4 @setfilename ../../info/org
5 @settitle The Org Manual
10 @c Use proper quote and backtick for code sections in PDF output
11 @c Cf. Texinfo manual 14.2
12 @set txicodequoteundirected
13 @set txicodequotebacktick
15 @c Version and Contact Info
16 @set MAINTAINERSITE @uref{http://orgmode.org,maintainers webpage}
17 @set AUTHOR Carsten Dominik
18 @set MAINTAINER Carsten Dominik
19 @set MAINTAINEREMAIL @email{carsten at orgmode dot org}
20 @set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer}
25 @c -----------------------------------------------------------------------------
27 @c Macro definitions for commands and keys
28 @c =======================================
30 @c The behavior of the key/command macros will depend on the flag cmdnames
31 @c When set, commands names are shown. When clear, they are not shown.
35 @c Below we define the following macros for Org key tables:
37 @c orgkey{key} A key item
38 @c orgcmd{key,cmd} Key with command name
39 @c xorgcmd{key,cmd} Key with command name as @itemx
40 @c orgcmdnki{key,cmd} Like orgcmd, but do not index the key
41 @c orgcmdtkc{text,key,cmd} Like orgcmd,special text instead of key
42 @c orgcmdkkc{key1,key2,cmd} Two keys with one command name, use "or"
43 @c orgcmdkxkc{key1,key2,cmd} Two keys with one command name, but
44 @c different functions, so format as @itemx
45 @c orgcmdkskc{key1,key2,cmd} Same as orgcmdkkc, but use "or short"
46 @c xorgcmdkskc{key1,key2,cmd} Same as previous, but use @itemx
47 @c orgcmdkkcc{key1,key2,cmd1,cmd2} Two keys and two commands
49 @c a key but no command
61 @c one key with a command
62 @c Inserts: @item KEY COMMAND
63 @macro orgcmd{key,command}
68 @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
71 @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
80 @c One key with one command, formatted using @itemx
81 @c Inserts: @itemx KEY COMMAND
82 @macro xorgcmd{key,command}
87 @itemx @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
90 @itemx @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
99 @c one key with a command, bit do not index the key
100 @c Inserts: @item KEY COMMAND
101 @macro orgcmdnki{key,command}
105 @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
108 @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
116 @c one key with a command, and special text to replace key in item
117 @c Inserts: @item TEXT COMMAND
118 @macro orgcmdtkc{text,key,command}
123 @item @kbd{\text\} @hskip 0pt plus 1filll @code{\command\}
126 @item @kbd{\text\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
135 @c two keys with one command
136 @c Inserts: @item KEY1 or KEY2 COMMAND
137 @macro orgcmdkkc{key1,key2,command}
143 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
146 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
152 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\}
156 @c Two keys with one command name, but different functions, so format as
158 @c Inserts: @item KEY1
159 @c @itemx KEY2 COMMAND
160 @macro orgcmdkxkc{key1,key2,command}
167 @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
171 @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
182 @c Same as previous, but use "or short"
183 @c Inserts: @item KEY1 or short KEY2 COMMAND
184 @macro orgcmdkskc{key1,key2,command}
190 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
193 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
199 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
203 @c Same as previous, but use @itemx
204 @c Inserts: @itemx KEY1 or short KEY2 COMMAND
205 @macro xorgcmdkskc{key1,key2,command}
211 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
214 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
220 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
224 @c two keys with two commands
225 @c Inserts: @item KEY1 COMMAND1
226 @c @itemx KEY2 COMMAND2
227 @macro orgcmdkkcc{key1,key2,command1,command2}
234 @item @kbd{\key1\} @hskip 0pt plus 1filll @code{\command1\}
235 @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command2\}
238 @item @kbd{\key1\} @tie{}@tie{}@tie{}@tie{}(@code{\command1\})
239 @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command2\})
249 @c -----------------------------------------------------------------------------
252 @c @hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed}
255 @c Subheadings inside a table.
256 @macro tsubheading{text}
258 @subsubheading \text\
266 This manual is for Org version @value{VERSION}.
268 Copyright @copyright{} 2004-2012 Free Software Foundation, Inc.
271 Permission is granted to copy, distribute and/or modify this document
272 under the terms of the GNU Free Documentation License, Version 1.3 or
273 any later version published by the Free Software Foundation; with no
274 Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
275 and with the Back-Cover Texts as in (a) below. A copy of the license
276 is included in the section entitled ``GNU Free Documentation License.''
278 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
279 modify this GNU manual. Buying copies from the FSF supports it in
280 developing GNU and promoting software freedom.''
282 This document is part of a collection distributed under the GNU Free
283 Documentation License. If you want to distribute this document
284 separately from the collection, you can do so by adding a copy of the
285 license to the document, as described in section 6 of the license.
291 * Org Mode: (org). Outline-based notes management and organizer
295 @title The Org Manual
297 @subtitle Release @value{VERSION}
298 @author by Carsten Dominik
299 with contributions by David O'Toole, Bastien Guerry, Philip Rooke, Dan Davison, Eric Schulte, Thomas Dye and Jambunathan K.
301 @c The following two commands start the copyright page.
303 @vskip 0pt plus 1filll
307 @c Output the table of contents at the beginning.
311 @node Top, Introduction, (dir), (dir)
318 * Introduction:: Getting started
319 * Document Structure:: A tree works like your brain
320 * Tables:: Pure magic for quick formatting
321 * Hyperlinks:: Notes in context
322 * TODO Items:: Every tree branch can be a TODO item
323 * Tags:: Tagging headlines and matching sets of tags
324 * Properties and Columns:: Storing information about an entry
325 * Dates and Times:: Making items useful for planning
326 * Capture - Refile - Archive:: The ins and outs for projects
327 * Agenda Views:: Collecting information into views
328 * Markup:: Prepare text for rich export
329 * Exporting:: Sharing and publishing of notes
330 * Publishing:: Create a web site of linked Org files
331 * Working With Source Code:: Export, evaluate, and tangle code blocks
332 * Miscellaneous:: All the rest which did not fit elsewhere
333 * Hacking:: How to hack your way around
334 * MobileOrg:: Viewing and capture on a mobile device
335 * History and Acknowledgments:: How Org came into being
336 * Main Index:: An index of Org's concepts and features
337 * Key Index:: Key bindings and where they are described
338 * Command and Function Index:: Command names and some internal functions
339 * Variable Index:: Variables mentioned in the manual
342 --- The Detailed Node Listing ---
346 * Summary:: Brief summary of what Org does
347 * Installation:: How to install a downloaded version of Org
348 * Activation:: How to activate Org for certain buffers
349 * Feedback:: Bug reports, ideas, patches etc.
350 * Conventions:: Type-setting conventions in the manual
354 * Outlines:: Org is based on Outline mode
355 * Headlines:: How to typeset Org tree headlines
356 * Visibility cycling:: Show and hide, much simplified
357 * Motion:: Jumping to other headlines
358 * Structure editing:: Changing sequence and level of headlines
359 * Sparse trees:: Matches embedded in context
360 * Plain lists:: Additional structure within an entry
361 * Drawers:: Tucking stuff away
362 * Blocks:: Folding blocks
363 * Footnotes:: How footnotes are defined in Org's syntax
364 * Orgstruct mode:: Structure editing outside Org
368 * Built-in table editor:: Simple tables
369 * Column width and alignment:: Overrule the automatic settings
370 * Column groups:: Grouping to trigger vertical lines
371 * Orgtbl mode:: The table editor as minor mode
372 * The spreadsheet:: The table editor has spreadsheet capabilities
373 * Org-Plot:: Plotting from org tables
377 * References:: How to refer to another field or range
378 * Formula syntax for Calc:: Using Calc to compute stuff
379 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
380 * Durations and time values:: How to compute durations and time values
381 * Field and range formulas:: Formula for specific (ranges of) fields
382 * Column formulas:: Formulas valid for an entire column
383 * Editing and debugging formulas:: Fixing formulas
384 * Updating the table:: Recomputing all dependent fields
385 * Advanced features:: Field and column names, parameters and automatic recalc
389 * Link format:: How links in Org are formatted
390 * Internal links:: Links to other places in the current file
391 * External links:: URL-like links to the world
392 * Handling links:: Creating, inserting and following
393 * Using links outside Org:: Linking from my C source code?
394 * Link abbreviations:: Shortcuts for writing complex links
395 * Search options:: Linking to a specific location
396 * Custom searches:: When the default search is not enough
400 * Radio targets:: Make targets trigger links in plain text
404 * TODO basics:: Marking and displaying TODO entries
405 * TODO extensions:: Workflow and assignments
406 * Progress logging:: Dates and notes for progress
407 * Priorities:: Some things are more important than others
408 * Breaking down tasks:: Splitting a task into manageable pieces
409 * Checkboxes:: Tick-off lists
411 Extended use of TODO keywords
413 * Workflow states:: From TODO to DONE in steps
414 * TODO types:: I do this, Fred does the rest
415 * Multiple sets in one file:: Mixing it all, and still finding your way
416 * Fast access to TODO states:: Single letter selection of a state
417 * Per-file keywords:: Different files, different requirements
418 * Faces for TODO keywords:: Highlighting states
419 * TODO dependencies:: When one task needs to wait for others
423 * Closing items:: When was this entry marked DONE?
424 * Tracking TODO state changes:: When did the status change?
425 * Tracking your habits:: How consistent have you been?
429 * Tag inheritance:: Tags use the tree structure of the outline
430 * Setting tags:: How to assign tags to a headline
431 * Tag searches:: Searching for combinations of tags
433 Properties and columns
435 * Property syntax:: How properties are spelled out
436 * Special properties:: Access to other Org mode features
437 * Property searches:: Matching property values
438 * Property inheritance:: Passing values down the tree
439 * Column view:: Tabular viewing and editing
440 * Property API:: Properties for Lisp programmers
444 * Defining columns:: The COLUMNS format property
445 * Using column view:: How to create and use column view
446 * Capturing column view:: A dynamic block for column view
450 * Scope of column definitions:: Where defined, where valid?
451 * Column attributes:: Appearance and content of a column
455 * Timestamps:: Assigning a time to a tree entry
456 * Creating timestamps:: Commands which insert timestamps
457 * Deadlines and scheduling:: Planning your work
458 * Clocking work time:: Tracking how long you spend on a task
459 * Effort estimates:: Planning work effort in advance
460 * Relative timer:: Notes with a running timer
461 * Countdown timer:: Starting a countdown timer for a task
465 * The date/time prompt:: How Org mode helps you entering date and time
466 * Custom time format:: Making dates look different
468 Deadlines and scheduling
470 * Inserting deadline/schedule:: Planning items
471 * Repeated tasks:: Items that show up again and again
475 * Clocking commands:: Starting and stopping a clock
476 * The clock table:: Detailed reports
477 * Resolving idle time:: Resolving time when you've been idle
479 Capture - Refile - Archive
481 * Capture:: Capturing new stuff
482 * Attachments:: Add files to tasks
483 * RSS Feeds:: Getting input from RSS feeds
484 * Protocols:: External (e.g.@: Browser) access to Emacs and Org
485 * Refiling notes:: Moving a tree from one place to another
486 * Archiving:: What to do with finished projects
490 * Setting up capture:: Where notes will be stored
491 * Using capture:: Commands to invoke and terminate capture
492 * Capture templates:: Define the outline of different note types
496 * Template elements:: What is needed for a complete template entry
497 * Template expansion:: Filling in information about time and context
501 * Moving subtrees:: Moving a tree to an archive file
502 * Internal archiving:: Switch off a tree but keep it in the file
506 * Agenda files:: Files being searched for agenda information
507 * Agenda dispatcher:: Keyboard access to agenda views
508 * Built-in agenda views:: What is available out of the box?
509 * Presentation and sorting:: How agenda items are prepared for display
510 * Agenda commands:: Remote editing of Org trees
511 * Custom agenda views:: Defining special searches and views
512 * Exporting Agenda Views:: Writing a view to a file
513 * Agenda column view:: Using column view for collected entries
515 The built-in agenda views
517 * Weekly/daily agenda:: The calendar page with current tasks
518 * Global TODO list:: All unfinished action items
519 * Matching tags and properties:: Structured information with fine-tuned search
520 * Timeline:: Time-sorted view for single file
521 * Search view:: Find entries by searching for text
522 * Stuck projects:: Find projects you need to review
524 Presentation and sorting
526 * Categories:: Not all tasks are equal
527 * Time-of-day specifications:: How the agenda knows the time
528 * Sorting of agenda items:: The order of things
532 * Storing searches:: Type once, use often
533 * Block agenda:: All the stuff you need in a single buffer
534 * Setting Options:: Changing the rules
536 Markup for rich export
538 * Structural markup elements:: The basic structure as seen by the exporter
539 * Images and tables:: Tables and Images will be included
540 * Literal examples:: Source code examples with special formatting
541 * Include files:: Include additional files into a document
542 * Index entries:: Making an index
543 * Macro replacement:: Use macros to create complex output
544 * Embedded @LaTeX{}:: LaTeX can be freely used inside Org documents
546 Structural markup elements
548 * Document title:: Where the title is taken from
549 * Headings and sections:: The document structure as seen by the exporter
550 * Table of contents:: The if and where of the table of contents
551 * Initial text:: Text before the first heading?
553 * Paragraphs:: Paragraphs
554 * Footnote markup:: Footnotes
555 * Emphasis and monospace:: Bold, italic, etc.
556 * Horizontal rules:: Make a line
557 * Comment lines:: What will *not* be exported
561 * Special symbols:: Greek letters and other symbols
562 * Subscripts and superscripts:: Simple syntax for raising/lowering text
563 * @LaTeX{} fragments:: Complex formulas made easy
564 * Previewing @LaTeX{} fragments:: What will this snippet look like?
565 * CDLaTeX mode:: Speed up entering of formulas
569 * Selective export:: Using tags to select and exclude trees
570 * Export options:: Per-file export settings
571 * The export dispatcher:: How to access exporter commands
572 * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
573 * HTML export:: Exporting to HTML
574 * @LaTeX{} and PDF export:: Exporting to @LaTeX{}, and processing to PDF
575 * DocBook export:: Exporting to DocBook
576 * OpenDocument Text export:: Exporting to OpenDocument Text
577 * TaskJuggler export:: Exporting to TaskJuggler
578 * Freemind export:: Exporting to Freemind mind maps
579 * XOXO export:: Exporting to XOXO
580 * iCalendar export:: Exporting in iCalendar format
584 * HTML Export commands:: How to invoke HTML export
585 * HTML preamble and postamble:: How to insert a preamble and a postamble
586 * Quoting HTML tags:: Using direct HTML in Org mode
587 * Links in HTML export:: How links will be interpreted and formatted
588 * Tables in HTML export:: How to modify the formatting of tables
589 * Images in HTML export:: How to insert figures into HTML output
590 * Math formatting in HTML export:: Beautiful math also on the web
591 * Text areas in HTML export:: An alternative way to show an example
592 * CSS support:: Changing the appearance of the output
593 * JavaScript support:: Info and Folding in a web browser
595 @LaTeX{} and PDF export
597 * @LaTeX{}/PDF export commands::
598 * Header and sectioning:: Setting up the export file structure
599 * Quoting @LaTeX{} code:: Incorporating literal @LaTeX{} code
600 * Tables in @LaTeX{} export:: Options for exporting tables to @LaTeX{}
601 * Images in @LaTeX{} export:: How to insert figures into @LaTeX{} output
602 * Beamer class export:: Turning the file into a presentation
606 * DocBook export commands:: How to invoke DocBook export
607 * Quoting DocBook code:: Incorporating DocBook code in Org files
608 * Recursive sections:: Recursive sections in DocBook
609 * Tables in DocBook export:: Tables are exported as HTML tables
610 * Images in DocBook export:: How to insert figures into DocBook output
611 * Special characters:: How to handle special characters
613 OpenDocument Text export
615 * Pre-requisites for @acronym{ODT} export:: What packages @acronym{ODT} exporter relies on
616 * @acronym{ODT} export commands:: How to invoke @acronym{ODT} export
617 * Applying custom styles:: How to apply custom styles to the output
618 * Links in @acronym{ODT} export:: How links will be interpreted and formatted
619 * Tables in @acronym{ODT} export:: How Tables are exported
620 * Images in @acronym{ODT} export:: How to insert images
621 * Math formatting in @acronym{ODT} export:: How @LaTeX{} fragments are formatted
622 * Literal examples in @acronym{ODT} export:: How source and example blocks are formatted
623 * Advanced topics in @acronym{ODT} export:: Read this if you are a power user
625 Math formatting in @acronym{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 @acronym{ODT} export
632 * Exporting and converting to other formats:: How to produce @samp{pdf} and other formats
633 * Working with OpenDocument style files:: Explore the internals
634 * Creating one-off styles:: How to produce custom highlighting etc
635 * Customizing tables in @acronym{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 * dir:: Specify the default (possibly remote)
697 directory for code block execution
698 * exports:: Export code and/or results
699 * tangle:: Toggle tangling and specify file name
700 * mkdirp:: Toggle creation of parent directories of target
701 files during tangling
702 * comments:: Toggle insertion of comments in tangled
704 * padline:: Control insertion of padding lines in tangled
706 * no-expand:: Turn off variable assignment and noweb
707 expansion during tangling
708 * session:: Preserve the state of code evaluation
709 * noweb:: Toggle expansion of noweb references
710 * noweb-ref:: Specify block's noweb reference resolution target
711 * noweb-sep:: String used to separate noweb references
712 * cache:: Avoid re-evaluating unchanged code blocks
713 * sep:: Delimiter for writing tabular results outside Org
714 * hlines:: Handle horizontal lines in tables
715 * colnames:: Handle column names in tables
716 * rownames:: Handle row names in tables
717 * shebang:: Make tangled files executable
718 * eval:: Limit evaluation of specific code blocks
719 * wrap:: Mark source block evaluation results
723 * Completion:: M-TAB knows what you need
724 * Easy Templates:: Quick insertion of structural elements
725 * Speed keys:: Electric commands at the beginning of a headline
726 * Code evaluation security:: Org mode files evaluate inline code
727 * Customization:: Adapting Org to your taste
728 * In-buffer settings:: Overview of the #+KEYWORDS
729 * The very busy C-c C-c key:: When in doubt, press C-c C-c
730 * Clean view:: Getting rid of leading stars in the outline
731 * TTY keys:: Using Org on a tty
732 * Interaction:: Other Emacs packages
733 * org-crypt.el:: Encrypting Org files
735 Interaction with other packages
737 * Cooperation:: Packages Org cooperates with
738 * Conflicts:: Packages that lead to conflicts
742 * Hooks:: Who to reach into Org's internals
743 * Add-on packages:: Available extensions
744 * Adding hyperlink types:: New custom link types
745 * Context-sensitive commands:: How to add functionality to such commands
746 * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
747 * Dynamic blocks:: Automatically filled blocks
748 * Special agenda views:: Customized views
749 * Extracting agenda information:: Postprocessing of agenda information
750 * Using the property API:: Writing programs that use entry properties
751 * Using the mapping API:: Mapping over all or selected entries
753 Tables and lists in arbitrary syntax
755 * Radio tables:: Sending and receiving radio tables
756 * A @LaTeX{} example:: Step by step, almost a tutorial
757 * Translator functions:: Copy and modify
758 * Radio lists:: Doing the same for lists
762 * Setting up the staging area:: Where to interact with the mobile device
763 * Pushing to MobileOrg:: Uploading Org files and agendas
764 * Pulling from MobileOrg:: Integrating captured and flagged items
769 @node Introduction, Document Structure, Top, Top
770 @chapter Introduction
774 * Summary:: Brief summary of what Org does
775 * Installation:: How to install a downloaded version of Org
776 * Activation:: How to activate Org for certain buffers
777 * Feedback:: Bug reports, ideas, patches etc.
778 * Conventions:: Type-setting conventions in the manual
781 @node Summary, Installation, Introduction, Introduction
785 Org is a mode for keeping notes, maintaining TODO lists, and doing
786 project planning with a fast and effective plain-text system.
788 Org develops organizational tasks around NOTES files that contain
789 lists or information about projects as plain text. Org is
790 implemented on top of Outline mode, which makes it possible to keep the
791 content of large files well structured. Visibility cycling and
792 structure editing help to work with the tree. Tables are easily created
793 with a built-in table editor. Org supports TODO items, deadlines,
794 timestamps, and scheduling. It dynamically compiles entries into an
795 agenda that utilizes and smoothly integrates much of the Emacs calendar
796 and diary. Plain text URL-like links connect to websites, emails,
797 Usenet messages, BBDB entries, and any files related to the projects.
798 For printing and sharing of notes, an Org file can be exported as a
799 structured ASCII file, as HTML, or (TODO and agenda items only) as an
800 iCalendar file. It can also serve as a publishing tool for a set of
803 As a project planning environment, Org works by adding metadata to outline
804 nodes. Based on this data, specific entries can be extracted in queries and
805 create dynamic @i{agenda views}.
807 Org mode contains the Org Babel environment which allows you to work with
808 embedded source code blocks in a file, to facilitate code evaluation,
809 documentation, and literate programming techniques.
811 Org's automatic, context-sensitive table editor with spreadsheet
812 capabilities can be integrated into any major mode by activating the
813 minor Orgtbl mode. Using a translation step, it can be used to maintain
814 tables in arbitrary file types, for example in @LaTeX{}. The structure
815 editing and list creation capabilities can be used outside Org with
816 the minor Orgstruct mode.
818 Org keeps simple things simple. When first fired up, it should
819 feel like a straightforward, easy to use outliner. Complexity is not
820 imposed, but a large amount of functionality is available when you need
821 it. Org is a toolbox and can be used in different ways and for different
825 @r{@bullet{} an outline extension with visibility cycling and structure editing}
826 @r{@bullet{} an ASCII system and table editor for taking structured notes}
827 @r{@bullet{} a TODO list editor}
828 @r{@bullet{} a full agenda and planner with deadlines and work scheduling}
829 @pindex GTD, Getting Things Done
830 @r{@bullet{} an environment in which to implement David Allen's GTD system}
831 @r{@bullet{} a simple hypertext system, with HTML and @LaTeX{} export}
832 @r{@bullet{} a publishing tool to create a set of interlinked webpages}
833 @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 are using a version of Org that is part of the Emacs
857 distribution or an XEmacs package, please skip this section and go directly
858 to @ref{Activation}. To see what version of Org (if any) is part of your
859 Emacs distribution, type @kbd{M-x load-library RET org} and then @kbd{M-x
862 If you have downloaded Org from the Web, either as a distribution @file{.zip}
863 or @file{.tar} file, or as a Git archive, you must take the following steps
864 to install it: go into the unpacked Org distribution directory and edit the
865 top section of the file @file{Makefile}. You must set the name of the Emacs
866 binary (likely either @file{emacs} or @file{xemacs}), and the paths to the
867 directories where local Lisp and Info files are kept. If you don't have
868 access to the system-wide directories, you can simply run Org directly from
869 the distribution directory by adding the @file{lisp} subdirectory to the
870 Emacs load path. To do this, add the following line to @file{.emacs}:
873 (setq load-path (cons "~/path/to/orgdir/lisp" load-path))
877 If you plan to use code from the @file{contrib} subdirectory, do a similar
878 step for this directory:
881 (setq load-path (cons "~/path/to/orgdir/contrib/lisp" load-path))
884 @noindent Now byte-compile the Lisp files with the shell command:
890 @noindent If you are running Org from the distribution directory, this is
891 all. If you want to install Org into the system directories, use (as
898 Installing Info files is system dependent, because of differences in the
899 @file{install-info} program. The following should correctly install the Info
900 files on most systems, please send a bug report if not@footnote{The output
901 from install-info (if any) is also system dependent. In particular Debian
902 and its derivatives use two different versions of install-info and you may
906 This is not dpkg install-info anymore, but GNU install-info
907 See the man page for ginstall-info for command line arguments
910 @noindent which can be safely ignored.}.
916 Then add the following line to @file{.emacs}. It is needed so that
917 Emacs can autoload functions that are located in files not immediately loaded
918 when Org mode starts.
920 (require 'org-install)
923 Do not forget to activate Org as described in the following section.
926 @node Activation, Feedback, Installation, Introduction
930 @cindex global key bindings
931 @cindex key bindings, global
933 To make sure files with extension @file{.org} use Org mode, add the following
934 line to your @file{.emacs} file.
936 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
938 @noindent Org mode buffers need font-lock to be turned on - this is the
939 default in Emacs@footnote{If you don't use font-lock globally, turn it on in
940 Org buffer with @code{(add-hook 'org-mode-hook 'turn-on-font-lock)}}.
942 The four Org commands @command{org-store-link}, @command{org-capture},
943 @command{org-agenda}, and @command{org-iswitchb} should be accessible through
944 global keys (i.e.@: anywhere in Emacs, not just in Org buffers). Here are
945 suggested bindings for these keys, please modify the keys to your own
948 (global-set-key "\C-cl" 'org-store-link)
949 (global-set-key "\C-cc" 'org-capture)
950 (global-set-key "\C-ca" 'org-agenda)
951 (global-set-key "\C-cb" 'org-iswitchb)
954 @cindex Org mode, turning on
955 With this setup, all files with extension @samp{.org} will be put
956 into Org mode. As an alternative, make the first line of a file look
960 MY PROJECTS -*- mode: org; -*-
963 @vindex org-insert-mode-line-in-empty-file
964 @noindent which will select Org mode for this buffer no matter what
965 the file's name is. See also the variable
966 @code{org-insert-mode-line-in-empty-file}.
968 Many commands in Org work on the region if the region is @i{active}. To make
969 use of this, you need to have @code{transient-mark-mode}
970 (@code{zmacs-regions} in XEmacs) turned on. In Emacs 23 this is the default,
971 in Emacs 22 you need to do this yourself with
973 (transient-mark-mode 1)
975 @noindent If you do not like @code{transient-mark-mode}, you can create an
976 active region by using the mouse to select a region, or pressing
977 @kbd{C-@key{SPC}} twice before moving the cursor.
979 @node Feedback, Conventions, Activation, Introduction
986 If you find problems with Org, or if you have questions, remarks, or ideas
987 about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}.
988 If you are not a member of the mailing list, your mail will be passed to the
989 list after a moderator has approved it@footnote{Please consider subscribing
990 to the mailing list, in order to minimize the work the mailing list
991 moderators have to do.}.
993 For bug reports, please first try to reproduce the bug with the latest
994 version of Org available---if you are running an outdated version, it is
995 quite possible that the bug has been fixed already. If the bug persists,
996 prepare a report and provide as much information as possible, including the
997 version information of Emacs (@kbd{M-x emacs-version @key{RET}}) and Org
998 (@kbd{M-x org-version @key{RET}}), as well as the Org related setup in
999 @file{.emacs}. The easiest way to do this is to use the command
1001 @kbd{M-x org-submit-bug-report}
1003 @noindent which will put all this information into an Emacs mail buffer so
1004 that you only need to add your description. If you re not sending the Email
1005 from within Emacs, please copy and paste the content into your Email program.
1007 Sometimes you might face a problem due to an error in your Emacs or Org mode
1008 setup. Before reporting a bug, it is very helpful to start Emacs with minimal
1009 customisations and reproduce the problem. Doing so often helps you determine
1010 if the problem is with your customization or with Org mode itself. You can
1011 start a typical minimal session with a command like the example below.
1014 $ emacs -Q -l /path/to/minimal-org.el
1017 However if you are using Org mode as distributed with Emacs, a minimal setup
1018 is not necessary. In that case it is sufficient to start Emacs as @code{emacs
1019 -Q}. The @code{minimal-org.el} setup file can have contents as shown below.
1022 ;;; Minimal setup to load latest `org-mode'
1024 ;; activate debugging
1025 (setq debug-on-error t
1029 ;; add latest org-mode to load path
1030 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/lisp"))
1031 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/contrib/lisp"))
1034 (require 'org-install)
1037 If an error occurs, a backtrace can be very useful (see below on how to
1038 create one). Often a small example file helps, along with clear information
1042 @item What exactly did you do?
1043 @item What did you expect to happen?
1044 @item What happened instead?
1046 @noindent Thank you for helping to improve this program.
1048 @subsubheading How to create a useful backtrace
1050 @cindex backtrace of an error
1051 If working with Org produces an error with a message you don't
1052 understand, you may have hit a bug. The best way to report this is by
1053 providing, in addition to what was mentioned above, a @emph{backtrace}.
1054 This is information from the built-in debugger about where and how the
1055 error occurred. Here is how to produce a useful backtrace:
1059 Reload uncompiled versions of all Org mode Lisp files. The backtrace
1060 contains much more information if it is produced with uncompiled code.
1063 C-u M-x org-reload RET
1066 or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the
1069 Go to the @code{Options} menu and select @code{Enter Debugger on Error}
1070 (XEmacs has this option in the @code{Troubleshooting} sub-menu).
1072 Do whatever you have to do to hit the error. Don't forget to
1073 document the steps you take.
1075 When you hit the error, a @file{*Backtrace*} buffer will appear on the
1076 screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and
1077 attach it to your bug report.
1080 @node Conventions, , Feedback, Introduction
1081 @section Typesetting conventions used in this manual
1083 Org uses three types of keywords: TODO keywords, tags and property
1084 names. In this manual we use the following conventions:
1089 TODO keywords are written with all capitals, even if they are
1093 User-defined tags are written in lowercase; built-in tags with special
1094 meaning are written with all capitals.
1097 User-defined properties are capitalized; built-in properties with
1098 special meaning are written with all capitals.
1101 Moreover, Org uses @i{option keywords} (like @code{#+TITLE} to set the title)
1102 and @i{environment keywords} (like @code{#+BEGIN_HTML} to start a @code{HTML}
1103 environment). They are written in uppercase in the manual to enhance its
1104 readability, but you can use lowercase in your Org files@footnote{Easy
1105 templates insert lowercase keywords and Babel dynamically inserts
1108 The manual lists both the keys and the corresponding commands for accessing a
1109 functionality. Org mode often uses the same key for different functions,
1110 depending on context. The command that is bound to such keys has a generic
1111 name, like @code{org-metaright}. In the manual we will, wherever possible,
1112 give the function that is internally called by the generic command. For
1113 example, in the chapter on document structure, @kbd{M-@key{right}} will be
1114 listed to call @code{org-do-demote}, while in the chapter on tables, it will
1115 be listed to call org-table-move-column-right.
1117 If you prefer, you can compile the manual without the command names by
1118 unsetting the flag @code{cmdnames} in @file{org.texi}.
1120 @node Document Structure, Tables, Introduction, Top
1121 @chapter Document structure
1122 @cindex document structure
1123 @cindex structure of document
1125 Org is based on Outline mode and provides flexible commands to
1126 edit the structure of the document.
1129 * Outlines:: Org is based on Outline mode
1130 * Headlines:: How to typeset Org tree headlines
1131 * Visibility cycling:: Show and hide, much simplified
1132 * Motion:: Jumping to other headlines
1133 * Structure editing:: Changing sequence and level of headlines
1134 * Sparse trees:: Matches embedded in context
1135 * Plain lists:: Additional structure within an entry
1136 * Drawers:: Tucking stuff away
1137 * Blocks:: Folding blocks
1138 * Footnotes:: How footnotes are defined in Org's syntax
1139 * Orgstruct mode:: Structure editing outside Org
1142 @node Outlines, Headlines, Document Structure, Document Structure
1145 @cindex Outline mode
1147 Org is implemented on top of Outline mode. Outlines allow a
1148 document to be organized in a hierarchical structure, which (at least
1149 for me) is the best representation of notes and thoughts. An overview
1150 of this structure is achieved by folding (hiding) large parts of the
1151 document to show only the general document structure and the parts
1152 currently being worked on. Org greatly simplifies the use of
1153 outlines by compressing the entire show/hide functionality into a single
1154 command, @command{org-cycle}, which is bound to the @key{TAB} key.
1156 @node Headlines, Visibility cycling, Outlines, Document Structure
1159 @cindex outline tree
1160 @vindex org-special-ctrl-a/e
1161 @vindex org-special-ctrl-k
1162 @vindex org-ctrl-k-protect-subtree
1164 Headlines define the structure of an outline tree. The headlines in Org
1165 start with one or more stars, on the left margin@footnote{See the variables
1166 @code{org-special-ctrl-a/e}, @code{org-special-ctrl-k}, and
1167 @code{org-ctrl-k-protect-subtree} to configure special behavior of @kbd{C-a},
1168 @kbd{C-e}, and @kbd{C-k} in headlines.} @footnote{Clocking only works with
1169 headings indented less then 30 stars.}. For example:
1172 * Top level headline
1179 * Another top level headline
1182 @noindent Some people find the many stars too noisy and would prefer an
1183 outline that has whitespace followed by a single star as headline
1184 starters. @ref{Clean view}, describes a setup to realize this.
1186 @vindex org-cycle-separator-lines
1187 An empty line after the end of a subtree is considered part of it and
1188 will be hidden when the subtree is folded. However, if you leave at
1189 least two empty lines, one empty line will remain visible after folding
1190 the subtree, in order to structure the collapsed view. See the
1191 variable @code{org-cycle-separator-lines} to modify this behavior.
1193 @node Visibility cycling, Motion, Headlines, Document Structure
1194 @section Visibility cycling
1195 @cindex cycling, visibility
1196 @cindex visibility cycling
1197 @cindex trees, visibility
1198 @cindex show hidden text
1201 Outlines make it possible to hide parts of the text in the buffer.
1202 Org uses just two commands, bound to @key{TAB} and
1203 @kbd{S-@key{TAB}} to change the visibility in the buffer.
1205 @cindex subtree visibility states
1206 @cindex subtree cycling
1207 @cindex folded, subtree visibility state
1208 @cindex children, subtree visibility state
1209 @cindex subtree, subtree visibility state
1211 @orgcmd{@key{TAB},org-cycle}
1212 @emph{Subtree cycling}: Rotate current subtree among the states
1215 ,-> FOLDED -> CHILDREN -> SUBTREE --.
1216 '-----------------------------------'
1219 @vindex org-cycle-emulate-tab
1220 @vindex org-cycle-global-at-bob
1221 The cursor must be on a headline for this to work@footnote{see, however,
1222 the option @code{org-cycle-emulate-tab}.}. When the cursor is at the
1223 beginning of the buffer and the first line is not a headline, then
1224 @key{TAB} actually runs global cycling (see below)@footnote{see the
1225 option @code{org-cycle-global-at-bob}.}. Also when called with a prefix
1226 argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
1228 @cindex global visibility states
1229 @cindex global cycling
1230 @cindex overview, global visibility state
1231 @cindex contents, global visibility state
1232 @cindex show all, global visibility state
1233 @orgcmd{S-@key{TAB},org-global-cycle}
1234 @itemx C-u @key{TAB}
1235 @emph{Global cycling}: Rotate the entire buffer among the states
1238 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
1239 '--------------------------------------'
1242 When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
1243 CONTENTS view up to headlines of level N will be shown. Note that inside
1244 tables, @kbd{S-@key{TAB}} jumps to the previous field.
1246 @cindex show all, command
1247 @orgcmd{C-u C-u C-u @key{TAB},show-all}
1248 Show all, including drawers.
1249 @orgcmd{C-c C-r,org-reveal}
1250 Reveal context around point, showing the current entry, the following heading
1251 and the hierarchy above. Useful for working near a location that has been
1252 exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
1253 (@pxref{Agenda commands}). With a prefix argument show, on each
1254 level, all sibling headings. With a double prefix argument, also show the
1255 entire subtree of the parent.
1256 @orgcmd{C-c C-k,show-branches}
1257 Expose all the headings of the subtree, CONTENT view for just one subtree.
1258 @orgcmd{C-c C-x b,org-tree-to-indirect-buffer}
1259 Show the current subtree in an indirect buffer@footnote{The indirect
1262 (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
1265 (see the Emacs manual for more information about indirect buffers)
1267 will contain the entire buffer, but will be narrowed to the current
1268 tree. Editing the indirect buffer will also change the original buffer,
1269 but without affecting visibility in that buffer.}. With a numeric
1270 prefix argument N, go up to level N and then take that tree. If N is
1271 negative then go up that many levels. With a @kbd{C-u} prefix, do not remove
1272 the previously used indirect buffer.
1273 @orgcmd{C-c C-x v,org-copy-visible}
1274 Copy the @i{visible} text in the region into the kill ring.
1277 @vindex org-startup-folded
1278 @cindex @code{overview}, STARTUP keyword
1279 @cindex @code{content}, STARTUP keyword
1280 @cindex @code{showall}, STARTUP keyword
1281 @cindex @code{showeverything}, STARTUP keyword
1283 When Emacs first visits an Org file, the global state is set to
1284 OVERVIEW, i.e.@: only the top level headlines are visible. This can be
1285 configured through the variable @code{org-startup-folded}, or on a
1286 per-file basis by adding one of the following lines anywhere in the
1293 #+STARTUP: showeverything
1296 @cindex property, VISIBILITY
1298 Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
1299 and Columns}) will get their visibility adapted accordingly. Allowed values
1300 for this property are @code{folded}, @code{children}, @code{content}, and
1303 @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
1304 Switch back to the startup visibility of the buffer, i.e.@: whatever is
1305 requested by startup options and @samp{VISIBILITY} properties in individual
1309 @node Motion, Structure editing, Visibility cycling, Document Structure
1311 @cindex motion, between headlines
1312 @cindex jumping, to headlines
1313 @cindex headline navigation
1314 The following commands jump to other headlines in the buffer.
1317 @orgcmd{C-c C-n,outline-next-visible-heading}
1319 @orgcmd{C-c C-p,outline-previous-visible-heading}
1321 @orgcmd{C-c C-f,org-forward-same-level}
1322 Next heading same level.
1323 @orgcmd{C-c C-b,org-backward-same-level}
1324 Previous heading same level.
1325 @orgcmd{C-c C-u,outline-up-heading}
1326 Backward to higher level heading.
1327 @orgcmd{C-c C-j,org-goto}
1328 Jump to a different place without changing the current outline
1329 visibility. Shows the document structure in a temporary buffer, where
1330 you can use the following keys to find your destination:
1331 @vindex org-goto-auto-isearch
1333 @key{TAB} @r{Cycle visibility.}
1334 @key{down} / @key{up} @r{Next/previous visible headline.}
1335 @key{RET} @r{Select this location.}
1336 @kbd{/} @r{Do a Sparse-tree search}
1337 @r{The following keys work if you turn off @code{org-goto-auto-isearch}}
1338 n / p @r{Next/previous visible headline.}
1339 f / b @r{Next/previous headline same level.}
1341 0-9 @r{Digit argument.}
1344 @vindex org-goto-interface
1346 See also the variable @code{org-goto-interface}.
1349 @node Structure editing, Sparse trees, Motion, Document Structure
1350 @section Structure editing
1351 @cindex structure editing
1352 @cindex headline, promotion and demotion
1353 @cindex promotion, of subtrees
1354 @cindex demotion, of subtrees
1355 @cindex subtree, cut and paste
1356 @cindex pasting, of subtrees
1357 @cindex cutting, of subtrees
1358 @cindex copying, of subtrees
1359 @cindex sorting, of subtrees
1360 @cindex subtrees, cut and paste
1363 @orgcmd{M-@key{RET},org-insert-heading}
1364 @vindex org-M-RET-may-split-line
1365 Insert new heading with same level as current. If the cursor is in a plain
1366 list item, a new item is created (@pxref{Plain lists}). To force creation of
1367 a new headline, use a prefix argument. When this command is used in the
1368 middle of a line, the line is split and the rest of the line becomes the new
1369 headline@footnote{If you do not want the line to be split, customize the
1370 variable @code{org-M-RET-may-split-line}.}. If the command is used at the
1371 beginning of a headline, the new headline is created before the current line.
1372 If at the beginning of any other line, the content of that line is made the
1373 new heading. If the command is used at the end of a folded subtree (i.e.@:
1374 behind the ellipses at the end of a headline), then a headline like the
1375 current one will be inserted after the end of the subtree.
1376 @orgcmd{C-@key{RET},org-insert-heading-respect-content}
1377 Just like @kbd{M-@key{RET}}, except when adding a new heading below the
1378 current heading, the new heading is placed after the body instead of before
1379 it. This command works from anywhere in the entry.
1380 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
1381 @vindex org-treat-insert-todo-heading-as-state-change
1382 Insert new TODO entry with same level as current heading. See also the
1383 variable @code{org-treat-insert-todo-heading-as-state-change}.
1384 @orgcmd{C-S-@key{RET},org-insert-todo-heading-respect-content}
1385 Insert new TODO entry with same level as current heading. Like
1386 @kbd{C-@key{RET}}, the new headline will be inserted after the current
1388 @orgcmd{@key{TAB},org-cycle}
1389 In a new entry with no text yet, the first @key{TAB} demotes the entry to
1390 become a child of the previous one. The next @key{TAB} makes it a parent,
1391 and so on, all the way to top level. Yet another @key{TAB}, and you are back
1392 to the initial level.
1393 @orgcmd{M-@key{left},org-do-promote}
1394 Promote current heading by one level.
1395 @orgcmd{M-@key{right},org-do-demote}
1396 Demote current heading by one level.
1397 @orgcmd{M-S-@key{left},org-promote-subtree}
1398 Promote the current subtree by one level.
1399 @orgcmd{M-S-@key{right},org-demote-subtree}
1400 Demote the current subtree by one level.
1401 @orgcmd{M-S-@key{up},org-move-subtree-up}
1402 Move subtree up (swap with previous subtree of same
1404 @orgcmd{M-S-@key{down},org-move-subtree-down}
1405 Move subtree down (swap with next subtree of same level).
1406 @orgcmd{C-c C-x C-w,org-cut-subtree}
1407 Kill subtree, i.e.@: remove it from buffer but save in kill ring.
1408 With a numeric prefix argument N, kill N sequential subtrees.
1409 @orgcmd{C-c C-x M-w,org-copy-subtree}
1410 Copy subtree to kill ring. With a numeric prefix argument N, copy the N
1411 sequential subtrees.
1412 @orgcmd{C-c C-x C-y,org-paste-subtree}
1413 Yank subtree from kill ring. This does modify the level of the subtree to
1414 make sure the tree fits in nicely at the yank position. The yank level can
1415 also be specified with a numeric prefix argument, or by yanking after a
1416 headline marker like @samp{****}.
1417 @orgcmd{C-y,org-yank}
1418 @vindex org-yank-adjusted-subtrees
1419 @vindex org-yank-folded-subtrees
1420 Depending on the variables @code{org-yank-adjusted-subtrees} and
1421 @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
1422 paste subtrees folded and in a clever way, using the same command as @kbd{C-c
1423 C-x C-y}. With the default settings, no level adjustment will take place,
1424 but the yanked tree will be folded unless doing so would swallow text
1425 previously visible. Any prefix argument to this command will force a normal
1426 @code{yank} to be executed, with the prefix passed along. A good way to
1427 force a normal yank is @kbd{C-u C-y}. If you use @code{yank-pop} after a
1428 yank, it will yank previous kill items plainly, without adjustment and
1430 @orgcmd{C-c C-x c,org-clone-subtree-with-time-shift}
1431 Clone a subtree by making a number of sibling copies of it. You will be
1432 prompted for the number of copies to make, and you can also specify if any
1433 timestamps in the entry should be shifted. This can be useful, for example,
1434 to create a number of tasks related to a series of lectures to prepare. For
1435 more details, see the docstring of the command
1436 @code{org-clone-subtree-with-time-shift}.
1437 @orgcmd{C-c C-w,org-refile}
1438 Refile entry or region to a different location. @xref{Refiling notes}.
1439 @orgcmd{C-c ^,org-sort}
1440 Sort same-level entries. When there is an active region, all entries in the
1441 region will be sorted. Otherwise the children of the current headline are
1442 sorted. The command prompts for the sorting method, which can be
1443 alphabetically, numerically, by time (first timestamp with active preferred,
1444 creation time, scheduled time, deadline time), by priority, by TODO keyword
1445 (in the sequence the keywords have been defined in the setup) or by the value
1446 of a property. Reverse sorting is possible as well. You can also supply
1447 your own function to extract the sorting key. With a @kbd{C-u} prefix,
1448 sorting will be case-sensitive.
1449 @orgcmd{C-x n s,org-narrow-to-subtree}
1450 Narrow buffer to current subtree.
1451 @orgcmd{C-x n b,org-narrow-to-block}
1452 Narrow buffer to current block.
1453 @orgcmd{C-x n w,widen}
1454 Widen buffer to remove narrowing.
1455 @orgcmd{C-c *,org-toggle-heading}
1456 Turn a normal line or plain list item into a headline (so that it becomes a
1457 subheading at its location). Also turn a headline into a normal line by
1458 removing the stars. If there is an active region, turn all lines in the
1459 region into headlines. If the first line in the region was an item, turn
1460 only the item lines into headlines. Finally, if the first line is a
1461 headline, remove the stars from all headlines in the region.
1464 @cindex region, active
1465 @cindex active region
1466 @cindex transient mark mode
1467 When there is an active region (Transient Mark mode), promotion and
1468 demotion work on all headlines in the region. To select a region of
1469 headlines, it is best to place both point and mark at the beginning of a
1470 line, mark at the beginning of the first headline, and point at the line
1471 just after the last headline to change. Note that when the cursor is
1472 inside a table (@pxref{Tables}), the Meta-Cursor keys have different
1476 @node Sparse trees, Plain lists, Structure editing, Document Structure
1477 @section Sparse trees
1478 @cindex sparse trees
1479 @cindex trees, sparse
1480 @cindex folding, sparse trees
1481 @cindex occur, command
1483 @vindex org-show-hierarchy-above
1484 @vindex org-show-following-heading
1485 @vindex org-show-siblings
1486 @vindex org-show-entry-below
1487 An important feature of Org mode is the ability to construct @emph{sparse
1488 trees} for selected information in an outline tree, so that the entire
1489 document is folded as much as possible, but the selected information is made
1490 visible along with the headline structure above it@footnote{See also the
1491 variables @code{org-show-hierarchy-above}, @code{org-show-following-heading},
1492 @code{org-show-siblings}, and @code{org-show-entry-below} for detailed
1493 control on how much context is shown around each match.}. Just try it out
1494 and you will see immediately how it works.
1496 Org mode contains several commands creating such trees, all these
1497 commands can be accessed through a dispatcher:
1500 @orgcmd{C-c /,org-sparse-tree}
1501 This prompts for an extra key to select a sparse-tree creating command.
1502 @orgcmd{C-c / r,org-occur}
1503 @vindex org-remove-highlights-with-change
1504 Prompts for a regexp and shows a sparse tree with all matches. If
1505 the match is in a headline, the headline is made visible. If the match is in
1506 the body of an entry, headline and body are made visible. In order to
1507 provide minimal context, also the full hierarchy of headlines above the match
1508 is shown, as well as the headline following the match. Each match is also
1509 highlighted; the highlights disappear when the buffer is changed by an
1510 editing command@footnote{This depends on the option
1511 @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
1512 When called with a @kbd{C-u} prefix argument, previous highlights are kept,
1513 so several calls to this command can be stacked.
1514 @orgcmdkkc{M-g n,M-g M-n,next-error}
1515 Jump to the next sparse tree match in this buffer.
1516 @orgcmdkkc{M-g p,M-g M-p,previous-error}
1517 Jump to the previous sparse tree match in this buffer.
1522 @vindex org-agenda-custom-commands
1523 For frequently used sparse trees of specific search strings, you can
1524 use the variable @code{org-agenda-custom-commands} to define fast
1525 keyboard access to specific sparse trees. These commands will then be
1526 accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
1530 (setq org-agenda-custom-commands
1531 '(("f" occur-tree "FIXME")))
1534 @noindent will define the key @kbd{C-c a f} as a shortcut for creating
1535 a sparse tree matching the string @samp{FIXME}.
1537 The other sparse tree commands select headings based on TODO keywords,
1538 tags, or properties and will be discussed later in this manual.
1541 @cindex printing sparse trees
1542 @cindex visible text, printing
1543 To print a sparse tree, you can use the Emacs command
1544 @code{ps-print-buffer-with-faces} which does not print invisible parts
1545 of the document @footnote{This does not work under XEmacs, because
1546 XEmacs uses selective display for outlining, not text properties.}.
1547 Or you can use the command @kbd{C-c C-e v} to export only the visible
1548 part of the document and print the resulting file.
1550 @node Plain lists, Drawers, Sparse trees, Document Structure
1551 @section Plain lists
1553 @cindex lists, plain
1554 @cindex lists, ordered
1555 @cindex ordered lists
1557 Within an entry of the outline tree, hand-formatted lists can provide
1558 additional structure. They also provide a way to create lists of checkboxes
1559 (@pxref{Checkboxes}). Org supports editing such lists, and every exporter
1560 (@pxref{Exporting}) can parse and format them.
1562 Org knows ordered lists, unordered lists, and description lists.
1565 @emph{Unordered} list items start with @samp{-}, @samp{+}, or
1566 @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
1567 they will be seen as top-level headlines. Also, when you are hiding leading
1568 stars to get a clean outline view, plain list items starting with a star may
1569 be hard to distinguish from true headlines. In short: even though @samp{*}
1570 is supported, it may be better to not use it for plain list items.} as
1573 @vindex org-plain-list-ordered-item-terminator
1574 @vindex org-alphabetical-lists
1575 @emph{Ordered} list items start with a numeral followed by either a period or
1576 a right parenthesis@footnote{You can filter out any of them by configuring
1577 @code{org-plain-list-ordered-item-terminator}.}, such as @samp{1.} or
1578 @samp{1)}@footnote{You can also get @samp{a.}, @samp{A.}, @samp{a)} and
1579 @samp{A)} by configuring @code{org-alphabetical-lists}. To minimize
1580 confusion with normal text, those are limited to one character only. Beyond
1581 that limit, bullets will automatically fallback to numbers.}. If you want a
1582 list to start with a different value (e.g.@: 20), start the text of the item
1583 with @code{[@@20]}@footnote{If there's a checkbox in the item, the cookie
1584 must be put @emph{before} the checkbox. If you have activated alphabetical
1585 lists, you can also use counters like @code{[@@b]}.}. Those constructs can
1586 be used in any item of the list in order to enforce a particular numbering.
1588 @emph{Description} list items are unordered list items, and contain the
1589 separator @samp{ :: } to distinguish the description @emph{term} from the
1593 Items belonging to the same list must have the same indentation on the first
1594 line. In particular, if an ordered list reaches number @samp{10.}, then the
1595 2--digit numbers must be written left-aligned with the other numbers in the
1596 list. An item ends before the next line that is less or equally indented
1597 than its bullet/number.
1599 @vindex org-list-ending-method
1600 @vindex org-list-end-regexp
1601 @vindex org-empty-line-terminates-plain-lists
1602 Two methods@footnote{To disable either of them, configure
1603 @code{org-list-ending-method}.} are provided to terminate lists. A list ends
1604 whenever every item has ended, which means before any line less or equally
1605 indented than items at top level. It also ends before two blank
1606 lines@footnote{See also @code{org-empty-line-terminates-plain-lists}.}. In
1607 that case, all items are closed. For finer control, you can end lists with
1608 any pattern set in @code{org-list-end-regexp}. Here is an example:
1612 ** Lord of the Rings
1613 My favorite scenes are (in this order)
1614 1. The attack of the Rohirrim
1615 2. Eowyn's fight with the witch king
1616 + this was already my favorite scene in the book
1617 + I really like Miranda Otto.
1618 3. Peter Jackson being shot by Legolas
1620 He makes a really funny face when it happens.
1621 But in the end, no individual scenes matter but the film as a whole.
1622 Important actors in this film are:
1623 - @b{Elijah Wood} :: He plays Frodo
1624 - @b{Sean Austin} :: He plays Sam, Frodo's friend. I still remember
1625 him very well from his role as Mikey Walsh in @i{The Goonies}.
1629 Org supports these lists by tuning filling and wrapping commands to deal with
1630 them correctly@footnote{Org only changes the filling settings for Emacs. For
1631 XEmacs, you should use Kyle E. Jones' @file{filladapt.el}. To turn this on,
1632 put into @file{.emacs}: @code{(require 'filladapt)}}, and by exporting them
1633 properly (@pxref{Exporting}). Since indentation is what governs the
1634 structure of these lists, many structural constructs like @code{#+BEGIN_...}
1635 blocks can be indented to signal that they belong to a particular item.
1637 @vindex org-list-demote-modify-bullet
1638 @vindex org-list-indent-offset
1639 If you find that using a different bullet for a sub-list (than that used for
1640 the current list-level) improves readability, customize the variable
1641 @code{org-list-demote-modify-bullet}. To get a greater difference of
1642 indentation between items and theirs sub-items, customize
1643 @code{org-list-indent-offset}.
1645 @vindex org-list-automatic-rules
1646 The following commands act on items when the cursor is in the first line of
1647 an item (the line with the bullet or number). Some of them imply the
1648 application of automatic rules to keep list structure intact. If some of
1649 these actions get in your way, configure @code{org-list-automatic-rules}
1650 to disable them individually.
1653 @orgcmd{@key{TAB},org-cycle}
1654 @cindex cycling, in plain lists
1655 @vindex org-cycle-include-plain-lists
1656 Items can be folded just like headline levels. Normally this works only if
1657 the cursor is on a plain list item. For more details, see the variable
1658 @code{org-cycle-include-plain-lists}. If this variable is set to
1659 @code{integrate}, plain list items will be treated like low-level
1660 headlines. The level of an item is then given by the indentation of the
1661 bullet/number. Items are always subordinate to real headlines, however; the
1662 hierarchies remain completely separated. In a new item with no text yet, the
1663 first @key{TAB} demotes the item to become a child of the previous
1664 one. Subsequent @key{TAB}s move the item to meaningful levels in the list
1665 and eventually get it back to its initial position.
1666 @orgcmd{M-@key{RET},org-insert-heading}
1667 @vindex org-M-RET-may-split-line
1668 @vindex org-list-automatic-rules
1669 Insert new item at current level. With a prefix argument, force a new
1670 heading (@pxref{Structure editing}). If this command is used in the middle
1671 of an item, that item is @emph{split} in two, and the second part becomes the
1672 new item@footnote{If you do not want the item to be split, customize the
1673 variable @code{org-M-RET-may-split-line}.}. If this command is executed
1674 @emph{before item's body}, the new item is created @emph{before} the current
1679 @kindex M-S-@key{RET}
1681 Insert a new item with a checkbox (@pxref{Checkboxes}).
1682 @kindex S-@key{down}
1685 @cindex shift-selection-mode
1686 @vindex org-support-shift-select
1687 @vindex org-list-use-circular-motion
1688 Jump to the previous/next item in the current list@footnote{If you want to
1689 cycle around items that way, you may customize
1690 @code{org-list-use-circular-motion}.}, but only if
1691 @code{org-support-shift-select} is off. If not, you can still use paragraph
1692 jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite
1695 @kindex M-@key{down}
1698 Move the item including subitems up/down@footnote{See
1699 @code{org-liste-use-circular-motion} for a cyclic behavior.} (swap with
1700 previous/next item of same indentation). If the list is ordered, renumbering
1702 @kindex M-@key{left}
1703 @kindex M-@key{right}
1706 Decrease/increase the indentation of an item, leaving children alone.
1707 @kindex M-S-@key{left}
1708 @kindex M-S-@key{right}
1711 Decrease/increase the indentation of the item, including subitems.
1712 Initially, the item tree is selected based on current indentation. When
1713 these commands are executed several times in direct succession, the initially
1714 selected region is used, even if the new indentation would imply a different
1715 hierarchy. To use the new hierarchy, break the command chain with a cursor
1718 As a special case, using this command on the very first item of a list will
1719 move the whole list. This behavior can be disabled by configuring
1720 @code{org-list-automatic-rules}. The global indentation of a list has no
1721 influence on the text @emph{after} the list.
1724 If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
1725 state of the checkbox. In any case, verify bullets and indentation
1726 consistency in the whole list.
1728 @vindex org-plain-list-ordered-item-terminator
1729 @vindex org-list-automatic-rules
1731 Cycle the entire list level through the different itemize/enumerate bullets
1732 (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}) or a subset of them,
1733 depending on @code{org-plain-list-ordered-item-terminator}, the type of list,
1734 and its position@footnote{See @code{bullet} rule in
1735 @code{org-list-automatic-rules} for more information.}. With a numeric
1736 prefix argument N, select the Nth bullet from this list. If there is an
1737 active region when calling this, selected text will be changed into an item.
1738 With a prefix argument, all lines will be converted to list items. If the
1739 first line already was a list item, any item marker will be removed from the
1740 list. Finally, even without an active region, a normal line will be
1741 converted into a list item.
1744 Turn a plain list item into a headline (so that it becomes a subheading at
1745 its location). @xref{Structure editing}, for a detailed explanation.
1748 Turn the whole plain list into a subtree of the current heading. Checkboxes
1749 (@pxref{Checkboxes}) will become TODO (resp. DONE) keywords when unchecked
1751 @kindex S-@key{left}
1752 @kindex S-@key{right}
1754 @vindex org-support-shift-select
1755 This command also cycles bullet styles when the cursor in on the bullet or
1756 anywhere in an item line, details depending on
1757 @code{org-support-shift-select}.
1760 Sort the plain list. You will be prompted for the sorting method:
1761 numerically, alphabetically, by time, or by custom function.
1764 @node Drawers, Blocks, Plain lists, Document Structure
1768 @cindex visibility cycling, drawers
1771 @cindex org-insert-drawer
1773 Sometimes you want to keep information associated with an entry, but you
1774 normally don't want to see it. For this, Org mode has @emph{drawers}.
1775 Drawers need to be configured with the variable
1776 @code{org-drawers}@footnote{You can define drawers on a per-file basis
1777 with a line like @code{#+DRAWERS: HIDDEN PROPERTIES STATE}}. Drawers
1781 ** This is a headline
1782 Still outside the drawer
1784 This is inside the drawer.
1789 You can interactively insert drawers at point by calling
1790 @code{org-insert-drawer}, which is bound to @key{C-c C-x d}. With an active
1791 region, this command will put the region inside the drawer. With a prefix
1792 argument, this command calls @code{org-insert-property-drawer} and add a
1793 property drawer right below the current headline. Completion over drawer
1794 keywords is also possible using @key{M-TAB}.
1796 Visibility cycling (@pxref{Visibility cycling}) on the headline will hide and
1797 show the entry, but keep the drawer collapsed to a single line. In order to
1798 look inside the drawer, you need to move the cursor to the drawer line and
1799 press @key{TAB} there. Org mode uses the @code{PROPERTIES} drawer for
1800 storing properties (@pxref{Properties and Columns}), and you can also arrange
1801 for state change notes (@pxref{Tracking TODO state changes}) and clock times
1802 (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}. If you
1803 want to store a quick note in the LOGBOOK drawer, in a similar way to state changes, use
1808 Add a time-stamped note to the LOGBOOK drawer.
1811 @node Blocks, Footnotes, Drawers, Document Structure
1814 @vindex org-hide-block-startup
1815 @cindex blocks, folding
1816 Org mode uses begin...end blocks for various purposes from including source
1817 code examples (@pxref{Literal examples}) to capturing time logging
1818 information (@pxref{Clocking work time}). These blocks can be folded and
1819 unfolded by pressing TAB in the begin line. You can also get all blocks
1820 folded at startup by configuring the variable @code{org-hide-block-startup}
1821 or on a per-file basis by using
1823 @cindex @code{hideblocks}, STARTUP keyword
1824 @cindex @code{nohideblocks}, STARTUP keyword
1826 #+STARTUP: hideblocks
1827 #+STARTUP: nohideblocks
1830 @node Footnotes, Orgstruct mode, Blocks, Document Structure
1834 Org mode supports the creation of footnotes. In contrast to the
1835 @file{footnote.el} package, Org mode's footnotes are designed for work on a
1836 larger document, not only for one-off documents like emails. The basic
1837 syntax is similar to the one used by @file{footnote.el}, i.e.@: a footnote is
1838 defined in a paragraph that is started by a footnote marker in square
1839 brackets in column 0, no indentation allowed. If you need a paragraph break
1840 inside a footnote, use the @LaTeX{} idiom @samp{\par}. The footnote reference
1841 is simply the marker in square brackets, inside text. For example:
1844 The Org homepage[fn:1] now looks a lot better than it used to.
1846 [fn:1] The link is: http://orgmode.org
1849 Org mode extends the number-based syntax to @emph{named} footnotes and
1850 optional inline definition. Using plain numbers as markers (as
1851 @file{footnote.el} does) is supported for backward compatibility, but not
1852 encouraged because of possible conflicts with @LaTeX{} snippets (@pxref{Embedded
1853 @LaTeX{}}). Here are the valid references:
1857 A plain numeric footnote marker. Compatible with @file{footnote.el}, but not
1858 recommended because something like @samp{[1]} could easily be part of a code
1861 A named footnote reference, where @code{name} is a unique label word, or, for
1862 simplicity of automatic creation, a number.
1863 @item [fn:: This is the inline definition of this footnote]
1864 A @LaTeX{}-like anonymous footnote where the definition is given directly at the
1866 @item [fn:name: a definition]
1867 An inline definition of a footnote, which also specifies a name for the note.
1868 Since Org allows multiple references to the same note, you can then use
1869 @code{[fn:name]} to create additional references.
1872 @vindex org-footnote-auto-label
1873 Footnote labels can be created automatically, or you can create names yourself.
1874 This is handled by the variable @code{org-footnote-auto-label} and its
1875 corresponding @code{#+STARTUP} keywords. See the docstring of that variable
1878 @noindent The following command handles footnotes:
1883 The footnote action command.
1885 When the cursor is on a footnote reference, jump to the definition. When it
1886 is at a definition, jump to the (first) reference.
1888 @vindex org-footnote-define-inline
1889 @vindex org-footnote-section
1890 @vindex org-footnote-auto-adjust
1891 Otherwise, create a new footnote. Depending on the variable
1892 @code{org-footnote-define-inline}@footnote{The corresponding in-buffer
1893 setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
1894 definition will be placed right into the text as part of the reference, or
1895 separately into the location determined by the variable
1896 @code{org-footnote-section}.
1898 When this command is called with a prefix argument, a menu of additional
1901 s @r{Sort the footnote definitions by reference sequence. During editing,}
1902 @r{Org makes no effort to sort footnote definitions into a particular}
1903 @r{sequence. If you want them sorted, use this command, which will}
1904 @r{also move entries according to @code{org-footnote-section}. Automatic}
1905 @r{sorting after each insertion/deletion can be configured using the}
1906 @r{variable @code{org-footnote-auto-adjust}.}
1907 r @r{Renumber the simple @code{fn:N} footnotes. Automatic renumbering}
1908 @r{after each insertion/deletion can be configured using the variable}
1909 @r{@code{org-footnote-auto-adjust}.}
1910 S @r{Short for first @code{r}, then @code{s} action.}
1911 n @r{Normalize the footnotes by collecting all definitions (including}
1912 @r{inline definitions) into a special section, and then numbering them}
1913 @r{in sequence. The references will then also be numbers. This is}
1914 @r{meant to be the final step before finishing a document (e.g.@: sending}
1915 @r{off an email). The exporters do this automatically, and so could}
1916 @r{something like @code{message-send-hook}.}
1917 d @r{Delete the footnote at point, and all definitions of and references}
1920 Depending on the variable @code{org-footnote-auto-adjust}@footnote{the
1921 corresponding in-buffer options are @code{fnadjust} and @code{nofnadjust}.},
1922 renumbering and sorting footnotes can be automatic after each insertion or
1927 If the cursor is on a footnote reference, jump to the definition. If it is a
1928 the definition, jump back to the reference. When called at a footnote
1929 location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
1933 @item C-c C-o @r{or} mouse-1/2
1934 Footnote labels are also links to the corresponding definition/reference, and
1935 you can use the usual commands to follow these links.
1938 @node Orgstruct mode, , Footnotes, Document Structure
1939 @section The Orgstruct minor mode
1940 @cindex Orgstruct mode
1941 @cindex minor mode for structure editing
1943 If you like the intuitive way the Org mode structure editing and list
1944 formatting works, you might want to use these commands in other modes like
1945 Text mode or Mail mode as well. The minor mode @code{orgstruct-mode} makes
1946 this possible. Toggle the mode with @kbd{M-x orgstruct-mode}, or
1947 turn it on by default, for example in Message mode, with one of:
1950 (add-hook 'message-mode-hook 'turn-on-orgstruct)
1951 (add-hook 'message-mode-hook 'turn-on-orgstruct++)
1954 When this mode is active and the cursor is on a line that looks to Org like a
1955 headline or the first line of a list item, most structure editing commands
1956 will work, even if the same keys normally have different functionality in the
1957 major mode you are using. If the cursor is not in one of those special
1958 lines, Orgstruct mode lurks silently in the shadows. When you use
1959 @code{orgstruct++-mode}, Org will also export indentation and autofill
1960 settings into that mode, and detect item context after the first line of an
1963 @node Tables, Hyperlinks, Document Structure, Top
1966 @cindex editing tables
1968 Org comes with a fast and intuitive table editor. Spreadsheet-like
1969 calculations are supported using the Emacs @file{calc} package
1971 (@pxref{Top,Calc,,Calc,Gnu Emacs Calculator Manual}).
1974 (see the Emacs Calculator manual for more information about the Emacs
1979 * Built-in table editor:: Simple tables
1980 * Column width and alignment:: Overrule the automatic settings
1981 * Column groups:: Grouping to trigger vertical lines
1982 * Orgtbl mode:: The table editor as minor mode
1983 * The spreadsheet:: The table editor has spreadsheet capabilities
1984 * Org-Plot:: Plotting from org tables
1987 @node Built-in table editor, Column width and alignment, Tables, Tables
1988 @section The built-in table editor
1989 @cindex table editor, built-in
1991 Org makes it easy to format tables in plain ASCII. Any line with @samp{|} as
1992 the first non-whitespace character is considered part of a table. @samp{|}
1993 is also the column separator@footnote{To insert a vertical bar into a table
1994 field, use @code{\vert} or, inside a word @code{abc\vert@{@}def}.}. A table
1995 might look like this:
1998 | Name | Phone | Age |
1999 |-------+-------+-----|
2000 | Peter | 1234 | 17 |
2001 | Anna | 4321 | 25 |
2004 A table is re-aligned automatically each time you press @key{TAB} or
2005 @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to
2006 the next field (@key{RET} to the next row) and creates new table rows
2007 at the end of the table or before horizontal lines. The indentation
2008 of the table is set by the first line. Any line starting with
2009 @samp{|-} is considered as a horizontal separator line and will be
2010 expanded on the next re-align to span the whole table width. So, to
2011 create the above table, you would only type
2018 @noindent and then press @key{TAB} to align the table and start filling in
2019 fields. Even faster would be to type @code{|Name|Phone|Age} followed by
2020 @kbd{C-c @key{RET}}.
2022 @vindex org-enable-table-editor
2023 @vindex org-table-auto-blank-field
2024 When typing text into a field, Org treats @key{DEL},
2025 @key{Backspace}, and all character keys in a special way, so that
2026 inserting and deleting avoids shifting other fields. Also, when
2027 typing @emph{immediately after the cursor was moved into a new field
2028 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
2029 field is automatically made blank. If this behavior is too
2030 unpredictable for you, configure the variables
2031 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
2034 @tsubheading{Creation and conversion}
2035 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2036 Convert the active region to table. If every line contains at least one
2037 TAB character, the function assumes that the material is tab separated.
2038 If every line contains a comma, comma-separated values (CSV) are assumed.
2039 If not, lines are split at whitespace into fields. You can use a prefix
2040 argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
2041 C-u} forces TAB, and a numeric argument N indicates that at least N
2042 consecutive spaces, or alternatively a TAB will be the separator.
2044 If there is no active region, this command creates an empty Org
2045 table. But it is easier just to start typing, like
2046 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
2048 @tsubheading{Re-aligning and field motion}
2049 @orgcmd{C-c C-c,org-table-align}
2050 Re-align the table without moving the cursor.
2052 @orgcmd{<TAB>,org-table-next-field}
2053 Re-align the table, move to the next field. Creates a new row if
2056 @orgcmd{S-@key{TAB},org-table-previous-field}
2057 Re-align, move to previous field.
2059 @orgcmd{@key{RET},org-table-next-row}
2060 Re-align the table and move down to next row. Creates a new row if
2061 necessary. At the beginning or end of a line, @key{RET} still does
2062 NEWLINE, so it can be used to split a table.
2064 @orgcmd{M-a,org-table-beginning-of-field}
2065 Move to beginning of the current table field, or on to the previous field.
2066 @orgcmd{M-e,org-table-end-of-field}
2067 Move to end of the current table field, or on to the next field.
2069 @tsubheading{Column and row editing}
2070 @orgcmdkkcc{M-@key{left},M-@key{right},org-table-move-column-left,org-table-move-column-right}
2071 Move the current column left/right.
2073 @orgcmd{M-S-@key{left},org-table-delete-column}
2074 Kill the current column.
2076 @orgcmd{M-S-@key{right},org-table-insert-column}
2077 Insert a new column to the left of the cursor position.
2079 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-move-row-up,org-table-move-row-down}
2080 Move the current row up/down.
2082 @orgcmd{M-S-@key{up},org-table-kill-row}
2083 Kill the current row or horizontal line.
2085 @orgcmd{M-S-@key{down},org-table-insert-row}
2086 Insert a new row above the current row. With a prefix argument, the line is
2087 created below the current one.
2089 @orgcmd{C-c -,org-table-insert-hline}
2090 Insert a horizontal line below current row. With a prefix argument, the line
2091 is created above the current line.
2093 @orgcmd{C-c @key{RET},org-table-hline-and-move}
2094 Insert a horizontal line below current row, and move the cursor into the row
2097 @orgcmd{C-c ^,org-table-sort-lines}
2098 Sort the table lines in the region. The position of point indicates the
2099 column to be used for sorting, and the range of lines is the range
2100 between the nearest horizontal separator lines, or the entire table. If
2101 point is before the first column, you will be prompted for the sorting
2102 column. If there is an active region, the mark specifies the first line
2103 and the sorting column, while point should be in the last line to be
2104 included into the sorting. The command prompts for the sorting type
2105 (alphabetically, numerically, or by time). When called with a prefix
2106 argument, alphabetic sorting will be case-sensitive.
2108 @tsubheading{Regions}
2109 @orgcmd{C-c C-x M-w,org-table-copy-region}
2110 Copy a rectangular region from a table to a special clipboard. Point and
2111 mark determine edge fields of the rectangle. If there is no active region,
2112 copy just the current field. The process ignores horizontal separator lines.
2114 @orgcmd{C-c C-x C-w,org-table-cut-region}
2115 Copy a rectangular region from a table to a special clipboard, and
2116 blank all fields in the rectangle. So this is the ``cut'' operation.
2118 @orgcmd{C-c C-x C-y,org-table-paste-rectangle}
2119 Paste a rectangular region into a table.
2120 The upper left corner ends up in the current field. All involved fields
2121 will be overwritten. If the rectangle does not fit into the present table,
2122 the table is enlarged as needed. The process ignores horizontal separator
2125 @orgcmd{M-@key{RET},org-table-wrap-region}
2126 Split the current field at the cursor position and move the rest to the line
2127 below. If there is an active region, and both point and mark are in the same
2128 column, the text in the column is wrapped to minimum width for the given
2129 number of lines. A numeric prefix argument may be used to change the number
2130 of desired lines. If there is no region, but you specify a prefix argument,
2131 the current field is made blank, and the content is appended to the field
2134 @tsubheading{Calculations}
2135 @cindex formula, in tables
2136 @cindex calculations, in tables
2137 @cindex region, active
2138 @cindex active region
2139 @cindex transient mark mode
2140 @orgcmd{C-c +,org-table-sum}
2141 Sum the numbers in the current column, or in the rectangle defined by
2142 the active region. The result is shown in the echo area and can
2143 be inserted with @kbd{C-y}.
2145 @orgcmd{S-@key{RET},org-table-copy-down}
2146 @vindex org-table-copy-increment
2147 When current field is empty, copy from first non-empty field above. When not
2148 empty, copy current field down to next row and move cursor along with it.
2149 Depending on the variable @code{org-table-copy-increment}, integer field
2150 values will be incremented during copy. Integers that are too large will not
2151 be incremented. Also, a @code{0} prefix argument temporarily disables the
2152 increment. This key is also used by shift-selection and related modes
2153 (@pxref{Conflicts}).
2155 @tsubheading{Miscellaneous}
2156 @orgcmd{C-c `,org-table-edit-field}
2157 Edit the current field in a separate window. This is useful for fields that
2158 are not fully visible (@pxref{Column width and alignment}). When called with
2159 a @kbd{C-u} prefix, just make the full field visible, so that it can be
2160 edited in place. When called with two @kbd{C-u} prefixes, make the editor
2161 window follow the cursor through the table and always show the current
2162 field. The follow mode exits automatically when the cursor leaves the table,
2163 or when you repeat this command with @kbd{C-u C-u C-c `}.
2165 @item M-x org-table-import
2166 Import a file as a table. The table should be TAB or whitespace
2167 separated. Use, for example, to import a spreadsheet table or data
2168 from a database, because these programs generally can write
2169 TAB-separated text files. This command works by inserting the file into
2170 the buffer and then converting the region to a table. Any prefix
2171 argument is passed on to the converter, which uses it to determine the
2173 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2174 Tables can also be imported by pasting tabular text into the Org
2175 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
2176 @kbd{C-c |} command (see above under @i{Creation and conversion}).
2178 @item M-x org-table-export
2179 @findex org-table-export
2180 @vindex org-table-export-default-format
2181 Export the table, by default as a TAB-separated file. Use for data
2182 exchange with, for example, spreadsheet or database programs. The format
2183 used to export the file can be configured in the variable
2184 @code{org-table-export-default-format}. You may also use properties
2185 @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
2186 name and the format for table export in a subtree. Org supports quite
2187 general formats for exported tables. The exporter format is the same as the
2188 format used by Orgtbl radio tables, see @ref{Translator functions}, for a
2189 detailed description.
2192 If you don't like the automatic table editor because it gets in your
2193 way on lines which you would like to start with @samp{|}, you can turn
2197 (setq org-enable-table-editor nil)
2200 @noindent Then the only table command that still works is
2201 @kbd{C-c C-c} to do a manual re-align.
2203 @node Column width and alignment, Column groups, Built-in table editor, Tables
2204 @section Column width and alignment
2205 @cindex narrow columns in tables
2206 @cindex alignment in tables
2208 The width of columns is automatically determined by the table editor. And
2209 also the alignment of a column is determined automatically from the fraction
2210 of number-like versus non-number fields in the column.
2212 Sometimes a single field or a few fields need to carry more text, leading to
2213 inconveniently wide columns. Or maybe you want to make a table with several
2214 columns having a fixed width, regardless of content. To set@footnote{This
2215 feature does not work on XEmacs.} the width of a column, one field anywhere
2216 in the column may contain just the string @samp{<N>} where @samp{N} is an
2217 integer specifying the width of the column in characters. The next re-align
2218 will then set the width of this column to this value.
2222 |---+------------------------------| |---+--------|
2224 | 1 | one | | 1 | one |
2225 | 2 | two | ----\ | 2 | two |
2226 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
2227 | 4 | four | | 4 | four |
2228 |---+------------------------------| |---+--------|
2233 Fields that are wider become clipped and end in the string @samp{=>}.
2234 Note that the full text is still in the buffer but is hidden.
2235 To see the full text, hold the mouse over the field---a tool-tip window
2236 will show the full content. To edit such a field, use the command
2237 @kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will
2238 open a new window with the full field. Edit it and finish with @kbd{C-c
2241 @vindex org-startup-align-all-tables
2242 When visiting a file containing a table with narrowed columns, the
2243 necessary character hiding has not yet happened, and the table needs to
2244 be aligned before it looks nice. Setting the option
2245 @code{org-startup-align-all-tables} will realign all tables in a file
2246 upon visiting, but also slow down startup. You can also set this option
2247 on a per-file basis with:
2254 If you would like to overrule the automatic alignment of number-rich columns
2255 to the right and of string-rich column to the left, you can use @samp{<r>},
2256 @samp{c}@footnote{Centering does not work inside Emacs, but it does have an
2257 effect when exporting to HTML.} or @samp{<l>} in a similar fashion. You may
2258 also combine alignment and field width like this: @samp{<l10>}.
2260 Lines which only contain these formatting cookies will be removed
2261 automatically when exporting the document.
2263 @node Column groups, Orgtbl mode, Column width and alignment, Tables
2264 @section Column groups
2265 @cindex grouping columns in tables
2267 When Org exports tables, it does so by default without vertical
2268 lines because that is visually more satisfying in general. Occasionally
2269 however, vertical lines can be useful to structure a table into groups
2270 of columns, much like horizontal lines can do for groups of rows. In
2271 order to specify column groups, you can use a special row where the
2272 first field contains only @samp{/}. The further fields can either
2273 contain @samp{<} to indicate that this column should start a group,
2274 @samp{>} to indicate the end of a column, or @samp{<>} to make a column
2275 a group of its own. Boundaries between column groups will upon export be
2276 marked with vertical lines. Here is an example:
2279 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2280 |---+-----+-----+-----+---------+------------|
2281 | / | < | | > | < | > |
2282 | 1 | 1 | 1 | 1 | 1 | 1 |
2283 | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
2284 | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
2285 |---+-----+-----+-----+---------+------------|
2286 #+TBLFM: $2=$1^2::$3=$1^3::$4=$1^4::$5=sqrt($1)::$6=sqrt(sqrt(($1)))
2289 It is also sufficient to just insert the column group starters after
2290 every vertical line you would like to have:
2293 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2294 |----+-----+-----+-----+---------+------------|
2298 @node Orgtbl mode, The spreadsheet, Column groups, Tables
2299 @section The Orgtbl minor mode
2301 @cindex minor mode for tables
2303 If you like the intuitive way the Org table editor works, you
2304 might also want to use it in other modes like Text mode or Mail mode.
2305 The minor mode Orgtbl mode makes this possible. You can always toggle
2306 the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for
2307 example in Message mode, use
2310 (add-hook 'message-mode-hook 'turn-on-orgtbl)
2313 Furthermore, with some special setup, it is possible to maintain tables
2314 in arbitrary syntax with Orgtbl mode. For example, it is possible to
2315 construct @LaTeX{} tables with the underlying ease and power of
2316 Orgtbl mode, including spreadsheet capabilities. For details, see
2317 @ref{Tables in arbitrary syntax}.
2319 @node The spreadsheet, Org-Plot, Orgtbl mode, Tables
2320 @section The spreadsheet
2321 @cindex calculations, in tables
2322 @cindex spreadsheet capabilities
2323 @cindex @file{calc} package
2325 The table editor makes use of the Emacs @file{calc} package to implement
2326 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
2327 derive fields from other fields. While fully featured, Org's implementation
2328 is not identical to other spreadsheets. For example, Org knows the concept
2329 of a @emph{column formula} that will be applied to all non-header fields in a
2330 column without having to copy the formula to each relevant field. There is
2331 also a formula debugger, and a formula editor with features for highlighting
2332 fields in the table corresponding to the references at the point in the
2333 formula, moving these references by arrow keys
2336 * References:: How to refer to another field or range
2337 * Formula syntax for Calc:: Using Calc to compute stuff
2338 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
2339 * Durations and time values:: How to compute durations and time values
2340 * Field and range formulas:: Formula for specific (ranges of) fields
2341 * Column formulas:: Formulas valid for an entire column
2342 * Editing and debugging formulas:: Fixing formulas
2343 * Updating the table:: Recomputing all dependent fields
2344 * Advanced features:: Field and column names, parameters and automatic recalc
2347 @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet
2348 @subsection References
2351 To compute fields in the table from other fields, formulas must
2352 reference other fields or ranges. In Org, fields can be referenced
2353 by name, by absolute coordinates, and by relative coordinates. To find
2354 out what the coordinates of a field are, press @kbd{C-c ?} in that
2355 field, or press @kbd{C-c @}} to toggle the display of a grid.
2357 @subsubheading Field references
2358 @cindex field references
2359 @cindex references, to fields
2361 Formulas can reference the value of another field in two ways. Like in
2362 any other spreadsheet, you may reference fields with a letter/number
2363 combination like @code{B3}, meaning the 2nd field in the 3rd row.
2364 @vindex org-table-use-standard-references
2365 However, Org prefers@footnote{Org will understand references typed by the
2366 user as @samp{B4}, but it will not use this syntax when offering a formula
2367 for editing. You can customize this behavior using the variable
2368 @code{org-table-use-standard-references}.} to use another, more general
2369 representation that looks like this:
2371 @@@var{row}$@var{column}
2374 Column specifications can be absolute like @code{$1},
2375 @code{$2},...@code{$@var{N}}, or relative to the current column (i.e.@: the
2376 column of the field which is being computed) like @code{$+1} or @code{$-2}.
2377 @code{$<} and @code{$>} are immutable references to the first and last
2378 column, respectively, and you can use @code{$>>>} to indicate the third
2379 column from the right.
2381 The row specification only counts data lines and ignores horizontal separator
2382 lines (hlines). Like with columns, you can use absolute row numbers
2383 @code{@@1}, @code{@@2},...@code{@@@var{N}}, and row numbers relative to the
2384 current row like @code{@@+3} or @code{@@-1}. @code{@@<} and @code{@@>} are
2385 immutable references the first and last@footnote{For backward compatibility
2386 you can also use special names like @code{$LR5} and @code{$LR12} to refer in
2387 a stable way to the 5th and 12th field in the last row of the table.
2388 However, this syntax is deprecated, it should not be used for new documents.
2389 Use @code{@@>$} instead.} row in the table, respectively. You may also
2390 specify the row relative to one of the hlines: @code{@@I} refers to the first
2391 hline, @code{@@II} to the second, etc@. @code{@@-I} refers to the first such
2392 line above the current line, @code{@@+I} to the first such line below the
2393 current line. You can also write @code{@@III+2} which is the second data line
2394 after the third hline in the table.
2396 @code{@@0} and @code{$0} refer to the current row and column, respectively,
2397 i.e. to the row/column for the field being computed. Also, if you omit
2398 either the column or the row part of the reference, the current row/column is
2401 Org's references with @emph{unsigned} numbers are fixed references
2402 in the sense that if you use the same reference in the formula for two
2403 different fields, the same field will be referenced each time.
2404 Org's references with @emph{signed} numbers are floating
2405 references because the same reference operator can reference different
2406 fields depending on the field being calculated by the formula.
2408 Here are a few examples:
2411 @@2$3 @r{2nd row, 3rd column (same as @code{C2})}
2412 $5 @r{column 5 in the current row (same as @code{E&})}
2413 @@2 @r{current column, row 2}
2414 @@-1$-3 @r{the field one row up, three columns to the left}
2415 @@-I$2 @r{field just under hline above current row, column 2}
2416 @@>$5 @r{field in the last row, in column 5}
2419 @subsubheading Range references
2420 @cindex range references
2421 @cindex references, to ranges
2423 You may reference a rectangular range of fields by specifying two field
2424 references connected by two dots @samp{..}. If both fields are in the
2425 current row, you may simply use @samp{$2..$7}, but if at least one field
2426 is in a different row, you need to use the general @code{@@row$column}
2427 format at least for the first field (i.e the reference must start with
2428 @samp{@@} in order to be interpreted correctly). Examples:
2431 $1..$3 @r{first three fields in the current row}
2432 $P..$Q @r{range, using column names (see under Advanced)}
2433 $<<<..$>> @r{start in third column, continue to the one but last}
2434 @@2$1..@@4$3 @r{6 fields between these two fields (same as @code{A2..C4})}
2435 @@-1$-2..@@-1 @r{3 numbers from the column to the left, 2 up to current row}
2436 @@I..II @r{between first and second hline, short for @code{@@I..@@II}}
2439 @noindent Range references return a vector of values that can be fed
2440 into Calc vector functions. Empty fields in ranges are normally
2441 suppressed, so that the vector contains only the non-empty fields (but
2442 see the @samp{E} mode switch below). If there are no non-empty fields,
2443 @samp{[0]} is returned to avoid syntax errors in formulas.
2445 @subsubheading Field coordinates in formulas
2446 @cindex field coordinates
2447 @cindex coordinates, of field
2448 @cindex row, of field coordinates
2449 @cindex column, of field coordinates
2451 For Calc formulas and Lisp formulas @code{@@#} and @code{$#} can be used to
2452 get the row or column number of the field where the formula result goes.
2453 The traditional Lisp formula equivalents are @code{org-table-current-dline}
2454 and @code{org-table-current-column}. Examples:
2457 if(@@# % 2, $#, string("")) @r{column number on odd lines only}
2458 $3 = remote(FOO, @@@@#$2) @r{copy column 2 from table FOO into}
2459 @r{column 3 of the current table}
2462 @noindent For the second example, table FOO must have at least as many rows
2463 as the current table. Note that this is inefficient@footnote{The computation time scales as
2464 O(N^2) because table FOO is parsed for each field to be copied.} for large
2467 @subsubheading Named references
2468 @cindex named references
2469 @cindex references, named
2470 @cindex name, of column or field
2471 @cindex constants, in calculations
2474 @vindex org-table-formula-constants
2475 @samp{$name} is interpreted as the name of a column, parameter or
2476 constant. Constants are defined globally through the variable
2477 @code{org-table-formula-constants}, and locally (for the file) through a
2481 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
2485 @vindex constants-unit-system
2486 @pindex constants.el
2487 Also properties (@pxref{Properties and Columns}) can be used as
2488 constants in table formulas: for a property @samp{:Xyz:} use the name
2489 @samp{$PROP_Xyz}, and the property will be searched in the current
2490 outline entry and in the hierarchy above it. If you have the
2491 @file{constants.el} package, it will also be used to resolve constants,
2492 including natural constants like @samp{$h} for Planck's constant, and
2493 units like @samp{$km} for kilometers@footnote{@file{constants.el} can
2494 supply the values of constants in two different unit systems, @code{SI}
2495 and @code{cgs}. Which one is used depends on the value of the variable
2496 @code{constants-unit-system}. You can use the @code{#+STARTUP} options
2497 @code{constSI} and @code{constcgs} to set this value for the current
2498 buffer.}. Column names and parameters can be specified in special table
2499 lines. These are described below, see @ref{Advanced features}. All
2500 names must start with a letter, and further consist of letters and
2503 @subsubheading Remote references
2504 @cindex remote references
2505 @cindex references, remote
2506 @cindex references, to a different table
2507 @cindex name, of column or field
2508 @cindex constants, in calculations
2511 You may also reference constants, fields and ranges from a different table,
2512 either in the current file or even in a different file. The syntax is
2515 remote(NAME-OR-ID,REF)
2519 where NAME can be the name of a table in the current file as set by a
2520 @code{#+TBLNAME: NAME} line before the table. It can also be the ID of an
2521 entry, even in a different file, and the reference then refers to the first
2522 table in that entry. REF is an absolute field or range reference as
2523 described above for example @code{@@3$3} or @code{$somename}, valid in the
2526 @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet
2527 @subsection Formula syntax for Calc
2528 @cindex formula syntax, Calc
2529 @cindex syntax, of formulas
2531 A formula can be any algebraic expression understood by the Emacs
2532 @file{Calc} package. @b{Note that @file{calc} has the
2533 non-standard convention that @samp{/} has lower precedence than
2534 @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.} Before
2535 evaluation by @code{calc-eval} (@pxref{Calling Calc from
2536 Your Programs,calc-eval,Calling Calc from Your Lisp Programs,Calc,GNU
2537 Emacs Calc Manual}),
2538 @c FIXME: The link to the Calc manual in HTML does not work.
2539 variable substitution takes place according to the rules described above.
2540 @cindex vectors, in table calculations
2541 The range vectors can be directly fed into the Calc vector functions
2542 like @samp{vmean} and @samp{vsum}.
2544 @cindex format specifier
2545 @cindex mode, for @file{calc}
2546 @vindex org-calc-default-modes
2547 A formula can contain an optional mode string after a semicolon. This
2548 string consists of flags to influence Calc and other modes during
2549 execution. By default, Org uses the standard Calc modes (precision
2550 12, angular units degrees, fraction and symbolic modes off). The display
2551 format, however, has been changed to @code{(float 8)} to keep tables
2552 compact. The default settings can be configured using the variable
2553 @code{org-calc-default-modes}.
2556 p20 @r{set the internal Calc calculation precision to 20 digits}
2557 n3 s3 e2 f4 @r{Normal, scientific, engineering, or fixed}
2558 @r{format of the result of Calc passed back to Org.}
2559 @r{Calc formatting is unlimited in precision as}
2560 @r{long as the Calc calculation precision is greater.}
2561 D R @r{angle modes: degrees, radians}
2562 F S @r{fraction and symbolic modes}
2563 N @r{interpret all fields as numbers, use 0 for non-numbers}
2564 E @r{keep empty fields in ranges}
2569 Unless you use large integer numbers or high-precision-calculation
2570 and -display for floating point numbers you may alternatively provide a
2571 @code{printf} format specifier to reformat the Calc result after it has been
2572 passed back to Org instead of letting Calc already do the
2573 formatting@footnote{The @code{printf} reformatting is limited in precision
2574 because the value passed to it is converted into an @code{integer} or
2575 @code{double}. The @code{integer} is limited in size by truncating the
2576 signed value to 32 bits. The @code{double} is limited in precision to 64
2577 bits overall which leaves approximately 16 significant decimal digits.}.
2581 $1+$2 @r{Sum of first and second field}
2582 $1+$2;%.2f @r{Same, format result to two decimals}
2583 exp($2)+exp($1) @r{Math functions can be used}
2584 $0;%.1f @r{Reformat current cell to 1 decimal}
2585 ($3-32)*5/9 @r{Degrees F -> C conversion}
2586 $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}}
2587 tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1}
2588 sin($1);Dp3%.1e @r{Same, but use printf specifier for display}
2589 vmean($2..$7) @r{Compute column range mean, using vector function}
2590 vmean($2..$7);EN @r{Same, but treat empty fields as 0}
2591 taylor($3,x=7,2) @r{Taylor series of $3, at x=7, second degree}
2594 Calc also contains a complete set of logical operations. For example
2597 if($1<20,teen,string("")) @r{"teen" if age $1 less than 20, else empty}
2600 Note that you can also use two org-specific flags @code{T} and @code{t} for
2601 durations computations @ref{Durations and time values}.
2603 @node Formula syntax for Lisp, Durations and time values, Formula syntax for Calc, The spreadsheet
2604 @subsection Emacs Lisp forms as formulas
2605 @cindex Lisp forms, as table formulas
2607 It is also possible to write a formula in Emacs Lisp; this can be useful for
2608 string manipulation and control structures, if Calc's functionality is not
2609 enough. If a formula starts with a single-quote followed by an opening
2610 parenthesis, then it is evaluated as a Lisp form. The evaluation should
2611 return either a string or a number. Just as with @file{calc} formulas, you
2612 can specify modes and a printf format after a semicolon. With Emacs Lisp
2613 forms, you need to be conscious about the way field references are
2614 interpolated into the form. By default, a reference will be interpolated as
2615 a Lisp string (in double-quotes) containing the field. If you provide the
2616 @samp{N} mode switch, all referenced elements will be numbers (non-number
2617 fields will be zero) and interpolated as Lisp numbers, without quotes. If
2618 you provide the @samp{L} flag, all fields will be interpolated literally,
2619 without quotes. I.e., if you want a reference to be interpreted as a string
2620 by the Lisp form, enclose the reference operator itself in double-quotes,
2621 like @code{"$3"}. Ranges are inserted as space-separated fields, so you can
2622 embed them in list or vector syntax. Here are a few examples---note how the
2623 @samp{N} mode is used when we do computations in Lisp:
2626 @r{Swap the first two characters of the content of column 1}
2627 '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
2628 @r{Add columns 1 and 2, equivalent to Calc's @code{$1+$2}}
2630 @r{Compute the sum of columns 1-4, like Calc's @code{vsum($1..$4)}}
2631 '(apply '+ '($1..$4));N
2634 @node Durations and time values, Field and range formulas, Formula syntax for Lisp, The spreadsheet
2635 @subsection Durations and time values
2636 @cindex Duration, computing
2637 @cindex Time, computing
2638 @vindex org-table-duration-custom-format
2640 If you want to compute time values use the @code{T} flag, either in Calc
2641 formulas or Elisp formulas:
2645 | Task 1 | Task 2 | Total |
2646 |---------+----------+----------|
2647 | 2:12 | 1:47 | 03:59:00 |
2648 | 3:02:20 | -2:07:00 | 0.92 |
2649 #+TBLFM: @@2$3=$1+$2;T::@@3$3=$1+$2;t
2653 Input duration values must be of the form @code{[HH:MM[:SS]}, where seconds
2654 are optional. With the @code{T} flag, computed durations will be displayed
2655 as @code{[HH:MM:SS} (see the first formula above). With the @code{t} flag,
2656 computed durations will be displayed according to the value of the variable
2657 @code{org-table-duration-custom-format}, which defaults to @code{'hours} and
2658 will display the result as a fraction of hours (see the second formula in the
2661 Negative duration values can be manipulated as well, and integers will be
2662 considered as seconds in addition and subtraction.
2664 @node Field and range formulas, Column formulas, Durations and time values, The spreadsheet
2665 @subsection Field and range formulas
2666 @cindex field formula
2667 @cindex range formula
2668 @cindex formula, for individual table field
2669 @cindex formula, for range of fields
2671 To assign a formula to a particular field, type it directly into the field,
2672 preceded by @samp{:=}, for example @samp{:=vsum(@@II..III)}. When you press
2673 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2674 the formula will be stored as the formula for this field, evaluated, and the
2675 current field will be replaced with the result.
2678 Formulas are stored in a special line starting with @samp{#+TBLFM:} directly
2679 below the table. If you type the equation in the 4th field of the 3rd data
2680 line in the table, the formula will look like @samp{@@3$4=$1+$2}. When
2681 inserting/deleting/swapping column and rows with the appropriate commands,
2682 @i{absolute references} (but not relative ones) in stored formulas are
2683 modified in order to still reference the same field. To avoid this from
2684 happening, in particular in range references, anchor ranges at the table
2685 borders (using @code{@@<}, @code{@@>}, @code{$<}, @code{$>}), or at hlines
2686 using the @code{@@I} notation. Automatic adaptation of field references does
2687 of cause not happen if you edit the table structure with normal editing
2688 commands---then you must fix the equations yourself.
2690 Instead of typing an equation into the field, you may also use the following
2694 @orgcmd{C-u C-c =,org-table-eval-formula}
2695 Install a new formula for the current field. The command prompts for a
2696 formula with default taken from the @samp{#+TBLFM:} line, applies
2697 it to the current field, and stores it.
2700 The left-hand side of a formula can also be a special expression in order to
2701 assign the formula to a number of different fields. There is no keyboard
2702 shortcut to enter such range formulas. To add them, use the formula editor
2703 (@pxref{Editing and debugging formulas}) or edit the @code{#+TBLFM:} line
2708 Column formula, valid for the entire column. This is so common that Org
2709 treats these formulas in a special way, see @ref{Column formulas}.
2711 Row formula, applies to all fields in the specified row. @code{@@>=} means
2714 Range formula, applies to all fields in the given rectangular range. This
2715 can also be used to assign a formula to some but not all fields in a row.
2717 Named field, see @ref{Advanced features}.
2720 @node Column formulas, Editing and debugging formulas, Field and range formulas, The spreadsheet
2721 @subsection Column formulas
2722 @cindex column formula
2723 @cindex formula, for table column
2725 When you assign a formula to a simple column reference like @code{$3=}, the
2726 same formula will be used in all fields of that column, with the following
2727 very convenient exceptions: (i) If the table contains horizontal separator
2728 hlines, everything before the first such line is considered part of the table
2729 @emph{header} and will not be modified by column formulas. (ii) Fields that
2730 already get a value from a field/range formula will be left alone by column
2731 formulas. These conditions make column formulas very easy to use.
2733 To assign a formula to a column, type it directly into any field in the
2734 column, preceded by an equal sign, like @samp{=$1+$2}. When you press
2735 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2736 the formula will be stored as the formula for the current column, evaluated
2737 and the current field replaced with the result. If the field contains only
2738 @samp{=}, the previously stored formula for this column is used. For each
2739 column, Org will only remember the most recently used formula. In the
2740 @samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}. The
2741 left-hand side of a column formula can not be the name of column, it must be
2742 the numeric column reference or @code{$>}.
2744 Instead of typing an equation into the field, you may also use the
2748 @orgcmd{C-c =,org-table-eval-formula}
2749 Install a new formula for the current column and replace current field with
2750 the result of the formula. The command prompts for a formula, with default
2751 taken from the @samp{#+TBLFM} line, applies it to the current field and
2752 stores it. With a numeric prefix argument(e.g.@: @kbd{C-5 C-c =}) the command
2753 will apply it to that many consecutive fields in the current column.
2756 @node Editing and debugging formulas, Updating the table, Column formulas, The spreadsheet
2757 @subsection Editing and debugging formulas
2758 @cindex formula editing
2759 @cindex editing, of table formulas
2761 @vindex org-table-use-standard-references
2762 You can edit individual formulas in the minibuffer or directly in the
2763 field. Org can also prepare a special buffer with all active
2764 formulas of a table. When offering a formula for editing, Org
2765 converts references to the standard format (like @code{B3} or @code{D&})
2766 if possible. If you prefer to only work with the internal format (like
2767 @code{@@3$2} or @code{$4}), configure the variable
2768 @code{org-table-use-standard-references}.
2771 @orgcmdkkc{C-c =,C-u C-c =,org-table-eval-formula}
2772 Edit the formula associated with the current column/field in the
2773 minibuffer. See @ref{Column formulas}, and @ref{Field and range formulas}.
2774 @orgcmd{C-u C-u C-c =,org-table-eval-formula}
2775 Re-insert the active formula (either a
2776 field formula, or a column formula) into the current field, so that you
2777 can edit it directly in the field. The advantage over editing in the
2778 minibuffer is that you can use the command @kbd{C-c ?}.
2779 @orgcmd{C-c ?,org-table-field-info}
2780 While editing a formula in a table field, highlight the field(s)
2781 referenced by the reference at the cursor position in the formula.
2783 @findex org-table-toggle-coordinate-overlays
2785 Toggle the display of row and column numbers for a table, using overlays
2786 (@command{org-table-toggle-coordinate-overlays}). These are updated each
2787 time the table is aligned; you can force it with @kbd{C-c C-c}.
2789 @findex org-table-toggle-formula-debugger
2791 Toggle the formula debugger on and off
2792 (@command{org-table-toggle-formula-debugger}). See below.
2793 @orgcmd{C-c ',org-table-edit-formulas}
2794 Edit all formulas for the current table in a special buffer, where the
2795 formulas will be displayed one per line. If the current field has an
2796 active formula, the cursor in the formula editor will mark it.
2797 While inside the special buffer, Org will automatically highlight
2798 any field or range reference at the cursor position. You may edit,
2799 remove and add formulas, and use the following commands:
2801 @orgcmdkkc{C-c C-c,C-x C-s,org-table-fedit-finish}
2802 Exit the formula editor and store the modified formulas. With @kbd{C-u}
2803 prefix, also apply the new formulas to the entire table.
2804 @orgcmd{C-c C-q,org-table-fedit-abort}
2805 Exit the formula editor without installing changes.
2806 @orgcmd{C-c C-r,org-table-fedit-toggle-ref-type}
2807 Toggle all references in the formula editor between standard (like
2808 @code{B3}) and internal (like @code{@@3$2}).
2809 @orgcmd{@key{TAB},org-table-fedit-lisp-indent}
2810 Pretty-print or indent Lisp formula at point. When in a line containing
2811 a Lisp formula, format the formula according to Emacs Lisp rules.
2812 Another @key{TAB} collapses the formula back again. In the open
2813 formula, @key{TAB} re-indents just like in Emacs Lisp mode.
2814 @orgcmd{M-@key{TAB},lisp-complete-symbol}
2815 Complete Lisp symbols, just like in Emacs Lisp mode.
2817 @kindex S-@key{down}
2818 @kindex S-@key{left}
2819 @kindex S-@key{right}
2820 @findex org-table-fedit-ref-up
2821 @findex org-table-fedit-ref-down
2822 @findex org-table-fedit-ref-left
2823 @findex org-table-fedit-ref-right
2824 @item S-@key{up}/@key{down}/@key{left}/@key{right}
2825 Shift the reference at point. For example, if the reference is
2826 @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
2827 This also works for relative references and for hline references.
2828 @orgcmdkkcc{M-S-@key{up},M-S-@key{down},org-table-fedit-line-up,org-table-fedit-line-down}
2829 Move the test line for column formulas in the Org buffer up and
2831 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-fedit-scroll-down,org-table-fedit-scroll-up}
2832 Scroll the window displaying the table.
2834 @findex org-table-toggle-coordinate-overlays
2836 Turn the coordinate grid in the table on and off.
2840 Making a table field blank does not remove the formula associated with
2841 the field, because that is stored in a different line (the @samp{#+TBLFM}
2842 line)---during the next recalculation the field will be filled again.
2843 To remove a formula from a field, you have to give an empty reply when
2844 prompted for the formula, or to edit the @samp{#+TBLFM} line.
2847 You may edit the @samp{#+TBLFM} directly and re-apply the changed
2848 equations with @kbd{C-c C-c} in that line or with the normal
2849 recalculation commands in the table.
2851 @subsubheading Debugging formulas
2852 @cindex formula debugging
2853 @cindex debugging, of table formulas
2854 When the evaluation of a formula leads to an error, the field content
2855 becomes the string @samp{#ERROR}. If you would like see what is going
2856 on during variable substitution and calculation in order to find a bug,
2857 turn on formula debugging in the @code{Tbl} menu and repeat the
2858 calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
2859 field. Detailed information will be displayed.
2861 @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet
2862 @subsection Updating the table
2863 @cindex recomputing table fields
2864 @cindex updating, table
2866 Recalculation of a table is normally not automatic, but needs to be
2867 triggered by a command. See @ref{Advanced features}, for a way to make
2868 recalculation at least semi-automatic.
2870 In order to recalculate a line of a table or the entire table, use the
2874 @orgcmd{C-c *,org-table-recalculate}
2875 Recalculate the current row by first applying the stored column formulas
2876 from left to right, and all field/range formulas in the current row.
2882 Recompute the entire table, line by line. Any lines before the first
2883 hline are left alone, assuming that these are part of the table header.
2885 @orgcmdkkc{C-u C-u C-c *,C-u C-u C-c C-c,org-table-iterate}
2886 Iterate the table by recomputing it until no further changes occur.
2887 This may be necessary if some computed fields use the value of other
2888 fields that are computed @i{later} in the calculation sequence.
2889 @item M-x org-table-recalculate-buffer-tables
2890 @findex org-table-recalculate-buffer-tables
2891 Recompute all tables in the current buffer.
2892 @item M-x org-table-iterate-buffer-tables
2893 @findex org-table-iterate-buffer-tables
2894 Iterate all tables in the current buffer, in order to converge table-to-table
2898 @node Advanced features, , Updating the table, The spreadsheet
2899 @subsection Advanced features
2901 If you want the recalculation of fields to happen automatically, or if you
2902 want to be able to assign @i{names}@footnote{Such names must start by an
2903 alphabetic character and use only alphanumeric/underscore characters.} to
2904 fields and columns, you need to reserve the first column of the table for
2905 special marking characters.
2908 @orgcmd{C-#,org-table-rotate-recalc-marks}
2909 Rotate the calculation mark in first column through the states @samp{ },
2910 @samp{#}, @samp{*}, @samp{!}, @samp{$}. When there is an active region,
2911 change all marks in the region.
2914 Here is an example of a table that collects exam results of students and
2915 makes use of these features:
2919 |---+---------+--------+--------+--------+-------+------|
2920 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
2921 |---+---------+--------+--------+--------+-------+------|
2922 | ! | | P1 | P2 | P3 | Tot | |
2923 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
2924 | ^ | | m1 | m2 | m3 | mt | |
2925 |---+---------+--------+--------+--------+-------+------|
2926 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
2927 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
2928 |---+---------+--------+--------+--------+-------+------|
2929 | | Average | | | | 29.7 | |
2930 | ^ | | | | | at | |
2931 | $ | max=50 | | | | | |
2932 |---+---------+--------+--------+--------+-------+------|
2933 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
2937 @noindent @b{Important}: please note that for these special tables,
2938 recalculating the table with @kbd{C-u C-c *} will only affect rows that
2939 are marked @samp{#} or @samp{*}, and fields that have a formula assigned
2940 to the field itself. The column formulas are not applied in rows with
2943 @cindex marking characters, tables
2944 The marking characters have the following meaning:
2947 The fields in this line define names for the columns, so that you may
2948 refer to a column as @samp{$Tot} instead of @samp{$6}.
2950 This row defines names for the fields @emph{above} the row. With such
2951 a definition, any formula in the table may use @samp{$m1} to refer to
2952 the value @samp{10}. Also, if you assign a formula to a names field, it
2953 will be stored as @samp{$name=...}.
2955 Similar to @samp{^}, but defines names for the fields in the row
2958 Fields in this row can define @emph{parameters} for formulas. For
2959 example, if a field in a @samp{$} row contains @samp{max=50}, then
2960 formulas in this table can refer to the value 50 using @samp{$max}.
2961 Parameters work exactly like constants, only that they can be defined on
2964 Fields in this row are automatically recalculated when pressing
2965 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row
2966 is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked
2967 lines will be left alone by this command.
2969 Selects this line for global recalculation with @kbd{C-u C-c *}, but
2970 not for automatic recalculation. Use this when automatic
2971 recalculation slows down editing too much.
2973 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
2974 All lines that should be recalculated should be marked with @samp{#}
2977 Do not export this line. Useful for lines that contain the narrowing
2978 @samp{<N>} markers or column group markers.
2981 Finally, just to whet your appetite for what can be done with the
2982 fantastic @file{calc.el} package, here is a table that computes the Taylor
2983 series of degree @code{n} at location @code{x} for a couple of
2988 |---+-------------+---+-----+--------------------------------------|
2989 | | Func | n | x | Result |
2990 |---+-------------+---+-----+--------------------------------------|
2991 | # | exp(x) | 1 | x | 1 + x |
2992 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
2993 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
2994 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
2995 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
2996 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
2997 |---+-------------+---+-----+--------------------------------------|
2998 #+TBLFM: $5=taylor($2,$4,$3);n3
3002 @node Org-Plot, , The spreadsheet, Tables
3004 @cindex graph, in tables
3005 @cindex plot tables using Gnuplot
3008 Org-Plot can produce 2D and 3D graphs of information stored in org tables
3009 using @file{Gnuplot} @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
3010 @uref{http://cars9.uchicago.edu/~ravel/software/gnuplot-mode.html}. To see
3011 this in action, ensure that you have both Gnuplot and Gnuplot mode installed
3012 on your system, then call @code{org-plot/gnuplot} on the following table.
3016 #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
3017 | Sede | Max cites | H-index |
3018 |-----------+-----------+---------|
3019 | Chile | 257.72 | 21.39 |
3020 | Leeds | 165.77 | 19.68 |
3021 | Sao Paolo | 71.00 | 11.50 |
3022 | Stockholm | 134.19 | 14.33 |
3023 | Morelia | 257.56 | 17.67 |
3027 Notice that Org Plot is smart enough to apply the table's headers as labels.
3028 Further control over the labels, type, content, and appearance of plots can
3029 be exercised through the @code{#+PLOT:} lines preceding a table. See below
3030 for a complete list of Org-plot options. For more information and examples
3031 see the Org-plot tutorial at
3032 @uref{http://orgmode.org/worg/org-tutorials/org-plot.html}.
3034 @subsubheading Plot Options
3038 Specify any @command{gnuplot} option to be set when graphing.
3041 Specify the title of the plot.
3044 Specify which column of the table to use as the @code{x} axis.
3047 Specify the columns to graph as a Lisp style list, surrounded by parentheses
3048 and separated by spaces for example @code{dep:(3 4)} to graph the third and
3049 fourth columns (defaults to graphing all other columns aside from the @code{ind}
3053 Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
3056 Specify a @code{with} option to be inserted for every col being plotted
3057 (e.g.@: @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
3058 Defaults to @code{lines}.
3061 If you want to plot to a file, specify @code{"@var{path/to/desired/output-file}"}.
3064 List of labels to be used for the @code{deps} (defaults to the column headers
3068 Specify an entire line to be inserted in the Gnuplot script.
3071 When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
3072 flat mapping rather than a @code{3d} slope.
3075 Specify format of Org mode timestamps as they will be parsed by Gnuplot.
3076 Defaults to @samp{%Y-%m-%d-%H:%M:%S}.
3079 If you want total control, you can specify a script file (place the file name
3080 between double-quotes) which will be used to plot. Before plotting, every
3081 instance of @code{$datafile} in the specified script will be replaced with
3082 the path to the generated data file. Note: even if you set this option, you
3083 may still want to specify the plot type, as that can impact the content of
3087 @node Hyperlinks, TODO Items, Tables, Top
3091 Like HTML, Org provides links inside a file, external links to
3092 other files, Usenet articles, emails, and much more.
3095 * Link format:: How links in Org are formatted
3096 * Internal links:: Links to other places in the current file
3097 * External links:: URL-like links to the world
3098 * Handling links:: Creating, inserting and following
3099 * Using links outside Org:: Linking from my C source code?
3100 * Link abbreviations:: Shortcuts for writing complex links
3101 * Search options:: Linking to a specific location
3102 * Custom searches:: When the default search is not enough
3105 @node Link format, Internal links, Hyperlinks, Hyperlinks
3106 @section Link format
3108 @cindex format, of links
3110 Org will recognize plain URL-like links and activate them as
3111 clickable links. The general link format, however, looks like this:
3114 [[link][description]] @r{or alternatively} [[link]]
3118 Once a link in the buffer is complete (all brackets present), Org
3119 will change the display so that @samp{description} is displayed instead
3120 of @samp{[[link][description]]} and @samp{link} is displayed instead of
3121 @samp{[[link]]}. Links will be highlighted in the face @code{org-link},
3122 which by default is an underlined face. You can directly edit the
3123 visible part of a link. Note that this can be either the @samp{link}
3124 part (if there is no description) or the @samp{description} part. To
3125 edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
3128 If you place the cursor at the beginning or just behind the end of the
3129 displayed text and press @key{BACKSPACE}, you will remove the
3130 (invisible) bracket at that location. This makes the link incomplete
3131 and the internals are again displayed as plain text. Inserting the
3132 missing bracket hides the link internals again. To show the
3133 internal structure of all links, use the menu entry
3134 @code{Org->Hyperlinks->Literal links}.
3136 @node Internal links, External links, Link format, Hyperlinks
3137 @section Internal links
3138 @cindex internal links
3139 @cindex links, internal
3140 @cindex targets, for links
3142 @cindex property, CUSTOM_ID
3143 If the link does not look like a URL, it is considered to be internal in the
3144 current file. The most important case is a link like
3145 @samp{[[#my-custom-id]]} which will link to the entry with the
3146 @code{CUSTOM_ID} property @samp{my-custom-id}. Such custom IDs are very good
3147 for HTML export (@pxref{HTML export}) where they produce pretty section
3148 links. You are responsible yourself to make sure these custom IDs are unique
3151 Links such as @samp{[[My Target]]} or @samp{[[My Target][Find my target]]}
3152 lead to a text search in the current file.
3154 The link can be followed with @kbd{C-c C-o} when the cursor is on the link,
3155 or with a mouse click (@pxref{Handling links}). Links to custom IDs will
3156 point to the corresponding headline. The preferred match for a text link is
3157 a @i{dedicated target}: the same string in double angular brackets. Targets
3158 may be located anywhere; sometimes it is convenient to put them into a
3159 comment line. For example
3165 @noindent In HTML export (@pxref{HTML export}), such targets will become
3166 named anchors for direct access through @samp{http} links@footnote{Note that
3167 text before the first headline is usually not exported, so the first such
3168 target should be after the first headline, or in the line directly before the
3171 If no dedicated target exists, Org will search for a headline that is exactly
3172 the link text but may also include a TODO keyword and tags@footnote{To insert
3173 a link targeting a headline, in-buffer completion can be used. Just type a
3174 star followed by a few optional letters into the buffer and press
3175 @kbd{M-@key{TAB}}. All headlines in the current buffer will be offered as
3176 completions.}. In non-Org files, the search will look for the words in the
3177 link text. In the above example the search would be for @samp{my target}.
3179 Following a link pushes a mark onto Org's own mark ring. You can
3180 return to the previous position with @kbd{C-c &}. Using this command
3181 several times in direct succession goes back to positions recorded
3185 * Radio targets:: Make targets trigger links in plain text
3188 @node Radio targets, , Internal links, Internal links
3189 @subsection Radio targets
3190 @cindex radio targets
3191 @cindex targets, radio
3192 @cindex links, radio targets
3194 Org can automatically turn any occurrences of certain target names
3195 in normal text into a link. So without explicitly creating a link, the
3196 text connects to the target radioing its position. Radio targets are
3197 enclosed by triple angular brackets. For example, a target @samp{<<<My
3198 Target>>>} causes each occurrence of @samp{my target} in normal text to
3199 become activated as a link. The Org file is scanned automatically
3200 for radio targets only when the file is first loaded into Emacs. To
3201 update the target list during editing, press @kbd{C-c C-c} with the
3202 cursor on or at a target.
3204 @node External links, Handling links, Internal links, Hyperlinks
3205 @section External links
3206 @cindex links, external
3207 @cindex external links
3208 @cindex links, external
3216 @cindex WANDERLUST links
3218 @cindex USENET links
3223 Org supports links to files, websites, Usenet and email messages,
3224 BBDB database entries and links to both IRC conversations and their
3225 logs. External links are URL-like locators. They start with a short
3226 identifying string followed by a colon. There can be no space after
3227 the colon. The following list shows examples for each link type.
3230 http://www.astro.uva.nl/~dominik @r{on the web}
3231 doi:10.1000/182 @r{DOI for an electronic resource}
3232 file:/home/dominik/images/jupiter.jpg @r{file, absolute path}
3233 /home/dominik/images/jupiter.jpg @r{same as above}
3234 file:papers/last.pdf @r{file, relative path}
3235 ./papers/last.pdf @r{same as above}
3236 file:/myself@@some.where:papers/last.pdf @r{file, path on remote machine}
3237 /myself@@some.where:papers/last.pdf @r{same as above}
3238 file:sometextfile::NNN @r{file, jump to line number}
3239 file:projects.org @r{another Org file}
3240 file:projects.org::some words @r{text search in Org file}@footnote{
3241 The actual behavior of the search will depend on the value of
3242 the variable @code{org-link-search-must-match-exact-headline}. If its value
3243 is nil, then a fuzzy text search will be done. If it is t, then only the
3244 exact headline will be matched. If the value is @code{'query-to-create},
3245 then an exact headline will be searched; if it is not found, then the user
3246 will be queried to create it.}
3247 file:projects.org::*task title @r{heading search in Org file}
3248 file+sys:/path/to/file @r{open via OS, like double-click}
3249 file+emacs:/path/to/file @r{force opening by Emacs}
3250 docview:papers/last.pdf::NNN @r{open in doc-view mode at page}
3251 id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID}
3252 news:comp.emacs @r{Usenet link}
3253 mailto:adent@@galaxy.net @r{Mail link}
3254 vm:folder @r{VM folder link}
3255 vm:folder#id @r{VM message link}
3256 vm://myself@@some.where.org/folder#id @r{VM on remote machine}
3257 vm-imap:account:folder @r{VM IMAP folder link}
3258 vm-imap:account:folder#id @r{VM IMAP message link}
3259 wl:folder @r{WANDERLUST folder link}
3260 wl:folder#id @r{WANDERLUST message link}
3261 mhe:folder @r{MH-E folder link}
3262 mhe:folder#id @r{MH-E message link}
3263 rmail:folder @r{RMAIL folder link}
3264 rmail:folder#id @r{RMAIL message link}
3265 gnus:group @r{Gnus group link}
3266 gnus:group#id @r{Gnus article link}
3267 bbdb:R.*Stallman @r{BBDB link (with regexp)}
3268 irc:/irc.com/#emacs/bob @r{IRC link}
3269 info:org#External links @r{Info node link}
3270 shell:ls *.org @r{A shell command}
3271 elisp:org-agenda @r{Interactive Elisp command}
3272 elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
3275 For customizing Org to add new link types @ref{Adding hyperlink types}.
3277 A link should be enclosed in double brackets and may contain a
3278 descriptive text to be displayed instead of the URL (@pxref{Link
3279 format}), for example:
3282 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
3286 If the description is a file name or URL that points to an image, HTML
3287 export (@pxref{HTML export}) will inline the image as a clickable
3288 button. If there is no description at all and the link points to an
3290 that image will be inlined into the exported HTML file.
3292 @cindex square brackets, around links
3293 @cindex plain text external links
3294 Org also finds external links in the normal text and activates them
3295 as links. If spaces must be part of the link (for example in
3296 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
3297 about the end of the link, enclose them in square brackets.
3299 @node Handling links, Using links outside Org, External links, Hyperlinks
3300 @section Handling links
3301 @cindex links, handling
3303 Org provides methods to create a link in the correct syntax, to
3304 insert it into an Org file, and to follow the link.
3307 @orgcmd{C-c l,org-store-link}
3308 @cindex storing links
3309 Store a link to the current location. This is a @emph{global} command (you
3310 must create the key binding yourself) which can be used in any buffer to
3311 create a link. The link will be stored for later insertion into an Org
3312 buffer (see below). What kind of link will be created depends on the current
3315 @b{Org mode buffers}@*
3316 For Org files, if there is a @samp{<<target>>} at the cursor, the link points
3317 to the target. Otherwise it points to the current headline, which will also
3318 be the description@footnote{If the headline contains a timestamp, it will be
3319 removed from the link and result in a wrong link -- you should avoid putting
3320 timestamp in the headline.}.
3322 @vindex org-link-to-org-use-id
3323 @cindex property, CUSTOM_ID
3324 @cindex property, ID
3325 If the headline has a @code{CUSTOM_ID} property, a link to this custom ID
3326 will be stored. In addition or alternatively (depending on the value of
3327 @code{org-link-to-org-use-id}), a globally unique @code{ID} property will be
3328 created and/or used to construct a link. So using this command in Org
3329 buffers will potentially create two links: a human-readable from the custom
3330 ID, and one that is globally unique and works even if the entry is moved from
3331 file to file. Later, when inserting the link, you need to decide which one
3334 @b{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus}@*
3335 Pretty much all Emacs mail clients are supported. The link will point to the
3336 current article, or, in some GNUS buffers, to the group. The description is
3337 constructed from the author and the subject.
3339 @b{Web browsers: W3 and W3M}@*
3340 Here the link will be the current URL, with the page title as description.
3342 @b{Contacts: BBDB}@*
3343 Links created in a BBDB buffer will point to the current entry.
3346 @vindex org-irc-link-to-logs
3347 For IRC links, if you set the variable @code{org-irc-link-to-logs} to
3348 @code{t}, a @samp{file:/} style link to the relevant point in the logs for
3349 the current conversation is created. Otherwise an @samp{irc:/} style link to
3350 the user/channel/server under the point will be stored.
3353 For any other files, the link will point to the file, with a search string
3354 (@pxref{Search options}) pointing to the contents of the current line. If
3355 there is an active region, the selected words will form the basis of the
3356 search string. If the automatically created link is not working correctly or
3357 accurately enough, you can write custom functions to select the search string
3358 and to do the search for particular file types---see @ref{Custom searches}.
3359 The key binding @kbd{C-c l} is only a suggestion---see @ref{Installation}.
3362 When the cursor is in an agenda view, the created link points to the
3363 entry referenced by the current line.
3366 @orgcmd{C-c C-l,org-insert-link}
3367 @cindex link completion
3368 @cindex completion, of links
3369 @cindex inserting links
3370 @vindex org-keep-stored-link-after-insertion
3371 Insert a link@footnote{ Note that you don't have to use this command to
3372 insert a link. Links in Org are plain text, and you can type or paste them
3373 straight into the buffer. By using this command, the links are automatically
3374 enclosed in double brackets, and you will be asked for the optional
3375 descriptive text.}. This prompts for a link to be inserted into the buffer.
3376 You can just type a link, using text for an internal link, or one of the link
3377 type prefixes mentioned in the examples above. The link will be inserted
3378 into the buffer@footnote{After insertion of a stored link, the link will be
3379 removed from the list of stored links. To keep it in the list later use, use
3380 a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
3381 @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
3382 If some text was selected when this command is called, the selected text
3383 becomes the default description.
3385 @b{Inserting stored links}@*
3386 All links stored during the
3387 current session are part of the history for this prompt, so you can access
3388 them with @key{up} and @key{down} (or @kbd{M-p/n}).
3390 @b{Completion support}@* Completion with @key{TAB} will help you to insert
3391 valid link prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
3392 defined through link abbreviations (@pxref{Link abbreviations}). If you
3393 press @key{RET} after inserting only the @var{prefix}, Org will offer
3394 specific completion support for some link types@footnote{This works by
3395 calling a special function @code{org-PREFIX-complete-link}.} For
3396 example, if you type @kbd{file @key{RET}}, file name completion (alternative
3397 access: @kbd{C-u C-c C-l}, see below) will be offered, and after @kbd{bbdb
3398 @key{RET}} you can complete contact names.
3400 @cindex file name completion
3401 @cindex completion, of file names
3402 When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
3403 a file will be inserted and you may use file name completion to select
3404 the name of the file. The path to the file is inserted relative to the
3405 directory of the current Org file, if the linked file is in the current
3406 directory or in a sub-directory of it, or if the path is written relative
3407 to the current directory using @samp{../}. Otherwise an absolute path
3408 is used, if possible with @samp{~/} for your home directory. You can
3409 force an absolute path with two @kbd{C-u} prefixes.
3411 @item C-c C-l @ @r{(with cursor on existing link)}
3412 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
3413 link and description parts of the link.
3415 @cindex following links
3416 @orgcmd{C-c C-o,org-open-at-point}
3417 @vindex org-file-apps
3418 @vindex org-link-frame-setup
3419 Open link at point. This will launch a web browser for URLs (using
3420 @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
3421 the corresponding links, and execute the command in a shell link. When the
3422 cursor is on an internal link, this command runs the corresponding search.
3423 When the cursor is on a TAG list in a headline, it creates the corresponding
3424 TAGS view. If the cursor is on a timestamp, it compiles the agenda for that
3425 date. Furthermore, it will visit text and remote files in @samp{file:} links
3426 with Emacs and select a suitable application for local non-text files.
3427 Classification of files is based on file extension only. See option
3428 @code{org-file-apps}. If you want to override the default application and
3429 visit the file with Emacs, use a @kbd{C-u} prefix. If you want to avoid
3430 opening in Emacs, use a @kbd{C-u C-u} prefix.@*
3431 If the cursor is on a headline, but not on a link, offer all links in the
3432 headline and entry text. If you want to setup the frame configuration for
3433 following links, customize @code{org-link-frame-setup}.
3436 @vindex org-return-follows-link
3437 When @code{org-return-follows-link} is set, @kbd{@key{RET}} will also follow
3444 On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
3445 would. Under Emacs 22 and later, @kbd{mouse-1} will also follow a link.
3449 @vindex org-display-internal-link-with-indirect-buffer
3450 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
3451 internal links to be displayed in another window@footnote{See the
3452 variable @code{org-display-internal-link-with-indirect-buffer}}.
3454 @orgcmd{C-c C-x C-v,org-toggle-inline-images}
3455 @cindex inlining images
3456 @cindex images, inlining
3457 @vindex org-startup-with-inline-images
3458 @cindex @code{inlineimages}, STARTUP keyword
3459 @cindex @code{noinlineimages}, STARTUP keyword
3460 Toggle the inline display of linked images. Normally this will only inline
3461 images that have no description part in the link, i.e.@: images that will also
3462 be inlined during export. When called with a prefix argument, also display
3463 images that do have a link description. You can ask for inline images to be
3464 displayed at startup by configuring the variable
3465 @code{org-startup-with-inline-images}@footnote{with corresponding
3466 @code{#+STARTUP} keywords @code{inlineimages} and @code{inlineimages}}.
3467 @orgcmd{C-c %,org-mark-ring-push}
3469 Push the current position onto the mark ring, to be able to return
3470 easily. Commands following an internal link do this automatically.
3472 @orgcmd{C-c &,org-mark-ring-goto}
3473 @cindex links, returning to
3474 Jump back to a recorded position. A position is recorded by the
3475 commands following internal links, and by @kbd{C-c %}. Using this
3476 command several times in direct succession moves through a ring of
3477 previously recorded positions.
3479 @orgcmdkkcc{C-c C-x C-n,C-c C-x C-p,org-next-link,org-previous-link}
3480 @cindex links, finding next/previous
3481 Move forward/backward to the next link in the buffer. At the limit of
3482 the buffer, the search fails once, and then wraps around. The key
3483 bindings for this are really too long; you might want to bind this also
3484 to @kbd{C-n} and @kbd{C-p}
3486 (add-hook 'org-load-hook
3488 (define-key org-mode-map "\C-n" 'org-next-link)
3489 (define-key org-mode-map "\C-p" 'org-previous-link)))
3493 @node Using links outside Org, Link abbreviations, Handling links, Hyperlinks
3494 @section Using links outside Org
3496 You can insert and follow links that have Org syntax not only in
3497 Org, but in any Emacs buffer. For this, you should create two
3498 global commands, like this (please select suitable global keys
3502 (global-set-key "\C-c L" 'org-insert-link-global)
3503 (global-set-key "\C-c o" 'org-open-at-point-global)
3506 @node Link abbreviations, Search options, Using links outside Org, Hyperlinks
3507 @section Link abbreviations
3508 @cindex link abbreviations
3509 @cindex abbreviation, links
3511 Long URLs can be cumbersome to type, and often many similar links are
3512 needed in a document. For this you can use link abbreviations. An
3513 abbreviated link looks like this
3516 [[linkword:tag][description]]
3520 @vindex org-link-abbrev-alist
3521 where the tag is optional.
3522 The @i{linkword} must be a word, starting with a letter, followed by
3523 letters, numbers, @samp{-}, and @samp{_}. Abbreviations are resolved
3524 according to the information in the variable @code{org-link-abbrev-alist}
3525 that relates the linkwords to replacement text. Here is an example:
3529 (setq org-link-abbrev-alist
3530 '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
3531 ("google" . "http://www.google.com/search?q=")
3532 ("gmap" . "http://maps.google.com/maps?q=%s")
3533 ("omap" . "http://nominatim.openstreetmap.org/search?q=%s&polygon=1")
3534 ("ads" . "http://adsabs.harvard.edu/cgi-bin/nph-abs_connect?author=%s&db_key=AST")))
3538 If the replacement text contains the string @samp{%s}, it will be
3539 replaced with the tag. Otherwise the tag will be appended to the string
3540 in order to create the link. You may also specify a function that will
3541 be called with the tag as the only argument to create the link.
3543 With the above setting, you could link to a specific bug with
3544 @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
3545 @code{[[google:OrgMode]]}, show the map location of the Free Software
3546 Foundation @code{[[gmap:51 Franklin Street, Boston]]} or of Carsten office
3547 @code{[[omap:Science Park 904, Amsterdam, The Netherlands]]} and find out
3548 what the Org author is doing besides Emacs hacking with
3549 @code{[[ads:Dominik,C]]}.
3551 If you need special abbreviations just for a single Org buffer, you
3552 can define them in the file with
3556 #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
3557 #+LINK: google http://www.google.com/search?q=%s
3561 In-buffer completion (@pxref{Completion}) can be used after @samp{[} to
3562 complete link abbreviations. You may also define a function
3563 @code{org-PREFIX-complete-link} that implements special (e.g.@: completion)
3564 support for inserting such a link with @kbd{C-c C-l}. Such a function should
3565 not accept any arguments, and return the full link with prefix.
3567 @node Search options, Custom searches, Link abbreviations, Hyperlinks
3568 @section Search options in file links
3569 @cindex search option in file links
3570 @cindex file links, searching
3572 File links can contain additional information to make Emacs jump to a
3573 particular location in the file when following a link. This can be a
3574 line number or a search option after a double@footnote{For backward
3575 compatibility, line numbers can also follow a single colon.} colon. For
3576 example, when the command @kbd{C-c l} creates a link (@pxref{Handling
3577 links}) to a file, it encodes the words in the current line as a search
3578 string that can be used to find this line back later when following the
3579 link with @kbd{C-c C-o}.
3581 Here is the syntax of the different ways to attach a search to a file
3582 link, together with an explanation:
3585 [[file:~/code/main.c::255]]
3586 [[file:~/xx.org::My Target]]
3587 [[file:~/xx.org::*My Target]]
3588 [[file:~/xx.org::#my-custom-id]]
3589 [[file:~/xx.org::/regexp/]]
3596 Search for a link target @samp{<<My Target>>}, or do a text search for
3597 @samp{my target}, similar to the search in internal links, see
3598 @ref{Internal links}. In HTML export (@pxref{HTML export}), such a file
3599 link will become an HTML reference to the corresponding named anchor in
3602 In an Org file, restrict search to headlines.
3604 Link to a heading with a @code{CUSTOM_ID} property
3606 Do a regular expression search for @code{regexp}. This uses the Emacs
3607 command @code{occur} to list all matches in a separate window. If the
3608 target file is in Org mode, @code{org-occur} is used to create a
3609 sparse tree with the matches.
3610 @c If the target file is a directory,
3611 @c @code{grep} will be used to search all files in the directory.
3614 As a degenerate case, a file link with an empty file name can be used
3615 to search the current file. For example, @code{[[file:::find me]]} does
3616 a search for @samp{find me} in the current file, just as
3617 @samp{[[find me]]} would.
3619 @node Custom searches, , Search options, Hyperlinks
3620 @section Custom Searches
3621 @cindex custom search strings
3622 @cindex search strings, custom
3624 The default mechanism for creating search strings and for doing the
3625 actual search related to a file link may not work correctly in all
3626 cases. For example, Bib@TeX{} database files have many entries like
3627 @samp{year="1993"} which would not result in good search strings,
3628 because the only unique identification for a Bib@TeX{} entry is the
3631 @vindex org-create-file-search-functions
3632 @vindex org-execute-file-search-functions
3633 If you come across such a problem, you can write custom functions to set
3634 the right search string for a particular file type, and to do the search
3635 for the string in the file. Using @code{add-hook}, these functions need
3636 to be added to the hook variables
3637 @code{org-create-file-search-functions} and
3638 @code{org-execute-file-search-functions}. See the docstring for these
3639 variables for more information. Org actually uses this mechanism
3640 for Bib@TeX{} database files, and you can use the corresponding code as
3641 an implementation example. See the file @file{org-bibtex.el}.
3643 @node TODO Items, Tags, Hyperlinks, Top
3647 Org mode does not maintain TODO lists as separate documents@footnote{Of
3648 course, you can make a document that contains only long lists of TODO items,
3649 but this is not required.}. Instead, TODO items are an integral part of the
3650 notes file, because TODO items usually come up while taking notes! With Org
3651 mode, simply mark any entry in a tree as being a TODO item. In this way,
3652 information is not duplicated, and the entire context from which the TODO
3653 item emerged is always present.
3655 Of course, this technique for managing TODO items scatters them
3656 throughout your notes file. Org mode compensates for this by providing
3657 methods to give you an overview of all the things that you have to do.
3660 * TODO basics:: Marking and displaying TODO entries
3661 * TODO extensions:: Workflow and assignments
3662 * Progress logging:: Dates and notes for progress
3663 * Priorities:: Some things are more important than others
3664 * Breaking down tasks:: Splitting a task into manageable pieces
3665 * Checkboxes:: Tick-off lists
3668 @node TODO basics, TODO extensions, TODO Items, TODO Items
3669 @section Basic TODO functionality
3671 Any headline becomes a TODO item when it starts with the word
3672 @samp{TODO}, for example:
3675 *** TODO Write letter to Sam Fortune
3679 The most important commands to work with TODO entries are:
3682 @orgcmd{C-c C-t,org-todo}
3683 @cindex cycling, of TODO states
3684 Rotate the TODO state of the current item among
3687 ,-> (unmarked) -> TODO -> DONE --.
3688 '--------------------------------'
3691 The same rotation can also be done ``remotely'' from the timeline and
3692 agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}).
3694 @orgkey{C-u C-c C-t}
3695 Select a specific keyword using completion or (if it has been set up)
3696 the fast selection interface. For the latter, you need to assign keys
3697 to TODO states, see @ref{Per-file keywords}, and @ref{Setting tags}, for
3700 @kindex S-@key{right}
3701 @kindex S-@key{left}
3702 @item S-@key{right} @ @r{/} @ S-@key{left}
3703 @vindex org-treat-S-cursor-todo-selection-as-state-change
3704 Select the following/preceding TODO state, similar to cycling. Useful
3705 mostly if more than two TODO states are possible (@pxref{TODO
3706 extensions}). See also @ref{Conflicts}, for a discussion of the interaction
3707 with @code{shift-selection-mode}. See also the variable
3708 @code{org-treat-S-cursor-todo-selection-as-state-change}.
3709 @orgcmd{C-c / t,org-show-todo-key}
3710 @cindex sparse tree, for TODO
3711 @vindex org-todo-keywords
3712 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds the
3713 entire buffer, but shows all TODO items (with not-DONE state) and the
3714 headings hierarchy above them. With a prefix argument (or by using @kbd{C-c
3715 / T}), search for a specific TODO. You will be prompted for the keyword, and
3716 you can also give a list of keywords like @code{KWD1|KWD2|...} to list
3717 entries that match any one of these keywords. With a numeric prefix argument
3718 N, show the tree for the Nth keyword in the variable
3719 @code{org-todo-keywords}. With two prefix arguments, find all TODO states,
3720 both un-done and done.
3721 @orgcmd{C-c a t,org-todo-list}
3722 Show the global TODO list. Collects the TODO items (with not-DONE states)
3723 from all agenda files (@pxref{Agenda Views}) into a single buffer. The new
3724 buffer will be in @code{agenda-mode}, which provides commands to examine and
3725 manipulate the TODO entries from the new buffer (@pxref{Agenda commands}).
3726 @xref{Global TODO list}, for more information.
3727 @orgcmd{S-M-@key{RET},org-insert-todo-heading}
3728 Insert a new TODO entry below the current one.
3732 @vindex org-todo-state-tags-triggers
3733 Changing a TODO state can also trigger tag changes. See the docstring of the
3734 option @code{org-todo-state-tags-triggers} for details.
3736 @node TODO extensions, Progress logging, TODO basics, TODO Items
3737 @section Extended use of TODO keywords
3738 @cindex extended TODO keywords
3740 @vindex org-todo-keywords
3741 By default, marked TODO entries have one of only two states: TODO and
3742 DONE. Org mode allows you to classify TODO items in more complex ways
3743 with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With
3744 special setup, the TODO keyword system can work differently in different
3747 Note that @i{tags} are another way to classify headlines in general and
3748 TODO items in particular (@pxref{Tags}).
3751 * Workflow states:: From TODO to DONE in steps
3752 * TODO types:: I do this, Fred does the rest
3753 * Multiple sets in one file:: Mixing it all, and still finding your way
3754 * Fast access to TODO states:: Single letter selection of a state
3755 * Per-file keywords:: Different files, different requirements
3756 * Faces for TODO keywords:: Highlighting states
3757 * TODO dependencies:: When one task needs to wait for others
3760 @node Workflow states, TODO types, TODO extensions, TODO extensions
3761 @subsection TODO keywords as workflow states
3762 @cindex TODO workflow
3763 @cindex workflow states as TODO keywords
3765 You can use TODO keywords to indicate different @emph{sequential} states
3766 in the process of working on an item, for example@footnote{Changing
3767 this variable only becomes effective after restarting Org mode in a
3771 (setq org-todo-keywords
3772 '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
3775 The vertical bar separates the TODO keywords (states that @emph{need
3776 action}) from the DONE states (which need @emph{no further action}). If
3777 you don't provide the separator bar, the last state is used as the DONE
3779 @cindex completion, of TODO keywords
3780 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
3781 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED. You may
3782 also use a numeric prefix argument to quickly select a specific state. For
3783 example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY.
3784 Or you can use @kbd{S-@key{left}} to go backward through the sequence. If you
3785 define many keywords, you can use in-buffer completion
3786 (@pxref{Completion}) or even a special one-key selection scheme
3787 (@pxref{Fast access to TODO states}) to insert these words into the
3788 buffer. Changing a TODO state can be logged with a timestamp, see
3789 @ref{Tracking TODO state changes}, for more information.
3791 @node TODO types, Multiple sets in one file, Workflow states, TODO extensions
3792 @subsection TODO keywords as types
3794 @cindex names as TODO keywords
3795 @cindex types as TODO keywords
3797 The second possibility is to use TODO keywords to indicate different
3798 @emph{types} of action items. For example, you might want to indicate
3799 that items are for ``work'' or ``home''. Or, when you work with several
3800 people on a single project, you might want to assign action items
3801 directly to persons, by using their names as TODO keywords. This would
3802 be set up like this:
3805 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
3808 In this case, different keywords do not indicate a sequence, but rather
3809 different types. So the normal work flow would be to assign a task to a
3810 person, and later to mark it DONE. Org mode supports this style by adapting
3811 the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
3812 @kbd{t} command in the timeline and agenda buffers.}. When used several
3813 times in succession, it will still cycle through all names, in order to first
3814 select the right type for a task. But when you return to the item after some
3815 time and execute @kbd{C-c C-t} again, it will switch from any name directly
3816 to DONE. Use prefix arguments or completion to quickly select a specific
3817 name. You can also review the items of a specific TODO type in a sparse tree
3818 by using a numeric prefix to @kbd{C-c / t}. For example, to see all things
3819 Lucy has to do, you would use @kbd{C-3 C-c / t}. To collect Lucy's items
3820 from all agenda files into a single buffer, you would use the numeric prefix
3821 argument as well when creating the global TODO list: @kbd{C-3 C-c a t}.
3823 @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions
3824 @subsection Multiple keyword sets in one file
3825 @cindex TODO keyword sets
3827 Sometimes you may want to use different sets of TODO keywords in
3828 parallel. For example, you may want to have the basic
3829 @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
3830 separate state indicating that an item has been canceled (so it is not
3831 DONE, but also does not require action). Your setup would then look
3835 (setq org-todo-keywords
3836 '((sequence "TODO" "|" "DONE")
3837 (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
3838 (sequence "|" "CANCELED")))
3841 The keywords should all be different, this helps Org mode to keep track
3842 of which subsequence should be used for a given entry. In this setup,
3843 @kbd{C-c C-t} only operates within a subsequence, so it switches from
3844 @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
3845 (nothing) to @code{REPORT}. Therefore you need a mechanism to initially
3846 select the correct sequence. Besides the obvious ways like typing a
3847 keyword or using completion, you may also apply the following commands:
3850 @kindex C-S-@key{right}
3851 @kindex C-S-@key{left}
3852 @kindex C-u C-u C-c C-t
3853 @item C-u C-u C-c C-t
3854 @itemx C-S-@key{right}
3855 @itemx C-S-@key{left}
3856 These keys jump from one TODO subset to the next. In the above example,
3857 @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{right}} would jump from @code{TODO} or
3858 @code{DONE} to @code{REPORT}, and any of the words in the second row to
3859 @code{CANCELED}. Note that the @kbd{C-S-} key binding conflict with
3860 @code{shift-selection-mode} (@pxref{Conflicts}).
3861 @kindex S-@key{right}
3862 @kindex S-@key{left}
3865 @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through @emph{all}
3866 keywords from all sets, so for example @kbd{S-@key{<right>}} would switch
3867 from @code{DONE} to @code{REPORT} in the example above. See also
3868 @ref{Conflicts}, for a discussion of the interaction with
3869 @code{shift-selection-mode}.
3872 @node Fast access to TODO states, Per-file keywords, Multiple sets in one file, TODO extensions
3873 @subsection Fast access to TODO states
3875 If you would like to quickly change an entry to an arbitrary TODO state
3876 instead of cycling through the states, you can set up keys for
3877 single-letter access to the states. This is done by adding the section
3878 key after each keyword, in parentheses. For example:
3881 (setq org-todo-keywords
3882 '((sequence "TODO(t)" "|" "DONE(d)")
3883 (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
3884 (sequence "|" "CANCELED(c)")))
3887 @vindex org-fast-tag-selection-include-todo
3888 If you then press @kbd{C-c C-t} followed by the selection key, the entry
3889 will be switched to this state. @kbd{SPC} can be used to remove any TODO
3890 keyword from an entry.@footnote{Check also the variable
3891 @code{org-fast-tag-selection-include-todo}, it allows you to change the TODO
3892 state through the tags interface (@pxref{Setting tags}), in case you like to
3893 mingle the two concepts. Note that this means you need to come up with
3894 unique keys across both sets of keywords.}
3896 @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions
3897 @subsection Setting up keywords for individual files
3898 @cindex keyword options
3899 @cindex per-file keywords
3904 It can be very useful to use different aspects of the TODO mechanism in
3905 different files. For file-local settings, you need to add special lines
3906 to the file which set the keywords and interpretation for that file
3907 only. For example, to set one of the two examples discussed above, you
3908 need one of the following lines, starting in column zero anywhere in the
3912 #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
3914 @noindent (you may also write @code{#+SEQ_TODO} to be explicit about the
3915 interpretation, but it means the same as @code{#+TODO}), or
3917 #+TYP_TODO: Fred Sara Lucy Mike | DONE
3920 A setup for using several sets in parallel would be:
3924 #+TODO: REPORT BUG KNOWNCAUSE | FIXED
3928 @cindex completion, of option keywords
3930 @noindent To make sure you are using the correct keyword, type
3931 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
3933 @cindex DONE, final TODO keyword
3934 Remember that the keywords after the vertical bar (or the last keyword
3935 if no bar is there) must always mean that the item is DONE (although you
3936 may use a different word). After changing one of these lines, use
3937 @kbd{C-c C-c} with the cursor still in the line to make the changes
3938 known to Org mode@footnote{Org mode parses these lines only when
3939 Org mode is activated after visiting a file. @kbd{C-c C-c} with the
3940 cursor in a line starting with @samp{#+} is simply restarting Org mode
3941 for the current buffer.}.
3943 @node Faces for TODO keywords, TODO dependencies, Per-file keywords, TODO extensions
3944 @subsection Faces for TODO keywords
3945 @cindex faces, for TODO keywords
3947 @vindex org-todo @r{(face)}
3948 @vindex org-done @r{(face)}
3949 @vindex org-todo-keyword-faces
3950 Org mode highlights TODO keywords with special faces: @code{org-todo}
3951 for keywords indicating that an item still has to be acted upon, and
3952 @code{org-done} for keywords indicating that an item is finished. If
3953 you are using more than 2 different states, you might want to use
3954 special faces for some of them. This can be done using the variable
3955 @code{org-todo-keyword-faces}. For example:
3959 (setq org-todo-keyword-faces
3960 '(("TODO" . org-warning) ("STARTED" . "yellow")
3961 ("CANCELED" . (:foreground "blue" :weight bold))))
3965 While using a list with face properties as shown for CANCELED @emph{should}
3966 work, this does not always seem to be the case. If necessary, define a
3967 special face and use that. A string is interpreted as a color. The variable
3968 @code{org-faces-easy-properties} determines if that color is interpreted as a
3969 foreground or a background color.
3971 @node TODO dependencies, , Faces for TODO keywords, TODO extensions
3972 @subsection TODO dependencies
3973 @cindex TODO dependencies
3974 @cindex dependencies, of TODO states
3976 @vindex org-enforce-todo-dependencies
3977 @cindex property, ORDERED
3978 The structure of Org files (hierarchy and lists) makes it easy to define TODO
3979 dependencies. Usually, a parent TODO task should not be marked DONE until
3980 all subtasks (defined as children tasks) are marked as DONE. And sometimes
3981 there is a logical sequence to a number of (sub)tasks, so that one task
3982 cannot be acted upon before all siblings above it are done. If you customize
3983 the variable @code{org-enforce-todo-dependencies}, Org will block entries
3984 from changing state to DONE while they have children that are not DONE.
3985 Furthermore, if an entry has a property @code{ORDERED}, each of its children
3986 will be blocked until all earlier siblings are marked DONE. Here is an
3990 * TODO Blocked until (two) is done
3999 ** TODO b, needs to wait for (a)
4000 ** TODO c, needs to wait for (a) and (b)
4004 @orgcmd{C-c C-x o,org-toggle-ordered-property}
4005 @vindex org-track-ordered-property-with-tag
4006 @cindex property, ORDERED
4007 Toggle the @code{ORDERED} property of the current entry. A property is used
4008 for this behavior because this should be local to the current entry, not
4009 inherited like a tag. However, if you would like to @i{track} the value of
4010 this property with a tag for better visibility, customize the variable
4011 @code{org-track-ordered-property-with-tag}.
4012 @orgkey{C-u C-u C-u C-c C-t}
4013 Change TODO state, circumventing any state blocking.
4016 @vindex org-agenda-dim-blocked-tasks
4017 If you set the variable @code{org-agenda-dim-blocked-tasks}, TODO entries
4018 that cannot be closed because of such dependencies will be shown in a dimmed
4019 font or even made invisible in agenda views (@pxref{Agenda Views}).
4021 @cindex checkboxes and TODO dependencies
4022 @vindex org-enforce-todo-dependencies
4023 You can also block changes of TODO states by looking at checkboxes
4024 (@pxref{Checkboxes}). If you set the variable
4025 @code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked
4026 checkboxes will be blocked from switching to DONE.
4028 If you need more complex dependency structures, for example dependencies
4029 between entries in different trees or files, check out the contributed
4030 module @file{org-depend.el}.
4033 @node Progress logging, Priorities, TODO extensions, TODO Items
4034 @section Progress logging
4035 @cindex progress logging
4036 @cindex logging, of progress
4038 Org mode can automatically record a timestamp and possibly a note when
4039 you mark a TODO item as DONE, or even each time you change the state of
4040 a TODO item. This system is highly configurable, settings can be on a
4041 per-keyword basis and can be localized to a file or even a subtree. For
4042 information on how to clock working time for a task, see @ref{Clocking
4046 * Closing items:: When was this entry marked DONE?
4047 * Tracking TODO state changes:: When did the status change?
4048 * Tracking your habits:: How consistent have you been?
4051 @node Closing items, Tracking TODO state changes, Progress logging, Progress logging
4052 @subsection Closing items
4054 The most basic logging is to keep track of @emph{when} a certain TODO
4055 item was finished. This is achieved with@footnote{The corresponding
4056 in-buffer setting is: @code{#+STARTUP: logdone}}
4059 (setq org-log-done 'time)
4063 Then each time you turn an entry from a TODO (not-done) state into any
4064 of the DONE states, a line @samp{CLOSED: [timestamp]} will be inserted
4065 just after the headline. If you turn the entry back into a TODO item
4066 through further state cycling, that line will be removed again. If you
4067 want to record a note along with the timestamp, use@footnote{The
4068 corresponding in-buffer setting is: @code{#+STARTUP: lognotedone}}
4071 (setq org-log-done 'note)
4075 You will then be prompted for a note, and that note will be stored below
4076 the entry with a @samp{Closing Note} heading.
4078 In the timeline (@pxref{Timeline}) and in the agenda
4079 (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
4080 display the TODO items with a @samp{CLOSED} timestamp on each day,
4081 giving you an overview of what has been done.
4083 @node Tracking TODO state changes, Tracking your habits, Closing items, Progress logging
4084 @subsection Tracking TODO state changes
4085 @cindex drawer, for state change recording
4087 @vindex org-log-states-order-reversed
4088 @vindex org-log-into-drawer
4089 @cindex property, LOG_INTO_DRAWER
4090 When TODO keywords are used as workflow states (@pxref{Workflow states}), you
4091 might want to keep track of when a state change occurred and maybe take a
4092 note about this change. You can either record just a timestamp, or a
4093 time-stamped note for a change. These records will be inserted after the
4094 headline as an itemized list, newest first@footnote{See the variable
4095 @code{org-log-states-order-reversed}}. When taking a lot of notes, you might
4096 want to get the notes out of the way into a drawer (@pxref{Drawers}).
4097 Customize the variable @code{org-log-into-drawer} to get this behavior---the
4098 recommended drawer for this is called @code{LOGBOOK}@footnote{Note that the
4099 @code{LOGBOOK} drawer is unfolded when pressing @key{SPC} in the agenda to
4100 show an entry---use @key{C-u SPC} to keep it folded here}. You can also
4101 overrule the setting of this variable for a subtree by setting a
4102 @code{LOG_INTO_DRAWER} property.
4104 Since it is normally too much to record a note for every state, Org mode
4105 expects configuration on a per-keyword basis for this. This is achieved by
4106 adding special markers @samp{!} (for a timestamp) or @samp{@@} (for a note
4107 with timestamp) in parentheses after each keyword. For example, with the
4111 (setq org-todo-keywords
4112 '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
4115 To record a timestamp without a note for TODO keywords configured with
4116 @samp{@@}, just type @kbd{C-c C-c} to enter a blank note when prompted.
4119 @vindex org-log-done
4120 you not only define global TODO keywords and fast access keys, but also
4121 request that a time is recorded when the entry is set to
4122 DONE@footnote{It is possible that Org mode will record two timestamps
4123 when you are using both @code{org-log-done} and state change logging.
4124 However, it will never prompt for two notes---if you have configured
4125 both, the state change recording note will take precedence and cancel
4126 the @samp{Closing Note}.}, and that a note is recorded when switching to
4127 WAIT or CANCELED. The setting for WAIT is even more special: the
4128 @samp{!} after the slash means that in addition to the note taken when
4129 entering the state, a timestamp should be recorded when @i{leaving} the
4130 WAIT state, if and only if the @i{target} state does not configure
4131 logging for entering it. So it has no effect when switching from WAIT
4132 to DONE, because DONE is configured to record a timestamp only. But
4133 when switching from WAIT back to TODO, the @samp{/!} in the WAIT
4134 setting now triggers a timestamp even though TODO has no logging
4137 You can use the exact same syntax for setting logging preferences local
4140 #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
4143 @cindex property, LOGGING
4144 In order to define logging settings that are local to a subtree or a
4145 single item, define a LOGGING property in this entry. Any non-empty
4146 LOGGING property resets all logging settings to nil. You may then turn
4147 on logging for this specific tree using STARTUP keywords like
4148 @code{lognotedone} or @code{logrepeat}, as well as adding state specific
4149 settings like @code{TODO(!)}. For example
4152 * TODO Log each state with only a time
4154 :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
4156 * TODO Only log when switching to WAIT, and when repeating
4158 :LOGGING: WAIT(@@) logrepeat
4160 * TODO No logging at all
4166 @node Tracking your habits, , Tracking TODO state changes, Progress logging
4167 @subsection Tracking your habits
4170 Org has the ability to track the consistency of a special category of TODOs,
4171 called ``habits''. A habit has the following properties:
4175 You have enabled the @code{habits} module by customizing the variable
4178 The habit is a TODO item, with a TODO keyword representing an open state.
4180 The property @code{STYLE} is set to the value @code{habit}.
4182 The TODO has a scheduled date, usually with a @code{.+} style repeat
4183 interval. A @code{++} style may be appropriate for habits with time
4184 constraints, e.g., must be done on weekends, or a @code{+} style for an
4185 unusual habit that can have a backlog, e.g., weekly reports.
4187 The TODO may also have minimum and maximum ranges specified by using the
4188 syntax @samp{.+2d/3d}, which says that you want to do the task at least every
4189 three days, but at most every two days.
4191 You must also have state logging for the @code{DONE} state enabled, in order
4192 for historical data to be represented in the consistency graph. If it is not
4193 enabled it is not an error, but the consistency graphs will be largely
4197 To give you an idea of what the above rules look like in action, here's an
4198 actual habit with some history:
4202 SCHEDULED: <2009-10-17 Sat .+2d/4d>
4203 - State "DONE" from "TODO" [2009-10-15 Thu]
4204 - State "DONE" from "TODO" [2009-10-12 Mon]
4205 - State "DONE" from "TODO" [2009-10-10 Sat]
4206 - State "DONE" from "TODO" [2009-10-04 Sun]
4207 - State "DONE" from "TODO" [2009-10-02 Fri]
4208 - State "DONE" from "TODO" [2009-09-29 Tue]
4209 - State "DONE" from "TODO" [2009-09-25 Fri]
4210 - State "DONE" from "TODO" [2009-09-19 Sat]
4211 - State "DONE" from "TODO" [2009-09-16 Wed]
4212 - State "DONE" from "TODO" [2009-09-12 Sat]
4215 :LAST_REPEAT: [2009-10-19 Mon 00:36]
4219 What this habit says is: I want to shave at most every 2 days (given by the
4220 @code{SCHEDULED} date and repeat interval) and at least every 4 days. If
4221 today is the 15th, then the habit first appears in the agenda on Oct 17,
4222 after the minimum of 2 days has elapsed, and will appear overdue on Oct 19,
4223 after four days have elapsed.
4225 What's really useful about habits is that they are displayed along with a
4226 consistency graph, to show how consistent you've been at getting that task
4227 done in the past. This graph shows every day that the task was done over the
4228 past three weeks, with colors for each day. The colors used are:
4232 If the task wasn't to be done yet on that day.
4234 If the task could have been done on that day.
4236 If the task was going to be overdue the next day.
4238 If the task was overdue on that day.
4241 In addition to coloring each day, the day is also marked with an asterisk if
4242 the task was actually done that day, and an exclamation mark to show where
4243 the current day falls in the graph.
4245 There are several configuration variables that can be used to change the way
4246 habits are displayed in the agenda.
4249 @item org-habit-graph-column
4250 The buffer column at which the consistency graph should be drawn. This will
4251 overwrite any text in that column, so it is a good idea to keep your habits'
4252 titles brief and to the point.
4253 @item org-habit-preceding-days
4254 The amount of history, in days before today, to appear in consistency graphs.
4255 @item org-habit-following-days
4256 The number of days after today that will appear in consistency graphs.
4257 @item org-habit-show-habits-only-for-today
4258 If non-nil, only show habits in today's agenda view. This is set to true by
4262 Lastly, pressing @kbd{K} in the agenda buffer will cause habits to
4263 temporarily be disabled and they won't appear at all. Press @kbd{K} again to
4264 bring them back. They are also subject to tag filtering, if you have habits
4265 which should only be done in certain contexts, for example.
4267 @node Priorities, Breaking down tasks, Progress logging, TODO Items
4271 If you use Org mode extensively, you may end up with enough TODO items that
4272 it starts to make sense to prioritize them. Prioritizing can be done by
4273 placing a @emph{priority cookie} into the headline of a TODO item, like this
4276 *** TODO [#A] Write letter to Sam Fortune
4280 @vindex org-priority-faces
4281 By default, Org mode supports three priorities: @samp{A}, @samp{B}, and
4282 @samp{C}. @samp{A} is the highest priority. An entry without a cookie is
4283 treated just like priority @samp{B}. Priorities make a difference only for
4284 sorting in the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they
4285 have no inherent meaning to Org mode. The cookies can be highlighted with
4286 special faces by customizing the variable @code{org-priority-faces}.
4288 Priorities can be attached to any outline node; they do not need to be TODO
4294 @findex org-priority
4295 Set the priority of the current headline (@command{org-priority}). The
4296 command prompts for a priority character @samp{A}, @samp{B} or @samp{C}.
4297 When you press @key{SPC} instead, the priority cookie is removed from the
4298 headline. The priorities can also be changed ``remotely'' from the timeline
4299 and agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
4301 @orgcmdkkcc{S-@key{up},S-@key{down},org-priority-up,org-priority-down}
4302 @vindex org-priority-start-cycle-with-default
4303 Increase/decrease priority of current headline@footnote{See also the option
4304 @code{org-priority-start-cycle-with-default}.}. Note that these keys are
4305 also used to modify timestamps (@pxref{Creating timestamps}). See also
4306 @ref{Conflicts}, for a discussion of the interaction with
4307 @code{shift-selection-mode}.
4310 @vindex org-highest-priority
4311 @vindex org-lowest-priority
4312 @vindex org-default-priority
4313 You can change the range of allowed priorities by setting the variables
4314 @code{org-highest-priority}, @code{org-lowest-priority}, and
4315 @code{org-default-priority}. For an individual buffer, you may set
4316 these values (highest, lowest, default) like this (please make sure that
4317 the highest priority is earlier in the alphabet than the lowest
4320 @cindex #+PRIORITIES
4325 @node Breaking down tasks, Checkboxes, Priorities, TODO Items
4326 @section Breaking tasks down into subtasks
4327 @cindex tasks, breaking down
4328 @cindex statistics, for TODO items
4330 @vindex org-agenda-todo-list-sublevels
4331 It is often advisable to break down large tasks into smaller, manageable
4332 subtasks. You can do this by creating an outline tree below a TODO item,
4333 with detailed subtasks on the tree@footnote{To keep subtasks out of the
4334 global TODO list, see the @code{org-agenda-todo-list-sublevels}.}. To keep
4335 the overview over the fraction of subtasks that are already completed, insert
4336 either @samp{[/]} or @samp{[%]} anywhere in the headline. These cookies will
4337 be updated each time the TODO status of a child changes, or when pressing
4338 @kbd{C-c C-c} on the cookie. For example:
4341 * Organize Party [33%]
4342 ** TODO Call people [1/2]
4346 ** DONE Talk to neighbor
4349 @cindex property, COOKIE_DATA
4350 If a heading has both checkboxes and TODO children below it, the meaning of
4351 the statistics cookie become ambiguous. Set the property
4352 @code{COOKIE_DATA} to either @samp{checkbox} or @samp{todo} to resolve
4355 @vindex org-hierarchical-todo-statistics
4356 If you would like to have the statistics cookie count any TODO entries in the
4357 subtree (not just direct children), configure the variable
4358 @code{org-hierarchical-todo-statistics}. To do this for a single subtree,
4359 include the word @samp{recursive} into the value of the @code{COOKIE_DATA}
4363 * Parent capturing statistics [2/20]
4365 :COOKIE_DATA: todo recursive
4369 If you would like a TODO entry to automatically change to DONE
4370 when all children are done, you can use the following setup:
4373 (defun org-summary-todo (n-done n-not-done)
4374 "Switch entry to DONE when all subentries are done, to TODO otherwise."
4375 (let (org-log-done org-log-states) ; turn off logging
4376 (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
4378 (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
4382 Another possibility is the use of checkboxes to identify (a hierarchy of) a
4383 large number of subtasks (@pxref{Checkboxes}).
4386 @node Checkboxes, , Breaking down tasks, TODO Items
4390 @vindex org-list-automatic-rules
4391 Every item in a plain list@footnote{With the exception of description
4392 lists. But you can allow it by modifying @code{org-list-automatic-rules}
4393 accordingly.} (@pxref{Plain lists}) can be made into a checkbox by starting
4394 it with the string @samp{[ ]}. This feature is similar to TODO items
4395 (@pxref{TODO Items}), but is more lightweight. Checkboxes are not included
4396 into the global TODO list, so they are often great to split a task into a
4397 number of simple steps. Or you can use them in a shopping list. To toggle a
4398 checkbox, use @kbd{C-c C-c}, or use the mouse (thanks to Piotr Zielinski's
4399 @file{org-mouse.el}).
4401 Here is an example of a checkbox list.
4404 * TODO Organize party [2/4]
4405 - [-] call people [1/3]
4410 - [ ] think about what music to play
4411 - [X] talk to the neighbors
4414 Checkboxes work hierarchically, so if a checkbox item has children that
4415 are checkboxes, toggling one of the children checkboxes will make the
4416 parent checkbox reflect if none, some, or all of the children are
4419 @cindex statistics, for checkboxes
4420 @cindex checkbox statistics
4421 @cindex property, COOKIE_DATA
4422 @vindex org-hierarchical-checkbox-statistics
4423 The @samp{[2/4]} and @samp{[1/3]} in the first and second line are cookies
4424 indicating how many checkboxes present in this entry have been checked off,
4425 and the total number of checkboxes present. This can give you an idea on how
4426 many checkboxes remain, even without opening a folded entry. The cookies can
4427 be placed into a headline or into (the first line of) a plain list item.
4428 Each cookie covers checkboxes of direct children structurally below the
4429 headline/item on which the cookie appears@footnote{Set the variable
4430 @code{org-hierarchical-checkbox-statistics} if you want such cookies to
4431 count all checkboxes below the cookie, not just those belonging to direct
4432 children.}. You have to insert the cookie yourself by typing either
4433 @samp{[/]} or @samp{[%]}. With @samp{[/]} you get an @samp{n out of m}
4434 result, as in the examples above. With @samp{[%]} you get information about
4435 the percentage of checkboxes checked (in the above example, this would be
4436 @samp{[50%]} and @samp{[33%]}, respectively). In a headline, a cookie can
4437 count either checkboxes below the heading or TODO states of children, and it
4438 will display whatever was changed last. Set the property @code{COOKIE_DATA}
4439 to either @samp{checkbox} or @samp{todo} to resolve this issue.
4441 @cindex blocking, of checkboxes
4442 @cindex checkbox blocking
4443 @cindex property, ORDERED
4444 If the current outline node has an @code{ORDERED} property, checkboxes must
4445 be checked off in sequence, and an error will be thrown if you try to check
4446 off a box while there are unchecked boxes above it.
4448 @noindent The following commands work with checkboxes:
4451 @orgcmd{C-c C-c,org-toggle-checkbox}
4452 Toggle checkbox status or (with prefix arg) checkbox presence at point.
4453 With a single prefix argument, add an empty checkbox or remove the current
4454 one@footnote{`C-u C-c C-c' on the @emph{first} item of a list with no checkbox
4455 will add checkboxes to the rest of the list.}. With a double prefix argument, set it to @samp{[-]}, which is
4456 considered to be an intermediate state.
4457 @orgcmd{C-c C-x C-b,org-toggle-checkbox}
4458 Toggle checkbox status or (with prefix arg) checkbox presence at point. With
4459 double prefix argument, set it to @samp{[-]}, which is considered to be an
4463 If there is an active region, toggle the first checkbox in the region
4464 and set all remaining boxes to the same status as the first. With a prefix
4465 arg, add or remove the checkbox for all items in the region.
4467 If the cursor is in a headline, toggle checkboxes in the region between
4468 this headline and the next (so @emph{not} the entire subtree).
4470 If there is no active region, just toggle the checkbox at point.
4472 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
4473 Insert a new item with a checkbox. This works only if the cursor is already
4474 in a plain list item (@pxref{Plain lists}).
4475 @orgcmd{C-c C-x o,org-toggle-ordered-property}
4476 @vindex org-track-ordered-property-with-tag
4477 @cindex property, ORDERED
4478 Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
4479 be checked off in sequence. A property is used for this behavior because
4480 this should be local to the current entry, not inherited like a tag.
4481 However, if you would like to @i{track} the value of this property with a tag
4482 for better visibility, customize the variable
4483 @code{org-track-ordered-property-with-tag}.
4484 @orgcmd{C-c #,org-update-statistics-cookies}
4485 Update the statistics cookie in the current outline entry. When called with
4486 a @kbd{C-u} prefix, update the entire file. Checkbox statistic cookies are
4487 updated automatically if you toggle checkboxes with @kbd{C-c C-c} and make
4488 new ones with @kbd{M-S-@key{RET}}. TODO statistics cookies update when
4489 changing TODO states. If you delete boxes/entries or add/change them by
4490 hand, use this command to get things back into sync.
4493 @node Tags, Properties and Columns, TODO Items, Top
4496 @cindex headline tagging
4497 @cindex matching, tags
4498 @cindex sparse tree, tag based
4500 An excellent way to implement labels and contexts for cross-correlating
4501 information is to assign @i{tags} to headlines. Org mode has extensive
4504 @vindex org-tag-faces
4505 Every headline can contain a list of tags; they occur at the end of the
4506 headline. Tags are normal words containing letters, numbers, @samp{_}, and
4507 @samp{@@}. Tags must be preceded and followed by a single colon, e.g.,
4508 @samp{:work:}. Several tags can be specified, as in @samp{:work:urgent:}.
4509 Tags will by default be in bold face with the same color as the headline.
4510 You may specify special faces for specific tags using the variable
4511 @code{org-tag-faces}, in much the same way as you can for TODO keywords
4512 (@pxref{Faces for TODO keywords}).
4515 * Tag inheritance:: Tags use the tree structure of the outline
4516 * Setting tags:: How to assign tags to a headline
4517 * Tag searches:: Searching for combinations of tags
4520 @node Tag inheritance, Setting tags, Tags, Tags
4521 @section Tag inheritance
4522 @cindex tag inheritance
4523 @cindex inheritance, of tags
4524 @cindex sublevels, inclusion into tags match
4526 @i{Tags} make use of the hierarchical structure of outline trees. If a
4527 heading has a certain tag, all subheadings will inherit the tag as
4528 well. For example, in the list
4531 * Meeting with the French group :work:
4532 ** Summary by Frank :boss:notes:
4533 *** TODO Prepare slides for him :action:
4537 the final heading will have the tags @samp{:work:}, @samp{:boss:},
4538 @samp{:notes:}, and @samp{:action:} even though the final heading is not
4539 explicitly marked with those tags. You can also set tags that all entries in
4540 a file should inherit just as if these tags were defined in a hypothetical
4541 level zero that surrounds the entire file. Use a line like this@footnote{As
4542 with all these in-buffer settings, pressing @kbd{C-c C-c} activates any
4543 changes in the line.}:
4547 #+FILETAGS: :Peter:Boss:Secret:
4551 @vindex org-use-tag-inheritance
4552 @vindex org-tags-exclude-from-inheritance
4553 To limit tag inheritance to specific tags, or to turn it off entirely, use
4554 the variables @code{org-use-tag-inheritance} and
4555 @code{org-tags-exclude-from-inheritance}.
4557 @vindex org-tags-match-list-sublevels
4558 When a headline matches during a tags search while tag inheritance is turned
4559 on, all the sublevels in the same tree will (for a simple match form) match
4560 as well@footnote{This is only true if the search does not involve more
4561 complex tests including properties (@pxref{Property searches}).}. The list
4562 of matches may then become very long. If you only want to see the first tags
4563 match in a subtree, configure the variable
4564 @code{org-tags-match-list-sublevels} (not recommended).
4566 @node Setting tags, Tag searches, Tag inheritance, Tags
4567 @section Setting tags
4568 @cindex setting tags
4569 @cindex tags, setting
4572 Tags can simply be typed into the buffer at the end of a headline.
4573 After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is
4574 also a special command for inserting tags:
4577 @orgcmd{C-c C-q,org-set-tags-command}
4578 @cindex completion, of tags
4579 @vindex org-tags-column
4580 Enter new tags for the current headline. Org mode will either offer
4581 completion or a special single-key interface for setting tags, see
4582 below. After pressing @key{RET}, the tags will be inserted and aligned
4583 to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all
4584 tags in the current buffer will be aligned to that column, just to make
4585 things look nice. TAGS are automatically realigned after promotion,
4586 demotion, and TODO state changes (@pxref{TODO basics}).
4587 @orgcmd{C-c C-c,org-set-tags-command}
4588 When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
4591 @vindex org-tag-alist
4592 Org supports tag insertion based on a @emph{list of tags}. By
4593 default this list is constructed dynamically, containing all tags
4594 currently used in the buffer. You may also globally specify a hard list
4595 of tags with the variable @code{org-tag-alist}. Finally you can set
4596 the default tags for a given file with lines like
4600 #+TAGS: @@work @@home @@tennisclub
4601 #+TAGS: laptop car pc sailboat
4604 If you have globally defined your preferred set of tags using the
4605 variable @code{org-tag-alist}, but would like to use a dynamic tag list
4606 in a specific file, add an empty TAGS option line to that file:
4612 @vindex org-tag-persistent-alist
4613 If you have a preferred set of tags that you would like to use in every file,
4614 in addition to those defined on a per-file basis by TAGS option lines, then
4615 you may specify a list of tags with the variable
4616 @code{org-tag-persistent-alist}. You may turn this off on a per-file basis
4617 by adding a STARTUP option line to that file:
4623 By default Org mode uses the standard minibuffer completion facilities for
4624 entering tags. However, it also implements another, quicker, tag selection
4625 method called @emph{fast tag selection}. This allows you to select and
4626 deselect tags with just a single key press. For this to work well you should
4627 assign unique letters to most of your commonly used tags. You can do this
4628 globally by configuring the variable @code{org-tag-alist} in your
4629 @file{.emacs} file. For example, you may find the need to tag many items in
4630 different files with @samp{:@@home:}. In this case you can set something
4634 (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
4637 @noindent If the tag is only relevant to the file you are working on, then you
4638 can instead set the TAGS option line as:
4641 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p)
4644 @noindent The tags interface will show the available tags in a splash
4645 window. If you want to start a new line after a specific tag, insert
4646 @samp{\n} into the tag list
4649 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) \n laptop(l) pc(p)
4652 @noindent or write them in two lines:
4655 #+TAGS: @@work(w) @@home(h) @@tennisclub(t)
4656 #+TAGS: laptop(l) pc(p)
4660 You can also group together tags that are mutually exclusive by using
4664 #+TAGS: @{ @@work(w) @@home(h) @@tennisclub(t) @} laptop(l) pc(p)
4667 @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
4668 and @samp{@@tennisclub} should be selected. Multiple such groups are allowed.
4670 @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
4671 these lines to activate any changes.
4674 To set these mutually exclusive groups in the variable @code{org-tags-alist},
4675 you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
4676 of the braces. Similarly, you can use @code{:newline} to indicate a line
4677 break. The previous example would be set globally by the following
4681 (setq org-tag-alist '((:startgroup . nil)
4682 ("@@work" . ?w) ("@@home" . ?h)
4683 ("@@tennisclub" . ?t)
4685 ("laptop" . ?l) ("pc" . ?p)))
4688 If at least one tag has a selection key then pressing @kbd{C-c C-c} will
4689 automatically present you with a special interface, listing inherited tags,
4690 the tags of the current headline, and a list of all valid tags with
4691 corresponding keys@footnote{Keys will automatically be assigned to tags which
4692 have no configured keys.}. In this interface, you can use the following
4697 Pressing keys assigned to tags will add or remove them from the list of
4698 tags in the current line. Selecting a tag in a group of mutually
4699 exclusive tags will turn off any other tags from that group.
4702 Enter a tag in the minibuffer, even if the tag is not in the predefined
4703 list. You will be able to complete on all tags present in the buffer.
4704 You can also add several tags: just separate them with a comma.
4708 Clear all tags for this line.
4711 Accept the modified set.
4713 Abort without installing changes.
4715 If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
4717 Turn off groups of mutually exclusive tags. Use this to (as an
4718 exception) assign several tags from such a group.
4720 Toggle auto-exit after the next change (see below).
4721 If you are using expert mode, the first @kbd{C-c} will display the
4726 This method lets you assign tags to a headline with very few keys. With
4727 the above setup, you could clear the current tags and set @samp{@@home},
4728 @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
4729 C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@home} to
4730 @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
4731 alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag
4732 @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
4733 @key{RET} @key{RET}}.
4735 @vindex org-fast-tag-selection-single-key
4736 If you find that most of the time you need only a single key press to
4737 modify your list of tags, set the variable
4738 @code{org-fast-tag-selection-single-key}. Then you no longer have to
4739 press @key{RET} to exit fast tag selection---it will immediately exit
4740 after the first change. If you then occasionally need more keys, press
4741 @kbd{C-c} to turn off auto-exit for the current tag selection process
4742 (in effect: start selection with @kbd{C-c C-c C-c} instead of @kbd{C-c
4743 C-c}). If you set the variable to the value @code{expert}, the special
4744 window is not even shown for single-key tag selection, it comes up only
4745 when you press an extra @kbd{C-c}.
4747 @node Tag searches, , Setting tags, Tags
4748 @section Tag searches
4749 @cindex tag searches
4750 @cindex searching for tags
4752 Once a system of tags has been set up, it can be used to collect related
4753 information into special lists.
4756 @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
4757 Create a sparse tree with all headlines matching a tags search. With a
4758 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
4759 @orgcmd{C-c a m,org-tags-view}
4760 Create a global list of tag matches from all agenda files.
4761 @xref{Matching tags and properties}.
4762 @orgcmd{C-c a M,org-tags-view}
4763 @vindex org-tags-match-list-sublevels
4764 Create a global list of tag matches from all agenda files, but check
4765 only TODO items and force checking subitems (see variable
4766 @code{org-tags-match-list-sublevels}).
4769 These commands all prompt for a match string which allows basic Boolean logic
4770 like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and
4771 @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries
4772 which are tagged, like @samp{Kathy} or @samp{Sally}. The full syntax of the search
4773 string is rich and allows also matching against TODO keywords, entry levels
4774 and properties. For a complete description with many examples, see
4775 @ref{Matching tags and properties}.
4778 @node Properties and Columns, Dates and Times, Tags, Top
4779 @chapter Properties and columns
4782 A property is a key-value pair associated with an entry. Properties can be
4783 set so they are associated with a single entry, with every entry in a tree,
4784 or with every entry in an Org mode file.
4786 There are two main applications for properties in Org mode. First,
4787 properties are like tags, but with a value. Imagine maintaining a file where
4788 you document bugs and plan releases for a piece of software. Instead of
4789 using tags like @code{:release_1:}, @code{:release_2:}, you can use a
4790 property, say @code{:Release:}, that in different subtrees has different
4791 values, such as @code{1.0} or @code{2.0}. Second, you can use properties to
4792 implement (very basic) database capabilities in an Org buffer. Imagine
4793 keeping track of your music CDs, where properties could be things such as the
4794 album, artist, date of release, number of tracks, and so on.
4796 Properties can be conveniently edited and viewed in column view
4797 (@pxref{Column view}).
4800 * Property syntax:: How properties are spelled out
4801 * Special properties:: Access to other Org mode features
4802 * Property searches:: Matching property values
4803 * Property inheritance:: Passing values down the tree
4804 * Column view:: Tabular viewing and editing
4805 * Property API:: Properties for Lisp programmers
4808 @node Property syntax, Special properties, Properties and Columns, Properties and Columns
4809 @section Property syntax
4810 @cindex property syntax
4811 @cindex drawer, for properties
4813 Properties are key-value pairs. When they are associated with a single entry
4814 or with a tree they need to be inserted into a special
4815 drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property
4816 is specified on a single line, with the key (surrounded by colons)
4817 first, and the value after it. Here is an example:
4822 *** Goldberg Variations
4824 :Title: Goldberg Variations
4825 :Composer: J.S. Bach
4827 :Publisher: Deutsche Grammophon
4832 Depending on the value of @code{org-use-property-inheritance}, a property set
4833 this way will either be associated with a single entry, or the sub-tree
4834 defined by the entry, see @ref{Property inheritance}.
4836 You may define the allowed values for a particular property @samp{:Xyz:}
4837 by setting a property @samp{:Xyz_ALL:}. This special property is
4838 @emph{inherited}, so if you set it in a level 1 entry, it will apply to
4839 the entire tree. When allowed values are defined, setting the
4840 corresponding property becomes easier and is less prone to typing
4841 errors. For the example with the CD collection, we can predefine
4842 publishers and the number of disks in a box like this:
4847 :NDisks_ALL: 1 2 3 4
4848 :Publisher_ALL: "Deutsche Grammophon" Philips EMI
4852 If you want to set properties that can be inherited by any entry in a
4853 file, use a line like
4854 @cindex property, _ALL
4857 #+PROPERTY: NDisks_ALL 1 2 3 4
4860 If you want to add to the value of an existing property, append a @code{+} to
4861 the property name. The following results in the property @code{var} having
4862 the value ``foo=1 bar=2''.
4865 #+PROPERTY: var foo=1
4866 #+PROPERTY: var+ bar=2
4869 It is also possible to add to the values of inherited properties. The
4870 following results in the @code{genres} property having the value ``Classic
4871 Baroque'' under the @code{Goldberg Variations} subtree.
4879 *** Goldberg Variations
4881 :Title: Goldberg Variations
4882 :Composer: J.S. Bach
4884 :Publisher: Deutsche Grammophon
4889 Note that a property can only have one entry per Drawer.
4891 @vindex org-global-properties
4892 Property values set with the global variable
4893 @code{org-global-properties} can be inherited by all entries in all
4897 The following commands help to work with properties:
4900 @orgcmd{M-@key{TAB},pcomplete}
4901 After an initial colon in a line, complete property keys. All keys used
4902 in the current file will be offered as possible completions.
4903 @orgcmd{C-c C-x p,org-set-property}
4904 Set a property. This prompts for a property name and a value. If
4905 necessary, the property drawer is created as well.
4906 @item C-u M-x org-insert-drawer
4907 @cindex org-insert-drawer
4908 Insert a property drawer into the current entry. The drawer will be
4909 inserted early in the entry, but after the lines with planning
4910 information like deadlines.
4911 @orgcmd{C-c C-c,org-property-action}
4912 With the cursor in a property drawer, this executes property commands.
4913 @orgcmd{C-c C-c s,org-set-property}
4914 Set a property in the current entry. Both the property and the value
4915 can be inserted using completion.
4916 @orgcmdkkcc{S-@key{right},S-@key{left},org-property-next-allowed-value,org-property-previous-allowed-value}
4917 Switch property at point to the next/previous allowed value.
4918 @orgcmd{C-c C-c d,org-delete-property}
4919 Remove a property from the current entry.
4920 @orgcmd{C-c C-c D,org-delete-property-globally}
4921 Globally remove a property, from all entries in the current file.
4922 @orgcmd{C-c C-c c,org-compute-property-at-point}
4923 Compute the property at point, using the operator and scope from the
4924 nearest column format definition.
4927 @node Special properties, Property searches, Property syntax, Properties and Columns
4928 @section Special properties
4929 @cindex properties, special
4931 Special properties provide an alternative access method to Org mode features,
4932 like the TODO state or the priority of an entry, discussed in the previous
4933 chapters. This interface exists so that you can include these states in a
4934 column view (@pxref{Column view}), or to use them in queries. The following
4935 property names are special and (except for @code{:CATEGORY:}) should not be
4936 used as keys in the properties drawer:
4938 @cindex property, special, TODO
4939 @cindex property, special, TAGS
4940 @cindex property, special, ALLTAGS
4941 @cindex property, special, CATEGORY
4942 @cindex property, special, PRIORITY
4943 @cindex property, special, DEADLINE
4944 @cindex property, special, SCHEDULED
4945 @cindex property, special, CLOSED
4946 @cindex property, special, TIMESTAMP
4947 @cindex property, special, TIMESTAMP_IA
4948 @cindex property, special, CLOCKSUM
4949 @cindex property, special, BLOCKED
4950 @c guessing that ITEM is needed in this area; also, should this list be sorted?
4951 @cindex property, special, ITEM
4952 @cindex property, special, FILE
4954 TODO @r{The TODO keyword of the entry.}
4955 TAGS @r{The tags defined directly in the headline.}
4956 ALLTAGS @r{All tags, including inherited ones.}
4957 CATEGORY @r{The category of an entry.}
4958 PRIORITY @r{The priority of the entry, a string with a single letter.}
4959 DEADLINE @r{The deadline time string, without the angular brackets.}
4960 SCHEDULED @r{The scheduling timestamp, without the angular brackets.}
4961 CLOSED @r{When was this entry closed?}
4962 TIMESTAMP @r{The first keyword-less timestamp in the entry.}
4963 TIMESTAMP_IA @r{The first inactive timestamp in the entry.}
4964 CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}}
4965 @r{must be run first to compute the values in the current buffer.}
4966 BLOCKED @r{"t" if task is currently blocked by children or siblings}
4967 ITEM @r{The content of the entry.}
4968 FILE @r{The filename the entry is located in.}
4971 @node Property searches, Property inheritance, Special properties, Properties and Columns
4972 @section Property searches
4973 @cindex properties, searching
4974 @cindex searching, of properties
4976 To create sparse trees and special lists with selection based on properties,
4977 the same commands are used as for tag searches (@pxref{Tag searches}).
4979 @orgcmdkkc{C-c / m,C-c \,org-match-sparse-tree}
4980 Create a sparse tree with all matching entries. With a
4981 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
4982 @orgcmd{C-c a m,org-tags-view}
4983 Create a global list of tag/property matches from all agenda files.
4984 @xref{Matching tags and properties}.
4985 @orgcmd{C-c a M,org-tags-view}
4986 @vindex org-tags-match-list-sublevels
4987 Create a global list of tag matches from all agenda files, but check
4988 only TODO items and force checking of subitems (see variable
4989 @code{org-tags-match-list-sublevels}).
4992 The syntax for the search string is described in @ref{Matching tags and
4995 There is also a special command for creating sparse trees based on a
5000 Create a sparse tree based on the value of a property. This first
5001 prompts for the name of a property, and then for a value. A sparse tree
5002 is created with all entries that define this property with the given
5003 value. If you enclose the value in curly braces, it is interpreted as
5004 a regular expression and matched against the property values.
5007 @node Property inheritance, Column view, Property searches, Properties and Columns
5008 @section Property Inheritance
5009 @cindex properties, inheritance
5010 @cindex inheritance, of properties
5012 @vindex org-use-property-inheritance
5013 The outline structure of Org mode documents lends itself to an
5014 inheritance model of properties: if the parent in a tree has a certain
5015 property, the children can inherit this property. Org mode does not
5016 turn this on by default, because it can slow down property searches
5017 significantly and is often not needed. However, if you find inheritance
5018 useful, you can turn it on by setting the variable
5019 @code{org-use-property-inheritance}. It may be set to @code{t} to make
5020 all properties inherited from the parent, to a list of properties
5021 that should be inherited, or to a regular expression that matches
5022 inherited properties. If a property has the value @samp{nil}, this is
5023 interpreted as an explicit undefine of the property, so that inheritance
5024 search will stop at this value and return @code{nil}.
5026 Org mode has a few properties for which inheritance is hard-coded, at
5027 least for the special applications for which they are used:
5029 @cindex property, COLUMNS
5032 The @code{:COLUMNS:} property defines the format of column view
5033 (@pxref{Column view}). It is inherited in the sense that the level
5034 where a @code{:COLUMNS:} property is defined is used as the starting
5035 point for a column view table, independently of the location in the
5036 subtree from where columns view is turned on.
5038 @cindex property, CATEGORY
5039 For agenda view, a category set through a @code{:CATEGORY:} property
5040 applies to the entire subtree.
5042 @cindex property, ARCHIVE
5043 For archiving, the @code{:ARCHIVE:} property may define the archive
5044 location for the entire subtree (@pxref{Moving subtrees}).
5046 @cindex property, LOGGING
5047 The LOGGING property may define logging settings for an entry or a
5048 subtree (@pxref{Tracking TODO state changes}).
5051 @node Column view, Property API, Property inheritance, Properties and Columns
5052 @section Column view
5054 A great way to view and edit properties in an outline tree is
5055 @emph{column view}. In column view, each outline node is turned into a
5056 table row. Columns in this table provide access to properties of the
5057 entries. Org mode implements columns by overlaying a tabular structure
5058 over the headline of each item. While the headlines have been turned
5059 into a table row, you can still change the visibility of the outline
5060 tree. For example, you get a compact table by switching to CONTENTS
5061 view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
5062 is active), but you can still open, read, and edit the entry below each
5063 headline. Or, you can switch to column view after executing a sparse
5064 tree command and in this way get a table only for the selected items.
5065 Column view also works in agenda buffers (@pxref{Agenda Views}) where
5066 queries have collected selected items, possibly from a number of files.
5069 * Defining columns:: The COLUMNS format property
5070 * Using column view:: How to create and use column view
5071 * Capturing column view:: A dynamic block for column view
5074 @node Defining columns, Using column view, Column view, Column view
5075 @subsection Defining columns
5076 @cindex column view, for properties
5077 @cindex properties, column view
5079 Setting up a column view first requires defining the columns. This is
5080 done by defining a column format line.
5083 * Scope of column definitions:: Where defined, where valid?
5084 * Column attributes:: Appearance and content of a column
5087 @node Scope of column definitions, Column attributes, Defining columns, Defining columns
5088 @subsubsection Scope of column definitions
5090 To define a column format for an entire file, use a line like
5094 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5097 To specify a format that only applies to a specific tree, add a
5098 @code{:COLUMNS:} property to the top node of that tree, for example:
5101 ** Top node for columns view
5103 :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5107 If a @code{:COLUMNS:} property is present in an entry, it defines columns
5108 for the entry itself, and for the entire subtree below it. Since the
5109 column definition is part of the hierarchical structure of the document,
5110 you can define columns on level 1 that are general enough for all
5111 sublevels, and more specific columns further down, when you edit a
5112 deeper part of the tree.
5114 @node Column attributes, , Scope of column definitions, Defining columns
5115 @subsubsection Column attributes
5116 A column definition sets the attributes of a column. The general
5117 definition looks like this:
5120 %[@var{width}]@var{property}[(@var{title})][@{@var{summary-type}@}]
5124 Except for the percent sign and the property name, all items are
5125 optional. The individual parts have the following meaning:
5128 @var{width} @r{An integer specifying the width of the column in characters.}
5129 @r{If omitted, the width will be determined automatically.}
5130 @var{property} @r{The property that should be edited in this column.}
5131 @r{Special properties representing meta data are allowed here}
5132 @r{as well (@pxref{Special properties})}
5133 @var{title} @r{The header text for the column. If omitted, the property}
5135 @{@var{summary-type}@} @r{The summary type. If specified, the column values for}
5136 @r{parent nodes are computed from the children.}
5137 @r{Supported summary types are:}
5138 @{+@} @r{Sum numbers in this column.}
5139 @{+;%.1f@} @r{Like @samp{+}, but format result with @samp{%.1f}.}
5140 @{$@} @r{Currency, short for @samp{+;%.2f}.}
5141 @{:@} @r{Sum times, HH:MM, plain numbers are hours.}
5142 @{X@} @r{Checkbox status, @samp{[X]} if all children are @samp{[X]}.}
5143 @{X/@} @r{Checkbox status, @samp{[n/m]}.}
5144 @{X%@} @r{Checkbox status, @samp{[n%]}.}
5145 @{min@} @r{Smallest number in column.}
5146 @{max@} @r{Largest number.}
5147 @{mean@} @r{Arithmetic mean of numbers.}
5148 @{:min@} @r{Smallest time value in column.}
5149 @{:max@} @r{Largest time value.}
5150 @{:mean@} @r{Arithmetic mean of time values.}
5151 @{@@min@} @r{Minimum age (in days/hours/mins/seconds).}
5152 @{@@max@} @r{Maximum age (in days/hours/mins/seconds).}
5153 @{@@mean@} @r{Arithmetic mean of ages (in days/hours/mins/seconds).}
5154 @{est+@} @r{Add low-high estimates.}
5158 Be aware that you can only have one summary type for any property you
5159 include. Subsequent columns referencing the same property will all display the
5160 same summary information.
5162 The @code{est+} summary type requires further explanation. It is used for
5163 combining estimates, expressed as low-high ranges. For example, instead
5164 of estimating a particular task will take 5 days, you might estimate it as
5165 5-6 days if you're fairly confident you know how much work is required, or
5166 1-10 days if you don't really know what needs to be done. Both ranges
5167 average at 5.5 days, but the first represents a more predictable delivery.
5169 When combining a set of such estimates, simply adding the lows and highs
5170 produces an unrealistically wide result. Instead, @code{est+} adds the
5171 statistical mean and variance of the sub-tasks, generating a final estimate
5172 from the sum. For example, suppose you had ten tasks, each of which was
5173 estimated at 0.5 to 2 days of work. Straight addition produces an estimate
5174 of 5 to 20 days, representing what to expect if everything goes either
5175 extremely well or extremely poorly. In contrast, @code{est+} estimates the
5176 full job more realistically, at 10-15 days.
5178 Here is an example for a complete columns definition, along with allowed
5182 :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.}
5183 %10Time_Estimate@{:@} %CLOCKSUM
5184 :Owner_ALL: Tammy Mark Karl Lisa Don
5185 :Status_ALL: "In progress" "Not started yet" "Finished" ""
5186 :Approved_ALL: "[ ]" "[X]"
5190 The first column, @samp{%25ITEM}, means the first 25 characters of the
5191 item itself, i.e.@: of the headline. You probably always should start the
5192 column definition with the @samp{ITEM} specifier. The other specifiers
5193 create columns @samp{Owner} with a list of names as allowed values, for
5194 @samp{Status} with four different possible values, and for a checkbox
5195 field @samp{Approved}. When no width is given after the @samp{%}
5196 character, the column will be exactly as wide as it needs to be in order
5197 to fully display all values. The @samp{Approved} column does have a
5198 modified title (@samp{Approved?}, with a question mark). Summaries will
5199 be created for the @samp{Time_Estimate} column by adding time duration
5200 expressions like HH:MM, and for the @samp{Approved} column, by providing
5201 an @samp{[X]} status if all children have been checked. The
5202 @samp{CLOCKSUM} column is special, it lists the sum of CLOCK intervals
5205 @node Using column view, Capturing column view, Defining columns, Column view
5206 @subsection Using column view
5209 @tsubheading{Turning column view on and off}
5210 @orgcmd{C-c C-x C-c,org-columns}
5211 @vindex org-columns-default-format
5212 Turn on column view. If the cursor is before the first headline in the file,
5213 column view is turned on for the entire file, using the @code{#+COLUMNS}
5214 definition. If the cursor is somewhere inside the outline, this command
5215 searches the hierarchy, up from point, for a @code{:COLUMNS:} property that
5216 defines a format. When one is found, the column view table is established
5217 for the tree starting at the entry that contains the @code{:COLUMNS:}
5218 property. If no such property is found, the format is taken from the
5219 @code{#+COLUMNS} line or from the variable @code{org-columns-default-format},
5220 and column view is established for the current entry and its subtree.
5221 @orgcmd{r,org-columns-redo}
5222 Recreate the column view, to include recent changes made in the buffer.
5223 @orgcmd{g,org-columns-redo}
5225 @orgcmd{q,org-columns-quit}
5227 @tsubheading{Editing values}
5228 @item @key{left} @key{right} @key{up} @key{down}
5229 Move through the column view from field to field.
5230 @kindex S-@key{left}
5231 @kindex S-@key{right}
5232 @item S-@key{left}/@key{right}
5233 Switch to the next/previous allowed value of the field. For this, you
5234 have to have specified allowed values for a property.
5236 Directly select the Nth allowed value, @kbd{0} selects the 10th value.
5237 @orgcmdkkcc{n,p,org-columns-next-allowed-value,org-columns-previous-allowed-value}
5238 Same as @kbd{S-@key{left}/@key{right}}
5239 @orgcmd{e,org-columns-edit-value}
5240 Edit the property at point. For the special properties, this will
5241 invoke the same interface that you normally use to change that
5242 property. For example, when editing a TAGS property, the tag completion
5243 or fast selection interface will pop up.
5244 @orgcmd{C-c C-c,org-columns-set-tags-or-toggle}
5245 When there is a checkbox at point, toggle it.
5246 @orgcmd{v,org-columns-show-value}
5247 View the full value of this property. This is useful if the width of
5248 the column is smaller than that of the value.
5249 @orgcmd{a,org-columns-edit-allowed}
5250 Edit the list of allowed values for this property. If the list is found
5251 in the hierarchy, the modified values is stored there. If no list is
5252 found, the new value is stored in the first entry that is part of the
5253 current column view.
5254 @tsubheading{Modifying the table structure}
5255 @orgcmdkkcc{<,>,org-columns-narrow,org-columns-widen}
5256 Make the column narrower/wider by one character.
5257 @orgcmd{S-M-@key{right},org-columns-new}
5258 Insert a new column, to the left of the current column.
5259 @orgcmd{S-M-@key{left},org-columns-delete}
5260 Delete the current column.
5263 @node Capturing column view, , Using column view, Column view
5264 @subsection Capturing column view
5266 Since column view is just an overlay over a buffer, it cannot be
5267 exported or printed directly. If you want to capture a column view, use
5268 a @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame
5269 of this block looks like this:
5271 @cindex #+BEGIN, columnview
5274 #+BEGIN: columnview :hlines 1 :id "label"
5279 @noindent This dynamic block has the following parameters:
5283 This is the most important parameter. Column view is a feature that is
5284 often localized to a certain (sub)tree, and the capture block might be
5285 at a different location in the file. To identify the tree whose view to
5286 capture, you can use 4 values:
5287 @cindex property, ID
5289 local @r{use the tree in which the capture block is located}
5290 global @r{make a global view, including all headings in the file}
5291 "file:@var{path-to-file}"
5292 @r{run column view at the top of this file}
5293 "@var{ID}" @r{call column view in the tree that has an @code{:ID:}}
5294 @r{property with the value @i{label}. You can use}
5295 @r{@kbd{M-x org-id-copy} to create a globally unique ID for}
5296 @r{the current entry and copy it to the kill-ring.}
5299 When @code{t}, insert an hline after every line. When a number @var{N}, insert
5300 an hline before each headline with level @code{<= @var{N}}.
5302 When set to @code{t}, force column groups to get vertical lines.
5304 When set to a number, don't capture entries below this level.
5305 @item :skip-empty-rows
5306 When set to @code{t}, skip rows where the only non-empty specifier of the
5307 column view is @code{ITEM}.
5312 The following commands insert or update the dynamic block:
5315 @orgcmd{C-c C-x i,org-insert-columns-dblock}
5316 Insert a dynamic block capturing a column view. You will be prompted
5317 for the scope or ID of the view.
5318 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
5319 Update dynamic block at point. The cursor needs to be in the
5320 @code{#+BEGIN} line of the dynamic block.
5321 @orgcmd{C-u C-c C-x C-u,org-update-all-dblocks}
5322 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
5323 you have several clock table blocks, column-capturing blocks or other dynamic
5327 You can add formulas to the column view table and you may add plotting
5328 instructions in front of the table---these will survive an update of the
5329 block. If there is a @code{#+TBLFM:} after the table, the table will
5330 actually be recalculated automatically after an update.
5332 An alternative way to capture and process property values into a table is
5333 provided by Eric Schulte's @file{org-collector.el} which is a contributed
5334 package@footnote{Contributed packages are not part of Emacs, but are
5335 distributed with the main distribution of Org (visit
5336 @uref{http://orgmode.org}).}. It provides a general API to collect
5337 properties from entries in a certain scope, and arbitrary Lisp expressions to
5338 process these values before inserting them into a table or a dynamic block.
5340 @node Property API, , Column view, Properties and Columns
5341 @section The Property API
5342 @cindex properties, API
5343 @cindex API, for properties
5345 There is a full API for accessing and changing properties. This API can
5346 be used by Emacs Lisp programs to work with properties and to implement
5347 features based on them. For more information see @ref{Using the
5350 @node Dates and Times, Capture - Refile - Archive, Properties and Columns, Top
5351 @chapter Dates and times
5357 To assist project planning, TODO items can be labeled with a date and/or
5358 a time. The specially formatted string carrying the date and time
5359 information is called a @emph{timestamp} in Org mode. This may be a
5360 little confusing because timestamp is often used as indicating when
5361 something was created or last changed. However, in Org mode this term
5362 is used in a much wider sense.
5365 * Timestamps:: Assigning a time to a tree entry
5366 * Creating timestamps:: Commands which insert timestamps
5367 * Deadlines and scheduling:: Planning your work
5368 * Clocking work time:: Tracking how long you spend on a task
5369 * Effort estimates:: Planning work effort in advance
5370 * Relative timer:: Notes with a running timer
5371 * Countdown timer:: Starting a countdown timer for a task
5375 @node Timestamps, Creating timestamps, Dates and Times, Dates and Times
5376 @section Timestamps, deadlines, and scheduling
5378 @cindex ranges, time
5383 A timestamp is a specification of a date (possibly with a time or a range of
5384 times) in a special format, either @samp{<2003-09-16 Tue>}@footnote{In this
5385 simplest form, the day name is optional when you type the date yourself.
5386 However, any dates inserted or modified by Org will add that day name, for
5387 reading convenience.} or @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16
5388 Tue 12:00-12:30>}@footnote{This is inspired by the standard ISO 8601
5389 date/time format. To use an alternative format, see @ref{Custom time
5390 format}.}. A timestamp can appear anywhere in the headline or body of an Org
5391 tree entry. Its presence causes entries to be shown on specific dates in the
5392 agenda (@pxref{Weekly/daily agenda}). We distinguish:
5395 @item Plain timestamp; Event; Appointment
5398 A simple timestamp just assigns a date/time to an item. This is just
5399 like writing down an appointment or event in a paper agenda. In the
5400 timeline and agenda displays, the headline of an entry associated with a
5401 plain timestamp will be shown exactly on that date.
5404 * Meet Peter at the movies <2006-11-01 Wed 19:15>
5405 * Discussion on climate change <2006-11-02 Thu 20:00-22:00>
5408 @item Timestamp with repeater interval
5409 @cindex timestamp, with repeater interval
5410 A timestamp may contain a @emph{repeater interval}, indicating that it
5411 applies not only on the given date, but again and again after a certain
5412 interval of N days (d), weeks (w), months (m), or years (y). The
5413 following will show up in the agenda every Wednesday:
5416 * Pick up Sam at school <2007-05-16 Wed 12:30 +1w>
5419 @item Diary-style sexp entries
5420 For more complex date specifications, Org mode supports using the special
5421 sexp diary entries implemented in the Emacs calendar/diary
5422 package@footnote{When working with the standard diary sexp functions, you
5423 need to be very careful with the order of the arguments. That order depend
5424 evilly on the variable @code{calendar-date-style} (or, for older Emacs
5425 versions, @code{european-calendar-style}). For example, to specify a date
5426 December 12, 2005, the call might look like @code{(diary-date 12 1 2005)} or
5427 @code{(diary-date 1 12 2005)} or @code{(diary-date 2005 12 1)}, depending on
5428 the settings. This has been the source of much confusion. Org mode users
5429 can resort to special versions of these functions like @code{org-date} or
5430 @code{org-anniversary}. These work just like the corresponding @code{diary-}
5431 functions, but with stable ISO order of arguments (year, month, day) wherever
5432 applicable, independent of the value of @code{calendar-date-style}.}. For
5433 example with optional time
5436 * 22:00-23:00 The nerd meeting on every 2nd Thursday of the month
5437 <%%(org-float t 4 2)>
5440 @item Time/Date range
5443 Two timestamps connected by @samp{--} denote a range. The headline
5444 will be shown on the first and last day of the range, and on any dates
5445 that are displayed and fall in the range. Here is an example:
5448 ** Meeting in Amsterdam
5449 <2004-08-23 Mon>--<2004-08-26 Thu>
5452 @item Inactive timestamp
5453 @cindex timestamp, inactive
5454 @cindex inactive timestamp
5455 Just like a plain timestamp, but with square brackets instead of
5456 angular ones. These timestamps are inactive in the sense that they do
5457 @emph{not} trigger an entry to show up in the agenda.
5460 * Gillian comes late for the fifth time [2006-11-01 Wed]
5465 @node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times
5466 @section Creating timestamps
5467 @cindex creating timestamps
5468 @cindex timestamps, creating
5470 For Org mode to recognize timestamps, they need to be in the specific
5471 format. All commands listed below produce timestamps in the correct
5475 @orgcmd{C-c .,org-time-stamp}
5476 Prompt for a date and insert a corresponding timestamp. When the cursor is
5477 at an existing timestamp in the buffer, the command is used to modify this
5478 timestamp instead of inserting a new one. When this command is used twice in
5479 succession, a time range is inserted.
5481 @orgcmd{C-c !,org-time-stamp-inactive}
5482 Like @kbd{C-c .}, but insert an inactive timestamp that will not cause
5489 @vindex org-time-stamp-rounding-minutes
5490 Like @kbd{C-c .} and @kbd{C-c !}, but use the alternative format which
5491 contains date and time. The default time can be rounded to multiples of 5
5492 minutes, see the option @code{org-time-stamp-rounding-minutes}.
5495 Normalize timestamp, insert/fix day name if missing or wrong.
5497 @orgcmd{C-c <,org-date-from-calendar}
5498 Insert a timestamp corresponding to the cursor date in the Calendar.
5500 @orgcmd{C-c >,org-goto-calendar}
5501 Access the Emacs calendar for the current date. If there is a
5502 timestamp in the current line, go to the corresponding date
5505 @orgcmd{C-c C-o,org-open-at-point}
5506 Access the agenda for the date given by the timestamp or -range at
5507 point (@pxref{Weekly/daily agenda}).
5509 @orgcmdkkcc{S-@key{left},S-@key{right},org-timestamp-down-day,org-timestamp-up-day}
5510 Change date at cursor by one day. These key bindings conflict with
5511 shift-selection and related modes (@pxref{Conflicts}).
5513 @orgcmdkkcc{S-@key{up},S-@key{down},org-timestamp-up,org-timestamp-down-down}
5514 Change the item under the cursor in a timestamp. The cursor can be on a
5515 year, month, day, hour or minute. When the timestamp contains a time range
5516 like @samp{15:30-16:30}, modifying the first time will also shift the second,
5517 shifting the time block with constant length. To change the length, modify
5518 the second time. Note that if the cursor is in a headline and not at a
5519 timestamp, these same keys modify the priority of an item.
5520 (@pxref{Priorities}). The key bindings also conflict with shift-selection and
5521 related modes (@pxref{Conflicts}).
5523 @orgcmd{C-c C-y,org-evaluate-time-range}
5524 @cindex evaluate time range
5525 Evaluate a time range by computing the difference between start and end.
5526 With a prefix argument, insert result after the time range (in a table: into
5527 the following column).
5532 * The date/time prompt:: How Org mode helps you entering date and time
5533 * Custom time format:: Making dates look different
5536 @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps
5537 @subsection The date/time prompt
5538 @cindex date, reading in minibuffer
5539 @cindex time, reading in minibuffer
5541 @vindex org-read-date-prefer-future
5542 When Org mode prompts for a date/time, the default is shown in default
5543 date/time format, and the prompt therefore seems to ask for a specific
5544 format. But it will in fact accept any string containing some date and/or
5545 time information, and it is really smart about interpreting your input. You
5546 can, for example, use @kbd{C-y} to paste a (possibly multi-line) string
5547 copied from an email message. Org mode will find whatever information is in
5548 there and derive anything you have not specified from the @emph{default date
5549 and time}. The default is usually the current date and time, but when
5550 modifying an existing timestamp, or when entering the second stamp of a
5551 range, it is taken from the stamp in the buffer. When filling in
5552 information, Org mode assumes that most of the time you will want to enter a
5553 date in the future: if you omit the month/year and the given day/month is
5554 @i{before} today, it will assume that you mean a future date@footnote{See the
5555 variable @code{org-read-date-prefer-future}. You may set that variable to
5556 the symbol @code{time} to even make a time before now shift the date to
5557 tomorrow.}. If the date has been automatically shifted into the future, the
5558 time prompt will show this with @samp{(=>F).}
5560 For example, let's assume that today is @b{June 13, 2006}. Here is how
5561 various inputs will be interpreted, the items filled in by Org mode are
5565 3-2-5 @result{} 2003-02-05
5566 2/5/3 @result{} 2003-02-05
5567 14 @result{} @b{2006}-@b{06}-14
5568 12 @result{} @b{2006}-@b{07}-12
5569 2/5 @result{} @b{2007}-02-05
5570 Fri @result{} nearest Friday (default date or later)
5571 sep 15 @result{} @b{2006}-09-15
5572 feb 15 @result{} @b{2007}-02-15
5573 sep 12 9 @result{} 2009-09-12
5574 12:45 @result{} @b{2006}-@b{06}-@b{13} 12:45
5575 22 sept 0:34 @result{} @b{2006}-09-22 0:34
5576 w4 @result{} ISO week for of the current year @b{2006}
5577 2012 w4 fri @result{} Friday of ISO week 4 in 2012
5578 2012-w04-5 @result{} Same as above
5581 Furthermore you can specify a relative date by giving, as the
5582 @emph{first} thing in the input: a plus/minus sign, a number and a
5583 letter ([dwmy]) to indicate change in days, weeks, months, or years. With a
5584 single plus or minus, the date is always relative to today. With a
5585 double plus or minus, it is relative to the default date. If instead of
5586 a single letter, you use the abbreviation of day name, the date will be
5587 the Nth such day, e.g.@:
5592 +4d @result{} four days from today
5593 +4 @result{} same as above
5594 +2w @result{} two weeks from today
5595 ++5 @result{} five days from default date
5596 +2tue @result{} second Tuesday from now.
5599 @vindex parse-time-months
5600 @vindex parse-time-weekdays
5601 The function understands English month and weekday abbreviations. If
5602 you want to use unabbreviated names and/or other languages, configure
5603 the variables @code{parse-time-months} and @code{parse-time-weekdays}.
5605 @vindex org-read-date-force-compatible-dates
5606 Not all dates can be represented in a given Emacs implementation. By default
5607 Org mode forces dates into the compatibility range 1970--2037 which works on
5608 all Emacs implementations. If you want to use dates outside of this range,
5609 read the docstring of the variable
5610 @code{org-read-date-force-compatible-dates}.
5612 You can specify a time range by giving start and end times or by giving a
5613 start time and a duration (in HH:MM format). Use one or two dash(es) as the
5614 separator in the former case and use '+' as the separator in the latter
5618 11am-1:15pm @result{} 11:00-13:15
5619 11am--1:15pm @result{} same as above
5620 11am+2:15 @result{} same as above
5623 @cindex calendar, for selecting date
5624 @vindex org-popup-calendar-for-date-prompt
5625 Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
5626 you don't need/want the calendar, configure the variable
5627 @code{org-popup-calendar-for-date-prompt}.}. When you exit the date
5628 prompt, either by clicking on a date in the calendar, or by pressing
5629 @key{RET}, the date selected in the calendar will be combined with the
5630 information entered at the prompt. You can control the calendar fully
5631 from the minibuffer:
5638 @kindex S-@key{right}
5639 @kindex S-@key{left}
5640 @kindex S-@key{down}
5642 @kindex M-S-@key{right}
5643 @kindex M-S-@key{left}
5646 @key{RET} @r{Choose date at cursor in calendar.}
5647 mouse-1 @r{Select date by clicking on it.}
5648 S-@key{right}/@key{left} @r{One day forward/backward.}
5649 S-@key{down}/@key{up} @r{One week forward/backward.}
5650 M-S-@key{right}/@key{left} @r{One month forward/backward.}
5651 > / < @r{Scroll calendar forward/backward by one month.}
5652 M-v / C-v @r{Scroll calendar forward/backward by 3 months.}
5655 @vindex org-read-date-display-live
5656 The actions of the date/time prompt may seem complex, but I assure you they
5657 will grow on you, and you will start getting annoyed by pretty much any other
5658 way of entering a date/time out there. To help you understand what is going
5659 on, the current interpretation of your input will be displayed live in the
5660 minibuffer@footnote{If you find this distracting, turn the display of with
5661 @code{org-read-date-display-live}.}.
5663 @node Custom time format, , The date/time prompt, Creating timestamps
5664 @subsection Custom time format
5665 @cindex custom date/time format
5666 @cindex time format, custom
5667 @cindex date format, custom
5669 @vindex org-display-custom-times
5670 @vindex org-time-stamp-custom-formats
5671 Org mode uses the standard ISO notation for dates and times as it is
5672 defined in ISO 8601. If you cannot get used to this and require another
5673 representation of date and time to keep you happy, you can get it by
5674 customizing the variables @code{org-display-custom-times} and
5675 @code{org-time-stamp-custom-formats}.
5678 @orgcmd{C-c C-x C-t,org-toggle-time-stamp-overlays}
5679 Toggle the display of custom formats for dates and times.
5683 Org mode needs the default format for scanning, so the custom date/time
5684 format does not @emph{replace} the default format---instead it is put
5685 @emph{over} the default format using text properties. This has the
5686 following consequences:
5689 You cannot place the cursor onto a timestamp anymore, only before or
5692 The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
5693 each component of a timestamp. If the cursor is at the beginning of
5694 the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
5695 just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the
5696 time will be changed by one minute.
5698 If the timestamp contains a range of clock times or a repeater, these
5699 will not be overlaid, but remain in the buffer as they were.
5701 When you delete a timestamp character-by-character, it will only
5702 disappear from the buffer after @emph{all} (invisible) characters
5703 belonging to the ISO timestamp have been removed.
5705 If the custom timestamp format is longer than the default and you are
5706 using dates in tables, table alignment will be messed up. If the custom
5707 format is shorter, things do work as expected.
5711 @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times
5712 @section Deadlines and scheduling
5714 A timestamp may be preceded by special keywords to facilitate planning:
5718 @cindex DEADLINE keyword
5720 Meaning: the task (most likely a TODO item, though not necessarily) is supposed
5721 to be finished on that date.
5723 @vindex org-deadline-warning-days
5724 On the deadline date, the task will be listed in the agenda. In
5725 addition, the agenda for @emph{today} will carry a warning about the
5726 approaching or missed deadline, starting
5727 @code{org-deadline-warning-days} before the due date, and continuing
5728 until the entry is marked DONE. An example:
5731 *** TODO write article about the Earth for the Guide
5732 The editor in charge is [[bbdb:Ford Prefect]]
5733 DEADLINE: <2004-02-29 Sun>
5736 You can specify a different lead time for warnings for a specific
5737 deadlines using the following syntax. Here is an example with a warning
5738 period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}.
5741 @cindex SCHEDULED keyword
5743 Meaning: you are planning to start working on that task on the given
5746 @vindex org-agenda-skip-scheduled-if-done
5747 The headline will be listed under the given date@footnote{It will still
5748 be listed on that date after it has been marked DONE. If you don't like
5749 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In
5750 addition, a reminder that the scheduled date has passed will be present
5751 in the compilation for @emph{today}, until the entry is marked DONE, i.e.@:
5752 the task will automatically be forwarded until completed.
5755 *** TODO Call Trillian for a date on New Years Eve.
5756 SCHEDULED: <2004-12-25 Sat>
5760 @b{Important:} Scheduling an item in Org mode should @i{not} be
5761 understood in the same way that we understand @i{scheduling a meeting}.
5762 Setting a date for a meeting is just a simple appointment, you should
5763 mark this entry with a simple plain timestamp, to get this item shown
5764 on the date where it applies. This is a frequent misunderstanding by
5765 Org users. In Org mode, @i{scheduling} means setting a date when you
5766 want to start working on an action item.
5769 You may use timestamps with repeaters in scheduling and deadline
5770 entries. Org mode will issue early and late warnings based on the
5771 assumption that the timestamp represents the @i{nearest instance} of
5772 the repeater. However, the use of diary sexp entries like
5774 @code{<%%(org-float t 42)>}
5776 in scheduling and deadline timestamps is limited. Org mode does not
5777 know enough about the internals of each sexp function to issue early and
5778 late warnings. However, it will show the item on each day where the
5782 * Inserting deadline/schedule:: Planning items
5783 * Repeated tasks:: Items that show up again and again
5786 @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling
5787 @subsection Inserting deadlines or schedules
5789 The following commands allow you to quickly insert@footnote{The @samp{SCHEDULED} and
5790 @samp{DEADLINE} dates are inserted on the line right below the headline. Don't put
5791 any text between this line and the headline.} a deadline or to schedule
5796 @orgcmd{C-c C-d,org-deadline}
5797 Insert @samp{DEADLINE} keyword along with a stamp. The insertion will happen
5798 in the line directly following the headline. Any CLOSED timestamp will be
5799 removed. When called with a prefix arg, an existing deadline will be removed
5800 from the entry. Depending on the variable @code{org-log-redeadline}@footnote{with corresponding
5801 @code{#+STARTUP} keywords @code{logredeadline}, @code{lognoteredeadline},
5802 and @code{nologredeadline}}, a note will be taken when changing an existing
5805 @orgcmd{C-c C-s,org-schedule}
5806 Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will
5807 happen in the line directly following the headline. Any CLOSED timestamp
5808 will be removed. When called with a prefix argument, remove the scheduling
5809 date from the entry. Depending on the variable
5810 @code{org-log-reschedule}@footnote{with corresponding @code{#+STARTUP}
5811 keywords @code{logreschedule}, @code{lognotereschedule}, and
5812 @code{nologreschedule}}, a note will be taken when changing an existing
5815 @orgcmd{C-c C-x C-k,org-mark-entry-for-agenda-action}
5818 Mark the current entry for agenda action. After you have marked the entry
5819 like this, you can open the agenda or the calendar to find an appropriate
5820 date. With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to
5821 schedule the marked item.
5823 @orgcmd{C-c / d,org-check-deadlines}
5824 @cindex sparse tree, for deadlines
5825 @vindex org-deadline-warning-days
5826 Create a sparse tree with all deadlines that are either past-due, or
5827 which will become due within @code{org-deadline-warning-days}.
5828 With @kbd{C-u} prefix, show all deadlines in the file. With a numeric
5829 prefix, check that many days. For example, @kbd{C-1 C-c / d} shows
5830 all deadlines due tomorrow.
5832 @orgcmd{C-c / b,org-check-before-date}
5833 Sparse tree for deadlines and scheduled items before a given date.
5835 @orgcmd{C-c / a,org-check-after-date}
5836 Sparse tree for deadlines and scheduled items after a given date.
5839 Note that @code{org-schedule} and @code{org-deadline} supports
5840 setting the date by indicating a relative time: e.g. +1d will set
5841 the date to the next day after today, and --1w will set the date
5842 to the previous week before any current timestamp.
5844 @node Repeated tasks, , Inserting deadline/schedule, Deadlines and scheduling
5845 @subsection Repeated tasks
5846 @cindex tasks, repeated
5847 @cindex repeated tasks
5849 Some tasks need to be repeated again and again. Org mode helps to
5850 organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
5851 or plain timestamp. In the following example
5853 ** TODO Pay the rent
5854 DEADLINE: <2005-10-01 Sat +1m>
5857 the @code{+1m} is a repeater; the intended interpretation is that the task
5858 has a deadline on <2005-10-01> and repeats itself every (one) month starting
5859 from that time. If you need both a repeater and a special warning period in
5860 a deadline entry, the repeater should come first and the warning period last:
5861 @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
5863 @vindex org-todo-repeat-to-state
5864 Deadlines and scheduled items produce entries in the agenda when they are
5865 over-due, so it is important to be able to mark such an entry as completed
5866 once you have done so. When you mark a DEADLINE or a SCHEDULE with the TODO
5867 keyword DONE, it will no longer produce entries in the agenda. The problem
5868 with this is, however, that then also the @emph{next} instance of the
5869 repeated entry will not be active. Org mode deals with this in the following
5870 way: When you try to mark such an entry DONE (using @kbd{C-c C-t}), it will
5871 shift the base date of the repeating timestamp by the repeater interval, and
5872 immediately set the entry state back to TODO@footnote{In fact, the target
5873 state is taken from, in this sequence, the @code{REPEAT_TO_STATE} property or
5874 the variable @code{org-todo-repeat-to-state}. If neither of these is
5875 specified, the target state defaults to the first state of the TODO state
5876 sequence.}. In the example above, setting the state to DONE would actually
5877 switch the date like this:
5880 ** TODO Pay the rent
5881 DEADLINE: <2005-11-01 Tue +1m>
5884 @vindex org-log-repeat
5885 A timestamp@footnote{You can change this using the option
5886 @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
5887 @code{lognoterepeat}, and @code{nologrepeat}. With @code{lognoterepeat}, you
5888 will also be prompted for a note.} will be added under the deadline, to keep
5889 a record that you actually acted on the previous instance of this deadline.
5891 As a consequence of shifting the base date, this entry will no longer be
5892 visible in the agenda when checking past dates, but all future instances
5895 With the @samp{+1m} cookie, the date shift will always be exactly one
5896 month. So if you have not paid the rent for three months, marking this
5897 entry DONE will still keep it as an overdue deadline. Depending on the
5898 task, this may not be the best way to handle it. For example, if you
5899 forgot to call your father for 3 weeks, it does not make sense to call
5900 him 3 times in a single day to make up for it. Finally, there are tasks
5901 like changing batteries which should always repeat a certain time
5902 @i{after} the last time you did it. For these tasks, Org mode has
5903 special repeaters @samp{++} and @samp{.+}. For example:
5907 DEADLINE: <2008-02-10 Sun ++1w>
5908 Marking this DONE will shift the date by at least one week,
5909 but also by as many weeks as it takes to get this date into
5910 the future. However, it stays on a Sunday, even if you called
5911 and marked it done on Saturday.
5912 ** TODO Check the batteries in the smoke detectors
5913 DEADLINE: <2005-11-01 Tue .+1m>
5914 Marking this DONE will shift the date to one month after
5918 You may have both scheduling and deadline information for a specific
5919 task---just make sure that the repeater intervals on both are the same.
5921 An alternative to using a repeater is to create a number of copies of a task
5922 subtree, with dates shifted in each copy. The command @kbd{C-c C-x c} was
5923 created for this purpose, it is described in @ref{Structure editing}.
5926 @node Clocking work time, Effort estimates, Deadlines and scheduling, Dates and Times
5927 @section Clocking work time
5928 @cindex clocking time
5929 @cindex time clocking
5931 Org mode allows you to clock the time you spend on specific tasks in a
5932 project. When you start working on an item, you can start the clock. When
5933 you stop working on that task, or when you mark the task done, the clock is
5934 stopped and the corresponding time interval is recorded. It also computes
5935 the total time spent on each subtree@footnote{Clocking only works if all
5936 headings are indented with less than 30 stars. This is a hardcoded
5937 limitation of `lmax' in `org-clock-sum'.} of a project. And it remembers a
5938 history or tasks recently clocked, to that you can jump quickly between a
5939 number of tasks absorbing your time.
5941 To save the clock history across Emacs sessions, use
5943 (setq org-clock-persist 'history)
5944 (org-clock-persistence-insinuate)
5946 When you clock into a new task after resuming Emacs, the incomplete
5947 clock@footnote{To resume the clock under the assumption that you have worked
5948 on this task while outside Emacs, use @code{(setq org-clock-persist t)}.}
5949 will be found (@pxref{Resolving idle time}) and you will be prompted about
5953 * Clocking commands:: Starting and stopping a clock
5954 * The clock table:: Detailed reports
5955 * Resolving idle time:: Resolving time when you've been idle
5958 @node Clocking commands, The clock table, Clocking work time, Clocking work time
5959 @subsection Clocking commands
5962 @orgcmd{C-c C-x C-i,org-clock-in}
5963 @vindex org-clock-into-drawer
5964 @cindex property, LOG_INTO_DRAWER
5965 Start the clock on the current item (clock-in). This inserts the CLOCK
5966 keyword together with a timestamp. If this is not the first clocking of
5967 this item, the multiple CLOCK lines will be wrapped into a
5968 @code{:LOGBOOK:} drawer (see also the variable
5969 @code{org-clock-into-drawer}). You can also overrule
5970 the setting of this variable for a subtree by setting a
5971 @code{CLOCK_INTO_DRAWER} or @code{LOG_INTO_DRAWER} property.
5972 When called with a @kbd{C-u} prefix argument,
5973 select the task from a list of recently clocked tasks. With two @kbd{C-u
5974 C-u} prefixes, clock into the task at point and mark it as the default task.
5975 The default task will always be available when selecting a clocking task,
5976 with letter @kbd{d}.@*
5977 @cindex property: CLOCK_MODELINE_TOTAL
5978 @cindex property: LAST_REPEAT
5979 @vindex org-clock-modeline-total
5980 While the clock is running, the current clocking time is shown in the mode
5981 line, along with the title of the task. The clock time shown will be all
5982 time ever clocked for this task and its children. If the task has an effort
5983 estimate (@pxref{Effort estimates}), the mode line displays the current
5984 clocking time against it@footnote{To add an effort estimate ``on the fly'',
5985 hook a function doing this to @code{org-clock-in-prepare-hook}.} If the task
5986 is a repeating one (@pxref{Repeated tasks}), only the time since the last
5987 reset of the task @footnote{as recorded by the @code{LAST_REPEAT} property}
5988 will be shown. More control over what time is shown can be exercised with
5989 the @code{CLOCK_MODELINE_TOTAL} property. It may have the values
5990 @code{current} to show only the current clocking instance, @code{today} to
5991 show all time clocked on this tasks today (see also the variable
5992 @code{org-extend-today-until}), @code{all} to include all time, or
5993 @code{auto} which is the default@footnote{See also the variable
5994 @code{org-clock-modeline-total}.}.@* Clicking with @kbd{mouse-1} onto the
5995 mode line entry will pop up a menu with clocking options.
5997 @orgcmd{C-c C-x C-o,org-clock-out}
5998 @vindex org-log-note-clock-out
5999 Stop the clock (clock-out). This inserts another timestamp at the same
6000 location where the clock was last started. It also directly computes
6001 the resulting time in inserts it after the time range as @samp{=>
6002 HH:MM}. See the variable @code{org-log-note-clock-out} for the
6003 possibility to record an additional note together with the clock-out
6004 timestamp@footnote{The corresponding in-buffer setting is:
6005 @code{#+STARTUP: lognoteclock-out}}.
6006 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6007 Update the effort estimate for the current clock task.
6010 @orgcmdkkc{C-c C-c,C-c C-y,org-evaluate-time-range}
6011 Recompute the time interval after changing one of the timestamps. This
6012 is only necessary if you edit the timestamps directly. If you change
6013 them with @kbd{S-@key{cursor}} keys, the update is automatic.
6014 @orgcmd{C-S-@key{up/down},org-clock-timestamps-up/down}
6015 On @code{CLOCK} log lines, increase/decrease both timestamps at the same
6016 time so that duration keeps the same.
6017 @orgcmd{C-c C-t,org-todo}
6018 Changing the TODO state of an item to DONE automatically stops the clock
6019 if it is running in this same item.
6020 @orgcmd{C-c C-x C-x,org-clock-cancel}
6021 Cancel the current clock. This is useful if a clock was started by
6022 mistake, or if you ended up working on something else.
6023 @orgcmd{C-c C-x C-j,org-clock-goto}
6024 Jump to the headline of the currently clocked in task. With a @kbd{C-u}
6025 prefix arg, select the target task from a list of recently clocked tasks.
6026 @orgcmd{C-c C-x C-d,org-clock-display}
6027 @vindex org-remove-highlights-with-change
6028 Display time summaries for each subtree in the current buffer. This puts
6029 overlays at the end of each headline, showing the total time recorded under
6030 that heading, including the time of any subheadings. You can use visibility
6031 cycling to study the tree, but the overlays disappear when you change the
6032 buffer (see variable @code{org-remove-highlights-with-change}) or press
6036 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
6037 the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
6038 worked on or closed during a day.
6040 @node The clock table, Resolving idle time, Clocking commands, Clocking work time
6041 @subsection The clock table
6042 @cindex clocktable, dynamic block
6043 @cindex report, of clocked time
6045 Org mode can produce quite complex reports based on the time clocking
6046 information. Such a report is called a @emph{clock table}, because it is
6047 formatted as one or several Org tables.
6050 @orgcmd{C-c C-x C-r,org-clock-report}
6051 Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
6052 report as an Org mode table into the current file. When the cursor is
6053 at an existing clock table, just update it. When called with a prefix
6054 argument, jump to the first clock report in the current document and
6055 update it. The clock table always includes also trees with
6056 @code{:ARCHIVE:} tag.
6057 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
6058 Update dynamic block at point. The cursor needs to be in the
6059 @code{#+BEGIN} line of the dynamic block.
6060 @orgkey{C-u C-c C-x C-u}
6061 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
6062 you have several clock table blocks in a buffer.
6063 @orgcmdkxkc{S-@key{left},S-@key{right},org-clocktable-try-shift}
6064 Shift the current @code{:block} interval and update the table. The cursor
6065 needs to be in the @code{#+BEGIN: clocktable} line for this command. If
6066 @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
6070 Here is an example of the frame for a clock table as it is inserted into the
6071 buffer with the @kbd{C-c C-x C-r} command:
6073 @cindex #+BEGIN, clocktable
6075 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
6079 @vindex org-clocktable-defaults
6080 The @samp{BEGIN} line and specify a number of options to define the scope,
6081 structure, and formatting of the report. Defaults for all these options can
6082 be configured in the variable @code{org-clocktable-defaults}.
6084 @noindent First there are options that determine which clock entries are to
6087 :maxlevel @r{Maximum level depth to which times are listed in the table.}
6088 @r{Clocks at deeper levels will be summed into the upper level.}
6089 :scope @r{The scope to consider. This can be any of the following:}
6090 nil @r{the current buffer or narrowed region}
6091 file @r{the full current buffer}
6092 subtree @r{the subtree where the clocktable is located}
6093 tree@var{N} @r{the surrounding level @var{N} tree, for example @code{tree3}}
6094 tree @r{the surrounding level 1 tree}
6095 agenda @r{all agenda files}
6096 ("file"..) @r{scan these files}
6097 file-with-archives @r{current file and its archives}
6098 agenda-with-archives @r{all agenda files, including archives}
6099 :block @r{The time block to consider. This block is specified either}
6100 @r{absolute, or relative to the current time and may be any of}
6102 2007-12-31 @r{New year eve 2007}
6103 2007-12 @r{December 2007}
6104 2007-W50 @r{ISO-week 50 in 2007}
6105 2007-Q2 @r{2nd quarter in 2007}
6106 2007 @r{the year 2007}
6107 today, yesterday, today-@var{N} @r{a relative day}
6108 thisweek, lastweek, thisweek-@var{N} @r{a relative week}
6109 thismonth, lastmonth, thismonth-@var{N} @r{a relative month}
6110 thisyear, lastyear, thisyear-@var{N} @r{a relative year}
6111 @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
6112 :tstart @r{A time string specifying when to start considering times.}
6113 :tend @r{A time string specifying when to stop considering times.}
6114 :step @r{@code{week} or @code{day}, to split the table into chunks.}
6115 @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
6116 :stepskip0 @r{Do not show steps that have zero time.}
6117 :fileskip0 @r{Do not show table sections from files which did not contribute.}
6118 :tags @r{A tags match to select entries that should contribute. See}
6119 @r{@ref{Matching tags and properties} for the match syntax.}
6122 Then there are options which determine the formatting of the table. There
6123 options are interpreted by the function @code{org-clocktable-write-default},
6124 but you can specify your own function using the @code{:formatter} parameter.
6126 :emphasize @r{When @code{t}, emphasize level one and level two items.}
6127 :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".}
6128 :link @r{Link the item headlines in the table to their origins.}
6129 :narrow @r{An integer to limit the width of the headline column in}
6130 @r{the org table. If you write it like @samp{50!}, then the}
6131 @r{headline will also be shortened in export.}
6132 :indent @r{Indent each headline field according to its level.}
6133 :tcolumns @r{Number of columns to be used for times. If this is smaller}
6134 @r{than @code{:maxlevel}, lower levels will be lumped into one column.}
6135 :level @r{Should a level number column be included?}
6136 :compact @r{Abbreviation for @code{:level nil :indent t :narrow 40! :tcolumns 1}}
6137 @r{All are overwritten except if there is an explicit @code{:narrow}}
6138 :timestamp @r{A timestamp for the entry, when available. Look for SCHEDULED,}
6139 @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.}
6140 :properties @r{List of properties that should be shown in the table. Each}
6141 @r{property will get its own column.}
6142 :inherit-props @r{When this flag is @code{t}, the values for @code{:properties} will be inherited.}
6143 :formula @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
6144 @r{As a special case, @samp{:formula %} adds a column with % time.}
6145 @r{If you do not specify a formula here, any existing formula}
6146 @r{below the clock table will survive updates and be evaluated.}
6147 :formatter @r{A function to format clock data and insert it into the buffer.}
6149 To get a clock summary of the current level 1 tree, for the current
6150 day, you could write
6152 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
6156 and to use a specific time range you could write@footnote{Note that all
6157 parameters must be specified in a single line---the line is broken here
6158 only to fit it into the manual.}
6160 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
6161 :tend "<2006-08-10 Thu 12:00>"
6164 A summary of the current subtree with % times would be
6166 #+BEGIN: clocktable :scope subtree :link t :formula %
6169 A horizontally compact representation of everything clocked during last week
6172 #+BEGIN: clocktable :scope agenda :block lastweek :compact t
6176 @node Resolving idle time, , The clock table, Clocking work time
6177 @subsection Resolving idle time
6178 @cindex resolve idle time
6180 @cindex idle, resolve, dangling
6181 If you clock in on a work item, and then walk away from your
6182 computer---perhaps to take a phone call---you often need to ``resolve'' the
6183 time you were away by either subtracting it from the current clock, or
6184 applying it to another one.
6186 @vindex org-clock-idle-time
6187 By customizing the variable @code{org-clock-idle-time} to some integer, such
6188 as 10 or 15, Emacs can alert you when you get back to your computer after
6189 being idle for that many minutes@footnote{On computers using Mac OS X,
6190 idleness is based on actual user idleness, not just Emacs' idle time. For
6191 X11, you can install a utility program @file{x11idle.c}, available in the
6192 UTILITIES directory of the Org git distribution, to get the same general
6193 treatment of idleness. On other systems, idle time refers to Emacs idle time
6194 only.}, and ask what you want to do with the idle time. There will be a
6195 question waiting for you when you get back, indicating how much idle time has
6196 passed (constantly updated with the current amount), as well as a set of
6197 choices to correct the discrepancy:
6201 To keep some or all of the minutes and stay clocked in, press @kbd{k}. Org
6202 will ask how many of the minutes to keep. Press @key{RET} to keep them all,
6203 effectively changing nothing, or enter a number to keep that many minutes.
6205 If you use the shift key and press @kbd{K}, it will keep however many minutes
6206 you request and then immediately clock out of that task. If you keep all of
6207 the minutes, this is the same as just clocking out of the current task.
6209 To keep none of the minutes, use @kbd{s} to subtract all the away time from
6210 the clock, and then check back in from the moment you returned.
6212 To keep none of the minutes and just clock out at the start of the away time,
6213 use the shift key and press @kbd{S}. Remember that using shift will always
6214 leave you clocked out, no matter which option you choose.
6216 To cancel the clock altogether, use @kbd{C}. Note that if instead of
6217 canceling you subtract the away time, and the resulting clock amount is less
6218 than a minute, the clock will still be canceled rather than clutter up the
6219 log with an empty entry.
6222 What if you subtracted those away minutes from the current clock, and now
6223 want to apply them to a new clock? Simply clock in to any task immediately
6224 after the subtraction. Org will notice that you have subtracted time ``on
6225 the books'', so to speak, and will ask if you want to apply those minutes to
6226 the next task you clock in on.
6228 There is one other instance when this clock resolution magic occurs. Say you
6229 were clocked in and hacking away, and suddenly your cat chased a mouse who
6230 scared a hamster that crashed into your UPS's power button! You suddenly
6231 lose all your buffers, but thanks to auto-save you still have your recent Org
6232 mode changes, including your last clock in.
6234 If you restart Emacs and clock into any task, Org will notice that you have a
6235 dangling clock which was never clocked out from your last session. Using
6236 that clock's starting time as the beginning of the unaccounted-for period,
6237 Org will ask how you want to resolve that time. The logic and behavior is
6238 identical to dealing with away time due to idleness; it is just happening due
6239 to a recovery event rather than a set amount of idle time.
6241 You can also check all the files visited by your Org agenda for dangling
6242 clocks at any time using @kbd{M-x org-resolve-clocks}.
6244 @node Effort estimates, Relative timer, Clocking work time, Dates and Times
6245 @section Effort estimates
6246 @cindex effort estimates
6248 @cindex property, Effort
6249 @vindex org-effort-property
6250 If you want to plan your work in a very detailed way, or if you need to
6251 produce offers with quotations of the estimated work effort, you may want to
6252 assign effort estimates to entries. If you are also clocking your work, you
6253 may later want to compare the planned effort with the actual working time, a
6254 great way to improve planning estimates. Effort estimates are stored in a
6255 special property @samp{Effort}@footnote{You may change the property being
6256 used with the variable @code{org-effort-property}.}. You can set the effort
6257 for an entry with the following commands:
6260 @orgcmd{C-c C-x e,org-set-effort}
6261 Set the effort estimate for the current entry. With a numeric prefix
6262 argument, set it to the Nth allowed value (see below). This command is also
6263 accessible from the agenda with the @kbd{e} key.
6264 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6265 Modify the effort estimate of the item currently being clocked.
6268 Clearly the best way to work with effort estimates is through column view
6269 (@pxref{Column view}). You should start by setting up discrete values for
6270 effort estimates, and a @code{COLUMNS} format that displays these values
6271 together with clock sums (if you want to clock your time). For a specific
6275 #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00
6276 #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
6280 @vindex org-global-properties
6281 @vindex org-columns-default-format
6282 or, even better, you can set up these values globally by customizing the
6283 variables @code{org-global-properties} and @code{org-columns-default-format}.
6284 In particular if you want to use this setup also in the agenda, a global
6285 setup may be advised.
6287 The way to assign estimates to individual items is then to switch to column
6288 mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
6289 value. The values you enter will immediately be summed up in the hierarchy.
6290 In the column next to it, any clocked time will be displayed.
6292 @vindex org-agenda-columns-add-appointments-to-effort-sum
6293 If you switch to column view in the daily/weekly agenda, the effort column
6294 will summarize the estimated work effort for each day@footnote{Please note
6295 the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
6296 column view}).}, and you can use this to find space in your schedule. To get
6297 an overview of the entire part of the day that is committed, you can set the
6298 option @code{org-agenda-columns-add-appointments-to-effort-sum}. The
6299 appointments on a day that take place over a specified time interval will
6300 then also be added to the load estimate of the day.
6302 Effort estimates can be used in secondary agenda filtering that is triggered
6303 with the @kbd{/} key in the agenda (@pxref{Agenda commands}). If you have
6304 these estimates defined consistently, two or three key presses will narrow
6305 down the list to stuff that fits into an available time slot.
6307 @node Relative timer, Countdown timer, Effort estimates, Dates and Times
6308 @section Taking notes with a relative timer
6309 @cindex relative timer
6311 When taking notes during, for example, a meeting or a video viewing, it can
6312 be useful to have access to times relative to a starting time. Org provides
6313 such a relative timer and make it easy to create timed notes.
6316 @orgcmd{C-c C-x .,org-timer}
6317 Insert a relative time into the buffer. The first time you use this, the
6318 timer will be started. When called with a prefix argument, the timer is
6320 @orgcmd{C-c C-x -,org-timer-item}
6321 Insert a description list item with the current relative time. With a prefix
6322 argument, first reset the timer to 0.
6323 @orgcmd{M-@key{RET},org-insert-heading}
6324 Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
6326 @c for key sequences with a comma, command name macros fail :(
6329 Pause the timer, or continue it if it is already paused
6330 (@command{org-timer-pause-or-continue}).
6331 @c removed the sentence because it is redundant to the following item
6332 @kindex C-u C-c C-x ,
6334 Stop the timer. After this, you can only start a new timer, not continue the
6335 old one. This command also removes the timer from the mode line.
6336 @orgcmd{C-c C-x 0,org-timer-start}
6337 Reset the timer without inserting anything into the buffer. By default, the
6338 timer is reset to 0. When called with a @kbd{C-u} prefix, reset the timer to
6339 specific starting offset. The user is prompted for the offset, with a
6340 default taken from a timer string at point, if any, So this can be used to
6341 restart taking notes after a break in the process. When called with a double
6342 prefix argument @kbd{C-u C-u}, change all timer strings in the active region
6343 by a certain amount. This can be used to fix timer strings if the timer was
6344 not started at exactly the right moment.
6347 @node Countdown timer, , Relative timer, Dates and Times
6348 @section Countdown timer
6349 @cindex Countdown timer
6353 Calling @code{org-timer-set-timer} from an Org mode buffer runs a countdown
6354 timer. Use @kbd{;} from agenda buffers, @key{C-c C-x ;} everywhere else.
6356 @code{org-timer-set-timer} prompts the user for a duration and displays a
6357 countdown timer in the modeline. @code{org-timer-default-timer} sets the
6358 default countdown value. Giving a prefix numeric argument overrides this
6361 @node Capture - Refile - Archive, Agenda Views, Dates and Times, Top
6362 @chapter Capture - Refile - Archive
6365 An important part of any organization system is the ability to quickly
6366 capture new ideas and tasks, and to associate reference material with them.
6367 Org does this using a process called @i{capture}. It also can store files
6368 related to a task (@i{attachments}) in a special directory. Once in the
6369 system, tasks and projects need to be moved around. Moving completed project
6370 trees to an archive file keeps the system compact and fast.
6373 * Capture:: Capturing new stuff
6374 * Attachments:: Add files to tasks
6375 * RSS Feeds:: Getting input from RSS feeds
6376 * Protocols:: External (e.g.@: Browser) access to Emacs and Org
6377 * Refiling notes:: Moving a tree from one place to another
6378 * Archiving:: What to do with finished projects
6381 @node Capture, Attachments, Capture - Refile - Archive, Capture - Refile - Archive
6385 Org's method for capturing new items is heavily inspired by John Wiegley
6386 excellent remember package. Up to version 6.36 Org used a special setup
6387 for @file{remember.el}. @file{org-remember.el} is still part of Org mode for
6388 backward compatibility with existing setups. You can find the documentation
6389 for org-remember at @url{http://orgmode.org/org-remember.pdf}.
6391 The new capturing setup described here is preferred and should be used by new
6392 users. To convert your @code{org-remember-templates}, run the command
6394 @kbd{M-x org-capture-import-remember-templates @key{RET}}
6396 @noindent and then customize the new variable with @kbd{M-x
6397 customize-variable org-capture-templates}, check the result, and save the
6398 customization. You can then use both remember and capture until
6399 you are familiar with the new mechanism.
6401 Capture lets you quickly store notes with little interruption of your work
6402 flow. The basic process of capturing is very similar to remember, but Org
6403 does enhance it with templates and more.
6406 * Setting up capture:: Where notes will be stored
6407 * Using capture:: Commands to invoke and terminate capture
6408 * Capture templates:: Define the outline of different note types
6411 @node Setting up capture, Using capture, Capture, Capture
6412 @subsection Setting up capture
6414 The following customization sets a default target file for notes, and defines
6415 a global key@footnote{Please select your own key, @kbd{C-c c} is only a
6416 suggestion.} for capturing new material.
6418 @vindex org-default-notes-file
6420 (setq org-default-notes-file (concat org-directory "/notes.org"))
6421 (define-key global-map "\C-cc" 'org-capture)
6424 @node Using capture, Capture templates, Setting up capture, Capture
6425 @subsection Using capture
6428 @orgcmd{C-c c,org-capture}
6429 Call the command @code{org-capture}. Note that this keybinding is global and
6430 not active by default - you need to install it. If you have templates
6432 defined @pxref{Capture templates}, it will offer these templates for
6433 selection or use a new Org outline node as the default template. It will
6434 insert the template into the target file and switch to an indirect buffer
6435 narrowed to this new node. You may then insert the information you want.
6437 @orgcmd{C-c C-c,org-capture-finalize}
6438 Once you have finished entering information into the capture buffer, @kbd{C-c
6439 C-c} will return you to the window configuration before the capture process,
6440 so that you can resume your work without further distraction. When called
6441 with a prefix arg, finalize and then jump to the captured item.
6443 @orgcmd{C-c C-w,org-capture-refile}
6444 Finalize the capture process by refiling (@pxref{Refiling notes}) the note to
6445 a different place. Please realize that this is a normal refiling command
6446 that will be executed---so the cursor position at the moment you run this
6447 command is important. If you have inserted a tree with a parent and
6448 children, first move the cursor back to the parent. Any prefix argument
6449 given to this command will be passed on to the @code{org-refile} command.
6451 @orgcmd{C-c C-k,org-capture-kill}
6452 Abort the capture process and return to the previous state.
6456 You can also call @code{org-capture} in a special way from the agenda, using
6457 the @kbd{k c} key combination. With this access, any timestamps inserted by
6458 the selected capture template will default to the cursor date in the agenda,
6459 rather than to the current date.
6461 To find the locations of the last stored capture, use @code{org-capture} with
6466 Visit the target location of a capture template. You get to select the
6467 template in the usual way.
6468 @orgkey{C-u C-u C-c c}
6469 Visit the last stored capture item in its buffer.
6472 @node Capture templates, , Using capture, Capture
6473 @subsection Capture templates
6474 @cindex templates, for Capture
6476 You can use templates for different types of capture items, and
6477 for different target locations. The easiest way to create such templates is
6478 through the customize interface.
6482 Customize the variable @code{org-capture-templates}.
6485 Before we give the formal description of template definitions, let's look at
6486 an example. Say you would like to use one template to create general TODO
6487 entries, and you want to put these entries under the heading @samp{Tasks} in
6488 your file @file{~/org/gtd.org}. Also, a date tree in the file
6489 @file{journal.org} should capture journal entries. A possible configuration
6493 (setq org-capture-templates
6494 '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks")
6495 "* TODO %?\n %i\n %a")
6496 ("j" "Journal" entry (file+datetree "~/org/journal.org")
6497 "* %?\nEntered on %U\n %i\n %a")))
6500 @noindent If you then press @kbd{C-c c t}, Org will prepare the template
6504 [[file:@var{link to where you initiated capture}]]
6508 During expansion of the template, @code{%a} has been replaced by a link to
6509 the location from where you called the capture command. This can be
6510 extremely useful for deriving tasks from emails, for example. You fill in
6511 the task definition, press @code{C-c C-c} and Org returns you to the same
6512 place where you started the capture process.
6514 To define special keys to capture to a particular template without going
6515 through the interactive template selection, you can create your key binding
6519 (define-key global-map "\C-cx"
6520 (lambda () (interactive) (org-capture nil "x")))
6524 * Template elements:: What is needed for a complete template entry
6525 * Template expansion:: Filling in information about time and context
6528 @node Template elements, Template expansion, Capture templates, Capture templates
6529 @subsubsection Template elements
6531 Now lets look at the elements of a template definition. Each entry in
6532 @code{org-capture-templates} is a list with the following items:
6536 The keys that will select the template, as a string, characters
6537 only, for example @code{"a"} for a template to be selected with a
6538 single key, or @code{"bt"} for selection with two keys. When using
6539 several keys, keys using the same prefix key must be sequential
6540 in the list and preceded by a 2-element entry explaining the
6541 prefix key, for example
6543 ("b" "Templates for marking stuff to buy")
6545 @noindent If you do not define a template for the @kbd{C} key, this key will
6546 be used to open the customize buffer for this complex variable.
6549 A short string describing the template, which will be shown during
6553 The type of entry, a symbol. Valid values are:
6556 An Org mode node, with a headline. Will be filed as the child of the target
6557 entry or as a top-level entry. The target file should be an Org mode file.
6559 A plain list item, placed in the first plain list at the target
6560 location. Again the target file should be an Org file.
6562 A checkbox item. This only differs from the plain list item by the
6565 a new line in the first table at the target location. Where exactly the
6566 line will be inserted depends on the properties @code{:prepend} and
6567 @code{:table-line-pos} (see below).
6569 Text to be inserted as it is.
6573 @vindex org-default-notes-file
6574 Specification of where the captured item should be placed. In Org mode
6575 files, targets usually define a node. Entries will become children of this
6576 node. Other types will be added to the table or list in the body of this
6577 node. Most target specifications contain a file name. If that file name is
6578 the empty string, it defaults to @code{org-default-notes-file}. A file can
6579 also be given as a variable, function, or Emacs Lisp form.
6583 @item (file "path/to/file")
6584 Text will be placed at the beginning or end of that file.
6586 @item (id "id of existing org entry")
6587 Filing as child of this entry, or in the body of the entry.
6589 @item (file+headline "path/to/file" "node headline")
6590 Fast configuration if the target heading is unique in the file.
6592 @item (file+olp "path/to/file" "Level 1 heading" "Level 2" ...)
6593 For non-unique headings, the full path is safer.
6595 @item (file+regexp "path/to/file" "regexp to find location")
6596 Use a regular expression to position the cursor.
6598 @item (file+datetree "path/to/file")
6599 Will create a heading in a date tree for today's date.
6601 @item (file+datetree+prompt "path/to/file")
6602 Will create a heading in a date tree, but will prompt for the date.
6604 @item (file+function "path/to/file" function-finding-location)
6605 A function to find the right location in the file.
6608 File to the entry that is currently being clocked.
6610 @item (function function-finding-location)
6611 Most general way, write your own function to find both
6616 The template for creating the capture item. If you leave this empty, an
6617 appropriate default template will be used. Otherwise this is a string with
6618 escape codes, which will be replaced depending on time and context of the
6619 capture call. The string with escapes may be loaded from a template file,
6620 using the special syntax @code{(file "path/to/template")}. See below for
6624 The rest of the entry is a property list of additional options.
6625 Recognized properties are:
6628 Normally new captured information will be appended at
6629 the target location (last child, last table line, last list item...).
6630 Setting this property will change that.
6632 @item :immediate-finish
6633 When set, do not offer to edit the information, just
6634 file it away immediately. This makes sense if the template only needs
6635 information that can be added automatically.
6638 Set this to the number of lines to insert
6639 before and after the new item. Default 0, only common other value is 1.
6642 Start the clock in this item.
6645 Keep the clock running when filing the captured entry.
6648 If starting the capture interrupted a clock, restart that clock when finished
6649 with the capture. Note that @code{:clock-keep} has precedence over
6650 @code{:clock-resume}. When setting both to @code{t}, the current clock will
6651 run and the previous one will not be resumed.
6654 Do not narrow the target buffer, simply show the full buffer. Default is to
6655 narrow it so that you only see the new material.
6657 @item :table-line-pos
6658 Specification of the location in the table where the new line should be
6659 inserted. It should be a string like @code{"II-3"} meaning that the new
6660 line should become the third line before the second horizontal separator
6664 If the target file was not yet visited when capture was invoked, kill the
6665 buffer again after capture is completed.
6669 @node Template expansion, , Template elements, Capture templates
6670 @subsubsection Template expansion
6672 In the template itself, special @kbd{%}-escapes@footnote{If you need one of
6673 these sequences literally, escape the @kbd{%} with a backslash.} allow
6674 dynamic insertion of content. The templates are expanded in the order given here:
6677 %[@var{file}] @r{insert the contents of the file given by @var{file}.}
6678 %(@var{sexp}) @r{evaluate Elisp @var{sexp} and replace with the result.}
6679 %<...> @r{the result of format-time-string on the ... format specification.}
6680 %t @r{timestamp, date only.}
6681 %T @r{timestamp with date and time.}
6682 %u, %U @r{like the above, but inactive timestamps.}
6683 %a @r{annotation, normally the link created with @code{org-store-link}.}
6684 %i @r{initial content, the region when capture is called while the}
6685 @r{region is active.}
6686 @r{The entire text will be indented like @code{%i} itself.}
6687 %A @r{like @code{%a}, but prompt for the description part.}
6688 %c @r{Current kill ring head.}
6689 %x @r{Content of the X clipboard.}
6690 %k @r{title of the currently clocked task.}
6691 %K @r{link to the currently clocked task.}
6692 %n @r{user name (taken from @code{user-full-name}).}
6693 %f @r{file visited by current buffer when org-capture was called.}
6694 %F @r{full path of the file or directory visited by current buffer.}
6695 %:keyword @r{specific information for certain link types, see below.}
6696 %^g @r{prompt for tags, with completion on tags in target file.}
6697 %^G @r{prompt for tags, with completion all tags in all agenda files.}
6698 %^t @r{like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}.}
6699 @r{You may define a prompt like @code{%^@{Birthday@}t}.}
6700 %^C @r{Interactive selection of which kill or clip to use.}
6701 %^L @r{Like @code{%^C}, but insert as link.}
6702 %^@{@var{prop}@}p @r{Prompt the user for a value for property @var{prop}.}
6703 %^@{@var{prompt}@} @r{prompt the user for a string and replace this sequence with it.}
6704 @r{You may specify a default value and a completion table with}
6705 @r{%^@{prompt|default|completion2|completion3...@}.}
6706 @r{The arrow keys access a prompt-specific history.}
6710 For specific link types, the following keywords will be
6711 defined@footnote{If you define your own link types (@pxref{Adding
6712 hyperlink types}), any property you store with
6713 @code{org-store-link-props} can be accessed in capture templates in a
6716 @vindex org-from-is-user-regexp
6718 Link type | Available keywords
6719 ---------------------------------+----------------------------------------------
6720 bbdb | %:name %:company
6721 irc | %:server %:port %:nick
6722 vm, vm-imap, wl, mh, mew, rmail | %:type %:subject %:message-id
6723 | %:from %:fromname %:fromaddress
6724 | %:to %:toname %:toaddress
6725 | %:date @r{(message date header field)}
6726 | %:date-timestamp @r{(date as active timestamp)}
6727 | %:date-timestamp-inactive @r{(date as inactive timestamp)}
6728 | %: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}.}}
6729 gnus | %:group, @r{for messages also all email fields}
6731 info | %:file %:node
6736 To place the cursor after template expansion use:
6739 %? @r{After completing the template, position cursor here.}
6743 @node Attachments, RSS Feeds, Capture, Capture - Refile - Archive
6744 @section Attachments
6747 @vindex org-attach-directory
6748 It is often useful to associate reference material with an outline node/task.
6749 Small chunks of plain text can simply be stored in the subtree of a project.
6750 Hyperlinks (@pxref{Hyperlinks}) can establish associations with
6751 files that live elsewhere on your computer or in the cloud, like emails or
6752 source code files belonging to a project. Another method is @i{attachments},
6753 which are files located in a directory belonging to an outline node. Org
6754 uses directories named by the unique ID of each entry. These directories are
6755 located in the @file{data} directory which lives in the same directory where
6756 your Org file lives@footnote{If you move entries or Org files from one
6757 directory to another, you may want to configure @code{org-attach-directory}
6758 to contain an absolute path.}. If you initialize this directory with
6759 @code{git init}, Org will automatically commit changes when it sees them.
6760 The attachment system has been contributed to Org by John Wiegley.
6762 In cases where it seems better to do so, you can also attach a directory of your
6763 choice to an entry. You can also make children inherit the attachment
6764 directory from a parent, so that an entire subtree uses the same attached
6767 @noindent The following commands deal with attachments:
6771 @orgcmd{C-c C-a,org-attach}
6772 The dispatcher for commands related to the attachment system. After these
6773 keys, a list of commands is displayed and you must press an additional key
6774 to select a command:
6777 @orgcmdtkc{a,C-c C-a a,org-attach-attach}
6778 @vindex org-attach-method
6779 Select a file and move it into the task's attachment directory. The file
6780 will be copied, moved, or linked, depending on @code{org-attach-method}.
6781 Note that hard links are not supported on all systems.
6787 Attach a file using the copy/move/link method.
6788 Note that hard links are not supported on all systems.
6790 @orgcmdtkc{n,C-c C-a n,org-attach-new}
6791 Create a new attachment as an Emacs buffer.
6793 @orgcmdtkc{z,C-c C-a z,org-attach-sync}
6794 Synchronize the current task with its attachment directory, in case you added
6795 attachments yourself.
6797 @orgcmdtkc{o,C-c C-a o,org-attach-open}
6798 @vindex org-file-apps
6799 Open current task's attachment. If there is more than one, prompt for a
6800 file name first. Opening will follow the rules set by @code{org-file-apps}.
6801 For more details, see the information on following hyperlinks
6802 (@pxref{Handling links}).
6804 @orgcmdtkc{O,C-c C-a O,org-attach-open-in-emacs}
6805 Also open the attachment, but force opening the file in Emacs.
6807 @orgcmdtkc{f,C-c C-a f,org-attach-reveal}
6808 Open the current task's attachment directory.
6810 @orgcmdtkc{F,C-c C-a F,org-attach-reveal-in-emacs}
6811 Also open the directory, but force using @command{dired} in Emacs.
6813 @orgcmdtkc{d,C-c C-a d,org-attach-delete-one}
6814 Select and delete a single attachment.
6816 @orgcmdtkc{D,C-c C-a D,org-attach-delete-all}
6817 Delete all of a task's attachments. A safer way is to open the directory in
6818 @command{dired} and delete from there.
6820 @orgcmdtkc{s,C-c C-a s,org-attach-set-directory}
6821 @cindex property, ATTACH_DIR
6822 Set a specific directory as the entry's attachment directory. This works by
6823 putting the directory path into the @code{ATTACH_DIR} property.
6825 @orgcmdtkc{i,C-c C-a i,org-attach-set-inherit}
6826 @cindex property, ATTACH_DIR_INHERIT
6827 Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
6828 same directory for attachments as the parent does.
6832 @node RSS Feeds, Protocols, Attachments, Capture - Refile - Archive
6837 Org can add and change entries based on information found in RSS feeds and
6838 Atom feeds. You could use this to make a task out of each new podcast in a
6839 podcast feed. Or you could use a phone-based note-creating service on the
6840 web to import tasks into Org. To access feeds, configure the variable
6841 @code{org-feed-alist}. The docstring of this variable has detailed
6842 information. Here is just an example:
6845 (setq org-feed-alist
6847 "http://rss.slashdot.org/Slashdot/slashdot"
6848 "~/txt/org/feeds.org" "Slashdot Entries")))
6852 will configure that new items from the feed provided by
6853 @code{rss.slashdot.org} will result in new entries in the file
6854 @file{~/org/feeds.org} under the heading @samp{Slashdot Entries}, whenever
6855 the following command is used:
6858 @orgcmd{C-c C-x g,org-feed-update-all}
6860 Collect items from the feeds configured in @code{org-feed-alist} and act upon
6862 @orgcmd{C-c C-x G,org-feed-goto-inbox}
6863 Prompt for a feed name and go to the inbox configured for this feed.
6866 Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which
6867 it will store information about the status of items in the feed, to avoid
6868 adding the same item several times. You should add @samp{FEEDSTATUS} to the
6869 list of drawers in that file:
6872 #+DRAWERS: LOGBOOK PROPERTIES FEEDSTATUS
6875 For more information, including how to read atom feeds, see
6876 @file{org-feed.el} and the docstring of @code{org-feed-alist}.
6878 @node Protocols, Refiling notes, RSS Feeds, Capture - Refile - Archive
6879 @section Protocols for external access
6880 @cindex protocols, for external access
6883 You can set up Org for handling protocol calls from outside applications that
6884 are passed to Emacs through the @file{emacsserver}. For example, you can
6885 configure bookmarks in your web browser to send a link to the current page to
6886 Org and create a note from it using capture (@pxref{Capture}). Or you
6887 could create a bookmark that will tell Emacs to open the local source file of
6888 a remote website you are looking at with the browser. See
6889 @uref{http://orgmode.org/worg/org-contrib/org-protocol.php} for detailed
6890 documentation and setup instructions.
6892 @node Refiling notes, Archiving, Protocols, Capture - Refile - Archive
6893 @section Refiling notes
6894 @cindex refiling notes
6896 When reviewing the captured data, you may want to refile some of the entries
6897 into a different list, for example into a project. Cutting, finding the
6898 right location, and then pasting the note is cumbersome. To simplify this
6899 process, you can use the following special command:
6902 @orgcmd{C-c C-w,org-refile}
6903 @vindex org-reverse-note-order
6904 @vindex org-refile-targets
6905 @vindex org-refile-use-outline-path
6906 @vindex org-outline-path-complete-in-steps
6907 @vindex org-refile-allow-creating-parent-nodes
6908 @vindex org-log-refile
6909 @vindex org-refile-use-cache
6910 Refile the entry or region at point. This command offers possible locations
6911 for refiling the entry and lets you select one with completion. The item (or
6912 all items in the region) is filed below the target heading as a subitem.
6913 Depending on @code{org-reverse-note-order}, it will be either the first or
6915 By default, all level 1 headlines in the current buffer are considered to be
6916 targets, but you can have more complex definitions across a number of files.
6917 See the variable @code{org-refile-targets} for details. If you would like to
6918 select a location via a file-path-like completion along the outline path, see
6919 the variables @code{org-refile-use-outline-path} and
6920 @code{org-outline-path-complete-in-steps}. If you would like to be able to
6921 create new nodes as new parents for refiling on the fly, check the
6922 variable @code{org-refile-allow-creating-parent-nodes}.
6923 When the variable @code{org-log-refile}@footnote{with corresponding
6924 @code{#+STARTUP} keywords @code{logrefile}, @code{lognoterefile},
6925 and @code{nologrefile}} is set, a timestamp or a note will be
6926 recorded when an entry has been refiled.
6927 @orgkey{C-u C-c C-w}
6928 Use the refile interface to jump to a heading.
6929 @orgcmd{C-u C-u C-c C-w,org-refile-goto-last-stored}
6930 Jump to the location where @code{org-refile} last moved a tree to.
6932 Refile as the child of the item currently being clocked.
6933 @item C-0 C-c C-w @ @r{or} @ C-u C-u C-u C-c C-w
6935 @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}
6937 Clear the target cache. Caching of refile targets can be turned on by
6938 setting @code{org-refile-use-cache}. To make the command see new possible
6939 targets, you have to clear the cache with this command.
6942 @node Archiving, , Refiling notes, Capture - Refile - Archive
6946 When a project represented by a (sub)tree is finished, you may want
6947 to move the tree out of the way and to stop it from contributing to the
6948 agenda. Archiving is important to keep your working files compact and global
6949 searches like the construction of agenda views fast.
6952 @orgcmd{C-c C-x C-a,org-archive-subtree-default}
6953 @vindex org-archive-default-command
6954 Archive the current entry using the command specified in the variable
6955 @code{org-archive-default-command}.
6959 * Moving subtrees:: Moving a tree to an archive file
6960 * Internal archiving:: Switch off a tree but keep it in the file
6963 @node Moving subtrees, Internal archiving, Archiving, Archiving
6964 @subsection Moving a tree to the archive file
6965 @cindex external archiving
6967 The most common archiving action is to move a project tree to another file,
6971 @orgcmdkskc{C-c C-x C-s,C-c $,org-archive-subtree}
6972 @vindex org-archive-location
6973 Archive the subtree starting at the cursor position to the location
6974 given by @code{org-archive-location}.
6975 @orgkey{C-u C-c C-x C-s}
6976 Check if any direct children of the current headline could be moved to
6977 the archive. To do this, each subtree is checked for open TODO entries.
6978 If none are found, the command offers to move it to the archive
6979 location. If the cursor is @emph{not} on a headline when this command
6980 is invoked, the level 1 trees will be checked.
6983 @cindex archive locations
6984 The default archive location is a file in the same directory as the
6985 current file, with the name derived by appending @file{_archive} to the
6986 current file name. For information and examples on how to change this,
6987 see the documentation string of the variable
6988 @code{org-archive-location}. There is also an in-buffer option for
6989 setting this variable, for example@footnote{For backward compatibility,
6990 the following also works: If there are several such lines in a file,
6991 each specifies the archive location for the text below it. The first
6992 such line also applies to any text before its definition. However,
6993 using this method is @emph{strongly} deprecated as it is incompatible
6994 with the outline structure of the document. The correct method for
6995 setting multiple archive locations in a buffer is using properties.}:
6999 #+ARCHIVE: %s_done::
7002 @cindex property, ARCHIVE
7004 If you would like to have a special ARCHIVE location for a single entry
7005 or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
7006 location as the value (@pxref{Properties and Columns}).
7008 @vindex org-archive-save-context-info
7009 When a subtree is moved, it receives a number of special properties that
7010 record context information like the file from where the entry came, its
7011 outline path the archiving time etc. Configure the variable
7012 @code{org-archive-save-context-info} to adjust the amount of information
7016 @node Internal archiving, , Moving subtrees, Archiving
7017 @subsection Internal archiving
7019 If you want to just switch off (for agenda views) certain subtrees without
7020 moving them to a different file, you can use the @code{ARCHIVE tag}.
7022 A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
7023 its location in the outline tree, but behaves in the following way:
7026 @vindex org-cycle-open-archived-trees
7027 It does not open when you attempt to do so with a visibility cycling
7028 command (@pxref{Visibility cycling}). You can force cycling archived
7029 subtrees with @kbd{C-@key{TAB}}, or by setting the option
7030 @code{org-cycle-open-archived-trees}. Also normal outline commands like
7031 @code{show-all} will open archived subtrees.
7033 @vindex org-sparse-tree-open-archived-trees
7034 During sparse tree construction (@pxref{Sparse trees}), matches in
7035 archived subtrees are not exposed, unless you configure the option
7036 @code{org-sparse-tree-open-archived-trees}.
7038 @vindex org-agenda-skip-archived-trees
7039 During agenda view construction (@pxref{Agenda Views}), the content of
7040 archived trees is ignored unless you configure the option
7041 @code{org-agenda-skip-archived-trees}, in which case these trees will always
7042 be included. In the agenda you can press @kbd{v a} to get archives
7043 temporarily included.
7045 @vindex org-export-with-archived-trees
7046 Archived trees are not exported (@pxref{Exporting}), only the headline
7047 is. Configure the details using the variable
7048 @code{org-export-with-archived-trees}.
7050 @vindex org-columns-skip-archived-trees
7051 Archived trees are excluded from column view unless the variable
7052 @code{org-columns-skip-archived-trees} is configured to @code{nil}.
7055 The following commands help manage the ARCHIVE tag:
7058 @orgcmd{C-c C-x a,org-toggle-archive-tag}
7059 Toggle the ARCHIVE tag for the current headline. When the tag is set,
7060 the headline changes to a shadowed face, and the subtree below it is
7062 @orgkey{C-u C-c C-x a}
7063 Check if any direct children of the current headline should be archived.
7064 To do this, each subtree is checked for open TODO entries. If none are
7065 found, the command offers to set the ARCHIVE tag for the child. If the
7066 cursor is @emph{not} on a headline when this command is invoked, the
7067 level 1 trees will be checked.
7068 @orgcmd{C-@kbd{TAB},org-force-cycle-archived}
7069 Cycle a tree even if it is tagged with ARCHIVE.
7070 @orgcmd{C-c C-x A,org-archive-to-archive-sibling}
7071 Move the current entry to the @emph{Archive Sibling}. This is a sibling of
7072 the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}. The
7073 entry becomes a child of that sibling and in this way retains a lot of its
7074 original context, including inherited tags and approximate position in the
7079 @node Agenda Views, Markup, Capture - Refile - Archive, Top
7080 @chapter Agenda views
7081 @cindex agenda views
7083 Due to the way Org works, TODO items, time-stamped items, and
7084 tagged headlines can be scattered throughout a file or even a number of
7085 files. To get an overview of open action items, or of events that are
7086 important for a particular date, this information must be collected,
7087 sorted and displayed in an organized way.
7089 Org can select items based on various criteria and display them
7090 in a separate buffer. Seven different view types are provided:
7094 an @emph{agenda} that is like a calendar and shows information
7097 a @emph{TODO list} that covers all unfinished
7100 a @emph{match view}, showings headlines based on the tags, properties, and
7101 TODO state associated with them,
7103 a @emph{timeline view} that shows all events in a single Org file,
7104 in time-sorted view,
7106 a @emph{text search view} that shows all entries from multiple files
7107 that contain specified keywords,
7109 a @emph{stuck projects view} showing projects that currently don't move
7112 @emph{custom views} that are special searches and combinations of different
7117 The extracted information is displayed in a special @emph{agenda
7118 buffer}. This buffer is read-only, but provides commands to visit the
7119 corresponding locations in the original Org files, and even to
7120 edit these files remotely.
7122 @vindex org-agenda-window-setup
7123 @vindex org-agenda-restore-windows-after-quit
7124 Two variables control how the agenda buffer is displayed and whether the
7125 window configuration is restored when the agenda exits:
7126 @code{org-agenda-window-setup} and
7127 @code{org-agenda-restore-windows-after-quit}.
7130 * Agenda files:: Files being searched for agenda information
7131 * Agenda dispatcher:: Keyboard access to agenda views
7132 * Built-in agenda views:: What is available out of the box?
7133 * Presentation and sorting:: How agenda items are prepared for display
7134 * Agenda commands:: Remote editing of Org trees
7135 * Custom agenda views:: Defining special searches and views
7136 * Exporting Agenda Views:: Writing a view to a file
7137 * Agenda column view:: Using column view for collected entries
7140 @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views
7141 @section Agenda files
7142 @cindex agenda files
7143 @cindex files for agenda
7145 @vindex org-agenda-files
7146 The information to be shown is normally collected from all @emph{agenda
7147 files}, the files listed in the variable
7148 @code{org-agenda-files}@footnote{If the value of that variable is not a
7149 list, but a single file name, then the list of agenda files will be
7150 maintained in that external file.}. If a directory is part of this list,
7151 all files with the extension @file{.org} in this directory will be part
7154 Thus, even if you only work with a single Org file, that file should
7155 be put into the list@footnote{When using the dispatcher, pressing
7156 @kbd{<} before selecting a command will actually limit the command to
7157 the current file, and ignore @code{org-agenda-files} until the next
7158 dispatcher command.}. You can customize @code{org-agenda-files}, but
7159 the easiest way to maintain it is through the following commands
7161 @cindex files, adding to agenda list
7163 @orgcmd{C-c [,org-agenda-file-to-front}
7164 Add current file to the list of agenda files. The file is added to
7165 the front of the list. If it was already in the list, it is moved to
7166 the front. With a prefix argument, file is added/moved to the end.
7167 @orgcmd{C-c ],org-remove-file}
7168 Remove current file from the list of agenda files.
7170 @cindex cycling, of agenda files
7171 @orgcmd{C-',org-cycle-agenda-files}
7173 Cycle through agenda file list, visiting one file after the other.
7174 @kindex M-x org-iswitchb
7175 @item M-x org-iswitchb
7176 Command to use an @code{iswitchb}-like interface to switch to and between Org
7181 The Org menu contains the current list of files and can be used
7182 to visit any of them.
7184 If you would like to focus the agenda temporarily on a file not in
7185 this list, or on just one file in the list, or even on only a subtree in a
7186 file, then this can be done in different ways. For a single agenda command,
7187 you may press @kbd{<} once or several times in the dispatcher
7188 (@pxref{Agenda dispatcher}). To restrict the agenda scope for an
7189 extended period, use the following commands:
7192 @orgcmd{C-c C-x <,org-agenda-set-restriction-lock}
7193 Permanently restrict the agenda to the current subtree. When with a
7194 prefix argument, or with the cursor before the first headline in a file,
7195 the agenda scope is set to the entire file. This restriction remains in
7196 effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
7197 or @kbd{>} in the agenda dispatcher. If there is a window displaying an
7198 agenda view, the new restriction takes effect immediately.
7199 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
7200 Remove the permanent restriction created by @kbd{C-c C-x <}.
7204 When working with @file{speedbar.el}, you can use the following commands in
7207 @orgcmdtkc{< @r{in the speedbar frame},<,org-speedbar-set-agenda-restriction}
7208 Permanently restrict the agenda to the item---either an Org file or a subtree
7209 in such a file---at the cursor in the Speedbar frame.
7210 If there is a window displaying an agenda view, the new restriction takes
7212 @orgcmdtkc{> @r{in the speedbar frame},>,org-agenda-remove-restriction-lock}
7213 Lift the restriction.
7216 @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views
7217 @section The agenda dispatcher
7218 @cindex agenda dispatcher
7219 @cindex dispatching agenda commands
7220 The views are created through a dispatcher, which should be bound to a
7221 global key---for example @kbd{C-c a} (@pxref{Activation}). In the
7222 following we will assume that @kbd{C-c a} is indeed how the dispatcher
7223 is accessed and list keyboard access to commands accordingly. After
7224 pressing @kbd{C-c a}, an additional letter is required to execute a
7225 command. The dispatcher offers the following default commands:
7228 Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
7230 Create a list of all TODO items (@pxref{Global TODO list}).
7232 Create a list of headlines matching a TAGS expression (@pxref{Matching
7233 tags and properties}).
7235 Create the timeline view for the current buffer (@pxref{Timeline}).
7237 Create a list of entries selected by a boolean expression of keywords
7238 and/or regular expressions that must or must not occur in the entry.
7240 @vindex org-agenda-text-search-extra-files
7241 Search for a regular expression in all agenda files and additionally in
7242 the files listed in @code{org-agenda-text-search-extra-files}. This
7243 uses the Emacs command @code{multi-occur}. A prefix argument can be
7244 used to specify the number of context lines for each match, default is
7247 Create a list of stuck projects (@pxref{Stuck projects}).
7249 Restrict an agenda command to the current buffer@footnote{For backward
7250 compatibility, you can also press @kbd{1} to restrict to the current
7251 buffer.}. After pressing @kbd{<}, you still need to press the character
7252 selecting the command.
7254 If there is an active region, restrict the following agenda command to
7255 the region. Otherwise, restrict it to the current subtree@footnote{For
7256 backward compatibility, you can also press @kbd{0} to restrict to the
7257 current region/subtree.}. After pressing @kbd{< <}, you still need to press the
7258 character selecting the command.
7261 You can also define custom commands that will be accessible through the
7262 dispatcher, just like the default commands. This includes the
7263 possibility to create extended agenda buffers that contain several
7264 blocks together, for example the weekly agenda, the global TODO list and
7265 a number of special tags matches. @xref{Custom agenda views}.
7267 @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda Views
7268 @section The built-in agenda views
7270 In this section we describe the built-in views.
7273 * Weekly/daily agenda:: The calendar page with current tasks
7274 * Global TODO list:: All unfinished action items
7275 * Matching tags and properties:: Structured information with fine-tuned search
7276 * Timeline:: Time-sorted view for single file
7277 * Search view:: Find entries by searching for text
7278 * Stuck projects:: Find projects you need to review
7281 @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views
7282 @subsection The weekly/daily agenda
7284 @cindex weekly agenda
7285 @cindex daily agenda
7287 The purpose of the weekly/daily @emph{agenda} is to act like a page of a
7288 paper agenda, showing all the tasks for the current week or day.
7291 @cindex org-agenda, command
7292 @orgcmd{C-c a a,org-agenda-list}
7293 Compile an agenda for the current week from a list of Org files. The agenda
7294 shows the entries for each day. With a numeric prefix@footnote{For backward
7295 compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
7296 listed before the agenda. This feature is deprecated, use the dedicated TODO
7297 list, or a block agenda instead (@pxref{Block agenda}).} (like @kbd{C-u 2 1
7298 C-c a a}) you may set the number of days to be displayed.
7301 @vindex org-agenda-span
7302 @vindex org-agenda-ndays
7303 The default number of days displayed in the agenda is set by the variable
7304 @code{org-agenda-span} (or the obsolete @code{org-agenda-ndays}). This
7305 variable can be set to any number of days you want to see by default in the
7306 agenda, or to a span name, such a @code{day}, @code{week}, @code{month} or
7309 Remote editing from the agenda buffer means, for example, that you can
7310 change the dates of deadlines and appointments from the agenda buffer.
7311 The commands available in the Agenda buffer are listed in @ref{Agenda
7314 @subsubheading Calendar/Diary integration
7315 @cindex calendar integration
7316 @cindex diary integration
7318 Emacs contains the calendar and diary by Edward M. Reingold. The
7319 calendar displays a three-month calendar with holidays from different
7320 countries and cultures. The diary allows you to keep track of
7321 anniversaries, lunar phases, sunrise/set, recurrent appointments
7322 (weekly, monthly) and more. In this way, it is quite complementary to
7323 Org. It can be very useful to combine output from Org with
7326 In order to include entries from the Emacs diary into Org mode's
7327 agenda, you only need to customize the variable
7330 (setq org-agenda-include-diary t)
7333 @noindent After that, everything will happen automatically. All diary
7334 entries including holidays, anniversaries, etc., will be included in the
7335 agenda buffer created by Org mode. @key{SPC}, @key{TAB}, and
7336 @key{RET} can be used from the agenda buffer to jump to the diary
7337 file in order to edit existing diary entries. The @kbd{i} command to
7338 insert new entries for the current date works in the agenda buffer, as
7339 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
7340 Sunrise/Sunset times, show lunar phases and to convert to other
7341 calendars, respectively. @kbd{c} can be used to switch back and forth
7342 between calendar and agenda.
7344 If you are using the diary only for sexp entries and holidays, it is
7345 faster to not use the above setting, but instead to copy or even move
7346 the entries into an Org file. Org mode evaluates diary-style sexp
7347 entries, and does it faster because there is no overhead for first
7348 creating the diary display. Note that the sexp entries must start at
7349 the left margin, no whitespace is allowed before them. For example,
7350 the following segment of an Org file will be processed and entries
7351 will be made in the agenda:
7354 * Birthdays and similar stuff
7356 %%(org-calendar-holiday) ; special function for holiday names
7358 %%(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
7359 %%(org-anniversary 1869 10 2) Mahatma Gandhi would be %d years old
7362 @subsubheading Anniversaries from BBDB
7363 @cindex BBDB, anniversaries
7364 @cindex anniversaries, from BBDB
7366 If you are using the Big Brothers Database to store your contacts, you will
7367 very likely prefer to store anniversaries in BBDB rather than in a
7368 separate Org or diary file. Org supports this and will show BBDB
7369 anniversaries as part of the agenda. All you need to do is to add the
7370 following to one of your agenda files:
7377 %%(org-bbdb-anniversaries)
7380 You can then go ahead and define anniversaries for a BBDB record. Basically,
7381 you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB
7382 record and then add the date in the format @code{YYYY-MM-DD} or @code{MM-DD},
7383 followed by a space and the class of the anniversary (@samp{birthday} or
7384 @samp{wedding}, or a format string). If you omit the class, it will default to
7385 @samp{birthday}. Here are a few examples, the header for the file
7386 @file{org-bbdb.el} contains more detailed information.
7392 2008-04-14 %s released version 6.01 of org mode, %d years ago
7395 After a change to BBDB, or for the first agenda display during an Emacs
7396 session, the agenda display will suffer a short delay as Org updates its
7397 hash with anniversaries. However, from then on things will be very fast---much
7398 faster in fact than a long list of @samp{%%(diary-anniversary)} entries
7399 in an Org or Diary file.
7401 @subsubheading Appointment reminders
7402 @cindex @file{appt.el}
7403 @cindex appointment reminders
7407 Org can interact with Emacs appointments notification facility. To add all
7408 the appointments of your agenda files, use the command
7409 @code{org-agenda-to-appt}. This command also lets you filter through the
7410 list of your appointments and add only those belonging to a specific category
7411 or matching a regular expression. See the docstring for details.
7413 @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views
7414 @subsection The global TODO list
7415 @cindex global TODO list
7416 @cindex TODO list, global
7418 The global TODO list contains all unfinished TODO items formatted and
7419 collected into a single place.
7422 @orgcmd{C-c a t,org-todo-list}
7423 Show the global TODO list. This collects the TODO items from all agenda
7424 files (@pxref{Agenda Views}) into a single buffer. By default, this lists
7425 items with a state the is not a DONE state. The buffer is in
7426 @code{agenda-mode}, so there are commands to examine and manipulate the TODO
7427 entries directly from that buffer (@pxref{Agenda commands}).
7428 @orgcmd{C-c a T,org-todo-list}
7429 @cindex TODO keyword matching
7430 @vindex org-todo-keywords
7431 Like the above, but allows selection of a specific TODO keyword. You can
7432 also do this by specifying a prefix argument to @kbd{C-c a t}. You are
7433 prompted for a keyword, and you may also specify several keywords by
7434 separating them with @samp{|} as the boolean OR operator. With a numeric
7435 prefix, the Nth keyword in @code{org-todo-keywords} is selected.
7437 The @kbd{r} key in the agenda buffer regenerates it, and you can give
7438 a prefix argument to this command to change the selected TODO keyword,
7439 for example @kbd{3 r}. If you often need a search for a specific
7440 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
7441 Matching specific TODO keywords can also be done as part of a tags
7442 search (@pxref{Tag searches}).
7445 Remote editing of TODO items means that you can change the state of a
7446 TODO entry with a single key press. The commands available in the
7447 TODO list are described in @ref{Agenda commands}.
7449 @cindex sublevels, inclusion into TODO list
7450 Normally the global TODO list simply shows all headlines with TODO
7451 keywords. This list can become very long. There are two ways to keep
7455 @vindex org-agenda-todo-ignore-scheduled
7456 @vindex org-agenda-todo-ignore-deadlines
7457 @vindex org-agenda-todo-ignore-timestamp
7458 @vindex org-agenda-todo-ignore-with-date
7459 Some people view a TODO item that has been @emph{scheduled} for execution or
7460 have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}.
7461 Configure the variables @code{org-agenda-todo-ignore-scheduled},
7462 @code{org-agenda-todo-ignore-deadlines},
7463 @code{org-agenda-todo-ignore-timestamp} and/or
7464 @code{org-agenda-todo-ignore-with-date} to exclude such items from the global
7467 @vindex org-agenda-todo-list-sublevels
7468 TODO items may have sublevels to break up the task into subtasks. In
7469 such cases it may be enough to list only the highest level TODO headline
7470 and omit the sublevels from the global list. Configure the variable
7471 @code{org-agenda-todo-list-sublevels} to get this behavior.
7474 @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views
7475 @subsection Matching tags and properties
7476 @cindex matching, of tags
7477 @cindex matching, of properties
7481 If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}),
7482 or have properties (@pxref{Properties and Columns}), you can select headlines
7483 based on this metadata and collect them into an agenda buffer. The match
7484 syntax described here also applies when creating sparse trees with @kbd{C-c /
7488 @orgcmd{C-c a m,org-tags-view}
7489 Produce a list of all headlines that match a given set of tags. The
7490 command prompts for a selection criterion, which is a boolean logic
7491 expression with tags, like @samp{+work+urgent-withboss} or
7492 @samp{work|home} (@pxref{Tags}). If you often need a specific search,
7493 define a custom command for it (@pxref{Agenda dispatcher}).
7494 @orgcmd{C-c a M,org-tags-view}
7495 @vindex org-tags-match-list-sublevels
7496 @vindex org-agenda-tags-todo-honor-ignore-options
7497 Like @kbd{C-c a m}, but only select headlines that are also TODO items in a
7498 not-DONE state and force checking subitems (see variable
7499 @code{org-tags-match-list-sublevels}). To exclude scheduled/deadline items,
7500 see the variable @code{org-agenda-tags-todo-honor-ignore-options}. Matching
7501 specific TODO keywords together with a tags match is also possible, see
7505 The commands available in the tags list are described in @ref{Agenda
7508 @subsubheading Match syntax
7510 @cindex Boolean logic, for tag/property searches
7511 A search string can use Boolean operators @samp{&} for AND and @samp{|} for
7512 OR. @samp{&} binds more strongly than @samp{|}. Parentheses are currently
7513 not implemented. Each element in the search is either a tag, a regular
7514 expression matching tags, or an expression like @code{PROPERTY OPERATOR
7515 VALUE} with a comparison operator, accessing a property value. Each element
7516 may be preceded by @samp{-}, to select against it, and @samp{+} is syntactic
7517 sugar for positive selection. The AND operator @samp{&} is optional when
7518 @samp{+} or @samp{-} is present. Here are some examples, using only tags.
7522 Select headlines tagged @samp{:work:}, but discard those also tagged
7525 Selects lines tagged @samp{:work:} or @samp{:laptop:}.
7526 @item work|laptop+night
7527 Like before, but require the @samp{:laptop:} lines to be tagged also
7531 @cindex regular expressions, with tags search
7532 Instead of a tag, you may also specify a regular expression enclosed in curly
7533 braces. For example,
7534 @samp{work+@{^boss.*@}} matches headlines that contain the tag
7535 @samp{:work:} and any tag @i{starting} with @samp{boss}.
7537 @cindex TODO keyword matching, with tags search
7538 @cindex level, require for tags/property match
7539 @cindex category, require for tags/property match
7540 @vindex org-odd-levels-only
7541 You may also test for properties (@pxref{Properties and Columns}) at the same
7542 time as matching tags. The properties may be real properties, or special
7543 properties that represent other metadata (@pxref{Special properties}). For
7544 example, the ``property'' @code{TODO} represents the TODO keyword of the
7545 entry. Or, the ``property'' @code{LEVEL} represents the level of an entry.
7546 So a search @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines
7547 that have the tag @samp{boss} and are @emph{not} marked with the TODO keyword
7548 DONE. In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not
7549 count the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc.
7551 Here are more examples:
7553 @item work+TODO="WAITING"
7554 Select @samp{:work:}-tagged TODO lines with the specific TODO
7555 keyword @samp{WAITING}.
7556 @item work+TODO="WAITING"|home+TODO="WAITING"
7557 Waiting tasks both at work and at home.
7560 When matching properties, a number of different operators can be used to test
7561 the value of a property. Here is a complex example:
7564 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 \
7565 +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
7569 The type of comparison will depend on how the comparison value is written:
7572 If the comparison value is a plain number, a numerical comparison is done,
7573 and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
7574 @samp{>=}, and @samp{<>}.
7576 If the comparison value is enclosed in double-quotes,
7577 a string comparison is done, and the same operators are allowed.
7579 If the comparison value is enclosed in double-quotes @emph{and} angular
7580 brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
7581 assumed to be date/time specifications in the standard Org way, and the
7582 comparison will be done accordingly. Special values that will be recognized
7583 are @code{"<now>"} for now (including time), and @code{"<today>"}, and
7584 @code{"<tomorrow>"} for these days at 0:00 hours, i.e.@: without a time
7585 specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
7586 @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
7587 respectively, can be used.
7589 If the comparison value is enclosed
7590 in curly braces, a regexp match is performed, with @samp{=} meaning that the
7591 regexp matches the property value, and @samp{<>} meaning that it does not
7595 So the search string in the example finds entries tagged @samp{:work:} but
7596 not @samp{:boss:}, which also have a priority value @samp{A}, a
7597 @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
7598 property that is numerically smaller than 2, a @samp{:With:} property that is
7599 matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
7600 on or after October 11, 2008.
7602 Accessing TODO, LEVEL, and CATEGORY during a search is fast. Accessing any
7603 other properties will slow down the search. However, once you have paid the
7604 price by accessing one property, testing additional properties is cheap
7607 You can configure Org mode to use property inheritance during a search, but
7608 beware that this can slow down searches considerably. See @ref{Property
7609 inheritance}, for details.
7611 For backward compatibility, and also for typing speed, there is also a
7612 different way to test TODO states in a search. For this, terminate the
7613 tags/property part of the search string (which may include several terms
7614 connected with @samp{|}) with a @samp{/} and then specify a Boolean
7615 expression just for TODO keywords. The syntax is then similar to that for
7616 tags, but should be applied with care: for example, a positive selection on
7617 several TODO keywords cannot meaningfully be combined with boolean AND.
7618 However, @emph{negative selection} combined with AND can be meaningful. To
7619 make sure that only lines are checked that actually have any TODO keyword
7620 (resulting in a speed-up), use @kbd{C-c a M}, or equivalently start the TODO
7621 part after the slash with @samp{!}. Using @kbd{C-c a M} or @samp{/!} will
7622 not match TODO keywords in a DONE state. Examples:
7626 Same as @samp{work+TODO="WAITING"}
7627 @item work/!-WAITING-NEXT
7628 Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
7630 @item work/!+WAITING|+NEXT
7631 Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
7635 @node Timeline, Search view, Matching tags and properties, Built-in agenda views
7636 @subsection Timeline for a single file
7637 @cindex timeline, single file
7638 @cindex time-sorted view
7640 The timeline summarizes all time-stamped items from a single Org mode
7641 file in a @emph{time-sorted view}. The main purpose of this command is
7642 to give an overview over events in a project.
7645 @orgcmd{C-c a L,org-timeline}
7646 Show a time-sorted view of the Org file, with all time-stamped items.
7647 When called with a @kbd{C-u} prefix, all unfinished TODO entries
7648 (scheduled or not) are also listed under the current date.
7652 The commands available in the timeline buffer are listed in
7653 @ref{Agenda commands}.
7655 @node Search view, Stuck projects, Timeline, Built-in agenda views
7656 @subsection Search view
7659 @cindex searching, for text
7661 This agenda view is a general text search facility for Org mode entries.
7662 It is particularly useful to find notes.
7665 @orgcmd{C-c a s,org-search-view}
7666 This is a special search that lets you select entries by matching a substring
7667 or specific words using a boolean logic.
7669 For example, the search string @samp{computer equipment} will find entries
7670 that contain @samp{computer equipment} as a substring. If the two words are
7671 separated by more space or a line break, the search will still match.
7672 Search view can also search for specific keywords in the entry, using Boolean
7673 logic. The search string @samp{+computer +wifi -ethernet -@{8\.11[bg]@}}
7674 will search for note entries that contain the keywords @code{computer}
7675 and @code{wifi}, but not the keyword @code{ethernet}, and which are also
7676 not matched by the regular expression @code{8\.11[bg]}, meaning to
7677 exclude both 8.11b and 8.11g. The first @samp{+} is necessary to turn on
7678 word search, other @samp{+} characters are optional. For more details, see
7679 the docstring of the command @code{org-search-view}.
7681 @vindex org-agenda-text-search-extra-files
7682 Note that in addition to the agenda files, this command will also search
7683 the files listed in @code{org-agenda-text-search-extra-files}.
7685 @node Stuck projects, , Search view, Built-in agenda views
7686 @subsection Stuck projects
7687 @pindex GTD, Getting Things Done
7689 If you are following a system like David Allen's GTD to organize your
7690 work, one of the ``duties'' you have is a regular review to make sure
7691 that all projects move along. A @emph{stuck} project is a project that
7692 has no defined next actions, so it will never show up in the TODO lists
7693 Org mode produces. During the review, you need to identify such
7694 projects and define next actions for them.
7697 @orgcmd{C-c a #,org-agenda-list-stuck-projects}
7698 List projects that are stuck.
7701 @vindex org-stuck-projects
7702 Customize the variable @code{org-stuck-projects} to define what a stuck
7703 project is and how to find it.
7706 You almost certainly will have to configure this view before it will
7707 work for you. The built-in default assumes that all your projects are
7708 level-2 headlines, and that a project is not stuck if it has at least
7709 one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
7711 Let's assume that you, in your own way of using Org mode, identify
7712 projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
7713 indicate a project that should not be considered yet. Let's further
7714 assume that the TODO keyword DONE marks finished projects, and that NEXT
7715 and TODO indicate next actions. The tag @@SHOP indicates shopping and
7716 is a next action even without the NEXT tag. Finally, if the project
7717 contains the special word IGNORE anywhere, it should not be listed
7718 either. In this case you would start by identifying eligible projects
7719 with a tags/todo match@footnote{@xref{Tag searches}.}
7720 @samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT, @@SHOP, and
7721 IGNORE in the subtree to identify projects that are not stuck. The
7722 correct customization for this is
7725 (setq org-stuck-projects
7726 '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
7730 Note that if a project is identified as non-stuck, the subtree of this entry
7731 will still be searched for stuck projects.
7733 @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views
7734 @section Presentation and sorting
7735 @cindex presentation, of agenda items
7737 @vindex org-agenda-prefix-format
7738 @vindex org-agenda-tags-column
7739 Before displaying items in an agenda view, Org mode visually prepares the
7740 items and sorts them. Each item occupies a single line. The line starts
7741 with a @emph{prefix} that contains the @emph{category} (@pxref{Categories})
7742 of the item and other important information. You can customize in which
7743 column tags will be displayed through @code{org-agenda-tags-column}. You can
7744 also customize the prefix using the option @code{org-agenda-prefix-format}.
7745 This prefix is followed by a cleaned-up version of the outline headline
7746 associated with the item.
7749 * Categories:: Not all tasks are equal
7750 * Time-of-day specifications:: How the agenda knows the time
7751 * Sorting of agenda items:: The order of things
7754 @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting
7755 @subsection Categories
7759 The category is a broad label assigned to each agenda item. By default,
7760 the category is simply derived from the file name, but you can also
7761 specify it with a special line in the buffer, like this@footnote{For
7762 backward compatibility, the following also works: if there are several
7763 such lines in a file, each specifies the category for the text below it.
7764 The first category also applies to any text before the first CATEGORY
7765 line. However, using this method is @emph{strongly} deprecated as it is
7766 incompatible with the outline structure of the document. The correct
7767 method for setting multiple categories in a buffer is using a
7775 @cindex property, CATEGORY
7776 If you would like to have a special CATEGORY for a single entry or a
7777 (sub)tree, give the entry a @code{:CATEGORY:} property with the
7778 special category you want to apply as the value.
7781 The display in the agenda buffer looks best if the category is not
7782 longer than 10 characters.
7785 You can set up icons for category by customizing the
7786 @code{org-agenda-category-icon-alist} variable.
7788 @node Time-of-day specifications, Sorting of agenda items, Categories, Presentation and sorting
7789 @subsection Time-of-day specifications
7790 @cindex time-of-day specification
7792 Org mode checks each agenda item for a time-of-day specification. The
7793 time can be part of the timestamp that triggered inclusion into the
7794 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time
7795 ranges can be specified with two timestamps, like
7797 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
7799 In the headline of the entry itself, a time(range) may also appear as
7800 plain text (like @samp{12:45} or a @samp{8:30-1pm}). If the agenda
7801 integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
7802 specifications in diary entries are recognized as well.
7804 For agenda display, Org mode extracts the time and displays it in a
7805 standard 24 hour format as part of the prefix. The example times in
7806 the previous paragraphs would end up in the agenda like this:
7809 8:30-13:00 Arthur Dent lies in front of the bulldozer
7810 12:45...... Ford Prefect arrives and takes Arthur to the pub
7811 19:00...... The Vogon reads his poem
7812 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
7816 If the agenda is in single-day mode, or for the display of today, the
7817 timed entries are embedded in a time grid, like
7820 8:00...... ------------------
7821 8:30-13:00 Arthur Dent lies in front of the bulldozer
7822 10:00...... ------------------
7823 12:00...... ------------------
7824 12:45...... Ford Prefect arrives and takes Arthur to the pub
7825 14:00...... ------------------
7826 16:00...... ------------------
7827 18:00...... ------------------
7828 19:00...... The Vogon reads his poem
7829 20:00...... ------------------
7830 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
7833 @vindex org-agenda-use-time-grid
7834 @vindex org-agenda-time-grid
7835 The time grid can be turned on and off with the variable
7836 @code{org-agenda-use-time-grid}, and can be configured with
7837 @code{org-agenda-time-grid}.
7839 @node Sorting of agenda items, , Time-of-day specifications, Presentation and sorting
7840 @subsection Sorting of agenda items
7841 @cindex sorting, of agenda items
7842 @cindex priorities, of agenda items
7843 Before being inserted into a view, the items are sorted. How this is
7844 done depends on the type of view.
7847 @vindex org-agenda-files
7848 For the daily/weekly agenda, the items for each day are sorted. The
7849 default order is to first collect all items containing an explicit
7850 time-of-day specification. These entries will be shown at the beginning
7851 of the list, as a @emph{schedule} for the day. After that, items remain
7852 grouped in categories, in the sequence given by @code{org-agenda-files}.
7853 Within each category, items are sorted by priority (@pxref{Priorities}),
7854 which is composed of the base priority (2000 for priority @samp{A}, 1000
7855 for @samp{B}, and 0 for @samp{C}), plus additional increments for
7856 overdue scheduled or deadline items.
7858 For the TODO list, items remain in the order of categories, but within
7859 each category, sorting takes place according to priority
7860 (@pxref{Priorities}). The priority used for sorting derives from the
7861 priority cookie, with additions depending on how close an item is to its due
7864 For tags matches, items are not sorted at all, but just appear in the
7865 sequence in which they are found in the agenda files.
7868 @vindex org-agenda-sorting-strategy
7869 Sorting can be customized using the variable
7870 @code{org-agenda-sorting-strategy}, and may also include criteria based on
7871 the estimated effort of an entry (@pxref{Effort estimates}).
7873 @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda Views
7874 @section Commands in the agenda buffer
7875 @cindex commands, in agenda buffer
7877 Entries in the agenda buffer are linked back to the Org file or diary
7878 file where they originate. You are not allowed to edit the agenda
7879 buffer itself, but commands are provided to show and jump to the
7880 original entry location, and to edit the Org files ``remotely'' from
7881 the agenda buffer. In this way, all information is stored only once,
7882 removing the risk that your agenda and note files may diverge.
7884 Some commands can be executed with mouse clicks on agenda lines. For
7885 the other commands, the cursor needs to be in the desired line.
7888 @tsubheading{Motion}
7889 @cindex motion commands in agenda
7890 @orgcmd{n,org-agenda-next-line}
7891 Next line (same as @key{up} and @kbd{C-p}).
7892 @orgcmd{p,org-agenda-previous-line}
7893 Previous line (same as @key{down} and @kbd{C-n}).
7894 @tsubheading{View/Go to Org file}
7895 @orgcmdkkc{@key{SPC},mouse-3,org-agenda-show-and-scroll-up}
7896 Display the original location of the item in another window.
7897 With prefix arg, make sure that the entire entry is made visible in the
7898 outline, not only the heading.
7900 @orgcmd{L,org-agenda-recenter}
7901 Display original location and recenter that window.
7903 @orgcmdkkc{@key{TAB},mouse-2,org-agenda-goto}
7904 Go to the original location of the item in another window.
7906 @orgcmd{@key{RET},org-agenda-switch-to}
7907 Go to the original location of the item and delete other windows.
7909 @orgcmd{F,org-agenda-follow-mode}
7910 @vindex org-agenda-start-with-follow-mode
7911 Toggle Follow mode. In Follow mode, as you move the cursor through
7912 the agenda buffer, the other window always shows the corresponding
7913 location in the Org file. The initial setting for this mode in new
7914 agenda buffers can be set with the variable
7915 @code{org-agenda-start-with-follow-mode}.
7917 @orgcmd{C-c C-x b,org-agenda-tree-to-indirect-buffer}
7918 Display the entire subtree of the current item in an indirect buffer. With a
7919 numeric prefix argument N, go up to level N and then take that tree. If N is
7920 negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the
7921 previously used indirect buffer.
7923 @orgcmd{C-c C-o,org-agenda-open-link}
7924 Follow a link in the entry. This will offer a selection of any links in the
7925 text belonging to the referenced Org node. If there is only one link, it
7926 will be followed without a selection prompt.
7928 @tsubheading{Change display}
7929 @cindex display changing, in agenda
7932 Interactively select another agenda view and append it to the current view.
7936 Delete other windows.
7938 @orgcmdkskc{v d,d,org-agenda-day-view}
7939 @xorgcmdkskc{v w,w,org-agenda-day-view}
7940 @xorgcmd{v m,org-agenda-month-view}
7941 @xorgcmd{v y,org-agenda-month-year}
7942 @xorgcmd{v SPC,org-agenda-reset-view}
7943 @vindex org-agenda-span
7944 Switch to day/week/month/year view. When switching to day or week view, this
7945 setting becomes the default for subsequent agenda refreshes. Since month and
7946 year views are slow to create, they do not become the default. A numeric
7947 prefix argument may be used to jump directly to a specific day of the year,
7948 ISO week, month, or year, respectively. For example, @kbd{32 d} jumps to
7949 February 1st, @kbd{9 w} to ISO week number 9. When setting day, week, or
7950 month view, a year may be encoded in the prefix argument as well. For
7951 example, @kbd{200712 w} will jump to week 12 in 2007. If such a year
7952 specification has only one or two digits, it will be mapped to the interval
7953 1938-2037. @kbd{v @key{SPC}} will reset to what is set in
7954 @code{org-agenda-span}.
7956 @orgcmd{f,org-agenda-later}
7957 Go forward in time to display the following @code{org-agenda-current-span} days.
7958 For example, if the display covers a week, switch to the following week.
7959 With prefix arg, go forward that many times @code{org-agenda-current-span} days.
7961 @orgcmd{b,org-agenda-earlier}
7962 Go backward in time to display earlier dates.
7964 @orgcmd{.,org-agenda-goto-today}
7967 @orgcmd{j,org-agenda-goto-date}
7968 Prompt for a date and go there.
7970 @orgcmd{J,org-agenda-clock-goto}
7971 Go to the currently clocked-in task @i{in the agenda buffer}.
7973 @orgcmd{D,org-agenda-toggle-diary}
7974 Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}.
7976 @orgcmdkskc{v l,l,org-agenda-log-mode}
7978 @vindex org-log-done
7979 @vindex org-agenda-log-mode-items
7980 Toggle Logbook mode. In Logbook mode, entries that were marked DONE while
7981 logging was on (variable @code{org-log-done}) are shown in the agenda, as are
7982 entries that have been clocked on that day. You can configure the entry
7983 types that should be included in log mode using the variable
7984 @code{org-agenda-log-mode-items}. When called with a @kbd{C-u} prefix, show
7985 all possible logbook entries, including state changes. When called with two
7986 prefix args @kbd{C-u C-u}, show only logging information, nothing else.
7987 @kbd{v L} is equivalent to @kbd{C-u v l}.
7989 @orgcmdkskc{v [,[,org-agenda-manipulate-query-add}
7990 Include inactive timestamps into the current view. Only for weekly/daily
7991 agenda and timeline views.
7993 @orgcmd{v a,org-agenda-archives-mode}
7994 @xorgcmd{v A,org-agenda-archives-mode 'files}
7995 Toggle Archives mode. In Archives mode, trees that are marked
7996 @code{ARCHIVED} are also scanned when producing the agenda. When you use the
7997 capital @kbd{A}, even all archive files are included. To exit archives mode,
7998 press @kbd{v a} again.
8000 @orgcmdkskc{v R,R,org-agenda-clockreport-mode}
8001 @vindex org-agenda-start-with-clockreport-mode
8002 @vindex org-clock-report-include-clocking-task
8003 Toggle Clockreport mode. In Clockreport mode, the daily/weekly agenda will
8004 always show a table with the clocked times for the timespan and file scope
8005 covered by the current agenda view. The initial setting for this mode in new
8006 agenda buffers can be set with the variable
8007 @code{org-agenda-start-with-clockreport-mode}. By using a prefix argument
8008 when toggling this mode (i.e.@: @kbd{C-u R}), the clock table will not show
8009 contributions from entries that are hidden by agenda filtering@footnote{Only
8010 tags filtering will be respected here, effort filtering is ignored.}. See
8011 also the variable @code{org-clock-report-include-clocking-task}.
8014 @vindex org-agenda-clock-consistency-checks
8015 Show overlapping clock entries, clocking gaps, and other clocking problems in
8016 the current agenda range. You can then visit clocking lines and fix them
8017 manually. See the variable @code{org-agenda-clock-consistency-checks} for
8018 information on how to customize the definition of what constituted a clocking
8019 problem. To return to normal agenda display, press @kbd{l} to exit Logbook
8022 @orgcmdkskc{v E,E,org-agenda-entry-text-mode}
8023 @vindex org-agenda-start-with-entry-text-mode
8024 @vindex org-agenda-entry-text-maxlines
8025 Toggle entry text mode. In entry text mode, a number of lines from the Org
8026 outline node referenced by an agenda line will be displayed below the line.
8027 The maximum number of lines is given by the variable
8028 @code{org-agenda-entry-text-maxlines}. Calling this command with a numeric
8029 prefix argument will temporarily modify that number to the prefix value.
8031 @orgcmd{G,org-agenda-toggle-time-grid}
8032 @vindex org-agenda-use-time-grid
8033 @vindex org-agenda-time-grid
8034 Toggle the time grid on and off. See also the variables
8035 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
8037 @orgcmd{r,org-agenda-redo}
8038 Recreate the agenda buffer, for example to reflect the changes after
8039 modification of the timestamps of items with @kbd{S-@key{left}} and
8040 @kbd{S-@key{right}}. When the buffer is the global TODO list, a prefix
8041 argument is interpreted to create a selective list for a specific TODO
8043 @orgcmd{g,org-agenda-redo}
8046 @orgcmdkskc{C-x C-s,s,org-save-all-org-buffers}
8047 Save all Org buffers in the current Emacs session, and also the locations of
8050 @orgcmd{C-c C-x C-c,org-agenda-columns}
8051 @vindex org-columns-default-format
8052 Invoke column view (@pxref{Column view}) in the agenda buffer. The column
8053 view format is taken from the entry at point, or (if there is no entry at
8054 point), from the first entry in the agenda view. So whatever the format for
8055 that entry would be in the original buffer (taken from a property, from a
8056 @code{#+COLUMNS} line, or from the default variable
8057 @code{org-columns-default-format}), will be used in the agenda.
8059 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
8060 Remove the restriction lock on the agenda, if it is currently restricted to a
8061 file or subtree (@pxref{Agenda files}).
8063 @tsubheading{Secondary filtering and query editing}
8064 @cindex filtering, by tag category and effort, in agenda
8065 @cindex tag filtering, in agenda
8066 @cindex category filtering, in agenda
8067 @cindex effort filtering, in agenda
8068 @cindex query editing, in agenda
8070 @orgcmd{<,org-agenda-filter-by-category}
8071 @vindex org-agenda-category-filter-preset
8073 Filter the current agenda view with respect to the category of the item at
8074 point. Pressing @code{<} another time will remove this filter. You can add
8075 a filter preset through the option @code{org-agenda-category-filter-preset}
8078 @orgcmd{/,org-agenda-filter-by-tag}
8079 @vindex org-agenda-tag-filter-preset
8080 Filter the current agenda view with respect to a tag and/or effort estimates.
8081 The difference between this and a custom agenda command is that filtering is
8082 very fast, so that you can switch quickly between different filters without
8083 having to recreate the agenda.@footnote{Custom commands can preset a filter by
8084 binding the variable @code{org-agenda-tag-filter-preset} as an option. This
8085 filter will then be applied to the view and persist as a basic filter through
8086 refreshes and more secondary filtering. The filter is a global property of
8087 the entire agenda view---in a block agenda, you should only set this in the
8088 global options section, not in the section of an individual block.}
8090 You will be prompted for a tag selection letter; @key{SPC} will mean any tag at
8091 all. Pressing @key{TAB} at that prompt will offer use completion to select a
8092 tag (including any tags that do not have a selection character). The command
8093 then hides all entries that do not contain or inherit this tag. When called
8094 with prefix arg, remove the entries that @emph{do} have the tag. A second
8095 @kbd{/} at the prompt will turn off the filter and unhide any hidden entries.
8096 If the first key you press is either @kbd{+} or @kbd{-}, the previous filter
8097 will be narrowed by requiring or forbidding the selected additional tag.
8098 Instead of pressing @kbd{+} or @kbd{-} after @kbd{/}, you can also
8099 immediately use the @kbd{\} command.
8101 @vindex org-sort-agenda-noeffort-is-high
8102 In order to filter for effort estimates, you should set up allowed
8103 efforts globally, for example
8105 (setq org-global-properties
8106 '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
8108 You can then filter for an effort by first typing an operator, one of
8109 @kbd{<}, @kbd{>}, and @kbd{=}, and then the one-digit index of an effort
8110 estimate in your array of allowed values, where @kbd{0} means the 10th value.
8111 The filter will then restrict to entries with effort smaller-or-equal, equal,
8112 or larger-or-equal than the selected value. If the digits 0-9 are not used
8113 as fast access keys to tags, you can also simply press the index digit
8114 directly without an operator. In this case, @kbd{<} will be assumed. For
8115 application of the operator, entries without a defined effort will be treated
8116 according to the value of @code{org-sort-agenda-noeffort-is-high}. To filter
8117 for tasks without effort definition, press @kbd{?} as the operator.
8119 Org also supports automatic, context-aware tag filtering. If the variable
8120 @code{org-agenda-auto-exclude-function} is set to a user-defined function,
8121 that function can decide which tags should be excluded from the agenda
8122 automatically. Once this is set, the @kbd{/} command then accepts @kbd{RET}
8123 as a sub-option key and runs the auto exclusion logic. For example, let's
8124 say you use a @code{Net} tag to identify tasks which need network access, an
8125 @code{Errand} tag for errands in town, and a @code{Call} tag for making phone
8126 calls. You could auto-exclude these tags based on the availability of the
8127 Internet, and outside of business hours, with something like this:
8131 (defun org-my-auto-exclude-function (tag)
8133 ((string= tag "Net")
8134 (/= 0 (call-process "/sbin/ping" nil nil nil
8135 "-c1" "-q" "-t1" "mail.gnu.org")))
8136 ((or (string= tag "Errand") (string= tag "Call"))
8137 (let ((hour (nth 2 (decode-time))))
8138 (or (< hour 8) (> hour 21)))))
8141 (setq org-agenda-auto-exclude-function 'org-my-auto-exclude-function)
8145 @orgcmd{\\,org-agenda-filter-by-tag-refine}
8146 Narrow the current agenda filter by an additional condition. When called with
8147 prefix arg, remove the entries that @emph{do} have the tag, or that do match
8148 the effort criterion. You can achieve the same effect by pressing @kbd{+} or
8149 @kbd{-} as the first key after the @kbd{/} command.
8158 @item @r{in} search view
8159 add new search words (@kbd{[} and @kbd{]}) or new regular expressions
8160 (@kbd{@{} and @kbd{@}}) to the query string. The opening bracket/brace will
8161 add a positive search term prefixed by @samp{+}, indicating that this search
8162 term @i{must} occur/match in the entry. The closing bracket/brace will add a
8163 negative search term which @i{must not} occur/match in the entry for it to be
8167 @tsubheading{Remote editing}
8168 @cindex remote editing, from agenda
8173 @cindex undoing remote-editing events
8174 @cindex remote editing, undo
8175 @orgcmd{C-_,org-agenda-undo}
8176 Undo a change due to a remote editing command. The change is undone
8177 both in the agenda buffer and in the remote buffer.
8179 @orgcmd{t,org-agenda-todo}
8180 Change the TODO state of the item, both in the agenda and in the
8183 @orgcmd{C-S-@key{right},org-agenda-todo-nextset}
8184 @orgcmd{C-S-@key{left},org-agenda-todo-previousset}
8185 Switch to the next/previous set of TODO keywords.
8187 @orgcmd{C-k,org-agenda-kill}
8188 @vindex org-agenda-confirm-kill
8189 Delete the current agenda item along with the entire subtree belonging
8190 to it in the original Org file. If the text to be deleted remotely
8191 is longer than one line, the kill needs to be confirmed by the user. See
8192 variable @code{org-agenda-confirm-kill}.
8194 @orgcmd{C-c C-w,org-agenda-refile}
8195 Refile the entry at point.
8197 @orgcmdkskc{C-c C-x C-a,a,org-agenda-archive-default-with-confirmation}
8198 @vindex org-archive-default-command
8199 Archive the subtree corresponding to the entry at point using the default
8200 archiving command set in @code{org-archive-default-command}. When using the
8201 @code{a} key, confirmation will be required.
8203 @orgcmd{C-c C-x a,org-agenda-toggle-archive-tag}
8204 Toggle the ARCHIVE tag for the current headline.
8206 @orgcmd{C-c C-x A,org-agenda-archive-to-archive-sibling}
8207 Move the subtree corresponding to the current entry to its @emph{archive
8210 @orgcmdkskc{C-c C-x C-s,$,org-agenda-archive}
8211 Archive the subtree corresponding to the current headline. This means the
8212 entry will be moved to the configured archive location, most likely a
8215 @orgcmd{T,org-agenda-show-tags}
8216 @vindex org-agenda-show-inherited-tags
8217 Show all tags associated with the current item. This is useful if you have
8218 turned off @code{org-agenda-show-inherited-tags}, but still want to see all
8219 tags of a headline occasionally.
8221 @orgcmd{:,org-agenda-set-tags}
8222 Set tags for the current headline. If there is an active region in the
8223 agenda, change a tag for all headings in the region.
8227 Set the priority for the current item (@command{org-agenda-priority}).
8228 Org mode prompts for the priority character. If you reply with @key{SPC},
8229 the priority cookie is removed from the entry.
8231 @orgcmd{P,org-agenda-show-priority}
8232 Display weighted priority of current item.
8234 @orgcmdkkc{+,S-@key{up},org-agenda-priority-up}
8235 Increase the priority of the current item. The priority is changed in
8236 the original buffer, but the agenda is not resorted. Use the @kbd{r}
8239 @orgcmdkkc{-,S-@key{down},org-agenda-priority-down}
8240 Decrease the priority of the current item.
8242 @orgcmdkkc{z,C-c C-z,org-agenda-add-note}
8243 @vindex org-log-into-drawer
8244 Add a note to the entry. This note will be recorded, and then filed to the
8245 same location where state change notes are put. Depending on
8246 @code{org-log-into-drawer}, this may be inside a drawer.
8248 @orgcmd{C-c C-a,org-attach}
8249 Dispatcher for all command related to attachments.
8251 @orgcmd{C-c C-s,org-agenda-schedule}
8252 Schedule this item. With prefix arg remove the scheduling timestamp
8254 @orgcmd{C-c C-d,org-agenda-deadline}
8255 Set a deadline for this item. With prefix arg remove the deadline.
8257 @orgcmd{k,org-agenda-action}
8258 Agenda actions, to set dates for selected items to the cursor date.
8259 This command also works in the calendar! The command prompts for an
8262 m @r{Mark the entry at point for action. You can also make entries}
8263 @r{in Org files with @kbd{C-c C-x C-k}.}
8264 d @r{Set the deadline of the marked entry to the date at point.}
8265 s @r{Schedule the marked entry at the date at point.}
8266 r @r{Call @code{org-capture} with the cursor date as default date.}
8269 Press @kbd{r} afterward to refresh the agenda and see the effect of the
8272 @orgcmd{S-@key{right},org-agenda-do-date-later}
8273 Change the timestamp associated with the current line by one day into the
8274 future. If the date is in the past, the first call to this command will move
8276 With a numeric prefix argument, change it by that many days. For example,
8277 @kbd{3 6 5 S-@key{right}} will change it by a year. With a @kbd{C-u} prefix,
8278 change the time by one hour. If you immediately repeat the command, it will
8279 continue to change hours even without the prefix arg. With a double @kbd{C-u
8280 C-u} prefix, do the same for changing minutes.@*
8281 The stamp is changed in the original Org file, but the change is not directly
8282 reflected in the agenda buffer. Use @kbd{r} or @kbd{g} to update the buffer.
8284 @orgcmd{S-@key{left},org-agenda-do-date-earlier}
8285 Change the timestamp associated with the current line by one day
8288 @orgcmd{>,org-agenda-date-prompt}
8289 Change the timestamp associated with the current line. The key @kbd{>} has
8290 been chosen, because it is the same as @kbd{S-.} on my keyboard.
8292 @orgcmd{I,org-agenda-clock-in}
8293 Start the clock on the current item. If a clock is running already, it
8296 @orgcmd{O,org-agenda-clock-out}
8297 Stop the previously started clock.
8299 @orgcmd{X,org-agenda-clock-cancel}
8300 Cancel the currently running clock.
8302 @orgcmd{J,org-agenda-clock-goto}
8303 Jump to the running clock in another window.
8305 @tsubheading{Bulk remote editing selected entries}
8306 @cindex remote editing, bulk, from agenda
8308 @orgcmd{m,org-agenda-bulk-mark}
8309 Mark the entry at point for bulk action. With prefix arg, mark that many
8312 @orgcmd{%,org-agenda-bulk-mark-regexp}
8313 Mark entries matching a regular expression for bulk action.
8315 @orgcmd{u,org-agenda-bulk-unmark}
8316 Unmark entry for bulk action.
8318 @orgcmd{U,org-agenda-bulk-remove-all-marks}
8319 Unmark all marked entries for bulk action.
8321 @orgcmd{B,org-agenda-bulk-action}
8322 Bulk action: act on all marked entries in the agenda. This will prompt for
8323 another key to select the action to be applied. The prefix arg to @kbd{B}
8324 will be passed through to the @kbd{s} and @kbd{d} commands, to bulk-remove
8325 these special timestamps.
8327 r @r{Prompt for a single refile target and move all entries. The entries}
8328 @r{will no longer be in the agenda; refresh (@kbd{g}) to bring them back.}
8329 $ @r{Archive all selected entries.}
8330 A @r{Archive entries by moving them to their respective archive siblings.}
8331 t @r{Change TODO state. This prompts for a single TODO keyword and}
8332 @r{changes the state of all selected entries, bypassing blocking and}
8333 @r{suppressing logging notes (but not timestamps).}
8334 + @r{Add a tag to all selected entries.}
8335 - @r{Remove a tag from all selected entries.}
8336 s @r{Schedule all items to a new date. To shift existing schedule dates}
8337 @r{by a fixed number of days, use something starting with double plus}
8338 @r{at the prompt, for example @samp{++8d} or @samp{++2w}.}
8339 S @r{Reschedule randomly into the coming N days. N will be prompted for.}
8340 @r{With prefix arg (@kbd{C-u B S}), scatter only across weekdays.}
8341 d @r{Set deadline to a specific date.}
8342 f @r{Apply a function to marked entries.}
8343 @r{For example, the function below sets the CATEGORY property of the}
8345 @r{(defun set-category ()}
8346 @r{ (interactive "P")}
8347 @r{ (let* ((marker (or (org-get-at-bol 'org-hd-marker)}
8348 @r{ (org-agenda-error)))}
8349 @r{ (buffer (marker-buffer marker)))}
8350 @r{ (with-current-buffer buffer}
8351 @r{ (save-excursion}
8352 @r{ (save-restriction}
8354 @r{ (goto-char marker)}
8355 @r{ (org-back-to-heading t)}
8356 @r{ (org-set-property "CATEGORY" "web"))))))}
8360 @tsubheading{Calendar commands}
8361 @cindex calendar commands, from agenda
8363 @orgcmd{c,org-agenda-goto-calendar}
8364 Open the Emacs calendar and move to the date at the agenda cursor.
8366 @orgcmd{c,org-calendar-goto-agenda}
8367 When in the calendar, compute and show the Org mode agenda for the
8370 @cindex diary entries, creating from agenda
8371 @orgcmd{i,org-agenda-diary-entry}
8372 @vindex org-agenda-diary-file
8373 Insert a new entry into the diary, using the date at the cursor and (for
8374 block entries) the date at the mark. This will add to the Emacs diary
8375 file@footnote{This file is parsed for the agenda when
8376 @code{org-agenda-include-diary} is set.}, in a way similar to the @kbd{i}
8377 command in the calendar. The diary file will pop up in another window, where
8378 you can add the entry.
8380 If you configure @code{org-agenda-diary-file} to point to an Org mode file,
8381 Org will create entries (in Org mode syntax) in that file instead. Most
8382 entries will be stored in a date-based outline tree that will later make it
8383 easy to archive appointments from previous months/years. The tree will be
8384 built under an entry with a @code{DATE_TREE} property, or else with years as
8385 top-level entries. Emacs will prompt you for the entry text---if you specify
8386 it, the entry will be created in @code{org-agenda-diary-file} without further
8387 interaction. If you directly press @key{RET} at the prompt without typing
8388 text, the target file will be shown in another window for you to finish the
8389 entry there. See also the @kbd{k r} command.
8391 @orgcmd{M,org-agenda-phases-of-moon}
8392 Show the phases of the moon for the three months around current date.
8394 @orgcmd{S,org-agenda-sunrise-sunset}
8395 Show sunrise and sunset times. The geographical location must be set
8396 with calendar variables, see the documentation for the Emacs calendar.
8398 @orgcmd{C,org-agenda-convert-date}
8399 Convert the date at cursor into many other cultural and historic
8402 @orgcmd{H,org-agenda-holidays}
8403 Show holidays for three months around the cursor date.
8405 @item M-x org-export-icalendar-combine-agenda-files
8406 Export a single iCalendar file containing entries from all agenda files.
8407 This is a globally available command, and also available in the agenda menu.
8409 @tsubheading{Exporting to a file}
8410 @orgcmd{C-x C-w,org-write-agenda}
8411 @cindex exporting agenda views
8412 @cindex agenda views, exporting
8413 @vindex org-agenda-exporter-settings
8414 Write the agenda view to a file. Depending on the extension of the selected
8415 file name, the view will be exported as HTML (extension @file{.html} or
8416 @file{.htm}), Postscript (extension @file{.ps}), PDF (extension @file{.pdf}),
8417 and plain text (any other extension). When called with a @kbd{C-u} prefix
8418 argument, immediately open the newly created file. Use the variable
8419 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
8420 for @file{htmlize} to be used during export.
8422 @tsubheading{Quit and Exit}
8423 @orgcmd{q,org-agenda-quit}
8424 Quit agenda, remove the agenda buffer.
8426 @cindex agenda files, removing buffers
8427 @orgcmd{x,org-agenda-exit}
8428 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
8429 for the compilation of the agenda. Buffers created by the user to
8430 visit Org files will not be removed.
8434 @node Custom agenda views, Exporting Agenda Views, Agenda commands, Agenda Views
8435 @section Custom agenda views
8436 @cindex custom agenda views
8437 @cindex agenda views, custom
8439 Custom agenda commands serve two purposes: to store and quickly access
8440 frequently used TODO and tags searches, and to create special composite
8441 agenda buffers. Custom agenda commands will be accessible through the
8442 dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
8445 * Storing searches:: Type once, use often
8446 * Block agenda:: All the stuff you need in a single buffer
8447 * Setting Options:: Changing the rules
8450 @node Storing searches, Block agenda, Custom agenda views, Custom agenda views
8451 @subsection Storing searches
8453 The first application of custom searches is the definition of keyboard
8454 shortcuts for frequently used searches, either creating an agenda
8455 buffer, or a sparse tree (the latter covering of course only the current
8458 @vindex org-agenda-custom-commands
8459 Custom commands are configured in the variable
8460 @code{org-agenda-custom-commands}. You can customize this variable, for
8461 example by pressing @kbd{C-c a C}. You can also directly set it with
8462 Emacs Lisp in @file{.emacs}. The following example contains all valid
8467 (setq org-agenda-custom-commands
8468 '(("w" todo "WAITING")
8469 ("W" todo-tree "WAITING")
8470 ("u" tags "+boss-urgent")
8471 ("v" tags-todo "+boss-urgent")
8472 ("U" tags-tree "+boss-urgent")
8473 ("f" occur-tree "\\<FIXME\\>")
8474 ("h" . "HOME+Name tags searches") ; description for "h" prefix
8475 ("hl" tags "+home+Lisa")
8476 ("hp" tags "+home+Peter")
8477 ("hk" tags "+home+Kim")))
8482 The initial string in each entry defines the keys you have to press
8483 after the dispatcher command @kbd{C-c a} in order to access the command.
8484 Usually this will be just a single character, but if you have many
8485 similar commands, you can also define two-letter combinations where the
8486 first character is the same in several combinations and serves as a
8487 prefix key@footnote{You can provide a description for a prefix key by
8488 inserting a cons cell with the prefix and the description.}. The second
8489 parameter is the search type, followed by the string or regular
8490 expression to be used for the matching. The example above will
8495 as a global search for TODO entries with @samp{WAITING} as the TODO
8498 as the same search, but only in the current buffer and displaying the
8499 results as a sparse tree
8501 as a global tags search for headlines marked @samp{:boss:} but not
8504 as the same search as @kbd{C-c a u}, but limiting the search to
8505 headlines that are also TODO items
8507 as the same search as @kbd{C-c a u}, but only in the current buffer and
8508 displaying the result as a sparse tree
8510 to create a sparse tree (again: current buffer only) with all entries
8511 containing the word @samp{FIXME}
8513 as a prefix command for a HOME tags search where you have to press an
8514 additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
8515 Peter, or Kim) as additional tag to match.
8518 @node Block agenda, Setting Options, Storing searches, Custom agenda views
8519 @subsection Block agenda
8520 @cindex block agenda
8521 @cindex agenda, with block views
8523 Another possibility is the construction of agenda views that comprise
8524 the results of @emph{several} commands, each of which creates a block in
8525 the agenda buffer. The available commands include @code{agenda} for the
8526 daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
8527 for the global TODO list (as constructed with @kbd{C-c a t}), and the
8528 matching commands discussed above: @code{todo}, @code{tags}, and
8529 @code{tags-todo}. Here are two examples:
8533 (setq org-agenda-custom-commands
8534 '(("h" "Agenda and Home-related tasks"
8538 ("o" "Agenda and Office-related tasks"
8546 This will define @kbd{C-c a h} to create a multi-block view for stuff
8547 you need to attend to at home. The resulting agenda buffer will contain
8548 your agenda for the current week, all TODO items that carry the tag
8549 @samp{home}, and also all lines tagged with @samp{garden}. Finally the
8550 command @kbd{C-c a o} provides a similar view for office tasks.
8552 @node Setting Options, , Block agenda, Custom agenda views
8553 @subsection Setting options for custom commands
8554 @cindex options, for custom agenda views
8556 @vindex org-agenda-custom-commands
8557 Org mode contains a number of variables regulating agenda construction
8558 and display. The global variables define the behavior for all agenda
8559 commands, including the custom commands. However, if you want to change
8560 some settings just for a single custom view, you can do so. Setting
8561 options requires inserting a list of variable names and values at the
8562 right spot in @code{org-agenda-custom-commands}. For example:
8566 (setq org-agenda-custom-commands
8567 '(("w" todo "WAITING"
8568 ((org-agenda-sorting-strategy '(priority-down))
8569 (org-agenda-prefix-format " Mixed: ")))
8570 ("U" tags-tree "+boss-urgent"
8571 ((org-show-following-heading nil)
8572 (org-show-hierarchy-above nil)))
8574 ((org-agenda-files '("~org/notes.org"))
8575 (org-agenda-text-search-extra-files nil)))))
8580 Now the @kbd{C-c a w} command will sort the collected entries only by
8581 priority, and the prefix format is modified to just say @samp{ Mixed: }
8582 instead of giving the category of the entry. The sparse tags tree of
8583 @kbd{C-c a U} will now turn out ultra-compact, because neither the
8584 headline hierarchy above the match, nor the headline following the match
8585 will be shown. The command @kbd{C-c a N} will do a text search limited
8586 to only a single file.
8588 @vindex org-agenda-custom-commands
8589 For command sets creating a block agenda,
8590 @code{org-agenda-custom-commands} has two separate spots for setting
8591 options. You can add options that should be valid for just a single
8592 command in the set, and options that should be valid for all commands in
8593 the set. The former are just added to the command entry; the latter
8594 must come after the list of command entries. Going back to the block
8595 agenda example (@pxref{Block agenda}), let's change the sorting strategy
8596 for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
8597 the results for GARDEN tags query in the opposite order,
8598 @code{priority-up}. This would look like this:
8602 (setq org-agenda-custom-commands
8603 '(("h" "Agenda and Home-related tasks"
8607 ((org-agenda-sorting-strategy '(priority-up)))))
8608 ((org-agenda-sorting-strategy '(priority-down))))
8609 ("o" "Agenda and Office-related tasks"
8616 As you see, the values and parentheses setting is a little complex.
8617 When in doubt, use the customize interface to set this variable---it
8618 fully supports its structure. Just one caveat: when setting options in
8619 this interface, the @emph{values} are just Lisp expressions. So if the
8620 value is a string, you need to add the double-quotes around the value
8624 @node Exporting Agenda Views, Agenda column view, Custom agenda views, Agenda Views
8625 @section Exporting Agenda Views
8626 @cindex agenda views, exporting
8628 If you are away from your computer, it can be very useful to have a printed
8629 version of some agenda views to carry around. Org mode can export custom
8630 agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's
8631 @file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the
8632 ghostscript @file{ps2pdf} utility must be installed on the system. Selecting
8633 a PDF file will also create the postscript file.}, and iCalendar files. If
8634 you want to do this only occasionally, use the command
8637 @orgcmd{C-x C-w,org-write-agenda}
8638 @cindex exporting agenda views
8639 @cindex agenda views, exporting
8640 @vindex org-agenda-exporter-settings
8641 Write the agenda view to a file. Depending on the extension of the selected
8642 file name, the view will be exported as HTML (extension @file{.html} or
8643 @file{.htm}), Postscript (extension @file{.ps}), iCalendar (extension
8644 @file{.ics}), or plain text (any other extension). Use the variable
8645 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
8646 for @file{htmlize} to be used during export, for example
8648 @vindex org-agenda-add-entry-text-maxlines
8649 @vindex htmlize-output-type
8650 @vindex ps-number-of-columns
8651 @vindex ps-landscape-mode
8653 (setq org-agenda-exporter-settings
8654 '((ps-number-of-columns 2)
8655 (ps-landscape-mode t)
8656 (org-agenda-add-entry-text-maxlines 5)
8657 (htmlize-output-type 'css)))
8661 If you need to export certain agenda views frequently, you can associate
8662 any custom agenda command with a list of output file names
8663 @footnote{If you want to store standard views like the weekly agenda
8664 or the global TODO list as well, you need to define custom commands for
8665 them in order to be able to specify file names.}. Here is an example
8666 that first defines custom commands for the agenda and the global
8667 TODO list, together with a number of files to which to export them.
8668 Then we define two block agenda commands and specify file names for them
8669 as well. File names can be relative to the current working directory,
8674 (setq org-agenda-custom-commands
8675 '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
8676 ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
8677 ("h" "Agenda and Home-related tasks"
8682 ("~/views/home.html"))
8683 ("o" "Agenda and Office-related tasks"
8688 ("~/views/office.ps" "~/calendars/office.ics"))))
8692 The extension of the file name determines the type of export. If it is
8693 @file{.html}, Org mode will use the @file{htmlize.el} package to convert
8694 the buffer to HTML and save it to this file name. If the extension is
8695 @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
8696 Postscript output. If the extension is @file{.ics}, iCalendar export is
8697 run export over all files that were used to construct the agenda, and
8698 limit the export to entries listed in the agenda. Any other
8699 extension produces a plain ASCII file.
8701 The export files are @emph{not} created when you use one of those
8702 commands interactively because this might use too much overhead.
8703 Instead, there is a special command to produce @emph{all} specified
8707 @orgcmd{C-c a e,org-store-agenda-views}
8708 Export all agenda views that have export file names associated with
8712 You can use the options section of the custom agenda commands to also
8713 set options for the export commands. For example:
8716 (setq org-agenda-custom-commands
8718 ((ps-number-of-columns 2)
8719 (ps-landscape-mode t)
8720 (org-agenda-prefix-format " [ ] ")
8721 (org-agenda-with-colors nil)
8722 (org-agenda-remove-tags t))
8727 This command sets two options for the Postscript exporter, to make it
8728 print in two columns in landscape format---the resulting page can be cut
8729 in two and then used in a paper agenda. The remaining settings modify
8730 the agenda prefix to omit category and scheduling information, and
8731 instead include a checkbox to check off items. We also remove the tags
8732 to make the lines compact, and we don't want to use colors for the
8733 black-and-white printer. Settings specified in
8734 @code{org-agenda-exporter-settings} will also apply, but the settings
8735 in @code{org-agenda-custom-commands} take precedence.
8738 From the command line you may also use
8740 emacs -eval (org-batch-store-agenda-views) -kill
8743 or, if you need to modify some parameters@footnote{Quoting depends on the
8744 system you use, please check the FAQ for examples.}
8746 emacs -eval '(org-batch-store-agenda-views \
8747 org-agenda-span (quote month) \
8748 org-agenda-start-day "2007-11-01" \
8749 org-agenda-include-diary nil \
8750 org-agenda-files (quote ("~/org/project.org")))' \
8754 which will create the agenda views restricted to the file
8755 @file{~/org/project.org}, without diary entries and with a 30-day
8758 You can also extract agenda information in a way that allows further
8759 processing by other programs. See @ref{Extracting agenda information}, for
8763 @node Agenda column view, , Exporting Agenda Views, Agenda Views
8764 @section Using column view in the agenda
8765 @cindex column view, in agenda
8766 @cindex agenda, column view
8768 Column view (@pxref{Column view}) is normally used to view and edit
8769 properties embedded in the hierarchical structure of an Org file. It can be
8770 quite useful to use column view also from the agenda, where entries are
8771 collected by certain criteria.
8774 @orgcmd{C-c C-x C-c,org-agenda-columns}
8775 Turn on column view in the agenda.
8778 To understand how to use this properly, it is important to realize that the
8779 entries in the agenda are no longer in their proper outline environment.
8780 This causes the following issues:
8784 @vindex org-columns-default-format
8785 @vindex org-overriding-columns-format
8786 Org needs to make a decision which @code{COLUMNS} format to use. Since the
8787 entries in the agenda are collected from different files, and different files
8788 may have different @code{COLUMNS} formats, this is a non-trivial problem.
8789 Org first checks if the variable @code{org-agenda-overriding-columns-format} is
8790 currently set, and if so, takes the format from there. Otherwise it takes
8791 the format associated with the first item in the agenda, or, if that item
8792 does not have a specific format (defined in a property, or in its file), it
8793 uses @code{org-columns-default-format}.
8795 @cindex property, special, CLOCKSUM
8796 If any of the columns has a summary type defined (@pxref{Column attributes}),
8797 turning on column view in the agenda will visit all relevant agenda files and
8798 make sure that the computations of this property are up to date. This is
8799 also true for the special @code{CLOCKSUM} property. Org will then sum the
8800 values displayed in the agenda. In the daily/weekly agenda, the sums will
8801 cover a single day; in all other views they cover the entire block. It is
8802 vital to realize that the agenda may show the same entry @emph{twice} (for
8803 example as scheduled and as a deadline), and it may show two entries from the
8804 same hierarchy (for example a @emph{parent} and its @emph{child}). In these
8805 cases, the summation in the agenda will lead to incorrect results because
8806 some values will count double.
8808 When the column view in the agenda shows the @code{CLOCKSUM}, that is always
8809 the entire clocked time for this item. So even in the daily/weekly agenda,
8810 the clocksum listed in column view may originate from times outside the
8811 current view. This has the advantage that you can compare these values with
8812 a column listing the planned total effort for a task---one of the major
8813 applications for column view in the agenda. If you want information about
8814 clocked time in the displayed period use clock table mode (press @kbd{R} in
8819 @node Markup, Exporting, Agenda Views, Top
8820 @chapter Markup for rich export
8822 When exporting Org mode documents, the exporter tries to reflect the
8823 structure of the document as accurately as possible in the backend. Since
8824 export targets like HTML, @LaTeX{}, or DocBook allow much richer formatting,
8825 Org mode has rules on how to prepare text for rich export. This section
8826 summarizes the markup rules used in an Org mode buffer.
8829 * Structural markup elements:: The basic structure as seen by the exporter
8830 * Images and tables:: Tables and Images will be included
8831 * Literal examples:: Source code examples with special formatting
8832 * Include files:: Include additional files into a document
8833 * Index entries:: Making an index
8834 * Macro replacement:: Use macros to create complex output
8835 * Embedded @LaTeX{}:: LaTeX can be freely used inside Org documents
8838 @node Structural markup elements, Images and tables, Markup, Markup
8839 @section Structural markup elements
8842 * Document title:: Where the title is taken from
8843 * Headings and sections:: The document structure as seen by the exporter
8844 * Table of contents:: The if and where of the table of contents
8845 * Initial text:: Text before the first heading?
8847 * Paragraphs:: Paragraphs
8848 * Footnote markup:: Footnotes
8849 * Emphasis and monospace:: Bold, italic, etc.
8850 * Horizontal rules:: Make a line
8851 * Comment lines:: What will *not* be exported
8854 @node Document title, Headings and sections, Structural markup elements, Structural markup elements
8855 @subheading Document title
8856 @cindex document title, markup rules
8859 The title of the exported document is taken from the special line
8863 #+TITLE: This is the title of the document
8867 If this line does not exist, the title is derived from the first non-empty,
8868 non-comment line in the buffer. If no such line exists, or if you have
8869 turned off exporting of the text before the first headline (see below), the
8870 title will be the file name without extension.
8872 @cindex property, EXPORT_TITLE
8873 If you are exporting only a subtree by marking is as the region, the heading
8874 of the subtree will become the title of the document. If the subtree has a
8875 property @code{EXPORT_TITLE}, that will take precedence.
8877 @node Headings and sections, Table of contents, Document title, Structural markup elements
8878 @subheading Headings and sections
8879 @cindex headings and sections, markup rules
8881 @vindex org-export-headline-levels
8882 The outline structure of the document as described in @ref{Document
8883 Structure}, forms the basis for defining sections of the exported document.
8884 However, since the outline structure is also used for (for example) lists of
8885 tasks, only the first three outline levels will be used as headings. Deeper
8886 levels will become itemized lists. You can change the location of this
8887 switch globally by setting the variable @code{org-export-headline-levels}, or on a
8888 per-file basis with a line
8895 @node Table of contents, Initial text, Headings and sections, Structural markup elements
8896 @subheading Table of contents
8897 @cindex table of contents, markup rules
8899 @vindex org-export-with-toc
8900 The table of contents is normally inserted directly before the first headline
8901 of the file. If you would like to get it to a different location, insert the
8902 string @code{[TABLE-OF-CONTENTS]} on a line by itself at the desired
8903 location. The depth of the table of contents is by default the same as the
8904 number of headline levels, but you can choose a smaller number, or turn off
8905 the table of contents entirely, by configuring the variable
8906 @code{org-export-with-toc}, or on a per-file basis with a line like
8909 #+OPTIONS: toc:2 (only to two levels in TOC)
8910 #+OPTIONS: toc:nil (no TOC at all)
8913 @node Initial text, Lists, Table of contents, Structural markup elements
8914 @subheading Text before the first headline
8915 @cindex text before first headline, markup rules
8918 Org mode normally exports the text before the first headline, and even uses
8919 the first line as the document title. The text will be fully marked up. If
8920 you need to include literal HTML, @LaTeX{}, or DocBook code, use the special
8921 constructs described below in the sections for the individual exporters.
8923 @vindex org-export-skip-text-before-1st-heading
8924 Some people like to use the space before the first headline for setup and
8925 internal links and therefore would like to control the exported text before
8926 the first headline in a different way. You can do so by setting the variable
8927 @code{org-export-skip-text-before-1st-heading} to @code{t}. On a per-file
8928 basis, you can get the same effect with @samp{#+OPTIONS: skip:t}.
8931 If you still want to have some text before the first headline, use the
8932 @code{#+TEXT} construct:
8936 #+TEXT: This text will go before the *first* headline.
8937 #+TEXT: [TABLE-OF-CONTENTS]
8938 #+TEXT: This goes between the table of contents and the *first* headline
8941 @node Lists, Paragraphs, Initial text, Structural markup elements
8943 @cindex lists, markup rules
8945 Plain lists as described in @ref{Plain lists}, are translated to the backend's
8946 syntax for such lists. Most backends support unordered, ordered, and
8949 @node Paragraphs, Footnote markup, Lists, Structural markup elements
8950 @subheading Paragraphs, line breaks, and quoting
8951 @cindex paragraphs, markup rules
8953 Paragraphs are separated by at least one empty line. If you need to enforce
8954 a line break within a paragraph, use @samp{\\} at the end of a line.
8956 To keep the line breaks in a region, but otherwise use normal formatting, you
8957 can use this construct, which can also be used to format poetry.
8959 @cindex #+BEGIN_VERSE
8962 Great clouds overhead
8963 Tiny black birds rise and fall
8970 When quoting a passage from another document, it is customary to format this
8971 as a paragraph that is indented on both the left and the right margin. You
8972 can include quotations in Org mode documents like this:
8974 @cindex #+BEGIN_QUOTE
8977 Everything should be made as simple as possible,
8978 but not any simpler -- Albert Einstein
8982 If you would like to center some text, do it like this:
8983 @cindex #+BEGIN_CENTER
8986 Everything should be made as simple as possible, \\
8992 @node Footnote markup, Emphasis and monospace, Paragraphs, Structural markup elements
8993 @subheading Footnote markup
8994 @cindex footnotes, markup rules
8995 @cindex @file{footnote.el}
8997 Footnotes defined in the way described in @ref{Footnotes}, will be exported
8998 by all backends. Org allows multiple references to the same note, and
8999 multiple footnotes side by side.
9001 @node Emphasis and monospace, Horizontal rules, Footnote markup, Structural markup elements
9002 @subheading Emphasis and monospace
9004 @cindex underlined text, markup rules
9005 @cindex bold text, markup rules
9006 @cindex italic text, markup rules
9007 @cindex verbatim text, markup rules
9008 @cindex code text, markup rules
9009 @cindex strike-through text, markup rules
9010 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=}
9011 and @code{~verbatim~}, and, if you must, @samp{+strike-through+}. Text
9012 in the code and verbatim string is not processed for Org mode specific
9013 syntax; it is exported verbatim.
9015 @node Horizontal rules, Comment lines, Emphasis and monospace, Structural markup elements
9016 @subheading Horizontal rules
9017 @cindex horizontal rules, markup rules
9018 A line consisting of only dashes, and at least 5 of them, will be exported as
9019 a horizontal line (@samp{<hr/>} in HTML and @code{\hrule} in @LaTeX{}).
9021 @node Comment lines, , Horizontal rules, Structural markup elements
9022 @subheading Comment lines
9023 @cindex comment lines
9024 @cindex exporting, not
9025 @cindex #+BEGIN_COMMENT
9027 Lines starting with @samp{#} in column zero are treated as comments and will
9028 never be exported. If you want an indented line to be treated as a comment,
9029 start it with @samp{#+ }. Also entire subtrees starting with the word
9030 @samp{COMMENT} will never be exported. Finally, regions surrounded by
9031 @samp{#+BEGIN_COMMENT} ... @samp{#+END_COMMENT} will not be exported.
9036 Toggle the COMMENT keyword at the beginning of an entry.
9040 @node Images and tables, Literal examples, Structural markup elements, Markup
9041 @section Images and Tables
9043 @cindex tables, markup rules
9046 Both the native Org mode tables (@pxref{Tables}) and tables formatted with
9047 the @file{table.el} package will be exported properly. For Org mode tables,
9048 the lines before the first horizontal separator line will become table header
9049 lines. You can use the following lines somewhere before the table to assign
9050 a caption and a label for cross references, and in the text you can refer to
9051 the object with @code{\ref@{tab:basic-data@}}:
9054 #+CAPTION: This is the caption for the next table (or link)
9055 #+LABEL: tab:basic-data
9060 Optionally, the caption can take the form:
9062 #+CAPTION: [Caption for list of figures]@{Caption for table (or link).@}
9065 @cindex inlined images, markup rules
9066 Some backends (HTML, @LaTeX{}, and DocBook) allow you to directly include
9067 images into the exported document. Org does this, if a link to an image
9068 files does not have a description part, for example @code{[[./img/a.jpg]]}.
9069 If you wish to define a caption for the image and maybe a label for internal
9070 cross references, make sure that the link is on a line by itself and precede
9071 it with @code{#+CAPTION} and @code{#+LABEL} as follows:
9074 #+CAPTION: This is the caption for the next figure link (or table)
9075 #+LABEL: fig:SED-HR4049
9079 You may also define additional attributes for the figure. As this is
9080 backend-specific, see the sections about the individual backends for more
9083 @xref{Handling links,the discussion of image links}.
9085 @node Literal examples, Include files, Images and tables, Markup
9086 @section Literal examples
9087 @cindex literal examples, markup rules
9088 @cindex code line references, markup rules
9090 You can include literal examples that should not be subjected to
9091 markup. Such examples will be typeset in monospace, so this is well suited
9092 for source code and similar examples.
9093 @cindex #+BEGIN_EXAMPLE
9097 Some example from a text file.
9101 Note that such blocks may be @i{indented} in order to align nicely with
9102 indented text and in particular with plain list structure (@pxref{Plain
9103 lists}). For simplicity when using small examples, you can also start the
9104 example lines with a colon followed by a space. There may also be additional
9105 whitespace before the colon:
9109 : Some example from a text file.
9112 @cindex formatting source code, markup rules
9113 If the example is source code from a programming language, or any other text
9114 that can be marked up by font-lock in Emacs, you can ask for the example to
9115 look like the fontified Emacs buffer@footnote{This works automatically for
9116 the HTML backend (it requires version 1.34 of the @file{htmlize.el} package,
9117 which is distributed with Org). Fontified code chunks in @LaTeX{} can be
9118 achieved using either the listings or the
9119 @url{http://code.google.com/p/minted, minted,} package. To use listings, turn
9120 on the variable @code{org-export-latex-listings} and ensure that the listings
9121 package is included by the @LaTeX{} header (e.g.@: by configuring
9122 @code{org-export-latex-packages-alist}). See the listings documentation for
9123 configuration options, including obtaining colored output. For minted it is
9124 necessary to install the program @url{http://pygments.org, pygments}, in
9125 addition to setting @code{org-export-latex-minted}, ensuring that the minted
9126 package is included by the @LaTeX{} header, and ensuring that the
9127 @code{-shell-escape} option is passed to @file{pdflatex} (see
9128 @code{org-latex-to-pdf-process}). See the documentation of the variables
9129 @code{org-export-latex-listings} and @code{org-export-latex-minted} for
9130 further details.}. This is done with the @samp{src} block, where you also
9131 need to specify the name of the major mode that should be used to fontify the
9132 example@footnote{Code in @samp{src} blocks may also be evaluated either
9133 interactively or on export. See @pxref{Working With Source Code} for more
9134 information on evaluating code blocks.}, see @ref{Easy Templates} for
9135 shortcuts to easily insert code blocks.
9139 #+BEGIN_SRC emacs-lisp
9140 (defun org-xor (a b)
9146 Both in @code{example} and in @code{src} snippets, you can add a @code{-n}
9147 switch to the end of the @code{BEGIN} line, to get the lines of the example
9148 numbered. If you use a @code{+n} switch, the numbering from the previous
9149 numbered snippet will be continued in the current one. In literal examples,
9150 Org will interpret strings like @samp{(ref:name)} as labels, and use them as
9151 targets for special hyperlinks like @code{[[(name)]]} (i.e.@: the reference name
9152 enclosed in single parenthesis). In HTML, hovering the mouse over such a
9153 link will remote-highlight the corresponding code line, which is kind of
9156 You can also add a @code{-r} switch which @i{removes} the labels from the
9157 source code@footnote{Adding @code{-k} to @code{-n -r} will @i{keep} the
9158 labels in the source code while using line numbers for the links, which might
9159 be useful to explain those in an Org mode example code.}. With the @code{-n}
9160 switch, links to these references will be labeled by the line numbers from
9161 the code listing, otherwise links will use the labels with no parentheses.
9165 #+BEGIN_SRC emacs-lisp -n -r
9166 (save-excursion (ref:sc)
9167 (goto-char (point-min)) (ref:jump)
9169 In line [[(sc)]] we remember the current position. [[(jump)][Line (jump)]]
9173 @vindex org-coderef-label-format
9174 If the syntax for the label format conflicts with the language syntax, use a
9175 @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
9176 -n -r -l "((%s))"}. See also the variable @code{org-coderef-label-format}.
9178 HTML export also allows examples to be published as text areas (@pxref{Text
9179 areas in HTML export}).
9181 Because the @code{#+BEGIN_...} and @code{#+END_...} patterns need to be added
9182 so often, shortcuts are provided using the Easy Templates facility
9183 (@pxref{Easy Templates}).
9188 Edit the source code example at point in its native mode. This works by
9189 switching to a temporary buffer with the source code. You need to exit by
9190 pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*}
9191 or @samp{#} will get a comma prepended, to keep them from being interpreted
9192 by Org as outline nodes or special comments. These commas will be stripped
9193 for editing with @kbd{C-c '}, and also for export.}. The edited version will
9194 then replace the old version in the Org buffer. Fixed-width regions
9195 (where each line starts with a colon followed by a space) will be edited
9196 using @code{artist-mode}@footnote{You may select a different-mode with the
9197 variable @code{org-edit-fixed-width-region-mode}.} to allow creating ASCII
9198 drawings easily. Using this command in an empty line will create a new
9202 Calling @code{org-store-link} while editing a source code example in a
9203 temporary buffer created with @kbd{C-c '} will prompt for a label. Make sure
9204 that it is unique in the current buffer, and insert it with the proper
9205 formatting like @samp{(ref:label)} at the end of the current line. Then the
9206 label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
9210 @node Include files, Index entries, Literal examples, Markup
9211 @section Include files
9212 @cindex include files, markup rules
9214 During export, you can include the content of another file. For example, to
9215 include your @file{.emacs} file, you could use:
9219 #+INCLUDE: "~/.emacs" src emacs-lisp
9222 The optional second and third parameter are the markup (e.g.@: @samp{quote},
9223 @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the
9224 language for formatting the contents. The markup is optional; if it is not
9225 given, the text will be assumed to be in Org mode format and will be
9226 processed normally. The include line will also allow additional keyword
9227 parameters @code{:prefix1} and @code{:prefix} to specify prefixes for the
9228 first line and for each following line, @code{:minlevel} in order to get
9229 Org mode content demoted to a specified level, as well as any options
9230 accepted by the selected markup. For example, to include a file as an item,
9234 #+INCLUDE: "~/snippets/xx" :prefix1 " + " :prefix " "
9237 You can also include a portion of a file by specifying a lines range using
9238 the @code{:lines} parameter. The line at the upper end of the range will not
9239 be included. The start and/or the end of the range may be omitted to use the
9243 #+INCLUDE: "~/.emacs" :lines "5-10" @r{Include lines 5 to 10, 10 excluded}
9244 #+INCLUDE: "~/.emacs" :lines "-10" @r{Include lines 1 to 10, 10 excluded}
9245 #+INCLUDE: "~/.emacs" :lines "10-" @r{Include lines from 10 to EOF}
9251 Visit the include file at point.
9254 @node Index entries, Macro replacement, Include files, Markup
9255 @section Index entries
9256 @cindex index entries, for publishing
9258 You can specify entries that will be used for generating an index during
9259 publishing. This is done by lines starting with @code{#+INDEX}. An entry
9260 the contains an exclamation mark will create a sub item. See @ref{Generating
9261 an index} for more information.
9266 #+INDEX: Application!CV
9272 @node Macro replacement, Embedded @LaTeX{}, Index entries, Markup
9273 @section Macro replacement
9274 @cindex macro replacement, during export
9277 You can define text snippets with
9280 #+MACRO: name replacement text $1, $2 are arguments
9283 @noindent which can be referenced anywhere in the document (even in
9284 code examples) with @code{@{@{@{name(arg1,arg2)@}@}@}}. In addition to
9285 defined macros, @code{@{@{@{title@}@}@}}, @code{@{@{@{author@}@}@}}, etc.,
9286 will reference information set by the @code{#+TITLE:}, @code{#+AUTHOR:}, and
9287 similar lines. Also, @code{@{@{@{date(@var{FORMAT})@}@}@}} and
9288 @code{@{@{@{modification-time(@var{FORMAT})@}@}@}} refer to current date time
9289 and to the modification time of the file being exported, respectively.
9290 @var{FORMAT} should be a format string understood by
9291 @code{format-time-string}.
9293 Macro expansion takes place during export, and some people use it to
9294 construct complex HTML code.
9297 @node Embedded @LaTeX{}, , Macro replacement, Markup
9298 @section Embedded @LaTeX{}
9299 @cindex @TeX{} interpretation
9300 @cindex @LaTeX{} interpretation
9302 Plain ASCII is normally sufficient for almost all note taking. Exceptions
9303 include scientific notes, which often require mathematical symbols and the
9304 occasional formula. @LaTeX{}@footnote{@LaTeX{} is a macro system based on
9305 Donald E. Knuth's @TeX{} system. Many of the features described here as
9306 ``@LaTeX{}'' are really from @TeX{}, but for simplicity I am blurring this
9307 distinction.} is widely used to typeset scientific documents. Org mode
9308 supports embedding @LaTeX{} code into its files, because many academics are
9309 used to writing and reading @LaTeX{} source code, and because it can be
9310 readily processed to produce pretty output for a number of export backends.
9313 * Special symbols:: Greek letters and other symbols
9314 * Subscripts and superscripts:: Simple syntax for raising/lowering text
9315 * @LaTeX{} fragments:: Complex formulas made easy
9316 * Previewing @LaTeX{} fragments:: What will this snippet look like?
9317 * CDLaTeX mode:: Speed up entering of formulas
9320 @node Special symbols, Subscripts and superscripts, Embedded @LaTeX{}, Embedded @LaTeX{}
9321 @subsection Special symbols
9322 @cindex math symbols
9323 @cindex special symbols
9324 @cindex @TeX{} macros
9325 @cindex @LaTeX{} fragments, markup rules
9326 @cindex HTML entities
9327 @cindex @LaTeX{} entities
9329 You can use @LaTeX{} macros to insert special symbols like @samp{\alpha} to
9330 indicate the Greek letter, or @samp{\to} to indicate an arrow. Completion
9331 for these macros is available, just type @samp{\} and maybe a few letters,
9332 and press @kbd{M-@key{TAB}} to see possible completions. Unlike @LaTeX{}
9333 code, Org mode allows these macros to be present without surrounding math
9334 delimiters, for example:
9337 Angles are written as Greek letters \alpha, \beta and \gamma.
9340 @vindex org-entities
9341 During export, these symbols will be transformed into the native format of
9342 the exporter backend. Strings like @code{\alpha} will be exported as
9343 @code{α} in the HTML output, and as @code{$\alpha$} in the @LaTeX{}
9344 output. Similarly, @code{\nbsp} will become @code{ } in HTML and
9345 @code{~} in @LaTeX{}. If you need such a symbol inside a word, terminate it
9346 like this: @samp{\Aacute@{@}stor}.
9348 A large number of entities is provided, with names taken from both HTML and
9349 @LaTeX{}; see the variable @code{org-entities} for the complete list.
9350 @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
9351 @samp{...} are all converted into special commands creating hyphens of
9352 different lengths or a compact set of dots.
9354 If you would like to see entities displayed as UTF8 characters, use the
9355 following command@footnote{You can turn this on by default by setting the
9356 variable @code{org-pretty-entities}, or on a per-file base with the
9357 @code{#+STARTUP} option @code{entitiespretty}.}:
9362 Toggle display of entities as UTF-8 characters. This does not change the
9363 buffer content which remains plain ASCII, but it overlays the UTF-8 character
9364 for display purposes only.
9367 @node Subscripts and superscripts, @LaTeX{} fragments, Special symbols, Embedded @LaTeX{}
9368 @subsection Subscripts and superscripts
9372 Just like in @LaTeX{}, @samp{^} and @samp{_} are used to indicate super-
9373 and subscripts. Again, these can be used without embedding them in
9374 math-mode delimiters. To increase the readability of ASCII text, it is
9375 not necessary (but OK) to surround multi-character sub- and superscripts
9376 with curly braces. For example
9379 The mass of the sun is M_sun = 1.989 x 10^30 kg. The radius of
9380 the sun is R_@{sun@} = 6.96 x 10^8 m.
9383 @vindex org-export-with-sub-superscripts
9384 To avoid interpretation as raised or lowered text, you can quote @samp{^} and
9385 @samp{_} with a backslash: @samp{\^} and @samp{\_}. If you write a text
9386 where the underscore is often used in a different context, Org's convention
9387 to always interpret these as subscripts can get in your way. Configure the
9388 variable @code{org-export-with-sub-superscripts} to globally change this
9389 convention, or use, on a per-file basis:
9395 @noindent With this setting, @samp{a_b} will not be interpreted as a
9396 subscript, but @samp{a_@{b@}} will.
9401 In addition to showing entities as UTF-8 characters, this command will also
9402 format sub- and superscripts in a WYSIWYM way.
9405 @node @LaTeX{} fragments, Previewing @LaTeX{} fragments, Subscripts and superscripts, Embedded @LaTeX{}
9406 @subsection @LaTeX{} fragments
9407 @cindex @LaTeX{} fragments
9409 @vindex org-format-latex-header
9410 Going beyond symbols and sub- and superscripts, a full formula language is
9411 needed. Org mode can contain @LaTeX{} math fragments, and it supports ways
9412 to process these for several export backends. When exporting to @LaTeX{},
9413 the code is obviously left as it is. When exporting to HTML, Org invokes the
9414 @uref{http://www.mathjax.org, MathJax library} (@pxref{Math formatting in
9415 HTML export}) to process and display the math@footnote{If you plan to use
9416 this regularly or on pages with significant page views, you should install
9417 @file{MathJax} on your own
9418 server in order to limit the load of our server.}. Finally, it can also
9419 process the mathematical expressions into images@footnote{For this to work
9420 you need to be on a system with a working @LaTeX{} installation. You also
9421 need the @file{dvipng} program, available at
9422 @url{http://sourceforge.net/projects/dvipng/}. The @LaTeX{} header that will
9423 be used when processing a fragment can be configured with the variable
9424 @code{org-format-latex-header}.} that can be displayed in a browser or in
9427 @LaTeX{} fragments don't need any special marking at all. The following
9428 snippets will be identified as @LaTeX{} source code:
9431 Environments of any kind@footnote{When @file{MathJax} is used, only the
9432 environment recognized by @file{MathJax} will be processed. When
9433 @file{dvipng} is used to create images, any @LaTeX{} environments will be
9434 handled.}. The only requirement is that the @code{\begin} statement appears
9435 on a new line, preceded by only whitespace.
9437 Text within the usual @LaTeX{} math delimiters. To avoid conflicts with
9438 currency specifications, single @samp{$} characters are only recognized as
9439 math delimiters if the enclosed text contains at most two line breaks, is
9440 directly attached to the @samp{$} characters with no whitespace in between,
9441 and if the closing @samp{$} is followed by whitespace, punctuation or a dash.
9442 For the other delimiters, there is no such restriction, so when in doubt, use
9443 @samp{\(...\)} as inline math delimiters.
9446 @noindent For example:
9449 \begin@{equation@} % arbitrary environments,
9450 x=\sqrt@{b@} % even tables, figures
9451 \end@{equation@} % etc
9453 If $a^2=b$ and \( b=2 \), then the solution must be
9454 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
9458 @vindex org-format-latex-options
9459 If you need any of the delimiter ASCII sequences for other purposes, you
9460 can configure the option @code{org-format-latex-options} to deselect the
9461 ones you do not wish to have interpreted by the @LaTeX{} converter.
9463 @vindex org-export-with-LaTeX-fragments
9464 @LaTeX{} processing can be configured with the variable
9465 @code{org-export-with-LaTeX-fragments}. The default setting is @code{t}
9466 which means @file{MathJax} for HTML, and no processing for DocBook, ASCII and
9467 @LaTeX{} backends. You can also set this variable on a per-file basis using one
9471 #+OPTIONS: LaTeX:t @r{Do the right thing automatically (MathJax)}
9472 #+OPTIONS: LaTeX:dvipng @r{Force using dvipng images}
9473 #+OPTIONS: LaTeX:nil @r{Do not process @LaTeX{} fragments at all}
9474 #+OPTIONS: LaTeX:verbatim @r{Verbatim export, for jsMath or so}
9477 @node Previewing @LaTeX{} fragments, CDLaTeX mode, @LaTeX{} fragments, Embedded @LaTeX{}
9478 @subsection Previewing @LaTeX{} fragments
9479 @cindex @LaTeX{} fragments, preview
9481 If you have @file{dvipng} installed, @LaTeX{} fragments can be processed to
9482 produce preview images of the typeset expressions:
9487 Produce a preview image of the @LaTeX{} fragment at point and overlay it
9488 over the source code. If there is no fragment at point, process all
9489 fragments in the current entry (between two headlines). When called
9490 with a prefix argument, process the entire subtree. When called with
9491 two prefix arguments, or when the cursor is before the first headline,
9492 process the entire buffer.
9495 Remove the overlay preview images.
9498 @vindex org-format-latex-options
9499 You can customize the variable @code{org-format-latex-options} to influence
9500 some aspects of the preview. In particular, the @code{:scale} (and for HTML
9501 export, @code{:html-scale}) property can be used to adjust the size of the
9504 @node CDLaTeX mode, , Previewing @LaTeX{} fragments, Embedded @LaTeX{}
9505 @subsection Using CD@LaTeX{} to enter math
9508 CD@LaTeX{} mode is a minor mode that is normally used in combination with a
9509 major @LaTeX{} mode like AUC@TeX{} in order to speed-up insertion of
9510 environments and math templates. Inside Org mode, you can make use of
9511 some of the features of CD@LaTeX{} mode. You need to install
9512 @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
9513 AUC@TeX{}) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
9514 Don't use CD@LaTeX{} mode itself under Org mode, but use the light
9515 version @code{org-cdlatex-mode} that comes as part of Org mode. Turn it
9516 on for the current buffer with @code{M-x org-cdlatex-mode}, or for all
9520 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
9523 When this mode is enabled, the following features are present (for more
9524 details see the documentation of CD@LaTeX{} mode):
9528 Environment templates can be inserted with @kbd{C-c @{}.
9531 The @key{TAB} key will do template expansion if the cursor is inside a
9532 @LaTeX{} fragment@footnote{Org mode has a method to test if the cursor is
9533 inside such a fragment, see the documentation of the function
9534 @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will
9535 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
9536 correctly inside the first brace. Another @key{TAB} will get you into
9537 the second brace. Even outside fragments, @key{TAB} will expand
9538 environment abbreviations at the beginning of a line. For example, if
9539 you write @samp{equ} at the beginning of a line and press @key{TAB},
9540 this abbreviation will be expanded to an @code{equation} environment.
9541 To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}.
9545 @vindex cdlatex-simplify-sub-super-scripts
9546 Pressing @kbd{_} and @kbd{^} inside a @LaTeX{} fragment will insert these
9547 characters together with a pair of braces. If you use @key{TAB} to move
9548 out of the braces, and if the braces surround only a single character or
9549 macro, they are removed again (depending on the variable
9550 @code{cdlatex-simplify-sub-super-scripts}).
9553 Pressing the backquote @kbd{`} followed by a character inserts math
9554 macros, also outside @LaTeX{} fragments. If you wait more than 1.5 seconds
9555 after the backquote, a help window will pop up.
9558 Pressing the single-quote @kbd{'} followed by another character modifies
9559 the symbol before point with an accent or a font. If you wait more than
9560 1.5 seconds after the single-quote, a help window will pop up. Character
9561 modification will work only inside @LaTeX{} fragments; outside the quote
9565 @node Exporting, Publishing, Markup, Top
9569 Org mode documents can be exported into a variety of other formats. For
9570 printing and sharing of notes, ASCII export produces a readable and simple
9571 version of an Org file. HTML export allows you to publish a notes file on
9572 the web, while the XOXO format provides a solid base for exchange with a
9573 broad range of other applications. @LaTeX{} export lets you use Org mode and
9574 its structured editing functions to easily create @LaTeX{} files. DocBook
9575 export makes it possible to convert Org files to many other formats using
9576 DocBook tools. OpenDocument Text(@acronym{ODT}) export allows seamless
9577 collaboration across organizational boundaries. For project management you
9578 can create gantt and resource charts by using TaskJuggler export. To
9579 incorporate entries with associated times like deadlines or appointments into
9580 a desktop calendar program like iCal, Org mode can also produce extracts in
9581 the iCalendar format. Currently Org mode only supports export, not import of
9582 these different formats.
9584 Org supports export of selected regions when @code{transient-mark-mode} is
9585 enabled (default in Emacs 23).
9588 * Selective export:: Using tags to select and exclude trees
9589 * Export options:: Per-file export settings
9590 * The export dispatcher:: How to access exporter commands
9591 * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
9592 * HTML export:: Exporting to HTML
9593 * @LaTeX{} and PDF export:: Exporting to @LaTeX{}, and processing to PDF
9594 * DocBook export:: Exporting to DocBook
9595 * OpenDocument Text export:: Exporting to OpenDocument Text
9596 * TaskJuggler export:: Exporting to TaskJuggler
9597 * Freemind export:: Exporting to Freemind mind maps
9598 * XOXO export:: Exporting to XOXO
9599 * iCalendar export:: Exporting in iCalendar format
9602 @node Selective export, Export options, Exporting, Exporting
9603 @section Selective export
9604 @cindex export, selective by tags or TODO keyword
9606 @vindex org-export-select-tags
9607 @vindex org-export-exclude-tags
9608 @cindex org-export-with-tasks
9609 You may use tags to select the parts of a document that should be exported,
9610 or to exclude parts from export. This behavior is governed by two variables:
9611 @code{org-export-select-tags} and @code{org-export-exclude-tags},
9612 respectively defaulting to @code{'(:export:)} and @code{'(:noexport:)}.
9616 Org first checks if any of the @emph{select} tags is present in the
9617 buffer. If yes, all trees that do not carry one of these tags will be
9618 excluded. If a selected tree is a subtree, the heading hierarchy above it
9619 will also be selected for export, but not the text below those headings.
9622 If none of the select tags is found, the whole buffer will be selected for
9626 Finally, all subtrees that are marked by any of the @emph{exclude} tags will
9627 be removed from the export buffer.
9630 The variable @code{org-export-with-tasks} can be configured to select which
9631 kind of tasks should be included for export. See the docstring of the
9632 variable for more information.
9634 @node Export options, The export dispatcher, Selective export, Exporting
9635 @section Export options
9636 @cindex options, for export
9638 @cindex completion, of option keywords
9639 The exporter recognizes special lines in the buffer which provide
9640 additional information. These lines may be put anywhere in the file.
9641 The whole set of lines can be inserted into the buffer with @kbd{C-c
9642 C-e t}. For individual lines, a good way to make sure the keyword is
9643 correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion
9644 (@pxref{Completion}). For a summary of other in-buffer settings not
9645 specifically related to export, see @ref{In-buffer settings}.
9646 In particular, note that you can place commonly-used (export) options in
9647 a separate file which can be included using @code{#+SETUPFILE}.
9650 @orgcmd{C-c C-e t,org-insert-export-options-template}
9651 Insert template with export options, see example below.
9658 @cindex #+DESCRIPTION
9666 @cindex #+EXPORT_SELECT_TAGS
9667 @cindex #+EXPORT_EXCLUDE_TAGS
9669 @cindex #+LaTeX_HEADER
9670 @vindex user-full-name
9671 @vindex user-mail-address
9672 @vindex org-export-default-language
9673 @vindex org-export-date-timestamp-format
9675 #+TITLE: the title to be shown (default is the buffer name)
9676 #+AUTHOR: the author (default taken from @code{user-full-name})
9677 #+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}
9678 #+EMAIL: his/her email address (default from @code{user-mail-address})
9679 #+DESCRIPTION: the page description, e.g.@: for the XHTML meta tag
9680 #+KEYWORDS: the page keywords, e.g.@: for the XHTML meta tag
9681 #+LANGUAGE: language for HTML, e.g.@: @samp{en} (@code{org-export-default-language})
9682 #+TEXT: Some descriptive text to be inserted at the beginning.
9683 #+TEXT: Several lines may be given.
9684 #+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ...
9685 #+BIND: lisp-var lisp-val, e.g.@:: @code{org-export-latex-low-levels itemize}
9686 @r{You need to confirm using these, or configure @code{org-export-allow-BIND}}
9687 #+LINK_UP: the ``up'' link of an exported page
9688 #+LINK_HOME: the ``home'' link of an exported page
9689 #+LaTeX_HEADER: extra line(s) for the @LaTeX{} header, like \usepackage@{xyz@}
9690 #+EXPORT_SELECT_TAGS: Tags that select a tree for export
9691 #+EXPORT_EXCLUDE_TAGS: Tags that exclude a tree from export
9692 #+XSLT: the XSLT stylesheet used by DocBook exporter to generate FO file
9696 The @code{#+OPTIONS} line is a compact@footnote{If you want to configure many options
9697 this way, you can use several @code{#+OPTIONS} lines.} form to specify export
9698 settings. Here you can:
9699 @cindex headline levels
9700 @cindex section-numbers
9701 @cindex table of contents
9702 @cindex line-break preservation
9703 @cindex quoted HTML tags
9704 @cindex fixed-width sections
9706 @cindex @TeX{}-like syntax for sub- and superscripts
9708 @cindex special strings
9709 @cindex emphasized text
9710 @cindex @TeX{} macros
9711 @cindex @LaTeX{} fragments
9712 @cindex author info, in export
9713 @cindex time info, in export
9714 @vindex org-export-plist-vars
9715 @vindex org-export-author-info
9716 @vindex org-export-creator-info
9717 @vindex org-export-email-info
9718 @vindex org-export-time-stamp-file
9720 H: @r{set the number of headline levels for export}
9721 num: @r{turn on/off section-numbers}
9722 toc: @r{turn on/off table of contents, or set level limit (integer)}
9723 \n: @r{turn on/off line-break-preservation (DOES NOT WORK)}
9724 @@: @r{turn on/off quoted HTML tags}
9725 :: @r{turn on/off fixed-width sections}
9726 |: @r{turn on/off tables}
9727 ^: @r{turn on/off @TeX{}-like syntax for sub- and superscripts. If}
9728 @r{you write "^:@{@}", @code{a_@{b@}} will be interpreted, but}
9729 @r{the simple @code{a_b} will be left as it is.}
9730 -: @r{turn on/off conversion of special strings.}
9731 f: @r{turn on/off footnotes like this[1].}
9732 todo: @r{turn on/off inclusion of TODO keywords into exported text}
9733 tasks: @r{turn on/off inclusion of tasks (TODO items), can be nil to remove}
9734 @r{all tasks, @code{todo} to remove DONE tasks, or list of kwds to keep}
9735 pri: @r{turn on/off priority cookies}
9736 tags: @r{turn on/off inclusion of tags, may also be @code{not-in-toc}}
9737 <: @r{turn on/off inclusion of any time/date stamps like DEADLINES}
9738 *: @r{turn on/off emphasized text (bold, italic, underlined)}
9739 TeX: @r{turn on/off simple @TeX{} macros in plain text}
9740 LaTeX: @r{configure export of @LaTeX{} fragments. Default @code{auto}}
9741 skip: @r{turn on/off skipping the text before the first heading}
9742 author: @r{turn on/off inclusion of author name/email into exported file}
9743 email: @r{turn on/off inclusion of author email into exported file}
9744 creator: @r{turn on/off inclusion of creator info into exported file}
9745 timestamp: @r{turn on/off inclusion creation time into exported file}
9746 d: @r{turn on/off inclusion of drawers}
9749 These options take effect in both the HTML and @LaTeX{} export, except for
9750 @code{TeX} and @code{LaTeX} options, which are respectively @code{t} and
9751 @code{nil} for the @LaTeX{} export.
9753 The default values for these and many other options are given by a set of
9754 variables. For a list of such variables, the corresponding OPTIONS keys and
9755 also the publishing keys (@pxref{Project alist}), see the constant
9756 @code{org-export-plist-vars}.
9758 When exporting only a single subtree by selecting it with @kbd{C-c @@} before
9759 calling an export command, the subtree can overrule some of the file's export
9760 settings with properties @code{EXPORT_FILE_NAME}, @code{EXPORT_TITLE},
9761 @code{EXPORT_TEXT}, @code{EXPORT_AUTHOR}, @code{EXPORT_DATE}, and
9762 @code{EXPORT_OPTIONS}.
9764 @node The export dispatcher, ASCII/Latin-1/UTF-8 export, Export options, Exporting
9765 @section The export dispatcher
9766 @cindex dispatcher, for export commands
9768 All export commands can be reached using the export dispatcher, which is a
9769 prefix key that prompts for an additional key specifying the command.
9770 Normally the entire file is exported, but if there is an active region that
9771 contains one outline tree, the first heading is used as document title and
9772 the subtrees are exported.
9775 @orgcmd{C-c C-e,org-export}
9776 @vindex org-export-run-in-background
9777 Dispatcher for export and publishing commands. Displays a help-window
9778 listing the additional key(s) needed to launch an export or publishing
9779 command. The prefix arg is passed through to the exporter. A double prefix
9780 @kbd{C-u C-u} causes most commands to be executed in the background, in a
9781 separate Emacs process@footnote{To make this behavior the default, customize
9782 the variable @code{org-export-run-in-background}.}.
9783 @orgcmd{C-c C-e v,org-export-visible}
9784 Like @kbd{C-c C-e}, but only export the text that is currently visible
9785 (i.e.@: not hidden by outline visibility).
9786 @orgcmd{C-u C-u C-c C-e,org-export}
9787 @vindex org-export-run-in-background
9788 Call the exporter, but reverse the setting of
9789 @code{org-export-run-in-background}, i.e.@: request background processing if
9790 not set, or force processing in the current Emacs process if set.
9793 @node ASCII/Latin-1/UTF-8 export, HTML export, The export dispatcher, Exporting
9794 @section ASCII/Latin-1/UTF-8 export
9795 @cindex ASCII export
9796 @cindex Latin-1 export
9797 @cindex UTF-8 export
9799 ASCII export produces a simple and very readable version of an Org mode
9800 file, containing only plain ASCII. Latin-1 and UTF-8 export augment the file
9801 with special characters and symbols available in these encodings.
9803 @cindex region, active
9804 @cindex active region
9805 @cindex transient-mark-mode
9807 @orgcmd{C-c C-e a,org-export-as-ascii}
9808 @cindex property, EXPORT_FILE_NAME
9809 Export as ASCII file. For an Org file, @file{myfile.org}, the ASCII file
9810 will be @file{myfile.txt}. The file will be overwritten without
9811 warning. If there is an active region@footnote{This requires
9812 @code{transient-mark-mode} be turned on.}, only the region will be
9813 exported. If the selected region is a single tree@footnote{To select the
9814 current subtree, use @kbd{C-c @@}.}, the tree head will
9815 become the document title. If the tree head entry has or inherits an
9816 @code{EXPORT_FILE_NAME} property, that name will be used for the
9818 @orgcmd{C-c C-e A,org-export-as-ascii-to-buffer}
9819 Export to a temporary buffer. Do not create a file.
9820 @orgcmd{C-c C-e n,org-export-as-latin1}
9821 @xorgcmd{C-c C-e N,org-export-as-latin1-to-buffer}
9822 Like the above commands, but use Latin-1 encoding.
9823 @orgcmd{C-c C-e u,org-export-as-utf8}
9824 @xorgcmd{C-c C-e U,org-export-as-utf8-to-buffer}
9825 Like the above commands, but use UTF-8 encoding.
9826 @item C-c C-e v a/n/u
9827 Export only the visible part of the document.
9830 @cindex headline levels, for exporting
9831 In the exported version, the first 3 outline levels will become
9832 headlines, defining a general document structure. Additional levels
9833 will be exported as itemized lists. If you want that transition to occur
9834 at a different level, specify it with a prefix argument. For example,
9841 creates only top level headlines and does the rest as items. When
9842 headlines are converted to items, the indentation of the text following
9843 the headline is changed to fit nicely under the item. This is done with
9844 the assumption that the first body line indicates the base indentation of
9845 the body text. Any indentation larger than this is adjusted to preserve
9846 the layout relative to the first line. Should there be lines with less
9847 indentation than the first, these are left alone.
9849 @vindex org-export-ascii-links-to-notes
9850 Links will be exported in a footnote-like style, with the descriptive part in
9851 the text and the link in a note before the next heading. See the variable
9852 @code{org-export-ascii-links-to-notes} for details and other options.
9854 @node HTML export, @LaTeX{} and PDF export, ASCII/Latin-1/UTF-8 export, Exporting
9855 @section HTML export
9858 Org mode contains an HTML (XHTML 1.0 strict) exporter with extensive
9859 HTML formatting, in ways similar to John Gruber's @emph{markdown}
9860 language, but with additional support for tables.
9863 * HTML Export commands:: How to invoke HTML export
9864 * HTML preamble and postamble:: How to insert a preamble and a postamble
9865 * Quoting HTML tags:: Using direct HTML in Org mode
9866 * Links in HTML export:: How links will be interpreted and formatted
9867 * Tables in HTML export:: How to modify the formatting of tables
9868 * Images in HTML export:: How to insert figures into HTML output
9869 * Math formatting in HTML export:: Beautiful math also on the web
9870 * Text areas in HTML export:: An alternative way to show an example
9871 * CSS support:: Changing the appearance of the output
9872 * JavaScript support:: Info and Folding in a web browser
9875 @node HTML Export commands, HTML preamble and postamble, HTML export, HTML export
9876 @subsection HTML export commands
9878 @cindex region, active
9879 @cindex active region
9880 @cindex transient-mark-mode
9882 @orgcmd{C-c C-e h,org-export-as-html}
9883 @cindex property, EXPORT_FILE_NAME
9884 Export as HTML file. For an Org file @file{myfile.org},
9885 the HTML file will be @file{myfile.html}. The file will be overwritten
9886 without warning. If there is an active region@footnote{This requires
9887 @code{transient-mark-mode} be turned on.}, only the region will be
9888 exported. If the selected region is a single tree@footnote{To select the
9889 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
9890 title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
9891 property, that name will be used for the export.
9892 @orgcmd{C-c C-e b,org-export-as-html-and-open}
9893 Export as HTML file and immediately open it with a browser.
9894 @orgcmd{C-c C-e H,org-export-as-html-to-buffer}
9895 Export to a temporary buffer. Do not create a file.
9896 @orgcmd{C-c C-e R,org-export-region-as-html}
9897 Export the active region to a temporary buffer. With a prefix argument, do
9898 not produce the file header and footer, but just the plain HTML section for
9899 the region. This is good for cut-and-paste operations.
9900 @item C-c C-e v h/b/H/R
9901 Export only the visible part of the document.
9902 @item M-x org-export-region-as-html
9903 Convert the region to HTML under the assumption that it was Org mode
9904 syntax before. This is a global command that can be invoked in any
9906 @item M-x org-replace-region-by-HTML
9907 Replace the active region (assumed to be in Org mode syntax) by HTML
9911 @cindex headline levels, for exporting
9912 In the exported version, the first 3 outline levels will become headlines,
9913 defining a general document structure. Additional levels will be exported as
9914 itemized lists. If you want that transition to occur at a different level,
9915 specify it with a numeric prefix argument. For example,
9922 creates two levels of headings and does the rest as items.
9925 @node HTML preamble and postamble, Quoting HTML tags, HTML Export commands, HTML export
9926 @subsection HTML preamble and postamble
9927 @vindex org-export-html-preamble
9928 @vindex org-export-html-postamble
9929 @vindex org-export-html-preamble-format
9930 @vindex org-export-html-postamble-format
9931 @vindex org-export-html-validation-link
9932 @vindex org-export-author-info
9933 @vindex org-export-email-info
9934 @vindex org-export-creator-info
9935 @vindex org-export-time-stamp-file
9937 The HTML exporter lets you define a preamble and a postamble.
9939 The default value for @code{org-export-html-preamble} is @code{t}, which
9940 means that the preamble is inserted depending on the relevant formatting
9941 string in @code{org-export-html-preamble-format}.
9943 Setting @code{org-export-html-preamble} to a string will override the default
9944 formatting string. Setting it to a function, will insert the output of the
9945 function, which must be a string; such a function takes no argument but you
9946 can check against the value of @code{opt-plist}, which contains the list of
9947 publishing properties for the current file. Setting to @code{nil} will not
9948 insert any preamble.
9950 The default value for @code{org-export-html-postamble} is @code{'auto}, which
9951 means that the HTML exporter will look for the value of
9952 @code{org-export-author-info}, @code{org-export-email-info},
9953 @code{org-export-creator-info} and @code{org-export-time-stamp-file},
9954 @code{org-export-html-validation-link} and build the postamble from these
9955 values. Setting @code{org-export-html-postamble} to @code{t} will insert the
9956 postamble from the relevant formatting string found in
9957 @code{org-export-html-postamble-format}. Setting it to @code{nil} will not
9958 insert any postamble.
9960 @node Quoting HTML tags, Links in HTML export, HTML preamble and postamble, HTML export
9961 @subsection Quoting HTML tags
9963 Plain @samp{<} and @samp{>} are always transformed to @samp{<} and
9964 @samp{>} in HTML export. If you want to include simple HTML tags
9965 which should be interpreted as such, mark them with @samp{@@} as in
9966 @samp{@@<b>bold text@@</b>}. Note that this really works only for
9967 simple tags. For more extensive HTML that should be copied verbatim to
9968 the exported file use either
9971 @cindex #+BEGIN_HTML
9973 #+HTML: Literal HTML code for export
9977 @cindex #+BEGIN_HTML
9981 All lines between these markers are exported literally
9986 @node Links in HTML export, Tables in HTML export, Quoting HTML tags, HTML export
9987 @subsection Links in HTML export
9989 @cindex links, in HTML export
9990 @cindex internal links, in HTML export
9991 @cindex external links, in HTML export
9992 Internal links (@pxref{Internal links}) will continue to work in HTML. This
9993 includes automatic links created by radio targets (@pxref{Radio
9994 targets}). Links to external files will still work if the target file is on
9995 the same @i{relative} path as the published Org file. Links to other
9996 @file{.org} files will be translated into HTML links under the assumption
9997 that an HTML version also exists of the linked file, at the same relative
9998 path. @samp{id:} links can then be used to jump to specific entries across
9999 files. For information related to linking files while publishing them to a
10000 publishing directory see @ref{Publishing links}.
10002 If you want to specify attributes for links, you can do so using a special
10003 @code{#+ATTR_HTML} line to define attributes that will be added to the
10004 @code{<a>} or @code{<img>} tags. Here is an example that sets @code{title}
10005 and @code{style} attributes for a link:
10007 @cindex #+ATTR_HTML
10009 #+ATTR_HTML: title="The Org mode homepage" style="color:red;"
10010 [[http://orgmode.org]]
10013 @node Tables in HTML export, Images in HTML export, Links in HTML export, HTML export
10015 @cindex tables, in HTML
10016 @vindex org-export-html-table-tag
10018 Org mode tables are exported to HTML using the table tag defined in
10019 @code{org-export-html-table-tag}. The default setting makes tables without
10020 cell borders and frame. If you would like to change this for individual
10021 tables, place something like the following before the table:
10024 @cindex #+ATTR_HTML
10026 #+CAPTION: This is a table with lines around and between cells
10027 #+ATTR_HTML: border="2" rules="all" frame="border"
10030 @node Images in HTML export, Math formatting in HTML export, Tables in HTML export, HTML export
10031 @subsection Images in HTML export
10033 @cindex images, inline in HTML
10034 @cindex inlining images in HTML
10035 @vindex org-export-html-inline-images
10036 HTML export can inline images given as links in the Org file, and
10037 it can make an image the clickable part of a link. By
10038 default@footnote{But see the variable
10039 @code{org-export-html-inline-images}.}, images are inlined if a link does
10040 not have a description. So @samp{[[file:myimg.jpg]]} will be inlined,
10041 while @samp{[[file:myimg.jpg][the image]]} will just produce a link
10042 @samp{the image} that points to the image. If the description part
10043 itself is a @code{file:} link or a @code{http:} URL pointing to an
10044 image, this image will be inlined and activated so that clicking on the
10045 image will activate the link. For example, to include a thumbnail that
10046 will link to a high resolution version of the image, you could use:
10049 [[file:highres.jpg][file:thumb.jpg]]
10052 If you need to add attributes to an inlined image, use a @code{#+ATTR_HTML}.
10053 In the example below we specify the @code{alt} and @code{title} attributes to
10054 support text viewers and accessibility, and align it to the right.
10057 @cindex #+ATTR_HTML
10059 #+CAPTION: A black cat stalking a spider
10060 #+ATTR_HTML: alt="cat/spider image" title="Action!" align="right"
10065 You could use @code{http} addresses just as well.
10067 @node Math formatting in HTML export, Text areas in HTML export, Images in HTML export, HTML export
10068 @subsection Math formatting in HTML export
10072 @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be displayed in two
10073 different ways on HTML pages. The default is to use the
10074 @uref{http://www.mathjax.org, MathJax system} which should work out of the
10075 box with Org mode installation because @code{http://orgmode.org} serves
10076 @file{MathJax} for Org mode users for small applications and for testing
10077 purposes. @b{If you plan to use this regularly or on pages with significant
10078 page views, you should install@footnote{Installation instructions can be
10079 found on the MathJax website, see
10080 @uref{http://www.mathjax.org/resources/docs/?installation.html}.} MathJax on
10081 your own server in order to limit the load of our server.} To configure
10082 @file{MathJax}, use the variable @code{org-export-html-mathjax-options} or
10083 insert something like the following into the buffer:
10086 #+MATHJAX: align:"left" mathml:t path:"/MathJax/MathJax.js"
10089 @noindent See the docstring of the variable
10090 @code{org-export-html-mathjax-options} for the meaning of the parameters in
10093 If you prefer, you can also request that @LaTeX{} fragments are processed
10094 into small images that will be inserted into the browser page. Before the
10095 availability of MathJax, this was the default method for Org files. This
10096 method requires that the @file{dvipng} program is available on your system.
10097 You can still get this processing with
10100 #+OPTIONS: LaTeX:dvipng
10103 @node Text areas in HTML export, CSS support, Math formatting in HTML export, HTML export
10104 @subsection Text areas in HTML export
10106 @cindex text areas, in HTML
10107 An alternative way to publish literal code examples in HTML is to use text
10108 areas, where the example can even be edited before pasting it into an
10109 application. It is triggered by a @code{-t} switch at an @code{example} or
10110 @code{src} block. Using this switch disables any options for syntax and
10111 label highlighting, and line numbering, which may be present. You may also
10112 use @code{-h} and @code{-w} switches to specify the height and width of the
10113 text area, which default to the number of lines in the example, and 80,
10114 respectively. For example
10117 #+BEGIN_EXAMPLE -t -w 40
10118 (defun org-xor (a b)
10125 @node CSS support, JavaScript support, Text areas in HTML export, HTML export
10126 @subsection CSS support
10127 @cindex CSS, for HTML export
10128 @cindex HTML export, CSS
10130 @vindex org-export-html-todo-kwd-class-prefix
10131 @vindex org-export-html-tag-class-prefix
10132 You can also give style information for the exported file. The HTML exporter
10133 assigns the following special CSS classes@footnote{If the classes on TODO
10134 keywords and tags lead to conflicts, use the variables
10135 @code{org-export-html-todo-kwd-class-prefix} and
10136 @code{org-export-html-tag-class-prefix} to make them unique.} to appropriate
10137 parts of the document---your style specifications may change these, in
10138 addition to any of the standard classes like for headlines, tables, etc.
10140 p.author @r{author information, including email}
10141 p.date @r{publishing date}
10142 p.creator @r{creator info, about org mode version}
10143 .title @r{document title}
10144 .todo @r{TODO keywords, all not-done states}
10145 .done @r{the DONE keywords, all states that count as done}
10146 .WAITING @r{each TODO keyword also uses a class named after itself}
10147 .timestamp @r{timestamp}
10148 .timestamp-kwd @r{keyword associated with a timestamp, like SCHEDULED}
10149 .timestamp-wrapper @r{span around keyword plus timestamp}
10150 .tag @r{tag in a headline}
10151 ._HOME @r{each tag uses itself as a class, "@@" replaced by "_"}
10152 .target @r{target for links}
10153 .linenr @r{the line number in a code example}
10154 .code-highlighted @r{for highlighting referenced code lines}
10155 div.outline-N @r{div for outline level N (headline plus text))}
10156 div.outline-text-N @r{extra div for text at outline level N}
10157 .section-number-N @r{section number in headlines, different for each level}
10158 div.figure @r{how to format an inlined image}
10159 pre.src @r{formatted source code}
10160 pre.example @r{normal example}
10161 p.verse @r{verse paragraph}
10162 div.footnotes @r{footnote section headline}
10163 p.footnote @r{footnote definition paragraph, containing a footnote}
10164 .footref @r{a footnote reference number (always a <sup>)}
10165 .footnum @r{footnote number in footnote definition (always <sup>)}
10168 @vindex org-export-html-style-default
10169 @vindex org-export-html-style-include-default
10170 @vindex org-export-html-style
10171 @vindex org-export-html-extra
10172 @vindex org-export-html-style-default
10173 Each exported file contains a compact default style that defines these
10174 classes in a basic way@footnote{This style is defined in the constant
10175 @code{org-export-html-style-default}, which you should not modify. To turn
10176 inclusion of these defaults off, customize
10177 @code{org-export-html-style-include-default}}. You may overwrite these
10178 settings, or add to them by using the variables @code{org-export-html-style}
10179 (for Org-wide settings) and @code{org-export-html-style-extra} (for more
10180 fine-grained settings, like file-local settings). To set the latter variable
10181 individually for each file, you can use
10185 #+STYLE: <link rel="stylesheet" type="text/css" href="stylesheet.css" />
10189 For longer style definitions, you can use several such lines. You could also
10190 directly write a @code{<style>} @code{</style>} section in this way, without
10191 referring to an external file.
10193 In order to add styles to a subtree, use the @code{:HTML_CONTAINER_CLASS:}
10194 property to assign a class to the tree. In order to specify CSS styles for a
10195 particular headline, you can use the id specified in a @code{:CUSTOM_ID:}
10198 @c FIXME: More about header and footer styles
10199 @c FIXME: Talk about links and targets.
10201 @node JavaScript support, , CSS support, HTML export
10202 @subsection JavaScript supported display of web pages
10204 @cindex Rose, Sebastian
10205 Sebastian Rose has written a JavaScript program especially designed to
10206 enhance the web viewing experience of HTML files created with Org. This
10207 program allows you to view large files in two different ways. The first one
10208 is an @emph{Info}-like mode where each section is displayed separately and
10209 navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
10210 as well, press @kbd{?} for an overview of the available keys). The second
10211 view type is a @emph{folding} view much like Org provides inside Emacs. The
10212 script is available at @url{http://orgmode.org/org-info.js} and you can find
10213 the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
10214 We host the script at our site, but if you use it a lot, you might
10215 not want to be dependent on @url{orgmode.org} and prefer to install a local
10216 copy on your own web server.
10218 To use the script, you need to make sure that the @file{org-jsinfo.el} module
10219 gets loaded. It should be loaded by default, but you can try @kbd{M-x
10220 customize-variable @key{RET} org-modules @key{RET}} to convince yourself that
10221 this is indeed the case. All it then takes to make use of the program is
10222 adding a single line to the Org file:
10224 @cindex #+INFOJS_OPT
10226 #+INFOJS_OPT: view:info toc:nil
10230 If this line is found, the HTML header will automatically contain the code
10231 needed to invoke the script. Using the line above, you can set the following
10235 path: @r{The path to the script. The default is to grab the script from}
10236 @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
10237 @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
10238 view: @r{Initial view when website is first shown. Possible values are:}
10239 info @r{Info-like interface with one section per page.}
10240 overview @r{Folding interface, initially showing only top-level.}
10241 content @r{Folding interface, starting with all headlines visible.}
10242 showall @r{Folding interface, all headlines and text visible.}
10243 sdepth: @r{Maximum headline level that will still become an independent}
10244 @r{section for info and folding modes. The default is taken from}
10245 @r{@code{org-export-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
10246 @r{If this is smaller than in @code{org-export-headline-levels}, each}
10247 @r{info/folding section can still contain child headlines.}
10248 toc: @r{Should the table of contents @emph{initially} be visible?}
10249 @r{Even when @code{nil}, you can always get to the "toc" with @kbd{i}.}
10250 tdepth: @r{The depth of the table of contents. The defaults are taken from}
10251 @r{the variables @code{org-export-headline-levels} and @code{org-export-with-toc}.}
10252 ftoc: @r{Does the CSS of the page specify a fixed position for the "toc"?}
10253 @r{If yes, the toc will never be displayed as a section.}
10254 ltoc: @r{Should there be short contents (children) in each section?}
10255 @r{Make this @code{above} if the section should be above initial text.}
10256 mouse: @r{Headings are highlighted when the mouse is over them. Should be}
10257 @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
10258 buttons: @r{Should view-toggle buttons be everywhere? When @code{nil} (the}
10259 @r{default), only one such button will be present.}
10262 @vindex org-infojs-options
10263 @vindex org-export-html-use-infojs
10264 You can choose default values for these options by customizing the variable
10265 @code{org-infojs-options}. If you always want to apply the script to your
10266 pages, configure the variable @code{org-export-html-use-infojs}.
10268 @node @LaTeX{} and PDF export, DocBook export, HTML export, Exporting
10269 @section @LaTeX{} and PDF export
10270 @cindex @LaTeX{} export
10272 @cindex Guerry, Bastien
10274 Org mode contains a @LaTeX{} exporter written by Bastien Guerry. With
10275 further processing@footnote{The default @LaTeX{} output is designed for
10276 processing with @code{pdftex} or @LaTeX{}. It includes packages that are not
10277 compatible with @code{xetex} and possibly @code{luatex}. See the variables
10278 @code{org-export-latex-default-packages-alist} and
10279 @code{org-export-latex-packages-alist}.}, this backend is also used to
10280 produce PDF output. Since the @LaTeX{} output uses @file{hyperref} to
10281 implement links and cross references, the PDF output file will be fully
10282 linked. Beware of the fact that your @code{org} file has to be properly
10283 structured in order to be correctly exported: respect the hierarchy of
10287 * @LaTeX{}/PDF export commands::
10288 * Header and sectioning:: Setting up the export file structure
10289 * Quoting @LaTeX{} code:: Incorporating literal @LaTeX{} code
10290 * Tables in @LaTeX{} export:: Options for exporting tables to @LaTeX{}
10291 * Images in @LaTeX{} export:: How to insert figures into @LaTeX{} output
10292 * Beamer class export:: Turning the file into a presentation
10295 @node @LaTeX{}/PDF export commands, Header and sectioning, @LaTeX{} and PDF export, @LaTeX{} and PDF export
10296 @subsection @LaTeX{} export commands
10298 @cindex region, active
10299 @cindex active region
10300 @cindex transient-mark-mode
10302 @orgcmd{C-c C-e l,org-export-as-latex}
10303 @cindex property EXPORT_FILE_NAME
10304 Export as @LaTeX{} file. For an Org file
10305 @file{myfile.org}, the @LaTeX{} file will be @file{myfile.tex}. The file will
10306 be overwritten without warning. If there is an active region@footnote{This
10307 requires @code{transient-mark-mode} be turned on.}, only the region will be
10308 exported. If the selected region is a single tree@footnote{To select the
10309 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
10310 title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME}
10311 property, that name will be used for the export.
10312 @orgcmd{C-c C-e L,org-export-as-latex-to-buffer}
10313 Export to a temporary buffer. Do not create a file.
10314 @item C-c C-e v l/L
10315 Export only the visible part of the document.
10316 @item M-x org-export-region-as-latex
10317 Convert the region to @LaTeX{} under the assumption that it was Org mode
10318 syntax before. This is a global command that can be invoked in any
10320 @item M-x org-replace-region-by-latex
10321 Replace the active region (assumed to be in Org mode syntax) by @LaTeX{}
10323 @orgcmd{C-c C-e p,org-export-as-pdf}
10324 Export as @LaTeX{} and then process to PDF.
10325 @orgcmd{C-c C-e d,org-export-as-pdf-and-open}
10326 Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
10329 @cindex headline levels, for exporting
10330 @vindex org-latex-low-levels
10331 In the exported version, the first 3 outline levels will become
10332 headlines, defining a general document structure. Additional levels
10333 will be exported as description lists. The exporter can ignore them or
10334 convert them to a custom string depending on
10335 @code{org-latex-low-levels}.
10337 If you want that transition to occur at a different level, specify it
10338 with a numeric prefix argument. For example,
10341 @kbd{C-2 C-c C-e l}
10345 creates two levels of headings and does the rest as items.
10347 @node Header and sectioning, Quoting @LaTeX{} code, @LaTeX{}/PDF export commands, @LaTeX{} and PDF export
10348 @subsection Header and sectioning structure
10349 @cindex @LaTeX{} class
10350 @cindex @LaTeX{} sectioning structure
10351 @cindex @LaTeX{} header
10352 @cindex header, for @LaTeX{} files
10353 @cindex sectioning structure, for @LaTeX{} export
10355 By default, the @LaTeX{} output uses the class @code{article}.
10357 @vindex org-export-latex-default-class
10358 @vindex org-export-latex-classes
10359 @vindex org-export-latex-default-packages-alist
10360 @vindex org-export-latex-packages-alist
10361 @cindex #+LaTeX_HEADER
10362 @cindex #+LaTeX_CLASS
10363 @cindex #+LaTeX_CLASS_OPTIONS
10364 @cindex property, LaTeX_CLASS
10365 @cindex property, LaTeX_CLASS_OPTIONS
10366 You can change this globally by setting a different value for
10367 @code{org-export-latex-default-class} or locally by adding an option like
10368 @code{#+LaTeX_CLASS: myclass} in your file, or with a @code{:LaTeX_CLASS:}
10369 property that applies when exporting a region containing only this (sub)tree.
10370 The class must be listed in @code{org-export-latex-classes}. This variable
10371 defines a header template for each class@footnote{Into which the values of
10372 @code{org-export-latex-default-packages-alist} and
10373 @code{org-export-latex-packages-alist} are spliced.}, and allows you to
10374 define the sectioning structure for each class. You can also define your own
10375 classes there. @code{#+LaTeX_CLASS_OPTIONS} or a @code{LaTeX_CLASS_OPTIONS}
10376 property can specify the options for the @code{\documentclass} macro. You
10377 can also use @code{#+LaTeX_HEADER: \usepackage@{xyz@}} to add lines to the
10378 header. See the docstring of @code{org-export-latex-classes} for more
10381 @node Quoting @LaTeX{} code, Tables in @LaTeX{} export, Header and sectioning, @LaTeX{} and PDF export
10382 @subsection Quoting @LaTeX{} code
10384 Embedded @LaTeX{} as described in @ref{Embedded @LaTeX{}}, will be correctly
10385 inserted into the @LaTeX{} file. This includes simple macros like
10386 @samp{\ref@{LABEL@}} to create a cross reference to a figure. Furthermore,
10387 you can add special code that should only be present in @LaTeX{} export with
10388 the following constructs:
10391 @cindex #+BEGIN_LaTeX
10393 #+LaTeX: Literal @LaTeX{} code for export
10397 @cindex #+BEGIN_LaTeX
10401 All lines between these markers are exported literally
10406 @node Tables in @LaTeX{} export, Images in @LaTeX{} export, Quoting @LaTeX{} code, @LaTeX{} and PDF export
10407 @subsection Tables in @LaTeX{} export
10408 @cindex tables, in @LaTeX{} export
10410 For @LaTeX{} export of a table, you can specify a label, a caption and
10411 placement options (@pxref{Images and tables}). You can also use the
10412 @code{ATTR_LaTeX} line to request a @code{longtable} environment for the
10413 table, so that it may span several pages, or to change the default table
10414 environment from @code{table} to @code{table*} or to change the default inner
10415 tabular environment to @code{tabularx} or @code{tabulary}. Finally, you can
10416 set the alignment string, and (with @code{tabularx} or @code{tabulary}) the
10421 @cindex #+ATTR_LaTeX
10423 #+CAPTION: A long table
10425 #+ATTR_LaTeX: longtable align=l|lp@{3cm@}r|l
10430 or to specify a multicolumn table with @code{tabulary}
10434 @cindex #+ATTR_LaTeX
10436 #+CAPTION: A wide table with tabulary
10438 #+ATTR_LaTeX: table* tabulary width=\textwidth
10443 @node Images in @LaTeX{} export, Beamer class export, Tables in @LaTeX{} export, @LaTeX{} and PDF export
10444 @subsection Images in @LaTeX{} export
10445 @cindex images, inline in @LaTeX{}
10446 @cindex inlining images in @LaTeX{}
10448 Images that are linked to without a description part in the link, like
10449 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
10450 output file resulting from @LaTeX{} processing. Org will use an
10451 @code{\includegraphics} macro to insert the image. If you have specified a
10452 caption and/or a label as described in @ref{Images and tables}, the figure
10453 will be wrapped into a @code{figure} environment and thus become a floating
10454 element. You can use an @code{#+ATTR_LaTeX:} line to specify various other
10455 options. You can ask org to export an image as a float without specifying
10456 a label or a caption by using the keyword @code{float} in this line. Various
10457 optional arguments to the @code{\includegraphics} macro can also be specified
10458 in this fashion. To modify the placement option of the floating environment,
10459 add something like @samp{placement=[h!]} to the attributes. It is to be noted
10460 this option can be used with tables as well@footnote{One can also take
10461 advantage of this option to pass other, unrelated options into the figure or
10462 table environment. For an example see the section ``Exporting org files'' in
10463 @url{http://orgmode.org/worg/org-hacks.html}}. For example the
10464 @code{#+ATTR_LaTeX:} line below is exported as the @code{figure} environment
10467 If you would like to let text flow around the image, add the word @samp{wrap}
10468 to the @code{#+ATTR_LaTeX:} line, which will make the figure occupy the left
10469 half of the page. To fine-tune, the @code{placement} field will be the set
10470 of additional arguments needed by the @code{wrapfigure} environment. Note
10471 that if you change the size of the image, you need to use compatible settings
10472 for @code{\includegraphics} and @code{wrapfigure}.
10476 @cindex #+ATTR_LaTeX
10478 #+CAPTION: The black-body emission of the disk around HR 4049
10479 #+LABEL: fig:SED-HR4049
10480 #+ATTR_LaTeX: width=5cm,angle=90
10481 [[./img/sed-hr4049.pdf]]
10483 #+ATTR_LaTeX: width=0.38\textwidth wrap placement=@{r@}@{0.4\textwidth@}
10487 If you wish to include an image which spans multiple columns in a page, you
10488 can use the keyword @code{multicolumn} in the @code{#+ATTR_LaTeX} line. This
10489 will export the image wrapped in a @code{figure*} environment.
10491 If you need references to a label created in this way, write
10492 @samp{\ref@{fig:SED-HR4049@}} just like in @LaTeX{}.
10494 @node Beamer class export, , Images in @LaTeX{} export, @LaTeX{} and PDF export
10495 @subsection Beamer class export
10497 The @LaTeX{} class @file{beamer} allows production of high quality presentations
10498 using @LaTeX{} and pdf processing. Org mode has special support for turning an
10499 Org mode file or tree into a @file{beamer} presentation.
10501 When the @LaTeX{} class for the current buffer (as set with @code{#+LaTeX_CLASS:
10502 beamer}) or subtree (set with a @code{LaTeX_CLASS} property) is
10503 @code{beamer}, a special export mode will turn the file or tree into a beamer
10504 presentation. Any tree with not-too-deep level nesting should in principle be
10505 exportable as a beamer presentation. By default, the top-level entries (or
10506 the first level below the selected subtree heading) will be turned into
10507 frames, and the outline structure below this level will become itemize lists.
10508 You can also configure the variable @code{org-beamer-frame-level} to a
10509 different level---then the hierarchy above frames will produce the sectioning
10510 structure of the presentation.
10512 A template for useful in-buffer settings or properties can be inserted into
10513 the buffer with @kbd{M-x org-insert-beamer-options-template}. Among other
10514 things, this will install a column view format which is very handy for
10515 editing special properties used by beamer.
10517 You can influence the structure of the presentation using the following
10522 The environment that should be used to format this entry. Valid environments
10523 are defined in the constant @code{org-beamer-environments-default}, and you
10524 can define more in @code{org-beamer-environments-extra}. If this property is
10525 set, the entry will also get a @code{:B_environment:} tag to make this
10526 visible. This tag has no semantic meaning, it is only a visual aid.
10527 @item BEAMER_envargs
10528 The beamer-special arguments that should be used for the environment, like
10529 @code{[t]} or @code{[<+->]} of @code{<2-3>}. If the @code{BEAMER_col}
10530 property is also set, something like @code{C[t]} can be added here as well to
10531 set an options argument for the implied @code{columns} environment.
10532 @code{c[t]} or @code{c<2->} will set an options for the implied @code{column}
10535 The width of a column that should start with this entry. If this property is
10536 set, the entry will also get a @code{:BMCOL:} property to make this visible.
10537 Also this tag is only a visual aid. When this is a plain number, it will be
10538 interpreted as a fraction of @code{\textwidth}. Otherwise it will be assumed
10539 that you have specified the units, like @samp{3cm}. The first such property
10540 in a frame will start a @code{columns} environment to surround the columns.
10541 This environment is closed when an entry has a @code{BEAMER_col} property
10542 with value 0 or 1, or automatically at the end of the frame.
10544 Additional commands that should be inserted after the environment has been
10545 opened. For example, when creating a frame, this can be used to specify
10549 Frames will automatically receive a @code{fragile} option if they contain
10550 source code that uses the verbatim environment. Special @file{beamer}
10551 specific code can be inserted using @code{#+BEAMER:} and
10552 @code{#+BEGIN_BEAMER...#+END_BEAMER} constructs, similar to other export
10553 backends, but with the difference that @code{#+LaTeX:} stuff will be included
10554 in the presentation as well.
10556 Outline nodes with @code{BEAMER_env} property value @samp{note} or
10557 @samp{noteNH} will be formatted as beamer notes, i,e, they will be wrapped
10558 into @code{\note@{...@}}. The former will include the heading as part of the
10559 note text, the latter will ignore the heading of that node. To simplify note
10560 generation, it is actually enough to mark the note with a @emph{tag} (either
10561 @code{:B_note:} or @code{:B_noteNH:}) instead of creating the
10562 @code{BEAMER_env} property.
10564 You can turn on a special minor mode @code{org-beamer-mode} for editing
10572 @orgcmd{C-c C-b,org-beamer-select-environment}
10573 In @code{org-beamer-mode}, this key offers fast selection of a beamer
10574 environment or the @code{BEAMER_col} property.
10577 Column view provides a great way to set the environment of a node and other
10578 important parameters. Make sure you are using a COLUMN format that is geared
10579 toward this special purpose. The command @kbd{M-x
10580 org-insert-beamer-options-template} defines such a format.
10582 Here is a simple example Org document that is intended for beamer export.
10585 #+LaTeX_CLASS: beamer
10586 #+TITLE: Example Presentation
10587 #+AUTHOR: Carsten Dominik
10588 #+LaTeX_CLASS_OPTIONS: [presentation]
10589 #+BEAMER_FRAME_LEVEL: 2
10590 #+BEAMER_HEADER_EXTRA: \usetheme@{Madrid@}\usecolortheme@{default@}
10591 #+COLUMNS: %35ITEM %10BEAMER_env(Env) %10BEAMER_envargs(Args) %4BEAMER_col(Col) %8BEAMER_extra(Ex)
10593 * This is the first structural section
10595 ** Frame 1 \\ with a subtitle
10596 *** Thanks to Eric Fraga :BMCOL:B_block:
10599 :BEAMER_envargs: C[t]
10602 for the first viable beamer setup in Org
10603 *** Thanks to everyone else :BMCOL:B_block:
10607 :BEAMER_envargs: <2->
10609 for contributing to the discussion
10610 **** This will be formatted as a beamer note :B_note:
10611 ** Frame 2 \\ where we will not use columns
10612 *** Request :B_block:
10613 Please test this stuff!
10619 For more information, see the documentation on Worg.
10621 @node DocBook export, OpenDocument Text export, @LaTeX{} and PDF export, Exporting
10622 @section DocBook export
10623 @cindex DocBook export
10625 @cindex Cui, Baoqiu
10627 Org contains a DocBook exporter written by Baoqiu Cui. Once an Org file is
10628 exported to DocBook format, it can be further processed to produce other
10629 formats, including PDF, HTML, man pages, etc., using many available DocBook
10630 tools and stylesheets.
10632 Currently DocBook exporter only supports DocBook V5.0.
10635 * DocBook export commands:: How to invoke DocBook export
10636 * Quoting DocBook code:: Incorporating DocBook code in Org files
10637 * Recursive sections:: Recursive sections in DocBook
10638 * Tables in DocBook export:: Tables are exported as HTML tables
10639 * Images in DocBook export:: How to insert figures into DocBook output
10640 * Special characters:: How to handle special characters
10643 @node DocBook export commands, Quoting DocBook code, DocBook export, DocBook export
10644 @subsection DocBook export commands
10646 @cindex region, active
10647 @cindex active region
10648 @cindex transient-mark-mode
10650 @orgcmd{C-c C-e D,org-export-as-docbook}
10651 @cindex property EXPORT_FILE_NAME
10652 Export as DocBook file. For an Org file, @file{myfile.org}, the DocBook XML
10653 file will be @file{myfile.xml}. The file will be overwritten without
10654 warning. If there is an active region@footnote{This requires
10655 @code{transient-mark-mode} to be turned on}, only the region will be
10656 exported. If the selected region is a single tree@footnote{To select the
10657 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
10658 title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
10659 property, that name will be used for the export.
10660 @orgcmd{C-c C-e V,org-export-as-docbook-pdf-and-open}
10661 Export as DocBook file, process to PDF, then open the resulting PDF file.
10663 @vindex org-export-docbook-xslt-proc-command
10664 @vindex org-export-docbook-xsl-fo-proc-command
10665 Note that, in order to produce PDF output based on exported DocBook file, you
10666 need to have XSLT processor and XSL-FO processor software installed on your
10667 system. Check variables @code{org-export-docbook-xslt-proc-command} and
10668 @code{org-export-docbook-xsl-fo-proc-command}.
10670 @vindex org-export-docbook-xslt-stylesheet
10671 The stylesheet argument @code{%s} in variable
10672 @code{org-export-docbook-xslt-proc-command} is replaced by the value of
10673 variable @code{org-export-docbook-xslt-stylesheet}, which needs to be set by
10674 the user. You can also overrule this global setting on a per-file basis by
10675 adding an in-buffer setting @code{#+XSLT:} to the Org file.
10677 @orgkey{C-c C-e v D}
10678 Export only the visible part of the document.
10681 @node Quoting DocBook code, Recursive sections, DocBook export commands, DocBook export
10682 @subsection Quoting DocBook code
10684 You can quote DocBook code in Org files and copy it verbatim into exported
10685 DocBook file with the following constructs:
10688 @cindex #+BEGIN_DOCBOOK
10690 #+DOCBOOK: Literal DocBook code for export
10694 @cindex #+BEGIN_DOCBOOK
10698 All lines between these markers are exported by DocBook exporter
10703 For example, you can use the following lines to include a DocBook warning
10704 admonition. As to what this warning says, you should pay attention to the
10705 document context when quoting DocBook code in Org files. You may make
10706 exported DocBook XML files invalid by not quoting DocBook code correctly.
10711 <para>You should know what you are doing when quoting DocBook XML code
10712 in your Org file. Invalid DocBook XML may be generated by
10713 DocBook exporter if you are not careful!</para>
10718 @node Recursive sections, Tables in DocBook export, Quoting DocBook code, DocBook export
10719 @subsection Recursive sections
10720 @cindex DocBook recursive sections
10722 DocBook exporter exports Org files as articles using the @code{article}
10723 element in DocBook. Recursive sections, i.e.@: @code{section} elements, are
10724 used in exported articles. Top level headlines in Org files are exported as
10725 top level sections, and lower level headlines are exported as nested
10726 sections. The entire structure of Org files will be exported completely, no
10727 matter how many nested levels of headlines there are.
10729 Using recursive sections makes it easy to port and reuse exported DocBook
10730 code in other DocBook document types like @code{book} or @code{set}.
10732 @node Tables in DocBook export, Images in DocBook export, Recursive sections, DocBook export
10733 @subsection Tables in DocBook export
10734 @cindex tables, in DocBook export
10736 Tables in Org files are exported as HTML tables, which have been supported since
10739 If a table does not have a caption, an informal table is generated using the
10740 @code{informaltable} element; otherwise, a formal table will be generated
10741 using the @code{table} element.
10743 @node Images in DocBook export, Special characters, Tables in DocBook export, DocBook export
10744 @subsection Images in DocBook export
10745 @cindex images, inline in DocBook
10746 @cindex inlining images in DocBook
10748 Images that are linked to without a description part in the link, like
10749 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]}, will be exported to DocBook
10750 using @code{mediaobject} elements. Each @code{mediaobject} element contains
10751 an @code{imageobject} that wraps an @code{imagedata} element. If you have
10752 specified a caption for an image as described in @ref{Images and tables}, a
10753 @code{caption} element will be added in @code{mediaobject}. If a label is
10754 also specified, it will be exported as an @code{xml:id} attribute of the
10755 @code{mediaobject} element.
10757 @vindex org-export-docbook-default-image-attributes
10758 Image attributes supported by the @code{imagedata} element, like @code{align}
10759 or @code{width}, can be specified in two ways: you can either customize
10760 variable @code{org-export-docbook-default-image-attributes} or use the
10761 @code{#+ATTR_DOCBOOK:} line. Attributes specified in variable
10762 @code{org-export-docbook-default-image-attributes} are applied to all inline
10763 images in the Org file to be exported (unless they are overridden by image
10764 attributes specified in @code{#+ATTR_DOCBOOK:} lines).
10766 The @code{#+ATTR_DOCBOOK:} line can be used to specify additional image
10767 attributes or override default image attributes for individual images. If
10768 the same attribute appears in both the @code{#+ATTR_DOCBOOK:} line and
10769 variable @code{org-export-docbook-default-image-attributes}, the former
10770 takes precedence. Here is an example about how image attributes can be
10775 @cindex #+ATTR_DOCBOOK
10777 #+CAPTION: The logo of Org mode
10778 #+LABEL: unicorn-svg
10779 #+ATTR_DOCBOOK: scalefit="1" width="100%" depth="100%"
10780 [[./img/org-mode-unicorn.svg]]
10783 @vindex org-export-docbook-inline-image-extensions
10784 By default, DocBook exporter recognizes the following image file types:
10785 @file{jpeg}, @file{jpg}, @file{png}, @file{gif}, and @file{svg}. You can
10786 customize variable @code{org-export-docbook-inline-image-extensions} to add
10787 more types to this list as long as DocBook supports them.
10789 @node Special characters, , Images in DocBook export, DocBook export
10790 @subsection Special characters in DocBook export
10791 @cindex Special characters in DocBook export
10793 @vindex org-export-docbook-doctype
10794 @vindex org-entities
10795 Special characters that are written in @TeX{}-like syntax, such as @code{\alpha},
10796 @code{\Gamma}, and @code{\Zeta}, are supported by DocBook exporter. These
10797 characters are rewritten to XML entities, like @code{α},
10798 @code{Γ}, and @code{Ζ}, based on the list saved in variable
10799 @code{org-entities}. As long as the generated DocBook file includes the
10800 corresponding entities, these special characters are recognized.
10802 You can customize variable @code{org-export-docbook-doctype} to include the
10803 entities you need. For example, you can set variable
10804 @code{org-export-docbook-doctype} to the following value to recognize all
10805 special characters included in XHTML entities:
10808 "<!DOCTYPE article [
10809 <!ENTITY % xhtml1-symbol PUBLIC
10810 \"-//W3C//ENTITIES Symbol for HTML//EN//XML\"
10811 \"http://www.w3.org/2003/entities/2007/xhtml1-symbol.ent\"
10818 @c begin opendocument
10820 @node OpenDocument Text export, TaskJuggler export, DocBook export, Exporting
10821 @section OpenDocument Text export
10822 @cindex K, Jambunathan
10824 @cindex OpenDocument
10825 @cindex export, OpenDocument
10826 @cindex LibreOffice
10828 @cindex org-modules
10830 Orgmode@footnote{Versions 7.8 or later} supports export to OpenDocument Text
10831 (@acronym{ODT}) format using the @file{org-odt.el} module. Documents created
10832 by this exporter use the @cite{OpenDocument-v1.2
10833 specification}@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
10834 Open Document Format for Office Applications (OpenDocument) Version 1.2}} and
10835 are compatible with LibreOffice 3.4.
10838 * Pre-requisites for @acronym{ODT} export:: What packages @acronym{ODT} exporter relies on
10839 * @acronym{ODT} export commands:: How to invoke @acronym{ODT} export
10840 * Applying custom styles:: How to apply custom styles to the output
10841 * Links in @acronym{ODT} export:: How links will be interpreted and formatted
10842 * Tables in @acronym{ODT} export:: How Tables are exported
10843 * Images in @acronym{ODT} export:: How to insert images
10844 * Math formatting in @acronym{ODT} export:: How @LaTeX{} fragments are formatted
10845 * Literal examples in @acronym{ODT} export:: How source and example blocks are formatted
10846 * Advanced topics in @acronym{ODT} export:: Read this if you are a power user
10849 @node Pre-requisites for @acronym{ODT} export, @acronym{ODT} export commands, OpenDocument Text export, OpenDocument Text export
10850 @subsection Pre-requisites for @acronym{ODT} export
10852 The @acronym{ODT} exporter relies on the @file{zip} program to create the final
10853 output. Check the availability of this program before proceeding further.
10855 @node @acronym{ODT} export commands, Applying custom styles, Pre-requisites for @acronym{ODT} export, OpenDocument Text export
10856 @subsection @acronym{ODT} export commands
10858 @subsubheading Exporting to @acronym{ODT}
10859 @anchor{x-export-to-odt}
10861 @cindex region, active
10862 @cindex active region
10863 @cindex transient-mark-mode
10865 @orgcmd{C-c C-e o,org-export-as-odt}
10866 @cindex property EXPORT_FILE_NAME
10868 Export as OpenDocument Text file.
10869 @vindex org-export-odt-preferred-output-format
10870 If @code{org-export-odt-preferred-output-format} is specified, automatically
10871 convert the exported file to that format.
10872 @xref{x-export-to-other-formats,,Automatically exporting to other formats}.
10874 For an Org file @file{myfile.org}, the @acronym{ODT} file will be
10875 @file{myfile.odt}. The file will be overwritten without warning. If there
10876 is an active region,@footnote{This requires @code{transient-mark-mode} to be
10877 turned on} only the region will be exported. If the selected region is a
10878 single tree,@footnote{To select the current subtree, use @kbd{C-c @@}} the
10879 tree head will become the document title. If the tree head entry has, or
10880 inherits, an @code{EXPORT_FILE_NAME} property, that name will be used for the
10883 @orgcmd{C-c C-e O,org-export-as-odt-and-open}
10884 Export as OpenDocument Text file and open the resulting file.
10885 @vindex org-export-odt-preferred-output-format
10886 If @code{org-export-odt-preferred-output-format} is specified, open the
10887 converted file instead.
10888 @xref{x-export-to-other-formats,,Automatically exporting to other formats}.
10891 @subsubheading Automatically exporting to other formats
10892 @anchor{x-export-to-other-formats}
10893 @vindex org-export-odt-preferred-output-format
10894 Very often, you will find yourself exporting to @acronym{ODT} format, only to
10895 immediately save the exported document to a different format like @samp{pdf}.
10896 In such cases, you will find it convenient to configure a converter
10897 (@pxref{Exporting and converting to other formats}) and specify your
10898 preferred output format by customizing the variable
10899 @code{org-export-odt-preferred-output-format}. This way, the export commands
10900 (@pxref{x-export-to-odt,,Exporting to ODT}) can be extended to also export to
10901 the preferred format.
10903 @node Applying custom styles, Links in @acronym{ODT} export, @acronym{ODT} export commands, OpenDocument Text export
10904 @subsection Applying custom styles
10905 @cindex styles, custom
10906 @cindex template, custom
10908 The @acronym{ODT} exporter ships with a set of OpenDocument styles
10909 (@pxref{Working with OpenDocument style files}) that ensure a well-formatted
10910 output. These factory styles, however, may not cater to your specific
10911 tastes. To customize the output, you can either modify the above styles
10912 files directly, or generate the required styles using an application like
10913 LibreOffice. The latter method is suitable for expert and non-expert
10914 users alike, and is described here.
10916 @subsubsection Applying custom styles - the easy way
10920 Create a sample @file{example.org} file with the below settings and export it
10921 to @acronym{ODT} format.
10924 #+OPTIONS: H:10 num:t
10928 Open the above @file{example.odt} using LibreOffice. Use the @file{Stylist}
10929 to locate the target styles - these typically have the @samp{Org} prefix -
10930 and modify those to your taste. Save the modified file either as an
10931 OpenDocument Text (@file{.odt}) or OpenDocument Template (@file{.ott}) file.
10934 @cindex #+ODT_STYLES_FILE
10935 @vindex org-export-odt-styles-file
10936 Customize the variable @code{org-export-odt-styles-file} and point it to the
10937 newly created file. For additional configuration options
10938 @pxref{x-overriding-factory-styles,,Overriding factory styles}.
10940 If you would like to choose a style on a per-file basis, you can use the
10941 @code{#+ODT_STYLES_FILE} option. A typical setting will look like
10944 #+ODT_STYLES_FILE: "/path/to/example.ott"
10950 #+ODT_STYLES_FILE: ("/path/to/file.ott" ("styles.xml" "image/hdr.png"))
10955 @subsubsection Using third-party styles and templates
10957 You can use third-party styles and templates for customizing your output.
10958 This will produce the desired output only if the template provides all
10959 style names that the @samp{ODT} exporter relies on. Unless this condition is
10960 met, the output is going to be less than satisfactory. So it is highly
10961 recommended that you only work with templates that are directly derived from
10962 the factory settings.
10964 @node Links in @acronym{ODT} export, Tables in @acronym{ODT} export, Applying custom styles, OpenDocument Text export
10965 @subsection Links in @acronym{ODT} export
10966 @cindex tables, in DocBook export
10968 The @acronym{ODT} exporter creates cross-references (aka bookmarks) for
10969 internal links. It creates Internet-style links for all other links.
10971 @node Tables in @acronym{ODT} export, Images in @acronym{ODT} export, Links in @acronym{ODT} export, OpenDocument Text export
10972 @subsection Tables in @acronym{ODT} export
10973 @cindex tables, in DocBook export
10975 Export of native Org mode tables (@pxref{Tables}) and simple @file{table.el}
10976 tables is supported. However, export of complex @file{table.el} tables -
10977 tables that have column or row spans - is not supported. Such tables are
10978 stripped from the exported document.
10980 By default, a table is exported with top and bottom frames and with
10981 rules separating row and column groups (@pxref{Column groups}). If the table
10982 specifies alignment and relative width for its columns (@pxref{Column width
10983 and alignment}) then these are honored on export.@footnote{The column widths
10984 are interpreted as weighted ratios with the default weight being 1}
10987 If you are not satisfied with the default formatting of tables, you can
10988 create custom table styles and associate them with a table using
10989 the @code{#+ATTR_ODT} line. @xref{Customizing tables in @acronym{ODT} export}.
10991 @node Images in @acronym{ODT} export, Math formatting in @acronym{ODT} export, Tables in @acronym{ODT} export, OpenDocument Text export
10992 @subsection Images in @acronym{ODT} export
10993 @cindex images, embedding in @acronym{ODT}
10994 @cindex embedding images in @acronym{ODT}
10996 @subsubheading Embedding images
10997 You can embed images within the exported document by providing a link to the
10998 desired image file with no link description. For example, to embed
10999 @samp{img.png} do either of the following:
11009 @subsubheading Embedding clickable images
11010 You can create clickable images by providing a link whose description is a
11011 link to an image file. For example, to embed a image
11012 @file{org-mode-unicorn.png} which when clicked jumps to
11013 @uref{http://Orgmode.org} website, do the following
11016 [[http://orgmode.org][./org-mode-unicorn.png]]
11019 @subsubheading Sizing and scaling of embedded images
11021 You can control the size and scale of the embedded images using the
11022 @code{#+ATTR_ODT} attribute.
11024 @vindex org-export-odt-pixels-per-inch
11025 Note that the exporter specifies the desired size of the image in the final
11026 document in units of centimeters. In order to scale the embedded images, the
11027 exporter needs to compute the size of the image. This is done by retrieving
11028 the image size in pixels and converting the pixel units to centimeters using
11029 @code{org-export-odt-pixels-per-inch}. The default value of this variable is
11030 set to @code{display-pixels-per-inch}. You can tweak this variable to
11031 achieve the best results.
11033 The examples below illustrate the various possibilities.
11037 @item Explicitly size the image
11038 To embed @file{img.png} as a 10 cm x 10 cm image, do the following:
11041 #+ATTR_ODT: :width 10 :height 10
11045 @item Scale the image
11046 To embed @file{img.png} at half its size, do the following:
11049 #+ATTR_ODT: :scale 0.5
11053 @item Scale the image to a specific width
11054 To embed @file{img.png} with a width of 10 cm while retaining the original
11055 height:width ratio, do the following:
11058 #+ATTR_ODT: :width 10
11062 @item Scale the image to a specific height
11063 To embed @file{img.png} with a height of 10 cm while retaining the original
11064 height:width ratio, do the following
11067 #+ATTR_ODT: :height 10
11072 @node Math formatting in @acronym{ODT} export, Literal examples in @acronym{ODT} export, Images in @acronym{ODT} export, OpenDocument Text export
11073 @subsection Math formatting in @acronym{ODT} export
11075 The @acronym{ODT} exporter has special support for handling math.
11078 * Working with @LaTeX{} math snippets:: How to embed @LaTeX{} math fragments
11079 * Working with MathML or OpenDocument formula files:: How to embed equations in native format
11082 @node Working with @LaTeX{} math snippets, Working with MathML or OpenDocument formula files, Math formatting in @acronym{ODT} export, Math formatting in @acronym{ODT} export
11083 @subsubsection Working with @LaTeX{} math snippets
11085 @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be embedded in the ODT
11086 document in one of the following ways:
11092 This option is activated on a per-file basis with
11098 With this option, @LaTeX{} fragments are first converted into MathML
11099 fragments using an external @LaTeX{}-to-MathML converter program. The
11100 resulting MathML fragments are then embedded as an OpenDocument Formula in
11101 the exported document.
11103 @vindex org-latex-to-mathml-convert-command
11104 @vindex org-latex-to-mathml-jar-file
11106 You can specify the @LaTeX{}-to-MathML converter by customizing the variables
11107 @code{org-latex-to-mathml-convert-command} and
11108 @code{org-latex-to-mathml-jar-file}.
11110 If you prefer to use @file{MathToWeb}@footnote{See
11111 @uref{http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl, MathToWeb}} as your
11112 converter, you can configure the above variables as shown below.
11115 (setq org-latex-to-mathml-convert-command
11116 "java -jar %j -unicode -force -df %o %I"
11117 org-latex-to-mathml-jar-file
11118 "/path/to/mathtoweb.jar")
11121 You can use the following commands to quickly verify the reliability of
11122 the @LaTeX{}-to-MathML converter.
11126 @item M-x org-export-as-odf
11127 Convert a @LaTeX{} math snippet to OpenDocument formula (@file{.odf}) file.
11129 @item M-x org-export-as-odf-and-open
11130 Convert a @LaTeX{} math snippet to OpenDocument formula (@file{.odf}) file and
11131 open the formula file with the system-registered application.
11137 This option is activated on a per-file basis with
11140 #+OPTIONS: LaTeX:dvipng
11143 With this option, @LaTeX{} fragments are processed into PNG images and the
11144 resulting images are embedded in the exported document. This method requires
11145 that the @file{dvipng} program be available on your system.
11148 @node Working with MathML or OpenDocument formula files, , Working with @LaTeX{} math snippets, Math formatting in @acronym{ODT} export
11149 @subsubsection Working with MathML or OpenDocument formula files
11151 For various reasons, you may find embedding @LaTeX{} math snippets in an
11152 @acronym{ODT} document less than reliable. In that case, you can embed a
11153 math equation by linking to its MathML(@file{.mml}) source or its
11154 OpenDocument formula (@file{.odf}) file as shown below:
11166 @node Literal examples in @acronym{ODT} export, Advanced topics in @acronym{ODT} export, Math formatting in @acronym{ODT} export, OpenDocument Text export
11167 @subsection Literal examples in @acronym{ODT} export
11169 Export of literal examples (@pxref{Literal examples}) with full fontification
11170 is supported. This feature is enabled by default and is activated
11171 automatically if an enhanced version of @file{htmlfontify.el} is available in
11172 the @code{load-path}.@footnote{The @file{htmlfontify.el} that ships with
11173 standard Emacs <= 24.1 has no support for @acronym{ODT} fontification. A
11174 copy of the proposed version is available as an attachment to
11175 @url{http://debbugs.gnu.org/cgi/bugreport.cgi?msg=5;filename=htmlfontify.el;att=9;bug=9914,
11178 @vindex org-export-odt-fontify-srcblocks
11180 The character styles used for fontification of the literal blocks are
11181 auto-generated by the exporter in conjunction with @file{htmlfontify.el}
11182 library and need not be included in the default @file{styles.xml} file.
11183 These auto-generated styles have the @samp{OrgSrc} prefix and inherit their color
11184 based on the face used by Emacs @code{font-lock} library.
11186 @vindex org-export-odt-create-custom-styles-for-srcblocks
11187 If you prefer to use your own custom styles for fontification and disable
11188 their auto-generation altogether, you can do so by customizing the variable
11189 @code{org-export-odt-create-custom-styles-for-srcblocks}.
11191 You can turn off fontification support for literal examples by customizing
11192 the variable @code{org-export-odt-fontify-srcblocks}.
11195 @node Advanced topics in @acronym{ODT} export, , Literal examples in @acronym{ODT} export, OpenDocument Text export
11196 @subsection Advanced topics in @acronym{ODT} export
11198 If you rely heavily on @acronym{ODT} export, you may want to exploit the full
11199 set of features that the exporter offers. This section describes features
11200 that would be of interest to power users.
11203 * Exporting and converting to other formats:: How to produce @samp{pdf} and other formats
11204 * Working with OpenDocument style files:: Explore the internals
11205 * Creating one-off styles:: How to produce custom highlighting etc
11206 * Customizing tables in @acronym{ODT} export:: How to define and use Table templates
11207 * Validating OpenDocument XML:: How to debug corrupt OpenDocument files
11210 @node Exporting and converting to other formats, Working with OpenDocument style files, Advanced topics in @acronym{ODT} export, Advanced topics in @acronym{ODT} export
11211 @subsubsection Exporting and converting to other formats
11215 The @acronym{ODT} exporter adds support for exporting Org outlines to formats
11216 that are not supported natively by Org. It also adds support to convert
11217 document from one format to another. To use these features, you need to
11218 configure a command-line converter. Once a command-line converter is
11219 configured you can use it to extend the list of formats to which Org can
11220 export. @xref{x-export-to-other-formats,,Automatically exporting to other
11221 formats}. You can also use it to perform one-off document conversion as
11224 @vindex org-export-odt-convert
11227 @item M-x org-export-odt-convert
11228 Convert an existing document from one format to another as determined by the
11229 variable @code{org-export-odt-convert-capabilities}
11230 (@pxref{x-odt-converter-capabilities,,Configure converter
11231 capabilities}). @strong{Please note} that you can use this command to even
11232 convert documents that are produced outside of Org and in other formats than
11233 @acronym{ODT} format.
11236 @subsubheading Pre-configured converters
11239 The @acronym{ODT} exporter supports two converters out of the box:
11243 @cindex @file{unoconv}
11244 @item @file{unoconv}
11246 This converter is available as an installable package in your favorite
11249 @cindex @file{BasicODConverter}
11250 @item @file{BasicODConverter}
11252 @vindex org-odt-data-dir
11253 This converter is distributed as a LibreOffice extension and can be found in
11254 your Org distribution. See the subdirectory pointed to by the variable
11255 @code{org-odt-data-dir}.
11259 @subsubheading Installing a new converter
11260 If you prefer to use a converter other than the two mentioned above, then you
11261 may have to do additional configuration. You can proceed as follows:
11264 @item Register the converter
11266 @vindex org-export-odt-convert-processes
11267 Name your converter and add it to the list of known converters by customizing
11268 the variable @code{org-export-odt-convert-processes}. Also specify how the
11269 converter can be invoked via command-line to effect the conversion.
11271 @item Configure its capabilities
11272 @vindex org-export-odt-convert-capabilities
11274 @anchor{x-odt-converter-capabilities}
11276 Specify the set of formats the converter can handle by customizing the
11277 variable @code{org-export-odt-convert-capabilities}. Use the default value
11278 for this variable as a guide for configuring your converter. As suggested by
11279 the default setting, you can specify the full set of formats supported by the
11280 converter and not limit yourself to specifying formats that are related to
11281 just the OpenDocument Text format.
11283 @item Choose the converter
11285 @vindex org-export-odt-convert-process
11286 Select the newly added converter as the preferred one by customizing the
11287 variable @code{org-export-odt-convert-process}.
11290 @node Working with OpenDocument style files, Creating one-off styles, Exporting and converting to other formats, Advanced topics in @acronym{ODT} export
11291 @subsubsection Working with OpenDocument style files
11292 @cindex styles, custom
11293 @cindex template, custom
11295 This section explores the internals of the @acronym{ODT} exporter and the
11296 means by which it produces styled documents. Read this section if you are
11297 interested in exploring the automatic and custom OpenDocument styles used by
11300 @anchor{x-factory-styles}
11301 @subsubheading Factory styles
11303 The @acronym{ODT} exporter relies on two files for generating its output.
11304 These files are bundled with the distribution under the directory pointed to
11305 by the variable @code{org-odt-styles-dir}. The two files are:
11308 @anchor{x-orgodtstyles-xml}
11310 @file{OrgOdtStyles.xml}
11312 This file contributes to the @file{styles.xml} file of the final @samp{ODT}
11313 document. This file gets modified for the following purposes:
11317 To control outline numbering based on user settings.
11320 To add styles generated by @file{htmlfontify.el} for fontification of code
11324 @anchor{x-orgodtcontenttemplate-xml}
11326 @file{OrgOdtContentTemplate.xml}
11328 This file contributes to the @file{content.xml} file of the final @samp{ODT}
11329 document. The contents of the Org outline are inserted between the
11330 @samp{<office:text>}@dots{}@samp{</office:text>} elements of this file.
11332 Apart from serving as a template file for the final @file{content.xml}, the
11333 file serves the following purposes:
11337 It contains automatic styles for formatting of tables which are referenced by
11341 It contains @samp{<text:sequence-decl>}@dots{}@samp{</text:sequence-decl>}
11342 elements that control how various entities - tables, images, equations etc -
11347 @anchor{x-overriding-factory-styles}
11348 @subsubheading Overriding factory styles
11349 The following two variables control the location from which the @acronym{ODT}
11350 exporter picks up the custom styles and content template files. You can
11351 customize these variables to override the factory styles used by the
11355 @anchor{x-org-export-odt-styles-file}
11357 @code{org-export-odt-styles-file}
11359 Use this variable to specify the @file{styles.xml} that will be used in the
11360 final output. You can specify one of the following values:
11363 @item A @file{styles.xml} file
11365 Use this file instead of the default @file{styles.xml}
11367 @item A @file{.odt} or @file{.ott} file
11369 Use the @file{styles.xml} contained in the specified OpenDocument Text or
11372 @item A @file{.odt} or @file{.ott} file and a subset of files contained within them
11374 Use the @file{styles.xml} contained in the specified OpenDocument Text or
11375 Template file. Additionally extract the specified member files and embed
11376 those within the final @samp{ODT} document.
11378 Use this option if the @file{styles.xml} file references additional files
11379 like header and footer images.
11383 Use the default @file{styles.xml}
11386 @anchor{x-org-export-odt-content-template-file}
11388 @code{org-export-odt-content-template-file}
11390 Use this variable to specify the blank @file{content.xml} that will be used
11391 in the final output.
11394 @node Creating one-off styles, Customizing tables in @acronym{ODT} export, Working with OpenDocument style files, Advanced topics in @acronym{ODT} export
11395 @subsubsection Creating one-off styles
11397 There are times when you would want one-off formatting in the exported
11398 document. You can achieve this by embedding raw OpenDocument XML in the Org
11399 file. The use of this feature is better illustrated with couple of examples.
11402 @item Embedding ODT tags as part of regular text
11404 You can include simple OpenDocument tags by prefixing them with
11405 @samp{@@}. For example, to highlight a region of text do the following:
11408 @@<text:span text:style-name="Highlight">This is a
11409 highlighted text@@</text:span>. But this is a
11413 @strong{Hint:} To see the above example in action, edit your
11414 @file{styles.xml}(@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
11415 custom @samp{Highlight} style as shown below.
11418 <style:style style:name="Highlight" style:family="text">
11419 <style:text-properties fo:background-color="#ff0000"/>
11423 @item Embedding a one-line OpenDocument XML
11425 You can add a simple OpenDocument one-liner using the @code{#+ODT:}
11426 directive. For example, to force a page break do the following:
11429 #+ODT: <text:p text:style-name="PageBreak"/>
11432 @strong{Hint:} To see the above example in action, edit your
11433 @file{styles.xml}(@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
11434 custom @samp{PageBreak} style as shown below.
11437 <style:style style:name="PageBreak" style:family="paragraph"
11438 style:parent-style-name="Text_20_body">
11439 <style:paragraph-properties fo:break-before="page"/>
11443 @item Embedding a block of OpenDocument XML
11445 You can add a large block of OpenDocument XML using the
11446 @code{#+BEGIN_ODT}@dots{}@code{#+END_ODT} construct.
11448 For example, to create a one-off paragraph that uses bold text, do the
11453 <text:p text:style-name="Text_20_body_20_bold">
11454 This paragraph is specially formatted and uses bold text.
11461 @node Customizing tables in @acronym{ODT} export, Validating OpenDocument XML, Creating one-off styles, Advanced topics in @acronym{ODT} export
11462 @subsubsection Customizing tables in @acronym{ODT} export
11463 @cindex tables, in ODT export
11466 You can override the default formatting of the table by specifying a custom
11467 table style with the @code{#+ATTR_ODT} line. For a discussion on default
11468 formatting of tables @pxref{Tables in @acronym{ODT} export}.
11470 This feature closely mimics the way table templates are defined in the
11472 specification.@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
11473 OpenDocument-v1.2 Specification}}
11477 @subsubheading Custom table styles - an illustration
11479 To have a quick preview of this feature, install the below setting and export
11480 the table that follows.
11483 (setq org-export-odt-table-styles
11484 (append org-export-odt-table-styles
11485 '(("TableWithHeaderRowAndColumn" "Custom"
11486 ((use-first-row-styles . t)
11487 (use-first-column-styles . t)))
11488 ("TableWithFirstRowandLastRow" "Custom"
11489 ((use-first-row-styles . t)
11490 (use-last-row-styles . t))))))
11494 #+ATTR_ODT: TableWithHeaderRowAndColumn
11495 | Name | Phone | Age |
11496 | Peter | 1234 | 17 |
11497 | Anna | 4321 | 25 |
11500 In the above example, you used a template named @samp{Custom} and installed
11501 two table styles with the names @samp{TableWithHeaderRowAndColumn} and
11502 @samp{TableWithFirstRowandLastRow}. (@strong{Important:} The OpenDocument
11503 styles needed for producing the above template have been pre-defined for you.
11504 These styles are available under the section marked @samp{Custom Table
11505 Template} in @file{OrgOdtContentTemplate.xml}
11506 (@pxref{x-orgodtcontenttemplate-xml,,Factory styles}). If you need
11507 additional templates you have to define these styles yourselves.
11509 @subsubheading Custom table styles - the nitty-gritty
11510 To use this feature proceed as follows:
11514 Create a table template@footnote{See the @code{<table:table-template>}
11515 element of the OpenDocument-v1.2 specification}
11517 A table template is nothing but a set of @samp{table-cell} and
11518 @samp{paragraph} styles for each of the following table cell categories:
11532 The names for the above styles must be chosen based on the name of the table
11533 template using a well-defined convention.
11535 The naming convention is better illustrated with an example. For a table
11536 template with the name @samp{Custom}, the needed style names are listed in
11537 the following table.
11539 @multitable {Table cell type} {CustomEvenColumnTableCell} {CustomEvenColumnTableParagraph}
11540 @headitem Table cell type
11541 @tab @code{table-cell} style
11542 @tab @code{paragraph} style
11547 @tab @samp{CustomTableCell}
11548 @tab @samp{CustomTableParagraph}
11550 @tab @samp{CustomFirstColumnTableCell}
11551 @tab @samp{CustomFirstColumnTableParagraph}
11553 @tab @samp{CustomLastColumnTableCell}
11554 @tab @samp{CustomLastColumnTableParagraph}
11556 @tab @samp{CustomFirstRowTableCell}
11557 @tab @samp{CustomFirstRowTableParagraph}
11559 @tab @samp{CustomLastRowTableCell}
11560 @tab @samp{CustomLastRowTableParagraph}
11562 @tab @samp{CustomEvenRowTableCell}
11563 @tab @samp{CustomEvenRowTableParagraph}
11565 @tab @samp{CustomOddRowTableCell}
11566 @tab @samp{CustomOddRowTableParagraph}
11568 @tab @samp{CustomEvenColumnTableCell}
11569 @tab @samp{CustomEvenColumnTableParagraph}
11571 @tab @samp{CustomOddColumnTableCell}
11572 @tab @samp{CustomOddColumnTableParagraph}
11575 To create a table template with the name @samp{Custom}, define the above
11577 @code{<office:automatic-styles>}...@code{</office:automatic-styles>} element
11578 of the content template file (@pxref{x-orgodtcontenttemplate-xml,,Factory
11582 Define a table style@footnote{See the attributes @code{table:template-name},
11583 @code{table:use-first-row-styles}, @code{table:use-last-row-styles},
11584 @code{table:use-first-column-styles}, @code{table:use-last-column-styles},
11585 @code{table:use-banding-rows-styles}, and
11586 @code{table:use-banding-column-styles} of the @code{<table:table>} element in
11587 the OpenDocument-v1.2 specification}
11589 @vindex org-export-odt-table-styles
11590 To define a table style, create an entry for the style in the variable
11591 @code{org-export-odt-table-styles} and specify the following:
11594 @item the name of the table template created in step (1)
11595 @item the set of cell styles in that template that are to be activated
11598 For example, the entry below defines two different table styles
11599 @samp{TableWithHeaderRowsAndColumns} and @samp{TableWithHeaderColumns} based
11600 on the same template @samp{Custom}. The styles achieve their intended effect
11601 by selectively activating the individual cell styles in that template.
11604 (setq org-export-odt-table-styles
11605 (append org-export-odt-table-styles
11606 '(("TableWithHeaderRowAndColumn" "Custom"
11607 ((use-first-row-styles . t)
11608 (use-first-column-styles . t)))
11609 ("TableWithFirstRowandLastRow" "Custom"
11610 ((use-first-row-styles . t)
11611 (use-last-row-styles . t))))))
11615 Associate a table with the table style
11617 To do this, specify the table style created in step (2) as part of
11618 the @code{ATTR_ODT} line as shown below.
11621 #+ATTR_ODT: TableWithHeaderRowAndColumn
11622 | Name | Phone | Age |
11623 | Peter | 1234 | 17 |
11624 | Anna | 4321 | 25 |
11628 @node Validating OpenDocument XML, , Customizing tables in @acronym{ODT} export, Advanced topics in @acronym{ODT} export
11629 @subsubsection Validating OpenDocument XML
11631 Occasionally, you will discover that the document created by the
11632 @acronym{ODT} exporter cannot be opened by your favorite application. One of
11633 the common reasons for this is that the @file{.odt} file is corrupt. In such
11634 cases, you may want to validate the document against the OpenDocument RELAX
11635 NG Compact Syntax (RNC) schema.
11637 For de-compressing the @file{.odt} file@footnote{@file{.odt} files are
11638 nothing but @samp{zip} archives}: @inforef{File Archives,,emacs}. For
11639 general help with validation (and schema-sensitive editing) of XML files:
11640 @inforef{Introduction,,nxml-mode}.
11642 @vindex org-export-odt-schema-dir
11643 If you have ready access to OpenDocument @file{.rnc} files and the needed
11644 schema-locating rules in a single folder, you can customize the variable
11645 @code{org-export-odt-schema-dir} to point to that directory. The
11646 @acronym{ODT} exporter will take care of updating the
11647 @code{rng-schema-locating-files} for you.
11649 @c end opendocument
11651 @node TaskJuggler export, Freemind export, OpenDocument Text export, Exporting
11652 @section TaskJuggler export
11653 @cindex TaskJuggler export
11654 @cindex Project management
11656 @uref{http://www.taskjuggler.org/, TaskJuggler} is a project management tool.
11657 It provides an optimizing scheduler that computes your project time lines and
11658 resource assignments based on the project outline and the constraints that
11661 The TaskJuggler exporter is a bit different from other exporters, such as the
11662 @code{HTML} and @LaTeX{} exporters for example, in that it does not export all the
11663 nodes of a document or strictly follow the order of the nodes in the
11666 Instead the TaskJuggler exporter looks for a tree that defines the tasks and
11667 a optionally tree that defines the resources for this project. It then
11668 creates a TaskJuggler file based on these trees and the attributes defined in
11671 @subsection TaskJuggler export commands
11674 @orgcmd{C-c C-e j,org-export-as-taskjuggler}
11675 Export as TaskJuggler file.
11677 @orgcmd{C-c C-e J,org-export-as-taskjuggler-and-open}
11678 Export as TaskJuggler file and then open the file with TaskJugglerUI.
11683 @vindex org-export-taskjuggler-project-tag
11684 Create your tasks as you usually do with Org mode. Assign efforts to each
11685 task using properties (it is easiest to do this in the column view). You
11686 should end up with something similar to the example by Peter Jones in
11687 @url{http://www.contextualdevelopment.com/static/artifacts/articles/2008/project-planning/project-planning.org}.
11688 Now mark the top node of your tasks with a tag named
11689 @code{:taskjuggler_project:} (or whatever you customized
11690 @code{org-export-taskjuggler-project-tag} to). You are now ready to export
11691 the project plan with @kbd{C-c C-e J} which will export the project plan and
11692 open a gantt chart in TaskJugglerUI.
11694 @subsection Resources
11696 @vindex org-export-taskjuggler-resource-tag
11697 Next you can define resources and assign those to work on specific tasks. You
11698 can group your resources hierarchically. Tag the top node of the resources
11699 with @code{:taskjuggler_resource:} (or whatever you customized
11700 @code{org-export-taskjuggler-resource-tag} to). You can optionally assign an
11701 identifier (named @samp{resource_id}) to the resources (using the standard
11702 Org properties commands, @pxref{Property syntax}) or you can let the exporter
11703 generate identifiers automatically (the exporter picks the first word of the
11704 headline as the identifier as long as it is unique---see the documentation of
11705 @code{org-taskjuggler-get-unique-id}). Using that identifier you can then
11706 allocate resources to tasks. This is again done with the @samp{allocate}
11707 property on the tasks. Do this in column view or when on the task type
11708 @kbd{C-c C-x p allocate @key{RET} <resource_id> @key{RET}}.
11710 Once the allocations are done you can again export to TaskJuggler and check
11711 in the Resource Allocation Graph which person is working on what task at what
11714 @subsection Export of properties
11716 The exporter also takes TODO state information into consideration, i.e.@: if a
11717 task is marked as done it will have the corresponding attribute in
11718 TaskJuggler (@samp{complete 100}). Also it will export any property on a task
11719 resource or resource node which is known to TaskJuggler, such as
11720 @samp{limits}, @samp{vacation}, @samp{shift}, @samp{booking},
11721 @samp{efficiency}, @samp{journalentry}, @samp{rate} for resources or
11722 @samp{account}, @samp{start}, @samp{note}, @samp{duration}, @samp{end},
11723 @samp{journalentry}, @samp{milestone}, @samp{reference}, @samp{responsible},
11724 @samp{scheduling}, etc for tasks.
11726 @subsection Dependencies
11728 The exporter will handle dependencies that are defined in the tasks either
11729 with the @samp{ORDERED} attribute (@pxref{TODO dependencies}), with the
11730 @samp{BLOCKER} attribute (see @file{org-depend.el}) or alternatively with a
11731 @samp{depends} attribute. Both the @samp{BLOCKER} and the @samp{depends}
11732 attribute can be either @samp{previous-sibling} or a reference to an
11733 identifier (named @samp{task_id}) which is defined for another task in the
11734 project. @samp{BLOCKER} and the @samp{depends} attribute can define multiple
11735 dependencies separated by either space or comma. You can also specify
11736 optional attributes on the dependency by simply appending it. The following
11737 examples should illustrate this:
11742 :task_id: preparation
11745 * Training material
11747 :task_id: training_material
11750 ** Markup Guidelines
11754 ** Workflow Guidelines
11761 :BLOCKER: training_material @{ gapduration 1d @} preparation
11765 @subsection Reports
11767 @vindex org-export-taskjuggler-default-reports
11768 TaskJuggler can produce many kinds of reports (e.g.@: gantt chart, resource
11769 allocation, etc). The user defines what kind of reports should be generated
11770 for a project in the TaskJuggler file. The exporter will automatically insert
11771 some default reports in the file. These defaults are defined in
11772 @code{org-export-taskjuggler-default-reports}. They can be modified using
11773 customize along with a number of other options. For a more complete list, see
11774 @kbd{M-x customize-group @key{RET} org-export-taskjuggler @key{RET}}.
11776 For more information and examples see the Org-taskjuggler tutorial at
11777 @uref{http://orgmode.org/worg/org-tutorials/org-taskjuggler.html}.
11779 @node Freemind export, XOXO export, TaskJuggler export, Exporting
11780 @section Freemind export
11781 @cindex Freemind export
11784 The Freemind exporter was written by Lennart Borgman.
11787 @orgcmd{C-c C-e m,org-export-as-freemind}
11788 Export as Freemind mind map. For an Org file @file{myfile.org}, the Freemind
11789 file will be @file{myfile.mm}.
11792 @node XOXO export, iCalendar export, Freemind export, Exporting
11793 @section XOXO export
11794 @cindex XOXO export
11796 Org mode contains an exporter that produces XOXO-style output.
11797 Currently, this exporter only handles the general outline structure and
11798 does not interpret any additional Org mode features.
11801 @orgcmd{C-c C-e x,org-export-as-xoxo}
11802 Export as XOXO file. For an Org file @file{myfile.org}, the XOXO file will be
11803 @file{myfile.html}.
11804 @orgkey{C-c C-e v x}
11805 Export only the visible part of the document.
11808 @node iCalendar export, , XOXO export, Exporting
11809 @section iCalendar export
11810 @cindex iCalendar export
11812 @vindex org-icalendar-include-todo
11813 @vindex org-icalendar-use-deadline
11814 @vindex org-icalendar-use-scheduled
11815 @vindex org-icalendar-categories
11816 @vindex org-icalendar-alarm-time
11817 Some people use Org mode for keeping track of projects, but still prefer a
11818 standard calendar application for anniversaries and appointments. In this
11819 case it can be useful to show deadlines and other time-stamped items in Org
11820 files in the calendar application. Org mode can export calendar information
11821 in the standard iCalendar format. If you also want to have TODO entries
11822 included in the export, configure the variable
11823 @code{org-icalendar-include-todo}. Plain timestamps are exported as VEVENT,
11824 and TODO items as VTODO. It will also create events from deadlines that are
11825 in non-TODO items. Deadlines and scheduling dates in TODO items will be used
11826 to set the start and due dates for the TODO entry@footnote{See the variables
11827 @code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}.
11828 As categories, it will use the tags locally defined in the heading, and the
11829 file/tree category@footnote{To add inherited tags or the TODO state,
11830 configure the variable @code{org-icalendar-categories}.}. See the variable
11831 @code{org-icalendar-alarm-time} for a way to assign alarms to entries with a
11834 @vindex org-icalendar-store-UID
11835 @cindex property, ID
11836 The iCalendar standard requires each entry to have a globally unique
11837 identifier (UID). Org creates these identifiers during export. If you set
11838 the variable @code{org-icalendar-store-UID}, the UID will be stored in the
11839 @code{:ID:} property of the entry and re-used next time you report this
11840 entry. Since a single entry can give rise to multiple iCalendar entries (as
11841 a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
11842 prefixes to the UID, depending on what triggered the inclusion of the entry.
11843 In this way the UID remains unique, but a synchronization program can still
11844 figure out from which entry all the different instances originate.
11847 @orgcmd{C-c C-e i,org-export-icalendar-this-file}
11848 Create iCalendar entries for the current file and store them in the same
11849 directory, using a file extension @file{.ics}.
11850 @orgcmd{C-c C-e I, org-export-icalendar-all-agenda-files}
11851 @vindex org-agenda-files
11852 Like @kbd{C-c C-e i}, but do this for all files in
11853 @code{org-agenda-files}. For each of these files, a separate iCalendar
11854 file will be written.
11855 @orgcmd{C-c C-e c,org-export-icalendar-combine-agenda-files}
11856 @vindex org-combined-agenda-icalendar-file
11857 Create a single large iCalendar file from all files in
11858 @code{org-agenda-files} and write it to the file given by
11859 @code{org-combined-agenda-icalendar-file}.
11862 @vindex org-use-property-inheritance
11863 @vindex org-icalendar-include-body
11864 @cindex property, SUMMARY
11865 @cindex property, DESCRIPTION
11866 @cindex property, LOCATION
11867 The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION
11868 property can be inherited from higher in the hierarchy if you configure
11869 @code{org-use-property-inheritance} accordingly.} properties if the selected
11870 entries have them. If not, the summary will be derived from the headline,
11871 and the description from the body (limited to
11872 @code{org-icalendar-include-body} characters).
11874 How this calendar is best read and updated, depends on the application
11875 you are using. The FAQ covers this issue.
11877 @node Publishing, Working With Source Code, Exporting, Top
11878 @chapter Publishing
11881 Org includes a publishing management system that allows you to configure
11882 automatic HTML conversion of @emph{projects} composed of interlinked org
11883 files. You can also configure Org to automatically upload your exported HTML
11884 pages and related attachments, such as images and source code files, to a web
11887 You can also use Org to convert files into PDF, or even combine HTML and PDF
11888 conversion so that files are available in both formats on the server.
11890 Publishing has been contributed to Org by David O'Toole.
11893 * Configuration:: Defining projects
11894 * Uploading files:: How to get files up on the server
11895 * Sample configuration:: Example projects
11896 * Triggering publication:: Publication commands
11899 @node Configuration, Uploading files, Publishing, Publishing
11900 @section Configuration
11902 Publishing needs significant configuration to specify files, destination
11903 and many other properties of a project.
11906 * Project alist:: The central configuration variable
11907 * Sources and destinations:: From here to there
11908 * Selecting files:: What files are part of the project?
11909 * Publishing action:: Setting the function doing the publishing
11910 * Publishing options:: Tweaking HTML/@LaTeX{} export
11911 * Publishing links:: Which links keep working after publishing?
11912 * Sitemap:: Generating a list of all pages
11913 * Generating an index:: An index that reaches across pages
11916 @node Project alist, Sources and destinations, Configuration, Configuration
11917 @subsection The variable @code{org-publish-project-alist}
11918 @cindex org-publish-project-alist
11919 @cindex projects, for publishing
11921 @vindex org-publish-project-alist
11922 Publishing is configured almost entirely through setting the value of one
11923 variable, called @code{org-publish-project-alist}. Each element of the list
11924 configures one project, and may be in one of the two following forms:
11927 ("project-name" :property value :property value ...)
11928 @r{i.e.@: a well-formed property list with alternating keys and values}
11930 ("project-name" :components ("project-name" "project-name" ...))
11934 In both cases, projects are configured by specifying property values. A
11935 project defines the set of files that will be published, as well as the
11936 publishing configuration to use when publishing those files. When a project
11937 takes the second form listed above, the individual members of the
11938 @code{:components} property are taken to be sub-projects, which group
11939 together files requiring different publishing options. When you publish such
11940 a ``meta-project'', all the components will also be published, in the
11943 @node Sources and destinations, Selecting files, Project alist, Configuration
11944 @subsection Sources and destinations for files
11945 @cindex directories, for publishing
11947 Most properties are optional, but some should always be set. In
11948 particular, Org needs to know where to look for source files,
11949 and where to put published files.
11951 @multitable @columnfractions 0.3 0.7
11952 @item @code{:base-directory}
11953 @tab Directory containing publishing source files
11954 @item @code{:publishing-directory}
11955 @tab Directory where output files will be published. You can directly
11956 publish to a webserver using a file name syntax appropriate for
11957 the Emacs @file{tramp} package. Or you can publish to a local directory and
11958 use external tools to upload your website (@pxref{Uploading files}).
11959 @item @code{:preparation-function}
11960 @tab Function or list of functions to be called before starting the
11961 publishing process, for example, to run @code{make} for updating files to be
11962 published. The project property list is scoped into this call as the
11963 variable @code{project-plist}.
11964 @item @code{:completion-function}
11965 @tab Function or list of functions called after finishing the publishing
11966 process, for example, to change permissions of the resulting files. The
11967 project property list is scoped into this call as the variable
11968 @code{project-plist}.
11972 @node Selecting files, Publishing action, Sources and destinations, Configuration
11973 @subsection Selecting files
11974 @cindex files, selecting for publishing
11976 By default, all files with extension @file{.org} in the base directory
11977 are considered part of the project. This can be modified by setting the
11979 @multitable @columnfractions 0.25 0.75
11980 @item @code{:base-extension}
11981 @tab Extension (without the dot!) of source files. This actually is a
11982 regular expression. Set this to the symbol @code{any} if you want to get all
11983 files in @code{:base-directory}, even without extension.
11985 @item @code{:exclude}
11986 @tab Regular expression to match file names that should not be
11987 published, even though they have been selected on the basis of their
11990 @item @code{:include}
11991 @tab List of files to be included regardless of @code{:base-extension}
11992 and @code{:exclude}.
11994 @item @code{:recursive}
11995 @tab Non-nil means, check base-directory recursively for files to publish.
11998 @node Publishing action, Publishing options, Selecting files, Configuration
11999 @subsection Publishing action
12000 @cindex action, for publishing
12002 Publishing means that a file is copied to the destination directory and
12003 possibly transformed in the process. The default transformation is to export
12004 Org files as HTML files, and this is done by the function
12005 @code{org-publish-org-to-html} which calls the HTML exporter (@pxref{HTML
12006 export}). But you also can publish your content as PDF files using
12007 @code{org-publish-org-to-pdf}, or as @code{ascii}, @code{latin1} or
12008 @code{utf8} encoded files using the corresponding functions. If you want to
12009 publish the Org file itself, but with @i{archived}, @i{commented}, and
12010 @i{tag-excluded} trees removed, use @code{org-publish-org-to-org} and set the
12011 parameters @code{:plain-source} and/or @code{:htmlized-source}. This will
12012 produce @file{file.org} and @file{file.org.html} in the publishing
12013 directory@footnote{@file{file-source.org} and @file{file-source.org.html} if
12014 source and publishing directories are equal. Note that with this kind of
12015 setup, you need to add @code{:exclude "-source\\.org"} to the project
12016 definition in @code{org-publish-project-alist} to prevent the published
12017 source files from being considered as new org files the next time the project
12018 is published.}. Other files like images only need to be copied to the
12019 publishing destination; for this you may use @code{org-publish-attachment}.
12020 For non-Org files, you always need to specify the publishing function:
12022 @multitable @columnfractions 0.3 0.7
12023 @item @code{:publishing-function}
12024 @tab Function executing the publication of a file. This may also be a
12025 list of functions, which will all be called in turn.
12026 @item @code{:plain-source}
12027 @tab Non-nil means, publish plain source.
12028 @item @code{:htmlized-source}
12029 @tab Non-nil means, publish htmlized source.
12032 The function must accept three arguments: a property list containing at least
12033 a @code{:publishing-directory} property, the name of the file to be
12034 published, and the path to the publishing directory of the output file. It
12035 should take the specified file, make the necessary transformation (if any)
12036 and place the result into the destination folder.
12038 @node Publishing options, Publishing links, Publishing action, Configuration
12039 @subsection Options for the HTML/@LaTeX{} exporters
12040 @cindex options, for publishing
12042 The property list can be used to set many export options for the HTML
12043 and @LaTeX{} exporters. In most cases, these properties correspond to user
12044 variables in Org. The table below lists these properties along
12045 with the variable they belong to. See the documentation string for the
12046 respective variable for details.
12048 @vindex org-export-html-link-up
12049 @vindex org-export-html-link-home
12050 @vindex org-export-default-language
12051 @vindex org-display-custom-times
12052 @vindex org-export-headline-levels
12053 @vindex org-export-with-section-numbers
12054 @vindex org-export-section-number-format
12055 @vindex org-export-with-toc
12056 @vindex org-export-preserve-breaks
12057 @vindex org-export-with-archived-trees
12058 @vindex org-export-with-emphasize
12059 @vindex org-export-with-sub-superscripts
12060 @vindex org-export-with-special-strings
12061 @vindex org-export-with-footnotes
12062 @vindex org-export-with-drawers
12063 @vindex org-export-with-tags
12064 @vindex org-export-with-todo-keywords
12065 @vindex org-export-with-tasks
12066 @vindex org-export-with-done-tasks
12067 @vindex org-export-with-priority
12068 @vindex org-export-with-TeX-macros
12069 @vindex org-export-with-LaTeX-fragments
12070 @vindex org-export-skip-text-before-1st-heading
12071 @vindex org-export-with-fixed-width
12072 @vindex org-export-with-timestamps
12073 @vindex org-export-author-info
12074 @vindex org-export-email-info
12075 @vindex org-export-creator-info
12076 @vindex org-export-time-stamp-file
12077 @vindex org-export-with-tables
12078 @vindex org-export-highlight-first-table-line
12079 @vindex org-export-html-style-include-default
12080 @vindex org-export-html-style-include-scripts
12081 @vindex org-export-html-style
12082 @vindex org-export-html-style-extra
12083 @vindex org-export-html-link-org-files-as-html
12084 @vindex org-export-html-inline-images
12085 @vindex org-export-html-extension
12086 @vindex org-export-html-table-tag
12087 @vindex org-export-html-expand
12088 @vindex org-export-html-with-timestamp
12089 @vindex org-export-publishing-directory
12090 @vindex org-export-html-preamble
12091 @vindex org-export-html-postamble
12092 @vindex user-full-name
12093 @vindex user-mail-address
12094 @vindex org-export-select-tags
12095 @vindex org-export-exclude-tags
12097 @multitable @columnfractions 0.32 0.68
12098 @item @code{:link-up} @tab @code{org-export-html-link-up}
12099 @item @code{:link-home} @tab @code{org-export-html-link-home}
12100 @item @code{:language} @tab @code{org-export-default-language}
12101 @item @code{:customtime} @tab @code{org-display-custom-times}
12102 @item @code{:headline-levels} @tab @code{org-export-headline-levels}
12103 @item @code{:section-numbers} @tab @code{org-export-with-section-numbers}
12104 @item @code{:section-number-format} @tab @code{org-export-section-number-format}
12105 @item @code{:table-of-contents} @tab @code{org-export-with-toc}
12106 @item @code{:preserve-breaks} @tab @code{org-export-preserve-breaks}
12107 @item @code{:archived-trees} @tab @code{org-export-with-archived-trees}
12108 @item @code{:emphasize} @tab @code{org-export-with-emphasize}
12109 @item @code{:sub-superscript} @tab @code{org-export-with-sub-superscripts}
12110 @item @code{:special-strings} @tab @code{org-export-with-special-strings}
12111 @item @code{:footnotes} @tab @code{org-export-with-footnotes}
12112 @item @code{:drawers} @tab @code{org-export-with-drawers}
12113 @item @code{:tags} @tab @code{org-export-with-tags}
12114 @item @code{:todo-keywords} @tab @code{org-export-with-todo-keywords}
12115 @item @code{:tasks} @tab @code{org-export-with-tasks}
12116 @item @code{:priority} @tab @code{org-export-with-priority}
12117 @item @code{:TeX-macros} @tab @code{org-export-with-TeX-macros}
12118 @item @code{:LaTeX-fragments} @tab @code{org-export-with-LaTeX-fragments}
12119 @item @code{:latex-listings} @tab @code{org-export-latex-listings}
12120 @item @code{:skip-before-1st-heading} @tab @code{org-export-skip-text-before-1st-heading}
12121 @item @code{:fixed-width} @tab @code{org-export-with-fixed-width}
12122 @item @code{:timestamps} @tab @code{org-export-with-timestamps}
12123 @item @code{:author} @tab @code{user-full-name}
12124 @item @code{:email} @tab @code{user-mail-address} : @code{addr;addr;..}
12125 @item @code{:author-info} @tab @code{org-export-author-info}
12126 @item @code{:email-info} @tab @code{org-export-email-info}
12127 @item @code{:creator-info} @tab @code{org-export-creator-info}
12128 @item @code{:tables} @tab @code{org-export-with-tables}
12129 @item @code{:table-auto-headline} @tab @code{org-export-highlight-first-table-line}
12130 @item @code{:style-include-default} @tab @code{org-export-html-style-include-default}
12131 @item @code{:style-include-scripts} @tab @code{org-export-html-style-include-scripts}
12132 @item @code{:style} @tab @code{org-export-html-style}
12133 @item @code{:style-extra} @tab @code{org-export-html-style-extra}
12134 @item @code{:convert-org-links} @tab @code{org-export-html-link-org-files-as-html}
12135 @item @code{:inline-images} @tab @code{org-export-html-inline-images}
12136 @item @code{:html-extension} @tab @code{org-export-html-extension}
12137 @item @code{:html-preamble} @tab @code{org-export-html-preamble}
12138 @item @code{:html-postamble} @tab @code{org-export-html-postamble}
12139 @item @code{:xml-declaration} @tab @code{org-export-html-xml-declaration}
12140 @item @code{:html-table-tag} @tab @code{org-export-html-table-tag}
12141 @item @code{:expand-quoted-html} @tab @code{org-export-html-expand}
12142 @item @code{:timestamp} @tab @code{org-export-html-with-timestamp}
12143 @item @code{:publishing-directory} @tab @code{org-export-publishing-directory}
12144 @item @code{:select-tags} @tab @code{org-export-select-tags}
12145 @item @code{:exclude-tags} @tab @code{org-export-exclude-tags}
12146 @item @code{:latex-image-options} @tab @code{org-export-latex-image-default-option}
12149 Most of the @code{org-export-with-*} variables have the same effect in
12150 both HTML and @LaTeX{} exporters, except for @code{:TeX-macros} and
12151 @code{:LaTeX-fragments} options, respectively @code{nil} and @code{t} in the
12152 @LaTeX{} export. See @code{org-export-plist-vars} to check this list of
12157 @vindex org-publish-project-alist
12158 When a property is given a value in @code{org-publish-project-alist},
12159 its setting overrides the value of the corresponding user variable (if
12160 any) during publishing. Options set within a file (@pxref{Export
12161 options}), however, override everything.
12163 @node Publishing links, Sitemap, Publishing options, Configuration
12164 @subsection Links between published files
12165 @cindex links, publishing
12167 To create a link from one Org file to another, you would use
12168 something like @samp{[[file:foo.org][The foo]]} or simply
12169 @samp{file:foo.org.} (@pxref{Hyperlinks}). When published, this link
12170 becomes a link to @file{foo.html}. In this way, you can interlink the
12171 pages of your "org web" project and the links will work as expected when
12172 you publish them to HTML. If you also publish the Org source file and want
12173 to link to that, use an @code{http:} link instead of a @code{file:} link,
12174 because @code{file:} links are converted to link to the corresponding
12177 You may also link to related files, such as images. Provided you are careful
12178 with relative file names, and provided you have also configured Org to upload
12179 the related files, these links will work too. See @ref{Complex example}, for
12180 an example of this usage.
12182 Sometimes an Org file to be published may contain links that are
12183 only valid in your production environment, but not in the publishing
12184 location. In this case, use the property
12186 @multitable @columnfractions 0.4 0.6
12187 @item @code{:link-validation-function}
12188 @tab Function to validate links
12192 to define a function for checking link validity. This function must
12193 accept two arguments, the file name and a directory relative to which
12194 the file name is interpreted in the production environment. If this
12195 function returns @code{nil}, then the HTML generator will only insert a
12196 description into the HTML file, but no link. One option for this
12197 function is @code{org-publish-validate-link} which checks if the given
12198 file is part of any project in @code{org-publish-project-alist}.
12200 @node Sitemap, Generating an index, Publishing links, Configuration
12201 @subsection Generating a sitemap
12202 @cindex sitemap, of published pages
12204 The following properties may be used to control publishing of
12205 a map of files for a given project.
12207 @multitable @columnfractions 0.35 0.65
12208 @item @code{:auto-sitemap}
12209 @tab When non-nil, publish a sitemap during @code{org-publish-current-project}
12210 or @code{org-publish-all}.
12212 @item @code{:sitemap-filename}
12213 @tab Filename for output of sitemap. Defaults to @file{sitemap.org} (which
12214 becomes @file{sitemap.html}).
12216 @item @code{:sitemap-title}
12217 @tab Title of sitemap page. Defaults to name of file.
12219 @item @code{:sitemap-function}
12220 @tab Plug-in function to use for generation of the sitemap.
12221 Defaults to @code{org-publish-org-sitemap}, which generates a plain list
12222 of links to all files in the project.
12224 @item @code{:sitemap-sort-folders}
12225 @tab Where folders should appear in the sitemap. Set this to @code{first}
12226 (default) or @code{last} to display folders first or last,
12227 respectively. Any other value will mix files and folders.
12229 @item @code{:sitemap-sort-files}
12230 @tab How the files are sorted in the site map. Set this to
12231 @code{alphabetically} (default), @code{chronologically} or
12232 @code{anti-chronologically}. @code{chronologically} sorts the files with
12233 older date first while @code{anti-chronologically} sorts the files with newer
12234 date first. @code{alphabetically} sorts the files alphabetically. The date of
12235 a file is retrieved with @code{org-publish-find-date}.
12237 @item @code{:sitemap-ignore-case}
12238 @tab Should sorting be case-sensitive? Default @code{nil}.
12240 @item @code{:sitemap-file-entry-format}
12241 @tab With this option one can tell how a sitemap's entry is formatted in the
12242 sitemap. This is a format string with some escape sequences: @code{%t} stands
12243 for the title of the file, @code{%a} stands for the author of the file and
12244 @code{%d} stands for the date of the file. The date is retrieved with the
12245 @code{org-publish-find-date} function and formatted with
12246 @code{org-publish-sitemap-date-format}. Default @code{%t}.
12248 @item @code{:sitemap-date-format}
12249 @tab Format string for the @code{format-time-string} function that tells how
12250 a sitemap entry's date is to be formatted. This property bypasses
12251 @code{org-publish-sitemap-date-format} which defaults to @code{%Y-%m-%d}.
12253 @item @code{:sitemap-sans-extension}
12254 @tab When non-nil, remove filenames' extensions from the generated sitemap.
12255 Useful to have cool URIs (see @uref{http://www.w3.org/Provider/Style/URI}).
12256 Defaults to @code{nil}.
12260 @node Generating an index, , Sitemap, Configuration
12261 @subsection Generating an index
12262 @cindex index, in a publishing project
12264 Org mode can generate an index across the files of a publishing project.
12266 @multitable @columnfractions 0.25 0.75
12267 @item @code{:makeindex}
12268 @tab When non-nil, generate in index in the file @file{theindex.org} and
12269 publish it as @file{theindex.html}.
12272 The file will be created when first publishing a project with the
12273 @code{:makeindex} set. The file only contains a statement @code{#+INCLUDE:
12274 "theindex.inc"}. You can then build around this include statement by adding
12275 a title, style information, etc.
12277 @node Uploading files, Sample configuration, Configuration, Publishing
12278 @section Uploading files
12282 For those people already utilizing third party sync tools such as
12283 @command{rsync} or @command{unison}, it might be preferable not to use the built in
12284 @i{remote} publishing facilities of Org mode which rely heavily on
12285 Tramp. Tramp, while very useful and powerful, tends not to be
12286 so efficient for multiple file transfer and has been known to cause problems
12289 Specialized synchronization utilities offer several advantages. In addition
12290 to timestamp comparison, they also do content and permissions/attribute
12291 checks. For this reason you might prefer to publish your web to a local
12292 directory (possibly even @i{in place} with your Org files) and then use
12293 @file{unison} or @file{rsync} to do the synchronization with the remote host.
12295 Since Unison (for example) can be configured as to which files to transfer to
12296 a certain remote destination, it can greatly simplify the project publishing
12297 definition. Simply keep all files in the correct location, process your Org
12298 files with @code{org-publish} and let the synchronization tool do the rest.
12299 You do not need, in this scenario, to include attachments such as @file{jpg},
12300 @file{css} or @file{gif} files in the project definition since the 3rd party
12303 Publishing to a local directory is also much faster than to a remote one, so
12304 that you can afford more easily to republish entire projects. If you set
12305 @code{org-publish-use-timestamps-flag} to @code{nil}, you gain the main
12306 benefit of re-including any changed external files such as source example
12307 files you might include with @code{#+INCLUDE}. The timestamp mechanism in
12308 Org is not smart enough to detect if included files have been modified.
12310 @node Sample configuration, Triggering publication, Uploading files, Publishing
12311 @section Sample configuration
12313 Below we provide two example configurations. The first one is a simple
12314 project publishing only a set of Org files. The second example is
12315 more complex, with a multi-component project.
12318 * Simple example:: One-component publishing
12319 * Complex example:: A multi-component publishing example
12322 @node Simple example, Complex example, Sample configuration, Sample configuration
12323 @subsection Example: simple publishing configuration
12325 This example publishes a set of Org files to the @file{public_html}
12326 directory on the local machine.
12329 (setq org-publish-project-alist
12331 :base-directory "~/org/"
12332 :publishing-directory "~/public_html"
12333 :section-numbers nil
12334 :table-of-contents nil
12335 :style "<link rel=\"stylesheet\"
12336 href=\"../other/mystyle.css\"
12337 type=\"text/css\"/>")))
12340 @node Complex example, , Simple example, Sample configuration
12341 @subsection Example: complex publishing configuration
12343 This more complicated example publishes an entire website, including
12344 Org files converted to HTML, image files, Emacs Lisp source code, and
12345 style sheets. The publishing directory is remote and private files are
12348 To ensure that links are preserved, care should be taken to replicate
12349 your directory structure on the web server, and to use relative file
12350 paths. For example, if your Org files are kept in @file{~/org} and your
12351 publishable images in @file{~/images}, you would link to an image with
12354 file:../images/myimage.png
12357 On the web server, the relative path to the image should be the
12358 same. You can accomplish this by setting up an "images" folder in the
12359 right place on the web server, and publishing images to it.
12362 (setq org-publish-project-alist
12364 :base-directory "~/org/"
12365 :base-extension "org"
12366 :publishing-directory "/ssh:user@@host:~/html/notebook/"
12367 :publishing-function org-publish-org-to-html
12368 :exclude "PrivatePage.org" ;; regexp
12370 :section-numbers nil
12371 :table-of-contents nil
12372 :style "<link rel=\"stylesheet\"
12373 href=\"../other/mystyle.css\" type=\"text/css\"/>"
12377 :base-directory "~/images/"
12378 :base-extension "jpg\\|gif\\|png"
12379 :publishing-directory "/ssh:user@@host:~/html/images/"
12380 :publishing-function org-publish-attachment)
12383 :base-directory "~/other/"
12384 :base-extension "css\\|el"
12385 :publishing-directory "/ssh:user@@host:~/html/other/"
12386 :publishing-function org-publish-attachment)
12387 ("website" :components ("orgfiles" "images" "other"))))
12390 @node Triggering publication, , Sample configuration, Publishing
12391 @section Triggering publication
12393 Once properly configured, Org can publish with the following commands:
12396 @orgcmd{C-c C-e X,org-publish}
12397 Prompt for a specific project and publish all files that belong to it.
12398 @orgcmd{C-c C-e P,org-publish-current-project}
12399 Publish the project containing the current file.
12400 @orgcmd{C-c C-e F,org-publish-current-file}
12401 Publish only the current file.
12402 @orgcmd{C-c C-e E,org-publish-all}
12403 Publish every project.
12406 @vindex org-publish-use-timestamps-flag
12407 Org uses timestamps to track when a file has changed. The above functions
12408 normally only publish changed files. You can override this and force
12409 publishing of all files by giving a prefix argument to any of the commands
12410 above, or by customizing the variable @code{org-publish-use-timestamps-flag}.
12411 This may be necessary in particular if files include other files via
12412 @code{#+SETUPFILE:} or @code{#+INCLUDE:}.
12414 @comment node-name, next, previous, up
12415 @comment Working With Source Code, Miscellaneous, Publishing, Top
12417 @node Working With Source Code, Miscellaneous, Publishing, Top
12418 @chapter Working with source code
12419 @cindex Schulte, Eric
12420 @cindex Davison, Dan
12421 @cindex source code, working with
12423 Source code can be included in Org mode documents using a @samp{src} block,
12427 #+BEGIN_SRC emacs-lisp
12428 (defun org-xor (a b)
12434 Org mode provides a number of features for working with live source code,
12435 including editing of code blocks in their native major-mode, evaluation of
12436 code blocks, converting code blocks into source files (known as @dfn{tangling}
12437 in literate programming), and exporting code blocks and their
12438 results in several formats. This functionality was contributed by Eric
12439 Schulte and Dan Davison, and was originally named Org-babel.
12441 The following sections describe Org mode's code block handling facilities.
12444 * Structure of code blocks:: Code block syntax described
12445 * Editing source code:: Language major-mode editing
12446 * Exporting code blocks:: Export contents and/or results
12447 * Extracting source code:: Create pure source code files
12448 * Evaluating code blocks:: Place results of evaluation in the Org mode buffer
12449 * Library of Babel:: Use and contribute to a library of useful code blocks
12450 * Languages:: List of supported code block languages
12451 * Header arguments:: Configure code block functionality
12452 * Results of evaluation:: How evaluation results are handled
12453 * Noweb reference syntax:: Literate programming in Org mode
12454 * Key bindings and useful functions:: Work quickly with code blocks
12455 * Batch execution:: Call functions from the command line
12458 @comment node-name, next, previous, up
12459 @comment Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
12461 @node Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
12462 @section Structure of code blocks
12463 @cindex code block, structure
12464 @cindex source code, block structure
12466 @cindex #+BEGIN_SRC
12468 Live code blocks can be specified with a @samp{src} block or
12469 inline.@footnote{Note that @samp{src} blocks may be inserted using Org mode's
12470 @ref{Easy Templates} system} The structure of a @samp{src} block is
12474 #+BEGIN_SRC <language> <switches> <header arguments>
12479 The @code{#+NAME:} line is optional, and can be used to name the code
12480 block. Live code blocks require that a language be specified on the
12481 @code{#+BEGIN_SRC} line. Switches and header arguments are optional.
12482 @cindex source code, inline
12484 Live code blocks can also be specified inline using
12487 src_<language>@{<body>@}
12493 src_<language>[<header arguments>]@{<body>@}
12497 @item <#+NAME: name>
12498 This line associates a name with the code block. This is similar to the
12499 @code{#+TBLNAME: NAME} lines that can be used to name tables in Org mode
12500 files. Referencing the name of a code block makes it possible to evaluate
12501 the block from other places in the file, from other files, or from Org mode
12502 table formulas (see @ref{The spreadsheet}). Names are assumed to be unique
12503 and the behavior of Org mode when two or more blocks share the same name is
12507 The language of the code in the block (see @ref{Languages}).
12508 @cindex source code, language
12510 Optional switches control code block export (see the discussion of switches in
12511 @ref{Literal examples})
12512 @cindex source code, switches
12513 @item <header arguments>
12514 Optional header arguments control many aspects of evaluation, export and
12515 tangling of code blocks (see @ref{Header arguments}).
12516 Header arguments can also be set on a per-buffer or per-subtree
12517 basis using properties.
12518 @item source code, header arguments
12520 Source code in the specified language.
12523 @comment node-name, next, previous, up
12524 @comment Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
12526 @node Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
12527 @section Editing source code
12528 @cindex code block, editing
12529 @cindex source code, editing
12532 Use @kbd{C-c '} to edit the current code block. This brings up
12533 a language major-mode edit buffer containing the body of the code
12534 block. Saving this buffer will write the new contents back to the Org
12535 buffer. Use @kbd{C-c '} again to exit.
12537 The @code{org-src-mode} minor mode will be active in the edit buffer. The
12538 following variables can be used to configure the behavior of the edit
12539 buffer. See also the customization group @code{org-edit-structure} for
12540 further configuration options.
12543 @item org-src-lang-modes
12544 If an Emacs major-mode named @code{<lang>-mode} exists, where
12545 @code{<lang>} is the language named in the header line of the code block,
12546 then the edit buffer will be placed in that major-mode. This variable
12547 can be used to map arbitrary language names to existing major modes.
12548 @item org-src-window-setup
12549 Controls the way Emacs windows are rearranged when the edit buffer is created.
12550 @item org-src-preserve-indentation
12551 This variable is especially useful for tangling languages such as
12552 Python, in which whitespace indentation in the output is critical.
12553 @item org-src-ask-before-returning-to-edit-buffer
12554 By default, Org will ask before returning to an open edit buffer. Set this
12555 variable to nil to switch without asking.
12558 To turn on native code fontification in the @emph{Org} buffer, configure the
12559 variable @code{org-src-fontify-natively}.
12561 @comment node-name, next, previous, up
12562 @comment Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
12564 @node Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
12565 @section Exporting code blocks
12566 @cindex code block, exporting
12567 @cindex source code, exporting
12569 It is possible to export the @emph{code} of code blocks, the @emph{results}
12570 of code block evaluation, @emph{both} the code and the results of code block
12571 evaluation, or @emph{none}. For most languages, the default exports code.
12572 However, for some languages (e.g.@: @code{ditaa}) the default exports the
12573 results of code block evaluation. For information on exporting code block
12574 bodies, see @ref{Literal examples}.
12576 The @code{:exports} header argument can be used to specify export
12579 @subsubheading Header arguments:
12581 @item :exports code
12582 The default in most languages. The body of the code block is exported, as
12583 described in @ref{Literal examples}.
12584 @item :exports results
12585 The code block will be evaluated and the results will be placed in the
12586 Org mode buffer for export, either updating previous results of the code
12587 block located anywhere in the buffer or, if no previous results exist,
12588 placing the results immediately after the code block. The body of the code
12589 block will not be exported.
12590 @item :exports both
12591 Both the code block and its results will be exported.
12592 @item :exports none
12593 Neither the code block nor its results will be exported.
12596 It is possible to inhibit the evaluation of code blocks during export.
12597 Setting the @code{org-export-babel-evaluate} variable to @code{nil} will
12598 ensure that no code blocks are evaluated as part of the export process. This
12599 can be useful in situations where potentially untrusted Org mode files are
12600 exported in an automated fashion, for example when Org mode is used as the
12601 markup language for a wiki.
12603 @comment node-name, next, previous, up
12604 @comment Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
12605 @node Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
12606 @section Extracting source code
12608 @cindex source code, extracting
12609 @cindex code block, extracting source code
12611 Creating pure source code files by extracting code from source blocks is
12612 referred to as ``tangling''---a term adopted from the literate programming
12613 community. During ``tangling'' of code blocks their bodies are expanded
12614 using @code{org-babel-expand-src-block} which can expand both variable and
12615 ``noweb'' style references (see @ref{Noweb reference syntax}).
12617 @subsubheading Header arguments
12620 The default. The code block is not included in the tangled output.
12622 Include the code block in the tangled output. The output file name is the
12623 name of the org file with the extension @samp{.org} replaced by the extension
12624 for the block language.
12625 @item :tangle filename
12626 Include the code block in the tangled output to file @samp{filename}.
12630 @subsubheading Functions
12632 @item org-babel-tangle
12633 Tangle the current file. Bound to @kbd{C-c C-v t}.
12634 @item org-babel-tangle-file
12635 Choose a file to tangle. Bound to @kbd{C-c C-v f}.
12638 @subsubheading Hooks
12640 @item org-babel-post-tangle-hook
12641 This hook is run from within code files tangled by @code{org-babel-tangle}.
12642 Example applications could include post-processing, compilation or evaluation
12643 of tangled code files.
12646 @node Evaluating code blocks, Library of Babel, Extracting source code, Working With Source Code
12647 @section Evaluating code blocks
12648 @cindex code block, evaluating
12649 @cindex source code, evaluating
12652 Code blocks can be evaluated@footnote{Whenever code is evaluated there is a
12653 potential for that code to do harm. Org mode provides safeguards to ensure
12654 that code is only evaluated after explicit confirmation from the user. For
12655 information on these safeguards (and on how to disable them) see @ref{Code
12656 evaluation security}.} and the results of evaluation optionally placed in the
12657 Org mode buffer. The results of evaluation are placed following a line that
12658 begins by default with @code{#+RESULTS} and optionally a cache identifier
12659 and/or the name of the evaluated code block. The default value of
12660 @code{#+RESULTS} can be changed with the customizable variable
12661 @code{org-babel-results-keyword}.
12663 By default, the evaluation facility is only enabled for Lisp code blocks
12664 specified as @code{emacs-lisp}. However, source code blocks in many languages
12665 can be evaluated within Org mode (see @ref{Languages} for a list of supported
12666 languages and @ref{Structure of code blocks} for information on the syntax
12667 used to define a code block).
12670 There are a number of ways to evaluate code blocks. The simplest is to press
12671 @kbd{C-c C-c} or @kbd{C-c C-v e} with the point on a code block@footnote{The
12672 @code{org-babel-no-eval-on-ctrl-c-ctrl-c} variable can be used to remove code
12673 evaluation from the @kbd{C-c C-c} key binding.}. This will call the
12674 @code{org-babel-execute-src-block} function to evaluate the block and insert
12675 its results into the Org mode buffer.
12678 It is also possible to evaluate named code blocks from anywhere in an
12679 Org mode buffer or an Org mode table. Live code blocks located in the current
12680 Org mode buffer or in the ``Library of Babel'' (see @ref{Library of Babel})
12681 can be executed. Named code blocks can be executed with a separate
12682 @code{#+CALL:} line or inline within a block of text.
12684 The syntax of the @code{#+CALL:} line is
12687 #+CALL: <name>(<arguments>)
12688 #+CALL: <name>[<inside header arguments>](<arguments>) <end header arguments>
12691 The syntax for inline evaluation of named code blocks is
12694 ... call_<name>(<arguments>) ...
12695 ... call_<name>[<inside header arguments>](<arguments>)[<end header arguments>] ...
12700 The name of the code block to be evaluated (see @ref{Structure of code blocks}).
12702 Arguments specified in this section will be passed to the code block. These
12703 arguments use standard function call syntax, rather than
12704 header argument syntax. For example, a @code{#+CALL:} line that passes the
12705 number four to a code block named @code{double}, which declares the header
12706 argument @code{:var n=2}, would be written as @code{#+CALL: double(n=4)}.
12707 @item <inside header arguments>
12708 Inside header arguments are passed through and applied to the named code
12709 block. These arguments use header argument syntax rather than standard
12710 function call syntax. Inside header arguments affect how the code block is
12711 evaluated. For example, @code{[:results output]} will collect the results of
12712 everything printed to @code{STDOUT} during execution of the code block.
12713 @item <end header arguments>
12714 End header arguments are applied to the calling instance and do not affect
12715 evaluation of the named code block. They affect how the results are
12716 incorporated into the Org mode buffer and how the call line is exported. For
12717 example, @code{:results html} will insert the results of the call line
12718 evaluation in the Org buffer, wrapped in a @code{BEGIN_HTML:} block.
12720 For more examples of passing header arguments to @code{#+CALL:} lines see
12721 @ref{Header arguments in function calls}.
12724 @node Library of Babel, Languages, Evaluating code blocks, Working With Source Code
12725 @section Library of Babel
12726 @cindex babel, library of
12727 @cindex source code, library
12728 @cindex code block, library
12730 The ``Library of Babel'' consists of code blocks that can be called from any
12731 Org mode file. Code blocks defined in the ``Library of Babel'' can be called
12732 remotely as if they were in the current Org mode buffer (see @ref{Evaluating
12733 code blocks} for information on the syntax of remote code block evaluation).
12736 The central repository of code blocks in the ``Library of Babel'' is housed
12737 in an Org mode file located in the @samp{contrib} directory of Org mode.
12739 Users can add code blocks they believe to be generally useful to their
12740 ``Library of Babel.'' The code blocks can be stored in any Org mode file and
12741 then loaded into the library with @code{org-babel-lob-ingest}.
12745 Code blocks located in any Org mode file can be loaded into the ``Library of
12746 Babel'' with the @code{org-babel-lob-ingest} function, bound to @kbd{C-c C-v
12749 @node Languages, Header arguments, Library of Babel, Working With Source Code
12751 @cindex babel, languages
12752 @cindex source code, languages
12753 @cindex code block, languages
12755 Code blocks in the following languages are supported.
12757 @multitable @columnfractions 0.28 0.3 0.22 0.2
12758 @item @b{Language} @tab @b{Identifier} @tab @b{Language} @tab @b{Identifier}
12759 @item Asymptote @tab asymptote @tab Awk @tab awk
12760 @item Emacs Calc @tab calc @tab C @tab C
12761 @item C++ @tab C++ @tab Clojure @tab clojure
12762 @item CSS @tab css @tab ditaa @tab ditaa
12763 @item Graphviz @tab dot @tab Emacs Lisp @tab emacs-lisp
12764 @item gnuplot @tab gnuplot @tab Haskell @tab haskell
12765 @item Java @tab java @tab @tab
12766 @item Javascript @tab js @tab LaTeX @tab latex
12767 @item Ledger @tab ledger @tab Lisp @tab lisp
12768 @item Lilypond @tab lilypond @tab MATLAB @tab matlab
12769 @item Mscgen @tab mscgen @tab Objective Caml @tab ocaml
12770 @item Octave @tab octave @tab Org mode @tab org
12771 @item Oz @tab oz @tab Perl @tab perl
12772 @item Plantuml @tab plantuml @tab Python @tab python
12773 @item R @tab R @tab Ruby @tab ruby
12774 @item Sass @tab sass @tab Scheme @tab scheme
12775 @item GNU Screen @tab screen @tab shell @tab sh
12776 @item SQL @tab sql @tab SQLite @tab sqlite
12779 Language-specific documentation is available for some languages. If
12780 available, it can be found at
12781 @uref{http://orgmode.org/worg/org-contrib/babel/languages}.
12783 The @code{org-babel-load-languages} controls which languages are enabled for
12784 evaluation (by default only @code{emacs-lisp} is enabled). This variable can
12785 be set using the customization interface or by adding code like the following
12786 to your emacs configuration.
12789 The following disables @code{emacs-lisp} evaluation and enables evaluation of
12790 @code{R} code blocks.
12794 (org-babel-do-load-languages
12795 'org-babel-load-languages
12796 '((emacs-lisp . nil)
12800 It is also possible to enable support for a language by loading the related
12801 elisp file with @code{require}.
12804 The following adds support for evaluating @code{clojure} code blocks.
12808 (require 'ob-clojure)
12811 @node Header arguments, Results of evaluation, Languages, Working With Source Code
12812 @section Header arguments
12813 @cindex code block, header arguments
12814 @cindex source code, block header arguments
12816 Code block functionality can be configured with header arguments. This
12817 section provides an overview of the use of header arguments, and then
12818 describes each header argument in detail.
12821 * Using header arguments:: Different ways to set header arguments
12822 * Specific header arguments:: List of header arguments
12825 @node Using header arguments, Specific header arguments, Header arguments, Header arguments
12826 @subsection Using header arguments
12828 The values of header arguments can be set in six different ways, each more
12829 specific (and having higher priority) than the last.
12831 * System-wide header arguments:: Set global default values
12832 * Language-specific header arguments:: Set default values by language
12833 * Buffer-wide header arguments:: Set default values for a specific buffer
12834 * Header arguments in Org mode properties:: Set default values for a buffer or heading
12835 * Code block specific header arguments:: The most common way to set values
12836 * Header arguments in function calls:: The most specific level
12840 @node System-wide header arguments, Language-specific header arguments, Using header arguments, Using header arguments
12841 @subsubheading System-wide header arguments
12842 @vindex org-babel-default-header-args
12843 System-wide values of header arguments can be specified by customizing the
12844 @code{org-babel-default-header-args} variable:
12848 :results => "replace"
12855 @c org-babel-default-header-args is a variable defined in `org-babel.el'.
12857 @c ((:session . "none")
12858 @c (:results . "replace")
12859 @c (:exports . "code")
12861 @c (:noweb . "no"))
12865 @c Default arguments to use when evaluating a code block.
12868 For example, the following example could be used to set the default value of
12869 @code{:noweb} header arguments to @code{yes}. This would have the effect of
12870 expanding @code{:noweb} references by default when evaluating source code
12874 (setq org-babel-default-header-args
12875 (cons '(:noweb . "yes")
12876 (assq-delete-all :noweb org-babel-default-header-args)))
12879 @node Language-specific header arguments, Buffer-wide header arguments, System-wide header arguments, Using header arguments
12880 @subsubheading Language-specific header arguments
12881 Each language can define its own set of default header arguments. See the
12882 language-specific documentation available online at
12883 @uref{http://orgmode.org/worg/org-contrib/babel}.
12885 @node Buffer-wide header arguments, Header arguments in Org mode properties, Language-specific header arguments, Using header arguments
12886 @subsubheading Buffer-wide header arguments
12887 Buffer-wide header arguments may be specified as properties through the use
12888 of @code{#+PROPERTY:} lines placed anywhere in an Org mode file (see
12889 @ref{Property syntax}).
12891 For example the following would set @code{session} to @code{*R*}, and
12892 @code{results} to @code{silent} for every code block in the buffer, ensuring
12893 that all execution took place in the same session, and no results would be
12894 inserted into the buffer.
12897 #+PROPERTY: session *R*
12898 #+PROPERTY: results silent
12901 @node Header arguments in Org mode properties, Code block specific header arguments, Buffer-wide header arguments, Using header arguments
12902 @subsubheading Header arguments in Org mode properties
12904 Header arguments are also read from Org mode properties (see @ref{Property
12905 syntax}), which can be set on a buffer-wide or per-heading basis. An example
12906 of setting a header argument for all code blocks in a buffer is
12909 #+PROPERTY: tangle yes
12912 @vindex org-use-property-inheritance
12913 When properties are used to set default header arguments, they are looked up
12914 with inheritance, regardless of the value of
12915 @code{org-use-property-inheritance}. In the following example the value of
12916 the @code{:cache} header argument will default to @code{yes} in all code
12917 blocks in the subtree rooted at the following heading:
12927 @vindex org-babel-default-header-args
12928 Properties defined in this way override the properties set in
12929 @code{org-babel-default-header-args}. It is convenient to use the
12930 @code{org-set-property} function bound to @kbd{C-c C-x p} to set properties
12931 in Org mode documents.
12933 @node Code block specific header arguments, Header arguments in function calls, Header arguments in Org mode properties, Using header arguments
12934 @subsubheading Code block specific header arguments
12936 The most common way to assign values to header arguments is at the
12937 code block level. This can be done by listing a sequence of header
12938 arguments and their values as part of the @code{#+BEGIN_SRC} line.
12939 Properties set in this way override both the values of
12940 @code{org-babel-default-header-args} and header arguments specified as
12941 properties. In the following example, the @code{:results} header argument
12942 is set to @code{silent}, meaning the results of execution will not be
12943 inserted in the buffer, and the @code{:exports} header argument is set to
12944 @code{code}, meaning only the body of the code block will be
12945 preserved on export to HTML or @LaTeX{}.
12949 #+BEGIN_SRC haskell :results silent :exports code :var n=0
12951 fac n = n * fac (n-1)
12954 Similarly, it is possible to set header arguments for inline code blocks
12957 src_haskell[:exports both]@{fac 5@}
12960 Code block header arguments can span multiple lines using @code{#+HEADER:} or
12961 @code{#+HEADERS:} lines preceding a code block or nested between the
12962 @code{#+NAME:} line and the @code{#+BEGIN_SRC} line of a named code block.
12966 Multi-line header arguments on an un-named code block:
12968 #+HEADERS: :var data1=1
12969 #+BEGIN_SRC emacs-lisp :var data2=2
12970 (message "data1:%S, data2:%S" data1 data2)
12977 Multi-line header arguments on a named code block:
12979 #+NAME: named-block
12980 #+HEADER: :var data=2
12981 #+BEGIN_SRC emacs-lisp
12982 (message "data:%S" data)
12985 #+RESULTS: named-block
12989 @node Header arguments in function calls, , Code block specific header arguments, Using header arguments
12990 @comment node-name, next, previous, up
12991 @subsubheading Header arguments in function calls
12993 At the most specific level, header arguments for ``Library of Babel'' or
12994 @code{#+CALL:} lines can be set as shown in the two examples below. For more
12995 information on the structure of @code{#+CALL:} lines see @ref{Evaluating code
12998 The following will apply the @code{:exports results} header argument to the
12999 evaluation of the @code{#+CALL:} line.
13001 #+CALL: factorial(n=5) :exports results
13004 The following will apply the @code{:session special} header argument to the
13005 evaluation of the @code{factorial} code block.
13007 #+CALL: factorial[:session special](n=5)
13010 @node Specific header arguments, , Using header arguments, Header arguments
13011 @subsection Specific header arguments
13012 Header arguments consist of an initial colon followed by the name of the
13013 argument in lowercase letters. The following header arguments are defined:
13016 * var:: Pass arguments to code blocks
13017 * results:: Specify the type of results and how they will
13018 be collected and handled
13019 * file:: Specify a path for file output
13020 * dir:: Specify the default (possibly remote)
13021 directory for code block execution
13022 * exports:: Export code and/or results
13023 * tangle:: Toggle tangling and specify file name
13024 * mkdirp:: Toggle creation of parent directories of target
13025 files during tangling
13026 * comments:: Toggle insertion of comments in tangled
13028 * padline:: Control insertion of padding lines in tangled
13030 * no-expand:: Turn off variable assignment and noweb
13031 expansion during tangling
13032 * session:: Preserve the state of code evaluation
13033 * noweb:: Toggle expansion of noweb references
13034 * noweb-ref:: Specify block's noweb reference resolution target
13035 * noweb-sep:: String used to separate noweb references
13036 * cache:: Avoid re-evaluating unchanged code blocks
13037 * sep:: Delimiter for writing tabular results outside Org
13038 * hlines:: Handle horizontal lines in tables
13039 * colnames:: Handle column names in tables
13040 * rownames:: Handle row names in tables
13041 * shebang:: Make tangled files executable
13042 * eval:: Limit evaluation of specific code blocks
13043 * wrap:: Mark source block evaluation results
13046 Additional header arguments are defined on a language-specific basis, see
13049 @node var, results, Specific header arguments, Specific header arguments
13050 @subsubsection @code{:var}
13051 The @code{:var} header argument is used to pass arguments to code blocks.
13052 The specifics of how arguments are included in a code block vary by language;
13053 these are addressed in the language-specific documentation. However, the
13054 syntax used to specify arguments is the same across all languages. In every
13055 case, variables require a default value when they are declared.
13057 The values passed to arguments can either be literal values, references, or
13058 Emacs Lisp code (see @ref{var, Emacs Lisp evaluation of variables}). References
13059 include anything in the Org mode file that takes a @code{#+NAME:},
13060 @code{#+TBLNAME:}, or @code{#+RESULTS:} line. This includes tables, lists,
13061 @code{#+BEGIN_EXAMPLE} blocks, other code blocks, and the results of other
13064 Argument values can be indexed in a manner similar to arrays (see @ref{var,
13065 Indexable variable values}).
13067 The following syntax is used to pass arguments to code blocks using the
13068 @code{:var} header argument.
13074 The argument, @code{assign}, can either be a literal value, such as a string
13075 @samp{"string"} or a number @samp{9}, or a reference to a table, a list, a
13076 literal example, another code block (with or without arguments), or the
13077 results of evaluating another code block.
13079 Here are examples of passing values by reference:
13084 an Org mode table named with either a @code{#+NAME:} or @code{#+TBLNAME:} line
13086 #+TBLNAME: example-table
13092 #+NAME: table-length
13093 #+BEGIN_SRC emacs-lisp :var table=example-table
13097 #+RESULTS: table-length
13102 a simple list named with a @code{#+NAME:} line (note that nesting is not
13103 carried through to the source code block)
13106 #+NAME: example-list
13112 #+BEGIN_SRC emacs-lisp :var x=example-list
13120 @item code block without arguments
13121 a code block name (from the example above), as assigned by @code{#+NAME:},
13122 optionally followed by parentheses
13125 #+BEGIN_SRC emacs-lisp :var length=table-length()
13133 @item code block with arguments
13134 a code block name, as assigned by @code{#+NAME:}, followed by parentheses and
13135 optional arguments passed within the parentheses following the
13136 code block name using standard function call syntax
13140 #+BEGIN_SRC emacs-lisp :var input=8
13148 #+BEGIN_SRC emacs-lisp :var input=double(input=1)
13156 @item literal example
13157 a literal example block named with a @code{#+NAME:} line
13160 #+NAME: literal-example
13166 #+NAME: read-literal-example
13167 #+BEGIN_SRC emacs-lisp :var x=literal-example
13168 (concatenate 'string x " for you.")
13171 #+RESULTS: read-literal-example
13172 : A literal example
13173 : on two lines for you.
13179 @subsubheading Alternate argument syntax
13180 It is also possible to specify arguments in a potentially more natural way
13181 using the @code{#+NAME:} line of a code block. As in the following
13182 example, arguments can be packed inside of parentheses, separated by commas,
13183 following the source name.
13186 #+NAME: double(input=0, x=2)
13187 #+BEGIN_SRC emacs-lisp
13192 @subsubheading Indexable variable values
13193 It is possible to reference portions of variable values by ``indexing'' into
13194 the variables. Indexes are 0 based with negative values counting back from
13195 the end. If an index is separated by @code{,}s then each subsequent section
13196 will index into the next deepest nesting or dimension of the value. Note
13197 that this indexing occurs @emph{before} other table related header arguments
13198 like @code{:hlines}, @code{:colnames} and @code{:rownames} are applied. The
13199 following example assigns the last cell of the first row the table
13200 @code{example-table} to the variable @code{data}:
13203 #+NAME: example-table
13209 #+BEGIN_SRC emacs-lisp :var data=example-table[0,-1]
13217 Ranges of variable values can be referenced using two integers separated by a
13218 @code{:}, in which case the entire inclusive range is referenced. For
13219 example the following assigns the middle three rows of @code{example-table}
13223 #+NAME: example-table
13230 #+BEGIN_SRC emacs-lisp :var data=example-table[1:3]
13240 Additionally, an empty index, or the single character @code{*}, are both
13241 interpreted to mean the entire range and as such are equivalent to
13242 @code{0:-1}, as shown in the following example in which the entire first
13243 column is referenced.
13246 #+NAME: example-table
13252 #+BEGIN_SRC emacs-lisp :var data=example-table[,0]
13260 It is possible to index into the results of code blocks as well as tables.
13261 Any number of dimensions can be indexed. Dimensions are separated from one
13262 another by commas, as shown in the following example.
13266 #+BEGIN_SRC emacs-lisp
13267 '(((1 2 3) (4 5 6) (7 8 9))
13268 ((10 11 12) (13 14 15) (16 17 18))
13269 ((19 20 21) (22 23 24) (25 26 27)))
13272 #+BEGIN_SRC emacs-lisp :var data=3D[1,,1]
13280 @subsubheading Emacs Lisp evaluation of variables
13282 Emacs lisp code can be used to initialize variable values. When a variable
13283 value starts with @code{(}, @code{[}, @code{'} or @code{`} it will be
13284 evaluated as Emacs Lisp and the result of the evaluation will be assigned as
13285 the variable value. The following example demonstrates use of this
13286 evaluation to reliably pass the file-name of the Org mode buffer to a code
13287 block---note that evaluation of header arguments is guaranteed to take place
13288 in the original Org mode file, while there is no such guarantee for
13289 evaluation of the code block body.
13292 #+BEGIN_SRC sh :var filename=(buffer-file-name) :exports both
13297 Note that values read from tables and lists will not be evaluated as
13298 Emacs Lisp, as shown in the following example.
13304 #+HEADERS: :var data=table[0,0]
13313 @node results, file, var, Specific header arguments
13314 @subsubsection @code{:results}
13316 There are three classes of @code{:results} header argument. Only one option
13317 per class may be supplied per code block.
13321 @b{collection} header arguments specify how the results should be collected
13322 from the code block
13324 @b{type} header arguments specify what type of result the code block will
13325 return---which has implications for how they will be inserted into the
13328 @b{handling} header arguments specify how the results of evaluating the code
13329 block should be handled.
13332 @subsubheading Collection
13333 The following options are mutually exclusive, and specify how the results
13334 should be collected from the code block.
13338 This is the default. The result is the value of the last statement in the
13339 code block. This header argument places the evaluation in functional
13340 mode. Note that in some languages, e.g., Python, use of this result type
13341 requires that a @code{return} statement be included in the body of the source
13342 code block. E.g., @code{:results value}.
13343 @item @code{output}
13344 The result is the collection of everything printed to STDOUT during the
13345 execution of the code block. This header argument places the
13346 evaluation in scripting mode. E.g., @code{:results output}.
13349 @subsubheading Type
13351 The following options are mutually exclusive and specify what type of results
13352 the code block will return. By default, results are inserted as either a
13353 table or scalar depending on their value.
13356 @item @code{table}, @code{vector}
13357 The results should be interpreted as an Org mode table. If a single value is
13358 returned, it will be converted into a table with one row and one column.
13359 E.g., @code{:results value table}.
13361 The results should be interpreted as an Org mode list. If a single scalar
13362 value is returned it will be converted into a list with only one element.
13363 @item @code{scalar}, @code{verbatim}
13364 The results should be interpreted literally---they will not be
13365 converted into a table. The results will be inserted into the Org mode
13366 buffer as quoted text. E.g., @code{:results value verbatim}.
13368 The results will be interpreted as the path to a file, and will be inserted
13369 into the Org mode buffer as a file link. E.g., @code{:results value file}.
13370 @item @code{raw}, @code{org}
13371 The results are interpreted as raw Org mode code and are inserted directly
13372 into the buffer. If the results look like a table they will be aligned as
13373 such by Org mode. E.g., @code{:results value raw}.
13375 Results are assumed to be HTML and will be enclosed in a @code{BEGIN_HTML}
13376 block. E.g., @code{:results value html}.
13378 Results assumed to be @LaTeX{} and are enclosed in a @code{BEGIN_LaTeX} block.
13379 E.g., @code{:results value latex}.
13381 Result are assumed to be parsable code and are enclosed in a code block.
13382 E.g., @code{:results value code}.
13384 The result is converted to pretty-printed code and is enclosed in a code
13385 block. This option currently supports Emacs Lisp, Python, and Ruby. E.g.,
13386 @code{:results value pp}.
13388 The result is wrapped in a RESULTS drawer. This can be useful for
13389 inserting @code{raw} or @code{org} syntax results in such a way that their
13390 extent is known and they can be automatically removed or replaced.
13393 @subsubheading Handling
13394 The following results options indicate what happens with the
13395 results once they are collected.
13398 @item @code{silent}
13399 The results will be echoed in the minibuffer but will not be inserted into
13400 the Org mode buffer. E.g., @code{:results output silent}.
13401 @item @code{replace}
13402 The default value. Any existing results will be removed, and the new results
13403 will be inserted into the Org mode buffer in their place. E.g.,
13404 @code{:results output replace}.
13405 @item @code{append}
13406 If there are pre-existing results of the code block then the new results will
13407 be appended to the existing results. Otherwise the new results will be
13408 inserted as with @code{replace}.
13409 @item @code{prepend}
13410 If there are pre-existing results of the code block then the new results will
13411 be prepended to the existing results. Otherwise the new results will be
13412 inserted as with @code{replace}.
13415 @node file, dir, results, Specific header arguments
13416 @subsubsection @code{:file}
13418 The header argument @code{:file} is used to specify an external file in which
13419 to save code block results. After code block evaluation an Org mode style
13420 @code{[[file:]]} link (see @ref{Link format}) to the file will be inserted
13421 into the Org mode buffer. Some languages including R, gnuplot, dot, and
13422 ditaa provide special handling of the @code{:file} header argument
13423 automatically wrapping the code block body in the boilerplate code required
13424 to save output to the specified file. This is often useful for saving
13425 graphical output of a code block to the specified file.
13427 The argument to @code{:file} should be either a string specifying the path to
13428 a file, or a list of two strings in which case the first element of the list
13429 should be the path to a file and the second a description for the link.
13431 @node dir, exports, file, Specific header arguments
13432 @subsubsection @code{:dir} and remote execution
13434 While the @code{:file} header argument can be used to specify the path to the
13435 output file, @code{:dir} specifies the default directory during code block
13436 execution. If it is absent, then the directory associated with the current
13437 buffer is used. In other words, supplying @code{:dir path} temporarily has
13438 the same effect as changing the current directory with @kbd{M-x cd path}, and
13439 then not supplying @code{:dir}. Under the surface, @code{:dir} simply sets
13440 the value of the Emacs variable @code{default-directory}.
13442 When using @code{:dir}, you should supply a relative path for file output
13443 (e.g.@: @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which
13444 case that path will be interpreted relative to the default directory.
13446 In other words, if you want your plot to go into a folder called @file{Work}
13447 in your home directory, you could use
13450 #+BEGIN_SRC R :file myplot.png :dir ~/Work
13451 matplot(matrix(rnorm(100), 10), type="l")
13455 @subsubheading Remote execution
13456 A directory on a remote machine can be specified using tramp file syntax, in
13457 which case the code will be evaluated on the remote machine. An example is
13460 #+BEGIN_SRC R :file plot.png :dir /dand@@yakuba.princeton.edu:
13461 plot(1:10, main=system("hostname", intern=TRUE))
13465 Text results will be returned to the local Org mode buffer as usual, and file
13466 output will be created on the remote machine with relative paths interpreted
13467 relative to the remote directory. An Org mode link to the remote file will be
13470 So, in the above example a plot will be created on the remote machine,
13471 and a link of the following form will be inserted in the org buffer:
13474 [[file:/scp:dand@@yakuba.princeton.edu:/home/dand/plot.png][plot.png]]
13477 Most of this functionality follows immediately from the fact that @code{:dir}
13478 sets the value of the Emacs variable @code{default-directory}, thanks to
13479 tramp. Those using XEmacs, or GNU Emacs prior to version 23 may need to
13480 install tramp separately in order for these features to work correctly.
13482 @subsubheading Further points
13486 If @code{:dir} is used in conjunction with @code{:session}, although it will
13487 determine the starting directory for a new session as expected, no attempt is
13488 currently made to alter the directory associated with an existing session.
13490 @code{:dir} should typically not be used to create files during export with
13491 @code{:exports results} or @code{:exports both}. The reason is that, in order
13492 to retain portability of exported material between machines, during export
13493 links inserted into the buffer will @emph{not} be expanded against @code{default
13494 directory}. Therefore, if @code{default-directory} is altered using
13495 @code{:dir}, it is probable that the file will be created in a location to
13496 which the link does not point.
13499 @node exports, tangle, dir, Specific header arguments
13500 @subsubsection @code{:exports}
13502 The @code{:exports} header argument specifies what should be included in HTML
13503 or @LaTeX{} exports of the Org mode file.
13507 The default. The body of code is included into the exported file. E.g.,
13508 @code{:exports code}.
13509 @item @code{results}
13510 The result of evaluating the code is included in the exported file. E.g.,
13511 @code{:exports results}.
13513 Both the code and results are included in the exported file. E.g.,
13514 @code{:exports both}.
13516 Nothing is included in the exported file. E.g., @code{:exports none}.
13519 @node tangle, mkdirp, exports, Specific header arguments
13520 @subsubsection @code{:tangle}
13522 The @code{:tangle} header argument specifies whether or not the code
13523 block should be included in tangled extraction of source code files.
13526 @item @code{tangle}
13527 The code block is exported to a source code file named after the full path
13528 (including the directory) and file name (w/o extension) of the Org mode file.
13529 E.g., @code{:tangle yes}.
13531 The default. The code block is not exported to a source code file.
13532 E.g., @code{:tangle no}.
13534 Any other string passed to the @code{:tangle} header argument is interpreted
13535 as a path (directory and file name relative to the directory of the Org mode
13536 file) to which the block will be exported. E.g., @code{:tangle path}.
13539 @node mkdirp, comments, tangle, Specific header arguments
13540 @subsubsection @code{:mkdirp}
13542 The @code{:mkdirp} header argument can be used to create parent directories
13543 of tangled files when missing. This can be set to @code{yes} to enable
13544 directory creation or to @code{no} to inhibit directory creation.
13546 @node comments, padline, mkdirp, Specific header arguments
13547 @subsubsection @code{:comments}
13548 By default code blocks are tangled to source-code files without any insertion
13549 of comments beyond those which may already exist in the body of the code
13550 block. The @code{:comments} header argument can be set as follows to control
13551 the insertion of extra comments into the tangled code file.
13555 The default. No extra comments are inserted during tangling.
13557 The code block is wrapped in comments which contain pointers back to the
13558 original Org file from which the code was tangled.
13560 A synonym for ``link'' to maintain backwards compatibility.
13562 Include text from the Org mode file as a comment.
13564 The text is picked from the leading context of the tangled code and is
13565 limited by the nearest headline or source block as the case may be.
13567 Turns on both the ``link'' and ``org'' comment options.
13569 Turns on the ``link'' comment option, and additionally wraps expanded noweb
13570 references in the code block body in link comments.
13573 @node padline, no-expand, comments, Specific header arguments
13574 @subsubsection @code{:padline}
13575 Control in insertion of padding lines around code block bodies in tangled
13576 code files. The default value is @code{yes} which results in insertion of
13577 newlines before and after each tangled code block. The following arguments
13582 Insert newlines before and after each code block body in tangled code files.
13584 Do not insert any newline padding in tangled output.
13587 @node no-expand, session, padline, Specific header arguments
13588 @subsubsection @code{:no-expand}
13590 By default, code blocks are expanded with @code{org-babel-expand-src-block}
13591 during tangling. This has the effect of assigning values to variables
13592 specified with @code{:var} (see @ref{var}), and of replacing ``noweb''
13593 references (see @ref{Noweb reference syntax}) with their targets. The
13594 @code{:no-expand} header argument can be used to turn off this behavior.
13596 @node session, noweb, no-expand, Specific header arguments
13597 @subsubsection @code{:session}
13599 The @code{:session} header argument starts a session for an interpreted
13600 language where state is preserved.
13602 By default, a session is not started.
13604 A string passed to the @code{:session} header argument will give the session
13605 a name. This makes it possible to run concurrent sessions for each
13606 interpreted language.
13608 @node noweb, noweb-ref, session, Specific header arguments
13609 @subsubsection @code{:noweb}
13611 The @code{:noweb} header argument controls expansion of ``noweb'' syntax
13612 references (see @ref{Noweb reference syntax}) when the code block is
13613 evaluated, tangled, or exported. The @code{:noweb} header argument can have
13614 one of four values: @code{no}, @code{yes}, @code{tangle}, or
13619 The default. ``Noweb'' syntax references in the body of the code block will
13620 not be expanded before the code block is evaluated, tangled or exported.
13622 ``Noweb'' syntax references in the body of the code block will be
13623 expanded before the code block is evaluated, tangled or exported.
13624 @item @code{tangle}
13625 ``Noweb'' syntax references in the body of the code block will be expanded
13626 before the code block is tangled. However, ``noweb'' syntax references will
13627 not be expanded when the code block is evaluated or exported.
13628 @item @code{no-export}
13629 ``Noweb'' syntax references in the body of the code block will be expanded
13630 before the block is evaluated or tangled. However, ``noweb'' syntax
13631 references will not be expanded when the code block is exported.
13634 @subsubheading Noweb prefix lines
13635 Noweb insertions are now placed behind the line prefix of the
13636 @code{<<reference>>}.
13637 This behavior is illustrated in the following example. Because the
13638 @code{<<example>>} noweb reference appears behind the SQL comment syntax,
13639 each line of the expanded noweb reference will be commented.
13652 -- multi-line body of example
13655 Note that noweb replacement text that does not contain any newlines will not
13656 be affected by this change, so it is still possible to use inline noweb
13659 @node noweb-ref, noweb-sep, noweb, Specific header arguments
13660 @subsubsection @code{:noweb-ref}
13661 When expanding ``noweb'' style references the bodies of all code block with
13662 @emph{either} a block name matching the reference name @emph{or} a
13663 @code{:noweb-ref} header argument matching the reference name will be
13664 concatenated together to form the replacement text.
13666 By setting this header argument at the sub-tree or file level, simple code
13667 block concatenation may be achieved. For example, when tangling the
13668 following Org mode file, the bodies of code blocks will be concatenated into
13669 the resulting pure code file@footnote{(The example needs property inheritance
13670 to be turned on for the @code{noweb-ref} property, see @ref{Property
13674 #+BEGIN_SRC sh :tangle yes :noweb yes :shebang #!/bin/sh
13677 * the mount point of the fullest disk
13679 :noweb-ref: fullest-disk
13682 ** query all mounted disks
13687 ** strip the header row
13692 ** sort by the percent full
13694 |awk '@{print $5 " " $6@}'|sort -n |tail -1 \
13697 ** extract the mount point
13699 |awk '@{print $2@}'
13703 The @code{:noweb-sep} (see @ref{noweb-sep}) header argument holds the string
13704 used to separate accumulate noweb references like those above. By default a
13707 @node noweb-sep, cache, noweb-ref, Specific header arguments
13708 @subsubsection @code{:noweb-sep}
13710 The @code{:noweb-sep} header argument holds the string used to separate
13711 accumulate noweb references (see @ref{noweb-ref}). By default a newline is
13714 @node cache, sep, noweb-sep, Specific header arguments
13715 @subsubsection @code{:cache}
13717 The @code{:cache} header argument controls the use of in-buffer caching of
13718 the results of evaluating code blocks. It can be used to avoid re-evaluating
13719 unchanged code blocks. This header argument can have one of two
13720 values: @code{yes} or @code{no}.
13724 The default. No caching takes place, and the code block will be evaluated
13725 every time it is called.
13727 Every time the code block is run a SHA1 hash of the code and arguments
13728 passed to the block will be generated. This hash is packed into the
13729 @code{#+RESULTS:} line and will be checked on subsequent
13730 executions of the code block. If the code block has not
13731 changed since the last time it was evaluated, it will not be re-evaluated.
13734 Code block caches notice if the value of a variable argument
13735 to the code block has changed. If this is the case, the cache is
13736 invalidated and the code block is re-run. In the following example,
13737 @code{caller} will not be re-run unless the results of @code{random} have
13738 changed since it was last run.
13742 #+BEGIN_SRC R :cache yes
13746 #+RESULTS[a2a72cd647ad44515fab62e144796432793d68e1]: random
13750 #+BEGIN_SRC emacs-lisp :var x=random :cache yes
13754 #+RESULTS[bec9c8724e397d5df3b696502df3ed7892fc4f5f]: caller
13758 @node sep, hlines, cache, Specific header arguments
13759 @subsubsection @code{:sep}
13761 The @code{:sep} header argument can be used to control the delimiter used
13762 when writing tabular results out to files external to Org mode. This is used
13763 either when opening tabular results of a code block by calling the
13764 @code{org-open-at-point} function bound to @kbd{C-c C-o} on the code block,
13765 or when writing code block results to an external file (see @ref{file})
13768 By default, when @code{:sep} is not specified output tables are tab
13771 @node hlines, colnames, sep, Specific header arguments
13772 @subsubsection @code{:hlines}
13774 Tables are frequently represented with one or more horizontal lines, or
13775 hlines. The @code{:hlines} argument to a code block accepts the
13776 values @code{yes} or @code{no}, with a default value of @code{no}.
13780 Strips horizontal lines from the input table. In most languages this is the
13781 desired effect because an @code{hline} symbol is interpreted as an unbound
13782 variable and raises an error. Setting @code{:hlines no} or relying on the
13783 default value yields the following results.
13786 #+TBLNAME: many-cols
13794 #+BEGIN_SRC python :var tab=many-cols
13798 #+RESULTS: echo-table
13805 Leaves hlines in the table. Setting @code{:hlines yes} has this effect.
13808 #+TBLNAME: many-cols
13816 #+BEGIN_SRC python :var tab=many-cols :hlines yes
13820 #+RESULTS: echo-table
13829 @node colnames, rownames, hlines, Specific header arguments
13830 @subsubsection @code{:colnames}
13832 The @code{:colnames} header argument accepts the values @code{yes},
13833 @code{no}, or @code{nil} for unassigned. The default value is @code{nil}.
13834 Note that the behavior of the @code{:colnames} header argument may differ
13835 across languages. For example Emacs Lisp code blocks ignore the
13836 @code{:colnames} header argument entirely given the ease with which tables
13837 with column names may be handled directly in Emacs Lisp.
13841 If an input table looks like it has column names
13842 (because its second row is an hline), then the column
13843 names will be removed from the table before
13844 processing, then reapplied to the results.
13847 #+TBLNAME: less-cols
13853 #+NAME: echo-table-again
13854 #+BEGIN_SRC python :var tab=less-cols
13855 return [[val + '*' for val in row] for row in tab]
13858 #+RESULTS: echo-table-again
13865 Please note that column names are not removed before the table is indexed
13866 using variable indexing @xref{var, Indexable variable values}.
13869 No column name pre-processing takes place
13872 Column names are removed and reapplied as with @code{nil} even if the table
13873 does not ``look like'' it has column names (i.e.@: the second row is not an
13877 @node rownames, shebang, colnames, Specific header arguments
13878 @subsubsection @code{:rownames}
13880 The @code{:rownames} header argument can take on the values @code{yes}
13881 or @code{no}, with a default value of @code{no}.
13885 No row name pre-processing will take place.
13888 The first column of the table is removed from the table before processing,
13889 and is then reapplied to the results.
13892 #+TBLNAME: with-rownames
13893 | one | 1 | 2 | 3 | 4 | 5 |
13894 | two | 6 | 7 | 8 | 9 | 10 |
13896 #+NAME: echo-table-once-again
13897 #+BEGIN_SRC python :var tab=with-rownames :rownames yes
13898 return [[val + 10 for val in row] for row in tab]
13901 #+RESULTS: echo-table-once-again
13902 | one | 11 | 12 | 13 | 14 | 15 |
13903 | two | 16 | 17 | 18 | 19 | 20 |
13906 Please note that row names are not removed before the table is indexed using
13907 variable indexing @xref{var, Indexable variable values}.
13911 @node shebang, eval, rownames, Specific header arguments
13912 @subsubsection @code{:shebang}
13914 Setting the @code{:shebang} header argument to a string value
13915 (e.g.@: @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the
13916 first line of any tangled file holding the code block, and the file
13917 permissions of the tangled file are set to make it executable.
13919 @node eval, wrap, shebang, Specific header arguments
13920 @subsubsection @code{:eval}
13921 The @code{:eval} header argument can be used to limit the evaluation of
13922 specific code blocks. The @code{:eval} header argument can be useful for
13923 protecting against the evaluation of dangerous code blocks or to ensure that
13924 evaluation will require a query regardless of the value of the
13925 @code{org-confirm-babel-evaluate} variable. The possible values of
13926 @code{:eval} and their effects are shown below.
13930 The code block will not be evaluated under any circumstances.
13932 Evaluation of the code block will require a query.
13933 @item never-export or no-export
13934 The code block will not be evaluated during export but may still be called
13937 Evaluation of the code block during export will require a query.
13940 If this header argument is not set then evaluation is determined by the value
13941 of the @code{org-confirm-babel-evaluate} variable see @ref{Code evaluation
13944 @node wrap, , eval, Specific header arguments
13945 @subsubsection @code{:wrap}
13946 The @code{:wrap} header argument is used to mark the results of source block
13947 evaluation. The header argument can be passed a string that will be appended
13948 to @code{#+BEGIN_} and @code{#+END_}, which will then be used to wrap the
13949 results. If not string is specified then the results will be wrapped in a
13950 @code{#+BEGIN/END_RESULTS} block.
13952 @node Results of evaluation, Noweb reference syntax, Header arguments, Working With Source Code
13953 @section Results of evaluation
13954 @cindex code block, results of evaluation
13955 @cindex source code, results of evaluation
13957 The way in which results are handled depends on whether a session is invoked,
13958 as well as on whether @code{:results value} or @code{:results output} is
13959 used. The following table shows the table possibilities. For a full listing
13960 of the possible results header arguments see @ref{results}.
13962 @multitable @columnfractions 0.26 0.33 0.41
13963 @item @tab @b{Non-session} @tab @b{Session}
13964 @item @code{:results value} @tab value of last expression @tab value of last expression
13965 @item @code{:results output} @tab contents of STDOUT @tab concatenation of interpreter output
13968 Note: With @code{:results value}, the result in both @code{:session} and
13969 non-session is returned to Org mode as a table (a one- or two-dimensional
13970 vector of strings or numbers) when appropriate.
13972 @subsection Non-session
13973 @subsubsection @code{:results value}
13974 This is the default. Internally, the value is obtained by wrapping the code
13975 in a function definition in the external language, and evaluating that
13976 function. Therefore, code should be written as if it were the body of such a
13977 function. In particular, note that Python does not automatically return a
13978 value from a function unless a @code{return} statement is present, and so a
13979 @samp{return} statement will usually be required in Python.
13981 This is the only one of the four evaluation contexts in which the code is
13982 automatically wrapped in a function definition.
13984 @subsubsection @code{:results output}
13985 The code is passed to the interpreter as an external process, and the
13986 contents of the standard output stream are returned as text. (In certain
13987 languages this also contains the error output stream; this is an area for
13990 @subsection Session
13991 @subsubsection @code{:results value}
13992 The code is passed to an interpreter running as an interactive Emacs inferior
13993 process. Only languages which provide tools for interactive evaluation of
13994 code have session support, so some language (e.g., C and ditaa) do not
13995 support the @code{:session} header argument, and in other languages (e.g.,
13996 Python and Haskell) which have limitations on the code which may be entered
13997 into interactive sessions, those limitations apply to the code in code blocks
13998 using the @code{:session} header argument as well.
14000 Unless the @code{:results output} option is supplied (see below) the result
14001 returned is the result of the last evaluation performed by the
14002 interpreter. (This is obtained in a language-specific manner: the value of
14003 the variable @code{_} in Python and Ruby, and the value of @code{.Last.value}
14006 @subsubsection @code{:results output}
14007 The code is passed to the interpreter running as an interactive Emacs
14008 inferior process. The result returned is the concatenation of the sequence of
14009 (text) output from the interactive interpreter. Notice that this is not
14010 necessarily the same as what would be sent to @code{STDOUT} if the same code
14011 were passed to a non-interactive interpreter running as an external
14012 process. For example, compare the following two blocks:
14015 #+BEGIN_SRC python :results output
14026 In non-session mode, the `2' is not printed and does not appear.
14028 #+BEGIN_SRC python :results output :session
14040 But in @code{:session} mode, the interactive interpreter receives input `2'
14041 and prints out its value, `2'. (Indeed, the other print statements are
14044 @node Noweb reference syntax, Key bindings and useful functions, Results of evaluation, Working With Source Code
14045 @section Noweb reference syntax
14046 @cindex code block, noweb reference
14047 @cindex syntax, noweb
14048 @cindex source code, noweb reference
14050 The ``noweb'' (see @uref{http://www.cs.tufts.edu/~nr/noweb/}) Literate
14051 Programming system allows named blocks of code to be referenced by using the
14052 familiar Noweb syntax:
14055 <<code-block-name>>
14058 When a code block is tangled or evaluated, whether or not ``noweb''
14059 references are expanded depends upon the value of the @code{:noweb} header
14060 argument. If @code{:noweb yes}, then a Noweb reference is expanded before
14061 evaluation. If @code{:noweb no}, the default, then the reference is not
14062 expanded before evaluation. See the @ref{noweb-ref} header argument for
14063 a more flexible way to resolve noweb references.
14065 Note: the default value, @code{:noweb no}, was chosen to ensure that
14066 correct code is not broken in a language, such as Ruby, where
14067 @code{<<arg>>} is a syntactically valid construct. If @code{<<arg>>} is not
14068 syntactically valid in languages that you use, then please consider setting
14071 Note: if noweb tangling is slow in large Org-mode files consider setting the
14072 @code{*org-babel-use-quick-and-dirty-noweb-expansion*} variable to true.
14073 This will result in faster noweb reference resolution at the expense of not
14074 correctly resolving inherited values of the @code{:noweb-ref} header
14077 @node Key bindings and useful functions, Batch execution, Noweb reference syntax, Working With Source Code
14078 @section Key bindings and useful functions
14079 @cindex code block, key bindings
14081 Many common Org mode key sequences are re-bound depending on
14084 Within a code block, the following key bindings
14087 @multitable @columnfractions 0.25 0.75
14089 @item @kbd{C-c C-c} @tab @code{org-babel-execute-src-block}
14091 @item @kbd{C-c C-o} @tab @code{org-babel-open-src-block-result}
14093 @item @kbd{C-@key{up}} @tab @code{org-babel-load-in-session}
14095 @item @kbd{M-@key{down}} @tab @code{org-babel-pop-to-session}
14098 In an Org mode buffer, the following key bindings are active:
14100 @multitable @columnfractions 0.45 0.55
14102 @kindex C-c C-v C-a
14103 @item @kbd{C-c C-v a} @ @ @r{or} @ @ @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
14105 @kindex C-c C-v C-b
14106 @item @kbd{C-c C-v b} @ @ @r{or} @ @ @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
14108 @kindex C-c C-v C-f
14109 @item @kbd{C-c C-v f} @ @ @r{or} @ @ @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
14111 @item @kbd{C-c C-v g} @tab @code{org-babel-goto-named-source-block}
14113 @item @kbd{C-c C-v h} @tab @code{org-babel-describe-bindings}
14115 @kindex C-c C-v C-l
14116 @item @kbd{C-c C-v l} @ @ @r{or} @ @ @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest}
14118 @kindex C-c C-v C-p
14119 @item @kbd{C-c C-v p} @ @ @r{or} @ @ @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block}
14121 @kindex C-c C-v C-s
14122 @item @kbd{C-c C-v s} @ @ @r{or} @ @ @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
14124 @kindex C-c C-v C-t
14125 @item @kbd{C-c C-v t} @ @ @r{or} @ @ @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
14127 @kindex C-c C-v C-z
14128 @item @kbd{C-c C-v z} @ @ @r{or} @ @ @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session}
14131 @c When possible these keybindings were extended to work when the control key is
14132 @c kept pressed, resulting in the following additional keybindings.
14134 @c @multitable @columnfractions 0.25 0.75
14135 @c @item @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
14136 @c @item @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
14137 @c @item @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
14138 @c @item @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest}
14139 @c @item @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block}
14140 @c @item @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
14141 @c @item @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
14142 @c @item @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session}
14145 @node Batch execution, , Key bindings and useful functions, Working With Source Code
14146 @section Batch execution
14147 @cindex code block, batch execution
14148 @cindex source code, batch execution
14150 It is possible to call functions from the command line. This shell
14151 script calls @code{org-babel-tangle} on every one of its arguments.
14153 Be sure to adjust the paths to fit your system.
14157 # -*- mode: shell-script -*-
14159 # tangle files with org-mode
14163 ORGINSTALL="~/src/org/lisp/org-install.el"
14165 # wrap each argument in the code required to call tangle on it
14167 FILES="$FILES \"$i\""
14170 emacs -Q --batch -l $ORGINSTALL \
14172 (add-to-list 'load-path (expand-file-name \"~/src/org/lisp/\"))
14173 (add-to-list 'load-path (expand-file-name \"~/src/org/contrib/lisp/\"))
14174 (require 'org)(require 'org-exp)(require 'ob)(require 'ob-tangle)
14175 (mapc (lambda (file)
14176 (find-file (expand-file-name file \"$DIR\"))
14178 (kill-buffer)) '($FILES)))" 2>&1 |grep tangled
14181 @node Miscellaneous, Hacking, Working With Source Code, Top
14182 @chapter Miscellaneous
14185 * Completion:: M-TAB knows what you need
14186 * Easy Templates:: Quick insertion of structural elements
14187 * Speed keys:: Electric commands at the beginning of a headline
14188 * Code evaluation security:: Org mode files evaluate inline code
14189 * Customization:: Adapting Org to your taste
14190 * In-buffer settings:: Overview of the #+KEYWORDS
14191 * The very busy C-c C-c key:: When in doubt, press C-c C-c
14192 * Clean view:: Getting rid of leading stars in the outline
14193 * TTY keys:: Using Org on a tty
14194 * Interaction:: Other Emacs packages
14195 * org-crypt.el:: Encrypting Org files
14199 @node Completion, Easy Templates, Miscellaneous, Miscellaneous
14200 @section Completion
14201 @cindex completion, of @TeX{} symbols
14202 @cindex completion, of TODO keywords
14203 @cindex completion, of dictionary words
14204 @cindex completion, of option keywords
14205 @cindex completion, of tags
14206 @cindex completion, of property keys
14207 @cindex completion, of link abbreviations
14208 @cindex @TeX{} symbol completion
14209 @cindex TODO keywords completion
14210 @cindex dictionary word completion
14211 @cindex option keyword completion
14212 @cindex tag completion
14213 @cindex link abbreviations, completion of
14215 Emacs would not be Emacs without completion, and Org mode uses it whenever it
14216 makes sense. If you prefer an @i{iswitchb}- or @i{ido}-like interface for
14217 some of the completion prompts, you can specify your preference by setting at
14218 most one of the variables @code{org-completion-use-iswitchb}
14219 @code{org-completion-use-ido}.
14221 Org supports in-buffer completion. This type of completion does
14222 not make use of the minibuffer. You simply type a few letters into
14223 the buffer and use the key to complete text right there.
14226 @kindex M-@key{TAB}
14228 Complete word at point
14231 At the beginning of a headline, complete TODO keywords.
14233 After @samp{\}, complete @TeX{} symbols supported by the exporter.
14235 After @samp{*}, complete headlines in the current buffer so that they
14236 can be used in search links like @samp{[[*find this headline]]}.
14238 After @samp{:} in a headline, complete tags. The list of tags is taken
14239 from the variable @code{org-tag-alist} (possibly set through the
14240 @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
14241 dynamically from all tags used in the current buffer.
14243 After @samp{:} and not in a headline, complete property keys. The list
14244 of keys is constructed dynamically from all keys used in the current
14247 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
14249 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
14250 @samp{OPTIONS} which set file-specific options for Org mode. When the
14251 option keyword is already complete, pressing @kbd{M-@key{TAB}} again
14252 will insert example settings for this keyword.
14254 In the line after @samp{#+STARTUP: }, complete startup keywords,
14255 i.e.@: valid keys for this line.
14257 Elsewhere, complete dictionary words using Ispell.
14261 @node Easy Templates, Speed keys, Completion, Miscellaneous
14262 @section Easy Templates
14263 @cindex template insertion
14264 @cindex insertion, of templates
14266 Org mode supports insertion of empty structural elements (like
14267 @code{#+BEGIN_SRC} and @code{#+END_SRC} pairs) with just a few key
14268 strokes. This is achieved through a native template expansion mechanism.
14269 Note that Emacs has several other template mechanisms which could be used in
14270 a similar way, for example @file{yasnippet}.
14272 To insert a structural element, type a @samp{<}, followed by a template
14273 selector and @kbd{@key{TAB}}. Completion takes effect only when the above
14274 keystrokes are typed on a line by itself.
14276 The following template selectors are currently supported.
14278 @multitable @columnfractions 0.1 0.9
14279 @item @kbd{s} @tab @code{#+BEGIN_SRC ... #+END_SRC}
14280 @item @kbd{e} @tab @code{#+BEGIN_EXAMPLE ... #+END_EXAMPLE}
14281 @item @kbd{q} @tab @code{#+BEGIN_QUOTE ... #+END_QUOTE}
14282 @item @kbd{v} @tab @code{#+BEGIN_VERSE ... #+END_VERSE}
14283 @item @kbd{c} @tab @code{#+BEGIN_CENTER ... #+END_CENTER}
14284 @item @kbd{l} @tab @code{#+BEGIN_LaTeX ... #+END_LaTeX}
14285 @item @kbd{L} @tab @code{#+LaTeX:}
14286 @item @kbd{h} @tab @code{#+BEGIN_HTML ... #+END_HTML}
14287 @item @kbd{H} @tab @code{#+HTML:}
14288 @item @kbd{a} @tab @code{#+BEGIN_ASCII ... #+END_ASCII}
14289 @item @kbd{A} @tab @code{#+ASCII:}
14290 @item @kbd{i} @tab @code{#+INDEX:} line
14291 @item @kbd{I} @tab @code{#+INCLUDE:} line
14294 For example, on an empty line, typing "<e" and then pressing TAB, will expand
14295 into a complete EXAMPLE template.
14297 You can install additional templates by customizing the variable
14298 @code{org-structure-template-alist}. See the docstring of the variable for
14299 additional details.
14301 @node Speed keys, Code evaluation security, Easy Templates, Miscellaneous
14302 @section Speed keys
14304 @vindex org-use-speed-commands
14305 @vindex org-speed-commands-user
14307 Single keys can be made to execute commands when the cursor is at the
14308 beginning of a headline, i.e.@: before the first star. Configure the variable
14309 @code{org-use-speed-commands} to activate this feature. There is a
14310 pre-defined list of commands, and you can add more such commands using the
14311 variable @code{org-speed-commands-user}. Speed keys do not only speed up
14312 navigation and other commands, but they also provide an alternative way to
14313 execute commands bound to keys that are not or not easily available on a TTY,
14314 or on a small mobile device with a limited keyboard.
14316 To see which commands are available, activate the feature and press @kbd{?}
14317 with the cursor at the beginning of a headline.
14319 @node Code evaluation security, Customization, Speed keys, Miscellaneous
14320 @section Code evaluation and security issues
14322 Org provides tools to work with the code snippets, including evaluating them.
14324 Running code on your machine always comes with a security risk. Badly
14325 written or malicious code can be executed on purpose or by accident. Org has
14326 default settings which will only evaluate such code if you give explicit
14327 permission to do so, and as a casual user of these features you should leave
14328 these precautions intact.
14330 For people who regularly work with such code, the confirmation prompts can
14331 become annoying, and you might want to turn them off. This can be done, but
14332 you must be aware of the risks that are involved.
14334 Code evaluation can happen under the following circumstances:
14337 @item Source code blocks
14338 Source code blocks can be evaluated during export, or when pressing @kbd{C-c
14339 C-c} in the block. The most important thing to realize here is that Org mode
14340 files which contain code snippets are, in a certain sense, like executable
14341 files. So you should accept them and load them into Emacs only from trusted
14342 sources---just like you would do with a program you install on your computer.
14344 Make sure you know what you are doing before customizing the variables
14345 which take off the default security brakes.
14347 @defopt org-confirm-babel-evaluate
14348 When t (the default), the user is asked before every code block evaluation.
14349 When nil, the user is not asked. When set to a function, it is called with
14350 two arguments (language and body of the code block) and should return t to
14351 ask and nil not to ask.
14354 For example, here is how to execute "ditaa" code (which is considered safe)
14357 (defun my-org-confirm-babel-evaluate (lang body)
14358 (not (string= lang "ditaa"))) ; don't ask for ditaa
14359 (setq org-confirm-babel-evaluate 'my-org-confirm-babel-evaluate)
14362 @item Following @code{shell} and @code{elisp} links
14363 Org has two link types that can directly evaluate code (@pxref{External
14364 links}). These links can be problematic because the code to be evaluated is
14367 @defopt org-confirm-shell-link-function
14368 Function to queries user about shell link execution.
14370 @defopt org-confirm-elisp-link-function
14371 Functions to query user for Emacs Lisp link execution.
14374 @item Formulas in tables
14375 Formulas in tables (@pxref{The spreadsheet}) are code that is evaluated
14376 either by the @i{calc} interpreter, or by the @i{Emacs Lisp} interpreter.
14379 @node Customization, In-buffer settings, Code evaluation security, Miscellaneous
14380 @section Customization
14381 @cindex customization
14382 @cindex options, for customization
14383 @cindex variables, for customization
14385 There are more than 500 variables that can be used to customize
14386 Org. For the sake of compactness of the manual, I am not
14387 describing the variables here. A structured overview of customization
14388 variables is available with @kbd{M-x org-customize}. Or select
14389 @code{Browse Org Group} from the @code{Org->Customization} menu. Many
14390 settings can also be activated on a per-file basis, by putting special
14391 lines into the buffer (@pxref{In-buffer settings}).
14393 @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous
14394 @section Summary of in-buffer settings
14395 @cindex in-buffer settings
14396 @cindex special keywords
14398 Org mode uses special lines in the buffer to define settings on a
14399 per-file basis. These lines start with a @samp{#+} followed by a
14400 keyword, a colon, and then individual words defining a setting. Several
14401 setting words can be in the same line, but you can also have multiple
14402 lines for the keyword. While these settings are described throughout
14403 the manual, here is a summary. After changing any of those lines in the
14404 buffer, press @kbd{C-c C-c} with the cursor still in the line to
14405 activate the changes immediately. Otherwise they become effective only
14406 when the file is visited again in a new Emacs session.
14408 @vindex org-archive-location
14410 @item #+ARCHIVE: %s_done::
14411 This line sets the archive location for the agenda file. It applies for
14412 all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
14413 of the file. The first such line also applies to any entries before it.
14414 The corresponding variable is @code{org-archive-location}.
14416 This line sets the category for the agenda file. The category applies
14417 for all subsequent lines until the next @samp{#+CATEGORY} line, or the
14418 end of the file. The first such line also applies to any entries before it.
14419 @item #+COLUMNS: %25ITEM .....
14420 @cindex property, COLUMNS
14421 Set the default format for columns view. This format applies when
14422 columns view is invoked in locations where no @code{COLUMNS} property
14424 @item #+CONSTANTS: name1=value1 ...
14425 @vindex org-table-formula-constants
14426 @vindex org-table-formula
14427 Set file-local values for constants to be used in table formulas. This
14428 line sets the local variable @code{org-table-formula-constants-local}.
14429 The global version of this variable is
14430 @code{org-table-formula-constants}.
14431 @item #+FILETAGS: :tag1:tag2:tag3:
14432 Set tags that can be inherited by any entry in the file, including the
14434 @item #+DRAWERS: NAME1 .....
14435 @vindex org-drawers
14436 Set the file-local set of drawers. The corresponding global variable is
14437 @code{org-drawers}.
14438 @item #+LINK: linkword replace
14439 @vindex org-link-abbrev-alist
14440 These lines (several are allowed) specify link abbreviations.
14441 @xref{Link abbreviations}. The corresponding variable is
14442 @code{org-link-abbrev-alist}.
14443 @item #+PRIORITIES: highest lowest default
14444 @vindex org-highest-priority
14445 @vindex org-lowest-priority
14446 @vindex org-default-priority
14447 This line sets the limits and the default for the priorities. All three
14448 must be either letters A-Z or numbers 0-9. The highest priority must
14449 have a lower ASCII number than the lowest priority.
14450 @item #+PROPERTY: Property_Name Value
14451 This line sets a default inheritance value for entries in the current
14452 buffer, most useful for specifying the allowed values of a property.
14453 @cindex #+SETUPFILE
14454 @item #+SETUPFILE: file
14455 This line defines a file that holds more in-buffer setup. Normally this is
14456 entirely ignored. Only when the buffer is parsed for option-setting lines
14457 (i.e.@: when starting Org mode for a file, when pressing @kbd{C-c C-c} in a
14458 settings line, or when exporting), then the contents of this file are parsed
14459 as if they had been included in the buffer. In particular, the file can be
14460 any other Org mode file with internal setup. You can visit the file the
14461 cursor is in the line with @kbd{C-c '}.
14464 This line sets options to be used at startup of Org mode, when an
14465 Org file is being visited.
14467 The first set of options deals with the initial visibility of the outline
14468 tree. The corresponding variable for global default settings is
14469 @code{org-startup-folded}, with a default value @code{t}, which means
14471 @vindex org-startup-folded
14472 @cindex @code{overview}, STARTUP keyword
14473 @cindex @code{content}, STARTUP keyword
14474 @cindex @code{showall}, STARTUP keyword
14475 @cindex @code{showeverything}, STARTUP keyword
14477 overview @r{top-level headlines only}
14478 content @r{all headlines}
14479 showall @r{no folding of any entries}
14480 showeverything @r{show even drawer contents}
14483 @vindex org-startup-indented
14484 @cindex @code{indent}, STARTUP keyword
14485 @cindex @code{noindent}, STARTUP keyword
14486 Dynamic virtual indentation is controlled by the variable
14487 @code{org-startup-indented}@footnote{Emacs 23 and Org mode 6.29 are required}
14489 indent @r{start with @code{org-indent-mode} turned on}
14490 noindent @r{start with @code{org-indent-mode} turned off}
14493 @vindex org-startup-align-all-tables
14494 Then there are options for aligning tables upon visiting a file. This
14495 is useful in files containing narrowed table columns. The corresponding
14496 variable is @code{org-startup-align-all-tables}, with a default value
14498 @cindex @code{align}, STARTUP keyword
14499 @cindex @code{noalign}, STARTUP keyword
14501 align @r{align all tables}
14502 noalign @r{don't align tables on startup}
14505 @vindex org-startup-with-inline-images
14506 When visiting a file, inline images can be automatically displayed. The
14507 corresponding variable is @code{org-startup-with-inline-images}, with a
14508 default value @code{nil} to avoid delays when visiting a file.
14509 @cindex @code{inlineimages}, STARTUP keyword
14510 @cindex @code{noinlineimages}, STARTUP keyword
14512 inlineimages @r{show inline images}
14513 noinlineimages @r{don't show inline images on startup}
14516 @vindex org-log-done
14517 @vindex org-log-note-clock-out
14518 @vindex org-log-repeat
14519 Logging the closing and reopening of TODO items and clock intervals can be
14520 configured using these options (see variables @code{org-log-done},
14521 @code{org-log-note-clock-out} and @code{org-log-repeat})
14522 @cindex @code{logdone}, STARTUP keyword
14523 @cindex @code{lognotedone}, STARTUP keyword
14524 @cindex @code{nologdone}, STARTUP keyword
14525 @cindex @code{lognoteclock-out}, STARTUP keyword
14526 @cindex @code{nolognoteclock-out}, STARTUP keyword
14527 @cindex @code{logrepeat}, STARTUP keyword
14528 @cindex @code{lognoterepeat}, STARTUP keyword
14529 @cindex @code{nologrepeat}, STARTUP keyword
14530 @cindex @code{logreschedule}, STARTUP keyword
14531 @cindex @code{lognotereschedule}, STARTUP keyword
14532 @cindex @code{nologreschedule}, STARTUP keyword
14533 @cindex @code{logredeadline}, STARTUP keyword
14534 @cindex @code{lognoteredeadline}, STARTUP keyword
14535 @cindex @code{nologredeadline}, STARTUP keyword
14536 @cindex @code{logrefile}, STARTUP keyword
14537 @cindex @code{lognoterefile}, STARTUP keyword
14538 @cindex @code{nologrefile}, STARTUP keyword
14540 logdone @r{record a timestamp when an item is marked DONE}
14541 lognotedone @r{record timestamp and a note when DONE}
14542 nologdone @r{don't record when items are marked DONE}
14543 logrepeat @r{record a time when reinstating a repeating item}
14544 lognoterepeat @r{record a note when reinstating a repeating item}
14545 nologrepeat @r{do not record when reinstating repeating item}
14546 lognoteclock-out @r{record a note when clocking out}
14547 nolognoteclock-out @r{don't record a note when clocking out}
14548 logreschedule @r{record a timestamp when scheduling time changes}
14549 lognotereschedule @r{record a note when scheduling time changes}
14550 nologreschedule @r{do not record when a scheduling date changes}
14551 logredeadline @r{record a timestamp when deadline changes}
14552 lognoteredeadline @r{record a note when deadline changes}
14553 nologredeadline @r{do not record when a deadline date changes}
14554 logrefile @r{record a timestamp when refiling}
14555 lognoterefile @r{record a note when refiling}
14556 nologrefile @r{do not record when refiling}
14558 @vindex org-hide-leading-stars
14559 @vindex org-odd-levels-only
14560 Here are the options for hiding leading stars in outline headings, and for
14561 indenting outlines. The corresponding variables are
14562 @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
14563 default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
14564 @cindex @code{hidestars}, STARTUP keyword
14565 @cindex @code{showstars}, STARTUP keyword
14566 @cindex @code{odd}, STARTUP keyword
14567 @cindex @code{even}, STARTUP keyword
14569 hidestars @r{make all but one of the stars starting a headline invisible.}
14570 showstars @r{show all stars starting a headline}
14571 indent @r{virtual indentation according to outline level}
14572 noindent @r{no virtual indentation according to outline level}
14573 odd @r{allow only odd outline levels (1,3,...)}
14574 oddeven @r{allow all outline levels}
14576 @vindex org-put-time-stamp-overlays
14577 @vindex org-time-stamp-overlay-formats
14578 To turn on custom format overlays over timestamps (variables
14579 @code{org-put-time-stamp-overlays} and
14580 @code{org-time-stamp-overlay-formats}), use
14581 @cindex @code{customtime}, STARTUP keyword
14583 customtime @r{overlay custom time format}
14585 @vindex constants-unit-system
14586 The following options influence the table spreadsheet (variable
14587 @code{constants-unit-system}).
14588 @cindex @code{constcgs}, STARTUP keyword
14589 @cindex @code{constSI}, STARTUP keyword
14591 constcgs @r{@file{constants.el} should use the c-g-s unit system}
14592 constSI @r{@file{constants.el} should use the SI unit system}
14594 @vindex org-footnote-define-inline
14595 @vindex org-footnote-auto-label
14596 @vindex org-footnote-auto-adjust
14597 To influence footnote settings, use the following keywords. The
14598 corresponding variables are @code{org-footnote-define-inline},
14599 @code{org-footnote-auto-label}, and @code{org-footnote-auto-adjust}.
14600 @cindex @code{fninline}, STARTUP keyword
14601 @cindex @code{nofninline}, STARTUP keyword
14602 @cindex @code{fnlocal}, STARTUP keyword
14603 @cindex @code{fnprompt}, STARTUP keyword
14604 @cindex @code{fnauto}, STARTUP keyword
14605 @cindex @code{fnconfirm}, STARTUP keyword
14606 @cindex @code{fnplain}, STARTUP keyword
14607 @cindex @code{fnadjust}, STARTUP keyword
14608 @cindex @code{nofnadjust}, STARTUP keyword
14610 fninline @r{define footnotes inline}
14611 fnnoinline @r{define footnotes in separate section}
14612 fnlocal @r{define footnotes near first reference, but not inline}
14613 fnprompt @r{prompt for footnote labels}
14614 fnauto @r{create @code{[fn:1]}-like labels automatically (default)}
14615 fnconfirm @r{offer automatic label for editing or confirmation}
14616 fnplain @r{create @code{[1]}-like labels automatically}
14617 fnadjust @r{automatically renumber and sort footnotes}
14618 nofnadjust @r{do not renumber and sort automatically}
14620 @cindex org-hide-block-startup
14621 To hide blocks on startup, use these keywords. The corresponding variable is
14622 @code{org-hide-block-startup}.
14623 @cindex @code{hideblocks}, STARTUP keyword
14624 @cindex @code{nohideblocks}, STARTUP keyword
14626 hideblocks @r{Hide all begin/end blocks on startup}
14627 nohideblocks @r{Do not hide blocks on startup}
14629 @cindex org-pretty-entities
14630 The display of entities as UTF-8 characters is governed by the variable
14631 @code{org-pretty-entities} and the keywords
14632 @cindex @code{entitiespretty}, STARTUP keyword
14633 @cindex @code{entitiesplain}, STARTUP keyword
14635 entitiespretty @r{Show entities as UTF-8 characters where possible}
14636 entitiesplain @r{Leave entities plain}
14638 @item #+TAGS: TAG1(c1) TAG2(c2)
14639 @vindex org-tag-alist
14640 These lines (several such lines are allowed) specify the valid tags in
14641 this file, and (potentially) the corresponding @emph{fast tag selection}
14642 keys. The corresponding variable is @code{org-tag-alist}.
14644 This line contains the formulas for the table directly above the line.
14645 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+DATE:,
14646 @itemx #+OPTIONS:, #+BIND:, #+XSLT:,
14647 @itemx #+DESCRIPTION:, #+KEYWORDS:,
14648 @itemx #+LaTeX_HEADER:, #+STYLE:, #+LINK_UP:, #+LINK_HOME:,
14649 @itemx #+EXPORT_SELECT_TAGS:, #+EXPORT_EXCLUDE_TAGS:
14650 These lines provide settings for exporting files. For more details see
14651 @ref{Export options}.
14652 @item #+TODO: #+SEQ_TODO: #+TYP_TODO:
14653 @vindex org-todo-keywords
14654 These lines set the TODO keywords and their interpretation in the
14655 current file. The corresponding variable is @code{org-todo-keywords}.
14658 @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous
14659 @section The very busy C-c C-c key
14661 @cindex C-c C-c, overview
14663 The key @kbd{C-c C-c} has many purposes in Org, which are all
14664 mentioned scattered throughout this manual. One specific function of
14665 this key is to add @emph{tags} to a headline (@pxref{Tags}). In many
14666 other circumstances it means something like @emph{``Hey Org, look
14667 here and update according to what you see here''}. Here is a summary of
14668 what this means in different contexts.
14672 If there are highlights in the buffer from the creation of a sparse
14673 tree, or from clock display, remove these highlights.
14675 If the cursor is in one of the special @code{#+KEYWORD} lines, this
14676 triggers scanning the buffer for these lines and updating the
14679 If the cursor is inside a table, realign the table. This command
14680 works even if the automatic table editor has been turned off.
14682 If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
14685 If the current buffer is a capture buffer, close the note and file it.
14686 With a prefix argument, file it, without further interaction, to the
14689 If the cursor is on a @code{<<<target>>>}, update radio targets and
14690 corresponding links in this buffer.
14692 If the cursor is in a property line or at the start or end of a property
14693 drawer, offer property commands.
14695 If the cursor is at a footnote reference, go to the corresponding
14696 definition, and vice versa.
14698 If the cursor is on a statistics cookie, update it.
14700 If the cursor is in a plain list item with a checkbox, toggle the status
14703 If the cursor is on a numbered item in a plain list, renumber the
14706 If the cursor is on the @code{#+BEGIN} line of a dynamic block, the
14709 If the cursor is at a timestamp, fix the day name in the timestamp.
14712 @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous
14713 @section A cleaner outline view
14714 @cindex hiding leading stars
14715 @cindex dynamic indentation
14716 @cindex odd-levels-only outlines
14717 @cindex clean outline view
14719 Some people find it noisy and distracting that the Org headlines start with a
14720 potentially large number of stars, and that text below the headlines is not
14721 indented. While this is no problem when writing a @emph{book-like} document
14722 where the outline headings are really section headings, in a more
14723 @emph{list-oriented} outline, indented structure is a lot cleaner:
14727 * Top level headline | * Top level headline
14728 ** Second level | * Second level
14729 *** 3rd level | * 3rd level
14730 some text | some text
14731 *** 3rd level | * 3rd level
14732 more text | more text
14733 * Another top level headline | * Another top level headline
14739 If you are using at least Emacs 23.2@footnote{Emacs 23.1 can actually crash
14740 with @code{org-indent-mode}} and version 6.29 of Org, this kind of view can
14741 be achieved dynamically at display time using @code{org-indent-mode}. In
14742 this minor mode, all lines are prefixed for display with the necessary amount
14743 of space@footnote{@code{org-indent-mode} also sets the @code{wrap-prefix}
14744 property, such that @code{visual-line-mode} (or purely setting
14745 @code{word-wrap}) wraps long lines (including headlines) correctly indented.
14746 }. Also headlines are prefixed with additional stars, so that the amount of
14747 indentation shifts by two@footnote{See the variable
14748 @code{org-indent-indentation-per-level}.} spaces per level. All headline
14749 stars but the last one are made invisible using the @code{org-hide}
14750 face@footnote{Turning on @code{org-indent-mode} sets
14751 @code{org-hide-leading-stars} to @code{t} and @code{org-adapt-indentation} to
14752 @code{nil}.} - see below under @samp{2.} for more information on how this
14753 works. You can turn on @code{org-indent-mode} for all files by customizing
14754 the variable @code{org-startup-indented}, or you can turn it on for
14755 individual files using
14761 If you want a similar effect in an earlier version of Emacs and/or Org, or if
14762 you want the indentation to be hard space characters so that the plain text
14763 file looks as similar as possible to the Emacs display, Org supports you in
14768 @emph{Indentation of text below headlines}@*
14769 You may indent text below each headline to make the left boundary line up
14770 with the headline, like
14774 more text, now indented
14777 @vindex org-adapt-indentation
14778 Org supports this with paragraph filling, line wrapping, and structure
14779 editing@footnote{See also the variable @code{org-adapt-indentation}.},
14780 preserving or adapting the indentation as appropriate.
14783 @vindex org-hide-leading-stars
14784 @emph{Hiding leading stars}@* You can modify the display in such a way that
14785 all leading stars become invisible. To do this in a global way, configure
14786 the variable @code{org-hide-leading-stars} or change this on a per-file basis
14790 #+STARTUP: hidestars
14791 #+STARTUP: showstars
14794 With hidden stars, the tree becomes:
14798 * Top level headline
14806 @vindex org-hide @r{(face)}
14807 The leading stars are not truly replaced by whitespace, they are only
14808 fontified with the face @code{org-hide} that uses the background color as
14809 font color. If you are not using either white or black background, you may
14810 have to customize this face to get the wanted effect. Another possibility is
14811 to set this font such that the extra stars are @i{almost} invisible, for
14812 example using the color @code{grey90} on a white background.
14815 @vindex org-odd-levels-only
14816 Things become cleaner still if you skip all the even levels and use only odd
14817 levels 1, 3, 5..., effectively adding two stars to go from one outline level
14818 to the next@footnote{When you need to specify a level for a property search
14819 or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc@.}. In this
14820 way we get the outline view shown at the beginning of this section. In order
14821 to make the structure editing and export commands handle this convention
14822 correctly, configure the variable @code{org-odd-levels-only}, or set this on
14823 a per-file basis with one of the following lines:
14830 You can convert an Org file from single-star-per-level to the
14831 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
14832 RET} in that file. The reverse operation is @kbd{M-x
14833 org-convert-to-oddeven-levels}.
14836 @node TTY keys, Interaction, Clean view, Miscellaneous
14837 @section Using Org on a tty
14838 @cindex tty key bindings
14840 Because Org contains a large number of commands, by default many of
14841 Org's core commands are bound to keys that are generally not
14842 accessible on a tty, such as the cursor keys (@key{left}, @key{right},
14843 @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
14844 together with modifiers like @key{Meta} and/or @key{Shift}. To access
14845 these commands on a tty when special keys are unavailable, the following
14846 alternative bindings can be used. The tty bindings below will likely be
14847 more cumbersome; you may find for some of the bindings below that a
14848 customized workaround suits you better. For example, changing a timestamp
14849 is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
14850 tty you would rather use @kbd{C-c .} to re-insert the timestamp.
14852 @multitable @columnfractions 0.15 0.2 0.1 0.2
14853 @item @b{Default} @tab @b{Alternative 1} @tab @b{Speed key} @tab @b{Alternative 2}
14854 @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab @kbd{C} @tab
14855 @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{l} @tab @kbd{@key{Esc} @key{left}}
14856 @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab @kbd{L} @tab
14857 @item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{r} @tab @kbd{@key{Esc} @key{right}}
14858 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab @kbd{R} @tab
14859 @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{ } @tab @kbd{@key{Esc} @key{up}}
14860 @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab @kbd{U} @tab
14861 @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{ } @tab @kbd{@key{Esc} @key{down}}
14862 @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab @kbd{D} @tab
14863 @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab @kbd{ } @tab
14864 @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{ } @tab @kbd{@key{Esc} @key{RET}}
14865 @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab @kbd{ } @tab
14866 @item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab @kbd{ } @tab
14867 @item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab @kbd{ } @tab
14868 @item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab @kbd{ } @tab
14869 @item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab @kbd{ } @tab
14870 @item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab @kbd{ } @tab
14871 @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab @kbd{ } @tab
14875 @node Interaction, org-crypt.el, TTY keys, Miscellaneous
14876 @section Interaction with other packages
14877 @cindex packages, interaction with other
14878 Org lives in the world of GNU Emacs and interacts in various ways
14879 with other code out there.
14882 * Cooperation:: Packages Org cooperates with
14883 * Conflicts:: Packages that lead to conflicts
14886 @node Cooperation, Conflicts, Interaction, Interaction
14887 @subsection Packages that Org cooperates with
14890 @cindex @file{calc.el}
14891 @cindex Gillespie, Dave
14892 @item @file{calc.el} by Dave Gillespie
14893 Org uses the Calc package for implementing spreadsheet
14894 functionality in its tables (@pxref{The spreadsheet}). Org
14895 checks for the availability of Calc by looking for the function
14896 @code{calc-eval} which will have been autoloaded during setup if Calc has
14897 been installed properly. As of Emacs 22, Calc is part of the Emacs
14898 distribution. Another possibility for interaction between the two
14899 packages is using Calc for embedded calculations. @xref{Embedded Mode,
14900 , Embedded Mode, Calc, GNU Emacs Calc Manual}.
14901 @item @file{constants.el} by Carsten Dominik
14902 @cindex @file{constants.el}
14903 @cindex Dominik, Carsten
14904 @vindex org-table-formula-constants
14905 In a table formula (@pxref{The spreadsheet}), it is possible to use
14906 names for natural constants or units. Instead of defining your own
14907 constants in the variable @code{org-table-formula-constants}, install
14908 the @file{constants} package which defines a large number of constants
14909 and units, and lets you use unit prefixes like @samp{M} for
14910 @samp{Mega}, etc@. You will need version 2.0 of this package, available
14911 at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for
14912 the function @code{constants-get}, which has to be autoloaded in your
14913 setup. See the installation instructions in the file
14914 @file{constants.el}.
14915 @item @file{cdlatex.el} by Carsten Dominik
14916 @cindex @file{cdlatex.el}
14917 @cindex Dominik, Carsten
14918 Org mode can make use of the CD@LaTeX{} package to efficiently enter
14919 @LaTeX{} fragments into Org files. See @ref{CDLaTeX mode}.
14920 @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
14921 @cindex @file{imenu.el}
14922 Imenu allows menu access to an index of items in a file. Org mode
14923 supports Imenu---all you need to do to get the index is the following:
14925 (add-hook 'org-mode-hook
14926 (lambda () (imenu-add-to-menubar "Imenu")))
14928 @vindex org-imenu-depth
14929 By default the index is two levels deep---you can modify the depth using
14930 the option @code{org-imenu-depth}.
14931 @item @file{remember.el} by John Wiegley
14932 @cindex @file{remember.el}
14933 @cindex Wiegley, John
14934 Org used to use this package for capture, but no longer does.
14935 @item @file{speedbar.el} by Eric M. Ludlam
14936 @cindex @file{speedbar.el}
14937 @cindex Ludlam, Eric M.
14938 Speedbar is a package that creates a special frame displaying files and
14939 index items in files. Org mode supports Speedbar and allows you to
14940 drill into Org files directly from the Speedbar. It also allows you to
14941 restrict the scope of agenda commands to a file or a subtree by using
14942 the command @kbd{<} in the Speedbar frame.
14943 @cindex @file{table.el}
14944 @item @file{table.el} by Takaaki Ota
14946 @cindex table editor, @file{table.el}
14947 @cindex @file{table.el}
14948 @cindex Ota, Takaaki
14950 Complex ASCII tables with automatic line wrapping, column- and row-spanning,
14951 and alignment can be created using the Emacs table package by Takaaki Ota
14952 (@uref{http://sourceforge.net/projects/table}, and also part of Emacs 22).
14953 Org mode will recognize these tables and export them properly. Because of
14954 interference with other Org mode functionality, you unfortunately cannot edit
14955 these tables directly in the buffer. Instead, you need to use the command
14956 @kbd{C-c '} to edit them, similar to source code snippets.
14959 @orgcmd{C-c ',org-edit-special}
14960 Edit a @file{table.el} table. Works when the cursor is in a table.el table.
14962 @orgcmd{C-c ~,org-table-create-with-table.el}
14963 Insert a @file{table.el} table. If there is already a table at point, this
14964 command converts it between the @file{table.el} format and the Org mode
14965 format. See the documentation string of the command
14966 @code{org-convert-table} for the restrictions under which this is
14969 @file{table.el} is part of Emacs since Emacs 22.
14970 @item @file{footnote.el} by Steven L. Baur
14971 @cindex @file{footnote.el}
14972 @cindex Baur, Steven L.
14973 Org mode recognizes numerical footnotes as provided by this package.
14974 However, Org mode also has its own footnote support (@pxref{Footnotes}),
14975 which makes using @file{footnote.el} unnecessary.
14978 @node Conflicts, , Cooperation, Interaction
14979 @subsection Packages that lead to conflicts with Org mode
14983 @cindex @code{shift-selection-mode}
14984 @vindex org-support-shift-select
14985 In Emacs 23, @code{shift-selection-mode} is on by default, meaning that
14986 cursor motions combined with the shift key should start or enlarge regions.
14987 This conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change
14988 timestamps, TODO keywords, priorities, and item bullet types if the cursor is
14989 at such a location. By default, @kbd{S-@key{cursor}} commands outside
14990 special contexts don't do anything, but you can customize the variable
14991 @code{org-support-shift-select}. Org mode then tries to accommodate shift
14992 selection by (i) using it outside of the special contexts where special
14993 commands apply, and by (ii) extending an existing active region even if the
14994 cursor moves across a special context.
14996 @item @file{CUA.el} by Kim. F. Storm
14997 @cindex @file{CUA.el}
14998 @cindex Storm, Kim. F.
14999 @vindex org-replace-disputed-keys
15000 Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by CUA mode
15001 (as well as @code{pc-select-mode} and @code{s-region-mode}) to select and extend the
15002 region. In fact, Emacs 23 has this built-in in the form of
15003 @code{shift-selection-mode}, see previous paragraph. If you are using Emacs
15004 23, you probably don't want to use another package for this purpose. However,
15005 if you prefer to leave these keys to a different package while working in
15006 Org mode, configure the variable @code{org-replace-disputed-keys}. When set,
15007 Org will move the following key bindings in Org files, and in the agenda
15008 buffer (but not during date selection).
15011 S-UP @result{} M-p S-DOWN @result{} M-n
15012 S-LEFT @result{} M-- S-RIGHT @result{} M-+
15013 C-S-LEFT @result{} M-S-- C-S-RIGHT @result{} M-S-+
15016 @vindex org-disputed-keys
15017 Yes, these are unfortunately more difficult to remember. If you want
15018 to have other replacement keys, look at the variable
15019 @code{org-disputed-keys}.
15021 @item @file{yasnippet.el}
15022 @cindex @file{yasnippet.el}
15023 The way Org mode binds the TAB key (binding to @code{[tab]} instead of
15024 @code{"\t"}) overrules YASnippet's access to this key. The following code
15025 fixed this problem:
15028 (add-hook 'org-mode-hook
15030 (org-set-local 'yas/trigger-key [tab])
15031 (define-key yas/keymap [tab] 'yas/next-field-or-maybe-expand)))
15034 The latest version of yasnippet doesn't play well with Org mode. If the
15035 above code does not fix the conflict, start by defining the following
15039 (defun yas/org-very-safe-expand ()
15040 (let ((yas/fallback-behavior 'return-nil)) (yas/expand)))
15043 Then, tell Org mode what to do with the new function:
15046 (add-hook 'org-mode-hook
15048 (make-variable-buffer-local 'yas/trigger-key)
15049 (setq yas/trigger-key [tab])
15050 (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand)
15051 (define-key yas/keymap [tab] 'yas/next-field)))
15054 @item @file{windmove.el} by Hovav Shacham
15055 @cindex @file{windmove.el}
15056 This package also uses the @kbd{S-<cursor>} keys, so everything written
15057 in the paragraph above about CUA mode also applies here. If you want make
15058 the windmove function active in locations where Org mode does not have
15059 special functionality on @kbd{S-@key{cursor}}, add this to your
15063 ;; Make windmove work in org-mode:
15064 (add-hook 'org-shiftup-final-hook 'windmove-up)
15065 (add-hook 'org-shiftleft-final-hook 'windmove-left)
15066 (add-hook 'org-shiftdown-final-hook 'windmove-down)
15067 (add-hook 'org-shiftright-final-hook 'windmove-right)
15070 @item @file{viper.el} by Michael Kifer
15071 @cindex @file{viper.el}
15073 Viper uses @kbd{C-c /} and therefore makes this key not access the
15074 corresponding Org mode command @code{org-sparse-tree}. You need to find
15075 another key for this command, or override the key in
15076 @code{viper-vi-global-user-map} with
15079 (define-key viper-vi-global-user-map "C-c /" 'org-sparse-tree)
15084 @node org-crypt.el, , Interaction, Miscellaneous
15085 @section org-crypt.el
15086 @cindex @file{org-crypt.el}
15087 @cindex @code{org-decrypt-entry}
15089 Org-crypt will encrypt the text of an entry, but not the headline, or
15090 properties. Org-crypt uses the Emacs EasyPG library to encrypt and decrypt
15093 Any text below a headline that has a @samp{:crypt:} tag will be automatically
15094 be encrypted when the file is saved. If you want to use a different tag just
15095 customize the @code{org-crypt-tag-matcher} setting.
15097 To use org-crypt it is suggested that you have the following in your
15101 (require 'org-crypt)
15102 (org-crypt-use-before-save-magic)
15103 (setq org-tags-exclude-from-inheritance (quote ("crypt")))
15105 (setq org-crypt-key nil)
15106 ;; GPG key to use for encryption
15107 ;; Either the Key ID or set to nil to use symmetric encryption.
15109 (setq auto-save-default nil)
15110 ;; Auto-saving does not cooperate with org-crypt.el: so you need
15111 ;; to turn it off if you plan to use org-crypt.el quite often.
15112 ;; Otherwise, you'll get an (annoying) message each time you
15115 ;; To turn it off only locally, you can insert this:
15117 ;; # -*- buffer-auto-save-file-name: nil; -*-
15120 Excluding the crypt tag from inheritance prevents already encrypted text
15121 being encrypted again.
15123 @node Hacking, MobileOrg, Miscellaneous, Top
15127 This appendix covers some aspects where users can extend the functionality of
15131 * Hooks:: Who to reach into Org's internals
15132 * Add-on packages:: Available extensions
15133 * Adding hyperlink types:: New custom link types
15134 * Context-sensitive commands:: How to add functionality to such commands
15135 * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
15136 * Dynamic blocks:: Automatically filled blocks
15137 * Special agenda views:: Customized views
15138 * Extracting agenda information:: Postprocessing of agenda information
15139 * Using the property API:: Writing programs that use entry properties
15140 * Using the mapping API:: Mapping over all or selected entries
15143 @node Hooks, Add-on packages, Hacking, Hacking
15147 Org has a large number of hook variables that can be used to add
15148 functionality. This appendix about hacking is going to illustrate the
15149 use of some of them. A complete list of all hooks with documentation is
15150 maintained by the Worg project and can be found at
15151 @uref{http://orgmode.org/worg/org-configs/org-hooks.php}.
15153 @node Add-on packages, Adding hyperlink types, Hooks, Hacking
15154 @section Add-on packages
15155 @cindex add-on packages
15157 A large number of add-on packages have been written by various authors.
15158 These packages are not part of Emacs, but they are distributed as contributed
15159 packages with the separate release available at the Org mode home page at
15160 @uref{http://orgmode.org}. The list of contributed packages, along with
15161 documentation about each package, is maintained by the Worg project at
15162 @uref{http://orgmode.org/worg/org-contrib/}.
15166 @node Adding hyperlink types, Context-sensitive commands, Add-on packages, Hacking
15167 @section Adding hyperlink types
15168 @cindex hyperlinks, adding new types
15170 Org has a large number of hyperlink types built-in
15171 (@pxref{Hyperlinks}). If you would like to add new link types, Org
15172 provides an interface for doing so. Let's look at an example file,
15173 @file{org-man.el}, that will add support for creating links like
15174 @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
15178 ;;; org-man.el - Support for links to manpages in Org
15182 (org-add-link-type "man" 'org-man-open)
15183 (add-hook 'org-store-link-functions 'org-man-store-link)
15185 (defcustom org-man-command 'man
15186 "The Emacs command to be used to display a man page."
15188 :type '(choice (const man) (const woman)))
15190 (defun org-man-open (path)
15191 "Visit the manpage on PATH.
15192 PATH should be a topic that can be thrown at the man command."
15193 (funcall org-man-command path))
15195 (defun org-man-store-link ()
15196 "Store a link to a manpage."
15197 (when (memq major-mode '(Man-mode woman-mode))
15198 ;; This is a man page, we do make this link
15199 (let* ((page (org-man-get-page-name))
15200 (link (concat "man:" page))
15201 (description (format "Manpage for %s" page)))
15202 (org-store-link-props
15205 :description description))))
15207 (defun org-man-get-page-name ()
15208 "Extract the page name from the buffer name."
15209 ;; This works for both `Man-mode' and `woman-mode'.
15210 (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
15211 (match-string 1 (buffer-name))
15212 (error "Cannot create link to this man page")))
15216 ;;; org-man.el ends here
15220 You would activate this new link type in @file{.emacs} with
15227 Let's go through the file and see what it does.
15230 It does @code{(require 'org)} to make sure that @file{org.el} has been
15233 The next line calls @code{org-add-link-type} to define a new link type
15234 with prefix @samp{man}. The call also contains the name of a function
15235 that will be called to follow such a link.
15237 @vindex org-store-link-functions
15238 The next line adds a function to @code{org-store-link-functions}, in
15239 order to allow the command @kbd{C-c l} to record a useful link in a
15240 buffer displaying a man page.
15243 The rest of the file defines the necessary variables and functions.
15244 First there is a customization variable that determines which Emacs
15245 command should be used to display man pages. There are two options,
15246 @code{man} and @code{woman}. Then the function to follow a link is
15247 defined. It gets the link path as an argument---in this case the link
15248 path is just a topic for the manual command. The function calls the
15249 value of @code{org-man-command} to display the man page.
15251 Finally the function @code{org-man-store-link} is defined. When you try
15252 to store a link with @kbd{C-c l}, this function will be called to
15253 try to make a link. The function must first decide if it is supposed to
15254 create the link for this buffer type; we do this by checking the value
15255 of the variable @code{major-mode}. If not, the function must exit and
15256 return the value @code{nil}. If yes, the link is created by getting the
15257 manual topic from the buffer name and prefixing it with the string
15258 @samp{man:}. Then it must call the command @code{org-store-link-props}
15259 and set the @code{:type} and @code{:link} properties. Optionally you
15260 can also set the @code{:description} property to provide a default for
15261 the link description when the link is later inserted into an Org
15262 buffer with @kbd{C-c C-l}.
15264 When it makes sense for your new link type, you may also define a function
15265 @code{org-PREFIX-complete-link} that implements special (e.g.@: completion)
15266 support for inserting such a link with @kbd{C-c C-l}. Such a function should
15267 not accept any arguments, and return the full link with prefix.
15269 @node Context-sensitive commands, Tables in arbitrary syntax, Adding hyperlink types, Hacking
15270 @section Context-sensitive commands
15271 @cindex context-sensitive commands, hooks
15272 @cindex add-ons, context-sensitive commands
15273 @vindex org-ctrl-c-ctrl-c-hook
15275 Org has several commands that act differently depending on context. The most
15276 important example is the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}).
15277 Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys have this property.
15279 Add-ons can tap into this functionality by providing a function that detects
15280 special context for that add-on and executes functionality appropriate for
15281 the context. Here is an example from Dan Davison's @file{org-R.el} which
15282 allows you to evaluate commands based on the @file{R} programming language
15283 @footnote{@file{org-R.el} has been replaced by the Org mode functionality
15284 described in @ref{Working With Source Code} and is now obsolete.}. For this
15285 package, special contexts are lines that start with @code{#+R:} or
15289 (defun org-R-apply-maybe ()
15290 "Detect if this is context for org-R and execute R commands."
15291 (if (save-excursion
15292 (beginning-of-line 1)
15293 (looking-at "#\\+RR?:"))
15294 (progn (call-interactively 'org-R-apply)
15295 t) ;; to signal that we took action
15296 nil)) ;; to signal that we did not
15298 (add-hook 'org-ctrl-c-ctrl-c-hook 'org-R-apply-maybe)
15301 The function first checks if the cursor is in such a line. If that is the
15302 case, @code{org-R-apply} is called and the function returns @code{t} to
15303 signal that action was taken, and @kbd{C-c C-c} will stop looking for other
15304 contexts. If the function finds it should do nothing locally, it returns
15305 @code{nil} so that other, similar functions can have a try.
15308 @node Tables in arbitrary syntax, Dynamic blocks, Context-sensitive commands, Hacking
15309 @section Tables and lists in arbitrary syntax
15310 @cindex tables, in other modes
15311 @cindex lists, in other modes
15312 @cindex Orgtbl mode
15314 Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
15315 frequent feature request has been to make it work with native tables in
15316 specific languages, for example @LaTeX{}. However, this is extremely
15317 hard to do in a general way, would lead to a customization nightmare,
15318 and would take away much of the simplicity of the Orgtbl mode table
15321 This appendix describes a different approach. We keep the Orgtbl mode
15322 table in its native format (the @i{source table}), and use a custom
15323 function to @i{translate} the table to the correct syntax, and to
15324 @i{install} it in the right location (the @i{target table}). This puts
15325 the burden of writing conversion functions on the user, but it allows
15326 for a very flexible system.
15328 Bastien added the ability to do the same with lists, in Orgstruct mode. You
15329 can use Org's facilities to edit and structure lists by turning
15330 @code{orgstruct-mode} on, then locally exporting such lists in another format
15331 (HTML, @LaTeX{} or Texinfo.)
15335 * Radio tables:: Sending and receiving radio tables
15336 * A @LaTeX{} example:: Step by step, almost a tutorial
15337 * Translator functions:: Copy and modify
15338 * Radio lists:: Doing the same for lists
15341 @node Radio tables, A @LaTeX{} example, Tables in arbitrary syntax, Tables in arbitrary syntax
15342 @subsection Radio tables
15343 @cindex radio tables
15345 To define the location of the target table, you first need to create two
15346 lines that are comments in the current mode, but contain magic words for
15347 Orgtbl mode to find. Orgtbl mode will insert the translated table
15348 between these lines, replacing whatever was there before. For example:
15351 /* BEGIN RECEIVE ORGTBL table_name */
15352 /* END RECEIVE ORGTBL table_name */
15356 Just above the source table, we put a special line that tells
15357 Orgtbl mode how to translate this table and where to install it. For
15361 #+ORGTBL: SEND table_name translation_function arguments....
15365 @code{table_name} is the reference name for the table that is also used
15366 in the receiver lines. @code{translation_function} is the Lisp function
15367 that does the translation. Furthermore, the line can contain a list of
15368 arguments (alternating key and value) at the end. The arguments will be
15369 passed as a property list to the translation function for
15370 interpretation. A few standard parameters are already recognized and
15371 acted upon before the translation function is called:
15375 Skip the first N lines of the table. Hlines do count as separate lines for
15378 @item :skipcols (n1 n2 ...)
15379 List of columns that should be skipped. If the table has a column with
15380 calculation marks, that column is automatically discarded as well.
15381 Please note that the translator function sees the table @emph{after} the
15382 removal of these columns, the function never knows that there have been
15383 additional columns.
15387 The one problem remaining is how to keep the source table in the buffer
15388 without disturbing the normal workings of the file, for example during
15389 compilation of a C file or processing of a @LaTeX{} file. There are a
15390 number of different solutions:
15394 The table could be placed in a block comment if that is supported by the
15395 language. For example, in C mode you could wrap the table between
15396 @samp{/*} and @samp{*/} lines.
15398 Sometimes it is possible to put the table after some kind of @i{END}
15399 statement, for example @samp{\bye} in @TeX{} and @samp{\end@{document@}}
15402 You can just comment the table line-by-line whenever you want to process
15403 the file, and uncomment it whenever you need to edit the table. This
15404 only sounds tedious---the command @kbd{M-x orgtbl-toggle-comment}
15405 makes this comment-toggling very easy, in particular if you bind it to a
15409 @node A @LaTeX{} example, Translator functions, Radio tables, Tables in arbitrary syntax
15410 @subsection A @LaTeX{} example of radio tables
15411 @cindex @LaTeX{}, and Orgtbl mode
15413 The best way to wrap the source table in @LaTeX{} is to use the
15414 @code{comment} environment provided by @file{comment.sty}. It has to be
15415 activated by placing @code{\usepackage@{comment@}} into the document
15416 header. Orgtbl mode can insert a radio table skeleton@footnote{By
15417 default this works only for @LaTeX{}, HTML, and Texinfo. Configure the
15418 variable @code{orgtbl-radio-tables} to install templates for other
15419 modes.} with the command @kbd{M-x orgtbl-insert-radio-table}. You will
15420 be prompted for a table name, let's say we use @samp{salesfigures}. You
15421 will then get the following template:
15423 @cindex #+ORGTBL, SEND
15425 % BEGIN RECEIVE ORGTBL salesfigures
15426 % END RECEIVE ORGTBL salesfigures
15428 #+ORGTBL: SEND salesfigures orgtbl-to-latex
15434 @vindex @LaTeX{}-verbatim-environments
15435 The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
15436 @code{orgtbl-to-latex} to convert the table into @LaTeX{} and to put it
15437 into the receiver location with name @code{salesfigures}. You may now
15438 fill in the table---feel free to use the spreadsheet features@footnote{If
15439 the @samp{#+TBLFM} line contains an odd number of dollar characters,
15440 this may cause problems with font-lock in @LaTeX{} mode. As shown in the
15441 example you can fix this by adding an extra line inside the
15442 @code{comment} environment that is used to balance the dollar
15443 expressions. If you are using AUC@TeX{} with the font-latex library, a
15444 much better solution is to add the @code{comment} environment to the
15445 variable @code{LaTeX-verbatim-environments}.}:
15448 % BEGIN RECEIVE ORGTBL salesfigures
15449 % END RECEIVE ORGTBL salesfigures
15451 #+ORGTBL: SEND salesfigures orgtbl-to-latex
15452 | Month | Days | Nr sold | per day |
15453 |-------+------+---------+---------|
15454 | Jan | 23 | 55 | 2.4 |
15455 | Feb | 21 | 16 | 0.8 |
15456 | March | 22 | 278 | 12.6 |
15457 #+TBLFM: $4=$3/$2;%.1f
15458 % $ (optional extra dollar to keep font-lock happy, see footnote)
15463 When you are done, press @kbd{C-c C-c} in the table to get the converted
15464 table inserted between the two marker lines.
15466 Now let's assume you want to make the table header by hand, because you
15467 want to control how columns are aligned, etc@. In this case we make sure
15468 that the table translator skips the first 2 lines of the source
15469 table, and tell the command to work as a @i{splice}, i.e.@: to not produce
15470 header and footer commands of the target table:
15473 \begin@{tabular@}@{lrrr@}
15474 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
15475 % BEGIN RECEIVE ORGTBL salesfigures
15476 % END RECEIVE ORGTBL salesfigures
15480 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
15481 | Month | Days | Nr sold | per day |
15482 |-------+------+---------+---------|
15483 | Jan | 23 | 55 | 2.4 |
15484 | Feb | 21 | 16 | 0.8 |
15485 | March | 22 | 278 | 12.6 |
15486 #+TBLFM: $4=$3/$2;%.1f
15490 The @LaTeX{} translator function @code{orgtbl-to-latex} is already part of
15491 Orgtbl mode. It uses a @code{tabular} environment to typeset the table
15492 and marks horizontal lines with @code{\hline}. Furthermore, it
15493 interprets the following parameters (see also @pxref{Translator functions}):
15496 @item :splice nil/t
15497 When set to t, return only table body lines, don't wrap them into a
15498 tabular environment. Default is nil.
15501 A format to be used to wrap each field, it should contain @code{%s} for the
15502 original field value. For example, to wrap each field value in dollars,
15503 you could use @code{:fmt "$%s$"}. This may also be a property list with
15504 column numbers and formats, for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
15505 A function of one argument can be used in place of the strings; the
15506 function must return a formatted string.
15509 Use this format to print numbers with exponentials. The format should
15510 have @code{%s} twice for inserting mantissa and exponent, for example
15511 @code{"%s\\times10^@{%s@}"}. The default is @code{"%s\\,(%s)"}. This
15512 may also be a property list with column numbers and formats, for example
15513 @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After
15514 @code{efmt} has been applied to a value, @code{fmt} will also be
15515 applied. Similar to @code{fmt}, functions of two arguments can be
15516 supplied instead of strings.
15519 @node Translator functions, Radio lists, A @LaTeX{} example, Tables in arbitrary syntax
15520 @subsection Translator functions
15521 @cindex HTML, and Orgtbl mode
15522 @cindex translator function
15524 Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
15525 (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
15526 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and @code{orgtbl-to-texinfo}.
15527 Except for @code{orgtbl-to-html}@footnote{The HTML translator uses the same
15528 code that produces tables during HTML export.}, these all use a generic
15529 translator, @code{orgtbl-to-generic}. For example, @code{orgtbl-to-latex}
15530 itself is a very short function that computes the column definitions for the
15531 @code{tabular} environment, defines a few field and line separators and then
15532 hands processing over to the generic translator. Here is the entire code:
15536 (defun orgtbl-to-latex (table params)
15537 "Convert the Orgtbl mode TABLE to LaTeX."
15538 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
15539 org-table-last-alignment ""))
15542 :tstart (concat "\\begin@{tabular@}@{" alignment "@}")
15543 :tend "\\end@{tabular@}"
15544 :lstart "" :lend " \\\\" :sep " & "
15545 :efmt "%s\\,(%s)" :hline "\\hline")))
15546 (orgtbl-to-generic table (org-combine-plists params2 params))))
15550 As you can see, the properties passed into the function (variable
15551 @var{PARAMS}) are combined with the ones newly defined in the function
15552 (variable @var{PARAMS2}). The ones passed into the function (i.e.@: the
15553 ones set by the @samp{ORGTBL SEND} line) take precedence. So if you
15554 would like to use the @LaTeX{} translator, but wanted the line endings to
15555 be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
15556 overrule the default with
15559 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
15562 For a new language, you can either write your own converter function in
15563 analogy with the @LaTeX{} translator, or you can use the generic function
15564 directly. For example, if you have a language where a table is started
15565 with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are
15566 started with @samp{!BL!}, ended with @samp{!EL!}, and where the field
15567 separator is a TAB, you could call the generic translator like this (on
15571 #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
15572 :lstart "!BL! " :lend " !EL!" :sep "\t"
15576 Please check the documentation string of the function
15577 @code{orgtbl-to-generic} for a full list of parameters understood by
15578 that function, and remember that you can pass each of them into
15579 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
15580 using the generic function.
15582 Of course you can also write a completely new function doing complicated
15583 things the generic translator cannot do. A translator function takes
15584 two arguments. The first argument is the table, a list of lines, each
15585 line either the symbol @code{hline} or a list of fields. The second
15586 argument is the property list containing all parameters specified in the
15587 @samp{#+ORGTBL: SEND} line. The function must return a single string
15588 containing the formatted table. If you write a generally useful
15589 translator, please post it on @email{emacs-orgmode@@gnu.org} so that
15590 others can benefit from your work.
15592 @node Radio lists, , Translator functions, Tables in arbitrary syntax
15593 @subsection Radio lists
15594 @cindex radio lists
15595 @cindex org-list-insert-radio-list
15597 Sending and receiving radio lists works exactly the same way as sending and
15598 receiving radio tables (@pxref{Radio tables}). As for radio tables, you can
15599 insert radio list templates in HTML, @LaTeX{} and Texinfo modes by calling
15600 @code{org-list-insert-radio-list}.
15602 Here are the differences with radio tables:
15606 Orgstruct mode must be active.
15608 Use the @code{ORGLST} keyword instead of @code{ORGTBL}.
15610 The available translation functions for radio lists don't take
15613 @kbd{C-c C-c} will work when pressed on the first item of the list.
15616 Here is a @LaTeX{} example. Let's say that you have this in your
15621 % BEGIN RECEIVE ORGLST to-buy
15622 % END RECEIVE ORGLST to-buy
15624 #+ORGLST: SEND to-buy org-list-to-latex
15633 Pressing `C-c C-c' on @code{a new house} and will insert the converted
15634 @LaTeX{} list between the two marker lines.
15636 @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Hacking
15637 @section Dynamic blocks
15638 @cindex dynamic blocks
15640 Org documents can contain @emph{dynamic blocks}. These are
15641 specially marked regions that are updated by some user-written function.
15642 A good example for such a block is the clock table inserted by the
15643 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
15645 Dynamic blocks are enclosed by a BEGIN-END structure that assigns a name
15646 to the block and can also specify parameters for the function producing
15647 the content of the block.
15649 @cindex #+BEGIN:dynamic block
15651 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
15656 Dynamic blocks are updated with the following commands
15659 @orgcmd{C-c C-x C-u,org-dblock-update}
15660 Update dynamic block at point.
15661 @orgkey{C-u C-c C-x C-u}
15662 Update all dynamic blocks in the current file.
15665 Updating a dynamic block means to remove all the text between BEGIN and
15666 END, parse the BEGIN line for parameters and then call the specific
15667 writer function for this block to insert the new content. If you want
15668 to use the original content in the writer function, you can use the
15669 extra parameter @code{:content}.
15671 For a block with name @code{myblock}, the writer function is
15672 @code{org-dblock-write:myblock} with as only parameter a property list
15673 with the parameters given in the begin line. Here is a trivial example
15674 of a block that keeps track of when the block update function was last
15678 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
15684 The corresponding block writer function could look like this:
15687 (defun org-dblock-write:block-update-time (params)
15688 (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
15689 (insert "Last block update at: "
15690 (format-time-string fmt (current-time)))))
15693 If you want to make sure that all dynamic blocks are always up-to-date,
15694 you could add the function @code{org-update-all-dblocks} to a hook, for
15695 example @code{before-save-hook}. @code{org-update-all-dblocks} is
15696 written in a way such that it does nothing in buffers that are not in
15699 You can narrow the current buffer to the current dynamic block (like any
15700 other block) with @code{org-narrow-to-block}.
15702 @node Special agenda views, Extracting agenda information, Dynamic blocks, Hacking
15703 @section Special agenda views
15704 @cindex agenda views, user-defined
15706 @vindex org-agenda-skip-function
15707 @vindex org-agenda-skip-function-global
15708 Org provides a special hook that can be used to narrow down the selection
15709 made by these agenda views: @code{agenda}, @code{todo}, @code{alltodo},
15710 @code{tags}, @code{tags-todo}, @code{tags-tree}. You may specify a function
15711 that is used at each match to verify if the match should indeed be part of
15712 the agenda view, and if not, how much should be skipped. You can specify a
15713 global condition that will be applied to all agenda views, this condition
15714 would be stored in the variable @code{org-agenda-skip-function-global}. More
15715 commonly, such a definition is applied only to specific custom searches,
15716 using @code{org-agenda-skip-function}.
15718 Let's say you want to produce a list of projects that contain a WAITING
15719 tag anywhere in the project tree. Let's further assume that you have
15720 marked all tree headings that define a project with the TODO keyword
15721 PROJECT. In this case you would run a TODO search for the keyword
15722 PROJECT, but skip the match unless there is a WAITING tag anywhere in
15723 the subtree belonging to the project line.
15725 To achieve this, you must write a function that searches the subtree for
15726 the tag. If the tag is found, the function must return @code{nil} to
15727 indicate that this match should not be skipped. If there is no such
15728 tag, return the location of the end of the subtree, to indicate that
15729 search should continue from there.
15732 (defun my-skip-unless-waiting ()
15733 "Skip trees that are not waiting"
15734 (let ((subtree-end (save-excursion (org-end-of-subtree t))))
15735 (if (re-search-forward ":waiting:" subtree-end t)
15736 nil ; tag found, do not skip
15737 subtree-end))) ; tag not found, continue after end of subtree
15740 Now you may use this function in an agenda custom command, for example
15744 (org-add-agenda-custom-command
15745 '("b" todo "PROJECT"
15746 ((org-agenda-skip-function 'my-skip-unless-waiting)
15747 (org-agenda-overriding-header "Projects waiting for something: "))))
15750 @vindex org-agenda-overriding-header
15751 Note that this also binds @code{org-agenda-overriding-header} to get a
15752 meaningful header in the agenda view.
15754 @vindex org-odd-levels-only
15755 @vindex org-agenda-skip-function
15756 A general way to create custom searches is to base them on a search for
15757 entries with a certain level limit. If you want to study all entries with
15758 your custom search function, simply do a search for
15759 @samp{LEVEL>0}@footnote{Note that, when using @code{org-odd-levels-only}, a
15760 level number corresponds to order in the hierarchy, not to the number of
15761 stars.}, and then use @code{org-agenda-skip-function} to select the entries
15762 you really want to have.
15764 You may also put a Lisp form into @code{org-agenda-skip-function}. In
15765 particular, you may use the functions @code{org-agenda-skip-entry-if}
15766 and @code{org-agenda-skip-subtree-if} in this form, for example:
15769 @item (org-agenda-skip-entry-if 'scheduled)
15770 Skip current entry if it has been scheduled.
15771 @item (org-agenda-skip-entry-if 'notscheduled)
15772 Skip current entry if it has not been scheduled.
15773 @item (org-agenda-skip-entry-if 'deadline)
15774 Skip current entry if it has a deadline.
15775 @item (org-agenda-skip-entry-if 'scheduled 'deadline)
15776 Skip current entry if it has a deadline, or if it is scheduled.
15777 @item (org-agenda-skip-entry-if 'todo '("TODO" "WAITING"))
15778 Skip current entry if the TODO keyword is TODO or WAITING.
15779 @item (org-agenda-skip-entry-if 'todo 'done)
15780 Skip current entry if the TODO keyword marks a DONE state.
15781 @item (org-agenda-skip-entry-if 'timestamp)
15782 Skip current entry if it has any timestamp, may also be deadline or scheduled.
15783 @item (org-agenda-skip-entry 'regexp "regular expression")
15784 Skip current entry if the regular expression matches in the entry.
15785 @item (org-agenda-skip-entry 'notregexp "regular expression")
15786 Skip current entry unless the regular expression matches.
15787 @item (org-agenda-skip-subtree-if 'regexp "regular expression")
15788 Same as above, but check and skip the entire subtree.
15791 Therefore we could also have written the search for WAITING projects
15792 like this, even without defining a special function:
15795 (org-add-agenda-custom-command
15796 '("b" todo "PROJECT"
15797 ((org-agenda-skip-function '(org-agenda-skip-subtree-if
15798 'regexp ":waiting:"))
15799 (org-agenda-overriding-header "Projects waiting for something: "))))
15802 @node Extracting agenda information, Using the property API, Special agenda views, Hacking
15803 @section Extracting agenda information
15804 @cindex agenda, pipe
15805 @cindex Scripts, for agenda processing
15807 @vindex org-agenda-custom-commands
15808 Org provides commands to access agenda information for the command
15809 line in Emacs batch mode. This extracted information can be sent
15810 directly to a printer, or it can be read by a program that does further
15811 processing of the data. The first of these commands is the function
15812 @code{org-batch-agenda}, that produces an agenda view and sends it as
15813 ASCII text to STDOUT. The command takes a single string as parameter.
15814 If the string has length 1, it is used as a key to one of the commands
15815 you have configured in @code{org-agenda-custom-commands}, basically any
15816 key you can use after @kbd{C-c a}. For example, to directly print the
15817 current TODO list, you could use
15820 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
15823 If the parameter is a string with 2 or more characters, it is used as a
15824 tags/TODO match string. For example, to print your local shopping list
15825 (all items with the tag @samp{shop}, but excluding the tag
15826 @samp{NewYork}), you could use
15829 emacs -batch -l ~/.emacs \
15830 -eval '(org-batch-agenda "+shop-NewYork")' | lpr
15834 You may also modify parameters on the fly like this:
15837 emacs -batch -l ~/.emacs \
15838 -eval '(org-batch-agenda "a" \
15839 org-agenda-span (quote month) \
15840 org-agenda-include-diary nil \
15841 org-agenda-files (quote ("~/org/project.org")))' \
15846 which will produce a 30-day agenda, fully restricted to the Org file
15847 @file{~/org/projects.org}, not even including the diary.
15849 If you want to process the agenda data in more sophisticated ways, you
15850 can use the command @code{org-batch-agenda-csv} to get a comma-separated
15851 list of values for each agenda item. Each line in the output will
15852 contain a number of fields separated by commas. The fields in a line
15856 category @r{The category of the item}
15857 head @r{The headline, without TODO keyword, TAGS and PRIORITY}
15858 type @r{The type of the agenda entry, can be}
15859 todo @r{selected in TODO match}
15860 tagsmatch @r{selected in tags match}
15861 diary @r{imported from diary}
15862 deadline @r{a deadline}
15863 scheduled @r{scheduled}
15864 timestamp @r{appointment, selected by timestamp}
15865 closed @r{entry was closed on date}
15866 upcoming-deadline @r{warning about nearing deadline}
15867 past-scheduled @r{forwarded scheduled item}
15868 block @r{entry has date block including date}
15869 todo @r{The TODO keyword, if any}
15870 tags @r{All tags including inherited ones, separated by colons}
15871 date @r{The relevant date, like 2007-2-14}
15872 time @r{The time, like 15:00-16:50}
15873 extra @r{String with extra planning info}
15874 priority-l @r{The priority letter if any was given}
15875 priority-n @r{The computed numerical priority}
15879 Time and date will only be given if a timestamp (or deadline/scheduled)
15880 led to the selection of the item.
15882 A CSV list like this is very easy to use in a post-processing script.
15883 For example, here is a Perl program that gets the TODO list from
15884 Emacs/Org and prints all the items, preceded by a checkbox:
15889 # define the Emacs command to run
15890 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
15892 # run it and capture the output
15893 $agenda = qx@{$cmd 2>/dev/null@};
15895 # loop over all lines
15896 foreach $line (split(/\n/,$agenda)) @{
15897 # get the individual values
15898 ($category,$head,$type,$todo,$tags,$date,$time,$extra,
15899 $priority_l,$priority_n) = split(/,/,$line);
15900 # process and print
15901 print "[ ] $head\n";
15905 @node Using the property API, Using the mapping API, Extracting agenda information, Hacking
15906 @section Using the property API
15907 @cindex API, for properties
15908 @cindex properties, API
15910 Here is a description of the functions that can be used to work with
15913 @defun org-entry-properties &optional pom which
15914 Get all properties of the entry at point-or-marker POM.@*
15915 This includes the TODO keyword, the tags, time strings for deadline,
15916 scheduled, and clocking, and any additional properties defined in the
15917 entry. The return value is an alist. Keys may occur multiple times
15918 if the property key was used several times.@*
15919 POM may also be nil, in which case the current entry is used.
15920 If WHICH is nil or `all', get all properties. If WHICH is
15921 `special' or `standard', only get that subclass.
15923 @vindex org-use-property-inheritance
15924 @findex org-insert-property-drawer
15925 @defun org-entry-get pom property &optional inherit
15926 Get value of PROPERTY for entry at point-or-marker POM. By default,
15927 this only looks at properties defined locally in the entry. If INHERIT
15928 is non-nil and the entry does not have the property, then also check
15929 higher levels of the hierarchy. If INHERIT is the symbol
15930 @code{selective}, use inheritance if and only if the setting of
15931 @code{org-use-property-inheritance} selects PROPERTY for inheritance.
15934 @defun org-entry-delete pom property
15935 Delete the property PROPERTY from entry at point-or-marker POM.
15938 @defun org-entry-put pom property value
15939 Set PROPERTY to VALUE for entry at point-or-marker POM.
15942 @defun org-buffer-property-keys &optional include-specials
15943 Get all property keys in the current buffer.
15946 @defun org-insert-property-drawer
15947 Insert a property drawer for the current entry. Also
15950 @defun org-entry-put-multivalued-property pom property &rest values
15951 Set PROPERTY at point-or-marker POM to VALUES. VALUES should be a list of
15952 strings. They will be concatenated, with spaces as separators.
15955 @defun org-entry-get-multivalued-property pom property
15956 Treat the value of the property PROPERTY as a whitespace-separated list of
15957 values and return the values as a list of strings.
15960 @defun org-entry-add-to-multivalued-property pom property value
15961 Treat the value of the property PROPERTY as a whitespace-separated list of
15962 values and make sure that VALUE is in this list.
15965 @defun org-entry-remove-from-multivalued-property pom property value
15966 Treat the value of the property PROPERTY as a whitespace-separated list of
15967 values and make sure that VALUE is @emph{not} in this list.
15970 @defun org-entry-member-in-multivalued-property pom property value
15971 Treat the value of the property PROPERTY as a whitespace-separated list of
15972 values and check if VALUE is in this list.
15975 @defopt org-property-allowed-value-functions
15976 Hook for functions supplying allowed values for a specific property.
15977 The functions must take a single argument, the name of the property, and
15978 return a flat list of allowed values. If @samp{:ETC} is one of
15979 the values, use the values as completion help, but allow also other values
15980 to be entered. The functions must return @code{nil} if they are not
15981 responsible for this property.
15984 @node Using the mapping API, , Using the property API, Hacking
15985 @section Using the mapping API
15986 @cindex API, for mapping
15987 @cindex mapping entries, API
15989 Org has sophisticated mapping capabilities to find all entries satisfying
15990 certain criteria. Internally, this functionality is used to produce agenda
15991 views, but there is also an API that can be used to execute arbitrary
15992 functions for each or selected entries. The main entry point for this API
15995 @defun org-map-entries func &optional match scope &rest skip
15996 Call FUNC at each headline selected by MATCH in SCOPE.
15998 FUNC is a function or a Lisp form. The function will be called without
15999 arguments, with the cursor positioned at the beginning of the headline.
16000 The return values of all calls to the function will be collected and
16001 returned as a list.
16003 The call to FUNC will be wrapped into a save-excursion form, so FUNC
16004 does not need to preserve point. After evaluation, the cursor will be
16005 moved to the end of the line (presumably of the headline of the
16006 processed entry) and search continues from there. Under some
16007 circumstances, this may not produce the wanted results. For example,
16008 if you have removed (e.g.@: archived) the current (sub)tree it could
16009 mean that the next entry will be skipped entirely. In such cases, you
16010 can specify the position from where search should continue by making
16011 FUNC set the variable `org-map-continue-from' to the desired buffer
16014 MATCH is a tags/property/todo match as it is used in the agenda match view.
16015 Only headlines that are matched by this query will be considered during
16016 the iteration. When MATCH is nil or t, all headlines will be
16017 visited by the iteration.
16019 SCOPE determines the scope of this command. It can be any of:
16022 nil @r{the current buffer, respecting the restriction if any}
16023 tree @r{the subtree started with the entry at point}
16024 region @r{The entries within the active region, if any}
16025 file @r{the current buffer, without restriction}
16027 @r{the current buffer, and any archives associated with it}
16028 agenda @r{all agenda files}
16029 agenda-with-archives
16030 @r{all agenda files with any archive files associated with them}
16032 @r{if this is a list, all files in the list will be scanned}
16035 The remaining args are treated as settings for the skipping facilities of
16036 the scanner. The following items can be given here:
16038 @vindex org-agenda-skip-function
16040 archive @r{skip trees with the archive tag}
16041 comment @r{skip trees with the COMMENT keyword}
16042 function or Lisp form
16043 @r{will be used as value for @code{org-agenda-skip-function},}
16044 @r{so whenever the function returns t, FUNC}
16045 @r{will not be called for that entry and search will}
16046 @r{continue from the point where the function leaves it}
16050 The function given to that mapping routine can really do anything you like.
16051 It can use the property API (@pxref{Using the property API}) to gather more
16052 information about the entry, or in order to change metadata in the entry.
16053 Here are a couple of functions that might be handy:
16055 @defun org-todo &optional arg
16056 Change the TODO state of the entry. See the docstring of the functions for
16057 the many possible values for the argument ARG.
16060 @defun org-priority &optional action
16061 Change the priority of the entry. See the docstring of this function for the
16062 possible values for ACTION.
16065 @defun org-toggle-tag tag &optional onoff
16066 Toggle the tag TAG in the current entry. Setting ONOFF to either @code{on}
16067 or @code{off} will not toggle tag, but ensure that it is either on or off.
16071 Promote the current entry.
16075 Demote the current entry.
16078 Here is a simple example that will turn all entries in the current file with
16079 a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
16080 Entries in comment trees and in archive trees will be ignored.
16084 '(org-todo "UPCOMING")
16085 "+TOMORROW" 'file 'archive 'comment)
16088 The following example counts the number of entries with TODO keyword
16089 @code{WAITING}, in all agenda files.
16092 (length (org-map-entries t "/+WAITING" 'agenda))
16095 @node MobileOrg, History and Acknowledgments, Hacking, Top
16096 @appendix MobileOrg
16100 @uref{http://mobileorg.ncogni.to/, MobileOrg} is an application for the
16101 @i{iPhone/iPod Touch} series of devices, developed by Richard Moreland.
16102 @i{MobileOrg} offers offline viewing and capture support for an Org mode
16103 system rooted on a ``real'' computer. It does also allow you to record
16104 changes to existing entries. Android users should check out
16105 @uref{http://wiki.github.com/matburt/mobileorg-android/, MobileOrg Android}
16108 This appendix describes the support Org has for creating agenda views in a
16109 format that can be displayed by @i{MobileOrg}, and for integrating notes
16110 captured and changes made by @i{MobileOrg} into the main system.
16112 For changing tags and TODO states in MobileOrg, you should have set up the
16113 customization variables @code{org-todo-keywords} and @code{org-tags-alist} to
16114 cover all important tags and TODO keywords, even if individual files use only
16115 part of these. MobileOrg will also offer you states and tags set up with
16116 in-buffer settings, but it will understand the logistics of TODO state
16117 @i{sets} (@pxref{Per-file keywords}) and @i{mutually exclusive} tags
16118 (@pxref{Setting tags}) only for those set in these variables.
16121 * Setting up the staging area:: Where to interact with the mobile device
16122 * Pushing to MobileOrg:: Uploading Org files and agendas
16123 * Pulling from MobileOrg:: Integrating captured and flagged items
16126 @node Setting up the staging area, Pushing to MobileOrg, MobileOrg, MobileOrg
16127 @section Setting up the staging area
16129 MobileOrg needs to interact with Emacs through a directory on a server. If you
16130 are using a public server, you should consider to encrypt the files that are
16131 uploaded to the server. This can be done with Org mode 7.02 and with
16132 @i{MobileOrg 1.5} (iPhone version), and you need an @file{openssl}
16133 installation on your system. To turn on encryption, set a password in
16134 @i{MobileOrg} and, on the Emacs side, configure the variable
16135 @code{org-mobile-use-encryption}@footnote{If you can safely store the
16136 password in your Emacs setup, you might also want to configure
16137 @code{org-mobile-encryption-password}. Please read the docstring of that
16138 variable. Note that encryption will apply only to the contents of the
16139 @file{.org} files. The file names themselves will remain visible.}.
16141 The easiest way to create that directory is to use a free
16142 @uref{http://dropbox.com,Dropbox.com} account@footnote{If you cannot use
16143 Dropbox, or if your version of MobileOrg does not support it, you can use a
16144 webdav server. For more information, check out the documentation of MobileOrg and also this
16145 @uref{http://orgmode.org/worg/org-faq.html#mobileorg_webdav, FAQ entry}.}.
16146 When MobileOrg first connects to your Dropbox, it will create a directory
16147 @i{MobileOrg} inside the Dropbox. After the directory has been created, tell
16151 (setq org-mobile-directory "~/Dropbox/MobileOrg")
16154 Org mode has commands to put files for @i{MobileOrg} into that directory,
16155 and to read captured notes from there.
16157 @node Pushing to MobileOrg, Pulling from MobileOrg, Setting up the staging area, MobileOrg
16158 @section Pushing to MobileOrg
16160 This operation copies all files currently listed in @code{org-mobile-files}
16161 to the directory @code{org-mobile-directory}. By default this list contains
16162 all agenda files (as listed in @code{org-agenda-files}), but additional files
16163 can be included by customizing @code{org-mobile-files}. File names will be
16164 staged with paths relative to @code{org-directory}, so all files should be
16165 inside this directory. The push operation also creates a special Org file
16166 @file{agendas.org} with all custom agenda view defined by the
16167 user@footnote{While creating the agendas, Org mode will force ID properties
16168 on all referenced entries, so that these entries can be uniquely identified
16169 if @i{MobileOrg} flags them for further action. If you do not want to get
16170 these properties in so many entries, you can set the variable
16171 @code{org-mobile-force-id-on-agenda-items} to @code{nil}. Org mode will then
16172 rely on outline paths, in the hope that these will be unique enough.}.
16173 Finally, Org writes the file @file{index.org}, containing links to all other
16174 files. @i{MobileOrg} first reads this file from the server, and then
16175 downloads all agendas and Org files listed in it. To speed up the download,
16176 MobileOrg will only read files whose checksums@footnote{stored automatically
16177 in the file @file{checksums.dat}} have changed.
16179 @node Pulling from MobileOrg, , Pushing to MobileOrg, MobileOrg
16180 @section Pulling from MobileOrg
16182 When @i{MobileOrg} synchronizes with the server, it not only pulls the Org
16183 files for viewing. It also appends captured entries and pointers to flagged
16184 and changed entries to the file @file{mobileorg.org} on the server. Org has
16185 a @emph{pull} operation that integrates this information into an inbox file
16186 and operates on the pointers to flagged entries. Here is how it works:
16190 Org moves all entries found in
16191 @file{mobileorg.org}@footnote{@file{mobileorg.org} will be empty after this
16192 operation.} and appends them to the file pointed to by the variable
16193 @code{org-mobile-inbox-for-pull}. Each captured entry and each editing event
16194 will be a top-level entry in the inbox file.
16196 After moving the entries, Org will attempt to implement the changes made in
16197 @i{MobileOrg}. Some changes are applied directly and without user
16198 interaction. Examples are all changes to tags, TODO state, headline and body
16199 text that can be cleanly applied. Entries that have been flagged for further
16200 action will receive a tag @code{:FLAGGED:}, so that they can be easily found
16201 again. When there is a problem finding an entry or applying the change, the
16202 pointer entry will remain in the inbox and will be marked with an error
16203 message. You need to later resolve these issues by hand.
16205 Org will then generate an agenda view with all flagged entries. The user
16206 should then go through these entries and do whatever actions are necessary.
16207 If a note has been stored while flagging an entry in @i{MobileOrg}, that note
16208 will be displayed in the echo area when the cursor is on the corresponding
16213 Pressing @kbd{?} in that special agenda will display the full flagging note in
16214 another window and also push it onto the kill ring. So you could use @kbd{?
16215 z C-y C-c C-c} to store that flagging note as a normal note in the entry.
16216 Pressing @kbd{?} twice in succession will offer to remove the
16217 @code{:FLAGGED:} tag along with the recorded flagging note (which is stored
16218 in a property). In this way you indicate that the intended processing for
16219 this flagged entry is finished.
16224 If you are not able to process all flagged entries directly, you can always
16225 return to this agenda view@footnote{Note, however, that there is a subtle
16226 difference. The view created automatically by @kbd{M-x org-mobile-pull
16227 @key{RET}} is guaranteed to search all files that have been addressed by the
16228 last pull. This might include a file that is not currently in your list of
16229 agenda files. If you later use @kbd{C-c a ?} to regenerate the view, only
16230 the current agenda files will be searched.} using @kbd{C-c a ?}.
16232 @node History and Acknowledgments, Main Index, MobileOrg, Top
16233 @appendix History and acknowledgments
16234 @cindex acknowledgments
16238 Org was born in 2003, out of frustration over the user interface of the Emacs
16239 Outline mode. I was trying to organize my notes and projects, and using
16240 Emacs seemed to be the natural way to go. However, having to remember eleven
16241 different commands with two or three keys per command, only to hide and show
16242 parts of the outline tree, that seemed entirely unacceptable to me. Also,
16243 when using outlines to take notes, I constantly wanted to restructure the
16244 tree, organizing it parallel to my thoughts and plans. @emph{Visibility
16245 cycling} and @emph{structure editing} were originally implemented in the
16246 package @file{outline-magic.el}, but quickly moved to the more general
16247 @file{org.el}. As this environment became comfortable for project planning,
16248 the next step was adding @emph{TODO entries}, basic @emph{timestamps}, and
16249 @emph{table support}. These areas highlighted the two main goals that Org
16250 still has today: to be a new, outline-based, plain text mode with innovative
16251 and intuitive editing features, and to incorporate project planning
16252 functionality directly into a notes file.
16254 Since the first release, literally thousands of emails to me or to
16255 @email{emacs-orgmode@@gnu.org} have provided a constant stream of bug
16256 reports, feedback, new ideas, and sometimes patches and add-on code.
16257 Many thanks to everyone who has helped to improve this package. I am
16258 trying to keep here a list of the people who had significant influence
16259 in shaping one or more aspects of Org. The list may not be
16260 complete, if I have forgotten someone, please accept my apologies and
16263 Before I get to this list, a few special mentions are in order:
16266 @item Bastien Guerry
16267 Bastien has written a large number of extensions to Org (most of them
16268 integrated into the core by now), including the @LaTeX{} exporter and the plain
16269 list parser. His support during the early days, when he basically acted as
16270 co-maintainer, was central to the success of this project. Bastien also
16271 invented Worg, helped establishing the Web presence of Org, and sponsors
16272 hosting costs for the orgmode.org website.
16273 @item Eric Schulte and Dan Davison
16274 Eric and Dan are jointly responsible for the Org-babel system, which turns
16275 Org into a multi-language environment for evaluating code and doing literate
16276 programming and reproducible research.
16278 John has contributed a number of great ideas and patches directly to Org,
16279 including the attachment system (@file{org-attach.el}), integration with
16280 Apple Mail (@file{org-mac-message.el}), hierarchical dependencies of TODO
16281 items, habit tracking (@file{org-habits.el}), and encryption
16282 (@file{org-crypt.el}). Also, the capture system is really an extended copy
16283 of his great @file{remember.el}.
16284 @item Sebastian Rose
16285 Without Sebastian, the HTML/XHTML publishing of Org would be the pitiful work
16286 of an ignorant amateur. Sebastian has pushed this part of Org onto a much
16287 higher level. He also wrote @file{org-info.js}, a Java script for displaying
16288 webpages derived from Org using an Info-like or a folding interface with
16289 single-key navigation.
16292 @noindent OK, now to the full list of contributions! Again, please let me
16293 know what I am missing here!
16298 @i{Russel Adams} came up with the idea for drawers.
16300 @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
16302 @i{Christophe Bataillon} created the great unicorn logo that we use on the
16305 @i{Alex Bochannek} provided a patch for rounding timestamps.
16307 @i{Jan Böcker} wrote @file{org-docview.el}.
16309 @i{Brad Bozarth} showed how to pull RSS feed data into Org mode files.
16311 @i{Tom Breton} wrote @file{org-choose.el}.
16313 @i{Charles Cave}'s suggestion sparked the implementation of templates
16314 for Remember, which are now templates for capture.
16316 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
16319 @i{Gregory Chernov} patched support for Lisp forms into table
16320 calculations and improved XEmacs compatibility, in particular by porting
16321 @file{nouline.el} to XEmacs.
16323 @i{Sacha Chua} suggested copying some linking code from Planner.
16325 @i{Baoqiu Cui} contributed the DocBook exporter.
16327 @i{Eddward DeVilla} proposed and tested checkbox statistics. He also
16328 came up with the idea of properties, and that there should be an API for
16331 @i{Nick Dokos} tracked down several nasty bugs.
16333 @i{Kees Dullemond} used to edit projects lists directly in HTML and so
16334 inspired some of the early development, including HTML export. He also
16335 asked for a way to narrow wide table columns.
16337 @i{Thomas S. Dye} contributed documentation on Worg and helped integrating
16338 the Org-Babel documentation into the manual.
16340 @i{Christian Egli} converted the documentation into Texinfo format, inspired
16341 the agenda, patched CSS formatting into the HTML exporter, and wrote
16342 @file{org-taskjuggler.el}.
16344 @i{David Emery} provided a patch for custom CSS support in exported
16347 @i{Nic Ferrier} contributed mailcap and XOXO support.
16349 @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
16351 @i{John Foerch} figured out how to make incremental search show context
16352 around a match in a hidden outline tree.
16354 @i{Raimar Finken} wrote @file{org-git-line.el}.
16356 @i{Mikael Fornius} works as a mailing list moderator.
16358 @i{Austin Frank} works as a mailing list moderator.
16360 @i{Eric Fraga} drove the development of BEAMER export with ideas and
16363 @i{Barry Gidden} did proofreading the manual in preparation for the book
16364 publication through Network Theory Ltd.
16366 @i{Niels Giesen} had the idea to automatically archive DONE trees.
16368 @i{Nicolas Goaziou} rewrote much of the plain list code.
16370 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
16372 @i{Brian Gough} of Network Theory Ltd publishes the Org mode manual as a
16375 @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
16376 task state change logging, and the clocktable. His clear explanations have
16377 been critical when we started to adopt the Git version control system.
16379 @i{Manuel Hermenegildo} has contributed various ideas, small fixes and
16382 @i{Phil Jackson} wrote @file{org-irc.el}.
16384 @i{Scott Jaderholm} proposed footnotes, control over whitespace between
16385 folded entries, and column view for properties.
16387 @i{Matt Jones} wrote @i{MobileOrg Android}.
16389 @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
16391 @i{Shidai Liu} ("Leo") asked for embedded @LaTeX{} and tested it. He also
16392 provided frequent feedback and some patches.
16394 @i{Matt Lundin} has proposed last-row references for table formulas and named
16395 invisible anchors. He has also worked a lot on the FAQ.
16397 @i{David Maus} wrote @file{org-atom.el}, maintains the issues file for Org,
16398 and is a prolific contributor on the mailing list with competent replies,
16399 small fixes and patches.
16401 @i{Jason F. McBrayer} suggested agenda export to CSV format.
16403 @i{Max Mikhanosha} came up with the idea of refiling.
16405 @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
16408 @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
16411 @i{Richard Moreland} wrote @i{MobileOrg} for the iPhone.
16413 @i{Rick Moynihan} proposed allowing multiple TODO sequences in a file
16414 and being able to quickly restrict the agenda to a subtree.
16416 @i{Todd Neal} provided patches for links to Info files and Elisp forms.
16418 @i{Greg Newman} refreshed the unicorn logo into its current form.
16420 @i{Tim O'Callaghan} suggested in-file links, search options for general
16421 file links, and TAGS.
16423 @i{Osamu Okano} wrote @file{orgcard2ref.pl}, a Perl program to create a text
16424 version of the reference card.
16426 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
16429 @i{Oliver Oppitz} suggested multi-state TODO items.
16431 @i{Scott Otterson} sparked the introduction of descriptive text for
16432 links, among other things.
16434 @i{Pete Phillips} helped during the development of the TAGS feature, and
16435 provided frequent feedback.
16437 @i{Martin Pohlack} provided the code snippet to bundle character insertion
16438 into bundles of 20 for undo.
16440 @i{T.V. Raman} reported bugs and suggested improvements.
16442 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
16445 @i{Paul Rivier} provided the basic implementation of named footnotes. He
16446 also acted as mailing list moderator for some time.
16448 @i{Kevin Rogers} contributed code to access VM files on remote hosts.
16450 @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
16451 conflict with @file{allout.el}.
16453 @i{Jason Riedy} generalized the send-receive mechanism for Orgtbl tables with
16456 @i{Philip Rooke} created the Org reference card, provided lots
16457 of feedback, developed and applied standards to the Org documentation.
16459 @i{Christian Schlauer} proposed angular brackets around links, among
16462 @i{Paul Sexton} wrote @file{org-ctags.el}.
16464 Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
16465 @file{organizer-mode.el}.
16467 @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal
16468 examples, and remote highlighting for referenced code lines.
16470 @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
16471 now packaged into Org's @file{contrib} directory.
16473 @i{Daniel Sinder} came up with the idea of internal archiving by locking
16476 @i{Dale Smith} proposed link abbreviations.
16478 @i{James TD Smith} has contributed a large number of patches for useful
16479 tweaks and features.
16481 @i{Adam Spiers} asked for global linking commands, inspired the link
16482 extension system, added support for mairix, and proposed the mapping API.
16484 @i{Ulf Stegemann} created the table to translate special symbols to HTML,
16485 @LaTeX{}, UTF-8, Latin-1 and ASCII.
16487 @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content
16488 with links transformation to Org syntax.
16490 @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
16491 chapter about publishing.
16493 @i{Jambunathan K} contributed the @acronym{ODT} exporter.
16495 @i{Sebastien Vauban} reported many issues with @LaTeX{} and BEAMER export and
16496 enabled source code highlighting in Gnus.
16498 @i{Stefan Vollmar} organized a video-recorded talk at the
16499 Max-Planck-Institute for Neurology. He also inspired the creation of a
16500 concept index for HTML export.
16502 @i{J@"urgen Vollmer} contributed code generating the table of contents
16505 @i{Samuel Wales} has provided important feedback and bug reports.
16507 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
16510 @i{David Wainberg} suggested archiving, and improvements to the linking
16513 @i{Carsten Wimmer} suggested some changes and helped fix a bug in
16516 @i{Roland Winkler} requested additional key bindings to make Org
16519 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
16520 and contributed various ideas and code snippets.
16525 @node Main Index, Key Index, History and Acknowledgments, Top
16526 @unnumbered Concept index
16530 @node Key Index, Command and Function Index, Main Index, Top
16531 @unnumbered Key index
16535 @node Command and Function Index, Variable Index, Key Index, Top
16536 @unnumbered Command and function index
16540 @node Variable Index, , Command and Function Index, Top
16541 @unnumbered Variable index
16543 This is not a complete index of variables and faces, only the ones that are
16544 mentioned in the manual. For a more complete list, use @kbd{M-x
16545 org-customize @key{RET}} and then click yourself through the tree.
16551 @c Local variables:
16553 @c indent-tabs-mode: nil
16554 @c paragraph-start: "
\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|\f\\|[ ]*$"
16555 @c paragraph-separate: "
\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|[ \f]*$"
16559 @c LocalWords: webdavhost pre