4 @setfilename ../../info/org
5 @settitle The Org Manual
10 @c Use proper quote and backtick for code sections in PDF output
11 @c Cf. Texinfo manual 14.2
12 @set txicodequoteundirected
13 @set txicodequotebacktick
15 @c Version and Contact Info
16 @set MAINTAINERSITE @uref{http://orgmode.org,maintainers webpage}
17 @set AUTHOR Carsten Dominik
18 @set MAINTAINER Carsten Dominik
19 @set MAINTAINEREMAIL @email{carsten at orgmode dot org}
20 @set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer}
25 @c -----------------------------------------------------------------------------
27 @c Macro definitions for commands and keys
28 @c =======================================
30 @c The behavior of the key/command macros will depend on the flag cmdnames
31 @c When set, commands names are shown. When clear, they are not shown.
35 @c Below we define the following macros for Org key tables:
37 @c orgkey{key} A key item
38 @c orgcmd{key,cmd} Key with command name
39 @c xorgcmd{key,cmd} Key with command name as @itemx
40 @c orgcmdnki{key,cmd} Like orgcmd, but do not index the key
41 @c orgcmdtkc{text,key,cmd} Like orgcmd,special text instead of key
42 @c orgcmdkkc{key1,key2,cmd} Two keys with one command name, use "or"
43 @c orgcmdkxkc{key1,key2,cmd} Two keys with one command name, but
44 @c different functions, so format as @itemx
45 @c orgcmdkskc{key1,key2,cmd} Same as orgcmdkkc, but use "or short"
46 @c xorgcmdkskc{key1,key2,cmd} Same as previous, but use @itemx
47 @c orgcmdkkcc{key1,key2,cmd1,cmd2} Two keys and two commands
49 @c a key but no command
61 @c one key with a command
62 @c Inserts: @item KEY COMMAND
63 @macro orgcmd{key,command}
68 @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
71 @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
80 @c One key with one command, formatted using @itemx
81 @c Inserts: @itemx KEY COMMAND
82 @macro xorgcmd{key,command}
87 @itemx @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
90 @itemx @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
99 @c one key with a command, bit do not index the key
100 @c Inserts: @item KEY COMMAND
101 @macro orgcmdnki{key,command}
105 @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
108 @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
116 @c one key with a command, and special text to replace key in item
117 @c Inserts: @item TEXT COMMAND
118 @macro orgcmdtkc{text,key,command}
123 @item @kbd{\text\} @hskip 0pt plus 1filll @code{\command\}
126 @item @kbd{\text\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
135 @c two keys with one command
136 @c Inserts: @item KEY1 or KEY2 COMMAND
137 @macro orgcmdkkc{key1,key2,command}
143 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
146 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
152 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\}
156 @c Two keys with one command name, but different functions, so format as
158 @c Inserts: @item KEY1
159 @c @itemx KEY2 COMMAND
160 @macro orgcmdkxkc{key1,key2,command}
167 @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
171 @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
182 @c Same as previous, but use "or short"
183 @c Inserts: @item KEY1 or short KEY2 COMMAND
184 @macro orgcmdkskc{key1,key2,command}
190 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
193 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
199 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
203 @c Same as previous, but use @itemx
204 @c Inserts: @itemx KEY1 or short KEY2 COMMAND
205 @macro xorgcmdkskc{key1,key2,command}
211 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
214 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
220 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
224 @c two keys with two commands
225 @c Inserts: @item KEY1 COMMAND1
226 @c @itemx KEY2 COMMAND2
227 @macro orgcmdkkcc{key1,key2,command1,command2}
234 @item @kbd{\key1\} @hskip 0pt plus 1filll @code{\command1\}
235 @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command2\}
238 @item @kbd{\key1\} @tie{}@tie{}@tie{}@tie{}(@code{\command1\})
239 @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command2\})
249 @c -----------------------------------------------------------------------------
252 @c @hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed}
255 @c Subheadings inside a table.
256 @macro tsubheading{text}
258 @subsubheading \text\
266 This manual is for Org version @value{VERSION}.
268 Copyright @copyright{} 2004-2012 Free Software Foundation, Inc.
271 Permission is granted to copy, distribute and/or modify this document
272 under the terms of the GNU Free Documentation License, Version 1.3 or
273 any later version published by the Free Software Foundation; with no
274 Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
275 and with the Back-Cover Texts as in (a) below. A copy of the license
276 is included in the section entitled ``GNU Free Documentation License.''
278 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
279 modify this GNU manual. Buying copies from the FSF supports it in
280 developing GNU and promoting software freedom.''
282 This document is part of a collection distributed under the GNU Free
283 Documentation License. If you want to distribute this document
284 separately from the collection, you can do so by adding a copy of the
285 license to the document, as described in section 6 of the license.
291 * Org Mode: (org). Outline-based notes management and organizer
295 @title The Org Manual
297 @subtitle Release @value{VERSION}
298 @author by Carsten Dominik
299 with contributions by David O'Toole, Bastien Guerry, Philip Rooke, Dan Davison, Eric Schulte, Thomas Dye and Jambunathan K.
301 @c The following two commands start the copyright page.
303 @vskip 0pt plus 1filll
307 @c Output the table of contents at the beginning.
311 @node Top, Introduction, (dir), (dir)
318 * Introduction:: Getting started
319 * Document Structure:: A tree works like your brain
320 * Tables:: Pure magic for quick formatting
321 * Hyperlinks:: Notes in context
322 * TODO Items:: Every tree branch can be a TODO item
323 * Tags:: Tagging headlines and matching sets of tags
324 * Properties and Columns:: Storing information about an entry
325 * Dates and Times:: Making items useful for planning
326 * Capture - Refile - Archive:: The ins and outs for projects
327 * Agenda Views:: Collecting information into views
328 * Markup:: Prepare text for rich export
329 * Exporting:: Sharing and publishing of notes
330 * Publishing:: Create a web site of linked Org files
331 * Working With Source Code:: Export, evaluate, and tangle code blocks
332 * Miscellaneous:: All the rest which did not fit elsewhere
333 * Hacking:: How to hack your way around
334 * MobileOrg:: Viewing and capture on a mobile device
335 * History and Acknowledgments:: How Org came into being
336 * Main Index:: An index of Org's concepts and features
337 * Key Index:: Key bindings and where they are described
338 * Command and Function Index:: Command names and some internal functions
339 * Variable Index:: Variables mentioned in the manual
342 --- The Detailed Node Listing ---
346 * Summary:: Brief summary of what Org does
347 * Installation:: How to install a downloaded version of Org
348 * Activation:: How to activate Org for certain buffers
349 * Feedback:: Bug reports, ideas, patches etc.
350 * Conventions:: Type-setting conventions in the manual
354 * Outlines:: Org is based on Outline mode
355 * Headlines:: How to typeset Org tree headlines
356 * Visibility cycling:: Show and hide, much simplified
357 * Motion:: Jumping to other headlines
358 * Structure editing:: Changing sequence and level of headlines
359 * Sparse trees:: Matches embedded in context
360 * Plain lists:: Additional structure within an entry
361 * Drawers:: Tucking stuff away
362 * Blocks:: Folding blocks
363 * Footnotes:: How footnotes are defined in Org's syntax
364 * Orgstruct mode:: Structure editing outside Org
368 * Built-in table editor:: Simple tables
369 * Column width and alignment:: Overrule the automatic settings
370 * Column groups:: Grouping to trigger vertical lines
371 * Orgtbl mode:: The table editor as minor mode
372 * The spreadsheet:: The table editor has spreadsheet capabilities
373 * Org-Plot:: Plotting from org tables
377 * References:: How to refer to another field or range
378 * Formula syntax for Calc:: Using Calc to compute stuff
379 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
380 * Durations and time values:: How to compute durations and time values
381 * Field and range formulas:: Formula for specific (ranges of) fields
382 * Column formulas:: Formulas valid for an entire column
383 * Editing and debugging formulas:: Fixing formulas
384 * Updating the table:: Recomputing all dependent fields
385 * Advanced features:: Field and column names, parameters and automatic recalc
389 * Link format:: How links in Org are formatted
390 * Internal links:: Links to other places in the current file
391 * External links:: URL-like links to the world
392 * Handling links:: Creating, inserting and following
393 * Using links outside Org:: Linking from my C source code?
394 * Link abbreviations:: Shortcuts for writing complex links
395 * Search options:: Linking to a specific location
396 * Custom searches:: When the default search is not enough
400 * Radio targets:: Make targets trigger links in plain text
404 * TODO basics:: Marking and displaying TODO entries
405 * TODO extensions:: Workflow and assignments
406 * Progress logging:: Dates and notes for progress
407 * Priorities:: Some things are more important than others
408 * Breaking down tasks:: Splitting a task into manageable pieces
409 * Checkboxes:: Tick-off lists
411 Extended use of TODO keywords
413 * Workflow states:: From TODO to DONE in steps
414 * TODO types:: I do this, Fred does the rest
415 * Multiple sets in one file:: Mixing it all, and still finding your way
416 * Fast access to TODO states:: Single letter selection of a state
417 * Per-file keywords:: Different files, different requirements
418 * Faces for TODO keywords:: Highlighting states
419 * TODO dependencies:: When one task needs to wait for others
423 * Closing items:: When was this entry marked DONE?
424 * Tracking TODO state changes:: When did the status change?
425 * Tracking your habits:: How consistent have you been?
429 * Tag inheritance:: Tags use the tree structure of the outline
430 * Setting tags:: How to assign tags to a headline
431 * Tag searches:: Searching for combinations of tags
433 Properties and columns
435 * Property syntax:: How properties are spelled out
436 * Special properties:: Access to other Org mode features
437 * Property searches:: Matching property values
438 * Property inheritance:: Passing values down the tree
439 * Column view:: Tabular viewing and editing
440 * Property API:: Properties for Lisp programmers
444 * Defining columns:: The COLUMNS format property
445 * Using column view:: How to create and use column view
446 * Capturing column view:: A dynamic block for column view
450 * Scope of column definitions:: Where defined, where valid?
451 * Column attributes:: Appearance and content of a column
455 * Timestamps:: Assigning a time to a tree entry
456 * Creating timestamps:: Commands which insert timestamps
457 * Deadlines and scheduling:: Planning your work
458 * Clocking work time:: Tracking how long you spend on a task
459 * Effort estimates:: Planning work effort in advance
460 * Relative timer:: Notes with a running timer
461 * Countdown timer:: Starting a countdown timer for a task
465 * The date/time prompt:: How Org mode helps you entering date and time
466 * Custom time format:: Making dates look different
468 Deadlines and scheduling
470 * Inserting deadline/schedule:: Planning items
471 * Repeated tasks:: Items that show up again and again
475 * Clocking commands:: Starting and stopping a clock
476 * The clock table:: Detailed reports
477 * Resolving idle time:: Resolving time when you've been idle
479 Capture - Refile - Archive
481 * Capture:: Capturing new stuff
482 * Attachments:: Add files to tasks
483 * RSS Feeds:: Getting input from RSS feeds
484 * Protocols:: External (e.g.@: Browser) access to Emacs and Org
485 * Refiling notes:: Moving a tree from one place to another
486 * Archiving:: What to do with finished projects
490 * Setting up capture:: Where notes will be stored
491 * Using capture:: Commands to invoke and terminate capture
492 * Capture templates:: Define the outline of different note types
496 * Template elements:: What is needed for a complete template entry
497 * Template expansion:: Filling in information about time and context
501 * Moving subtrees:: Moving a tree to an archive file
502 * Internal archiving:: Switch off a tree but keep it in the file
506 * Agenda files:: Files being searched for agenda information
507 * Agenda dispatcher:: Keyboard access to agenda views
508 * Built-in agenda views:: What is available out of the box?
509 * Presentation and sorting:: How agenda items are prepared for display
510 * Agenda commands:: Remote editing of Org trees
511 * Custom agenda views:: Defining special searches and views
512 * Exporting Agenda Views:: Writing a view to a file
513 * Agenda column view:: Using column view for collected entries
515 The built-in agenda views
517 * Weekly/daily agenda:: The calendar page with current tasks
518 * Global TODO list:: All unfinished action items
519 * Matching tags and properties:: Structured information with fine-tuned search
520 * Timeline:: Time-sorted view for single file
521 * Search view:: Find entries by searching for text
522 * Stuck projects:: Find projects you need to review
524 Presentation and sorting
526 * Categories:: Not all tasks are equal
527 * Time-of-day specifications:: How the agenda knows the time
528 * Sorting of agenda items:: The order of things
532 * Storing searches:: Type once, use often
533 * Block agenda:: All the stuff you need in a single buffer
534 * Setting Options:: Changing the rules
536 Markup for rich export
538 * Structural markup elements:: The basic structure as seen by the exporter
539 * Images and tables:: Tables and Images will be included
540 * Literal examples:: Source code examples with special formatting
541 * Include files:: Include additional files into a document
542 * Index entries:: Making an index
543 * Macro replacement:: Use macros to create complex output
544 * Embedded @LaTeX{}:: LaTeX can be freely used inside Org documents
546 Structural markup elements
548 * Document title:: Where the title is taken from
549 * Headings and sections:: The document structure as seen by the exporter
550 * Table of contents:: The if and where of the table of contents
551 * Initial text:: Text before the first heading?
553 * Paragraphs:: Paragraphs
554 * Footnote markup:: Footnotes
555 * Emphasis and monospace:: Bold, italic, etc.
556 * Horizontal rules:: Make a line
557 * Comment lines:: What will *not* be exported
561 * Special symbols:: Greek letters and other symbols
562 * Subscripts and superscripts:: Simple syntax for raising/lowering text
563 * @LaTeX{} fragments:: Complex formulas made easy
564 * Previewing @LaTeX{} fragments:: What will this snippet look like?
565 * CDLaTeX mode:: Speed up entering of formulas
569 * Selective export:: Using tags to select and exclude trees
570 * Export options:: Per-file export settings
571 * The export dispatcher:: How to access exporter commands
572 * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
573 * HTML export:: Exporting to HTML
574 * @LaTeX{} and PDF export:: Exporting to @LaTeX{}, and processing to PDF
575 * DocBook export:: Exporting to DocBook
576 * OpenDocument Text export:: Exporting to OpenDocument Text
577 * TaskJuggler export:: Exporting to TaskJuggler
578 * Freemind export:: Exporting to Freemind mind maps
579 * XOXO export:: Exporting to XOXO
580 * iCalendar export:: Exporting in iCalendar format
584 * HTML Export commands:: How to invoke HTML export
585 * HTML preamble and postamble:: How to insert a preamble and a postamble
586 * Quoting HTML tags:: Using direct HTML in Org mode
587 * Links in HTML export:: How links will be interpreted and formatted
588 * Tables in HTML export:: How to modify the formatting of tables
589 * Images in HTML export:: How to insert figures into HTML output
590 * Math formatting in HTML export:: Beautiful math also on the web
591 * Text areas in HTML export:: An alternative way to show an example
592 * CSS support:: Changing the appearance of the output
593 * JavaScript support:: Info and Folding in a web browser
595 @LaTeX{} and PDF export
597 * @LaTeX{}/PDF export commands::
598 * Header and sectioning:: Setting up the export file structure
599 * Quoting @LaTeX{} code:: Incorporating literal @LaTeX{} code
600 * Tables in @LaTeX{} export:: Options for exporting tables to @LaTeX{}
601 * Images in @LaTeX{} export:: How to insert figures into @LaTeX{} output
602 * Beamer class export:: Turning the file into a presentation
606 * DocBook export commands:: How to invoke DocBook export
607 * Quoting DocBook code:: Incorporating DocBook code in Org files
608 * Recursive sections:: Recursive sections in DocBook
609 * Tables in DocBook export:: Tables are exported as HTML tables
610 * Images in DocBook export:: How to insert figures into DocBook output
611 * Special characters:: How to handle special characters
613 OpenDocument Text export
615 * Pre-requisites for @acronym{ODT} export:: What packages @acronym{ODT} exporter relies on
616 * @acronym{ODT} export commands:: How to invoke @acronym{ODT} export
617 * Applying custom styles:: How to apply custom styles to the output
618 * Links in @acronym{ODT} export:: How links will be interpreted and formatted
619 * Tables in @acronym{ODT} export:: How Tables are exported
620 * Images in @acronym{ODT} export:: How to insert images
621 * Math formatting in @acronym{ODT} export:: How @LaTeX{} fragments are formatted
622 * Literal examples in @acronym{ODT} export:: How source and example blocks are formatted
623 * Advanced topics in @acronym{ODT} export:: Read this if you are a power user
625 Math formatting in @acronym{ODT} export
627 * Working with @LaTeX{} math snippets:: How to embed @LaTeX{} math fragments
628 * Working with MathML or OpenDocument formula files:: How to embed equations in native format
630 Advanced topics in @acronym{ODT} export
632 * Exporting and converting to other formats:: How to produce @samp{pdf} and other formats
633 * Working with OpenDocument style files:: Explore the internals
634 * Creating one-off styles:: How to produce custom highlighting etc
635 * Customizing tables in @acronym{ODT} export:: How to define and use Table templates
636 * Validating OpenDocument XML:: How to debug corrupt OpenDocument files
640 * Configuration:: Defining projects
641 * Uploading files:: How to get files up on the server
642 * Sample configuration:: Example projects
643 * Triggering publication:: Publication commands
647 * Project alist:: The central configuration variable
648 * Sources and destinations:: From here to there
649 * Selecting files:: What files are part of the project?
650 * Publishing action:: Setting the function doing the publishing
651 * Publishing options:: Tweaking HTML/@LaTeX{} export
652 * Publishing links:: Which links keep working after publishing?
653 * Sitemap:: Generating a list of all pages
654 * Generating an index:: An index that reaches across pages
658 * Simple example:: One-component publishing
659 * Complex example:: A multi-component publishing example
661 Working with source code
663 * Structure of code blocks:: Code block syntax described
664 * Editing source code:: Language major-mode editing
665 * Exporting code blocks:: Export contents and/or results
666 * Extracting source code:: Create pure source code files
667 * Evaluating code blocks:: Place results of evaluation in the Org mode buffer
668 * Library of Babel:: Use and contribute to a library of useful code blocks
669 * Languages:: List of supported code block languages
670 * Header arguments:: Configure code block functionality
671 * Results of evaluation:: How evaluation results are handled
672 * Noweb reference syntax:: Literate programming in Org mode
673 * Key bindings and useful functions:: Work quickly with code blocks
674 * Batch execution:: Call functions from the command line
678 * Using header arguments:: Different ways to set header arguments
679 * Specific header arguments:: List of header arguments
681 Using header arguments
683 * System-wide header arguments:: Set global default values
684 * Language-specific header arguments:: Set default values by language
685 * Buffer-wide header arguments:: Set default values for a specific buffer
686 * Header arguments in Org mode properties:: Set default values for a buffer or heading
687 * Code block specific header arguments:: The most common way to set values
688 * Header arguments in function calls:: The most specific level
690 Specific header arguments
692 * var:: Pass arguments to code blocks
693 * results:: Specify the type of results and how they will
694 be collected and handled
695 * file:: Specify a path for file output
696 * dir:: Specify the default (possibly remote)
697 directory for code block execution
698 * exports:: Export code and/or results
699 * tangle:: Toggle tangling and specify file name
700 * mkdirp:: Toggle creation of parent directories of target
701 files during tangling
702 * comments:: Toggle insertion of comments in tangled
704 * padline:: Control insertion of padding lines in tangled
706 * no-expand:: Turn off variable assignment and noweb
707 expansion during tangling
708 * session:: Preserve the state of code evaluation
709 * noweb:: Toggle expansion of noweb references
710 * noweb-ref:: Specify block's noweb reference resolution target
711 * cache:: Avoid re-evaluating unchanged code blocks
712 * sep:: Delimiter for writing tabular results outside Org
713 * hlines:: Handle horizontal lines in tables
714 * colnames:: Handle column names in tables
715 * rownames:: Handle row names in tables
716 * shebang:: Make tangled files executable
717 * eval:: Limit evaluation of specific code blocks
721 * Completion:: M-TAB knows what you need
722 * Easy Templates:: Quick insertion of structural elements
723 * Speed keys:: Electric commands at the beginning of a headline
724 * Code evaluation security:: Org mode files evaluate inline code
725 * Customization:: Adapting Org to your taste
726 * In-buffer settings:: Overview of the #+KEYWORDS
727 * The very busy C-c C-c key:: When in doubt, press C-c C-c
728 * Clean view:: Getting rid of leading stars in the outline
729 * TTY keys:: Using Org on a tty
730 * Interaction:: Other Emacs packages
731 * org-crypt.el:: Encrypting Org files
733 Interaction with other packages
735 * Cooperation:: Packages Org cooperates with
736 * Conflicts:: Packages that lead to conflicts
740 * Hooks:: Who to reach into Org's internals
741 * Add-on packages:: Available extensions
742 * Adding hyperlink types:: New custom link types
743 * Context-sensitive commands:: How to add functionality to such commands
744 * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
745 * Dynamic blocks:: Automatically filled blocks
746 * Special agenda views:: Customized views
747 * Extracting agenda information:: Postprocessing of agenda information
748 * Using the property API:: Writing programs that use entry properties
749 * Using the mapping API:: Mapping over all or selected entries
751 Tables and lists in arbitrary syntax
753 * Radio tables:: Sending and receiving radio tables
754 * A @LaTeX{} example:: Step by step, almost a tutorial
755 * Translator functions:: Copy and modify
756 * Radio lists:: Doing the same for lists
760 * Setting up the staging area:: Where to interact with the mobile device
761 * Pushing to MobileOrg:: Uploading Org files and agendas
762 * Pulling from MobileOrg:: Integrating captured and flagged items
767 @node Introduction, Document Structure, Top, Top
768 @chapter Introduction
772 * Summary:: Brief summary of what Org does
773 * Installation:: How to install a downloaded version of Org
774 * Activation:: How to activate Org for certain buffers
775 * Feedback:: Bug reports, ideas, patches etc.
776 * Conventions:: Type-setting conventions in the manual
779 @node Summary, Installation, Introduction, Introduction
783 Org is a mode for keeping notes, maintaining TODO lists, and doing
784 project planning with a fast and effective plain-text system.
786 Org develops organizational tasks around NOTES files that contain
787 lists or information about projects as plain text. Org is
788 implemented on top of Outline mode, which makes it possible to keep the
789 content of large files well structured. Visibility cycling and
790 structure editing help to work with the tree. Tables are easily created
791 with a built-in table editor. Org supports TODO items, deadlines,
792 timestamps, and scheduling. It dynamically compiles entries into an
793 agenda that utilizes and smoothly integrates much of the Emacs calendar
794 and diary. Plain text URL-like links connect to websites, emails,
795 Usenet messages, BBDB entries, and any files related to the projects.
796 For printing and sharing of notes, an Org file can be exported as a
797 structured ASCII file, as HTML, or (TODO and agenda items only) as an
798 iCalendar file. It can also serve as a publishing tool for a set of
801 As a project planning environment, Org works by adding metadata to outline
802 nodes. Based on this data, specific entries can be extracted in queries and
803 create dynamic @i{agenda views}.
805 Org mode contains the Org Babel environment which allows you to work with
806 embedded source code blocks in a file, to facilitate code evaluation,
807 documentation, and literate programming techniques.
809 Org's automatic, context-sensitive table editor with spreadsheet
810 capabilities can be integrated into any major mode by activating the
811 minor Orgtbl mode. Using a translation step, it can be used to maintain
812 tables in arbitrary file types, for example in @LaTeX{}. The structure
813 editing and list creation capabilities can be used outside Org with
814 the minor Orgstruct mode.
816 Org keeps simple things simple. When first fired up, it should
817 feel like a straightforward, easy to use outliner. Complexity is not
818 imposed, but a large amount of functionality is available when you need
819 it. Org is a toolbox and can be used in different ways and for different
823 @r{@bullet{} an outline extension with visibility cycling and structure editing}
824 @r{@bullet{} an ASCII system and table editor for taking structured notes}
825 @r{@bullet{} a TODO list editor}
826 @r{@bullet{} a full agenda and planner with deadlines and work scheduling}
827 @pindex GTD, Getting Things Done
828 @r{@bullet{} an environment in which to implement David Allen's GTD system}
829 @r{@bullet{} a simple hypertext system, with HTML and @LaTeX{} export}
830 @r{@bullet{} a publishing tool to create a set of interlinked webpages}
831 @r{@bullet{} an environment for literate programming}
836 There is a website for Org which provides links to the newest
837 version of Org, as well as additional information, frequently asked
838 questions (FAQ), links to tutorials, etc@. This page is located at
839 @uref{http://orgmode.org}.
841 @cindex print edition
842 The version 7.3 of this manual is available as a
843 @uref{http://www.network-theory.co.uk/org/manual/, paperback book from Network
849 @node Installation, Activation, Summary, Introduction
850 @section Installation
854 @b{Important:} @i{If you are using a version of Org that is part of the Emacs
855 distribution or an XEmacs package, please skip this section and go directly
856 to @ref{Activation}. To see what version of Org (if any) is part of your
857 Emacs distribution, type @kbd{M-x load-library RET org} and then @kbd{M-x
860 If you have downloaded Org from the Web, either as a distribution @file{.zip}
861 or @file{.tar} file, or as a Git archive, you must take the following steps
862 to install it: go into the unpacked Org distribution directory and edit the
863 top section of the file @file{Makefile}. You must set the name of the Emacs
864 binary (likely either @file{emacs} or @file{xemacs}), and the paths to the
865 directories where local Lisp and Info files are kept. If you don't have
866 access to the system-wide directories, you can simply run Org directly from
867 the distribution directory by adding the @file{lisp} subdirectory to the
868 Emacs load path. To do this, add the following line to @file{.emacs}:
871 (setq load-path (cons "~/path/to/orgdir/lisp" load-path))
875 If you plan to use code from the @file{contrib} subdirectory, do a similar
876 step for this directory:
879 (setq load-path (cons "~/path/to/orgdir/contrib/lisp" load-path))
882 @noindent Now byte-compile the Lisp files with the shell command:
888 @noindent If you are running Org from the distribution directory, this is
889 all. If you want to install Org into the system directories, use (as
896 Installing Info files is system dependent, because of differences in the
897 @file{install-info} program. The following should correctly install the Info
898 files on most systems, please send a bug report if not@footnote{The output
899 from install-info (if any) is also system dependent. In particular Debian
900 and its derivatives use two different versions of install-info and you may
904 This is not dpkg install-info anymore, but GNU install-info
905 See the man page for ginstall-info for command line arguments
908 @noindent which can be safely ignored.}.
914 Then add the following line to @file{.emacs}. It is needed so that
915 Emacs can autoload functions that are located in files not immediately loaded
916 when Org mode starts.
918 (require 'org-install)
921 Do not forget to activate Org as described in the following section.
924 @node Activation, Feedback, Installation, Introduction
928 @cindex global key bindings
929 @cindex key bindings, global
931 To make sure files with extension @file{.org} use Org mode, add the following
932 line to your @file{.emacs} file.
934 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
936 @noindent Org mode buffers need font-lock to be turned on - this is the
937 default in Emacs@footnote{If you don't use font-lock globally, turn it on in
938 Org buffer with @code{(add-hook 'org-mode-hook 'turn-on-font-lock)}}.
940 The four Org commands @command{org-store-link}, @command{org-capture},
941 @command{org-agenda}, and @command{org-iswitchb} should be accessible through
942 global keys (i.e.@: anywhere in Emacs, not just in Org buffers). Here are
943 suggested bindings for these keys, please modify the keys to your own
946 (global-set-key "\C-cl" 'org-store-link)
947 (global-set-key "\C-cc" 'org-capture)
948 (global-set-key "\C-ca" 'org-agenda)
949 (global-set-key "\C-cb" 'org-iswitchb)
952 @cindex Org mode, turning on
953 With this setup, all files with extension @samp{.org} will be put
954 into Org mode. As an alternative, make the first line of a file look
958 MY PROJECTS -*- mode: org; -*-
961 @vindex org-insert-mode-line-in-empty-file
962 @noindent which will select Org mode for this buffer no matter what
963 the file's name is. See also the variable
964 @code{org-insert-mode-line-in-empty-file}.
966 Many commands in Org work on the region if the region is @i{active}. To make
967 use of this, you need to have @code{transient-mark-mode}
968 (@code{zmacs-regions} in XEmacs) turned on. In Emacs 23 this is the default,
969 in Emacs 22 you need to do this yourself with
971 (transient-mark-mode 1)
973 @noindent If you do not like @code{transient-mark-mode}, you can create an
974 active region by using the mouse to select a region, or pressing
975 @kbd{C-@key{SPC}} twice before moving the cursor.
977 @node Feedback, Conventions, Activation, Introduction
984 If you find problems with Org, or if you have questions, remarks, or ideas
985 about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}.
986 If you are not a member of the mailing list, your mail will be passed to the
987 list after a moderator has approved it@footnote{Please consider subscribing
988 to the mailing list, in order to minimize the work the mailing list
989 moderators have to do.}.
991 For bug reports, please first try to reproduce the bug with the latest
992 version of Org available---if you are running an outdated version, it is
993 quite possible that the bug has been fixed already. If the bug persists,
994 prepare a report and provide as much information as possible, including the
995 version information of Emacs (@kbd{M-x emacs-version @key{RET}}) and Org
996 (@kbd{M-x org-version @key{RET}}), as well as the Org related setup in
997 @file{.emacs}. The easiest way to do this is to use the command
999 @kbd{M-x org-submit-bug-report}
1001 @noindent which will put all this information into an Emacs mail buffer so
1002 that you only need to add your description. If you re not sending the Email
1003 from within Emacs, please copy and paste the content into your Email program.
1005 Sometimes you might face a problem due to an error in your Emacs or Org mode
1006 setup. Before reporting a bug, it is very helpful to start Emacs with minimal
1007 customizations and reproduce the problem. Doing so often helps you determine
1008 if the problem is with your customization or with Org mode itself. You can
1009 start a typical minimal session with a command like the example below.
1012 $ emacs -Q -l /path/to/minimal-org.el
1015 However if you are using Org mode as distributed with Emacs, a minimal setup
1016 is not necessary. In that case it is sufficient to start Emacs as @code{emacs
1017 -Q}. The @code{minimal-org.el} setup file can have contents as shown below.
1020 ;;; Minimal setup to load latest `org-mode'
1022 ;; activate debugging
1023 (setq debug-on-error t
1027 ;; add latest org-mode to load path
1028 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/lisp"))
1029 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/contrib/lisp"))
1032 (require 'org-install)
1035 If an error occurs, a backtrace can be very useful (see below on how to
1036 create one). Often a small example file helps, along with clear information
1040 @item What exactly did you do?
1041 @item What did you expect to happen?
1042 @item What happened instead?
1044 @noindent Thank you for helping to improve this program.
1046 @subsubheading How to create a useful backtrace
1048 @cindex backtrace of an error
1049 If working with Org produces an error with a message you don't
1050 understand, you may have hit a bug. The best way to report this is by
1051 providing, in addition to what was mentioned above, a @emph{backtrace}.
1052 This is information from the built-in debugger about where and how the
1053 error occurred. Here is how to produce a useful backtrace:
1057 Reload uncompiled versions of all Org mode Lisp files. The backtrace
1058 contains much more information if it is produced with uncompiled code.
1061 C-u M-x org-reload RET
1064 or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the
1067 Go to the @code{Options} menu and select @code{Enter Debugger on Error}
1068 (XEmacs has this option in the @code{Troubleshooting} sub-menu).
1070 Do whatever you have to do to hit the error. Don't forget to
1071 document the steps you take.
1073 When you hit the error, a @file{*Backtrace*} buffer will appear on the
1074 screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and
1075 attach it to your bug report.
1078 @node Conventions, , Feedback, Introduction
1079 @section Typesetting conventions used in this manual
1081 Org uses three types of keywords: TODO keywords, tags, and property
1082 names. In this manual we use the following conventions:
1087 TODO keywords are written with all capitals, even if they are
1091 User-defined tags are written in lowercase; built-in tags with special
1092 meaning are written with all capitals.
1095 User-defined properties are capitalized; built-in properties with
1096 special meaning are written with all capitals.
1099 The manual lists both the keys and the corresponding commands for accessing
1100 functionality. Org mode often uses the same key for different functions,
1101 depending on context. The command that is bound to such keys has a generic
1102 name, like @code{org-metaright}. In the manual we will, wherever possible,
1103 give the function that is internally called by the generic command. For
1104 example, in the chapter on document structure, @kbd{M-@key{right}} will be
1105 listed to call @code{org-do-demote}, while in the chapter on tables, it will
1106 be listed to call org-table-move-column-right.
1108 If you prefer, you can compile the manual without the command names by
1109 unsetting the flag @code{cmdnames} in @file{org.texi}.
1111 @node Document Structure, Tables, Introduction, Top
1112 @chapter Document structure
1113 @cindex document structure
1114 @cindex structure of document
1116 Org is based on Outline mode and provides flexible commands to
1117 edit the structure of the document.
1120 * Outlines:: Org is based on Outline mode
1121 * Headlines:: How to typeset Org tree headlines
1122 * Visibility cycling:: Show and hide, much simplified
1123 * Motion:: Jumping to other headlines
1124 * Structure editing:: Changing sequence and level of headlines
1125 * Sparse trees:: Matches embedded in context
1126 * Plain lists:: Additional structure within an entry
1127 * Drawers:: Tucking stuff away
1128 * Blocks:: Folding blocks
1129 * Footnotes:: How footnotes are defined in Org's syntax
1130 * Orgstruct mode:: Structure editing outside Org
1133 @node Outlines, Headlines, Document Structure, Document Structure
1136 @cindex Outline mode
1138 Org is implemented on top of Outline mode. Outlines allow a
1139 document to be organized in a hierarchical structure, which (at least
1140 for me) is the best representation of notes and thoughts. An overview
1141 of this structure is achieved by folding (hiding) large parts of the
1142 document to show only the general document structure and the parts
1143 currently being worked on. Org greatly simplifies the use of
1144 outlines by compressing the entire show/hide functionality into a single
1145 command, @command{org-cycle}, which is bound to the @key{TAB} key.
1147 @node Headlines, Visibility cycling, Outlines, Document Structure
1150 @cindex outline tree
1151 @vindex org-special-ctrl-a/e
1152 @vindex org-special-ctrl-k
1153 @vindex org-ctrl-k-protect-subtree
1155 Headlines define the structure of an outline tree. The headlines in Org
1156 start with one or more stars, on the left margin@footnote{See the variables
1157 @code{org-special-ctrl-a/e}, @code{org-special-ctrl-k}, and
1158 @code{org-ctrl-k-protect-subtree} to configure special behavior of @kbd{C-a},
1159 @kbd{C-e}, and @kbd{C-k} in headlines.}. For example:
1162 * Top level headline
1169 * Another top level headline
1172 @noindent Some people find the many stars too noisy and would prefer an
1173 outline that has whitespace followed by a single star as headline
1174 starters. @ref{Clean view}, describes a setup to realize this.
1176 @vindex org-cycle-separator-lines
1177 An empty line after the end of a subtree is considered part of it and
1178 will be hidden when the subtree is folded. However, if you leave at
1179 least two empty lines, one empty line will remain visible after folding
1180 the subtree, in order to structure the collapsed view. See the
1181 variable @code{org-cycle-separator-lines} to modify this behavior.
1183 @node Visibility cycling, Motion, Headlines, Document Structure
1184 @section Visibility cycling
1185 @cindex cycling, visibility
1186 @cindex visibility cycling
1187 @cindex trees, visibility
1188 @cindex show hidden text
1191 Outlines make it possible to hide parts of the text in the buffer.
1192 Org uses just two commands, bound to @key{TAB} and
1193 @kbd{S-@key{TAB}} to change the visibility in the buffer.
1195 @cindex subtree visibility states
1196 @cindex subtree cycling
1197 @cindex folded, subtree visibility state
1198 @cindex children, subtree visibility state
1199 @cindex subtree, subtree visibility state
1201 @orgcmd{@key{TAB},org-cycle}
1202 @emph{Subtree cycling}: Rotate current subtree among the states
1205 ,-> FOLDED -> CHILDREN -> SUBTREE --.
1206 '-----------------------------------'
1209 @vindex org-cycle-emulate-tab
1210 @vindex org-cycle-global-at-bob
1211 The cursor must be on a headline for this to work@footnote{see, however,
1212 the option @code{org-cycle-emulate-tab}.}. When the cursor is at the
1213 beginning of the buffer and the first line is not a headline, then
1214 @key{TAB} actually runs global cycling (see below)@footnote{see the
1215 option @code{org-cycle-global-at-bob}.}. Also when called with a prefix
1216 argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
1218 @cindex global visibility states
1219 @cindex global cycling
1220 @cindex overview, global visibility state
1221 @cindex contents, global visibility state
1222 @cindex show all, global visibility state
1223 @orgcmd{S-@key{TAB},org-global-cycle}
1224 @itemx C-u @key{TAB}
1225 @emph{Global cycling}: Rotate the entire buffer among the states
1228 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
1229 '--------------------------------------'
1232 When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
1233 CONTENTS view up to headlines of level N will be shown. Note that inside
1234 tables, @kbd{S-@key{TAB}} jumps to the previous field.
1236 @cindex show all, command
1237 @orgcmd{C-u C-u C-u @key{TAB},show-all}
1238 Show all, including drawers.
1239 @orgcmd{C-c C-r,org-reveal}
1240 Reveal context around point, showing the current entry, the following heading
1241 and the hierarchy above. Useful for working near a location that has been
1242 exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
1243 (@pxref{Agenda commands}). With a prefix argument show, on each
1244 level, all sibling headings. With a double prefix argument, also show the
1245 entire subtree of the parent.
1246 @orgcmd{C-c C-k,show-branches}
1247 Expose all the headings of the subtree, CONTENT view for just one subtree.
1248 @orgcmd{C-c C-x b,org-tree-to-indirect-buffer}
1249 Show the current subtree in an indirect buffer@footnote{The indirect
1252 (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
1255 (see the Emacs manual for more information about indirect buffers)
1257 will contain the entire buffer, but will be narrowed to the current
1258 tree. Editing the indirect buffer will also change the original buffer,
1259 but without affecting visibility in that buffer.}. With a numeric
1260 prefix argument N, go up to level N and then take that tree. If N is
1261 negative then go up that many levels. With a @kbd{C-u} prefix, do not remove
1262 the previously used indirect buffer.
1263 @orgcmd{C-c C-x v,org-copy-visible}
1264 Copy the @i{visible} text in the region into the kill ring.
1267 @vindex org-startup-folded
1268 @cindex @code{overview}, STARTUP keyword
1269 @cindex @code{content}, STARTUP keyword
1270 @cindex @code{showall}, STARTUP keyword
1271 @cindex @code{showeverything}, STARTUP keyword
1273 When Emacs first visits an Org file, the global state is set to
1274 OVERVIEW, i.e.@: only the top level headlines are visible. This can be
1275 configured through the variable @code{org-startup-folded}, or on a
1276 per-file basis by adding one of the following lines anywhere in the
1283 #+STARTUP: showeverything
1286 @cindex property, VISIBILITY
1288 Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
1289 and Columns}) will get their visibility adapted accordingly. Allowed values
1290 for this property are @code{folded}, @code{children}, @code{content}, and
1293 @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
1294 Switch back to the startup visibility of the buffer, i.e.@: whatever is
1295 requested by startup options and @samp{VISIBILITY} properties in individual
1299 @node Motion, Structure editing, Visibility cycling, Document Structure
1301 @cindex motion, between headlines
1302 @cindex jumping, to headlines
1303 @cindex headline navigation
1304 The following commands jump to other headlines in the buffer.
1307 @orgcmd{C-c C-n,outline-next-visible-heading}
1309 @orgcmd{C-c C-p,outline-previous-visible-heading}
1311 @orgcmd{C-c C-f,org-forward-same-level}
1312 Next heading same level.
1313 @orgcmd{C-c C-b,org-backward-same-level}
1314 Previous heading same level.
1315 @orgcmd{C-c C-u,outline-up-heading}
1316 Backward to higher level heading.
1317 @orgcmd{C-c C-j,org-goto}
1318 Jump to a different place without changing the current outline
1319 visibility. Shows the document structure in a temporary buffer, where
1320 you can use the following keys to find your destination:
1321 @vindex org-goto-auto-isearch
1323 @key{TAB} @r{Cycle visibility.}
1324 @key{down} / @key{up} @r{Next/previous visible headline.}
1325 @key{RET} @r{Select this location.}
1326 @kbd{/} @r{Do a Sparse-tree search}
1327 @r{The following keys work if you turn off @code{org-goto-auto-isearch}}
1328 n / p @r{Next/previous visible headline.}
1329 f / b @r{Next/previous headline same level.}
1331 0-9 @r{Digit argument.}
1334 @vindex org-goto-interface
1336 See also the variable @code{org-goto-interface}.
1339 @node Structure editing, Sparse trees, Motion, Document Structure
1340 @section Structure editing
1341 @cindex structure editing
1342 @cindex headline, promotion and demotion
1343 @cindex promotion, of subtrees
1344 @cindex demotion, of subtrees
1345 @cindex subtree, cut and paste
1346 @cindex pasting, of subtrees
1347 @cindex cutting, of subtrees
1348 @cindex copying, of subtrees
1349 @cindex sorting, of subtrees
1350 @cindex subtrees, cut and paste
1353 @orgcmd{M-@key{RET},org-insert-heading}
1354 @vindex org-M-RET-may-split-line
1355 Insert new heading with same level as current. If the cursor is in a plain
1356 list item, a new item is created (@pxref{Plain lists}). To force creation of
1357 a new headline, use a prefix argument. When this command is used in the
1358 middle of a line, the line is split and the rest of the line becomes the new
1359 headline@footnote{If you do not want the line to be split, customize the
1360 variable @code{org-M-RET-may-split-line}.}. If the command is used at the
1361 beginning of a headline, the new headline is created before the current line.
1362 If at the beginning of any other line, the content of that line is made the
1363 new heading. If the command is used at the end of a folded subtree (i.e.@:
1364 behind the ellipses at the end of a headline), then a headline like the
1365 current one will be inserted after the end of the subtree.
1366 @orgcmd{C-@key{RET},org-insert-heading-respect-content}
1367 Just like @kbd{M-@key{RET}}, except when adding a new heading below the
1368 current heading, the new heading is placed after the body instead of before
1369 it. This command works from anywhere in the entry.
1370 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
1371 @vindex org-treat-insert-todo-heading-as-state-change
1372 Insert new TODO entry with same level as current heading. See also the
1373 variable @code{org-treat-insert-todo-heading-as-state-change}.
1374 @orgcmd{C-S-@key{RET},org-insert-todo-heading-respect-content}
1375 Insert new TODO entry with same level as current heading. Like
1376 @kbd{C-@key{RET}}, the new headline will be inserted after the current
1378 @orgcmd{@key{TAB},org-cycle}
1379 In a new entry with no text yet, the first @key{TAB} demotes the entry to
1380 become a child of the previous one. The next @key{TAB} makes it a parent,
1381 and so on, all the way to top level. Yet another @key{TAB}, and you are back
1382 to the initial level.
1383 @orgcmd{M-@key{left},org-do-promote}
1384 Promote current heading by one level.
1385 @orgcmd{M-@key{right},org-do-demote}
1386 Demote current heading by one level.
1387 @orgcmd{M-S-@key{left},org-promote-subtree}
1388 Promote the current subtree by one level.
1389 @orgcmd{M-S-@key{right},org-demote-subtree}
1390 Demote the current subtree by one level.
1391 @orgcmd{M-S-@key{up},org-move-subtree-up}
1392 Move subtree up (swap with previous subtree of same
1394 @orgcmd{M-S-@key{down},org-move-subtree-down}
1395 Move subtree down (swap with next subtree of same level).
1396 @orgcmd{C-c C-x C-w,org-cut-subtree}
1397 Kill subtree, i.e.@: remove it from buffer but save in kill ring.
1398 With a numeric prefix argument N, kill N sequential subtrees.
1399 @orgcmd{C-c C-x M-w,org-copy-subtree}
1400 Copy subtree to kill ring. With a numeric prefix argument N, copy the N
1401 sequential subtrees.
1402 @orgcmd{C-c C-x C-y,org-paste-subtree}
1403 Yank subtree from kill ring. This does modify the level of the subtree to
1404 make sure the tree fits in nicely at the yank position. The yank level can
1405 also be specified with a numeric prefix argument, or by yanking after a
1406 headline marker like @samp{****}.
1407 @orgcmd{C-y,org-yank}
1408 @vindex org-yank-adjusted-subtrees
1409 @vindex org-yank-folded-subtrees
1410 Depending on the variables @code{org-yank-adjusted-subtrees} and
1411 @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
1412 paste subtrees folded and in a clever way, using the same command as @kbd{C-c
1413 C-x C-y}. With the default settings, no level adjustment will take place,
1414 but the yanked tree will be folded unless doing so would swallow text
1415 previously visible. Any prefix argument to this command will force a normal
1416 @code{yank} to be executed, with the prefix passed along. A good way to
1417 force a normal yank is @kbd{C-u C-y}. If you use @code{yank-pop} after a
1418 yank, it will yank previous kill items plainly, without adjustment and
1420 @orgcmd{C-c C-x c,org-clone-subtree-with-time-shift}
1421 Clone a subtree by making a number of sibling copies of it. You will be
1422 prompted for the number of copies to make, and you can also specify if any
1423 timestamps in the entry should be shifted. This can be useful, for example,
1424 to create a number of tasks related to a series of lectures to prepare. For
1425 more details, see the docstring of the command
1426 @code{org-clone-subtree-with-time-shift}.
1427 @orgcmd{C-c C-w,org-refile}
1428 Refile entry or region to a different location. @xref{Refiling notes}.
1429 @orgcmd{C-c ^,org-sort-entries-or-items}
1430 Sort same-level entries. When there is an active region, all entries in the
1431 region will be sorted. Otherwise the children of the current headline are
1432 sorted. The command prompts for the sorting method, which can be
1433 alphabetically, numerically, by time (first timestamp with active preferred,
1434 creation time, scheduled time, deadline time), by priority, by TODO keyword
1435 (in the sequence the keywords have been defined in the setup) or by the value
1436 of a property. Reverse sorting is possible as well. You can also supply
1437 your own function to extract the sorting key. With a @kbd{C-u} prefix,
1438 sorting will be case-sensitive. With two @kbd{C-u C-u} prefixes, duplicate
1439 entries will also be removed.
1440 @orgcmd{C-x n s,org-narrow-to-subtree}
1441 Narrow buffer to current subtree.
1442 @orgcmd{C-x n b,org-narrow-to-block}
1443 Narrow buffer to current block.
1444 @orgcmd{C-x n w,widen}
1445 Widen buffer to remove narrowing.
1446 @orgcmd{C-c *,org-toggle-heading}
1447 Turn a normal line or plain list item into a headline (so that it becomes a
1448 subheading at its location). Also turn a headline into a normal line by
1449 removing the stars. If there is an active region, turn all lines in the
1450 region into headlines. If the first line in the region was an item, turn
1451 only the item lines into headlines. Finally, if the first line is a
1452 headline, remove the stars from all headlines in the region.
1455 @cindex region, active
1456 @cindex active region
1457 @cindex transient mark mode
1458 When there is an active region (Transient Mark mode), promotion and
1459 demotion work on all headlines in the region. To select a region of
1460 headlines, it is best to place both point and mark at the beginning of a
1461 line, mark at the beginning of the first headline, and point at the line
1462 just after the last headline to change. Note that when the cursor is
1463 inside a table (@pxref{Tables}), the Meta-Cursor keys have different
1467 @node Sparse trees, Plain lists, Structure editing, Document Structure
1468 @section Sparse trees
1469 @cindex sparse trees
1470 @cindex trees, sparse
1471 @cindex folding, sparse trees
1472 @cindex occur, command
1474 @vindex org-show-hierarchy-above
1475 @vindex org-show-following-heading
1476 @vindex org-show-siblings
1477 @vindex org-show-entry-below
1478 An important feature of Org mode is the ability to construct @emph{sparse
1479 trees} for selected information in an outline tree, so that the entire
1480 document is folded as much as possible, but the selected information is made
1481 visible along with the headline structure above it@footnote{See also the
1482 variables @code{org-show-hierarchy-above}, @code{org-show-following-heading},
1483 @code{org-show-siblings}, and @code{org-show-entry-below} for detailed
1484 control on how much context is shown around each match.}. Just try it out
1485 and you will see immediately how it works.
1487 Org mode contains several commands creating such trees, all these
1488 commands can be accessed through a dispatcher:
1491 @orgcmd{C-c /,org-sparse-tree}
1492 This prompts for an extra key to select a sparse-tree creating command.
1493 @orgcmd{C-c / r,org-occur}
1494 @vindex org-remove-highlights-with-change
1495 Prompts for a regexp and shows a sparse tree with all matches. If
1496 the match is in a headline, the headline is made visible. If the match is in
1497 the body of an entry, headline and body are made visible. In order to
1498 provide minimal context, also the full hierarchy of headlines above the match
1499 is shown, as well as the headline following the match. Each match is also
1500 highlighted; the highlights disappear when the buffer is changed by an
1501 editing command@footnote{This depends on the option
1502 @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
1503 When called with a @kbd{C-u} prefix argument, previous highlights are kept,
1504 so several calls to this command can be stacked.
1505 @orgcmdkkc{M-g n,M-g M-n,next-error}
1506 Jump to the next sparse tree match in this buffer.
1507 @orgcmdkkc{M-g p,M-g M-p,previous-error}
1508 Jump to the previous sparse tree match in this buffer.
1513 @vindex org-agenda-custom-commands
1514 For frequently used sparse trees of specific search strings, you can
1515 use the variable @code{org-agenda-custom-commands} to define fast
1516 keyboard access to specific sparse trees. These commands will then be
1517 accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
1521 (setq org-agenda-custom-commands
1522 '(("f" occur-tree "FIXME")))
1525 @noindent will define the key @kbd{C-c a f} as a shortcut for creating
1526 a sparse tree matching the string @samp{FIXME}.
1528 The other sparse tree commands select headings based on TODO keywords,
1529 tags, or properties and will be discussed later in this manual.
1532 @cindex printing sparse trees
1533 @cindex visible text, printing
1534 To print a sparse tree, you can use the Emacs command
1535 @code{ps-print-buffer-with-faces} which does not print invisible parts
1536 of the document @footnote{This does not work under XEmacs, because
1537 XEmacs uses selective display for outlining, not text properties.}.
1538 Or you can use the command @kbd{C-c C-e v} to export only the visible
1539 part of the document and print the resulting file.
1541 @node Plain lists, Drawers, Sparse trees, Document Structure
1542 @section Plain lists
1544 @cindex lists, plain
1545 @cindex lists, ordered
1546 @cindex ordered lists
1548 Within an entry of the outline tree, hand-formatted lists can provide
1549 additional structure. They also provide a way to create lists of checkboxes
1550 (@pxref{Checkboxes}). Org supports editing such lists, and every exporter
1551 (@pxref{Exporting}) can parse and format them.
1553 Org knows ordered lists, unordered lists, and description lists.
1556 @emph{Unordered} list items start with @samp{-}, @samp{+}, or
1557 @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
1558 they will be seen as top-level headlines. Also, when you are hiding leading
1559 stars to get a clean outline view, plain list items starting with a star may
1560 be hard to distinguish from true headlines. In short: even though @samp{*}
1561 is supported, it may be better to not use it for plain list items.} as
1564 @vindex org-plain-list-ordered-item-terminator
1565 @vindex org-alphabetical-lists
1566 @emph{Ordered} list items start with a numeral followed by either a period or
1567 a right parenthesis@footnote{You can filter out any of them by configuring
1568 @code{org-plain-list-ordered-item-terminator}.}, such as @samp{1.} or
1569 @samp{1)}@footnote{You can also get @samp{a.}, @samp{A.}, @samp{a)} and
1570 @samp{A)} by configuring @code{org-alphabetical-lists}. To minimize
1571 confusion with normal text, those are limited to one character only. Beyond
1572 that limit, bullets will automatically fallback to numbers.}. If you want a
1573 list to start with a different value (e.g.@: 20), start the text of the item
1574 with @code{[@@20]}@footnote{If there's a checkbox in the item, the cookie
1575 must be put @emph{before} the checkbox. If you have activated alphabetical
1576 lists, you can also use counters like @code{[@@b]}.}. Those constructs can
1577 be used in any item of the list in order to enforce a particular numbering.
1579 @emph{Description} list items are unordered list items, and contain the
1580 separator @samp{ :: } to distinguish the description @emph{term} from the
1584 Items belonging to the same list must have the same indentation on the first
1585 line. In particular, if an ordered list reaches number @samp{10.}, then the
1586 2--digit numbers must be written left-aligned with the other numbers in the
1587 list. An item ends before the next line that is less or equally indented
1588 than its bullet/number.
1590 @vindex org-list-ending-method
1591 @vindex org-list-end-regexp
1592 @vindex org-empty-line-terminates-plain-lists
1593 Two methods@footnote{To disable either of them, configure
1594 @code{org-list-ending-method}.} are provided to terminate lists. A list ends
1595 whenever every item has ended, which means before any line less or equally
1596 indented than items at top level. It also ends before two blank
1597 lines@footnote{See also @code{org-empty-line-terminates-plain-lists}.}. In
1598 that case, all items are closed. For finer control, you can end lists with
1599 any pattern set in @code{org-list-end-regexp}. Here is an example:
1603 ** Lord of the Rings
1604 My favorite scenes are (in this order)
1605 1. The attack of the Rohirrim
1606 2. Eowyn's fight with the witch king
1607 + this was already my favorite scene in the book
1608 + I really like Miranda Otto.
1609 3. Peter Jackson being shot by Legolas
1611 He makes a really funny face when it happens.
1612 But in the end, no individual scenes matter but the film as a whole.
1613 Important actors in this film are:
1614 - @b{Elijah Wood} :: He plays Frodo
1615 - @b{Sean Austin} :: He plays Sam, Frodo's friend. I still remember
1616 him very well from his role as Mikey Walsh in @i{The Goonies}.
1620 Org supports these lists by tuning filling and wrapping commands to deal with
1621 them correctly@footnote{Org only changes the filling settings for Emacs. For
1622 XEmacs, you should use Kyle E. Jones' @file{filladapt.el}. To turn this on,
1623 put into @file{.emacs}: @code{(require 'filladapt)}}, and by exporting them
1624 properly (@pxref{Exporting}). Since indentation is what governs the
1625 structure of these lists, many structural constructs like @code{#+BEGIN_...}
1626 blocks can be indented to signal that they belong to a particular item.
1628 @vindex org-list-demote-modify-bullet
1629 @vindex org-list-indent-offset
1630 If you find that using a different bullet for a sub-list (than that used for
1631 the current list-level) improves readability, customize the variable
1632 @code{org-list-demote-modify-bullet}. To get a greater difference of
1633 indentation between items and theirs sub-items, customize
1634 @code{org-list-indent-offset}.
1636 @vindex org-list-automatic-rules
1637 The following commands act on items when the cursor is in the first line of
1638 an item (the line with the bullet or number). Some of them imply the
1639 application of automatic rules to keep list structure intact. If some of
1640 these actions get in your way, configure @code{org-list-automatic-rules}
1641 to disable them individually.
1644 @orgcmd{@key{TAB},org-cycle}
1645 @cindex cycling, in plain lists
1646 @vindex org-cycle-include-plain-lists
1647 Items can be folded just like headline levels. Normally this works only if
1648 the cursor is on a plain list item. For more details, see the variable
1649 @code{org-cycle-include-plain-lists}. If this variable is set to
1650 @code{integrate}, plain list items will be treated like low-level
1651 headlines. The level of an item is then given by the indentation of the
1652 bullet/number. Items are always subordinate to real headlines, however; the
1653 hierarchies remain completely separated. In a new item with no text yet, the
1654 first @key{TAB} demotes the item to become a child of the previous
1655 one. Subsequent @key{TAB}s move the item to meaningful levels in the list
1656 and eventually get it back to its initial position.
1657 @orgcmd{M-@key{RET},org-insert-heading}
1658 @vindex org-M-RET-may-split-line
1659 @vindex org-list-automatic-rules
1660 Insert new item at current level. With a prefix argument, force a new
1661 heading (@pxref{Structure editing}). If this command is used in the middle
1662 of an item, that item is @emph{split} in two, and the second part becomes the
1663 new item@footnote{If you do not want the item to be split, customize the
1664 variable @code{org-M-RET-may-split-line}.}. If this command is executed
1665 @emph{before item's body}, the new item is created @emph{before} the current
1670 @kindex M-S-@key{RET}
1672 Insert a new item with a checkbox (@pxref{Checkboxes}).
1673 @kindex S-@key{down}
1676 @cindex shift-selection-mode
1677 @vindex org-support-shift-select
1678 @vindex org-list-use-circular-motion
1679 Jump to the previous/next item in the current list@footnote{If you want to
1680 cycle around items that way, you may customize
1681 @code{org-list-use-circular-motion}.}, but only if
1682 @code{org-support-shift-select} is off. If not, you can still use paragraph
1683 jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite
1686 @kindex M-@key{down}
1689 Move the item including subitems up/down@footnote{See
1690 @code{org-liste-use-circular-motion} for a cyclic behavior.} (swap with
1691 previous/next item of same indentation). If the list is ordered, renumbering
1693 @kindex M-@key{left}
1694 @kindex M-@key{right}
1697 Decrease/increase the indentation of an item, leaving children alone.
1698 @kindex M-S-@key{left}
1699 @kindex M-S-@key{right}
1702 Decrease/increase the indentation of the item, including subitems.
1703 Initially, the item tree is selected based on current indentation. When
1704 these commands are executed several times in direct succession, the initially
1705 selected region is used, even if the new indentation would imply a different
1706 hierarchy. To use the new hierarchy, break the command chain with a cursor
1709 As a special case, using this command on the very first item of a list will
1710 move the whole list. This behavior can be disabled by configuring
1711 @code{org-list-automatic-rules}. The global indentation of a list has no
1712 influence on the text @emph{after} the list.
1715 If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
1716 state of the checkbox. In any case, verify bullets and indentation
1717 consistency in the whole list.
1719 @vindex org-plain-list-ordered-item-terminator
1720 @vindex org-list-automatic-rules
1722 Cycle the entire list level through the different itemize/enumerate bullets
1723 (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}) or a subset of them,
1724 depending on @code{org-plain-list-ordered-item-terminator}, the type of list,
1725 and its position@footnote{See @code{bullet} rule in
1726 @code{org-list-automatic-rules} for more information.}. With a numeric
1727 prefix argument N, select the Nth bullet from this list. If there is an
1728 active region when calling this, selected text will be changed into an item.
1729 With a prefix argument, all lines will be converted to list items. If the
1730 first line already was a list item, any item marker will be removed from the
1731 list. Finally, even without an active region, a normal line will be
1732 converted into a list item.
1735 Turn a plain list item into a headline (so that it becomes a subheading at
1736 its location). @xref{Structure editing}, for a detailed explanation.
1739 Turn the whole plain list into a subtree of the current heading. Checkboxes
1740 (@pxref{Checkboxes}) will become TODO (resp. DONE) keywords when unchecked
1742 @kindex S-@key{left}
1743 @kindex S-@key{right}
1745 @vindex org-support-shift-select
1746 This command also cycles bullet styles when the cursor in on the bullet or
1747 anywhere in an item line, details depending on
1748 @code{org-support-shift-select}.
1751 Sort the plain list. You will be prompted for the sorting method:
1752 numerically, alphabetically, by time, or by custom function.
1755 @node Drawers, Blocks, Plain lists, Document Structure
1759 @cindex visibility cycling, drawers
1762 Sometimes you want to keep information associated with an entry, but you
1763 normally don't want to see it. For this, Org mode has @emph{drawers}.
1764 Drawers need to be configured with the variable
1765 @code{org-drawers}@footnote{You can define drawers on a per-file basis
1766 with a line like @code{#+DRAWERS: HIDDEN PROPERTIES STATE}}. Drawers
1770 ** This is a headline
1771 Still outside the drawer
1773 This is inside the drawer.
1778 Visibility cycling (@pxref{Visibility cycling}) on the headline will hide and
1779 show the entry, but keep the drawer collapsed to a single line. In order to
1780 look inside the drawer, you need to move the cursor to the drawer line and
1781 press @key{TAB} there. Org mode uses the @code{PROPERTIES} drawer for
1782 storing properties (@pxref{Properties and Columns}), and you can also arrange
1783 for state change notes (@pxref{Tracking TODO state changes}) and clock times
1784 (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}. If you
1785 want to store a quick note in the LOGBOOK drawer, in a similar way to state changes, use
1790 Add a time-stamped note to the LOGBOOK drawer.
1793 @node Blocks, Footnotes, Drawers, Document Structure
1796 @vindex org-hide-block-startup
1797 @cindex blocks, folding
1798 Org mode uses begin...end blocks for various purposes from including source
1799 code examples (@pxref{Literal examples}) to capturing time logging
1800 information (@pxref{Clocking work time}). These blocks can be folded and
1801 unfolded by pressing TAB in the begin line. You can also get all blocks
1802 folded at startup by configuring the variable @code{org-hide-block-startup}
1803 or on a per-file basis by using
1805 @cindex @code{hideblocks}, STARTUP keyword
1806 @cindex @code{nohideblocks}, STARTUP keyword
1808 #+STARTUP: hideblocks
1809 #+STARTUP: nohideblocks
1812 @node Footnotes, Orgstruct mode, Blocks, Document Structure
1816 Org mode supports the creation of footnotes. In contrast to the
1817 @file{footnote.el} package, Org mode's footnotes are designed for work on a
1818 larger document, not only for one-off documents like emails. The basic
1819 syntax is similar to the one used by @file{footnote.el}, i.e.@: a footnote is
1820 defined in a paragraph that is started by a footnote marker in square
1821 brackets in column 0, no indentation allowed. If you need a paragraph break
1822 inside a footnote, use the @LaTeX{} idiom @samp{\par}. The footnote reference
1823 is simply the marker in square brackets, inside text. For example:
1826 The Org homepage[fn:1] now looks a lot better than it used to.
1828 [fn:1] The link is: http://orgmode.org
1831 Org mode extends the number-based syntax to @emph{named} footnotes and
1832 optional inline definition. Using plain numbers as markers (as
1833 @file{footnote.el} does) is supported for backward compatibility, but not
1834 encouraged because of possible conflicts with @LaTeX{} snippets (@pxref{Embedded
1835 @LaTeX{}}). Here are the valid references:
1839 A plain numeric footnote marker. Compatible with @file{footnote.el}, but not
1840 recommended because something like @samp{[1]} could easily be part of a code
1843 A named footnote reference, where @code{name} is a unique label word, or, for
1844 simplicity of automatic creation, a number.
1845 @item [fn:: This is the inline definition of this footnote]
1846 A @LaTeX{}-like anonymous footnote where the definition is given directly at the
1848 @item [fn:name: a definition]
1849 An inline definition of a footnote, which also specifies a name for the note.
1850 Since Org allows multiple references to the same note, you can then use
1851 @code{[fn:name]} to create additional references.
1854 @vindex org-footnote-auto-label
1855 Footnote labels can be created automatically, or you can create names yourself.
1856 This is handled by the variable @code{org-footnote-auto-label} and its
1857 corresponding @code{#+STARTUP} keywords. See the docstring of that variable
1860 @noindent The following command handles footnotes:
1865 The footnote action command.
1867 When the cursor is on a footnote reference, jump to the definition. When it
1868 is at a definition, jump to the (first) reference.
1870 @vindex org-footnote-define-inline
1871 @vindex org-footnote-section
1872 @vindex org-footnote-auto-adjust
1873 Otherwise, create a new footnote. Depending on the variable
1874 @code{org-footnote-define-inline}@footnote{The corresponding in-buffer
1875 setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
1876 definition will be placed right into the text as part of the reference, or
1877 separately into the location determined by the variable
1878 @code{org-footnote-section}.
1880 When this command is called with a prefix argument, a menu of additional
1883 s @r{Sort the footnote definitions by reference sequence. During editing,}
1884 @r{Org makes no effort to sort footnote definitions into a particular}
1885 @r{sequence. If you want them sorted, use this command, which will}
1886 @r{also move entries according to @code{org-footnote-section}. Automatic}
1887 @r{sorting after each insertion/deletion can be configured using the}
1888 @r{variable @code{org-footnote-auto-adjust}.}
1889 r @r{Renumber the simple @code{fn:N} footnotes. Automatic renumbering}
1890 @r{after each insertion/deletion can be configured using the variable}
1891 @r{@code{org-footnote-auto-adjust}.}
1892 S @r{Short for first @code{r}, then @code{s} action.}
1893 n @r{Normalize the footnotes by collecting all definitions (including}
1894 @r{inline definitions) into a special section, and then numbering them}
1895 @r{in sequence. The references will then also be numbers. This is}
1896 @r{meant to be the final step before finishing a document (e.g.@: sending}
1897 @r{off an email). The exporters do this automatically, and so could}
1898 @r{something like @code{message-send-hook}.}
1899 d @r{Delete the footnote at point, and all definitions of and references}
1902 Depending on the variable @code{org-footnote-auto-adjust}@footnote{the
1903 corresponding in-buffer options are @code{fnadjust} and @code{nofnadjust}.},
1904 renumbering and sorting footnotes can be automatic after each insertion or
1909 If the cursor is on a footnote reference, jump to the definition. If it is a
1910 the definition, jump back to the reference. When called at a footnote
1911 location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
1915 @item C-c C-o @r{or} mouse-1/2
1916 Footnote labels are also links to the corresponding definition/reference, and
1917 you can use the usual commands to follow these links.
1920 @node Orgstruct mode, , Footnotes, Document Structure
1921 @section The Orgstruct minor mode
1922 @cindex Orgstruct mode
1923 @cindex minor mode for structure editing
1925 If you like the intuitive way the Org mode structure editing and list
1926 formatting works, you might want to use these commands in other modes like
1927 Text mode or Mail mode as well. The minor mode @code{orgstruct-mode} makes
1928 this possible. Toggle the mode with @kbd{M-x orgstruct-mode}, or
1929 turn it on by default, for example in Message mode, with one of:
1932 (add-hook 'message-mode-hook 'turn-on-orgstruct)
1933 (add-hook 'message-mode-hook 'turn-on-orgstruct++)
1936 When this mode is active and the cursor is on a line that looks to Org like a
1937 headline or the first line of a list item, most structure editing commands
1938 will work, even if the same keys normally have different functionality in the
1939 major mode you are using. If the cursor is not in one of those special
1940 lines, Orgstruct mode lurks silently in the shadows. When you use
1941 @code{orgstruct++-mode}, Org will also export indentation and autofill
1942 settings into that mode, and detect item context after the first line of an
1945 @node Tables, Hyperlinks, Document Structure, Top
1948 @cindex editing tables
1950 Org comes with a fast and intuitive table editor. Spreadsheet-like
1951 calculations are supported using the Emacs @file{calc} package
1953 (@pxref{Top,Calc,,Calc,Gnu Emacs Calculator Manual}).
1956 (see the Emacs Calculator manual for more information about the Emacs
1961 * Built-in table editor:: Simple tables
1962 * Column width and alignment:: Overrule the automatic settings
1963 * Column groups:: Grouping to trigger vertical lines
1964 * Orgtbl mode:: The table editor as minor mode
1965 * The spreadsheet:: The table editor has spreadsheet capabilities
1966 * Org-Plot:: Plotting from org tables
1969 @node Built-in table editor, Column width and alignment, Tables, Tables
1970 @section The built-in table editor
1971 @cindex table editor, built-in
1973 Org makes it easy to format tables in plain ASCII. Any line with @samp{|} as
1974 the first non-whitespace character is considered part of a table. @samp{|}
1975 is also the column separator@footnote{To insert a vertical bar into a table
1976 field, use @code{\vert} or, inside a word @code{abc\vert@{@}def}.}. A table
1977 might look like this:
1980 | Name | Phone | Age |
1981 |-------+-------+-----|
1982 | Peter | 1234 | 17 |
1983 | Anna | 4321 | 25 |
1986 A table is re-aligned automatically each time you press @key{TAB} or
1987 @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to
1988 the next field (@key{RET} to the next row) and creates new table rows
1989 at the end of the table or before horizontal lines. The indentation
1990 of the table is set by the first line. Any line starting with
1991 @samp{|-} is considered as a horizontal separator line and will be
1992 expanded on the next re-align to span the whole table width. So, to
1993 create the above table, you would only type
2000 @noindent and then press @key{TAB} to align the table and start filling in
2001 fields. Even faster would be to type @code{|Name|Phone|Age} followed by
2002 @kbd{C-c @key{RET}}.
2004 @vindex org-enable-table-editor
2005 @vindex org-table-auto-blank-field
2006 When typing text into a field, Org treats @key{DEL},
2007 @key{Backspace}, and all character keys in a special way, so that
2008 inserting and deleting avoids shifting other fields. Also, when
2009 typing @emph{immediately after the cursor was moved into a new field
2010 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
2011 field is automatically made blank. If this behavior is too
2012 unpredictable for you, configure the variables
2013 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
2016 @tsubheading{Creation and conversion}
2017 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2018 Convert the active region to table. If every line contains at least one
2019 TAB character, the function assumes that the material is tab separated.
2020 If every line contains a comma, comma-separated values (CSV) are assumed.
2021 If not, lines are split at whitespace into fields. You can use a prefix
2022 argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
2023 C-u} forces TAB, and a numeric argument N indicates that at least N
2024 consecutive spaces, or alternatively a TAB will be the separator.
2026 If there is no active region, this command creates an empty Org
2027 table. But it is easier just to start typing, like
2028 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
2030 @tsubheading{Re-aligning and field motion}
2031 @orgcmd{C-c C-c,org-table-align}
2032 Re-align the table without moving the cursor.
2034 @orgcmd{<TAB>,org-table-next-field}
2035 Re-align the table, move to the next field. Creates a new row if
2038 @orgcmd{S-@key{TAB},org-table-previous-field}
2039 Re-align, move to previous field.
2041 @orgcmd{@key{RET},org-table-next-row}
2042 Re-align the table and move down to next row. Creates a new row if
2043 necessary. At the beginning or end of a line, @key{RET} still does
2044 NEWLINE, so it can be used to split a table.
2046 @orgcmd{M-a,org-table-beginning-of-field}
2047 Move to beginning of the current table field, or on to the previous field.
2048 @orgcmd{M-e,org-table-end-of-field}
2049 Move to end of the current table field, or on to the next field.
2051 @tsubheading{Column and row editing}
2052 @orgcmdkkcc{M-@key{left},M-@key{right},org-table-move-column-left,org-table-move-column-right}
2053 Move the current column left/right.
2055 @orgcmd{M-S-@key{left},org-table-delete-column}
2056 Kill the current column.
2058 @orgcmd{M-S-@key{right},org-table-insert-column}
2059 Insert a new column to the left of the cursor position.
2061 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-move-row-up,org-table-move-row-down}
2062 Move the current row up/down.
2064 @orgcmd{M-S-@key{up},org-table-kill-row}
2065 Kill the current row or horizontal line.
2067 @orgcmd{M-S-@key{down},org-table-insert-row}
2068 Insert a new row above the current row. With a prefix argument, the line is
2069 created below the current one.
2071 @orgcmd{C-c -,org-table-insert-hline}
2072 Insert a horizontal line below current row. With a prefix argument, the line
2073 is created above the current line.
2075 @orgcmd{C-c @key{RET},org-table-hline-and-move}
2076 Insert a horizontal line below current row, and move the cursor into the row
2079 @orgcmd{C-c ^,org-table-sort-lines}
2080 Sort the table lines in the region. The position of point indicates the
2081 column to be used for sorting, and the range of lines is the range
2082 between the nearest horizontal separator lines, or the entire table. If
2083 point is before the first column, you will be prompted for the sorting
2084 column. If there is an active region, the mark specifies the first line
2085 and the sorting column, while point should be in the last line to be
2086 included into the sorting. The command prompts for the sorting type
2087 (alphabetically, numerically, or by time). When called with a prefix
2088 argument, alphabetic sorting will be case-sensitive.
2090 @tsubheading{Regions}
2091 @orgcmd{C-c C-x M-w,org-table-copy-region}
2092 Copy a rectangular region from a table to a special clipboard. Point and
2093 mark determine edge fields of the rectangle. If there is no active region,
2094 copy just the current field. The process ignores horizontal separator lines.
2096 @orgcmd{C-c C-x C-w,org-table-cut-region}
2097 Copy a rectangular region from a table to a special clipboard, and
2098 blank all fields in the rectangle. So this is the ``cut'' operation.
2100 @orgcmd{C-c C-x C-y,org-table-paste-rectangle}
2101 Paste a rectangular region into a table.
2102 The upper left corner ends up in the current field. All involved fields
2103 will be overwritten. If the rectangle does not fit into the present table,
2104 the table is enlarged as needed. The process ignores horizontal separator
2107 @orgcmd{M-@key{RET},org-table-wrap-region}
2108 Split the current field at the cursor position and move the rest to the line
2109 below. If there is an active region, and both point and mark are in the same
2110 column, the text in the column is wrapped to minimum width for the given
2111 number of lines. A numeric prefix argument may be used to change the number
2112 of desired lines. If there is no region, but you specify a prefix argument,
2113 the current field is made blank, and the content is appended to the field
2116 @tsubheading{Calculations}
2117 @cindex formula, in tables
2118 @cindex calculations, in tables
2119 @cindex region, active
2120 @cindex active region
2121 @cindex transient mark mode
2122 @orgcmd{C-c +,org-table-sum}
2123 Sum the numbers in the current column, or in the rectangle defined by
2124 the active region. The result is shown in the echo area and can
2125 be inserted with @kbd{C-y}.
2127 @orgcmd{S-@key{RET},org-table-copy-down}
2128 @vindex org-table-copy-increment
2129 When current field is empty, copy from first non-empty field above. When not
2130 empty, copy current field down to next row and move cursor along with it.
2131 Depending on the variable @code{org-table-copy-increment}, integer field
2132 values will be incremented during copy. Integers that are too large will not
2133 be incremented. Also, a @code{0} prefix argument temporarily disables the
2134 increment. This key is also used by shift-selection and related modes
2135 (@pxref{Conflicts}).
2137 @tsubheading{Miscellaneous}
2138 @orgcmd{C-c `,org-table-edit-field}
2139 Edit the current field in a separate window. This is useful for fields that
2140 are not fully visible (@pxref{Column width and alignment}). When called with
2141 a @kbd{C-u} prefix, just make the full field visible, so that it can be
2142 edited in place. When called with two @kbd{C-u} prefixes, make the editor
2143 window follow the cursor through the table and always show the current
2144 field. The follow mode exits automatically when the cursor leaves the table,
2145 or when you repeat this command with @kbd{C-u C-u C-c `}.
2147 @item M-x org-table-import
2148 Import a file as a table. The table should be TAB or whitespace
2149 separated. Use, for example, to import a spreadsheet table or data
2150 from a database, because these programs generally can write
2151 TAB-separated text files. This command works by inserting the file into
2152 the buffer and then converting the region to a table. Any prefix
2153 argument is passed on to the converter, which uses it to determine the
2155 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2156 Tables can also be imported by pasting tabular text into the Org
2157 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
2158 @kbd{C-c |} command (see above under @i{Creation and conversion}).
2160 @item M-x org-table-export
2161 @findex org-table-export
2162 @vindex org-table-export-default-format
2163 Export the table, by default as a TAB-separated file. Use for data
2164 exchange with, for example, spreadsheet or database programs. The format
2165 used to export the file can be configured in the variable
2166 @code{org-table-export-default-format}. You may also use properties
2167 @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
2168 name and the format for table export in a subtree. Org supports quite
2169 general formats for exported tables. The exporter format is the same as the
2170 format used by Orgtbl radio tables, see @ref{Translator functions}, for a
2171 detailed description.
2174 If you don't like the automatic table editor because it gets in your
2175 way on lines which you would like to start with @samp{|}, you can turn
2179 (setq org-enable-table-editor nil)
2182 @noindent Then the only table command that still works is
2183 @kbd{C-c C-c} to do a manual re-align.
2185 @node Column width and alignment, Column groups, Built-in table editor, Tables
2186 @section Column width and alignment
2187 @cindex narrow columns in tables
2188 @cindex alignment in tables
2190 The width of columns is automatically determined by the table editor. And
2191 also the alignment of a column is determined automatically from the fraction
2192 of number-like versus non-number fields in the column.
2194 Sometimes a single field or a few fields need to carry more text, leading to
2195 inconveniently wide columns. Or maybe you want to make a table with several
2196 columns having a fixed width, regardless of content. To set@footnote{This
2197 feature does not work on XEmacs.} the width of a column, one field anywhere
2198 in the column may contain just the string @samp{<N>} where @samp{N} is an
2199 integer specifying the width of the column in characters. The next re-align
2200 will then set the width of this column to this value.
2204 |---+------------------------------| |---+--------|
2206 | 1 | one | | 1 | one |
2207 | 2 | two | ----\ | 2 | two |
2208 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
2209 | 4 | four | | 4 | four |
2210 |---+------------------------------| |---+--------|
2215 Fields that are wider become clipped and end in the string @samp{=>}.
2216 Note that the full text is still in the buffer but is hidden.
2217 To see the full text, hold the mouse over the field---a tool-tip window
2218 will show the full content. To edit such a field, use the command
2219 @kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will
2220 open a new window with the full field. Edit it and finish with @kbd{C-c
2223 @vindex org-startup-align-all-tables
2224 When visiting a file containing a table with narrowed columns, the
2225 necessary character hiding has not yet happened, and the table needs to
2226 be aligned before it looks nice. Setting the option
2227 @code{org-startup-align-all-tables} will realign all tables in a file
2228 upon visiting, but also slow down startup. You can also set this option
2229 on a per-file basis with:
2236 If you would like to overrule the automatic alignment of number-rich columns
2237 to the right and of string-rich column to the left, you can use @samp{<r>},
2238 @samp{c}@footnote{Centering does not work inside Emacs, but it does have an
2239 effect when exporting to HTML.} or @samp{<l>} in a similar fashion. You may
2240 also combine alignment and field width like this: @samp{<l10>}.
2242 Lines which only contain these formatting cookies will be removed
2243 automatically when exporting the document.
2245 @node Column groups, Orgtbl mode, Column width and alignment, Tables
2246 @section Column groups
2247 @cindex grouping columns in tables
2249 When Org exports tables, it does so by default without vertical
2250 lines because that is visually more satisfying in general. Occasionally
2251 however, vertical lines can be useful to structure a table into groups
2252 of columns, much like horizontal lines can do for groups of rows. In
2253 order to specify column groups, you can use a special row where the
2254 first field contains only @samp{/}. The further fields can either
2255 contain @samp{<} to indicate that this column should start a group,
2256 @samp{>} to indicate the end of a column, or @samp{<>} to make a column
2257 a group of its own. Boundaries between column groups will upon export be
2258 marked with vertical lines. Here is an example:
2261 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2262 |---+-----+-----+-----+---------+------------|
2263 | / | < | | > | < | > |
2264 | 1 | 1 | 1 | 1 | 1 | 1 |
2265 | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
2266 | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
2267 |---+-----+-----+-----+---------+------------|
2268 #+TBLFM: $2=$1^2::$3=$1^3::$4=$1^4::$5=sqrt($1)::$6=sqrt(sqrt(($1)))
2271 It is also sufficient to just insert the column group starters after
2272 every vertical line you would like to have:
2275 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2276 |----+-----+-----+-----+---------+------------|
2280 @node Orgtbl mode, The spreadsheet, Column groups, Tables
2281 @section The Orgtbl minor mode
2283 @cindex minor mode for tables
2285 If you like the intuitive way the Org table editor works, you
2286 might also want to use it in other modes like Text mode or Mail mode.
2287 The minor mode Orgtbl mode makes this possible. You can always toggle
2288 the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for
2289 example in Message mode, use
2292 (add-hook 'message-mode-hook 'turn-on-orgtbl)
2295 Furthermore, with some special setup, it is possible to maintain tables
2296 in arbitrary syntax with Orgtbl mode. For example, it is possible to
2297 construct @LaTeX{} tables with the underlying ease and power of
2298 Orgtbl mode, including spreadsheet capabilities. For details, see
2299 @ref{Tables in arbitrary syntax}.
2301 @node The spreadsheet, Org-Plot, Orgtbl mode, Tables
2302 @section The spreadsheet
2303 @cindex calculations, in tables
2304 @cindex spreadsheet capabilities
2305 @cindex @file{calc} package
2307 The table editor makes use of the Emacs @file{calc} package to implement
2308 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
2309 derive fields from other fields. While fully featured, Org's implementation
2310 is not identical to other spreadsheets. For example, Org knows the concept
2311 of a @emph{column formula} that will be applied to all non-header fields in a
2312 column without having to copy the formula to each relevant field. There is
2313 also a formula debugger, and a formula editor with features for highlighting
2314 fields in the table corresponding to the references at the point in the
2315 formula, moving these references by arrow keys
2318 * References:: How to refer to another field or range
2319 * Formula syntax for Calc:: Using Calc to compute stuff
2320 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
2321 * Durations and time values:: How to compute durations and time values
2322 * Field and range formulas:: Formula for specific (ranges of) fields
2323 * Column formulas:: Formulas valid for an entire column
2324 * Editing and debugging formulas:: Fixing formulas
2325 * Updating the table:: Recomputing all dependent fields
2326 * Advanced features:: Field and column names, parameters and automatic recalc
2329 @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet
2330 @subsection References
2333 To compute fields in the table from other fields, formulas must
2334 reference other fields or ranges. In Org, fields can be referenced
2335 by name, by absolute coordinates, and by relative coordinates. To find
2336 out what the coordinates of a field are, press @kbd{C-c ?} in that
2337 field, or press @kbd{C-c @}} to toggle the display of a grid.
2339 @subsubheading Field references
2340 @cindex field references
2341 @cindex references, to fields
2343 Formulas can reference the value of another field in two ways. Like in
2344 any other spreadsheet, you may reference fields with a letter/number
2345 combination like @code{B3}, meaning the 2nd field in the 3rd row.
2346 @vindex org-table-use-standard-references
2347 However, Org prefers@footnote{Org will understand references typed by the
2348 user as @samp{B4}, but it will not use this syntax when offering a formula
2349 for editing. You can customize this behavior using the variable
2350 @code{org-table-use-standard-references}.} to use another, more general
2351 representation that looks like this:
2353 @@@var{row}$@var{column}
2356 Column specifications can be absolute like @code{$1},
2357 @code{$2},...@code{$@var{N}}, or relative to the current column (i.e.@: the
2358 column of the field which is being computed) like @code{$+1} or @code{$-2}.
2359 @code{$<} and @code{$>} are immutable references to the first and last
2360 column, respectively, and you can use @code{$>>>} to indicate the third
2361 column from the right.
2363 The row specification only counts data lines and ignores horizontal separator
2364 lines (hlines). Like with columns, you can use absolute row numbers
2365 @code{@@1}, @code{@@2},...@code{@@@var{N}}, and row numbers relative to the
2366 current row like @code{@@+3} or @code{@@-1}. @code{@@<} and @code{@@>} are
2367 immutable references the first and last@footnote{For backward compatibility
2368 you can also use special names like @code{$LR5} and @code{$LR12} to refer in
2369 a stable way to the 5th and 12th field in the last row of the table.
2370 However, this syntax is deprecated, it should not be used for new documents.
2371 Use @code{@@>$} instead.} row in the table, respectively. You may also
2372 specify the row relative to one of the hlines: @code{@@I} refers to the first
2373 hline, @code{@@II} to the second, etc@. @code{@@-I} refers to the first such
2374 line above the current line, @code{@@+I} to the first such line below the
2375 current line. You can also write @code{@@III+2} which is the second data line
2376 after the third hline in the table.
2378 @code{@@0} and @code{$0} refer to the current row and column, respectively,
2379 i.e. to the row/column for the field being computed. Also, if you omit
2380 either the column or the row part of the reference, the current row/column is
2383 Org's references with @emph{unsigned} numbers are fixed references
2384 in the sense that if you use the same reference in the formula for two
2385 different fields, the same field will be referenced each time.
2386 Org's references with @emph{signed} numbers are floating
2387 references because the same reference operator can reference different
2388 fields depending on the field being calculated by the formula.
2390 Here are a few examples:
2393 @@2$3 @r{2nd row, 3rd column (same as @code{C2})}
2394 $5 @r{column 5 in the current row (same as @code{E&})}
2395 @@2 @r{current column, row 2}
2396 @@-1$-3 @r{the field one row up, three columns to the left}
2397 @@-I$2 @r{field just under hline above current row, column 2}
2398 @@>$5 @r{field in the last row, in column 5}
2401 @subsubheading Range references
2402 @cindex range references
2403 @cindex references, to ranges
2405 You may reference a rectangular range of fields by specifying two field
2406 references connected by two dots @samp{..}. If both fields are in the
2407 current row, you may simply use @samp{$2..$7}, but if at least one field
2408 is in a different row, you need to use the general @code{@@row$column}
2409 format at least for the first field (i.e the reference must start with
2410 @samp{@@} in order to be interpreted correctly). Examples:
2413 $1..$3 @r{first three fields in the current row}
2414 $P..$Q @r{range, using column names (see under Advanced)}
2415 $<<<..$>> @r{start in third column, continue to the one but last}
2416 @@2$1..@@4$3 @r{6 fields between these two fields (same as @code{A2..C4})}
2417 @@-1$-2..@@-1 @r{3 numbers from the column to the left, 2 up to current row}
2418 @@I..II @r{between first and second hline, short for @code{@@I..@@II}}
2421 @noindent Range references return a vector of values that can be fed
2422 into Calc vector functions. Empty fields in ranges are normally
2423 suppressed, so that the vector contains only the non-empty fields (but
2424 see the @samp{E} mode switch below). If there are no non-empty fields,
2425 @samp{[0]} is returned to avoid syntax errors in formulas.
2427 @subsubheading Field coordinates in formulas
2428 @cindex field coordinates
2429 @cindex coordinates, of field
2430 @cindex row, of field coordinates
2431 @cindex column, of field coordinates
2433 For Calc formulas and Lisp formulas @code{@@#} and @code{$#} can be used to
2434 get the row or column number of the field where the formula result goes.
2435 The traditional Lisp formula equivalents are @code{org-table-current-dline}
2436 and @code{org-table-current-column}. Examples:
2439 if(@@# % 2, $#, string("")) @r{column number on odd lines only}
2440 $3 = remote(FOO, @@@@#$2) @r{copy column 2 from table FOO into}
2441 @r{column 3 of the current table}
2444 @noindent For the second example, table FOO must have at least as many rows
2445 as the current table. Note that this is inefficient@footnote{The computation time scales as
2446 O(N^2) because table FOO is parsed for each field to be copied.} for large
2449 @subsubheading Named references
2450 @cindex named references
2451 @cindex references, named
2452 @cindex name, of column or field
2453 @cindex constants, in calculations
2456 @vindex org-table-formula-constants
2457 @samp{$name} is interpreted as the name of a column, parameter or
2458 constant. Constants are defined globally through the variable
2459 @code{org-table-formula-constants}, and locally (for the file) through a
2463 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
2467 @vindex constants-unit-system
2468 @pindex constants.el
2469 Also properties (@pxref{Properties and Columns}) can be used as
2470 constants in table formulas: for a property @samp{:Xyz:} use the name
2471 @samp{$PROP_Xyz}, and the property will be searched in the current
2472 outline entry and in the hierarchy above it. If you have the
2473 @file{constants.el} package, it will also be used to resolve constants,
2474 including natural constants like @samp{$h} for Planck's constant, and
2475 units like @samp{$km} for kilometers@footnote{@file{constants.el} can
2476 supply the values of constants in two different unit systems, @code{SI}
2477 and @code{cgs}. Which one is used depends on the value of the variable
2478 @code{constants-unit-system}. You can use the @code{#+STARTUP} options
2479 @code{constSI} and @code{constcgs} to set this value for the current
2480 buffer.}. Column names and parameters can be specified in special table
2481 lines. These are described below, see @ref{Advanced features}. All
2482 names must start with a letter, and further consist of letters and
2485 @subsubheading Remote references
2486 @cindex remote references
2487 @cindex references, remote
2488 @cindex references, to a different table
2489 @cindex name, of column or field
2490 @cindex constants, in calculations
2493 You may also reference constants, fields and ranges from a different table,
2494 either in the current file or even in a different file. The syntax is
2497 remote(NAME-OR-ID,REF)
2501 where NAME can be the name of a table in the current file as set by a
2502 @code{#+TBLNAME: NAME} line before the table. It can also be the ID of an
2503 entry, even in a different file, and the reference then refers to the first
2504 table in that entry. REF is an absolute field or range reference as
2505 described above for example @code{@@3$3} or @code{$somename}, valid in the
2508 @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet
2509 @subsection Formula syntax for Calc
2510 @cindex formula syntax, Calc
2511 @cindex syntax, of formulas
2513 A formula can be any algebraic expression understood by the Emacs
2514 @file{Calc} package. @b{Note that @file{calc} has the
2515 non-standard convention that @samp{/} has lower precedence than
2516 @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.} Before
2517 evaluation by @code{calc-eval} (@pxref{Calling Calc from
2518 Your Programs,calc-eval,Calling Calc from Your Lisp Programs,Calc,GNU
2519 Emacs Calc Manual}),
2520 @c FIXME: The link to the Calc manual in HTML does not work.
2521 variable substitution takes place according to the rules described above.
2522 @cindex vectors, in table calculations
2523 The range vectors can be directly fed into the Calc vector functions
2524 like @samp{vmean} and @samp{vsum}.
2526 @cindex format specifier
2527 @cindex mode, for @file{calc}
2528 @vindex org-calc-default-modes
2529 A formula can contain an optional mode string after a semicolon. This
2530 string consists of flags to influence Calc and other modes during
2531 execution. By default, Org uses the standard Calc modes (precision
2532 12, angular units degrees, fraction and symbolic modes off). The display
2533 format, however, has been changed to @code{(float 8)} to keep tables
2534 compact. The default settings can be configured using the variable
2535 @code{org-calc-default-modes}.
2538 p20 @r{set the internal Calc calculation precision to 20 digits}
2539 n3 s3 e2 f4 @r{Normal, scientific, engineering, or fixed}
2540 @r{format of the result of Calc passed back to Org.}
2541 @r{Calc formatting is unlimited in precision as}
2542 @r{long as the Calc calculation precision is greater.}
2543 D R @r{angle modes: degrees, radians}
2544 F S @r{fraction and symbolic modes}
2545 N @r{interpret all fields as numbers, use 0 for non-numbers}
2546 E @r{keep empty fields in ranges}
2551 Unless you use large integer numbers or high-precision-calculation
2552 and -display for floating point numbers you may alternatively provide a
2553 @code{printf} format specifier to reformat the Calc result after it has been
2554 passed back to Org instead of letting Calc already do the
2555 formatting@footnote{The @code{printf} reformatting is limited in precision
2556 because the value passed to it is converted into an @code{integer} or
2557 @code{double}. The @code{integer} is limited in size by truncating the
2558 signed value to 32 bits. The @code{double} is limited in precision to 64
2559 bits overall which leaves approximately 16 significant decimal digits.}.
2563 $1+$2 @r{Sum of first and second field}
2564 $1+$2;%.2f @r{Same, format result to two decimals}
2565 exp($2)+exp($1) @r{Math functions can be used}
2566 $0;%.1f @r{Reformat current cell to 1 decimal}
2567 ($3-32)*5/9 @r{Degrees F -> C conversion}
2568 $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}}
2569 tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1}
2570 sin($1);Dp3%.1e @r{Same, but use printf specifier for display}
2571 vmean($2..$7) @r{Compute column range mean, using vector function}
2572 vmean($2..$7);EN @r{Same, but treat empty fields as 0}
2573 taylor($3,x=7,2) @r{Taylor series of $3, at x=7, second degree}
2576 Calc also contains a complete set of logical operations. For example
2579 if($1<20,teen,string("")) @r{"teen" if age $1 less than 20, else empty}
2582 Note that you can also use two org-specific flags @code{T} and @code{t} for
2583 durations computations @ref{Durations and time values}.
2585 @node Formula syntax for Lisp, Durations and time values, Formula syntax for Calc, The spreadsheet
2586 @subsection Emacs Lisp forms as formulas
2587 @cindex Lisp forms, as table formulas
2589 It is also possible to write a formula in Emacs Lisp; this can be useful for
2590 string manipulation and control structures, if Calc's functionality is not
2591 enough. If a formula starts with a single-quote followed by an opening
2592 parenthesis, then it is evaluated as a Lisp form. The evaluation should
2593 return either a string or a number. Just as with @file{calc} formulas, you
2594 can specify modes and a printf format after a semicolon. With Emacs Lisp
2595 forms, you need to be conscious about the way field references are
2596 interpolated into the form. By default, a reference will be interpolated as
2597 a Lisp string (in double-quotes) containing the field. If you provide the
2598 @samp{N} mode switch, all referenced elements will be numbers (non-number
2599 fields will be zero) and interpolated as Lisp numbers, without quotes. If
2600 you provide the @samp{L} flag, all fields will be interpolated literally,
2601 without quotes. I.e., if you want a reference to be interpreted as a string
2602 by the Lisp form, enclose the reference operator itself in double-quotes,
2603 like @code{"$3"}. Ranges are inserted as space-separated fields, so you can
2604 embed them in list or vector syntax. Here are a few examples---note how the
2605 @samp{N} mode is used when we do computations in Lisp:
2608 @r{Swap the first two characters of the content of column 1}
2609 '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
2610 @r{Add columns 1 and 2, equivalent to Calc's @code{$1+$2}}
2612 @r{Compute the sum of columns 1-4, like Calc's @code{vsum($1..$4)}}
2613 '(apply '+ '($1..$4));N
2616 @node Durations and time values, Field and range formulas, Formula syntax for Lisp, The spreadsheet
2617 @subsection Durations and time values
2618 @cindex Duration, computing
2619 @cindex Time, computing
2620 @vindex org-table-duration-custom-format
2622 If you want to compute time values use the @code{T} flag, either in Calc
2623 formulas or Elisp formulas:
2627 | Task 1 | Task 2 | Total |
2628 |---------+----------+----------|
2629 | 2:12 | 1:47 | 03:59:00 |
2630 | 3:02:20 | -2:07:00 | 0.92 |
2631 #+TBLFM: @@2$3=$1+$2;T::@@3$3=$1+$2;t
2635 Input duration values must be of the form @code{[HH:MM[:SS]}, where seconds
2636 are optional. With the @code{T} flag, computed durations will be displayed
2637 as @code{[HH:MM:SS} (see the first formula above). With the @code{t} flag,
2638 computed durations will be displayed according to the value of the variable
2639 @code{org-table-duration-custom-format}, which defaults to @code{'hours} and
2640 will display the result as a fraction of hours (see the second formula in the
2643 Negative duration values can be manipulated as well, and integers will be
2644 considered as seconds in addition and subtraction.
2646 @node Field and range formulas, Column formulas, Durations and time values, The spreadsheet
2647 @subsection Field and range formulas
2648 @cindex field formula
2649 @cindex range formula
2650 @cindex formula, for individual table field
2651 @cindex formula, for range of fields
2653 To assign a formula to a particular field, type it directly into the field,
2654 preceded by @samp{:=}, for example @samp{:=vsum(@@II..III)}. When you press
2655 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2656 the formula will be stored as the formula for this field, evaluated, and the
2657 current field will be replaced with the result.
2660 Formulas are stored in a special line starting with @samp{#+TBLFM:} directly
2661 below the table. If you type the equation in the 4th field of the 3rd data
2662 line in the table, the formula will look like @samp{@@3$4=$1+$2}. When
2663 inserting/deleting/swapping column and rows with the appropriate commands,
2664 @i{absolute references} (but not relative ones) in stored formulas are
2665 modified in order to still reference the same field. To avoid this from
2666 happening, in particular in range references, anchor ranges at the table
2667 borders (using @code{@@<}, @code{@@>}, @code{$<}, @code{$>}), or at hlines
2668 using the @code{@@I} notation. Automatic adaptation of field references does
2669 of cause not happen if you edit the table structure with normal editing
2670 commands---then you must fix the equations yourself.
2672 Instead of typing an equation into the field, you may also use the following
2676 @orgcmd{C-u C-c =,org-table-eval-formula}
2677 Install a new formula for the current field. The command prompts for a
2678 formula with default taken from the @samp{#+TBLFM:} line, applies
2679 it to the current field, and stores it.
2682 The left-hand side of a formula can also be a special expression in order to
2683 assign the formula to a number of different fields. There is no keyboard
2684 shortcut to enter such range formulas. To add them, use the formula editor
2685 (@pxref{Editing and debugging formulas}) or edit the @code{#+TBLFM:} line
2690 Column formula, valid for the entire column. This is so common that Org
2691 treats these formulas in a special way, see @ref{Column formulas}.
2693 Row formula, applies to all fields in the specified row. @code{@@>=} means
2696 Range formula, applies to all fields in the given rectangular range. This
2697 can also be used to assign a formula to some but not all fields in a row.
2699 Named field, see @ref{Advanced features}.
2702 @node Column formulas, Editing and debugging formulas, Field and range formulas, The spreadsheet
2703 @subsection Column formulas
2704 @cindex column formula
2705 @cindex formula, for table column
2707 When you assign a formula to a simple column reference like @code{$3=}, the
2708 same formula will be used in all fields of that column, with the following
2709 very convenient exceptions: (i) If the table contains horizontal separator
2710 hlines, everything before the first such line is considered part of the table
2711 @emph{header} and will not be modified by column formulas. (ii) Fields that
2712 already get a value from a field/range formula will be left alone by column
2713 formulas. These conditions make column formulas very easy to use.
2715 To assign a formula to a column, type it directly into any field in the
2716 column, preceded by an equal sign, like @samp{=$1+$2}. When you press
2717 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2718 the formula will be stored as the formula for the current column, evaluated
2719 and the current field replaced with the result. If the field contains only
2720 @samp{=}, the previously stored formula for this column is used. For each
2721 column, Org will only remember the most recently used formula. In the
2722 @samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}. The
2723 left-hand side of a column formula can not be the name of column, it must be
2724 the numeric column reference or @code{$>}.
2726 Instead of typing an equation into the field, you may also use the
2730 @orgcmd{C-c =,org-table-eval-formula}
2731 Install a new formula for the current column and replace current field with
2732 the result of the formula. The command prompts for a formula, with default
2733 taken from the @samp{#+TBLFM} line, applies it to the current field and
2734 stores it. With a numeric prefix argument(e.g.@: @kbd{C-5 C-c =}) the command
2735 will apply it to that many consecutive fields in the current column.
2738 @node Editing and debugging formulas, Updating the table, Column formulas, The spreadsheet
2739 @subsection Editing and debugging formulas
2740 @cindex formula editing
2741 @cindex editing, of table formulas
2743 @vindex org-table-use-standard-references
2744 You can edit individual formulas in the minibuffer or directly in the
2745 field. Org can also prepare a special buffer with all active
2746 formulas of a table. When offering a formula for editing, Org
2747 converts references to the standard format (like @code{B3} or @code{D&})
2748 if possible. If you prefer to only work with the internal format (like
2749 @code{@@3$2} or @code{$4}), configure the variable
2750 @code{org-table-use-standard-references}.
2753 @orgcmdkkc{C-c =,C-u C-c =,org-table-eval-formula}
2754 Edit the formula associated with the current column/field in the
2755 minibuffer. See @ref{Column formulas}, and @ref{Field and range formulas}.
2756 @orgcmd{C-u C-u C-c =,org-table-eval-formula}
2757 Re-insert the active formula (either a
2758 field formula, or a column formula) into the current field, so that you
2759 can edit it directly in the field. The advantage over editing in the
2760 minibuffer is that you can use the command @kbd{C-c ?}.
2761 @orgcmd{C-c ?,org-table-field-info}
2762 While editing a formula in a table field, highlight the field(s)
2763 referenced by the reference at the cursor position in the formula.
2765 @findex org-table-toggle-coordinate-overlays
2767 Toggle the display of row and column numbers for a table, using overlays
2768 (@command{org-table-toggle-coordinate-overlays}). These are updated each
2769 time the table is aligned; you can force it with @kbd{C-c C-c}.
2771 @findex org-table-toggle-formula-debugger
2773 Toggle the formula debugger on and off
2774 (@command{org-table-toggle-formula-debugger}). See below.
2775 @orgcmd{C-c ',org-table-edit-formulas}
2776 Edit all formulas for the current table in a special buffer, where the
2777 formulas will be displayed one per line. If the current field has an
2778 active formula, the cursor in the formula editor will mark it.
2779 While inside the special buffer, Org will automatically highlight
2780 any field or range reference at the cursor position. You may edit,
2781 remove and add formulas, and use the following commands:
2783 @orgcmdkkc{C-c C-c,C-x C-s,org-table-fedit-finish}
2784 Exit the formula editor and store the modified formulas. With @kbd{C-u}
2785 prefix, also apply the new formulas to the entire table.
2786 @orgcmd{C-c C-q,org-table-fedit-abort}
2787 Exit the formula editor without installing changes.
2788 @orgcmd{C-c C-r,org-table-fedit-toggle-ref-type}
2789 Toggle all references in the formula editor between standard (like
2790 @code{B3}) and internal (like @code{@@3$2}).
2791 @orgcmd{@key{TAB},org-table-fedit-lisp-indent}
2792 Pretty-print or indent Lisp formula at point. When in a line containing
2793 a Lisp formula, format the formula according to Emacs Lisp rules.
2794 Another @key{TAB} collapses the formula back again. In the open
2795 formula, @key{TAB} re-indents just like in Emacs Lisp mode.
2796 @orgcmd{M-@key{TAB},lisp-complete-symbol}
2797 Complete Lisp symbols, just like in Emacs Lisp mode.
2799 @kindex S-@key{down}
2800 @kindex S-@key{left}
2801 @kindex S-@key{right}
2802 @findex org-table-fedit-ref-up
2803 @findex org-table-fedit-ref-down
2804 @findex org-table-fedit-ref-left
2805 @findex org-table-fedit-ref-right
2806 @item S-@key{up}/@key{down}/@key{left}/@key{right}
2807 Shift the reference at point. For example, if the reference is
2808 @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
2809 This also works for relative references and for hline references.
2810 @orgcmdkkcc{M-S-@key{up},M-S-@key{down},org-table-fedit-line-up,org-table-fedit-line-down}
2811 Move the test line for column formulas in the Org buffer up and
2813 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-fedit-scroll-down,org-table-fedit-scroll-up}
2814 Scroll the window displaying the table.
2816 @findex org-table-toggle-coordinate-overlays
2818 Turn the coordinate grid in the table on and off.
2822 Making a table field blank does not remove the formula associated with
2823 the field, because that is stored in a different line (the @samp{#+TBLFM}
2824 line)---during the next recalculation the field will be filled again.
2825 To remove a formula from a field, you have to give an empty reply when
2826 prompted for the formula, or to edit the @samp{#+TBLFM} line.
2829 You may edit the @samp{#+TBLFM} directly and re-apply the changed
2830 equations with @kbd{C-c C-c} in that line or with the normal
2831 recalculation commands in the table.
2833 @subsubheading Debugging formulas
2834 @cindex formula debugging
2835 @cindex debugging, of table formulas
2836 When the evaluation of a formula leads to an error, the field content
2837 becomes the string @samp{#ERROR}. If you would like see what is going
2838 on during variable substitution and calculation in order to find a bug,
2839 turn on formula debugging in the @code{Tbl} menu and repeat the
2840 calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
2841 field. Detailed information will be displayed.
2843 @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet
2844 @subsection Updating the table
2845 @cindex recomputing table fields
2846 @cindex updating, table
2848 Recalculation of a table is normally not automatic, but needs to be
2849 triggered by a command. See @ref{Advanced features}, for a way to make
2850 recalculation at least semi-automatic.
2852 In order to recalculate a line of a table or the entire table, use the
2856 @orgcmd{C-c *,org-table-recalculate}
2857 Recalculate the current row by first applying the stored column formulas
2858 from left to right, and all field/range formulas in the current row.
2864 Recompute the entire table, line by line. Any lines before the first
2865 hline are left alone, assuming that these are part of the table header.
2867 @orgcmdkkc{C-u C-u C-c *,C-u C-u C-c C-c,org-table-iterate}
2868 Iterate the table by recomputing it until no further changes occur.
2869 This may be necessary if some computed fields use the value of other
2870 fields that are computed @i{later} in the calculation sequence.
2871 @item M-x org-table-recalculate-buffer-tables
2872 @findex org-table-recalculate-buffer-tables
2873 Recompute all tables in the current buffer.
2874 @item M-x org-table-iterate-buffer-tables
2875 @findex org-table-iterate-buffer-tables
2876 Iterate all tables in the current buffer, in order to converge table-to-table
2880 @node Advanced features, , Updating the table, The spreadsheet
2881 @subsection Advanced features
2883 If you want the recalculation of fields to happen automatically, or if you
2884 want to be able to assign @i{names}@footnote{Such names must start by an
2885 alphabetic character and use only alphanumeric/underscore characters.} to
2886 fields and columns, you need to reserve the first column of the table for
2887 special marking characters.
2890 @orgcmd{C-#,org-table-rotate-recalc-marks}
2891 Rotate the calculation mark in first column through the states @samp{ },
2892 @samp{#}, @samp{*}, @samp{!}, @samp{$}. When there is an active region,
2893 change all marks in the region.
2896 Here is an example of a table that collects exam results of students and
2897 makes use of these features:
2901 |---+---------+--------+--------+--------+-------+------|
2902 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
2903 |---+---------+--------+--------+--------+-------+------|
2904 | ! | | P1 | P2 | P3 | Tot | |
2905 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
2906 | ^ | | m1 | m2 | m3 | mt | |
2907 |---+---------+--------+--------+--------+-------+------|
2908 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
2909 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
2910 |---+---------+--------+--------+--------+-------+------|
2911 | | Average | | | | 29.7 | |
2912 | ^ | | | | | at | |
2913 | $ | max=50 | | | | | |
2914 |---+---------+--------+--------+--------+-------+------|
2915 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
2919 @noindent @b{Important}: please note that for these special tables,
2920 recalculating the table with @kbd{C-u C-c *} will only affect rows that
2921 are marked @samp{#} or @samp{*}, and fields that have a formula assigned
2922 to the field itself. The column formulas are not applied in rows with
2925 @cindex marking characters, tables
2926 The marking characters have the following meaning:
2929 The fields in this line define names for the columns, so that you may
2930 refer to a column as @samp{$Tot} instead of @samp{$6}.
2932 This row defines names for the fields @emph{above} the row. With such
2933 a definition, any formula in the table may use @samp{$m1} to refer to
2934 the value @samp{10}. Also, if you assign a formula to a names field, it
2935 will be stored as @samp{$name=...}.
2937 Similar to @samp{^}, but defines names for the fields in the row
2940 Fields in this row can define @emph{parameters} for formulas. For
2941 example, if a field in a @samp{$} row contains @samp{max=50}, then
2942 formulas in this table can refer to the value 50 using @samp{$max}.
2943 Parameters work exactly like constants, only that they can be defined on
2946 Fields in this row are automatically recalculated when pressing
2947 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row
2948 is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked
2949 lines will be left alone by this command.
2951 Selects this line for global recalculation with @kbd{C-u C-c *}, but
2952 not for automatic recalculation. Use this when automatic
2953 recalculation slows down editing too much.
2955 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
2956 All lines that should be recalculated should be marked with @samp{#}
2959 Do not export this line. Useful for lines that contain the narrowing
2960 @samp{<N>} markers or column group markers.
2963 Finally, just to whet your appetite for what can be done with the
2964 fantastic @file{calc.el} package, here is a table that computes the Taylor
2965 series of degree @code{n} at location @code{x} for a couple of
2970 |---+-------------+---+-----+--------------------------------------|
2971 | | Func | n | x | Result |
2972 |---+-------------+---+-----+--------------------------------------|
2973 | # | exp(x) | 1 | x | 1 + x |
2974 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
2975 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
2976 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
2977 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
2978 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
2979 |---+-------------+---+-----+--------------------------------------|
2980 #+TBLFM: $5=taylor($2,$4,$3);n3
2984 @node Org-Plot, , The spreadsheet, Tables
2986 @cindex graph, in tables
2987 @cindex plot tables using Gnuplot
2990 Org-Plot can produce 2D and 3D graphs of information stored in org tables
2991 using @file{Gnuplot} @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
2992 @uref{http://cars9.uchicago.edu/~ravel/software/gnuplot-mode.html}. To see
2993 this in action, ensure that you have both Gnuplot and Gnuplot mode installed
2994 on your system, then call @code{org-plot/gnuplot} on the following table.
2998 #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
2999 | Sede | Max cites | H-index |
3000 |-----------+-----------+---------|
3001 | Chile | 257.72 | 21.39 |
3002 | Leeds | 165.77 | 19.68 |
3003 | Sao Paolo | 71.00 | 11.50 |
3004 | Stockholm | 134.19 | 14.33 |
3005 | Morelia | 257.56 | 17.67 |
3009 Notice that Org Plot is smart enough to apply the table's headers as labels.
3010 Further control over the labels, type, content, and appearance of plots can
3011 be exercised through the @code{#+PLOT:} lines preceding a table. See below
3012 for a complete list of Org-plot options. For more information and examples
3013 see the Org-plot tutorial at
3014 @uref{http://orgmode.org/worg/org-tutorials/org-plot.html}.
3016 @subsubheading Plot Options
3020 Specify any @command{gnuplot} option to be set when graphing.
3023 Specify the title of the plot.
3026 Specify which column of the table to use as the @code{x} axis.
3029 Specify the columns to graph as a Lisp style list, surrounded by parentheses
3030 and separated by spaces for example @code{dep:(3 4)} to graph the third and
3031 fourth columns (defaults to graphing all other columns aside from the @code{ind}
3035 Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
3038 Specify a @code{with} option to be inserted for every col being plotted
3039 (e.g.@: @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
3040 Defaults to @code{lines}.
3043 If you want to plot to a file, specify @code{"@var{path/to/desired/output-file}"}.
3046 List of labels to be used for the @code{deps} (defaults to the column headers
3050 Specify an entire line to be inserted in the Gnuplot script.
3053 When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
3054 flat mapping rather than a @code{3d} slope.
3057 Specify format of Org mode timestamps as they will be parsed by Gnuplot.
3058 Defaults to @samp{%Y-%m-%d-%H:%M:%S}.
3061 If you want total control, you can specify a script file (place the file name
3062 between double-quotes) which will be used to plot. Before plotting, every
3063 instance of @code{$datafile} in the specified script will be replaced with
3064 the path to the generated data file. Note: even if you set this option, you
3065 may still want to specify the plot type, as that can impact the content of
3069 @node Hyperlinks, TODO Items, Tables, Top
3073 Like HTML, Org provides links inside a file, external links to
3074 other files, Usenet articles, emails, and much more.
3077 * Link format:: How links in Org are formatted
3078 * Internal links:: Links to other places in the current file
3079 * External links:: URL-like links to the world
3080 * Handling links:: Creating, inserting and following
3081 * Using links outside Org:: Linking from my C source code?
3082 * Link abbreviations:: Shortcuts for writing complex links
3083 * Search options:: Linking to a specific location
3084 * Custom searches:: When the default search is not enough
3087 @node Link format, Internal links, Hyperlinks, Hyperlinks
3088 @section Link format
3090 @cindex format, of links
3092 Org will recognize plain URL-like links and activate them as
3093 clickable links. The general link format, however, looks like this:
3096 [[link][description]] @r{or alternatively} [[link]]
3100 Once a link in the buffer is complete (all brackets present), Org
3101 will change the display so that @samp{description} is displayed instead
3102 of @samp{[[link][description]]} and @samp{link} is displayed instead of
3103 @samp{[[link]]}. Links will be highlighted in the face @code{org-link},
3104 which by default is an underlined face. You can directly edit the
3105 visible part of a link. Note that this can be either the @samp{link}
3106 part (if there is no description) or the @samp{description} part. To
3107 edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
3110 If you place the cursor at the beginning or just behind the end of the
3111 displayed text and press @key{BACKSPACE}, you will remove the
3112 (invisible) bracket at that location. This makes the link incomplete
3113 and the internals are again displayed as plain text. Inserting the
3114 missing bracket hides the link internals again. To show the
3115 internal structure of all links, use the menu entry
3116 @code{Org->Hyperlinks->Literal links}.
3118 @node Internal links, External links, Link format, Hyperlinks
3119 @section Internal links
3120 @cindex internal links
3121 @cindex links, internal
3122 @cindex targets, for links
3124 @cindex property, CUSTOM_ID
3125 If the link does not look like a URL, it is considered to be internal in the
3126 current file. The most important case is a link like
3127 @samp{[[#my-custom-id]]} which will link to the entry with the
3128 @code{CUSTOM_ID} property @samp{my-custom-id}. Such custom IDs are very good
3129 for HTML export (@pxref{HTML export}) where they produce pretty section
3130 links. You are responsible yourself to make sure these custom IDs are unique
3133 Links such as @samp{[[My Target]]} or @samp{[[My Target][Find my target]]}
3134 lead to a text search in the current file.
3136 The link can be followed with @kbd{C-c C-o} when the cursor is on the link,
3137 or with a mouse click (@pxref{Handling links}). Links to custom IDs will
3138 point to the corresponding headline. The preferred match for a text link is
3139 a @i{dedicated target}: the same string in double angular brackets. Targets
3140 may be located anywhere; sometimes it is convenient to put them into a
3141 comment line. For example
3147 @noindent In HTML export (@pxref{HTML export}), such targets will become
3148 named anchors for direct access through @samp{http} links@footnote{Note that
3149 text before the first headline is usually not exported, so the first such
3150 target should be after the first headline, or in the line directly before the
3153 If no dedicated target exists, Org will search for a headline that is exactly
3154 the link text but may also include a TODO keyword and tags@footnote{To insert
3155 a link targeting a headline, in-buffer completion can be used. Just type a
3156 star followed by a few optional letters into the buffer and press
3157 @kbd{M-@key{TAB}}. All headlines in the current buffer will be offered as
3158 completions.}. In non-Org files, the search will look for the words in the
3159 link text. In the above example the search would be for @samp{my target}.
3161 Following a link pushes a mark onto Org's own mark ring. You can
3162 return to the previous position with @kbd{C-c &}. Using this command
3163 several times in direct succession goes back to positions recorded
3167 * Radio targets:: Make targets trigger links in plain text
3170 @node Radio targets, , Internal links, Internal links
3171 @subsection Radio targets
3172 @cindex radio targets
3173 @cindex targets, radio
3174 @cindex links, radio targets
3176 Org can automatically turn any occurrences of certain target names
3177 in normal text into a link. So without explicitly creating a link, the
3178 text connects to the target radioing its position. Radio targets are
3179 enclosed by triple angular brackets. For example, a target @samp{<<<My
3180 Target>>>} causes each occurrence of @samp{my target} in normal text to
3181 become activated as a link. The Org file is scanned automatically
3182 for radio targets only when the file is first loaded into Emacs. To
3183 update the target list during editing, press @kbd{C-c C-c} with the
3184 cursor on or at a target.
3186 @node External links, Handling links, Internal links, Hyperlinks
3187 @section External links
3188 @cindex links, external
3189 @cindex external links
3190 @cindex links, external
3198 @cindex WANDERLUST links
3200 @cindex USENET links
3205 Org supports links to files, websites, Usenet and email messages,
3206 BBDB database entries and links to both IRC conversations and their
3207 logs. External links are URL-like locators. They start with a short
3208 identifying string followed by a colon. There can be no space after
3209 the colon. The following list shows examples for each link type.
3212 http://www.astro.uva.nl/~dominik @r{on the web}
3213 doi:10.1000/182 @r{DOI for an electronic resource}
3214 file:/home/dominik/images/jupiter.jpg @r{file, absolute path}
3215 /home/dominik/images/jupiter.jpg @r{same as above}
3216 file:papers/last.pdf @r{file, relative path}
3217 ./papers/last.pdf @r{same as above}
3218 file:/myself@@some.where:papers/last.pdf @r{file, path on remote machine}
3219 /myself@@some.where:papers/last.pdf @r{same as above}
3220 file:sometextfile::NNN @r{file, jump to line number}
3221 file:projects.org @r{another Org file}
3222 file:projects.org::some words @r{text search in Org file}@footnote{
3223 The actual behavior of the search will depend on the value of
3224 the variable @code{org-link-search-must-match-exact-headline}. If its value
3225 is nil, then a fuzzy text search will be done. If it is t, then only the
3226 exact headline will be matched. If the value is @code{'query-to-create},
3227 then an exact headline will be searched; if it is not found, then the user
3228 will be queried to create it.}
3229 file:projects.org::*task title @r{heading search in Org file}
3230 file+sys:/path/to/file @r{open via OS, like double-click}
3231 file+emacs:/path/to/file @r{force opening by Emacs}
3232 docview:papers/last.pdf::NNN @r{open in doc-view mode at page}
3233 id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID}
3234 news:comp.emacs @r{Usenet link}
3235 mailto:adent@@galaxy.net @r{Mail link}
3236 vm:folder @r{VM folder link}
3237 vm:folder#id @r{VM message link}
3238 vm://myself@@some.where.org/folder#id @r{VM on remote machine}
3239 wl:folder @r{WANDERLUST folder link}
3240 wl:folder#id @r{WANDERLUST message link}
3241 mhe:folder @r{MH-E folder link}
3242 mhe:folder#id @r{MH-E message link}
3243 rmail:folder @r{RMAIL folder link}
3244 rmail:folder#id @r{RMAIL message link}
3245 gnus:group @r{Gnus group link}
3246 gnus:group#id @r{Gnus article link}
3247 bbdb:R.*Stallman @r{BBDB link (with regexp)}
3248 irc:/irc.com/#emacs/bob @r{IRC link}
3249 info:org#External links @r{Info node link}
3250 shell:ls *.org @r{A shell command}
3251 elisp:org-agenda @r{Interactive Elisp command}
3252 elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
3255 For customizing Org to add new link types @ref{Adding hyperlink types}.
3257 A link should be enclosed in double brackets and may contain a
3258 descriptive text to be displayed instead of the URL (@pxref{Link
3259 format}), for example:
3262 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
3266 If the description is a file name or URL that points to an image, HTML
3267 export (@pxref{HTML export}) will inline the image as a clickable
3268 button. If there is no description at all and the link points to an
3270 that image will be inlined into the exported HTML file.
3272 @cindex square brackets, around links
3273 @cindex plain text external links
3274 Org also finds external links in the normal text and activates them
3275 as links. If spaces must be part of the link (for example in
3276 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
3277 about the end of the link, enclose them in square brackets.
3279 @node Handling links, Using links outside Org, External links, Hyperlinks
3280 @section Handling links
3281 @cindex links, handling
3283 Org provides methods to create a link in the correct syntax, to
3284 insert it into an Org file, and to follow the link.
3287 @orgcmd{C-c l,org-store-link}
3288 @cindex storing links
3289 Store a link to the current location. This is a @emph{global} command (you
3290 must create the key binding yourself) which can be used in any buffer to
3291 create a link. The link will be stored for later insertion into an Org
3292 buffer (see below). What kind of link will be created depends on the current
3295 @b{Org mode buffers}@*
3296 For Org files, if there is a @samp{<<target>>} at the cursor, the link points
3297 to the target. Otherwise it points to the current headline, which will also
3298 be the description@footnote{If the headline contains a timestamp, it will be
3299 removed from the link and result in a wrong link -- you should avoid putting
3300 timestamp in the headline.}.
3302 @vindex org-link-to-org-use-id
3303 @cindex property, CUSTOM_ID
3304 @cindex property, ID
3305 If the headline has a @code{CUSTOM_ID} property, a link to this custom ID
3306 will be stored. In addition or alternatively (depending on the value of
3307 @code{org-link-to-org-use-id}), a globally unique @code{ID} property will be
3308 created and/or used to construct a link. So using this command in Org
3309 buffers will potentially create two links: a human-readable from the custom
3310 ID, and one that is globally unique and works even if the entry is moved from
3311 file to file. Later, when inserting the link, you need to decide which one
3314 @b{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus}@*
3315 Pretty much all Emacs mail clients are supported. The link will point to the
3316 current article, or, in some GNUS buffers, to the group. The description is
3317 constructed from the author and the subject.
3319 @b{Web browsers: W3 and W3M}@*
3320 Here the link will be the current URL, with the page title as description.
3322 @b{Contacts: BBDB}@*
3323 Links created in a BBDB buffer will point to the current entry.
3326 @vindex org-irc-link-to-logs
3327 For IRC links, if you set the variable @code{org-irc-link-to-logs} to
3328 @code{t}, a @samp{file:/} style link to the relevant point in the logs for
3329 the current conversation is created. Otherwise an @samp{irc:/} style link to
3330 the user/channel/server under the point will be stored.
3333 For any other files, the link will point to the file, with a search string
3334 (@pxref{Search options}) pointing to the contents of the current line. If
3335 there is an active region, the selected words will form the basis of the
3336 search string. If the automatically created link is not working correctly or
3337 accurately enough, you can write custom functions to select the search string
3338 and to do the search for particular file types---see @ref{Custom searches}.
3339 The key binding @kbd{C-c l} is only a suggestion---see @ref{Installation}.
3342 When the cursor is in an agenda view, the created link points to the
3343 entry referenced by the current line.
3346 @orgcmd{C-c C-l,org-insert-link}
3347 @cindex link completion
3348 @cindex completion, of links
3349 @cindex inserting links
3350 @vindex org-keep-stored-link-after-insertion
3351 Insert a link@footnote{ Note that you don't have to use this command to
3352 insert a link. Links in Org are plain text, and you can type or paste them
3353 straight into the buffer. By using this command, the links are automatically
3354 enclosed in double brackets, and you will be asked for the optional
3355 descriptive text.}. This prompts for a link to be inserted into the buffer.
3356 You can just type a link, using text for an internal link, or one of the link
3357 type prefixes mentioned in the examples above. The link will be inserted
3358 into the buffer@footnote{After insertion of a stored link, the link will be
3359 removed from the list of stored links. To keep it in the list later use, use
3360 a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
3361 @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
3362 If some text was selected when this command is called, the selected text
3363 becomes the default description.
3365 @b{Inserting stored links}@*
3366 All links stored during the
3367 current session are part of the history for this prompt, so you can access
3368 them with @key{up} and @key{down} (or @kbd{M-p/n}).
3370 @b{Completion support}@* Completion with @key{TAB} will help you to insert
3371 valid link prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
3372 defined through link abbreviations (@pxref{Link abbreviations}). If you
3373 press @key{RET} after inserting only the @var{prefix}, Org will offer
3374 specific completion support for some link types@footnote{This works by
3375 calling a special function @code{org-PREFIX-complete-link}.} For
3376 example, if you type @kbd{file @key{RET}}, file name completion (alternative
3377 access: @kbd{C-u C-c C-l}, see below) will be offered, and after @kbd{bbdb
3378 @key{RET}} you can complete contact names.
3380 @cindex file name completion
3381 @cindex completion, of file names
3382 When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
3383 a file will be inserted and you may use file name completion to select
3384 the name of the file. The path to the file is inserted relative to the
3385 directory of the current Org file, if the linked file is in the current
3386 directory or in a sub-directory of it, or if the path is written relative
3387 to the current directory using @samp{../}. Otherwise an absolute path
3388 is used, if possible with @samp{~/} for your home directory. You can
3389 force an absolute path with two @kbd{C-u} prefixes.
3391 @item C-c C-l @ @r{(with cursor on existing link)}
3392 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
3393 link and description parts of the link.
3395 @cindex following links
3396 @orgcmd{C-c C-o,org-open-at-point}
3397 @vindex org-file-apps
3398 @vindex org-link-frame-setup
3399 Open link at point. This will launch a web browser for URLs (using
3400 @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
3401 the corresponding links, and execute the command in a shell link. When the
3402 cursor is on an internal link, this command runs the corresponding search.
3403 When the cursor is on a TAG list in a headline, it creates the corresponding
3404 TAGS view. If the cursor is on a timestamp, it compiles the agenda for that
3405 date. Furthermore, it will visit text and remote files in @samp{file:} links
3406 with Emacs and select a suitable application for local non-text files.
3407 Classification of files is based on file extension only. See option
3408 @code{org-file-apps}. If you want to override the default application and
3409 visit the file with Emacs, use a @kbd{C-u} prefix. If you want to avoid
3410 opening in Emacs, use a @kbd{C-u C-u} prefix.@*
3411 If the cursor is on a headline, but not on a link, offer all links in the
3412 headline and entry text. If you want to setup the frame configuration for
3413 following links, customize @code{org-link-frame-setup}.
3416 @vindex org-return-follows-link
3417 When @code{org-return-follows-link} is set, @kbd{@key{RET}} will also follow
3424 On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
3425 would. Under Emacs 22 and later, @kbd{mouse-1} will also follow a link.
3429 @vindex org-display-internal-link-with-indirect-buffer
3430 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
3431 internal links to be displayed in another window@footnote{See the
3432 variable @code{org-display-internal-link-with-indirect-buffer}}.
3434 @orgcmd{C-c C-x C-v,org-toggle-inline-images}
3435 @cindex inlining images
3436 @cindex images, inlining
3437 @vindex org-startup-with-inline-images
3438 @cindex @code{inlineimages}, STARTUP keyword
3439 @cindex @code{noinlineimages}, STARTUP keyword
3440 Toggle the inline display of linked images. Normally this will only inline
3441 images that have no description part in the link, i.e.@: images that will also
3442 be inlined during export. When called with a prefix argument, also display
3443 images that do have a link description. You can ask for inline images to be
3444 displayed at startup by configuring the variable
3445 @code{org-startup-with-inline-images}@footnote{with corresponding
3446 @code{#+STARTUP} keywords @code{inlineimages} and @code{inlineimages}}.
3447 @orgcmd{C-c %,org-mark-ring-push}
3449 Push the current position onto the mark ring, to be able to return
3450 easily. Commands following an internal link do this automatically.
3452 @orgcmd{C-c &,org-mark-ring-goto}
3453 @cindex links, returning to
3454 Jump back to a recorded position. A position is recorded by the
3455 commands following internal links, and by @kbd{C-c %}. Using this
3456 command several times in direct succession moves through a ring of
3457 previously recorded positions.
3459 @orgcmdkkcc{C-c C-x C-n,C-c C-x C-p,org-next-link,org-previous-link}
3460 @cindex links, finding next/previous
3461 Move forward/backward to the next link in the buffer. At the limit of
3462 the buffer, the search fails once, and then wraps around. The key
3463 bindings for this are really too long; you might want to bind this also
3464 to @kbd{C-n} and @kbd{C-p}
3466 (add-hook 'org-load-hook
3468 (define-key org-mode-map "\C-n" 'org-next-link)
3469 (define-key org-mode-map "\C-p" 'org-previous-link)))
3473 @node Using links outside Org, Link abbreviations, Handling links, Hyperlinks
3474 @section Using links outside Org
3476 You can insert and follow links that have Org syntax not only in
3477 Org, but in any Emacs buffer. For this, you should create two
3478 global commands, like this (please select suitable global keys
3482 (global-set-key "\C-c L" 'org-insert-link-global)
3483 (global-set-key "\C-c o" 'org-open-at-point-global)
3486 @node Link abbreviations, Search options, Using links outside Org, Hyperlinks
3487 @section Link abbreviations
3488 @cindex link abbreviations
3489 @cindex abbreviation, links
3491 Long URLs can be cumbersome to type, and often many similar links are
3492 needed in a document. For this you can use link abbreviations. An
3493 abbreviated link looks like this
3496 [[linkword:tag][description]]
3500 @vindex org-link-abbrev-alist
3501 where the tag is optional.
3502 The @i{linkword} must be a word, starting with a letter, followed by
3503 letters, numbers, @samp{-}, and @samp{_}. Abbreviations are resolved
3504 according to the information in the variable @code{org-link-abbrev-alist}
3505 that relates the linkwords to replacement text. Here is an example:
3509 (setq org-link-abbrev-alist
3510 '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
3511 ("google" . "http://www.google.com/search?q=")
3512 ("gmap" . "http://maps.google.com/maps?q=%s")
3513 ("omap" . "http://nominatim.openstreetmap.org/search?q=%s&polygon=1")
3514 ("ads" . "http://adsabs.harvard.edu/cgi-bin/nph-abs_connect?author=%s&db_key=AST")))
3518 If the replacement text contains the string @samp{%s}, it will be
3519 replaced with the tag. Otherwise the tag will be appended to the string
3520 in order to create the link. You may also specify a function that will
3521 be called with the tag as the only argument to create the link.
3523 With the above setting, you could link to a specific bug with
3524 @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
3525 @code{[[google:OrgMode]]}, show the map location of the Free Software
3526 Foundation @code{[[gmap:51 Franklin Street, Boston]]} or of Carsten office
3527 @code{[[omap:Science Park 904, Amsterdam, The Netherlands]]} and find out
3528 what the Org author is doing besides Emacs hacking with
3529 @code{[[ads:Dominik,C]]}.
3531 If you need special abbreviations just for a single Org buffer, you
3532 can define them in the file with
3536 #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
3537 #+LINK: google http://www.google.com/search?q=%s
3541 In-buffer completion (@pxref{Completion}) can be used after @samp{[} to
3542 complete link abbreviations. You may also define a function
3543 @code{org-PREFIX-complete-link} that implements special (e.g.@: completion)
3544 support for inserting such a link with @kbd{C-c C-l}. Such a function should
3545 not accept any arguments, and return the full link with prefix.
3547 @node Search options, Custom searches, Link abbreviations, Hyperlinks
3548 @section Search options in file links
3549 @cindex search option in file links
3550 @cindex file links, searching
3552 File links can contain additional information to make Emacs jump to a
3553 particular location in the file when following a link. This can be a
3554 line number or a search option after a double@footnote{For backward
3555 compatibility, line numbers can also follow a single colon.} colon. For
3556 example, when the command @kbd{C-c l} creates a link (@pxref{Handling
3557 links}) to a file, it encodes the words in the current line as a search
3558 string that can be used to find this line back later when following the
3559 link with @kbd{C-c C-o}.
3561 Here is the syntax of the different ways to attach a search to a file
3562 link, together with an explanation:
3565 [[file:~/code/main.c::255]]
3566 [[file:~/xx.org::My Target]]
3567 [[file:~/xx.org::*My Target]]
3568 [[file:~/xx.org::#my-custom-id]]
3569 [[file:~/xx.org::/regexp/]]
3576 Search for a link target @samp{<<My Target>>}, or do a text search for
3577 @samp{my target}, similar to the search in internal links, see
3578 @ref{Internal links}. In HTML export (@pxref{HTML export}), such a file
3579 link will become an HTML reference to the corresponding named anchor in
3582 In an Org file, restrict search to headlines.
3584 Link to a heading with a @code{CUSTOM_ID} property
3586 Do a regular expression search for @code{regexp}. This uses the Emacs
3587 command @code{occur} to list all matches in a separate window. If the
3588 target file is in Org mode, @code{org-occur} is used to create a
3589 sparse tree with the matches.
3590 @c If the target file is a directory,
3591 @c @code{grep} will be used to search all files in the directory.
3594 As a degenerate case, a file link with an empty file name can be used
3595 to search the current file. For example, @code{[[file:::find me]]} does
3596 a search for @samp{find me} in the current file, just as
3597 @samp{[[find me]]} would.
3599 @node Custom searches, , Search options, Hyperlinks
3600 @section Custom Searches
3601 @cindex custom search strings
3602 @cindex search strings, custom
3604 The default mechanism for creating search strings and for doing the
3605 actual search related to a file link may not work correctly in all
3606 cases. For example, Bib@TeX{} database files have many entries like
3607 @samp{year="1993"} which would not result in good search strings,
3608 because the only unique identification for a Bib@TeX{} entry is the
3611 @vindex org-create-file-search-functions
3612 @vindex org-execute-file-search-functions
3613 If you come across such a problem, you can write custom functions to set
3614 the right search string for a particular file type, and to do the search
3615 for the string in the file. Using @code{add-hook}, these functions need
3616 to be added to the hook variables
3617 @code{org-create-file-search-functions} and
3618 @code{org-execute-file-search-functions}. See the docstring for these
3619 variables for more information. Org actually uses this mechanism
3620 for Bib@TeX{} database files, and you can use the corresponding code as
3621 an implementation example. See the file @file{org-bibtex.el}.
3623 @node TODO Items, Tags, Hyperlinks, Top
3627 Org mode does not maintain TODO lists as separate documents@footnote{Of
3628 course, you can make a document that contains only long lists of TODO items,
3629 but this is not required.}. Instead, TODO items are an integral part of the
3630 notes file, because TODO items usually come up while taking notes! With Org
3631 mode, simply mark any entry in a tree as being a TODO item. In this way,
3632 information is not duplicated, and the entire context from which the TODO
3633 item emerged is always present.
3635 Of course, this technique for managing TODO items scatters them
3636 throughout your notes file. Org mode compensates for this by providing
3637 methods to give you an overview of all the things that you have to do.
3640 * TODO basics:: Marking and displaying TODO entries
3641 * TODO extensions:: Workflow and assignments
3642 * Progress logging:: Dates and notes for progress
3643 * Priorities:: Some things are more important than others
3644 * Breaking down tasks:: Splitting a task into manageable pieces
3645 * Checkboxes:: Tick-off lists
3648 @node TODO basics, TODO extensions, TODO Items, TODO Items
3649 @section Basic TODO functionality
3651 Any headline becomes a TODO item when it starts with the word
3652 @samp{TODO}, for example:
3655 *** TODO Write letter to Sam Fortune
3659 The most important commands to work with TODO entries are:
3662 @orgcmd{C-c C-t,org-todo}
3663 @cindex cycling, of TODO states
3664 Rotate the TODO state of the current item among
3667 ,-> (unmarked) -> TODO -> DONE --.
3668 '--------------------------------'
3671 The same rotation can also be done ``remotely'' from the timeline and
3672 agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}).
3674 @orgkey{C-u C-c C-t}
3675 Select a specific keyword using completion or (if it has been set up)
3676 the fast selection interface. For the latter, you need to assign keys
3677 to TODO states, see @ref{Per-file keywords}, and @ref{Setting tags}, for
3680 @kindex S-@key{right}
3681 @kindex S-@key{left}
3682 @item S-@key{right} @ @r{/} @ S-@key{left}
3683 @vindex org-treat-S-cursor-todo-selection-as-state-change
3684 Select the following/preceding TODO state, similar to cycling. Useful
3685 mostly if more than two TODO states are possible (@pxref{TODO
3686 extensions}). See also @ref{Conflicts}, for a discussion of the interaction
3687 with @code{shift-selection-mode}. See also the variable
3688 @code{org-treat-S-cursor-todo-selection-as-state-change}.
3689 @orgcmd{C-c / t,org-show-todo-key}
3690 @cindex sparse tree, for TODO
3691 @vindex org-todo-keywords
3692 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds the
3693 entire buffer, but shows all TODO items (with not-DONE state) and the
3694 headings hierarchy above them. With a prefix argument (or by using @kbd{C-c
3695 / T}), search for a specific TODO. You will be prompted for the keyword, and
3696 you can also give a list of keywords like @code{KWD1|KWD2|...} to list
3697 entries that match any one of these keywords. With a numeric prefix argument
3698 N, show the tree for the Nth keyword in the variable
3699 @code{org-todo-keywords}. With two prefix arguments, find all TODO states,
3700 both un-done and done.
3701 @orgcmd{C-c a t,org-todo-list}
3702 Show the global TODO list. Collects the TODO items (with not-DONE states)
3703 from all agenda files (@pxref{Agenda Views}) into a single buffer. The new
3704 buffer will be in @code{agenda-mode}, which provides commands to examine and
3705 manipulate the TODO entries from the new buffer (@pxref{Agenda commands}).
3706 @xref{Global TODO list}, for more information.
3707 @orgcmd{S-M-@key{RET},org-insert-todo-heading}
3708 Insert a new TODO entry below the current one.
3712 @vindex org-todo-state-tags-triggers
3713 Changing a TODO state can also trigger tag changes. See the docstring of the
3714 option @code{org-todo-state-tags-triggers} for details.
3716 @node TODO extensions, Progress logging, TODO basics, TODO Items
3717 @section Extended use of TODO keywords
3718 @cindex extended TODO keywords
3720 @vindex org-todo-keywords
3721 By default, marked TODO entries have one of only two states: TODO and
3722 DONE. Org mode allows you to classify TODO items in more complex ways
3723 with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With
3724 special setup, the TODO keyword system can work differently in different
3727 Note that @i{tags} are another way to classify headlines in general and
3728 TODO items in particular (@pxref{Tags}).
3731 * Workflow states:: From TODO to DONE in steps
3732 * TODO types:: I do this, Fred does the rest
3733 * Multiple sets in one file:: Mixing it all, and still finding your way
3734 * Fast access to TODO states:: Single letter selection of a state
3735 * Per-file keywords:: Different files, different requirements
3736 * Faces for TODO keywords:: Highlighting states
3737 * TODO dependencies:: When one task needs to wait for others
3740 @node Workflow states, TODO types, TODO extensions, TODO extensions
3741 @subsection TODO keywords as workflow states
3742 @cindex TODO workflow
3743 @cindex workflow states as TODO keywords
3745 You can use TODO keywords to indicate different @emph{sequential} states
3746 in the process of working on an item, for example@footnote{Changing
3747 this variable only becomes effective after restarting Org mode in a
3751 (setq org-todo-keywords
3752 '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
3755 The vertical bar separates the TODO keywords (states that @emph{need
3756 action}) from the DONE states (which need @emph{no further action}). If
3757 you don't provide the separator bar, the last state is used as the DONE
3759 @cindex completion, of TODO keywords
3760 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
3761 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED. You may
3762 also use a numeric prefix argument to quickly select a specific state. For
3763 example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY.
3764 Or you can use @kbd{S-@key{left}} to go backward through the sequence. If you
3765 define many keywords, you can use in-buffer completion
3766 (@pxref{Completion}) or even a special one-key selection scheme
3767 (@pxref{Fast access to TODO states}) to insert these words into the
3768 buffer. Changing a TODO state can be logged with a timestamp, see
3769 @ref{Tracking TODO state changes}, for more information.
3771 @node TODO types, Multiple sets in one file, Workflow states, TODO extensions
3772 @subsection TODO keywords as types
3774 @cindex names as TODO keywords
3775 @cindex types as TODO keywords
3777 The second possibility is to use TODO keywords to indicate different
3778 @emph{types} of action items. For example, you might want to indicate
3779 that items are for ``work'' or ``home''. Or, when you work with several
3780 people on a single project, you might want to assign action items
3781 directly to persons, by using their names as TODO keywords. This would
3782 be set up like this:
3785 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
3788 In this case, different keywords do not indicate a sequence, but rather
3789 different types. So the normal work flow would be to assign a task to a
3790 person, and later to mark it DONE. Org mode supports this style by adapting
3791 the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
3792 @kbd{t} command in the timeline and agenda buffers.}. When used several
3793 times in succession, it will still cycle through all names, in order to first
3794 select the right type for a task. But when you return to the item after some
3795 time and execute @kbd{C-c C-t} again, it will switch from any name directly
3796 to DONE. Use prefix arguments or completion to quickly select a specific
3797 name. You can also review the items of a specific TODO type in a sparse tree
3798 by using a numeric prefix to @kbd{C-c / t}. For example, to see all things
3799 Lucy has to do, you would use @kbd{C-3 C-c / t}. To collect Lucy's items
3800 from all agenda files into a single buffer, you would use the numeric prefix
3801 argument as well when creating the global TODO list: @kbd{C-3 C-c a t}.
3803 @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions
3804 @subsection Multiple keyword sets in one file
3805 @cindex TODO keyword sets
3807 Sometimes you may want to use different sets of TODO keywords in
3808 parallel. For example, you may want to have the basic
3809 @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
3810 separate state indicating that an item has been canceled (so it is not
3811 DONE, but also does not require action). Your setup would then look
3815 (setq org-todo-keywords
3816 '((sequence "TODO" "|" "DONE")
3817 (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
3818 (sequence "|" "CANCELED")))
3821 The keywords should all be different, this helps Org mode to keep track
3822 of which subsequence should be used for a given entry. In this setup,
3823 @kbd{C-c C-t} only operates within a subsequence, so it switches from
3824 @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
3825 (nothing) to @code{REPORT}. Therefore you need a mechanism to initially
3826 select the correct sequence. Besides the obvious ways like typing a
3827 keyword or using completion, you may also apply the following commands:
3830 @kindex C-S-@key{right}
3831 @kindex C-S-@key{left}
3832 @kindex C-u C-u C-c C-t
3833 @item C-u C-u C-c C-t
3834 @itemx C-S-@key{right}
3835 @itemx C-S-@key{left}
3836 These keys jump from one TODO subset to the next. In the above example,
3837 @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{right}} would jump from @code{TODO} or
3838 @code{DONE} to @code{REPORT}, and any of the words in the second row to
3839 @code{CANCELED}. Note that the @kbd{C-S-} key binding conflict with
3840 @code{shift-selection-mode} (@pxref{Conflicts}).
3841 @kindex S-@key{right}
3842 @kindex S-@key{left}
3845 @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through @emph{all}
3846 keywords from all sets, so for example @kbd{S-@key{<right>}} would switch
3847 from @code{DONE} to @code{REPORT} in the example above. See also
3848 @ref{Conflicts}, for a discussion of the interaction with
3849 @code{shift-selection-mode}.
3852 @node Fast access to TODO states, Per-file keywords, Multiple sets in one file, TODO extensions
3853 @subsection Fast access to TODO states
3855 If you would like to quickly change an entry to an arbitrary TODO state
3856 instead of cycling through the states, you can set up keys for
3857 single-letter access to the states. This is done by adding the section
3858 key after each keyword, in parentheses. For example:
3861 (setq org-todo-keywords
3862 '((sequence "TODO(t)" "|" "DONE(d)")
3863 (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
3864 (sequence "|" "CANCELED(c)")))
3867 @vindex org-fast-tag-selection-include-todo
3868 If you then press @kbd{C-c C-t} followed by the selection key, the entry
3869 will be switched to this state. @kbd{SPC} can be used to remove any TODO
3870 keyword from an entry.@footnote{Check also the variable
3871 @code{org-fast-tag-selection-include-todo}, it allows you to change the TODO
3872 state through the tags interface (@pxref{Setting tags}), in case you like to
3873 mingle the two concepts. Note that this means you need to come up with
3874 unique keys across both sets of keywords.}
3876 @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions
3877 @subsection Setting up keywords for individual files
3878 @cindex keyword options
3879 @cindex per-file keywords
3884 It can be very useful to use different aspects of the TODO mechanism in
3885 different files. For file-local settings, you need to add special lines
3886 to the file which set the keywords and interpretation for that file
3887 only. For example, to set one of the two examples discussed above, you
3888 need one of the following lines, starting in column zero anywhere in the
3892 #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
3894 @noindent (you may also write @code{#+SEQ_TODO} to be explicit about the
3895 interpretation, but it means the same as @code{#+TODO}), or
3897 #+TYP_TODO: Fred Sara Lucy Mike | DONE
3900 A setup for using several sets in parallel would be:
3904 #+TODO: REPORT BUG KNOWNCAUSE | FIXED
3908 @cindex completion, of option keywords
3910 @noindent To make sure you are using the correct keyword, type
3911 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
3913 @cindex DONE, final TODO keyword
3914 Remember that the keywords after the vertical bar (or the last keyword
3915 if no bar is there) must always mean that the item is DONE (although you
3916 may use a different word). After changing one of these lines, use
3917 @kbd{C-c C-c} with the cursor still in the line to make the changes
3918 known to Org mode@footnote{Org mode parses these lines only when
3919 Org mode is activated after visiting a file. @kbd{C-c C-c} with the
3920 cursor in a line starting with @samp{#+} is simply restarting Org mode
3921 for the current buffer.}.
3923 @node Faces for TODO keywords, TODO dependencies, Per-file keywords, TODO extensions
3924 @subsection Faces for TODO keywords
3925 @cindex faces, for TODO keywords
3927 @vindex org-todo @r{(face)}
3928 @vindex org-done @r{(face)}
3929 @vindex org-todo-keyword-faces
3930 Org mode highlights TODO keywords with special faces: @code{org-todo}
3931 for keywords indicating that an item still has to be acted upon, and
3932 @code{org-done} for keywords indicating that an item is finished. If
3933 you are using more than 2 different states, you might want to use
3934 special faces for some of them. This can be done using the variable
3935 @code{org-todo-keyword-faces}. For example:
3939 (setq org-todo-keyword-faces
3940 '(("TODO" . org-warning) ("STARTED" . "yellow")
3941 ("CANCELED" . (:foreground "blue" :weight bold))))
3945 While using a list with face properties as shown for CANCELED @emph{should}
3946 work, this does not always seem to be the case. If necessary, define a
3947 special face and use that. A string is interpreted as a color. The variable
3948 @code{org-faces-easy-properties} determines if that color is interpreted as a
3949 foreground or a background color.
3951 @node TODO dependencies, , Faces for TODO keywords, TODO extensions
3952 @subsection TODO dependencies
3953 @cindex TODO dependencies
3954 @cindex dependencies, of TODO states
3956 @vindex org-enforce-todo-dependencies
3957 @cindex property, ORDERED
3958 The structure of Org files (hierarchy and lists) makes it easy to define TODO
3959 dependencies. Usually, a parent TODO task should not be marked DONE until
3960 all subtasks (defined as children tasks) are marked as DONE. And sometimes
3961 there is a logical sequence to a number of (sub)tasks, so that one task
3962 cannot be acted upon before all siblings above it are done. If you customize
3963 the variable @code{org-enforce-todo-dependencies}, Org will block entries
3964 from changing state to DONE while they have children that are not DONE.
3965 Furthermore, if an entry has a property @code{ORDERED}, each of its children
3966 will be blocked until all earlier siblings are marked DONE. Here is an
3970 * TODO Blocked until (two) is done
3979 ** TODO b, needs to wait for (a)
3980 ** TODO c, needs to wait for (a) and (b)
3984 @orgcmd{C-c C-x o,org-toggle-ordered-property}
3985 @vindex org-track-ordered-property-with-tag
3986 @cindex property, ORDERED
3987 Toggle the @code{ORDERED} property of the current entry. A property is used
3988 for this behavior because this should be local to the current entry, not
3989 inherited like a tag. However, if you would like to @i{track} the value of
3990 this property with a tag for better visibility, customize the variable
3991 @code{org-track-ordered-property-with-tag}.
3992 @orgkey{C-u C-u C-u C-c C-t}
3993 Change TODO state, circumventing any state blocking.
3996 @vindex org-agenda-dim-blocked-tasks
3997 If you set the variable @code{org-agenda-dim-blocked-tasks}, TODO entries
3998 that cannot be closed because of such dependencies will be shown in a dimmed
3999 font or even made invisible in agenda views (@pxref{Agenda Views}).
4001 @cindex checkboxes and TODO dependencies
4002 @vindex org-enforce-todo-dependencies
4003 You can also block changes of TODO states by looking at checkboxes
4004 (@pxref{Checkboxes}). If you set the variable
4005 @code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked
4006 checkboxes will be blocked from switching to DONE.
4008 If you need more complex dependency structures, for example dependencies
4009 between entries in different trees or files, check out the contributed
4010 module @file{org-depend.el}.
4013 @node Progress logging, Priorities, TODO extensions, TODO Items
4014 @section Progress logging
4015 @cindex progress logging
4016 @cindex logging, of progress
4018 Org mode can automatically record a timestamp and possibly a note when
4019 you mark a TODO item as DONE, or even each time you change the state of
4020 a TODO item. This system is highly configurable, settings can be on a
4021 per-keyword basis and can be localized to a file or even a subtree. For
4022 information on how to clock working time for a task, see @ref{Clocking
4026 * Closing items:: When was this entry marked DONE?
4027 * Tracking TODO state changes:: When did the status change?
4028 * Tracking your habits:: How consistent have you been?
4031 @node Closing items, Tracking TODO state changes, Progress logging, Progress logging
4032 @subsection Closing items
4034 The most basic logging is to keep track of @emph{when} a certain TODO
4035 item was finished. This is achieved with@footnote{The corresponding
4036 in-buffer setting is: @code{#+STARTUP: logdone}}
4039 (setq org-log-done 'time)
4043 Then each time you turn an entry from a TODO (not-done) state into any
4044 of the DONE states, a line @samp{CLOSED: [timestamp]} will be inserted
4045 just after the headline. If you turn the entry back into a TODO item
4046 through further state cycling, that line will be removed again. If you
4047 want to record a note along with the timestamp, use@footnote{The
4048 corresponding in-buffer setting is: @code{#+STARTUP: lognotedone}}
4051 (setq org-log-done 'note)
4055 You will then be prompted for a note, and that note will be stored below
4056 the entry with a @samp{Closing Note} heading.
4058 In the timeline (@pxref{Timeline}) and in the agenda
4059 (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
4060 display the TODO items with a @samp{CLOSED} timestamp on each day,
4061 giving you an overview of what has been done.
4063 @node Tracking TODO state changes, Tracking your habits, Closing items, Progress logging
4064 @subsection Tracking TODO state changes
4065 @cindex drawer, for state change recording
4067 @vindex org-log-states-order-reversed
4068 @vindex org-log-into-drawer
4069 @cindex property, LOG_INTO_DRAWER
4070 When TODO keywords are used as workflow states (@pxref{Workflow states}), you
4071 might want to keep track of when a state change occurred and maybe take a
4072 note about this change. You can either record just a timestamp, or a
4073 time-stamped note for a change. These records will be inserted after the
4074 headline as an itemized list, newest first@footnote{See the variable
4075 @code{org-log-states-order-reversed}}. When taking a lot of notes, you might
4076 want to get the notes out of the way into a drawer (@pxref{Drawers}).
4077 Customize the variable @code{org-log-into-drawer} to get this
4078 behavior---the recommended drawer for this is called @code{LOGBOOK}. You can
4079 also overrule the setting of this variable for a subtree by setting a
4080 @code{LOG_INTO_DRAWER} property.
4082 Since it is normally too much to record a note for every state, Org mode
4083 expects configuration on a per-keyword basis for this. This is achieved by
4084 adding special markers @samp{!} (for a timestamp) or @samp{@@} (for a note
4085 with timestamp) in parentheses after each keyword. For example, with the
4089 (setq org-todo-keywords
4090 '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
4093 To record a timestamp without a note for TODO keywords configured with
4094 @samp{@@}, just type @kbd{C-c C-c} to enter a blank note when prompted.
4097 @vindex org-log-done
4098 you not only define global TODO keywords and fast access keys, but also
4099 request that a time is recorded when the entry is set to
4100 DONE@footnote{It is possible that Org mode will record two timestamps
4101 when you are using both @code{org-log-done} and state change logging.
4102 However, it will never prompt for two notes---if you have configured
4103 both, the state change recording note will take precedence and cancel
4104 the @samp{Closing Note}.}, and that a note is recorded when switching to
4105 WAIT or CANCELED. The setting for WAIT is even more special: the
4106 @samp{!} after the slash means that in addition to the note taken when
4107 entering the state, a timestamp should be recorded when @i{leaving} the
4108 WAIT state, if and only if the @i{target} state does not configure
4109 logging for entering it. So it has no effect when switching from WAIT
4110 to DONE, because DONE is configured to record a timestamp only. But
4111 when switching from WAIT back to TODO, the @samp{/!} in the WAIT
4112 setting now triggers a timestamp even though TODO has no logging
4115 You can use the exact same syntax for setting logging preferences local
4118 #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
4121 @cindex property, LOGGING
4122 In order to define logging settings that are local to a subtree or a
4123 single item, define a LOGGING property in this entry. Any non-empty
4124 LOGGING property resets all logging settings to nil. You may then turn
4125 on logging for this specific tree using STARTUP keywords like
4126 @code{lognotedone} or @code{logrepeat}, as well as adding state specific
4127 settings like @code{TODO(!)}. For example
4130 * TODO Log each state with only a time
4132 :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
4134 * TODO Only log when switching to WAIT, and when repeating
4136 :LOGGING: WAIT(@@) logrepeat
4138 * TODO No logging at all
4144 @node Tracking your habits, , Tracking TODO state changes, Progress logging
4145 @subsection Tracking your habits
4148 Org has the ability to track the consistency of a special category of TODOs,
4149 called ``habits''. A habit has the following properties:
4153 You have enabled the @code{habits} module by customizing the variable
4156 The habit is a TODO item, with a TODO keyword representing an open state.
4158 The property @code{STYLE} is set to the value @code{habit}.
4160 The TODO has a scheduled date, usually with a @code{.+} style repeat
4161 interval. A @code{++} style may be appropriate for habits with time
4162 constraints, e.g., must be done on weekends, or a @code{+} style for an
4163 unusual habit that can have a backlog, e.g., weekly reports.
4165 The TODO may also have minimum and maximum ranges specified by using the
4166 syntax @samp{.+2d/3d}, which says that you want to do the task at least every
4167 three days, but at most every two days.
4169 You must also have state logging for the @code{DONE} state enabled, in order
4170 for historical data to be represented in the consistency graph. If it is not
4171 enabled it is not an error, but the consistency graphs will be largely
4175 To give you an idea of what the above rules look like in action, here's an
4176 actual habit with some history:
4180 SCHEDULED: <2009-10-17 Sat .+2d/4d>
4181 - State "DONE" from "TODO" [2009-10-15 Thu]
4182 - State "DONE" from "TODO" [2009-10-12 Mon]
4183 - State "DONE" from "TODO" [2009-10-10 Sat]
4184 - State "DONE" from "TODO" [2009-10-04 Sun]
4185 - State "DONE" from "TODO" [2009-10-02 Fri]
4186 - State "DONE" from "TODO" [2009-09-29 Tue]
4187 - State "DONE" from "TODO" [2009-09-25 Fri]
4188 - State "DONE" from "TODO" [2009-09-19 Sat]
4189 - State "DONE" from "TODO" [2009-09-16 Wed]
4190 - State "DONE" from "TODO" [2009-09-12 Sat]
4193 :LAST_REPEAT: [2009-10-19 Mon 00:36]
4197 What this habit says is: I want to shave at most every 2 days (given by the
4198 @code{SCHEDULED} date and repeat interval) and at least every 4 days. If
4199 today is the 15th, then the habit first appears in the agenda on Oct 17,
4200 after the minimum of 2 days has elapsed, and will appear overdue on Oct 19,
4201 after four days have elapsed.
4203 What's really useful about habits is that they are displayed along with a
4204 consistency graph, to show how consistent you've been at getting that task
4205 done in the past. This graph shows every day that the task was done over the
4206 past three weeks, with colors for each day. The colors used are:
4210 If the task wasn't to be done yet on that day.
4212 If the task could have been done on that day.
4214 If the task was going to be overdue the next day.
4216 If the task was overdue on that day.
4219 In addition to coloring each day, the day is also marked with an asterisk if
4220 the task was actually done that day, and an exclamation mark to show where
4221 the current day falls in the graph.
4223 There are several configuration variables that can be used to change the way
4224 habits are displayed in the agenda.
4227 @item org-habit-graph-column
4228 The buffer column at which the consistency graph should be drawn. This will
4229 overwrite any text in that column, so it is a good idea to keep your habits'
4230 titles brief and to the point.
4231 @item org-habit-preceding-days
4232 The amount of history, in days before today, to appear in consistency graphs.
4233 @item org-habit-following-days
4234 The number of days after today that will appear in consistency graphs.
4235 @item org-habit-show-habits-only-for-today
4236 If non-nil, only show habits in today's agenda view. This is set to true by
4240 Lastly, pressing @kbd{K} in the agenda buffer will cause habits to
4241 temporarily be disabled and they won't appear at all. Press @kbd{K} again to
4242 bring them back. They are also subject to tag filtering, if you have habits
4243 which should only be done in certain contexts, for example.
4245 @node Priorities, Breaking down tasks, Progress logging, TODO Items
4249 If you use Org mode extensively, you may end up with enough TODO items that
4250 it starts to make sense to prioritize them. Prioritizing can be done by
4251 placing a @emph{priority cookie} into the headline of a TODO item, like this
4254 *** TODO [#A] Write letter to Sam Fortune
4258 @vindex org-priority-faces
4259 By default, Org mode supports three priorities: @samp{A}, @samp{B}, and
4260 @samp{C}. @samp{A} is the highest priority. An entry without a cookie is
4261 treated just like priority @samp{B}. Priorities make a difference only for
4262 sorting in the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they
4263 have no inherent meaning to Org mode. The cookies can be highlighted with
4264 special faces by customizing the variable @code{org-priority-faces}.
4266 Priorities can be attached to any outline node; they do not need to be TODO
4272 @findex org-priority
4273 Set the priority of the current headline (@command{org-priority}). The
4274 command prompts for a priority character @samp{A}, @samp{B} or @samp{C}.
4275 When you press @key{SPC} instead, the priority cookie is removed from the
4276 headline. The priorities can also be changed ``remotely'' from the timeline
4277 and agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
4279 @orgcmdkkcc{S-@key{up},S-@key{down},org-priority-up,org-priority-down}
4280 @vindex org-priority-start-cycle-with-default
4281 Increase/decrease priority of current headline@footnote{See also the option
4282 @code{org-priority-start-cycle-with-default}.}. Note that these keys are
4283 also used to modify timestamps (@pxref{Creating timestamps}). See also
4284 @ref{Conflicts}, for a discussion of the interaction with
4285 @code{shift-selection-mode}.
4288 @vindex org-highest-priority
4289 @vindex org-lowest-priority
4290 @vindex org-default-priority
4291 You can change the range of allowed priorities by setting the variables
4292 @code{org-highest-priority}, @code{org-lowest-priority}, and
4293 @code{org-default-priority}. For an individual buffer, you may set
4294 these values (highest, lowest, default) like this (please make sure that
4295 the highest priority is earlier in the alphabet than the lowest
4298 @cindex #+PRIORITIES
4303 @node Breaking down tasks, Checkboxes, Priorities, TODO Items
4304 @section Breaking tasks down into subtasks
4305 @cindex tasks, breaking down
4306 @cindex statistics, for TODO items
4308 @vindex org-agenda-todo-list-sublevels
4309 It is often advisable to break down large tasks into smaller, manageable
4310 subtasks. You can do this by creating an outline tree below a TODO item,
4311 with detailed subtasks on the tree@footnote{To keep subtasks out of the
4312 global TODO list, see the @code{org-agenda-todo-list-sublevels}.}. To keep
4313 the overview over the fraction of subtasks that are already completed, insert
4314 either @samp{[/]} or @samp{[%]} anywhere in the headline. These cookies will
4315 be updated each time the TODO status of a child changes, or when pressing
4316 @kbd{C-c C-c} on the cookie. For example:
4319 * Organize Party [33%]
4320 ** TODO Call people [1/2]
4324 ** DONE Talk to neighbor
4327 @cindex property, COOKIE_DATA
4328 If a heading has both checkboxes and TODO children below it, the meaning of
4329 the statistics cookie become ambiguous. Set the property
4330 @code{COOKIE_DATA} to either @samp{checkbox} or @samp{todo} to resolve
4333 @vindex org-hierarchical-todo-statistics
4334 If you would like to have the statistics cookie count any TODO entries in the
4335 subtree (not just direct children), configure the variable
4336 @code{org-hierarchical-todo-statistics}. To do this for a single subtree,
4337 include the word @samp{recursive} into the value of the @code{COOKIE_DATA}
4341 * Parent capturing statistics [2/20]
4343 :COOKIE_DATA: todo recursive
4347 If you would like a TODO entry to automatically change to DONE
4348 when all children are done, you can use the following setup:
4351 (defun org-summary-todo (n-done n-not-done)
4352 "Switch entry to DONE when all subentries are done, to TODO otherwise."
4353 (let (org-log-done org-log-states) ; turn off logging
4354 (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
4356 (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
4360 Another possibility is the use of checkboxes to identify (a hierarchy of) a
4361 large number of subtasks (@pxref{Checkboxes}).
4364 @node Checkboxes, , Breaking down tasks, TODO Items
4368 @vindex org-list-automatic-rules
4369 Every item in a plain list@footnote{With the exception of description
4370 lists. But you can allow it by modifying @code{org-list-automatic-rules}
4371 accordingly.} (@pxref{Plain lists}) can be made into a checkbox by starting
4372 it with the string @samp{[ ]}. This feature is similar to TODO items
4373 (@pxref{TODO Items}), but is more lightweight. Checkboxes are not included
4374 into the global TODO list, so they are often great to split a task into a
4375 number of simple steps. Or you can use them in a shopping list. To toggle a
4376 checkbox, use @kbd{C-c C-c}, or use the mouse (thanks to Piotr Zielinski's
4377 @file{org-mouse.el}).
4379 Here is an example of a checkbox list.
4382 * TODO Organize party [2/4]
4383 - [-] call people [1/3]
4388 - [ ] think about what music to play
4389 - [X] talk to the neighbors
4392 Checkboxes work hierarchically, so if a checkbox item has children that
4393 are checkboxes, toggling one of the children checkboxes will make the
4394 parent checkbox reflect if none, some, or all of the children are
4397 @cindex statistics, for checkboxes
4398 @cindex checkbox statistics
4399 @cindex property, COOKIE_DATA
4400 @vindex org-hierarchical-checkbox-statistics
4401 The @samp{[2/4]} and @samp{[1/3]} in the first and second line are cookies
4402 indicating how many checkboxes present in this entry have been checked off,
4403 and the total number of checkboxes present. This can give you an idea on how
4404 many checkboxes remain, even without opening a folded entry. The cookies can
4405 be placed into a headline or into (the first line of) a plain list item.
4406 Each cookie covers checkboxes of direct children structurally below the
4407 headline/item on which the cookie appears@footnote{Set the variable
4408 @code{org-hierarchical-checkbox-statistics} if you want such cookies to
4409 count all checkboxes below the cookie, not just those belonging to direct
4410 children.}. You have to insert the cookie yourself by typing either
4411 @samp{[/]} or @samp{[%]}. With @samp{[/]} you get an @samp{n out of m}
4412 result, as in the examples above. With @samp{[%]} you get information about
4413 the percentage of checkboxes checked (in the above example, this would be
4414 @samp{[50%]} and @samp{[33%]}, respectively). In a headline, a cookie can
4415 count either checkboxes below the heading or TODO states of children, and it
4416 will display whatever was changed last. Set the property @code{COOKIE_DATA}
4417 to either @samp{checkbox} or @samp{todo} to resolve this issue.
4419 @cindex blocking, of checkboxes
4420 @cindex checkbox blocking
4421 @cindex property, ORDERED
4422 If the current outline node has an @code{ORDERED} property, checkboxes must
4423 be checked off in sequence, and an error will be thrown if you try to check
4424 off a box while there are unchecked boxes above it.
4426 @noindent The following commands work with checkboxes:
4429 @orgcmd{C-c C-c,org-toggle-checkbox}
4430 Toggle checkbox status or (with prefix arg) checkbox presence at point.
4431 With a single prefix argument, add an empty checkbox or remove the current
4432 one@footnote{`C-u C-c C-c' on the @emph{first} item of a list with no checkbox
4433 will add checkboxes to the rest of the list.}. With a double prefix argument, set it to @samp{[-]}, which is
4434 considered to be an intermediate state.
4435 @orgcmd{C-c C-x C-b,org-toggle-checkbox}
4436 Toggle checkbox status or (with prefix arg) checkbox presence at point. With
4437 double prefix argument, set it to @samp{[-]}, which is considered to be an
4441 If there is an active region, toggle the first checkbox in the region
4442 and set all remaining boxes to the same status as the first. With a prefix
4443 arg, add or remove the checkbox for all items in the region.
4445 If the cursor is in a headline, toggle checkboxes in the region between
4446 this headline and the next (so @emph{not} the entire subtree).
4448 If there is no active region, just toggle the checkbox at point.
4450 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
4451 Insert a new item with a checkbox. This works only if the cursor is already
4452 in a plain list item (@pxref{Plain lists}).
4453 @orgcmd{C-c C-x o,org-toggle-ordered-property}
4454 @vindex org-track-ordered-property-with-tag
4455 @cindex property, ORDERED
4456 Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
4457 be checked off in sequence. A property is used for this behavior because
4458 this should be local to the current entry, not inherited like a tag.
4459 However, if you would like to @i{track} the value of this property with a tag
4460 for better visibility, customize the variable
4461 @code{org-track-ordered-property-with-tag}.
4462 @orgcmd{C-c #,org-update-statistics-cookies}
4463 Update the statistics cookie in the current outline entry. When called with
4464 a @kbd{C-u} prefix, update the entire file. Checkbox statistic cookies are
4465 updated automatically if you toggle checkboxes with @kbd{C-c C-c} and make
4466 new ones with @kbd{M-S-@key{RET}}. TODO statistics cookies update when
4467 changing TODO states. If you delete boxes/entries or add/change them by
4468 hand, use this command to get things back into sync.
4471 @node Tags, Properties and Columns, TODO Items, Top
4474 @cindex headline tagging
4475 @cindex matching, tags
4476 @cindex sparse tree, tag based
4478 An excellent way to implement labels and contexts for cross-correlating
4479 information is to assign @i{tags} to headlines. Org mode has extensive
4482 @vindex org-tag-faces
4483 Every headline can contain a list of tags; they occur at the end of the
4484 headline. Tags are normal words containing letters, numbers, @samp{_}, and
4485 @samp{@@}. Tags must be preceded and followed by a single colon, e.g.,
4486 @samp{:work:}. Several tags can be specified, as in @samp{:work:urgent:}.
4487 Tags will by default be in bold face with the same color as the headline.
4488 You may specify special faces for specific tags using the variable
4489 @code{org-tag-faces}, in much the same way as you can for TODO keywords
4490 (@pxref{Faces for TODO keywords}).
4493 * Tag inheritance:: Tags use the tree structure of the outline
4494 * Setting tags:: How to assign tags to a headline
4495 * Tag searches:: Searching for combinations of tags
4498 @node Tag inheritance, Setting tags, Tags, Tags
4499 @section Tag inheritance
4500 @cindex tag inheritance
4501 @cindex inheritance, of tags
4502 @cindex sublevels, inclusion into tags match
4504 @i{Tags} make use of the hierarchical structure of outline trees. If a
4505 heading has a certain tag, all subheadings will inherit the tag as
4506 well. For example, in the list
4509 * Meeting with the French group :work:
4510 ** Summary by Frank :boss:notes:
4511 *** TODO Prepare slides for him :action:
4515 the final heading will have the tags @samp{:work:}, @samp{:boss:},
4516 @samp{:notes:}, and @samp{:action:} even though the final heading is not
4517 explicitly marked with those tags. You can also set tags that all entries in
4518 a file should inherit just as if these tags were defined in a hypothetical
4519 level zero that surrounds the entire file. Use a line like this@footnote{As
4520 with all these in-buffer settings, pressing @kbd{C-c C-c} activates any
4521 changes in the line.}:
4525 #+FILETAGS: :Peter:Boss:Secret:
4529 @vindex org-use-tag-inheritance
4530 @vindex org-tags-exclude-from-inheritance
4531 To limit tag inheritance to specific tags, or to turn it off entirely, use
4532 the variables @code{org-use-tag-inheritance} and
4533 @code{org-tags-exclude-from-inheritance}.
4535 @vindex org-tags-match-list-sublevels
4536 When a headline matches during a tags search while tag inheritance is turned
4537 on, all the sublevels in the same tree will (for a simple match form) match
4538 as well@footnote{This is only true if the search does not involve more
4539 complex tests including properties (@pxref{Property searches}).}. The list
4540 of matches may then become very long. If you only want to see the first tags
4541 match in a subtree, configure the variable
4542 @code{org-tags-match-list-sublevels} (not recommended).
4544 @node Setting tags, Tag searches, Tag inheritance, Tags
4545 @section Setting tags
4546 @cindex setting tags
4547 @cindex tags, setting
4550 Tags can simply be typed into the buffer at the end of a headline.
4551 After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is
4552 also a special command for inserting tags:
4555 @orgcmd{C-c C-q,org-set-tags-command}
4556 @cindex completion, of tags
4557 @vindex org-tags-column
4558 Enter new tags for the current headline. Org mode will either offer
4559 completion or a special single-key interface for setting tags, see
4560 below. After pressing @key{RET}, the tags will be inserted and aligned
4561 to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all
4562 tags in the current buffer will be aligned to that column, just to make
4563 things look nice. TAGS are automatically realigned after promotion,
4564 demotion, and TODO state changes (@pxref{TODO basics}).
4565 @orgcmd{C-c C-c,org-set-tags-command}
4566 When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
4569 @vindex org-tag-alist
4570 Org supports tag insertion based on a @emph{list of tags}. By
4571 default this list is constructed dynamically, containing all tags
4572 currently used in the buffer. You may also globally specify a hard list
4573 of tags with the variable @code{org-tag-alist}. Finally you can set
4574 the default tags for a given file with lines like
4578 #+TAGS: @@work @@home @@tennisclub
4579 #+TAGS: laptop car pc sailboat
4582 If you have globally defined your preferred set of tags using the
4583 variable @code{org-tag-alist}, but would like to use a dynamic tag list
4584 in a specific file, add an empty TAGS option line to that file:
4590 @vindex org-tag-persistent-alist
4591 If you have a preferred set of tags that you would like to use in every file,
4592 in addition to those defined on a per-file basis by TAGS option lines, then
4593 you may specify a list of tags with the variable
4594 @code{org-tag-persistent-alist}. You may turn this off on a per-file basis
4595 by adding a STARTUP option line to that file:
4601 By default Org mode uses the standard minibuffer completion facilities for
4602 entering tags. However, it also implements another, quicker, tag selection
4603 method called @emph{fast tag selection}. This allows you to select and
4604 deselect tags with just a single key press. For this to work well you should
4605 assign unique letters to most of your commonly used tags. You can do this
4606 globally by configuring the variable @code{org-tag-alist} in your
4607 @file{.emacs} file. For example, you may find the need to tag many items in
4608 different files with @samp{:@@home:}. In this case you can set something
4612 (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
4615 @noindent If the tag is only relevant to the file you are working on, then you
4616 can instead set the TAGS option line as:
4619 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p)
4622 @noindent The tags interface will show the available tags in a splash
4623 window. If you want to start a new line after a specific tag, insert
4624 @samp{\n} into the tag list
4627 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) \n laptop(l) pc(p)
4630 @noindent or write them in two lines:
4633 #+TAGS: @@work(w) @@home(h) @@tennisclub(t)
4634 #+TAGS: laptop(l) pc(p)
4638 You can also group together tags that are mutually exclusive by using
4642 #+TAGS: @{ @@work(w) @@home(h) @@tennisclub(t) @} laptop(l) pc(p)
4645 @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
4646 and @samp{@@tennisclub} should be selected. Multiple such groups are allowed.
4648 @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
4649 these lines to activate any changes.
4652 To set these mutually exclusive groups in the variable @code{org-tags-alist},
4653 you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
4654 of the braces. Similarly, you can use @code{:newline} to indicate a line
4655 break. The previous example would be set globally by the following
4659 (setq org-tag-alist '((:startgroup . nil)
4660 ("@@work" . ?w) ("@@home" . ?h)
4661 ("@@tennisclub" . ?t)
4663 ("laptop" . ?l) ("pc" . ?p)))
4666 If at least one tag has a selection key then pressing @kbd{C-c C-c} will
4667 automatically present you with a special interface, listing inherited tags,
4668 the tags of the current headline, and a list of all valid tags with
4669 corresponding keys@footnote{Keys will automatically be assigned to tags which
4670 have no configured keys.}. In this interface, you can use the following
4675 Pressing keys assigned to tags will add or remove them from the list of
4676 tags in the current line. Selecting a tag in a group of mutually
4677 exclusive tags will turn off any other tags from that group.
4680 Enter a tag in the minibuffer, even if the tag is not in the predefined
4681 list. You will be able to complete on all tags present in the buffer.
4682 You can also add several tags: just separate them with a comma.
4686 Clear all tags for this line.
4689 Accept the modified set.
4691 Abort without installing changes.
4693 If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
4695 Turn off groups of mutually exclusive tags. Use this to (as an
4696 exception) assign several tags from such a group.
4698 Toggle auto-exit after the next change (see below).
4699 If you are using expert mode, the first @kbd{C-c} will display the
4704 This method lets you assign tags to a headline with very few keys. With
4705 the above setup, you could clear the current tags and set @samp{@@home},
4706 @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
4707 C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@home} to
4708 @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
4709 alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag
4710 @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
4711 @key{RET} @key{RET}}.
4713 @vindex org-fast-tag-selection-single-key
4714 If you find that most of the time you need only a single key press to
4715 modify your list of tags, set the variable
4716 @code{org-fast-tag-selection-single-key}. Then you no longer have to
4717 press @key{RET} to exit fast tag selection---it will immediately exit
4718 after the first change. If you then occasionally need more keys, press
4719 @kbd{C-c} to turn off auto-exit for the current tag selection process
4720 (in effect: start selection with @kbd{C-c C-c C-c} instead of @kbd{C-c
4721 C-c}). If you set the variable to the value @code{expert}, the special
4722 window is not even shown for single-key tag selection, it comes up only
4723 when you press an extra @kbd{C-c}.
4725 @node Tag searches, , Setting tags, Tags
4726 @section Tag searches
4727 @cindex tag searches
4728 @cindex searching for tags
4730 Once a system of tags has been set up, it can be used to collect related
4731 information into special lists.
4734 @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
4735 Create a sparse tree with all headlines matching a tags search. With a
4736 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
4737 @orgcmd{C-c a m,org-tags-view}
4738 Create a global list of tag matches from all agenda files.
4739 @xref{Matching tags and properties}.
4740 @orgcmd{C-c a M,org-tags-view}
4741 @vindex org-tags-match-list-sublevels
4742 Create a global list of tag matches from all agenda files, but check
4743 only TODO items and force checking subitems (see variable
4744 @code{org-tags-match-list-sublevels}).
4747 These commands all prompt for a match string which allows basic Boolean logic
4748 like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and
4749 @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries
4750 which are tagged, like @samp{Kathy} or @samp{Sally}. The full syntax of the search
4751 string is rich and allows also matching against TODO keywords, entry levels
4752 and properties. For a complete description with many examples, see
4753 @ref{Matching tags and properties}.
4756 @node Properties and Columns, Dates and Times, Tags, Top
4757 @chapter Properties and columns
4760 A property is a key-value pair associated with an entry. Properties can be
4761 set so they are associated with a single entry, with every entry in a tree,
4762 or with every entry in an Org mode file.
4764 There are two main applications for properties in Org mode. First,
4765 properties are like tags, but with a value. Imagine maintaining a file where
4766 you document bugs and plan releases for a piece of software. Instead of
4767 using tags like @code{:release_1:}, @code{:release_2:}, you can use a
4768 property, say @code{:Release:}, that in different subtrees has different
4769 values, such as @code{1.0} or @code{2.0}. Second, you can use properties to
4770 implement (very basic) database capabilities in an Org buffer. Imagine
4771 keeping track of your music CDs, where properties could be things such as the
4772 album, artist, date of release, number of tracks, and so on.
4774 Properties can be conveniently edited and viewed in column view
4775 (@pxref{Column view}).
4778 * Property syntax:: How properties are spelled out
4779 * Special properties:: Access to other Org mode features
4780 * Property searches:: Matching property values
4781 * Property inheritance:: Passing values down the tree
4782 * Column view:: Tabular viewing and editing
4783 * Property API:: Properties for Lisp programmers
4786 @node Property syntax, Special properties, Properties and Columns, Properties and Columns
4787 @section Property syntax
4788 @cindex property syntax
4789 @cindex drawer, for properties
4791 Properties are key-value pairs. When they are associated with a single entry
4792 or with a tree they need to be inserted into a special
4793 drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property
4794 is specified on a single line, with the key (surrounded by colons)
4795 first, and the value after it. Here is an example:
4800 *** Goldberg Variations
4802 :Title: Goldberg Variations
4803 :Composer: J.S. Bach
4805 :Publisher: Deutsche Grammophon
4810 Depending on the value of @code{org-use-property-inheritance}, a property set
4811 this way will either be associated with a single entry, or the sub-tree
4812 defined by the entry, see @ref{Property inheritance}.
4814 You may define the allowed values for a particular property @samp{:Xyz:}
4815 by setting a property @samp{:Xyz_ALL:}. This special property is
4816 @emph{inherited}, so if you set it in a level 1 entry, it will apply to
4817 the entire tree. When allowed values are defined, setting the
4818 corresponding property becomes easier and is less prone to typing
4819 errors. For the example with the CD collection, we can predefine
4820 publishers and the number of disks in a box like this:
4825 :NDisks_ALL: 1 2 3 4
4826 :Publisher_ALL: "Deutsche Grammophon" Philips EMI
4830 If you want to set properties that can be inherited by any entry in a
4831 file, use a line like
4832 @cindex property, _ALL
4835 #+PROPERTY: NDisks_ALL 1 2 3 4
4838 If you want to add to the value of an existing property, append a @code{+} to
4839 the property name. The following results in the property @code{var} having
4840 the value ``foo=1 bar=2''.
4843 #+PROPERTY: var foo=1
4844 #+PROPERTY: var+ bar=2
4847 It is also possible to add to the values of inherited properties. The
4848 following results in the @code{genres} property having the value ``Classic
4849 Baroque'' under the @code{Goldberg Variations} subtree.
4857 *** Goldberg Variations
4859 :Title: Goldberg Variations
4860 :Composer: J.S. Bach
4862 :Publisher: Deutsche Grammophon
4867 Note that a property can only have one entry per Drawer.
4869 @vindex org-global-properties
4870 Property values set with the global variable
4871 @code{org-global-properties} can be inherited by all entries in all
4875 The following commands help to work with properties:
4878 @orgcmd{M-@key{TAB},pcomplete}
4879 After an initial colon in a line, complete property keys. All keys used
4880 in the current file will be offered as possible completions.
4881 @orgcmd{C-c C-x p,org-set-property}
4882 Set a property. This prompts for a property name and a value. If
4883 necessary, the property drawer is created as well.
4884 @item M-x org-insert-property-drawer
4885 @findex org-insert-property-drawer
4886 Insert a property drawer into the current entry. The drawer will be
4887 inserted early in the entry, but after the lines with planning
4888 information like deadlines.
4889 @orgcmd{C-c C-c,org-property-action}
4890 With the cursor in a property drawer, this executes property commands.
4891 @orgcmd{C-c C-c s,org-set-property}
4892 Set a property in the current entry. Both the property and the value
4893 can be inserted using completion.
4894 @orgcmdkkcc{S-@key{right},S-@key{left},org-property-next-allowed-value,org-property-previous-allowed-value}
4895 Switch property at point to the next/previous allowed value.
4896 @orgcmd{C-c C-c d,org-delete-property}
4897 Remove a property from the current entry.
4898 @orgcmd{C-c C-c D,org-delete-property-globally}
4899 Globally remove a property, from all entries in the current file.
4900 @orgcmd{C-c C-c c,org-compute-property-at-point}
4901 Compute the property at point, using the operator and scope from the
4902 nearest column format definition.
4905 @node Special properties, Property searches, Property syntax, Properties and Columns
4906 @section Special properties
4907 @cindex properties, special
4909 Special properties provide an alternative access method to Org mode features,
4910 like the TODO state or the priority of an entry, discussed in the previous
4911 chapters. This interface exists so that you can include these states in a
4912 column view (@pxref{Column view}), or to use them in queries. The following
4913 property names are special and (except for @code{:CATEGORY:}) should not be
4914 used as keys in the properties drawer:
4916 @cindex property, special, TODO
4917 @cindex property, special, TAGS
4918 @cindex property, special, ALLTAGS
4919 @cindex property, special, CATEGORY
4920 @cindex property, special, PRIORITY
4921 @cindex property, special, DEADLINE
4922 @cindex property, special, SCHEDULED
4923 @cindex property, special, CLOSED
4924 @cindex property, special, TIMESTAMP
4925 @cindex property, special, TIMESTAMP_IA
4926 @cindex property, special, CLOCKSUM
4927 @cindex property, special, BLOCKED
4928 @c guessing that ITEM is needed in this area; also, should this list be sorted?
4929 @cindex property, special, ITEM
4930 @cindex property, special, FILE
4932 TODO @r{The TODO keyword of the entry.}
4933 TAGS @r{The tags defined directly in the headline.}
4934 ALLTAGS @r{All tags, including inherited ones.}
4935 CATEGORY @r{The category of an entry.}
4936 PRIORITY @r{The priority of the entry, a string with a single letter.}
4937 DEADLINE @r{The deadline time string, without the angular brackets.}
4938 SCHEDULED @r{The scheduling timestamp, without the angular brackets.}
4939 CLOSED @r{When was this entry closed?}
4940 TIMESTAMP @r{The first keyword-less timestamp in the entry.}
4941 TIMESTAMP_IA @r{The first inactive timestamp in the entry.}
4942 CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}}
4943 @r{must be run first to compute the values in the current buffer.}
4944 BLOCKED @r{"t" if task is currently blocked by children or siblings}
4945 ITEM @r{The content of the entry.}
4946 FILE @r{The filename the entry is located in.}
4949 @node Property searches, Property inheritance, Special properties, Properties and Columns
4950 @section Property searches
4951 @cindex properties, searching
4952 @cindex searching, of properties
4954 To create sparse trees and special lists with selection based on properties,
4955 the same commands are used as for tag searches (@pxref{Tag searches}).
4957 @orgcmdkkc{C-c / m,C-c \,org-match-sparse-tree}
4958 Create a sparse tree with all matching entries. With a
4959 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
4960 @orgcmd{C-c a m,org-tags-view}
4961 Create a global list of tag/property matches from all agenda files.
4962 @xref{Matching tags and properties}.
4963 @orgcmd{C-c a M,org-tags-view}
4964 @vindex org-tags-match-list-sublevels
4965 Create a global list of tag matches from all agenda files, but check
4966 only TODO items and force checking of subitems (see variable
4967 @code{org-tags-match-list-sublevels}).
4970 The syntax for the search string is described in @ref{Matching tags and
4973 There is also a special command for creating sparse trees based on a
4978 Create a sparse tree based on the value of a property. This first
4979 prompts for the name of a property, and then for a value. A sparse tree
4980 is created with all entries that define this property with the given
4981 value. If you enclose the value in curly braces, it is interpreted as
4982 a regular expression and matched against the property values.
4985 @node Property inheritance, Column view, Property searches, Properties and Columns
4986 @section Property Inheritance
4987 @cindex properties, inheritance
4988 @cindex inheritance, of properties
4990 @vindex org-use-property-inheritance
4991 The outline structure of Org mode documents lends itself to an
4992 inheritance model of properties: if the parent in a tree has a certain
4993 property, the children can inherit this property. Org mode does not
4994 turn this on by default, because it can slow down property searches
4995 significantly and is often not needed. However, if you find inheritance
4996 useful, you can turn it on by setting the variable
4997 @code{org-use-property-inheritance}. It may be set to @code{t} to make
4998 all properties inherited from the parent, to a list of properties
4999 that should be inherited, or to a regular expression that matches
5000 inherited properties. If a property has the value @samp{nil}, this is
5001 interpreted as an explicit undefine of the property, so that inheritance
5002 search will stop at this value and return @code{nil}.
5004 Org mode has a few properties for which inheritance is hard-coded, at
5005 least for the special applications for which they are used:
5007 @cindex property, COLUMNS
5010 The @code{:COLUMNS:} property defines the format of column view
5011 (@pxref{Column view}). It is inherited in the sense that the level
5012 where a @code{:COLUMNS:} property is defined is used as the starting
5013 point for a column view table, independently of the location in the
5014 subtree from where columns view is turned on.
5016 @cindex property, CATEGORY
5017 For agenda view, a category set through a @code{:CATEGORY:} property
5018 applies to the entire subtree.
5020 @cindex property, ARCHIVE
5021 For archiving, the @code{:ARCHIVE:} property may define the archive
5022 location for the entire subtree (@pxref{Moving subtrees}).
5024 @cindex property, LOGGING
5025 The LOGGING property may define logging settings for an entry or a
5026 subtree (@pxref{Tracking TODO state changes}).
5029 @node Column view, Property API, Property inheritance, Properties and Columns
5030 @section Column view
5032 A great way to view and edit properties in an outline tree is
5033 @emph{column view}. In column view, each outline node is turned into a
5034 table row. Columns in this table provide access to properties of the
5035 entries. Org mode implements columns by overlaying a tabular structure
5036 over the headline of each item. While the headlines have been turned
5037 into a table row, you can still change the visibility of the outline
5038 tree. For example, you get a compact table by switching to CONTENTS
5039 view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
5040 is active), but you can still open, read, and edit the entry below each
5041 headline. Or, you can switch to column view after executing a sparse
5042 tree command and in this way get a table only for the selected items.
5043 Column view also works in agenda buffers (@pxref{Agenda Views}) where
5044 queries have collected selected items, possibly from a number of files.
5047 * Defining columns:: The COLUMNS format property
5048 * Using column view:: How to create and use column view
5049 * Capturing column view:: A dynamic block for column view
5052 @node Defining columns, Using column view, Column view, Column view
5053 @subsection Defining columns
5054 @cindex column view, for properties
5055 @cindex properties, column view
5057 Setting up a column view first requires defining the columns. This is
5058 done by defining a column format line.
5061 * Scope of column definitions:: Where defined, where valid?
5062 * Column attributes:: Appearance and content of a column
5065 @node Scope of column definitions, Column attributes, Defining columns, Defining columns
5066 @subsubsection Scope of column definitions
5068 To define a column format for an entire file, use a line like
5072 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5075 To specify a format that only applies to a specific tree, add a
5076 @code{:COLUMNS:} property to the top node of that tree, for example:
5079 ** Top node for columns view
5081 :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5085 If a @code{:COLUMNS:} property is present in an entry, it defines columns
5086 for the entry itself, and for the entire subtree below it. Since the
5087 column definition is part of the hierarchical structure of the document,
5088 you can define columns on level 1 that are general enough for all
5089 sublevels, and more specific columns further down, when you edit a
5090 deeper part of the tree.
5092 @node Column attributes, , Scope of column definitions, Defining columns
5093 @subsubsection Column attributes
5094 A column definition sets the attributes of a column. The general
5095 definition looks like this:
5098 %[@var{width}]@var{property}[(@var{title})][@{@var{summary-type}@}]
5102 Except for the percent sign and the property name, all items are
5103 optional. The individual parts have the following meaning:
5106 @var{width} @r{An integer specifying the width of the column in characters.}
5107 @r{If omitted, the width will be determined automatically.}
5108 @var{property} @r{The property that should be edited in this column.}
5109 @r{Special properties representing meta data are allowed here}
5110 @r{as well (@pxref{Special properties})}
5111 @var{title} @r{The header text for the column. If omitted, the property}
5113 @{@var{summary-type}@} @r{The summary type. If specified, the column values for}
5114 @r{parent nodes are computed from the children.}
5115 @r{Supported summary types are:}
5116 @{+@} @r{Sum numbers in this column.}
5117 @{+;%.1f@} @r{Like @samp{+}, but format result with @samp{%.1f}.}
5118 @{$@} @r{Currency, short for @samp{+;%.2f}.}
5119 @{:@} @r{Sum times, HH:MM, plain numbers are hours.}
5120 @{X@} @r{Checkbox status, @samp{[X]} if all children are @samp{[X]}.}
5121 @{X/@} @r{Checkbox status, @samp{[n/m]}.}
5122 @{X%@} @r{Checkbox status, @samp{[n%]}.}
5123 @{min@} @r{Smallest number in column.}
5124 @{max@} @r{Largest number.}
5125 @{mean@} @r{Arithmetic mean of numbers.}
5126 @{:min@} @r{Smallest time value in column.}
5127 @{:max@} @r{Largest time value.}
5128 @{:mean@} @r{Arithmetic mean of time values.}
5129 @{@@min@} @r{Minimum age (in days/hours/mins/seconds).}
5130 @{@@max@} @r{Maximum age (in days/hours/mins/seconds).}
5131 @{@@mean@} @r{Arithmetic mean of ages (in days/hours/mins/seconds).}
5132 @{est+@} @r{Add low-high estimates.}
5136 Be aware that you can only have one summary type for any property you
5137 include. Subsequent columns referencing the same property will all display the
5138 same summary information.
5140 The @code{est+} summary type requires further explanation. It is used for
5141 combining estimates, expressed as low-high ranges. For example, instead
5142 of estimating a particular task will take 5 days, you might estimate it as
5143 5-6 days if you're fairly confident you know how much work is required, or
5144 1-10 days if you don't really know what needs to be done. Both ranges
5145 average at 5.5 days, but the first represents a more predictable delivery.
5147 When combining a set of such estimates, simply adding the lows and highs
5148 produces an unrealistically wide result. Instead, @code{est+} adds the
5149 statistical mean and variance of the sub-tasks, generating a final estimate
5150 from the sum. For example, suppose you had ten tasks, each of which was
5151 estimated at 0.5 to 2 days of work. Straight addition produces an estimate
5152 of 5 to 20 days, representing what to expect if everything goes either
5153 extremely well or extremely poorly. In contrast, @code{est+} estimates the
5154 full job more realistically, at 10-15 days.
5156 Here is an example for a complete columns definition, along with allowed
5160 :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.}
5161 %10Time_Estimate@{:@} %CLOCKSUM
5162 :Owner_ALL: Tammy Mark Karl Lisa Don
5163 :Status_ALL: "In progress" "Not started yet" "Finished" ""
5164 :Approved_ALL: "[ ]" "[X]"
5168 The first column, @samp{%25ITEM}, means the first 25 characters of the
5169 item itself, i.e.@: of the headline. You probably always should start the
5170 column definition with the @samp{ITEM} specifier. The other specifiers
5171 create columns @samp{Owner} with a list of names as allowed values, for
5172 @samp{Status} with four different possible values, and for a checkbox
5173 field @samp{Approved}. When no width is given after the @samp{%}
5174 character, the column will be exactly as wide as it needs to be in order
5175 to fully display all values. The @samp{Approved} column does have a
5176 modified title (@samp{Approved?}, with a question mark). Summaries will
5177 be created for the @samp{Time_Estimate} column by adding time duration
5178 expressions like HH:MM, and for the @samp{Approved} column, by providing
5179 an @samp{[X]} status if all children have been checked. The
5180 @samp{CLOCKSUM} column is special, it lists the sum of CLOCK intervals
5183 @node Using column view, Capturing column view, Defining columns, Column view
5184 @subsection Using column view
5187 @tsubheading{Turning column view on and off}
5188 @orgcmd{C-c C-x C-c,org-columns}
5189 @vindex org-columns-default-format
5190 Turn on column view. If the cursor is before the first headline in the file,
5191 column view is turned on for the entire file, using the @code{#+COLUMNS}
5192 definition. If the cursor is somewhere inside the outline, this command
5193 searches the hierarchy, up from point, for a @code{:COLUMNS:} property that
5194 defines a format. When one is found, the column view table is established
5195 for the tree starting at the entry that contains the @code{:COLUMNS:}
5196 property. If no such property is found, the format is taken from the
5197 @code{#+COLUMNS} line or from the variable @code{org-columns-default-format},
5198 and column view is established for the current entry and its subtree.
5199 @orgcmd{r,org-columns-redo}
5200 Recreate the column view, to include recent changes made in the buffer.
5201 @orgcmd{g,org-columns-redo}
5203 @orgcmd{q,org-columns-quit}
5205 @tsubheading{Editing values}
5206 @item @key{left} @key{right} @key{up} @key{down}
5207 Move through the column view from field to field.
5208 @kindex S-@key{left}
5209 @kindex S-@key{right}
5210 @item S-@key{left}/@key{right}
5211 Switch to the next/previous allowed value of the field. For this, you
5212 have to have specified allowed values for a property.
5214 Directly select the Nth allowed value, @kbd{0} selects the 10th value.
5215 @orgcmdkkcc{n,p,org-columns-next-allowed-value,org-columns-previous-allowed-value}
5216 Same as @kbd{S-@key{left}/@key{right}}
5217 @orgcmd{e,org-columns-edit-value}
5218 Edit the property at point. For the special properties, this will
5219 invoke the same interface that you normally use to change that
5220 property. For example, when editing a TAGS property, the tag completion
5221 or fast selection interface will pop up.
5222 @orgcmd{C-c C-c,org-columns-set-tags-or-toggle}
5223 When there is a checkbox at point, toggle it.
5224 @orgcmd{v,org-columns-show-value}
5225 View the full value of this property. This is useful if the width of
5226 the column is smaller than that of the value.
5227 @orgcmd{a,org-columns-edit-allowed}
5228 Edit the list of allowed values for this property. If the list is found
5229 in the hierarchy, the modified values is stored there. If no list is
5230 found, the new value is stored in the first entry that is part of the
5231 current column view.
5232 @tsubheading{Modifying the table structure}
5233 @orgcmdkkcc{<,>,org-columns-narrow,org-columns-widen}
5234 Make the column narrower/wider by one character.
5235 @orgcmd{S-M-@key{right},org-columns-new}
5236 Insert a new column, to the left of the current column.
5237 @orgcmd{S-M-@key{left},org-columns-delete}
5238 Delete the current column.
5241 @node Capturing column view, , Using column view, Column view
5242 @subsection Capturing column view
5244 Since column view is just an overlay over a buffer, it cannot be
5245 exported or printed directly. If you want to capture a column view, use
5246 a @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame
5247 of this block looks like this:
5249 @cindex #+BEGIN, columnview
5252 #+BEGIN: columnview :hlines 1 :id "label"
5257 @noindent This dynamic block has the following parameters:
5261 This is the most important parameter. Column view is a feature that is
5262 often localized to a certain (sub)tree, and the capture block might be
5263 at a different location in the file. To identify the tree whose view to
5264 capture, you can use 4 values:
5265 @cindex property, ID
5267 local @r{use the tree in which the capture block is located}
5268 global @r{make a global view, including all headings in the file}
5269 "file:@var{path-to-file}"
5270 @r{run column view at the top of this file}
5271 "@var{ID}" @r{call column view in the tree that has an @code{:ID:}}
5272 @r{property with the value @i{label}. You can use}
5273 @r{@kbd{M-x org-id-copy} to create a globally unique ID for}
5274 @r{the current entry and copy it to the kill-ring.}
5277 When @code{t}, insert an hline after every line. When a number @var{N}, insert
5278 an hline before each headline with level @code{<= @var{N}}.
5280 When set to @code{t}, force column groups to get vertical lines.
5282 When set to a number, don't capture entries below this level.
5283 @item :skip-empty-rows
5284 When set to @code{t}, skip rows where the only non-empty specifier of the
5285 column view is @code{ITEM}.
5290 The following commands insert or update the dynamic block:
5293 @orgcmd{C-c C-x i,org-insert-columns-dblock}
5294 Insert a dynamic block capturing a column view. You will be prompted
5295 for the scope or ID of the view.
5296 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
5297 Update dynamic block at point. The cursor needs to be in the
5298 @code{#+BEGIN} line of the dynamic block.
5299 @orgcmd{C-u C-c C-x C-u,org-update-all-dblocks}
5300 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
5301 you have several clock table blocks, column-capturing blocks or other dynamic
5305 You can add formulas to the column view table and you may add plotting
5306 instructions in front of the table---these will survive an update of the
5307 block. If there is a @code{#+TBLFM:} after the table, the table will
5308 actually be recalculated automatically after an update.
5310 An alternative way to capture and process property values into a table is
5311 provided by Eric Schulte's @file{org-collector.el} which is a contributed
5312 package@footnote{Contributed packages are not part of Emacs, but are
5313 distributed with the main distribution of Org (visit
5314 @uref{http://orgmode.org}).}. It provides a general API to collect
5315 properties from entries in a certain scope, and arbitrary Lisp expressions to
5316 process these values before inserting them into a table or a dynamic block.
5318 @node Property API, , Column view, Properties and Columns
5319 @section The Property API
5320 @cindex properties, API
5321 @cindex API, for properties
5323 There is a full API for accessing and changing properties. This API can
5324 be used by Emacs Lisp programs to work with properties and to implement
5325 features based on them. For more information see @ref{Using the
5328 @node Dates and Times, Capture - Refile - Archive, Properties and Columns, Top
5329 @chapter Dates and times
5335 To assist project planning, TODO items can be labeled with a date and/or
5336 a time. The specially formatted string carrying the date and time
5337 information is called a @emph{timestamp} in Org mode. This may be a
5338 little confusing because timestamp is often used as indicating when
5339 something was created or last changed. However, in Org mode this term
5340 is used in a much wider sense.
5343 * Timestamps:: Assigning a time to a tree entry
5344 * Creating timestamps:: Commands which insert timestamps
5345 * Deadlines and scheduling:: Planning your work
5346 * Clocking work time:: Tracking how long you spend on a task
5347 * Effort estimates:: Planning work effort in advance
5348 * Relative timer:: Notes with a running timer
5349 * Countdown timer:: Starting a countdown timer for a task
5353 @node Timestamps, Creating timestamps, Dates and Times, Dates and Times
5354 @section Timestamps, deadlines, and scheduling
5356 @cindex ranges, time
5361 A timestamp is a specification of a date (possibly with a time or a range of
5362 times) in a special format, either @samp{<2003-09-16 Tue>}@footnote{In this
5363 simplest form, the day name is optional when you type the date yourself.
5364 However, any dates inserted or modified by Org will add that day name, for
5365 reading convenience.} or @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16
5366 Tue 12:00-12:30>}@footnote{This is inspired by the standard ISO 8601
5367 date/time format. To use an alternative format, see @ref{Custom time
5368 format}.}. A timestamp can appear anywhere in the headline or body of an Org
5369 tree entry. Its presence causes entries to be shown on specific dates in the
5370 agenda (@pxref{Weekly/daily agenda}). We distinguish:
5373 @item Plain timestamp; Event; Appointment
5376 A simple timestamp just assigns a date/time to an item. This is just
5377 like writing down an appointment or event in a paper agenda. In the
5378 timeline and agenda displays, the headline of an entry associated with a
5379 plain timestamp will be shown exactly on that date.
5382 * Meet Peter at the movies <2006-11-01 Wed 19:15>
5383 * Discussion on climate change <2006-11-02 Thu 20:00-22:00>
5386 @item Timestamp with repeater interval
5387 @cindex timestamp, with repeater interval
5388 A timestamp may contain a @emph{repeater interval}, indicating that it
5389 applies not only on the given date, but again and again after a certain
5390 interval of N days (d), weeks (w), months (m), or years (y). The
5391 following will show up in the agenda every Wednesday:
5394 * Pick up Sam at school <2007-05-16 Wed 12:30 +1w>
5397 @item Diary-style sexp entries
5398 For more complex date specifications, Org mode supports using the special
5399 sexp diary entries implemented in the Emacs calendar/diary
5400 package@footnote{When working with the standard diary sexp functions, you
5401 need to be very careful with the order of the arguments. That order depend
5402 evilly on the variable @code{calendar-date-style} (or, for older Emacs
5403 versions, @code{european-calendar-style}). For example, to specify a date
5404 December 12, 2005, the call might look like @code{(diary-date 12 1 2005)} or
5405 @code{(diary-date 1 12 2005)} or @code{(diary-date 2005 12 1)}, depending on
5406 the settings. This has been the source of much confusion. Org mode users
5407 can resort to special versions of these functions like @code{org-date} or
5408 @code{org-anniversary}. These work just like the corresponding @code{diary-}
5409 functions, but with stable ISO order of arguments (year, month, day) wherever
5410 applicable, independent of the value of @code{calendar-date-style}.}. For example
5413 * The nerd meeting on every 2nd Thursday of the month
5414 <%%(org-float t 4 2)>
5417 @item Time/Date range
5420 Two timestamps connected by @samp{--} denote a range. The headline
5421 will be shown on the first and last day of the range, and on any dates
5422 that are displayed and fall in the range. Here is an example:
5425 ** Meeting in Amsterdam
5426 <2004-08-23 Mon>--<2004-08-26 Thu>
5429 @item Inactive timestamp
5430 @cindex timestamp, inactive
5431 @cindex inactive timestamp
5432 Just like a plain timestamp, but with square brackets instead of
5433 angular ones. These timestamps are inactive in the sense that they do
5434 @emph{not} trigger an entry to show up in the agenda.
5437 * Gillian comes late for the fifth time [2006-11-01 Wed]
5442 @node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times
5443 @section Creating timestamps
5444 @cindex creating timestamps
5445 @cindex timestamps, creating
5447 For Org mode to recognize timestamps, they need to be in the specific
5448 format. All commands listed below produce timestamps in the correct
5452 @orgcmd{C-c .,org-time-stamp}
5453 Prompt for a date and insert a corresponding timestamp. When the cursor is
5454 at an existing timestamp in the buffer, the command is used to modify this
5455 timestamp instead of inserting a new one. When this command is used twice in
5456 succession, a time range is inserted.
5458 @orgcmd{C-c !,org-time-stamp-inactive}
5459 Like @kbd{C-c .}, but insert an inactive timestamp that will not cause
5466 @vindex org-time-stamp-rounding-minutes
5467 Like @kbd{C-c .} and @kbd{C-c !}, but use the alternative format which
5468 contains date and time. The default time can be rounded to multiples of 5
5469 minutes, see the option @code{org-time-stamp-rounding-minutes}.
5472 Normalize timestamp, insert/fix day name if missing or wrong.
5474 @orgcmd{C-c <,org-date-from-calendar}
5475 Insert a timestamp corresponding to the cursor date in the Calendar.
5477 @orgcmd{C-c >,org-goto-calendar}
5478 Access the Emacs calendar for the current date. If there is a
5479 timestamp in the current line, go to the corresponding date
5482 @orgcmd{C-c C-o,org-open-at-point}
5483 Access the agenda for the date given by the timestamp or -range at
5484 point (@pxref{Weekly/daily agenda}).
5486 @orgcmdkkcc{S-@key{left},S-@key{right},org-timestamp-down-day,org-timestamp-up-day}
5487 Change date at cursor by one day. These key bindings conflict with
5488 shift-selection and related modes (@pxref{Conflicts}).
5490 @orgcmdkkcc{S-@key{up},S-@key{down},org-timestamp-up,org-timestamp-down-down}
5491 Change the item under the cursor in a timestamp. The cursor can be on a
5492 year, month, day, hour or minute. When the timestamp contains a time range
5493 like @samp{15:30-16:30}, modifying the first time will also shift the second,
5494 shifting the time block with constant length. To change the length, modify
5495 the second time. Note that if the cursor is in a headline and not at a
5496 timestamp, these same keys modify the priority of an item.
5497 (@pxref{Priorities}). The key bindings also conflict with shift-selection and
5498 related modes (@pxref{Conflicts}).
5500 @orgcmd{C-c C-y,org-evaluate-time-range}
5501 @cindex evaluate time range
5502 Evaluate a time range by computing the difference between start and end.
5503 With a prefix argument, insert result after the time range (in a table: into
5504 the following column).
5509 * The date/time prompt:: How Org mode helps you entering date and time
5510 * Custom time format:: Making dates look different
5513 @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps
5514 @subsection The date/time prompt
5515 @cindex date, reading in minibuffer
5516 @cindex time, reading in minibuffer
5518 @vindex org-read-date-prefer-future
5519 When Org mode prompts for a date/time, the default is shown in default
5520 date/time format, and the prompt therefore seems to ask for a specific
5521 format. But it will in fact accept any string containing some date and/or
5522 time information, and it is really smart about interpreting your input. You
5523 can, for example, use @kbd{C-y} to paste a (possibly multi-line) string
5524 copied from an email message. Org mode will find whatever information is in
5525 there and derive anything you have not specified from the @emph{default date
5526 and time}. The default is usually the current date and time, but when
5527 modifying an existing timestamp, or when entering the second stamp of a
5528 range, it is taken from the stamp in the buffer. When filling in
5529 information, Org mode assumes that most of the time you will want to enter a
5530 date in the future: if you omit the month/year and the given day/month is
5531 @i{before} today, it will assume that you mean a future date@footnote{See the
5532 variable @code{org-read-date-prefer-future}. You may set that variable to
5533 the symbol @code{time} to even make a time before now shift the date to
5534 tomorrow.}. If the date has been automatically shifted into the future, the
5535 time prompt will show this with @samp{(=>F).}
5537 For example, let's assume that today is @b{June 13, 2006}. Here is how
5538 various inputs will be interpreted, the items filled in by Org mode are
5542 3-2-5 @result{} 2003-02-05
5543 2/5/3 @result{} 2003-02-05
5544 14 @result{} @b{2006}-@b{06}-14
5545 12 @result{} @b{2006}-@b{07}-12
5546 2/5 @result{} @b{2007}-02-05
5547 Fri @result{} nearest Friday (default date or later)
5548 sep 15 @result{} @b{2006}-09-15
5549 feb 15 @result{} @b{2007}-02-15
5550 sep 12 9 @result{} 2009-09-12
5551 12:45 @result{} @b{2006}-@b{06}-@b{13} 12:45
5552 22 sept 0:34 @result{} @b{2006}-09-22 0:34
5553 w4 @result{} ISO week for of the current year @b{2006}
5554 2012 w4 fri @result{} Friday of ISO week 4 in 2012
5555 2012-w04-5 @result{} Same as above
5558 Furthermore you can specify a relative date by giving, as the
5559 @emph{first} thing in the input: a plus/minus sign, a number and a
5560 letter ([dwmy]) to indicate change in days, weeks, months, or years. With a
5561 single plus or minus, the date is always relative to today. With a
5562 double plus or minus, it is relative to the default date. If instead of
5563 a single letter, you use the abbreviation of day name, the date will be
5564 the Nth such day, e.g.@:
5569 +4d @result{} four days from today
5570 +4 @result{} same as above
5571 +2w @result{} two weeks from today
5572 ++5 @result{} five days from default date
5573 +2tue @result{} second Tuesday from now.
5576 @vindex parse-time-months
5577 @vindex parse-time-weekdays
5578 The function understands English month and weekday abbreviations. If
5579 you want to use unabbreviated names and/or other languages, configure
5580 the variables @code{parse-time-months} and @code{parse-time-weekdays}.
5582 @vindex org-read-date-force-compatible-dates
5583 Not all dates can be represented in a given Emacs implementation. By default
5584 Org mode forces dates into the compatibility range 1970--2037 which works on
5585 all Emacs implementations. If you want to use dates outside of this range,
5586 read the docstring of the variable
5587 @code{org-read-date-force-compatible-dates}.
5589 You can specify a time range by giving start and end times or by giving a
5590 start time and a duration (in HH:MM format). Use one or two dash(es) as the
5591 separator in the former case and use '+' as the separator in the latter
5595 11am-1:15pm @result{} 11:00-13:15
5596 11am--1:15pm @result{} same as above
5597 11am+2:15 @result{} same as above
5600 @cindex calendar, for selecting date
5601 @vindex org-popup-calendar-for-date-prompt
5602 Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
5603 you don't need/want the calendar, configure the variable
5604 @code{org-popup-calendar-for-date-prompt}.}. When you exit the date
5605 prompt, either by clicking on a date in the calendar, or by pressing
5606 @key{RET}, the date selected in the calendar will be combined with the
5607 information entered at the prompt. You can control the calendar fully
5608 from the minibuffer:
5615 @kindex S-@key{right}
5616 @kindex S-@key{left}
5617 @kindex S-@key{down}
5619 @kindex M-S-@key{right}
5620 @kindex M-S-@key{left}
5623 @key{RET} @r{Choose date at cursor in calendar.}
5624 mouse-1 @r{Select date by clicking on it.}
5625 S-@key{right}/@key{left} @r{One day forward/backward.}
5626 S-@key{down}/@key{up} @r{One week forward/backward.}
5627 M-S-@key{right}/@key{left} @r{One month forward/backward.}
5628 > / < @r{Scroll calendar forward/backward by one month.}
5629 M-v / C-v @r{Scroll calendar forward/backward by 3 months.}
5632 @vindex org-read-date-display-live
5633 The actions of the date/time prompt may seem complex, but I assure you they
5634 will grow on you, and you will start getting annoyed by pretty much any other
5635 way of entering a date/time out there. To help you understand what is going
5636 on, the current interpretation of your input will be displayed live in the
5637 minibuffer@footnote{If you find this distracting, turn the display of with
5638 @code{org-read-date-display-live}.}.
5640 @node Custom time format, , The date/time prompt, Creating timestamps
5641 @subsection Custom time format
5642 @cindex custom date/time format
5643 @cindex time format, custom
5644 @cindex date format, custom
5646 @vindex org-display-custom-times
5647 @vindex org-time-stamp-custom-formats
5648 Org mode uses the standard ISO notation for dates and times as it is
5649 defined in ISO 8601. If you cannot get used to this and require another
5650 representation of date and time to keep you happy, you can get it by
5651 customizing the variables @code{org-display-custom-times} and
5652 @code{org-time-stamp-custom-formats}.
5655 @orgcmd{C-c C-x C-t,org-toggle-time-stamp-overlays}
5656 Toggle the display of custom formats for dates and times.
5660 Org mode needs the default format for scanning, so the custom date/time
5661 format does not @emph{replace} the default format---instead it is put
5662 @emph{over} the default format using text properties. This has the
5663 following consequences:
5666 You cannot place the cursor onto a timestamp anymore, only before or
5669 The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
5670 each component of a timestamp. If the cursor is at the beginning of
5671 the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
5672 just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the
5673 time will be changed by one minute.
5675 If the timestamp contains a range of clock times or a repeater, these
5676 will not be overlaid, but remain in the buffer as they were.
5678 When you delete a timestamp character-by-character, it will only
5679 disappear from the buffer after @emph{all} (invisible) characters
5680 belonging to the ISO timestamp have been removed.
5682 If the custom timestamp format is longer than the default and you are
5683 using dates in tables, table alignment will be messed up. If the custom
5684 format is shorter, things do work as expected.
5688 @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times
5689 @section Deadlines and scheduling
5691 A timestamp may be preceded by special keywords to facilitate planning:
5695 @cindex DEADLINE keyword
5697 Meaning: the task (most likely a TODO item, though not necessarily) is supposed
5698 to be finished on that date.
5700 @vindex org-deadline-warning-days
5701 On the deadline date, the task will be listed in the agenda. In
5702 addition, the agenda for @emph{today} will carry a warning about the
5703 approaching or missed deadline, starting
5704 @code{org-deadline-warning-days} before the due date, and continuing
5705 until the entry is marked DONE. An example:
5708 *** TODO write article about the Earth for the Guide
5709 The editor in charge is [[bbdb:Ford Prefect]]
5710 DEADLINE: <2004-02-29 Sun>
5713 You can specify a different lead time for warnings for a specific
5714 deadlines using the following syntax. Here is an example with a warning
5715 period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}.
5718 @cindex SCHEDULED keyword
5720 Meaning: you are planning to start working on that task on the given
5723 @vindex org-agenda-skip-scheduled-if-done
5724 The headline will be listed under the given date@footnote{It will still
5725 be listed on that date after it has been marked DONE. If you don't like
5726 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In
5727 addition, a reminder that the scheduled date has passed will be present
5728 in the compilation for @emph{today}, until the entry is marked DONE, i.e.@:
5729 the task will automatically be forwarded until completed.
5732 *** TODO Call Trillian for a date on New Years Eve.
5733 SCHEDULED: <2004-12-25 Sat>
5737 @b{Important:} Scheduling an item in Org mode should @i{not} be
5738 understood in the same way that we understand @i{scheduling a meeting}.
5739 Setting a date for a meeting is just a simple appointment, you should
5740 mark this entry with a simple plain timestamp, to get this item shown
5741 on the date where it applies. This is a frequent misunderstanding by
5742 Org users. In Org mode, @i{scheduling} means setting a date when you
5743 want to start working on an action item.
5746 You may use timestamps with repeaters in scheduling and deadline
5747 entries. Org mode will issue early and late warnings based on the
5748 assumption that the timestamp represents the @i{nearest instance} of
5749 the repeater. However, the use of diary sexp entries like
5751 @code{<%%(org-float t 42)>}
5753 in scheduling and deadline timestamps is limited. Org mode does not
5754 know enough about the internals of each sexp function to issue early and
5755 late warnings. However, it will show the item on each day where the
5759 * Inserting deadline/schedule:: Planning items
5760 * Repeated tasks:: Items that show up again and again
5763 @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling
5764 @subsection Inserting deadlines or schedules
5766 The following commands allow you to quickly insert@footnote{The @samp{SCHEDULED} and
5767 @samp{DEADLINE} dates are inserted on the line right below the headline. Don't put
5768 any text between this line and the headline.} a deadline or to schedule
5773 @orgcmd{C-c C-d,org-deadline}
5774 Insert @samp{DEADLINE} keyword along with a stamp. The insertion will happen
5775 in the line directly following the headline. Any CLOSED timestamp will be
5776 removed. When called with a prefix arg, an existing deadline will be removed
5777 from the entry. Depending on the variable @code{org-log-redeadline}@footnote{with corresponding
5778 @code{#+STARTUP} keywords @code{logredeadline}, @code{lognoteredeadline},
5779 and @code{nologredeadline}}, a note will be taken when changing an existing
5782 @orgcmd{C-c C-s,org-schedule}
5783 Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will
5784 happen in the line directly following the headline. Any CLOSED timestamp
5785 will be removed. When called with a prefix argument, remove the scheduling
5786 date from the entry. Depending on the variable
5787 @code{org-log-reschedule}@footnote{with corresponding @code{#+STARTUP}
5788 keywords @code{logreschedule}, @code{lognotereschedule}, and
5789 @code{nologreschedule}}, a note will be taken when changing an existing
5792 @orgcmd{C-c C-x C-k,org-mark-entry-for-agenda-action}
5795 Mark the current entry for agenda action. After you have marked the entry
5796 like this, you can open the agenda or the calendar to find an appropriate
5797 date. With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to
5798 schedule the marked item.
5800 @orgcmd{C-c / d,org-check-deadlines}
5801 @cindex sparse tree, for deadlines
5802 @vindex org-deadline-warning-days
5803 Create a sparse tree with all deadlines that are either past-due, or
5804 which will become due within @code{org-deadline-warning-days}.
5805 With @kbd{C-u} prefix, show all deadlines in the file. With a numeric
5806 prefix, check that many days. For example, @kbd{C-1 C-c / d} shows
5807 all deadlines due tomorrow.
5809 @orgcmd{C-c / b,org-check-before-date}
5810 Sparse tree for deadlines and scheduled items before a given date.
5812 @orgcmd{C-c / a,org-check-after-date}
5813 Sparse tree for deadlines and scheduled items after a given date.
5816 Note that @code{org-schedule} and @code{org-deadline} supports
5817 setting the date by indicating a relative time: e.g. +1d will set
5818 the date to the next day after today, and --1w will set the date
5819 to the previous week before any current timestamp.
5821 @node Repeated tasks, , Inserting deadline/schedule, Deadlines and scheduling
5822 @subsection Repeated tasks
5823 @cindex tasks, repeated
5824 @cindex repeated tasks
5826 Some tasks need to be repeated again and again. Org mode helps to
5827 organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
5828 or plain timestamp. In the following example
5830 ** TODO Pay the rent
5831 DEADLINE: <2005-10-01 Sat +1m>
5834 the @code{+1m} is a repeater; the intended interpretation is that the task
5835 has a deadline on <2005-10-01> and repeats itself every (one) month starting
5836 from that time. If you need both a repeater and a special warning period in
5837 a deadline entry, the repeater should come first and the warning period last:
5838 @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
5840 @vindex org-todo-repeat-to-state
5841 Deadlines and scheduled items produce entries in the agenda when they are
5842 over-due, so it is important to be able to mark such an entry as completed
5843 once you have done so. When you mark a DEADLINE or a SCHEDULE with the TODO
5844 keyword DONE, it will no longer produce entries in the agenda. The problem
5845 with this is, however, that then also the @emph{next} instance of the
5846 repeated entry will not be active. Org mode deals with this in the following
5847 way: When you try to mark such an entry DONE (using @kbd{C-c C-t}), it will
5848 shift the base date of the repeating timestamp by the repeater interval, and
5849 immediately set the entry state back to TODO@footnote{In fact, the target
5850 state is taken from, in this sequence, the @code{REPEAT_TO_STATE} property or
5851 the variable @code{org-todo-repeat-to-state}. If neither of these is
5852 specified, the target state defaults to the first state of the TODO state
5853 sequence.}. In the example above, setting the state to DONE would actually
5854 switch the date like this:
5857 ** TODO Pay the rent
5858 DEADLINE: <2005-11-01 Tue +1m>
5861 @vindex org-log-repeat
5862 A timestamp@footnote{You can change this using the option
5863 @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
5864 @code{lognoterepeat}, and @code{nologrepeat}. With @code{lognoterepeat}, you
5865 will also be prompted for a note.} will be added under the deadline, to keep
5866 a record that you actually acted on the previous instance of this deadline.
5868 As a consequence of shifting the base date, this entry will no longer be
5869 visible in the agenda when checking past dates, but all future instances
5872 With the @samp{+1m} cookie, the date shift will always be exactly one
5873 month. So if you have not paid the rent for three months, marking this
5874 entry DONE will still keep it as an overdue deadline. Depending on the
5875 task, this may not be the best way to handle it. For example, if you
5876 forgot to call your father for 3 weeks, it does not make sense to call
5877 him 3 times in a single day to make up for it. Finally, there are tasks
5878 like changing batteries which should always repeat a certain time
5879 @i{after} the last time you did it. For these tasks, Org mode has
5880 special repeaters @samp{++} and @samp{.+}. For example:
5884 DEADLINE: <2008-02-10 Sun ++1w>
5885 Marking this DONE will shift the date by at least one week,
5886 but also by as many weeks as it takes to get this date into
5887 the future. However, it stays on a Sunday, even if you called
5888 and marked it done on Saturday.
5889 ** TODO Check the batteries in the smoke detectors
5890 DEADLINE: <2005-11-01 Tue .+1m>
5891 Marking this DONE will shift the date to one month after
5895 You may have both scheduling and deadline information for a specific
5896 task---just make sure that the repeater intervals on both are the same.
5898 An alternative to using a repeater is to create a number of copies of a task
5899 subtree, with dates shifted in each copy. The command @kbd{C-c C-x c} was
5900 created for this purpose, it is described in @ref{Structure editing}.
5903 @node Clocking work time, Effort estimates, Deadlines and scheduling, Dates and Times
5904 @section Clocking work time
5905 @cindex clocking time
5906 @cindex time clocking
5908 Org mode allows you to clock the time you spend on specific tasks in a
5909 project. When you start working on an item, you can start the clock.
5910 When you stop working on that task, or when you mark the task done, the
5911 clock is stopped and the corresponding time interval is recorded. It
5912 also computes the total time spent on each subtree of a project. And it
5913 remembers a history or tasks recently clocked, to that you can jump quickly
5914 between a number of tasks absorbing your time.
5916 To save the clock history across Emacs sessions, use
5918 (setq org-clock-persist 'history)
5919 (org-clock-persistence-insinuate)
5921 When you clock into a new task after resuming Emacs, the incomplete
5922 clock@footnote{To resume the clock under the assumption that you have worked
5923 on this task while outside Emacs, use @code{(setq org-clock-persist t)}.}
5924 will be found (@pxref{Resolving idle time}) and you will be prompted about
5928 * Clocking commands:: Starting and stopping a clock
5929 * The clock table:: Detailed reports
5930 * Resolving idle time:: Resolving time when you've been idle
5933 @node Clocking commands, The clock table, Clocking work time, Clocking work time
5934 @subsection Clocking commands
5937 @orgcmd{C-c C-x C-i,org-clock-in}
5938 @vindex org-clock-into-drawer
5939 @cindex property, LOG_INTO_DRAWER
5940 Start the clock on the current item (clock-in). This inserts the CLOCK
5941 keyword together with a timestamp. If this is not the first clocking of
5942 this item, the multiple CLOCK lines will be wrapped into a
5943 @code{:LOGBOOK:} drawer (see also the variable
5944 @code{org-clock-into-drawer}). You can also overrule
5945 the setting of this variable for a subtree by setting a
5946 @code{CLOCK_INTO_DRAWER} or @code{LOG_INTO_DRAWER} property.
5947 When called with a @kbd{C-u} prefix argument,
5948 select the task from a list of recently clocked tasks. With two @kbd{C-u
5949 C-u} prefixes, clock into the task at point and mark it as the default task.
5950 The default task will always be available when selecting a clocking task,
5951 with letter @kbd{d}.@*
5952 @cindex property: CLOCK_MODELINE_TOTAL
5953 @cindex property: LAST_REPEAT
5954 @vindex org-clock-modeline-total
5955 While the clock is running, the current clocking time is shown in the mode
5956 line, along with the title of the task. The clock time shown will be all
5957 time ever clocked for this task and its children. If the task has an effort
5958 estimate (@pxref{Effort estimates}), the mode line displays the current
5959 clocking time against it@footnote{To add an effort estimate ``on the fly'',
5960 hook a function doing this to @code{org-clock-in-prepare-hook}.} If the task
5961 is a repeating one (@pxref{Repeated tasks}), only the time since the last
5962 reset of the task @footnote{as recorded by the @code{LAST_REPEAT} property}
5963 will be shown. More control over what time is shown can be exercised with
5964 the @code{CLOCK_MODELINE_TOTAL} property. It may have the values
5965 @code{current} to show only the current clocking instance, @code{today} to
5966 show all time clocked on this tasks today (see also the variable
5967 @code{org-extend-today-until}), @code{all} to include all time, or
5968 @code{auto} which is the default@footnote{See also the variable
5969 @code{org-clock-modeline-total}.}.@* Clicking with @kbd{mouse-1} onto the
5970 mode line entry will pop up a menu with clocking options.
5972 @orgcmd{C-c C-x C-o,org-clock-out}
5973 @vindex org-log-note-clock-out
5974 Stop the clock (clock-out). This inserts another timestamp at the same
5975 location where the clock was last started. It also directly computes
5976 the resulting time in inserts it after the time range as @samp{=>
5977 HH:MM}. See the variable @code{org-log-note-clock-out} for the
5978 possibility to record an additional note together with the clock-out
5979 timestamp@footnote{The corresponding in-buffer setting is:
5980 @code{#+STARTUP: lognoteclock-out}}.
5981 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
5982 Update the effort estimate for the current clock task.
5985 @orgcmdkkc{C-c C-c,C-c C-y,org-evaluate-time-range}
5986 Recompute the time interval after changing one of the timestamps. This
5987 is only necessary if you edit the timestamps directly. If you change
5988 them with @kbd{S-@key{cursor}} keys, the update is automatic.
5989 @orgcmd{C-S-@key{up/down},org-clock-timestamps-up/down}
5990 On @code{CLOCK} log lines, increase/decrease both timestamps at the same
5991 time so that duration keeps the same.
5992 @orgcmd{C-c C-t,org-todo}
5993 Changing the TODO state of an item to DONE automatically stops the clock
5994 if it is running in this same item.
5995 @orgcmd{C-c C-x C-x,org-clock-cancel}
5996 Cancel the current clock. This is useful if a clock was started by
5997 mistake, or if you ended up working on something else.
5998 @orgcmd{C-c C-x C-j,org-clock-goto}
5999 Jump to the headline of the currently clocked in task. With a @kbd{C-u}
6000 prefix arg, select the target task from a list of recently clocked tasks.
6001 @orgcmd{C-c C-x C-d,org-clock-display}
6002 @vindex org-remove-highlights-with-change
6003 Display time summaries for each subtree in the current buffer. This puts
6004 overlays at the end of each headline, showing the total time recorded under
6005 that heading, including the time of any subheadings. You can use visibility
6006 cycling to study the tree, but the overlays disappear when you change the
6007 buffer (see variable @code{org-remove-highlights-with-change}) or press
6011 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
6012 the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
6013 worked on or closed during a day.
6015 @node The clock table, Resolving idle time, Clocking commands, Clocking work time
6016 @subsection The clock table
6017 @cindex clocktable, dynamic block
6018 @cindex report, of clocked time
6020 Org mode can produce quite complex reports based on the time clocking
6021 information. Such a report is called a @emph{clock table}, because it is
6022 formatted as one or several Org tables.
6025 @orgcmd{C-c C-x C-r,org-clock-report}
6026 Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
6027 report as an Org mode table into the current file. When the cursor is
6028 at an existing clock table, just update it. When called with a prefix
6029 argument, jump to the first clock report in the current document and
6030 update it. The clock table always includes also trees with
6031 @code{:ARCHIVE:} tag.
6032 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
6033 Update dynamic block at point. The cursor needs to be in the
6034 @code{#+BEGIN} line of the dynamic block.
6035 @orgkey{C-u C-c C-x C-u}
6036 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
6037 you have several clock table blocks in a buffer.
6038 @orgcmdkxkc{S-@key{left},S-@key{right},org-clocktable-try-shift}
6039 Shift the current @code{:block} interval and update the table. The cursor
6040 needs to be in the @code{#+BEGIN: clocktable} line for this command. If
6041 @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
6045 Here is an example of the frame for a clock table as it is inserted into the
6046 buffer with the @kbd{C-c C-x C-r} command:
6048 @cindex #+BEGIN, clocktable
6050 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
6054 @vindex org-clocktable-defaults
6055 The @samp{BEGIN} line and specify a number of options to define the scope,
6056 structure, and formatting of the report. Defaults for all these options can
6057 be configured in the variable @code{org-clocktable-defaults}.
6059 @noindent First there are options that determine which clock entries are to
6062 :maxlevel @r{Maximum level depth to which times are listed in the table.}
6063 @r{Clocks at deeper levels will be summed into the upper level.}
6064 :scope @r{The scope to consider. This can be any of the following:}
6065 nil @r{the current buffer or narrowed region}
6066 file @r{the full current buffer}
6067 subtree @r{the subtree where the clocktable is located}
6068 tree@var{N} @r{the surrounding level @var{N} tree, for example @code{tree3}}
6069 tree @r{the surrounding level 1 tree}
6070 agenda @r{all agenda files}
6071 ("file"..) @r{scan these files}
6072 file-with-archives @r{current file and its archives}
6073 agenda-with-archives @r{all agenda files, including archives}
6074 :block @r{The time block to consider. This block is specified either}
6075 @r{absolute, or relative to the current time and may be any of}
6077 2007-12-31 @r{New year eve 2007}
6078 2007-12 @r{December 2007}
6079 2007-W50 @r{ISO-week 50 in 2007}
6080 2007-Q2 @r{2nd quarter in 2007}
6081 2007 @r{the year 2007}
6082 today, yesterday, today-@var{N} @r{a relative day}
6083 thisweek, lastweek, thisweek-@var{N} @r{a relative week}
6084 thismonth, lastmonth, thismonth-@var{N} @r{a relative month}
6085 thisyear, lastyear, thisyear-@var{N} @r{a relative year}
6086 @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
6087 :tstart @r{A time string specifying when to start considering times.}
6088 :tend @r{A time string specifying when to stop considering times.}
6089 :step @r{@code{week} or @code{day}, to split the table into chunks.}
6090 @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
6091 :stepskip0 @r{Do not show steps that have zero time.}
6092 :fileskip0 @r{Do not show table sections from files which did not contribute.}
6093 :tags @r{A tags match to select entries that should contribute. See}
6094 @r{@ref{Matching tags and properties} for the match syntax.}
6097 Then there are options which determine the formatting of the table. There
6098 options are interpreted by the function @code{org-clocktable-write-default},
6099 but you can specify your own function using the @code{:formatter} parameter.
6101 :emphasize @r{When @code{t}, emphasize level one and level two items.}
6102 :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".}
6103 :link @r{Link the item headlines in the table to their origins.}
6104 :narrow @r{An integer to limit the width of the headline column in}
6105 @r{the org table. If you write it like @samp{50!}, then the}
6106 @r{headline will also be shortened in export.}
6107 :indent @r{Indent each headline field according to its level.}
6108 :tcolumns @r{Number of columns to be used for times. If this is smaller}
6109 @r{than @code{:maxlevel}, lower levels will be lumped into one column.}
6110 :level @r{Should a level number column be included?}
6111 :compact @r{Abbreviation for @code{:level nil :indent t :narrow 40! :tcolumns 1}}
6112 @r{All are overwritten except if there is an explicit @code{:narrow}}
6113 :timestamp @r{A timestamp for the entry, when available. Look for SCHEDULED,}
6114 @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.}
6115 :properties @r{List of properties that should be shown in the table. Each}
6116 @r{property will get its own column.}
6117 :inherit-props @r{When this flag is @code{t}, the values for @code{:properties} will be inherited.}
6118 :formula @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
6119 @r{As a special case, @samp{:formula %} adds a column with % time.}
6120 @r{If you do not specify a formula here, any existing formula}
6121 @r{below the clock table will survive updates and be evaluated.}
6122 :formatter @r{A function to format clock data and insert it into the buffer.}
6124 To get a clock summary of the current level 1 tree, for the current
6125 day, you could write
6127 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
6131 and to use a specific time range you could write@footnote{Note that all
6132 parameters must be specified in a single line---the line is broken here
6133 only to fit it into the manual.}
6135 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
6136 :tend "<2006-08-10 Thu 12:00>"
6139 A summary of the current subtree with % times would be
6141 #+BEGIN: clocktable :scope subtree :link t :formula %
6144 A horizontally compact representation of everything clocked during last week
6147 #+BEGIN: clocktable :scope agenda :block lastweek :compact t
6151 @node Resolving idle time, , The clock table, Clocking work time
6152 @subsection Resolving idle time
6153 @cindex resolve idle time
6155 @cindex idle, resolve, dangling
6156 If you clock in on a work item, and then walk away from your
6157 computer---perhaps to take a phone call---you often need to ``resolve'' the
6158 time you were away by either subtracting it from the current clock, or
6159 applying it to another one.
6161 @vindex org-clock-idle-time
6162 By customizing the variable @code{org-clock-idle-time} to some integer, such
6163 as 10 or 15, Emacs can alert you when you get back to your computer after
6164 being idle for that many minutes@footnote{On computers using Mac OS X,
6165 idleness is based on actual user idleness, not just Emacs' idle time. For
6166 X11, you can install a utility program @file{x11idle.c}, available in the
6167 UTILITIES directory of the Org git distribution, to get the same general
6168 treatment of idleness. On other systems, idle time refers to Emacs idle time
6169 only.}, and ask what you want to do with the idle time. There will be a
6170 question waiting for you when you get back, indicating how much idle time has
6171 passed (constantly updated with the current amount), as well as a set of
6172 choices to correct the discrepancy:
6176 To keep some or all of the minutes and stay clocked in, press @kbd{k}. Org
6177 will ask how many of the minutes to keep. Press @key{RET} to keep them all,
6178 effectively changing nothing, or enter a number to keep that many minutes.
6180 If you use the shift key and press @kbd{K}, it will keep however many minutes
6181 you request and then immediately clock out of that task. If you keep all of
6182 the minutes, this is the same as just clocking out of the current task.
6184 To keep none of the minutes, use @kbd{s} to subtract all the away time from
6185 the clock, and then check back in from the moment you returned.
6187 To keep none of the minutes and just clock out at the start of the away time,
6188 use the shift key and press @kbd{S}. Remember that using shift will always
6189 leave you clocked out, no matter which option you choose.
6191 To cancel the clock altogether, use @kbd{C}. Note that if instead of
6192 canceling you subtract the away time, and the resulting clock amount is less
6193 than a minute, the clock will still be canceled rather than clutter up the
6194 log with an empty entry.
6197 What if you subtracted those away minutes from the current clock, and now
6198 want to apply them to a new clock? Simply clock in to any task immediately
6199 after the subtraction. Org will notice that you have subtracted time ``on
6200 the books'', so to speak, and will ask if you want to apply those minutes to
6201 the next task you clock in on.
6203 There is one other instance when this clock resolution magic occurs. Say you
6204 were clocked in and hacking away, and suddenly your cat chased a mouse who
6205 scared a hamster that crashed into your UPS's power button! You suddenly
6206 lose all your buffers, but thanks to auto-save you still have your recent Org
6207 mode changes, including your last clock in.
6209 If you restart Emacs and clock into any task, Org will notice that you have a
6210 dangling clock which was never clocked out from your last session. Using
6211 that clock's starting time as the beginning of the unaccounted-for period,
6212 Org will ask how you want to resolve that time. The logic and behavior is
6213 identical to dealing with away time due to idleness; it is just happening due
6214 to a recovery event rather than a set amount of idle time.
6216 You can also check all the files visited by your Org agenda for dangling
6217 clocks at any time using @kbd{M-x org-resolve-clocks}.
6219 @node Effort estimates, Relative timer, Clocking work time, Dates and Times
6220 @section Effort estimates
6221 @cindex effort estimates
6223 @cindex property, Effort
6224 @vindex org-effort-property
6225 If you want to plan your work in a very detailed way, or if you need to
6226 produce offers with quotations of the estimated work effort, you may want to
6227 assign effort estimates to entries. If you are also clocking your work, you
6228 may later want to compare the planned effort with the actual working time, a
6229 great way to improve planning estimates. Effort estimates are stored in a
6230 special property @samp{Effort}@footnote{You may change the property being
6231 used with the variable @code{org-effort-property}.}. You can set the effort
6232 for an entry with the following commands:
6235 @orgcmd{C-c C-x e,org-set-effort}
6236 Set the effort estimate for the current entry. With a numeric prefix
6237 argument, set it to the Nth allowed value (see below). This command is also
6238 accessible from the agenda with the @kbd{e} key.
6239 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6240 Modify the effort estimate of the item currently being clocked.
6243 Clearly the best way to work with effort estimates is through column view
6244 (@pxref{Column view}). You should start by setting up discrete values for
6245 effort estimates, and a @code{COLUMNS} format that displays these values
6246 together with clock sums (if you want to clock your time). For a specific
6250 #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00
6251 #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
6255 @vindex org-global-properties
6256 @vindex org-columns-default-format
6257 or, even better, you can set up these values globally by customizing the
6258 variables @code{org-global-properties} and @code{org-columns-default-format}.
6259 In particular if you want to use this setup also in the agenda, a global
6260 setup may be advised.
6262 The way to assign estimates to individual items is then to switch to column
6263 mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
6264 value. The values you enter will immediately be summed up in the hierarchy.
6265 In the column next to it, any clocked time will be displayed.
6267 @vindex org-agenda-columns-add-appointments-to-effort-sum
6268 If you switch to column view in the daily/weekly agenda, the effort column
6269 will summarize the estimated work effort for each day@footnote{Please note
6270 the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
6271 column view}).}, and you can use this to find space in your schedule. To get
6272 an overview of the entire part of the day that is committed, you can set the
6273 option @code{org-agenda-columns-add-appointments-to-effort-sum}. The
6274 appointments on a day that take place over a specified time interval will
6275 then also be added to the load estimate of the day.
6277 Effort estimates can be used in secondary agenda filtering that is triggered
6278 with the @kbd{/} key in the agenda (@pxref{Agenda commands}). If you have
6279 these estimates defined consistently, two or three key presses will narrow
6280 down the list to stuff that fits into an available time slot.
6282 @node Relative timer, Countdown timer, Effort estimates, Dates and Times
6283 @section Taking notes with a relative timer
6284 @cindex relative timer
6286 When taking notes during, for example, a meeting or a video viewing, it can
6287 be useful to have access to times relative to a starting time. Org provides
6288 such a relative timer and make it easy to create timed notes.
6291 @orgcmd{C-c C-x .,org-timer}
6292 Insert a relative time into the buffer. The first time you use this, the
6293 timer will be started. When called with a prefix argument, the timer is
6295 @orgcmd{C-c C-x -,org-timer-item}
6296 Insert a description list item with the current relative time. With a prefix
6297 argument, first reset the timer to 0.
6298 @orgcmd{M-@key{RET},org-insert-heading}
6299 Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
6301 @c for key sequences with a comma, command name macros fail :(
6304 Pause the timer, or continue it if it is already paused
6305 (@command{org-timer-pause-or-continue}).
6306 @c removed the sentence because it is redundant to the following item
6307 @kindex C-u C-c C-x ,
6309 Stop the timer. After this, you can only start a new timer, not continue the
6310 old one. This command also removes the timer from the mode line.
6311 @orgcmd{C-c C-x 0,org-timer-start}
6312 Reset the timer without inserting anything into the buffer. By default, the
6313 timer is reset to 0. When called with a @kbd{C-u} prefix, reset the timer to
6314 specific starting offset. The user is prompted for the offset, with a
6315 default taken from a timer string at point, if any, So this can be used to
6316 restart taking notes after a break in the process. When called with a double
6317 prefix argument @kbd{C-u C-u}, change all timer strings in the active region
6318 by a certain amount. This can be used to fix timer strings if the timer was
6319 not started at exactly the right moment.
6322 @node Countdown timer, , Relative timer, Dates and Times
6323 @section Countdown timer
6324 @cindex Countdown timer
6328 Calling @code{org-timer-set-timer} from an Org mode buffer runs a countdown
6329 timer. Use @kbd{;} from agenda buffers, @key{C-c C-x ;} everywhere else.
6331 @code{org-timer-set-timer} prompts the user for a duration and displays a
6332 countdown timer in the modeline. @code{org-timer-default-timer} sets the
6333 default countdown value. Giving a prefix numeric argument overrides this
6336 @node Capture - Refile - Archive, Agenda Views, Dates and Times, Top
6337 @chapter Capture - Refile - Archive
6340 An important part of any organization system is the ability to quickly
6341 capture new ideas and tasks, and to associate reference material with them.
6342 Org does this using a process called @i{capture}. It also can store files
6343 related to a task (@i{attachments}) in a special directory. Once in the
6344 system, tasks and projects need to be moved around. Moving completed project
6345 trees to an archive file keeps the system compact and fast.
6348 * Capture:: Capturing new stuff
6349 * Attachments:: Add files to tasks
6350 * RSS Feeds:: Getting input from RSS feeds
6351 * Protocols:: External (e.g.@: Browser) access to Emacs and Org
6352 * Refiling notes:: Moving a tree from one place to another
6353 * Archiving:: What to do with finished projects
6356 @node Capture, Attachments, Capture - Refile - Archive, Capture - Refile - Archive
6360 Org's method for capturing new items is heavily inspired by John Wiegley
6361 excellent remember package. Up to version 6.36 Org used a special setup
6362 for @file{remember.el}. @file{org-remember.el} is still part of Org mode for
6363 backward compatibility with existing setups. You can find the documentation
6364 for org-remember at @url{http://orgmode.org/org-remember.pdf}.
6366 The new capturing setup described here is preferred and should be used by new
6367 users. To convert your @code{org-remember-templates}, run the command
6369 @kbd{M-x org-capture-import-remember-templates @key{RET}}
6371 @noindent and then customize the new variable with @kbd{M-x
6372 customize-variable org-capture-templates}, check the result, and save the
6373 customization. You can then use both remember and capture until
6374 you are familiar with the new mechanism.
6376 Capture lets you quickly store notes with little interruption of your work
6377 flow. The basic process of capturing is very similar to remember, but Org
6378 does enhance it with templates and more.
6381 * Setting up capture:: Where notes will be stored
6382 * Using capture:: Commands to invoke and terminate capture
6383 * Capture templates:: Define the outline of different note types
6386 @node Setting up capture, Using capture, Capture, Capture
6387 @subsection Setting up capture
6389 The following customization sets a default target file for notes, and defines
6390 a global key@footnote{Please select your own key, @kbd{C-c c} is only a
6391 suggestion.} for capturing new material.
6393 @vindex org-default-notes-file
6395 (setq org-default-notes-file (concat org-directory "/notes.org"))
6396 (define-key global-map "\C-cc" 'org-capture)
6399 @node Using capture, Capture templates, Setting up capture, Capture
6400 @subsection Using capture
6403 @orgcmd{C-c c,org-capture}
6404 Call the command @code{org-capture}. Note that this keybinding is global and
6405 not active by default - you need to install it. If you have templates
6407 defined @pxref{Capture templates}, it will offer these templates for
6408 selection or use a new Org outline node as the default template. It will
6409 insert the template into the target file and switch to an indirect buffer
6410 narrowed to this new node. You may then insert the information you want.
6412 @orgcmd{C-c C-c,org-capture-finalize}
6413 Once you have finished entering information into the capture buffer, @kbd{C-c
6414 C-c} will return you to the window configuration before the capture process,
6415 so that you can resume your work without further distraction. When called
6416 with a prefix arg, finalize and then jump to the captured item.
6418 @orgcmd{C-c C-w,org-capture-refile}
6419 Finalize the capture process by refiling (@pxref{Refiling notes}) the note to
6420 a different place. Please realize that this is a normal refiling command
6421 that will be executed---so the cursor position at the moment you run this
6422 command is important. If you have inserted a tree with a parent and
6423 children, first move the cursor back to the parent. Any prefix argument
6424 given to this command will be passed on to the @code{org-refile} command.
6426 @orgcmd{C-c C-k,org-capture-kill}
6427 Abort the capture process and return to the previous state.
6431 You can also call @code{org-capture} in a special way from the agenda, using
6432 the @kbd{k c} key combination. With this access, any timestamps inserted by
6433 the selected capture template will default to the cursor date in the agenda,
6434 rather than to the current date.
6436 To find the locations of the last stored capture, use @code{org-capture} with
6441 Visit the target location of a capture template. You get to select the
6442 template in the usual way.
6443 @orgkey{C-u C-u C-c c}
6444 Visit the last stored capture item in its buffer.
6447 @node Capture templates, , Using capture, Capture
6448 @subsection Capture templates
6449 @cindex templates, for Capture
6451 You can use templates for different types of capture items, and
6452 for different target locations. The easiest way to create such templates is
6453 through the customize interface.
6457 Customize the variable @code{org-capture-templates}.
6460 Before we give the formal description of template definitions, let's look at
6461 an example. Say you would like to use one template to create general TODO
6462 entries, and you want to put these entries under the heading @samp{Tasks} in
6463 your file @file{~/org/gtd.org}. Also, a date tree in the file
6464 @file{journal.org} should capture journal entries. A possible configuration
6468 (setq org-capture-templates
6469 '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks")
6470 "* TODO %?\n %i\n %a")
6471 ("j" "Journal" entry (file+datetree "~/org/journal.org")
6472 "* %?\nEntered on %U\n %i\n %a")))
6475 @noindent If you then press @kbd{C-c c t}, Org will prepare the template
6479 [[file:@var{link to where you initiated capture}]]
6483 During expansion of the template, @code{%a} has been replaced by a link to
6484 the location from where you called the capture command. This can be
6485 extremely useful for deriving tasks from emails, for example. You fill in
6486 the task definition, press @code{C-c C-c} and Org returns you to the same
6487 place where you started the capture process.
6489 To define special keys to capture to a particular template without going
6490 through the interactive template selection, you can create your key binding
6494 (define-key global-map "\C-cx"
6495 (lambda () (interactive) (org-capture nil "x")))
6499 * Template elements:: What is needed for a complete template entry
6500 * Template expansion:: Filling in information about time and context
6503 @node Template elements, Template expansion, Capture templates, Capture templates
6504 @subsubsection Template elements
6506 Now lets look at the elements of a template definition. Each entry in
6507 @code{org-capture-templates} is a list with the following items:
6511 The keys that will select the template, as a string, characters
6512 only, for example @code{"a"} for a template to be selected with a
6513 single key, or @code{"bt"} for selection with two keys. When using
6514 several keys, keys using the same prefix key must be sequential
6515 in the list and preceded by a 2-element entry explaining the
6516 prefix key, for example
6518 ("b" "Templates for marking stuff to buy")
6520 @noindent If you do not define a template for the @kbd{C} key, this key will
6521 be used to open the customize buffer for this complex variable.
6524 A short string describing the template, which will be shown during
6528 The type of entry, a symbol. Valid values are:
6531 An Org mode node, with a headline. Will be filed as the child of the target
6532 entry or as a top-level entry. The target file should be an Org mode file.
6534 A plain list item, placed in the first plain list at the target
6535 location. Again the target file should be an Org file.
6537 A checkbox item. This only differs from the plain list item by the
6540 a new line in the first table at the target location. Where exactly the
6541 line will be inserted depends on the properties @code{:prepend} and
6542 @code{:table-line-pos} (see below).
6544 Text to be inserted as it is.
6548 @vindex org-default-notes-file
6549 Specification of where the captured item should be placed. In Org mode
6550 files, targets usually define a node. Entries will become children of this
6551 node. Other types will be added to the table or list in the body of this
6552 node. Most target specifications contain a file name. If that file name is
6553 the empty string, it defaults to @code{org-default-notes-file}. A file can
6554 also be given as a variable, function, or Emacs Lisp form.
6558 @item (file "path/to/file")
6559 Text will be placed at the beginning or end of that file.
6561 @item (id "id of existing org entry")
6562 Filing as child of this entry, or in the body of the entry.
6564 @item (file+headline "path/to/file" "node headline")
6565 Fast configuration if the target heading is unique in the file.
6567 @item (file+olp "path/to/file" "Level 1 heading" "Level 2" ...)
6568 For non-unique headings, the full path is safer.
6570 @item (file+regexp "path/to/file" "regexp to find location")
6571 Use a regular expression to position the cursor.
6573 @item (file+datetree "path/to/file")
6574 Will create a heading in a date tree for today's date.
6576 @item (file+datetree+prompt "path/to/file")
6577 Will create a heading in a date tree, but will prompt for the date.
6579 @item (file+function "path/to/file" function-finding-location)
6580 A function to find the right location in the file.
6583 File to the entry that is currently being clocked.
6585 @item (function function-finding-location)
6586 Most general way, write your own function to find both
6591 The template for creating the capture item. If you leave this empty, an
6592 appropriate default template will be used. Otherwise this is a string with
6593 escape codes, which will be replaced depending on time and context of the
6594 capture call. The string with escapes may be loaded from a template file,
6595 using the special syntax @code{(file "path/to/template")}. See below for
6599 The rest of the entry is a property list of additional options.
6600 Recognized properties are:
6603 Normally new captured information will be appended at
6604 the target location (last child, last table line, last list item...).
6605 Setting this property will change that.
6607 @item :immediate-finish
6608 When set, do not offer to edit the information, just
6609 file it away immediately. This makes sense if the template only needs
6610 information that can be added automatically.
6613 Set this to the number of lines to insert
6614 before and after the new item. Default 0, only common other value is 1.
6617 Start the clock in this item.
6620 Keep the clock running when filing the captured entry.
6623 If starting the capture interrupted a clock, restart that clock when finished
6624 with the capture. Note that @code{:clock-keep} has precedence over
6625 @code{:clock-resume}. When setting both to @code{t}, the current clock will
6626 run and the previous one will not be resumed.
6629 Do not narrow the target buffer, simply show the full buffer. Default is to
6630 narrow it so that you only see the new material.
6632 @item :table-line-pos
6633 Specification of the location in the table where the new line should be
6634 inserted. It should be a string like @code{"II-3"} meaning that the new
6635 line should become the third line before the second horizontal separator
6639 If the target file was not yet visited when capture was invoked, kill the
6640 buffer again after capture is completed.
6644 @node Template expansion, , Template elements, Capture templates
6645 @subsubsection Template expansion
6647 In the template itself, special @kbd{%}-escapes@footnote{If you need one of
6648 these sequences literally, escape the @kbd{%} with a backslash.} allow
6649 dynamic insertion of content. The templates are expanded in the order given here:
6652 %[@var{file}] @r{insert the contents of the file given by @var{file}.}
6653 %(@var{sexp}) @r{evaluate Elisp @var{sexp} and replace with the result.}
6654 %<...> @r{the result of format-time-string on the ... format specification.}
6655 %t @r{timestamp, date only.}
6656 %T @r{timestamp with date and time.}
6657 %u, %U @r{like the above, but inactive timestamps.}
6658 %a @r{annotation, normally the link created with @code{org-store-link}.}
6659 %i @r{initial content, the region when capture is called while the}
6660 @r{region is active.}
6661 @r{The entire text will be indented like @code{%i} itself.}
6662 %A @r{like @code{%a}, but prompt for the description part.}
6663 %c @r{Current kill ring head.}
6664 %x @r{Content of the X clipboard.}
6665 %k @r{title of the currently clocked task.}
6666 %K @r{link to the currently clocked task.}
6667 %n @r{user name (taken from @code{user-full-name}).}
6668 %f @r{file visited by current buffer when org-capture was called.}
6669 %F @r{full path of the file or directory visited by current buffer.}
6670 %:keyword @r{specific information for certain link types, see below.}
6671 %^g @r{prompt for tags, with completion on tags in target file.}
6672 %^G @r{prompt for tags, with completion all tags in all agenda files.}
6673 %^t @r{like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}.}
6674 @r{You may define a prompt like @code{%^@{Birthday@}t}.}
6675 %^C @r{Interactive selection of which kill or clip to use.}
6676 %^L @r{Like @code{%^C}, but insert as link.}
6677 %^@{@var{prop}@}p @r{Prompt the user for a value for property @var{prop}.}
6678 %^@{@var{prompt}@} @r{prompt the user for a string and replace this sequence with it.}
6679 @r{You may specify a default value and a completion table with}
6680 @r{%^@{prompt|default|completion2|completion3...@}.}
6681 @r{The arrow keys access a prompt-specific history.}
6685 For specific link types, the following keywords will be
6686 defined@footnote{If you define your own link types (@pxref{Adding
6687 hyperlink types}), any property you store with
6688 @code{org-store-link-props} can be accessed in capture templates in a
6691 @vindex org-from-is-user-regexp
6693 Link type | Available keywords
6694 ------------------------+----------------------------------------------
6695 bbdb | %:name %:company
6696 irc | %:server %:port %:nick
6697 vm, wl, mh, mew, rmail | %:type %:subject %:message-id
6698 | %:from %:fromname %:fromaddress
6699 | %:to %:toname %:toaddress
6700 | %:date @r{(message date header field)}
6701 | %:date-timestamp @r{(date as active timestamp)}
6702 | %:date-timestamp-inactive @r{(date as inactive timestamp)}
6703 | %: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}.}}
6704 gnus | %:group, @r{for messages also all email fields}
6706 info | %:file %:node
6711 To place the cursor after template expansion use:
6714 %? @r{After completing the template, position cursor here.}
6718 @node Attachments, RSS Feeds, Capture, Capture - Refile - Archive
6719 @section Attachments
6722 @vindex org-attach-directory
6723 It is often useful to associate reference material with an outline node/task.
6724 Small chunks of plain text can simply be stored in the subtree of a project.
6725 Hyperlinks (@pxref{Hyperlinks}) can establish associations with
6726 files that live elsewhere on your computer or in the cloud, like emails or
6727 source code files belonging to a project. Another method is @i{attachments},
6728 which are files located in a directory belonging to an outline node. Org
6729 uses directories named by the unique ID of each entry. These directories are
6730 located in the @file{data} directory which lives in the same directory where
6731 your Org file lives@footnote{If you move entries or Org files from one
6732 directory to another, you may want to configure @code{org-attach-directory}
6733 to contain an absolute path.}. If you initialize this directory with
6734 @code{git init}, Org will automatically commit changes when it sees them.
6735 The attachment system has been contributed to Org by John Wiegley.
6737 In cases where it seems better to do so, you can also attach a directory of your
6738 choice to an entry. You can also make children inherit the attachment
6739 directory from a parent, so that an entire subtree uses the same attached
6742 @noindent The following commands deal with attachments:
6746 @orgcmd{C-c C-a,org-attach}
6747 The dispatcher for commands related to the attachment system. After these
6748 keys, a list of commands is displayed and you must press an additional key
6749 to select a command:
6752 @orgcmdtkc{a,C-c C-a a,org-attach-attach}
6753 @vindex org-attach-method
6754 Select a file and move it into the task's attachment directory. The file
6755 will be copied, moved, or linked, depending on @code{org-attach-method}.
6756 Note that hard links are not supported on all systems.
6762 Attach a file using the copy/move/link method.
6763 Note that hard links are not supported on all systems.
6765 @orgcmdtkc{n,C-c C-a n,org-attach-new}
6766 Create a new attachment as an Emacs buffer.
6768 @orgcmdtkc{z,C-c C-a z,org-attach-sync}
6769 Synchronize the current task with its attachment directory, in case you added
6770 attachments yourself.
6772 @orgcmdtkc{o,C-c C-a o,org-attach-open}
6773 @vindex org-file-apps
6774 Open current task's attachment. If there is more than one, prompt for a
6775 file name first. Opening will follow the rules set by @code{org-file-apps}.
6776 For more details, see the information on following hyperlinks
6777 (@pxref{Handling links}).
6779 @orgcmdtkc{O,C-c C-a O,org-attach-open-in-emacs}
6780 Also open the attachment, but force opening the file in Emacs.
6782 @orgcmdtkc{f,C-c C-a f,org-attach-reveal}
6783 Open the current task's attachment directory.
6785 @orgcmdtkc{F,C-c C-a F,org-attach-reveal-in-emacs}
6786 Also open the directory, but force using @command{dired} in Emacs.
6788 @orgcmdtkc{d,C-c C-a d,org-attach-delete-one}
6789 Select and delete a single attachment.
6791 @orgcmdtkc{D,C-c C-a D,org-attach-delete-all}
6792 Delete all of a task's attachments. A safer way is to open the directory in
6793 @command{dired} and delete from there.
6795 @orgcmdtkc{s,C-c C-a s,org-attach-set-directory}
6796 @cindex property, ATTACH_DIR
6797 Set a specific directory as the entry's attachment directory. This works by
6798 putting the directory path into the @code{ATTACH_DIR} property.
6800 @orgcmdtkc{i,C-c C-a i,org-attach-set-inherit}
6801 @cindex property, ATTACH_DIR_INHERIT
6802 Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
6803 same directory for attachments as the parent does.
6807 @node RSS Feeds, Protocols, Attachments, Capture - Refile - Archive
6812 Org can add and change entries based on information found in RSS feeds and
6813 Atom feeds. You could use this to make a task out of each new podcast in a
6814 podcast feed. Or you could use a phone-based note-creating service on the
6815 web to import tasks into Org. To access feeds, configure the variable
6816 @code{org-feed-alist}. The docstring of this variable has detailed
6817 information. Here is just an example:
6820 (setq org-feed-alist
6822 "http://rss.slashdot.org/Slashdot/slashdot"
6823 "~/txt/org/feeds.org" "Slashdot Entries")))
6827 will configure that new items from the feed provided by
6828 @code{rss.slashdot.org} will result in new entries in the file
6829 @file{~/org/feeds.org} under the heading @samp{Slashdot Entries}, whenever
6830 the following command is used:
6833 @orgcmd{C-c C-x g,org-feed-update-all}
6835 Collect items from the feeds configured in @code{org-feed-alist} and act upon
6837 @orgcmd{C-c C-x G,org-feed-goto-inbox}
6838 Prompt for a feed name and go to the inbox configured for this feed.
6841 Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which
6842 it will store information about the status of items in the feed, to avoid
6843 adding the same item several times. You should add @samp{FEEDSTATUS} to the
6844 list of drawers in that file:
6847 #+DRAWERS: LOGBOOK PROPERTIES FEEDSTATUS
6850 For more information, including how to read atom feeds, see
6851 @file{org-feed.el} and the docstring of @code{org-feed-alist}.
6853 @node Protocols, Refiling notes, RSS Feeds, Capture - Refile - Archive
6854 @section Protocols for external access
6855 @cindex protocols, for external access
6858 You can set up Org for handling protocol calls from outside applications that
6859 are passed to Emacs through the @file{emacsserver}. For example, you can
6860 configure bookmarks in your web browser to send a link to the current page to
6861 Org and create a note from it using capture (@pxref{Capture}). Or you
6862 could create a bookmark that will tell Emacs to open the local source file of
6863 a remote website you are looking at with the browser. See
6864 @uref{http://orgmode.org/worg/org-contrib/org-protocol.php} for detailed
6865 documentation and setup instructions.
6867 @node Refiling notes, Archiving, Protocols, Capture - Refile - Archive
6868 @section Refiling notes
6869 @cindex refiling notes
6871 When reviewing the captured data, you may want to refile some of the entries
6872 into a different list, for example into a project. Cutting, finding the
6873 right location, and then pasting the note is cumbersome. To simplify this
6874 process, you can use the following special command:
6877 @orgcmd{C-c C-w,org-refile}
6878 @vindex org-reverse-note-order
6879 @vindex org-refile-targets
6880 @vindex org-refile-use-outline-path
6881 @vindex org-outline-path-complete-in-steps
6882 @vindex org-refile-allow-creating-parent-nodes
6883 @vindex org-log-refile
6884 @vindex org-refile-use-cache
6885 Refile the entry or region at point. This command offers possible locations
6886 for refiling the entry and lets you select one with completion. The item (or
6887 all items in the region) is filed below the target heading as a subitem.
6888 Depending on @code{org-reverse-note-order}, it will be either the first or
6890 By default, all level 1 headlines in the current buffer are considered to be
6891 targets, but you can have more complex definitions across a number of files.
6892 See the variable @code{org-refile-targets} for details. If you would like to
6893 select a location via a file-path-like completion along the outline path, see
6894 the variables @code{org-refile-use-outline-path} and
6895 @code{org-outline-path-complete-in-steps}. If you would like to be able to
6896 create new nodes as new parents for refiling on the fly, check the
6897 variable @code{org-refile-allow-creating-parent-nodes}.
6898 When the variable @code{org-log-refile}@footnote{with corresponding
6899 @code{#+STARTUP} keywords @code{logrefile}, @code{lognoterefile},
6900 and @code{nologrefile}} is set, a timestamp or a note will be
6901 recorded when an entry has been refiled.
6902 @orgkey{C-u C-c C-w}
6903 Use the refile interface to jump to a heading.
6904 @orgcmd{C-u C-u C-c C-w,org-refile-goto-last-stored}
6905 Jump to the location where @code{org-refile} last moved a tree to.
6907 Refile as the child of the item currently being clocked.
6908 @item C-0 C-c C-w @ @r{or} @ C-u C-u C-u C-c C-w
6910 @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}
6912 Clear the target cache. Caching of refile targets can be turned on by
6913 setting @code{org-refile-use-cache}. To make the command see new possible
6914 targets, you have to clear the cache with this command.
6917 @node Archiving, , Refiling notes, Capture - Refile - Archive
6921 When a project represented by a (sub)tree is finished, you may want
6922 to move the tree out of the way and to stop it from contributing to the
6923 agenda. Archiving is important to keep your working files compact and global
6924 searches like the construction of agenda views fast.
6927 @orgcmd{C-c C-x C-a,org-archive-subtree-default}
6928 @vindex org-archive-default-command
6929 Archive the current entry using the command specified in the variable
6930 @code{org-archive-default-command}.
6934 * Moving subtrees:: Moving a tree to an archive file
6935 * Internal archiving:: Switch off a tree but keep it in the file
6938 @node Moving subtrees, Internal archiving, Archiving, Archiving
6939 @subsection Moving a tree to the archive file
6940 @cindex external archiving
6942 The most common archiving action is to move a project tree to another file,
6946 @orgcmdkskc{C-c C-x C-s,C-c $,org-archive-subtree}
6947 @vindex org-archive-location
6948 Archive the subtree starting at the cursor position to the location
6949 given by @code{org-archive-location}.
6950 @orgkey{C-u C-c C-x C-s}
6951 Check if any direct children of the current headline could be moved to
6952 the archive. To do this, each subtree is checked for open TODO entries.
6953 If none are found, the command offers to move it to the archive
6954 location. If the cursor is @emph{not} on a headline when this command
6955 is invoked, the level 1 trees will be checked.
6958 @cindex archive locations
6959 The default archive location is a file in the same directory as the
6960 current file, with the name derived by appending @file{_archive} to the
6961 current file name. For information and examples on how to change this,
6962 see the documentation string of the variable
6963 @code{org-archive-location}. There is also an in-buffer option for
6964 setting this variable, for example@footnote{For backward compatibility,
6965 the following also works: If there are several such lines in a file,
6966 each specifies the archive location for the text below it. The first
6967 such line also applies to any text before its definition. However,
6968 using this method is @emph{strongly} deprecated as it is incompatible
6969 with the outline structure of the document. The correct method for
6970 setting multiple archive locations in a buffer is using properties.}:
6974 #+ARCHIVE: %s_done::
6977 @cindex property, ARCHIVE
6979 If you would like to have a special ARCHIVE location for a single entry
6980 or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
6981 location as the value (@pxref{Properties and Columns}).
6983 @vindex org-archive-save-context-info
6984 When a subtree is moved, it receives a number of special properties that
6985 record context information like the file from where the entry came, its
6986 outline path the archiving time etc. Configure the variable
6987 @code{org-archive-save-context-info} to adjust the amount of information
6991 @node Internal archiving, , Moving subtrees, Archiving
6992 @subsection Internal archiving
6994 If you want to just switch off (for agenda views) certain subtrees without
6995 moving them to a different file, you can use the @code{ARCHIVE tag}.
6997 A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
6998 its location in the outline tree, but behaves in the following way:
7001 @vindex org-cycle-open-archived-trees
7002 It does not open when you attempt to do so with a visibility cycling
7003 command (@pxref{Visibility cycling}). You can force cycling archived
7004 subtrees with @kbd{C-@key{TAB}}, or by setting the option
7005 @code{org-cycle-open-archived-trees}. Also normal outline commands like
7006 @code{show-all} will open archived subtrees.
7008 @vindex org-sparse-tree-open-archived-trees
7009 During sparse tree construction (@pxref{Sparse trees}), matches in
7010 archived subtrees are not exposed, unless you configure the option
7011 @code{org-sparse-tree-open-archived-trees}.
7013 @vindex org-agenda-skip-archived-trees
7014 During agenda view construction (@pxref{Agenda Views}), the content of
7015 archived trees is ignored unless you configure the option
7016 @code{org-agenda-skip-archived-trees}, in which case these trees will always
7017 be included. In the agenda you can press @kbd{v a} to get archives
7018 temporarily included.
7020 @vindex org-export-with-archived-trees
7021 Archived trees are not exported (@pxref{Exporting}), only the headline
7022 is. Configure the details using the variable
7023 @code{org-export-with-archived-trees}.
7025 @vindex org-columns-skip-archived-trees
7026 Archived trees are excluded from column view unless the variable
7027 @code{org-columns-skip-archived-trees} is configured to @code{nil}.
7030 The following commands help manage the ARCHIVE tag:
7033 @orgcmd{C-c C-x a,org-toggle-archive-tag}
7034 Toggle the ARCHIVE tag for the current headline. When the tag is set,
7035 the headline changes to a shadowed face, and the subtree below it is
7037 @orgkey{C-u C-c C-x a}
7038 Check if any direct children of the current headline should be archived.
7039 To do this, each subtree is checked for open TODO entries. If none are
7040 found, the command offers to set the ARCHIVE tag for the child. If the
7041 cursor is @emph{not} on a headline when this command is invoked, the
7042 level 1 trees will be checked.
7043 @orgcmd{C-@kbd{TAB},org-force-cycle-archived}
7044 Cycle a tree even if it is tagged with ARCHIVE.
7045 @orgcmd{C-c C-x A,org-archive-to-archive-sibling}
7046 Move the current entry to the @emph{Archive Sibling}. This is a sibling of
7047 the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}. The
7048 entry becomes a child of that sibling and in this way retains a lot of its
7049 original context, including inherited tags and approximate position in the
7054 @node Agenda Views, Markup, Capture - Refile - Archive, Top
7055 @chapter Agenda views
7056 @cindex agenda views
7058 Due to the way Org works, TODO items, time-stamped items, and
7059 tagged headlines can be scattered throughout a file or even a number of
7060 files. To get an overview of open action items, or of events that are
7061 important for a particular date, this information must be collected,
7062 sorted and displayed in an organized way.
7064 Org can select items based on various criteria and display them
7065 in a separate buffer. Seven different view types are provided:
7069 an @emph{agenda} that is like a calendar and shows information
7072 a @emph{TODO list} that covers all unfinished
7075 a @emph{match view}, showings headlines based on the tags, properties, and
7076 TODO state associated with them,
7078 a @emph{timeline view} that shows all events in a single Org file,
7079 in time-sorted view,
7081 a @emph{text search view} that shows all entries from multiple files
7082 that contain specified keywords,
7084 a @emph{stuck projects view} showing projects that currently don't move
7087 @emph{custom views} that are special searches and combinations of different
7092 The extracted information is displayed in a special @emph{agenda
7093 buffer}. This buffer is read-only, but provides commands to visit the
7094 corresponding locations in the original Org files, and even to
7095 edit these files remotely.
7097 @vindex org-agenda-window-setup
7098 @vindex org-agenda-restore-windows-after-quit
7099 Two variables control how the agenda buffer is displayed and whether the
7100 window configuration is restored when the agenda exits:
7101 @code{org-agenda-window-setup} and
7102 @code{org-agenda-restore-windows-after-quit}.
7105 * Agenda files:: Files being searched for agenda information
7106 * Agenda dispatcher:: Keyboard access to agenda views
7107 * Built-in agenda views:: What is available out of the box?
7108 * Presentation and sorting:: How agenda items are prepared for display
7109 * Agenda commands:: Remote editing of Org trees
7110 * Custom agenda views:: Defining special searches and views
7111 * Exporting Agenda Views:: Writing a view to a file
7112 * Agenda column view:: Using column view for collected entries
7115 @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views
7116 @section Agenda files
7117 @cindex agenda files
7118 @cindex files for agenda
7120 @vindex org-agenda-files
7121 The information to be shown is normally collected from all @emph{agenda
7122 files}, the files listed in the variable
7123 @code{org-agenda-files}@footnote{If the value of that variable is not a
7124 list, but a single file name, then the list of agenda files will be
7125 maintained in that external file.}. If a directory is part of this list,
7126 all files with the extension @file{.org} in this directory will be part
7129 Thus, even if you only work with a single Org file, that file should
7130 be put into the list@footnote{When using the dispatcher, pressing
7131 @kbd{<} before selecting a command will actually limit the command to
7132 the current file, and ignore @code{org-agenda-files} until the next
7133 dispatcher command.}. You can customize @code{org-agenda-files}, but
7134 the easiest way to maintain it is through the following commands
7136 @cindex files, adding to agenda list
7138 @orgcmd{C-c [,org-agenda-file-to-front}
7139 Add current file to the list of agenda files. The file is added to
7140 the front of the list. If it was already in the list, it is moved to
7141 the front. With a prefix argument, file is added/moved to the end.
7142 @orgcmd{C-c ],org-remove-file}
7143 Remove current file from the list of agenda files.
7145 @cindex cycling, of agenda files
7146 @orgcmd{C-',org-cycle-agenda-files}
7148 Cycle through agenda file list, visiting one file after the other.
7149 @kindex M-x org-iswitchb
7150 @item M-x org-iswitchb
7151 Command to use an @code{iswitchb}-like interface to switch to and between Org
7156 The Org menu contains the current list of files and can be used
7157 to visit any of them.
7159 If you would like to focus the agenda temporarily on a file not in
7160 this list, or on just one file in the list, or even on only a subtree in a
7161 file, then this can be done in different ways. For a single agenda command,
7162 you may press @kbd{<} once or several times in the dispatcher
7163 (@pxref{Agenda dispatcher}). To restrict the agenda scope for an
7164 extended period, use the following commands:
7167 @orgcmd{C-c C-x <,org-agenda-set-restriction-lock}
7168 Permanently restrict the agenda to the current subtree. When with a
7169 prefix argument, or with the cursor before the first headline in a file,
7170 the agenda scope is set to the entire file. This restriction remains in
7171 effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
7172 or @kbd{>} in the agenda dispatcher. If there is a window displaying an
7173 agenda view, the new restriction takes effect immediately.
7174 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
7175 Remove the permanent restriction created by @kbd{C-c C-x <}.
7179 When working with @file{speedbar.el}, you can use the following commands in
7182 @orgcmdtkc{< @r{in the speedbar frame},<,org-speedbar-set-agenda-restriction}
7183 Permanently restrict the agenda to the item---either an Org file or a subtree
7184 in such a file---at the cursor in the Speedbar frame.
7185 If there is a window displaying an agenda view, the new restriction takes
7187 @orgcmdtkc{> @r{in the speedbar frame},>,org-agenda-remove-restriction-lock}
7188 Lift the restriction.
7191 @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views
7192 @section The agenda dispatcher
7193 @cindex agenda dispatcher
7194 @cindex dispatching agenda commands
7195 The views are created through a dispatcher, which should be bound to a
7196 global key---for example @kbd{C-c a} (@pxref{Activation}). In the
7197 following we will assume that @kbd{C-c a} is indeed how the dispatcher
7198 is accessed and list keyboard access to commands accordingly. After
7199 pressing @kbd{C-c a}, an additional letter is required to execute a
7200 command. The dispatcher offers the following default commands:
7203 Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
7205 Create a list of all TODO items (@pxref{Global TODO list}).
7207 Create a list of headlines matching a TAGS expression (@pxref{Matching
7208 tags and properties}).
7210 Create the timeline view for the current buffer (@pxref{Timeline}).
7212 Create a list of entries selected by a boolean expression of keywords
7213 and/or regular expressions that must or must not occur in the entry.
7215 @vindex org-agenda-text-search-extra-files
7216 Search for a regular expression in all agenda files and additionally in
7217 the files listed in @code{org-agenda-text-search-extra-files}. This
7218 uses the Emacs command @code{multi-occur}. A prefix argument can be
7219 used to specify the number of context lines for each match, default is
7222 Create a list of stuck projects (@pxref{Stuck projects}).
7224 Restrict an agenda command to the current buffer@footnote{For backward
7225 compatibility, you can also press @kbd{1} to restrict to the current
7226 buffer.}. After pressing @kbd{<}, you still need to press the character
7227 selecting the command.
7229 If there is an active region, restrict the following agenda command to
7230 the region. Otherwise, restrict it to the current subtree@footnote{For
7231 backward compatibility, you can also press @kbd{0} to restrict to the
7232 current region/subtree.}. After pressing @kbd{< <}, you still need to press the
7233 character selecting the command.
7236 You can also define custom commands that will be accessible through the
7237 dispatcher, just like the default commands. This includes the
7238 possibility to create extended agenda buffers that contain several
7239 blocks together, for example the weekly agenda, the global TODO list and
7240 a number of special tags matches. @xref{Custom agenda views}.
7242 @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda Views
7243 @section The built-in agenda views
7245 In this section we describe the built-in views.
7248 * Weekly/daily agenda:: The calendar page with current tasks
7249 * Global TODO list:: All unfinished action items
7250 * Matching tags and properties:: Structured information with fine-tuned search
7251 * Timeline:: Time-sorted view for single file
7252 * Search view:: Find entries by searching for text
7253 * Stuck projects:: Find projects you need to review
7256 @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views
7257 @subsection The weekly/daily agenda
7259 @cindex weekly agenda
7260 @cindex daily agenda
7262 The purpose of the weekly/daily @emph{agenda} is to act like a page of a
7263 paper agenda, showing all the tasks for the current week or day.
7266 @cindex org-agenda, command
7267 @orgcmd{C-c a a,org-agenda-list}
7268 Compile an agenda for the current week from a list of Org files. The agenda
7269 shows the entries for each day. With a numeric prefix@footnote{For backward
7270 compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
7271 listed before the agenda. This feature is deprecated, use the dedicated TODO
7272 list, or a block agenda instead (@pxref{Block agenda}).} (like @kbd{C-u 2 1
7273 C-c a a}) you may set the number of days to be displayed.
7276 @vindex org-agenda-span
7277 @vindex org-agenda-ndays
7278 The default number of days displayed in the agenda is set by the variable
7279 @code{org-agenda-span} (or the obsolete @code{org-agenda-ndays}). This
7280 variable can be set to any number of days you want to see by default in the
7281 agenda, or to a span name, such a @code{day}, @code{week}, @code{month} or
7284 Remote editing from the agenda buffer means, for example, that you can
7285 change the dates of deadlines and appointments from the agenda buffer.
7286 The commands available in the Agenda buffer are listed in @ref{Agenda
7289 @subsubheading Calendar/Diary integration
7290 @cindex calendar integration
7291 @cindex diary integration
7293 Emacs contains the calendar and diary by Edward M. Reingold. The
7294 calendar displays a three-month calendar with holidays from different
7295 countries and cultures. The diary allows you to keep track of
7296 anniversaries, lunar phases, sunrise/set, recurrent appointments
7297 (weekly, monthly) and more. In this way, it is quite complementary to
7298 Org. It can be very useful to combine output from Org with
7301 In order to include entries from the Emacs diary into Org mode's
7302 agenda, you only need to customize the variable
7305 (setq org-agenda-include-diary t)
7308 @noindent After that, everything will happen automatically. All diary
7309 entries including holidays, anniversaries, etc., will be included in the
7310 agenda buffer created by Org mode. @key{SPC}, @key{TAB}, and
7311 @key{RET} can be used from the agenda buffer to jump to the diary
7312 file in order to edit existing diary entries. The @kbd{i} command to
7313 insert new entries for the current date works in the agenda buffer, as
7314 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
7315 Sunrise/Sunset times, show lunar phases and to convert to other
7316 calendars, respectively. @kbd{c} can be used to switch back and forth
7317 between calendar and agenda.
7319 If you are using the diary only for sexp entries and holidays, it is
7320 faster to not use the above setting, but instead to copy or even move
7321 the entries into an Org file. Org mode evaluates diary-style sexp
7322 entries, and does it faster because there is no overhead for first
7323 creating the diary display. Note that the sexp entries must start at
7324 the left margin, no whitespace is allowed before them. For example,
7325 the following segment of an Org file will be processed and entries
7326 will be made in the agenda:
7329 * Birthdays and similar stuff
7331 %%(org-calendar-holiday) ; special function for holiday names
7333 %%(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
7334 %%(org-anniversary 1869 10 2) Mahatma Gandhi would be %d years old
7337 @subsubheading Anniversaries from BBDB
7338 @cindex BBDB, anniversaries
7339 @cindex anniversaries, from BBDB
7341 If you are using the Big Brothers Database to store your contacts, you will
7342 very likely prefer to store anniversaries in BBDB rather than in a
7343 separate Org or diary file. Org supports this and will show BBDB
7344 anniversaries as part of the agenda. All you need to do is to add the
7345 following to one of your agenda files:
7352 %%(org-bbdb-anniversaries)
7355 You can then go ahead and define anniversaries for a BBDB record. Basically,
7356 you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB
7357 record and then add the date in the format @code{YYYY-MM-DD} or @code{MM-DD},
7358 followed by a space and the class of the anniversary (@samp{birthday} or
7359 @samp{wedding}, or a format string). If you omit the class, it will default to
7360 @samp{birthday}. Here are a few examples, the header for the file
7361 @file{org-bbdb.el} contains more detailed information.
7367 2008-04-14 %s released version 6.01 of org mode, %d years ago
7370 After a change to BBDB, or for the first agenda display during an Emacs
7371 session, the agenda display will suffer a short delay as Org updates its
7372 hash with anniversaries. However, from then on things will be very fast---much
7373 faster in fact than a long list of @samp{%%(diary-anniversary)} entries
7374 in an Org or Diary file.
7376 @subsubheading Appointment reminders
7377 @cindex @file{appt.el}
7378 @cindex appointment reminders
7382 Org can interact with Emacs appointments notification facility. To add all
7383 the appointments of your agenda files, use the command
7384 @code{org-agenda-to-appt}. This command also lets you filter through the
7385 list of your appointments and add only those belonging to a specific category
7386 or matching a regular expression. See the docstring for details.
7388 @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views
7389 @subsection The global TODO list
7390 @cindex global TODO list
7391 @cindex TODO list, global
7393 The global TODO list contains all unfinished TODO items formatted and
7394 collected into a single place.
7397 @orgcmd{C-c a t,org-todo-list}
7398 Show the global TODO list. This collects the TODO items from all agenda
7399 files (@pxref{Agenda Views}) into a single buffer. By default, this lists
7400 items with a state the is not a DONE state. The buffer is in
7401 @code{agenda-mode}, so there are commands to examine and manipulate the TODO
7402 entries directly from that buffer (@pxref{Agenda commands}).
7403 @orgcmd{C-c a T,org-todo-list}
7404 @cindex TODO keyword matching
7405 @vindex org-todo-keywords
7406 Like the above, but allows selection of a specific TODO keyword. You can
7407 also do this by specifying a prefix argument to @kbd{C-c a t}. You are
7408 prompted for a keyword, and you may also specify several keywords by
7409 separating them with @samp{|} as the boolean OR operator. With a numeric
7410 prefix, the Nth keyword in @code{org-todo-keywords} is selected.
7412 The @kbd{r} key in the agenda buffer regenerates it, and you can give
7413 a prefix argument to this command to change the selected TODO keyword,
7414 for example @kbd{3 r}. If you often need a search for a specific
7415 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
7416 Matching specific TODO keywords can also be done as part of a tags
7417 search (@pxref{Tag searches}).
7420 Remote editing of TODO items means that you can change the state of a
7421 TODO entry with a single key press. The commands available in the
7422 TODO list are described in @ref{Agenda commands}.
7424 @cindex sublevels, inclusion into TODO list
7425 Normally the global TODO list simply shows all headlines with TODO
7426 keywords. This list can become very long. There are two ways to keep
7430 @vindex org-agenda-todo-ignore-scheduled
7431 @vindex org-agenda-todo-ignore-deadlines
7432 @vindex org-agenda-todo-ignore-timestamp
7433 @vindex org-agenda-todo-ignore-with-date
7434 Some people view a TODO item that has been @emph{scheduled} for execution or
7435 have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}.
7436 Configure the variables @code{org-agenda-todo-ignore-scheduled},
7437 @code{org-agenda-todo-ignore-deadlines},
7438 @code{org-agenda-todo-ignore-timestamp} and/or
7439 @code{org-agenda-todo-ignore-with-date} to exclude such items from the global
7442 @vindex org-agenda-todo-list-sublevels
7443 TODO items may have sublevels to break up the task into subtasks. In
7444 such cases it may be enough to list only the highest level TODO headline
7445 and omit the sublevels from the global list. Configure the variable
7446 @code{org-agenda-todo-list-sublevels} to get this behavior.
7449 @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views
7450 @subsection Matching tags and properties
7451 @cindex matching, of tags
7452 @cindex matching, of properties
7456 If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}),
7457 or have properties (@pxref{Properties and Columns}), you can select headlines
7458 based on this metadata and collect them into an agenda buffer. The match
7459 syntax described here also applies when creating sparse trees with @kbd{C-c /
7463 @orgcmd{C-c a m,org-tags-view}
7464 Produce a list of all headlines that match a given set of tags. The
7465 command prompts for a selection criterion, which is a boolean logic
7466 expression with tags, like @samp{+work+urgent-withboss} or
7467 @samp{work|home} (@pxref{Tags}). If you often need a specific search,
7468 define a custom command for it (@pxref{Agenda dispatcher}).
7469 @orgcmd{C-c a M,org-tags-view}
7470 @vindex org-tags-match-list-sublevels
7471 @vindex org-agenda-tags-todo-honor-ignore-options
7472 Like @kbd{C-c a m}, but only select headlines that are also TODO items in a
7473 not-DONE state and force checking subitems (see variable
7474 @code{org-tags-match-list-sublevels}). To exclude scheduled/deadline items,
7475 see the variable @code{org-agenda-tags-todo-honor-ignore-options}. Matching
7476 specific TODO keywords together with a tags match is also possible, see
7480 The commands available in the tags list are described in @ref{Agenda
7483 @subsubheading Match syntax
7485 @cindex Boolean logic, for tag/property searches
7486 A search string can use Boolean operators @samp{&} for AND and @samp{|} for
7487 OR. @samp{&} binds more strongly than @samp{|}. Parentheses are currently
7488 not implemented. Each element in the search is either a tag, a regular
7489 expression matching tags, or an expression like @code{PROPERTY OPERATOR
7490 VALUE} with a comparison operator, accessing a property value. Each element
7491 may be preceded by @samp{-}, to select against it, and @samp{+} is syntactic
7492 sugar for positive selection. The AND operator @samp{&} is optional when
7493 @samp{+} or @samp{-} is present. Here are some examples, using only tags.
7497 Select headlines tagged @samp{:work:}, but discard those also tagged
7500 Selects lines tagged @samp{:work:} or @samp{:laptop:}.
7501 @item work|laptop+night
7502 Like before, but require the @samp{:laptop:} lines to be tagged also
7506 @cindex regular expressions, with tags search
7507 Instead of a tag, you may also specify a regular expression enclosed in curly
7508 braces. For example,
7509 @samp{work+@{^boss.*@}} matches headlines that contain the tag
7510 @samp{:work:} and any tag @i{starting} with @samp{boss}.
7512 @cindex TODO keyword matching, with tags search
7513 @cindex level, require for tags/property match
7514 @cindex category, require for tags/property match
7515 @vindex org-odd-levels-only
7516 You may also test for properties (@pxref{Properties and Columns}) at the same
7517 time as matching tags. The properties may be real properties, or special
7518 properties that represent other metadata (@pxref{Special properties}). For
7519 example, the ``property'' @code{TODO} represents the TODO keyword of the
7520 entry. Or, the ``property'' @code{LEVEL} represents the level of an entry.
7521 So a search @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines
7522 that have the tag @samp{boss} and are @emph{not} marked with the TODO keyword
7523 DONE. In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not
7524 count the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc.
7526 Here are more examples:
7528 @item work+TODO="WAITING"
7529 Select @samp{:work:}-tagged TODO lines with the specific TODO
7530 keyword @samp{WAITING}.
7531 @item work+TODO="WAITING"|home+TODO="WAITING"
7532 Waiting tasks both at work and at home.
7535 When matching properties, a number of different operators can be used to test
7536 the value of a property. Here is a complex example:
7539 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 \
7540 +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
7544 The type of comparison will depend on how the comparison value is written:
7547 If the comparison value is a plain number, a numerical comparison is done,
7548 and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
7549 @samp{>=}, and @samp{<>}.
7551 If the comparison value is enclosed in double-quotes,
7552 a string comparison is done, and the same operators are allowed.
7554 If the comparison value is enclosed in double-quotes @emph{and} angular
7555 brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
7556 assumed to be date/time specifications in the standard Org way, and the
7557 comparison will be done accordingly. Special values that will be recognized
7558 are @code{"<now>"} for now (including time), and @code{"<today>"}, and
7559 @code{"<tomorrow>"} for these days at 0:00 hours, i.e.@: without a time
7560 specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
7561 @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
7562 respectively, can be used.
7564 If the comparison value is enclosed
7565 in curly braces, a regexp match is performed, with @samp{=} meaning that the
7566 regexp matches the property value, and @samp{<>} meaning that it does not
7570 So the search string in the example finds entries tagged @samp{:work:} but
7571 not @samp{:boss:}, which also have a priority value @samp{A}, a
7572 @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
7573 property that is numerically smaller than 2, a @samp{:With:} property that is
7574 matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
7575 on or after October 11, 2008.
7577 Accessing TODO, LEVEL, and CATEGORY during a search is fast. Accessing any
7578 other properties will slow down the search. However, once you have paid the
7579 price by accessing one property, testing additional properties is cheap
7582 You can configure Org mode to use property inheritance during a search, but
7583 beware that this can slow down searches considerably. See @ref{Property
7584 inheritance}, for details.
7586 For backward compatibility, and also for typing speed, there is also a
7587 different way to test TODO states in a search. For this, terminate the
7588 tags/property part of the search string (which may include several terms
7589 connected with @samp{|}) with a @samp{/} and then specify a Boolean
7590 expression just for TODO keywords. The syntax is then similar to that for
7591 tags, but should be applied with care: for example, a positive selection on
7592 several TODO keywords cannot meaningfully be combined with boolean AND.
7593 However, @emph{negative selection} combined with AND can be meaningful. To
7594 make sure that only lines are checked that actually have any TODO keyword
7595 (resulting in a speed-up), use @kbd{C-c a M}, or equivalently start the TODO
7596 part after the slash with @samp{!}. Using @kbd{C-c a M} or @samp{/!} will
7597 not match TODO keywords in a DONE state. Examples:
7601 Same as @samp{work+TODO="WAITING"}
7602 @item work/!-WAITING-NEXT
7603 Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
7605 @item work/!+WAITING|+NEXT
7606 Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
7610 @node Timeline, Search view, Matching tags and properties, Built-in agenda views
7611 @subsection Timeline for a single file
7612 @cindex timeline, single file
7613 @cindex time-sorted view
7615 The timeline summarizes all time-stamped items from a single Org mode
7616 file in a @emph{time-sorted view}. The main purpose of this command is
7617 to give an overview over events in a project.
7620 @orgcmd{C-c a L,org-timeline}
7621 Show a time-sorted view of the Org file, with all time-stamped items.
7622 When called with a @kbd{C-u} prefix, all unfinished TODO entries
7623 (scheduled or not) are also listed under the current date.
7627 The commands available in the timeline buffer are listed in
7628 @ref{Agenda commands}.
7630 @node Search view, Stuck projects, Timeline, Built-in agenda views
7631 @subsection Search view
7634 @cindex searching, for text
7636 This agenda view is a general text search facility for Org mode entries.
7637 It is particularly useful to find notes.
7640 @orgcmd{C-c a s,org-search-view}
7641 This is a special search that lets you select entries by matching a substring
7642 or specific words using a boolean logic.
7644 For example, the search string @samp{computer equipment} will find entries
7645 that contain @samp{computer equipment} as a substring. If the two words are
7646 separated by more space or a line break, the search will still match.
7647 Search view can also search for specific keywords in the entry, using Boolean
7648 logic. The search string @samp{+computer +wifi -ethernet -@{8\.11[bg]@}}
7649 will search for note entries that contain the keywords @code{computer}
7650 and @code{wifi}, but not the keyword @code{ethernet}, and which are also
7651 not matched by the regular expression @code{8\.11[bg]}, meaning to
7652 exclude both 8.11b and 8.11g. The first @samp{+} is necessary to turn on
7653 word search, other @samp{+} characters are optional. For more details, see
7654 the docstring of the command @code{org-search-view}.
7656 @vindex org-agenda-text-search-extra-files
7657 Note that in addition to the agenda files, this command will also search
7658 the files listed in @code{org-agenda-text-search-extra-files}.
7660 @node Stuck projects, , Search view, Built-in agenda views
7661 @subsection Stuck projects
7662 @pindex GTD, Getting Things Done
7664 If you are following a system like David Allen's GTD to organize your
7665 work, one of the ``duties'' you have is a regular review to make sure
7666 that all projects move along. A @emph{stuck} project is a project that
7667 has no defined next actions, so it will never show up in the TODO lists
7668 Org mode produces. During the review, you need to identify such
7669 projects and define next actions for them.
7672 @orgcmd{C-c a #,org-agenda-list-stuck-projects}
7673 List projects that are stuck.
7676 @vindex org-stuck-projects
7677 Customize the variable @code{org-stuck-projects} to define what a stuck
7678 project is and how to find it.
7681 You almost certainly will have to configure this view before it will
7682 work for you. The built-in default assumes that all your projects are
7683 level-2 headlines, and that a project is not stuck if it has at least
7684 one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
7686 Let's assume that you, in your own way of using Org mode, identify
7687 projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
7688 indicate a project that should not be considered yet. Let's further
7689 assume that the TODO keyword DONE marks finished projects, and that NEXT
7690 and TODO indicate next actions. The tag @@SHOP indicates shopping and
7691 is a next action even without the NEXT tag. Finally, if the project
7692 contains the special word IGNORE anywhere, it should not be listed
7693 either. In this case you would start by identifying eligible projects
7694 with a tags/todo match@footnote{@xref{Tag searches}.}
7695 @samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT, @@SHOP, and
7696 IGNORE in the subtree to identify projects that are not stuck. The
7697 correct customization for this is
7700 (setq org-stuck-projects
7701 '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
7705 Note that if a project is identified as non-stuck, the subtree of this entry
7706 will still be searched for stuck projects.
7708 @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views
7709 @section Presentation and sorting
7710 @cindex presentation, of agenda items
7712 @vindex org-agenda-prefix-format
7713 @vindex org-agenda-tags-column
7714 Before displaying items in an agenda view, Org mode visually prepares the
7715 items and sorts them. Each item occupies a single line. The line starts
7716 with a @emph{prefix} that contains the @emph{category} (@pxref{Categories})
7717 of the item and other important information. You can customize in which
7718 column tags will be displayed through @code{org-agenda-tags-column}. You can
7719 also customize the prefix using the option @code{org-agenda-prefix-format}.
7720 This prefix is followed by a cleaned-up version of the outline headline
7721 associated with the item.
7724 * Categories:: Not all tasks are equal
7725 * Time-of-day specifications:: How the agenda knows the time
7726 * Sorting of agenda items:: The order of things
7729 @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting
7730 @subsection Categories
7734 The category is a broad label assigned to each agenda item. By default,
7735 the category is simply derived from the file name, but you can also
7736 specify it with a special line in the buffer, like this@footnote{For
7737 backward compatibility, the following also works: if there are several
7738 such lines in a file, each specifies the category for the text below it.
7739 The first category also applies to any text before the first CATEGORY
7740 line. However, using this method is @emph{strongly} deprecated as it is
7741 incompatible with the outline structure of the document. The correct
7742 method for setting multiple categories in a buffer is using a
7750 @cindex property, CATEGORY
7751 If you would like to have a special CATEGORY for a single entry or a
7752 (sub)tree, give the entry a @code{:CATEGORY:} property with the
7753 special category you want to apply as the value.
7756 The display in the agenda buffer looks best if the category is not
7757 longer than 10 characters.
7760 You can set up icons for category by customizing the
7761 @code{org-agenda-category-icon-alist} variable.
7763 @node Time-of-day specifications, Sorting of agenda items, Categories, Presentation and sorting
7764 @subsection Time-of-day specifications
7765 @cindex time-of-day specification
7767 Org mode checks each agenda item for a time-of-day specification. The
7768 time can be part of the timestamp that triggered inclusion into the
7769 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time
7770 ranges can be specified with two timestamps, like
7772 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
7774 In the headline of the entry itself, a time(range) may also appear as
7775 plain text (like @samp{12:45} or a @samp{8:30-1pm}). If the agenda
7776 integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
7777 specifications in diary entries are recognized as well.
7779 For agenda display, Org mode extracts the time and displays it in a
7780 standard 24 hour format as part of the prefix. The example times in
7781 the previous paragraphs would end up in the agenda like this:
7784 8:30-13:00 Arthur Dent lies in front of the bulldozer
7785 12:45...... Ford Prefect arrives and takes Arthur to the pub
7786 19:00...... The Vogon reads his poem
7787 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
7791 If the agenda is in single-day mode, or for the display of today, the
7792 timed entries are embedded in a time grid, like
7795 8:00...... ------------------
7796 8:30-13:00 Arthur Dent lies in front of the bulldozer
7797 10:00...... ------------------
7798 12:00...... ------------------
7799 12:45...... Ford Prefect arrives and takes Arthur to the pub
7800 14:00...... ------------------
7801 16:00...... ------------------
7802 18:00...... ------------------
7803 19:00...... The Vogon reads his poem
7804 20:00...... ------------------
7805 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
7808 @vindex org-agenda-use-time-grid
7809 @vindex org-agenda-time-grid
7810 The time grid can be turned on and off with the variable
7811 @code{org-agenda-use-time-grid}, and can be configured with
7812 @code{org-agenda-time-grid}.
7814 @node Sorting of agenda items, , Time-of-day specifications, Presentation and sorting
7815 @subsection Sorting of agenda items
7816 @cindex sorting, of agenda items
7817 @cindex priorities, of agenda items
7818 Before being inserted into a view, the items are sorted. How this is
7819 done depends on the type of view.
7822 @vindex org-agenda-files
7823 For the daily/weekly agenda, the items for each day are sorted. The
7824 default order is to first collect all items containing an explicit
7825 time-of-day specification. These entries will be shown at the beginning
7826 of the list, as a @emph{schedule} for the day. After that, items remain
7827 grouped in categories, in the sequence given by @code{org-agenda-files}.
7828 Within each category, items are sorted by priority (@pxref{Priorities}),
7829 which is composed of the base priority (2000 for priority @samp{A}, 1000
7830 for @samp{B}, and 0 for @samp{C}), plus additional increments for
7831 overdue scheduled or deadline items.
7833 For the TODO list, items remain in the order of categories, but within
7834 each category, sorting takes place according to priority
7835 (@pxref{Priorities}). The priority used for sorting derives from the
7836 priority cookie, with additions depending on how close an item is to its due
7839 For tags matches, items are not sorted at all, but just appear in the
7840 sequence in which they are found in the agenda files.
7843 @vindex org-agenda-sorting-strategy
7844 Sorting can be customized using the variable
7845 @code{org-agenda-sorting-strategy}, and may also include criteria based on
7846 the estimated effort of an entry (@pxref{Effort estimates}).
7848 @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda Views
7849 @section Commands in the agenda buffer
7850 @cindex commands, in agenda buffer
7852 Entries in the agenda buffer are linked back to the Org file or diary
7853 file where they originate. You are not allowed to edit the agenda
7854 buffer itself, but commands are provided to show and jump to the
7855 original entry location, and to edit the Org files ``remotely'' from
7856 the agenda buffer. In this way, all information is stored only once,
7857 removing the risk that your agenda and note files may diverge.
7859 Some commands can be executed with mouse clicks on agenda lines. For
7860 the other commands, the cursor needs to be in the desired line.
7863 @tsubheading{Motion}
7864 @cindex motion commands in agenda
7865 @orgcmd{n,org-agenda-next-line}
7866 Next line (same as @key{up} and @kbd{C-p}).
7867 @orgcmd{p,org-agenda-previous-line}
7868 Previous line (same as @key{down} and @kbd{C-n}).
7869 @tsubheading{View/Go to Org file}
7870 @orgcmdkkc{@key{SPC},mouse-3,org-agenda-show-and-scroll-up}
7871 Display the original location of the item in another window.
7872 With prefix arg, make sure that the entire entry is made visible in the
7873 outline, not only the heading.
7875 @orgcmd{L,org-agenda-recenter}
7876 Display original location and recenter that window.
7878 @orgcmdkkc{@key{TAB},mouse-2,org-agenda-goto}
7879 Go to the original location of the item in another window.
7881 @orgcmd{@key{RET},org-agenda-switch-to}
7882 Go to the original location of the item and delete other windows.
7884 @orgcmd{F,org-agenda-follow-mode}
7885 @vindex org-agenda-start-with-follow-mode
7886 Toggle Follow mode. In Follow mode, as you move the cursor through
7887 the agenda buffer, the other window always shows the corresponding
7888 location in the Org file. The initial setting for this mode in new
7889 agenda buffers can be set with the variable
7890 @code{org-agenda-start-with-follow-mode}.
7892 @orgcmd{C-c C-x b,org-agenda-tree-to-indirect-buffer}
7893 Display the entire subtree of the current item in an indirect buffer. With a
7894 numeric prefix argument N, go up to level N and then take that tree. If N is
7895 negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the
7896 previously used indirect buffer.
7898 @orgcmd{C-c C-o,org-agenda-open-link}
7899 Follow a link in the entry. This will offer a selection of any links in the
7900 text belonging to the referenced Org node. If there is only one link, it
7901 will be followed without a selection prompt.
7903 @tsubheading{Change display}
7904 @cindex display changing, in agenda
7907 Interactively select another agenda view and append it to the current view.
7911 Delete other windows.
7913 @orgcmdkskc{v d,d,org-agenda-day-view}
7914 @xorgcmdkskc{v w,w,org-agenda-day-view}
7915 @xorgcmd{v m,org-agenda-month-view}
7916 @xorgcmd{v y,org-agenda-month-year}
7917 @xorgcmd{v SPC,org-agenda-reset-view}
7918 @vindex org-agenda-span
7919 Switch to day/week/month/year view. When switching to day or week view, this
7920 setting becomes the default for subsequent agenda refreshes. Since month and
7921 year views are slow to create, they do not become the default. A numeric
7922 prefix argument may be used to jump directly to a specific day of the year,
7923 ISO week, month, or year, respectively. For example, @kbd{32 d} jumps to
7924 February 1st, @kbd{9 w} to ISO week number 9. When setting day, week, or
7925 month view, a year may be encoded in the prefix argument as well. For
7926 example, @kbd{200712 w} will jump to week 12 in 2007. If such a year
7927 specification has only one or two digits, it will be mapped to the interval
7928 1938-2037. @kbd{v @key{SPC}} will reset to what is set in
7929 @code{org-agenda-span}.
7931 @orgcmd{f,org-agenda-later}
7932 Go forward in time to display the following @code{org-agenda-current-span} days.
7933 For example, if the display covers a week, switch to the following week.
7934 With prefix arg, go forward that many times @code{org-agenda-current-span} days.
7936 @orgcmd{b,org-agenda-earlier}
7937 Go backward in time to display earlier dates.
7939 @orgcmd{.,org-agenda-goto-today}
7942 @orgcmd{j,org-agenda-goto-date}
7943 Prompt for a date and go there.
7945 @orgcmd{J,org-agenda-clock-goto}
7946 Go to the currently clocked-in task @i{in the agenda buffer}.
7948 @orgcmd{D,org-agenda-toggle-diary}
7949 Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}.
7951 @orgcmdkskc{v l,l,org-agenda-log-mode}
7953 @vindex org-log-done
7954 @vindex org-agenda-log-mode-items
7955 Toggle Logbook mode. In Logbook mode, entries that were marked DONE while
7956 logging was on (variable @code{org-log-done}) are shown in the agenda, as are
7957 entries that have been clocked on that day. You can configure the entry
7958 types that should be included in log mode using the variable
7959 @code{org-agenda-log-mode-items}. When called with a @kbd{C-u} prefix, show
7960 all possible logbook entries, including state changes. When called with two
7961 prefix args @kbd{C-u C-u}, show only logging information, nothing else.
7962 @kbd{v L} is equivalent to @kbd{C-u v l}.
7964 @orgcmdkskc{v [,[,org-agenda-manipulate-query-add}
7965 Include inactive timestamps into the current view. Only for weekly/daily
7966 agenda and timeline views.
7968 @orgcmd{v a,org-agenda-archives-mode}
7969 @xorgcmd{v A,org-agenda-archives-mode 'files}
7970 Toggle Archives mode. In Archives mode, trees that are marked
7971 @code{ARCHIVED} are also scanned when producing the agenda. When you use the
7972 capital @kbd{A}, even all archive files are included. To exit archives mode,
7973 press @kbd{v a} again.
7975 @orgcmdkskc{v R,R,org-agenda-clockreport-mode}
7976 @vindex org-agenda-start-with-clockreport-mode
7977 @vindex org-clock-report-include-clocking-task
7978 Toggle Clockreport mode. In Clockreport mode, the daily/weekly agenda will
7979 always show a table with the clocked times for the timespan and file scope
7980 covered by the current agenda view. The initial setting for this mode in new
7981 agenda buffers can be set with the variable
7982 @code{org-agenda-start-with-clockreport-mode}. By using a prefix argument
7983 when toggling this mode (i.e.@: @kbd{C-u R}), the clock table will not show
7984 contributions from entries that are hidden by agenda filtering@footnote{Only
7985 tags filtering will be respected here, effort filtering is ignored.}. See
7986 also the variable @code{org-clock-report-include-clocking-task}.
7989 @vindex org-agenda-clock-consistency-checks
7990 Show overlapping clock entries, clocking gaps, and other clocking problems in
7991 the current agenda range. You can then visit clocking lines and fix them
7992 manually. See the variable @code{org-agenda-clock-consistency-checks} for
7993 information on how to customize the definition of what constituted a clocking
7994 problem. To return to normal agenda display, press @kbd{l} to exit Logbook
7997 @orgcmdkskc{v E,E,org-agenda-entry-text-mode}
7998 @vindex org-agenda-start-with-entry-text-mode
7999 @vindex org-agenda-entry-text-maxlines
8000 Toggle entry text mode. In entry text mode, a number of lines from the Org
8001 outline node referenced by an agenda line will be displayed below the line.
8002 The maximum number of lines is given by the variable
8003 @code{org-agenda-entry-text-maxlines}. Calling this command with a numeric
8004 prefix argument will temporarily modify that number to the prefix value.
8006 @orgcmd{G,org-agenda-toggle-time-grid}
8007 @vindex org-agenda-use-time-grid
8008 @vindex org-agenda-time-grid
8009 Toggle the time grid on and off. See also the variables
8010 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
8012 @orgcmd{r,org-agenda-redo}
8013 Recreate the agenda buffer, for example to reflect the changes after
8014 modification of the timestamps of items with @kbd{S-@key{left}} and
8015 @kbd{S-@key{right}}. When the buffer is the global TODO list, a prefix
8016 argument is interpreted to create a selective list for a specific TODO
8018 @orgcmd{g,org-agenda-redo}
8021 @orgcmdkskc{C-x C-s,s,org-save-all-org-buffers}
8022 Save all Org buffers in the current Emacs session, and also the locations of
8025 @orgcmd{C-c C-x C-c,org-agenda-columns}
8026 @vindex org-columns-default-format
8027 Invoke column view (@pxref{Column view}) in the agenda buffer. The column
8028 view format is taken from the entry at point, or (if there is no entry at
8029 point), from the first entry in the agenda view. So whatever the format for
8030 that entry would be in the original buffer (taken from a property, from a
8031 @code{#+COLUMNS} line, or from the default variable
8032 @code{org-columns-default-format}), will be used in the agenda.
8034 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
8035 Remove the restriction lock on the agenda, if it is currently restricted to a
8036 file or subtree (@pxref{Agenda files}).
8038 @tsubheading{Secondary filtering and query editing}
8039 @cindex filtering, by tag category and effort, in agenda
8040 @cindex tag filtering, in agenda
8041 @cindex category filtering, in agenda
8042 @cindex effort filtering, in agenda
8043 @cindex query editing, in agenda
8045 @orgcmd{<,org-agenda-filter-by-category}
8046 @vindex org-agenda-category-filter-preset
8048 Filter the current agenda view with respect to the category of the item at
8049 point. Pressing @code{<} another time will remove this filter. You can add
8050 a filter preset through the option @code{org-agenda-category-filter-preset}
8053 @orgcmd{/,org-agenda-filter-by-tag}
8054 @vindex org-agenda-tag-filter-preset
8055 Filter the current agenda view with respect to a tag and/or effort estimates.
8056 The difference between this and a custom agenda command is that filtering is
8057 very fast, so that you can switch quickly between different filters without
8058 having to recreate the agenda.@footnote{Custom commands can preset a filter by
8059 binding the variable @code{org-agenda-tag-filter-preset} as an option. This
8060 filter will then be applied to the view and persist as a basic filter through
8061 refreshes and more secondary filtering. The filter is a global property of
8062 the entire agenda view---in a block agenda, you should only set this in the
8063 global options section, not in the section of an individual block.}
8065 You will be prompted for a tag selection letter; @key{SPC} will mean any tag at
8066 all. Pressing @key{TAB} at that prompt will offer use completion to select a
8067 tag (including any tags that do not have a selection character). The command
8068 then hides all entries that do not contain or inherit this tag. When called
8069 with prefix arg, remove the entries that @emph{do} have the tag. A second
8070 @kbd{/} at the prompt will turn off the filter and unhide any hidden entries.
8071 If the first key you press is either @kbd{+} or @kbd{-}, the previous filter
8072 will be narrowed by requiring or forbidding the selected additional tag.
8073 Instead of pressing @kbd{+} or @kbd{-} after @kbd{/}, you can also
8074 immediately use the @kbd{\} command.
8076 @vindex org-sort-agenda-noeffort-is-high
8077 In order to filter for effort estimates, you should set up allowed
8078 efforts globally, for example
8080 (setq org-global-properties
8081 '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
8083 You can then filter for an effort by first typing an operator, one of
8084 @kbd{<}, @kbd{>}, and @kbd{=}, and then the one-digit index of an effort
8085 estimate in your array of allowed values, where @kbd{0} means the 10th value.
8086 The filter will then restrict to entries with effort smaller-or-equal, equal,
8087 or larger-or-equal than the selected value. If the digits 0-9 are not used
8088 as fast access keys to tags, you can also simply press the index digit
8089 directly without an operator. In this case, @kbd{<} will be assumed. For
8090 application of the operator, entries without a defined effort will be treated
8091 according to the value of @code{org-sort-agenda-noeffort-is-high}. To filter
8092 for tasks without effort definition, press @kbd{?} as the operator.
8094 Org also supports automatic, context-aware tag filtering. If the variable
8095 @code{org-agenda-auto-exclude-function} is set to a user-defined function,
8096 that function can decide which tags should be excluded from the agenda
8097 automatically. Once this is set, the @kbd{/} command then accepts @kbd{RET}
8098 as a sub-option key and runs the auto exclusion logic. For example, let's
8099 say you use a @code{Net} tag to identify tasks which need network access, an
8100 @code{Errand} tag for errands in town, and a @code{Call} tag for making phone
8101 calls. You could auto-exclude these tags based on the availability of the
8102 Internet, and outside of business hours, with something like this:
8106 (defun org-my-auto-exclude-function (tag)
8108 ((string= tag "Net")
8109 (/= 0 (call-process "/sbin/ping" nil nil nil
8110 "-c1" "-q" "-t1" "mail.gnu.org")))
8111 ((or (string= tag "Errand") (string= tag "Call"))
8112 (let ((hour (nth 2 (decode-time))))
8113 (or (< hour 8) (> hour 21)))))
8116 (setq org-agenda-auto-exclude-function 'org-my-auto-exclude-function)
8120 @orgcmd{\\,org-agenda-filter-by-tag-refine}
8121 Narrow the current agenda filter by an additional condition. When called with
8122 prefix arg, remove the entries that @emph{do} have the tag, or that do match
8123 the effort criterion. You can achieve the same effect by pressing @kbd{+} or
8124 @kbd{-} as the first key after the @kbd{/} command.
8133 @item @r{in} search view
8134 add new search words (@kbd{[} and @kbd{]}) or new regular expressions
8135 (@kbd{@{} and @kbd{@}}) to the query string. The opening bracket/brace will
8136 add a positive search term prefixed by @samp{+}, indicating that this search
8137 term @i{must} occur/match in the entry. The closing bracket/brace will add a
8138 negative search term which @i{must not} occur/match in the entry for it to be
8142 @tsubheading{Remote editing}
8143 @cindex remote editing, from agenda
8148 @cindex undoing remote-editing events
8149 @cindex remote editing, undo
8150 @orgcmd{C-_,org-agenda-undo}
8151 Undo a change due to a remote editing command. The change is undone
8152 both in the agenda buffer and in the remote buffer.
8154 @orgcmd{t,org-agenda-todo}
8155 Change the TODO state of the item, both in the agenda and in the
8158 @orgcmd{C-S-@key{right},org-agenda-todo-nextset}
8159 @orgcmd{C-S-@key{left},org-agenda-todo-previousset}
8160 Switch to the next/previous set of TODO keywords.
8162 @orgcmd{C-k,org-agenda-kill}
8163 @vindex org-agenda-confirm-kill
8164 Delete the current agenda item along with the entire subtree belonging
8165 to it in the original Org file. If the text to be deleted remotely
8166 is longer than one line, the kill needs to be confirmed by the user. See
8167 variable @code{org-agenda-confirm-kill}.
8169 @orgcmd{C-c C-w,org-agenda-refile}
8170 Refile the entry at point.
8172 @orgcmdkskc{C-c C-x C-a,a,org-agenda-archive-default-with-confirmation}
8173 @vindex org-archive-default-command
8174 Archive the subtree corresponding to the entry at point using the default
8175 archiving command set in @code{org-archive-default-command}. When using the
8176 @code{a} key, confirmation will be required.
8178 @orgcmd{C-c C-x a,org-agenda-toggle-archive-tag}
8179 Toggle the ARCHIVE tag for the current headline.
8181 @orgcmd{C-c C-x A,org-agenda-archive-to-archive-sibling}
8182 Move the subtree corresponding to the current entry to its @emph{archive
8185 @orgcmdkskc{C-c C-x C-s,$,org-agenda-archive}
8186 Archive the subtree corresponding to the current headline. This means the
8187 entry will be moved to the configured archive location, most likely a
8190 @orgcmd{T,org-agenda-show-tags}
8191 @vindex org-agenda-show-inherited-tags
8192 Show all tags associated with the current item. This is useful if you have
8193 turned off @code{org-agenda-show-inherited-tags}, but still want to see all
8194 tags of a headline occasionally.
8196 @orgcmd{:,org-agenda-set-tags}
8197 Set tags for the current headline. If there is an active region in the
8198 agenda, change a tag for all headings in the region.
8202 Set the priority for the current item (@command{org-agenda-priority}).
8203 Org mode prompts for the priority character. If you reply with @key{SPC},
8204 the priority cookie is removed from the entry.
8206 @orgcmd{P,org-agenda-show-priority}
8207 Display weighted priority of current item.
8209 @orgcmdkkc{+,S-@key{up},org-agenda-priority-up}
8210 Increase the priority of the current item. The priority is changed in
8211 the original buffer, but the agenda is not resorted. Use the @kbd{r}
8214 @orgcmdkkc{-,S-@key{down},org-agenda-priority-down}
8215 Decrease the priority of the current item.
8217 @orgcmdkkc{z,C-c C-z,org-agenda-add-note}
8218 @vindex org-log-into-drawer
8219 Add a note to the entry. This note will be recorded, and then filed to the
8220 same location where state change notes are put. Depending on
8221 @code{org-log-into-drawer}, this may be inside a drawer.
8223 @orgcmd{C-c C-a,org-attach}
8224 Dispatcher for all command related to attachments.
8226 @orgcmd{C-c C-s,org-agenda-schedule}
8227 Schedule this item. With prefix arg remove the scheduling timestamp
8229 @orgcmd{C-c C-d,org-agenda-deadline}
8230 Set a deadline for this item. With prefix arg remove the deadline.
8232 @orgcmd{k,org-agenda-action}
8233 Agenda actions, to set dates for selected items to the cursor date.
8234 This command also works in the calendar! The command prompts for an
8237 m @r{Mark the entry at point for action. You can also make entries}
8238 @r{in Org files with @kbd{C-c C-x C-k}.}
8239 d @r{Set the deadline of the marked entry to the date at point.}
8240 s @r{Schedule the marked entry at the date at point.}
8241 r @r{Call @code{org-capture} with the cursor date as default date.}
8244 Press @kbd{r} afterward to refresh the agenda and see the effect of the
8247 @orgcmd{S-@key{right},org-agenda-do-date-later}
8248 Change the timestamp associated with the current line by one day into the
8249 future. If the date is in the past, the first call to this command will move
8251 With a numeric prefix argument, change it by that many days. For example,
8252 @kbd{3 6 5 S-@key{right}} will change it by a year. With a @kbd{C-u} prefix,
8253 change the time by one hour. If you immediately repeat the command, it will
8254 continue to change hours even without the prefix arg. With a double @kbd{C-u
8255 C-u} prefix, do the same for changing minutes.@*
8256 The stamp is changed in the original Org file, but the change is not directly
8257 reflected in the agenda buffer. Use @kbd{r} or @kbd{g} to update the buffer.
8259 @orgcmd{S-@key{left},org-agenda-do-date-earlier}
8260 Change the timestamp associated with the current line by one day
8263 @orgcmd{>,org-agenda-date-prompt}
8264 Change the timestamp associated with the current line. The key @kbd{>} has
8265 been chosen, because it is the same as @kbd{S-.} on my keyboard.
8267 @orgcmd{I,org-agenda-clock-in}
8268 Start the clock on the current item. If a clock is running already, it
8271 @orgcmd{O,org-agenda-clock-out}
8272 Stop the previously started clock.
8274 @orgcmd{X,org-agenda-clock-cancel}
8275 Cancel the currently running clock.
8277 @orgcmd{J,org-agenda-clock-goto}
8278 Jump to the running clock in another window.
8280 @tsubheading{Bulk remote editing selected entries}
8281 @cindex remote editing, bulk, from agenda
8283 @orgcmd{m,org-agenda-bulk-mark}
8284 Mark the entry at point for bulk action. With prefix arg, mark that many
8287 @orgcmd{%,org-agenda-bulk-mark-regexp}
8288 Mark entries matching a regular expression for bulk action.
8290 @orgcmd{u,org-agenda-bulk-unmark}
8291 Unmark entry for bulk action.
8293 @orgcmd{U,org-agenda-bulk-remove-all-marks}
8294 Unmark all marked entries for bulk action.
8296 @orgcmd{B,org-agenda-bulk-action}
8297 Bulk action: act on all marked entries in the agenda. This will prompt for
8298 another key to select the action to be applied. The prefix arg to @kbd{B}
8299 will be passed through to the @kbd{s} and @kbd{d} commands, to bulk-remove
8300 these special timestamps.
8302 r @r{Prompt for a single refile target and move all entries. The entries}
8303 @r{will no longer be in the agenda; refresh (@kbd{g}) to bring them back.}
8304 $ @r{Archive all selected entries.}
8305 A @r{Archive entries by moving them to their respective archive siblings.}
8306 t @r{Change TODO state. This prompts for a single TODO keyword and}
8307 @r{changes the state of all selected entries, bypassing blocking and}
8308 @r{suppressing logging notes (but not timestamps).}
8309 + @r{Add a tag to all selected entries.}
8310 - @r{Remove a tag from all selected entries.}
8311 s @r{Schedule all items to a new date. To shift existing schedule dates}
8312 @r{by a fixed number of days, use something starting with double plus}
8313 @r{at the prompt, for example @samp{++8d} or @samp{++2w}.}
8314 S @r{Reschedule randomly into the coming N days. N will be prompted for.}
8315 @r{With prefix arg (@kbd{C-u B S}), scatter only across weekdays.}
8316 d @r{Set deadline to a specific date.}
8317 f @r{Apply a function to marked entries.}
8318 @r{For example, the function below sets the CATEGORY property of the}
8320 @r{(defun set-category ()}
8321 @r{ (interactive "P")}
8322 @r{ (let* ((marker (or (org-get-at-bol 'org-hd-marker)}
8323 @r{ (org-agenda-error)))}
8324 @r{ (buffer (marker-buffer marker)))}
8325 @r{ (with-current-buffer buffer}
8326 @r{ (save-excursion}
8327 @r{ (save-restriction}
8329 @r{ (goto-char marker)}
8330 @r{ (org-back-to-heading t)}
8331 @r{ (org-set-property "CATEGORY" "web"))))))}
8335 @tsubheading{Calendar commands}
8336 @cindex calendar commands, from agenda
8338 @orgcmd{c,org-agenda-goto-calendar}
8339 Open the Emacs calendar and move to the date at the agenda cursor.
8341 @orgcmd{c,org-calendar-goto-agenda}
8342 When in the calendar, compute and show the Org mode agenda for the
8345 @cindex diary entries, creating from agenda
8346 @orgcmd{i,org-agenda-diary-entry}
8347 @vindex org-agenda-diary-file
8348 Insert a new entry into the diary, using the date at the cursor and (for
8349 block entries) the date at the mark. This will add to the Emacs diary
8350 file@footnote{This file is parsed for the agenda when
8351 @code{org-agenda-include-diary} is set.}, in a way similar to the @kbd{i}
8352 command in the calendar. The diary file will pop up in another window, where
8353 you can add the entry.
8355 If you configure @code{org-agenda-diary-file} to point to an Org mode file,
8356 Org will create entries (in Org mode syntax) in that file instead. Most
8357 entries will be stored in a date-based outline tree that will later make it
8358 easy to archive appointments from previous months/years. The tree will be
8359 built under an entry with a @code{DATE_TREE} property, or else with years as
8360 top-level entries. Emacs will prompt you for the entry text---if you specify
8361 it, the entry will be created in @code{org-agenda-diary-file} without further
8362 interaction. If you directly press @key{RET} at the prompt without typing
8363 text, the target file will be shown in another window for you to finish the
8364 entry there. See also the @kbd{k r} command.
8366 @orgcmd{M,org-agenda-phases-of-moon}
8367 Show the phases of the moon for the three months around current date.
8369 @orgcmd{S,org-agenda-sunrise-sunset}
8370 Show sunrise and sunset times. The geographical location must be set
8371 with calendar variables, see the documentation for the Emacs calendar.
8373 @orgcmd{C,org-agenda-convert-date}
8374 Convert the date at cursor into many other cultural and historic
8377 @orgcmd{H,org-agenda-holidays}
8378 Show holidays for three months around the cursor date.
8380 @item M-x org-export-icalendar-combine-agenda-files
8381 Export a single iCalendar file containing entries from all agenda files.
8382 This is a globally available command, and also available in the agenda menu.
8384 @tsubheading{Exporting to a file}
8385 @orgcmd{C-x C-w,org-write-agenda}
8386 @cindex exporting agenda views
8387 @cindex agenda views, exporting
8388 @vindex org-agenda-exporter-settings
8389 Write the agenda view to a file. Depending on the extension of the selected
8390 file name, the view will be exported as HTML (extension @file{.html} or
8391 @file{.htm}), Postscript (extension @file{.ps}), PDF (extension @file{.pdf}),
8392 and plain text (any other extension). When called with a @kbd{C-u} prefix
8393 argument, immediately open the newly created file. Use the variable
8394 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
8395 for @file{htmlize} to be used during export.
8397 @tsubheading{Quit and Exit}
8398 @orgcmd{q,org-agenda-quit}
8399 Quit agenda, remove the agenda buffer.
8401 @cindex agenda files, removing buffers
8402 @orgcmd{x,org-agenda-exit}
8403 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
8404 for the compilation of the agenda. Buffers created by the user to
8405 visit Org files will not be removed.
8409 @node Custom agenda views, Exporting Agenda Views, Agenda commands, Agenda Views
8410 @section Custom agenda views
8411 @cindex custom agenda views
8412 @cindex agenda views, custom
8414 Custom agenda commands serve two purposes: to store and quickly access
8415 frequently used TODO and tags searches, and to create special composite
8416 agenda buffers. Custom agenda commands will be accessible through the
8417 dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
8420 * Storing searches:: Type once, use often
8421 * Block agenda:: All the stuff you need in a single buffer
8422 * Setting Options:: Changing the rules
8425 @node Storing searches, Block agenda, Custom agenda views, Custom agenda views
8426 @subsection Storing searches
8428 The first application of custom searches is the definition of keyboard
8429 shortcuts for frequently used searches, either creating an agenda
8430 buffer, or a sparse tree (the latter covering of course only the current
8433 @vindex org-agenda-custom-commands
8434 Custom commands are configured in the variable
8435 @code{org-agenda-custom-commands}. You can customize this variable, for
8436 example by pressing @kbd{C-c a C}. You can also directly set it with
8437 Emacs Lisp in @file{.emacs}. The following example contains all valid
8442 (setq org-agenda-custom-commands
8443 '(("w" todo "WAITING")
8444 ("W" todo-tree "WAITING")
8445 ("u" tags "+boss-urgent")
8446 ("v" tags-todo "+boss-urgent")
8447 ("U" tags-tree "+boss-urgent")
8448 ("f" occur-tree "\\<FIXME\\>")
8449 ("h" . "HOME+Name tags searches") ; description for "h" prefix
8450 ("hl" tags "+home+Lisa")
8451 ("hp" tags "+home+Peter")
8452 ("hk" tags "+home+Kim")))
8457 The initial string in each entry defines the keys you have to press
8458 after the dispatcher command @kbd{C-c a} in order to access the command.
8459 Usually this will be just a single character, but if you have many
8460 similar commands, you can also define two-letter combinations where the
8461 first character is the same in several combinations and serves as a
8462 prefix key@footnote{You can provide a description for a prefix key by
8463 inserting a cons cell with the prefix and the description.}. The second
8464 parameter is the search type, followed by the string or regular
8465 expression to be used for the matching. The example above will
8470 as a global search for TODO entries with @samp{WAITING} as the TODO
8473 as the same search, but only in the current buffer and displaying the
8474 results as a sparse tree
8476 as a global tags search for headlines marked @samp{:boss:} but not
8479 as the same search as @kbd{C-c a u}, but limiting the search to
8480 headlines that are also TODO items
8482 as the same search as @kbd{C-c a u}, but only in the current buffer and
8483 displaying the result as a sparse tree
8485 to create a sparse tree (again: current buffer only) with all entries
8486 containing the word @samp{FIXME}
8488 as a prefix command for a HOME tags search where you have to press an
8489 additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
8490 Peter, or Kim) as additional tag to match.
8493 @node Block agenda, Setting Options, Storing searches, Custom agenda views
8494 @subsection Block agenda
8495 @cindex block agenda
8496 @cindex agenda, with block views
8498 Another possibility is the construction of agenda views that comprise
8499 the results of @emph{several} commands, each of which creates a block in
8500 the agenda buffer. The available commands include @code{agenda} for the
8501 daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
8502 for the global TODO list (as constructed with @kbd{C-c a t}), and the
8503 matching commands discussed above: @code{todo}, @code{tags}, and
8504 @code{tags-todo}. Here are two examples:
8508 (setq org-agenda-custom-commands
8509 '(("h" "Agenda and Home-related tasks"
8513 ("o" "Agenda and Office-related tasks"
8521 This will define @kbd{C-c a h} to create a multi-block view for stuff
8522 you need to attend to at home. The resulting agenda buffer will contain
8523 your agenda for the current week, all TODO items that carry the tag
8524 @samp{home}, and also all lines tagged with @samp{garden}. Finally the
8525 command @kbd{C-c a o} provides a similar view for office tasks.
8527 @node Setting Options, , Block agenda, Custom agenda views
8528 @subsection Setting options for custom commands
8529 @cindex options, for custom agenda views
8531 @vindex org-agenda-custom-commands
8532 Org mode contains a number of variables regulating agenda construction
8533 and display. The global variables define the behavior for all agenda
8534 commands, including the custom commands. However, if you want to change
8535 some settings just for a single custom view, you can do so. Setting
8536 options requires inserting a list of variable names and values at the
8537 right spot in @code{org-agenda-custom-commands}. For example:
8541 (setq org-agenda-custom-commands
8542 '(("w" todo "WAITING"
8543 ((org-agenda-sorting-strategy '(priority-down))
8544 (org-agenda-prefix-format " Mixed: ")))
8545 ("U" tags-tree "+boss-urgent"
8546 ((org-show-following-heading nil)
8547 (org-show-hierarchy-above nil)))
8549 ((org-agenda-files '("~org/notes.org"))
8550 (org-agenda-text-search-extra-files nil)))))
8555 Now the @kbd{C-c a w} command will sort the collected entries only by
8556 priority, and the prefix format is modified to just say @samp{ Mixed: }
8557 instead of giving the category of the entry. The sparse tags tree of
8558 @kbd{C-c a U} will now turn out ultra-compact, because neither the
8559 headline hierarchy above the match, nor the headline following the match
8560 will be shown. The command @kbd{C-c a N} will do a text search limited
8561 to only a single file.
8563 @vindex org-agenda-custom-commands
8564 For command sets creating a block agenda,
8565 @code{org-agenda-custom-commands} has two separate spots for setting
8566 options. You can add options that should be valid for just a single
8567 command in the set, and options that should be valid for all commands in
8568 the set. The former are just added to the command entry; the latter
8569 must come after the list of command entries. Going back to the block
8570 agenda example (@pxref{Block agenda}), let's change the sorting strategy
8571 for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
8572 the results for GARDEN tags query in the opposite order,
8573 @code{priority-up}. This would look like this:
8577 (setq org-agenda-custom-commands
8578 '(("h" "Agenda and Home-related tasks"
8582 ((org-agenda-sorting-strategy '(priority-up)))))
8583 ((org-agenda-sorting-strategy '(priority-down))))
8584 ("o" "Agenda and Office-related tasks"
8591 As you see, the values and parentheses setting is a little complex.
8592 When in doubt, use the customize interface to set this variable---it
8593 fully supports its structure. Just one caveat: when setting options in
8594 this interface, the @emph{values} are just Lisp expressions. So if the
8595 value is a string, you need to add the double-quotes around the value
8599 @node Exporting Agenda Views, Agenda column view, Custom agenda views, Agenda Views
8600 @section Exporting Agenda Views
8601 @cindex agenda views, exporting
8603 If you are away from your computer, it can be very useful to have a printed
8604 version of some agenda views to carry around. Org mode can export custom
8605 agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's
8606 @file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the
8607 ghostscript @file{ps2pdf} utility must be installed on the system. Selecting
8608 a PDF file will also create the postscript file.}, and iCalendar files. If
8609 you want to do this only occasionally, use the command
8612 @orgcmd{C-x C-w,org-write-agenda}
8613 @cindex exporting agenda views
8614 @cindex agenda views, exporting
8615 @vindex org-agenda-exporter-settings
8616 Write the agenda view to a file. Depending on the extension of the selected
8617 file name, the view will be exported as HTML (extension @file{.html} or
8618 @file{.htm}), Postscript (extension @file{.ps}), iCalendar (extension
8619 @file{.ics}), or plain text (any other extension). Use the variable
8620 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
8621 for @file{htmlize} to be used during export, for example
8623 @vindex org-agenda-add-entry-text-maxlines
8624 @vindex htmlize-output-type
8625 @vindex ps-number-of-columns
8626 @vindex ps-landscape-mode
8628 (setq org-agenda-exporter-settings
8629 '((ps-number-of-columns 2)
8630 (ps-landscape-mode t)
8631 (org-agenda-add-entry-text-maxlines 5)
8632 (htmlize-output-type 'css)))
8636 If you need to export certain agenda views frequently, you can associate
8637 any custom agenda command with a list of output file names
8638 @footnote{If you want to store standard views like the weekly agenda
8639 or the global TODO list as well, you need to define custom commands for
8640 them in order to be able to specify file names.}. Here is an example
8641 that first defines custom commands for the agenda and the global
8642 TODO list, together with a number of files to which to export them.
8643 Then we define two block agenda commands and specify file names for them
8644 as well. File names can be relative to the current working directory,
8649 (setq org-agenda-custom-commands
8650 '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
8651 ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
8652 ("h" "Agenda and Home-related tasks"
8657 ("~/views/home.html"))
8658 ("o" "Agenda and Office-related tasks"
8663 ("~/views/office.ps" "~/calendars/office.ics"))))
8667 The extension of the file name determines the type of export. If it is
8668 @file{.html}, Org mode will use the @file{htmlize.el} package to convert
8669 the buffer to HTML and save it to this file name. If the extension is
8670 @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
8671 Postscript output. If the extension is @file{.ics}, iCalendar export is
8672 run export over all files that were used to construct the agenda, and
8673 limit the export to entries listed in the agenda. Any other
8674 extension produces a plain ASCII file.
8676 The export files are @emph{not} created when you use one of those
8677 commands interactively because this might use too much overhead.
8678 Instead, there is a special command to produce @emph{all} specified
8682 @orgcmd{C-c a e,org-store-agenda-views}
8683 Export all agenda views that have export file names associated with
8687 You can use the options section of the custom agenda commands to also
8688 set options for the export commands. For example:
8691 (setq org-agenda-custom-commands
8693 ((ps-number-of-columns 2)
8694 (ps-landscape-mode t)
8695 (org-agenda-prefix-format " [ ] ")
8696 (org-agenda-with-colors nil)
8697 (org-agenda-remove-tags t))
8702 This command sets two options for the Postscript exporter, to make it
8703 print in two columns in landscape format---the resulting page can be cut
8704 in two and then used in a paper agenda. The remaining settings modify
8705 the agenda prefix to omit category and scheduling information, and
8706 instead include a checkbox to check off items. We also remove the tags
8707 to make the lines compact, and we don't want to use colors for the
8708 black-and-white printer. Settings specified in
8709 @code{org-agenda-exporter-settings} will also apply, but the settings
8710 in @code{org-agenda-custom-commands} take precedence.
8713 From the command line you may also use
8715 emacs -eval (org-batch-store-agenda-views) -kill
8718 or, if you need to modify some parameters@footnote{Quoting depends on the
8719 system you use, please check the FAQ for examples.}
8721 emacs -eval '(org-batch-store-agenda-views \
8722 org-agenda-span (quote month) \
8723 org-agenda-start-day "2007-11-01" \
8724 org-agenda-include-diary nil \
8725 org-agenda-files (quote ("~/org/project.org")))' \
8729 which will create the agenda views restricted to the file
8730 @file{~/org/project.org}, without diary entries and with a 30-day
8733 You can also extract agenda information in a way that allows further
8734 processing by other programs. See @ref{Extracting agenda information}, for
8738 @node Agenda column view, , Exporting Agenda Views, Agenda Views
8739 @section Using column view in the agenda
8740 @cindex column view, in agenda
8741 @cindex agenda, column view
8743 Column view (@pxref{Column view}) is normally used to view and edit
8744 properties embedded in the hierarchical structure of an Org file. It can be
8745 quite useful to use column view also from the agenda, where entries are
8746 collected by certain criteria.
8749 @orgcmd{C-c C-x C-c,org-agenda-columns}
8750 Turn on column view in the agenda.
8753 To understand how to use this properly, it is important to realize that the
8754 entries in the agenda are no longer in their proper outline environment.
8755 This causes the following issues:
8759 @vindex org-columns-default-format
8760 @vindex org-overriding-columns-format
8761 Org needs to make a decision which @code{COLUMNS} format to use. Since the
8762 entries in the agenda are collected from different files, and different files
8763 may have different @code{COLUMNS} formats, this is a non-trivial problem.
8764 Org first checks if the variable @code{org-agenda-overriding-columns-format} is
8765 currently set, and if so, takes the format from there. Otherwise it takes
8766 the format associated with the first item in the agenda, or, if that item
8767 does not have a specific format (defined in a property, or in its file), it
8768 uses @code{org-columns-default-format}.
8770 @cindex property, special, CLOCKSUM
8771 If any of the columns has a summary type defined (@pxref{Column attributes}),
8772 turning on column view in the agenda will visit all relevant agenda files and
8773 make sure that the computations of this property are up to date. This is
8774 also true for the special @code{CLOCKSUM} property. Org will then sum the
8775 values displayed in the agenda. In the daily/weekly agenda, the sums will
8776 cover a single day; in all other views they cover the entire block. It is
8777 vital to realize that the agenda may show the same entry @emph{twice} (for
8778 example as scheduled and as a deadline), and it may show two entries from the
8779 same hierarchy (for example a @emph{parent} and its @emph{child}). In these
8780 cases, the summation in the agenda will lead to incorrect results because
8781 some values will count double.
8783 When the column view in the agenda shows the @code{CLOCKSUM}, that is always
8784 the entire clocked time for this item. So even in the daily/weekly agenda,
8785 the clocksum listed in column view may originate from times outside the
8786 current view. This has the advantage that you can compare these values with
8787 a column listing the planned total effort for a task---one of the major
8788 applications for column view in the agenda. If you want information about
8789 clocked time in the displayed period use clock table mode (press @kbd{R} in
8794 @node Markup, Exporting, Agenda Views, Top
8795 @chapter Markup for rich export
8797 When exporting Org mode documents, the exporter tries to reflect the
8798 structure of the document as accurately as possible in the backend. Since
8799 export targets like HTML, @LaTeX{}, or DocBook allow much richer formatting,
8800 Org mode has rules on how to prepare text for rich export. This section
8801 summarizes the markup rules used in an Org mode buffer.
8804 * Structural markup elements:: The basic structure as seen by the exporter
8805 * Images and tables:: Tables and Images will be included
8806 * Literal examples:: Source code examples with special formatting
8807 * Include files:: Include additional files into a document
8808 * Index entries:: Making an index
8809 * Macro replacement:: Use macros to create complex output
8810 * Embedded @LaTeX{}:: LaTeX can be freely used inside Org documents
8813 @node Structural markup elements, Images and tables, Markup, Markup
8814 @section Structural markup elements
8817 * Document title:: Where the title is taken from
8818 * Headings and sections:: The document structure as seen by the exporter
8819 * Table of contents:: The if and where of the table of contents
8820 * Initial text:: Text before the first heading?
8822 * Paragraphs:: Paragraphs
8823 * Footnote markup:: Footnotes
8824 * Emphasis and monospace:: Bold, italic, etc.
8825 * Horizontal rules:: Make a line
8826 * Comment lines:: What will *not* be exported
8829 @node Document title, Headings and sections, Structural markup elements, Structural markup elements
8830 @subheading Document title
8831 @cindex document title, markup rules
8834 The title of the exported document is taken from the special line
8838 #+TITLE: This is the title of the document
8842 If this line does not exist, the title is derived from the first non-empty,
8843 non-comment line in the buffer. If no such line exists, or if you have
8844 turned off exporting of the text before the first headline (see below), the
8845 title will be the file name without extension.
8847 @cindex property, EXPORT_TITLE
8848 If you are exporting only a subtree by marking is as the region, the heading
8849 of the subtree will become the title of the document. If the subtree has a
8850 property @code{EXPORT_TITLE}, that will take precedence.
8852 @node Headings and sections, Table of contents, Document title, Structural markup elements
8853 @subheading Headings and sections
8854 @cindex headings and sections, markup rules
8856 @vindex org-export-headline-levels
8857 The outline structure of the document as described in @ref{Document
8858 Structure}, forms the basis for defining sections of the exported document.
8859 However, since the outline structure is also used for (for example) lists of
8860 tasks, only the first three outline levels will be used as headings. Deeper
8861 levels will become itemized lists. You can change the location of this
8862 switch globally by setting the variable @code{org-export-headline-levels}, or on a
8863 per-file basis with a line
8870 @node Table of contents, Initial text, Headings and sections, Structural markup elements
8871 @subheading Table of contents
8872 @cindex table of contents, markup rules
8874 @vindex org-export-with-toc
8875 The table of contents is normally inserted directly before the first headline
8876 of the file. If you would like to get it to a different location, insert the
8877 string @code{[TABLE-OF-CONTENTS]} on a line by itself at the desired
8878 location. The depth of the table of contents is by default the same as the
8879 number of headline levels, but you can choose a smaller number, or turn off
8880 the table of contents entirely, by configuring the variable
8881 @code{org-export-with-toc}, or on a per-file basis with a line like
8884 #+OPTIONS: toc:2 (only to two levels in TOC)
8885 #+OPTIONS: toc:nil (no TOC at all)
8888 @node Initial text, Lists, Table of contents, Structural markup elements
8889 @subheading Text before the first headline
8890 @cindex text before first headline, markup rules
8893 Org mode normally exports the text before the first headline, and even uses
8894 the first line as the document title. The text will be fully marked up. If
8895 you need to include literal HTML, @LaTeX{}, or DocBook code, use the special
8896 constructs described below in the sections for the individual exporters.
8898 @vindex org-export-skip-text-before-1st-heading
8899 Some people like to use the space before the first headline for setup and
8900 internal links and therefore would like to control the exported text before
8901 the first headline in a different way. You can do so by setting the variable
8902 @code{org-export-skip-text-before-1st-heading} to @code{t}. On a per-file
8903 basis, you can get the same effect with @samp{#+OPTIONS: skip:t}.
8906 If you still want to have some text before the first headline, use the
8907 @code{#+TEXT} construct:
8911 #+TEXT: This text will go before the *first* headline.
8912 #+TEXT: [TABLE-OF-CONTENTS]
8913 #+TEXT: This goes between the table of contents and the *first* headline
8916 @node Lists, Paragraphs, Initial text, Structural markup elements
8918 @cindex lists, markup rules
8920 Plain lists as described in @ref{Plain lists}, are translated to the backend's
8921 syntax for such lists. Most backends support unordered, ordered, and
8924 @node Paragraphs, Footnote markup, Lists, Structural markup elements
8925 @subheading Paragraphs, line breaks, and quoting
8926 @cindex paragraphs, markup rules
8928 Paragraphs are separated by at least one empty line. If you need to enforce
8929 a line break within a paragraph, use @samp{\\} at the end of a line.
8931 To keep the line breaks in a region, but otherwise use normal formatting, you
8932 can use this construct, which can also be used to format poetry.
8934 @cindex #+BEGIN_VERSE
8937 Great clouds overhead
8938 Tiny black birds rise and fall
8945 When quoting a passage from another document, it is customary to format this
8946 as a paragraph that is indented on both the left and the right margin. You
8947 can include quotations in Org mode documents like this:
8949 @cindex #+BEGIN_QUOTE
8952 Everything should be made as simple as possible,
8953 but not any simpler -- Albert Einstein
8957 If you would like to center some text, do it like this:
8958 @cindex #+BEGIN_CENTER
8961 Everything should be made as simple as possible, \\
8967 @node Footnote markup, Emphasis and monospace, Paragraphs, Structural markup elements
8968 @subheading Footnote markup
8969 @cindex footnotes, markup rules
8970 @cindex @file{footnote.el}
8972 Footnotes defined in the way described in @ref{Footnotes}, will be exported
8973 by all backends. Org allows multiple references to the same note, and
8974 multiple footnotes side by side.
8976 @node Emphasis and monospace, Horizontal rules, Footnote markup, Structural markup elements
8977 @subheading Emphasis and monospace
8979 @cindex underlined text, markup rules
8980 @cindex bold text, markup rules
8981 @cindex italic text, markup rules
8982 @cindex verbatim text, markup rules
8983 @cindex code text, markup rules
8984 @cindex strike-through text, markup rules
8985 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=}
8986 and @code{~verbatim~}, and, if you must, @samp{+strike-through+}. Text
8987 in the code and verbatim string is not processed for Org mode specific
8988 syntax; it is exported verbatim.
8990 @node Horizontal rules, Comment lines, Emphasis and monospace, Structural markup elements
8991 @subheading Horizontal rules
8992 @cindex horizontal rules, markup rules
8993 A line consisting of only dashes, and at least 5 of them, will be exported as
8994 a horizontal line (@samp{<hr/>} in HTML and @code{\hrule} in @LaTeX{}).
8996 @node Comment lines, , Horizontal rules, Structural markup elements
8997 @subheading Comment lines
8998 @cindex comment lines
8999 @cindex exporting, not
9000 @cindex #+BEGIN_COMMENT
9002 Lines starting with @samp{#} in column zero are treated as comments and will
9003 never be exported. If you want an indented line to be treated as a comment,
9004 start it with @samp{#+ }. Also entire subtrees starting with the word
9005 @samp{COMMENT} will never be exported. Finally, regions surrounded by
9006 @samp{#+BEGIN_COMMENT} ... @samp{#+END_COMMENT} will not be exported.
9011 Toggle the COMMENT keyword at the beginning of an entry.
9015 @node Images and tables, Literal examples, Structural markup elements, Markup
9016 @section Images and Tables
9018 @cindex tables, markup rules
9021 Both the native Org mode tables (@pxref{Tables}) and tables formatted with
9022 the @file{table.el} package will be exported properly. For Org mode tables,
9023 the lines before the first horizontal separator line will become table header
9024 lines. You can use the following lines somewhere before the table to assign
9025 a caption and a label for cross references, and in the text you can refer to
9026 the object with @code{\ref@{tab:basic-data@}}:
9029 #+CAPTION: This is the caption for the next table (or link)
9030 #+LABEL: tbl:basic-data
9035 Optionally, the caption can take the form:
9037 #+CAPTION: [Caption for list of figures]@{Caption for table (or link).@}
9040 @cindex inlined images, markup rules
9041 Some backends (HTML, @LaTeX{}, and DocBook) allow you to directly include
9042 images into the exported document. Org does this, if a link to an image
9043 files does not have a description part, for example @code{[[./img/a.jpg]]}.
9044 If you wish to define a caption for the image and maybe a label for internal
9045 cross references, make sure that the link is on a line by itself and precede
9046 it with @code{#+CAPTION} and @code{#+LABEL} as follows:
9049 #+CAPTION: This is the caption for the next figure link (or table)
9050 #+LABEL: fig:SED-HR4049
9054 You may also define additional attributes for the figure. As this is
9055 backend-specific, see the sections about the individual backends for more
9058 @xref{Handling links,the discussion of image links}.
9060 @node Literal examples, Include files, Images and tables, Markup
9061 @section Literal examples
9062 @cindex literal examples, markup rules
9063 @cindex code line references, markup rules
9065 You can include literal examples that should not be subjected to
9066 markup. Such examples will be typeset in monospace, so this is well suited
9067 for source code and similar examples.
9068 @cindex #+BEGIN_EXAMPLE
9072 Some example from a text file.
9076 Note that such blocks may be @i{indented} in order to align nicely with
9077 indented text and in particular with plain list structure (@pxref{Plain
9078 lists}). For simplicity when using small examples, you can also start the
9079 example lines with a colon followed by a space. There may also be additional
9080 whitespace before the colon:
9084 : Some example from a text file.
9087 @cindex formatting source code, markup rules
9088 If the example is source code from a programming language, or any other text
9089 that can be marked up by font-lock in Emacs, you can ask for the example to
9090 look like the fontified Emacs buffer@footnote{This works automatically for
9091 the HTML backend (it requires version 1.34 of the @file{htmlize.el} package,
9092 which is distributed with Org). Fontified code chunks in @LaTeX{} can be
9093 achieved using either the listings or the
9094 @url{http://code.google.com/p/minted, minted,} package. To use listings, turn
9095 on the variable @code{org-export-latex-listings} and ensure that the listings
9096 package is included by the @LaTeX{} header (e.g.@: by configuring
9097 @code{org-export-latex-packages-alist}). See the listings documentation for
9098 configuration options, including obtaining colored output. For minted it is
9099 necessary to install the program @url{http://pygments.org, pygments}, in
9100 addition to setting @code{org-export-latex-minted}, ensuring that the minted
9101 package is included by the @LaTeX{} header, and ensuring that the
9102 @code{-shell-escape} option is passed to @file{pdflatex} (see
9103 @code{org-latex-to-pdf-process}). See the documentation of the variables
9104 @code{org-export-latex-listings} and @code{org-export-latex-minted} for
9105 further details.}. This is done with the @samp{src} block, where you also
9106 need to specify the name of the major mode that should be used to fontify the
9107 example@footnote{Code in @samp{src} blocks may also be evaluated either
9108 interactively or on export. See @pxref{Working With Source Code} for more
9109 information on evaluating code blocks.}, see @ref{Easy Templates} for
9110 shortcuts to easily insert code blocks.
9114 #+BEGIN_SRC emacs-lisp
9115 (defun org-xor (a b)
9121 Both in @code{example} and in @code{src} snippets, you can add a @code{-n}
9122 switch to the end of the @code{BEGIN} line, to get the lines of the example
9123 numbered. If you use a @code{+n} switch, the numbering from the previous
9124 numbered snippet will be continued in the current one. In literal examples,
9125 Org will interpret strings like @samp{(ref:name)} as labels, and use them as
9126 targets for special hyperlinks like @code{[[(name)]]} (i.e.@: the reference name
9127 enclosed in single parenthesis). In HTML, hovering the mouse over such a
9128 link will remote-highlight the corresponding code line, which is kind of
9131 You can also add a @code{-r} switch which @i{removes} the labels from the
9132 source code@footnote{Adding @code{-k} to @code{-n -r} will @i{keep} the
9133 labels in the source code while using line numbers for the links, which might
9134 be useful to explain those in an Org mode example code.}. With the @code{-n}
9135 switch, links to these references will be labeled by the line numbers from
9136 the code listing, otherwise links will use the labels with no parentheses.
9140 #+BEGIN_SRC emacs-lisp -n -r
9141 (save-excursion (ref:sc)
9142 (goto-char (point-min)) (ref:jump)
9144 In line [[(sc)]] we remember the current position. [[(jump)][Line (jump)]]
9148 @vindex org-coderef-label-format
9149 If the syntax for the label format conflicts with the language syntax, use a
9150 @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
9151 -n -r -l "((%s))"}. See also the variable @code{org-coderef-label-format}.
9153 HTML export also allows examples to be published as text areas (@pxref{Text
9154 areas in HTML export}).
9156 Because the @code{#+BEGIN_...} and @code{#+END_...} patterns need to be added
9157 so often, shortcuts are provided using the Easy Templates facility
9158 (@pxref{Easy Templates}).
9163 Edit the source code example at point in its native mode. This works by
9164 switching to a temporary buffer with the source code. You need to exit by
9165 pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*}
9166 or @samp{#} will get a comma prepended, to keep them from being interpreted
9167 by Org as outline nodes or special comments. These commas will be stripped
9168 for editing with @kbd{C-c '}, and also for export.}. The edited version will
9169 then replace the old version in the Org buffer. Fixed-width regions
9170 (where each line starts with a colon followed by a space) will be edited
9171 using @code{artist-mode}@footnote{You may select a different-mode with the
9172 variable @code{org-edit-fixed-width-region-mode}.} to allow creating ASCII
9173 drawings easily. Using this command in an empty line will create a new
9177 Calling @code{org-store-link} while editing a source code example in a
9178 temporary buffer created with @kbd{C-c '} will prompt for a label. Make sure
9179 that it is unique in the current buffer, and insert it with the proper
9180 formatting like @samp{(ref:label)} at the end of the current line. Then the
9181 label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
9185 @node Include files, Index entries, Literal examples, Markup
9186 @section Include files
9187 @cindex include files, markup rules
9189 During export, you can include the content of another file. For example, to
9190 include your @file{.emacs} file, you could use:
9194 #+INCLUDE: "~/.emacs" src emacs-lisp
9197 The optional second and third parameter are the markup (e.g.@: @samp{quote},
9198 @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the
9199 language for formatting the contents. The markup is optional; if it is not
9200 given, the text will be assumed to be in Org mode format and will be
9201 processed normally. The include line will also allow additional keyword
9202 parameters @code{:prefix1} and @code{:prefix} to specify prefixes for the
9203 first line and for each following line, @code{:minlevel} in order to get
9204 Org mode content demoted to a specified level, as well as any options
9205 accepted by the selected markup. For example, to include a file as an item,
9209 #+INCLUDE: "~/snippets/xx" :prefix1 " + " :prefix " "
9212 You can also include a portion of a file by specifying a lines range using
9213 the @code{:lines} parameter. The line at the upper end of the range will not
9214 be included. The start and/or the end of the range may be omitted to use the
9218 #+INCLUDE: "~/.emacs" :lines "5-10" @r{Include lines 5 to 10, 10 excluded}
9219 #+INCLUDE: "~/.emacs" :lines "-10" @r{Include lines 1 to 10, 10 excluded}
9220 #+INCLUDE: "~/.emacs" :lines "10-" @r{Include lines from 10 to EOF}
9226 Visit the include file at point.
9229 @node Index entries, Macro replacement, Include files, Markup
9230 @section Index entries
9231 @cindex index entries, for publishing
9233 You can specify entries that will be used for generating an index during
9234 publishing. This is done by lines starting with @code{#+INDEX}. An entry
9235 the contains an exclamation mark will create a sub item. See @ref{Generating
9236 an index} for more information.
9241 #+INDEX: Application!CV
9247 @node Macro replacement, Embedded @LaTeX{}, Index entries, Markup
9248 @section Macro replacement
9249 @cindex macro replacement, during export
9252 You can define text snippets with
9255 #+MACRO: name replacement text $1, $2 are arguments
9258 @noindent which can be referenced anywhere in the document (even in
9259 code examples) with @code{@{@{@{name(arg1,arg2)@}@}@}}. In addition to
9260 defined macros, @code{@{@{@{title@}@}@}}, @code{@{@{@{author@}@}@}}, etc.,
9261 will reference information set by the @code{#+TITLE:}, @code{#+AUTHOR:}, and
9262 similar lines. Also, @code{@{@{@{date(@var{FORMAT})@}@}@}} and
9263 @code{@{@{@{modification-time(@var{FORMAT})@}@}@}} refer to current date time
9264 and to the modification time of the file being exported, respectively.
9265 @var{FORMAT} should be a format string understood by
9266 @code{format-time-string}.
9268 Macro expansion takes place during export, and some people use it to
9269 construct complex HTML code.
9272 @node Embedded @LaTeX{}, , Macro replacement, Markup
9273 @section Embedded @LaTeX{}
9274 @cindex @TeX{} interpretation
9275 @cindex @LaTeX{} interpretation
9277 Plain ASCII is normally sufficient for almost all note taking. Exceptions
9278 include scientific notes, which often require mathematical symbols and the
9279 occasional formula. @LaTeX{}@footnote{@LaTeX{} is a macro system based on
9280 Donald E. Knuth's @TeX{} system. Many of the features described here as
9281 ``@LaTeX{}'' are really from @TeX{}, but for simplicity I am blurring this
9282 distinction.} is widely used to typeset scientific documents. Org mode
9283 supports embedding @LaTeX{} code into its files, because many academics are
9284 used to writing and reading @LaTeX{} source code, and because it can be
9285 readily processed to produce pretty output for a number of export backends.
9288 * Special symbols:: Greek letters and other symbols
9289 * Subscripts and superscripts:: Simple syntax for raising/lowering text
9290 * @LaTeX{} fragments:: Complex formulas made easy
9291 * Previewing @LaTeX{} fragments:: What will this snippet look like?
9292 * CDLaTeX mode:: Speed up entering of formulas
9295 @node Special symbols, Subscripts and superscripts, Embedded @LaTeX{}, Embedded @LaTeX{}
9296 @subsection Special symbols
9297 @cindex math symbols
9298 @cindex special symbols
9299 @cindex @TeX{} macros
9300 @cindex @LaTeX{} fragments, markup rules
9301 @cindex HTML entities
9302 @cindex @LaTeX{} entities
9304 You can use @LaTeX{} macros to insert special symbols like @samp{\alpha} to
9305 indicate the Greek letter, or @samp{\to} to indicate an arrow. Completion
9306 for these macros is available, just type @samp{\} and maybe a few letters,
9307 and press @kbd{M-@key{TAB}} to see possible completions. Unlike @LaTeX{}
9308 code, Org mode allows these macros to be present without surrounding math
9309 delimiters, for example:
9312 Angles are written as Greek letters \alpha, \beta and \gamma.
9315 @vindex org-entities
9316 During export, these symbols will be transformed into the native format of
9317 the exporter backend. Strings like @code{\alpha} will be exported as
9318 @code{α} in the HTML output, and as @code{$\alpha$} in the @LaTeX{}
9319 output. Similarly, @code{\nbsp} will become @code{ } in HTML and
9320 @code{~} in @LaTeX{}. If you need such a symbol inside a word, terminate it
9321 like this: @samp{\Aacute@{@}stor}.
9323 A large number of entities is provided, with names taken from both HTML and
9324 @LaTeX{}; see the variable @code{org-entities} for the complete list.
9325 @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
9326 @samp{...} are all converted into special commands creating hyphens of
9327 different lengths or a compact set of dots.
9329 If you would like to see entities displayed as UTF8 characters, use the
9330 following command@footnote{You can turn this on by default by setting the
9331 variable @code{org-pretty-entities}, or on a per-file base with the
9332 @code{#+STARTUP} option @code{entitiespretty}.}:
9337 Toggle display of entities as UTF-8 characters. This does not change the
9338 buffer content which remains plain ASCII, but it overlays the UTF-8 character
9339 for display purposes only.
9342 @node Subscripts and superscripts, @LaTeX{} fragments, Special symbols, Embedded @LaTeX{}
9343 @subsection Subscripts and superscripts
9347 Just like in @LaTeX{}, @samp{^} and @samp{_} are used to indicate super-
9348 and subscripts. Again, these can be used without embedding them in
9349 math-mode delimiters. To increase the readability of ASCII text, it is
9350 not necessary (but OK) to surround multi-character sub- and superscripts
9351 with curly braces. For example
9354 The mass of the sun is M_sun = 1.989 x 10^30 kg. The radius of
9355 the sun is R_@{sun@} = 6.96 x 10^8 m.
9358 @vindex org-export-with-sub-superscripts
9359 To avoid interpretation as raised or lowered text, you can quote @samp{^} and
9360 @samp{_} with a backslash: @samp{\^} and @samp{\_}. If you write a text
9361 where the underscore is often used in a different context, Org's convention
9362 to always interpret these as subscripts can get in your way. Configure the
9363 variable @code{org-export-with-sub-superscripts} to globally change this
9364 convention, or use, on a per-file basis:
9370 @noindent With this setting, @samp{a_b} will not be interpreted as a
9371 subscript, but @samp{a_@{b@}} will.
9376 In addition to showing entities as UTF-8 characters, this command will also
9377 format sub- and superscripts in a WYSIWYM way.
9380 @node @LaTeX{} fragments, Previewing @LaTeX{} fragments, Subscripts and superscripts, Embedded @LaTeX{}
9381 @subsection @LaTeX{} fragments
9382 @cindex @LaTeX{} fragments
9384 @vindex org-format-latex-header
9385 Going beyond symbols and sub- and superscripts, a full formula language is
9386 needed. Org mode can contain @LaTeX{} math fragments, and it supports ways
9387 to process these for several export backends. When exporting to @LaTeX{},
9388 the code is obviously left as it is. When exporting to HTML, Org invokes the
9389 @uref{http://www.mathjax.org, MathJax library} (@pxref{Math formatting in
9390 HTML export}) to process and display the math@footnote{If you plan to use
9391 this regularly or on pages with significant page views, you should install
9392 @file{MathJax} on your own
9393 server in order to limit the load of our server.}. Finally, it can also
9394 process the mathematical expressions into images@footnote{For this to work
9395 you need to be on a system with a working @LaTeX{} installation. You also
9396 need the @file{dvipng} program, available at
9397 @url{http://sourceforge.net/projects/dvipng/}. The @LaTeX{} header that will
9398 be used when processing a fragment can be configured with the variable
9399 @code{org-format-latex-header}.} that can be displayed in a browser or in
9402 @LaTeX{} fragments don't need any special marking at all. The following
9403 snippets will be identified as @LaTeX{} source code:
9406 Environments of any kind@footnote{When @file{MathJax} is used, only the
9407 environment recognized by @file{MathJax} will be processed. When
9408 @file{dvipng} is used to create images, any @LaTeX{} environments will be
9409 handled.}. The only requirement is that the @code{\begin} statement appears
9410 on a new line, preceded by only whitespace.
9412 Text within the usual @LaTeX{} math delimiters. To avoid conflicts with
9413 currency specifications, single @samp{$} characters are only recognized as
9414 math delimiters if the enclosed text contains at most two line breaks, is
9415 directly attached to the @samp{$} characters with no whitespace in between,
9416 and if the closing @samp{$} is followed by whitespace, punctuation or a dash.
9417 For the other delimiters, there is no such restriction, so when in doubt, use
9418 @samp{\(...\)} as inline math delimiters.
9421 @noindent For example:
9424 \begin@{equation@} % arbitrary environments,
9425 x=\sqrt@{b@} % even tables, figures
9426 \end@{equation@} % etc
9428 If $a^2=b$ and \( b=2 \), then the solution must be
9429 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
9433 @vindex org-format-latex-options
9434 If you need any of the delimiter ASCII sequences for other purposes, you
9435 can configure the option @code{org-format-latex-options} to deselect the
9436 ones you do not wish to have interpreted by the @LaTeX{} converter.
9438 @vindex org-export-with-LaTeX-fragments
9439 @LaTeX{} processing can be configured with the variable
9440 @code{org-export-with-LaTeX-fragments}. The default setting is @code{t}
9441 which means @file{MathJax} for HTML, and no processing for DocBook, ASCII and
9442 @LaTeX{} backends. You can also set this variable on a per-file basis using one
9446 #+OPTIONS: LaTeX:t @r{Do the right thing automatically (MathJax)}
9447 #+OPTIONS: LaTeX:dvipng @r{Force using dvipng images}
9448 #+OPTIONS: LaTeX:nil @r{Do not process @LaTeX{} fragments at all}
9449 #+OPTIONS: LaTeX:verbatim @r{Verbatim export, for jsMath or so}
9452 @node Previewing @LaTeX{} fragments, CDLaTeX mode, @LaTeX{} fragments, Embedded @LaTeX{}
9453 @subsection Previewing @LaTeX{} fragments
9454 @cindex @LaTeX{} fragments, preview
9456 If you have @file{dvipng} installed, @LaTeX{} fragments can be processed to
9457 produce preview images of the typeset expressions:
9462 Produce a preview image of the @LaTeX{} fragment at point and overlay it
9463 over the source code. If there is no fragment at point, process all
9464 fragments in the current entry (between two headlines). When called
9465 with a prefix argument, process the entire subtree. When called with
9466 two prefix arguments, or when the cursor is before the first headline,
9467 process the entire buffer.
9470 Remove the overlay preview images.
9473 @vindex org-format-latex-options
9474 You can customize the variable @code{org-format-latex-options} to influence
9475 some aspects of the preview. In particular, the @code{:scale} (and for HTML
9476 export, @code{:html-scale}) property can be used to adjust the size of the
9479 @node CDLaTeX mode, , Previewing @LaTeX{} fragments, Embedded @LaTeX{}
9480 @subsection Using CD@LaTeX{} to enter math
9483 CD@LaTeX{} mode is a minor mode that is normally used in combination with a
9484 major @LaTeX{} mode like AUC@TeX{} in order to speed-up insertion of
9485 environments and math templates. Inside Org mode, you can make use of
9486 some of the features of CD@LaTeX{} mode. You need to install
9487 @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
9488 AUC@TeX{}) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
9489 Don't use CD@LaTeX{} mode itself under Org mode, but use the light
9490 version @code{org-cdlatex-mode} that comes as part of Org mode. Turn it
9491 on for the current buffer with @code{M-x org-cdlatex-mode}, or for all
9495 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
9498 When this mode is enabled, the following features are present (for more
9499 details see the documentation of CD@LaTeX{} mode):
9503 Environment templates can be inserted with @kbd{C-c @{}.
9506 The @key{TAB} key will do template expansion if the cursor is inside a
9507 @LaTeX{} fragment@footnote{Org mode has a method to test if the cursor is
9508 inside such a fragment, see the documentation of the function
9509 @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will
9510 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
9511 correctly inside the first brace. Another @key{TAB} will get you into
9512 the second brace. Even outside fragments, @key{TAB} will expand
9513 environment abbreviations at the beginning of a line. For example, if
9514 you write @samp{equ} at the beginning of a line and press @key{TAB},
9515 this abbreviation will be expanded to an @code{equation} environment.
9516 To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}.
9520 @vindex cdlatex-simplify-sub-super-scripts
9521 Pressing @kbd{_} and @kbd{^} inside a @LaTeX{} fragment will insert these
9522 characters together with a pair of braces. If you use @key{TAB} to move
9523 out of the braces, and if the braces surround only a single character or
9524 macro, they are removed again (depending on the variable
9525 @code{cdlatex-simplify-sub-super-scripts}).
9528 Pressing the backquote @kbd{`} followed by a character inserts math
9529 macros, also outside @LaTeX{} fragments. If you wait more than 1.5 seconds
9530 after the backquote, a help window will pop up.
9533 Pressing the single-quote @kbd{'} followed by another character modifies
9534 the symbol before point with an accent or a font. If you wait more than
9535 1.5 seconds after the single-quote, a help window will pop up. Character
9536 modification will work only inside @LaTeX{} fragments; outside the quote
9540 @node Exporting, Publishing, Markup, Top
9544 Org mode documents can be exported into a variety of other formats. For
9545 printing and sharing of notes, ASCII export produces a readable and simple
9546 version of an Org file. HTML export allows you to publish a notes file on
9547 the web, while the XOXO format provides a solid base for exchange with a
9548 broad range of other applications. @LaTeX{} export lets you use Org mode and
9549 its structured editing functions to easily create @LaTeX{} files. DocBook
9550 export makes it possible to convert Org files to many other formats using
9551 DocBook tools. OpenDocument Text(@acronym{ODT}) export allows seamless
9552 collaboration across organizational boundaries. For project management you
9553 can create gantt and resource charts by using TaskJuggler export. To
9554 incorporate entries with associated times like deadlines or appointments into
9555 a desktop calendar program like iCal, Org mode can also produce extracts in
9556 the iCalendar format. Currently Org mode only supports export, not import of
9557 these different formats.
9559 Org supports export of selected regions when @code{transient-mark-mode} is
9560 enabled (default in Emacs 23).
9563 * Selective export:: Using tags to select and exclude trees
9564 * Export options:: Per-file export settings
9565 * The export dispatcher:: How to access exporter commands
9566 * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
9567 * HTML export:: Exporting to HTML
9568 * @LaTeX{} and PDF export:: Exporting to @LaTeX{}, and processing to PDF
9569 * DocBook export:: Exporting to DocBook
9570 * OpenDocument Text export:: Exporting to OpenDocument Text
9571 * TaskJuggler export:: Exporting to TaskJuggler
9572 * Freemind export:: Exporting to Freemind mind maps
9573 * XOXO export:: Exporting to XOXO
9574 * iCalendar export:: Exporting in iCalendar format
9577 @node Selective export, Export options, Exporting, Exporting
9578 @section Selective export
9579 @cindex export, selective by tags or TODO keyword
9581 @vindex org-export-select-tags
9582 @vindex org-export-exclude-tags
9583 @cindex org-export-with-tasks
9584 You may use tags to select the parts of a document that should be exported,
9585 or to exclude parts from export. This behavior is governed by two variables:
9586 @code{org-export-select-tags} and @code{org-export-exclude-tags},
9587 respectively defaulting to @code{'(:export:)} and @code{'(:noexport:)}.
9591 Org first checks if any of the @emph{select} tags is present in the
9592 buffer. If yes, all trees that do not carry one of these tags will be
9593 excluded. If a selected tree is a subtree, the heading hierarchy above it
9594 will also be selected for export, but not the text below those headings.
9597 If none of the select tags is found, the whole buffer will be selected for
9601 Finally, all subtrees that are marked by any of the @emph{exclude} tags will
9602 be removed from the export buffer.
9605 The variable @code{org-export-with-tasks} can be configured to select which
9606 kind of tasks should be included for export. See the docstring of the
9607 variable for more information.
9609 @node Export options, The export dispatcher, Selective export, Exporting
9610 @section Export options
9611 @cindex options, for export
9613 @cindex completion, of option keywords
9614 The exporter recognizes special lines in the buffer which provide
9615 additional information. These lines may be put anywhere in the file.
9616 The whole set of lines can be inserted into the buffer with @kbd{C-c
9617 C-e t}. For individual lines, a good way to make sure the keyword is
9618 correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion
9619 (@pxref{Completion}). For a summary of other in-buffer settings not
9620 specifically related to export, see @ref{In-buffer settings}.
9621 In particular, note that you can place commonly-used (export) options in
9622 a separate file which can be included using @code{#+SETUPFILE}.
9625 @orgcmd{C-c C-e t,org-insert-export-options-template}
9626 Insert template with export options, see example below.
9633 @cindex #+DESCRIPTION
9641 @cindex #+EXPORT_SELECT_TAGS
9642 @cindex #+EXPORT_EXCLUDE_TAGS
9644 @cindex #+LATEX_HEADER
9645 @vindex user-full-name
9646 @vindex user-mail-address
9647 @vindex org-export-default-language
9648 @vindex org-export-date-timestamp-format
9650 #+TITLE: the title to be shown (default is the buffer name)
9651 #+AUTHOR: the author (default taken from @code{user-full-name})
9652 #+DATE: a date, an Org timestamp@footnote{@code{org-export-date-timestamp-format} defines how this timestamp will be exported.}, or a format string for @code{format-time-string}
9653 #+EMAIL: his/her email address (default from @code{user-mail-address})
9654 #+DESCRIPTION: the page description, e.g.@: for the XHTML meta tag
9655 #+KEYWORDS: the page keywords, e.g.@: for the XHTML meta tag
9656 #+LANGUAGE: language for HTML, e.g.@: @samp{en} (@code{org-export-default-language})
9657 #+TEXT: Some descriptive text to be inserted at the beginning.
9658 #+TEXT: Several lines may be given.
9659 #+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ...
9660 #+BIND: lisp-var lisp-val, e.g.@:: @code{org-export-latex-low-levels itemize}
9661 @r{You need to confirm using these, or configure @code{org-export-allow-BIND}}
9662 #+LINK_UP: the ``up'' link of an exported page
9663 #+LINK_HOME: the ``home'' link of an exported page
9664 #+LATEX_HEADER: extra line(s) for the @LaTeX{} header, like \usepackage@{xyz@}
9665 #+EXPORT_SELECT_TAGS: Tags that select a tree for export
9666 #+EXPORT_EXCLUDE_TAGS: Tags that exclude a tree from export
9667 #+XSLT: the XSLT stylesheet used by DocBook exporter to generate FO file
9671 The @code{#+OPTIONS} line is a compact@footnote{If you want to configure many options
9672 this way, you can use several @code{#+OPTIONS} lines.} form to specify export
9673 settings. Here you can:
9674 @cindex headline levels
9675 @cindex section-numbers
9676 @cindex table of contents
9677 @cindex line-break preservation
9678 @cindex quoted HTML tags
9679 @cindex fixed-width sections
9681 @cindex @TeX{}-like syntax for sub- and superscripts
9683 @cindex special strings
9684 @cindex emphasized text
9685 @cindex @TeX{} macros
9686 @cindex @LaTeX{} fragments
9687 @cindex author info, in export
9688 @cindex time info, in export
9689 @vindex org-export-plist-vars
9690 @vindex org-export-author-info
9691 @vindex org-export-creator-info
9692 @vindex org-export-email-info
9693 @vindex org-export-time-stamp-file
9695 H: @r{set the number of headline levels for export}
9696 num: @r{turn on/off section-numbers}
9697 toc: @r{turn on/off table of contents, or set level limit (integer)}
9698 \n: @r{turn on/off line-break-preservation (DOES NOT WORK)}
9699 @@: @r{turn on/off quoted HTML tags}
9700 :: @r{turn on/off fixed-width sections}
9701 |: @r{turn on/off tables}
9702 ^: @r{turn on/off @TeX{}-like syntax for sub- and superscripts. If}
9703 @r{you write "^:@{@}", @code{a_@{b@}} will be interpreted, but}
9704 @r{the simple @code{a_b} will be left as it is.}
9705 -: @r{turn on/off conversion of special strings.}
9706 f: @r{turn on/off footnotes like this[1].}
9707 todo: @r{turn on/off inclusion of TODO keywords into exported text}
9708 tasks: @r{turn on/off inclusion of tasks (TODO items), can be nil to remove}
9709 @r{all tasks, @code{todo} to remove DONE tasks, or list of kwds to keep}
9710 pri: @r{turn on/off priority cookies}
9711 tags: @r{turn on/off inclusion of tags, may also be @code{not-in-toc}}
9712 <: @r{turn on/off inclusion of any time/date stamps like DEADLINES}
9713 *: @r{turn on/off emphasized text (bold, italic, underlined)}
9714 TeX: @r{turn on/off simple @TeX{} macros in plain text}
9715 LaTeX: @r{configure export of @LaTeX{} fragments. Default @code{auto}}
9716 skip: @r{turn on/off skipping the text before the first heading}
9717 author: @r{turn on/off inclusion of author name/email into exported file}
9718 email: @r{turn on/off inclusion of author email into exported file}
9719 creator: @r{turn on/off inclusion of creator info into exported file}
9720 timestamp: @r{turn on/off inclusion creation time into exported file}
9721 d: @r{turn on/off inclusion of drawers}
9724 These options take effect in both the HTML and @LaTeX{} export, except for
9725 @code{TeX} and @code{LaTeX} options, which are respectively @code{t} and
9726 @code{nil} for the @LaTeX{} export.
9728 The default values for these and many other options are given by a set of
9729 variables. For a list of such variables, the corresponding OPTIONS keys and
9730 also the publishing keys (@pxref{Project alist}), see the constant
9731 @code{org-export-plist-vars}.
9733 When exporting only a single subtree by selecting it with @kbd{C-c @@} before
9734 calling an export command, the subtree can overrule some of the file's export
9735 settings with properties @code{EXPORT_FILE_NAME}, @code{EXPORT_TITLE},
9736 @code{EXPORT_TEXT}, @code{EXPORT_AUTHOR}, @code{EXPORT_DATE}, and
9737 @code{EXPORT_OPTIONS}.
9739 @node The export dispatcher, ASCII/Latin-1/UTF-8 export, Export options, Exporting
9740 @section The export dispatcher
9741 @cindex dispatcher, for export commands
9743 All export commands can be reached using the export dispatcher, which is a
9744 prefix key that prompts for an additional key specifying the command.
9745 Normally the entire file is exported, but if there is an active region that
9746 contains one outline tree, the first heading is used as document title and
9747 the subtrees are exported.
9750 @orgcmd{C-c C-e,org-export}
9751 @vindex org-export-run-in-background
9752 Dispatcher for export and publishing commands. Displays a help-window
9753 listing the additional key(s) needed to launch an export or publishing
9754 command. The prefix arg is passed through to the exporter. A double prefix
9755 @kbd{C-u C-u} causes most commands to be executed in the background, in a
9756 separate Emacs process@footnote{To make this behavior the default, customize
9757 the variable @code{org-export-run-in-background}.}.
9758 @orgcmd{C-c C-e v,org-export-visible}
9759 Like @kbd{C-c C-e}, but only export the text that is currently visible
9760 (i.e.@: not hidden by outline visibility).
9761 @orgcmd{C-u C-u C-c C-e,org-export}
9762 @vindex org-export-run-in-background
9763 Call the exporter, but reverse the setting of
9764 @code{org-export-run-in-background}, i.e.@: request background processing if
9765 not set, or force processing in the current Emacs process if set.
9768 @node ASCII/Latin-1/UTF-8 export, HTML export, The export dispatcher, Exporting
9769 @section ASCII/Latin-1/UTF-8 export
9770 @cindex ASCII export
9771 @cindex Latin-1 export
9772 @cindex UTF-8 export
9774 ASCII export produces a simple and very readable version of an Org mode
9775 file, containing only plain ASCII. Latin-1 and UTF-8 export augment the file
9776 with special characters and symbols available in these encodings.
9778 @cindex region, active
9779 @cindex active region
9780 @cindex transient-mark-mode
9782 @orgcmd{C-c C-e a,org-export-as-ascii}
9783 @cindex property, EXPORT_FILE_NAME
9784 Export as ASCII file. For an Org file, @file{myfile.org}, the ASCII file
9785 will be @file{myfile.txt}. The file will be overwritten without
9786 warning. If there is an active region@footnote{This requires
9787 @code{transient-mark-mode} be turned on.}, only the region will be
9788 exported. If the selected region is a single tree@footnote{To select the
9789 current subtree, use @kbd{C-c @@}.}, the tree head will
9790 become the document title. If the tree head entry has or inherits an
9791 @code{EXPORT_FILE_NAME} property, that name will be used for the
9793 @orgcmd{C-c C-e A,org-export-as-ascii-to-buffer}
9794 Export to a temporary buffer. Do not create a file.
9795 @orgcmd{C-c C-e n,org-export-as-latin1}
9796 @xorgcmd{C-c C-e N,org-export-as-latin1-to-buffer}
9797 Like the above commands, but use Latin-1 encoding.
9798 @orgcmd{C-c C-e u,org-export-as-utf8}
9799 @xorgcmd{C-c C-e U,org-export-as-utf8-to-buffer}
9800 Like the above commands, but use UTF-8 encoding.
9801 @item C-c C-e v a/n/u
9802 Export only the visible part of the document.
9805 @cindex headline levels, for exporting
9806 In the exported version, the first 3 outline levels will become
9807 headlines, defining a general document structure. Additional levels
9808 will be exported as itemized lists. If you want that transition to occur
9809 at a different level, specify it with a prefix argument. For example,
9816 creates only top level headlines and does the rest as items. When
9817 headlines are converted to items, the indentation of the text following
9818 the headline is changed to fit nicely under the item. This is done with
9819 the assumption that the first body line indicates the base indentation of
9820 the body text. Any indentation larger than this is adjusted to preserve
9821 the layout relative to the first line. Should there be lines with less
9822 indentation than the first, these are left alone.
9824 @vindex org-export-ascii-links-to-notes
9825 Links will be exported in a footnote-like style, with the descriptive part in
9826 the text and the link in a note before the next heading. See the variable
9827 @code{org-export-ascii-links-to-notes} for details and other options.
9829 @node HTML export, @LaTeX{} and PDF export, ASCII/Latin-1/UTF-8 export, Exporting
9830 @section HTML export
9833 Org mode contains an HTML (XHTML 1.0 strict) exporter with extensive
9834 HTML formatting, in ways similar to John Gruber's @emph{markdown}
9835 language, but with additional support for tables.
9838 * HTML Export commands:: How to invoke HTML export
9839 * HTML preamble and postamble:: How to insert a preamble and a postamble
9840 * Quoting HTML tags:: Using direct HTML in Org mode
9841 * Links in HTML export:: How links will be interpreted and formatted
9842 * Tables in HTML export:: How to modify the formatting of tables
9843 * Images in HTML export:: How to insert figures into HTML output
9844 * Math formatting in HTML export:: Beautiful math also on the web
9845 * Text areas in HTML export:: An alternative way to show an example
9846 * CSS support:: Changing the appearance of the output
9847 * JavaScript support:: Info and Folding in a web browser
9850 @node HTML Export commands, HTML preamble and postamble, HTML export, HTML export
9851 @subsection HTML export commands
9853 @cindex region, active
9854 @cindex active region
9855 @cindex transient-mark-mode
9857 @orgcmd{C-c C-e h,org-export-as-html}
9858 @cindex property, EXPORT_FILE_NAME
9859 Export as HTML file. For an Org file @file{myfile.org},
9860 the HTML file will be @file{myfile.html}. The file will be overwritten
9861 without warning. If there is an active region@footnote{This requires
9862 @code{transient-mark-mode} be turned on.}, only the region will be
9863 exported. If the selected region is a single tree@footnote{To select the
9864 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
9865 title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
9866 property, that name will be used for the export.
9867 @orgcmd{C-c C-e b,org-export-as-html-and-open}
9868 Export as HTML file and immediately open it with a browser.
9869 @orgcmd{C-c C-e H,org-export-as-html-to-buffer}
9870 Export to a temporary buffer. Do not create a file.
9871 @orgcmd{C-c C-e R,org-export-region-as-html}
9872 Export the active region to a temporary buffer. With a prefix argument, do
9873 not produce the file header and footer, but just the plain HTML section for
9874 the region. This is good for cut-and-paste operations.
9875 @item C-c C-e v h/b/H/R
9876 Export only the visible part of the document.
9877 @item M-x org-export-region-as-html
9878 Convert the region to HTML under the assumption that it was Org mode
9879 syntax before. This is a global command that can be invoked in any
9881 @item M-x org-replace-region-by-HTML
9882 Replace the active region (assumed to be in Org mode syntax) by HTML
9886 @cindex headline levels, for exporting
9887 In the exported version, the first 3 outline levels will become headlines,
9888 defining a general document structure. Additional levels will be exported as
9889 itemized lists. If you want that transition to occur at a different level,
9890 specify it with a numeric prefix argument. For example,
9897 creates two levels of headings and does the rest as items.
9900 @node HTML preamble and postamble, Quoting HTML tags, HTML Export commands, HTML export
9901 @subsection HTML preamble and postamble
9902 @vindex org-export-html-preamble
9903 @vindex org-export-html-postamble
9904 @vindex org-export-html-preamble-format
9905 @vindex org-export-html-postamble-format
9906 @vindex org-export-html-validation-link
9907 @vindex org-export-author-info
9908 @vindex org-export-email-info
9909 @vindex org-export-creator-info
9910 @vindex org-export-time-stamp-file
9912 The HTML exporter lets you define a preamble and a postamble.
9914 The default value for @code{org-export-html-preamble} is @code{t}, which
9915 means that the preamble is inserted depending on the relevant formatting
9916 string in @code{org-export-html-preamble-format}.
9918 Setting @code{org-export-html-preamble} to a string will override the default
9919 formatting string. Setting it to a function, will insert the output of the
9920 function, which must be a string; such a function takes no argument but you
9921 can check against the value of @code{opt-plist}, which contains the list of
9922 publishing properties for the current file. Setting to @code{nil} will not
9923 insert any preamble.
9925 The default value for @code{org-export-html-postamble} is @code{'auto}, which
9926 means that the HTML exporter will look for the value of
9927 @code{org-export-author-info}, @code{org-export-email-info},
9928 @code{org-export-creator-info} and @code{org-export-time-stamp-file},
9929 @code{org-export-html-validation-link} and build the postamble from these
9930 values. Setting @code{org-export-html-postamble} to @code{t} will insert the
9931 postamble from the relevant formatting string found in
9932 @code{org-export-html-postamble-format}. Setting it to @code{nil} will not
9933 insert any postamble.
9935 @node Quoting HTML tags, Links in HTML export, HTML preamble and postamble, HTML export
9936 @subsection Quoting HTML tags
9938 Plain @samp{<} and @samp{>} are always transformed to @samp{<} and
9939 @samp{>} in HTML export. If you want to include simple HTML tags
9940 which should be interpreted as such, mark them with @samp{@@} as in
9941 @samp{@@<b>bold text@@</b>}. Note that this really works only for
9942 simple tags. For more extensive HTML that should be copied verbatim to
9943 the exported file use either
9946 @cindex #+BEGIN_HTML
9948 #+HTML: Literal HTML code for export
9952 @cindex #+BEGIN_HTML
9956 All lines between these markers are exported literally
9961 @node Links in HTML export, Tables in HTML export, Quoting HTML tags, HTML export
9962 @subsection Links in HTML export
9964 @cindex links, in HTML export
9965 @cindex internal links, in HTML export
9966 @cindex external links, in HTML export
9967 Internal links (@pxref{Internal links}) will continue to work in HTML. This
9968 includes automatic links created by radio targets (@pxref{Radio
9969 targets}). Links to external files will still work if the target file is on
9970 the same @i{relative} path as the published Org file. Links to other
9971 @file{.org} files will be translated into HTML links under the assumption
9972 that an HTML version also exists of the linked file, at the same relative
9973 path. @samp{id:} links can then be used to jump to specific entries across
9974 files. For information related to linking files while publishing them to a
9975 publishing directory see @ref{Publishing links}.
9977 If you want to specify attributes for links, you can do so using a special
9978 @code{#+ATTR_HTML} line to define attributes that will be added to the
9979 @code{<a>} or @code{<img>} tags. Here is an example that sets @code{title}
9980 and @code{style} attributes for a link:
9984 #+ATTR_HTML: title="The Org mode homepage" style="color:red;"
9985 [[http://orgmode.org]]
9988 @node Tables in HTML export, Images in HTML export, Links in HTML export, HTML export
9990 @cindex tables, in HTML
9991 @vindex org-export-html-table-tag
9993 Org mode tables are exported to HTML using the table tag defined in
9994 @code{org-export-html-table-tag}. The default setting makes tables without
9995 cell borders and frame. If you would like to change this for individual
9996 tables, place something like the following before the table:
10001 #+CAPTION: This is a table with lines around and between cells
10002 #+ATTR_HTML: border="2" rules="all" frame="border"
10005 @node Images in HTML export, Math formatting in HTML export, Tables in HTML export, HTML export
10006 @subsection Images in HTML export
10008 @cindex images, inline in HTML
10009 @cindex inlining images in HTML
10010 @vindex org-export-html-inline-images
10011 HTML export can inline images given as links in the Org file, and
10012 it can make an image the clickable part of a link. By
10013 default@footnote{But see the variable
10014 @code{org-export-html-inline-images}.}, images are inlined if a link does
10015 not have a description. So @samp{[[file:myimg.jpg]]} will be inlined,
10016 while @samp{[[file:myimg.jpg][the image]]} will just produce a link
10017 @samp{the image} that points to the image. If the description part
10018 itself is a @code{file:} link or a @code{http:} URL pointing to an
10019 image, this image will be inlined and activated so that clicking on the
10020 image will activate the link. For example, to include a thumbnail that
10021 will link to a high resolution version of the image, you could use:
10024 [[file:highres.jpg][file:thumb.jpg]]
10027 If you need to add attributes to an inlined image, use a @code{#+ATTR_HTML}.
10028 In the example below we specify the @code{alt} and @code{title} attributes to
10029 support text viewers and accessibility, and align it to the right.
10032 @cindex #+ATTR_HTML
10034 #+CAPTION: A black cat stalking a spider
10035 #+ATTR_HTML: alt="cat/spider image" title="Action!" align="right"
10040 You could use @code{http} addresses just as well.
10042 @node Math formatting in HTML export, Text areas in HTML export, Images in HTML export, HTML export
10043 @subsection Math formatting in HTML export
10047 @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be displayed in two
10048 different ways on HTML pages. The default is to use the
10049 @uref{http://www.mathjax.org, MathJax system} which should work out of the
10050 box with Org mode installation because @code{http://orgmode.org} serves
10051 @file{MathJax} for Org mode users for small applications and for testing
10052 purposes. @b{If you plan to use this regularly or on pages with significant
10053 page views, you should install@footnote{Installation instructions can be
10054 found on the MathJax website, see
10055 @uref{http://www.mathjax.org/resources/docs/?installation.html}.} MathJax on
10056 your own server in order to limit the load of our server.} To configure
10057 @file{MathJax}, use the variable @code{org-export-html-mathjax-options} or
10058 insert something like the following into the buffer:
10061 #+MATHJAX: align:"left" mathml:t path:"/MathJax/MathJax.js"
10064 @noindent See the docstring of the variable
10065 @code{org-export-html-mathjax-options} for the meaning of the parameters in
10068 If you prefer, you can also request that @LaTeX{} fragments are processed
10069 into small images that will be inserted into the browser page. Before the
10070 availability of MathJax, this was the default method for Org files. This
10071 method requires that the @file{dvipng} program is available on your system.
10072 You can still get this processing with
10075 #+OPTIONS: LaTeX:dvipng
10078 @node Text areas in HTML export, CSS support, Math formatting in HTML export, HTML export
10079 @subsection Text areas in HTML export
10081 @cindex text areas, in HTML
10082 An alternative way to publish literal code examples in HTML is to use text
10083 areas, where the example can even be edited before pasting it into an
10084 application. It is triggered by a @code{-t} switch at an @code{example} or
10085 @code{src} block. Using this switch disables any options for syntax and
10086 label highlighting, and line numbering, which may be present. You may also
10087 use @code{-h} and @code{-w} switches to specify the height and width of the
10088 text area, which default to the number of lines in the example, and 80,
10089 respectively. For example
10092 #+BEGIN_EXAMPLE -t -w 40
10093 (defun org-xor (a b)
10100 @node CSS support, JavaScript support, Text areas in HTML export, HTML export
10101 @subsection CSS support
10102 @cindex CSS, for HTML export
10103 @cindex HTML export, CSS
10105 @vindex org-export-html-todo-kwd-class-prefix
10106 @vindex org-export-html-tag-class-prefix
10107 You can also give style information for the exported file. The HTML exporter
10108 assigns the following special CSS classes@footnote{If the classes on TODO
10109 keywords and tags lead to conflicts, use the variables
10110 @code{org-export-html-todo-kwd-class-prefix} and
10111 @code{org-export-html-tag-class-prefix} to make them unique.} to appropriate
10112 parts of the document---your style specifications may change these, in
10113 addition to any of the standard classes like for headlines, tables, etc.
10115 p.author @r{author information, including email}
10116 p.date @r{publishing date}
10117 p.creator @r{creator info, about org mode version}
10118 .title @r{document title}
10119 .todo @r{TODO keywords, all not-done states}
10120 .done @r{the DONE keywords, all states that count as done}
10121 .WAITING @r{each TODO keyword also uses a class named after itself}
10122 .timestamp @r{timestamp}
10123 .timestamp-kwd @r{keyword associated with a timestamp, like SCHEDULED}
10124 .timestamp-wrapper @r{span around keyword plus timestamp}
10125 .tag @r{tag in a headline}
10126 ._HOME @r{each tag uses itself as a class, "@@" replaced by "_"}
10127 .target @r{target for links}
10128 .linenr @r{the line number in a code example}
10129 .code-highlighted @r{for highlighting referenced code lines}
10130 div.outline-N @r{div for outline level N (headline plus text))}
10131 div.outline-text-N @r{extra div for text at outline level N}
10132 .section-number-N @r{section number in headlines, different for each level}
10133 div.figure @r{how to format an inlined image}
10134 pre.src @r{formatted source code}
10135 pre.example @r{normal example}
10136 p.verse @r{verse paragraph}
10137 div.footnotes @r{footnote section headline}
10138 p.footnote @r{footnote definition paragraph, containing a footnote}
10139 .footref @r{a footnote reference number (always a <sup>)}
10140 .footnum @r{footnote number in footnote definition (always <sup>)}
10143 @vindex org-export-html-style-default
10144 @vindex org-export-html-style-include-default
10145 @vindex org-export-html-style
10146 @vindex org-export-html-extra
10147 @vindex org-export-html-style-default
10148 Each exported file contains a compact default style that defines these
10149 classes in a basic way@footnote{This style is defined in the constant
10150 @code{org-export-html-style-default}, which you should not modify. To turn
10151 inclusion of these defaults off, customize
10152 @code{org-export-html-style-include-default}}. You may overwrite these
10153 settings, or add to them by using the variables @code{org-export-html-style}
10154 (for Org-wide settings) and @code{org-export-html-style-extra} (for more
10155 fine-grained settings, like file-local settings). To set the latter variable
10156 individually for each file, you can use
10160 #+STYLE: <link rel="stylesheet" type="text/css" href="stylesheet.css" />
10164 For longer style definitions, you can use several such lines. You could also
10165 directly write a @code{<style>} @code{</style>} section in this way, without
10166 referring to an external file.
10168 In order to add styles to a subtree, use the @code{:HTML_CONTAINER_CLASS:}
10169 property to assign a class to the tree. In order to specify CSS styles for a
10170 particular headline, you can use the id specified in a @code{:CUSTOM_ID:}
10173 @c FIXME: More about header and footer styles
10174 @c FIXME: Talk about links and targets.
10176 @node JavaScript support, , CSS support, HTML export
10177 @subsection JavaScript supported display of web pages
10179 @cindex Rose, Sebastian
10180 Sebastian Rose has written a JavaScript program especially designed to
10181 enhance the web viewing experience of HTML files created with Org. This
10182 program allows you to view large files in two different ways. The first one
10183 is an @emph{Info}-like mode where each section is displayed separately and
10184 navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
10185 as well, press @kbd{?} for an overview of the available keys). The second
10186 view type is a @emph{folding} view much like Org provides inside Emacs. The
10187 script is available at @url{http://orgmode.org/org-info.js} and you can find
10188 the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
10189 We host the script at our site, but if you use it a lot, you might
10190 not want to be dependent on @url{orgmode.org} and prefer to install a local
10191 copy on your own web server.
10193 To use the script, you need to make sure that the @file{org-jsinfo.el} module
10194 gets loaded. It should be loaded by default, but you can try @kbd{M-x
10195 customize-variable @key{RET} org-modules @key{RET}} to convince yourself that
10196 this is indeed the case. All it then takes to make use of the program is
10197 adding a single line to the Org file:
10199 @cindex #+INFOJS_OPT
10201 #+INFOJS_OPT: view:info toc:nil
10205 If this line is found, the HTML header will automatically contain the code
10206 needed to invoke the script. Using the line above, you can set the following
10210 path: @r{The path to the script. The default is to grab the script from}
10211 @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
10212 @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
10213 view: @r{Initial view when website is first shown. Possible values are:}
10214 info @r{Info-like interface with one section per page.}
10215 overview @r{Folding interface, initially showing only top-level.}
10216 content @r{Folding interface, starting with all headlines visible.}
10217 showall @r{Folding interface, all headlines and text visible.}
10218 sdepth: @r{Maximum headline level that will still become an independent}
10219 @r{section for info and folding modes. The default is taken from}
10220 @r{@code{org-export-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
10221 @r{If this is smaller than in @code{org-export-headline-levels}, each}
10222 @r{info/folding section can still contain child headlines.}
10223 toc: @r{Should the table of contents @emph{initially} be visible?}
10224 @r{Even when @code{nil}, you can always get to the "toc" with @kbd{i}.}
10225 tdepth: @r{The depth of the table of contents. The defaults are taken from}
10226 @r{the variables @code{org-export-headline-levels} and @code{org-export-with-toc}.}
10227 ftoc: @r{Does the CSS of the page specify a fixed position for the "toc"?}
10228 @r{If yes, the toc will never be displayed as a section.}
10229 ltoc: @r{Should there be short contents (children) in each section?}
10230 @r{Make this @code{above} if the section should be above initial text.}
10231 mouse: @r{Headings are highlighted when the mouse is over them. Should be}
10232 @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
10233 buttons: @r{Should view-toggle buttons be everywhere? When @code{nil} (the}
10234 @r{default), only one such button will be present.}
10237 @vindex org-infojs-options
10238 @vindex org-export-html-use-infojs
10239 You can choose default values for these options by customizing the variable
10240 @code{org-infojs-options}. If you always want to apply the script to your
10241 pages, configure the variable @code{org-export-html-use-infojs}.
10243 @node @LaTeX{} and PDF export, DocBook export, HTML export, Exporting
10244 @section @LaTeX{} and PDF export
10245 @cindex @LaTeX{} export
10247 @cindex Guerry, Bastien
10249 Org mode contains a @LaTeX{} exporter written by Bastien Guerry. With
10250 further processing@footnote{The default @LaTeX{} output is designed for
10251 processing with @code{pdftex} or @LaTeX{}. It includes packages that are not
10252 compatible with @code{xetex} and possibly @code{luatex}. See the variables
10253 @code{org-export-latex-default-packages-alist} and
10254 @code{org-export-latex-packages-alist}.}, this backend is also used to
10255 produce PDF output. Since the @LaTeX{} output uses @file{hyperref} to
10256 implement links and cross references, the PDF output file will be fully
10257 linked. Beware of the fact that your @code{org} file has to be properly
10258 structured in order to be correctly exported: respect the hierarchy of
10262 * @LaTeX{}/PDF export commands::
10263 * Header and sectioning:: Setting up the export file structure
10264 * Quoting @LaTeX{} code:: Incorporating literal @LaTeX{} code
10265 * Tables in @LaTeX{} export:: Options for exporting tables to @LaTeX{}
10266 * Images in @LaTeX{} export:: How to insert figures into @LaTeX{} output
10267 * Beamer class export:: Turning the file into a presentation
10270 @node @LaTeX{}/PDF export commands, Header and sectioning, @LaTeX{} and PDF export, @LaTeX{} and PDF export
10271 @subsection @LaTeX{} export commands
10273 @cindex region, active
10274 @cindex active region
10275 @cindex transient-mark-mode
10277 @orgcmd{C-c C-e l,org-export-as-latex}
10278 @cindex property EXPORT_FILE_NAME
10279 Export as @LaTeX{} file. For an Org file
10280 @file{myfile.org}, the @LaTeX{} file will be @file{myfile.tex}. The file will
10281 be overwritten without warning. If there is an active region@footnote{This
10282 requires @code{transient-mark-mode} be turned on.}, only the region will be
10283 exported. If the selected region is a single tree@footnote{To select the
10284 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
10285 title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME}
10286 property, that name will be used for the export.
10287 @orgcmd{C-c C-e L,org-export-as-latex-to-buffer}
10288 Export to a temporary buffer. Do not create a file.
10289 @item C-c C-e v l/L
10290 Export only the visible part of the document.
10291 @item M-x org-export-region-as-latex
10292 Convert the region to @LaTeX{} under the assumption that it was Org mode
10293 syntax before. This is a global command that can be invoked in any
10295 @item M-x org-replace-region-by-latex
10296 Replace the active region (assumed to be in Org mode syntax) by @LaTeX{}
10298 @orgcmd{C-c C-e p,org-export-as-pdf}
10299 Export as @LaTeX{} and then process to PDF.
10300 @orgcmd{C-c C-e d,org-export-as-pdf-and-open}
10301 Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
10304 @cindex headline levels, for exporting
10305 @vindex org-latex-low-levels
10306 In the exported version, the first 3 outline levels will become
10307 headlines, defining a general document structure. Additional levels
10308 will be exported as description lists. The exporter can ignore them or
10309 convert them to a custom string depending on
10310 @code{org-latex-low-levels}.
10312 If you want that transition to occur at a different level, specify it
10313 with a numeric prefix argument. For example,
10316 @kbd{C-2 C-c C-e l}
10320 creates two levels of headings and does the rest as items.
10322 @node Header and sectioning, Quoting @LaTeX{} code, @LaTeX{}/PDF export commands, @LaTeX{} and PDF export
10323 @subsection Header and sectioning structure
10324 @cindex @LaTeX{} class
10325 @cindex @LaTeX{} sectioning structure
10326 @cindex @LaTeX{} header
10327 @cindex header, for @LaTeX{} files
10328 @cindex sectioning structure, for @LaTeX{} export
10330 By default, the @LaTeX{} output uses the class @code{article}.
10332 @vindex org-export-latex-default-class
10333 @vindex org-export-latex-classes
10334 @vindex org-export-latex-default-packages-alist
10335 @vindex org-export-latex-packages-alist
10336 @cindex #+LATEX_HEADER
10337 @cindex #+LATEX_CLASS
10338 @cindex #+LATEX_CLASS_OPTIONS
10339 @cindex property, LATEX_CLASS
10340 @cindex property, LATEX_CLASS_OPTIONS
10341 You can change this globally by setting a different value for
10342 @code{org-export-latex-default-class} or locally by adding an option like
10343 @code{#+LaTeX_CLASS: myclass} in your file, or with a @code{:LaTeX_CLASS:}
10344 property that applies when exporting a region containing only this (sub)tree.
10345 The class must be listed in @code{org-export-latex-classes}. This variable
10346 defines a header template for each class@footnote{Into which the values of
10347 @code{org-export-latex-default-packages-alist} and
10348 @code{org-export-latex-packages-alist} are spliced.}, and allows you to
10349 define the sectioning structure for each class. You can also define your own
10350 classes there. @code{#+LaTeX_CLASS_OPTIONS} or a @code{LaTeX_CLASS_OPTIONS}
10351 property can specify the options for the @code{\documentclass} macro. You
10352 can also use @code{#+LATEX_HEADER: \usepackage@{xyz@}} to add lines to the
10353 header. See the docstring of @code{org-export-latex-classes} for more
10356 @node Quoting @LaTeX{} code, Tables in @LaTeX{} export, Header and sectioning, @LaTeX{} and PDF export
10357 @subsection Quoting @LaTeX{} code
10359 Embedded @LaTeX{} as described in @ref{Embedded @LaTeX{}}, will be correctly
10360 inserted into the @LaTeX{} file. This includes simple macros like
10361 @samp{\ref@{LABEL@}} to create a cross reference to a figure. Furthermore,
10362 you can add special code that should only be present in @LaTeX{} export with
10363 the following constructs:
10366 @cindex #+BEGIN_LaTeX
10368 #+LaTeX: Literal @LaTeX{} code for export
10372 @cindex #+BEGIN_LaTeX
10376 All lines between these markers are exported literally
10381 @node Tables in @LaTeX{} export, Images in @LaTeX{} export, Quoting @LaTeX{} code, @LaTeX{} and PDF export
10382 @subsection Tables in @LaTeX{} export
10383 @cindex tables, in @LaTeX{} export
10385 For @LaTeX{} export of a table, you can specify a label, a caption and
10386 placement options (@pxref{Images and tables}). You can also use the
10387 @code{ATTR_LaTeX} line to request a @code{longtable} environment for the
10388 table, so that it may span several pages, or to change the default table
10389 environment from @code{table} to @code{table*} or to change the default inner
10390 tabular environment to @code{tabularx} or @code{tabulary}. Finally, you can
10391 set the alignment string, and (with @code{tabularx} or @code{tabulary}) the
10396 @cindex #+ATTR_LaTeX
10398 #+CAPTION: A long table
10400 #+ATTR_LaTeX: longtable align=l|lp@{3cm@}r|l
10405 or to specify a multicolumn table with @code{tabulary}
10409 @cindex #+ATTR_LaTeX
10411 #+CAPTION: A wide table with tabulary
10413 #+ATTR_LaTeX: table* tabulary width=\textwidth
10418 @node Images in @LaTeX{} export, Beamer class export, Tables in @LaTeX{} export, @LaTeX{} and PDF export
10419 @subsection Images in @LaTeX{} export
10420 @cindex images, inline in @LaTeX{}
10421 @cindex inlining images in @LaTeX{}
10423 Images that are linked to without a description part in the link, like
10424 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
10425 output file resulting from @LaTeX{} processing. Org will use an
10426 @code{\includegraphics} macro to insert the image. If you have specified a
10427 caption and/or a label as described in @ref{Images and tables}, the figure
10428 will be wrapped into a @code{figure} environment and thus become a floating
10429 element. You can use an @code{#+ATTR_LaTeX:} line to specify various other
10430 options. You can ask org to export an image as a float without specifying
10431 a label or a caption by using the keyword @code{float} in this line. Various
10432 optional arguments to the @code{\includegraphics} macro can also be specified
10433 in this fashion. To modify the placement option of the floating environment,
10434 add something like @samp{placement=[h!]} to the attributes. It is to be noted
10435 this option can be used with tables as well@footnote{One can also take
10436 advantage of this option to pass other, unrelated options into the figure or
10437 table environment. For an example see the section ``Exporting org files'' in
10438 @url{http://orgmode.org/worg/org-hacks.html}}. For example the
10439 @code{#+ATTR_LaTeX:} line below is exported as the @code{figure} environment
10442 If you would like to let text flow around the image, add the word @samp{wrap}
10443 to the @code{#+ATTR_LaTeX:} line, which will make the figure occupy the left
10444 half of the page. To fine-tune, the @code{placement} field will be the set
10445 of additional arguments needed by the @code{wrapfigure} environment. Note
10446 that if you change the size of the image, you need to use compatible settings
10447 for @code{\includegraphics} and @code{wrapfigure}.
10451 @cindex #+ATTR_LaTeX
10453 #+CAPTION: The black-body emission of the disk around HR 4049
10454 #+LABEL: fig:SED-HR4049
10455 #+ATTR_LaTeX: width=5cm,angle=90
10456 [[./img/sed-hr4049.pdf]]
10458 #+ATTR_LaTeX: width=0.38\textwidth wrap placement=@{r@}@{0.4\textwidth@}
10462 If you wish to include an image which spans multiple columns in a page, you
10463 can use the keyword @code{multicolumn} in the @code{#+ATTR_LaTeX} line. This
10464 will export the image wrapped in a @code{figure*} environment.
10466 If you need references to a label created in this way, write
10467 @samp{\ref@{fig:SED-HR4049@}} just like in @LaTeX{}.
10469 @node Beamer class export, , Images in @LaTeX{} export, @LaTeX{} and PDF export
10470 @subsection Beamer class export
10472 The @LaTeX{} class @file{beamer} allows production of high quality presentations
10473 using @LaTeX{} and pdf processing. Org mode has special support for turning an
10474 Org mode file or tree into a @file{beamer} presentation.
10476 When the @LaTeX{} class for the current buffer (as set with @code{#+LaTeX_CLASS:
10477 beamer}) or subtree (set with a @code{LaTeX_CLASS} property) is
10478 @code{beamer}, a special export mode will turn the file or tree into a beamer
10479 presentation. Any tree with not-too-deep level nesting should in principle be
10480 exportable as a beamer presentation. By default, the top-level entries (or
10481 the first level below the selected subtree heading) will be turned into
10482 frames, and the outline structure below this level will become itemize lists.
10483 You can also configure the variable @code{org-beamer-frame-level} to a
10484 different level---then the hierarchy above frames will produce the sectioning
10485 structure of the presentation.
10487 A template for useful in-buffer settings or properties can be inserted into
10488 the buffer with @kbd{M-x org-insert-beamer-options-template}. Among other
10489 things, this will install a column view format which is very handy for
10490 editing special properties used by beamer.
10492 You can influence the structure of the presentation using the following
10497 The environment that should be used to format this entry. Valid environments
10498 are defined in the constant @code{org-beamer-environments-default}, and you
10499 can define more in @code{org-beamer-environments-extra}. If this property is
10500 set, the entry will also get a @code{:B_environment:} tag to make this
10501 visible. This tag has no semantic meaning, it is only a visual aid.
10502 @item BEAMER_envargs
10503 The beamer-special arguments that should be used for the environment, like
10504 @code{[t]} or @code{[<+->]} of @code{<2-3>}. If the @code{BEAMER_col}
10505 property is also set, something like @code{C[t]} can be added here as well to
10506 set an options argument for the implied @code{columns} environment.
10507 @code{c[t]} or @code{c<2->} will set an options for the implied @code{column}
10510 The width of a column that should start with this entry. If this property is
10511 set, the entry will also get a @code{:BMCOL:} property to make this visible.
10512 Also this tag is only a visual aid. When this is a plain number, it will be
10513 interpreted as a fraction of @code{\textwidth}. Otherwise it will be assumed
10514 that you have specified the units, like @samp{3cm}. The first such property
10515 in a frame will start a @code{columns} environment to surround the columns.
10516 This environment is closed when an entry has a @code{BEAMER_col} property
10517 with value 0 or 1, or automatically at the end of the frame.
10519 Additional commands that should be inserted after the environment has been
10520 opened. For example, when creating a frame, this can be used to specify
10524 Frames will automatically receive a @code{fragile} option if they contain
10525 source code that uses the verbatim environment. Special @file{beamer}
10526 specific code can be inserted using @code{#+BEAMER:} and
10527 @code{#+BEGIN_beamer...#+end_beamer} constructs, similar to other export
10528 backends, but with the difference that @code{#+LaTeX:} stuff will be included
10529 in the presentation as well.
10531 Outline nodes with @code{BEAMER_env} property value @samp{note} or
10532 @samp{noteNH} will be formatted as beamer notes, i,e, they will be wrapped
10533 into @code{\note@{...@}}. The former will include the heading as part of the
10534 note text, the latter will ignore the heading of that node. To simplify note
10535 generation, it is actually enough to mark the note with a @emph{tag} (either
10536 @code{:B_note:} or @code{:B_noteNH:}) instead of creating the
10537 @code{BEAMER_env} property.
10539 You can turn on a special minor mode @code{org-beamer-mode} for editing
10547 @orgcmd{C-c C-b,org-beamer-select-environment}
10548 In @code{org-beamer-mode}, this key offers fast selection of a beamer
10549 environment or the @code{BEAMER_col} property.
10552 Column view provides a great way to set the environment of a node and other
10553 important parameters. Make sure you are using a COLUMN format that is geared
10554 toward this special purpose. The command @kbd{M-x
10555 org-insert-beamer-options-template} defines such a format.
10557 Here is a simple example Org document that is intended for beamer export.
10560 #+LaTeX_CLASS: beamer
10561 #+TITLE: Example Presentation
10562 #+AUTHOR: Carsten Dominik
10563 #+LaTeX_CLASS_OPTIONS: [presentation]
10564 #+BEAMER_FRAME_LEVEL: 2
10565 #+BEAMER_HEADER_EXTRA: \usetheme@{Madrid@}\usecolortheme@{default@}
10566 #+COLUMNS: %35ITEM %10BEAMER_env(Env) %10BEAMER_envargs(Args) %4BEAMER_col(Col) %8BEAMER_extra(Ex)
10568 * This is the first structural section
10570 ** Frame 1 \\ with a subtitle
10571 *** Thanks to Eric Fraga :BMCOL:B_block:
10574 :BEAMER_envargs: C[t]
10577 for the first viable beamer setup in Org
10578 *** Thanks to everyone else :BMCOL:B_block:
10582 :BEAMER_envargs: <2->
10584 for contributing to the discussion
10585 **** This will be formatted as a beamer note :B_note:
10586 ** Frame 2 \\ where we will not use columns
10587 *** Request :B_block:
10588 Please test this stuff!
10594 For more information, see the documentation on Worg.
10596 @node DocBook export, OpenDocument Text export, @LaTeX{} and PDF export, Exporting
10597 @section DocBook export
10598 @cindex DocBook export
10600 @cindex Cui, Baoqiu
10602 Org contains a DocBook exporter written by Baoqiu Cui. Once an Org file is
10603 exported to DocBook format, it can be further processed to produce other
10604 formats, including PDF, HTML, man pages, etc., using many available DocBook
10605 tools and stylesheets.
10607 Currently DocBook exporter only supports DocBook V5.0.
10610 * DocBook export commands:: How to invoke DocBook export
10611 * Quoting DocBook code:: Incorporating DocBook code in Org files
10612 * Recursive sections:: Recursive sections in DocBook
10613 * Tables in DocBook export:: Tables are exported as HTML tables
10614 * Images in DocBook export:: How to insert figures into DocBook output
10615 * Special characters:: How to handle special characters
10618 @node DocBook export commands, Quoting DocBook code, DocBook export, DocBook export
10619 @subsection DocBook export commands
10621 @cindex region, active
10622 @cindex active region
10623 @cindex transient-mark-mode
10625 @orgcmd{C-c C-e D,org-export-as-docbook}
10626 @cindex property EXPORT_FILE_NAME
10627 Export as DocBook file. For an Org file, @file{myfile.org}, the DocBook XML
10628 file will be @file{myfile.xml}. The file will be overwritten without
10629 warning. If there is an active region@footnote{This requires
10630 @code{transient-mark-mode} to be turned on}, only the region will be
10631 exported. If the selected region is a single tree@footnote{To select the
10632 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
10633 title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
10634 property, that name will be used for the export.
10635 @orgcmd{C-c C-e V,org-export-as-docbook-pdf-and-open}
10636 Export as DocBook file, process to PDF, then open the resulting PDF file.
10638 @vindex org-export-docbook-xslt-proc-command
10639 @vindex org-export-docbook-xsl-fo-proc-command
10640 Note that, in order to produce PDF output based on exported DocBook file, you
10641 need to have XSLT processor and XSL-FO processor software installed on your
10642 system. Check variables @code{org-export-docbook-xslt-proc-command} and
10643 @code{org-export-docbook-xsl-fo-proc-command}.
10645 @vindex org-export-docbook-xslt-stylesheet
10646 The stylesheet argument @code{%s} in variable
10647 @code{org-export-docbook-xslt-proc-command} is replaced by the value of
10648 variable @code{org-export-docbook-xslt-stylesheet}, which needs to be set by
10649 the user. You can also overrule this global setting on a per-file basis by
10650 adding an in-buffer setting @code{#+XSLT:} to the Org file.
10652 @orgkey{C-c C-e v D}
10653 Export only the visible part of the document.
10656 @node Quoting DocBook code, Recursive sections, DocBook export commands, DocBook export
10657 @subsection Quoting DocBook code
10659 You can quote DocBook code in Org files and copy it verbatim into exported
10660 DocBook file with the following constructs:
10663 @cindex #+BEGIN_DOCBOOK
10665 #+DOCBOOK: Literal DocBook code for export
10669 @cindex #+BEGIN_DOCBOOK
10673 All lines between these markers are exported by DocBook exporter
10678 For example, you can use the following lines to include a DocBook warning
10679 admonition. As to what this warning says, you should pay attention to the
10680 document context when quoting DocBook code in Org files. You may make
10681 exported DocBook XML files invalid by not quoting DocBook code correctly.
10686 <para>You should know what you are doing when quoting DocBook XML code
10687 in your Org file. Invalid DocBook XML may be generated by
10688 DocBook exporter if you are not careful!</para>
10693 @node Recursive sections, Tables in DocBook export, Quoting DocBook code, DocBook export
10694 @subsection Recursive sections
10695 @cindex DocBook recursive sections
10697 DocBook exporter exports Org files as articles using the @code{article}
10698 element in DocBook. Recursive sections, i.e.@: @code{section} elements, are
10699 used in exported articles. Top level headlines in Org files are exported as
10700 top level sections, and lower level headlines are exported as nested
10701 sections. The entire structure of Org files will be exported completely, no
10702 matter how many nested levels of headlines there are.
10704 Using recursive sections makes it easy to port and reuse exported DocBook
10705 code in other DocBook document types like @code{book} or @code{set}.
10707 @node Tables in DocBook export, Images in DocBook export, Recursive sections, DocBook export
10708 @subsection Tables in DocBook export
10709 @cindex tables, in DocBook export
10711 Tables in Org files are exported as HTML tables, which have been supported since
10714 If a table does not have a caption, an informal table is generated using the
10715 @code{informaltable} element; otherwise, a formal table will be generated
10716 using the @code{table} element.
10718 @node Images in DocBook export, Special characters, Tables in DocBook export, DocBook export
10719 @subsection Images in DocBook export
10720 @cindex images, inline in DocBook
10721 @cindex inlining images in DocBook
10723 Images that are linked to without a description part in the link, like
10724 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]}, will be exported to DocBook
10725 using @code{mediaobject} elements. Each @code{mediaobject} element contains
10726 an @code{imageobject} that wraps an @code{imagedata} element. If you have
10727 specified a caption for an image as described in @ref{Images and tables}, a
10728 @code{caption} element will be added in @code{mediaobject}. If a label is
10729 also specified, it will be exported as an @code{xml:id} attribute of the
10730 @code{mediaobject} element.
10732 @vindex org-export-docbook-default-image-attributes
10733 Image attributes supported by the @code{imagedata} element, like @code{align}
10734 or @code{width}, can be specified in two ways: you can either customize
10735 variable @code{org-export-docbook-default-image-attributes} or use the
10736 @code{#+ATTR_DOCBOOK:} line. Attributes specified in variable
10737 @code{org-export-docbook-default-image-attributes} are applied to all inline
10738 images in the Org file to be exported (unless they are overridden by image
10739 attributes specified in @code{#+ATTR_DOCBOOK:} lines).
10741 The @code{#+ATTR_DOCBOOK:} line can be used to specify additional image
10742 attributes or override default image attributes for individual images. If
10743 the same attribute appears in both the @code{#+ATTR_DOCBOOK:} line and
10744 variable @code{org-export-docbook-default-image-attributes}, the former
10745 takes precedence. Here is an example about how image attributes can be
10750 @cindex #+ATTR_DOCBOOK
10752 #+CAPTION: The logo of Org mode
10753 #+LABEL: unicorn-svg
10754 #+ATTR_DOCBOOK: scalefit="1" width="100%" depth="100%"
10755 [[./img/org-mode-unicorn.svg]]
10758 @vindex org-export-docbook-inline-image-extensions
10759 By default, DocBook exporter recognizes the following image file types:
10760 @file{jpeg}, @file{jpg}, @file{png}, @file{gif}, and @file{svg}. You can
10761 customize variable @code{org-export-docbook-inline-image-extensions} to add
10762 more types to this list as long as DocBook supports them.
10764 @node Special characters, , Images in DocBook export, DocBook export
10765 @subsection Special characters in DocBook export
10766 @cindex Special characters in DocBook export
10768 @vindex org-export-docbook-doctype
10769 @vindex org-entities
10770 Special characters that are written in @TeX{}-like syntax, such as @code{\alpha},
10771 @code{\Gamma}, and @code{\Zeta}, are supported by DocBook exporter. These
10772 characters are rewritten to XML entities, like @code{α},
10773 @code{Γ}, and @code{Ζ}, based on the list saved in variable
10774 @code{org-entities}. As long as the generated DocBook file includes the
10775 corresponding entities, these special characters are recognized.
10777 You can customize variable @code{org-export-docbook-doctype} to include the
10778 entities you need. For example, you can set variable
10779 @code{org-export-docbook-doctype} to the following value to recognize all
10780 special characters included in XHTML entities:
10783 "<!DOCTYPE article [
10784 <!ENTITY % xhtml1-symbol PUBLIC
10785 \"-//W3C//ENTITIES Symbol for HTML//EN//XML\"
10786 \"http://www.w3.org/2003/entities/2007/xhtml1-symbol.ent\"
10793 @c begin opendocument
10795 @node OpenDocument Text export, TaskJuggler export, DocBook export, Exporting
10796 @section OpenDocument Text export
10797 @cindex K, Jambunathan
10799 @cindex OpenDocument
10800 @cindex export, OpenDocument
10801 @cindex LibreOffice
10803 @cindex org-modules
10805 Orgmode@footnote{Versions 7.8 or later} supports export to OpenDocument Text
10806 (@acronym{ODT}) format using the @file{org-odt.el} module. Documents created
10807 by this exporter use the @cite{OpenDocument-v1.2
10808 specification}@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
10809 Open Document Format for Office Applications (OpenDocument) Version 1.2}} and
10810 are compatible with LibreOffice 3.4.
10813 * Pre-requisites for @acronym{ODT} export:: What packages @acronym{ODT} exporter relies on
10814 * @acronym{ODT} export commands:: How to invoke @acronym{ODT} export
10815 * Applying custom styles:: How to apply custom styles to the output
10816 * Links in @acronym{ODT} export:: How links will be interpreted and formatted
10817 * Tables in @acronym{ODT} export:: How Tables are exported
10818 * Images in @acronym{ODT} export:: How to insert images
10819 * Math formatting in @acronym{ODT} export:: How @LaTeX{} fragments are formatted
10820 * Literal examples in @acronym{ODT} export:: How source and example blocks are formatted
10821 * Advanced topics in @acronym{ODT} export:: Read this if you are a power user
10824 @node Pre-requisites for @acronym{ODT} export, @acronym{ODT} export commands, OpenDocument Text export, OpenDocument Text export
10825 @subsection Pre-requisites for @acronym{ODT} export
10827 The @acronym{ODT} exporter relies on the @file{zip} program to create the final
10828 output. Check the availability of this program before proceeding further.
10830 @node @acronym{ODT} export commands, Applying custom styles, Pre-requisites for @acronym{ODT} export, OpenDocument Text export
10831 @subsection @acronym{ODT} export commands
10833 @subsubheading Exporting to @acronym{ODT}
10834 @anchor{x-export-to-odt}
10836 @cindex region, active
10837 @cindex active region
10838 @cindex transient-mark-mode
10840 @orgcmd{C-c C-e o,org-export-as-odt}
10841 @cindex property EXPORT_FILE_NAME
10843 Export as OpenDocument Text file.
10844 @vindex org-export-odt-preferred-output-format
10845 If @code{org-export-odt-preferred-output-format} is specified, automatically
10846 convert the exported file to that format.
10847 @xref{x-export-to-other-formats,,Automatically exporting to other formats}.
10849 For an Org file @file{myfile.org}, the @acronym{ODT} file will be
10850 @file{myfile.odt}. The file will be overwritten without warning. If there
10851 is an active region,@footnote{This requires @code{transient-mark-mode} to be
10852 turned on} only the region will be exported. If the selected region is a
10853 single tree,@footnote{To select the current subtree, use @kbd{C-c @@}} the
10854 tree head will become the document title. If the tree head entry has, or
10855 inherits, an @code{EXPORT_FILE_NAME} property, that name will be used for the
10858 @orgcmd{C-c C-e O,org-export-as-odt-and-open}
10859 Export as OpenDocument Text file and open the resulting file.
10860 @vindex org-export-odt-preferred-output-format
10861 If @code{org-export-odt-preferred-output-format} is specified, open the
10862 converted file instead.
10863 @xref{x-export-to-other-formats,,Automatically exporting to other formats}.
10866 @subsubheading Automatically exporting to other formats
10867 @anchor{x-export-to-other-formats}
10868 @vindex org-export-odt-preferred-output-format
10869 Very often, you will find yourself exporting to @acronym{ODT} format, only to
10870 immediately save the exported document to a different format like @samp{pdf}.
10871 In such cases, you will find it convenient to configure a converter
10872 (@pxref{Exporting and converting to other formats}) and specify your
10873 preferred output format by customizing the variable
10874 @code{org-export-odt-preferred-output-format}. This way, the export commands
10875 (@pxref{x-export-to-odt,,Exporting to ODT}) can be extended to also export to
10876 the preferred format.
10878 @node Applying custom styles, Links in @acronym{ODT} export, @acronym{ODT} export commands, OpenDocument Text export
10879 @subsection Applying custom styles
10880 @cindex styles, custom
10881 @cindex template, custom
10883 The @acronym{ODT} exporter ships with a set of OpenDocument styles
10884 (@pxref{Working with OpenDocument style files}) that ensure a well-formatted
10885 output. These factory styles, however, may not cater to your specific
10886 tastes. To customize the output, you can either modify the above styles
10887 files directly, or generate the required styles using an application like
10888 LibreOffice. The latter method is suitable for expert and non-expert
10889 users alike, and is described here.
10891 @subsubsection Applying custom styles - the easy way
10895 Create a sample @file{example.org} file with the below settings and export it
10896 to @acronym{ODT} format.
10899 #+OPTIONS: H:10 num:t
10903 Open the above @file{example.odt} using LibreOffice. Use the @file{Stylist}
10904 to locate the target styles - these typically have the @samp{Org} prefix -
10905 and modify those to your taste. Save the modified file either as an
10906 OpenDocument Text (@file{.odt}) or OpenDocument Template (@file{.ott}) file.
10909 @cindex #+ODT_STYLES_FILE
10910 @vindex org-export-odt-styles-file
10911 Customize the variable @code{org-export-odt-styles-file} and point it to the
10912 newly created file. For additional configuration options
10913 @pxref{x-overriding-factory-styles,,Overriding factory styles}.
10915 If you would like to choose a style on a per-file basis, you can use the
10916 @code{#+ODT_STYLES_FILE} option. A typical setting will look like
10919 #+ODT_STYLES_FILE: "/path/to/example.ott"
10925 #+ODT_STYLES_FILE: ("/path/to/file.ott" ("styles.xml" "image/hdr.png"))
10930 @subsubsection Using third-party styles and templates
10932 You can use third-party styles and templates for customizing your output.
10933 This will produce the desired output only if the template provides all
10934 style names that the @samp{ODT} exporter relies on. Unless this condition is
10935 met, the output is going to be less than satisfactory. So it is highly
10936 recommended that you only work with templates that are directly derived from
10937 the factory settings.
10939 @node Links in @acronym{ODT} export, Tables in @acronym{ODT} export, Applying custom styles, OpenDocument Text export
10940 @subsection Links in @acronym{ODT} export
10941 @cindex tables, in DocBook export
10943 The @acronym{ODT} exporter creates cross-references (aka bookmarks) for
10944 internal links. It creates Internet-style links for all other links.
10946 @node Tables in @acronym{ODT} export, Images in @acronym{ODT} export, Links in @acronym{ODT} export, OpenDocument Text export
10947 @subsection Tables in @acronym{ODT} export
10948 @cindex tables, in DocBook export
10950 Export of native Org mode tables (@pxref{Tables}) and simple @file{table.el}
10951 tables is supported. However, export of complex @file{table.el} tables -
10952 tables that have column or row spans - is not supported. Such tables are
10953 stripped from the exported document.
10955 By default, a table is exported with top and bottom frames and with
10956 rules separating row and column groups (@pxref{Column groups}). If the table
10957 specifies alignment and relative width for its columns (@pxref{Column width
10958 and alignment}) then these are honored on export.@footnote{The column widths
10959 are interpreted as weighted ratios with the default weight being 1}
10962 If you are not satisfied with the default formatting of tables, you can
10963 create custom table styles and associate them with a table using
10964 the @code{#+ATTR_ODT} line. @xref{Customizing tables in @acronym{ODT} export}.
10966 @node Images in @acronym{ODT} export, Math formatting in @acronym{ODT} export, Tables in @acronym{ODT} export, OpenDocument Text export
10967 @subsection Images in @acronym{ODT} export
10968 @cindex images, embedding in @acronym{ODT}
10969 @cindex embedding images in @acronym{ODT}
10971 @subsubheading Embedding images
10972 You can embed images within the exported document by providing a link to the
10973 desired image file with no link description. For example, to embed
10974 @samp{img.png} do either of the following:
10984 @subsubheading Embedding clickable images
10985 You can create clickable images by providing a link whose description is a
10986 link to an image file. For example, to embed a image
10987 @file{org-mode-unicorn.png} which when clicked jumps to
10988 @uref{http://Orgmode.org} website, do the following
10991 [[http://orgmode.org][./org-mode-unicorn.png]]
10994 @subsubheading Sizing and scaling of embedded images
10996 You can control the size and scale of the embedded images using the
10997 @code{#+ATTR_ODT} attribute.
10999 @vindex org-export-odt-pixels-per-inch
11000 Note that the exporter specifies the desired size of the image in the final
11001 document in units of centimeters. In order to scale the embedded images, the
11002 exporter needs to compute the size of the image. This is done by retrieving
11003 the image size in pixels and converting the pixel units to centimeters using
11004 @code{org-export-odt-pixels-per-inch}. The default value of this variable is
11005 set to @code{display-pixels-per-inch}. You can tweak this variable to
11006 achieve the best results.
11008 The examples below illustrate the various possibilities.
11012 @item Explicitly size the image
11013 To embed @file{img.png} as a 10 cm x 10 cm image, do the following:
11016 #+ATTR_ODT: :width 10 :height 10
11020 @item Scale the image
11021 To embed @file{img.png} at half its size, do the following:
11024 #+ATTR_ODT: :scale 0.5
11028 @item Scale the image to a specific width
11029 To embed @file{img.png} with a width of 10 cm while retaining the original
11030 height:width ratio, do the following:
11033 #+ATTR_ODT: :width 10
11037 @item Scale the image to a specific height
11038 To embed @file{img.png} with a height of 10 cm while retaining the original
11039 height:width ratio, do the following
11042 #+ATTR_ODT: :height 10
11047 @node Math formatting in @acronym{ODT} export, Literal examples in @acronym{ODT} export, Images in @acronym{ODT} export, OpenDocument Text export
11048 @subsection Math formatting in @acronym{ODT} export
11050 The @acronym{ODT} exporter has special support for handling math.
11053 * Working with @LaTeX{} math snippets:: How to embed @LaTeX{} math fragments
11054 * Working with MathML or OpenDocument formula files:: How to embed equations in native format
11057 @node Working with @LaTeX{} math snippets, Working with MathML or OpenDocument formula files, Math formatting in @acronym{ODT} export, Math formatting in @acronym{ODT} export
11058 @subsubsection Working with @LaTeX{} math snippets
11060 @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be embedded in the ODT
11061 document in one of the following ways:
11067 This option is activated on a per-file basis with
11073 With this option, @LaTeX{} fragments are first converted into MathML
11074 fragments using an external @LaTeX{}-to-MathML converter program. The
11075 resulting MathML fragments are then embedded as an OpenDocument Formula in
11076 the exported document.
11078 @vindex org-latex-to-mathml-convert-command
11079 @vindex org-latex-to-mathml-jar-file
11081 You can specify the @LaTeX{}-to-MathML converter by customizing the variables
11082 @code{org-latex-to-mathml-convert-command} and
11083 @code{org-latex-to-mathml-jar-file}.
11085 If you prefer to use @file{MathToWeb}@footnote{See
11086 @uref{http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl, MathToWeb}} as your
11087 converter, you can configure the above variables as shown below.
11090 (setq org-latex-to-mathml-convert-command
11091 "java -jar %j -unicode -force -df %o %I"
11092 org-latex-to-mathml-jar-file
11093 "/path/to/mathtoweb.jar")
11096 You can use the following commands to quickly verify the reliability of
11097 the @LaTeX{}-to-MathML converter.
11101 @item M-x org-export-as-odf
11102 Convert a @LaTeX{} math snippet to OpenDocument formula (@file{.odf}) file.
11104 @item M-x org-export-as-odf-and-open
11105 Convert a @LaTeX{} math snippet to OpenDocument formula (@file{.odf}) file and
11106 open the formula file with the system-registered application.
11112 This option is activated on a per-file basis with
11115 #+OPTIONS: LaTeX:dvipng
11118 With this option, @LaTeX{} fragments are processed into PNG images and the
11119 resulting images are embedded in the exported document. This method requires
11120 that the @file{dvipng} program be available on your system.
11123 @node Working with MathML or OpenDocument formula files, , Working with @LaTeX{} math snippets, Math formatting in @acronym{ODT} export
11124 @subsubsection Working with MathML or OpenDocument formula files
11126 For various reasons, you may find embedding @LaTeX{} math snippets in an
11127 @acronym{ODT} document less than reliable. In that case, you can embed a
11128 math equation by linking to its MathML(@file{.mml}) source or its
11129 OpenDocument formula (@file{.odf}) file as shown below:
11141 @node Literal examples in @acronym{ODT} export, Advanced topics in @acronym{ODT} export, Math formatting in @acronym{ODT} export, OpenDocument Text export
11142 @subsection Literal examples in @acronym{ODT} export
11144 Export of literal examples (@pxref{Literal examples}) with full fontification
11145 is supported. This feature is enabled by default and is activated
11146 automatically if an enhanced version of @file{htmlfontify.el} is available in
11147 the @code{load-path}.@footnote{The @file{htmlfontify.el} that ships with
11148 standard Emacs <= 24.1 has no support for @acronym{ODT} fontification. A
11149 copy of the proposed version is available as an attachment to
11150 @url{http://debbugs.gnu.org/cgi/bugreport.cgi?msg=5;filename=htmlfontify.el;att=9;bug=9914,
11153 @vindex org-export-odt-fontify-srcblocks
11155 The character styles used for fontification of the literal blocks are
11156 auto-generated by the exporter in conjunction with @file{htmlfontify.el}
11157 library and need not be included in the default @file{styles.xml} file.
11158 These auto-generated styles have the @samp{OrgSrc} prefix and inherit their color
11159 based on the face used by Emacs @code{font-lock} library.
11161 @vindex org-export-odt-create-custom-styles-for-srcblocks
11162 If you prefer to use your own custom styles for fontification and disable
11163 their auto-generation altogether, you can do so by customizing the variable
11164 @code{org-export-odt-create-custom-styles-for-srcblocks}.
11166 You can turn off fontification support for literal examples by customizing
11167 the variable @code{org-export-odt-fontify-srcblocks}.
11170 @node Advanced topics in @acronym{ODT} export, , Literal examples in @acronym{ODT} export, OpenDocument Text export
11171 @subsection Advanced topics in @acronym{ODT} export
11173 If you rely heavily on @acronym{ODT} export, you may want to exploit the full
11174 set of features that the exporter offers. This section describes features
11175 that would be of interest to power users.
11178 * Exporting and converting to other formats:: How to produce @samp{pdf} and other formats
11179 * Working with OpenDocument style files:: Explore the internals
11180 * Creating one-off styles:: How to produce custom highlighting etc
11181 * Customizing tables in @acronym{ODT} export:: How to define and use Table templates
11182 * Validating OpenDocument XML:: How to debug corrupt OpenDocument files
11185 @node Exporting and converting to other formats, Working with OpenDocument style files, Advanced topics in @acronym{ODT} export, Advanced topics in @acronym{ODT} export
11186 @subsubsection Exporting and converting to other formats
11190 The @acronym{ODT} exporter adds support for exporting Org outlines to formats
11191 that are not supported natively by Org. It also adds support to convert
11192 document from one format to another. To use these features, you need to
11193 configure a command-line converter. Once a command-line converter is
11194 configured you can use it to extend the list of formats to which Org can
11195 export. @xref{x-export-to-other-formats,,Automatically exporting to other
11196 formats}. You can also use it to perform one-off document conversion as
11199 @vindex org-export-odt-convert
11202 @item M-x org-export-odt-convert
11203 Convert an existing document from one format to another as determined by the
11204 variable @code{org-export-odt-convert-capabilities}
11205 (@pxref{x-odt-converter-capabilities,,Configure converter
11206 capabilities}). @strong{Please note} that you can use this command to even
11207 convert documents that are produced outside of Org and in other formats than
11208 @acronym{ODT} format.
11211 @subsubheading Pre-configured converters
11214 The @acronym{ODT} exporter supports two converters out of the box:
11218 @cindex @file{unoconv}
11219 @item @file{unoconv}
11221 This converter is available as an installable package in your favorite
11224 @cindex @file{BasicODConverter}
11225 @item @file{BasicODConverter}
11227 @vindex org-odt-data-dir
11228 This converter is distributed as a LibreOffice extension and can be found in
11229 your Org distribution. See the subdirectory pointed to by the variable
11230 @code{org-odt-data-dir}.
11234 @subsubheading Installing a new converter
11235 If you prefer to use a converter other than the two mentioned above, then you
11236 may have to do additional configuration. You can proceed as follows:
11239 @item Register the converter
11241 @vindex org-export-odt-convert-processes
11242 Name your converter and add it to the list of known converters by customizing
11243 the variable @code{org-export-odt-convert-processes}. Also specify how the
11244 converter can be invoked via command-line to effect the conversion.
11246 @item Configure its capabilities
11247 @vindex org-export-odt-convert-capabilities
11249 @anchor{x-odt-converter-capabilities}
11251 Specify the set of formats the converter can handle by customizing the
11252 variable @code{org-export-odt-convert-capabilities}. Use the default value
11253 for this variable as a guide for configuring your converter. As suggested by
11254 the default setting, you can specify the full set of formats supported by the
11255 converter and not limit yourself to specifying formats that are related to
11256 just the OpenDocument Text format.
11258 @item Choose the converter
11260 @vindex org-export-odt-convert-process
11261 Select the newly added converter as the preferred one by customizing the
11262 variable @code{org-export-odt-convert-process}.
11265 @node Working with OpenDocument style files, Creating one-off styles, Exporting and converting to other formats, Advanced topics in @acronym{ODT} export
11266 @subsubsection Working with OpenDocument style files
11267 @cindex styles, custom
11268 @cindex template, custom
11270 This section explores the internals of the @acronym{ODT} exporter and the
11271 means by which it produces styled documents. Read this section if you are
11272 interested in exploring the automatic and custom OpenDocument styles used by
11275 @anchor{x-factory-styles}
11276 @subsubheading Factory styles
11278 The @acronym{ODT} exporter relies on two files for generating its output.
11279 These files are bundled with the distribution under the directory pointed to
11280 by the variable @code{org-odt-styles-dir}. The two files are:
11283 @anchor{x-orgodtstyles-xml}
11285 @file{OrgOdtStyles.xml}
11287 This file contributes to the @file{styles.xml} file of the final @samp{ODT}
11288 document. This file gets modified for the following purposes:
11292 To control outline numbering based on user settings.
11295 To add styles generated by @file{htmlfontify.el} for fontification of code
11299 @anchor{x-orgodtcontenttemplate-xml}
11301 @file{OrgOdtContentTemplate.xml}
11303 This file contributes to the @file{content.xml} file of the final @samp{ODT}
11304 document. The contents of the Org outline are inserted between the
11305 @samp{<office:text>}@dots{}@samp{</office:text>} elements of this file.
11307 Apart from serving as a template file for the final @file{content.xml}, the
11308 file serves the following purposes:
11312 It contains automatic styles for formatting of tables which are referenced by
11316 It contains @samp{<text:sequence-decl>}@dots{}@samp{</text:sequence-decl>}
11317 elements that control how various entities - tables, images, equations etc -
11322 @anchor{x-overriding-factory-styles}
11323 @subsubheading Overriding factory styles
11324 The following two variables control the location from which the @acronym{ODT}
11325 exporter picks up the custom styles and content template files. You can
11326 customize these variables to override the factory styles used by the
11330 @anchor{x-org-export-odt-styles-file}
11332 @code{org-export-odt-styles-file}
11334 Use this variable to specify the @file{styles.xml} that will be used in the
11335 final output. You can specify one of the following values:
11338 @item A @file{styles.xml} file
11340 Use this file instead of the default @file{styles.xml}
11342 @item A @file{.odt} or @file{.ott} file
11344 Use the @file{styles.xml} contained in the specified OpenDocument Text or
11347 @item A @file{.odt} or @file{.ott} file and a subset of files contained within them
11349 Use the @file{styles.xml} contained in the specified OpenDocument Text or
11350 Template file. Additionally extract the specified member files and embed
11351 those within the final @samp{ODT} document.
11353 Use this option if the @file{styles.xml} file references additional files
11354 like header and footer images.
11358 Use the default @file{styles.xml}
11361 @anchor{x-org-export-odt-content-template-file}
11363 @code{org-export-odt-content-template-file}
11365 Use this variable to specify the blank @file{content.xml} that will be used
11366 in the final output.
11369 @node Creating one-off styles, Customizing tables in @acronym{ODT} export, Working with OpenDocument style files, Advanced topics in @acronym{ODT} export
11370 @subsubsection Creating one-off styles
11372 There are times when you would want one-off formatting in the exported
11373 document. You can achieve this by embedding raw OpenDocument XML in the Org
11374 file. The use of this feature is better illustrated with couple of examples.
11377 @item Embedding ODT tags as part of regular text
11379 You can include simple OpenDocument tags by prefixing them with
11380 @samp{@@}. For example, to highlight a region of text do the following:
11383 @@<text:span text:style-name="Highlight">This is a
11384 highlighted text@@</text:span>. But this is a
11388 @strong{Hint:} To see the above example in action, edit your
11389 @file{styles.xml}(@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
11390 custom @samp{Highlight} style as shown below.
11393 <style:style style:name="Highlight" style:family="text">
11394 <style:text-properties fo:background-color="#ff0000"/>
11398 @item Embedding a one-line OpenDocument XML
11400 You can add a simple OpenDocument one-liner using the @code{#+ODT:}
11401 directive. For example, to force a page break do the following:
11404 #+ODT: <text:p text:style-name="PageBreak"/>
11407 @strong{Hint:} To see the above example in action, edit your
11408 @file{styles.xml}(@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
11409 custom @samp{PageBreak} style as shown below.
11412 <style:style style:name="PageBreak" style:family="paragraph"
11413 style:parent-style-name="Text_20_body">
11414 <style:paragraph-properties fo:break-before="page"/>
11418 @item Embedding a block of OpenDocument XML
11420 You can add a large block of OpenDocument XML using the
11421 @code{#+BEGIN_ODT}@dots{}@code{#+END_ODT} construct.
11423 For example, to create a one-off paragraph that uses bold text, do the
11428 <text:p text:style-name="Text_20_body_20_bold">
11429 This paragraph is specially formatted and uses bold text.
11436 @node Customizing tables in @acronym{ODT} export, Validating OpenDocument XML, Creating one-off styles, Advanced topics in @acronym{ODT} export
11437 @subsubsection Customizing tables in @acronym{ODT} export
11438 @cindex tables, in ODT export
11441 You can override the default formatting of the table by specifying a custom
11442 table style with the @code{#+ATTR_ODT} line. For a discussion on default
11443 formatting of tables @pxref{Tables in @acronym{ODT} export}.
11445 This feature closely mimics the way table templates are defined in the
11447 specification.@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
11448 OpenDocument-v1.2 Specification}}
11452 @subsubheading Custom table styles - an illustration
11454 To have a quick preview of this feature, install the below setting and export
11455 the table that follows.
11458 (setq org-export-odt-table-styles
11459 (append org-export-odt-table-styles
11460 '(("TableWithHeaderRowAndColumn" "Custom"
11461 ((use-first-row-styles . t)
11462 (use-first-column-styles . t)))
11463 ("TableWithFirstRowandLastRow" "Custom"
11464 ((use-first-row-styles . t)
11465 (use-last-row-styles . t))))))
11469 #+ATTR_ODT: TableWithHeaderRowAndColumn
11470 | Name | Phone | Age |
11471 | Peter | 1234 | 17 |
11472 | Anna | 4321 | 25 |
11475 In the above example, you used a template named @samp{Custom} and installed
11476 two table styles with the names @samp{TableWithHeaderRowAndColumn} and
11477 @samp{TableWithFirstRowandLastRow}. (@strong{Important:} The OpenDocument
11478 styles needed for producing the above template have been pre-defined for you.
11479 These styles are available under the section marked @samp{Custom Table
11480 Template} in @file{OrgOdtContentTemplate.xml}
11481 (@pxref{x-orgodtcontenttemplate-xml,,Factory styles}). If you need
11482 additional templates you have to define these styles yourselves.
11484 @subsubheading Custom table styles - the nitty-gritty
11485 To use this feature proceed as follows:
11489 Create a table template@footnote{See the @code{<table:table-template>}
11490 element of the OpenDocument-v1.2 specification}
11492 A table template is nothing but a set of @samp{table-cell} and
11493 @samp{paragraph} styles for each of the following table cell categories:
11507 The names for the above styles must be chosen based on the name of the table
11508 template using a well-defined convention.
11510 The naming convention is better illustrated with an example. For a table
11511 template with the name @samp{Custom}, the needed style names are listed in
11512 the following table.
11514 @multitable {Table cell type} {CustomEvenColumnTableCell} {CustomEvenColumnTableParagraph}
11515 @headitem Table cell type
11516 @tab @code{table-cell} style
11517 @tab @code{paragraph} style
11522 @tab @samp{CustomTableCell}
11523 @tab @samp{CustomTableParagraph}
11525 @tab @samp{CustomFirstColumnTableCell}
11526 @tab @samp{CustomFirstColumnTableParagraph}
11528 @tab @samp{CustomLastColumnTableCell}
11529 @tab @samp{CustomLastColumnTableParagraph}
11531 @tab @samp{CustomFirstRowTableCell}
11532 @tab @samp{CustomFirstRowTableParagraph}
11534 @tab @samp{CustomLastRowTableCell}
11535 @tab @samp{CustomLastRowTableParagraph}
11537 @tab @samp{CustomEvenRowTableCell}
11538 @tab @samp{CustomEvenRowTableParagraph}
11540 @tab @samp{CustomOddRowTableCell}
11541 @tab @samp{CustomOddRowTableParagraph}
11543 @tab @samp{CustomEvenColumnTableCell}
11544 @tab @samp{CustomEvenColumnTableParagraph}
11546 @tab @samp{CustomOddColumnTableCell}
11547 @tab @samp{CustomOddColumnTableParagraph}
11550 To create a table template with the name @samp{Custom}, define the above
11552 @code{<office:automatic-styles>}...@code{</office:automatic-styles>} element
11553 of the content template file (@pxref{x-orgodtcontenttemplate-xml,,Factory
11557 Define a table style@footnote{See the attributes @code{table:template-name},
11558 @code{table:use-first-row-styles}, @code{table:use-last-row-styles},
11559 @code{table:use-first-column-styles}, @code{table:use-last-column-styles},
11560 @code{table:use-banding-rows-styles}, and
11561 @code{table:use-banding-column-styles} of the @code{<table:table>} element in
11562 the OpenDocument-v1.2 specification}
11564 @vindex org-export-odt-table-styles
11565 To define a table style, create an entry for the style in the variable
11566 @code{org-export-odt-table-styles} and specify the following:
11569 @item the name of the table template created in step (1)
11570 @item the set of cell styles in that template that are to be activated
11573 For example, the entry below defines two different table styles
11574 @samp{TableWithHeaderRowsAndColumns} and @samp{TableWithHeaderColumns} based
11575 on the same template @samp{Custom}. The styles achieve their intended effect
11576 by selectively activating the individual cell styles in that template.
11579 (setq org-export-odt-table-styles
11580 (append org-export-odt-table-styles
11581 '(("TableWithHeaderRowAndColumn" "Custom"
11582 ((use-first-row-styles . t)
11583 (use-first-column-styles . t)))
11584 ("TableWithFirstRowandLastRow" "Custom"
11585 ((use-first-row-styles . t)
11586 (use-last-row-styles . t))))))
11590 Associate a table with the table style
11592 To do this, specify the table style created in step (2) as part of
11593 the @code{ATTR_ODT} line as shown below.
11596 #+ATTR_ODT: TableWithHeaderRowAndColumn
11597 | Name | Phone | Age |
11598 | Peter | 1234 | 17 |
11599 | Anna | 4321 | 25 |
11603 @node Validating OpenDocument XML, , Customizing tables in @acronym{ODT} export, Advanced topics in @acronym{ODT} export
11604 @subsubsection Validating OpenDocument XML
11606 Occasionally, you will discover that the document created by the
11607 @acronym{ODT} exporter cannot be opened by your favorite application. One of
11608 the common reasons for this is that the @file{.odt} file is corrupt. In such
11609 cases, you may want to validate the document against the OpenDocument RELAX
11610 NG Compact Syntax (RNC) schema.
11612 For de-compressing the @file{.odt} file@footnote{@file{.odt} files are
11613 nothing but @samp{zip} archives}: @inforef{File Archives,,emacs}. For
11614 general help with validation (and schema-sensitive editing) of XML files:
11615 @inforef{Introduction,,nxml-mode}.
11617 @vindex org-export-odt-schema-dir
11618 If you have ready access to OpenDocument @file{.rnc} files and the needed
11619 schema-locating rules in a single folder, you can customize the variable
11620 @code{org-export-odt-schema-dir} to point to that directory. The
11621 @acronym{ODT} exporter will take care of updating the
11622 @code{rng-schema-locating-files} for you.
11624 @c end opendocument
11626 @node TaskJuggler export, Freemind export, OpenDocument Text export, Exporting
11627 @section TaskJuggler export
11628 @cindex TaskJuggler export
11629 @cindex Project management
11631 @uref{http://www.taskjuggler.org/, TaskJuggler} is a project management tool.
11632 It provides an optimizing scheduler that computes your project time lines and
11633 resource assignments based on the project outline and the constraints that
11636 The TaskJuggler exporter is a bit different from other exporters, such as the
11637 @code{HTML} and @LaTeX{} exporters for example, in that it does not export all the
11638 nodes of a document or strictly follow the order of the nodes in the
11641 Instead the TaskJuggler exporter looks for a tree that defines the tasks and
11642 a optionally tree that defines the resources for this project. It then
11643 creates a TaskJuggler file based on these trees and the attributes defined in
11646 @subsection TaskJuggler export commands
11649 @orgcmd{C-c C-e j,org-export-as-taskjuggler}
11650 Export as TaskJuggler file.
11652 @orgcmd{C-c C-e J,org-export-as-taskjuggler-and-open}
11653 Export as TaskJuggler file and then open the file with TaskJugglerUI.
11658 @vindex org-export-taskjuggler-project-tag
11659 Create your tasks as you usually do with Org mode. Assign efforts to each
11660 task using properties (it is easiest to do this in the column view). You
11661 should end up with something similar to the example by Peter Jones in
11662 @url{http://www.contextualdevelopment.com/static/artifacts/articles/2008/project-planning/project-planning.org}.
11663 Now mark the top node of your tasks with a tag named
11664 @code{:taskjuggler_project:} (or whatever you customized
11665 @code{org-export-taskjuggler-project-tag} to). You are now ready to export
11666 the project plan with @kbd{C-c C-e J} which will export the project plan and
11667 open a gantt chart in TaskJugglerUI.
11669 @subsection Resources
11671 @vindex org-export-taskjuggler-resource-tag
11672 Next you can define resources and assign those to work on specific tasks. You
11673 can group your resources hierarchically. Tag the top node of the resources
11674 with @code{:taskjuggler_resource:} (or whatever you customized
11675 @code{org-export-taskjuggler-resource-tag} to). You can optionally assign an
11676 identifier (named @samp{resource_id}) to the resources (using the standard
11677 Org properties commands, @pxref{Property syntax}) or you can let the exporter
11678 generate identifiers automatically (the exporter picks the first word of the
11679 headline as the identifier as long as it is unique---see the documentation of
11680 @code{org-taskjuggler-get-unique-id}). Using that identifier you can then
11681 allocate resources to tasks. This is again done with the @samp{allocate}
11682 property on the tasks. Do this in column view or when on the task type
11683 @kbd{C-c C-x p allocate @key{RET} <resource_id> @key{RET}}.
11685 Once the allocations are done you can again export to TaskJuggler and check
11686 in the Resource Allocation Graph which person is working on what task at what
11689 @subsection Export of properties
11691 The exporter also takes TODO state information into consideration, i.e.@: if a
11692 task is marked as done it will have the corresponding attribute in
11693 TaskJuggler (@samp{complete 100}). Also it will export any property on a task
11694 resource or resource node which is known to TaskJuggler, such as
11695 @samp{limits}, @samp{vacation}, @samp{shift}, @samp{booking},
11696 @samp{efficiency}, @samp{journalentry}, @samp{rate} for resources or
11697 @samp{account}, @samp{start}, @samp{note}, @samp{duration}, @samp{end},
11698 @samp{journalentry}, @samp{milestone}, @samp{reference}, @samp{responsible},
11699 @samp{scheduling}, etc for tasks.
11701 @subsection Dependencies
11703 The exporter will handle dependencies that are defined in the tasks either
11704 with the @samp{ORDERED} attribute (@pxref{TODO dependencies}), with the
11705 @samp{BLOCKER} attribute (see @file{org-depend.el}) or alternatively with a
11706 @samp{depends} attribute. Both the @samp{BLOCKER} and the @samp{depends}
11707 attribute can be either @samp{previous-sibling} or a reference to an
11708 identifier (named @samp{task_id}) which is defined for another task in the
11709 project. @samp{BLOCKER} and the @samp{depends} attribute can define multiple
11710 dependencies separated by either space or comma. You can also specify
11711 optional attributes on the dependency by simply appending it. The following
11712 examples should illustrate this:
11717 :task_id: preparation
11720 * Training material
11722 :task_id: training_material
11725 ** Markup Guidelines
11729 ** Workflow Guidelines
11736 :BLOCKER: training_material @{ gapduration 1d @} preparation
11740 @subsection Reports
11742 @vindex org-export-taskjuggler-default-reports
11743 TaskJuggler can produce many kinds of reports (e.g.@: gantt chart, resource
11744 allocation, etc). The user defines what kind of reports should be generated
11745 for a project in the TaskJuggler file. The exporter will automatically insert
11746 some default reports in the file. These defaults are defined in
11747 @code{org-export-taskjuggler-default-reports}. They can be modified using
11748 customize along with a number of other options. For a more complete list, see
11749 @kbd{M-x customize-group @key{RET} org-export-taskjuggler @key{RET}}.
11751 For more information and examples see the Org-taskjuggler tutorial at
11752 @uref{http://orgmode.org/worg/org-tutorials/org-taskjuggler.html}.
11754 @node Freemind export, XOXO export, TaskJuggler export, Exporting
11755 @section Freemind export
11756 @cindex Freemind export
11759 The Freemind exporter was written by Lennart Borgman.
11762 @orgcmd{C-c C-e m,org-export-as-freemind}
11763 Export as Freemind mind map. For an Org file @file{myfile.org}, the Freemind
11764 file will be @file{myfile.mm}.
11767 @node XOXO export, iCalendar export, Freemind export, Exporting
11768 @section XOXO export
11769 @cindex XOXO export
11771 Org mode contains an exporter that produces XOXO-style output.
11772 Currently, this exporter only handles the general outline structure and
11773 does not interpret any additional Org mode features.
11776 @orgcmd{C-c C-e x,org-export-as-xoxo}
11777 Export as XOXO file. For an Org file @file{myfile.org}, the XOXO file will be
11778 @file{myfile.html}.
11779 @orgkey{C-c C-e v x}
11780 Export only the visible part of the document.
11783 @node iCalendar export, , XOXO export, Exporting
11784 @section iCalendar export
11785 @cindex iCalendar export
11787 @vindex org-icalendar-include-todo
11788 @vindex org-icalendar-use-deadline
11789 @vindex org-icalendar-use-scheduled
11790 @vindex org-icalendar-categories
11791 @vindex org-icalendar-alarm-time
11792 Some people use Org mode for keeping track of projects, but still prefer a
11793 standard calendar application for anniversaries and appointments. In this
11794 case it can be useful to show deadlines and other time-stamped items in Org
11795 files in the calendar application. Org mode can export calendar information
11796 in the standard iCalendar format. If you also want to have TODO entries
11797 included in the export, configure the variable
11798 @code{org-icalendar-include-todo}. Plain timestamps are exported as VEVENT,
11799 and TODO items as VTODO. It will also create events from deadlines that are
11800 in non-TODO items. Deadlines and scheduling dates in TODO items will be used
11801 to set the start and due dates for the TODO entry@footnote{See the variables
11802 @code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}.
11803 As categories, it will use the tags locally defined in the heading, and the
11804 file/tree category@footnote{To add inherited tags or the TODO state,
11805 configure the variable @code{org-icalendar-categories}.}. See the variable
11806 @code{org-icalendar-alarm-time} for a way to assign alarms to entries with a
11809 @vindex org-icalendar-store-UID
11810 @cindex property, ID
11811 The iCalendar standard requires each entry to have a globally unique
11812 identifier (UID). Org creates these identifiers during export. If you set
11813 the variable @code{org-icalendar-store-UID}, the UID will be stored in the
11814 @code{:ID:} property of the entry and re-used next time you report this
11815 entry. Since a single entry can give rise to multiple iCalendar entries (as
11816 a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
11817 prefixes to the UID, depending on what triggered the inclusion of the entry.
11818 In this way the UID remains unique, but a synchronization program can still
11819 figure out from which entry all the different instances originate.
11822 @orgcmd{C-c C-e i,org-export-icalendar-this-file}
11823 Create iCalendar entries for the current file and store them in the same
11824 directory, using a file extension @file{.ics}.
11825 @orgcmd{C-c C-e I, org-export-icalendar-all-agenda-files}
11826 @vindex org-agenda-files
11827 Like @kbd{C-c C-e i}, but do this for all files in
11828 @code{org-agenda-files}. For each of these files, a separate iCalendar
11829 file will be written.
11830 @orgcmd{C-c C-e c,org-export-icalendar-combine-agenda-files}
11831 @vindex org-combined-agenda-icalendar-file
11832 Create a single large iCalendar file from all files in
11833 @code{org-agenda-files} and write it to the file given by
11834 @code{org-combined-agenda-icalendar-file}.
11837 @vindex org-use-property-inheritance
11838 @vindex org-icalendar-include-body
11839 @cindex property, SUMMARY
11840 @cindex property, DESCRIPTION
11841 @cindex property, LOCATION
11842 The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION
11843 property can be inherited from higher in the hierarchy if you configure
11844 @code{org-use-property-inheritance} accordingly.} properties if the selected
11845 entries have them. If not, the summary will be derived from the headline,
11846 and the description from the body (limited to
11847 @code{org-icalendar-include-body} characters).
11849 How this calendar is best read and updated, depends on the application
11850 you are using. The FAQ covers this issue.
11852 @node Publishing, Working With Source Code, Exporting, Top
11853 @chapter Publishing
11856 Org includes a publishing management system that allows you to configure
11857 automatic HTML conversion of @emph{projects} composed of interlinked org
11858 files. You can also configure Org to automatically upload your exported HTML
11859 pages and related attachments, such as images and source code files, to a web
11862 You can also use Org to convert files into PDF, or even combine HTML and PDF
11863 conversion so that files are available in both formats on the server.
11865 Publishing has been contributed to Org by David O'Toole.
11868 * Configuration:: Defining projects
11869 * Uploading files:: How to get files up on the server
11870 * Sample configuration:: Example projects
11871 * Triggering publication:: Publication commands
11874 @node Configuration, Uploading files, Publishing, Publishing
11875 @section Configuration
11877 Publishing needs significant configuration to specify files, destination
11878 and many other properties of a project.
11881 * Project alist:: The central configuration variable
11882 * Sources and destinations:: From here to there
11883 * Selecting files:: What files are part of the project?
11884 * Publishing action:: Setting the function doing the publishing
11885 * Publishing options:: Tweaking HTML/@LaTeX{} export
11886 * Publishing links:: Which links keep working after publishing?
11887 * Sitemap:: Generating a list of all pages
11888 * Generating an index:: An index that reaches across pages
11891 @node Project alist, Sources and destinations, Configuration, Configuration
11892 @subsection The variable @code{org-publish-project-alist}
11893 @cindex org-publish-project-alist
11894 @cindex projects, for publishing
11896 @vindex org-publish-project-alist
11897 Publishing is configured almost entirely through setting the value of one
11898 variable, called @code{org-publish-project-alist}. Each element of the list
11899 configures one project, and may be in one of the two following forms:
11902 ("project-name" :property value :property value ...)
11903 @r{i.e.@: a well-formed property list with alternating keys and values}
11905 ("project-name" :components ("project-name" "project-name" ...))
11909 In both cases, projects are configured by specifying property values. A
11910 project defines the set of files that will be published, as well as the
11911 publishing configuration to use when publishing those files. When a project
11912 takes the second form listed above, the individual members of the
11913 @code{:components} property are taken to be sub-projects, which group
11914 together files requiring different publishing options. When you publish such
11915 a ``meta-project'', all the components will also be published, in the
11918 @node Sources and destinations, Selecting files, Project alist, Configuration
11919 @subsection Sources and destinations for files
11920 @cindex directories, for publishing
11922 Most properties are optional, but some should always be set. In
11923 particular, Org needs to know where to look for source files,
11924 and where to put published files.
11926 @multitable @columnfractions 0.3 0.7
11927 @item @code{:base-directory}
11928 @tab Directory containing publishing source files
11929 @item @code{:publishing-directory}
11930 @tab Directory where output files will be published. You can directly
11931 publish to a webserver using a file name syntax appropriate for
11932 the Emacs @file{tramp} package. Or you can publish to a local directory and
11933 use external tools to upload your website (@pxref{Uploading files}).
11934 @item @code{:preparation-function}
11935 @tab Function or list of functions to be called before starting the
11936 publishing process, for example, to run @code{make} for updating files to be
11937 published. The project property list is scoped into this call as the
11938 variable @code{project-plist}.
11939 @item @code{:completion-function}
11940 @tab Function or list of functions called after finishing the publishing
11941 process, for example, to change permissions of the resulting files. The
11942 project property list is scoped into this call as the variable
11943 @code{project-plist}.
11947 @node Selecting files, Publishing action, Sources and destinations, Configuration
11948 @subsection Selecting files
11949 @cindex files, selecting for publishing
11951 By default, all files with extension @file{.org} in the base directory
11952 are considered part of the project. This can be modified by setting the
11954 @multitable @columnfractions 0.25 0.75
11955 @item @code{:base-extension}
11956 @tab Extension (without the dot!) of source files. This actually is a
11957 regular expression. Set this to the symbol @code{any} if you want to get all
11958 files in @code{:base-directory}, even without extension.
11960 @item @code{:exclude}
11961 @tab Regular expression to match file names that should not be
11962 published, even though they have been selected on the basis of their
11965 @item @code{:include}
11966 @tab List of files to be included regardless of @code{:base-extension}
11967 and @code{:exclude}.
11969 @item @code{:recursive}
11970 @tab Non-nil means, check base-directory recursively for files to publish.
11973 @node Publishing action, Publishing options, Selecting files, Configuration
11974 @subsection Publishing action
11975 @cindex action, for publishing
11977 Publishing means that a file is copied to the destination directory and
11978 possibly transformed in the process. The default transformation is to export
11979 Org files as HTML files, and this is done by the function
11980 @code{org-publish-org-to-html} which calls the HTML exporter (@pxref{HTML
11981 export}). But you also can publish your content as PDF files using
11982 @code{org-publish-org-to-pdf}, or as @code{ascii}, @code{latin1} or
11983 @code{utf8} encoded files using the corresponding functions. If you want to
11984 publish the Org file itself, but with @i{archived}, @i{commented}, and
11985 @i{tag-excluded} trees removed, use @code{org-publish-org-to-org} and set the
11986 parameters @code{:plain-source} and/or @code{:htmlized-source}. This will
11987 produce @file{file.org} and @file{file.org.html} in the publishing
11988 directory@footnote{@file{file-source.org} and @file{file-source.org.html} if
11989 source and publishing directories are equal. Note that with this kind of
11990 setup, you need to add @code{:exclude "-source\\.org"} to the project
11991 definition in @code{org-publish-project-alist} to prevent the published
11992 source files from being considered as new org files the next time the project
11993 is published.}. Other files like images only need to be copied to the
11994 publishing destination; for this you may use @code{org-publish-attachment}.
11995 For non-Org files, you always need to specify the publishing function:
11997 @multitable @columnfractions 0.3 0.7
11998 @item @code{:publishing-function}
11999 @tab Function executing the publication of a file. This may also be a
12000 list of functions, which will all be called in turn.
12001 @item @code{:plain-source}
12002 @tab Non-nil means, publish plain source.
12003 @item @code{:htmlized-source}
12004 @tab Non-nil means, publish htmlized source.
12007 The function must accept three arguments: a property list containing at least
12008 a @code{:publishing-directory} property, the name of the file to be
12009 published, and the path to the publishing directory of the output file. It
12010 should take the specified file, make the necessary transformation (if any)
12011 and place the result into the destination folder.
12013 @node Publishing options, Publishing links, Publishing action, Configuration
12014 @subsection Options for the HTML/@LaTeX{} exporters
12015 @cindex options, for publishing
12017 The property list can be used to set many export options for the HTML
12018 and @LaTeX{} exporters. In most cases, these properties correspond to user
12019 variables in Org. The table below lists these properties along
12020 with the variable they belong to. See the documentation string for the
12021 respective variable for details.
12023 @vindex org-export-html-link-up
12024 @vindex org-export-html-link-home
12025 @vindex org-export-default-language
12026 @vindex org-display-custom-times
12027 @vindex org-export-headline-levels
12028 @vindex org-export-with-section-numbers
12029 @vindex org-export-section-number-format
12030 @vindex org-export-with-toc
12031 @vindex org-export-preserve-breaks
12032 @vindex org-export-with-archived-trees
12033 @vindex org-export-with-emphasize
12034 @vindex org-export-with-sub-superscripts
12035 @vindex org-export-with-special-strings
12036 @vindex org-export-with-footnotes
12037 @vindex org-export-with-drawers
12038 @vindex org-export-with-tags
12039 @vindex org-export-with-todo-keywords
12040 @vindex org-export-with-tasks
12041 @vindex org-export-with-done-tasks
12042 @vindex org-export-with-priority
12043 @vindex org-export-with-TeX-macros
12044 @vindex org-export-with-LaTeX-fragments
12045 @vindex org-export-skip-text-before-1st-heading
12046 @vindex org-export-with-fixed-width
12047 @vindex org-export-with-timestamps
12048 @vindex org-export-author-info
12049 @vindex org-export-email-info
12050 @vindex org-export-creator-info
12051 @vindex org-export-time-stamp-file
12052 @vindex org-export-with-tables
12053 @vindex org-export-highlight-first-table-line
12054 @vindex org-export-html-style-include-default
12055 @vindex org-export-html-style-include-scripts
12056 @vindex org-export-html-style
12057 @vindex org-export-html-style-extra
12058 @vindex org-export-html-link-org-files-as-html
12059 @vindex org-export-html-inline-images
12060 @vindex org-export-html-extension
12061 @vindex org-export-html-table-tag
12062 @vindex org-export-html-expand
12063 @vindex org-export-html-with-timestamp
12064 @vindex org-export-publishing-directory
12065 @vindex org-export-html-preamble
12066 @vindex org-export-html-postamble
12067 @vindex user-full-name
12068 @vindex user-mail-address
12069 @vindex org-export-select-tags
12070 @vindex org-export-exclude-tags
12072 @multitable @columnfractions 0.32 0.68
12073 @item @code{:link-up} @tab @code{org-export-html-link-up}
12074 @item @code{:link-home} @tab @code{org-export-html-link-home}
12075 @item @code{:language} @tab @code{org-export-default-language}
12076 @item @code{:customtime} @tab @code{org-display-custom-times}
12077 @item @code{:headline-levels} @tab @code{org-export-headline-levels}
12078 @item @code{:section-numbers} @tab @code{org-export-with-section-numbers}
12079 @item @code{:section-number-format} @tab @code{org-export-section-number-format}
12080 @item @code{:table-of-contents} @tab @code{org-export-with-toc}
12081 @item @code{:preserve-breaks} @tab @code{org-export-preserve-breaks}
12082 @item @code{:archived-trees} @tab @code{org-export-with-archived-trees}
12083 @item @code{:emphasize} @tab @code{org-export-with-emphasize}
12084 @item @code{:sub-superscript} @tab @code{org-export-with-sub-superscripts}
12085 @item @code{:special-strings} @tab @code{org-export-with-special-strings}
12086 @item @code{:footnotes} @tab @code{org-export-with-footnotes}
12087 @item @code{:drawers} @tab @code{org-export-with-drawers}
12088 @item @code{:tags} @tab @code{org-export-with-tags}
12089 @item @code{:todo-keywords} @tab @code{org-export-with-todo-keywords}
12090 @item @code{:tasks} @tab @code{org-export-with-tasks}
12091 @item @code{:priority} @tab @code{org-export-with-priority}
12092 @item @code{:TeX-macros} @tab @code{org-export-with-TeX-macros}
12093 @item @code{:LaTeX-fragments} @tab @code{org-export-with-LaTeX-fragments}
12094 @item @code{:latex-listings} @tab @code{org-export-latex-listings}
12095 @item @code{:skip-before-1st-heading} @tab @code{org-export-skip-text-before-1st-heading}
12096 @item @code{:fixed-width} @tab @code{org-export-with-fixed-width}
12097 @item @code{:timestamps} @tab @code{org-export-with-timestamps}
12098 @item @code{:author} @tab @code{user-full-name}
12099 @item @code{:email} @tab @code{user-mail-address} : @code{addr;addr;..}
12100 @item @code{:author-info} @tab @code{org-export-author-info}
12101 @item @code{:email-info} @tab @code{org-export-email-info}
12102 @item @code{:creator-info} @tab @code{org-export-creator-info}
12103 @item @code{:tables} @tab @code{org-export-with-tables}
12104 @item @code{:table-auto-headline} @tab @code{org-export-highlight-first-table-line}
12105 @item @code{:style-include-default} @tab @code{org-export-html-style-include-default}
12106 @item @code{:style-include-scripts} @tab @code{org-export-html-style-include-scripts}
12107 @item @code{:style} @tab @code{org-export-html-style}
12108 @item @code{:style-extra} @tab @code{org-export-html-style-extra}
12109 @item @code{:convert-org-links} @tab @code{org-export-html-link-org-files-as-html}
12110 @item @code{:inline-images} @tab @code{org-export-html-inline-images}
12111 @item @code{:html-extension} @tab @code{org-export-html-extension}
12112 @item @code{:html-preamble} @tab @code{org-export-html-preamble}
12113 @item @code{:html-postamble} @tab @code{org-export-html-postamble}
12114 @item @code{:xml-declaration} @tab @code{org-export-html-xml-declaration}
12115 @item @code{:html-table-tag} @tab @code{org-export-html-table-tag}
12116 @item @code{:expand-quoted-html} @tab @code{org-export-html-expand}
12117 @item @code{:timestamp} @tab @code{org-export-html-with-timestamp}
12118 @item @code{:publishing-directory} @tab @code{org-export-publishing-directory}
12119 @item @code{:select-tags} @tab @code{org-export-select-tags}
12120 @item @code{:exclude-tags} @tab @code{org-export-exclude-tags}
12121 @item @code{:latex-image-options} @tab @code{org-export-latex-image-default-option}
12124 Most of the @code{org-export-with-*} variables have the same effect in
12125 both HTML and @LaTeX{} exporters, except for @code{:TeX-macros} and
12126 @code{:LaTeX-fragments} options, respectively @code{nil} and @code{t} in the
12127 @LaTeX{} export. See @code{org-export-plist-vars} to check this list of
12132 @vindex org-publish-project-alist
12133 When a property is given a value in @code{org-publish-project-alist},
12134 its setting overrides the value of the corresponding user variable (if
12135 any) during publishing. Options set within a file (@pxref{Export
12136 options}), however, override everything.
12138 @node Publishing links, Sitemap, Publishing options, Configuration
12139 @subsection Links between published files
12140 @cindex links, publishing
12142 To create a link from one Org file to another, you would use
12143 something like @samp{[[file:foo.org][The foo]]} or simply
12144 @samp{file:foo.org.} (@pxref{Hyperlinks}). When published, this link
12145 becomes a link to @file{foo.html}. In this way, you can interlink the
12146 pages of your "org web" project and the links will work as expected when
12147 you publish them to HTML. If you also publish the Org source file and want
12148 to link to that, use an @code{http:} link instead of a @code{file:} link,
12149 because @code{file:} links are converted to link to the corresponding
12152 You may also link to related files, such as images. Provided you are careful
12153 with relative file names, and provided you have also configured Org to upload
12154 the related files, these links will work too. See @ref{Complex example}, for
12155 an example of this usage.
12157 Sometimes an Org file to be published may contain links that are
12158 only valid in your production environment, but not in the publishing
12159 location. In this case, use the property
12161 @multitable @columnfractions 0.4 0.6
12162 @item @code{:link-validation-function}
12163 @tab Function to validate links
12167 to define a function for checking link validity. This function must
12168 accept two arguments, the file name and a directory relative to which
12169 the file name is interpreted in the production environment. If this
12170 function returns @code{nil}, then the HTML generator will only insert a
12171 description into the HTML file, but no link. One option for this
12172 function is @code{org-publish-validate-link} which checks if the given
12173 file is part of any project in @code{org-publish-project-alist}.
12175 @node Sitemap, Generating an index, Publishing links, Configuration
12176 @subsection Generating a sitemap
12177 @cindex sitemap, of published pages
12179 The following properties may be used to control publishing of
12180 a map of files for a given project.
12182 @multitable @columnfractions 0.35 0.65
12183 @item @code{:auto-sitemap}
12184 @tab When non-nil, publish a sitemap during @code{org-publish-current-project}
12185 or @code{org-publish-all}.
12187 @item @code{:sitemap-filename}
12188 @tab Filename for output of sitemap. Defaults to @file{sitemap.org} (which
12189 becomes @file{sitemap.html}).
12191 @item @code{:sitemap-title}
12192 @tab Title of sitemap page. Defaults to name of file.
12194 @item @code{:sitemap-function}
12195 @tab Plug-in function to use for generation of the sitemap.
12196 Defaults to @code{org-publish-org-sitemap}, which generates a plain list
12197 of links to all files in the project.
12199 @item @code{:sitemap-sort-folders}
12200 @tab Where folders should appear in the sitemap. Set this to @code{first}
12201 (default) or @code{last} to display folders first or last,
12202 respectively. Any other value will mix files and folders.
12204 @item @code{:sitemap-sort-files}
12205 @tab How the files are sorted in the site map. Set this to
12206 @code{alphabetically} (default), @code{chronologically} or
12207 @code{anti-chronologically}. @code{chronologically} sorts the files with
12208 older date first while @code{anti-chronologically} sorts the files with newer
12209 date first. @code{alphabetically} sorts the files alphabetically. The date of
12210 a file is retrieved with @code{org-publish-find-date}.
12212 @item @code{:sitemap-ignore-case}
12213 @tab Should sorting be case-sensitive? Default @code{nil}.
12215 @item @code{:sitemap-file-entry-format}
12216 @tab With this option one can tell how a sitemap's entry is formatted in the
12217 sitemap. This is a format string with some escape sequences: @code{%t} stands
12218 for the title of the file, @code{%a} stands for the author of the file and
12219 @code{%d} stands for the date of the file. The date is retrieved with the
12220 @code{org-publish-find-date} function and formatted with
12221 @code{org-publish-sitemap-date-format}. Default @code{%t}.
12223 @item @code{:sitemap-date-format}
12224 @tab Format string for the @code{format-time-string} function that tells how
12225 a sitemap entry's date is to be formatted. This property bypasses
12226 @code{org-publish-sitemap-date-format} which defaults to @code{%Y-%m-%d}.
12228 @item @code{:sitemap-sans-extension}
12229 @tab When non-nil, remove filenames' extensions from the generated sitemap.
12230 Useful to have cool URIs (see @uref{http://www.w3.org/Provider/Style/URI}).
12231 Defaults to @code{nil}.
12235 @node Generating an index, , Sitemap, Configuration
12236 @subsection Generating an index
12237 @cindex index, in a publishing project
12239 Org mode can generate an index across the files of a publishing project.
12241 @multitable @columnfractions 0.25 0.75
12242 @item @code{:makeindex}
12243 @tab When non-nil, generate in index in the file @file{theindex.org} and
12244 publish it as @file{theindex.html}.
12247 The file will be created when first publishing a project with the
12248 @code{:makeindex} set. The file only contains a statement @code{#+include:
12249 "theindex.inc"}. You can then build around this include statement by adding
12250 a title, style information, etc.
12252 @node Uploading files, Sample configuration, Configuration, Publishing
12253 @section Uploading files
12257 For those people already utilizing third party sync tools such as
12258 @command{rsync} or @command{unison}, it might be preferable not to use the built in
12259 @i{remote} publishing facilities of Org mode which rely heavily on
12260 Tramp. Tramp, while very useful and powerful, tends not to be
12261 so efficient for multiple file transfer and has been known to cause problems
12264 Specialized synchronization utilities offer several advantages. In addition
12265 to timestamp comparison, they also do content and permissions/attribute
12266 checks. For this reason you might prefer to publish your web to a local
12267 directory (possibly even @i{in place} with your Org files) and then use
12268 @file{unison} or @file{rsync} to do the synchronization with the remote host.
12270 Since Unison (for example) can be configured as to which files to transfer to
12271 a certain remote destination, it can greatly simplify the project publishing
12272 definition. Simply keep all files in the correct location, process your Org
12273 files with @code{org-publish} and let the synchronization tool do the rest.
12274 You do not need, in this scenario, to include attachments such as @file{jpg},
12275 @file{css} or @file{gif} files in the project definition since the 3rd party
12278 Publishing to a local directory is also much faster than to a remote one, so
12279 that you can afford more easily to republish entire projects. If you set
12280 @code{org-publish-use-timestamps-flag} to @code{nil}, you gain the main
12281 benefit of re-including any changed external files such as source example
12282 files you might include with @code{#+INCLUDE}. The timestamp mechanism in
12283 Org is not smart enough to detect if included files have been modified.
12285 @node Sample configuration, Triggering publication, Uploading files, Publishing
12286 @section Sample configuration
12288 Below we provide two example configurations. The first one is a simple
12289 project publishing only a set of Org files. The second example is
12290 more complex, with a multi-component project.
12293 * Simple example:: One-component publishing
12294 * Complex example:: A multi-component publishing example
12297 @node Simple example, Complex example, Sample configuration, Sample configuration
12298 @subsection Example: simple publishing configuration
12300 This example publishes a set of Org files to the @file{public_html}
12301 directory on the local machine.
12304 (setq org-publish-project-alist
12306 :base-directory "~/org/"
12307 :publishing-directory "~/public_html"
12308 :section-numbers nil
12309 :table-of-contents nil
12310 :style "<link rel=\"stylesheet\"
12311 href=\"../other/mystyle.css\"
12312 type=\"text/css\"/>")))
12315 @node Complex example, , Simple example, Sample configuration
12316 @subsection Example: complex publishing configuration
12318 This more complicated example publishes an entire website, including
12319 Org files converted to HTML, image files, Emacs Lisp source code, and
12320 style sheets. The publishing directory is remote and private files are
12323 To ensure that links are preserved, care should be taken to replicate
12324 your directory structure on the web server, and to use relative file
12325 paths. For example, if your Org files are kept in @file{~/org} and your
12326 publishable images in @file{~/images}, you would link to an image with
12329 file:../images/myimage.png
12332 On the web server, the relative path to the image should be the
12333 same. You can accomplish this by setting up an "images" folder in the
12334 right place on the web server, and publishing images to it.
12337 (setq org-publish-project-alist
12339 :base-directory "~/org/"
12340 :base-extension "org"
12341 :publishing-directory "/ssh:user@@host:~/html/notebook/"
12342 :publishing-function org-publish-org-to-html
12343 :exclude "PrivatePage.org" ;; regexp
12345 :section-numbers nil
12346 :table-of-contents nil
12347 :style "<link rel=\"stylesheet\"
12348 href=\"../other/mystyle.css\" type=\"text/css\"/>"
12352 :base-directory "~/images/"
12353 :base-extension "jpg\\|gif\\|png"
12354 :publishing-directory "/ssh:user@@host:~/html/images/"
12355 :publishing-function org-publish-attachment)
12358 :base-directory "~/other/"
12359 :base-extension "css\\|el"
12360 :publishing-directory "/ssh:user@@host:~/html/other/"
12361 :publishing-function org-publish-attachment)
12362 ("website" :components ("orgfiles" "images" "other"))))
12365 @node Triggering publication, , Sample configuration, Publishing
12366 @section Triggering publication
12368 Once properly configured, Org can publish with the following commands:
12371 @orgcmd{C-c C-e X,org-publish}
12372 Prompt for a specific project and publish all files that belong to it.
12373 @orgcmd{C-c C-e P,org-publish-current-project}
12374 Publish the project containing the current file.
12375 @orgcmd{C-c C-e F,org-publish-current-file}
12376 Publish only the current file.
12377 @orgcmd{C-c C-e E,org-publish-all}
12378 Publish every project.
12381 @vindex org-publish-use-timestamps-flag
12382 Org uses timestamps to track when a file has changed. The above functions
12383 normally only publish changed files. You can override this and force
12384 publishing of all files by giving a prefix argument to any of the commands
12385 above, or by customizing the variable @code{org-publish-use-timestamps-flag}.
12386 This may be necessary in particular if files include other files via
12387 @code{#+SETUPFILE:} or @code{#+INCLUDE:}.
12389 @comment node-name, next, previous, up
12390 @comment Working With Source Code, Miscellaneous, Publishing, Top
12392 @node Working With Source Code, Miscellaneous, Publishing, Top
12393 @chapter Working with source code
12394 @cindex Schulte, Eric
12395 @cindex Davison, Dan
12396 @cindex source code, working with
12398 Source code can be included in Org mode documents using a @samp{src} block,
12402 #+BEGIN_SRC emacs-lisp
12403 (defun org-xor (a b)
12409 Org mode provides a number of features for working with live source code,
12410 including editing of code blocks in their native major-mode, evaluation of
12411 code blocks, converting code blocks into source files (known as @dfn{tangling}
12412 in literate programming), and exporting code blocks and their
12413 results in several formats. This functionality was contributed by Eric
12414 Schulte and Dan Davison, and was originally named Org-babel.
12416 The following sections describe Org mode's code block handling facilities.
12419 * Structure of code blocks:: Code block syntax described
12420 * Editing source code:: Language major-mode editing
12421 * Exporting code blocks:: Export contents and/or results
12422 * Extracting source code:: Create pure source code files
12423 * Evaluating code blocks:: Place results of evaluation in the Org mode buffer
12424 * Library of Babel:: Use and contribute to a library of useful code blocks
12425 * Languages:: List of supported code block languages
12426 * Header arguments:: Configure code block functionality
12427 * Results of evaluation:: How evaluation results are handled
12428 * Noweb reference syntax:: Literate programming in Org mode
12429 * Key bindings and useful functions:: Work quickly with code blocks
12430 * Batch execution:: Call functions from the command line
12433 @comment node-name, next, previous, up
12434 @comment Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
12436 @node Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
12437 @section Structure of code blocks
12438 @cindex code block, structure
12439 @cindex source code, block structure
12441 @cindex #+BEGIN_SRC
12443 Live code blocks can be specified with a @samp{src} block or
12444 inline.@footnote{Note that @samp{src} blocks may be inserted using Org mode's
12445 @ref{Easy Templates} system} The structure of a @samp{src} block is
12449 #+BEGIN_SRC <language> <switches> <header arguments>
12454 The @code{#+NAME:} line is optional, and can be used to name the code
12455 block. Live code blocks require that a language be specified on the
12456 @code{#+BEGIN_SRC} line. Switches and header arguments are optional.
12457 @cindex source code, inline
12459 Live code blocks can also be specified inline using
12462 src_<language>@{<body>@}
12468 src_<language>[<header arguments>]@{<body>@}
12472 @item <#+NAME: name>
12473 This line associates a name with the code block. This is similar to the
12474 @code{#+TBLNAME: NAME} lines that can be used to name tables in Org mode
12475 files. Referencing the name of a code block makes it possible to evaluate
12476 the block from other places in the file, from other files, or from Org mode
12477 table formulas (see @ref{The spreadsheet}). Names are assumed to be unique
12478 and the behavior of Org mode when two or more blocks share the same name is
12482 The language of the code in the block (see @ref{Languages}).
12483 @cindex source code, language
12485 Optional switches control code block export (see the discussion of switches in
12486 @ref{Literal examples})
12487 @cindex source code, switches
12488 @item <header arguments>
12489 Optional header arguments control many aspects of evaluation, export and
12490 tangling of code blocks (see @ref{Header arguments}).
12491 Header arguments can also be set on a per-buffer or per-subtree
12492 basis using properties.
12493 @item source code, header arguments
12495 Source code in the specified language.
12498 @comment node-name, next, previous, up
12499 @comment Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
12501 @node Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
12502 @section Editing source code
12503 @cindex code block, editing
12504 @cindex source code, editing
12507 Use @kbd{C-c '} to edit the current code block. This brings up
12508 a language major-mode edit buffer containing the body of the code
12509 block. Saving this buffer will write the new contents back to the Org
12510 buffer. Use @kbd{C-c '} again to exit.
12512 The @code{org-src-mode} minor mode will be active in the edit buffer. The
12513 following variables can be used to configure the behavior of the edit
12514 buffer. See also the customization group @code{org-edit-structure} for
12515 further configuration options.
12518 @item org-src-lang-modes
12519 If an Emacs major-mode named @code{<lang>-mode} exists, where
12520 @code{<lang>} is the language named in the header line of the code block,
12521 then the edit buffer will be placed in that major-mode. This variable
12522 can be used to map arbitrary language names to existing major modes.
12523 @item org-src-window-setup
12524 Controls the way Emacs windows are rearranged when the edit buffer is created.
12525 @item org-src-preserve-indentation
12526 This variable is especially useful for tangling languages such as
12527 Python, in which whitespace indentation in the output is critical.
12528 @item org-src-ask-before-returning-to-edit-buffer
12529 By default, Org will ask before returning to an open edit buffer. Set this
12530 variable to nil to switch without asking.
12533 To turn on native code fontification in the @emph{Org} buffer, configure the
12534 variable @code{org-src-fontify-natively}.
12536 @comment node-name, next, previous, up
12537 @comment Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
12539 @node Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
12540 @section Exporting code blocks
12541 @cindex code block, exporting
12542 @cindex source code, exporting
12544 It is possible to export the @emph{code} of code blocks, the @emph{results}
12545 of code block evaluation, @emph{both} the code and the results of code block
12546 evaluation, or @emph{none}. For most languages, the default exports code.
12547 However, for some languages (e.g.@: @code{ditaa}) the default exports the
12548 results of code block evaluation. For information on exporting code block
12549 bodies, see @ref{Literal examples}.
12551 The @code{:exports} header argument can be used to specify export
12554 @subsubheading Header arguments:
12556 @item :exports code
12557 The default in most languages. The body of the code block is exported, as
12558 described in @ref{Literal examples}.
12559 @item :exports results
12560 The code block will be evaluated and the results will be placed in the
12561 Org mode buffer for export, either updating previous results of the code
12562 block located anywhere in the buffer or, if no previous results exist,
12563 placing the results immediately after the code block. The body of the code
12564 block will not be exported.
12565 @item :exports both
12566 Both the code block and its results will be exported.
12567 @item :exports none
12568 Neither the code block nor its results will be exported.
12571 It is possible to inhibit the evaluation of code blocks during export.
12572 Setting the @code{org-export-babel-evaluate} variable to @code{nil} will
12573 ensure that no code blocks are evaluated as part of the export process. This
12574 can be useful in situations where potentially untrusted Org mode files are
12575 exported in an automated fashion, for example when Org mode is used as the
12576 markup language for a wiki.
12578 @comment node-name, next, previous, up
12579 @comment Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
12580 @node Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
12581 @section Extracting source code
12583 @cindex source code, extracting
12584 @cindex code block, extracting source code
12586 Creating pure source code files by extracting code from source blocks is
12587 referred to as ``tangling''---a term adopted from the literate programming
12588 community. During ``tangling'' of code blocks their bodies are expanded
12589 using @code{org-babel-expand-src-block} which can expand both variable and
12590 ``noweb'' style references (see @ref{Noweb reference syntax}).
12592 @subsubheading Header arguments
12595 The default. The code block is not included in the tangled output.
12597 Include the code block in the tangled output. The output file name is the
12598 name of the org file with the extension @samp{.org} replaced by the extension
12599 for the block language.
12600 @item :tangle filename
12601 Include the code block in the tangled output to file @samp{filename}.
12605 @subsubheading Functions
12607 @item org-babel-tangle
12608 Tangle the current file. Bound to @kbd{C-c C-v t}.
12609 @item org-babel-tangle-file
12610 Choose a file to tangle. Bound to @kbd{C-c C-v f}.
12613 @subsubheading Hooks
12615 @item org-babel-post-tangle-hook
12616 This hook is run from within code files tangled by @code{org-babel-tangle}.
12617 Example applications could include post-processing, compilation or evaluation
12618 of tangled code files.
12621 @node Evaluating code blocks, Library of Babel, Extracting source code, Working With Source Code
12622 @section Evaluating code blocks
12623 @cindex code block, evaluating
12624 @cindex source code, evaluating
12626 Code blocks can be evaluated@footnote{Whenever code is evaluated there is a
12627 potential for that code to do harm. Org mode provides safeguards to ensure
12628 that code is only evaluated after explicit confirmation from the user. For
12629 information on these safeguards (and on how to disable them) see @ref{Code
12630 evaluation security}.} and the results of evaluation optionally placed in the
12631 Org mode buffer. By default, the evaluation facility is only enabled for
12632 Lisp code blocks specified as @code{emacs-lisp}. However, source code blocks
12633 in many languages can be evaluated within Org mode (see @ref{Languages} for a
12634 list of supported languages and @ref{Structure of code blocks} for
12635 information on the syntax used to define a code block).
12638 There are a number of ways to evaluate code blocks. The simplest is to press
12639 @kbd{C-c C-c} or @kbd{C-c C-v e} with the point on a code block@footnote{The
12640 @code{org-babel-no-eval-on-ctrl-c-ctrl-c} variable can be used to remove code
12641 evaluation from the @kbd{C-c C-c} key binding.}. This will call the
12642 @code{org-babel-execute-src-block} function to evaluate the block and insert
12643 its results into the Org mode buffer.
12646 It is also possible to evaluate named code blocks from anywhere in an
12647 Org mode buffer or an Org mode table. Live code blocks located in the current
12648 Org mode buffer or in the ``Library of Babel'' (see @ref{Library of Babel})
12649 can be executed. Named code blocks can be executed with a separate
12650 @code{#+CALL:} line or inline within a block of text.
12652 The syntax of the @code{#+CALL:} line is
12655 #+CALL: <name>(<arguments>)
12656 #+CALL: <name>[<inside header arguments>](<arguments>) <end header arguments>
12659 The syntax for inline evaluation of named code blocks is
12662 ... call_<name>(<arguments>) ...
12663 ... call_<name>[<inside header arguments>](<arguments>)[<end header arguments>] ...
12668 The name of the code block to be evaluated (see @ref{Structure of code blocks}).
12670 Arguments specified in this section will be passed to the code block. These
12671 arguments use standard function call syntax, rather than
12672 header argument syntax. For example, a @code{#+CALL:} line that passes the
12673 number four to a code block named @code{double}, which declares the header
12674 argument @code{:var n=2}, would be written as @code{#+CALL: double(n=4)}.
12675 @item <inside header arguments>
12676 Inside header arguments are passed through and applied to the named code
12677 block. These arguments use header argument syntax rather than standard
12678 function call syntax. Inside header arguments affect how the code block is
12679 evaluated. For example, @code{[:results output]} will collect the results of
12680 everything printed to @code{STDOUT} during execution of the code block.
12681 @item <end header arguments>
12682 End header arguments are applied to the calling instance and do not affect
12683 evaluation of the named code block. They affect how the results are
12684 incorporated into the Org mode buffer and how the call line is exported. For
12685 example, @code{:results html} will insert the results of the call line
12686 evaluation in the Org buffer, wrapped in a @code{BEGIN_HTML:} block.
12688 For more examples of passing header arguments to @code{#+CALL:} lines see
12689 @ref{Header arguments in function calls}.
12692 @node Library of Babel, Languages, Evaluating code blocks, Working With Source Code
12693 @section Library of Babel
12694 @cindex babel, library of
12695 @cindex source code, library
12696 @cindex code block, library
12698 The ``Library of Babel'' consists of code blocks that can be called from any
12699 Org mode file. Code blocks defined in the ``Library of Babel'' can be called
12700 remotely as if they were in the current Org mode buffer (see @ref{Evaluating
12701 code blocks} for information on the syntax of remote code block evaluation).
12704 The central repository of code blocks in the ``Library of Babel'' is housed
12705 in an Org mode file located in the @samp{contrib} directory of Org mode.
12707 Users can add code blocks they believe to be generally useful to their
12708 ``Library of Babel.'' The code blocks can be stored in any Org mode file and
12709 then loaded into the library with @code{org-babel-lob-ingest}.
12713 Code blocks located in any Org mode file can be loaded into the ``Library of
12714 Babel'' with the @code{org-babel-lob-ingest} function, bound to @kbd{C-c C-v
12717 @node Languages, Header arguments, Library of Babel, Working With Source Code
12719 @cindex babel, languages
12720 @cindex source code, languages
12721 @cindex code block, languages
12723 Code blocks in the following languages are supported.
12725 @multitable @columnfractions 0.28 0.3 0.22 0.2
12726 @item @b{Language} @tab @b{Identifier} @tab @b{Language} @tab @b{Identifier}
12727 @item Asymptote @tab asymptote @tab Awk @tab awk
12728 @item Emacs Calc @tab calc @tab C @tab C
12729 @item C++ @tab C++ @tab Clojure @tab clojure
12730 @item CSS @tab css @tab ditaa @tab ditaa
12731 @item Graphviz @tab dot @tab Emacs Lisp @tab emacs-lisp
12732 @item gnuplot @tab gnuplot @tab Haskell @tab haskell
12733 @item Java @tab java @tab @tab
12734 @item Javascript @tab js @tab LaTeX @tab latex
12735 @item Ledger @tab ledger @tab Lisp @tab lisp
12736 @item Lilypond @tab lilypond @tab MATLAB @tab matlab
12737 @item Mscgen @tab mscgen @tab Objective Caml @tab ocaml
12738 @item Octave @tab octave @tab Org mode @tab org
12739 @item Oz @tab oz @tab Perl @tab perl
12740 @item Plantuml @tab plantuml @tab Python @tab python
12741 @item R @tab R @tab Ruby @tab ruby
12742 @item Sass @tab sass @tab Scheme @tab scheme
12743 @item GNU Screen @tab screen @tab shell @tab sh
12744 @item SQL @tab sql @tab SQLite @tab sqlite
12747 Language-specific documentation is available for some languages. If
12748 available, it can be found at
12749 @uref{http://orgmode.org/worg/org-contrib/babel/languages}.
12751 The @code{org-babel-load-languages} controls which languages are enabled for
12752 evaluation (by default only @code{emacs-lisp} is enabled). This variable can
12753 be set using the customization interface or by adding code like the following
12754 to your emacs configuration.
12757 The following disables @code{emacs-lisp} evaluation and enables evaluation of
12758 @code{R} code blocks.
12762 (org-babel-do-load-languages
12763 'org-babel-load-languages
12764 '((emacs-lisp . nil)
12768 It is also possible to enable support for a language by loading the related
12769 elisp file with @code{require}.
12772 The following adds support for evaluating @code{clojure} code blocks.
12776 (require 'ob-clojure)
12779 @node Header arguments, Results of evaluation, Languages, Working With Source Code
12780 @section Header arguments
12781 @cindex code block, header arguments
12782 @cindex source code, block header arguments
12784 Code block functionality can be configured with header arguments. This
12785 section provides an overview of the use of header arguments, and then
12786 describes each header argument in detail.
12789 * Using header arguments:: Different ways to set header arguments
12790 * Specific header arguments:: List of header arguments
12793 @node Using header arguments, Specific header arguments, Header arguments, Header arguments
12794 @subsection Using header arguments
12796 The values of header arguments can be set in six different ways, each more
12797 specific (and having higher priority) than the last.
12799 * System-wide header arguments:: Set global default values
12800 * Language-specific header arguments:: Set default values by language
12801 * Buffer-wide header arguments:: Set default values for a specific buffer
12802 * Header arguments in Org mode properties:: Set default values for a buffer or heading
12803 * Code block specific header arguments:: The most common way to set values
12804 * Header arguments in function calls:: The most specific level
12808 @node System-wide header arguments, Language-specific header arguments, Using header arguments, Using header arguments
12809 @subsubheading System-wide header arguments
12810 @vindex org-babel-default-header-args
12811 System-wide values of header arguments can be specified by customizing the
12812 @code{org-babel-default-header-args} variable:
12816 :results => "replace"
12823 @c org-babel-default-header-args is a variable defined in `org-babel.el'.
12825 @c ((:session . "none")
12826 @c (:results . "replace")
12827 @c (:exports . "code")
12829 @c (:noweb . "no"))
12833 @c Default arguments to use when evaluating a code block.
12836 For example, the following example could be used to set the default value of
12837 @code{:noweb} header arguments to @code{yes}. This would have the effect of
12838 expanding @code{:noweb} references by default when evaluating source code
12842 (setq org-babel-default-header-args
12843 (cons '(:noweb . "yes")
12844 (assq-delete-all :noweb org-babel-default-header-args)))
12847 @node Language-specific header arguments, Buffer-wide header arguments, System-wide header arguments, Using header arguments
12848 @subsubheading Language-specific header arguments
12849 Each language can define its own set of default header arguments. See the
12850 language-specific documentation available online at
12851 @uref{http://orgmode.org/worg/org-contrib/babel}.
12853 @node Buffer-wide header arguments, Header arguments in Org mode properties, Language-specific header arguments, Using header arguments
12854 @subsubheading Buffer-wide header arguments
12855 Buffer-wide header arguments may be specified as properties through the use
12856 of @code{#+PROPERTY:} lines placed anywhere in an Org mode file (see
12857 @ref{Property syntax}).
12859 For example the following would set @code{session} to @code{*R*}, and
12860 @code{results} to @code{silent} for every code block in the buffer, ensuring
12861 that all execution took place in the same session, and no results would be
12862 inserted into the buffer.
12865 #+PROPERTY: session *R*
12866 #+PROPERTY: results silent
12869 @node Header arguments in Org mode properties, Code block specific header arguments, Buffer-wide header arguments, Using header arguments
12870 @subsubheading Header arguments in Org mode properties
12872 Header arguments are also read from Org mode properties (see @ref{Property
12873 syntax}), which can be set on a buffer-wide or per-heading basis. An example
12874 of setting a header argument for all code blocks in a buffer is
12877 #+PROPERTY: tangle yes
12880 @vindex org-use-property-inheritance
12881 When properties are used to set default header arguments, they are looked up
12882 with inheritance, regardless of the value of
12883 @code{org-use-property-inheritance}. In the following example the value of
12884 the @code{:cache} header argument will default to @code{yes} in all code
12885 blocks in the subtree rooted at the following heading:
12895 @vindex org-babel-default-header-args
12896 Properties defined in this way override the properties set in
12897 @code{org-babel-default-header-args}. It is convenient to use the
12898 @code{org-set-property} function bound to @kbd{C-c C-x p} to set properties
12899 in Org mode documents.
12901 @node Code block specific header arguments, Header arguments in function calls, Header arguments in Org mode properties, Using header arguments
12902 @subsubheading Code block specific header arguments
12904 The most common way to assign values to header arguments is at the
12905 code block level. This can be done by listing a sequence of header
12906 arguments and their values as part of the @code{#+BEGIN_SRC} line.
12907 Properties set in this way override both the values of
12908 @code{org-babel-default-header-args} and header arguments specified as
12909 properties. In the following example, the @code{:results} header argument
12910 is set to @code{silent}, meaning the results of execution will not be
12911 inserted in the buffer, and the @code{:exports} header argument is set to
12912 @code{code}, meaning only the body of the code block will be
12913 preserved on export to HTML or @LaTeX{}.
12917 #+BEGIN_SRC haskell :results silent :exports code :var n=0
12919 fac n = n * fac (n-1)
12922 Similarly, it is possible to set header arguments for inline code blocks
12925 src_haskell[:exports both]@{fac 5@}
12928 Code block header arguments can span multiple lines using @code{#+HEADER:} or
12929 @code{#+HEADERS:} lines preceding a code block or nested between the
12930 @code{#+NAME:} line and the @code{#+BEGIN_SRC} line of a named code block.
12934 Multi-line header arguments on an un-named code block:
12936 #+HEADERS: :var data1=1
12937 #+BEGIN_SRC emacs-lisp :var data2=2
12938 (message "data1:%S, data2:%S" data1 data2)
12945 Multi-line header arguments on a named code block:
12947 #+NAME: named-block
12948 #+HEADER: :var data=2
12949 #+BEGIN_SRC emacs-lisp
12950 (message "data:%S" data)
12953 #+results: named-block
12957 @node Header arguments in function calls, , Code block specific header arguments, Using header arguments
12958 @comment node-name, next, previous, up
12959 @subsubheading Header arguments in function calls
12961 At the most specific level, header arguments for ``Library of Babel'' or
12962 @code{#+CALL:} lines can be set as shown in the two examples below. For more
12963 information on the structure of @code{#+CALL:} lines see @ref{Evaluating code
12966 The following will apply the @code{:exports results} header argument to the
12967 evaluation of the @code{#+CALL:} line.
12969 #+CALL: factorial(n=5) :exports results
12972 The following will apply the @code{:session special} header argument to the
12973 evaluation of the @code{factorial} code block.
12975 #+CALL: factorial[:session special](n=5)
12978 @node Specific header arguments, , Using header arguments, Header arguments
12979 @subsection Specific header arguments
12980 Header arguments consist of an initial colon followed by the name of the
12981 argument in lowercase letters. The following header arguments are defined:
12984 * var:: Pass arguments to code blocks
12985 * results:: Specify the type of results and how they will
12986 be collected and handled
12987 * file:: Specify a path for file output
12988 * dir:: Specify the default (possibly remote)
12989 directory for code block execution
12990 * exports:: Export code and/or results
12991 * tangle:: Toggle tangling and specify file name
12992 * mkdirp:: Toggle creation of parent directories of target
12993 files during tangling
12994 * comments:: Toggle insertion of comments in tangled
12996 * padline:: Control insertion of padding lines in tangled
12998 * no-expand:: Turn off variable assignment and noweb
12999 expansion during tangling
13000 * session:: Preserve the state of code evaluation
13001 * noweb:: Toggle expansion of noweb references
13002 * noweb-ref:: Specify block's noweb reference resolution target
13003 * cache:: Avoid re-evaluating unchanged code blocks
13004 * sep:: Delimiter for writing tabular results outside Org
13005 * hlines:: Handle horizontal lines in tables
13006 * colnames:: Handle column names in tables
13007 * rownames:: Handle row names in tables
13008 * shebang:: Make tangled files executable
13009 * eval:: Limit evaluation of specific code blocks
13012 Additional header arguments are defined on a language-specific basis, see
13015 @node var, results, Specific header arguments, Specific header arguments
13016 @subsubsection @code{:var}
13017 The @code{:var} header argument is used to pass arguments to code blocks.
13018 The specifics of how arguments are included in a code block vary by language;
13019 these are addressed in the language-specific documentation. However, the
13020 syntax used to specify arguments is the same across all languages. In every
13021 case, variables require a default value when they are declared.
13023 The values passed to arguments can either be literal values, references, or
13024 Emacs Lisp code (see @ref{var, Emacs Lisp evaluation of variables}). References
13025 include anything in the Org mode file that takes a @code{#+NAME:},
13026 @code{#+TBLNAME:}, or @code{#+RESULTS:} line. This includes tables, lists,
13027 @code{#+BEGIN_EXAMPLE} blocks, other code blocks, and the results of other
13030 Argument values can be indexed in a manner similar to arrays (see @ref{var,
13031 Indexable variable values}).
13033 The following syntax is used to pass arguments to code blocks using the
13034 @code{:var} header argument.
13040 The argument, @code{assign}, can either be a literal value, such as a string
13041 @samp{"string"} or a number @samp{9}, or a reference to a table, a list, a
13042 literal example, another code block (with or without arguments), or the
13043 results of evaluating another code block.
13045 Here are examples of passing values by reference:
13050 an Org mode table named with either a @code{#+NAME:} or @code{#+TBLNAME:} line
13052 #+TBLNAME: example-table
13058 #+NAME: table-length
13059 #+BEGIN_SRC emacs-lisp :var table=example-table
13063 #+results: table-length
13068 a simple list named with a @code{#+NAME:} line (note that nesting is not
13069 carried through to the source code block)
13072 #+NAME: example-list
13078 #+BEGIN_SRC emacs-lisp :var x=example-list
13086 @item code block without arguments
13087 a code block name (from the example above), as assigned by @code{#+NAME:},
13088 optionally followed by parentheses
13091 #+BEGIN_SRC emacs-lisp :var length=table-length()
13099 @item code block with arguments
13100 a code block name, as assigned by @code{#+NAME:}, followed by parentheses and
13101 optional arguments passed within the parentheses following the
13102 code block name using standard function call syntax
13106 #+BEGIN_SRC emacs-lisp :var input=8
13114 #+BEGIN_SRC emacs-lisp :var input=double(input=1)
13122 @item literal example
13123 a literal example block named with a @code{#+NAME:} line
13126 #+NAME: literal-example
13132 #+NAME: read-literal-example
13133 #+BEGIN_SRC emacs-lisp :var x=literal-example
13134 (concatenate 'string x " for you.")
13137 #+results: read-literal-example
13138 : A literal example
13139 : on two lines for you.
13145 @subsubheading Alternate argument syntax
13146 It is also possible to specify arguments in a potentially more natural way
13147 using the @code{#+NAME:} line of a code block. As in the following
13148 example, arguments can be packed inside of parentheses, separated by commas,
13149 following the source name.
13152 #+NAME: double(input=0, x=2)
13153 #+BEGIN_SRC emacs-lisp
13158 @subsubheading Indexable variable values
13159 It is possible to reference portions of variable values by ``indexing'' into
13160 the variables. Indexes are 0 based with negative values counting back from
13161 the end. If an index is separated by @code{,}s then each subsequent section
13162 will index into the next deepest nesting or dimension of the value. Note
13163 that this indexing occurs @emph{before} other table related header arguments
13164 like @code{:hlines}, @code{:colnames} and @code{:rownames} are applied. The
13165 following example assigns the last cell of the first row the table
13166 @code{example-table} to the variable @code{data}:
13169 #+NAME: example-table
13175 #+BEGIN_SRC emacs-lisp :var data=example-table[0,-1]
13183 Ranges of variable values can be referenced using two integers separated by a
13184 @code{:}, in which case the entire inclusive range is referenced. For
13185 example the following assigns the middle three rows of @code{example-table}
13189 #+NAME: example-table
13196 #+BEGIN_SRC emacs-lisp :var data=example-table[1:3]
13206 Additionally, an empty index, or the single character @code{*}, are both
13207 interpreted to mean the entire range and as such are equivalent to
13208 @code{0:-1}, as shown in the following example in which the entire first
13209 column is referenced.
13212 #+NAME: example-table
13218 #+BEGIN_SRC emacs-lisp :var data=example-table[,0]
13226 It is possible to index into the results of code blocks as well as tables.
13227 Any number of dimensions can be indexed. Dimensions are separated from one
13228 another by commas, as shown in the following example.
13232 #+BEGIN_SRC emacs-lisp
13233 '(((1 2 3) (4 5 6) (7 8 9))
13234 ((10 11 12) (13 14 15) (16 17 18))
13235 ((19 20 21) (22 23 24) (25 26 27)))
13238 #+BEGIN_SRC emacs-lisp :var data=3D[1,,1]
13246 @subsubheading Emacs Lisp evaluation of variables
13248 Emacs lisp code can be used to initialize variable values. When a variable
13249 value starts with @code{(}, @code{[}, @code{'} or @code{`} it will be
13250 evaluated as Emacs Lisp and the result of the evaluation will be assigned as
13251 the variable value. The following example demonstrates use of this
13252 evaluation to reliably pass the file-name of the Org mode buffer to a code
13253 block---note that evaluation of header arguments is guaranteed to take place
13254 in the original Org mode file, while there is no such guarantee for
13255 evaluation of the code block body.
13258 #+BEGIN_SRC sh :var filename=(buffer-file-name) :exports both
13263 Note that values read from tables and lists will not be evaluated as
13264 Emacs Lisp, as shown in the following example.
13270 #+HEADERS: :var data=table[0,0]
13279 @node results, file, var, Specific header arguments
13280 @subsubsection @code{:results}
13282 There are three classes of @code{:results} header argument. Only one option
13283 per class may be supplied per code block.
13287 @b{collection} header arguments specify how the results should be collected
13288 from the code block
13290 @b{type} header arguments specify what type of result the code block will
13291 return---which has implications for how they will be inserted into the
13294 @b{handling} header arguments specify how the results of evaluating the code
13295 block should be handled.
13298 @subsubheading Collection
13299 The following options are mutually exclusive, and specify how the results
13300 should be collected from the code block.
13304 This is the default. The result is the value of the last statement in the
13305 code block. This header argument places the evaluation in functional
13306 mode. Note that in some languages, e.g., Python, use of this result type
13307 requires that a @code{return} statement be included in the body of the source
13308 code block. E.g., @code{:results value}.
13309 @item @code{output}
13310 The result is the collection of everything printed to STDOUT during the
13311 execution of the code block. This header argument places the
13312 evaluation in scripting mode. E.g., @code{:results output}.
13315 @subsubheading Type
13317 The following options are mutually exclusive and specify what type of results
13318 the code block will return. By default, results are inserted as either a
13319 table or scalar depending on their value.
13322 @item @code{table}, @code{vector}
13323 The results should be interpreted as an Org mode table. If a single value is
13324 returned, it will be converted into a table with one row and one column.
13325 E.g., @code{:results value table}.
13327 The results should be interpreted as an Org mode list. If a single scalar
13328 value is returned it will be converted into a list with only one element.
13329 @item @code{scalar}, @code{verbatim}
13330 The results should be interpreted literally---they will not be
13331 converted into a table. The results will be inserted into the Org mode
13332 buffer as quoted text. E.g., @code{:results value verbatim}.
13334 The results will be interpreted as the path to a file, and will be inserted
13335 into the Org mode buffer as a file link. E.g., @code{:results value file}.
13336 @item @code{raw}, @code{org}
13337 The results are interpreted as raw Org mode code and are inserted directly
13338 into the buffer. If the results look like a table they will be aligned as
13339 such by Org mode. E.g., @code{:results value raw}.
13341 Results are assumed to be HTML and will be enclosed in a @code{begin_html}
13342 block. E.g., @code{:results value html}.
13344 Results assumed to be @LaTeX{} and are enclosed in a @code{begin_latex} block.
13345 E.g., @code{:results value latex}.
13347 Result are assumed to be parsable code and are enclosed in a code block.
13348 E.g., @code{:results value code}.
13350 The result is converted to pretty-printed code and is enclosed in a code
13351 block. This option currently supports Emacs Lisp, Python, and Ruby. E.g.,
13352 @code{:results value pp}.
13354 The result is wrapped in a @code{begin_result} block. This can be useful for
13355 inserting @code{raw} or @code{org} syntax results in such a way that their
13356 extend is known and they can be automatically removed or replaced.
13359 @subsubheading Handling
13360 The following results options indicate what happens with the
13361 results once they are collected.
13364 @item @code{silent}
13365 The results will be echoed in the minibuffer but will not be inserted into
13366 the Org mode buffer. E.g., @code{:results output silent}.
13367 @item @code{replace}
13368 The default value. Any existing results will be removed, and the new results
13369 will be inserted into the Org mode buffer in their place. E.g.,
13370 @code{:results output replace}.
13371 @item @code{append}
13372 If there are pre-existing results of the code block then the new results will
13373 be appended to the existing results. Otherwise the new results will be
13374 inserted as with @code{replace}.
13375 @item @code{prepend}
13376 If there are pre-existing results of the code block then the new results will
13377 be prepended to the existing results. Otherwise the new results will be
13378 inserted as with @code{replace}.
13381 @node file, dir, results, Specific header arguments
13382 @subsubsection @code{:file}
13384 The header argument @code{:file} is used to specify an external file in which
13385 to save code block results. After code block evaluation an Org mode style
13386 @code{[[file:]]} link (see @ref{Link format}) to the file will be inserted
13387 into the Org mode buffer. Some languages including R, gnuplot, dot, and
13388 ditaa provide special handling of the @code{:file} header argument
13389 automatically wrapping the code block body in the boilerplate code required
13390 to save output to the specified file. This is often useful for saving
13391 graphical output of a code block to the specified file.
13393 The argument to @code{:file} should be either a string specifying the path to
13394 a file, or a list of two strings in which case the first element of the list
13395 should be the path to a file and the second a description for the link.
13397 @node dir, exports, file, Specific header arguments
13398 @subsubsection @code{:dir} and remote execution
13400 While the @code{:file} header argument can be used to specify the path to the
13401 output file, @code{:dir} specifies the default directory during code block
13402 execution. If it is absent, then the directory associated with the current
13403 buffer is used. In other words, supplying @code{:dir path} temporarily has
13404 the same effect as changing the current directory with @kbd{M-x cd path}, and
13405 then not supplying @code{:dir}. Under the surface, @code{:dir} simply sets
13406 the value of the Emacs variable @code{default-directory}.
13408 When using @code{:dir}, you should supply a relative path for file output
13409 (e.g.@: @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which
13410 case that path will be interpreted relative to the default directory.
13412 In other words, if you want your plot to go into a folder called @file{Work}
13413 in your home directory, you could use
13416 #+BEGIN_SRC R :file myplot.png :dir ~/Work
13417 matplot(matrix(rnorm(100), 10), type="l")
13421 @subsubheading Remote execution
13422 A directory on a remote machine can be specified using tramp file syntax, in
13423 which case the code will be evaluated on the remote machine. An example is
13426 #+BEGIN_SRC R :file plot.png :dir /dand@@yakuba.princeton.edu:
13427 plot(1:10, main=system("hostname", intern=TRUE))
13431 Text results will be returned to the local Org mode buffer as usual, and file
13432 output will be created on the remote machine with relative paths interpreted
13433 relative to the remote directory. An Org mode link to the remote file will be
13436 So, in the above example a plot will be created on the remote machine,
13437 and a link of the following form will be inserted in the org buffer:
13440 [[file:/scp:dand@@yakuba.princeton.edu:/home/dand/plot.png][plot.png]]
13443 Most of this functionality follows immediately from the fact that @code{:dir}
13444 sets the value of the Emacs variable @code{default-directory}, thanks to
13445 tramp. Those using XEmacs, or GNU Emacs prior to version 23 may need to
13446 install tramp separately in order for these features to work correctly.
13448 @subsubheading Further points
13452 If @code{:dir} is used in conjunction with @code{:session}, although it will
13453 determine the starting directory for a new session as expected, no attempt is
13454 currently made to alter the directory associated with an existing session.
13456 @code{:dir} should typically not be used to create files during export with
13457 @code{:exports results} or @code{:exports both}. The reason is that, in order
13458 to retain portability of exported material between machines, during export
13459 links inserted into the buffer will @emph{not} be expanded against @code{default
13460 directory}. Therefore, if @code{default-directory} is altered using
13461 @code{:dir}, it is probable that the file will be created in a location to
13462 which the link does not point.
13465 @node exports, tangle, dir, Specific header arguments
13466 @subsubsection @code{:exports}
13468 The @code{:exports} header argument specifies what should be included in HTML
13469 or @LaTeX{} exports of the Org mode file.
13473 The default. The body of code is included into the exported file. E.g.,
13474 @code{:exports code}.
13475 @item @code{results}
13476 The result of evaluating the code is included in the exported file. E.g.,
13477 @code{:exports results}.
13479 Both the code and results are included in the exported file. E.g.,
13480 @code{:exports both}.
13482 Nothing is included in the exported file. E.g., @code{:exports none}.
13485 @node tangle, mkdirp, exports, Specific header arguments
13486 @subsubsection @code{:tangle}
13488 The @code{:tangle} header argument specifies whether or not the code
13489 block should be included in tangled extraction of source code files.
13492 @item @code{tangle}
13493 The code block is exported to a source code file named after the full path
13494 (including the directory) and file name (w/o extension) of the Org mode file.
13495 E.g., @code{:tangle yes}.
13497 The default. The code block is not exported to a source code file.
13498 E.g., @code{:tangle no}.
13500 Any other string passed to the @code{:tangle} header argument is interpreted
13501 as a path (directory and file name relative to the directory of the Org mode
13502 file) to which the block will be exported. E.g., @code{:tangle path}.
13505 @node mkdirp, comments, tangle, Specific header arguments
13506 @subsubsection @code{:mkdirp}
13508 The @code{:mkdirp} header argument can be used to create parent directories
13509 of tangled files when missing. This can be set to @code{yes} to enable
13510 directory creation or to @code{no} to inhibit directory creation.
13512 @node comments, padline, mkdirp, Specific header arguments
13513 @subsubsection @code{:comments}
13514 By default code blocks are tangled to source-code files without any insertion
13515 of comments beyond those which may already exist in the body of the code
13516 block. The @code{:comments} header argument can be set as follows to control
13517 the insertion of extra comments into the tangled code file.
13521 The default. No extra comments are inserted during tangling.
13523 The code block is wrapped in comments which contain pointers back to the
13524 original Org file from which the code was tangled.
13526 A synonym for ``link'' to maintain backwards compatibility.
13528 Include text from the Org mode file as a comment.
13530 The text is picked from the leading context of the tangled code and is
13531 limited by the nearest headline or source block as the case may be.
13533 Turns on both the ``link'' and ``org'' comment options.
13535 Turns on the ``link'' comment option, and additionally wraps expanded noweb
13536 references in the code block body in link comments.
13539 @node padline, no-expand, comments, Specific header arguments
13540 @subsubsection @code{:padline}
13541 Control in insertion of padding lines around code block bodies in tangled
13542 code files. The default value is @code{yes} which results in insertion of
13543 newlines before and after each tangled code block. The following arguments
13548 Insert newlines before and after each code block body in tangled code files.
13550 Do not insert any newline padding in tangled output.
13553 @node no-expand, session, padline, Specific header arguments
13554 @subsubsection @code{:no-expand}
13556 By default, code blocks are expanded with @code{org-babel-expand-src-block}
13557 during tangling. This has the effect of assigning values to variables
13558 specified with @code{:var} (see @ref{var}), and of replacing ``noweb''
13559 references (see @ref{Noweb reference syntax}) with their targets. The
13560 @code{:no-expand} header argument can be used to turn off this behavior.
13562 @node session, noweb, no-expand, Specific header arguments
13563 @subsubsection @code{:session}
13565 The @code{:session} header argument starts a session for an interpreted
13566 language where state is preserved.
13568 By default, a session is not started.
13570 A string passed to the @code{:session} header argument will give the session
13571 a name. This makes it possible to run concurrent sessions for each
13572 interpreted language.
13574 @node noweb, noweb-ref, session, Specific header arguments
13575 @subsubsection @code{:noweb}
13577 The @code{:noweb} header argument controls expansion of ``noweb'' style (see
13578 @ref{Noweb reference syntax}) references in a code block. This header
13579 argument can have one of three values: @code{yes}, @code{no}, or @code{tangle}.
13583 All ``noweb'' syntax references in the body of the code block will be
13584 expanded before the block is evaluated, tangled or exported.
13586 The default. No ``noweb'' syntax specific action is taken on evaluating
13587 code blocks, However, noweb references will still be expanded during
13589 @item @code{tangle}
13590 All ``noweb'' syntax references in the body of the code block will be
13591 expanded before the block is tangled, however ``noweb'' references will not
13592 be expanded when the block is evaluated or exported.
13595 @subsubheading Noweb prefix lines
13596 Noweb insertions are now placed behind the line prefix of the
13597 @code{<<reference>>}.
13598 This behavior is illustrated in the following example. Because the
13599 @code{<<example>>} noweb reference appears behind the SQL comment syntax,
13600 each line of the expanded noweb reference will be commented.
13613 -- multi-line body of example
13616 Note that noweb replacement text that does not contain any newlines will not
13617 be affected by this change, so it is still possible to use inline noweb
13620 @node noweb-ref, cache, noweb, Specific header arguments
13621 @subsubsection @code{:noweb-ref}
13622 When expanding ``noweb'' style references the bodies of all code block with
13623 @emph{either} a block name matching the reference name @emph{or} a
13624 @code{:noweb-ref} header argument matching the reference name will be
13625 concatenated together to form the replacement text.
13627 By setting this header argument at the sub-tree or file level, simple code
13628 block concatenation may be achieved. For example, when tangling the
13629 following Org mode file, the bodies of code blocks will be concatenated into
13630 the resulting pure code file@footnote{(The example needs property inheritance
13631 to be turned on for the @code{noweb-ref} property, see @ref{Property
13635 #+BEGIN_SRC sh :tangle yes :noweb yes :shebang #!/bin/sh
13638 * the mount point of the fullest disk
13640 :noweb-ref: fullest-disk
13643 ** query all mounted disks
13648 ** strip the header row
13653 ** sort by the percent full
13655 |awk '@{print $5 " " $6@}'|sort -n |tail -1 \
13658 ** extract the mount point
13660 |awk '@{print $2@}'
13664 @node cache, sep, noweb-ref, Specific header arguments
13665 @subsubsection @code{:cache}
13667 The @code{:cache} header argument controls the use of in-buffer caching of
13668 the results of evaluating code blocks. It can be used to avoid re-evaluating
13669 unchanged code blocks. This header argument can have one of two
13670 values: @code{yes} or @code{no}.
13674 The default. No caching takes place, and the code block will be evaluated
13675 every time it is called.
13677 Every time the code block is run a SHA1 hash of the code and arguments
13678 passed to the block will be generated. This hash is packed into the
13679 @code{#+results:} line and will be checked on subsequent
13680 executions of the code block. If the code block has not
13681 changed since the last time it was evaluated, it will not be re-evaluated.
13684 Code block caches notice if the value of a variable argument
13685 to the code block has changed. If this is the case, the cache is
13686 invalidated and the code block is re-run. In the following example,
13687 @code{caller} will not be re-run unless the results of @code{random} have
13688 changed since it was last run.
13692 #+BEGIN_SRC R :cache yes
13696 #+results[a2a72cd647ad44515fab62e144796432793d68e1]: random
13700 #+BEGIN_SRC emacs-lisp :var x=random :cache yes
13704 #+results[bec9c8724e397d5df3b696502df3ed7892fc4f5f]: caller
13708 @node sep, hlines, cache, Specific header arguments
13709 @subsubsection @code{:sep}
13711 The @code{:sep} header argument can be used to control the delimiter used
13712 when writing tabular results out to files external to Org mode. This is used
13713 either when opening tabular results of a code block by calling the
13714 @code{org-open-at-point} function bound to @kbd{C-c C-o} on the code block,
13715 or when writing code block results to an external file (see @ref{file})
13718 By default, when @code{:sep} is not specified output tables are tab
13721 @node hlines, colnames, sep, Specific header arguments
13722 @subsubsection @code{:hlines}
13724 Tables are frequently represented with one or more horizontal lines, or
13725 hlines. The @code{:hlines} argument to a code block accepts the
13726 values @code{yes} or @code{no}, with a default value of @code{no}.
13730 Strips horizontal lines from the input table. In most languages this is the
13731 desired effect because an @code{hline} symbol is interpreted as an unbound
13732 variable and raises an error. Setting @code{:hlines no} or relying on the
13733 default value yields the following results.
13736 #+TBLNAME: many-cols
13744 #+BEGIN_SRC python :var tab=many-cols
13748 #+results: echo-table
13755 Leaves hlines in the table. Setting @code{:hlines yes} has this effect.
13758 #+TBLNAME: many-cols
13766 #+BEGIN_SRC python :var tab=many-cols :hlines yes
13770 #+results: echo-table
13779 @node colnames, rownames, hlines, Specific header arguments
13780 @subsubsection @code{:colnames}
13782 The @code{:colnames} header argument accepts the values @code{yes},
13783 @code{no}, or @code{nil} for unassigned. The default value is @code{nil}.
13784 Note that the behavior of the @code{:colnames} header argument may differ
13785 across languages. For example Emacs Lisp code blocks ignore the
13786 @code{:colnames} header argument entirely given the ease with which tables
13787 with column names may be handled directly in Emacs Lisp.
13791 If an input table looks like it has column names
13792 (because its second row is an hline), then the column
13793 names will be removed from the table before
13794 processing, then reapplied to the results.
13797 #+TBLNAME: less-cols
13803 #+NAME: echo-table-again
13804 #+BEGIN_SRC python :var tab=less-cols
13805 return [[val + '*' for val in row] for row in tab]
13808 #+results: echo-table-again
13815 Please note that column names are not removed before the table is indexed
13816 using variable indexing @xref{var, Indexable variable values}.
13819 No column name pre-processing takes place
13822 Column names are removed and reapplied as with @code{nil} even if the table
13823 does not ``look like'' it has column names (i.e.@: the second row is not an
13827 @node rownames, shebang, colnames, Specific header arguments
13828 @subsubsection @code{:rownames}
13830 The @code{:rownames} header argument can take on the values @code{yes}
13831 or @code{no}, with a default value of @code{no}.
13835 No row name pre-processing will take place.
13838 The first column of the table is removed from the table before processing,
13839 and is then reapplied to the results.
13842 #+TBLNAME: with-rownames
13843 | one | 1 | 2 | 3 | 4 | 5 |
13844 | two | 6 | 7 | 8 | 9 | 10 |
13846 #+NAME: echo-table-once-again
13847 #+BEGIN_SRC python :var tab=with-rownames :rownames yes
13848 return [[val + 10 for val in row] for row in tab]
13851 #+results: echo-table-once-again
13852 | one | 11 | 12 | 13 | 14 | 15 |
13853 | two | 16 | 17 | 18 | 19 | 20 |
13856 Please note that row names are not removed before the table is indexed using
13857 variable indexing @xref{var, Indexable variable values}.
13861 @node shebang, eval, rownames, Specific header arguments
13862 @subsubsection @code{:shebang}
13864 Setting the @code{:shebang} header argument to a string value
13865 (e.g.@: @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the
13866 first line of any tangled file holding the code block, and the file
13867 permissions of the tangled file are set to make it executable.
13869 @node eval, , shebang, Specific header arguments
13870 @subsubsection @code{:eval}
13871 The @code{:eval} header argument can be used to limit the evaluation of
13872 specific code blocks. The @code{:eval} header argument can be useful for
13873 protecting against the evaluation of dangerous code blocks or to ensure that
13874 evaluation will require a query regardless of the value of the
13875 @code{org-confirm-babel-evaluate} variable. The possible values of
13876 @code{:eval} and their effects are shown below.
13880 The code block will not be evaluated under any circumstances.
13882 Evaluation of the code block will require a query.
13883 @item never-export or no-export
13884 The code block will not be evaluated during export but may still be called
13887 Evaluation of the code block during export will require a query.
13890 If this header argument is not set then evaluation is determined by the value
13891 of the @code{org-confirm-babel-evaluate} variable see @ref{Code evaluation
13894 @node Results of evaluation, Noweb reference syntax, Header arguments, Working With Source Code
13895 @section Results of evaluation
13896 @cindex code block, results of evaluation
13897 @cindex source code, results of evaluation
13899 The way in which results are handled depends on whether a session is invoked,
13900 as well as on whether @code{:results value} or @code{:results output} is
13901 used. The following table shows the table possibilities. For a full listing
13902 of the possible results header arguments see @ref{results}.
13904 @multitable @columnfractions 0.26 0.33 0.41
13905 @item @tab @b{Non-session} @tab @b{Session}
13906 @item @code{:results value} @tab value of last expression @tab value of last expression
13907 @item @code{:results output} @tab contents of STDOUT @tab concatenation of interpreter output
13910 Note: With @code{:results value}, the result in both @code{:session} and
13911 non-session is returned to Org mode as a table (a one- or two-dimensional
13912 vector of strings or numbers) when appropriate.
13914 @subsection Non-session
13915 @subsubsection @code{:results value}
13916 This is the default. Internally, the value is obtained by wrapping the code
13917 in a function definition in the external language, and evaluating that
13918 function. Therefore, code should be written as if it were the body of such a
13919 function. In particular, note that Python does not automatically return a
13920 value from a function unless a @code{return} statement is present, and so a
13921 @samp{return} statement will usually be required in Python.
13923 This is the only one of the four evaluation contexts in which the code is
13924 automatically wrapped in a function definition.
13926 @subsubsection @code{:results output}
13927 The code is passed to the interpreter as an external process, and the
13928 contents of the standard output stream are returned as text. (In certain
13929 languages this also contains the error output stream; this is an area for
13932 @subsection Session
13933 @subsubsection @code{:results value}
13934 The code is passed to an interpreter running as an interactive Emacs inferior
13935 process. Only languages which provide tools for interactive evaluation of
13936 code have session support, so some language (e.g., C and ditaa) do not
13937 support the @code{:session} header argument, and in other languages (e.g.,
13938 Python and Haskell) which have limitations on the code which may be entered
13939 into interactive sessions, those limitations apply to the code in code blocks
13940 using the @code{:session} header argument as well.
13942 Unless the @code{:results output} option is supplied (see below) the result
13943 returned is the result of the last evaluation performed by the
13944 interpreter. (This is obtained in a language-specific manner: the value of
13945 the variable @code{_} in Python and Ruby, and the value of @code{.Last.value}
13948 @subsubsection @code{:results output}
13949 The code is passed to the interpreter running as an interactive Emacs
13950 inferior process. The result returned is the concatenation of the sequence of
13951 (text) output from the interactive interpreter. Notice that this is not
13952 necessarily the same as what would be sent to @code{STDOUT} if the same code
13953 were passed to a non-interactive interpreter running as an external
13954 process. For example, compare the following two blocks:
13957 #+BEGIN_SRC python :results output
13968 In non-session mode, the `2' is not printed and does not appear.
13970 #+BEGIN_SRC python :results output :session
13982 But in @code{:session} mode, the interactive interpreter receives input `2'
13983 and prints out its value, `2'. (Indeed, the other print statements are
13986 @node Noweb reference syntax, Key bindings and useful functions, Results of evaluation, Working With Source Code
13987 @section Noweb reference syntax
13988 @cindex code block, noweb reference
13989 @cindex syntax, noweb
13990 @cindex source code, noweb reference
13992 The ``noweb'' (see @uref{http://www.cs.tufts.edu/~nr/noweb/}) Literate
13993 Programming system allows named blocks of code to be referenced by using the
13994 familiar Noweb syntax:
13997 <<code-block-name>>
14000 When a code block is tangled or evaluated, whether or not ``noweb''
14001 references are expanded depends upon the value of the @code{:noweb} header
14002 argument. If @code{:noweb yes}, then a Noweb reference is expanded before
14003 evaluation. If @code{:noweb no}, the default, then the reference is not
14004 expanded before evaluation. See the @ref{noweb-ref} header argument for
14005 a more flexible way to resolve noweb references.
14007 Note: the default value, @code{:noweb no}, was chosen to ensure that
14008 correct code is not broken in a language, such as Ruby, where
14009 @code{<<arg>>} is a syntactically valid construct. If @code{<<arg>>} is not
14010 syntactically valid in languages that you use, then please consider setting
14013 Note: if noweb tangling is slow in large Org-mode files consider setting the
14014 @code{*org-babel-use-quick-and-dirty-noweb-expansion*} variable to true.
14015 This will result in faster noweb reference resolution at the expense of not
14016 correctly resolving inherited values of the @code{:noweb-ref} header
14019 @node Key bindings and useful functions, Batch execution, Noweb reference syntax, Working With Source Code
14020 @section Key bindings and useful functions
14021 @cindex code block, key bindings
14023 Many common Org mode key sequences are re-bound depending on
14026 Within a code block, the following key bindings
14029 @multitable @columnfractions 0.25 0.75
14031 @item @kbd{C-c C-c} @tab @code{org-babel-execute-src-block}
14033 @item @kbd{C-c C-o} @tab @code{org-babel-open-src-block-result}
14035 @item @kbd{C-@key{up}} @tab @code{org-babel-load-in-session}
14037 @item @kbd{M-@key{down}} @tab @code{org-babel-pop-to-session}
14040 In an Org mode buffer, the following key bindings are active:
14042 @multitable @columnfractions 0.45 0.55
14044 @kindex C-c C-v C-a
14045 @item @kbd{C-c C-v a} @ @ @r{or} @ @ @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
14047 @kindex C-c C-v C-b
14048 @item @kbd{C-c C-v b} @ @ @r{or} @ @ @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
14050 @kindex C-c C-v C-f
14051 @item @kbd{C-c C-v f} @ @ @r{or} @ @ @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
14053 @item @kbd{C-c C-v g} @tab @code{org-babel-goto-named-source-block}
14055 @item @kbd{C-c C-v h} @tab @code{org-babel-describe-bindings}
14057 @kindex C-c C-v C-l
14058 @item @kbd{C-c C-v l} @ @ @r{or} @ @ @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest}
14060 @kindex C-c C-v C-p
14061 @item @kbd{C-c C-v p} @ @ @r{or} @ @ @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block}
14063 @kindex C-c C-v C-s
14064 @item @kbd{C-c C-v s} @ @ @r{or} @ @ @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
14066 @kindex C-c C-v C-t
14067 @item @kbd{C-c C-v t} @ @ @r{or} @ @ @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
14069 @kindex C-c C-v C-z
14070 @item @kbd{C-c C-v z} @ @ @r{or} @ @ @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session}
14073 @c When possible these keybindings were extended to work when the control key is
14074 @c kept pressed, resulting in the following additional keybindings.
14076 @c @multitable @columnfractions 0.25 0.75
14077 @c @item @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
14078 @c @item @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
14079 @c @item @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
14080 @c @item @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest}
14081 @c @item @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block}
14082 @c @item @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
14083 @c @item @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
14084 @c @item @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session}
14087 @node Batch execution, , Key bindings and useful functions, Working With Source Code
14088 @section Batch execution
14089 @cindex code block, batch execution
14090 @cindex source code, batch execution
14092 It is possible to call functions from the command line. This shell
14093 script calls @code{org-babel-tangle} on every one of its arguments.
14095 Be sure to adjust the paths to fit your system.
14099 # -*- mode: shell-script -*-
14101 # tangle files with org-mode
14105 ORGINSTALL="~/src/org/lisp/org-install.el"
14107 # wrap each argument in the code required to call tangle on it
14109 FILES="$FILES \"$i\""
14112 emacs -Q --batch -l $ORGINSTALL \
14114 (add-to-list 'load-path (expand-file-name \"~/src/org/lisp/\"))
14115 (add-to-list 'load-path (expand-file-name \"~/src/org/contrib/lisp/\"))
14116 (require 'org)(require 'org-exp)(require 'ob)(require 'ob-tangle)
14117 (mapc (lambda (file)
14118 (find-file (expand-file-name file \"$DIR\"))
14120 (kill-buffer)) '($FILES)))" 2>&1 |grep tangled
14123 @node Miscellaneous, Hacking, Working With Source Code, Top
14124 @chapter Miscellaneous
14127 * Completion:: M-TAB knows what you need
14128 * Easy Templates:: Quick insertion of structural elements
14129 * Speed keys:: Electric commands at the beginning of a headline
14130 * Code evaluation security:: Org mode files evaluate inline code
14131 * Customization:: Adapting Org to your taste
14132 * In-buffer settings:: Overview of the #+KEYWORDS
14133 * The very busy C-c C-c key:: When in doubt, press C-c C-c
14134 * Clean view:: Getting rid of leading stars in the outline
14135 * TTY keys:: Using Org on a tty
14136 * Interaction:: Other Emacs packages
14137 * org-crypt.el:: Encrypting Org files
14141 @node Completion, Easy Templates, Miscellaneous, Miscellaneous
14142 @section Completion
14143 @cindex completion, of @TeX{} symbols
14144 @cindex completion, of TODO keywords
14145 @cindex completion, of dictionary words
14146 @cindex completion, of option keywords
14147 @cindex completion, of tags
14148 @cindex completion, of property keys
14149 @cindex completion, of link abbreviations
14150 @cindex @TeX{} symbol completion
14151 @cindex TODO keywords completion
14152 @cindex dictionary word completion
14153 @cindex option keyword completion
14154 @cindex tag completion
14155 @cindex link abbreviations, completion of
14157 Emacs would not be Emacs without completion, and Org mode uses it whenever it
14158 makes sense. If you prefer an @i{iswitchb}- or @i{ido}-like interface for
14159 some of the completion prompts, you can specify your preference by setting at
14160 most one of the variables @code{org-completion-use-iswitchb}
14161 @code{org-completion-use-ido}.
14163 Org supports in-buffer completion. This type of completion does
14164 not make use of the minibuffer. You simply type a few letters into
14165 the buffer and use the key to complete text right there.
14168 @kindex M-@key{TAB}
14170 Complete word at point
14173 At the beginning of a headline, complete TODO keywords.
14175 After @samp{\}, complete @TeX{} symbols supported by the exporter.
14177 After @samp{*}, complete headlines in the current buffer so that they
14178 can be used in search links like @samp{[[*find this headline]]}.
14180 After @samp{:} in a headline, complete tags. The list of tags is taken
14181 from the variable @code{org-tag-alist} (possibly set through the
14182 @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
14183 dynamically from all tags used in the current buffer.
14185 After @samp{:} and not in a headline, complete property keys. The list
14186 of keys is constructed dynamically from all keys used in the current
14189 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
14191 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
14192 @samp{OPTIONS} which set file-specific options for Org mode. When the
14193 option keyword is already complete, pressing @kbd{M-@key{TAB}} again
14194 will insert example settings for this keyword.
14196 In the line after @samp{#+STARTUP: }, complete startup keywords,
14197 i.e.@: valid keys for this line.
14199 Elsewhere, complete dictionary words using Ispell.
14203 @node Easy Templates, Speed keys, Completion, Miscellaneous
14204 @section Easy Templates
14205 @cindex template insertion
14206 @cindex insertion, of templates
14208 Org mode supports insertion of empty structural elements (like
14209 @code{#+BEGIN_SRC} and @code{#+END_SRC} pairs) with just a few key
14210 strokes. This is achieved through a native template expansion mechanism.
14211 Note that Emacs has several other template mechanisms which could be used in
14212 a similar way, for example @file{yasnippet}.
14214 To insert a structural element, type a @samp{<}, followed by a template
14215 selector and @kbd{@key{TAB}}. Completion takes effect only when the above
14216 keystrokes are typed on a line by itself.
14218 The following template selectors are currently supported.
14220 @multitable @columnfractions 0.1 0.9
14221 @item @kbd{s} @tab @code{#+begin_src ... #+end_src}
14222 @item @kbd{e} @tab @code{#+begin_example ... #+end_example}
14223 @item @kbd{q} @tab @code{#+begin_quote ... #+end_quote}
14224 @item @kbd{v} @tab @code{#+begin_verse ... #+end_verse}
14225 @item @kbd{c} @tab @code{#+begin_center ... #+end_center}
14226 @item @kbd{l} @tab @code{#+begin_latex ... #+end_latex}
14227 @item @kbd{L} @tab @code{#+latex:}
14228 @item @kbd{h} @tab @code{#+begin_html ... #+end_html}
14229 @item @kbd{H} @tab @code{#+html:}
14230 @item @kbd{a} @tab @code{#+begin_ascii ... #+end_ascii}
14231 @item @kbd{A} @tab @code{#+ascii:}
14232 @item @kbd{i} @tab @code{#+index:} line
14233 @item @kbd{I} @tab @code{#+include:} line
14236 For example, on an empty line, typing "<e" and then pressing TAB, will expand
14237 into a complete EXAMPLE template.
14239 You can install additional templates by customizing the variable
14240 @code{org-structure-template-alist}. See the docstring of the variable for
14241 additional details.
14243 @node Speed keys, Code evaluation security, Easy Templates, Miscellaneous
14244 @section Speed keys
14246 @vindex org-use-speed-commands
14247 @vindex org-speed-commands-user
14249 Single keys can be made to execute commands when the cursor is at the
14250 beginning of a headline, i.e.@: before the first star. Configure the variable
14251 @code{org-use-speed-commands} to activate this feature. There is a
14252 pre-defined list of commands, and you can add more such commands using the
14253 variable @code{org-speed-commands-user}. Speed keys do not only speed up
14254 navigation and other commands, but they also provide an alternative way to
14255 execute commands bound to keys that are not or not easily available on a TTY,
14256 or on a small mobile device with a limited keyboard.
14258 To see which commands are available, activate the feature and press @kbd{?}
14259 with the cursor at the beginning of a headline.
14261 @node Code evaluation security, Customization, Speed keys, Miscellaneous
14262 @section Code evaluation and security issues
14264 Org provides tools to work with the code snippets, including evaluating them.
14266 Running code on your machine always comes with a security risk. Badly
14267 written or malicious code can be executed on purpose or by accident. Org has
14268 default settings which will only evaluate such code if you give explicit
14269 permission to do so, and as a casual user of these features you should leave
14270 these precautions intact.
14272 For people who regularly work with such code, the confirmation prompts can
14273 become annoying, and you might want to turn them off. This can be done, but
14274 you must be aware of the risks that are involved.
14276 Code evaluation can happen under the following circumstances:
14279 @item Source code blocks
14280 Source code blocks can be evaluated during export, or when pressing @kbd{C-c
14281 C-c} in the block. The most important thing to realize here is that Org mode
14282 files which contain code snippets are, in a certain sense, like executable
14283 files. So you should accept them and load them into Emacs only from trusted
14284 sources---just like you would do with a program you install on your computer.
14286 Make sure you know what you are doing before customizing the variables
14287 which take off the default security brakes.
14289 @defopt org-confirm-babel-evaluate
14290 When t (the default), the user is asked before every code block evaluation.
14291 When nil, the user is not asked. When set to a function, it is called with
14292 two arguments (language and body of the code block) and should return t to
14293 ask and nil not to ask.
14296 For example, here is how to execute "ditaa" code (which is considered safe)
14299 (defun my-org-confirm-babel-evaluate (lang body)
14300 (not (string= lang "ditaa"))) ; don't ask for ditaa
14301 (setq org-confirm-babel-evaluate 'my-org-confirm-babel-evaluate)
14304 @item Following @code{shell} and @code{elisp} links
14305 Org has two link types that can directly evaluate code (@pxref{External
14306 links}). These links can be problematic because the code to be evaluated is
14309 @defopt org-confirm-shell-link-function
14310 Function to queries user about shell link execution.
14312 @defopt org-confirm-elisp-link-function
14313 Functions to query user for Emacs Lisp link execution.
14316 @item Formulas in tables
14317 Formulas in tables (@pxref{The spreadsheet}) are code that is evaluated
14318 either by the @i{calc} interpreter, or by the @i{Emacs Lisp} interpreter.
14321 @node Customization, In-buffer settings, Code evaluation security, Miscellaneous
14322 @section Customization
14323 @cindex customization
14324 @cindex options, for customization
14325 @cindex variables, for customization
14327 There are more than 180 variables that can be used to customize
14328 Org. For the sake of compactness of the manual, I am not
14329 describing the variables here. A structured overview of customization
14330 variables is available with @kbd{M-x org-customize}. Or select
14331 @code{Browse Org Group} from the @code{Org->Customization} menu. Many
14332 settings can also be activated on a per-file basis, by putting special
14333 lines into the buffer (@pxref{In-buffer settings}).
14335 @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous
14336 @section Summary of in-buffer settings
14337 @cindex in-buffer settings
14338 @cindex special keywords
14340 Org mode uses special lines in the buffer to define settings on a
14341 per-file basis. These lines start with a @samp{#+} followed by a
14342 keyword, a colon, and then individual words defining a setting. Several
14343 setting words can be in the same line, but you can also have multiple
14344 lines for the keyword. While these settings are described throughout
14345 the manual, here is a summary. After changing any of those lines in the
14346 buffer, press @kbd{C-c C-c} with the cursor still in the line to
14347 activate the changes immediately. Otherwise they become effective only
14348 when the file is visited again in a new Emacs session.
14350 @vindex org-archive-location
14352 @item #+ARCHIVE: %s_done::
14353 This line sets the archive location for the agenda file. It applies for
14354 all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
14355 of the file. The first such line also applies to any entries before it.
14356 The corresponding variable is @code{org-archive-location}.
14358 This line sets the category for the agenda file. The category applies
14359 for all subsequent lines until the next @samp{#+CATEGORY} line, or the
14360 end of the file. The first such line also applies to any entries before it.
14361 @item #+COLUMNS: %25ITEM .....
14362 @cindex property, COLUMNS
14363 Set the default format for columns view. This format applies when
14364 columns view is invoked in locations where no @code{COLUMNS} property
14366 @item #+CONSTANTS: name1=value1 ...
14367 @vindex org-table-formula-constants
14368 @vindex org-table-formula
14369 Set file-local values for constants to be used in table formulas. This
14370 line sets the local variable @code{org-table-formula-constants-local}.
14371 The global version of this variable is
14372 @code{org-table-formula-constants}.
14373 @item #+FILETAGS: :tag1:tag2:tag3:
14374 Set tags that can be inherited by any entry in the file, including the
14376 @item #+DRAWERS: NAME1 .....
14377 @vindex org-drawers
14378 Set the file-local set of drawers. The corresponding global variable is
14379 @code{org-drawers}.
14380 @item #+LINK: linkword replace
14381 @vindex org-link-abbrev-alist
14382 These lines (several are allowed) specify link abbreviations.
14383 @xref{Link abbreviations}. The corresponding variable is
14384 @code{org-link-abbrev-alist}.
14385 @item #+PRIORITIES: highest lowest default
14386 @vindex org-highest-priority
14387 @vindex org-lowest-priority
14388 @vindex org-default-priority
14389 This line sets the limits and the default for the priorities. All three
14390 must be either letters A-Z or numbers 0-9. The highest priority must
14391 have a lower ASCII number than the lowest priority.
14392 @item #+PROPERTY: Property_Name Value
14393 This line sets a default inheritance value for entries in the current
14394 buffer, most useful for specifying the allowed values of a property.
14395 @cindex #+SETUPFILE
14396 @item #+SETUPFILE: file
14397 This line defines a file that holds more in-buffer setup. Normally this is
14398 entirely ignored. Only when the buffer is parsed for option-setting lines
14399 (i.e.@: when starting Org mode for a file, when pressing @kbd{C-c C-c} in a
14400 settings line, or when exporting), then the contents of this file are parsed
14401 as if they had been included in the buffer. In particular, the file can be
14402 any other Org mode file with internal setup. You can visit the file the
14403 cursor is in the line with @kbd{C-c '}.
14406 This line sets options to be used at startup of Org mode, when an
14407 Org file is being visited.
14409 The first set of options deals with the initial visibility of the outline
14410 tree. The corresponding variable for global default settings is
14411 @code{org-startup-folded}, with a default value @code{t}, which means
14413 @vindex org-startup-folded
14414 @cindex @code{overview}, STARTUP keyword
14415 @cindex @code{content}, STARTUP keyword
14416 @cindex @code{showall}, STARTUP keyword
14417 @cindex @code{showeverything}, STARTUP keyword
14419 overview @r{top-level headlines only}
14420 content @r{all headlines}
14421 showall @r{no folding of any entries}
14422 showeverything @r{show even drawer contents}
14425 @vindex org-startup-indented
14426 @cindex @code{indent}, STARTUP keyword
14427 @cindex @code{noindent}, STARTUP keyword
14428 Dynamic virtual indentation is controlled by the variable
14429 @code{org-startup-indented}@footnote{Emacs 23 and Org mode 6.29 are required}
14431 indent @r{start with @code{org-indent-mode} turned on}
14432 noindent @r{start with @code{org-indent-mode} turned off}
14435 @vindex org-startup-align-all-tables
14436 Then there are options for aligning tables upon visiting a file. This
14437 is useful in files containing narrowed table columns. The corresponding
14438 variable is @code{org-startup-align-all-tables}, with a default value
14440 @cindex @code{align}, STARTUP keyword
14441 @cindex @code{noalign}, STARTUP keyword
14443 align @r{align all tables}
14444 noalign @r{don't align tables on startup}
14447 @vindex org-startup-with-inline-images
14448 When visiting a file, inline images can be automatically displayed. The
14449 corresponding variable is @code{org-startup-with-inline-images}, with a
14450 default value @code{nil} to avoid delays when visiting a file.
14451 @cindex @code{inlineimages}, STARTUP keyword
14452 @cindex @code{noinlineimages}, STARTUP keyword
14454 inlineimages @r{show inline images}
14455 noinlineimages @r{don't show inline images on startup}
14458 @vindex org-log-done
14459 @vindex org-log-note-clock-out
14460 @vindex org-log-repeat
14461 Logging the closing and reopening of TODO items and clock intervals can be
14462 configured using these options (see variables @code{org-log-done},
14463 @code{org-log-note-clock-out} and @code{org-log-repeat})
14464 @cindex @code{logdone}, STARTUP keyword
14465 @cindex @code{lognotedone}, STARTUP keyword
14466 @cindex @code{nologdone}, STARTUP keyword
14467 @cindex @code{lognoteclock-out}, STARTUP keyword
14468 @cindex @code{nolognoteclock-out}, STARTUP keyword
14469 @cindex @code{logrepeat}, STARTUP keyword
14470 @cindex @code{lognoterepeat}, STARTUP keyword
14471 @cindex @code{nologrepeat}, STARTUP keyword
14472 @cindex @code{logreschedule}, STARTUP keyword
14473 @cindex @code{lognotereschedule}, STARTUP keyword
14474 @cindex @code{nologreschedule}, STARTUP keyword
14475 @cindex @code{logredeadline}, STARTUP keyword
14476 @cindex @code{lognoteredeadline}, STARTUP keyword
14477 @cindex @code{nologredeadline}, STARTUP keyword
14478 @cindex @code{logrefile}, STARTUP keyword
14479 @cindex @code{lognoterefile}, STARTUP keyword
14480 @cindex @code{nologrefile}, STARTUP keyword
14482 logdone @r{record a timestamp when an item is marked DONE}
14483 lognotedone @r{record timestamp and a note when DONE}
14484 nologdone @r{don't record when items are marked DONE}
14485 logrepeat @r{record a time when reinstating a repeating item}
14486 lognoterepeat @r{record a note when reinstating a repeating item}
14487 nologrepeat @r{do not record when reinstating repeating item}
14488 lognoteclock-out @r{record a note when clocking out}
14489 nolognoteclock-out @r{don't record a note when clocking out}
14490 logreschedule @r{record a timestamp when scheduling time changes}
14491 lognotereschedule @r{record a note when scheduling time changes}
14492 nologreschedule @r{do not record when a scheduling date changes}
14493 logredeadline @r{record a timestamp when deadline changes}
14494 lognoteredeadline @r{record a note when deadline changes}
14495 nologredeadline @r{do not record when a deadline date changes}
14496 logrefile @r{record a timestamp when refiling}
14497 lognoterefile @r{record a note when refiling}
14498 nologrefile @r{do not record when refiling}
14500 @vindex org-hide-leading-stars
14501 @vindex org-odd-levels-only
14502 Here are the options for hiding leading stars in outline headings, and for
14503 indenting outlines. The corresponding variables are
14504 @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
14505 default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
14506 @cindex @code{hidestars}, STARTUP keyword
14507 @cindex @code{showstars}, STARTUP keyword
14508 @cindex @code{odd}, STARTUP keyword
14509 @cindex @code{even}, STARTUP keyword
14511 hidestars @r{make all but one of the stars starting a headline invisible.}
14512 showstars @r{show all stars starting a headline}
14513 indent @r{virtual indentation according to outline level}
14514 noindent @r{no virtual indentation according to outline level}
14515 odd @r{allow only odd outline levels (1,3,...)}
14516 oddeven @r{allow all outline levels}
14518 @vindex org-put-time-stamp-overlays
14519 @vindex org-time-stamp-overlay-formats
14520 To turn on custom format overlays over timestamps (variables
14521 @code{org-put-time-stamp-overlays} and
14522 @code{org-time-stamp-overlay-formats}), use
14523 @cindex @code{customtime}, STARTUP keyword
14525 customtime @r{overlay custom time format}
14527 @vindex constants-unit-system
14528 The following options influence the table spreadsheet (variable
14529 @code{constants-unit-system}).
14530 @cindex @code{constcgs}, STARTUP keyword
14531 @cindex @code{constSI}, STARTUP keyword
14533 constcgs @r{@file{constants.el} should use the c-g-s unit system}
14534 constSI @r{@file{constants.el} should use the SI unit system}
14536 @vindex org-footnote-define-inline
14537 @vindex org-footnote-auto-label
14538 @vindex org-footnote-auto-adjust
14539 To influence footnote settings, use the following keywords. The
14540 corresponding variables are @code{org-footnote-define-inline},
14541 @code{org-footnote-auto-label}, and @code{org-footnote-auto-adjust}.
14542 @cindex @code{fninline}, STARTUP keyword
14543 @cindex @code{nofninline}, STARTUP keyword
14544 @cindex @code{fnlocal}, STARTUP keyword
14545 @cindex @code{fnprompt}, STARTUP keyword
14546 @cindex @code{fnauto}, STARTUP keyword
14547 @cindex @code{fnconfirm}, STARTUP keyword
14548 @cindex @code{fnplain}, STARTUP keyword
14549 @cindex @code{fnadjust}, STARTUP keyword
14550 @cindex @code{nofnadjust}, STARTUP keyword
14552 fninline @r{define footnotes inline}
14553 fnnoinline @r{define footnotes in separate section}
14554 fnlocal @r{define footnotes near first reference, but not inline}
14555 fnprompt @r{prompt for footnote labels}
14556 fnauto @r{create @code{[fn:1]}-like labels automatically (default)}
14557 fnconfirm @r{offer automatic label for editing or confirmation}
14558 fnplain @r{create @code{[1]}-like labels automatically}
14559 fnadjust @r{automatically renumber and sort footnotes}
14560 nofnadjust @r{do not renumber and sort automatically}
14562 @cindex org-hide-block-startup
14563 To hide blocks on startup, use these keywords. The corresponding variable is
14564 @code{org-hide-block-startup}.
14565 @cindex @code{hideblocks}, STARTUP keyword
14566 @cindex @code{nohideblocks}, STARTUP keyword
14568 hideblocks @r{Hide all begin/end blocks on startup}
14569 nohideblocks @r{Do not hide blocks on startup}
14571 @cindex org-pretty-entities
14572 The display of entities as UTF-8 characters is governed by the variable
14573 @code{org-pretty-entities} and the keywords
14574 @cindex @code{entitiespretty}, STARTUP keyword
14575 @cindex @code{entitiesplain}, STARTUP keyword
14577 entitiespretty @r{Show entities as UTF-8 characters where possible}
14578 entitiesplain @r{Leave entities plain}
14580 @item #+TAGS: TAG1(c1) TAG2(c2)
14581 @vindex org-tag-alist
14582 These lines (several such lines are allowed) specify the valid tags in
14583 this file, and (potentially) the corresponding @emph{fast tag selection}
14584 keys. The corresponding variable is @code{org-tag-alist}.
14586 This line contains the formulas for the table directly above the line.
14587 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+DATE:,
14588 @itemx #+OPTIONS:, #+BIND:, #+XSLT:,
14589 @itemx #+DESCRIPTION:, #+KEYWORDS:,
14590 @itemx #+LATEX_HEADER:, #+STYLE:, #+LINK_UP:, #+LINK_HOME:,
14591 @itemx #+EXPORT_SELECT_TAGS:, #+EXPORT_EXCLUDE_TAGS:
14592 These lines provide settings for exporting files. For more details see
14593 @ref{Export options}.
14594 @item #+TODO: #+SEQ_TODO: #+TYP_TODO:
14595 @vindex org-todo-keywords
14596 These lines set the TODO keywords and their interpretation in the
14597 current file. The corresponding variable is @code{org-todo-keywords}.
14600 @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous
14601 @section The very busy C-c C-c key
14603 @cindex C-c C-c, overview
14605 The key @kbd{C-c C-c} has many purposes in Org, which are all
14606 mentioned scattered throughout this manual. One specific function of
14607 this key is to add @emph{tags} to a headline (@pxref{Tags}). In many
14608 other circumstances it means something like @emph{``Hey Org, look
14609 here and update according to what you see here''}. Here is a summary of
14610 what this means in different contexts.
14614 If there are highlights in the buffer from the creation of a sparse
14615 tree, or from clock display, remove these highlights.
14617 If the cursor is in one of the special @code{#+KEYWORD} lines, this
14618 triggers scanning the buffer for these lines and updating the
14621 If the cursor is inside a table, realign the table. This command
14622 works even if the automatic table editor has been turned off.
14624 If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
14627 If the current buffer is a capture buffer, close the note and file it.
14628 With a prefix argument, file it, without further interaction, to the
14631 If the cursor is on a @code{<<<target>>>}, update radio targets and
14632 corresponding links in this buffer.
14634 If the cursor is in a property line or at the start or end of a property
14635 drawer, offer property commands.
14637 If the cursor is at a footnote reference, go to the corresponding
14638 definition, and vice versa.
14640 If the cursor is on a statistics cookie, update it.
14642 If the cursor is in a plain list item with a checkbox, toggle the status
14645 If the cursor is on a numbered item in a plain list, renumber the
14648 If the cursor is on the @code{#+BEGIN} line of a dynamic block, the
14651 If the cursor is at a timestamp, fix the day name in the timestamp.
14654 @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous
14655 @section A cleaner outline view
14656 @cindex hiding leading stars
14657 @cindex dynamic indentation
14658 @cindex odd-levels-only outlines
14659 @cindex clean outline view
14661 Some people find it noisy and distracting that the Org headlines start with a
14662 potentially large number of stars, and that text below the headlines is not
14663 indented. While this is no problem when writing a @emph{book-like} document
14664 where the outline headings are really section headings, in a more
14665 @emph{list-oriented} outline, indented structure is a lot cleaner:
14669 * Top level headline | * Top level headline
14670 ** Second level | * Second level
14671 *** 3rd level | * 3rd level
14672 some text | some text
14673 *** 3rd level | * 3rd level
14674 more text | more text
14675 * Another top level headline | * Another top level headline
14681 If you are using at least Emacs 23.2@footnote{Emacs 23.1 can actually crash
14682 with @code{org-indent-mode}} and version 6.29 of Org, this kind of view can
14683 be achieved dynamically at display time using @code{org-indent-mode}. In
14684 this minor mode, all lines are prefixed for display with the necessary amount
14685 of space@footnote{@code{org-indent-mode} also sets the @code{wrap-prefix}
14686 property, such that @code{visual-line-mode} (or purely setting
14687 @code{word-wrap}) wraps long lines (including headlines) correctly indented.
14688 }. Also headlines are prefixed with additional stars, so that the amount of
14689 indentation shifts by two@footnote{See the variable
14690 @code{org-indent-indentation-per-level}.} spaces per level. All headline
14691 stars but the last one are made invisible using the @code{org-hide}
14692 face@footnote{Turning on @code{org-indent-mode} sets
14693 @code{org-hide-leading-stars} to @code{t} and @code{org-adapt-indentation} to
14694 @code{nil}.} - see below under @samp{2.} for more information on how this
14695 works. You can turn on @code{org-indent-mode} for all files by customizing
14696 the variable @code{org-startup-indented}, or you can turn it on for
14697 individual files using
14703 If you want a similar effect in an earlier version of Emacs and/or Org, or if
14704 you want the indentation to be hard space characters so that the plain text
14705 file looks as similar as possible to the Emacs display, Org supports you in
14710 @emph{Indentation of text below headlines}@*
14711 You may indent text below each headline to make the left boundary line up
14712 with the headline, like
14716 more text, now indented
14719 @vindex org-adapt-indentation
14720 Org supports this with paragraph filling, line wrapping, and structure
14721 editing@footnote{See also the variable @code{org-adapt-indentation}.},
14722 preserving or adapting the indentation as appropriate.
14725 @vindex org-hide-leading-stars
14726 @emph{Hiding leading stars}@* You can modify the display in such a way that
14727 all leading stars become invisible. To do this in a global way, configure
14728 the variable @code{org-hide-leading-stars} or change this on a per-file basis
14732 #+STARTUP: hidestars
14733 #+STARTUP: showstars
14736 With hidden stars, the tree becomes:
14740 * Top level headline
14748 @vindex org-hide @r{(face)}
14749 The leading stars are not truly replaced by whitespace, they are only
14750 fontified with the face @code{org-hide} that uses the background color as
14751 font color. If you are not using either white or black background, you may
14752 have to customize this face to get the wanted effect. Another possibility is
14753 to set this font such that the extra stars are @i{almost} invisible, for
14754 example using the color @code{grey90} on a white background.
14757 @vindex org-odd-levels-only
14758 Things become cleaner still if you skip all the even levels and use only odd
14759 levels 1, 3, 5..., effectively adding two stars to go from one outline level
14760 to the next@footnote{When you need to specify a level for a property search
14761 or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc@.}. In this
14762 way we get the outline view shown at the beginning of this section. In order
14763 to make the structure editing and export commands handle this convention
14764 correctly, configure the variable @code{org-odd-levels-only}, or set this on
14765 a per-file basis with one of the following lines:
14772 You can convert an Org file from single-star-per-level to the
14773 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
14774 RET} in that file. The reverse operation is @kbd{M-x
14775 org-convert-to-oddeven-levels}.
14778 @node TTY keys, Interaction, Clean view, Miscellaneous
14779 @section Using Org on a tty
14780 @cindex tty key bindings
14782 Because Org contains a large number of commands, by default many of
14783 Org's core commands are bound to keys that are generally not
14784 accessible on a tty, such as the cursor keys (@key{left}, @key{right},
14785 @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
14786 together with modifiers like @key{Meta} and/or @key{Shift}. To access
14787 these commands on a tty when special keys are unavailable, the following
14788 alternative bindings can be used. The tty bindings below will likely be
14789 more cumbersome; you may find for some of the bindings below that a
14790 customized workaround suits you better. For example, changing a timestamp
14791 is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
14792 tty you would rather use @kbd{C-c .} to re-insert the timestamp.
14794 @multitable @columnfractions 0.15 0.2 0.1 0.2
14795 @item @b{Default} @tab @b{Alternative 1} @tab @b{Speed key} @tab @b{Alternative 2}
14796 @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab @kbd{C} @tab
14797 @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{l} @tab @kbd{@key{Esc} @key{left}}
14798 @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab @kbd{L} @tab
14799 @item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{r} @tab @kbd{@key{Esc} @key{right}}
14800 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab @kbd{R} @tab
14801 @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{ } @tab @kbd{@key{Esc} @key{up}}
14802 @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab @kbd{U} @tab
14803 @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{ } @tab @kbd{@key{Esc} @key{down}}
14804 @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab @kbd{D} @tab
14805 @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab @kbd{ } @tab
14806 @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{ } @tab @kbd{@key{Esc} @key{RET}}
14807 @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab @kbd{ } @tab
14808 @item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab @kbd{ } @tab
14809 @item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab @kbd{ } @tab
14810 @item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab @kbd{ } @tab
14811 @item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab @kbd{ } @tab
14812 @item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab @kbd{ } @tab
14813 @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab @kbd{ } @tab
14817 @node Interaction, org-crypt.el, TTY keys, Miscellaneous
14818 @section Interaction with other packages
14819 @cindex packages, interaction with other
14820 Org lives in the world of GNU Emacs and interacts in various ways
14821 with other code out there.
14824 * Cooperation:: Packages Org cooperates with
14825 * Conflicts:: Packages that lead to conflicts
14828 @node Cooperation, Conflicts, Interaction, Interaction
14829 @subsection Packages that Org cooperates with
14832 @cindex @file{calc.el}
14833 @cindex Gillespie, Dave
14834 @item @file{calc.el} by Dave Gillespie
14835 Org uses the Calc package for implementing spreadsheet
14836 functionality in its tables (@pxref{The spreadsheet}). Org
14837 checks for the availability of Calc by looking for the function
14838 @code{calc-eval} which will have been autoloaded during setup if Calc has
14839 been installed properly. As of Emacs 22, Calc is part of the Emacs
14840 distribution. Another possibility for interaction between the two
14841 packages is using Calc for embedded calculations. @xref{Embedded Mode,
14842 , Embedded Mode, Calc, GNU Emacs Calc Manual}.
14843 @item @file{constants.el} by Carsten Dominik
14844 @cindex @file{constants.el}
14845 @cindex Dominik, Carsten
14846 @vindex org-table-formula-constants
14847 In a table formula (@pxref{The spreadsheet}), it is possible to use
14848 names for natural constants or units. Instead of defining your own
14849 constants in the variable @code{org-table-formula-constants}, install
14850 the @file{constants} package which defines a large number of constants
14851 and units, and lets you use unit prefixes like @samp{M} for
14852 @samp{Mega}, etc@. You will need version 2.0 of this package, available
14853 at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for
14854 the function @code{constants-get}, which has to be autoloaded in your
14855 setup. See the installation instructions in the file
14856 @file{constants.el}.
14857 @item @file{cdlatex.el} by Carsten Dominik
14858 @cindex @file{cdlatex.el}
14859 @cindex Dominik, Carsten
14860 Org mode can make use of the CD@LaTeX{} package to efficiently enter
14861 @LaTeX{} fragments into Org files. See @ref{CDLaTeX mode}.
14862 @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
14863 @cindex @file{imenu.el}
14864 Imenu allows menu access to an index of items in a file. Org mode
14865 supports Imenu---all you need to do to get the index is the following:
14867 (add-hook 'org-mode-hook
14868 (lambda () (imenu-add-to-menubar "Imenu")))
14870 @vindex org-imenu-depth
14871 By default the index is two levels deep---you can modify the depth using
14872 the option @code{org-imenu-depth}.
14873 @item @file{remember.el} by John Wiegley
14874 @cindex @file{remember.el}
14875 @cindex Wiegley, John
14876 Org used to use this package for capture, but no longer does.
14877 @item @file{speedbar.el} by Eric M. Ludlam
14878 @cindex @file{speedbar.el}
14879 @cindex Ludlam, Eric M.
14880 Speedbar is a package that creates a special frame displaying files and
14881 index items in files. Org mode supports Speedbar and allows you to
14882 drill into Org files directly from the Speedbar. It also allows you to
14883 restrict the scope of agenda commands to a file or a subtree by using
14884 the command @kbd{<} in the Speedbar frame.
14885 @cindex @file{table.el}
14886 @item @file{table.el} by Takaaki Ota
14888 @cindex table editor, @file{table.el}
14889 @cindex @file{table.el}
14890 @cindex Ota, Takaaki
14892 Complex ASCII tables with automatic line wrapping, column- and row-spanning,
14893 and alignment can be created using the Emacs table package by Takaaki Ota
14894 (@uref{http://sourceforge.net/projects/table}, and also part of Emacs 22).
14895 Org mode will recognize these tables and export them properly. Because of
14896 interference with other Org mode functionality, you unfortunately cannot edit
14897 these tables directly in the buffer. Instead, you need to use the command
14898 @kbd{C-c '} to edit them, similar to source code snippets.
14901 @orgcmd{C-c ',org-edit-special}
14902 Edit a @file{table.el} table. Works when the cursor is in a table.el table.
14904 @orgcmd{C-c ~,org-table-create-with-table.el}
14905 Insert a @file{table.el} table. If there is already a table at point, this
14906 command converts it between the @file{table.el} format and the Org mode
14907 format. See the documentation string of the command
14908 @code{org-convert-table} for the restrictions under which this is
14911 @file{table.el} is part of Emacs since Emacs 22.
14912 @item @file{footnote.el} by Steven L. Baur
14913 @cindex @file{footnote.el}
14914 @cindex Baur, Steven L.
14915 Org mode recognizes numerical footnotes as provided by this package.
14916 However, Org mode also has its own footnote support (@pxref{Footnotes}),
14917 which makes using @file{footnote.el} unnecessary.
14920 @node Conflicts, , Cooperation, Interaction
14921 @subsection Packages that lead to conflicts with Org mode
14925 @cindex @code{shift-selection-mode}
14926 @vindex org-support-shift-select
14927 In Emacs 23, @code{shift-selection-mode} is on by default, meaning that
14928 cursor motions combined with the shift key should start or enlarge regions.
14929 This conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change
14930 timestamps, TODO keywords, priorities, and item bullet types if the cursor is
14931 at such a location. By default, @kbd{S-@key{cursor}} commands outside
14932 special contexts don't do anything, but you can customize the variable
14933 @code{org-support-shift-select}. Org mode then tries to accommodate shift
14934 selection by (i) using it outside of the special contexts where special
14935 commands apply, and by (ii) extending an existing active region even if the
14936 cursor moves across a special context.
14938 @item @file{CUA.el} by Kim. F. Storm
14939 @cindex @file{CUA.el}
14940 @cindex Storm, Kim. F.
14941 @vindex org-replace-disputed-keys
14942 Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by CUA mode
14943 (as well as @code{pc-select-mode} and @code{s-region-mode}) to select and extend the
14944 region. In fact, Emacs 23 has this built-in in the form of
14945 @code{shift-selection-mode}, see previous paragraph. If you are using Emacs
14946 23, you probably don't want to use another package for this purpose. However,
14947 if you prefer to leave these keys to a different package while working in
14948 Org mode, configure the variable @code{org-replace-disputed-keys}. When set,
14949 Org will move the following key bindings in Org files, and in the agenda
14950 buffer (but not during date selection).
14953 S-UP @result{} M-p S-DOWN @result{} M-n
14954 S-LEFT @result{} M-- S-RIGHT @result{} M-+
14955 C-S-LEFT @result{} M-S-- C-S-RIGHT @result{} M-S-+
14958 @vindex org-disputed-keys
14959 Yes, these are unfortunately more difficult to remember. If you want
14960 to have other replacement keys, look at the variable
14961 @code{org-disputed-keys}.
14963 @item @file{yasnippet.el}
14964 @cindex @file{yasnippet.el}
14965 The way Org mode binds the TAB key (binding to @code{[tab]} instead of
14966 @code{"\t"}) overrules YASnippet's access to this key. The following code
14967 fixed this problem:
14970 (add-hook 'org-mode-hook
14972 (org-set-local 'yas/trigger-key [tab])
14973 (define-key yas/keymap [tab] 'yas/next-field-or-maybe-expand)))
14976 The latest version of yasnippet doesn't play well with Org mode. If the
14977 above code does not fix the conflict, start by defining the following
14981 (defun yas/org-very-safe-expand ()
14982 (let ((yas/fallback-behavior 'return-nil)) (yas/expand)))
14985 Then, tell Org mode what to do with the new function:
14988 (add-hook 'org-mode-hook
14990 (make-variable-buffer-local 'yas/trigger-key)
14991 (setq yas/trigger-key [tab])
14992 (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand)
14993 (define-key yas/keymap [tab] 'yas/next-field)))
14996 @item @file{windmove.el} by Hovav Shacham
14997 @cindex @file{windmove.el}
14998 This package also uses the @kbd{S-<cursor>} keys, so everything written
14999 in the paragraph above about CUA mode also applies here. If you want make
15000 the windmove function active in locations where Org mode does not have
15001 special functionality on @kbd{S-@key{cursor}}, add this to your
15005 ;; Make windmove work in org-mode:
15006 (add-hook 'org-shiftup-final-hook 'windmove-up)
15007 (add-hook 'org-shiftleft-final-hook 'windmove-left)
15008 (add-hook 'org-shiftdown-final-hook 'windmove-down)
15009 (add-hook 'org-shiftright-final-hook 'windmove-right)
15012 @item @file{viper.el} by Michael Kifer
15013 @cindex @file{viper.el}
15015 Viper uses @kbd{C-c /} and therefore makes this key not access the
15016 corresponding Org mode command @code{org-sparse-tree}. You need to find
15017 another key for this command, or override the key in
15018 @code{viper-vi-global-user-map} with
15021 (define-key viper-vi-global-user-map "C-c /" 'org-sparse-tree)
15026 @node org-crypt.el, , Interaction, Miscellaneous
15027 @section org-crypt.el
15028 @cindex @file{org-crypt.el}
15029 @cindex @code{org-decrypt-entry}
15031 Org-crypt will encrypt the text of an entry, but not the headline, or
15032 properties. Org-crypt uses the Emacs EasyPG library to encrypt and decrypt
15035 Any text below a headline that has a @samp{:crypt:} tag will be automatically
15036 be encrypted when the file is saved. If you want to use a different tag just
15037 customize the @code{org-crypt-tag-matcher} setting.
15039 To use org-crypt it is suggested that you have the following in your
15043 (require 'org-crypt)
15044 (org-crypt-use-before-save-magic)
15045 (setq org-tags-exclude-from-inheritance (quote ("crypt")))
15047 (setq org-crypt-key nil)
15048 ;; GPG key to use for encryption
15049 ;; Either the Key ID or set to nil to use symmetric encryption.
15051 (setq auto-save-default nil)
15052 ;; Auto-saving does not cooperate with org-crypt.el: so you need
15053 ;; to turn it off if you plan to use org-crypt.el quite often.
15054 ;; Otherwise, you'll get an (annoying) message each time you
15057 ;; To turn it off only locally, you can insert this:
15059 ;; # -*- buffer-auto-save-file-name: nil; -*-
15062 Excluding the crypt tag from inheritance prevents already encrypted text
15063 being encrypted again.
15065 @node Hacking, MobileOrg, Miscellaneous, Top
15069 This appendix covers some aspects where users can extend the functionality of
15073 * Hooks:: Who to reach into Org's internals
15074 * Add-on packages:: Available extensions
15075 * Adding hyperlink types:: New custom link types
15076 * Context-sensitive commands:: How to add functionality to such commands
15077 * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
15078 * Dynamic blocks:: Automatically filled blocks
15079 * Special agenda views:: Customized views
15080 * Extracting agenda information:: Postprocessing of agenda information
15081 * Using the property API:: Writing programs that use entry properties
15082 * Using the mapping API:: Mapping over all or selected entries
15085 @node Hooks, Add-on packages, Hacking, Hacking
15089 Org has a large number of hook variables that can be used to add
15090 functionality. This appendix about hacking is going to illustrate the
15091 use of some of them. A complete list of all hooks with documentation is
15092 maintained by the Worg project and can be found at
15093 @uref{http://orgmode.org/worg/org-configs/org-hooks.php}.
15095 @node Add-on packages, Adding hyperlink types, Hooks, Hacking
15096 @section Add-on packages
15097 @cindex add-on packages
15099 A large number of add-on packages have been written by various authors.
15100 These packages are not part of Emacs, but they are distributed as contributed
15101 packages with the separate release available at the Org mode home page at
15102 @uref{http://orgmode.org}. The list of contributed packages, along with
15103 documentation about each package, is maintained by the Worg project at
15104 @uref{http://orgmode.org/worg/org-contrib/}.
15108 @node Adding hyperlink types, Context-sensitive commands, Add-on packages, Hacking
15109 @section Adding hyperlink types
15110 @cindex hyperlinks, adding new types
15112 Org has a large number of hyperlink types built-in
15113 (@pxref{Hyperlinks}). If you would like to add new link types, Org
15114 provides an interface for doing so. Let's look at an example file,
15115 @file{org-man.el}, that will add support for creating links like
15116 @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
15120 ;;; org-man.el - Support for links to manpages in Org
15124 (org-add-link-type "man" 'org-man-open)
15125 (add-hook 'org-store-link-functions 'org-man-store-link)
15127 (defcustom org-man-command 'man
15128 "The Emacs command to be used to display a man page."
15130 :type '(choice (const man) (const woman)))
15132 (defun org-man-open (path)
15133 "Visit the manpage on PATH.
15134 PATH should be a topic that can be thrown at the man command."
15135 (funcall org-man-command path))
15137 (defun org-man-store-link ()
15138 "Store a link to a manpage."
15139 (when (memq major-mode '(Man-mode woman-mode))
15140 ;; This is a man page, we do make this link
15141 (let* ((page (org-man-get-page-name))
15142 (link (concat "man:" page))
15143 (description (format "Manpage for %s" page)))
15144 (org-store-link-props
15147 :description description))))
15149 (defun org-man-get-page-name ()
15150 "Extract the page name from the buffer name."
15151 ;; This works for both `Man-mode' and `woman-mode'.
15152 (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
15153 (match-string 1 (buffer-name))
15154 (error "Cannot create link to this man page")))
15158 ;;; org-man.el ends here
15162 You would activate this new link type in @file{.emacs} with
15169 Let's go through the file and see what it does.
15172 It does @code{(require 'org)} to make sure that @file{org.el} has been
15175 The next line calls @code{org-add-link-type} to define a new link type
15176 with prefix @samp{man}. The call also contains the name of a function
15177 that will be called to follow such a link.
15179 @vindex org-store-link-functions
15180 The next line adds a function to @code{org-store-link-functions}, in
15181 order to allow the command @kbd{C-c l} to record a useful link in a
15182 buffer displaying a man page.
15185 The rest of the file defines the necessary variables and functions.
15186 First there is a customization variable that determines which Emacs
15187 command should be used to display man pages. There are two options,
15188 @code{man} and @code{woman}. Then the function to follow a link is
15189 defined. It gets the link path as an argument---in this case the link
15190 path is just a topic for the manual command. The function calls the
15191 value of @code{org-man-command} to display the man page.
15193 Finally the function @code{org-man-store-link} is defined. When you try
15194 to store a link with @kbd{C-c l}, this function will be called to
15195 try to make a link. The function must first decide if it is supposed to
15196 create the link for this buffer type; we do this by checking the value
15197 of the variable @code{major-mode}. If not, the function must exit and
15198 return the value @code{nil}. If yes, the link is created by getting the
15199 manual topic from the buffer name and prefixing it with the string
15200 @samp{man:}. Then it must call the command @code{org-store-link-props}
15201 and set the @code{:type} and @code{:link} properties. Optionally you
15202 can also set the @code{:description} property to provide a default for
15203 the link description when the link is later inserted into an Org
15204 buffer with @kbd{C-c C-l}.
15206 When it makes sense for your new link type, you may also define a function
15207 @code{org-PREFIX-complete-link} that implements special (e.g.@: completion)
15208 support for inserting such a link with @kbd{C-c C-l}. Such a function should
15209 not accept any arguments, and return the full link with prefix.
15211 @node Context-sensitive commands, Tables in arbitrary syntax, Adding hyperlink types, Hacking
15212 @section Context-sensitive commands
15213 @cindex context-sensitive commands, hooks
15214 @cindex add-ons, context-sensitive commands
15215 @vindex org-ctrl-c-ctrl-c-hook
15217 Org has several commands that act differently depending on context. The most
15218 important example it the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}).
15219 Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys have this property.
15221 Add-ons can tap into this functionality by providing a function that detects
15222 special context for that add-on and executes functionality appropriate for
15223 the context. Here is an example from Dan Davison's @file{org-R.el} which
15224 allows you to evaluate commands based on the @file{R} programming language
15225 @footnote{@file{org-R.el} has been replaced by the Org mode functionality
15226 described in @ref{Working With Source Code} and is now obsolete.}. For this
15227 package, special contexts are lines that start with @code{#+R:} or
15231 (defun org-R-apply-maybe ()
15232 "Detect if this is context for org-R and execute R commands."
15233 (if (save-excursion
15234 (beginning-of-line 1)
15235 (looking-at "#\\+RR?:"))
15236 (progn (call-interactively 'org-R-apply)
15237 t) ;; to signal that we took action
15238 nil)) ;; to signal that we did not
15240 (add-hook 'org-ctrl-c-ctrl-c-hook 'org-R-apply-maybe)
15243 The function first checks if the cursor is in such a line. If that is the
15244 case, @code{org-R-apply} is called and the function returns @code{t} to
15245 signal that action was taken, and @kbd{C-c C-c} will stop looking for other
15246 contexts. If the function finds it should do nothing locally, it returns
15247 @code{nil} so that other, similar functions can have a try.
15250 @node Tables in arbitrary syntax, Dynamic blocks, Context-sensitive commands, Hacking
15251 @section Tables and lists in arbitrary syntax
15252 @cindex tables, in other modes
15253 @cindex lists, in other modes
15254 @cindex Orgtbl mode
15256 Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
15257 frequent feature request has been to make it work with native tables in
15258 specific languages, for example @LaTeX{}. However, this is extremely
15259 hard to do in a general way, would lead to a customization nightmare,
15260 and would take away much of the simplicity of the Orgtbl mode table
15263 This appendix describes a different approach. We keep the Orgtbl mode
15264 table in its native format (the @i{source table}), and use a custom
15265 function to @i{translate} the table to the correct syntax, and to
15266 @i{install} it in the right location (the @i{target table}). This puts
15267 the burden of writing conversion functions on the user, but it allows
15268 for a very flexible system.
15270 Bastien added the ability to do the same with lists, in Orgstruct mode. You
15271 can use Org's facilities to edit and structure lists by turning
15272 @code{orgstruct-mode} on, then locally exporting such lists in another format
15273 (HTML, @LaTeX{} or Texinfo.)
15277 * Radio tables:: Sending and receiving radio tables
15278 * A @LaTeX{} example:: Step by step, almost a tutorial
15279 * Translator functions:: Copy and modify
15280 * Radio lists:: Doing the same for lists
15283 @node Radio tables, A @LaTeX{} example, Tables in arbitrary syntax, Tables in arbitrary syntax
15284 @subsection Radio tables
15285 @cindex radio tables
15287 To define the location of the target table, you first need to create two
15288 lines that are comments in the current mode, but contain magic words for
15289 Orgtbl mode to find. Orgtbl mode will insert the translated table
15290 between these lines, replacing whatever was there before. For example:
15293 /* BEGIN RECEIVE ORGTBL table_name */
15294 /* END RECEIVE ORGTBL table_name */
15298 Just above the source table, we put a special line that tells
15299 Orgtbl mode how to translate this table and where to install it. For
15303 #+ORGTBL: SEND table_name translation_function arguments....
15307 @code{table_name} is the reference name for the table that is also used
15308 in the receiver lines. @code{translation_function} is the Lisp function
15309 that does the translation. Furthermore, the line can contain a list of
15310 arguments (alternating key and value) at the end. The arguments will be
15311 passed as a property list to the translation function for
15312 interpretation. A few standard parameters are already recognized and
15313 acted upon before the translation function is called:
15317 Skip the first N lines of the table. Hlines do count as separate lines for
15320 @item :skipcols (n1 n2 ...)
15321 List of columns that should be skipped. If the table has a column with
15322 calculation marks, that column is automatically discarded as well.
15323 Please note that the translator function sees the table @emph{after} the
15324 removal of these columns, the function never knows that there have been
15325 additional columns.
15329 The one problem remaining is how to keep the source table in the buffer
15330 without disturbing the normal workings of the file, for example during
15331 compilation of a C file or processing of a @LaTeX{} file. There are a
15332 number of different solutions:
15336 The table could be placed in a block comment if that is supported by the
15337 language. For example, in C mode you could wrap the table between
15338 @samp{/*} and @samp{*/} lines.
15340 Sometimes it is possible to put the table after some kind of @i{END}
15341 statement, for example @samp{\bye} in @TeX{} and @samp{\end@{document@}}
15344 You can just comment the table line-by-line whenever you want to process
15345 the file, and uncomment it whenever you need to edit the table. This
15346 only sounds tedious---the command @kbd{M-x orgtbl-toggle-comment}
15347 makes this comment-toggling very easy, in particular if you bind it to a
15351 @node A @LaTeX{} example, Translator functions, Radio tables, Tables in arbitrary syntax
15352 @subsection A @LaTeX{} example of radio tables
15353 @cindex @LaTeX{}, and Orgtbl mode
15355 The best way to wrap the source table in @LaTeX{} is to use the
15356 @code{comment} environment provided by @file{comment.sty}. It has to be
15357 activated by placing @code{\usepackage@{comment@}} into the document
15358 header. Orgtbl mode can insert a radio table skeleton@footnote{By
15359 default this works only for @LaTeX{}, HTML, and Texinfo. Configure the
15360 variable @code{orgtbl-radio-tables} to install templates for other
15361 modes.} with the command @kbd{M-x orgtbl-insert-radio-table}. You will
15362 be prompted for a table name, let's say we use @samp{salesfigures}. You
15363 will then get the following template:
15365 @cindex #+ORGTBL, SEND
15367 % BEGIN RECEIVE ORGTBL salesfigures
15368 % END RECEIVE ORGTBL salesfigures
15370 #+ORGTBL: SEND salesfigures orgtbl-to-latex
15376 @vindex @LaTeX{}-verbatim-environments
15377 The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
15378 @code{orgtbl-to-latex} to convert the table into @LaTeX{} and to put it
15379 into the receiver location with name @code{salesfigures}. You may now
15380 fill in the table---feel free to use the spreadsheet features@footnote{If
15381 the @samp{#+TBLFM} line contains an odd number of dollar characters,
15382 this may cause problems with font-lock in @LaTeX{} mode. As shown in the
15383 example you can fix this by adding an extra line inside the
15384 @code{comment} environment that is used to balance the dollar
15385 expressions. If you are using AUC@TeX{} with the font-latex library, a
15386 much better solution is to add the @code{comment} environment to the
15387 variable @code{LaTeX-verbatim-environments}.}:
15390 % BEGIN RECEIVE ORGTBL salesfigures
15391 % END RECEIVE ORGTBL salesfigures
15393 #+ORGTBL: SEND salesfigures orgtbl-to-latex
15394 | Month | Days | Nr sold | per day |
15395 |-------+------+---------+---------|
15396 | Jan | 23 | 55 | 2.4 |
15397 | Feb | 21 | 16 | 0.8 |
15398 | March | 22 | 278 | 12.6 |
15399 #+TBLFM: $4=$3/$2;%.1f
15400 % $ (optional extra dollar to keep font-lock happy, see footnote)
15405 When you are done, press @kbd{C-c C-c} in the table to get the converted
15406 table inserted between the two marker lines.
15408 Now let's assume you want to make the table header by hand, because you
15409 want to control how columns are aligned, etc@. In this case we make sure
15410 that the table translator skips the first 2 lines of the source
15411 table, and tell the command to work as a @i{splice}, i.e.@: to not produce
15412 header and footer commands of the target table:
15415 \begin@{tabular@}@{lrrr@}
15416 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
15417 % BEGIN RECEIVE ORGTBL salesfigures
15418 % END RECEIVE ORGTBL salesfigures
15422 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
15423 | Month | Days | Nr sold | per day |
15424 |-------+------+---------+---------|
15425 | Jan | 23 | 55 | 2.4 |
15426 | Feb | 21 | 16 | 0.8 |
15427 | March | 22 | 278 | 12.6 |
15428 #+TBLFM: $4=$3/$2;%.1f
15432 The @LaTeX{} translator function @code{orgtbl-to-latex} is already part of
15433 Orgtbl mode. It uses a @code{tabular} environment to typeset the table
15434 and marks horizontal lines with @code{\hline}. Furthermore, it
15435 interprets the following parameters (see also @pxref{Translator functions}):
15438 @item :splice nil/t
15439 When set to t, return only table body lines, don't wrap them into a
15440 tabular environment. Default is nil.
15443 A format to be used to wrap each field, it should contain @code{%s} for the
15444 original field value. For example, to wrap each field value in dollars,
15445 you could use @code{:fmt "$%s$"}. This may also be a property list with
15446 column numbers and formats, for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
15447 A function of one argument can be used in place of the strings; the
15448 function must return a formatted string.
15451 Use this format to print numbers with exponentials. The format should
15452 have @code{%s} twice for inserting mantissa and exponent, for example
15453 @code{"%s\\times10^@{%s@}"}. The default is @code{"%s\\,(%s)"}. This
15454 may also be a property list with column numbers and formats, for example
15455 @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After
15456 @code{efmt} has been applied to a value, @code{fmt} will also be
15457 applied. Similar to @code{fmt}, functions of two arguments can be
15458 supplied instead of strings.
15461 @node Translator functions, Radio lists, A @LaTeX{} example, Tables in arbitrary syntax
15462 @subsection Translator functions
15463 @cindex HTML, and Orgtbl mode
15464 @cindex translator function
15466 Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
15467 (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
15468 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and @code{orgtbl-to-texinfo}.
15469 Except for @code{orgtbl-to-html}@footnote{The HTML translator uses the same
15470 code that produces tables during HTML export.}, these all use a generic
15471 translator, @code{orgtbl-to-generic}. For example, @code{orgtbl-to-latex}
15472 itself is a very short function that computes the column definitions for the
15473 @code{tabular} environment, defines a few field and line separators and then
15474 hands processing over to the generic translator. Here is the entire code:
15478 (defun orgtbl-to-latex (table params)
15479 "Convert the Orgtbl mode TABLE to LaTeX."
15480 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
15481 org-table-last-alignment ""))
15484 :tstart (concat "\\begin@{tabular@}@{" alignment "@}")
15485 :tend "\\end@{tabular@}"
15486 :lstart "" :lend " \\\\" :sep " & "
15487 :efmt "%s\\,(%s)" :hline "\\hline")))
15488 (orgtbl-to-generic table (org-combine-plists params2 params))))
15492 As you can see, the properties passed into the function (variable
15493 @var{PARAMS}) are combined with the ones newly defined in the function
15494 (variable @var{PARAMS2}). The ones passed into the function (i.e.@: the
15495 ones set by the @samp{ORGTBL SEND} line) take precedence. So if you
15496 would like to use the @LaTeX{} translator, but wanted the line endings to
15497 be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
15498 overrule the default with
15501 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
15504 For a new language, you can either write your own converter function in
15505 analogy with the @LaTeX{} translator, or you can use the generic function
15506 directly. For example, if you have a language where a table is started
15507 with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are
15508 started with @samp{!BL!}, ended with @samp{!EL!}, and where the field
15509 separator is a TAB, you could call the generic translator like this (on
15513 #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
15514 :lstart "!BL! " :lend " !EL!" :sep "\t"
15518 Please check the documentation string of the function
15519 @code{orgtbl-to-generic} for a full list of parameters understood by
15520 that function, and remember that you can pass each of them into
15521 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
15522 using the generic function.
15524 Of course you can also write a completely new function doing complicated
15525 things the generic translator cannot do. A translator function takes
15526 two arguments. The first argument is the table, a list of lines, each
15527 line either the symbol @code{hline} or a list of fields. The second
15528 argument is the property list containing all parameters specified in the
15529 @samp{#+ORGTBL: SEND} line. The function must return a single string
15530 containing the formatted table. If you write a generally useful
15531 translator, please post it on @email{emacs-orgmode@@gnu.org} so that
15532 others can benefit from your work.
15534 @node Radio lists, , Translator functions, Tables in arbitrary syntax
15535 @subsection Radio lists
15536 @cindex radio lists
15537 @cindex org-list-insert-radio-list
15539 Sending and receiving radio lists works exactly the same way as sending and
15540 receiving radio tables (@pxref{Radio tables}). As for radio tables, you can
15541 insert radio list templates in HTML, @LaTeX{} and Texinfo modes by calling
15542 @code{org-list-insert-radio-list}.
15544 Here are the differences with radio tables:
15548 Orgstruct mode must be active.
15550 Use the @code{ORGLST} keyword instead of @code{ORGTBL}.
15552 The available translation functions for radio lists don't take
15555 @kbd{C-c C-c} will work when pressed on the first item of the list.
15558 Here is a @LaTeX{} example. Let's say that you have this in your
15563 % BEGIN RECEIVE ORGLST to-buy
15564 % END RECEIVE ORGLST to-buy
15566 #+ORGLST: SEND to-buy org-list-to-latex
15575 Pressing `C-c C-c' on @code{a new house} and will insert the converted
15576 @LaTeX{} list between the two marker lines.
15578 @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Hacking
15579 @section Dynamic blocks
15580 @cindex dynamic blocks
15582 Org documents can contain @emph{dynamic blocks}. These are
15583 specially marked regions that are updated by some user-written function.
15584 A good example for such a block is the clock table inserted by the
15585 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
15587 Dynamic blocks are enclosed by a BEGIN-END structure that assigns a name
15588 to the block and can also specify parameters for the function producing
15589 the content of the block.
15591 @cindex #+BEGIN:dynamic block
15593 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
15598 Dynamic blocks are updated with the following commands
15601 @orgcmd{C-c C-x C-u,org-dblock-update}
15602 Update dynamic block at point.
15603 @orgkey{C-u C-c C-x C-u}
15604 Update all dynamic blocks in the current file.
15607 Updating a dynamic block means to remove all the text between BEGIN and
15608 END, parse the BEGIN line for parameters and then call the specific
15609 writer function for this block to insert the new content. If you want
15610 to use the original content in the writer function, you can use the
15611 extra parameter @code{:content}.
15613 For a block with name @code{myblock}, the writer function is
15614 @code{org-dblock-write:myblock} with as only parameter a property list
15615 with the parameters given in the begin line. Here is a trivial example
15616 of a block that keeps track of when the block update function was last
15620 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
15626 The corresponding block writer function could look like this:
15629 (defun org-dblock-write:block-update-time (params)
15630 (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
15631 (insert "Last block update at: "
15632 (format-time-string fmt (current-time)))))
15635 If you want to make sure that all dynamic blocks are always up-to-date,
15636 you could add the function @code{org-update-all-dblocks} to a hook, for
15637 example @code{before-save-hook}. @code{org-update-all-dblocks} is
15638 written in a way such that it does nothing in buffers that are not in
15641 You can narrow the current buffer to the current dynamic block (like any
15642 other block) with @code{org-narrow-to-block}.
15644 @node Special agenda views, Extracting agenda information, Dynamic blocks, Hacking
15645 @section Special agenda views
15646 @cindex agenda views, user-defined
15648 @vindex org-agenda-skip-function
15649 @vindex org-agenda-skip-function-global
15650 Org provides a special hook that can be used to narrow down the selection
15651 made by these agenda views: @code{agenda}, @code{todo}, @code{alltodo},
15652 @code{tags}, @code{tags-todo}, @code{tags-tree}. You may specify a function
15653 that is used at each match to verify if the match should indeed be part of
15654 the agenda view, and if not, how much should be skipped. You can specify a
15655 global condition that will be applied to all agenda views, this condition
15656 would be stored in the variable @code{org-agenda-skip-function-global}. More
15657 commonly, such a definition is applied only to specific custom searches,
15658 using @code{org-agenda-skip-function}.
15660 Let's say you want to produce a list of projects that contain a WAITING
15661 tag anywhere in the project tree. Let's further assume that you have
15662 marked all tree headings that define a project with the TODO keyword
15663 PROJECT. In this case you would run a TODO search for the keyword
15664 PROJECT, but skip the match unless there is a WAITING tag anywhere in
15665 the subtree belonging to the project line.
15667 To achieve this, you must write a function that searches the subtree for
15668 the tag. If the tag is found, the function must return @code{nil} to
15669 indicate that this match should not be skipped. If there is no such
15670 tag, return the location of the end of the subtree, to indicate that
15671 search should continue from there.
15674 (defun my-skip-unless-waiting ()
15675 "Skip trees that are not waiting"
15676 (let ((subtree-end (save-excursion (org-end-of-subtree t))))
15677 (if (re-search-forward ":waiting:" subtree-end t)
15678 nil ; tag found, do not skip
15679 subtree-end))) ; tag not found, continue after end of subtree
15682 Now you may use this function in an agenda custom command, for example
15686 (org-add-agenda-custom-command
15687 '("b" todo "PROJECT"
15688 ((org-agenda-skip-function 'my-skip-unless-waiting)
15689 (org-agenda-overriding-header "Projects waiting for something: "))))
15692 @vindex org-agenda-overriding-header
15693 Note that this also binds @code{org-agenda-overriding-header} to get a
15694 meaningful header in the agenda view.
15696 @vindex org-odd-levels-only
15697 @vindex org-agenda-skip-function
15698 A general way to create custom searches is to base them on a search for
15699 entries with a certain level limit. If you want to study all entries with
15700 your custom search function, simply do a search for
15701 @samp{LEVEL>0}@footnote{Note that, when using @code{org-odd-levels-only}, a
15702 level number corresponds to order in the hierarchy, not to the number of
15703 stars.}, and then use @code{org-agenda-skip-function} to select the entries
15704 you really want to have.
15706 You may also put a Lisp form into @code{org-agenda-skip-function}. In
15707 particular, you may use the functions @code{org-agenda-skip-entry-if}
15708 and @code{org-agenda-skip-subtree-if} in this form, for example:
15711 @item (org-agenda-skip-entry-if 'scheduled)
15712 Skip current entry if it has been scheduled.
15713 @item (org-agenda-skip-entry-if 'notscheduled)
15714 Skip current entry if it has not been scheduled.
15715 @item (org-agenda-skip-entry-if 'deadline)
15716 Skip current entry if it has a deadline.
15717 @item (org-agenda-skip-entry-if 'scheduled 'deadline)
15718 Skip current entry if it has a deadline, or if it is scheduled.
15719 @item (org-agenda-skip-entry-if 'todo '("TODO" "WAITING"))
15720 Skip current entry if the TODO keyword is TODO or WAITING.
15721 @item (org-agenda-skip-entry-if 'todo 'done)
15722 Skip current entry if the TODO keyword marks a DONE state.
15723 @item (org-agenda-skip-entry-if 'timestamp)
15724 Skip current entry if it has any timestamp, may also be deadline or scheduled.
15725 @item (org-agenda-skip-entry 'regexp "regular expression")
15726 Skip current entry if the regular expression matches in the entry.
15727 @item (org-agenda-skip-entry 'notregexp "regular expression")
15728 Skip current entry unless the regular expression matches.
15729 @item (org-agenda-skip-subtree-if 'regexp "regular expression")
15730 Same as above, but check and skip the entire subtree.
15733 Therefore we could also have written the search for WAITING projects
15734 like this, even without defining a special function:
15737 (org-add-agenda-custom-command
15738 '("b" todo "PROJECT"
15739 ((org-agenda-skip-function '(org-agenda-skip-subtree-if
15740 'regexp ":waiting:"))
15741 (org-agenda-overriding-header "Projects waiting for something: "))))
15744 @node Extracting agenda information, Using the property API, Special agenda views, Hacking
15745 @section Extracting agenda information
15746 @cindex agenda, pipe
15747 @cindex Scripts, for agenda processing
15749 @vindex org-agenda-custom-commands
15750 Org provides commands to access agenda information for the command
15751 line in Emacs batch mode. This extracted information can be sent
15752 directly to a printer, or it can be read by a program that does further
15753 processing of the data. The first of these commands is the function
15754 @code{org-batch-agenda}, that produces an agenda view and sends it as
15755 ASCII text to STDOUT. The command takes a single string as parameter.
15756 If the string has length 1, it is used as a key to one of the commands
15757 you have configured in @code{org-agenda-custom-commands}, basically any
15758 key you can use after @kbd{C-c a}. For example, to directly print the
15759 current TODO list, you could use
15762 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
15765 If the parameter is a string with 2 or more characters, it is used as a
15766 tags/TODO match string. For example, to print your local shopping list
15767 (all items with the tag @samp{shop}, but excluding the tag
15768 @samp{NewYork}), you could use
15771 emacs -batch -l ~/.emacs \
15772 -eval '(org-batch-agenda "+shop-NewYork")' | lpr
15776 You may also modify parameters on the fly like this:
15779 emacs -batch -l ~/.emacs \
15780 -eval '(org-batch-agenda "a" \
15781 org-agenda-span (quote month) \
15782 org-agenda-include-diary nil \
15783 org-agenda-files (quote ("~/org/project.org")))' \
15788 which will produce a 30-day agenda, fully restricted to the Org file
15789 @file{~/org/projects.org}, not even including the diary.
15791 If you want to process the agenda data in more sophisticated ways, you
15792 can use the command @code{org-batch-agenda-csv} to get a comma-separated
15793 list of values for each agenda item. Each line in the output will
15794 contain a number of fields separated by commas. The fields in a line
15798 category @r{The category of the item}
15799 head @r{The headline, without TODO keyword, TAGS and PRIORITY}
15800 type @r{The type of the agenda entry, can be}
15801 todo @r{selected in TODO match}
15802 tagsmatch @r{selected in tags match}
15803 diary @r{imported from diary}
15804 deadline @r{a deadline}
15805 scheduled @r{scheduled}
15806 timestamp @r{appointment, selected by timestamp}
15807 closed @r{entry was closed on date}
15808 upcoming-deadline @r{warning about nearing deadline}
15809 past-scheduled @r{forwarded scheduled item}
15810 block @r{entry has date block including date}
15811 todo @r{The TODO keyword, if any}
15812 tags @r{All tags including inherited ones, separated by colons}
15813 date @r{The relevant date, like 2007-2-14}
15814 time @r{The time, like 15:00-16:50}
15815 extra @r{String with extra planning info}
15816 priority-l @r{The priority letter if any was given}
15817 priority-n @r{The computed numerical priority}
15821 Time and date will only be given if a timestamp (or deadline/scheduled)
15822 led to the selection of the item.
15824 A CSV list like this is very easy to use in a post-processing script.
15825 For example, here is a Perl program that gets the TODO list from
15826 Emacs/Org and prints all the items, preceded by a checkbox:
15831 # define the Emacs command to run
15832 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
15834 # run it and capture the output
15835 $agenda = qx@{$cmd 2>/dev/null@};
15837 # loop over all lines
15838 foreach $line (split(/\n/,$agenda)) @{
15839 # get the individual values
15840 ($category,$head,$type,$todo,$tags,$date,$time,$extra,
15841 $priority_l,$priority_n) = split(/,/,$line);
15842 # process and print
15843 print "[ ] $head\n";
15847 @node Using the property API, Using the mapping API, Extracting agenda information, Hacking
15848 @section Using the property API
15849 @cindex API, for properties
15850 @cindex properties, API
15852 Here is a description of the functions that can be used to work with
15855 @defun org-entry-properties &optional pom which
15856 Get all properties of the entry at point-or-marker POM.@*
15857 This includes the TODO keyword, the tags, time strings for deadline,
15858 scheduled, and clocking, and any additional properties defined in the
15859 entry. The return value is an alist. Keys may occur multiple times
15860 if the property key was used several times.@*
15861 POM may also be nil, in which case the current entry is used.
15862 If WHICH is nil or `all', get all properties. If WHICH is
15863 `special' or `standard', only get that subclass.
15865 @vindex org-use-property-inheritance
15866 @defun org-entry-get pom property &optional inherit
15867 Get value of PROPERTY for entry at point-or-marker POM. By default,
15868 this only looks at properties defined locally in the entry. If INHERIT
15869 is non-nil and the entry does not have the property, then also check
15870 higher levels of the hierarchy. If INHERIT is the symbol
15871 @code{selective}, use inheritance if and only if the setting of
15872 @code{org-use-property-inheritance} selects PROPERTY for inheritance.
15875 @defun org-entry-delete pom property
15876 Delete the property PROPERTY from entry at point-or-marker POM.
15879 @defun org-entry-put pom property value
15880 Set PROPERTY to VALUE for entry at point-or-marker POM.
15883 @defun org-buffer-property-keys &optional include-specials
15884 Get all property keys in the current buffer.
15887 @defun org-insert-property-drawer
15888 Insert a property drawer at point.
15891 @defun org-entry-put-multivalued-property pom property &rest values
15892 Set PROPERTY at point-or-marker POM to VALUES. VALUES should be a list of
15893 strings. They will be concatenated, with spaces as separators.
15896 @defun org-entry-get-multivalued-property pom property
15897 Treat the value of the property PROPERTY as a whitespace-separated list of
15898 values and return the values as a list of strings.
15901 @defun org-entry-add-to-multivalued-property pom property value
15902 Treat the value of the property PROPERTY as a whitespace-separated list of
15903 values and make sure that VALUE is in this list.
15906 @defun org-entry-remove-from-multivalued-property pom property value
15907 Treat the value of the property PROPERTY as a whitespace-separated list of
15908 values and make sure that VALUE is @emph{not} in this list.
15911 @defun org-entry-member-in-multivalued-property pom property value
15912 Treat the value of the property PROPERTY as a whitespace-separated list of
15913 values and check if VALUE is in this list.
15916 @defopt org-property-allowed-value-functions
15917 Hook for functions supplying allowed values for a specific property.
15918 The functions must take a single argument, the name of the property, and
15919 return a flat list of allowed values. If @samp{:ETC} is one of
15920 the values, use the values as completion help, but allow also other values
15921 to be entered. The functions must return @code{nil} if they are not
15922 responsible for this property.
15925 @node Using the mapping API, , Using the property API, Hacking
15926 @section Using the mapping API
15927 @cindex API, for mapping
15928 @cindex mapping entries, API
15930 Org has sophisticated mapping capabilities to find all entries satisfying
15931 certain criteria. Internally, this functionality is used to produce agenda
15932 views, but there is also an API that can be used to execute arbitrary
15933 functions for each or selected entries. The main entry point for this API
15936 @defun org-map-entries func &optional match scope &rest skip
15937 Call FUNC at each headline selected by MATCH in SCOPE.
15939 FUNC is a function or a Lisp form. The function will be called without
15940 arguments, with the cursor positioned at the beginning of the headline.
15941 The return values of all calls to the function will be collected and
15942 returned as a list.
15944 The call to FUNC will be wrapped into a save-excursion form, so FUNC
15945 does not need to preserve point. After evaluation, the cursor will be
15946 moved to the end of the line (presumably of the headline of the
15947 processed entry) and search continues from there. Under some
15948 circumstances, this may not produce the wanted results. For example,
15949 if you have removed (e.g.@: archived) the current (sub)tree it could
15950 mean that the next entry will be skipped entirely. In such cases, you
15951 can specify the position from where search should continue by making
15952 FUNC set the variable `org-map-continue-from' to the desired buffer
15955 MATCH is a tags/property/todo match as it is used in the agenda match view.
15956 Only headlines that are matched by this query will be considered during
15957 the iteration. When MATCH is nil or t, all headlines will be
15958 visited by the iteration.
15960 SCOPE determines the scope of this command. It can be any of:
15963 nil @r{the current buffer, respecting the restriction if any}
15964 tree @r{the subtree started with the entry at point}
15965 region @r{The entries within the active region, if any}
15966 file @r{the current buffer, without restriction}
15968 @r{the current buffer, and any archives associated with it}
15969 agenda @r{all agenda files}
15970 agenda-with-archives
15971 @r{all agenda files with any archive files associated with them}
15973 @r{if this is a list, all files in the list will be scanned}
15976 The remaining args are treated as settings for the skipping facilities of
15977 the scanner. The following items can be given here:
15979 @vindex org-agenda-skip-function
15981 archive @r{skip trees with the archive tag}
15982 comment @r{skip trees with the COMMENT keyword}
15983 function or Lisp form
15984 @r{will be used as value for @code{org-agenda-skip-function},}
15985 @r{so whenever the function returns t, FUNC}
15986 @r{will not be called for that entry and search will}
15987 @r{continue from the point where the function leaves it}
15991 The function given to that mapping routine can really do anything you like.
15992 It can use the property API (@pxref{Using the property API}) to gather more
15993 information about the entry, or in order to change metadata in the entry.
15994 Here are a couple of functions that might be handy:
15996 @defun org-todo &optional arg
15997 Change the TODO state of the entry. See the docstring of the functions for
15998 the many possible values for the argument ARG.
16001 @defun org-priority &optional action
16002 Change the priority of the entry. See the docstring of this function for the
16003 possible values for ACTION.
16006 @defun org-toggle-tag tag &optional onoff
16007 Toggle the tag TAG in the current entry. Setting ONOFF to either @code{on}
16008 or @code{off} will not toggle tag, but ensure that it is either on or off.
16012 Promote the current entry.
16016 Demote the current entry.
16019 Here is a simple example that will turn all entries in the current file with
16020 a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
16021 Entries in comment trees and in archive trees will be ignored.
16025 '(org-todo "UPCOMING")
16026 "+TOMORROW" 'file 'archive 'comment)
16029 The following example counts the number of entries with TODO keyword
16030 @code{WAITING}, in all agenda files.
16033 (length (org-map-entries t "/+WAITING" 'agenda))
16036 @node MobileOrg, History and Acknowledgments, Hacking, Top
16037 @appendix MobileOrg
16041 @uref{http://mobileorg.ncogni.to/, MobileOrg} is an application for the
16042 @i{iPhone/iPod Touch} series of devices, developed by Richard Moreland.
16043 @i{MobileOrg} offers offline viewing and capture support for an Org mode
16044 system rooted on a ``real'' computer. It does also allow you to record
16045 changes to existing entries. Android users should check out
16046 @uref{http://wiki.github.com/matburt/mobileorg-android/, MobileOrg Android}
16049 This appendix describes the support Org has for creating agenda views in a
16050 format that can be displayed by @i{MobileOrg}, and for integrating notes
16051 captured and changes made by @i{MobileOrg} into the main system.
16053 For changing tags and TODO states in MobileOrg, you should have set up the
16054 customization variables @code{org-todo-keywords} and @code{org-tags-alist} to
16055 cover all important tags and TODO keywords, even if individual files use only
16056 part of these. MobileOrg will also offer you states and tags set up with
16057 in-buffer settings, but it will understand the logistics of TODO state
16058 @i{sets} (@pxref{Per-file keywords}) and @i{mutually exclusive} tags
16059 (@pxref{Setting tags}) only for those set in these variables.
16062 * Setting up the staging area:: Where to interact with the mobile device
16063 * Pushing to MobileOrg:: Uploading Org files and agendas
16064 * Pulling from MobileOrg:: Integrating captured and flagged items
16067 @node Setting up the staging area, Pushing to MobileOrg, MobileOrg, MobileOrg
16068 @section Setting up the staging area
16070 MobileOrg needs to interact with Emacs through a directory on a server. If you
16071 are using a public server, you should consider to encrypt the files that are
16072 uploaded to the server. This can be done with Org mode 7.02 and with
16073 @i{MobileOrg 1.5} (iPhone version), and you need an @file{openssl}
16074 installation on your system. To turn on encryption, set a password in
16075 @i{MobileOrg} and, on the Emacs side, configure the variable
16076 @code{org-mobile-use-encryption}@footnote{If you can safely store the
16077 password in your Emacs setup, you might also want to configure
16078 @code{org-mobile-encryption-password}. Please read the docstring of that
16079 variable. Note that encryption will apply only to the contents of the
16080 @file{.org} files. The file names themselves will remain visible.}.
16082 The easiest way to create that directory is to use a free
16083 @uref{http://dropbox.com,Dropbox.com} account@footnote{If you cannot use
16084 Dropbox, or if your version of MobileOrg does not support it, you can use a
16085 webdav server. For more information, check out the documentation of MobileOrg and also this
16086 @uref{http://orgmode.org/worg/org-faq.html#mobileorg_webdav, FAQ entry}.}.
16087 When MobileOrg first connects to your Dropbox, it will create a directory
16088 @i{MobileOrg} inside the Dropbox. After the directory has been created, tell
16092 (setq org-mobile-directory "~/Dropbox/MobileOrg")
16095 Org mode has commands to put files for @i{MobileOrg} into that directory,
16096 and to read captured notes from there.
16098 @node Pushing to MobileOrg, Pulling from MobileOrg, Setting up the staging area, MobileOrg
16099 @section Pushing to MobileOrg
16101 This operation copies all files currently listed in @code{org-mobile-files}
16102 to the directory @code{org-mobile-directory}. By default this list contains
16103 all agenda files (as listed in @code{org-agenda-files}), but additional files
16104 can be included by customizing @code{org-mobile-files}. File names will be
16105 staged with paths relative to @code{org-directory}, so all files should be
16106 inside this directory. The push operation also creates a special Org file
16107 @file{agendas.org} with all custom agenda view defined by the
16108 user@footnote{While creating the agendas, Org mode will force ID properties
16109 on all referenced entries, so that these entries can be uniquely identified
16110 if @i{MobileOrg} flags them for further action. If you do not want to get
16111 these properties in so many entries, you can set the variable
16112 @code{org-mobile-force-id-on-agenda-items} to @code{nil}. Org mode will then
16113 rely on outline paths, in the hope that these will be unique enough.}.
16114 Finally, Org writes the file @file{index.org}, containing links to all other
16115 files. @i{MobileOrg} first reads this file from the server, and then
16116 downloads all agendas and Org files listed in it. To speed up the download,
16117 MobileOrg will only read files whose checksums@footnote{stored automatically
16118 in the file @file{checksums.dat}} have changed.
16120 @node Pulling from MobileOrg, , Pushing to MobileOrg, MobileOrg
16121 @section Pulling from MobileOrg
16123 When @i{MobileOrg} synchronizes with the server, it not only pulls the Org
16124 files for viewing. It also appends captured entries and pointers to flagged
16125 and changed entries to the file @file{mobileorg.org} on the server. Org has
16126 a @emph{pull} operation that integrates this information into an inbox file
16127 and operates on the pointers to flagged entries. Here is how it works:
16131 Org moves all entries found in
16132 @file{mobileorg.org}@footnote{@file{mobileorg.org} will be empty after this
16133 operation.} and appends them to the file pointed to by the variable
16134 @code{org-mobile-inbox-for-pull}. Each captured entry and each editing event
16135 will be a top-level entry in the inbox file.
16137 After moving the entries, Org will attempt to implement the changes made in
16138 @i{MobileOrg}. Some changes are applied directly and without user
16139 interaction. Examples are all changes to tags, TODO state, headline and body
16140 text that can be cleanly applied. Entries that have been flagged for further
16141 action will receive a tag @code{:FLAGGED:}, so that they can be easily found
16142 again. When there is a problem finding an entry or applying the change, the
16143 pointer entry will remain in the inbox and will be marked with an error
16144 message. You need to later resolve these issues by hand.
16146 Org will then generate an agenda view with all flagged entries. The user
16147 should then go through these entries and do whatever actions are necessary.
16148 If a note has been stored while flagging an entry in @i{MobileOrg}, that note
16149 will be displayed in the echo area when the cursor is on the corresponding
16154 Pressing @kbd{?} in that special agenda will display the full flagging note in
16155 another window and also push it onto the kill ring. So you could use @kbd{?
16156 z C-y C-c C-c} to store that flagging note as a normal note in the entry.
16157 Pressing @kbd{?} twice in succession will offer to remove the
16158 @code{:FLAGGED:} tag along with the recorded flagging note (which is stored
16159 in a property). In this way you indicate that the intended processing for
16160 this flagged entry is finished.
16165 If you are not able to process all flagged entries directly, you can always
16166 return to this agenda view@footnote{Note, however, that there is a subtle
16167 difference. The view created automatically by @kbd{M-x org-mobile-pull
16168 @key{RET}} is guaranteed to search all files that have been addressed by the
16169 last pull. This might include a file that is not currently in your list of
16170 agenda files. If you later use @kbd{C-c a ?} to regenerate the view, only
16171 the current agenda files will be searched.} using @kbd{C-c a ?}.
16173 @node History and Acknowledgments, Main Index, MobileOrg, Top
16174 @appendix History and acknowledgments
16175 @cindex acknowledgments
16179 Org was born in 2003, out of frustration over the user interface of the Emacs
16180 Outline mode. I was trying to organize my notes and projects, and using
16181 Emacs seemed to be the natural way to go. However, having to remember eleven
16182 different commands with two or three keys per command, only to hide and show
16183 parts of the outline tree, that seemed entirely unacceptable to me. Also,
16184 when using outlines to take notes, I constantly wanted to restructure the
16185 tree, organizing it parallel to my thoughts and plans. @emph{Visibility
16186 cycling} and @emph{structure editing} were originally implemented in the
16187 package @file{outline-magic.el}, but quickly moved to the more general
16188 @file{org.el}. As this environment became comfortable for project planning,
16189 the next step was adding @emph{TODO entries}, basic @emph{timestamps}, and
16190 @emph{table support}. These areas highlighted the two main goals that Org
16191 still has today: to be a new, outline-based, plain text mode with innovative
16192 and intuitive editing features, and to incorporate project planning
16193 functionality directly into a notes file.
16195 Since the first release, literally thousands of emails to me or to
16196 @email{emacs-orgmode@@gnu.org} have provided a constant stream of bug
16197 reports, feedback, new ideas, and sometimes patches and add-on code.
16198 Many thanks to everyone who has helped to improve this package. I am
16199 trying to keep here a list of the people who had significant influence
16200 in shaping one or more aspects of Org. The list may not be
16201 complete, if I have forgotten someone, please accept my apologies and
16204 Before I get to this list, a few special mentions are in order:
16207 @item Bastien Guerry
16208 Bastien has written a large number of extensions to Org (most of them
16209 integrated into the core by now), including the @LaTeX{} exporter and the plain
16210 list parser. His support during the early days, when he basically acted as
16211 co-maintainer, was central to the success of this project. Bastien also
16212 invented Worg, helped establishing the Web presence of Org, and sponsors
16213 hosting costs for the orgmode.org website.
16214 @item Eric Schulte and Dan Davison
16215 Eric and Dan are jointly responsible for the Org-babel system, which turns
16216 Org into a multi-language environment for evaluating code and doing literate
16217 programming and reproducible research.
16219 John has contributed a number of great ideas and patches directly to Org,
16220 including the attachment system (@file{org-attach.el}), integration with
16221 Apple Mail (@file{org-mac-message.el}), hierarchical dependencies of TODO
16222 items, habit tracking (@file{org-habits.el}), and encryption
16223 (@file{org-crypt.el}). Also, the capture system is really an extended copy
16224 of his great @file{remember.el}.
16225 @item Sebastian Rose
16226 Without Sebastian, the HTML/XHTML publishing of Org would be the pitiful work
16227 of an ignorant amateur. Sebastian has pushed this part of Org onto a much
16228 higher level. He also wrote @file{org-info.js}, a Java script for displaying
16229 webpages derived from Org using an Info-like or a folding interface with
16230 single-key navigation.
16233 @noindent OK, now to the full list of contributions! Again, please let me
16234 know what I am missing here!
16239 @i{Russel Adams} came up with the idea for drawers.
16241 @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
16243 @i{Christophe Bataillon} created the great unicorn logo that we use on the
16246 @i{Alex Bochannek} provided a patch for rounding timestamps.
16248 @i{Jan Böcker} wrote @file{org-docview.el}.
16250 @i{Brad Bozarth} showed how to pull RSS feed data into Org mode files.
16252 @i{Tom Breton} wrote @file{org-choose.el}.
16254 @i{Charles Cave}'s suggestion sparked the implementation of templates
16255 for Remember, which are now templates for capture.
16257 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
16260 @i{Gregory Chernov} patched support for Lisp forms into table
16261 calculations and improved XEmacs compatibility, in particular by porting
16262 @file{nouline.el} to XEmacs.
16264 @i{Sacha Chua} suggested copying some linking code from Planner.
16266 @i{Baoqiu Cui} contributed the DocBook exporter.
16268 @i{Eddward DeVilla} proposed and tested checkbox statistics. He also
16269 came up with the idea of properties, and that there should be an API for
16272 @i{Nick Dokos} tracked down several nasty bugs.
16274 @i{Kees Dullemond} used to edit projects lists directly in HTML and so
16275 inspired some of the early development, including HTML export. He also
16276 asked for a way to narrow wide table columns.
16278 @i{Thomas S. Dye} contributed documentation on Worg and helped integrating
16279 the Org-Babel documentation into the manual.
16281 @i{Christian Egli} converted the documentation into Texinfo format, inspired
16282 the agenda, patched CSS formatting into the HTML exporter, and wrote
16283 @file{org-taskjuggler.el}.
16285 @i{David Emery} provided a patch for custom CSS support in exported
16288 @i{Nic Ferrier} contributed mailcap and XOXO support.
16290 @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
16292 @i{John Foerch} figured out how to make incremental search show context
16293 around a match in a hidden outline tree.
16295 @i{Raimar Finken} wrote @file{org-git-line.el}.
16297 @i{Mikael Fornius} works as a mailing list moderator.
16299 @i{Austin Frank} works as a mailing list moderator.
16301 @i{Eric Fraga} drove the development of BEAMER export with ideas and
16304 @i{Barry Gidden} did proofreading the manual in preparation for the book
16305 publication through Network Theory Ltd.
16307 @i{Niels Giesen} had the idea to automatically archive DONE trees.
16309 @i{Nicolas Goaziou} rewrote much of the plain list code.
16311 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
16313 @i{Brian Gough} of Network Theory Ltd publishes the Org mode manual as a
16316 @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
16317 task state change logging, and the clocktable. His clear explanations have
16318 been critical when we started to adopt the Git version control system.
16320 @i{Manuel Hermenegildo} has contributed various ideas, small fixes and
16323 @i{Phil Jackson} wrote @file{org-irc.el}.
16325 @i{Scott Jaderholm} proposed footnotes, control over whitespace between
16326 folded entries, and column view for properties.
16328 @i{Matt Jones} wrote @i{MobileOrg Android}.
16330 @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
16332 @i{Shidai Liu} ("Leo") asked for embedded @LaTeX{} and tested it. He also
16333 provided frequent feedback and some patches.
16335 @i{Matt Lundin} has proposed last-row references for table formulas and named
16336 invisible anchors. He has also worked a lot on the FAQ.
16338 @i{David Maus} wrote @file{org-atom.el}, maintains the issues file for Org,
16339 and is a prolific contributor on the mailing list with competent replies,
16340 small fixes and patches.
16342 @i{Jason F. McBrayer} suggested agenda export to CSV format.
16344 @i{Max Mikhanosha} came up with the idea of refiling.
16346 @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
16349 @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
16352 @i{Richard Moreland} wrote @i{MobileOrg} for the iPhone.
16354 @i{Rick Moynihan} proposed allowing multiple TODO sequences in a file
16355 and being able to quickly restrict the agenda to a subtree.
16357 @i{Todd Neal} provided patches for links to Info files and Elisp forms.
16359 @i{Greg Newman} refreshed the unicorn logo into its current form.
16361 @i{Tim O'Callaghan} suggested in-file links, search options for general
16362 file links, and TAGS.
16364 @i{Osamu Okano} wrote @file{orgcard2ref.pl}, a Perl program to create a text
16365 version of the reference card.
16367 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
16370 @i{Oliver Oppitz} suggested multi-state TODO items.
16372 @i{Scott Otterson} sparked the introduction of descriptive text for
16373 links, among other things.
16375 @i{Pete Phillips} helped during the development of the TAGS feature, and
16376 provided frequent feedback.
16378 @i{Martin Pohlack} provided the code snippet to bundle character insertion
16379 into bundles of 20 for undo.
16381 @i{T.V. Raman} reported bugs and suggested improvements.
16383 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
16386 @i{Paul Rivier} provided the basic implementation of named footnotes. He
16387 also acted as mailing list moderator for some time.
16389 @i{Kevin Rogers} contributed code to access VM files on remote hosts.
16391 @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
16392 conflict with @file{allout.el}.
16394 @i{Jason Riedy} generalized the send-receive mechanism for Orgtbl tables with
16397 @i{Philip Rooke} created the Org reference card, provided lots
16398 of feedback, developed and applied standards to the Org documentation.
16400 @i{Christian Schlauer} proposed angular brackets around links, among
16403 @i{Paul Sexton} wrote @file{org-ctags.el}.
16405 Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
16406 @file{organizer-mode.el}.
16408 @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal
16409 examples, and remote highlighting for referenced code lines.
16411 @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
16412 now packaged into Org's @file{contrib} directory.
16414 @i{Daniel Sinder} came up with the idea of internal archiving by locking
16417 @i{Dale Smith} proposed link abbreviations.
16419 @i{James TD Smith} has contributed a large number of patches for useful
16420 tweaks and features.
16422 @i{Adam Spiers} asked for global linking commands, inspired the link
16423 extension system, added support for mairix, and proposed the mapping API.
16425 @i{Ulf Stegemann} created the table to translate special symbols to HTML,
16426 @LaTeX{}, UTF-8, Latin-1 and ASCII.
16428 @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content
16429 with links transformation to Org syntax.
16431 @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
16432 chapter about publishing.
16434 @i{Jambunathan K} contributed the @acronym{ODT} exporter.
16436 @i{Sebastien Vauban} reported many issues with @LaTeX{} and BEAMER export and
16437 enabled source code highlighting in Gnus.
16439 @i{Stefan Vollmar} organized a video-recorded talk at the
16440 Max-Planck-Institute for Neurology. He also inspired the creation of a
16441 concept index for HTML export.
16443 @i{J@"urgen Vollmer} contributed code generating the table of contents
16446 @i{Samuel Wales} has provided important feedback and bug reports.
16448 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
16451 @i{David Wainberg} suggested archiving, and improvements to the linking
16454 @i{Carsten Wimmer} suggested some changes and helped fix a bug in
16457 @i{Roland Winkler} requested additional key bindings to make Org
16460 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
16461 and contributed various ideas and code snippets.
16466 @node Main Index, Key Index, History and Acknowledgments, Top
16467 @unnumbered Concept index
16471 @node Key Index, Command and Function Index, Main Index, Top
16472 @unnumbered Key index
16476 @node Command and Function Index, Variable Index, Key Index, Top
16477 @unnumbered Command and function index
16481 @node Variable Index, , Command and Function Index, Top
16482 @unnumbered Variable index
16484 This is not a complete index of variables and faces, only the ones that are
16485 mentioned in the manual. For a more complete list, use @kbd{M-x
16486 org-customize @key{RET}} and then click yourself through the tree.
16492 @c Local variables:
16494 @c indent-tabs-mode: nil
16495 @c paragraph-start: "
\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|\f\\|[ ]*$"
16496 @c paragraph-separate: "
\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|[ \f]*$"
16500 @c LocalWords: webdavhost pre