3 @setfilename ../../info/org
4 @settitle The Org Manual
6 @include org-version.inc
8 @c Use proper quote and backtick for code sections in PDF output
9 @c Cf. Texinfo manual 14.2
10 @set txicodequoteundirected
11 @set txicodequotebacktick
13 @c Version and Contact Info
14 @set MAINTAINERSITE @uref{http://orgmode.org,maintainers web page}
15 @set AUTHOR Carsten Dominik
16 @set MAINTAINER Bastien Guerry
17 @set MAINTAINEREMAIL @email{bzg at gnu dot org}
18 @set MAINTAINERCONTACT @uref{mailto:bzg at gnu dot org,contact the maintainer}
23 @c -----------------------------------------------------------------------------
25 @c Macro definitions for commands and keys
26 @c =======================================
28 @c The behavior of the key/command macros will depend on the flag cmdnames
29 @c When set, commands names are shown. When clear, they are not shown.
33 @c Below we define the following macros for Org key tables:
35 @c orgkey{key} A key item
36 @c orgcmd{key,cmd} Key with command name
37 @c xorgcmd{key,cmd} Key with command name as @itemx
38 @c orgcmdnki{key,cmd} Like orgcmd, but do not index the key
39 @c orgcmdtkc{text,key,cmd} Like orgcmd,special text instead of key
40 @c orgcmdkkc{key1,key2,cmd} Two keys with one command name, use "or"
41 @c orgcmdkxkc{key1,key2,cmd} Two keys with one command name, but
42 @c different functions, so format as @itemx
43 @c orgcmdkskc{key1,key2,cmd} Same as orgcmdkkc, but use "or short"
44 @c xorgcmdkskc{key1,key2,cmd} Same as previous, but use @itemx
45 @c orgcmdkkcc{key1,key2,cmd1,cmd2} Two keys and two commands
47 @c a key but no command
59 @c one key with a command
60 @c Inserts: @item KEY COMMAND
61 @macro orgcmd{key,command}
66 @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
69 @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
78 @c One key with one command, formatted using @itemx
79 @c Inserts: @itemx KEY COMMAND
80 @macro xorgcmd{key,command}
85 @itemx @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
88 @itemx @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
97 @c one key with a command, bit do not index the key
98 @c Inserts: @item KEY COMMAND
99 @macro orgcmdnki{key,command}
103 @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
106 @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
114 @c one key with a command, and special text to replace key in item
115 @c Inserts: @item TEXT COMMAND
116 @macro orgcmdtkc{text,key,command}
121 @item @kbd{\text\} @hskip 0pt plus 1filll @code{\command\}
124 @item @kbd{\text\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
133 @c two keys with one command
134 @c Inserts: @item KEY1 or KEY2 COMMAND
135 @macro orgcmdkkc{key1,key2,command}
141 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
144 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
150 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\}
154 @c Two keys with one command name, but different functions, so format as
156 @c Inserts: @item KEY1
157 @c @itemx KEY2 COMMAND
158 @macro orgcmdkxkc{key1,key2,command}
165 @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
169 @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
180 @c Same as previous, but use "or short"
181 @c Inserts: @item KEY1 or short KEY2 COMMAND
182 @macro orgcmdkskc{key1,key2,command}
188 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
191 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
197 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
201 @c Same as previous, but use @itemx
202 @c Inserts: @itemx KEY1 or short KEY2 COMMAND
203 @macro xorgcmdkskc{key1,key2,command}
209 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
212 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
218 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
222 @c two keys with two commands
223 @c Inserts: @item KEY1 COMMAND1
224 @c @itemx KEY2 COMMAND2
225 @macro orgcmdkkcc{key1,key2,command1,command2}
232 @item @kbd{\key1\} @hskip 0pt plus 1filll @code{\command1\}
233 @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command2\}
236 @item @kbd{\key1\} @tie{}@tie{}@tie{}@tie{}(@code{\command1\})
237 @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command2\})
247 @c -----------------------------------------------------------------------------
250 @c @hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed}
253 @c Subheadings inside a table.
254 @macro tsubheading{text}
256 @subsubheading \text\
264 This manual is for Org version @value{VERSION}.
266 Copyright @copyright{} 2004--2013 Free Software Foundation, Inc.
269 Permission is granted to copy, distribute and/or modify this document
270 under the terms of the GNU Free Documentation License, Version 1.3 or
271 any later version published by the Free Software Foundation; with no
272 Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
273 and with the Back-Cover Texts as in (a) below. A copy of the license
274 is included in the section entitled ``GNU Free Documentation License.''
276 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
277 modify this GNU manual.''
281 @dircategory Emacs editing modes
283 * Org Mode: (org). Outline-based notes management and organizer
287 @title The Org Manual
289 @subtitle Release @value{VERSION}
290 @author by Carsten Dominik
291 with contributions by David O'Toole, Bastien Guerry, Philip Rooke, Dan
292 Davison, Eric Schulte, Thomas Dye, Jambunathan K and Nicolas Goaziou.
294 @c The following two commands start the copyright page.
296 @vskip 0pt plus 1filll
300 @c Output the table of contents at the beginning.
304 @c FIXME These hand-written next,prev,up node pointers make editing a lot
305 @c harder. There should be no need for them, makeinfo can do it
306 @c automatically for any document with a normal structure.
307 @node Top, Introduction, (dir), (dir)
314 * Introduction:: Getting started
315 * Document Structure:: A tree works like your brain
316 * Tables:: Pure magic for quick formatting
317 * Hyperlinks:: Notes in context
318 * TODO Items:: Every tree branch can be a TODO item
319 * Tags:: Tagging headlines and matching sets of tags
320 * Properties and Columns:: Storing information about an entry
321 * Dates and Times:: Making items useful for planning
322 * Capture - Refile - Archive:: The ins and outs for projects
323 * Agenda Views:: Collecting information into views
324 * Markup:: Prepare text for rich export
325 * Exporting:: Sharing and publishing notes
326 * Publishing:: Create a web site of linked Org files
327 * Working With Source Code:: Export, evaluate, and tangle code blocks
328 * Miscellaneous:: All the rest which did not fit elsewhere
329 * Hacking:: How to hack your way around
330 * MobileOrg:: Viewing and capture on a mobile device
331 * History and Acknowledgments:: How Org came into being
332 * GNU Free Documentation License:: The license for this documentation.
333 * Main Index:: An index of Org's concepts and features
334 * Key Index:: Key bindings and where they are described
335 * Command and Function Index:: Command names and some internal functions
336 * Variable Index:: Variables mentioned in the manual
339 --- The Detailed Node Listing ---
343 * Summary:: Brief summary of what Org does
344 * Installation:: Installing Org
345 * Activation:: How to activate Org for certain buffers
346 * Feedback:: Bug reports, ideas, patches etc.
347 * Conventions:: Typesetting conventions in the manual
351 * Outlines:: Org is based on Outline mode
352 * Headlines:: How to typeset Org tree headlines
353 * Visibility cycling:: Show and hide, much simplified
354 * Motion:: Jumping to other headlines
355 * Structure editing:: Changing sequence and level of headlines
356 * Sparse trees:: Matches embedded in context
357 * Plain lists:: Additional structure within an entry
358 * Drawers:: Tucking stuff away
359 * Blocks:: Folding blocks
360 * Footnotes:: How footnotes are defined in Org's syntax
361 * Orgstruct mode:: Structure editing outside Org
362 * Org syntax:: Formal description of Org's syntax
366 * Global and local cycling:: Cycling through various visibility states
367 * Initial visibility:: Setting the initial visibility state
368 * Catching invisible edits:: Preventing mistakes when editing invisible parts
370 Global and local cycling
372 * Initial visibility:: Setting the initial visibility state
373 * Catching invisible edits:: Preventing mistakes when editing invisible parts
377 * Built-in table editor:: Simple tables
378 * Column width and alignment:: Overrule the automatic settings
379 * Column groups:: Grouping to trigger vertical lines
380 * Orgtbl mode:: The table editor as minor mode
381 * The spreadsheet:: The table editor has spreadsheet capabilities
382 * Org-Plot:: Plotting from org tables
386 * References:: How to refer to another field or range
387 * Formula syntax for Calc:: Using Calc to compute stuff
388 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
389 * Durations and time values:: How to compute durations and time values
390 * Field and range formulas:: Formula for specific (ranges of) fields
391 * Column formulas:: Formulas valid for an entire column
392 * Lookup functions:: Lookup functions for searching tables
393 * Editing and debugging formulas:: Fixing formulas
394 * Updating the table:: Recomputing all dependent fields
395 * Advanced features:: Field and column names, parameters and automatic recalc
399 * Link format:: How links in Org are formatted
400 * Internal links:: Links to other places in the current file
401 * External links:: URL-like links to the world
402 * Handling links:: Creating, inserting and following
403 * Using links outside Org:: Linking from my C source code?
404 * Link abbreviations:: Shortcuts for writing complex links
405 * Search options:: Linking to a specific location
406 * Custom searches:: When the default search is not enough
410 * Radio targets:: Make targets trigger links in plain text
414 * TODO basics:: Marking and displaying TODO entries
415 * TODO extensions:: Workflow and assignments
416 * Progress logging:: Dates and notes for progress
417 * Priorities:: Some things are more important than others
418 * Breaking down tasks:: Splitting a task into manageable pieces
419 * Checkboxes:: Tick-off lists
421 Extended use of TODO keywords
423 * Workflow states:: From TODO to DONE in steps
424 * TODO types:: I do this, Fred does the rest
425 * Multiple sets in one file:: Mixing it all, and still finding your way
426 * Fast access to TODO states:: Single letter selection of a state
427 * Per-file keywords:: Different files, different requirements
428 * Faces for TODO keywords:: Highlighting states
429 * TODO dependencies:: When one task needs to wait for others
433 * Closing items:: When was this entry marked DONE?
434 * Tracking TODO state changes:: When did the status change?
435 * Tracking your habits:: How consistent have you been?
439 * Tag inheritance:: Tags use the tree structure of the outline
440 * Setting tags:: How to assign tags to a headline
441 * Tag groups:: Use one tag to search for several tags
442 * Tag searches:: Searching for combinations of tags
444 Properties and columns
446 * Property syntax:: How properties are spelled out
447 * Special properties:: Access to other Org mode features
448 * Property searches:: Matching property values
449 * Property inheritance:: Passing values down the tree
450 * Column view:: Tabular viewing and editing
451 * Property API:: Properties for Lisp programmers
455 * Defining columns:: The COLUMNS format property
456 * Using column view:: How to create and use column view
457 * Capturing column view:: A dynamic block for column view
461 * Scope of column definitions:: Where defined, where valid?
462 * Column attributes:: Appearance and content of a column
466 * Timestamps:: Assigning a time to a tree entry
467 * Creating timestamps:: Commands which insert timestamps
468 * Deadlines and scheduling:: Planning your work
469 * Clocking work time:: Tracking how long you spend on a task
470 * Effort estimates:: Planning work effort in advance
471 * Relative timer:: Notes with a running timer
472 * Countdown timer:: Starting a countdown timer for a task
476 * The date/time prompt:: How Org mode helps you entering date and time
477 * Custom time format:: Making dates look different
479 Deadlines and scheduling
481 * Inserting deadline/schedule:: Planning items
482 * Repeated tasks:: Items that show up again and again
486 * Clocking commands:: Starting and stopping a clock
487 * The clock table:: Detailed reports
488 * Resolving idle time:: Resolving time when you've been idle
490 Capture - Refile - Archive
492 * Capture:: Capturing new stuff
493 * Attachments:: Add files to tasks
494 * RSS Feeds:: Getting input from RSS feeds
495 * Protocols:: External (e.g., Browser) access to Emacs and Org
496 * Refile and copy:: Moving/copying a tree from one place to another
497 * Archiving:: What to do with finished projects
501 * Setting up capture:: Where notes will be stored
502 * Using capture:: Commands to invoke and terminate capture
503 * Capture templates:: Define the outline of different note types
507 * Template elements:: What is needed for a complete template entry
508 * Template expansion:: Filling in information about time and context
509 * Templates in contexts:: Only show a template in a specific context
513 * Moving subtrees:: Moving a tree to an archive file
514 * Internal archiving:: Switch off a tree but keep it in the file
518 * Agenda files:: Files being searched for agenda information
519 * Agenda dispatcher:: Keyboard access to agenda views
520 * Built-in agenda views:: What is available out of the box?
521 * Presentation and sorting:: How agenda items are prepared for display
522 * Agenda commands:: Remote editing of Org trees
523 * Custom agenda views:: Defining special searches and views
524 * Exporting Agenda Views:: Writing a view to a file
525 * Agenda column view:: Using column view for collected entries
527 The built-in agenda views
529 * Weekly/daily agenda:: The calendar page with current tasks
530 * Global TODO list:: All unfinished action items
531 * Matching tags and properties:: Structured information with fine-tuned search
532 * Timeline:: Time-sorted view for single file
533 * Search view:: Find entries by searching for text
534 * Stuck projects:: Find projects you need to review
536 Presentation and sorting
538 * Categories:: Not all tasks are equal
539 * Time-of-day specifications:: How the agenda knows the time
540 * Sorting of agenda items:: The order of things
544 * Storing searches:: Type once, use often
545 * Block agenda:: All the stuff you need in a single buffer
546 * Setting Options:: Changing the rules
548 Markup for rich export
550 * Structural markup elements:: The basic structure as seen by the exporter
551 * Images and tables:: Images, tables and caption mechanism
552 * Literal examples:: Source code examples with special formatting
553 * Include files:: Include additional files into a document
554 * Index entries:: Making an index
555 * Macro replacement:: Use macros to create complex output
556 * Embedded @LaTeX{}:: LaTeX can be freely used inside Org documents
558 Structural markup elements
560 * Document title:: Where the title is taken from
561 * Headings and sections:: The document structure as seen by the exporter
562 * Table of contents:: The if and where of the table of contents
564 * Paragraphs:: Paragraphs
565 * Footnote markup:: Footnotes
566 * Emphasis and monospace:: Bold, italic, etc.
567 * Horizontal rules:: Make a line
568 * Comment lines:: What will *not* be exported
572 * Special symbols:: Greek letters and other symbols
573 * Subscripts and superscripts:: Simple syntax for raising/lowering text
574 * @LaTeX{} fragments:: Complex formulas made easy
575 * Previewing @LaTeX{} fragments:: What will this snippet look like?
576 * CDLaTeX mode:: Speed up entering of formulas
580 * The Export Dispatcher:: The main exporter interface
581 * Export formats:: Available export formats
582 * Export settings:: Generic export settings
583 * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
584 * HTML export:: Exporting to HTML
585 * @LaTeX{} and PDF export:: Exporting to @LaTeX{}, and processing to PDF
586 * OpenDocument Text export:: Exporting to OpenDocument Text
587 * iCalendar export:: Exporting in iCalendar format
591 * HTML Export commands:: How to invoke HTML export
592 * HTML preamble and postamble:: How to insert a preamble and a postamble
593 * Quoting HTML tags:: Using direct HTML in Org mode
594 * Links in HTML export:: How links will be interpreted and formatted
595 * Tables in HTML export:: How to modify the formatting of tables
596 * Images in HTML export:: How to insert figures into HTML output
597 * Math formatting in HTML export:: Beautiful math also on the web
598 * Text areas in HTML export:: An alternative way to show an example
599 * CSS support:: Changing the appearance of the output
600 * JavaScript support:: Info and Folding in a web browser
602 @LaTeX{} and PDF export
604 * @LaTeX{}/PDF export commands::
605 * Header and sectioning:: Setting up the export file structure
606 * Quoting @LaTeX{} code:: Incorporating literal @LaTeX{} code
607 * Tables in @LaTeX{} export:: Options for exporting tables to @LaTeX{}
608 * Images in @LaTeX{} export:: How to insert figures into @LaTeX{} output
609 * Beamer class export:: Turning the file into a presentation
611 OpenDocument Text export
613 * Pre-requisites for ODT export:: What packages ODT exporter relies on
614 * ODT export commands:: How to invoke ODT export
615 * Extending ODT export:: How to produce @samp{doc}, @samp{pdf} files
616 * Applying custom styles:: How to apply custom styles to the output
617 * Links in ODT export:: How links will be interpreted and formatted
618 * Tables in ODT export:: How Tables are exported
619 * Images in ODT export:: How to insert images
620 * Math formatting in ODT export:: How @LaTeX{} fragments are formatted
621 * Labels and captions in ODT export:: How captions are rendered
622 * Literal examples in ODT export:: How source and example blocks are formatted
623 * Advanced topics in ODT export:: Read this if you are a power user
625 Math formatting in ODT export
627 * Working with @LaTeX{} math snippets:: How to embed @LaTeX{} math fragments
628 * Working with MathML or OpenDocument formula files:: How to embed equations in native format
630 Advanced topics in ODT export
632 * Configuring a document converter:: How to register a document converter
633 * Working with OpenDocument style files:: Explore the internals
634 * Creating one-off styles:: How to produce custom highlighting etc
635 * Customizing tables in ODT export:: How to define and use Table templates
636 * Validating OpenDocument XML:: How to debug corrupt OpenDocument files
640 * Configuration:: Defining projects
641 * Uploading files:: How to get files up on the server
642 * Sample configuration:: Example projects
643 * Triggering publication:: Publication commands
647 * Project alist:: The central configuration variable
648 * Sources and destinations:: From here to there
649 * Selecting files:: What files are part of the project?
650 * Publishing action:: Setting the function doing the publishing
651 * Publishing options:: Tweaking HTML/@LaTeX{} export
652 * Publishing links:: Which links keep working after publishing?
653 * Sitemap:: Generating a list of all pages
654 * Generating an index:: An index that reaches across pages
658 * Simple example:: One-component publishing
659 * Complex example:: A multi-component publishing example
661 Working with source code
663 * Structure of code blocks:: Code block syntax described
664 * Editing source code:: Language major-mode editing
665 * Exporting code blocks:: Export contents and/or results
666 * Extracting source code:: Create pure source code files
667 * Evaluating code blocks:: Place results of evaluation in the Org mode buffer
668 * Library of Babel:: Use and contribute to a library of useful code blocks
669 * Languages:: List of supported code block languages
670 * Header arguments:: Configure code block functionality
671 * Results of evaluation:: How evaluation results are handled
672 * Noweb reference syntax:: Literate programming in Org mode
673 * Key bindings and useful functions:: Work quickly with code blocks
674 * Batch execution:: Call functions from the command line
678 * Using header arguments:: Different ways to set header arguments
679 * Specific header arguments:: List of header arguments
681 Using header arguments
683 * System-wide header arguments:: Set global default values
684 * Language-specific header arguments:: Set default values by language
685 * Buffer-wide header arguments:: Set default values for a specific buffer
686 * Header arguments in Org mode properties:: Set default values for a buffer or heading
687 * Code block specific header arguments:: The most common way to set values
688 * Header arguments in function calls:: The most specific level
690 Specific header arguments
692 * var:: Pass arguments to code blocks
693 * results:: Specify the type of results and how they will
694 be collected and handled
695 * file:: Specify a path for file output
696 * file-desc:: Specify a description for file results
697 * dir:: Specify the default (possibly remote)
698 directory for code block execution
699 * exports:: Export code and/or results
700 * tangle:: Toggle tangling and specify file name
701 * mkdirp:: Toggle creation of parent directories of target
702 files during tangling
703 * comments:: Toggle insertion of comments in tangled
705 * padline:: Control insertion of padding lines in tangled
707 * no-expand:: Turn off variable assignment and noweb
708 expansion during tangling
709 * session:: Preserve the state of code evaluation
710 * noweb:: Toggle expansion of noweb references
711 * noweb-ref:: Specify block's noweb reference resolution target
712 * noweb-sep:: String used to separate noweb references
713 * cache:: Avoid re-evaluating unchanged code blocks
714 * sep:: Delimiter for writing tabular results outside Org
715 * hlines:: Handle horizontal lines in tables
716 * colnames:: Handle column names in tables
717 * rownames:: Handle row names in tables
718 * shebang:: Make tangled files executable
719 * eval:: Limit evaluation of specific code blocks
720 * wrap:: Mark source block evaluation results
721 * post:: Post processing of code block results
725 * Completion:: M-TAB knows what you need
726 * Easy Templates:: Quick insertion of structural elements
727 * Speed keys:: Electric commands at the beginning of a headline
728 * Code evaluation security:: Org mode files evaluate inline code
729 * Customization:: Adapting Org to your taste
730 * In-buffer settings:: Overview of the #+KEYWORDS
731 * The very busy C-c C-c key:: When in doubt, press C-c C-c
732 * Clean view:: Getting rid of leading stars in the outline
733 * TTY keys:: Using Org on a tty
734 * Interaction:: Other Emacs packages
735 * org-crypt.el:: Encrypting Org files
737 Interaction with other packages
739 * Cooperation:: Packages Org cooperates with
740 * Conflicts:: Packages that lead to conflicts
744 * Hooks:: How to reach into Org's internals
745 * Add-on packages:: Available extensions
746 * Adding hyperlink types:: New custom link types
747 * Adding export back-ends:: How to write new export back-ends
748 * Context-sensitive commands:: How to add functionality to such commands
749 * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
750 * Dynamic blocks:: Automatically filled blocks
751 * Special agenda views:: Customized views
752 * Speeding up your agendas:: Tips on how to speed up your agendas
753 * Extracting agenda information:: Post-processing of agenda information
754 * Using the property API:: Writing programs that use entry properties
755 * Using the mapping API:: Mapping over all or selected entries
757 Tables and lists in arbitrary syntax
759 * Radio tables:: Sending and receiving radio tables
760 * A @LaTeX{} example:: Step by step, almost a tutorial
761 * Translator functions:: Copy and modify
762 * Radio lists:: Doing the same for lists
766 * Setting up the staging area:: Where to interact with the mobile device
767 * Pushing to MobileOrg:: Uploading Org files and agendas
768 * Pulling from MobileOrg:: Integrating captured and flagged items
773 @node Introduction, Document Structure, Top, Top
774 @chapter Introduction
778 * Summary:: Brief summary of what Org does
779 * Installation:: Installing Org
780 * Activation:: How to activate Org for certain buffers
781 * Feedback:: Bug reports, ideas, patches etc.
782 * Conventions:: Typesetting conventions in the manual
785 @node Summary, Installation, Introduction, Introduction
789 Org is a mode for keeping notes, maintaining TODO lists, and doing
790 project planning with a fast and effective plain-text system.
792 Org develops organizational tasks around NOTES files that contain
793 lists or information about projects as plain text. Org is
794 implemented on top of Outline mode, which makes it possible to keep the
795 content of large files well structured. Visibility cycling and
796 structure editing help to work with the tree. Tables are easily created
797 with a built-in table editor. Org supports TODO items, deadlines,
798 timestamps, and scheduling. It dynamically compiles entries into an
799 agenda that utilizes and smoothly integrates much of the Emacs calendar
800 and diary. Plain text URL-like links connect to websites, emails,
801 Usenet messages, BBDB entries, and any files related to the projects.
802 For printing and sharing notes, an Org file can be exported as a
803 structured ASCII file, as HTML, or (TODO and agenda items only) as an
804 iCalendar file. It can also serve as a publishing tool for a set of
807 As a project planning environment, Org works by adding metadata to outline
808 nodes. Based on this data, specific entries can be extracted in queries and
809 create dynamic @i{agenda views}.
811 Org mode contains the Org Babel environment which allows you to work with
812 embedded source code blocks in a file, to facilitate code evaluation,
813 documentation, and literate programming techniques.
815 Org's automatic, context-sensitive table editor with spreadsheet
816 capabilities can be integrated into any major mode by activating the
817 minor Orgtbl mode. Using a translation step, it can be used to maintain
818 tables in arbitrary file types, for example in @LaTeX{}. The structure
819 editing and list creation capabilities can be used outside Org with
820 the minor Orgstruct mode.
822 Org keeps simple things simple. When first fired up, it should
823 feel like a straightforward, easy to use outliner. Complexity is not
824 imposed, but a large amount of functionality is available when you need
825 it. Org is a toolbox and can be used in different ways and for different
829 @r{@bullet{} an outline extension with visibility cycling and structure editing}
830 @r{@bullet{} an ASCII system and table editor for taking structured notes}
831 @r{@bullet{} a TODO list editor}
832 @r{@bullet{} a full agenda and planner with deadlines and work scheduling}
833 @pindex GTD, Getting Things Done
834 @r{@bullet{} an environment in which to implement David Allen's GTD system}
835 @r{@bullet{} a simple hypertext system, with HTML and @LaTeX{} export}
836 @r{@bullet{} a publishing tool to create a set of interlinked web pages}
837 @r{@bullet{} an environment for literate programming}
841 There is a website for Org which provides links to the newest
842 version of Org, as well as additional information, frequently asked
843 questions (FAQ), links to tutorials, etc. This page is located at
844 @uref{http://orgmode.org}.
846 @cindex print edition
847 The version 7.3 of this manual is available as a
848 @uref{http://www.network-theory.co.uk/org/manual/, paperback book from Network
854 @node Installation, Activation, Summary, Introduction
855 @section Installation
859 Org is part of recent distributions of GNU Emacs, so you normally don't need
860 to install it. If, for one reason or another, you want to install Org on top
861 of this pre-packaged version, there are three ways to do it:
864 @item By using Emacs package system.
865 @item By downloading Org as an archive.
866 @item By using Org's git repository.
869 We @b{strongly recommend} to stick to a single installation method.
871 @subsubheading Using Emacs packaging system
873 Recent Emacs distributions include a packaging system which lets you install
874 Elisp libraries. You can install Org with @kbd{M-x package-install RET org}.
875 You need to do this in a session where no @code{.org} file has been visited.
876 Then, to make sure your Org configuration is taken into account, initialize
877 the package system with @code{(package-initialize)} in your @file{.emacs}
878 before setting any Org option. If you want to use Org's package repository,
879 check out the @uref{http://orgmode.org/elpa.html, Org ELPA page}.
881 @subsubheading Downloading Org as an archive
883 You can download Org latest release from @uref{http://orgmode.org/, Org's
884 website}. In this case, make sure you set the load-path correctly in your
888 (add-to-list 'load-path "~/path/to/orgdir/lisp")
891 The downloaded archive contains contributed libraries that are not included
892 in Emacs. If you want to use them, add the @file{contrib} directory to your
896 (add-to-list 'load-path "~/path/to/orgdir/contrib/lisp" t)
899 Optionally, you can compile the files and/or install them in your system.
900 Run @code{make help} to list compilation and installation options.
902 @subsubheading Using Org's git repository
904 You can clone Org's repository and install Org like this:
908 $ git clone git://orgmode.org/org-mode.git
912 Note that in this case, @code{make autoloads} is mandatory: it defines Org's
913 version in @file{org-version.el} and Org's autoloads in
914 @file{org-loaddefs.el}.
916 Remember to add the correct load-path as described in the method above.
918 You can also compile with @code{make}, generate the documentation with
919 @code{make doc}, create a local configuration with @code{make config} and
920 install Org with @code{make install}. Please run @code{make help} to get
921 the list of compilation/installation options.
923 For more detailed explanations on Org's build system, please check the Org
924 Build System page on @uref{http://orgmode.org/worg/dev/org-build-system.html,
927 @node Activation, Feedback, Installation, Introduction
932 @cindex global key bindings
933 @cindex key bindings, global
936 @findex org-store-link
939 Since Emacs 22.2, files with the @file{.org} extension use Org mode by
940 default. If you are using an earlier version of Emacs, add this line to your
944 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
947 Org mode buffers need font-lock to be turned on: this is the default in
948 Emacs@footnote{If you don't use font-lock globally, turn it on in Org buffer
949 with @code{(add-hook 'org-mode-hook 'turn-on-font-lock)}}.
951 There are compatibility issues between Org mode and some other Elisp
952 packages, please take the time to check the list (@pxref{Conflicts}).
954 The four Org commands @command{org-store-link}, @command{org-capture},
955 @command{org-agenda}, and @command{org-iswitchb} should be accessible through
956 global keys (i.e., anywhere in Emacs, not just in Org buffers). Here are
957 suggested bindings for these keys, please modify the keys to your own
960 (global-set-key "\C-cl" 'org-store-link)
961 (global-set-key "\C-cc" 'org-capture)
962 (global-set-key "\C-ca" 'org-agenda)
963 (global-set-key "\C-cb" 'org-iswitchb)
966 @cindex Org mode, turning on
967 With this setup, all files with extension @samp{.org} will be put
968 into Org mode. As an alternative, make the first line of a file look
972 MY PROJECTS -*- mode: org; -*-
975 @vindex org-insert-mode-line-in-empty-file
976 @noindent which will select Org mode for this buffer no matter what
977 the file's name is. See also the variable
978 @code{org-insert-mode-line-in-empty-file}.
980 Many commands in Org work on the region if the region is @i{active}. To make
981 use of this, you need to have @code{transient-mark-mode}
982 (@code{zmacs-regions} in XEmacs) turned on. In Emacs 23 this is the default,
983 in Emacs 22 you need to do this yourself with
985 (transient-mark-mode 1)
987 @noindent If you do not like @code{transient-mark-mode}, you can create an
988 active region by using the mouse to select a region, or pressing
989 @kbd{C-@key{SPC}} twice before moving the cursor.
991 @node Feedback, Conventions, Activation, Introduction
998 If you find problems with Org, or if you have questions, remarks, or ideas
999 about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}.
1000 If you are not a member of the mailing list, your mail will be passed to the
1001 list after a moderator has approved it@footnote{Please consider subscribing
1002 to the mailing list, in order to minimize the work the mailing list
1003 moderators have to do.}.
1005 For bug reports, please first try to reproduce the bug with the latest
1006 version of Org available---if you are running an outdated version, it is
1007 quite possible that the bug has been fixed already. If the bug persists,
1008 prepare a report and provide as much information as possible, including the
1009 version information of Emacs (@kbd{M-x emacs-version @key{RET}}) and Org
1010 (@kbd{M-x org-version @key{RET}}), as well as the Org related setup in
1011 @file{.emacs}. The easiest way to do this is to use the command
1013 @kbd{M-x org-submit-bug-report}
1015 @noindent which will put all this information into an Emacs mail buffer so
1016 that you only need to add your description. If you re not sending the Email
1017 from within Emacs, please copy and paste the content into your Email program.
1019 Sometimes you might face a problem due to an error in your Emacs or Org mode
1020 setup. Before reporting a bug, it is very helpful to start Emacs with minimal
1021 customizations and reproduce the problem. Doing so often helps you determine
1022 if the problem is with your customization or with Org mode itself. You can
1023 start a typical minimal session with a command like the example below.
1026 $ emacs -Q -l /path/to/minimal-org.el
1029 However if you are using Org mode as distributed with Emacs, a minimal setup
1030 is not necessary. In that case it is sufficient to start Emacs as
1031 @code{emacs -Q}. The @code{minimal-org.el} setup file can have contents as
1035 ;;; Minimal setup to load latest `org-mode'
1037 ;; activate debugging
1038 (setq debug-on-error t
1042 ;; add latest org-mode to load path
1043 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/lisp"))
1044 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/contrib/lisp" t))
1047 If an error occurs, a backtrace can be very useful (see below on how to
1048 create one). Often a small example file helps, along with clear information
1052 @item What exactly did you do?
1053 @item What did you expect to happen?
1054 @item What happened instead?
1056 @noindent Thank you for helping to improve this program.
1058 @subsubheading How to create a useful backtrace
1060 @cindex backtrace of an error
1061 If working with Org produces an error with a message you don't
1062 understand, you may have hit a bug. The best way to report this is by
1063 providing, in addition to what was mentioned above, a @emph{backtrace}.
1064 This is information from the built-in debugger about where and how the
1065 error occurred. Here is how to produce a useful backtrace:
1069 Reload uncompiled versions of all Org mode Lisp files. The backtrace
1070 contains much more information if it is produced with uncompiled code.
1073 C-u M-x org-reload RET
1076 or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the
1079 Go to the @code{Options} menu and select @code{Enter Debugger on Error}
1080 (XEmacs has this option in the @code{Troubleshooting} sub-menu).
1082 Do whatever you have to do to hit the error. Don't forget to
1083 document the steps you take.
1085 When you hit the error, a @file{*Backtrace*} buffer will appear on the
1086 screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and
1087 attach it to your bug report.
1090 @node Conventions, , Feedback, Introduction
1091 @section Typesetting conventions used in this manual
1093 @subsubheading TODO keywords, tags, properties, etc.
1095 Org mainly uses three types of keywords: TODO keywords, tags and property
1096 names. In this manual we use the following conventions:
1101 TODO keywords are written with all capitals, even if they are
1105 User-defined tags are written in lowercase; built-in tags with special
1106 meaning are written with all capitals.
1109 User-defined properties are capitalized; built-in properties with
1110 special meaning are written with all capitals.
1113 Moreover, Org uses @i{option keywords} (like @code{#+TITLE} to set the title)
1114 and @i{environment keywords} (like @code{#+BEGIN_HTML} to start a @code{HTML}
1115 environment). They are written in uppercase in the manual to enhance its
1116 readability, but you can use lowercase in your Org files@footnote{Easy
1117 templates insert lowercase keywords and Babel dynamically inserts
1120 @subsubheading Keybindings and commands
1126 The manual suggests two global keybindings: @kbd{C-c a} for @code{org-agenda}
1127 and @kbd{C-c c} for @code{org-capture}. These are only suggestions, but the
1128 rest of the manual assumes that you are using these keybindings.
1130 Also, the manual lists both the keys and the corresponding commands for
1131 accessing a functionality. Org mode often uses the same key for different
1132 functions, depending on context. The command that is bound to such keys has
1133 a generic name, like @code{org-metaright}. In the manual we will, wherever
1134 possible, give the function that is internally called by the generic command.
1135 For example, in the chapter on document structure, @kbd{M-@key{right}} will
1136 be listed to call @code{org-do-demote}, while in the chapter on tables, it
1137 will be listed to call @code{org-table-move-column-right}. If you prefer,
1138 you can compile the manual without the command names by unsetting the flag
1139 @code{cmdnames} in @file{org.texi}.
1141 @node Document Structure, Tables, Introduction, Top
1142 @chapter Document structure
1143 @cindex document structure
1144 @cindex structure of document
1146 Org is based on Outline mode and provides flexible commands to
1147 edit the structure of the document.
1150 * Outlines:: Org is based on Outline mode
1151 * Headlines:: How to typeset Org tree headlines
1152 * Visibility cycling:: Show and hide, much simplified
1153 * Motion:: Jumping to other headlines
1154 * Structure editing:: Changing sequence and level of headlines
1155 * Sparse trees:: Matches embedded in context
1156 * Plain lists:: Additional structure within an entry
1157 * Drawers:: Tucking stuff away
1158 * Blocks:: Folding blocks
1159 * Footnotes:: How footnotes are defined in Org's syntax
1160 * Orgstruct mode:: Structure editing outside Org
1161 * Org syntax:: Formal description of Org's syntax
1164 @node Outlines, Headlines, Document Structure, Document Structure
1167 @cindex Outline mode
1169 Org is implemented on top of Outline mode. Outlines allow a
1170 document to be organized in a hierarchical structure, which (at least
1171 for me) is the best representation of notes and thoughts. An overview
1172 of this structure is achieved by folding (hiding) large parts of the
1173 document to show only the general document structure and the parts
1174 currently being worked on. Org greatly simplifies the use of
1175 outlines by compressing the entire show/hide functionality into a single
1176 command, @command{org-cycle}, which is bound to the @key{TAB} key.
1178 @node Headlines, Visibility cycling, Outlines, Document Structure
1181 @cindex outline tree
1182 @vindex org-special-ctrl-a/e
1183 @vindex org-special-ctrl-k
1184 @vindex org-ctrl-k-protect-subtree
1186 Headlines define the structure of an outline tree. The headlines in Org
1187 start with one or more stars, on the left margin@footnote{See the variables
1188 @code{org-special-ctrl-a/e}, @code{org-special-ctrl-k}, and
1189 @code{org-ctrl-k-protect-subtree} to configure special behavior of @kbd{C-a},
1190 @kbd{C-e}, and @kbd{C-k} in headlines.} @footnote{Clocking only works with
1191 headings indented less then 30 stars.}. For example:
1194 * Top level headline
1201 * Another top level headline
1204 @noindent Some people find the many stars too noisy and would prefer an
1205 outline that has whitespace followed by a single star as headline
1206 starters. @ref{Clean view}, describes a setup to realize this.
1208 @vindex org-cycle-separator-lines
1209 An empty line after the end of a subtree is considered part of it and
1210 will be hidden when the subtree is folded. However, if you leave at
1211 least two empty lines, one empty line will remain visible after folding
1212 the subtree, in order to structure the collapsed view. See the
1213 variable @code{org-cycle-separator-lines} to modify this behavior.
1215 @node Visibility cycling, Motion, Headlines, Document Structure
1216 @section Visibility cycling
1217 @cindex cycling, visibility
1218 @cindex visibility cycling
1219 @cindex trees, visibility
1220 @cindex show hidden text
1224 * Global and local cycling:: Cycling through various visibility states
1225 * Initial visibility:: Setting the initial visibility state
1226 * Catching invisible edits:: Preventing mistakes when editing invisible parts
1229 @node Global and local cycling, Initial visibility, Visibility cycling, Visibility cycling
1230 @subsection Global and local cycling
1232 Outlines make it possible to hide parts of the text in the buffer.
1233 Org uses just two commands, bound to @key{TAB} and
1234 @kbd{S-@key{TAB}} to change the visibility in the buffer.
1236 @cindex subtree visibility states
1237 @cindex subtree cycling
1238 @cindex folded, subtree visibility state
1239 @cindex children, subtree visibility state
1240 @cindex subtree, subtree visibility state
1242 @orgcmd{@key{TAB},org-cycle}
1243 @emph{Subtree cycling}: Rotate current subtree among the states
1246 ,-> FOLDED -> CHILDREN -> SUBTREE --.
1247 '-----------------------------------'
1250 @vindex org-cycle-emulate-tab
1251 @vindex org-cycle-global-at-bob
1252 The cursor must be on a headline for this to work@footnote{see, however,
1253 the option @code{org-cycle-emulate-tab}.}. When the cursor is at the
1254 beginning of the buffer and the first line is not a headline, then
1255 @key{TAB} actually runs global cycling (see below)@footnote{see the
1256 option @code{org-cycle-global-at-bob}.}. Also when called with a prefix
1257 argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
1259 @cindex global visibility states
1260 @cindex global cycling
1261 @cindex overview, global visibility state
1262 @cindex contents, global visibility state
1263 @cindex show all, global visibility state
1264 @orgcmd{S-@key{TAB},org-global-cycle}
1265 @itemx C-u @key{TAB}
1266 @emph{Global cycling}: Rotate the entire buffer among the states
1269 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
1270 '--------------------------------------'
1273 When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
1274 CONTENTS view up to headlines of level N will be shown. Note that inside
1275 tables, @kbd{S-@key{TAB}} jumps to the previous field.
1277 @cindex show all, command
1278 @orgcmd{C-u C-u C-u @key{TAB},show-all}
1279 Show all, including drawers.
1280 @cindex revealing context
1281 @orgcmd{C-c C-r,org-reveal}
1282 Reveal context around point, showing the current entry, the following heading
1283 and the hierarchy above. Useful for working near a location that has been
1284 exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
1285 (@pxref{Agenda commands}). With a prefix argument show, on each
1286 level, all sibling headings. With a double prefix argument, also show the
1287 entire subtree of the parent.
1288 @cindex show branches, command
1289 @orgcmd{C-c C-k,show-branches}
1290 Expose all the headings of the subtree, CONTENT view for just one subtree.
1291 @cindex show children, command
1292 @orgcmd{C-c @key{TAB},show-children}
1293 Expose all direct children of the subtree. With a numeric prefix argument N,
1294 expose all children down to level N@.
1295 @orgcmd{C-c C-x b,org-tree-to-indirect-buffer}
1296 Show the current subtree in an indirect buffer@footnote{The indirect
1299 (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
1302 (see the Emacs manual for more information about indirect buffers)
1304 will contain the entire buffer, but will be narrowed to the current
1305 tree. Editing the indirect buffer will also change the original buffer,
1306 but without affecting visibility in that buffer.}. With a numeric
1307 prefix argument N, go up to level N and then take that tree. If N is
1308 negative then go up that many levels. With a @kbd{C-u} prefix, do not remove
1309 the previously used indirect buffer.
1310 @orgcmd{C-c C-x v,org-copy-visible}
1311 Copy the @i{visible} text in the region into the kill ring.
1315 * Initial visibility:: Setting the initial visibility state
1316 * Catching invisible edits:: Preventing mistakes when editing invisible parts
1319 @node Initial visibility, Catching invisible edits, Global and local cycling, Visibility cycling
1320 @subsection Initial visibility
1322 @cindex visibility, initialize
1323 @vindex org-startup-folded
1324 @vindex org-agenda-inhibit-startup
1325 @cindex @code{overview}, STARTUP keyword
1326 @cindex @code{content}, STARTUP keyword
1327 @cindex @code{showall}, STARTUP keyword
1328 @cindex @code{showeverything}, STARTUP keyword
1330 When Emacs first visits an Org file, the global state is set to OVERVIEW,
1331 i.e., only the top level headlines are visible@footnote{When
1332 @code{org-agenda-inhibit-startup} is non-nil, Org will not honor the default
1333 visibility state when first opening a file for the agenda (@pxref{Speeding up
1334 your agendas}).} This can be configured through the variable
1335 @code{org-startup-folded}, or on a per-file basis by adding one of the
1336 following lines anywhere in the buffer:
1342 #+STARTUP: showeverything
1345 The startup visibility options are ignored when the file is open for the
1346 first time during the agenda generation: if you want the agenda to honor
1347 the startup visibility, set @code{org-agenda-inhibit-startup} to nil.
1349 @cindex property, VISIBILITY
1351 Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
1352 and Columns}) will get their visibility adapted accordingly. Allowed values
1353 for this property are @code{folded}, @code{children}, @code{content}, and
1357 @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
1358 Switch back to the startup visibility of the buffer, i.e., whatever is
1359 requested by startup options and @samp{VISIBILITY} properties in individual
1363 @node Catching invisible edits, , Initial visibility, Visibility cycling
1364 @subsection Catching invisible edits
1366 @vindex org-catch-invisible-edits
1367 @cindex edits, catching invisible
1368 Sometimes you may inadvertently edit an invisible part of the buffer and be
1369 confused on what as been edited and how to undo the mistake. Setting
1370 @code{org-catch-invisible-edits} to non-nil will help prevent this. See the
1371 docstring of this option on how Org should catch invisible edits and process
1374 @node Motion, Structure editing, Visibility cycling, Document Structure
1376 @cindex motion, between headlines
1377 @cindex jumping, to headlines
1378 @cindex headline navigation
1379 The following commands jump to other headlines in the buffer.
1382 @orgcmd{C-c C-n,outline-next-visible-heading}
1384 @orgcmd{C-c C-p,outline-previous-visible-heading}
1386 @orgcmd{C-c C-f,org-forward-same-level}
1387 Next heading same level.
1388 @orgcmd{C-c C-b,org-backward-same-level}
1389 Previous heading same level.
1390 @orgcmd{C-c C-u,outline-up-heading}
1391 Backward to higher level heading.
1392 @orgcmd{C-c C-j,org-goto}
1393 Jump to a different place without changing the current outline
1394 visibility. Shows the document structure in a temporary buffer, where
1395 you can use the following keys to find your destination:
1396 @vindex org-goto-auto-isearch
1398 @key{TAB} @r{Cycle visibility.}
1399 @key{down} / @key{up} @r{Next/previous visible headline.}
1400 @key{RET} @r{Select this location.}
1401 @kbd{/} @r{Do a Sparse-tree search}
1402 @r{The following keys work if you turn off @code{org-goto-auto-isearch}}
1403 n / p @r{Next/previous visible headline.}
1404 f / b @r{Next/previous headline same level.}
1406 0-9 @r{Digit argument.}
1409 @vindex org-goto-interface
1411 See also the variable @code{org-goto-interface}.
1414 @node Structure editing, Sparse trees, Motion, Document Structure
1415 @section Structure editing
1416 @cindex structure editing
1417 @cindex headline, promotion and demotion
1418 @cindex promotion, of subtrees
1419 @cindex demotion, of subtrees
1420 @cindex subtree, cut and paste
1421 @cindex pasting, of subtrees
1422 @cindex cutting, of subtrees
1423 @cindex copying, of subtrees
1424 @cindex sorting, of subtrees
1425 @cindex subtrees, cut and paste
1428 @orgcmd{M-@key{RET},org-insert-heading}
1429 @vindex org-M-RET-may-split-line
1430 Insert a new heading/item with the same level than the one at point.
1431 If the cursor is in a plain list item, a new item is created
1432 (@pxref{Plain lists}). To prevent this behavior in lists, call the
1433 command with a prefix argument. When this command is used in the
1434 middle of a line, the line is split and the rest of the line becomes
1435 the new item or headline@footnote{If you do not want the line to be
1436 split, customize the variable @code{org-M-RET-may-split-line}.}. If
1437 the command is used at the @emph{beginning} of a headline, the new
1438 headline is created before the current line. If the command is used
1439 at the @emph{end} of a folded subtree (i.e., behind the ellipses at
1440 the end of a headline), then a headline like the current one will be
1441 inserted after the end of the subtree. Calling this command with
1442 @kbd{C-u C-u} will unconditionally respect the headline's content and
1443 create a new item at the end of the parent subtree.
1444 @orgcmd{C-@key{RET},org-insert-heading-respect-content}
1445 Just like @kbd{M-@key{RET}}, except when adding a new heading below the
1446 current heading, the new heading is placed after the body instead of before
1447 it. This command works from anywhere in the entry.
1448 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
1449 @vindex org-treat-insert-todo-heading-as-state-change
1450 Insert new TODO entry with same level as current heading. See also the
1451 variable @code{org-treat-insert-todo-heading-as-state-change}.
1452 @orgcmd{C-S-@key{RET},org-insert-todo-heading-respect-content}
1453 Insert new TODO entry with same level as current heading. Like
1454 @kbd{C-@key{RET}}, the new headline will be inserted after the current
1456 @orgcmd{@key{TAB},org-cycle}
1457 In a new entry with no text yet, the first @key{TAB} demotes the entry to
1458 become a child of the previous one. The next @key{TAB} makes it a parent,
1459 and so on, all the way to top level. Yet another @key{TAB}, and you are back
1460 to the initial level.
1461 @orgcmd{M-@key{left},org-do-promote}
1462 Promote current heading by one level.
1463 @orgcmd{M-@key{right},org-do-demote}
1464 Demote current heading by one level.
1465 @orgcmd{M-S-@key{left},org-promote-subtree}
1466 Promote the current subtree by one level.
1467 @orgcmd{M-S-@key{right},org-demote-subtree}
1468 Demote the current subtree by one level.
1469 @orgcmd{M-S-@key{up},org-move-subtree-up}
1470 Move subtree up (swap with previous subtree of same
1472 @orgcmd{M-S-@key{down},org-move-subtree-down}
1473 Move subtree down (swap with next subtree of same level).
1474 @orgcmd{M-h,org-mark-element}
1475 Mark the element at point. Hitting repeatedly will mark subsequent elements
1476 of the one just marked. E.g., hitting @key{M-h} on a paragraph will mark it,
1477 hitting @key{M-h} immediately again will mark the next one.
1478 @orgcmd{C-c @@,org-mark-subtree}
1479 Mark the subtree at point. Hitting repeatedly will mark subsequent subtrees
1480 of the same level than the marked subtree.
1481 @orgcmd{C-c C-x C-w,org-cut-subtree}
1482 Kill subtree, i.e., remove it from buffer but save in kill ring.
1483 With a numeric prefix argument N, kill N sequential subtrees.
1484 @orgcmd{C-c C-x M-w,org-copy-subtree}
1485 Copy subtree to kill ring. With a numeric prefix argument N, copy the N
1486 sequential subtrees.
1487 @orgcmd{C-c C-x C-y,org-paste-subtree}
1488 Yank subtree from kill ring. This does modify the level of the subtree to
1489 make sure the tree fits in nicely at the yank position. The yank level can
1490 also be specified with a numeric prefix argument, or by yanking after a
1491 headline marker like @samp{****}.
1492 @orgcmd{C-y,org-yank}
1493 @vindex org-yank-adjusted-subtrees
1494 @vindex org-yank-folded-subtrees
1495 Depending on the variables @code{org-yank-adjusted-subtrees} and
1496 @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
1497 paste subtrees folded and in a clever way, using the same command as @kbd{C-c
1498 C-x C-y}. With the default settings, no level adjustment will take place,
1499 but the yanked tree will be folded unless doing so would swallow text
1500 previously visible. Any prefix argument to this command will force a normal
1501 @code{yank} to be executed, with the prefix passed along. A good way to
1502 force a normal yank is @kbd{C-u C-y}. If you use @code{yank-pop} after a
1503 yank, it will yank previous kill items plainly, without adjustment and
1505 @orgcmd{C-c C-x c,org-clone-subtree-with-time-shift}
1506 Clone a subtree by making a number of sibling copies of it. You will be
1507 prompted for the number of copies to make, and you can also specify if any
1508 timestamps in the entry should be shifted. This can be useful, for example,
1509 to create a number of tasks related to a series of lectures to prepare. For
1510 more details, see the docstring of the command
1511 @code{org-clone-subtree-with-time-shift}.
1512 @orgcmd{C-c C-w,org-refile}
1513 Refile entry or region to a different location. @xref{Refile and copy}.
1514 @orgcmd{C-c ^,org-sort}
1515 Sort same-level entries. When there is an active region, all entries in the
1516 region will be sorted. Otherwise the children of the current headline are
1517 sorted. The command prompts for the sorting method, which can be
1518 alphabetically, numerically, by time (first timestamp with active preferred,
1519 creation time, scheduled time, deadline time), by priority, by TODO keyword
1520 (in the sequence the keywords have been defined in the setup) or by the value
1521 of a property. Reverse sorting is possible as well. You can also supply
1522 your own function to extract the sorting key. With a @kbd{C-u} prefix,
1523 sorting will be case-sensitive.
1524 @orgcmd{C-x n s,org-narrow-to-subtree}
1525 Narrow buffer to current subtree.
1526 @orgcmd{C-x n b,org-narrow-to-block}
1527 Narrow buffer to current block.
1528 @orgcmd{C-x n w,widen}
1529 Widen buffer to remove narrowing.
1530 @orgcmd{C-c *,org-toggle-heading}
1531 Turn a normal line or plain list item into a headline (so that it becomes a
1532 subheading at its location). Also turn a headline into a normal line by
1533 removing the stars. If there is an active region, turn all lines in the
1534 region into headlines. If the first line in the region was an item, turn
1535 only the item lines into headlines. Finally, if the first line is a
1536 headline, remove the stars from all headlines in the region.
1539 @cindex region, active
1540 @cindex active region
1541 @cindex transient mark mode
1542 When there is an active region (Transient Mark mode), promotion and
1543 demotion work on all headlines in the region. To select a region of
1544 headlines, it is best to place both point and mark at the beginning of a
1545 line, mark at the beginning of the first headline, and point at the line
1546 just after the last headline to change. Note that when the cursor is
1547 inside a table (@pxref{Tables}), the Meta-Cursor keys have different
1551 @node Sparse trees, Plain lists, Structure editing, Document Structure
1552 @section Sparse trees
1553 @cindex sparse trees
1554 @cindex trees, sparse
1555 @cindex folding, sparse trees
1556 @cindex occur, command
1558 @vindex org-show-hierarchy-above
1559 @vindex org-show-following-heading
1560 @vindex org-show-siblings
1561 @vindex org-show-entry-below
1562 An important feature of Org mode is the ability to construct @emph{sparse
1563 trees} for selected information in an outline tree, so that the entire
1564 document is folded as much as possible, but the selected information is made
1565 visible along with the headline structure above it@footnote{See also the
1566 variables @code{org-show-hierarchy-above}, @code{org-show-following-heading},
1567 @code{org-show-siblings}, and @code{org-show-entry-below} for detailed
1568 control on how much context is shown around each match.}. Just try it out
1569 and you will see immediately how it works.
1571 Org mode contains several commands creating such trees, all these
1572 commands can be accessed through a dispatcher:
1575 @orgcmd{C-c /,org-sparse-tree}
1576 This prompts for an extra key to select a sparse-tree creating command.
1577 @orgcmd{C-c / r,org-occur}
1578 @vindex org-remove-highlights-with-change
1579 Prompts for a regexp and shows a sparse tree with all matches. If
1580 the match is in a headline, the headline is made visible. If the match is in
1581 the body of an entry, headline and body are made visible. In order to
1582 provide minimal context, also the full hierarchy of headlines above the match
1583 is shown, as well as the headline following the match. Each match is also
1584 highlighted; the highlights disappear when the buffer is changed by an
1585 editing command@footnote{This depends on the option
1586 @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
1587 When called with a @kbd{C-u} prefix argument, previous highlights are kept,
1588 so several calls to this command can be stacked.
1589 @orgcmdkkc{M-g n,M-g M-n,next-error}
1590 Jump to the next sparse tree match in this buffer.
1591 @orgcmdkkc{M-g p,M-g M-p,previous-error}
1592 Jump to the previous sparse tree match in this buffer.
1597 @vindex org-agenda-custom-commands
1598 For frequently used sparse trees of specific search strings, you can
1599 use the variable @code{org-agenda-custom-commands} to define fast
1600 keyboard access to specific sparse trees. These commands will then be
1601 accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
1605 (setq org-agenda-custom-commands
1606 '(("f" occur-tree "FIXME")))
1609 @noindent will define the key @kbd{C-c a f} as a shortcut for creating
1610 a sparse tree matching the string @samp{FIXME}.
1612 The other sparse tree commands select headings based on TODO keywords,
1613 tags, or properties and will be discussed later in this manual.
1616 @cindex printing sparse trees
1617 @cindex visible text, printing
1618 To print a sparse tree, you can use the Emacs command
1619 @code{ps-print-buffer-with-faces} which does not print invisible parts
1620 of the document @footnote{This does not work under XEmacs, because
1621 XEmacs uses selective display for outlining, not text properties.}.
1622 Or you can use @kbd{C-c C-e C-v} to export only the visible part of
1623 the document and print the resulting file.
1625 @node Plain lists, Drawers, Sparse trees, Document Structure
1626 @section Plain lists
1628 @cindex lists, plain
1629 @cindex lists, ordered
1630 @cindex ordered lists
1632 Within an entry of the outline tree, hand-formatted lists can provide
1633 additional structure. They also provide a way to create lists of checkboxes
1634 (@pxref{Checkboxes}). Org supports editing such lists, and every exporter
1635 (@pxref{Exporting}) can parse and format them.
1637 Org knows ordered lists, unordered lists, and description lists.
1640 @emph{Unordered} list items start with @samp{-}, @samp{+}, or
1641 @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
1642 they will be seen as top-level headlines. Also, when you are hiding leading
1643 stars to get a clean outline view, plain list items starting with a star may
1644 be hard to distinguish from true headlines. In short: even though @samp{*}
1645 is supported, it may be better to not use it for plain list items.} as
1648 @vindex org-plain-list-ordered-item-terminator
1649 @vindex org-list-allow-alphabetical
1650 @emph{Ordered} list items start with a numeral followed by either a period or
1651 a right parenthesis@footnote{You can filter out any of them by configuring
1652 @code{org-plain-list-ordered-item-terminator}.}, such as @samp{1.} or
1653 @samp{1)}@footnote{You can also get @samp{a.}, @samp{A.}, @samp{a)} and
1654 @samp{A)} by configuring @code{org-list-allow-alphabetical}. To minimize
1655 confusion with normal text, those are limited to one character only. Beyond
1656 that limit, bullets will automatically fallback to numbers.}. If you want a
1657 list to start with a different value (e.g., 20), start the text of the item
1658 with @code{[@@20]}@footnote{If there's a checkbox in the item, the cookie
1659 must be put @emph{before} the checkbox. If you have activated alphabetical
1660 lists, you can also use counters like @code{[@@b]}.}. Those constructs can
1661 be used in any item of the list in order to enforce a particular numbering.
1663 @emph{Description} list items are unordered list items, and contain the
1664 separator @samp{ :: } to distinguish the description @emph{term} from the
1668 Items belonging to the same list must have the same indentation on the first
1669 line. In particular, if an ordered list reaches number @samp{10.}, then the
1670 2--digit numbers must be written left-aligned with the other numbers in the
1671 list. An item ends before the next line that is less or equally indented
1672 than its bullet/number.
1674 @vindex org-list-empty-line-terminates-plain-lists
1675 A list ends whenever every item has ended, which means before any line less
1676 or equally indented than items at top level. It also ends before two blank
1677 lines@footnote{See also @code{org-list-empty-line-terminates-plain-lists}.}.
1678 In that case, all items are closed. Here is an example:
1682 ** Lord of the Rings
1683 My favorite scenes are (in this order)
1684 1. The attack of the Rohirrim
1685 2. Eowyn's fight with the witch king
1686 + this was already my favorite scene in the book
1687 + I really like Miranda Otto.
1688 3. Peter Jackson being shot by Legolas
1690 He makes a really funny face when it happens.
1691 But in the end, no individual scenes matter but the film as a whole.
1692 Important actors in this film are:
1693 - @b{Elijah Wood} :: He plays Frodo
1694 - @b{Sean Austin} :: He plays Sam, Frodo's friend. I still remember
1695 him very well from his role as Mikey Walsh in @i{The Goonies}.
1699 Org supports these lists by tuning filling and wrapping commands to deal with
1700 them correctly@footnote{Org only changes the filling settings for Emacs. For
1701 XEmacs, you should use Kyle E. Jones' @file{filladapt.el}. To turn this on,
1702 put into @file{.emacs}: @code{(require 'filladapt)}}, and by exporting them
1703 properly (@pxref{Exporting}). Since indentation is what governs the
1704 structure of these lists, many structural constructs like @code{#+BEGIN_...}
1705 blocks can be indented to signal that they belong to a particular item.
1707 @vindex org-list-demote-modify-bullet
1708 @vindex org-list-indent-offset
1709 If you find that using a different bullet for a sub-list (than that used for
1710 the current list-level) improves readability, customize the variable
1711 @code{org-list-demote-modify-bullet}. To get a greater difference of
1712 indentation between items and theirs sub-items, customize
1713 @code{org-list-indent-offset}.
1715 @vindex org-list-automatic-rules
1716 The following commands act on items when the cursor is in the first line of
1717 an item (the line with the bullet or number). Some of them imply the
1718 application of automatic rules to keep list structure intact. If some of
1719 these actions get in your way, configure @code{org-list-automatic-rules}
1720 to disable them individually.
1723 @orgcmd{@key{TAB},org-cycle}
1724 @cindex cycling, in plain lists
1725 @vindex org-cycle-include-plain-lists
1726 Items can be folded just like headline levels. Normally this works only if
1727 the cursor is on a plain list item. For more details, see the variable
1728 @code{org-cycle-include-plain-lists}. If this variable is set to
1729 @code{integrate}, plain list items will be treated like low-level
1730 headlines. The level of an item is then given by the indentation of the
1731 bullet/number. Items are always subordinate to real headlines, however; the
1732 hierarchies remain completely separated. In a new item with no text yet, the
1733 first @key{TAB} demotes the item to become a child of the previous
1734 one. Subsequent @key{TAB}s move the item to meaningful levels in the list
1735 and eventually get it back to its initial position.
1736 @orgcmd{M-@key{RET},org-insert-heading}
1737 @vindex org-M-RET-may-split-line
1738 @vindex org-list-automatic-rules
1739 Insert new item at current level. With a prefix argument, force a new
1740 heading (@pxref{Structure editing}). If this command is used in the middle
1741 of an item, that item is @emph{split} in two, and the second part becomes the
1742 new item@footnote{If you do not want the item to be split, customize the
1743 variable @code{org-M-RET-may-split-line}.}. If this command is executed
1744 @emph{before item's body}, the new item is created @emph{before} the current
1749 @kindex M-S-@key{RET}
1751 Insert a new item with a checkbox (@pxref{Checkboxes}).
1752 @kindex S-@key{down}
1755 @cindex shift-selection-mode
1756 @vindex org-support-shift-select
1757 @vindex org-list-use-circular-motion
1758 Jump to the previous/next item in the current list@footnote{If you want to
1759 cycle around items that way, you may customize
1760 @code{org-list-use-circular-motion}.}, but only if
1761 @code{org-support-shift-select} is off. If not, you can still use paragraph
1762 jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite
1765 @kindex M-@key{down}
1768 Move the item including subitems up/down@footnote{See
1769 @code{org-list-use-circular-motion} for a cyclic behavior.} (swap with
1770 previous/next item of same indentation). If the list is ordered, renumbering
1772 @kindex M-@key{left}
1773 @kindex M-@key{right}
1776 Decrease/increase the indentation of an item, leaving children alone.
1777 @kindex M-S-@key{left}
1778 @kindex M-S-@key{right}
1781 Decrease/increase the indentation of the item, including subitems.
1782 Initially, the item tree is selected based on current indentation. When
1783 these commands are executed several times in direct succession, the initially
1784 selected region is used, even if the new indentation would imply a different
1785 hierarchy. To use the new hierarchy, break the command chain with a cursor
1788 As a special case, using this command on the very first item of a list will
1789 move the whole list. This behavior can be disabled by configuring
1790 @code{org-list-automatic-rules}. The global indentation of a list has no
1791 influence on the text @emph{after} the list.
1794 If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
1795 state of the checkbox. In any case, verify bullets and indentation
1796 consistency in the whole list.
1798 @vindex org-plain-list-ordered-item-terminator
1800 Cycle the entire list level through the different itemize/enumerate bullets
1801 (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}) or a subset of them,
1802 depending on @code{org-plain-list-ordered-item-terminator}, the type of list,
1803 and its indentation. With a numeric prefix argument N, select the Nth bullet
1804 from this list. If there is an active region when calling this, selected
1805 text will be changed into an item. With a prefix argument, all lines will be
1806 converted to list items. If the first line already was a list item, any item
1807 marker will be removed from the list. Finally, even without an active
1808 region, a normal line will be converted into a list item.
1811 Turn a plain list item into a headline (so that it becomes a subheading at
1812 its location). @xref{Structure editing}, for a detailed explanation.
1815 Turn the whole plain list into a subtree of the current heading. Checkboxes
1816 (@pxref{Checkboxes}) will become TODO (resp. DONE) keywords when unchecked
1818 @kindex S-@key{left}
1819 @kindex S-@key{right}
1821 @vindex org-support-shift-select
1822 This command also cycles bullet styles when the cursor in on the bullet or
1823 anywhere in an item line, details depending on
1824 @code{org-support-shift-select}.
1827 Sort the plain list. You will be prompted for the sorting method:
1828 numerically, alphabetically, by time, or by custom function.
1831 @node Drawers, Blocks, Plain lists, Document Structure
1835 @cindex visibility cycling, drawers
1838 @cindex org-insert-drawer
1840 Sometimes you want to keep information associated with an entry, but you
1841 normally don't want to see it. For this, Org mode has @emph{drawers}.
1842 Drawers need to be configured with the variable
1843 @code{org-drawers}@footnote{You can define additional drawers on a
1844 per-file basis with a line like @code{#+DRAWERS: HIDDEN STATE}}. Drawers
1848 ** This is a headline
1849 Still outside the drawer
1851 This is inside the drawer.
1856 You can interactively insert drawers at point by calling
1857 @code{org-insert-drawer}, which is bound to @key{C-c C-x d}. With an active
1858 region, this command will put the region inside the drawer. With a prefix
1859 argument, this command calls @code{org-insert-property-drawer} and add a
1860 property drawer right below the current headline. Completion over drawer
1861 keywords is also possible using @key{M-TAB}.
1863 Visibility cycling (@pxref{Visibility cycling}) on the headline will hide and
1864 show the entry, but keep the drawer collapsed to a single line. In order to
1865 look inside the drawer, you need to move the cursor to the drawer line and
1866 press @key{TAB} there. Org mode uses the @code{PROPERTIES} drawer for
1867 storing properties (@pxref{Properties and Columns}), and you can also arrange
1868 for state change notes (@pxref{Tracking TODO state changes}) and clock times
1869 (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}. If you
1870 want to store a quick note in the LOGBOOK drawer, in a similar way to state changes, use
1875 Add a time-stamped note to the LOGBOOK drawer.
1878 @node Blocks, Footnotes, Drawers, Document Structure
1881 @vindex org-hide-block-startup
1882 @cindex blocks, folding
1883 Org mode uses begin...end blocks for various purposes from including source
1884 code examples (@pxref{Literal examples}) to capturing time logging
1885 information (@pxref{Clocking work time}). These blocks can be folded and
1886 unfolded by pressing TAB in the begin line. You can also get all blocks
1887 folded at startup by configuring the variable @code{org-hide-block-startup}
1888 or on a per-file basis by using
1890 @cindex @code{hideblocks}, STARTUP keyword
1891 @cindex @code{nohideblocks}, STARTUP keyword
1893 #+STARTUP: hideblocks
1894 #+STARTUP: nohideblocks
1897 @node Footnotes, Orgstruct mode, Blocks, Document Structure
1901 Org mode supports the creation of footnotes. In contrast to the
1902 @file{footnote.el} package, Org mode's footnotes are designed for work on
1903 a larger document, not only for one-off documents like emails.
1905 A footnote is started by a footnote marker in square brackets in column 0, no
1906 indentation allowed. It ends at the next footnote definition, headline, or
1907 after two consecutive empty lines. The footnote reference is simply the
1908 marker in square brackets, inside text. For example:
1911 The Org homepage[fn:1] now looks a lot better than it used to.
1913 [fn:1] The link is: http://orgmode.org
1916 Org mode extends the number-based syntax to @emph{named} footnotes and
1917 optional inline definition. Using plain numbers as markers (as
1918 @file{footnote.el} does) is supported for backward compatibility, but not
1919 encouraged because of possible conflicts with @LaTeX{} snippets (@pxref{Embedded
1920 @LaTeX{}}). Here are the valid references:
1924 A plain numeric footnote marker. Compatible with @file{footnote.el}, but not
1925 recommended because something like @samp{[1]} could easily be part of a code
1928 A named footnote reference, where @code{name} is a unique label word, or, for
1929 simplicity of automatic creation, a number.
1930 @item [fn:: This is the inline definition of this footnote]
1931 A @LaTeX{}-like anonymous footnote where the definition is given directly at the
1933 @item [fn:name: a definition]
1934 An inline definition of a footnote, which also specifies a name for the note.
1935 Since Org allows multiple references to the same note, you can then use
1936 @code{[fn:name]} to create additional references.
1939 @vindex org-footnote-auto-label
1940 Footnote labels can be created automatically, or you can create names yourself.
1941 This is handled by the variable @code{org-footnote-auto-label} and its
1942 corresponding @code{#+STARTUP} keywords. See the docstring of that variable
1945 @noindent The following command handles footnotes:
1950 The footnote action command.
1952 When the cursor is on a footnote reference, jump to the definition. When it
1953 is at a definition, jump to the (first) reference.
1955 @vindex org-footnote-define-inline
1956 @vindex org-footnote-section
1957 @vindex org-footnote-auto-adjust
1958 Otherwise, create a new footnote. Depending on the variable
1959 @code{org-footnote-define-inline}@footnote{The corresponding in-buffer
1960 setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
1961 definition will be placed right into the text as part of the reference, or
1962 separately into the location determined by the variable
1963 @code{org-footnote-section}.
1965 When this command is called with a prefix argument, a menu of additional
1968 s @r{Sort the footnote definitions by reference sequence. During editing,}
1969 @r{Org makes no effort to sort footnote definitions into a particular}
1970 @r{sequence. If you want them sorted, use this command, which will}
1971 @r{also move entries according to @code{org-footnote-section}. Automatic}
1972 @r{sorting after each insertion/deletion can be configured using the}
1973 @r{variable @code{org-footnote-auto-adjust}.}
1974 r @r{Renumber the simple @code{fn:N} footnotes. Automatic renumbering}
1975 @r{after each insertion/deletion can be configured using the variable}
1976 @r{@code{org-footnote-auto-adjust}.}
1977 S @r{Short for first @code{r}, then @code{s} action.}
1978 n @r{Normalize the footnotes by collecting all definitions (including}
1979 @r{inline definitions) into a special section, and then numbering them}
1980 @r{in sequence. The references will then also be numbers. This is}
1981 @r{meant to be the final step before finishing a document (e.g., sending}
1983 d @r{Delete the footnote at point, and all definitions of and references}
1986 Depending on the variable @code{org-footnote-auto-adjust}@footnote{the
1987 corresponding in-buffer options are @code{fnadjust} and @code{nofnadjust}.},
1988 renumbering and sorting footnotes can be automatic after each insertion or
1993 If the cursor is on a footnote reference, jump to the definition. If it is a
1994 the definition, jump back to the reference. When called at a footnote
1995 location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
1999 @item C-c C-o @r{or} mouse-1/2
2000 Footnote labels are also links to the corresponding definition/reference, and
2001 you can use the usual commands to follow these links.
2004 @node Orgstruct mode, Org syntax, Footnotes, Document Structure
2005 @section The Orgstruct minor mode
2006 @cindex Orgstruct mode
2007 @cindex minor mode for structure editing
2009 If you like the intuitive way the Org mode structure editing and list
2010 formatting works, you might want to use these commands in other modes like
2011 Text mode or Mail mode as well. The minor mode @code{orgstruct-mode} makes
2012 this possible. Toggle the mode with @kbd{M-x orgstruct-mode}, or
2013 turn it on by default, for example in Message mode, with one of:
2016 (add-hook 'message-mode-hook 'turn-on-orgstruct)
2017 (add-hook 'message-mode-hook 'turn-on-orgstruct++)
2020 When this mode is active and the cursor is on a line that looks to Org like a
2021 headline or the first line of a list item, most structure editing commands
2022 will work, even if the same keys normally have different functionality in the
2023 major mode you are using. If the cursor is not in one of those special
2024 lines, Orgstruct mode lurks silently in the shadows.
2026 When you use @code{orgstruct++-mode}, Org will also export indentation and
2027 autofill settings into that mode, and detect item context after the first
2030 @vindex orgstruct-heading-prefix-regexp
2031 You can also use Org structure editing to fold and unfold headlines in
2032 @emph{any} file, provided you defined @var{orgstruct-heading-prefix-regexp}:
2033 the regular expression must match the local prefix to use before Org's
2034 headlines. For example, if you set this variable to @code{"^;; "} in Emacs
2035 Lisp files, you will be able to fold and unfold headlines in Emacs Lisp
2036 commented lines. Some commands like @code{org-demote} are disabled when the
2037 prefix is set, but folding/unfolding will work correctly.
2039 @node Org syntax, , Orgstruct mode, Document Structure
2043 A reference document providing a formal description of Org's syntax is
2044 available as @uref{http://orgmode.org/worg/dev/org-syntax.html, a draft on
2045 Worg}, written and maintained by Nicolas Goaziou. It defines Org's core
2046 internal concepts such as @code{headlines}, @code{sections}, @code{affiliated
2047 keywords}, @code{(greater) elements} and @code{objects}. Each part of an Org
2048 file falls into one of the categories above.
2050 To explore the abstract structure of an Org buffer, run this in a buffer:
2053 M-: (org-element-parse-buffer) RET
2056 It will output a list containing the buffer's content represented as an
2057 abstract structure. The export engine relies on the information stored in
2058 this list. Most interactive commands (e.g., for structure editing) also
2059 rely on the syntactic meaning of the surrounding context.
2061 @node Tables, Hyperlinks, Document Structure, Top
2064 @cindex editing tables
2066 Org comes with a fast and intuitive table editor. Spreadsheet-like
2067 calculations are supported using the Emacs @file{calc} package
2068 (@pxref{Top, Calc, , calc, Gnu Emacs Calculator Manual}).
2071 * Built-in table editor:: Simple tables
2072 * Column width and alignment:: Overrule the automatic settings
2073 * Column groups:: Grouping to trigger vertical lines
2074 * Orgtbl mode:: The table editor as minor mode
2075 * The spreadsheet:: The table editor has spreadsheet capabilities
2076 * Org-Plot:: Plotting from org tables
2079 @node Built-in table editor, Column width and alignment, Tables, Tables
2080 @section The built-in table editor
2081 @cindex table editor, built-in
2083 Org makes it easy to format tables in plain ASCII@. Any line with @samp{|} as
2084 the first non-whitespace character is considered part of a table. @samp{|}
2085 is also the column separator@footnote{To insert a vertical bar into a table
2086 field, use @code{\vert} or, inside a word @code{abc\vert@{@}def}.}. A table
2087 might look like this:
2090 | Name | Phone | Age |
2091 |-------+-------+-----|
2092 | Peter | 1234 | 17 |
2093 | Anna | 4321 | 25 |
2096 A table is re-aligned automatically each time you press @key{TAB} or
2097 @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to
2098 the next field (@key{RET} to the next row) and creates new table rows
2099 at the end of the table or before horizontal lines. The indentation
2100 of the table is set by the first line. Any line starting with
2101 @samp{|-} is considered as a horizontal separator line and will be
2102 expanded on the next re-align to span the whole table width. So, to
2103 create the above table, you would only type
2110 @noindent and then press @key{TAB} to align the table and start filling in
2111 fields. Even faster would be to type @code{|Name|Phone|Age} followed by
2112 @kbd{C-c @key{RET}}.
2114 @vindex org-enable-table-editor
2115 @vindex org-table-auto-blank-field
2116 When typing text into a field, Org treats @key{DEL},
2117 @key{Backspace}, and all character keys in a special way, so that
2118 inserting and deleting avoids shifting other fields. Also, when
2119 typing @emph{immediately after the cursor was moved into a new field
2120 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
2121 field is automatically made blank. If this behavior is too
2122 unpredictable for you, configure the variables
2123 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
2126 @tsubheading{Creation and conversion}
2127 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2128 Convert the active region to table. If every line contains at least one
2129 TAB character, the function assumes that the material is tab separated.
2130 If every line contains a comma, comma-separated values (CSV) are assumed.
2131 If not, lines are split at whitespace into fields. You can use a prefix
2132 argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
2133 C-u} forces TAB, and a numeric argument N indicates that at least N
2134 consecutive spaces, or alternatively a TAB will be the separator.
2136 If there is no active region, this command creates an empty Org
2137 table. But it is easier just to start typing, like
2138 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
2140 @tsubheading{Re-aligning and field motion}
2141 @orgcmd{C-c C-c,org-table-align}
2142 Re-align the table and don't move to another field.
2144 @orgcmd{<TAB>,org-table-next-field}
2145 Re-align the table, move to the next field. Creates a new row if
2148 @orgcmd{S-@key{TAB},org-table-previous-field}
2149 Re-align, move to previous field.
2151 @orgcmd{@key{RET},org-table-next-row}
2152 Re-align the table and move down to next row. Creates a new row if
2153 necessary. At the beginning or end of a line, @key{RET} still does
2154 NEWLINE, so it can be used to split a table.
2156 @orgcmd{M-a,org-table-beginning-of-field}
2157 Move to beginning of the current table field, or on to the previous field.
2158 @orgcmd{M-e,org-table-end-of-field}
2159 Move to end of the current table field, or on to the next field.
2161 @tsubheading{Column and row editing}
2162 @orgcmdkkcc{M-@key{left},M-@key{right},org-table-move-column-left,org-table-move-column-right}
2163 Move the current column left/right.
2165 @orgcmd{M-S-@key{left},org-table-delete-column}
2166 Kill the current column.
2168 @orgcmd{M-S-@key{right},org-table-insert-column}
2169 Insert a new column to the left of the cursor position.
2171 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-move-row-up,org-table-move-row-down}
2172 Move the current row up/down.
2174 @orgcmd{M-S-@key{up},org-table-kill-row}
2175 Kill the current row or horizontal line.
2177 @orgcmd{M-S-@key{down},org-table-insert-row}
2178 Insert a new row above the current row. With a prefix argument, the line is
2179 created below the current one.
2181 @orgcmd{C-c -,org-table-insert-hline}
2182 Insert a horizontal line below current row. With a prefix argument, the line
2183 is created above the current line.
2185 @orgcmd{C-c @key{RET},org-table-hline-and-move}
2186 Insert a horizontal line below current row, and move the cursor into the row
2189 @orgcmd{C-c ^,org-table-sort-lines}
2190 Sort the table lines in the region. The position of point indicates the
2191 column to be used for sorting, and the range of lines is the range
2192 between the nearest horizontal separator lines, or the entire table. If
2193 point is before the first column, you will be prompted for the sorting
2194 column. If there is an active region, the mark specifies the first line
2195 and the sorting column, while point should be in the last line to be
2196 included into the sorting. The command prompts for the sorting type
2197 (alphabetically, numerically, or by time). When called with a prefix
2198 argument, alphabetic sorting will be case-sensitive.
2200 @tsubheading{Regions}
2201 @orgcmd{C-c C-x M-w,org-table-copy-region}
2202 Copy a rectangular region from a table to a special clipboard. Point and
2203 mark determine edge fields of the rectangle. If there is no active region,
2204 copy just the current field. The process ignores horizontal separator lines.
2206 @orgcmd{C-c C-x C-w,org-table-cut-region}
2207 Copy a rectangular region from a table to a special clipboard, and
2208 blank all fields in the rectangle. So this is the ``cut'' operation.
2210 @orgcmd{C-c C-x C-y,org-table-paste-rectangle}
2211 Paste a rectangular region into a table.
2212 The upper left corner ends up in the current field. All involved fields
2213 will be overwritten. If the rectangle does not fit into the present table,
2214 the table is enlarged as needed. The process ignores horizontal separator
2217 @orgcmd{M-@key{RET},org-table-wrap-region}
2218 Split the current field at the cursor position and move the rest to the line
2219 below. If there is an active region, and both point and mark are in the same
2220 column, the text in the column is wrapped to minimum width for the given
2221 number of lines. A numeric prefix argument may be used to change the number
2222 of desired lines. If there is no region, but you specify a prefix argument,
2223 the current field is made blank, and the content is appended to the field
2226 @tsubheading{Calculations}
2227 @cindex formula, in tables
2228 @cindex calculations, in tables
2229 @cindex region, active
2230 @cindex active region
2231 @cindex transient mark mode
2232 @orgcmd{C-c +,org-table-sum}
2233 Sum the numbers in the current column, or in the rectangle defined by
2234 the active region. The result is shown in the echo area and can
2235 be inserted with @kbd{C-y}.
2237 @orgcmd{S-@key{RET},org-table-copy-down}
2238 @vindex org-table-copy-increment
2239 When current field is empty, copy from first non-empty field above. When not
2240 empty, copy current field down to next row and move cursor along with it.
2241 Depending on the variable @code{org-table-copy-increment}, integer field
2242 values will be incremented during copy. Integers that are too large will not
2243 be incremented. Also, a @code{0} prefix argument temporarily disables the
2244 increment. This key is also used by shift-selection and related modes
2245 (@pxref{Conflicts}).
2247 @tsubheading{Miscellaneous}
2248 @orgcmd{C-c `,org-table-edit-field}
2249 Edit the current field in a separate window. This is useful for fields that
2250 are not fully visible (@pxref{Column width and alignment}). When called with
2251 a @kbd{C-u} prefix, just make the full field visible, so that it can be
2252 edited in place. When called with two @kbd{C-u} prefixes, make the editor
2253 window follow the cursor through the table and always show the current
2254 field. The follow mode exits automatically when the cursor leaves the table,
2255 or when you repeat this command with @kbd{C-u C-u C-c `}.
2257 @item M-x org-table-import
2258 Import a file as a table. The table should be TAB or whitespace
2259 separated. Use, for example, to import a spreadsheet table or data
2260 from a database, because these programs generally can write
2261 TAB-separated text files. This command works by inserting the file into
2262 the buffer and then converting the region to a table. Any prefix
2263 argument is passed on to the converter, which uses it to determine the
2265 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2266 Tables can also be imported by pasting tabular text into the Org
2267 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
2268 @kbd{C-c |} command (see above under @i{Creation and conversion}).
2270 @item M-x org-table-export
2271 @findex org-table-export
2272 @vindex org-table-export-default-format
2273 Export the table, by default as a TAB-separated file. Use for data
2274 exchange with, for example, spreadsheet or database programs. The format
2275 used to export the file can be configured in the variable
2276 @code{org-table-export-default-format}. You may also use properties
2277 @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
2278 name and the format for table export in a subtree. Org supports quite
2279 general formats for exported tables. The exporter format is the same as the
2280 format used by Orgtbl radio tables, see @ref{Translator functions}, for a
2281 detailed description.
2284 If you don't like the automatic table editor because it gets in your
2285 way on lines which you would like to start with @samp{|}, you can turn
2289 (setq org-enable-table-editor nil)
2292 @noindent Then the only table command that still works is
2293 @kbd{C-c C-c} to do a manual re-align.
2295 @node Column width and alignment, Column groups, Built-in table editor, Tables
2296 @section Column width and alignment
2297 @cindex narrow columns in tables
2298 @cindex alignment in tables
2300 The width of columns is automatically determined by the table editor. And
2301 also the alignment of a column is determined automatically from the fraction
2302 of number-like versus non-number fields in the column.
2304 Sometimes a single field or a few fields need to carry more text, leading to
2305 inconveniently wide columns. Or maybe you want to make a table with several
2306 columns having a fixed width, regardless of content. To set@footnote{This
2307 feature does not work on XEmacs.} the width of a column, one field anywhere
2308 in the column may contain just the string @samp{<N>} where @samp{N} is an
2309 integer specifying the width of the column in characters. The next re-align
2310 will then set the width of this column to this value.
2314 |---+------------------------------| |---+--------|
2316 | 1 | one | | 1 | one |
2317 | 2 | two | ----\ | 2 | two |
2318 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
2319 | 4 | four | | 4 | four |
2320 |---+------------------------------| |---+--------|
2325 Fields that are wider become clipped and end in the string @samp{=>}.
2326 Note that the full text is still in the buffer but is hidden.
2327 To see the full text, hold the mouse over the field---a tool-tip window
2328 will show the full content. To edit such a field, use the command
2329 @kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will
2330 open a new window with the full field. Edit it and finish with @kbd{C-c
2333 @vindex org-startup-align-all-tables
2334 When visiting a file containing a table with narrowed columns, the
2335 necessary character hiding has not yet happened, and the table needs to
2336 be aligned before it looks nice. Setting the option
2337 @code{org-startup-align-all-tables} will realign all tables in a file
2338 upon visiting, but also slow down startup. You can also set this option
2339 on a per-file basis with:
2346 If you would like to overrule the automatic alignment of number-rich columns
2347 to the right and of string-rich column to the left, you can use @samp{<r>},
2348 @samp{<c>}@footnote{Centering does not work inside Emacs, but it does have an
2349 effect when exporting to HTML.} or @samp{<l>} in a similar fashion. You may
2350 also combine alignment and field width like this: @samp{<r10>}.
2352 Lines which only contain these formatting cookies will be removed
2353 automatically when exporting the document.
2355 @node Column groups, Orgtbl mode, Column width and alignment, Tables
2356 @section Column groups
2357 @cindex grouping columns in tables
2359 When Org exports tables, it does so by default without vertical
2360 lines because that is visually more satisfying in general. Occasionally
2361 however, vertical lines can be useful to structure a table into groups
2362 of columns, much like horizontal lines can do for groups of rows. In
2363 order to specify column groups, you can use a special row where the
2364 first field contains only @samp{/}. The further fields can either
2365 contain @samp{<} to indicate that this column should start a group,
2366 @samp{>} to indicate the end of a column, or @samp{<>} (no space between @samp{<}
2367 and @samp{>}) to make a column
2368 a group of its own. Boundaries between column groups will upon export be
2369 marked with vertical lines. Here is an example:
2372 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2373 |---+-----+-----+-----+---------+------------|
2374 | / | < | | > | < | > |
2375 | 1 | 1 | 1 | 1 | 1 | 1 |
2376 | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
2377 | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
2378 |---+-----+-----+-----+---------+------------|
2379 #+TBLFM: $2=$1^2::$3=$1^3::$4=$1^4::$5=sqrt($1)::$6=sqrt(sqrt(($1)))
2382 It is also sufficient to just insert the column group starters after
2383 every vertical line you would like to have:
2386 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2387 |----+-----+-----+-----+---------+------------|
2391 @node Orgtbl mode, The spreadsheet, Column groups, Tables
2392 @section The Orgtbl minor mode
2394 @cindex minor mode for tables
2396 If you like the intuitive way the Org table editor works, you
2397 might also want to use it in other modes like Text mode or Mail mode.
2398 The minor mode Orgtbl mode makes this possible. You can always toggle
2399 the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for
2400 example in Message mode, use
2403 (add-hook 'message-mode-hook 'turn-on-orgtbl)
2406 Furthermore, with some special setup, it is possible to maintain tables
2407 in arbitrary syntax with Orgtbl mode. For example, it is possible to
2408 construct @LaTeX{} tables with the underlying ease and power of
2409 Orgtbl mode, including spreadsheet capabilities. For details, see
2410 @ref{Tables in arbitrary syntax}.
2412 @node The spreadsheet, Org-Plot, Orgtbl mode, Tables
2413 @section The spreadsheet
2414 @cindex calculations, in tables
2415 @cindex spreadsheet capabilities
2416 @cindex @file{calc} package
2418 The table editor makes use of the Emacs @file{calc} package to implement
2419 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
2420 derive fields from other fields. While fully featured, Org's implementation
2421 is not identical to other spreadsheets. For example, Org knows the concept
2422 of a @emph{column formula} that will be applied to all non-header fields in a
2423 column without having to copy the formula to each relevant field. There is
2424 also a formula debugger, and a formula editor with features for highlighting
2425 fields in the table corresponding to the references at the point in the
2426 formula, moving these references by arrow keys
2429 * References:: How to refer to another field or range
2430 * Formula syntax for Calc:: Using Calc to compute stuff
2431 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
2432 * Durations and time values:: How to compute durations and time values
2433 * Field and range formulas:: Formula for specific (ranges of) fields
2434 * Column formulas:: Formulas valid for an entire column
2435 * Lookup functions:: Lookup functions for searching tables
2436 * Editing and debugging formulas:: Fixing formulas
2437 * Updating the table:: Recomputing all dependent fields
2438 * Advanced features:: Field and column names, parameters and automatic recalc
2441 @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet
2442 @subsection References
2445 To compute fields in the table from other fields, formulas must
2446 reference other fields or ranges. In Org, fields can be referenced
2447 by name, by absolute coordinates, and by relative coordinates. To find
2448 out what the coordinates of a field are, press @kbd{C-c ?} in that
2449 field, or press @kbd{C-c @}} to toggle the display of a grid.
2451 @subsubheading Field references
2452 @cindex field references
2453 @cindex references, to fields
2455 Formulas can reference the value of another field in two ways. Like in
2456 any other spreadsheet, you may reference fields with a letter/number
2457 combination like @code{B3}, meaning the 2nd field in the 3rd row.
2458 @vindex org-table-use-standard-references
2459 However, Org prefers@footnote{Org will understand references typed by the
2460 user as @samp{B4}, but it will not use this syntax when offering a formula
2461 for editing. You can customize this behavior using the variable
2462 @code{org-table-use-standard-references}.} to use another, more general
2463 representation that looks like this:
2465 @@@var{row}$@var{column}
2468 Column specifications can be absolute like @code{$1},
2469 @code{$2},...@code{$@var{N}}, or relative to the current column (i.e., the
2470 column of the field which is being computed) like @code{$+1} or @code{$-2}.
2471 @code{$<} and @code{$>} are immutable references to the first and last
2472 column, respectively, and you can use @code{$>>>} to indicate the third
2473 column from the right.
2475 The row specification only counts data lines and ignores horizontal separator
2476 lines (hlines). Like with columns, you can use absolute row numbers
2477 @code{@@1}, @code{@@2},...@code{@@@var{N}}, and row numbers relative to the
2478 current row like @code{@@+3} or @code{@@-1}. @code{@@<} and @code{@@>} are
2479 immutable references the first and last@footnote{For backward compatibility
2480 you can also use special names like @code{$LR5} and @code{$LR12} to refer in
2481 a stable way to the 5th and 12th field in the last row of the table.
2482 However, this syntax is deprecated, it should not be used for new documents.
2483 Use @code{@@>$} instead.} row in the table, respectively. You may also
2484 specify the row relative to one of the hlines: @code{@@I} refers to the first
2485 hline, @code{@@II} to the second, etc. @code{@@-I} refers to the first such
2486 line above the current line, @code{@@+I} to the first such line below the
2487 current line. You can also write @code{@@III+2} which is the second data line
2488 after the third hline in the table.
2490 @code{@@0} and @code{$0} refer to the current row and column, respectively,
2491 i.e., to the row/column for the field being computed. Also, if you omit
2492 either the column or the row part of the reference, the current row/column is
2495 Org's references with @emph{unsigned} numbers are fixed references
2496 in the sense that if you use the same reference in the formula for two
2497 different fields, the same field will be referenced each time.
2498 Org's references with @emph{signed} numbers are floating
2499 references because the same reference operator can reference different
2500 fields depending on the field being calculated by the formula.
2502 Here are a few examples:
2505 @@2$3 @r{2nd row, 3rd column (same as @code{C2})}
2506 $5 @r{column 5 in the current row (same as @code{E&})}
2507 @@2 @r{current column, row 2}
2508 @@-1$-3 @r{the field one row up, three columns to the left}
2509 @@-I$2 @r{field just under hline above current row, column 2}
2510 @@>$5 @r{field in the last row, in column 5}
2513 @subsubheading Range references
2514 @cindex range references
2515 @cindex references, to ranges
2517 You may reference a rectangular range of fields by specifying two field
2518 references connected by two dots @samp{..}. If both fields are in the
2519 current row, you may simply use @samp{$2..$7}, but if at least one field
2520 is in a different row, you need to use the general @code{@@row$column}
2521 format at least for the first field (i.e the reference must start with
2522 @samp{@@} in order to be interpreted correctly). Examples:
2525 $1..$3 @r{first three fields in the current row}
2526 $P..$Q @r{range, using column names (see under Advanced)}
2527 $<<<..$>> @r{start in third column, continue to the one but last}
2528 @@2$1..@@4$3 @r{6 fields between these two fields (same as @code{A2..C4})}
2529 @@-1$-2..@@-1 @r{3 fields in the row above, starting from 2 columns on the left}
2530 @@I..II @r{between first and second hline, short for @code{@@I..@@II}}
2533 @noindent Range references return a vector of values that can be fed
2534 into Calc vector functions. Empty fields in ranges are normally
2535 suppressed, so that the vector contains only the non-empty fields (but
2536 see the @samp{E} mode switch below). If there are no non-empty fields,
2537 @samp{[0]} is returned to avoid syntax errors in formulas.
2539 @subsubheading Field coordinates in formulas
2540 @cindex field coordinates
2541 @cindex coordinates, of field
2542 @cindex row, of field coordinates
2543 @cindex column, of field coordinates
2545 For Calc formulas and Lisp formulas @code{@@#} and @code{$#} can be used to
2546 get the row or column number of the field where the formula result goes.
2547 The traditional Lisp formula equivalents are @code{org-table-current-dline}
2548 and @code{org-table-current-column}. Examples:
2551 if(@@# % 2, $#, string("")) @r{column number on odd lines only}
2552 $3 = remote(FOO, @@@@#$2) @r{copy column 2 from table FOO into}
2553 @r{column 3 of the current table}
2556 @noindent For the second example, table FOO must have at least as many rows
2557 as the current table. Note that this is inefficient@footnote{The computation time scales as
2558 O(N^2) because table FOO is parsed for each field to be copied.} for large
2561 @subsubheading Named references
2562 @cindex named references
2563 @cindex references, named
2564 @cindex name, of column or field
2565 @cindex constants, in calculations
2568 @vindex org-table-formula-constants
2569 @samp{$name} is interpreted as the name of a column, parameter or
2570 constant. Constants are defined globally through the variable
2571 @code{org-table-formula-constants}, and locally (for the file) through a
2575 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
2579 @vindex constants-unit-system
2580 @pindex constants.el
2581 Also properties (@pxref{Properties and Columns}) can be used as
2582 constants in table formulas: for a property @samp{:Xyz:} use the name
2583 @samp{$PROP_Xyz}, and the property will be searched in the current
2584 outline entry and in the hierarchy above it. If you have the
2585 @file{constants.el} package, it will also be used to resolve constants,
2586 including natural constants like @samp{$h} for Planck's constant, and
2587 units like @samp{$km} for kilometers@footnote{@file{constants.el} can
2588 supply the values of constants in two different unit systems, @code{SI}
2589 and @code{cgs}. Which one is used depends on the value of the variable
2590 @code{constants-unit-system}. You can use the @code{#+STARTUP} options
2591 @code{constSI} and @code{constcgs} to set this value for the current
2592 buffer.}. Column names and parameters can be specified in special table
2593 lines. These are described below, see @ref{Advanced features}. All
2594 names must start with a letter, and further consist of letters and
2597 @subsubheading Remote references
2598 @cindex remote references
2599 @cindex references, remote
2600 @cindex references, to a different table
2601 @cindex name, of column or field
2602 @cindex constants, in calculations
2603 @cindex #+NAME, for table
2605 You may also reference constants, fields and ranges from a different table,
2606 either in the current file or even in a different file. The syntax is
2609 remote(NAME-OR-ID,REF)
2613 where NAME can be the name of a table in the current file as set by a
2614 @code{#+NAME: Name} line before the table. It can also be the ID of an
2615 entry, even in a different file, and the reference then refers to the first
2616 table in that entry. REF is an absolute field or range reference as
2617 described above for example @code{@@3$3} or @code{$somename}, valid in the
2620 @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet
2621 @subsection Formula syntax for Calc
2622 @cindex formula syntax, Calc
2623 @cindex syntax, of formulas
2625 A formula can be any algebraic expression understood by the Emacs
2626 @file{Calc} package. @b{Note that @file{calc} has the
2627 non-standard convention that @samp{/} has lower precedence than
2628 @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.} Before
2629 evaluation by @code{calc-eval} (@pxref{Calling Calc from
2630 Your Programs, calc-eval, Calling Calc from Your Lisp Programs, calc, GNU
2631 Emacs Calc Manual}),
2632 variable substitution takes place according to the rules described above.
2633 @cindex vectors, in table calculations
2634 The range vectors can be directly fed into the Calc vector functions
2635 like @samp{vmean} and @samp{vsum}.
2637 @cindex format specifier
2638 @cindex mode, for @file{calc}
2639 @vindex org-calc-default-modes
2640 A formula can contain an optional mode string after a semicolon. This
2641 string consists of flags to influence Calc and other modes during
2642 execution. By default, Org uses the standard Calc modes (precision
2643 12, angular units degrees, fraction and symbolic modes off). The display
2644 format, however, has been changed to @code{(float 8)} to keep tables
2645 compact. The default settings can be configured using the variable
2646 @code{org-calc-default-modes}.
2649 p20 @r{set the internal Calc calculation precision to 20 digits}
2650 n3 s3 e2 f4 @r{Normal, scientific, engineering, or fixed}
2651 @r{format of the result of Calc passed back to Org.}
2652 @r{Calc formatting is unlimited in precision as}
2653 @r{long as the Calc calculation precision is greater.}
2654 D R @r{angle modes: degrees, radians}
2655 F S @r{fraction and symbolic modes}
2656 E @r{keep empty fields in ranges and use nan (not a number)}
2657 @r{in Calc formulas for empty fields in range references and}
2658 @r{for empty field references; else suppress empty fields in}
2659 @r{range references and use 0 for empty field references, see}
2660 @r{also the notes for `Range references' in @pxref{References}}
2661 N @r{interpret all fields as numbers, use 0 for non-numbers;}
2662 @r{N has higher precedence than E (for the value of the field)}
2663 L @r{literal, for Lisp formulas only}
2667 Unless you use large integer numbers or high-precision-calculation
2668 and -display for floating point numbers you may alternatively provide a
2669 @code{printf} format specifier to reformat the Calc result after it has been
2670 passed back to Org instead of letting Calc already do the
2671 formatting@footnote{The @code{printf} reformatting is limited in precision
2672 because the value passed to it is converted into an @code{integer} or
2673 @code{double}. The @code{integer} is limited in size by truncating the
2674 signed value to 32 bits. The @code{double} is limited in precision to 64
2675 bits overall which leaves approximately 16 significant decimal digits.}.
2679 $1+$2 @r{Sum of first and second field}
2680 $1+$2;%.2f @r{Same, format result to two decimals}
2681 exp($2)+exp($1) @r{Math functions can be used}
2682 $0;%.1f @r{Reformat current cell to 1 decimal}
2683 ($3-32)*5/9 @r{Degrees F -> C conversion}
2684 $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}}
2685 tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1}
2686 sin($1);Dp3%.1e @r{Same, but use printf specifier for display}
2687 vmean($2..$7) @r{Compute column range mean, suppress empty fields}
2688 vmean($2..$7);EN @r{Same, but treat empty fields as 0}
2689 taylor($3,x=7,2) @r{Taylor series of $3, at x=7, second degree}
2692 Calc also contains a complete set of logical operations. For example
2695 if($1 < 20, teen, string(""))
2696 @r{"teen" if age $1 is less than 20, else empty}
2697 if("$1" = "nan" || "$2" = "nan", string(""), $1 + $2); E
2698 @r{sum of first two columns unless one or both empty}
2701 Note that you can also use two org-specific flags @code{T} and @code{t} for
2702 durations computations @ref{Durations and time values}.
2704 You can add your own Calc functions defined in Emacs Lisp with @code{defmath}
2705 and use them in formula syntax for Calc.
2707 @node Formula syntax for Lisp, Durations and time values, Formula syntax for Calc, The spreadsheet
2708 @subsection Emacs Lisp forms as formulas
2709 @cindex Lisp forms, as table formulas
2711 It is also possible to write a formula in Emacs Lisp. This can be useful
2712 for string manipulation and control structures, if Calc's functionality is
2715 If a formula starts with a single-quote followed by an opening parenthesis,
2716 then it is evaluated as a Lisp form. The evaluation should return either a
2717 string or a number. Just as with @file{calc} formulas, you can specify modes
2718 and a printf format after a semicolon.
2720 With Emacs Lisp forms, you need to be conscious about the way field
2721 references are interpolated into the form. By default, a reference will be
2722 interpolated as a Lisp string (in double-quotes) containing the field. If
2723 you provide the @samp{N} mode switch, all referenced elements will be numbers
2724 (non-number fields will be zero) and interpolated as Lisp numbers, without
2725 quotes. If you provide the @samp{L} flag, all fields will be interpolated
2726 literally, without quotes. I.e., if you want a reference to be interpreted
2727 as a string by the Lisp form, enclose the reference operator itself in
2728 double-quotes, like @code{"$3"}. Ranges are inserted as space-separated
2729 fields, so you can embed them in list or vector syntax.
2731 Here are a few examples---note how the @samp{N} mode is used when we do
2732 computations in Lisp:
2735 @r{Swap the first two characters of the content of column 1}
2736 '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
2737 @r{Add columns 1 and 2, equivalent to Calc's @code{$1+$2}}
2739 @r{Compute the sum of columns 1--4, like Calc's @code{vsum($1..$4)}}
2740 '(apply '+ '($1..$4));N
2743 @node Durations and time values, Field and range formulas, Formula syntax for Lisp, The spreadsheet
2744 @subsection Durations and time values
2745 @cindex Duration, computing
2746 @cindex Time, computing
2747 @vindex org-table-duration-custom-format
2749 If you want to compute time values use the @code{T} flag, either in Calc
2750 formulas or Elisp formulas:
2754 | Task 1 | Task 2 | Total |
2755 |---------+----------+----------|
2756 | 2:12 | 1:47 | 03:59:00 |
2757 | 3:02:20 | -2:07:00 | 0.92 |
2758 #+TBLFM: @@2$3=$1+$2;T::@@3$3=$1+$2;t
2762 Input duration values must be of the form @code{[HH:MM[:SS]}, where seconds
2763 are optional. With the @code{T} flag, computed durations will be displayed
2764 as @code{HH:MM:SS} (see the first formula above). With the @code{t} flag,
2765 computed durations will be displayed according to the value of the variable
2766 @code{org-table-duration-custom-format}, which defaults to @code{'hours} and
2767 will display the result as a fraction of hours (see the second formula in the
2770 Negative duration values can be manipulated as well, and integers will be
2771 considered as seconds in addition and subtraction.
2773 @node Field and range formulas, Column formulas, Durations and time values, The spreadsheet
2774 @subsection Field and range formulas
2775 @cindex field formula
2776 @cindex range formula
2777 @cindex formula, for individual table field
2778 @cindex formula, for range of fields
2780 To assign a formula to a particular field, type it directly into the field,
2781 preceded by @samp{:=}, for example @samp{:=vsum(@@II..III)}. When you press
2782 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2783 the formula will be stored as the formula for this field, evaluated, and the
2784 current field will be replaced with the result.
2787 Formulas are stored in a special line starting with @samp{#+TBLFM:} directly
2788 below the table. If you type the equation in the 4th field of the 3rd data
2789 line in the table, the formula will look like @samp{@@3$4=$1+$2}. When
2790 inserting/deleting/swapping column and rows with the appropriate commands,
2791 @i{absolute references} (but not relative ones) in stored formulas are
2792 modified in order to still reference the same field. To avoid this from
2793 happening, in particular in range references, anchor ranges at the table
2794 borders (using @code{@@<}, @code{@@>}, @code{$<}, @code{$>}), or at hlines
2795 using the @code{@@I} notation. Automatic adaptation of field references does
2796 of course not happen if you edit the table structure with normal editing
2797 commands---then you must fix the equations yourself.
2799 Instead of typing an equation into the field, you may also use the following
2803 @orgcmd{C-u C-c =,org-table-eval-formula}
2804 Install a new formula for the current field. The command prompts for a
2805 formula with default taken from the @samp{#+TBLFM:} line, applies
2806 it to the current field, and stores it.
2809 The left-hand side of a formula can also be a special expression in order to
2810 assign the formula to a number of different fields. There is no keyboard
2811 shortcut to enter such range formulas. To add them, use the formula editor
2812 (@pxref{Editing and debugging formulas}) or edit the @code{#+TBLFM:} line
2817 Column formula, valid for the entire column. This is so common that Org
2818 treats these formulas in a special way, see @ref{Column formulas}.
2820 Row formula, applies to all fields in the specified row. @code{@@>=} means
2823 Range formula, applies to all fields in the given rectangular range. This
2824 can also be used to assign a formula to some but not all fields in a row.
2826 Named field, see @ref{Advanced features}.
2829 @node Column formulas, Lookup functions, Field and range formulas, The spreadsheet
2830 @subsection Column formulas
2831 @cindex column formula
2832 @cindex formula, for table column
2834 When you assign a formula to a simple column reference like @code{$3=}, the
2835 same formula will be used in all fields of that column, with the following
2836 very convenient exceptions: (i) If the table contains horizontal separator
2837 hlines with rows above and below, everything before the first such hline is
2838 considered part of the table @emph{header} and will not be modified by column
2839 formulas. Therefore a header is mandatory when you use column formulas and
2840 want to add hlines to group rows, like for example to separate a total row at
2841 the bottom from the summand rows above. (ii) Fields that already get a value
2842 from a field/range formula will be left alone by column formulas. These
2843 conditions make column formulas very easy to use.
2845 To assign a formula to a column, type it directly into any field in the
2846 column, preceded by an equal sign, like @samp{=$1+$2}. When you press
2847 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2848 the formula will be stored as the formula for the current column, evaluated
2849 and the current field replaced with the result. If the field contains only
2850 @samp{=}, the previously stored formula for this column is used. For each
2851 column, Org will only remember the most recently used formula. In the
2852 @samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}. The
2853 left-hand side of a column formula can not be the name of column, it must be
2854 the numeric column reference or @code{$>}.
2856 Instead of typing an equation into the field, you may also use the
2860 @orgcmd{C-c =,org-table-eval-formula}
2861 Install a new formula for the current column and replace current field with
2862 the result of the formula. The command prompts for a formula, with default
2863 taken from the @samp{#+TBLFM} line, applies it to the current field and
2864 stores it. With a numeric prefix argument(e.g., @kbd{C-5 C-c =}) the command
2865 will apply it to that many consecutive fields in the current column.
2868 @node Lookup functions, Editing and debugging formulas, Column formulas, The spreadsheet
2869 @subsection Lookup functions
2870 @cindex lookup functions in tables
2871 @cindex table lookup functions
2873 Org has three predefined Emacs Lisp functions for lookups in tables.
2875 @item (org-lookup-first VAL S-LIST R-LIST &optional PREDICATE)
2876 @findex org-lookup-first
2877 Searches for the first element @code{S} in list @code{S-LIST} for which
2881 is @code{t}; returns the value from the corresponding position in list
2882 @code{R-LIST}. The default @code{PREDICATE} is @code{equal}. Note that the
2883 parameters @code{VAL} and @code{S} are passed to @code{PREDICATE} in the same
2884 order as the corresponding parameters are in the call to
2885 @code{org-lookup-first}, where @code{VAL} precedes @code{S-LIST}. If
2886 @code{R-LIST} is @code{nil}, the matching element @code{S} of @code{S-LIST}
2888 @item (org-lookup-last VAL S-LIST R-LIST &optional PREDICATE)
2889 @findex org-lookup-last
2890 Similar to @code{org-lookup-first} above, but searches for the @i{last}
2891 element for which @code{PREDICATE} is @code{t}.
2892 @item (org-lookup-all VAL S-LIST R-LIST &optional PREDICATE)
2893 @findex org-lookup-all
2894 Similar to @code{org-lookup-first}, but searches for @i{all} elements for
2895 which @code{PREDICATE} is @code{t}, and returns @i{all} corresponding
2896 values. This function can not be used by itself in a formula, because it
2897 returns a list of values. However, powerful lookups can be built when this
2898 function is combined with other Emacs Lisp functions.
2901 If the ranges used in these functions contain empty fields, the @code{E} mode
2902 for the formula should usually be specified: otherwise empty fields will not be
2903 included in @code{S-LIST} and/or @code{R-LIST} which can, for example, result
2904 in an incorrect mapping from an element of @code{S-LIST} to the corresponding
2905 element of @code{R-LIST}.
2907 These three functions can be used to implement associative arrays, count
2908 matching cells, rank results, group data etc. For practical examples
2909 see @uref{http://orgmode.org/worg/org-tutorials/org-lookups.html, this
2912 @node Editing and debugging formulas, Updating the table, Lookup functions, The spreadsheet
2913 @subsection Editing and debugging formulas
2914 @cindex formula editing
2915 @cindex editing, of table formulas
2917 @vindex org-table-use-standard-references
2918 You can edit individual formulas in the minibuffer or directly in the
2919 field. Org can also prepare a special buffer with all active
2920 formulas of a table. When offering a formula for editing, Org
2921 converts references to the standard format (like @code{B3} or @code{D&})
2922 if possible. If you prefer to only work with the internal format (like
2923 @code{@@3$2} or @code{$4}), configure the variable
2924 @code{org-table-use-standard-references}.
2927 @orgcmdkkc{C-c =,C-u C-c =,org-table-eval-formula}
2928 Edit the formula associated with the current column/field in the
2929 minibuffer. See @ref{Column formulas}, and @ref{Field and range formulas}.
2930 @orgcmd{C-u C-u C-c =,org-table-eval-formula}
2931 Re-insert the active formula (either a
2932 field formula, or a column formula) into the current field, so that you
2933 can edit it directly in the field. The advantage over editing in the
2934 minibuffer is that you can use the command @kbd{C-c ?}.
2935 @orgcmd{C-c ?,org-table-field-info}
2936 While editing a formula in a table field, highlight the field(s)
2937 referenced by the reference at the cursor position in the formula.
2939 @findex org-table-toggle-coordinate-overlays
2941 Toggle the display of row and column numbers for a table, using overlays
2942 (@command{org-table-toggle-coordinate-overlays}). These are updated each
2943 time the table is aligned; you can force it with @kbd{C-c C-c}.
2945 @findex org-table-toggle-formula-debugger
2947 Toggle the formula debugger on and off
2948 (@command{org-table-toggle-formula-debugger}). See below.
2949 @orgcmd{C-c ',org-table-edit-formulas}
2950 Edit all formulas for the current table in a special buffer, where the
2951 formulas will be displayed one per line. If the current field has an
2952 active formula, the cursor in the formula editor will mark it.
2953 While inside the special buffer, Org will automatically highlight
2954 any field or range reference at the cursor position. You may edit,
2955 remove and add formulas, and use the following commands:
2958 @orgcmdkkc{C-c C-c,C-x C-s,org-table-fedit-finish}
2959 Exit the formula editor and store the modified formulas. With @kbd{C-u}
2960 prefix, also apply the new formulas to the entire table.
2961 @orgcmd{C-c C-q,org-table-fedit-abort}
2962 Exit the formula editor without installing changes.
2963 @orgcmd{C-c C-r,org-table-fedit-toggle-ref-type}
2964 Toggle all references in the formula editor between standard (like
2965 @code{B3}) and internal (like @code{@@3$2}).
2966 @orgcmd{@key{TAB},org-table-fedit-lisp-indent}
2967 Pretty-print or indent Lisp formula at point. When in a line containing
2968 a Lisp formula, format the formula according to Emacs Lisp rules.
2969 Another @key{TAB} collapses the formula back again. In the open
2970 formula, @key{TAB} re-indents just like in Emacs Lisp mode.
2971 @orgcmd{M-@key{TAB},lisp-complete-symbol}
2972 Complete Lisp symbols, just like in Emacs Lisp mode.
2974 @kindex S-@key{down}
2975 @kindex S-@key{left}
2976 @kindex S-@key{right}
2977 @findex org-table-fedit-ref-up
2978 @findex org-table-fedit-ref-down
2979 @findex org-table-fedit-ref-left
2980 @findex org-table-fedit-ref-right
2981 @item S-@key{up}/@key{down}/@key{left}/@key{right}
2982 Shift the reference at point. For example, if the reference is
2983 @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
2984 This also works for relative references and for hline references.
2985 @orgcmdkkcc{M-S-@key{up},M-S-@key{down},org-table-fedit-line-up,org-table-fedit-line-down}
2986 Move the test line for column formulas in the Org buffer up and
2988 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-fedit-scroll-down,org-table-fedit-scroll-up}
2989 Scroll the window displaying the table.
2991 @findex org-table-toggle-coordinate-overlays
2993 Turn the coordinate grid in the table on and off.
2997 Making a table field blank does not remove the formula associated with
2998 the field, because that is stored in a different line (the @samp{#+TBLFM}
2999 line)---during the next recalculation the field will be filled again.
3000 To remove a formula from a field, you have to give an empty reply when
3001 prompted for the formula, or to edit the @samp{#+TBLFM} line.
3004 You may edit the @samp{#+TBLFM} directly and re-apply the changed
3005 equations with @kbd{C-c C-c} in that line or with the normal
3006 recalculation commands in the table.
3008 @anchor{Using multiple #+TBLFM lines}
3009 @subsubheading Using multiple #+TBLFM lines
3010 @cindex #+TBLFM line, multiple
3012 @cindex #+TBLFM, switching
3015 You may apply the formula temporarily. This is useful when you
3016 switch the formula. Place multiple @samp{#+TBLFM} lines right
3017 after the table, and then press @kbd{C-c C-c} on the formula to
3018 apply. Here is an example:
3030 Pressing @kbd{C-c C-c} in the line of @samp{#+TBLFM: $2=$1*2} yields:
3042 Note: If you recalculate this table (with @kbd{C-u C-c *}, for example), you
3043 will get the following result of applying only the first @samp{#+TBLFM} line.
3054 @subsubheading Debugging formulas
3055 @cindex formula debugging
3056 @cindex debugging, of table formulas
3057 When the evaluation of a formula leads to an error, the field content
3058 becomes the string @samp{#ERROR}. If you would like see what is going
3059 on during variable substitution and calculation in order to find a bug,
3060 turn on formula debugging in the @code{Tbl} menu and repeat the
3061 calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
3062 field. Detailed information will be displayed.
3064 @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet
3065 @subsection Updating the table
3066 @cindex recomputing table fields
3067 @cindex updating, table
3069 Recalculation of a table is normally not automatic, but needs to be
3070 triggered by a command. See @ref{Advanced features}, for a way to make
3071 recalculation at least semi-automatic.
3073 In order to recalculate a line of a table or the entire table, use the
3077 @orgcmd{C-c *,org-table-recalculate}
3078 Recalculate the current row by first applying the stored column formulas
3079 from left to right, and all field/range formulas in the current row.
3085 Recompute the entire table, line by line. Any lines before the first
3086 hline are left alone, assuming that these are part of the table header.
3088 @orgcmdkkc{C-u C-u C-c *,C-u C-u C-c C-c,org-table-iterate}
3089 Iterate the table by recomputing it until no further changes occur.
3090 This may be necessary if some computed fields use the value of other
3091 fields that are computed @i{later} in the calculation sequence.
3092 @item M-x org-table-recalculate-buffer-tables
3093 @findex org-table-recalculate-buffer-tables
3094 Recompute all tables in the current buffer.
3095 @item M-x org-table-iterate-buffer-tables
3096 @findex org-table-iterate-buffer-tables
3097 Iterate all tables in the current buffer, in order to converge table-to-table
3101 @node Advanced features, , Updating the table, The spreadsheet
3102 @subsection Advanced features
3104 If you want the recalculation of fields to happen automatically, or if you
3105 want to be able to assign @i{names}@footnote{Such names must start by an
3106 alphabetic character and use only alphanumeric/underscore characters.} to
3107 fields and columns, you need to reserve the first column of the table for
3108 special marking characters.
3111 @orgcmd{C-#,org-table-rotate-recalc-marks}
3112 Rotate the calculation mark in first column through the states @samp{ },
3113 @samp{#}, @samp{*}, @samp{!}, @samp{$}. When there is an active region,
3114 change all marks in the region.
3117 Here is an example of a table that collects exam results of students and
3118 makes use of these features:
3122 |---+---------+--------+--------+--------+-------+------|
3123 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
3124 |---+---------+--------+--------+--------+-------+------|
3125 | ! | | P1 | P2 | P3 | Tot | |
3126 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
3127 | ^ | | m1 | m2 | m3 | mt | |
3128 |---+---------+--------+--------+--------+-------+------|
3129 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
3130 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
3131 |---+---------+--------+--------+--------+-------+------|
3132 | | Average | | | | 25.0 | |
3133 | ^ | | | | | at | |
3134 | $ | max=50 | | | | | |
3135 |---+---------+--------+--------+--------+-------+------|
3136 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
3140 @noindent @b{Important}: please note that for these special tables,
3141 recalculating the table with @kbd{C-u C-c *} will only affect rows that
3142 are marked @samp{#} or @samp{*}, and fields that have a formula assigned
3143 to the field itself. The column formulas are not applied in rows with
3146 @cindex marking characters, tables
3147 The marking characters have the following meaning:
3151 The fields in this line define names for the columns, so that you may
3152 refer to a column as @samp{$Tot} instead of @samp{$6}.
3154 This row defines names for the fields @emph{above} the row. With such
3155 a definition, any formula in the table may use @samp{$m1} to refer to
3156 the value @samp{10}. Also, if you assign a formula to a names field, it
3157 will be stored as @samp{$name=...}.
3159 Similar to @samp{^}, but defines names for the fields in the row
3162 Fields in this row can define @emph{parameters} for formulas. For
3163 example, if a field in a @samp{$} row contains @samp{max=50}, then
3164 formulas in this table can refer to the value 50 using @samp{$max}.
3165 Parameters work exactly like constants, only that they can be defined on
3168 Fields in this row are automatically recalculated when pressing
3169 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row
3170 is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked
3171 lines will be left alone by this command.
3173 Selects this line for global recalculation with @kbd{C-u C-c *}, but
3174 not for automatic recalculation. Use this when automatic
3175 recalculation slows down editing too much.
3177 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
3178 All lines that should be recalculated should be marked with @samp{#}
3181 Do not export this line. Useful for lines that contain the narrowing
3182 @samp{<N>} markers or column group markers.
3185 Finally, just to whet your appetite for what can be done with the
3186 fantastic @file{calc.el} package, here is a table that computes the Taylor
3187 series of degree @code{n} at location @code{x} for a couple of
3192 |---+-------------+---+-----+--------------------------------------|
3193 | | Func | n | x | Result |
3194 |---+-------------+---+-----+--------------------------------------|
3195 | # | exp(x) | 1 | x | 1 + x |
3196 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
3197 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
3198 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
3199 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
3200 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
3201 |---+-------------+---+-----+--------------------------------------|
3202 #+TBLFM: $5=taylor($2,$4,$3);n3
3206 @node Org-Plot, , The spreadsheet, Tables
3208 @cindex graph, in tables
3209 @cindex plot tables using Gnuplot
3212 Org-Plot can produce 2D and 3D graphs of information stored in org tables
3213 using @file{Gnuplot} @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
3214 @uref{http://xafs.org/BruceRavel/GnuplotMode}. To see this in action, ensure
3215 that you have both Gnuplot and Gnuplot mode installed on your system, then
3216 call @code{org-plot/gnuplot} on the following table.
3220 #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
3221 | Sede | Max cites | H-index |
3222 |-----------+-----------+---------|
3223 | Chile | 257.72 | 21.39 |
3224 | Leeds | 165.77 | 19.68 |
3225 | Sao Paolo | 71.00 | 11.50 |
3226 | Stockholm | 134.19 | 14.33 |
3227 | Morelia | 257.56 | 17.67 |
3231 Notice that Org Plot is smart enough to apply the table's headers as labels.
3232 Further control over the labels, type, content, and appearance of plots can
3233 be exercised through the @code{#+PLOT:} lines preceding a table. See below
3234 for a complete list of Org-plot options. For more information and examples
3235 see the Org-plot tutorial at
3236 @uref{http://orgmode.org/worg/org-tutorials/org-plot.html}.
3238 @subsubheading Plot Options
3242 Specify any @command{gnuplot} option to be set when graphing.
3245 Specify the title of the plot.
3248 Specify which column of the table to use as the @code{x} axis.
3251 Specify the columns to graph as a Lisp style list, surrounded by parentheses
3252 and separated by spaces for example @code{dep:(3 4)} to graph the third and
3253 fourth columns (defaults to graphing all other columns aside from the @code{ind}
3257 Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
3260 Specify a @code{with} option to be inserted for every col being plotted
3261 (e.g., @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
3262 Defaults to @code{lines}.
3265 If you want to plot to a file, specify @code{"@var{path/to/desired/output-file}"}.
3268 List of labels to be used for the @code{deps} (defaults to the column headers
3272 Specify an entire line to be inserted in the Gnuplot script.
3275 When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
3276 flat mapping rather than a @code{3d} slope.
3279 Specify format of Org mode timestamps as they will be parsed by Gnuplot.
3280 Defaults to @samp{%Y-%m-%d-%H:%M:%S}.
3283 If you want total control, you can specify a script file (place the file name
3284 between double-quotes) which will be used to plot. Before plotting, every
3285 instance of @code{$datafile} in the specified script will be replaced with
3286 the path to the generated data file. Note: even if you set this option, you
3287 may still want to specify the plot type, as that can impact the content of
3291 @node Hyperlinks, TODO Items, Tables, Top
3295 Like HTML, Org provides links inside a file, external links to
3296 other files, Usenet articles, emails, and much more.
3299 * Link format:: How links in Org are formatted
3300 * Internal links:: Links to other places in the current file
3301 * External links:: URL-like links to the world
3302 * Handling links:: Creating, inserting and following
3303 * Using links outside Org:: Linking from my C source code?
3304 * Link abbreviations:: Shortcuts for writing complex links
3305 * Search options:: Linking to a specific location
3306 * Custom searches:: When the default search is not enough
3309 @node Link format, Internal links, Hyperlinks, Hyperlinks
3310 @section Link format
3312 @cindex format, of links
3314 Org will recognize plain URL-like links and activate them as
3315 clickable links. The general link format, however, looks like this:
3318 [[link][description]] @r{or alternatively} [[link]]
3322 Once a link in the buffer is complete (all brackets present), Org
3323 will change the display so that @samp{description} is displayed instead
3324 of @samp{[[link][description]]} and @samp{link} is displayed instead of
3325 @samp{[[link]]}. Links will be highlighted in the face @code{org-link},
3326 which by default is an underlined face. You can directly edit the
3327 visible part of a link. Note that this can be either the @samp{link}
3328 part (if there is no description) or the @samp{description} part. To
3329 edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
3332 If you place the cursor at the beginning or just behind the end of the
3333 displayed text and press @key{BACKSPACE}, you will remove the
3334 (invisible) bracket at that location. This makes the link incomplete
3335 and the internals are again displayed as plain text. Inserting the
3336 missing bracket hides the link internals again. To show the
3337 internal structure of all links, use the menu entry
3338 @code{Org->Hyperlinks->Literal links}.
3340 @node Internal links, External links, Link format, Hyperlinks
3341 @section Internal links
3342 @cindex internal links
3343 @cindex links, internal
3344 @cindex targets, for links
3346 @cindex property, CUSTOM_ID
3347 If the link does not look like a URL, it is considered to be internal in the
3348 current file. The most important case is a link like
3349 @samp{[[#my-custom-id]]} which will link to the entry with the
3350 @code{CUSTOM_ID} property @samp{my-custom-id}. You are responsible yourself
3351 to make sure these custom IDs are unique in a file.
3353 Links such as @samp{[[My Target]]} or @samp{[[My Target][Find my target]]}
3354 lead to a text search in the current file.
3356 The link can be followed with @kbd{C-c C-o} when the cursor is on the link,
3357 or with a mouse click (@pxref{Handling links}). Links to custom IDs will
3358 point to the corresponding headline. The preferred match for a text link is
3359 a @i{dedicated target}: the same string in double angular brackets, like
3360 @samp{<<My Target>>}.
3363 If no dedicated target exists, the link will then try to match the exact name
3364 of an element within the buffer. Naming is done with the @code{#+NAME}
3365 keyword, which has to be put the line before the element it refers to, as in
3366 the following example
3375 If none of the above succeeds, Org will search for a headline that is exactly
3376 the link text but may also include a TODO keyword and tags@footnote{To insert
3377 a link targeting a headline, in-buffer completion can be used. Just type
3378 a star followed by a few optional letters into the buffer and press
3379 @kbd{M-@key{TAB}}. All headlines in the current buffer will be offered as
3382 During export, internal links will be used to mark objects and assign them
3383 a number. Marked objects will then be referenced by links pointing to them.
3384 In particular, links without a description will appear as the number assigned
3385 to the marked object@footnote{When targeting a @code{#+NAME} keyword,
3386 @code{#+CAPTION} keyword is mandatory in order to get proper numbering
3387 (@pxref{Images and tables}).}. In the following excerpt from an Org buffer
3391 - <<target>>another item
3392 Here we refer to item [[target]].
3396 The last sentence will appear as @samp{Here we refer to item 2} when
3399 In non-Org files, the search will look for the words in the link text. In
3400 the above example the search would be for @samp{my target}.
3402 Following a link pushes a mark onto Org's own mark ring. You can
3403 return to the previous position with @kbd{C-c &}. Using this command
3404 several times in direct succession goes back to positions recorded
3408 * Radio targets:: Make targets trigger links in plain text
3411 @node Radio targets, , Internal links, Internal links
3412 @subsection Radio targets
3413 @cindex radio targets
3414 @cindex targets, radio
3415 @cindex links, radio targets
3417 Org can automatically turn any occurrences of certain target names
3418 in normal text into a link. So without explicitly creating a link, the
3419 text connects to the target radioing its position. Radio targets are
3420 enclosed by triple angular brackets. For example, a target @samp{<<<My
3421 Target>>>} causes each occurrence of @samp{my target} in normal text to
3422 become activated as a link. The Org file is scanned automatically
3423 for radio targets only when the file is first loaded into Emacs. To
3424 update the target list during editing, press @kbd{C-c C-c} with the
3425 cursor on or at a target.
3427 @node External links, Handling links, Internal links, Hyperlinks
3428 @section External links
3429 @cindex links, external
3430 @cindex external links
3431 @cindex links, external
3439 @cindex WANDERLUST links
3441 @cindex USENET links
3446 Org supports links to files, websites, Usenet and email messages,
3447 BBDB database entries and links to both IRC conversations and their
3448 logs. External links are URL-like locators. They start with a short
3449 identifying string followed by a colon. There can be no space after
3450 the colon. The following list shows examples for each link type.
3453 http://www.astro.uva.nl/~dominik @r{on the web}
3454 doi:10.1000/182 @r{DOI for an electronic resource}
3455 file:/home/dominik/images/jupiter.jpg @r{file, absolute path}
3456 /home/dominik/images/jupiter.jpg @r{same as above}
3457 file:papers/last.pdf @r{file, relative path}
3458 ./papers/last.pdf @r{same as above}
3459 file:/myself@@some.where:papers/last.pdf @r{file, path on remote machine}
3460 /myself@@some.where:papers/last.pdf @r{same as above}
3461 file:sometextfile::NNN @r{file, jump to line number}
3462 file:projects.org @r{another Org file}
3463 file:projects.org::some words @r{text search in Org file}@footnote{
3464 The actual behavior of the search will depend on the value of
3465 the variable @code{org-link-search-must-match-exact-headline}. If its value
3466 is nil, then a fuzzy text search will be done. If it is t, then only the
3467 exact headline will be matched. If the value is @code{'query-to-create},
3468 then an exact headline will be searched; if it is not found, then the user
3469 will be queried to create it.}
3470 file:projects.org::*task title @r{heading search in Org file}
3471 file+sys:/path/to/file @r{open via OS, like double-click}
3472 file+emacs:/path/to/file @r{force opening by Emacs}
3473 docview:papers/last.pdf::NNN @r{open in doc-view mode at page}
3474 id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID}
3475 news:comp.emacs @r{Usenet link}
3476 mailto:adent@@galaxy.net @r{Mail link}
3477 vm:folder @r{VM folder link}
3478 vm:folder#id @r{VM message link}
3479 vm://myself@@some.where.org/folder#id @r{VM on remote machine}
3480 vm-imap:account:folder @r{VM IMAP folder link}
3481 vm-imap:account:folder#id @r{VM IMAP message link}
3482 wl:folder @r{WANDERLUST folder link}
3483 wl:folder#id @r{WANDERLUST message link}
3484 mhe:folder @r{MH-E folder link}
3485 mhe:folder#id @r{MH-E message link}
3486 rmail:folder @r{RMAIL folder link}
3487 rmail:folder#id @r{RMAIL message link}
3488 gnus:group @r{Gnus group link}
3489 gnus:group#id @r{Gnus article link}
3490 bbdb:R.*Stallman @r{BBDB link (with regexp)}
3491 irc:/irc.com/#emacs/bob @r{IRC link}
3492 info:org#External links @r{Info node link}
3493 shell:ls *.org @r{A shell command}
3494 elisp:org-agenda @r{Interactive Elisp command}
3495 elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
3498 For customizing Org to add new link types @ref{Adding hyperlink types}.
3500 A link should be enclosed in double brackets and may contain a
3501 descriptive text to be displayed instead of the URL (@pxref{Link
3502 format}), for example:
3505 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
3509 If the description is a file name or URL that points to an image, HTML
3510 export (@pxref{HTML export}) will inline the image as a clickable
3511 button. If there is no description at all and the link points to an
3513 that image will be inlined into the exported HTML file.
3515 @cindex square brackets, around links
3516 @cindex plain text external links
3517 Org also finds external links in the normal text and activates them
3518 as links. If spaces must be part of the link (for example in
3519 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
3520 about the end of the link, enclose them in square brackets.
3522 @node Handling links, Using links outside Org, External links, Hyperlinks
3523 @section Handling links
3524 @cindex links, handling
3526 Org provides methods to create a link in the correct syntax, to
3527 insert it into an Org file, and to follow the link.
3530 @orgcmd{C-c l,org-store-link}
3531 @cindex storing links
3532 Store a link to the current location. This is a @emph{global} command (you
3533 must create the key binding yourself) which can be used in any buffer to
3534 create a link. The link will be stored for later insertion into an Org
3535 buffer (see below). What kind of link will be created depends on the current
3538 @b{Org mode buffers}@*
3539 For Org files, if there is a @samp{<<target>>} at the cursor, the link points
3540 to the target. Otherwise it points to the current headline, which will also
3541 be the description@footnote{If the headline contains a timestamp, it will be
3542 removed from the link and result in a wrong link---you should avoid putting
3543 timestamp in the headline.}.
3545 @vindex org-id-link-to-org-use-id
3546 @cindex property, CUSTOM_ID
3547 @cindex property, ID
3548 If the headline has a @code{CUSTOM_ID} property, a link to this custom ID
3549 will be stored. In addition or alternatively (depending on the value of
3550 @code{org-id-link-to-org-use-id}), a globally unique @code{ID} property will
3551 be created and/or used to construct a link@footnote{The library @code{org-id}
3552 must first be loaded, either through @code{org-customize} by enabling
3553 @code{id} in @code{org-modules} , or by adding @code{(require 'org-id)} in
3554 your @file{.emacs}.}. So using this command in Org
3555 buffers will potentially create two links: a human-readable from the custom
3556 ID, and one that is globally unique and works even if the entry is moved from
3557 file to file. Later, when inserting the link, you need to decide which one
3560 @b{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus}@*
3561 Pretty much all Emacs mail clients are supported. The link will point to the
3562 current article, or, in some GNUS buffers, to the group. The description is
3563 constructed from the author and the subject.
3565 @b{Web browsers: W3 and W3M}@*
3566 Here the link will be the current URL, with the page title as description.
3568 @b{Contacts: BBDB}@*
3569 Links created in a BBDB buffer will point to the current entry.
3572 @vindex org-irc-link-to-logs
3573 For IRC links, if you set the variable @code{org-irc-link-to-logs} to
3574 @code{t}, a @samp{file:/} style link to the relevant point in the logs for
3575 the current conversation is created. Otherwise an @samp{irc:/} style link to
3576 the user/channel/server under the point will be stored.
3579 For any other files, the link will point to the file, with a search string
3580 (@pxref{Search options}) pointing to the contents of the current line. If
3581 there is an active region, the selected words will form the basis of the
3582 search string. If the automatically created link is not working correctly or
3583 accurately enough, you can write custom functions to select the search string
3584 and to do the search for particular file types---see @ref{Custom searches}.
3585 The key binding @kbd{C-c l} is only a suggestion---see @ref{Installation}.
3588 When the cursor is in an agenda view, the created link points to the
3589 entry referenced by the current line.
3592 @orgcmd{C-c C-l,org-insert-link}
3593 @cindex link completion
3594 @cindex completion, of links
3595 @cindex inserting links
3596 @vindex org-keep-stored-link-after-insertion
3597 Insert a link@footnote{ Note that you don't have to use this command to
3598 insert a link. Links in Org are plain text, and you can type or paste them
3599 straight into the buffer. By using this command, the links are automatically
3600 enclosed in double brackets, and you will be asked for the optional
3601 descriptive text.}. This prompts for a link to be inserted into the buffer.
3602 You can just type a link, using text for an internal link, or one of the link
3603 type prefixes mentioned in the examples above. The link will be inserted
3604 into the buffer@footnote{After insertion of a stored link, the link will be
3605 removed from the list of stored links. To keep it in the list later use, use
3606 a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
3607 @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
3608 If some text was selected when this command is called, the selected text
3609 becomes the default description.
3611 @b{Inserting stored links}@*
3612 All links stored during the
3613 current session are part of the history for this prompt, so you can access
3614 them with @key{up} and @key{down} (or @kbd{M-p/n}).
3616 @b{Completion support}@* Completion with @key{TAB} will help you to insert
3617 valid link prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
3618 defined through link abbreviations (@pxref{Link abbreviations}). If you
3619 press @key{RET} after inserting only the @var{prefix}, Org will offer
3620 specific completion support for some link types@footnote{This works by
3621 calling a special function @code{org-PREFIX-complete-link}.} For
3622 example, if you type @kbd{file @key{RET}}, file name completion (alternative
3623 access: @kbd{C-u C-c C-l}, see below) will be offered, and after @kbd{bbdb
3624 @key{RET}} you can complete contact names.
3626 @cindex file name completion
3627 @cindex completion, of file names
3628 When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
3629 a file will be inserted and you may use file name completion to select
3630 the name of the file. The path to the file is inserted relative to the
3631 directory of the current Org file, if the linked file is in the current
3632 directory or in a sub-directory of it, or if the path is written relative
3633 to the current directory using @samp{../}. Otherwise an absolute path
3634 is used, if possible with @samp{~/} for your home directory. You can
3635 force an absolute path with two @kbd{C-u} prefixes.
3637 @item C-c C-l @ @r{(with cursor on existing link)}
3638 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
3639 link and description parts of the link.
3641 @cindex following links
3642 @orgcmd{C-c C-o,org-open-at-point}
3643 @vindex org-file-apps
3644 @vindex org-link-frame-setup
3645 Open link at point. This will launch a web browser for URLs (using
3646 @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
3647 the corresponding links, and execute the command in a shell link. When the
3648 cursor is on an internal link, this command runs the corresponding search.
3649 When the cursor is on a TAG list in a headline, it creates the corresponding
3650 TAGS view. If the cursor is on a timestamp, it compiles the agenda for that
3651 date. Furthermore, it will visit text and remote files in @samp{file:} links
3652 with Emacs and select a suitable application for local non-text files.
3653 Classification of files is based on file extension only. See option
3654 @code{org-file-apps}. If you want to override the default application and
3655 visit the file with Emacs, use a @kbd{C-u} prefix. If you want to avoid
3656 opening in Emacs, use a @kbd{C-u C-u} prefix.@*
3657 If the cursor is on a headline, but not on a link, offer all links in the
3658 headline and entry text. If you want to setup the frame configuration for
3659 following links, customize @code{org-link-frame-setup}.
3662 @vindex org-return-follows-link
3663 When @code{org-return-follows-link} is set, @kbd{@key{RET}} will also follow
3670 On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
3671 would. Under Emacs 22 and later, @kbd{mouse-1} will also follow a link.
3675 @vindex org-display-internal-link-with-indirect-buffer
3676 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
3677 internal links to be displayed in another window@footnote{See the
3678 variable @code{org-display-internal-link-with-indirect-buffer}}.
3680 @orgcmd{C-c C-x C-v,org-toggle-inline-images}
3681 @cindex inlining images
3682 @cindex images, inlining
3683 @vindex org-startup-with-inline-images
3684 @cindex @code{inlineimages}, STARTUP keyword
3685 @cindex @code{noinlineimages}, STARTUP keyword
3686 Toggle the inline display of linked images. Normally this will only inline
3687 images that have no description part in the link, i.e., images that will also
3688 be inlined during export. When called with a prefix argument, also display
3689 images that do have a link description. You can ask for inline images to be
3690 displayed at startup by configuring the variable
3691 @code{org-startup-with-inline-images}@footnote{with corresponding
3692 @code{#+STARTUP} keywords @code{inlineimages} and @code{inlineimages}}.
3693 @orgcmd{C-c %,org-mark-ring-push}
3695 Push the current position onto the mark ring, to be able to return
3696 easily. Commands following an internal link do this automatically.
3698 @orgcmd{C-c &,org-mark-ring-goto}
3699 @cindex links, returning to
3700 Jump back to a recorded position. A position is recorded by the
3701 commands following internal links, and by @kbd{C-c %}. Using this
3702 command several times in direct succession moves through a ring of
3703 previously recorded positions.
3705 @orgcmdkkcc{C-c C-x C-n,C-c C-x C-p,org-next-link,org-previous-link}
3706 @cindex links, finding next/previous
3707 Move forward/backward to the next link in the buffer. At the limit of
3708 the buffer, the search fails once, and then wraps around. The key
3709 bindings for this are really too long; you might want to bind this also
3710 to @kbd{C-n} and @kbd{C-p}
3712 (add-hook 'org-load-hook
3714 (define-key org-mode-map "\C-n" 'org-next-link)
3715 (define-key org-mode-map "\C-p" 'org-previous-link)))
3719 @node Using links outside Org, Link abbreviations, Handling links, Hyperlinks
3720 @section Using links outside Org
3722 You can insert and follow links that have Org syntax not only in
3723 Org, but in any Emacs buffer. For this, you should create two
3724 global commands, like this (please select suitable global keys
3728 (global-set-key "\C-c L" 'org-insert-link-global)
3729 (global-set-key "\C-c o" 'org-open-at-point-global)
3732 @node Link abbreviations, Search options, Using links outside Org, Hyperlinks
3733 @section Link abbreviations
3734 @cindex link abbreviations
3735 @cindex abbreviation, links
3737 Long URLs can be cumbersome to type, and often many similar links are
3738 needed in a document. For this you can use link abbreviations. An
3739 abbreviated link looks like this
3742 [[linkword:tag][description]]
3746 @vindex org-link-abbrev-alist
3747 where the tag is optional.
3748 The @i{linkword} must be a word, starting with a letter, followed by
3749 letters, numbers, @samp{-}, and @samp{_}. Abbreviations are resolved
3750 according to the information in the variable @code{org-link-abbrev-alist}
3751 that relates the linkwords to replacement text. Here is an example:
3755 (setq org-link-abbrev-alist
3756 '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
3757 ("url-to-ja" . "http://translate.google.fr/translate?sl=en&tl=ja&u=%h")
3758 ("google" . "http://www.google.com/search?q=")
3759 ("gmap" . "http://maps.google.com/maps?q=%s")
3760 ("omap" . "http://nominatim.openstreetmap.org/search?q=%s&polygon=1")
3761 ("ads" . "http://adsabs.harvard.edu/cgi-bin/nph-abs_connect?author=%s&db_key=AST")))
3765 If the replacement text contains the string @samp{%s}, it will be
3766 replaced with the tag. Using @samp{%h} instead of @samp{%s} will
3767 url-encode the tag (see the example above, where we need to encode
3768 the URL parameter.) Using @samp{%(my-function)} will pass the tag
3769 to a custom function, and replace it by the resulting string.
3771 If the replacement text don't contain any specifier, it will simply
3772 be appended to the string in order to create the link.
3774 Instead of a string, you may also specify a function that will be
3775 called with the tag as the only argument to create the link.
3777 With the above setting, you could link to a specific bug with
3778 @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
3779 @code{[[google:OrgMode]]}, show the map location of the Free Software
3780 Foundation @code{[[gmap:51 Franklin Street, Boston]]} or of Carsten office
3781 @code{[[omap:Science Park 904, Amsterdam, The Netherlands]]} and find out
3782 what the Org author is doing besides Emacs hacking with
3783 @code{[[ads:Dominik,C]]}.
3785 If you need special abbreviations just for a single Org buffer, you
3786 can define them in the file with
3790 #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
3791 #+LINK: google http://www.google.com/search?q=%s
3795 In-buffer completion (@pxref{Completion}) can be used after @samp{[} to
3796 complete link abbreviations. You may also define a function
3797 @code{org-PREFIX-complete-link} that implements special (e.g., completion)
3798 support for inserting such a link with @kbd{C-c C-l}. Such a function should
3799 not accept any arguments, and return the full link with prefix.
3801 @node Search options, Custom searches, Link abbreviations, Hyperlinks
3802 @section Search options in file links
3803 @cindex search option in file links
3804 @cindex file links, searching
3806 File links can contain additional information to make Emacs jump to a
3807 particular location in the file when following a link. This can be a
3808 line number or a search option after a double@footnote{For backward
3809 compatibility, line numbers can also follow a single colon.} colon. For
3810 example, when the command @kbd{C-c l} creates a link (@pxref{Handling
3811 links}) to a file, it encodes the words in the current line as a search
3812 string that can be used to find this line back later when following the
3813 link with @kbd{C-c C-o}.
3815 Here is the syntax of the different ways to attach a search to a file
3816 link, together with an explanation:
3819 [[file:~/code/main.c::255]]
3820 [[file:~/xx.org::My Target]]
3821 [[file:~/xx.org::*My Target]]
3822 [[file:~/xx.org::#my-custom-id]]
3823 [[file:~/xx.org::/regexp/]]
3830 Search for a link target @samp{<<My Target>>}, or do a text search for
3831 @samp{my target}, similar to the search in internal links, see
3832 @ref{Internal links}. In HTML export (@pxref{HTML export}), such a file
3833 link will become a HTML reference to the corresponding named anchor in
3836 In an Org file, restrict search to headlines.
3838 Link to a heading with a @code{CUSTOM_ID} property
3840 Do a regular expression search for @code{regexp}. This uses the Emacs
3841 command @code{occur} to list all matches in a separate window. If the
3842 target file is in Org mode, @code{org-occur} is used to create a
3843 sparse tree with the matches.
3844 @c If the target file is a directory,
3845 @c @code{grep} will be used to search all files in the directory.
3848 As a degenerate case, a file link with an empty file name can be used
3849 to search the current file. For example, @code{[[file:::find me]]} does
3850 a search for @samp{find me} in the current file, just as
3851 @samp{[[find me]]} would.
3853 @node Custom searches, , Search options, Hyperlinks
3854 @section Custom Searches
3855 @cindex custom search strings
3856 @cindex search strings, custom
3858 The default mechanism for creating search strings and for doing the
3859 actual search related to a file link may not work correctly in all
3860 cases. For example, Bib@TeX{} database files have many entries like
3861 @samp{year="1993"} which would not result in good search strings,
3862 because the only unique identification for a Bib@TeX{} entry is the
3865 @vindex org-create-file-search-functions
3866 @vindex org-execute-file-search-functions
3867 If you come across such a problem, you can write custom functions to set
3868 the right search string for a particular file type, and to do the search
3869 for the string in the file. Using @code{add-hook}, these functions need
3870 to be added to the hook variables
3871 @code{org-create-file-search-functions} and
3872 @code{org-execute-file-search-functions}. See the docstring for these
3873 variables for more information. Org actually uses this mechanism
3874 for Bib@TeX{} database files, and you can use the corresponding code as
3875 an implementation example. See the file @file{org-bibtex.el}.
3877 @node TODO Items, Tags, Hyperlinks, Top
3881 Org mode does not maintain TODO lists as separate documents@footnote{Of
3882 course, you can make a document that contains only long lists of TODO items,
3883 but this is not required.}. Instead, TODO items are an integral part of the
3884 notes file, because TODO items usually come up while taking notes! With Org
3885 mode, simply mark any entry in a tree as being a TODO item. In this way,
3886 information is not duplicated, and the entire context from which the TODO
3887 item emerged is always present.
3889 Of course, this technique for managing TODO items scatters them
3890 throughout your notes file. Org mode compensates for this by providing
3891 methods to give you an overview of all the things that you have to do.
3894 * TODO basics:: Marking and displaying TODO entries
3895 * TODO extensions:: Workflow and assignments
3896 * Progress logging:: Dates and notes for progress
3897 * Priorities:: Some things are more important than others
3898 * Breaking down tasks:: Splitting a task into manageable pieces
3899 * Checkboxes:: Tick-off lists
3902 @node TODO basics, TODO extensions, TODO Items, TODO Items
3903 @section Basic TODO functionality
3905 Any headline becomes a TODO item when it starts with the word
3906 @samp{TODO}, for example:
3909 *** TODO Write letter to Sam Fortune
3913 The most important commands to work with TODO entries are:
3916 @orgcmd{C-c C-t,org-todo}
3917 @cindex cycling, of TODO states
3918 @vindex org-use-fast-todo-selection
3920 Rotate the TODO state of the current item among
3923 ,-> (unmarked) -> TODO -> DONE --.
3924 '--------------------------------'
3927 If TODO keywords have fast access keys (see @ref{Fast access to TODO
3928 states}), you will be prompted for a TODO keyword through the fast selection
3929 interface; this is the default behavior when
3930 @var{org-use-fast-todo-selection} is non-nil.
3932 The same rotation can also be done ``remotely'' from the timeline and agenda
3933 buffers with the @kbd{t} command key (@pxref{Agenda commands}).
3935 @orgkey{C-u C-c C-t}
3936 When TODO keywords have no selection keys, select a specific keyword using
3937 completion; otherwise force cycling through TODO states with no prompt. When
3938 @var{org-use-fast-todo-selection} is set to @code{prefix}, use the fast
3939 selection interface.
3941 @kindex S-@key{right}
3942 @kindex S-@key{left}
3943 @item S-@key{right} @ @r{/} @ S-@key{left}
3944 @vindex org-treat-S-cursor-todo-selection-as-state-change
3945 Select the following/preceding TODO state, similar to cycling. Useful
3946 mostly if more than two TODO states are possible (@pxref{TODO
3947 extensions}). See also @ref{Conflicts}, for a discussion of the interaction
3948 with @code{shift-selection-mode}. See also the variable
3949 @code{org-treat-S-cursor-todo-selection-as-state-change}.
3950 @orgcmd{C-c / t,org-show-todo-tree}
3951 @cindex sparse tree, for TODO
3952 @vindex org-todo-keywords
3953 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds the
3954 entire buffer, but shows all TODO items (with not-DONE state) and the
3955 headings hierarchy above them. With a prefix argument (or by using @kbd{C-c
3956 / T}), search for a specific TODO@. You will be prompted for the keyword, and
3957 you can also give a list of keywords like @code{KWD1|KWD2|...} to list
3958 entries that match any one of these keywords. With a numeric prefix argument
3959 N, show the tree for the Nth keyword in the variable
3960 @code{org-todo-keywords}. With two prefix arguments, find all TODO states,
3961 both un-done and done.
3962 @orgcmd{C-c a t,org-todo-list}
3963 Show the global TODO list. Collects the TODO items (with not-DONE states)
3964 from all agenda files (@pxref{Agenda Views}) into a single buffer. The new
3965 buffer will be in @code{agenda-mode}, which provides commands to examine and
3966 manipulate the TODO entries from the new buffer (@pxref{Agenda commands}).
3967 @xref{Global TODO list}, for more information.
3968 @orgcmd{S-M-@key{RET},org-insert-todo-heading}
3969 Insert a new TODO entry below the current one.
3973 @vindex org-todo-state-tags-triggers
3974 Changing a TODO state can also trigger tag changes. See the docstring of the
3975 option @code{org-todo-state-tags-triggers} for details.
3977 @node TODO extensions, Progress logging, TODO basics, TODO Items
3978 @section Extended use of TODO keywords
3979 @cindex extended TODO keywords
3981 @vindex org-todo-keywords
3982 By default, marked TODO entries have one of only two states: TODO and
3983 DONE@. Org mode allows you to classify TODO items in more complex ways
3984 with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With
3985 special setup, the TODO keyword system can work differently in different
3988 Note that @i{tags} are another way to classify headlines in general and
3989 TODO items in particular (@pxref{Tags}).
3992 * Workflow states:: From TODO to DONE in steps
3993 * TODO types:: I do this, Fred does the rest
3994 * Multiple sets in one file:: Mixing it all, and still finding your way
3995 * Fast access to TODO states:: Single letter selection of a state
3996 * Per-file keywords:: Different files, different requirements
3997 * Faces for TODO keywords:: Highlighting states
3998 * TODO dependencies:: When one task needs to wait for others
4001 @node Workflow states, TODO types, TODO extensions, TODO extensions
4002 @subsection TODO keywords as workflow states
4003 @cindex TODO workflow
4004 @cindex workflow states as TODO keywords
4006 You can use TODO keywords to indicate different @emph{sequential} states
4007 in the process of working on an item, for example@footnote{Changing
4008 this variable only becomes effective after restarting Org mode in a
4012 (setq org-todo-keywords
4013 '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
4016 The vertical bar separates the TODO keywords (states that @emph{need
4017 action}) from the DONE states (which need @emph{no further action}). If
4018 you don't provide the separator bar, the last state is used as the DONE
4020 @cindex completion, of TODO keywords
4021 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
4022 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED@. You may
4023 also use a numeric prefix argument to quickly select a specific state. For
4024 example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY@.
4025 Or you can use @kbd{S-@key{left}} to go backward through the sequence. If you
4026 define many keywords, you can use in-buffer completion
4027 (@pxref{Completion}) or even a special one-key selection scheme
4028 (@pxref{Fast access to TODO states}) to insert these words into the
4029 buffer. Changing a TODO state can be logged with a timestamp, see
4030 @ref{Tracking TODO state changes}, for more information.
4032 @node TODO types, Multiple sets in one file, Workflow states, TODO extensions
4033 @subsection TODO keywords as types
4035 @cindex names as TODO keywords
4036 @cindex types as TODO keywords
4038 The second possibility is to use TODO keywords to indicate different
4039 @emph{types} of action items. For example, you might want to indicate
4040 that items are for ``work'' or ``home''. Or, when you work with several
4041 people on a single project, you might want to assign action items
4042 directly to persons, by using their names as TODO keywords. This would
4043 be set up like this:
4046 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
4049 In this case, different keywords do not indicate a sequence, but rather
4050 different types. So the normal work flow would be to assign a task to a
4051 person, and later to mark it DONE@. Org mode supports this style by adapting
4052 the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
4053 @kbd{t} command in the timeline and agenda buffers.}. When used several
4054 times in succession, it will still cycle through all names, in order to first
4055 select the right type for a task. But when you return to the item after some
4056 time and execute @kbd{C-c C-t} again, it will switch from any name directly
4057 to DONE@. Use prefix arguments or completion to quickly select a specific
4058 name. You can also review the items of a specific TODO type in a sparse tree
4059 by using a numeric prefix to @kbd{C-c / t}. For example, to see all things
4060 Lucy has to do, you would use @kbd{C-3 C-c / t}. To collect Lucy's items
4061 from all agenda files into a single buffer, you would use the numeric prefix
4062 argument as well when creating the global TODO list: @kbd{C-3 C-c a t}.
4064 @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions
4065 @subsection Multiple keyword sets in one file
4066 @cindex TODO keyword sets
4068 Sometimes you may want to use different sets of TODO keywords in
4069 parallel. For example, you may want to have the basic
4070 @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
4071 separate state indicating that an item has been canceled (so it is not
4072 DONE, but also does not require action). Your setup would then look
4076 (setq org-todo-keywords
4077 '((sequence "TODO" "|" "DONE")
4078 (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
4079 (sequence "|" "CANCELED")))
4082 The keywords should all be different, this helps Org mode to keep track
4083 of which subsequence should be used for a given entry. In this setup,
4084 @kbd{C-c C-t} only operates within a subsequence, so it switches from
4085 @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
4086 (nothing) to @code{REPORT}. Therefore you need a mechanism to initially
4087 select the correct sequence. Besides the obvious ways like typing a
4088 keyword or using completion, you may also apply the following commands:
4091 @kindex C-S-@key{right}
4092 @kindex C-S-@key{left}
4093 @kindex C-u C-u C-c C-t
4094 @item C-u C-u C-c C-t
4095 @itemx C-S-@key{right}
4096 @itemx C-S-@key{left}
4097 These keys jump from one TODO subset to the next. In the above example,
4098 @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{right}} would jump from @code{TODO} or
4099 @code{DONE} to @code{REPORT}, and any of the words in the second row to
4100 @code{CANCELED}. Note that the @kbd{C-S-} key binding conflict with
4101 @code{shift-selection-mode} (@pxref{Conflicts}).
4102 @kindex S-@key{right}
4103 @kindex S-@key{left}
4106 @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through @emph{all}
4107 keywords from all sets, so for example @kbd{S-@key{<right>}} would switch
4108 from @code{DONE} to @code{REPORT} in the example above. See also
4109 @ref{Conflicts}, for a discussion of the interaction with
4110 @code{shift-selection-mode}.
4113 @node Fast access to TODO states, Per-file keywords, Multiple sets in one file, TODO extensions
4114 @subsection Fast access to TODO states
4116 If you would like to quickly change an entry to an arbitrary TODO state
4117 instead of cycling through the states, you can set up keys for single-letter
4118 access to the states. This is done by adding the selection character after
4119 each keyword, in parentheses@footnote{All characters are allowed except
4120 @code{@@^!}, which have a special meaning here.}. For example:
4123 (setq org-todo-keywords
4124 '((sequence "TODO(t)" "|" "DONE(d)")
4125 (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
4126 (sequence "|" "CANCELED(c)")))
4129 @vindex org-fast-tag-selection-include-todo
4130 If you then press @kbd{C-c C-t} followed by the selection key, the entry
4131 will be switched to this state. @kbd{SPC} can be used to remove any TODO
4132 keyword from an entry.@footnote{Check also the variable
4133 @code{org-fast-tag-selection-include-todo}, it allows you to change the TODO
4134 state through the tags interface (@pxref{Setting tags}), in case you like to
4135 mingle the two concepts. Note that this means you need to come up with
4136 unique keys across both sets of keywords.}
4138 @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions
4139 @subsection Setting up keywords for individual files
4140 @cindex keyword options
4141 @cindex per-file keywords
4146 It can be very useful to use different aspects of the TODO mechanism in
4147 different files. For file-local settings, you need to add special lines
4148 to the file which set the keywords and interpretation for that file
4149 only. For example, to set one of the two examples discussed above, you
4150 need one of the following lines, starting in column zero anywhere in the
4154 #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
4156 @noindent (you may also write @code{#+SEQ_TODO} to be explicit about the
4157 interpretation, but it means the same as @code{#+TODO}), or
4159 #+TYP_TODO: Fred Sara Lucy Mike | DONE
4162 A setup for using several sets in parallel would be:
4166 #+TODO: REPORT BUG KNOWNCAUSE | FIXED
4170 @cindex completion, of option keywords
4172 @noindent To make sure you are using the correct keyword, type
4173 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
4175 @cindex DONE, final TODO keyword
4176 Remember that the keywords after the vertical bar (or the last keyword
4177 if no bar is there) must always mean that the item is DONE (although you
4178 may use a different word). After changing one of these lines, use
4179 @kbd{C-c C-c} with the cursor still in the line to make the changes
4180 known to Org mode@footnote{Org mode parses these lines only when
4181 Org mode is activated after visiting a file. @kbd{C-c C-c} with the
4182 cursor in a line starting with @samp{#+} is simply restarting Org mode
4183 for the current buffer.}.
4185 @node Faces for TODO keywords, TODO dependencies, Per-file keywords, TODO extensions
4186 @subsection Faces for TODO keywords
4187 @cindex faces, for TODO keywords
4189 @vindex org-todo @r{(face)}
4190 @vindex org-done @r{(face)}
4191 @vindex org-todo-keyword-faces
4192 Org mode highlights TODO keywords with special faces: @code{org-todo}
4193 for keywords indicating that an item still has to be acted upon, and
4194 @code{org-done} for keywords indicating that an item is finished. If
4195 you are using more than 2 different states, you might want to use
4196 special faces for some of them. This can be done using the variable
4197 @code{org-todo-keyword-faces}. For example:
4201 (setq org-todo-keyword-faces
4202 '(("TODO" . org-warning) ("STARTED" . "yellow")
4203 ("CANCELED" . (:foreground "blue" :weight bold))))
4207 While using a list with face properties as shown for CANCELED @emph{should}
4208 work, this does not always seem to be the case. If necessary, define a
4209 special face and use that. A string is interpreted as a color. The variable
4210 @code{org-faces-easy-properties} determines if that color is interpreted as a
4211 foreground or a background color.
4213 @node TODO dependencies, , Faces for TODO keywords, TODO extensions
4214 @subsection TODO dependencies
4215 @cindex TODO dependencies
4216 @cindex dependencies, of TODO states
4218 @vindex org-enforce-todo-dependencies
4219 @cindex property, ORDERED
4220 The structure of Org files (hierarchy and lists) makes it easy to define TODO
4221 dependencies. Usually, a parent TODO task should not be marked DONE until
4222 all subtasks (defined as children tasks) are marked as DONE@. And sometimes
4223 there is a logical sequence to a number of (sub)tasks, so that one task
4224 cannot be acted upon before all siblings above it are done. If you customize
4225 the variable @code{org-enforce-todo-dependencies}, Org will block entries
4226 from changing state to DONE while they have children that are not DONE@.
4227 Furthermore, if an entry has a property @code{ORDERED}, each of its children
4228 will be blocked until all earlier siblings are marked DONE@. Here is an
4232 * TODO Blocked until (two) is done
4241 ** TODO b, needs to wait for (a)
4242 ** TODO c, needs to wait for (a) and (b)
4246 @orgcmd{C-c C-x o,org-toggle-ordered-property}
4247 @vindex org-track-ordered-property-with-tag
4248 @cindex property, ORDERED
4249 Toggle the @code{ORDERED} property of the current entry. A property is used
4250 for this behavior because this should be local to the current entry, not
4251 inherited like a tag. However, if you would like to @i{track} the value of
4252 this property with a tag for better visibility, customize the variable
4253 @code{org-track-ordered-property-with-tag}.
4254 @orgkey{C-u C-u C-u C-c C-t}
4255 Change TODO state, circumventing any state blocking.
4258 @vindex org-agenda-dim-blocked-tasks
4259 If you set the variable @code{org-agenda-dim-blocked-tasks}, TODO entries
4260 that cannot be closed because of such dependencies will be shown in a dimmed
4261 font or even made invisible in agenda views (@pxref{Agenda Views}).
4263 @cindex checkboxes and TODO dependencies
4264 @vindex org-enforce-todo-dependencies
4265 You can also block changes of TODO states by looking at checkboxes
4266 (@pxref{Checkboxes}). If you set the variable
4267 @code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked
4268 checkboxes will be blocked from switching to DONE.
4270 If you need more complex dependency structures, for example dependencies
4271 between entries in different trees or files, check out the contributed
4272 module @file{org-depend.el}.
4275 @node Progress logging, Priorities, TODO extensions, TODO Items
4276 @section Progress logging
4277 @cindex progress logging
4278 @cindex logging, of progress
4280 Org mode can automatically record a timestamp and possibly a note when
4281 you mark a TODO item as DONE, or even each time you change the state of
4282 a TODO item. This system is highly configurable; settings can be on a
4283 per-keyword basis and can be localized to a file or even a subtree. For
4284 information on how to clock working time for a task, see @ref{Clocking
4288 * Closing items:: When was this entry marked DONE?
4289 * Tracking TODO state changes:: When did the status change?
4290 * Tracking your habits:: How consistent have you been?
4293 @node Closing items, Tracking TODO state changes, Progress logging, Progress logging
4294 @subsection Closing items
4296 The most basic logging is to keep track of @emph{when} a certain TODO
4297 item was finished. This is achieved with@footnote{The corresponding
4298 in-buffer setting is: @code{#+STARTUP: logdone}}
4301 (setq org-log-done 'time)
4305 Then each time you turn an entry from a TODO (not-done) state into any
4306 of the DONE states, a line @samp{CLOSED: [timestamp]} will be inserted
4307 just after the headline. If you turn the entry back into a TODO item
4308 through further state cycling, that line will be removed again. If you
4309 want to record a note along with the timestamp, use@footnote{The
4310 corresponding in-buffer setting is: @code{#+STARTUP: lognotedone}}
4313 (setq org-log-done 'note)
4317 You will then be prompted for a note, and that note will be stored below
4318 the entry with a @samp{Closing Note} heading.
4320 In the timeline (@pxref{Timeline}) and in the agenda
4321 (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
4322 display the TODO items with a @samp{CLOSED} timestamp on each day,
4323 giving you an overview of what has been done.
4325 @node Tracking TODO state changes, Tracking your habits, Closing items, Progress logging
4326 @subsection Tracking TODO state changes
4327 @cindex drawer, for state change recording
4329 @vindex org-log-states-order-reversed
4330 @vindex org-log-into-drawer
4331 @cindex property, LOG_INTO_DRAWER
4332 When TODO keywords are used as workflow states (@pxref{Workflow states}), you
4333 might want to keep track of when a state change occurred and maybe take a
4334 note about this change. You can either record just a timestamp, or a
4335 time-stamped note for a change. These records will be inserted after the
4336 headline as an itemized list, newest first@footnote{See the variable
4337 @code{org-log-states-order-reversed}}. When taking a lot of notes, you might
4338 want to get the notes out of the way into a drawer (@pxref{Drawers}).
4339 Customize the variable @code{org-log-into-drawer} to get this behavior---the
4340 recommended drawer for this is called @code{LOGBOOK}@footnote{Note that the
4341 @code{LOGBOOK} drawer is unfolded when pressing @key{SPC} in the agenda to
4342 show an entry---use @key{C-u SPC} to keep it folded here}. You can also
4343 overrule the setting of this variable for a subtree by setting a
4344 @code{LOG_INTO_DRAWER} property.
4346 Since it is normally too much to record a note for every state, Org mode
4347 expects configuration on a per-keyword basis for this. This is achieved by
4348 adding special markers @samp{!} (for a timestamp) or @samp{@@} (for a note
4349 with timestamp) in parentheses after each keyword. For example, with the
4353 (setq org-todo-keywords
4354 '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
4357 To record a timestamp without a note for TODO keywords configured with
4358 @samp{@@}, just type @kbd{C-c C-c} to enter a blank note when prompted.
4361 @vindex org-log-done
4362 you not only define global TODO keywords and fast access keys, but also
4363 request that a time is recorded when the entry is set to
4364 DONE@footnote{It is possible that Org mode will record two timestamps
4365 when you are using both @code{org-log-done} and state change logging.
4366 However, it will never prompt for two notes---if you have configured
4367 both, the state change recording note will take precedence and cancel
4368 the @samp{Closing Note}.}, and that a note is recorded when switching to
4369 WAIT or CANCELED@. The setting for WAIT is even more special: the
4370 @samp{!} after the slash means that in addition to the note taken when
4371 entering the state, a timestamp should be recorded when @i{leaving} the
4372 WAIT state, if and only if the @i{target} state does not configure
4373 logging for entering it. So it has no effect when switching from WAIT
4374 to DONE, because DONE is configured to record a timestamp only. But
4375 when switching from WAIT back to TODO, the @samp{/!} in the WAIT
4376 setting now triggers a timestamp even though TODO has no logging
4379 You can use the exact same syntax for setting logging preferences local
4382 #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
4385 @cindex property, LOGGING
4386 In order to define logging settings that are local to a subtree or a
4387 single item, define a LOGGING property in this entry. Any non-empty
4388 LOGGING property resets all logging settings to nil. You may then turn
4389 on logging for this specific tree using STARTUP keywords like
4390 @code{lognotedone} or @code{logrepeat}, as well as adding state specific
4391 settings like @code{TODO(!)}. For example
4394 * TODO Log each state with only a time
4396 :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
4398 * TODO Only log when switching to WAIT, and when repeating
4400 :LOGGING: WAIT(@@) logrepeat
4402 * TODO No logging at all
4408 @node Tracking your habits, , Tracking TODO state changes, Progress logging
4409 @subsection Tracking your habits
4412 Org has the ability to track the consistency of a special category of TODOs,
4413 called ``habits''. A habit has the following properties:
4417 You have enabled the @code{habits} module by customizing the variable
4420 The habit is a TODO item, with a TODO keyword representing an open state.
4422 The property @code{STYLE} is set to the value @code{habit}.
4424 The TODO has a scheduled date, usually with a @code{.+} style repeat
4425 interval. A @code{++} style may be appropriate for habits with time
4426 constraints, e.g., must be done on weekends, or a @code{+} style for an
4427 unusual habit that can have a backlog, e.g., weekly reports.
4429 The TODO may also have minimum and maximum ranges specified by using the
4430 syntax @samp{.+2d/3d}, which says that you want to do the task at least every
4431 three days, but at most every two days.
4433 You must also have state logging for the @code{DONE} state enabled
4434 (@pxref{Tracking TODO state changes}), in order for historical data to be
4435 represented in the consistency graph. If it is not enabled it is not an
4436 error, but the consistency graphs will be largely meaningless.
4439 To give you an idea of what the above rules look like in action, here's an
4440 actual habit with some history:
4444 SCHEDULED: <2009-10-17 Sat .+2d/4d>
4445 - State "DONE" from "TODO" [2009-10-15 Thu]
4446 - State "DONE" from "TODO" [2009-10-12 Mon]
4447 - State "DONE" from "TODO" [2009-10-10 Sat]
4448 - State "DONE" from "TODO" [2009-10-04 Sun]
4449 - State "DONE" from "TODO" [2009-10-02 Fri]
4450 - State "DONE" from "TODO" [2009-09-29 Tue]
4451 - State "DONE" from "TODO" [2009-09-25 Fri]
4452 - State "DONE" from "TODO" [2009-09-19 Sat]
4453 - State "DONE" from "TODO" [2009-09-16 Wed]
4454 - State "DONE" from "TODO" [2009-09-12 Sat]
4457 :LAST_REPEAT: [2009-10-19 Mon 00:36]
4461 What this habit says is: I want to shave at most every 2 days (given by the
4462 @code{SCHEDULED} date and repeat interval) and at least every 4 days. If
4463 today is the 15th, then the habit first appears in the agenda on Oct 17,
4464 after the minimum of 2 days has elapsed, and will appear overdue on Oct 19,
4465 after four days have elapsed.
4467 What's really useful about habits is that they are displayed along with a
4468 consistency graph, to show how consistent you've been at getting that task
4469 done in the past. This graph shows every day that the task was done over the
4470 past three weeks, with colors for each day. The colors used are:
4474 If the task wasn't to be done yet on that day.
4476 If the task could have been done on that day.
4478 If the task was going to be overdue the next day.
4480 If the task was overdue on that day.
4483 In addition to coloring each day, the day is also marked with an asterisk if
4484 the task was actually done that day, and an exclamation mark to show where
4485 the current day falls in the graph.
4487 There are several configuration variables that can be used to change the way
4488 habits are displayed in the agenda.
4491 @item org-habit-graph-column
4492 The buffer column at which the consistency graph should be drawn. This will
4493 overwrite any text in that column, so it is a good idea to keep your habits'
4494 titles brief and to the point.
4495 @item org-habit-preceding-days
4496 The amount of history, in days before today, to appear in consistency graphs.
4497 @item org-habit-following-days
4498 The number of days after today that will appear in consistency graphs.
4499 @item org-habit-show-habits-only-for-today
4500 If non-nil, only show habits in today's agenda view. This is set to true by
4504 Lastly, pressing @kbd{K} in the agenda buffer will cause habits to
4505 temporarily be disabled and they won't appear at all. Press @kbd{K} again to
4506 bring them back. They are also subject to tag filtering, if you have habits
4507 which should only be done in certain contexts, for example.
4509 @node Priorities, Breaking down tasks, Progress logging, TODO Items
4513 If you use Org mode extensively, you may end up with enough TODO items that
4514 it starts to make sense to prioritize them. Prioritizing can be done by
4515 placing a @emph{priority cookie} into the headline of a TODO item, like this
4518 *** TODO [#A] Write letter to Sam Fortune
4522 @vindex org-priority-faces
4523 By default, Org mode supports three priorities: @samp{A}, @samp{B}, and
4524 @samp{C}. @samp{A} is the highest priority. An entry without a cookie is
4525 treated just like priority @samp{B}. Priorities make a difference only for
4526 sorting in the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they
4527 have no inherent meaning to Org mode. The cookies can be highlighted with
4528 special faces by customizing the variable @code{org-priority-faces}.
4530 Priorities can be attached to any outline node; they do not need to be TODO
4536 @findex org-priority
4537 Set the priority of the current headline (@command{org-priority}). The
4538 command prompts for a priority character @samp{A}, @samp{B} or @samp{C}.
4539 When you press @key{SPC} instead, the priority cookie is removed from the
4540 headline. The priorities can also be changed ``remotely'' from the timeline
4541 and agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
4543 @orgcmdkkcc{S-@key{up},S-@key{down},org-priority-up,org-priority-down}
4544 @vindex org-priority-start-cycle-with-default
4545 Increase/decrease priority of current headline@footnote{See also the option
4546 @code{org-priority-start-cycle-with-default}.}. Note that these keys are
4547 also used to modify timestamps (@pxref{Creating timestamps}). See also
4548 @ref{Conflicts}, for a discussion of the interaction with
4549 @code{shift-selection-mode}.
4552 @vindex org-highest-priority
4553 @vindex org-lowest-priority
4554 @vindex org-default-priority
4555 You can change the range of allowed priorities by setting the variables
4556 @code{org-highest-priority}, @code{org-lowest-priority}, and
4557 @code{org-default-priority}. For an individual buffer, you may set
4558 these values (highest, lowest, default) like this (please make sure that
4559 the highest priority is earlier in the alphabet than the lowest
4562 @cindex #+PRIORITIES
4567 @node Breaking down tasks, Checkboxes, Priorities, TODO Items
4568 @section Breaking tasks down into subtasks
4569 @cindex tasks, breaking down
4570 @cindex statistics, for TODO items
4572 @vindex org-agenda-todo-list-sublevels
4573 It is often advisable to break down large tasks into smaller, manageable
4574 subtasks. You can do this by creating an outline tree below a TODO item,
4575 with detailed subtasks on the tree@footnote{To keep subtasks out of the
4576 global TODO list, see the @code{org-agenda-todo-list-sublevels}.}. To keep
4577 the overview over the fraction of subtasks that are already completed, insert
4578 either @samp{[/]} or @samp{[%]} anywhere in the headline. These cookies will
4579 be updated each time the TODO status of a child changes, or when pressing
4580 @kbd{C-c C-c} on the cookie. For example:
4583 * Organize Party [33%]
4584 ** TODO Call people [1/2]
4588 ** DONE Talk to neighbor
4591 @cindex property, COOKIE_DATA
4592 If a heading has both checkboxes and TODO children below it, the meaning of
4593 the statistics cookie become ambiguous. Set the property
4594 @code{COOKIE_DATA} to either @samp{checkbox} or @samp{todo} to resolve
4597 @vindex org-hierarchical-todo-statistics
4598 If you would like to have the statistics cookie count any TODO entries in the
4599 subtree (not just direct children), configure the variable
4600 @code{org-hierarchical-todo-statistics}. To do this for a single subtree,
4601 include the word @samp{recursive} into the value of the @code{COOKIE_DATA}
4605 * Parent capturing statistics [2/20]
4607 :COOKIE_DATA: todo recursive
4611 If you would like a TODO entry to automatically change to DONE
4612 when all children are done, you can use the following setup:
4615 (defun org-summary-todo (n-done n-not-done)
4616 "Switch entry to DONE when all subentries are done, to TODO otherwise."
4617 (let (org-log-done org-log-states) ; turn off logging
4618 (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
4620 (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
4624 Another possibility is the use of checkboxes to identify (a hierarchy of) a
4625 large number of subtasks (@pxref{Checkboxes}).
4628 @node Checkboxes, , Breaking down tasks, TODO Items
4632 @vindex org-list-automatic-rules
4633 Every item in a plain list@footnote{With the exception of description
4634 lists. But you can allow it by modifying @code{org-list-automatic-rules}
4635 accordingly.} (@pxref{Plain lists}) can be made into a checkbox by starting
4636 it with the string @samp{[ ]}. This feature is similar to TODO items
4637 (@pxref{TODO Items}), but is more lightweight. Checkboxes are not included
4638 in the global TODO list, so they are often great to split a task into a
4639 number of simple steps. Or you can use them in a shopping list. To toggle a
4640 checkbox, use @kbd{C-c C-c}, or use the mouse (thanks to Piotr Zielinski's
4641 @file{org-mouse.el}).
4643 Here is an example of a checkbox list.
4646 * TODO Organize party [2/4]
4647 - [-] call people [1/3]
4652 - [ ] think about what music to play
4653 - [X] talk to the neighbors
4656 Checkboxes work hierarchically, so if a checkbox item has children that
4657 are checkboxes, toggling one of the children checkboxes will make the
4658 parent checkbox reflect if none, some, or all of the children are
4661 @cindex statistics, for checkboxes
4662 @cindex checkbox statistics
4663 @cindex property, COOKIE_DATA
4664 @vindex org-checkbox-hierarchical-statistics
4665 The @samp{[2/4]} and @samp{[1/3]} in the first and second line are cookies
4666 indicating how many checkboxes present in this entry have been checked off,
4667 and the total number of checkboxes present. This can give you an idea on how
4668 many checkboxes remain, even without opening a folded entry. The cookies can
4669 be placed into a headline or into (the first line of) a plain list item.
4670 Each cookie covers checkboxes of direct children structurally below the
4671 headline/item on which the cookie appears@footnote{Set the variable
4672 @code{org-checkbox-hierarchical-statistics} if you want such cookies to
4673 count all checkboxes below the cookie, not just those belonging to direct
4674 children.}. You have to insert the cookie yourself by typing either
4675 @samp{[/]} or @samp{[%]}. With @samp{[/]} you get an @samp{n out of m}
4676 result, as in the examples above. With @samp{[%]} you get information about
4677 the percentage of checkboxes checked (in the above example, this would be
4678 @samp{[50%]} and @samp{[33%]}, respectively). In a headline, a cookie can
4679 count either checkboxes below the heading or TODO states of children, and it
4680 will display whatever was changed last. Set the property @code{COOKIE_DATA}
4681 to either @samp{checkbox} or @samp{todo} to resolve this issue.
4683 @cindex blocking, of checkboxes
4684 @cindex checkbox blocking
4685 @cindex property, ORDERED
4686 If the current outline node has an @code{ORDERED} property, checkboxes must
4687 be checked off in sequence, and an error will be thrown if you try to check
4688 off a box while there are unchecked boxes above it.
4690 @noindent The following commands work with checkboxes:
4693 @orgcmd{C-c C-c,org-toggle-checkbox}
4694 Toggle checkbox status or (with prefix arg) checkbox presence at point.
4695 With a single prefix argument, add an empty checkbox or remove the current
4696 one@footnote{@kbd{C-u C-c C-c} on the @emph{first} item of a list with no checkbox
4697 will add checkboxes to the rest of the list.}. With a double prefix argument, set it to @samp{[-]}, which is
4698 considered to be an intermediate state.
4699 @orgcmd{C-c C-x C-b,org-toggle-checkbox}
4700 Toggle checkbox status or (with prefix arg) checkbox presence at point. With
4701 double prefix argument, set it to @samp{[-]}, which is considered to be an
4705 If there is an active region, toggle the first checkbox in the region
4706 and set all remaining boxes to the same status as the first. With a prefix
4707 arg, add or remove the checkbox for all items in the region.
4709 If the cursor is in a headline, toggle checkboxes in the region between
4710 this headline and the next (so @emph{not} the entire subtree).
4712 If there is no active region, just toggle the checkbox at point.
4714 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
4715 Insert a new item with a checkbox. This works only if the cursor is already
4716 in a plain list item (@pxref{Plain lists}).
4717 @orgcmd{C-c C-x o,org-toggle-ordered-property}
4718 @vindex org-track-ordered-property-with-tag
4719 @cindex property, ORDERED
4720 Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
4721 be checked off in sequence. A property is used for this behavior because
4722 this should be local to the current entry, not inherited like a tag.
4723 However, if you would like to @i{track} the value of this property with a tag
4724 for better visibility, customize the variable
4725 @code{org-track-ordered-property-with-tag}.
4726 @orgcmd{C-c #,org-update-statistics-cookies}
4727 Update the statistics cookie in the current outline entry. When called with
4728 a @kbd{C-u} prefix, update the entire file. Checkbox statistic cookies are
4729 updated automatically if you toggle checkboxes with @kbd{C-c C-c} and make
4730 new ones with @kbd{M-S-@key{RET}}. TODO statistics cookies update when
4731 changing TODO states. If you delete boxes/entries or add/change them by
4732 hand, use this command to get things back into sync.
4735 @node Tags, Properties and Columns, TODO Items, Top
4738 @cindex headline tagging
4739 @cindex matching, tags
4740 @cindex sparse tree, tag based
4742 An excellent way to implement labels and contexts for cross-correlating
4743 information is to assign @i{tags} to headlines. Org mode has extensive
4746 @vindex org-tag-faces
4747 Every headline can contain a list of tags; they occur at the end of the
4748 headline. Tags are normal words containing letters, numbers, @samp{_}, and
4749 @samp{@@}. Tags must be preceded and followed by a single colon, e.g.,
4750 @samp{:work:}. Several tags can be specified, as in @samp{:work:urgent:}.
4751 Tags will by default be in bold face with the same color as the headline.
4752 You may specify special faces for specific tags using the variable
4753 @code{org-tag-faces}, in much the same way as you can for TODO keywords
4754 (@pxref{Faces for TODO keywords}).
4757 * Tag inheritance:: Tags use the tree structure of the outline
4758 * Setting tags:: How to assign tags to a headline
4759 * Tag groups:: Use one tag to search for several tags
4760 * Tag searches:: Searching for combinations of tags
4763 @node Tag inheritance, Setting tags, Tags, Tags
4764 @section Tag inheritance
4765 @cindex tag inheritance
4766 @cindex inheritance, of tags
4767 @cindex sublevels, inclusion into tags match
4769 @i{Tags} make use of the hierarchical structure of outline trees. If a
4770 heading has a certain tag, all subheadings will inherit the tag as
4771 well. For example, in the list
4774 * Meeting with the French group :work:
4775 ** Summary by Frank :boss:notes:
4776 *** TODO Prepare slides for him :action:
4780 the final heading will have the tags @samp{:work:}, @samp{:boss:},
4781 @samp{:notes:}, and @samp{:action:} even though the final heading is not
4782 explicitly marked with those tags. You can also set tags that all entries in
4783 a file should inherit just as if these tags were defined in a hypothetical
4784 level zero that surrounds the entire file. Use a line like this@footnote{As
4785 with all these in-buffer settings, pressing @kbd{C-c C-c} activates any
4786 changes in the line.}:
4790 #+FILETAGS: :Peter:Boss:Secret:
4794 @vindex org-use-tag-inheritance
4795 @vindex org-tags-exclude-from-inheritance
4796 To limit tag inheritance to specific tags, use @code{org-tags-exclude-from-inheritance}.
4797 To turn it off entirely, use @code{org-use-tag-inheritance}.
4799 @vindex org-tags-match-list-sublevels
4800 When a headline matches during a tags search while tag inheritance is turned
4801 on, all the sublevels in the same tree will (for a simple match form) match
4802 as well@footnote{This is only true if the search does not involve more
4803 complex tests including properties (@pxref{Property searches}).}. The list
4804 of matches may then become very long. If you only want to see the first tags
4805 match in a subtree, configure the variable
4806 @code{org-tags-match-list-sublevels} (not recommended).
4808 @vindex org-agenda-use-tag-inheritance
4809 Tag inheritance is relevant when the agenda search tries to match a tag,
4810 either in the @code{tags} or @code{tags-todo} agenda types. In other agenda
4811 types, @code{org-use-tag-inheritance} has no effect. Still, you may want to
4812 have your tags correctly set in the agenda, so that tag filtering works fine,
4813 with inherited tags. Set @code{org-agenda-use-tag-inheritance} to control
4814 this: the default value includes all agenda types, but setting this to nil
4815 can really speed up agenda generation.
4817 @node Setting tags, Tag groups, Tag inheritance, Tags
4818 @section Setting tags
4819 @cindex setting tags
4820 @cindex tags, setting
4823 Tags can simply be typed into the buffer at the end of a headline.
4824 After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is
4825 also a special command for inserting tags:
4828 @orgcmd{C-c C-q,org-set-tags-command}
4829 @cindex completion, of tags
4830 @vindex org-tags-column
4831 Enter new tags for the current headline. Org mode will either offer
4832 completion or a special single-key interface for setting tags, see
4833 below. After pressing @key{RET}, the tags will be inserted and aligned
4834 to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all
4835 tags in the current buffer will be aligned to that column, just to make
4836 things look nice. TAGS are automatically realigned after promotion,
4837 demotion, and TODO state changes (@pxref{TODO basics}).
4839 @orgcmd{C-c C-c,org-set-tags-command}
4840 When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
4843 @vindex org-tag-alist
4844 Org supports tag insertion based on a @emph{list of tags}. By
4845 default this list is constructed dynamically, containing all tags
4846 currently used in the buffer. You may also globally specify a hard list
4847 of tags with the variable @code{org-tag-alist}. Finally you can set
4848 the default tags for a given file with lines like
4852 #+TAGS: @@work @@home @@tennisclub
4853 #+TAGS: laptop car pc sailboat
4856 If you have globally defined your preferred set of tags using the
4857 variable @code{org-tag-alist}, but would like to use a dynamic tag list
4858 in a specific file, add an empty TAGS option line to that file:
4864 @vindex org-tag-persistent-alist
4865 If you have a preferred set of tags that you would like to use in every file,
4866 in addition to those defined on a per-file basis by TAGS option lines, then
4867 you may specify a list of tags with the variable
4868 @code{org-tag-persistent-alist}. You may turn this off on a per-file basis
4869 by adding a STARTUP option line to that file:
4875 By default Org mode uses the standard minibuffer completion facilities for
4876 entering tags. However, it also implements another, quicker, tag selection
4877 method called @emph{fast tag selection}. This allows you to select and
4878 deselect tags with just a single key press. For this to work well you should
4879 assign unique letters to most of your commonly used tags. You can do this
4880 globally by configuring the variable @code{org-tag-alist} in your
4881 @file{.emacs} file. For example, you may find the need to tag many items in
4882 different files with @samp{:@@home:}. In this case you can set something
4886 (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
4889 @noindent If the tag is only relevant to the file you are working on, then you
4890 can instead set the TAGS option line as:
4893 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p)
4896 @noindent The tags interface will show the available tags in a splash
4897 window. If you want to start a new line after a specific tag, insert
4898 @samp{\n} into the tag list
4901 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) \n laptop(l) pc(p)
4904 @noindent or write them in two lines:
4907 #+TAGS: @@work(w) @@home(h) @@tennisclub(t)
4908 #+TAGS: laptop(l) pc(p)
4912 You can also group together tags that are mutually exclusive by using
4916 #+TAGS: @{ @@work(w) @@home(h) @@tennisclub(t) @} laptop(l) pc(p)
4919 @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
4920 and @samp{@@tennisclub} should be selected. Multiple such groups are allowed.
4922 @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
4923 these lines to activate any changes.
4926 To set these mutually exclusive groups in the variable @code{org-tags-alist},
4927 you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
4928 of the braces. Similarly, you can use @code{:newline} to indicate a line
4929 break. The previous example would be set globally by the following
4933 (setq org-tag-alist '((:startgroup . nil)
4934 ("@@work" . ?w) ("@@home" . ?h)
4935 ("@@tennisclub" . ?t)
4937 ("laptop" . ?l) ("pc" . ?p)))
4940 If at least one tag has a selection key then pressing @kbd{C-c C-c} will
4941 automatically present you with a special interface, listing inherited tags,
4942 the tags of the current headline, and a list of all valid tags with
4943 corresponding keys@footnote{Keys will automatically be assigned to tags which
4944 have no configured keys.}. In this interface, you can use the following
4949 Pressing keys assigned to tags will add or remove them from the list of
4950 tags in the current line. Selecting a tag in a group of mutually
4951 exclusive tags will turn off any other tags from that group.
4954 Enter a tag in the minibuffer, even if the tag is not in the predefined
4955 list. You will be able to complete on all tags present in the buffer.
4956 You can also add several tags: just separate them with a comma.
4960 Clear all tags for this line.
4963 Accept the modified set.
4965 Abort without installing changes.
4967 If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
4969 Turn off groups of mutually exclusive tags. Use this to (as an
4970 exception) assign several tags from such a group.
4972 Toggle auto-exit after the next change (see below).
4973 If you are using expert mode, the first @kbd{C-c} will display the
4978 This method lets you assign tags to a headline with very few keys. With
4979 the above setup, you could clear the current tags and set @samp{@@home},
4980 @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
4981 C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@home} to
4982 @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
4983 alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag
4984 @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
4985 @key{RET} @key{RET}}.
4987 @vindex org-fast-tag-selection-single-key
4988 If you find that most of the time you need only a single key press to
4989 modify your list of tags, set @code{org-fast-tag-selection-single-key}.
4990 Then you no longer have to press @key{RET} to exit fast tag selection---it
4991 will immediately exit after the first change. If you then occasionally
4992 need more keys, press @kbd{C-c} to turn off auto-exit for the current tag
4993 selection process (in effect: start selection with @kbd{C-c C-c C-c}
4994 instead of @kbd{C-c C-c}). If you set the variable to the value
4995 @code{expert}, the special window is not even shown for single-key tag
4996 selection, it comes up only when you press an extra @kbd{C-c}.
4998 @node Tag groups, Tag searches, Setting tags, Tags
5002 @cindex tags, groups
5003 In a set of mutually exclusive tags, the first tag can be defined as a
5004 @emph{group tag}. When you search for a group tag, it will return matches
5005 for all members in the group. In an agenda view, filtering by a group tag
5006 will display headlines tagged with at least one of the members of the
5007 group. This makes tag searches and filters even more flexible.
5009 You can set group tags by inserting a colon between the group tag and other
5013 #+TAGS: @{ @@read : @@read_book @@read_ebook @}
5016 In this example, @samp{@@read} is a @emph{group tag} for a set of three
5017 tags: @samp{@@read}, @samp{@@read_book} and @samp{@@read_ebook}.
5019 You can also use the @code{:grouptags} keyword directly when setting
5020 @var{org-tag-alist}:
5023 (setq org-tag-alist '((:startgroup . nil)
5026 ("@@read_book" . nil)
5027 ("@@read_ebook" . nil)
5032 @vindex org-group-tags
5033 If you want to ignore group tags temporarily, toggle group tags support
5034 with @command{org-toggle-tags-groups}, bound to @kbd{C-c C-x q}. If you
5035 want to disable tag groups completely, set @var{org-group-tags} to nil.
5037 @node Tag searches, , Tag groups, Tags
5038 @section Tag searches
5039 @cindex tag searches
5040 @cindex searching for tags
5042 Once a system of tags has been set up, it can be used to collect related
5043 information into special lists.
5046 @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
5047 Create a sparse tree with all headlines matching a tags search. With a
5048 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
5049 @orgcmd{C-c a m,org-tags-view}
5050 Create a global list of tag matches from all agenda files.
5051 @xref{Matching tags and properties}.
5052 @orgcmd{C-c a M,org-tags-view}
5053 @vindex org-tags-match-list-sublevels
5054 Create a global list of tag matches from all agenda files, but check
5055 only TODO items and force checking subitems (see variable
5056 @code{org-tags-match-list-sublevels}).
5059 These commands all prompt for a match string which allows basic Boolean logic
5060 like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and
5061 @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries
5062 which are tagged, like @samp{Kathy} or @samp{Sally}. The full syntax of the search
5063 string is rich and allows also matching against TODO keywords, entry levels
5064 and properties. For a complete description with many examples, see
5065 @ref{Matching tags and properties}.
5068 @node Properties and Columns, Dates and Times, Tags, Top
5069 @chapter Properties and columns
5072 A property is a key-value pair associated with an entry. Properties can be
5073 set so they are associated with a single entry, with every entry in a tree,
5074 or with every entry in an Org mode file.
5076 There are two main applications for properties in Org mode. First,
5077 properties are like tags, but with a value. Imagine maintaining a file where
5078 you document bugs and plan releases for a piece of software. Instead of
5079 using tags like @code{:release_1:}, @code{:release_2:}, you can use a
5080 property, say @code{:Release:}, that in different subtrees has different
5081 values, such as @code{1.0} or @code{2.0}. Second, you can use properties to
5082 implement (very basic) database capabilities in an Org buffer. Imagine
5083 keeping track of your music CDs, where properties could be things such as the
5084 album, artist, date of release, number of tracks, and so on.
5086 Properties can be conveniently edited and viewed in column view
5087 (@pxref{Column view}).
5090 * Property syntax:: How properties are spelled out
5091 * Special properties:: Access to other Org mode features
5092 * Property searches:: Matching property values
5093 * Property inheritance:: Passing values down the tree
5094 * Column view:: Tabular viewing and editing
5095 * Property API:: Properties for Lisp programmers
5098 @node Property syntax, Special properties, Properties and Columns, Properties and Columns
5099 @section Property syntax
5100 @cindex property syntax
5101 @cindex drawer, for properties
5103 Properties are key-value pairs. When they are associated with a single entry
5104 or with a tree they need to be inserted into a special
5105 drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property
5106 is specified on a single line, with the key (surrounded by colons)
5107 first, and the value after it. Here is an example:
5112 *** Goldberg Variations
5114 :Title: Goldberg Variations
5115 :Composer: J.S. Bach
5117 :Publisher: Deutsche Grammophon
5122 Depending on the value of @code{org-use-property-inheritance}, a property set
5123 this way will either be associated with a single entry, or the sub-tree
5124 defined by the entry, see @ref{Property inheritance}.
5126 You may define the allowed values for a particular property @samp{:Xyz:}
5127 by setting a property @samp{:Xyz_ALL:}. This special property is
5128 @emph{inherited}, so if you set it in a level 1 entry, it will apply to
5129 the entire tree. When allowed values are defined, setting the
5130 corresponding property becomes easier and is less prone to typing
5131 errors. For the example with the CD collection, we can predefine
5132 publishers and the number of disks in a box like this:
5137 :NDisks_ALL: 1 2 3 4
5138 :Publisher_ALL: "Deutsche Grammophon" Philips EMI
5142 If you want to set properties that can be inherited by any entry in a
5143 file, use a line like
5144 @cindex property, _ALL
5147 #+PROPERTY: NDisks_ALL 1 2 3 4
5150 Contrary to properties set from a special drawer, you have to refresh the
5151 buffer with @kbd{C-c C-c} to activate this changes.
5153 If you want to add to the value of an existing property, append a @code{+} to
5154 the property name. The following results in the property @code{var} having
5155 the value ``foo=1 bar=2''.
5158 #+PROPERTY: var foo=1
5159 #+PROPERTY: var+ bar=2
5162 It is also possible to add to the values of inherited properties. The
5163 following results in the @code{genres} property having the value ``Classic
5164 Baroque'' under the @code{Goldberg Variations} subtree.
5172 *** Goldberg Variations
5174 :Title: Goldberg Variations
5175 :Composer: J.S. Bach
5177 :Publisher: Deutsche Grammophon
5182 Note that a property can only have one entry per Drawer.
5184 @vindex org-global-properties
5185 Property values set with the global variable
5186 @code{org-global-properties} can be inherited by all entries in all
5190 The following commands help to work with properties:
5193 @orgcmd{M-@key{TAB},pcomplete}
5194 After an initial colon in a line, complete property keys. All keys used
5195 in the current file will be offered as possible completions.
5196 @orgcmd{C-c C-x p,org-set-property}
5197 Set a property. This prompts for a property name and a value. If
5198 necessary, the property drawer is created as well.
5199 @item C-u M-x org-insert-drawer
5200 @cindex org-insert-drawer
5201 Insert a property drawer into the current entry. The drawer will be
5202 inserted early in the entry, but after the lines with planning
5203 information like deadlines.
5204 @orgcmd{C-c C-c,org-property-action}
5205 With the cursor in a property drawer, this executes property commands.
5206 @orgcmd{C-c C-c s,org-set-property}
5207 Set a property in the current entry. Both the property and the value
5208 can be inserted using completion.
5209 @orgcmdkkcc{S-@key{right},S-@key{left},org-property-next-allowed-value,org-property-previous-allowed-value}
5210 Switch property at point to the next/previous allowed value.
5211 @orgcmd{C-c C-c d,org-delete-property}
5212 Remove a property from the current entry.
5213 @orgcmd{C-c C-c D,org-delete-property-globally}
5214 Globally remove a property, from all entries in the current file.
5215 @orgcmd{C-c C-c c,org-compute-property-at-point}
5216 Compute the property at point, using the operator and scope from the
5217 nearest column format definition.
5220 @node Special properties, Property searches, Property syntax, Properties and Columns
5221 @section Special properties
5222 @cindex properties, special
5224 Special properties provide an alternative access method to Org mode features,
5225 like the TODO state or the priority of an entry, discussed in the previous
5226 chapters. This interface exists so that you can include these states in a
5227 column view (@pxref{Column view}), or to use them in queries. The following
5228 property names are special and (except for @code{:CATEGORY:}) should not be
5229 used as keys in the properties drawer:
5231 @cindex property, special, ID
5232 @cindex property, special, TODO
5233 @cindex property, special, TAGS
5234 @cindex property, special, ALLTAGS
5235 @cindex property, special, CATEGORY
5236 @cindex property, special, PRIORITY
5237 @cindex property, special, DEADLINE
5238 @cindex property, special, SCHEDULED
5239 @cindex property, special, CLOSED
5240 @cindex property, special, TIMESTAMP
5241 @cindex property, special, TIMESTAMP_IA
5242 @cindex property, special, CLOCKSUM
5243 @cindex property, special, CLOCKSUM_T
5244 @cindex property, special, BLOCKED
5245 @c guessing that ITEM is needed in this area; also, should this list be sorted?
5246 @cindex property, special, ITEM
5247 @cindex property, special, FILE
5249 ID @r{A globally unique ID used for synchronization during}
5250 @r{iCalendar or MobileOrg export.}
5251 TODO @r{The TODO keyword of the entry.}
5252 TAGS @r{The tags defined directly in the headline.}
5253 ALLTAGS @r{All tags, including inherited ones.}
5254 CATEGORY @r{The category of an entry.}
5255 PRIORITY @r{The priority of the entry, a string with a single letter.}
5256 DEADLINE @r{The deadline time string, without the angular brackets.}
5257 SCHEDULED @r{The scheduling timestamp, without the angular brackets.}
5258 CLOSED @r{When was this entry closed?}
5259 TIMESTAMP @r{The first keyword-less timestamp in the entry.}
5260 TIMESTAMP_IA @r{The first inactive timestamp in the entry.}
5261 CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}}
5262 @r{must be run first to compute the values in the current buffer.}
5263 CLOCKSUM_T @r{The sum of CLOCK intervals in the subtree for today.}
5264 @r{@code{org-clock-sum-today} must be run first to compute the}
5265 @r{values in the current buffer.}
5266 BLOCKED @r{"t" if task is currently blocked by children or siblings}
5267 ITEM @r{The headline of the entry.}
5268 FILE @r{The filename the entry is located in.}
5271 @node Property searches, Property inheritance, Special properties, Properties and Columns
5272 @section Property searches
5273 @cindex properties, searching
5274 @cindex searching, of properties
5276 To create sparse trees and special lists with selection based on properties,
5277 the same commands are used as for tag searches (@pxref{Tag searches}).
5280 @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
5281 Create a sparse tree with all matching entries. With a
5282 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
5283 @orgcmd{C-c a m,org-tags-view}
5284 Create a global list of tag/property matches from all agenda files.
5285 @xref{Matching tags and properties}.
5286 @orgcmd{C-c a M,org-tags-view}
5287 @vindex org-tags-match-list-sublevels
5288 Create a global list of tag matches from all agenda files, but check
5289 only TODO items and force checking of subitems (see variable
5290 @code{org-tags-match-list-sublevels}).
5293 The syntax for the search string is described in @ref{Matching tags and
5296 There is also a special command for creating sparse trees based on a
5301 Create a sparse tree based on the value of a property. This first
5302 prompts for the name of a property, and then for a value. A sparse tree
5303 is created with all entries that define this property with the given
5304 value. If you enclose the value in curly braces, it is interpreted as
5305 a regular expression and matched against the property values.
5308 @node Property inheritance, Column view, Property searches, Properties and Columns
5309 @section Property Inheritance
5310 @cindex properties, inheritance
5311 @cindex inheritance, of properties
5313 @vindex org-use-property-inheritance
5314 The outline structure of Org mode documents lends itself to an
5315 inheritance model of properties: if the parent in a tree has a certain
5316 property, the children can inherit this property. Org mode does not
5317 turn this on by default, because it can slow down property searches
5318 significantly and is often not needed. However, if you find inheritance
5319 useful, you can turn it on by setting the variable
5320 @code{org-use-property-inheritance}. It may be set to @code{t} to make
5321 all properties inherited from the parent, to a list of properties
5322 that should be inherited, or to a regular expression that matches
5323 inherited properties. If a property has the value @samp{nil}, this is
5324 interpreted as an explicit undefine of the property, so that inheritance
5325 search will stop at this value and return @code{nil}.
5327 Org mode has a few properties for which inheritance is hard-coded, at
5328 least for the special applications for which they are used:
5330 @cindex property, COLUMNS
5333 The @code{:COLUMNS:} property defines the format of column view
5334 (@pxref{Column view}). It is inherited in the sense that the level
5335 where a @code{:COLUMNS:} property is defined is used as the starting
5336 point for a column view table, independently of the location in the
5337 subtree from where columns view is turned on.
5339 @cindex property, CATEGORY
5340 For agenda view, a category set through a @code{:CATEGORY:} property
5341 applies to the entire subtree.
5343 @cindex property, ARCHIVE
5344 For archiving, the @code{:ARCHIVE:} property may define the archive
5345 location for the entire subtree (@pxref{Moving subtrees}).
5347 @cindex property, LOGGING
5348 The LOGGING property may define logging settings for an entry or a
5349 subtree (@pxref{Tracking TODO state changes}).
5352 @node Column view, Property API, Property inheritance, Properties and Columns
5353 @section Column view
5355 A great way to view and edit properties in an outline tree is
5356 @emph{column view}. In column view, each outline node is turned into a
5357 table row. Columns in this table provide access to properties of the
5358 entries. Org mode implements columns by overlaying a tabular structure
5359 over the headline of each item. While the headlines have been turned
5360 into a table row, you can still change the visibility of the outline
5361 tree. For example, you get a compact table by switching to CONTENTS
5362 view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
5363 is active), but you can still open, read, and edit the entry below each
5364 headline. Or, you can switch to column view after executing a sparse
5365 tree command and in this way get a table only for the selected items.
5366 Column view also works in agenda buffers (@pxref{Agenda Views}) where
5367 queries have collected selected items, possibly from a number of files.
5370 * Defining columns:: The COLUMNS format property
5371 * Using column view:: How to create and use column view
5372 * Capturing column view:: A dynamic block for column view
5375 @node Defining columns, Using column view, Column view, Column view
5376 @subsection Defining columns
5377 @cindex column view, for properties
5378 @cindex properties, column view
5380 Setting up a column view first requires defining the columns. This is
5381 done by defining a column format line.
5384 * Scope of column definitions:: Where defined, where valid?
5385 * Column attributes:: Appearance and content of a column
5388 @node Scope of column definitions, Column attributes, Defining columns, Defining columns
5389 @subsubsection Scope of column definitions
5391 To define a column format for an entire file, use a line like
5395 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5398 To specify a format that only applies to a specific tree, add a
5399 @code{:COLUMNS:} property to the top node of that tree, for example:
5402 ** Top node for columns view
5404 :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5408 If a @code{:COLUMNS:} property is present in an entry, it defines columns
5409 for the entry itself, and for the entire subtree below it. Since the
5410 column definition is part of the hierarchical structure of the document,
5411 you can define columns on level 1 that are general enough for all
5412 sublevels, and more specific columns further down, when you edit a
5413 deeper part of the tree.
5415 @node Column attributes, , Scope of column definitions, Defining columns
5416 @subsubsection Column attributes
5417 A column definition sets the attributes of a column. The general
5418 definition looks like this:
5421 %[@var{width}]@var{property}[(@var{title})][@{@var{summary-type}@}]
5425 Except for the percent sign and the property name, all items are
5426 optional. The individual parts have the following meaning:
5429 @var{width} @r{An integer specifying the width of the column in characters.}
5430 @r{If omitted, the width will be determined automatically.}
5431 @var{property} @r{The property that should be edited in this column.}
5432 @r{Special properties representing meta data are allowed here}
5433 @r{as well (@pxref{Special properties})}
5434 @var{title} @r{The header text for the column. If omitted, the property}
5436 @{@var{summary-type}@} @r{The summary type. If specified, the column values for}
5437 @r{parent nodes are computed from the children.}
5438 @r{Supported summary types are:}
5439 @{+@} @r{Sum numbers in this column.}
5440 @{+;%.1f@} @r{Like @samp{+}, but format result with @samp{%.1f}.}
5441 @{$@} @r{Currency, short for @samp{+;%.2f}.}
5442 @{:@} @r{Sum times, HH:MM, plain numbers are hours.}
5443 @{X@} @r{Checkbox status, @samp{[X]} if all children are @samp{[X]}.}
5444 @{X/@} @r{Checkbox status, @samp{[n/m]}.}
5445 @{X%@} @r{Checkbox status, @samp{[n%]}.}
5446 @{min@} @r{Smallest number in column.}
5447 @{max@} @r{Largest number.}
5448 @{mean@} @r{Arithmetic mean of numbers.}
5449 @{:min@} @r{Smallest time value in column.}
5450 @{:max@} @r{Largest time value.}
5451 @{:mean@} @r{Arithmetic mean of time values.}
5452 @{@@min@} @r{Minimum age (in days/hours/mins/seconds).}
5453 @{@@max@} @r{Maximum age (in days/hours/mins/seconds).}
5454 @{@@mean@} @r{Arithmetic mean of ages (in days/hours/mins/seconds).}
5455 @{est+@} @r{Add low-high estimates.}
5459 Be aware that you can only have one summary type for any property you
5460 include. Subsequent columns referencing the same property will all display the
5461 same summary information.
5463 The @code{est+} summary type requires further explanation. It is used for
5464 combining estimates, expressed as low-high ranges. For example, instead
5465 of estimating a particular task will take 5 days, you might estimate it as
5466 5--6 days if you're fairly confident you know how much work is required, or
5467 1--10 days if you don't really know what needs to be done. Both ranges
5468 average at 5.5 days, but the first represents a more predictable delivery.
5470 When combining a set of such estimates, simply adding the lows and highs
5471 produces an unrealistically wide result. Instead, @code{est+} adds the
5472 statistical mean and variance of the sub-tasks, generating a final estimate
5473 from the sum. For example, suppose you had ten tasks, each of which was
5474 estimated at 0.5 to 2 days of work. Straight addition produces an estimate
5475 of 5 to 20 days, representing what to expect if everything goes either
5476 extremely well or extremely poorly. In contrast, @code{est+} estimates the
5477 full job more realistically, at 10--15 days.
5479 Here is an example for a complete columns definition, along with allowed
5483 :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.}
5484 %10Time_Estimate@{:@} %CLOCKSUM %CLOCKSUM_T
5485 :Owner_ALL: Tammy Mark Karl Lisa Don
5486 :Status_ALL: "In progress" "Not started yet" "Finished" ""
5487 :Approved_ALL: "[ ]" "[X]"
5491 The first column, @samp{%25ITEM}, means the first 25 characters of the
5492 item itself, i.e., of the headline. You probably always should start the
5493 column definition with the @samp{ITEM} specifier. The other specifiers
5494 create columns @samp{Owner} with a list of names as allowed values, for
5495 @samp{Status} with four different possible values, and for a checkbox
5496 field @samp{Approved}. When no width is given after the @samp{%}
5497 character, the column will be exactly as wide as it needs to be in order
5498 to fully display all values. The @samp{Approved} column does have a
5499 modified title (@samp{Approved?}, with a question mark). Summaries will
5500 be created for the @samp{Time_Estimate} column by adding time duration
5501 expressions like HH:MM, and for the @samp{Approved} column, by providing
5502 an @samp{[X]} status if all children have been checked. The
5503 @samp{CLOCKSUM} and @samp{CLOCKSUM_T} columns are special, they lists the
5504 sums of CLOCK intervals in the subtree, either for all clocks or just for
5507 @node Using column view, Capturing column view, Defining columns, Column view
5508 @subsection Using column view
5511 @tsubheading{Turning column view on and off}
5512 @orgcmd{C-c C-x C-c,org-columns}
5513 @vindex org-columns-default-format
5514 Turn on column view. If the cursor is before the first headline in the file,
5515 column view is turned on for the entire file, using the @code{#+COLUMNS}
5516 definition. If the cursor is somewhere inside the outline, this command
5517 searches the hierarchy, up from point, for a @code{:COLUMNS:} property that
5518 defines a format. When one is found, the column view table is established
5519 for the tree starting at the entry that contains the @code{:COLUMNS:}
5520 property. If no such property is found, the format is taken from the
5521 @code{#+COLUMNS} line or from the variable @code{org-columns-default-format},
5522 and column view is established for the current entry and its subtree.
5523 @orgcmd{r,org-columns-redo}
5524 Recreate the column view, to include recent changes made in the buffer.
5525 @orgcmd{g,org-columns-redo}
5527 @orgcmd{q,org-columns-quit}
5529 @tsubheading{Editing values}
5530 @item @key{left} @key{right} @key{up} @key{down}
5531 Move through the column view from field to field.
5532 @kindex S-@key{left}
5533 @kindex S-@key{right}
5534 @item S-@key{left}/@key{right}
5535 Switch to the next/previous allowed value of the field. For this, you
5536 have to have specified allowed values for a property.
5538 Directly select the Nth allowed value, @kbd{0} selects the 10th value.
5539 @orgcmdkkcc{n,p,org-columns-next-allowed-value,org-columns-previous-allowed-value}
5540 Same as @kbd{S-@key{left}/@key{right}}
5541 @orgcmd{e,org-columns-edit-value}
5542 Edit the property at point. For the special properties, this will
5543 invoke the same interface that you normally use to change that
5544 property. For example, when editing a TAGS property, the tag completion
5545 or fast selection interface will pop up.
5546 @orgcmd{C-c C-c,org-columns-set-tags-or-toggle}
5547 When there is a checkbox at point, toggle it.
5548 @orgcmd{v,org-columns-show-value}
5549 View the full value of this property. This is useful if the width of
5550 the column is smaller than that of the value.
5551 @orgcmd{a,org-columns-edit-allowed}
5552 Edit the list of allowed values for this property. If the list is found
5553 in the hierarchy, the modified values is stored there. If no list is
5554 found, the new value is stored in the first entry that is part of the
5555 current column view.
5556 @tsubheading{Modifying the table structure}
5557 @orgcmdkkcc{<,>,org-columns-narrow,org-columns-widen}
5558 Make the column narrower/wider by one character.
5559 @orgcmd{S-M-@key{right},org-columns-new}
5560 Insert a new column, to the left of the current column.
5561 @orgcmd{S-M-@key{left},org-columns-delete}
5562 Delete the current column.
5565 @node Capturing column view, , Using column view, Column view
5566 @subsection Capturing column view
5568 Since column view is just an overlay over a buffer, it cannot be
5569 exported or printed directly. If you want to capture a column view, use
5570 a @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame
5571 of this block looks like this:
5573 @cindex #+BEGIN, columnview
5576 #+BEGIN: columnview :hlines 1 :id "label"
5581 @noindent This dynamic block has the following parameters:
5585 This is the most important parameter. Column view is a feature that is
5586 often localized to a certain (sub)tree, and the capture block might be
5587 at a different location in the file. To identify the tree whose view to
5588 capture, you can use 4 values:
5589 @cindex property, ID
5591 local @r{use the tree in which the capture block is located}
5592 global @r{make a global view, including all headings in the file}
5593 "file:@var{path-to-file}"
5594 @r{run column view at the top of this file}
5595 "@var{ID}" @r{call column view in the tree that has an @code{:ID:}}
5596 @r{property with the value @i{label}. You can use}
5597 @r{@kbd{M-x org-id-copy} to create a globally unique ID for}
5598 @r{the current entry and copy it to the kill-ring.}
5601 When @code{t}, insert an hline after every line. When a number @var{N}, insert
5602 an hline before each headline with level @code{<= @var{N}}.
5604 When set to @code{t}, force column groups to get vertical lines.
5606 When set to a number, don't capture entries below this level.
5607 @item :skip-empty-rows
5608 When set to @code{t}, skip rows where the only non-empty specifier of the
5609 column view is @code{ITEM}.
5614 The following commands insert or update the dynamic block:
5617 @orgcmd{C-c C-x i,org-insert-columns-dblock}
5618 Insert a dynamic block capturing a column view. You will be prompted
5619 for the scope or ID of the view.
5620 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
5621 Update dynamic block at point. The cursor needs to be in the
5622 @code{#+BEGIN} line of the dynamic block.
5623 @orgcmd{C-u C-c C-x C-u,org-update-all-dblocks}
5624 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
5625 you have several clock table blocks, column-capturing blocks or other dynamic
5629 You can add formulas to the column view table and you may add plotting
5630 instructions in front of the table---these will survive an update of the
5631 block. If there is a @code{#+TBLFM:} after the table, the table will
5632 actually be recalculated automatically after an update.
5634 An alternative way to capture and process property values into a table is
5635 provided by Eric Schulte's @file{org-collector.el} which is a contributed
5636 package@footnote{Contributed packages are not part of Emacs, but are
5637 distributed with the main distribution of Org (visit
5638 @uref{http://orgmode.org}).}. It provides a general API to collect
5639 properties from entries in a certain scope, and arbitrary Lisp expressions to
5640 process these values before inserting them into a table or a dynamic block.
5642 @node Property API, , Column view, Properties and Columns
5643 @section The Property API
5644 @cindex properties, API
5645 @cindex API, for properties
5647 There is a full API for accessing and changing properties. This API can
5648 be used by Emacs Lisp programs to work with properties and to implement
5649 features based on them. For more information see @ref{Using the
5652 @node Dates and Times, Capture - Refile - Archive, Properties and Columns, Top
5653 @chapter Dates and times
5659 To assist project planning, TODO items can be labeled with a date and/or
5660 a time. The specially formatted string carrying the date and time
5661 information is called a @emph{timestamp} in Org mode. This may be a
5662 little confusing because timestamp is often used as indicating when
5663 something was created or last changed. However, in Org mode this term
5664 is used in a much wider sense.
5667 * Timestamps:: Assigning a time to a tree entry
5668 * Creating timestamps:: Commands which insert timestamps
5669 * Deadlines and scheduling:: Planning your work
5670 * Clocking work time:: Tracking how long you spend on a task
5671 * Effort estimates:: Planning work effort in advance
5672 * Relative timer:: Notes with a running timer
5673 * Countdown timer:: Starting a countdown timer for a task
5677 @node Timestamps, Creating timestamps, Dates and Times, Dates and Times
5678 @section Timestamps, deadlines, and scheduling
5680 @cindex ranges, time
5685 A timestamp is a specification of a date (possibly with a time or a range of
5686 times) in a special format, either @samp{<2003-09-16 Tue>}@footnote{In this
5687 simplest form, the day name is optional when you type the date yourself.
5688 However, any dates inserted or modified by Org will add that day name, for
5689 reading convenience.} or @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16
5690 Tue 12:00-12:30>}@footnote{This is inspired by the standard ISO 8601
5691 date/time format. To use an alternative format, see @ref{Custom time
5692 format}.}. A timestamp can appear anywhere in the headline or body of an Org
5693 tree entry. Its presence causes entries to be shown on specific dates in the
5694 agenda (@pxref{Weekly/daily agenda}). We distinguish:
5697 @item Plain timestamp; Event; Appointment
5700 A simple timestamp just assigns a date/time to an item. This is just
5701 like writing down an appointment or event in a paper agenda. In the
5702 timeline and agenda displays, the headline of an entry associated with a
5703 plain timestamp will be shown exactly on that date.
5706 * Meet Peter at the movies
5707 <2006-11-01 Wed 19:15>
5708 * Discussion on climate change
5709 <2006-11-02 Thu 20:00-22:00>
5712 @item Timestamp with repeater interval
5713 @cindex timestamp, with repeater interval
5714 A timestamp may contain a @emph{repeater interval}, indicating that it
5715 applies not only on the given date, but again and again after a certain
5716 interval of N days (d), weeks (w), months (m), or years (y). The
5717 following will show up in the agenda every Wednesday:
5720 * Pick up Sam at school
5721 <2007-05-16 Wed 12:30 +1w>
5724 @item Diary-style sexp entries
5725 For more complex date specifications, Org mode supports using the special
5726 sexp diary entries implemented in the Emacs calendar/diary
5727 package@footnote{When working with the standard diary sexp functions, you
5728 need to be very careful with the order of the arguments. That order depend
5729 evilly on the variable @code{calendar-date-style} (or, for older Emacs
5730 versions, @code{european-calendar-style}). For example, to specify a date
5731 December 12, 2005, the call might look like @code{(diary-date 12 1 2005)} or
5732 @code{(diary-date 1 12 2005)} or @code{(diary-date 2005 12 1)}, depending on
5733 the settings. This has been the source of much confusion. Org mode users
5734 can resort to special versions of these functions like @code{org-date} or
5735 @code{org-anniversary}. These work just like the corresponding @code{diary-}
5736 functions, but with stable ISO order of arguments (year, month, day) wherever
5737 applicable, independent of the value of @code{calendar-date-style}.}. For
5738 example with optional time
5741 * 22:00-23:00 The nerd meeting on every 2nd Thursday of the month
5742 <%%(diary-float t 4 2)>
5745 @item Time/Date range
5748 Two timestamps connected by @samp{--} denote a range. The headline
5749 will be shown on the first and last day of the range, and on any dates
5750 that are displayed and fall in the range. Here is an example:
5753 ** Meeting in Amsterdam
5754 <2004-08-23 Mon>--<2004-08-26 Thu>
5757 @item Inactive timestamp
5758 @cindex timestamp, inactive
5759 @cindex inactive timestamp
5760 Just like a plain timestamp, but with square brackets instead of
5761 angular ones. These timestamps are inactive in the sense that they do
5762 @emph{not} trigger an entry to show up in the agenda.
5765 * Gillian comes late for the fifth time
5771 @node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times
5772 @section Creating timestamps
5773 @cindex creating timestamps
5774 @cindex timestamps, creating
5776 For Org mode to recognize timestamps, they need to be in the specific
5777 format. All commands listed below produce timestamps in the correct
5781 @orgcmd{C-c .,org-time-stamp}
5782 Prompt for a date and insert a corresponding timestamp. When the cursor is
5783 at an existing timestamp in the buffer, the command is used to modify this
5784 timestamp instead of inserting a new one. When this command is used twice in
5785 succession, a time range is inserted.
5787 @orgcmd{C-c !,org-time-stamp-inactive}
5788 Like @kbd{C-c .}, but insert an inactive timestamp that will not cause
5795 @vindex org-time-stamp-rounding-minutes
5796 Like @kbd{C-c .} and @kbd{C-c !}, but use the alternative format which
5797 contains date and time. The default time can be rounded to multiples of 5
5798 minutes, see the option @code{org-time-stamp-rounding-minutes}.
5801 Normalize timestamp, insert/fix day name if missing or wrong.
5803 @orgcmd{C-c <,org-date-from-calendar}
5804 Insert a timestamp corresponding to the cursor date in the Calendar.
5806 @orgcmd{C-c >,org-goto-calendar}
5807 Access the Emacs calendar for the current date. If there is a
5808 timestamp in the current line, go to the corresponding date
5811 @orgcmd{C-c C-o,org-open-at-point}
5812 Access the agenda for the date given by the timestamp or -range at
5813 point (@pxref{Weekly/daily agenda}).
5815 @orgcmdkkcc{S-@key{left},S-@key{right},org-timestamp-down-day,org-timestamp-up-day}
5816 Change date at cursor by one day. These key bindings conflict with
5817 shift-selection and related modes (@pxref{Conflicts}).
5819 @orgcmdkkcc{S-@key{up},S-@key{down},org-timestamp-up,org-timestamp-down-down}
5820 Change the item under the cursor in a timestamp. The cursor can be on a
5821 year, month, day, hour or minute. When the timestamp contains a time range
5822 like @samp{15:30-16:30}, modifying the first time will also shift the second,
5823 shifting the time block with constant length. To change the length, modify
5824 the second time. Note that if the cursor is in a headline and not at a
5825 timestamp, these same keys modify the priority of an item.
5826 (@pxref{Priorities}). The key bindings also conflict with shift-selection and
5827 related modes (@pxref{Conflicts}).
5829 @orgcmd{C-c C-y,org-evaluate-time-range}
5830 @cindex evaluate time range
5831 Evaluate a time range by computing the difference between start and end.
5832 With a prefix argument, insert result after the time range (in a table: into
5833 the following column).
5838 * The date/time prompt:: How Org mode helps you entering date and time
5839 * Custom time format:: Making dates look different
5842 @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps
5843 @subsection The date/time prompt
5844 @cindex date, reading in minibuffer
5845 @cindex time, reading in minibuffer
5847 @vindex org-read-date-prefer-future
5848 When Org mode prompts for a date/time, the default is shown in default
5849 date/time format, and the prompt therefore seems to ask for a specific
5850 format. But it will in fact accept date/time information in a variety of
5851 formats. Generally, the information should start at the beginning of the
5852 string. Org mode will find whatever information is in
5853 there and derive anything you have not specified from the @emph{default date
5854 and time}. The default is usually the current date and time, but when
5855 modifying an existing timestamp, or when entering the second stamp of a
5856 range, it is taken from the stamp in the buffer. When filling in
5857 information, Org mode assumes that most of the time you will want to enter a
5858 date in the future: if you omit the month/year and the given day/month is
5859 @i{before} today, it will assume that you mean a future date@footnote{See the
5860 variable @code{org-read-date-prefer-future}. You may set that variable to
5861 the symbol @code{time} to even make a time before now shift the date to
5862 tomorrow.}. If the date has been automatically shifted into the future, the
5863 time prompt will show this with @samp{(=>F).}
5865 For example, let's assume that today is @b{June 13, 2006}. Here is how
5866 various inputs will be interpreted, the items filled in by Org mode are
5870 3-2-5 @result{} 2003-02-05
5871 2/5/3 @result{} 2003-02-05
5872 14 @result{} @b{2006}-@b{06}-14
5873 12 @result{} @b{2006}-@b{07}-12
5874 2/5 @result{} @b{2007}-02-05
5875 Fri @result{} nearest Friday (default date or later)
5876 sep 15 @result{} @b{2006}-09-15
5877 feb 15 @result{} @b{2007}-02-15
5878 sep 12 9 @result{} 2009-09-12
5879 12:45 @result{} @b{2006}-@b{06}-@b{13} 12:45
5880 22 sept 0:34 @result{} @b{2006}-09-22 0:34
5881 w4 @result{} ISO week for of the current year @b{2006}
5882 2012 w4 fri @result{} Friday of ISO week 4 in 2012
5883 2012-w04-5 @result{} Same as above
5886 Furthermore you can specify a relative date by giving, as the @emph{first}
5887 thing in the input: a plus/minus sign, a number and a letter ([hdwmy]) to
5888 indicate change in hours, days, weeks, months, or years. With a single plus
5889 or minus, the date is always relative to today. With a double plus or minus,
5890 it is relative to the default date. If instead of a single letter, you use
5891 the abbreviation of day name, the date will be the Nth such day, e.g.:
5896 +4d @result{} four days from today
5897 +4 @result{} same as above
5898 +2w @result{} two weeks from today
5899 ++5 @result{} five days from default date
5900 +2tue @result{} second Tuesday from now.
5903 @vindex parse-time-months
5904 @vindex parse-time-weekdays
5905 The function understands English month and weekday abbreviations. If
5906 you want to use unabbreviated names and/or other languages, configure
5907 the variables @code{parse-time-months} and @code{parse-time-weekdays}.
5909 @vindex org-read-date-force-compatible-dates
5910 Not all dates can be represented in a given Emacs implementation. By default
5911 Org mode forces dates into the compatibility range 1970--2037 which works on
5912 all Emacs implementations. If you want to use dates outside of this range,
5913 read the docstring of the variable
5914 @code{org-read-date-force-compatible-dates}.
5916 You can specify a time range by giving start and end times or by giving a
5917 start time and a duration (in HH:MM format). Use one or two dash(es) as the
5918 separator in the former case and use '+' as the separator in the latter
5922 11am-1:15pm @result{} 11:00-13:15
5923 11am--1:15pm @result{} same as above
5924 11am+2:15 @result{} same as above
5927 @cindex calendar, for selecting date
5928 @vindex org-popup-calendar-for-date-prompt
5929 Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
5930 you don't need/want the calendar, configure the variable
5931 @code{org-popup-calendar-for-date-prompt}.}. When you exit the date
5932 prompt, either by clicking on a date in the calendar, or by pressing
5933 @key{RET}, the date selected in the calendar will be combined with the
5934 information entered at the prompt. You can control the calendar fully
5935 from the minibuffer:
5942 @kindex S-@key{right}
5943 @kindex S-@key{left}
5944 @kindex S-@key{down}
5946 @kindex M-S-@key{right}
5947 @kindex M-S-@key{left}
5950 @key{RET} @r{Choose date at cursor in calendar.}
5951 mouse-1 @r{Select date by clicking on it.}
5952 S-@key{right}/@key{left} @r{One day forward/backward.}
5953 S-@key{down}/@key{up} @r{One week forward/backward.}
5954 M-S-@key{right}/@key{left} @r{One month forward/backward.}
5955 > / < @r{Scroll calendar forward/backward by one month.}
5956 M-v / C-v @r{Scroll calendar forward/backward by 3 months.}
5959 @vindex org-read-date-display-live
5960 The actions of the date/time prompt may seem complex, but I assure you they
5961 will grow on you, and you will start getting annoyed by pretty much any other
5962 way of entering a date/time out there. To help you understand what is going
5963 on, the current interpretation of your input will be displayed live in the
5964 minibuffer@footnote{If you find this distracting, turn the display of with
5965 @code{org-read-date-display-live}.}.
5967 @node Custom time format, , The date/time prompt, Creating timestamps
5968 @subsection Custom time format
5969 @cindex custom date/time format
5970 @cindex time format, custom
5971 @cindex date format, custom
5973 @vindex org-display-custom-times
5974 @vindex org-time-stamp-custom-formats
5975 Org mode uses the standard ISO notation for dates and times as it is
5976 defined in ISO 8601. If you cannot get used to this and require another
5977 representation of date and time to keep you happy, you can get it by
5978 customizing the variables @code{org-display-custom-times} and
5979 @code{org-time-stamp-custom-formats}.
5982 @orgcmd{C-c C-x C-t,org-toggle-time-stamp-overlays}
5983 Toggle the display of custom formats for dates and times.
5987 Org mode needs the default format for scanning, so the custom date/time
5988 format does not @emph{replace} the default format---instead it is put
5989 @emph{over} the default format using text properties. This has the
5990 following consequences:
5993 You cannot place the cursor onto a timestamp anymore, only before or
5996 The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
5997 each component of a timestamp. If the cursor is at the beginning of
5998 the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
5999 just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the
6000 time will be changed by one minute.
6002 If the timestamp contains a range of clock times or a repeater, these
6003 will not be overlaid, but remain in the buffer as they were.
6005 When you delete a timestamp character-by-character, it will only
6006 disappear from the buffer after @emph{all} (invisible) characters
6007 belonging to the ISO timestamp have been removed.
6009 If the custom timestamp format is longer than the default and you are
6010 using dates in tables, table alignment will be messed up. If the custom
6011 format is shorter, things do work as expected.
6015 @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times
6016 @section Deadlines and scheduling
6018 A timestamp may be preceded by special keywords to facilitate planning:
6022 @cindex DEADLINE keyword
6024 Meaning: the task (most likely a TODO item, though not necessarily) is supposed
6025 to be finished on that date.
6027 @vindex org-deadline-warning-days
6028 @vindex org-agenda-skip-deadline-prewarning-if-scheduled
6029 On the deadline date, the task will be listed in the agenda. In
6030 addition, the agenda for @emph{today} will carry a warning about the
6031 approaching or missed deadline, starting
6032 @code{org-deadline-warning-days} before the due date, and continuing
6033 until the entry is marked DONE@. An example:
6036 *** TODO write article about the Earth for the Guide
6037 DEADLINE: <2004-02-29 Sun>
6038 The editor in charge is [[bbdb:Ford Prefect]]
6041 You can specify a different lead time for warnings for a specific
6042 deadlines using the following syntax. Here is an example with a warning
6043 period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}. This warning is
6044 deactivated if the task get scheduled and you set
6045 @code{org-agenda-skip-deadline-prewarning-if-scheduled} to @code{t}.
6048 @cindex SCHEDULED keyword
6050 Meaning: you are planning to start working on that task on the given
6053 @vindex org-agenda-skip-scheduled-if-done
6054 The headline will be listed under the given date@footnote{It will still
6055 be listed on that date after it has been marked DONE@. If you don't like
6056 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In
6057 addition, a reminder that the scheduled date has passed will be present
6058 in the compilation for @emph{today}, until the entry is marked DONE, i.e.,
6059 the task will automatically be forwarded until completed.
6062 *** TODO Call Trillian for a date on New Years Eve.
6063 SCHEDULED: <2004-12-25 Sat>
6066 @vindex org-scheduled-delay-days
6067 @vindex org-agenda-skip-scheduled-delay-if-deadline
6068 If you want to @emph{delay} the display of this task in the agenda, use
6069 @code{SCHEDULED: <2004-12-25 Sat -2d>}: the task is still scheduled on the
6070 25th but will appear two days later. In case the task contains a repeater,
6071 the delay is considered to affect all occurrences; if you want the delay to
6072 only affect the first scheduled occurrence of the task, use @code{--2d}
6073 instead. See @code{org-scheduled-delay-days} and
6074 @code{org-agenda-skip-scheduled-delay-if-deadline} for details on how to
6075 control this globally or per agenda.
6078 @b{Important:} Scheduling an item in Org mode should @i{not} be
6079 understood in the same way that we understand @i{scheduling a meeting}.
6080 Setting a date for a meeting is just a simple appointment, you should
6081 mark this entry with a simple plain timestamp, to get this item shown
6082 on the date where it applies. This is a frequent misunderstanding by
6083 Org users. In Org mode, @i{scheduling} means setting a date when you
6084 want to start working on an action item.
6087 You may use timestamps with repeaters in scheduling and deadline
6088 entries. Org mode will issue early and late warnings based on the
6089 assumption that the timestamp represents the @i{nearest instance} of
6090 the repeater. However, the use of diary sexp entries like
6092 @code{<%%(diary-float t 42)>}
6094 in scheduling and deadline timestamps is limited. Org mode does not
6095 know enough about the internals of each sexp function to issue early and
6096 late warnings. However, it will show the item on each day where the
6100 * Inserting deadline/schedule:: Planning items
6101 * Repeated tasks:: Items that show up again and again
6104 @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling
6105 @subsection Inserting deadlines or schedules
6107 The following commands allow you to quickly insert@footnote{The @samp{SCHEDULED} and
6108 @samp{DEADLINE} dates are inserted on the line right below the headline. Don't put
6109 any text between this line and the headline.} a deadline or to schedule
6114 @orgcmd{C-c C-d,org-deadline}
6115 Insert @samp{DEADLINE} keyword along with a stamp. The insertion will happen
6116 in the line directly following the headline. Any CLOSED timestamp will be
6117 removed. When called with a prefix arg, an existing deadline will be removed
6118 from the entry. Depending on the variable @code{org-log-redeadline}@footnote{with corresponding
6119 @code{#+STARTUP} keywords @code{logredeadline}, @code{lognoteredeadline},
6120 and @code{nologredeadline}}, a note will be taken when changing an existing
6123 @orgcmd{C-c C-s,org-schedule}
6124 Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will
6125 happen in the line directly following the headline. Any CLOSED timestamp
6126 will be removed. When called with a prefix argument, remove the scheduling
6127 date from the entry. Depending on the variable
6128 @code{org-log-reschedule}@footnote{with corresponding @code{#+STARTUP}
6129 keywords @code{logreschedule}, @code{lognotereschedule}, and
6130 @code{nologreschedule}}, a note will be taken when changing an existing
6133 @orgcmd{C-c C-x C-k,org-mark-entry-for-agenda-action}
6136 Mark the current entry for agenda action. After you have marked the entry
6137 like this, you can open the agenda or the calendar to find an appropriate
6138 date. With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to
6139 schedule the marked item.
6141 @orgcmd{C-c / d,org-check-deadlines}
6142 @cindex sparse tree, for deadlines
6143 @vindex org-deadline-warning-days
6144 Create a sparse tree with all deadlines that are either past-due, or
6145 which will become due within @code{org-deadline-warning-days}.
6146 With @kbd{C-u} prefix, show all deadlines in the file. With a numeric
6147 prefix, check that many days. For example, @kbd{C-1 C-c / d} shows
6148 all deadlines due tomorrow.
6150 @orgcmd{C-c / b,org-check-before-date}
6151 Sparse tree for deadlines and scheduled items before a given date.
6153 @orgcmd{C-c / a,org-check-after-date}
6154 Sparse tree for deadlines and scheduled items after a given date.
6157 Note that @code{org-schedule} and @code{org-deadline} supports
6158 setting the date by indicating a relative time: e.g., +1d will set
6159 the date to the next day after today, and --1w will set the date
6160 to the previous week before any current timestamp.
6162 @node Repeated tasks, , Inserting deadline/schedule, Deadlines and scheduling
6163 @subsection Repeated tasks
6164 @cindex tasks, repeated
6165 @cindex repeated tasks
6167 Some tasks need to be repeated again and again. Org mode helps to
6168 organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
6169 or plain timestamp. In the following example
6171 ** TODO Pay the rent
6172 DEADLINE: <2005-10-01 Sat +1m>
6175 the @code{+1m} is a repeater; the intended interpretation is that the task
6176 has a deadline on <2005-10-01> and repeats itself every (one) month starting
6177 from that time. You can use yearly, monthly, weekly, daily and hourly repeat
6178 cookies by using the @code{y/w/m/d/h} letters. If you need both a repeater
6179 and a special warning period in a deadline entry, the repeater should come
6180 first and the warning period last: @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
6182 @vindex org-todo-repeat-to-state
6183 Deadlines and scheduled items produce entries in the agenda when they are
6184 over-due, so it is important to be able to mark such an entry as completed
6185 once you have done so. When you mark a DEADLINE or a SCHEDULE with the TODO
6186 keyword DONE, it will no longer produce entries in the agenda. The problem
6187 with this is, however, that then also the @emph{next} instance of the
6188 repeated entry will not be active. Org mode deals with this in the following
6189 way: When you try to mark such an entry DONE (using @kbd{C-c C-t}), it will
6190 shift the base date of the repeating timestamp by the repeater interval, and
6191 immediately set the entry state back to TODO@footnote{In fact, the target
6192 state is taken from, in this sequence, the @code{REPEAT_TO_STATE} property or
6193 the variable @code{org-todo-repeat-to-state}. If neither of these is
6194 specified, the target state defaults to the first state of the TODO state
6195 sequence.}. In the example above, setting the state to DONE would actually
6196 switch the date like this:
6199 ** TODO Pay the rent
6200 DEADLINE: <2005-11-01 Tue +1m>
6203 @vindex org-log-repeat
6204 A timestamp@footnote{You can change this using the option
6205 @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
6206 @code{lognoterepeat}, and @code{nologrepeat}. With @code{lognoterepeat}, you
6207 will also be prompted for a note.} will be added under the deadline, to keep
6208 a record that you actually acted on the previous instance of this deadline.
6210 As a consequence of shifting the base date, this entry will no longer be
6211 visible in the agenda when checking past dates, but all future instances
6214 With the @samp{+1m} cookie, the date shift will always be exactly one
6215 month. So if you have not paid the rent for three months, marking this
6216 entry DONE will still keep it as an overdue deadline. Depending on the
6217 task, this may not be the best way to handle it. For example, if you
6218 forgot to call your father for 3 weeks, it does not make sense to call
6219 him 3 times in a single day to make up for it. Finally, there are tasks
6220 like changing batteries which should always repeat a certain time
6221 @i{after} the last time you did it. For these tasks, Org mode has
6222 special repeaters @samp{++} and @samp{.+}. For example:
6226 DEADLINE: <2008-02-10 Sun ++1w>
6227 Marking this DONE will shift the date by at least one week,
6228 but also by as many weeks as it takes to get this date into
6229 the future. However, it stays on a Sunday, even if you called
6230 and marked it done on Saturday.
6231 ** TODO Check the batteries in the smoke detectors
6232 DEADLINE: <2005-11-01 Tue .+1m>
6233 Marking this DONE will shift the date to one month after
6237 @vindex org-agenda-skip-scheduled-if-deadline-is-shown
6238 You may have both scheduling and deadline information for a specific task.
6239 If the repeater is set for the scheduling information only, you probably want
6240 the repeater to be ignored after the deadline. If so, set the variable
6241 @code{org-agenda-skip-scheduled-if-deadline-is-shown} to
6242 @code{repeated-after-deadline}. If you want both scheduling and deadline
6243 information to repeat after the same interval, set the same repeater for both
6246 An alternative to using a repeater is to create a number of copies of a task
6247 subtree, with dates shifted in each copy. The command @kbd{C-c C-x c} was
6248 created for this purpose, it is described in @ref{Structure editing}.
6251 @node Clocking work time, Effort estimates, Deadlines and scheduling, Dates and Times
6252 @section Clocking work time
6253 @cindex clocking time
6254 @cindex time clocking
6256 Org mode allows you to clock the time you spend on specific tasks in a
6257 project. When you start working on an item, you can start the clock. When
6258 you stop working on that task, or when you mark the task done, the clock is
6259 stopped and the corresponding time interval is recorded. It also computes
6260 the total time spent on each subtree@footnote{Clocking only works if all
6261 headings are indented with less than 30 stars. This is a hardcoded
6262 limitation of `lmax' in `org-clock-sum'.} of a project. And it remembers a
6263 history or tasks recently clocked, to that you can jump quickly between a
6264 number of tasks absorbing your time.
6266 To save the clock history across Emacs sessions, use
6268 (setq org-clock-persist 'history)
6269 (org-clock-persistence-insinuate)
6271 When you clock into a new task after resuming Emacs, the incomplete
6272 clock@footnote{To resume the clock under the assumption that you have worked
6273 on this task while outside Emacs, use @code{(setq org-clock-persist t)}.}
6274 will be found (@pxref{Resolving idle time}) and you will be prompted about
6278 * Clocking commands:: Starting and stopping a clock
6279 * The clock table:: Detailed reports
6280 * Resolving idle time:: Resolving time when you've been idle
6283 @node Clocking commands, The clock table, Clocking work time, Clocking work time
6284 @subsection Clocking commands
6287 @orgcmd{C-c C-x C-i,org-clock-in}
6288 @vindex org-clock-into-drawer
6289 @vindex org-clock-continuously
6290 @cindex property, LOG_INTO_DRAWER
6291 Start the clock on the current item (clock-in). This inserts the CLOCK
6292 keyword together with a timestamp. If this is not the first clocking of
6293 this item, the multiple CLOCK lines will be wrapped into a
6294 @code{:LOGBOOK:} drawer (see also the variable
6295 @code{org-clock-into-drawer}). You can also overrule
6296 the setting of this variable for a subtree by setting a
6297 @code{CLOCK_INTO_DRAWER} or @code{LOG_INTO_DRAWER} property.
6298 When called with a @kbd{C-u} prefix argument,
6299 select the task from a list of recently clocked tasks. With two @kbd{C-u
6300 C-u} prefixes, clock into the task at point and mark it as the default task;
6301 the default task will then always be available with letter @kbd{d} when
6302 selecting a clocking task. With three @kbd{C-u C-u C-u} prefixes, force
6303 continuous clocking by starting the clock when the last clock stopped.@*
6304 @cindex property: CLOCK_MODELINE_TOTAL
6305 @cindex property: LAST_REPEAT
6306 @vindex org-clock-modeline-total
6307 While the clock is running, the current clocking time is shown in the mode
6308 line, along with the title of the task. The clock time shown will be all
6309 time ever clocked for this task and its children. If the task has an effort
6310 estimate (@pxref{Effort estimates}), the mode line displays the current
6311 clocking time against it@footnote{To add an effort estimate ``on the fly'',
6312 hook a function doing this to @code{org-clock-in-prepare-hook}.} If the task
6313 is a repeating one (@pxref{Repeated tasks}), only the time since the last
6314 reset of the task @footnote{as recorded by the @code{LAST_REPEAT} property}
6315 will be shown. More control over what time is shown can be exercised with
6316 the @code{CLOCK_MODELINE_TOTAL} property. It may have the values
6317 @code{current} to show only the current clocking instance, @code{today} to
6318 show all time clocked on this tasks today (see also the variable
6319 @code{org-extend-today-until}), @code{all} to include all time, or
6320 @code{auto} which is the default@footnote{See also the variable
6321 @code{org-clock-modeline-total}.}.@* Clicking with @kbd{mouse-1} onto the
6322 mode line entry will pop up a menu with clocking options.
6324 @orgcmd{C-c C-x C-o,org-clock-out}
6325 @vindex org-log-note-clock-out
6326 Stop the clock (clock-out). This inserts another timestamp at the same
6327 location where the clock was last started. It also directly computes
6328 the resulting time in inserts it after the time range as @samp{=>
6329 HH:MM}. See the variable @code{org-log-note-clock-out} for the
6330 possibility to record an additional note together with the clock-out
6331 timestamp@footnote{The corresponding in-buffer setting is:
6332 @code{#+STARTUP: lognoteclock-out}}.
6333 @orgcmd{C-c C-x C-x,org-clock-in-last}
6334 @vindex org-clock-continuously
6335 Reclock the last clocked task. With one @kbd{C-u} prefix argument,
6336 select the task from the clock history. With two @kbd{C-u} prefixes,
6337 force continuous clocking by starting the clock when the last clock
6339 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6340 Update the effort estimate for the current clock task.
6343 @orgcmdkkc{C-c C-c,C-c C-y,org-evaluate-time-range}
6344 Recompute the time interval after changing one of the timestamps. This
6345 is only necessary if you edit the timestamps directly. If you change
6346 them with @kbd{S-@key{cursor}} keys, the update is automatic.
6347 @orgcmd{C-S-@key{up/down},org-clock-timestamps-up/down}
6348 On @code{CLOCK} log lines, increase/decrease both timestamps so that the
6349 clock duration keeps the same.
6350 @orgcmd{S-M-@key{up/down},org-timestamp-up/down}
6351 On @code{CLOCK} log lines, increase/decrease the timestamp at point and
6352 the one of the previous (or the next clock) timestamp by the same duration.
6353 For example, if you hit @kbd{S-M-@key{up}} to increase a clocked-out timestamp
6354 by five minutes, then the clocked-in timestamp of the next clock will be
6355 increased by five minutes.
6356 @orgcmd{C-c C-t,org-todo}
6357 Changing the TODO state of an item to DONE automatically stops the clock
6358 if it is running in this same item.
6359 @orgcmd{C-c C-x C-q,org-clock-cancel}
6360 Cancel the current clock. This is useful if a clock was started by
6361 mistake, or if you ended up working on something else.
6362 @orgcmd{C-c C-x C-j,org-clock-goto}
6363 Jump to the headline of the currently clocked in task. With a @kbd{C-u}
6364 prefix arg, select the target task from a list of recently clocked tasks.
6365 @orgcmd{C-c C-x C-d,org-clock-display}
6366 @vindex org-remove-highlights-with-change
6367 Display time summaries for each subtree in the current buffer. This puts
6368 overlays at the end of each headline, showing the total time recorded under
6369 that heading, including the time of any subheadings. You can use visibility
6370 cycling to study the tree, but the overlays disappear when you change the
6371 buffer (see variable @code{org-remove-highlights-with-change}) or press
6375 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
6376 the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
6377 worked on or closed during a day.
6379 @strong{Important:} note that both @code{org-clock-out} and
6380 @code{org-clock-in-last} can have a global keybinding and will not
6381 modify the window disposition.
6383 @node The clock table, Resolving idle time, Clocking commands, Clocking work time
6384 @subsection The clock table
6385 @cindex clocktable, dynamic block
6386 @cindex report, of clocked time
6388 Org mode can produce quite complex reports based on the time clocking
6389 information. Such a report is called a @emph{clock table}, because it is
6390 formatted as one or several Org tables.
6393 @orgcmd{C-c C-x C-r,org-clock-report}
6394 Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
6395 report as an Org mode table into the current file. When the cursor is
6396 at an existing clock table, just update it. When called with a prefix
6397 argument, jump to the first clock report in the current document and
6398 update it. The clock table always includes also trees with
6399 @code{:ARCHIVE:} tag.
6400 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
6401 Update dynamic block at point. The cursor needs to be in the
6402 @code{#+BEGIN} line of the dynamic block.
6403 @orgkey{C-u C-c C-x C-u}
6404 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
6405 you have several clock table blocks in a buffer.
6406 @orgcmdkxkc{S-@key{left},S-@key{right},org-clocktable-try-shift}
6407 Shift the current @code{:block} interval and update the table. The cursor
6408 needs to be in the @code{#+BEGIN: clocktable} line for this command. If
6409 @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
6413 Here is an example of the frame for a clock table as it is inserted into the
6414 buffer with the @kbd{C-c C-x C-r} command:
6416 @cindex #+BEGIN, clocktable
6418 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
6422 @vindex org-clocktable-defaults
6423 The @samp{BEGIN} line and specify a number of options to define the scope,
6424 structure, and formatting of the report. Defaults for all these options can
6425 be configured in the variable @code{org-clocktable-defaults}.
6427 @noindent First there are options that determine which clock entries are to
6430 :maxlevel @r{Maximum level depth to which times are listed in the table.}
6431 @r{Clocks at deeper levels will be summed into the upper level.}
6432 :scope @r{The scope to consider. This can be any of the following:}
6433 nil @r{the current buffer or narrowed region}
6434 file @r{the full current buffer}
6435 subtree @r{the subtree where the clocktable is located}
6436 tree@var{N} @r{the surrounding level @var{N} tree, for example @code{tree3}}
6437 tree @r{the surrounding level 1 tree}
6438 agenda @r{all agenda files}
6439 ("file"..) @r{scan these files}
6440 file-with-archives @r{current file and its archives}
6441 agenda-with-archives @r{all agenda files, including archives}
6442 :block @r{The time block to consider. This block is specified either}
6443 @r{absolute, or relative to the current time and may be any of}
6445 2007-12-31 @r{New year eve 2007}
6446 2007-12 @r{December 2007}
6447 2007-W50 @r{ISO-week 50 in 2007}
6448 2007-Q2 @r{2nd quarter in 2007}
6449 2007 @r{the year 2007}
6450 today, yesterday, today-@var{N} @r{a relative day}
6451 thisweek, lastweek, thisweek-@var{N} @r{a relative week}
6452 thismonth, lastmonth, thismonth-@var{N} @r{a relative month}
6453 thisyear, lastyear, thisyear-@var{N} @r{a relative year}
6454 @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
6455 :tstart @r{A time string specifying when to start considering times.}
6456 @r{Relative times like @code{"<-2w>"} can also be used. See}
6457 @r{@ref{Matching tags and properties} for relative time syntax.}
6458 :tend @r{A time string specifying when to stop considering times.}
6459 @r{Relative times like @code{"<now>"} can also be used. See}
6460 @r{@ref{Matching tags and properties} for relative time syntax.}
6461 :wstart @r{The starting day of the week. The default is 1 for monday.}
6462 :mstart @r{The starting day of the month. The default 1 is for the first}
6463 @r{day of the month.}
6464 :step @r{@code{week} or @code{day}, to split the table into chunks.}
6465 @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
6466 :stepskip0 @r{Do not show steps that have zero time.}
6467 :fileskip0 @r{Do not show table sections from files which did not contribute.}
6468 :tags @r{A tags match to select entries that should contribute. See}
6469 @r{@ref{Matching tags and properties} for the match syntax.}
6472 Then there are options which determine the formatting of the table. There
6473 options are interpreted by the function @code{org-clocktable-write-default},
6474 but you can specify your own function using the @code{:formatter} parameter.
6476 :emphasize @r{When @code{t}, emphasize level one and level two items.}
6477 :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".}
6478 :link @r{Link the item headlines in the table to their origins.}
6479 :narrow @r{An integer to limit the width of the headline column in}
6480 @r{the org table. If you write it like @samp{50!}, then the}
6481 @r{headline will also be shortened in export.}
6482 :indent @r{Indent each headline field according to its level.}
6483 :tcolumns @r{Number of columns to be used for times. If this is smaller}
6484 @r{than @code{:maxlevel}, lower levels will be lumped into one column.}
6485 :level @r{Should a level number column be included?}
6486 :compact @r{Abbreviation for @code{:level nil :indent t :narrow 40! :tcolumns 1}}
6487 @r{All are overwritten except if there is an explicit @code{:narrow}}
6488 :timestamp @r{A timestamp for the entry, when available. Look for SCHEDULED,}
6489 @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.}
6490 :properties @r{List of properties that should be shown in the table. Each}
6491 @r{property will get its own column.}
6492 :inherit-props @r{When this flag is @code{t}, the values for @code{:properties} will be inherited.}
6493 :formula @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
6494 @r{As a special case, @samp{:formula %} adds a column with % time.}
6495 @r{If you do not specify a formula here, any existing formula}
6496 @r{below the clock table will survive updates and be evaluated.}
6497 :formatter @r{A function to format clock data and insert it into the buffer.}
6499 To get a clock summary of the current level 1 tree, for the current
6500 day, you could write
6502 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
6506 and to use a specific time range you could write@footnote{Note that all
6507 parameters must be specified in a single line---the line is broken here
6508 only to fit it into the manual.}
6510 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
6511 :tend "<2006-08-10 Thu 12:00>"
6514 A range starting a week ago and ending right now could be written as
6516 #+BEGIN: clocktable :tstart "<-1w>" :tend "<now>"
6519 A summary of the current subtree with % times would be
6521 #+BEGIN: clocktable :scope subtree :link t :formula %
6524 A horizontally compact representation of everything clocked during last week
6527 #+BEGIN: clocktable :scope agenda :block lastweek :compact t
6531 @node Resolving idle time, , The clock table, Clocking work time
6532 @subsection Resolving idle time and continuous clocking
6534 @subsubheading Resolving idle time
6535 @cindex resolve idle time
6536 @vindex org-clock-x11idle-program-name
6538 @cindex idle, resolve, dangling
6539 If you clock in on a work item, and then walk away from your
6540 computer---perhaps to take a phone call---you often need to ``resolve'' the
6541 time you were away by either subtracting it from the current clock, or
6542 applying it to another one.
6544 @vindex org-clock-idle-time
6545 By customizing the variable @code{org-clock-idle-time} to some integer, such
6546 as 10 or 15, Emacs can alert you when you get back to your computer after
6547 being idle for that many minutes@footnote{On computers using Mac OS X,
6548 idleness is based on actual user idleness, not just Emacs' idle time. For
6549 X11, you can install a utility program @file{x11idle.c}, available in the
6550 @code{contrib/scripts} directory of the Org git distribution, or install the
6551 @file{xprintidle} package and set it to the variable
6552 @code{org-clock-x11idle-program-name} if you are running Debian, to get the
6553 same general treatment of idleness. On other systems, idle time refers to
6554 Emacs idle time only.}, and ask what you want to do with the idle time.
6555 There will be a question waiting for you when you get back, indicating how
6556 much idle time has passed (constantly updated with the current amount), as
6557 well as a set of choices to correct the discrepancy:
6561 To keep some or all of the minutes and stay clocked in, press @kbd{k}. Org
6562 will ask how many of the minutes to keep. Press @key{RET} to keep them all,
6563 effectively changing nothing, or enter a number to keep that many minutes.
6565 If you use the shift key and press @kbd{K}, it will keep however many minutes
6566 you request and then immediately clock out of that task. If you keep all of
6567 the minutes, this is the same as just clocking out of the current task.
6569 To keep none of the minutes, use @kbd{s} to subtract all the away time from
6570 the clock, and then check back in from the moment you returned.
6572 To keep none of the minutes and just clock out at the start of the away time,
6573 use the shift key and press @kbd{S}. Remember that using shift will always
6574 leave you clocked out, no matter which option you choose.
6576 To cancel the clock altogether, use @kbd{C}. Note that if instead of
6577 canceling you subtract the away time, and the resulting clock amount is less
6578 than a minute, the clock will still be canceled rather than clutter up the
6579 log with an empty entry.
6582 What if you subtracted those away minutes from the current clock, and now
6583 want to apply them to a new clock? Simply clock in to any task immediately
6584 after the subtraction. Org will notice that you have subtracted time ``on
6585 the books'', so to speak, and will ask if you want to apply those minutes to
6586 the next task you clock in on.
6588 There is one other instance when this clock resolution magic occurs. Say you
6589 were clocked in and hacking away, and suddenly your cat chased a mouse who
6590 scared a hamster that crashed into your UPS's power button! You suddenly
6591 lose all your buffers, but thanks to auto-save you still have your recent Org
6592 mode changes, including your last clock in.
6594 If you restart Emacs and clock into any task, Org will notice that you have a
6595 dangling clock which was never clocked out from your last session. Using
6596 that clock's starting time as the beginning of the unaccounted-for period,
6597 Org will ask how you want to resolve that time. The logic and behavior is
6598 identical to dealing with away time due to idleness; it is just happening due
6599 to a recovery event rather than a set amount of idle time.
6601 You can also check all the files visited by your Org agenda for dangling
6602 clocks at any time using @kbd{M-x org-resolve-clocks RET} (or @kbd{C-c C-x C-z}).
6604 @subsubheading Continuous clocking
6605 @cindex continuous clocking
6606 @vindex org-clock-continuously
6608 You may want to start clocking from the time when you clocked out the
6609 previous task. To enable this systematically, set @code{org-clock-continuously}
6610 to @code{t}. Each time you clock in, Org retrieves the clock-out time of the
6611 last clocked entry for this session, and start the new clock from there.
6613 If you only want this from time to time, use three universal prefix arguments
6614 with @code{org-clock-in} and two @kbd{C-u C-u} with @code{org-clock-in-last}.
6616 @node Effort estimates, Relative timer, Clocking work time, Dates and Times
6617 @section Effort estimates
6618 @cindex effort estimates
6620 @cindex property, Effort
6621 @vindex org-effort-property
6622 If you want to plan your work in a very detailed way, or if you need to
6623 produce offers with quotations of the estimated work effort, you may want to
6624 assign effort estimates to entries. If you are also clocking your work, you
6625 may later want to compare the planned effort with the actual working time, a
6626 great way to improve planning estimates. Effort estimates are stored in a
6627 special property @samp{Effort}@footnote{You may change the property being
6628 used with the variable @code{org-effort-property}.}. You can set the effort
6629 for an entry with the following commands:
6632 @orgcmd{C-c C-x e,org-set-effort}
6633 Set the effort estimate for the current entry. With a numeric prefix
6634 argument, set it to the Nth allowed value (see below). This command is also
6635 accessible from the agenda with the @kbd{e} key.
6636 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6637 Modify the effort estimate of the item currently being clocked.
6640 Clearly the best way to work with effort estimates is through column view
6641 (@pxref{Column view}). You should start by setting up discrete values for
6642 effort estimates, and a @code{COLUMNS} format that displays these values
6643 together with clock sums (if you want to clock your time). For a specific
6647 #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00
6648 #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
6652 @vindex org-global-properties
6653 @vindex org-columns-default-format
6654 or, even better, you can set up these values globally by customizing the
6655 variables @code{org-global-properties} and @code{org-columns-default-format}.
6656 In particular if you want to use this setup also in the agenda, a global
6657 setup may be advised.
6659 The way to assign estimates to individual items is then to switch to column
6660 mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
6661 value. The values you enter will immediately be summed up in the hierarchy.
6662 In the column next to it, any clocked time will be displayed.
6664 @vindex org-agenda-columns-add-appointments-to-effort-sum
6665 If you switch to column view in the daily/weekly agenda, the effort column
6666 will summarize the estimated work effort for each day@footnote{Please note
6667 the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
6668 column view}).}, and you can use this to find space in your schedule. To get
6669 an overview of the entire part of the day that is committed, you can set the
6670 option @code{org-agenda-columns-add-appointments-to-effort-sum}. The
6671 appointments on a day that take place over a specified time interval will
6672 then also be added to the load estimate of the day.
6674 Effort estimates can be used in secondary agenda filtering that is triggered
6675 with the @kbd{/} key in the agenda (@pxref{Agenda commands}). If you have
6676 these estimates defined consistently, two or three key presses will narrow
6677 down the list to stuff that fits into an available time slot.
6679 @node Relative timer, Countdown timer, Effort estimates, Dates and Times
6680 @section Taking notes with a relative timer
6681 @cindex relative timer
6683 When taking notes during, for example, a meeting or a video viewing, it can
6684 be useful to have access to times relative to a starting time. Org provides
6685 such a relative timer and make it easy to create timed notes.
6688 @orgcmd{C-c C-x .,org-timer}
6689 Insert a relative time into the buffer. The first time you use this, the
6690 timer will be started. When called with a prefix argument, the timer is
6692 @orgcmd{C-c C-x -,org-timer-item}
6693 Insert a description list item with the current relative time. With a prefix
6694 argument, first reset the timer to 0.
6695 @orgcmd{M-@key{RET},org-insert-heading}
6696 Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
6698 @c for key sequences with a comma, command name macros fail :(
6701 Pause the timer, or continue it if it is already paused
6702 (@command{org-timer-pause-or-continue}).
6703 @c removed the sentence because it is redundant to the following item
6704 @kindex C-u C-c C-x ,
6706 Stop the timer. After this, you can only start a new timer, not continue the
6707 old one. This command also removes the timer from the mode line.
6708 @orgcmd{C-c C-x 0,org-timer-start}
6709 Reset the timer without inserting anything into the buffer. By default, the
6710 timer is reset to 0. When called with a @kbd{C-u} prefix, reset the timer to
6711 specific starting offset. The user is prompted for the offset, with a
6712 default taken from a timer string at point, if any, So this can be used to
6713 restart taking notes after a break in the process. When called with a double
6714 prefix argument @kbd{C-u C-u}, change all timer strings in the active region
6715 by a certain amount. This can be used to fix timer strings if the timer was
6716 not started at exactly the right moment.
6719 @node Countdown timer, , Relative timer, Dates and Times
6720 @section Countdown timer
6721 @cindex Countdown timer
6725 Calling @code{org-timer-set-timer} from an Org mode buffer runs a countdown
6726 timer. Use @kbd{;} from agenda buffers, @key{C-c C-x ;} everywhere else.
6728 @code{org-timer-set-timer} prompts the user for a duration and displays a
6729 countdown timer in the modeline. @code{org-timer-default-timer} sets the
6730 default countdown value. Giving a prefix numeric argument overrides this
6733 @node Capture - Refile - Archive, Agenda Views, Dates and Times, Top
6734 @chapter Capture - Refile - Archive
6737 An important part of any organization system is the ability to quickly
6738 capture new ideas and tasks, and to associate reference material with them.
6739 Org does this using a process called @i{capture}. It also can store files
6740 related to a task (@i{attachments}) in a special directory. Once in the
6741 system, tasks and projects need to be moved around. Moving completed project
6742 trees to an archive file keeps the system compact and fast.
6745 * Capture:: Capturing new stuff
6746 * Attachments:: Add files to tasks
6747 * RSS Feeds:: Getting input from RSS feeds
6748 * Protocols:: External (e.g., Browser) access to Emacs and Org
6749 * Refile and copy:: Moving/copying a tree from one place to another
6750 * Archiving:: What to do with finished projects
6753 @node Capture, Attachments, Capture - Refile - Archive, Capture - Refile - Archive
6757 Capture lets you quickly store notes with little interruption of your work
6758 flow. Org's method for capturing new items is heavily inspired by John
6759 Wiegley excellent @code{remember.el} package. Up to version 6.36, Org
6760 used a special setup for @file{remember.el}, then replaced it with
6761 @file{org-remember.el}. As of version 8.0, @file{org-remember.el} has
6762 been completely replaced by @file{org-capture.el}.
6764 If your configuration depends on @file{org-remember.el}, you need to update
6765 it and use the setup described below. To convert your
6766 @code{org-remember-templates}, run the command
6768 @kbd{M-x org-capture-import-remember-templates @key{RET}}
6770 @noindent and then customize the new variable with @kbd{M-x
6771 customize-variable org-capture-templates}, check the result, and save the
6775 * Setting up capture:: Where notes will be stored
6776 * Using capture:: Commands to invoke and terminate capture
6777 * Capture templates:: Define the outline of different note types
6780 @node Setting up capture, Using capture, Capture, Capture
6781 @subsection Setting up capture
6783 The following customization sets a default target file for notes, and defines
6784 a global key@footnote{Please select your own key, @kbd{C-c c} is only a
6785 suggestion.} for capturing new material.
6787 @vindex org-default-notes-file
6790 (setq org-default-notes-file (concat org-directory "/notes.org"))
6791 (define-key global-map "\C-cc" 'org-capture)
6795 @node Using capture, Capture templates, Setting up capture, Capture
6796 @subsection Using capture
6799 @orgcmd{C-c c,org-capture}
6800 Call the command @code{org-capture}. Note that this keybinding is global and
6801 not active by default: you need to install it. If you have templates
6803 defined @pxref{Capture templates}, it will offer these templates for
6804 selection or use a new Org outline node as the default template. It will
6805 insert the template into the target file and switch to an indirect buffer
6806 narrowed to this new node. You may then insert the information you want.
6808 @orgcmd{C-c C-c,org-capture-finalize}
6809 Once you have finished entering information into the capture buffer, @kbd{C-c
6810 C-c} will return you to the window configuration before the capture process,
6811 so that you can resume your work without further distraction. When called
6812 with a prefix arg, finalize and then jump to the captured item.
6814 @orgcmd{C-c C-w,org-capture-refile}
6815 Finalize the capture process by refiling (@pxref{Refile and copy}) the note to
6816 a different place. Please realize that this is a normal refiling command
6817 that will be executed---so the cursor position at the moment you run this
6818 command is important. If you have inserted a tree with a parent and
6819 children, first move the cursor back to the parent. Any prefix argument
6820 given to this command will be passed on to the @code{org-refile} command.
6822 @orgcmd{C-c C-k,org-capture-kill}
6823 Abort the capture process and return to the previous state.
6827 You can also call @code{org-capture} in a special way from the agenda, using
6828 the @kbd{k c} key combination. With this access, any timestamps inserted by
6829 the selected capture template will default to the cursor date in the agenda,
6830 rather than to the current date.
6832 To find the locations of the last stored capture, use @code{org-capture} with
6837 Visit the target location of a capture template. You get to select the
6838 template in the usual way.
6839 @orgkey{C-u C-u C-c c}
6840 Visit the last stored capture item in its buffer.
6843 @vindex org-capture-bookmark
6844 @cindex org-capture-last-stored
6845 You can also jump to the bookmark @code{org-capture-last-stored}, which will
6846 automatically be created unless you set @code{org-capture-bookmark} to
6849 To insert the capture at point in an Org buffer, call @code{org-capture} with
6850 a @code{C-0} prefix argument.
6852 @node Capture templates, , Using capture, Capture
6853 @subsection Capture templates
6854 @cindex templates, for Capture
6856 You can use templates for different types of capture items, and
6857 for different target locations. The easiest way to create such templates is
6858 through the customize interface.
6862 Customize the variable @code{org-capture-templates}.
6865 Before we give the formal description of template definitions, let's look at
6866 an example. Say you would like to use one template to create general TODO
6867 entries, and you want to put these entries under the heading @samp{Tasks} in
6868 your file @file{~/org/gtd.org}. Also, a date tree in the file
6869 @file{journal.org} should capture journal entries. A possible configuration
6874 (setq org-capture-templates
6875 '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks")
6876 "* TODO %?\n %i\n %a")
6877 ("j" "Journal" entry (file+datetree "~/org/journal.org")
6878 "* %?\nEntered on %U\n %i\n %a")))
6882 @noindent If you then press @kbd{C-c c t}, Org will prepare the template
6886 [[file:@var{link to where you initiated capture}]]
6890 During expansion of the template, @code{%a} has been replaced by a link to
6891 the location from where you called the capture command. This can be
6892 extremely useful for deriving tasks from emails, for example. You fill in
6893 the task definition, press @code{C-c C-c} and Org returns you to the same
6894 place where you started the capture process.
6896 To define special keys to capture to a particular template without going
6897 through the interactive template selection, you can create your key binding
6901 (define-key global-map "\C-cx"
6902 (lambda () (interactive) (org-capture nil "x")))
6906 * Template elements:: What is needed for a complete template entry
6907 * Template expansion:: Filling in information about time and context
6908 * Templates in contexts:: Only show a template in a specific context
6911 @node Template elements, Template expansion, Capture templates, Capture templates
6912 @subsubsection Template elements
6914 Now lets look at the elements of a template definition. Each entry in
6915 @code{org-capture-templates} is a list with the following items:
6919 The keys that will select the template, as a string, characters
6920 only, for example @code{"a"} for a template to be selected with a
6921 single key, or @code{"bt"} for selection with two keys. When using
6922 several keys, keys using the same prefix key must be sequential
6923 in the list and preceded by a 2-element entry explaining the
6924 prefix key, for example
6926 ("b" "Templates for marking stuff to buy")
6928 @noindent If you do not define a template for the @kbd{C} key, this key will
6929 be used to open the customize buffer for this complex variable.
6932 A short string describing the template, which will be shown during
6936 The type of entry, a symbol. Valid values are:
6940 An Org mode node, with a headline. Will be filed as the child of the target
6941 entry or as a top-level entry. The target file should be an Org mode file.
6943 A plain list item, placed in the first plain list at the target
6944 location. Again the target file should be an Org file.
6946 A checkbox item. This only differs from the plain list item by the
6949 a new line in the first table at the target location. Where exactly the
6950 line will be inserted depends on the properties @code{:prepend} and
6951 @code{:table-line-pos} (see below).
6953 Text to be inserted as it is.
6957 @vindex org-default-notes-file
6958 Specification of where the captured item should be placed. In Org mode
6959 files, targets usually define a node. Entries will become children of this
6960 node. Other types will be added to the table or list in the body of this
6961 node. Most target specifications contain a file name. If that file name is
6962 the empty string, it defaults to @code{org-default-notes-file}. A file can
6963 also be given as a variable, function, or Emacs Lisp form.
6968 @item (file "path/to/file")
6969 Text will be placed at the beginning or end of that file.
6971 @item (id "id of existing org entry")
6972 Filing as child of this entry, or in the body of the entry.
6974 @item (file+headline "path/to/file" "node headline")
6975 Fast configuration if the target heading is unique in the file.
6977 @item (file+olp "path/to/file" "Level 1 heading" "Level 2" ...)
6978 For non-unique headings, the full path is safer.
6980 @item (file+regexp "path/to/file" "regexp to find location")
6981 Use a regular expression to position the cursor.
6983 @item (file+datetree "path/to/file")
6984 Will create a heading in a date tree for today's date.
6986 @item (file+datetree+prompt "path/to/file")
6987 Will create a heading in a date tree, but will prompt for the date.
6989 @item (file+function "path/to/file" function-finding-location)
6990 A function to find the right location in the file.
6993 File to the entry that is currently being clocked.
6995 @item (function function-finding-location)
6996 Most general way, write your own function to find both
7001 The template for creating the capture item. If you leave this empty, an
7002 appropriate default template will be used. Otherwise this is a string with
7003 escape codes, which will be replaced depending on time and context of the
7004 capture call. The string with escapes may be loaded from a template file,
7005 using the special syntax @code{(file "path/to/template")}. See below for
7009 The rest of the entry is a property list of additional options.
7010 Recognized properties are:
7014 Normally new captured information will be appended at
7015 the target location (last child, last table line, last list item...).
7016 Setting this property will change that.
7018 @item :immediate-finish
7019 When set, do not offer to edit the information, just
7020 file it away immediately. This makes sense if the template only needs
7021 information that can be added automatically.
7024 Set this to the number of lines to insert
7025 before and after the new item. Default 0, only common other value is 1.
7028 Start the clock in this item.
7031 Keep the clock running when filing the captured entry.
7034 If starting the capture interrupted a clock, restart that clock when finished
7035 with the capture. Note that @code{:clock-keep} has precedence over
7036 @code{:clock-resume}. When setting both to @code{t}, the current clock will
7037 run and the previous one will not be resumed.
7040 Do not narrow the target buffer, simply show the full buffer. Default is to
7041 narrow it so that you only see the new material.
7043 @item :table-line-pos
7044 Specification of the location in the table where the new line should be
7045 inserted. It should be a string like @code{"II-3"} meaning that the new
7046 line should become the third line before the second horizontal separator
7050 If the target file was not yet visited when capture was invoked, kill the
7051 buffer again after capture is completed.
7055 @node Template expansion, Templates in contexts, Template elements, Capture templates
7056 @subsubsection Template expansion
7058 In the template itself, special @kbd{%}-escapes@footnote{If you need one of
7059 these sequences literally, escape the @kbd{%} with a backslash.} allow
7060 dynamic insertion of content. The templates are expanded in the order given here:
7063 %[@var{file}] @r{Insert the contents of the file given by @var{file}.}
7064 %(@var{sexp}) @r{Evaluate Elisp @var{sexp} and replace with the result.}
7065 @r{For convenience, %:keyword (see below) placeholders}
7066 @r{within the expression will be expanded prior to this.}
7067 @r{The sexp must return a string.}
7068 %<...> @r{The result of format-time-string on the ... format specification.}
7069 %t @r{Timestamp, date only.}
7070 %T @r{Timestamp, with date and time.}
7071 %u, %U @r{Like the above, but inactive timestamps.}
7072 %i @r{Initial content, the region when capture is called while the}
7073 @r{region is active.}
7074 @r{The entire text will be indented like @code{%i} itself.}
7075 %a @r{Annotation, normally the link created with @code{org-store-link}.}
7076 %A @r{Like @code{%a}, but prompt for the description part.}
7077 %l @r{Like %a, but only insert the literal link.}
7078 %c @r{Current kill ring head.}
7079 %x @r{Content of the X clipboard.}
7080 %k @r{Title of the currently clocked task.}
7081 %K @r{Link to the currently clocked task.}
7082 %n @r{User name (taken from @code{user-full-name}).}
7083 %f @r{File visited by current buffer when org-capture was called.}
7084 %F @r{Full path of the file or directory visited by current buffer.}
7085 %:keyword @r{Specific information for certain link types, see below.}
7086 %^g @r{Prompt for tags, with completion on tags in target file.}
7087 %^G @r{Prompt for tags, with completion all tags in all agenda files.}
7088 %^t @r{Like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}.}
7089 @r{You may define a prompt like @code{%^@{Birthday@}t}.}
7090 %^C @r{Interactive selection of which kill or clip to use.}
7091 %^L @r{Like @code{%^C}, but insert as link.}
7092 %^@{@var{prop}@}p @r{Prompt the user for a value for property @var{prop}.}
7093 %^@{@var{prompt}@} @r{prompt the user for a string and replace this sequence with it.}
7094 @r{You may specify a default value and a completion table with}
7095 @r{%^@{prompt|default|completion2|completion3...@}.}
7096 @r{The arrow keys access a prompt-specific history.}
7097 %\n @r{Insert the text entered at the nth %^@{@var{prompt}@}, where @code{n} is}
7098 @r{a number, starting from 1.}
7099 %? @r{After completing the template, position cursor here.}
7103 For specific link types, the following keywords will be
7104 defined@footnote{If you define your own link types (@pxref{Adding
7105 hyperlink types}), any property you store with
7106 @code{org-store-link-props} can be accessed in capture templates in a
7109 @vindex org-from-is-user-regexp
7111 Link type | Available keywords
7112 ---------------------------------+----------------------------------------------
7113 bbdb | %:name %:company
7114 irc | %:server %:port %:nick
7115 vm, vm-imap, wl, mh, mew, rmail | %:type %:subject %:message-id
7116 | %:from %:fromname %:fromaddress
7117 | %:to %:toname %:toaddress
7118 | %:date @r{(message date header field)}
7119 | %:date-timestamp @r{(date as active timestamp)}
7120 | %:date-timestamp-inactive @r{(date as inactive timestamp)}
7121 | %: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}.}}
7122 gnus | %:group, @r{for messages also all email fields}
7124 info | %:file %:node
7129 To place the cursor after template expansion use:
7132 %? @r{After completing the template, position cursor here.}
7135 @node Templates in contexts, , Template expansion, Capture templates
7136 @subsubsection Templates in contexts
7138 @vindex org-capture-templates-contexts
7139 To control whether a capture template should be accessible from a specific
7140 context, you can customize @var{org-capture-templates-contexts}. Let's say
7141 for example that you have a capture template @code{"p"} for storing Gnus
7142 emails containing patches. Then you would configure this option like this:
7145 (setq org-capture-templates-contexts
7146 '(("p" (in-mode . "message-mode"))))
7149 You can also tell that the command key @code{"p"} should refer to another
7150 template. In that case, add this command key like this:
7153 (setq org-capture-templates-contexts
7154 '(("p" "q" (in-mode . "message-mode"))))
7157 See the docstring of the variable for more information.
7159 @node Attachments, RSS Feeds, Capture, Capture - Refile - Archive
7160 @section Attachments
7163 @vindex org-attach-directory
7164 It is often useful to associate reference material with an outline node/task.
7165 Small chunks of plain text can simply be stored in the subtree of a project.
7166 Hyperlinks (@pxref{Hyperlinks}) can establish associations with
7167 files that live elsewhere on your computer or in the cloud, like emails or
7168 source code files belonging to a project. Another method is @i{attachments},
7169 which are files located in a directory belonging to an outline node. Org
7170 uses directories named by the unique ID of each entry. These directories are
7171 located in the @file{data} directory which lives in the same directory where
7172 your Org file lives@footnote{If you move entries or Org files from one
7173 directory to another, you may want to configure @code{org-attach-directory}
7174 to contain an absolute path.}. If you initialize this directory with
7175 @code{git init}, Org will automatically commit changes when it sees them.
7176 The attachment system has been contributed to Org by John Wiegley.
7178 In cases where it seems better to do so, you can also attach a directory of your
7179 choice to an entry. You can also make children inherit the attachment
7180 directory from a parent, so that an entire subtree uses the same attached
7183 @noindent The following commands deal with attachments:
7186 @orgcmd{C-c C-a,org-attach}
7187 The dispatcher for commands related to the attachment system. After these
7188 keys, a list of commands is displayed and you must press an additional key
7189 to select a command:
7192 @orgcmdtkc{a,C-c C-a a,org-attach-attach}
7193 @vindex org-attach-method
7194 Select a file and move it into the task's attachment directory. The file
7195 will be copied, moved, or linked, depending on @code{org-attach-method}.
7196 Note that hard links are not supported on all systems.
7202 Attach a file using the copy/move/link method.
7203 Note that hard links are not supported on all systems.
7205 @orgcmdtkc{n,C-c C-a n,org-attach-new}
7206 Create a new attachment as an Emacs buffer.
7208 @orgcmdtkc{z,C-c C-a z,org-attach-sync}
7209 Synchronize the current task with its attachment directory, in case you added
7210 attachments yourself.
7212 @orgcmdtkc{o,C-c C-a o,org-attach-open}
7213 @vindex org-file-apps
7214 Open current task's attachment. If there is more than one, prompt for a
7215 file name first. Opening will follow the rules set by @code{org-file-apps}.
7216 For more details, see the information on following hyperlinks
7217 (@pxref{Handling links}).
7219 @orgcmdtkc{O,C-c C-a O,org-attach-open-in-emacs}
7220 Also open the attachment, but force opening the file in Emacs.
7222 @orgcmdtkc{f,C-c C-a f,org-attach-reveal}
7223 Open the current task's attachment directory.
7225 @orgcmdtkc{F,C-c C-a F,org-attach-reveal-in-emacs}
7226 Also open the directory, but force using @command{dired} in Emacs.
7228 @orgcmdtkc{d,C-c C-a d,org-attach-delete-one}
7229 Select and delete a single attachment.
7231 @orgcmdtkc{D,C-c C-a D,org-attach-delete-all}
7232 Delete all of a task's attachments. A safer way is to open the directory in
7233 @command{dired} and delete from there.
7235 @orgcmdtkc{s,C-c C-a s,org-attach-set-directory}
7236 @cindex property, ATTACH_DIR
7237 Set a specific directory as the entry's attachment directory. This works by
7238 putting the directory path into the @code{ATTACH_DIR} property.
7240 @orgcmdtkc{i,C-c C-a i,org-attach-set-inherit}
7241 @cindex property, ATTACH_DIR_INHERIT
7242 Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
7243 same directory for attachments as the parent does.
7247 @node RSS Feeds, Protocols, Attachments, Capture - Refile - Archive
7252 Org can add and change entries based on information found in RSS feeds and
7253 Atom feeds. You could use this to make a task out of each new podcast in a
7254 podcast feed. Or you could use a phone-based note-creating service on the
7255 web to import tasks into Org. To access feeds, configure the variable
7256 @code{org-feed-alist}. The docstring of this variable has detailed
7257 information. Here is just an example:
7261 (setq org-feed-alist
7263 "http://rss.slashdot.org/Slashdot/slashdot"
7264 "~/txt/org/feeds.org" "Slashdot Entries")))
7269 will configure that new items from the feed provided by
7270 @code{rss.slashdot.org} will result in new entries in the file
7271 @file{~/org/feeds.org} under the heading @samp{Slashdot Entries}, whenever
7272 the following command is used:
7275 @orgcmd{C-c C-x g,org-feed-update-all}
7277 Collect items from the feeds configured in @code{org-feed-alist} and act upon
7279 @orgcmd{C-c C-x G,org-feed-goto-inbox}
7280 Prompt for a feed name and go to the inbox configured for this feed.
7283 Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which
7284 it will store information about the status of items in the feed, to avoid
7285 adding the same item several times. You should add @samp{FEEDSTATUS} to the
7286 list of drawers in that file:
7289 #+DRAWERS: LOGBOOK PROPERTIES FEEDSTATUS
7292 For more information, including how to read atom feeds, see
7293 @file{org-feed.el} and the docstring of @code{org-feed-alist}.
7295 @node Protocols, Refile and copy, RSS Feeds, Capture - Refile - Archive
7296 @section Protocols for external access
7297 @cindex protocols, for external access
7300 You can set up Org for handling protocol calls from outside applications that
7301 are passed to Emacs through the @file{emacsserver}. For example, you can
7302 configure bookmarks in your web browser to send a link to the current page to
7303 Org and create a note from it using capture (@pxref{Capture}). Or you
7304 could create a bookmark that will tell Emacs to open the local source file of
7305 a remote website you are looking at with the browser. See
7306 @uref{http://orgmode.org/worg/org-contrib/org-protocol.php} for detailed
7307 documentation and setup instructions.
7309 @node Refile and copy, Archiving, Protocols, Capture - Refile - Archive
7310 @section Refile and copy
7311 @cindex refiling notes
7312 @cindex copying notes
7314 When reviewing the captured data, you may want to refile or to copy some of
7315 the entries into a different list, for example into a project. Cutting,
7316 finding the right location, and then pasting the note is cumbersome. To
7317 simplify this process, you can use the following special command:
7320 @orgcmd{C-c M-w,org-copy}
7322 Copying works like refiling, except that the original note is not deleted.
7323 @orgcmd{C-c C-w,org-refile}
7325 @vindex org-reverse-note-order
7326 @vindex org-refile-targets
7327 @vindex org-refile-use-outline-path
7328 @vindex org-outline-path-complete-in-steps
7329 @vindex org-refile-allow-creating-parent-nodes
7330 @vindex org-log-refile
7331 @vindex org-refile-use-cache
7332 Refile the entry or region at point. This command offers possible locations
7333 for refiling the entry and lets you select one with completion. The item (or
7334 all items in the region) is filed below the target heading as a subitem.
7335 Depending on @code{org-reverse-note-order}, it will be either the first or
7337 By default, all level 1 headlines in the current buffer are considered to be
7338 targets, but you can have more complex definitions across a number of files.
7339 See the variable @code{org-refile-targets} for details. If you would like to
7340 select a location via a file-path-like completion along the outline path, see
7341 the variables @code{org-refile-use-outline-path} and
7342 @code{org-outline-path-complete-in-steps}. If you would like to be able to
7343 create new nodes as new parents for refiling on the fly, check the
7344 variable @code{org-refile-allow-creating-parent-nodes}.
7345 When the variable @code{org-log-refile}@footnote{with corresponding
7346 @code{#+STARTUP} keywords @code{logrefile}, @code{lognoterefile},
7347 and @code{nologrefile}} is set, a timestamp or a note will be
7348 recorded when an entry has been refiled.
7349 @orgkey{C-u C-c C-w}
7350 Use the refile interface to jump to a heading.
7351 @orgcmd{C-u C-u C-c C-w,org-refile-goto-last-stored}
7352 Jump to the location where @code{org-refile} last moved a tree to.
7354 Refile as the child of the item currently being clocked.
7355 @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}
7356 Clear the target cache. Caching of refile targets can be turned on by
7357 setting @code{org-refile-use-cache}. To make the command see new possible
7358 targets, you have to clear the cache with this command.
7361 @node Archiving, , Refile and copy, Capture - Refile - Archive
7365 When a project represented by a (sub)tree is finished, you may want
7366 to move the tree out of the way and to stop it from contributing to the
7367 agenda. Archiving is important to keep your working files compact and global
7368 searches like the construction of agenda views fast.
7371 @orgcmd{C-c C-x C-a,org-archive-subtree-default}
7372 @vindex org-archive-default-command
7373 Archive the current entry using the command specified in the variable
7374 @code{org-archive-default-command}.
7378 * Moving subtrees:: Moving a tree to an archive file
7379 * Internal archiving:: Switch off a tree but keep it in the file
7382 @node Moving subtrees, Internal archiving, Archiving, Archiving
7383 @subsection Moving a tree to the archive file
7384 @cindex external archiving
7386 The most common archiving action is to move a project tree to another file,
7390 @orgcmdkskc{C-c C-x C-s,C-c $,org-archive-subtree}
7391 @vindex org-archive-location
7392 Archive the subtree starting at the cursor position to the location
7393 given by @code{org-archive-location}.
7394 @orgkey{C-u C-c C-x C-s}
7395 Check if any direct children of the current headline could be moved to
7396 the archive. To do this, each subtree is checked for open TODO entries.
7397 If none are found, the command offers to move it to the archive
7398 location. If the cursor is @emph{not} on a headline when this command
7399 is invoked, the level 1 trees will be checked.
7402 @cindex archive locations
7403 The default archive location is a file in the same directory as the
7404 current file, with the name derived by appending @file{_archive} to the
7405 current file name. You can also choose what heading to file archived
7406 items under, with the possibility to add them to a datetree in a file.
7407 For information and examples on how to specify the file and the heading,
7408 see the documentation string of the variable
7409 @code{org-archive-location}.
7411 There is also an in-buffer option for setting this variable, for
7412 example@footnote{For backward compatibility, the following also works:
7413 If there are several such lines in a file, each specifies the archive
7414 location for the text below it. The first such line also applies to any
7415 text before its definition. However, using this method is
7416 @emph{strongly} deprecated as it is incompatible with the outline
7417 structure of the document. The correct method for setting multiple
7418 archive locations in a buffer is using properties.}:
7422 #+ARCHIVE: %s_done::
7425 @cindex property, ARCHIVE
7427 If you would like to have a special ARCHIVE location for a single entry
7428 or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
7429 location as the value (@pxref{Properties and Columns}).
7431 @vindex org-archive-save-context-info
7432 When a subtree is moved, it receives a number of special properties that
7433 record context information like the file from where the entry came, its
7434 outline path the archiving time etc. Configure the variable
7435 @code{org-archive-save-context-info} to adjust the amount of information
7439 @node Internal archiving, , Moving subtrees, Archiving
7440 @subsection Internal archiving
7442 If you want to just switch off (for agenda views) certain subtrees without
7443 moving them to a different file, you can use the @code{ARCHIVE tag}.
7445 A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
7446 its location in the outline tree, but behaves in the following way:
7449 @vindex org-cycle-open-archived-trees
7450 It does not open when you attempt to do so with a visibility cycling
7451 command (@pxref{Visibility cycling}). You can force cycling archived
7452 subtrees with @kbd{C-@key{TAB}}, or by setting the option
7453 @code{org-cycle-open-archived-trees}. Also normal outline commands like
7454 @code{show-all} will open archived subtrees.
7456 @vindex org-sparse-tree-open-archived-trees
7457 During sparse tree construction (@pxref{Sparse trees}), matches in
7458 archived subtrees are not exposed, unless you configure the option
7459 @code{org-sparse-tree-open-archived-trees}.
7461 @vindex org-agenda-skip-archived-trees
7462 During agenda view construction (@pxref{Agenda Views}), the content of
7463 archived trees is ignored unless you configure the option
7464 @code{org-agenda-skip-archived-trees}, in which case these trees will always
7465 be included. In the agenda you can press @kbd{v a} to get archives
7466 temporarily included.
7468 @vindex org-export-with-archived-trees
7469 Archived trees are not exported (@pxref{Exporting}), only the headline
7470 is. Configure the details using the variable
7471 @code{org-export-with-archived-trees}.
7473 @vindex org-columns-skip-archived-trees
7474 Archived trees are excluded from column view unless the variable
7475 @code{org-columns-skip-archived-trees} is configured to @code{nil}.
7478 The following commands help manage the ARCHIVE tag:
7481 @orgcmd{C-c C-x a,org-toggle-archive-tag}
7482 Toggle the ARCHIVE tag for the current headline. When the tag is set,
7483 the headline changes to a shadowed face, and the subtree below it is
7485 @orgkey{C-u C-c C-x a}
7486 Check if any direct children of the current headline should be archived.
7487 To do this, each subtree is checked for open TODO entries. If none are
7488 found, the command offers to set the ARCHIVE tag for the child. If the
7489 cursor is @emph{not} on a headline when this command is invoked, the
7490 level 1 trees will be checked.
7491 @orgcmd{C-@kbd{TAB},org-force-cycle-archived}
7492 Cycle a tree even if it is tagged with ARCHIVE.
7493 @orgcmd{C-c C-x A,org-archive-to-archive-sibling}
7494 Move the current entry to the @emph{Archive Sibling}. This is a sibling of
7495 the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}. The
7496 entry becomes a child of that sibling and in this way retains a lot of its
7497 original context, including inherited tags and approximate position in the
7502 @node Agenda Views, Markup, Capture - Refile - Archive, Top
7503 @chapter Agenda views
7504 @cindex agenda views
7506 Due to the way Org works, TODO items, time-stamped items, and
7507 tagged headlines can be scattered throughout a file or even a number of
7508 files. To get an overview of open action items, or of events that are
7509 important for a particular date, this information must be collected,
7510 sorted and displayed in an organized way.
7512 Org can select items based on various criteria and display them
7513 in a separate buffer. Seven different view types are provided:
7517 an @emph{agenda} that is like a calendar and shows information
7520 a @emph{TODO list} that covers all unfinished
7523 a @emph{match view}, showings headlines based on the tags, properties, and
7524 TODO state associated with them,
7526 a @emph{timeline view} that shows all events in a single Org file,
7527 in time-sorted view,
7529 a @emph{text search view} that shows all entries from multiple files
7530 that contain specified keywords,
7532 a @emph{stuck projects view} showing projects that currently don't move
7535 @emph{custom views} that are special searches and combinations of different
7540 The extracted information is displayed in a special @emph{agenda
7541 buffer}. This buffer is read-only, but provides commands to visit the
7542 corresponding locations in the original Org files, and even to
7543 edit these files remotely.
7545 @vindex org-agenda-window-setup
7546 @vindex org-agenda-restore-windows-after-quit
7547 Two variables control how the agenda buffer is displayed and whether the
7548 window configuration is restored when the agenda exits:
7549 @code{org-agenda-window-setup} and
7550 @code{org-agenda-restore-windows-after-quit}.
7553 * Agenda files:: Files being searched for agenda information
7554 * Agenda dispatcher:: Keyboard access to agenda views
7555 * Built-in agenda views:: What is available out of the box?
7556 * Presentation and sorting:: How agenda items are prepared for display
7557 * Agenda commands:: Remote editing of Org trees
7558 * Custom agenda views:: Defining special searches and views
7559 * Exporting Agenda Views:: Writing a view to a file
7560 * Agenda column view:: Using column view for collected entries
7563 @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views
7564 @section Agenda files
7565 @cindex agenda files
7566 @cindex files for agenda
7568 @vindex org-agenda-files
7569 The information to be shown is normally collected from all @emph{agenda
7570 files}, the files listed in the variable
7571 @code{org-agenda-files}@footnote{If the value of that variable is not a
7572 list, but a single file name, then the list of agenda files will be
7573 maintained in that external file.}. If a directory is part of this list,
7574 all files with the extension @file{.org} in this directory will be part
7577 Thus, even if you only work with a single Org file, that file should
7578 be put into the list@footnote{When using the dispatcher, pressing
7579 @kbd{<} before selecting a command will actually limit the command to
7580 the current file, and ignore @code{org-agenda-files} until the next
7581 dispatcher command.}. You can customize @code{org-agenda-files}, but
7582 the easiest way to maintain it is through the following commands
7584 @cindex files, adding to agenda list
7586 @orgcmd{C-c [,org-agenda-file-to-front}
7587 Add current file to the list of agenda files. The file is added to
7588 the front of the list. If it was already in the list, it is moved to
7589 the front. With a prefix argument, file is added/moved to the end.
7590 @orgcmd{C-c ],org-remove-file}
7591 Remove current file from the list of agenda files.
7593 @cindex cycling, of agenda files
7594 @orgcmd{C-',org-cycle-agenda-files}
7596 Cycle through agenda file list, visiting one file after the other.
7597 @kindex M-x org-iswitchb
7598 @item M-x org-iswitchb
7599 Command to use an @code{iswitchb}-like interface to switch to and between Org
7604 The Org menu contains the current list of files and can be used
7605 to visit any of them.
7607 If you would like to focus the agenda temporarily on a file not in
7608 this list, or on just one file in the list, or even on only a subtree in a
7609 file, then this can be done in different ways. For a single agenda command,
7610 you may press @kbd{<} once or several times in the dispatcher
7611 (@pxref{Agenda dispatcher}). To restrict the agenda scope for an
7612 extended period, use the following commands:
7615 @orgcmd{C-c C-x <,org-agenda-set-restriction-lock}
7616 Permanently restrict the agenda to the current subtree. When with a
7617 prefix argument, or with the cursor before the first headline in a file,
7618 the agenda scope is set to the entire file. This restriction remains in
7619 effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
7620 or @kbd{>} in the agenda dispatcher. If there is a window displaying an
7621 agenda view, the new restriction takes effect immediately.
7622 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
7623 Remove the permanent restriction created by @kbd{C-c C-x <}.
7627 When working with @file{speedbar.el}, you can use the following commands in
7631 @orgcmdtkc{< @r{in the speedbar frame},<,org-speedbar-set-agenda-restriction}
7632 Permanently restrict the agenda to the item---either an Org file or a subtree
7633 in such a file---at the cursor in the Speedbar frame.
7634 If there is a window displaying an agenda view, the new restriction takes
7636 @orgcmdtkc{> @r{in the speedbar frame},>,org-agenda-remove-restriction-lock}
7637 Lift the restriction.
7640 @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views
7641 @section The agenda dispatcher
7642 @cindex agenda dispatcher
7643 @cindex dispatching agenda commands
7644 The views are created through a dispatcher, which should be bound to a
7645 global key---for example @kbd{C-c a} (@pxref{Activation}). In the
7646 following we will assume that @kbd{C-c a} is indeed how the dispatcher
7647 is accessed and list keyboard access to commands accordingly. After
7648 pressing @kbd{C-c a}, an additional letter is required to execute a
7649 command. The dispatcher offers the following default commands:
7653 Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
7655 Create a list of all TODO items (@pxref{Global TODO list}).
7657 Create a list of headlines matching a TAGS expression (@pxref{Matching
7658 tags and properties}).
7660 Create the timeline view for the current buffer (@pxref{Timeline}).
7662 Create a list of entries selected by a boolean expression of keywords
7663 and/or regular expressions that must or must not occur in the entry.
7665 @vindex org-agenda-text-search-extra-files
7666 Search for a regular expression in all agenda files and additionally in
7667 the files listed in @code{org-agenda-text-search-extra-files}. This
7668 uses the Emacs command @code{multi-occur}. A prefix argument can be
7669 used to specify the number of context lines for each match, default is
7672 Create a list of stuck projects (@pxref{Stuck projects}).
7674 Restrict an agenda command to the current buffer@footnote{For backward
7675 compatibility, you can also press @kbd{1} to restrict to the current
7676 buffer.}. After pressing @kbd{<}, you still need to press the character
7677 selecting the command.
7679 If there is an active region, restrict the following agenda command to
7680 the region. Otherwise, restrict it to the current subtree@footnote{For
7681 backward compatibility, you can also press @kbd{0} to restrict to the
7682 current region/subtree.}. After pressing @kbd{< <}, you still need to press the
7683 character selecting the command.
7686 @vindex org-agenda-sticky
7687 Toggle sticky agenda views. By default, Org maintains only a single agenda
7688 buffer and rebuilds it each time you change the view, to make sure everything
7689 is always up to date. If you switch between views often and the build time
7690 bothers you, you can turn on sticky agenda buffers (make this the default by
7691 customizing the variable @code{org-agenda-sticky}). With sticky agendas, the
7692 dispatcher only switches to the selected view, you need to update it by hand
7693 with @kbd{r} or @kbd{g}. You can toggle sticky agenda view any time with
7694 @code{org-toggle-sticky-agenda}.
7697 You can also define custom commands that will be accessible through the
7698 dispatcher, just like the default commands. This includes the
7699 possibility to create extended agenda buffers that contain several
7700 blocks together, for example the weekly agenda, the global TODO list and
7701 a number of special tags matches. @xref{Custom agenda views}.
7703 @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda Views
7704 @section The built-in agenda views
7706 In this section we describe the built-in views.
7709 * Weekly/daily agenda:: The calendar page with current tasks
7710 * Global TODO list:: All unfinished action items
7711 * Matching tags and properties:: Structured information with fine-tuned search
7712 * Timeline:: Time-sorted view for single file
7713 * Search view:: Find entries by searching for text
7714 * Stuck projects:: Find projects you need to review
7717 @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views
7718 @subsection The weekly/daily agenda
7720 @cindex weekly agenda
7721 @cindex daily agenda
7723 The purpose of the weekly/daily @emph{agenda} is to act like a page of a
7724 paper agenda, showing all the tasks for the current week or day.
7727 @cindex org-agenda, command
7728 @orgcmd{C-c a a,org-agenda-list}
7729 Compile an agenda for the current week from a list of Org files. The agenda
7730 shows the entries for each day. With a numeric prefix@footnote{For backward
7731 compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
7732 listed before the agenda. This feature is deprecated, use the dedicated TODO
7733 list, or a block agenda instead (@pxref{Block agenda}).} (like @kbd{C-u 2 1
7734 C-c a a}) you may set the number of days to be displayed.
7737 @vindex org-agenda-span
7738 @vindex org-agenda-ndays
7739 @vindex org-agenda-start-day
7740 @vindex org-agenda-start-on-weekday
7741 The default number of days displayed in the agenda is set by the variable
7742 @var{org-agenda-span} (or the obsolete @var{org-agenda-ndays}). This
7743 variable can be set to any number of days you want to see by default in the
7744 agenda, or to a span name, such as @code{day}, @code{week}, @code{month} or
7745 @code{year}. For weekly agendas, the default is to start on the previous
7746 monday (see @var{org-agenda-start-on-weekday}). You can also set the start
7747 date using a date shift: @code{(setq org-agenda-start-day "+10d")} will
7748 start the agenda ten days from today in the future.
7750 Remote editing from the agenda buffer means, for example, that you can
7751 change the dates of deadlines and appointments from the agenda buffer.
7752 The commands available in the Agenda buffer are listed in @ref{Agenda
7755 @subsubheading Calendar/Diary integration
7756 @cindex calendar integration
7757 @cindex diary integration
7759 Emacs contains the calendar and diary by Edward M. Reingold. The
7760 calendar displays a three-month calendar with holidays from different
7761 countries and cultures. The diary allows you to keep track of
7762 anniversaries, lunar phases, sunrise/set, recurrent appointments
7763 (weekly, monthly) and more. In this way, it is quite complementary to
7764 Org. It can be very useful to combine output from Org with
7767 In order to include entries from the Emacs diary into Org mode's
7768 agenda, you only need to customize the variable
7771 (setq org-agenda-include-diary t)
7774 @noindent After that, everything will happen automatically. All diary
7775 entries including holidays, anniversaries, etc., will be included in the
7776 agenda buffer created by Org mode. @key{SPC}, @key{TAB}, and
7777 @key{RET} can be used from the agenda buffer to jump to the diary
7778 file in order to edit existing diary entries. The @kbd{i} command to
7779 insert new entries for the current date works in the agenda buffer, as
7780 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
7781 Sunrise/Sunset times, show lunar phases and to convert to other
7782 calendars, respectively. @kbd{c} can be used to switch back and forth
7783 between calendar and agenda.
7785 If you are using the diary only for sexp entries and holidays, it is
7786 faster to not use the above setting, but instead to copy or even move
7787 the entries into an Org file. Org mode evaluates diary-style sexp
7788 entries, and does it faster because there is no overhead for first
7789 creating the diary display. Note that the sexp entries must start at
7790 the left margin, no whitespace is allowed before them. For example,
7791 the following segment of an Org file will be processed and entries
7792 will be made in the agenda:
7795 * Birthdays and similar stuff
7797 %%(org-calendar-holiday) ; special function for holiday names
7799 %%(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
7800 %%(org-anniversary 1869 10 2) Mahatma Gandhi would be %d years old
7803 @subsubheading Anniversaries from BBDB
7804 @cindex BBDB, anniversaries
7805 @cindex anniversaries, from BBDB
7807 If you are using the Big Brothers Database to store your contacts, you will
7808 very likely prefer to store anniversaries in BBDB rather than in a
7809 separate Org or diary file. Org supports this and will show BBDB
7810 anniversaries as part of the agenda. All you need to do is to add the
7811 following to one of your agenda files:
7818 %%(org-bbdb-anniversaries)
7821 You can then go ahead and define anniversaries for a BBDB record. Basically,
7822 you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB
7823 record and then add the date in the format @code{YYYY-MM-DD} or @code{MM-DD},
7824 followed by a space and the class of the anniversary (@samp{birthday} or
7825 @samp{wedding}, or a format string). If you omit the class, it will default to
7826 @samp{birthday}. Here are a few examples, the header for the file
7827 @file{org-bbdb.el} contains more detailed information.
7833 2008-04-14 %s released version 6.01 of org mode, %d years ago
7836 After a change to BBDB, or for the first agenda display during an Emacs
7837 session, the agenda display will suffer a short delay as Org updates its
7838 hash with anniversaries. However, from then on things will be very fast---much
7839 faster in fact than a long list of @samp{%%(diary-anniversary)} entries
7840 in an Org or Diary file.
7842 @subsubheading Appointment reminders
7843 @cindex @file{appt.el}
7844 @cindex appointment reminders
7848 Org can interact with Emacs appointments notification facility. To add the
7849 appointments of your agenda files, use the command @code{org-agenda-to-appt}.
7850 This command lets you filter through the list of your appointments and add
7851 only those belonging to a specific category or matching a regular expression.
7852 It also reads a @code{APPT_WARNTIME} property which will then override the
7853 value of @code{appt-message-warning-time} for this appointment. See the
7854 docstring for details.
7856 @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views
7857 @subsection The global TODO list
7858 @cindex global TODO list
7859 @cindex TODO list, global
7861 The global TODO list contains all unfinished TODO items formatted and
7862 collected into a single place.
7865 @orgcmd{C-c a t,org-todo-list}
7866 Show the global TODO list. This collects the TODO items from all agenda
7867 files (@pxref{Agenda Views}) into a single buffer. By default, this lists
7868 items with a state the is not a DONE state. The buffer is in
7869 @code{agenda-mode}, so there are commands to examine and manipulate the TODO
7870 entries directly from that buffer (@pxref{Agenda commands}).
7871 @orgcmd{C-c a T,org-todo-list}
7872 @cindex TODO keyword matching
7873 @vindex org-todo-keywords
7874 Like the above, but allows selection of a specific TODO keyword. You can
7875 also do this by specifying a prefix argument to @kbd{C-c a t}. You are
7876 prompted for a keyword, and you may also specify several keywords by
7877 separating them with @samp{|} as the boolean OR operator. With a numeric
7878 prefix, the Nth keyword in @code{org-todo-keywords} is selected.
7880 The @kbd{r} key in the agenda buffer regenerates it, and you can give
7881 a prefix argument to this command to change the selected TODO keyword,
7882 for example @kbd{3 r}. If you often need a search for a specific
7883 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
7884 Matching specific TODO keywords can also be done as part of a tags
7885 search (@pxref{Tag searches}).
7888 Remote editing of TODO items means that you can change the state of a
7889 TODO entry with a single key press. The commands available in the
7890 TODO list are described in @ref{Agenda commands}.
7892 @cindex sublevels, inclusion into TODO list
7893 Normally the global TODO list simply shows all headlines with TODO
7894 keywords. This list can become very long. There are two ways to keep
7898 @vindex org-agenda-todo-ignore-scheduled
7899 @vindex org-agenda-todo-ignore-deadlines
7900 @vindex org-agenda-todo-ignore-timestamp
7901 @vindex org-agenda-todo-ignore-with-date
7902 Some people view a TODO item that has been @emph{scheduled} for execution or
7903 have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}.
7904 Configure the variables @code{org-agenda-todo-ignore-scheduled},
7905 @code{org-agenda-todo-ignore-deadlines},
7906 @code{org-agenda-todo-ignore-timestamp} and/or
7907 @code{org-agenda-todo-ignore-with-date} to exclude such items from the global
7910 @vindex org-agenda-todo-list-sublevels
7911 TODO items may have sublevels to break up the task into subtasks. In
7912 such cases it may be enough to list only the highest level TODO headline
7913 and omit the sublevels from the global list. Configure the variable
7914 @code{org-agenda-todo-list-sublevels} to get this behavior.
7917 @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views
7918 @subsection Matching tags and properties
7919 @cindex matching, of tags
7920 @cindex matching, of properties
7924 If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}),
7925 or have properties (@pxref{Properties and Columns}), you can select headlines
7926 based on this metadata and collect them into an agenda buffer. The match
7927 syntax described here also applies when creating sparse trees with @kbd{C-c /
7931 @orgcmd{C-c a m,org-tags-view}
7932 Produce a list of all headlines that match a given set of tags. The
7933 command prompts for a selection criterion, which is a boolean logic
7934 expression with tags, like @samp{+work+urgent-withboss} or
7935 @samp{work|home} (@pxref{Tags}). If you often need a specific search,
7936 define a custom command for it (@pxref{Agenda dispatcher}).
7937 @orgcmd{C-c a M,org-tags-view}
7938 @vindex org-tags-match-list-sublevels
7939 @vindex org-agenda-tags-todo-honor-ignore-options
7940 Like @kbd{C-c a m}, but only select headlines that are also TODO items in a
7941 not-DONE state and force checking subitems (see variable
7942 @code{org-tags-match-list-sublevels}). To exclude scheduled/deadline items,
7943 see the variable @code{org-agenda-tags-todo-honor-ignore-options}. Matching
7944 specific TODO keywords together with a tags match is also possible, see
7948 The commands available in the tags list are described in @ref{Agenda
7951 @subsubheading Match syntax
7953 @cindex Boolean logic, for tag/property searches
7954 A search string can use Boolean operators @samp{&} for @code{AND} and
7955 @samp{|} for @code{OR}@. @samp{&} binds more strongly than @samp{|}.
7956 Parentheses are not implemented. Each element in the search is either a
7957 tag, a regular expression matching tags, or an expression like
7958 @code{PROPERTY OPERATOR VALUE} with a comparison operator, accessing a
7959 property value. Each element may be preceded by @samp{-}, to select
7960 against it, and @samp{+} is syntactic sugar for positive selection. The
7961 @code{AND} operator @samp{&} is optional when @samp{+} or @samp{-} is
7962 present. Here are some examples, using only tags.
7966 Select headlines tagged @samp{:work:}.
7968 Select headlines tagged @samp{:work:} and @samp{:boss:}.
7970 Select headlines tagged @samp{:work:}, but discard those also tagged
7973 Selects lines tagged @samp{:work:} or @samp{:laptop:}.
7974 @item work|laptop+night
7975 Like before, but require the @samp{:laptop:} lines to be tagged also
7979 @cindex regular expressions, with tags search
7980 Instead of a tag, you may also specify a regular expression enclosed in curly
7981 braces. For example,
7982 @samp{work+@{^boss.*@}} matches headlines that contain the tag
7983 @samp{:work:} and any tag @i{starting} with @samp{boss}.
7985 @cindex group tags, as regular expressions
7986 Group tags (@pxref{Tag groups}) are expanded as regular expressions. E.g.,
7987 if @samp{:work:} is a group tag for the group @samp{:work:lab:conf:}, then
7988 searching for @samp{work} will search for @samp{@{\(?:work\|lab\|conf\)@}}
7989 and searching for @samp{-work} will search for all headlines but those with
7990 one of the tag in the group (i.e., @samp{-@{\(?:work\|lab\|conf\)@}}).
7992 @cindex TODO keyword matching, with tags search
7993 @cindex level, require for tags/property match
7994 @cindex category, require for tags/property match
7995 @vindex org-odd-levels-only
7996 You may also test for properties (@pxref{Properties and Columns}) at the same
7997 time as matching tags. The properties may be real properties, or special
7998 properties that represent other metadata (@pxref{Special properties}). For
7999 example, the ``property'' @code{TODO} represents the TODO keyword of the
8000 entry. Or, the ``property'' @code{LEVEL} represents the level of an entry.
8001 So a search @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines
8002 that have the tag @samp{boss} and are @emph{not} marked with the TODO keyword
8003 DONE@. In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not
8004 count the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc.
8005 The ITEM special property cannot currently be used in tags/property
8006 searches@footnote{But @pxref{x-agenda-skip-entry-regexp,
8007 ,skipping entries based on regexp}.}.
8009 Here are more examples:
8012 @item work+TODO="WAITING"
8013 Select @samp{:work:}-tagged TODO lines with the specific TODO
8014 keyword @samp{WAITING}.
8015 @item work+TODO="WAITING"|home+TODO="WAITING"
8016 Waiting tasks both at work and at home.
8019 When matching properties, a number of different operators can be used to test
8020 the value of a property. Here is a complex example:
8023 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 \
8024 +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
8028 The type of comparison will depend on how the comparison value is written:
8031 If the comparison value is a plain number, a numerical comparison is done,
8032 and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
8033 @samp{>=}, and @samp{<>}.
8035 If the comparison value is enclosed in double-quotes,
8036 a string comparison is done, and the same operators are allowed.
8038 If the comparison value is enclosed in double-quotes @emph{and} angular
8039 brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
8040 assumed to be date/time specifications in the standard Org way, and the
8041 comparison will be done accordingly. Special values that will be recognized
8042 are @code{"<now>"} for now (including time), and @code{"<today>"}, and
8043 @code{"<tomorrow>"} for these days at 0:00 hours, i.e., without a time
8044 specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
8045 @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
8046 respectively, can be used.
8048 If the comparison value is enclosed
8049 in curly braces, a regexp match is performed, with @samp{=} meaning that the
8050 regexp matches the property value, and @samp{<>} meaning that it does not
8054 So the search string in the example finds entries tagged @samp{:work:} but
8055 not @samp{:boss:}, which also have a priority value @samp{A}, a
8056 @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
8057 property that is numerically smaller than 2, a @samp{:With:} property that is
8058 matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
8059 on or after October 11, 2008.
8061 Accessing TODO, LEVEL, and CATEGORY during a search is fast. Accessing any
8062 other properties will slow down the search. However, once you have paid the
8063 price by accessing one property, testing additional properties is cheap
8066 You can configure Org mode to use property inheritance during a search, but
8067 beware that this can slow down searches considerably. See @ref{Property
8068 inheritance}, for details.
8070 For backward compatibility, and also for typing speed, there is also a
8071 different way to test TODO states in a search. For this, terminate the
8072 tags/property part of the search string (which may include several terms
8073 connected with @samp{|}) with a @samp{/} and then specify a Boolean
8074 expression just for TODO keywords. The syntax is then similar to that for
8075 tags, but should be applied with care: for example, a positive selection on
8076 several TODO keywords cannot meaningfully be combined with boolean AND@.
8077 However, @emph{negative selection} combined with AND can be meaningful. To
8078 make sure that only lines are checked that actually have any TODO keyword
8079 (resulting in a speed-up), use @kbd{C-c a M}, or equivalently start the TODO
8080 part after the slash with @samp{!}. Using @kbd{C-c a M} or @samp{/!} will
8081 not match TODO keywords in a DONE state. Examples:
8085 Same as @samp{work+TODO="WAITING"}
8086 @item work/!-WAITING-NEXT
8087 Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
8089 @item work/!+WAITING|+NEXT
8090 Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
8094 @node Timeline, Search view, Matching tags and properties, Built-in agenda views
8095 @subsection Timeline for a single file
8096 @cindex timeline, single file
8097 @cindex time-sorted view
8099 The timeline summarizes all time-stamped items from a single Org mode
8100 file in a @emph{time-sorted view}. The main purpose of this command is
8101 to give an overview over events in a project.
8104 @orgcmd{C-c a L,org-timeline}
8105 Show a time-sorted view of the Org file, with all time-stamped items.
8106 When called with a @kbd{C-u} prefix, all unfinished TODO entries
8107 (scheduled or not) are also listed under the current date.
8111 The commands available in the timeline buffer are listed in
8112 @ref{Agenda commands}.
8114 @node Search view, Stuck projects, Timeline, Built-in agenda views
8115 @subsection Search view
8118 @cindex searching, for text
8120 This agenda view is a general text search facility for Org mode entries.
8121 It is particularly useful to find notes.
8124 @orgcmd{C-c a s,org-search-view}
8125 This is a special search that lets you select entries by matching a substring
8126 or specific words using a boolean logic.
8128 For example, the search string @samp{computer equipment} will find entries
8129 that contain @samp{computer equipment} as a substring. If the two words are
8130 separated by more space or a line break, the search will still match.
8131 Search view can also search for specific keywords in the entry, using Boolean
8132 logic. The search string @samp{+computer +wifi -ethernet -@{8\.11[bg]@}}
8133 will search for note entries that contain the keywords @code{computer}
8134 and @code{wifi}, but not the keyword @code{ethernet}, and which are also
8135 not matched by the regular expression @code{8\.11[bg]}, meaning to
8136 exclude both 8.11b and 8.11g. The first @samp{+} is necessary to turn on
8137 word search, other @samp{+} characters are optional. For more details, see
8138 the docstring of the command @code{org-search-view}.
8140 @vindex org-agenda-text-search-extra-files
8141 Note that in addition to the agenda files, this command will also search
8142 the files listed in @code{org-agenda-text-search-extra-files}.
8144 @node Stuck projects, , Search view, Built-in agenda views
8145 @subsection Stuck projects
8146 @pindex GTD, Getting Things Done
8148 If you are following a system like David Allen's GTD to organize your
8149 work, one of the ``duties'' you have is a regular review to make sure
8150 that all projects move along. A @emph{stuck} project is a project that
8151 has no defined next actions, so it will never show up in the TODO lists
8152 Org mode produces. During the review, you need to identify such
8153 projects and define next actions for them.
8156 @orgcmd{C-c a #,org-agenda-list-stuck-projects}
8157 List projects that are stuck.
8160 @vindex org-stuck-projects
8161 Customize the variable @code{org-stuck-projects} to define what a stuck
8162 project is and how to find it.
8165 You almost certainly will have to configure this view before it will
8166 work for you. The built-in default assumes that all your projects are
8167 level-2 headlines, and that a project is not stuck if it has at least
8168 one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
8170 Let's assume that you, in your own way of using Org mode, identify
8171 projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
8172 indicate a project that should not be considered yet. Let's further
8173 assume that the TODO keyword DONE marks finished projects, and that NEXT
8174 and TODO indicate next actions. The tag @@SHOP indicates shopping and
8175 is a next action even without the NEXT tag. Finally, if the project
8176 contains the special word IGNORE anywhere, it should not be listed
8177 either. In this case you would start by identifying eligible projects
8178 with a tags/todo match@footnote{@xref{Tag searches}.}
8179 @samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT, @@SHOP, and
8180 IGNORE in the subtree to identify projects that are not stuck. The
8181 correct customization for this is
8184 (setq org-stuck-projects
8185 '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
8189 Note that if a project is identified as non-stuck, the subtree of this entry
8190 will still be searched for stuck projects.
8192 @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views
8193 @section Presentation and sorting
8194 @cindex presentation, of agenda items
8196 @vindex org-agenda-prefix-format
8197 @vindex org-agenda-tags-column
8198 Before displaying items in an agenda view, Org mode visually prepares the
8199 items and sorts them. Each item occupies a single line. The line starts
8200 with a @emph{prefix} that contains the @emph{category} (@pxref{Categories})
8201 of the item and other important information. You can customize in which
8202 column tags will be displayed through @code{org-agenda-tags-column}. You can
8203 also customize the prefix using the option @code{org-agenda-prefix-format}.
8204 This prefix is followed by a cleaned-up version of the outline headline
8205 associated with the item.
8208 * Categories:: Not all tasks are equal
8209 * Time-of-day specifications:: How the agenda knows the time
8210 * Sorting of agenda items:: The order of things
8213 @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting
8214 @subsection Categories
8218 The category is a broad label assigned to each agenda item. By default,
8219 the category is simply derived from the file name, but you can also
8220 specify it with a special line in the buffer, like this@footnote{For
8221 backward compatibility, the following also works: if there are several
8222 such lines in a file, each specifies the category for the text below it.
8223 The first category also applies to any text before the first CATEGORY
8224 line. However, using this method is @emph{strongly} deprecated as it is
8225 incompatible with the outline structure of the document. The correct
8226 method for setting multiple categories in a buffer is using a
8234 @cindex property, CATEGORY
8235 If you would like to have a special CATEGORY for a single entry or a
8236 (sub)tree, give the entry a @code{:CATEGORY:} property with the
8237 special category you want to apply as the value.
8240 The display in the agenda buffer looks best if the category is not
8241 longer than 10 characters.
8244 You can set up icons for category by customizing the
8245 @code{org-agenda-category-icon-alist} variable.
8247 @node Time-of-day specifications, Sorting of agenda items, Categories, Presentation and sorting
8248 @subsection Time-of-day specifications
8249 @cindex time-of-day specification
8251 Org mode checks each agenda item for a time-of-day specification. The
8252 time can be part of the timestamp that triggered inclusion into the
8253 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time
8254 ranges can be specified with two timestamps, like
8256 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
8258 In the headline of the entry itself, a time(range) may also appear as
8259 plain text (like @samp{12:45} or a @samp{8:30-1pm}). If the agenda
8260 integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
8261 specifications in diary entries are recognized as well.
8263 For agenda display, Org mode extracts the time and displays it in a
8264 standard 24 hour format as part of the prefix. The example times in
8265 the previous paragraphs would end up in the agenda like this:
8268 8:30-13:00 Arthur Dent lies in front of the bulldozer
8269 12:45...... Ford Prefect arrives and takes Arthur to the pub
8270 19:00...... The Vogon reads his poem
8271 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
8275 If the agenda is in single-day mode, or for the display of today, the
8276 timed entries are embedded in a time grid, like
8279 8:00...... ------------------
8280 8:30-13:00 Arthur Dent lies in front of the bulldozer
8281 10:00...... ------------------
8282 12:00...... ------------------
8283 12:45...... Ford Prefect arrives and takes Arthur to the pub
8284 14:00...... ------------------
8285 16:00...... ------------------
8286 18:00...... ------------------
8287 19:00...... The Vogon reads his poem
8288 20:00...... ------------------
8289 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
8292 @vindex org-agenda-use-time-grid
8293 @vindex org-agenda-time-grid
8294 The time grid can be turned on and off with the variable
8295 @code{org-agenda-use-time-grid}, and can be configured with
8296 @code{org-agenda-time-grid}.
8298 @node Sorting of agenda items, , Time-of-day specifications, Presentation and sorting
8299 @subsection Sorting of agenda items
8300 @cindex sorting, of agenda items
8301 @cindex priorities, of agenda items
8302 Before being inserted into a view, the items are sorted. How this is
8303 done depends on the type of view.
8306 @vindex org-agenda-files
8307 For the daily/weekly agenda, the items for each day are sorted. The
8308 default order is to first collect all items containing an explicit
8309 time-of-day specification. These entries will be shown at the beginning
8310 of the list, as a @emph{schedule} for the day. After that, items remain
8311 grouped in categories, in the sequence given by @code{org-agenda-files}.
8312 Within each category, items are sorted by priority (@pxref{Priorities}),
8313 which is composed of the base priority (2000 for priority @samp{A}, 1000
8314 for @samp{B}, and 0 for @samp{C}), plus additional increments for
8315 overdue scheduled or deadline items.
8317 For the TODO list, items remain in the order of categories, but within
8318 each category, sorting takes place according to priority
8319 (@pxref{Priorities}). The priority used for sorting derives from the
8320 priority cookie, with additions depending on how close an item is to its due
8323 For tags matches, items are not sorted at all, but just appear in the
8324 sequence in which they are found in the agenda files.
8327 @vindex org-agenda-sorting-strategy
8328 Sorting can be customized using the variable
8329 @code{org-agenda-sorting-strategy}, and may also include criteria based on
8330 the estimated effort of an entry (@pxref{Effort estimates}).
8332 @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda Views
8333 @section Commands in the agenda buffer
8334 @cindex commands, in agenda buffer
8336 Entries in the agenda buffer are linked back to the Org file or diary
8337 file where they originate. You are not allowed to edit the agenda
8338 buffer itself, but commands are provided to show and jump to the
8339 original entry location, and to edit the Org files ``remotely'' from
8340 the agenda buffer. In this way, all information is stored only once,
8341 removing the risk that your agenda and note files may diverge.
8343 Some commands can be executed with mouse clicks on agenda lines. For
8344 the other commands, the cursor needs to be in the desired line.
8347 @tsubheading{Motion}
8348 @cindex motion commands in agenda
8349 @orgcmd{n,org-agenda-next-line}
8350 Next line (same as @key{down} and @kbd{C-n}).
8351 @orgcmd{p,org-agenda-previous-line}
8352 Previous line (same as @key{up} and @kbd{C-p}).
8353 @tsubheading{View/Go to Org file}
8354 @orgcmdkkc{@key{SPC},mouse-3,org-agenda-show-and-scroll-up}
8355 Display the original location of the item in another window.
8356 With prefix arg, make sure that the entire entry is made visible in the
8357 outline, not only the heading.
8359 @orgcmd{L,org-agenda-recenter}
8360 Display original location and recenter that window.
8362 @orgcmdkkc{@key{TAB},mouse-2,org-agenda-goto}
8363 Go to the original location of the item in another window.
8365 @orgcmd{@key{RET},org-agenda-switch-to}
8366 Go to the original location of the item and delete other windows.
8368 @orgcmd{F,org-agenda-follow-mode}
8369 @vindex org-agenda-start-with-follow-mode
8370 Toggle Follow mode. In Follow mode, as you move the cursor through
8371 the agenda buffer, the other window always shows the corresponding
8372 location in the Org file. The initial setting for this mode in new
8373 agenda buffers can be set with the variable
8374 @code{org-agenda-start-with-follow-mode}.
8376 @orgcmd{C-c C-x b,org-agenda-tree-to-indirect-buffer}
8377 Display the entire subtree of the current item in an indirect buffer. With a
8378 numeric prefix argument N, go up to level N and then take that tree. If N is
8379 negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the
8380 previously used indirect buffer.
8382 @orgcmd{C-c C-o,org-agenda-open-link}
8383 Follow a link in the entry. This will offer a selection of any links in the
8384 text belonging to the referenced Org node. If there is only one link, it
8385 will be followed without a selection prompt.
8387 @tsubheading{Change display}
8388 @cindex display changing, in agenda
8391 Interactively select another agenda view and append it to the current view.
8395 Delete other windows.
8397 @orgcmdkskc{v d,d,org-agenda-day-view}
8398 @xorgcmdkskc{v w,w,org-agenda-week-view}
8399 @xorgcmd{v m,org-agenda-month-view}
8400 @xorgcmd{v y,org-agenda-year-view}
8401 @xorgcmd{v SPC,org-agenda-reset-view}
8402 @vindex org-agenda-span
8403 Switch to day/week/month/year view. When switching to day or week view, this
8404 setting becomes the default for subsequent agenda refreshes. Since month and
8405 year views are slow to create, they do not become the default. A numeric
8406 prefix argument may be used to jump directly to a specific day of the year,
8407 ISO week, month, or year, respectively. For example, @kbd{32 d} jumps to
8408 February 1st, @kbd{9 w} to ISO week number 9. When setting day, week, or
8409 month view, a year may be encoded in the prefix argument as well. For
8410 example, @kbd{200712 w} will jump to week 12 in 2007. If such a year
8411 specification has only one or two digits, it will be mapped to the interval
8412 1938--2037. @kbd{v @key{SPC}} will reset to what is set in
8413 @code{org-agenda-span}.
8415 @orgcmd{f,org-agenda-later}
8416 Go forward in time to display the following @code{org-agenda-current-span} days.
8417 For example, if the display covers a week, switch to the following week.
8418 With prefix arg, go forward that many times @code{org-agenda-current-span} days.
8420 @orgcmd{b,org-agenda-earlier}
8421 Go backward in time to display earlier dates.
8423 @orgcmd{.,org-agenda-goto-today}
8426 @orgcmd{j,org-agenda-goto-date}
8427 Prompt for a date and go there.
8429 @orgcmd{J,org-agenda-clock-goto}
8430 Go to the currently clocked-in task @i{in the agenda buffer}.
8432 @orgcmd{D,org-agenda-toggle-diary}
8433 Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}.
8435 @orgcmdkskc{v l,l,org-agenda-log-mode}
8437 @vindex org-log-done
8438 @vindex org-agenda-log-mode-items
8439 Toggle Logbook mode. In Logbook mode, entries that were marked DONE while
8440 logging was on (variable @code{org-log-done}) are shown in the agenda, as are
8441 entries that have been clocked on that day. You can configure the entry
8442 types that should be included in log mode using the variable
8443 @code{org-agenda-log-mode-items}. When called with a @kbd{C-u} prefix, show
8444 all possible logbook entries, including state changes. When called with two
8445 prefix arguments @kbd{C-u C-u}, show only logging information, nothing else.
8446 @kbd{v L} is equivalent to @kbd{C-u v l}.
8448 @orgcmdkskc{v [,[,org-agenda-manipulate-query-add}
8449 Include inactive timestamps into the current view. Only for weekly/daily
8450 agenda and timeline views.
8452 @orgcmd{v a,org-agenda-archives-mode}
8453 @xorgcmd{v A,org-agenda-archives-mode 'files}
8454 Toggle Archives mode. In Archives mode, trees that are marked
8455 @code{ARCHIVED} are also scanned when producing the agenda. When you use the
8456 capital @kbd{A}, even all archive files are included. To exit archives mode,
8457 press @kbd{v a} again.
8459 @orgcmdkskc{v R,R,org-agenda-clockreport-mode}
8460 @vindex org-agenda-start-with-clockreport-mode
8461 @vindex org-clock-report-include-clocking-task
8462 Toggle Clockreport mode. In Clockreport mode, the daily/weekly agenda will
8463 always show a table with the clocked times for the time span and file scope
8464 covered by the current agenda view. The initial setting for this mode in new
8465 agenda buffers can be set with the variable
8466 @code{org-agenda-start-with-clockreport-mode}. By using a prefix argument
8467 when toggling this mode (i.e., @kbd{C-u R}), the clock table will not show
8468 contributions from entries that are hidden by agenda filtering@footnote{Only
8469 tags filtering will be respected here, effort filtering is ignored.}. See
8470 also the variable @code{org-clock-report-include-clocking-task}.
8473 @vindex org-agenda-clock-consistency-checks
8474 Show overlapping clock entries, clocking gaps, and other clocking problems in
8475 the current agenda range. You can then visit clocking lines and fix them
8476 manually. See the variable @code{org-agenda-clock-consistency-checks} for
8477 information on how to customize the definition of what constituted a clocking
8478 problem. To return to normal agenda display, press @kbd{l} to exit Logbook
8481 @orgcmdkskc{v E,E,org-agenda-entry-text-mode}
8482 @vindex org-agenda-start-with-entry-text-mode
8483 @vindex org-agenda-entry-text-maxlines
8484 Toggle entry text mode. In entry text mode, a number of lines from the Org
8485 outline node referenced by an agenda line will be displayed below the line.
8486 The maximum number of lines is given by the variable
8487 @code{org-agenda-entry-text-maxlines}. Calling this command with a numeric
8488 prefix argument will temporarily modify that number to the prefix value.
8490 @orgcmd{G,org-agenda-toggle-time-grid}
8491 @vindex org-agenda-use-time-grid
8492 @vindex org-agenda-time-grid
8493 Toggle the time grid on and off. See also the variables
8494 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
8496 @orgcmd{r,org-agenda-redo}
8497 Recreate the agenda buffer, for example to reflect the changes after
8498 modification of the timestamps of items with @kbd{S-@key{left}} and
8499 @kbd{S-@key{right}}. When the buffer is the global TODO list, a prefix
8500 argument is interpreted to create a selective list for a specific TODO
8502 @orgcmd{g,org-agenda-redo}
8505 @orgcmdkskc{C-x C-s,s,org-save-all-org-buffers}
8506 Save all Org buffers in the current Emacs session, and also the locations of
8509 @orgcmd{C-c C-x C-c,org-agenda-columns}
8510 @vindex org-columns-default-format
8511 Invoke column view (@pxref{Column view}) in the agenda buffer. The column
8512 view format is taken from the entry at point, or (if there is no entry at
8513 point), from the first entry in the agenda view. So whatever the format for
8514 that entry would be in the original buffer (taken from a property, from a
8515 @code{#+COLUMNS} line, or from the default variable
8516 @code{org-columns-default-format}), will be used in the agenda.
8518 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
8519 Remove the restriction lock on the agenda, if it is currently restricted to a
8520 file or subtree (@pxref{Agenda files}).
8522 @tsubheading{Secondary filtering and query editing}
8523 @cindex filtering, by tag category and effort, in agenda
8524 @cindex tag filtering, in agenda
8525 @cindex category filtering, in agenda
8526 @cindex effort filtering, in agenda
8527 @cindex query editing, in agenda
8529 @orgcmd{<,org-agenda-filter-by-category}
8530 @vindex org-agenda-category-filter-preset
8532 Filter the current agenda view with respect to the category of the item at
8533 point. Pressing @code{<} another time will remove this filter. You can add
8534 a filter preset through the option @code{org-agenda-category-filter-preset}
8537 @orgcmd{|,org-agenda-filter-by-regexp}
8538 @vindex org-agenda-regexp-filter-preset
8540 Filter the agenda view by a regular expression: only show agenda entries
8541 matching the regular expression the user entered. When called with a prefix
8542 argument, it will filter @emph{out} entries matching the regexp. With two
8543 universal prefix arguments, it will remove all the regexp filters, which can
8544 be accumulated. You can add a filter preset through the option
8545 @code{org-agenda-category-filter-preset} (see below.)
8547 @orgcmd{/,org-agenda-filter-by-tag}
8548 @vindex org-agenda-tag-filter-preset
8549 Filter the agenda view with respect to a tag and/or effort estimates. The
8550 difference between this and a custom agenda command is that filtering is very
8551 fast, so that you can switch quickly between different filters without having
8552 to recreate the agenda.@footnote{Custom commands can preset a filter by
8553 binding the variable @code{org-agenda-tag-filter-preset} as an option. This
8554 filter will then be applied to the view and persist as a basic filter through
8555 refreshes and more secondary filtering. The filter is a global property of
8556 the entire agenda view---in a block agenda, you should only set this in the
8557 global options section, not in the section of an individual block.}
8559 You will be prompted for a tag selection letter; @key{SPC} will mean any tag at
8560 all. Pressing @key{TAB} at that prompt will offer use completion to select a
8561 tag (including any tags that do not have a selection character). The command
8562 then hides all entries that do not contain or inherit this tag. When called
8563 with prefix arg, remove the entries that @emph{do} have the tag. A second
8564 @kbd{/} at the prompt will turn off the filter and unhide any hidden entries.
8565 If the first key you press is either @kbd{+} or @kbd{-}, the previous filter
8566 will be narrowed by requiring or forbidding the selected additional tag.
8567 Instead of pressing @kbd{+} or @kbd{-} after @kbd{/}, you can also
8568 immediately use the @kbd{\} command.
8570 @vindex org-sort-agenda-noeffort-is-high
8571 In order to filter for effort estimates, you should set up allowed
8572 efforts globally, for example
8574 (setq org-global-properties
8575 '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
8577 You can then filter for an effort by first typing an operator, one of
8578 @kbd{<}, @kbd{>}, and @kbd{=}, and then the one-digit index of an effort
8579 estimate in your array of allowed values, where @kbd{0} means the 10th value.
8580 The filter will then restrict to entries with effort smaller-or-equal, equal,
8581 or larger-or-equal than the selected value. If the digits 0--9 are not used
8582 as fast access keys to tags, you can also simply press the index digit
8583 directly without an operator. In this case, @kbd{<} will be assumed. For
8584 application of the operator, entries without a defined effort will be treated
8585 according to the value of @code{org-sort-agenda-noeffort-is-high}. To filter
8586 for tasks without effort definition, press @kbd{?} as the operator.
8588 Org also supports automatic, context-aware tag filtering. If the variable
8589 @code{org-agenda-auto-exclude-function} is set to a user-defined function,
8590 that function can decide which tags should be excluded from the agenda
8591 automatically. Once this is set, the @kbd{/} command then accepts @kbd{RET}
8592 as a sub-option key and runs the auto exclusion logic. For example, let's
8593 say you use a @code{Net} tag to identify tasks which need network access, an
8594 @code{Errand} tag for errands in town, and a @code{Call} tag for making phone
8595 calls. You could auto-exclude these tags based on the availability of the
8596 Internet, and outside of business hours, with something like this:
8600 (defun org-my-auto-exclude-function (tag)
8602 ((string= tag "Net")
8603 (/= 0 (call-process "/sbin/ping" nil nil nil
8604 "-c1" "-q" "-t1" "mail.gnu.org")))
8605 ((or (string= tag "Errand") (string= tag "Call"))
8606 (let ((hour (nth 2 (decode-time))))
8607 (or (< hour 8) (> hour 21)))))
8610 (setq org-agenda-auto-exclude-function 'org-my-auto-exclude-function)
8614 @orgcmd{\\,org-agenda-filter-by-tag-refine}
8615 Narrow the current agenda filter by an additional condition. When called with
8616 prefix arg, remove the entries that @emph{do} have the tag, or that do match
8617 the effort criterion. You can achieve the same effect by pressing @kbd{+} or
8618 @kbd{-} as the first key after the @kbd{/} command.
8627 @item @r{in} search view
8628 add new search words (@kbd{[} and @kbd{]}) or new regular expressions
8629 (@kbd{@{} and @kbd{@}}) to the query string. The opening bracket/brace will
8630 add a positive search term prefixed by @samp{+}, indicating that this search
8631 term @i{must} occur/match in the entry. The closing bracket/brace will add a
8632 negative search term which @i{must not} occur/match in the entry for it to be
8636 @tsubheading{Remote editing}
8637 @cindex remote editing, from agenda
8642 @cindex undoing remote-editing events
8643 @cindex remote editing, undo
8644 @orgcmd{C-_,org-agenda-undo}
8645 Undo a change due to a remote editing command. The change is undone
8646 both in the agenda buffer and in the remote buffer.
8648 @orgcmd{t,org-agenda-todo}
8649 Change the TODO state of the item, both in the agenda and in the
8652 @orgcmd{C-S-@key{right},org-agenda-todo-nextset}
8653 @orgcmd{C-S-@key{left},org-agenda-todo-previousset}
8654 Switch to the next/previous set of TODO keywords.
8656 @orgcmd{C-k,org-agenda-kill}
8657 @vindex org-agenda-confirm-kill
8658 Delete the current agenda item along with the entire subtree belonging
8659 to it in the original Org file. If the text to be deleted remotely
8660 is longer than one line, the kill needs to be confirmed by the user. See
8661 variable @code{org-agenda-confirm-kill}.
8663 @orgcmd{C-c C-w,org-agenda-refile}
8664 Refile the entry at point.
8666 @orgcmdkskc{C-c C-x C-a,a,org-agenda-archive-default-with-confirmation}
8667 @vindex org-archive-default-command
8668 Archive the subtree corresponding to the entry at point using the default
8669 archiving command set in @code{org-archive-default-command}. When using the
8670 @code{a} key, confirmation will be required.
8672 @orgcmd{C-c C-x a,org-agenda-toggle-archive-tag}
8673 Toggle the ARCHIVE tag for the current headline.
8675 @orgcmd{C-c C-x A,org-agenda-archive-to-archive-sibling}
8676 Move the subtree corresponding to the current entry to its @emph{archive
8679 @orgcmdkskc{C-c C-x C-s,$,org-agenda-archive}
8680 Archive the subtree corresponding to the current headline. This means the
8681 entry will be moved to the configured archive location, most likely a
8684 @orgcmd{T,org-agenda-show-tags}
8685 @vindex org-agenda-show-inherited-tags
8686 Show all tags associated with the current item. This is useful if you have
8687 turned off @code{org-agenda-show-inherited-tags}, but still want to see all
8688 tags of a headline occasionally.
8690 @orgcmd{:,org-agenda-set-tags}
8691 Set tags for the current headline. If there is an active region in the
8692 agenda, change a tag for all headings in the region.
8696 Set the priority for the current item (@command{org-agenda-priority}).
8697 Org mode prompts for the priority character. If you reply with @key{SPC},
8698 the priority cookie is removed from the entry.
8700 @orgcmd{P,org-agenda-show-priority}
8701 Display weighted priority of current item.
8703 @orgcmdkkc{+,S-@key{up},org-agenda-priority-up}
8704 Increase the priority of the current item. The priority is changed in
8705 the original buffer, but the agenda is not resorted. Use the @kbd{r}
8708 @orgcmdkkc{-,S-@key{down},org-agenda-priority-down}
8709 Decrease the priority of the current item.
8711 @orgcmdkkc{z,C-c C-z,org-agenda-add-note}
8712 @vindex org-log-into-drawer
8713 Add a note to the entry. This note will be recorded, and then filed to the
8714 same location where state change notes are put. Depending on
8715 @code{org-log-into-drawer}, this may be inside a drawer.
8717 @orgcmd{C-c C-a,org-attach}
8718 Dispatcher for all command related to attachments.
8720 @orgcmd{C-c C-s,org-agenda-schedule}
8721 Schedule this item. With prefix arg remove the scheduling timestamp
8723 @orgcmd{C-c C-d,org-agenda-deadline}
8724 Set a deadline for this item. With prefix arg remove the deadline.
8726 @orgcmd{S-@key{right},org-agenda-do-date-later}
8727 Change the timestamp associated with the current line by one day into the
8728 future. If the date is in the past, the first call to this command will move
8730 With a numeric prefix argument, change it by that many days. For example,
8731 @kbd{3 6 5 S-@key{right}} will change it by a year. With a @kbd{C-u} prefix,
8732 change the time by one hour. If you immediately repeat the command, it will
8733 continue to change hours even without the prefix arg. With a double @kbd{C-u
8734 C-u} prefix, do the same for changing minutes.@*
8735 The stamp is changed in the original Org file, but the change is not directly
8736 reflected in the agenda buffer. Use @kbd{r} or @kbd{g} to update the buffer.
8738 @orgcmd{S-@key{left},org-agenda-do-date-earlier}
8739 Change the timestamp associated with the current line by one day
8742 @orgcmd{>,org-agenda-date-prompt}
8743 Change the timestamp associated with the current line. The key @kbd{>} has
8744 been chosen, because it is the same as @kbd{S-.} on my keyboard.
8746 @orgcmd{I,org-agenda-clock-in}
8747 Start the clock on the current item. If a clock is running already, it
8750 @orgcmd{O,org-agenda-clock-out}
8751 Stop the previously started clock.
8753 @orgcmd{X,org-agenda-clock-cancel}
8754 Cancel the currently running clock.
8756 @orgcmd{J,org-agenda-clock-goto}
8757 Jump to the running clock in another window.
8759 @orgcmd{k,org-agenda-capture}
8760 Like @code{org-capture}, but use the date at point as the default date for
8761 the capture template. See @var{org-capture-use-agenda-date} to make this
8762 the default behavior of @code{org-capture}.
8763 @cindex capturing, from agenda
8764 @vindex org-capture-use-agenda-date
8766 @tsubheading{Bulk remote editing selected entries}
8767 @cindex remote editing, bulk, from agenda
8768 @vindex org-agenda-bulk-persistent-marks
8769 @vindex org-agenda-bulk-custom-functions
8771 @orgcmd{m,org-agenda-bulk-mark}
8772 Mark the entry at point for bulk action. With prefix arg, mark that many
8775 @orgcmd{%,org-agenda-bulk-mark-regexp}
8776 Mark entries matching a regular expression for bulk action.
8778 @orgcmd{u,org-agenda-bulk-unmark}
8779 Unmark entry for bulk action.
8781 @orgcmd{U,org-agenda-bulk-remove-all-marks}
8782 Unmark all marked entries for bulk action.
8784 @orgcmd{B,org-agenda-bulk-action}
8785 Bulk action: act on all marked entries in the agenda. This will prompt for
8786 another key to select the action to be applied. The prefix arg to @kbd{B}
8787 will be passed through to the @kbd{s} and @kbd{d} commands, to bulk-remove
8788 these special timestamps. By default, marks are removed after the bulk. If
8789 you want them to persist, set @code{org-agenda-bulk-persistent-marks} to
8790 @code{t} or hit @kbd{p} at the prompt.
8794 Toggle persistent marks.
8796 Archive all selected entries.
8798 Archive entries by moving them to their respective archive siblings.
8800 Change TODO state. This prompts for a single TODO keyword and changes the
8801 state of all selected entries, bypassing blocking and suppressing logging
8802 notes (but not timestamps).
8804 Add a tag to all selected entries.
8806 Remove a tag from all selected entries.
8808 Schedule all items to a new date. To shift existing schedule dates by a
8809 fixed number of days, use something starting with double plus at the prompt,
8810 for example @samp{++8d} or @samp{++2w}.
8812 Set deadline to a specific date.
8814 Prompt for a single refile target and move all entries. The entries will no
8815 longer be in the agenda; refresh (@kbd{g}) to bring them back.
8817 Reschedule randomly into the coming N days. N will be prompted for. With
8818 prefix arg (@kbd{C-u B S}), scatter only across weekdays.
8820 Apply a function@footnote{You can also create persistent custom functions
8821 through@code{org-agenda-bulk-custom-functions}.} to marked entries. For
8822 example, the function below sets the CATEGORY property of the entries to web.
8826 (defun set-category ()
8828 (let* ((marker (or (org-get-at-bol 'org-hd-marker)
8829 (org-agenda-error)))
8830 (buffer (marker-buffer marker)))
8831 (with-current-buffer buffer
8836 (org-back-to-heading t)
8837 (org-set-property "CATEGORY" "web"))))))
8842 @tsubheading{Calendar commands}
8843 @cindex calendar commands, from agenda
8845 @orgcmd{c,org-agenda-goto-calendar}
8846 Open the Emacs calendar and move to the date at the agenda cursor.
8848 @orgcmd{c,org-calendar-goto-agenda}
8849 When in the calendar, compute and show the Org mode agenda for the
8852 @cindex diary entries, creating from agenda
8853 @orgcmd{i,org-agenda-diary-entry}
8854 @vindex org-agenda-diary-file
8855 Insert a new entry into the diary, using the date at the cursor and (for
8856 block entries) the date at the mark. This will add to the Emacs diary
8857 file@footnote{This file is parsed for the agenda when
8858 @code{org-agenda-include-diary} is set.}, in a way similar to the @kbd{i}
8859 command in the calendar. The diary file will pop up in another window, where
8860 you can add the entry.
8862 If you configure @code{org-agenda-diary-file} to point to an Org mode file,
8863 Org will create entries (in Org mode syntax) in that file instead. Most
8864 entries will be stored in a date-based outline tree that will later make it
8865 easy to archive appointments from previous months/years. The tree will be
8866 built under an entry with a @code{DATE_TREE} property, or else with years as
8867 top-level entries. Emacs will prompt you for the entry text---if you specify
8868 it, the entry will be created in @code{org-agenda-diary-file} without further
8869 interaction. If you directly press @key{RET} at the prompt without typing
8870 text, the target file will be shown in another window for you to finish the
8871 entry there. See also the @kbd{k r} command.
8873 @orgcmd{M,org-agenda-phases-of-moon}
8874 Show the phases of the moon for the three months around current date.
8876 @orgcmd{S,org-agenda-sunrise-sunset}
8877 Show sunrise and sunset times. The geographical location must be set
8878 with calendar variables, see the documentation for the Emacs calendar.
8880 @orgcmd{C,org-agenda-convert-date}
8881 Convert the date at cursor into many other cultural and historic
8884 @orgcmd{H,org-agenda-holidays}
8885 Show holidays for three months around the cursor date.
8887 @item M-x org-icalendar-combine-agenda-files
8888 Export a single iCalendar file containing entries from all agenda files.
8889 This is a globally available command, and also available in the agenda menu.
8891 @tsubheading{Exporting to a file}
8892 @orgcmd{C-x C-w,org-agenda-write}
8893 @cindex exporting agenda views
8894 @cindex agenda views, exporting
8895 @vindex org-agenda-exporter-settings
8896 Write the agenda view to a file. Depending on the extension of the selected
8897 file name, the view will be exported as HTML (@file{.html} or @file{.htm}),
8898 Postscript (@file{.ps}), PDF (@file{.pdf}), Org (@file{.org}) and plain text
8899 (any other extension). When exporting to Org, only the body of original
8900 headlines are exported, not subtrees or inherited tags. When called with a
8901 @kbd{C-u} prefix argument, immediately open the newly created file. Use the
8902 variable @code{org-agenda-exporter-settings} to set options for
8903 @file{ps-print} and for @file{htmlize} to be used during export.
8905 @tsubheading{Quit and Exit}
8906 @orgcmd{q,org-agenda-quit}
8907 Quit agenda, remove the agenda buffer.
8909 @cindex agenda files, removing buffers
8910 @orgcmd{x,org-agenda-exit}
8911 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
8912 for the compilation of the agenda. Buffers created by the user to
8913 visit Org files will not be removed.
8917 @node Custom agenda views, Exporting Agenda Views, Agenda commands, Agenda Views
8918 @section Custom agenda views
8919 @cindex custom agenda views
8920 @cindex agenda views, custom
8922 Custom agenda commands serve two purposes: to store and quickly access
8923 frequently used TODO and tags searches, and to create special composite
8924 agenda buffers. Custom agenda commands will be accessible through the
8925 dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
8928 * Storing searches:: Type once, use often
8929 * Block agenda:: All the stuff you need in a single buffer
8930 * Setting Options:: Changing the rules
8933 @node Storing searches, Block agenda, Custom agenda views, Custom agenda views
8934 @subsection Storing searches
8936 The first application of custom searches is the definition of keyboard
8937 shortcuts for frequently used searches, either creating an agenda
8938 buffer, or a sparse tree (the latter covering of course only the current
8941 @vindex org-agenda-custom-commands
8942 @cindex agenda views, main example
8943 @cindex agenda, as an agenda views
8944 @cindex agenda*, as an agenda views
8945 @cindex tags, as an agenda view
8946 @cindex todo, as an agenda view
8952 Custom commands are configured in the variable
8953 @code{org-agenda-custom-commands}. You can customize this variable, for
8954 example by pressing @kbd{C-c a C}. You can also directly set it with Emacs
8955 Lisp in @file{.emacs}. The following example contains all valid agenda
8960 (setq org-agenda-custom-commands
8963 ("w" todo "WAITING")
8964 ("W" todo-tree "WAITING")
8965 ("u" tags "+boss-urgent")
8966 ("v" tags-todo "+boss-urgent")
8967 ("U" tags-tree "+boss-urgent")
8968 ("f" occur-tree "\\<FIXME\\>")
8969 ("h" . "HOME+Name tags searches") ; description for "h" prefix
8970 ("hl" tags "+home+Lisa")
8971 ("hp" tags "+home+Peter")
8972 ("hk" tags "+home+Kim")))
8977 The initial string in each entry defines the keys you have to press
8978 after the dispatcher command @kbd{C-c a} in order to access the command.
8979 Usually this will be just a single character, but if you have many
8980 similar commands, you can also define two-letter combinations where the
8981 first character is the same in several combinations and serves as a
8982 prefix key@footnote{You can provide a description for a prefix key by
8983 inserting a cons cell with the prefix and the description.}. The second
8984 parameter is the search type, followed by the string or regular
8985 expression to be used for the matching. The example above will
8990 as a global search for agenda entries planned@footnote{@emph{Planned} means
8991 here that these entries have some planning information attached to them, like
8992 a time-stamp, a scheduled or a deadline string. See
8993 @var{org-agenda-entry-types} on how to set what planning information will be
8994 taken into account.} this week/day.
8996 as a global search for agenda entries planned this week/day, but only those
8997 with an hour specification like @code{[h]h:mm}---think of them as appointments.
8999 as a global search for TODO entries with @samp{WAITING} as the TODO
9002 as the same search, but only in the current buffer and displaying the
9003 results as a sparse tree
9005 as a global tags search for headlines marked @samp{:boss:} but not
9008 as the same search as @kbd{C-c a u}, but limiting the search to
9009 headlines that are also TODO items
9011 as the same search as @kbd{C-c a u}, but only in the current buffer and
9012 displaying the result as a sparse tree
9014 to create a sparse tree (again: current buffer only) with all entries
9015 containing the word @samp{FIXME}
9017 as a prefix command for a HOME tags search where you have to press an
9018 additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
9019 Peter, or Kim) as additional tag to match.
9022 Note that the @code{*-tree} agenda views need to be called from an
9023 Org buffer as they operate on the current buffer only.
9025 @node Block agenda, Setting Options, Storing searches, Custom agenda views
9026 @subsection Block agenda
9027 @cindex block agenda
9028 @cindex agenda, with block views
9030 Another possibility is the construction of agenda views that comprise
9031 the results of @emph{several} commands, each of which creates a block in
9032 the agenda buffer. The available commands include @code{agenda} for the
9033 daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
9034 for the global TODO list (as constructed with @kbd{C-c a t}), and the
9035 matching commands discussed above: @code{todo}, @code{tags}, and
9036 @code{tags-todo}. Here are two examples:
9040 (setq org-agenda-custom-commands
9041 '(("h" "Agenda and Home-related tasks"
9045 ("o" "Agenda and Office-related tasks"
9053 This will define @kbd{C-c a h} to create a multi-block view for stuff
9054 you need to attend to at home. The resulting agenda buffer will contain
9055 your agenda for the current week, all TODO items that carry the tag
9056 @samp{home}, and also all lines tagged with @samp{garden}. Finally the
9057 command @kbd{C-c a o} provides a similar view for office tasks.
9059 @node Setting Options, , Block agenda, Custom agenda views
9060 @subsection Setting options for custom commands
9061 @cindex options, for custom agenda views
9063 @vindex org-agenda-custom-commands
9064 Org mode contains a number of variables regulating agenda construction
9065 and display. The global variables define the behavior for all agenda
9066 commands, including the custom commands. However, if you want to change
9067 some settings just for a single custom view, you can do so. Setting
9068 options requires inserting a list of variable names and values at the
9069 right spot in @code{org-agenda-custom-commands}. For example:
9073 (setq org-agenda-custom-commands
9074 '(("w" todo "WAITING"
9075 ((org-agenda-sorting-strategy '(priority-down))
9076 (org-agenda-prefix-format " Mixed: ")))
9077 ("U" tags-tree "+boss-urgent"
9078 ((org-show-following-heading nil)
9079 (org-show-hierarchy-above nil)))
9081 ((org-agenda-files '("~org/notes.org"))
9082 (org-agenda-text-search-extra-files nil)))))
9087 Now the @kbd{C-c a w} command will sort the collected entries only by
9088 priority, and the prefix format is modified to just say @samp{ Mixed: }
9089 instead of giving the category of the entry. The sparse tags tree of
9090 @kbd{C-c a U} will now turn out ultra-compact, because neither the
9091 headline hierarchy above the match, nor the headline following the match
9092 will be shown. The command @kbd{C-c a N} will do a text search limited
9093 to only a single file.
9095 @vindex org-agenda-custom-commands
9096 For command sets creating a block agenda,
9097 @code{org-agenda-custom-commands} has two separate spots for setting
9098 options. You can add options that should be valid for just a single
9099 command in the set, and options that should be valid for all commands in
9100 the set. The former are just added to the command entry; the latter
9101 must come after the list of command entries. Going back to the block
9102 agenda example (@pxref{Block agenda}), let's change the sorting strategy
9103 for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
9104 the results for GARDEN tags query in the opposite order,
9105 @code{priority-up}. This would look like this:
9109 (setq org-agenda-custom-commands
9110 '(("h" "Agenda and Home-related tasks"
9114 ((org-agenda-sorting-strategy '(priority-up)))))
9115 ((org-agenda-sorting-strategy '(priority-down))))
9116 ("o" "Agenda and Office-related tasks"
9123 As you see, the values and parentheses setting is a little complex.
9124 When in doubt, use the customize interface to set this variable---it
9125 fully supports its structure. Just one caveat: when setting options in
9126 this interface, the @emph{values} are just Lisp expressions. So if the
9127 value is a string, you need to add the double-quotes around the value
9130 @vindex org-agenda-custom-commands-contexts
9131 To control whether an agenda command should be accessible from a specific
9132 context, you can customize @var{org-agenda-custom-commands-contexts}. Let's
9133 say for example that you have an agenda commands @code{"o"} displaying a view
9134 that you only need when reading emails. Then you would configure this option
9138 (setq org-agenda-custom-commands-contexts
9139 '(("o" (in-mode . "message-mode"))))
9142 You can also tell that the command key @code{"o"} should refer to another
9143 command key @code{"r"}. In that case, add this command key like this:
9146 (setq org-agenda-custom-commands-contexts
9147 '(("o" "r" (in-mode . "message-mode"))))
9150 See the docstring of the variable for more information.
9152 @node Exporting Agenda Views, Agenda column view, Custom agenda views, Agenda Views
9153 @section Exporting Agenda Views
9154 @cindex agenda views, exporting
9156 If you are away from your computer, it can be very useful to have a printed
9157 version of some agenda views to carry around. Org mode can export custom
9158 agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's
9159 @file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the
9160 ghostscript @file{ps2pdf} utility must be installed on the system. Selecting
9161 a PDF file will also create the postscript file.}, and iCalendar files. If
9162 you want to do this only occasionally, use the command
9165 @orgcmd{C-x C-w,org-agenda-write}
9166 @cindex exporting agenda views
9167 @cindex agenda views, exporting
9168 @vindex org-agenda-exporter-settings
9169 Write the agenda view to a file. Depending on the extension of the selected
9170 file name, the view will be exported as HTML (extension @file{.html} or
9171 @file{.htm}), Postscript (extension @file{.ps}), iCalendar (extension
9172 @file{.ics}), or plain text (any other extension). Use the variable
9173 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
9174 for @file{htmlize} to be used during export, for example
9176 @vindex org-agenda-add-entry-text-maxlines
9177 @vindex htmlize-output-type
9178 @vindex ps-number-of-columns
9179 @vindex ps-landscape-mode
9181 (setq org-agenda-exporter-settings
9182 '((ps-number-of-columns 2)
9183 (ps-landscape-mode t)
9184 (org-agenda-add-entry-text-maxlines 5)
9185 (htmlize-output-type 'css)))
9189 If you need to export certain agenda views frequently, you can associate
9190 any custom agenda command with a list of output file names
9191 @footnote{If you want to store standard views like the weekly agenda
9192 or the global TODO list as well, you need to define custom commands for
9193 them in order to be able to specify file names.}. Here is an example
9194 that first defines custom commands for the agenda and the global
9195 TODO list, together with a number of files to which to export them.
9196 Then we define two block agenda commands and specify file names for them
9197 as well. File names can be relative to the current working directory,
9202 (setq org-agenda-custom-commands
9203 '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
9204 ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
9205 ("h" "Agenda and Home-related tasks"
9210 ("~/views/home.html"))
9211 ("o" "Agenda and Office-related tasks"
9216 ("~/views/office.ps" "~/calendars/office.ics"))))
9220 The extension of the file name determines the type of export. If it is
9221 @file{.html}, Org mode will use the @file{htmlize.el} package to convert
9222 the buffer to HTML and save it to this file name. If the extension is
9223 @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
9224 Postscript output. If the extension is @file{.ics}, iCalendar export is
9225 run export over all files that were used to construct the agenda, and
9226 limit the export to entries listed in the agenda. Any other
9227 extension produces a plain ASCII file.
9229 The export files are @emph{not} created when you use one of those
9230 commands interactively because this might use too much overhead.
9231 Instead, there is a special command to produce @emph{all} specified
9235 @orgcmd{C-c a e,org-store-agenda-views}
9236 Export all agenda views that have export file names associated with
9240 You can use the options section of the custom agenda commands to also
9241 set options for the export commands. For example:
9244 (setq org-agenda-custom-commands
9246 ((ps-number-of-columns 2)
9247 (ps-landscape-mode t)
9248 (org-agenda-prefix-format " [ ] ")
9249 (org-agenda-with-colors nil)
9250 (org-agenda-remove-tags t))
9255 This command sets two options for the Postscript exporter, to make it
9256 print in two columns in landscape format---the resulting page can be cut
9257 in two and then used in a paper agenda. The remaining settings modify
9258 the agenda prefix to omit category and scheduling information, and
9259 instead include a checkbox to check off items. We also remove the tags
9260 to make the lines compact, and we don't want to use colors for the
9261 black-and-white printer. Settings specified in
9262 @code{org-agenda-exporter-settings} will also apply, but the settings
9263 in @code{org-agenda-custom-commands} take precedence.
9266 From the command line you may also use
9268 emacs -eval (org-batch-store-agenda-views) -kill
9271 or, if you need to modify some parameters@footnote{Quoting depends on the
9272 system you use, please check the FAQ for examples.}
9274 emacs -eval '(org-batch-store-agenda-views \
9275 org-agenda-span (quote month) \
9276 org-agenda-start-day "2007-11-01" \
9277 org-agenda-include-diary nil \
9278 org-agenda-files (quote ("~/org/project.org")))' \
9282 which will create the agenda views restricted to the file
9283 @file{~/org/project.org}, without diary entries and with a 30-day
9286 You can also extract agenda information in a way that allows further
9287 processing by other programs. See @ref{Extracting agenda information}, for
9291 @node Agenda column view, , Exporting Agenda Views, Agenda Views
9292 @section Using column view in the agenda
9293 @cindex column view, in agenda
9294 @cindex agenda, column view
9296 Column view (@pxref{Column view}) is normally used to view and edit
9297 properties embedded in the hierarchical structure of an Org file. It can be
9298 quite useful to use column view also from the agenda, where entries are
9299 collected by certain criteria.
9302 @orgcmd{C-c C-x C-c,org-agenda-columns}
9303 Turn on column view in the agenda.
9306 To understand how to use this properly, it is important to realize that the
9307 entries in the agenda are no longer in their proper outline environment.
9308 This causes the following issues:
9312 @vindex org-columns-default-format
9313 @vindex org-overriding-columns-format
9314 Org needs to make a decision which @code{COLUMNS} format to use. Since the
9315 entries in the agenda are collected from different files, and different files
9316 may have different @code{COLUMNS} formats, this is a non-trivial problem.
9317 Org first checks if the variable @code{org-agenda-overriding-columns-format} is
9318 currently set, and if so, takes the format from there. Otherwise it takes
9319 the format associated with the first item in the agenda, or, if that item
9320 does not have a specific format (defined in a property, or in its file), it
9321 uses @code{org-columns-default-format}.
9323 @cindex property, special, CLOCKSUM
9324 If any of the columns has a summary type defined (@pxref{Column attributes}),
9325 turning on column view in the agenda will visit all relevant agenda files and
9326 make sure that the computations of this property are up to date. This is
9327 also true for the special @code{CLOCKSUM} property. Org will then sum the
9328 values displayed in the agenda. In the daily/weekly agenda, the sums will
9329 cover a single day; in all other views they cover the entire block. It is
9330 vital to realize that the agenda may show the same entry @emph{twice} (for
9331 example as scheduled and as a deadline), and it may show two entries from the
9332 same hierarchy (for example a @emph{parent} and its @emph{child}). In these
9333 cases, the summation in the agenda will lead to incorrect results because
9334 some values will count double.
9336 When the column view in the agenda shows the @code{CLOCKSUM}, that is always
9337 the entire clocked time for this item. So even in the daily/weekly agenda,
9338 the clocksum listed in column view may originate from times outside the
9339 current view. This has the advantage that you can compare these values with
9340 a column listing the planned total effort for a task---one of the major
9341 applications for column view in the agenda. If you want information about
9342 clocked time in the displayed period use clock table mode (press @kbd{R} in
9346 @cindex property, special, CLOCKSUM_T
9347 When the column view in the agenda shows the @code{CLOCKSUM_T}, that is
9348 always today's clocked time for this item. So even in the weekly agenda,
9349 the clocksum listed in column view only originates from today. This lets
9350 you compare the time you spent on a task for today, with the time already
9351 spent (via @code{CLOCKSUM}) and with the planned total effort for it.
9355 @node Markup, Exporting, Agenda Views, Top
9356 @chapter Markup for rich export
9358 When exporting Org mode documents, the exporter tries to reflect the
9359 structure of the document as accurately as possible in the back-end. Since
9360 export targets like HTML, @LaTeX{} allow much richer formatting, Org mode has
9361 rules on how to prepare text for rich export. This section summarizes the
9362 markup rules used in an Org mode buffer.
9365 * Structural markup elements:: The basic structure as seen by the exporter
9366 * Images and tables:: Images, tables and caption mechanism
9367 * Literal examples:: Source code examples with special formatting
9368 * Include files:: Include additional files into a document
9369 * Index entries:: Making an index
9370 * Macro replacement:: Use macros to create complex output
9371 * Embedded @LaTeX{}:: LaTeX can be freely used inside Org documents
9374 @node Structural markup elements, Images and tables, Markup, Markup
9375 @section Structural markup elements
9378 * Document title:: Where the title is taken from
9379 * Headings and sections:: The document structure as seen by the exporter
9380 * Table of contents:: The if and where of the table of contents
9382 * Paragraphs:: Paragraphs
9383 * Footnote markup:: Footnotes
9384 * Emphasis and monospace:: Bold, italic, etc.
9385 * Horizontal rules:: Make a line
9386 * Comment lines:: What will *not* be exported
9389 @node Document title, Headings and sections, Structural markup elements, Structural markup elements
9390 @subheading Document title
9391 @cindex document title, markup rules
9394 The title of the exported document is taken from the special line
9398 #+TITLE: This is the title of the document
9402 If this line does not exist, the title will be the name of the file
9403 associated to buffer, without extension, or the buffer name.
9405 @cindex property, EXPORT_TITLE
9406 If you are exporting only a subtree by marking is as the region, the heading
9407 of the subtree will become the title of the document. If the subtree has a
9408 property @code{EXPORT_TITLE}, that will take precedence.
9410 @node Headings and sections, Table of contents, Document title, Structural markup elements
9411 @subheading Headings and sections
9412 @cindex headings and sections, markup rules
9414 @vindex org-export-headline-levels
9415 The outline structure of the document as described in @ref{Document
9416 Structure}, forms the basis for defining sections of the exported document.
9417 However, since the outline structure is also used for (for example) lists of
9418 tasks, only the first three outline levels will be used as headings. Deeper
9419 levels will become itemized lists. You can change the location of this
9420 switch globally by setting the variable @code{org-export-headline-levels}, or on a
9421 per-file basis with a line
9428 @node Table of contents, Lists, Headings and sections, Structural markup elements
9429 @subheading Table of contents
9430 @cindex table of contents, markup rules
9433 @vindex org-export-with-toc
9434 The table of contents is normally inserted directly before the first headline
9435 of the file. If you would like to get it to a different location, insert
9436 @code{#+TOC: headlines} at the desired location. The depth of the table of
9437 contents is by default the same as the number of headline levels, but you can
9438 choose a smaller number, or turn off the table of contents entirely, by
9439 configuring the variable @code{org-export-with-toc}, or on a per-file basis
9443 #+OPTIONS: toc:2 (only to two levels in TOC)
9444 #+TOC: headlines 2 (the same, at a specific location)
9445 #+OPTIONS: toc:nil (no TOC at all)
9448 The same @code{TOC} keyword can also generate a list of all tables (resp. all
9449 listings) with a caption in the buffer.
9452 #+TOC: listings (build a list of listings)
9453 #+TOC: tables (build a list of tables)
9456 @cindex property, ALT_TITLE
9457 The headline's title usually determines its corresponding entry in a table of
9458 contents. However, it is possible to specify an alternative title by
9459 setting @code{ALT_TITLE} property accordingly. It will then be used when
9462 @node Lists, Paragraphs, Table of contents, Structural markup elements
9464 @cindex lists, markup rules
9466 Plain lists as described in @ref{Plain lists}, are translated to the back-end's
9467 syntax for such lists. Most back-ends support unordered, ordered, and
9470 @node Paragraphs, Footnote markup, Lists, Structural markup elements
9471 @subheading Paragraphs, line breaks, and quoting
9472 @cindex paragraphs, markup rules
9474 Paragraphs are separated by at least one empty line. If you need to enforce
9475 a line break within a paragraph, use @samp{\\} at the end of a line.
9477 To keep the line breaks in a region, but otherwise use normal formatting, you
9478 can use this construct, which can also be used to format poetry.
9480 @cindex #+BEGIN_VERSE
9483 Great clouds overhead
9484 Tiny black birds rise and fall
9491 When quoting a passage from another document, it is customary to format this
9492 as a paragraph that is indented on both the left and the right margin. You
9493 can include quotations in Org mode documents like this:
9495 @cindex #+BEGIN_QUOTE
9498 Everything should be made as simple as possible,
9499 but not any simpler -- Albert Einstein
9503 If you would like to center some text, do it like this:
9504 @cindex #+BEGIN_CENTER
9507 Everything should be made as simple as possible, \\
9513 @node Footnote markup, Emphasis and monospace, Paragraphs, Structural markup elements
9514 @subheading Footnote markup
9515 @cindex footnotes, markup rules
9516 @cindex @file{footnote.el}
9518 Footnotes defined in the way described in @ref{Footnotes}, will be exported
9519 by all back-ends. Org allows multiple references to the same note, and
9520 multiple footnotes side by side.
9522 @node Emphasis and monospace, Horizontal rules, Footnote markup, Structural markup elements
9523 @subheading Emphasis and monospace
9525 @cindex underlined text, markup rules
9526 @cindex bold text, markup rules
9527 @cindex italic text, markup rules
9528 @cindex verbatim text, markup rules
9529 @cindex code text, markup rules
9530 @cindex strike-through text, markup rules
9531 @vindex org-fontify-emphasized-text
9532 @vindex org-emphasis-regexp-components
9533 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=}
9534 and @code{~verbatim~}, and, if you must, @samp{+strike-through+}. Text
9535 in the code and verbatim string is not processed for Org mode specific
9536 syntax; it is exported verbatim.
9538 To turn off fontification for marked up text, you can set
9539 @code{org-fontify-emphasized-text} to @code{nil}. To fine tune what
9540 characters are allowed before and after the special characters, see
9541 @code{org-emphasis-regexp-components}.
9543 @node Horizontal rules, Comment lines, Emphasis and monospace, Structural markup elements
9544 @subheading Horizontal rules
9545 @cindex horizontal rules, markup rules
9546 A line consisting of only dashes, and at least 5 of them, will be exported as
9547 a horizontal line (@samp{<hr/>} in HTML and @code{\hrule} in @LaTeX{}).
9549 @node Comment lines, , Horizontal rules, Structural markup elements
9550 @subheading Comment lines
9551 @cindex comment lines
9552 @cindex exporting, not
9553 @cindex #+BEGIN_COMMENT
9555 Lines starting with zero or more whitespace characters followed by one
9556 @samp{#} and a whitespace are treated as comments and will never be exported.
9557 Also entire subtrees starting with the word @samp{COMMENT} will never be
9558 exported. Finally, regions surrounded by @samp{#+BEGIN_COMMENT}
9559 ... @samp{#+END_COMMENT} will not be exported.
9564 Toggle the COMMENT keyword at the beginning of an entry.
9568 @node Images and tables, Literal examples, Structural markup elements, Markup
9569 @section Images and Tables
9571 @cindex tables, markup rules
9574 Both the native Org mode tables (@pxref{Tables}) and tables formatted with
9575 the @file{table.el} package will be exported properly. For Org mode tables,
9576 the lines before the first horizontal separator line will become table header
9577 lines. You can use the following lines somewhere before the table to assign
9578 a caption and a label for cross references, and in the text you can refer to
9579 the object with @code{[[tab:basic-data]]} (@pxref{Internal links}):
9582 #+CAPTION: This is the caption for the next table (or link)
9583 #+NAME: tab:basic-data
9588 Optionally, the caption can take the form:
9590 #+CAPTION[Caption for list of tables]: Caption for table.
9593 @cindex inlined images, markup rules
9594 Some back-ends allow you to directly include images into the exported
9595 document. Org does this, if a link to an image files does not have
9596 a description part, for example @code{[[./img/a.jpg]]}. If you wish to
9597 define a caption for the image and maybe a label for internal cross
9598 references, make sure that the link is on a line by itself and precede it
9599 with @code{#+CAPTION} and @code{#+NAME} as follows:
9602 #+CAPTION: This is the caption for the next figure link (or table)
9603 #+NAME: fig:SED-HR4049
9608 Such images can be displayed within the buffer. @xref{Handling links,the
9609 discussion of image links}.
9611 Even though images and tables are prominent examples of captioned structures,
9612 the same caption mechanism can apply to many others (e.g., @LaTeX{}
9613 equations, source code blocks). Depending on the export back-end, those may
9614 or may not be handled.
9616 @node Literal examples, Include files, Images and tables, Markup
9617 @section Literal examples
9618 @cindex literal examples, markup rules
9619 @cindex code line references, markup rules
9621 You can include literal examples that should not be subjected to
9622 markup. Such examples will be typeset in monospace, so this is well suited
9623 for source code and similar examples.
9624 @cindex #+BEGIN_EXAMPLE
9628 Some example from a text file.
9632 Note that such blocks may be @i{indented} in order to align nicely with
9633 indented text and in particular with plain list structure (@pxref{Plain
9634 lists}). For simplicity when using small examples, you can also start the
9635 example lines with a colon followed by a space. There may also be additional
9636 whitespace before the colon:
9640 : Some example from a text file.
9643 @cindex formatting source code, markup rules
9644 If the example is source code from a programming language, or any other text
9645 that can be marked up by font-lock in Emacs, you can ask for the example to
9646 look like the fontified Emacs buffer@footnote{This works automatically for
9647 the HTML back-end (it requires version 1.34 of the @file{htmlize.el} package,
9648 which is distributed with Org). Fontified code chunks in @LaTeX{} can be
9649 achieved using either the listings or the
9650 @url{http://code.google.com/p/minted, minted,} package. Refer to
9651 @code{org-latex-listings} documentation for details.}. This is done
9652 with the @samp{src} block, where you also need to specify the name of the
9653 major mode that should be used to fontify the example@footnote{Code in
9654 @samp{src} blocks may also be evaluated either interactively or on export.
9655 See @pxref{Working With Source Code} for more information on evaluating code
9656 blocks.}, see @ref{Easy Templates} for shortcuts to easily insert code
9661 #+BEGIN_SRC emacs-lisp
9662 (defun org-xor (a b)
9668 Both in @code{example} and in @code{src} snippets, you can add a @code{-n}
9669 switch to the end of the @code{BEGIN} line, to get the lines of the example
9670 numbered. If you use a @code{+n} switch, the numbering from the previous
9671 numbered snippet will be continued in the current one. In literal examples,
9672 Org will interpret strings like @samp{(ref:name)} as labels, and use them as
9673 targets for special hyperlinks like @code{[[(name)]]} (i.e., the reference name
9674 enclosed in single parenthesis). In HTML, hovering the mouse over such a
9675 link will remote-highlight the corresponding code line, which is kind of
9678 You can also add a @code{-r} switch which @i{removes} the labels from the
9679 source code@footnote{Adding @code{-k} to @code{-n -r} will @i{keep} the
9680 labels in the source code while using line numbers for the links, which might
9681 be useful to explain those in an Org mode example code.}. With the @code{-n}
9682 switch, links to these references will be labeled by the line numbers from
9683 the code listing, otherwise links will use the labels with no parentheses.
9687 #+BEGIN_SRC emacs-lisp -n -r
9688 (save-excursion (ref:sc)
9689 (goto-char (point-min)) (ref:jump)
9691 In line [[(sc)]] we remember the current position. [[(jump)][Line (jump)]]
9695 @vindex org-coderef-label-format
9696 If the syntax for the label format conflicts with the language syntax, use a
9697 @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
9698 -n -r -l "((%s))"}. See also the variable @code{org-coderef-label-format}.
9700 HTML export also allows examples to be published as text areas (@pxref{Text
9701 areas in HTML export}).
9703 Because the @code{#+BEGIN_...} and @code{#+END_...} patterns need to be added
9704 so often, shortcuts are provided using the Easy Templates facility
9705 (@pxref{Easy Templates}).
9710 Edit the source code example at point in its native mode. This works by
9711 switching to a temporary buffer with the source code. You need to exit by
9712 pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*},
9713 @samp{,*}, @samp{#+} and @samp{,#+} will get a comma prepended, to keep them
9714 from being interpreted by Org as outline nodes or special syntax. These
9715 commas will be stripped for editing with @kbd{C-c '}, and also for export.}.
9716 The edited version will then replace the old version in the Org buffer.
9717 Fixed-width regions (where each line starts with a colon followed by a space)
9718 will be edited using @code{artist-mode}@footnote{You may select
9719 a different-mode with the variable @code{org-edit-fixed-width-region-mode}.}
9720 to allow creating ASCII drawings easily. Using this command in an empty line
9721 will create a new fixed-width region.
9724 Calling @code{org-store-link} while editing a source code example in a
9725 temporary buffer created with @kbd{C-c '} will prompt for a label. Make sure
9726 that it is unique in the current buffer, and insert it with the proper
9727 formatting like @samp{(ref:label)} at the end of the current line. Then the
9728 label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
9732 @node Include files, Index entries, Literal examples, Markup
9733 @section Include files
9734 @cindex include files, markup rules
9736 During export, you can include the content of another file. For example, to
9737 include your @file{.emacs} file, you could use:
9741 #+INCLUDE: "~/.emacs" src emacs-lisp
9745 The optional second and third parameter are the markup (e.g., @samp{quote},
9746 @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the
9747 language for formatting the contents. The markup is optional; if it is not
9748 given, the text will be assumed to be in Org mode format and will be
9751 Contents of the included file will belong to the same structure (headline,
9752 item) containing the INCLUDE keyword. In particular, headlines within the
9753 file will become children of the current section. That behaviour can be
9754 changed by providing an additional keyword parameter, @code{:minlevel}. In
9755 that case, all headlines in the included file will be shifted so the one with
9756 the lowest level reaches that specified level. For example, to make a file
9757 become a sibling of the current top-level headline, use
9760 #+INCLUDE: "~/my-book/chapter2.org" :minlevel 1
9763 You can also include a portion of a file by specifying a lines range using
9764 the @code{:lines} parameter. The line at the upper end of the range will not
9765 be included. The start and/or the end of the range may be omitted to use the
9769 #+INCLUDE: "~/.emacs" :lines "5-10" @r{Include lines 5 to 10, 10 excluded}
9770 #+INCLUDE: "~/.emacs" :lines "-10" @r{Include lines 1 to 10, 10 excluded}
9771 #+INCLUDE: "~/.emacs" :lines "10-" @r{Include lines from 10 to EOF}
9777 Visit the include file at point.
9780 @node Index entries, Macro replacement, Include files, Markup
9781 @section Index entries
9782 @cindex index entries, for publishing
9784 You can specify entries that will be used for generating an index during
9785 publishing. This is done by lines starting with @code{#+INDEX}. An entry
9786 the contains an exclamation mark will create a sub item. See @ref{Generating
9787 an index} for more information.
9792 #+INDEX: Application!CV
9798 @node Macro replacement, Embedded @LaTeX{}, Index entries, Markup
9799 @section Macro replacement
9800 @cindex macro replacement, during export
9803 You can define text snippets with
9806 #+MACRO: name replacement text $1, $2 are arguments
9809 @noindent which can be referenced in
9810 paragraphs, verse blocks, table cells and some keywords with
9811 @code{@{@{@{name(arg1,arg2)@}@}@}}@footnote{Since commas separate arguments,
9812 commas within arguments have to be escaped with a backslash character.
9813 Conversely, backslash characters before a comma, and only them, need to be
9814 escaped with another backslash character.}. In addition to defined macros,
9815 @code{@{@{@{title@}@}@}}, @code{@{@{@{author@}@}@}}, etc., will reference
9816 information set by the @code{#+TITLE:}, @code{#+AUTHOR:}, and similar lines.
9817 Also, @code{@{@{@{date(@var{FORMAT})@}@}@}} and
9818 @code{@{@{@{modification-time(@var{FORMAT})@}@}@}} refer to current date time
9819 and to the modification time of the file being exported, respectively.
9820 @var{FORMAT} should be a format string understood by
9821 @code{format-time-string}.
9823 Macro expansion takes place during export.
9826 @node Embedded @LaTeX{}, , Macro replacement, Markup
9827 @section Embedded @LaTeX{}
9828 @cindex @TeX{} interpretation
9829 @cindex @LaTeX{} interpretation
9831 Plain ASCII is normally sufficient for almost all note taking. Exceptions
9832 include scientific notes, which often require mathematical symbols and the
9833 occasional formula. @LaTeX{}@footnote{@LaTeX{} is a macro system based on
9834 Donald E. Knuth's @TeX{} system. Many of the features described here as
9835 ``@LaTeX{}'' are really from @TeX{}, but for simplicity I am blurring this
9836 distinction.} is widely used to typeset scientific documents. Org mode
9837 supports embedding @LaTeX{} code into its files, because many academics are
9838 used to writing and reading @LaTeX{} source code, and because it can be
9839 readily processed to produce pretty output for a number of export back-ends.
9842 * Special symbols:: Greek letters and other symbols
9843 * Subscripts and superscripts:: Simple syntax for raising/lowering text
9844 * @LaTeX{} fragments:: Complex formulas made easy
9845 * Previewing @LaTeX{} fragments:: What will this snippet look like?
9846 * CDLaTeX mode:: Speed up entering of formulas
9849 @node Special symbols, Subscripts and superscripts, Embedded @LaTeX{}, Embedded @LaTeX{}
9850 @subsection Special symbols
9851 @cindex math symbols
9852 @cindex special symbols
9853 @cindex @TeX{} macros
9854 @cindex @LaTeX{} fragments, markup rules
9855 @cindex HTML entities
9856 @cindex @LaTeX{} entities
9858 You can use @LaTeX{}-like syntax to insert special symbols like @samp{\alpha}
9859 to indicate the Greek letter, or @samp{\to} to indicate an arrow. Completion
9860 for these symbols is available, just type @samp{\} and maybe a few letters,
9861 and press @kbd{M-@key{TAB}} to see possible completions. Unlike @LaTeX{}
9862 code, Org mode allows these symbols to be present without surrounding math
9863 delimiters, for example:
9866 Angles are written as Greek letters \alpha, \beta and \gamma.
9869 @vindex org-entities
9870 During export, these symbols will be transformed into the native format of
9871 the exporter back-end. Strings like @code{\alpha} will be exported as
9872 @code{α} in the HTML output, and as @code{$\alpha$} in the @LaTeX{}
9873 output. Similarly, @code{\nbsp} will become @code{ } in HTML and
9874 @code{~} in @LaTeX{}. If you need such a symbol inside a word, terminate it
9875 like this: @samp{\Aacute@{@}stor}.
9877 A large number of entities is provided, with names taken from both HTML and
9878 @LaTeX{}; see the variable @code{org-entities} for the complete list.
9879 @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
9880 @samp{...} are all converted into special commands creating hyphens of
9881 different lengths or a compact set of dots.
9883 If you would like to see entities displayed as UTF-8 characters, use the
9884 following command@footnote{You can turn this on by default by setting the
9885 variable @code{org-pretty-entities}, or on a per-file base with the
9886 @code{#+STARTUP} option @code{entitiespretty}.}:
9889 @cindex @code{entitiespretty}, STARTUP keyword
9892 Toggle display of entities as UTF-8 characters. This does not change the
9893 buffer content which remains plain ASCII, but it overlays the UTF-8 character
9894 for display purposes only.
9897 @node Subscripts and superscripts, @LaTeX{} fragments, Special symbols, Embedded @LaTeX{}
9898 @subsection Subscripts and superscripts
9902 Just like in @LaTeX{}, @samp{^} and @samp{_} are used to indicate super- and
9903 subscripts. Again, these can be used without embedding them in math-mode
9904 delimiters. To increase the readability of ASCII text, it is not necessary
9905 (but OK) to surround multi-character sub- and superscripts with curly braces.
9909 The mass of the sun is M_sun = 1.989 x 10^30 kg. The radius of
9910 the sun is R_@{sun@} = 6.96 x 10^8 m.
9913 @vindex org-use-sub-superscripts
9914 To avoid interpretation as raised or lowered text, you can quote @samp{^} and
9915 @samp{_} with a backslash: @samp{\^} and @samp{\_}. If you write a text
9916 where the underscore is often used in a different context, Org's convention
9917 to always interpret these as subscripts can get in your way. Configure the
9918 variable @code{org-use-sub-superscripts} to change this convention. For
9919 example, when setting this variable to @code{@{@}}, @samp{a_b} will not be
9920 interpreted as a subscript, but @samp{a_@{b@}} will.
9925 In addition to showing entities as UTF-8 characters, this command will also
9926 format sub- and superscripts in a WYSIWYM way.
9929 @node @LaTeX{} fragments, Previewing @LaTeX{} fragments, Subscripts and superscripts, Embedded @LaTeX{}
9930 @subsection @LaTeX{} fragments
9931 @cindex @LaTeX{} fragments
9933 @vindex org-format-latex-header
9934 Going beyond symbols and sub- and superscripts, a full formula language is
9935 needed. Org mode can contain @LaTeX{} math fragments, and it supports ways
9936 to process these for several export back-ends. When exporting to @LaTeX{},
9937 the code is obviously left as it is. When exporting to HTML, Org invokes the
9938 @uref{http://www.mathjax.org, MathJax library} (@pxref{Math formatting in
9939 HTML export}) to process and display the math@footnote{If you plan to use
9940 this regularly or on pages with significant page views, you should install
9941 @file{MathJax} on your own server in order to limit the load of our server.}.
9942 Finally, it can also process the mathematical expressions into
9943 images@footnote{For this to work you need to be on a system with a working
9944 @LaTeX{} installation. You also need the @file{dvipng} program or the
9945 @file{convert}, respectively available at
9946 @url{http://sourceforge.net/projects/dvipng/} and from the @file{imagemagick}
9947 suite. The @LaTeX{} header that will be used when processing a fragment can
9948 be configured with the variable @code{org-format-latex-header}.} that can be
9949 displayed in a browser.
9951 @LaTeX{} fragments don't need any special marking at all. The following
9952 snippets will be identified as @LaTeX{} source code:
9955 Environments of any kind@footnote{When @file{MathJax} is used, only the
9956 environments recognized by @file{MathJax} will be processed. When
9957 @file{dvipng} is used to create images, any @LaTeX{} environment will be
9958 handled.}. The only requirement is that the @code{\begin} and @code{\end}
9959 statements appear on a new line, at the beginning of the line or after
9962 Text within the usual @LaTeX{} math delimiters. To avoid conflicts with
9963 currency specifications, single @samp{$} characters are only recognized as
9964 math delimiters if the enclosed text contains at most two line breaks, is
9965 directly attached to the @samp{$} characters with no whitespace in between,
9966 and if the closing @samp{$} is followed by whitespace, punctuation or a dash.
9967 For the other delimiters, there is no such restriction, so when in doubt, use
9968 @samp{\(...\)} as inline math delimiters.
9971 @noindent For example:
9978 If $a^2=b$ and \( b=2 \), then the solution must be
9979 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
9984 @c @vindex org-format-latex-options
9985 @c If you need any of the delimiter ASCII sequences for other purposes, you
9986 @c can configure the option @code{org-format-latex-options} to deselect the
9987 @c ones you do not wish to have interpreted by the @LaTeX{} converter.
9989 @vindex org-export-with-latex
9990 @LaTeX{} processing can be configured with the variable
9991 @code{org-export-with-latex}. The default setting is @code{t} which means
9992 @file{MathJax} for HTML, and no processing for ASCII and @LaTeX{} back-ends.
9993 You can also set this variable on a per-file basis using one of these
9997 #+OPTIONS: tex:t @r{Do the right thing automatically (MathJax)}
9998 #+OPTIONS: tex:dvipng @r{Force using dvipng images}
9999 #+OPTIONS: tex:nil @r{Do not process @LaTeX{} fragments at all}
10000 #+OPTIONS: tex:verbatim @r{Verbatim export, for jsMath or so}
10003 @node Previewing @LaTeX{} fragments, CDLaTeX mode, @LaTeX{} fragments, Embedded @LaTeX{}
10004 @subsection Previewing @LaTeX{} fragments
10005 @cindex @LaTeX{} fragments, preview
10007 @vindex org-latex-create-formula-image-program
10008 If you have @file{dvipng} or @file{imagemagick} installed@footnote{Choose the
10009 converter by setting the variable
10010 @code{org-latex-create-formula-image-program} accordingly.}, @LaTeX{}
10011 fragments can be processed to produce preview images of the typeset
10015 @kindex C-c C-x C-l
10017 Produce a preview image of the @LaTeX{} fragment at point and overlay it
10018 over the source code. If there is no fragment at point, process all
10019 fragments in the current entry (between two headlines). When called
10020 with a prefix argument, process the entire subtree. When called with
10021 two prefix arguments, or when the cursor is before the first headline,
10022 process the entire buffer.
10025 Remove the overlay preview images.
10028 @vindex org-format-latex-options
10029 You can customize the variable @code{org-format-latex-options} to influence
10030 some aspects of the preview. In particular, the @code{:scale} (and for HTML
10031 export, @code{:html-scale}) property can be used to adjust the size of the
10034 @vindex org-startup-with-latex-preview
10035 You can turn on the previewing of all @LaTeX{} fragments in a file with
10038 #+STARTUP: latexpreview
10041 To disable it, simply use
10044 #+STARTUP: nolatexpreview
10047 @node CDLaTeX mode, , Previewing @LaTeX{} fragments, Embedded @LaTeX{}
10048 @subsection Using CD@LaTeX{} to enter math
10051 CD@LaTeX{} mode is a minor mode that is normally used in combination with a
10052 major @LaTeX{} mode like AUC@TeX{} in order to speed-up insertion of
10053 environments and math templates. Inside Org mode, you can make use of
10054 some of the features of CD@LaTeX{} mode. You need to install
10055 @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
10056 AUC@TeX{}) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
10057 Don't use CD@LaTeX{} mode itself under Org mode, but use the light
10058 version @code{org-cdlatex-mode} that comes as part of Org mode. Turn it
10059 on for the current buffer with @code{M-x org-cdlatex-mode}, or for all
10063 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
10066 When this mode is enabled, the following features are present (for more
10067 details see the documentation of CD@LaTeX{} mode):
10071 Environment templates can be inserted with @kbd{C-c @{}.
10074 The @key{TAB} key will do template expansion if the cursor is inside a
10075 @LaTeX{} fragment@footnote{Org mode has a method to test if the cursor is
10076 inside such a fragment, see the documentation of the function
10077 @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will
10078 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
10079 correctly inside the first brace. Another @key{TAB} will get you into
10080 the second brace. Even outside fragments, @key{TAB} will expand
10081 environment abbreviations at the beginning of a line. For example, if
10082 you write @samp{equ} at the beginning of a line and press @key{TAB},
10083 this abbreviation will be expanded to an @code{equation} environment.
10084 To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}.
10088 @vindex cdlatex-simplify-sub-super-scripts
10089 Pressing @kbd{_} and @kbd{^} inside a @LaTeX{} fragment will insert these
10090 characters together with a pair of braces. If you use @key{TAB} to move
10091 out of the braces, and if the braces surround only a single character or
10092 macro, they are removed again (depending on the variable
10093 @code{cdlatex-simplify-sub-super-scripts}).
10096 Pressing the backquote @kbd{`} followed by a character inserts math
10097 macros, also outside @LaTeX{} fragments. If you wait more than 1.5 seconds
10098 after the backquote, a help window will pop up.
10101 Pressing the single-quote @kbd{'} followed by another character modifies
10102 the symbol before point with an accent or a font. If you wait more than
10103 1.5 seconds after the single-quote, a help window will pop up. Character
10104 modification will work only inside @LaTeX{} fragments; outside the quote
10108 @node Exporting, Publishing, Markup, Top
10112 Org mode documents can be exported into a variety of other formats.
10114 For printing and sharing notes, ASCII export produces a readable and simple
10115 version of an Org file. HTML export allows you to publish a notes file on
10116 the web. @LaTeX{} export lets you use Org mode and its structured editing
10117 functions to easily create @LaTeX{} files. OpenDocument Text (ODT) export
10118 allows seamless collaboration across organizational boundaries. To
10119 incorporate entries with associated times like deadlines or appointments into
10120 a desktop calendar program like iCal, Org mode can also produce extracts in
10121 the iCalendar format.
10124 * The Export Dispatcher:: The main exporter interface
10125 * Export formats:: Available export formats
10126 * Export settings:: Generic export settings
10127 * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
10128 * HTML export:: Exporting to HTML
10129 * @LaTeX{} and PDF export:: Exporting to @LaTeX{}, and processing to PDF
10130 * OpenDocument Text export:: Exporting to OpenDocument Text
10131 * iCalendar export:: Exporting in iCalendar format
10134 @node The Export Dispatcher, Export formats, Exporting, Exporting
10135 @section The Export Dispatcher
10136 @vindex org-export-dispatch-use-expert-ui
10137 @cindex Export, dispatcher
10139 The main entry point for any export related task is the dispatcher, a
10140 hierarchical menu@footnote{It is also possible to use a less intrusive
10141 interface by setting @var{org-export-dispatch-use-expert-ui} to a non-nil
10142 value. In that case, only a prompt is visible from the minibuffer. From
10143 there one can still switch back to regular menu with @kbd{?} key.} from
10144 which it is possible to select an export format and to toggle export
10149 @orgcmd{C-c C-e,org-export-dispatch}
10151 Dispatch for export and publishing commands. When called with @kbd{C-u}
10152 prefix argument, repeat last command, preserving toggled options, on
10153 current buffer. If the active buffer hasn't changed and subtree export was
10154 activated, the command will affect that same subtree.
10158 Normally the entire buffer is exported, but if there is an active region
10159 only that part of the buffer will be exported.
10161 Export options can also, among other things, affect the scope of export
10162 process. They are toggled from the dispatcher with appropriate key
10167 @vindex org-export-async-init-file
10168 @vindex org-export-run-in-background
10169 Toggles asynchronous export. The export happens in an external Emacs
10170 process@footnote{Configure @var{org-export-async-init-file} to properly set
10173 In this case, no output is displayed automatically. It is stored in a list
10174 called the export stack, and can be viewed from there. The stack can be
10175 reached by calling the dispatcher with a double @kbd{C-u} prefix argument,
10176 or with @kbd{&} key from the dispatcher.
10178 To make this behaviour the default, customize the variable successfully
10179 @var{org-export-run-in-background}.
10182 Toggles body-only export. Its effect, if any, depends on the back-end
10183 used. Its purpose is to remove all meta-data from output and focus on the
10187 @vindex org-export-initial-scope
10188 Toggles subtree export. The top heading becomes the document title and is
10189 removed from the contents.
10191 You can change the default state of this option by setting
10192 @var{org-export-initial-scope}.
10195 Toggles visible-only export. Only export the text that is currently
10196 visible, i.e. not hidden by outline visibility in the buffer.
10200 @vindex org-export-copy-to-kill-ring
10201 Unless it happened asynchronously, a successful export process usually
10202 stores its output into the kill-ring. You can configure
10203 @var{org-export-copy-to-kill-ring} in order to change this behaviour.
10205 @node Export formats, Export settings, The Export Dispatcher, Exporting
10206 @section Export formats
10207 @cindex Export, formats
10209 Libraries translating an Org buffer into a foreign format are called export
10210 back-ends. An export format is not available until the proper back-end has
10213 @vindex org-export-backends
10214 By default, the following four back-ends are ready to use: @code{ascii},
10215 @code{html}, @code{icalendar} and @code{latex}. It is possible to add more
10216 (or remove some) by customizing @var{org-export-backends}.
10218 Core back-ends include:
10221 @item ascii (ASCII format)
10222 @item beamer (@LaTeX{} Beamer format)
10223 @item html (HTML format)
10224 @item icalendar (iCalendar format)
10225 @item latex (@LaTeX{} format)
10226 @item man (Man page format)
10227 @item md (Markdown format)
10228 @item odt (OpenDocument Text format)
10229 @item texinfo (Texinfo format)
10232 More are available from the @code{contrib/} directory available from the
10233 distribution archives or from GNU/Org ELPA.
10235 @node Export settings, ASCII/Latin-1/UTF-8 export, Export formats, Exporting
10236 @section Export settings
10237 @cindex Export, settings
10239 Export output can be controlled through a number of export options. These
10240 can be set globally with variables, and overridden on a per-buffer basis
10241 with keywords. Such keywords may be put anywhere in the file. For
10242 individual lines, a good way to make sure the keyword is correct is to type
10243 @code{#+} and then use @kbd{M-<TAB>} completion.
10245 Here is an exhaustive list of such keywords along with the equivalent
10246 global variable. Only options available for every back-end are discussed
10251 @vindex user-full-name
10252 the author (@var{user-full-name}).
10255 @vindex org-export-creator-string
10256 entity responsible for output generation (@var{org-export-creator-string}).
10259 @vindex org-export-date-timestamp-format
10260 A date or a time-stamp@footnote{The variable
10261 @var{org-export-date-timestamp-format} defines how this time-stamp will be
10265 the page description, e.g., for the XHTML meta tag.
10268 @vindex user-mail-address
10269 email address (@var{user-mail-address}).
10272 Tags that exclude a tree from export
10275 keywords defining the contents, e.g., for the XHTML meta tag.
10278 @vindex org-export-default-language
10279 language used for translation of some strings
10280 (@var{org-export-default-language}).
10283 @vindex org-export-select-tags
10284 Tags that select a tree for export (@var{org-export-select-tags}).
10287 the title to be shown (otherwise derived from buffer's name).
10290 Additionally, the @code{OPTIONS} keyword is a compact@footnote{If you want
10291 to configure many options this way, you can use several @code{#+OPTIONS}
10292 lines.} form to specify export settings. Here you can:
10296 @vindex org-export-with-smart-quotes
10297 toggle smart quotes (@var{org-export-with-smart-quotes}).
10300 toggle emphasized text (@var{org-export-with-emphasize}).
10303 @vindex org-export-with-special-strings
10304 toggle conversion of special strings
10305 (@var{org-export-with-special-strings}).
10308 @vindex org-export-with-fixed-width
10309 toggle fixed-width sections
10310 (@var{org-export-with-fixed-width}).
10313 @vindex org-export-with-timestamps
10314 toggle inclusion of any time/date stamps like DEADLINES
10315 (@var{org-export-with-timestamps}).
10318 @vindex org-export-preserve-breaks
10319 toggle line-break-preservation (@var{org-export-preserve-breaks}).
10322 @vindex org-export-with-sub-superscripts
10323 toggle @TeX{}-like syntax for sub- and superscripts. If you write "^:@{@}",
10324 @samp{a_@{b@}} will be interpreted, but the simple @samp{a_b} will be left as
10325 it is (@var{org-export-with-sub-superscripts}).
10328 @vindex org-export-with-archived-trees
10329 configure export of archived trees. Can be set to @code{headline} to only
10330 process the headline, skipping its contents
10331 (@var{org-export-with-archived-trees}).
10334 @vindex org-export-with-author
10335 toggle inclusion of author name into exported file
10336 (@var{org-export-with-author}).
10339 @vindex org-export-with-clocks
10340 toggle inclusion of CLOCK keywords (@var{org-export-with-clocks}).
10343 @vindex org-export-with-creator
10344 configure inclusion of creator info into exported file. It may be set to
10345 @code{comment} (@var{org-export-with-creator}).
10348 @vindex org-export-with-drawers
10349 toggle inclusion of drawers, or list drawers to include
10350 (@var{org-export-with-drawers}).
10353 @vindex org-export-with-entities
10354 toggle inclusion of entities (@var{org-export-with-entities}).
10357 @vindex org-export-with-email
10358 toggle inclusion of author email into exported file
10359 (@var{org-export-with-email}).
10362 @vindex org-export-with-footnotes
10363 toggle footnotes (@var{org-export-with-footnotes}).
10366 @vindex org-export-headline-levels
10367 set the number of headline levels for export
10368 (@var{org-export-headline-levels}).
10371 @vindex org-export-with-inlinetasks
10372 toggle inclusion of inlinetasks (@var{org-export-with-inlinetasks}).
10375 @vindex org-export-with-section-numbers
10376 toggle section-numbers (@var{org-export-with-section-numbers}).
10379 @vindex org-export-with-planning
10380 toggle export of planning information (e.g. deadlines)
10381 (@var{org-export-with-planning}).
10384 @vindex org-export-with-priority
10385 toggle priority cookies (@var{org-export-with-priority}).
10388 @vindex org-export-with-statistics-cookies
10389 toggle inclusion of statistics cookies
10390 (@var{org-export-with-statistics-cookies}).
10393 @vindex org-export-with-tags
10394 toggle inclusion of tags, may also be @code{not-in-toc}
10395 (@var{org-export-with-tags}).
10398 @vindex org-export-with-tasks
10399 toggle inclusion of tasks (TODO items), can be @code{nil} to remove all
10400 tasks, @code{todo} to remove DONE tasks, or a list of keywords to keep
10401 (@var{org-export-with-tasks}).
10404 @vindex org-export-with-latex
10405 configure export of @LaTeX{} fragments and environments. It may be set to
10406 @code{verbatim} (@var{org-export-with-latex}).
10409 @vindex org-export-time-stamp-file
10410 toggle inclusion creation time into exported file
10411 (@var{org-export-time-stamp-file}).
10414 @vindex org-export-with-toc
10415 toggle table of contents, or set level limit (@var{org-export-with-toc}).
10418 @vindex org-export-with-todo-keywords
10419 toggle inclusion of TODO keywords into exported text
10420 (@var{org-export-with-todo-keywords}).
10423 @vindex org-export-with-tables
10424 toggle tables (@var{org-export-with-tables}).
10428 A more general mechanism is also provided. Indeed, Emacs variables can
10429 become buffer-local during export by using the BIND keyword. Its syntax is
10430 @samp{#+BIND: variable value}. This is particularly useful for in-buffer
10431 settings that cannot be changed using specific keywords.
10433 You can place commonly-used export settings in a separate file which can be
10434 included using @samp{#+SETUPFILE: filename} syntax.
10436 These settings affect all buffer's export processes. Though, it is
10437 possible to override them locally when exporting only a subtree. This is
10438 done by adding a headline property named after the keyword with the
10439 @samp{EXPORT_} prefix. For example, @samp{DATE} and @samp{OPTIONS}
10440 keywords become, respectively @samp{EXPORT_DATE} and @samp{EXPORT_OPTIONS}
10441 properties. Subtree export also supports the self-explicit
10442 @samp{EXPORT_FILE_NAME} property@footnote{There is no buffer-wide
10443 equivalent for this property. The file name in this case is derived from
10444 the file associated to the buffer, if possible, or asked to the user
10447 @node ASCII/Latin-1/UTF-8 export, HTML export, Export settings, Exporting
10448 @section ASCII/Latin-1/UTF-8 export
10449 @cindex ASCII export
10450 @cindex Latin-1 export
10451 @cindex UTF-8 export
10453 ASCII export produces a simple and very readable version of an Org mode
10454 file, containing only plain ASCII@. Latin-1 and UTF-8 export augment the file
10455 with special characters and symbols available in these encodings.
10457 @cindex region, active
10458 @cindex active region
10459 @cindex transient-mark-mode
10461 @orgcmd{C-c C-e t a,org-ascii-export-to-ascii}
10462 @cindex property, EXPORT_FILE_NAME
10463 Export as an ASCII file. For an Org file, @file{myfile.org}, the ASCII file
10464 will be @file{myfile.txt}. The file will be overwritten without
10465 warning. If there is an active region@footnote{This requires
10466 @code{transient-mark-mode} be turned on.}, only the region will be
10467 exported. If the selected region is a single tree@footnote{To select the
10468 current subtree, use @kbd{C-c @@}.}, the tree head will
10469 become the document title. If the tree head entry has or inherits an
10470 @code{EXPORT_FILE_NAME} property, that name will be used for the
10472 @orgcmd{C-c C-e t A,org-ascii-export-as-ascii}
10473 Export to a temporary buffer. Do not create a file.
10474 @item C-c C-e C-v t a/t A
10475 Export only the visible part of the document.
10478 @c FIXME Exporting sublevels
10479 @c @cindex headline levels, for exporting
10480 @c In the exported version, the first 3 outline levels will become
10481 @c headlines, defining a general document structure. Additional levels
10482 @c will be exported as itemized lists. If you want that transition to occur
10483 @c at a different level, specify it with a prefix argument. For example,
10486 @c @kbd{C-1 C-c C-e a}
10490 @c creates only top level headlines and exports the rest as items. When
10491 @c headlines are converted to items, the indentation of the text following
10492 @c the headline is changed to fit nicely under the item. This is done with
10493 @c the assumption that the first body line indicates the base indentation of
10494 @c the body text. Any indentation larger than this is adjusted to preserve
10495 @c the layout relative to the first line. Should there be lines with less
10496 @c indentation than the first one, these are left alone.
10498 @vindex org-ascii-links-to-notes
10499 Links will be exported in a footnote-like style, with the descriptive part in
10500 the text and the link in a note before the next heading. See the variable
10501 @code{org-ascii-links-to-notes} for details and other options.
10503 @node HTML export, @LaTeX{} and PDF export, ASCII/Latin-1/UTF-8 export, Exporting
10504 @section HTML export
10505 @cindex HTML export
10507 Org mode contains a HTML (XHTML 1.0 strict) exporter with extensive
10508 HTML formatting, in ways similar to John Gruber's @emph{markdown}
10509 language, but with additional support for tables.
10512 * HTML Export commands:: How to invoke HTML export
10513 * HTML preamble and postamble:: How to insert a preamble and a postamble
10514 * Quoting HTML tags:: Using direct HTML in Org mode
10515 * Links in HTML export:: How links will be interpreted and formatted
10516 * Tables in HTML export:: How to modify the formatting of tables
10517 * Images in HTML export:: How to insert figures into HTML output
10518 * Math formatting in HTML export:: Beautiful math also on the web
10519 * Text areas in HTML export:: An alternative way to show an example
10520 * CSS support:: Changing the appearance of the output
10521 * JavaScript support:: Info and Folding in a web browser
10524 @node HTML Export commands, HTML preamble and postamble, HTML export, HTML export
10525 @subsection HTML export commands
10527 @cindex region, active
10528 @cindex active region
10529 @cindex transient-mark-mode
10531 @orgcmd{C-c C-e h h,org-html-export-to-html}
10532 @cindex property, EXPORT_FILE_NAME
10533 Export as a HTML file. For an Org file @file{myfile.org},
10534 the HTML file will be @file{myfile.html}. The file will be overwritten
10535 without warning. If there is an active region@footnote{This requires
10536 @code{transient-mark-mode} be turned on.}, only the region will be
10537 exported. If the selected region is a single tree@footnote{To select the
10538 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
10539 title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
10540 property, that name will be used for the export.
10542 Export as a HTML file and immediately open it with a browser.
10543 @orgcmd{C-c C-e h H,org-html-export-as-html}
10544 Export to a temporary buffer. Do not create a file.
10545 @item C-c C-e C-v h H/h h/h o
10546 Export only the visible part of the document.
10549 @c FIXME Exporting sublevels
10550 @c @cindex headline levels, for exporting
10551 @c In the exported version, the first 3 outline levels will become headlines,
10552 @c defining a general document structure. Additional levels will be exported as
10553 @c itemized lists. If you want that transition to occur at a different level,
10554 @c specify it with a numeric prefix argument. For example,
10557 @c @kbd{C-2 C-c C-e b}
10561 @c creates two levels of headings and does the rest as items.
10563 @node HTML preamble and postamble, Quoting HTML tags, HTML Export commands, HTML export
10564 @subsection HTML preamble and postamble
10565 @vindex org-html-preamble
10566 @vindex org-html-postamble
10567 @vindex org-html-preamble-format
10568 @vindex org-html-postamble-format
10569 @vindex org-html-validation-link
10570 @vindex org-export-author-info
10571 @vindex org-export-email-info
10572 @vindex org-export-creator-info
10573 @vindex org-export-time-stamp-file
10575 The HTML exporter lets you define a preamble and a postamble.
10577 The default value for @code{org-html-preamble} is @code{t}, which means
10578 that the preamble is inserted depending on the relevant format string in
10579 @code{org-html-preamble-format}.
10581 Setting @code{org-html-preamble} to a string will override the default format
10582 string. If you set it to a function, it will insert the output of the
10583 function, which must be a string. Setting to @code{nil} will not insert any
10586 The default value for @code{org-html-postamble} is @code{'auto}, which means
10587 that the HTML exporter will look for information about the author, the email,
10588 the creator and the date, and build the postamble from these values. Setting
10589 @code{org-html-postamble} to @code{t} will insert the postamble from the
10590 relevant format string found in @code{org-html-postamble-format}. Setting it
10591 to @code{nil} will not insert any postamble.
10593 @node Quoting HTML tags, Links in HTML export, HTML preamble and postamble, HTML export
10594 @subsection Quoting HTML tags
10596 Plain @samp{<} and @samp{>} are always transformed to @samp{<} and
10597 @samp{>} in HTML export. If you want to include simple HTML tags
10598 which should be interpreted as such, mark them with @samp{@@} as in
10599 @samp{@@<b>bold text@@</b>}. Note that this really works only for
10600 simple tags. For more extensive HTML that should be copied verbatim to
10601 the exported file use either
10604 @cindex #+BEGIN_HTML
10606 #+HTML: Literal HTML code for export
10610 @cindex #+BEGIN_HTML
10614 All lines between these markers are exported literally
10619 @node Links in HTML export, Tables in HTML export, Quoting HTML tags, HTML export
10620 @subsection Links in HTML export
10622 @cindex links, in HTML export
10623 @cindex internal links, in HTML export
10624 @cindex external links, in HTML export
10625 Internal links (@pxref{Internal links}) will continue to work in HTML@. This
10626 includes automatic links created by radio targets (@pxref{Radio
10627 targets}). Links to external files will still work if the target file is on
10628 the same @i{relative} path as the published Org file. Links to other
10629 @file{.org} files will be translated into HTML links under the assumption
10630 that a HTML version also exists of the linked file, at the same relative
10631 path. @samp{id:} links can then be used to jump to specific entries across
10632 files. For information related to linking files while publishing them to a
10633 publishing directory see @ref{Publishing links}.
10635 If you want to specify attributes for links, you can do so using a special
10636 @code{#+ATTR_HTML} line to define attributes that will be added to the
10637 @code{<a>} or @code{<img>} tags. Here is an example that sets @code{title}
10638 and @code{style} attributes for a link:
10640 @cindex #+ATTR_HTML
10642 #+ATTR_HTML: :title The Org mode homepage :style color:red;
10643 [[http://orgmode.org]]
10646 @node Tables in HTML export, Images in HTML export, Links in HTML export, HTML export
10648 @cindex tables, in HTML
10649 @vindex org-html-table-default-attributes
10651 Org mode tables are exported to HTML using the table attributes defined in
10652 @code{org-html-table-default-attributes}. The default setting makes tables
10653 without cell borders and frame. If you would like to change this for
10654 individual tables, place something like the following before the table:
10657 @cindex #+ATTR_HTML
10659 #+CAPTION: This is a table with lines around and between cells
10660 #+ATTR_HTML: :border 2 :rules all :frame border
10663 @vindex org-html-table-row-tags
10664 You can also modify the default tags used for each row by setting
10665 @var{org-html-table-row-tags}. See the docstring for an example on
10666 how to use this option.
10668 @node Images in HTML export, Math formatting in HTML export, Tables in HTML export, HTML export
10669 @subsection Images in HTML export
10671 @cindex images, inline in HTML
10672 @cindex inlining images in HTML
10673 @vindex org-html-inline-images
10674 HTML export can inline images given as links in the Org file, and
10675 it can make an image the clickable part of a link. By
10676 default@footnote{But see the variable
10677 @code{org-html-inline-images}.}, images are inlined if a link does
10678 not have a description. So @samp{[[file:myimg.jpg]]} will be inlined,
10679 while @samp{[[file:myimg.jpg][the image]]} will just produce a link
10680 @samp{the image} that points to the image. If the description part
10681 itself is a @code{file:} link or a @code{http:} URL pointing to an
10682 image, this image will be inlined and activated so that clicking on the
10683 image will activate the link. For example, to include a thumbnail that
10684 will link to a high resolution version of the image, you could use:
10687 [[file:highres.jpg][file:thumb.jpg]]
10690 If you need to add attributes to an inlined image, use a @code{#+ATTR_HTML}.
10691 In the example below we specify the @code{alt} and @code{title} attributes to
10692 support text viewers and accessibility, and align it to the right.
10695 @cindex #+ATTR_HTML
10697 #+CAPTION: A black cat stalking a spider
10698 #+ATTR_HTML: :alt cat/spider image :title Action! :align right
10703 You could use @code{http} addresses just as well.
10705 @node Math formatting in HTML export, Text areas in HTML export, Images in HTML export, HTML export
10706 @subsection Math formatting in HTML export
10710 @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be displayed in two
10711 different ways on HTML pages. The default is to use the
10712 @uref{http://www.mathjax.org, MathJax system} which should work out of the
10713 box with Org mode installation because @code{http://orgmode.org} serves
10714 @file{MathJax} for Org mode users for small applications and for testing
10715 purposes. @b{If you plan to use this regularly or on pages with significant
10716 page views, you should install@footnote{Installation instructions can be
10717 found on the MathJax website, see
10718 @uref{http://www.mathjax.org/resources/docs/?installation.html}.} MathJax on
10719 your own server in order to limit the load of our server.} To configure
10720 @file{MathJax}, use the variable @code{org-html-mathjax-options} or
10721 insert something like the following into the buffer:
10724 #+HTML_MATHJAX: align:"left" mathml:t path:"/MathJax/MathJax.js"
10727 @noindent See the docstring of the variable
10728 @code{org-html-mathjax-options} for the meaning of the parameters in
10731 If you prefer, you can also request that @LaTeX{} fragments are processed
10732 into small images that will be inserted into the browser page. Before the
10733 availability of MathJax, this was the default method for Org files. This
10734 method requires that the @file{dvipng} program is available on your system.
10735 You can still get this processing with
10738 #+OPTIONS: LaTeX:dvipng
10741 @node Text areas in HTML export, CSS support, Math formatting in HTML export, HTML export
10742 @subsection Text areas in HTML export
10744 @cindex text areas, in HTML
10745 An alternative way to publish literal code examples in HTML is to use text
10746 areas, where the example can even be edited before pasting it into an
10747 application. It is triggered by a @code{-t} switch at an @code{example} or
10748 @code{src} block. Using this switch disables any options for syntax and
10749 label highlighting, and line numbering, which may be present. You may also
10750 use @code{-h} and @code{-w} switches to specify the height and width of the
10751 text area, which default to the number of lines in the example, and 80,
10752 respectively. For example
10755 #+BEGIN_EXAMPLE -t -w 40
10756 (defun org-xor (a b)
10763 @node CSS support, JavaScript support, Text areas in HTML export, HTML export
10764 @subsection CSS support
10765 @cindex CSS, for HTML export
10766 @cindex HTML export, CSS
10768 @vindex org-html-todo-kwd-class-prefix
10769 @vindex org-html-tag-class-prefix
10770 You can also give style information for the exported file. The HTML exporter
10771 assigns the following special CSS classes@footnote{If the classes on TODO
10772 keywords and tags lead to conflicts, use the variables
10773 @code{org-html-todo-kwd-class-prefix} and
10774 @code{org-html-tag-class-prefix} to make them unique.} to appropriate
10775 parts of the document---your style specifications may change these, in
10776 addition to any of the standard classes like for headlines, tables, etc.
10778 p.author @r{author information, including email}
10779 p.date @r{publishing date}
10780 p.creator @r{creator info, about org mode version}
10781 .title @r{document title}
10782 .todo @r{TODO keywords, all not-done states}
10783 .done @r{the DONE keywords, all states that count as done}
10784 .WAITING @r{each TODO keyword also uses a class named after itself}
10785 .timestamp @r{timestamp}
10786 .timestamp-kwd @r{keyword associated with a timestamp, like SCHEDULED}
10787 .timestamp-wrapper @r{span around keyword plus timestamp}
10788 .tag @r{tag in a headline}
10789 ._HOME @r{each tag uses itself as a class, "@@" replaced by "_"}
10790 .target @r{target for links}
10791 .linenr @r{the line number in a code example}
10792 .code-highlighted @r{for highlighting referenced code lines}
10793 div.outline-N @r{div for outline level N (headline plus text))}
10794 div.outline-text-N @r{extra div for text at outline level N}
10795 .section-number-N @r{section number in headlines, different for each level}
10796 div.figure @r{how to format an inlined image}
10797 pre.src @r{formatted source code}
10798 pre.example @r{normal example}
10799 p.verse @r{verse paragraph}
10800 div.footnotes @r{footnote section headline}
10801 p.footnote @r{footnote definition paragraph, containing a footnote}
10802 .footref @r{a footnote reference number (always a <sup>)}
10803 .footnum @r{footnote number in footnote definition (always <sup>)}
10806 @vindex org-html-style-default
10807 @vindex org-html-head-include-default-style
10808 @vindex org-html-head
10809 @vindex org-html-head-extra
10810 @cindex #+HTML_INCLUDE_STYLE
10811 Each exported file contains a compact default style that defines these
10812 classes in a basic way@footnote{This style is defined in the constant
10813 @code{org-html-style-default}, which you should not modify. To turn
10814 inclusion of these defaults off, customize
10815 @code{org-html-head-include-default-style} or set @code{#+HTML_INCLUDE_STYLE}
10816 to nil on a per-file basis.}. You may overwrite these settings, or add to
10817 them by using the variables @code{org-html-head} and
10818 @code{org-html-head-extra}. You can override the global values of these
10819 variables for each file by using these keywords:
10821 @cindex #+HTML_HEAD
10822 @cindex #+HTML_HEAD_EXTRA
10824 #+HTML_HEAD: <link rel="stylesheet" type="text/css" href="style1.css" />
10825 #+HTML_HEAD_EXTRA: <link rel="alternate stylesheet" type="text/css" href="style2.css" />
10829 For longer style definitions, you can use several such lines. You could also
10830 directly write a @code{<style>} @code{</style>} section in this way, without
10831 referring to an external file.
10833 In order to add styles to a subtree, use the @code{:HTML_CONTAINER_CLASS:}
10834 property to assign a class to the tree. In order to specify CSS styles for a
10835 particular headline, you can use the id specified in a @code{:CUSTOM_ID:}
10838 @c FIXME: More about header and footer styles
10839 @c FIXME: Talk about links and targets.
10841 @node JavaScript support, , CSS support, HTML export
10842 @subsection JavaScript supported display of web pages
10844 @cindex Rose, Sebastian
10845 Sebastian Rose has written a JavaScript program especially designed to
10846 enhance the web viewing experience of HTML files created with Org. This
10847 program allows you to view large files in two different ways. The first one
10848 is an @emph{Info}-like mode where each section is displayed separately and
10849 navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
10850 as well, press @kbd{?} for an overview of the available keys). The second
10851 view type is a @emph{folding} view much like Org provides inside Emacs. The
10852 script is available at @url{http://orgmode.org/org-info.js} and you can find
10853 the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
10854 We host the script at our site, but if you use it a lot, you might not want
10855 to be dependent on @url{http://orgmode.org} and prefer to install a local
10856 copy on your own web server.
10858 All it then takes to use this program is adding a single line to the Org
10861 @cindex #+INFOJS_OPT
10863 #+INFOJS_OPT: view:info toc:nil
10867 If this line is found, the HTML header will automatically contain the code
10868 needed to invoke the script. Using the line above, you can set the following
10872 path: @r{The path to the script. The default is to grab the script from}
10873 @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
10874 @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
10875 view: @r{Initial view when the website is first shown. Possible values are:}
10876 info @r{Info-like interface with one section per page.}
10877 overview @r{Folding interface, initially showing only top-level.}
10878 content @r{Folding interface, starting with all headlines visible.}
10879 showall @r{Folding interface, all headlines and text visible.}
10880 sdepth: @r{Maximum headline level that will still become an independent}
10881 @r{section for info and folding modes. The default is taken from}
10882 @r{@code{org-export-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
10883 @r{If this is smaller than in @code{org-export-headline-levels}, each}
10884 @r{info/folding section can still contain child headlines.}
10885 toc: @r{Should the table of contents @emph{initially} be visible?}
10886 @r{Even when @code{nil}, you can always get to the "toc" with @kbd{i}.}
10887 tdepth: @r{The depth of the table of contents. The defaults are taken from}
10888 @r{the variables @code{org-export-headline-levels} and @code{org-export-with-toc}.}
10889 ftoc: @r{Does the CSS of the page specify a fixed position for the "toc"?}
10890 @r{If yes, the toc will never be displayed as a section.}
10891 ltoc: @r{Should there be short contents (children) in each section?}
10892 @r{Make this @code{above} if the section should be above initial text.}
10893 mouse: @r{Headings are highlighted when the mouse is over them. Should be}
10894 @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
10895 buttons: @r{Should view-toggle buttons be everywhere? When @code{nil} (the}
10896 @r{default), only one such button will be present.}
10899 @vindex org-html-infojs-options
10900 @vindex org-html-use-infojs
10901 You can choose default values for these options by customizing the variable
10902 @code{org-html-infojs-options}. If you always want to apply the script to your
10903 pages, configure the variable @code{org-html-use-infojs}.
10905 @node @LaTeX{} and PDF export, OpenDocument Text export, HTML export, Exporting
10906 @section @LaTeX{} and PDF export
10907 @cindex @LaTeX{} export
10910 Org mode contains a @LaTeX{} exporter. With further processing@footnote{The
10911 default @LaTeX{} output is designed for processing with @code{pdftex} or
10912 @LaTeX{}. It includes packages that are not compatible with @code{xetex} and
10913 possibly @code{luatex}. See the variables
10914 @code{org-latex-default-packages-alist} and
10915 @code{org-latex-packages-alist}.}, this back-end is also used to produce PDF
10916 output. Since the @LaTeX{} output uses @file{hyperref} to implement links
10917 and cross references, the PDF output file will be fully linked. Beware of
10918 the fact that your @code{org} file has to be properly structured in order to
10919 be correctly exported: respect the hierarchy of sections.
10922 * @LaTeX{}/PDF export commands::
10923 * Header and sectioning:: Setting up the export file structure
10924 * Quoting @LaTeX{} code:: Incorporating literal @LaTeX{} code
10925 * Tables in @LaTeX{} export:: Options for exporting tables to @LaTeX{}
10926 * Images in @LaTeX{} export:: How to insert figures into @LaTeX{} output
10927 * Beamer class export:: Turning the file into a presentation
10930 @node @LaTeX{}/PDF export commands, Header and sectioning, @LaTeX{} and PDF export, @LaTeX{} and PDF export
10931 @subsection @LaTeX{} export commands
10933 @cindex region, active
10934 @cindex active region
10935 @cindex transient-mark-mode
10937 @orgcmd{C-c C-e l l,org-latex-export-to-latex}
10938 Export as a @LaTeX{} file. For an Org file @file{myfile.org}, the @LaTeX{}
10939 file will be @file{myfile.tex}. The file will be overwritten without
10941 @orgcmd{C-c C-e l L,org-latex-export-as-latex}
10942 Export to a temporary buffer. Do not create a file.
10943 @item C-c C-e C-v l/L
10944 Export only the visible part of the document.
10945 @orgcmd{C-c C-e l p,org-latex-export-to-pdf}
10946 Export as @LaTeX{} and then process to PDF.
10948 Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
10951 In the exported version, the first three outline levels will become
10952 headlines, defining a general document structure. Additional levels will be
10953 exported as description lists. The transition can also occur at a different
10954 level (@pxref{Export settings}).
10956 @node Header and sectioning, Quoting @LaTeX{} code, @LaTeX{}/PDF export commands, @LaTeX{} and PDF export
10957 @subsection Header and sectioning structure
10958 @cindex @LaTeX{} class
10959 @cindex @LaTeX{} sectioning structure
10960 @cindex @LaTeX{} header
10961 @cindex header, for @LaTeX{} files
10962 @cindex sectioning structure, for @LaTeX{} export
10964 By default, the @LaTeX{} output uses the class @code{article}.
10966 @vindex org-latex-default-class
10967 @vindex org-latex-classes
10968 @vindex org-latex-default-packages-alist
10969 @vindex org-latex-packages-alist
10970 You can change this globally by setting a different value for
10971 @code{org-latex-default-class} or locally by adding an option like
10972 @code{#+LATEX_CLASS: myclass} in your file, or with
10973 a @code{EXPORT_LATEX_CLASS} property that applies when exporting a region
10974 containing only this (sub)tree. The class must be listed in
10975 @code{org-latex-classes}. This variable defines a header template for each
10976 class@footnote{Into which the values of
10977 @code{org-latex-default-packages-alist} and @code{org-latex-packages-alist}
10978 are spliced.}, and allows you to define the sectioning structure for each
10979 class. You can also define your own classes there.
10981 @cindex #+LATEX_CLASS
10982 @cindex #+LATEX_CLASS_OPTIONS
10983 @cindex property, EXPORT_LATEX_CLASS
10984 @cindex property, EXPORT_LATEX_CLASS_OPTIONS
10985 @code{LATEX_CLASS_OPTIONS} keyword or @code{EXPORT_LATEX_CLASS_OPTIONS}
10986 property can specify the options for the @code{\documentclass} macro. These
10987 options have to be provided, as expected by @LaTeX{}, within square brackets.
10989 @cindex #+LATEX_HEADER
10990 @cindex #+LATEX_HEADER_EXTRA
10991 You can also use LATEX_HEADER and LATEX_HEADER_EXTRA keywords in order to add
10992 lines to the header. See the docstring of @code{org-latex-classes} for more
10995 An example is shown below.
10998 #+LATEX_CLASS: article
10999 #+LATEX_CLASS_OPTIONS: [a4paper]
11000 #+LATEX_HEADER: \usepackage@{xyz@}
11006 @node Quoting @LaTeX{} code, Tables in @LaTeX{} export, Header and sectioning, @LaTeX{} and PDF export
11007 @subsection Quoting @LaTeX{} code
11009 Embedded @LaTeX{} as described in @ref{Embedded @LaTeX{}}, will be correctly
11010 inserted into the @LaTeX{} file. Furthermore, you can add special code that
11011 should only be present in @LaTeX{} export with the following constructs:
11014 @cindex #+BEGIN_LATEX
11016 Code within @@@@latex:some code@@@@ a paragraph.
11022 #+LATEX: Literal @LaTeX{} code for export
11025 @noindent or, eventually,
11029 All lines between these markers are exported literally
11034 @node Tables in @LaTeX{} export, Images in @LaTeX{} export, Quoting @LaTeX{} code, @LaTeX{} and PDF export
11035 @subsection Tables in @LaTeX{} export
11036 @cindex tables, in @LaTeX{} export
11038 For @LaTeX{} export of a table, you can specify a label and a caption
11039 (@pxref{Images and tables}).
11041 You can also use the @code{ATTR_LATEX} line to control table layout and
11042 contents. Valid attributes are:
11046 @vindex org-latex-default-table-mode
11047 Nature of table's contents. It can be set to @code{table}, @code{math},
11048 @code{inline-math} or @code{verbatim}. In particular, when in @code{math} or
11049 @code{inline-math} mode, every cell is exported as-is, horizontal rules are
11050 ignored and the table will be wrapped in a math environment. Also,
11051 contiguous tables sharing the same math mode will be wrapped within the same
11052 environment. Default mode is determined in
11053 @var{org-latex-default-table-mode}.
11055 @vindex org-latex-default-table-environment
11056 Environment used for the table. It can be to any @LaTeX{} table
11057 environment, like @code{tabularx}, @code{longtable}, @code{array},
11058 @code{tabu}, @code{bmatrix}@enddots{} It defaults to
11059 @var{org-latex-default-table-environment} value.
11061 Float environment for the table. Possible values are @code{sidewaystable},
11062 @code{multicolumn} and @code{table}. If unspecified, a table with a caption
11063 will have a @code{table} environment. Moreover, @code{:placement} attribute
11064 can specify the positioning of the float.
11065 @item :align, :font, :width
11066 set, respectively, the alignment string of the table, its font size and its
11067 width. They only apply on regular tables.
11069 Boolean specific to the @code{tabu} and @code{longtabu} environments, and
11070 only takes effect when used in conjunction with the @code{:width} attribute.
11071 When @code{:spread} is non-nil, the table will be spread or shrunk by the
11072 value of @code{:width}.
11073 @item :booktabs, :center, :rmlines
11074 @vindex org-latex-tables-booktabs
11075 @vindex org-latex-tables-centered
11076 They toggle, respectively, @code{booktabs} usage (assuming the package is
11077 properly loaded), table centering and removal of every horizontal rule but
11078 the first one (in a "table.el" table only). In particular,
11079 @var{org-latex-tables-booktabs} (resp. @var{org-latex-tables-centered})
11080 activates the first (resp. second) attribute globally.
11081 @item :math-prefix, :math-suffix, :math-arguments
11082 string which will be inserted, respectively, before the table within the math
11083 environment, after the table within the math environment, and between the
11084 macro name and the contents of the table. The latter attribute is necessary
11085 to matrix macros that require more than one argument (e.g.,
11086 @code{qbordermatrix}).
11089 Thus, attributes can be used in a wide array of situations, like writing
11090 a table that will span over multiple pages, or a matrix product:
11092 @cindex #+ATTR_LATEX
11094 #+ATTR_LATEX: :environment longtable :align l|lp@{3cm@}r|l
11098 #+ATTR_LATEX: :mode math :environment bmatrix :math-suffix \times
11101 #+ATTR_LATEX: :mode math :environment bmatrix
11106 @node Images in @LaTeX{} export, Beamer class export, Tables in @LaTeX{} export, @LaTeX{} and PDF export
11107 @subsection Images in @LaTeX{} export
11108 @cindex images, inline in @LaTeX{}
11109 @cindex inlining images in @LaTeX{}
11111 Images that are linked to without a description part in the link, like
11112 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
11113 output file resulting from @LaTeX{} processing. Org will use an
11114 @code{\includegraphics} macro to insert the image@footnote{In the case of
11115 TikZ (@url{http://sourceforge.net/projects/pgf/}) images, it will become an
11116 @code{\input} macro wrapped within a @code{tikzpicture} environment.}. You
11117 can use an @code{#+ATTR_LATEX:} line to specify its width or height, with,
11118 respectively, @code{:width} and @code{:height} attributes. It is also
11119 possible to specify any other option with the @code{:options} attribute, as
11120 shown in the following example:
11122 @cindex #+ATTR_LATEX
11124 #+ATTR_LATEX: :width 5cm :options angle=90
11125 [[./img/sed-hr4049.pdf]]
11128 If you have specified a caption as described in @ref{Images and tables}, the
11129 picture will be wrapped into a @code{figure} environment and thus become
11130 a floating element. You can also ask Org to export an image as a float
11131 without specifying caption by setting the @code{:float} attribute to
11132 @code{figure} value in @code{#+ATTR_LATEX:} line. You may also set it to:
11135 @code{wrap}: if you would like to let text flow around the image. It will
11136 make the figure occupy the left half of the page.
11138 @code{multicolumn}: if you wish to include an image which spans multiple
11139 columns in a page. This will export the image wrapped in a @code{figure*}
11143 To modify the placement option of any floating environment, set the
11144 @code{placement} attribute.
11146 @cindex #+ATTR_LATEX
11148 #+ATTR_LATEX: :float wrap :width 0.38\textwidth :placement @{r@}@{0.4\textwidth@}
11152 Eventually, in the @code{:comment-include} attributes has a non-nil value,
11153 the code actually including the image will be commented out.
11155 @node Beamer class export, , Images in @LaTeX{} export, @LaTeX{} and PDF export
11156 @subsection Beamer class export
11158 The @LaTeX{} class @file{beamer} allows production of high quality presentations
11159 using @LaTeX{} and pdf processing. Org mode has special support for turning an
11160 Org mode file or tree into a @file{beamer} presentation.
11162 When the @LaTeX{} class for the current buffer (as set with @code{#+LaTeX_CLASS:
11163 beamer}) or subtree (set with a @code{LaTeX_CLASS} property) is
11164 @code{beamer}, a special export mode will turn the file or tree into a beamer
11165 presentation. Any tree with not-too-deep level nesting should in principle be
11166 exportable as a beamer presentation. By default, the top-level entries (or
11167 the first level below the selected subtree heading) will be turned into
11168 frames, and the outline structure below this level will become itemize lists.
11169 You can also configure the variable @code{org-beamer-frame-level} to a
11170 different level---then the hierarchy above frames will produce the sectioning
11171 structure of the presentation.
11173 A template for useful in-buffer settings or properties can be inserted into
11174 the buffer with @kbd{M-x org-beamer-insert-options-template}. Among other
11175 things, this will install a column view format which is very handy for
11176 editing special properties used by beamer.
11178 You can influence the structure of the presentation using the following
11183 The environment that should be used to format this entry. Valid environments
11184 are defined in the constant @code{org-beamer-environments-default}, and you
11185 can define more in @code{org-beamer-environments-extra}. If this property is
11186 set, the entry will also get a @code{:B_environment:} tag to make this
11187 visible. This tag has no semantic meaning, it is only a visual aid.
11188 @item BEAMER_envargs
11189 The beamer-special arguments that should be used for the environment, like
11190 @code{[t]} or @code{[<+->]} of @code{<2-3>}. If the @code{BEAMER_col}
11191 property is also set, something like @code{C[t]} can be added here as well to
11192 set an options argument for the implied @code{columns} environment.
11193 @code{c[t]} or @code{c<2->} will set an options for the implied @code{column}
11196 The width of a column that should start with this entry. If this property is
11197 set, the entry will also get a @code{:BMCOL:} property to make this visible.
11198 Also this tag is only a visual aid. When this is a plain number, it will be
11199 interpreted as a fraction of @code{\textwidth}. Otherwise it will be assumed
11200 that you have specified the units, like @samp{3cm}. The first such property
11201 in a frame will start a @code{columns} environment to surround the columns.
11202 This environment is closed when an entry has a @code{BEAMER_col} property
11203 with value 0 or 1, or automatically at the end of the frame.
11205 Additional commands that should be inserted after the environment has been
11206 opened. For example, when creating a frame, this can be used to specify
11210 Frames will automatically receive a @code{fragile} option if they contain
11211 source code that uses the verbatim environment. Special @file{beamer}
11212 specific code can be inserted using @code{#+BEAMER:} and
11213 @code{#+BEGIN_BEAMER...#+END_BEAMER} constructs, similar to other export
11214 backends, but with the difference that @code{#+LaTeX:} stuff will be included
11215 in the presentation as well.
11217 Outline nodes with @code{BEAMER_env} property value @samp{note} or
11218 @samp{noteNH} will be formatted as beamer notes, i,e, they will be wrapped
11219 into @code{\note@{...@}}. The former will include the heading as part of the
11220 note text, the latter will ignore the heading of that node. To simplify note
11221 generation, it is actually enough to mark the note with a @emph{tag} (either
11222 @code{:B_note:} or @code{:B_noteNH:}) instead of creating the
11223 @code{BEAMER_env} property.
11225 You can turn on a special minor mode @code{org-beamer-mode} for editing
11233 @orgcmd{C-c C-b,org-beamer-select-environment}
11234 In @code{org-beamer-mode}, this key offers fast selection of a beamer
11235 environment or the @code{BEAMER_col} property.
11238 Column view provides a great way to set the environment of a node and other
11239 important parameters. Make sure you are using a COLUMN format that is geared
11240 toward this special purpose. The command @kbd{M-x
11241 org-insert-beamer-options-template} defines such a format.
11243 Here is a simple example Org document that is intended for beamer export.
11246 #+LaTeX_CLASS: beamer
11247 #+TITLE: Example Presentation
11248 #+AUTHOR: Carsten Dominik
11249 #+LaTeX_CLASS_OPTIONS: [presentation]
11250 #+BEAMER_FRAME_LEVEL: 2
11251 #+BEAMER_HEADER_EXTRA: \usetheme@{Madrid@}\usecolortheme@{default@}
11252 #+COLUMNS: %35ITEM %10BEAMER_env(Env) %10BEAMER_envargs(Args) %4BEAMER_col(Col) %8BEAMER_extra(Ex)
11254 * This is the first structural section
11256 ** Frame 1 \\ with a subtitle
11257 *** Thanks to Eric Fraga :BMCOL:B_block:
11260 :BEAMER_envargs: C[t]
11263 for the first viable beamer setup in Org
11264 *** Thanks to everyone else :BMCOL:B_block:
11268 :BEAMER_envargs: <2->
11270 for contributing to the discussion
11271 **** This will be formatted as a beamer note :B_note:
11272 ** Frame 2 \\ where we will not use columns
11273 *** Request :B_block:
11274 Please test this stuff!
11280 For more information, see the documentation on Worg.
11282 @c begin opendocument
11284 @node OpenDocument Text export, iCalendar export, @LaTeX{} and PDF export, Exporting
11285 @section OpenDocument Text export
11287 @cindex OpenDocument
11288 @cindex export, OpenDocument
11289 @cindex LibreOffice
11291 @cindex org-modules
11293 Org Mode@footnote{Versions 7.8 or later} supports export to OpenDocument Text
11294 (ODT) format using the @file{org-odt.el} module. Documents created
11295 by this exporter use the @cite{OpenDocument-v1.2
11296 specification}@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
11297 Open Document Format for Office Applications (OpenDocument) Version 1.2}} and
11298 are compatible with LibreOffice 3.4.
11301 * Pre-requisites for ODT export:: What packages ODT exporter relies on
11302 * ODT export commands:: How to invoke ODT export
11303 * Extending ODT export:: How to produce @samp{doc}, @samp{pdf} files
11304 * Applying custom styles:: How to apply custom styles to the output
11305 * Links in ODT export:: How links will be interpreted and formatted
11306 * Tables in ODT export:: How Tables are exported
11307 * Images in ODT export:: How to insert images
11308 * Math formatting in ODT export:: How @LaTeX{} fragments are formatted
11309 * Labels and captions in ODT export:: How captions are rendered
11310 * Literal examples in ODT export:: How source and example blocks are formatted
11311 * Advanced topics in ODT export:: Read this if you are a power user
11314 @node Pre-requisites for ODT export, ODT export commands, OpenDocument Text export, OpenDocument Text export
11315 @subsection Pre-requisites for ODT export
11317 The ODT exporter relies on the @file{zip} program to create the final
11318 output. Check the availability of this program before proceeding further.
11320 @node ODT export commands, Extending ODT export, Pre-requisites for ODT export, OpenDocument Text export
11321 @subsection ODT export commands
11323 @subsubheading Exporting to ODT
11324 @anchor{x-export-to-odt}
11326 @cindex region, active
11327 @cindex active region
11328 @cindex transient-mark-mode
11330 @orgcmd{C-c C-e o o,org-odt-export-to-odt}
11331 @cindex property EXPORT_FILE_NAME
11333 Export as OpenDocument Text file.
11335 @vindex org-odt-preferred-output-format
11336 If @code{org-preferred-output-format} is specified, automatically convert
11337 the exported file to that format. @xref{x-export-to-other-formats, ,
11338 Automatically exporting to other formats}.
11340 For an Org file @file{myfile.org}, the ODT file will be
11341 @file{myfile.odt}. The file will be overwritten without warning. If there
11342 is an active region,@footnote{This requires @code{transient-mark-mode} to be
11343 turned on} only the region will be exported. If the selected region is a
11344 single tree,@footnote{To select the current subtree, use @kbd{C-c @@}} the
11345 tree head will become the document title. If the tree head entry has, or
11346 inherits, an @code{EXPORT_FILE_NAME} property, that name will be used for the
11350 Export as an OpenDocument Text file and open the resulting file.
11352 @vindex org-odt-preferred-output-format
11353 If @code{org-preferred-output-format} is specified, open the converted file
11354 instead. @xref{x-export-to-other-formats, , Automatically exporting to
11358 @node Extending ODT export, Applying custom styles, ODT export commands, OpenDocument Text export
11359 @subsection Extending ODT export
11361 The ODT exporter can interface with a variety of document
11362 converters and supports popular converters out of the box. As a result, you
11363 can use it to export to formats like @samp{doc} or convert a document from
11364 one format (say @samp{csv}) to another format (say @samp{ods} or @samp{xls}).
11366 @cindex @file{unoconv}
11367 @cindex LibreOffice
11368 If you have a working installation of LibreOffice, a document converter is
11369 pre-configured for you and you can use it right away. If you would like to
11370 use @file{unoconv} as your preferred converter, customize the variable
11371 @code{org-odt-convert-process} to point to @code{unoconv}. You can
11372 also use your own favorite converter or tweak the default settings of the
11373 @file{LibreOffice} and @samp{unoconv} converters. @xref{Configuring a
11374 document converter}.
11376 @subsubsection Automatically exporting to other formats
11377 @anchor{x-export-to-other-formats}
11379 @vindex org-odt-preferred-output-format
11380 Very often, you will find yourself exporting to ODT format, only to
11381 immediately save the exported document to other formats like @samp{doc},
11382 @samp{docx}, @samp{rtf}, @samp{pdf} etc. In such cases, you can specify your
11383 preferred output format by customizing the variable
11384 @code{org-odt-preferred-output-format}. This way, the export commands
11385 (@pxref{x-export-to-odt,,Exporting to ODT}) can be extended to export to a
11386 format that is of immediate interest to you.
11388 @subsubsection Converting between document formats
11389 @anchor{x-convert-to-other-formats}
11391 There are many document converters in the wild which support conversion to
11392 and from various file formats, including, but not limited to the
11393 ODT format. LibreOffice converter, mentioned above, is one such
11394 converter. Once a converter is configured, you can interact with it using
11395 the following command.
11397 @vindex org-odt-convert
11400 @item M-x org-odt-convert
11401 Convert an existing document from one format to another. With a prefix
11402 argument, also open the newly produced file.
11405 @node Applying custom styles, Links in ODT export, Extending ODT export, OpenDocument Text export
11406 @subsection Applying custom styles
11407 @cindex styles, custom
11408 @cindex template, custom
11410 The ODT exporter ships with a set of OpenDocument styles
11411 (@pxref{Working with OpenDocument style files}) that ensure a well-formatted
11412 output. These factory styles, however, may not cater to your specific
11413 tastes. To customize the output, you can either modify the above styles
11414 files directly, or generate the required styles using an application like
11415 LibreOffice. The latter method is suitable for expert and non-expert
11416 users alike, and is described here.
11418 @subsubsection Applying custom styles: the easy way
11422 Create a sample @file{example.org} file with the below settings and export it
11426 #+OPTIONS: H:10 num:t
11430 Open the above @file{example.odt} using LibreOffice. Use the @file{Stylist}
11431 to locate the target styles---these typically have the @samp{Org} prefix---and
11432 modify those to your taste. Save the modified file either as an
11433 OpenDocument Text (@file{.odt}) or OpenDocument Template (@file{.ott}) file.
11436 @cindex #+ODT_STYLES_FILE
11437 @vindex org-odt-styles-file
11438 Customize the variable @code{org-odt-styles-file} and point it to the
11439 newly created file. For additional configuration options
11440 @pxref{x-overriding-factory-styles,,Overriding factory styles}.
11442 If you would like to choose a style on a per-file basis, you can use the
11443 @code{#+ODT_STYLES_FILE} option. A typical setting will look like
11446 #+ODT_STYLES_FILE: "/path/to/example.ott"
11452 #+ODT_STYLES_FILE: ("/path/to/file.ott" ("styles.xml" "image/hdr.png"))
11457 @subsubsection Using third-party styles and templates
11459 You can use third-party styles and templates for customizing your output.
11460 This will produce the desired output only if the template provides all
11461 style names that the @samp{ODT} exporter relies on. Unless this condition is
11462 met, the output is going to be less than satisfactory. So it is highly
11463 recommended that you only work with templates that are directly derived from
11464 the factory settings.
11466 @node Links in ODT export, Tables in ODT export, Applying custom styles, OpenDocument Text export
11467 @subsection Links in ODT export
11468 @cindex links, in ODT export
11470 ODT exporter creates native cross-references for internal links. It creates
11471 Internet-style links for all other links.
11473 A link with no description and destined to a regular (un-itemized) outline
11474 heading is replaced with a cross-reference and section number of the heading.
11476 A @samp{\ref@{label@}}-style reference to an image, table etc. is replaced
11477 with a cross-reference and sequence number of the labeled entity.
11478 @xref{Labels and captions in ODT export}.
11480 @node Tables in ODT export, Images in ODT export, Links in ODT export, OpenDocument Text export
11481 @subsection Tables in ODT export
11482 @cindex tables, in ODT export
11484 Export of native Org mode tables (@pxref{Tables}) and simple @file{table.el}
11485 tables is supported. However, export of complex @file{table.el} tables---tables
11486 that have column or row spans---is not supported. Such tables are
11487 stripped from the exported document.
11489 By default, a table is exported with top and bottom frames and with rules
11490 separating row and column groups (@pxref{Column groups}). Furthermore, all
11491 tables are typeset to occupy the same width. If the table specifies
11492 alignment and relative width for its columns (@pxref{Column width and
11493 alignment}) then these are honored on export.@footnote{The column widths are
11494 interpreted as weighted ratios with the default weight being 1}
11497 You can control the width of the table by specifying @code{:rel-width}
11498 property using an @code{#+ATTR_ODT} line.
11500 For example, consider the following table which makes use of all the rules
11504 #+ATTR_ODT: :rel-width 50
11505 | Area/Month | Jan | Feb | Mar | Sum |
11506 |---------------+-------+-------+-------+-------|
11508 | <l13> | <r5> | <r5> | <r5> | <r6> |
11509 | North America | 1 | 21 | 926 | 948 |
11510 | Middle East | 6 | 75 | 844 | 925 |
11511 | Asia Pacific | 9 | 27 | 790 | 826 |
11512 |---------------+-------+-------+-------+-------|
11513 | Sum | 16 | 123 | 2560 | 2699 |
11516 On export, the table will occupy 50% of text area. The columns will be sized
11517 (roughly) in the ratio of 13:5:5:5:6. The first column will be left-aligned
11518 and rest of the columns will be right-aligned. There will be vertical rules
11519 after separating the header and last columns from other columns. There will
11520 be horizontal rules separating the header and last rows from other rows.
11522 If you are not satisfied with the above formatting options, you can create
11523 custom table styles and associate them with a table using the
11524 @code{#+ATTR_ODT} line. @xref{Customizing tables in ODT export}.
11526 @node Images in ODT export, Math formatting in ODT export, Tables in ODT export, OpenDocument Text export
11527 @subsection Images in ODT export
11528 @cindex images, embedding in ODT
11529 @cindex embedding images in ODT
11531 @subsubheading Embedding images
11532 You can embed images within the exported document by providing a link to the
11533 desired image file with no link description. For example, to embed
11534 @samp{img.png} do either of the following:
11544 @subsubheading Embedding clickable images
11545 You can create clickable images by providing a link whose description is a
11546 link to an image file. For example, to embed a image
11547 @file{org-mode-unicorn.png} which when clicked jumps to
11548 @uref{http://Orgmode.org} website, do the following
11551 [[http://orgmode.org][./org-mode-unicorn.png]]
11554 @subsubheading Sizing and scaling of embedded images
11557 You can control the size and scale of the embedded images using the
11558 @code{#+ATTR_ODT} attribute.
11560 @cindex identify, ImageMagick
11561 @vindex org-odt-pixels-per-inch
11562 The exporter specifies the desired size of the image in the final document in
11563 units of centimeters. In order to scale the embedded images, the exporter
11564 queries for pixel dimensions of the images using one of a) ImageMagick's
11565 @file{identify} program or b) Emacs `create-image' and `image-size'
11566 APIs.@footnote{Use of @file{ImageMagick} is only desirable. However, if you
11567 routinely produce documents that have large images or you export your Org
11568 files that has images using a Emacs batch script, then the use of
11569 @file{ImageMagick} is mandatory.} The pixel dimensions are subsequently
11570 converted in to units of centimeters using
11571 @code{org-odt-pixels-per-inch}. The default value of this variable is
11572 set to @code{display-pixels-per-inch}. You can tweak this variable to
11573 achieve the best results.
11575 The examples below illustrate the various possibilities.
11578 @item Explicitly size the image
11579 To embed @file{img.png} as a 10 cm x 10 cm image, do the following:
11582 #+ATTR_ODT: :width 10 :height 10
11586 @item Scale the image
11587 To embed @file{img.png} at half its size, do the following:
11590 #+ATTR_ODT: :scale 0.5
11594 @item Scale the image to a specific width
11595 To embed @file{img.png} with a width of 10 cm while retaining the original
11596 height:width ratio, do the following:
11599 #+ATTR_ODT: :width 10
11603 @item Scale the image to a specific height
11604 To embed @file{img.png} with a height of 10 cm while retaining the original
11605 height:width ratio, do the following
11608 #+ATTR_ODT: :height 10
11613 @subsubheading Anchoring of images
11616 You can control the manner in which an image is anchored by setting the
11617 @code{:anchor} property of it's @code{#+ATTR_ODT} line. You can specify one
11618 of the the following three values for the @code{:anchor} property:
11619 @samp{"as-char"}, @samp{"paragraph"} and @samp{"page"}.
11621 To create an image that is anchored to a page, do the following:
11623 #+ATTR_ODT: :anchor "page"
11627 @node Math formatting in ODT export, Labels and captions in ODT export, Images in ODT export, OpenDocument Text export
11628 @subsection Math formatting in ODT export
11630 The ODT exporter has special support for handling math.
11633 * Working with @LaTeX{} math snippets:: How to embed @LaTeX{} math fragments
11634 * Working with MathML or OpenDocument formula files:: How to embed equations in native format
11637 @node Working with @LaTeX{} math snippets, Working with MathML or OpenDocument formula files, Math formatting in ODT export, Math formatting in ODT export
11638 @subsubsection Working with @LaTeX{} math snippets
11640 @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be embedded in the ODT
11641 document in one of the following ways:
11647 This option is activated on a per-file basis with
11653 With this option, @LaTeX{} fragments are first converted into MathML
11654 fragments using an external @LaTeX{}-to-MathML converter program. The
11655 resulting MathML fragments are then embedded as an OpenDocument Formula in
11656 the exported document.
11658 @vindex org-latex-to-mathml-convert-command
11659 @vindex org-latex-to-mathml-jar-file
11661 You can specify the @LaTeX{}-to-MathML converter by customizing the variables
11662 @code{org-latex-to-mathml-convert-command} and
11663 @code{org-latex-to-mathml-jar-file}.
11665 If you prefer to use @file{MathToWeb}@footnote{See
11666 @uref{http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl, MathToWeb}} as your
11667 converter, you can configure the above variables as shown below.
11670 (setq org-latex-to-mathml-convert-command
11671 "java -jar %j -unicode -force -df %o %I"
11672 org-latex-to-mathml-jar-file
11673 "/path/to/mathtoweb.jar")
11676 You can use the following commands to quickly verify the reliability of
11677 the @LaTeX{}-to-MathML converter.
11680 @item M-x org-odt-export-as-odf
11681 Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file.
11683 @item M-x org-odt-export-as-odf-and-open
11684 Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file
11685 and open the formula file with the system-registered application.
11691 This option is activated on a per-file basis with
11694 #+OPTIONS: LaTeX:dvipng
11697 With this option, @LaTeX{} fragments are processed into PNG images and the
11698 resulting images are embedded in the exported document. This method requires
11699 that the @file{dvipng} program be available on your system.
11702 @node Working with MathML or OpenDocument formula files, , Working with @LaTeX{} math snippets, Math formatting in ODT export
11703 @subsubsection Working with MathML or OpenDocument formula files
11705 For various reasons, you may find embedding @LaTeX{} math snippets in an
11706 ODT document less than reliable. In that case, you can embed a
11707 math equation by linking to its MathML (@file{.mml}) source or its
11708 OpenDocument formula (@file{.odf}) file as shown below:
11720 @node Labels and captions in ODT export, Literal examples in ODT export, Math formatting in ODT export, OpenDocument Text export
11721 @subsection Labels and captions in ODT export
11723 You can label and caption various category of objects---an inline image, a
11724 table, a @LaTeX{} fragment or a Math formula---using @code{#+LABEL} and
11725 @code{#+CAPTION} lines. @xref{Images and tables}. ODT exporter enumerates
11726 each labeled or captioned object of a given category separately. As a
11727 result, each such object is assigned a sequence number based on order of it's
11728 appearance in the Org file.
11730 In the exported document, a user-provided caption is augmented with the
11731 category and sequence number. Consider the following inline image in an Org
11735 #+CAPTION: Bell curve
11736 #+LABEL: fig:SED-HR4049
11740 It could be rendered as shown below in the exported document.
11743 Figure 2: Bell curve
11746 @vindex org-odt-category-map-alist
11747 You can modify the category component of the caption by customizing the
11748 option @code{org-odt-category-map-alist}. For example, to tag all embedded
11749 images with the string @samp{Illustration} (instead of the default
11750 @samp{Figure}) use the following setting:
11753 (setq org-odt-category-map-alist
11754 (("__Figure__" "Illustration" "value" "Figure" org-odt--enumerable-image-p)))
11757 With this, previous image will be captioned as below in the exported
11761 Illustration 2: Bell curve
11764 @node Literal examples in ODT export, Advanced topics in ODT export, Labels and captions in ODT export, OpenDocument Text export
11765 @subsection Literal examples in ODT export
11767 Export of literal examples (@pxref{Literal examples}) with full fontification
11768 is supported. Internally, the exporter relies on @file{htmlfontify.el} to
11769 generate all style definitions needed for a fancy listing.@footnote{Your
11770 @file{htmlfontify.el} library must at least be at Emacs 24.1 levels for
11771 fontification to be turned on.} The auto-generated styles have @samp{OrgSrc}
11772 as prefix and inherit their color from the faces used by Emacs
11773 @code{font-lock} library for the source language.
11775 @vindex org-odt-fontify-srcblocks
11776 If you prefer to use your own custom styles for fontification, you can do
11777 so by customizing the variable
11778 @code{org-odt-create-custom-styles-for-srcblocks}.
11780 @vindex org-odt-create-custom-styles-for-srcblocks
11781 You can turn off fontification of literal examples by customizing the
11782 option @code{org-odt-fontify-srcblocks}.
11784 @node Advanced topics in ODT export, , Literal examples in ODT export, OpenDocument Text export
11785 @subsection Advanced topics in ODT export
11787 If you rely heavily on ODT export, you may want to exploit the full
11788 set of features that the exporter offers. This section describes features
11789 that would be of interest to power users.
11792 * Configuring a document converter:: How to register a document converter
11793 * Working with OpenDocument style files:: Explore the internals
11794 * Creating one-off styles:: How to produce custom highlighting etc
11795 * Customizing tables in ODT export:: How to define and use Table templates
11796 * Validating OpenDocument XML:: How to debug corrupt OpenDocument files
11799 @node Configuring a document converter, Working with OpenDocument style files, Advanced topics in ODT export, Advanced topics in ODT export
11800 @subsubsection Configuring a document converter
11802 @cindex doc, docx, rtf
11805 The ODT exporter can work with popular converters with little or no
11806 extra configuration from your side. @xref{Extending ODT export}.
11807 If you are using a converter that is not supported by default or if you would
11808 like to tweak the default converter settings, proceed as below.
11811 @item Register the converter
11813 @vindex org-odt-convert-processes
11814 Name your converter and add it to the list of known converters by
11815 customizing the option @code{org-odt-convert-processes}. Also specify how
11816 the converter can be invoked via command-line to effect the conversion.
11818 @item Configure its capabilities
11820 @vindex org-odt-convert-capabilities
11821 @anchor{x-odt-converter-capabilities} Specify the set of formats the
11822 converter can handle by customizing the variable
11823 @code{org-odt-convert-capabilities}. Use the default value for this
11824 variable as a guide for configuring your converter. As suggested by the
11825 default setting, you can specify the full set of formats supported by the
11826 converter and not limit yourself to specifying formats that are related to
11827 just the OpenDocument Text format.
11829 @item Choose the converter
11831 @vindex org-odt-convert-process
11832 Select the newly added converter as the preferred one by customizing the
11833 option @code{org-odt-convert-process}.
11836 @node Working with OpenDocument style files, Creating one-off styles, Configuring a document converter, Advanced topics in ODT export
11837 @subsubsection Working with OpenDocument style files
11838 @cindex styles, custom
11839 @cindex template, custom
11841 This section explores the internals of the ODT exporter and the
11842 means by which it produces styled documents. Read this section if you are
11843 interested in exploring the automatic and custom OpenDocument styles used by
11846 @anchor{x-factory-styles}
11847 @subsubheading Factory styles
11849 The ODT exporter relies on two files for generating its output.
11850 These files are bundled with the distribution under the directory pointed to
11851 by the variable @code{org-odt-styles-dir}. The two files are:
11854 @anchor{x-orgodtstyles-xml}
11856 @file{OrgOdtStyles.xml}
11858 This file contributes to the @file{styles.xml} file of the final @samp{ODT}
11859 document. This file gets modified for the following purposes:
11863 To control outline numbering based on user settings.
11866 To add styles generated by @file{htmlfontify.el} for fontification of code
11870 @anchor{x-orgodtcontenttemplate-xml}
11872 @file{OrgOdtContentTemplate.xml}
11874 This file contributes to the @file{content.xml} file of the final @samp{ODT}
11875 document. The contents of the Org outline are inserted between the
11876 @samp{<office:text>}@dots{}@samp{</office:text>} elements of this file.
11878 Apart from serving as a template file for the final @file{content.xml}, the
11879 file serves the following purposes:
11883 It contains automatic styles for formatting of tables which are referenced by
11887 It contains @samp{<text:sequence-decl>}@dots{}@samp{</text:sequence-decl>}
11888 elements that control how various entities---tables, images, equations,
11889 etc.---are numbered.
11893 @anchor{x-overriding-factory-styles}
11894 @subsubheading Overriding factory styles
11895 The following two variables control the location from which the ODT
11896 exporter picks up the custom styles and content template files. You can
11897 customize these variables to override the factory styles used by the
11901 @anchor{x-org-odt-styles-file}
11903 @code{org-odt-styles-file}
11905 Use this variable to specify the @file{styles.xml} that will be used in the
11906 final output. You can specify one of the following values:
11909 @item A @file{styles.xml} file
11911 Use this file instead of the default @file{styles.xml}
11913 @item A @file{.odt} or @file{.ott} file
11915 Use the @file{styles.xml} contained in the specified OpenDocument Text or
11918 @item A @file{.odt} or @file{.ott} file and a subset of files contained within them
11920 Use the @file{styles.xml} contained in the specified OpenDocument Text or
11921 Template file. Additionally extract the specified member files and embed
11922 those within the final @samp{ODT} document.
11924 Use this option if the @file{styles.xml} file references additional files
11925 like header and footer images.
11929 Use the default @file{styles.xml}
11932 @anchor{x-org-odt-content-template-file}
11934 @code{org-odt-content-template-file}
11936 Use this variable to specify the blank @file{content.xml} that will be used
11937 in the final output.
11940 @node Creating one-off styles, Customizing tables in ODT export, Working with OpenDocument style files, Advanced topics in ODT export
11941 @subsubsection Creating one-off styles
11943 There are times when you would want one-off formatting in the exported
11944 document. You can achieve this by embedding raw OpenDocument XML in the Org
11945 file. The use of this feature is better illustrated with couple of examples.
11948 @item Embedding ODT tags as part of regular text
11950 You can include simple OpenDocument tags by prefixing them with
11951 @samp{@@}. For example, to highlight a region of text do the following:
11954 @@<text:span text:style-name="Highlight">This is a
11955 highlighted text@@</text:span>. But this is a
11959 @strong{Hint:} To see the above example in action, edit your
11960 @file{styles.xml} (@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
11961 custom @samp{Highlight} style as shown below.
11964 <style:style style:name="Highlight" style:family="text">
11965 <style:text-properties fo:background-color="#ff0000"/>
11969 @item Embedding a one-line OpenDocument XML
11971 You can add a simple OpenDocument one-liner using the @code{#+ODT:}
11972 directive. For example, to force a page break do the following:
11975 #+ODT: <text:p text:style-name="PageBreak"/>
11978 @strong{Hint:} To see the above example in action, edit your
11979 @file{styles.xml} (@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
11980 custom @samp{PageBreak} style as shown below.
11983 <style:style style:name="PageBreak" style:family="paragraph"
11984 style:parent-style-name="Text_20_body">
11985 <style:paragraph-properties fo:break-before="page"/>
11989 @item Embedding a block of OpenDocument XML
11991 You can add a large block of OpenDocument XML using the
11992 @code{#+BEGIN_ODT}@dots{}@code{#+END_ODT} construct.
11994 For example, to create a one-off paragraph that uses bold text, do the
11999 <text:p text:style-name="Text_20_body_20_bold">
12000 This paragraph is specially formatted and uses bold text.
12007 @node Customizing tables in ODT export, Validating OpenDocument XML, Creating one-off styles, Advanced topics in ODT export
12008 @subsubsection Customizing tables in ODT export
12009 @cindex tables, in ODT export
12012 You can override the default formatting of the table by specifying a custom
12013 table style with the @code{#+ATTR_ODT} line. For a discussion on default
12014 formatting of tables @pxref{Tables in ODT export}.
12016 This feature closely mimics the way table templates are defined in the
12018 specification.@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
12019 OpenDocument-v1.2 Specification}}
12021 @subsubheading Custom table styles: an illustration
12023 @vindex org-odt-table-styles
12024 To have a quick preview of this feature, install the below setting and
12025 export the table that follows:
12028 (setq org-odt-table-styles
12029 (append org-odt-table-styles
12030 '(("TableWithHeaderRowAndColumn" "Custom"
12031 ((use-first-row-styles . t)
12032 (use-first-column-styles . t)))
12033 ("TableWithFirstRowandLastRow" "Custom"
12034 ((use-first-row-styles . t)
12035 (use-last-row-styles . t))))))
12039 #+ATTR_ODT: :style "TableWithHeaderRowAndColumn"
12040 | Name | Phone | Age |
12041 | Peter | 1234 | 17 |
12042 | Anna | 4321 | 25 |
12045 In the above example, you used a template named @samp{Custom} and installed
12046 two table styles with the names @samp{TableWithHeaderRowAndColumn} and
12047 @samp{TableWithFirstRowandLastRow}. (@strong{Important:} The OpenDocument
12048 styles needed for producing the above template have been pre-defined for
12049 you. These styles are available under the section marked @samp{Custom
12050 Table Template} in @file{OrgOdtContentTemplate.xml}
12051 (@pxref{x-orgodtcontenttemplate-xml,,Factory styles}). If you need
12052 additional templates you have to define these styles yourselves.
12054 @subsubheading Custom table styles: the nitty-gritty
12055 To use this feature proceed as follows:
12059 Create a table template@footnote{See the @code{<table:table-template>}
12060 element of the OpenDocument-v1.2 specification}
12062 A table template is nothing but a set of @samp{table-cell} and
12063 @samp{paragraph} styles for each of the following table cell categories:
12077 The names for the above styles must be chosen based on the name of the table
12078 template using a well-defined convention.
12080 The naming convention is better illustrated with an example. For a table
12081 template with the name @samp{Custom}, the needed style names are listed in
12082 the following table.
12084 @multitable {Table cell type} {CustomEvenColumnTableCell} {CustomEvenColumnTableParagraph}
12085 @headitem Table cell type
12086 @tab @code{table-cell} style
12087 @tab @code{paragraph} style
12092 @tab @samp{CustomTableCell}
12093 @tab @samp{CustomTableParagraph}
12095 @tab @samp{CustomFirstColumnTableCell}
12096 @tab @samp{CustomFirstColumnTableParagraph}
12098 @tab @samp{CustomLastColumnTableCell}
12099 @tab @samp{CustomLastColumnTableParagraph}
12101 @tab @samp{CustomFirstRowTableCell}
12102 @tab @samp{CustomFirstRowTableParagraph}
12104 @tab @samp{CustomLastRowTableCell}
12105 @tab @samp{CustomLastRowTableParagraph}
12107 @tab @samp{CustomEvenRowTableCell}
12108 @tab @samp{CustomEvenRowTableParagraph}
12110 @tab @samp{CustomOddRowTableCell}
12111 @tab @samp{CustomOddRowTableParagraph}
12113 @tab @samp{CustomEvenColumnTableCell}
12114 @tab @samp{CustomEvenColumnTableParagraph}
12116 @tab @samp{CustomOddColumnTableCell}
12117 @tab @samp{CustomOddColumnTableParagraph}
12120 To create a table template with the name @samp{Custom}, define the above
12122 @code{<office:automatic-styles>}...@code{</office:automatic-styles>} element
12123 of the content template file (@pxref{x-orgodtcontenttemplate-xml,,Factory
12127 Define a table style@footnote{See the attributes @code{table:template-name},
12128 @code{table:use-first-row-styles}, @code{table:use-last-row-styles},
12129 @code{table:use-first-column-styles}, @code{table:use-last-column-styles},
12130 @code{table:use-banding-rows-styles}, and
12131 @code{table:use-banding-column-styles} of the @code{<table:table>} element in
12132 the OpenDocument-v1.2 specification}
12134 @vindex org-odt-table-styles
12135 To define a table style, create an entry for the style in the variable
12136 @code{org-odt-table-styles} and specify the following:
12139 @item the name of the table template created in step (1)
12140 @item the set of cell styles in that template that are to be activated
12143 For example, the entry below defines two different table styles
12144 @samp{TableWithHeaderRowAndColumn} and @samp{TableWithFirstRowandLastRow}
12145 based on the same template @samp{Custom}. The styles achieve their intended
12146 effect by selectively activating the individual cell styles in that template.
12149 (setq org-odt-table-styles
12150 (append org-odt-table-styles
12151 '(("TableWithHeaderRowAndColumn" "Custom"
12152 ((use-first-row-styles . t)
12153 (use-first-column-styles . t)))
12154 ("TableWithFirstRowandLastRow" "Custom"
12155 ((use-first-row-styles . t)
12156 (use-last-row-styles . t))))))
12160 Associate a table with the table style
12162 To do this, specify the table style created in step (2) as part of
12163 the @code{ATTR_ODT} line as shown below.
12166 #+ATTR_ODT: :style "TableWithHeaderRowAndColumn"
12167 | Name | Phone | Age |
12168 | Peter | 1234 | 17 |
12169 | Anna | 4321 | 25 |
12173 @node Validating OpenDocument XML, , Customizing tables in ODT export, Advanced topics in ODT export
12174 @subsubsection Validating OpenDocument XML
12176 Occasionally, you will discover that the document created by the
12177 ODT exporter cannot be opened by your favorite application. One of
12178 the common reasons for this is that the @file{.odt} file is corrupt. In such
12179 cases, you may want to validate the document against the OpenDocument RELAX
12180 NG Compact Syntax (RNC) schema.
12182 For de-compressing the @file{.odt} file@footnote{@file{.odt} files are
12183 nothing but @samp{zip} archives}: @inforef{File Archives,,emacs}. For
12184 general help with validation (and schema-sensitive editing) of XML files:
12185 @inforef{Introduction,,nxml-mode}.
12187 @vindex org-odt-schema-dir
12188 If you have ready access to OpenDocument @file{.rnc} files and the needed
12189 schema-locating rules in a single folder, you can customize the variable
12190 @code{org-odt-schema-dir} to point to that directory. The ODT exporter
12191 will take care of updating the @code{rng-schema-locating-files} for you.
12193 @c end opendocument
12195 @node iCalendar export, , OpenDocument Text export, Exporting
12196 @section iCalendar export
12197 @cindex iCalendar export
12199 @vindex org-icalendar-include-todo
12200 @vindex org-icalendar-use-deadline
12201 @vindex org-icalendar-use-scheduled
12202 @vindex org-icalendar-categories
12203 @vindex org-icalendar-alarm-time
12204 Some people use Org mode for keeping track of projects, but still prefer a
12205 standard calendar application for anniversaries and appointments. In this
12206 case it can be useful to show deadlines and other time-stamped items in Org
12207 files in the calendar application. Org mode can export calendar information
12208 in the standard iCalendar format. If you also want to have TODO entries
12209 included in the export, configure the variable
12210 @code{org-icalendar-include-todo}. Plain timestamps are exported as VEVENT,
12211 and TODO items as VTODO@. It will also create events from deadlines that are
12212 in non-TODO items. Deadlines and scheduling dates in TODO items will be used
12213 to set the start and due dates for the TODO entry@footnote{See the variables
12214 @code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}.
12215 As categories, it will use the tags locally defined in the heading, and the
12216 file/tree category@footnote{To add inherited tags or the TODO state,
12217 configure the variable @code{org-icalendar-categories}.}. See the variable
12218 @code{org-icalendar-alarm-time} for a way to assign alarms to entries with a
12221 @vindex org-icalendar-store-UID
12222 @cindex property, ID
12223 The iCalendar standard requires each entry to have a globally unique
12224 identifier (UID). Org creates these identifiers during export. If you set
12225 the variable @code{org-icalendar-store-UID}, the UID will be stored in the
12226 @code{:ID:} property of the entry and re-used next time you report this
12227 entry. Since a single entry can give rise to multiple iCalendar entries (as
12228 a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
12229 prefixes to the UID, depending on what triggered the inclusion of the entry.
12230 In this way the UID remains unique, but a synchronization program can still
12231 figure out from which entry all the different instances originate.
12234 @orgcmd{C-c C-e c f,org-icalendar-export-to-ics}
12235 Create iCalendar entries for the current buffer and store them in the same
12236 directory, using a file extension @file{.ics}.
12237 @orgcmd{C-c C-e c a, org-icalendar-export-agenda-files}
12238 @vindex org-agenda-files
12239 Like @kbd{C-c C-e c f}, but do this for all files in
12240 @code{org-agenda-files}. For each of these files, a separate iCalendar
12241 file will be written.
12242 @orgcmd{C-c C-e c c,org-icalendar-combine-agenda-files}
12243 @vindex org-icalendar-combined-agenda-file
12244 Create a single large iCalendar file from all files in
12245 @code{org-agenda-files} and write it to the file given by
12246 @code{org-icalendar-combined-agenda-file}.
12249 @vindex org-use-property-inheritance
12250 @vindex org-icalendar-include-body
12251 @cindex property, SUMMARY
12252 @cindex property, DESCRIPTION
12253 @cindex property, LOCATION
12254 The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION
12255 property can be inherited from higher in the hierarchy if you configure
12256 @code{org-use-property-inheritance} accordingly.} properties if the selected
12257 entries have them. If not, the summary will be derived from the headline,
12258 and the description from the body (limited to
12259 @code{org-icalendar-include-body} characters).
12261 How this calendar is best read and updated, depends on the application
12262 you are using. The FAQ covers this issue.
12264 @node Publishing, Working With Source Code, Exporting, Top
12265 @chapter Publishing
12268 Org includes a publishing management system that allows you to configure
12269 automatic HTML conversion of @emph{projects} composed of interlinked org
12270 files. You can also configure Org to automatically upload your exported HTML
12271 pages and related attachments, such as images and source code files, to a web
12274 You can also use Org to convert files into PDF, or even combine HTML and PDF
12275 conversion so that files are available in both formats on the server.
12277 Publishing has been contributed to Org by David O'Toole.
12280 * Configuration:: Defining projects
12281 * Uploading files:: How to get files up on the server
12282 * Sample configuration:: Example projects
12283 * Triggering publication:: Publication commands
12286 @node Configuration, Uploading files, Publishing, Publishing
12287 @section Configuration
12289 Publishing needs significant configuration to specify files, destination
12290 and many other properties of a project.
12293 * Project alist:: The central configuration variable
12294 * Sources and destinations:: From here to there
12295 * Selecting files:: What files are part of the project?
12296 * Publishing action:: Setting the function doing the publishing
12297 * Publishing options:: Tweaking HTML/@LaTeX{} export
12298 * Publishing links:: Which links keep working after publishing?
12299 * Sitemap:: Generating a list of all pages
12300 * Generating an index:: An index that reaches across pages
12303 @node Project alist, Sources and destinations, Configuration, Configuration
12304 @subsection The variable @code{org-publish-project-alist}
12305 @cindex org-publish-project-alist
12306 @cindex projects, for publishing
12308 @vindex org-publish-project-alist
12309 Publishing is configured almost entirely through setting the value of one
12310 variable, called @code{org-publish-project-alist}. Each element of the list
12311 configures one project, and may be in one of the two following forms:
12314 ("project-name" :property value :property value ...)
12315 @r{i.e., a well-formed property list with alternating keys and values}
12317 ("project-name" :components ("project-name" "project-name" ...))
12321 In both cases, projects are configured by specifying property values. A
12322 project defines the set of files that will be published, as well as the
12323 publishing configuration to use when publishing those files. When a project
12324 takes the second form listed above, the individual members of the
12325 @code{:components} property are taken to be sub-projects, which group
12326 together files requiring different publishing options. When you publish such
12327 a ``meta-project'', all the components will also be published, in the
12330 @node Sources and destinations, Selecting files, Project alist, Configuration
12331 @subsection Sources and destinations for files
12332 @cindex directories, for publishing
12334 Most properties are optional, but some should always be set. In
12335 particular, Org needs to know where to look for source files,
12336 and where to put published files.
12338 @multitable @columnfractions 0.3 0.7
12339 @item @code{:base-directory}
12340 @tab Directory containing publishing source files
12341 @item @code{:publishing-directory}
12342 @tab Directory where output files will be published. You can directly
12343 publish to a web server using a file name syntax appropriate for
12344 the Emacs @file{tramp} package. Or you can publish to a local directory and
12345 use external tools to upload your website (@pxref{Uploading files}).
12346 @item @code{:preparation-function}
12347 @tab Function or list of functions to be called before starting the
12348 publishing process, for example, to run @code{make} for updating files to be
12349 published. The project property list is scoped into this call as the
12350 variable @code{project-plist}.
12351 @item @code{:completion-function}
12352 @tab Function or list of functions called after finishing the publishing
12353 process, for example, to change permissions of the resulting files. The
12354 project property list is scoped into this call as the variable
12355 @code{project-plist}.
12359 @node Selecting files, Publishing action, Sources and destinations, Configuration
12360 @subsection Selecting files
12361 @cindex files, selecting for publishing
12363 By default, all files with extension @file{.org} in the base directory
12364 are considered part of the project. This can be modified by setting the
12366 @multitable @columnfractions 0.25 0.75
12367 @item @code{:base-extension}
12368 @tab Extension (without the dot!) of source files. This actually is a
12369 regular expression. Set this to the symbol @code{any} if you want to get all
12370 files in @code{:base-directory}, even without extension.
12372 @item @code{:exclude}
12373 @tab Regular expression to match file names that should not be
12374 published, even though they have been selected on the basis of their
12377 @item @code{:include}
12378 @tab List of files to be included regardless of @code{:base-extension}
12379 and @code{:exclude}.
12381 @item @code{:recursive}
12382 @tab Non-nil means, check base-directory recursively for files to publish.
12385 @node Publishing action, Publishing options, Selecting files, Configuration
12386 @subsection Publishing action
12387 @cindex action, for publishing
12389 Publishing means that a file is copied to the destination directory and
12390 possibly transformed in the process. The default transformation is to export
12391 Org files as HTML files, and this is done by the function
12392 @code{org-html-publish-to-html} which calls the HTML exporter (@pxref{HTML
12393 export}). But you also can publish your content as PDF files using
12394 @code{org-latex-publish-to-pdf} or as @code{ascii}, @code{Texinfo}, etc.,
12395 using the corresponding functions.
12397 If you want to publish the Org file itself but with the @i{archived},
12398 @i{commented} and @i{tag-excluded} trees removed, use the function
12399 @code{org-org-publish-to-org}. This will produce @file{file.org}. If you
12400 want a htmlized version of this file, set the parameter
12401 @code{:htmlized-source} to @code{t}, it will produce @file{file.org.html} in
12402 the publishing directory.
12404 @c @footnote{@file{file-source.org} and @file{file-source.org.html} if source
12405 @c and publishing directories are equal. Note that with this kind of setup, you
12406 @c need to add @code{:exclude "-source\\.org"} to the project definition in
12407 @c @code{org-publish-project-alist} to prevent the published source files from
12408 @c being considered as new org files the next time the project is published.}.
12410 Other files like images only need to be copied to the publishing destination;
12411 for this you may use @code{org-publish-attachment}. For non-Org files, you
12412 always need to specify the publishing function:
12414 @multitable @columnfractions 0.3 0.7
12415 @item @code{:publishing-function}
12416 @tab Function executing the publication of a file. This may also be a
12417 list of functions, which will all be called in turn.
12418 @c @item @code{:plain-source}
12419 @c @tab Non-nil means, publish plain source.
12420 @item @code{:htmlized-source}
12421 @tab Non-nil means, publish htmlized source.
12424 The function must accept three arguments: a property list containing at least
12425 a @code{:publishing-directory} property, the name of the file to be
12426 published, and the path to the publishing directory of the output file. It
12427 should take the specified file, make the necessary transformation (if any)
12428 and place the result into the destination folder.
12430 @node Publishing options, Publishing links, Publishing action, Configuration
12431 @subsection Options for the exporters
12432 @cindex options, for publishing
12434 The property list can be used to set many export options for the exporters.
12435 In most cases, these properties correspond to user variables in Org. The
12436 first table below lists these properties along with the variable they belong
12437 to. The second table list HTML specific properties. See the documentation
12438 string for the respective variable for details.
12440 @vindex org-export-with-archived-trees
12441 @vindex org-export-with-author
12442 @vindex org-export-with-creator
12443 @vindex org-display-custom-times
12444 @vindex org-export-with-drawers
12445 @vindex org-export-with-email
12446 @vindex user-mail-address
12447 @vindex org-export-with-emphasize
12448 @vindex org-export-exclude-tags
12449 @vindex org-export-with-fixed-width
12450 @vindex org-export-with-footnotes
12451 @vindex org-export-headline-levels
12452 @vindex org-export-default-language
12453 @vindex org-export-with-latex
12454 @vindex org-export-preserve-breaks
12455 @vindex org-export-with-priority
12456 @vindex org-export-publishing-directory
12457 @vindex org-export-with-section-numbers
12458 @vindex org-export-select-tags
12459 @vindex org-export-with-special-strings
12460 @vindex org-export-with-sub-superscripts
12461 @vindex org-export-with-toc
12462 @vindex org-export-with-tables
12463 @vindex org-export-with-tags
12464 @vindex org-export-with-tasks
12465 @vindex org-export-with-timestamps
12466 @vindex org-export-with-todo-keywords
12468 @multitable @columnfractions 0.32 0.68
12469 @item @code{:archived-trees} @tab @code{org-export-with-archived-trees}
12470 @item @code{:author} @tab @code{org-export-with-author}
12471 @item @code{:creator} @tab @code{org-export-with-creator}
12472 @item @code{:customtime} @tab @code{org-display-custom-times}
12473 @item @code{:drawers} @tab @code{org-export-with-drawers}
12474 @item @code{:email} @tab @code{org-export-with-email}
12475 @item @code{:email} @tab @code{user-mail-address} : @code{addr;addr;..}
12476 @item @code{:emphasize} @tab @code{org-export-with-emphasize}
12477 @item @code{:exclude-tags} @tab @code{org-export-exclude-tags}
12478 @item @code{:fixed-width} @tab @code{org-export-with-fixed-width}
12479 @item @code{:footnotes} @tab @code{org-export-with-footnotes}
12480 @item @code{:headline-levels} @tab @code{org-export-headline-levels}
12481 @item @code{:language} @tab @code{org-export-default-language}
12482 @item @code{:latex-fragments} @tab @code{org-export-with-latex}
12483 @item @code{:preserve-breaks} @tab @code{org-export-preserve-breaks}
12484 @item @code{:priority} @tab @code{org-export-with-priority}
12485 @item @code{:publishing-directory} @tab @code{org-export-publishing-directory}
12486 @item @code{:section-numbers} @tab @code{org-export-with-section-numbers}
12487 @item @code{:select-tags} @tab @code{org-export-select-tags}
12488 @item @code{:special-strings} @tab @code{org-export-with-special-strings}
12489 @item @code{:sub-superscript} @tab @code{org-export-with-sub-superscripts}
12490 @item @code{:table-of-contents} @tab @code{org-export-with-toc}
12491 @item @code{:tables} @tab @code{org-export-with-tables}
12492 @item @code{:tags} @tab @code{org-export-with-tags}
12493 @item @code{:tasks} @tab @code{org-export-with-tasks}
12494 @item @code{:timestamps} @tab @code{org-export-with-timestamps}
12495 @item @code{:todo-keywords} @tab @code{org-export-with-todo-keywords}
12498 @vindex org-html-doctype
12499 @vindex org-html-xml-declaration
12500 @vindex org-html-link-up
12501 @vindex org-html-link-home
12502 @vindex org-html-link-org-files-as-html
12503 @vindex org-html-head
12504 @vindex org-html-head-extra
12505 @vindex org-html-inline-images
12506 @vindex org-html-extension
12507 @vindex org-html-preamble
12508 @vindex org-html-postamble
12509 @vindex org-html-table-default-attributes
12510 @vindex org-html-style-include-default
12511 @vindex org-html-style-include-scripts
12512 @multitable @columnfractions 0.32 0.68
12513 @item @code{:html-doctype} @tab @code{org-html-doctype}
12514 @item @code{:html-xml-declaration} @tab @code{org-html-xml-declaration}
12515 @item @code{:html-link-up} @tab @code{org-html-link-up}
12516 @item @code{:html-link-home} @tab @code{org-html-link-home}
12517 @item @code{:html-link-org-as-html} @tab @code{org-html-link-org-files-as-html}
12518 @item @code{:html-head} @tab @code{org-html-head}
12519 @item @code{:html-head-extra} @tab @code{org-html-head-extra}
12520 @item @code{:html-inline-images} @tab @code{org-html-inline-images}
12521 @item @code{:html-extension} @tab @code{org-html-extension}
12522 @item @code{:html-preamble} @tab @code{org-html-preamble}
12523 @item @code{:html-postamble} @tab @code{org-html-postamble}
12524 @item @code{:html-table-attributes} @tab @code{org-html-table-default-attributes}
12525 @item @code{:html-head-include-default-style} @tab @code{org-html-style-include-default}
12526 @item @code{:html-head-include-scripts} @tab @code{org-html-style-include-scripts}
12529 Most of the @code{org-export-with-*} variables have the same effect in each
12532 @vindex org-publish-project-alist
12533 When a property is given a value in @code{org-publish-project-alist}, its
12534 setting overrides the value of the corresponding user variable (if any)
12535 during publishing. Options set within a file (@pxref{Export settings}),
12536 however, override everything.
12538 @node Publishing links, Sitemap, Publishing options, Configuration
12539 @subsection Links between published files
12540 @cindex links, publishing
12542 To create a link from one Org file to another, you would use something like
12543 @samp{[[file:foo.org][The foo]]} or simply @samp{file:foo.org.}
12544 (@pxref{Hyperlinks}). When published, this link becomes a link to
12545 @file{foo.html}. You can thus interlink the pages of your "org web" project
12546 and the links will work as expected when you publish them to HTML@. If you
12547 also publish the Org source file and want to link to it, use an @code{http:}
12548 link instead of a @code{file:} link, because @code{file:} links are converted
12549 to link to the corresponding @file{html} file.
12551 You may also link to related files, such as images. Provided you are careful
12552 with relative file names, and provided you have also configured Org to upload
12553 the related files, these links will work too. See @ref{Complex example}, for
12554 an example of this usage.
12556 @node Sitemap, Generating an index, Publishing links, Configuration
12557 @subsection Generating a sitemap
12558 @cindex sitemap, of published pages
12560 The following properties may be used to control publishing of
12561 a map of files for a given project.
12563 @multitable @columnfractions 0.35 0.65
12564 @item @code{:auto-sitemap}
12565 @tab When non-nil, publish a sitemap during @code{org-publish-current-project}
12566 or @code{org-publish-all}.
12568 @item @code{:sitemap-filename}
12569 @tab Filename for output of sitemap. Defaults to @file{sitemap.org} (which
12570 becomes @file{sitemap.html}).
12572 @item @code{:sitemap-title}
12573 @tab Title of sitemap page. Defaults to name of file.
12575 @item @code{:sitemap-function}
12576 @tab Plug-in function to use for generation of the sitemap.
12577 Defaults to @code{org-publish-org-sitemap}, which generates a plain list
12578 of links to all files in the project.
12580 @item @code{:sitemap-sort-folders}
12581 @tab Where folders should appear in the sitemap. Set this to @code{first}
12582 (default) or @code{last} to display folders first or last,
12583 respectively. Any other value will mix files and folders.
12585 @item @code{:sitemap-sort-files}
12586 @tab How the files are sorted in the site map. Set this to
12587 @code{alphabetically} (default), @code{chronologically} or
12588 @code{anti-chronologically}. @code{chronologically} sorts the files with
12589 older date first while @code{anti-chronologically} sorts the files with newer
12590 date first. @code{alphabetically} sorts the files alphabetically. The date of
12591 a file is retrieved with @code{org-publish-find-date}.
12593 @item @code{:sitemap-ignore-case}
12594 @tab Should sorting be case-sensitive? Default @code{nil}.
12596 @item @code{:sitemap-file-entry-format}
12597 @tab With this option one can tell how a sitemap's entry is formatted in the
12598 sitemap. This is a format string with some escape sequences: @code{%t} stands
12599 for the title of the file, @code{%a} stands for the author of the file and
12600 @code{%d} stands for the date of the file. The date is retrieved with the
12601 @code{org-publish-find-date} function and formatted with
12602 @code{org-publish-sitemap-date-format}. Default @code{%t}.
12604 @item @code{:sitemap-date-format}
12605 @tab Format string for the @code{format-time-string} function that tells how
12606 a sitemap entry's date is to be formatted. This property bypasses
12607 @code{org-publish-sitemap-date-format} which defaults to @code{%Y-%m-%d}.
12609 @item @code{:sitemap-sans-extension}
12610 @tab When non-nil, remove filenames' extensions from the generated sitemap.
12611 Useful to have cool URIs (see @uref{http://www.w3.org/Provider/Style/URI}).
12612 Defaults to @code{nil}.
12616 @node Generating an index, , Sitemap, Configuration
12617 @subsection Generating an index
12618 @cindex index, in a publishing project
12620 Org mode can generate an index across the files of a publishing project.
12622 @multitable @columnfractions 0.25 0.75
12623 @item @code{:makeindex}
12624 @tab When non-nil, generate in index in the file @file{theindex.org} and
12625 publish it as @file{theindex.html}.
12628 The file will be created when first publishing a project with the
12629 @code{:makeindex} set. The file only contains a statement @code{#+INCLUDE:
12630 "theindex.inc"}. You can then build around this include statement by adding
12631 a title, style information, etc.
12633 @node Uploading files, Sample configuration, Configuration, Publishing
12634 @section Uploading files
12638 For those people already utilizing third party sync tools such as
12639 @command{rsync} or @command{unison}, it might be preferable not to use the built in
12640 @i{remote} publishing facilities of Org mode which rely heavily on
12641 Tramp. Tramp, while very useful and powerful, tends not to be
12642 so efficient for multiple file transfer and has been known to cause problems
12645 Specialized synchronization utilities offer several advantages. In addition
12646 to timestamp comparison, they also do content and permissions/attribute
12647 checks. For this reason you might prefer to publish your web to a local
12648 directory (possibly even @i{in place} with your Org files) and then use
12649 @file{unison} or @file{rsync} to do the synchronization with the remote host.
12651 Since Unison (for example) can be configured as to which files to transfer to
12652 a certain remote destination, it can greatly simplify the project publishing
12653 definition. Simply keep all files in the correct location, process your Org
12654 files with @code{org-publish} and let the synchronization tool do the rest.
12655 You do not need, in this scenario, to include attachments such as @file{jpg},
12656 @file{css} or @file{gif} files in the project definition since the 3rd party
12659 Publishing to a local directory is also much faster than to a remote one, so
12660 that you can afford more easily to republish entire projects. If you set
12661 @code{org-publish-use-timestamps-flag} to @code{nil}, you gain the main
12662 benefit of re-including any changed external files such as source example
12663 files you might include with @code{#+INCLUDE:}. The timestamp mechanism in
12664 Org is not smart enough to detect if included files have been modified.
12666 @node Sample configuration, Triggering publication, Uploading files, Publishing
12667 @section Sample configuration
12669 Below we provide two example configurations. The first one is a simple
12670 project publishing only a set of Org files. The second example is
12671 more complex, with a multi-component project.
12674 * Simple example:: One-component publishing
12675 * Complex example:: A multi-component publishing example
12678 @node Simple example, Complex example, Sample configuration, Sample configuration
12679 @subsection Example: simple publishing configuration
12681 This example publishes a set of Org files to the @file{public_html}
12682 directory on the local machine.
12685 (setq org-publish-project-alist
12687 :base-directory "~/org/"
12688 :publishing-directory "~/public_html"
12689 :section-numbers nil
12690 :table-of-contents nil
12691 :style "<link rel=\"stylesheet\"
12692 href=\"../other/mystyle.css\"
12693 type=\"text/css\"/>")))
12696 @node Complex example, , Simple example, Sample configuration
12697 @subsection Example: complex publishing configuration
12699 This more complicated example publishes an entire website, including
12700 Org files converted to HTML, image files, Emacs Lisp source code, and
12701 style sheets. The publishing directory is remote and private files are
12704 To ensure that links are preserved, care should be taken to replicate
12705 your directory structure on the web server, and to use relative file
12706 paths. For example, if your Org files are kept in @file{~/org} and your
12707 publishable images in @file{~/images}, you would link to an image with
12710 file:../images/myimage.png
12713 On the web server, the relative path to the image should be the
12714 same. You can accomplish this by setting up an "images" folder in the
12715 right place on the web server, and publishing images to it.
12718 (setq org-publish-project-alist
12720 :base-directory "~/org/"
12721 :base-extension "org"
12722 :publishing-directory "/ssh:user@@host:~/html/notebook/"
12723 :publishing-function org-html-publish-to-html
12724 :exclude "PrivatePage.org" ;; regexp
12726 :section-numbers nil
12727 :table-of-contents nil
12728 :style "<link rel=\"stylesheet\"
12729 href=\"../other/mystyle.css\" type=\"text/css\"/>"
12733 :base-directory "~/images/"
12734 :base-extension "jpg\\|gif\\|png"
12735 :publishing-directory "/ssh:user@@host:~/html/images/"
12736 :publishing-function org-publish-attachment)
12739 :base-directory "~/other/"
12740 :base-extension "css\\|el"
12741 :publishing-directory "/ssh:user@@host:~/html/other/"
12742 :publishing-function org-publish-attachment)
12743 ("website" :components ("orgfiles" "images" "other"))))
12746 @node Triggering publication, , Sample configuration, Publishing
12747 @section Triggering publication
12749 Once properly configured, Org can publish with the following commands:
12752 @orgcmd{C-c C-e P x,org-publish}
12753 Prompt for a specific project and publish all files that belong to it.
12754 @orgcmd{C-c C-e P p,org-publish-current-project}
12755 Publish the project containing the current file.
12756 @orgcmd{C-c C-e P f,org-publish-current-file}
12757 Publish only the current file.
12758 @orgcmd{C-c C-e P a,org-publish-all}
12759 Publish every project.
12762 @vindex org-publish-use-timestamps-flag
12763 Org uses timestamps to track when a file has changed. The above functions
12764 normally only publish changed files. You can override this and force
12765 publishing of all files by giving a prefix argument to any of the commands
12766 above, or by customizing the variable @code{org-publish-use-timestamps-flag}.
12767 This may be necessary in particular if files include other files via
12768 @code{#+SETUPFILE:} or @code{#+INCLUDE:}.
12770 @comment node-name, next, previous, up
12771 @comment Working With Source Code, Miscellaneous, Publishing, Top
12773 @node Working With Source Code, Miscellaneous, Publishing, Top
12774 @chapter Working with source code
12775 @cindex Schulte, Eric
12776 @cindex Davison, Dan
12777 @cindex source code, working with
12779 Source code can be included in Org mode documents using a @samp{src} block,
12783 #+BEGIN_SRC emacs-lisp
12784 (defun org-xor (a b)
12790 Org mode provides a number of features for working with live source code,
12791 including editing of code blocks in their native major-mode, evaluation of
12792 code blocks, converting code blocks into source files (known as @dfn{tangling}
12793 in literate programming), and exporting code blocks and their
12794 results in several formats. This functionality was contributed by Eric
12795 Schulte and Dan Davison, and was originally named Org-babel.
12797 The following sections describe Org mode's code block handling facilities.
12800 * Structure of code blocks:: Code block syntax described
12801 * Editing source code:: Language major-mode editing
12802 * Exporting code blocks:: Export contents and/or results
12803 * Extracting source code:: Create pure source code files
12804 * Evaluating code blocks:: Place results of evaluation in the Org mode buffer
12805 * Library of Babel:: Use and contribute to a library of useful code blocks
12806 * Languages:: List of supported code block languages
12807 * Header arguments:: Configure code block functionality
12808 * Results of evaluation:: How evaluation results are handled
12809 * Noweb reference syntax:: Literate programming in Org mode
12810 * Key bindings and useful functions:: Work quickly with code blocks
12811 * Batch execution:: Call functions from the command line
12814 @comment node-name, next, previous, up
12815 @comment Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
12817 @node Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
12818 @section Structure of code blocks
12819 @cindex code block, structure
12820 @cindex source code, block structure
12822 @cindex #+BEGIN_SRC
12824 Live code blocks can be specified with a @samp{src} block or
12825 inline.@footnote{Note that @samp{src} blocks may be inserted using Org mode's
12826 @ref{Easy Templates} system} The structure of a @samp{src} block is
12830 #+BEGIN_SRC <language> <switches> <header arguments>
12835 The @code{#+NAME:} line is optional, and can be used to name the code
12836 block. Live code blocks require that a language be specified on the
12837 @code{#+BEGIN_SRC} line. Switches and header arguments are optional.
12838 @cindex source code, inline
12840 Live code blocks can also be specified inline using
12843 src_<language>@{<body>@}
12849 src_<language>[<header arguments>]@{<body>@}
12853 @item <#+NAME: name>
12854 This line associates a name with the code block. This is similar to the
12855 @code{#+NAME: Name} lines that can be used to name tables in Org mode
12856 files. Referencing the name of a code block makes it possible to evaluate
12857 the block from other places in the file, from other files, or from Org mode
12858 table formulas (see @ref{The spreadsheet}). Names are assumed to be unique
12859 and the behavior of Org mode when two or more blocks share the same name is
12863 The language of the code in the block (see @ref{Languages}).
12864 @cindex source code, language
12866 Optional switches control code block export (see the discussion of switches in
12867 @ref{Literal examples})
12868 @cindex source code, switches
12869 @item <header arguments>
12870 Optional header arguments control many aspects of evaluation, export and
12871 tangling of code blocks (see @ref{Header arguments}).
12872 Header arguments can also be set on a per-buffer or per-subtree
12873 basis using properties.
12874 @item source code, header arguments
12876 Source code in the specified language.
12879 @comment node-name, next, previous, up
12880 @comment Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
12882 @node Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
12883 @section Editing source code
12884 @cindex code block, editing
12885 @cindex source code, editing
12888 Use @kbd{C-c '} to edit the current code block. This brings up
12889 a language major-mode edit buffer containing the body of the code
12890 block. Saving this buffer will write the new contents back to the Org
12891 buffer. Use @kbd{C-c '} again to exit.
12893 The @code{org-src-mode} minor mode will be active in the edit buffer. The
12894 following variables can be used to configure the behavior of the edit
12895 buffer. See also the customization group @code{org-edit-structure} for
12896 further configuration options.
12899 @item org-src-lang-modes
12900 If an Emacs major-mode named @code{<lang>-mode} exists, where
12901 @code{<lang>} is the language named in the header line of the code block,
12902 then the edit buffer will be placed in that major-mode. This variable
12903 can be used to map arbitrary language names to existing major modes.
12904 @item org-src-window-setup
12905 Controls the way Emacs windows are rearranged when the edit buffer is created.
12906 @item org-src-preserve-indentation
12907 This variable is especially useful for tangling languages such as
12908 Python, in which whitespace indentation in the output is critical.
12909 @item org-src-ask-before-returning-to-edit-buffer
12910 By default, Org will ask before returning to an open edit buffer. Set this
12911 variable to nil to switch without asking.
12914 To turn on native code fontification in the @emph{Org} buffer, configure the
12915 variable @code{org-src-fontify-natively}.
12917 @comment node-name, next, previous, up
12918 @comment Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
12920 @node Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
12921 @section Exporting code blocks
12922 @cindex code block, exporting
12923 @cindex source code, exporting
12925 It is possible to export the @emph{code} of code blocks, the @emph{results}
12926 of code block evaluation, @emph{both} the code and the results of code block
12927 evaluation, or @emph{none}. For most languages, the default exports code.
12928 However, for some languages (e.g., @code{ditaa}) the default exports the
12929 results of code block evaluation. For information on exporting code block
12930 bodies, see @ref{Literal examples}.
12932 The @code{:exports} header argument can be used to specify export
12935 @subsubheading Header arguments:
12938 @item :exports code
12939 The default in most languages. The body of the code block is exported, as
12940 described in @ref{Literal examples}.
12941 @item :exports results
12942 The code block will be evaluated and the results will be placed in the
12943 Org mode buffer for export, either updating previous results of the code
12944 block located anywhere in the buffer or, if no previous results exist,
12945 placing the results immediately after the code block. The body of the code
12946 block will not be exported.
12947 @item :exports both
12948 Both the code block and its results will be exported.
12949 @item :exports none
12950 Neither the code block nor its results will be exported.
12953 It is possible to inhibit the evaluation of code blocks during export.
12954 Setting the @code{org-export-babel-evaluate} variable to @code{nil} will
12955 ensure that no code blocks are evaluated as part of the export process. This
12956 can be useful in situations where potentially untrusted Org mode files are
12957 exported in an automated fashion, for example when Org mode is used as the
12958 markup language for a wiki.
12960 @comment node-name, next, previous, up
12961 @comment Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
12962 @node Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
12963 @section Extracting source code
12965 @cindex source code, extracting
12966 @cindex code block, extracting source code
12968 Creating pure source code files by extracting code from source blocks is
12969 referred to as ``tangling''---a term adopted from the literate programming
12970 community. During ``tangling'' of code blocks their bodies are expanded
12971 using @code{org-babel-expand-src-block} which can expand both variable and
12972 ``noweb'' style references (see @ref{Noweb reference syntax}).
12974 @subsubheading Header arguments
12978 The default. The code block is not included in the tangled output.
12980 Include the code block in the tangled output. The output file name is the
12981 name of the org file with the extension @samp{.org} replaced by the extension
12982 for the block language.
12983 @item :tangle filename
12984 Include the code block in the tangled output to file @samp{filename}.
12988 @subsubheading Functions
12991 @item org-babel-tangle
12992 Tangle the current file. Bound to @kbd{C-c C-v t}.
12994 With prefix argument only tangle the current code block.
12995 @item org-babel-tangle-file
12996 Choose a file to tangle. Bound to @kbd{C-c C-v f}.
12999 @subsubheading Hooks
13002 @item org-babel-post-tangle-hook
13003 This hook is run from within code files tangled by @code{org-babel-tangle}.
13004 Example applications could include post-processing, compilation or evaluation
13005 of tangled code files.
13008 @node Evaluating code blocks, Library of Babel, Extracting source code, Working With Source Code
13009 @section Evaluating code blocks
13010 @cindex code block, evaluating
13011 @cindex source code, evaluating
13014 Code blocks can be evaluated@footnote{Whenever code is evaluated there is a
13015 potential for that code to do harm. Org mode provides safeguards to ensure
13016 that code is only evaluated after explicit confirmation from the user. For
13017 information on these safeguards (and on how to disable them) see @ref{Code
13018 evaluation security}.} and the results of evaluation optionally placed in the
13019 Org mode buffer. The results of evaluation are placed following a line that
13020 begins by default with @code{#+RESULTS} and optionally a cache identifier
13021 and/or the name of the evaluated code block. The default value of
13022 @code{#+RESULTS} can be changed with the customizable variable
13023 @code{org-babel-results-keyword}.
13025 By default, the evaluation facility is only enabled for Lisp code blocks
13026 specified as @code{emacs-lisp}. However, source code blocks in many languages
13027 can be evaluated within Org mode (see @ref{Languages} for a list of supported
13028 languages and @ref{Structure of code blocks} for information on the syntax
13029 used to define a code block).
13032 There are a number of ways to evaluate code blocks. The simplest is to press
13033 @kbd{C-c C-c} or @kbd{C-c C-v e} with the point on a code block@footnote{The
13034 @code{org-babel-no-eval-on-ctrl-c-ctrl-c} variable can be used to remove code
13035 evaluation from the @kbd{C-c C-c} key binding.}. This will call the
13036 @code{org-babel-execute-src-block} function to evaluate the block and insert
13037 its results into the Org mode buffer.
13040 It is also possible to evaluate named code blocks from anywhere in an Org
13041 mode buffer or an Org mode table. Live code blocks located in the current
13042 Org mode buffer or in the ``Library of Babel'' (see @ref{Library of Babel})
13043 can be executed. Named code blocks can be executed with a separate
13044 @code{#+CALL:} line or inline within a block of text.
13046 The syntax of the @code{#+CALL:} line is
13049 #+CALL: <name>(<arguments>)
13050 #+CALL: <name>[<inside header arguments>](<arguments>) <end header arguments>
13053 The syntax for inline evaluation of named code blocks is
13056 ... call_<name>(<arguments>) ...
13057 ... call_<name>[<inside header arguments>](<arguments>)[<end header arguments>] ...
13062 The name of the code block to be evaluated (see @ref{Structure of code blocks}).
13064 Arguments specified in this section will be passed to the code block. These
13065 arguments use standard function call syntax, rather than
13066 header argument syntax. For example, a @code{#+CALL:} line that passes the
13067 number four to a code block named @code{double}, which declares the header
13068 argument @code{:var n=2}, would be written as @code{#+CALL: double(n=4)}.
13069 @item <inside header arguments>
13070 Inside header arguments are passed through and applied to the named code
13071 block. These arguments use header argument syntax rather than standard
13072 function call syntax. Inside header arguments affect how the code block is
13073 evaluated. For example, @code{[:results output]} will collect the results of
13074 everything printed to @code{STDOUT} during execution of the code block.
13075 @item <end header arguments>
13076 End header arguments are applied to the calling instance and do not affect
13077 evaluation of the named code block. They affect how the results are
13078 incorporated into the Org mode buffer and how the call line is exported. For
13079 example, @code{:results html} will insert the results of the call line
13080 evaluation in the Org buffer, wrapped in a @code{BEGIN_HTML:} block.
13082 For more examples of passing header arguments to @code{#+CALL:} lines see
13083 @ref{Header arguments in function calls}.
13086 @node Library of Babel, Languages, Evaluating code blocks, Working With Source Code
13087 @section Library of Babel
13088 @cindex babel, library of
13089 @cindex source code, library
13090 @cindex code block, library
13092 The ``Library of Babel'' consists of code blocks that can be called from any
13093 Org mode file. Code blocks defined in the ``Library of Babel'' can be called
13094 remotely as if they were in the current Org mode buffer (see @ref{Evaluating
13095 code blocks} for information on the syntax of remote code block evaluation).
13098 The central repository of code blocks in the ``Library of Babel'' is housed
13099 in an Org mode file located in the @samp{contrib} directory of Org mode.
13101 Users can add code blocks they believe to be generally useful to their
13102 ``Library of Babel.'' The code blocks can be stored in any Org mode file and
13103 then loaded into the library with @code{org-babel-lob-ingest}.
13107 Code blocks located in any Org mode file can be loaded into the ``Library of
13108 Babel'' with the @code{org-babel-lob-ingest} function, bound to @kbd{C-c C-v
13111 @node Languages, Header arguments, Library of Babel, Working With Source Code
13113 @cindex babel, languages
13114 @cindex source code, languages
13115 @cindex code block, languages
13117 Code blocks in the following languages are supported.
13119 @multitable @columnfractions 0.28 0.3 0.22 0.2
13120 @item @b{Language} @tab @b{Identifier} @tab @b{Language} @tab @b{Identifier}
13121 @item Asymptote @tab asymptote @tab Awk @tab awk
13122 @item Emacs Calc @tab calc @tab C @tab C
13123 @item C++ @tab C++ @tab Clojure @tab clojure
13124 @item CSS @tab css @tab ditaa @tab ditaa
13125 @item Graphviz @tab dot @tab Emacs Lisp @tab emacs-lisp
13126 @item gnuplot @tab gnuplot @tab Haskell @tab haskell
13127 @item Java @tab java @tab @tab
13128 @item Javascript @tab js @tab LaTeX @tab latex
13129 @item Ledger @tab ledger @tab Lisp @tab lisp
13130 @item Lilypond @tab lilypond @tab MATLAB @tab matlab
13131 @item Mscgen @tab mscgen @tab Objective Caml @tab ocaml
13132 @item Octave @tab octave @tab Org mode @tab org
13133 @item Oz @tab oz @tab Perl @tab perl
13134 @item Plantuml @tab plantuml @tab Python @tab python
13135 @item R @tab R @tab Ruby @tab ruby
13136 @item Sass @tab sass @tab Scheme @tab scheme
13137 @item GNU Screen @tab screen @tab shell @tab sh
13138 @item SQL @tab sql @tab SQLite @tab sqlite
13141 Language-specific documentation is available for some languages. If
13142 available, it can be found at
13143 @uref{http://orgmode.org/worg/org-contrib/babel/languages.html}.
13145 The @code{org-babel-load-languages} controls which languages are enabled for
13146 evaluation (by default only @code{emacs-lisp} is enabled). This variable can
13147 be set using the customization interface or by adding code like the following
13148 to your emacs configuration.
13151 The following disables @code{emacs-lisp} evaluation and enables evaluation of
13152 @code{R} code blocks.
13156 (org-babel-do-load-languages
13157 'org-babel-load-languages
13158 '((emacs-lisp . nil)
13162 It is also possible to enable support for a language by loading the related
13163 elisp file with @code{require}.
13166 The following adds support for evaluating @code{clojure} code blocks.
13170 (require 'ob-clojure)
13173 @node Header arguments, Results of evaluation, Languages, Working With Source Code
13174 @section Header arguments
13175 @cindex code block, header arguments
13176 @cindex source code, block header arguments
13178 Code block functionality can be configured with header arguments. This
13179 section provides an overview of the use of header arguments, and then
13180 describes each header argument in detail.
13183 * Using header arguments:: Different ways to set header arguments
13184 * Specific header arguments:: List of header arguments
13187 @node Using header arguments, Specific header arguments, Header arguments, Header arguments
13188 @subsection Using header arguments
13190 The values of header arguments can be set in six different ways, each more
13191 specific (and having higher priority) than the last.
13193 * System-wide header arguments:: Set global default values
13194 * Language-specific header arguments:: Set default values by language
13195 * Buffer-wide header arguments:: Set default values for a specific buffer
13196 * Header arguments in Org mode properties:: Set default values for a buffer or heading
13197 * Code block specific header arguments:: The most common way to set values
13198 * Header arguments in function calls:: The most specific level
13202 @node System-wide header arguments, Language-specific header arguments, Using header arguments, Using header arguments
13203 @subsubheading System-wide header arguments
13204 @vindex org-babel-default-header-args
13205 System-wide values of header arguments can be specified by adapting the
13206 @code{org-babel-default-header-args} variable:
13210 :results => "replace"
13216 For example, the following example could be used to set the default value of
13217 @code{:noweb} header arguments to @code{yes}. This would have the effect of
13218 expanding @code{:noweb} references by default when evaluating source code
13222 (setq org-babel-default-header-args
13223 (cons '(:noweb . "yes")
13224 (assq-delete-all :noweb org-babel-default-header-args)))
13227 @node Language-specific header arguments, Buffer-wide header arguments, System-wide header arguments, Using header arguments
13228 @subsubheading Language-specific header arguments
13229 Each language can define its own set of default header arguments. See the
13230 language-specific documentation available online at
13231 @uref{http://orgmode.org/worg/org-contrib/babel}.
13233 @node Buffer-wide header arguments, Header arguments in Org mode properties, Language-specific header arguments, Using header arguments
13234 @subsubheading Buffer-wide header arguments
13235 Buffer-wide header arguments may be specified as properties through the use
13236 of @code{#+PROPERTY:} lines placed anywhere in an Org mode file (see
13237 @ref{Property syntax}).
13239 For example the following would set @code{session} to @code{*R*}, and
13240 @code{results} to @code{silent} for every code block in the buffer, ensuring
13241 that all execution took place in the same session, and no results would be
13242 inserted into the buffer.
13245 #+PROPERTY: session *R*
13246 #+PROPERTY: results silent
13249 @node Header arguments in Org mode properties, Code block specific header arguments, Buffer-wide header arguments, Using header arguments
13250 @subsubheading Header arguments in Org mode properties
13252 Header arguments are also read from Org mode properties (see @ref{Property
13253 syntax}), which can be set on a buffer-wide or per-heading basis. An example
13254 of setting a header argument for all code blocks in a buffer is
13257 #+PROPERTY: tangle yes
13260 @vindex org-use-property-inheritance
13261 When properties are used to set default header arguments, they are looked up
13262 with inheritance, regardless of the value of
13263 @code{org-use-property-inheritance}. In the following example the value of
13264 the @code{:cache} header argument will default to @code{yes} in all code
13265 blocks in the subtree rooted at the following heading:
13275 @vindex org-babel-default-header-args
13276 Properties defined in this way override the properties set in
13277 @code{org-babel-default-header-args}. It is convenient to use the
13278 @code{org-set-property} function bound to @kbd{C-c C-x p} to set properties
13279 in Org mode documents.
13281 @node Code block specific header arguments, Header arguments in function calls, Header arguments in Org mode properties, Using header arguments
13282 @subsubheading Code block specific header arguments
13284 The most common way to assign values to header arguments is at the
13285 code block level. This can be done by listing a sequence of header
13286 arguments and their values as part of the @code{#+BEGIN_SRC} line.
13287 Properties set in this way override both the values of
13288 @code{org-babel-default-header-args} and header arguments specified as
13289 properties. In the following example, the @code{:results} header argument
13290 is set to @code{silent}, meaning the results of execution will not be
13291 inserted in the buffer, and the @code{:exports} header argument is set to
13292 @code{code}, meaning only the body of the code block will be
13293 preserved on export to HTML or @LaTeX{}.
13297 #+BEGIN_SRC haskell :results silent :exports code :var n=0
13299 fac n = n * fac (n-1)
13302 Similarly, it is possible to set header arguments for inline code blocks
13305 src_haskell[:exports both]@{fac 5@}
13308 Code block header arguments can span multiple lines using @code{#+HEADER:} or
13309 @code{#+HEADERS:} lines preceding a code block or nested between the
13310 @code{#+NAME:} line and the @code{#+BEGIN_SRC} line of a named code block.
13314 Multi-line header arguments on an un-named code block:
13317 #+HEADERS: :var data1=1
13318 #+BEGIN_SRC emacs-lisp :var data2=2
13319 (message "data1:%S, data2:%S" data1 data2)
13326 Multi-line header arguments on a named code block:
13329 #+NAME: named-block
13330 #+HEADER: :var data=2
13331 #+BEGIN_SRC emacs-lisp
13332 (message "data:%S" data)
13335 #+RESULTS: named-block
13339 @node Header arguments in function calls, , Code block specific header arguments, Using header arguments
13340 @comment node-name, next, previous, up
13341 @subsubheading Header arguments in function calls
13343 At the most specific level, header arguments for ``Library of Babel'' or
13344 @code{#+CALL:} lines can be set as shown in the two examples below. For more
13345 information on the structure of @code{#+CALL:} lines see @ref{Evaluating code
13348 The following will apply the @code{:exports results} header argument to the
13349 evaluation of the @code{#+CALL:} line.
13352 #+CALL: factorial(n=5) :exports results
13355 The following will apply the @code{:session special} header argument to the
13356 evaluation of the @code{factorial} code block.
13359 #+CALL: factorial[:session special](n=5)
13362 @node Specific header arguments, , Using header arguments, Header arguments
13363 @subsection Specific header arguments
13364 Header arguments consist of an initial colon followed by the name of the
13365 argument in lowercase letters. The following header arguments are defined:
13368 * var:: Pass arguments to code blocks
13369 * results:: Specify the type of results and how they will
13370 be collected and handled
13371 * file:: Specify a path for file output
13372 * file-desc:: Specify a description for file results
13373 * dir:: Specify the default (possibly remote)
13374 directory for code block execution
13375 * exports:: Export code and/or results
13376 * tangle:: Toggle tangling and specify file name
13377 * mkdirp:: Toggle creation of parent directories of target
13378 files during tangling
13379 * comments:: Toggle insertion of comments in tangled
13381 * padline:: Control insertion of padding lines in tangled
13383 * no-expand:: Turn off variable assignment and noweb
13384 expansion during tangling
13385 * session:: Preserve the state of code evaluation
13386 * noweb:: Toggle expansion of noweb references
13387 * noweb-ref:: Specify block's noweb reference resolution target
13388 * noweb-sep:: String used to separate noweb references
13389 * cache:: Avoid re-evaluating unchanged code blocks
13390 * sep:: Delimiter for writing tabular results outside Org
13391 * hlines:: Handle horizontal lines in tables
13392 * colnames:: Handle column names in tables
13393 * rownames:: Handle row names in tables
13394 * shebang:: Make tangled files executable
13395 * eval:: Limit evaluation of specific code blocks
13396 * wrap:: Mark source block evaluation results
13397 * post:: Post processing of code block results
13400 Additional header arguments are defined on a language-specific basis, see
13403 @node var, results, Specific header arguments, Specific header arguments
13404 @subsubsection @code{:var}
13405 The @code{:var} header argument is used to pass arguments to code blocks.
13406 The specifics of how arguments are included in a code block vary by language;
13407 these are addressed in the language-specific documentation. However, the
13408 syntax used to specify arguments is the same across all languages. In every
13409 case, variables require a default value when they are declared.
13411 The values passed to arguments can either be literal values, references, or
13412 Emacs Lisp code (see @ref{var, Emacs Lisp evaluation of variables}).
13413 References include anything in the Org mode file that takes a @code{#+NAME:}
13414 or @code{#+RESULTS:} line: tables, lists, @code{#+BEGIN_EXAMPLE} blocks,
13415 other code blocks and the results of other code blocks.
13417 Note: When a reference is made to another code block, the referenced block
13418 will be evaluated unless it has current cached results (see @ref{cache}).
13420 Argument values can be indexed in a manner similar to arrays (see @ref{var,
13421 Indexable variable values}).
13423 The following syntax is used to pass arguments to code blocks using the
13424 @code{:var} header argument.
13430 The argument, @code{assign}, can either be a literal value, such as a string
13431 @samp{"string"} or a number @samp{9}, or a reference to a table, a list, a
13432 literal example, another code block (with or without arguments), or the
13433 results of evaluating another code block.
13435 Here are examples of passing values by reference:
13440 an Org mode table named with either a @code{#+NAME:} line
13443 #+NAME: example-table
13449 #+NAME: table-length
13450 #+BEGIN_SRC emacs-lisp :var table=example-table
13454 #+RESULTS: table-length
13459 a simple list named with a @code{#+NAME:} line (note that nesting is not
13460 carried through to the source code block)
13463 #+NAME: example-list
13469 #+BEGIN_SRC emacs-lisp :var x=example-list
13477 @item code block without arguments
13478 a code block name (from the example above), as assigned by @code{#+NAME:},
13479 optionally followed by parentheses
13482 #+BEGIN_SRC emacs-lisp :var length=table-length()
13490 @item code block with arguments
13491 a code block name, as assigned by @code{#+NAME:}, followed by parentheses and
13492 optional arguments passed within the parentheses following the
13493 code block name using standard function call syntax
13497 #+BEGIN_SRC emacs-lisp :var input=8
13505 #+BEGIN_SRC emacs-lisp :var input=double(input=1)
13513 @item literal example
13514 a literal example block named with a @code{#+NAME:} line
13517 #+NAME: literal-example
13523 #+NAME: read-literal-example
13524 #+BEGIN_SRC emacs-lisp :var x=literal-example
13525 (concatenate 'string x " for you.")
13528 #+RESULTS: read-literal-example
13529 : A literal example
13530 : on two lines for you.
13536 @subsubheading Indexable variable values
13537 It is possible to reference portions of variable values by ``indexing'' into
13538 the variables. Indexes are 0 based with negative values counting back from
13539 the end. If an index is separated by @code{,}s then each subsequent section
13540 will index into the next deepest nesting or dimension of the value. Note
13541 that this indexing occurs @emph{before} other table related header arguments
13542 like @code{:hlines}, @code{:colnames} and @code{:rownames} are applied. The
13543 following example assigns the last cell of the first row the table
13544 @code{example-table} to the variable @code{data}:
13547 #+NAME: example-table
13553 #+BEGIN_SRC emacs-lisp :var data=example-table[0,-1]
13561 Ranges of variable values can be referenced using two integers separated by a
13562 @code{:}, in which case the entire inclusive range is referenced. For
13563 example the following assigns the middle three rows of @code{example-table}
13567 #+NAME: example-table
13574 #+BEGIN_SRC emacs-lisp :var data=example-table[1:3]
13584 Additionally, an empty index, or the single character @code{*}, are both
13585 interpreted to mean the entire range and as such are equivalent to
13586 @code{0:-1}, as shown in the following example in which the entire first
13587 column is referenced.
13590 #+NAME: example-table
13596 #+BEGIN_SRC emacs-lisp :var data=example-table[,0]
13604 It is possible to index into the results of code blocks as well as tables.
13605 Any number of dimensions can be indexed. Dimensions are separated from one
13606 another by commas, as shown in the following example.
13610 #+BEGIN_SRC emacs-lisp
13611 '(((1 2 3) (4 5 6) (7 8 9))
13612 ((10 11 12) (13 14 15) (16 17 18))
13613 ((19 20 21) (22 23 24) (25 26 27)))
13616 #+BEGIN_SRC emacs-lisp :var data=3D[1,,1]
13624 @subsubheading Emacs Lisp evaluation of variables
13626 Emacs lisp code can be used to initialize variable values. When a variable
13627 value starts with @code{(}, @code{[}, @code{'} or @code{`} it will be
13628 evaluated as Emacs Lisp and the result of the evaluation will be assigned as
13629 the variable value. The following example demonstrates use of this
13630 evaluation to reliably pass the file-name of the Org mode buffer to a code
13631 block---note that evaluation of header arguments is guaranteed to take place
13632 in the original Org mode file, while there is no such guarantee for
13633 evaluation of the code block body.
13636 #+BEGIN_SRC sh :var filename=(buffer-file-name) :exports both
13641 Note that values read from tables and lists will not be evaluated as
13642 Emacs Lisp, as shown in the following example.
13648 #+HEADERS: :var data=table[0,0]
13657 @node results, file, var, Specific header arguments
13658 @subsubsection @code{:results}
13660 There are four classes of @code{:results} header argument. Only one option
13661 per class may be supplied per code block.
13665 @b{collection} header arguments specify how the results should be collected
13666 from the code block
13668 @b{type} header arguments specify what type of result the code block will
13669 return---which has implications for how they will be processed before
13670 insertion into the Org mode buffer
13672 @b{format} header arguments specify what type of result the code block will
13673 return---which has implications for how they will be inserted into the
13676 @b{handling} header arguments specify how the results of evaluating the code
13677 block should be handled.
13680 @subsubheading Collection
13681 The following options are mutually exclusive, and specify how the results
13682 should be collected from the code block.
13686 This is the default. The result is the value of the last statement in the
13687 code block. This header argument places the evaluation in functional
13688 mode. Note that in some languages, e.g., Python, use of this result type
13689 requires that a @code{return} statement be included in the body of the source
13690 code block. E.g., @code{:results value}.
13691 @item @code{output}
13692 The result is the collection of everything printed to STDOUT during the
13693 execution of the code block. This header argument places the
13694 evaluation in scripting mode. E.g., @code{:results output}.
13697 @subsubheading Type
13699 The following options are mutually exclusive and specify what type of results
13700 the code block will return. By default, results are inserted as either a
13701 table or scalar depending on their value.
13704 @item @code{table}, @code{vector}
13705 The results should be interpreted as an Org mode table. If a single value is
13706 returned, it will be converted into a table with one row and one column.
13707 E.g., @code{:results value table}.
13709 The results should be interpreted as an Org mode list. If a single scalar
13710 value is returned it will be converted into a list with only one element.
13711 @item @code{scalar}, @code{verbatim}
13712 The results should be interpreted literally---they will not be
13713 converted into a table. The results will be inserted into the Org mode
13714 buffer as quoted text. E.g., @code{:results value verbatim}.
13716 The results will be interpreted as the path to a file, and will be inserted
13717 into the Org mode buffer as a file link. E.g., @code{:results value file}.
13720 @subsubheading Format
13722 The following options are mutually exclusive and specify what type of results
13723 the code block will return. By default, results are inserted according to the
13724 type as specified above.
13728 The results are interpreted as raw Org mode code and are inserted directly
13729 into the buffer. If the results look like a table they will be aligned as
13730 such by Org mode. E.g., @code{:results value raw}.
13732 The results are will be enclosed in a @code{BEGIN_SRC org} block.
13733 They are not comma-escaped by default but they will be if you hit @kbd{TAB}
13734 in the block and/or if you export the file. E.g., @code{:results value org}.
13736 Results are assumed to be HTML and will be enclosed in a @code{BEGIN_HTML}
13737 block. E.g., @code{:results value html}.
13739 Results assumed to be @LaTeX{} and are enclosed in a @code{BEGIN_LaTeX} block.
13740 E.g., @code{:results value latex}.
13742 Result are assumed to be parsable code and are enclosed in a code block.
13743 E.g., @code{:results value code}.
13745 The result is converted to pretty-printed code and is enclosed in a code
13746 block. This option currently supports Emacs Lisp, Python, and Ruby. E.g.,
13747 @code{:results value pp}.
13748 @item @code{drawer}
13749 The result is wrapped in a RESULTS drawer. This can be useful for
13750 inserting @code{raw} or @code{org} syntax results in such a way that their
13751 extent is known and they can be automatically removed or replaced.
13754 @subsubheading Handling
13755 The following results options indicate what happens with the
13756 results once they are collected.
13759 @item @code{silent}
13760 The results will be echoed in the minibuffer but will not be inserted into
13761 the Org mode buffer. E.g., @code{:results output silent}.
13762 @item @code{replace}
13763 The default value. Any existing results will be removed, and the new results
13764 will be inserted into the Org mode buffer in their place. E.g.,
13765 @code{:results output replace}.
13766 @item @code{append}
13767 If there are pre-existing results of the code block then the new results will
13768 be appended to the existing results. Otherwise the new results will be
13769 inserted as with @code{replace}.
13770 @item @code{prepend}
13771 If there are pre-existing results of the code block then the new results will
13772 be prepended to the existing results. Otherwise the new results will be
13773 inserted as with @code{replace}.
13776 @node file, file-desc, results, Specific header arguments
13777 @subsubsection @code{:file}
13779 The header argument @code{:file} is used to specify an external file in which
13780 to save code block results. After code block evaluation an Org mode style
13781 @code{[[file:]]} link (see @ref{Link format}) to the file will be inserted
13782 into the Org mode buffer. Some languages including R, gnuplot, dot, and
13783 ditaa provide special handling of the @code{:file} header argument
13784 automatically wrapping the code block body in the boilerplate code required
13785 to save output to the specified file. This is often useful for saving
13786 graphical output of a code block to the specified file.
13788 The argument to @code{:file} should be either a string specifying the path to
13789 a file, or a list of two strings in which case the first element of the list
13790 should be the path to a file and the second a description for the link.
13792 @node file-desc, dir, file, Specific header arguments
13793 @subsubsection @code{:file-desc}
13795 The value of the @code{:file-desc} header argument is used to provide a
13796 description for file code block results which are inserted as Org mode links
13797 (see @ref{Link format}). If the @code{:file-desc} header argument is given
13798 with no value the link path will be placed in both the ``link'' and the
13799 ``description'' portion of the Org mode link.
13801 @node dir, exports, file-desc, Specific header arguments
13802 @subsubsection @code{:dir} and remote execution
13804 While the @code{:file} header argument can be used to specify the path to the
13805 output file, @code{:dir} specifies the default directory during code block
13806 execution. If it is absent, then the directory associated with the current
13807 buffer is used. In other words, supplying @code{:dir path} temporarily has
13808 the same effect as changing the current directory with @kbd{M-x cd path}, and
13809 then not supplying @code{:dir}. Under the surface, @code{:dir} simply sets
13810 the value of the Emacs variable @code{default-directory}.
13812 When using @code{:dir}, you should supply a relative path for file output
13813 (e.g., @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which
13814 case that path will be interpreted relative to the default directory.
13816 In other words, if you want your plot to go into a folder called @file{Work}
13817 in your home directory, you could use
13820 #+BEGIN_SRC R :file myplot.png :dir ~/Work
13821 matplot(matrix(rnorm(100), 10), type="l")
13825 @subsubheading Remote execution
13826 A directory on a remote machine can be specified using tramp file syntax, in
13827 which case the code will be evaluated on the remote machine. An example is
13830 #+BEGIN_SRC R :file plot.png :dir /dand@@yakuba.princeton.edu:
13831 plot(1:10, main=system("hostname", intern=TRUE))
13835 Text results will be returned to the local Org mode buffer as usual, and file
13836 output will be created on the remote machine with relative paths interpreted
13837 relative to the remote directory. An Org mode link to the remote file will be
13840 So, in the above example a plot will be created on the remote machine,
13841 and a link of the following form will be inserted in the org buffer:
13844 [[file:/scp:dand@@yakuba.princeton.edu:/home/dand/plot.png][plot.png]]
13847 Most of this functionality follows immediately from the fact that @code{:dir}
13848 sets the value of the Emacs variable @code{default-directory}, thanks to
13849 tramp. Those using XEmacs, or GNU Emacs prior to version 23 may need to
13850 install tramp separately in order for these features to work correctly.
13852 @subsubheading Further points
13856 If @code{:dir} is used in conjunction with @code{:session}, although it will
13857 determine the starting directory for a new session as expected, no attempt is
13858 currently made to alter the directory associated with an existing session.
13860 @code{:dir} should typically not be used to create files during export with
13861 @code{:exports results} or @code{:exports both}. The reason is that, in order
13862 to retain portability of exported material between machines, during export
13863 links inserted into the buffer will @emph{not} be expanded against @code{default
13864 directory}. Therefore, if @code{default-directory} is altered using
13865 @code{:dir}, it is probable that the file will be created in a location to
13866 which the link does not point.
13869 @node exports, tangle, dir, Specific header arguments
13870 @subsubsection @code{:exports}
13872 The @code{:exports} header argument specifies what should be included in HTML
13873 or @LaTeX{} exports of the Org mode file.
13877 The default. The body of code is included into the exported file. E.g.,
13878 @code{:exports code}.
13879 @item @code{results}
13880 The result of evaluating the code is included in the exported file. E.g.,
13881 @code{:exports results}.
13883 Both the code and results are included in the exported file. E.g.,
13884 @code{:exports both}.
13886 Nothing is included in the exported file. E.g., @code{:exports none}.
13889 @node tangle, mkdirp, exports, Specific header arguments
13890 @subsubsection @code{:tangle}
13892 The @code{:tangle} header argument specifies whether or not the code
13893 block should be included in tangled extraction of source code files.
13896 @item @code{tangle}
13897 The code block is exported to a source code file named after the full path
13898 (including the directory) and file name (w/o extension) of the Org mode file.
13899 E.g., @code{:tangle yes}.
13901 The default. The code block is not exported to a source code file.
13902 E.g., @code{:tangle no}.
13904 Any other string passed to the @code{:tangle} header argument is interpreted
13905 as a path (directory and file name relative to the directory of the Org mode
13906 file) to which the block will be exported. E.g., @code{:tangle path}.
13909 @node mkdirp, comments, tangle, Specific header arguments
13910 @subsubsection @code{:mkdirp}
13912 The @code{:mkdirp} header argument can be used to create parent directories
13913 of tangled files when missing. This can be set to @code{yes} to enable
13914 directory creation or to @code{no} to inhibit directory creation.
13916 @node comments, padline, mkdirp, Specific header arguments
13917 @subsubsection @code{:comments}
13918 By default code blocks are tangled to source-code files without any insertion
13919 of comments beyond those which may already exist in the body of the code
13920 block. The @code{:comments} header argument can be set as follows to control
13921 the insertion of extra comments into the tangled code file.
13925 The default. No extra comments are inserted during tangling.
13927 The code block is wrapped in comments which contain pointers back to the
13928 original Org file from which the code was tangled.
13930 A synonym for ``link'' to maintain backwards compatibility.
13932 Include text from the Org mode file as a comment.
13933 The text is picked from the leading context of the tangled code and is
13934 limited by the nearest headline or source block as the case may be.
13936 Turns on both the ``link'' and ``org'' comment options.
13938 Turns on the ``link'' comment option, and additionally wraps expanded noweb
13939 references in the code block body in link comments.
13942 @node padline, no-expand, comments, Specific header arguments
13943 @subsubsection @code{:padline}
13944 Control in insertion of padding lines around code block bodies in tangled
13945 code files. The default value is @code{yes} which results in insertion of
13946 newlines before and after each tangled code block. The following arguments
13951 Insert newlines before and after each code block body in tangled code files.
13953 Do not insert any newline padding in tangled output.
13956 @node no-expand, session, padline, Specific header arguments
13957 @subsubsection @code{:no-expand}
13959 By default, code blocks are expanded with @code{org-babel-expand-src-block}
13960 during tangling. This has the effect of assigning values to variables
13961 specified with @code{:var} (see @ref{var}), and of replacing ``noweb''
13962 references (see @ref{Noweb reference syntax}) with their targets. The
13963 @code{:no-expand} header argument can be used to turn off this behavior.
13965 @node session, noweb, no-expand, Specific header arguments
13966 @subsubsection @code{:session}
13968 The @code{:session} header argument starts a session for an interpreted
13969 language where state is preserved.
13971 By default, a session is not started.
13973 A string passed to the @code{:session} header argument will give the session
13974 a name. This makes it possible to run concurrent sessions for each
13975 interpreted language.
13977 @node noweb, noweb-ref, session, Specific header arguments
13978 @subsubsection @code{:noweb}
13980 The @code{:noweb} header argument controls expansion of ``noweb'' syntax
13981 references (see @ref{Noweb reference syntax}) when the code block is
13982 evaluated, tangled, or exported. The @code{:noweb} header argument can have
13983 one of the five values: @code{no}, @code{yes}, @code{tangle}, or
13984 @code{no-export} @code{strip-export}.
13988 The default. ``Noweb'' syntax references in the body of the code block will
13989 not be expanded before the code block is evaluated, tangled or exported.
13991 ``Noweb'' syntax references in the body of the code block will be
13992 expanded before the code block is evaluated, tangled or exported.
13993 @item @code{tangle}
13994 ``Noweb'' syntax references in the body of the code block will be expanded
13995 before the code block is tangled. However, ``noweb'' syntax references will
13996 not be expanded when the code block is evaluated or exported.
13997 @item @code{no-export}
13998 ``Noweb'' syntax references in the body of the code block will be expanded
13999 before the block is evaluated or tangled. However, ``noweb'' syntax
14000 references will not be expanded when the code block is exported.
14001 @item @code{strip-export}
14002 ``Noweb'' syntax references in the body of the code block will be expanded
14003 before the block is evaluated or tangled. However, ``noweb'' syntax
14004 references will not be removed when the code block is exported.
14006 ``Noweb'' syntax references in the body of the code block will only be
14007 expanded before the block is evaluated.
14010 @subsubheading Noweb prefix lines
14011 Noweb insertions are now placed behind the line prefix of the
14012 @code{<<reference>>}.
14013 This behavior is illustrated in the following example. Because the
14014 @code{<<example>>} noweb reference appears behind the SQL comment syntax,
14015 each line of the expanded noweb reference will be commented.
14027 -- multi-line body of example
14030 Note that noweb replacement text that does not contain any newlines will not
14031 be affected by this change, so it is still possible to use inline noweb
14034 @node noweb-ref, noweb-sep, noweb, Specific header arguments
14035 @subsubsection @code{:noweb-ref}
14036 When expanding ``noweb'' style references the bodies of all code block with
14037 @emph{either} a block name matching the reference name @emph{or} a
14038 @code{:noweb-ref} header argument matching the reference name will be
14039 concatenated together to form the replacement text.
14041 By setting this header argument at the sub-tree or file level, simple code
14042 block concatenation may be achieved. For example, when tangling the
14043 following Org mode file, the bodies of code blocks will be concatenated into
14044 the resulting pure code file@footnote{(The example needs property inheritance
14045 to be turned on for the @code{noweb-ref} property, see @ref{Property
14049 #+BEGIN_SRC sh :tangle yes :noweb yes :shebang #!/bin/sh
14052 * the mount point of the fullest disk
14054 :noweb-ref: fullest-disk
14057 ** query all mounted disks
14062 ** strip the header row
14067 ** sort by the percent full
14069 |awk '@{print $5 " " $6@}'|sort -n |tail -1 \
14072 ** extract the mount point
14074 |awk '@{print $2@}'
14078 The @code{:noweb-sep} (see @ref{noweb-sep}) header argument holds the string
14079 used to separate accumulate noweb references like those above. By default a
14082 @node noweb-sep, cache, noweb-ref, Specific header arguments
14083 @subsubsection @code{:noweb-sep}
14085 The @code{:noweb-sep} header argument holds the string used to separate
14086 accumulate noweb references (see @ref{noweb-ref}). By default a newline is
14089 @node cache, sep, noweb-sep, Specific header arguments
14090 @subsubsection @code{:cache}
14092 The @code{:cache} header argument controls the use of in-buffer caching of
14093 the results of evaluating code blocks. It can be used to avoid re-evaluating
14094 unchanged code blocks. Note that the @code{:cache} header argument will not
14095 attempt to cache results when the @code{:session} header argument is used,
14096 because the results of the code block execution may be stored in the session
14097 outside of the Org mode buffer. The @code{:cache} header argument can have
14098 one of two values: @code{yes} or @code{no}.
14102 The default. No caching takes place, and the code block will be evaluated
14103 every time it is called.
14105 Every time the code block is run a SHA1 hash of the code and arguments
14106 passed to the block will be generated. This hash is packed into the
14107 @code{#+RESULTS:} line and will be checked on subsequent
14108 executions of the code block. If the code block has not
14109 changed since the last time it was evaluated, it will not be re-evaluated.
14112 Code block caches notice if the value of a variable argument
14113 to the code block has changed. If this is the case, the cache is
14114 invalidated and the code block is re-run. In the following example,
14115 @code{caller} will not be re-run unless the results of @code{random} have
14116 changed since it was last run.
14120 #+BEGIN_SRC R :cache yes
14124 #+RESULTS[a2a72cd647ad44515fab62e144796432793d68e1]: random
14128 #+BEGIN_SRC emacs-lisp :var x=random :cache yes
14132 #+RESULTS[bec9c8724e397d5df3b696502df3ed7892fc4f5f]: caller
14136 @node sep, hlines, cache, Specific header arguments
14137 @subsubsection @code{:sep}
14139 The @code{:sep} header argument can be used to control the delimiter used
14140 when writing tabular results out to files external to Org mode. This is used
14141 either when opening tabular results of a code block by calling the
14142 @code{org-open-at-point} function bound to @kbd{C-c C-o} on the code block,
14143 or when writing code block results to an external file (see @ref{file})
14146 By default, when @code{:sep} is not specified output tables are tab
14149 @node hlines, colnames, sep, Specific header arguments
14150 @subsubsection @code{:hlines}
14152 Tables are frequently represented with one or more horizontal lines, or
14153 hlines. The @code{:hlines} argument to a code block accepts the
14154 values @code{yes} or @code{no}, with a default value of @code{no}.
14158 Strips horizontal lines from the input table. In most languages this is the
14159 desired effect because an @code{hline} symbol is interpreted as an unbound
14160 variable and raises an error. Setting @code{:hlines no} or relying on the
14161 default value yields the following results.
14172 #+BEGIN_SRC python :var tab=many-cols
14176 #+RESULTS: echo-table
14183 Leaves hlines in the table. Setting @code{:hlines yes} has this effect.
14194 #+BEGIN_SRC python :var tab=many-cols :hlines yes
14198 #+RESULTS: echo-table
14207 @node colnames, rownames, hlines, Specific header arguments
14208 @subsubsection @code{:colnames}
14210 The @code{:colnames} header argument accepts the values @code{yes},
14211 @code{no}, or @code{nil} for unassigned. The default value is @code{nil}.
14212 Note that the behavior of the @code{:colnames} header argument may differ
14217 If an input table looks like it has column names
14218 (because its second row is an hline), then the column
14219 names will be removed from the table before
14220 processing, then reapplied to the results.
14229 #+NAME: echo-table-again
14230 #+BEGIN_SRC python :var tab=less-cols
14231 return [[val + '*' for val in row] for row in tab]
14234 #+RESULTS: echo-table-again
14241 Please note that column names are not removed before the table is indexed
14242 using variable indexing @xref{var, Indexable variable values}.
14245 No column name pre-processing takes place
14248 Column names are removed and reapplied as with @code{nil} even if the table
14249 does not ``look like'' it has column names (i.e., the second row is not an
14253 @node rownames, shebang, colnames, Specific header arguments
14254 @subsubsection @code{:rownames}
14256 The @code{:rownames} header argument can take on the values @code{yes} or
14257 @code{no}, with a default value of @code{no}. Note that Emacs Lisp code
14258 blocks ignore the @code{:rownames} header argument entirely given the ease
14259 with which tables with row names may be handled directly in Emacs Lisp.
14263 No row name pre-processing will take place.
14266 The first column of the table is removed from the table before processing,
14267 and is then reapplied to the results.
14270 #+NAME: with-rownames
14271 | one | 1 | 2 | 3 | 4 | 5 |
14272 | two | 6 | 7 | 8 | 9 | 10 |
14274 #+NAME: echo-table-once-again
14275 #+BEGIN_SRC python :var tab=with-rownames :rownames yes
14276 return [[val + 10 for val in row] for row in tab]
14279 #+RESULTS: echo-table-once-again
14280 | one | 11 | 12 | 13 | 14 | 15 |
14281 | two | 16 | 17 | 18 | 19 | 20 |
14284 Please note that row names are not removed before the table is indexed using
14285 variable indexing @xref{var, Indexable variable values}.
14289 @node shebang, eval, rownames, Specific header arguments
14290 @subsubsection @code{:shebang}
14292 Setting the @code{:shebang} header argument to a string value
14293 (e.g., @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the
14294 first line of any tangled file holding the code block, and the file
14295 permissions of the tangled file are set to make it executable.
14297 @node eval, wrap, shebang, Specific header arguments
14298 @subsubsection @code{:eval}
14299 The @code{:eval} header argument can be used to limit the evaluation of
14300 specific code blocks. The @code{:eval} header argument can be useful for
14301 protecting against the evaluation of dangerous code blocks or to ensure that
14302 evaluation will require a query regardless of the value of the
14303 @code{org-confirm-babel-evaluate} variable. The possible values of
14304 @code{:eval} and their effects are shown below.
14308 The code block will not be evaluated under any circumstances.
14310 Evaluation of the code block will require a query.
14311 @item never-export or no-export
14312 The code block will not be evaluated during export but may still be called
14315 Evaluation of the code block during export will require a query.
14318 If this header argument is not set then evaluation is determined by the value
14319 of the @code{org-confirm-babel-evaluate} variable see @ref{Code evaluation
14322 @node wrap, post, eval, Specific header arguments
14323 @subsubsection @code{:wrap}
14324 The @code{:wrap} header argument is used to mark the results of source block
14325 evaluation. The header argument can be passed a string that will be appended
14326 to @code{#+BEGIN_} and @code{#+END_}, which will then be used to wrap the
14327 results. If not string is specified then the results will be wrapped in a
14328 @code{#+BEGIN/END_RESULTS} block.
14330 @node post, , wrap, Specific header arguments
14331 @subsubsection @code{:post}
14332 The @code{:post} header argument is used to post-process the results of a
14333 code block execution. When a post argument is given, the results of the code
14334 block will temporarily be bound to the @code{*this*} variable. This variable
14335 may then be included in header argument forms such as those used in @ref{var}
14336 header argument specifications allowing passing of results to other code
14337 blocks, or direct execution via Emacs Lisp.
14339 The following example illustrates the usage of the @code{:post} header
14344 #+begin_src sh :var data="" :var width="\\textwidth" :results output
14345 echo "#+ATTR_LATEX :width $width"
14349 #+header: :file /tmp/it.png
14350 #+begin_src dot :post attr_wrap(width="5cm", data=*this*) :results drawer
14360 #+ATTR_LATEX :width 5cm
14361 [[file:/tmp/it.png]]
14365 @node Results of evaluation, Noweb reference syntax, Header arguments, Working With Source Code
14366 @section Results of evaluation
14367 @cindex code block, results of evaluation
14368 @cindex source code, results of evaluation
14370 The way in which results are handled depends on whether a session is invoked,
14371 as well as on whether @code{:results value} or @code{:results output} is
14372 used. The following table shows the table possibilities. For a full listing
14373 of the possible results header arguments see @ref{results}.
14375 @multitable @columnfractions 0.26 0.33 0.41
14376 @item @tab @b{Non-session} @tab @b{Session}
14377 @item @code{:results value} @tab value of last expression @tab value of last expression
14378 @item @code{:results output} @tab contents of STDOUT @tab concatenation of interpreter output
14381 Note: With @code{:results value}, the result in both @code{:session} and
14382 non-session is returned to Org mode as a table (a one- or two-dimensional
14383 vector of strings or numbers) when appropriate.
14385 @subsection Non-session
14386 @subsubsection @code{:results value}
14387 This is the default. Internally, the value is obtained by wrapping the code
14388 in a function definition in the external language, and evaluating that
14389 function. Therefore, code should be written as if it were the body of such a
14390 function. In particular, note that Python does not automatically return a
14391 value from a function unless a @code{return} statement is present, and so a
14392 @samp{return} statement will usually be required in Python.
14394 This is the only one of the four evaluation contexts in which the code is
14395 automatically wrapped in a function definition.
14397 @subsubsection @code{:results output}
14398 The code is passed to the interpreter as an external process, and the
14399 contents of the standard output stream are returned as text. (In certain
14400 languages this also contains the error output stream; this is an area for
14403 @subsection Session
14404 @subsubsection @code{:results value}
14405 The code is passed to an interpreter running as an interactive Emacs inferior
14406 process. Only languages which provide tools for interactive evaluation of
14407 code have session support, so some language (e.g., C and ditaa) do not
14408 support the @code{:session} header argument, and in other languages (e.g.,
14409 Python and Haskell) which have limitations on the code which may be entered
14410 into interactive sessions, those limitations apply to the code in code blocks
14411 using the @code{:session} header argument as well.
14413 Unless the @code{:results output} option is supplied (see below) the result
14414 returned is the result of the last evaluation performed by the
14415 interpreter. (This is obtained in a language-specific manner: the value of
14416 the variable @code{_} in Python and Ruby, and the value of @code{.Last.value}
14419 @subsubsection @code{:results output}
14420 The code is passed to the interpreter running as an interactive Emacs
14421 inferior process. The result returned is the concatenation of the sequence of
14422 (text) output from the interactive interpreter. Notice that this is not
14423 necessarily the same as what would be sent to @code{STDOUT} if the same code
14424 were passed to a non-interactive interpreter running as an external
14425 process. For example, compare the following two blocks:
14428 #+BEGIN_SRC python :results output
14439 In non-session mode, the `2' is not printed and does not appear.
14442 #+BEGIN_SRC python :results output :session
14454 But in @code{:session} mode, the interactive interpreter receives input `2'
14455 and prints out its value, `2'. (Indeed, the other print statements are
14458 @node Noweb reference syntax, Key bindings and useful functions, Results of evaluation, Working With Source Code
14459 @section Noweb reference syntax
14460 @cindex code block, noweb reference
14461 @cindex syntax, noweb
14462 @cindex source code, noweb reference
14464 The ``noweb'' (see @uref{http://www.cs.tufts.edu/~nr/noweb/}) Literate
14465 Programming system allows named blocks of code to be referenced by using the
14466 familiar Noweb syntax:
14469 <<code-block-name>>
14472 When a code block is tangled or evaluated, whether or not ``noweb''
14473 references are expanded depends upon the value of the @code{:noweb} header
14474 argument. If @code{:noweb yes}, then a Noweb reference is expanded before
14475 evaluation. If @code{:noweb no}, the default, then the reference is not
14476 expanded before evaluation. See the @ref{noweb-ref} header argument for
14477 a more flexible way to resolve noweb references.
14479 It is possible to include the @emph{results} of a code block rather than the
14480 body. This is done by appending parenthesis to the code block name which may
14481 optionally contain arguments to the code block as shown below.
14484 <<code-block-name(optional arguments)>>
14487 Note: the default value, @code{:noweb no}, was chosen to ensure that
14488 correct code is not broken in a language, such as Ruby, where
14489 @code{<<arg>>} is a syntactically valid construct. If @code{<<arg>>} is not
14490 syntactically valid in languages that you use, then please consider setting
14493 Note: if noweb tangling is slow in large Org mode files consider setting the
14494 @code{*org-babel-use-quick-and-dirty-noweb-expansion*} variable to true.
14495 This will result in faster noweb reference resolution at the expense of not
14496 correctly resolving inherited values of the @code{:noweb-ref} header
14499 @node Key bindings and useful functions, Batch execution, Noweb reference syntax, Working With Source Code
14500 @section Key bindings and useful functions
14501 @cindex code block, key bindings
14503 Many common Org mode key sequences are re-bound depending on
14506 Within a code block, the following key bindings
14509 @multitable @columnfractions 0.25 0.75
14511 @item @kbd{C-c C-c} @tab @code{org-babel-execute-src-block}
14513 @item @kbd{C-c C-o} @tab @code{org-babel-open-src-block-result}
14515 @item @kbd{C-@key{up}} @tab @code{org-babel-load-in-session}
14517 @item @kbd{M-@key{down}} @tab @code{org-babel-pop-to-session}
14520 In an Org mode buffer, the following key bindings are active:
14522 @multitable @columnfractions 0.45 0.55
14524 @kindex C-c C-v C-p
14525 @item @kbd{C-c C-v p} @ @ @r{or} @ @ @kbd{C-c C-v C-p} @tab @code{org-babel-previous-src-block}
14527 @kindex C-c C-v C-n
14528 @item @kbd{C-c C-v n} @ @ @r{or} @ @ @kbd{C-c C-v C-n} @tab @code{org-babel-next-src-block}
14530 @kindex C-c C-v C-e
14531 @item @kbd{C-c C-v e} @ @ @r{or} @ @ @kbd{C-c C-v C-e} @tab @code{org-babel-execute-maybe}
14533 @kindex C-c C-v C-o
14534 @item @kbd{C-c C-v o} @ @ @r{or} @ @ @kbd{C-c C-v C-o} @tab @code{org-babel-open-src-block-result}
14536 @kindex C-c C-v C-v
14537 @item @kbd{C-c C-v v} @ @ @r{or} @ @ @kbd{C-c C-v C-v} @tab @code{org-babel-expand-src-block}
14539 @kindex C-c C-v C-u
14540 @item @kbd{C-c C-v u} @ @ @r{or} @ @ @kbd{C-c C-v C-u} @tab @code{org-babel-goto-src-block-head}
14542 @kindex C-c C-v C-g
14543 @item @kbd{C-c C-v g} @ @ @r{or} @ @ @kbd{C-c C-v C-g} @tab @code{org-babel-goto-named-src-block}
14545 @kindex C-c C-v C-r
14546 @item @kbd{C-c C-v r} @ @ @r{or} @ @ @kbd{C-c C-v C-r} @tab @code{org-babel-goto-named-result}
14548 @kindex C-c C-v C-b
14549 @item @kbd{C-c C-v b} @ @ @r{or} @ @ @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
14551 @kindex C-c C-v C-s
14552 @item @kbd{C-c C-v s} @ @ @r{or} @ @ @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
14554 @kindex C-c C-v C-d
14555 @item @kbd{C-c C-v d} @ @ @r{or} @ @ @kbd{C-c C-v C-d} @tab @code{org-babel-demarcate-block}
14557 @kindex C-c C-v C-t
14558 @item @kbd{C-c C-v t} @ @ @r{or} @ @ @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
14560 @kindex C-c C-v C-f
14561 @item @kbd{C-c C-v f} @ @ @r{or} @ @ @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
14563 @kindex C-c C-v C-c
14564 @item @kbd{C-c C-v c} @ @ @r{or} @ @ @kbd{C-c C-v C-c} @tab @code{org-babel-check-src-block}
14566 @kindex C-c C-v C-j
14567 @item @kbd{C-c C-v j} @ @ @r{or} @ @ @kbd{C-c C-v C-j} @tab @code{org-babel-insert-header-arg}
14569 @kindex C-c C-v C-l
14570 @item @kbd{C-c C-v l} @ @ @r{or} @ @ @kbd{C-c C-v C-l} @tab @code{org-babel-load-in-session}
14572 @kindex C-c C-v C-i
14573 @item @kbd{C-c C-v i} @ @ @r{or} @ @ @kbd{C-c C-v C-i} @tab @code{org-babel-lob-ingest}
14575 @kindex C-c C-v C-I
14576 @item @kbd{C-c C-v I} @ @ @r{or} @ @ @kbd{C-c C-v C-I} @tab @code{org-babel-view-src-block-info}
14578 @kindex C-c C-v C-z
14579 @item @kbd{C-c C-v z} @ @ @r{or} @ @ @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session-with-code}
14581 @kindex C-c C-v C-a
14582 @item @kbd{C-c C-v a} @ @ @r{or} @ @ @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
14584 @kindex C-c C-v C-h
14585 @item @kbd{C-c C-v h} @ @ @r{or} @ @ @kbd{C-c C-v C-h} @tab @code{org-babel-describe-bindings}
14587 @kindex C-c C-v C-x
14588 @item @kbd{C-c C-v x} @ @ @r{or} @ @ @kbd{C-c C-v C-x} @tab @code{org-babel-do-key-sequence-in-edit-buffer}
14591 @c When possible these keybindings were extended to work when the control key is
14592 @c kept pressed, resulting in the following additional keybindings.
14594 @c @multitable @columnfractions 0.25 0.75
14595 @c @item @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
14596 @c @item @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
14597 @c @item @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
14598 @c @item @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest}
14599 @c @item @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block}
14600 @c @item @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
14601 @c @item @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
14602 @c @item @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session}
14605 @node Batch execution, , Key bindings and useful functions, Working With Source Code
14606 @section Batch execution
14607 @cindex code block, batch execution
14608 @cindex source code, batch execution
14610 It is possible to call functions from the command line. This shell
14611 script calls @code{org-babel-tangle} on every one of its arguments.
14613 Be sure to adjust the paths to fit your system.
14617 # -*- mode: shell-script -*-
14619 # tangle files with org-mode
14624 # wrap each argument in the code required to call tangle on it
14626 FILES="$FILES \"$i\""
14631 (add-to-list 'load-path (expand-file-name \"~/src/org/lisp/\"))
14632 (add-to-list 'load-path (expand-file-name \"~/src/org/contrib/lisp/\" t))
14633 (require 'org)(require 'org-exp)(require 'ob)(require 'ob-tangle)
14634 (mapc (lambda (file)
14635 (find-file (expand-file-name file \"$DIR\"))
14637 (kill-buffer)) '($FILES)))" 2>&1 |grep tangled
14640 @node Miscellaneous, Hacking, Working With Source Code, Top
14641 @chapter Miscellaneous
14644 * Completion:: M-TAB knows what you need
14645 * Easy Templates:: Quick insertion of structural elements
14646 * Speed keys:: Electric commands at the beginning of a headline
14647 * Code evaluation security:: Org mode files evaluate inline code
14648 * Customization:: Adapting Org to your taste
14649 * In-buffer settings:: Overview of the #+KEYWORDS
14650 * The very busy C-c C-c key:: When in doubt, press C-c C-c
14651 * Clean view:: Getting rid of leading stars in the outline
14652 * TTY keys:: Using Org on a tty
14653 * Interaction:: Other Emacs packages
14654 * org-crypt.el:: Encrypting Org files
14658 @node Completion, Easy Templates, Miscellaneous, Miscellaneous
14659 @section Completion
14660 @cindex completion, of @TeX{} symbols
14661 @cindex completion, of TODO keywords
14662 @cindex completion, of dictionary words
14663 @cindex completion, of option keywords
14664 @cindex completion, of tags
14665 @cindex completion, of property keys
14666 @cindex completion, of link abbreviations
14667 @cindex @TeX{} symbol completion
14668 @cindex TODO keywords completion
14669 @cindex dictionary word completion
14670 @cindex option keyword completion
14671 @cindex tag completion
14672 @cindex link abbreviations, completion of
14674 Emacs would not be Emacs without completion, and Org mode uses it whenever it
14675 makes sense. If you prefer an @i{iswitchb}- or @i{ido}-like interface for
14676 some of the completion prompts, you can specify your preference by setting at
14677 most one of the variables @code{org-completion-use-iswitchb}
14678 @code{org-completion-use-ido}.
14680 Org supports in-buffer completion. This type of completion does
14681 not make use of the minibuffer. You simply type a few letters into
14682 the buffer and use the key to complete text right there.
14685 @kindex M-@key{TAB}
14687 Complete word at point
14690 At the beginning of a headline, complete TODO keywords.
14692 After @samp{\}, complete @TeX{} symbols supported by the exporter.
14694 After @samp{*}, complete headlines in the current buffer so that they
14695 can be used in search links like @samp{[[*find this headline]]}.
14697 After @samp{:} in a headline, complete tags. The list of tags is taken
14698 from the variable @code{org-tag-alist} (possibly set through the
14699 @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
14700 dynamically from all tags used in the current buffer.
14702 After @samp{:} and not in a headline, complete property keys. The list
14703 of keys is constructed dynamically from all keys used in the current
14706 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
14708 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
14709 @samp{OPTIONS} which set file-specific options for Org mode. When the
14710 option keyword is already complete, pressing @kbd{M-@key{TAB}} again
14711 will insert example settings for this keyword.
14713 In the line after @samp{#+STARTUP: }, complete startup keywords,
14714 i.e., valid keys for this line.
14716 Elsewhere, complete dictionary words using Ispell.
14720 @node Easy Templates, Speed keys, Completion, Miscellaneous
14721 @section Easy Templates
14722 @cindex template insertion
14723 @cindex insertion, of templates
14725 Org mode supports insertion of empty structural elements (like
14726 @code{#+BEGIN_SRC} and @code{#+END_SRC} pairs) with just a few key
14727 strokes. This is achieved through a native template expansion mechanism.
14728 Note that Emacs has several other template mechanisms which could be used in
14729 a similar way, for example @file{yasnippet}.
14731 To insert a structural element, type a @samp{<}, followed by a template
14732 selector and @kbd{@key{TAB}}. Completion takes effect only when the above
14733 keystrokes are typed on a line by itself.
14735 The following template selectors are currently supported.
14737 @multitable @columnfractions 0.1 0.9
14738 @item @kbd{s} @tab @code{#+BEGIN_SRC ... #+END_SRC}
14739 @item @kbd{e} @tab @code{#+BEGIN_EXAMPLE ... #+END_EXAMPLE}
14740 @item @kbd{q} @tab @code{#+BEGIN_QUOTE ... #+END_QUOTE}
14741 @item @kbd{v} @tab @code{#+BEGIN_VERSE ... #+END_VERSE}
14742 @item @kbd{c} @tab @code{#+BEGIN_CENTER ... #+END_CENTER}
14743 @item @kbd{l} @tab @code{#+BEGIN_LaTeX ... #+END_LaTeX}
14744 @item @kbd{L} @tab @code{#+LaTeX:}
14745 @item @kbd{h} @tab @code{#+BEGIN_HTML ... #+END_HTML}
14746 @item @kbd{H} @tab @code{#+HTML:}
14747 @item @kbd{a} @tab @code{#+BEGIN_ASCII ... #+END_ASCII}
14748 @item @kbd{A} @tab @code{#+ASCII:}
14749 @item @kbd{i} @tab @code{#+INDEX:} line
14750 @item @kbd{I} @tab @code{#+INCLUDE:} line
14753 For example, on an empty line, typing "<e" and then pressing TAB, will expand
14754 into a complete EXAMPLE template.
14756 You can install additional templates by customizing the variable
14757 @code{org-structure-template-alist}. See the docstring of the variable for
14758 additional details.
14760 @node Speed keys, Code evaluation security, Easy Templates, Miscellaneous
14761 @section Speed keys
14763 @vindex org-use-speed-commands
14764 @vindex org-speed-commands-user
14766 Single keys can be made to execute commands when the cursor is at the
14767 beginning of a headline, i.e., before the first star. Configure the variable
14768 @code{org-use-speed-commands} to activate this feature. There is a
14769 pre-defined list of commands, and you can add more such commands using the
14770 variable @code{org-speed-commands-user}. Speed keys do not only speed up
14771 navigation and other commands, but they also provide an alternative way to
14772 execute commands bound to keys that are not or not easily available on a TTY,
14773 or on a small mobile device with a limited keyboard.
14775 To see which commands are available, activate the feature and press @kbd{?}
14776 with the cursor at the beginning of a headline.
14778 @node Code evaluation security, Customization, Speed keys, Miscellaneous
14779 @section Code evaluation and security issues
14781 Org provides tools to work with the code snippets, including evaluating them.
14783 Running code on your machine always comes with a security risk. Badly
14784 written or malicious code can be executed on purpose or by accident. Org has
14785 default settings which will only evaluate such code if you give explicit
14786 permission to do so, and as a casual user of these features you should leave
14787 these precautions intact.
14789 For people who regularly work with such code, the confirmation prompts can
14790 become annoying, and you might want to turn them off. This can be done, but
14791 you must be aware of the risks that are involved.
14793 Code evaluation can happen under the following circumstances:
14796 @item Source code blocks
14797 Source code blocks can be evaluated during export, or when pressing @kbd{C-c
14798 C-c} in the block. The most important thing to realize here is that Org mode
14799 files which contain code snippets are, in a certain sense, like executable
14800 files. So you should accept them and load them into Emacs only from trusted
14801 sources---just like you would do with a program you install on your computer.
14803 Make sure you know what you are doing before customizing the variables
14804 which take off the default security brakes.
14806 @defopt org-confirm-babel-evaluate
14807 When t (the default), the user is asked before every code block evaluation.
14808 When nil, the user is not asked. When set to a function, it is called with
14809 two arguments (language and body of the code block) and should return t to
14810 ask and nil not to ask.
14813 For example, here is how to execute "ditaa" code (which is considered safe)
14817 (defun my-org-confirm-babel-evaluate (lang body)
14818 (not (string= lang "ditaa"))) ; don't ask for ditaa
14819 (setq org-confirm-babel-evaluate 'my-org-confirm-babel-evaluate)
14822 @item Following @code{shell} and @code{elisp} links
14823 Org has two link types that can directly evaluate code (@pxref{External
14824 links}). These links can be problematic because the code to be evaluated is
14827 @defopt org-confirm-shell-link-function
14828 Function to queries user about shell link execution.
14830 @defopt org-confirm-elisp-link-function
14831 Functions to query user for Emacs Lisp link execution.
14834 @item Formulas in tables
14835 Formulas in tables (@pxref{The spreadsheet}) are code that is evaluated
14836 either by the @i{calc} interpreter, or by the @i{Emacs Lisp} interpreter.
14839 @node Customization, In-buffer settings, Code evaluation security, Miscellaneous
14840 @section Customization
14841 @cindex customization
14842 @cindex options, for customization
14843 @cindex variables, for customization
14845 There are more than 500 variables that can be used to customize
14846 Org. For the sake of compactness of the manual, I am not
14847 describing the variables here. A structured overview of customization
14848 variables is available with @kbd{M-x org-customize}. Or select
14849 @code{Browse Org Group} from the @code{Org->Customization} menu. Many
14850 settings can also be activated on a per-file basis, by putting special
14851 lines into the buffer (@pxref{In-buffer settings}).
14853 @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous
14854 @section Summary of in-buffer settings
14855 @cindex in-buffer settings
14856 @cindex special keywords
14858 Org mode uses special lines in the buffer to define settings on a
14859 per-file basis. These lines start with a @samp{#+} followed by a
14860 keyword, a colon, and then individual words defining a setting. Several
14861 setting words can be in the same line, but you can also have multiple
14862 lines for the keyword. While these settings are described throughout
14863 the manual, here is a summary. After changing any of those lines in the
14864 buffer, press @kbd{C-c C-c} with the cursor still in the line to
14865 activate the changes immediately. Otherwise they become effective only
14866 when the file is visited again in a new Emacs session.
14868 @vindex org-archive-location
14870 @item #+ARCHIVE: %s_done::
14871 This line sets the archive location for the agenda file. It applies for
14872 all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
14873 of the file. The first such line also applies to any entries before it.
14874 The corresponding variable is @code{org-archive-location}.
14876 This line sets the category for the agenda file. The category applies
14877 for all subsequent lines until the next @samp{#+CATEGORY} line, or the
14878 end of the file. The first such line also applies to any entries before it.
14879 @item #+COLUMNS: %25ITEM .....
14880 @cindex property, COLUMNS
14881 Set the default format for columns view. This format applies when
14882 columns view is invoked in locations where no @code{COLUMNS} property
14884 @item #+CONSTANTS: name1=value1 ...
14885 @vindex org-table-formula-constants
14886 @vindex org-table-formula
14887 Set file-local values for constants to be used in table formulas. This
14888 line sets the local variable @code{org-table-formula-constants-local}.
14889 The global version of this variable is
14890 @code{org-table-formula-constants}.
14891 @item #+FILETAGS: :tag1:tag2:tag3:
14892 Set tags that can be inherited by any entry in the file, including the
14894 @item #+DRAWERS: NAME1 .....
14895 @vindex org-drawers
14896 Set the file-local set of additional drawers. The corresponding global
14897 variable is @code{org-drawers}.
14898 @item #+LINK: linkword replace
14899 @vindex org-link-abbrev-alist
14900 These lines (several are allowed) specify link abbreviations.
14901 @xref{Link abbreviations}. The corresponding variable is
14902 @code{org-link-abbrev-alist}.
14903 @item #+PRIORITIES: highest lowest default
14904 @vindex org-highest-priority
14905 @vindex org-lowest-priority
14906 @vindex org-default-priority
14907 This line sets the limits and the default for the priorities. All three
14908 must be either letters A--Z or numbers 0--9. The highest priority must
14909 have a lower ASCII number than the lowest priority.
14910 @item #+PROPERTY: Property_Name Value
14911 This line sets a default inheritance value for entries in the current
14912 buffer, most useful for specifying the allowed values of a property.
14913 @cindex #+SETUPFILE
14914 @item #+SETUPFILE: file
14915 This line defines a file that holds more in-buffer setup. Normally this is
14916 entirely ignored. Only when the buffer is parsed for option-setting lines
14917 (i.e., when starting Org mode for a file, when pressing @kbd{C-c C-c} in a
14918 settings line, or when exporting), then the contents of this file are parsed
14919 as if they had been included in the buffer. In particular, the file can be
14920 any other Org mode file with internal setup. You can visit the file the
14921 cursor is in the line with @kbd{C-c '}.
14924 This line sets options to be used at startup of Org mode, when an
14925 Org file is being visited.
14927 The first set of options deals with the initial visibility of the outline
14928 tree. The corresponding variable for global default settings is
14929 @code{org-startup-folded}, with a default value @code{t}, which means
14931 @vindex org-startup-folded
14932 @cindex @code{overview}, STARTUP keyword
14933 @cindex @code{content}, STARTUP keyword
14934 @cindex @code{showall}, STARTUP keyword
14935 @cindex @code{showeverything}, STARTUP keyword
14937 overview @r{top-level headlines only}
14938 content @r{all headlines}
14939 showall @r{no folding of any entries}
14940 showeverything @r{show even drawer contents}
14943 @vindex org-startup-indented
14944 @cindex @code{indent}, STARTUP keyword
14945 @cindex @code{noindent}, STARTUP keyword
14946 Dynamic virtual indentation is controlled by the variable
14947 @code{org-startup-indented}@footnote{Emacs 23 and Org mode 6.29 are required}
14949 indent @r{start with @code{org-indent-mode} turned on}
14950 noindent @r{start with @code{org-indent-mode} turned off}
14953 @vindex org-startup-align-all-tables
14954 Then there are options for aligning tables upon visiting a file. This
14955 is useful in files containing narrowed table columns. The corresponding
14956 variable is @code{org-startup-align-all-tables}, with a default value
14958 @cindex @code{align}, STARTUP keyword
14959 @cindex @code{noalign}, STARTUP keyword
14961 align @r{align all tables}
14962 noalign @r{don't align tables on startup}
14965 @vindex org-startup-with-inline-images
14966 When visiting a file, inline images can be automatically displayed. The
14967 corresponding variable is @code{org-startup-with-inline-images}, with a
14968 default value @code{nil} to avoid delays when visiting a file.
14969 @cindex @code{inlineimages}, STARTUP keyword
14970 @cindex @code{noinlineimages}, STARTUP keyword
14972 inlineimages @r{show inline images}
14973 noinlineimages @r{don't show inline images on startup}
14976 @vindex org-startup-with-latex-preview
14977 When visiting a file, @LaTeX{} fragments can be converted to images
14978 automatically. The variable @code{org-startup-with-latex-preview} which
14979 controls this behavior, is set to @code{nil} by default to avoid delays on
14981 @cindex @code{latexpreview}, STARTUP keyword
14982 @cindex @code{nolatexpreview}, STARTUP keyword
14984 latexpreview @r{preview @LaTeX{} fragments}
14985 nolatexpreview @r{don't preview @LaTeX{} fragments}
14988 @vindex org-log-done
14989 @vindex org-log-note-clock-out
14990 @vindex org-log-repeat
14991 Logging the closing and reopening of TODO items and clock intervals can be
14992 configured using these options (see variables @code{org-log-done},
14993 @code{org-log-note-clock-out} and @code{org-log-repeat})
14994 @cindex @code{logdone}, STARTUP keyword
14995 @cindex @code{lognotedone}, STARTUP keyword
14996 @cindex @code{nologdone}, STARTUP keyword
14997 @cindex @code{lognoteclock-out}, STARTUP keyword
14998 @cindex @code{nolognoteclock-out}, STARTUP keyword
14999 @cindex @code{logrepeat}, STARTUP keyword
15000 @cindex @code{lognoterepeat}, STARTUP keyword
15001 @cindex @code{nologrepeat}, STARTUP keyword
15002 @cindex @code{logreschedule}, STARTUP keyword
15003 @cindex @code{lognotereschedule}, STARTUP keyword
15004 @cindex @code{nologreschedule}, STARTUP keyword
15005 @cindex @code{logredeadline}, STARTUP keyword
15006 @cindex @code{lognoteredeadline}, STARTUP keyword
15007 @cindex @code{nologredeadline}, STARTUP keyword
15008 @cindex @code{logrefile}, STARTUP keyword
15009 @cindex @code{lognoterefile}, STARTUP keyword
15010 @cindex @code{nologrefile}, STARTUP keyword
15011 @cindex @code{logdrawer}, STARTUP keyword
15012 @cindex @code{nologdrawer}, STARTUP keyword
15013 @cindex @code{logstatesreversed}, STARTUP keyword
15014 @cindex @code{nologstatesreversed}, STARTUP keyword
15016 logdone @r{record a timestamp when an item is marked DONE}
15017 lognotedone @r{record timestamp and a note when DONE}
15018 nologdone @r{don't record when items are marked DONE}
15019 logrepeat @r{record a time when reinstating a repeating item}
15020 lognoterepeat @r{record a note when reinstating a repeating item}
15021 nologrepeat @r{do not record when reinstating repeating item}
15022 lognoteclock-out @r{record a note when clocking out}
15023 nolognoteclock-out @r{don't record a note when clocking out}
15024 logreschedule @r{record a timestamp when scheduling time changes}
15025 lognotereschedule @r{record a note when scheduling time changes}
15026 nologreschedule @r{do not record when a scheduling date changes}
15027 logredeadline @r{record a timestamp when deadline changes}
15028 lognoteredeadline @r{record a note when deadline changes}
15029 nologredeadline @r{do not record when a deadline date changes}
15030 logrefile @r{record a timestamp when refiling}
15031 lognoterefile @r{record a note when refiling}
15032 nologrefile @r{do not record when refiling}
15033 logdrawer @r{store log into drawer}
15034 nologdrawer @r{store log outside of drawer}
15035 logstatesreversed @r{reverse the order of states notes}
15036 nologstatesreversed @r{do not reverse the order of states notes}
15039 @vindex org-hide-leading-stars
15040 @vindex org-odd-levels-only
15041 Here are the options for hiding leading stars in outline headings, and for
15042 indenting outlines. The corresponding variables are
15043 @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
15044 default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
15045 @cindex @code{hidestars}, STARTUP keyword
15046 @cindex @code{showstars}, STARTUP keyword
15047 @cindex @code{odd}, STARTUP keyword
15048 @cindex @code{even}, STARTUP keyword
15050 hidestars @r{make all but one of the stars starting a headline invisible.}
15051 showstars @r{show all stars starting a headline}
15052 indent @r{virtual indentation according to outline level}
15053 noindent @r{no virtual indentation according to outline level}
15054 odd @r{allow only odd outline levels (1,3,...)}
15055 oddeven @r{allow all outline levels}
15058 @vindex org-put-time-stamp-overlays
15059 @vindex org-time-stamp-overlay-formats
15060 To turn on custom format overlays over timestamps (variables
15061 @code{org-put-time-stamp-overlays} and
15062 @code{org-time-stamp-overlay-formats}), use
15063 @cindex @code{customtime}, STARTUP keyword
15065 customtime @r{overlay custom time format}
15068 @vindex constants-unit-system
15069 The following options influence the table spreadsheet (variable
15070 @code{constants-unit-system}).
15071 @cindex @code{constcgs}, STARTUP keyword
15072 @cindex @code{constSI}, STARTUP keyword
15074 constcgs @r{@file{constants.el} should use the c-g-s unit system}
15075 constSI @r{@file{constants.el} should use the SI unit system}
15078 @vindex org-footnote-define-inline
15079 @vindex org-footnote-auto-label
15080 @vindex org-footnote-auto-adjust
15081 To influence footnote settings, use the following keywords. The
15082 corresponding variables are @code{org-footnote-define-inline},
15083 @code{org-footnote-auto-label}, and @code{org-footnote-auto-adjust}.
15084 @cindex @code{fninline}, STARTUP keyword
15085 @cindex @code{nofninline}, STARTUP keyword
15086 @cindex @code{fnlocal}, STARTUP keyword
15087 @cindex @code{fnprompt}, STARTUP keyword
15088 @cindex @code{fnauto}, STARTUP keyword
15089 @cindex @code{fnconfirm}, STARTUP keyword
15090 @cindex @code{fnplain}, STARTUP keyword
15091 @cindex @code{fnadjust}, STARTUP keyword
15092 @cindex @code{nofnadjust}, STARTUP keyword
15094 fninline @r{define footnotes inline}
15095 fnnoinline @r{define footnotes in separate section}
15096 fnlocal @r{define footnotes near first reference, but not inline}
15097 fnprompt @r{prompt for footnote labels}
15098 fnauto @r{create @code{[fn:1]}-like labels automatically (default)}
15099 fnconfirm @r{offer automatic label for editing or confirmation}
15100 fnplain @r{create @code{[1]}-like labels automatically}
15101 fnadjust @r{automatically renumber and sort footnotes}
15102 nofnadjust @r{do not renumber and sort automatically}
15105 @cindex org-hide-block-startup
15106 To hide blocks on startup, use these keywords. The corresponding variable is
15107 @code{org-hide-block-startup}.
15108 @cindex @code{hideblocks}, STARTUP keyword
15109 @cindex @code{nohideblocks}, STARTUP keyword
15111 hideblocks @r{Hide all begin/end blocks on startup}
15112 nohideblocks @r{Do not hide blocks on startup}
15115 @cindex org-pretty-entities
15116 The display of entities as UTF-8 characters is governed by the variable
15117 @code{org-pretty-entities} and the keywords
15118 @cindex @code{entitiespretty}, STARTUP keyword
15119 @cindex @code{entitiesplain}, STARTUP keyword
15121 entitiespretty @r{Show entities as UTF-8 characters where possible}
15122 entitiesplain @r{Leave entities plain}
15125 @item #+TAGS: TAG1(c1) TAG2(c2)
15126 @vindex org-tag-alist
15127 These lines (several such lines are allowed) specify the valid tags in
15128 this file, and (potentially) the corresponding @emph{fast tag selection}
15129 keys. The corresponding variable is @code{org-tag-alist}.
15132 This line contains the formulas for the table directly above the line.
15134 Table can have multiple lines containing @samp{#+TBLFM:}. Note
15135 that only the first line of @samp{#+TBLFM:} will be applied when
15136 you recalculate the table. For more details see @ref{Using
15137 multiple #+TBLFM lines} in @ref{Editing and debugging formulas}.
15139 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+DATE:,
15140 @itemx #+OPTIONS:, #+BIND:,
15141 @itemx #+DESCRIPTION:, #+KEYWORDS:,
15142 @itemx #+LaTeX_HEADER:, #+LaTeX_HEADER_EXTRA:,
15143 @itemx #+HTML_HEAD:, #+HTML_LINK_UP:, #+HTML_LINK_HOME:,
15144 @itemx #+SELECT_TAGS:, #+EXCLUDE_TAGS:
15145 These lines provide settings for exporting files. For more details see
15146 @ref{Export settings}.
15147 @item #+TODO: #+SEQ_TODO: #+TYP_TODO:
15148 @vindex org-todo-keywords
15149 These lines set the TODO keywords and their interpretation in the
15150 current file. The corresponding variable is @code{org-todo-keywords}.
15153 @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous
15154 @section The very busy C-c C-c key
15156 @cindex C-c C-c, overview
15158 The key @kbd{C-c C-c} has many purposes in Org, which are all
15159 mentioned scattered throughout this manual. One specific function of
15160 this key is to add @emph{tags} to a headline (@pxref{Tags}). In many
15161 other circumstances it means something like @emph{``Hey Org, look
15162 here and update according to what you see here''}. Here is a summary of
15163 what this means in different contexts.
15167 If there are highlights in the buffer from the creation of a sparse
15168 tree, or from clock display, remove these highlights.
15170 If the cursor is in one of the special @code{#+KEYWORD} lines, this
15171 triggers scanning the buffer for these lines and updating the
15174 If the cursor is inside a table, realign the table. This command
15175 works even if the automatic table editor has been turned off.
15177 If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
15180 If the current buffer is a capture buffer, close the note and file it.
15181 With a prefix argument, file it, without further interaction, to the
15184 If the cursor is on a @code{<<<target>>>}, update radio targets and
15185 corresponding links in this buffer.
15187 If the cursor is in a property line or at the start or end of a property
15188 drawer, offer property commands.
15190 If the cursor is at a footnote reference, go to the corresponding
15191 definition, and @emph{vice versa}.
15193 If the cursor is on a statistics cookie, update it.
15195 If the cursor is in a plain list item with a checkbox, toggle the status
15198 If the cursor is on a numbered item in a plain list, renumber the
15201 If the cursor is on the @code{#+BEGIN} line of a dynamic block, the
15204 If the cursor is at a timestamp, fix the day name in the timestamp.
15207 @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous
15208 @section A cleaner outline view
15209 @cindex hiding leading stars
15210 @cindex dynamic indentation
15211 @cindex odd-levels-only outlines
15212 @cindex clean outline view
15214 Some people find it noisy and distracting that the Org headlines start with a
15215 potentially large number of stars, and that text below the headlines is not
15216 indented. While this is no problem when writing a @emph{book-like} document
15217 where the outline headings are really section headings, in a more
15218 @emph{list-oriented} outline, indented structure is a lot cleaner:
15222 * Top level headline | * Top level headline
15223 ** Second level | * Second level
15224 *** 3rd level | * 3rd level
15225 some text | some text
15226 *** 3rd level | * 3rd level
15227 more text | more text
15228 * Another top level headline | * Another top level headline
15234 If you are using at least Emacs 23.2@footnote{Emacs 23.1 can actually crash
15235 with @code{org-indent-mode}} and version 6.29 of Org, this kind of view can
15236 be achieved dynamically at display time using @code{org-indent-mode}. In
15237 this minor mode, all lines are prefixed for display with the necessary amount
15238 of space@footnote{@code{org-indent-mode} also sets the @code{wrap-prefix}
15239 property, such that @code{visual-line-mode} (or purely setting
15240 @code{word-wrap}) wraps long lines (including headlines) correctly indented.
15241 }. Also headlines are prefixed with additional stars, so that the amount of
15242 indentation shifts by two@footnote{See the variable
15243 @code{org-indent-indentation-per-level}.} spaces per level. All headline
15244 stars but the last one are made invisible using the @code{org-hide}
15245 face@footnote{Turning on @code{org-indent-mode} sets
15246 @code{org-hide-leading-stars} to @code{t} and @code{org-adapt-indentation} to
15247 @code{nil}.}; see below under @samp{2.} for more information on how this
15248 works. You can turn on @code{org-indent-mode} for all files by customizing
15249 the variable @code{org-startup-indented}, or you can turn it on for
15250 individual files using
15256 If you want a similar effect in an earlier version of Emacs and/or Org, or if
15257 you want the indentation to be hard space characters so that the plain text
15258 file looks as similar as possible to the Emacs display, Org supports you in
15263 @emph{Indentation of text below headlines}@*
15264 You may indent text below each headline to make the left boundary line up
15265 with the headline, like
15269 more text, now indented
15272 @vindex org-adapt-indentation
15273 Org supports this with paragraph filling, line wrapping, and structure
15274 editing@footnote{See also the variable @code{org-adapt-indentation}.},
15275 preserving or adapting the indentation as appropriate.
15278 @vindex org-hide-leading-stars
15279 @emph{Hiding leading stars}@* You can modify the display in such a way that
15280 all leading stars become invisible. To do this in a global way, configure
15281 the variable @code{org-hide-leading-stars} or change this on a per-file basis
15285 #+STARTUP: hidestars
15286 #+STARTUP: showstars
15289 With hidden stars, the tree becomes:
15293 * Top level headline
15301 @vindex org-hide @r{(face)}
15302 The leading stars are not truly replaced by whitespace, they are only
15303 fontified with the face @code{org-hide} that uses the background color as
15304 font color. If you are not using either white or black background, you may
15305 have to customize this face to get the wanted effect. Another possibility is
15306 to set this font such that the extra stars are @i{almost} invisible, for
15307 example using the color @code{grey90} on a white background.
15310 @vindex org-odd-levels-only
15311 Things become cleaner still if you skip all the even levels and use only odd
15312 levels 1, 3, 5..., effectively adding two stars to go from one outline level
15313 to the next@footnote{When you need to specify a level for a property search
15314 or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc.}. In this
15315 way we get the outline view shown at the beginning of this section. In order
15316 to make the structure editing and export commands handle this convention
15317 correctly, configure the variable @code{org-odd-levels-only}, or set this on
15318 a per-file basis with one of the following lines:
15325 You can convert an Org file from single-star-per-level to the
15326 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
15327 RET} in that file. The reverse operation is @kbd{M-x
15328 org-convert-to-oddeven-levels}.
15331 @node TTY keys, Interaction, Clean view, Miscellaneous
15332 @section Using Org on a tty
15333 @cindex tty key bindings
15335 Because Org contains a large number of commands, by default many of
15336 Org's core commands are bound to keys that are generally not
15337 accessible on a tty, such as the cursor keys (@key{left}, @key{right},
15338 @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
15339 together with modifiers like @key{Meta} and/or @key{Shift}. To access
15340 these commands on a tty when special keys are unavailable, the following
15341 alternative bindings can be used. The tty bindings below will likely be
15342 more cumbersome; you may find for some of the bindings below that a
15343 customized workaround suits you better. For example, changing a timestamp
15344 is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
15345 tty you would rather use @kbd{C-c .} to re-insert the timestamp.
15347 @multitable @columnfractions 0.15 0.2 0.1 0.2
15348 @item @b{Default} @tab @b{Alternative 1} @tab @b{Speed key} @tab @b{Alternative 2}
15349 @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab @kbd{C} @tab
15350 @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{l} @tab @kbd{@key{Esc} @key{left}}
15351 @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab @kbd{L} @tab
15352 @item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{r} @tab @kbd{@key{Esc} @key{right}}
15353 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab @kbd{R} @tab
15354 @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{ } @tab @kbd{@key{Esc} @key{up}}
15355 @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab @kbd{U} @tab
15356 @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{ } @tab @kbd{@key{Esc} @key{down}}
15357 @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab @kbd{D} @tab
15358 @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab @kbd{ } @tab
15359 @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{ } @tab @kbd{@key{Esc} @key{RET}}
15360 @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab @kbd{ } @tab
15361 @item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab @kbd{ } @tab
15362 @item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab @kbd{ } @tab
15363 @item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab @kbd{ } @tab
15364 @item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab @kbd{ } @tab
15365 @item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab @kbd{ } @tab
15366 @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab @kbd{ } @tab
15370 @node Interaction, org-crypt.el, TTY keys, Miscellaneous
15371 @section Interaction with other packages
15372 @cindex packages, interaction with other
15373 Org lives in the world of GNU Emacs and interacts in various ways
15374 with other code out there.
15377 * Cooperation:: Packages Org cooperates with
15378 * Conflicts:: Packages that lead to conflicts
15381 @node Cooperation, Conflicts, Interaction, Interaction
15382 @subsection Packages that Org cooperates with
15385 @cindex @file{calc.el}
15386 @cindex Gillespie, Dave
15387 @item @file{calc.el} by Dave Gillespie
15388 Org uses the Calc package for implementing spreadsheet
15389 functionality in its tables (@pxref{The spreadsheet}). Org
15390 checks for the availability of Calc by looking for the function
15391 @code{calc-eval} which will have been autoloaded during setup if Calc has
15392 been installed properly. As of Emacs 22, Calc is part of the Emacs
15393 distribution. Another possibility for interaction between the two
15394 packages is using Calc for embedded calculations. @xref{Embedded Mode,
15395 , Embedded Mode, calc, GNU Emacs Calc Manual}.
15396 @item @file{constants.el} by Carsten Dominik
15397 @cindex @file{constants.el}
15398 @cindex Dominik, Carsten
15399 @vindex org-table-formula-constants
15400 In a table formula (@pxref{The spreadsheet}), it is possible to use
15401 names for natural constants or units. Instead of defining your own
15402 constants in the variable @code{org-table-formula-constants}, install
15403 the @file{constants} package which defines a large number of constants
15404 and units, and lets you use unit prefixes like @samp{M} for
15405 @samp{Mega}, etc. You will need version 2.0 of this package, available
15406 at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for
15407 the function @code{constants-get}, which has to be autoloaded in your
15408 setup. See the installation instructions in the file
15409 @file{constants.el}.
15410 @item @file{cdlatex.el} by Carsten Dominik
15411 @cindex @file{cdlatex.el}
15412 @cindex Dominik, Carsten
15413 Org mode can make use of the CD@LaTeX{} package to efficiently enter
15414 @LaTeX{} fragments into Org files. See @ref{CDLaTeX mode}.
15415 @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
15416 @cindex @file{imenu.el}
15417 Imenu allows menu access to an index of items in a file. Org mode
15418 supports Imenu---all you need to do to get the index is the following:
15420 (add-hook 'org-mode-hook
15421 (lambda () (imenu-add-to-menubar "Imenu")))
15423 @vindex org-imenu-depth
15424 By default the index is two levels deep---you can modify the depth using
15425 the option @code{org-imenu-depth}.
15426 @item @file{remember.el} by John Wiegley
15427 @cindex @file{remember.el}
15428 @cindex Wiegley, John
15429 Org used to use this package for capture, but no longer does.
15430 @item @file{speedbar.el} by Eric M. Ludlam
15431 @cindex @file{speedbar.el}
15432 @cindex Ludlam, Eric M.
15433 Speedbar is a package that creates a special frame displaying files and
15434 index items in files. Org mode supports Speedbar and allows you to
15435 drill into Org files directly from the Speedbar. It also allows you to
15436 restrict the scope of agenda commands to a file or a subtree by using
15437 the command @kbd{<} in the Speedbar frame.
15438 @cindex @file{table.el}
15439 @item @file{table.el} by Takaaki Ota
15441 @cindex table editor, @file{table.el}
15442 @cindex @file{table.el}
15443 @cindex Ota, Takaaki
15445 Complex ASCII tables with automatic line wrapping, column- and row-spanning,
15446 and alignment can be created using the Emacs table package by Takaaki Ota
15447 (@uref{http://sourceforge.net/projects/table}, and also part of Emacs 22).
15448 Org mode will recognize these tables and export them properly. Because of
15449 interference with other Org mode functionality, you unfortunately cannot edit
15450 these tables directly in the buffer. Instead, you need to use the command
15451 @kbd{C-c '} to edit them, similar to source code snippets.
15454 @orgcmd{C-c ',org-edit-special}
15455 Edit a @file{table.el} table. Works when the cursor is in a table.el table.
15457 @orgcmd{C-c ~,org-table-create-with-table.el}
15458 Insert a @file{table.el} table. If there is already a table at point, this
15459 command converts it between the @file{table.el} format and the Org mode
15460 format. See the documentation string of the command
15461 @code{org-convert-table} for the restrictions under which this is
15464 @file{table.el} is part of Emacs since Emacs 22.
15465 @item @file{footnote.el} by Steven L. Baur
15466 @cindex @file{footnote.el}
15467 @cindex Baur, Steven L.
15468 Org mode recognizes numerical footnotes as provided by this package.
15469 However, Org mode also has its own footnote support (@pxref{Footnotes}),
15470 which makes using @file{footnote.el} unnecessary.
15473 @node Conflicts, , Cooperation, Interaction
15474 @subsection Packages that lead to conflicts with Org mode
15478 @cindex @code{shift-selection-mode}
15479 @vindex org-support-shift-select
15480 In Emacs 23, @code{shift-selection-mode} is on by default, meaning that
15481 cursor motions combined with the shift key should start or enlarge regions.
15482 This conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change
15483 timestamps, TODO keywords, priorities, and item bullet types if the cursor is
15484 at such a location. By default, @kbd{S-@key{cursor}} commands outside
15485 special contexts don't do anything, but you can customize the variable
15486 @code{org-support-shift-select}. Org mode then tries to accommodate shift
15487 selection by (i) using it outside of the special contexts where special
15488 commands apply, and by (ii) extending an existing active region even if the
15489 cursor moves across a special context.
15491 @item @file{CUA.el} by Kim. F. Storm
15492 @cindex @file{CUA.el}
15493 @cindex Storm, Kim. F.
15494 @vindex org-replace-disputed-keys
15495 Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by CUA mode
15496 (as well as @code{pc-select-mode} and @code{s-region-mode}) to select and extend the
15497 region. In fact, Emacs 23 has this built-in in the form of
15498 @code{shift-selection-mode}, see previous paragraph. If you are using Emacs
15499 23, you probably don't want to use another package for this purpose. However,
15500 if you prefer to leave these keys to a different package while working in
15501 Org mode, configure the variable @code{org-replace-disputed-keys}. When set,
15502 Org will move the following key bindings in Org files, and in the agenda
15503 buffer (but not during date selection).
15506 S-UP @result{} M-p S-DOWN @result{} M-n
15507 S-LEFT @result{} M-- S-RIGHT @result{} M-+
15508 C-S-LEFT @result{} M-S-- C-S-RIGHT @result{} M-S-+
15511 @vindex org-disputed-keys
15512 Yes, these are unfortunately more difficult to remember. If you want
15513 to have other replacement keys, look at the variable
15514 @code{org-disputed-keys}.
15516 @item @file{filladapt.el} by Kyle Jones
15517 @cindex @file{filladapt.el}
15519 Org mode tries to do the right thing when filling paragraphs, list items and
15520 other elements. Many users reported they had problems using both
15521 @file{filladapt.el} and Org mode, so a safe thing to do is to disable it like
15525 (add-hook 'org-mode-hook 'turn-off-filladapt-mode)
15528 @item @file{yasnippet.el}
15529 @cindex @file{yasnippet.el}
15530 The way Org mode binds the TAB key (binding to @code{[tab]} instead of
15531 @code{"\t"}) overrules YASnippet's access to this key. The following code
15532 fixed this problem:
15535 (add-hook 'org-mode-hook
15537 (org-set-local 'yas/trigger-key [tab])
15538 (define-key yas/keymap [tab] 'yas/next-field-or-maybe-expand)))
15541 The latest version of yasnippet doesn't play well with Org mode. If the
15542 above code does not fix the conflict, start by defining the following
15546 (defun yas/org-very-safe-expand ()
15547 (let ((yas/fallback-behavior 'return-nil)) (yas/expand)))
15550 Then, tell Org mode what to do with the new function:
15553 (add-hook 'org-mode-hook
15555 (make-variable-buffer-local 'yas/trigger-key)
15556 (setq yas/trigger-key [tab])
15557 (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand)
15558 (define-key yas/keymap [tab] 'yas/next-field)))
15561 @item @file{windmove.el} by Hovav Shacham
15562 @cindex @file{windmove.el}
15563 This package also uses the @kbd{S-<cursor>} keys, so everything written
15564 in the paragraph above about CUA mode also applies here. If you want make
15565 the windmove function active in locations where Org mode does not have
15566 special functionality on @kbd{S-@key{cursor}}, add this to your
15570 ;; Make windmove work in org-mode:
15571 (add-hook 'org-shiftup-final-hook 'windmove-up)
15572 (add-hook 'org-shiftleft-final-hook 'windmove-left)
15573 (add-hook 'org-shiftdown-final-hook 'windmove-down)
15574 (add-hook 'org-shiftright-final-hook 'windmove-right)
15577 @item @file{viper.el} by Michael Kifer
15578 @cindex @file{viper.el}
15580 Viper uses @kbd{C-c /} and therefore makes this key not access the
15581 corresponding Org mode command @code{org-sparse-tree}. You need to find
15582 another key for this command, or override the key in
15583 @code{viper-vi-global-user-map} with
15586 (define-key viper-vi-global-user-map "C-c /" 'org-sparse-tree)
15591 @node org-crypt.el, , Interaction, Miscellaneous
15592 @section org-crypt.el
15593 @cindex @file{org-crypt.el}
15594 @cindex @code{org-decrypt-entry}
15596 Org-crypt will encrypt the text of an entry, but not the headline, or
15597 properties. Org-crypt uses the Emacs EasyPG library to encrypt and decrypt
15600 Any text below a headline that has a @samp{:crypt:} tag will be automatically
15601 be encrypted when the file is saved. If you want to use a different tag just
15602 customize the @code{org-crypt-tag-matcher} setting.
15604 To use org-crypt it is suggested that you have the following in your
15608 (require 'org-crypt)
15609 (org-crypt-use-before-save-magic)
15610 (setq org-tags-exclude-from-inheritance (quote ("crypt")))
15612 (setq org-crypt-key nil)
15613 ;; GPG key to use for encryption
15614 ;; Either the Key ID or set to nil to use symmetric encryption.
15616 (setq auto-save-default nil)
15617 ;; Auto-saving does not cooperate with org-crypt.el: so you need
15618 ;; to turn it off if you plan to use org-crypt.el quite often.
15619 ;; Otherwise, you'll get an (annoying) message each time you
15622 ;; To turn it off only locally, you can insert this:
15624 ;; # -*- buffer-auto-save-file-name: nil; -*-
15627 Excluding the crypt tag from inheritance prevents already encrypted text
15628 being encrypted again.
15630 @node Hacking, MobileOrg, Miscellaneous, Top
15634 This appendix covers some aspects where users can extend the functionality of
15638 * Hooks:: How to reach into Org's internals
15639 * Add-on packages:: Available extensions
15640 * Adding hyperlink types:: New custom link types
15641 * Adding export back-ends:: How to write new export back-ends
15642 * Context-sensitive commands:: How to add functionality to such commands
15643 * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
15644 * Dynamic blocks:: Automatically filled blocks
15645 * Special agenda views:: Customized views
15646 * Speeding up your agendas:: Tips on how to speed up your agendas
15647 * Extracting agenda information:: Post-processing of agenda information
15648 * Using the property API:: Writing programs that use entry properties
15649 * Using the mapping API:: Mapping over all or selected entries
15652 @node Hooks, Add-on packages, Hacking, Hacking
15656 Org has a large number of hook variables that can be used to add
15657 functionality. This appendix about hacking is going to illustrate the
15658 use of some of them. A complete list of all hooks with documentation is
15659 maintained by the Worg project and can be found at
15660 @uref{http://orgmode.org/worg/org-configs/org-hooks.php}.
15662 @node Add-on packages, Adding hyperlink types, Hooks, Hacking
15663 @section Add-on packages
15664 @cindex add-on packages
15666 A large number of add-on packages have been written by various authors.
15667 These packages are not part of Emacs, but they are distributed as contributed
15668 packages with the separate release available at the Org mode home page at
15669 @uref{http://orgmode.org}. The list of contributed packages, along with
15670 documentation about each package, is maintained by the Worg project at
15671 @uref{http://orgmode.org/worg/org-contrib/}.
15675 @node Adding hyperlink types, Adding export back-ends, Add-on packages, Hacking
15676 @section Adding hyperlink types
15677 @cindex hyperlinks, adding new types
15679 Org has a large number of hyperlink types built-in
15680 (@pxref{Hyperlinks}). If you would like to add new link types, Org
15681 provides an interface for doing so. Let's look at an example file,
15682 @file{org-man.el}, that will add support for creating links like
15683 @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
15687 ;;; org-man.el - Support for links to manpages in Org
15691 (org-add-link-type "man" 'org-man-open)
15692 (add-hook 'org-store-link-functions 'org-man-store-link)
15694 (defcustom org-man-command 'man
15695 "The Emacs command to be used to display a man page."
15697 :type '(choice (const man) (const woman)))
15699 (defun org-man-open (path)
15700 "Visit the manpage on PATH.
15701 PATH should be a topic that can be thrown at the man command."
15702 (funcall org-man-command path))
15704 (defun org-man-store-link ()
15705 "Store a link to a manpage."
15706 (when (memq major-mode '(Man-mode woman-mode))
15707 ;; This is a man page, we do make this link
15708 (let* ((page (org-man-get-page-name))
15709 (link (concat "man:" page))
15710 (description (format "Manpage for %s" page)))
15711 (org-store-link-props
15714 :description description))))
15716 (defun org-man-get-page-name ()
15717 "Extract the page name from the buffer name."
15718 ;; This works for both `Man-mode' and `woman-mode'.
15719 (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
15720 (match-string 1 (buffer-name))
15721 (error "Cannot create link to this man page")))
15725 ;;; org-man.el ends here
15729 You would activate this new link type in @file{.emacs} with
15736 Let's go through the file and see what it does.
15739 It does @code{(require 'org)} to make sure that @file{org.el} has been
15742 The next line calls @code{org-add-link-type} to define a new link type
15743 with prefix @samp{man}. The call also contains the name of a function
15744 that will be called to follow such a link.
15746 @vindex org-store-link-functions
15747 The next line adds a function to @code{org-store-link-functions}, in
15748 order to allow the command @kbd{C-c l} to record a useful link in a
15749 buffer displaying a man page.
15752 The rest of the file defines the necessary variables and functions.
15753 First there is a customization variable that determines which Emacs
15754 command should be used to display man pages. There are two options,
15755 @code{man} and @code{woman}. Then the function to follow a link is
15756 defined. It gets the link path as an argument---in this case the link
15757 path is just a topic for the manual command. The function calls the
15758 value of @code{org-man-command} to display the man page.
15760 Finally the function @code{org-man-store-link} is defined. When you try
15761 to store a link with @kbd{C-c l}, this function will be called to
15762 try to make a link. The function must first decide if it is supposed to
15763 create the link for this buffer type; we do this by checking the value
15764 of the variable @code{major-mode}. If not, the function must exit and
15765 return the value @code{nil}. If yes, the link is created by getting the
15766 manual topic from the buffer name and prefixing it with the string
15767 @samp{man:}. Then it must call the command @code{org-store-link-props}
15768 and set the @code{:type} and @code{:link} properties. Optionally you
15769 can also set the @code{:description} property to provide a default for
15770 the link description when the link is later inserted into an Org
15771 buffer with @kbd{C-c C-l}.
15773 When it makes sense for your new link type, you may also define a function
15774 @code{org-PREFIX-complete-link} that implements special (e.g., completion)
15775 support for inserting such a link with @kbd{C-c C-l}. Such a function should
15776 not accept any arguments, and return the full link with prefix.
15778 @node Adding export back-ends, Context-sensitive commands, Adding hyperlink types, Hacking
15779 @section Adding export back-ends
15780 @cindex Export, writing back-ends
15782 Org 8.0 comes with a completely rewritten export engine which makes it easy
15783 to write new export back-ends, either from scratch, or from deriving them
15784 from existing ones.
15786 Your two entry points are respectively @code{org-export-define-backend} and
15787 @code{org-export-define-derived-backend}. To grok these functions, you
15788 should first have a look at @file{ox-latex.el} (for how to define a new
15789 back-end from scratch) and @file{ox-beamer.el} (for how to derive a new
15790 back-end from an existing one.
15792 When creating a new back-end from scratch, the basic idea is to set the name
15793 of the back-end (as a symbol) and an an alist of elements and export
15794 functions. On top of this, you will need to set additional keywords like
15795 @code{:menu-entry} (to display the back-end in the export dispatcher),
15796 @code{:export-block} (to specify what blocks should not be exported by this
15797 back-end), and @code{:options-alist} (to let the user set export options that
15798 are specific to this back-end.)
15800 Deriving a new back-end is similar, except that you need to set
15801 @code{:translate-alist} to an alist of export functions that should be used
15802 instead of the parent back-end functions.
15804 For a complete reference documentation, see
15805 @url{http://orgmode.org/worg/dev/org-export-reference.html, the Org Export
15806 Reference on Worg}.
15808 @node Context-sensitive commands, Tables in arbitrary syntax, Adding export back-ends, Hacking
15809 @section Context-sensitive commands
15810 @cindex context-sensitive commands, hooks
15811 @cindex add-ons, context-sensitive commands
15812 @vindex org-ctrl-c-ctrl-c-hook
15814 Org has several commands that act differently depending on context. The most
15815 important example is the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}).
15816 Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys have this property.
15818 Add-ons can tap into this functionality by providing a function that detects
15819 special context for that add-on and executes functionality appropriate for
15820 the context. Here is an example from Dan Davison's @file{org-R.el} which
15821 allows you to evaluate commands based on the @file{R} programming language
15822 @footnote{@file{org-R.el} has been replaced by the Org mode functionality
15823 described in @ref{Working With Source Code} and is now obsolete.}. For this
15824 package, special contexts are lines that start with @code{#+R:} or
15828 (defun org-R-apply-maybe ()
15829 "Detect if this is context for org-R and execute R commands."
15830 (if (save-excursion
15831 (beginning-of-line 1)
15832 (looking-at "#\\+RR?:"))
15833 (progn (call-interactively 'org-R-apply)
15834 t) ;; to signal that we took action
15835 nil)) ;; to signal that we did not
15837 (add-hook 'org-ctrl-c-ctrl-c-hook 'org-R-apply-maybe)
15840 The function first checks if the cursor is in such a line. If that is the
15841 case, @code{org-R-apply} is called and the function returns @code{t} to
15842 signal that action was taken, and @kbd{C-c C-c} will stop looking for other
15843 contexts. If the function finds it should do nothing locally, it returns
15844 @code{nil} so that other, similar functions can have a try.
15847 @node Tables in arbitrary syntax, Dynamic blocks, Context-sensitive commands, Hacking
15848 @section Tables and lists in arbitrary syntax
15849 @cindex tables, in other modes
15850 @cindex lists, in other modes
15851 @cindex Orgtbl mode
15853 Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
15854 frequent feature request has been to make it work with native tables in
15855 specific languages, for example @LaTeX{}. However, this is extremely
15856 hard to do in a general way, would lead to a customization nightmare,
15857 and would take away much of the simplicity of the Orgtbl mode table
15860 This appendix describes a different approach. We keep the Orgtbl mode
15861 table in its native format (the @i{source table}), and use a custom
15862 function to @i{translate} the table to the correct syntax, and to
15863 @i{install} it in the right location (the @i{target table}). This puts
15864 the burden of writing conversion functions on the user, but it allows
15865 for a very flexible system.
15867 Bastien added the ability to do the same with lists, in Orgstruct mode. You
15868 can use Org's facilities to edit and structure lists by turning
15869 @code{orgstruct-mode} on, then locally exporting such lists in another format
15870 (HTML, @LaTeX{} or Texinfo.)
15874 * Radio tables:: Sending and receiving radio tables
15875 * A @LaTeX{} example:: Step by step, almost a tutorial
15876 * Translator functions:: Copy and modify
15877 * Radio lists:: Doing the same for lists
15880 @node Radio tables, A @LaTeX{} example, Tables in arbitrary syntax, Tables in arbitrary syntax
15881 @subsection Radio tables
15882 @cindex radio tables
15884 To define the location of the target table, you first need to create two
15885 lines that are comments in the current mode, but contain magic words for
15886 Orgtbl mode to find. Orgtbl mode will insert the translated table
15887 between these lines, replacing whatever was there before. For example:
15890 /* BEGIN RECEIVE ORGTBL table_name */
15891 /* END RECEIVE ORGTBL table_name */
15895 Just above the source table, we put a special line that tells
15896 Orgtbl mode how to translate this table and where to install it. For
15900 #+ORGTBL: SEND table_name translation_function arguments....
15904 @code{table_name} is the reference name for the table that is also used
15905 in the receiver lines. @code{translation_function} is the Lisp function
15906 that does the translation. Furthermore, the line can contain a list of
15907 arguments (alternating key and value) at the end. The arguments will be
15908 passed as a property list to the translation function for
15909 interpretation. A few standard parameters are already recognized and
15910 acted upon before the translation function is called:
15914 Skip the first N lines of the table. Hlines do count as separate lines for
15917 @item :skipcols (n1 n2 ...)
15918 List of columns that should be skipped. If the table has a column with
15919 calculation marks, that column is automatically discarded as well.
15920 Please note that the translator function sees the table @emph{after} the
15921 removal of these columns, the function never knows that there have been
15922 additional columns.
15925 When non-nil, do not escape special characters @code{&%#_^} when exporting
15926 the table. The default value is nil.
15930 The one problem remaining is how to keep the source table in the buffer
15931 without disturbing the normal workings of the file, for example during
15932 compilation of a C file or processing of a @LaTeX{} file. There are a
15933 number of different solutions:
15937 The table could be placed in a block comment if that is supported by the
15938 language. For example, in C mode you could wrap the table between
15939 @samp{/*} and @samp{*/} lines.
15941 Sometimes it is possible to put the table after some kind of @i{END}
15942 statement, for example @samp{\bye} in @TeX{} and @samp{\end@{document@}}
15945 You can just comment the table line-by-line whenever you want to process
15946 the file, and uncomment it whenever you need to edit the table. This
15947 only sounds tedious---the command @kbd{M-x orgtbl-toggle-comment}
15948 makes this comment-toggling very easy, in particular if you bind it to a
15952 @node A @LaTeX{} example, Translator functions, Radio tables, Tables in arbitrary syntax
15953 @subsection A @LaTeX{} example of radio tables
15954 @cindex @LaTeX{}, and Orgtbl mode
15956 The best way to wrap the source table in @LaTeX{} is to use the
15957 @code{comment} environment provided by @file{comment.sty}. It has to be
15958 activated by placing @code{\usepackage@{comment@}} into the document
15959 header. Orgtbl mode can insert a radio table skeleton@footnote{By
15960 default this works only for @LaTeX{}, HTML, and Texinfo. Configure the
15961 variable @code{orgtbl-radio-tables} to install templates for other
15962 modes.} with the command @kbd{M-x orgtbl-insert-radio-table}. You will
15963 be prompted for a table name, let's say we use @samp{salesfigures}. You
15964 will then get the following template:
15966 @cindex #+ORGTBL, SEND
15968 % BEGIN RECEIVE ORGTBL salesfigures
15969 % END RECEIVE ORGTBL salesfigures
15971 #+ORGTBL: SEND salesfigures orgtbl-to-latex
15977 @vindex @LaTeX{}-verbatim-environments
15978 The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
15979 @code{orgtbl-to-latex} to convert the table into @LaTeX{} and to put it
15980 into the receiver location with name @code{salesfigures}. You may now
15981 fill in the table---feel free to use the spreadsheet features@footnote{If
15982 the @samp{#+TBLFM} line contains an odd number of dollar characters,
15983 this may cause problems with font-lock in @LaTeX{} mode. As shown in the
15984 example you can fix this by adding an extra line inside the
15985 @code{comment} environment that is used to balance the dollar
15986 expressions. If you are using AUC@TeX{} with the font-latex library, a
15987 much better solution is to add the @code{comment} environment to the
15988 variable @code{LaTeX-verbatim-environments}.}:
15991 % BEGIN RECEIVE ORGTBL salesfigures
15992 % END RECEIVE ORGTBL salesfigures
15994 #+ORGTBL: SEND salesfigures orgtbl-to-latex
15995 | Month | Days | Nr sold | per day |
15996 |-------+------+---------+---------|
15997 | Jan | 23 | 55 | 2.4 |
15998 | Feb | 21 | 16 | 0.8 |
15999 | March | 22 | 278 | 12.6 |
16000 #+TBLFM: $4=$3/$2;%.1f
16001 % $ (optional extra dollar to keep font-lock happy, see footnote)
16006 When you are done, press @kbd{C-c C-c} in the table to get the converted
16007 table inserted between the two marker lines.
16009 Now let's assume you want to make the table header by hand, because you
16010 want to control how columns are aligned, etc. In this case we make sure
16011 that the table translator skips the first 2 lines of the source
16012 table, and tell the command to work as a @i{splice}, i.e., to not produce
16013 header and footer commands of the target table:
16016 \begin@{tabular@}@{lrrr@}
16017 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
16018 % BEGIN RECEIVE ORGTBL salesfigures
16019 % END RECEIVE ORGTBL salesfigures
16023 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
16024 | Month | Days | Nr sold | per day |
16025 |-------+------+---------+---------|
16026 | Jan | 23 | 55 | 2.4 |
16027 | Feb | 21 | 16 | 0.8 |
16028 | March | 22 | 278 | 12.6 |
16029 #+TBLFM: $4=$3/$2;%.1f
16033 The @LaTeX{} translator function @code{orgtbl-to-latex} is already part of
16034 Orgtbl mode. It uses a @code{tabular} environment to typeset the table
16035 and marks horizontal lines with @code{\hline}. Furthermore, it
16036 interprets the following parameters (see also @pxref{Translator functions}):
16039 @item :splice nil/t
16040 When set to t, return only table body lines, don't wrap them into a
16041 tabular environment. Default is nil.
16044 A format to be used to wrap each field, it should contain @code{%s} for the
16045 original field value. For example, to wrap each field value in dollars,
16046 you could use @code{:fmt "$%s$"}. This may also be a property list with
16047 column numbers and formats, for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
16048 A function of one argument can be used in place of the strings; the
16049 function must return a formatted string.
16052 Use this format to print numbers with exponentials. The format should
16053 have @code{%s} twice for inserting mantissa and exponent, for example
16054 @code{"%s\\times10^@{%s@}"}. The default is @code{"%s\\,(%s)"}. This
16055 may also be a property list with column numbers and formats, for example
16056 @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After
16057 @code{efmt} has been applied to a value, @code{fmt} will also be
16058 applied. Similar to @code{fmt}, functions of two arguments can be
16059 supplied instead of strings.
16062 @node Translator functions, Radio lists, A @LaTeX{} example, Tables in arbitrary syntax
16063 @subsection Translator functions
16064 @cindex HTML, and Orgtbl mode
16065 @cindex translator function
16067 Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
16068 (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
16069 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and @code{orgtbl-to-texinfo}.
16070 Except for @code{orgtbl-to-html}@footnote{The HTML translator uses the same
16071 code that produces tables during HTML export.}, these all use a generic
16072 translator, @code{orgtbl-to-generic}. For example, @code{orgtbl-to-latex}
16073 itself is a very short function that computes the column definitions for the
16074 @code{tabular} environment, defines a few field and line separators and then
16075 hands processing over to the generic translator. Here is the entire code:
16079 (defun orgtbl-to-latex (table params)
16080 "Convert the Orgtbl mode TABLE to LaTeX."
16081 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
16082 org-table-last-alignment ""))
16085 :tstart (concat "\\begin@{tabular@}@{" alignment "@}")
16086 :tend "\\end@{tabular@}"
16087 :lstart "" :lend " \\\\" :sep " & "
16088 :efmt "%s\\,(%s)" :hline "\\hline")))
16089 (orgtbl-to-generic table (org-combine-plists params2 params))))
16093 As you can see, the properties passed into the function (variable
16094 @var{PARAMS}) are combined with the ones newly defined in the function
16095 (variable @var{PARAMS2}). The ones passed into the function (i.e., the
16096 ones set by the @samp{ORGTBL SEND} line) take precedence. So if you
16097 would like to use the @LaTeX{} translator, but wanted the line endings to
16098 be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
16099 overrule the default with
16102 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
16105 For a new language, you can either write your own converter function in
16106 analogy with the @LaTeX{} translator, or you can use the generic function
16107 directly. For example, if you have a language where a table is started
16108 with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are
16109 started with @samp{!BL!}, ended with @samp{!EL!}, and where the field
16110 separator is a TAB, you could call the generic translator like this (on
16114 #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
16115 :lstart "!BL! " :lend " !EL!" :sep "\t"
16119 Please check the documentation string of the function
16120 @code{orgtbl-to-generic} for a full list of parameters understood by
16121 that function, and remember that you can pass each of them into
16122 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
16123 using the generic function.
16125 Of course you can also write a completely new function doing complicated
16126 things the generic translator cannot do. A translator function takes
16127 two arguments. The first argument is the table, a list of lines, each
16128 line either the symbol @code{hline} or a list of fields. The second
16129 argument is the property list containing all parameters specified in the
16130 @samp{#+ORGTBL: SEND} line. The function must return a single string
16131 containing the formatted table. If you write a generally useful
16132 translator, please post it on @email{emacs-orgmode@@gnu.org} so that
16133 others can benefit from your work.
16135 @node Radio lists, , Translator functions, Tables in arbitrary syntax
16136 @subsection Radio lists
16137 @cindex radio lists
16138 @cindex org-list-insert-radio-list
16140 Sending and receiving radio lists works exactly the same way as sending and
16141 receiving radio tables (@pxref{Radio tables}). As for radio tables, you can
16142 insert radio list templates in HTML, @LaTeX{} and Texinfo modes by calling
16143 @code{org-list-insert-radio-list}.
16145 Here are the differences with radio tables:
16149 Orgstruct mode must be active.
16151 Use the @code{ORGLST} keyword instead of @code{ORGTBL}.
16153 The available translation functions for radio lists don't take
16156 @kbd{C-c C-c} will work when pressed on the first item of the list.
16159 Here is a @LaTeX{} example. Let's say that you have this in your
16164 % BEGIN RECEIVE ORGLST to-buy
16165 % END RECEIVE ORGLST to-buy
16167 #+ORGLST: SEND to-buy org-list-to-latex
16176 Pressing @kbd{C-c C-c} on @code{a new house} and will insert the converted
16177 @LaTeX{} list between the two marker lines.
16179 @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Hacking
16180 @section Dynamic blocks
16181 @cindex dynamic blocks
16183 Org documents can contain @emph{dynamic blocks}. These are
16184 specially marked regions that are updated by some user-written function.
16185 A good example for such a block is the clock table inserted by the
16186 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
16188 Dynamic blocks are enclosed by a BEGIN-END structure that assigns a name
16189 to the block and can also specify parameters for the function producing
16190 the content of the block.
16192 @cindex #+BEGIN:dynamic block
16194 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
16199 Dynamic blocks are updated with the following commands
16202 @orgcmd{C-c C-x C-u,org-dblock-update}
16203 Update dynamic block at point.
16204 @orgkey{C-u C-c C-x C-u}
16205 Update all dynamic blocks in the current file.
16208 Updating a dynamic block means to remove all the text between BEGIN and
16209 END, parse the BEGIN line for parameters and then call the specific
16210 writer function for this block to insert the new content. If you want
16211 to use the original content in the writer function, you can use the
16212 extra parameter @code{:content}.
16214 For a block with name @code{myblock}, the writer function is
16215 @code{org-dblock-write:myblock} with as only parameter a property list
16216 with the parameters given in the begin line. Here is a trivial example
16217 of a block that keeps track of when the block update function was last
16221 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
16227 The corresponding block writer function could look like this:
16230 (defun org-dblock-write:block-update-time (params)
16231 (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
16232 (insert "Last block update at: "
16233 (format-time-string fmt (current-time)))))
16236 If you want to make sure that all dynamic blocks are always up-to-date,
16237 you could add the function @code{org-update-all-dblocks} to a hook, for
16238 example @code{before-save-hook}. @code{org-update-all-dblocks} is
16239 written in a way such that it does nothing in buffers that are not in
16242 You can narrow the current buffer to the current dynamic block (like any
16243 other block) with @code{org-narrow-to-block}.
16245 @node Special agenda views, Speeding up your agendas, Dynamic blocks, Hacking
16246 @section Special agenda views
16247 @cindex agenda views, user-defined
16249 @vindex org-agenda-skip-function
16250 @vindex org-agenda-skip-function-global
16251 Org provides a special hook that can be used to narrow down the selection
16252 made by these agenda views: @code{agenda}, @code{agenda*}@footnote{The
16253 @code{agenda*} view is the same than @code{agenda} except that it only
16254 considers @emph{appointments}, i.e., scheduled and deadline items that have a
16255 time specification @code{[h]h:mm} in their time-stamps.}, @code{todo},
16256 @code{alltodo}, @code{tags}, @code{tags-todo}, @code{tags-tree}. You may
16257 specify a function that is used at each match to verify if the match should
16258 indeed be part of the agenda view, and if not, how much should be skipped.
16259 You can specify a global condition that will be applied to all agenda views,
16260 this condition would be stored in the variable
16261 @code{org-agenda-skip-function-global}. More commonly, such a definition is
16262 applied only to specific custom searches, using
16263 @code{org-agenda-skip-function}.
16265 Let's say you want to produce a list of projects that contain a WAITING
16266 tag anywhere in the project tree. Let's further assume that you have
16267 marked all tree headings that define a project with the TODO keyword
16268 PROJECT@. In this case you would run a TODO search for the keyword
16269 PROJECT, but skip the match unless there is a WAITING tag anywhere in
16270 the subtree belonging to the project line.
16272 To achieve this, you must write a function that searches the subtree for
16273 the tag. If the tag is found, the function must return @code{nil} to
16274 indicate that this match should not be skipped. If there is no such
16275 tag, return the location of the end of the subtree, to indicate that
16276 search should continue from there.
16279 (defun my-skip-unless-waiting ()
16280 "Skip trees that are not waiting"
16281 (let ((subtree-end (save-excursion (org-end-of-subtree t))))
16282 (if (re-search-forward ":waiting:" subtree-end t)
16283 nil ; tag found, do not skip
16284 subtree-end))) ; tag not found, continue after end of subtree
16287 Now you may use this function in an agenda custom command, for example
16291 (org-add-agenda-custom-command
16292 '("b" todo "PROJECT"
16293 ((org-agenda-skip-function 'my-skip-unless-waiting)
16294 (org-agenda-overriding-header "Projects waiting for something: "))))
16297 @vindex org-agenda-overriding-header
16298 Note that this also binds @code{org-agenda-overriding-header} to get a
16299 meaningful header in the agenda view.
16301 @vindex org-odd-levels-only
16302 @vindex org-agenda-skip-function
16303 A general way to create custom searches is to base them on a search for
16304 entries with a certain level limit. If you want to study all entries with
16305 your custom search function, simply do a search for
16306 @samp{LEVEL>0}@footnote{Note that, when using @code{org-odd-levels-only}, a
16307 level number corresponds to order in the hierarchy, not to the number of
16308 stars.}, and then use @code{org-agenda-skip-function} to select the entries
16309 you really want to have.
16311 You may also put a Lisp form into @code{org-agenda-skip-function}. In
16312 particular, you may use the functions @code{org-agenda-skip-entry-if}
16313 and @code{org-agenda-skip-subtree-if} in this form, for example:
16316 @item (org-agenda-skip-entry-if 'scheduled)
16317 Skip current entry if it has been scheduled.
16318 @item (org-agenda-skip-entry-if 'notscheduled)
16319 Skip current entry if it has not been scheduled.
16320 @item (org-agenda-skip-entry-if 'deadline)
16321 Skip current entry if it has a deadline.
16322 @item (org-agenda-skip-entry-if 'scheduled 'deadline)
16323 Skip current entry if it has a deadline, or if it is scheduled.
16324 @item (org-agenda-skip-entry-if 'todo '("TODO" "WAITING"))
16325 Skip current entry if the TODO keyword is TODO or WAITING.
16326 @item (org-agenda-skip-entry-if 'todo 'done)
16327 Skip current entry if the TODO keyword marks a DONE state.
16328 @item (org-agenda-skip-entry-if 'timestamp)
16329 Skip current entry if it has any timestamp, may also be deadline or scheduled.
16330 @anchor{x-agenda-skip-entry-regexp}
16331 @item (org-agenda-skip-entry-if 'regexp "regular expression")
16332 Skip current entry if the regular expression matches in the entry.
16333 @item (org-agenda-skip-entry-if 'notregexp "regular expression")
16334 Skip current entry unless the regular expression matches.
16335 @item (org-agenda-skip-subtree-if 'regexp "regular expression")
16336 Same as above, but check and skip the entire subtree.
16339 Therefore we could also have written the search for WAITING projects
16340 like this, even without defining a special function:
16343 (org-add-agenda-custom-command
16344 '("b" todo "PROJECT"
16345 ((org-agenda-skip-function '(org-agenda-skip-subtree-if
16346 'regexp ":waiting:"))
16347 (org-agenda-overriding-header "Projects waiting for something: "))))
16350 @node Speeding up your agendas, Extracting agenda information, Special agenda views, Hacking
16351 @section Speeding up your agendas
16352 @cindex agenda views, optimization
16354 When your Org files grow in both number and size, agenda commands may start
16355 to become slow. Below are some tips on how to speed up the agenda commands.
16359 Reduce the number of Org agenda files: this will reduce the slowliness caused
16360 by accessing to a hard drive.
16362 Reduce the number of DONE and archived headlines: this way the agenda does
16363 not need to skip them.
16365 @vindex org-agenda-dim-blocked-tasks
16366 Inhibit the dimming of blocked tasks:
16368 (setq org-agenda-dim-blocked-tasks nil)
16371 @vindex org-startup-folded
16372 @vindex org-agenda-inhibit-startup
16373 Inhibit agenda files startup options:
16375 (setq org-agenda-inhibit-startup nil)
16378 @vindex org-agenda-show-inherited-tags
16379 @vindex org-agenda-use-tag-inheritance
16380 Disable tag inheritance in agenda:
16382 (setq org-agenda-use-tag-inheritance nil)
16386 You can set these options for specific agenda views only. See the docstrings
16387 of these variables for details on why they affect the agenda generation, and
16388 this @uref{http://orgmode.org/worg/agenda-optimization.html, dedicated Worg
16389 page} for further explanations.
16391 @node Extracting agenda information, Using the property API, Speeding up your agendas, Hacking
16392 @section Extracting agenda information
16393 @cindex agenda, pipe
16394 @cindex Scripts, for agenda processing
16396 @vindex org-agenda-custom-commands
16397 Org provides commands to access agenda information for the command
16398 line in Emacs batch mode. This extracted information can be sent
16399 directly to a printer, or it can be read by a program that does further
16400 processing of the data. The first of these commands is the function
16401 @code{org-batch-agenda}, that produces an agenda view and sends it as
16402 ASCII text to STDOUT@. The command takes a single string as parameter.
16403 If the string has length 1, it is used as a key to one of the commands
16404 you have configured in @code{org-agenda-custom-commands}, basically any
16405 key you can use after @kbd{C-c a}. For example, to directly print the
16406 current TODO list, you could use
16409 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
16412 If the parameter is a string with 2 or more characters, it is used as a
16413 tags/TODO match string. For example, to print your local shopping list
16414 (all items with the tag @samp{shop}, but excluding the tag
16415 @samp{NewYork}), you could use
16418 emacs -batch -l ~/.emacs \
16419 -eval '(org-batch-agenda "+shop-NewYork")' | lpr
16423 You may also modify parameters on the fly like this:
16426 emacs -batch -l ~/.emacs \
16427 -eval '(org-batch-agenda "a" \
16428 org-agenda-span (quote month) \
16429 org-agenda-include-diary nil \
16430 org-agenda-files (quote ("~/org/project.org")))' \
16435 which will produce a 30-day agenda, fully restricted to the Org file
16436 @file{~/org/projects.org}, not even including the diary.
16438 If you want to process the agenda data in more sophisticated ways, you
16439 can use the command @code{org-batch-agenda-csv} to get a comma-separated
16440 list of values for each agenda item. Each line in the output will
16441 contain a number of fields separated by commas. The fields in a line
16445 category @r{The category of the item}
16446 head @r{The headline, without TODO keyword, TAGS and PRIORITY}
16447 type @r{The type of the agenda entry, can be}
16448 todo @r{selected in TODO match}
16449 tagsmatch @r{selected in tags match}
16450 diary @r{imported from diary}
16451 deadline @r{a deadline}
16452 scheduled @r{scheduled}
16453 timestamp @r{appointment, selected by timestamp}
16454 closed @r{entry was closed on date}
16455 upcoming-deadline @r{warning about nearing deadline}
16456 past-scheduled @r{forwarded scheduled item}
16457 block @r{entry has date block including date}
16458 todo @r{The TODO keyword, if any}
16459 tags @r{All tags including inherited ones, separated by colons}
16460 date @r{The relevant date, like 2007-2-14}
16461 time @r{The time, like 15:00-16:50}
16462 extra @r{String with extra planning info}
16463 priority-l @r{The priority letter if any was given}
16464 priority-n @r{The computed numerical priority}
16468 Time and date will only be given if a timestamp (or deadline/scheduled)
16469 led to the selection of the item.
16471 A CSV list like this is very easy to use in a post-processing script.
16472 For example, here is a Perl program that gets the TODO list from
16473 Emacs/Org and prints all the items, preceded by a checkbox:
16478 # define the Emacs command to run
16479 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
16481 # run it and capture the output
16482 $agenda = qx@{$cmd 2>/dev/null@};
16484 # loop over all lines
16485 foreach $line (split(/\n/,$agenda)) @{
16486 # get the individual values
16487 ($category,$head,$type,$todo,$tags,$date,$time,$extra,
16488 $priority_l,$priority_n) = split(/,/,$line);
16489 # process and print
16490 print "[ ] $head\n";
16494 @node Using the property API, Using the mapping API, Extracting agenda information, Hacking
16495 @section Using the property API
16496 @cindex API, for properties
16497 @cindex properties, API
16499 Here is a description of the functions that can be used to work with
16502 @defun org-entry-properties &optional pom which
16503 Get all properties of the entry at point-or-marker POM.@*
16504 This includes the TODO keyword, the tags, time strings for deadline,
16505 scheduled, and clocking, and any additional properties defined in the
16506 entry. The return value is an alist. Keys may occur multiple times
16507 if the property key was used several times.@*
16508 POM may also be nil, in which case the current entry is used.
16509 If WHICH is nil or `all', get all properties. If WHICH is
16510 `special' or `standard', only get that subclass.
16512 @vindex org-use-property-inheritance
16513 @findex org-insert-property-drawer
16514 @defun org-entry-get pom property &optional inherit
16515 Get value of PROPERTY for entry at point-or-marker POM@. By default,
16516 this only looks at properties defined locally in the entry. If INHERIT
16517 is non-nil and the entry does not have the property, then also check
16518 higher levels of the hierarchy. If INHERIT is the symbol
16519 @code{selective}, use inheritance if and only if the setting of
16520 @code{org-use-property-inheritance} selects PROPERTY for inheritance.
16523 @defun org-entry-delete pom property
16524 Delete the property PROPERTY from entry at point-or-marker POM.
16527 @defun org-entry-put pom property value
16528 Set PROPERTY to VALUE for entry at point-or-marker POM.
16531 @defun org-buffer-property-keys &optional include-specials
16532 Get all property keys in the current buffer.
16535 @defun org-insert-property-drawer
16536 Insert a property drawer for the current entry. Also
16539 @defun org-entry-put-multivalued-property pom property &rest values
16540 Set PROPERTY at point-or-marker POM to VALUES@. VALUES should be a list of
16541 strings. They will be concatenated, with spaces as separators.
16544 @defun org-entry-get-multivalued-property pom property
16545 Treat the value of the property PROPERTY as a whitespace-separated list of
16546 values and return the values as a list of strings.
16549 @defun org-entry-add-to-multivalued-property pom property value
16550 Treat the value of the property PROPERTY as a whitespace-separated list of
16551 values and make sure that VALUE is in this list.
16554 @defun org-entry-remove-from-multivalued-property pom property value
16555 Treat the value of the property PROPERTY as a whitespace-separated list of
16556 values and make sure that VALUE is @emph{not} in this list.
16559 @defun org-entry-member-in-multivalued-property pom property value
16560 Treat the value of the property PROPERTY as a whitespace-separated list of
16561 values and check if VALUE is in this list.
16564 @defopt org-property-allowed-value-functions
16565 Hook for functions supplying allowed values for a specific property.
16566 The functions must take a single argument, the name of the property, and
16567 return a flat list of allowed values. If @samp{:ETC} is one of
16568 the values, use the values as completion help, but allow also other values
16569 to be entered. The functions must return @code{nil} if they are not
16570 responsible for this property.
16573 @node Using the mapping API, , Using the property API, Hacking
16574 @section Using the mapping API
16575 @cindex API, for mapping
16576 @cindex mapping entries, API
16578 Org has sophisticated mapping capabilities to find all entries satisfying
16579 certain criteria. Internally, this functionality is used to produce agenda
16580 views, but there is also an API that can be used to execute arbitrary
16581 functions for each or selected entries. The main entry point for this API
16584 @defun org-map-entries func &optional match scope &rest skip
16585 Call FUNC at each headline selected by MATCH in SCOPE.
16587 FUNC is a function or a Lisp form. The function will be called without
16588 arguments, with the cursor positioned at the beginning of the headline.
16589 The return values of all calls to the function will be collected and
16590 returned as a list.
16592 The call to FUNC will be wrapped into a save-excursion form, so FUNC
16593 does not need to preserve point. After evaluation, the cursor will be
16594 moved to the end of the line (presumably of the headline of the
16595 processed entry) and search continues from there. Under some
16596 circumstances, this may not produce the wanted results. For example,
16597 if you have removed (e.g., archived) the current (sub)tree it could
16598 mean that the next entry will be skipped entirely. In such cases, you
16599 can specify the position from where search should continue by making
16600 FUNC set the variable `org-map-continue-from' to the desired buffer
16603 MATCH is a tags/property/todo match as it is used in the agenda match view.
16604 Only headlines that are matched by this query will be considered during
16605 the iteration. When MATCH is nil or t, all headlines will be
16606 visited by the iteration.
16608 SCOPE determines the scope of this command. It can be any of:
16611 nil @r{the current buffer, respecting the restriction if any}
16612 tree @r{the subtree started with the entry at point}
16613 region @r{The entries within the active region, if any}
16614 file @r{the current buffer, without restriction}
16616 @r{the current buffer, and any archives associated with it}
16617 agenda @r{all agenda files}
16618 agenda-with-archives
16619 @r{all agenda files with any archive files associated with them}
16621 @r{if this is a list, all files in the list will be scanned}
16624 The remaining args are treated as settings for the skipping facilities of
16625 the scanner. The following items can be given here:
16627 @vindex org-agenda-skip-function
16629 archive @r{skip trees with the archive tag}
16630 comment @r{skip trees with the COMMENT keyword}
16631 function or Lisp form
16632 @r{will be used as value for @code{org-agenda-skip-function},}
16633 @r{so whenever the function returns t, FUNC}
16634 @r{will not be called for that entry and search will}
16635 @r{continue from the point where the function leaves it}
16639 The function given to that mapping routine can really do anything you like.
16640 It can use the property API (@pxref{Using the property API}) to gather more
16641 information about the entry, or in order to change metadata in the entry.
16642 Here are a couple of functions that might be handy:
16644 @defun org-todo &optional arg
16645 Change the TODO state of the entry. See the docstring of the functions for
16646 the many possible values for the argument ARG.
16649 @defun org-priority &optional action
16650 Change the priority of the entry. See the docstring of this function for the
16651 possible values for ACTION.
16654 @defun org-toggle-tag tag &optional onoff
16655 Toggle the tag TAG in the current entry. Setting ONOFF to either @code{on}
16656 or @code{off} will not toggle tag, but ensure that it is either on or off.
16660 Promote the current entry.
16664 Demote the current entry.
16667 Here is a simple example that will turn all entries in the current file with
16668 a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
16669 Entries in comment trees and in archive trees will be ignored.
16673 '(org-todo "UPCOMING")
16674 "+TOMORROW" 'file 'archive 'comment)
16677 The following example counts the number of entries with TODO keyword
16678 @code{WAITING}, in all agenda files.
16681 (length (org-map-entries t "/+WAITING" 'agenda))
16684 @node MobileOrg, History and Acknowledgments, Hacking, Top
16685 @appendix MobileOrg
16689 @i{MobileOrg} is the name of the mobile companion app for Org mode, currently
16690 available for iOS and for Android. @i{MobileOrg} offers offline viewing and
16691 capture support for an Org mode system rooted on a ``real'' computer. It
16692 does also allow you to record changes to existing entries.
16693 The @uref{http://mobileorg.ncogni.to/, iOS implementation} for the
16694 @i{iPhone/iPod Touch/iPad} series of devices, was developed by Richard
16695 Moreland. Android users should check out
16696 @uref{http://wiki.github.com/matburt/mobileorg-android/, MobileOrg Android}
16697 by Matt Jones. The two implementations are not identical but offer similar
16700 This appendix describes the support Org has for creating agenda views in a
16701 format that can be displayed by @i{MobileOrg}, and for integrating notes
16702 captured and changes made by @i{MobileOrg} into the main system.
16704 For changing tags and TODO states in MobileOrg, you should have set up the
16705 customization variables @code{org-todo-keywords} and @code{org-tags-alist} to
16706 cover all important tags and TODO keywords, even if individual files use only
16707 part of these. MobileOrg will also offer you states and tags set up with
16708 in-buffer settings, but it will understand the logistics of TODO state
16709 @i{sets} (@pxref{Per-file keywords}) and @i{mutually exclusive} tags
16710 (@pxref{Setting tags}) only for those set in these variables.
16713 * Setting up the staging area:: Where to interact with the mobile device
16714 * Pushing to MobileOrg:: Uploading Org files and agendas
16715 * Pulling from MobileOrg:: Integrating captured and flagged items
16718 @node Setting up the staging area, Pushing to MobileOrg, MobileOrg, MobileOrg
16719 @section Setting up the staging area
16721 MobileOrg needs to interact with Emacs through a directory on a server. If you
16722 are using a public server, you should consider to encrypt the files that are
16723 uploaded to the server. This can be done with Org mode 7.02 and with
16724 @i{MobileOrg 1.5} (iPhone version), and you need an @file{openssl}
16725 installation on your system. To turn on encryption, set a password in
16726 @i{MobileOrg} and, on the Emacs side, configure the variable
16727 @code{org-mobile-use-encryption}@footnote{If you can safely store the
16728 password in your Emacs setup, you might also want to configure
16729 @code{org-mobile-encryption-password}. Please read the docstring of that
16730 variable. Note that encryption will apply only to the contents of the
16731 @file{.org} files. The file names themselves will remain visible.}.
16733 The easiest way to create that directory is to use a free
16734 @uref{http://dropbox.com,Dropbox.com} account@footnote{If you cannot use
16735 Dropbox, or if your version of MobileOrg does not support it, you can use a
16736 webdav server. For more information, check out the documentation of MobileOrg and also this
16737 @uref{http://orgmode.org/worg/org-faq.html#mobileorg_webdav, FAQ entry}.}.
16738 When MobileOrg first connects to your Dropbox, it will create a directory
16739 @i{MobileOrg} inside the Dropbox. After the directory has been created, tell
16743 (setq org-mobile-directory "~/Dropbox/MobileOrg")
16746 Org mode has commands to put files for @i{MobileOrg} into that directory,
16747 and to read captured notes from there.
16749 @node Pushing to MobileOrg, Pulling from MobileOrg, Setting up the staging area, MobileOrg
16750 @section Pushing to MobileOrg
16752 This operation copies all files currently listed in @code{org-mobile-files}
16753 to the directory @code{org-mobile-directory}. By default this list contains
16754 all agenda files (as listed in @code{org-agenda-files}), but additional files
16755 can be included by customizing @code{org-mobile-files}. File names will be
16756 staged with paths relative to @code{org-directory}, so all files should be
16757 inside this directory@footnote{Symbolic links in @code{org-directory} need to
16758 have the same name than their targets.}.
16760 The push operation also creates a special Org file @file{agendas.org} with
16761 all custom agenda view defined by the user@footnote{While creating the
16762 agendas, Org mode will force ID properties on all referenced entries, so that
16763 these entries can be uniquely identified if @i{MobileOrg} flags them for
16764 further action. If you do not want to get these properties in so many
16765 entries, you can set the variable @code{org-mobile-force-id-on-agenda-items}
16766 to @code{nil}. Org mode will then rely on outline paths, in the hope that
16767 these will be unique enough.}.
16769 Finally, Org writes the file @file{index.org}, containing links to all other
16770 files. @i{MobileOrg} first reads this file from the server, and then
16771 downloads all agendas and Org files listed in it. To speed up the download,
16772 MobileOrg will only read files whose checksums@footnote{Checksums are stored
16773 automatically in the file @file{checksums.dat}} have changed.
16775 @node Pulling from MobileOrg, , Pushing to MobileOrg, MobileOrg
16776 @section Pulling from MobileOrg
16778 When @i{MobileOrg} synchronizes with the server, it not only pulls the Org
16779 files for viewing. It also appends captured entries and pointers to flagged
16780 and changed entries to the file @file{mobileorg.org} on the server. Org has
16781 a @emph{pull} operation that integrates this information into an inbox file
16782 and operates on the pointers to flagged entries. Here is how it works:
16786 Org moves all entries found in
16787 @file{mobileorg.org}@footnote{@file{mobileorg.org} will be empty after this
16788 operation.} and appends them to the file pointed to by the variable
16789 @code{org-mobile-inbox-for-pull}. Each captured entry and each editing event
16790 will be a top-level entry in the inbox file.
16792 After moving the entries, Org will attempt to implement the changes made in
16793 @i{MobileOrg}. Some changes are applied directly and without user
16794 interaction. Examples are all changes to tags, TODO state, headline and body
16795 text that can be cleanly applied. Entries that have been flagged for further
16796 action will receive a tag @code{:FLAGGED:}, so that they can be easily found
16797 again. When there is a problem finding an entry or applying the change, the
16798 pointer entry will remain in the inbox and will be marked with an error
16799 message. You need to later resolve these issues by hand.
16801 Org will then generate an agenda view with all flagged entries. The user
16802 should then go through these entries and do whatever actions are necessary.
16803 If a note has been stored while flagging an entry in @i{MobileOrg}, that note
16804 will be displayed in the echo area when the cursor is on the corresponding
16810 Pressing @kbd{?} in that special agenda will display the full flagging note in
16811 another window and also push it onto the kill ring. So you could use @kbd{?
16812 z C-y C-c C-c} to store that flagging note as a normal note in the entry.
16813 Pressing @kbd{?} twice in succession will offer to remove the
16814 @code{:FLAGGED:} tag along with the recorded flagging note (which is stored
16815 in a property). In this way you indicate that the intended processing for
16816 this flagged entry is finished.
16821 If you are not able to process all flagged entries directly, you can always
16822 return to this agenda view@footnote{Note, however, that there is a subtle
16823 difference. The view created automatically by @kbd{M-x org-mobile-pull
16824 @key{RET}} is guaranteed to search all files that have been addressed by the
16825 last pull. This might include a file that is not currently in your list of
16826 agenda files. If you later use @kbd{C-c a ?} to regenerate the view, only
16827 the current agenda files will be searched.} using @kbd{C-c a ?}.
16829 @node History and Acknowledgments, GNU Free Documentation License, MobileOrg, Top
16830 @appendix History and acknowledgments
16831 @cindex acknowledgments
16835 @section From Carsten
16837 Org was born in 2003, out of frustration over the user interface of the Emacs
16838 Outline mode. I was trying to organize my notes and projects, and using
16839 Emacs seemed to be the natural way to go. However, having to remember eleven
16840 different commands with two or three keys per command, only to hide and show
16841 parts of the outline tree, that seemed entirely unacceptable to me. Also,
16842 when using outlines to take notes, I constantly wanted to restructure the
16843 tree, organizing it parallel to my thoughts and plans. @emph{Visibility
16844 cycling} and @emph{structure editing} were originally implemented in the
16845 package @file{outline-magic.el}, but quickly moved to the more general
16846 @file{org.el}. As this environment became comfortable for project planning,
16847 the next step was adding @emph{TODO entries}, basic @emph{timestamps}, and
16848 @emph{table support}. These areas highlighted the two main goals that Org
16849 still has today: to be a new, outline-based, plain text mode with innovative
16850 and intuitive editing features, and to incorporate project planning
16851 functionality directly into a notes file.
16853 Since the first release, literally thousands of emails to me or to
16854 @email{emacs-orgmode@@gnu.org} have provided a constant stream of bug
16855 reports, feedback, new ideas, and sometimes patches and add-on code.
16856 Many thanks to everyone who has helped to improve this package. I am
16857 trying to keep here a list of the people who had significant influence
16858 in shaping one or more aspects of Org. The list may not be
16859 complete, if I have forgotten someone, please accept my apologies and
16862 Before I get to this list, a few special mentions are in order:
16865 @item Bastien Guerry
16866 Bastien has written a large number of extensions to Org (most of them
16867 integrated into the core by now), including the @LaTeX{} exporter and the plain
16868 list parser. His support during the early days, when he basically acted as
16869 co-maintainer, was central to the success of this project. Bastien also
16870 invented Worg, helped establishing the Web presence of Org, and sponsored
16871 hosting costs for the orgmode.org website.
16872 @item Eric Schulte and Dan Davison
16873 Eric and Dan are jointly responsible for the Org-babel system, which turns
16874 Org into a multi-language environment for evaluating code and doing literate
16875 programming and reproducible research.
16877 John has contributed a number of great ideas and patches directly to Org,
16878 including the attachment system (@file{org-attach.el}), integration with
16879 Apple Mail (@file{org-mac-message.el}), hierarchical dependencies of TODO
16880 items, habit tracking (@file{org-habits.el}), and encryption
16881 (@file{org-crypt.el}). Also, the capture system is really an extended copy
16882 of his great @file{remember.el}.
16883 @item Sebastian Rose
16884 Without Sebastian, the HTML/XHTML publishing of Org would be the pitiful work
16885 of an ignorant amateur. Sebastian has pushed this part of Org onto a much
16886 higher level. He also wrote @file{org-info.js}, a Java script for displaying
16887 web pages derived from Org using an Info-like or a folding interface with
16888 single-key navigation.
16891 @noindent See below for the full list of contributions! Again, please
16892 let me know what I am missing here!
16894 @section From Bastien
16896 I (Bastien) have been maintaining Org since January 2011. This appendix
16897 would not be complete without adding a few more acknowledgements and thanks
16898 to Carsten's ones above.
16900 I am first grateful to Carsten for his trust while handing me over the
16901 maintainership of Org. His support as been great since day one of this new
16902 adventure, and it helped a lot.
16904 When I took over maintainership, I knew I would have to make Org more
16905 collaborative than ever, as I would have to rely on people that are more
16906 knowledgeable than I am on many parts of the code. Here is a list of the
16907 persons I could rely on, they should really be considered co-maintainers,
16908 either of the code or the community:
16912 Eric is maintaining the Babel parts of Org. His reactivity here kept me away
16913 from worrying about possible bugs here and let me focus on other parts.
16915 @item Nicolas Goaziou
16916 Nicolas is maintaining the consistency of the deepest parts of Org. His
16917 work on @file{org-element.el} and @file{ox.el} has been outstanding, and
16918 opened the doors for many new ideas and features. He rewrote many of the
16919 old exporters to use the new export engine, and helped with documenting
16920 this major change. More importantly (if that's possible), he has been more
16921 than reliable during all the work done for Org 8.0, and always very
16922 reactive on the mailing list.
16925 Achim rewrote the building process of Org, turning some @emph{ad hoc} tools
16926 into a flexible and conceptually clean process. He patiently coped with the
16927 many hiccups that such a change can create for users.
16930 The Org mode mailing list would not be such a nice place without Nick, who
16931 patiently helped users so many times. It is impossible to overestimate such
16932 a great help, and the list would not be so active without him.
16935 I received support from so many users that it is clearly impossible to be
16936 fair when shortlisting a few of them, but Org's history would not be
16937 complete if the ones above were not mentioned in this manual.
16939 @section List of contributions
16944 @i{Russel Adams} came up with the idea for drawers.
16946 @i{Suvayu Ali} has steadily helped on the mailing list, providing useful
16947 feedback on many features and several patches.
16949 @i{Luis Anaya} wrote @file{ox-man.el}.
16951 @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
16953 @i{Michael Brand} helped by reporting many bugs and testing many features.
16954 He also implemented the distinction between empty fields and 0-value fields
16955 in Org's spreadsheets.
16957 @i{Christophe Bataillon} created the great unicorn logo that we use on the
16960 @i{Alex Bochannek} provided a patch for rounding timestamps.
16962 @i{Jan Böcker} wrote @file{org-docview.el}.
16964 @i{Brad Bozarth} showed how to pull RSS feed data into Org mode files.
16966 @i{Tom Breton} wrote @file{org-choose.el}.
16968 @i{Charles Cave}'s suggestion sparked the implementation of templates
16969 for Remember, which are now templates for capture.
16971 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
16974 @i{Gregory Chernov} patched support for Lisp forms into table
16975 calculations and improved XEmacs compatibility, in particular by porting
16976 @file{nouline.el} to XEmacs.
16978 @i{Sacha Chua} suggested copying some linking code from Planner.
16980 @i{Toby S. Cubitt} contributed to the code for clock formats.
16982 @i{Baoqiu Cui} contributed the DocBook exporter. It has been deleted from
16983 Org 8.0: you can now export to Texinfo and export the @code{.texi} file to
16984 DocBook using @code{makeinfo}.
16986 @i{Eddward DeVilla} proposed and tested checkbox statistics. He also
16987 came up with the idea of properties, and that there should be an API for
16990 @i{Nick Dokos} tracked down several nasty bugs.
16992 @i{Kees Dullemond} used to edit projects lists directly in HTML and so
16993 inspired some of the early development, including HTML export. He also
16994 asked for a way to narrow wide table columns.
16996 @i{Thomas S. Dye} contributed documentation on Worg and helped integrating
16997 the Org-Babel documentation into the manual.
16999 @i{Christian Egli} converted the documentation into Texinfo format, inspired
17000 the agenda, patched CSS formatting into the HTML exporter, and wrote
17001 @file{org-taskjuggler.el}, which has been rewritten by Nicolas Goaziou as
17002 @file{ox-taskjuggler.el} for Org 8.0.
17004 @i{David Emery} provided a patch for custom CSS support in exported
17007 @i{Nic Ferrier} contributed mailcap and XOXO support.
17009 @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
17011 @i{John Foerch} figured out how to make incremental search show context
17012 around a match in a hidden outline tree.
17014 @i{Raimar Finken} wrote @file{org-git-line.el}.
17016 @i{Mikael Fornius} works as a mailing list moderator.
17018 @i{Austin Frank} works as a mailing list moderator.
17020 @i{Eric Fraga} drove the development of BEAMER export with ideas and
17023 @i{Barry Gidden} did proofreading the manual in preparation for the book
17024 publication through Network Theory Ltd.
17026 @i{Niels Giesen} had the idea to automatically archive DONE trees.
17028 @i{Nicolas Goaziou} rewrote much of the plain list code. He also wrote
17029 @file{org-element.el} and @file{org-export.el}, which was a huge step forward
17030 in implementing a clean framework for Org exporters.
17032 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
17034 @i{Brian Gough} of Network Theory Ltd publishes the Org mode manual as a
17037 @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
17038 task state change logging, and the clocktable. His clear explanations have
17039 been critical when we started to adopt the Git version control system.
17041 @i{Manuel Hermenegildo} has contributed various ideas, small fixes and
17044 @i{Phil Jackson} wrote @file{org-irc.el}.
17046 @i{Scott Jaderholm} proposed footnotes, control over whitespace between
17047 folded entries, and column view for properties.
17049 @i{Matt Jones} wrote @i{MobileOrg Android}.
17051 @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
17053 @i{Jonathan Leech-Pepin} wrote @file{ox-texinfo.el}.
17055 @i{Shidai Liu} ("Leo") asked for embedded @LaTeX{} and tested it. He also
17056 provided frequent feedback and some patches.
17058 @i{Matt Lundin} has proposed last-row references for table formulas and named
17059 invisible anchors. He has also worked a lot on the FAQ.
17061 @i{David Maus} wrote @file{org-atom.el}, maintains the issues file for Org,
17062 and is a prolific contributor on the mailing list with competent replies,
17063 small fixes and patches.
17065 @i{Jason F. McBrayer} suggested agenda export to CSV format.
17067 @i{Max Mikhanosha} came up with the idea of refiling and sticky agendas.
17069 @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
17072 @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
17075 @i{Richard Moreland} wrote @i{MobileOrg} for the iPhone.
17077 @i{Rick Moynihan} proposed allowing multiple TODO sequences in a file
17078 and being able to quickly restrict the agenda to a subtree.
17080 @i{Todd Neal} provided patches for links to Info files and Elisp forms.
17082 @i{Greg Newman} refreshed the unicorn logo into its current form.
17084 @i{Tim O'Callaghan} suggested in-file links, search options for general
17085 file links, and TAGS.
17087 @i{Osamu Okano} wrote @file{orgcard2ref.pl}, a Perl program to create a text
17088 version of the reference card.
17090 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
17093 @i{Oliver Oppitz} suggested multi-state TODO items.
17095 @i{Scott Otterson} sparked the introduction of descriptive text for
17096 links, among other things.
17098 @i{Pete Phillips} helped during the development of the TAGS feature, and
17099 provided frequent feedback.
17101 @i{Francesco Pizzolante} provided patches that helped speeding up the agenda
17104 @i{Martin Pohlack} provided the code snippet to bundle character insertion
17105 into bundles of 20 for undo.
17107 @i{T.V. Raman} reported bugs and suggested improvements.
17109 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
17112 @i{Paul Rivier} provided the basic implementation of named footnotes. He
17113 also acted as mailing list moderator for some time.
17115 @i{Kevin Rogers} contributed code to access VM files on remote hosts.
17117 @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
17118 conflict with @file{allout.el}.
17120 @i{Jason Riedy} generalized the send-receive mechanism for Orgtbl tables with
17123 @i{Philip Rooke} created the Org reference card, provided lots
17124 of feedback, developed and applied standards to the Org documentation.
17126 @i{Christian Schlauer} proposed angular brackets around links, among
17129 @i{Christopher Schmidt} reworked @code{orgstruct-mode} so that users can
17130 enjoy folding in non-org buffers by using Org headlines in comments.
17132 @i{Paul Sexton} wrote @file{org-ctags.el}.
17134 Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
17135 @file{organizer-mode.el}.
17137 @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal
17138 examples, and remote highlighting for referenced code lines.
17140 @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
17141 now packaged into Org's @file{contrib} directory.
17143 @i{Daniel Sinder} came up with the idea of internal archiving by locking
17146 @i{Dale Smith} proposed link abbreviations.
17148 @i{James TD Smith} has contributed a large number of patches for useful
17149 tweaks and features.
17151 @i{Adam Spiers} asked for global linking commands, inspired the link
17152 extension system, added support for mairix, and proposed the mapping API.
17154 @i{Ulf Stegemann} created the table to translate special symbols to HTML,
17155 @LaTeX{}, UTF-8, Latin-1 and ASCII.
17157 @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content
17158 with links transformation to Org syntax.
17160 @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
17161 chapter about publishing.
17163 @i{Jambunathan K} contributed the ODT exporter and rewrote the HTML exporter.
17165 @i{Sebastien Vauban} reported many issues with @LaTeX{} and BEAMER export and
17166 enabled source code highlighting in Gnus.
17168 @i{Stefan Vollmar} organized a video-recorded talk at the
17169 Max-Planck-Institute for Neurology. He also inspired the creation of a
17170 concept index for HTML export.
17172 @i{J@"urgen Vollmer} contributed code generating the table of contents
17175 @i{Samuel Wales} has provided important feedback and bug reports.
17177 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
17180 @i{David Wainberg} suggested archiving, and improvements to the linking
17183 @i{Carsten Wimmer} suggested some changes and helped fix a bug in
17186 @i{Roland Winkler} requested additional key bindings to make Org
17189 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
17190 and contributed various ideas and code snippets.
17194 @node GNU Free Documentation License, Main Index, History and Acknowledgments, Top
17195 @appendix GNU Free Documentation License
17196 @include doclicense.texi
17199 @node Main Index, Key Index, GNU Free Documentation License, Top
17200 @unnumbered Concept index
17204 @node Key Index, Command and Function Index, Main Index, Top
17205 @unnumbered Key index
17209 @node Command and Function Index, Variable Index, Key Index, Top
17210 @unnumbered Command and function index
17214 @node Variable Index, , Command and Function Index, Top
17215 @unnumbered Variable index
17217 This is not a complete index of variables and faces, only the ones that are
17218 mentioned in the manual. For a more complete list, use @kbd{M-x
17219 org-customize @key{RET}} and then click yourself through the tree.
17225 @c Local variables:
17227 @c indent-tabs-mode: nil
17228 @c paragraph-start: "
\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|\f\\|[ ]*$"
17229 @c paragraph-separate: "
\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|[ \f]*$"
17233 @c LocalWords: webdavhost pre