4 @setfilename ../../info/org
5 @settitle The Org Manual
8 @set DATE December 2011
10 @c Use proper quote and backtick for code sections in PDF output
11 @c Cf. Texinfo manual 14.2
12 @set txicodequoteundirected
13 @set txicodequotebacktick
15 @c Version and Contact Info
16 @set MAINTAINERSITE @uref{http://orgmode.org,maintainers webpage}
17 @set AUTHOR Carsten Dominik
18 @set MAINTAINER Carsten Dominik
19 @set MAINTAINEREMAIL @email{carsten at orgmode dot org}
20 @set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer}
25 @c -----------------------------------------------------------------------------
27 @c Macro definitions for commands and keys
28 @c =======================================
30 @c The behavior of the key/command macros will depend on the flag cmdnames
31 @c When set, commands names are shown. When clear, they are not shown.
35 @c Below we define the following macros for Org key tables:
37 @c orgkey{key} A key item
38 @c orgcmd{key,cmd} Key with command name
39 @c xorgcmd{key,cmmand} Key with command name as @itemx
40 @c orgcmdnki{key,cmd} Like orgcmd, but do not index the key
41 @c orgcmdtkc{text,key,cmd} Like orgcmd,special text instead of key
42 @c orgcmdkkc{key1,key2,cmd} Two keys with one command name, use "or"
43 @c orgcmdkxkc{key1,key2,cmd} Two keys with one command name, but
44 @c different functions, so format as @itemx
45 @c orgcmdkskc{key1,key2,cmd} Same as orgcmdkkc, but use "or short"
46 @c xorgcmdkskc{key1,key2,cmd} Same as previous, but use @itemx
47 @c orgcmdkkcc{key1,key2,cmd1,cmd2} Two keys and two commands
49 @c a key but no command
61 @c one key with a command
62 @c Inserts: @item KEY COMMAND
63 @macro orgcmd{key,command}
68 @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
71 @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
80 @c One key with one command, formatted using @itemx
81 @c Inserts: @itemx KEY COMMAND
82 @macro xorgcmd{key,command}
87 @itemx @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
90 @itemx @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
99 @c one key with a command, bit do not index the key
100 @c Inserts: @item KEY COMMAND
101 @macro orgcmdnki{key,command}
105 @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
108 @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
116 @c one key with a command, and special text to replace key in item
117 @c Inserts: @item TEXT COMMAND
118 @macro orgcmdtkc{text,key,command}
123 @item @kbd{\text\} @hskip 0pt plus 1filll @code{\command\}
126 @item @kbd{\text\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
135 @c two keys with one command
136 @c Inserts: @item KEY1 or KEY2 COMMAND
137 @macro orgcmdkkc{key1,key2,command}
143 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
146 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
152 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\}
156 @c Two keys with one command name, but different functions, so format as
158 @c Inserts: @item KEY1
159 @c @itemx KEY2 COMMAND
160 @macro orgcmdkxkc{key1,key2,command}
167 @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
171 @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
182 @c Same as previous, but use "or short"
183 @c Inserts: @item KEY1 or short KEY2 COMMAND
184 @macro orgcmdkskc{key1,key2,command}
190 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
193 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
199 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
203 @c Same as previous, but use @itemx
204 @c Inserts: @itemx KEY1 or short KEY2 COMMAND
205 @macro xorgcmdkskc{key1,key2,command}
211 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
214 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
220 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
224 @c two keys with two commands
225 @c Inserts: @item KEY1 COMMAND1
226 @c @itemx KEY2 COMMAND2
227 @macro orgcmdkkcc{key1,key2,command1,command2}
234 @item @kbd{\key1\} @hskip 0pt plus 1filll @code{\command1\}
235 @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command2\}
238 @item @kbd{\key1\} @tie{}@tie{}@tie{}@tie{}(@code{\command1\})
239 @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command2\})
249 @c -----------------------------------------------------------------------------
252 @c @hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed}
255 @c Subheadings inside a table.
256 @macro tsubheading{text}
258 @subsubheading \text\
266 This manual is for Org version @value{VERSION}.
268 Copyright @copyright{} 2004-2011 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:: Which key invokes which 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 * cache:: Avoid re-evaluating unchanged code blocks
712 * sep:: Delimiter for writing tabular results outside Org
713 * hlines:: Handle horizontal lines in tables
714 * colnames:: Handle column names in tables
715 * rownames:: Handle row names in tables
716 * shebang:: Make tangled files executable
717 * eval:: Limit evaluation of specific code blocks
721 * Completion:: M-TAB knows what you need
722 * Easy Templates:: Quick insertion of structural elements
723 * Speed keys:: Electric commands at the beginning of a headline
724 * Code evaluation security:: Org mode files evaluate inline code
725 * Customization:: Adapting Org to your taste
726 * In-buffer settings:: Overview of the #+KEYWORDS
727 * The very busy C-c C-c key:: When in doubt, press C-c C-c
728 * Clean view:: Getting rid of leading stars in the outline
729 * TTY keys:: Using Org on a tty
730 * Interaction:: Other Emacs packages
731 * org-crypt.el:: Encrypting Org files
733 Interaction with other packages
735 * Cooperation:: Packages Org cooperates with
736 * Conflicts:: Packages that lead to conflicts
740 * Hooks:: Who to reach into Org's internals
741 * Add-on packages:: Available extensions
742 * Adding hyperlink types:: New custom link types
743 * Context-sensitive commands:: How to add functionality to such commands
744 * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
745 * Dynamic blocks:: Automatically filled blocks
746 * Special agenda views:: Customized views
747 * Extracting agenda information:: Postprocessing of agenda information
748 * Using the property API:: Writing programs that use entry properties
749 * Using the mapping API:: Mapping over all or selected entries
751 Tables and lists in arbitrary syntax
753 * Radio tables:: Sending and receiving radio tables
754 * A LaTeX example:: Step by step, almost a tutorial
755 * Translator functions:: Copy and modify
756 * Radio lists:: Doing the same for lists
760 * Setting up the staging area:: Where to interact with the mobile device
761 * Pushing to MobileOrg:: Uploading Org files and agendas
762 * Pulling from MobileOrg:: Integrating captured and flagged items
767 @node Introduction, Document Structure, Top, Top
768 @chapter Introduction
772 * Summary:: Brief summary of what Org does
773 * Installation:: How to install a downloaded version of Org
774 * Activation:: How to activate Org for certain buffers
775 * Feedback:: Bug reports, ideas, patches etc.
776 * Conventions:: Type-setting conventions in the manual
779 @node Summary, Installation, Introduction, Introduction
783 Org is a mode for keeping notes, maintaining TODO lists, and doing
784 project planning with a fast and effective plain-text system.
786 Org develops organizational tasks around NOTES files that contain
787 lists or information about projects as plain text. Org is
788 implemented on top of Outline mode, which makes it possible to keep the
789 content of large files well structured. Visibility cycling and
790 structure editing help to work with the tree. Tables are easily created
791 with a built-in table editor. Org supports TODO items, deadlines,
792 timestamps, and scheduling. It dynamically compiles entries into an
793 agenda that utilizes and smoothly integrates much of the Emacs calendar
794 and diary. Plain text URL-like links connect to websites, emails,
795 Usenet messages, BBDB entries, and any files related to the projects.
796 For printing and sharing of notes, an Org file can be exported as a
797 structured ASCII file, as HTML, or (TODO and agenda items only) as an
798 iCalendar file. It can also serve as a publishing tool for a set of
801 As a project planning environment, Org works by adding metadata to outline
802 nodes. Based on this data, specific entries can be extracted in queries and
803 create dynamic @i{agenda views}.
805 Org mode contains the Org Babel environment which allows you to work with
806 embedded source code blocks in a file, to facilitate code evaluation,
807 documentation, and literate programming techniques.
809 Org's automatic, context-sensitive table editor with spreadsheet
810 capabilities can be integrated into any major mode by activating the
811 minor Orgtbl mode. Using a translation step, it can be used to maintain
812 tables in arbitrary file types, for example in @LaTeX{}. The structure
813 editing and list creation capabilities can be used outside Org with
814 the minor Orgstruct mode.
816 Org keeps simple things simple. When first fired up, it should
817 feel like a straightforward, easy to use outliner. Complexity is not
818 imposed, but a large amount of functionality is available when you need
819 it. Org is a toolbox and can be used in different ways and for different
823 @r{@bullet{} an outline extension with visibility cycling and structure editing}
824 @r{@bullet{} an ASCII system and table editor for taking structured notes}
825 @r{@bullet{} a TODO list editor}
826 @r{@bullet{} a full agenda and planner with deadlines and work scheduling}
827 @pindex GTD, Getting Things Done
828 @r{@bullet{} an environment in which to implement David Allen's GTD system}
829 @r{@bullet{} a simple hypertext system, with HTML and @LaTeX{} export}
830 @r{@bullet{} a publishing tool to create a set of interlinked webpages}
831 @r{@bullet{} an environment for literate programming}
836 There is a website for Org which provides links to the newest
837 version of Org, as well as additional information, frequently asked
838 questions (FAQ), links to tutorials, etc@. This page is located at
839 @uref{http://orgmode.org}.
841 @cindex print edition
842 The version 7.3 of this manual is available as a
843 @uref{http://www.network-theory.co.uk/org/manual/, paperback book from Network
849 @node Installation, Activation, Summary, Introduction
850 @section Installation
854 @b{Important:} @i{If you are using a version of Org that is part of the Emacs
855 distribution or an XEmacs package, please skip this section and go directly
856 to @ref{Activation}. To see what version of Org (if any) is part of your
857 Emacs distribution, type @kbd{M-x load-library RET org} and then @kbd{M-x
860 If you have downloaded Org from the Web, either as a distribution @file{.zip}
861 or @file{.tar} file, or as a Git archive, you must take the following steps
862 to install it: go into the unpacked Org distribution directory and edit the
863 top section of the file @file{Makefile}. You must set the name of the Emacs
864 binary (likely either @file{emacs} or @file{xemacs}), and the paths to the
865 directories where local Lisp and Info files are kept. If you don't have
866 access to the system-wide directories, you can simply run Org directly from
867 the distribution directory by adding the @file{lisp} subdirectory to the
868 Emacs load path. To do this, add the following line to @file{.emacs}:
871 (setq load-path (cons "~/path/to/orgdir/lisp" load-path))
875 If you plan to use code from the @file{contrib} subdirectory, do a similar
876 step for this directory:
879 (setq load-path (cons "~/path/to/orgdir/contrib/lisp" load-path))
882 @noindent Now byte-compile the Lisp files with the shell command:
888 @noindent If you are running Org from the distribution directory, this is
889 all. If you want to install Org into the system directories, use (as
896 Installing Info files is system dependent, because of differences in the
897 @file{install-info} program. The following should correctly install the Info
898 files on most systems, please send a bug report if not@footnote{The output
899 from install-info (if any) is also system dependent. In particular Debian
900 and its derivatives use two different versions of install-info and you may
904 This is not dpkg install-info anymore, but GNU install-info
905 See the man page for ginstall-info for command line arguments
908 @noindent which can be safely ignored.}.
914 Then add the following line to @file{.emacs}. It is needed so that
915 Emacs can autoload functions that are located in files not immediately loaded
916 when Org mode starts.
918 (require 'org-install)
921 Do not forget to activate Org as described in the following section.
924 @node Activation, Feedback, Installation, Introduction
928 @cindex global key bindings
929 @cindex key bindings, global
931 To make sure files with extension @file{.org} use Org mode, add the following
932 line to your @file{.emacs} file.
934 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
936 @noindent Org mode buffers need font-lock to be turned on - this is the
937 default in Emacs@footnote{If you don't use font-lock globally, turn it on in
938 Org buffer with @code{(add-hook 'org-mode-hook 'turn-on-font-lock)}}.
940 The four Org commands @command{org-store-link}, @command{org-capture},
941 @command{org-agenda}, and @command{org-iswitchb} should be accessible through
942 global keys (i.e.@: anywhere in Emacs, not just in Org buffers). Here are
943 suggested bindings for these keys, please modify the keys to your own
946 (global-set-key "\C-cl" 'org-store-link)
947 (global-set-key "\C-cc" 'org-capture)
948 (global-set-key "\C-ca" 'org-agenda)
949 (global-set-key "\C-cb" 'org-iswitchb)
952 @cindex Org mode, turning on
953 With this setup, all files with extension @samp{.org} will be put
954 into Org mode. As an alternative, make the first line of a file look
958 MY PROJECTS -*- mode: org; -*-
961 @vindex org-insert-mode-line-in-empty-file
962 @noindent which will select Org mode for this buffer no matter what
963 the file's name is. See also the variable
964 @code{org-insert-mode-line-in-empty-file}.
966 Many commands in Org work on the region if the region is @i{active}. To make
967 use of this, you need to have @code{transient-mark-mode}
968 (@code{zmacs-regions} in XEmacs) turned on. In Emacs 23 this is the default,
969 in Emacs 22 you need to do this yourself with
971 (transient-mark-mode 1)
973 @noindent If you do not like @code{transient-mark-mode}, you can create an
974 active region by using the mouse to select a region, or pressing
975 @kbd{C-@key{SPC}} twice before moving the cursor.
977 @node Feedback, Conventions, Activation, Introduction
984 If you find problems with Org, or if you have questions, remarks, or ideas
985 about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}.
986 If you are not a member of the mailing list, your mail will be passed to the
987 list after a moderator has approved it@footnote{Please consider subscribing
988 to the mailing list, in order to minimize the work the mailing list
989 moderators have to do.}.
991 For bug reports, please first try to reproduce the bug with the latest
992 version of Org available---if you are running an outdated version, it is
993 quite possible that the bug has been fixed already. If the bug persists,
994 prepare a report and provide as much information as possible, including the
995 version information of Emacs (@kbd{M-x emacs-version @key{RET}}) and Org
996 (@kbd{M-x org-version @key{RET}}), as well as the Org related setup in
997 @file{.emacs}. The easiest way to do this is to use the command
999 @kbd{M-x org-submit-bug-report}
1001 @noindent which will put all this information into an Emacs mail buffer so
1002 that you only need to add your description. If you re not sending the Email
1003 from within Emacs, please copy and paste the content into your Email program.
1005 Sometimes you might face a problem due to an error in your Emacs or Org mode
1006 setup. Before reporting a bug, it is very helpful to start Emacs with minimal
1007 customisations and reproduce the problem. Doing so often helps you determine
1008 if the problem is with your customisation or with Org mode itself. You can
1009 start a typical minimal session with a command like the example below.
1012 $ emacs -Q -l /path/to/minimal-org.el
1015 However if you are using Org mode as distributed with Emacs, a minimal setup
1016 is not necessary. In that case it is sufficient to start Emacs as @code{emacs
1017 -Q}. The @code{minimal-org.el} setup file can have contents as shown below.
1020 ;;; Minimal setup to load latest `org-mode'
1022 ;; activate debugging
1023 (setq debug-on-error t
1027 ;; add latest org-mode to load path
1028 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/lisp"))
1029 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/contrib/lisp"))
1032 (require 'org-install)
1035 If an error occurs, a backtrace can be very useful (see below on how to
1036 create one). Often a small example file helps, along with clear information
1040 @item What exactly did you do?
1041 @item What did you expect to happen?
1042 @item What happened instead?
1044 @noindent Thank you for helping to improve this program.
1046 @subsubheading How to create a useful backtrace
1048 @cindex backtrace of an error
1049 If working with Org produces an error with a message you don't
1050 understand, you may have hit a bug. The best way to report this is by
1051 providing, in addition to what was mentioned above, a @emph{backtrace}.
1052 This is information from the built-in debugger about where and how the
1053 error occurred. Here is how to produce a useful backtrace:
1057 Reload uncompiled versions of all Org mode Lisp files. The backtrace
1058 contains much more information if it is produced with uncompiled code.
1061 C-u M-x org-reload RET
1064 or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the
1067 Go to the @code{Options} menu and select @code{Enter Debugger on Error}
1068 (XEmacs has this option in the @code{Troubleshooting} sub-menu).
1070 Do whatever you have to do to hit the error. Don't forget to
1071 document the steps you take.
1073 When you hit the error, a @file{*Backtrace*} buffer will appear on the
1074 screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and
1075 attach it to your bug report.
1078 @node Conventions, , Feedback, Introduction
1079 @section Typesetting conventions used in this manual
1081 Org uses three types of keywords: TODO keywords, tags, and property
1082 names. In this manual we use the following conventions:
1087 TODO keywords are written with all capitals, even if they are
1091 User-defined tags are written in lowercase; built-in tags with special
1092 meaning are written with all capitals.
1095 User-defined properties are capitalized; built-in properties with
1096 special meaning are written with all capitals.
1099 The manual lists both the keys and the corresponding commands for accessing
1100 functionality. Org mode often uses the same key for different functions,
1101 depending on context. The command that is bound to such keys has a generic
1102 name, like @code{org-metaright}. In the manual we will, wherever possible,
1103 give the function that is internally called by the generic command. For
1104 example, in the chapter on document structure, @kbd{M-@key{right}} will be
1105 listed to call @code{org-do-demote}, while in the chapter on tables, it will
1106 be listed to call org-table-move-column-right.
1108 If you prefer, you can compile the manual without the command names by
1109 unsetting the flag @code{cmdnames} in @file{org.texi}.
1111 @node Document Structure, Tables, Introduction, Top
1112 @chapter Document structure
1113 @cindex document structure
1114 @cindex structure of document
1116 Org is based on Outline mode and provides flexible commands to
1117 edit the structure of the document.
1120 * Outlines:: Org is based on Outline mode
1121 * Headlines:: How to typeset Org tree headlines
1122 * Visibility cycling:: Show and hide, much simplified
1123 * Motion:: Jumping to other headlines
1124 * Structure editing:: Changing sequence and level of headlines
1125 * Sparse trees:: Matches embedded in context
1126 * Plain lists:: Additional structure within an entry
1127 * Drawers:: Tucking stuff away
1128 * Blocks:: Folding blocks
1129 * Footnotes:: How footnotes are defined in Org's syntax
1130 * Orgstruct mode:: Structure editing outside Org
1133 @node Outlines, Headlines, Document Structure, Document Structure
1136 @cindex Outline mode
1138 Org is implemented on top of Outline mode. Outlines allow a
1139 document to be organized in a hierarchical structure, which (at least
1140 for me) is the best representation of notes and thoughts. An overview
1141 of this structure is achieved by folding (hiding) large parts of the
1142 document to show only the general document structure and the parts
1143 currently being worked on. Org greatly simplifies the use of
1144 outlines by compressing the entire show/hide functionality into a single
1145 command, @command{org-cycle}, which is bound to the @key{TAB} key.
1147 @node Headlines, Visibility cycling, Outlines, Document Structure
1150 @cindex outline tree
1151 @vindex org-special-ctrl-a/e
1152 @vindex org-special-ctrl-k
1153 @vindex org-ctrl-k-protect-subtree
1155 Headlines define the structure of an outline tree. The headlines in Org
1156 start with one or more stars, on the left margin@footnote{See the variables
1157 @code{org-special-ctrl-a/e}, @code{org-special-ctrl-k}, and
1158 @code{org-ctrl-k-protect-subtree} to configure special behavior of @kbd{C-a},
1159 @kbd{C-e}, and @kbd{C-k} in headlines.}. For example:
1162 * Top level headline
1169 * Another top level headline
1172 @noindent Some people find the many stars too noisy and would prefer an
1173 outline that has whitespace followed by a single star as headline
1174 starters. @ref{Clean view}, describes a setup to realize this.
1176 @vindex org-cycle-separator-lines
1177 An empty line after the end of a subtree is considered part of it and
1178 will be hidden when the subtree is folded. However, if you leave at
1179 least two empty lines, one empty line will remain visible after folding
1180 the subtree, in order to structure the collapsed view. See the
1181 variable @code{org-cycle-separator-lines} to modify this behavior.
1183 @node Visibility cycling, Motion, Headlines, Document Structure
1184 @section Visibility cycling
1185 @cindex cycling, visibility
1186 @cindex visibility cycling
1187 @cindex trees, visibility
1188 @cindex show hidden text
1191 Outlines make it possible to hide parts of the text in the buffer.
1192 Org uses just two commands, bound to @key{TAB} and
1193 @kbd{S-@key{TAB}} to change the visibility in the buffer.
1195 @cindex subtree visibility states
1196 @cindex subtree cycling
1197 @cindex folded, subtree visibility state
1198 @cindex children, subtree visibility state
1199 @cindex subtree, subtree visibility state
1201 @orgcmd{@key{TAB},org-cycle}
1202 @emph{Subtree cycling}: Rotate current subtree among the states
1205 ,-> FOLDED -> CHILDREN -> SUBTREE --.
1206 '-----------------------------------'
1209 @vindex org-cycle-emulate-tab
1210 @vindex org-cycle-global-at-bob
1211 The cursor must be on a headline for this to work@footnote{see, however,
1212 the option @code{org-cycle-emulate-tab}.}. When the cursor is at the
1213 beginning of the buffer and the first line is not a headline, then
1214 @key{TAB} actually runs global cycling (see below)@footnote{see the
1215 option @code{org-cycle-global-at-bob}.}. Also when called with a prefix
1216 argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
1218 @cindex global visibility states
1219 @cindex global cycling
1220 @cindex overview, global visibility state
1221 @cindex contents, global visibility state
1222 @cindex show all, global visibility state
1223 @orgcmd{S-@key{TAB},org-global-cycle}
1224 @itemx C-u @key{TAB}
1225 @emph{Global cycling}: Rotate the entire buffer among the states
1228 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
1229 '--------------------------------------'
1232 When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
1233 CONTENTS view up to headlines of level N will be shown. Note that inside
1234 tables, @kbd{S-@key{TAB}} jumps to the previous field.
1236 @cindex show all, command
1237 @orgcmd{C-u C-u C-u @key{TAB},show-all}
1238 Show all, including drawers.
1239 @orgcmd{C-c C-r,org-reveal}
1240 Reveal context around point, showing the current entry, the following heading
1241 and the hierarchy above. Useful for working near a location that has been
1242 exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
1243 (@pxref{Agenda commands}). With a prefix argument show, on each
1244 level, all sibling headings. With double prefix arg, also show the entire
1245 subtree of the parent.
1246 @orgcmd{C-c C-k,show-branches}
1247 Expose all the headings of the subtree, CONTENT view for just one subtree.
1248 @orgcmd{C-c C-x b,org-tree-to-indirect-buffer}
1249 Show the current subtree in an indirect buffer@footnote{The indirect
1252 (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
1255 (see the Emacs manual for more information about indirect buffers)
1257 will contain the entire buffer, but will be narrowed to the current
1258 tree. Editing the indirect buffer will also change the original buffer,
1259 but without affecting visibility in that buffer.}. With a numeric
1260 prefix argument N, go up to level N and then take that tree. If N is
1261 negative then go up that many levels. With a @kbd{C-u} prefix, do not remove
1262 the previously used indirect buffer.
1263 @orgcmd{C-c C-x v,org-copy-visible}
1264 Copy the @i{visible} text in the region into the kill ring.
1267 @vindex org-startup-folded
1268 @cindex @code{overview}, STARTUP keyword
1269 @cindex @code{content}, STARTUP keyword
1270 @cindex @code{showall}, STARTUP keyword
1271 @cindex @code{showeverything}, STARTUP keyword
1273 When Emacs first visits an Org file, the global state is set to
1274 OVERVIEW, i.e.@: only the top level headlines are visible. This can be
1275 configured through the variable @code{org-startup-folded}, or on a
1276 per-file basis by adding one of the following lines anywhere in the
1283 #+STARTUP: showeverything
1286 @cindex property, VISIBILITY
1288 Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
1289 and Columns}) will get their visibility adapted accordingly. Allowed values
1290 for this property are @code{folded}, @code{children}, @code{content}, and
1293 @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
1294 Switch back to the startup visibility of the buffer, i.e.@: whatever is
1295 requested by startup options and @samp{VISIBILITY} properties in individual
1299 @node Motion, Structure editing, Visibility cycling, Document Structure
1301 @cindex motion, between headlines
1302 @cindex jumping, to headlines
1303 @cindex headline navigation
1304 The following commands jump to other headlines in the buffer.
1307 @orgcmd{C-c C-n,outline-next-visible-heading}
1309 @orgcmd{C-c C-p,outline-previous-visible-heading}
1311 @orgcmd{C-c C-f,org-forward-same-level}
1312 Next heading same level.
1313 @orgcmd{C-c C-b,org-backward-same-level}
1314 Previous heading same level.
1315 @orgcmd{C-c C-u,outline-up-heading}
1316 Backward to higher level heading.
1317 @orgcmd{C-c C-j,org-goto}
1318 Jump to a different place without changing the current outline
1319 visibility. Shows the document structure in a temporary buffer, where
1320 you can use the following keys to find your destination:
1321 @vindex org-goto-auto-isearch
1323 @key{TAB} @r{Cycle visibility.}
1324 @key{down} / @key{up} @r{Next/previous visible headline.}
1325 @key{RET} @r{Select this location.}
1326 @kbd{/} @r{Do a Sparse-tree search}
1327 @r{The following keys work if you turn off @code{org-goto-auto-isearch}}
1328 n / p @r{Next/previous visible headline.}
1329 f / b @r{Next/previous headline same level.}
1331 0-9 @r{Digit argument.}
1334 @vindex org-goto-interface
1336 See also the variable @code{org-goto-interface}.
1339 @node Structure editing, Sparse trees, Motion, Document Structure
1340 @section Structure editing
1341 @cindex structure editing
1342 @cindex headline, promotion and demotion
1343 @cindex promotion, of subtrees
1344 @cindex demotion, of subtrees
1345 @cindex subtree, cut and paste
1346 @cindex pasting, of subtrees
1347 @cindex cutting, of subtrees
1348 @cindex copying, of subtrees
1349 @cindex sorting, of subtrees
1350 @cindex subtrees, cut and paste
1353 @orgcmd{M-@key{RET},org-insert-heading}
1354 @vindex org-M-RET-may-split-line
1355 Insert new heading with same level as current. If the cursor is in a plain
1356 list item, a new item is created (@pxref{Plain lists}). To force creation of
1357 a new headline, use a prefix argument. When this command is used in the
1358 middle of a line, the line is split and the rest of the line becomes the new
1359 headline@footnote{If you do not want the line to be split, customize the
1360 variable @code{org-M-RET-may-split-line}.}. If the command is used at the
1361 beginning of a headline, the new headline is created before the current line.
1362 If at the beginning of any other line, the content of that line is made the
1363 new heading. If the command is used at the end of a folded subtree (i.e.@:
1364 behind the ellipses at the end of a headline), then a headline like the
1365 current one will be inserted after the end of the subtree.
1366 @orgcmd{C-@key{RET},org-insert-heading-respect-content}
1367 Just like @kbd{M-@key{RET}}, except when adding a new heading below the
1368 current heading, the new heading is placed after the body instead of before
1369 it. This command works from anywhere in the entry.
1370 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
1371 @vindex org-treat-insert-todo-heading-as-state-change
1372 Insert new TODO entry with same level as current heading. See also the
1373 variable @code{org-treat-insert-todo-heading-as-state-change}.
1374 @orgcmd{C-S-@key{RET},org-insert-todo-heading-respect-content}
1375 Insert new TODO entry with same level as current heading. Like
1376 @kbd{C-@key{RET}}, the new headline will be inserted after the current
1378 @orgcmd{@key{TAB},org-cycle}
1379 In a new entry with no text yet, the first @key{TAB} demotes the entry to
1380 become a child of the previous one. The next @key{TAB} makes it a parent,
1381 and so on, all the way to top level. Yet another @key{TAB}, and you are back
1382 to the initial level.
1383 @orgcmd{M-@key{left},org-do-promote}
1384 Promote current heading by one level.
1385 @orgcmd{M-@key{right},org-do-demote}
1386 Demote current heading by one level.
1387 @orgcmd{M-S-@key{left},org-promote-subtree}
1388 Promote the current subtree by one level.
1389 @orgcmd{M-S-@key{right},org-demote-subtree}
1390 Demote the current subtree by one level.
1391 @orgcmd{M-S-@key{up},org-move-subtree-up}
1392 Move subtree up (swap with previous subtree of same
1394 @orgcmd{M-S-@key{down},org-move-subtree-down}
1395 Move subtree down (swap with next subtree of same level).
1396 @orgcmd{C-c C-x C-w,org-cut-subtree}
1397 Kill subtree, i.e.@: remove it from buffer but save in kill ring.
1398 With a numeric prefix argument N, kill N sequential subtrees.
1399 @orgcmd{C-c C-x M-w,org-copy-subtree}
1400 Copy subtree to kill ring. With a numeric prefix argument N, copy the N
1401 sequential subtrees.
1402 @orgcmd{C-c C-x C-y,org-paste-subtree}
1403 Yank subtree from kill ring. This does modify the level of the subtree to
1404 make sure the tree fits in nicely at the yank position. The yank level can
1405 also be specified with a numeric prefix argument, or by yanking after a
1406 headline marker like @samp{****}.
1407 @orgcmd{C-y,org-yank}
1408 @vindex org-yank-adjusted-subtrees
1409 @vindex org-yank-folded-subtrees
1410 Depending on the variables @code{org-yank-adjusted-subtrees} and
1411 @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
1412 paste subtrees folded and in a clever way, using the same command as @kbd{C-c
1413 C-x C-y}. With the default settings, no level adjustment will take place,
1414 but the yanked tree will be folded unless doing so would swallow text
1415 previously visible. Any prefix argument to this command will force a normal
1416 @code{yank} to be executed, with the prefix passed along. A good way to
1417 force a normal yank is @kbd{C-u C-y}. If you use @code{yank-pop} after a
1418 yank, it will yank previous kill items plainly, without adjustment and
1420 @orgcmd{C-c C-x c,org-clone-subtree-with-time-shift}
1421 Clone a subtree by making a number of sibling copies of it. You will be
1422 prompted for the number of copies to make, and you can also specify if any
1423 timestamps in the entry should be shifted. This can be useful, for example,
1424 to create a number of tasks related to a series of lectures to prepare. For
1425 more details, see the docstring of the command
1426 @code{org-clone-subtree-with-time-shift}.
1427 @orgcmd{C-c C-w,org-refile}
1428 Refile entry or region to a different location. @xref{Refiling notes}.
1429 @orgcmd{C-c ^,org-sort-entries-or-items}
1430 Sort same-level entries. When there is an active region, all entries in the
1431 region will be sorted. Otherwise the children of the current headline are
1432 sorted. The command prompts for the sorting method, which can be
1433 alphabetically, numerically, by time (first timestamp with active preferred,
1434 creation time, scheduled time, deadline time), by priority, by TODO keyword
1435 (in the sequence the keywords have been defined in the setup) or by the value
1436 of a property. Reverse sorting is possible as well. You can also supply
1437 your own function to extract the sorting key. With a @kbd{C-u} prefix,
1438 sorting will be case-sensitive. With two @kbd{C-u C-u} prefixes, duplicate
1439 entries will also be removed.
1440 @orgcmd{C-x n s,org-narrow-to-subtree}
1441 Narrow buffer to current subtree.
1442 @orgcmd{C-x n b,org-narrow-to-block}
1443 Narrow buffer to current block.
1444 @orgcmd{C-x n w,widen}
1445 Widen buffer to remove narrowing.
1446 @orgcmd{C-c *,org-toggle-heading}
1447 Turn a normal line or plain list item into a headline (so that it becomes a
1448 subheading at its location). Also turn a headline into a normal line by
1449 removing the stars. If there is an active region, turn all lines in the
1450 region into headlines. If the first line in the region was an item, turn
1451 only the item lines into headlines. Finally, if the first line is a
1452 headline, remove the stars from all headlines in the region.
1455 @cindex region, active
1456 @cindex active region
1457 @cindex transient mark mode
1458 When there is an active region (Transient Mark mode), promotion and
1459 demotion work on all headlines in the region. To select a region of
1460 headlines, it is best to place both point and mark at the beginning of a
1461 line, mark at the beginning of the first headline, and point at the line
1462 just after the last headline to change. Note that when the cursor is
1463 inside a table (@pxref{Tables}), the Meta-Cursor keys have different
1467 @node Sparse trees, Plain lists, Structure editing, Document Structure
1468 @section Sparse trees
1469 @cindex sparse trees
1470 @cindex trees, sparse
1471 @cindex folding, sparse trees
1472 @cindex occur, command
1474 @vindex org-show-hierarchy-above
1475 @vindex org-show-following-heading
1476 @vindex org-show-siblings
1477 @vindex org-show-entry-below
1478 An important feature of Org mode is the ability to construct @emph{sparse
1479 trees} for selected information in an outline tree, so that the entire
1480 document is folded as much as possible, but the selected information is made
1481 visible along with the headline structure above it@footnote{See also the
1482 variables @code{org-show-hierarchy-above}, @code{org-show-following-heading},
1483 @code{org-show-siblings}, and @code{org-show-entry-below} for detailed
1484 control on how much context is shown around each match.}. Just try it out
1485 and you will see immediately how it works.
1487 Org mode contains several commands creating such trees, all these
1488 commands can be accessed through a dispatcher:
1491 @orgcmd{C-c /,org-sparse-tree}
1492 This prompts for an extra key to select a sparse-tree creating command.
1493 @orgcmd{C-c / r,org-occur}
1494 @vindex org-remove-highlights-with-change
1495 Prompts for a regexp and shows a sparse tree with all matches. If
1496 the match is in a headline, the headline is made visible. If the match is in
1497 the body of an entry, headline and body are made visible. In order to
1498 provide minimal context, also the full hierarchy of headlines above the match
1499 is shown, as well as the headline following the match. Each match is also
1500 highlighted; the highlights disappear when the buffer is changed by an
1501 editing command@footnote{This depends on the option
1502 @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
1503 When called with a @kbd{C-u} prefix argument, previous highlights are kept,
1504 so several calls to this command can be stacked.
1505 @orgcmdkkc{M-g n,M-g M-n,next-error}
1506 Jump to the next sparse tree match in this buffer.
1507 @orgcmdkkc{M-g p,M-g M-p,previous-error}
1508 Jump to the previous sparse tree match in this buffer.
1513 @vindex org-agenda-custom-commands
1514 For frequently used sparse trees of specific search strings, you can
1515 use the variable @code{org-agenda-custom-commands} to define fast
1516 keyboard access to specific sparse trees. These commands will then be
1517 accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
1521 (setq org-agenda-custom-commands
1522 '(("f" occur-tree "FIXME")))
1525 @noindent will define the key @kbd{C-c a f} as a shortcut for creating
1526 a sparse tree matching the string @samp{FIXME}.
1528 The other sparse tree commands select headings based on TODO keywords,
1529 tags, or properties and will be discussed later in this manual.
1532 @cindex printing sparse trees
1533 @cindex visible text, printing
1534 To print a sparse tree, you can use the Emacs command
1535 @code{ps-print-buffer-with-faces} which does not print invisible parts
1536 of the document @footnote{This does not work under XEmacs, because
1537 XEmacs uses selective display for outlining, not text properties.}.
1538 Or you can use the command @kbd{C-c C-e v} to export only the visible
1539 part of the document and print the resulting file.
1541 @node Plain lists, Drawers, Sparse trees, Document Structure
1542 @section Plain lists
1544 @cindex lists, plain
1545 @cindex lists, ordered
1546 @cindex ordered lists
1548 Within an entry of the outline tree, hand-formatted lists can provide
1549 additional structure. They also provide a way to create lists of checkboxes
1550 (@pxref{Checkboxes}). Org supports editing such lists, and every exporter
1551 (@pxref{Exporting}) can parse and format them.
1553 Org knows ordered lists, unordered lists, and description lists.
1556 @emph{Unordered} list items start with @samp{-}, @samp{+}, or
1557 @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
1558 they will be seen as top-level headlines. Also, when you are hiding leading
1559 stars to get a clean outline view, plain list items starting with a star may
1560 be hard to distinguish from true headlines. In short: even though @samp{*}
1561 is supported, it may be better to not use it for plain list items.} as
1564 @vindex org-plain-list-ordered-item-terminator
1565 @vindex org-alphabetical-lists
1566 @emph{Ordered} list items start with a numeral followed by either a period or
1567 a right parenthesis@footnote{You can filter out any of them by configuring
1568 @code{org-plain-list-ordered-item-terminator}.}, such as @samp{1.} or
1569 @samp{1)}@footnote{You can also get @samp{a.}, @samp{A.}, @samp{a)} and
1570 @samp{A)} by configuring @code{org-alphabetical-lists}. To minimize
1571 confusion with normal text, those are limited to one character only. Beyond
1572 that limit, bullets will automatically fallback to numbers.}. If you want a
1573 list to start with a different value (e.g.@: 20), start the text of the item
1574 with @code{[@@20]}@footnote{If there's a checkbox in the item, the cookie
1575 must be put @emph{before} the checkbox. If you have activated alphabetical
1576 lists, you can also use counters like @code{[@@b]}.}. Those constructs can
1577 be used in any item of the list in order to enforce a particular numbering.
1579 @emph{Description} list items are unordered list items, and contain the
1580 separator @samp{ :: } to distinguish the description @emph{term} from the
1584 Items belonging to the same list must have the same indentation on the first
1585 line. In particular, if an ordered list reaches number @samp{10.}, then the
1586 2--digit numbers must be written left-aligned with the other numbers in the
1587 list. An item ends before the next line that is less or equally indented
1588 than its bullet/number.
1590 @vindex org-list-ending-method
1591 @vindex org-list-end-regexp
1592 @vindex org-empty-line-terminates-plain-lists
1593 Two methods@footnote{To disable either of them, configure
1594 @code{org-list-ending-method}.} are provided to terminate lists. A list ends
1595 whenever every item has ended, which means before any line less or equally
1596 indented than items at top level. It also ends before two blank
1597 lines@footnote{See also @code{org-empty-line-terminates-plain-lists}.}. In
1598 that case, all items are closed. For finer control, you can end lists with
1599 any pattern set in @code{org-list-end-regexp}. Here is an example:
1603 ** Lord of the Rings
1604 My favorite scenes are (in this order)
1605 1. The attack of the Rohirrim
1606 2. Eowyn's fight with the witch king
1607 + this was already my favorite scene in the book
1608 + I really like Miranda Otto.
1609 3. Peter Jackson being shot by Legolas
1611 He makes a really funny face when it happens.
1612 But in the end, no individual scenes matter but the film as a whole.
1613 Important actors in this film are:
1614 - @b{Elijah Wood} :: He plays Frodo
1615 - @b{Sean Austin} :: He plays Sam, Frodo's friend. I still remember
1616 him very well from his role as Mikey Walsh in @i{The Goonies}.
1620 Org supports these lists by tuning filling and wrapping commands to deal with
1621 them correctly@footnote{Org only changes the filling settings for Emacs. For
1622 XEmacs, you should use Kyle E. Jones' @file{filladapt.el}. To turn this on,
1623 put into @file{.emacs}: @code{(require 'filladapt)}}, and by exporting them
1624 properly (@pxref{Exporting}). Since indentation is what governs the
1625 structure of these lists, many structural constructs like @code{#+BEGIN_...}
1626 blocks can be indented to signal that they belong to a particular item.
1628 @vindex org-list-demote-modify-bullet
1629 @vindex org-list-indent-offset
1630 If you find that using a different bullet for a sub-list (than that used for
1631 the current list-level) improves readability, customize the variable
1632 @code{org-list-demote-modify-bullet}. To get a greater difference of
1633 indentation between items and theirs sub-items, customize
1634 @code{org-list-indent-offset}.
1636 @vindex org-list-automatic-rules
1637 The following commands act on items when the cursor is in the first line of
1638 an item (the line with the bullet or number). Some of them imply the
1639 application of automatic rules to keep list structure intact. If some of
1640 these actions get in your way, configure @code{org-list-automatic-rules}
1641 to disable them individually.
1644 @orgcmd{@key{TAB},org-cycle}
1645 @cindex cycling, in plain lists
1646 @vindex org-cycle-include-plain-lists
1647 Items can be folded just like headline levels. Normally this works only if
1648 the cursor is on a plain list item. For more details, see the variable
1649 @code{org-cycle-include-plain-lists}. If this variable is set to
1650 @code{integrate}, plain list items will be treated like low-level
1651 headlines. The level of an item is then given by the
1652 indentation of the bullet/number. Items are always subordinate to real
1653 headlines, however; the hierarchies remain completely separated.
1654 @orgcmd{M-@key{RET},org-insert-heading}
1655 @vindex org-M-RET-may-split-line
1656 @vindex org-list-automatic-rules
1657 Insert new item at current level. With a prefix argument, force a new
1658 heading (@pxref{Structure editing}). If this command is used in the middle
1659 of an item, that item is @emph{split} in two, and the second part becomes the
1660 new item@footnote{If you do not want the item to be split, customize the
1661 variable @code{org-M-RET-may-split-line}.}. If this command is executed
1662 @emph{before item's body}, the new item is created @emph{before} the current
1664 @kindex M-S-@key{RET}
1666 Insert a new item with a checkbox (@pxref{Checkboxes}).
1667 @orgcmd{@key{TAB},org-cycle}
1668 In a new item with no text yet, the first @key{TAB} demotes the item to
1669 become a child of the previous one. Subsequent @key{TAB}s move the item to
1670 meaningful levels in the list and eventually get it back to its initial
1672 @kindex S-@key{down}
1675 @cindex shift-selection-mode
1676 @vindex org-support-shift-select
1677 @vindex org-list-use-circular-motion
1678 Jump to the previous/next item in the current list@footnote{If you want to
1679 cycle around items that way, you may customize
1680 @code{org-list-use-circular-motion}.}, but only if
1681 @code{org-support-shift-select} is off. If not, you can still use paragraph
1682 jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite
1685 @kindex M-@key{down}
1688 Move the item including subitems up/down@footnote{See
1689 @code{org-liste-use-circular-motion} for a cyclic behavior.} (swap with
1690 previous/next item of same indentation). If the list is ordered, renumbering
1692 @kindex M-@key{left}
1693 @kindex M-@key{right}
1695 @itemx M-@key{right}
1696 Decrease/increase the indentation of an item, leaving children alone.
1697 @kindex M-S-@key{left}
1698 @kindex M-S-@key{right}
1699 @item M-S-@key{left}
1700 @itemx M-S-@key{right}
1701 Decrease/increase the indentation of the item, including subitems.
1702 Initially, the item tree is selected based on current indentation. When
1703 these commands are executed several times in direct succession, the initially
1704 selected region is used, even if the new indentation would imply a different
1705 hierarchy. To use the new hierarchy, break the command chain with a cursor
1708 As a special case, using this command on the very first item of a list will
1709 move the whole list. This behavior can be disabled by configuring
1710 @code{org-list-automatic-rules}. The global indentation of a list has no
1711 influence on the text @emph{after} the list.
1714 If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
1715 state of the checkbox. In any case, verify bullets and indentation
1716 consistency in the whole list.
1718 @vindex org-plain-list-ordered-item-terminator
1719 @vindex org-list-automatic-rules
1721 Cycle the entire list level through the different itemize/enumerate bullets
1722 (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}) or a subset of them,
1723 depending on @code{org-plain-list-ordered-item-terminator}, the type of list,
1724 and its position@footnote{See @code{bullet} rule in
1725 @code{org-list-automatic-rules} for more information.}. With a numeric
1726 prefix argument N, select the Nth bullet from this list. If there is an
1727 active region when calling this, selected text will be changed into an item.
1728 With a prefix argument, all lines will be converted to list items. If the
1729 first line already was a list item, any item marker will be removed from the
1730 list. Finally, even without an active region, a normal line will be
1731 converted into a list item.
1734 Turn a plain list item into a headline (so that it becomes a subheading at
1735 its location). @xref{Structure editing}, for a detailed explanation.
1738 Turn the whole plain list into a subtree of the current heading. Checkboxes
1739 (@pxref{Checkboxes}) will become TODO (resp. DONE) keywords when unchecked
1741 @kindex S-@key{left}
1742 @kindex S-@key{right}
1743 @item S-@key{left}/@key{right}
1744 @vindex org-support-shift-select
1745 This command also cycles bullet styles when the cursor in on the bullet or
1746 anywhere in an item line, details depending on
1747 @code{org-support-shift-select}.
1750 Sort the plain list. You will be prompted for the sorting method:
1751 numerically, alphabetically, by time, or by custom function.
1754 @node Drawers, Blocks, Plain lists, Document Structure
1758 @cindex visibility cycling, drawers
1761 Sometimes you want to keep information associated with an entry, but you
1762 normally don't want to see it. For this, Org mode has @emph{drawers}.
1763 Drawers need to be configured with the variable
1764 @code{org-drawers}@footnote{You can define drawers on a per-file basis
1765 with a line like @code{#+DRAWERS: HIDDEN PROPERTIES STATE}}. Drawers
1769 ** This is a headline
1770 Still outside the drawer
1772 This is inside the drawer.
1777 Visibility cycling (@pxref{Visibility cycling}) on the headline will hide and
1778 show the entry, but keep the drawer collapsed to a single line. In order to
1779 look inside the drawer, you need to move the cursor to the drawer line and
1780 press @key{TAB} there. Org mode uses the @code{PROPERTIES} drawer for
1781 storing properties (@pxref{Properties and Columns}), and you can also arrange
1782 for state change notes (@pxref{Tracking TODO state changes}) and clock times
1783 (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}. If you
1784 want to store a quick note in the LOGBOOK drawer, in a similar way to state changes, use
1789 Add a time-stamped note to the LOGBOOK drawer.
1792 @node Blocks, Footnotes, Drawers, Document Structure
1795 @vindex org-hide-block-startup
1796 @cindex blocks, folding
1797 Org mode uses begin...end blocks for various purposes from including source
1798 code examples (@pxref{Literal examples}) to capturing time logging
1799 information (@pxref{Clocking work time}). These blocks can be folded and
1800 unfolded by pressing TAB in the begin line. You can also get all blocks
1801 folded at startup by configuring the variable @code{org-hide-block-startup}
1802 or on a per-file basis by using
1804 @cindex @code{hideblocks}, STARTUP keyword
1805 @cindex @code{nohideblocks}, STARTUP keyword
1807 #+STARTUP: hideblocks
1808 #+STARTUP: nohideblocks
1811 @node Footnotes, Orgstruct mode, Blocks, Document Structure
1815 Org mode supports the creation of footnotes. In contrast to the
1816 @file{footnote.el} package, Org mode's footnotes are designed for work on a
1817 larger document, not only for one-off documents like emails. The basic
1818 syntax is similar to the one used by @file{footnote.el}, i.e.@: a footnote is
1819 defined in a paragraph that is started by a footnote marker in square
1820 brackets in column 0, no indentation allowed. If you need a paragraph break
1821 inside a footnote, use the @LaTeX{} idiom @samp{\par}. The footnote reference
1822 is simply the marker in square brackets, inside text. For example:
1825 The Org homepage[fn:1] now looks a lot better than it used to.
1827 [fn:1] The link is: http://orgmode.org
1830 Org mode extends the number-based syntax to @emph{named} footnotes and
1831 optional inline definition. Using plain numbers as markers (as
1832 @file{footnote.el} does) is supported for backward compatibility, but not
1833 encouraged because of possible conflicts with @LaTeX{} snippets (@pxref{Embedded
1834 LaTeX}). Here are the valid references:
1838 A plain numeric footnote marker. Compatible with @file{footnote.el}, but not
1839 recommended because something like @samp{[1]} could easily be part of a code
1842 A named footnote reference, where @code{name} is a unique label word, or, for
1843 simplicity of automatic creation, a number.
1844 @item [fn:: This is the inline definition of this footnote]
1845 A @LaTeX{}-like anonymous footnote where the definition is given directly at the
1847 @item [fn:name: a definition]
1848 An inline definition of a footnote, which also specifies a name for the note.
1849 Since Org allows multiple references to the same note, you can then use
1850 @code{[fn:name]} to create additional references.
1853 @vindex org-footnote-auto-label
1854 Footnote labels can be created automatically, or you can create names yourself.
1855 This is handled by the variable @code{org-footnote-auto-label} and its
1856 corresponding @code{#+STARTUP} keywords. See the docstring of that variable
1859 @noindent The following command handles footnotes:
1864 The footnote action command.
1866 When the cursor is on a footnote reference, jump to the definition. When it
1867 is at a definition, jump to the (first) reference.
1869 @vindex org-footnote-define-inline
1870 @vindex org-footnote-section
1871 @vindex org-footnote-auto-adjust
1872 Otherwise, create a new footnote. Depending on the variable
1873 @code{org-footnote-define-inline}@footnote{The corresponding in-buffer
1874 setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
1875 definition will be placed right into the text as part of the reference, or
1876 separately into the location determined by the variable
1877 @code{org-footnote-section}.
1879 When this command is called with a prefix argument, a menu of additional
1882 s @r{Sort the footnote definitions by reference sequence. During editing,}
1883 @r{Org makes no effort to sort footnote definitions into a particular}
1884 @r{sequence. If you want them sorted, use this command, which will}
1885 @r{also move entries according to @code{org-footnote-section}. Automatic}
1886 @r{sorting after each insertion/deletion can be configured using the}
1887 @r{variable @code{org-footnote-auto-adjust}.}
1888 r @r{Renumber the simple @code{fn:N} footnotes. Automatic renumbering}
1889 @r{after each insertion/deletion can be configured using the variable}
1890 @r{@code{org-footnote-auto-adjust}.}
1891 S @r{Short for first @code{r}, then @code{s} action.}
1892 n @r{Normalize the footnotes by collecting all definitions (including}
1893 @r{inline definitions) into a special section, and then numbering them}
1894 @r{in sequence. The references will then also be numbers. This is}
1895 @r{meant to be the final step before finishing a document (e.g.@: sending}
1896 @r{off an email). The exporters do this automatically, and so could}
1897 @r{something like @code{message-send-hook}.}
1898 d @r{Delete the footnote at point, and all definitions of and references}
1901 Depending on the variable @code{org-footnote-auto-adjust}@footnote{the
1902 corresponding in-buffer options are @code{fnadjust} and @code{nofnadjust}.},
1903 renumbering and sorting footnotes can be automatic after each insertion or
1908 If the cursor is on a footnote reference, jump to the definition. If it is a
1909 the definition, jump back to the reference. When called at a footnote
1910 location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
1914 @item C-c C-o @r{or} mouse-1/2
1915 Footnote labels are also links to the corresponding definition/reference, and
1916 you can use the usual commands to follow these links.
1919 @node Orgstruct mode, , Footnotes, Document Structure
1920 @section The Orgstruct minor mode
1921 @cindex Orgstruct mode
1922 @cindex minor mode for structure editing
1924 If you like the intuitive way the Org mode structure editing and list
1925 formatting works, you might want to use these commands in other modes like
1926 Text mode or Mail mode as well. The minor mode @code{orgstruct-mode} makes
1927 this possible. Toggle the mode with @kbd{M-x orgstruct-mode}, or
1928 turn it on by default, for example in Message mode, with one of:
1931 (add-hook 'message-mode-hook 'turn-on-orgstruct)
1932 (add-hook 'message-mode-hook 'turn-on-orgstruct++)
1935 When this mode is active and the cursor is on a line that looks to Org like a
1936 headline or the first line of a list item, most structure editing commands
1937 will work, even if the same keys normally have different functionality in the
1938 major mode you are using. If the cursor is not in one of those special
1939 lines, Orgstruct mode lurks silently in the shadows. When you use
1940 @code{orgstruct++-mode}, Org will also export indentation and autofill
1941 settings into that mode, and detect item context after the first line of an
1944 @node Tables, Hyperlinks, Document Structure, Top
1947 @cindex editing tables
1949 Org comes with a fast and intuitive table editor. Spreadsheet-like
1950 calculations are supported using the Emacs @file{calc} package
1952 (@pxref{Top,Calc,,Calc,Gnu Emacs Calculator Manual}).
1955 (see the Emacs Calculator manual for more information about the Emacs
1960 * Built-in table editor:: Simple tables
1961 * Column width and alignment:: Overrule the automatic settings
1962 * Column groups:: Grouping to trigger vertical lines
1963 * Orgtbl mode:: The table editor as minor mode
1964 * The spreadsheet:: The table editor has spreadsheet capabilities
1965 * Org-Plot:: Plotting from org tables
1968 @node Built-in table editor, Column width and alignment, Tables, Tables
1969 @section The built-in table editor
1970 @cindex table editor, built-in
1972 Org makes it easy to format tables in plain ASCII. Any line with @samp{|} as
1973 the first non-whitespace character is considered part of a table. @samp{|}
1974 is also the column separator@footnote{To insert a vertical bar into a table
1975 field, use @code{\vert} or, inside a word @code{abc\vert@{@}def}.}. A table
1976 might look like this:
1979 | Name | Phone | Age |
1980 |-------+-------+-----|
1981 | Peter | 1234 | 17 |
1982 | Anna | 4321 | 25 |
1985 A table is re-aligned automatically each time you press @key{TAB} or
1986 @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to
1987 the next field (@key{RET} to the next row) and creates new table rows
1988 at the end of the table or before horizontal lines. The indentation
1989 of the table is set by the first line. Any line starting with
1990 @samp{|-} is considered as a horizontal separator line and will be
1991 expanded on the next re-align to span the whole table width. So, to
1992 create the above table, you would only type
1999 @noindent and then press @key{TAB} to align the table and start filling in
2000 fields. Even faster would be to type @code{|Name|Phone|Age} followed by
2001 @kbd{C-c @key{RET}}.
2003 @vindex org-enable-table-editor
2004 @vindex org-table-auto-blank-field
2005 When typing text into a field, Org treats @key{DEL},
2006 @key{Backspace}, and all character keys in a special way, so that
2007 inserting and deleting avoids shifting other fields. Also, when
2008 typing @emph{immediately after the cursor was moved into a new field
2009 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
2010 field is automatically made blank. If this behavior is too
2011 unpredictable for you, configure the variables
2012 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
2015 @tsubheading{Creation and conversion}
2016 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2017 Convert the active region to table. If every line contains at least one
2018 TAB character, the function assumes that the material is tab separated.
2019 If every line contains a comma, comma-separated values (CSV) are assumed.
2020 If not, lines are split at whitespace into fields. You can use a prefix
2021 argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
2022 C-u} forces TAB, and a numeric argument N indicates that at least N
2023 consecutive spaces, or alternatively a TAB will be the separator.
2025 If there is no active region, this command creates an empty Org
2026 table. But it is easier just to start typing, like
2027 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
2029 @tsubheading{Re-aligning and field motion}
2030 @orgcmd{C-c C-c,org-table-align}
2031 Re-align the table without moving the cursor.
2033 @orgcmd{<TAB>,org-table-next-field}
2034 Re-align the table, move to the next field. Creates a new row if
2037 @orgcmd{S-@key{TAB},org-table-previous-field}
2038 Re-align, move to previous field.
2040 @orgcmd{@key{RET},org-table-next-row}
2041 Re-align the table and move down to next row. Creates a new row if
2042 necessary. At the beginning or end of a line, @key{RET} still does
2043 NEWLINE, so it can be used to split a table.
2045 @orgcmd{M-a,org-table-beginning-of-field}
2046 Move to beginning of the current table field, or on to the previous field.
2047 @orgcmd{M-e,org-table-end-of-field}
2048 Move to end of the current table field, or on to the next field.
2050 @tsubheading{Column and row editing}
2051 @orgcmdkkcc{M-@key{left},M-@key{right},org-table-move-column-left,org-table-move-column-right}
2052 Move the current column left/right.
2054 @orgcmd{M-S-@key{left},org-table-delete-column}
2055 Kill the current column.
2057 @orgcmd{M-S-@key{right},org-table-insert-column}
2058 Insert a new column to the left of the cursor position.
2060 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-move-row-up,org-table-move-row-down}
2061 Move the current row up/down.
2063 @orgcmd{M-S-@key{up},org-table-kill-row}
2064 Kill the current row or horizontal line.
2066 @orgcmd{M-S-@key{down},org-table-insert-row}
2067 Insert a new row above the current row. With a prefix argument, the line is
2068 created below the current one.
2070 @orgcmd{C-c -,org-table-insert-hline}
2071 Insert a horizontal line below current row. With a prefix argument, the line
2072 is created above the current line.
2074 @orgcmd{C-c @key{RET},org-table-hline-and-move}
2075 Insert a horizontal line below current row, and move the cursor into the row
2078 @orgcmd{C-c ^,org-table-sort-lines}
2079 Sort the table lines in the region. The position of point indicates the
2080 column to be used for sorting, and the range of lines is the range
2081 between the nearest horizontal separator lines, or the entire table. If
2082 point is before the first column, you will be prompted for the sorting
2083 column. If there is an active region, the mark specifies the first line
2084 and the sorting column, while point should be in the last line to be
2085 included into the sorting. The command prompts for the sorting type
2086 (alphabetically, numerically, or by time). When called with a prefix
2087 argument, alphabetic sorting will be case-sensitive.
2089 @tsubheading{Regions}
2090 @orgcmd{C-c C-x M-w,org-table-copy-region}
2091 Copy a rectangular region from a table to a special clipboard. Point and
2092 mark determine edge fields of the rectangle. If there is no active region,
2093 copy just the current field. The process ignores horizontal separator lines.
2095 @orgcmd{C-c C-x C-w,org-table-cut-region}
2096 Copy a rectangular region from a table to a special clipboard, and
2097 blank all fields in the rectangle. So this is the ``cut'' operation.
2099 @orgcmd{C-c C-x C-y,org-table-paste-rectangle}
2100 Paste a rectangular region into a table.
2101 The upper left corner ends up in the current field. All involved fields
2102 will be overwritten. If the rectangle does not fit into the present table,
2103 the table is enlarged as needed. The process ignores horizontal separator
2106 @orgcmd{M-@key{RET},org-table-wrap-region}
2107 Split the current field at the cursor position and move the rest to the line
2108 below. If there is an active region, and both point and mark are in the same
2109 column, the text in the column is wrapped to minimum width for the given
2110 number of lines. A numeric prefix argument may be used to change the number
2111 of desired lines. If there is no region, but you specify a prefix argument,
2112 the current field is made blank, and the content is appended to the field
2115 @tsubheading{Calculations}
2116 @cindex formula, in tables
2117 @cindex calculations, in tables
2118 @cindex region, active
2119 @cindex active region
2120 @cindex transient mark mode
2121 @orgcmd{C-c +,org-table-sum}
2122 Sum the numbers in the current column, or in the rectangle defined by
2123 the active region. The result is shown in the echo area and can
2124 be inserted with @kbd{C-y}.
2126 @orgcmd{S-@key{RET},org-table-copy-down}
2127 @vindex org-table-copy-increment
2128 When current field is empty, copy from first non-empty field above. When not
2129 empty, copy current field down to next row and move cursor along with it.
2130 Depending on the variable @code{org-table-copy-increment}, integer field
2131 values will be incremented during copy. Integers that are too large will not
2132 be incremented. Also, a @code{0} prefix argument temporarily disables the
2133 increment. This key is also used by shift-selection and related modes
2134 (@pxref{Conflicts}).
2136 @tsubheading{Miscellaneous}
2137 @orgcmd{C-c `,org-table-edit-field}
2138 Edit the current field in a separate window. This is useful for fields that
2139 are not fully visible (@pxref{Column width and alignment}). When called with
2140 a @kbd{C-u} prefix, just make the full field visible, so that it can be
2141 edited in place. When called with two @kbd{C-u} prefixes, make the editor
2142 window follow the cursor through the table and always show the current
2143 field. The follow mode exits automatically when the cursor leaves the table,
2144 or when you repeat this command with @kbd{C-u C-u C-c `}.
2146 @item M-x org-table-import
2147 Import a file as a table. The table should be TAB or whitespace
2148 separated. Use, for example, to import a spreadsheet table or data
2149 from a database, because these programs generally can write
2150 TAB-separated text files. This command works by inserting the file into
2151 the buffer and then converting the region to a table. Any prefix
2152 argument is passed on to the converter, which uses it to determine the
2154 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2155 Tables can also be imported by pasting tabular text into the Org
2156 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
2157 @kbd{C-c |} command (see above under @i{Creation and conversion}).
2159 @item M-x org-table-export
2160 @findex org-table-export
2161 @vindex org-table-export-default-format
2162 Export the table, by default as a TAB-separated file. Use for data
2163 exchange with, for example, spreadsheet or database programs. The format
2164 used to export the file can be configured in the variable
2165 @code{org-table-export-default-format}. You may also use properties
2166 @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
2167 name and the format for table export in a subtree. Org supports quite
2168 general formats for exported tables. The exporter format is the same as the
2169 format used by Orgtbl radio tables, see @ref{Translator functions}, for a
2170 detailed description.
2173 If you don't like the automatic table editor because it gets in your
2174 way on lines which you would like to start with @samp{|}, you can turn
2178 (setq org-enable-table-editor nil)
2181 @noindent Then the only table command that still works is
2182 @kbd{C-c C-c} to do a manual re-align.
2184 @node Column width and alignment, Column groups, Built-in table editor, Tables
2185 @section Column width and alignment
2186 @cindex narrow columns in tables
2187 @cindex alignment in tables
2189 The width of columns is automatically determined by the table editor. And
2190 also the alignment of a column is determined automatically from the fraction
2191 of number-like versus non-number fields in the column.
2193 Sometimes a single field or a few fields need to carry more text, leading to
2194 inconveniently wide columns. Or maybe you want to make a table with several
2195 columns having a fixed width, regardless of content. To set@footnote{This
2196 feature does not work on XEmacs.} the width of a column, one field anywhere
2197 in the column may contain just the string @samp{<N>} where @samp{N} is an
2198 integer specifying the width of the column in characters. The next re-align
2199 will then set the width of this column to this value.
2203 |---+------------------------------| |---+--------|
2205 | 1 | one | | 1 | one |
2206 | 2 | two | ----\ | 2 | two |
2207 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
2208 | 4 | four | | 4 | four |
2209 |---+------------------------------| |---+--------|
2214 Fields that are wider become clipped and end in the string @samp{=>}.
2215 Note that the full text is still in the buffer but is hidden.
2216 To see the full text, hold the mouse over the field---a tool-tip window
2217 will show the full content. To edit such a field, use the command
2218 @kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will
2219 open a new window with the full field. Edit it and finish with @kbd{C-c
2222 @vindex org-startup-align-all-tables
2223 When visiting a file containing a table with narrowed columns, the
2224 necessary character hiding has not yet happened, and the table needs to
2225 be aligned before it looks nice. Setting the option
2226 @code{org-startup-align-all-tables} will realign all tables in a file
2227 upon visiting, but also slow down startup. You can also set this option
2228 on a per-file basis with:
2235 If you would like to overrule the automatic alignment of number-rich columns
2236 to the right and of string-rich column to the left, you can use @samp{<r>},
2237 @samp{c}@footnote{Centering does not work inside Emacs, but it does have an
2238 effect when exporting to HTML.} or @samp{<l>} in a similar fashion. You may
2239 also combine alignment and field width like this: @samp{<l10>}.
2241 Lines which only contain these formatting cookies will be removed
2242 automatically when exporting the document.
2244 @node Column groups, Orgtbl mode, Column width and alignment, Tables
2245 @section Column groups
2246 @cindex grouping columns in tables
2248 When Org exports tables, it does so by default without vertical
2249 lines because that is visually more satisfying in general. Occasionally
2250 however, vertical lines can be useful to structure a table into groups
2251 of columns, much like horizontal lines can do for groups of rows. In
2252 order to specify column groups, you can use a special row where the
2253 first field contains only @samp{/}. The further fields can either
2254 contain @samp{<} to indicate that this column should start a group,
2255 @samp{>} to indicate the end of a column, or @samp{<>} to make a column
2256 a group of its own. Boundaries between column groups will upon export be
2257 marked with vertical lines. Here is an example:
2260 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2261 |---+-----+-----+-----+---------+------------|
2262 | / | < | | > | < | > |
2263 | 1 | 1 | 1 | 1 | 1 | 1 |
2264 | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
2265 | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
2266 |---+-----+-----+-----+---------+------------|
2267 #+TBLFM: $2=$1^2::$3=$1^3::$4=$1^4::$5=sqrt($1)::$6=sqrt(sqrt(($1)))
2270 It is also sufficient to just insert the column group starters after
2271 every vertical line you would like to have:
2274 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2275 |----+-----+-----+-----+---------+------------|
2279 @node Orgtbl mode, The spreadsheet, Column groups, Tables
2280 @section The Orgtbl minor mode
2282 @cindex minor mode for tables
2284 If you like the intuitive way the Org table editor works, you
2285 might also want to use it in other modes like Text mode or Mail mode.
2286 The minor mode Orgtbl mode makes this possible. You can always toggle
2287 the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for
2288 example in Message mode, use
2291 (add-hook 'message-mode-hook 'turn-on-orgtbl)
2294 Furthermore, with some special setup, it is possible to maintain tables
2295 in arbitrary syntax with Orgtbl mode. For example, it is possible to
2296 construct @LaTeX{} tables with the underlying ease and power of
2297 Orgtbl mode, including spreadsheet capabilities. For details, see
2298 @ref{Tables in arbitrary syntax}.
2300 @node The spreadsheet, Org-Plot, Orgtbl mode, Tables
2301 @section The spreadsheet
2302 @cindex calculations, in tables
2303 @cindex spreadsheet capabilities
2304 @cindex @file{calc} package
2306 The table editor makes use of the Emacs @file{calc} package to implement
2307 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
2308 derive fields from other fields. While fully featured, Org's implementation
2309 is not identical to other spreadsheets. For example, Org knows the concept
2310 of a @emph{column formula} that will be applied to all non-header fields in a
2311 column without having to copy the formula to each relevant field. There is
2312 also a formula debugger, and a formula editor with features for highlighting
2313 fields in the table corresponding to the references at the point in the
2314 formula, moving these references by arrow keys
2317 * References:: How to refer to another field or range
2318 * Formula syntax for Calc:: Using Calc to compute stuff
2319 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
2320 * Durations and time values:: How to compute durations and time values
2321 * Field and range formulas:: Formula for specific (ranges of) fields
2322 * Column formulas:: Formulas valid for an entire column
2323 * Editing and debugging formulas:: Fixing formulas
2324 * Updating the table:: Recomputing all dependent fields
2325 * Advanced features:: Field and column names, parameters and automatic recalc
2328 @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet
2329 @subsection References
2332 To compute fields in the table from other fields, formulas must
2333 reference other fields or ranges. In Org, fields can be referenced
2334 by name, by absolute coordinates, and by relative coordinates. To find
2335 out what the coordinates of a field are, press @kbd{C-c ?} in that
2336 field, or press @kbd{C-c @}} to toggle the display of a grid.
2338 @subsubheading Field references
2339 @cindex field references
2340 @cindex references, to fields
2342 Formulas can reference the value of another field in two ways. Like in
2343 any other spreadsheet, you may reference fields with a letter/number
2344 combination like @code{B3}, meaning the 2nd field in the 3rd row.
2345 @vindex org-table-use-standard-references
2346 However, Org prefers@footnote{Org will understand references typed by the
2347 user as @samp{B4}, but it will not use this syntax when offering a formula
2348 for editing. You can customize this behavior using the variable
2349 @code{org-table-use-standard-references}.} to use another, more general
2350 representation that looks like this:
2352 @@@var{row}$@var{column}
2355 Column specifications can be absolute like @code{$1},
2356 @code{$2},...@code{$@var{N}}, or relative to the current column (i.e.@: the
2357 column of the field which is being computed) like @code{$+1} or @code{$-2}.
2358 @code{$<} and @code{$>} are immutable references to the first and last
2359 column, respectively, and you can use @code{$>>>} to indicate the third
2360 column from the right.
2362 The row specification only counts data lines and ignores horizontal separator
2363 lines (hlines). Like with columns, you can use absolute row numbers
2364 @code{@@1}, @code{@@2},...@code{@@@var{N}}, and row numbers relative to the
2365 current row like @code{@@+3} or @code{@@-1}. @code{@@<} and @code{@@>} are
2366 immutable references the first and last@footnote{For backward compatibility
2367 you can also use special names like @code{$LR5} and @code{$LR12} to refer in
2368 a stable way to the 5th and 12th field in the last row of the table.
2369 However, this syntax is deprecated, it should not be used for new documents.
2370 Use @code{@@>$} instead.} row in the table, respectively. You may also
2371 specify the row relative to one of the hlines: @code{@@I} refers to the first
2372 hline, @code{@@II} to the second, etc@. @code{@@-I} refers to the first such
2373 line above the current line, @code{@@+I} to the first such line below the
2374 current line. You can also write @code{@@III+2} which is the second data line
2375 after the third hline in the table.
2377 @code{@@0} and @code{$0} refer to the current row and column, respectively,
2378 i.e. to the row/column for the field being computed. Also, if you omit
2379 either the column or the row part of the reference, the current row/column is
2382 Org's references with @emph{unsigned} numbers are fixed references
2383 in the sense that if you use the same reference in the formula for two
2384 different fields, the same field will be referenced each time.
2385 Org's references with @emph{signed} numbers are floating
2386 references because the same reference operator can reference different
2387 fields depending on the field being calculated by the formula.
2389 Here are a few examples:
2392 @@2$3 @r{2nd row, 3rd column (same as @code{C2})}
2393 $5 @r{column 5 in the current row (same as @code{E&})}
2394 @@2 @r{current column, row 2}
2395 @@-1$-3 @r{the field one row up, three columns to the left}
2396 @@-I$2 @r{field just under hline above current row, column 2}
2397 @@>$5 @r{field in the last row, in column 5}
2400 @subsubheading Range references
2401 @cindex range references
2402 @cindex references, to ranges
2404 You may reference a rectangular range of fields by specifying two field
2405 references connected by two dots @samp{..}. If both fields are in the
2406 current row, you may simply use @samp{$2..$7}, but if at least one field
2407 is in a different row, you need to use the general @code{@@row$column}
2408 format at least for the first field (i.e the reference must start with
2409 @samp{@@} in order to be interpreted correctly). Examples:
2412 $1..$3 @r{first three fields in the current row}
2413 $P..$Q @r{range, using column names (see under Advanced)}
2414 $<<<..$>> @r{start in third column, continue to the one but last}
2415 @@2$1..@@4$3 @r{6 fields between these two fields (same as @code{A2..C4})}
2416 @@-1$-2..@@-1 @r{3 numbers from the column to the left, 2 up to current row}
2417 @@I..II @r{between first and second hline, short for @code{@@I..@@II}}
2420 @noindent Range references return a vector of values that can be fed
2421 into Calc vector functions. Empty fields in ranges are normally
2422 suppressed, so that the vector contains only the non-empty fields (but
2423 see the @samp{E} mode switch below). If there are no non-empty fields,
2424 @samp{[0]} is returned to avoid syntax errors in formulas.
2426 @subsubheading Field coordinates in formulas
2427 @cindex field coordinates
2428 @cindex coordinates, of field
2429 @cindex row, of field coordinates
2430 @cindex column, of field coordinates
2432 For Calc formulas and Lisp formulas @code{@@#} and @code{$#} can be used to
2433 get the row or column number of the field where the formula result goes.
2434 The traditional Lisp formula equivalents are @code{org-table-current-dline}
2435 and @code{org-table-current-column}. Examples:
2438 if(@@# % 2, $#, string("")) @r{column number on odd lines only}
2439 $3 = remote(FOO, @@@@#$2) @r{copy column 2 from table FOO into}
2440 @r{column 3 of the current table}
2443 @noindent For the second example, table FOO must have at least as many rows
2444 as the current table. Note that this is inefficient@footnote{The computation time scales as
2445 O(N^2) because table FOO is parsed for each field to be copied.} for large
2448 @subsubheading Named references
2449 @cindex named references
2450 @cindex references, named
2451 @cindex name, of column or field
2452 @cindex constants, in calculations
2455 @vindex org-table-formula-constants
2456 @samp{$name} is interpreted as the name of a column, parameter or
2457 constant. Constants are defined globally through the variable
2458 @code{org-table-formula-constants}, and locally (for the file) through a
2462 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
2466 @vindex constants-unit-system
2467 @pindex constants.el
2468 Also properties (@pxref{Properties and Columns}) can be used as
2469 constants in table formulas: for a property @samp{:Xyz:} use the name
2470 @samp{$PROP_Xyz}, and the property will be searched in the current
2471 outline entry and in the hierarchy above it. If you have the
2472 @file{constants.el} package, it will also be used to resolve constants,
2473 including natural constants like @samp{$h} for Planck's constant, and
2474 units like @samp{$km} for kilometers@footnote{@file{constants.el} can
2475 supply the values of constants in two different unit systems, @code{SI}
2476 and @code{cgs}. Which one is used depends on the value of the variable
2477 @code{constants-unit-system}. You can use the @code{#+STARTUP} options
2478 @code{constSI} and @code{constcgs} to set this value for the current
2479 buffer.}. Column names and parameters can be specified in special table
2480 lines. These are described below, see @ref{Advanced features}. All
2481 names must start with a letter, and further consist of letters and
2484 @subsubheading Remote references
2485 @cindex remote references
2486 @cindex references, remote
2487 @cindex references, to a different table
2488 @cindex name, of column or field
2489 @cindex constants, in calculations
2492 You may also reference constants, fields and ranges from a different table,
2493 either in the current file or even in a different file. The syntax is
2496 remote(NAME-OR-ID,REF)
2500 where NAME can be the name of a table in the current file as set by a
2501 @code{#+TBLNAME: NAME} line before the table. It can also be the ID of an
2502 entry, even in a different file, and the reference then refers to the first
2503 table in that entry. REF is an absolute field or range reference as
2504 described above for example @code{@@3$3} or @code{$somename}, valid in the
2507 @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet
2508 @subsection Formula syntax for Calc
2509 @cindex formula syntax, Calc
2510 @cindex syntax, of formulas
2512 A formula can be any algebraic expression understood by the Emacs
2513 @file{Calc} package. @b{Note that @file{calc} has the
2514 non-standard convention that @samp{/} has lower precedence than
2515 @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.} Before
2516 evaluation by @code{calc-eval} (@pxref{Calling Calc from
2517 Your Programs,calc-eval,Calling Calc from Your Lisp Programs,Calc,GNU
2518 Emacs Calc Manual}),
2519 @c FIXME: The link to the Calc manual in HTML does not work.
2520 variable substitution takes place according to the rules described above.
2521 @cindex vectors, in table calculations
2522 The range vectors can be directly fed into the Calc vector functions
2523 like @samp{vmean} and @samp{vsum}.
2525 @cindex format specifier
2526 @cindex mode, for @file{calc}
2527 @vindex org-calc-default-modes
2528 A formula can contain an optional mode string after a semicolon. This
2529 string consists of flags to influence Calc and other modes during
2530 execution. By default, Org uses the standard Calc modes (precision
2531 12, angular units degrees, fraction and symbolic modes off). The display
2532 format, however, has been changed to @code{(float 8)} to keep tables
2533 compact. The default settings can be configured using the variable
2534 @code{org-calc-default-modes}.
2537 p20 @r{set the internal Calc calculation precision to 20 digits}
2538 n3 s3 e2 f4 @r{Normal, scientific, engineering, or fixed}
2539 @r{format of the result of Calc passed back to Org.}
2540 @r{Calc formatting is unlimited in precision as}
2541 @r{long as the Calc calculation precision is greater.}
2542 D R @r{angle modes: degrees, radians}
2543 F S @r{fraction and symbolic modes}
2544 N @r{interpret all fields as numbers, use 0 for non-numbers}
2545 E @r{keep empty fields in ranges}
2550 Unless you use large integer numbers or high-precision-calculation
2551 and -display for floating point numbers you may alternatively provide a
2552 @code{printf} format specifier to reformat the Calc result after it has been
2553 passed back to Org instead of letting Calc already do the
2554 formatting@footnote{The @code{printf} reformatting is limited in precision
2555 because the value passed to it is converted into an @code{integer} or
2556 @code{double}. The @code{integer} is limited in size by truncating the
2557 signed value to 32 bits. The @code{double} is limited in precision to 64
2558 bits overall which leaves approximately 16 significant decimal digits.}.
2562 $1+$2 @r{Sum of first and second field}
2563 $1+$2;%.2f @r{Same, format result to two decimals}
2564 exp($2)+exp($1) @r{Math functions can be used}
2565 $0;%.1f @r{Reformat current cell to 1 decimal}
2566 ($3-32)*5/9 @r{Degrees F -> C conversion}
2567 $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}}
2568 tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1}
2569 sin($1);Dp3%.1e @r{Same, but use printf specifier for display}
2570 vmean($2..$7) @r{Compute column range mean, using vector function}
2571 vmean($2..$7);EN @r{Same, but treat empty fields as 0}
2572 taylor($3,x=7,2) @r{Taylor series of $3, at x=7, second degree}
2575 Calc also contains a complete set of logical operations. For example
2578 if($1<20,teen,string("")) @r{"teen" if age $1 less than 20, else empty}
2581 Note that you can also use two org-specific flags @code{T} and @code{t} for
2582 durations computations @ref{Durations and time values}.
2584 @node Formula syntax for Lisp, Durations and time values, Formula syntax for Calc, The spreadsheet
2585 @subsection Emacs Lisp forms as formulas
2586 @cindex Lisp forms, as table formulas
2588 It is also possible to write a formula in Emacs Lisp; this can be useful for
2589 string manipulation and control structures, if Calc's functionality is not
2590 enough. If a formula starts with a single-quote followed by an opening
2591 parenthesis, then it is evaluated as a Lisp form. The evaluation should
2592 return either a string or a number. Just as with @file{calc} formulas, you
2593 can specify modes and a printf format after a semicolon. With Emacs Lisp
2594 forms, you need to be conscious about the way field references are
2595 interpolated into the form. By default, a reference will be interpolated as
2596 a Lisp string (in double-quotes) containing the field. If you provide the
2597 @samp{N} mode switch, all referenced elements will be numbers (non-number
2598 fields will be zero) and interpolated as Lisp numbers, without quotes. If
2599 you provide the @samp{L} flag, all fields will be interpolated literally,
2600 without quotes. I.e., if you want a reference to be interpreted as a string
2601 by the Lisp form, enclose the reference operator itself in double-quotes,
2602 like @code{"$3"}. Ranges are inserted as space-separated fields, so you can
2603 embed them in list or vector syntax. Here are a few examples---note how the
2604 @samp{N} mode is used when we do computations in Lisp:
2607 @r{Swap the first two characters of the content of column 1}
2608 '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
2609 @r{Add columns 1 and 2, equivalent to Calc's @code{$1+$2}}
2611 @r{Compute the sum of columns 1-4, like Calc's @code{vsum($1..$4)}}
2612 '(apply '+ '($1..$4));N
2615 @node Durations and time values, Field and range formulas, Formula syntax for Lisp, The spreadsheet
2616 @subsection Durations and time values
2617 @cindex Duration, computing
2618 @cindex Time, computing
2619 @vindex org-table-duration-custom-format
2621 If you want to compute time values use the @code{T} flag, either in Calc
2622 formulas or Elisp formulas:
2626 | Task 1 | Task 2 | Total |
2627 |---------+----------+----------|
2628 | 2:12 | 1:47 | 03:59:00 |
2629 | 3:02:20 | -2:07:00 | 0.92 |
2630 #+TBLFM: @@2$3=$1+$2;T::@@3$3=$1+$2;t
2634 Input duration values must be of the form @code{[HH:MM[:SS]}, where seconds
2635 are optional. With the @code{T} flag, computed durations will be displayed
2636 as @code{[HH:MM:SS} (see the first formula above). With the @code{t} flag,
2637 computed durations will be displayed according to the value of the variable
2638 @code{org-table-duration-custom-format}, which defaults to @code{'hours} and
2639 will display the result as a fraction of hours (see the second formula in the
2642 Negative duration values can be manipulated as well, and integers will be
2643 considered as seconds in addition and subtraction.
2645 @node Field and range formulas, Column formulas, Durations and time values, The spreadsheet
2646 @subsection Field and range formulas
2647 @cindex field formula
2648 @cindex range formula
2649 @cindex formula, for individual table field
2650 @cindex formula, for range of fields
2652 To assign a formula to a particular field, type it directly into the field,
2653 preceded by @samp{:=}, for example @samp{:=vsum(@@II..III)}. When you press
2654 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2655 the formula will be stored as the formula for this field, evaluated, and the
2656 current field will be replaced with the result.
2659 Formulas are stored in a special line starting with @samp{#+TBLFM:} directly
2660 below the table. If you type the equation in the 4th field of the 3rd data
2661 line in the table, the formula will look like @samp{@@3$4=$1+$2}. When
2662 inserting/deleting/swapping column and rows with the appropriate commands,
2663 @i{absolute references} (but not relative ones) in stored formulas are
2664 modified in order to still reference the same field. To avoid this from
2665 happening, in particular in range references, anchor ranges at the table
2666 borders (using @code{@@<}, @code{@@>}, @code{$<}, @code{$>}), or at hlines
2667 using the @code{@@I} notation. Automatic adaptation of field references does
2668 of cause not happen if you edit the table structure with normal editing
2669 commands---then you must fix the equations yourself.
2671 Instead of typing an equation into the field, you may also use the following
2675 @orgcmd{C-u C-c =,org-table-eval-formula}
2676 Install a new formula for the current field. The command prompts for a
2677 formula with default taken from the @samp{#+TBLFM:} line, applies
2678 it to the current field, and stores it.
2681 The left-hand side of a formula can also be a special expression in order to
2682 assign the formula to a number of different fields. There is no keyboard
2683 shortcut to enter such range formulas. To add them, use the formula editor
2684 (@pxref{Editing and debugging formulas}) or edit the @code{#+TBLFM:} line
2689 Column formula, valid for the entire column. This is so common that Org
2690 treats these formulas in a special way, see @ref{Column formulas}.
2692 Row formula, applies to all fields in the specified row. @code{@@>=} means
2695 Range formula, applies to all fields in the given rectangular range. This
2696 can also be used to assign a formula to some but not all fields in a row.
2698 Named field, see @ref{Advanced features}.
2701 @node Column formulas, Editing and debugging formulas, Field and range formulas, The spreadsheet
2702 @subsection Column formulas
2703 @cindex column formula
2704 @cindex formula, for table column
2706 When you assign a formula to a simple column reference like @code{$3=}, the
2707 same formula will be used in all fields of that column, with the following
2708 very convenient exceptions: (i) If the table contains horizontal separator
2709 hlines, everything before the first such line is considered part of the table
2710 @emph{header} and will not be modified by column formulas. (ii) Fields that
2711 already get a value from a field/range formula will be left alone by column
2712 formulas. These conditions make column formulas very easy to use.
2714 To assign a formula to a column, type it directly into any field in the
2715 column, preceded by an equal sign, like @samp{=$1+$2}. When you press
2716 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2717 the formula will be stored as the formula for the current column, evaluated
2718 and the current field replaced with the result. If the field contains only
2719 @samp{=}, the previously stored formula for this column is used. For each
2720 column, Org will only remember the most recently used formula. In the
2721 @samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}. The
2722 left-hand side of a column formula can not be the name of column, it must be
2723 the numeric column reference or @code{$>}.
2725 Instead of typing an equation into the field, you may also use the
2729 @orgcmd{C-c =,org-table-eval-formula}
2730 Install a new formula for the current column and replace current field with
2731 the result of the formula. The command prompts for a formula, with default
2732 taken from the @samp{#+TBLFM} line, applies it to the current field and
2733 stores it. With a numeric prefix argument(e.g.@: @kbd{C-5 C-c =}) the command
2734 will apply it to that many consecutive fields in the current column.
2737 @node Editing and debugging formulas, Updating the table, Column formulas, The spreadsheet
2738 @subsection Editing and debugging formulas
2739 @cindex formula editing
2740 @cindex editing, of table formulas
2742 @vindex org-table-use-standard-references
2743 You can edit individual formulas in the minibuffer or directly in the
2744 field. Org can also prepare a special buffer with all active
2745 formulas of a table. When offering a formula for editing, Org
2746 converts references to the standard format (like @code{B3} or @code{D&})
2747 if possible. If you prefer to only work with the internal format (like
2748 @code{@@3$2} or @code{$4}), configure the variable
2749 @code{org-table-use-standard-references}.
2752 @orgcmdkkc{C-c =,C-u C-c =,org-table-eval-formula}
2753 Edit the formula associated with the current column/field in the
2754 minibuffer. See @ref{Column formulas}, and @ref{Field and range formulas}.
2755 @orgcmd{C-u C-u C-c =,org-table-eval-formula}
2756 Re-insert the active formula (either a
2757 field formula, or a column formula) into the current field, so that you
2758 can edit it directly in the field. The advantage over editing in the
2759 minibuffer is that you can use the command @kbd{C-c ?}.
2760 @orgcmd{C-c ?,org-table-field-info}
2761 While editing a formula in a table field, highlight the field(s)
2762 referenced by the reference at the cursor position in the formula.
2764 @findex org-table-toggle-coordinate-overlays
2766 Toggle the display of row and column numbers for a table, using overlays
2767 (@command{org-table-toggle-coordinate-overlays}). These are updated each
2768 time the table is aligned; you can force it with @kbd{C-c C-c}.
2770 @findex org-table-toggle-formula-debugger
2772 Toggle the formula debugger on and off
2773 (@command{org-table-toggle-formula-debugger}). See below.
2774 @orgcmd{C-c ',org-table-edit-formulas}
2775 Edit all formulas for the current table in a special buffer, where the
2776 formulas will be displayed one per line. If the current field has an
2777 active formula, the cursor in the formula editor will mark it.
2778 While inside the special buffer, Org will automatically highlight
2779 any field or range reference at the cursor position. You may edit,
2780 remove and add formulas, and use the following commands:
2782 @orgcmdkkc{C-c C-c,C-x C-s,org-table-fedit-finish}
2783 Exit the formula editor and store the modified formulas. With @kbd{C-u}
2784 prefix, also apply the new formulas to the entire table.
2785 @orgcmd{C-c C-q,org-table-fedit-abort}
2786 Exit the formula editor without installing changes.
2787 @orgcmd{C-c C-r,org-table-fedit-toggle-ref-type}
2788 Toggle all references in the formula editor between standard (like
2789 @code{B3}) and internal (like @code{@@3$2}).
2790 @orgcmd{@key{TAB},org-table-fedit-lisp-indent}
2791 Pretty-print or indent Lisp formula at point. When in a line containing
2792 a Lisp formula, format the formula according to Emacs Lisp rules.
2793 Another @key{TAB} collapses the formula back again. In the open
2794 formula, @key{TAB} re-indents just like in Emacs Lisp mode.
2795 @orgcmd{M-@key{TAB},lisp-complete-symbol}
2796 Complete Lisp symbols, just like in Emacs Lisp mode.
2798 @kindex S-@key{down}
2799 @kindex S-@key{left}
2800 @kindex S-@key{right}
2801 @findex org-table-fedit-ref-up
2802 @findex org-table-fedit-ref-down
2803 @findex org-table-fedit-ref-left
2804 @findex org-table-fedit-ref-right
2805 @item S-@key{up}/@key{down}/@key{left}/@key{right}
2806 Shift the reference at point. For example, if the reference is
2807 @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
2808 This also works for relative references and for hline references.
2809 @orgcmdkkcc{M-S-@key{up},M-S-@key{down},org-table-fedit-line-up,org-table-fedit-line-down}
2810 Move the test line for column formulas in the Org buffer up and
2812 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-fedit-scroll-down,org-table-fedit-scroll-up}
2813 Scroll the window displaying the table.
2815 @findex org-table-toggle-coordinate-overlays
2817 Turn the coordinate grid in the table on and off.
2821 Making a table field blank does not remove the formula associated with
2822 the field, because that is stored in a different line (the @samp{#+TBLFM}
2823 line)---during the next recalculation the field will be filled again.
2824 To remove a formula from a field, you have to give an empty reply when
2825 prompted for the formula, or to edit the @samp{#+TBLFM} line.
2828 You may edit the @samp{#+TBLFM} directly and re-apply the changed
2829 equations with @kbd{C-c C-c} in that line or with the normal
2830 recalculation commands in the table.
2832 @subsubheading Debugging formulas
2833 @cindex formula debugging
2834 @cindex debugging, of table formulas
2835 When the evaluation of a formula leads to an error, the field content
2836 becomes the string @samp{#ERROR}. If you would like see what is going
2837 on during variable substitution and calculation in order to find a bug,
2838 turn on formula debugging in the @code{Tbl} menu and repeat the
2839 calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
2840 field. Detailed information will be displayed.
2842 @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet
2843 @subsection Updating the table
2844 @cindex recomputing table fields
2845 @cindex updating, table
2847 Recalculation of a table is normally not automatic, but needs to be
2848 triggered by a command. See @ref{Advanced features}, for a way to make
2849 recalculation at least semi-automatic.
2851 In order to recalculate a line of a table or the entire table, use the
2855 @orgcmd{C-c *,org-table-recalculate}
2856 Recalculate the current row by first applying the stored column formulas
2857 from left to right, and all field/range formulas in the current row.
2863 Recompute the entire table, line by line. Any lines before the first
2864 hline are left alone, assuming that these are part of the table header.
2866 @orgcmdkkc{C-u C-u C-c *,C-u C-u C-c C-c,org-table-iterate}
2867 Iterate the table by recomputing it until no further changes occur.
2868 This may be necessary if some computed fields use the value of other
2869 fields that are computed @i{later} in the calculation sequence.
2870 @item M-x org-table-recalculate-buffer-tables
2871 @findex org-table-recalculate-buffer-tables
2872 Recompute all tables in the current buffer.
2873 @item M-x org-table-iterate-buffer-tables
2874 @findex org-table-iterate-buffer-tables
2875 Iterate all tables in the current buffer, in order to converge table-to-table
2879 @node Advanced features, , Updating the table, The spreadsheet
2880 @subsection Advanced features
2882 If you want the recalculation of fields to happen automatically, or if you
2883 want to be able to assign @i{names}@footnote{Such names must start by an
2884 alphabetic character and use only alphanumeric/underscore characters.} to
2885 fields and columns, you need to reserve the first column of the table for
2886 special marking characters.
2889 @orgcmd{C-#,org-table-rotate-recalc-marks}
2890 Rotate the calculation mark in first column through the states @samp{ },
2891 @samp{#}, @samp{*}, @samp{!}, @samp{$}. When there is an active region,
2892 change all marks in the region.
2895 Here is an example of a table that collects exam results of students and
2896 makes use of these features:
2900 |---+---------+--------+--------+--------+-------+------|
2901 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
2902 |---+---------+--------+--------+--------+-------+------|
2903 | ! | | P1 | P2 | P3 | Tot | |
2904 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
2905 | ^ | | m1 | m2 | m3 | mt | |
2906 |---+---------+--------+--------+--------+-------+------|
2907 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
2908 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
2909 |---+---------+--------+--------+--------+-------+------|
2910 | | Average | | | | 29.7 | |
2911 | ^ | | | | | at | |
2912 | $ | max=50 | | | | | |
2913 |---+---------+--------+--------+--------+-------+------|
2914 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
2918 @noindent @b{Important}: please note that for these special tables,
2919 recalculating the table with @kbd{C-u C-c *} will only affect rows that
2920 are marked @samp{#} or @samp{*}, and fields that have a formula assigned
2921 to the field itself. The column formulas are not applied in rows with
2924 @cindex marking characters, tables
2925 The marking characters have the following meaning:
2928 The fields in this line define names for the columns, so that you may
2929 refer to a column as @samp{$Tot} instead of @samp{$6}.
2931 This row defines names for the fields @emph{above} the row. With such
2932 a definition, any formula in the table may use @samp{$m1} to refer to
2933 the value @samp{10}. Also, if you assign a formula to a names field, it
2934 will be stored as @samp{$name=...}.
2936 Similar to @samp{^}, but defines names for the fields in the row
2939 Fields in this row can define @emph{parameters} for formulas. For
2940 example, if a field in a @samp{$} row contains @samp{max=50}, then
2941 formulas in this table can refer to the value 50 using @samp{$max}.
2942 Parameters work exactly like constants, only that they can be defined on
2945 Fields in this row are automatically recalculated when pressing
2946 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row
2947 is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked
2948 lines will be left alone by this command.
2950 Selects this line for global recalculation with @kbd{C-u C-c *}, but
2951 not for automatic recalculation. Use this when automatic
2952 recalculation slows down editing too much.
2954 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
2955 All lines that should be recalculated should be marked with @samp{#}
2958 Do not export this line. Useful for lines that contain the narrowing
2959 @samp{<N>} markers or column group markers.
2962 Finally, just to whet your appetite for what can be done with the
2963 fantastic @file{calc.el} package, here is a table that computes the Taylor
2964 series of degree @code{n} at location @code{x} for a couple of
2969 |---+-------------+---+-----+--------------------------------------|
2970 | | Func | n | x | Result |
2971 |---+-------------+---+-----+--------------------------------------|
2972 | # | exp(x) | 1 | x | 1 + x |
2973 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
2974 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
2975 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
2976 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
2977 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
2978 |---+-------------+---+-----+--------------------------------------|
2979 #+TBLFM: $5=taylor($2,$4,$3);n3
2983 @node Org-Plot, , The spreadsheet, Tables
2985 @cindex graph, in tables
2986 @cindex plot tables using Gnuplot
2989 Org-Plot can produce 2D and 3D graphs of information stored in org tables
2990 using @file{Gnuplot} @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
2991 @uref{http://cars9.uchicago.edu/~ravel/software/gnuplot-mode.html}. To see
2992 this in action, ensure that you have both Gnuplot and Gnuplot mode installed
2993 on your system, then call @code{org-plot/gnuplot} on the following table.
2997 #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
2998 | Sede | Max cites | H-index |
2999 |-----------+-----------+---------|
3000 | Chile | 257.72 | 21.39 |
3001 | Leeds | 165.77 | 19.68 |
3002 | Sao Paolo | 71.00 | 11.50 |
3003 | Stockholm | 134.19 | 14.33 |
3004 | Morelia | 257.56 | 17.67 |
3008 Notice that Org Plot is smart enough to apply the table's headers as labels.
3009 Further control over the labels, type, content, and appearance of plots can
3010 be exercised through the @code{#+PLOT:} lines preceding a table. See below
3011 for a complete list of Org-plot options. For more information and examples
3012 see the Org-plot tutorial at
3013 @uref{http://orgmode.org/worg/org-tutorials/org-plot.html}.
3015 @subsubheading Plot Options
3019 Specify any @command{gnuplot} option to be set when graphing.
3022 Specify the title of the plot.
3025 Specify which column of the table to use as the @code{x} axis.
3028 Specify the columns to graph as a Lisp style list, surrounded by parentheses
3029 and separated by spaces for example @code{dep:(3 4)} to graph the third and
3030 fourth columns (defaults to graphing all other columns aside from the @code{ind}
3034 Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
3037 Specify a @code{with} option to be inserted for every col being plotted
3038 (e.g.@: @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
3039 Defaults to @code{lines}.
3042 If you want to plot to a file, specify @code{"@var{path/to/desired/output-file}"}.
3045 List of labels to be used for the @code{deps} (defaults to the column headers
3049 Specify an entire line to be inserted in the Gnuplot script.
3052 When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
3053 flat mapping rather than a @code{3d} slope.
3056 Specify format of Org mode timestamps as they will be parsed by Gnuplot.
3057 Defaults to @samp{%Y-%m-%d-%H:%M:%S}.
3060 If you want total control, you can specify a script file (place the file name
3061 between double-quotes) which will be used to plot. Before plotting, every
3062 instance of @code{$datafile} in the specified script will be replaced with
3063 the path to the generated data file. Note: even if you set this option, you
3064 may still want to specify the plot type, as that can impact the content of
3068 @node Hyperlinks, TODO Items, Tables, Top
3072 Like HTML, Org provides links inside a file, external links to
3073 other files, Usenet articles, emails, and much more.
3076 * Link format:: How links in Org are formatted
3077 * Internal links:: Links to other places in the current file
3078 * External links:: URL-like links to the world
3079 * Handling links:: Creating, inserting and following
3080 * Using links outside Org:: Linking from my C source code?
3081 * Link abbreviations:: Shortcuts for writing complex links
3082 * Search options:: Linking to a specific location
3083 * Custom searches:: When the default search is not enough
3086 @node Link format, Internal links, Hyperlinks, Hyperlinks
3087 @section Link format
3089 @cindex format, of links
3091 Org will recognize plain URL-like links and activate them as
3092 clickable links. The general link format, however, looks like this:
3095 [[link][description]] @r{or alternatively} [[link]]
3099 Once a link in the buffer is complete (all brackets present), Org
3100 will change the display so that @samp{description} is displayed instead
3101 of @samp{[[link][description]]} and @samp{link} is displayed instead of
3102 @samp{[[link]]}. Links will be highlighted in the face @code{org-link},
3103 which by default is an underlined face. You can directly edit the
3104 visible part of a link. Note that this can be either the @samp{link}
3105 part (if there is no description) or the @samp{description} part. To
3106 edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
3109 If you place the cursor at the beginning or just behind the end of the
3110 displayed text and press @key{BACKSPACE}, you will remove the
3111 (invisible) bracket at that location. This makes the link incomplete
3112 and the internals are again displayed as plain text. Inserting the
3113 missing bracket hides the link internals again. To show the
3114 internal structure of all links, use the menu entry
3115 @code{Org->Hyperlinks->Literal links}.
3117 @node Internal links, External links, Link format, Hyperlinks
3118 @section Internal links
3119 @cindex internal links
3120 @cindex links, internal
3121 @cindex targets, for links
3123 @cindex property, CUSTOM_ID
3124 If the link does not look like a URL, it is considered to be internal in the
3125 current file. The most important case is a link like
3126 @samp{[[#my-custom-id]]} which will link to the entry with the
3127 @code{CUSTOM_ID} property @samp{my-custom-id}. Such custom IDs are very good
3128 for HTML export (@pxref{HTML export}) where they produce pretty section
3129 links. You are responsible yourself to make sure these custom IDs are unique
3132 Links such as @samp{[[My Target]]} or @samp{[[My Target][Find my target]]}
3133 lead to a text search in the current file.
3135 The link can be followed with @kbd{C-c C-o} when the cursor is on the link,
3136 or with a mouse click (@pxref{Handling links}). Links to custom IDs will
3137 point to the corresponding headline. The preferred match for a text link is
3138 a @i{dedicated target}: the same string in double angular brackets. Targets
3139 may be located anywhere; sometimes it is convenient to put them into a
3140 comment line. For example
3146 @noindent In HTML export (@pxref{HTML export}), such targets will become
3147 named anchors for direct access through @samp{http} links@footnote{Note that
3148 text before the first headline is usually not exported, so the first such
3149 target should be after the first headline, or in the line directly before the
3152 If no dedicated target exists, Org will search for a headline that is exactly
3153 the link text but may also include a TODO keyword and tags@footnote{To insert
3154 a link targeting a headline, in-buffer completion can be used. Just type a
3155 star followed by a few optional letters into the buffer and press
3156 @kbd{M-@key{TAB}}. All headlines in the current buffer will be offered as
3157 completions.}. In non-Org files, the search will look for the words in the
3158 link text. In the above example the search would be for @samp{my target}.
3160 Following a link pushes a mark onto Org's own mark ring. You can
3161 return to the previous position with @kbd{C-c &}. Using this command
3162 several times in direct succession goes back to positions recorded
3166 * Radio targets:: Make targets trigger links in plain text
3169 @node Radio targets, , Internal links, Internal links
3170 @subsection Radio targets
3171 @cindex radio targets
3172 @cindex targets, radio
3173 @cindex links, radio targets
3175 Org can automatically turn any occurrences of certain target names
3176 in normal text into a link. So without explicitly creating a link, the
3177 text connects to the target radioing its position. Radio targets are
3178 enclosed by triple angular brackets. For example, a target @samp{<<<My
3179 Target>>>} causes each occurrence of @samp{my target} in normal text to
3180 become activated as a link. The Org file is scanned automatically
3181 for radio targets only when the file is first loaded into Emacs. To
3182 update the target list during editing, press @kbd{C-c C-c} with the
3183 cursor on or at a target.
3185 @node External links, Handling links, Internal links, Hyperlinks
3186 @section External links
3187 @cindex links, external
3188 @cindex external links
3189 @cindex links, external
3197 @cindex WANDERLUST links
3199 @cindex USENET links
3204 Org supports links to files, websites, Usenet and email messages,
3205 BBDB database entries and links to both IRC conversations and their
3206 logs. External links are URL-like locators. They start with a short
3207 identifying string followed by a colon. There can be no space after
3208 the colon. The following list shows examples for each link type.
3211 http://www.astro.uva.nl/~dominik @r{on the web}
3212 doi:10.1000/182 @r{DOI for an electronic resource}
3213 file:/home/dominik/images/jupiter.jpg @r{file, absolute path}
3214 /home/dominik/images/jupiter.jpg @r{same as above}
3215 file:papers/last.pdf @r{file, relative path}
3216 ./papers/last.pdf @r{same as above}
3217 file:/myself@@some.where:papers/last.pdf @r{file, path on remote machine}
3218 /myself@@some.where:papers/last.pdf @r{same as above}
3219 file:sometextfile::NNN @r{file, jump to line number}
3220 file:projects.org @r{another Org file}
3221 file:projects.org::some words @r{text search in Org file}@footnote{
3222 The actual behavior of the search will depend on the value of
3223 the variable @code{org-link-search-must-match-exact-headline}. If its value
3224 is nil, then a fuzzy text search will be done. If it is t, then only the
3225 exact headline will be matched. If the value is @code{'query-to-create},
3226 then an exact headline will be searched; if it is not found, then the user
3227 will be queried to create it.}
3228 file:projects.org::*task title @r{heading search in Org file}
3229 file+sys:/path/to/file @r{open via OS, like double-click}
3230 file+emacs:/path/to/file @r{force opening by Emacs}
3231 docview:papers/last.pdf::NNN @r{open in doc-view mode at page}
3232 id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID}
3233 news:comp.emacs @r{Usenet link}
3234 mailto:adent@@galaxy.net @r{Mail link}
3235 vm:folder @r{VM folder link}
3236 vm:folder#id @r{VM message link}
3237 vm://myself@@some.where.org/folder#id @r{VM on remote machine}
3238 wl:folder @r{WANDERLUST folder link}
3239 wl:folder#id @r{WANDERLUST message link}
3240 mhe:folder @r{MH-E folder link}
3241 mhe:folder#id @r{MH-E message link}
3242 rmail:folder @r{RMAIL folder link}
3243 rmail:folder#id @r{RMAIL message link}
3244 gnus:group @r{Gnus group link}
3245 gnus:group#id @r{Gnus article link}
3246 bbdb:R.*Stallman @r{BBDB link (with regexp)}
3247 irc:/irc.com/#emacs/bob @r{IRC link}
3248 info:org#External links @r{Info node link}
3249 shell:ls *.org @r{A shell command}
3250 elisp:org-agenda @r{Interactive Elisp command}
3251 elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
3254 For customizing Org to add new link types @ref{Adding hyperlink types}.
3256 A link should be enclosed in double brackets and may contain a
3257 descriptive text to be displayed instead of the URL (@pxref{Link
3258 format}), for example:
3261 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
3265 If the description is a file name or URL that points to an image, HTML
3266 export (@pxref{HTML export}) will inline the image as a clickable
3267 button. If there is no description at all and the link points to an
3269 that image will be inlined into the exported HTML file.
3271 @cindex square brackets, around links
3272 @cindex plain text external links
3273 Org also finds external links in the normal text and activates them
3274 as links. If spaces must be part of the link (for example in
3275 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
3276 about the end of the link, enclose them in square brackets.
3278 @node Handling links, Using links outside Org, External links, Hyperlinks
3279 @section Handling links
3280 @cindex links, handling
3282 Org provides methods to create a link in the correct syntax, to
3283 insert it into an Org file, and to follow the link.
3286 @orgcmd{C-c l,org-store-link}
3287 @cindex storing links
3288 Store a link to the current location. This is a @emph{global} command (you
3289 must create the key binding yourself) which can be used in any buffer to
3290 create a link. The link will be stored for later insertion into an Org
3291 buffer (see below). What kind of link will be created depends on the current
3294 @b{Org mode buffers}@*
3295 For Org files, if there is a @samp{<<target>>} at the cursor, the link points
3296 to the target. Otherwise it points to the current headline, which will also
3297 be the description@footnote{If the headline contains a timestamp, it will be
3298 removed from the link and result in a wrong link -- you should avoid putting
3299 timestamp in the headline.}.
3301 @vindex org-link-to-org-use-id
3302 @cindex property, CUSTOM_ID
3303 @cindex property, ID
3304 If the headline has a @code{CUSTOM_ID} property, a link to this custom ID
3305 will be stored. In addition or alternatively (depending on the value of
3306 @code{org-link-to-org-use-id}), a globally unique @code{ID} property will be
3307 created and/or used to construct a link. So using this command in Org
3308 buffers will potentially create two links: a human-readable from the custom
3309 ID, and one that is globally unique and works even if the entry is moved from
3310 file to file. Later, when inserting the link, you need to decide which one
3313 @b{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus}@*
3314 Pretty much all Emacs mail clients are supported. The link will point to the
3315 current article, or, in some GNUS buffers, to the group. The description is
3316 constructed from the author and the subject.
3318 @b{Web browsers: W3 and W3M}@*
3319 Here the link will be the current URL, with the page title as description.
3321 @b{Contacts: BBDB}@*
3322 Links created in a BBDB buffer will point to the current entry.
3325 @vindex org-irc-link-to-logs
3326 For IRC links, if you set the variable @code{org-irc-link-to-logs} to
3327 @code{t}, a @samp{file:/} style link to the relevant point in the logs for
3328 the current conversation is created. Otherwise an @samp{irc:/} style link to
3329 the user/channel/server under the point will be stored.
3332 For any other files, the link will point to the file, with a search string
3333 (@pxref{Search options}) pointing to the contents of the current line. If
3334 there is an active region, the selected words will form the basis of the
3335 search string. If the automatically created link is not working correctly or
3336 accurately enough, you can write custom functions to select the search string
3337 and to do the search for particular file types---see @ref{Custom searches}.
3338 The key binding @kbd{C-c l} is only a suggestion---see @ref{Installation}.
3341 When the cursor is in an agenda view, the created link points to the
3342 entry referenced by the current line.
3345 @orgcmd{C-c C-l,org-insert-link}
3346 @cindex link completion
3347 @cindex completion, of links
3348 @cindex inserting links
3349 @vindex org-keep-stored-link-after-insertion
3350 Insert a link@footnote{ Note that you don't have to use this command to
3351 insert a link. Links in Org are plain text, and you can type or paste them
3352 straight into the buffer. By using this command, the links are automatically
3353 enclosed in double brackets, and you will be asked for the optional
3354 descriptive text.}. This prompts for a link to be inserted into the buffer.
3355 You can just type a link, using text for an internal link, or one of the link
3356 type prefixes mentioned in the examples above. The link will be inserted
3357 into the buffer@footnote{After insertion of a stored link, the link will be
3358 removed from the list of stored links. To keep it in the list later use, use
3359 a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
3360 @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
3361 If some text was selected when this command is called, the selected text
3362 becomes the default description.
3364 @b{Inserting stored links}@*
3365 All links stored during the
3366 current session are part of the history for this prompt, so you can access
3367 them with @key{up} and @key{down} (or @kbd{M-p/n}).
3369 @b{Completion support}@* Completion with @key{TAB} will help you to insert
3370 valid link prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
3371 defined through link abbreviations (@pxref{Link abbreviations}). If you
3372 press @key{RET} after inserting only the @var{prefix}, Org will offer
3373 specific completion support for some link types@footnote{This works by
3374 calling a special function @code{org-PREFIX-complete-link}.} For
3375 example, if you type @kbd{file @key{RET}}, file name completion (alternative
3376 access: @kbd{C-u C-c C-l}, see below) will be offered, and after @kbd{bbdb
3377 @key{RET}} you can complete contact names.
3379 @cindex file name completion
3380 @cindex completion, of file names
3381 When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
3382 a file will be inserted and you may use file name completion to select
3383 the name of the file. The path to the file is inserted relative to the
3384 directory of the current Org file, if the linked file is in the current
3385 directory or in a sub-directory of it, or if the path is written relative
3386 to the current directory using @samp{../}. Otherwise an absolute path
3387 is used, if possible with @samp{~/} for your home directory. You can
3388 force an absolute path with two @kbd{C-u} prefixes.
3390 @item C-c C-l @ @r{(with cursor on existing link)}
3391 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
3392 link and description parts of the link.
3394 @cindex following links
3395 @orgcmd{C-c C-o,org-open-at-point}
3396 @vindex org-file-apps
3397 @vindex org-link-frame-setup
3398 Open link at point. This will launch a web browser for URLs (using
3399 @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
3400 the corresponding links, and execute the command in a shell link. When the
3401 cursor is on an internal link, this command runs the corresponding search.
3402 When the cursor is on a TAG list in a headline, it creates the corresponding
3403 TAGS view. If the cursor is on a timestamp, it compiles the agenda for that
3404 date. Furthermore, it will visit text and remote files in @samp{file:} links
3405 with Emacs and select a suitable application for local non-text files.
3406 Classification of files is based on file extension only. See option
3407 @code{org-file-apps}. If you want to override the default application and
3408 visit the file with Emacs, use a @kbd{C-u} prefix. If you want to avoid
3409 opening in Emacs, use a @kbd{C-u C-u} prefix.@*
3410 If the cursor is on a headline, but not on a link, offer all links in the
3411 headline and entry text. If you want to setup the frame configuration for
3412 following links, customize @code{org-link-frame-setup}.
3415 @vindex org-return-follows-link
3416 When @code{org-return-follows-link} is set, @kbd{@key{RET}} will also follow
3423 On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
3424 would. Under Emacs 22 and later, @kbd{mouse-1} will also follow a link.
3428 @vindex org-display-internal-link-with-indirect-buffer
3429 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
3430 internal links to be displayed in another window@footnote{See the
3431 variable @code{org-display-internal-link-with-indirect-buffer}}.
3433 @orgcmd{C-c C-x C-v,org-toggle-inline-images}
3434 @cindex inlining images
3435 @cindex images, inlining
3436 @vindex org-startup-with-inline-images
3437 @cindex @code{inlineimages}, STARTUP keyword
3438 @cindex @code{noinlineimages}, STARTUP keyword
3439 Toggle the inline display of linked images. Normally this will only inline
3440 images that have no description part in the link, i.e.@: images that will also
3441 be inlined during export. When called with a prefix argument, also display
3442 images that do have a link description. You can ask for inline images to be
3443 displayed at startup by configuring the variable
3444 @code{org-startup-with-inline-images}@footnote{with corresponding
3445 @code{#+STARTUP} keywords @code{inlineimages} and @code{inlineimages}}.
3446 @orgcmd{C-c %,org-mark-ring-push}
3448 Push the current position onto the mark ring, to be able to return
3449 easily. Commands following an internal link do this automatically.
3451 @orgcmd{C-c &,org-mark-ring-goto}
3452 @cindex links, returning to
3453 Jump back to a recorded position. A position is recorded by the
3454 commands following internal links, and by @kbd{C-c %}. Using this
3455 command several times in direct succession moves through a ring of
3456 previously recorded positions.
3458 @orgcmdkkcc{C-c C-x C-n,C-c C-x C-p,org-next-link,org-previous-link}
3459 @cindex links, finding next/previous
3460 Move forward/backward to the next link in the buffer. At the limit of
3461 the buffer, the search fails once, and then wraps around. The key
3462 bindings for this are really too long; you might want to bind this also
3463 to @kbd{C-n} and @kbd{C-p}
3465 (add-hook 'org-load-hook
3467 (define-key org-mode-map "\C-n" 'org-next-link)
3468 (define-key org-mode-map "\C-p" 'org-previous-link)))
3472 @node Using links outside Org, Link abbreviations, Handling links, Hyperlinks
3473 @section Using links outside Org
3475 You can insert and follow links that have Org syntax not only in
3476 Org, but in any Emacs buffer. For this, you should create two
3477 global commands, like this (please select suitable global keys
3481 (global-set-key "\C-c L" 'org-insert-link-global)
3482 (global-set-key "\C-c o" 'org-open-at-point-global)
3485 @node Link abbreviations, Search options, Using links outside Org, Hyperlinks
3486 @section Link abbreviations
3487 @cindex link abbreviations
3488 @cindex abbreviation, links
3490 Long URLs can be cumbersome to type, and often many similar links are
3491 needed in a document. For this you can use link abbreviations. An
3492 abbreviated link looks like this
3495 [[linkword:tag][description]]
3499 @vindex org-link-abbrev-alist
3500 where the tag is optional.
3501 The @i{linkword} must be a word, starting with a letter, followed by
3502 letters, numbers, @samp{-}, and @samp{_}. Abbreviations are resolved
3503 according to the information in the variable @code{org-link-abbrev-alist}
3504 that relates the linkwords to replacement text. Here is an example:
3508 (setq org-link-abbrev-alist
3509 '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
3510 ("google" . "http://www.google.com/search?q=")
3511 ("gmap" . "http://maps.google.com/maps?q=%s")
3512 ("omap" . "http://nominatim.openstreetmap.org/search?q=%s&polygon=1")
3513 ("ads" . "http://adsabs.harvard.edu/cgi-bin/nph-abs_connect?author=%s&db_key=AST")))
3517 If the replacement text contains the string @samp{%s}, it will be
3518 replaced with the tag. Otherwise the tag will be appended to the string
3519 in order to create the link. You may also specify a function that will
3520 be called with the tag as the only argument to create the link.
3522 With the above setting, you could link to a specific bug with
3523 @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
3524 @code{[[google:OrgMode]]}, show the map location of the Free Software
3525 Foundation @code{[[gmap:51 Franklin Street, Boston]]} or of Carsten office
3526 @code{[[omap:Science Park 904, Amsterdam, The Netherlands]]} and find out
3527 what the Org author is doing besides Emacs hacking with
3528 @code{[[ads:Dominik,C]]}.
3530 If you need special abbreviations just for a single Org buffer, you
3531 can define them in the file with
3535 #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
3536 #+LINK: google http://www.google.com/search?q=%s
3540 In-buffer completion (@pxref{Completion}) can be used after @samp{[} to
3541 complete link abbreviations. You may also define a function
3542 @code{org-PREFIX-complete-link} that implements special (e.g.@: completion)
3543 support for inserting such a link with @kbd{C-c C-l}. Such a function should
3544 not accept any arguments, and return the full link with prefix.
3546 @node Search options, Custom searches, Link abbreviations, Hyperlinks
3547 @section Search options in file links
3548 @cindex search option in file links
3549 @cindex file links, searching
3551 File links can contain additional information to make Emacs jump to a
3552 particular location in the file when following a link. This can be a
3553 line number or a search option after a double@footnote{For backward
3554 compatibility, line numbers can also follow a single colon.} colon. For
3555 example, when the command @kbd{C-c l} creates a link (@pxref{Handling
3556 links}) to a file, it encodes the words in the current line as a search
3557 string that can be used to find this line back later when following the
3558 link with @kbd{C-c C-o}.
3560 Here is the syntax of the different ways to attach a search to a file
3561 link, together with an explanation:
3564 [[file:~/code/main.c::255]]
3565 [[file:~/xx.org::My Target]]
3566 [[file:~/xx.org::*My Target]]
3567 [[file:~/xx.org::#my-custom-id]]
3568 [[file:~/xx.org::/regexp/]]
3575 Search for a link target @samp{<<My Target>>}, or do a text search for
3576 @samp{my target}, similar to the search in internal links, see
3577 @ref{Internal links}. In HTML export (@pxref{HTML export}), such a file
3578 link will become an HTML reference to the corresponding named anchor in
3581 In an Org file, restrict search to headlines.
3583 Link to a heading with a @code{CUSTOM_ID} property
3585 Do a regular expression search for @code{regexp}. This uses the Emacs
3586 command @code{occur} to list all matches in a separate window. If the
3587 target file is in Org mode, @code{org-occur} is used to create a
3588 sparse tree with the matches.
3589 @c If the target file is a directory,
3590 @c @code{grep} will be used to search all files in the directory.
3593 As a degenerate case, a file link with an empty file name can be used
3594 to search the current file. For example, @code{[[file:::find me]]} does
3595 a search for @samp{find me} in the current file, just as
3596 @samp{[[find me]]} would.
3598 @node Custom searches, , Search options, Hyperlinks
3599 @section Custom Searches
3600 @cindex custom search strings
3601 @cindex search strings, custom
3603 The default mechanism for creating search strings and for doing the
3604 actual search related to a file link may not work correctly in all
3605 cases. For example, Bib@TeX{} database files have many entries like
3606 @samp{year="1993"} which would not result in good search strings,
3607 because the only unique identification for a Bib@TeX{} entry is the
3610 @vindex org-create-file-search-functions
3611 @vindex org-execute-file-search-functions
3612 If you come across such a problem, you can write custom functions to set
3613 the right search string for a particular file type, and to do the search
3614 for the string in the file. Using @code{add-hook}, these functions need
3615 to be added to the hook variables
3616 @code{org-create-file-search-functions} and
3617 @code{org-execute-file-search-functions}. See the docstring for these
3618 variables for more information. Org actually uses this mechanism
3619 for Bib@TeX{} database files, and you can use the corresponding code as
3620 an implementation example. See the file @file{org-bibtex.el}.
3622 @node TODO Items, Tags, Hyperlinks, Top
3626 Org mode does not maintain TODO lists as separate documents@footnote{Of
3627 course, you can make a document that contains only long lists of TODO items,
3628 but this is not required.}. Instead, TODO items are an integral part of the
3629 notes file, because TODO items usually come up while taking notes! With Org
3630 mode, simply mark any entry in a tree as being a TODO item. In this way,
3631 information is not duplicated, and the entire context from which the TODO
3632 item emerged is always present.
3634 Of course, this technique for managing TODO items scatters them
3635 throughout your notes file. Org mode compensates for this by providing
3636 methods to give you an overview of all the things that you have to do.
3639 * TODO basics:: Marking and displaying TODO entries
3640 * TODO extensions:: Workflow and assignments
3641 * Progress logging:: Dates and notes for progress
3642 * Priorities:: Some things are more important than others
3643 * Breaking down tasks:: Splitting a task into manageable pieces
3644 * Checkboxes:: Tick-off lists
3647 @node TODO basics, TODO extensions, TODO Items, TODO Items
3648 @section Basic TODO functionality
3650 Any headline becomes a TODO item when it starts with the word
3651 @samp{TODO}, for example:
3654 *** TODO Write letter to Sam Fortune
3658 The most important commands to work with TODO entries are:
3661 @orgcmd{C-c C-t,org-todo}
3662 @cindex cycling, of TODO states
3663 Rotate the TODO state of the current item among
3666 ,-> (unmarked) -> TODO -> DONE --.
3667 '--------------------------------'
3670 The same rotation can also be done ``remotely'' from the timeline and
3671 agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}).
3673 @orgkey{C-u C-c C-t}
3674 Select a specific keyword using completion or (if it has been set up)
3675 the fast selection interface. For the latter, you need to assign keys
3676 to TODO states, see @ref{Per-file keywords}, and @ref{Setting tags}, for
3679 @kindex S-@key{right}
3680 @kindex S-@key{left}
3681 @item S-@key{right} @ @r{/} @ S-@key{left}
3682 @vindex org-treat-S-cursor-todo-selection-as-state-change
3683 Select the following/preceding TODO state, similar to cycling. Useful
3684 mostly if more than two TODO states are possible (@pxref{TODO
3685 extensions}). See also @ref{Conflicts}, for a discussion of the interaction
3686 with @code{shift-selection-mode}. See also the variable
3687 @code{org-treat-S-cursor-todo-selection-as-state-change}.
3688 @orgcmd{C-c / t,org-show-todo-key}
3689 @cindex sparse tree, for TODO
3690 @vindex org-todo-keywords
3691 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds the
3692 entire buffer, but shows all TODO items (with not-DONE state) and the
3693 headings hierarchy above them. With a prefix argument (or by using @kbd{C-c
3694 / T}), search for a specific TODO. You will be prompted for the keyword, and
3695 you can also give a list of keywords like @code{KWD1|KWD2|...} to list
3696 entries that match any one of these keywords. With a numeric prefix argument
3697 N, show the tree for the Nth keyword in the variable
3698 @code{org-todo-keywords}. With two prefix arguments, find all TODO states,
3699 both un-done and done.
3700 @orgcmd{C-c a t,org-todo-list}
3701 Show the global TODO list. Collects the TODO items (with not-DONE states)
3702 from all agenda files (@pxref{Agenda Views}) into a single buffer. The new
3703 buffer will be in @code{agenda-mode}, which provides commands to examine and
3704 manipulate the TODO entries from the new buffer (@pxref{Agenda commands}).
3705 @xref{Global TODO list}, for more information.
3706 @orgcmd{S-M-@key{RET},org-insert-todo-heading}
3707 Insert a new TODO entry below the current one.
3711 @vindex org-todo-state-tags-triggers
3712 Changing a TODO state can also trigger tag changes. See the docstring of the
3713 option @code{org-todo-state-tags-triggers} for details.
3715 @node TODO extensions, Progress logging, TODO basics, TODO Items
3716 @section Extended use of TODO keywords
3717 @cindex extended TODO keywords
3719 @vindex org-todo-keywords
3720 By default, marked TODO entries have one of only two states: TODO and
3721 DONE. Org mode allows you to classify TODO items in more complex ways
3722 with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With
3723 special setup, the TODO keyword system can work differently in different
3726 Note that @i{tags} are another way to classify headlines in general and
3727 TODO items in particular (@pxref{Tags}).
3730 * Workflow states:: From TODO to DONE in steps
3731 * TODO types:: I do this, Fred does the rest
3732 * Multiple sets in one file:: Mixing it all, and still finding your way
3733 * Fast access to TODO states:: Single letter selection of a state
3734 * Per-file keywords:: Different files, different requirements
3735 * Faces for TODO keywords:: Highlighting states
3736 * TODO dependencies:: When one task needs to wait for others
3739 @node Workflow states, TODO types, TODO extensions, TODO extensions
3740 @subsection TODO keywords as workflow states
3741 @cindex TODO workflow
3742 @cindex workflow states as TODO keywords
3744 You can use TODO keywords to indicate different @emph{sequential} states
3745 in the process of working on an item, for example@footnote{Changing
3746 this variable only becomes effective after restarting Org mode in a
3750 (setq org-todo-keywords
3751 '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
3754 The vertical bar separates the TODO keywords (states that @emph{need
3755 action}) from the DONE states (which need @emph{no further action}). If
3756 you don't provide the separator bar, the last state is used as the DONE
3758 @cindex completion, of TODO keywords
3759 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
3760 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED. You may
3761 also use a numeric prefix argument to quickly select a specific state. For
3762 example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY.
3763 Or you can use @kbd{S-@key{left}} to go backward through the sequence. If you
3764 define many keywords, you can use in-buffer completion
3765 (@pxref{Completion}) or even a special one-key selection scheme
3766 (@pxref{Fast access to TODO states}) to insert these words into the
3767 buffer. Changing a TODO state can be logged with a timestamp, see
3768 @ref{Tracking TODO state changes}, for more information.
3770 @node TODO types, Multiple sets in one file, Workflow states, TODO extensions
3771 @subsection TODO keywords as types
3773 @cindex names as TODO keywords
3774 @cindex types as TODO keywords
3776 The second possibility is to use TODO keywords to indicate different
3777 @emph{types} of action items. For example, you might want to indicate
3778 that items are for ``work'' or ``home''. Or, when you work with several
3779 people on a single project, you might want to assign action items
3780 directly to persons, by using their names as TODO keywords. This would
3781 be set up like this:
3784 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
3787 In this case, different keywords do not indicate a sequence, but rather
3788 different types. So the normal work flow would be to assign a task to a
3789 person, and later to mark it DONE. Org mode supports this style by adapting
3790 the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
3791 @kbd{t} command in the timeline and agenda buffers.}. When used several
3792 times in succession, it will still cycle through all names, in order to first
3793 select the right type for a task. But when you return to the item after some
3794 time and execute @kbd{C-c C-t} again, it will switch from any name directly
3795 to DONE. Use prefix arguments or completion to quickly select a specific
3796 name. You can also review the items of a specific TODO type in a sparse tree
3797 by using a numeric prefix to @kbd{C-c / t}. For example, to see all things
3798 Lucy has to do, you would use @kbd{C-3 C-c / t}. To collect Lucy's items
3799 from all agenda files into a single buffer, you would use the numeric prefix
3800 argument as well when creating the global TODO list: @kbd{C-3 C-c a t}.
3802 @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions
3803 @subsection Multiple keyword sets in one file
3804 @cindex TODO keyword sets
3806 Sometimes you may want to use different sets of TODO keywords in
3807 parallel. For example, you may want to have the basic
3808 @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
3809 separate state indicating that an item has been canceled (so it is not
3810 DONE, but also does not require action). Your setup would then look
3814 (setq org-todo-keywords
3815 '((sequence "TODO" "|" "DONE")
3816 (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
3817 (sequence "|" "CANCELED")))
3820 The keywords should all be different, this helps Org mode to keep track
3821 of which subsequence should be used for a given entry. In this setup,
3822 @kbd{C-c C-t} only operates within a subsequence, so it switches from
3823 @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
3824 (nothing) to @code{REPORT}. Therefore you need a mechanism to initially
3825 select the correct sequence. Besides the obvious ways like typing a
3826 keyword or using completion, you may also apply the following commands:
3829 @kindex C-S-@key{right}
3830 @kindex C-S-@key{left}
3831 @kindex C-u C-u C-c C-t
3832 @item C-u C-u C-c C-t
3833 @itemx C-S-@key{right}
3834 @itemx C-S-@key{left}
3835 These keys jump from one TODO subset to the next. In the above example,
3836 @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{right}} would jump from @code{TODO} or
3837 @code{DONE} to @code{REPORT}, and any of the words in the second row to
3838 @code{CANCELED}. Note that the @kbd{C-S-} key binding conflict with
3839 @code{shift-selection-mode} (@pxref{Conflicts}).
3840 @kindex S-@key{right}
3841 @kindex S-@key{left}
3844 @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through @emph{all}
3845 keywords from all sets, so for example @kbd{S-@key{<right>}} would switch
3846 from @code{DONE} to @code{REPORT} in the example above. See also
3847 @ref{Conflicts}, for a discussion of the interaction with
3848 @code{shift-selection-mode}.
3851 @node Fast access to TODO states, Per-file keywords, Multiple sets in one file, TODO extensions
3852 @subsection Fast access to TODO states
3854 If you would like to quickly change an entry to an arbitrary TODO state
3855 instead of cycling through the states, you can set up keys for
3856 single-letter access to the states. This is done by adding the section
3857 key after each keyword, in parentheses. For example:
3860 (setq org-todo-keywords
3861 '((sequence "TODO(t)" "|" "DONE(d)")
3862 (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
3863 (sequence "|" "CANCELED(c)")))
3866 @vindex org-fast-tag-selection-include-todo
3867 If you then press @kbd{C-c C-t} followed by the selection key, the entry
3868 will be switched to this state. @kbd{SPC} can be used to remove any TODO
3869 keyword from an entry.@footnote{Check also the variable
3870 @code{org-fast-tag-selection-include-todo}, it allows you to change the TODO
3871 state through the tags interface (@pxref{Setting tags}), in case you like to
3872 mingle the two concepts. Note that this means you need to come up with
3873 unique keys across both sets of keywords.}
3875 @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions
3876 @subsection Setting up keywords for individual files
3877 @cindex keyword options
3878 @cindex per-file keywords
3883 It can be very useful to use different aspects of the TODO mechanism in
3884 different files. For file-local settings, you need to add special lines
3885 to the file which set the keywords and interpretation for that file
3886 only. For example, to set one of the two examples discussed above, you
3887 need one of the following lines, starting in column zero anywhere in the
3891 #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
3893 @noindent (you may also write @code{#+SEQ_TODO} to be explicit about the
3894 interpretation, but it means the same as @code{#+TODO}), or
3896 #+TYP_TODO: Fred Sara Lucy Mike | DONE
3899 A setup for using several sets in parallel would be:
3903 #+TODO: REPORT BUG KNOWNCAUSE | FIXED
3907 @cindex completion, of option keywords
3909 @noindent To make sure you are using the correct keyword, type
3910 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
3912 @cindex DONE, final TODO keyword
3913 Remember that the keywords after the vertical bar (or the last keyword
3914 if no bar is there) must always mean that the item is DONE (although you
3915 may use a different word). After changing one of these lines, use
3916 @kbd{C-c C-c} with the cursor still in the line to make the changes
3917 known to Org mode@footnote{Org mode parses these lines only when
3918 Org mode is activated after visiting a file. @kbd{C-c C-c} with the
3919 cursor in a line starting with @samp{#+} is simply restarting Org mode
3920 for the current buffer.}.
3922 @node Faces for TODO keywords, TODO dependencies, Per-file keywords, TODO extensions
3923 @subsection Faces for TODO keywords
3924 @cindex faces, for TODO keywords
3926 @vindex org-todo @r{(face)}
3927 @vindex org-done @r{(face)}
3928 @vindex org-todo-keyword-faces
3929 Org mode highlights TODO keywords with special faces: @code{org-todo}
3930 for keywords indicating that an item still has to be acted upon, and
3931 @code{org-done} for keywords indicating that an item is finished. If
3932 you are using more than 2 different states, you might want to use
3933 special faces for some of them. This can be done using the variable
3934 @code{org-todo-keyword-faces}. For example:
3938 (setq org-todo-keyword-faces
3939 '(("TODO" . org-warning) ("STARTED" . "yellow")
3940 ("CANCELED" . (:foreground "blue" :weight bold))))
3944 While using a list with face properties as shown for CANCELED @emph{should}
3945 work, this does not aways seem to be the case. If necessary, define a
3946 special face and use that. A string is interpreted as a color. The variable
3947 @code{org-faces-easy-properties} determines if that color is interpreted as a
3948 foreground or a background color.
3950 @node TODO dependencies, , Faces for TODO keywords, TODO extensions
3951 @subsection TODO dependencies
3952 @cindex TODO dependencies
3953 @cindex dependencies, of TODO states
3955 @vindex org-enforce-todo-dependencies
3956 @cindex property, ORDERED
3957 The structure of Org files (hierarchy and lists) makes it easy to define TODO
3958 dependencies. Usually, a parent TODO task should not be marked DONE until
3959 all subtasks (defined as children tasks) are marked as DONE. And sometimes
3960 there is a logical sequence to a number of (sub)tasks, so that one task
3961 cannot be acted upon before all siblings above it are done. If you customize
3962 the variable @code{org-enforce-todo-dependencies}, Org will block entries
3963 from changing state to DONE while they have children that are not DONE.
3964 Furthermore, if an entry has a property @code{ORDERED}, each of its children
3965 will be blocked until all earlier siblings are marked DONE. Here is an
3969 * TODO Blocked until (two) is done
3978 ** TODO b, needs to wait for (a)
3979 ** TODO c, needs to wait for (a) and (b)
3983 @orgcmd{C-c C-x o,org-toggle-ordered-property}
3984 @vindex org-track-ordered-property-with-tag
3985 @cindex property, ORDERED
3986 Toggle the @code{ORDERED} property of the current entry. A property is used
3987 for this behavior because this should be local to the current entry, not
3988 inherited like a tag. However, if you would like to @i{track} the value of
3989 this property with a tag for better visibility, customize the variable
3990 @code{org-track-ordered-property-with-tag}.
3991 @orgkey{C-u C-u C-u C-c C-t}
3992 Change TODO state, circumventing any state blocking.
3995 @vindex org-agenda-dim-blocked-tasks
3996 If you set the variable @code{org-agenda-dim-blocked-tasks}, TODO entries
3997 that cannot be closed because of such dependencies will be shown in a dimmed
3998 font or even made invisible in agenda views (@pxref{Agenda Views}).
4000 @cindex checkboxes and TODO dependencies
4001 @vindex org-enforce-todo-dependencies
4002 You can also block changes of TODO states by looking at checkboxes
4003 (@pxref{Checkboxes}). If you set the variable
4004 @code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked
4005 checkboxes will be blocked from switching to DONE.
4007 If you need more complex dependency structures, for example dependencies
4008 between entries in different trees or files, check out the contributed
4009 module @file{org-depend.el}.
4012 @node Progress logging, Priorities, TODO extensions, TODO Items
4013 @section Progress logging
4014 @cindex progress logging
4015 @cindex logging, of progress
4017 Org mode can automatically record a timestamp and possibly a note when
4018 you mark a TODO item as DONE, or even each time you change the state of
4019 a TODO item. This system is highly configurable, settings can be on a
4020 per-keyword basis and can be localized to a file or even a subtree. For
4021 information on how to clock working time for a task, see @ref{Clocking
4025 * Closing items:: When was this entry marked DONE?
4026 * Tracking TODO state changes:: When did the status change?
4027 * Tracking your habits:: How consistent have you been?
4030 @node Closing items, Tracking TODO state changes, Progress logging, Progress logging
4031 @subsection Closing items
4033 The most basic logging is to keep track of @emph{when} a certain TODO
4034 item was finished. This is achieved with@footnote{The corresponding
4035 in-buffer setting is: @code{#+STARTUP: logdone}}
4038 (setq org-log-done 'time)
4042 Then each time you turn an entry from a TODO (not-done) state into any
4043 of the DONE states, a line @samp{CLOSED: [timestamp]} will be inserted
4044 just after the headline. If you turn the entry back into a TODO item
4045 through further state cycling, that line will be removed again. If you
4046 want to record a note along with the timestamp, use@footnote{The
4047 corresponding in-buffer setting is: @code{#+STARTUP: lognotedone}}
4050 (setq org-log-done 'note)
4054 You will then be prompted for a note, and that note will be stored below
4055 the entry with a @samp{Closing Note} heading.
4057 In the timeline (@pxref{Timeline}) and in the agenda
4058 (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
4059 display the TODO items with a @samp{CLOSED} timestamp on each day,
4060 giving you an overview of what has been done.
4062 @node Tracking TODO state changes, Tracking your habits, Closing items, Progress logging
4063 @subsection Tracking TODO state changes
4064 @cindex drawer, for state change recording
4066 @vindex org-log-states-order-reversed
4067 @vindex org-log-into-drawer
4068 @cindex property, LOG_INTO_DRAWER
4069 When TODO keywords are used as workflow states (@pxref{Workflow states}), you
4070 might want to keep track of when a state change occurred and maybe take a
4071 note about this change. You can either record just a timestamp, or a
4072 time-stamped note for a change. These records will be inserted after the
4073 headline as an itemized list, newest first@footnote{See the variable
4074 @code{org-log-states-order-reversed}}. When taking a lot of notes, you might
4075 want to get the notes out of the way into a drawer (@pxref{Drawers}).
4076 Customize the variable @code{org-log-into-drawer} to get this
4077 behavior---the recommended drawer for this is called @code{LOGBOOK}. You can
4078 also overrule the setting of this variable for a subtree by setting a
4079 @code{LOG_INTO_DRAWER} property.
4081 Since it is normally too much to record a note for every state, Org mode
4082 expects configuration on a per-keyword basis for this. This is achieved by
4083 adding special markers @samp{!} (for a timestamp) or @samp{@@} (for a note
4084 with timestamp) in parentheses after each keyword. For example, with the
4088 (setq org-todo-keywords
4089 '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
4092 To record a timestamp without a note for TODO keywords configured with
4093 @samp{@@}, just type @kbd{C-c C-c} to enter a blank note when prompted.
4096 @vindex org-log-done
4097 you not only define global TODO keywords and fast access keys, but also
4098 request that a time is recorded when the entry is set to
4099 DONE@footnote{It is possible that Org mode will record two timestamps
4100 when you are using both @code{org-log-done} and state change logging.
4101 However, it will never prompt for two notes---if you have configured
4102 both, the state change recording note will take precedence and cancel
4103 the @samp{Closing Note}.}, and that a note is recorded when switching to
4104 WAIT or CANCELED. The setting for WAIT is even more special: the
4105 @samp{!} after the slash means that in addition to the note taken when
4106 entering the state, a timestamp should be recorded when @i{leaving} the
4107 WAIT state, if and only if the @i{target} state does not configure
4108 logging for entering it. So it has no effect when switching from WAIT
4109 to DONE, because DONE is configured to record a timestamp only. But
4110 when switching from WAIT back to TODO, the @samp{/!} in the WAIT
4111 setting now triggers a timestamp even though TODO has no logging
4114 You can use the exact same syntax for setting logging preferences local
4117 #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
4120 @cindex property, LOGGING
4121 In order to define logging settings that are local to a subtree or a
4122 single item, define a LOGGING property in this entry. Any non-empty
4123 LOGGING property resets all logging settings to nil. You may then turn
4124 on logging for this specific tree using STARTUP keywords like
4125 @code{lognotedone} or @code{logrepeat}, as well as adding state specific
4126 settings like @code{TODO(!)}. For example
4129 * TODO Log each state with only a time
4131 :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
4133 * TODO Only log when switching to WAIT, and when repeating
4135 :LOGGING: WAIT(@@) logrepeat
4137 * TODO No logging at all
4143 @node Tracking your habits, , Tracking TODO state changes, Progress logging
4144 @subsection Tracking your habits
4147 Org has the ability to track the consistency of a special category of TODOs,
4148 called ``habits''. A habit has the following properties:
4152 You have enabled the @code{habits} module by customizing the variable
4155 The habit is a TODO item, with a TODO keyword representing an open state.
4157 The property @code{STYLE} is set to the value @code{habit}.
4159 The TODO has a scheduled date, usually with a @code{.+} style repeat
4160 interval. A @code{++} style may be appropriate for habits with time
4161 constraints, e.g., must be done on weekends, or a @code{+} style for an
4162 unusual habit that can have a backlog, e.g., weekly reports.
4164 The TODO may also have minimum and maximum ranges specified by using the
4165 syntax @samp{.+2d/3d}, which says that you want to do the task at least every
4166 three days, but at most every two days.
4168 You must also have state logging for the @code{DONE} state enabled, in order
4169 for historical data to be represented in the consistency graph. If it is not
4170 enabled it is not an error, but the consistency graphs will be largely
4174 To give you an idea of what the above rules look like in action, here's an
4175 actual habit with some history:
4179 SCHEDULED: <2009-10-17 Sat .+2d/4d>
4180 - State "DONE" from "TODO" [2009-10-15 Thu]
4181 - State "DONE" from "TODO" [2009-10-12 Mon]
4182 - State "DONE" from "TODO" [2009-10-10 Sat]
4183 - State "DONE" from "TODO" [2009-10-04 Sun]
4184 - State "DONE" from "TODO" [2009-10-02 Fri]
4185 - State "DONE" from "TODO" [2009-09-29 Tue]
4186 - State "DONE" from "TODO" [2009-09-25 Fri]
4187 - State "DONE" from "TODO" [2009-09-19 Sat]
4188 - State "DONE" from "TODO" [2009-09-16 Wed]
4189 - State "DONE" from "TODO" [2009-09-12 Sat]
4192 :LAST_REPEAT: [2009-10-19 Mon 00:36]
4196 What this habit says is: I want to shave at most every 2 days (given by the
4197 @code{SCHEDULED} date and repeat interval) and at least every 4 days. If
4198 today is the 15th, then the habit first appears in the agenda on Oct 17,
4199 after the minimum of 2 days has elapsed, and will appear overdue on Oct 19,
4200 after four days have elapsed.
4202 What's really useful about habits is that they are displayed along with a
4203 consistency graph, to show how consistent you've been at getting that task
4204 done in the past. This graph shows every day that the task was done over the
4205 past three weeks, with colors for each day. The colors used are:
4209 If the task wasn't to be done yet on that day.
4211 If the task could have been done on that day.
4213 If the task was going to be overdue the next day.
4215 If the task was overdue on that day.
4218 In addition to coloring each day, the day is also marked with an asterisk if
4219 the task was actually done that day, and an exclamation mark to show where
4220 the current day falls in the graph.
4222 There are several configuration variables that can be used to change the way
4223 habits are displayed in the agenda.
4226 @item org-habit-graph-column
4227 The buffer column at which the consistency graph should be drawn. This will
4228 overwrite any text in that column, so it is a good idea to keep your habits'
4229 titles brief and to the point.
4230 @item org-habit-preceding-days
4231 The amount of history, in days before today, to appear in consistency graphs.
4232 @item org-habit-following-days
4233 The number of days after today that will appear in consistency graphs.
4234 @item org-habit-show-habits-only-for-today
4235 If non-nil, only show habits in today's agenda view. This is set to true by
4239 Lastly, pressing @kbd{K} in the agenda buffer will cause habits to
4240 temporarily be disabled and they won't appear at all. Press @kbd{K} again to
4241 bring them back. They are also subject to tag filtering, if you have habits
4242 which should only be done in certain contexts, for example.
4244 @node Priorities, Breaking down tasks, Progress logging, TODO Items
4248 If you use Org mode extensively, you may end up with enough TODO items that
4249 it starts to make sense to prioritize them. Prioritizing can be done by
4250 placing a @emph{priority cookie} into the headline of a TODO item, like this
4253 *** TODO [#A] Write letter to Sam Fortune
4257 @vindex org-priority-faces
4258 By default, Org mode supports three priorities: @samp{A}, @samp{B}, and
4259 @samp{C}. @samp{A} is the highest priority. An entry without a cookie is
4260 treated just like priority @samp{B}. Priorities make a difference only for
4261 sorting in the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they
4262 have no inherent meaning to Org mode. The cookies can be highlighted with
4263 special faces by customizing the variable @code{org-priority-faces}.
4265 Priorities can be attached to any outline node; they do not need to be TODO
4271 @findex org-priority
4272 Set the priority of the current headline (@command{org-priority}). The
4273 command prompts for a priority character @samp{A}, @samp{B} or @samp{C}.
4274 When you press @key{SPC} instead, the priority cookie is removed from the
4275 headline. The priorities can also be changed ``remotely'' from the timeline
4276 and agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
4278 @orgcmdkkcc{S-@key{up},S-@key{down},org-priority-up,org-priority-down}
4279 @vindex org-priority-start-cycle-with-default
4280 Increase/decrease priority of current headline@footnote{See also the option
4281 @code{org-priority-start-cycle-with-default}.}. Note that these keys are
4282 also used to modify timestamps (@pxref{Creating timestamps}). See also
4283 @ref{Conflicts}, for a discussion of the interaction with
4284 @code{shift-selection-mode}.
4287 @vindex org-highest-priority
4288 @vindex org-lowest-priority
4289 @vindex org-default-priority
4290 You can change the range of allowed priorities by setting the variables
4291 @code{org-highest-priority}, @code{org-lowest-priority}, and
4292 @code{org-default-priority}. For an individual buffer, you may set
4293 these values (highest, lowest, default) like this (please make sure that
4294 the highest priority is earlier in the alphabet than the lowest
4297 @cindex #+PRIORITIES
4302 @node Breaking down tasks, Checkboxes, Priorities, TODO Items
4303 @section Breaking tasks down into subtasks
4304 @cindex tasks, breaking down
4305 @cindex statistics, for TODO items
4307 @vindex org-agenda-todo-list-sublevels
4308 It is often advisable to break down large tasks into smaller, manageable
4309 subtasks. You can do this by creating an outline tree below a TODO item,
4310 with detailed subtasks on the tree@footnote{To keep subtasks out of the
4311 global TODO list, see the @code{org-agenda-todo-list-sublevels}.}. To keep
4312 the overview over the fraction of subtasks that are already completed, insert
4313 either @samp{[/]} or @samp{[%]} anywhere in the headline. These cookies will
4314 be updated each time the TODO status of a child changes, or when pressing
4315 @kbd{C-c C-c} on the cookie. For example:
4318 * Organize Party [33%]
4319 ** TODO Call people [1/2]
4323 ** DONE Talk to neighbor
4326 @cindex property, COOKIE_DATA
4327 If a heading has both checkboxes and TODO children below it, the meaning of
4328 the statistics cookie become ambiguous. Set the property
4329 @code{COOKIE_DATA} to either @samp{checkbox} or @samp{todo} to resolve
4332 @vindex org-hierarchical-todo-statistics
4333 If you would like to have the statistics cookie count any TODO entries in the
4334 subtree (not just direct children), configure the variable
4335 @code{org-hierarchical-todo-statistics}. To do this for a single subtree,
4336 include the word @samp{recursive} into the value of the @code{COOKIE_DATA}
4340 * Parent capturing statistics [2/20]
4342 :COOKIE_DATA: todo recursive
4346 If you would like a TODO entry to automatically change to DONE
4347 when all children are done, you can use the following setup:
4350 (defun org-summary-todo (n-done n-not-done)
4351 "Switch entry to DONE when all subentries are done, to TODO otherwise."
4352 (let (org-log-done org-log-states) ; turn off logging
4353 (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
4355 (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
4359 Another possibility is the use of checkboxes to identify (a hierarchy of) a
4360 large number of subtasks (@pxref{Checkboxes}).
4363 @node Checkboxes, , Breaking down tasks, TODO Items
4367 @vindex org-list-automatic-rules
4368 Every item in a plain list@footnote{With the exception of description
4369 lists. But you can allow it by modifying @code{org-list-automatic-rules}
4370 accordingly.} (@pxref{Plain lists}) can be made into a checkbox by starting
4371 it with the string @samp{[ ]}. This feature is similar to TODO items
4372 (@pxref{TODO Items}), but is more lightweight. Checkboxes are not included
4373 into the global TODO list, so they are often great to split a task into a
4374 number of simple steps. Or you can use them in a shopping list. To toggle a
4375 checkbox, use @kbd{C-c C-c}, or use the mouse (thanks to Piotr Zielinski's
4376 @file{org-mouse.el}).
4378 Here is an example of a checkbox list.
4381 * TODO Organize party [2/4]
4382 - [-] call people [1/3]
4387 - [ ] think about what music to play
4388 - [X] talk to the neighbors
4391 Checkboxes work hierarchically, so if a checkbox item has children that
4392 are checkboxes, toggling one of the children checkboxes will make the
4393 parent checkbox reflect if none, some, or all of the children are
4396 @cindex statistics, for checkboxes
4397 @cindex checkbox statistics
4398 @cindex property, COOKIE_DATA
4399 @vindex org-hierarchical-checkbox-statistics
4400 The @samp{[2/4]} and @samp{[1/3]} in the first and second line are cookies
4401 indicating how many checkboxes present in this entry have been checked off,
4402 and the total number of checkboxes present. This can give you an idea on how
4403 many checkboxes remain, even without opening a folded entry. The cookies can
4404 be placed into a headline or into (the first line of) a plain list item.
4405 Each cookie covers checkboxes of direct children structurally below the
4406 headline/item on which the cookie appears@footnote{Set the variable
4407 @code{org-hierarchical-checkbox-statistics} if you want such cookies to
4408 count all checkboxes below the cookie, not just those belonging to direct
4409 children.}. You have to insert the cookie yourself by typing either
4410 @samp{[/]} or @samp{[%]}. With @samp{[/]} you get an @samp{n out of m}
4411 result, as in the examples above. With @samp{[%]} you get information about
4412 the percentage of checkboxes checked (in the above example, this would be
4413 @samp{[50%]} and @samp{[33%]}, respectively). In a headline, a cookie can
4414 count either checkboxes below the heading or TODO states of children, and it
4415 will display whatever was changed last. Set the property @code{COOKIE_DATA}
4416 to either @samp{checkbox} or @samp{todo} to resolve this issue.
4418 @cindex blocking, of checkboxes
4419 @cindex checkbox blocking
4420 @cindex property, ORDERED
4421 If the current outline node has an @code{ORDERED} property, checkboxes must
4422 be checked off in sequence, and an error will be thrown if you try to check
4423 off a box while there are unchecked boxes above it.
4425 @noindent The following commands work with checkboxes:
4428 @orgcmd{C-c C-c,org-toggle-checkbox}
4429 Toggle checkbox status or (with prefix arg) checkbox presence at point. With
4430 double prefix argument, set it to @samp{[-]}, which is considered to be an
4432 @orgcmd{C-c C-x C-b,org-toggle-checkbox}
4433 Toggle checkbox status or (with prefix arg) checkbox presence at point. With
4434 double prefix argument, set it to @samp{[-]}, which is considered to be an
4438 If there is an active region, toggle the first checkbox in the region
4439 and set all remaining boxes to the same status as the first. With a prefix
4440 arg, add or remove the checkbox for all items in the region.
4442 If the cursor is in a headline, toggle checkboxes in the region between
4443 this headline and the next (so @emph{not} the entire subtree).
4445 If there is no active region, just toggle the checkbox at point.
4447 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
4448 Insert a new item with a checkbox. This works only if the cursor is already
4449 in a plain list item (@pxref{Plain lists}).
4450 @orgcmd{C-c C-x o,org-toggle-ordered-property}
4451 @vindex org-track-ordered-property-with-tag
4452 @cindex property, ORDERED
4453 Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
4454 be checked off in sequence. A property is used for this behavior because
4455 this should be local to the current entry, not inherited like a tag.
4456 However, if you would like to @i{track} the value of this property with a tag
4457 for better visibility, customize the variable
4458 @code{org-track-ordered-property-with-tag}.
4459 @orgcmd{C-c #,org-update-statistics-cookies}
4460 Update the statistics cookie in the current outline entry. When called with
4461 a @kbd{C-u} prefix, update the entire file. Checkbox statistic cookies are
4462 updated automatically if you toggle checkboxes with @kbd{C-c C-c} and make
4463 new ones with @kbd{M-S-@key{RET}}. TODO statistics cookies update when
4464 changing TODO states. If you delete boxes/entries or add/change them by
4465 hand, use this command to get things back into sync.
4468 @node Tags, Properties and Columns, TODO Items, Top
4471 @cindex headline tagging
4472 @cindex matching, tags
4473 @cindex sparse tree, tag based
4475 An excellent way to implement labels and contexts for cross-correlating
4476 information is to assign @i{tags} to headlines. Org mode has extensive
4479 @vindex org-tag-faces
4480 Every headline can contain a list of tags; they occur at the end of the
4481 headline. Tags are normal words containing letters, numbers, @samp{_}, and
4482 @samp{@@}. Tags must be preceded and followed by a single colon, e.g.,
4483 @samp{:work:}. Several tags can be specified, as in @samp{:work:urgent:}.
4484 Tags will by default be in bold face with the same color as the headline.
4485 You may specify special faces for specific tags using the variable
4486 @code{org-tag-faces}, in much the same way as you can for TODO keywords
4487 (@pxref{Faces for TODO keywords}).
4490 * Tag inheritance:: Tags use the tree structure of the outline
4491 * Setting tags:: How to assign tags to a headline
4492 * Tag searches:: Searching for combinations of tags
4495 @node Tag inheritance, Setting tags, Tags, Tags
4496 @section Tag inheritance
4497 @cindex tag inheritance
4498 @cindex inheritance, of tags
4499 @cindex sublevels, inclusion into tags match
4501 @i{Tags} make use of the hierarchical structure of outline trees. If a
4502 heading has a certain tag, all subheadings will inherit the tag as
4503 well. For example, in the list
4506 * Meeting with the French group :work:
4507 ** Summary by Frank :boss:notes:
4508 *** TODO Prepare slides for him :action:
4512 the final heading will have the tags @samp{:work:}, @samp{:boss:},
4513 @samp{:notes:}, and @samp{:action:} even though the final heading is not
4514 explicitly marked with those tags. You can also set tags that all entries in
4515 a file should inherit just as if these tags were defined in a hypothetical
4516 level zero that surrounds the entire file. Use a line like this@footnote{As
4517 with all these in-buffer settings, pressing @kbd{C-c C-c} activates any
4518 changes in the line.}:
4522 #+FILETAGS: :Peter:Boss:Secret:
4526 @vindex org-use-tag-inheritance
4527 @vindex org-tags-exclude-from-inheritance
4528 To limit tag inheritance to specific tags, or to turn it off entirely, use
4529 the variables @code{org-use-tag-inheritance} and
4530 @code{org-tags-exclude-from-inheritance}.
4532 @vindex org-tags-match-list-sublevels
4533 When a headline matches during a tags search while tag inheritance is turned
4534 on, all the sublevels in the same tree will (for a simple match form) match
4535 as well@footnote{This is only true if the search does not involve more
4536 complex tests including properties (@pxref{Property searches}).}. The list
4537 of matches may then become very long. If you only want to see the first tags
4538 match in a subtree, configure the variable
4539 @code{org-tags-match-list-sublevels} (not recommended).
4541 @node Setting tags, Tag searches, Tag inheritance, Tags
4542 @section Setting tags
4543 @cindex setting tags
4544 @cindex tags, setting
4547 Tags can simply be typed into the buffer at the end of a headline.
4548 After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is
4549 also a special command for inserting tags:
4552 @orgcmd{C-c C-q,org-set-tags-command}
4553 @cindex completion, of tags
4554 @vindex org-tags-column
4555 Enter new tags for the current headline. Org mode will either offer
4556 completion or a special single-key interface for setting tags, see
4557 below. After pressing @key{RET}, the tags will be inserted and aligned
4558 to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all
4559 tags in the current buffer will be aligned to that column, just to make
4560 things look nice. TAGS are automatically realigned after promotion,
4561 demotion, and TODO state changes (@pxref{TODO basics}).
4562 @orgcmd{C-c C-c,org-set-tags-command}
4563 When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
4566 @vindex org-tag-alist
4567 Org supports tag insertion based on a @emph{list of tags}. By
4568 default this list is constructed dynamically, containing all tags
4569 currently used in the buffer. You may also globally specify a hard list
4570 of tags with the variable @code{org-tag-alist}. Finally you can set
4571 the default tags for a given file with lines like
4575 #+TAGS: @@work @@home @@tennisclub
4576 #+TAGS: laptop car pc sailboat
4579 If you have globally defined your preferred set of tags using the
4580 variable @code{org-tag-alist}, but would like to use a dynamic tag list
4581 in a specific file, add an empty TAGS option line to that file:
4587 @vindex org-tag-persistent-alist
4588 If you have a preferred set of tags that you would like to use in every file,
4589 in addition to those defined on a per-file basis by TAGS option lines, then
4590 you may specify a list of tags with the variable
4591 @code{org-tag-persistent-alist}. You may turn this off on a per-file basis
4592 by adding a STARTUP option line to that file:
4598 By default Org mode uses the standard minibuffer completion facilities for
4599 entering tags. However, it also implements another, quicker, tag selection
4600 method called @emph{fast tag selection}. This allows you to select and
4601 deselect tags with just a single key press. For this to work well you should
4602 assign unique letters to most of your commonly used tags. You can do this
4603 globally by configuring the variable @code{org-tag-alist} in your
4604 @file{.emacs} file. For example, you may find the need to tag many items in
4605 different files with @samp{:@@home:}. In this case you can set something
4609 (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
4612 @noindent If the tag is only relevant to the file you are working on, then you
4613 can instead set the TAGS option line as:
4616 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p)
4619 @noindent The tags interface will show the available tags in a splash
4620 window. If you want to start a new line after a specific tag, insert
4621 @samp{\n} into the tag list
4624 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) \n laptop(l) pc(p)
4627 @noindent or write them in two lines:
4630 #+TAGS: @@work(w) @@home(h) @@tennisclub(t)
4631 #+TAGS: laptop(l) pc(p)
4635 You can also group together tags that are mutually exclusive by using
4639 #+TAGS: @{ @@work(w) @@home(h) @@tennisclub(t) @} laptop(l) pc(p)
4642 @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
4643 and @samp{@@tennisclub} should be selected. Multiple such groups are allowed.
4645 @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
4646 these lines to activate any changes.
4649 To set these mutually exclusive groups in the variable @code{org-tags-alist},
4650 you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
4651 of the braces. Similarly, you can use @code{:newline} to indicate a line
4652 break. The previous example would be set globally by the following
4656 (setq org-tag-alist '((:startgroup . nil)
4657 ("@@work" . ?w) ("@@home" . ?h)
4658 ("@@tennisclub" . ?t)
4660 ("laptop" . ?l) ("pc" . ?p)))
4663 If at least one tag has a selection key then pressing @kbd{C-c C-c} will
4664 automatically present you with a special interface, listing inherited tags,
4665 the tags of the current headline, and a list of all valid tags with
4666 corresponding keys@footnote{Keys will automatically be assigned to tags which
4667 have no configured keys.}. In this interface, you can use the following
4672 Pressing keys assigned to tags will add or remove them from the list of
4673 tags in the current line. Selecting a tag in a group of mutually
4674 exclusive tags will turn off any other tags from that group.
4677 Enter a tag in the minibuffer, even if the tag is not in the predefined
4678 list. You will be able to complete on all tags present in the buffer.
4679 You can also add several tags: just separate them with a comma.
4683 Clear all tags for this line.
4686 Accept the modified set.
4688 Abort without installing changes.
4690 If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
4692 Turn off groups of mutually exclusive tags. Use this to (as an
4693 exception) assign several tags from such a group.
4695 Toggle auto-exit after the next change (see below).
4696 If you are using expert mode, the first @kbd{C-c} will display the
4701 This method lets you assign tags to a headline with very few keys. With
4702 the above setup, you could clear the current tags and set @samp{@@home},
4703 @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
4704 C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@home} to
4705 @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
4706 alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag
4707 @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
4708 @key{RET} @key{RET}}.
4710 @vindex org-fast-tag-selection-single-key
4711 If you find that most of the time you need only a single key press to
4712 modify your list of tags, set the variable
4713 @code{org-fast-tag-selection-single-key}. Then you no longer have to
4714 press @key{RET} to exit fast tag selection---it will immediately exit
4715 after the first change. If you then occasionally need more keys, press
4716 @kbd{C-c} to turn off auto-exit for the current tag selection process
4717 (in effect: start selection with @kbd{C-c C-c C-c} instead of @kbd{C-c
4718 C-c}). If you set the variable to the value @code{expert}, the special
4719 window is not even shown for single-key tag selection, it comes up only
4720 when you press an extra @kbd{C-c}.
4722 @node Tag searches, , Setting tags, Tags
4723 @section Tag searches
4724 @cindex tag searches
4725 @cindex searching for tags
4727 Once a system of tags has been set up, it can be used to collect related
4728 information into special lists.
4731 @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
4732 Create a sparse tree with all headlines matching a tags search. With a
4733 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
4734 @orgcmd{C-c a m,org-tags-view}
4735 Create a global list of tag matches from all agenda files.
4736 @xref{Matching tags and properties}.
4737 @orgcmd{C-c a M,org-tags-view}
4738 @vindex org-tags-match-list-sublevels
4739 Create a global list of tag matches from all agenda files, but check
4740 only TODO items and force checking subitems (see variable
4741 @code{org-tags-match-list-sublevels}).
4744 These commands all prompt for a match string which allows basic Boolean logic
4745 like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and
4746 @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries
4747 which are tagged, like @samp{Kathy} or @samp{Sally}. The full syntax of the search
4748 string is rich and allows also matching against TODO keywords, entry levels
4749 and properties. For a complete description with many examples, see
4750 @ref{Matching tags and properties}.
4753 @node Properties and Columns, Dates and Times, Tags, Top
4754 @chapter Properties and columns
4757 A property is a key-value pair associated with an entry. Properties can be
4758 set so they are associated with a single entry, with every entry in a tree,
4759 or with every entry in an Org mode file.
4761 There are two main applications for properties in Org mode. First,
4762 properties are like tags, but with a value. Imagine maintaining a file where
4763 you document bugs and plan releases for a piece of software. Instead of
4764 using tags like @code{:release_1:}, @code{:release_2:}, you can use a
4765 property, say @code{:Release:}, that in different subtrees has different
4766 values, such as @code{1.0} or @code{2.0}. Second, you can use properties to
4767 implement (very basic) database capabilities in an Org buffer. Imagine
4768 keeping track of your music CDs, where properties could be things such as the
4769 album, artist, date of release, number of tracks, and so on.
4771 Properties can be conveniently edited and viewed in column view
4772 (@pxref{Column view}).
4775 * Property syntax:: How properties are spelled out
4776 * Special properties:: Access to other Org mode features
4777 * Property searches:: Matching property values
4778 * Property inheritance:: Passing values down the tree
4779 * Column view:: Tabular viewing and editing
4780 * Property API:: Properties for Lisp programmers
4783 @node Property syntax, Special properties, Properties and Columns, Properties and Columns
4784 @section Property syntax
4785 @cindex property syntax
4786 @cindex drawer, for properties
4788 Properties are key-value pairs. When they are associated with a single entry
4789 or with a tree they need to be inserted into a special
4790 drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property
4791 is specified on a single line, with the key (surrounded by colons)
4792 first, and the value after it. Here is an example:
4797 *** Goldberg Variations
4799 :Title: Goldberg Variations
4800 :Composer: J.S. Bach
4802 :Publisher: Deutsche Grammophon
4807 Depending on the value of @code{org-use-property-inheritance}, a property set
4808 this way will either be associated with a single entry, or the sub-tree
4809 defined by the entry, see @ref{Property inheritance}.
4811 You may define the allowed values for a particular property @samp{:Xyz:}
4812 by setting a property @samp{:Xyz_ALL:}. This special property is
4813 @emph{inherited}, so if you set it in a level 1 entry, it will apply to
4814 the entire tree. When allowed values are defined, setting the
4815 corresponding property becomes easier and is less prone to typing
4816 errors. For the example with the CD collection, we can predefine
4817 publishers and the number of disks in a box like this:
4822 :NDisks_ALL: 1 2 3 4
4823 :Publisher_ALL: "Deutsche Grammophon" Philips EMI
4827 If you want to set properties that can be inherited by any entry in a
4828 file, use a line like
4829 @cindex property, _ALL
4832 #+PROPERTY: NDisks_ALL 1 2 3 4
4835 If you want to add to the value of an existing property, append a @code{+} to
4836 the property name. The following results in the property @code{var} having
4837 the value ``foo=1 bar=2''.
4840 #+PROPERTY: var foo=1
4841 #+PROPERTY: var+ bar=2
4844 It is also possible to add to the values of inherited properties. The
4845 following results in the @code{genres} property having the value ``Classic
4846 Baroque'' under the @code{Goldberg Variations} subtree.
4854 *** Goldberg Variations
4856 :Title: Goldberg Variations
4857 :Composer: J.S. Bach
4859 :Publisher: Deutsche Grammophon
4864 Note that a property can only have one entry per Drawer.
4866 @vindex org-global-properties
4867 Property values set with the global variable
4868 @code{org-global-properties} can be inherited by all entries in all
4872 The following commands help to work with properties:
4875 @orgcmd{M-@key{TAB},pcomplete}
4876 After an initial colon in a line, complete property keys. All keys used
4877 in the current file will be offered as possible completions.
4878 @orgcmd{C-c C-x p,org-set-property}
4879 Set a property. This prompts for a property name and a value. If
4880 necessary, the property drawer is created as well.
4881 @item M-x org-insert-property-drawer
4882 @findex org-insert-property-drawer
4883 Insert a property drawer into the current entry. The drawer will be
4884 inserted early in the entry, but after the lines with planning
4885 information like deadlines.
4886 @orgcmd{C-c C-c,org-property-action}
4887 With the cursor in a property drawer, this executes property commands.
4888 @orgcmd{C-c C-c s,org-set-property}
4889 Set a property in the current entry. Both the property and the value
4890 can be inserted using completion.
4891 @orgcmdkkcc{S-@key{right},S-@key{left},org-property-next-allowed-value,org-property-previous-allowed-value}
4892 Switch property at point to the next/previous allowed value.
4893 @orgcmd{C-c C-c d,org-delete-property}
4894 Remove a property from the current entry.
4895 @orgcmd{C-c C-c D,org-delete-property-globally}
4896 Globally remove a property, from all entries in the current file.
4897 @orgcmd{C-c C-c c,org-compute-property-at-point}
4898 Compute the property at point, using the operator and scope from the
4899 nearest column format definition.
4902 @node Special properties, Property searches, Property syntax, Properties and Columns
4903 @section Special properties
4904 @cindex properties, special
4906 Special properties provide an alternative access method to Org mode features,
4907 like the TODO state or the priority of an entry, discussed in the previous
4908 chapters. This interface exists so that you can include these states in a
4909 column view (@pxref{Column view}), or to use them in queries. The following
4910 property names are special and (except for @code{:CATEGORY:}) should not be
4911 used as keys in the properties drawer:
4913 @cindex property, special, TODO
4914 @cindex property, special, TAGS
4915 @cindex property, special, ALLTAGS
4916 @cindex property, special, CATEGORY
4917 @cindex property, special, PRIORITY
4918 @cindex property, special, DEADLINE
4919 @cindex property, special, SCHEDULED
4920 @cindex property, special, CLOSED
4921 @cindex property, special, TIMESTAMP
4922 @cindex property, special, TIMESTAMP_IA
4923 @cindex property, special, CLOCKSUM
4924 @cindex property, special, BLOCKED
4925 @c guessing that ITEM is needed in this area; also, should this list be sorted?
4926 @cindex property, special, ITEM
4927 @cindex property, special, FILE
4929 TODO @r{The TODO keyword of the entry.}
4930 TAGS @r{The tags defined directly in the headline.}
4931 ALLTAGS @r{All tags, including inherited ones.}
4932 CATEGORY @r{The category of an entry.}
4933 PRIORITY @r{The priority of the entry, a string with a single letter.}
4934 DEADLINE @r{The deadline time string, without the angular brackets.}
4935 SCHEDULED @r{The scheduling timestamp, without the angular brackets.}
4936 CLOSED @r{When was this entry closed?}
4937 TIMESTAMP @r{The first keyword-less timestamp in the entry.}
4938 TIMESTAMP_IA @r{The first inactive timestamp in the entry.}
4939 CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}}
4940 @r{must be run first to compute the values in the current buffer.}
4941 BLOCKED @r{"t" if task is currently blocked by children or siblings}
4942 ITEM @r{The content of the entry.}
4943 FILE @r{The filename the entry is located in.}
4946 @node Property searches, Property inheritance, Special properties, Properties and Columns
4947 @section Property searches
4948 @cindex properties, searching
4949 @cindex searching, of properties
4951 To create sparse trees and special lists with selection based on properties,
4952 the same commands are used as for tag searches (@pxref{Tag searches}).
4954 @orgcmdkkc{C-c / m,C-c \,org-match-sparse-tree}
4955 Create a sparse tree with all matching entries. With a
4956 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
4957 @orgcmd{C-c a m,org-tags-view}
4958 Create a global list of tag/property matches from all agenda files.
4959 @xref{Matching tags and properties}.
4960 @orgcmd{C-c a M,org-tags-view}
4961 @vindex org-tags-match-list-sublevels
4962 Create a global list of tag matches from all agenda files, but check
4963 only TODO items and force checking of subitems (see variable
4964 @code{org-tags-match-list-sublevels}).
4967 The syntax for the search string is described in @ref{Matching tags and
4970 There is also a special command for creating sparse trees based on a
4975 Create a sparse tree based on the value of a property. This first
4976 prompts for the name of a property, and then for a value. A sparse tree
4977 is created with all entries that define this property with the given
4978 value. If you enclose the value in curly braces, it is interpreted as
4979 a regular expression and matched against the property values.
4982 @node Property inheritance, Column view, Property searches, Properties and Columns
4983 @section Property Inheritance
4984 @cindex properties, inheritance
4985 @cindex inheritance, of properties
4987 @vindex org-use-property-inheritance
4988 The outline structure of Org mode documents lends itself to an
4989 inheritance model of properties: if the parent in a tree has a certain
4990 property, the children can inherit this property. Org mode does not
4991 turn this on by default, because it can slow down property searches
4992 significantly and is often not needed. However, if you find inheritance
4993 useful, you can turn it on by setting the variable
4994 @code{org-use-property-inheritance}. It may be set to @code{t} to make
4995 all properties inherited from the parent, to a list of properties
4996 that should be inherited, or to a regular expression that matches
4997 inherited properties. If a property has the value @samp{nil}, this is
4998 interpreted as an explicit undefine of the property, so that inheritance
4999 search will stop at this value and return @code{nil}.
5001 Org mode has a few properties for which inheritance is hard-coded, at
5002 least for the special applications for which they are used:
5004 @cindex property, COLUMNS
5007 The @code{:COLUMNS:} property defines the format of column view
5008 (@pxref{Column view}). It is inherited in the sense that the level
5009 where a @code{:COLUMNS:} property is defined is used as the starting
5010 point for a column view table, independently of the location in the
5011 subtree from where columns view is turned on.
5013 @cindex property, CATEGORY
5014 For agenda view, a category set through a @code{:CATEGORY:} property
5015 applies to the entire subtree.
5017 @cindex property, ARCHIVE
5018 For archiving, the @code{:ARCHIVE:} property may define the archive
5019 location for the entire subtree (@pxref{Moving subtrees}).
5021 @cindex property, LOGGING
5022 The LOGGING property may define logging settings for an entry or a
5023 subtree (@pxref{Tracking TODO state changes}).
5026 @node Column view, Property API, Property inheritance, Properties and Columns
5027 @section Column view
5029 A great way to view and edit properties in an outline tree is
5030 @emph{column view}. In column view, each outline node is turned into a
5031 table row. Columns in this table provide access to properties of the
5032 entries. Org mode implements columns by overlaying a tabular structure
5033 over the headline of each item. While the headlines have been turned
5034 into a table row, you can still change the visibility of the outline
5035 tree. For example, you get a compact table by switching to CONTENTS
5036 view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
5037 is active), but you can still open, read, and edit the entry below each
5038 headline. Or, you can switch to column view after executing a sparse
5039 tree command and in this way get a table only for the selected items.
5040 Column view also works in agenda buffers (@pxref{Agenda Views}) where
5041 queries have collected selected items, possibly from a number of files.
5044 * Defining columns:: The COLUMNS format property
5045 * Using column view:: How to create and use column view
5046 * Capturing column view:: A dynamic block for column view
5049 @node Defining columns, Using column view, Column view, Column view
5050 @subsection Defining columns
5051 @cindex column view, for properties
5052 @cindex properties, column view
5054 Setting up a column view first requires defining the columns. This is
5055 done by defining a column format line.
5058 * Scope of column definitions:: Where defined, where valid?
5059 * Column attributes:: Appearance and content of a column
5062 @node Scope of column definitions, Column attributes, Defining columns, Defining columns
5063 @subsubsection Scope of column definitions
5065 To define a column format for an entire file, use a line like
5069 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5072 To specify a format that only applies to a specific tree, add a
5073 @code{:COLUMNS:} property to the top node of that tree, for example:
5076 ** Top node for columns view
5078 :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5082 If a @code{:COLUMNS:} property is present in an entry, it defines columns
5083 for the entry itself, and for the entire subtree below it. Since the
5084 column definition is part of the hierarchical structure of the document,
5085 you can define columns on level 1 that are general enough for all
5086 sublevels, and more specific columns further down, when you edit a
5087 deeper part of the tree.
5089 @node Column attributes, , Scope of column definitions, Defining columns
5090 @subsubsection Column attributes
5091 A column definition sets the attributes of a column. The general
5092 definition looks like this:
5095 %[@var{width}]@var{property}[(@var{title})][@{@var{summary-type}@}]
5099 Except for the percent sign and the property name, all items are
5100 optional. The individual parts have the following meaning:
5103 @var{width} @r{An integer specifying the width of the column in characters.}
5104 @r{If omitted, the width will be determined automatically.}
5105 @var{property} @r{The property that should be edited in this column.}
5106 @r{Special properties representing meta data are allowed here}
5107 @r{as well (@pxref{Special properties})}
5108 @var{title} @r{The header text for the column. If omitted, the property}
5110 @{@var{summary-type}@} @r{The summary type. If specified, the column values for}
5111 @r{parent nodes are computed from the children.}
5112 @r{Supported summary types are:}
5113 @{+@} @r{Sum numbers in this column.}
5114 @{+;%.1f@} @r{Like @samp{+}, but format result with @samp{%.1f}.}
5115 @{$@} @r{Currency, short for @samp{+;%.2f}.}
5116 @{:@} @r{Sum times, HH:MM, plain numbers are hours.}
5117 @{X@} @r{Checkbox status, @samp{[X]} if all children are @samp{[X]}.}
5118 @{X/@} @r{Checkbox status, @samp{[n/m]}.}
5119 @{X%@} @r{Checkbox status, @samp{[n%]}.}
5120 @{min@} @r{Smallest number in column.}
5121 @{max@} @r{Largest number.}
5122 @{mean@} @r{Arithmetic mean of numbers.}
5123 @{:min@} @r{Smallest time value in column.}
5124 @{:max@} @r{Largest time value.}
5125 @{:mean@} @r{Arithmetic mean of time values.}
5126 @{@@min@} @r{Minimum age (in days/hours/mins/seconds).}
5127 @{@@max@} @r{Maximum age (in days/hours/mins/seconds).}
5128 @{@@mean@} @r{Arithmetic mean of ages (in days/hours/mins/seconds).}
5129 @{est+@} @r{Add low-high estimates.}
5133 Be aware that you can only have one summary type for any property you
5134 include. Subsequent columns referencing the same property will all display the
5135 same summary information.
5137 The @code{est+} summary type requires further explanation. It is used for
5138 combining estimates, expressed as low-high ranges. For example, instead
5139 of estimating a particular task will take 5 days, you might estimate it as
5140 5-6 days if you're fairly confident you know how much work is required, or
5141 1-10 days if you don't really know what needs to be done. Both ranges
5142 average at 5.5 days, but the first represents a more predictable delivery.
5144 When combining a set of such estimates, simply adding the lows and highs
5145 produces an unrealistically wide result. Instead, @code{est+} adds the
5146 statistical mean and variance of the sub-tasks, generating a final estimate
5147 from the sum. For example, suppose you had ten tasks, each of which was
5148 estimated at 0.5 to 2 days of work. Straight addition produces an estimate
5149 of 5 to 20 days, representing what to expect if everything goes either
5150 extremely well or extremely poorly. In contrast, @code{est+} estimates the
5151 full job more realistically, at 10-15 days.
5153 Here is an example for a complete columns definition, along with allowed
5157 :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.}
5158 %10Time_Estimate@{:@} %CLOCKSUM
5159 :Owner_ALL: Tammy Mark Karl Lisa Don
5160 :Status_ALL: "In progress" "Not started yet" "Finished" ""
5161 :Approved_ALL: "[ ]" "[X]"
5165 The first column, @samp{%25ITEM}, means the first 25 characters of the
5166 item itself, i.e.@: of the headline. You probably always should start the
5167 column definition with the @samp{ITEM} specifier. The other specifiers
5168 create columns @samp{Owner} with a list of names as allowed values, for
5169 @samp{Status} with four different possible values, and for a checkbox
5170 field @samp{Approved}. When no width is given after the @samp{%}
5171 character, the column will be exactly as wide as it needs to be in order
5172 to fully display all values. The @samp{Approved} column does have a
5173 modified title (@samp{Approved?}, with a question mark). Summaries will
5174 be created for the @samp{Time_Estimate} column by adding time duration
5175 expressions like HH:MM, and for the @samp{Approved} column, by providing
5176 an @samp{[X]} status if all children have been checked. The
5177 @samp{CLOCKSUM} column is special, it lists the sum of CLOCK intervals
5180 @node Using column view, Capturing column view, Defining columns, Column view
5181 @subsection Using column view
5184 @tsubheading{Turning column view on and off}
5185 @orgcmd{C-c C-x C-c,org-columns}
5186 @vindex org-columns-default-format
5187 Turn on column view. If the cursor is before the first headline in the file,
5188 column view is turned on for the entire file, using the @code{#+COLUMNS}
5189 definition. If the cursor is somewhere inside the outline, this command
5190 searches the hierarchy, up from point, for a @code{:COLUMNS:} property that
5191 defines a format. When one is found, the column view table is established
5192 for the tree starting at the entry that contains the @code{:COLUMNS:}
5193 property. If no such property is found, the format is taken from the
5194 @code{#+COLUMNS} line or from the variable @code{org-columns-default-format},
5195 and column view is established for the current entry and its subtree.
5196 @orgcmd{r,org-columns-redo}
5197 Recreate the column view, to include recent changes made in the buffer.
5198 @orgcmd{g,org-columns-redo}
5200 @orgcmd{q,org-columns-quit}
5202 @tsubheading{Editing values}
5203 @item @key{left} @key{right} @key{up} @key{down}
5204 Move through the column view from field to field.
5205 @kindex S-@key{left}
5206 @kindex S-@key{right}
5207 @item S-@key{left}/@key{right}
5208 Switch to the next/previous allowed value of the field. For this, you
5209 have to have specified allowed values for a property.
5211 Directly select the Nth allowed value, @kbd{0} selects the 10th value.
5212 @orgcmdkkcc{n,p,org-columns-next-allowed-value,org-columns-previous-allowed-value}
5213 Same as @kbd{S-@key{left}/@key{right}}
5214 @orgcmd{e,org-columns-edit-value}
5215 Edit the property at point. For the special properties, this will
5216 invoke the same interface that you normally use to change that
5217 property. For example, when editing a TAGS property, the tag completion
5218 or fast selection interface will pop up.
5219 @orgcmd{C-c C-c,org-columns-set-tags-or-toggle}
5220 When there is a checkbox at point, toggle it.
5221 @orgcmd{v,org-columns-show-value}
5222 View the full value of this property. This is useful if the width of
5223 the column is smaller than that of the value.
5224 @orgcmd{a,org-columns-edit-allowed}
5225 Edit the list of allowed values for this property. If the list is found
5226 in the hierarchy, the modified values is stored there. If no list is
5227 found, the new value is stored in the first entry that is part of the
5228 current column view.
5229 @tsubheading{Modifying the table structure}
5230 @orgcmdkkcc{<,>,org-columns-narrow,org-columns-widen}
5231 Make the column narrower/wider by one character.
5232 @orgcmd{S-M-@key{right},org-columns-new}
5233 Insert a new column, to the left of the current column.
5234 @orgcmd{S-M-@key{left},org-columns-delete}
5235 Delete the current column.
5238 @node Capturing column view, , Using column view, Column view
5239 @subsection Capturing column view
5241 Since column view is just an overlay over a buffer, it cannot be
5242 exported or printed directly. If you want to capture a column view, use
5243 a @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame
5244 of this block looks like this:
5246 @cindex #+BEGIN, columnview
5249 #+BEGIN: columnview :hlines 1 :id "label"
5254 @noindent This dynamic block has the following parameters:
5258 This is the most important parameter. Column view is a feature that is
5259 often localized to a certain (sub)tree, and the capture block might be
5260 at a different location in the file. To identify the tree whose view to
5261 capture, you can use 4 values:
5262 @cindex property, ID
5264 local @r{use the tree in which the capture block is located}
5265 global @r{make a global view, including all headings in the file}
5266 "file:@var{path-to-file}"
5267 @r{run column view at the top of this file}
5268 "@var{ID}" @r{call column view in the tree that has an @code{:ID:}}
5269 @r{property with the value @i{label}. You can use}
5270 @r{@kbd{M-x org-id-copy} to create a globally unique ID for}
5271 @r{the current entry and copy it to the kill-ring.}
5274 When @code{t}, insert an hline after every line. When a number @var{N}, insert
5275 an hline before each headline with level @code{<= @var{N}}.
5277 When set to @code{t}, force column groups to get vertical lines.
5279 When set to a number, don't capture entries below this level.
5280 @item :skip-empty-rows
5281 When set to @code{t}, skip rows where the only non-empty specifier of the
5282 column view is @code{ITEM}.
5287 The following commands insert or update the dynamic block:
5290 @orgcmd{C-c C-x i,org-insert-columns-dblock}
5291 Insert a dynamic block capturing a column view. You will be prompted
5292 for the scope or ID of the view.
5293 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
5294 Update dynamic block at point. The cursor needs to be in the
5295 @code{#+BEGIN} line of the dynamic block.
5296 @orgcmd{C-u C-c C-x C-u,org-update-all-dblocks}
5297 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
5298 you have several clock table blocks, column-capturing blocks or other dynamic
5302 You can add formulas to the column view table and you may add plotting
5303 instructions in front of the table---these will survive an update of the
5304 block. If there is a @code{#+TBLFM:} after the table, the table will
5305 actually be recalculated automatically after an update.
5307 An alternative way to capture and process property values into a table is
5308 provided by Eric Schulte's @file{org-collector.el} which is a contributed
5309 package@footnote{Contributed packages are not part of Emacs, but are
5310 distributed with the main distribution of Org (visit
5311 @uref{http://orgmode.org}).}. It provides a general API to collect
5312 properties from entries in a certain scope, and arbitrary Lisp expressions to
5313 process these values before inserting them into a table or a dynamic block.
5315 @node Property API, , Column view, Properties and Columns
5316 @section The Property API
5317 @cindex properties, API
5318 @cindex API, for properties
5320 There is a full API for accessing and changing properties. This API can
5321 be used by Emacs Lisp programs to work with properties and to implement
5322 features based on them. For more information see @ref{Using the
5325 @node Dates and Times, Capture - Refile - Archive, Properties and Columns, Top
5326 @chapter Dates and times
5332 To assist project planning, TODO items can be labeled with a date and/or
5333 a time. The specially formatted string carrying the date and time
5334 information is called a @emph{timestamp} in Org mode. This may be a
5335 little confusing because timestamp is often used as indicating when
5336 something was created or last changed. However, in Org mode this term
5337 is used in a much wider sense.
5340 * Timestamps:: Assigning a time to a tree entry
5341 * Creating timestamps:: Commands which insert timestamps
5342 * Deadlines and scheduling:: Planning your work
5343 * Clocking work time:: Tracking how long you spend on a task
5344 * Effort estimates:: Planning work effort in advance
5345 * Relative timer:: Notes with a running timer
5346 * Countdown timer:: Starting a countdown timer for a task
5350 @node Timestamps, Creating timestamps, Dates and Times, Dates and Times
5351 @section Timestamps, deadlines, and scheduling
5353 @cindex ranges, time
5358 A timestamp is a specification of a date (possibly with a time or a range of
5359 times) in a special format, either @samp{<2003-09-16 Tue>}@footnote{In this
5360 simplest form, the day name is optional when you type the date yourself.
5361 However, any dates inserted or modified by Org will add that day name, for
5362 reading convenience.} or @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16
5363 Tue 12:00-12:30>}@footnote{This is inspired by the standard ISO 8601
5364 date/time format. To use an alternative format, see @ref{Custom time
5365 format}.}. A timestamp can appear anywhere in the headline or body of an Org
5366 tree entry. Its presence causes entries to be shown on specific dates in the
5367 agenda (@pxref{Weekly/daily agenda}). We distinguish:
5370 @item Plain timestamp; Event; Appointment
5373 A simple timestamp just assigns a date/time to an item. This is just
5374 like writing down an appointment or event in a paper agenda. In the
5375 timeline and agenda displays, the headline of an entry associated with a
5376 plain timestamp will be shown exactly on that date.
5379 * Meet Peter at the movies <2006-11-01 Wed 19:15>
5380 * Discussion on climate change <2006-11-02 Thu 20:00-22:00>
5383 @item Timestamp with repeater interval
5384 @cindex timestamp, with repeater interval
5385 A timestamp may contain a @emph{repeater interval}, indicating that it
5386 applies not only on the given date, but again and again after a certain
5387 interval of N days (d), weeks (w), months (m), or years (y). The
5388 following will show up in the agenda every Wednesday:
5391 * Pick up Sam at school <2007-05-16 Wed 12:30 +1w>
5394 @item Diary-style sexp entries
5395 For more complex date specifications, Org mode supports using the special
5396 sexp diary entries implemented in the Emacs calendar/diary
5397 package@footnote{When working with the standard diary sexp functions, you
5398 need to be very careful with the order of the arguments. That order depend
5399 evilly on the variable @code{calendar-date-style} (or, for older Emacs
5400 versions, @code{european-calendar-style}). For example, to specify a date
5401 December 12, 2005, the call might look like @code{(diary-date 12 1 2005)} or
5402 @code{(diary-date 1 12 2005)} or @code{(diary-date 2005 12 1)}, depending on
5403 the settings. This has been the source of much confusion. Org mode users
5404 can resort to special versions of these functions like @code{org-date} or
5405 @code{org-anniversary}. These work just like the corresponding @code{diary-}
5406 functions, but with stable ISO order of arguments (year, month, day) wherever
5407 applicable, independent of the value of @code{calendar-date-style}.}. For example
5410 * The nerd meeting on every 2nd Thursday of the month
5411 <%%(org-float t 4 2)>
5414 @item Time/Date range
5417 Two timestamps connected by @samp{--} denote a range. The headline
5418 will be shown on the first and last day of the range, and on any dates
5419 that are displayed and fall in the range. Here is an example:
5422 ** Meeting in Amsterdam
5423 <2004-08-23 Mon>--<2004-08-26 Thu>
5426 @item Inactive timestamp
5427 @cindex timestamp, inactive
5428 @cindex inactive timestamp
5429 Just like a plain timestamp, but with square brackets instead of
5430 angular ones. These timestamps are inactive in the sense that they do
5431 @emph{not} trigger an entry to show up in the agenda.
5434 * Gillian comes late for the fifth time [2006-11-01 Wed]
5439 @node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times
5440 @section Creating timestamps
5441 @cindex creating timestamps
5442 @cindex timestamps, creating
5444 For Org mode to recognize timestamps, they need to be in the specific
5445 format. All commands listed below produce timestamps in the correct
5449 @orgcmd{C-c .,org-time-stamp}
5450 Prompt for a date and insert a corresponding timestamp. When the cursor is
5451 at an existing timestamp in the buffer, the command is used to modify this
5452 timestamp instead of inserting a new one. When this command is used twice in
5453 succession, a time range is inserted.
5455 @orgcmd{C-c !,org-time-stamp-inactive}
5456 Like @kbd{C-c .}, but insert an inactive timestamp that will not cause
5463 @vindex org-time-stamp-rounding-minutes
5464 Like @kbd{C-c .} and @kbd{C-c !}, but use the alternative format which
5465 contains date and time. The default time can be rounded to multiples of 5
5466 minutes, see the option @code{org-time-stamp-rounding-minutes}.
5469 Normalize timestamp, insert/fix day name if missing or wrong.
5471 @orgcmd{C-c <,org-date-from-calendar}
5472 Insert a timestamp corresponding to the cursor date in the Calendar.
5474 @orgcmd{C-c >,org-goto-calendar}
5475 Access the Emacs calendar for the current date. If there is a
5476 timestamp in the current line, go to the corresponding date
5479 @orgcmd{C-c C-o,org-open-at-point}
5480 Access the agenda for the date given by the timestamp or -range at
5481 point (@pxref{Weekly/daily agenda}).
5483 @orgcmdkkcc{S-@key{left},S-@key{right},org-timestamp-down-day,org-timestamp-up-day}
5484 Change date at cursor by one day. These key bindings conflict with
5485 shift-selection and related modes (@pxref{Conflicts}).
5487 @orgcmdkkcc{S-@key{up},S-@key{down},org-timestamp-up,org-timestamp-down-down}
5488 Change the item under the cursor in a timestamp. The cursor can be on a
5489 year, month, day, hour or minute. When the timestamp contains a time range
5490 like @samp{15:30-16:30}, modifying the first time will also shift the second,
5491 shifting the time block with constant length. To change the length, modify
5492 the second time. Note that if the cursor is in a headline and not at a
5493 timestamp, these same keys modify the priority of an item.
5494 (@pxref{Priorities}). The key bindings also conflict with shift-selection and
5495 related modes (@pxref{Conflicts}).
5497 @orgcmd{C-c C-y,org-evaluate-time-range}
5498 @cindex evaluate time range
5499 Evaluate a time range by computing the difference between start and end.
5500 With a prefix argument, insert result after the time range (in a table: into
5501 the following column).
5506 * The date/time prompt:: How Org mode helps you entering date and time
5507 * Custom time format:: Making dates look different
5510 @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps
5511 @subsection The date/time prompt
5512 @cindex date, reading in minibuffer
5513 @cindex time, reading in minibuffer
5515 @vindex org-read-date-prefer-future
5516 When Org mode prompts for a date/time, the default is shown in default
5517 date/time format, and the prompt therefore seems to ask for a specific
5518 format. But it will in fact accept any string containing some date and/or
5519 time information, and it is really smart about interpreting your input. You
5520 can, for example, use @kbd{C-y} to paste a (possibly multi-line) string
5521 copied from an email message. Org mode will find whatever information is in
5522 there and derive anything you have not specified from the @emph{default date
5523 and time}. The default is usually the current date and time, but when
5524 modifying an existing timestamp, or when entering the second stamp of a
5525 range, it is taken from the stamp in the buffer. When filling in
5526 information, Org mode assumes that most of the time you will want to enter a
5527 date in the future: if you omit the month/year and the given day/month is
5528 @i{before} today, it will assume that you mean a future date@footnote{See the
5529 variable @code{org-read-date-prefer-future}. You may set that variable to
5530 the symbol @code{time} to even make a time before now shift the date to
5531 tomorrow.}. If the date has been automatically shifted into the future, the
5532 time prompt will show this with @samp{(=>F).}
5534 For example, let's assume that today is @b{June 13, 2006}. Here is how
5535 various inputs will be interpreted, the items filled in by Org mode are
5539 3-2-5 @result{} 2003-02-05
5540 2/5/3 @result{} 2003-02-05
5541 14 @result{} @b{2006}-@b{06}-14
5542 12 @result{} @b{2006}-@b{07}-12
5543 2/5 @result{} @b{2007}-02-05
5544 Fri @result{} nearest Friday (default date or later)
5545 sep 15 @result{} @b{2006}-09-15
5546 feb 15 @result{} @b{2007}-02-15
5547 sep 12 9 @result{} 2009-09-12
5548 12:45 @result{} @b{2006}-@b{06}-@b{13} 12:45
5549 22 sept 0:34 @result{} @b{2006}-09-22 0:34
5550 w4 @result{} ISO week for of the current year @b{2006}
5551 2012 w4 fri @result{} Friday of ISO week 4 in 2012
5552 2012-w04-5 @result{} Same as above
5555 Furthermore you can specify a relative date by giving, as the
5556 @emph{first} thing in the input: a plus/minus sign, a number and a
5557 letter ([dwmy]) to indicate change in days, weeks, months, or years. With a
5558 single plus or minus, the date is always relative to today. With a
5559 double plus or minus, it is relative to the default date. If instead of
5560 a single letter, you use the abbreviation of day name, the date will be
5561 the Nth such day, e.g.@:
5566 +4d @result{} four days from today
5567 +4 @result{} same as above
5568 +2w @result{} two weeks from today
5569 ++5 @result{} five days from default date
5570 +2tue @result{} second Tuesday from now.
5573 @vindex parse-time-months
5574 @vindex parse-time-weekdays
5575 The function understands English month and weekday abbreviations. If
5576 you want to use unabbreviated names and/or other languages, configure
5577 the variables @code{parse-time-months} and @code{parse-time-weekdays}.
5579 @vindex org-read-date-force-compatible-dates
5580 Not all dates can be represented in a given Emacs implementation. By default
5581 Org mode forces dates into the compatibility range 1970--2037 which works on
5582 all Emacs implementations. If you want to use dates outside of this range,
5583 read the docstring of the variable
5584 @code{org-read-date-force-compatible-dates}.
5586 You can specify a time range by giving start and end times or by giving a
5587 start time and a duration (in HH:MM format). Use one or two dash(es) as the
5588 separator in the former case and use '+' as the separator in the latter
5592 11am-1:15pm @result{} 11:00-13:15
5593 11am--1:15pm @result{} same as above
5594 11am+2:15 @result{} same as above
5597 @cindex calendar, for selecting date
5598 @vindex org-popup-calendar-for-date-prompt
5599 Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
5600 you don't need/want the calendar, configure the variable
5601 @code{org-popup-calendar-for-date-prompt}.}. When you exit the date
5602 prompt, either by clicking on a date in the calendar, or by pressing
5603 @key{RET}, the date selected in the calendar will be combined with the
5604 information entered at the prompt. You can control the calendar fully
5605 from the minibuffer:
5612 @kindex S-@key{right}
5613 @kindex S-@key{left}
5614 @kindex S-@key{down}
5616 @kindex M-S-@key{right}
5617 @kindex M-S-@key{left}
5620 @key{RET} @r{Choose date at cursor in calendar.}
5621 mouse-1 @r{Select date by clicking on it.}
5622 S-@key{right}/@key{left} @r{One day forward/backward.}
5623 S-@key{down}/@key{up} @r{One week forward/backward.}
5624 M-S-@key{right}/@key{left} @r{One month forward/backward.}
5625 > / < @r{Scroll calendar forward/backward by one month.}
5626 M-v / C-v @r{Scroll calendar forward/backward by 3 months.}
5629 @vindex org-read-date-display-live
5630 The actions of the date/time prompt may seem complex, but I assure you they
5631 will grow on you, and you will start getting annoyed by pretty much any other
5632 way of entering a date/time out there. To help you understand what is going
5633 on, the current interpretation of your input will be displayed live in the
5634 minibuffer@footnote{If you find this distracting, turn the display of with
5635 @code{org-read-date-display-live}.}.
5637 @node Custom time format, , The date/time prompt, Creating timestamps
5638 @subsection Custom time format
5639 @cindex custom date/time format
5640 @cindex time format, custom
5641 @cindex date format, custom
5643 @vindex org-display-custom-times
5644 @vindex org-time-stamp-custom-formats
5645 Org mode uses the standard ISO notation for dates and times as it is
5646 defined in ISO 8601. If you cannot get used to this and require another
5647 representation of date and time to keep you happy, you can get it by
5648 customizing the variables @code{org-display-custom-times} and
5649 @code{org-time-stamp-custom-formats}.
5652 @orgcmd{C-c C-x C-t,org-toggle-time-stamp-overlays}
5653 Toggle the display of custom formats for dates and times.
5657 Org mode needs the default format for scanning, so the custom date/time
5658 format does not @emph{replace} the default format---instead it is put
5659 @emph{over} the default format using text properties. This has the
5660 following consequences:
5663 You cannot place the cursor onto a timestamp anymore, only before or
5666 The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
5667 each component of a timestamp. If the cursor is at the beginning of
5668 the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
5669 just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the
5670 time will be changed by one minute.
5672 If the timestamp contains a range of clock times or a repeater, these
5673 will not be overlaid, but remain in the buffer as they were.
5675 When you delete a timestamp character-by-character, it will only
5676 disappear from the buffer after @emph{all} (invisible) characters
5677 belonging to the ISO timestamp have been removed.
5679 If the custom timestamp format is longer than the default and you are
5680 using dates in tables, table alignment will be messed up. If the custom
5681 format is shorter, things do work as expected.
5685 @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times
5686 @section Deadlines and scheduling
5688 A timestamp may be preceded by special keywords to facilitate planning:
5692 @cindex DEADLINE keyword
5694 Meaning: the task (most likely a TODO item, though not necessarily) is supposed
5695 to be finished on that date.
5697 @vindex org-deadline-warning-days
5698 On the deadline date, the task will be listed in the agenda. In
5699 addition, the agenda for @emph{today} will carry a warning about the
5700 approaching or missed deadline, starting
5701 @code{org-deadline-warning-days} before the due date, and continuing
5702 until the entry is marked DONE. An example:
5705 *** TODO write article about the Earth for the Guide
5706 The editor in charge is [[bbdb:Ford Prefect]]
5707 DEADLINE: <2004-02-29 Sun>
5710 You can specify a different lead time for warnings for a specific
5711 deadlines using the following syntax. Here is an example with a warning
5712 period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}.
5715 @cindex SCHEDULED keyword
5717 Meaning: you are planning to start working on that task on the given
5720 @vindex org-agenda-skip-scheduled-if-done
5721 The headline will be listed under the given date@footnote{It will still
5722 be listed on that date after it has been marked DONE. If you don't like
5723 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In
5724 addition, a reminder that the scheduled date has passed will be present
5725 in the compilation for @emph{today}, until the entry is marked DONE, i.e.@:
5726 the task will automatically be forwarded until completed.
5729 *** TODO Call Trillian for a date on New Years Eve.
5730 SCHEDULED: <2004-12-25 Sat>
5734 @b{Important:} Scheduling an item in Org mode should @i{not} be
5735 understood in the same way that we understand @i{scheduling a meeting}.
5736 Setting a date for a meeting is just a simple appointment, you should
5737 mark this entry with a simple plain timestamp, to get this item shown
5738 on the date where it applies. This is a frequent misunderstanding by
5739 Org users. In Org mode, @i{scheduling} means setting a date when you
5740 want to start working on an action item.
5743 You may use timestamps with repeaters in scheduling and deadline
5744 entries. Org mode will issue early and late warnings based on the
5745 assumption that the timestamp represents the @i{nearest instance} of
5746 the repeater. However, the use of diary sexp entries like
5748 @code{<%%(org-float t 42)>}
5750 in scheduling and deadline timestamps is limited. Org mode does not
5751 know enough about the internals of each sexp function to issue early and
5752 late warnings. However, it will show the item on each day where the
5756 * Inserting deadline/schedule:: Planning items
5757 * Repeated tasks:: Items that show up again and again
5760 @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling
5761 @subsection Inserting deadlines or schedules
5763 The following commands allow you to quickly insert@footnote{The @samp{SCHEDULED} and
5764 @samp{DEADLINE} dates are inserted on the line right below the headline. Don't put
5765 any text between this line and the headline.} a deadline or to schedule
5770 @orgcmd{C-c C-d,org-deadline}
5771 Insert @samp{DEADLINE} keyword along with a stamp. The insertion will happen
5772 in the line directly following the headline. Any CLOSED timestamp will be
5773 removed. When called with a prefix arg, an existing deadline will be removed
5774 from the entry. Depending on the variable @code{org-log-redeadline}@footnote{with corresponding
5775 @code{#+STARTUP} keywords @code{logredeadline}, @code{lognoteredeadline},
5776 and @code{nologredeadline}}, a note will be taken when changing an existing
5779 @orgcmd{C-c C-s,org-schedule}
5780 Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will
5781 happen in the line directly following the headline. Any CLOSED timestamp
5782 will be removed. When called with a prefix argument, remove the scheduling
5783 date from the entry. Depending on the variable
5784 @code{org-log-reschedule}@footnote{with corresponding @code{#+STARTUP}
5785 keywords @code{logreschedule}, @code{lognotereschedule}, and
5786 @code{nologreschedule}}, a note will be taken when changing an existing
5789 @orgcmd{C-c C-x C-k,org-mark-entry-for-agenda-action}
5792 Mark the current entry for agenda action. After you have marked the entry
5793 like this, you can open the agenda or the calendar to find an appropriate
5794 date. With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to
5795 schedule the marked item.
5797 @orgcmd{C-c / d,org-check-deadlines}
5798 @cindex sparse tree, for deadlines
5799 @vindex org-deadline-warning-days
5800 Create a sparse tree with all deadlines that are either past-due, or
5801 which will become due within @code{org-deadline-warning-days}.
5802 With @kbd{C-u} prefix, show all deadlines in the file. With a numeric
5803 prefix, check that many days. For example, @kbd{C-1 C-c / d} shows
5804 all deadlines due tomorrow.
5806 @orgcmd{C-c / b,org-check-before-date}
5807 Sparse tree for deadlines and scheduled items before a given date.
5809 @orgcmd{C-c / a,org-check-after-date}
5810 Sparse tree for deadlines and scheduled items after a given date.
5813 Note that @code{org-schedule} and @code{org-deadline} supports
5814 setting the date by indicating a relative time: e.g. +1d will set
5815 the date to the next day after today, and --1w will set the date
5816 to the previous week before any current timestamp.
5818 @node Repeated tasks, , Inserting deadline/schedule, Deadlines and scheduling
5819 @subsection Repeated tasks
5820 @cindex tasks, repeated
5821 @cindex repeated tasks
5823 Some tasks need to be repeated again and again. Org mode helps to
5824 organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
5825 or plain timestamp. In the following example
5827 ** TODO Pay the rent
5828 DEADLINE: <2005-10-01 Sat +1m>
5831 the @code{+1m} is a repeater; the intended interpretation is that the task
5832 has a deadline on <2005-10-01> and repeats itself every (one) month starting
5833 from that time. If you need both a repeater and a special warning period in
5834 a deadline entry, the repeater should come first and the warning period last:
5835 @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
5837 @vindex org-todo-repeat-to-state
5838 Deadlines and scheduled items produce entries in the agenda when they are
5839 over-due, so it is important to be able to mark such an entry as completed
5840 once you have done so. When you mark a DEADLINE or a SCHEDULE with the TODO
5841 keyword DONE, it will no longer produce entries in the agenda. The problem
5842 with this is, however, that then also the @emph{next} instance of the
5843 repeated entry will not be active. Org mode deals with this in the following
5844 way: When you try to mark such an entry DONE (using @kbd{C-c C-t}), it will
5845 shift the base date of the repeating timestamp by the repeater interval, and
5846 immediately set the entry state back to TODO@footnote{In fact, the target
5847 state is taken from, in this sequence, the @code{REPEAT_TO_STATE} property or
5848 the variable @code{org-todo-repeat-to-state}. If neither of these is
5849 specified, the target state defaults to the first state of the TODO state
5850 sequence.}. In the example above, setting the state to DONE would actually
5851 switch the date like this:
5854 ** TODO Pay the rent
5855 DEADLINE: <2005-11-01 Tue +1m>
5858 @vindex org-log-repeat
5859 A timestamp@footnote{You can change this using the option
5860 @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
5861 @code{lognoterepeat}, and @code{nologrepeat}. With @code{lognoterepeat}, you
5862 will also be prompted for a note.} will be added under the deadline, to keep
5863 a record that you actually acted on the previous instance of this deadline.
5865 As a consequence of shifting the base date, this entry will no longer be
5866 visible in the agenda when checking past dates, but all future instances
5869 With the @samp{+1m} cookie, the date shift will always be exactly one
5870 month. So if you have not paid the rent for three months, marking this
5871 entry DONE will still keep it as an overdue deadline. Depending on the
5872 task, this may not be the best way to handle it. For example, if you
5873 forgot to call your father for 3 weeks, it does not make sense to call
5874 him 3 times in a single day to make up for it. Finally, there are tasks
5875 like changing batteries which should always repeat a certain time
5876 @i{after} the last time you did it. For these tasks, Org mode has
5877 special repeaters @samp{++} and @samp{.+}. For example:
5881 DEADLINE: <2008-02-10 Sun ++1w>
5882 Marking this DONE will shift the date by at least one week,
5883 but also by as many weeks as it takes to get this date into
5884 the future. However, it stays on a Sunday, even if you called
5885 and marked it done on Saturday.
5886 ** TODO Check the batteries in the smoke detectors
5887 DEADLINE: <2005-11-01 Tue .+1m>
5888 Marking this DONE will shift the date to one month after
5892 You may have both scheduling and deadline information for a specific
5893 task---just make sure that the repeater intervals on both are the same.
5895 An alternative to using a repeater is to create a number of copies of a task
5896 subtree, with dates shifted in each copy. The command @kbd{C-c C-x c} was
5897 created for this purpose, it is described in @ref{Structure editing}.
5900 @node Clocking work time, Effort estimates, Deadlines and scheduling, Dates and Times
5901 @section Clocking work time
5902 @cindex clocking time
5903 @cindex time clocking
5905 Org mode allows you to clock the time you spend on specific tasks in a
5906 project. When you start working on an item, you can start the clock.
5907 When you stop working on that task, or when you mark the task done, the
5908 clock is stopped and the corresponding time interval is recorded. It
5909 also computes the total time spent on each subtree of a project. And it
5910 remembers a history or tasks recently clocked, to that you can jump quickly
5911 between a number of tasks absorbing your time.
5913 To save the clock history across Emacs sessions, use
5915 (setq org-clock-persist 'history)
5916 (org-clock-persistence-insinuate)
5918 When you clock into a new task after resuming Emacs, the incomplete
5919 clock@footnote{To resume the clock under the assumption that you have worked
5920 on this task while outside Emacs, use @code{(setq org-clock-persist t)}.}
5921 will be found (@pxref{Resolving idle time}) and you will be prompted about
5925 * Clocking commands:: Starting and stopping a clock
5926 * The clock table:: Detailed reports
5927 * Resolving idle time:: Resolving time when you've been idle
5930 @node Clocking commands, The clock table, Clocking work time, Clocking work time
5931 @subsection Clocking commands
5934 @orgcmd{C-c C-x C-i,org-clock-in}
5935 @vindex org-clock-into-drawer
5936 @cindex property, LOG_INTO_DRAWER
5937 Start the clock on the current item (clock-in). This inserts the CLOCK
5938 keyword together with a timestamp. If this is not the first clocking of
5939 this item, the multiple CLOCK lines will be wrapped into a
5940 @code{:LOGBOOK:} drawer (see also the variable
5941 @code{org-clock-into-drawer}). You can also overrule
5942 the setting of this variable for a subtree by setting a
5943 @code{CLOCK_INTO_DRAWER} or @code{LOG_INTO_DRAWER} property.
5944 When called with a @kbd{C-u} prefix argument,
5945 select the task from a list of recently clocked tasks. With two @kbd{C-u
5946 C-u} prefixes, clock into the task at point and mark it as the default task.
5947 The default task will always be available when selecting a clocking task,
5948 with letter @kbd{d}.@*
5949 @cindex property: CLOCK_MODELINE_TOTAL
5950 @cindex property: LAST_REPEAT
5951 @vindex org-clock-modeline-total
5952 While the clock is running, the current clocking time is shown in the mode
5953 line, along with the title of the task. The clock time shown will be all
5954 time ever clocked for this task and its children. If the task has an effort
5955 estimate (@pxref{Effort estimates}), the mode line displays the current
5956 clocking time against it@footnote{To add an effort estimate ``on the fly'',
5957 hook a function doing this to @code{org-clock-in-prepare-hook}.} If the task
5958 is a repeating one (@pxref{Repeated tasks}), only the time since the last
5959 reset of the task @footnote{as recorded by the @code{LAST_REPEAT} property}
5960 will be shown. More control over what time is shown can be exercised with
5961 the @code{CLOCK_MODELINE_TOTAL} property. It may have the values
5962 @code{current} to show only the current clocking instance, @code{today} to
5963 show all time clocked on this tasks today (see also the variable
5964 @code{org-extend-today-until}), @code{all} to include all time, or
5965 @code{auto} which is the default@footnote{See also the variable
5966 @code{org-clock-modeline-total}.}.@* Clicking with @kbd{mouse-1} onto the
5967 mode line entry will pop up a menu with clocking options.
5969 @orgcmd{C-c C-x C-o,org-clock-out}
5970 @vindex org-log-note-clock-out
5971 Stop the clock (clock-out). This inserts another timestamp at the same
5972 location where the clock was last started. It also directly computes
5973 the resulting time in inserts it after the time range as @samp{=>
5974 HH:MM}. See the variable @code{org-log-note-clock-out} for the
5975 possibility to record an additional note together with the clock-out
5976 timestamp@footnote{The corresponding in-buffer setting is:
5977 @code{#+STARTUP: lognoteclock-out}}.
5978 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
5979 Update the effort estimate for the current clock task.
5982 @orgcmdkkc{C-c C-c,C-c C-y,org-evaluate-time-range}
5983 Recompute the time interval after changing one of the timestamps. This
5984 is only necessary if you edit the timestamps directly. If you change
5985 them with @kbd{S-@key{cursor}} keys, the update is automatic.
5986 @orgcmd{C-S-@key{up/down},org-clock-timestamps-up/down}
5987 On @code{CLOCK} log lines, increase/decrease both timestamps at the same
5988 time so that duration keeps the same.
5989 @orgcmd{C-c C-t,org-todo}
5990 Changing the TODO state of an item to DONE automatically stops the clock
5991 if it is running in this same item.
5992 @orgcmd{C-c C-x C-x,org-clock-cancel}
5993 Cancel the current clock. This is useful if a clock was started by
5994 mistake, or if you ended up working on something else.
5995 @orgcmd{C-c C-x C-j,org-clock-goto}
5996 Jump to the headline of the currently clocked in task. With a @kbd{C-u}
5997 prefix arg, select the target task from a list of recently clocked tasks.
5998 @orgcmd{C-c C-x C-d,org-clock-display}
5999 @vindex org-remove-highlights-with-change
6000 Display time summaries for each subtree in the current buffer. This puts
6001 overlays at the end of each headline, showing the total time recorded under
6002 that heading, including the time of any subheadings. You can use visibility
6003 cycling to study the tree, but the overlays disappear when you change the
6004 buffer (see variable @code{org-remove-highlights-with-change}) or press
6008 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
6009 the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
6010 worked on or closed during a day.
6012 @node The clock table, Resolving idle time, Clocking commands, Clocking work time
6013 @subsection The clock table
6014 @cindex clocktable, dynamic block
6015 @cindex report, of clocked time
6017 Org mode can produce quite complex reports based on the time clocking
6018 information. Such a report is called a @emph{clock table}, because it is
6019 formatted as one or several Org tables.
6022 @orgcmd{C-c C-x C-r,org-clock-report}
6023 Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
6024 report as an Org mode table into the current file. When the cursor is
6025 at an existing clock table, just update it. When called with a prefix
6026 argument, jump to the first clock report in the current document and
6027 update it. The clock table always includes also trees with
6028 @code{:ARCHIVE:} tag.
6029 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
6030 Update dynamic block at point. The cursor needs to be in the
6031 @code{#+BEGIN} line of the dynamic block.
6032 @orgkey{C-u C-c C-x C-u}
6033 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
6034 you have several clock table blocks in a buffer.
6035 @orgcmdkxkc{S-@key{left},S-@key{right},org-clocktable-try-shift}
6036 Shift the current @code{:block} interval and update the table. The cursor
6037 needs to be in the @code{#+BEGIN: clocktable} line for this command. If
6038 @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
6042 Here is an example of the frame for a clock table as it is inserted into the
6043 buffer with the @kbd{C-c C-x C-r} command:
6045 @cindex #+BEGIN, clocktable
6047 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
6051 @vindex org-clocktable-defaults
6052 The @samp{BEGIN} line and specify a number of options to define the scope,
6053 structure, and formatting of the report. Defaults for all these options can
6054 be configured in the variable @code{org-clocktable-defaults}.
6056 @noindent First there are options that determine which clock entries are to
6059 :maxlevel @r{Maximum level depth to which times are listed in the table.}
6060 @r{Clocks at deeper levels will be summed into the upper level.}
6061 :scope @r{The scope to consider. This can be any of the following:}
6062 nil @r{the current buffer or narrowed region}
6063 file @r{the full current buffer}
6064 subtree @r{the subtree where the clocktable is located}
6065 tree@var{N} @r{the surrounding level @var{N} tree, for example @code{tree3}}
6066 tree @r{the surrounding level 1 tree}
6067 agenda @r{all agenda files}
6068 ("file"..) @r{scan these files}
6069 file-with-archives @r{current file and its archives}
6070 agenda-with-archives @r{all agenda files, including archives}
6071 :block @r{The time block to consider. This block is specified either}
6072 @r{absolute, or relative to the current time and may be any of}
6074 2007-12-31 @r{New year eve 2007}
6075 2007-12 @r{December 2007}
6076 2007-W50 @r{ISO-week 50 in 2007}
6077 2007-Q2 @r{2nd quarter in 2007}
6078 2007 @r{the year 2007}
6079 today, yesterday, today-@var{N} @r{a relative day}
6080 thisweek, lastweek, thisweek-@var{N} @r{a relative week}
6081 thismonth, lastmonth, thismonth-@var{N} @r{a relative month}
6082 thisyear, lastyear, thisyear-@var{N} @r{a relative year}
6083 @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
6084 :tstart @r{A time string specifying when to start considering times.}
6085 :tend @r{A time string specifying when to stop considering times.}
6086 :step @r{@code{week} or @code{day}, to split the table into chunks.}
6087 @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
6088 :stepskip0 @r{Do not show steps that have zero time.}
6089 :fileskip0 @r{Do not show table sections from files which did not contribute.}
6090 :tags @r{A tags match to select entries that should contribute. See}
6091 @r{@ref{Matching tags and properties} for the match syntax.}
6094 Then there are options which determine the formatting of the table. There
6095 options are interpreted by the function @code{org-clocktable-write-default},
6096 but you can specify your own function using the @code{:formatter} parameter.
6098 :emphasize @r{When @code{t}, emphasize level one and level two items.}
6099 :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".}
6100 :link @r{Link the item headlines in the table to their origins.}
6101 :narrow @r{An integer to limit the width of the headline column in}
6102 @r{the org table. If you write it like @samp{50!}, then the}
6103 @r{headline will also be shortened in export.}
6104 :indent @r{Indent each headline field according to its level.}
6105 :tcolumns @r{Number of columns to be used for times. If this is smaller}
6106 @r{than @code{:maxlevel}, lower levels will be lumped into one column.}
6107 :level @r{Should a level number column be included?}
6108 :compact @r{Abbreviation for @code{:level nil :indent t :narrow 40! :tcolumns 1}}
6109 @r{All are overwritten except if there is an explicit @code{:narrow}}
6110 :timestamp @r{A timestamp for the entry, when available. Look for SCHEDULED,}
6111 @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.}
6112 :properties @r{List of properties that should be shown in the table. Each}
6113 @r{property will get its own column.}
6114 :inherit-props @r{When this flag is @code{t}, the values for @code{:properties} will be inherited.}
6115 :formula @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
6116 @r{As a special case, @samp{:formula %} adds a column with % time.}
6117 @r{If you do not specify a formula here, any existing formula}
6118 @r{below the clock table will survive updates and be evaluated.}
6119 :formatter @r{A function to format clock data and insert it into the buffer.}
6121 To get a clock summary of the current level 1 tree, for the current
6122 day, you could write
6124 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
6128 and to use a specific time range you could write@footnote{Note that all
6129 parameters must be specified in a single line---the line is broken here
6130 only to fit it into the manual.}
6132 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
6133 :tend "<2006-08-10 Thu 12:00>"
6136 A summary of the current subtree with % times would be
6138 #+BEGIN: clocktable :scope subtree :link t :formula %
6141 A horizontally compact representation of everything clocked during last week
6144 #+BEGIN: clocktable :scope agenda :block lastweek :compact t
6148 @node Resolving idle time, , The clock table, Clocking work time
6149 @subsection Resolving idle time
6150 @cindex resolve idle time
6152 @cindex idle, resolve, dangling
6153 If you clock in on a work item, and then walk away from your
6154 computer---perhaps to take a phone call---you often need to ``resolve'' the
6155 time you were away by either subtracting it from the current clock, or
6156 applying it to another one.
6158 @vindex org-clock-idle-time
6159 By customizing the variable @code{org-clock-idle-time} to some integer, such
6160 as 10 or 15, Emacs can alert you when you get back to your computer after
6161 being idle for that many minutes@footnote{On computers using Mac OS X,
6162 idleness is based on actual user idleness, not just Emacs' idle time. For
6163 X11, you can install a utility program @file{x11idle.c}, available in the
6164 UTILITIES directory of the Org git distribution, to get the same general
6165 treatment of idleness. On other systems, idle time refers to Emacs idle time
6166 only.}, and ask what you want to do with the idle time. There will be a
6167 question waiting for you when you get back, indicating how much idle time has
6168 passed (constantly updated with the current amount), as well as a set of
6169 choices to correct the discrepancy:
6173 To keep some or all of the minutes and stay clocked in, press @kbd{k}. Org
6174 will ask how many of the minutes to keep. Press @key{RET} to keep them all,
6175 effectively changing nothing, or enter a number to keep that many minutes.
6177 If you use the shift key and press @kbd{K}, it will keep however many minutes
6178 you request and then immediately clock out of that task. If you keep all of
6179 the minutes, this is the same as just clocking out of the current task.
6181 To keep none of the minutes, use @kbd{s} to subtract all the away time from
6182 the clock, and then check back in from the moment you returned.
6184 To keep none of the minutes and just clock out at the start of the away time,
6185 use the shift key and press @kbd{S}. Remember that using shift will always
6186 leave you clocked out, no matter which option you choose.
6188 To cancel the clock altogether, use @kbd{C}. Note that if instead of
6189 canceling you subtract the away time, and the resulting clock amount is less
6190 than a minute, the clock will still be canceled rather than clutter up the
6191 log with an empty entry.
6194 What if you subtracted those away minutes from the current clock, and now
6195 want to apply them to a new clock? Simply clock in to any task immediately
6196 after the subtraction. Org will notice that you have subtracted time ``on
6197 the books'', so to speak, and will ask if you want to apply those minutes to
6198 the next task you clock in on.
6200 There is one other instance when this clock resolution magic occurs. Say you
6201 were clocked in and hacking away, and suddenly your cat chased a mouse who
6202 scared a hamster that crashed into your UPS's power button! You suddenly
6203 lose all your buffers, but thanks to auto-save you still have your recent Org
6204 mode changes, including your last clock in.
6206 If you restart Emacs and clock into any task, Org will notice that you have a
6207 dangling clock which was never clocked out from your last session. Using
6208 that clock's starting time as the beginning of the unaccounted-for period,
6209 Org will ask how you want to resolve that time. The logic and behavior is
6210 identical to dealing with away time due to idleness; it is just happening due
6211 to a recovery event rather than a set amount of idle time.
6213 You can also check all the files visited by your Org agenda for dangling
6214 clocks at any time using @kbd{M-x org-resolve-clocks}.
6216 @node Effort estimates, Relative timer, Clocking work time, Dates and Times
6217 @section Effort estimates
6218 @cindex effort estimates
6220 @cindex property, Effort
6221 @vindex org-effort-property
6222 If you want to plan your work in a very detailed way, or if you need to
6223 produce offers with quotations of the estimated work effort, you may want to
6224 assign effort estimates to entries. If you are also clocking your work, you
6225 may later want to compare the planned effort with the actual working time, a
6226 great way to improve planning estimates. Effort estimates are stored in a
6227 special property @samp{Effort}@footnote{You may change the property being
6228 used with the variable @code{org-effort-property}.}. You can set the effort
6229 for an entry with the following commands:
6232 @orgcmd{C-c C-x e,org-set-effort}
6233 Set the effort estimate for the current entry. With a numeric prefix
6234 argument, set it to the Nth allowed value (see below). This command is also
6235 accessible from the agenda with the @kbd{e} key.
6236 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6237 Modify the effort estimate of the item currently being clocked.
6240 Clearly the best way to work with effort estimates is through column view
6241 (@pxref{Column view}). You should start by setting up discrete values for
6242 effort estimates, and a @code{COLUMNS} format that displays these values
6243 together with clock sums (if you want to clock your time). For a specific
6247 #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00
6248 #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
6252 @vindex org-global-properties
6253 @vindex org-columns-default-format
6254 or, even better, you can set up these values globally by customizing the
6255 variables @code{org-global-properties} and @code{org-columns-default-format}.
6256 In particular if you want to use this setup also in the agenda, a global
6257 setup may be advised.
6259 The way to assign estimates to individual items is then to switch to column
6260 mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
6261 value. The values you enter will immediately be summed up in the hierarchy.
6262 In the column next to it, any clocked time will be displayed.
6264 @vindex org-agenda-columns-add-appointments-to-effort-sum
6265 If you switch to column view in the daily/weekly agenda, the effort column
6266 will summarize the estimated work effort for each day@footnote{Please note
6267 the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
6268 column view}).}, and you can use this to find space in your schedule. To get
6269 an overview of the entire part of the day that is committed, you can set the
6270 option @code{org-agenda-columns-add-appointments-to-effort-sum}. The
6271 appointments on a day that take place over a specified time interval will
6272 then also be added to the load estimate of the day.
6274 Effort estimates can be used in secondary agenda filtering that is triggered
6275 with the @kbd{/} key in the agenda (@pxref{Agenda commands}). If you have
6276 these estimates defined consistently, two or three key presses will narrow
6277 down the list to stuff that fits into an available time slot.
6279 @node Relative timer, Countdown timer, Effort estimates, Dates and Times
6280 @section Taking notes with a relative timer
6281 @cindex relative timer
6283 When taking notes during, for example, a meeting or a video viewing, it can
6284 be useful to have access to times relative to a starting time. Org provides
6285 such a relative timer and make it easy to create timed notes.
6288 @orgcmd{C-c C-x .,org-timer}
6289 Insert a relative time into the buffer. The first time you use this, the
6290 timer will be started. When called with a prefix argument, the timer is
6292 @orgcmd{C-c C-x -,org-timer-item}
6293 Insert a description list item with the current relative time. With a prefix
6294 argument, first reset the timer to 0.
6295 @orgcmd{M-@key{RET},org-insert-heading}
6296 Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
6298 @c for key sequences with a comma, command name macros fail :(
6301 Pause the timer, or continue it if it is already paused
6302 (@command{org-timer-pause-or-continue}).
6303 @c removed the sentence because it is redundant to the following item
6304 @kindex C-u C-c C-x ,
6306 Stop the timer. After this, you can only start a new timer, not continue the
6307 old one. This command also removes the timer from the mode line.
6308 @orgcmd{C-c C-x 0,org-timer-start}
6309 Reset the timer without inserting anything into the buffer. By default, the
6310 timer is reset to 0. When called with a @kbd{C-u} prefix, reset the timer to
6311 specific starting offset. The user is prompted for the offset, with a
6312 default taken from a timer string at point, if any, So this can be used to
6313 restart taking notes after a break in the process. When called with a double
6314 prefix argument @kbd{C-u C-u}, change all timer strings in the active region
6315 by a certain amount. This can be used to fix timer strings if the timer was
6316 not started at exactly the right moment.
6319 @node Countdown timer, , Relative timer, Dates and Times
6320 @section Countdown timer
6321 @cindex Countdown timer
6325 Calling @code{org-timer-set-timer} from an Org mode buffer runs a countdown
6326 timer. Use @kbd{;} from agenda buffers, @key{C-c C-x ;} everwhere else.
6328 @code{org-timer-set-timer} prompts the user for a duration and displays a
6329 countdown timer in the modeline. @code{org-timer-default-timer} sets the
6330 default countdown value. Giving a prefix numeric argument overrides this
6333 @node Capture - Refile - Archive, Agenda Views, Dates and Times, Top
6334 @chapter Capture - Refile - Archive
6337 An important part of any organization system is the ability to quickly
6338 capture new ideas and tasks, and to associate reference material with them.
6339 Org does this using a process called @i{capture}. It also can store files
6340 related to a task (@i{attachments}) in a special directory. Once in the
6341 system, tasks and projects need to be moved around. Moving completed project
6342 trees to an archive file keeps the system compact and fast.
6345 * Capture:: Capturing new stuff
6346 * Attachments:: Add files to tasks
6347 * RSS Feeds:: Getting input from RSS feeds
6348 * Protocols:: External (e.g.@: Browser) access to Emacs and Org
6349 * Refiling notes:: Moving a tree from one place to another
6350 * Archiving:: What to do with finished projects
6353 @node Capture, Attachments, Capture - Refile - Archive, Capture - Refile - Archive
6357 Org's method for capturing new items is heavily inspired by John Wiegley
6358 excellent remember package. Up to version 6.36 Org used a special setup
6359 for @file{remember.el}. @file{org-remember.el} is still part of Org mode for
6360 backward compatibility with existing setups. You can find the documentation
6361 for org-remember at @url{http://orgmode.org/org-remember.pdf}.
6363 The new capturing setup described here is preferred and should be used by new
6364 users. To convert your @code{org-remember-templates}, run the command
6366 @kbd{M-x org-capture-import-remember-templates @key{RET}}
6368 @noindent and then customize the new variable with @kbd{M-x
6369 customize-variable org-capture-templates}, check the result, and save the
6370 customization. You can then use both remember and capture until
6371 you are familiar with the new mechanism.
6373 Capture lets you quickly store notes with little interruption of your work
6374 flow. The basic process of capturing is very similar to remember, but Org
6375 does enhance it with templates and more.
6378 * Setting up capture:: Where notes will be stored
6379 * Using capture:: Commands to invoke and terminate capture
6380 * Capture templates:: Define the outline of different note types
6383 @node Setting up capture, Using capture, Capture, Capture
6384 @subsection Setting up capture
6386 The following customization sets a default target file for notes, and defines
6387 a global key@footnote{Please select your own key, @kbd{C-c c} is only a
6388 suggestion.} for capturing new material.
6390 @vindex org-default-notes-file
6392 (setq org-default-notes-file (concat org-directory "/notes.org"))
6393 (define-key global-map "\C-cc" 'org-capture)
6396 @node Using capture, Capture templates, Setting up capture, Capture
6397 @subsection Using capture
6400 @orgcmd{C-c c,org-capture}
6401 Call the command @code{org-capture}. Note that this keybinding is global and
6402 not active by default - you need to install it. If you have templates
6404 defined @pxref{Capture templates}, it will offer these templates for
6405 selection or use a new Org outline node as the default template. It will
6406 insert the template into the target file and switch to an indirect buffer
6407 narrowed to this new node. You may then insert the information you want.
6409 @orgcmd{C-c C-c,org-capture-finalize}
6410 Once you have finished entering information into the capture buffer, @kbd{C-c
6411 C-c} will return you to the window configuration before the capture process,
6412 so that you can resume your work without further distraction. When called
6413 with a prefix arg, finalize and then jump to the captured item.
6415 @orgcmd{C-c C-w,org-capture-refile}
6416 Finalize the capture process by refiling (@pxref{Refiling notes}) the note to
6417 a different place. Please realize that this is a normal refiling command
6418 that will be executed---so the cursor position at the moment you run this
6419 command is important. If you have inserted a tree with a parent and
6420 children, first move the cursor back to the parent. Any prefix argument
6421 given to this command will be passed on to the @code{org-refile} command.
6423 @orgcmd{C-c C-k,org-capture-kill}
6424 Abort the capture process and return to the previous state.
6428 You can also call @code{org-capture} in a special way from the agenda, using
6429 the @kbd{k c} key combination. With this access, any timestamps inserted by
6430 the selected capture template will default to the cursor date in the agenda,
6431 rather than to the current date.
6433 To find the locations of the last stored capture, use @code{org-capture} with
6438 Visit the target location of a capture template. You get to select the
6439 template in the usual way.
6440 @orgkey{C-u C-u C-c c}
6441 Visit the last stored capture item in its buffer.
6444 @node Capture templates, , Using capture, Capture
6445 @subsection Capture templates
6446 @cindex templates, for Capture
6448 You can use templates for different types of capture items, and
6449 for different target locations. The easiest way to create such templates is
6450 through the customize interface.
6454 Customize the variable @code{org-capture-templates}.
6457 Before we give the formal description of template definitions, let's look at
6458 an example. Say you would like to use one template to create general TODO
6459 entries, and you want to put these entries under the heading @samp{Tasks} in
6460 your file @file{~/org/gtd.org}. Also, a date tree in the file
6461 @file{journal.org} should capture journal entries. A possible configuration
6465 (setq org-capture-templates
6466 '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks")
6467 "* TODO %?\n %i\n %a")
6468 ("j" "Journal" entry (file+datetree "~/org/journal.org")
6469 "* %?\nEntered on %U\n %i\n %a")))
6472 @noindent If you then press @kbd{C-c c t}, Org will prepare the template
6476 [[file:@var{link to where you initiated capture}]]
6480 During expansion of the template, @code{%a} has been replaced by a link to
6481 the location from where you called the capture command. This can be
6482 extremely useful for deriving tasks from emails, for example. You fill in
6483 the task definition, press @code{C-c C-c} and Org returns you to the same
6484 place where you started the capture process.
6486 To define special keys to capture to a particular template without going
6487 through the interactive template selection, you can create your key binding
6491 (define-key global-map "\C-cx"
6492 (lambda () (interactive) (org-capture nil "x")))
6496 * Template elements:: What is needed for a complete template entry
6497 * Template expansion:: Filling in information about time and context
6500 @node Template elements, Template expansion, Capture templates, Capture templates
6501 @subsubsection Template elements
6503 Now lets look at the elements of a template definition. Each entry in
6504 @code{org-capture-templates} is a list with the following items:
6508 The keys that will select the template, as a string, characters
6509 only, for example @code{"a"} for a template to be selected with a
6510 single key, or @code{"bt"} for selection with two keys. When using
6511 several keys, keys using the same prefix key must be sequential
6512 in the list and preceded by a 2-element entry explaining the
6513 prefix key, for example
6515 ("b" "Templates for marking stuff to buy")
6517 @noindent If you do not define a template for the @kbd{C} key, this key will
6518 be used to open the customize buffer for this complex variable.
6521 A short string describing the template, which will be shown during
6525 The type of entry, a symbol. Valid values are:
6528 An Org mode node, with a headline. Will be filed as the child of the target
6529 entry or as a top-level entry. The target file should be an Org mode file.
6531 A plain list item, placed in the first plain list at the target
6532 location. Again the target file should be an Org file.
6534 A checkbox item. This only differs from the plain list item by the
6537 a new line in the first table at the target location. Where exactly the
6538 line will be inserted depends on the properties @code{:prepend} and
6539 @code{:table-line-pos} (see below).
6541 Text to be inserted as it is.
6545 @vindex org-default-notes-file
6546 Specification of where the captured item should be placed. In Org mode
6547 files, targets usually define a node. Entries will become children of this
6548 node. Other types will be added to the table or list in the body of this
6549 node. Most target specifications contain a file name. If that file name is
6550 the empty string, it defaults to @code{org-default-notes-file}. A file can
6551 also be given as a variable, function, or Emacs Lisp form.
6555 @item (file "path/to/file")
6556 Text will be placed at the beginning or end of that file.
6558 @item (id "id of existing org entry")
6559 Filing as child of this entry, or in the body of the entry.
6561 @item (file+headline "path/to/file" "node headline")
6562 Fast configuration if the target heading is unique in the file.
6564 @item (file+olp "path/to/file" "Level 1 heading" "Level 2" ...)
6565 For non-unique headings, the full path is safer.
6567 @item (file+regexp "path/to/file" "regexp to find location")
6568 Use a regular expression to position the cursor.
6570 @item (file+datetree "path/to/file")
6571 Will create a heading in a date tree for today's date.
6573 @item (file+datetree+prompt "path/to/file")
6574 Will create a heading in a date tree, but will prompt for the date.
6576 @item (file+function "path/to/file" function-finding-location)
6577 A function to find the right location in the file.
6580 File to the entry that is currently being clocked.
6582 @item (function function-finding-location)
6583 Most general way, write your own function to find both
6588 The template for creating the capture item. If you leave this empty, an
6589 appropriate default template will be used. Otherwise this is a string with
6590 escape codes, which will be replaced depending on time and context of the
6591 capture call. The string with escapes may be loaded from a template file,
6592 using the special syntax @code{(file "path/to/template")}. See below for
6596 The rest of the entry is a property list of additional options.
6597 Recognized properties are:
6600 Normally new captured information will be appended at
6601 the target location (last child, last table line, last list item...).
6602 Setting this property will change that.
6604 @item :immediate-finish
6605 When set, do not offer to edit the information, just
6606 file it away immediately. This makes sense if the template only needs
6607 information that can be added automatically.
6610 Set this to the number of lines to insert
6611 before and after the new item. Default 0, only common other value is 1.
6614 Start the clock in this item.
6617 Keep the clock running when filing the captured entry.
6620 If starting the capture interrupted a clock, restart that clock when finished
6621 with the capture. Note that @code{:clock-keep} has precedence over
6622 @code{:clock-resume}. When setting both to @code{t}, the current clock will
6623 run and the previous one will not be resumed.
6626 Do not narrow the target buffer, simply show the full buffer. Default is to
6627 narrow it so that you only see the new material.
6629 @item :table-line-pos
6630 Specification of the location in the table where the new line should be
6631 inserted. It should be a string like @code{"II-3"} meaning that the new
6632 line should become the third line before the second horizontal separator
6636 If the target file was not yet visited when capture was invoked, kill the
6637 buffer again after capture is completed.
6641 @node Template expansion, , Template elements, Capture templates
6642 @subsubsection Template expansion
6644 In the template itself, special @kbd{%}-escapes@footnote{If you need one of
6645 these sequences literally, escape the @kbd{%} with a backslash.} allow
6646 dynamic insertion of content. The templates are expanded in the order given here:
6649 %[@var{file}] @r{insert the contents of the file given by @var{file}.}
6650 %(@var{sexp}) @r{evaluate Elisp @var{sexp} and replace with the result.}
6651 %<...> @r{the result of format-time-string on the ... format specification.}
6652 %t @r{timestamp, date only.}
6653 %T @r{timestamp with date and time.}
6654 %u, %U @r{like the above, but inactive timestamps.}
6655 %a @r{annotation, normally the link created with @code{org-store-link}.}
6656 %i @r{initial content, the region when capture is called while the}
6657 @r{region is active.}
6658 @r{The entire text will be indented like @code{%i} itself.}
6659 %A @r{like @code{%a}, but prompt for the description part.}
6660 %c @r{Current kill ring head.}
6661 %x @r{Content of the X clipboard.}
6662 %k @r{title of the currently clocked task.}
6663 %K @r{link to the currently clocked task.}
6664 %n @r{user name (taken from @code{user-full-name}).}
6665 %f @r{file visited by current buffer when org-capture was called.}
6666 %F @r{full path of the file or directory visited by current buffer.}
6667 %:keyword @r{specific information for certain link types, see below.}
6668 %^g @r{prompt for tags, with completion on tags in target file.}
6669 %^G @r{prompt for tags, with completion all tags in all agenda files.}
6670 %^t @r{like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}.}
6671 @r{You may define a prompt like @code{%^@{Birthday@}t}.}
6672 %^C @r{Interactive selection of which kill or clip to use.}
6673 %^L @r{Like @code{%^C}, but insert as link.}
6674 %^@{@var{prop}@}p @r{Prompt the user for a value for property @var{prop}.}
6675 %^@{@var{prompt}@} @r{prompt the user for a string and replace this sequence with it.}
6676 @r{You may specify a default value and a completion table with}
6677 @r{%^@{prompt|default|completion2|completion3...@}.}
6678 @r{The arrow keys access a prompt-specific history.}
6682 For specific link types, the following keywords will be
6683 defined@footnote{If you define your own link types (@pxref{Adding
6684 hyperlink types}), any property you store with
6685 @code{org-store-link-props} can be accessed in capture templates in a
6688 @vindex org-from-is-user-regexp
6690 Link type | Available keywords
6691 ------------------------+----------------------------------------------
6692 bbdb | %:name %:company
6693 irc | %:server %:port %:nick
6694 vm, wl, mh, mew, rmail | %:type %:subject %:message-id
6695 | %:from %:fromname %:fromaddress
6696 | %:to %:toname %:toaddress
6697 | %:date @r{(message date header field)}
6698 | %:date-timestamp @r{(date as active timestamp)}
6699 | %:date-timestamp-inactive @r{(date as inactive timestamp)}
6700 | %: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}.}}
6701 gnus | %:group, @r{for messages also all email fields}
6703 info | %:file %:node
6708 To place the cursor after template expansion use:
6711 %? @r{After completing the template, position cursor here.}
6715 @node Attachments, RSS Feeds, Capture, Capture - Refile - Archive
6716 @section Attachments
6719 @vindex org-attach-directory
6720 It is often useful to associate reference material with an outline node/task.
6721 Small chunks of plain text can simply be stored in the subtree of a project.
6722 Hyperlinks (@pxref{Hyperlinks}) can establish associations with
6723 files that live elsewhere on your computer or in the cloud, like emails or
6724 source code files belonging to a project. Another method is @i{attachments},
6725 which are files located in a directory belonging to an outline node. Org
6726 uses directories named by the unique ID of each entry. These directories are
6727 located in the @file{data} directory which lives in the same directory where
6728 your Org file lives@footnote{If you move entries or Org files from one
6729 directory to another, you may want to configure @code{org-attach-directory}
6730 to contain an absolute path.}. If you initialize this directory with
6731 @code{git init}, Org will automatically commit changes when it sees them.
6732 The attachment system has been contributed to Org by John Wiegley.
6734 In cases where it seems better to do so, you can also attach a directory of your
6735 choice to an entry. You can also make children inherit the attachment
6736 directory from a parent, so that an entire subtree uses the same attached
6739 @noindent The following commands deal with attachments:
6743 @orgcmd{C-c C-a,org-attach}
6744 The dispatcher for commands related to the attachment system. After these
6745 keys, a list of commands is displayed and you must press an additional key
6746 to select a command:
6749 @orgcmdtkc{a,C-c C-a a,org-attach-attach}
6750 @vindex org-attach-method
6751 Select a file and move it into the task's attachment directory. The file
6752 will be copied, moved, or linked, depending on @code{org-attach-method}.
6753 Note that hard links are not supported on all systems.
6759 Attach a file using the copy/move/link method.
6760 Note that hard links are not supported on all systems.
6762 @orgcmdtkc{n,C-c C-a n,org-attach-new}
6763 Create a new attachment as an Emacs buffer.
6765 @orgcmdtkc{z,C-c C-a z,org-attach-sync}
6766 Synchronize the current task with its attachment directory, in case you added
6767 attachments yourself.
6769 @orgcmdtkc{o,C-c C-a o,org-attach-open}
6770 @vindex org-file-apps
6771 Open current task's attachment. If there is more than one, prompt for a
6772 file name first. Opening will follow the rules set by @code{org-file-apps}.
6773 For more details, see the information on following hyperlinks
6774 (@pxref{Handling links}).
6776 @orgcmdtkc{O,C-c C-a O,org-attach-open-in-emacs}
6777 Also open the attachment, but force opening the file in Emacs.
6779 @orgcmdtkc{f,C-c C-a f,org-attach-reveal}
6780 Open the current task's attachment directory.
6782 @orgcmdtkc{F,C-c C-a F,org-attach-reveal-in-emacs}
6783 Also open the directory, but force using @command{dired} in Emacs.
6785 @orgcmdtkc{d,C-c C-a d,org-attach-delete-one}
6786 Select and delete a single attachment.
6788 @orgcmdtkc{D,C-c C-a D,org-attach-delete-all}
6789 Delete all of a task's attachments. A safer way is to open the directory in
6790 @command{dired} and delete from there.
6792 @orgcmdtkc{s,C-c C-a s,org-attach-set-directory}
6793 @cindex property, ATTACH_DIR
6794 Set a specific directory as the entry's attachment directory. This works by
6795 putting the directory path into the @code{ATTACH_DIR} property.
6797 @orgcmdtkc{i,C-c C-a i,org-attach-set-inherit}
6798 @cindex property, ATTACH_DIR_INHERIT
6799 Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
6800 same directory for attachments as the parent does.
6804 @node RSS Feeds, Protocols, Attachments, Capture - Refile - Archive
6809 Org can add and change entries based on information found in RSS feeds and
6810 Atom feeds. You could use this to make a task out of each new podcast in a
6811 podcast feed. Or you could use a phone-based note-creating service on the
6812 web to import tasks into Org. To access feeds, configure the variable
6813 @code{org-feed-alist}. The docstring of this variable has detailed
6814 information. Here is just an example:
6817 (setq org-feed-alist
6819 "http://rss.slashdot.org/Slashdot/slashdot"
6820 "~/txt/org/feeds.org" "Slashdot Entries")))
6824 will configure that new items from the feed provided by
6825 @code{rss.slashdot.org} will result in new entries in the file
6826 @file{~/org/feeds.org} under the heading @samp{Slashdot Entries}, whenever
6827 the following command is used:
6830 @orgcmd{C-c C-x g,org-feed-update-all}
6832 Collect items from the feeds configured in @code{org-feed-alist} and act upon
6834 @orgcmd{C-c C-x G,org-feed-goto-inbox}
6835 Prompt for a feed name and go to the inbox configured for this feed.
6838 Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which
6839 it will store information about the status of items in the feed, to avoid
6840 adding the same item several times. You should add @samp{FEEDSTATUS} to the
6841 list of drawers in that file:
6844 #+DRAWERS: LOGBOOK PROPERTIES FEEDSTATUS
6847 For more information, including how to read atom feeds, see
6848 @file{org-feed.el} and the docstring of @code{org-feed-alist}.
6850 @node Protocols, Refiling notes, RSS Feeds, Capture - Refile - Archive
6851 @section Protocols for external access
6852 @cindex protocols, for external access
6855 You can set up Org for handling protocol calls from outside applications that
6856 are passed to Emacs through the @file{emacsserver}. For example, you can
6857 configure bookmarks in your web browser to send a link to the current page to
6858 Org and create a note from it using capture (@pxref{Capture}). Or you
6859 could create a bookmark that will tell Emacs to open the local source file of
6860 a remote website you are looking at with the browser. See
6861 @uref{http://orgmode.org/worg/org-contrib/org-protocol.php} for detailed
6862 documentation and setup instructions.
6864 @node Refiling notes, Archiving, Protocols, Capture - Refile - Archive
6865 @section Refiling notes
6866 @cindex refiling notes
6868 When reviewing the captured data, you may want to refile some of the entries
6869 into a different list, for example into a project. Cutting, finding the
6870 right location, and then pasting the note is cumbersome. To simplify this
6871 process, you can use the following special command:
6874 @orgcmd{C-c C-w,org-refile}
6875 @vindex org-reverse-note-order
6876 @vindex org-refile-targets
6877 @vindex org-refile-use-outline-path
6878 @vindex org-outline-path-complete-in-steps
6879 @vindex org-refile-allow-creating-parent-nodes
6880 @vindex org-log-refile
6881 @vindex org-refile-use-cache
6882 Refile the entry or region at point. This command offers possible locations
6883 for refiling the entry and lets you select one with completion. The item (or
6884 all items in the region) is filed below the target heading as a subitem.
6885 Depending on @code{org-reverse-note-order}, it will be either the first or
6887 By default, all level 1 headlines in the current buffer are considered to be
6888 targets, but you can have more complex definitions across a number of files.
6889 See the variable @code{org-refile-targets} for details. If you would like to
6890 select a location via a file-path-like completion along the outline path, see
6891 the variables @code{org-refile-use-outline-path} and
6892 @code{org-outline-path-complete-in-steps}. If you would like to be able to
6893 create new nodes as new parents for refiling on the fly, check the
6894 variable @code{org-refile-allow-creating-parent-nodes}.
6895 When the variable @code{org-log-refile}@footnote{with corresponding
6896 @code{#+STARTUP} keywords @code{logrefile}, @code{lognoterefile},
6897 and @code{nologrefile}} is set, a timestamp or a note will be
6898 recorded when an entry has been refiled.
6899 @orgkey{C-u C-c C-w}
6900 Use the refile interface to jump to a heading.
6901 @orgcmd{C-u C-u C-c C-w,org-refile-goto-last-stored}
6902 Jump to the location where @code{org-refile} last moved a tree to.
6904 Refile as the child of the item currently being clocked.
6905 @item C-0 C-c C-w @ @r{or} @ C-u C-u C-u C-c C-w
6907 @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}
6909 Clear the target cache. Caching of refile targets can be turned on by
6910 setting @code{org-refile-use-cache}. To make the command see new possible
6911 targets, you have to clear the cache with this command.
6914 @node Archiving, , Refiling notes, Capture - Refile - Archive
6918 When a project represented by a (sub)tree is finished, you may want
6919 to move the tree out of the way and to stop it from contributing to the
6920 agenda. Archiving is important to keep your working files compact and global
6921 searches like the construction of agenda views fast.
6924 @orgcmd{C-c C-x C-a,org-archive-subtree-default}
6925 @vindex org-archive-default-command
6926 Archive the current entry using the command specified in the variable
6927 @code{org-archive-default-command}.
6931 * Moving subtrees:: Moving a tree to an archive file
6932 * Internal archiving:: Switch off a tree but keep it in the file
6935 @node Moving subtrees, Internal archiving, Archiving, Archiving
6936 @subsection Moving a tree to the archive file
6937 @cindex external archiving
6939 The most common archiving action is to move a project tree to another file,
6943 @orgcmdkskc{C-c C-x C-s,C-c $,org-archive-subtree}
6944 @vindex org-archive-location
6945 Archive the subtree starting at the cursor position to the location
6946 given by @code{org-archive-location}.
6947 @orgkey{C-u C-c C-x C-s}
6948 Check if any direct children of the current headline could be moved to
6949 the archive. To do this, each subtree is checked for open TODO entries.
6950 If none are found, the command offers to move it to the archive
6951 location. If the cursor is @emph{not} on a headline when this command
6952 is invoked, the level 1 trees will be checked.
6955 @cindex archive locations
6956 The default archive location is a file in the same directory as the
6957 current file, with the name derived by appending @file{_archive} to the
6958 current file name. For information and examples on how to change this,
6959 see the documentation string of the variable
6960 @code{org-archive-location}. There is also an in-buffer option for
6961 setting this variable, for example@footnote{For backward compatibility,
6962 the following also works: If there are several such lines in a file,
6963 each specifies the archive location for the text below it. The first
6964 such line also applies to any text before its definition. However,
6965 using this method is @emph{strongly} deprecated as it is incompatible
6966 with the outline structure of the document. The correct method for
6967 setting multiple archive locations in a buffer is using properties.}:
6971 #+ARCHIVE: %s_done::
6974 @cindex property, ARCHIVE
6976 If you would like to have a special ARCHIVE location for a single entry
6977 or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
6978 location as the value (@pxref{Properties and Columns}).
6980 @vindex org-archive-save-context-info
6981 When a subtree is moved, it receives a number of special properties that
6982 record context information like the file from where the entry came, its
6983 outline path the archiving time etc. Configure the variable
6984 @code{org-archive-save-context-info} to adjust the amount of information
6988 @node Internal archiving, , Moving subtrees, Archiving
6989 @subsection Internal archiving
6991 If you want to just switch off (for agenda views) certain subtrees without
6992 moving them to a different file, you can use the @code{ARCHIVE tag}.
6994 A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
6995 its location in the outline tree, but behaves in the following way:
6998 @vindex org-cycle-open-archived-trees
6999 It does not open when you attempt to do so with a visibility cycling
7000 command (@pxref{Visibility cycling}). You can force cycling archived
7001 subtrees with @kbd{C-@key{TAB}}, or by setting the option
7002 @code{org-cycle-open-archived-trees}. Also normal outline commands like
7003 @code{show-all} will open archived subtrees.
7005 @vindex org-sparse-tree-open-archived-trees
7006 During sparse tree construction (@pxref{Sparse trees}), matches in
7007 archived subtrees are not exposed, unless you configure the option
7008 @code{org-sparse-tree-open-archived-trees}.
7010 @vindex org-agenda-skip-archived-trees
7011 During agenda view construction (@pxref{Agenda Views}), the content of
7012 archived trees is ignored unless you configure the option
7013 @code{org-agenda-skip-archived-trees}, in which case these trees will always
7014 be included. In the agenda you can press @kbd{v a} to get archives
7015 temporarily included.
7017 @vindex org-export-with-archived-trees
7018 Archived trees are not exported (@pxref{Exporting}), only the headline
7019 is. Configure the details using the variable
7020 @code{org-export-with-archived-trees}.
7022 @vindex org-columns-skip-archived-trees
7023 Archived trees are excluded from column view unless the variable
7024 @code{org-columns-skip-archived-trees} is configured to @code{nil}.
7027 The following commands help manage the ARCHIVE tag:
7030 @orgcmd{C-c C-x a,org-toggle-archive-tag}
7031 Toggle the ARCHIVE tag for the current headline. When the tag is set,
7032 the headline changes to a shadowed face, and the subtree below it is
7034 @orgkey{C-u C-c C-x a}
7035 Check if any direct children of the current headline should be archived.
7036 To do this, each subtree is checked for open TODO entries. If none are
7037 found, the command offers to set the ARCHIVE tag for the child. If the
7038 cursor is @emph{not} on a headline when this command is invoked, the
7039 level 1 trees will be checked.
7040 @orgcmd{C-@kbd{TAB},org-force-cycle-archived}
7041 Cycle a tree even if it is tagged with ARCHIVE.
7042 @orgcmd{C-c C-x A,org-archive-to-archive-sibling}
7043 Move the current entry to the @emph{Archive Sibling}. This is a sibling of
7044 the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}. The
7045 entry becomes a child of that sibling and in this way retains a lot of its
7046 original context, including inherited tags and approximate position in the
7051 @node Agenda Views, Markup, Capture - Refile - Archive, Top
7052 @chapter Agenda views
7053 @cindex agenda views
7055 Due to the way Org works, TODO items, time-stamped items, and
7056 tagged headlines can be scattered throughout a file or even a number of
7057 files. To get an overview of open action items, or of events that are
7058 important for a particular date, this information must be collected,
7059 sorted and displayed in an organized way.
7061 Org can select items based on various criteria and display them
7062 in a separate buffer. Seven different view types are provided:
7066 an @emph{agenda} that is like a calendar and shows information
7069 a @emph{TODO list} that covers all unfinished
7072 a @emph{match view}, showings headlines based on the tags, properties, and
7073 TODO state associated with them,
7075 a @emph{timeline view} that shows all events in a single Org file,
7076 in time-sorted view,
7078 a @emph{text search view} that shows all entries from multiple files
7079 that contain specified keywords,
7081 a @emph{stuck projects view} showing projects that currently don't move
7084 @emph{custom views} that are special searches and combinations of different
7089 The extracted information is displayed in a special @emph{agenda
7090 buffer}. This buffer is read-only, but provides commands to visit the
7091 corresponding locations in the original Org files, and even to
7092 edit these files remotely.
7094 @vindex org-agenda-window-setup
7095 @vindex org-agenda-restore-windows-after-quit
7096 Two variables control how the agenda buffer is displayed and whether the
7097 window configuration is restored when the agenda exits:
7098 @code{org-agenda-window-setup} and
7099 @code{org-agenda-restore-windows-after-quit}.
7102 * Agenda files:: Files being searched for agenda information
7103 * Agenda dispatcher:: Keyboard access to agenda views
7104 * Built-in agenda views:: What is available out of the box?
7105 * Presentation and sorting:: How agenda items are prepared for display
7106 * Agenda commands:: Remote editing of Org trees
7107 * Custom agenda views:: Defining special searches and views
7108 * Exporting Agenda Views:: Writing a view to a file
7109 * Agenda column view:: Using column view for collected entries
7112 @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views
7113 @section Agenda files
7114 @cindex agenda files
7115 @cindex files for agenda
7117 @vindex org-agenda-files
7118 The information to be shown is normally collected from all @emph{agenda
7119 files}, the files listed in the variable
7120 @code{org-agenda-files}@footnote{If the value of that variable is not a
7121 list, but a single file name, then the list of agenda files will be
7122 maintained in that external file.}. If a directory is part of this list,
7123 all files with the extension @file{.org} in this directory will be part
7126 Thus, even if you only work with a single Org file, that file should
7127 be put into the list@footnote{When using the dispatcher, pressing
7128 @kbd{<} before selecting a command will actually limit the command to
7129 the current file, and ignore @code{org-agenda-files} until the next
7130 dispatcher command.}. You can customize @code{org-agenda-files}, but
7131 the easiest way to maintain it is through the following commands
7133 @cindex files, adding to agenda list
7135 @orgcmd{C-c [,org-agenda-file-to-front}
7136 Add current file to the list of agenda files. The file is added to
7137 the front of the list. If it was already in the list, it is moved to
7138 the front. With a prefix argument, file is added/moved to the end.
7139 @orgcmd{C-c ],org-remove-file}
7140 Remove current file from the list of agenda files.
7142 @cindex cycling, of agenda files
7143 @orgcmd{C-',org-cycle-agenda-files}
7145 Cycle through agenda file list, visiting one file after the other.
7146 @kindex M-x org-iswitchb
7147 @item M-x org-iswitchb
7148 Command to use an @code{iswitchb}-like interface to switch to and between Org
7153 The Org menu contains the current list of files and can be used
7154 to visit any of them.
7156 If you would like to focus the agenda temporarily on a file not in
7157 this list, or on just one file in the list, or even on only a subtree in a
7158 file, then this can be done in different ways. For a single agenda command,
7159 you may press @kbd{<} once or several times in the dispatcher
7160 (@pxref{Agenda dispatcher}). To restrict the agenda scope for an
7161 extended period, use the following commands:
7164 @orgcmd{C-c C-x <,org-agenda-set-restriction-lock}
7165 Permanently restrict the agenda to the current subtree. When with a
7166 prefix argument, or with the cursor before the first headline in a file,
7167 the agenda scope is set to the entire file. This restriction remains in
7168 effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
7169 or @kbd{>} in the agenda dispatcher. If there is a window displaying an
7170 agenda view, the new restriction takes effect immediately.
7171 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
7172 Remove the permanent restriction created by @kbd{C-c C-x <}.
7176 When working with @file{speedbar.el}, you can use the following commands in
7179 @orgcmdtkc{< @r{in the speedbar frame},<,org-speedbar-set-agenda-restriction}
7180 Permanently restrict the agenda to the item---either an Org file or a subtree
7181 in such a file---at the cursor in the Speedbar frame.
7182 If there is a window displaying an agenda view, the new restriction takes
7184 @orgcmdtkc{> @r{in the speedbar frame},>,org-agenda-remove-restriction-lock}
7185 Lift the restriction.
7188 @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views
7189 @section The agenda dispatcher
7190 @cindex agenda dispatcher
7191 @cindex dispatching agenda commands
7192 The views are created through a dispatcher, which should be bound to a
7193 global key---for example @kbd{C-c a} (@pxref{Activation}). In the
7194 following we will assume that @kbd{C-c a} is indeed how the dispatcher
7195 is accessed and list keyboard access to commands accordingly. After
7196 pressing @kbd{C-c a}, an additional letter is required to execute a
7197 command. The dispatcher offers the following default commands:
7200 Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
7202 Create a list of all TODO items (@pxref{Global TODO list}).
7204 Create a list of headlines matching a TAGS expression (@pxref{Matching
7205 tags and properties}).
7207 Create the timeline view for the current buffer (@pxref{Timeline}).
7209 Create a list of entries selected by a boolean expression of keywords
7210 and/or regular expressions that must or must not occur in the entry.
7212 @vindex org-agenda-text-search-extra-files
7213 Search for a regular expression in all agenda files and additionally in
7214 the files listed in @code{org-agenda-text-search-extra-files}. This
7215 uses the Emacs command @code{multi-occur}. A prefix argument can be
7216 used to specify the number of context lines for each match, default is
7219 Create a list of stuck projects (@pxref{Stuck projects}).
7221 Restrict an agenda command to the current buffer@footnote{For backward
7222 compatibility, you can also press @kbd{1} to restrict to the current
7223 buffer.}. After pressing @kbd{<}, you still need to press the character
7224 selecting the command.
7226 If there is an active region, restrict the following agenda command to
7227 the region. Otherwise, restrict it to the current subtree@footnote{For
7228 backward compatibility, you can also press @kbd{0} to restrict to the
7229 current region/subtree.}. After pressing @kbd{< <}, you still need to press the
7230 character selecting the command.
7233 You can also define custom commands that will be accessible through the
7234 dispatcher, just like the default commands. This includes the
7235 possibility to create extended agenda buffers that contain several
7236 blocks together, for example the weekly agenda, the global TODO list and
7237 a number of special tags matches. @xref{Custom agenda views}.
7239 @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda Views
7240 @section The built-in agenda views
7242 In this section we describe the built-in views.
7245 * Weekly/daily agenda:: The calendar page with current tasks
7246 * Global TODO list:: All unfinished action items
7247 * Matching tags and properties:: Structured information with fine-tuned search
7248 * Timeline:: Time-sorted view for single file
7249 * Search view:: Find entries by searching for text
7250 * Stuck projects:: Find projects you need to review
7253 @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views
7254 @subsection The weekly/daily agenda
7256 @cindex weekly agenda
7257 @cindex daily agenda
7259 The purpose of the weekly/daily @emph{agenda} is to act like a page of a
7260 paper agenda, showing all the tasks for the current week or day.
7263 @cindex org-agenda, command
7264 @orgcmd{C-c a a,org-agenda-list}
7265 Compile an agenda for the current week from a list of Org files. The agenda
7266 shows the entries for each day. With a numeric prefix@footnote{For backward
7267 compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
7268 listed before the agenda. This feature is deprecated, use the dedicated TODO
7269 list, or a block agenda instead (@pxref{Block agenda}).} (like @kbd{C-u 2 1
7270 C-c a a}) you may set the number of days to be displayed.
7273 @vindex org-agenda-span
7274 @vindex org-agenda-ndays
7275 The default number of days displayed in the agenda is set by the variable
7276 @code{org-agenda-span} (or the obsolete @code{org-agenda-ndays}). This
7277 variable can be set to any number of days you want to see by default in the
7278 agenda, or to a span name, such a @code{day}, @code{week}, @code{month} or
7281 Remote editing from the agenda buffer means, for example, that you can
7282 change the dates of deadlines and appointments from the agenda buffer.
7283 The commands available in the Agenda buffer are listed in @ref{Agenda
7286 @subsubheading Calendar/Diary integration
7287 @cindex calendar integration
7288 @cindex diary integration
7290 Emacs contains the calendar and diary by Edward M. Reingold. The
7291 calendar displays a three-month calendar with holidays from different
7292 countries and cultures. The diary allows you to keep track of
7293 anniversaries, lunar phases, sunrise/set, recurrent appointments
7294 (weekly, monthly) and more. In this way, it is quite complementary to
7295 Org. It can be very useful to combine output from Org with
7298 In order to include entries from the Emacs diary into Org mode's
7299 agenda, you only need to customize the variable
7302 (setq org-agenda-include-diary t)
7305 @noindent After that, everything will happen automatically. All diary
7306 entries including holidays, anniversaries, etc., will be included in the
7307 agenda buffer created by Org mode. @key{SPC}, @key{TAB}, and
7308 @key{RET} can be used from the agenda buffer to jump to the diary
7309 file in order to edit existing diary entries. The @kbd{i} command to
7310 insert new entries for the current date works in the agenda buffer, as
7311 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
7312 Sunrise/Sunset times, show lunar phases and to convert to other
7313 calendars, respectively. @kbd{c} can be used to switch back and forth
7314 between calendar and agenda.
7316 If you are using the diary only for sexp entries and holidays, it is
7317 faster to not use the above setting, but instead to copy or even move
7318 the entries into an Org file. Org mode evaluates diary-style sexp
7319 entries, and does it faster because there is no overhead for first
7320 creating the diary display. Note that the sexp entries must start at
7321 the left margin, no whitespace is allowed before them. For example,
7322 the following segment of an Org file will be processed and entries
7323 will be made in the agenda:
7326 * Birthdays and similar stuff
7328 %%(org-calendar-holiday) ; special function for holiday names
7330 %%(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
7331 %%(org-anniversary 1869 10 2) Mahatma Gandhi would be %d years old
7334 @subsubheading Anniversaries from BBDB
7335 @cindex BBDB, anniversaries
7336 @cindex anniversaries, from BBDB
7338 If you are using the Big Brothers Database to store your contacts, you will
7339 very likely prefer to store anniversaries in BBDB rather than in a
7340 separate Org or diary file. Org supports this and will show BBDB
7341 anniversaries as part of the agenda. All you need to do is to add the
7342 following to one your your agenda files:
7349 %%(org-bbdb-anniversaries)
7352 You can then go ahead and define anniversaries for a BBDB record. Basically,
7353 you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB
7354 record and then add the date in the format @code{YYYY-MM-DD} or @code{MM-DD},
7355 followed by a space and the class of the anniversary (@samp{birthday} or
7356 @samp{wedding}, or a format string). If you omit the class, it will default to
7357 @samp{birthday}. Here are a few examples, the header for the file
7358 @file{org-bbdb.el} contains more detailed information.
7364 2008-04-14 %s released version 6.01 of org mode, %d years ago
7367 After a change to BBDB, or for the first agenda display during an Emacs
7368 session, the agenda display will suffer a short delay as Org updates its
7369 hash with anniversaries. However, from then on things will be very fast---much
7370 faster in fact than a long list of @samp{%%(diary-anniversary)} entries
7371 in an Org or Diary file.
7373 @subsubheading Appointment reminders
7374 @cindex @file{appt.el}
7375 @cindex appointment reminders
7379 Org can interact with Emacs appointments notification facility. To add all
7380 the appointments of your agenda files, use the command
7381 @code{org-agenda-to-appt}. This command also lets you filter through the
7382 list of your appointments and add only those belonging to a specific category
7383 or matching a regular expression. See the docstring for details.
7385 @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views
7386 @subsection The global TODO list
7387 @cindex global TODO list
7388 @cindex TODO list, global
7390 The global TODO list contains all unfinished TODO items formatted and
7391 collected into a single place.
7394 @orgcmd{C-c a t,org-todo-list}
7395 Show the global TODO list. This collects the TODO items from all agenda
7396 files (@pxref{Agenda Views}) into a single buffer. By default, this lists
7397 items with a state the is not a DONE state. The buffer is in
7398 @code{agenda-mode}, so there are commands to examine and manipulate the TODO
7399 entries directly from that buffer (@pxref{Agenda commands}).
7400 @orgcmd{C-c a T,org-todo-list}
7401 @cindex TODO keyword matching
7402 @vindex org-todo-keywords
7403 Like the above, but allows selection of a specific TODO keyword. You can
7404 also do this by specifying a prefix argument to @kbd{C-c a t}. You are
7405 prompted for a keyword, and you may also specify several keywords by
7406 separating them with @samp{|} as the boolean OR operator. With a numeric
7407 prefix, the Nth keyword in @code{org-todo-keywords} is selected.
7409 The @kbd{r} key in the agenda buffer regenerates it, and you can give
7410 a prefix argument to this command to change the selected TODO keyword,
7411 for example @kbd{3 r}. If you often need a search for a specific
7412 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
7413 Matching specific TODO keywords can also be done as part of a tags
7414 search (@pxref{Tag searches}).
7417 Remote editing of TODO items means that you can change the state of a
7418 TODO entry with a single key press. The commands available in the
7419 TODO list are described in @ref{Agenda commands}.
7421 @cindex sublevels, inclusion into TODO list
7422 Normally the global TODO list simply shows all headlines with TODO
7423 keywords. This list can become very long. There are two ways to keep
7427 @vindex org-agenda-todo-ignore-scheduled
7428 @vindex org-agenda-todo-ignore-deadlines
7429 @vindex org-agenda-todo-ignore-timestamp
7430 @vindex org-agenda-todo-ignore-with-date
7431 Some people view a TODO item that has been @emph{scheduled} for execution or
7432 have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}.
7433 Configure the variables @code{org-agenda-todo-ignore-scheduled},
7434 @code{org-agenda-todo-ignore-deadlines},
7435 @code{org-agenda-todo-ignore-timestamp} and/or
7436 @code{org-agenda-todo-ignore-with-date} to exclude such items from the global
7439 @vindex org-agenda-todo-list-sublevels
7440 TODO items may have sublevels to break up the task into subtasks. In
7441 such cases it may be enough to list only the highest level TODO headline
7442 and omit the sublevels from the global list. Configure the variable
7443 @code{org-agenda-todo-list-sublevels} to get this behavior.
7446 @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views
7447 @subsection Matching tags and properties
7448 @cindex matching, of tags
7449 @cindex matching, of properties
7453 If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}),
7454 or have properties (@pxref{Properties and Columns}), you can select headlines
7455 based on this metadata and collect them into an agenda buffer. The match
7456 syntax described here also applies when creating sparse trees with @kbd{C-c /
7460 @orgcmd{C-c a m,org-tags-view}
7461 Produce a list of all headlines that match a given set of tags. The
7462 command prompts for a selection criterion, which is a boolean logic
7463 expression with tags, like @samp{+work+urgent-withboss} or
7464 @samp{work|home} (@pxref{Tags}). If you often need a specific search,
7465 define a custom command for it (@pxref{Agenda dispatcher}).
7466 @orgcmd{C-c a M,org-tags-view}
7467 @vindex org-tags-match-list-sublevels
7468 @vindex org-agenda-tags-todo-honor-ignore-options
7469 Like @kbd{C-c a m}, but only select headlines that are also TODO items in a
7470 not-DONE state and force checking subitems (see variable
7471 @code{org-tags-match-list-sublevels}). To exclude scheduled/deadline items,
7472 see the variable @code{org-agenda-tags-todo-honor-ignore-options}. Matching
7473 specific TODO keywords together with a tags match is also possible, see
7477 The commands available in the tags list are described in @ref{Agenda
7480 @subsubheading Match syntax
7482 @cindex Boolean logic, for tag/property searches
7483 A search string can use Boolean operators @samp{&} for AND and @samp{|} for
7484 OR. @samp{&} binds more strongly than @samp{|}. Parentheses are currently
7485 not implemented. Each element in the search is either a tag, a regular
7486 expression matching tags, or an expression like @code{PROPERTY OPERATOR
7487 VALUE} with a comparison operator, accessing a property value. Each element
7488 may be preceded by @samp{-}, to select against it, and @samp{+} is syntactic
7489 sugar for positive selection. The AND operator @samp{&} is optional when
7490 @samp{+} or @samp{-} is present. Here are some examples, using only tags.
7494 Select headlines tagged @samp{:work:}, but discard those also tagged
7497 Selects lines tagged @samp{:work:} or @samp{:laptop:}.
7498 @item work|laptop+night
7499 Like before, but require the @samp{:laptop:} lines to be tagged also
7503 @cindex regular expressions, with tags search
7504 Instead of a tag, you may also specify a regular expression enclosed in curly
7505 braces. For example,
7506 @samp{work+@{^boss.*@}} matches headlines that contain the tag
7507 @samp{:work:} and any tag @i{starting} with @samp{boss}.
7509 @cindex TODO keyword matching, with tags search
7510 @cindex level, require for tags/property match
7511 @cindex category, require for tags/property match
7512 @vindex org-odd-levels-only
7513 You may also test for properties (@pxref{Properties and Columns}) at the same
7514 time as matching tags. The properties may be real properties, or special
7515 properties that represent other metadata (@pxref{Special properties}). For
7516 example, the ``property'' @code{TODO} represents the TODO keyword of the
7517 entry. Or, the ``property'' @code{LEVEL} represents the level of an entry.
7518 So a search @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines
7519 that have the tag @samp{boss} and are @emph{not} marked with the TODO keyword
7520 DONE. In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not
7521 count the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc.
7523 Here are more examples:
7525 @item work+TODO="WAITING"
7526 Select @samp{:work:}-tagged TODO lines with the specific TODO
7527 keyword @samp{WAITING}.
7528 @item work+TODO="WAITING"|home+TODO="WAITING"
7529 Waiting tasks both at work and at home.
7532 When matching properties, a number of different operators can be used to test
7533 the value of a property. Here is a complex example:
7536 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 \
7537 +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
7541 The type of comparison will depend on how the comparison value is written:
7544 If the comparison value is a plain number, a numerical comparison is done,
7545 and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
7546 @samp{>=}, and @samp{<>}.
7548 If the comparison value is enclosed in double-quotes,
7549 a string comparison is done, and the same operators are allowed.
7551 If the comparison value is enclosed in double-quotes @emph{and} angular
7552 brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
7553 assumed to be date/time specifications in the standard Org way, and the
7554 comparison will be done accordingly. Special values that will be recognized
7555 are @code{"<now>"} for now (including time), and @code{"<today>"}, and
7556 @code{"<tomorrow>"} for these days at 0:00 hours, i.e.@: without a time
7557 specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
7558 @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
7559 respectively, can be used.
7561 If the comparison value is enclosed
7562 in curly braces, a regexp match is performed, with @samp{=} meaning that the
7563 regexp matches the property value, and @samp{<>} meaning that it does not
7567 So the search string in the example finds entries tagged @samp{:work:} but
7568 not @samp{:boss:}, which also have a priority value @samp{A}, a
7569 @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
7570 property that is numerically smaller than 2, a @samp{:With:} property that is
7571 matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
7572 on or after October 11, 2008.
7574 Accessing TODO, LEVEL, and CATEGORY during a search is fast. Accessing any
7575 other properties will slow down the search. However, once you have paid the
7576 price by accessing one property, testing additional properties is cheap
7579 You can configure Org mode to use property inheritance during a search, but
7580 beware that this can slow down searches considerably. See @ref{Property
7581 inheritance}, for details.
7583 For backward compatibility, and also for typing speed, there is also a
7584 different way to test TODO states in a search. For this, terminate the
7585 tags/property part of the search string (which may include several terms
7586 connected with @samp{|}) with a @samp{/} and then specify a Boolean
7587 expression just for TODO keywords. The syntax is then similar to that for
7588 tags, but should be applied with care: for example, a positive selection on
7589 several TODO keywords cannot meaningfully be combined with boolean AND.
7590 However, @emph{negative selection} combined with AND can be meaningful. To
7591 make sure that only lines are checked that actually have any TODO keyword
7592 (resulting in a speed-up), use @kbd{C-c a M}, or equivalently start the TODO
7593 part after the slash with @samp{!}. Using @kbd{C-c a M} or @samp{/!} will
7594 not match TODO keywords in a DONE state. Examples:
7598 Same as @samp{work+TODO="WAITING"}
7599 @item work/!-WAITING-NEXT
7600 Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
7602 @item work/!+WAITING|+NEXT
7603 Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
7607 @node Timeline, Search view, Matching tags and properties, Built-in agenda views
7608 @subsection Timeline for a single file
7609 @cindex timeline, single file
7610 @cindex time-sorted view
7612 The timeline summarizes all time-stamped items from a single Org mode
7613 file in a @emph{time-sorted view}. The main purpose of this command is
7614 to give an overview over events in a project.
7617 @orgcmd{C-c a L,org-timeline}
7618 Show a time-sorted view of the Org file, with all time-stamped items.
7619 When called with a @kbd{C-u} prefix, all unfinished TODO entries
7620 (scheduled or not) are also listed under the current date.
7624 The commands available in the timeline buffer are listed in
7625 @ref{Agenda commands}.
7627 @node Search view, Stuck projects, Timeline, Built-in agenda views
7628 @subsection Search view
7631 @cindex searching, for text
7633 This agenda view is a general text search facility for Org mode entries.
7634 It is particularly useful to find notes.
7637 @orgcmd{C-c a s,org-search-view}
7638 This is a special search that lets you select entries by matching a substring
7639 or specific words using a boolean logic.
7641 For example, the search string @samp{computer equipment} will find entries
7642 that contain @samp{computer equipment} as a substring. If the two words are
7643 separated by more space or a line break, the search will still match.
7644 Search view can also search for specific keywords in the entry, using Boolean
7645 logic. The search string @samp{+computer +wifi -ethernet -@{8\.11[bg]@}}
7646 will search for note entries that contain the keywords @code{computer}
7647 and @code{wifi}, but not the keyword @code{ethernet}, and which are also
7648 not matched by the regular expression @code{8\.11[bg]}, meaning to
7649 exclude both 8.11b and 8.11g. The first @samp{+} is necessary to turn on
7650 word search, other @samp{+} characters are optional. For more details, see
7651 the docstring of the command @code{org-search-view}.
7653 @vindex org-agenda-text-search-extra-files
7654 Note that in addition to the agenda files, this command will also search
7655 the files listed in @code{org-agenda-text-search-extra-files}.
7657 @node Stuck projects, , Search view, Built-in agenda views
7658 @subsection Stuck projects
7659 @pindex GTD, Getting Things Done
7661 If you are following a system like David Allen's GTD to organize your
7662 work, one of the ``duties'' you have is a regular review to make sure
7663 that all projects move along. A @emph{stuck} project is a project that
7664 has no defined next actions, so it will never show up in the TODO lists
7665 Org mode produces. During the review, you need to identify such
7666 projects and define next actions for them.
7669 @orgcmd{C-c a #,org-agenda-list-stuck-projects}
7670 List projects that are stuck.
7673 @vindex org-stuck-projects
7674 Customize the variable @code{org-stuck-projects} to define what a stuck
7675 project is and how to find it.
7678 You almost certainly will have to configure this view before it will
7679 work for you. The built-in default assumes that all your projects are
7680 level-2 headlines, and that a project is not stuck if it has at least
7681 one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
7683 Let's assume that you, in your own way of using Org mode, identify
7684 projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
7685 indicate a project that should not be considered yet. Let's further
7686 assume that the TODO keyword DONE marks finished projects, and that NEXT
7687 and TODO indicate next actions. The tag @@SHOP indicates shopping and
7688 is a next action even without the NEXT tag. Finally, if the project
7689 contains the special word IGNORE anywhere, it should not be listed
7690 either. In this case you would start by identifying eligible projects
7691 with a tags/todo match@footnote{@xref{Tag searches}.}
7692 @samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT, @@SHOP, and
7693 IGNORE in the subtree to identify projects that are not stuck. The
7694 correct customization for this is
7697 (setq org-stuck-projects
7698 '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
7702 Note that if a project is identified as non-stuck, the subtree of this entry
7703 will still be searched for stuck projects.
7705 @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views
7706 @section Presentation and sorting
7707 @cindex presentation, of agenda items
7709 @vindex org-agenda-prefix-format
7710 @vindex org-agenda-tags-column
7711 Before displaying items in an agenda view, Org mode visually prepares the
7712 items and sorts them. Each item occupies a single line. The line starts
7713 with a @emph{prefix} that contains the @emph{category} (@pxref{Categories})
7714 of the item and other important information. You can customize in which
7715 column tags will be displayed through @code{org-agenda-tags-column}. You can
7716 also customize the prefix using the option @code{org-agenda-prefix-format}.
7717 This prefix is followed by a cleaned-up version of the outline headline
7718 associated with the item.
7721 * Categories:: Not all tasks are equal
7722 * Time-of-day specifications:: How the agenda knows the time
7723 * Sorting of agenda items:: The order of things
7726 @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting
7727 @subsection Categories
7731 The category is a broad label assigned to each agenda item. By default,
7732 the category is simply derived from the file name, but you can also
7733 specify it with a special line in the buffer, like this@footnote{For
7734 backward compatibility, the following also works: if there are several
7735 such lines in a file, each specifies the category for the text below it.
7736 The first category also applies to any text before the first CATEGORY
7737 line. However, using this method is @emph{strongly} deprecated as it is
7738 incompatible with the outline structure of the document. The correct
7739 method for setting multiple categories in a buffer is using a
7747 @cindex property, CATEGORY
7748 If you would like to have a special CATEGORY for a single entry or a
7749 (sub)tree, give the entry a @code{:CATEGORY:} property with the
7750 special category you want to apply as the value.
7753 The display in the agenda buffer looks best if the category is not
7754 longer than 10 characters.
7757 You can set up icons for category by customizing the
7758 @code{org-agenda-category-icon-alist} variable.
7760 @node Time-of-day specifications, Sorting of agenda items, Categories, Presentation and sorting
7761 @subsection Time-of-day specifications
7762 @cindex time-of-day specification
7764 Org mode checks each agenda item for a time-of-day specification. The
7765 time can be part of the timestamp that triggered inclusion into the
7766 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time
7767 ranges can be specified with two timestamps, like
7769 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
7771 In the headline of the entry itself, a time(range) may also appear as
7772 plain text (like @samp{12:45} or a @samp{8:30-1pm}). If the agenda
7773 integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
7774 specifications in diary entries are recognized as well.
7776 For agenda display, Org mode extracts the time and displays it in a
7777 standard 24 hour format as part of the prefix. The example times in
7778 the previous paragraphs would end up in the agenda like this:
7781 8:30-13:00 Arthur Dent lies in front of the bulldozer
7782 12:45...... Ford Prefect arrives and takes Arthur to the pub
7783 19:00...... The Vogon reads his poem
7784 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
7788 If the agenda is in single-day mode, or for the display of today, the
7789 timed entries are embedded in a time grid, like
7792 8:00...... ------------------
7793 8:30-13:00 Arthur Dent lies in front of the bulldozer
7794 10:00...... ------------------
7795 12:00...... ------------------
7796 12:45...... Ford Prefect arrives and takes Arthur to the pub
7797 14:00...... ------------------
7798 16:00...... ------------------
7799 18:00...... ------------------
7800 19:00...... The Vogon reads his poem
7801 20:00...... ------------------
7802 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
7805 @vindex org-agenda-use-time-grid
7806 @vindex org-agenda-time-grid
7807 The time grid can be turned on and off with the variable
7808 @code{org-agenda-use-time-grid}, and can be configured with
7809 @code{org-agenda-time-grid}.
7811 @node Sorting of agenda items, , Time-of-day specifications, Presentation and sorting
7812 @subsection Sorting of agenda items
7813 @cindex sorting, of agenda items
7814 @cindex priorities, of agenda items
7815 Before being inserted into a view, the items are sorted. How this is
7816 done depends on the type of view.
7819 @vindex org-agenda-files
7820 For the daily/weekly agenda, the items for each day are sorted. The
7821 default order is to first collect all items containing an explicit
7822 time-of-day specification. These entries will be shown at the beginning
7823 of the list, as a @emph{schedule} for the day. After that, items remain
7824 grouped in categories, in the sequence given by @code{org-agenda-files}.
7825 Within each category, items are sorted by priority (@pxref{Priorities}),
7826 which is composed of the base priority (2000 for priority @samp{A}, 1000
7827 for @samp{B}, and 0 for @samp{C}), plus additional increments for
7828 overdue scheduled or deadline items.
7830 For the TODO list, items remain in the order of categories, but within
7831 each category, sorting takes place according to priority
7832 (@pxref{Priorities}). The priority used for sorting derives from the
7833 priority cookie, with additions depending on how close an item is to its due
7836 For tags matches, items are not sorted at all, but just appear in the
7837 sequence in which they are found in the agenda files.
7840 @vindex org-agenda-sorting-strategy
7841 Sorting can be customized using the variable
7842 @code{org-agenda-sorting-strategy}, and may also include criteria based on
7843 the estimated effort of an entry (@pxref{Effort estimates}).
7845 @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda Views
7846 @section Commands in the agenda buffer
7847 @cindex commands, in agenda buffer
7849 Entries in the agenda buffer are linked back to the Org file or diary
7850 file where they originate. You are not allowed to edit the agenda
7851 buffer itself, but commands are provided to show and jump to the
7852 original entry location, and to edit the Org files ``remotely'' from
7853 the agenda buffer. In this way, all information is stored only once,
7854 removing the risk that your agenda and note files may diverge.
7856 Some commands can be executed with mouse clicks on agenda lines. For
7857 the other commands, the cursor needs to be in the desired line.
7860 @tsubheading{Motion}
7861 @cindex motion commands in agenda
7862 @orgcmd{n,org-agenda-next-line}
7863 Next line (same as @key{up} and @kbd{C-p}).
7864 @orgcmd{p,org-agenda-previous-line}
7865 Previous line (same as @key{down} and @kbd{C-n}).
7866 @tsubheading{View/Go to Org file}
7867 @orgcmdkkc{@key{SPC},mouse-3,org-agenda-show-and-scroll-up}
7868 Display the original location of the item in another window.
7869 With prefix arg, make sure that the entire entry is made visible in the
7870 outline, not only the heading.
7872 @orgcmd{L,org-agenda-recenter}
7873 Display original location and recenter that window.
7875 @orgcmdkkc{@key{TAB},mouse-2,org-agenda-goto}
7876 Go to the original location of the item in another window.
7878 @orgcmd{@key{RET},org-agenda-switch-to}
7879 Go to the original location of the item and delete other windows.
7881 @orgcmd{F,org-agenda-follow-mode}
7882 @vindex org-agenda-start-with-follow-mode
7883 Toggle Follow mode. In Follow mode, as you move the cursor through
7884 the agenda buffer, the other window always shows the corresponding
7885 location in the Org file. The initial setting for this mode in new
7886 agenda buffers can be set with the variable
7887 @code{org-agenda-start-with-follow-mode}.
7889 @orgcmd{C-c C-x b,org-agenda-tree-to-indirect-buffer}
7890 Display the entire subtree of the current item in an indirect buffer. With a
7891 numeric prefix argument N, go up to level N and then take that tree. If N is
7892 negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the
7893 previously used indirect buffer.
7895 @orgcmd{C-c C-o,org-agenda-open-link}
7896 Follow a link in the entry. This will offer a selection of any links in the
7897 text belonging to the referenced Org node. If there is only one link, it
7898 will be followed without a selection prompt.
7900 @tsubheading{Change display}
7901 @cindex display changing, in agenda
7904 Interactively select another agenda view and append it to the current view.
7908 Delete other windows.
7910 @orgcmdkskc{v d,d,org-agenda-day-view}
7911 @xorgcmdkskc{v w,w,org-agenda-day-view}
7912 @xorgcmd{v m,org-agenda-month-view}
7913 @xorgcmd{v y,org-agenda-month-year}
7914 @xorgcmd{v SPC,org-agenda-reset-view}
7915 @vindex org-agenda-span
7916 Switch to day/week/month/year view. When switching to day or week view, this
7917 setting becomes the default for subsequent agenda refreshes. Since month and
7918 year views are slow to create, they do not become the default. A numeric
7919 prefix argument may be used to jump directly to a specific day of the year,
7920 ISO week, month, or year, respectively. For example, @kbd{32 d} jumps to
7921 February 1st, @kbd{9 w} to ISO week number 9. When setting day, week, or
7922 month view, a year may be encoded in the prefix argument as well. For
7923 example, @kbd{200712 w} will jump to week 12 in 2007. If such a year
7924 specification has only one or two digits, it will be mapped to the interval
7925 1938-2037. @kbd{v @key{SPC}} will reset to what is set in
7926 @code{org-agenda-span}.
7928 @orgcmd{f,org-agenda-later}
7929 Go forward in time to display the following @code{org-agenda-current-span} days.
7930 For example, if the display covers a week, switch to the following week.
7931 With prefix arg, go forward that many times @code{org-agenda-current-span} days.
7933 @orgcmd{b,org-agenda-earlier}
7934 Go backward in time to display earlier dates.
7936 @orgcmd{.,org-agenda-goto-today}
7939 @orgcmd{j,org-agenda-goto-date}
7940 Prompt for a date and go there.
7942 @orgcmd{J,org-agenda-clock-goto}
7943 Go to the currently clocked-in task @i{in the agenda buffer}.
7945 @orgcmd{D,org-agenda-toggle-diary}
7946 Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}.
7948 @orgcmdkskc{v l,l,org-agenda-log-mode}
7950 @vindex org-log-done
7951 @vindex org-agenda-log-mode-items
7952 Toggle Logbook mode. In Logbook mode, entries that were marked DONE while
7953 logging was on (variable @code{org-log-done}) are shown in the agenda, as are
7954 entries that have been clocked on that day. You can configure the entry
7955 types that should be included in log mode using the variable
7956 @code{org-agenda-log-mode-items}. When called with a @kbd{C-u} prefix, show
7957 all possible logbook entries, including state changes. When called with two
7958 prefix args @kbd{C-u C-u}, show only logging information, nothing else.
7959 @kbd{v L} is equivalent to @kbd{C-u v l}.
7961 @orgcmdkskc{v [,[,org-agenda-manipulate-query-add}
7962 Include inactive timestamps into the current view. Only for weekly/daily
7963 agenda and timeline views.
7965 @orgcmd{v a,org-agenda-archives-mode}
7966 @xorgcmd{v A,org-agenda-archives-mode 'files}
7967 Toggle Archives mode. In Archives mode, trees that are marked
7968 @code{ARCHIVED} are also scanned when producing the agenda. When you use the
7969 capital @kbd{A}, even all archive files are included. To exit archives mode,
7970 press @kbd{v a} again.
7972 @orgcmdkskc{v R,R,org-agenda-clockreport-mode}
7973 @vindex org-agenda-start-with-clockreport-mode
7974 @vindex org-clock-report-include-clocking-task
7975 Toggle Clockreport mode. In Clockreport mode, the daily/weekly agenda will
7976 always show a table with the clocked times for the timespan and file scope
7977 covered by the current agenda view. The initial setting for this mode in new
7978 agenda buffers can be set with the variable
7979 @code{org-agenda-start-with-clockreport-mode}. By using a prefix argument
7980 when toggling this mode (i.e.@: @kbd{C-u R}), the clock table will not show
7981 contributions from entries that are hidden by agenda filtering@footnote{Only
7982 tags filtering will be respected here, effort filtering is ignored.}. See
7983 also the variable @code{org-clock-report-include-clocking-task}.
7986 @vindex org-agenda-clock-consistency-checks
7987 Show overlapping clock entries, clocking gaps, and other clocking problems in
7988 the current agenda range. You can then visit clocking lines and fix them
7989 manually. See the variable @code{org-agenda-clock-consistency-checks} for
7990 information on how to customize the definition of what constituted a clocking
7991 problem. To return to normal agenda display, press @kbd{l} to exit Logbook
7994 @orgcmdkskc{v E,E,org-agenda-entry-text-mode}
7995 @vindex org-agenda-start-with-entry-text-mode
7996 @vindex org-agenda-entry-text-maxlines
7997 Toggle entry text mode. In entry text mode, a number of lines from the Org
7998 outline node referenced by an agenda line will be displayed below the line.
7999 The maximum number of lines is given by the variable
8000 @code{org-agenda-entry-text-maxlines}. Calling this command with a numeric
8001 prefix argument will temporarily modify that number to the prefix value.
8003 @orgcmd{G,org-agenda-toggle-time-grid}
8004 @vindex org-agenda-use-time-grid
8005 @vindex org-agenda-time-grid
8006 Toggle the time grid on and off. See also the variables
8007 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
8009 @orgcmd{r,org-agenda-redo}
8010 Recreate the agenda buffer, for example to reflect the changes after
8011 modification of the timestamps of items with @kbd{S-@key{left}} and
8012 @kbd{S-@key{right}}. When the buffer is the global TODO list, a prefix
8013 argument is interpreted to create a selective list for a specific TODO
8015 @orgcmd{g,org-agenda-redo}
8018 @orgcmdkskc{C-x C-s,s,org-save-all-org-buffers}
8019 Save all Org buffers in the current Emacs session, and also the locations of
8022 @orgcmd{C-c C-x C-c,org-agenda-columns}
8023 @vindex org-columns-default-format
8024 Invoke column view (@pxref{Column view}) in the agenda buffer. The column
8025 view format is taken from the entry at point, or (if there is no entry at
8026 point), from the first entry in the agenda view. So whatever the format for
8027 that entry would be in the original buffer (taken from a property, from a
8028 @code{#+COLUMNS} line, or from the default variable
8029 @code{org-columns-default-format}), will be used in the agenda.
8031 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
8032 Remove the restriction lock on the agenda, if it is currently restricted to a
8033 file or subtree (@pxref{Agenda files}).
8035 @tsubheading{Secondary filtering and query editing}
8036 @cindex filtering, by tag and effort, in agenda
8037 @cindex tag filtering, in agenda
8038 @cindex effort filtering, in agenda
8039 @cindex query editing, in agenda
8041 @orgcmd{/,org-agenda-filter-by-tag}
8042 @vindex org-agenda-filter-preset
8043 Filter the current agenda view with respect to a tag and/or effort estimates.
8044 The difference between this and a custom agenda command is that filtering is
8045 very fast, so that you can switch quickly between different filters without
8046 having to recreate the agenda.@footnote{Custom commands can preset a filter by
8047 binding the variable @code{org-agenda-filter-preset} as an option. This
8048 filter will then be applied to the view and persist as a basic filter through
8049 refreshes and more secondary filtering. The filter is a global property of
8050 the entire agenda view---in a block agenda, you should only set this in the
8051 global options section, not in the section of an individual block.}
8053 You will be prompted for a tag selection letter; @key{SPC} will mean any tag at
8054 all. Pressing @key{TAB} at that prompt will offer use completion to select a
8055 tag (including any tags that do not have a selection character). The command
8056 then hides all entries that do not contain or inherit this tag. When called
8057 with prefix arg, remove the entries that @emph{do} have the tag. A second
8058 @kbd{/} at the prompt will turn off the filter and unhide any hidden entries.
8059 If the first key you press is either @kbd{+} or @kbd{-}, the previous filter
8060 will be narrowed by requiring or forbidding the selected additional tag.
8061 Instead of pressing @kbd{+} or @kbd{-} after @kbd{/}, you can also
8062 immediately use the @kbd{\} command.
8064 @vindex org-sort-agenda-noeffort-is-high
8065 In order to filter for effort estimates, you should set up allowed
8066 efforts globally, for example
8068 (setq org-global-properties
8069 '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
8071 You can then filter for an effort by first typing an operator, one of
8072 @kbd{<}, @kbd{>}, and @kbd{=}, and then the one-digit index of an effort
8073 estimate in your array of allowed values, where @kbd{0} means the 10th value.
8074 The filter will then restrict to entries with effort smaller-or-equal, equal,
8075 or larger-or-equal than the selected value. If the digits 0-9 are not used
8076 as fast access keys to tags, you can also simply press the index digit
8077 directly without an operator. In this case, @kbd{<} will be assumed. For
8078 application of the operator, entries without a defined effort will be treated
8079 according to the value of @code{org-sort-agenda-noeffort-is-high}. To filter
8080 for tasks without effort definition, press @kbd{?} as the operator.
8082 Org also supports automatic, context-aware tag filtering. If the variable
8083 @code{org-agenda-auto-exclude-function} is set to a user-defined function,
8084 that function can decide which tags should be excluded from the agenda
8085 automatically. Once this is set, the @kbd{/} command then accepts @kbd{RET}
8086 as a sub-option key and runs the auto exclusion logic. For example, let's
8087 say you use a @code{Net} tag to identify tasks which need network access, an
8088 @code{Errand} tag for errands in town, and a @code{Call} tag for making phone
8089 calls. You could auto-exclude these tags based on the availability of the
8090 Internet, and outside of business hours, with something like this:
8094 (defun org-my-auto-exclude-function (tag)
8096 ((string= tag "Net")
8097 (/= 0 (call-process "/sbin/ping" nil nil nil
8098 "-c1" "-q" "-t1" "mail.gnu.org")))
8099 ((or (string= tag "Errand") (string= tag "Call"))
8100 (let ((hour (nth 2 (decode-time))))
8101 (or (< hour 8) (> hour 21)))))
8104 (setq org-agenda-auto-exclude-function 'org-my-auto-exclude-function)
8108 @orgcmd{\\,org-agenda-filter-by-tag-refine}
8109 Narrow the current agenda filter by an additional condition. When called with
8110 prefix arg, remove the entries that @emph{do} have the tag, or that do match
8111 the effort criterion. You can achieve the same effect by pressing @kbd{+} or
8112 @kbd{-} as the first key after the @kbd{/} command.
8121 @item @r{in} search view
8122 add new search words (@kbd{[} and @kbd{]}) or new regular expressions
8123 (@kbd{@{} and @kbd{@}}) to the query string. The opening bracket/brace will
8124 add a positive search term prefixed by @samp{+}, indicating that this search
8125 term @i{must} occur/match in the entry. The closing bracket/brace will add a
8126 negative search term which @i{must not} occur/match in the entry for it to be
8130 @tsubheading{Remote editing}
8131 @cindex remote editing, from agenda
8136 @cindex undoing remote-editing events
8137 @cindex remote editing, undo
8138 @orgcmd{C-_,org-agenda-undo}
8139 Undo a change due to a remote editing command. The change is undone
8140 both in the agenda buffer and in the remote buffer.
8142 @orgcmd{t,org-agenda-todo}
8143 Change the TODO state of the item, both in the agenda and in the
8146 @orgcmd{C-S-@key{right},org-agenda-todo-nextset}
8147 @orgcmd{C-S-@key{left},org-agenda-todo-previousset}
8148 Switch to the next/previous set of TODO keywords.
8150 @orgcmd{C-k,org-agenda-kill}
8151 @vindex org-agenda-confirm-kill
8152 Delete the current agenda item along with the entire subtree belonging
8153 to it in the original Org file. If the text to be deleted remotely
8154 is longer than one line, the kill needs to be confirmed by the user. See
8155 variable @code{org-agenda-confirm-kill}.
8157 @orgcmd{C-c C-w,org-agenda-refile}
8158 Refile the entry at point.
8160 @orgcmdkskc{C-c C-x C-a,a,org-agenda-archive-default-with-confirmation}
8161 @vindex org-archive-default-command
8162 Archive the subtree corresponding to the entry at point using the default
8163 archiving command set in @code{org-archive-default-command}. When using the
8164 @code{a} key, confirmation will be required.
8166 @orgcmd{C-c C-x a,org-agenda-toggle-archive-tag}
8167 Toggle the ARCHIVE tag for the current headline.
8169 @orgcmd{C-c C-x A,org-agenda-archive-to-archive-sibling}
8170 Move the subtree corresponding to the current entry to its @emph{archive
8173 @orgcmdkskc{C-c C-x C-s,$,org-agenda-archive}
8174 Archive the subtree corresponding to the current headline. This means the
8175 entry will be moved to the configured archive location, most likely a
8178 @orgcmd{T,org-agenda-show-tags}
8179 @vindex org-agenda-show-inherited-tags
8180 Show all tags associated with the current item. This is useful if you have
8181 turned off @code{org-agenda-show-inherited-tags}, but still want to see all
8182 tags of a headline occasionally.
8184 @orgcmd{:,org-agenda-set-tags}
8185 Set tags for the current headline. If there is an active region in the
8186 agenda, change a tag for all headings in the region.
8190 Set the priority for the current item (@command{org-agenda-priority}).
8191 Org mode prompts for the priority character. If you reply with @key{SPC},
8192 the priority cookie is removed from the entry.
8194 @orgcmd{P,org-agenda-show-priority}
8195 Display weighted priority of current item.
8197 @orgcmdkkc{+,S-@key{up},org-agenda-priority-up}
8198 Increase the priority of the current item. The priority is changed in
8199 the original buffer, but the agenda is not resorted. Use the @kbd{r}
8202 @orgcmdkkc{-,S-@key{down},org-agenda-priority-down}
8203 Decrease the priority of the current item.
8205 @orgcmdkkc{z,C-c C-z,org-agenda-add-note}
8206 @vindex org-log-into-drawer
8207 Add a note to the entry. This note will be recorded, and then filed to the
8208 same location where state change notes are put. Depending on
8209 @code{org-log-into-drawer}, this may be inside a drawer.
8211 @orgcmd{C-c C-a,org-attach}
8212 Dispatcher for all command related to attachments.
8214 @orgcmd{C-c C-s,org-agenda-schedule}
8215 Schedule this item. With prefix arg remove the scheduling timestamp
8217 @orgcmd{C-c C-d,org-agenda-deadline}
8218 Set a deadline for this item. With prefix arg remove the deadline.
8220 @orgcmd{k,org-agenda-action}
8221 Agenda actions, to set dates for selected items to the cursor date.
8222 This command also works in the calendar! The command prompts for an
8225 m @r{Mark the entry at point for action. You can also make entries}
8226 @r{in Org files with @kbd{C-c C-x C-k}.}
8227 d @r{Set the deadline of the marked entry to the date at point.}
8228 s @r{Schedule the marked entry at the date at point.}
8229 r @r{Call @code{org-capture} with the cursor date as default date.}
8232 Press @kbd{r} afterward to refresh the agenda and see the effect of the
8235 @orgcmd{S-@key{right},org-agenda-do-date-later}
8236 Change the timestamp associated with the current line by one day into the
8237 future. If the date is in the past, the first call to this command will move
8239 With a numeric prefix argument, change it by that many days. For example,
8240 @kbd{3 6 5 S-@key{right}} will change it by a year. With a @kbd{C-u} prefix,
8241 change the time by one hour. If you immediately repeat the command, it will
8242 continue to change hours even without the prefix arg. With a double @kbd{C-u
8243 C-u} prefix, do the same for changing minutes.@*
8244 The stamp is changed in the original Org file, but the change is not directly
8245 reflected in the agenda buffer. Use @kbd{r} or @kbd{g} to update the buffer.
8247 @orgcmd{S-@key{left},org-agenda-do-date-earlier}
8248 Change the timestamp associated with the current line by one day
8251 @orgcmd{>,org-agenda-date-prompt}
8252 Change the timestamp associated with the current line. The key @kbd{>} has
8253 been chosen, because it is the same as @kbd{S-.} on my keyboard.
8255 @orgcmd{I,org-agenda-clock-in}
8256 Start the clock on the current item. If a clock is running already, it
8259 @orgcmd{O,org-agenda-clock-out}
8260 Stop the previously started clock.
8262 @orgcmd{X,org-agenda-clock-cancel}
8263 Cancel the currently running clock.
8265 @orgcmd{J,org-agenda-clock-goto}
8266 Jump to the running clock in another window.
8268 @tsubheading{Bulk remote editing selected entries}
8269 @cindex remote editing, bulk, from agenda
8271 @orgcmd{m,org-agenda-bulk-mark}
8272 Mark the entry at point for bulk action. With prefix arg, mark that many
8275 @orgcmd{%,org-agenda-bulk-mark-regexp}
8276 Mark entries matching a regular expression for bulk action.
8278 @orgcmd{u,org-agenda-bulk-unmark}
8279 Unmark entry for bulk action.
8281 @orgcmd{U,org-agenda-bulk-remove-all-marks}
8282 Unmark all marked entries for bulk action.
8284 @orgcmd{B,org-agenda-bulk-action}
8285 Bulk action: act on all marked entries in the agenda. This will prompt for
8286 another key to select the action to be applied. The prefix arg to @kbd{B}
8287 will be passed through to the @kbd{s} and @kbd{d} commands, to bulk-remove
8288 these special timestamps.
8290 r @r{Prompt for a single refile target and move all entries. The entries}
8291 @r{will no longer be in the agenda; refresh (@kbd{g}) to bring them back.}
8292 $ @r{Archive all selected entries.}
8293 A @r{Archive entries by moving them to their respective archive siblings.}
8294 t @r{Change TODO state. This prompts for a single TODO keyword and}
8295 @r{changes the state of all selected entries, bypassing blocking and}
8296 @r{suppressing logging notes (but not timestamps).}
8297 + @r{Add a tag to all selected entries.}
8298 - @r{Remove a tag from all selected entries.}
8299 s @r{Schedule all items to a new date. To shift existing schedule dates}
8300 @r{by a fixed number of days, use something starting with double plus}
8301 @r{at the prompt, for example @samp{++8d} or @samp{++2w}.}
8302 S @r{Reschedule randomly into the coming N days. N will be prompted for.}
8303 @r{With prefix arg (@kbd{C-u B S}), scatter only across weekdays.}
8304 d @r{Set deadline to a specific date.}
8305 f @r{Apply a function to marked entries.}
8306 @r{For example, the function below sets the CATEGORY property of the}
8308 @r{(defun set-category ()}
8309 @r{ (interactive "P")}
8310 @r{ (let* ((marker (or (org-get-at-bol 'org-hd-marker)}
8311 @r{ (org-agenda-error)))}
8312 @r{ (buffer (marker-buffer marker)))}
8313 @r{ (with-current-buffer buffer}
8314 @r{ (save-excursion}
8315 @r{ (save-restriction}
8317 @r{ (goto-char marker)}
8318 @r{ (org-back-to-heading t)}
8319 @r{ (org-set-property "CATEGORY" "web"))))))}
8323 @tsubheading{Calendar commands}
8324 @cindex calendar commands, from agenda
8326 @orgcmd{c,org-agenda-goto-calendar}
8327 Open the Emacs calendar and move to the date at the agenda cursor.
8329 @orgcmd{c,org-calendar-goto-agenda}
8330 When in the calendar, compute and show the Org mode agenda for the
8333 @cindex diary entries, creating from agenda
8334 @orgcmd{i,org-agenda-diary-entry}
8335 @vindex org-agenda-diary-file
8336 Insert a new entry into the diary, using the date at the cursor and (for
8337 block entries) the date at the mark. This will add to the Emacs diary
8338 file@footnote{This file is parsed for the agenda when
8339 @code{org-agenda-include-diary} is set.}, in a way similar to the @kbd{i}
8340 command in the calendar. The diary file will pop up in another window, where
8341 you can add the entry.
8343 If you configure @code{org-agenda-diary-file} to point to an Org mode file,
8344 Org will create entries (in Org mode syntax) in that file instead. Most
8345 entries will be stored in a date-based outline tree that will later make it
8346 easy to archive appointments from previous months/years. The tree will be
8347 built under an entry with a @code{DATE_TREE} property, or else with years as
8348 top-level entries. Emacs will prompt you for the entry text---if you specify
8349 it, the entry will be created in @code{org-agenda-diary-file} without further
8350 interaction. If you directly press @key{RET} at the prompt without typing
8351 text, the target file will be shown in another window for you to finish the
8352 entry there. See also the @kbd{k r} command.
8354 @orgcmd{M,org-agenda-phases-of-moon}
8355 Show the phases of the moon for the three months around current date.
8357 @orgcmd{S,org-agenda-sunrise-sunset}
8358 Show sunrise and sunset times. The geographical location must be set
8359 with calendar variables, see the documentation for the Emacs calendar.
8361 @orgcmd{C,org-agenda-convert-date}
8362 Convert the date at cursor into many other cultural and historic
8365 @orgcmd{H,org-agenda-holidays}
8366 Show holidays for three months around the cursor date.
8368 @item M-x org-export-icalendar-combine-agenda-files
8369 Export a single iCalendar file containing entries from all agenda files.
8370 This is a globally available command, and also available in the agenda menu.
8372 @tsubheading{Exporting to a file}
8373 @orgcmd{C-x C-w,org-write-agenda}
8374 @cindex exporting agenda views
8375 @cindex agenda views, exporting
8376 @vindex org-agenda-exporter-settings
8377 Write the agenda view to a file. Depending on the extension of the selected
8378 file name, the view will be exported as HTML (extension @file{.html} or
8379 @file{.htm}), Postscript (extension @file{.ps}), PDF (extension @file{.pdf}),
8380 and plain text (any other extension). When called with a @kbd{C-u} prefix
8381 argument, immediately open the newly created file. Use the variable
8382 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
8383 for @file{htmlize} to be used during export.
8385 @tsubheading{Quit and Exit}
8386 @orgcmd{q,org-agenda-quit}
8387 Quit agenda, remove the agenda buffer.
8389 @cindex agenda files, removing buffers
8390 @orgcmd{x,org-agenda-exit}
8391 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
8392 for the compilation of the agenda. Buffers created by the user to
8393 visit Org files will not be removed.
8397 @node Custom agenda views, Exporting Agenda Views, Agenda commands, Agenda Views
8398 @section Custom agenda views
8399 @cindex custom agenda views
8400 @cindex agenda views, custom
8402 Custom agenda commands serve two purposes: to store and quickly access
8403 frequently used TODO and tags searches, and to create special composite
8404 agenda buffers. Custom agenda commands will be accessible through the
8405 dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
8408 * Storing searches:: Type once, use often
8409 * Block agenda:: All the stuff you need in a single buffer
8410 * Setting Options:: Changing the rules
8413 @node Storing searches, Block agenda, Custom agenda views, Custom agenda views
8414 @subsection Storing searches
8416 The first application of custom searches is the definition of keyboard
8417 shortcuts for frequently used searches, either creating an agenda
8418 buffer, or a sparse tree (the latter covering of course only the current
8421 @vindex org-agenda-custom-commands
8422 Custom commands are configured in the variable
8423 @code{org-agenda-custom-commands}. You can customize this variable, for
8424 example by pressing @kbd{C-c a C}. You can also directly set it with
8425 Emacs Lisp in @file{.emacs}. The following example contains all valid
8430 (setq org-agenda-custom-commands
8431 '(("w" todo "WAITING")
8432 ("W" todo-tree "WAITING")
8433 ("u" tags "+boss-urgent")
8434 ("v" tags-todo "+boss-urgent")
8435 ("U" tags-tree "+boss-urgent")
8436 ("f" occur-tree "\\<FIXME\\>")
8437 ("h" . "HOME+Name tags searches") ; description for "h" prefix
8438 ("hl" tags "+home+Lisa")
8439 ("hp" tags "+home+Peter")
8440 ("hk" tags "+home+Kim")))
8445 The initial string in each entry defines the keys you have to press
8446 after the dispatcher command @kbd{C-c a} in order to access the command.
8447 Usually this will be just a single character, but if you have many
8448 similar commands, you can also define two-letter combinations where the
8449 first character is the same in several combinations and serves as a
8450 prefix key@footnote{You can provide a description for a prefix key by
8451 inserting a cons cell with the prefix and the description.}. The second
8452 parameter is the search type, followed by the string or regular
8453 expression to be used for the matching. The example above will
8458 as a global search for TODO entries with @samp{WAITING} as the TODO
8461 as the same search, but only in the current buffer and displaying the
8462 results as a sparse tree
8464 as a global tags search for headlines marked @samp{:boss:} but not
8467 as the same search as @kbd{C-c a u}, but limiting the search to
8468 headlines that are also TODO items
8470 as the same search as @kbd{C-c a u}, but only in the current buffer and
8471 displaying the result as a sparse tree
8473 to create a sparse tree (again: current buffer only) with all entries
8474 containing the word @samp{FIXME}
8476 as a prefix command for a HOME tags search where you have to press an
8477 additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
8478 Peter, or Kim) as additional tag to match.
8481 @node Block agenda, Setting Options, Storing searches, Custom agenda views
8482 @subsection Block agenda
8483 @cindex block agenda
8484 @cindex agenda, with block views
8486 Another possibility is the construction of agenda views that comprise
8487 the results of @emph{several} commands, each of which creates a block in
8488 the agenda buffer. The available commands include @code{agenda} for the
8489 daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
8490 for the global TODO list (as constructed with @kbd{C-c a t}), and the
8491 matching commands discussed above: @code{todo}, @code{tags}, and
8492 @code{tags-todo}. Here are two examples:
8496 (setq org-agenda-custom-commands
8497 '(("h" "Agenda and Home-related tasks"
8501 ("o" "Agenda and Office-related tasks"
8509 This will define @kbd{C-c a h} to create a multi-block view for stuff
8510 you need to attend to at home. The resulting agenda buffer will contain
8511 your agenda for the current week, all TODO items that carry the tag
8512 @samp{home}, and also all lines tagged with @samp{garden}. Finally the
8513 command @kbd{C-c a o} provides a similar view for office tasks.
8515 @node Setting Options, , Block agenda, Custom agenda views
8516 @subsection Setting options for custom commands
8517 @cindex options, for custom agenda views
8519 @vindex org-agenda-custom-commands
8520 Org mode contains a number of variables regulating agenda construction
8521 and display. The global variables define the behavior for all agenda
8522 commands, including the custom commands. However, if you want to change
8523 some settings just for a single custom view, you can do so. Setting
8524 options requires inserting a list of variable names and values at the
8525 right spot in @code{org-agenda-custom-commands}. For example:
8529 (setq org-agenda-custom-commands
8530 '(("w" todo "WAITING"
8531 ((org-agenda-sorting-strategy '(priority-down))
8532 (org-agenda-prefix-format " Mixed: ")))
8533 ("U" tags-tree "+boss-urgent"
8534 ((org-show-following-heading nil)
8535 (org-show-hierarchy-above nil)))
8537 ((org-agenda-files '("~org/notes.org"))
8538 (org-agenda-text-search-extra-files nil)))))
8543 Now the @kbd{C-c a w} command will sort the collected entries only by
8544 priority, and the prefix format is modified to just say @samp{ Mixed: }
8545 instead of giving the category of the entry. The sparse tags tree of
8546 @kbd{C-c a U} will now turn out ultra-compact, because neither the
8547 headline hierarchy above the match, nor the headline following the match
8548 will be shown. The command @kbd{C-c a N} will do a text search limited
8549 to only a single file.
8551 @vindex org-agenda-custom-commands
8552 For command sets creating a block agenda,
8553 @code{org-agenda-custom-commands} has two separate spots for setting
8554 options. You can add options that should be valid for just a single
8555 command in the set, and options that should be valid for all commands in
8556 the set. The former are just added to the command entry; the latter
8557 must come after the list of command entries. Going back to the block
8558 agenda example (@pxref{Block agenda}), let's change the sorting strategy
8559 for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
8560 the results for GARDEN tags query in the opposite order,
8561 @code{priority-up}. This would look like this:
8565 (setq org-agenda-custom-commands
8566 '(("h" "Agenda and Home-related tasks"
8570 ((org-agenda-sorting-strategy '(priority-up)))))
8571 ((org-agenda-sorting-strategy '(priority-down))))
8572 ("o" "Agenda and Office-related tasks"
8579 As you see, the values and parentheses setting is a little complex.
8580 When in doubt, use the customize interface to set this variable---it
8581 fully supports its structure. Just one caveat: when setting options in
8582 this interface, the @emph{values} are just Lisp expressions. So if the
8583 value is a string, you need to add the double-quotes around the value
8587 @node Exporting Agenda Views, Agenda column view, Custom agenda views, Agenda Views
8588 @section Exporting Agenda Views
8589 @cindex agenda views, exporting
8591 If you are away from your computer, it can be very useful to have a printed
8592 version of some agenda views to carry around. Org mode can export custom
8593 agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's
8594 @file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the
8595 ghostscript @file{ps2pdf} utility must be installed on the system. Selecting
8596 a PDF file will also create the postscript file.}, and iCalendar files. If
8597 you want to do this only occasionally, use the command
8600 @orgcmd{C-x C-w,org-write-agenda}
8601 @cindex exporting agenda views
8602 @cindex agenda views, exporting
8603 @vindex org-agenda-exporter-settings
8604 Write the agenda view to a file. Depending on the extension of the selected
8605 file name, the view will be exported as HTML (extension @file{.html} or
8606 @file{.htm}), Postscript (extension @file{.ps}), iCalendar (extension
8607 @file{.ics}), or plain text (any other extension). Use the variable
8608 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
8609 for @file{htmlize} to be used during export, for example
8611 @vindex org-agenda-add-entry-text-maxlines
8612 @vindex htmlize-output-type
8613 @vindex ps-number-of-columns
8614 @vindex ps-landscape-mode
8616 (setq org-agenda-exporter-settings
8617 '((ps-number-of-columns 2)
8618 (ps-landscape-mode t)
8619 (org-agenda-add-entry-text-maxlines 5)
8620 (htmlize-output-type 'css)))
8624 If you need to export certain agenda views frequently, you can associate
8625 any custom agenda command with a list of output file names
8626 @footnote{If you want to store standard views like the weekly agenda
8627 or the global TODO list as well, you need to define custom commands for
8628 them in order to be able to specify file names.}. Here is an example
8629 that first defines custom commands for the agenda and the global
8630 TODO list, together with a number of files to which to export them.
8631 Then we define two block agenda commands and specify file names for them
8632 as well. File names can be relative to the current working directory,
8637 (setq org-agenda-custom-commands
8638 '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
8639 ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
8640 ("h" "Agenda and Home-related tasks"
8645 ("~/views/home.html"))
8646 ("o" "Agenda and Office-related tasks"
8651 ("~/views/office.ps" "~/calendars/office.ics"))))
8655 The extension of the file name determines the type of export. If it is
8656 @file{.html}, Org mode will use the @file{htmlize.el} package to convert
8657 the buffer to HTML and save it to this file name. If the extension is
8658 @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
8659 Postscript output. If the extension is @file{.ics}, iCalendar export is
8660 run export over all files that were used to construct the agenda, and
8661 limit the export to entries listed in the agenda. Any other
8662 extension produces a plain ASCII file.
8664 The export files are @emph{not} created when you use one of those
8665 commands interactively because this might use too much overhead.
8666 Instead, there is a special command to produce @emph{all} specified
8670 @orgcmd{C-c a e,org-store-agenda-views}
8671 Export all agenda views that have export file names associated with
8675 You can use the options section of the custom agenda commands to also
8676 set options for the export commands. For example:
8679 (setq org-agenda-custom-commands
8681 ((ps-number-of-columns 2)
8682 (ps-landscape-mode t)
8683 (org-agenda-prefix-format " [ ] ")
8684 (org-agenda-with-colors nil)
8685 (org-agenda-remove-tags t))
8690 This command sets two options for the Postscript exporter, to make it
8691 print in two columns in landscape format---the resulting page can be cut
8692 in two and then used in a paper agenda. The remaining settings modify
8693 the agenda prefix to omit category and scheduling information, and
8694 instead include a checkbox to check off items. We also remove the tags
8695 to make the lines compact, and we don't want to use colors for the
8696 black-and-white printer. Settings specified in
8697 @code{org-agenda-exporter-settings} will also apply, but the settings
8698 in @code{org-agenda-custom-commands} take precedence.
8701 From the command line you may also use
8703 emacs -eval (org-batch-store-agenda-views) -kill
8706 or, if you need to modify some parameters@footnote{Quoting depends on the
8707 system you use, please check the FAQ for examples.}
8709 emacs -eval '(org-batch-store-agenda-views \
8710 org-agenda-span (quote month) \
8711 org-agenda-start-day "2007-11-01" \
8712 org-agenda-include-diary nil \
8713 org-agenda-files (quote ("~/org/project.org")))' \
8717 which will create the agenda views restricted to the file
8718 @file{~/org/project.org}, without diary entries and with a 30-day
8721 You can also extract agenda information in a way that allows further
8722 processing by other programs. See @ref{Extracting agenda information}, for
8726 @node Agenda column view, , Exporting Agenda Views, Agenda Views
8727 @section Using column view in the agenda
8728 @cindex column view, in agenda
8729 @cindex agenda, column view
8731 Column view (@pxref{Column view}) is normally used to view and edit
8732 properties embedded in the hierarchical structure of an Org file. It can be
8733 quite useful to use column view also from the agenda, where entries are
8734 collected by certain criteria.
8737 @orgcmd{C-c C-x C-c,org-agenda-columns}
8738 Turn on column view in the agenda.
8741 To understand how to use this properly, it is important to realize that the
8742 entries in the agenda are no longer in their proper outline environment.
8743 This causes the following issues:
8747 @vindex org-columns-default-format
8748 @vindex org-overriding-columns-format
8749 Org needs to make a decision which @code{COLUMNS} format to use. Since the
8750 entries in the agenda are collected from different files, and different files
8751 may have different @code{COLUMNS} formats, this is a non-trivial problem.
8752 Org first checks if the variable @code{org-agenda-overriding-columns-format} is
8753 currently set, and if so, takes the format from there. Otherwise it takes
8754 the format associated with the first item in the agenda, or, if that item
8755 does not have a specific format (defined in a property, or in its file), it
8756 uses @code{org-columns-default-format}.
8758 @cindex property, special, CLOCKSUM
8759 If any of the columns has a summary type defined (@pxref{Column attributes}),
8760 turning on column view in the agenda will visit all relevant agenda files and
8761 make sure that the computations of this property are up to date. This is
8762 also true for the special @code{CLOCKSUM} property. Org will then sum the
8763 values displayed in the agenda. In the daily/weekly agenda, the sums will
8764 cover a single day; in all other views they cover the entire block. It is
8765 vital to realize that the agenda may show the same entry @emph{twice} (for
8766 example as scheduled and as a deadline), and it may show two entries from the
8767 same hierarchy (for example a @emph{parent} and its @emph{child}). In these
8768 cases, the summation in the agenda will lead to incorrect results because
8769 some values will count double.
8771 When the column view in the agenda shows the @code{CLOCKSUM}, that is always
8772 the entire clocked time for this item. So even in the daily/weekly agenda,
8773 the clocksum listed in column view may originate from times outside the
8774 current view. This has the advantage that you can compare these values with
8775 a column listing the planned total effort for a task---one of the major
8776 applications for column view in the agenda. If you want information about
8777 clocked time in the displayed period use clock table mode (press @kbd{R} in
8782 @node Markup, Exporting, Agenda Views, Top
8783 @chapter Markup for rich export
8785 When exporting Org mode documents, the exporter tries to reflect the
8786 structure of the document as accurately as possible in the backend. Since
8787 export targets like HTML, @LaTeX{}, or DocBook allow much richer formatting,
8788 Org mode has rules on how to prepare text for rich export. This section
8789 summarizes the markup rules used in an Org mode buffer.
8792 * Structural markup elements:: The basic structure as seen by the exporter
8793 * Images and tables:: Tables and Images will be included
8794 * Literal examples:: Source code examples with special formatting
8795 * Include files:: Include additional files into a document
8796 * Index entries:: Making an index
8797 * Macro replacement:: Use macros to create complex output
8798 * Embedded LaTeX:: LaTeX can be freely used inside Org documents
8801 @node Structural markup elements, Images and tables, Markup, Markup
8802 @section Structural markup elements
8805 * Document title:: Where the title is taken from
8806 * Headings and sections:: The document structure as seen by the exporter
8807 * Table of contents:: The if and where of the table of contents
8808 * Initial text:: Text before the first heading?
8810 * Paragraphs:: Paragraphs
8811 * Footnote markup:: Footnotes
8812 * Emphasis and monospace:: Bold, italic, etc.
8813 * Horizontal rules:: Make a line
8814 * Comment lines:: What will *not* be exported
8817 @node Document title, Headings and sections, Structural markup elements, Structural markup elements
8818 @subheading Document title
8819 @cindex document title, markup rules
8822 The title of the exported document is taken from the special line
8826 #+TITLE: This is the title of the document
8830 If this line does not exist, the title is derived from the first non-empty,
8831 non-comment line in the buffer. If no such line exists, or if you have
8832 turned off exporting of the text before the first headline (see below), the
8833 title will be the file name without extension.
8835 @cindex property, EXPORT_TITLE
8836 If you are exporting only a subtree by marking is as the region, the heading
8837 of the subtree will become the title of the document. If the subtree has a
8838 property @code{EXPORT_TITLE}, that will take precedence.
8840 @node Headings and sections, Table of contents, Document title, Structural markup elements
8841 @subheading Headings and sections
8842 @cindex headings and sections, markup rules
8844 @vindex org-export-headline-levels
8845 The outline structure of the document as described in @ref{Document
8846 Structure}, forms the basis for defining sections of the exported document.
8847 However, since the outline structure is also used for (for example) lists of
8848 tasks, only the first three outline levels will be used as headings. Deeper
8849 levels will become itemized lists. You can change the location of this
8850 switch globally by setting the variable @code{org-export-headline-levels}, or on a
8851 per-file basis with a line
8858 @node Table of contents, Initial text, Headings and sections, Structural markup elements
8859 @subheading Table of contents
8860 @cindex table of contents, markup rules
8862 @vindex org-export-with-toc
8863 The table of contents is normally inserted directly before the first headline
8864 of the file. If you would like to get it to a different location, insert the
8865 string @code{[TABLE-OF-CONTENTS]} on a line by itself at the desired
8866 location. The depth of the table of contents is by default the same as the
8867 number of headline levels, but you can choose a smaller number, or turn off
8868 the table of contents entirely, by configuring the variable
8869 @code{org-export-with-toc}, or on a per-file basis with a line like
8872 #+OPTIONS: toc:2 (only to two levels in TOC)
8873 #+OPTIONS: toc:nil (no TOC at all)
8876 @node Initial text, Lists, Table of contents, Structural markup elements
8877 @subheading Text before the first headline
8878 @cindex text before first headline, markup rules
8881 Org mode normally exports the text before the first headline, and even uses
8882 the first line as the document title. The text will be fully marked up. If
8883 you need to include literal HTML, @LaTeX{}, or DocBook code, use the special
8884 constructs described below in the sections for the individual exporters.
8886 @vindex org-export-skip-text-before-1st-heading
8887 Some people like to use the space before the first headline for setup and
8888 internal links and therefore would like to control the exported text before
8889 the first headline in a different way. You can do so by setting the variable
8890 @code{org-export-skip-text-before-1st-heading} to @code{t}. On a per-file
8891 basis, you can get the same effect with @samp{#+OPTIONS: skip:t}.
8894 If you still want to have some text before the first headline, use the
8895 @code{#+TEXT} construct:
8899 #+TEXT: This text will go before the *first* headline.
8900 #+TEXT: [TABLE-OF-CONTENTS]
8901 #+TEXT: This goes between the table of contents and the *first* headline
8904 @node Lists, Paragraphs, Initial text, Structural markup elements
8906 @cindex lists, markup rules
8908 Plain lists as described in @ref{Plain lists}, are translated to the backend's
8909 syntax for such lists. Most backends support unordered, ordered, and
8912 @node Paragraphs, Footnote markup, Lists, Structural markup elements
8913 @subheading Paragraphs, line breaks, and quoting
8914 @cindex paragraphs, markup rules
8916 Paragraphs are separated by at least one empty line. If you need to enforce
8917 a line break within a paragraph, use @samp{\\} at the end of a line.
8919 To keep the line breaks in a region, but otherwise use normal formatting, you
8920 can use this construct, which can also be used to format poetry.
8922 @cindex #+BEGIN_VERSE
8925 Great clouds overhead
8926 Tiny black birds rise and fall
8933 When quoting a passage from another document, it is customary to format this
8934 as a paragraph that is indented on both the left and the right margin. You
8935 can include quotations in Org mode documents like this:
8937 @cindex #+BEGIN_QUOTE
8940 Everything should be made as simple as possible,
8941 but not any simpler -- Albert Einstein
8945 If you would like to center some text, do it like this:
8946 @cindex #+BEGIN_CENTER
8949 Everything should be made as simple as possible, \\
8955 @node Footnote markup, Emphasis and monospace, Paragraphs, Structural markup elements
8956 @subheading Footnote markup
8957 @cindex footnotes, markup rules
8958 @cindex @file{footnote.el}
8960 Footnotes defined in the way described in @ref{Footnotes}, will be exported
8961 by all backends. Org allows multiple references to the same note, and
8962 multiple footnotes side by side.
8964 @node Emphasis and monospace, Horizontal rules, Footnote markup, Structural markup elements
8965 @subheading Emphasis and monospace
8967 @cindex underlined text, markup rules
8968 @cindex bold text, markup rules
8969 @cindex italic text, markup rules
8970 @cindex verbatim text, markup rules
8971 @cindex code text, markup rules
8972 @cindex strike-through text, markup rules
8973 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=}
8974 and @code{~verbatim~}, and, if you must, @samp{+strike-through+}. Text
8975 in the code and verbatim string is not processed for Org mode specific
8976 syntax; it is exported verbatim.
8978 @node Horizontal rules, Comment lines, Emphasis and monospace, Structural markup elements
8979 @subheading Horizontal rules
8980 @cindex horizontal rules, markup rules
8981 A line consisting of only dashes, and at least 5 of them, will be exported as
8982 a horizontal line (@samp{<hr/>} in HTML and @code{\hrule} in @LaTeX{}).
8984 @node Comment lines, , Horizontal rules, Structural markup elements
8985 @subheading Comment lines
8986 @cindex comment lines
8987 @cindex exporting, not
8988 @cindex #+BEGIN_COMMENT
8990 Lines starting with @samp{#} in column zero are treated as comments and will
8991 never be exported. If you want an indented line to be treated as a comment,
8992 start it with @samp{#+ }. Also entire subtrees starting with the word
8993 @samp{COMMENT} will never be exported. Finally, regions surrounded by
8994 @samp{#+BEGIN_COMMENT} ... @samp{#+END_COMMENT} will not be exported.
8999 Toggle the COMMENT keyword at the beginning of an entry.
9003 @node Images and tables, Literal examples, Structural markup elements, Markup
9004 @section Images and Tables
9006 @cindex tables, markup rules
9009 Both the native Org mode tables (@pxref{Tables}) and tables formatted with
9010 the @file{table.el} package will be exported properly. For Org mode tables,
9011 the lines before the first horizontal separator line will become table header
9012 lines. You can use the following lines somewhere before the table to assign
9013 a caption and a label for cross references, and in the text you can refer to
9014 the object with @code{\ref@{tab:basic-data@}}:
9017 #+CAPTION: This is the caption for the next table (or link)
9018 #+LABEL: tbl:basic-data
9023 Optionally, the caption can take the form:
9025 #+CAPTION: [Caption for list of figures]@{Caption for table (or link).@}
9028 @cindex inlined images, markup rules
9029 Some backends (HTML, @LaTeX{}, and DocBook) allow you to directly include
9030 images into the exported document. Org does this, if a link to an image
9031 files does not have a description part, for example @code{[[./img/a.jpg]]}.
9032 If you wish to define a caption for the image and maybe a label for internal
9033 cross references, make sure that the link is on a line by itself and precede
9034 it with @code{#+CAPTION} and @code{#+LABEL} as follows:
9037 #+CAPTION: This is the caption for the next figure link (or table)
9038 #+LABEL: fig:SED-HR4049
9042 You may also define additional attributes for the figure. As this is
9043 backend-specific, see the sections about the individual backends for more
9046 @xref{Handling links,the discussion of image links}.
9048 @node Literal examples, Include files, Images and tables, Markup
9049 @section Literal examples
9050 @cindex literal examples, markup rules
9051 @cindex code line references, markup rules
9053 You can include literal examples that should not be subjected to
9054 markup. Such examples will be typeset in monospace, so this is well suited
9055 for source code and similar examples.
9056 @cindex #+BEGIN_EXAMPLE
9060 Some example from a text file.
9064 Note that such blocks may be @i{indented} in order to align nicely with
9065 indented text and in particular with plain list structure (@pxref{Plain
9066 lists}). For simplicity when using small examples, you can also start the
9067 example lines with a colon followed by a space. There may also be additional
9068 whitespace before the colon:
9072 : Some example from a text file.
9075 @cindex formatting source code, markup rules
9076 If the example is source code from a programming language, or any other text
9077 that can be marked up by font-lock in Emacs, you can ask for the example to
9078 look like the fontified Emacs buffer@footnote{This works automatically for
9079 the HTML backend (it requires version 1.34 of the @file{htmlize.el} package,
9080 which is distributed with Org). Fontified code chunks in LaTeX can be
9081 achieved using either the listings or the
9082 @url{http://code.google.com/p/minted, minted,} package. To use listings, turn
9083 on the variable @code{org-export-latex-listings} and ensure that the listings
9084 package is included by the LaTeX header (e.g.@: by configuring
9085 @code{org-export-latex-packages-alist}). See the listings documentation for
9086 configuration options, including obtaining colored output. For minted it is
9087 necessary to install the program @url{http://pygments.org, pygments}, in
9088 addition to setting @code{org-export-latex-minted}, ensuring that the minted
9089 package is included by the LaTeX header, and ensuring that the
9090 @code{-shell-escape} option is passed to @file{pdflatex} (see
9091 @code{org-latex-to-pdf-process}). See the documentation of the variables
9092 @code{org-export-latex-listings} and @code{org-export-latex-minted} for
9093 further details.}. This is done with the @samp{src} block, where you also
9094 need to specify the name of the major mode that should be used to fontify the
9095 example@footnote{Code in @samp{src} blocks may also be evaluated either
9096 interactively or on export. See @pxref{Working With Source Code} for more
9097 information on evaluating code blocks.}, see @ref{Easy Templates} for
9098 shortcuts to easily insert code blocks.
9102 #+BEGIN_SRC emacs-lisp
9103 (defun org-xor (a b)
9109 Both in @code{example} and in @code{src} snippets, you can add a @code{-n}
9110 switch to the end of the @code{BEGIN} line, to get the lines of the example
9111 numbered. If you use a @code{+n} switch, the numbering from the previous
9112 numbered snippet will be continued in the current one. In literal examples,
9113 Org will interpret strings like @samp{(ref:name)} as labels, and use them as
9114 targets for special hyperlinks like @code{[[(name)]]} (i.e.@: the reference name
9115 enclosed in single parenthesis). In HTML, hovering the mouse over such a
9116 link will remote-highlight the corresponding code line, which is kind of
9119 You can also add a @code{-r} switch which @i{removes} the labels from the
9120 source code@footnote{Adding @code{-k} to @code{-n -r} will @i{keep} the
9121 labels in the source code while using line numbers for the links, which might
9122 be useful to explain those in an Org mode example code.}. With the @code{-n}
9123 switch, links to these references will be labeled by the line numbers from
9124 the code listing, otherwise links will use the labels with no parentheses.
9128 #+BEGIN_SRC emacs-lisp -n -r
9129 (save-excursion (ref:sc)
9130 (goto-char (point-min)) (ref:jump)
9132 In line [[(sc)]] we remember the current position. [[(jump)][Line (jump)]]
9136 @vindex org-coderef-label-format
9137 If the syntax for the label format conflicts with the language syntax, use a
9138 @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
9139 -n -r -l "((%s))"}. See also the variable @code{org-coderef-label-format}.
9141 HTML export also allows examples to be published as text areas (@pxref{Text
9142 areas in HTML export}).
9144 Because the @code{#+BEGIN_...} and @code{#+END_...} patterns need to be added
9145 so often, shortcuts are provided using the Easy Templates facility
9146 (@pxref{Easy Templates}).
9151 Edit the source code example at point in its native mode. This works by
9152 switching to a temporary buffer with the source code. You need to exit by
9153 pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*}
9154 or @samp{#} will get a comma prepended, to keep them from being interpreted
9155 by Org as outline nodes or special comments. These commas will be stripped
9156 for editing with @kbd{C-c '}, and also for export.}. The edited version will
9157 then replace the old version in the Org buffer. Fixed-width regions
9158 (where each line starts with a colon followed by a space) will be edited
9159 using @code{artist-mode}@footnote{You may select a different-mode with the
9160 variable @code{org-edit-fixed-width-region-mode}.} to allow creating ASCII
9161 drawings easily. Using this command in an empty line will create a new
9165 Calling @code{org-store-link} while editing a source code example in a
9166 temporary buffer created with @kbd{C-c '} will prompt for a label. Make sure
9167 that it is unique in the current buffer, and insert it with the proper
9168 formatting like @samp{(ref:label)} at the end of the current line. Then the
9169 label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
9173 @node Include files, Index entries, Literal examples, Markup
9174 @section Include files
9175 @cindex include files, markup rules
9177 During export, you can include the content of another file. For example, to
9178 include your @file{.emacs} file, you could use:
9182 #+INCLUDE: "~/.emacs" src emacs-lisp
9185 The optional second and third parameter are the markup (e.g.@: @samp{quote},
9186 @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the
9187 language for formatting the contents. The markup is optional; if it is not
9188 given, the text will be assumed to be in Org mode format and will be
9189 processed normally. The include line will also allow additional keyword
9190 parameters @code{:prefix1} and @code{:prefix} to specify prefixes for the
9191 first line and for each following line, @code{:minlevel} in order to get
9192 Org mode content demoted to a specified level, as well as any options
9193 accepted by the selected markup. For example, to include a file as an item,
9197 #+INCLUDE: "~/snippets/xx" :prefix1 " + " :prefix " "
9200 You can also include a portion of a file by specifying a lines range using
9201 the @code{:lines} parameter. The line at the upper end of the range will not
9202 be included. The start and/or the end of the range may be omitted to use the
9206 #+INCLUDE: "~/.emacs" :lines "5-10" @r{Include lines 5 to 10, 10 excluded}
9207 #+INCLUDE: "~/.emacs" :lines "-10" @r{Include lines 1 to 10, 10 excluded}
9208 #+INCLUDE: "~/.emacs" :lines "10-" @r{Include lines from 10 to EOF}
9214 Visit the include file at point.
9217 @node Index entries, Macro replacement, Include files, Markup
9218 @section Index entries
9219 @cindex index entries, for publishing
9221 You can specify entries that will be used for generating an index during
9222 publishing. This is done by lines starting with @code{#+INDEX}. An entry
9223 the contains an exclamation mark will create a sub item. See @ref{Generating
9224 an index} for more information.
9229 #+INDEX: Application!CV
9235 @node Macro replacement, Embedded LaTeX, Index entries, Markup
9236 @section Macro replacement
9237 @cindex macro replacement, during export
9240 You can define text snippets with
9243 #+MACRO: name replacement text $1, $2 are arguments
9246 @noindent which can be referenced anywhere in the document (even in
9247 code examples) with @code{@{@{@{name(arg1,arg2)@}@}@}}. In addition to
9248 defined macros, @code{@{@{@{title@}@}@}}, @code{@{@{@{author@}@}@}}, etc.,
9249 will reference information set by the @code{#+TITLE:}, @code{#+AUTHOR:}, and
9250 similar lines. Also, @code{@{@{@{date(@var{FORMAT})@}@}@}} and
9251 @code{@{@{@{modification-time(@var{FORMAT})@}@}@}} refer to current date time
9252 and to the modification time of the file being exported, respectively.
9253 @var{FORMAT} should be a format string understood by
9254 @code{format-time-string}.
9256 Macro expansion takes place during export, and some people use it to
9257 construct complex HTML code.
9260 @node Embedded LaTeX, , Macro replacement, Markup
9261 @section Embedded @LaTeX{}
9262 @cindex @TeX{} interpretation
9263 @cindex @LaTeX{} interpretation
9265 Plain ASCII is normally sufficient for almost all note taking. Exceptions
9266 include scientific notes, which often require mathematical symbols and the
9267 occasional formula. @LaTeX{}@footnote{@LaTeX{} is a macro system based on
9268 Donald E. Knuth's @TeX{} system. Many of the features described here as
9269 ``@LaTeX{}'' are really from @TeX{}, but for simplicity I am blurring this
9270 distinction.} is widely used to typeset scientific documents. Org mode
9271 supports embedding @LaTeX{} code into its files, because many academics are
9272 used to writing and reading @LaTeX{} source code, and because it can be
9273 readily processed to produce pretty output for a number of export backends.
9276 * Special symbols:: Greek letters and other symbols
9277 * Subscripts and superscripts:: Simple syntax for raising/lowering text
9278 * LaTeX fragments:: Complex formulas made easy
9279 * Previewing LaTeX fragments:: What will this snippet look like?
9280 * CDLaTeX mode:: Speed up entering of formulas
9283 @node Special symbols, Subscripts and superscripts, Embedded LaTeX, Embedded LaTeX
9284 @subsection Special symbols
9285 @cindex math symbols
9286 @cindex special symbols
9287 @cindex @TeX{} macros
9288 @cindex @LaTeX{} fragments, markup rules
9289 @cindex HTML entities
9290 @cindex @LaTeX{} entities
9292 You can use @LaTeX{} macros to insert special symbols like @samp{\alpha} to
9293 indicate the Greek letter, or @samp{\to} to indicate an arrow. Completion
9294 for these macros is available, just type @samp{\} and maybe a few letters,
9295 and press @kbd{M-@key{TAB}} to see possible completions. Unlike @LaTeX{}
9296 code, Org mode allows these macros to be present without surrounding math
9297 delimiters, for example:
9300 Angles are written as Greek letters \alpha, \beta and \gamma.
9303 @vindex org-entities
9304 During export, these symbols will be transformed into the native format of
9305 the exporter backend. Strings like @code{\alpha} will be exported as
9306 @code{α} in the HTML output, and as @code{$\alpha$} in the @LaTeX{}
9307 output. Similarly, @code{\nbsp} will become @code{ } in HTML and
9308 @code{~} in @LaTeX{}. If you need such a symbol inside a word, terminate it
9309 like this: @samp{\Aacute@{@}stor}.
9311 A large number of entities is provided, with names taken from both HTML and
9312 @LaTeX{}; see the variable @code{org-entities} for the complete list.
9313 @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
9314 @samp{...} are all converted into special commands creating hyphens of
9315 different lengths or a compact set of dots.
9317 If you would like to see entities displayed as UTF8 characters, use the
9318 following command@footnote{You can turn this on by default by setting the
9319 variable @code{org-pretty-entities}, or on a per-file base with the
9320 @code{#+STARTUP} option @code{entitiespretty}.}:
9325 Toggle display of entities as UTF-8 characters. This does not change the
9326 buffer content which remains plain ASCII, but it overlays the UTF-8 character
9327 for display purposes only.
9330 @node Subscripts and superscripts, LaTeX fragments, Special symbols, Embedded LaTeX
9331 @subsection Subscripts and superscripts
9335 Just like in @LaTeX{}, @samp{^} and @samp{_} are used to indicate super-
9336 and subscripts. Again, these can be used without embedding them in
9337 math-mode delimiters. To increase the readability of ASCII text, it is
9338 not necessary (but OK) to surround multi-character sub- and superscripts
9339 with curly braces. For example
9342 The mass of the sun is M_sun = 1.989 x 10^30 kg. The radius of
9343 the sun is R_@{sun@} = 6.96 x 10^8 m.
9346 @vindex org-export-with-sub-superscripts
9347 To avoid interpretation as raised or lowered text, you can quote @samp{^} and
9348 @samp{_} with a backslash: @samp{\^} and @samp{\_}. If you write a text
9349 where the underscore is often used in a different context, Org's convention
9350 to always interpret these as subscripts can get in your way. Configure the
9351 variable @code{org-export-with-sub-superscripts} to globally change this
9352 convention, or use, on a per-file basis:
9358 @noindent With this setting, @samp{a_b} will not be interpreted as a
9359 subscript, but @samp{a_@{b@}} will.
9364 In addition to showing entities as UTF-8 characters, this command will also
9365 format sub- and superscripts in a WYSIWYM way.
9368 @node LaTeX fragments, Previewing LaTeX fragments, Subscripts and superscripts, Embedded LaTeX
9369 @subsection @LaTeX{} fragments
9370 @cindex @LaTeX{} fragments
9372 @vindex org-format-latex-header
9373 Going beyond symbols and sub- and superscripts, a full formula language is
9374 needed. Org mode can contain @LaTeX{} math fragments, and it supports ways
9375 to process these for several export backends. When exporting to @LaTeX{},
9376 the code is obviously left as it is. When exporting to HTML, Org invokes the
9377 @uref{http://www.mathjax.org, MathJax library} (@pxref{Math formatting in
9378 HTML export}) to process and display the math@footnote{If you plan to use
9379 this regularly or on pages with significant page views, you should install
9380 @file{MathJax} on your own
9381 server in order to limit the load of our server.}. Finally, it can also
9382 process the mathematical expressions into images@footnote{For this to work
9383 you need to be on a system with a working @LaTeX{} installation. You also
9384 need the @file{dvipng} program, available at
9385 @url{http://sourceforge.net/projects/dvipng/}. The @LaTeX{} header that will
9386 be used when processing a fragment can be configured with the variable
9387 @code{org-format-latex-header}.} that can be displayed in a browser or in
9390 @LaTeX{} fragments don't need any special marking at all. The following
9391 snippets will be identified as @LaTeX{} source code:
9394 Environments of any kind@footnote{When @file{MathJax} is used, only the
9395 environment recognized by @file{MathJax} will be processed. When
9396 @file{dvipng} is used to create images, any @LaTeX{} environments will be
9397 handled.}. The only requirement is that the @code{\begin} statement appears
9398 on a new line, preceded by only whitespace.
9400 Text within the usual @LaTeX{} math delimiters. To avoid conflicts with
9401 currency specifications, single @samp{$} characters are only recognized as
9402 math delimiters if the enclosed text contains at most two line breaks, is
9403 directly attached to the @samp{$} characters with no whitespace in between,
9404 and if the closing @samp{$} is followed by whitespace, punctuation or a dash.
9405 For the other delimiters, there is no such restriction, so when in doubt, use
9406 @samp{\(...\)} as inline math delimiters.
9409 @noindent For example:
9412 \begin@{equation@} % arbitrary environments,
9413 x=\sqrt@{b@} % even tables, figures
9414 \end@{equation@} % etc
9416 If $a^2=b$ and \( b=2 \), then the solution must be
9417 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
9421 @vindex org-format-latex-options
9422 If you need any of the delimiter ASCII sequences for other purposes, you
9423 can configure the option @code{org-format-latex-options} to deselect the
9424 ones you do not wish to have interpreted by the @LaTeX{} converter.
9426 @vindex org-export-with-LaTeX-fragments
9427 LaTeX processing can be configured with the variable
9428 @code{org-export-with-LaTeX-fragments}. The default setting is @code{t}
9429 which means @file{MathJax} for HTML, and no processing for DocBook, ASCII and
9430 LaTeX backends. You can also set this variable on a per-file basis using one
9434 #+OPTIONS: LaTeX:t @r{Do the right thing automatically (MathJax)}
9435 #+OPTIONS: LaTeX:dvipng @r{Force using dvipng images}
9436 #+OPTIONS: LaTeX:nil @r{Do not process @LaTeX{} fragments at all}
9437 #+OPTIONS: LaTeX:verbatim @r{Verbatim export, for jsMath or so}
9440 @node Previewing LaTeX fragments, CDLaTeX mode, LaTeX fragments, Embedded LaTeX
9441 @subsection Previewing LaTeX fragments
9442 @cindex LaTeX fragments, preview
9444 If you have @file{dvipng} installed, @LaTeX{} fragments can be processed to
9445 produce preview images of the typeset expressions:
9450 Produce a preview image of the @LaTeX{} fragment at point and overlay it
9451 over the source code. If there is no fragment at point, process all
9452 fragments in the current entry (between two headlines). When called
9453 with a prefix argument, process the entire subtree. When called with
9454 two prefix arguments, or when the cursor is before the first headline,
9455 process the entire buffer.
9458 Remove the overlay preview images.
9461 @vindex org-format-latex-options
9462 You can customize the variable @code{org-format-latex-options} to influence
9463 some aspects of the preview. In particular, the @code{:scale} (and for HTML
9464 export, @code{:html-scale}) property can be used to adjust the size of the
9467 @node CDLaTeX mode, , Previewing LaTeX fragments, Embedded LaTeX
9468 @subsection Using CDLa@TeX{} to enter math
9471 CDLa@TeX{} mode is a minor mode that is normally used in combination with a
9472 major @LaTeX{} mode like AUC@TeX{} in order to speed-up insertion of
9473 environments and math templates. Inside Org mode, you can make use of
9474 some of the features of CDLa@TeX{} mode. You need to install
9475 @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
9476 AUC@TeX{}) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
9477 Don't use CDLa@TeX{} mode itself under Org mode, but use the light
9478 version @code{org-cdlatex-mode} that comes as part of Org mode. Turn it
9479 on for the current buffer with @code{M-x org-cdlatex-mode}, or for all
9483 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
9486 When this mode is enabled, the following features are present (for more
9487 details see the documentation of CDLa@TeX{} mode):
9491 Environment templates can be inserted with @kbd{C-c @{}.
9494 The @key{TAB} key will do template expansion if the cursor is inside a
9495 @LaTeX{} fragment@footnote{Org mode has a method to test if the cursor is
9496 inside such a fragment, see the documentation of the function
9497 @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will
9498 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
9499 correctly inside the first brace. Another @key{TAB} will get you into
9500 the second brace. Even outside fragments, @key{TAB} will expand
9501 environment abbreviations at the beginning of a line. For example, if
9502 you write @samp{equ} at the beginning of a line and press @key{TAB},
9503 this abbreviation will be expanded to an @code{equation} environment.
9504 To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}.
9508 @vindex cdlatex-simplify-sub-super-scripts
9509 Pressing @kbd{_} and @kbd{^} inside a @LaTeX{} fragment will insert these
9510 characters together with a pair of braces. If you use @key{TAB} to move
9511 out of the braces, and if the braces surround only a single character or
9512 macro, they are removed again (depending on the variable
9513 @code{cdlatex-simplify-sub-super-scripts}).
9516 Pressing the backquote @kbd{`} followed by a character inserts math
9517 macros, also outside @LaTeX{} fragments. If you wait more than 1.5 seconds
9518 after the backquote, a help window will pop up.
9521 Pressing the single-quote @kbd{'} followed by another character modifies
9522 the symbol before point with an accent or a font. If you wait more than
9523 1.5 seconds after the single-quote, a help window will pop up. Character
9524 modification will work only inside @LaTeX{} fragments; outside the quote
9528 @node Exporting, Publishing, Markup, Top
9532 Org mode documents can be exported into a variety of other formats. For
9533 printing and sharing of notes, ASCII export produces a readable and simple
9534 version of an Org file. HTML export allows you to publish a notes file on
9535 the web, while the XOXO format provides a solid base for exchange with a
9536 broad range of other applications. @LaTeX{} export lets you use Org mode and
9537 its structured editing functions to easily create @LaTeX{} files. DocBook
9538 export makes it possible to convert Org files to many other formats using
9539 DocBook tools. OpenDocument Text(@acronym{ODT}) export allows seamless
9540 colloboration across organizational boundaries. For project management you
9541 can create gantt and resource charts by using TaskJuggler export. To
9542 incorporate entries with associated times like deadlines or appointments into
9543 a desktop calendar program like iCal, Org mode can also produce extracts in
9544 the iCalendar format. Currently Org mode only supports export, not import of
9545 these different formats.
9547 Org supports export of selected regions when @code{transient-mark-mode} is
9548 enabled (default in Emacs 23).
9551 * Selective export:: Using tags to select and exclude trees
9552 * Export options:: Per-file export settings
9553 * The export dispatcher:: How to access exporter commands
9554 * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
9555 * HTML export:: Exporting to HTML
9556 * LaTeX and PDF export:: Exporting to @LaTeX{}, and processing to PDF
9557 * DocBook export:: Exporting to DocBook
9558 * OpenDocument Text export:: Exporting to OpenDocument Text
9559 * TaskJuggler export:: Exporting to TaskJuggler
9560 * Freemind export:: Exporting to Freemind mind maps
9561 * XOXO export:: Exporting to XOXO
9562 * iCalendar export:: Exporting in iCalendar format
9565 @node Selective export, Export options, Exporting, Exporting
9566 @section Selective export
9567 @cindex export, selective by tags or TODO keyword
9569 @vindex org-export-select-tags
9570 @vindex org-export-exclude-tags
9571 @cindex org-export-with-tasks
9572 You may use tags to select the parts of a document that should be exported,
9573 or to exclude parts from export. This behavior is governed by two variables:
9574 @code{org-export-select-tags} and @code{org-export-exclude-tags},
9575 respectively defaulting to @code{'(:export:)} and @code{'(:noexport:)}.
9579 Org first checks if any of the @emph{select} tags is present in the
9580 buffer. If yes, all trees that do not carry one of these tags will be
9581 excluded. If a selected tree is a subtree, the heading hierarchy above it
9582 will also be selected for export, but not the text below those headings.
9585 If none of the select tags is found, the whole buffer will be selected for
9589 Finally, all subtrees that are marked by any of the @emph{exclude} tags will
9590 be removed from the export buffer.
9593 The variable @code{org-export-with-tasks} can be configured to select which
9594 kind of tasks should be included for export. See the docstring of the
9595 variable for more information.
9597 @node Export options, The export dispatcher, Selective export, Exporting
9598 @section Export options
9599 @cindex options, for export
9601 @cindex completion, of option keywords
9602 The exporter recognizes special lines in the buffer which provide
9603 additional information. These lines may be put anywhere in the file.
9604 The whole set of lines can be inserted into the buffer with @kbd{C-c
9605 C-e t}. For individual lines, a good way to make sure the keyword is
9606 correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion
9607 (@pxref{Completion}). For a summary of other in-buffer settings not
9608 specifically related to export, see @ref{In-buffer settings}.
9609 In particular, note that you can place commonly-used (export) options in
9610 a separate file which can be included using @code{#+SETUPFILE}.
9613 @orgcmd{C-c C-e t,org-insert-export-options-template}
9614 Insert template with export options, see example below.
9621 @cindex #+DESCRIPTION
9629 @cindex #+EXPORT_SELECT_TAGS
9630 @cindex #+EXPORT_EXCLUDE_TAGS
9632 @cindex #+LATEX_HEADER
9633 @vindex user-full-name
9634 @vindex user-mail-address
9635 @vindex org-export-default-language
9637 #+TITLE: the title to be shown (default is the buffer name)
9638 #+AUTHOR: the author (default taken from @code{user-full-name})
9639 #+DATE: a date, fixed, or a format string for @code{format-time-string}
9640 #+EMAIL: his/her email address (default from @code{user-mail-address})
9641 #+DESCRIPTION: the page description, e.g.@: for the XHTML meta tag
9642 #+KEYWORDS: the page keywords, e.g.@: for the XHTML meta tag
9643 #+LANGUAGE: language for HTML, e.g.@: @samp{en} (@code{org-export-default-language})
9644 #+TEXT: Some descriptive text to be inserted at the beginning.
9645 #+TEXT: Several lines may be given.
9646 #+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ...
9647 #+BIND: lisp-var lisp-val, e.g.@:: org-export-latex-low-levels itemize
9648 @r{You need to confirm using these, or configure @code{org-export-allow-BIND}}
9649 #+LINK_UP: the ``up'' link of an exported page
9650 #+LINK_HOME: the ``home'' link of an exported page
9651 #+LATEX_HEADER: extra line(s) for the LaTeX header, like \usepackage@{xyz@}
9652 #+EXPORT_SELECT_TAGS: Tags that select a tree for export
9653 #+EXPORT_EXCLUDE_TAGS: Tags that exclude a tree from export
9654 #+XSLT: the XSLT stylesheet used by DocBook exporter to generate FO file
9658 The OPTIONS line is a compact@footnote{If you want to configure many options
9659 this way, you can use several OPTIONS lines.} form to specify export
9660 settings. Here you can:
9661 @cindex headline levels
9662 @cindex section-numbers
9663 @cindex table of contents
9664 @cindex line-break preservation
9665 @cindex quoted HTML tags
9666 @cindex fixed-width sections
9668 @cindex @TeX{}-like syntax for sub- and superscripts
9670 @cindex special strings
9671 @cindex emphasized text
9672 @cindex @TeX{} macros
9673 @cindex @LaTeX{} fragments
9674 @cindex author info, in export
9675 @cindex time info, in export
9676 @vindex org-export-plist-vars
9677 @vindex org-export-author-info
9678 @vindex org-export-creator-info
9679 @vindex org-export-email-info
9680 @vindex org-export-time-stamp-file
9682 H: @r{set the number of headline levels for export}
9683 num: @r{turn on/off section-numbers}
9684 toc: @r{turn on/off table of contents, or set level limit (integer)}
9685 \n: @r{turn on/off line-break-preservation (DOES NOT WORK)}
9686 @@: @r{turn on/off quoted HTML tags}
9687 :: @r{turn on/off fixed-width sections}
9688 |: @r{turn on/off tables}
9689 ^: @r{turn on/off @TeX{}-like syntax for sub- and superscripts. If}
9690 @r{you write "^:@{@}", @code{a_@{b@}} will be interpreted, but}
9691 @r{the simple @code{a_b} will be left as it is.}
9692 -: @r{turn on/off conversion of special strings.}
9693 f: @r{turn on/off footnotes like this[1].}
9694 todo: @r{turn on/off inclusion of TODO keywords into exported text}
9695 tasks: @r{turn on/off inclusion of tasks (TODO items), can be nil to remove}
9696 @r{all tasks, @code{todo} to remove DONE tasks, or list of kwds to keep}
9697 pri: @r{turn on/off priority cookies}
9698 tags: @r{turn on/off inclusion of tags, may also be @code{not-in-toc}}
9699 <: @r{turn on/off inclusion of any time/date stamps like DEADLINES}
9700 *: @r{turn on/off emphasized text (bold, italic, underlined)}
9701 TeX: @r{turn on/off simple @TeX{} macros in plain text}
9702 LaTeX: @r{configure export of @LaTeX{} fragments. Default @code{auto}}
9703 skip: @r{turn on/off skipping the text before the first heading}
9704 author: @r{turn on/off inclusion of author name/email into exported file}
9705 email: @r{turn on/off inclusion of author email into exported file}
9706 creator: @r{turn on/off inclusion of creator info into exported file}
9707 timestamp: @r{turn on/off inclusion creation time into exported file}
9708 d: @r{turn on/off inclusion of drawers}
9711 These options take effect in both the HTML and @LaTeX{} export, except for
9712 @code{TeX} and @code{LaTeX} options, which are respectively @code{t} and
9713 @code{nil} for the @LaTeX{} export.
9715 The default values for these and many other options are given by a set of
9716 variables. For a list of such variables, the corresponding OPTIONS keys and
9717 also the publishing keys (@pxref{Project alist}), see the constant
9718 @code{org-export-plist-vars}.
9720 When exporting only a single subtree by selecting it with @kbd{C-c @@} before
9721 calling an export command, the subtree can overrule some of the file's export
9722 settings with properties @code{EXPORT_FILE_NAME}, @code{EXPORT_TITLE},
9723 @code{EXPORT_TEXT}, @code{EXPORT_AUTHOR}, @code{EXPORT_DATE}, and
9724 @code{EXPORT_OPTIONS}.
9726 @node The export dispatcher, ASCII/Latin-1/UTF-8 export, Export options, Exporting
9727 @section The export dispatcher
9728 @cindex dispatcher, for export commands
9730 All export commands can be reached using the export dispatcher, which is a
9731 prefix key that prompts for an additional key specifying the command.
9732 Normally the entire file is exported, but if there is an active region that
9733 contains one outline tree, the first heading is used as document title and
9734 the subtrees are exported.
9737 @orgcmd{C-c C-e,org-export}
9738 @vindex org-export-run-in-background
9739 Dispatcher for export and publishing commands. Displays a help-window
9740 listing the additional key(s) needed to launch an export or publishing
9741 command. The prefix arg is passed through to the exporter. A double prefix
9742 @kbd{C-u C-u} causes most commands to be executed in the background, in a
9743 separate Emacs process@footnote{To make this behavior the default, customize
9744 the variable @code{org-export-run-in-background}.}.
9745 @orgcmd{C-c C-e v,org-export-visible}
9746 Like @kbd{C-c C-e}, but only export the text that is currently visible
9747 (i.e.@: not hidden by outline visibility).
9748 @orgcmd{C-u C-u C-c C-e,org-export}
9749 @vindex org-export-run-in-background
9750 Call the exporter, but reverse the setting of
9751 @code{org-export-run-in-background}, i.e.@: request background processing if
9752 not set, or force processing in the current Emacs process if set.
9755 @node ASCII/Latin-1/UTF-8 export, HTML export, The export dispatcher, Exporting
9756 @section ASCII/Latin-1/UTF-8 export
9757 @cindex ASCII export
9758 @cindex Latin-1 export
9759 @cindex UTF-8 export
9761 ASCII export produces a simple and very readable version of an Org mode
9762 file, containing only plain ASCII. Latin-1 and UTF-8 export augment the file
9763 with special characters and symbols available in these encodings.
9765 @cindex region, active
9766 @cindex active region
9767 @cindex transient-mark-mode
9769 @orgcmd{C-c C-e a,org-export-as-ascii}
9770 @cindex property, EXPORT_FILE_NAME
9771 Export as ASCII file. For an Org file, @file{myfile.org}, the ASCII file
9772 will be @file{myfile.txt}. The file will be overwritten without
9773 warning. If there is an active region@footnote{This requires
9774 @code{transient-mark-mode} be turned on.}, only the region will be
9775 exported. If the selected region is a single tree@footnote{To select the
9776 current subtree, use @kbd{C-c @@}.}, the tree head will
9777 become the document title. If the tree head entry has or inherits an
9778 @code{EXPORT_FILE_NAME} property, that name will be used for the
9780 @orgcmd{C-c C-e A,org-export-as-ascii-to-buffer}
9781 Export to a temporary buffer. Do not create a file.
9782 @orgcmd{C-c C-e n,org-export-as-latin1}
9783 @xorgcmd{C-c C-e N,org-export-as-latin1-to-buffer}
9784 Like the above commands, but use Latin-1 encoding.
9785 @orgcmd{C-c C-e u,org-export-as-utf8}
9786 @xorgcmd{C-c C-e U,org-export-as-utf8-to-buffer}
9787 Like the above commands, but use UTF-8 encoding.
9788 @item C-c C-e v a/n/u
9789 Export only the visible part of the document.
9792 @cindex headline levels, for exporting
9793 In the exported version, the first 3 outline levels will become
9794 headlines, defining a general document structure. Additional levels
9795 will be exported as itemized lists. If you want that transition to occur
9796 at a different level, specify it with a prefix argument. For example,
9803 creates only top level headlines and does the rest as items. When
9804 headlines are converted to items, the indentation of the text following
9805 the headline is changed to fit nicely under the item. This is done with
9806 the assumption that the first body line indicates the base indentation of
9807 the body text. Any indentation larger than this is adjusted to preserve
9808 the layout relative to the first line. Should there be lines with less
9809 indentation than the first, these are left alone.
9811 @vindex org-export-ascii-links-to-notes
9812 Links will be exported in a footnote-like style, with the descriptive part in
9813 the text and the link in a note before the next heading. See the variable
9814 @code{org-export-ascii-links-to-notes} for details and other options.
9816 @node HTML export, LaTeX and PDF export, ASCII/Latin-1/UTF-8 export, Exporting
9817 @section HTML export
9820 Org mode contains an HTML (XHTML 1.0 strict) exporter with extensive
9821 HTML formatting, in ways similar to John Gruber's @emph{markdown}
9822 language, but with additional support for tables.
9825 * HTML Export commands:: How to invoke HTML export
9826 * HTML preamble and postamble:: How to insert a preamble and a postamble
9827 * Quoting HTML tags:: Using direct HTML in Org mode
9828 * Links in HTML export:: How links will be interpreted and formatted
9829 * Tables in HTML export:: How to modify the formatting of tables
9830 * Images in HTML export:: How to insert figures into HTML output
9831 * Math formatting in HTML export:: Beautiful math also on the web
9832 * Text areas in HTML export:: An alternative way to show an example
9833 * CSS support:: Changing the appearance of the output
9834 * JavaScript support:: Info and Folding in a web browser
9837 @node HTML Export commands, HTML preamble and postamble, HTML export, HTML export
9838 @subsection HTML export commands
9840 @cindex region, active
9841 @cindex active region
9842 @cindex transient-mark-mode
9844 @orgcmd{C-c C-e h,org-export-as-html}
9845 @cindex property, EXPORT_FILE_NAME
9846 Export as HTML file. For an Org file @file{myfile.org},
9847 the HTML file will be @file{myfile.html}. The file will be overwritten
9848 without warning. If there is an active region@footnote{This requires
9849 @code{transient-mark-mode} be turned on.}, only the region will be
9850 exported. If the selected region is a single tree@footnote{To select the
9851 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
9852 title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
9853 property, that name will be used for the export.
9854 @orgcmd{C-c C-e b,org-export-as-html-and-open}
9855 Export as HTML file and immediately open it with a browser.
9856 @orgcmd{C-c C-e H,org-export-as-html-to-buffer}
9857 Export to a temporary buffer. Do not create a file.
9858 @orgcmd{C-c C-e R,org-export-region-as-html}
9859 Export the active region to a temporary buffer. With a prefix argument, do
9860 not produce the file header and footer, but just the plain HTML section for
9861 the region. This is good for cut-and-paste operations.
9862 @item C-c C-e v h/b/H/R
9863 Export only the visible part of the document.
9864 @item M-x org-export-region-as-html
9865 Convert the region to HTML under the assumption that it was Org mode
9866 syntax before. This is a global command that can be invoked in any
9868 @item M-x org-replace-region-by-HTML
9869 Replace the active region (assumed to be in Org mode syntax) by HTML
9873 @cindex headline levels, for exporting
9874 In the exported version, the first 3 outline levels will become headlines,
9875 defining a general document structure. Additional levels will be exported as
9876 itemized lists. If you want that transition to occur at a different level,
9877 specify it with a numeric prefix argument. For example,
9884 creates two levels of headings and does the rest as items.
9887 @node HTML preamble and postamble, Quoting HTML tags, HTML Export commands, HTML export
9888 @subsection HTML preamble and postamble
9889 @vindex org-export-html-preamble
9890 @vindex org-export-html-postamble
9891 @vindex org-export-html-preamble-format
9892 @vindex org-export-html-postamble-format
9893 @vindex org-export-html-validation-link
9894 @vindex org-export-author-info
9895 @vindex org-export-email-info
9896 @vindex org-export-creator-info
9897 @vindex org-export-time-stamp-file
9899 The HTML exporter lets you define a preamble and a postamble.
9901 The default value for @code{org-export-html-preamble} is @code{t}, which
9902 means that the preamble is inserted depending on the relevant formatting
9903 string in @code{org-export-html-preamble-format}.
9905 Setting @code{org-export-html-preamble} to a string will override the default
9906 formatting string. Setting it to a function, will insert the output of the
9907 function, which must be a string; such a function takes no argument but you
9908 can check against the value of @code{opt-plist}, which contains the list of
9909 publishing properties for the current file. Setting to @code{nil} will not
9910 insert any preamble.
9912 The default value for @code{org-export-html-postamble} is @code{'auto}, which
9913 means that the HTML exporter will look for the value of
9914 @code{org-export-author-info}, @code{org-export-email-info},
9915 @code{org-export-creator-info} and @code{org-export-time-stamp-file},
9916 @code{org-export-html-validation-link} and build the postamble from these
9917 values. Setting @code{org-export-html-postamble} to @code{t} will insert the
9918 postamble from the relevant formatting string found in
9919 @code{org-export-html-postamble-format}. Setting it to @code{nil} will not
9920 insert any postamble.
9922 @node Quoting HTML tags, Links in HTML export, HTML preamble and postamble, HTML export
9923 @subsection Quoting HTML tags
9925 Plain @samp{<} and @samp{>} are always transformed to @samp{<} and
9926 @samp{>} in HTML export. If you want to include simple HTML tags
9927 which should be interpreted as such, mark them with @samp{@@} as in
9928 @samp{@@<b>bold text@@</b>}. Note that this really works only for
9929 simple tags. For more extensive HTML that should be copied verbatim to
9930 the exported file use either
9933 @cindex #+BEGIN_HTML
9935 #+HTML: Literal HTML code for export
9939 @cindex #+BEGIN_HTML
9943 All lines between these markers are exported literally
9948 @node Links in HTML export, Tables in HTML export, Quoting HTML tags, HTML export
9949 @subsection Links in HTML export
9951 @cindex links, in HTML export
9952 @cindex internal links, in HTML export
9953 @cindex external links, in HTML export
9954 Internal links (@pxref{Internal links}) will continue to work in HTML. This
9955 includes automatic links created by radio targets (@pxref{Radio
9956 targets}). Links to external files will still work if the target file is on
9957 the same @i{relative} path as the published Org file. Links to other
9958 @file{.org} files will be translated into HTML links under the assumption
9959 that an HTML version also exists of the linked file, at the same relative
9960 path. @samp{id:} links can then be used to jump to specific entries across
9961 files. For information related to linking files while publishing them to a
9962 publishing directory see @ref{Publishing links}.
9964 If you want to specify attributes for links, you can do so using a special
9965 @code{#+ATTR_HTML} line to define attributes that will be added to the
9966 @code{<a>} or @code{<img>} tags. Here is an example that sets @code{title}
9967 and @code{style} attributes for a link:
9971 #+ATTR_HTML: title="The Org mode homepage" style="color:red;"
9972 [[http://orgmode.org]]
9975 @node Tables in HTML export, Images in HTML export, Links in HTML export, HTML export
9977 @cindex tables, in HTML
9978 @vindex org-export-html-table-tag
9980 Org mode tables are exported to HTML using the table tag defined in
9981 @code{org-export-html-table-tag}. The default setting makes tables without
9982 cell borders and frame. If you would like to change this for individual
9983 tables, place something like the following before the table:
9988 #+CAPTION: This is a table with lines around and between cells
9989 #+ATTR_HTML: border="2" rules="all" frame="border"
9992 @node Images in HTML export, Math formatting in HTML export, Tables in HTML export, HTML export
9993 @subsection Images in HTML export
9995 @cindex images, inline in HTML
9996 @cindex inlining images in HTML
9997 @vindex org-export-html-inline-images
9998 HTML export can inline images given as links in the Org file, and
9999 it can make an image the clickable part of a link. By
10000 default@footnote{But see the variable
10001 @code{org-export-html-inline-images}.}, images are inlined if a link does
10002 not have a description. So @samp{[[file:myimg.jpg]]} will be inlined,
10003 while @samp{[[file:myimg.jpg][the image]]} will just produce a link
10004 @samp{the image} that points to the image. If the description part
10005 itself is a @code{file:} link or a @code{http:} URL pointing to an
10006 image, this image will be inlined and activated so that clicking on the
10007 image will activate the link. For example, to include a thumbnail that
10008 will link to a high resolution version of the image, you could use:
10011 [[file:highres.jpg][file:thumb.jpg]]
10014 If you need to add attributes to an inlined image, use a @code{#+ATTR_HTML}.
10015 In the example below we specify the @code{alt} and @code{title} attributes to
10016 support text viewers and accessibility, and align it to the right.
10019 @cindex #+ATTR_HTML
10021 #+CAPTION: A black cat stalking a spider
10022 #+ATTR_HTML: alt="cat/spider image" title="Action!" align="right"
10027 You could use @code{http} addresses just as well.
10029 @node Math formatting in HTML export, Text areas in HTML export, Images in HTML export, HTML export
10030 @subsection Math formatting in HTML export
10034 @LaTeX{} math snippets (@pxref{LaTeX fragments}) can be displayed in two
10035 different ways on HTML pages. The default is to use the
10036 @uref{http://www.mathjax.org, MathJax system} which should work out of the
10037 box with Org mode installation because @code{http://orgmode.org} serves
10038 @file{MathJax} for Org mode users for small applications and for testing
10039 purposes. @b{If you plan to use this regularly or on pages with significant
10040 page views, you should install@footnote{Installation instructions can be
10041 found on the MathJax website, see
10042 @uref{http://www.mathjax.org/resources/docs/?installation.html}.} MathJax on
10043 your own server in order to limit the load of our server.} To configure
10044 @file{MathJax}, use the variable @code{org-export-html-mathjax-options} or
10045 insert something like the following into the buffer:
10048 #+MATHJAX: align:"left" mathml:t path:"/MathJax/MathJax.js"
10051 @noindent See the docstring of the variable
10052 @code{org-export-html-mathjax-options} for the meaning of the parameters in
10055 If you prefer, you can also request that @LaTeX{} fragments are processed
10056 into small images that will be inserted into the browser page. Before the
10057 availability of MathJax, this was the default method for Org files. This
10058 method requires that the @file{dvipng} program is available on your system.
10059 You can still get this processing with
10062 #+OPTIONS: LaTeX:dvipng
10065 @node Text areas in HTML export, CSS support, Math formatting in HTML export, HTML export
10066 @subsection Text areas in HTML export
10068 @cindex text areas, in HTML
10069 An alternative way to publish literal code examples in HTML is to use text
10070 areas, where the example can even be edited before pasting it into an
10071 application. It is triggered by a @code{-t} switch at an @code{example} or
10072 @code{src} block. Using this switch disables any options for syntax and
10073 label highlighting, and line numbering, which may be present. You may also
10074 use @code{-h} and @code{-w} switches to specify the height and width of the
10075 text area, which default to the number of lines in the example, and 80,
10076 respectively. For example
10079 #+BEGIN_EXAMPLE -t -w 40
10080 (defun org-xor (a b)
10087 @node CSS support, JavaScript support, Text areas in HTML export, HTML export
10088 @subsection CSS support
10089 @cindex CSS, for HTML export
10090 @cindex HTML export, CSS
10092 @vindex org-export-html-todo-kwd-class-prefix
10093 @vindex org-export-html-tag-class-prefix
10094 You can also give style information for the exported file. The HTML exporter
10095 assigns the following special CSS classes@footnote{If the classes on TODO
10096 keywords and tags lead to conflicts, use the variables
10097 @code{org-export-html-todo-kwd-class-prefix} and
10098 @code{org-export-html-tag-class-prefix} to make them unique.} to appropriate
10099 parts of the document---your style specifications may change these, in
10100 addition to any of the standard classes like for headlines, tables, etc.
10102 p.author @r{author information, including email}
10103 p.date @r{publishing date}
10104 p.creator @r{creator info, about org mode version}
10105 .title @r{document title}
10106 .todo @r{TODO keywords, all not-done states}
10107 .done @r{the DONE keywords, all states that count as done}
10108 .WAITING @r{each TODO keyword also uses a class named after itself}
10109 .timestamp @r{timestamp}
10110 .timestamp-kwd @r{keyword associated with a timestamp, like SCHEDULED}
10111 .timestamp-wrapper @r{span around keyword plus timestamp}
10112 .tag @r{tag in a headline}
10113 ._HOME @r{each tag uses itself as a class, "@@" replaced by "_"}
10114 .target @r{target for links}
10115 .linenr @r{the line number in a code example}
10116 .code-highlighted @r{for highlighting referenced code lines}
10117 div.outline-N @r{div for outline level N (headline plus text))}
10118 div.outline-text-N @r{extra div for text at outline level N}
10119 .section-number-N @r{section number in headlines, different for each level}
10120 div.figure @r{how to format an inlined image}
10121 pre.src @r{formatted source code}
10122 pre.example @r{normal example}
10123 p.verse @r{verse paragraph}
10124 div.footnotes @r{footnote section headline}
10125 p.footnote @r{footnote definition paragraph, containing a footnote}
10126 .footref @r{a footnote reference number (always a <sup>)}
10127 .footnum @r{footnote number in footnote definition (always <sup>)}
10130 @vindex org-export-html-style-default
10131 @vindex org-export-html-style-include-default
10132 @vindex org-export-html-style
10133 @vindex org-export-html-extra
10134 @vindex org-export-html-style-default
10135 Each exported file contains a compact default style that defines these
10136 classes in a basic way@footnote{This style is defined in the constant
10137 @code{org-export-html-style-default}, which you should not modify. To turn
10138 inclusion of these defaults off, customize
10139 @code{org-export-html-style-include-default}}. You may overwrite these
10140 settings, or add to them by using the variables @code{org-export-html-style}
10141 (for Org-wide settings) and @code{org-export-html-style-extra} (for more
10142 fine-grained settings, like file-local settings). To set the latter variable
10143 individually for each file, you can use
10147 #+STYLE: <link rel="stylesheet" type="text/css" href="stylesheet.css" />
10151 For longer style definitions, you can use several such lines. You could also
10152 directly write a @code{<style>} @code{</style>} section in this way, without
10153 referring to an external file.
10155 In order to add styles to a subtree, use the @code{:HTML_CONTAINER_CLASS:}
10156 property to assign a class to the tree. In order to specify CSS styles for a
10157 particular headline, you can use the id specified in a @code{:CUSTOM_ID:}
10160 @c FIXME: More about header and footer styles
10161 @c FIXME: Talk about links and targets.
10163 @node JavaScript support, , CSS support, HTML export
10164 @subsection JavaScript supported display of web pages
10166 @cindex Rose, Sebastian
10167 Sebastian Rose has written a JavaScript program especially designed to
10168 enhance the web viewing experience of HTML files created with Org. This
10169 program allows you to view large files in two different ways. The first one
10170 is an @emph{Info}-like mode where each section is displayed separately and
10171 navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
10172 as well, press @kbd{?} for an overview of the available keys). The second
10173 view type is a @emph{folding} view much like Org provides inside Emacs. The
10174 script is available at @url{http://orgmode.org/org-info.js} and you can find
10175 the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
10176 We host the script at our site, but if you use it a lot, you might
10177 not want to be dependent on @url{orgmode.org} and prefer to install a local
10178 copy on your own web server.
10180 To use the script, you need to make sure that the @file{org-jsinfo.el} module
10181 gets loaded. It should be loaded by default, but you can try @kbd{M-x
10182 customize-variable @key{RET} org-modules @key{RET}} to convince yourself that
10183 this is indeed the case. All it then takes to make use of the program is
10184 adding a single line to the Org file:
10186 @cindex #+INFOJS_OPT
10188 #+INFOJS_OPT: view:info toc:nil
10192 If this line is found, the HTML header will automatically contain the code
10193 needed to invoke the script. Using the line above, you can set the following
10197 path: @r{The path to the script. The default is to grab the script from}
10198 @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
10199 @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
10200 view: @r{Initial view when website is first shown. Possible values are:}
10201 info @r{Info-like interface with one section per page.}
10202 overview @r{Folding interface, initially showing only top-level.}
10203 content @r{Folding interface, starting with all headlines visible.}
10204 showall @r{Folding interface, all headlines and text visible.}
10205 sdepth: @r{Maximum headline level that will still become an independent}
10206 @r{section for info and folding modes. The default is taken from}
10207 @r{@code{org-export-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
10208 @r{If this is smaller than in @code{org-export-headline-levels}, each}
10209 @r{info/folding section can still contain child headlines.}
10210 toc: @r{Should the table of contents @emph{initially} be visible?}
10211 @r{Even when @code{nil}, you can always get to the "toc" with @kbd{i}.}
10212 tdepth: @r{The depth of the table of contents. The defaults are taken from}
10213 @r{the variables @code{org-export-headline-levels} and @code{org-export-with-toc}.}
10214 ftoc: @r{Does the CSS of the page specify a fixed position for the "toc"?}
10215 @r{If yes, the toc will never be displayed as a section.}
10216 ltoc: @r{Should there be short contents (children) in each section?}
10217 @r{Make this @code{above} if the section should be above initial text.}
10218 mouse: @r{Headings are highlighted when the mouse is over them. Should be}
10219 @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
10220 buttons: @r{Should view-toggle buttons be everywhere? When @code{nil} (the}
10221 @r{default), only one such button will be present.}
10224 @vindex org-infojs-options
10225 @vindex org-export-html-use-infojs
10226 You can choose default values for these options by customizing the variable
10227 @code{org-infojs-options}. If you always want to apply the script to your
10228 pages, configure the variable @code{org-export-html-use-infojs}.
10230 @node LaTeX and PDF export, DocBook export, HTML export, Exporting
10231 @section @LaTeX{} and PDF export
10232 @cindex @LaTeX{} export
10234 @cindex Guerry, Bastien
10236 Org mode contains a @LaTeX{} exporter written by Bastien Guerry. With
10237 further processing@footnote{The default LaTeX output is designed for
10238 processing with pdftex or latex. It includes packages that are not
10239 compatible with xetex and possibly luatex. See the variables
10240 @code{org-export-latex-default-packages-alist} and
10241 @code{org-export-latex-packages-alist}.}, this backend is also used to
10242 produce PDF output. Since the @LaTeX{} output uses @file{hyperref} to
10243 implement links and cross references, the PDF output file will be fully
10244 linked. Beware of the fact that your @code{org} file has to be properly
10245 structured in order to be correctly exported: respect the hierarchy of
10249 * LaTeX/PDF export commands:: Which key invokes which commands
10250 * Header and sectioning:: Setting up the export file structure
10251 * Quoting LaTeX code:: Incorporating literal @LaTeX{} code
10252 * Tables in LaTeX export:: Options for exporting tables to @LaTeX{}
10253 * Images in LaTeX export:: How to insert figures into @LaTeX{} output
10254 * Beamer class export:: Turning the file into a presentation
10257 @node LaTeX/PDF export commands, Header and sectioning, LaTeX and PDF export, LaTeX and PDF export
10258 @subsection @LaTeX{} export commands
10260 @cindex region, active
10261 @cindex active region
10262 @cindex transient-mark-mode
10264 @orgcmd{C-c C-e l,org-export-as-latex}
10265 @cindex property EXPORT_FILE_NAME
10266 Export as @LaTeX{} file. For an Org file
10267 @file{myfile.org}, the @LaTeX{} file will be @file{myfile.tex}. The file will
10268 be overwritten without warning. If there is an active region@footnote{This
10269 requires @code{transient-mark-mode} be turned on.}, only the region will be
10270 exported. If the selected region is a single tree@footnote{To select the
10271 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
10272 title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME}
10273 property, that name will be used for the export.
10274 @orgcmd{C-c C-e L,org-export-as-latex-to-buffer}
10275 Export to a temporary buffer. Do not create a file.
10276 @item C-c C-e v l/L
10277 Export only the visible part of the document.
10278 @item M-x org-export-region-as-latex
10279 Convert the region to @LaTeX{} under the assumption that it was Org mode
10280 syntax before. This is a global command that can be invoked in any
10282 @item M-x org-replace-region-by-latex
10283 Replace the active region (assumed to be in Org mode syntax) by @LaTeX{}
10285 @orgcmd{C-c C-e p,org-export-as-pdf}
10286 Export as @LaTeX{} and then process to PDF.
10287 @orgcmd{C-c C-e d,org-export-as-pdf-and-open}
10288 Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
10291 @cindex headline levels, for exporting
10292 @vindex org-latex-low-levels
10293 In the exported version, the first 3 outline levels will become
10294 headlines, defining a general document structure. Additional levels
10295 will be exported as description lists. The exporter can ignore them or
10296 convert them to a custom string depending on
10297 @code{org-latex-low-levels}.
10299 If you want that transition to occur at a different level, specify it
10300 with a numeric prefix argument. For example,
10303 @kbd{C-2 C-c C-e l}
10307 creates two levels of headings and does the rest as items.
10309 @node Header and sectioning, Quoting LaTeX code, LaTeX/PDF export commands, LaTeX and PDF export
10310 @subsection Header and sectioning structure
10311 @cindex @LaTeX{} class
10312 @cindex @LaTeX{} sectioning structure
10313 @cindex @LaTeX{} header
10314 @cindex header, for LaTeX files
10315 @cindex sectioning structure, for LaTeX export
10317 By default, the @LaTeX{} output uses the class @code{article}.
10319 @vindex org-export-latex-default-class
10320 @vindex org-export-latex-classes
10321 @vindex org-export-latex-default-packages-alist
10322 @vindex org-export-latex-packages-alist
10323 @cindex #+LATEX_HEADER
10324 @cindex #+LATEX_CLASS
10325 @cindex #+LATEX_CLASS_OPTIONS
10326 @cindex property, LATEX_CLASS
10327 @cindex property, LATEX_CLASS_OPTIONS
10328 You can change this globally by setting a different value for
10329 @code{org-export-latex-default-class} or locally by adding an option like
10330 @code{#+LaTeX_CLASS: myclass} in your file, or with a @code{:LaTeX_CLASS:}
10331 property that applies when exporting a region containing only this (sub)tree.
10332 The class must be listed in @code{org-export-latex-classes}. This variable
10333 defines a header template for each class@footnote{Into which the values of
10334 @code{org-export-latex-default-packages-alist} and
10335 @code{org-export-latex-packages-alist} are spliced.}, and allows you to
10336 define the sectioning structure for each class. You can also define your own
10337 classes there. @code{#+LaTeX_CLASS_OPTIONS} or a @code{LaTeX_CLASS_OPTIONS}
10338 property can specify the options for the @code{\documentclass} macro. You
10339 can also use @code{#+LATEX_HEADER: \usepackage@{xyz@}} to add lines to the
10340 header. See the docstring of @code{org-export-latex-classes} for more
10343 @node Quoting LaTeX code, Tables in LaTeX export, Header and sectioning, LaTeX and PDF export
10344 @subsection Quoting @LaTeX{} code
10346 Embedded @LaTeX{} as described in @ref{Embedded LaTeX}, will be correctly
10347 inserted into the @LaTeX{} file. This includes simple macros like
10348 @samp{\ref@{LABEL@}} to create a cross reference to a figure. Furthermore,
10349 you can add special code that should only be present in @LaTeX{} export with
10350 the following constructs:
10353 @cindex #+BEGIN_LaTeX
10355 #+LaTeX: Literal LaTeX code for export
10359 @cindex #+BEGIN_LaTeX
10363 All lines between these markers are exported literally
10368 @node Tables in LaTeX export, Images in LaTeX export, Quoting LaTeX code, LaTeX and PDF export
10369 @subsection Tables in @LaTeX{} export
10370 @cindex tables, in @LaTeX{} export
10372 For @LaTeX{} export of a table, you can specify a label, a caption and
10373 placement options (@pxref{Images and tables}). You can also use the
10374 @code{ATTR_LaTeX} line to request a @code{longtable} environment for the
10375 table, so that it may span several pages, or to change the default table
10376 environment from @code{table} to @code{table*} or to change the default inner
10377 tabular environment to @code{tabularx} or @code{tabulary}. Finally, you can
10378 set the alignment string, and (with @code{tabularx} or @code{tabulary}) the
10383 @cindex #+ATTR_LaTeX
10385 #+CAPTION: A long table
10387 #+ATTR_LaTeX: longtable align=l|lp@{3cm@}r|l
10392 or to specify a multicolumn table with @code{tabulary}
10396 @cindex #+ATTR_LaTeX
10398 #+CAPTION: A wide table with tabulary
10400 #+ATTR_LaTeX: table* tabulary width=\textwidth
10405 @node Images in LaTeX export, Beamer class export, Tables in LaTeX export, LaTeX and PDF export
10406 @subsection Images in @LaTeX{} export
10407 @cindex images, inline in @LaTeX{}
10408 @cindex inlining images in @LaTeX{}
10410 Images that are linked to without a description part in the link, like
10411 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
10412 output file resulting from @LaTeX{} processing. Org will use an
10413 @code{\includegraphics} macro to insert the image. If you have specified a
10414 caption and/or a label as described in @ref{Images and tables}, the figure
10415 will be wrapped into a @code{figure} environment and thus become a floating
10416 element. You can use an @code{#+ATTR_LaTeX:} line to specify various other
10417 options. You can ask org to export an image as a float without specifying
10418 a label or a caption by using the keyword @code{float} in this line. Various
10419 optional arguments to the @code{\includegraphics} macro can also be specified
10420 in this fashion. To modify the placement option of the floating environment,
10421 add something like @samp{placement=[h!]} to the attributes. It is to be noted
10422 this option can be used with tables as well@footnote{One can also take
10423 advantage of this option to pass other, unrelated options into the figure or
10424 table environment. For an example see the section ``Exporting org files'' in
10425 @url{http://orgmode.org/worg/org-hacks.html}}. For example the
10426 @code{#+ATTR_LaTeX:} line below is exported as the @code{figure} environment
10429 If you would like to let text flow around the image, add the word @samp{wrap}
10430 to the @code{#+ATTR_LaTeX:} line, which will make the figure occupy the left
10431 half of the page. To fine-tune, the @code{placement} field will be the set
10432 of additional arguments needed by the @code{wrapfigure} environment. Note
10433 that if you change the size of the image, you need to use compatible settings
10434 for @code{\includegraphics} and @code{wrapfigure}.
10438 @cindex #+ATTR_LaTeX
10440 #+CAPTION: The black-body emission of the disk around HR 4049
10441 #+LABEL: fig:SED-HR4049
10442 #+ATTR_LaTeX: width=5cm,angle=90
10443 [[./img/sed-hr4049.pdf]]
10445 #+ATTR_LaTeX: width=0.38\textwidth wrap placement=@{r@}@{0.4\textwidth@}
10449 If you wish to include an image which spans multiple columns in a page, you
10450 can use the keyword @code{multicolumn} in the @code{#+ATTR_LaTeX} line. This
10451 will export the image wrapped in a @code{figure*} environment.
10453 If you need references to a label created in this way, write
10454 @samp{\ref@{fig:SED-HR4049@}} just like in @LaTeX{}.
10456 @node Beamer class export, , Images in LaTeX export, LaTeX and PDF export
10457 @subsection Beamer class export
10459 The LaTeX class @file{beamer} allows production of high quality presentations
10460 using LaTeX and pdf processing. Org mode has special support for turning an
10461 Org mode file or tree into a @file{beamer} presentation.
10463 When the LaTeX class for the current buffer (as set with @code{#+LaTeX_CLASS:
10464 beamer}) or subtree (set with a @code{LaTeX_CLASS} property) is
10465 @code{beamer}, a special export mode will turn the file or tree into a beamer
10466 presentation. Any tree with not-too-deep level nesting should in principle be
10467 exportable as a beamer presentation. By default, the top-level entries (or
10468 the first level below the selected subtree heading) will be turned into
10469 frames, and the outline structure below this level will become itemize lists.
10470 You can also configure the variable @code{org-beamer-frame-level} to a
10471 different level---then the hierarchy above frames will produce the sectioning
10472 structure of the presentation.
10474 A template for useful in-buffer settings or properties can be inserted into
10475 the buffer with @kbd{M-x org-insert-beamer-options-template}. Among other
10476 things, this will install a column view format which is very handy for
10477 editing special properties used by beamer.
10479 You can influence the structure of the presentation using the following
10484 The environment that should be used to format this entry. Valid environments
10485 are defined in the constant @code{org-beamer-environments-default}, and you
10486 can define more in @code{org-beamer-environments-extra}. If this property is
10487 set, the entry will also get a @code{:B_environment:} tag to make this
10488 visible. This tag has no semantic meaning, it is only a visual aid.
10489 @item BEAMER_envargs
10490 The beamer-special arguments that should be used for the environment, like
10491 @code{[t]} or @code{[<+->]} of @code{<2-3>}. If the @code{BEAMER_col}
10492 property is also set, something like @code{C[t]} can be added here as well to
10493 set an options argument for the implied @code{columns} environment.
10494 @code{c[t]} or @code{c<2->} will set an options for the implied @code{column}
10497 The width of a column that should start with this entry. If this property is
10498 set, the entry will also get a @code{:BMCOL:} property to make this visible.
10499 Also this tag is only a visual aid. When this is a plain number, it will be
10500 interpreted as a fraction of @code{\textwidth}. Otherwise it will be assumed
10501 that you have specified the units, like @samp{3cm}. The first such property
10502 in a frame will start a @code{columns} environment to surround the columns.
10503 This environment is closed when an entry has a @code{BEAMER_col} property
10504 with value 0 or 1, or automatically at the end of the frame.
10506 Additional commands that should be inserted after the environment has been
10507 opened. For example, when creating a frame, this can be used to specify
10511 Frames will automatically receive a @code{fragile} option if they contain
10512 source code that uses the verbatim environment. Special @file{beamer}
10513 specific code can be inserted using @code{#+BEAMER:} and
10514 @code{#+BEGIN_beamer...#+end_beamer} constructs, similar to other export
10515 backends, but with the difference that @code{#+LaTeX:} stuff will be included
10516 in the presentation as well.
10518 Outline nodes with @code{BEAMER_env} property value @samp{note} or
10519 @samp{noteNH} will be formatted as beamer notes, i,e, they will be wrapped
10520 into @code{\note@{...@}}. The former will include the heading as part of the
10521 note text, the latter will ignore the heading of that node. To simplify note
10522 generation, it is actually enough to mark the note with a @emph{tag} (either
10523 @code{:B_note:} or @code{:B_noteNH:}) instead of creating the
10524 @code{BEAMER_env} property.
10526 You can turn on a special minor mode @code{org-beamer-mode} for editing
10534 @orgcmd{C-c C-b,org-beamer-select-environment}
10535 In @code{org-beamer-mode}, this key offers fast selection of a beamer
10536 environment or the @code{BEAMER_col} property.
10539 Column view provides a great way to set the environment of a node and other
10540 important parameters. Make sure you are using a COLUMN format that is geared
10541 toward this special purpose. The command @kbd{M-x
10542 org-insert-beamer-options-template} defines such a format.
10544 Here is a simple example Org document that is intended for beamer export.
10547 #+LaTeX_CLASS: beamer
10548 #+TITLE: Example Presentation
10549 #+AUTHOR: Carsten Dominik
10550 #+LaTeX_CLASS_OPTIONS: [presentation]
10551 #+BEAMER_FRAME_LEVEL: 2
10552 #+BEAMER_HEADER_EXTRA: \usetheme@{Madrid@}\usecolortheme@{default@}
10553 #+COLUMNS: %35ITEM %10BEAMER_env(Env) %10BEAMER_envargs(Args) %4BEAMER_col(Col) %8BEAMER_extra(Ex)
10555 * This is the first structural section
10557 ** Frame 1 \\ with a subtitle
10558 *** Thanks to Eric Fraga :BMCOL:B_block:
10561 :BEAMER_envargs: C[t]
10564 for the first viable beamer setup in Org
10565 *** Thanks to everyone else :BMCOL:B_block:
10569 :BEAMER_envargs: <2->
10571 for contributing to the discussion
10572 **** This will be formatted as a beamer note :B_note:
10573 ** Frame 2 \\ where we will not use columns
10574 *** Request :B_block:
10575 Please test this stuff!
10581 For more information, see the documentation on Worg.
10583 @node DocBook export, OpenDocument Text export, LaTeX and PDF export, Exporting
10584 @section DocBook export
10585 @cindex DocBook export
10587 @cindex Cui, Baoqiu
10589 Org contains a DocBook exporter written by Baoqiu Cui. Once an Org file is
10590 exported to DocBook format, it can be further processed to produce other
10591 formats, including PDF, HTML, man pages, etc., using many available DocBook
10592 tools and stylesheets.
10594 Currently DocBook exporter only supports DocBook V5.0.
10597 * DocBook export commands:: How to invoke DocBook export
10598 * Quoting DocBook code:: Incorporating DocBook code in Org files
10599 * Recursive sections:: Recursive sections in DocBook
10600 * Tables in DocBook export:: Tables are exported as HTML tables
10601 * Images in DocBook export:: How to insert figures into DocBook output
10602 * Special characters:: How to handle special characters
10605 @node DocBook export commands, Quoting DocBook code, DocBook export, DocBook export
10606 @subsection DocBook export commands
10608 @cindex region, active
10609 @cindex active region
10610 @cindex transient-mark-mode
10612 @orgcmd{C-c C-e D,org-export-as-docbook}
10613 @cindex property EXPORT_FILE_NAME
10614 Export as DocBook file. For an Org file, @file{myfile.org}, the DocBook XML
10615 file will be @file{myfile.xml}. The file will be overwritten without
10616 warning. If there is an active region@footnote{This requires
10617 @code{transient-mark-mode} to be turned on}, only the region will be
10618 exported. If the selected region is a single tree@footnote{To select the
10619 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
10620 title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
10621 property, that name will be used for the export.
10622 @orgcmd{C-c C-e V,org-export-as-docbook-pdf-and-open}
10623 Export as DocBook file, process to PDF, then open the resulting PDF file.
10625 @vindex org-export-docbook-xslt-proc-command
10626 @vindex org-export-docbook-xsl-fo-proc-command
10627 Note that, in order to produce PDF output based on exported DocBook file, you
10628 need to have XSLT processor and XSL-FO processor software installed on your
10629 system. Check variables @code{org-export-docbook-xslt-proc-command} and
10630 @code{org-export-docbook-xsl-fo-proc-command}.
10632 @vindex org-export-docbook-xslt-stylesheet
10633 The stylesheet argument @code{%s} in variable
10634 @code{org-export-docbook-xslt-proc-command} is replaced by the value of
10635 variable @code{org-export-docbook-xslt-stylesheet}, which needs to be set by
10636 the user. You can also overrule this global setting on a per-file basis by
10637 adding an in-buffer setting @code{#+XSLT:} to the Org file.
10639 @orgkey{C-c C-e v D}
10640 Export only the visible part of the document.
10643 @node Quoting DocBook code, Recursive sections, DocBook export commands, DocBook export
10644 @subsection Quoting DocBook code
10646 You can quote DocBook code in Org files and copy it verbatim into exported
10647 DocBook file with the following constructs:
10650 @cindex #+BEGIN_DOCBOOK
10652 #+DOCBOOK: Literal DocBook code for export
10656 @cindex #+BEGIN_DOCBOOK
10660 All lines between these markers are exported by DocBook exporter
10665 For example, you can use the following lines to include a DocBook warning
10666 admonition. As to what this warning says, you should pay attention to the
10667 document context when quoting DocBook code in Org files. You may make
10668 exported DocBook XML files invalid by not quoting DocBook code correctly.
10673 <para>You should know what you are doing when quoting DocBook XML code
10674 in your Org file. Invalid DocBook XML may be generated by
10675 DocBook exporter if you are not careful!</para>
10680 @node Recursive sections, Tables in DocBook export, Quoting DocBook code, DocBook export
10681 @subsection Recursive sections
10682 @cindex DocBook recursive sections
10684 DocBook exporter exports Org files as articles using the @code{article}
10685 element in DocBook. Recursive sections, i.e.@: @code{section} elements, are
10686 used in exported articles. Top level headlines in Org files are exported as
10687 top level sections, and lower level headlines are exported as nested
10688 sections. The entire structure of Org files will be exported completely, no
10689 matter how many nested levels of headlines there are.
10691 Using recursive sections makes it easy to port and reuse exported DocBook
10692 code in other DocBook document types like @code{book} or @code{set}.
10694 @node Tables in DocBook export, Images in DocBook export, Recursive sections, DocBook export
10695 @subsection Tables in DocBook export
10696 @cindex tables, in DocBook export
10698 Tables in Org files are exported as HTML tables, which have been supported since
10701 If a table does not have a caption, an informal table is generated using the
10702 @code{informaltable} element; otherwise, a formal table will be generated
10703 using the @code{table} element.
10705 @node Images in DocBook export, Special characters, Tables in DocBook export, DocBook export
10706 @subsection Images in DocBook export
10707 @cindex images, inline in DocBook
10708 @cindex inlining images in DocBook
10710 Images that are linked to without a description part in the link, like
10711 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]}, will be exported to DocBook
10712 using @code{mediaobject} elements. Each @code{mediaobject} element contains
10713 an @code{imageobject} that wraps an @code{imagedata} element. If you have
10714 specified a caption for an image as described in @ref{Images and tables}, a
10715 @code{caption} element will be added in @code{mediaobject}. If a label is
10716 also specified, it will be exported as an @code{xml:id} attribute of the
10717 @code{mediaobject} element.
10719 @vindex org-export-docbook-default-image-attributes
10720 Image attributes supported by the @code{imagedata} element, like @code{align}
10721 or @code{width}, can be specified in two ways: you can either customize
10722 variable @code{org-export-docbook-default-image-attributes} or use the
10723 @code{#+ATTR_DOCBOOK:} line. Attributes specified in variable
10724 @code{org-export-docbook-default-image-attributes} are applied to all inline
10725 images in the Org file to be exported (unless they are overridden by image
10726 attributes specified in @code{#+ATTR_DOCBOOK:} lines).
10728 The @code{#+ATTR_DOCBOOK:} line can be used to specify additional image
10729 attributes or override default image attributes for individual images. If
10730 the same attribute appears in both the @code{#+ATTR_DOCBOOK:} line and
10731 variable @code{org-export-docbook-default-image-attributes}, the former
10732 takes precedence. Here is an example about how image attributes can be
10737 @cindex #+ATTR_DOCBOOK
10739 #+CAPTION: The logo of Org mode
10740 #+LABEL: unicorn-svg
10741 #+ATTR_DOCBOOK: scalefit="1" width="100%" depth="100%"
10742 [[./img/org-mode-unicorn.svg]]
10745 @vindex org-export-docbook-inline-image-extensions
10746 By default, DocBook exporter recognizes the following image file types:
10747 @file{jpeg}, @file{jpg}, @file{png}, @file{gif}, and @file{svg}. You can
10748 customize variable @code{org-export-docbook-inline-image-extensions} to add
10749 more types to this list as long as DocBook supports them.
10751 @node Special characters, , Images in DocBook export, DocBook export
10752 @subsection Special characters in DocBook export
10753 @cindex Special characters in DocBook export
10755 @vindex org-export-docbook-doctype
10756 @vindex org-entities
10757 Special characters that are written in @TeX{}-like syntax, such as @code{\alpha},
10758 @code{\Gamma}, and @code{\Zeta}, are supported by DocBook exporter. These
10759 characters are rewritten to XML entities, like @code{α},
10760 @code{Γ}, and @code{Ζ}, based on the list saved in variable
10761 @code{org-entities}. As long as the generated DocBook file includes the
10762 corresponding entities, these special characters are recognized.
10764 You can customize variable @code{org-export-docbook-doctype} to include the
10765 entities you need. For example, you can set variable
10766 @code{org-export-docbook-doctype} to the following value to recognize all
10767 special characters included in XHTML entities:
10770 "<!DOCTYPE article [
10771 <!ENTITY % xhtml1-symbol PUBLIC
10772 \"-//W3C//ENTITIES Symbol for HTML//EN//XML\"
10773 \"http://www.w3.org/2003/entities/2007/xhtml1-symbol.ent\"
10780 @c begin opendocument
10782 @node OpenDocument Text export, TaskJuggler export, DocBook export, Exporting
10783 @section OpenDocument Text export
10784 @cindex K, Jambunathan
10786 @cindex OpenDocument
10787 @cindex export, OpenDocument
10788 @cindex LibreOffice
10790 @cindex org-modules
10792 Orgmode@footnote{Versions 7.8 or later} supports export to OpenDocument Text
10793 (@acronym{ODT}) format using the @file{org-odt.el} module. Documents created
10794 by this exporter use the @cite{OpenDocument-v1.2
10795 specification}@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
10796 Open Document Format for Office Applications (OpenDocument) Version 1.2}} and
10797 are compatible with LibreOffice 3.4.
10800 * Pre-requisites for @acronym{ODT} export:: What packages @acronym{ODT} exporter relies on
10801 * @acronym{ODT} export commands:: How to invoke @acronym{ODT} export
10802 * Applying custom styles:: How to apply custom styles to the output
10803 * Links in @acronym{ODT} export:: How links will be interpreted and formatted
10804 * Tables in @acronym{ODT} export:: How Tables are exported
10805 * Images in @acronym{ODT} export:: How to insert images
10806 * Math formatting in @acronym{ODT} export:: How @LaTeX{} fragments are formatted
10807 * Literal examples in @acronym{ODT} export:: How source and example blocks are formatted
10808 * Advanced topics in @acronym{ODT} export:: Read this if you are a power user
10811 @node Pre-requisites for @acronym{ODT} export, @acronym{ODT} export commands, OpenDocument Text export, OpenDocument Text export
10812 @subsection Pre-requisites for @acronym{ODT} export
10814 The @acronym{ODT} exporter relies on the @file{zip} program to create the final
10815 output. Check the availability of this program before proceeding further.
10817 @node @acronym{ODT} export commands, Applying custom styles, Pre-requisites for @acronym{ODT} export, OpenDocument Text export
10818 @subsection @acronym{ODT} export commands
10820 @subsubheading Exporting to @acronym{ODT}
10821 @anchor{x-export-to-odt}
10823 @cindex region, active
10824 @cindex active region
10825 @cindex transient-mark-mode
10827 @orgcmd{C-c C-e o,org-export-as-odt}
10828 @cindex property EXPORT_FILE_NAME
10830 Export as OpenDocument Text file.
10831 @vindex org-export-odt-preferred-output-format
10832 If @code{org-export-odt-preferred-output-format} is specified, automatically
10833 convert the exported file to that format.
10834 @xref{x-export-to-other-formats,,Automatically exporting to other formats}.
10836 For an Org file @file{myfile.org}, the @acronym{ODT} file will be
10837 @file{myfile.odt}. The file will be overwritten without warning. If there
10838 is an active region,@footnote{This requires @code{transient-mark-mode} to be
10839 turned on} only the region will be exported. If the selected region is a
10840 single tree,@footnote{To select the current subtree, use @kbd{C-c @@}} the
10841 tree head will become the document title. If the tree head entry has, or
10842 inherits, an @code{EXPORT_FILE_NAME} property, that name will be used for the
10845 @orgcmd{C-c C-e O,org-export-as-odt-and-open}
10846 Export as OpenDocument Text file and open the resulting file.
10847 @vindex org-export-odt-preferred-output-format
10848 If @code{org-export-odt-preferred-output-format} is specified, open the
10849 converted file instead.
10850 @xref{x-export-to-other-formats,,Automatically exporting to other formats}.
10853 @subsubheading Automatically exporting to other formats
10854 @anchor{x-export-to-other-formats}
10855 @vindex org-export-odt-preferred-output-format
10856 Very often, you will find yourself exporting to @acronym{ODT} format, only to
10857 immediately save the exported document to a different format like @samp{pdf}.
10858 In such cases, you will find it convenient to configure a converter
10859 (@pxref{Exporting and converting to other formats}) and specify your
10860 preferred output format by customizing the variable
10861 @code{org-export-odt-preferred-output-format}. This way, the export commands
10862 (@pxref{x-export-to-odt,,Exporting to ODT}) can be extended to also export to
10863 the preferred format.
10865 @node Applying custom styles, Links in @acronym{ODT} export, @acronym{ODT} export commands, OpenDocument Text export
10866 @subsection Applying custom styles
10867 @cindex styles, custom
10868 @cindex template, custom
10870 The @acronym{ODT} exporter ships with a set of OpenDocument styles
10871 (@pxref{Working with OpenDocument style files}) that ensure a well-formatted
10872 output. These factory styles, however, may not cater to your specific
10873 tastes. To customize the output, you can either modify the above styles
10874 files directly, or generate the required styles using an application like
10875 LibreOffice. The latter method is suitable for expert and non-expert
10876 users alike, and is described here.
10878 @subsubsection Applying custom styles - the easy way
10882 Create a sample @file{example.org} file with the below settings and export it
10883 to @acronym{ODT} format.
10886 #+OPTIONS: H:10 num:t
10890 Open the above @file{example.odt} using LibreOffice. Use the @file{Stylist}
10891 to locate the target styles - these typically have the @samp{Org} prefix -
10892 and modify those to your taste. Save the modified file either as an
10893 OpenDocument Text (@file{.odt}) or OpenDocument Template (@file{.ott}) file.
10896 @cindex #+ODT_STYLES_FILE
10897 @vindex org-export-odt-styles-file
10898 Customize the variable @code{org-export-odt-styles-file} and point it to the
10899 newly created file. For additional configuration options
10900 @pxref{x-overriding-factory-styles,,Overriding factory styles}.
10902 If you would like to choose a style on a per-file basis, you can use the
10903 @code{#+ODT_STYLES_FILE} option. A typical setting will look like
10906 #+ODT_STYLES_FILE: "/path/to/example.ott"
10912 #+ODT_STYLES_FILE: ("/path/to/file.ott" ("styles.xml" "image/hdr.png"))
10917 @subsubsection Using third-party styles and templates
10919 You can use third-party styles and templates for customizing your output.
10920 This will produce the desired output only if the template provides all
10921 style names that the @samp{ODT} exporter relies on. Unless this condition is
10922 met, the output is going to be less than satisfactory. So it is highly
10923 recommended that you only work with templates that are directly derived from
10924 the factory settings.
10926 @node Links in @acronym{ODT} export, Tables in @acronym{ODT} export, Applying custom styles, OpenDocument Text export
10927 @subsection Links in @acronym{ODT} export
10928 @cindex tables, in DocBook export
10930 The @acronym{ODT} exporter creates cross-references (aka bookmarks) for
10931 internal links. It creates Internet-style links for all other links.
10933 @node Tables in @acronym{ODT} export, Images in @acronym{ODT} export, Links in @acronym{ODT} export, OpenDocument Text export
10934 @subsection Tables in @acronym{ODT} export
10935 @cindex tables, in DocBook export
10937 Export of native Org mode tables (@pxref{Tables}) and simple @file{table.el}
10938 tables is supported. However, export of complex @file{table.el} tables -
10939 tables that have column or row spans - is not supported. Such tables are
10940 stripped from the exported document.
10942 By default, a table is exported with top and bottom frames and with
10943 rules separating row and column groups (@pxref{Column groups}). If the table
10944 specifies alignment and relative width for its columns (@pxref{Column width
10945 and alignment}) then these are honored on export.@footnote{The column widths
10946 are interpreted as weighted ratios with the default weight being 1}
10949 If you are not satisfied with the default formatting of tables, you can
10950 create custom table styles and associate them with a table using
10951 the @code{#+ATTR_ODT} line. @xref{Customizing tables in @acronym{ODT} export}.
10953 @node Images in @acronym{ODT} export, Math formatting in @acronym{ODT} export, Tables in @acronym{ODT} export, OpenDocument Text export
10954 @subsection Images in @acronym{ODT} export
10955 @cindex images, embedding in @acronym{ODT}
10956 @cindex embedding images in @acronym{ODT}
10958 @subsubheading Embedding images
10959 You can embed images within the exported document by providing a link to the
10960 desired image file with no link description. For example, to embed
10961 @samp{img.png} do either of the following:
10971 @subsubheading Embedding clickable images
10972 You can create clickable images by providing a link whose description is a
10973 link to an image file. For example, to embed a image
10974 @file{org-mode-unicorn.png} which when clicked jumps to
10975 @uref{http://Orgmode.org} website, do the following
10978 [[http://orgmode.org][./org-mode-unicorn.png]]
10981 @subsubheading Sizing and scaling of embedded images
10983 You can control the size and scale of the embedded images using the
10984 @code{#+ATTR_ODT} attribute.
10986 @vindex org-export-odt-pixels-per-inch
10987 Note that the exporter specifies the desired size of the image in the final
10988 document in units of centimetres. In order to scale the embedded images, the
10989 exporter needs to compute the size of the image. This is done by retrieving
10990 the image size in pixels and converting the pixel units to centimetres using
10991 @code{org-export-odt-pixels-per-inch}. The default value of this variable is
10992 set to @code{display-pixels-per-inch}. You can tweak this variable to
10993 achieve the best results.
10995 The examples below illustrate the various possibilities.
10999 @item Explicitly size the image
11000 To embed @file{img.png} as a 10 cm x 10 cm image, do the following:
11003 #+ATTR_ODT: :width 10 :height 10
11007 @item Scale the image
11008 To embed @file{img.png} at half its size, do the following:
11011 #+ATTR_ODT: :scale 0.5
11015 @item Scale the image to a specific width
11016 To embed @file{img.png} with a width of 10 cm while retaining the original
11017 height:width ratio, do the following:
11020 #+ATTR_ODT: :width 10
11024 @item Scale the image to a specific height
11025 To embed @file{img.png} with a height of 10 cm while retaining the original
11026 height:width ratio, do the following
11029 #+ATTR_ODT: :height 10
11034 @node Math formatting in @acronym{ODT} export, Literal examples in @acronym{ODT} export, Images in @acronym{ODT} export, OpenDocument Text export
11035 @subsection Math formatting in @acronym{ODT} export
11037 The @acronym{ODT} exporter has special support for handling math.
11040 * Working with @LaTeX{} math snippets:: How to embed @LaTeX{} math fragments
11041 * Working with MathML or OpenDocument formula files:: How to embed equations in native format
11044 @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
11045 @subsubsection Working with @LaTeX{} math snippets
11047 @LaTeX{} math snippets (@pxref{LaTeX fragments}) can be embedded in the ODT
11048 document in one of the following ways:
11054 This option is activated on a per-file basis with
11060 With this option, @LaTeX{} fragments are first converted into MathML
11061 fragments using an external @LaTeX{}-to-MathML converter program. The
11062 resulting MathML fragments are then embedded as an OpenDocument Formula in
11063 the exported document.
11065 @vindex org-latex-to-mathml-convert-command
11066 @vindex org-latex-to-mathml-jar-file
11068 You can specify the LaTeX-to-MathML converter by customizing the variables
11069 @code{org-latex-to-mathml-convert-command} and
11070 @code{org-latex-to-mathml-jar-file}.
11072 If you prefer to use @file{MathToWeb}@footnote{See
11073 @uref{http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl, MathToWeb}} as your
11074 converter, you can configure the above variables as shown below.
11077 (setq org-latex-to-mathml-convert-command
11078 "java -jar %j -unicode -force -df %o %I"
11079 org-latex-to-mathml-jar-file
11080 "/path/to/mathtoweb.jar")
11083 You can use the following commands to quickly verify the reliability of
11084 the @LaTeX{}-to-MathML converter.
11088 @item M-x org-export-as-odf
11089 Convert a @LaTeX{} math snippet to OpenDocument formula (@file{.odf}) file.
11091 @item M-x org-export-as-odf-and-open
11092 Convert a @LaTeX{} math snippet to OpenDocument formula (@file{.odf}) file and
11093 open the formula file with the system-registered application.
11099 This option is activated on a per-file basis with
11102 #+OPTIONS: LaTeX:dvipng
11105 With this option, @LaTeX{} fragments are processed into PNG images and the
11106 resulting images are embedded in the exported document. This method requires
11107 that the @file{dvipng} program be available on your system.
11110 @node Working with MathML or OpenDocument formula files, , Working with @LaTeX{} math snippets, Math formatting in @acronym{ODT} export
11111 @subsubsection Working with MathML or OpenDocument formula files
11113 For various reasons, you may find embedding @LaTeX{} math snippets in an
11114 @acronym{ODT} document less than reliable. In that case, you can embed a
11115 math equation by linking to its MathML(@file{.mml}) source or its
11116 OpenDocument formula (@file{.odf}) file as shown below:
11128 @node Literal examples in @acronym{ODT} export, Advanced topics in @acronym{ODT} export, Math formatting in @acronym{ODT} export, OpenDocument Text export
11129 @subsection Literal examples in @acronym{ODT} export
11131 Export of literal examples (@pxref{Literal examples}) with full fontification
11132 is supported. This feature is enabled by default and is activated
11133 automatically if an enhanced version of @file{htmlfontify.el} is available in
11134 the @code{load-path}.@footnote{The @file{htmlfontify.el} that ships with
11135 standard Emacs <= 24.1 has no support for @acronym{ODT} fontification. A
11136 copy of the proposed version is available as an attachment to
11137 @url{http://debbugs.gnu.org/cgi/bugreport.cgi?msg=5;filename=htmlfontify.el;att=9;bug=9914,
11140 @vindex org-export-odt-fontify-srcblocks
11142 The character styles used for fontification of the literal blocks are
11143 auto-generated by the exporter in conjunction with @file{htmlfontify.el}
11144 library and need not be included in the default @file{styles.xml} file.
11145 These auto-generated styles have the @samp{OrgSrc} prefix and inherit their color
11146 based on the face used by Emacs @code{font-lock} library.
11148 @vindex org-export-odt-create-custom-styles-for-srcblocks
11149 If you prefer to use your own custom styles for fontification and disable
11150 their auto-generation altogether, you can do so by customizing the variable
11151 @code{org-export-odt-create-custom-styles-for-srcblocks}.
11153 You can turn off fontification support for literal examples by customizing
11154 the variable @code{org-export-odt-fontify-srcblocks}.
11157 @node Advanced topics in @acronym{ODT} export, , Literal examples in @acronym{ODT} export, OpenDocument Text export
11158 @subsection Advanced topics in @acronym{ODT} export
11160 If you rely heavily on @acronym{ODT} export, you may want to exploit the full
11161 set of features that the exporter offers. This section describes features
11162 that would be of interest to power users.
11165 * Exporting and converting to other formats:: How to produce @samp{pdf} and other formats
11166 * Working with OpenDocument style files:: Explore the internals
11167 * Creating one-off styles:: How to produce custom highlighting etc
11168 * Customizing tables in @acronym{ODT} export:: How to define and use Table templates
11169 * Validating OpenDocument XML:: How to debug corrupt OpenDocument files
11172 @node Exporting and converting to other formats, Working with OpenDocument style files, Advanced topics in @acronym{ODT} export, Advanced topics in @acronym{ODT} export
11173 @subsubsection Exporting and converting to other formats
11177 The @acronym{ODT} exporter adds support for exporting Org outlines to formats
11178 that are not supported natively by Org. It also adds support to convert
11179 document from one format to another. To use these features, you need to
11180 configure a command-line converter. Once a command-line converter is
11181 configured you can use it to extend the list of formats to which Org can
11182 export. @xref{x-export-to-other-formats,,Automatically exporting to other
11183 formats}. You can also use it to perform one-off document conversion as
11186 @vindex org-export-odt-convert
11189 @item M-x org-export-odt-convert
11190 Convert an existing document from one format to another as determined by the
11191 variable @code{org-export-odt-convert-capabilities}
11192 (@pxref{x-odt-converter-capabilities,,Configure converter
11193 capabilities}). @strong{Please note} that you can use this command to even
11194 convert documents that are produced outside of Org and in other formats than
11195 @acronym{ODT} format.
11198 @subsubheading Pre-configured converters
11201 The @acronym{ODT} exporter supports two converters out of the box:
11205 @cindex @file{unoconv}
11206 @item @file{unoconv}
11208 This converter is available as an installable package in your favorite
11211 @cindex @file{BasicODConverter}
11212 @item @file{BasicODConverter}
11214 @vindex org-odt-data-dir
11215 This converter is distributed as a LibreOffice extension and can be found in
11216 your Org distribution. See the subdirectory pointed to by the variable
11217 @code{org-odt-data-dir}.
11221 @subsubheading Installing a new converter
11222 If you prefer to use a converter other than the two mentioned above, then you
11223 may have to do additional configuration. You can proceed as follows:
11226 @item Register the converter
11228 @vindex org-export-odt-convert-processes
11229 Name your converter and add it to the list of known converters by customizing
11230 the variable @code{org-export-odt-convert-processes}. Also specify how the
11231 converter can be invoked via command-line to effect the conversion.
11233 @item Configure its capabilities
11234 @vindex org-export-odt-convert-capabilities
11236 @anchor{x-odt-converter-capabilities}
11238 Specify the set of formats the converter can handle by customizing the
11239 variable @code{org-export-odt-convert-capabilities}. Use the default value
11240 for this variable as a guide for configuring your converter. As suggested by
11241 the default setting, you can specify the full set of formats supported by the
11242 converter and not limit yourself to specifying formats that are related to
11243 just the OpenDocument Text format.
11245 @item Choose the converter
11247 @vindex org-export-odt-convert-process
11248 Select the newly added converter as the preferred one by customizing the
11249 variable @code{org-export-odt-convert-process}.
11252 @node Working with OpenDocument style files, Creating one-off styles, Exporting and converting to other formats, Advanced topics in @acronym{ODT} export
11253 @subsubsection Working with OpenDocument style files
11254 @cindex styles, custom
11255 @cindex template, custom
11257 This section explores the internals of the @acronym{ODT} exporter and the
11258 means by which it produces styled documents. Read this section if you are
11259 interested in exploring the automatic and custom OpenDocument styles used by
11262 @anchor{x-factory-styles}
11263 @subsubheading Factory styles
11265 The @acronym{ODT} exporter relies on two files for generating its output.
11266 These files are bundled with the distribution under the directory pointed to
11267 by the variable @code{org-odt-styles-dir}. The two files are:
11270 @anchor{x-orgodtstyles-xml}
11272 @file{OrgOdtStyles.xml}
11274 This file contributes to the @file{styles.xml} file of the final @samp{ODT}
11275 document. This file gets modified for the following purposes:
11279 To control outline numbering based on user settings.
11282 To add styles generated by @file{htmlfontify.el} for fontification of code
11286 @anchor{x-orgodtcontenttemplate-xml}
11288 @file{OrgOdtContentTemplate.xml}
11290 This file contributes to the @file{content.xml} file of the final @samp{ODT}
11291 document. The contents of the Org outline are inserted between the
11292 @samp{<office:text>}@dots{}@samp{</office:text>} elements of this file.
11294 Apart from serving as a template file for the final @file{content.xml}, the
11295 file serves the following purposes:
11299 It contains automatic styles for formatting of tables which are referenced by
11303 It contains @samp{<text:sequence-decl>}@dots{}@samp{</text:sequence-decl>}
11304 elements that control how various entities - tables, images, equations etc -
11309 @anchor{x-overriding-factory-styles}
11310 @subsubheading Overriding factory styles
11311 The following two variables control the location from which the @acronym{ODT}
11312 exporter picks up the custom styles and content template files. You can
11313 customize these variables to override the factory styles used by the
11317 @anchor{x-org-export-odt-styles-file}
11319 @code{org-export-odt-styles-file}
11321 Use this variable to specify the @file{styles.xml} that will be used in the
11322 final output. You can specify one of the following values:
11325 @item A @file{styles.xml} file
11327 Use this file instead of the default @file{styles.xml}
11329 @item A @file{.odt} or @file{.ott} file
11331 Use the @file{styles.xml} contained in the specified OpenDocument Text or
11334 @item A @file{.odt} or @file{.ott} file and a subset of files contained within them
11336 Use the @file{styles.xml} contained in the specified OpenDocument Text or
11337 Template file. Additionally extract the specified member files and embed
11338 those within the final @samp{ODT} document.
11340 Use this option if the @file{styles.xml} file references additional files
11341 like header and footer images.
11345 Use the default @file{styles.xml}
11348 @anchor{x-org-export-odt-content-template-file}
11350 @code{org-export-odt-content-template-file}
11352 Use this variable to specify the blank @file{content.xml} that will be used
11353 in the final output.
11356 @node Creating one-off styles, Customizing tables in @acronym{ODT} export, Working with OpenDocument style files, Advanced topics in @acronym{ODT} export
11357 @subsubsection Creating one-off styles
11359 There are times when you would want one-off formatting in the exported
11360 document. You can achieve this by embedding raw OpenDocument XML in the Org
11361 file. The use of this feature is better illustrated with couple of examples.
11364 @item Embedding ODT tags as part of regular text
11366 You can include simple OpenDocument tags by prefixing them with
11367 @samp{@@}. For example, to highlight a region of text do the following:
11370 @@<text:span text:style-name="Highlight">This is a
11371 highlighted text@@</text:span>. But this is a
11375 @strong{Hint:} To see the above example in action, edit your
11376 @file{styles.xml}(@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
11377 custom @samp{Highlight} style as shown below.
11380 <style:style style:name="Highlight" style:family="text">
11381 <style:text-properties fo:background-color="#ff0000"/>
11385 @item Embedding a one-line OpenDocument XML
11387 You can add a simple OpenDocument one-liner using the @code{#+ODT:}
11388 directive. For example, to force a page break do the following:
11391 #+ODT: <text:p text:style-name="PageBreak"/>
11394 @strong{Hint:} To see the above example in action, edit your
11395 @file{styles.xml}(@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
11396 custom @samp{PageBreak} style as shown below.
11399 <style:style style:name="PageBreak" style:family="paragraph"
11400 style:parent-style-name="Text_20_body">
11401 <style:paragraph-properties fo:break-before="page"/>
11405 @item Embedding a block of OpenDocument XML
11407 You can add a large block of OpenDocument XML using the
11408 @code{#+BEGIN_ODT}@dots{}@code{#+END_ODT} construct.
11410 For example, to create a one-off paragraph that uses bold text, do the
11415 <text:p text:style-name="Text_20_body_20_bold">
11416 This paragraph is specially formatted and uses bold text.
11423 @node Customizing tables in @acronym{ODT} export, Validating OpenDocument XML, Creating one-off styles, Advanced topics in @acronym{ODT} export
11424 @subsubsection Customizing tables in @acronym{ODT} export
11425 @cindex tables, in ODT export
11428 You can override the default formatting of the table by specifying a custom
11429 table style with the @code{#+ATTR_ODT} line. For a discussion on default
11430 formatting of tables @pxref{Tables in @acronym{ODT} export}.
11432 This feature closely mimics the way table templates are defined in the
11434 specification.@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
11435 OpenDocument-v1.2 Specification}}
11439 @subsubheading Custom table styles - an illustration
11441 To have a quick preview of this feature, install the below setting and export
11442 the table that follows.
11445 (setq org-export-odt-table-styles
11446 (append org-export-odt-table-styles
11447 '(("TableWithHeaderRowAndColumn" "Custom"
11448 ((use-first-row-styles . t)
11449 (use-first-column-styles . t)))
11450 ("TableWithFirstRowandLastRow" "Custom"
11451 ((use-first-row-styles . t)
11452 (use-last-row-styles . t))))))
11456 #+ATTR_ODT: TableWithHeaderRowAndColumn
11457 | Name | Phone | Age |
11458 | Peter | 1234 | 17 |
11459 | Anna | 4321 | 25 |
11462 In the above example, you used a template named @samp{Custom} and installed
11463 two table styles with the names @samp{TableWithHeaderRowAndColumn} and
11464 @samp{TableWithFirstRowandLastRow}. (@strong{Important:} The OpenDocument
11465 styles needed for producing the above template have been pre-defined for you.
11466 These styles are available under the section marked @samp{Custom Table
11467 Template} in @file{OrgOdtContentTemplate.xml}
11468 (@pxref{x-orgodtcontenttemplate-xml,,Factory styles}). If you need
11469 additional templates you have to define these styles yourselves.
11471 @subsubheading Custom table styles - the nitty-gritty
11472 To use this feature proceed as follows:
11476 Create a table template@footnote{See the @code{<table:table-template>}
11477 element of the OpenDocument-v1.2 specification}
11479 A table template is nothing but a set of @samp{table-cell} and
11480 @samp{paragraph} styles for each of the following table cell categories:
11494 The names for the above styles must be chosen based on the name of the table
11495 template using a well-defined convention.
11497 The naming convention is better illustrated with an example. For a table
11498 template with the name @samp{Custom}, the needed style names are listed in
11499 the following table.
11501 @multitable {Table cell type} {CustomEvenColumnTableCell} {CustomEvenColumnTableParagraph}
11502 @headitem Table cell type
11503 @tab @code{table-cell} style
11504 @tab @code{paragraph} style
11509 @tab @samp{CustomTableCell}
11510 @tab @samp{CustomTableParagraph}
11512 @tab @samp{CustomFirstColumnTableCell}
11513 @tab @samp{CustomFirstColumnTableParagraph}
11515 @tab @samp{CustomLastColumnTableCell}
11516 @tab @samp{CustomLastColumnTableParagraph}
11518 @tab @samp{CustomFirstRowTableCell}
11519 @tab @samp{CustomFirstRowTableParagraph}
11521 @tab @samp{CustomLastRowTableCell}
11522 @tab @samp{CustomLastRowTableParagraph}
11524 @tab @samp{CustomEvenRowTableCell}
11525 @tab @samp{CustomEvenRowTableParagraph}
11527 @tab @samp{CustomOddRowTableCell}
11528 @tab @samp{CustomOddRowTableParagraph}
11530 @tab @samp{CustomEvenColumnTableCell}
11531 @tab @samp{CustomEvenColumnTableParagraph}
11533 @tab @samp{CustomOddColumnTableCell}
11534 @tab @samp{CustomOddColumnTableParagraph}
11537 To create a table template with the name @samp{Custom}, define the above
11539 @code{<office:automatic-styles>}...@code{</office:automatic-styles>} element
11540 of the content template file (@pxref{x-orgodtcontenttemplate-xml,,Factory
11544 Define a table style@footnote{See the attributes @code{table:template-name},
11545 @code{table:use-first-row-styles}, @code{table:use-last-row-styles},
11546 @code{table:use-first-column-styles}, @code{table:use-last-column-styles},
11547 @code{table:use-banding-rows-styles}, and
11548 @code{table:use-banding-column-styles} of the @code{<table:table>} element in
11549 the OpenDocument-v1.2 specification}
11551 @vindex org-export-odt-table-styles
11552 To define a table style, create an entry for the style in the variable
11553 @code{org-export-odt-table-styles} and specify the following:
11556 @item the name of the table template created in step (1)
11557 @item the set of cell styles in that template that are to be activated
11560 For example, the entry below defines two different table styles
11561 @samp{TableWithHeaderRowsAndColumns} and @samp{TableWithHeaderColumns} based
11562 on the same template @samp{Custom}. The styles achieve their intended effect
11563 by selectively activating the individual cell styles in that template.
11566 (setq org-export-odt-table-styles
11567 (append org-export-odt-table-styles
11568 '(("TableWithHeaderRowAndColumn" "Custom"
11569 ((use-first-row-styles . t)
11570 (use-first-column-styles . t)))
11571 ("TableWithFirstRowandLastRow" "Custom"
11572 ((use-first-row-styles . t)
11573 (use-last-row-styles . t))))))
11577 Associate a table with the table style
11579 To do this, specify the table style created in step (2) as part of
11580 the @code{ATTR_ODT} line as shown below.
11583 #+ATTR_ODT: TableWithHeaderRowAndColumn
11584 | Name | Phone | Age |
11585 | Peter | 1234 | 17 |
11586 | Anna | 4321 | 25 |
11590 @node Validating OpenDocument XML, , Customizing tables in @acronym{ODT} export, Advanced topics in @acronym{ODT} export
11591 @subsubsection Validating OpenDocument XML
11593 Occasionally, you will discover that the document created by the
11594 @acronym{ODT} exporter cannot be opened by your favorite application. One of
11595 the common reasons for this is that the @file{.odt} file is corrupt. In such
11596 cases, you may want to validate the document against the OpenDocument RELAX
11597 NG Compact Syntax (RNC) schema.
11599 For de-compressing the @file{.odt} file@footnote{@file{.odt} files are
11600 nothing but @samp{zip} archives}: @inforef{File Archives,,emacs}. For
11601 general help with validation (and schema-sensitive editing) of XML files:
11602 @inforef{Introduction,,nxml-mode}.
11604 @vindex org-export-odt-schema-dir
11605 If you have ready access to OpenDocument @file{.rnc} files and the needed
11606 schema-locating rules in a single folder, you can customize the variable
11607 @code{org-export-odt-schema-dir} to point to that directory. The
11608 @acronym{ODT} exporter will take care of updating the
11609 @code{rng-schema-locating-files} for you.
11611 @c end opendocument
11613 @node TaskJuggler export, Freemind export, OpenDocument Text export, Exporting
11614 @section TaskJuggler export
11615 @cindex TaskJuggler export
11616 @cindex Project management
11618 @uref{http://www.taskjuggler.org/, TaskJuggler} is a project management tool.
11619 It provides an optimizing scheduler that computes your project time lines and
11620 resource assignments based on the project outline and the constraints that
11623 The TaskJuggler exporter is a bit different from other exporters, such as the
11624 HTML and LaTeX exporters for example, in that it does not export all the
11625 nodes of a document or strictly follow the order of the nodes in the
11628 Instead the TaskJuggler exporter looks for a tree that defines the tasks and
11629 a optionally tree that defines the resources for this project. It then
11630 creates a TaskJuggler file based on these trees and the attributes defined in
11633 @subsection TaskJuggler export commands
11636 @orgcmd{C-c C-e j,org-export-as-taskjuggler}
11637 Export as TaskJuggler file.
11639 @orgcmd{C-c C-e J,org-export-as-taskjuggler-and-open}
11640 Export as TaskJuggler file and then open the file with TaskJugglerUI.
11645 @vindex org-export-taskjuggler-project-tag
11646 Create your tasks as you usually do with Org mode. Assign efforts to each
11647 task using properties (it is easiest to do this in the column view). You
11648 should end up with something similar to the example by Peter Jones in
11649 @url{http://www.contextualdevelopment.com/static/artifacts/articles/2008/project-planning/project-planning.org}.
11650 Now mark the top node of your tasks with a tag named
11651 @code{:taskjuggler_project:} (or whatever you customized
11652 @code{org-export-taskjuggler-project-tag} to). You are now ready to export
11653 the project plan with @kbd{C-c C-e J} which will export the project plan and
11654 open a gantt chart in TaskJugglerUI.
11656 @subsection Resources
11658 @vindex org-export-taskjuggler-resource-tag
11659 Next you can define resources and assign those to work on specific tasks. You
11660 can group your resources hierarchically. Tag the top node of the resources
11661 with @code{:taskjuggler_resource:} (or whatever you customized
11662 @code{org-export-taskjuggler-resource-tag} to). You can optionally assign an
11663 identifier (named @samp{resource_id}) to the resources (using the standard
11664 Org properties commands, @pxref{Property syntax}) or you can let the exporter
11665 generate identifiers automatically (the exporter picks the first word of the
11666 headline as the identifier as long as it is unique---see the documentation of
11667 @code{org-taskjuggler-get-unique-id}). Using that identifier you can then
11668 allocate resources to tasks. This is again done with the @samp{allocate}
11669 property on the tasks. Do this in column view or when on the task type
11670 @kbd{C-c C-x p allocate @key{RET} <resource_id> @key{RET}}.
11672 Once the allocations are done you can again export to TaskJuggler and check
11673 in the Resource Allocation Graph which person is working on what task at what
11676 @subsection Export of properties
11678 The exporter also takes TODO state information into consideration, i.e.@: if a
11679 task is marked as done it will have the corresponding attribute in
11680 TaskJuggler (@samp{complete 100}). Also it will export any property on a task
11681 resource or resource node which is known to TaskJuggler, such as
11682 @samp{limits}, @samp{vacation}, @samp{shift}, @samp{booking},
11683 @samp{efficiency}, @samp{journalentry}, @samp{rate} for resources or
11684 @samp{account}, @samp{start}, @samp{note}, @samp{duration}, @samp{end},
11685 @samp{journalentry}, @samp{milestone}, @samp{reference}, @samp{responsible},
11686 @samp{scheduling}, etc for tasks.
11688 @subsection Dependencies
11690 The exporter will handle dependencies that are defined in the tasks either
11691 with the @samp{ORDERED} attribute (@pxref{TODO dependencies}), with the
11692 @samp{BLOCKER} attribute (see @file{org-depend.el}) or alternatively with a
11693 @samp{depends} attribute. Both the @samp{BLOCKER} and the @samp{depends}
11694 attribute can be either @samp{previous-sibling} or a reference to an
11695 identifier (named @samp{task_id}) which is defined for another task in the
11696 project. @samp{BLOCKER} and the @samp{depends} attribute can define multiple
11697 dependencies separated by either space or comma. You can also specify
11698 optional attributes on the dependency by simply appending it. The following
11699 examples should illustrate this:
11704 :task_id: preparation
11707 * Training material
11709 :task_id: training_material
11712 ** Markup Guidelines
11716 ** Workflow Guidelines
11723 :BLOCKER: training_material @{ gapduration 1d @} preparation
11727 @subsection Reports
11729 @vindex org-export-taskjuggler-default-reports
11730 TaskJuggler can produce many kinds of reports (e.g.@: gantt chart, resource
11731 allocation, etc). The user defines what kind of reports should be generated
11732 for a project in the TaskJuggler file. The exporter will automatically insert
11733 some default reports in the file. These defaults are defined in
11734 @code{org-export-taskjuggler-default-reports}. They can be modified using
11735 customize along with a number of other options. For a more complete list, see
11736 @kbd{M-x customize-group @key{RET} org-export-taskjuggler @key{RET}}.
11738 For more information and examples see the Org-taskjuggler tutorial at
11739 @uref{http://orgmode.org/worg/org-tutorials/org-taskjuggler.html}.
11741 @node Freemind export, XOXO export, TaskJuggler export, Exporting
11742 @section Freemind export
11743 @cindex Freemind export
11746 The Freemind exporter was written by Lennart Borgman.
11749 @orgcmd{C-c C-e m,org-export-as-freemind}
11750 Export as Freemind mind map. For an Org file @file{myfile.org}, the Freemind
11751 file will be @file{myfile.mm}.
11754 @node XOXO export, iCalendar export, Freemind export, Exporting
11755 @section XOXO export
11756 @cindex XOXO export
11758 Org mode contains an exporter that produces XOXO-style output.
11759 Currently, this exporter only handles the general outline structure and
11760 does not interpret any additional Org mode features.
11763 @orgcmd{C-c C-e x,org-export-as-xoxo}
11764 Export as XOXO file. For an Org file @file{myfile.org}, the XOXO file will be
11765 @file{myfile.html}.
11766 @orgkey{C-c C-e v x}
11767 Export only the visible part of the document.
11770 @node iCalendar export, , XOXO export, Exporting
11771 @section iCalendar export
11772 @cindex iCalendar export
11774 @vindex org-icalendar-include-todo
11775 @vindex org-icalendar-use-deadline
11776 @vindex org-icalendar-use-scheduled
11777 @vindex org-icalendar-categories
11778 @vindex org-icalendar-alarm-time
11779 Some people use Org mode for keeping track of projects, but still prefer a
11780 standard calendar application for anniversaries and appointments. In this
11781 case it can be useful to show deadlines and other time-stamped items in Org
11782 files in the calendar application. Org mode can export calendar information
11783 in the standard iCalendar format. If you also want to have TODO entries
11784 included in the export, configure the variable
11785 @code{org-icalendar-include-todo}. Plain timestamps are exported as VEVENT,
11786 and TODO items as VTODO. It will also create events from deadlines that are
11787 in non-TODO items. Deadlines and scheduling dates in TODO items will be used
11788 to set the start and due dates for the TODO entry@footnote{See the variables
11789 @code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}.
11790 As categories, it will use the tags locally defined in the heading, and the
11791 file/tree category@footnote{To add inherited tags or the TODO state,
11792 configure the variable @code{org-icalendar-categories}.}. See the variable
11793 @code{org-icalendar-alarm-time} for a way to assign alarms to entries with a
11796 @vindex org-icalendar-store-UID
11797 @cindex property, ID
11798 The iCalendar standard requires each entry to have a globally unique
11799 identifier (UID). Org creates these identifiers during export. If you set
11800 the variable @code{org-icalendar-store-UID}, the UID will be stored in the
11801 @code{:ID:} property of the entry and re-used next time you report this
11802 entry. Since a single entry can give rise to multiple iCalendar entries (as
11803 a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
11804 prefixes to the UID, depending on what triggered the inclusion of the entry.
11805 In this way the UID remains unique, but a synchronization program can still
11806 figure out from which entry all the different instances originate.
11809 @orgcmd{C-c C-e i,org-export-icalendar-this-file}
11810 Create iCalendar entries for the current file and store them in the same
11811 directory, using a file extension @file{.ics}.
11812 @orgcmd{C-c C-e I, org-export-icalendar-all-agenda-files}
11813 @vindex org-agenda-files
11814 Like @kbd{C-c C-e i}, but do this for all files in
11815 @code{org-agenda-files}. For each of these files, a separate iCalendar
11816 file will be written.
11817 @orgcmd{C-c C-e c,org-export-icalendar-combine-agenda-files}
11818 @vindex org-combined-agenda-icalendar-file
11819 Create a single large iCalendar file from all files in
11820 @code{org-agenda-files} and write it to the file given by
11821 @code{org-combined-agenda-icalendar-file}.
11824 @vindex org-use-property-inheritance
11825 @vindex org-icalendar-include-body
11826 @cindex property, SUMMARY
11827 @cindex property, DESCRIPTION
11828 @cindex property, LOCATION
11829 The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION
11830 property can be inherited from higher in the hierarchy if you configure
11831 @code{org-use-property-inheritance} accordingly.} properties if the selected
11832 entries have them. If not, the summary will be derived from the headline,
11833 and the description from the body (limited to
11834 @code{org-icalendar-include-body} characters).
11836 How this calendar is best read and updated, depends on the application
11837 you are using. The FAQ covers this issue.
11839 @node Publishing, Working With Source Code, Exporting, Top
11840 @chapter Publishing
11843 Org includes a publishing management system that allows you to configure
11844 automatic HTML conversion of @emph{projects} composed of interlinked org
11845 files. You can also configure Org to automatically upload your exported HTML
11846 pages and related attachments, such as images and source code files, to a web
11849 You can also use Org to convert files into PDF, or even combine HTML and PDF
11850 conversion so that files are available in both formats on the server.
11852 Publishing has been contributed to Org by David O'Toole.
11855 * Configuration:: Defining projects
11856 * Uploading files:: How to get files up on the server
11857 * Sample configuration:: Example projects
11858 * Triggering publication:: Publication commands
11861 @node Configuration, Uploading files, Publishing, Publishing
11862 @section Configuration
11864 Publishing needs significant configuration to specify files, destination
11865 and many other properties of a project.
11868 * Project alist:: The central configuration variable
11869 * Sources and destinations:: From here to there
11870 * Selecting files:: What files are part of the project?
11871 * Publishing action:: Setting the function doing the publishing
11872 * Publishing options:: Tweaking HTML/@LaTeX{} export
11873 * Publishing links:: Which links keep working after publishing?
11874 * Sitemap:: Generating a list of all pages
11875 * Generating an index:: An index that reaches across pages
11878 @node Project alist, Sources and destinations, Configuration, Configuration
11879 @subsection The variable @code{org-publish-project-alist}
11880 @cindex org-publish-project-alist
11881 @cindex projects, for publishing
11883 @vindex org-publish-project-alist
11884 Publishing is configured almost entirely through setting the value of one
11885 variable, called @code{org-publish-project-alist}. Each element of the list
11886 configures one project, and may be in one of the two following forms:
11889 ("project-name" :property value :property value ...)
11890 @r{i.e.@: a well-formed property list with alternating keys and values}
11892 ("project-name" :components ("project-name" "project-name" ...))
11896 In both cases, projects are configured by specifying property values. A
11897 project defines the set of files that will be published, as well as the
11898 publishing configuration to use when publishing those files. When a project
11899 takes the second form listed above, the individual members of the
11900 @code{:components} property are taken to be sub-projects, which group
11901 together files requiring different publishing options. When you publish such
11902 a ``meta-project'', all the components will also be published, in the
11905 @node Sources and destinations, Selecting files, Project alist, Configuration
11906 @subsection Sources and destinations for files
11907 @cindex directories, for publishing
11909 Most properties are optional, but some should always be set. In
11910 particular, Org needs to know where to look for source files,
11911 and where to put published files.
11913 @multitable @columnfractions 0.3 0.7
11914 @item @code{:base-directory}
11915 @tab Directory containing publishing source files
11916 @item @code{:publishing-directory}
11917 @tab Directory where output files will be published. You can directly
11918 publish to a webserver using a file name syntax appropriate for
11919 the Emacs @file{tramp} package. Or you can publish to a local directory and
11920 use external tools to upload your website (@pxref{Uploading files}).
11921 @item @code{:preparation-function}
11922 @tab Function or list of functions to be called before starting the
11923 publishing process, for example, to run @code{make} for updating files to be
11924 published. The project property list is scoped into this call as the
11925 variable @code{project-plist}.
11926 @item @code{:completion-function}
11927 @tab Function or list of functions called after finishing the publishing
11928 process, for example, to change permissions of the resulting files. The
11929 project property list is scoped into this call as the variable
11930 @code{project-plist}.
11934 @node Selecting files, Publishing action, Sources and destinations, Configuration
11935 @subsection Selecting files
11936 @cindex files, selecting for publishing
11938 By default, all files with extension @file{.org} in the base directory
11939 are considered part of the project. This can be modified by setting the
11941 @multitable @columnfractions 0.25 0.75
11942 @item @code{:base-extension}
11943 @tab Extension (without the dot!) of source files. This actually is a
11944 regular expression. Set this to the symbol @code{any} if you want to get all
11945 files in @code{:base-directory}, even without extension.
11947 @item @code{:exclude}
11948 @tab Regular expression to match file names that should not be
11949 published, even though they have been selected on the basis of their
11952 @item @code{:include}
11953 @tab List of files to be included regardless of @code{:base-extension}
11954 and @code{:exclude}.
11956 @item @code{:recursive}
11957 @tab Non-nil means, check base-directory recursively for files to publish.
11960 @node Publishing action, Publishing options, Selecting files, Configuration
11961 @subsection Publishing action
11962 @cindex action, for publishing
11964 Publishing means that a file is copied to the destination directory and
11965 possibly transformed in the process. The default transformation is to export
11966 Org files as HTML files, and this is done by the function
11967 @code{org-publish-org-to-html} which calls the HTML exporter (@pxref{HTML
11968 export}). But you also can publish your content as PDF files using
11969 @code{org-publish-org-to-pdf}, or as @code{ascii}, @code{latin1} or
11970 @code{utf8} encoded files using the corresponding functions. If you want to
11971 publish the Org file itself, but with @i{archived}, @i{commented}, and
11972 @i{tag-excluded} trees removed, use @code{org-publish-org-to-org} and set the
11973 parameters @code{:plain-source} and/or @code{:htmlized-source}. This will
11974 produce @file{file.org} and @file{file.org.html} in the publishing
11975 directory@footnote{@file{file-source.org} and @file{file-source.org.html} if
11976 source and publishing directories are equal. Note that with this kind of
11977 setup, you need to add @code{:exclude "-source\\.org"} to the project
11978 definition in @code{org-publish-project-alist} to prevent the published
11979 source files from being considered as new org files the next time the project
11980 is published.}. Other files like images only need to be copied to the
11981 publishing destination; for this you may use @code{org-publish-attachment}.
11982 For non-Org files, you always need to specify the publishing function:
11984 @multitable @columnfractions 0.3 0.7
11985 @item @code{:publishing-function}
11986 @tab Function executing the publication of a file. This may also be a
11987 list of functions, which will all be called in turn.
11988 @item @code{:plain-source}
11989 @tab Non-nil means, publish plain source.
11990 @item @code{:htmlized-source}
11991 @tab Non-nil means, publish htmlized source.
11994 The function must accept three arguments: a property list containing at least
11995 a @code{:publishing-directory} property, the name of the file to be
11996 published, and the path to the publishing directory of the output file. It
11997 should take the specified file, make the necessary transformation (if any)
11998 and place the result into the destination folder.
12000 @node Publishing options, Publishing links, Publishing action, Configuration
12001 @subsection Options for the HTML/@LaTeX{} exporters
12002 @cindex options, for publishing
12004 The property list can be used to set many export options for the HTML
12005 and @LaTeX{} exporters. In most cases, these properties correspond to user
12006 variables in Org. The table below lists these properties along
12007 with the variable they belong to. See the documentation string for the
12008 respective variable for details.
12010 @vindex org-export-html-link-up
12011 @vindex org-export-html-link-home
12012 @vindex org-export-default-language
12013 @vindex org-display-custom-times
12014 @vindex org-export-headline-levels
12015 @vindex org-export-with-section-numbers
12016 @vindex org-export-section-number-format
12017 @vindex org-export-with-toc
12018 @vindex org-export-preserve-breaks
12019 @vindex org-export-with-archived-trees
12020 @vindex org-export-with-emphasize
12021 @vindex org-export-with-sub-superscripts
12022 @vindex org-export-with-special-strings
12023 @vindex org-export-with-footnotes
12024 @vindex org-export-with-drawers
12025 @vindex org-export-with-tags
12026 @vindex org-export-with-todo-keywords
12027 @vindex org-export-with-tasks
12028 @vindex org-export-with-done-tasks
12029 @vindex org-export-with-priority
12030 @vindex org-export-with-TeX-macros
12031 @vindex org-export-with-LaTeX-fragments
12032 @vindex org-export-skip-text-before-1st-heading
12033 @vindex org-export-with-fixed-width
12034 @vindex org-export-with-timestamps
12035 @vindex org-export-author-info
12036 @vindex org-export-email-info
12037 @vindex org-export-creator-info
12038 @vindex org-export-time-stamp-file
12039 @vindex org-export-with-tables
12040 @vindex org-export-highlight-first-table-line
12041 @vindex org-export-html-style-include-default
12042 @vindex org-export-html-style-include-scripts
12043 @vindex org-export-html-style
12044 @vindex org-export-html-style-extra
12045 @vindex org-export-html-link-org-files-as-html
12046 @vindex org-export-html-inline-images
12047 @vindex org-export-html-extension
12048 @vindex org-export-html-table-tag
12049 @vindex org-export-html-expand
12050 @vindex org-export-html-with-timestamp
12051 @vindex org-export-publishing-directory
12052 @vindex org-export-html-preamble
12053 @vindex org-export-html-postamble
12054 @vindex user-full-name
12055 @vindex user-mail-address
12056 @vindex org-export-select-tags
12057 @vindex org-export-exclude-tags
12059 @multitable @columnfractions 0.32 0.68
12060 @item @code{:link-up} @tab @code{org-export-html-link-up}
12061 @item @code{:link-home} @tab @code{org-export-html-link-home}
12062 @item @code{:language} @tab @code{org-export-default-language}
12063 @item @code{:customtime} @tab @code{org-display-custom-times}
12064 @item @code{:headline-levels} @tab @code{org-export-headline-levels}
12065 @item @code{:section-numbers} @tab @code{org-export-with-section-numbers}
12066 @item @code{:section-number-format} @tab @code{org-export-section-number-format}
12067 @item @code{:table-of-contents} @tab @code{org-export-with-toc}
12068 @item @code{:preserve-breaks} @tab @code{org-export-preserve-breaks}
12069 @item @code{:archived-trees} @tab @code{org-export-with-archived-trees}
12070 @item @code{:emphasize} @tab @code{org-export-with-emphasize}
12071 @item @code{:sub-superscript} @tab @code{org-export-with-sub-superscripts}
12072 @item @code{:special-strings} @tab @code{org-export-with-special-strings}
12073 @item @code{:footnotes} @tab @code{org-export-with-footnotes}
12074 @item @code{:drawers} @tab @code{org-export-with-drawers}
12075 @item @code{:tags} @tab @code{org-export-with-tags}
12076 @item @code{:todo-keywords} @tab @code{org-export-with-todo-keywords}
12077 @item @code{:tasks} @tab @code{org-export-with-tasks}
12078 @item @code{:priority} @tab @code{org-export-with-priority}
12079 @item @code{:TeX-macros} @tab @code{org-export-with-TeX-macros}
12080 @item @code{:LaTeX-fragments} @tab @code{org-export-with-LaTeX-fragments}
12081 @item @code{:latex-listings} @tab @code{org-export-latex-listings}
12082 @item @code{:skip-before-1st-heading} @tab @code{org-export-skip-text-before-1st-heading}
12083 @item @code{:fixed-width} @tab @code{org-export-with-fixed-width}
12084 @item @code{:timestamps} @tab @code{org-export-with-timestamps}
12085 @item @code{:author} @tab @code{user-full-name}
12086 @item @code{:email} @tab @code{user-mail-address} : @code{addr;addr;..}
12087 @item @code{:author-info} @tab @code{org-export-author-info}
12088 @item @code{:email-info} @tab @code{org-export-email-info}
12089 @item @code{:creator-info} @tab @code{org-export-creator-info}
12090 @item @code{:tables} @tab @code{org-export-with-tables}
12091 @item @code{:table-auto-headline} @tab @code{org-export-highlight-first-table-line}
12092 @item @code{:style-include-default} @tab @code{org-export-html-style-include-default}
12093 @item @code{:style-include-scripts} @tab @code{org-export-html-style-include-scripts}
12094 @item @code{:style} @tab @code{org-export-html-style}
12095 @item @code{:style-extra} @tab @code{org-export-html-style-extra}
12096 @item @code{:convert-org-links} @tab @code{org-export-html-link-org-files-as-html}
12097 @item @code{:inline-images} @tab @code{org-export-html-inline-images}
12098 @item @code{:html-extension} @tab @code{org-export-html-extension}
12099 @item @code{:html-preamble} @tab @code{org-export-html-preamble}
12100 @item @code{:html-postamble} @tab @code{org-export-html-postamble}
12101 @item @code{:xml-declaration} @tab @code{org-export-html-xml-declaration}
12102 @item @code{:html-table-tag} @tab @code{org-export-html-table-tag}
12103 @item @code{:expand-quoted-html} @tab @code{org-export-html-expand}
12104 @item @code{:timestamp} @tab @code{org-export-html-with-timestamp}
12105 @item @code{:publishing-directory} @tab @code{org-export-publishing-directory}
12106 @item @code{:select-tags} @tab @code{org-export-select-tags}
12107 @item @code{:exclude-tags} @tab @code{org-export-exclude-tags}
12108 @item @code{:latex-image-options} @tab @code{org-export-latex-image-default-option}
12111 Most of the @code{org-export-with-*} variables have the same effect in
12112 both HTML and @LaTeX{} exporters, except for @code{:TeX-macros} and
12113 @code{:LaTeX-fragments} options, respectively @code{nil} and @code{t} in the
12114 @LaTeX{} export. See @code{org-export-plist-vars} to check this list of
12119 @vindex org-publish-project-alist
12120 When a property is given a value in @code{org-publish-project-alist},
12121 its setting overrides the value of the corresponding user variable (if
12122 any) during publishing. Options set within a file (@pxref{Export
12123 options}), however, override everything.
12125 @node Publishing links, Sitemap, Publishing options, Configuration
12126 @subsection Links between published files
12127 @cindex links, publishing
12129 To create a link from one Org file to another, you would use
12130 something like @samp{[[file:foo.org][The foo]]} or simply
12131 @samp{file:foo.org.} (@pxref{Hyperlinks}). When published, this link
12132 becomes a link to @file{foo.html}. In this way, you can interlink the
12133 pages of your "org web" project and the links will work as expected when
12134 you publish them to HTML. If you also publish the Org source file and want
12135 to link to that, use an @code{http:} link instead of a @code{file:} link,
12136 because @code{file:} links are converted to link to the corresponding
12139 You may also link to related files, such as images. Provided you are careful
12140 with relative file names, and provided you have also configured Org to upload
12141 the related files, these links will work too. See @ref{Complex example}, for
12142 an example of this usage.
12144 Sometimes an Org file to be published may contain links that are
12145 only valid in your production environment, but not in the publishing
12146 location. In this case, use the property
12148 @multitable @columnfractions 0.4 0.6
12149 @item @code{:link-validation-function}
12150 @tab Function to validate links
12154 to define a function for checking link validity. This function must
12155 accept two arguments, the file name and a directory relative to which
12156 the file name is interpreted in the production environment. If this
12157 function returns @code{nil}, then the HTML generator will only insert a
12158 description into the HTML file, but no link. One option for this
12159 function is @code{org-publish-validate-link} which checks if the given
12160 file is part of any project in @code{org-publish-project-alist}.
12162 @node Sitemap, Generating an index, Publishing links, Configuration
12163 @subsection Generating a sitemap
12164 @cindex sitemap, of published pages
12166 The following properties may be used to control publishing of
12167 a map of files for a given project.
12169 @multitable @columnfractions 0.35 0.65
12170 @item @code{:auto-sitemap}
12171 @tab When non-nil, publish a sitemap during @code{org-publish-current-project}
12172 or @code{org-publish-all}.
12174 @item @code{:sitemap-filename}
12175 @tab Filename for output of sitemap. Defaults to @file{sitemap.org} (which
12176 becomes @file{sitemap.html}).
12178 @item @code{:sitemap-title}
12179 @tab Title of sitemap page. Defaults to name of file.
12181 @item @code{:sitemap-function}
12182 @tab Plug-in function to use for generation of the sitemap.
12183 Defaults to @code{org-publish-org-sitemap}, which generates a plain list
12184 of links to all files in the project.
12186 @item @code{:sitemap-sort-folders}
12187 @tab Where folders should appear in the sitemap. Set this to @code{first}
12188 (default) or @code{last} to display folders first or last,
12189 respectively. Any other value will mix files and folders.
12191 @item @code{:sitemap-sort-files}
12192 @tab How the files are sorted in the site map. Set this to
12193 @code{alphabetically} (default), @code{chronologically} or
12194 @code{anti-chronologically}. @code{chronologically} sorts the files with
12195 older date first while @code{anti-chronologically} sorts the files with newer
12196 date first. @code{alphabetically} sorts the files alphabetically. The date of
12197 a file is retrieved with @code{org-publish-find-date}.
12199 @item @code{:sitemap-ignore-case}
12200 @tab Should sorting be case-sensitive? Default @code{nil}.
12202 @item @code{:sitemap-file-entry-format}
12203 @tab With this option one can tell how a sitemap's entry is formatted in the
12204 sitemap. This is a format string with some escape sequences: @code{%t} stands
12205 for the title of the file, @code{%a} stands for the author of the file and
12206 @code{%d} stands for the date of the file. The date is retrieved with the
12207 @code{org-publish-find-date} function and formatted with
12208 @code{org-publish-sitemap-date-format}. Default @code{%t}.
12210 @item @code{:sitemap-date-format}
12211 @tab Format string for the @code{format-time-string} function that tells how
12212 a sitemap entry's date is to be formatted. This property bypasses
12213 @code{org-publish-sitemap-date-format} which defaults to @code{%Y-%m-%d}.
12215 @item @code{:sitemap-sans-extension}
12216 @tab When non-nil, remove filenames' extensions from the generated sitemap.
12217 Useful to have cool URIs (see @uref{http://www.w3.org/Provider/Style/URI}).
12218 Defaults to @code{nil}.
12222 @node Generating an index, , Sitemap, Configuration
12223 @subsection Generating an index
12224 @cindex index, in a publishing project
12226 Org mode can generate an index across the files of a publishing project.
12228 @multitable @columnfractions 0.25 0.75
12229 @item @code{:makeindex}
12230 @tab When non-nil, generate in index in the file @file{theindex.org} and
12231 publish it as @file{theindex.html}.
12234 The file will be created when first publishing a project with the
12235 @code{:makeindex} set. The file only contains a statement @code{#+include:
12236 "theindex.inc"}. You can then build around this include statement by adding
12237 a title, style information, etc.
12239 @node Uploading files, Sample configuration, Configuration, Publishing
12240 @section Uploading files
12244 For those people already utilizing third party sync tools such as
12245 @command{rsync} or @command{unison}, it might be preferable not to use the built in
12246 @i{remote} publishing facilities of Org mode which rely heavily on
12247 Tramp. Tramp, while very useful and powerful, tends not to be
12248 so efficient for multiple file transfer and has been known to cause problems
12251 Specialized synchronization utilities offer several advantages. In addition
12252 to timestamp comparison, they also do content and permissions/attribute
12253 checks. For this reason you might prefer to publish your web to a local
12254 directory (possibly even @i{in place} with your Org files) and then use
12255 @file{unison} or @file{rsync} to do the synchronization with the remote host.
12257 Since Unison (for example) can be configured as to which files to transfer to
12258 a certain remote destination, it can greatly simplify the project publishing
12259 definition. Simply keep all files in the correct location, process your Org
12260 files with @code{org-publish} and let the synchronization tool do the rest.
12261 You do not need, in this scenario, to include attachments such as @file{jpg},
12262 @file{css} or @file{gif} files in the project definition since the 3rd party
12265 Publishing to a local directory is also much faster than to a remote one, so
12266 that you can afford more easily to republish entire projects. If you set
12267 @code{org-publish-use-timestamps-flag} to @code{nil}, you gain the main
12268 benefit of re-including any changed external files such as source example
12269 files you might include with @code{#+INCLUDE}. The timestamp mechanism in
12270 Org is not smart enough to detect if included files have been modified.
12272 @node Sample configuration, Triggering publication, Uploading files, Publishing
12273 @section Sample configuration
12275 Below we provide two example configurations. The first one is a simple
12276 project publishing only a set of Org files. The second example is
12277 more complex, with a multi-component project.
12280 * Simple example:: One-component publishing
12281 * Complex example:: A multi-component publishing example
12284 @node Simple example, Complex example, Sample configuration, Sample configuration
12285 @subsection Example: simple publishing configuration
12287 This example publishes a set of Org files to the @file{public_html}
12288 directory on the local machine.
12291 (setq org-publish-project-alist
12293 :base-directory "~/org/"
12294 :publishing-directory "~/public_html"
12295 :section-numbers nil
12296 :table-of-contents nil
12297 :style "<link rel=\"stylesheet\"
12298 href=\"../other/mystyle.css\"
12299 type=\"text/css\"/>")))
12302 @node Complex example, , Simple example, Sample configuration
12303 @subsection Example: complex publishing configuration
12305 This more complicated example publishes an entire website, including
12306 Org files converted to HTML, image files, Emacs Lisp source code, and
12307 style sheets. The publishing directory is remote and private files are
12310 To ensure that links are preserved, care should be taken to replicate
12311 your directory structure on the web server, and to use relative file
12312 paths. For example, if your Org files are kept in @file{~/org} and your
12313 publishable images in @file{~/images}, you would link to an image with
12316 file:../images/myimage.png
12319 On the web server, the relative path to the image should be the
12320 same. You can accomplish this by setting up an "images" folder in the
12321 right place on the web server, and publishing images to it.
12324 (setq org-publish-project-alist
12326 :base-directory "~/org/"
12327 :base-extension "org"
12328 :publishing-directory "/ssh:user@@host:~/html/notebook/"
12329 :publishing-function org-publish-org-to-html
12330 :exclude "PrivatePage.org" ;; regexp
12332 :section-numbers nil
12333 :table-of-contents nil
12334 :style "<link rel=\"stylesheet\"
12335 href=\"../other/mystyle.css\" type=\"text/css\"/>"
12339 :base-directory "~/images/"
12340 :base-extension "jpg\\|gif\\|png"
12341 :publishing-directory "/ssh:user@@host:~/html/images/"
12342 :publishing-function org-publish-attachment)
12345 :base-directory "~/other/"
12346 :base-extension "css\\|el"
12347 :publishing-directory "/ssh:user@@host:~/html/other/"
12348 :publishing-function org-publish-attachment)
12349 ("website" :components ("orgfiles" "images" "other"))))
12352 @node Triggering publication, , Sample configuration, Publishing
12353 @section Triggering publication
12355 Once properly configured, Org can publish with the following commands:
12358 @orgcmd{C-c C-e X,org-publish}
12359 Prompt for a specific project and publish all files that belong to it.
12360 @orgcmd{C-c C-e P,org-publish-current-project}
12361 Publish the project containing the current file.
12362 @orgcmd{C-c C-e F,org-publish-current-file}
12363 Publish only the current file.
12364 @orgcmd{C-c C-e E,org-publish-all}
12365 Publish every project.
12368 @vindex org-publish-use-timestamps-flag
12369 Org uses timestamps to track when a file has changed. The above functions
12370 normally only publish changed files. You can override this and force
12371 publishing of all files by giving a prefix argument to any of the commands
12372 above, or by customizing the variable @code{org-publish-use-timestamps-flag}.
12373 This may be necessary in particular if files include other files via
12374 @code{#+SETUPFILE:} or @code{#+INCLUDE:}.
12376 @comment node-name, next, previous, up
12377 @comment Working With Source Code, Miscellaneous, Publishing, Top
12379 @node Working With Source Code, Miscellaneous, Publishing, Top
12380 @chapter Working with source code
12381 @cindex Schulte, Eric
12382 @cindex Davison, Dan
12383 @cindex source code, working with
12385 Source code can be included in Org mode documents using a @samp{src} block,
12389 #+BEGIN_SRC emacs-lisp
12390 (defun org-xor (a b)
12396 Org mode provides a number of features for working with live source code,
12397 including editing of code blocks in their native major-mode, evaluation of
12398 code blocks, converting code blocks into source files (known as @dfn{tangling}
12399 in literate programming), and exporting code blocks and their
12400 results in several formats. This functionality was contributed by Eric
12401 Schulte and Dan Davison, and was originally named Org-babel.
12403 The following sections describe Org mode's code block handling facilities.
12406 * Structure of code blocks:: Code block syntax described
12407 * Editing source code:: Language major-mode editing
12408 * Exporting code blocks:: Export contents and/or results
12409 * Extracting source code:: Create pure source code files
12410 * Evaluating code blocks:: Place results of evaluation in the Org mode buffer
12411 * Library of Babel:: Use and contribute to a library of useful code blocks
12412 * Languages:: List of supported code block languages
12413 * Header arguments:: Configure code block functionality
12414 * Results of evaluation:: How evaluation results are handled
12415 * Noweb reference syntax:: Literate programming in Org mode
12416 * Key bindings and useful functions:: Work quickly with code blocks
12417 * Batch execution:: Call functions from the command line
12420 @comment node-name, next, previous, up
12421 @comment Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
12423 @node Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
12424 @section Structure of code blocks
12425 @cindex code block, structure
12426 @cindex source code, block structure
12428 @cindex #+BEGIN_SRC
12430 Live code blocks can be specified with a @samp{src} block or
12431 inline.@footnote{Note that @samp{src} blocks may be inserted using Org mode's
12432 @ref{Easy Templates} system} The structure of a @samp{src} block is
12436 #+BEGIN_SRC <language> <switches> <header arguments>
12441 The @code{#+NAME:} line is optional, and can be used to name the code
12442 block. Live code blocks require that a language be specified on the
12443 @code{#+BEGIN_SRC} line. Switches and header arguments are optional.
12444 @cindex source code, inline
12446 Live code blocks can also be specified inline using
12449 src_<language>@{<body>@}
12455 src_<language>[<header arguments>]@{<body>@}
12459 @item <#+NAME: name>
12460 This line associates a name with the code block. This is similar to the
12461 @code{#+TBLNAME: NAME} lines that can be used to name tables in Org mode
12462 files. Referencing the name of a code block makes it possible to evaluate
12463 the block from other places in the file, from other files, or from Org mode
12464 table formulas (see @ref{The spreadsheet}). Names are assumed to be unique
12465 and the behavior of Org mode when two or more blocks share the same name is
12469 The language of the code in the block (see @ref{Languages}).
12470 @cindex source code, language
12472 Optional switches control code block export (see the discussion of switches in
12473 @ref{Literal examples})
12474 @cindex source code, switches
12475 @item <header arguments>
12476 Optional header arguments control many aspects of evaluation, export and
12477 tangling of code blocks (see @ref{Header arguments}).
12478 Header arguments can also be set on a per-buffer or per-subtree
12479 basis using properties.
12480 @item source code, header arguments
12482 Source code in the specified language.
12485 @comment node-name, next, previous, up
12486 @comment Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
12488 @node Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
12489 @section Editing source code
12490 @cindex code block, editing
12491 @cindex source code, editing
12494 Use @kbd{C-c '} to edit the current code block. This brings up
12495 a language major-mode edit buffer containing the body of the code
12496 block. Saving this buffer will write the new contents back to the Org
12497 buffer. Use @kbd{C-c '} again to exit.
12499 The @code{org-src-mode} minor mode will be active in the edit buffer. The
12500 following variables can be used to configure the behavior of the edit
12501 buffer. See also the customization group @code{org-edit-structure} for
12502 further configuration options.
12505 @item org-src-lang-modes
12506 If an Emacs major-mode named @code{<lang>-mode} exists, where
12507 @code{<lang>} is the language named in the header line of the code block,
12508 then the edit buffer will be placed in that major-mode. This variable
12509 can be used to map arbitrary language names to existing major modes.
12510 @item org-src-window-setup
12511 Controls the way Emacs windows are rearranged when the edit buffer is created.
12512 @item org-src-preserve-indentation
12513 This variable is especially useful for tangling languages such as
12514 Python, in which whitespace indentation in the output is critical.
12515 @item org-src-ask-before-returning-to-edit-buffer
12516 By default, Org will ask before returning to an open edit buffer. Set this
12517 variable to nil to switch without asking.
12520 To turn on native code fontification in the @emph{Org} buffer, configure the
12521 variable @code{org-src-fontify-natively}.
12523 @comment node-name, next, previous, up
12524 @comment Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
12526 @node Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
12527 @section Exporting code blocks
12528 @cindex code block, exporting
12529 @cindex source code, exporting
12531 It is possible to export the @emph{code} of code blocks, the @emph{results}
12532 of code block evaluation, @emph{both} the code and the results of code block
12533 evaluation, or @emph{none}. For most languages, the default exports code.
12534 However, for some languages (e.g.@: @code{ditaa}) the default exports the
12535 results of code block evaluation. For information on exporting code block
12536 bodies, see @ref{Literal examples}.
12538 The @code{:exports} header argument can be used to specify export
12541 @subsubheading Header arguments:
12543 @item :exports code
12544 The default in most languages. The body of the code block is exported, as
12545 described in @ref{Literal examples}.
12546 @item :exports results
12547 The code block will be evaluated and the results will be placed in the
12548 Org mode buffer for export, either updating previous results of the code
12549 block located anywhere in the buffer or, if no previous results exist,
12550 placing the results immediately after the code block. The body of the code
12551 block will not be exported.
12552 @item :exports both
12553 Both the code block and its results will be exported.
12554 @item :exports none
12555 Neither the code block nor its results will be exported.
12558 It is possible to inhibit the evaluation of code blocks during export.
12559 Setting the @code{org-export-babel-evaluate} variable to @code{nil} will
12560 ensure that no code blocks are evaluated as part of the export process. This
12561 can be useful in situations where potentially untrusted Org mode files are
12562 exported in an automated fashion, for example when Org mode is used as the
12563 markup language for a wiki.
12565 @comment node-name, next, previous, up
12566 @comment Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
12567 @node Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
12568 @section Extracting source code
12570 @cindex source code, extracting
12571 @cindex code block, extracting source code
12573 Creating pure source code files by extracting code from source blocks is
12574 referred to as ``tangling''---a term adopted from the literate programming
12575 community. During ``tangling'' of code blocks their bodies are expanded
12576 using @code{org-babel-expand-src-block} which can expand both variable and
12577 ``noweb'' style references (see @ref{Noweb reference syntax}).
12579 @subsubheading Header arguments
12582 The default. The code block is not included in the tangled output.
12584 Include the code block in the tangled output. The output file name is the
12585 name of the org file with the extension @samp{.org} replaced by the extension
12586 for the block language.
12587 @item :tangle filename
12588 Include the code block in the tangled output to file @samp{filename}.
12592 @subsubheading Functions
12594 @item org-babel-tangle
12595 Tangle the current file. Bound to @kbd{C-c C-v t}.
12596 @item org-babel-tangle-file
12597 Choose a file to tangle. Bound to @kbd{C-c C-v f}.
12600 @subsubheading Hooks
12602 @item org-babel-post-tangle-hook
12603 This hook is run from within code files tangled by @code{org-babel-tangle}.
12604 Example applications could include post-processing, compilation or evaluation
12605 of tangled code files.
12608 @node Evaluating code blocks, Library of Babel, Extracting source code, Working With Source Code
12609 @section Evaluating code blocks
12610 @cindex code block, evaluating
12611 @cindex source code, evaluating
12613 Code blocks can be evaluated@footnote{Whenever code is evaluated there is a
12614 potential for that code to do harm. Org mode provides safeguards to ensure
12615 that code is only evaluated after explicit confirmation from the user. For
12616 information on these safeguards (and on how to disable them) see @ref{Code
12617 evaluation security}.} and the results of evaluation optionally placed in the
12618 Org mode buffer. By default, the evaluation facility is only enabled for
12619 Lisp code blocks specified as @code{emacs-lisp}. However, souce code blocks
12620 in many languages can be evaluated within Org mode (see @ref{Languages} for a
12621 list of supported languages and @ref{Structure of code blocks} for
12622 information on the syntax used to define a code block).
12625 There are a number of ways to evaluate code blocks. The simplest is to press
12626 @kbd{C-c C-c} or @kbd{C-c C-v e} with the point on a code block@footnote{The
12627 @code{org-babel-no-eval-on-ctrl-c-ctrl-c} variable can be used to remove code
12628 evaluation from the @kbd{C-c C-c} key binding.}. This will call the
12629 @code{org-babel-execute-src-block} function to evaluate the block and insert
12630 its results into the Org mode buffer.
12633 It is also possible to evaluate named code blocks from anywhere in an
12634 Org mode buffer or an Org mode table. Live code blocks located in the current
12635 Org mode buffer or in the ``Library of Babel'' (see @ref{Library of Babel})
12636 can be executed. Named code blocks can be executed with a separate
12637 @code{#+CALL:} line or inline within a block of text.
12639 The syntax of the @code{#+CALL:} line is
12642 #+CALL: <name>(<arguments>)
12643 #+CALL: <name>[<inside header arguments>](<arguments>) <end header arguments>
12646 The syntax for inline evaluation of named code blocks is
12649 ... call_<name>(<arguments>) ...
12650 ... call_<name>[<inside header arguments>](<arguments>)[<end header arguments>] ...
12655 The name of the code block to be evaluated (see @ref{Structure of code blocks}).
12657 Arguments specified in this section will be passed to the code block. These
12658 arguments use standard function call syntax, rather than
12659 header argument syntax. For example, a @code{#+CALL:} line that passes the
12660 number four to a code block named @code{double}, which declares the header
12661 argument @code{:var n=2}, would be written as @code{#+CALL: double(n=4)}.
12662 @item <inside header arguments>
12663 Inside header arguments are passed through and applied to the named code
12664 block. These arguments use header argument syntax rather than standard
12665 function call syntax. Inside header arguments affect how the code block is
12666 evaluated. For example, @code{[:results output]} will collect the results of
12667 everything printed to @code{STDOUT} during execution of the code block.
12668 @item <end header arguments>
12669 End header arguments are applied to the calling instance and do not affect
12670 evaluation of the named code block. They affect how the results are
12671 incorporated into the Org mode buffer and how the call line is exported. For
12672 example, @code{:results html} will insert the results of the call line
12673 evaluation in the Org buffer, wrapped in a @code{BEGIN_HTML:} block.
12675 For more examples of passing header arguments to @code{#+CALL:} lines see
12676 @ref{Header arguments in function calls}.
12679 @node Library of Babel, Languages, Evaluating code blocks, Working With Source Code
12680 @section Library of Babel
12681 @cindex babel, library of
12682 @cindex source code, library
12683 @cindex code block, library
12685 The ``Library of Babel'' consists of code blocks that can be called from any
12686 Org mode file. Code blocks defined in the ``Library of Babel'' can be called
12687 remotely as if they were in the current Org mode buffer (see @ref{Evaluating
12688 code blocks} for information on the syntax of remote code block evaluation).
12691 The central repository of code blocks in the ``Library of Babel'' is housed
12692 in an Org mode file located in the @samp{contrib} directory of Org mode.
12694 Users can add code blocks they believe to be generally useful to their
12695 ``Library of Babel.'' The code blocks can be stored in any Org mode file and
12696 then loaded into the library with @code{org-babel-lob-ingest}.
12700 Code blocks located in any Org mode file can be loaded into the ``Library of
12701 Babel'' with the @code{org-babel-lob-ingest} function, bound to @kbd{C-c C-v
12704 @node Languages, Header arguments, Library of Babel, Working With Source Code
12706 @cindex babel, languages
12707 @cindex source code, languages
12708 @cindex code block, languages
12710 Code blocks in the following languages are supported.
12712 @multitable @columnfractions 0.28 0.3 0.22 0.2
12713 @item @b{Language} @tab @b{Identifier} @tab @b{Language} @tab @b{Identifier}
12714 @item Asymptote @tab asymptote @tab Awk @tab awk
12715 @item Emacs Calc @tab calc @tab C @tab C
12716 @item C++ @tab C++ @tab Clojure @tab clojure
12717 @item CSS @tab css @tab ditaa @tab ditaa
12718 @item Graphviz @tab dot @tab Emacs Lisp @tab emacs-lisp
12719 @item gnuplot @tab gnuplot @tab Haskell @tab haskell
12720 @item Java @tab java @tab @tab
12721 @item Javascript @tab js @tab LaTeX @tab latex
12722 @item Ledger @tab ledger @tab Lisp @tab lisp
12723 @item Lilypond @tab lilypond @tab MATLAB @tab matlab
12724 @item Mscgen @tab mscgen @tab Objective Caml @tab ocaml
12725 @item Octave @tab octave @tab Org mode @tab org
12726 @item Oz @tab oz @tab Perl @tab perl
12727 @item Plantuml @tab plantuml @tab Python @tab python
12728 @item R @tab R @tab Ruby @tab ruby
12729 @item Sass @tab sass @tab Scheme @tab scheme
12730 @item GNU Screen @tab screen @tab shell @tab sh
12731 @item SQL @tab sql @tab SQLite @tab sqlite
12734 Language-specific documentation is available for some languages. If
12735 available, it can be found at
12736 @uref{http://orgmode.org/worg/org-contrib/babel/languages}.
12738 The @code{org-babel-load-languages} controls which languages are enabled for
12739 evaluation (by default only @code{emacs-lisp} is enabled). This variable can
12740 be set using the customization interface or by adding code like the following
12741 to your emacs configuration.
12744 The following disables @code{emacs-lisp} evaluation and enables evaluation of
12745 @code{R} code blocks.
12749 (org-babel-do-load-languages
12750 'org-babel-load-languages
12751 '((emacs-lisp . nil)
12755 It is also possible to enable support for a language by loading the related
12756 elisp file with @code{require}.
12759 The following adds support for evaluating @code{clojure} code blocks.
12763 (require 'ob-clojure)
12766 @node Header arguments, Results of evaluation, Languages, Working With Source Code
12767 @section Header arguments
12768 @cindex code block, header arguments
12769 @cindex source code, block header arguments
12771 Code block functionality can be configured with header arguments. This
12772 section provides an overview of the use of header arguments, and then
12773 describes each header argument in detail.
12776 * Using header arguments:: Different ways to set header arguments
12777 * Specific header arguments:: List of header arguments
12780 @node Using header arguments, Specific header arguments, Header arguments, Header arguments
12781 @subsection Using header arguments
12783 The values of header arguments can be set in six different ways, each more
12784 specific (and having higher priority) than the last.
12786 * System-wide header arguments:: Set global default values
12787 * Language-specific header arguments:: Set default values by language
12788 * Buffer-wide header arguments:: Set default values for a specific buffer
12789 * Header arguments in Org mode properties:: Set default values for a buffer or heading
12790 * Code block specific header arguments:: The most common way to set values
12791 * Header arguments in function calls:: The most specific level
12795 @node System-wide header arguments, Language-specific header arguments, Using header arguments, Using header arguments
12796 @subsubheading System-wide header arguments
12797 @vindex org-babel-default-header-args
12798 System-wide values of header arguments can be specified by customizing the
12799 @code{org-babel-default-header-args} variable:
12803 :results => "replace"
12810 @c org-babel-default-header-args is a variable defined in `org-babel.el'.
12812 @c ((:session . "none")
12813 @c (:results . "replace")
12814 @c (:exports . "code")
12816 @c (:noweb . "no"))
12820 @c Default arguments to use when evaluating a code block.
12823 For example, the following example could be used to set the default value of
12824 @code{:noweb} header arguments to @code{yes}. This would have the effect of
12825 expanding @code{:noweb} references by default when evaluating source code
12829 (setq org-babel-default-header-args
12830 (cons '(:noweb . "yes")
12831 (assq-delete-all :noweb org-babel-default-header-args)))
12834 @node Language-specific header arguments, Buffer-wide header arguments, System-wide header arguments, Using header arguments
12835 @subsubheading Language-specific header arguments
12836 Each language can define its own set of default header arguments. See the
12837 language-specific documentation available online at
12838 @uref{http://orgmode.org/worg/org-contrib/babel}.
12840 @node Buffer-wide header arguments, Header arguments in Org mode properties, Language-specific header arguments, Using header arguments
12841 @subsubheading Buffer-wide header arguments
12842 Buffer-wide header arguments may be specified as properties through the use
12843 of @code{#+PROPERTY:} lines placed anywhere in an Org mode file (see
12844 @ref{Property syntax}).
12846 For example the following would set @code{session} to @code{*R*}, and
12847 @code{results} to @code{silent} for every code block in the buffer, ensuring
12848 that all execution took place in the same session, and no results would be
12849 inserted into the buffer.
12852 #+PROPERTY: session *R*
12853 #+PROPERTY: results silent
12856 @node Header arguments in Org mode properties, Code block specific header arguments, Buffer-wide header arguments, Using header arguments
12857 @subsubheading Header arguments in Org mode properties
12859 Header arguments are also read from Org mode properties (see @ref{Property
12860 syntax}), which can be set on a buffer-wide or per-heading basis. An example
12861 of setting a header argument for all code blocks in a buffer is
12864 #+PROPERTY: tangle yes
12867 @vindex org-use-property-inheritance
12868 When properties are used to set default header arguments, they are looked up
12869 with inheritance, regardless of the value of
12870 @code{org-use-property-inheritance}. In the following example the value of
12871 the @code{:cache} header argument will default to @code{yes} in all code
12872 blocks in the subtree rooted at the following heading:
12882 @vindex org-babel-default-header-args
12883 Properties defined in this way override the properties set in
12884 @code{org-babel-default-header-args}. It is convenient to use the
12885 @code{org-set-property} function bound to @kbd{C-c C-x p} to set properties
12886 in Org mode documents.
12888 @node Code block specific header arguments, Header arguments in function calls, Header arguments in Org mode properties, Using header arguments
12889 @subsubheading Code block specific header arguments
12891 The most common way to assign values to header arguments is at the
12892 code block level. This can be done by listing a sequence of header
12893 arguments and their values as part of the @code{#+BEGIN_SRC} line.
12894 Properties set in this way override both the values of
12895 @code{org-babel-default-header-args} and header arguments specified as
12896 properties. In the following example, the @code{:results} header argument
12897 is set to @code{silent}, meaning the results of execution will not be
12898 inserted in the buffer, and the @code{:exports} header argument is set to
12899 @code{code}, meaning only the body of the code block will be
12900 preserved on export to HTML or LaTeX.
12904 #+BEGIN_SRC haskell :results silent :exports code :var n=0
12906 fac n = n * fac (n-1)
12909 Similarly, it is possible to set header arguments for inline code blocks
12912 src_haskell[:exports both]@{fac 5@}
12915 Code block header arguments can span multiple lines using @code{#+HEADER:} or
12916 @code{#+HEADERS:} lines preceding a code block or nested between the
12917 @code{#+NAME:} line and the @code{#+BEGIN_SRC} line of a named code block.
12921 Multi-line header arguments on an un-named code block:
12923 #+HEADERS: :var data1=1
12924 #+BEGIN_SRC emacs-lisp :var data2=2
12925 (message "data1:%S, data2:%S" data1 data2)
12932 Multi-line header arguments on a named code block:
12934 #+NAME: named-block
12935 #+HEADER: :var data=2
12936 #+BEGIN_SRC emacs-lisp
12937 (message "data:%S" data)
12940 #+results: named-block
12944 @node Header arguments in function calls, , Code block specific header arguments, Using header arguments
12945 @comment node-name, next, previous, up
12946 @subsubheading Header arguments in function calls
12948 At the most specific level, header arguments for ``Library of Babel'' or
12949 @code{#+CALL:} lines can be set as shown in the two examples below. For more
12950 information on the structure of @code{#+CALL:} lines see @ref{Evaluating code
12953 The following will apply the @code{:exports results} header argument to the
12954 evaluation of the @code{#+CALL:} line.
12956 #+CALL: factorial(n=5) :exports results
12959 The following will apply the @code{:session special} header argument to the
12960 evaluation of the @code{factorial} code block.
12962 #+CALL: factorial[:session special](n=5)
12965 @node Specific header arguments, , Using header arguments, Header arguments
12966 @subsection Specific header arguments
12967 Header arguments consist of an initial colon followed by the name of the
12968 argument in lowercase letters. The following header arguments are defined:
12971 * var:: Pass arguments to code blocks
12972 * results:: Specify the type of results and how they will
12973 be collected and handled
12974 * file:: Specify a path for file output
12975 * dir:: Specify the default (possibly remote)
12976 directory for code block execution
12977 * exports:: Export code and/or results
12978 * tangle:: Toggle tangling and specify file name
12979 * mkdirp:: Toggle creation of parent directories of target
12980 files during tangling
12981 * comments:: Toggle insertion of comments in tangled
12983 * padline:: Control insertion of padding lines in tangled
12985 * no-expand:: Turn off variable assignment and noweb
12986 expansion during tangling
12987 * session:: Preserve the state of code evaluation
12988 * noweb:: Toggle expansion of noweb references
12989 * noweb-ref:: Specify block's noweb reference resolution target
12990 * cache:: Avoid re-evaluating unchanged code blocks
12991 * sep:: Delimiter for writing tabular results outside Org
12992 * hlines:: Handle horizontal lines in tables
12993 * colnames:: Handle column names in tables
12994 * rownames:: Handle row names in tables
12995 * shebang:: Make tangled files executable
12996 * eval:: Limit evaluation of specific code blocks
12999 Additional header arguments are defined on a language-specific basis, see
13002 @node var, results, Specific header arguments, Specific header arguments
13003 @subsubsection @code{:var}
13004 The @code{:var} header argument is used to pass arguments to code blocks.
13005 The specifics of how arguments are included in a code block vary by language;
13006 these are addressed in the language-specific documentation. However, the
13007 syntax used to specify arguments is the same across all languages. In every
13008 case, variables require a default value when they are declared.
13010 The values passed to arguments can either be literal values, references, or
13011 Emacs Lisp code (see @ref{var, Emacs Lisp evaluation of variables}). References
13012 include anything in the Org mode file that takes a @code{#+NAME:},
13013 @code{#+TBLNAME:}, or @code{#+RESULTS:} line. This includes tables, lists,
13014 @code{#+BEGIN_EXAMPLE} blocks, other code blocks, and the results of other
13017 Argument values can be indexed in a manner similar to arrays (see @ref{var,
13018 Indexable variable values}).
13020 The following syntax is used to pass arguments to code blocks using the
13021 @code{:var} header argument.
13027 The argument, @code{assign}, can either be a literal value, such as a string
13028 @samp{"string"} or a number @samp{9}, or a reference to a table, a list, a
13029 literal example, another code block (with or without arguments), or the
13030 results of evaluating another code block.
13032 Here are examples of passing values by reference:
13037 an Org mode table named with either a @code{#+NAME:} or @code{#+TBLNAME:} line
13039 #+TBLNAME: example-table
13045 #+NAME: table-length
13046 #+BEGIN_SRC emacs-lisp :var table=example-table
13050 #+results: table-length
13055 a simple list named with a @code{#+NAME:} line (note that nesting is not
13056 carried through to the source code block)
13059 #+NAME: example-list
13065 #+BEGIN_SRC emacs-lisp :var x=example-list
13073 @item code block without arguments
13074 a code block name (from the example above), as assigned by @code{#+NAME:},
13075 optionally followed by parentheses
13078 #+BEGIN_SRC emacs-lisp :var length=table-length()
13086 @item code block with arguments
13087 a code block name, as assigned by @code{#+NAME:}, followed by parentheses and
13088 optional arguments passed within the parentheses following the
13089 code block name using standard function call syntax
13093 #+BEGIN_SRC emacs-lisp :var input=8
13101 #+BEGIN_SRC emacs-lisp :var input=double(input=1)
13109 @item literal example
13110 a literal example block named with a @code{#+NAME:} line
13113 #+NAME: literal-example
13119 #+NAME: read-literal-example
13120 #+BEGIN_SRC emacs-lisp :var x=literal-example
13121 (concatenate 'string x " for you.")
13124 #+results: read-literal-example
13125 : A literal example
13126 : on two lines for you.
13132 @subsubheading Alternate argument syntax
13133 It is also possible to specify arguments in a potentially more natural way
13134 using the @code{#+NAME:} line of a code block. As in the following
13135 example, arguments can be packed inside of parentheses, separated by commas,
13136 following the source name.
13139 #+NAME: double(input=0, x=2)
13140 #+BEGIN_SRC emacs-lisp
13145 @subsubheading Indexable variable values
13146 It is possible to reference portions of variable values by ``indexing'' into
13147 the variables. Indexes are 0 based with negative values counting back from
13148 the end. If an index is separated by @code{,}s then each subsequent section
13149 will index into the next deepest nesting or dimension of the value. Note
13150 that this indexing occurs @emph{before} other table related header arguments
13151 like @code{:hlines}, @code{:colnames} and @code{:rownames} are applied. The
13152 following example assigns the last cell of the first row the table
13153 @code{example-table} to the variable @code{data}:
13156 #+NAME: example-table
13162 #+BEGIN_SRC emacs-lisp :var data=example-table[0,-1]
13170 Ranges of variable values can be referenced using two integers separated by a
13171 @code{:}, in which case the entire inclusive range is referenced. For
13172 example the following assigns the middle three rows of @code{example-table}
13176 #+NAME: example-table
13183 #+BEGIN_SRC emacs-lisp :var data=example-table[1:3]
13193 Additionally, an empty index, or the single character @code{*}, are both
13194 interpreted to mean the entire range and as such are equivalent to
13195 @code{0:-1}, as shown in the following example in which the entire first
13196 column is referenced.
13199 #+NAME: example-table
13205 #+BEGIN_SRC emacs-lisp :var data=example-table[,0]
13213 It is possible to index into the results of code blocks as well as tables.
13214 Any number of dimensions can be indexed. Dimensions are separated from one
13215 another by commas, as shown in the following example.
13219 #+BEGIN_SRC emacs-lisp
13220 '(((1 2 3) (4 5 6) (7 8 9))
13221 ((10 11 12) (13 14 15) (16 17 18))
13222 ((19 20 21) (22 23 24) (25 26 27)))
13225 #+BEGIN_SRC emacs-lisp :var data=3D[1,,1]
13233 @subsubheading Emacs Lisp evaluation of variables
13235 Emacs lisp code can be used to initialize variable values. When a variable
13236 value starts with @code{(}, @code{[}, @code{'} or @code{`} it will be
13237 evaluated as Emacs Lisp and the result of the evaluation will be assigned as
13238 the variable value. The following example demonstrates use of this
13239 evaluation to reliably pass the file-name of the Org mode buffer to a code
13240 block---note that evaluation of header arguments is guaranteed to take place
13241 in the original Org mode file, while there is no such guarantee for
13242 evaluation of the code block body.
13245 #+BEGIN_SRC sh :var filename=(buffer-file-name) :exports both
13250 Note that values read from tables and lists will not be evaluated as
13251 Emacs Lisp, as shown in the following example.
13257 #+HEADERS: :var data=table[0,0]
13266 @node results, file, var, Specific header arguments
13267 @subsubsection @code{:results}
13269 There are three classes of @code{:results} header argument. Only one option
13270 per class may be supplied per code block.
13274 @b{collection} header arguments specify how the results should be collected
13275 from the code block
13277 @b{type} header arguments specify what type of result the code block will
13278 return---which has implications for how they will be inserted into the
13281 @b{handling} header arguments specify how the results of evaluating the code
13282 block should be handled.
13285 @subsubheading Collection
13286 The following options are mutually exclusive, and specify how the results
13287 should be collected from the code block.
13291 This is the default. The result is the value of the last statement in the
13292 code block. This header argument places the evaluation in functional
13293 mode. Note that in some languages, e.g., Python, use of this result type
13294 requires that a @code{return} statement be included in the body of the source
13295 code block. E.g., @code{:results value}.
13296 @item @code{output}
13297 The result is the collection of everything printed to STDOUT during the
13298 execution of the code block. This header argument places the
13299 evaluation in scripting mode. E.g., @code{:results output}.
13302 @subsubheading Type
13304 The following options are mutually exclusive and specify what type of results
13305 the code block will return. By default, results are inserted as either a
13306 table or scalar depending on their value.
13309 @item @code{table}, @code{vector}
13310 The results should be interpreted as an Org mode table. If a single value is
13311 returned, it will be converted into a table with one row and one column.
13312 E.g., @code{:results value table}.
13314 The results should be interpreted as an Org mode list. If a single scalar
13315 value is returned it will be converted into a list with only one element.
13316 @item @code{scalar}, @code{verbatim}
13317 The results should be interpreted literally---they will not be
13318 converted into a table. The results will be inserted into the Org mode
13319 buffer as quoted text. E.g., @code{:results value verbatim}.
13321 The results will be interpreted as the path to a file, and will be inserted
13322 into the Org mode buffer as a file link. E.g., @code{:results value file}.
13323 @item @code{raw}, @code{org}
13324 The results are interpreted as raw Org mode code and are inserted directly
13325 into the buffer. If the results look like a table they will be aligned as
13326 such by Org mode. E.g., @code{:results value raw}.
13328 Results are assumed to be HTML and will be enclosed in a @code{begin_html}
13329 block. E.g., @code{:results value html}.
13331 Results assumed to be LaTeX and are enclosed in a @code{begin_latex} block.
13332 E.g., @code{:results value latex}.
13334 Result are assumed to be parsable code and are enclosed in a code block.
13335 E.g., @code{:results value code}.
13337 The result is converted to pretty-printed code and is enclosed in a code
13338 block. This option currently supports Emacs Lisp, Python, and Ruby. E.g.,
13339 @code{:results value pp}.
13341 The result is wrapped in a @code{begin_result} block. This can be useful for
13342 inserting @code{raw} or @code{org} syntax results in such a way that their
13343 extend is known and they can be automatically removed or replaced.
13346 @subsubheading Handling
13347 The following results options indicate what happens with the
13348 results once they are collected.
13351 @item @code{silent}
13352 The results will be echoed in the minibuffer but will not be inserted into
13353 the Org mode buffer. E.g., @code{:results output silent}.
13354 @item @code{replace}
13355 The default value. Any existing results will be removed, and the new results
13356 will be inserted into the Org mode buffer in their place. E.g.,
13357 @code{:results output replace}.
13358 @item @code{append}
13359 If there are pre-existing results of the code block then the new results will
13360 be appended to the existing results. Otherwise the new results will be
13361 inserted as with @code{replace}.
13362 @item @code{prepend}
13363 If there are pre-existing results of the code block then the new results will
13364 be prepended to the existing results. Otherwise the new results will be
13365 inserted as with @code{replace}.
13368 @node file, dir, results, Specific header arguments
13369 @subsubsection @code{:file}
13371 The header argument @code{:file} is used to specify an external file in which
13372 to save code block results. After code block evaluation an Org mode style
13373 @code{[[file:]]} link (see @ref{Link format}) to the file will be inserted
13374 into the Org mode buffer. Some languages including R, gnuplot, dot, and
13375 ditaa provide special handling of the @code{:file} header argument
13376 automatically wrapping the code block body in the boilerplate code required
13377 to save output to the specified file. This is often useful for saving
13378 graphical output of a code block to the specified file.
13380 The argument to @code{:file} should be either a string specifying the path to
13381 a file, or a list of two strings in which case the first element of the list
13382 should be the path to a file and the second a description for the link.
13384 @node dir, exports, file, Specific header arguments
13385 @subsubsection @code{:dir} and remote execution
13387 While the @code{:file} header argument can be used to specify the path to the
13388 output file, @code{:dir} specifies the default directory during code block
13389 execution. If it is absent, then the directory associated with the current
13390 buffer is used. In other words, supplying @code{:dir path} temporarily has
13391 the same effect as changing the current directory with @kbd{M-x cd path}, and
13392 then not supplying @code{:dir}. Under the surface, @code{:dir} simply sets
13393 the value of the Emacs variable @code{default-directory}.
13395 When using @code{:dir}, you should supply a relative path for file output
13396 (e.g.@: @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which
13397 case that path will be interpreted relative to the default directory.
13399 In other words, if you want your plot to go into a folder called @file{Work}
13400 in your home directory, you could use
13403 #+BEGIN_SRC R :file myplot.png :dir ~/Work
13404 matplot(matrix(rnorm(100), 10), type="l")
13408 @subsubheading Remote execution
13409 A directory on a remote machine can be specified using tramp file syntax, in
13410 which case the code will be evaluated on the remote machine. An example is
13413 #+BEGIN_SRC R :file plot.png :dir /dand@@yakuba.princeton.edu:
13414 plot(1:10, main=system("hostname", intern=TRUE))
13418 Text results will be returned to the local Org mode buffer as usual, and file
13419 output will be created on the remote machine with relative paths interpreted
13420 relative to the remote directory. An Org mode link to the remote file will be
13423 So, in the above example a plot will be created on the remote machine,
13424 and a link of the following form will be inserted in the org buffer:
13427 [[file:/scp:dand@@yakuba.princeton.edu:/home/dand/plot.png][plot.png]]
13430 Most of this functionality follows immediately from the fact that @code{:dir}
13431 sets the value of the Emacs variable @code{default-directory}, thanks to
13432 tramp. Those using XEmacs, or GNU Emacs prior to version 23 may need to
13433 install tramp separately in order for these features to work correctly.
13435 @subsubheading Further points
13439 If @code{:dir} is used in conjunction with @code{:session}, although it will
13440 determine the starting directory for a new session as expected, no attempt is
13441 currently made to alter the directory associated with an existing session.
13443 @code{:dir} should typically not be used to create files during export with
13444 @code{:exports results} or @code{:exports both}. The reason is that, in order
13445 to retain portability of exported material between machines, during export
13446 links inserted into the buffer will @emph{not} be expanded against @code{default
13447 directory}. Therefore, if @code{default-directory} is altered using
13448 @code{:dir}, it is probable that the file will be created in a location to
13449 which the link does not point.
13452 @node exports, tangle, dir, Specific header arguments
13453 @subsubsection @code{:exports}
13455 The @code{:exports} header argument specifies what should be included in HTML
13456 or LaTeX exports of the Org mode file.
13460 The default. The body of code is included into the exported file. E.g.,
13461 @code{:exports code}.
13462 @item @code{results}
13463 The result of evaluating the code is included in the exported file. E.g.,
13464 @code{:exports results}.
13466 Both the code and results are included in the exported file. E.g.,
13467 @code{:exports both}.
13469 Nothing is included in the exported file. E.g., @code{:exports none}.
13472 @node tangle, mkdirp, exports, Specific header arguments
13473 @subsubsection @code{:tangle}
13475 The @code{:tangle} header argument specifies whether or not the code
13476 block should be included in tangled extraction of source code files.
13479 @item @code{tangle}
13480 The code block is exported to a source code file named after the full path
13481 (including the directory) and file name (w/o extension) of the Org mode file.
13482 E.g., @code{:tangle yes}.
13484 The default. The code block is not exported to a source code file.
13485 E.g., @code{:tangle no}.
13487 Any other string passed to the @code{:tangle} header argument is interpreted
13488 as a path (directory and file name relative to the directory of the Org mode
13489 file) to which the block will be exported. E.g., @code{:tangle path}.
13492 @node mkdirp, comments, tangle, Specific header arguments
13493 @subsubsection @code{:mkdirp}
13495 The @code{:mkdirp} header argument can be used to create parent directories
13496 of tangled files when missing. This can be set to @code{yes} to enable
13497 directory creation or to @code{no} to inhibit directory creation.
13499 @node comments, padline, mkdirp, Specific header arguments
13500 @subsubsection @code{:comments}
13501 By default code blocks are tangled to source-code files without any insertion
13502 of comments beyond those which may already exist in the body of the code
13503 block. The @code{:comments} header argument can be set as follows to control
13504 the insertion of extra comments into the tangled code file.
13508 The default. No extra comments are inserted during tangling.
13510 The code block is wrapped in comments which contain pointers back to the
13511 original Org file from which the code was tangled.
13513 A synonym for ``link'' to maintain backwards compatibility.
13515 Include text from the Org mode file as a comment.
13517 The text is picked from the leading context of the tangled code and is
13518 limited by the nearest headline or source block as the case may be.
13520 Turns on both the ``link'' and ``org'' comment options.
13522 Turns on the ``link'' comment option, and additionally wraps expanded noweb
13523 references in the code block body in link comments.
13526 @node padline, no-expand, comments, Specific header arguments
13527 @subsubsection @code{:padline}
13528 Control in insertion of padding lines around code block bodies in tangled
13529 code files. The default value is @code{yes} which results in insertion of
13530 newlines before and after each tangled code block. The following arguments
13535 Insert newlines before and after each code block body in tangled code files.
13537 Do not insert any newline padding in tangled output.
13540 @node no-expand, session, padline, Specific header arguments
13541 @subsubsection @code{:no-expand}
13543 By default, code blocks are expanded with @code{org-babel-expand-src-block}
13544 during tangling. This has the effect of assigning values to variables
13545 specified with @code{:var} (see @ref{var}), and of replacing ``noweb''
13546 references (see @ref{Noweb reference syntax}) with their targets. The
13547 @code{:no-expand} header argument can be used to turn off this behavior.
13549 @node session, noweb, no-expand, Specific header arguments
13550 @subsubsection @code{:session}
13552 The @code{:session} header argument starts a session for an interpreted
13553 language where state is preserved.
13555 By default, a session is not started.
13557 A string passed to the @code{:session} header argument will give the session
13558 a name. This makes it possible to run concurrent sessions for each
13559 interpreted language.
13561 @node noweb, noweb-ref, session, Specific header arguments
13562 @subsubsection @code{:noweb}
13564 The @code{:noweb} header argument controls expansion of ``noweb'' style (see
13565 @ref{Noweb reference syntax}) references in a code block. This header
13566 argument can have one of three values: @code{yes}, @code{no}, or @code{tangle}.
13570 All ``noweb'' syntax references in the body of the code block will be
13571 expanded before the block is evaluated, tangled or exported.
13573 The default. No ``noweb'' syntax specific action is taken on evaluating
13574 code blocks, However, noweb references will still be expanded during
13576 @item @code{tangle}
13577 All ``noweb'' syntax references in the body of the code block will be
13578 expanded before the block is tangled, however ``noweb'' references will not
13579 be expanded when the block is evaluated or exported.
13582 @subsubheading Noweb prefix lines
13583 Noweb insertions are now placed behind the line prefix of the
13584 @code{<<reference>>}.
13585 This behavior is illustrated in the following example. Because the
13586 @code{<<example>>} noweb reference appears behind the SQL comment syntax,
13587 each line of the expanded noweb reference will be commented.
13600 -- multi-line body of example
13603 Note that noweb replacement text that does not contain any newlines will not
13604 be affected by this change, so it is still possible to use inline noweb
13607 @node noweb-ref, cache, noweb, Specific header arguments
13608 @subsubsection @code{:noweb-ref}
13609 When expanding ``noweb'' style references the bodies of all code block with
13610 @emph{either} a block name matching the reference name @emph{or} a
13611 @code{:noweb-ref} header argument matching the reference name will be
13612 concatenated together to form the replacement text.
13614 By setting this header argument at the sub-tree or file level, simple code
13615 block concatenation may be achieved. For example, when tangling the
13616 following Org mode file, the bodies of code blocks will be concatenated into
13617 the resulting pure code file.
13620 #+BEGIN_SRC sh :tangle yes :noweb yes :shebang #!/bin/sh
13623 * the mount point of the fullest disk
13625 :noweb-ref: fullest-disk
13628 ** query all mounted disks
13633 ** strip the header row
13638 ** sort by the percent full
13640 |awk '@{print $5 " " $6@}'|sort -n |tail -1 \
13643 ** extract the mount point
13645 |awk '@{print $2@}'
13649 @node cache, sep, noweb-ref, Specific header arguments
13650 @subsubsection @code{:cache}
13652 The @code{:cache} header argument controls the use of in-buffer caching of
13653 the results of evaluating code blocks. It can be used to avoid re-evaluating
13654 unchanged code blocks. This header argument can have one of two
13655 values: @code{yes} or @code{no}.
13659 The default. No caching takes place, and the code block will be evaluated
13660 every time it is called.
13662 Every time the code block is run a SHA1 hash of the code and arguments
13663 passed to the block will be generated. This hash is packed into the
13664 @code{#+results:} line and will be checked on subsequent
13665 executions of the code block. If the code block has not
13666 changed since the last time it was evaluated, it will not be re-evaluated.
13669 Code block caches notice if the value of a variable argument
13670 to the code block has changed. If this is the case, the cache is
13671 invalidated and the code block is re-run. In the following example,
13672 @code{caller} will not be re-run unless the results of @code{random} have
13673 changed since it was last run.
13677 #+BEGIN_SRC R :cache yes
13681 #+results[a2a72cd647ad44515fab62e144796432793d68e1]: random
13685 #+BEGIN_SRC emacs-lisp :var x=random :cache yes
13689 #+results[bec9c8724e397d5df3b696502df3ed7892fc4f5f]: caller
13693 @node sep, hlines, cache, Specific header arguments
13694 @subsubsection @code{:sep}
13696 The @code{:sep} header argument can be used to control the delimiter used
13697 when writing tabular results out to files external to Org mode. This is used
13698 either when opening tabular results of a code block by calling the
13699 @code{org-open-at-point} function bound to @kbd{C-c C-o} on the code block,
13700 or when writing code block results to an external file (see @ref{file})
13703 By default, when @code{:sep} is not specified output tables are tab
13706 @node hlines, colnames, sep, Specific header arguments
13707 @subsubsection @code{:hlines}
13709 Tables are frequently represented with one or more horizontal lines, or
13710 hlines. The @code{:hlines} argument to a code block accepts the
13711 values @code{yes} or @code{no}, with a default value of @code{no}.
13715 Strips horizontal lines from the input table. In most languages this is the
13716 desired effect because an @code{hline} symbol is interpreted as an unbound
13717 variable and raises an error. Setting @code{:hlines no} or relying on the
13718 default value yields the following results.
13721 #+TBLNAME: many-cols
13729 #+BEGIN_SRC python :var tab=many-cols
13733 #+results: echo-table
13740 Leaves hlines in the table. Setting @code{:hlines yes} has this effect.
13743 #+TBLNAME: many-cols
13751 #+BEGIN_SRC python :var tab=many-cols :hlines yes
13755 #+results: echo-table
13764 @node colnames, rownames, hlines, Specific header arguments
13765 @subsubsection @code{:colnames}
13767 The @code{:colnames} header argument accepts the values @code{yes},
13768 @code{no}, or @code{nil} for unassigned. The default value is @code{nil}.
13769 Note that the behavior of the @code{:colnames} header argument may differ
13770 across languages. For example Emacs Lisp code blocks ignore the
13771 @code{:colnames} header argument entirely given the ease with which tables
13772 with column names may be handled directly in Emacs Lisp.
13776 If an input table looks like it has column names
13777 (because its second row is an hline), then the column
13778 names will be removed from the table before
13779 processing, then reapplied to the results.
13782 #+TBLNAME: less-cols
13788 #+NAME: echo-table-again
13789 #+BEGIN_SRC python :var tab=less-cols
13790 return [[val + '*' for val in row] for row in tab]
13793 #+results: echo-table-again
13800 Please note that column names are not removed before the table is indexed
13801 using variable indexing @xref{var, Indexable variable values}.
13804 No column name pre-processing takes place
13807 Column names are removed and reapplied as with @code{nil} even if the table
13808 does not ``look like'' it has column names (i.e.@: the second row is not an
13812 @node rownames, shebang, colnames, Specific header arguments
13813 @subsubsection @code{:rownames}
13815 The @code{:rownames} header argument can take on the values @code{yes}
13816 or @code{no}, with a default value of @code{no}.
13820 No row name pre-processing will take place.
13823 The first column of the table is removed from the table before processing,
13824 and is then reapplied to the results.
13827 #+TBLNAME: with-rownames
13828 | one | 1 | 2 | 3 | 4 | 5 |
13829 | two | 6 | 7 | 8 | 9 | 10 |
13831 #+NAME: echo-table-once-again
13832 #+BEGIN_SRC python :var tab=with-rownames :rownames yes
13833 return [[val + 10 for val in row] for row in tab]
13836 #+results: echo-table-once-again
13837 | one | 11 | 12 | 13 | 14 | 15 |
13838 | two | 16 | 17 | 18 | 19 | 20 |
13841 Please note that row names are not removed before the table is indexed using
13842 variable indexing @xref{var, Indexable variable values}.
13846 @node shebang, eval, rownames, Specific header arguments
13847 @subsubsection @code{:shebang}
13849 Setting the @code{:shebang} header argument to a string value
13850 (e.g.@: @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the
13851 first line of any tangled file holding the code block, and the file
13852 permissions of the tangled file are set to make it executable.
13854 @node eval, , shebang, Specific header arguments
13855 @subsubsection @code{:eval}
13856 The @code{:eval} header argument can be used to limit the evaluation of
13857 specific code blocks. The @code{:eval} header argument can be useful for
13858 protecting against the evaluation of dangerous code blocks or to ensure that
13859 evaluation will require a query regardless of the value of the
13860 @code{org-confirm-babel-evaluate} variable. The possible values of
13861 @code{:eval} and their effects are shown below.
13865 The code block will not be evaluated under any circumstances.
13867 Evaluation of the code block will require a query.
13868 @item never-export or no-export
13869 The code block will not be evaluated during export but may still be called
13872 Evaluation of the code block during export will require a query.
13875 If this header argument is not set then evaluation is determined by the value
13876 of the @code{org-confirm-babel-evaluate} variable see @ref{Code evaluation
13879 @node Results of evaluation, Noweb reference syntax, Header arguments, Working With Source Code
13880 @section Results of evaluation
13881 @cindex code block, results of evaluation
13882 @cindex source code, results of evaluation
13884 The way in which results are handled depends on whether a session is invoked,
13885 as well as on whether @code{:results value} or @code{:results output} is
13886 used. The following table shows the table possibilities. For a full listing
13887 of the possible results header arguments see @ref{results}.
13889 @multitable @columnfractions 0.26 0.33 0.41
13890 @item @tab @b{Non-session} @tab @b{Session}
13891 @item @code{:results value} @tab value of last expression @tab value of last expression
13892 @item @code{:results output} @tab contents of STDOUT @tab concatenation of interpreter output
13895 Note: With @code{:results value}, the result in both @code{:session} and
13896 non-session is returned to Org mode as a table (a one- or two-dimensional
13897 vector of strings or numbers) when appropriate.
13899 @subsection Non-session
13900 @subsubsection @code{:results value}
13901 This is the default. Internally, the value is obtained by wrapping the code
13902 in a function definition in the external language, and evaluating that
13903 function. Therefore, code should be written as if it were the body of such a
13904 function. In particular, note that Python does not automatically return a
13905 value from a function unless a @code{return} statement is present, and so a
13906 @samp{return} statement will usually be required in Python.
13908 This is the only one of the four evaluation contexts in which the code is
13909 automatically wrapped in a function definition.
13911 @subsubsection @code{:results output}
13912 The code is passed to the interpreter as an external process, and the
13913 contents of the standard output stream are returned as text. (In certain
13914 languages this also contains the error output stream; this is an area for
13917 @subsection Session
13918 @subsubsection @code{:results value}
13919 The code is passed to an interpreter running as an interactive Emacs inferior
13920 process. Only languages which provide tools for interactive evaluation of
13921 code have session support, so some language (e.g., C and ditaa) do not
13922 support the @code{:session} header argument, and in other languages (e.g.,
13923 Python and Haskell) which have limitations on the code which may be entered
13924 into interactive sessions, those limitations apply to the code in code blocks
13925 using the @code{:session} header argument as well.
13927 Unless the @code{:results output} option is supplied (see below) the result
13928 returned is the result of the last evaluation performed by the
13929 interpreter. (This is obtained in a language-specific manner: the value of
13930 the variable @code{_} in Python and Ruby, and the value of @code{.Last.value}
13933 @subsubsection @code{:results output}
13934 The code is passed to the interpreter running as an interactive Emacs
13935 inferior process. The result returned is the concatenation of the sequence of
13936 (text) output from the interactive interpreter. Notice that this is not
13937 necessarily the same as what would be sent to @code{STDOUT} if the same code
13938 were passed to a non-interactive interpreter running as an external
13939 process. For example, compare the following two blocks:
13942 #+BEGIN_SRC python :results output
13953 In non-session mode, the `2' is not printed and does not appear.
13955 #+BEGIN_SRC python :results output :session
13967 But in @code{:session} mode, the interactive interpreter receives input `2'
13968 and prints out its value, `2'. (Indeed, the other print statements are
13971 @node Noweb reference syntax, Key bindings and useful functions, Results of evaluation, Working With Source Code
13972 @section Noweb reference syntax
13973 @cindex code block, noweb reference
13974 @cindex syntax, noweb
13975 @cindex source code, noweb reference
13977 The ``noweb'' (see @uref{http://www.cs.tufts.edu/~nr/noweb/}) Literate
13978 Programming system allows named blocks of code to be referenced by using the
13979 familiar Noweb syntax:
13982 <<code-block-name>>
13985 When a code block is tangled or evaluated, whether or not ``noweb''
13986 references are expanded depends upon the value of the @code{:noweb} header
13987 argument. If @code{:noweb yes}, then a Noweb reference is expanded before
13988 evaluation. If @code{:noweb no}, the default, then the reference is not
13989 expanded before evaluation.
13991 Note: the default value, @code{:noweb no}, was chosen to ensure that
13992 correct code is not broken in a language, such as Ruby, where
13993 @code{<<arg>>} is a syntactically valid construct. If @code{<<arg>>} is not
13994 syntactically valid in languages that you use, then please consider setting
13997 @node Key bindings and useful functions, Batch execution, Noweb reference syntax, Working With Source Code
13998 @section Key bindings and useful functions
13999 @cindex code block, key bindings
14001 Many common Org mode key sequences are re-bound depending on
14004 Within a code block, the following key bindings
14007 @multitable @columnfractions 0.25 0.75
14009 @item @kbd{C-c C-c} @tab @code{org-babel-execute-src-block}
14011 @item @kbd{C-c C-o} @tab @code{org-babel-open-src-block-result}
14013 @item @kbd{C-@key{up}} @tab @code{org-babel-load-in-session}
14015 @item @kbd{M-@key{down}} @tab @code{org-babel-pop-to-session}
14018 In an Org mode buffer, the following key bindings are active:
14020 @multitable @columnfractions 0.45 0.55
14022 @kindex C-c C-v C-a
14023 @item @kbd{C-c C-v a} @ @ @r{or} @ @ @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
14025 @kindex C-c C-v C-b
14026 @item @kbd{C-c C-v b} @ @ @r{or} @ @ @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
14028 @kindex C-c C-v C-f
14029 @item @kbd{C-c C-v f} @ @ @r{or} @ @ @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
14031 @item @kbd{C-c C-v g} @tab @code{org-babel-goto-named-source-block}
14033 @item @kbd{C-c C-v h} @tab @code{org-babel-describe-bindings}
14035 @kindex C-c C-v C-l
14036 @item @kbd{C-c C-v l} @ @ @r{or} @ @ @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest}
14038 @kindex C-c C-v C-p
14039 @item @kbd{C-c C-v p} @ @ @r{or} @ @ @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block}
14041 @kindex C-c C-v C-s
14042 @item @kbd{C-c C-v s} @ @ @r{or} @ @ @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
14044 @kindex C-c C-v C-t
14045 @item @kbd{C-c C-v t} @ @ @r{or} @ @ @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
14047 @kindex C-c C-v C-z
14048 @item @kbd{C-c C-v z} @ @ @r{or} @ @ @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session}
14051 @c When possible these keybindings were extended to work when the control key is
14052 @c kept pressed, resulting in the following additional keybindings.
14054 @c @multitable @columnfractions 0.25 0.75
14055 @c @item @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
14056 @c @item @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
14057 @c @item @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
14058 @c @item @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest}
14059 @c @item @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block}
14060 @c @item @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
14061 @c @item @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
14062 @c @item @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session}
14065 @node Batch execution, , Key bindings and useful functions, Working With Source Code
14066 @section Batch execution
14067 @cindex code block, batch execution
14068 @cindex source code, batch execution
14070 It is possible to call functions from the command line. This shell
14071 script calls @code{org-babel-tangle} on every one of its arguments.
14073 Be sure to adjust the paths to fit your system.
14077 # -*- mode: shell-script -*-
14079 # tangle files with org-mode
14083 ORGINSTALL="~/src/org/lisp/org-install.el"
14085 # wrap each argument in the code required to call tangle on it
14087 FILES="$FILES \"$i\""
14090 emacs -Q --batch -l $ORGINSTALL \
14092 (add-to-list 'load-path (expand-file-name \"~/src/org/lisp/\"))
14093 (add-to-list 'load-path (expand-file-name \"~/src/org/contrib/lisp/\"))
14094 (require 'org)(require 'org-exp)(require 'ob)(require 'ob-tangle)
14095 (mapc (lambda (file)
14096 (find-file (expand-file-name file \"$DIR\"))
14098 (kill-buffer)) '($FILES)))" 2>&1 |grep tangled
14101 @node Miscellaneous, Hacking, Working With Source Code, Top
14102 @chapter Miscellaneous
14105 * Completion:: M-TAB knows what you need
14106 * Easy Templates:: Quick insertion of structural elements
14107 * Speed keys:: Electric commands at the beginning of a headline
14108 * Code evaluation security:: Org mode files evaluate inline code
14109 * Customization:: Adapting Org to your taste
14110 * In-buffer settings:: Overview of the #+KEYWORDS
14111 * The very busy C-c C-c key:: When in doubt, press C-c C-c
14112 * Clean view:: Getting rid of leading stars in the outline
14113 * TTY keys:: Using Org on a tty
14114 * Interaction:: Other Emacs packages
14115 * org-crypt.el:: Encrypting Org files
14119 @node Completion, Easy Templates, Miscellaneous, Miscellaneous
14120 @section Completion
14121 @cindex completion, of @TeX{} symbols
14122 @cindex completion, of TODO keywords
14123 @cindex completion, of dictionary words
14124 @cindex completion, of option keywords
14125 @cindex completion, of tags
14126 @cindex completion, of property keys
14127 @cindex completion, of link abbreviations
14128 @cindex @TeX{} symbol completion
14129 @cindex TODO keywords completion
14130 @cindex dictionary word completion
14131 @cindex option keyword completion
14132 @cindex tag completion
14133 @cindex link abbreviations, completion of
14135 Emacs would not be Emacs without completion, and Org mode uses it whenever it
14136 makes sense. If you prefer an @i{iswitchb}- or @i{ido}-like interface for
14137 some of the completion prompts, you can specify your preference by setting at
14138 most one of the variables @code{org-completion-use-iswitchb}
14139 @code{org-completion-use-ido}.
14141 Org supports in-buffer completion. This type of completion does
14142 not make use of the minibuffer. You simply type a few letters into
14143 the buffer and use the key to complete text right there.
14146 @kindex M-@key{TAB}
14148 Complete word at point
14151 At the beginning of a headline, complete TODO keywords.
14153 After @samp{\}, complete @TeX{} symbols supported by the exporter.
14155 After @samp{*}, complete headlines in the current buffer so that they
14156 can be used in search links like @samp{[[*find this headline]]}.
14158 After @samp{:} in a headline, complete tags. The list of tags is taken
14159 from the variable @code{org-tag-alist} (possibly set through the
14160 @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
14161 dynamically from all tags used in the current buffer.
14163 After @samp{:} and not in a headline, complete property keys. The list
14164 of keys is constructed dynamically from all keys used in the current
14167 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
14169 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
14170 @samp{OPTIONS} which set file-specific options for Org mode. When the
14171 option keyword is already complete, pressing @kbd{M-@key{TAB}} again
14172 will insert example settings for this keyword.
14174 In the line after @samp{#+STARTUP: }, complete startup keywords,
14175 i.e.@: valid keys for this line.
14177 Elsewhere, complete dictionary words using Ispell.
14181 @node Easy Templates, Speed keys, Completion, Miscellaneous
14182 @section Easy Templates
14183 @cindex template insertion
14184 @cindex insertion, of templates
14186 Org mode supports insertion of empty structural elements (like
14187 @code{#+BEGIN_SRC} and @code{#+END_SRC} pairs) with just a few key
14188 strokes. This is achieved through a native template expansion mechanism.
14189 Note that Emacs has several other template mechanisms which could be used in
14190 a similar way, for example @file{yasnippet}.
14192 To insert a structural element, type a @samp{<}, followed by a template
14193 selector and @kbd{@key{TAB}}. Completion takes effect only when the above
14194 keystrokes are typed on a line by itself.
14196 The following template selectors are currently supported.
14198 @multitable @columnfractions 0.1 0.9
14199 @item @kbd{s} @tab @code{#+begin_src ... #+end_src}
14200 @item @kbd{e} @tab @code{#+begin_example ... #+end_example}
14201 @item @kbd{q} @tab @code{#+begin_quote ... #+end_quote}
14202 @item @kbd{v} @tab @code{#+begin_verse ... #+end_verse}
14203 @item @kbd{c} @tab @code{#+begin_center ... #+end_center}
14204 @item @kbd{l} @tab @code{#+begin_latex ... #+end_latex}
14205 @item @kbd{L} @tab @code{#+latex:}
14206 @item @kbd{h} @tab @code{#+begin_html ... #+end_html}
14207 @item @kbd{H} @tab @code{#+html:}
14208 @item @kbd{a} @tab @code{#+begin_ascii ... #+end_ascii}
14209 @item @kbd{A} @tab @code{#+ascii:}
14210 @item @kbd{i} @tab @code{#+index:} line
14211 @item @kbd{I} @tab @code{#+include:} line
14214 For example, on an empty line, typing "<e" and then pressing TAB, will expand
14215 into a complete EXAMPLE template.
14217 You can install additional templates by customizing the variable
14218 @code{org-structure-template-alist}. See the docstring of the variable for
14219 additional details.
14221 @node Speed keys, Code evaluation security, Easy Templates, Miscellaneous
14222 @section Speed keys
14224 @vindex org-use-speed-commands
14225 @vindex org-speed-commands-user
14227 Single keys can be made to execute commands when the cursor is at the
14228 beginning of a headline, i.e.@: before the first star. Configure the variable
14229 @code{org-use-speed-commands} to activate this feature. There is a
14230 pre-defined list of commands, and you can add more such commands using the
14231 variable @code{org-speed-commands-user}. Speed keys do not only speed up
14232 navigation and other commands, but they also provide an alternative way to
14233 execute commands bound to keys that are not or not easily available on a TTY,
14234 or on a small mobile device with a limited keyboard.
14236 To see which commands are available, activate the feature and press @kbd{?}
14237 with the cursor at the beginning of a headline.
14239 @node Code evaluation security, Customization, Speed keys, Miscellaneous
14240 @section Code evaluation and security issues
14242 Org provides tools to work with the code snippets, including evaluating them.
14244 Running code on your machine always comes with a security risk. Badly
14245 written or malicious code can be executed on purpose or by accident. Org has
14246 default settings which will only evaluate such code if you give explicit
14247 permission to do so, and as a casual user of these features you should leave
14248 these precautions intact.
14250 For people who regularly work with such code, the confirmation prompts can
14251 become annoying, and you might want to turn them off. This can be done, but
14252 you must be aware of the risks that are involved.
14254 Code evaluation can happen under the following circumstances:
14257 @item Source code blocks
14258 Source code blocks can be evaluated during export, or when pressing @kbd{C-c
14259 C-c} in the block. The most important thing to realize here is that Org mode
14260 files which contain code snippets are, in a certain sense, like executable
14261 files. So you should accept them and load them into Emacs only from trusted
14262 sources---just like you would do with a program you install on your computer.
14264 Make sure you know what you are doing before customizing the variables
14265 which take off the default security brakes.
14267 @defopt org-confirm-babel-evaluate
14268 When t (the default), the user is asked before every code block evaluation.
14269 When nil, the user is not asked. When set to a function, it is called with
14270 two arguments (language and body of the code block) and should return t to
14271 ask and nil not to ask.
14274 For example, here is how to execute "ditaa" code (which is considered safe)
14277 (defun my-org-confirm-babel-evaluate (lang body)
14278 (not (string= lang "ditaa"))) ; don't ask for ditaa
14279 (setq org-confirm-babel-evaluate 'my-org-confirm-babel-evaluate)
14282 @item Following @code{shell} and @code{elisp} links
14283 Org has two link types that can directly evaluate code (@pxref{External
14284 links}). These links can be problematic because the code to be evaluated is
14287 @defopt org-confirm-shell-link-function
14288 Function to queries user about shell link execution.
14290 @defopt org-confirm-elisp-link-function
14291 Functions to query user for Emacs Lisp link execution.
14294 @item Formulas in tables
14295 Formulas in tables (@pxref{The spreadsheet}) are code that is evaluated
14296 either by the @i{calc} interpreter, or by the @i{Emacs Lisp} interpreter.
14299 @node Customization, In-buffer settings, Code evaluation security, Miscellaneous
14300 @section Customization
14301 @cindex customization
14302 @cindex options, for customization
14303 @cindex variables, for customization
14305 There are more than 180 variables that can be used to customize
14306 Org. For the sake of compactness of the manual, I am not
14307 describing the variables here. A structured overview of customization
14308 variables is available with @kbd{M-x org-customize}. Or select
14309 @code{Browse Org Group} from the @code{Org->Customization} menu. Many
14310 settings can also be activated on a per-file basis, by putting special
14311 lines into the buffer (@pxref{In-buffer settings}).
14313 @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous
14314 @section Summary of in-buffer settings
14315 @cindex in-buffer settings
14316 @cindex special keywords
14318 Org mode uses special lines in the buffer to define settings on a
14319 per-file basis. These lines start with a @samp{#+} followed by a
14320 keyword, a colon, and then individual words defining a setting. Several
14321 setting words can be in the same line, but you can also have multiple
14322 lines for the keyword. While these settings are described throughout
14323 the manual, here is a summary. After changing any of those lines in the
14324 buffer, press @kbd{C-c C-c} with the cursor still in the line to
14325 activate the changes immediately. Otherwise they become effective only
14326 when the file is visited again in a new Emacs session.
14328 @vindex org-archive-location
14330 @item #+ARCHIVE: %s_done::
14331 This line sets the archive location for the agenda file. It applies for
14332 all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
14333 of the file. The first such line also applies to any entries before it.
14334 The corresponding variable is @code{org-archive-location}.
14336 This line sets the category for the agenda file. The category applies
14337 for all subsequent lines until the next @samp{#+CATEGORY} line, or the
14338 end of the file. The first such line also applies to any entries before it.
14339 @item #+COLUMNS: %25ITEM .....
14340 @cindex property, COLUMNS
14341 Set the default format for columns view. This format applies when
14342 columns view is invoked in locations where no @code{COLUMNS} property
14344 @item #+CONSTANTS: name1=value1 ...
14345 @vindex org-table-formula-constants
14346 @vindex org-table-formula
14347 Set file-local values for constants to be used in table formulas. This
14348 line sets the local variable @code{org-table-formula-constants-local}.
14349 The global version of this variable is
14350 @code{org-table-formula-constants}.
14351 @item #+FILETAGS: :tag1:tag2:tag3:
14352 Set tags that can be inherited by any entry in the file, including the
14354 @item #+DRAWERS: NAME1 .....
14355 @vindex org-drawers
14356 Set the file-local set of drawers. The corresponding global variable is
14357 @code{org-drawers}.
14358 @item #+LINK: linkword replace
14359 @vindex org-link-abbrev-alist
14360 These lines (several are allowed) specify link abbreviations.
14361 @xref{Link abbreviations}. The corresponding variable is
14362 @code{org-link-abbrev-alist}.
14363 @item #+PRIORITIES: highest lowest default
14364 @vindex org-highest-priority
14365 @vindex org-lowest-priority
14366 @vindex org-default-priority
14367 This line sets the limits and the default for the priorities. All three
14368 must be either letters A-Z or numbers 0-9. The highest priority must
14369 have a lower ASCII number than the lowest priority.
14370 @item #+PROPERTY: Property_Name Value
14371 This line sets a default inheritance value for entries in the current
14372 buffer, most useful for specifying the allowed values of a property.
14373 @cindex #+SETUPFILE
14374 @item #+SETUPFILE: file
14375 This line defines a file that holds more in-buffer setup. Normally this is
14376 entirely ignored. Only when the buffer is parsed for option-setting lines
14377 (i.e.@: when starting Org mode for a file, when pressing @kbd{C-c C-c} in a
14378 settings line, or when exporting), then the contents of this file are parsed
14379 as if they had been included in the buffer. In particular, the file can be
14380 any other Org mode file with internal setup. You can visit the file the
14381 cursor is in the line with @kbd{C-c '}.
14384 This line sets options to be used at startup of Org mode, when an
14385 Org file is being visited.
14387 The first set of options deals with the initial visibility of the outline
14388 tree. The corresponding variable for global default settings is
14389 @code{org-startup-folded}, with a default value @code{t}, which means
14391 @vindex org-startup-folded
14392 @cindex @code{overview}, STARTUP keyword
14393 @cindex @code{content}, STARTUP keyword
14394 @cindex @code{showall}, STARTUP keyword
14395 @cindex @code{showeverything}, STARTUP keyword
14397 overview @r{top-level headlines only}
14398 content @r{all headlines}
14399 showall @r{no folding of any entries}
14400 showeverything @r{show even drawer contents}
14403 @vindex org-startup-indented
14404 @cindex @code{indent}, STARTUP keyword
14405 @cindex @code{noindent}, STARTUP keyword
14406 Dynamic virtual indentation is controlled by the variable
14407 @code{org-startup-indented}@footnote{Emacs 23 and Org mode 6.29 are required}
14409 indent @r{start with @code{org-indent-mode} turned on}
14410 noindent @r{start with @code{org-indent-mode} turned off}
14413 @vindex org-startup-align-all-tables
14414 Then there are options for aligning tables upon visiting a file. This
14415 is useful in files containing narrowed table columns. The corresponding
14416 variable is @code{org-startup-align-all-tables}, with a default value
14418 @cindex @code{align}, STARTUP keyword
14419 @cindex @code{noalign}, STARTUP keyword
14421 align @r{align all tables}
14422 noalign @r{don't align tables on startup}
14425 @vindex org-startup-with-inline-images
14426 When visiting a file, inline images can be automatically displayed. The
14427 corresponding variable is @code{org-startup-with-inline-images}, with a
14428 default value @code{nil} to avoid delays when visiting a file.
14429 @cindex @code{inlineimages}, STARTUP keyword
14430 @cindex @code{noinlineimages}, STARTUP keyword
14432 inlineimages @r{show inline images}
14433 noinlineimages @r{don't show inline images on startup}
14436 @vindex org-log-done
14437 @vindex org-log-note-clock-out
14438 @vindex org-log-repeat
14439 Logging the closing and reopening of TODO items and clock intervals can be
14440 configured using these options (see variables @code{org-log-done},
14441 @code{org-log-note-clock-out} and @code{org-log-repeat})
14442 @cindex @code{logdone}, STARTUP keyword
14443 @cindex @code{lognotedone}, STARTUP keyword
14444 @cindex @code{nologdone}, STARTUP keyword
14445 @cindex @code{lognoteclock-out}, STARTUP keyword
14446 @cindex @code{nolognoteclock-out}, STARTUP keyword
14447 @cindex @code{logrepeat}, STARTUP keyword
14448 @cindex @code{lognoterepeat}, STARTUP keyword
14449 @cindex @code{nologrepeat}, STARTUP keyword
14450 @cindex @code{logreschedule}, STARTUP keyword
14451 @cindex @code{lognotereschedule}, STARTUP keyword
14452 @cindex @code{nologreschedule}, STARTUP keyword
14453 @cindex @code{logredeadline}, STARTUP keyword
14454 @cindex @code{lognoteredeadline}, STARTUP keyword
14455 @cindex @code{nologredeadline}, STARTUP keyword
14456 @cindex @code{logrefile}, STARTUP keyword
14457 @cindex @code{lognoterefile}, STARTUP keyword
14458 @cindex @code{nologrefile}, STARTUP keyword
14460 logdone @r{record a timestamp when an item is marked DONE}
14461 lognotedone @r{record timestamp and a note when DONE}
14462 nologdone @r{don't record when items are marked DONE}
14463 logrepeat @r{record a time when reinstating a repeating item}
14464 lognoterepeat @r{record a note when reinstating a repeating item}
14465 nologrepeat @r{do not record when reinstating repeating item}
14466 lognoteclock-out @r{record a note when clocking out}
14467 nolognoteclock-out @r{don't record a note when clocking out}
14468 logreschedule @r{record a timestamp when scheduling time changes}
14469 lognotereschedule @r{record a note when scheduling time changes}
14470 nologreschedule @r{do not record when a scheduling date changes}
14471 logredeadline @r{record a timestamp when deadline changes}
14472 lognoteredeadline @r{record a note when deadline changes}
14473 nologredeadline @r{do not record when a deadline date changes}
14474 logrefile @r{record a timestamp when refiling}
14475 lognoterefile @r{record a note when refiling}
14476 nologrefile @r{do not record when refiling}
14478 @vindex org-hide-leading-stars
14479 @vindex org-odd-levels-only
14480 Here are the options for hiding leading stars in outline headings, and for
14481 indenting outlines. The corresponding variables are
14482 @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
14483 default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
14484 @cindex @code{hidestars}, STARTUP keyword
14485 @cindex @code{showstars}, STARTUP keyword
14486 @cindex @code{odd}, STARTUP keyword
14487 @cindex @code{even}, STARTUP keyword
14489 hidestars @r{make all but one of the stars starting a headline invisible.}
14490 showstars @r{show all stars starting a headline}
14491 indent @r{virtual indentation according to outline level}
14492 noindent @r{no virtual indentation according to outline level}
14493 odd @r{allow only odd outline levels (1,3,...)}
14494 oddeven @r{allow all outline levels}
14496 @vindex org-put-time-stamp-overlays
14497 @vindex org-time-stamp-overlay-formats
14498 To turn on custom format overlays over timestamps (variables
14499 @code{org-put-time-stamp-overlays} and
14500 @code{org-time-stamp-overlay-formats}), use
14501 @cindex @code{customtime}, STARTUP keyword
14503 customtime @r{overlay custom time format}
14505 @vindex constants-unit-system
14506 The following options influence the table spreadsheet (variable
14507 @code{constants-unit-system}).
14508 @cindex @code{constcgs}, STARTUP keyword
14509 @cindex @code{constSI}, STARTUP keyword
14511 constcgs @r{@file{constants.el} should use the c-g-s unit system}
14512 constSI @r{@file{constants.el} should use the SI unit system}
14514 @vindex org-footnote-define-inline
14515 @vindex org-footnote-auto-label
14516 @vindex org-footnote-auto-adjust
14517 To influence footnote settings, use the following keywords. The
14518 corresponding variables are @code{org-footnote-define-inline},
14519 @code{org-footnote-auto-label}, and @code{org-footnote-auto-adjust}.
14520 @cindex @code{fninline}, STARTUP keyword
14521 @cindex @code{nofninline}, STARTUP keyword
14522 @cindex @code{fnlocal}, STARTUP keyword
14523 @cindex @code{fnprompt}, STARTUP keyword
14524 @cindex @code{fnauto}, STARTUP keyword
14525 @cindex @code{fnconfirm}, STARTUP keyword
14526 @cindex @code{fnplain}, STARTUP keyword
14527 @cindex @code{fnadjust}, STARTUP keyword
14528 @cindex @code{nofnadjust}, STARTUP keyword
14530 fninline @r{define footnotes inline}
14531 fnnoinline @r{define footnotes in separate section}
14532 fnlocal @r{define footnotes near first reference, but not inline}
14533 fnprompt @r{prompt for footnote labels}
14534 fnauto @r{create @code{[fn:1]}-like labels automatically (default)}
14535 fnconfirm @r{offer automatic label for editing or confirmation}
14536 fnplain @r{create @code{[1]}-like labels automatically}
14537 fnadjust @r{automatically renumber and sort footnotes}
14538 nofnadjust @r{do not renumber and sort automatically}
14540 @cindex org-hide-block-startup
14541 To hide blocks on startup, use these keywords. The corresponding variable is
14542 @code{org-hide-block-startup}.
14543 @cindex @code{hideblocks}, STARTUP keyword
14544 @cindex @code{nohideblocks}, STARTUP keyword
14546 hideblocks @r{Hide all begin/end blocks on startup}
14547 nohideblocks @r{Do not hide blocks on startup}
14549 @cindex org-pretty-entities
14550 The display of entities as UTF-8 characters is governed by the variable
14551 @code{org-pretty-entities} and the keywords
14552 @cindex @code{entitiespretty}, STARTUP keyword
14553 @cindex @code{entitiesplain}, STARTUP keyword
14555 entitiespretty @r{Show entities as UTF-8 characters where possible}
14556 entitiesplain @r{Leave entities plain}
14558 @item #+TAGS: TAG1(c1) TAG2(c2)
14559 @vindex org-tag-alist
14560 These lines (several such lines are allowed) specify the valid tags in
14561 this file, and (potentially) the corresponding @emph{fast tag selection}
14562 keys. The corresponding variable is @code{org-tag-alist}.
14564 This line contains the formulas for the table directly above the line.
14565 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+DATE:,
14566 @itemx #+OPTIONS:, #+BIND:, #+XSLT:,
14567 @itemx #+DESCRIPTION:, #+KEYWORDS:,
14568 @itemx #+LATEX_HEADER:, #+STYLE:, #+LINK_UP:, #+LINK_HOME:,
14569 @itemx #+EXPORT_SELECT_TAGS:, #+EXPORT_EXCLUDE_TAGS:
14570 These lines provide settings for exporting files. For more details see
14571 @ref{Export options}.
14572 @item #+TODO: #+SEQ_TODO: #+TYP_TODO:
14573 @vindex org-todo-keywords
14574 These lines set the TODO keywords and their interpretation in the
14575 current file. The corresponding variable is @code{org-todo-keywords}.
14578 @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous
14579 @section The very busy C-c C-c key
14581 @cindex C-c C-c, overview
14583 The key @kbd{C-c C-c} has many purposes in Org, which are all
14584 mentioned scattered throughout this manual. One specific function of
14585 this key is to add @emph{tags} to a headline (@pxref{Tags}). In many
14586 other circumstances it means something like @emph{``Hey Org, look
14587 here and update according to what you see here''}. Here is a summary of
14588 what this means in different contexts.
14592 If there are highlights in the buffer from the creation of a sparse
14593 tree, or from clock display, remove these highlights.
14595 If the cursor is in one of the special @code{#+KEYWORD} lines, this
14596 triggers scanning the buffer for these lines and updating the
14599 If the cursor is inside a table, realign the table. This command
14600 works even if the automatic table editor has been turned off.
14602 If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
14605 If the current buffer is a capture buffer, close the note and file it.
14606 With a prefix argument, file it, without further interaction, to the
14609 If the cursor is on a @code{<<<target>>>}, update radio targets and
14610 corresponding links in this buffer.
14612 If the cursor is in a property line or at the start or end of a property
14613 drawer, offer property commands.
14615 If the cursor is at a footnote reference, go to the corresponding
14616 definition, and vice versa.
14618 If the cursor is on a statistics cookie, update it.
14620 If the cursor is in a plain list item with a checkbox, toggle the status
14623 If the cursor is on a numbered item in a plain list, renumber the
14626 If the cursor is on the @code{#+BEGIN} line of a dynamic block, the
14629 If the cursor is at a timestamp, fix the day name in the timestamp.
14632 @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous
14633 @section A cleaner outline view
14634 @cindex hiding leading stars
14635 @cindex dynamic indentation
14636 @cindex odd-levels-only outlines
14637 @cindex clean outline view
14639 Some people find it noisy and distracting that the Org headlines start with a
14640 potentially large number of stars, and that text below the headlines is not
14641 indented. While this is no problem when writing a @emph{book-like} document
14642 where the outline headings are really section headings, in a more
14643 @emph{list-oriented} outline, indented structure is a lot cleaner:
14647 * Top level headline | * Top level headline
14648 ** Second level | * Second level
14649 *** 3rd level | * 3rd level
14650 some text | some text
14651 *** 3rd level | * 3rd level
14652 more text | more text
14653 * Another top level headline | * Another top level headline
14659 If you are using at least Emacs 23.2@footnote{Emacs 23.1 can actually crash
14660 with @code{org-indent-mode}} and version 6.29 of Org, this kind of view can
14661 be achieved dynamically at display time using @code{org-indent-mode}. In
14662 this minor mode, all lines are prefixed for display with the necessary amount
14663 of space@footnote{@code{org-indent-mode} also sets the @code{wrap-prefix}
14664 property, such that @code{visual-line-mode} (or purely setting
14665 @code{word-wrap}) wraps long lines (including headlines) correctly indented.
14666 }. Also headlines are prefixed with additional stars, so that the amount of
14667 indentation shifts by two@footnote{See the variable
14668 @code{org-indent-indentation-per-level}.} spaces per level. All headline
14669 stars but the last one are made invisible using the @code{org-hide}
14670 face@footnote{Turning on @code{org-indent-mode} sets
14671 @code{org-hide-leading-stars} to @code{t} and @code{org-adapt-indentation} to
14672 @code{nil}.} - see below under @samp{2.} for more information on how this
14673 works. You can turn on @code{org-indent-mode} for all files by customizing
14674 the variable @code{org-startup-indented}, or you can turn it on for
14675 individual files using
14681 If you want a similar effect in an earlier version of Emacs and/or Org, or if
14682 you want the indentation to be hard space characters so that the plain text
14683 file looks as similar as possible to the Emacs display, Org supports you in
14688 @emph{Indentation of text below headlines}@*
14689 You may indent text below each headline to make the left boundary line up
14690 with the headline, like
14694 more text, now indented
14697 @vindex org-adapt-indentation
14698 Org supports this with paragraph filling, line wrapping, and structure
14699 editing@footnote{See also the variable @code{org-adapt-indentation}.},
14700 preserving or adapting the indentation as appropriate.
14703 @vindex org-hide-leading-stars
14704 @emph{Hiding leading stars}@* You can modify the display in such a way that
14705 all leading stars become invisible. To do this in a global way, configure
14706 the variable @code{org-hide-leading-stars} or change this on a per-file basis
14710 #+STARTUP: hidestars
14711 #+STARTUP: showstars
14714 With hidden stars, the tree becomes:
14718 * Top level headline
14726 @vindex org-hide @r{(face)}
14727 The leading stars are not truly replaced by whitespace, they are only
14728 fontified with the face @code{org-hide} that uses the background color as
14729 font color. If you are not using either white or black background, you may
14730 have to customize this face to get the wanted effect. Another possibility is
14731 to set this font such that the extra stars are @i{almost} invisible, for
14732 example using the color @code{grey90} on a white background.
14735 @vindex org-odd-levels-only
14736 Things become cleaner still if you skip all the even levels and use only odd
14737 levels 1, 3, 5..., effectively adding two stars to go from one outline level
14738 to the next@footnote{When you need to specify a level for a property search
14739 or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc@.}. In this
14740 way we get the outline view shown at the beginning of this section. In order
14741 to make the structure editing and export commands handle this convention
14742 correctly, configure the variable @code{org-odd-levels-only}, or set this on
14743 a per-file basis with one of the following lines:
14750 You can convert an Org file from single-star-per-level to the
14751 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
14752 RET} in that file. The reverse operation is @kbd{M-x
14753 org-convert-to-oddeven-levels}.
14756 @node TTY keys, Interaction, Clean view, Miscellaneous
14757 @section Using Org on a tty
14758 @cindex tty key bindings
14760 Because Org contains a large number of commands, by default many of
14761 Org's core commands are bound to keys that are generally not
14762 accessible on a tty, such as the cursor keys (@key{left}, @key{right},
14763 @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
14764 together with modifiers like @key{Meta} and/or @key{Shift}. To access
14765 these commands on a tty when special keys are unavailable, the following
14766 alternative bindings can be used. The tty bindings below will likely be
14767 more cumbersome; you may find for some of the bindings below that a
14768 customized workaround suits you better. For example, changing a timestamp
14769 is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
14770 tty you would rather use @kbd{C-c .} to re-insert the timestamp.
14772 @multitable @columnfractions 0.15 0.2 0.1 0.2
14773 @item @b{Default} @tab @b{Alternative 1} @tab @b{Speed key} @tab @b{Alternative 2}
14774 @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab @kbd{C} @tab
14775 @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{l} @tab @kbd{@key{Esc} @key{left}}
14776 @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab @kbd{L} @tab
14777 @item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{r} @tab @kbd{@key{Esc} @key{right}}
14778 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab @kbd{R} @tab
14779 @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{ } @tab @kbd{@key{Esc} @key{up}}
14780 @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab @kbd{U} @tab
14781 @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{ } @tab @kbd{@key{Esc} @key{down}}
14782 @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab @kbd{D} @tab
14783 @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab @kbd{ } @tab
14784 @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{ } @tab @kbd{@key{Esc} @key{RET}}
14785 @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab @kbd{ } @tab
14786 @item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab @kbd{ } @tab
14787 @item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab @kbd{ } @tab
14788 @item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab @kbd{ } @tab
14789 @item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab @kbd{ } @tab
14790 @item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab @kbd{ } @tab
14791 @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab @kbd{ } @tab
14795 @node Interaction, org-crypt.el, TTY keys, Miscellaneous
14796 @section Interaction with other packages
14797 @cindex packages, interaction with other
14798 Org lives in the world of GNU Emacs and interacts in various ways
14799 with other code out there.
14802 * Cooperation:: Packages Org cooperates with
14803 * Conflicts:: Packages that lead to conflicts
14806 @node Cooperation, Conflicts, Interaction, Interaction
14807 @subsection Packages that Org cooperates with
14810 @cindex @file{calc.el}
14811 @cindex Gillespie, Dave
14812 @item @file{calc.el} by Dave Gillespie
14813 Org uses the Calc package for implementing spreadsheet
14814 functionality in its tables (@pxref{The spreadsheet}). Org
14815 checks for the availability of Calc by looking for the function
14816 @code{calc-eval} which will have been autoloaded during setup if Calc has
14817 been installed properly. As of Emacs 22, Calc is part of the Emacs
14818 distribution. Another possibility for interaction between the two
14819 packages is using Calc for embedded calculations. @xref{Embedded Mode,
14820 , Embedded Mode, Calc, GNU Emacs Calc Manual}.
14821 @item @file{constants.el} by Carsten Dominik
14822 @cindex @file{constants.el}
14823 @cindex Dominik, Carsten
14824 @vindex org-table-formula-constants
14825 In a table formula (@pxref{The spreadsheet}), it is possible to use
14826 names for natural constants or units. Instead of defining your own
14827 constants in the variable @code{org-table-formula-constants}, install
14828 the @file{constants} package which defines a large number of constants
14829 and units, and lets you use unit prefixes like @samp{M} for
14830 @samp{Mega}, etc@. You will need version 2.0 of this package, available
14831 at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for
14832 the function @code{constants-get}, which has to be autoloaded in your
14833 setup. See the installation instructions in the file
14834 @file{constants.el}.
14835 @item @file{cdlatex.el} by Carsten Dominik
14836 @cindex @file{cdlatex.el}
14837 @cindex Dominik, Carsten
14838 Org mode can make use of the CDLa@TeX{} package to efficiently enter
14839 @LaTeX{} fragments into Org files. See @ref{CDLaTeX mode}.
14840 @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
14841 @cindex @file{imenu.el}
14842 Imenu allows menu access to an index of items in a file. Org mode
14843 supports Imenu---all you need to do to get the index is the following:
14845 (add-hook 'org-mode-hook
14846 (lambda () (imenu-add-to-menubar "Imenu")))
14848 @vindex org-imenu-depth
14849 By default the index is two levels deep---you can modify the depth using
14850 the option @code{org-imenu-depth}.
14851 @item @file{remember.el} by John Wiegley
14852 @cindex @file{remember.el}
14853 @cindex Wiegley, John
14854 Org used to use this package for capture, but no longer does.
14855 @item @file{speedbar.el} by Eric M. Ludlam
14856 @cindex @file{speedbar.el}
14857 @cindex Ludlam, Eric M.
14858 Speedbar is a package that creates a special frame displaying files and
14859 index items in files. Org mode supports Speedbar and allows you to
14860 drill into Org files directly from the Speedbar. It also allows you to
14861 restrict the scope of agenda commands to a file or a subtree by using
14862 the command @kbd{<} in the Speedbar frame.
14863 @cindex @file{table.el}
14864 @item @file{table.el} by Takaaki Ota
14866 @cindex table editor, @file{table.el}
14867 @cindex @file{table.el}
14868 @cindex Ota, Takaaki
14870 Complex ASCII tables with automatic line wrapping, column- and row-spanning,
14871 and alignment can be created using the Emacs table package by Takaaki Ota
14872 (@uref{http://sourceforge.net/projects/table}, and also part of Emacs 22).
14873 Org mode will recognize these tables and export them properly. Because of
14874 interference with other Org mode functionality, you unfortunately cannot edit
14875 these tables directly in the buffer. Instead, you need to use the command
14876 @kbd{C-c '} to edit them, similar to source code snippets.
14879 @orgcmd{C-c ',org-edit-special}
14880 Edit a @file{table.el} table. Works when the cursor is in a table.el table.
14882 @orgcmd{C-c ~,org-table-create-with-table.el}
14883 Insert a @file{table.el} table. If there is already a table at point, this
14884 command converts it between the @file{table.el} format and the Org mode
14885 format. See the documentation string of the command
14886 @code{org-convert-table} for the restrictions under which this is
14889 @file{table.el} is part of Emacs since Emacs 22.
14890 @item @file{footnote.el} by Steven L. Baur
14891 @cindex @file{footnote.el}
14892 @cindex Baur, Steven L.
14893 Org mode recognizes numerical footnotes as provided by this package.
14894 However, Org mode also has its own footnote support (@pxref{Footnotes}),
14895 which makes using @file{footnote.el} unnecessary.
14898 @node Conflicts, , Cooperation, Interaction
14899 @subsection Packages that lead to conflicts with Org mode
14903 @cindex @code{shift-selection-mode}
14904 @vindex org-support-shift-select
14905 In Emacs 23, @code{shift-selection-mode} is on by default, meaning that
14906 cursor motions combined with the shift key should start or enlarge regions.
14907 This conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change
14908 timestamps, TODO keywords, priorities, and item bullet types if the cursor is
14909 at such a location. By default, @kbd{S-@key{cursor}} commands outside
14910 special contexts don't do anything, but you can customize the variable
14911 @code{org-support-shift-select}. Org mode then tries to accommodate shift
14912 selection by (i) using it outside of the special contexts where special
14913 commands apply, and by (ii) extending an existing active region even if the
14914 cursor moves across a special context.
14916 @item @file{CUA.el} by Kim. F. Storm
14917 @cindex @file{CUA.el}
14918 @cindex Storm, Kim. F.
14919 @vindex org-replace-disputed-keys
14920 Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by CUA mode
14921 (as well as @code{pc-select-mode} and @code{s-region-mode}) to select and extend the
14922 region. In fact, Emacs 23 has this built-in in the form of
14923 @code{shift-selection-mode}, see previous paragraph. If you are using Emacs
14924 23, you probably don't want to use another package for this purpose. However,
14925 if you prefer to leave these keys to a different package while working in
14926 Org mode, configure the variable @code{org-replace-disputed-keys}. When set,
14927 Org will move the following key bindings in Org files, and in the agenda
14928 buffer (but not during date selection).
14931 S-UP @result{} M-p S-DOWN @result{} M-n
14932 S-LEFT @result{} M-- S-RIGHT @result{} M-+
14933 C-S-LEFT @result{} M-S-- C-S-RIGHT @result{} M-S-+
14936 @vindex org-disputed-keys
14937 Yes, these are unfortunately more difficult to remember. If you want
14938 to have other replacement keys, look at the variable
14939 @code{org-disputed-keys}.
14941 @item @file{yasnippet.el}
14942 @cindex @file{yasnippet.el}
14943 The way Org mode binds the TAB key (binding to @code{[tab]} instead of
14944 @code{"\t"}) overrules YASnippet's access to this key. The following code
14945 fixed this problem:
14948 (add-hook 'org-mode-hook
14950 (org-set-local 'yas/trigger-key [tab])
14951 (define-key yas/keymap [tab] 'yas/next-field-or-maybe-expand)))
14954 The latest version of yasnippet doesn't play well with Org mode. If the
14955 above code does not fix the conflict, start by defining the following
14959 (defun yas/org-very-safe-expand ()
14960 (let ((yas/fallback-behavior 'return-nil)) (yas/expand)))
14963 Then, tell Org mode what to do with the new function:
14966 (add-hook 'org-mode-hook
14968 (make-variable-buffer-local 'yas/trigger-key)
14969 (setq yas/trigger-key [tab])
14970 (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand)
14971 (define-key yas/keymap [tab] 'yas/next-field)))
14974 @item @file{windmove.el} by Hovav Shacham
14975 @cindex @file{windmove.el}
14976 This package also uses the @kbd{S-<cursor>} keys, so everything written
14977 in the paragraph above about CUA mode also applies here. If you want make
14978 the windmove function active in locations where Org mode does not have
14979 special functionality on @kbd{S-@key{cursor}}, add this to your
14983 ;; Make windmove work in org-mode:
14984 (add-hook 'org-shiftup-final-hook 'windmove-up)
14985 (add-hook 'org-shiftleft-final-hook 'windmove-left)
14986 (add-hook 'org-shiftdown-final-hook 'windmove-down)
14987 (add-hook 'org-shiftright-final-hook 'windmove-right)
14990 @item @file{viper.el} by Michael Kifer
14991 @cindex @file{viper.el}
14993 Viper uses @kbd{C-c /} and therefore makes this key not access the
14994 corresponding Org mode command @code{org-sparse-tree}. You need to find
14995 another key for this command, or override the key in
14996 @code{viper-vi-global-user-map} with
14999 (define-key viper-vi-global-user-map "C-c /" 'org-sparse-tree)
15004 @node org-crypt.el, , Interaction, Miscellaneous
15005 @section org-crypt.el
15006 @cindex @file{org-crypt.el}
15007 @cindex @code{org-decrypt-entry}
15009 Org-crypt will encrypt the text of an entry, but not the headline, or
15010 properties. Org-crypt uses the Emacs EasyPG library to encrypt and decrypt
15013 Any text below a headline that has a @samp{:crypt:} tag will be automatically
15014 be encrypted when the file is saved. If you want to use a different tag just
15015 customize the @code{org-crypt-tag-matcher} setting.
15017 To use org-crypt it is suggested that you have the following in your
15021 (require 'org-crypt)
15022 (org-crypt-use-before-save-magic)
15023 (setq org-tags-exclude-from-inheritance (quote ("crypt")))
15025 (setq org-crypt-key nil)
15026 ;; GPG key to use for encryption
15027 ;; Either the Key ID or set to nil to use symmetric encryption.
15029 (setq auto-save-default nil)
15030 ;; Auto-saving does not cooperate with org-crypt.el: so you need
15031 ;; to turn it off if you plan to use org-crypt.el quite often.
15032 ;; Otherwise, you'll get an (annoying) message each time you
15035 ;; To turn it off only locally, you can insert this:
15037 ;; # -*- buffer-auto-save-file-name: nil; -*-
15040 Excluding the crypt tag from inheritance prevents already encrypted text
15041 being encrypted again.
15043 @node Hacking, MobileOrg, Miscellaneous, Top
15047 This appendix covers some aspects where users can extend the functionality of
15051 * Hooks:: Who to reach into Org's internals
15052 * Add-on packages:: Available extensions
15053 * Adding hyperlink types:: New custom link types
15054 * Context-sensitive commands:: How to add functionality to such commands
15055 * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
15056 * Dynamic blocks:: Automatically filled blocks
15057 * Special agenda views:: Customized views
15058 * Extracting agenda information:: Postprocessing of agenda information
15059 * Using the property API:: Writing programs that use entry properties
15060 * Using the mapping API:: Mapping over all or selected entries
15063 @node Hooks, Add-on packages, Hacking, Hacking
15067 Org has a large number of hook variables that can be used to add
15068 functionality. This appendix about hacking is going to illustrate the
15069 use of some of them. A complete list of all hooks with documentation is
15070 maintained by the Worg project and can be found at
15071 @uref{http://orgmode.org/worg/org-configs/org-hooks.php}.
15073 @node Add-on packages, Adding hyperlink types, Hooks, Hacking
15074 @section Add-on packages
15075 @cindex add-on packages
15077 A large number of add-on packages have been written by various authors.
15078 These packages are not part of Emacs, but they are distributed as contributed
15079 packages with the separate release available at the Org mode home page at
15080 @uref{http://orgmode.org}. The list of contributed packages, along with
15081 documentation about each package, is maintained by the Worg project at
15082 @uref{http://orgmode.org/worg/org-contrib/}.
15086 @node Adding hyperlink types, Context-sensitive commands, Add-on packages, Hacking
15087 @section Adding hyperlink types
15088 @cindex hyperlinks, adding new types
15090 Org has a large number of hyperlink types built-in
15091 (@pxref{Hyperlinks}). If you would like to add new link types, Org
15092 provides an interface for doing so. Let's look at an example file,
15093 @file{org-man.el}, that will add support for creating links like
15094 @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
15098 ;;; org-man.el - Support for links to manpages in Org
15102 (org-add-link-type "man" 'org-man-open)
15103 (add-hook 'org-store-link-functions 'org-man-store-link)
15105 (defcustom org-man-command 'man
15106 "The Emacs command to be used to display a man page."
15108 :type '(choice (const man) (const woman)))
15110 (defun org-man-open (path)
15111 "Visit the manpage on PATH.
15112 PATH should be a topic that can be thrown at the man command."
15113 (funcall org-man-command path))
15115 (defun org-man-store-link ()
15116 "Store a link to a manpage."
15117 (when (memq major-mode '(Man-mode woman-mode))
15118 ;; This is a man page, we do make this link
15119 (let* ((page (org-man-get-page-name))
15120 (link (concat "man:" page))
15121 (description (format "Manpage for %s" page)))
15122 (org-store-link-props
15125 :description description))))
15127 (defun org-man-get-page-name ()
15128 "Extract the page name from the buffer name."
15129 ;; This works for both `Man-mode' and `woman-mode'.
15130 (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
15131 (match-string 1 (buffer-name))
15132 (error "Cannot create link to this man page")))
15136 ;;; org-man.el ends here
15140 You would activate this new link type in @file{.emacs} with
15147 Let's go through the file and see what it does.
15150 It does @code{(require 'org)} to make sure that @file{org.el} has been
15153 The next line calls @code{org-add-link-type} to define a new link type
15154 with prefix @samp{man}. The call also contains the name of a function
15155 that will be called to follow such a link.
15157 @vindex org-store-link-functions
15158 The next line adds a function to @code{org-store-link-functions}, in
15159 order to allow the command @kbd{C-c l} to record a useful link in a
15160 buffer displaying a man page.
15163 The rest of the file defines the necessary variables and functions.
15164 First there is a customization variable that determines which Emacs
15165 command should be used to display man pages. There are two options,
15166 @code{man} and @code{woman}. Then the function to follow a link is
15167 defined. It gets the link path as an argument---in this case the link
15168 path is just a topic for the manual command. The function calls the
15169 value of @code{org-man-command} to display the man page.
15171 Finally the function @code{org-man-store-link} is defined. When you try
15172 to store a link with @kbd{C-c l}, this function will be called to
15173 try to make a link. The function must first decide if it is supposed to
15174 create the link for this buffer type; we do this by checking the value
15175 of the variable @code{major-mode}. If not, the function must exit and
15176 return the value @code{nil}. If yes, the link is created by getting the
15177 manual topic from the buffer name and prefixing it with the string
15178 @samp{man:}. Then it must call the command @code{org-store-link-props}
15179 and set the @code{:type} and @code{:link} properties. Optionally you
15180 can also set the @code{:description} property to provide a default for
15181 the link description when the link is later inserted into an Org
15182 buffer with @kbd{C-c C-l}.
15184 When it makes sense for your new link type, you may also define a function
15185 @code{org-PREFIX-complete-link} that implements special (e.g.@: completion)
15186 support for inserting such a link with @kbd{C-c C-l}. Such a function should
15187 not accept any arguments, and return the full link with prefix.
15189 @node Context-sensitive commands, Tables in arbitrary syntax, Adding hyperlink types, Hacking
15190 @section Context-sensitive commands
15191 @cindex context-sensitive commands, hooks
15192 @cindex add-ons, context-sensitive commands
15193 @vindex org-ctrl-c-ctrl-c-hook
15195 Org has several commands that act differently depending on context. The most
15196 important example it the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}).
15197 Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys have this property.
15199 Add-ons can tap into this functionality by providing a function that detects
15200 special context for that add-on and executes functionality appropriate for
15201 the context. Here is an example from Dan Davison's @file{org-R.el} which
15202 allows you to evaluate commands based on the @file{R} programming language
15203 @footnote{@file{org-R.el} has been replaced by the Org mode functionality
15204 described in @ref{Working With Source Code} and is now obsolete.}. For this
15205 package, special contexts are lines that start with @code{#+R:} or
15209 (defun org-R-apply-maybe ()
15210 "Detect if this is context for org-R and execute R commands."
15211 (if (save-excursion
15212 (beginning-of-line 1)
15213 (looking-at "#\\+RR?:"))
15214 (progn (call-interactively 'org-R-apply)
15215 t) ;; to signal that we took action
15216 nil)) ;; to signal that we did not
15218 (add-hook 'org-ctrl-c-ctrl-c-hook 'org-R-apply-maybe)
15221 The function first checks if the cursor is in such a line. If that is the
15222 case, @code{org-R-apply} is called and the function returns @code{t} to
15223 signal that action was taken, and @kbd{C-c C-c} will stop looking for other
15224 contexts. If the function finds it should do nothing locally, it returns
15225 @code{nil} so that other, similar functions can have a try.
15228 @node Tables in arbitrary syntax, Dynamic blocks, Context-sensitive commands, Hacking
15229 @section Tables and lists in arbitrary syntax
15230 @cindex tables, in other modes
15231 @cindex lists, in other modes
15232 @cindex Orgtbl mode
15234 Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
15235 frequent feature request has been to make it work with native tables in
15236 specific languages, for example @LaTeX{}. However, this is extremely
15237 hard to do in a general way, would lead to a customization nightmare,
15238 and would take away much of the simplicity of the Orgtbl mode table
15241 This appendix describes a different approach. We keep the Orgtbl mode
15242 table in its native format (the @i{source table}), and use a custom
15243 function to @i{translate} the table to the correct syntax, and to
15244 @i{install} it in the right location (the @i{target table}). This puts
15245 the burden of writing conversion functions on the user, but it allows
15246 for a very flexible system.
15248 Bastien added the ability to do the same with lists, in Orgstruct mode. You
15249 can use Org's facilities to edit and structure lists by turning
15250 @code{orgstruct-mode} on, then locally exporting such lists in another format
15251 (HTML, @LaTeX{} or Texinfo.)
15255 * Radio tables:: Sending and receiving radio tables
15256 * A LaTeX example:: Step by step, almost a tutorial
15257 * Translator functions:: Copy and modify
15258 * Radio lists:: Doing the same for lists
15261 @node Radio tables, A LaTeX example, Tables in arbitrary syntax, Tables in arbitrary syntax
15262 @subsection Radio tables
15263 @cindex radio tables
15265 To define the location of the target table, you first need to create two
15266 lines that are comments in the current mode, but contain magic words for
15267 Orgtbl mode to find. Orgtbl mode will insert the translated table
15268 between these lines, replacing whatever was there before. For example:
15271 /* BEGIN RECEIVE ORGTBL table_name */
15272 /* END RECEIVE ORGTBL table_name */
15276 Just above the source table, we put a special line that tells
15277 Orgtbl mode how to translate this table and where to install it. For
15281 #+ORGTBL: SEND table_name translation_function arguments....
15285 @code{table_name} is the reference name for the table that is also used
15286 in the receiver lines. @code{translation_function} is the Lisp function
15287 that does the translation. Furthermore, the line can contain a list of
15288 arguments (alternating key and value) at the end. The arguments will be
15289 passed as a property list to the translation function for
15290 interpretation. A few standard parameters are already recognized and
15291 acted upon before the translation function is called:
15295 Skip the first N lines of the table. Hlines do count as separate lines for
15298 @item :skipcols (n1 n2 ...)
15299 List of columns that should be skipped. If the table has a column with
15300 calculation marks, that column is automatically discarded as well.
15301 Please note that the translator function sees the table @emph{after} the
15302 removal of these columns, the function never knows that there have been
15303 additional columns.
15307 The one problem remaining is how to keep the source table in the buffer
15308 without disturbing the normal workings of the file, for example during
15309 compilation of a C file or processing of a @LaTeX{} file. There are a
15310 number of different solutions:
15314 The table could be placed in a block comment if that is supported by the
15315 language. For example, in C mode you could wrap the table between
15316 @samp{/*} and @samp{*/} lines.
15318 Sometimes it is possible to put the table after some kind of @i{END}
15319 statement, for example @samp{\bye} in @TeX{} and @samp{\end@{document@}}
15322 You can just comment the table line-by-line whenever you want to process
15323 the file, and uncomment it whenever you need to edit the table. This
15324 only sounds tedious---the command @kbd{M-x orgtbl-toggle-comment}
15325 makes this comment-toggling very easy, in particular if you bind it to a
15329 @node A LaTeX example, Translator functions, Radio tables, Tables in arbitrary syntax
15330 @subsection A @LaTeX{} example of radio tables
15331 @cindex @LaTeX{}, and Orgtbl mode
15333 The best way to wrap the source table in @LaTeX{} is to use the
15334 @code{comment} environment provided by @file{comment.sty}. It has to be
15335 activated by placing @code{\usepackage@{comment@}} into the document
15336 header. Orgtbl mode can insert a radio table skeleton@footnote{By
15337 default this works only for @LaTeX{}, HTML, and Texinfo. Configure the
15338 variable @code{orgtbl-radio-tables} to install templates for other
15339 modes.} with the command @kbd{M-x orgtbl-insert-radio-table}. You will
15340 be prompted for a table name, let's say we use @samp{salesfigures}. You
15341 will then get the following template:
15343 @cindex #+ORGTBL, SEND
15345 % BEGIN RECEIVE ORGTBL salesfigures
15346 % END RECEIVE ORGTBL salesfigures
15348 #+ORGTBL: SEND salesfigures orgtbl-to-latex
15354 @vindex @LaTeX{}-verbatim-environments
15355 The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
15356 @code{orgtbl-to-latex} to convert the table into @LaTeX{} and to put it
15357 into the receiver location with name @code{salesfigures}. You may now
15358 fill in the table---feel free to use the spreadsheet features@footnote{If
15359 the @samp{#+TBLFM} line contains an odd number of dollar characters,
15360 this may cause problems with font-lock in @LaTeX{} mode. As shown in the
15361 example you can fix this by adding an extra line inside the
15362 @code{comment} environment that is used to balance the dollar
15363 expressions. If you are using AUC@TeX{} with the font-latex library, a
15364 much better solution is to add the @code{comment} environment to the
15365 variable @code{LaTeX-verbatim-environments}.}:
15368 % BEGIN RECEIVE ORGTBL salesfigures
15369 % END RECEIVE ORGTBL salesfigures
15371 #+ORGTBL: SEND salesfigures orgtbl-to-latex
15372 | Month | Days | Nr sold | per day |
15373 |-------+------+---------+---------|
15374 | Jan | 23 | 55 | 2.4 |
15375 | Feb | 21 | 16 | 0.8 |
15376 | March | 22 | 278 | 12.6 |
15377 #+TBLFM: $4=$3/$2;%.1f
15378 % $ (optional extra dollar to keep font-lock happy, see footnote)
15383 When you are done, press @kbd{C-c C-c} in the table to get the converted
15384 table inserted between the two marker lines.
15386 Now let's assume you want to make the table header by hand, because you
15387 want to control how columns are aligned, etc@. In this case we make sure
15388 that the table translator skips the first 2 lines of the source
15389 table, and tell the command to work as a @i{splice}, i.e.@: to not produce
15390 header and footer commands of the target table:
15393 \begin@{tabular@}@{lrrr@}
15394 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
15395 % BEGIN RECEIVE ORGTBL salesfigures
15396 % END RECEIVE ORGTBL salesfigures
15400 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
15401 | Month | Days | Nr sold | per day |
15402 |-------+------+---------+---------|
15403 | Jan | 23 | 55 | 2.4 |
15404 | Feb | 21 | 16 | 0.8 |
15405 | March | 22 | 278 | 12.6 |
15406 #+TBLFM: $4=$3/$2;%.1f
15410 The @LaTeX{} translator function @code{orgtbl-to-latex} is already part of
15411 Orgtbl mode. It uses a @code{tabular} environment to typeset the table
15412 and marks horizontal lines with @code{\hline}. Furthermore, it
15413 interprets the following parameters (see also @pxref{Translator functions}):
15416 @item :splice nil/t
15417 When set to t, return only table body lines, don't wrap them into a
15418 tabular environment. Default is nil.
15421 A format to be used to wrap each field, it should contain @code{%s} for the
15422 original field value. For example, to wrap each field value in dollars,
15423 you could use @code{:fmt "$%s$"}. This may also be a property list with
15424 column numbers and formats, for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
15425 A function of one argument can be used in place of the strings; the
15426 function must return a formatted string.
15429 Use this format to print numbers with exponentials. The format should
15430 have @code{%s} twice for inserting mantissa and exponent, for example
15431 @code{"%s\\times10^@{%s@}"}. The default is @code{"%s\\,(%s)"}. This
15432 may also be a property list with column numbers and formats, for example
15433 @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After
15434 @code{efmt} has been applied to a value, @code{fmt} will also be
15435 applied. Similar to @code{fmt}, functions of two arguments can be
15436 supplied instead of strings.
15439 @node Translator functions, Radio lists, A LaTeX example, Tables in arbitrary syntax
15440 @subsection Translator functions
15441 @cindex HTML, and Orgtbl mode
15442 @cindex translator function
15444 Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
15445 (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
15446 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and @code{orgtbl-to-texinfo}.
15447 Except for @code{orgtbl-to-html}@footnote{The HTML translator uses the same
15448 code that produces tables during HTML export.}, these all use a generic
15449 translator, @code{orgtbl-to-generic}. For example, @code{orgtbl-to-latex}
15450 itself is a very short function that computes the column definitions for the
15451 @code{tabular} environment, defines a few field and line separators and then
15452 hands processing over to the generic translator. Here is the entire code:
15456 (defun orgtbl-to-latex (table params)
15457 "Convert the Orgtbl mode TABLE to LaTeX."
15458 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
15459 org-table-last-alignment ""))
15462 :tstart (concat "\\begin@{tabular@}@{" alignment "@}")
15463 :tend "\\end@{tabular@}"
15464 :lstart "" :lend " \\\\" :sep " & "
15465 :efmt "%s\\,(%s)" :hline "\\hline")))
15466 (orgtbl-to-generic table (org-combine-plists params2 params))))
15470 As you can see, the properties passed into the function (variable
15471 @var{PARAMS}) are combined with the ones newly defined in the function
15472 (variable @var{PARAMS2}). The ones passed into the function (i.e.@: the
15473 ones set by the @samp{ORGTBL SEND} line) take precedence. So if you
15474 would like to use the @LaTeX{} translator, but wanted the line endings to
15475 be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
15476 overrule the default with
15479 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
15482 For a new language, you can either write your own converter function in
15483 analogy with the @LaTeX{} translator, or you can use the generic function
15484 directly. For example, if you have a language where a table is started
15485 with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are
15486 started with @samp{!BL!}, ended with @samp{!EL!}, and where the field
15487 separator is a TAB, you could call the generic translator like this (on
15491 #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
15492 :lstart "!BL! " :lend " !EL!" :sep "\t"
15496 Please check the documentation string of the function
15497 @code{orgtbl-to-generic} for a full list of parameters understood by
15498 that function, and remember that you can pass each of them into
15499 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
15500 using the generic function.
15502 Of course you can also write a completely new function doing complicated
15503 things the generic translator cannot do. A translator function takes
15504 two arguments. The first argument is the table, a list of lines, each
15505 line either the symbol @code{hline} or a list of fields. The second
15506 argument is the property list containing all parameters specified in the
15507 @samp{#+ORGTBL: SEND} line. The function must return a single string
15508 containing the formatted table. If you write a generally useful
15509 translator, please post it on @email{emacs-orgmode@@gnu.org} so that
15510 others can benefit from your work.
15512 @node Radio lists, , Translator functions, Tables in arbitrary syntax
15513 @subsection Radio lists
15514 @cindex radio lists
15515 @cindex org-list-insert-radio-list
15517 Sending and receiving radio lists works exactly the same way as sending and
15518 receiving radio tables (@pxref{Radio tables}). As for radio tables, you can
15519 insert radio list templates in HTML, @LaTeX{} and Texinfo modes by calling
15520 @code{org-list-insert-radio-list}.
15522 Here are the differences with radio tables:
15526 Orgstruct mode must be active.
15528 Use the @code{ORGLST} keyword instead of @code{ORGTBL}.
15530 The available translation functions for radio lists don't take
15533 @kbd{C-c C-c} will work when pressed on the first item of the list.
15536 Here is a @LaTeX{} example. Let's say that you have this in your
15541 % BEGIN RECEIVE ORGLST to-buy
15542 % END RECEIVE ORGLST to-buy
15544 #+ORGLST: SEND to-buy org-list-to-latex
15553 Pressing `C-c C-c' on @code{a new house} and will insert the converted
15554 @LaTeX{} list between the two marker lines.
15556 @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Hacking
15557 @section Dynamic blocks
15558 @cindex dynamic blocks
15560 Org documents can contain @emph{dynamic blocks}. These are
15561 specially marked regions that are updated by some user-written function.
15562 A good example for such a block is the clock table inserted by the
15563 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
15565 Dynamic blocks are enclosed by a BEGIN-END structure that assigns a name
15566 to the block and can also specify parameters for the function producing
15567 the content of the block.
15569 @cindex #+BEGIN:dynamic block
15571 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
15576 Dynamic blocks are updated with the following commands
15579 @orgcmd{C-c C-x C-u,org-dblock-update}
15580 Update dynamic block at point.
15581 @orgkey{C-u C-c C-x C-u}
15582 Update all dynamic blocks in the current file.
15585 Updating a dynamic block means to remove all the text between BEGIN and
15586 END, parse the BEGIN line for parameters and then call the specific
15587 writer function for this block to insert the new content. If you want
15588 to use the original content in the writer function, you can use the
15589 extra parameter @code{:content}.
15591 For a block with name @code{myblock}, the writer function is
15592 @code{org-dblock-write:myblock} with as only parameter a property list
15593 with the parameters given in the begin line. Here is a trivial example
15594 of a block that keeps track of when the block update function was last
15598 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
15604 The corresponding block writer function could look like this:
15607 (defun org-dblock-write:block-update-time (params)
15608 (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
15609 (insert "Last block update at: "
15610 (format-time-string fmt (current-time)))))
15613 If you want to make sure that all dynamic blocks are always up-to-date,
15614 you could add the function @code{org-update-all-dblocks} to a hook, for
15615 example @code{before-save-hook}. @code{org-update-all-dblocks} is
15616 written in a way such that it does nothing in buffers that are not in
15619 You can narrow the current buffer to the current dynamic block (like any
15620 other block) with @code{org-narrow-to-block}.
15622 @node Special agenda views, Extracting agenda information, Dynamic blocks, Hacking
15623 @section Special agenda views
15624 @cindex agenda views, user-defined
15626 @vindex org-agenda-skip-function
15627 @vindex org-agenda-skip-function-global
15628 Org provides a special hook that can be used to narrow down the selection
15629 made by these agenda views: @code{agenda}, @code{todo}, @code{alltodo},
15630 @code{tags}, @code{tags-todo}, @code{tags-tree}. You may specify a function
15631 that is used at each match to verify if the match should indeed be part of
15632 the agenda view, and if not, how much should be skipped. You can specify a
15633 global condition that will be applied to all agenda views, this condition
15634 would be stored in the variable @code{org-agenda-skip-function-global}. More
15635 commonly, such a definition is applied only to specific custom searches,
15636 using @code{org-agenda-skip-function}.
15638 Let's say you want to produce a list of projects that contain a WAITING
15639 tag anywhere in the project tree. Let's further assume that you have
15640 marked all tree headings that define a project with the TODO keyword
15641 PROJECT. In this case you would run a TODO search for the keyword
15642 PROJECT, but skip the match unless there is a WAITING tag anywhere in
15643 the subtree belonging to the project line.
15645 To achieve this, you must write a function that searches the subtree for
15646 the tag. If the tag is found, the function must return @code{nil} to
15647 indicate that this match should not be skipped. If there is no such
15648 tag, return the location of the end of the subtree, to indicate that
15649 search should continue from there.
15652 (defun my-skip-unless-waiting ()
15653 "Skip trees that are not waiting"
15654 (let ((subtree-end (save-excursion (org-end-of-subtree t))))
15655 (if (re-search-forward ":waiting:" subtree-end t)
15656 nil ; tag found, do not skip
15657 subtree-end))) ; tag not found, continue after end of subtree
15660 Now you may use this function in an agenda custom command, for example
15664 (org-add-agenda-custom-command
15665 '("b" todo "PROJECT"
15666 ((org-agenda-skip-function 'my-skip-unless-waiting)
15667 (org-agenda-overriding-header "Projects waiting for something: "))))
15670 @vindex org-agenda-overriding-header
15671 Note that this also binds @code{org-agenda-overriding-header} to get a
15672 meaningful header in the agenda view.
15674 @vindex org-odd-levels-only
15675 @vindex org-agenda-skip-function
15676 A general way to create custom searches is to base them on a search for
15677 entries with a certain level limit. If you want to study all entries with
15678 your custom search function, simply do a search for
15679 @samp{LEVEL>0}@footnote{Note that, when using @code{org-odd-levels-only}, a
15680 level number corresponds to order in the hierarchy, not to the number of
15681 stars.}, and then use @code{org-agenda-skip-function} to select the entries
15682 you really want to have.
15684 You may also put a Lisp form into @code{org-agenda-skip-function}. In
15685 particular, you may use the functions @code{org-agenda-skip-entry-if}
15686 and @code{org-agenda-skip-subtree-if} in this form, for example:
15689 @item (org-agenda-skip-entry-if 'scheduled)
15690 Skip current entry if it has been scheduled.
15691 @item (org-agenda-skip-entry-if 'notscheduled)
15692 Skip current entry if it has not been scheduled.
15693 @item (org-agenda-skip-entry-if 'deadline)
15694 Skip current entry if it has a deadline.
15695 @item (org-agenda-skip-entry-if 'scheduled 'deadline)
15696 Skip current entry if it has a deadline, or if it is scheduled.
15697 @item (org-agenda-skip-entry-if 'todo '("TODO" "WAITING"))
15698 Skip current entry if the TODO keyword is TODO or WAITING.
15699 @item (org-agenda-skip-entry-if 'todo 'done)
15700 Skip current entry if the TODO keyword marks a DONE state.
15701 @item (org-agenda-skip-entry-if 'timestamp)
15702 Skip current entry if it has any timestamp, may also be deadline or scheduled.
15703 @item (org-agenda-skip-entry 'regexp "regular expression")
15704 Skip current entry if the regular expression matches in the entry.
15705 @item (org-agenda-skip-entry 'notregexp "regular expression")
15706 Skip current entry unless the regular expression matches.
15707 @item (org-agenda-skip-subtree-if 'regexp "regular expression")
15708 Same as above, but check and skip the entire subtree.
15711 Therefore we could also have written the search for WAITING projects
15712 like this, even without defining a special function:
15715 (org-add-agenda-custom-command
15716 '("b" todo "PROJECT"
15717 ((org-agenda-skip-function '(org-agenda-skip-subtree-if
15718 'regexp ":waiting:"))
15719 (org-agenda-overriding-header "Projects waiting for something: "))))
15722 @node Extracting agenda information, Using the property API, Special agenda views, Hacking
15723 @section Extracting agenda information
15724 @cindex agenda, pipe
15725 @cindex Scripts, for agenda processing
15727 @vindex org-agenda-custom-commands
15728 Org provides commands to access agenda information for the command
15729 line in Emacs batch mode. This extracted information can be sent
15730 directly to a printer, or it can be read by a program that does further
15731 processing of the data. The first of these commands is the function
15732 @code{org-batch-agenda}, that produces an agenda view and sends it as
15733 ASCII text to STDOUT. The command takes a single string as parameter.
15734 If the string has length 1, it is used as a key to one of the commands
15735 you have configured in @code{org-agenda-custom-commands}, basically any
15736 key you can use after @kbd{C-c a}. For example, to directly print the
15737 current TODO list, you could use
15740 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
15743 If the parameter is a string with 2 or more characters, it is used as a
15744 tags/TODO match string. For example, to print your local shopping list
15745 (all items with the tag @samp{shop}, but excluding the tag
15746 @samp{NewYork}), you could use
15749 emacs -batch -l ~/.emacs \
15750 -eval '(org-batch-agenda "+shop-NewYork")' | lpr
15754 You may also modify parameters on the fly like this:
15757 emacs -batch -l ~/.emacs \
15758 -eval '(org-batch-agenda "a" \
15759 org-agenda-span (quote month) \
15760 org-agenda-include-diary nil \
15761 org-agenda-files (quote ("~/org/project.org")))' \
15766 which will produce a 30-day agenda, fully restricted to the Org file
15767 @file{~/org/projects.org}, not even including the diary.
15769 If you want to process the agenda data in more sophisticated ways, you
15770 can use the command @code{org-batch-agenda-csv} to get a comma-separated
15771 list of values for each agenda item. Each line in the output will
15772 contain a number of fields separated by commas. The fields in a line
15776 category @r{The category of the item}
15777 head @r{The headline, without TODO keyword, TAGS and PRIORITY}
15778 type @r{The type of the agenda entry, can be}
15779 todo @r{selected in TODO match}
15780 tagsmatch @r{selected in tags match}
15781 diary @r{imported from diary}
15782 deadline @r{a deadline}
15783 scheduled @r{scheduled}
15784 timestamp @r{appointment, selected by timestamp}
15785 closed @r{entry was closed on date}
15786 upcoming-deadline @r{warning about nearing deadline}
15787 past-scheduled @r{forwarded scheduled item}
15788 block @r{entry has date block including date}
15789 todo @r{The TODO keyword, if any}
15790 tags @r{All tags including inherited ones, separated by colons}
15791 date @r{The relevant date, like 2007-2-14}
15792 time @r{The time, like 15:00-16:50}
15793 extra @r{String with extra planning info}
15794 priority-l @r{The priority letter if any was given}
15795 priority-n @r{The computed numerical priority}
15799 Time and date will only be given if a timestamp (or deadline/scheduled)
15800 led to the selection of the item.
15802 A CSV list like this is very easy to use in a post-processing script.
15803 For example, here is a Perl program that gets the TODO list from
15804 Emacs/Org and prints all the items, preceded by a checkbox:
15809 # define the Emacs command to run
15810 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
15812 # run it and capture the output
15813 $agenda = qx@{$cmd 2>/dev/null@};
15815 # loop over all lines
15816 foreach $line (split(/\n/,$agenda)) @{
15817 # get the individual values
15818 ($category,$head,$type,$todo,$tags,$date,$time,$extra,
15819 $priority_l,$priority_n) = split(/,/,$line);
15820 # process and print
15821 print "[ ] $head\n";
15825 @node Using the property API, Using the mapping API, Extracting agenda information, Hacking
15826 @section Using the property API
15827 @cindex API, for properties
15828 @cindex properties, API
15830 Here is a description of the functions that can be used to work with
15833 @defun org-entry-properties &optional pom which
15834 Get all properties of the entry at point-or-marker POM.@*
15835 This includes the TODO keyword, the tags, time strings for deadline,
15836 scheduled, and clocking, and any additional properties defined in the
15837 entry. The return value is an alist. Keys may occur multiple times
15838 if the property key was used several times.@*
15839 POM may also be nil, in which case the current entry is used.
15840 If WHICH is nil or `all', get all properties. If WHICH is
15841 `special' or `standard', only get that subclass.
15843 @vindex org-use-property-inheritance
15844 @defun org-entry-get pom property &optional inherit
15845 Get value of PROPERTY for entry at point-or-marker POM. By default,
15846 this only looks at properties defined locally in the entry. If INHERIT
15847 is non-nil and the entry does not have the property, then also check
15848 higher levels of the hierarchy. If INHERIT is the symbol
15849 @code{selective}, use inheritance if and only if the setting of
15850 @code{org-use-property-inheritance} selects PROPERTY for inheritance.
15853 @defun org-entry-delete pom property
15854 Delete the property PROPERTY from entry at point-or-marker POM.
15857 @defun org-entry-put pom property value
15858 Set PROPERTY to VALUE for entry at point-or-marker POM.
15861 @defun org-buffer-property-keys &optional include-specials
15862 Get all property keys in the current buffer.
15865 @defun org-insert-property-drawer
15866 Insert a property drawer at point.
15869 @defun org-entry-put-multivalued-property pom property &rest values
15870 Set PROPERTY at point-or-marker POM to VALUES. VALUES should be a list of
15871 strings. They will be concatenated, with spaces as separators.
15874 @defun org-entry-get-multivalued-property pom property
15875 Treat the value of the property PROPERTY as a whitespace-separated list of
15876 values and return the values as a list of strings.
15879 @defun org-entry-add-to-multivalued-property pom property value
15880 Treat the value of the property PROPERTY as a whitespace-separated list of
15881 values and make sure that VALUE is in this list.
15884 @defun org-entry-remove-from-multivalued-property pom property value
15885 Treat the value of the property PROPERTY as a whitespace-separated list of
15886 values and make sure that VALUE is @emph{not} in this list.
15889 @defun org-entry-member-in-multivalued-property pom property value
15890 Treat the value of the property PROPERTY as a whitespace-separated list of
15891 values and check if VALUE is in this list.
15894 @defopt org-property-allowed-value-functions
15895 Hook for functions supplying allowed values for a specific property.
15896 The functions must take a single argument, the name of the property, and
15897 return a flat list of allowed values. If @samp{:ETC} is one of
15898 the values, use the values as completion help, but allow also other values
15899 to be entered. The functions must return @code{nil} if they are not
15900 responsible for this property.
15903 @node Using the mapping API, , Using the property API, Hacking
15904 @section Using the mapping API
15905 @cindex API, for mapping
15906 @cindex mapping entries, API
15908 Org has sophisticated mapping capabilities to find all entries satisfying
15909 certain criteria. Internally, this functionality is used to produce agenda
15910 views, but there is also an API that can be used to execute arbitrary
15911 functions for each or selected entries. The main entry point for this API
15914 @defun org-map-entries func &optional match scope &rest skip
15915 Call FUNC at each headline selected by MATCH in SCOPE.
15917 FUNC is a function or a Lisp form. The function will be called without
15918 arguments, with the cursor positioned at the beginning of the headline.
15919 The return values of all calls to the function will be collected and
15920 returned as a list.
15922 The call to FUNC will be wrapped into a save-excursion form, so FUNC
15923 does not need to preserve point. After evaluation, the cursor will be
15924 moved to the end of the line (presumably of the headline of the
15925 processed entry) and search continues from there. Under some
15926 circumstances, this may not produce the wanted results. For example,
15927 if you have removed (e.g.@: archived) the current (sub)tree it could
15928 mean that the next entry will be skipped entirely. In such cases, you
15929 can specify the position from where search should continue by making
15930 FUNC set the variable `org-map-continue-from' to the desired buffer
15933 MATCH is a tags/property/todo match as it is used in the agenda match view.
15934 Only headlines that are matched by this query will be considered during
15935 the iteration. When MATCH is nil or t, all headlines will be
15936 visited by the iteration.
15938 SCOPE determines the scope of this command. It can be any of:
15941 nil @r{the current buffer, respecting the restriction if any}
15942 tree @r{the subtree started with the entry at point}
15943 region @r{The entries within the active region, if any}
15944 file @r{the current buffer, without restriction}
15946 @r{the current buffer, and any archives associated with it}
15947 agenda @r{all agenda files}
15948 agenda-with-archives
15949 @r{all agenda files with any archive files associated with them}
15951 @r{if this is a list, all files in the list will be scanned}
15954 The remaining args are treated as settings for the skipping facilities of
15955 the scanner. The following items can be given here:
15957 @vindex org-agenda-skip-function
15959 archive @r{skip trees with the archive tag}
15960 comment @r{skip trees with the COMMENT keyword}
15961 function or Lisp form
15962 @r{will be used as value for @code{org-agenda-skip-function},}
15963 @r{so whenever the function returns t, FUNC}
15964 @r{will not be called for that entry and search will}
15965 @r{continue from the point where the function leaves it}
15969 The function given to that mapping routine can really do anything you like.
15970 It can use the property API (@pxref{Using the property API}) to gather more
15971 information about the entry, or in order to change metadata in the entry.
15972 Here are a couple of functions that might be handy:
15974 @defun org-todo &optional arg
15975 Change the TODO state of the entry. See the docstring of the functions for
15976 the many possible values for the argument ARG.
15979 @defun org-priority &optional action
15980 Change the priority of the entry. See the docstring of this function for the
15981 possible values for ACTION.
15984 @defun org-toggle-tag tag &optional onoff
15985 Toggle the tag TAG in the current entry. Setting ONOFF to either @code{on}
15986 or @code{off} will not toggle tag, but ensure that it is either on or off.
15990 Promote the current entry.
15994 Demote the current entry.
15997 Here is a simple example that will turn all entries in the current file with
15998 a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
15999 Entries in comment trees and in archive trees will be ignored.
16003 '(org-todo "UPCOMING")
16004 "+TOMORROW" 'file 'archive 'comment)
16007 The following example counts the number of entries with TODO keyword
16008 @code{WAITING}, in all agenda files.
16011 (length (org-map-entries t "/+WAITING" 'agenda))
16014 @node MobileOrg, History and Acknowledgments, Hacking, Top
16015 @appendix MobileOrg
16019 @uref{http://mobileorg.ncogni.to/, MobileOrg} is an application for the
16020 @i{iPhone/iPod Touch} series of devices, developed by Richard Moreland.
16021 @i{MobileOrg} offers offline viewing and capture support for an Org mode
16022 system rooted on a ``real'' computer. It does also allow you to record
16023 changes to existing entries. Android users should check out
16024 @uref{http://wiki.github.com/matburt/mobileorg-android/, MobileOrg Android}
16027 This appendix describes the support Org has for creating agenda views in a
16028 format that can be displayed by @i{MobileOrg}, and for integrating notes
16029 captured and changes made by @i{MobileOrg} into the main system.
16031 For changing tags and TODO states in MobileOrg, you should have set up the
16032 customization variables @code{org-todo-keywords} and @code{org-tags-alist} to
16033 cover all important tags and TODO keywords, even if individual files use only
16034 part of these. MobileOrg will also offer you states and tags set up with
16035 in-buffer settings, but it will understand the logistics of TODO state
16036 @i{sets} (@pxref{Per-file keywords}) and @i{mutually exclusive} tags
16037 (@pxref{Setting tags}) only for those set in these variables.
16040 * Setting up the staging area:: Where to interact with the mobile device
16041 * Pushing to MobileOrg:: Uploading Org files and agendas
16042 * Pulling from MobileOrg:: Integrating captured and flagged items
16045 @node Setting up the staging area, Pushing to MobileOrg, MobileOrg, MobileOrg
16046 @section Setting up the staging area
16048 MobileOrg needs to interact with Emacs through a directory on a server. If you
16049 are using a public server, you should consider to encrypt the files that are
16050 uploaded to the server. This can be done with Org mode 7.02 and with
16051 @i{MobileOrg 1.5} (iPhone version), and you need an @file{openssl}
16052 installation on your system. To turn on encryption, set a password in
16053 @i{MobileOrg} and, on the Emacs side, configure the variable
16054 @code{org-mobile-use-encryption}@footnote{If you can safely store the
16055 password in your Emacs setup, you might also want to configure
16056 @code{org-mobile-encryption-password}. Please read the docstring of that
16057 variable. Note that encryption will apply only to the contents of the
16058 @file{.org} files. The file names themselves will remain visible.}.
16060 The easiest way to create that directory is to use a free
16061 @uref{http://dropbox.com,Dropbox.com} account@footnote{If you cannot use
16062 Dropbox, or if your version of MobileOrg does not support it, you can use a
16063 webdav server. For more information, check out the documentation of MobileOrg and also this
16064 @uref{http://orgmode.org/worg/org-faq.html#mobileorg_webdav, FAQ entry}.}.
16065 When MobileOrg first connects to your Dropbox, it will create a directory
16066 @i{MobileOrg} inside the Dropbox. After the directory has been created, tell
16070 (setq org-mobile-directory "~/Dropbox/MobileOrg")
16073 Org mode has commands to put files for @i{MobileOrg} into that directory,
16074 and to read captured notes from there.
16076 @node Pushing to MobileOrg, Pulling from MobileOrg, Setting up the staging area, MobileOrg
16077 @section Pushing to MobileOrg
16079 This operation copies all files currently listed in @code{org-mobile-files}
16080 to the directory @code{org-mobile-directory}. By default this list contains
16081 all agenda files (as listed in @code{org-agenda-files}), but additional files
16082 can be included by customizing @code{org-mobile-files}. File names will be
16083 staged with paths relative to @code{org-directory}, so all files should be
16084 inside this directory. The push operation also creates a special Org file
16085 @file{agendas.org} with all custom agenda view defined by the
16086 user@footnote{While creating the agendas, Org mode will force ID properties
16087 on all referenced entries, so that these entries can be uniquely identified
16088 if @i{MobileOrg} flags them for further action. If you do not want to get
16089 these properties in so many entries, you can set the variable
16090 @code{org-mobile-force-id-on-agenda-items} to @code{nil}. Org mode will then
16091 rely on outline paths, in the hope that these will be unique enough.}.
16092 Finally, Org writes the file @file{index.org}, containing links to all other
16093 files. @i{MobileOrg} first reads this file from the server, and then
16094 downloads all agendas and Org files listed in it. To speed up the download,
16095 MobileOrg will only read files whose checksums@footnote{stored automatically
16096 in the file @file{checksums.dat}} have changed.
16098 @node Pulling from MobileOrg, , Pushing to MobileOrg, MobileOrg
16099 @section Pulling from MobileOrg
16101 When @i{MobileOrg} synchronizes with the server, it not only pulls the Org
16102 files for viewing. It also appends captured entries and pointers to flagged
16103 and changed entries to the file @file{mobileorg.org} on the server. Org has
16104 a @emph{pull} operation that integrates this information into an inbox file
16105 and operates on the pointers to flagged entries. Here is how it works:
16109 Org moves all entries found in
16110 @file{mobileorg.org}@footnote{@file{mobileorg.org} will be empty after this
16111 operation.} and appends them to the file pointed to by the variable
16112 @code{org-mobile-inbox-for-pull}. Each captured entry and each editing event
16113 will be a top-level entry in the inbox file.
16115 After moving the entries, Org will attempt to implement the changes made in
16116 @i{MobileOrg}. Some changes are applied directly and without user
16117 interaction. Examples are all changes to tags, TODO state, headline and body
16118 text that can be cleanly applied. Entries that have been flagged for further
16119 action will receive a tag @code{:FLAGGED:}, so that they can be easily found
16120 again. When there is a problem finding an entry or applying the change, the
16121 pointer entry will remain in the inbox and will be marked with an error
16122 message. You need to later resolve these issues by hand.
16124 Org will then generate an agenda view with all flagged entries. The user
16125 should then go through these entries and do whatever actions are necessary.
16126 If a note has been stored while flagging an entry in @i{MobileOrg}, that note
16127 will be displayed in the echo area when the cursor is on the corresponding
16132 Pressing @kbd{?} in that special agenda will display the full flagging note in
16133 another window and also push it onto the kill ring. So you could use @kbd{?
16134 z C-y C-c C-c} to store that flagging note as a normal note in the entry.
16135 Pressing @kbd{?} twice in succession will offer to remove the
16136 @code{:FLAGGED:} tag along with the recorded flagging note (which is stored
16137 in a property). In this way you indicate that the intended processing for
16138 this flagged entry is finished.
16143 If you are not able to process all flagged entries directly, you can always
16144 return to this agenda view@footnote{Note, however, that there is a subtle
16145 difference. The view created automatically by @kbd{M-x org-mobile-pull
16146 @key{RET}} is guaranteed to search all files that have been addressed by the
16147 last pull. This might include a file that is not currently in your list of
16148 agenda files. If you later use @kbd{C-c a ?} to regenerate the view, only
16149 the current agenda files will be searched.} using @kbd{C-c a ?}.
16151 @node History and Acknowledgments, Main Index, MobileOrg, Top
16152 @appendix History and acknowledgments
16153 @cindex acknowledgments
16157 Org was born in 2003, out of frustration over the user interface of the Emacs
16158 Outline mode. I was trying to organize my notes and projects, and using
16159 Emacs seemed to be the natural way to go. However, having to remember eleven
16160 different commands with two or three keys per command, only to hide and show
16161 parts of the outline tree, that seemed entirely unacceptable to me. Also,
16162 when using outlines to take notes, I constantly wanted to restructure the
16163 tree, organizing it parallel to my thoughts and plans. @emph{Visibility
16164 cycling} and @emph{structure editing} were originally implemented in the
16165 package @file{outline-magic.el}, but quickly moved to the more general
16166 @file{org.el}. As this environment became comfortable for project planning,
16167 the next step was adding @emph{TODO entries}, basic @emph{timestamps}, and
16168 @emph{table support}. These areas highlighted the two main goals that Org
16169 still has today: to be a new, outline-based, plain text mode with innovative
16170 and intuitive editing features, and to incorporate project planning
16171 functionality directly into a notes file.
16173 Since the first release, literally thousands of emails to me or to
16174 @email{emacs-orgmode@@gnu.org} have provided a constant stream of bug
16175 reports, feedback, new ideas, and sometimes patches and add-on code.
16176 Many thanks to everyone who has helped to improve this package. I am
16177 trying to keep here a list of the people who had significant influence
16178 in shaping one or more aspects of Org. The list may not be
16179 complete, if I have forgotten someone, please accept my apologies and
16182 Before I get to this list, a few special mentions are in order:
16185 @item Bastien Guerry
16186 Bastien has written a large number of extensions to Org (most of them
16187 integrated into the core by now), including the LaTeX exporter and the plain
16188 list parser. His support during the early days, when he basically acted as
16189 co-maintainer, was central to the success of this project. Bastien also
16190 invented Worg, helped establishing the Web presence of Org, and sponsors
16191 hosting costs for the orgmode.org website.
16192 @item Eric Schulte and Dan Davison
16193 Eric and Dan are jointly responsible for the Org-babel system, which turns
16194 Org into a multi-language environment for evaluating code and doing literate
16195 programming and reproducible research.
16197 John has contributed a number of great ideas and patches directly to Org,
16198 including the attachment system (@file{org-attach.el}), integration with
16199 Apple Mail (@file{org-mac-message.el}), hierarchical dependencies of TODO
16200 items, habit tracking (@file{org-habits.el}), and encryption
16201 (@file{org-crypt.el}). Also, the capture system is really an extended copy
16202 of his great @file{remember.el}.
16203 @item Sebastian Rose
16204 Without Sebastian, the HTML/XHTML publishing of Org would be the pitiful work
16205 of an ignorant amateur. Sebastian has pushed this part of Org onto a much
16206 higher level. He also wrote @file{org-info.js}, a Java script for displaying
16207 webpages derived from Org using an Info-like or a folding interface with
16208 single-key navigation.
16211 @noindent OK, now to the full list of contributions! Again, please let me
16212 know what I am missing here!
16217 @i{Russel Adams} came up with the idea for drawers.
16219 @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
16221 @i{Christophe Bataillon} created the great unicorn logo that we use on the
16224 @i{Alex Bochannek} provided a patch for rounding timestamps.
16226 @i{Jan Böcker} wrote @file{org-docview.el}.
16228 @i{Brad Bozarth} showed how to pull RSS feed data into Org mode files.
16230 @i{Tom Breton} wrote @file{org-choose.el}.
16232 @i{Charles Cave}'s suggestion sparked the implementation of templates
16233 for Remember, which are now templates for capture.
16235 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
16238 @i{Gregory Chernov} patched support for Lisp forms into table
16239 calculations and improved XEmacs compatibility, in particular by porting
16240 @file{nouline.el} to XEmacs.
16242 @i{Sacha Chua} suggested copying some linking code from Planner.
16244 @i{Baoqiu Cui} contributed the DocBook exporter.
16246 @i{Eddward DeVilla} proposed and tested checkbox statistics. He also
16247 came up with the idea of properties, and that there should be an API for
16250 @i{Nick Dokos} tracked down several nasty bugs.
16252 @i{Kees Dullemond} used to edit projects lists directly in HTML and so
16253 inspired some of the early development, including HTML export. He also
16254 asked for a way to narrow wide table columns.
16256 @i{Thomas S. Dye} contributed documentation on Worg and helped integrating
16257 the Org-Babel documentation into the manual.
16259 @i{Christian Egli} converted the documentation into Texinfo format, inspired
16260 the agenda, patched CSS formatting into the HTML exporter, and wrote
16261 @file{org-taskjuggler.el}.
16263 @i{David Emery} provided a patch for custom CSS support in exported
16266 @i{Nic Ferrier} contributed mailcap and XOXO support.
16268 @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
16270 @i{John Foerch} figured out how to make incremental search show context
16271 around a match in a hidden outline tree.
16273 @i{Raimar Finken} wrote @file{org-git-line.el}.
16275 @i{Mikael Fornius} works as a mailing list moderator.
16277 @i{Austin Frank} works as a mailing list moderator.
16279 @i{Eric Fraga} drove the development of BEAMER export with ideas and
16282 @i{Barry Gidden} did proofreading the manual in preparation for the book
16283 publication through Network Theory Ltd.
16285 @i{Niels Giesen} had the idea to automatically archive DONE trees.
16287 @i{Nicolas Goaziou} rewrote much of the plain list code.
16289 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
16291 @i{Brian Gough} of Network Theory Ltd publishes the Org mode manual as a
16294 @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
16295 task state change logging, and the clocktable. His clear explanations have
16296 been critical when we started to adopt the Git version control system.
16298 @i{Manuel Hermenegildo} has contributed various ideas, small fixes and
16301 @i{Phil Jackson} wrote @file{org-irc.el}.
16303 @i{Scott Jaderholm} proposed footnotes, control over whitespace between
16304 folded entries, and column view for properties.
16306 @i{Matt Jones} wrote @i{MobileOrg Android}.
16308 @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
16310 @i{Shidai Liu} ("Leo") asked for embedded @LaTeX{} and tested it. He also
16311 provided frequent feedback and some patches.
16313 @i{Matt Lundin} has proposed last-row references for table formulas and named
16314 invisible anchors. He has also worked a lot on the FAQ.
16316 @i{David Maus} wrote @file{org-atom.el}, maintains the issues file for Org,
16317 and is a prolific contributor on the mailing list with competent replies,
16318 small fixes and patches.
16320 @i{Jason F. McBrayer} suggested agenda export to CSV format.
16322 @i{Max Mikhanosha} came up with the idea of refiling.
16324 @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
16327 @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
16330 @i{Richard Moreland} wrote @i{MobileOrg} for the iPhone.
16332 @i{Rick Moynihan} proposed allowing multiple TODO sequences in a file
16333 and being able to quickly restrict the agenda to a subtree.
16335 @i{Todd Neal} provided patches for links to Info files and Elisp forms.
16337 @i{Greg Newman} refreshed the unicorn logo into its current form.
16339 @i{Tim O'Callaghan} suggested in-file links, search options for general
16340 file links, and TAGS.
16342 @i{Osamu Okano} wrote @file{orgcard2ref.pl}, a Perl program to create a text
16343 version of the reference card.
16345 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
16348 @i{Oliver Oppitz} suggested multi-state TODO items.
16350 @i{Scott Otterson} sparked the introduction of descriptive text for
16351 links, among other things.
16353 @i{Pete Phillips} helped during the development of the TAGS feature, and
16354 provided frequent feedback.
16356 @i{Martin Pohlack} provided the code snippet to bundle character insertion
16357 into bundles of 20 for undo.
16359 @i{T.V. Raman} reported bugs and suggested improvements.
16361 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
16364 @i{Paul Rivier} provided the basic implementation of named footnotes. He
16365 also acted as mailing list moderator for some time.
16367 @i{Kevin Rogers} contributed code to access VM files on remote hosts.
16369 @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
16370 conflict with @file{allout.el}.
16372 @i{Jason Riedy} generalized the send-receive mechanism for Orgtbl tables with
16375 @i{Philip Rooke} created the Org reference card, provided lots
16376 of feedback, developed and applied standards to the Org documentation.
16378 @i{Christian Schlauer} proposed angular brackets around links, among
16381 @i{Paul Sexton} wrote @file{org-ctags.el}.
16383 Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
16384 @file{organizer-mode.el}.
16386 @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal
16387 examples, and remote highlighting for referenced code lines.
16389 @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
16390 now packaged into Org's @file{contrib} directory.
16392 @i{Daniel Sinder} came up with the idea of internal archiving by locking
16395 @i{Dale Smith} proposed link abbreviations.
16397 @i{James TD Smith} has contributed a large number of patches for useful
16398 tweaks and features.
16400 @i{Adam Spiers} asked for global linking commands, inspired the link
16401 extension system, added support for mairix, and proposed the mapping API.
16403 @i{Ulf Stegemann} created the table to translate special symbols to HTML,
16404 LaTeX, UTF-8, Latin-1 and ASCII.
16406 @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content
16407 with links transformation to Org syntax.
16409 @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
16410 chapter about publishing.
16412 @i{Jambunathan K} contributed the @acronym{ODT} exporter.
16414 @i{Sebastien Vauban} reported many issues with LaTeX and BEAMER export and
16415 enabled source code highlighling in Gnus.
16417 @i{Stefan Vollmar} organized a video-recorded talk at the
16418 Max-Planck-Institute for Neurology. He also inspired the creation of a
16419 concept index for HTML export.
16421 @i{J@"urgen Vollmer} contributed code generating the table of contents
16424 @i{Samuel Wales} has provided important feedback and bug reports.
16426 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
16429 @i{David Wainberg} suggested archiving, and improvements to the linking
16432 @i{Carsten Wimmer} suggested some changes and helped fix a bug in
16435 @i{Roland Winkler} requested additional key bindings to make Org
16438 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
16439 and contributed various ideas and code snippets.
16444 @node Main Index, Key Index, History and Acknowledgments, Top
16445 @unnumbered Concept index
16449 @node Key Index, Command and Function Index, Main Index, Top
16450 @unnumbered Key index
16454 @node Command and Function Index, Variable Index, Key Index, Top
16455 @unnumbered Command and function index
16459 @node Variable Index, , Command and Function Index, Top
16460 @unnumbered Variable index
16462 This is not a complete index of variables and faces, only the ones that are
16463 mentioned in the manual. For a more complete list, use @kbd{M-x
16464 org-customize @key{RET}} and then click yourself through the tree.
16470 @c Local variables:
16472 @c indent-tabs-mode: nil
16473 @c paragraph-start: "
\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|\f\\|[ ]*$"
16474 @c paragraph-separate: "
\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|[ \f]*$"
16478 @c LocalWords: webdavhost pre