4 @setfilename ../../info/org
5 @settitle The Org Manual
8 @set DATE December 2010
10 @c Use proper quote and backtick for code sections in PDF output
11 @c Cf. Texinfo manual 14.2
12 @set txicodequoteundirected
13 @set txicodequotebacktick
15 @c Version and Contact Info
16 @set MAINTAINERSITE @uref{http://orgmode.org,maintainers webpage}
17 @set AUTHOR Carsten Dominik
18 @set MAINTAINER Carsten Dominik
19 @set MAINTAINEREMAIL @email{carsten at orgmode dot org}
20 @set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer}
25 @c -----------------------------------------------------------------------------
27 @c Macro definitions for commands and keys
28 @c =======================================
30 @c The behavior of the key/command macros will depend on the flag cmdnames
31 @c When set, commands names are shown. When clear, they are not shown.
35 @c Below we define the following macros for Org key tables:
37 @c orgkey{key} A key item
38 @c orgcmd{key,cmd} Key with command name
39 @c xorgcmd{key,cmmand} Key with command name as @itemx
40 @c orgcmdnki{key,cmd} Like orgcmd, but do not index the key
41 @c orgcmdtkc{text,key,cmd} Like orgcmd,special text instead of key
42 @c orgcmdkkc{key1,key2,cmd} Two keys with one command name, use "or"
43 @c orgcmdkxkc{key1,key2,cmd} Two keys with one command name, but
44 @c different functions, so format as @itemx
45 @c orgcmdkskc{key1,key2,cmd} Same as orgcmdkkc, but use "or short"
46 @c xorgcmdkskc{key1,key2,cmd} Same as previous, but use @itemx
47 @c orgcmdkkcc{key1,key2,cmd1,cmd2} Two keys and two commands
49 @c a key but no command
61 @c one key with a command
62 @c Inserts: @item KEY COMMAND
63 @macro orgcmd{key,command}
68 @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
71 @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
80 @c One key with one command, formatted using @itemx
81 @c Inserts: @itemx KEY COMMAND
82 @macro xorgcmd{key,command}
87 @itemx @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
90 @itemx @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
99 @c one key with a command, bit do not index the key
100 @c Inserts: @item KEY COMMAND
101 @macro orgcmdnki{key,command}
105 @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
108 @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
116 @c one key with a command, and special text to replace key in item
117 @c Inserts: @item TEXT COMMAND
118 @macro orgcmdtkc{text,key,command}
123 @item @kbd{\text\} @hskip 0pt plus 1filll @code{\command\}
126 @item @kbd{\text\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
135 @c two keys with one command
136 @c Inserts: @item KEY1 or KEY2 COMMAND
137 @macro orgcmdkkc{key1,key2,command}
143 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
146 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
152 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\}
156 @c Two keys with one command name, but different functions, so format as
158 @c Inserts: @item KEY1
159 @c @itemx KEY2 COMMAND
160 @macro orgcmdkxkc{key1,key2,command}
167 @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
171 @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
182 @c Same as previous, but use "or short"
183 @c Inserts: @item KEY1 or short KEY2 COMMAND
184 @macro orgcmdkskc{key1,key2,command}
190 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
193 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
199 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
203 @c Same as previous, but use @itemx
204 @c Inserts: @itemx KEY1 or short KEY2 COMMAND
205 @macro xorgcmdkskc{key1,key2,command}
211 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
214 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
220 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
224 @c two keys with two commands
225 @c Inserts: @item KEY1 COMMAND1
226 @c @itemx KEY2 COMMAND2
227 @macro orgcmdkkcc{key1,key2,command1,command2}
234 @item @kbd{\key1\} @hskip 0pt plus 1filll @code{\command1\}
235 @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command2\}
238 @item @kbd{\key1\} @tie{}@tie{}@tie{}@tie{}(@code{\command1\})
239 @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command2\})
249 @c -----------------------------------------------------------------------------
252 @c @hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed}
255 @c Subheadings inside a table.
256 @macro tsubheading{text}
258 @subsubheading \text\
266 This manual is for Org version @value{VERSION}.
268 Copyright @copyright{} 2004-2011 Free Software Foundation, Inc.
271 Permission is granted to copy, distribute and/or modify this document
272 under the terms of the GNU Free Documentation License, Version 1.3 or
273 any later version published by the Free Software Foundation; with no
274 Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
275 and with the Back-Cover Texts as in (a) below. A copy of the license
276 is included in the section entitled ``GNU Free Documentation License.''
278 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
279 modify this GNU manual. Buying copies from the FSF supports it in
280 developing GNU and promoting software freedom.''
282 This document is part of a collection distributed under the GNU Free
283 Documentation License. If you want to distribute this document
284 separately from the collection, you can do so by adding a copy of the
285 license to the document, as described in section 6 of the license.
291 * Org Mode: (org). Outline-based notes management and organizer
295 @title The Org Manual
297 @subtitle Release @value{VERSION}
298 @author by Carsten Dominik
299 with contributions by David O'Toole, Bastien Guerry, Philip Rooke, Dan Davison, Eric Schulte, and Thomas Dye
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 * Field formulas:: Formulas valid for a single field
381 * Column formulas:: Formulas valid for an entire column
382 * Editing and debugging formulas:: Fixing formulas
383 * Updating the table:: Recomputing all dependent fields
384 * Advanced features:: Field names, parameters and automatic recalc
388 * Link format:: How links in Org are formatted
389 * Internal links:: Links to other places in the current file
390 * External links:: URL-like links to the world
391 * Handling links:: Creating, inserting and following
392 * Using links outside Org:: Linking from my C source code?
393 * Link abbreviations:: Shortcuts for writing complex links
394 * Search options:: Linking to a specific location
395 * Custom searches:: When the default search is not enough
399 * Radio targets:: Make targets trigger links in plain text
403 * TODO basics:: Marking and displaying TODO entries
404 * TODO extensions:: Workflow and assignments
405 * Progress logging:: Dates and notes for progress
406 * Priorities:: Some things are more important than others
407 * Breaking down tasks:: Splitting a task into manageable pieces
408 * Checkboxes:: Tick-off lists
410 Extended use of TODO keywords
412 * Workflow states:: From TODO to DONE in steps
413 * TODO types:: I do this, Fred does the rest
414 * Multiple sets in one file:: Mixing it all, and still finding your way
415 * Fast access to TODO states:: Single letter selection of a state
416 * Per-file keywords:: Different files, different requirements
417 * Faces for TODO keywords:: Highlighting states
418 * TODO dependencies:: When one task needs to wait for others
422 * Closing items:: When was this entry marked DONE?
423 * Tracking TODO state changes:: When did the status change?
424 * Tracking your habits:: How consistent have you been?
428 * Tag inheritance:: Tags use the tree structure of the outline
429 * Setting tags:: How to assign tags to a headline
430 * Tag searches:: Searching for combinations of tags
432 Properties and columns
434 * Property syntax:: How properties are spelled out
435 * Special properties:: Access to other Org-mode features
436 * Property searches:: Matching property values
437 * Property inheritance:: Passing values down the tree
438 * Column view:: Tabular viewing and editing
439 * Property API:: Properties for Lisp programmers
443 * Defining columns:: The COLUMNS format property
444 * Using column view:: How to create and use column view
445 * Capturing column view:: A dynamic block for column view
449 * Scope of column definitions:: Where defined, where valid?
450 * Column attributes:: Appearance and content of a column
454 * Timestamps:: Assigning a time to a tree entry
455 * Creating timestamps:: Commands which insert timestamps
456 * Deadlines and scheduling:: Planning your work
457 * Clocking work time:: Tracking how long you spend on a task
458 * Effort estimates:: Planning work effort in advance
459 * Relative timer:: Notes with a running timer
460 * Countdown timer:: Starting a countdown timer for a task
464 * The date/time prompt:: How Org-mode helps you entering date and time
465 * Custom time format:: Making dates look different
467 Deadlines and scheduling
469 * Inserting deadline/schedule:: Planning items
470 * Repeated tasks:: Items that show up again and again
474 * Clocking commands:: Starting and stopping a clock
475 * The clock table:: Detailed reports
476 * Resolving idle time:: Resolving time when you've been idle
478 Capture - Refile - Archive
480 * Capture:: Capturing new stuff
481 * Attachments:: Add files to tasks
482 * RSS Feeds:: Getting input from RSS feeds
483 * Protocols:: External (e.g. Browser) access to Emacs and Org
484 * Refiling notes:: Moving a tree from one place to another
485 * Archiving:: What to do with finished projects
489 * Setting up capture:: Where notes will be stored
490 * Using capture:: Commands to invoke and terminate capture
491 * Capture templates:: Define the outline of different note types
495 * Template elements:: What is needed for a complete template entry
496 * Template expansion:: Filling in information about time and context
500 * Moving subtrees:: Moving a tree to an archive file
501 * Internal archiving:: Switch off a tree but keep it in the file
505 * Agenda files:: Files being searched for agenda information
506 * Agenda dispatcher:: Keyboard access to agenda views
507 * Built-in agenda views:: What is available out of the box?
508 * Presentation and sorting:: How agenda items are prepared for display
509 * Agenda commands:: Remote editing of Org trees
510 * Custom agenda views:: Defining special searches and views
511 * Exporting Agenda Views:: Writing a view to a file
512 * Agenda column view:: Using column view for collected entries
514 The built-in agenda views
516 * Weekly/daily agenda:: The calendar page with current tasks
517 * Global TODO list:: All unfinished action items
518 * Matching tags and properties:: Structured information with fine-tuned search
519 * Timeline:: Time-sorted view for single file
520 * Search view:: Find entries by searching for text
521 * Stuck projects:: Find projects you need to review
523 Presentation and sorting
525 * Categories:: Not all tasks are equal
526 * Time-of-day specifications:: How the agenda knows the time
527 * Sorting of agenda items:: The order of things
531 * Storing searches:: Type once, use often
532 * Block agenda:: All the stuff you need in a single buffer
533 * Setting Options:: Changing the rules
535 Markup for rich export
537 * Structural markup elements:: The basic structure as seen by the exporter
538 * Images and tables:: Tables and Images will be included
539 * Literal examples:: Source code examples with special formatting
540 * Include files:: Include additional files into a document
541 * Index entries:: Making an index
542 * Macro replacement:: Use macros to create complex output
543 * Embedded LaTeX:: LaTeX can be freely used inside Org documents
545 Structural markup elements
547 * Document title:: Where the title is taken from
548 * Headings and sections:: The document structure as seen by the exporter
549 * Table of contents:: The if and where of the table of contents
550 * Initial text:: Text before the first heading?
552 * Paragraphs:: Paragraphs
553 * Footnote markup:: Footnotes
554 * Emphasis and monospace:: Bold, italic, etc.
555 * Horizontal rules:: Make a line
556 * Comment lines:: What will *not* be exported
560 * Special symbols:: Greek letters and other symbols
561 * Subscripts and superscripts:: Simple syntax for raising/lowering text
562 * LaTeX fragments:: Complex formulas made easy
563 * Previewing LaTeX fragments:: What will this snippet look like?
564 * CDLaTeX mode:: Speed up entering of formulas
568 * Selective export:: Using tags to select and exclude trees
569 * Export options:: Per-file export settings
570 * The export dispatcher:: How to access exporter commands
571 * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
572 * HTML export:: Exporting to HTML
573 * LaTeX and PDF export:: Exporting to @LaTeX{}, and processing to PDF
574 * DocBook export:: Exporting to DocBook
575 * TaskJuggler export:: Exporting to TaskJuggler
576 * Freemind export:: Exporting to Freemind mind maps
577 * XOXO export:: Exporting to XOXO
578 * iCalendar export:: Exporting in iCalendar format
582 * HTML Export commands:: How to invoke HTML export
583 * Quoting HTML tags:: Using direct HTML in Org-mode
584 * Links in HTML export:: How links will be interpreted and formatted
585 * Tables in HTML export:: How to modify the formatting of tables
586 * Images in HTML export:: How to insert figures into HTML output
587 * Math formatting in HTML export:: Beautiful math also on the web
588 * Text areas in HTML export:: An alternative way to show an example
589 * CSS support:: Changing the appearance of the output
590 * JavaScript support:: Info and Folding in a web browser
592 @LaTeX{} and PDF export
594 * LaTeX/PDF export commands:: Which key invokes which commands
595 * Header and sectioning:: Setting up the export file structure
596 * Quoting LaTeX code:: Incorporating literal @LaTeX{} code
597 * Tables in LaTeX export:: Options for exporting tables to @LaTeX{}
598 * Images in LaTeX export:: How to insert figures into @LaTeX{} output
599 * Beamer class export:: Turning the file into a presentation
603 * DocBook export commands:: How to invoke DocBook export
604 * Quoting DocBook code:: Incorporating DocBook code in Org files
605 * Recursive sections:: Recursive sections in DocBook
606 * Tables in DocBook export:: Tables are exported as HTML tables
607 * Images in DocBook export:: How to insert figures into DocBook output
608 * Special characters:: How to handle special characters
612 * Configuration:: Defining projects
613 * Uploading files:: How to get files up on the server
614 * Sample configuration:: Example projects
615 * Triggering publication:: Publication commands
619 * Project alist:: The central configuration variable
620 * Sources and destinations:: From here to there
621 * Selecting files:: What files are part of the project?
622 * Publishing action:: Setting the function doing the publishing
623 * Publishing options:: Tweaking HTML export
624 * Publishing links:: Which links keep working after publishing?
625 * Sitemap:: Generating a list of all pages
626 * Generating an index:: An index that reaches across pages
630 * Simple example:: One-component publishing
631 * Complex example:: A multi-component publishing example
633 Working with source code
635 * Structure of code blocks:: Code block syntax described
636 * Editing source code:: Language major-mode editing
637 * Exporting code blocks:: Export contents and/or results
638 * Extracting source code:: Create pure source code files
639 * Evaluating code blocks:: Place results of evaluation in the Org-mode buffer
640 * Library of Babel:: Use and contribute to a library of useful code blocks
641 * Languages:: List of supported code block languages
642 * Header arguments:: Configure code block functionality
643 * Results of evaluation:: How evaluation results are handled
644 * Noweb reference syntax:: Literate programming in Org-mode
645 * Key bindings and useful functions:: Work quickly with code blocks
646 * Batch execution:: Call functions from the command line
650 * Using header arguments:: Different ways to set header arguments
651 * Specific header arguments:: List of header arguments
653 Using header arguments
655 * System-wide header arguments:: Set global default values
656 * Language-specific header arguments:: Set default values by language
657 * Buffer-wide header arguments:: Set default values for a specific buffer
658 * Header arguments in Org-mode properties:: Set default values for a buffer or heading
659 * Code block specific header arguments:: The most common way to set values
660 * Header arguments in function calls:: The most specific level
662 Specific header arguments
664 * var:: Pass arguments to code blocks
665 * results:: Specify the type of results and how they will
666 be collected and handled
667 * file:: Specify a path for file output
668 * dir:: Specify the default (possibly remote)
669 directory for code block execution
670 * exports:: Export code and/or results
671 * tangle:: Toggle tangling and specify file name
672 * comments:: Toggle insertion of comments in tangled
674 * no-expand:: Turn off variable assignment and noweb
675 expansion during tangling
676 * session:: Preserve the state of code evaluation
677 * noweb:: Toggle expansion of noweb references
678 * cache:: Avoid re-evaluating unchanged code blocks
679 * hlines:: Handle horizontal lines in tables
680 * colnames:: Handle column names in tables
681 * rownames:: Handle row names in tables
682 * shebang:: Make tangled files executable
683 * eval:: Limit evaluation of specific code blocks
687 * Completion:: M-TAB knows what you need
688 * Easy Templates:: Quick insertion of structural elements
689 * Speed keys:: Electric commands at the beginning of a headline
690 * Code evaluation security:: Org mode files evaluate inline code
691 * Customization:: Adapting Org to your taste
692 * In-buffer settings:: Overview of the #+KEYWORDS
693 * The very busy C-c C-c key:: When in doubt, press C-c C-c
694 * Clean view:: Getting rid of leading stars in the outline
695 * TTY keys:: Using Org on a tty
696 * Interaction:: Other Emacs packages
698 Interaction with other packages
700 * Cooperation:: Packages Org cooperates with
701 * Conflicts:: Packages that lead to conflicts
705 * Hooks:: Who to reach into Org's internals
706 * Add-on packages:: Available extensions
707 * Adding hyperlink types:: New custom link types
708 * Context-sensitive commands:: How to add functionality to such commands
709 * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
710 * Dynamic blocks:: Automatically filled blocks
711 * Special agenda views:: Customized views
712 * Extracting agenda information:: Postprocessing of agenda information
713 * Using the property API:: Writing programs that use entry properties
714 * Using the mapping API:: Mapping over all or selected entries
716 Tables and lists in arbitrary syntax
718 * Radio tables:: Sending and receiving radio tables
719 * A LaTeX example:: Step by step, almost a tutorial
720 * Translator functions:: Copy and modify
721 * Radio lists:: Doing the same for lists
725 * Setting up the staging area:: Where to interact with the mobile device
726 * Pushing to MobileOrg:: Uploading Org files and agendas
727 * Pulling from MobileOrg:: Integrating captured and flagged items
732 @node Introduction, Document Structure, Top, Top
733 @chapter Introduction
737 * Summary:: Brief summary of what Org does
738 * Installation:: How to install a downloaded version of Org
739 * Activation:: How to activate Org for certain buffers
740 * Feedback:: Bug reports, ideas, patches etc.
741 * Conventions:: Type-setting conventions in the manual
744 @node Summary, Installation, Introduction, Introduction
748 Org is a mode for keeping notes, maintaining TODO lists, and doing
749 project planning with a fast and effective plain-text system.
751 Org develops organizational tasks around NOTES files that contain
752 lists or information about projects as plain text. Org is
753 implemented on top of Outline mode, which makes it possible to keep the
754 content of large files well structured. Visibility cycling and
755 structure editing help to work with the tree. Tables are easily created
756 with a built-in table editor. Org supports TODO items, deadlines,
757 timestamps, and scheduling. It dynamically compiles entries into an
758 agenda that utilizes and smoothly integrates much of the Emacs calendar
759 and diary. Plain text URL-like links connect to websites, emails,
760 Usenet messages, BBDB entries, and any files related to the projects.
761 For printing and sharing of notes, an Org file can be exported as a
762 structured ASCII file, as HTML, or (TODO and agenda items only) as an
763 iCalendar file. It can also serve as a publishing tool for a set of
766 As a project planning environment, Org works by adding metadata to outline
767 nodes. Based on this data, specific entries can be extracted in queries and
768 create dynamic @i{agenda views}.
770 Org mode contains the Org Babel environment which allows you to work with
771 embedded source code blocks in a file, to facilitate code evaluation,
772 documentation, and tangling.
774 Org's automatic, context-sensitive table editor with spreadsheet
775 capabilities can be integrated into any major mode by activating the
776 minor Orgtbl mode. Using a translation step, it can be used to maintain
777 tables in arbitrary file types, for example in @LaTeX{}. The structure
778 editing and list creation capabilities can be used outside Org with
779 the minor Orgstruct mode.
781 Org keeps simple things simple. When first fired up, it should
782 feel like a straightforward, easy to use outliner. Complexity is not
783 imposed, but a large amount of functionality is available when you need
784 it. Org is a toolbox and can be used in different ways and for different
788 @r{@bullet{} an outline extension with visibility cycling and structure editing}
789 @r{@bullet{} an ASCII system and table editor for taking structured notes}
790 @r{@bullet{} a TODO list editor}
791 @r{@bullet{} a full agenda and planner with deadlines and work scheduling}
792 @pindex GTD, Getting Things Done
793 @r{@bullet{} an environment in which to implement David Allen's GTD system}
794 @r{@bullet{} a simple hypertext system, with HTML and @LaTeX{} export}
795 @r{@bullet{} a publishing tool to create a set of interlinked webpages}
796 @r{@bullet{} an environment for literate programming}
801 There is a website for Org which provides links to the newest
802 version of Org, as well as additional information, frequently asked
803 questions (FAQ), links to tutorials, etc@. This page is located at
804 @uref{http://orgmode.org}.
809 @node Installation, Activation, Summary, Introduction
810 @section Installation
814 @b{Important:} @i{If you are using a version of Org that is part of the Emacs
815 distribution or an XEmacs package, please skip this section and go directly
816 to @ref{Activation}.}
818 If you have downloaded Org from the Web, either as a distribution @file{.zip}
819 or @file{.tar} file, or as a Git archive, you must take the following steps
820 to install it: go into the unpacked Org distribution directory and edit the
821 top section of the file @file{Makefile}. You must set the name of the Emacs
822 binary (likely either @file{emacs} or @file{xemacs}), and the paths to the
823 directories where local Lisp and Info files are kept. If you don't have
824 access to the system-wide directories, you can simply run Org directly from
825 the distribution directory by adding the @file{lisp} subdirectory to the
826 Emacs load path. To do this, add the following line to @file{.emacs}:
829 (setq load-path (cons "~/path/to/orgdir/lisp" load-path))
833 If you plan to use code from the @file{contrib} subdirectory, do a similar
834 step for this directory:
837 (setq load-path (cons "~/path/to/orgdir/contrib/lisp" load-path))
840 @noindent Now byte-compile the Lisp files with the shell command:
846 @noindent If you are running Org from the distribution directory, this is
847 all. If you want to install Org into the system directories, use (as
854 Installing Info files is system dependent, because of differences in the
855 @file{install-info} program. In Debian it copies the info files into the
856 correct directory and modifies the info directory file. In many other
857 systems, the files need to be copied to the correct directory separately, and
858 @file{install-info} then only modifies the directory file. Check your system
859 documentation to find out which of the following commands you need:
863 make install-info-debian
866 Then add the following line to @file{.emacs}. It is needed so that
867 Emacs can autoload functions that are located in files not immediately loaded
868 when Org-mode starts.
870 (require 'org-install)
873 Do not forget to activate Org as described in the following section.
876 @node Activation, Feedback, Installation, Introduction
880 @cindex global key bindings
881 @cindex key bindings, global
883 Add the following lines to your @file{.emacs} file. The last three lines
884 define @emph{global} keys for the commands @command{org-store-link},
885 @command{org-agenda}, and @command{org-iswitchb}---please choose suitable
889 ;; The following lines are always needed. Choose your own keys.
890 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
891 (global-set-key "\C-cl" 'org-store-link)
892 (global-set-key "\C-ca" 'org-agenda)
893 (global-set-key "\C-cb" 'org-iswitchb)
896 Furthermore, you must activate @code{font-lock-mode} in Org
897 buffers, because significant functionality depends on font-locking being
898 active. You can do this with either one of the following two lines
899 (XEmacs users must use the second option):
901 (global-font-lock-mode 1) ; for all buffers
902 (add-hook 'org-mode-hook 'turn-on-font-lock) ; Org buffers only
905 @cindex Org-mode, turning on
906 With this setup, all files with extension @samp{.org} will be put
907 into Org-mode. As an alternative, make the first line of a file look
911 MY PROJECTS -*- mode: org; -*-
914 @vindex org-insert-mode-line-in-empty-file
915 @noindent which will select Org-mode for this buffer no matter what
916 the file's name is. See also the variable
917 @code{org-insert-mode-line-in-empty-file}.
919 Many commands in Org work on the region if the region is @i{active}. To make
920 use of this, you need to have @code{transient-mark-mode}
921 (@code{zmacs-regions} in XEmacs) turned on. In Emacs 23 this is the default,
922 in Emacs 22 you need to do this yourself with
924 (transient-mark-mode 1)
926 @noindent If you do not like @code{transient-mark-mode}, you can create an
927 active region by using the mouse to select a region, or pressing
928 @kbd{C-@key{SPC}} twice before moving the cursor.
930 @node Feedback, Conventions, Activation, Introduction
937 If you find problems with Org, or if you have questions, remarks, or ideas
938 about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}.
939 If you are not a member of the mailing list, your mail will be passed to the
940 list after a moderator has approved it@footnote{Please consider subscribing
941 to the mailing list, in order to minimize the work the mailing list
942 moderators have to do.}.
944 For bug reports, please first try to reproduce the bug with the latest
945 version of Org available---if you are running an outdated version, it is
946 quite possible that the bug has been fixed already. If the bug persists,
947 prepare a report and provide as much information as possible, including the
948 version information of Emacs (@kbd{M-x emacs-version @key{RET}}) and Org
949 (@kbd{M-x org-version @key{RET}}), as well as the Org related setup in
950 @file{.emacs}. The easiest way to do this is to use the command
952 @kbd{M-x org-submit-bug-report}
954 @noindent which will put all this information into an Emacs mail buffer so
955 that you only need to add your description. If you re not sending the Email
956 from within Emacs, please copy and paste the content into your Email program.
958 If an error occurs, a backtrace can be very useful (see below on how to
959 create one). Often a small example file helps, along with clear information
963 @item What exactly did you do?
964 @item What did you expect to happen?
965 @item What happened instead?
967 @noindent Thank you for helping to improve this program.
969 @subsubheading How to create a useful backtrace
971 @cindex backtrace of an error
972 If working with Org produces an error with a message you don't
973 understand, you may have hit a bug. The best way to report this is by
974 providing, in addition to what was mentioned above, a @emph{backtrace}.
975 This is information from the built-in debugger about where and how the
976 error occurred. Here is how to produce a useful backtrace:
980 Reload uncompiled versions of all Org-mode Lisp files. The backtrace
981 contains much more information if it is produced with uncompiled code.
984 C-u M-x org-reload RET
987 or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the
990 Go to the @code{Options} menu and select @code{Enter Debugger on Error}
991 (XEmacs has this option in the @code{Troubleshooting} sub-menu).
993 Do whatever you have to do to hit the error. Don't forget to
994 document the steps you take.
996 When you hit the error, a @file{*Backtrace*} buffer will appear on the
997 screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and
998 attach it to your bug report.
1001 @node Conventions, , Feedback, Introduction
1002 @section Typesetting conventions used in this manual
1004 Org uses three types of keywords: TODO keywords, tags, and property
1005 names. In this manual we use the following conventions:
1010 TODO keywords are written with all capitals, even if they are
1014 User-defined tags are written in lowercase; built-in tags with special
1015 meaning are written with all capitals.
1018 User-defined properties are capitalized; built-in properties with
1019 special meaning are written with all capitals.
1022 The manual lists both the keys and the corresponding commands for accessing
1023 functionality. Org mode often uses the same key for different functions,
1024 depending on context. The command that is bound to such keys has a generic
1025 name, like @code{org-metaright}. In the manual we will, wherever possible,
1026 give the function that is internally called by the generic command. For
1027 example, in the chapter on document structure, @kbd{M-@key{right}} will be
1028 listed to call @code{org-do-demote}, while in the chapter on tables, it will
1029 be listed to call org-table-move-column-right.
1031 If you prefer, you can compile the manual without the command names by
1032 unsetting the flag @code{cmdnames} in @file{org.texi}.
1034 @node Document Structure, Tables, Introduction, Top
1035 @chapter Document structure
1036 @cindex document structure
1037 @cindex structure of document
1039 Org is based on Outline mode and provides flexible commands to
1040 edit the structure of the document.
1043 * Outlines:: Org is based on Outline mode
1044 * Headlines:: How to typeset Org tree headlines
1045 * Visibility cycling:: Show and hide, much simplified
1046 * Motion:: Jumping to other headlines
1047 * Structure editing:: Changing sequence and level of headlines
1048 * Sparse trees:: Matches embedded in context
1049 * Plain lists:: Additional structure within an entry
1050 * Drawers:: Tucking stuff away
1051 * Blocks:: Folding blocks
1052 * Footnotes:: How footnotes are defined in Org's syntax
1053 * Orgstruct mode:: Structure editing outside Org
1056 @node Outlines, Headlines, Document Structure, Document Structure
1059 @cindex Outline mode
1061 Org is implemented on top of Outline mode. Outlines allow a
1062 document to be organized in a hierarchical structure, which (at least
1063 for me) is the best representation of notes and thoughts. An overview
1064 of this structure is achieved by folding (hiding) large parts of the
1065 document to show only the general document structure and the parts
1066 currently being worked on. Org greatly simplifies the use of
1067 outlines by compressing the entire show/hide functionality into a single
1068 command, @command{org-cycle}, which is bound to the @key{TAB} key.
1070 @node Headlines, Visibility cycling, Outlines, Document Structure
1073 @cindex outline tree
1074 @vindex org-special-ctrl-a/e
1075 @vindex org-special-ctrl-k
1076 @vindex org-ctrl-k-protect-subtree
1078 Headlines define the structure of an outline tree. The headlines in Org
1079 start with one or more stars, on the left margin@footnote{See the variables
1080 @code{org-special-ctrl-a/e}, @code{org-special-ctrl-k}, and
1081 @code{org-ctrl-k-protect-subtree} to configure special behavior of @kbd{C-a},
1082 @kbd{C-e}, and @kbd{C-k} in headlines.}. For example:
1085 * Top level headline
1092 * Another top level headline
1095 @noindent Some people find the many stars too noisy and would prefer an
1096 outline that has whitespace followed by a single star as headline
1097 starters. @ref{Clean view}, describes a setup to realize this.
1099 @vindex org-cycle-separator-lines
1100 An empty line after the end of a subtree is considered part of it and
1101 will be hidden when the subtree is folded. However, if you leave at
1102 least two empty lines, one empty line will remain visible after folding
1103 the subtree, in order to structure the collapsed view. See the
1104 variable @code{org-cycle-separator-lines} to modify this behavior.
1106 @node Visibility cycling, Motion, Headlines, Document Structure
1107 @section Visibility cycling
1108 @cindex cycling, visibility
1109 @cindex visibility cycling
1110 @cindex trees, visibility
1111 @cindex show hidden text
1114 Outlines make it possible to hide parts of the text in the buffer.
1115 Org uses just two commands, bound to @key{TAB} and
1116 @kbd{S-@key{TAB}} to change the visibility in the buffer.
1118 @cindex subtree visibility states
1119 @cindex subtree cycling
1120 @cindex folded, subtree visibility state
1121 @cindex children, subtree visibility state
1122 @cindex subtree, subtree visibility state
1124 @orgcmd{@key{TAB},org-cycle}
1125 @emph{Subtree cycling}: Rotate current subtree among the states
1128 ,-> FOLDED -> CHILDREN -> SUBTREE --.
1129 '-----------------------------------'
1132 @vindex org-cycle-emulate-tab
1133 @vindex org-cycle-global-at-bob
1134 The cursor must be on a headline for this to work@footnote{see, however,
1135 the option @code{org-cycle-emulate-tab}.}. When the cursor is at the
1136 beginning of the buffer and the first line is not a headline, then
1137 @key{TAB} actually runs global cycling (see below)@footnote{see the
1138 option @code{org-cycle-global-at-bob}.}. Also when called with a prefix
1139 argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
1141 @cindex global visibility states
1142 @cindex global cycling
1143 @cindex overview, global visibility state
1144 @cindex contents, global visibility state
1145 @cindex show all, global visibility state
1146 @orgcmd{S-@key{TAB},org-global-cycle}
1147 @itemx C-u @key{TAB}
1148 @emph{Global cycling}: Rotate the entire buffer among the states
1151 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
1152 '--------------------------------------'
1155 When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
1156 CONTENTS view up to headlines of level N will be shown. Note that inside
1157 tables, @kbd{S-@key{TAB}} jumps to the previous field.
1159 @cindex show all, command
1160 @orgcmd{C-u C-u C-u @key{TAB},show-all}
1161 Show all, including drawers.
1162 @orgcmd{C-c C-r,org-reveal}
1163 Reveal context around point, showing the current entry, the following heading
1164 and the hierarchy above. Useful for working near a location that has been
1165 exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
1166 (@pxref{Agenda commands}). With a prefix argument show, on each
1167 level, all sibling headings. With double prefix arg, also show the entire
1168 subtree of the parent.
1169 @orgcmd{C-c C-k,show-branches}
1170 Expose all the headings of the subtree, CONTENT view for just one subtree.
1171 @orgcmd{C-c C-x b,org-tree-to-indirect-buffer}
1172 Show the current subtree in an indirect buffer@footnote{The indirect
1175 (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
1178 (see the Emacs manual for more information about indirect buffers)
1180 will contain the entire buffer, but will be narrowed to the current
1181 tree. Editing the indirect buffer will also change the original buffer,
1182 but without affecting visibility in that buffer.}. With a numeric
1183 prefix argument N, go up to level N and then take that tree. If N is
1184 negative then go up that many levels. With a @kbd{C-u} prefix, do not remove
1185 the previously used indirect buffer.
1188 @vindex org-startup-folded
1189 @cindex @code{overview}, STARTUP keyword
1190 @cindex @code{content}, STARTUP keyword
1191 @cindex @code{showall}, STARTUP keyword
1192 @cindex @code{showeverything}, STARTUP keyword
1194 When Emacs first visits an Org file, the global state is set to
1195 OVERVIEW, i.e. only the top level headlines are visible. This can be
1196 configured through the variable @code{org-startup-folded}, or on a
1197 per-file basis by adding one of the following lines anywhere in the
1204 #+STARTUP: showeverything
1207 @cindex property, VISIBILITY
1209 Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
1210 and Columns}) will get their visibility adapted accordingly. Allowed values
1211 for this property are @code{folded}, @code{children}, @code{content}, and
1214 @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
1215 Switch back to the startup visibility of the buffer, i.e. whatever is
1216 requested by startup options and @samp{VISIBILITY} properties in individual
1220 @node Motion, Structure editing, Visibility cycling, Document Structure
1222 @cindex motion, between headlines
1223 @cindex jumping, to headlines
1224 @cindex headline navigation
1225 The following commands jump to other headlines in the buffer.
1228 @orgcmd{C-c C-n,outline-next-visible-heading}
1230 @orgcmd{C-c C-p,outline-previous-visible-heading}
1232 @orgcmd{C-c C-f,org-forward-same-level}
1233 Next heading same level.
1234 @orgcmd{C-c C-b,org-backward-same-level}
1235 Previous heading same level.
1236 @orgcmd{C-c C-u,outline-up-heading}
1237 Backward to higher level heading.
1238 @orgcmd{C-c C-j,org-goto}
1239 Jump to a different place without changing the current outline
1240 visibility. Shows the document structure in a temporary buffer, where
1241 you can use the following keys to find your destination:
1242 @vindex org-goto-auto-isearch
1244 @key{TAB} @r{Cycle visibility.}
1245 @key{down} / @key{up} @r{Next/previous visible headline.}
1246 @key{RET} @r{Select this location.}
1247 @kbd{/} @r{Do a Sparse-tree search}
1248 @r{The following keys work if you turn off @code{org-goto-auto-isearch}}
1249 n / p @r{Next/previous visible headline.}
1250 f / b @r{Next/previous headline same level.}
1252 0-9 @r{Digit argument.}
1255 @vindex org-goto-interface
1257 See also the variable @code{org-goto-interface}.
1260 @node Structure editing, Sparse trees, Motion, Document Structure
1261 @section Structure editing
1262 @cindex structure editing
1263 @cindex headline, promotion and demotion
1264 @cindex promotion, of subtrees
1265 @cindex demotion, of subtrees
1266 @cindex subtree, cut and paste
1267 @cindex pasting, of subtrees
1268 @cindex cutting, of subtrees
1269 @cindex copying, of subtrees
1270 @cindex sorting, of subtrees
1271 @cindex subtrees, cut and paste
1274 @orgcmd{M-@key{RET},org-insert-heading}
1275 @vindex org-M-RET-may-split-line
1276 Insert new heading with same level as current. If the cursor is in a
1277 plain list item, a new item is created (@pxref{Plain lists}). To force
1278 creation of a new headline, use a prefix argument, or first press @key{RET}
1279 to get to the beginning of the next line. When this command is used in
1280 the middle of a line, the line is split and the rest of the line becomes
1281 the new headline@footnote{If you do not want the line to be split,
1282 customize the variable @code{org-M-RET-may-split-line}.}. If the
1283 command is used at the beginning of a headline, the new headline is
1284 created before the current line. If at the beginning of any other line,
1285 the content of that line is made the new heading. If the command is
1286 used at the end of a folded subtree (i.e. behind the ellipses at the end
1287 of a headline), then a headline like the current one will be inserted
1288 after the end of the subtree.
1289 @orgcmd{C-@key{RET},org-insert-heading-respect-content}
1290 Just like @kbd{M-@key{RET}}, except when adding a new heading below the
1291 current heading, the new heading is placed after the body instead of before
1292 it. This command works from anywhere in the entry.
1293 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
1294 @vindex org-treat-insert-todo-heading-as-state-change
1295 Insert new TODO entry with same level as current heading. See also the
1296 variable @code{org-treat-insert-todo-heading-as-state-change}.
1297 @orgcmd{C-S-@key{RET},org-insert-todo-heading-respect-content}
1298 Insert new TODO entry with same level as current heading. Like
1299 @kbd{C-@key{RET}}, the new headline will be inserted after the current
1301 @orgcmd{@key{TAB},org-cycle}
1302 In a new entry with no text yet, the first @key{TAB} demotes the entry to
1303 become a child of the previous one. The next @key{TAB} makes it a parent,
1304 and so on, all the way to top level. Yet another @key{TAB}, and you are back
1305 to the initial level.
1306 @orgcmd{M-@key{left},org-do-promote}
1307 Promote current heading by one level.
1308 @orgcmd{M-@key{right},org-do-demote}
1309 Demote current heading by one level.
1310 @orgcmd{M-S-@key{left},org-promote-subtree}
1311 Promote the current subtree by one level.
1312 @orgcmd{M-S-@key{right},org-demote-subtree}
1313 Demote the current subtree by one level.
1314 @orgcmd{M-S-@key{up},org-move-subtree-up}
1315 Move subtree up (swap with previous subtree of same
1317 @orgcmd{M-S-@key{down},org-move-subtree-down}
1318 Move subtree down (swap with next subtree of same level).
1319 @orgcmd{C-c C-x C-w,org-cut-subtree}
1320 Kill subtree, i.e. remove it from buffer but save in kill ring.
1321 With a numeric prefix argument N, kill N sequential subtrees.
1322 @orgcmd{C-c C-x M-w,org-copy-subtree}
1323 Copy subtree to kill ring. With a numeric prefix argument N, copy the N
1324 sequential subtrees.
1325 @orgcmd{C-c C-x C-y,org-paste-subtree}
1326 Yank subtree from kill ring. This does modify the level of the subtree to
1327 make sure the tree fits in nicely at the yank position. The yank level can
1328 also be specified with a numeric prefix argument, or by yanking after a
1329 headline marker like @samp{****}.
1330 @orgcmd{C-y,org-yank}
1331 @vindex org-yank-adjusted-subtrees
1332 @vindex org-yank-folded-subtrees
1333 Depending on the variables @code{org-yank-adjusted-subtrees} and
1334 @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
1335 paste subtrees folded and in a clever way, using the same command as @kbd{C-c
1336 C-x C-y}. With the default settings, no level adjustment will take place,
1337 but the yanked tree will be folded unless doing so would swallow text
1338 previously visible. Any prefix argument to this command will force a normal
1339 @code{yank} to be executed, with the prefix passed along. A good way to
1340 force a normal yank is @kbd{C-u C-y}. If you use @code{yank-pop} after a
1341 yank, it will yank previous kill items plainly, without adjustment and
1343 @orgcmd{C-c C-x c,org-clone-subtree-with-time-shift}
1344 Clone a subtree by making a number of sibling copies of it. You will be
1345 prompted for the number of copies to make, and you can also specify if any
1346 timestamps in the entry should be shifted. This can be useful, for example,
1347 to create a number of tasks related to a series of lectures to prepare. For
1348 more details, see the docstring of the command
1349 @code{org-clone-subtree-with-time-shift}.
1350 @orgcmd{C-c C-w,org-refile}
1351 Refile entry or region to a different location. @xref{Refiling notes}.
1352 @orgcmd{C-c ^,org-sort-entries-or-items}
1353 Sort same-level entries. When there is an active region, all entries in the
1354 region will be sorted. Otherwise the children of the current headline are
1355 sorted. The command prompts for the sorting method, which can be
1356 alphabetically, numerically, by time (first timestamp with active preferred,
1357 creation time, scheduled time, deadline time), by priority, by TODO keyword
1358 (in the sequence the keywords have been defined in the setup) or by the value
1359 of a property. Reverse sorting is possible as well. You can also supply
1360 your own function to extract the sorting key. With a @kbd{C-u} prefix,
1361 sorting will be case-sensitive. With two @kbd{C-u C-u} prefixes, duplicate
1362 entries will also be removed.
1363 @orgcmd{C-x n s,org-narrow-to-subtree}
1364 Narrow buffer to current subtree.
1365 @orgcmd{C-x n w,widen}
1366 Widen buffer to remove narrowing.
1367 @orgcmd{C-c *,org-toggle-heading}
1368 Turn a normal line or plain list item into a headline (so that it becomes a
1369 subheading at its location). Also turn a headline into a normal line by
1370 removing the stars. If there is an active region, turn all lines in the
1371 region into headlines. If the first line in the region was an item, turn
1372 only the item lines into headlines. Finally, if the first line is a
1373 headline, remove the stars from all headlines in the region.
1376 @cindex region, active
1377 @cindex active region
1378 @cindex transient mark mode
1379 When there is an active region (Transient Mark mode), promotion and
1380 demotion work on all headlines in the region. To select a region of
1381 headlines, it is best to place both point and mark at the beginning of a
1382 line, mark at the beginning of the first headline, and point at the line
1383 just after the last headline to change. Note that when the cursor is
1384 inside a table (@pxref{Tables}), the Meta-Cursor keys have different
1388 @node Sparse trees, Plain lists, Structure editing, Document Structure
1389 @section Sparse trees
1390 @cindex sparse trees
1391 @cindex trees, sparse
1392 @cindex folding, sparse trees
1393 @cindex occur, command
1395 @vindex org-show-hierarchy-above
1396 @vindex org-show-following-heading
1397 @vindex org-show-siblings
1398 @vindex org-show-entry-below
1399 An important feature of Org-mode is the ability to construct @emph{sparse
1400 trees} for selected information in an outline tree, so that the entire
1401 document is folded as much as possible, but the selected information is made
1402 visible along with the headline structure above it@footnote{See also the
1403 variables @code{org-show-hierarchy-above}, @code{org-show-following-heading},
1404 @code{org-show-siblings}, and @code{org-show-entry-below} for detailed
1405 control on how much context is shown around each match.}. Just try it out
1406 and you will see immediately how it works.
1408 Org-mode contains several commands creating such trees, all these
1409 commands can be accessed through a dispatcher:
1412 @orgcmd{C-c /,org-sparse-tree}
1413 This prompts for an extra key to select a sparse-tree creating command.
1414 @orgcmd{C-c / r,org-occur}
1415 @vindex org-remove-highlights-with-change
1416 Occur. Prompts for a regexp and shows a sparse tree with all matches. If
1417 the match is in a headline, the headline is made visible. If the match is in
1418 the body of an entry, headline and body are made visible. In order to
1419 provide minimal context, also the full hierarchy of headlines above the match
1420 is shown, as well as the headline following the match. Each match is also
1421 highlighted; the highlights disappear when the buffer is changed by an
1422 editing command@footnote{This depends on the option
1423 @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
1424 When called with a @kbd{C-u} prefix argument, previous highlights are kept,
1425 so several calls to this command can be stacked.
1429 @vindex org-agenda-custom-commands
1430 For frequently used sparse trees of specific search strings, you can
1431 use the variable @code{org-agenda-custom-commands} to define fast
1432 keyboard access to specific sparse trees. These commands will then be
1433 accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
1437 (setq org-agenda-custom-commands
1438 '(("f" occur-tree "FIXME")))
1441 @noindent will define the key @kbd{C-c a f} as a shortcut for creating
1442 a sparse tree matching the string @samp{FIXME}.
1444 The other sparse tree commands select headings based on TODO keywords,
1445 tags, or properties and will be discussed later in this manual.
1448 @cindex printing sparse trees
1449 @cindex visible text, printing
1450 To print a sparse tree, you can use the Emacs command
1451 @code{ps-print-buffer-with-faces} which does not print invisible parts
1452 of the document @footnote{This does not work under XEmacs, because
1453 XEmacs uses selective display for outlining, not text properties.}.
1454 Or you can use the command @kbd{C-c C-e v} to export only the visible
1455 part of the document and print the resulting file.
1457 @node Plain lists, Drawers, Sparse trees, Document Structure
1458 @section Plain lists
1460 @cindex lists, plain
1461 @cindex lists, ordered
1462 @cindex ordered lists
1464 Within an entry of the outline tree, hand-formatted lists can provide
1465 additional structure. They also provide a way to create lists of checkboxes
1466 (@pxref{Checkboxes}). Org supports editing such lists, and every exporter
1467 (@pxref{Exporting}) can parse and format them.
1469 Org knows ordered lists, unordered lists, and description lists.
1472 @emph{Unordered} list items start with @samp{-}, @samp{+}, or
1473 @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
1474 they will be seen as top-level headlines. Also, when you are hiding leading
1475 stars to get a clean outline view, plain list items starting with a star are
1476 visually indistinguishable from true headlines. In short: even though
1477 @samp{*} is supported, it may be better to not use it for plain list items.}
1480 @vindex org-plain-list-ordered-item-terminator
1481 @emph{Ordered} list items start with a numeral followed by either a period or
1482 a right parenthesis@footnote{You can filter out any of them by configuring
1483 @code{org-plain-list-ordered-item-terminator}.}, such as @samp{1.} or
1484 @samp{1)}. If you want a list to start with a different value (e.g. 20), start
1485 the text of the item with @code{[@@20]}@footnote{If there's a checkbox in the
1486 item, the cookie must be put @emph{before} the checkbox.}. Those constructs
1487 can be used in any item of the list in order to enforce a particular
1490 @emph{Description} list items are unordered list items, and contain the
1491 separator @samp{ :: } to separate the description @emph{term} from the
1495 Items belonging to the same list must have the same indentation on the first
1496 line. In particular, if an ordered list reaches number @samp{10.}, then the
1497 2--digit numbers must be written left-aligned with the other numbers in the
1500 @vindex org-list-ending-method
1501 @vindex org-list-end-regexp
1502 @vindex org-empty-line-terminates-plain-lists
1503 Two methods@footnote{To disable either of them, configure
1504 @code{org-list-ending-method}.} are provided to terminate lists. A list ends
1505 before the next line that is indented like the bullet/number or less, or it
1506 ends before two blank lines@footnote{See also
1507 @code{org-empty-line-terminates-plain-lists}.}. In both cases, all levels of
1508 the list are closed@footnote{So you cannot have a sublist, some text and then
1509 another sublist while still in the same top-level list item. This used to be
1510 possible, but it was only supported in the HTML exporter and difficult to
1511 manage with automatic indentation.}. For finer control, you can end lists
1512 with any pattern set in @code{org-list-end-regexp}. Here is an example:
1516 ** Lord of the Rings
1517 My favorite scenes are (in this order)
1518 1. The attack of the Rohirrim
1519 2. Eowyn's fight with the witch king
1520 + this was already my favorite scene in the book
1521 + I really like Miranda Otto.
1522 3. Peter Jackson being shot by Legolas
1523 He makes a really funny face when it happens.
1525 But in the end, no individual scenes matter but the film as a whole.
1526 Important actors in this film are:
1527 - @b{Elijah Wood} :: He plays Frodo
1528 - @b{Sean Austin} :: He plays Sam, Frodo's friend. I still remember
1529 him very well from his role as Mikey Walsh in @i{The Goonies}.
1533 Org supports these lists by tuning filling and wrapping commands to deal with
1534 them correctly@footnote{Org only changes the filling settings for Emacs. For
1535 XEmacs, you should use Kyle E. Jones' @file{filladapt.el}. To turn this on,
1536 put into @file{.emacs}: @code{(require 'filladapt)}}, and by exporting them
1537 properly (@pxref{Exporting}). Since indentation is what governs the
1538 structure of these lists, many structural constructs like @code{#+BEGIN_...}
1539 blocks can be indented to signal that they should be considered as a list
1542 @vindex org-list-demote-modify-bullet
1543 If you find that using a different bullet for a sub-list (than that used for
1544 the current list-level) improves readability, customize the variable
1545 @code{org-list-demote-modify-bullet}.
1547 @vindex org-list-automatic-rules
1548 The following commands act on items when the cursor is in the first line of
1549 an item (the line with the bullet or number). Some of them imply the
1550 application of automatic rules to keep list structure intact. If some of
1551 these actions get in your way, configure @code{org-list-automatic-rules}
1552 to disable them individually.
1555 @orgcmd{@key{TAB},org-cycle}
1556 @vindex org-cycle-include-plain-lists
1557 Items can be folded just like headline levels. Normally this works only if
1558 the cursor is on a plain list item. For more details, see the variable
1559 @code{org-cycle-include-plain-lists}. If this variable is set to
1560 @code{integrate}, plain list items will be treated like low-level
1561 headlines. The level of an item is then given by the
1562 indentation of the bullet/number. Items are always subordinate to real
1563 headlines, however; the hierarchies remain completely separated.
1564 @orgcmd{M-@key{RET},org-insert-heading}
1565 @vindex org-M-RET-may-split-line
1566 @vindex org-list-automatic-rules
1567 Insert new item at current level. With a prefix argument, force a new
1568 heading (@pxref{Structure editing}). If this command is used in the middle
1569 of a line, the line is @emph{split} and the rest of the line becomes the new
1570 item@footnote{If you do not want the line to be split, customize the variable
1571 @code{org-M-RET-may-split-line}.}. If this command is executed @emph{before
1572 an item's body}, the new item is created @emph{before} the current item. If the
1573 command is executed in the white space before the text that is part of an
1574 item but does not contain the bullet, a bullet is added to the current line.
1576 As a new item cannot be inserted in a structural construct (like an example
1577 or source code block) within a list, Org will instead insert it right before
1578 the structure, or return an error.
1579 @kindex M-S-@key{RET}
1581 Insert a new item with a checkbox (@pxref{Checkboxes}).
1582 @orgcmd{@key{TAB},org-cycle}
1583 In a new item with no text yet, the first @key{TAB} demotes the item to
1584 become a child of the previous one. Subsequent @key{TAB}s move the item to
1585 meaningful levels in the list and eventually get it back to its initial
1587 @kindex S-@key{down}
1590 @cindex shift-selection-mode
1591 @vindex org-support-shift-select
1592 Jump to the previous/next item in the current list, but only if
1593 @code{org-support-shift-select} is off. If not, you can still use paragraph
1594 jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite
1596 @kindex M-S-@key{up}
1597 @kindex M-S-@key{down}
1599 @itemx M-S-@key{down}
1600 Move the item including subitems up/down (swap with previous/next item
1601 of same indentation). If the list is ordered, renumbering is
1603 @kindex M-@key{left}
1604 @kindex M-@key{right}
1606 @itemx M-@key{right}
1607 Decrease/increase the indentation of an item, leaving children alone.
1608 @kindex M-S-@key{left}
1609 @kindex M-S-@key{right}
1610 @item M-S-@key{left}
1611 @itemx M-S-@key{right}
1612 Decrease/increase the indentation of the item, including subitems.
1613 Initially, the item tree is selected based on current indentation. When
1614 these commands are executed several times in direct succession, the initially
1615 selected region is used, even if the new indentation would imply a different
1616 hierarchy. To use the new hierarchy, break the command chain with a cursor
1619 As a special case, using this command on the very first item of a list will
1620 move the whole list. This behavior can be disabled by configuring
1621 @code{org-list-automatic-rules}. The global indentation of a list has no
1622 influence on the text @emph{after} the list.
1625 If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
1626 state of the checkbox. Also, makes sure that all the
1627 items on this list level use the same bullet and that the numbering of list
1628 items (if applicable) is correct.
1630 @vindex org-plain-list-ordered-item-terminator
1631 @vindex org-list-automatic-rules
1633 Cycle the entire list level through the different itemize/enumerate bullets
1634 (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}) or a subset of them,
1635 depending on @code{org-plain-list-ordered-item-terminator}, the type of list,
1636 and its position@footnote{See @code{bullet} rule in
1637 @code{org-list-automatic-rules} for more information.}. With a numeric
1638 prefix argument N, select the Nth bullet from this list. If there is an
1639 active region when calling this, all lines will be converted to list items.
1640 If the first line already was a list item, any item markers will be removed
1641 from the list. Finally, even without an active region, a normal line will be
1642 converted into a list item.
1645 Turn a plain list item into a headline (so that it becomes a subheading at
1646 its location). @xref{Structure editing}, for a detailed explanation.
1647 @kindex S-@key{left}
1648 @kindex S-@key{right}
1649 @item S-@key{left}/@key{right}
1650 @vindex org-support-shift-select
1651 This command also cycles bullet styles when the cursor in on the bullet or
1652 anywhere in an item line, details depending on
1653 @code{org-support-shift-select}.
1656 Sort the plain list. You will be prompted for the sorting method:
1657 numerically, alphabetically, by time, or by custom function.
1660 @node Drawers, Blocks, Plain lists, Document Structure
1664 @cindex visibility cycling, drawers
1667 Sometimes you want to keep information associated with an entry, but you
1668 normally don't want to see it. For this, Org-mode has @emph{drawers}.
1669 Drawers need to be configured with the variable
1670 @code{org-drawers}@footnote{You can define drawers on a per-file basis
1671 with a line like @code{#+DRAWERS: HIDDEN PROPERTIES STATE}}. Drawers
1675 ** This is a headline
1676 Still outside the drawer
1678 This is inside the drawer.
1683 Visibility cycling (@pxref{Visibility cycling}) on the headline will hide and
1684 show the entry, but keep the drawer collapsed to a single line. In order to
1685 look inside the drawer, you need to move the cursor to the drawer line and
1686 press @key{TAB} there. Org-mode uses the @code{PROPERTIES} drawer for
1687 storing properties (@pxref{Properties and Columns}), and you can also arrange
1688 for state change notes (@pxref{Tracking TODO state changes}) and clock times
1689 (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}. If you
1690 want to store a quick note in the LOGBOOK drawer, in a similar way to state changes, use
1695 Add a time-stamped note to the LOGBOOK drawer.
1698 @node Blocks, Footnotes, Drawers, Document Structure
1701 @vindex org-hide-block-startup
1702 @cindex blocks, folding
1703 Org-mode uses begin...end blocks for various purposes from including source
1704 code examples (@pxref{Literal examples}) to capturing time logging
1705 information (@pxref{Clocking work time}). These blocks can be folded and
1706 unfolded by pressing TAB in the begin line. You can also get all blocks
1707 folded at startup by configuring the variable @code{org-hide-block-startup}
1708 or on a per-file basis by using
1710 @cindex @code{hideblocks}, STARTUP keyword
1711 @cindex @code{nohideblocks}, STARTUP keyword
1713 #+STARTUP: hideblocks
1714 #+STARTUP: nohideblocks
1717 @node Footnotes, Orgstruct mode, Blocks, Document Structure
1721 Org-mode supports the creation of footnotes. In contrast to the
1722 @file{footnote.el} package, Org-mode's footnotes are designed for work on a
1723 larger document, not only for one-off documents like emails. The basic
1724 syntax is similar to the one used by @file{footnote.el}, i.e. a footnote is
1725 defined in a paragraph that is started by a footnote marker in square
1726 brackets in column 0, no indentation allowed. If you need a paragraph break
1727 inside a footnote, use the @LaTeX{} idiom @samp{\par}. The footnote reference
1728 is simply the marker in square brackets, inside text. For example:
1731 The Org homepage[fn:1] now looks a lot better than it used to.
1733 [fn:1] The link is: http://orgmode.org
1736 Org-mode extends the number-based syntax to @emph{named} footnotes and
1737 optional inline definition. Using plain numbers as markers (as
1738 @file{footnote.el} does) is supported for backward compatibility, but not
1739 encouraged because of possible conflicts with @LaTeX{} snippets (@pxref{Embedded
1740 LaTeX}). Here are the valid references:
1744 A plain numeric footnote marker. Compatible with @file{footnote.el}, but not
1745 recommended because something like @samp{[1]} could easily be part of a code
1748 A named footnote reference, where @code{name} is a unique label word, or, for
1749 simplicity of automatic creation, a number.
1750 @item [fn:: This is the inline definition of this footnote]
1751 A @LaTeX{}-like anonymous footnote where the definition is given directly at the
1753 @item [fn:name: a definition]
1754 An inline definition of a footnote, which also specifies a name for the note.
1755 Since Org allows multiple references to the same note, you can then use
1756 @code{[fn:name]} to create additional references.
1759 @vindex org-footnote-auto-label
1760 Footnote labels can be created automatically, or you can create names yourself.
1761 This is handled by the variable @code{org-footnote-auto-label} and its
1762 corresponding @code{#+STARTUP} keywords. See the docstring of that variable
1765 @noindent The following command handles footnotes:
1770 The footnote action command.
1772 When the cursor is on a footnote reference, jump to the definition. When it
1773 is at a definition, jump to the (first) reference.
1775 @vindex org-footnote-define-inline
1776 @vindex org-footnote-section
1777 @vindex org-footnote-auto-adjust
1778 Otherwise, create a new footnote. Depending on the variable
1779 @code{org-footnote-define-inline}@footnote{The corresponding in-buffer
1780 setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
1781 definition will be placed right into the text as part of the reference, or
1782 separately into the location determined by the variable
1783 @code{org-footnote-section}.
1785 When this command is called with a prefix argument, a menu of additional
1788 s @r{Sort the footnote definitions by reference sequence. During editing,}
1789 @r{Org makes no effort to sort footnote definitions into a particular}
1790 @r{sequence. If you want them sorted, use this command, which will}
1791 @r{also move entries according to @code{org-footnote-section}. Automatic}
1792 @r{sorting after each insertion/deletion can be configured using the}
1793 @r{variable @code{org-footnote-auto-adjust}.}
1794 r @r{Renumber the simple @code{fn:N} footnotes. Automatic renumbering}
1795 @r{after each insertion/deletion can be configured using the variable}
1796 @r{@code{org-footnote-auto-adjust}.}
1797 S @r{Short for first @code{r}, then @code{s} action.}
1798 n @r{Normalize the footnotes by collecting all definitions (including}
1799 @r{inline definitions) into a special section, and then numbering them}
1800 @r{in sequence. The references will then also be numbers. This is}
1801 @r{meant to be the final step before finishing a document (e.g. sending}
1802 @r{off an email). The exporters do this automatically, and so could}
1803 @r{something like @code{message-send-hook}.}
1804 d @r{Delete the footnote at point, and all definitions of and references}
1807 Depending on the variable @code{org-footnote-auto-adjust}@footnote{the
1808 corresponding in-buffer options are @code{fnadjust} and @code{nofnadjust}.},
1809 renumbering and sorting footnotes can be automatic after each insertion or
1814 If the cursor is on a footnote reference, jump to the definition. If it is a
1815 the definition, jump back to the reference. When called at a footnote
1816 location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
1820 @item C-c C-o @r{or} mouse-1/2
1821 Footnote labels are also links to the corresponding definition/reference, and
1822 you can use the usual commands to follow these links.
1825 @node Orgstruct mode, , Footnotes, Document Structure
1826 @section The Orgstruct minor mode
1827 @cindex Orgstruct mode
1828 @cindex minor mode for structure editing
1830 If you like the intuitive way the Org-mode structure editing and list
1831 formatting works, you might want to use these commands in other modes like
1832 Text mode or Mail mode as well. The minor mode @code{orgstruct-mode} makes
1833 this possible. Toggle the mode with @kbd{M-x orgstruct-mode}, or
1834 turn it on by default, for example in Mail mode, with one of:
1837 (add-hook 'mail-mode-hook 'turn-on-orgstruct)
1838 (add-hook 'mail-mode-hook 'turn-on-orgstruct++)
1841 When this mode is active and the cursor is on a line that looks to Org like a
1842 headline or the first line of a list item, most structure editing commands
1843 will work, even if the same keys normally have different functionality in the
1844 major mode you are using. If the cursor is not in one of those special
1845 lines, Orgstruct mode lurks silently in the shadows. When you use
1846 @code{orgstruct++-mode}, Org will also export indentation and autofill
1847 settings into that mode, and detect item context after the first line of an
1850 @node Tables, Hyperlinks, Document Structure, Top
1853 @cindex editing tables
1855 Org comes with a fast and intuitive table editor. Spreadsheet-like
1856 calculations are supported using the Emacs @file{calc} package
1858 (@pxref{Top,Calc,,Calc,Gnu Emacs Calculator Manual}).
1861 (see the Emacs Calculator manual for more information about the Emacs
1866 * Built-in table editor:: Simple tables
1867 * Column width and alignment:: Overrule the automatic settings
1868 * Column groups:: Grouping to trigger vertical lines
1869 * Orgtbl mode:: The table editor as minor mode
1870 * The spreadsheet:: The table editor has spreadsheet capabilities
1871 * Org-Plot:: Plotting from org tables
1874 @node Built-in table editor, Column width and alignment, Tables, Tables
1875 @section The built-in table editor
1876 @cindex table editor, built-in
1878 Org makes it easy to format tables in plain ASCII. Any line with
1879 @samp{|} as the first non-whitespace character is considered part of a
1880 table. @samp{|} is also the column separator. A table might look like
1884 | Name | Phone | Age |
1885 |-------+-------+-----|
1886 | Peter | 1234 | 17 |
1887 | Anna | 4321 | 25 |
1890 A table is re-aligned automatically each time you press @key{TAB} or
1891 @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to
1892 the next field (@key{RET} to the next row) and creates new table rows
1893 at the end of the table or before horizontal lines. The indentation
1894 of the table is set by the first line. Any line starting with
1895 @samp{|-} is considered as a horizontal separator line and will be
1896 expanded on the next re-align to span the whole table width. So, to
1897 create the above table, you would only type
1904 @noindent and then press @key{TAB} to align the table and start filling in
1905 fields. Even faster would be to type @code{|Name|Phone|Age} followed by
1906 @kbd{C-c @key{RET}}.
1908 @vindex org-enable-table-editor
1909 @vindex org-table-auto-blank-field
1910 When typing text into a field, Org treats @key{DEL},
1911 @key{Backspace}, and all character keys in a special way, so that
1912 inserting and deleting avoids shifting other fields. Also, when
1913 typing @emph{immediately after the cursor was moved into a new field
1914 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
1915 field is automatically made blank. If this behavior is too
1916 unpredictable for you, configure the variables
1917 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
1920 @tsubheading{Creation and conversion}
1921 @orgcmd{C-c |,org-table-create-or-convert-from-region}
1922 Convert the active region to table. If every line contains at least one
1923 TAB character, the function assumes that the material is tab separated.
1924 If every line contains a comma, comma-separated values (CSV) are assumed.
1925 If not, lines are split at whitespace into fields. You can use a prefix
1926 argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
1927 C-u} forces TAB, and a numeric argument N indicates that at least N
1928 consecutive spaces, or alternatively a TAB will be the separator.
1930 If there is no active region, this command creates an empty Org
1931 table. But it's easier just to start typing, like
1932 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
1934 @tsubheading{Re-aligning and field motion}
1935 @orgcmd{C-c C-c,org-table-align}
1936 Re-align the table without moving the cursor.
1938 @orgcmd{<TAB>,org-table-next-field}
1939 Re-align the table, move to the next field. Creates a new row if
1942 @orgcmd{S-@key{TAB},org-table-previous-field}
1943 Re-align, move to previous field.
1945 @orgcmd{@key{RET},org-table-next-row}
1946 Re-align the table and move down to next row. Creates a new row if
1947 necessary. At the beginning or end of a line, @key{RET} still does
1948 NEWLINE, so it can be used to split a table.
1950 @orgcmd{M-a,org-table-beginning-of-field}
1951 Move to beginning of the current table field, or on to the previous field.
1952 @orgcmd{M-e,org-table-end-of-field}
1953 Move to end of the current table field, or on to the next field.
1955 @tsubheading{Column and row editing}
1956 @orgcmdkkcc{M-@key{left},M-@key{right},org-table-move-column-left,org-table-move-column-right}
1957 Move the current column left/right.
1959 @orgcmd{M-S-@key{left},org-table-delete-column}
1960 Kill the current column.
1962 @orgcmd{M-S-@key{right},org-table-insert-column}
1963 Insert a new column to the left of the cursor position.
1965 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-move-row-up,org-table-move-row-down}
1966 Move the current row up/down.
1968 @orgcmd{M-S-@key{up},org-table-kill-row}
1969 Kill the current row or horizontal line.
1971 @orgcmd{M-S-@key{down},org-table-insert-row}
1972 Insert a new row above the current row. With a prefix argument, the line is
1973 created below the current one.
1975 @orgcmd{C-c -,org-table-insert-hline}
1976 Insert a horizontal line below current row. With a prefix argument, the line
1977 is created above the current line.
1979 @orgcmd{C-c @key{RET},org-table-hline-and-move}
1980 Insert a horizontal line below current row, and move the cursor into the row
1983 @orgcmd{C-c ^,org-table-sort-lines}
1984 Sort the table lines in the region. The position of point indicates the
1985 column to be used for sorting, and the range of lines is the range
1986 between the nearest horizontal separator lines, or the entire table. If
1987 point is before the first column, you will be prompted for the sorting
1988 column. If there is an active region, the mark specifies the first line
1989 and the sorting column, while point should be in the last line to be
1990 included into the sorting. The command prompts for the sorting type
1991 (alphabetically, numerically, or by time). When called with a prefix
1992 argument, alphabetic sorting will be case-sensitive.
1994 @tsubheading{Regions}
1995 @orgcmd{C-c C-x M-w,org-table-copy-region}
1996 Copy a rectangular region from a table to a special clipboard. Point and
1997 mark determine edge fields of the rectangle. If there is no active region,
1998 copy just the current field. The process ignores horizontal separator lines.
2000 @orgcmd{C-c C-x C-w,org-table-cut-region}
2001 Copy a rectangular region from a table to a special clipboard, and
2002 blank all fields in the rectangle. So this is the ``cut'' operation.
2004 @orgcmd{C-c C-x C-y,org-table-paste-rectangle}
2005 Paste a rectangular region into a table.
2006 The upper left corner ends up in the current field. All involved fields
2007 will be overwritten. If the rectangle does not fit into the present table,
2008 the table is enlarged as needed. The process ignores horizontal separator
2011 @orgcmd{M-@key{RET},org-table-wrap-region}
2012 Split the current field at the cursor position and move the rest to the line
2013 below. If there is an active region, and both point and mark are in the same
2014 column, the text in the column is wrapped to minimum width for the given
2015 number of lines. A numeric prefix argument may be used to change the number
2016 of desired lines. If there is no region, but you specify a prefix argument,
2017 the current field is made blank, and the content is appended to the field
2020 @tsubheading{Calculations}
2021 @cindex formula, in tables
2022 @cindex calculations, in tables
2023 @cindex region, active
2024 @cindex active region
2025 @cindex transient mark mode
2026 @orgcmd{C-c +,org-table-sum}
2027 Sum the numbers in the current column, or in the rectangle defined by
2028 the active region. The result is shown in the echo area and can
2029 be inserted with @kbd{C-y}.
2031 @orgcmd{S-@key{RET},org-table-copy-down}
2032 @vindex org-table-copy-increment
2033 When current field is empty, copy from first non-empty field above. When not
2034 empty, copy current field down to next row and move cursor along with it.
2035 Depending on the variable @code{org-table-copy-increment}, integer field
2036 values will be incremented during copy. Integers that are too large will not
2037 be incremented. Also, a @code{0} prefix argument temporarily disables the
2038 increment. This key is also used by shift-selection and related modes
2039 (@pxref{Conflicts}).
2041 @tsubheading{Miscellaneous}
2042 @orgcmd{C-c `,org-table-edit-field}
2043 Edit the current field in a separate window. This is useful for fields that
2044 are not fully visible (@pxref{Column width and alignment}). When called with
2045 a @kbd{C-u} prefix, just make the full field visible, so that it can be
2048 @item M-x org-table-import
2049 Import a file as a table. The table should be TAB or whitespace
2050 separated. Use, for example, to import a spreadsheet table or data
2051 from a database, because these programs generally can write
2052 TAB-separated text files. This command works by inserting the file into
2053 the buffer and then converting the region to a table. Any prefix
2054 argument is passed on to the converter, which uses it to determine the
2056 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2057 Tables can also be imported by pasting tabular text into the Org
2058 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
2059 @kbd{C-c |} command (see above under @i{Creation and conversion}).
2061 @item M-x org-table-export
2062 @findex org-table-export
2063 @vindex org-table-export-default-format
2064 Export the table, by default as a TAB-separated file. Use for data
2065 exchange with, for example, spreadsheet or database programs. The format
2066 used to export the file can be configured in the variable
2067 @code{org-table-export-default-format}. You may also use properties
2068 @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
2069 name and the format for table export in a subtree. Org supports quite
2070 general formats for exported tables. The exporter format is the same as the
2071 format used by Orgtbl radio tables, see @ref{Translator functions}, for a
2072 detailed description.
2075 If you don't like the automatic table editor because it gets in your
2076 way on lines which you would like to start with @samp{|}, you can turn
2080 (setq org-enable-table-editor nil)
2083 @noindent Then the only table command that still works is
2084 @kbd{C-c C-c} to do a manual re-align.
2086 @node Column width and alignment, Column groups, Built-in table editor, Tables
2087 @section Column width and alignment
2088 @cindex narrow columns in tables
2089 @cindex alignment in tables
2091 The width of columns is automatically determined by the table editor. And
2092 also the alignment of a column is determined automatically from the fraction
2093 of number-like versus non-number fields in the column.
2095 Sometimes a single field or a few fields need to carry more text, leading to
2096 inconveniently wide columns. Or maybe you want to make a table with several
2097 columns having a fixed width, regardless of content. To set@footnote{This
2098 feature does not work on XEmacs.} the width of a column, one field anywhere
2099 in the column may contain just the string @samp{<N>} where @samp{N} is an
2100 integer specifying the width of the column in characters. The next re-align
2101 will then set the width of this column to this value.
2105 |---+------------------------------| |---+--------|
2107 | 1 | one | | 1 | one |
2108 | 2 | two | ----\ | 2 | two |
2109 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
2110 | 4 | four | | 4 | four |
2111 |---+------------------------------| |---+--------|
2116 Fields that are wider become clipped and end in the string @samp{=>}.
2117 Note that the full text is still in the buffer but is hidden.
2118 To see the full text, hold the mouse over the field---a tool-tip window
2119 will show the full content. To edit such a field, use the command
2120 @kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will
2121 open a new window with the full field. Edit it and finish with @kbd{C-c
2124 @vindex org-startup-align-all-tables
2125 When visiting a file containing a table with narrowed columns, the
2126 necessary character hiding has not yet happened, and the table needs to
2127 be aligned before it looks nice. Setting the option
2128 @code{org-startup-align-all-tables} will realign all tables in a file
2129 upon visiting, but also slow down startup. You can also set this option
2130 on a per-file basis with:
2137 If you would like to overrule the automatic alignment of number-rich columns
2138 to the right and of string-rich column to the left, you can use @samp{<r>},
2139 @samp{c}@footnote{Centering does not work inside Emacs, but it does have an
2140 effect when exporting to HTML.} or @samp{<l>} in a similar fashion. You may
2141 also combine alignment and field width like this: @samp{<l10>}.
2143 Lines which only contain these formatting cookies will be removed
2144 automatically when exporting the document.
2146 @node Column groups, Orgtbl mode, Column width and alignment, Tables
2147 @section Column groups
2148 @cindex grouping columns in tables
2150 When Org exports tables, it does so by default without vertical
2151 lines because that is visually more satisfying in general. Occasionally
2152 however, vertical lines can be useful to structure a table into groups
2153 of columns, much like horizontal lines can do for groups of rows. In
2154 order to specify column groups, you can use a special row where the
2155 first field contains only @samp{/}. The further fields can either
2156 contain @samp{<} to indicate that this column should start a group,
2157 @samp{>} to indicate the end of a column, or @samp{<>} to make a column
2158 a group of its own. Boundaries between column groups will upon export be
2159 marked with vertical lines. Here is an example:
2162 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2163 |---+-----+-----+-----+---------+------------|
2164 | / | < | | > | < | > |
2165 | 1 | 1 | 1 | 1 | 1 | 1 |
2166 | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
2167 | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
2168 |---+-----+-----+-----+---------+------------|
2169 #+TBLFM: $2=$1^2::$3=$1^3::$4=$1^4::$5=sqrt($1)::$6=sqrt(sqrt(($1)))
2172 It is also sufficient to just insert the column group starters after
2173 every vertical line you would like to have:
2176 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2177 |----+-----+-----+-----+---------+------------|
2181 @node Orgtbl mode, The spreadsheet, Column groups, Tables
2182 @section The Orgtbl minor mode
2184 @cindex minor mode for tables
2186 If you like the intuitive way the Org table editor works, you
2187 might also want to use it in other modes like Text mode or Mail mode.
2188 The minor mode Orgtbl mode makes this possible. You can always toggle
2189 the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for
2190 example in mail mode, use
2193 (add-hook 'mail-mode-hook 'turn-on-orgtbl)
2196 Furthermore, with some special setup, it is possible to maintain tables
2197 in arbitrary syntax with Orgtbl mode. For example, it is possible to
2198 construct @LaTeX{} tables with the underlying ease and power of
2199 Orgtbl mode, including spreadsheet capabilities. For details, see
2200 @ref{Tables in arbitrary syntax}.
2202 @node The spreadsheet, Org-Plot, Orgtbl mode, Tables
2203 @section The spreadsheet
2204 @cindex calculations, in tables
2205 @cindex spreadsheet capabilities
2206 @cindex @file{calc} package
2208 The table editor makes use of the Emacs @file{calc} package to implement
2209 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
2210 derive fields from other fields. While fully featured, Org's implementation
2211 is not identical to other spreadsheets. For example, Org knows the concept
2212 of a @emph{column formula} that will be applied to all non-header fields in a
2213 column without having to copy the formula to each relevant field. There is
2214 also a formula debugger, and a formula editor with features for highlighting
2215 fields in the table corresponding to the references at the point in the
2216 formula, moving these references by arrow keys
2219 * References:: How to refer to another field or range
2220 * Formula syntax for Calc:: Using Calc to compute stuff
2221 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
2222 * Field formulas:: Formulas valid for a single field
2223 * Column formulas:: Formulas valid for an entire column
2224 * Editing and debugging formulas:: Fixing formulas
2225 * Updating the table:: Recomputing all dependent fields
2226 * Advanced features:: Field names, parameters and automatic recalc
2229 @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet
2230 @subsection References
2233 To compute fields in the table from other fields, formulas must
2234 reference other fields or ranges. In Org, fields can be referenced
2235 by name, by absolute coordinates, and by relative coordinates. To find
2236 out what the coordinates of a field are, press @kbd{C-c ?} in that
2237 field, or press @kbd{C-c @}} to toggle the display of a grid.
2239 @subsubheading Field references
2240 @cindex field references
2241 @cindex references, to fields
2243 Formulas can reference the value of another field in two ways. Like in
2244 any other spreadsheet, you may reference fields with a letter/number
2245 combination like @code{B3}, meaning the 2nd field in the 3rd row.
2246 @c Such references are always fixed to that field, they don't change
2247 @c when you copy and paste a formula to a different field. So
2248 @c Org's @code{B3} behaves like @code{$B$3} in other spreadsheets.
2251 Org also uses another, more general operator that looks like this:
2253 @@@var{row}$@var{column}
2257 Column references can be absolute like @samp{1}, @samp{2},...@samp{@var{N}},
2258 or relative to the current column like @samp{+1} or @samp{-2}.
2260 The row specification only counts data lines and ignores horizontal
2261 separator lines (hlines). You can use absolute row numbers
2262 @samp{1}...@samp{@var{N}}, and row numbers relative to the current row like
2263 @samp{+3} or @samp{-1}. Or specify the row relative to one of the
2264 hlines: @samp{I} refers to the first hline@footnote{Note that only
2265 hlines are counted that @emph{separate} table lines. If the table
2266 starts with a hline above the header, it does not count.}, @samp{II} to
2267 the second, etc@. @samp{-I} refers to the first such line above the
2268 current line, @samp{+I} to the first such line below the current line.
2269 You can also write @samp{III+2} which is the second data line after the
2270 third hline in the table.
2272 @samp{0} refers to the current row and column. Also, if you omit
2273 either the column or the row part of the reference, the current
2274 row/column is implied.
2276 Org's references with @emph{unsigned} numbers are fixed references
2277 in the sense that if you use the same reference in the formula for two
2278 different fields, the same field will be referenced each time.
2279 Org's references with @emph{signed} numbers are floating
2280 references because the same reference operator can reference different
2281 fields depending on the field being calculated by the formula.
2283 As a special case, references like @samp{$LR5} and @samp{$LR12} can be used
2284 to refer in a stable way to the 5th and 12th field in the last row of the
2287 Here are a few examples:
2290 @@2$3 @r{2nd row, 3rd column}
2291 C2 @r{same as previous}
2292 $5 @r{column 5 in the current row}
2293 E& @r{same as previous}
2294 @@2 @r{current column, row 2}
2295 @@-1$-3 @r{the field one row up, three columns to the left}
2296 @@-I$2 @r{field just under hline above current row, column 2}
2299 @subsubheading Range references
2300 @cindex range references
2301 @cindex references, to ranges
2303 You may reference a rectangular range of fields by specifying two field
2304 references connected by two dots @samp{..}. If both fields are in the
2305 current row, you may simply use @samp{$2..$7}, but if at least one field
2306 is in a different row, you need to use the general @code{@@row$column}
2307 format at least for the first field (i.e the reference must start with
2308 @samp{@@} in order to be interpreted correctly). Examples:
2311 $1..$3 @r{First three fields in the current row.}
2312 $P..$Q @r{Range, using column names (see under Advanced)}
2313 @@2$1..@@4$3 @r{6 fields between these two fields.}
2314 A2..C4 @r{Same as above.}
2315 @@-1$-2..@@-1 @r{3 numbers from the column to the left, 2 up to current row}
2318 @noindent Range references return a vector of values that can be fed
2319 into Calc vector functions. Empty fields in ranges are normally
2320 suppressed, so that the vector contains only the non-empty fields (but
2321 see the @samp{E} mode switch below). If there are no non-empty fields,
2322 @samp{[0]} is returned to avoid syntax errors in formulas.
2324 @subsubheading Field coordinates in formulas
2325 @cindex field coordinates
2326 @cindex coordinates, of field
2327 @cindex row, of field coordinates
2328 @cindex column, of field coordinates
2330 For Calc formulas and Lisp formulas @code{@@#} and @code{$#} can be used to
2331 get the row or column number of the field where the formula result goes.
2332 The traditional Lisp formula equivalents are @code{org-table-current-dline}
2333 and @code{org-table-current-column}. Examples:
2336 if(@@# % 2, $#, string("")) @r{column number on odd lines only}
2337 $3 = remote(FOO, @@@@#$2) @r{copy column 2 from table FOO into}
2338 @r{column 3 of the current table}
2341 @noindent For the second example, table FOO must have at least as many rows
2342 as the current table. Inefficient@footnote{The computation time scales as
2343 O(N^2) because table FOO is parsed for each field to be copied.} for large
2346 @subsubheading Named references
2347 @cindex named references
2348 @cindex references, named
2349 @cindex name, of column or field
2350 @cindex constants, in calculations
2353 @vindex org-table-formula-constants
2354 @samp{$name} is interpreted as the name of a column, parameter or
2355 constant. Constants are defined globally through the variable
2356 @code{org-table-formula-constants}, and locally (for the file) through a
2360 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
2364 @vindex constants-unit-system
2365 @pindex constants.el
2366 Also properties (@pxref{Properties and Columns}) can be used as
2367 constants in table formulas: for a property @samp{:Xyz:} use the name
2368 @samp{$PROP_Xyz}, and the property will be searched in the current
2369 outline entry and in the hierarchy above it. If you have the
2370 @file{constants.el} package, it will also be used to resolve constants,
2371 including natural constants like @samp{$h} for Planck's constant, and
2372 units like @samp{$km} for kilometers@footnote{@file{constants.el} can
2373 supply the values of constants in two different unit systems, @code{SI}
2374 and @code{cgs}. Which one is used depends on the value of the variable
2375 @code{constants-unit-system}. You can use the @code{#+STARTUP} options
2376 @code{constSI} and @code{constcgs} to set this value for the current
2377 buffer.}. Column names and parameters can be specified in special table
2378 lines. These are described below, see @ref{Advanced features}. All
2379 names must start with a letter, and further consist of letters and
2382 @subsubheading Remote references
2383 @cindex remote references
2384 @cindex references, remote
2385 @cindex references, to a different table
2386 @cindex name, of column or field
2387 @cindex constants, in calculations
2390 You may also reference constants, fields and ranges from a different table,
2391 either in the current file or even in a different file. The syntax is
2394 remote(NAME-OR-ID,REF)
2398 where NAME can be the name of a table in the current file as set by a
2399 @code{#+TBLNAME: NAME} line before the table. It can also be the ID of an
2400 entry, even in a different file, and the reference then refers to the first
2401 table in that entry. REF is an absolute field or range reference as
2402 described above for example @code{@@3$3} or @code{$somename}, valid in the
2405 @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet
2406 @subsection Formula syntax for Calc
2407 @cindex formula syntax, Calc
2408 @cindex syntax, of formulas
2410 A formula can be any algebraic expression understood by the Emacs
2411 @file{Calc} package. @b{Note that @file{calc} has the
2412 non-standard convention that @samp{/} has lower precedence than
2413 @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.} Before
2414 evaluation by @code{calc-eval} (@pxref{Calling Calc from
2415 Your Programs,calc-eval,Calling Calc from Your Lisp Programs,Calc,GNU
2416 Emacs Calc Manual}),
2417 @c FIXME: The link to the Calc manual in HTML does not work.
2418 variable substitution takes place according to the rules described above.
2419 @cindex vectors, in table calculations
2420 The range vectors can be directly fed into the Calc vector functions
2421 like @samp{vmean} and @samp{vsum}.
2423 @cindex format specifier
2424 @cindex mode, for @file{calc}
2425 @vindex org-calc-default-modes
2426 A formula can contain an optional mode string after a semicolon. This
2427 string consists of flags to influence Calc and other modes during
2428 execution. By default, Org uses the standard Calc modes (precision
2429 12, angular units degrees, fraction and symbolic modes off). The display
2430 format, however, has been changed to @code{(float 8)} to keep tables
2431 compact. The default settings can be configured using the variable
2432 @code{org-calc-default-modes}.
2435 p20 @r{set the internal Calc calculation precision to 20 digits}
2436 n3 s3 e2 f4 @r{Normal, scientific, engineering, or fixed}
2437 @r{format of the result of Calc passed back to Org.}
2438 @r{Calc formatting is unlimited in precision as}
2439 @r{long as the Calc calculation precision is greater.}
2440 D R @r{angle modes: degrees, radians}
2441 F S @r{fraction and symbolic modes}
2442 N @r{interpret all fields as numbers, use 0 for non-numbers}
2443 T @r{force text interpretation}
2444 E @r{keep empty fields in ranges}
2449 Unless you use large integer numbers or high-precision-calculation
2450 and -display for floating point numbers you may alternatively provide a
2451 @code{printf} format specifier to reformat the Calc result after it has been
2452 passed back to Org instead of letting Calc already do the
2453 formatting@footnote{The @code{printf} reformatting is limited in precision
2454 because the value passed to it is converted into an @code{integer} or
2455 @code{double}. The @code{integer} is limited in size by truncating the
2456 signed value to 32 bits. The @code{double} is limited in precision to 64
2457 bits overall which leaves approximately 16 significant decimal digits.}.
2461 $1+$2 @r{Sum of first and second field}
2462 $1+$2;%.2f @r{Same, format result to two decimals}
2463 exp($2)+exp($1) @r{Math functions can be used}
2464 $0;%.1f @r{Reformat current cell to 1 decimal}
2465 ($3-32)*5/9 @r{Degrees F -> C conversion}
2466 $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}}
2467 tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1}
2468 sin($1);Dp3%.1e @r{Same, but use printf specifier for display}
2469 vmean($2..$7) @r{Compute column range mean, using vector function}
2470 vmean($2..$7);EN @r{Same, but treat empty fields as 0}
2471 taylor($3,x=7,2) @r{Taylor series of $3, at x=7, second degree}
2474 Calc also contains a complete set of logical operations. For example
2477 if($1<20,teen,string("")) @r{``teen'' if age $1 less than 20, else empty}
2480 @node Formula syntax for Lisp, Field formulas, Formula syntax for Calc, The spreadsheet
2481 @subsection Emacs Lisp forms as formulas
2482 @cindex Lisp forms, as table formulas
2484 It is also possible to write a formula in Emacs Lisp; this can be useful for
2485 string manipulation and control structures, if Calc's functionality is not
2486 enough. If a formula starts with a single-quote followed by an opening
2487 parenthesis, then it is evaluated as a Lisp form. The evaluation should
2488 return either a string or a number. Just as with @file{calc} formulas, you
2489 can specify modes and a printf format after a semicolon. With Emacs Lisp
2490 forms, you need to be conscious about the way field references are
2491 interpolated into the form. By default, a reference will be interpolated as
2492 a Lisp string (in double-quotes) containing the field. If you provide the
2493 @samp{N} mode switch, all referenced elements will be numbers (non-number
2494 fields will be zero) and interpolated as Lisp numbers, without quotes. If
2495 you provide the @samp{L} flag, all fields will be interpolated literally,
2496 without quotes. I.e., if you want a reference to be interpreted as a string
2497 by the Lisp form, enclose the reference operator itself in double-quotes,
2498 like @code{"$3"}. Ranges are inserted as space-separated fields, so you can
2499 +embed them in list or vector syntax. Here are a few examples---note how the
2500 @samp{N} mode is used when we do computations in Lisp:
2503 @r{Swap the first two characters of the content of column 1}
2504 '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
2505 @r{Add columns 1 and 2, equivalent to Calc's @code{$1+$2}}
2507 @r{Compute the sum of columns 1-4, like Calc's @code{vsum($1..$4)}}
2508 '(apply '+ '($1..$4));N
2511 @node Field formulas, Column formulas, Formula syntax for Lisp, The spreadsheet
2512 @subsection Field formulas
2513 @cindex field formula
2514 @cindex formula, for individual table field
2516 To assign a formula to a particular field, type it directly into the
2517 field, preceded by @samp{:=}, for example @samp{:=$1+$2}. When you
2518 press @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in
2519 the field, the formula will be stored as the formula for this field,
2520 evaluated, and the current field replaced with the result.
2523 Formulas are stored in a special line starting with @samp{#+TBLFM:}
2524 directly below the table. If you type the equation in the 4th field of
2525 the 3rd data line in the table, the formula will look like
2526 @samp{@@3$4=$1+$2}. When inserting/deleting/swapping column and rows
2527 with the appropriate commands, @i{absolute references} (but not relative
2528 ones) in stored formulas are modified in order to still reference the
2529 same field. Of course this is not true if you edit the table structure
2530 with normal editing commands---then you must fix the equations yourself.
2531 The left-hand side of a formula may also be a named field (@pxref{Advanced
2532 features}), or a last-row reference like @samp{$LR3}.
2534 Instead of typing an equation into the field, you may also use the
2538 @orgcmd{C-u C-c =,org-table-eval-formula}
2539 Install a new formula for the current field. The command prompts for a
2540 formula with default taken from the @samp{#+TBLFM:} line, applies
2541 it to the current field, and stores it.
2544 @node Column formulas, Editing and debugging formulas, Field formulas, The spreadsheet
2545 @subsection Column formulas
2546 @cindex column formula
2547 @cindex formula, for table column
2549 Often in a table, the same formula should be used for all fields in a
2550 particular column. Instead of having to copy the formula to all fields
2551 in that column, Org allows you to assign a single formula to an entire
2552 column. If the table contains horizontal separator hlines, everything
2553 before the first such line is considered part of the table @emph{header}
2554 and will not be modified by column formulas.
2556 To assign a formula to a column, type it directly into any field in the
2557 column, preceded by an equal sign, like @samp{=$1+$2}. When you press
2558 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2559 the formula will be stored as the formula for the current column, evaluated
2560 and the current field replaced with the result. If the field contains only
2561 @samp{=}, the previously stored formula for this column is used. For each
2562 column, Org will only remember the most recently used formula. In the
2563 @samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}. The left-hand
2564 side of a column formula cannot currently be the name of column, it
2565 must be the numeric column reference.
2567 Instead of typing an equation into the field, you may also use the
2571 @orgcmd{C-c =,org-table-eval-formula}
2572 Install a new formula for the current column and replace current field with
2573 the result of the formula. The command prompts for a formula, with default
2574 taken from the @samp{#+TBLFM} line, applies it to the current field and
2575 stores it. With a numeric prefix argument(e.g. @kbd{C-5 C-c =}) the command
2576 will apply it to that many consecutive fields in the current column.
2579 @node Editing and debugging formulas, Updating the table, Column formulas, The spreadsheet
2580 @subsection Editing and debugging formulas
2581 @cindex formula editing
2582 @cindex editing, of table formulas
2584 @vindex org-table-use-standard-references
2585 You can edit individual formulas in the minibuffer or directly in the
2586 field. Org can also prepare a special buffer with all active
2587 formulas of a table. When offering a formula for editing, Org
2588 converts references to the standard format (like @code{B3} or @code{D&})
2589 if possible. If you prefer to only work with the internal format (like
2590 @code{@@3$2} or @code{$4}), configure the variable
2591 @code{org-table-use-standard-references}.
2594 @orgcmdkkc{C-c =,C-u C-c =,org-table-eval-formula}
2595 Edit the formula associated with the current column/field in the
2596 minibuffer. See @ref{Column formulas}, and @ref{Field formulas}.
2597 @orgcmd{C-u C-u C-c =,org-table-eval-formula}
2598 Re-insert the active formula (either a
2599 field formula, or a column formula) into the current field, so that you
2600 can edit it directly in the field. The advantage over editing in the
2601 minibuffer is that you can use the command @kbd{C-c ?}.
2602 @orgcmd{C-c ?,org-table-field-info}
2603 While editing a formula in a table field, highlight the field(s)
2604 referenced by the reference at the cursor position in the formula.
2606 @findex org-table-toggle-coordinate-overlays
2608 Toggle the display of row and column numbers for a table, using overlays
2609 (@command{org-table-toggle-coordinate-overlays}). These are updated each
2610 time the table is aligned; you can force it with @kbd{C-c C-c}.
2612 @findex org-table-toggle-formula-debugger
2614 Toggle the formula debugger on and off
2615 (@command{org-table-toggle-formula-debugger}). See below.
2616 @orgcmd{C-c ',org-table-edit-formulas}
2617 Edit all formulas for the current table in a special buffer, where the
2618 formulas will be displayed one per line. If the current field has an
2619 active formula, the cursor in the formula editor will mark it.
2620 While inside the special buffer, Org will automatically highlight
2621 any field or range reference at the cursor position. You may edit,
2622 remove and add formulas, and use the following commands:
2624 @orgcmdkkc{C-c C-c,C-x C-s,org-table-fedit-finish}
2625 Exit the formula editor and store the modified formulas. With @kbd{C-u}
2626 prefix, also apply the new formulas to the entire table.
2627 @orgcmd{C-c C-q,org-table-fedit-abort}
2628 Exit the formula editor without installing changes.
2629 @orgcmd{C-c C-r,org-table-fedit-toggle-ref-type}
2630 Toggle all references in the formula editor between standard (like
2631 @code{B3}) and internal (like @code{@@3$2}).
2632 @orgcmd{@key{TAB},org-table-fedit-lisp-indent}
2633 Pretty-print or indent Lisp formula at point. When in a line containing
2634 a Lisp formula, format the formula according to Emacs Lisp rules.
2635 Another @key{TAB} collapses the formula back again. In the open
2636 formula, @key{TAB} re-indents just like in Emacs Lisp mode.
2637 @orgcmd{M-@key{TAB},lisp-complete-symbol}
2638 Complete Lisp symbols, just like in Emacs Lisp mode.
2640 @kindex S-@key{down}
2641 @kindex S-@key{left}
2642 @kindex S-@key{right}
2643 @findex org-table-fedit-ref-up
2644 @findex org-table-fedit-ref-down
2645 @findex org-table-fedit-ref-left
2646 @findex org-table-fedit-ref-right
2647 @item S-@key{up}/@key{down}/@key{left}/@key{right}
2648 Shift the reference at point. For example, if the reference is
2649 @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
2650 This also works for relative references and for hline references.
2651 @orgcmdkkcc{M-S-@key{up},M-S-@key{down},org-table-fedit-line-up,org-table-fedit-line-down}
2652 Move the test line for column formulas in the Org buffer up and
2654 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-fedit-scroll-down,org-table-fedit-scroll-up}
2655 Scroll the window displaying the table.
2657 @findex org-table-toggle-coordinate-overlays
2659 Turn the coordinate grid in the table on and off.
2663 Making a table field blank does not remove the formula associated with
2664 the field, because that is stored in a different line (the @samp{#+TBLFM}
2665 line)---during the next recalculation the field will be filled again.
2666 To remove a formula from a field, you have to give an empty reply when
2667 prompted for the formula, or to edit the @samp{#+TBLFM} line.
2670 You may edit the @samp{#+TBLFM} directly and re-apply the changed
2671 equations with @kbd{C-c C-c} in that line or with the normal
2672 recalculation commands in the table.
2674 @subsubheading Debugging formulas
2675 @cindex formula debugging
2676 @cindex debugging, of table formulas
2677 When the evaluation of a formula leads to an error, the field content
2678 becomes the string @samp{#ERROR}. If you would like see what is going
2679 on during variable substitution and calculation in order to find a bug,
2680 turn on formula debugging in the @code{Tbl} menu and repeat the
2681 calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
2682 field. Detailed information will be displayed.
2684 @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet
2685 @subsection Updating the table
2686 @cindex recomputing table fields
2687 @cindex updating, table
2689 Recalculation of a table is normally not automatic, but needs to be
2690 triggered by a command. See @ref{Advanced features}, for a way to make
2691 recalculation at least semi-automatic.
2693 In order to recalculate a line of a table or the entire table, use the
2697 @orgcmd{C-c *,org-table-recalculate}
2698 Recalculate the current row by first applying the stored column formulas
2699 from left to right, and all field formulas in the current row.
2705 Recompute the entire table, line by line. Any lines before the first
2706 hline are left alone, assuming that these are part of the table header.
2708 @orgcmdkkc{C-u C-u C-c *,C-u C-u C-c C-c,org-table-iterate}
2709 Iterate the table by recomputing it until no further changes occur.
2710 This may be necessary if some computed fields use the value of other
2711 fields that are computed @i{later} in the calculation sequence.
2712 @item M-x org-table-recalculate-buffer-tables
2713 @findex org-table-recalculate-buffer-tables
2714 Recompute all tables in the current buffer.
2715 @item M-x org-table-iterate-buffer-tables
2716 @findex org-table-iterate-buffer-tables
2717 Iterate all tables in the current buffer, in order to converge table-to-table
2721 @node Advanced features, , Updating the table, The spreadsheet
2722 @subsection Advanced features
2724 If you want the recalculation of fields to happen automatically, or if
2725 you want to be able to assign @i{names} to fields and columns, you need
2726 to reserve the first column of the table for special marking characters.
2728 @orgcmd{C-#,org-table-rotate-recalc-marks}
2729 Rotate the calculation mark in first column through the states @samp{ },
2730 @samp{#}, @samp{*}, @samp{!}, @samp{$}. When there is an active region,
2731 change all marks in the region.
2734 Here is an example of a table that collects exam results of students and
2735 makes use of these features:
2739 |---+---------+--------+--------+--------+-------+------|
2740 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
2741 |---+---------+--------+--------+--------+-------+------|
2742 | ! | | P1 | P2 | P3 | Tot | |
2743 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
2744 | ^ | | m1 | m2 | m3 | mt | |
2745 |---+---------+--------+--------+--------+-------+------|
2746 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
2747 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
2748 |---+---------+--------+--------+--------+-------+------|
2749 | | Average | | | | 29.7 | |
2750 | ^ | | | | | at | |
2751 | $ | max=50 | | | | | |
2752 |---+---------+--------+--------+--------+-------+------|
2753 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
2757 @noindent @b{Important}: please note that for these special tables,
2758 recalculating the table with @kbd{C-u C-c *} will only affect rows that
2759 are marked @samp{#} or @samp{*}, and fields that have a formula assigned
2760 to the field itself. The column formulas are not applied in rows with
2763 @cindex marking characters, tables
2764 The marking characters have the following meaning:
2767 The fields in this line define names for the columns, so that you may
2768 refer to a column as @samp{$Tot} instead of @samp{$6}.
2770 This row defines names for the fields @emph{above} the row. With such
2771 a definition, any formula in the table may use @samp{$m1} to refer to
2772 the value @samp{10}. Also, if you assign a formula to a names field, it
2773 will be stored as @samp{$name=...}.
2775 Similar to @samp{^}, but defines names for the fields in the row
2778 Fields in this row can define @emph{parameters} for formulas. For
2779 example, if a field in a @samp{$} row contains @samp{max=50}, then
2780 formulas in this table can refer to the value 50 using @samp{$max}.
2781 Parameters work exactly like constants, only that they can be defined on
2784 Fields in this row are automatically recalculated when pressing
2785 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row
2786 is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked
2787 lines will be left alone by this command.
2789 Selects this line for global recalculation with @kbd{C-u C-c *}, but
2790 not for automatic recalculation. Use this when automatic
2791 recalculation slows down editing too much.
2793 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
2794 All lines that should be recalculated should be marked with @samp{#}
2797 Do not export this line. Useful for lines that contain the narrowing
2798 @samp{<N>} markers or column group markers.
2801 Finally, just to whet your appetite for what can be done with the
2802 fantastic @file{calc.el} package, here is a table that computes the Taylor
2803 series of degree @code{n} at location @code{x} for a couple of
2808 |---+-------------+---+-----+--------------------------------------|
2809 | | Func | n | x | Result |
2810 |---+-------------+---+-----+--------------------------------------|
2811 | # | exp(x) | 1 | x | 1 + x |
2812 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
2813 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
2814 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
2815 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
2816 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
2817 |---+-------------+---+-----+--------------------------------------|
2818 #+TBLFM: $5=taylor($2,$4,$3);n3
2822 @node Org-Plot, , The spreadsheet, Tables
2824 @cindex graph, in tables
2825 @cindex plot tables using Gnuplot
2828 Org-Plot can produce 2D and 3D graphs of information stored in org tables
2829 using @file{Gnuplot} @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
2830 @uref{http://cars9.uchicago.edu/~ravel/software/gnuplot-mode.html}. To see
2831 this in action, ensure that you have both Gnuplot and Gnuplot mode installed
2832 on your system, then call @code{org-plot/gnuplot} on the following table.
2836 #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
2837 | Sede | Max cites | H-index |
2838 |-----------+-----------+---------|
2839 | Chile | 257.72 | 21.39 |
2840 | Leeds | 165.77 | 19.68 |
2841 | Sao Paolo | 71.00 | 11.50 |
2842 | Stockholm | 134.19 | 14.33 |
2843 | Morelia | 257.56 | 17.67 |
2847 Notice that Org Plot is smart enough to apply the table's headers as labels.
2848 Further control over the labels, type, content, and appearance of plots can
2849 be exercised through the @code{#+PLOT:} lines preceding a table. See below
2850 for a complete list of Org-plot options. For more information and examples
2851 see the Org-plot tutorial at
2852 @uref{http://orgmode.org/worg/org-tutorials/org-plot.php}.
2854 @subsubheading Plot Options
2858 Specify any @command{gnuplot} option to be set when graphing.
2861 Specify the title of the plot.
2864 Specify which column of the table to use as the @code{x} axis.
2867 Specify the columns to graph as a Lisp style list, surrounded by parentheses
2868 and separated by spaces for example @code{dep:(3 4)} to graph the third and
2869 fourth columns (defaults to graphing all other columns aside from the @code{ind}
2873 Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
2876 Specify a @code{with} option to be inserted for every col being plotted
2877 (e.g. @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
2878 Defaults to @code{lines}.
2881 If you want to plot to a file, specify @code{"@var{path/to/desired/output-file}"}.
2884 List of labels to be used for the @code{deps} (defaults to the column headers
2888 Specify an entire line to be inserted in the Gnuplot script.
2891 When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
2892 flat mapping rather than a @code{3d} slope.
2895 Specify format of Org-mode timestamps as they will be parsed by Gnuplot.
2896 Defaults to @samp{%Y-%m-%d-%H:%M:%S}.
2899 If you want total control, you can specify a script file (place the file name
2900 between double-quotes) which will be used to plot. Before plotting, every
2901 instance of @code{$datafile} in the specified script will be replaced with
2902 the path to the generated data file. Note: even if you set this option, you
2903 may still want to specify the plot type, as that can impact the content of
2907 @node Hyperlinks, TODO Items, Tables, Top
2911 Like HTML, Org provides links inside a file, external links to
2912 other files, Usenet articles, emails, and much more.
2915 * Link format:: How links in Org are formatted
2916 * Internal links:: Links to other places in the current file
2917 * External links:: URL-like links to the world
2918 * Handling links:: Creating, inserting and following
2919 * Using links outside Org:: Linking from my C source code?
2920 * Link abbreviations:: Shortcuts for writing complex links
2921 * Search options:: Linking to a specific location
2922 * Custom searches:: When the default search is not enough
2925 @node Link format, Internal links, Hyperlinks, Hyperlinks
2926 @section Link format
2928 @cindex format, of links
2930 Org will recognize plain URL-like links and activate them as
2931 clickable links. The general link format, however, looks like this:
2934 [[link][description]] @r{or alternatively} [[link]]
2938 Once a link in the buffer is complete (all brackets present), Org
2939 will change the display so that @samp{description} is displayed instead
2940 of @samp{[[link][description]]} and @samp{link} is displayed instead of
2941 @samp{[[link]]}. Links will be highlighted in the face @code{org-link},
2942 which by default is an underlined face. You can directly edit the
2943 visible part of a link. Note that this can be either the @samp{link}
2944 part (if there is no description) or the @samp{description} part. To
2945 edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
2948 If you place the cursor at the beginning or just behind the end of the
2949 displayed text and press @key{BACKSPACE}, you will remove the
2950 (invisible) bracket at that location. This makes the link incomplete
2951 and the internals are again displayed as plain text. Inserting the
2952 missing bracket hides the link internals again. To show the
2953 internal structure of all links, use the menu entry
2954 @code{Org->Hyperlinks->Literal links}.
2956 @node Internal links, External links, Link format, Hyperlinks
2957 @section Internal links
2958 @cindex internal links
2959 @cindex links, internal
2960 @cindex targets, for links
2962 @cindex property, CUSTOM_ID
2963 If the link does not look like a URL, it is considered to be internal in the
2964 current file. The most important case is a link like
2965 @samp{[[#my-custom-id]]} which will link to the entry with the
2966 @code{CUSTOM_ID} property @samp{my-custom-id}. Such custom IDs are very good
2967 for HTML export (@pxref{HTML export}) where they produce pretty section
2968 links. You are responsible yourself to make sure these custom IDs are unique
2971 Links such as @samp{[[My Target]]} or @samp{[[My Target][Find my target]]}
2972 lead to a text search in the current file.
2974 The link can be followed with @kbd{C-c C-o} when the cursor is on the link,
2975 or with a mouse click (@pxref{Handling links}). Links to custom IDs will
2976 point to the corresponding headline. The preferred match for a text link is
2977 a @i{dedicated target}: the same string in double angular brackets. Targets
2978 may be located anywhere; sometimes it is convenient to put them into a
2979 comment line. For example
2985 @noindent In HTML export (@pxref{HTML export}), such targets will become
2986 named anchors for direct access through @samp{http} links@footnote{Note that
2987 text before the first headline is usually not exported, so the first such
2988 target should be after the first headline, or in the line directly before the
2991 If no dedicated target exists, Org will search for a headline that is exactly
2992 the link text but may also include a TODO keyword and tags@footnote{To insert
2993 a link targeting a headline, in-buffer completion can be used. Just type a
2994 star followed by a few optional letters into the buffer and press
2995 @kbd{M-@key{TAB}}. All headlines in the current buffer will be offered as
2996 completions.}. In non-Org files, the search will look for the words in the
2997 link text. In the above example the search would be for @samp{my target}.
2999 Following a link pushes a mark onto Org's own mark ring. You can
3000 return to the previous position with @kbd{C-c &}. Using this command
3001 several times in direct succession goes back to positions recorded
3005 * Radio targets:: Make targets trigger links in plain text
3008 @node Radio targets, , Internal links, Internal links
3009 @subsection Radio targets
3010 @cindex radio targets
3011 @cindex targets, radio
3012 @cindex links, radio targets
3014 Org can automatically turn any occurrences of certain target names
3015 in normal text into a link. So without explicitly creating a link, the
3016 text connects to the target radioing its position. Radio targets are
3017 enclosed by triple angular brackets. For example, a target @samp{<<<My
3018 Target>>>} causes each occurrence of @samp{my target} in normal text to
3019 become activated as a link. The Org file is scanned automatically
3020 for radio targets only when the file is first loaded into Emacs. To
3021 update the target list during editing, press @kbd{C-c C-c} with the
3022 cursor on or at a target.
3024 @node External links, Handling links, Internal links, Hyperlinks
3025 @section External links
3026 @cindex links, external
3027 @cindex external links
3028 @cindex links, external
3036 @cindex WANDERLUST links
3038 @cindex USENET links
3043 Org supports links to files, websites, Usenet and email messages,
3044 BBDB database entries and links to both IRC conversations and their
3045 logs. External links are URL-like locators. They start with a short
3046 identifying string followed by a colon. There can be no space after
3047 the colon. The following list shows examples for each link type.
3050 http://www.astro.uva.nl/~dominik @r{on the web}
3051 doi:10.1000/182 @r{DOI for an electronic resource}
3052 file:/home/dominik/images/jupiter.jpg @r{file, absolute path}
3053 /home/dominik/images/jupiter.jpg @r{same as above}
3054 file:papers/last.pdf @r{file, relative path}
3055 ./papers/last.pdf @r{same as above}
3056 file:/myself@@some.where:papers/last.pdf @r{file, path on remote machine}
3057 /myself@@some.where:papers/last.pdf @r{same as above}
3058 file:sometextfile::NNN @r{file with line number to jump to}
3059 file:projects.org @r{another Org file}
3060 file:projects.org::some words @r{text search in Org file}
3061 file:projects.org::*task title @r{heading search in Org file}
3062 docview:papers/last.pdf::NNN @r{open file in doc-view mode at page NNN}
3063 id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID}
3064 news:comp.emacs @r{Usenet link}
3065 mailto:adent@@galaxy.net @r{Mail link}
3066 vm:folder @r{VM folder link}
3067 vm:folder#id @r{VM message link}
3068 vm://myself@@some.where.org/folder#id @r{VM on remote machine}
3069 wl:folder @r{WANDERLUST folder link}
3070 wl:folder#id @r{WANDERLUST message link}
3071 mhe:folder @r{MH-E folder link}
3072 mhe:folder#id @r{MH-E message link}
3073 rmail:folder @r{RMAIL folder link}
3074 rmail:folder#id @r{RMAIL message link}
3075 gnus:group @r{Gnus group link}
3076 gnus:group#id @r{Gnus article link}
3077 bbdb:R.*Stallman @r{BBDB link (with regexp)}
3078 irc:/irc.com/#emacs/bob @r{IRC link}
3079 info:org:External%20links @r{Info node link (with encoded space)}
3080 shell:ls *.org @r{A shell command}
3081 elisp:org-agenda @r{Interactive Elisp command}
3082 elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
3085 A link should be enclosed in double brackets and may contain a
3086 descriptive text to be displayed instead of the URL (@pxref{Link
3087 format}), for example:
3090 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
3094 If the description is a file name or URL that points to an image, HTML
3095 export (@pxref{HTML export}) will inline the image as a clickable
3096 button. If there is no description at all and the link points to an
3098 that image will be inlined into the exported HTML file.
3100 @cindex square brackets, around links
3101 @cindex plain text external links
3102 Org also finds external links in the normal text and activates them
3103 as links. If spaces must be part of the link (for example in
3104 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
3105 about the end of the link, enclose them in square brackets.
3107 @node Handling links, Using links outside Org, External links, Hyperlinks
3108 @section Handling links
3109 @cindex links, handling
3111 Org provides methods to create a link in the correct syntax, to
3112 insert it into an Org file, and to follow the link.
3115 @orgcmd{C-c l,org-store-link}
3116 @cindex storing links
3117 Store a link to the current location. This is a @emph{global} command (you
3118 must create the key binding yourself) which can be used in any buffer to
3119 create a link. The link will be stored for later insertion into an Org
3120 buffer (see below). What kind of link will be created depends on the current
3123 @b{Org-mode buffers}@*
3124 For Org files, if there is a @samp{<<target>>} at the cursor, the link points
3125 to the target. Otherwise it points to the current headline, which will also
3128 @vindex org-link-to-org-use-id
3129 @cindex property, CUSTOM_ID
3130 @cindex property, ID
3131 If the headline has a @code{CUSTOM_ID} property, a link to this custom ID
3132 will be stored. In addition or alternatively (depending on the value of
3133 @code{org-link-to-org-use-id}), a globally unique @code{ID} property will be
3134 created and/or used to construct a link. So using this command in Org
3135 buffers will potentially create two links: a human-readable from the custom
3136 ID, and one that is globally unique and works even if the entry is moved from
3137 file to file. Later, when inserting the link, you need to decide which one
3140 @b{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus}@*
3141 Pretty much all Emacs mail clients are supported. The link will point to the
3142 current article, or, in some GNUS buffers, to the group. The description is
3143 constructed from the author and the subject.
3145 @b{Web browsers: W3 and W3M}@*
3146 Here the link will be the current URL, with the page title as description.
3148 @b{Contacts: BBDB}@*
3149 Links created in a BBDB buffer will point to the current entry.
3152 @vindex org-irc-link-to-logs
3153 For IRC links, if you set the variable @code{org-irc-link-to-logs} to
3154 @code{t}, a @samp{file:/} style link to the relevant point in the logs for
3155 the current conversation is created. Otherwise an @samp{irc:/} style link to
3156 the user/channel/server under the point will be stored.
3159 For any other files, the link will point to the file, with a search string
3160 (@pxref{Search options}) pointing to the contents of the current line. If
3161 there is an active region, the selected words will form the basis of the
3162 search string. If the automatically created link is not working correctly or
3163 accurately enough, you can write custom functions to select the search string
3164 and to do the search for particular file types---see @ref{Custom searches}.
3165 The key binding @kbd{C-c l} is only a suggestion---see @ref{Installation}.
3168 When the cursor is in an agenda view, the created link points to the
3169 entry referenced by the current line.
3172 @orgcmd{C-c C-l,org-insert-link}
3173 @cindex link completion
3174 @cindex completion, of links
3175 @cindex inserting links
3176 @vindex org-keep-stored-link-after-insertion
3177 Insert a link@footnote{ Note that you don't have to use this command to
3178 insert a link. Links in Org are plain text, and you can type or paste them
3179 straight into the buffer. By using this command, the links are automatically
3180 enclosed in double brackets, and you will be asked for the optional
3181 descriptive text.}. This prompts for a link to be inserted into the buffer.
3182 You can just type a link, using text for an internal link, or one of the link
3183 type prefixes mentioned in the examples above. The link will be inserted
3184 into the buffer@footnote{After insertion of a stored link, the link will be
3185 removed from the list of stored links. To keep it in the list later use, use
3186 a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
3187 @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
3188 If some text was selected when this command is called, the selected text
3189 becomes the default description.
3191 @b{Inserting stored links}@*
3192 All links stored during the
3193 current session are part of the history for this prompt, so you can access
3194 them with @key{up} and @key{down} (or @kbd{M-p/n}).
3196 @b{Completion support}@* Completion with @key{TAB} will help you to insert
3197 valid link prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
3198 defined through link abbreviations (@pxref{Link abbreviations}). If you
3199 press @key{RET} after inserting only the @var{prefix}, Org will offer
3200 specific completion support for some link types@footnote{This works by
3201 calling a special function @code{org-PREFIX-complete-link}.} For
3202 example, if you type @kbd{file @key{RET}}, file name completion (alternative
3203 access: @kbd{C-u C-c C-l}, see below) will be offered, and after @kbd{bbdb
3204 @key{RET}} you can complete contact names.
3206 @cindex file name completion
3207 @cindex completion, of file names
3208 When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
3209 a file will be inserted and you may use file name completion to select
3210 the name of the file. The path to the file is inserted relative to the
3211 directory of the current Org file, if the linked file is in the current
3212 directory or in a sub-directory of it, or if the path is written relative
3213 to the current directory using @samp{../}. Otherwise an absolute path
3214 is used, if possible with @samp{~/} for your home directory. You can
3215 force an absolute path with two @kbd{C-u} prefixes.
3217 @item C-c C-l @ @r{(with cursor on existing link)}
3218 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
3219 link and description parts of the link.
3221 @cindex following links
3222 @orgcmd{C-c C-o,org-open-at-point}
3223 @vindex org-file-apps
3224 Open link at point. This will launch a web browser for URLs (using
3225 @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
3226 the corresponding links, and execute the command in a shell link. When the
3227 cursor is on an internal link, this command runs the corresponding search.
3228 When the cursor is on a TAG list in a headline, it creates the corresponding
3229 TAGS view. If the cursor is on a timestamp, it compiles the agenda for that
3230 date. Furthermore, it will visit text and remote files in @samp{file:} links
3231 with Emacs and select a suitable application for local non-text files.
3232 Classification of files is based on file extension only. See option
3233 @code{org-file-apps}. If you want to override the default application and
3234 visit the file with Emacs, use a @kbd{C-u} prefix. If you want to avoid
3235 opening in Emacs, use a @kbd{C-u C-u} prefix.@*
3236 If the cursor is on a headline, but not on a link, offer all links in the
3237 headline and entry text.
3239 @vindex org-return-follows-link
3240 When @code{org-return-follows-link} is set, @kbd{@key{RET}} will also follow
3247 On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
3248 would. Under Emacs 22 and later, @kbd{mouse-1} will also follow a link.
3252 @vindex org-display-internal-link-with-indirect-buffer
3253 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
3254 internal links to be displayed in another window@footnote{See the
3255 variable @code{org-display-internal-link-with-indirect-buffer}}.
3257 @orgcmd{C-c C-x C-v,org-toggle-inline-images}
3258 @cindex inlining images
3259 @cindex images, inlining
3260 @vindex org-startup-with-inline-images
3261 @cindex @code{inlineimages}, STARTUP keyword
3262 @cindex @code{noinlineimages}, STARTUP keyword
3263 Toggle the inline display of linked images. Normally this will only inline
3264 images that have no description part in the link, i.e. images that will also
3265 be inlined during export. When called with a prefix argument, also display
3266 images that do have a link description. You can ask for inline images to be
3267 displayed at startup by configuring the variable
3268 @code{org-startup-with-inline-images}@footnote{with corresponding
3269 @code{#+STARTUP} keywords @code{inlineimages} and @code{inlineimages}}.
3270 @orgcmd{C-c %,org-mark-ring-push}
3272 Push the current position onto the mark ring, to be able to return
3273 easily. Commands following an internal link do this automatically.
3275 @orgcmd{C-c &,org-mark-ring-goto}
3276 @cindex links, returning to
3277 Jump back to a recorded position. A position is recorded by the
3278 commands following internal links, and by @kbd{C-c %}. Using this
3279 command several times in direct succession moves through a ring of
3280 previously recorded positions.
3282 @orgcmdkkcc{C-c C-x C-n,C-c C-x C-p,org-next-link,org-previous-link}
3283 @cindex links, finding next/previous
3284 Move forward/backward to the next link in the buffer. At the limit of
3285 the buffer, the search fails once, and then wraps around. The key
3286 bindings for this are really too long; you might want to bind this also
3287 to @kbd{C-n} and @kbd{C-p}
3289 (add-hook 'org-load-hook
3291 (define-key 'org-mode-map "\C-n" 'org-next-link)
3292 (define-key 'org-mode-map "\C-p" 'org-previous-link)))
3296 @node Using links outside Org, Link abbreviations, Handling links, Hyperlinks
3297 @section Using links outside Org
3299 You can insert and follow links that have Org syntax not only in
3300 Org, but in any Emacs buffer. For this, you should create two
3301 global commands, like this (please select suitable global keys
3305 (global-set-key "\C-c L" 'org-insert-link-global)
3306 (global-set-key "\C-c o" 'org-open-at-point-global)
3309 @node Link abbreviations, Search options, Using links outside Org, Hyperlinks
3310 @section Link abbreviations
3311 @cindex link abbreviations
3312 @cindex abbreviation, links
3314 Long URLs can be cumbersome to type, and often many similar links are
3315 needed in a document. For this you can use link abbreviations. An
3316 abbreviated link looks like this
3319 [[linkword:tag][description]]
3323 @vindex org-link-abbrev-alist
3324 where the tag is optional.
3325 The @i{linkword} must be a word, starting with a letter, followed by
3326 letters, numbers, @samp{-}, and @samp{_}. Abbreviations are resolved
3327 according to the information in the variable @code{org-link-abbrev-alist}
3328 that relates the linkwords to replacement text. Here is an example:
3332 (setq org-link-abbrev-alist
3333 '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
3334 ("google" . "http://www.google.com/search?q=")
3335 ("gmap" . "http://maps.google.com/maps?q=%s")
3336 ("omap" . "http://nominatim.openstreetmap.org/search?q=%s&polygon=1")
3337 ("ads" . "http://adsabs.harvard.edu/cgi-bin/nph-abs_connect?author=%s&db_key=AST")))
3341 If the replacement text contains the string @samp{%s}, it will be
3342 replaced with the tag. Otherwise the tag will be appended to the string
3343 in order to create the link. You may also specify a function that will
3344 be called with the tag as the only argument to create the link.
3346 With the above setting, you could link to a specific bug with
3347 @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
3348 @code{[[google:OrgMode]]}, show the map location of the Free Software
3349 Foundation @code{[[gmap:51 Franklin Street, Boston]]} or of Carsten office
3350 @code{[[omap:Science Park 904, Amsterdam, The Netherlands]]} and find out
3351 what the Org author is doing besides Emacs hacking with
3352 @code{[[ads:Dominik,C]]}.
3354 If you need special abbreviations just for a single Org buffer, you
3355 can define them in the file with
3359 #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
3360 #+LINK: google http://www.google.com/search?q=%s
3364 In-buffer completion (@pxref{Completion}) can be used after @samp{[} to
3365 complete link abbreviations. You may also define a function
3366 @code{org-PREFIX-complete-link} that implements special (e.g. completion)
3367 support for inserting such a link with @kbd{C-c C-l}. Such a function should
3368 not accept any arguments, and return the full link with prefix.
3370 @node Search options, Custom searches, Link abbreviations, Hyperlinks
3371 @section Search options in file links
3372 @cindex search option in file links
3373 @cindex file links, searching
3375 File links can contain additional information to make Emacs jump to a
3376 particular location in the file when following a link. This can be a
3377 line number or a search option after a double@footnote{For backward
3378 compatibility, line numbers can also follow a single colon.} colon. For
3379 example, when the command @kbd{C-c l} creates a link (@pxref{Handling
3380 links}) to a file, it encodes the words in the current line as a search
3381 string that can be used to find this line back later when following the
3382 link with @kbd{C-c C-o}.
3384 Here is the syntax of the different ways to attach a search to a file
3385 link, together with an explanation:
3388 [[file:~/code/main.c::255]]
3389 [[file:~/xx.org::My Target]]
3390 [[file:~/xx.org::*My Target]]
3391 [[file:~/xx.org::#my-custom-id]]
3392 [[file:~/xx.org::/regexp/]]
3399 Search for a link target @samp{<<My Target>>}, or do a text search for
3400 @samp{my target}, similar to the search in internal links, see
3401 @ref{Internal links}. In HTML export (@pxref{HTML export}), such a file
3402 link will become an HTML reference to the corresponding named anchor in
3405 In an Org file, restrict search to headlines.
3407 Link to a heading with a @code{CUSTOM_ID} property
3409 Do a regular expression search for @code{regexp}. This uses the Emacs
3410 command @code{occur} to list all matches in a separate window. If the
3411 target file is in Org-mode, @code{org-occur} is used to create a
3412 sparse tree with the matches.
3413 @c If the target file is a directory,
3414 @c @code{grep} will be used to search all files in the directory.
3417 As a degenerate case, a file link with an empty file name can be used
3418 to search the current file. For example, @code{[[file:::find me]]} does
3419 a search for @samp{find me} in the current file, just as
3420 @samp{[[find me]]} would.
3422 @node Custom searches, , Search options, Hyperlinks
3423 @section Custom Searches
3424 @cindex custom search strings
3425 @cindex search strings, custom
3427 The default mechanism for creating search strings and for doing the
3428 actual search related to a file link may not work correctly in all
3429 cases. For example, Bib@TeX{} database files have many entries like
3430 @samp{year="1993"} which would not result in good search strings,
3431 because the only unique identification for a Bib@TeX{} entry is the
3434 @vindex org-create-file-search-functions
3435 @vindex org-execute-file-search-functions
3436 If you come across such a problem, you can write custom functions to set
3437 the right search string for a particular file type, and to do the search
3438 for the string in the file. Using @code{add-hook}, these functions need
3439 to be added to the hook variables
3440 @code{org-create-file-search-functions} and
3441 @code{org-execute-file-search-functions}. See the docstring for these
3442 variables for more information. Org actually uses this mechanism
3443 for Bib@TeX{} database files, and you can use the corresponding code as
3444 an implementation example. See the file @file{org-bibtex.el}.
3446 @node TODO Items, Tags, Hyperlinks, Top
3450 Org-mode does not maintain TODO lists as separate documents@footnote{Of
3451 course, you can make a document that contains only long lists of TODO items,
3452 but this is not required.}. Instead, TODO items are an integral part of the
3453 notes file, because TODO items usually come up while taking notes! With Org
3454 mode, simply mark any entry in a tree as being a TODO item. In this way,
3455 information is not duplicated, and the entire context from which the TODO
3456 item emerged is always present.
3458 Of course, this technique for managing TODO items scatters them
3459 throughout your notes file. Org-mode compensates for this by providing
3460 methods to give you an overview of all the things that you have to do.
3463 * TODO basics:: Marking and displaying TODO entries
3464 * TODO extensions:: Workflow and assignments
3465 * Progress logging:: Dates and notes for progress
3466 * Priorities:: Some things are more important than others
3467 * Breaking down tasks:: Splitting a task into manageable pieces
3468 * Checkboxes:: Tick-off lists
3471 @node TODO basics, TODO extensions, TODO Items, TODO Items
3472 @section Basic TODO functionality
3474 Any headline becomes a TODO item when it starts with the word
3475 @samp{TODO}, for example:
3478 *** TODO Write letter to Sam Fortune
3482 The most important commands to work with TODO entries are:
3485 @orgcmd{C-c C-t,org-todo}
3486 @cindex cycling, of TODO states
3487 Rotate the TODO state of the current item among
3490 ,-> (unmarked) -> TODO -> DONE --.
3491 '--------------------------------'
3494 The same rotation can also be done ``remotely'' from the timeline and
3495 agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}).
3497 @orgkey{C-u C-c C-t}
3498 Select a specific keyword using completion or (if it has been set up)
3499 the fast selection interface. For the latter, you need to assign keys
3500 to TODO states, see @ref{Per-file keywords}, and @ref{Setting tags}, for
3503 @kindex S-@key{right}
3504 @kindex S-@key{left}
3505 @item S-@key{right} @ @r{/} @ S-@key{left}
3506 @vindex org-treat-S-cursor-todo-selection-as-state-change
3507 Select the following/preceding TODO state, similar to cycling. Useful
3508 mostly if more than two TODO states are possible (@pxref{TODO
3509 extensions}). See also @ref{Conflicts}, for a discussion of the interaction
3510 with @code{shift-selection-mode}. See also the variable
3511 @code{org-treat-S-cursor-todo-selection-as-state-change}.
3512 @orgcmd{C-c / t,org-show-todo-key}
3513 @cindex sparse tree, for TODO
3514 @vindex org-todo-keywords
3515 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds the
3516 entire buffer, but shows all TODO items (with not-DONE state) and the
3517 headings hierarchy above them. With a prefix argument (or by using @kbd{C-c
3518 / T}), search for a specific TODO. You will be prompted for the keyword, and
3519 you can also give a list of keywords like @code{KWD1|KWD2|...} to list
3520 entries that match any one of these keywords. With numeric prefix argument
3521 N, show the tree for the Nth keyword in the variable
3522 @code{org-todo-keywords}. With two prefix arguments, find all TODO states,
3523 both un-done and done.
3524 @orgcmd{C-c a t,org-todo-list}
3525 Show the global TODO list. Collects the TODO items (with not-DONE states)
3526 from all agenda files (@pxref{Agenda Views}) into a single buffer. The new
3527 buffer will be in @code{agenda-mode}, which provides commands to examine and
3528 manipulate the TODO entries from the new buffer (@pxref{Agenda commands}).
3529 @xref{Global TODO list}, for more information.
3530 @orgcmd{S-M-@key{RET},org-insert-todo-heading}
3531 Insert a new TODO entry below the current one.
3535 @vindex org-todo-state-tags-triggers
3536 Changing a TODO state can also trigger tag changes. See the docstring of the
3537 option @code{org-todo-state-tags-triggers} for details.
3539 @node TODO extensions, Progress logging, TODO basics, TODO Items
3540 @section Extended use of TODO keywords
3541 @cindex extended TODO keywords
3543 @vindex org-todo-keywords
3544 By default, marked TODO entries have one of only two states: TODO and
3545 DONE. Org-mode allows you to classify TODO items in more complex ways
3546 with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With
3547 special setup, the TODO keyword system can work differently in different
3550 Note that @i{tags} are another way to classify headlines in general and
3551 TODO items in particular (@pxref{Tags}).
3554 * Workflow states:: From TODO to DONE in steps
3555 * TODO types:: I do this, Fred does the rest
3556 * Multiple sets in one file:: Mixing it all, and still finding your way
3557 * Fast access to TODO states:: Single letter selection of a state
3558 * Per-file keywords:: Different files, different requirements
3559 * Faces for TODO keywords:: Highlighting states
3560 * TODO dependencies:: When one task needs to wait for others
3563 @node Workflow states, TODO types, TODO extensions, TODO extensions
3564 @subsection TODO keywords as workflow states
3565 @cindex TODO workflow
3566 @cindex workflow states as TODO keywords
3568 You can use TODO keywords to indicate different @emph{sequential} states
3569 in the process of working on an item, for example@footnote{Changing
3570 this variable only becomes effective after restarting Org-mode in a
3574 (setq org-todo-keywords
3575 '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
3578 The vertical bar separates the TODO keywords (states that @emph{need
3579 action}) from the DONE states (which need @emph{no further action}). If
3580 you don't provide the separator bar, the last state is used as the DONE
3582 @cindex completion, of TODO keywords
3583 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
3584 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED. You may
3585 also use a numeric prefix argument to quickly select a specific state. For
3586 example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY.
3587 Or you can use @kbd{S-@key{left}} to go backward through the sequence. If you
3588 define many keywords, you can use in-buffer completion
3589 (@pxref{Completion}) or even a special one-key selection scheme
3590 (@pxref{Fast access to TODO states}) to insert these words into the
3591 buffer. Changing a TODO state can be logged with a timestamp, see
3592 @ref{Tracking TODO state changes}, for more information.
3594 @node TODO types, Multiple sets in one file, Workflow states, TODO extensions
3595 @subsection TODO keywords as types
3597 @cindex names as TODO keywords
3598 @cindex types as TODO keywords
3600 The second possibility is to use TODO keywords to indicate different
3601 @emph{types} of action items. For example, you might want to indicate
3602 that items are for ``work'' or ``home''. Or, when you work with several
3603 people on a single project, you might want to assign action items
3604 directly to persons, by using their names as TODO keywords. This would
3605 be set up like this:
3608 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
3611 In this case, different keywords do not indicate a sequence, but rather
3612 different types. So the normal work flow would be to assign a task to a
3613 person, and later to mark it DONE. Org-mode supports this style by adapting
3614 the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
3615 @kbd{t} command in the timeline and agenda buffers.}. When used several
3616 times in succession, it will still cycle through all names, in order to first
3617 select the right type for a task. But when you return to the item after some
3618 time and execute @kbd{C-c C-t} again, it will switch from any name directly
3619 to DONE. Use prefix arguments or completion to quickly select a specific
3620 name. You can also review the items of a specific TODO type in a sparse tree
3621 by using a numeric prefix to @kbd{C-c / t}. For example, to see all things
3622 Lucy has to do, you would use @kbd{C-3 C-c / t}. To collect Lucy's items
3623 from all agenda files into a single buffer, you would use the numeric prefix
3624 argument as well when creating the global TODO list: @kbd{C-3 C-c a t}.
3626 @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions
3627 @subsection Multiple keyword sets in one file
3628 @cindex TODO keyword sets
3630 Sometimes you may want to use different sets of TODO keywords in
3631 parallel. For example, you may want to have the basic
3632 @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
3633 separate state indicating that an item has been canceled (so it is not
3634 DONE, but also does not require action). Your setup would then look
3638 (setq org-todo-keywords
3639 '((sequence "TODO" "|" "DONE")
3640 (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
3641 (sequence "|" "CANCELED")))
3644 The keywords should all be different, this helps Org-mode to keep track
3645 of which subsequence should be used for a given entry. In this setup,
3646 @kbd{C-c C-t} only operates within a subsequence, so it switches from
3647 @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
3648 (nothing) to @code{REPORT}. Therefore you need a mechanism to initially
3649 select the correct sequence. Besides the obvious ways like typing a
3650 keyword or using completion, you may also apply the following commands:
3653 @kindex C-S-@key{right}
3654 @kindex C-S-@key{left}
3655 @kindex C-u C-u C-c C-t
3656 @item C-u C-u C-c C-t
3657 @itemx C-S-@key{right}
3658 @itemx C-S-@key{left}
3659 These keys jump from one TODO subset to the next. In the above example,
3660 @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{right}} would jump from @code{TODO} or
3661 @code{DONE} to @code{REPORT}, and any of the words in the second row to
3662 @code{CANCELED}. Note that the @kbd{C-S-} key binding conflict with
3663 @code{shift-selection-mode} (@pxref{Conflicts}).
3664 @kindex S-@key{right}
3665 @kindex S-@key{left}
3668 @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through @emph{all}
3669 keywords from all sets, so for example @kbd{S-@key{<right>}} would switch
3670 from @code{DONE} to @code{REPORT} in the example above. See also
3671 @ref{Conflicts}, for a discussion of the interaction with
3672 @code{shift-selection-mode}.
3675 @node Fast access to TODO states, Per-file keywords, Multiple sets in one file, TODO extensions
3676 @subsection Fast access to TODO states
3678 If you would like to quickly change an entry to an arbitrary TODO state
3679 instead of cycling through the states, you can set up keys for
3680 single-letter access to the states. This is done by adding the section
3681 key after each keyword, in parentheses. For example:
3684 (setq org-todo-keywords
3685 '((sequence "TODO(t)" "|" "DONE(d)")
3686 (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
3687 (sequence "|" "CANCELED(c)")))
3690 @vindex org-fast-tag-selection-include-todo
3691 If you then press @code{C-c C-t} followed by the selection key, the entry
3692 will be switched to this state. @key{SPC} can be used to remove any TODO
3693 keyword from an entry.@footnote{Check also the variable
3694 @code{org-fast-tag-selection-include-todo}, it allows you to change the TODO
3695 state through the tags interface (@pxref{Setting tags}), in case you like to
3696 mingle the two concepts. Note that this means you need to come up with
3697 unique keys across both sets of keywords.}
3699 @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions
3700 @subsection Setting up keywords for individual files
3701 @cindex keyword options
3702 @cindex per-file keywords
3707 It can be very useful to use different aspects of the TODO mechanism in
3708 different files. For file-local settings, you need to add special lines
3709 to the file which set the keywords and interpretation for that file
3710 only. For example, to set one of the two examples discussed above, you
3711 need one of the following lines, starting in column zero anywhere in the
3715 #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
3717 @noindent (you may also write @code{#+SEQ_TODO} to be explicit about the
3718 interpretation, but it means the same as @code{#+TODO}), or
3720 #+TYP_TODO: Fred Sara Lucy Mike | DONE
3723 A setup for using several sets in parallel would be:
3727 #+TODO: REPORT BUG KNOWNCAUSE | FIXED
3731 @cindex completion, of option keywords
3733 @noindent To make sure you are using the correct keyword, type
3734 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
3736 @cindex DONE, final TODO keyword
3737 Remember that the keywords after the vertical bar (or the last keyword
3738 if no bar is there) must always mean that the item is DONE (although you
3739 may use a different word). After changing one of these lines, use
3740 @kbd{C-c C-c} with the cursor still in the line to make the changes
3741 known to Org-mode@footnote{Org-mode parses these lines only when
3742 Org-mode is activated after visiting a file. @kbd{C-c C-c} with the
3743 cursor in a line starting with @samp{#+} is simply restarting Org-mode
3744 for the current buffer.}.
3746 @node Faces for TODO keywords, TODO dependencies, Per-file keywords, TODO extensions
3747 @subsection Faces for TODO keywords
3748 @cindex faces, for TODO keywords
3750 @vindex org-todo @r{(face)}
3751 @vindex org-done @r{(face)}
3752 @vindex org-todo-keyword-faces
3753 Org-mode highlights TODO keywords with special faces: @code{org-todo}
3754 for keywords indicating that an item still has to be acted upon, and
3755 @code{org-done} for keywords indicating that an item is finished. If
3756 you are using more than 2 different states, you might want to use
3757 special faces for some of them. This can be done using the variable
3758 @code{org-todo-keyword-faces}. For example:
3762 (setq org-todo-keyword-faces
3763 '(("TODO" . org-warning) ("STARTED" . "yellow")
3764 ("CANCELED" . (:foreground "blue" :weight bold))))
3768 While using a list with face properties as shown for CANCELED @emph{should}
3769 work, this does not aways seem to be the case. If necessary, define a
3770 special face and use that. A string is interpreted as a color. The variable
3771 @code{org-faces-easy-properties} determines if that color is interpreted as a
3772 foreground or a background color.
3774 @node TODO dependencies, , Faces for TODO keywords, TODO extensions
3775 @subsection TODO dependencies
3776 @cindex TODO dependencies
3777 @cindex dependencies, of TODO states
3779 @vindex org-enforce-todo-dependencies
3780 @cindex property, ORDERED
3781 The structure of Org files (hierarchy and lists) makes it easy to define TODO
3782 dependencies. Usually, a parent TODO task should not be marked DONE until
3783 all subtasks (defined as children tasks) are marked as DONE. And sometimes
3784 there is a logical sequence to a number of (sub)tasks, so that one task
3785 cannot be acted upon before all siblings above it are done. If you customize
3786 the variable @code{org-enforce-todo-dependencies}, Org will block entries
3787 from changing state to DONE while they have children that are not DONE.
3788 Furthermore, if an entry has a property @code{ORDERED}, each of its children
3789 will be blocked until all earlier siblings are marked DONE. Here is an
3793 * TODO Blocked until (two) is done
3802 ** TODO b, needs to wait for (a)
3803 ** TODO c, needs to wait for (a) and (b)
3807 @orgcmd{C-c C-x o,org-toggle-ordered-property}
3808 @vindex org-track-ordered-property-with-tag
3809 @cindex property, ORDERED
3810 Toggle the @code{ORDERED} property of the current entry. A property is used
3811 for this behavior because this should be local to the current entry, not
3812 inherited like a tag. However, if you would like to @i{track} the value of
3813 this property with a tag for better visibility, customize the variable
3814 @code{org-track-ordered-property-with-tag}.
3815 @orgkey{C-u C-u C-u C-c C-t}
3816 Change TODO state, circumventing any state blocking.
3819 @vindex org-agenda-dim-blocked-tasks
3820 If you set the variable @code{org-agenda-dim-blocked-tasks}, TODO entries
3821 that cannot be closed because of such dependencies will be shown in a dimmed
3822 font or even made invisible in agenda views (@pxref{Agenda Views}).
3824 @cindex checkboxes and TODO dependencies
3825 @vindex org-enforce-todo-dependencies
3826 You can also block changes of TODO states by looking at checkboxes
3827 (@pxref{Checkboxes}). If you set the variable
3828 @code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked
3829 checkboxes will be blocked from switching to DONE.
3831 If you need more complex dependency structures, for example dependencies
3832 between entries in different trees or files, check out the contributed
3833 module @file{org-depend.el}.
3836 @node Progress logging, Priorities, TODO extensions, TODO Items
3837 @section Progress logging
3838 @cindex progress logging
3839 @cindex logging, of progress
3841 Org-mode can automatically record a timestamp and possibly a note when
3842 you mark a TODO item as DONE, or even each time you change the state of
3843 a TODO item. This system is highly configurable, settings can be on a
3844 per-keyword basis and can be localized to a file or even a subtree. For
3845 information on how to clock working time for a task, see @ref{Clocking
3849 * Closing items:: When was this entry marked DONE?
3850 * Tracking TODO state changes:: When did the status change?
3851 * Tracking your habits:: How consistent have you been?
3854 @node Closing items, Tracking TODO state changes, Progress logging, Progress logging
3855 @subsection Closing items
3857 The most basic logging is to keep track of @emph{when} a certain TODO
3858 item was finished. This is achieved with@footnote{The corresponding
3859 in-buffer setting is: @code{#+STARTUP: logdone}}
3862 (setq org-log-done 'time)
3866 Then each time you turn an entry from a TODO (not-done) state into any
3867 of the DONE states, a line @samp{CLOSED: [timestamp]} will be inserted
3868 just after the headline. If you turn the entry back into a TODO item
3869 through further state cycling, that line will be removed again. If you
3870 want to record a note along with the timestamp, use@footnote{The
3871 corresponding in-buffer setting is: @code{#+STARTUP: lognotedone}}
3874 (setq org-log-done 'note)
3878 You will then be prompted for a note, and that note will be stored below
3879 the entry with a @samp{Closing Note} heading.
3881 In the timeline (@pxref{Timeline}) and in the agenda
3882 (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
3883 display the TODO items with a @samp{CLOSED} timestamp on each day,
3884 giving you an overview of what has been done.
3886 @node Tracking TODO state changes, Tracking your habits, Closing items, Progress logging
3887 @subsection Tracking TODO state changes
3888 @cindex drawer, for state change recording
3890 @vindex org-log-states-order-reversed
3891 @vindex org-log-into-drawer
3892 @cindex property, LOG_INTO_DRAWER
3893 When TODO keywords are used as workflow states (@pxref{Workflow states}), you
3894 might want to keep track of when a state change occurred and maybe take a
3895 note about this change. You can either record just a timestamp, or a
3896 time-stamped note for a change. These records will be inserted after the
3897 headline as an itemized list, newest first@footnote{See the variable
3898 @code{org-log-states-order-reversed}}. When taking a lot of notes, you might
3899 want to get the notes out of the way into a drawer (@pxref{Drawers}).
3900 Customize the variable @code{org-log-into-drawer} to get this
3901 behavior---the recommended drawer for this is called @code{LOGBOOK}. You can
3902 also overrule the setting of this variable for a subtree by setting a
3903 @code{LOG_INTO_DRAWER} property.
3905 Since it is normally too much to record a note for every state, Org-mode
3906 expects configuration on a per-keyword basis for this. This is achieved by
3907 adding special markers @samp{!} (for a timestamp) and @samp{@@} (for a note)
3908 in parentheses after each keyword. For example, with the setting
3911 (setq org-todo-keywords
3912 '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
3916 @vindex org-log-done
3917 you not only define global TODO keywords and fast access keys, but also
3918 request that a time is recorded when the entry is set to
3919 DONE@footnote{It is possible that Org-mode will record two timestamps
3920 when you are using both @code{org-log-done} and state change logging.
3921 However, it will never prompt for two notes---if you have configured
3922 both, the state change recording note will take precedence and cancel
3923 the @samp{Closing Note}.}, and that a note is recorded when switching to
3924 WAIT or CANCELED. The setting for WAIT is even more special: the
3925 @samp{!} after the slash means that in addition to the note taken when
3926 entering the state, a timestamp should be recorded when @i{leaving} the
3927 WAIT state, if and only if the @i{target} state does not configure
3928 logging for entering it. So it has no effect when switching from WAIT
3929 to DONE, because DONE is configured to record a timestamp only. But
3930 when switching from WAIT back to TODO, the @samp{/!} in the WAIT
3931 setting now triggers a timestamp even though TODO has no logging
3934 You can use the exact same syntax for setting logging preferences local
3937 #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
3940 @cindex property, LOGGING
3941 In order to define logging settings that are local to a subtree or a
3942 single item, define a LOGGING property in this entry. Any non-empty
3943 LOGGING property resets all logging settings to nil. You may then turn
3944 on logging for this specific tree using STARTUP keywords like
3945 @code{lognotedone} or @code{logrepeat}, as well as adding state specific
3946 settings like @code{TODO(!)}. For example
3949 * TODO Log each state with only a time
3951 :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
3953 * TODO Only log when switching to WAIT, and when repeating
3955 :LOGGING: WAIT(@@) logrepeat
3957 * TODO No logging at all
3963 @node Tracking your habits, , Tracking TODO state changes, Progress logging
3964 @subsection Tracking your habits
3967 Org has the ability to track the consistency of a special category of TODOs,
3968 called ``habits''. A habit has the following properties:
3972 You have enabled the @code{habits} module by customizing the variable
3975 The habit is a TODO, with a TODO keyword representing an open state.
3977 The property @code{STYLE} is set to the value @code{habit}.
3979 The TODO has a scheduled date, usually with a @code{.+} style repeat
3980 interval. A @code{++} style may be appropriate for habits with time
3981 constraints, e.g., must be done on weekends, or a @code{+} style for an
3982 unusual habit that can have a backlog, e.g., weekly reports.
3984 The TODO may also have minimum and maximum ranges specified by using the
3985 syntax @samp{.+2d/3d}, which says that you want to do the task at least every
3986 three days, but at most every two days.
3988 You must also have state logging for the @code{DONE} state enabled, in order
3989 for historical data to be represented in the consistency graph. If it's not
3990 enabled it's not an error, but the consistency graphs will be largely
3994 To give you an idea of what the above rules look like in action, here's an
3995 actual habit with some history:
3999 SCHEDULED: <2009-10-17 Sat .+2d/4d>
4000 - State "DONE" from "TODO" [2009-10-15 Thu]
4001 - State "DONE" from "TODO" [2009-10-12 Mon]
4002 - State "DONE" from "TODO" [2009-10-10 Sat]
4003 - State "DONE" from "TODO" [2009-10-04 Sun]
4004 - State "DONE" from "TODO" [2009-10-02 Fri]
4005 - State "DONE" from "TODO" [2009-09-29 Tue]
4006 - State "DONE" from "TODO" [2009-09-25 Fri]
4007 - State "DONE" from "TODO" [2009-09-19 Sat]
4008 - State "DONE" from "TODO" [2009-09-16 Wed]
4009 - State "DONE" from "TODO" [2009-09-12 Sat]
4012 :LAST_REPEAT: [2009-10-19 Mon 00:36]
4016 What this habit says is: I want to shave at most every 2 days (given by the
4017 @code{SCHEDULED} date and repeat interval) and at least every 4 days. If
4018 today is the 15th, then the habit first appears in the agenda on Oct 17,
4019 after the minimum of 2 days has elapsed, and will appear overdue on Oct 19,
4020 after four days have elapsed.
4022 What's really useful about habits is that they are displayed along with a
4023 consistency graph, to show how consistent you've been at getting that task
4024 done in the past. This graph shows every day that the task was done over the
4025 past three weeks, with colors for each day. The colors used are:
4029 If the task wasn't to be done yet on that day.
4031 If the task could have been done on that day.
4033 If the task was going to be overdue the next day.
4035 If the task was overdue on that day.
4038 In addition to coloring each day, the day is also marked with an asterisk if
4039 the task was actually done that day, and an exclamation mark to show where
4040 the current day falls in the graph.
4042 There are several configuration variables that can be used to change the way
4043 habits are displayed in the agenda.
4046 @item org-habit-graph-column
4047 The buffer column at which the consistency graph should be drawn. This will
4048 overwrite any text in that column, so it's a good idea to keep your habits'
4049 titles brief and to the point.
4050 @item org-habit-preceding-days
4051 The amount of history, in days before today, to appear in consistency graphs.
4052 @item org-habit-following-days
4053 The number of days after today that will appear in consistency graphs.
4054 @item org-habit-show-habits-only-for-today
4055 If non-nil, only show habits in today's agenda view. This is set to true by
4059 Lastly, pressing @kbd{K} in the agenda buffer will cause habits to
4060 temporarily be disabled and they won't appear at all. Press @kbd{K} again to
4061 bring them back. They are also subject to tag filtering, if you have habits
4062 which should only be done in certain contexts, for example.
4064 @node Priorities, Breaking down tasks, Progress logging, TODO Items
4068 If you use Org-mode extensively, you may end up with enough TODO items that
4069 it starts to make sense to prioritize them. Prioritizing can be done by
4070 placing a @emph{priority cookie} into the headline of a TODO item, like this
4073 *** TODO [#A] Write letter to Sam Fortune
4077 @vindex org-priority-faces
4078 By default, Org-mode supports three priorities: @samp{A}, @samp{B}, and
4079 @samp{C}. @samp{A} is the highest priority. An entry without a cookie is
4080 treated just like priority @samp{B}. Priorities make a difference only for
4081 sorting in the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they
4082 have no inherent meaning to Org-mode. The cookies can be highlighted with
4083 special faces by customizing the variable @code{org-priority-faces}.
4085 Priorities can be attached to any outline node; they do not need to be TODO
4091 @findex org-priority
4092 Set the priority of the current headline (@command{org-priority}). The
4093 command prompts for a priority character @samp{A}, @samp{B} or @samp{C}.
4094 When you press @key{SPC} instead, the priority cookie is removed from the
4095 headline. The priorities can also be changed ``remotely'' from the timeline
4096 and agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
4098 @orgcmdkkcc{S-@key{up},S-@key{down},org-priority-up,org-priority-down}
4099 @vindex org-priority-start-cycle-with-default
4100 Increase/decrease priority of current headline@footnote{See also the option
4101 @code{org-priority-start-cycle-with-default}.}. Note that these keys are
4102 also used to modify timestamps (@pxref{Creating timestamps}). See also
4103 @ref{Conflicts}, for a discussion of the interaction with
4104 @code{shift-selection-mode}.
4107 @vindex org-highest-priority
4108 @vindex org-lowest-priority
4109 @vindex org-default-priority
4110 You can change the range of allowed priorities by setting the variables
4111 @code{org-highest-priority}, @code{org-lowest-priority}, and
4112 @code{org-default-priority}. For an individual buffer, you may set
4113 these values (highest, lowest, default) like this (please make sure that
4114 the highest priority is earlier in the alphabet than the lowest
4117 @cindex #+PRIORITIES
4122 @node Breaking down tasks, Checkboxes, Priorities, TODO Items
4123 @section Breaking tasks down into subtasks
4124 @cindex tasks, breaking down
4125 @cindex statistics, for TODO items
4127 @vindex org-agenda-todo-list-sublevels
4128 It is often advisable to break down large tasks into smaller, manageable
4129 subtasks. You can do this by creating an outline tree below a TODO item,
4130 with detailed subtasks on the tree@footnote{To keep subtasks out of the
4131 global TODO list, see the @code{org-agenda-todo-list-sublevels}.}. To keep
4132 the overview over the fraction of subtasks that are already completed, insert
4133 either @samp{[/]} or @samp{[%]} anywhere in the headline. These cookies will
4134 be updated each time the TODO status of a child changes, or when pressing
4135 @kbd{C-c C-c} on the cookie. For example:
4138 * Organize Party [33%]
4139 ** TODO Call people [1/2]
4143 ** DONE Talk to neighbor
4146 @cindex property, COOKIE_DATA
4147 If a heading has both checkboxes and TODO children below it, the meaning of
4148 the statistics cookie become ambiguous. Set the property
4149 @code{COOKIE_DATA} to either @samp{checkbox} or @samp{todo} to resolve
4152 @vindex org-hierarchical-todo-statistics
4153 If you would like to have the statistics cookie count any TODO entries in the
4154 subtree (not just direct children), configure the variable
4155 @code{org-hierarchical-todo-statistics}. To do this for a single subtree,
4156 include the word @samp{recursive} into the value of the @code{COOKIE_DATA}
4160 * Parent capturing statistics [2/20]
4162 :COOKIE_DATA: todo recursive
4166 If you would like a TODO entry to automatically change to DONE
4167 when all children are done, you can use the following setup:
4170 (defun org-summary-todo (n-done n-not-done)
4171 "Switch entry to DONE when all subentries are done, to TODO otherwise."
4172 (let (org-log-done org-log-states) ; turn off logging
4173 (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
4175 (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
4179 Another possibility is the use of checkboxes to identify (a hierarchy of) a
4180 large number of subtasks (@pxref{Checkboxes}).
4183 @node Checkboxes, , Breaking down tasks, TODO Items
4187 @vindex org-list-automatic-rules
4188 Every item in a plain list@footnote{With the exception of description
4189 lists. But you can allow it by modifying @code{org-list-automatic-rules}
4190 accordingly.} (@pxref{Plain lists}) can be made into a checkbox by starting
4191 it with the string @samp{[ ]}. This feature is similar to TODO items
4192 (@pxref{TODO Items}), but is more lightweight. Checkboxes are not included
4193 into the global TODO list, so they are often great to split a task into a
4194 number of simple steps. Or you can use them in a shopping list. To toggle a
4195 checkbox, use @kbd{C-c C-c}, or use the mouse (thanks to Piotr Zielinski's
4196 @file{org-mouse.el}).
4198 Here is an example of a checkbox list.
4201 * TODO Organize party [2/4]
4202 - [-] call people [1/3]
4207 - [ ] think about what music to play
4208 - [X] talk to the neighbors
4211 Checkboxes work hierarchically, so if a checkbox item has children that
4212 are checkboxes, toggling one of the children checkboxes will make the
4213 parent checkbox reflect if none, some, or all of the children are
4216 @cindex statistics, for checkboxes
4217 @cindex checkbox statistics
4218 @cindex property, COOKIE_DATA
4219 @vindex org-hierarchical-checkbox-statistics
4220 The @samp{[2/4]} and @samp{[1/3]} in the first and second line are cookies
4221 indicating how many checkboxes present in this entry have been checked off,
4222 and the total number of checkboxes present. This can give you an idea on how
4223 many checkboxes remain, even without opening a folded entry. The cookies can
4224 be placed into a headline or into (the first line of) a plain list item.
4225 Each cookie covers checkboxes of direct children structurally below the
4226 headline/item on which the cookie appears@footnote{Set the variable
4227 @code{org-hierarchical-checkbox-statistics} if you want such cookies to
4228 represent the all checkboxes below the cookie, not just the direct
4229 children.}. You have to insert the cookie yourself by typing either
4230 @samp{[/]} or @samp{[%]}. With @samp{[/]} you get an @samp{n out of m}
4231 result, as in the examples above. With @samp{[%]} you get information about
4232 the percentage of checkboxes checked (in the above example, this would be
4233 @samp{[50%]} and @samp{[33%]}, respectively). In a headline, a cookie can
4234 count either checkboxes below the heading or TODO states of children, and it
4235 will display whatever was changed last. Set the property @code{COOKIE_DATA}
4236 to either @samp{checkbox} or @samp{todo} to resolve this issue.
4238 @cindex blocking, of checkboxes
4239 @cindex checkbox blocking
4240 @cindex property, ORDERED
4241 If the current outline node has an @code{ORDERED} property, checkboxes must
4242 be checked off in sequence, and an error will be thrown if you try to check
4243 off a box while there are unchecked boxes above it.
4245 @noindent The following commands work with checkboxes:
4248 @orgcmd{C-c C-c,org-toggle-checkbox}
4249 Toggle checkbox status or (with prefix arg) checkbox presence at point. With
4250 double prefix argument, set it to @samp{[-]}, which is considered to be an
4252 @orgcmd{C-c C-x C-b,org-toggle-checkbox}
4253 Toggle checkbox status or (with prefix arg) checkbox presence at point. With
4254 double prefix argument, set it to @samp{[-]}, which is considered to be an
4258 If there is an active region, toggle the first checkbox in the region
4259 and set all remaining boxes to the same status as the first. With a prefix
4260 arg, add or remove the checkbox for all items in the region.
4262 If the cursor is in a headline, toggle checkboxes in the region between
4263 this headline and the next (so @emph{not} the entire subtree).
4265 If there is no active region, just toggle the checkbox at point.
4267 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
4268 Insert a new item with a checkbox.
4269 This works only if the cursor is already in a plain list item
4270 (@pxref{Plain lists}).
4271 @orgcmd{C-c C-x o,org-toggle-ordered-property}
4272 @vindex org-track-ordered-property-with-tag
4273 @cindex property, ORDERED
4274 Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
4275 be checked off in sequence. A property is used for this behavior because
4276 this should be local to the current entry, not inherited like a tag.
4277 However, if you would like to @i{track} the value of this property with a tag
4278 for better visibility, customize the variable
4279 @code{org-track-ordered-property-with-tag}.
4280 @orgcmd{C-c #,org-update-statistics-cookies}
4281 Update the statistics cookie in the current outline entry. When called with
4282 a @kbd{C-u} prefix, update the entire file. Checkbox statistic cookies are
4283 updated automatically if you toggle checkboxes with @kbd{C-c C-c} and make
4284 new ones with @kbd{M-S-@key{RET}}. TODO statistics cookies update when
4285 changing TODO states. If you delete boxes/entries or add/change them by
4286 hand, use this command to get things back into sync. Or simply toggle any
4287 entry twice (checkboxes with @kbd{C-c C-c}).
4290 @node Tags, Properties and Columns, TODO Items, Top
4293 @cindex headline tagging
4294 @cindex matching, tags
4295 @cindex sparse tree, tag based
4297 An excellent way to implement labels and contexts for cross-correlating
4298 information is to assign @i{tags} to headlines. Org-mode has extensive
4301 @vindex org-tag-faces
4302 Every headline can contain a list of tags; they occur at the end of the
4303 headline. Tags are normal words containing letters, numbers, @samp{_}, and
4304 @samp{@@}. Tags must be preceded and followed by a single colon, e.g.,
4305 @samp{:work:}. Several tags can be specified, as in @samp{:work:urgent:}.
4306 Tags will by default be in bold face with the same color as the headline.
4307 You may specify special faces for specific tags using the variable
4308 @code{org-tag-faces}, in much the same way as you can for TODO keywords
4309 (@pxref{Faces for TODO keywords}).
4312 * Tag inheritance:: Tags use the tree structure of the outline
4313 * Setting tags:: How to assign tags to a headline
4314 * Tag searches:: Searching for combinations of tags
4317 @node Tag inheritance, Setting tags, Tags, Tags
4318 @section Tag inheritance
4319 @cindex tag inheritance
4320 @cindex inheritance, of tags
4321 @cindex sublevels, inclusion into tags match
4323 @i{Tags} make use of the hierarchical structure of outline trees. If a
4324 heading has a certain tag, all subheadings will inherit the tag as
4325 well. For example, in the list
4328 * Meeting with the French group :work:
4329 ** Summary by Frank :boss:notes:
4330 *** TODO Prepare slides for him :action:
4334 the final heading will have the tags @samp{:work:}, @samp{:boss:},
4335 @samp{:notes:}, and @samp{:action:} even though the final heading is not
4336 explicitly marked with those tags. You can also set tags that all entries in
4337 a file should inherit just as if these tags were defined in a hypothetical
4338 level zero that surrounds the entire file. Use a line like this@footnote{As
4339 with all these in-buffer settings, pressing @kbd{C-c C-c} activates any
4340 changes in the line.}:
4344 #+FILETAGS: :Peter:Boss:Secret:
4348 @vindex org-use-tag-inheritance
4349 @vindex org-tags-exclude-from-inheritance
4350 To limit tag inheritance to specific tags, or to turn it off entirely, use
4351 the variables @code{org-use-tag-inheritance} and
4352 @code{org-tags-exclude-from-inheritance}.
4354 @vindex org-tags-match-list-sublevels
4355 When a headline matches during a tags search while tag inheritance is turned
4356 on, all the sublevels in the same tree will (for a simple match form) match
4357 as well@footnote{This is only true if the search does not involve more
4358 complex tests including properties (@pxref{Property searches}).}. The list
4359 of matches may then become very long. If you only want to see the first tags
4360 match in a subtree, configure the variable
4361 @code{org-tags-match-list-sublevels} (not recommended).
4363 @node Setting tags, Tag searches, Tag inheritance, Tags
4364 @section Setting tags
4365 @cindex setting tags
4366 @cindex tags, setting
4369 Tags can simply be typed into the buffer at the end of a headline.
4370 After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is
4371 also a special command for inserting tags:
4374 @orgcmd{C-c C-q,org-set-tags-command}
4375 @cindex completion, of tags
4376 @vindex org-tags-column
4377 Enter new tags for the current headline. Org-mode will either offer
4378 completion or a special single-key interface for setting tags, see
4379 below. After pressing @key{RET}, the tags will be inserted and aligned
4380 to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all
4381 tags in the current buffer will be aligned to that column, just to make
4382 things look nice. TAGS are automatically realigned after promotion,
4383 demotion, and TODO state changes (@pxref{TODO basics}).
4384 @orgcmd{C-c C-c,org-set-tags-command}
4385 When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
4388 @vindex org-tag-alist
4389 Org will support tag insertion based on a @emph{list of tags}. By
4390 default this list is constructed dynamically, containing all tags
4391 currently used in the buffer. You may also globally specify a hard list
4392 of tags with the variable @code{org-tag-alist}. Finally you can set
4393 the default tags for a given file with lines like
4397 #+TAGS: @@work @@home @@tennisclub
4398 #+TAGS: laptop car pc sailboat
4401 If you have globally defined your preferred set of tags using the
4402 variable @code{org-tag-alist}, but would like to use a dynamic tag list
4403 in a specific file, add an empty TAGS option line to that file:
4409 @vindex org-tag-persistent-alist
4410 If you have a preferred set of tags that you would like to use in every file,
4411 in addition to those defined on a per-file basis by TAGS option lines, then
4412 you may specify a list of tags with the variable
4413 @code{org-tag-persistent-alist}. You may turn this off on a per-file basis
4414 by adding a STARTUP option line to that file:
4420 By default Org-mode uses the standard minibuffer completion facilities for
4421 entering tags. However, it also implements another, quicker, tag selection
4422 method called @emph{fast tag selection}. This allows you to select and
4423 deselect tags with just a single key press. For this to work well you should
4424 assign unique letters to most of your commonly used tags. You can do this
4425 globally by configuring the variable @code{org-tag-alist} in your
4426 @file{.emacs} file. For example, you may find the need to tag many items in
4427 different files with @samp{:@@home:}. In this case you can set something
4431 (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
4434 @noindent If the tag is only relevant to the file you are working on, then you
4435 can instead set the TAGS option line as:
4438 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p)
4441 @noindent The tags interface will show the available tags in a splash
4442 window. If you want to start a new line after a specific tag, insert
4443 @samp{\n} into the tag list
4446 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) \n laptop(l) pc(p)
4449 @noindent or write them in two lines:
4452 #+TAGS: @@work(w) @@home(h) @@tennisclub(t)
4453 #+TAGS: laptop(l) pc(p)
4457 You can also group together tags that are mutually exclusive by using
4461 #+TAGS: @{ @@work(w) @@home(h) @@tennisclub(t) @} laptop(l) pc(p)
4464 @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
4465 and @samp{@@tennisclub} should be selected. Multiple such groups are allowed.
4467 @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
4468 these lines to activate any changes.
4471 To set these mutually exclusive groups in the variable @code{org-tags-alist},
4472 you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
4473 of the braces. Similarly, you can use @code{:newline} to indicate a line
4474 break. The previous example would be set globally by the following
4478 (setq org-tag-alist '((:startgroup . nil)
4479 ("@@work" . ?w) ("@@home" . ?h)
4480 ("@@tennisclub" . ?t)
4482 ("laptop" . ?l) ("pc" . ?p)))
4485 If at least one tag has a selection key then pressing @kbd{C-c C-c} will
4486 automatically present you with a special interface, listing inherited tags,
4487 the tags of the current headline, and a list of all valid tags with
4488 corresponding keys@footnote{Keys will automatically be assigned to tags which
4489 have no configured keys.}. In this interface, you can use the following
4494 Pressing keys assigned to tags will add or remove them from the list of
4495 tags in the current line. Selecting a tag in a group of mutually
4496 exclusive tags will turn off any other tags from that group.
4499 Enter a tag in the minibuffer, even if the tag is not in the predefined
4500 list. You will be able to complete on all tags present in the buffer.
4503 Clear all tags for this line.
4506 Accept the modified set.
4508 Abort without installing changes.
4510 If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
4512 Turn off groups of mutually exclusive tags. Use this to (as an
4513 exception) assign several tags from such a group.
4515 Toggle auto-exit after the next change (see below).
4516 If you are using expert mode, the first @kbd{C-c} will display the
4521 This method lets you assign tags to a headline with very few keys. With
4522 the above setup, you could clear the current tags and set @samp{@@home},
4523 @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
4524 C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@home} to
4525 @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
4526 alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag
4527 @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
4528 @key{RET} @key{RET}}.
4530 @vindex org-fast-tag-selection-single-key
4531 If you find that most of the time you need only a single key press to
4532 modify your list of tags, set the variable
4533 @code{org-fast-tag-selection-single-key}. Then you no longer have to
4534 press @key{RET} to exit fast tag selection---it will immediately exit
4535 after the first change. If you then occasionally need more keys, press
4536 @kbd{C-c} to turn off auto-exit for the current tag selection process
4537 (in effect: start selection with @kbd{C-c C-c C-c} instead of @kbd{C-c
4538 C-c}). If you set the variable to the value @code{expert}, the special
4539 window is not even shown for single-key tag selection, it comes up only
4540 when you press an extra @kbd{C-c}.
4542 @node Tag searches, , Setting tags, Tags
4543 @section Tag searches
4544 @cindex tag searches
4545 @cindex searching for tags
4547 Once a system of tags has been set up, it can be used to collect related
4548 information into special lists.
4551 @orgcmdkkc{C-c / m,C-c \,org-match-sparse-tree}
4552 Create a sparse tree with all headlines matching a tags search. With a
4553 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
4554 @orgcmd{C-c a m,org-tags-view}
4555 Create a global list of tag matches from all agenda files.
4556 @xref{Matching tags and properties}.
4557 @orgcmd{C-c a M,org-tags-view}
4558 @vindex org-tags-match-list-sublevels
4559 Create a global list of tag matches from all agenda files, but check
4560 only TODO items and force checking subitems (see variable
4561 @code{org-tags-match-list-sublevels}).
4564 These commands all prompt for a match string which allows basic Boolean logic
4565 like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and
4566 @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries
4567 which are tagged, like @samp{Kathy} or @samp{Sally}. The full syntax of the search
4568 string is rich and allows also matching against TODO keywords, entry levels
4569 and properties. For a complete description with many examples, see
4570 @ref{Matching tags and properties}.
4573 @node Properties and Columns, Dates and Times, Tags, Top
4574 @chapter Properties and columns
4577 Properties are a set of key-value pairs associated with an entry. There
4578 are two main applications for properties in Org-mode. First, properties
4579 are like tags, but with a value. Second, you can use properties to
4580 implement (very basic) database capabilities in an Org buffer. For
4581 an example of the first application, imagine maintaining a file where
4582 you document bugs and plan releases for a piece of software. Instead of
4583 using tags like @code{:release_1:}, @code{:release_2:}, one can use a
4584 property, say @code{:Release:}, that in different subtrees has different
4585 values, such as @code{1.0} or @code{2.0}. For an example of the second
4586 application of properties, imagine keeping track of your music CDs,
4587 where properties could be things such as the album, artist, date of
4588 release, number of tracks, and so on.
4590 Properties can be conveniently edited and viewed in column view
4591 (@pxref{Column view}).
4594 * Property syntax:: How properties are spelled out
4595 * Special properties:: Access to other Org-mode features
4596 * Property searches:: Matching property values
4597 * Property inheritance:: Passing values down the tree
4598 * Column view:: Tabular viewing and editing
4599 * Property API:: Properties for Lisp programmers
4602 @node Property syntax, Special properties, Properties and Columns, Properties and Columns
4603 @section Property syntax
4604 @cindex property syntax
4605 @cindex drawer, for properties
4607 Properties are key-value pairs. They need to be inserted into a special
4608 drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property
4609 is specified on a single line, with the key (surrounded by colons)
4610 first, and the value after it. Here is an example:
4615 *** Goldberg Variations
4617 :Title: Goldberg Variations
4618 :Composer: J.S. Bach
4620 :Publisher: Deutsche Grammophon
4625 You may define the allowed values for a particular property @samp{:Xyz:}
4626 by setting a property @samp{:Xyz_ALL:}. This special property is
4627 @emph{inherited}, so if you set it in a level 1 entry, it will apply to
4628 the entire tree. When allowed values are defined, setting the
4629 corresponding property becomes easier and is less prone to typing
4630 errors. For the example with the CD collection, we can predefine
4631 publishers and the number of disks in a box like this:
4636 :NDisks_ALL: 1 2 3 4
4637 :Publisher_ALL: "Deutsche Grammophon" Philips EMI
4641 If you want to set properties that can be inherited by any entry in a
4642 file, use a line like
4643 @cindex property, _ALL
4646 #+PROPERTY: NDisks_ALL 1 2 3 4
4649 @vindex org-global-properties
4650 Property values set with the global variable
4651 @code{org-global-properties} can be inherited by all entries in all
4655 The following commands help to work with properties:
4658 @orgcmd{M-@key{TAB},org-complete}
4659 After an initial colon in a line, complete property keys. All keys used
4660 in the current file will be offered as possible completions.
4661 @orgcmd{C-c C-x p,org-set-property}
4662 Set a property. This prompts for a property name and a value. If
4663 necessary, the property drawer is created as well.
4664 @item M-x org-insert-property-drawer
4665 @findex org-insert-property-drawer
4666 Insert a property drawer into the current entry. The drawer will be
4667 inserted early in the entry, but after the lines with planning
4668 information like deadlines.
4669 @orgcmd{C-c C-c,org-property-action}
4670 With the cursor in a property drawer, this executes property commands.
4671 @orgcmd{C-c C-c s,org-set-property}
4672 Set a property in the current entry. Both the property and the value
4673 can be inserted using completion.
4674 @orgcmdkkcc{S-@key{right},S-@key{left},org-property-next-allowed-value,org-property-previous-allowed-value}
4675 Switch property at point to the next/previous allowed value.
4676 @orgcmd{C-c C-c d,org-delete-property}
4677 Remove a property from the current entry.
4678 @orgcmd{C-c C-c D,org-delete-property-globally}
4679 Globally remove a property, from all entries in the current file.
4680 @orgcmd{C-c C-c c,org-compute-property-at-point}
4681 Compute the property at point, using the operator and scope from the
4682 nearest column format definition.
4685 @node Special properties, Property searches, Property syntax, Properties and Columns
4686 @section Special properties
4687 @cindex properties, special
4689 Special properties provide an alternative access method to Org-mode
4690 features, like the TODO state or the priority of an entry, discussed in the
4691 previous chapters. This interface exists so that you can include
4692 these states in a column view (@pxref{Column view}), or to use them in
4693 queries. The following property names are special and should not be
4694 used as keys in the properties drawer:
4696 @cindex property, special, TODO
4697 @cindex property, special, TAGS
4698 @cindex property, special, ALLTAGS
4699 @cindex property, special, CATEGORY
4700 @cindex property, special, PRIORITY
4701 @cindex property, special, DEADLINE
4702 @cindex property, special, SCHEDULED
4703 @cindex property, special, CLOSED
4704 @cindex property, special, TIMESTAMP
4705 @cindex property, special, TIMESTAMP_IA
4706 @cindex property, special, CLOCKSUM
4707 @cindex property, special, BLOCKED
4708 @c guessing that ITEM is needed in this area; also, should this list be sorted?
4709 @cindex property, special, ITEM
4711 TODO @r{The TODO keyword of the entry.}
4712 TAGS @r{The tags defined directly in the headline.}
4713 ALLTAGS @r{All tags, including inherited ones.}
4714 CATEGORY @r{The category of an entry.}
4715 PRIORITY @r{The priority of the entry, a string with a single letter.}
4716 DEADLINE @r{The deadline time string, without the angular brackets.}
4717 SCHEDULED @r{The scheduling timestamp, without the angular brackets.}
4718 CLOSED @r{When was this entry closed?}
4719 TIMESTAMP @r{The first keyword-less timestamp in the entry.}
4720 TIMESTAMP_IA @r{The first inactive timestamp in the entry.}
4721 CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}}
4722 @r{must be run first to compute the values.}
4723 BLOCKED @r{"t" if task is currently blocked by children or siblings}
4724 ITEM @r{The content of the entry.}
4727 @node Property searches, Property inheritance, Special properties, Properties and Columns
4728 @section Property searches
4729 @cindex properties, searching
4730 @cindex searching, of properties
4732 To create sparse trees and special lists with selection based on properties,
4733 the same commands are used as for tag searches (@pxref{Tag searches}).
4735 @orgcmdkkc{C-c / m,C-c \,org-match-sparse-tree}
4736 Create a sparse tree with all matching entries. With a
4737 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
4738 @orgcmd{C-c a m,org-tags-view}
4739 Create a global list of tag/property matches from all agenda files.
4740 @xref{Matching tags and properties}.
4741 @orgcmd{C-c a M,org-tags-view}
4742 @vindex org-tags-match-list-sublevels
4743 Create a global list of tag matches from all agenda files, but check
4744 only TODO items and force checking of subitems (see variable
4745 @code{org-tags-match-list-sublevels}).
4748 The syntax for the search string is described in @ref{Matching tags and
4751 There is also a special command for creating sparse trees based on a
4756 Create a sparse tree based on the value of a property. This first
4757 prompts for the name of a property, and then for a value. A sparse tree
4758 is created with all entries that define this property with the given
4759 value. If you enclose the value in curly braces, it is interpreted as
4760 a regular expression and matched against the property values.
4763 @node Property inheritance, Column view, Property searches, Properties and Columns
4764 @section Property Inheritance
4765 @cindex properties, inheritance
4766 @cindex inheritance, of properties
4768 @vindex org-use-property-inheritance
4769 The outline structure of Org-mode documents lends itself to an
4770 inheritance model of properties: if the parent in a tree has a certain
4771 property, the children can inherit this property. Org-mode does not
4772 turn this on by default, because it can slow down property searches
4773 significantly and is often not needed. However, if you find inheritance
4774 useful, you can turn it on by setting the variable
4775 @code{org-use-property-inheritance}. It may be set to @code{t} to make
4776 all properties inherited from the parent, to a list of properties
4777 that should be inherited, or to a regular expression that matches
4778 inherited properties. If a property has the value @samp{nil}, this is
4779 interpreted as an explicit undefine of the property, so that inheritance
4780 search will stop at this value and return @code{nil}.
4782 Org-mode has a few properties for which inheritance is hard-coded, at
4783 least for the special applications for which they are used:
4785 @cindex property, COLUMNS
4788 The @code{:COLUMNS:} property defines the format of column view
4789 (@pxref{Column view}). It is inherited in the sense that the level
4790 where a @code{:COLUMNS:} property is defined is used as the starting
4791 point for a column view table, independently of the location in the
4792 subtree from where columns view is turned on.
4794 @cindex property, CATEGORY
4795 For agenda view, a category set through a @code{:CATEGORY:} property
4796 applies to the entire subtree.
4798 @cindex property, ARCHIVE
4799 For archiving, the @code{:ARCHIVE:} property may define the archive
4800 location for the entire subtree (@pxref{Moving subtrees}).
4802 @cindex property, LOGGING
4803 The LOGGING property may define logging settings for an entry or a
4804 subtree (@pxref{Tracking TODO state changes}).
4807 @node Column view, Property API, Property inheritance, Properties and Columns
4808 @section Column view
4810 A great way to view and edit properties in an outline tree is
4811 @emph{column view}. In column view, each outline node is turned into a
4812 table row. Columns in this table provide access to properties of the
4813 entries. Org-mode implements columns by overlaying a tabular structure
4814 over the headline of each item. While the headlines have been turned
4815 into a table row, you can still change the visibility of the outline
4816 tree. For example, you get a compact table by switching to CONTENTS
4817 view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
4818 is active), but you can still open, read, and edit the entry below each
4819 headline. Or, you can switch to column view after executing a sparse
4820 tree command and in this way get a table only for the selected items.
4821 Column view also works in agenda buffers (@pxref{Agenda Views}) where
4822 queries have collected selected items, possibly from a number of files.
4825 * Defining columns:: The COLUMNS format property
4826 * Using column view:: How to create and use column view
4827 * Capturing column view:: A dynamic block for column view
4830 @node Defining columns, Using column view, Column view, Column view
4831 @subsection Defining columns
4832 @cindex column view, for properties
4833 @cindex properties, column view
4835 Setting up a column view first requires defining the columns. This is
4836 done by defining a column format line.
4839 * Scope of column definitions:: Where defined, where valid?
4840 * Column attributes:: Appearance and content of a column
4843 @node Scope of column definitions, Column attributes, Defining columns, Defining columns
4844 @subsubsection Scope of column definitions
4846 To define a column format for an entire file, use a line like
4850 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
4853 To specify a format that only applies to a specific tree, add a
4854 @code{:COLUMNS:} property to the top node of that tree, for example:
4857 ** Top node for columns view
4859 :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
4863 If a @code{:COLUMNS:} property is present in an entry, it defines columns
4864 for the entry itself, and for the entire subtree below it. Since the
4865 column definition is part of the hierarchical structure of the document,
4866 you can define columns on level 1 that are general enough for all
4867 sublevels, and more specific columns further down, when you edit a
4868 deeper part of the tree.
4870 @node Column attributes, , Scope of column definitions, Defining columns
4871 @subsubsection Column attributes
4872 A column definition sets the attributes of a column. The general
4873 definition looks like this:
4876 %[@var{width}]@var{property}[(@var{title})][@{@var{summary-type}@}]
4880 Except for the percent sign and the property name, all items are
4881 optional. The individual parts have the following meaning:
4884 @var{width} @r{An integer specifying the width of the column in characters.}
4885 @r{If omitted, the width will be determined automatically.}
4886 @var{property} @r{The property that should be edited in this column.}
4887 @r{Special properties representing meta data are allowed here}
4888 @r{as well (@pxref{Special properties})}
4889 @var{title} @r{The header text for the column. If omitted, the property}
4891 @{@var{summary-type}@} @r{The summary type. If specified, the column values for}
4892 @r{parent nodes are computed from the children.}
4893 @r{Supported summary types are:}
4894 @{+@} @r{Sum numbers in this column.}
4895 @{+;%.1f@} @r{Like @samp{+}, but format result with @samp{%.1f}.}
4896 @{$@} @r{Currency, short for @samp{+;%.2f}.}
4897 @{:@} @r{Sum times, HH:MM, plain numbers are hours.}
4898 @{X@} @r{Checkbox status, @samp{[X]} if all children are @samp{[X]}.}
4899 @{X/@} @r{Checkbox status, @samp{[n/m]}.}
4900 @{X%@} @r{Checkbox status, @samp{[n%]}.}
4901 @{min@} @r{Smallest number in column.}
4902 @{max@} @r{Largest number.}
4903 @{mean@} @r{Arithmetic mean of numbers.}
4904 @{:min@} @r{Smallest time value in column.}
4905 @{:max@} @r{Largest time value.}
4906 @{:mean@} @r{Arithmetic mean of time values.}
4907 @{@@min@} @r{Minimum age (in days/hours/mins/seconds).}
4908 @{@@max@} @r{Maximum age (in days/hours/mins/seconds).}
4909 @{@@mean@} @r{Arithmetic mean of ages (in days/hours/mins/seconds).}
4910 @{est+@} @r{Add low-high estimates.}
4914 Be aware that you can only have one summary type for any property you
4915 include. Subsequent columns referencing the same property will all display the
4916 same summary information.
4918 The @code{est+} summary type requires further explanation. It is used for
4919 combining estimates, expressed as low-high ranges. For example, instead
4920 of estimating a particular task will take 5 days, you might estimate it as
4921 5-6 days if you're fairly confident you know how much work is required, or
4922 1-10 days if you don't really know what needs to be done. Both ranges
4923 average at 5.5 days, but the first represents a more predictable delivery.
4925 When combining a set of such estimates, simply adding the lows and highs
4926 produces an unrealistically wide result. Instead, @code{est+} adds the
4927 statistical mean and variance of the sub-tasks, generating a final estimate
4928 from the sum. For example, suppose you had ten tasks, each of which was
4929 estimated at 0.5 to 2 days of work. Straight addition produces an estimate
4930 of 5 to 20 days, representing what to expect if everything goes either
4931 extremely well or extremely poorly. In contrast, @code{est+} estimates the
4932 full job more realistically, at 10-15 days.
4934 Here is an example for a complete columns definition, along with allowed
4938 :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.}
4939 %10Time_Estimate@{:@} %CLOCKSUM
4940 :Owner_ALL: Tammy Mark Karl Lisa Don
4941 :Status_ALL: "In progress" "Not started yet" "Finished" ""
4942 :Approved_ALL: "[ ]" "[X]"
4946 The first column, @samp{%25ITEM}, means the first 25 characters of the
4947 item itself, i.e. of the headline. You probably always should start the
4948 column definition with the @samp{ITEM} specifier. The other specifiers
4949 create columns @samp{Owner} with a list of names as allowed values, for
4950 @samp{Status} with four different possible values, and for a checkbox
4951 field @samp{Approved}. When no width is given after the @samp{%}
4952 character, the column will be exactly as wide as it needs to be in order
4953 to fully display all values. The @samp{Approved} column does have a
4954 modified title (@samp{Approved?}, with a question mark). Summaries will
4955 be created for the @samp{Time_Estimate} column by adding time duration
4956 expressions like HH:MM, and for the @samp{Approved} column, by providing
4957 an @samp{[X]} status if all children have been checked. The
4958 @samp{CLOCKSUM} column is special, it lists the sum of CLOCK intervals
4961 @node Using column view, Capturing column view, Defining columns, Column view
4962 @subsection Using column view
4965 @tsubheading{Turning column view on and off}
4966 @orgcmd{C-c C-x C-c,org-columns}
4967 @vindex org-columns-default-format
4968 Turn on column view. If the cursor is before the first headline in the file,
4969 column view is turned on for the entire file, using the @code{#+COLUMNS}
4970 definition. If the cursor is somewhere inside the outline, this command
4971 searches the hierarchy, up from point, for a @code{:COLUMNS:} property that
4972 defines a format. When one is found, the column view table is established
4973 for the tree starting at the entry that contains the @code{:COLUMNS:}
4974 property. If no such property is found, the format is taken from the
4975 @code{#+COLUMNS} line or from the variable @code{org-columns-default-format},
4976 and column view is established for the current entry and its subtree.
4977 @orgcmd{r,org-columns-redo}
4978 Recreate the column view, to include recent changes made in the buffer.
4979 @orgcmd{g,org-columns-redo}
4981 @orgcmd{q,org-columns-quit}
4983 @tsubheading{Editing values}
4984 @item @key{left} @key{right} @key{up} @key{down}
4985 Move through the column view from field to field.
4986 @kindex S-@key{left}
4987 @kindex S-@key{right}
4988 @item S-@key{left}/@key{right}
4989 Switch to the next/previous allowed value of the field. For this, you
4990 have to have specified allowed values for a property.
4992 Directly select the Nth allowed value, @kbd{0} selects the 10th value.
4993 @orgcmdkkcc{n,p,org-columns-next-allowed-value,org-columns-previous-allowed-value}
4994 Same as @kbd{S-@key{left}/@key{right}}
4995 @orgcmd{e,org-columns-edit-value}
4996 Edit the property at point. For the special properties, this will
4997 invoke the same interface that you normally use to change that
4998 property. For example, when editing a TAGS property, the tag completion
4999 or fast selection interface will pop up.
5000 @orgcmd{C-c C-c,org-columns-set-tags-or-toggle}
5001 When there is a checkbox at point, toggle it.
5002 @orgcmd{v,org-columns-show-value}
5003 View the full value of this property. This is useful if the width of
5004 the column is smaller than that of the value.
5005 @orgcmd{a,org-columns-edit-allowed}
5006 Edit the list of allowed values for this property. If the list is found
5007 in the hierarchy, the modified values is stored there. If no list is
5008 found, the new value is stored in the first entry that is part of the
5009 current column view.
5010 @tsubheading{Modifying the table structure}
5011 @orgcmdkkcc{<,>,org-columns-narrow,org-columns-widen}
5012 Make the column narrower/wider by one character.
5013 @orgcmd{S-M-@key{right},org-columns-new}
5014 Insert a new column, to the left of the current column.
5015 @orgcmd{S-M-@key{left},org-columns-delete}
5016 Delete the current column.
5019 @node Capturing column view, , Using column view, Column view
5020 @subsection Capturing column view
5022 Since column view is just an overlay over a buffer, it cannot be
5023 exported or printed directly. If you want to capture a column view, use
5024 a @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame
5025 of this block looks like this:
5027 @cindex #+BEGIN, columnview
5030 #+BEGIN: columnview :hlines 1 :id "label"
5035 @noindent This dynamic block has the following parameters:
5039 This is the most important parameter. Column view is a feature that is
5040 often localized to a certain (sub)tree, and the capture block might be
5041 at a different location in the file. To identify the tree whose view to
5042 capture, you can use 4 values:
5043 @cindex property, ID
5045 local @r{use the tree in which the capture block is located}
5046 global @r{make a global view, including all headings in the file}
5047 "file:@var{path-to-file}"
5048 @r{run column view at the top of this file}
5049 "@var{ID}" @r{call column view in the tree that has an @code{:ID:}}
5050 @r{property with the value @i{label}. You can use}
5051 @r{@kbd{M-x org-id-copy} to create a globally unique ID for}
5052 @r{the current entry and copy it to the kill-ring.}
5055 When @code{t}, insert an hline after every line. When a number @var{N}, insert
5056 an hline before each headline with level @code{<= @var{N}}.
5058 When set to @code{t}, force column groups to get vertical lines.
5060 When set to a number, don't capture entries below this level.
5061 @item :skip-empty-rows
5062 When set to @code{t}, skip rows where the only non-empty specifier of the
5063 column view is @code{ITEM}.
5068 The following commands insert or update the dynamic block:
5071 @orgcmd{C-c C-x i,org-insert-columns-dblock}
5072 Insert a dynamic block capturing a column view. You will be prompted
5073 for the scope or ID of the view.
5074 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
5075 Update dynamic block at point. The cursor needs to be in the
5076 @code{#+BEGIN} line of the dynamic block.
5077 @orgcmd{C-u C-c C-x C-u,org-update-all-dblocks}
5078 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
5079 you have several clock table blocks, column-capturing blocks or other dynamic
5083 You can add formulas to the column view table and you may add plotting
5084 instructions in front of the table---these will survive an update of the
5085 block. If there is a @code{#+TBLFM:} after the table, the table will
5086 actually be recalculated automatically after an update.
5088 An alternative way to capture and process property values into a table is
5089 provided by Eric Schulte's @file{org-collector.el} which is a contributed
5090 package@footnote{Contributed packages are not part of Emacs, but are
5091 distributed with the main distribution of Org (visit
5092 @uref{http://orgmode.org}).}. It provides a general API to collect
5093 properties from entries in a certain scope, and arbitrary Lisp expressions to
5094 process these values before inserting them into a table or a dynamic block.
5096 @node Property API, , Column view, Properties and Columns
5097 @section The Property API
5098 @cindex properties, API
5099 @cindex API, for properties
5101 There is a full API for accessing and changing properties. This API can
5102 be used by Emacs Lisp programs to work with properties and to implement
5103 features based on them. For more information see @ref{Using the
5106 @node Dates and Times, Capture - Refile - Archive, Properties and Columns, Top
5107 @chapter Dates and times
5113 To assist project planning, TODO items can be labeled with a date and/or
5114 a time. The specially formatted string carrying the date and time
5115 information is called a @emph{timestamp} in Org-mode. This may be a
5116 little confusing because timestamp is often used as indicating when
5117 something was created or last changed. However, in Org-mode this term
5118 is used in a much wider sense.
5121 * Timestamps:: Assigning a time to a tree entry
5122 * Creating timestamps:: Commands which insert timestamps
5123 * Deadlines and scheduling:: Planning your work
5124 * Clocking work time:: Tracking how long you spend on a task
5125 * Effort estimates:: Planning work effort in advance
5126 * Relative timer:: Notes with a running timer
5127 * Countdown timer:: Starting a countdown timer for a task
5131 @node Timestamps, Creating timestamps, Dates and Times, Dates and Times
5132 @section Timestamps, deadlines, and scheduling
5134 @cindex ranges, time
5139 A timestamp is a specification of a date (possibly with a time or a range of
5140 times) in a special format, either @samp{<2003-09-16 Tue>} or
5141 @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16 Tue
5142 12:00-12:30>}@footnote{This is inspired by the standard ISO 8601 date/time
5143 format. To use an alternative format, see @ref{Custom time format}.}. A
5144 timestamp can appear anywhere in the headline or body of an Org tree entry.
5145 Its presence causes entries to be shown on specific dates in the agenda
5146 (@pxref{Weekly/daily agenda}). We distinguish:
5149 @item Plain timestamp; Event; Appointment
5151 A simple timestamp just assigns a date/time to an item. This is just
5152 like writing down an appointment or event in a paper agenda. In the
5153 timeline and agenda displays, the headline of an entry associated with a
5154 plain timestamp will be shown exactly on that date.
5157 * Meet Peter at the movies <2006-11-01 Wed 19:15>
5158 * Discussion on climate change <2006-11-02 Thu 20:00-22:00>
5161 @item Timestamp with repeater interval
5162 @cindex timestamp, with repeater interval
5163 A timestamp may contain a @emph{repeater interval}, indicating that it
5164 applies not only on the given date, but again and again after a certain
5165 interval of N days (d), weeks (w), months (m), or years (y). The
5166 following will show up in the agenda every Wednesday:
5169 * Pick up Sam at school <2007-05-16 Wed 12:30 +1w>
5172 @item Diary-style sexp entries
5173 For more complex date specifications, Org-mode supports using the
5174 special sexp diary entries implemented in the Emacs calendar/diary
5175 package. For example
5178 * The nerd meeting on every 2nd Thursday of the month
5179 <%%(diary-float t 4 2)>
5182 @item Time/Date range
5185 Two timestamps connected by @samp{--} denote a range. The headline
5186 will be shown on the first and last day of the range, and on any dates
5187 that are displayed and fall in the range. Here is an example:
5190 ** Meeting in Amsterdam
5191 <2004-08-23 Mon>--<2004-08-26 Thu>
5194 @item Inactive timestamp
5195 @cindex timestamp, inactive
5196 @cindex inactive timestamp
5197 Just like a plain timestamp, but with square brackets instead of
5198 angular ones. These timestamps are inactive in the sense that they do
5199 @emph{not} trigger an entry to show up in the agenda.
5202 * Gillian comes late for the fifth time [2006-11-01 Wed]
5207 @node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times
5208 @section Creating timestamps
5209 @cindex creating timestamps
5210 @cindex timestamps, creating
5212 For Org-mode to recognize timestamps, they need to be in the specific
5213 format. All commands listed below produce timestamps in the correct
5217 @orgcmd{C-c .,org-time-stamp}
5218 Prompt for a date and insert a corresponding timestamp. When the cursor is
5219 at an existing timestamp in the buffer, the command is used to modify this
5220 timestamp instead of inserting a new one. When this command is used twice in
5221 succession, a time range is inserted.
5223 @orgcmd{C-c !,org-time-stamp-inactive}
5224 Like @kbd{C-c .}, but insert an inactive timestamp that will not cause
5231 @vindex org-time-stamp-rounding-minutes
5232 Like @kbd{C-c .} and @kbd{C-c !}, but use the alternative format which
5233 contains date and time. The default time can be rounded to multiples of 5
5234 minutes, see the option @code{org-time-stamp-rounding-minutes}.
5236 @orgcmd{C-c <,org-date-from-calendar}
5237 Insert a timestamp corresponding to the cursor date in the Calendar.
5239 @orgcmd{C-c >,org-goto-calendar}
5240 Access the Emacs calendar for the current date. If there is a
5241 timestamp in the current line, go to the corresponding date
5244 @orgcmd{C-c C-o,org-open-at-point}
5245 Access the agenda for the date given by the timestamp or -range at
5246 point (@pxref{Weekly/daily agenda}).
5248 @orgcmdkkcc{S-@key{left},S-@key{right},org-timestamp-down-day,org-timestamp-up-day}
5249 Change date at cursor by one day. These key bindings conflict with
5250 shift-selection and related modes (@pxref{Conflicts}).
5252 @orgcmdkkcc{S-@key{up},S-@key{down},org-timestamp-up,org-timestamp-down-down}
5253 Change the item under the cursor in a timestamp. The cursor can be on a
5254 year, month, day, hour or minute. When the timestamp contains a time range
5255 like @samp{15:30-16:30}, modifying the first time will also shift the second,
5256 shifting the time block with constant length. To change the length, modify
5257 the second time. Note that if the cursor is in a headline and not at a
5258 timestamp, these same keys modify the priority of an item.
5259 (@pxref{Priorities}). The key bindings also conflict with shift-selection and
5260 related modes (@pxref{Conflicts}).
5262 @orgcmd{C-c C-y,org-evaluate-time-range}
5263 @cindex evaluate time range
5264 Evaluate a time range by computing the difference between start and end.
5265 With a prefix argument, insert result after the time range (in a table: into
5266 the following column).
5271 * The date/time prompt:: How Org-mode helps you entering date and time
5272 * Custom time format:: Making dates look different
5275 @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps
5276 @subsection The date/time prompt
5277 @cindex date, reading in minibuffer
5278 @cindex time, reading in minibuffer
5280 @vindex org-read-date-prefer-future
5281 When Org-mode prompts for a date/time, the default is shown in default
5282 date/time format, and the prompt therefore seems to ask for a specific
5283 format. But it will in fact accept any string containing some date and/or
5284 time information, and it is really smart about interpreting your input. You
5285 can, for example, use @kbd{C-y} to paste a (possibly multi-line) string
5286 copied from an email message. Org-mode will find whatever information is in
5287 there and derive anything you have not specified from the @emph{default date
5288 and time}. The default is usually the current date and time, but when
5289 modifying an existing timestamp, or when entering the second stamp of a
5290 range, it is taken from the stamp in the buffer. When filling in
5291 information, Org-mode assumes that most of the time you will want to enter a
5292 date in the future: if you omit the month/year and the given day/month is
5293 @i{before} today, it will assume that you mean a future date@footnote{See the
5294 variable @code{org-read-date-prefer-future}. You may set that variable to
5295 the symbol @code{time} to even make a time before now shift the date to
5296 tomorrow.}. If the date has been automatically shifted into the future, the
5297 time prompt will show this with @samp{(=>F).}
5299 For example, let's assume that today is @b{June 13, 2006}. Here is how
5300 various inputs will be interpreted, the items filled in by Org-mode are
5304 3-2-5 --> 2003-02-05
5305 2/5/3 --> 2003-02-05
5306 14 --> @b{2006}-@b{06}-14
5307 12 --> @b{2006}-@b{07}-12
5308 2/5 --> @b{2007}-02-05
5309 Fri --> nearest Friday (default date or later)
5310 sep 15 --> @b{2006}-09-15
5311 feb 15 --> @b{2007}-02-15
5312 sep 12 9 --> 2009-09-12
5313 12:45 --> @b{2006}-@b{06}-@b{13} 12:45
5314 22 sept 0:34 --> @b{2006}-09-22 0:34
5315 w4 --> ISO week for of the current year @b{2006}
5316 2012 w4 fri --> Friday of ISO week 4 in 2012
5317 2012-w04-5 --> Same as above
5320 Furthermore you can specify a relative date by giving, as the
5321 @emph{first} thing in the input: a plus/minus sign, a number and a
5322 letter ([dwmy]) to indicate change in days, weeks, months, or years. With a
5323 single plus or minus, the date is always relative to today. With a
5324 double plus or minus, it is relative to the default date. If instead of
5325 a single letter, you use the abbreviation of day name, the date will be
5326 the Nth such day. E.g.
5331 +4d --> four days from today
5332 +4 --> same as above
5333 +2w --> two weeks from today
5334 ++5 --> five days from default date
5335 +2tue --> second Tuesday from now.
5338 @vindex parse-time-months
5339 @vindex parse-time-weekdays
5340 The function understands English month and weekday abbreviations. If
5341 you want to use unabbreviated names and/or other languages, configure
5342 the variables @code{parse-time-months} and @code{parse-time-weekdays}.
5344 You can specify a time range by giving start and end times or by giving a
5345 start time and a duration (in HH:MM format). Use `-' or `-@{@}-' as the separator
5346 in the former case and use '+' as the separator in the latter case. E.g.
5349 11am-1:15pm --> 11:00-13:15
5350 11am--1:15pm --> same as above
5351 11am+2:15 --> same as above
5354 @cindex calendar, for selecting date
5355 @vindex org-popup-calendar-for-date-prompt
5356 Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
5357 you don't need/want the calendar, configure the variable
5358 @code{org-popup-calendar-for-date-prompt}.}. When you exit the date
5359 prompt, either by clicking on a date in the calendar, or by pressing
5360 @key{RET}, the date selected in the calendar will be combined with the
5361 information entered at the prompt. You can control the calendar fully
5362 from the minibuffer:
5369 @kindex S-@key{right}
5370 @kindex S-@key{left}
5371 @kindex S-@key{down}
5373 @kindex M-S-@key{right}
5374 @kindex M-S-@key{left}
5377 @key{RET} @r{Choose date at cursor in calendar.}
5378 mouse-1 @r{Select date by clicking on it.}
5379 S-@key{right}/@key{left} @r{One day forward/backward.}
5380 S-@key{down}/@key{up} @r{One week forward/backward.}
5381 M-S-@key{right}/@key{left} @r{One month forward/backward.}
5382 > / < @r{Scroll calendar forward/backward by one month.}
5383 M-v / C-v @r{Scroll calendar forward/backward by 3 months.}
5386 @vindex org-read-date-display-live
5387 The actions of the date/time prompt may seem complex, but I assure you they
5388 will grow on you, and you will start getting annoyed by pretty much any other
5389 way of entering a date/time out there. To help you understand what is going
5390 on, the current interpretation of your input will be displayed live in the
5391 minibuffer@footnote{If you find this distracting, turn the display of with
5392 @code{org-read-date-display-live}.}.
5394 @node Custom time format, , The date/time prompt, Creating timestamps
5395 @subsection Custom time format
5396 @cindex custom date/time format
5397 @cindex time format, custom
5398 @cindex date format, custom
5400 @vindex org-display-custom-times
5401 @vindex org-time-stamp-custom-formats
5402 Org-mode uses the standard ISO notation for dates and times as it is
5403 defined in ISO 8601. If you cannot get used to this and require another
5404 representation of date and time to keep you happy, you can get it by
5405 customizing the variables @code{org-display-custom-times} and
5406 @code{org-time-stamp-custom-formats}.
5409 @orgcmd{C-c C-x C-t,org-toggle-time-stamp-overlays}
5410 Toggle the display of custom formats for dates and times.
5414 Org-mode needs the default format for scanning, so the custom date/time
5415 format does not @emph{replace} the default format---instead it is put
5416 @emph{over} the default format using text properties. This has the
5417 following consequences:
5420 You cannot place the cursor onto a timestamp anymore, only before or
5423 The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
5424 each component of a timestamp. If the cursor is at the beginning of
5425 the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
5426 just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the
5427 time will be changed by one minute.
5429 If the timestamp contains a range of clock times or a repeater, these
5430 will not be overlaid, but remain in the buffer as they were.
5432 When you delete a timestamp character-by-character, it will only
5433 disappear from the buffer after @emph{all} (invisible) characters
5434 belonging to the ISO timestamp have been removed.
5436 If the custom timestamp format is longer than the default and you are
5437 using dates in tables, table alignment will be messed up. If the custom
5438 format is shorter, things do work as expected.
5442 @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times
5443 @section Deadlines and scheduling
5445 A timestamp may be preceded by special keywords to facilitate planning:
5449 @cindex DEADLINE keyword
5451 Meaning: the task (most likely a TODO item, though not necessarily) is supposed
5452 to be finished on that date.
5454 @vindex org-deadline-warning-days
5455 On the deadline date, the task will be listed in the agenda. In
5456 addition, the agenda for @emph{today} will carry a warning about the
5457 approaching or missed deadline, starting
5458 @code{org-deadline-warning-days} before the due date, and continuing
5459 until the entry is marked DONE. An example:
5462 *** TODO write article about the Earth for the Guide
5463 The editor in charge is [[bbdb:Ford Prefect]]
5464 DEADLINE: <2004-02-29 Sun>
5467 You can specify a different lead time for warnings for a specific
5468 deadlines using the following syntax. Here is an example with a warning
5469 period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}.
5472 @cindex SCHEDULED keyword
5474 Meaning: you are planning to start working on that task on the given
5477 @vindex org-agenda-skip-scheduled-if-done
5478 The headline will be listed under the given date@footnote{It will still
5479 be listed on that date after it has been marked DONE. If you don't like
5480 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In
5481 addition, a reminder that the scheduled date has passed will be present
5482 in the compilation for @emph{today}, until the entry is marked DONE, i.e.
5483 the task will automatically be forwarded until completed.
5486 *** TODO Call Trillian for a date on New Years Eve.
5487 SCHEDULED: <2004-12-25 Sat>
5491 @b{Important:} Scheduling an item in Org-mode should @i{not} be
5492 understood in the same way that we understand @i{scheduling a meeting}.
5493 Setting a date for a meeting is just a simple appointment, you should
5494 mark this entry with a simple plain timestamp, to get this item shown
5495 on the date where it applies. This is a frequent misunderstanding by
5496 Org users. In Org-mode, @i{scheduling} means setting a date when you
5497 want to start working on an action item.
5500 You may use timestamps with repeaters in scheduling and deadline
5501 entries. Org-mode will issue early and late warnings based on the
5502 assumption that the timestamp represents the @i{nearest instance} of
5503 the repeater. However, the use of diary sexp entries like
5505 @code{<%%(diary-float t 42)>}
5507 in scheduling and deadline timestamps is limited. Org-mode does not
5508 know enough about the internals of each sexp function to issue early and
5509 late warnings. However, it will show the item on each day where the
5513 * Inserting deadline/schedule:: Planning items
5514 * Repeated tasks:: Items that show up again and again
5517 @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling
5518 @subsection Inserting deadlines or schedules
5520 The following commands allow you to quickly insert a deadline or to schedule
5525 @orgcmd{C-c C-d,org-deadline}
5526 Insert @samp{DEADLINE} keyword along with a stamp. The insertion will happen
5527 in the line directly following the headline. When called with a prefix arg,
5528 an existing deadline will be removed from the entry. Depending on the
5529 variable @code{org-log-redeadline}@footnote{with corresponding
5530 @code{#+STARTUP} keywords @code{logredeadline}, @code{lognoteredeadline},
5531 and @code{nologredeadline}}, a note will be taken when changing an existing
5533 @c FIXME Any CLOSED timestamp will be removed.????????
5535 @orgcmd{C-c C-s,org-schedule}
5536 Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will
5537 happen in the line directly following the headline. Any CLOSED timestamp
5538 will be removed. When called with a prefix argument, remove the scheduling
5539 date from the entry. Depending on the variable
5540 @code{org-log-reschedule}@footnote{with corresponding @code{#+STARTUP}
5541 keywords @code{logredeadline}, @code{lognoteredeadline}, and
5542 @code{nologredeadline}}, a note will be taken when changing an existing
5545 @orgcmd{C-c C-x C-k,org-mark-entry-for-agenda-action}
5548 Mark the current entry for agenda action. After you have marked the entry
5549 like this, you can open the agenda or the calendar to find an appropriate
5550 date. With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to
5551 schedule the marked item.
5553 @orgcmd{C-c / d,org-check-deadlines}
5554 @cindex sparse tree, for deadlines
5555 @vindex org-deadline-warning-days
5556 Create a sparse tree with all deadlines that are either past-due, or
5557 which will become due within @code{org-deadline-warning-days}.
5558 With @kbd{C-u} prefix, show all deadlines in the file. With a numeric
5559 prefix, check that many days. For example, @kbd{C-1 C-c / d} shows
5560 all deadlines due tomorrow.
5562 @orgcmd{C-c / b,org-check-before-date}
5563 Sparse tree for deadlines and scheduled items before a given date.
5565 @orgcmd{C-c / a,org-check-after-date}
5566 Sparse tree for deadlines and scheduled items after a given date.
5569 @node Repeated tasks, , Inserting deadline/schedule, Deadlines and scheduling
5570 @subsection Repeated tasks
5571 @cindex tasks, repeated
5572 @cindex repeated tasks
5574 Some tasks need to be repeated again and again. Org-mode helps to
5575 organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
5576 or plain timestamp. In the following example
5578 ** TODO Pay the rent
5579 DEADLINE: <2005-10-01 Sat +1m>
5582 the @code{+1m} is a repeater; the intended interpretation is that the task
5583 has a deadline on <2005-10-01> and repeats itself every (one) month starting
5584 from that time. If you need both a repeater and a special warning period in
5585 a deadline entry, the repeater should come first and the warning period last:
5586 @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
5588 @vindex org-todo-repeat-to-state
5589 Deadlines and scheduled items produce entries in the agenda when they are
5590 over-due, so it is important to be able to mark such an entry as completed
5591 once you have done so. When you mark a DEADLINE or a SCHEDULE with the TODO
5592 keyword DONE, it will no longer produce entries in the agenda. The problem
5593 with this is, however, that then also the @emph{next} instance of the
5594 repeated entry will not be active. Org-mode deals with this in the following
5595 way: When you try to mark such an entry DONE (using @kbd{C-c C-t}), it will
5596 shift the base date of the repeating timestamp by the repeater interval, and
5597 immediately set the entry state back to TODO@footnote{In fact, the target
5598 state is taken from, in this sequence, the @code{REPEAT_TO_STATE} property or
5599 the variable @code{org-todo-repeat-to-state}. If neither of these is
5600 specified, the target state defaults to the first state of the TODO state
5601 sequence.}. In the example above, setting the state to DONE would actually
5602 switch the date like this:
5605 ** TODO Pay the rent
5606 DEADLINE: <2005-11-01 Tue +1m>
5609 @vindex org-log-repeat
5610 A timestamp@footnote{You can change this using the option
5611 @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
5612 @code{lognoterepeat}, and @code{nologrepeat}. With @code{lognoterepeat}, you
5613 will also be prompted for a note.} will be added under the deadline, to keep
5614 a record that you actually acted on the previous instance of this deadline.
5616 As a consequence of shifting the base date, this entry will no longer be
5617 visible in the agenda when checking past dates, but all future instances
5620 With the @samp{+1m} cookie, the date shift will always be exactly one
5621 month. So if you have not paid the rent for three months, marking this
5622 entry DONE will still keep it as an overdue deadline. Depending on the
5623 task, this may not be the best way to handle it. For example, if you
5624 forgot to call your father for 3 weeks, it does not make sense to call
5625 him 3 times in a single day to make up for it. Finally, there are tasks
5626 like changing batteries which should always repeat a certain time
5627 @i{after} the last time you did it. For these tasks, Org-mode has
5628 special repeaters @samp{++} and @samp{.+}. For example:
5632 DEADLINE: <2008-02-10 Sun ++1w>
5633 Marking this DONE will shift the date by at least one week,
5634 but also by as many weeks as it takes to get this date into
5635 the future. However, it stays on a Sunday, even if you called
5636 and marked it done on Saturday.
5637 ** TODO Check the batteries in the smoke detectors
5638 DEADLINE: <2005-11-01 Tue .+1m>
5639 Marking this DONE will shift the date to one month after
5643 You may have both scheduling and deadline information for a specific
5644 task---just make sure that the repeater intervals on both are the same.
5646 An alternative to using a repeater is to create a number of copies of a task
5647 subtree, with dates shifted in each copy. The command @kbd{C-c C-x c} was
5648 created for this purpose, it is described in @ref{Structure editing}.
5651 @node Clocking work time, Effort estimates, Deadlines and scheduling, Dates and Times
5652 @section Clocking work time
5653 @cindex clocking time
5654 @cindex time clocking
5656 Org-mode allows you to clock the time you spend on specific tasks in a
5657 project. When you start working on an item, you can start the clock.
5658 When you stop working on that task, or when you mark the task done, the
5659 clock is stopped and the corresponding time interval is recorded. It
5660 also computes the total time spent on each subtree of a project. And it
5661 remembers a history or tasks recently clocked, to that you can jump quickly
5662 between a number of tasks absorbing your time.
5664 To save the clock history across Emacs sessions, use
5666 (setq org-clock-persist 'history)
5667 (org-clock-persistence-insinuate)
5669 When you clock into a new task after resuming Emacs, the incomplete
5670 clock@footnote{To resume the clock under the assumption that you have worked
5671 on this task while outside Emacs, use @code{(setq org-clock-persist t)}.}
5672 will be found (@pxref{Resolving idle time}) and you will be prompted about
5676 * Clocking commands:: Starting and stopping a clock
5677 * The clock table:: Detailed reports
5678 * Resolving idle time:: Resolving time when you've been idle
5681 @node Clocking commands, The clock table, Clocking work time, Clocking work time
5682 @subsection Clocking commands
5685 @orgcmd{C-c C-x C-i,org-clock-in}
5686 @vindex org-clock-into-drawer
5687 Start the clock on the current item (clock-in). This inserts the CLOCK
5688 keyword together with a timestamp. If this is not the first clocking of
5689 this item, the multiple CLOCK lines will be wrapped into a
5690 @code{:LOGBOOK:} drawer (see also the variable
5691 @code{org-clock-into-drawer}). When called with a @kbd{C-u} prefix argument,
5692 select the task from a list of recently clocked tasks. With two @kbd{C-u
5693 C-u} prefixes, clock into the task at point and mark it as the default task.
5694 The default task will always be available when selecting a clocking task,
5695 with letter @kbd{d}.@*
5696 @cindex property: CLOCK_MODELINE_TOTAL
5697 @cindex property: LAST_REPEAT
5698 @vindex org-clock-modeline-total
5699 While the clock is running, the current clocking time is shown in the mode
5700 line, along with the title of the task. The clock time shown will be all
5701 time ever clocked for this task and its children. If the task has an effort
5702 estimate (@pxref{Effort estimates}), the mode line displays the current
5703 clocking time against it@footnote{To add an effort estimate ``on the fly'',
5704 hook a function doing this to @code{org-clock-in-prepare-hook}.} If the task
5705 is a repeating one (@pxref{Repeated tasks}), only the time since the last
5706 reset of the task @footnote{as recorded by the @code{LAST_REPEAT} property}
5707 will be shown. More control over what time is shown can be exercised with
5708 the @code{CLOCK_MODELINE_TOTAL} property. It may have the values
5709 @code{current} to show only the current clocking instance, @code{today} to
5710 show all time clocked on this tasks today (see also the variable
5711 @code{org-extend-today-until}), @code{all} to include all time, or
5712 @code{auto} which is the default@footnote{See also the variable
5713 @code{org-clock-modeline-total}.}.@* Clicking with @kbd{mouse-1} onto the
5714 mode line entry will pop up a menu with clocking options.
5716 @orgcmd{C-c C-x C-o,org-clock-out}
5717 @vindex org-log-note-clock-out
5718 Stop the clock (clock-out). This inserts another timestamp at the same
5719 location where the clock was last started. It also directly computes
5720 the resulting time in inserts it after the time range as @samp{=>
5721 HH:MM}. See the variable @code{org-log-note-clock-out} for the
5722 possibility to record an additional note together with the clock-out
5723 timestamp@footnote{The corresponding in-buffer setting is:
5724 @code{#+STARTUP: lognoteclock-out}}.
5725 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
5726 Update the effort estimate for the current clock task.
5729 @orgcmdkkc{C-c C-c,C-c C-y,org-evaluate-time-range}
5730 Recompute the time interval after changing one of the timestamps. This
5731 is only necessary if you edit the timestamps directly. If you change
5732 them with @kbd{S-@key{cursor}} keys, the update is automatic.
5733 @orgcmd{C-c C-t,org-todo}
5734 Changing the TODO state of an item to DONE automatically stops the clock
5735 if it is running in this same item.
5736 @orgcmd{C-c C-x C-x,org-clock-cancel}
5737 Cancel the current clock. This is useful if a clock was started by
5738 mistake, or if you ended up working on something else.
5739 @orgcmd{C-c C-x C-j,org-clock-goto}
5740 Jump to the headline of the currently clocked in task. With a @kbd{C-u}
5741 prefix arg, select the target task from a list of recently clocked tasks.
5742 @orgcmd{C-c C-x C-d,org-clock-display}
5743 @vindex org-remove-highlights-with-change
5744 Display time summaries for each subtree in the current buffer. This
5745 puts overlays at the end of each headline, showing the total time
5746 recorded under that heading, including the time of any subheadings. You
5747 can use visibility cycling to study the tree, but the overlays disappear
5748 when you change the buffer (see variable
5749 @code{org-remove-highlights-with-change}) or press @kbd{C-c C-c}.
5752 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
5753 the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
5754 worked on or closed during a day.
5756 @node The clock table, Resolving idle time, Clocking commands, Clocking work time
5757 @subsection The clock table
5758 @cindex clocktable, dynamic block
5759 @cindex report, of clocked time
5761 Org mode can produce quite complex reports based on the time clocking
5762 information. Such a report is called a @emph{clock table}, because it is
5763 formatted as one or several Org tables.
5766 @orgcmd{C-c C-x C-r,org-clock-report}
5767 Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
5768 report as an Org-mode table into the current file. When the cursor is
5769 at an existing clock table, just update it. When called with a prefix
5770 argument, jump to the first clock report in the current document and
5772 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
5773 Update dynamic block at point. The cursor needs to be in the
5774 @code{#+BEGIN} line of the dynamic block.
5775 @orgkey{C-u C-c C-x C-u}
5776 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
5777 you have several clock table blocks in a buffer.
5778 @orgcmdkxkc{S-@key{left},S-@key{right},org-clocktable-try-shift}
5779 Shift the current @code{:block} interval and update the table. The cursor
5780 needs to be in the @code{#+BEGIN: clocktable} line for this command. If
5781 @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
5785 Here is an example of the frame for a clock table as it is inserted into the
5786 buffer with the @kbd{C-c C-x C-r} command:
5788 @cindex #+BEGIN, clocktable
5790 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
5794 @vindex org-clocktable-defaults
5795 The @samp{BEGIN} line and specify a number of options to define the scope,
5796 structure, and formatting of the report. Defaults for all these options can
5797 be configured in the variable @code{org-clocktable-defaults}.
5799 @noindent First there are options that determine which clock entries are to
5802 :maxlevel @r{Maximum level depth to which times are listed in the table.}
5803 @r{Clocks at deeper levels will be summed into the upper level.}
5804 :scope @r{The scope to consider. This can be any of the following:}
5805 nil @r{the current buffer or narrowed region}
5806 file @r{the full current buffer}
5807 subtree @r{the subtree where the clocktable is located}
5808 tree@var{N} @r{the surrounding level @var{N} tree, for example @code{tree3}}
5809 tree @r{the surrounding level 1 tree}
5810 agenda @r{all agenda files}
5811 ("file"..) @r{scan these files}
5812 file-with-archives @r{current file and its archives}
5813 agenda-with-archives @r{all agenda files, including archives}
5814 :block @r{The time block to consider. This block is specified either}
5815 @r{absolute, or relative to the current time and may be any of}
5817 2007-12-31 @r{New year eve 2007}
5818 2007-12 @r{December 2007}
5819 2007-W50 @r{ISO-week 50 in 2007}
5820 2007-Q2 @r{2nd quarter in 2007}
5821 2007 @r{the year 2007}
5822 today, yesterday, today-@var{N} @r{a relative day}
5823 thisweek, lastweek, thisweek-@var{N} @r{a relative week}
5824 thismonth, lastmonth, thismonth-@var{N} @r{a relative month}
5825 thisyear, lastyear, thisyear-@var{N} @r{a relative year}
5826 @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
5827 :tstart @r{A time string specifying when to start considering times.}
5828 :tend @r{A time string specifying when to stop considering times.}
5829 :step @r{@code{week} or @code{day}, to split the table into chunks.}
5830 @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
5831 :stepskip0 @r{Do not show steps that have zero time.}
5832 :fileskip0 @r{Do not show table sections from files which did not contribute.}
5833 :tags @r{A tags match to select entries that should contribute}.
5836 Then there are options which determine the formatting of the table. There
5837 options are interpreted by the function @code{org-clocktable-write-default},
5838 but you can specify your own function using the @code{:formatter} parameter.
5840 :emphasize @r{When @code{t}, emphasize level one and level two items.}
5841 :link @r{Link the item headlines in the table to their origins.}
5842 :narrow @r{An integer to limit the width of the headline column in}
5843 @r{the org table. If you write it like @samp{50!}, then the}
5844 @r{headline will also be shortened in export.}
5845 :indent @r{Indent each headline field according to its level.}
5846 :tcolumns @r{Number of columns to be used for times. If this is smaller}
5847 @r{than @code{:maxlevel}, lower levels will be lumped into one column.}
5848 :level @r{Should a level number column be included?}
5849 :compact @r{Abbreviation for @code{:level nil :indent t :narrow 40! :tcolumns 1}}
5850 @r{All are overwritten except if there is an explicit @code{:narrow}}
5851 :timestamp @r{A timestamp for the entry, when available. Look for SCHEDULED,}
5852 @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.}
5853 :formula @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
5854 @r{As a special case, @samp{:formula %} adds a column with % time.}
5855 @r{If you do not specify a formula here, any existing formula}
5856 @r{below the clock table will survive updates and be evaluated.}
5857 :formatter @r{A function to format clock data and insert it into the buffer.}
5859 To get a clock summary of the current level 1 tree, for the current
5860 day, you could write
5862 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
5866 and to use a specific time range you could write@footnote{Note that all
5867 parameters must be specified in a single line---the line is broken here
5868 only to fit it into the manual.}
5870 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
5871 :tend "<2006-08-10 Thu 12:00>"
5874 A summary of the current subtree with % times would be
5876 #+BEGIN: clocktable :scope subtree :link t :formula %
5879 A horizontally compact representation of everything clocked during last week
5882 #+BEGIN: clocktable :scope agenda :block lastweek :compact t
5886 @node Resolving idle time, , The clock table, Clocking work time
5887 @subsection Resolving idle time
5888 @cindex resolve idle time
5890 @cindex idle, resolve, dangling
5891 If you clock in on a work item, and then walk away from your
5892 computer---perhaps to take a phone call---you often need to ``resolve'' the
5893 time you were away by either subtracting it from the current clock, or
5894 applying it to another one.
5896 @vindex org-clock-idle-time
5897 By customizing the variable @code{org-clock-idle-time} to some integer, such
5898 as 10 or 15, Emacs can alert you when you get back to your computer after
5899 being idle for that many minutes@footnote{On computers using Mac OS X,
5900 idleness is based on actual user idleness, not just Emacs' idle time. For
5901 X11, you can install a utility program @file{x11idle.c}, available in the
5902 UTILITIES directory of the Org git distribution, to get the same general
5903 treatment of idleness. On other systems, idle time refers to Emacs idle time
5904 only.}, and ask what you want to do with the idle time. There will be a
5905 question waiting for you when you get back, indicating how much idle time has
5906 passed (constantly updated with the current amount), as well as a set of
5907 choices to correct the discrepancy:
5911 To keep some or all of the minutes and stay clocked in, press @kbd{k}. Org
5912 will ask how many of the minutes to keep. Press @key{RET} to keep them all,
5913 effectively changing nothing, or enter a number to keep that many minutes.
5915 If you use the shift key and press @kbd{K}, it will keep however many minutes
5916 you request and then immediately clock out of that task. If you keep all of
5917 the minutes, this is the same as just clocking out of the current task.
5919 To keep none of the minutes, use @kbd{s} to subtract all the away time from
5920 the clock, and then check back in from the moment you returned.
5922 To keep none of the minutes and just clock out at the start of the away time,
5923 use the shift key and press @kbd{S}. Remember that using shift will always
5924 leave you clocked out, no matter which option you choose.
5926 To cancel the clock altogether, use @kbd{C}. Note that if instead of
5927 canceling you subtract the away time, and the resulting clock amount is less
5928 than a minute, the clock will still be canceled rather than clutter up the
5929 log with an empty entry.
5932 What if you subtracted those away minutes from the current clock, and now
5933 want to apply them to a new clock? Simply clock in to any task immediately
5934 after the subtraction. Org will notice that you have subtracted time ``on
5935 the books'', so to speak, and will ask if you want to apply those minutes to
5936 the next task you clock in on.
5938 There is one other instance when this clock resolution magic occurs. Say you
5939 were clocked in and hacking away, and suddenly your cat chased a mouse who
5940 scared a hamster that crashed into your UPS's power button! You suddenly
5941 lose all your buffers, but thanks to auto-save you still have your recent Org
5942 mode changes, including your last clock in.
5944 If you restart Emacs and clock into any task, Org will notice that you have a
5945 dangling clock which was never clocked out from your last session. Using
5946 that clock's starting time as the beginning of the unaccounted-for period,
5947 Org will ask how you want to resolve that time. The logic and behavior is
5948 identical to dealing with away time due to idleness; it's just happening due
5949 to a recovery event rather than a set amount of idle time.
5951 You can also check all the files visited by your Org agenda for dangling
5952 clocks at any time using @kbd{M-x org-resolve-clocks}.
5954 @node Effort estimates, Relative timer, Clocking work time, Dates and Times
5955 @section Effort estimates
5956 @cindex effort estimates
5958 @cindex property, Effort
5959 @vindex org-effort-property
5960 If you want to plan your work in a very detailed way, or if you need to
5961 produce offers with quotations of the estimated work effort, you may want to
5962 assign effort estimates to entries. If you are also clocking your work, you
5963 may later want to compare the planned effort with the actual working time, a
5964 great way to improve planning estimates. Effort estimates are stored in a
5965 special property @samp{Effort}@footnote{You may change the property being
5966 used with the variable @code{org-effort-property}.}. You can set the effort
5967 for an entry with the following commands:
5970 @orgcmd{C-c C-x e,org-set-effort}
5971 Set the effort estimate for the current entry. With a numeric prefix
5972 argument, set it to the Nth allowed value (see below). This command is also
5973 accessible from the agenda with the @kbd{e} key.
5974 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
5975 Modify the effort estimate of the item currently being clocked.
5978 Clearly the best way to work with effort estimates is through column view
5979 (@pxref{Column view}). You should start by setting up discrete values for
5980 effort estimates, and a @code{COLUMNS} format that displays these values
5981 together with clock sums (if you want to clock your time). For a specific
5985 #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00
5986 #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
5990 @vindex org-global-properties
5991 @vindex org-columns-default-format
5992 or, even better, you can set up these values globally by customizing the
5993 variables @code{org-global-properties} and @code{org-columns-default-format}.
5994 In particular if you want to use this setup also in the agenda, a global
5995 setup may be advised.
5997 The way to assign estimates to individual items is then to switch to column
5998 mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
5999 value. The values you enter will immediately be summed up in the hierarchy.
6000 In the column next to it, any clocked time will be displayed.
6002 @vindex org-agenda-columns-add-appointments-to-effort-sum
6003 If you switch to column view in the daily/weekly agenda, the effort column
6004 will summarize the estimated work effort for each day@footnote{Please note
6005 the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
6006 column view}).}, and you can use this to find space in your schedule. To get
6007 an overview of the entire part of the day that is committed, you can set the
6008 option @code{org-agenda-columns-add-appointments-to-effort-sum}. The
6009 appointments on a day that take place over a specified time interval will
6010 then also be added to the load estimate of the day.
6012 Effort estimates can be used in secondary agenda filtering that is triggered
6013 with the @kbd{/} key in the agenda (@pxref{Agenda commands}). If you have
6014 these estimates defined consistently, two or three key presses will narrow
6015 down the list to stuff that fits into an available time slot.
6017 @node Relative timer, Countdown timer, Effort estimates, Dates and Times
6018 @section Taking notes with a relative timer
6019 @cindex relative timer
6021 When taking notes during, for example, a meeting or a video viewing, it can
6022 be useful to have access to times relative to a starting time. Org provides
6023 such a relative timer and make it easy to create timed notes.
6026 @orgcmd{C-c C-x .,org-timer}
6027 Insert a relative time into the buffer. The first time you use this, the
6028 timer will be started. When called with a prefix argument, the timer is
6030 @orgcmd{C-c C-x -,org-timer-item}
6031 Insert a description list item with the current relative time. With a prefix
6032 argument, first reset the timer to 0.
6033 @orgcmd{M-@key{RET},org-insert-heading}
6034 Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
6036 @c for key sequences with a comma, command name macros fail :(
6039 Pause the timer, or continue it if it is already paused
6040 (@command{org-timer-pause-or-continue}).
6041 @c removed the sentence because it is redundant to the following item
6042 @kindex C-u C-c C-x ,
6044 Stop the timer. After this, you can only start a new timer, not continue the
6045 old one. This command also removes the timer from the mode line.
6046 @orgcmd{C-c C-x 0,org-timer-start}
6047 Reset the timer without inserting anything into the buffer. By default, the
6048 timer is reset to 0. When called with a @kbd{C-u} prefix, reset the timer to
6049 specific starting offset. The user is prompted for the offset, with a
6050 default taken from a timer string at point, if any, So this can be used to
6051 restart taking notes after a break in the process. When called with a double
6052 prefix argument @kbd{C-u C-u}, change all timer strings in the active region
6053 by a certain amount. This can be used to fix timer strings if the timer was
6054 not started at exactly the right moment.
6057 @node Countdown timer, , Relative timer, Dates and Times
6058 @section Countdown timer
6059 @cindex Countdown timer
6063 Calling @code{org-timer-set-timer} from an Org-mode buffer runs a countdown
6064 timer. Use @key{;} from agenda buffers, @key{C-c C-x ;} everwhere else.
6066 @code{org-timer-set-timer} prompts the user for a duration and displays a
6067 countdown timer in the modeline. @code{org-timer-default-timer} sets the
6068 default countdown value. Giving a prefix numeric argument overrides this
6071 @node Capture - Refile - Archive, Agenda Views, Dates and Times, Top
6072 @chapter Capture - Refile - Archive
6075 An important part of any organization system is the ability to quickly
6076 capture new ideas and tasks, and to associate reference material with them.
6077 Org does this using a process called @i{capture}. It also can store files
6078 related to a task (@i{attachments}) in a special directory. Once in the
6079 system, tasks and projects need to be moved around. Moving completed project
6080 trees to an archive file keeps the system compact and fast.
6083 * Capture:: Capturing new stuff
6084 * Attachments:: Add files to tasks
6085 * RSS Feeds:: Getting input from RSS feeds
6086 * Protocols:: External (e.g. Browser) access to Emacs and Org
6087 * Refiling notes:: Moving a tree from one place to another
6088 * Archiving:: What to do with finished projects
6091 @node Capture, Attachments, Capture - Refile - Archive, Capture - Refile - Archive
6095 Org's method for capturing new items is heavily inspired by John Wiegley
6096 excellent remember package. Up to version 6.36 Org used a special setup
6097 for @file{remember.el}. @file{org-remember.el} is still part of Org-mode for
6098 backward compatibility with existing setups. You can find the documentation
6099 for org-remember at @url{http://orgmode.org/org-remember.pdf}.
6101 The new capturing setup described here is preferred and should be used by new
6102 users. To convert your @code{org-remember-templates}, run the command
6104 @kbd{M-x org-capture-import-remember-templates @key{RET}}
6106 @noindent and then customize the new variable with @kbd{M-x
6107 customize-variable org-capture-templates}, check the result, and save the
6108 customization. You can then use both remember and capture until
6109 you are familiar with the new mechanism.
6111 Capture lets you quickly store notes with little interruption of your work
6112 flow. The basic process of capturing is very similar to remember, but Org
6113 does enhance it with templates and more.
6116 * Setting up capture:: Where notes will be stored
6117 * Using capture:: Commands to invoke and terminate capture
6118 * Capture templates:: Define the outline of different note types
6121 @node Setting up capture, Using capture, Capture, Capture
6122 @subsection Setting up capture
6124 The following customization sets a default target file for notes, and defines
6125 a global key@footnote{Please select your own key, @kbd{C-c c} is only a
6126 suggestion.} for capturing new material.
6128 @vindex org-default-notes-file
6130 (setq org-default-notes-file (concat org-directory "/notes.org"))
6131 (define-key global-map "\C-cc" 'org-capture)
6134 @node Using capture, Capture templates, Setting up capture, Capture
6135 @subsection Using capture
6138 @orgcmd{C-c c,org-capture}
6139 Call the command @code{org-capture}. Note that this keybinding is global and
6140 not active by default - you need to install it. If you have templates
6141 defined @pxref{Capture templates}, it will offer these templates for
6142 selection or use a new Org outline node as the default template. It will
6143 insert the template into the target file and switch to an indirect buffer
6144 narrowed to this new node. You may then insert the information you want.
6146 @orgcmd{C-c C-c,org-capture-finalize}
6147 Once you have finished entering information into the capture buffer, @kbd{C-c
6148 C-c} will return you to the window configuration before the capture process,
6149 so that you can resume your work without further distraction. When called
6150 with a prefix arg, finalize and then jump to the captured item.
6152 @orgcmd{C-c C-w,org-capture-refile}
6153 Finalize the capture process by refiling (@pxref{Refiling notes}) the note to
6154 a different place. Please realize that this is a normal refiling command
6155 that will be executed---so the cursor position at the moment you run this
6156 command is important. If you have inserted a tree with a parent and
6157 children, first move the cursor back to the parent. Any prefix argument
6158 given to this command will be passed on to the @code{org-refile} command.
6160 @orgcmd{C-c C-k,org-capture-kill}
6161 Abort the capture process and return to the previous state.
6165 You can also call @code{org-capture} in a special way from the agenda, using
6166 the @kbd{k c} key combination. With this access, any timestamps inserted by
6167 the selected capture template will default to the cursor date in the agenda,
6168 rather than to the current date.
6170 To find the locations of the last stored capture, use @code{org-capture} with
6175 Visit the target location of a cpature template. You get to select the
6176 template in the usual way.
6177 @orgkey{C-u C-u C-c c}
6178 Visit the last stored capture item in its buffer.
6181 @node Capture templates, , Using capture, Capture
6182 @subsection Capture templates
6183 @cindex templates, for Capture
6185 You can use templates for different types of capture items, and
6186 for different target locations. The easiest way to create such templates is
6187 through the customize interface.
6191 Customize the variable @code{org-capture-templates}.
6194 Before we give the formal description of template definitions, let's look at
6195 an example. Say you would like to use one template to create general TODO
6196 entries, and you want to put these entries under the heading @samp{Tasks} in
6197 your file @file{~/org/gtd.org}. Also, a date tree in the file
6198 @file{journal.org} should capture journal entries. A possible configuration
6202 (setq org-capture-templates
6203 '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks")
6204 "* TODO %?\n %i\n %a")
6205 ("j" "Journal" entry (file+datetree "~/org/journal.org")
6206 "* %?\nEntered on %U\n %i\n %a")))
6209 @noindent If you then press @kbd{C-c c t}, Org will prepare the template
6213 [[file:@var{link to where you initiated capture}]]
6217 During expansion of the template, @code{%a} has been replaced by a link to
6218 the location from where you called the capture command. This can be
6219 extremely useful for deriving tasks from emails, for example. You fill in
6220 the task definition, press @code{C-c C-c} and Org returns you to the same
6221 place where you started the capture process.
6225 * Template elements:: What is needed for a complete template entry
6226 * Template expansion:: Filling in information about time and context
6229 @node Template elements, Template expansion, Capture templates, Capture templates
6230 @subsubsection Template elements
6232 Now lets look at the elements of a template definition. Each entry in
6233 @code{org-capture-templates} is a list with the following items:
6237 The keys that will select the template, as a string, characters
6238 only, for example @code{"a"} for a template to be selected with a
6239 single key, or @code{"bt"} for selection with two keys. When using
6240 several keys, keys using the same prefix key must be sequential
6241 in the list and preceded by a 2-element entry explaining the
6242 prefix key, for example
6244 ("b" "Templates for marking stuff to buy")
6246 @noindent If you do not define a template for the @kbd{C} key, this key will
6247 be used to open the customize buffer for this complex variable.
6250 A short string describing the template, which will be shown during
6254 The type of entry, a symbol. Valid values are:
6257 An Org-mode node, with a headline. Will be filed as the child of the
6258 target entry or as a top-level entry. The target file should be an Org-mode
6261 A plain list item, placed in the first plain list at the target
6262 location. Again the target file should be an Org file.
6264 A checkbox item. This only differs from the plain list item by the
6267 a new line in the first table at the target location. Where exactly the
6268 line will be inserted depends on the properties @code{:prepend} and
6269 @code{:table-line-pos} (see below).
6271 Text to be inserted as it is.
6275 @vindex org-default-notes-file
6276 Specification of where the captured item should be placed. In Org-mode
6277 files, targets usually define a node. Entries will become children of this
6278 node. Other types will be added to the table or list in the body of this
6279 node. Most target specifications contain a file name. If that file name is
6280 the empty string, it defaults to @code{org-default-notes-file}.
6284 @item (file "path/to/file")
6285 Text will be placed at the beginning or end of that file.
6287 @item (id "id of existing org entry")
6288 Filing as child of this entry, or in the body of the entry.
6290 @item (file+headline "path/to/file" "node headline")
6291 Fast configuration if the target heading is unique in the file.
6293 @item (file+olp "path/to/file" "Level 1 heading" "Level 2" ...)
6294 For non-unique headings, the full path is safer.
6296 @item (file+regexp "path/to/file" "regexp to find location")
6297 Use a regular expression to position the cursor.
6299 @item (file+datetree "path/to/file")
6300 Will create a heading in a date tree for today's date.
6302 @item (file+datetree+prompt "path/to/file")
6303 Will create a heading in a date tree, but will prompt for the date.
6305 @item (file+function "path/to/file" function-finding-location)
6306 A function to find the right location in the file.
6309 File to the entry that is currently being clocked.
6311 @item (function function-finding-location)
6312 Most general way, write your own function to find both
6317 The template for creating the capture item. If you leave this empty, an
6318 appropriate default template will be used. Otherwise this is a string with
6319 escape codes, which will be replaced depending on time and context of the
6320 capture call. The string with escapes may be loaded from a template file,
6321 using the special syntax @code{(file "path/to/template")}. See below for
6325 The rest of the entry is a property list of additional options.
6326 Recognized properties are:
6329 Normally new captured information will be appended at
6330 the target location (last child, last table line, last list item...).
6331 Setting this property will change that.
6333 @item :immediate-finish
6334 When set, do not offer to edit the information, just
6335 file it away immediately. This makes sense if the template only needs
6336 information that can be added automatically.
6339 Set this to the number of lines to insert
6340 before and after the new item. Default 0, only common other value is 1.
6343 Start the clock in this item.
6346 If starting the capture interrupted a clock, restart that clock when finished
6350 Do not narrow the target buffer, simply show the full buffer. Default is to
6351 narrow it so that you only see the new material.
6354 If the target file was not yet visited when capture was invoked, kill the
6355 buffer again after capture is completed.
6359 @node Template expansion, , Template elements, Capture templates
6360 @subsubsection Template expansion
6362 In the template itself, special @kbd{%}-escapes@footnote{If you need one of
6363 these sequences literally, escape the @kbd{%} with a backslash.} allow
6364 dynamic insertion of content:
6366 @comment SJE: should these sentences terminate in period?
6368 %^@{@var{prompt}@} @r{prompt the user for a string and replace this sequence with it.}
6369 @r{You may specify a default value and a completion table with}
6370 @r{%^@{prompt|default|completion2|completion3...@}}
6371 @r{The arrow keys access a prompt-specific history.}
6372 %a @r{annotation, normally the link created with @code{org-store-link}}
6373 %A @r{like @code{%a}, but prompt for the description part}
6374 %i @r{initial content, the region when capture is called while the}
6375 @r{region is active.}
6376 @r{The entire text will be indented like @code{%i} itself.}
6377 %t @r{timestamp, date only}
6378 %T @r{timestamp with date and time}
6379 %u, %U @r{like the above, but inactive timestamps}
6380 %^t @r{like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}}
6381 @r{You may define a prompt like @code{%^@{Birthday@}t}}
6382 %n @r{user name (taken from @code{user-full-name})}
6383 %c @r{Current kill ring head.}
6384 %x @r{Content of the X clipboard.}
6385 %^C @r{Interactive selection of which kill or clip to use.}
6386 %^L @r{Like @code{%^C}, but insert as link.}
6387 %k @r{title of the currently clocked task}
6388 %K @r{link to the currently clocked task}
6389 %^g @r{prompt for tags, with completion on tags in target file.}
6390 %^G @r{prompt for tags, with completion all tags in all agenda files.}
6391 %^@{@var{prop}@}p @r{Prompt the user for a value for property @var{prop}}
6392 %:keyword @r{specific information for certain link types, see below}
6393 %[@var{file}] @r{insert the contents of the file given by @var{file}}
6394 %(@var{sexp}) @r{evaluate Elisp @var{sexp} and replace with the result}
6398 For specific link types, the following keywords will be
6399 defined@footnote{If you define your own link types (@pxref{Adding
6400 hyperlink types}), any property you store with
6401 @code{org-store-link-props} can be accessed in capture templates in a
6404 @vindex org-from-is-user-regexp
6406 Link type | Available keywords
6407 -------------------+----------------------------------------------
6408 bbdb | %:name %:company
6409 irc | %:server %:port %:nick
6410 vm, wl, mh, mew, rmail | %:type %:subject %:message-id
6411 | %:from %:fromname %:fromaddress
6412 | %:to %:toname %:toaddress
6413 | %:date @r{(message date header field)}
6414 | %:date-timestamp @r{(date as active timestamp)}
6415 | %:date-timestamp-inactive @r{(date as inactive timestamp)}
6416 | %: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}.}}
6417 gnus | %:group, @r{for messages also all email fields}
6419 info | %:file %:node
6424 To place the cursor after template expansion use:
6427 %? @r{After completing the template, position cursor here.}
6431 @node Attachments, RSS Feeds, Capture, Capture - Refile - Archive
6432 @section Attachments
6435 @vindex org-attach-directory
6436 It is often useful to associate reference material with an outline node/task.
6437 Small chunks of plain text can simply be stored in the subtree of a project.
6438 Hyperlinks (@pxref{Hyperlinks}) can establish associations with
6439 files that live elsewhere on your computer or in the cloud, like emails or
6440 source code files belonging to a project. Another method is @i{attachments},
6441 which are files located in a directory belonging to an outline node. Org
6442 uses directories named by the unique ID of each entry. These directories are
6443 located in the @file{data} directory which lives in the same directory where
6444 your Org file lives@footnote{If you move entries or Org files from one
6445 directory to another, you may want to configure @code{org-attach-directory}
6446 to contain an absolute path.}. If you initialize this directory with
6447 @code{git init}, Org will automatically commit changes when it sees them.
6448 The attachment system has been contributed to Org by John Wiegley.
6450 In cases where it seems better to do so, you can also attach a directory of your
6451 choice to an entry. You can also make children inherit the attachment
6452 directory from a parent, so that an entire subtree uses the same attached
6455 @noindent The following commands deal with attachments:
6459 @orgcmd{C-c C-a,org-attach}
6460 The dispatcher for commands related to the attachment system. After these
6461 keys, a list of commands is displayed and you must press an additional key
6462 to select a command:
6465 @orgcmdtkc{a,C-c C-a a,org-attach-attach}
6466 @vindex org-attach-method
6467 Select a file and move it into the task's attachment directory. The file
6468 will be copied, moved, or linked, depending on @code{org-attach-method}.
6469 Note that hard links are not supported on all systems.
6475 Attach a file using the copy/move/link method.
6476 Note that hard links are not supported on all systems.
6478 @orgcmdtkc{n,C-c C-a n,org-attach-new}
6479 Create a new attachment as an Emacs buffer.
6481 @orgcmdtkc{z,C-c C-a z,org-attach-sync}
6482 Synchronize the current task with its attachment directory, in case you added
6483 attachments yourself.
6485 @orgcmdtkc{p,C-c C-a o,org-attach-open}
6486 @vindex org-file-apps
6487 Open current task's attachment. If there is more than one, prompt for a
6488 file name first. Opening will follow the rules set by @code{org-file-apps}.
6489 For more details, see the information on following hyperlinks
6490 (@pxref{Handling links}).
6492 @orgcmdtkc{O,C-c C-a O,org-attach-open-in-emacs}
6493 Also open the attachment, but force opening the file in Emacs.
6495 @orgcmdtkc{f,C-c C-a f,org-attach-reveal}
6496 Open the current task's attachment directory.
6498 @orgcmdtkc{F,C-c C-a F,org-attach-reveal-in-emacs}
6499 Also open the directory, but force using @command{dired} in Emacs.
6501 @orgcmdtkc{d,C-c C-a d,org-attach-delete-one}
6502 Select and delete a single attachment.
6504 @orgcmdtkc{D,C-c C-a D,org-attach-delete-all}
6505 Delete all of a task's attachments. A safer way is to open the directory in
6506 @command{dired} and delete from there.
6508 @orgcmdtkc{s,C-c C-a s,org-attach-set-directory}
6509 @cindex property, ATTACH_DIR
6510 Set a specific directory as the entry's attachment directory. This works by
6511 putting the directory path into the @code{ATTACH_DIR} property.
6513 @orgcmdtkc{i,C-c C-a i,org-attach-set-inherit}
6514 @cindex property, ATTACH_DIR_INHERIT
6515 Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
6516 same directory for attachments as the parent does.
6520 @node RSS Feeds, Protocols, Attachments, Capture - Refile - Archive
6525 Org can add and change entries based on information found in RSS feeds and
6526 Atom feeds. You could use this to make a task out of each new podcast in a
6527 podcast feed. Or you could use a phone-based note-creating service on the
6528 web to import tasks into Org. To access feeds, configure the variable
6529 @code{org-feed-alist}. The docstring of this variable has detailed
6530 information. Here is just an example:
6533 (setq org-feed-alist
6535 "http://rss.slashdot.org/Slashdot/slashdot"
6536 "~/txt/org/feeds.org" "Slashdot Entries")))
6540 will configure that new items from the feed provided by
6541 @code{rss.slashdot.org} will result in new entries in the file
6542 @file{~/org/feeds.org} under the heading @samp{Slashdot Entries}, whenever
6543 the following command is used:
6546 @orgcmd{C-c C-x g,org-feed-update-all}
6548 Collect items from the feeds configured in @code{org-feed-alist} and act upon
6550 @orgcmd{C-c C-x G,org-feed-goto-inbox}
6551 Prompt for a feed name and go to the inbox configured for this feed.
6554 Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which
6555 it will store information about the status of items in the feed, to avoid
6556 adding the same item several times. You should add @samp{FEEDSTATUS} to the
6557 list of drawers in that file:
6560 #+DRAWERS: LOGBOOK PROPERTIES FEEDSTATUS
6563 For more information, including how to read atom feeds, see
6564 @file{org-feed.el} and the docstring of @code{org-feed-alist}.
6566 @node Protocols, Refiling notes, RSS Feeds, Capture - Refile - Archive
6567 @section Protocols for external access
6568 @cindex protocols, for external access
6571 You can set up Org for handling protocol calls from outside applications that
6572 are passed to Emacs through the @file{emacsserver}. For example, you can
6573 configure bookmarks in your web browser to send a link to the current page to
6574 Org and create a note from it using capture (@pxref{Capture}). Or you
6575 could create a bookmark that will tell Emacs to open the local source file of
6576 a remote website you are looking at with the browser. See
6577 @uref{http://orgmode.org/worg/org-contrib/org-protocol.php} for detailed
6578 documentation and setup instructions.
6580 @node Refiling notes, Archiving, Protocols, Capture - Refile - Archive
6581 @section Refiling notes
6582 @cindex refiling notes
6584 When reviewing the captured data, you may want to refile some of the entries
6585 into a different list, for example into a project. Cutting, finding the
6586 right location, and then pasting the note is cumbersome. To simplify this
6587 process, you can use the following special command:
6590 @orgcmd{C-c C-w,org-refile}
6591 @vindex org-reverse-note-order
6592 @vindex org-refile-targets
6593 @vindex org-refile-use-outline-path
6594 @vindex org-outline-path-complete-in-steps
6595 @vindex org-refile-allow-creating-parent-nodes
6596 @vindex org-log-refile
6597 @vindex org-refile-use-cache
6598 Refile the entry or region at point. This command offers possible locations
6599 for refiling the entry and lets you select one with completion. The item (or
6600 all items in the region) is filed below the target heading as a subitem.
6601 Depending on @code{org-reverse-note-order}, it will be either the first or
6603 By default, all level 1 headlines in the current buffer are considered to be
6604 targets, but you can have more complex definitions across a number of files.
6605 See the variable @code{org-refile-targets} for details. If you would like to
6606 select a location via a file-path-like completion along the outline path, see
6607 the variables @code{org-refile-use-outline-path} and
6608 @code{org-outline-path-complete-in-steps}. If you would like to be able to
6609 create new nodes as new parents for refiling on the fly, check the
6610 variable @code{org-refile-allow-creating-parent-nodes}.
6611 When the variable @code{org-log-refile}@footnote{with corresponding
6612 @code{#+STARTUP} keywords @code{logrefile}, @code{lognoterefile},
6613 and @code{nologrefile}} is set, a time stamp or a note will be
6614 recorded when an entry has been refiled.
6615 @orgkey{C-u C-c C-w}
6616 Use the refile interface to jump to a heading.
6617 @orgcmd{C-u C-u C-c C-w,org-refile-goto-last-stored}
6618 Jump to the location where @code{org-refile} last moved a tree to.
6620 Refile as the child of the item currently being clocked.
6621 @item C-0 C-c C-w @ @r{or} @ C-u C-u C-u C-c C-w
6623 @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}
6625 Clear the target cache. Caching of refile targets can be turned on by
6626 setting @code{org-refile-use-cache}. To make the command see new possible
6627 targets, you have to clear the cache with this command.
6630 @node Archiving, , Refiling notes, Capture - Refile - Archive
6634 When a project represented by a (sub)tree is finished, you may want
6635 to move the tree out of the way and to stop it from contributing to the
6636 agenda. Archiving is important to keep your working files compact and global
6637 searches like the construction of agenda views fast.
6640 @orgcmd{C-c C-x C-a,org-archive-subtree-default}
6641 @vindex org-archive-default-command
6642 Archive the current entry using the command specified in the variable
6643 @code{org-archive-default-command}.
6647 * Moving subtrees:: Moving a tree to an archive file
6648 * Internal archiving:: Switch off a tree but keep it in the file
6651 @node Moving subtrees, Internal archiving, Archiving, Archiving
6652 @subsection Moving a tree to the archive file
6653 @cindex external archiving
6655 The most common archiving action is to move a project tree to another file,
6659 @orgcmdkskc{C-c C-x C-s,C-c $,org-archive-subtree}
6660 @vindex org-archive-location
6661 Archive the subtree starting at the cursor position to the location
6662 given by @code{org-archive-location}.
6663 @orgkey{C-u C-c C-x C-s}
6664 Check if any direct children of the current headline could be moved to
6665 the archive. To do this, each subtree is checked for open TODO entries.
6666 If none are found, the command offers to move it to the archive
6667 location. If the cursor is @emph{not} on a headline when this command
6668 is invoked, the level 1 trees will be checked.
6671 @cindex archive locations
6672 The default archive location is a file in the same directory as the
6673 current file, with the name derived by appending @file{_archive} to the
6674 current file name. For information and examples on how to change this,
6675 see the documentation string of the variable
6676 @code{org-archive-location}. There is also an in-buffer option for
6677 setting this variable, for example@footnote{For backward compatibility,
6678 the following also works: If there are several such lines in a file,
6679 each specifies the archive location for the text below it. The first
6680 such line also applies to any text before its definition. However,
6681 using this method is @emph{strongly} deprecated as it is incompatible
6682 with the outline structure of the document. The correct method for
6683 setting multiple archive locations in a buffer is using properties.}:
6687 #+ARCHIVE: %s_done::
6690 @cindex property, ARCHIVE
6692 If you would like to have a special ARCHIVE location for a single entry
6693 or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
6694 location as the value (@pxref{Properties and Columns}).
6696 @vindex org-archive-save-context-info
6697 When a subtree is moved, it receives a number of special properties that
6698 record context information like the file from where the entry came, its
6699 outline path the archiving time etc. Configure the variable
6700 @code{org-archive-save-context-info} to adjust the amount of information
6704 @node Internal archiving, , Moving subtrees, Archiving
6705 @subsection Internal archiving
6707 If you want to just switch off (for agenda views) certain subtrees without
6708 moving them to a different file, you can use the @code{ARCHIVE tag}.
6710 A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
6711 its location in the outline tree, but behaves in the following way:
6714 @vindex org-cycle-open-archived-trees
6715 It does not open when you attempt to do so with a visibility cycling
6716 command (@pxref{Visibility cycling}). You can force cycling archived
6717 subtrees with @kbd{C-@key{TAB}}, or by setting the option
6718 @code{org-cycle-open-archived-trees}. Also normal outline commands like
6719 @code{show-all} will open archived subtrees.
6721 @vindex org-sparse-tree-open-archived-trees
6722 During sparse tree construction (@pxref{Sparse trees}), matches in
6723 archived subtrees are not exposed, unless you configure the option
6724 @code{org-sparse-tree-open-archived-trees}.
6726 @vindex org-agenda-skip-archived-trees
6727 During agenda view construction (@pxref{Agenda Views}), the content of
6728 archived trees is ignored unless you configure the option
6729 @code{org-agenda-skip-archived-trees}, in which case these trees will always
6730 be included. In the agenda you can press @kbd{v a} to get archives
6731 temporarily included.
6733 @vindex org-export-with-archived-trees
6734 Archived trees are not exported (@pxref{Exporting}), only the headline
6735 is. Configure the details using the variable
6736 @code{org-export-with-archived-trees}.
6738 @vindex org-columns-skip-archived-trees
6739 Archived trees are excluded from column view unless the variable
6740 @code{org-columns-skip-archived-trees} is configured to @code{nil}.
6743 The following commands help manage the ARCHIVE tag:
6746 @orgcmd{C-c C-x a,org-toggle-archive-tag}
6747 Toggle the ARCHIVE tag for the current headline. When the tag is set,
6748 the headline changes to a shadowed face, and the subtree below it is
6750 @orgkey{C-u C-c C-x a}
6751 Check if any direct children of the current headline should be archived.
6752 To do this, each subtree is checked for open TODO entries. If none are
6753 found, the command offers to set the ARCHIVE tag for the child. If the
6754 cursor is @emph{not} on a headline when this command is invoked, the
6755 level 1 trees will be checked.
6756 @orgcmd{C-@kbd{TAB},org-force-cycle-archived}
6757 Cycle a tree even if it is tagged with ARCHIVE.
6758 @orgcmd{C-c C-x A,org-archive-to-archive-sibling}
6759 Move the current entry to the @emph{Archive Sibling}. This is a sibling of
6760 the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}. The
6761 entry becomes a child of that sibling and in this way retains a lot of its
6762 original context, including inherited tags and approximate position in the
6767 @node Agenda Views, Markup, Capture - Refile - Archive, Top
6768 @chapter Agenda views
6769 @cindex agenda views
6771 Due to the way Org works, TODO items, time-stamped items, and
6772 tagged headlines can be scattered throughout a file or even a number of
6773 files. To get an overview of open action items, or of events that are
6774 important for a particular date, this information must be collected,
6775 sorted and displayed in an organized way.
6777 Org can select items based on various criteria and display them
6778 in a separate buffer. Seven different view types are provided:
6782 an @emph{agenda} that is like a calendar and shows information
6785 a @emph{TODO list} that covers all unfinished
6788 a @emph{match view}, showings headlines based on the tags, properties, and
6789 TODO state associated with them,
6791 a @emph{timeline view} that shows all events in a single Org file,
6792 in time-sorted view,
6794 a @emph{text search view} that shows all entries from multiple files
6795 that contain specified keywords,
6797 a @emph{stuck projects view} showing projects that currently don't move
6800 @emph{custom views} that are special searches and combinations of different
6805 The extracted information is displayed in a special @emph{agenda
6806 buffer}. This buffer is read-only, but provides commands to visit the
6807 corresponding locations in the original Org files, and even to
6808 edit these files remotely.
6810 @vindex org-agenda-window-setup
6811 @vindex org-agenda-restore-windows-after-quit
6812 Two variables control how the agenda buffer is displayed and whether the
6813 window configuration is restored when the agenda exits:
6814 @code{org-agenda-window-setup} and
6815 @code{org-agenda-restore-windows-after-quit}.
6818 * Agenda files:: Files being searched for agenda information
6819 * Agenda dispatcher:: Keyboard access to agenda views
6820 * Built-in agenda views:: What is available out of the box?
6821 * Presentation and sorting:: How agenda items are prepared for display
6822 * Agenda commands:: Remote editing of Org trees
6823 * Custom agenda views:: Defining special searches and views
6824 * Exporting Agenda Views:: Writing a view to a file
6825 * Agenda column view:: Using column view for collected entries
6828 @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views
6829 @section Agenda files
6830 @cindex agenda files
6831 @cindex files for agenda
6833 @vindex org-agenda-files
6834 The information to be shown is normally collected from all @emph{agenda
6835 files}, the files listed in the variable
6836 @code{org-agenda-files}@footnote{If the value of that variable is not a
6837 list, but a single file name, then the list of agenda files will be
6838 maintained in that external file.}. If a directory is part of this list,
6839 all files with the extension @file{.org} in this directory will be part
6842 Thus, even if you only work with a single Org file, that file should
6843 be put into the list@footnote{When using the dispatcher, pressing
6844 @kbd{<} before selecting a command will actually limit the command to
6845 the current file, and ignore @code{org-agenda-files} until the next
6846 dispatcher command.}. You can customize @code{org-agenda-files}, but
6847 the easiest way to maintain it is through the following commands
6849 @cindex files, adding to agenda list
6851 @orgcmd{C-c [,org-agenda-to-front}
6852 Add current file to the list of agenda files. The file is added to
6853 the front of the list. If it was already in the list, it is moved to
6854 the front. With a prefix argument, file is added/moved to the end.
6855 @orgcmd{C-c ],org-remove-file}
6856 Remove current file from the list of agenda files.
6858 @orgcmd{C-',org-cycle-agenda-files}
6860 Cycle through agenda file list, visiting one file after the other.
6861 @kindex M-x org-iswitchb
6862 @item M-x org-iswitchb
6863 Command to use an @code{iswitchb}-like interface to switch to and between Org
6868 The Org menu contains the current list of files and can be used
6869 to visit any of them.
6871 If you would like to focus the agenda temporarily on a file not in
6872 this list, or on just one file in the list, or even on only a subtree in a
6873 file, then this can be done in different ways. For a single agenda command,
6874 you may press @kbd{<} once or several times in the dispatcher
6875 (@pxref{Agenda dispatcher}). To restrict the agenda scope for an
6876 extended period, use the following commands:
6879 @orgcmd{C-c C-x <,org-agenda-set-restriction-lock}
6880 Permanently restrict the agenda to the current subtree. When with a
6881 prefix argument, or with the cursor before the first headline in a file,
6882 the agenda scope is set to the entire file. This restriction remains in
6883 effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
6884 or @kbd{>} in the agenda dispatcher. If there is a window displaying an
6885 agenda view, the new restriction takes effect immediately.
6886 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
6887 Remove the permanent restriction created by @kbd{C-c C-x <}.
6891 When working with @file{speedbar.el}, you can use the following commands in
6894 @orgcmdtkc{< @r{in the speedbar frame},<,org-speedbar-set-agenda-restriction}
6895 Permanently restrict the agenda to the item---either an Org file or a subtree
6896 in such a file---at the cursor in the Speedbar frame.
6897 If there is a window displaying an agenda view, the new restriction takes
6899 @orgcmdtkc{> @r{in the speedbar frame},>,org-agenda-remove-restriction-lock}
6900 Lift the restriction.
6903 @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views
6904 @section The agenda dispatcher
6905 @cindex agenda dispatcher
6906 @cindex dispatching agenda commands
6907 The views are created through a dispatcher, which should be bound to a
6908 global key---for example @kbd{C-c a} (@pxref{Installation}). In the
6909 following we will assume that @kbd{C-c a} is indeed how the dispatcher
6910 is accessed and list keyboard access to commands accordingly. After
6911 pressing @kbd{C-c a}, an additional letter is required to execute a
6912 command. The dispatcher offers the following default commands:
6915 Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
6917 Create a list of all TODO items (@pxref{Global TODO list}).
6919 Create a list of headlines matching a TAGS expression (@pxref{Matching
6920 tags and properties}).
6922 Create the timeline view for the current buffer (@pxref{Timeline}).
6924 Create a list of entries selected by a boolean expression of keywords
6925 and/or regular expressions that must or must not occur in the entry.
6927 @vindex org-agenda-text-search-extra-files
6928 Search for a regular expression in all agenda files and additionally in
6929 the files listed in @code{org-agenda-text-search-extra-files}. This
6930 uses the Emacs command @code{multi-occur}. A prefix argument can be
6931 used to specify the number of context lines for each match, default is
6934 Create a list of stuck projects (@pxref{Stuck projects}).
6936 Restrict an agenda command to the current buffer@footnote{For backward
6937 compatibility, you can also press @kbd{1} to restrict to the current
6938 buffer.}. After pressing @kbd{<}, you still need to press the character
6939 selecting the command.
6941 If there is an active region, restrict the following agenda command to
6942 the region. Otherwise, restrict it to the current subtree@footnote{For
6943 backward compatibility, you can also press @kbd{0} to restrict to the
6944 current region/subtree.}. After pressing @kbd{< <}, you still need to press the
6945 character selecting the command.
6948 You can also define custom commands that will be accessible through the
6949 dispatcher, just like the default commands. This includes the
6950 possibility to create extended agenda buffers that contain several
6951 blocks together, for example the weekly agenda, the global TODO list and
6952 a number of special tags matches. @xref{Custom agenda views}.
6954 @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda Views
6955 @section The built-in agenda views
6957 In this section we describe the built-in views.
6960 * Weekly/daily agenda:: The calendar page with current tasks
6961 * Global TODO list:: All unfinished action items
6962 * Matching tags and properties:: Structured information with fine-tuned search
6963 * Timeline:: Time-sorted view for single file
6964 * Search view:: Find entries by searching for text
6965 * Stuck projects:: Find projects you need to review
6968 @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views
6969 @subsection The weekly/daily agenda
6971 @cindex weekly agenda
6972 @cindex daily agenda
6974 The purpose of the weekly/daily @emph{agenda} is to act like a page of a
6975 paper agenda, showing all the tasks for the current week or day.
6978 @cindex org-agenda, command
6979 @orgcmd{C-c a a,org-agenda-list}
6980 Compile an agenda for the current week from a list of Org files. The agenda
6981 shows the entries for each day. With a numeric prefix@footnote{For backward
6982 compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
6983 listed before the agenda. This feature is deprecated, use the dedicated TODO
6984 list, or a block agenda instead (@pxref{Block agenda}).} (like @kbd{C-u 2 1
6985 C-c a a}) you may set the number of days to be displayed.
6988 @vindex org-agenda-span
6989 @vindex org-agenda-ndays
6990 The default number of days displayed in the agenda is set by the variable
6991 @code{org-agenda-span} (or the obsolete @code{org-agenda-ndays}). This
6992 variable can be set to any number of days you want to see by default in the
6993 agenda, or to a span name, such a @code{day}, @code{week}, @code{month} or
6996 Remote editing from the agenda buffer means, for example, that you can
6997 change the dates of deadlines and appointments from the agenda buffer.
6998 The commands available in the Agenda buffer are listed in @ref{Agenda
7001 @subsubheading Calendar/Diary integration
7002 @cindex calendar integration
7003 @cindex diary integration
7005 Emacs contains the calendar and diary by Edward M. Reingold. The
7006 calendar displays a three-month calendar with holidays from different
7007 countries and cultures. The diary allows you to keep track of
7008 anniversaries, lunar phases, sunrise/set, recurrent appointments
7009 (weekly, monthly) and more. In this way, it is quite complementary to
7010 Org. It can be very useful to combine output from Org with
7013 In order to include entries from the Emacs diary into Org-mode's
7014 agenda, you only need to customize the variable
7017 (setq org-agenda-include-diary t)
7020 @noindent After that, everything will happen automatically. All diary
7021 entries including holidays, anniversaries, etc., will be included in the
7022 agenda buffer created by Org-mode. @key{SPC}, @key{TAB}, and
7023 @key{RET} can be used from the agenda buffer to jump to the diary
7024 file in order to edit existing diary entries. The @kbd{i} command to
7025 insert new entries for the current date works in the agenda buffer, as
7026 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
7027 Sunrise/Sunset times, show lunar phases and to convert to other
7028 calendars, respectively. @kbd{c} can be used to switch back and forth
7029 between calendar and agenda.
7031 If you are using the diary only for sexp entries and holidays, it is
7032 faster to not use the above setting, but instead to copy or even move
7033 the entries into an Org file. Org-mode evaluates diary-style sexp
7034 entries, and does it faster because there is no overhead for first
7035 creating the diary display. Note that the sexp entries must start at
7036 the left margin, no whitespace is allowed before them. For example,
7037 the following segment of an Org file will be processed and entries
7038 will be made in the agenda:
7041 * Birthdays and similar stuff
7043 %%(org-calendar-holiday) ; special function for holiday names
7045 %%(diary-anniversary 5 14 1956)@footnote{Note that the order of the arguments (month, day, year) depends on the setting of @code{calendar-date-style}.} Arthur Dent is %d years old
7046 %%(diary-anniversary 10 2 1869) Mahatma Gandhi would be %d years old
7049 @subsubheading Anniversaries from BBDB
7050 @cindex BBDB, anniversaries
7051 @cindex anniversaries, from BBDB
7053 If you are using the Big Brothers Database to store your contacts, you will
7054 very likely prefer to store anniversaries in BBDB rather than in a
7055 separate Org or diary file. Org supports this and will show BBDB
7056 anniversaries as part of the agenda. All you need to do is to add the
7057 following to one your your agenda files:
7064 %%(org-bbdb-anniversaries)
7067 You can then go ahead and define anniversaries for a BBDB record. Basically,
7068 you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB
7069 record and then add the date in the format @code{YYYY-MM-DD}, followed by a
7070 space and the class of the anniversary (@samp{birthday} or @samp{wedding}, or
7071 a format string). If you omit the class, it will default to @samp{birthday}.
7072 Here are a few examples, the header for the file @file{org-bbdb.el} contains
7073 more detailed information.
7078 2008-04-14 %s released version 6.01 of org-mode, %d years ago
7081 After a change to BBDB, or for the first agenda display during an Emacs
7082 session, the agenda display will suffer a short delay as Org updates its
7083 hash with anniversaries. However, from then on things will be very fast---much
7084 faster in fact than a long list of @samp{%%(diary-anniversary)} entries
7085 in an Org or Diary file.
7087 @subsubheading Appointment reminders
7088 @cindex @file{appt.el}
7089 @cindex appointment reminders
7091 Org can interact with Emacs appointments notification facility. To add all
7092 the appointments of your agenda files, use the command
7093 @code{org-agenda-to-appt}. This command also lets you filter through the
7094 list of your appointments and add only those belonging to a specific category
7095 or matching a regular expression. See the docstring for details.
7097 @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views
7098 @subsection The global TODO list
7099 @cindex global TODO list
7100 @cindex TODO list, global
7102 The global TODO list contains all unfinished TODO items formatted and
7103 collected into a single place.
7106 @orgcmd{C-c a t,org-todo-list}
7107 Show the global TODO list. This collects the TODO items from all agenda
7108 files (@pxref{Agenda Views}) into a single buffer. By default, this lists
7109 items with a state the is not a DONE state. The buffer is in
7110 @code{agenda-mode}, so there are commands to examine and manipulate the TODO
7111 entries directly from that buffer (@pxref{Agenda commands}).
7112 @orgcmd{C-c a T,org-todo-list}
7113 @cindex TODO keyword matching
7114 @vindex org-todo-keywords
7115 Like the above, but allows selection of a specific TODO keyword. You can
7116 also do this by specifying a prefix argument to @kbd{C-c a t}. You are
7117 prompted for a keyword, and you may also specify several keywords by
7118 separating them with @samp{|} as the boolean OR operator. With a numeric
7119 prefix, the Nth keyword in @code{org-todo-keywords} is selected.
7121 The @kbd{r} key in the agenda buffer regenerates it, and you can give
7122 a prefix argument to this command to change the selected TODO keyword,
7123 for example @kbd{3 r}. If you often need a search for a specific
7124 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
7125 Matching specific TODO keywords can also be done as part of a tags
7126 search (@pxref{Tag searches}).
7129 Remote editing of TODO items means that you can change the state of a
7130 TODO entry with a single key press. The commands available in the
7131 TODO list are described in @ref{Agenda commands}.
7133 @cindex sublevels, inclusion into TODO list
7134 Normally the global TODO list simply shows all headlines with TODO
7135 keywords. This list can become very long. There are two ways to keep
7139 @vindex org-agenda-todo-ignore-scheduled
7140 @vindex org-agenda-todo-ignore-deadlines
7141 @vindex org-agenda-todo-ignore-timestamp
7142 @vindex org-agenda-todo-ignore-with-date
7143 Some people view a TODO item that has been @emph{scheduled} for execution or
7144 have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}.
7145 Configure the variables @code{org-agenda-todo-ignore-scheduled},
7146 @code{org-agenda-todo-ignore-deadlines},
7147 @code{org-agenda-todo-ignore-timestamp} and/or
7148 @code{org-agenda-todo-ignore-with-date} to exclude such items from the global
7151 @vindex org-agenda-todo-list-sublevels
7152 TODO items may have sublevels to break up the task into subtasks. In
7153 such cases it may be enough to list only the highest level TODO headline
7154 and omit the sublevels from the global list. Configure the variable
7155 @code{org-agenda-todo-list-sublevels} to get this behavior.
7158 @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views
7159 @subsection Matching tags and properties
7160 @cindex matching, of tags
7161 @cindex matching, of properties
7165 If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}),
7166 or have properties (@pxref{Properties and Columns}), you can select headlines
7167 based on this metadata and collect them into an agenda buffer. The match
7168 syntax described here also applies when creating sparse trees with @kbd{C-c /
7172 @orgcmd{C-c a m,org-tags-view}
7173 Produce a list of all headlines that match a given set of tags. The
7174 command prompts for a selection criterion, which is a boolean logic
7175 expression with tags, like @samp{+work+urgent-withboss} or
7176 @samp{work|home} (@pxref{Tags}). If you often need a specific search,
7177 define a custom command for it (@pxref{Agenda dispatcher}).
7178 @orgcmd{C-c a M,org-tags-view}
7179 @vindex org-tags-match-list-sublevels
7180 @vindex org-agenda-tags-todo-honor-ignore-options
7181 Like @kbd{C-c a m}, but only select headlines that are also TODO items in a
7182 not-DONE state and force checking subitems (see variable
7183 @code{org-tags-match-list-sublevels}). To exclude scheduled/deadline items,
7184 see the variable @code{org-agenda-tags-todo-honor-ignore-options}. Matching
7185 specific TODO keywords together with a tags match is also possible, see
7189 The commands available in the tags list are described in @ref{Agenda
7192 @subsubheading Match syntax
7194 @cindex Boolean logic, for tag/property searches
7195 A search string can use Boolean operators @samp{&} for AND and @samp{|} for
7196 OR. @samp{&} binds more strongly than @samp{|}. Parentheses are currently
7197 not implemented. Each element in the search is either a tag, a regular
7198 expression matching tags, or an expression like @code{PROPERTY OPERATOR
7199 VALUE} with a comparison operator, accessing a property value. Each element
7200 may be preceded by @samp{-}, to select against it, and @samp{+} is syntactic
7201 sugar for positive selection. The AND operator @samp{&} is optional when
7202 @samp{+} or @samp{-} is present. Here are some examples, using only tags.
7206 Select headlines tagged @samp{:work:}, but discard those also tagged
7209 Selects lines tagged @samp{:work:} or @samp{:laptop:}.
7210 @item work|laptop+night
7211 Like before, but require the @samp{:laptop:} lines to be tagged also
7215 @cindex regular expressions, with tags search
7216 Instead of a tag, you may also specify a regular expression enclosed in curly
7217 braces. For example,
7218 @samp{work+@{^boss.*@}} matches headlines that contain the tag
7219 @samp{:work:} and any tag @i{starting} with @samp{boss}.
7221 @cindex TODO keyword matching, with tags search
7222 @cindex level, require for tags/property match
7223 @cindex category, require for tags/property match
7224 @vindex org-odd-levels-only
7225 You may also test for properties (@pxref{Properties and Columns}) at the same
7226 time as matching tags. The properties may be real properties, or special
7227 properties that represent other metadata (@pxref{Special properties}). For
7228 example, the ``property'' @code{TODO} represents the TODO keyword of the
7229 entry. Or, the ``property'' @code{LEVEL} represents the level of an entry.
7230 So a search @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines
7231 that have the tag @samp{boss} and are @emph{not} marked with the TODO keyword
7232 DONE. In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not
7233 count the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc.
7235 Here are more examples:
7237 @item work+TODO="WAITING"
7238 Select @samp{:work:}-tagged TODO lines with the specific TODO
7239 keyword @samp{WAITING}.
7240 @item work+TODO="WAITING"|home+TODO="WAITING"
7241 Waiting tasks both at work and at home.
7244 When matching properties, a number of different operators can be used to test
7245 the value of a property. Here is a complex example:
7248 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 \
7249 +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
7253 The type of comparison will depend on how the comparison value is written:
7256 If the comparison value is a plain number, a numerical comparison is done,
7257 and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
7258 @samp{>=}, and @samp{<>}.
7260 If the comparison value is enclosed in double-quotes,
7261 a string comparison is done, and the same operators are allowed.
7263 If the comparison value is enclosed in double-quotes @emph{and} angular
7264 brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
7265 assumed to be date/time specifications in the standard Org way, and the
7266 comparison will be done accordingly. Special values that will be recognized
7267 are @code{"<now>"} for now (including time), and @code{"<today>"}, and
7268 @code{"<tomorrow>"} for these days at 0:00 hours, i.e. without a time
7269 specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
7270 @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
7271 respectively, can be used.
7273 If the comparison value is enclosed
7274 in curly braces, a regexp match is performed, with @samp{=} meaning that the
7275 regexp matches the property value, and @samp{<>} meaning that it does not
7279 So the search string in the example finds entries tagged @samp{:work:} but
7280 not @samp{:boss:}, which also have a priority value @samp{A}, a
7281 @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
7282 property that is numerically smaller than 2, a @samp{:With:} property that is
7283 matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
7284 on or after October 11, 2008.
7286 Accessing TODO, LEVEL, and CATEGORY during a search is fast. Accessing any
7287 other properties will slow down the search. However, once you have paid the
7288 price by accessing one property, testing additional properties is cheap
7291 You can configure Org-mode to use property inheritance during a search, but
7292 beware that this can slow down searches considerably. See @ref{Property
7293 inheritance}, for details.
7295 For backward compatibility, and also for typing speed, there is also a
7296 different way to test TODO states in a search. For this, terminate the
7297 tags/property part of the search string (which may include several terms
7298 connected with @samp{|}) with a @samp{/} and then specify a Boolean
7299 expression just for TODO keywords. The syntax is then similar to that for
7300 tags, but should be applied with care: for example, a positive selection on
7301 several TODO keywords cannot meaningfully be combined with boolean AND.
7302 However, @emph{negative selection} combined with AND can be meaningful. To
7303 make sure that only lines are checked that actually have any TODO keyword
7304 (resulting in a speed-up), use @kbd{C-c a M}, or equivalently start the TODO
7305 part after the slash with @samp{!}. Using @kbd{C-c a M} or @samp{/!} will
7306 not match TODO keywords in a DONE state. Examples:
7310 Same as @samp{work+TODO="WAITING"}
7311 @item work/!-WAITING-NEXT
7312 Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
7314 @item work/!+WAITING|+NEXT
7315 Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
7319 @node Timeline, Search view, Matching tags and properties, Built-in agenda views
7320 @subsection Timeline for a single file
7321 @cindex timeline, single file
7322 @cindex time-sorted view
7324 The timeline summarizes all time-stamped items from a single Org-mode
7325 file in a @emph{time-sorted view}. The main purpose of this command is
7326 to give an overview over events in a project.
7329 @orgcmd{C-c a L,org-timeline}
7330 Show a time-sorted view of the Org file, with all time-stamped items.
7331 When called with a @kbd{C-u} prefix, all unfinished TODO entries
7332 (scheduled or not) are also listed under the current date.
7336 The commands available in the timeline buffer are listed in
7337 @ref{Agenda commands}.
7339 @node Search view, Stuck projects, Timeline, Built-in agenda views
7340 @subsection Search view
7343 @cindex searching, for text
7345 This agenda view is a general text search facility for Org-mode entries.
7346 It is particularly useful to find notes.
7349 @orgcmd{C-c a s,org-search-view}
7350 This is a special search that lets you select entries by matching a substring
7351 or specific words using a boolean logic.
7353 For example, the search string @samp{computer equipment} will find entries
7354 that contain @samp{computer equipment} as a substring. If the two words are
7355 separated by more space or a line break, the search will still match.
7356 Search view can also search for specific keywords in the entry, using Boolean
7357 logic. The search string @samp{+computer +wifi -ethernet -@{8\.11[bg]@}}
7358 will search for note entries that contain the keywords @code{computer}
7359 and @code{wifi}, but not the keyword @code{ethernet}, and which are also
7360 not matched by the regular expression @code{8\.11[bg]}, meaning to
7361 exclude both 8.11b and 8.11g. The first @samp{+} is necessary to turn on
7362 word search, other @samp{+} characters are optional. For more details, see
7363 the docstring of the command @code{org-search-view}.
7365 @vindex org-agenda-text-search-extra-files
7366 Note that in addition to the agenda files, this command will also search
7367 the files listed in @code{org-agenda-text-search-extra-files}.
7369 @node Stuck projects, , Search view, Built-in agenda views
7370 @subsection Stuck projects
7372 If you are following a system like David Allen's GTD to organize your
7373 work, one of the ``duties'' you have is a regular review to make sure
7374 that all projects move along. A @emph{stuck} project is a project that
7375 has no defined next actions, so it will never show up in the TODO lists
7376 Org-mode produces. During the review, you need to identify such
7377 projects and define next actions for them.
7380 @orgcmd{C-c a #,org-agenda-list-stuck-projects}
7381 List projects that are stuck.
7384 @vindex org-stuck-projects
7385 Customize the variable @code{org-stuck-projects} to define what a stuck
7386 project is and how to find it.
7389 You almost certainly will have to configure this view before it will
7390 work for you. The built-in default assumes that all your projects are
7391 level-2 headlines, and that a project is not stuck if it has at least
7392 one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
7394 Let's assume that you, in your own way of using Org-mode, identify
7395 projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
7396 indicate a project that should not be considered yet. Let's further
7397 assume that the TODO keyword DONE marks finished projects, and that NEXT
7398 and TODO indicate next actions. The tag @@SHOP indicates shopping and
7399 is a next action even without the NEXT tag. Finally, if the project
7400 contains the special word IGNORE anywhere, it should not be listed
7401 either. In this case you would start by identifying eligible projects
7402 with a tags/todo match@footnote{@xref{Tag searches}.}
7403 @samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT, @@SHOP, and
7404 IGNORE in the subtree to identify projects that are not stuck. The
7405 correct customization for this is
7408 (setq org-stuck-projects
7409 '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
7413 Note that if a project is identified as non-stuck, the subtree of this entry
7414 will still be searched for stuck projects.
7416 @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views
7417 @section Presentation and sorting
7418 @cindex presentation, of agenda items
7420 @vindex org-agenda-prefix-format
7421 Before displaying items in an agenda view, Org-mode visually prepares
7422 the items and sorts them. Each item occupies a single line. The line
7423 starts with a @emph{prefix} that contains the @emph{category}
7424 (@pxref{Categories}) of the item and other important information. You can
7425 customize the prefix using the option @code{org-agenda-prefix-format}.
7426 The prefix is followed by a cleaned-up version of the outline headline
7427 associated with the item.
7430 * Categories:: Not all tasks are equal
7431 * Time-of-day specifications:: How the agenda knows the time
7432 * Sorting of agenda items:: The order of things
7435 @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting
7436 @subsection Categories
7440 The category is a broad label assigned to each agenda item. By default,
7441 the category is simply derived from the file name, but you can also
7442 specify it with a special line in the buffer, like this@footnote{For
7443 backward compatibility, the following also works: if there are several
7444 such lines in a file, each specifies the category for the text below it.
7445 The first category also applies to any text before the first CATEGORY
7446 line. However, using this method is @emph{strongly} deprecated as it is
7447 incompatible with the outline structure of the document. The correct
7448 method for setting multiple categories in a buffer is using a
7456 @cindex property, CATEGORY
7457 If you would like to have a special CATEGORY for a single entry or a
7458 (sub)tree, give the entry a @code{:CATEGORY:} property with the
7459 special category you want to apply as the value.
7462 The display in the agenda buffer looks best if the category is not
7463 longer than 10 characters.
7466 You can set up icons for category by customizing the
7467 @code{org-agenda-category-icon-alist} variable.
7469 @node Time-of-day specifications, Sorting of agenda items, Categories, Presentation and sorting
7470 @subsection Time-of-day specifications
7471 @cindex time-of-day specification
7473 Org-mode checks each agenda item for a time-of-day specification. The
7474 time can be part of the timestamp that triggered inclusion into the
7475 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time
7476 ranges can be specified with two timestamps, like
7478 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
7480 In the headline of the entry itself, a time(range) may also appear as
7481 plain text (like @samp{12:45} or a @samp{8:30-1pm}). If the agenda
7482 integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
7483 specifications in diary entries are recognized as well.
7485 For agenda display, Org-mode extracts the time and displays it in a
7486 standard 24 hour format as part of the prefix. The example times in
7487 the previous paragraphs would end up in the agenda like this:
7490 8:30-13:00 Arthur Dent lies in front of the bulldozer
7491 12:45...... Ford Prefect arrives and takes Arthur to the pub
7492 19:00...... The Vogon reads his poem
7493 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
7497 If the agenda is in single-day mode, or for the display of today, the
7498 timed entries are embedded in a time grid, like
7501 8:00...... ------------------
7502 8:30-13:00 Arthur Dent lies in front of the bulldozer
7503 10:00...... ------------------
7504 12:00...... ------------------
7505 12:45...... Ford Prefect arrives and takes Arthur to the pub
7506 14:00...... ------------------
7507 16:00...... ------------------
7508 18:00...... ------------------
7509 19:00...... The Vogon reads his poem
7510 20:00...... ------------------
7511 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
7514 @vindex org-agenda-use-time-grid
7515 @vindex org-agenda-time-grid
7516 The time grid can be turned on and off with the variable
7517 @code{org-agenda-use-time-grid}, and can be configured with
7518 @code{org-agenda-time-grid}.
7520 @node Sorting of agenda items, , Time-of-day specifications, Presentation and sorting
7521 @subsection Sorting of agenda items
7522 @cindex sorting, of agenda items
7523 @cindex priorities, of agenda items
7524 Before being inserted into a view, the items are sorted. How this is
7525 done depends on the type of view.
7528 @vindex org-agenda-files
7529 For the daily/weekly agenda, the items for each day are sorted. The
7530 default order is to first collect all items containing an explicit
7531 time-of-day specification. These entries will be shown at the beginning
7532 of the list, as a @emph{schedule} for the day. After that, items remain
7533 grouped in categories, in the sequence given by @code{org-agenda-files}.
7534 Within each category, items are sorted by priority (@pxref{Priorities}),
7535 which is composed of the base priority (2000 for priority @samp{A}, 1000
7536 for @samp{B}, and 0 for @samp{C}), plus additional increments for
7537 overdue scheduled or deadline items.
7539 For the TODO list, items remain in the order of categories, but within
7540 each category, sorting takes place according to priority
7541 (@pxref{Priorities}). The priority used for sorting derives from the
7542 priority cookie, with additions depending on how close an item is to its due
7545 For tags matches, items are not sorted at all, but just appear in the
7546 sequence in which they are found in the agenda files.
7549 @vindex org-agenda-sorting-strategy
7550 Sorting can be customized using the variable
7551 @code{org-agenda-sorting-strategy}, and may also include criteria based on
7552 the estimated effort of an entry (@pxref{Effort estimates}).
7554 @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda Views
7555 @section Commands in the agenda buffer
7556 @cindex commands, in agenda buffer
7558 Entries in the agenda buffer are linked back to the Org file or diary
7559 file where they originate. You are not allowed to edit the agenda
7560 buffer itself, but commands are provided to show and jump to the
7561 original entry location, and to edit the Org files ``remotely'' from
7562 the agenda buffer. In this way, all information is stored only once,
7563 removing the risk that your agenda and note files may diverge.
7565 Some commands can be executed with mouse clicks on agenda lines. For
7566 the other commands, the cursor needs to be in the desired line.
7569 @tsubheading{Motion}
7570 @cindex motion commands in agenda
7571 @orgcmd{n,org-agenda-next-line}
7572 Next line (same as @key{up} and @kbd{C-p}).
7573 @orgcmd{p,org-agenda-previous-line}
7574 Previous line (same as @key{down} and @kbd{C-n}).
7575 @tsubheading{View/Go to Org file}
7576 @orgcmdkkc{@key{SPC},mouse-3,org-agenda-show-and-scroll-up}
7577 Display the original location of the item in another window.
7578 With prefix arg, make sure that the entire entry is made visible in the
7579 outline, not only the heading.
7581 @orgcmd{L,org-agenda-recenter}
7582 Display original location and recenter that window.
7584 @orgcmdkkc{@key{TAB},mouse-2,org-agenda-goto}
7585 Go to the original location of the item in another window.
7587 @orgcmd{@key{RET},org-agenda-switch-to}
7588 Go to the original location of the item and delete other windows.
7590 @orgcmd{F,org-agenda-follow-mode}
7591 @vindex org-agenda-start-with-follow-mode
7592 Toggle Follow mode. In Follow mode, as you move the cursor through
7593 the agenda buffer, the other window always shows the corresponding
7594 location in the Org file. The initial setting for this mode in new
7595 agenda buffers can be set with the variable
7596 @code{org-agenda-start-with-follow-mode}.
7598 @orgcmd{C-c C-x b,org-agenda-tree-to-indirect-buffer}
7599 Display the entire subtree of the current item in an indirect buffer. With a
7600 numeric prefix argument N, go up to level N and then take that tree. If N is
7601 negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the
7602 previously used indirect buffer.
7604 @orgcmd{C-c C-o,org-agenda-open-link}
7605 Follow a link in the entry. This will offer a selection of any links in the
7606 text belonging to the referenced Org node. If there is only one link, it
7607 will be followed without a selection prompt.
7609 @tsubheading{Change display}
7610 @cindex display changing, in agenda
7613 Delete other windows.
7621 @c @item v d @ @r{or short} @ d
7622 @c @itemx v w @ @r{or short} @ w
7625 @orgcmdkskc{v d,d,org-aganda-day-view}
7626 @xorgcmdkskc{v w,w,org-aganda-day-view}
7627 @xorgcmd{v m,org-agenda-month-view}
7628 @xorgcmd{v y,org-agenda-month-year}
7629 Switch to day/week/month/year view. When switching to day or week view,
7630 this setting becomes the default for subsequent agenda commands. Since
7631 month and year views are slow to create, they do not become the default.
7632 A numeric prefix argument may be used to jump directly to a specific day
7633 of the year, ISO week, month, or year, respectively. For example,
7634 @kbd{32 d} jumps to February 1st, @kbd{9 w} to ISO week number 9. When
7635 setting day, week, or month view, a year may be encoded in the prefix
7636 argument as well. For example, @kbd{200712 w} will jump to week 12 in
7637 2007. If such a year specification has only one or two digits, it will
7638 be mapped to the interval 1938-2037.
7640 @orgcmd{f,org-agenda-later}
7641 Go forward in time to display the following @code{org-agenda-current-span} days.
7642 For example, if the display covers a week, switch to the following week.
7643 With prefix arg, go forward that many times @code{org-agenda-current-span} days.
7645 @orgcmd{b,org-agenda-earlier}
7646 Go backward in time to display earlier dates.
7648 @orgcmd{.,org-agenda-goto-today}
7651 @orgcmd{j,org-agenda-goto-date}
7652 Prompt for a date and go there.
7654 @orgcmd{J,org-agenda-clock-goto}
7655 Go to the currently clocked-in task @i{in the agenda buffer}.
7657 @orgcmd{D,org-agenda-toggle-diary}
7658 Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}.
7660 @orgcmdkskc{v l,l,org-agenda-log-mode}
7662 @vindex org-log-done
7663 @vindex org-agenda-log-mode-items
7664 Toggle Logbook mode. In Logbook mode, entries that were marked DONE while
7665 logging was on (variable @code{org-log-done}) are shown in the agenda, as are
7666 entries that have been clocked on that day. You can configure the entry
7667 types that should be included in log mode using the variable
7668 @code{org-agenda-log-mode-items}. When called with a @kbd{C-u} prefix, show
7669 all possible logbook entries, including state changes. When called with two
7670 prefix args @kbd{C-u C-u}, show only logging information, nothing else.
7671 @kbd{v L} is equivalent to @kbd{C-u v l}.
7673 @orgcmdkskc{v [,[,org-agenda-manipulate-query-add}
7674 Include inactive timestamps into the current view. Only for weekly/daily
7675 agenda and timeline views.
7677 @orgcmd{v a,org-agenda-archives-mode}
7678 @xorgcmd{v A,org-agenda-archives-mode 'files}
7679 Toggle Archives mode. In Archives mode, trees that are marked
7680 @code{ARCHIVED} are also scanned when producing the agenda. When you use the
7681 capital @kbd{A}, even all archive files are included. To exit archives mode,
7682 press @kbd{v a} again.
7684 @orgcmdkskc{v R,R,org-agenda-clockreport-mode}
7685 @vindex org-agenda-start-with-clockreport-mode
7686 Toggle Clockreport mode. In Clockreport mode, the daily/weekly agenda will
7687 always show a table with the clocked times for the timespan and file scope
7688 covered by the current agenda view. The initial setting for this mode in new
7689 agenda buffers can be set with the variable
7690 @code{org-agenda-start-with-clockreport-mode}. By using a prefix argument
7691 when toggling this mode (i.e. @kbd{C-u R}), the clock table will not show
7692 contributions from entries that are hidden by agenda filtering@footnote{Only
7693 tags filtering will be respected here, effort filtering is ignored.}.
7695 @orgcmdkskc{v E,E,org-agenda-entry-text-mode}
7696 @vindex org-agenda-start-with-entry-text-mode
7697 @vindex org-agenda-entry-text-maxlines
7698 Toggle entry text mode. In entry text mode, a number of lines from the Org
7699 outline node referenced by an agenda line will be displayed below the line.
7700 The maximum number of lines is given by the variable
7701 @code{org-agenda-entry-text-maxlines}. Calling this command with a numeric
7702 prefix argument will temporarily modify that number to the prefix value.
7704 @orgcmd{G,org-agenda-toggle-time-grid}
7705 @vindex org-agenda-use-time-grid
7706 @vindex org-agenda-time-grid
7707 Toggle the time grid on and off. See also the variables
7708 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
7710 @orgcmd{r,org-agenda-rodo}
7711 Recreate the agenda buffer, for example to reflect the changes after
7712 modification of the timestamps of items with @kbd{S-@key{left}} and
7713 @kbd{S-@key{right}}. When the buffer is the global TODO list, a prefix
7714 argument is interpreted to create a selective list for a specific TODO
7716 @orgcmd{g,org-agenda-rodo}
7719 @orgcmdkskc{C-x C-s,s,org-save-all-org-buffers}
7720 Save all Org buffers in the current Emacs session, and also the locations of
7723 @orgcmd{C-c C-x C-c,org-agenda-columns}
7724 @vindex org-columns-default-format
7725 Invoke column view (@pxref{Column view}) in the agenda buffer. The column
7726 view format is taken from the entry at point, or (if there is no entry at
7727 point), from the first entry in the agenda view. So whatever the format for
7728 that entry would be in the original buffer (taken from a property, from a
7729 @code{#+COLUMNS} line, or from the default variable
7730 @code{org-columns-default-format}), will be used in the agenda.
7732 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
7733 Remove the restriction lock on the agenda, if it is currently restricted to a
7734 file or subtree (@pxref{Agenda files}).
7736 @tsubheading{Secondary filtering and query editing}
7737 @cindex filtering, by tag and effort, in agenda
7738 @cindex tag filtering, in agenda
7739 @cindex effort filtering, in agenda
7740 @cindex query editing, in agenda
7742 @orgcmd{/,org-agenda-filter-by-tag}
7743 @vindex org-agenda-filter-preset
7744 Filter the current agenda view with respect to a tag and/or effort estimates.
7745 The difference between this and a custom agenda command is that filtering is
7746 very fast, so that you can switch quickly between different filters without
7747 having to recreate the agenda.@footnote{Custom commands can preset a filter by
7748 binding the variable @code{org-agenda-filter-preset} as an option. This
7749 filter will then be applied to the view and persist as a basic filter through
7750 refreshes and more secondary filtering. The filter is a global property of
7751 the entire agenda view---in a block agenda, you should only set this in the
7752 global options section, not in the section of an individual block.}
7754 You will be prompted for a tag selection letter; @key{SPC} will mean any tag at
7755 all. Pressing @key{TAB} at that prompt will offer use completion to select a
7756 tag (including any tags that do not have a selection character). The command
7757 then hides all entries that do not contain or inherit this tag. When called
7758 with prefix arg, remove the entries that @emph{do} have the tag. A second
7759 @kbd{/} at the prompt will turn off the filter and unhide any hidden entries.
7760 If the first key you press is either @kbd{+} or @kbd{-}, the previous filter
7761 will be narrowed by requiring or forbidding the selected additional tag.
7762 Instead of pressing @kbd{+} or @kbd{-} after @kbd{/}, you can also
7763 immediately use the @kbd{\} command.
7765 @vindex org-sort-agenda-noeffort-is-high
7766 In order to filter for effort estimates, you should set up allowed
7767 efforts globally, for example
7769 (setq org-global-properties
7770 '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
7772 You can then filter for an effort by first typing an operator, one of
7773 @kbd{<}, @kbd{>}, and @kbd{=}, and then the one-digit index of an effort
7774 estimate in your array of allowed values, where @kbd{0} means the 10th value.
7775 The filter will then restrict to entries with effort smaller-or-equal, equal,
7776 or larger-or-equal than the selected value. If the digits 0-9 are not used
7777 as fast access keys to tags, you can also simply press the index digit
7778 directly without an operator. In this case, @kbd{<} will be assumed. For
7779 application of the operator, entries without a defined effort will be treated
7780 according to the value of @code{org-sort-agenda-noeffort-is-high}. To filter
7781 for tasks without effort definition, press @kbd{?} as the operator.
7783 Org also supports automatic, context-aware tag filtering. If the variable
7784 @code{org-agenda-auto-exclude-function} is set to a user-defined function,
7785 that function can decide which tags should be excluded from the agenda
7786 automatically. Once this is set, the @kbd{/} command then accepts @kbd{RET}
7787 as a sub-option key and runs the auto exclusion logic. For example, let's
7788 say you use a @code{Net} tag to identify tasks which need network access, an
7789 @code{Errand} tag for errands in town, and a @code{Call} tag for making phone
7790 calls. You could auto-exclude these tags based on the availability of the
7791 Internet, and outside of business hours, with something like this:
7795 (defun org-my-auto-exclude-function (tag)
7797 ((string= tag "Net")
7798 (/= 0 (call-process "/sbin/ping" nil nil nil
7799 "-c1" "-q" "-t1" "mail.gnu.org")))
7800 ((or (string= tag "Errand") (string= tag "Call"))
7801 (let ((hour (nth 2 (decode-time))))
7802 (or (< hour 8) (> hour 21)))))
7805 (setq org-agenda-auto-exclude-function 'org-my-auto-exclude-function)
7809 @orgcmd{\,org-agenda-filter-by-tag-refine}
7810 Narrow the current agenda filter by an additional condition. When called with
7811 prefix arg, remove the entries that @emph{do} have the tag, or that do match
7812 the effort criterion. You can achieve the same effect by pressing @kbd{+} or
7813 @kbd{-} as the first key after the @kbd{/} command.
7822 @item @r{in} search view
7823 add new search words (@kbd{[} and @kbd{]}) or new regular expressions
7824 (@kbd{@{} and @kbd{@}}) to the query string. The opening bracket/brace will
7825 add a positive search term prefixed by @samp{+}, indicating that this search
7826 term @i{must} occur/match in the entry. The closing bracket/brace will add a
7827 negative search term which @i{must not} occur/match in the entry for it to be
7831 @tsubheading{Remote editing}
7832 @cindex remote editing, from agenda
7837 @cindex undoing remote-editing events
7838 @cindex remote editing, undo
7839 @orgcmd{C-_,org-agenda-undo}
7840 Undo a change due to a remote editing command. The change is undone
7841 both in the agenda buffer and in the remote buffer.
7843 @orgcmd{t,org-agenda-todo}
7844 Change the TODO state of the item, both in the agenda and in the
7847 @orgcmd{C-S-@key{right},org-agenda-todo-nextset}
7848 @orgcmd{C-S-@key{left},org-agenda-todo-previousset}
7849 Switch to the next/previous set of TODO keywords.
7851 @orgcmd{C-k,org-agenda-kill}
7852 @vindex org-agenda-confirm-kill
7853 Delete the current agenda item along with the entire subtree belonging
7854 to it in the original Org file. If the text to be deleted remotely
7855 is longer than one line, the kill needs to be confirmed by the user. See
7856 variable @code{org-agenda-confirm-kill}.
7858 @orgcmd{C-c C-w,org-agenda-refile}
7859 Refile the entry at point.
7861 @orgcmdkskc{C-c C-x C-a,a,org-agenda-archive-default-with-confirmation}
7862 @vindex org-archive-default-command
7863 Archive the subtree corresponding to the entry at point using the default
7864 archiving command set in @code{org-archive-default-command}. When using the
7865 @code{a} key, confirmation will be required.
7867 @orgcmd{C-c C-x a,org-agenda-toggle-archive-tag}
7868 Toggle the ARCHIVE tag for the current headline.
7870 @orgcmd{C-c C-x A,org-agenda-archive-to-archive-sibling}
7871 Move the subtree corresponding to the current entry to its @emph{archive
7874 @orgcmdkskc{C-c C-x C-s,$,org-agenda-archive}
7875 Archive the subtree corresponding to the current headline. This means the
7876 entry will be moved to the configured archive location, most likely a
7879 @orgcmd{T,org-agenda-show-tags}
7880 @vindex org-agenda-show-inherited-tags
7881 Show all tags associated with the current item. This is useful if you have
7882 turned off @code{org-agenda-show-inherited-tags}, but still want to see all
7883 tags of a headline occasionally.
7885 @orgcmd{:,org-agenda-set-tags}
7886 Set tags for the current headline. If there is an active region in the
7887 agenda, change a tag for all headings in the region.
7891 Set the priority for the current item (@command{org-agenda-priority}).
7892 Org-mode prompts for the priority character. If you reply with @key{SPC}, the
7893 priority cookie is removed from the entry.
7895 @orgcmd{P,org-agenda-show-priority}
7896 Display weighted priority of current item.
7898 @orgcmdkkc{+,S-@key{up},org-agenda-priority-up}
7899 Increase the priority of the current item. The priority is changed in
7900 the original buffer, but the agenda is not resorted. Use the @kbd{r}
7903 @orgcmdkkc{-,S-@key{down},org-agenda-priority-down}
7904 Decrease the priority of the current item.
7906 @orgcmdkkc{z,C-c C-z,org-agenda-add-note}
7907 @vindex org-log-into-drawer
7908 Add a note to the entry. This note will be recorded, and then filed to the
7909 same location where state change notes are put. Depending on
7910 @code{org-log-into-drawer}, this may be inside a drawer.
7912 @orgcmd{C-c C-a,org-attach}
7913 Dispatcher for all command related to attachments.
7915 @orgcmd{C-c C-s,org-agenda-schedule}
7916 Schedule this item. With prefix arg remove the scheduling timestamp
7918 @orgcmd{C-c C-d,org-agenda-deadline}
7919 Set a deadline for this item. With prefix arg remove the deadline.
7921 @orgcmd{k,org-agenda-action}
7922 Agenda actions, to set dates for selected items to the cursor date.
7923 This command also works in the calendar! The command prompts for an
7926 m @r{Mark the entry at point for action. You can also make entries}
7927 @r{in Org files with @kbd{C-c C-x C-k}.}
7928 d @r{Set the deadline of the marked entry to the date at point.}
7929 s @r{Schedule the marked entry at the date at point.}
7930 r @r{Call @code{org-capture} with the cursor date as default date.}
7933 Press @kbd{r} afterward to refresh the agenda and see the effect of the
7936 @orgcmd{S-@key{right},org-agenda-do-date-later}
7937 Change the timestamp associated with the current line by one day into the
7938 future. With a numeric prefix argument, change it by that many days. For
7939 example, @kbd{3 6 5 S-@key{right}} will change it by a year. With a
7940 @kbd{C-u} prefix, change the time by one hour. If you immediately repeat the
7941 command, it will continue to change hours even without the prefix arg. With
7942 a double @kbd{C-u C-u} prefix, do the same for changing minutes. The stamp
7943 is changed in the original Org file, but the change is not directly reflected
7944 in the agenda buffer. Use @kbd{r} or @kbd{g} to update the buffer.
7946 @orgcmd{S-@key{left},org-agenda-do-date-earlier}
7947 Change the timestamp associated with the current line by one day
7950 @orgcmd{>,org-agenda-date-prompt}
7951 Change the timestamp associated with the current line. The key @kbd{>} has
7952 been chosen, because it is the same as @kbd{S-.} on my keyboard.
7954 @orgcmd{I,org-agenda-clock-in}
7955 Start the clock on the current item. If a clock is running already, it
7958 @orgcmd{O,org-agenda-clock-out}
7959 Stop the previously started clock.
7961 @orgcmd{X,org-agenda-clock-cancel}
7962 Cancel the currently running clock.
7964 @orgcmd{J,org-agenda-clock-goto}
7965 Jump to the running clock in another window.
7967 @tsubheading{Bulk remote editing selected entries}
7968 @cindex remote editing, bulk, from agenda
7970 @orgcmd{m,org-agenda-bulk-mark}
7971 Mark the entry at point for bulk action. With prefix arg, mark that many
7974 @orgcmd{u,org-agenda-bulk-unmark}
7975 Unmark entry for bulk action.
7977 @orgcmd{U,org-agenda-bulk-remove-all-marks}
7978 Unmark all marked entries for bulk action.
7980 @orgcmd{B,org-agenda-bulk-action}
7981 Bulk action: act on all marked entries in the agenda. This will prompt for
7982 another key to select the action to be applied. The prefix arg to @kbd{B}
7983 will be passed through to the @kbd{s} and @kbd{d} commands, to bulk-remove
7984 these special timestamps.
7986 r @r{Prompt for a single refile target and move all entries. The entries}
7987 @r{will no longer be in the agenda; refresh (@kbd{g}) to bring them back.}
7988 $ @r{Archive all selected entries.}
7989 A @r{Archive entries by moving them to their respective archive siblings.}
7990 t @r{Change TODO state. This prompts for a single TODO keyword and}
7991 @r{changes the state of all selected entries, bypassing blocking and}
7992 @r{suppressing logging notes (but not time stamps).}
7993 + @r{Add a tag to all selected entries.}
7994 - @r{Remove a tag from all selected entries.}
7995 s @r{Schedule all items to a new date. To shift existing schedule dates}
7996 @r{by a fixed number of days, use something starting with double plus}
7997 @r{at the prompt, for example @samp{++8d} or @samp{++2w}.}
7998 S @r{Reschedule randomly by N days. N will be prompted for. With prefix}
7999 @r{arg (@kbd{C-u B S}), scatter only accross weekdays.}
8000 d @r{Set deadline to a specific date.}
8004 @tsubheading{Calendar commands}
8005 @cindex calendar commands, from agenda
8007 @orgcmd{c,org-agenda-goto-calendar}
8008 Open the Emacs calendar and move to the date at the agenda cursor.
8010 @orgcmd{c,org-calendar-goto-agenda}
8011 When in the calendar, compute and show the Org-mode agenda for the
8014 @cindex diary entries, creating from agenda
8015 @orgcmd{i,org-agenda-diary-entry}
8016 @vindex org-agenda-diary-file
8017 Insert a new entry into the diary, using the date at the cursor and (for
8018 block entries) the date at the mark. This will add to the Emacs diary
8019 file@footnote{This file is parsed for the agenda when
8020 @code{org-agenda-include-diary} is set.}, in a way similar to the @kbd{i}
8021 command in the calendar. The diary file will pop up in another window, where
8022 you can add the entry.
8024 If you configure @code{org-agenda-diary-file} to point to an Org-mode file,
8025 Org will create entries (in org-mode syntax) in that file instead. Most
8026 entries will be stored in a date-based outline tree that will later make it
8027 easy to archive appointments from previous months/years. The tree will be
8028 built under an entry with a @code{DATE_TREE} property, or else with years as
8029 top-level entries. Emacs will prompt you for the entry text---if you specify
8030 it, the entry will be created in @code{org-agenda-diary-file} without further
8031 interaction. If you directly press @key{RET} at the prompt without typing
8032 text, the target file will be shown in another window for you to finish the
8033 entry there. See also the @kbd{k r} command.
8035 @orgcmd{M,org-agenda-phases-of-moon}
8036 Show the phases of the moon for the three months around current date.
8038 @orgcmd{S,org-agenda-sunrise-sunset}
8039 Show sunrise and sunset times. The geographical location must be set
8040 with calendar variables, see the documentation for the Emacs calendar.
8042 @orgcmd{C,org-agenda-convert-date}
8043 Convert the date at cursor into many other cultural and historic
8046 @orgcmd{H,org-agenda-holidays}
8047 Show holidays for three months around the cursor date.
8049 @item M-x org-export-icalendar-combine-agenda-files
8050 Export a single iCalendar file containing entries from all agenda files.
8051 This is a globally available command, and also available in the agenda menu.
8053 @tsubheading{Exporting to a file}
8054 @orgcmd{C-x C-w,org-write-agenda}
8055 @cindex exporting agenda views
8056 @cindex agenda views, exporting
8057 @vindex org-agenda-exporter-settings
8058 Write the agenda view to a file. Depending on the extension of the selected
8059 file name, the view will be exported as HTML (extension @file{.html} or
8060 @file{.htm}), Postscript (extension @file{.ps}), PDF (extension @file{.pdf}),
8061 and plain text (any other extension). When called with a @kbd{C-u} prefix
8062 argument, immediately open the newly created file. Use the variable
8063 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
8064 for @file{htmlize} to be used during export.
8066 @tsubheading{Quit and Exit}
8067 @orgcmd{q,org-agenda-quit}
8068 Quit agenda, remove the agenda buffer.
8070 @cindex agenda files, removing buffers
8071 @orgcmd{x,org-agenda-exit}
8072 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
8073 for the compilation of the agenda. Buffers created by the user to
8074 visit Org files will not be removed.
8078 @node Custom agenda views, Exporting Agenda Views, Agenda commands, Agenda Views
8079 @section Custom agenda views
8080 @cindex custom agenda views
8081 @cindex agenda views, custom
8083 Custom agenda commands serve two purposes: to store and quickly access
8084 frequently used TODO and tags searches, and to create special composite
8085 agenda buffers. Custom agenda commands will be accessible through the
8086 dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
8089 * Storing searches:: Type once, use often
8090 * Block agenda:: All the stuff you need in a single buffer
8091 * Setting Options:: Changing the rules
8094 @node Storing searches, Block agenda, Custom agenda views, Custom agenda views
8095 @subsection Storing searches
8097 The first application of custom searches is the definition of keyboard
8098 shortcuts for frequently used searches, either creating an agenda
8099 buffer, or a sparse tree (the latter covering of course only the current
8102 @vindex org-agenda-custom-commands
8103 Custom commands are configured in the variable
8104 @code{org-agenda-custom-commands}. You can customize this variable, for
8105 example by pressing @kbd{C-c a C}. You can also directly set it with
8106 Emacs Lisp in @file{.emacs}. The following example contains all valid
8111 (setq org-agenda-custom-commands
8112 '(("w" todo "WAITING")
8113 ("W" todo-tree "WAITING")
8114 ("u" tags "+boss-urgent")
8115 ("v" tags-todo "+boss-urgent")
8116 ("U" tags-tree "+boss-urgent")
8117 ("f" occur-tree "\\<FIXME\\>")
8118 ("h" . "HOME+Name tags searches") ; description for "h" prefix
8119 ("hl" tags "+home+Lisa")
8120 ("hp" tags "+home+Peter")
8121 ("hk" tags "+home+Kim")))
8126 The initial string in each entry defines the keys you have to press
8127 after the dispatcher command @kbd{C-c a} in order to access the command.
8128 Usually this will be just a single character, but if you have many
8129 similar commands, you can also define two-letter combinations where the
8130 first character is the same in several combinations and serves as a
8131 prefix key@footnote{You can provide a description for a prefix key by
8132 inserting a cons cell with the prefix and the description.}. The second
8133 parameter is the search type, followed by the string or regular
8134 expression to be used for the matching. The example above will
8139 as a global search for TODO entries with @samp{WAITING} as the TODO
8142 as the same search, but only in the current buffer and displaying the
8143 results as a sparse tree
8145 as a global tags search for headlines marked @samp{:boss:} but not
8148 as the same search as @kbd{C-c a u}, but limiting the search to
8149 headlines that are also TODO items
8151 as the same search as @kbd{C-c a u}, but only in the current buffer and
8152 displaying the result as a sparse tree
8154 to create a sparse tree (again: current buffer only) with all entries
8155 containing the word @samp{FIXME}
8157 as a prefix command for a HOME tags search where you have to press an
8158 additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
8159 Peter, or Kim) as additional tag to match.
8162 @node Block agenda, Setting Options, Storing searches, Custom agenda views
8163 @subsection Block agenda
8164 @cindex block agenda
8165 @cindex agenda, with block views
8167 Another possibility is the construction of agenda views that comprise
8168 the results of @emph{several} commands, each of which creates a block in
8169 the agenda buffer. The available commands include @code{agenda} for the
8170 daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
8171 for the global TODO list (as constructed with @kbd{C-c a t}), and the
8172 matching commands discussed above: @code{todo}, @code{tags}, and
8173 @code{tags-todo}. Here are two examples:
8177 (setq org-agenda-custom-commands
8178 '(("h" "Agenda and Home-related tasks"
8182 ("o" "Agenda and Office-related tasks"
8190 This will define @kbd{C-c a h} to create a multi-block view for stuff
8191 you need to attend to at home. The resulting agenda buffer will contain
8192 your agenda for the current week, all TODO items that carry the tag
8193 @samp{home}, and also all lines tagged with @samp{garden}. Finally the
8194 command @kbd{C-c a o} provides a similar view for office tasks.
8196 @node Setting Options, , Block agenda, Custom agenda views
8197 @subsection Setting options for custom commands
8198 @cindex options, for custom agenda views
8200 @vindex org-agenda-custom-commands
8201 Org-mode contains a number of variables regulating agenda construction
8202 and display. The global variables define the behavior for all agenda
8203 commands, including the custom commands. However, if you want to change
8204 some settings just for a single custom view, you can do so. Setting
8205 options requires inserting a list of variable names and values at the
8206 right spot in @code{org-agenda-custom-commands}. For example:
8210 (setq org-agenda-custom-commands
8211 '(("w" todo "WAITING"
8212 ((org-agenda-sorting-strategy '(priority-down))
8213 (org-agenda-prefix-format " Mixed: ")))
8214 ("U" tags-tree "+boss-urgent"
8215 ((org-show-following-heading nil)
8216 (org-show-hierarchy-above nil)))
8218 ((org-agenda-files '("~org/notes.org"))
8219 (org-agenda-text-search-extra-files nil)))))
8224 Now the @kbd{C-c a w} command will sort the collected entries only by
8225 priority, and the prefix format is modified to just say @samp{ Mixed: }
8226 instead of giving the category of the entry. The sparse tags tree of
8227 @kbd{C-c a U} will now turn out ultra-compact, because neither the
8228 headline hierarchy above the match, nor the headline following the match
8229 will be shown. The command @kbd{C-c a N} will do a text search limited
8230 to only a single file.
8232 @vindex org-agenda-custom-commands
8233 For command sets creating a block agenda,
8234 @code{org-agenda-custom-commands} has two separate spots for setting
8235 options. You can add options that should be valid for just a single
8236 command in the set, and options that should be valid for all commands in
8237 the set. The former are just added to the command entry; the latter
8238 must come after the list of command entries. Going back to the block
8239 agenda example (@pxref{Block agenda}), let's change the sorting strategy
8240 for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
8241 the results for GARDEN tags query in the opposite order,
8242 @code{priority-up}. This would look like this:
8246 (setq org-agenda-custom-commands
8247 '(("h" "Agenda and Home-related tasks"
8251 ((org-agenda-sorting-strategy '(priority-up)))))
8252 ((org-agenda-sorting-strategy '(priority-down))))
8253 ("o" "Agenda and Office-related tasks"
8260 As you see, the values and parentheses setting is a little complex.
8261 When in doubt, use the customize interface to set this variable---it
8262 fully supports its structure. Just one caveat: when setting options in
8263 this interface, the @emph{values} are just Lisp expressions. So if the
8264 value is a string, you need to add the double-quotes around the value
8268 @node Exporting Agenda Views, Agenda column view, Custom agenda views, Agenda Views
8269 @section Exporting Agenda Views
8270 @cindex agenda views, exporting
8272 If you are away from your computer, it can be very useful to have a printed
8273 version of some agenda views to carry around. Org-mode can export custom
8274 agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's
8275 @file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the
8276 ghostscript @file{ps2pdf} utility must be installed on the system. Selecting
8277 a PDF file with also create the postscript file.}, and iCalendar files. If
8278 you want to do this only occasionally, use the command
8281 @orgcmd{C-x C-w,org-write-agenda}
8282 @cindex exporting agenda views
8283 @cindex agenda views, exporting
8284 @vindex org-agenda-exporter-settings
8285 Write the agenda view to a file. Depending on the extension of the selected
8286 file name, the view will be exported as HTML (extension @file{.html} or
8287 @file{.htm}), Postscript (extension @file{.ps}), iCalendar (extension
8288 @file{.ics}), or plain text (any other extension). Use the variable
8289 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
8290 for @file{htmlize} to be used during export, for example
8292 @vindex org-agenda-add-entry-text-maxlines
8293 @vindex htmlize-output-type
8294 @vindex ps-number-of-columns
8295 @vindex ps-landscape-mode
8297 (setq org-agenda-exporter-settings
8298 '((ps-number-of-columns 2)
8299 (ps-landscape-mode t)
8300 (org-agenda-add-entry-text-maxlines 5)
8301 (htmlize-output-type 'css)))
8305 If you need to export certain agenda views frequently, you can associate
8306 any custom agenda command with a list of output file names
8307 @footnote{If you want to store standard views like the weekly agenda
8308 or the global TODO list as well, you need to define custom commands for
8309 them in order to be able to specify file names.}. Here is an example
8310 that first defines custom commands for the agenda and the global
8311 TODO list, together with a number of files to which to export them.
8312 Then we define two block agenda commands and specify file names for them
8313 as well. File names can be relative to the current working directory,
8318 (setq org-agenda-custom-commands
8319 '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
8320 ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
8321 ("h" "Agenda and Home-related tasks"
8326 ("~/views/home.html"))
8327 ("o" "Agenda and Office-related tasks"
8332 ("~/views/office.ps" "~/calendars/office.ics"))))
8336 The extension of the file name determines the type of export. If it is
8337 @file{.html}, Org-mode will use the @file{htmlize.el} package to convert
8338 the buffer to HTML and save it to this file name. If the extension is
8339 @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
8340 Postscript output. If the extension is @file{.ics}, iCalendar export is
8341 run export over all files that were used to construct the agenda, and
8342 limit the export to entries listed in the agenda. Any other
8343 extension produces a plain ASCII file.
8345 The export files are @emph{not} created when you use one of those
8346 commands interactively because this might use too much overhead.
8347 Instead, there is a special command to produce @emph{all} specified
8351 @orgcmd{C-c a e,org-store-agenda-views}
8352 Export all agenda views that have export file names associated with
8356 You can use the options section of the custom agenda commands to also
8357 set options for the export commands. For example:
8360 (setq org-agenda-custom-commands
8362 ((ps-number-of-columns 2)
8363 (ps-landscape-mode t)
8364 (org-agenda-prefix-format " [ ] ")
8365 (org-agenda-with-colors nil)
8366 (org-agenda-remove-tags t))
8371 This command sets two options for the Postscript exporter, to make it
8372 print in two columns in landscape format---the resulting page can be cut
8373 in two and then used in a paper agenda. The remaining settings modify
8374 the agenda prefix to omit category and scheduling information, and
8375 instead include a checkbox to check off items. We also remove the tags
8376 to make the lines compact, and we don't want to use colors for the
8377 black-and-white printer. Settings specified in
8378 @code{org-agenda-exporter-settings} will also apply, but the settings
8379 in @code{org-agenda-custom-commands} take precedence.
8382 From the command line you may also use
8384 emacs -f org-batch-store-agenda-views -kill
8387 or, if you need to modify some parameters@footnote{Quoting depends on the
8388 system you use, please check the FAQ for examples.}
8390 emacs -eval '(org-batch-store-agenda-views \
8391 org-agenda-span month \
8392 org-agenda-start-day "2007-11-01" \
8393 org-agenda-include-diary nil \
8394 org-agenda-files (quote ("~/org/project.org")))' \
8398 which will create the agenda views restricted to the file
8399 @file{~/org/project.org}, without diary entries and with a 30-day
8402 You can also extract agenda information in a way that allows further
8403 processing by other programs. See @ref{Extracting agenda information}, for
8407 @node Agenda column view, , Exporting Agenda Views, Agenda Views
8408 @section Using column view in the agenda
8409 @cindex column view, in agenda
8410 @cindex agenda, column view
8412 Column view (@pxref{Column view}) is normally used to view and edit
8413 properties embedded in the hierarchical structure of an Org file. It can be
8414 quite useful to use column view also from the agenda, where entries are
8415 collected by certain criteria.
8418 @orgcmd{C-c C-x C-c,org-agenda-columns}
8419 Turn on column view in the agenda.
8422 To understand how to use this properly, it is important to realize that the
8423 entries in the agenda are no longer in their proper outline environment.
8424 This causes the following issues:
8428 @vindex org-columns-default-format
8429 @vindex org-overriding-columns-format
8430 Org needs to make a decision which @code{COLUMNS} format to use. Since the
8431 entries in the agenda are collected from different files, and different files
8432 may have different @code{COLUMNS} formats, this is a non-trivial problem.
8433 Org first checks if the variable @code{org-overriding-columns-format} is
8434 currently set, and if so, takes the format from there. Otherwise it takes
8435 the format associated with the first item in the agenda, or, if that item
8436 does not have a specific format (defined in a property, or in its file), it
8437 uses @code{org-columns-default-format}.
8439 @cindex property, special, CLOCKSUM
8440 If any of the columns has a summary type defined (@pxref{Column attributes}),
8441 turning on column view in the agenda will visit all relevant agenda files and
8442 make sure that the computations of this property are up to date. This is
8443 also true for the special @code{CLOCKSUM} property. Org will then sum the
8444 values displayed in the agenda. In the daily/weekly agenda, the sums will
8445 cover a single day; in all other views they cover the entire block. It is
8446 vital to realize that the agenda may show the same entry @emph{twice} (for
8447 example as scheduled and as a deadline), and it may show two entries from the
8448 same hierarchy (for example a @emph{parent} and its @emph{child}). In these
8449 cases, the summation in the agenda will lead to incorrect results because
8450 some values will count double.
8452 When the column view in the agenda shows the @code{CLOCKSUM}, that is always
8453 the entire clocked time for this item. So even in the daily/weekly agenda,
8454 the clocksum listed in column view may originate from times outside the
8455 current view. This has the advantage that you can compare these values with
8456 a column listing the planned total effort for a task---one of the major
8457 applications for column view in the agenda. If you want information about
8458 clocked time in the displayed period use clock table mode (press @kbd{R} in
8463 @node Markup, Exporting, Agenda Views, Top
8464 @chapter Markup for rich export
8466 When exporting Org-mode documents, the exporter tries to reflect the
8467 structure of the document as accurately as possible in the backend. Since
8468 export targets like HTML, @LaTeX{}, or DocBook allow much richer formatting,
8469 Org-mode has rules on how to prepare text for rich export. This section
8470 summarizes the markup rules used in an Org-mode buffer.
8473 * Structural markup elements:: The basic structure as seen by the exporter
8474 * Images and tables:: Tables and Images will be included
8475 * Literal examples:: Source code examples with special formatting
8476 * Include files:: Include additional files into a document
8477 * Index entries:: Making an index
8478 * Macro replacement:: Use macros to create complex output
8479 * Embedded LaTeX:: LaTeX can be freely used inside Org documents
8482 @node Structural markup elements, Images and tables, Markup, Markup
8483 @section Structural markup elements
8486 * Document title:: Where the title is taken from
8487 * Headings and sections:: The document structure as seen by the exporter
8488 * Table of contents:: The if and where of the table of contents
8489 * Initial text:: Text before the first heading?
8491 * Paragraphs:: Paragraphs
8492 * Footnote markup:: Footnotes
8493 * Emphasis and monospace:: Bold, italic, etc.
8494 * Horizontal rules:: Make a line
8495 * Comment lines:: What will *not* be exported
8498 @node Document title, Headings and sections, Structural markup elements, Structural markup elements
8499 @subheading Document title
8500 @cindex document title, markup rules
8503 The title of the exported document is taken from the special line
8507 #+TITLE: This is the title of the document
8511 If this line does not exist, the title is derived from the first non-empty,
8512 non-comment line in the buffer. If no such line exists, or if you have
8513 turned off exporting of the text before the first headline (see below), the
8514 title will be the file name without extension.
8516 @cindex property, EXPORT_TITLE
8517 If you are exporting only a subtree by marking is as the region, the heading
8518 of the subtree will become the title of the document. If the subtree has a
8519 property @code{EXPORT_TITLE}, that will take precedence.
8521 @node Headings and sections, Table of contents, Document title, Structural markup elements
8522 @subheading Headings and sections
8523 @cindex headings and sections, markup rules
8525 @vindex org-export-headline-levels
8526 The outline structure of the document as described in @ref{Document
8527 Structure}, forms the basis for defining sections of the exported document.
8528 However, since the outline structure is also used for (for example) lists of
8529 tasks, only the first three outline levels will be used as headings. Deeper
8530 levels will become itemized lists. You can change the location of this
8531 switch globally by setting the variable @code{org-export-headline-levels}, or on a
8532 per-file basis with a line
8539 @node Table of contents, Initial text, Headings and sections, Structural markup elements
8540 @subheading Table of contents
8541 @cindex table of contents, markup rules
8543 @vindex org-export-with-toc
8544 The table of contents is normally inserted directly before the first headline
8545 of the file. If you would like to get it to a different location, insert the
8546 string @code{[TABLE-OF-CONTENTS]} on a line by itself at the desired
8547 location. The depth of the table of contents is by default the same as the
8548 number of headline levels, but you can choose a smaller number, or turn off
8549 the table of contents entirely, by configuring the variable
8550 @code{org-export-with-toc}, or on a per-file basis with a line like
8553 #+OPTIONS: toc:2 (only to two levels in TOC)
8554 #+OPTIONS: toc:nil (no TOC at all)
8557 @node Initial text, Lists, Table of contents, Structural markup elements
8558 @subheading Text before the first headline
8559 @cindex text before first headline, markup rules
8562 Org-mode normally exports the text before the first headline, and even uses
8563 the first line as the document title. The text will be fully marked up. If
8564 you need to include literal HTML, @LaTeX{}, or DocBook code, use the special
8565 constructs described below in the sections for the individual exporters.
8567 @vindex org-export-skip-text-before-1st-heading
8568 Some people like to use the space before the first headline for setup and
8569 internal links and therefore would like to control the exported text before
8570 the first headline in a different way. You can do so by setting the variable
8571 @code{org-export-skip-text-before-1st-heading} to @code{t}. On a per-file
8572 basis, you can get the same effect with @samp{#+OPTIONS: skip:t}.
8575 If you still want to have some text before the first headline, use the
8576 @code{#+TEXT} construct:
8580 #+TEXT: This text will go before the *first* headline.
8581 #+TEXT: [TABLE-OF-CONTENTS]
8582 #+TEXT: This goes between the table of contents and the first headline
8585 @node Lists, Paragraphs, Initial text, Structural markup elements
8587 @cindex lists, markup rules
8589 Plain lists as described in @ref{Plain lists}, are translated to the backend's
8590 syntax for such lists. Most backends support unordered, ordered, and
8593 @node Paragraphs, Footnote markup, Lists, Structural markup elements
8594 @subheading Paragraphs, line breaks, and quoting
8595 @cindex paragraphs, markup rules
8597 Paragraphs are separated by at least one empty line. If you need to enforce
8598 a line break within a paragraph, use @samp{\\} at the end of a line.
8600 To keep the line breaks in a region, but otherwise use normal formatting, you
8601 can use this construct, which can also be used to format poetry.
8603 @cindex #+BEGIN_VERSE
8606 Great clouds overhead
8607 Tiny black birds rise and fall
8614 When quoting a passage from another document, it is customary to format this
8615 as a paragraph that is indented on both the left and the right margin. You
8616 can include quotations in Org-mode documents like this:
8618 @cindex #+BEGIN_QUOTE
8621 Everything should be made as simple as possible,
8622 but not any simpler -- Albert Einstein
8626 If you would like to center some text, do it like this:
8627 @cindex #+BEGIN_CENTER
8630 Everything should be made as simple as possible, \\
8636 @node Footnote markup, Emphasis and monospace, Paragraphs, Structural markup elements
8637 @subheading Footnote markup
8638 @cindex footnotes, markup rules
8639 @cindex @file{footnote.el}
8641 Footnotes defined in the way described in @ref{Footnotes}, will be exported by
8642 all backends. Org allows multiple references to the same note, and
8643 different backends support this to varying degrees.
8645 @node Emphasis and monospace, Horizontal rules, Footnote markup, Structural markup elements
8646 @subheading Emphasis and monospace
8648 @cindex underlined text, markup rules
8649 @cindex bold text, markup rules
8650 @cindex italic text, markup rules
8651 @cindex verbatim text, markup rules
8652 @cindex code text, markup rules
8653 @cindex strike-through text, markup rules
8654 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=}
8655 and @code{~verbatim~}, and, if you must, @samp{+strike-through+}. Text
8656 in the code and verbatim string is not processed for Org-mode specific
8657 syntax; it is exported verbatim.
8659 @node Horizontal rules, Comment lines, Emphasis and monospace, Structural markup elements
8660 @subheading Horizontal rules
8661 @cindex horizontal rules, markup rules
8662 A line consisting of only dashes, and at least 5 of them, will be
8663 exported as a horizontal line (@samp{<hr/>} in HTML).
8665 @node Comment lines, , Horizontal rules, Structural markup elements
8666 @subheading Comment lines
8667 @cindex comment lines
8668 @cindex exporting, not
8669 @cindex #+BEGIN_COMMENT
8671 Lines starting with @samp{#} in column zero are treated as comments and will
8672 never be exported. If you want an indented line to be treated as a comment,
8673 start it with @samp{#+ }. Also entire subtrees starting with the word
8674 @samp{COMMENT} will never be exported. Finally, regions surrounded by
8675 @samp{#+BEGIN_COMMENT} ... @samp{#+END_COMMENT} will not be exported.
8680 Toggle the COMMENT keyword at the beginning of an entry.
8684 @node Images and tables, Literal examples, Structural markup elements, Markup
8685 @section Images and Tables
8687 @cindex tables, markup rules
8690 Both the native Org-mode tables (@pxref{Tables}) and tables formatted with
8691 the @file{table.el} package will be exported properly. For Org-mode tables,
8692 the lines before the first horizontal separator line will become table header
8693 lines. You can use the following lines somewhere before the table to assign
8694 a caption and a label for cross references, and in the text you can refer to
8695 the object with @code{\ref@{tab:basic-data@}}:
8698 #+CAPTION: This is the caption for the next table (or link)
8699 #+LABEL: tbl:basic-data
8704 @cindex inlined images, markup rules
8705 Some backends (HTML, @LaTeX{}, and DocBook) allow you to directly include
8706 images into the exported document. Org does this, if a link to an image
8707 files does not have a description part, for example @code{[[./img/a.jpg]]}.
8708 If you wish to define a caption for the image and maybe a label for internal
8709 cross references, make sure that the link is on a line by itself and precede
8710 it with @code{#+CAPTION} and @code{#+LABEL} as follows:
8713 #+CAPTION: This is the caption for the next figure link (or table)
8714 #+LABEL: fig:SED-HR4049
8718 You may also define additional attributes for the figure. As this is
8719 backend-specific, see the sections about the individual backends for more
8722 @xref{Handling links,the discussion of image links}.
8724 @node Literal examples, Include files, Images and tables, Markup
8725 @section Literal examples
8726 @cindex literal examples, markup rules
8727 @cindex code line references, markup rules
8729 You can include literal examples that should not be subjected to
8730 markup. Such examples will be typeset in monospace, so this is well suited
8731 for source code and similar examples.
8732 @cindex #+BEGIN_EXAMPLE
8736 Some example from a text file.
8740 Note that such blocks may be @i{indented} in order to align nicely with
8741 indented text and in particular with plain list structure (@pxref{Plain
8742 lists}). For simplicity when using small examples, you can also start the
8743 example lines with a colon followed by a space. There may also be additional
8744 whitespace before the colon:
8748 : Some example from a text file.
8751 @cindex formatting source code, markup rules
8752 If the example is source code from a programming language, or any other text
8753 that can be marked up by font-lock in Emacs, you can ask for the example to
8754 look like the fontified Emacs buffer@footnote{This works automatically for
8755 the HTML backend (it requires version 1.34 of the @file{htmlize.el} package,
8756 which is distributed with Org). Fontified code chunks in LaTeX can be
8757 achieved using either the listings or the
8758 @url{http://code.google.com/p/minted, minted,} package. To use listings, turn
8759 on the variable @code{org-export-latex-listings} and ensure that the listings
8760 package is included by the LaTeX header (e.g. by configuring
8761 @code{org-export-latex-packages-alist}). See the listings documentation for
8762 configuration options, including obtaining colored output. For minted it is
8763 necessary to install the program @url{http://pygments.org, pygments}, in
8764 addition to setting @code{org-export-latex-minted}, ensuring that the minted
8765 package is included by the LaTeX header, and ensuring that the
8766 @code{-shell-escape} option is passed to @file{pdflatex} (see
8767 @code{org-latex-to-pdf-process}). See the documentation of the variables
8768 @code{org-export-latex-listings} and @code{org-export-latex-minted} for
8769 further details.}. This is done with the @samp{src} block, where you also
8770 need to specify the name of the major mode that should be used to fontify the
8775 #+BEGIN_SRC emacs-lisp
8776 (defun org-xor (a b)
8782 Both in @code{example} and in @code{src} snippets, you can add a @code{-n}
8783 switch to the end of the @code{BEGIN} line, to get the lines of the example
8784 numbered. If you use a @code{+n} switch, the numbering from the previous
8785 numbered snippet will be continued in the current one. In literal examples,
8786 Org will interpret strings like @samp{(ref:name)} as labels, and use them as
8787 targets for special hyperlinks like @code{[[(name)]]} (i.e. the reference name
8788 enclosed in single parenthesis). In HTML, hovering the mouse over such a
8789 link will remote-highlight the corresponding code line, which is kind of
8792 You can also add a @code{-r} switch which @i{removes} the labels from the
8793 source code@footnote{Adding @code{-k} to @code{-n -r} will @i{keep} the
8794 labels in the source code while using line numbers for the links, which might
8795 be useful to explain those in an org-mode example code.}. With the @code{-n}
8796 switch, links to these references will be labeled by the line numbers from
8797 the code listing, otherwise links will use the labels with no parentheses.
8801 #+BEGIN_SRC emacs-lisp -n -r
8802 (save-excursion (ref:sc)
8803 (goto-char (point-min)) (ref:jump)
8805 In line [[(sc)]] we remember the current position. [[(jump)][Line (jump)]]
8809 @vindex org-coderef-label-format
8810 If the syntax for the label format conflicts with the language syntax, use a
8811 @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
8812 -n -r -l "((%s))"}. See also the variable @code{org-coderef-label-format}.
8814 HTML export also allows examples to be published as text areas, @xref{Text
8815 areas in HTML export}.
8820 Edit the source code example at point in its native mode. This works by
8821 switching to a temporary buffer with the source code. You need to exit by
8822 pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*}
8823 or @samp{#} will get a comma prepended, to keep them from being interpreted
8824 by Org as outline nodes or special comments. These commas will be stripped
8825 for editing with @kbd{C-c '}, and also for export.}. The edited version will
8826 then replace the old version in the Org buffer. Fixed-width regions
8827 (where each line starts with a colon followed by a space) will be edited
8828 using @code{artist-mode}@footnote{You may select a different-mode with the
8829 variable @code{org-edit-fixed-width-region-mode}.} to allow creating ASCII
8830 drawings easily. Using this command in an empty line will create a new
8834 Calling @code{org-store-link} while editing a source code example in a
8835 temporary buffer created with @kbd{C-c '} will prompt for a label. Make sure
8836 that it is unique in the current buffer, and insert it with the proper
8837 formatting like @samp{(ref:label)} at the end of the current line. Then the
8838 label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
8842 @node Include files, Index entries, Literal examples, Markup
8843 @section Include files
8844 @cindex include files, markup rules
8846 During export, you can include the content of another file. For example, to
8847 include your @file{.emacs} file, you could use:
8851 #+INCLUDE: "~/.emacs" src emacs-lisp
8854 The optional second and third parameter are the markup (e.g. @samp{quote},
8855 @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the
8856 language for formatting the contents. The markup is optional; if it is not
8857 given, the text will be assumed to be in Org-mode format and will be
8858 processed normally. The include line will also allow additional keyword
8859 parameters @code{:prefix1} and @code{:prefix} to specify prefixes for the
8860 first line and for each following line, @code{:minlevel} in order to get
8861 org-mode content demoted to a specified level, as well as any options
8862 accepted by the selected markup. For example, to include a file as an item,
8866 #+INCLUDE: "~/snippets/xx" :prefix1 " + " :prefix " "
8872 Visit the include file at point.
8875 @node Index entries, Macro replacement, Include files, Markup
8876 @section Index entries
8877 @cindex index entries, for publishing
8879 You can specify entries that will be used for generating an index during
8880 publishing. This is done by lines starting with @code{#+INDEX}. An entry
8881 the contains an exclamation mark will create a sub item. See @ref{Generating
8882 an index} for more information.
8887 #+INDEX: Application!CV
8893 @node Macro replacement, Embedded LaTeX, Index entries, Markup
8894 @section Macro replacement
8895 @cindex macro replacement, during export
8898 You can define text snippets with
8901 #+MACRO: name replacement text $1, $2 are arguments
8904 @noindent which can be referenced anywhere in the document (even in
8905 code examples) with @code{@{@{@{name(arg1,arg2)@}@}@}}. In addition to
8906 defined macros, @code{@{@{@{title@}@}@}}, @code{@{@{@{author@}@}@}}, etc.,
8907 will reference information set by the @code{#+TITLE:}, @code{#+AUTHOR:}, and
8908 similar lines. Also, @code{@{@{@{date(@var{FORMAT})@}@}@}} and
8909 @code{@{@{@{modification-time(@var{FORMAT})@}@}@}} refer to current date time
8910 and to the modification time of the file being exported, respectively.
8911 @var{FORMAT} should be a format string understood by
8912 @code{format-time-string}.
8914 Macro expansion takes place during export, and some people use it to
8915 construct complex HTML code.
8918 @node Embedded LaTeX, , Macro replacement, Markup
8919 @section Embedded @LaTeX{}
8920 @cindex @TeX{} interpretation
8921 @cindex @LaTeX{} interpretation
8923 Plain ASCII is normally sufficient for almost all note taking. Exceptions
8924 include scientific notes, which often require mathematical symbols and the
8925 occasional formula. @LaTeX{}@footnote{@LaTeX{} is a macro system based on
8926 Donald E. Knuth's @TeX{} system. Many of the features described here as
8927 ``@LaTeX{}'' are really from @TeX{}, but for simplicity I am blurring this
8928 distinction.} is widely used to typeset scientific documents. Org-mode
8929 supports embedding @LaTeX{} code into its files, because many academics are
8930 used to writing and reading @LaTeX{} source code, and because it can be
8931 readily processed to produce pretty output for a number of export backends.
8934 * Special symbols:: Greek letters and other symbols
8935 * Subscripts and superscripts:: Simple syntax for raising/lowering text
8936 * LaTeX fragments:: Complex formulas made easy
8937 * Previewing LaTeX fragments:: What will this snippet look like?
8938 * CDLaTeX mode:: Speed up entering of formulas
8941 @node Special symbols, Subscripts and superscripts, Embedded LaTeX, Embedded LaTeX
8942 @subsection Special symbols
8943 @cindex math symbols
8944 @cindex special symbols
8945 @cindex @TeX{} macros
8946 @cindex @LaTeX{} fragments, markup rules
8947 @cindex HTML entities
8948 @cindex @LaTeX{} entities
8950 You can use @LaTeX{} macros to insert special symbols like @samp{\alpha} to
8951 indicate the Greek letter, or @samp{\to} to indicate an arrow. Completion
8952 for these macros is available, just type @samp{\} and maybe a few letters,
8953 and press @kbd{M-@key{TAB}} to see possible completions. Unlike @LaTeX{}
8954 code, Org-mode allows these macros to be present without surrounding math
8955 delimiters, for example:
8958 Angles are written as Greek letters \alpha, \beta and \gamma.
8961 @vindex org-entities
8962 During export, these symbols will be transformed into the native format of
8963 the exporter backend. Strings like @code{\alpha} will be exported as
8964 @code{α} in the HTML output, and as @code{$\alpha$} in the @LaTeX{}
8965 output. Similarly, @code{\nbsp} will become @code{ } in HTML and
8966 @code{~} in @LaTeX{}. If you need such a symbol inside a word, terminate it
8967 like this: @samp{\Aacute@{@}stor}.
8969 A large number of entities is provided, with names taken from both HTML and
8970 @LaTeX{}; see the variable @code{org-entities} for the complete list.
8971 @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
8972 @samp{...} are all converted into special commands creating hyphens of
8973 different lengths or a compact set of dots.
8975 If you would like to see entities displayed as UTF8 characters, use the
8976 following command@footnote{You can turn this on by default by setting the
8977 variable @code{org-pretty-entities}, or on a per-file base with the
8978 @code{#+STARTUP} option @code{entitiespretty}.}:
8983 Toggle display of entities as UTF-8 characters. This does not change the
8984 buffer content which remains plain ASCII, but it overlays the UTF-8 character
8985 for display purposes only.
8988 @node Subscripts and superscripts, LaTeX fragments, Special symbols, Embedded LaTeX
8989 @subsection Subscripts and superscripts
8993 Just like in @LaTeX{}, @samp{^} and @samp{_} are used to indicate super-
8994 and subscripts. Again, these can be used without embedding them in
8995 math-mode delimiters. To increase the readability of ASCII text, it is
8996 not necessary (but OK) to surround multi-character sub- and superscripts
8997 with curly braces. For example
9000 The mass of the sun is M_sun = 1.989 x 10^30 kg. The radius of
9001 the sun is R_@{sun@} = 6.96 x 10^8 m.
9004 @vindex org-export-with-sub-superscripts
9005 To avoid interpretation as raised or lowered text, you can quote @samp{^} and
9006 @samp{_} with a backslash: @samp{\^} and @samp{\_}. If you write a text
9007 where the underscore is often used in a different context, Org's convention
9008 to always interpret these as subscripts can get in your way. Configure the
9009 variable @code{org-export-with-sub-superscripts} to globally change this
9010 convention, or use, on a per-file basis:
9016 @noindent With this setting, @samp{a_b} will not be interpreted as a
9017 subscript, but @samp{a_@{b@}} will.
9022 In addition to showing entities as UTF-8 characters, this command will also
9023 format sub- and superscripts in a WYSIWYM way.
9026 @node LaTeX fragments, Previewing LaTeX fragments, Subscripts and superscripts, Embedded LaTeX
9027 @subsection @LaTeX{} fragments
9028 @cindex @LaTeX{} fragments
9030 @vindex org-format-latex-header
9031 Going beyond symbols and sub- and superscripts, a full formula language is
9032 needed. Org-mode can contain @LaTeX{} math fragments, and it supports ways
9033 to process these for several export backends. When exporting to @LaTeX{},
9034 the code is obviously left as it is. When exporting to HTML, Org invokes the
9035 @uref{http://www.mathjax.org, MathJax library} (@pxref{Math formatting in
9036 HTML export}) to process and display the math@footnote{If you plan to use
9037 this regularly or on pages with significant page views, you should install
9038 @file{MathJax} on your own
9039 server in order to limit the load of our server.}. Finally, it can also
9040 process the mathematical expressions into images@footnote{For this to work
9041 you need to be on a system with a working @LaTeX{} installation. You also
9042 need the @file{dvipng} program, available at
9043 @url{http://sourceforge.net/projects/dvipng/}. The @LaTeX{} header that will
9044 be used when processing a fragment can be configured with the variable
9045 @code{org-format-latex-header}.} that can be displayed in a browser or in
9048 @LaTeX{} fragments don't need any special marking at all. The following
9049 snippets will be identified as @LaTeX{} source code:
9052 Environments of any kind@footnote{When @file{MathJax} is used, only the
9053 environment recognized by @file{MathJax} will be processed. When
9054 @file{dvipng} is used to create images, any @LaTeX{} environments will be
9055 handled.}. The only requirement is that the @code{\begin} statement appears
9056 on a new line, preceded by only whitespace.
9058 Text within the usual @LaTeX{} math delimiters. To avoid conflicts with
9059 currency specifications, single @samp{$} characters are only recognized as
9060 math delimiters if the enclosed text contains at most two line breaks, is
9061 directly attached to the @samp{$} characters with no whitespace in between,
9062 and if the closing @samp{$} is followed by whitespace, punctuation or a dash.
9063 For the other delimiters, there is no such restriction, so when in doubt, use
9064 @samp{\(...\)} as inline math delimiters.
9067 @noindent For example:
9070 \begin@{equation@} % arbitrary environments,
9071 x=\sqrt@{b@} % even tables, figures
9072 \end@{equation@} % etc
9074 If $a^2=b$ and \( b=2 \), then the solution must be
9075 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
9079 @vindex org-format-latex-options
9080 If you need any of the delimiter ASCII sequences for other purposes, you
9081 can configure the option @code{org-format-latex-options} to deselect the
9082 ones you do not wish to have interpreted by the @LaTeX{} converter.
9084 @vindex org-export-with-LaTeX-fragments
9085 LaTeX processing can be configured with the variable
9086 @code{org-export-with-LaTeX-fragments}. The default setting is @code{t}
9087 which means @file{MathJax} for HTML, and no processing for DocBook, ASCII and
9088 LaTeX backends. You can also set this variable on a per-file basis using one
9092 #+OPTIONS: LaTeX:t @r{Do the right thing automatically (MathJax)}
9093 #+OPTIONS: LaTeX:dvipng @r{Force using dvipng images}
9094 #+OPTIONS: LaTeX:nil @r{Do not process @LaTeX{} fragments at all}
9095 #+OPTIONS: LaTeX:verbatim @r{Verbatim export, for jsMath or so}
9098 @node Previewing LaTeX fragments, CDLaTeX mode, LaTeX fragments, Embedded LaTeX
9099 @subsection Previewing LaTeX fragments
9100 @cindex LaTeX fragments, preview
9102 If you have @file{dvipng} installed, @LaTeX{} fragments can be processed to
9103 produce preview images of the typeset expressions:
9108 Produce a preview image of the @LaTeX{} fragment at point and overlay it
9109 over the source code. If there is no fragment at point, process all
9110 fragments in the current entry (between two headlines). When called
9111 with a prefix argument, process the entire subtree. When called with
9112 two prefix arguments, or when the cursor is before the first headline,
9113 process the entire buffer.
9116 Remove the overlay preview images.
9119 @vindex org-format-latex-options
9120 You can customize the variable @code{org-format-latex-options} to influence
9121 some aspects of the preview. In particular, the @code{:scale} (and for HTML
9122 export, @code{:html-scale}) property can be used to adjust the size of the
9125 @node CDLaTeX mode, , Previewing LaTeX fragments, Embedded LaTeX
9126 @subsection Using CDLa@TeX{} to enter math
9129 CDLa@TeX{} mode is a minor mode that is normally used in combination with a
9130 major @LaTeX{} mode like AUC@TeX{} in order to speed-up insertion of
9131 environments and math templates. Inside Org-mode, you can make use of
9132 some of the features of CDLa@TeX{} mode. You need to install
9133 @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
9134 AUC@TeX{}) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
9135 Don't use CDLa@TeX{} mode itself under Org-mode, but use the light
9136 version @code{org-cdlatex-mode} that comes as part of Org-mode. Turn it
9137 on for the current buffer with @code{M-x org-cdlatex-mode}, or for all
9141 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
9144 When this mode is enabled, the following features are present (for more
9145 details see the documentation of CDLa@TeX{} mode):
9149 Environment templates can be inserted with @kbd{C-c @{}.
9152 The @key{TAB} key will do template expansion if the cursor is inside a
9153 @LaTeX{} fragment@footnote{Org-mode has a method to test if the cursor is
9154 inside such a fragment, see the documentation of the function
9155 @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will
9156 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
9157 correctly inside the first brace. Another @key{TAB} will get you into
9158 the second brace. Even outside fragments, @key{TAB} will expand
9159 environment abbreviations at the beginning of a line. For example, if
9160 you write @samp{equ} at the beginning of a line and press @key{TAB},
9161 this abbreviation will be expanded to an @code{equation} environment.
9162 To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}.
9166 @vindex cdlatex-simplify-sub-super-scripts
9167 Pressing @kbd{_} and @kbd{^} inside a @LaTeX{} fragment will insert these
9168 characters together with a pair of braces. If you use @key{TAB} to move
9169 out of the braces, and if the braces surround only a single character or
9170 macro, they are removed again (depending on the variable
9171 @code{cdlatex-simplify-sub-super-scripts}).
9174 Pressing the backquote @kbd{`} followed by a character inserts math
9175 macros, also outside @LaTeX{} fragments. If you wait more than 1.5 seconds
9176 after the backquote, a help window will pop up.
9179 Pressing the single-quote @kbd{'} followed by another character modifies
9180 the symbol before point with an accent or a font. If you wait more than
9181 1.5 seconds after the single-quote, a help window will pop up. Character
9182 modification will work only inside @LaTeX{} fragments; outside the quote
9186 @node Exporting, Publishing, Markup, Top
9190 Org-mode documents can be exported into a variety of other formats. For
9191 printing and sharing of notes, ASCII export produces a readable and simple
9192 version of an Org file. HTML export allows you to publish a notes file on
9193 the web, while the XOXO format provides a solid base for exchange with a
9194 broad range of other applications. @LaTeX{} export lets you use Org-mode and
9195 its structured editing functions to easily create @LaTeX{} files. DocBook
9196 export makes it possible to convert Org files to many other formats using
9197 DocBook tools. For project management you can create gantt and resource
9198 charts by using TaskJuggler export. To incorporate entries with associated
9199 times like deadlines or appointments into a desktop calendar program like
9200 iCal, Org-mode can also produce extracts in the iCalendar format. Currently
9201 Org-mode only supports export, not import of these different formats.
9203 Org supports export of selected regions when @code{transient-mark-mode} is
9204 enabled (default in Emacs 23).
9207 * Selective export:: Using tags to select and exclude trees
9208 * Export options:: Per-file export settings
9209 * The export dispatcher:: How to access exporter commands
9210 * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
9211 * HTML export:: Exporting to HTML
9212 * LaTeX and PDF export:: Exporting to @LaTeX{}, and processing to PDF
9213 * DocBook export:: Exporting to DocBook
9214 * TaskJuggler export:: Exporting to TaskJuggler
9215 * Freemind export:: Exporting to Freemind mind maps
9216 * XOXO export:: Exporting to XOXO
9217 * iCalendar export:: Exporting in iCalendar format
9220 @node Selective export, Export options, Exporting, Exporting
9221 @section Selective export
9222 @cindex export, selective by tags
9224 @vindex org-export-select-tags
9225 @vindex org-export-exclude-tags
9226 You may use tags to select the parts of a document that should be exported,
9227 or to exclude parts from export. This behavior is governed by two variables:
9228 @code{org-export-select-tags} and @code{org-export-exclude-tags}.
9230 Org first checks if any of the @emph{select} tags is present in the buffer.
9231 If yes, all trees that do not carry one of these tags will be excluded. If a
9232 selected tree is a subtree, the heading hierarchy above it will also be
9233 selected for export, but not the text below those headings.
9236 If none of the select tags is found, the whole buffer will be selected for
9240 Finally, all subtrees that are marked by any of the @emph{exclude} tags will
9241 be removed from the export buffer.
9243 @node Export options, The export dispatcher, Selective export, Exporting
9244 @section Export options
9245 @cindex options, for export
9247 @cindex completion, of option keywords
9248 The exporter recognizes special lines in the buffer which provide
9249 additional information. These lines may be put anywhere in the file.
9250 The whole set of lines can be inserted into the buffer with @kbd{C-c
9251 C-e t}. For individual lines, a good way to make sure the keyword is
9252 correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion
9253 (@pxref{Completion}). For a summary of other in-buffer settings not
9254 specifically related to export, see @ref{In-buffer settings}.
9255 In particular, note that you can place commonly-used (export) options in
9256 a separate file which can be included using @code{#+SETUPFILE}.
9259 @orgcmd{C-c C-e t,org-insert-export-options-template}
9260 Insert template with export options, see example below.
9267 @cindex #+DESCRIPTION
9275 @cindex #+EXPORT_SELECT_TAGS
9276 @cindex #+EXPORT_EXCLUDE_TAGS
9278 @cindex #+LATEX_HEADER
9279 @vindex user-full-name
9280 @vindex user-mail-address
9281 @vindex org-export-default-language
9283 #+TITLE: the title to be shown (default is the buffer name)
9284 #+AUTHOR: the author (default taken from @code{user-full-name})
9285 #+DATE: a date, fixed, or a format string for @code{format-time-string}
9286 #+EMAIL: his/her email address (default from @code{user-mail-address})
9287 #+DESCRIPTION: the page description, e.g. for the XHTML meta tag
9288 #+KEYWORDS: the page keywords, e.g. for the XHTML meta tag
9289 #+LANGUAGE: language for HTML, e.g. @samp{en} (@code{org-export-default-language})
9290 #+TEXT: Some descriptive text to be inserted at the beginning.
9291 #+TEXT: Several lines may be given.
9292 #+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ...
9293 #+BIND: lisp-var lisp-val, e.g.: org-export-latex-low-levels itemize
9294 @r{You need to confirm using these, or configure @code{org-export-allow-BIND}}
9295 #+LINK_UP: the ``up'' link of an exported page
9296 #+LINK_HOME: the ``home'' link of an exported page
9297 #+LATEX_HEADER: extra line(s) for the LaTeX header, like \usepackage@{xyz@}
9298 #+EXPORT_SELECT_TAGS: Tags that select a tree for export
9299 #+EXPORT_EXCLUDE_TAGS: Tags that exclude a tree from export
9300 #+XSLT: the XSLT stylesheet used by DocBook exporter to generate FO file
9304 The OPTIONS line is a compact@footnote{If you want to configure many options
9305 this way, you can use several OPTIONS lines.} form to specify export
9306 settings. Here you can:
9307 @cindex headline levels
9308 @cindex section-numbers
9309 @cindex table of contents
9310 @cindex line-break preservation
9311 @cindex quoted HTML tags
9312 @cindex fixed-width sections
9314 @cindex @TeX{}-like syntax for sub- and superscripts
9316 @cindex special strings
9317 @cindex emphasized text
9318 @cindex @TeX{} macros
9319 @cindex @LaTeX{} fragments
9320 @cindex author info, in export
9321 @cindex time info, in export
9323 H: @r{set the number of headline levels for export}
9324 num: @r{turn on/off section-numbers}
9325 toc: @r{turn on/off table of contents, or set level limit (integer)}
9326 \n: @r{turn on/off line-break-preservation (DOES NOT WORK)}
9327 @@: @r{turn on/off quoted HTML tags}
9328 :: @r{turn on/off fixed-width sections}
9329 |: @r{turn on/off tables}
9330 ^: @r{turn on/off @TeX{}-like syntax for sub- and superscripts. If}
9331 @r{you write "^:@{@}", @code{a_@{b@}} will be interpreted, but}
9332 @r{the simple @code{a_b} will be left as it is.}
9333 -: @r{turn on/off conversion of special strings.}
9334 f: @r{turn on/off footnotes like this[1].}
9335 todo: @r{turn on/off inclusion of TODO keywords into exported text}
9336 pri: @r{turn on/off priority cookies}
9337 tags: @r{turn on/off inclusion of tags, may also be @code{not-in-toc}}
9338 <: @r{turn on/off inclusion of any time/date stamps like DEADLINES}
9339 *: @r{turn on/off emphasized text (bold, italic, underlined)}
9340 TeX: @r{turn on/off simple @TeX{} macros in plain text}
9341 LaTeX: @r{configure export of @LaTeX{} fragments. Default @code{auto}}
9342 skip: @r{turn on/off skipping the text before the first heading}
9343 author: @r{turn on/off inclusion of author name/email into exported file}
9344 email: @r{turn on/off inclusion of author email into exported file}
9345 creator: @r{turn on/off inclusion of creator info into exported file}
9346 timestamp: @r{turn on/off inclusion creation time into exported file}
9347 d: @r{turn on/off inclusion of drawers}
9350 These options take effect in both the HTML and @LaTeX{} export, except for
9351 @code{TeX} and @code{LaTeX}, which are respectively @code{t} and @code{nil}
9352 for the @LaTeX{} export. The default values for these and many other options
9353 are given by a set of variables. For a list of such variables, the
9354 corresponding OPTIONS keys and also the publishing keys (@pxref{Project
9355 alist}), see the constant @code{org-export-plist-vars}.
9357 When exporting only a single subtree by selecting it with @kbd{C-c @@} before
9358 calling an export command, the subtree can overrule some of the file's export
9359 settings with properties @code{EXPORT_FILE_NAME}, @code{EXPORT_TITLE},
9360 @code{EXPORT_TEXT}, @code{EXPORT_AUTHOR}, @code{EXPORT_DATE}, and
9361 @code{EXPORT_OPTIONS}.
9363 @node The export dispatcher, ASCII/Latin-1/UTF-8 export, Export options, Exporting
9364 @section The export dispatcher
9365 @cindex dispatcher, for export commands
9367 All export commands can be reached using the export dispatcher, which is a
9368 prefix key that prompts for an additional key specifying the command.
9369 Normally the entire file is exported, but if there is an active region that
9370 contains one outline tree, the first heading is used as document title and
9371 the subtrees are exported.
9374 @orgcmd{C-c C-e,org-export}
9375 @vindex org-export-run-in-background
9376 Dispatcher for export and publishing commands. Displays a help-window
9377 listing the additional key(s) needed to launch an export or publishing
9378 command. The prefix arg is passed through to the exporter. A double prefix
9379 @kbd{C-u C-u} causes most commands to be executed in the background, in a
9380 separate Emacs process@footnote{To make this behavior the default, customize
9381 the variable @code{org-export-run-in-background}.}.
9382 @orgcmd{C-c C-e v,org-export-visible}
9383 Like @kbd{C-c C-e}, but only export the text that is currently visible
9384 (i.e. not hidden by outline visibility).
9385 @orgcmd{C-u C-u C-c C-e,org-export}
9386 @vindex org-export-run-in-background
9387 Call the exporter, but reverse the setting of
9388 @code{org-export-run-in-background}, i.e. request background processing if
9389 not set, or force processing in the current Emacs process if set.
9392 @node ASCII/Latin-1/UTF-8 export, HTML export, The export dispatcher, Exporting
9393 @section ASCII/Latin-1/UTF-8 export
9394 @cindex ASCII export
9395 @cindex Latin-1 export
9396 @cindex UTF-8 export
9398 ASCII export produces a simple and very readable version of an Org-mode
9399 file, containing only plain ASCII. Latin-1 and UTF-8 export augment the file
9400 with special characters and symbols available in these encodings.
9402 @cindex region, active
9403 @cindex active region
9404 @cindex transient-mark-mode
9406 @orgcmd{C-c C-e a,org-export-as-ascii}
9407 @cindex property, EXPORT_FILE_NAME
9408 Export as ASCII file. For an Org file, @file{myfile.org}, the ASCII file
9409 will be @file{myfile.txt}. The file will be overwritten without
9410 warning. If there is an active region@footnote{This requires
9411 @code{transient-mark-mode} be turned on.}, only the region will be
9412 exported. If the selected region is a single tree@footnote{To select the
9413 current subtree, use @kbd{C-c @@}.}, the tree head will
9414 become the document title. If the tree head entry has or inherits an
9415 @code{EXPORT_FILE_NAME} property, that name will be used for the
9417 @orgcmd{C-c C-e A,org-export-as-ascii-to-buffer}
9418 Export to a temporary buffer. Do not create a file.
9419 @orgcmd{C-c C-e n,org-export-as-latin1}
9420 @xorgcmd{C-c C-e N,org-export-as-latin1-to-buffer}
9421 Like the above commands, but use Latin-1 encoding.
9422 @orgcmd{C-c C-e u,org-export-as-utf8}
9423 @xorgcmd{C-c C-e U,org-export-as-utf8-to-buffer}
9424 Like the above commands, but use UTF-8 encoding.
9425 @item C-c C-e v a/n/u
9426 Export only the visible part of the document.
9429 @cindex headline levels, for exporting
9430 In the exported version, the first 3 outline levels will become
9431 headlines, defining a general document structure. Additional levels
9432 will be exported as itemized lists. If you want that transition to occur
9433 at a different level, specify it with a prefix argument. For example,
9440 creates only top level headlines and does the rest as items. When
9441 headlines are converted to items, the indentation of the text following
9442 the headline is changed to fit nicely under the item. This is done with
9443 the assumption that the first body line indicates the base indentation of
9444 the body text. Any indentation larger than this is adjusted to preserve
9445 the layout relative to the first line. Should there be lines with less
9446 indentation than the first, these are left alone.
9448 @vindex org-export-ascii-links-to-notes
9449 Links will be exported in a footnote-like style, with the descriptive part in
9450 the text and the link in a note before the next heading. See the variable
9451 @code{org-export-ascii-links-to-notes} for details and other options.
9453 @node HTML export, LaTeX and PDF export, ASCII/Latin-1/UTF-8 export, Exporting
9454 @section HTML export
9457 Org-mode contains an HTML (XHTML 1.0 strict) exporter with extensive
9458 HTML formatting, in ways similar to John Gruber's @emph{markdown}
9459 language, but with additional support for tables.
9462 * HTML Export commands:: How to invoke HTML export
9463 * Quoting HTML tags:: Using direct HTML in Org-mode
9464 * Links in HTML export:: How links will be interpreted and formatted
9465 * Tables in HTML export:: How to modify the formatting of tables
9466 * Images in HTML export:: How to insert figures into HTML output
9467 * Math formatting in HTML export:: Beautiful math also on the web
9468 * Text areas in HTML export:: An alternative way to show an example
9469 * CSS support:: Changing the appearance of the output
9470 * JavaScript support:: Info and Folding in a web browser
9473 @node HTML Export commands, Quoting HTML tags, HTML export, HTML export
9474 @subsection HTML export commands
9476 @cindex region, active
9477 @cindex active region
9478 @cindex transient-mark-mode
9480 @orgcmd{C-c C-e h,org-export-as-html}
9481 @cindex property, EXPORT_FILE_NAME
9482 Export as HTML file @file{myfile.html}. For an Org file @file{myfile.org},
9483 the ASCII file will be @file{myfile.html}. The file will be overwritten
9484 without warning. If there is an active region@footnote{This requires
9485 @code{transient-mark-mode} be turned on.}, only the region will be
9486 exported. If the selected region is a single tree@footnote{To select the
9487 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
9488 title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
9489 property, that name will be used for the export.
9490 @orgcmd{C-c C-e b,org-export-as-html-and-open}
9491 Export as HTML file and immediately open it with a browser.
9492 @orgcmd{C-c C-e H,org-export-as-html-to-buffer}
9493 Export to a temporary buffer. Do not create a file.
9494 @orgcmd{C-c C-e R,org-export-region-as-html}
9495 Export the active region to a temporary buffer. With a prefix argument, do
9496 not produce the file header and footer, but just the plain HTML section for
9497 the region. This is good for cut-and-paste operations.
9498 @item C-c C-e v h/b/H/R
9499 Export only the visible part of the document.
9500 @item M-x org-export-region-as-html
9501 Convert the region to HTML under the assumption that it was Org-mode
9502 syntax before. This is a global command that can be invoked in any
9504 @item M-x org-replace-region-by-HTML
9505 Replace the active region (assumed to be in Org-mode syntax) by HTML
9509 @cindex headline levels, for exporting
9510 In the exported version, the first 3 outline levels will become headlines,
9511 defining a general document structure. Additional levels will be exported as
9512 itemized lists. If you want that transition to occur at a different level,
9513 specify it with a numeric prefix argument. For example,
9520 creates two levels of headings and does the rest as items.
9522 @node Quoting HTML tags, Links in HTML export, HTML Export commands, HTML export
9523 @subsection Quoting HTML tags
9525 Plain @samp{<} and @samp{>} are always transformed to @samp{<} and
9526 @samp{>} in HTML export. If you want to include simple HTML tags
9527 which should be interpreted as such, mark them with @samp{@@} as in
9528 @samp{@@<b>bold text@@</b>}. Note that this really works only for
9529 simple tags. For more extensive HTML that should be copied verbatim to
9530 the exported file use either
9533 @cindex #+BEGIN_HTML
9535 #+HTML: Literal HTML code for export
9539 @cindex #+BEGIN_HTML
9543 All lines between these markers are exported literally
9548 @node Links in HTML export, Tables in HTML export, Quoting HTML tags, HTML export
9549 @subsection Links in HTML export
9551 @cindex links, in HTML export
9552 @cindex internal links, in HTML export
9553 @cindex external links, in HTML export
9554 Internal links (@pxref{Internal links}) will continue to work in HTML. This
9555 includes automatic links created by radio targets (@pxref{Radio
9556 targets}). Links to external files will still work if the target file is on
9557 the same @i{relative} path as the published Org file. Links to other
9558 @file{.org} files will be translated into HTML links under the assumption
9559 that an HTML version also exists of the linked file, at the same relative
9560 path. @samp{id:} links can then be used to jump to specific entries across
9561 files. For information related to linking files while publishing them to a
9562 publishing directory see @ref{Publishing links}.
9564 If you want to specify attributes for links, you can do so using a special
9565 @code{#+ATTR_HTML} line to define attributes that will be added to the
9566 @code{<a>} or @code{<img>} tags. Here is an example that sets @code{title}
9567 and @code{style} attributes for a link:
9571 #+ATTR_HTML: title="The Org-mode homepage" style="color:red;"
9572 [[http://orgmode.org]]
9575 @node Tables in HTML export, Images in HTML export, Links in HTML export, HTML export
9577 @cindex tables, in HTML
9578 @vindex org-export-html-table-tag
9580 Org-mode tables are exported to HTML using the table tag defined in
9581 @code{org-export-html-table-tag}. The default setting makes tables without
9582 cell borders and frame. If you would like to change this for individual
9583 tables, place something like the following before the table:
9588 #+CAPTION: This is a table with lines around and between cells
9589 #+ATTR_HTML: border="2" rules="all" frame="all"
9592 @node Images in HTML export, Math formatting in HTML export, Tables in HTML export, HTML export
9593 @subsection Images in HTML export
9595 @cindex images, inline in HTML
9596 @cindex inlining images in HTML
9597 @vindex org-export-html-inline-images
9598 HTML export can inline images given as links in the Org file, and
9599 it can make an image the clickable part of a link. By
9600 default@footnote{But see the variable
9601 @code{org-export-html-inline-images}.}, images are inlined if a link does
9602 not have a description. So @samp{[[file:myimg.jpg]]} will be inlined,
9603 while @samp{[[file:myimg.jpg][the image]]} will just produce a link
9604 @samp{the image} that points to the image. If the description part
9605 itself is a @code{file:} link or a @code{http:} URL pointing to an
9606 image, this image will be inlined and activated so that clicking on the
9607 image will activate the link. For example, to include a thumbnail that
9608 will link to a high resolution version of the image, you could use:
9611 [[file:highres.jpg][file:thumb.jpg]]
9614 If you need to add attributes to an inlined image, use a @code{#+ATTR_HTML}.
9615 In the example below we specify the @code{alt} and @code{title} attributes to
9616 support text viewers and accessibility, and align it to the right.
9621 #+CAPTION: A black cat stalking a spider
9622 #+ATTR_HTML: alt="cat/spider image" title="Action!" align="right"
9627 and you could use @code{http} addresses just as well.
9629 @node Math formatting in HTML export, Text areas in HTML export, Images in HTML export, HTML export
9630 @subsection Math formatting in HTML export
9634 @LaTeX{} math snippets (@pxref{LaTeX fragments}) can be displayed in two
9635 different ways on HTML pages. The default is to use the
9636 @uref{http://www.mathjax.org, MathJax system} which should work out of the
9637 box with Org mode installation because @code{http://orgmode.org} serves
9638 @file{MathJax} for Org-mode users for small applications and for testing
9639 purposes. @b{If you plan to use this regularly or on pages with significant
9640 page views, you should install@footnote{Installation instructions can be
9641 found on the MathJax website, see
9642 @uref{http://www.mathjax.org/resources/docs/?installation.html}.} MathJax on
9643 your own server in order to limit the load of our server.} To configure
9644 @file{MathJax}, use the variable @code{org-export-html-mathjax-options} or
9645 insert something like the following into the buffer:
9648 #+MATHJAX: align:"left" mathml:t path:"/MathJax/MathJax.js"
9651 @noindent See the docstring of the variable
9652 @code{org-export-html-mathjax-options} for the meaning of the parameters in
9655 If you prefer, you can also request that @LaTeX{} fragments are processed
9656 into small images that will be inserted into the browser page. Before the
9657 availability of MathJax, this was the default method for Org files. This
9658 method requires that the @file{dvipng} program is available on your system.
9659 You can still get this processing with
9662 #+OPTIONS: LaTeX:dvipng
9665 @node Text areas in HTML export, CSS support, Math formatting in HTML export, HTML export
9666 @subsection Text areas in HTML export
9668 @cindex text areas, in HTML
9669 An alternative way to publish literal code examples in HTML is to use text
9670 areas, where the example can even be edited before pasting it into an
9671 application. It is triggered by a @code{-t} switch at an @code{example} or
9672 @code{src} block. Using this switch disables any options for syntax and
9673 label highlighting, and line numbering, which may be present. You may also
9674 use @code{-h} and @code{-w} switches to specify the height and width of the
9675 text area, which default to the number of lines in the example, and 80,
9676 respectively. For example
9679 #+BEGIN_EXAMPLE -t -w 40
9680 (defun org-xor (a b)
9687 @node CSS support, JavaScript support, Text areas in HTML export, HTML export
9688 @subsection CSS support
9689 @cindex CSS, for HTML export
9690 @cindex HTML export, CSS
9692 @vindex org-export-html-todo-kwd-class-prefix
9693 @vindex org-export-html-tag-class-prefix
9694 You can also give style information for the exported file. The HTML exporter
9695 assigns the following special CSS classes@footnote{If the classes on TODO
9696 keywords and tags lead to conflicts, use the variables
9697 @code{org-export-html-todo-kwd-class-prefix} and
9698 @code{org-export-html-tag-class-prefix} to make them unique.} to appropriate
9699 parts of the document---your style specifications may change these, in
9700 addition to any of the standard classes like for headlines, tables, etc.
9702 p.author @r{author information, including email}
9703 p.date @r{publishing date}
9704 p.creator @r{creator info, about org-mode version}
9705 .title @r{document title}
9706 .todo @r{TODO keywords, all not-done states}
9707 .done @r{the DONE keywords, all stated the count as done}
9708 .WAITING @r{each TODO keyword also uses a class named after itself}
9709 .timestamp @r{timestamp}
9710 .timestamp-kwd @r{keyword associated with a timestamp, like SCHEDULED}
9711 .timestamp-wrapper @r{span around keyword plus timestamp}
9712 .tag @r{tag in a headline}
9713 ._HOME @r{each tag uses itself as a class, "@@" replaced by "_"}
9714 .target @r{target for links}
9715 .linenr @r{the line number in a code example}
9716 .code-highlighted @r{for highlighting referenced code lines}
9717 div.outline-N @r{div for outline level N (headline plus text))}
9718 div.outline-text-N @r{extra div for text at outline level N}
9719 .section-number-N @r{section number in headlines, different for each level}
9720 div.figure @r{how to format an inlined image}
9721 pre.src @r{formatted source code}
9722 pre.example @r{normal example}
9723 p.verse @r{verse paragraph}
9724 div.footnotes @r{footnote section headline}
9725 p.footnote @r{footnote definition paragraph, containing a footnote}
9726 .footref @r{a footnote reference number (always a <sup>)}
9727 .footnum @r{footnote number in footnote definition (always <sup>)}
9730 @vindex org-export-html-style-default
9731 @vindex org-export-html-style-include-default
9732 @vindex org-export-html-style
9733 @vindex org-export-html-extra
9734 @vindex org-export-html-style-default
9735 Each exported file contains a compact default style that defines these
9736 classes in a basic way@footnote{This style is defined in the constant
9737 @code{org-export-html-style-default}, which you should not modify. To turn
9738 inclusion of these defaults off, customize
9739 @code{org-export-html-style-include-default}}. You may overwrite these
9740 settings, or add to them by using the variables @code{org-export-html-style}
9741 (for Org-wide settings) and @code{org-export-html-style-extra} (for more
9742 fine-grained settings, like file-local settings). To set the latter variable
9743 individually for each file, you can use
9747 #+STYLE: <link rel="stylesheet" type="text/css" href="stylesheet.css" />
9751 For longer style definitions, you can use several such lines. You could also
9752 directly write a @code{<style>} @code{</style>} section in this way, without
9753 referring to an external file.
9755 In order to add styles to a subtree, use the @code{:HTML_CONTAINER_CLASS:}
9756 property to assign a class to the tree. In order to specify CSS styles for a
9757 particular headline, you can use the id specified in a @code{:CUSTOM_ID:}
9760 @c FIXME: More about header and footer styles
9761 @c FIXME: Talk about links and targets.
9763 @node JavaScript support, , CSS support, HTML export
9764 @subsection JavaScript supported display of web pages
9766 @cindex Rose, Sebastian
9767 Sebastian Rose has written a JavaScript program especially designed to
9768 enhance the web viewing experience of HTML files created with Org. This
9769 program allows you to view large files in two different ways. The first one
9770 is an @emph{Info}-like mode where each section is displayed separately and
9771 navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
9772 as well, press @kbd{?} for an overview of the available keys). The second
9773 view type is a @emph{folding} view much like Org provides inside Emacs. The
9774 script is available at @url{http://orgmode.org/org-info.js} and you can find
9775 the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
9776 We host the script at our site, but if you use it a lot, you might
9777 not want to be dependent on @url{orgmode.org} and prefer to install a local
9778 copy on your own web server.
9780 To use the script, you need to make sure that the @file{org-jsinfo.el} module
9781 gets loaded. It should be loaded by default, but you can try @kbd{M-x
9782 customize-variable @key{RET} org-modules @key{RET}} to convince yourself that
9783 this is indeed the case. All it then takes to make use of the program is
9784 adding a single line to the Org file:
9786 @cindex #+INFOJS_OPT
9788 #+INFOJS_OPT: view:info toc:nil
9792 If this line is found, the HTML header will automatically contain the code
9793 needed to invoke the script. Using the line above, you can set the following
9797 path: @r{The path to the script. The default is to grab the script from}
9798 @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
9799 @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
9800 view: @r{Initial view when website is first shown. Possible values are:}
9801 info @r{Info-like interface with one section per page.}
9802 overview @r{Folding interface, initially showing only top-level.}
9803 content @r{Folding interface, starting with all headlines visible.}
9804 showall @r{Folding interface, all headlines and text visible.}
9805 sdepth: @r{Maximum headline level that will still become an independent}
9806 @r{section for info and folding modes. The default is taken from}
9807 @r{@code{org-export-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
9808 @r{If this is smaller than in @code{org-export-headline-levels}, each}
9809 @r{info/folding section can still contain child headlines.}
9810 toc: @r{Should the table of contents @emph{initially} be visible?}
9811 @r{Even when @code{nil}, you can always get to the "toc" with @kbd{i}.}
9812 tdepth: @r{The depth of the table of contents. The defaults are taken from}
9813 @r{the variables @code{org-export-headline-levels} and @code{org-export-with-toc}.}
9814 ftoc: @r{Does the CSS of the page specify a fixed position for the "toc"?}
9815 @r{If yes, the toc will never be displayed as a section.}
9816 ltoc: @r{Should there be short contents (children) in each section?}
9817 @r{Make this @code{above} if the section should be above initial text.}
9818 mouse: @r{Headings are highlighted when the mouse is over them. Should be}
9819 @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
9820 buttons: @r{Should view-toggle buttons be everywhere? When @code{nil} (the}
9821 @r{default), only one such button will be present.}
9824 @vindex org-infojs-options
9825 @vindex org-export-html-use-infojs
9826 You can choose default values for these options by customizing the variable
9827 @code{org-infojs-options}. If you always want to apply the script to your
9828 pages, configure the variable @code{org-export-html-use-infojs}.
9830 @node LaTeX and PDF export, DocBook export, HTML export, Exporting
9831 @section @LaTeX{} and PDF export
9832 @cindex @LaTeX{} export
9834 @cindex Guerry, Bastien
9836 Org-mode contains a @LaTeX{} exporter written by Bastien Guerry. With
9837 further processing@footnote{The default LaTeX output is designed for
9838 processing with pdftex or latex. It includes packages that are not
9839 compatible with xetex and possibly luatex. See the variables
9840 @code{org-export-latex-default-packages-alist} and
9841 @code{org-export-latex-packages-alist}.}, this backend is also used to
9842 produce PDF output. Since the @LaTeX{} output uses @file{hyperref} to
9843 implement links and cross references, the PDF output file will be fully
9847 * LaTeX/PDF export commands:: Which key invokes which commands
9848 * Header and sectioning:: Setting up the export file structure
9849 * Quoting LaTeX code:: Incorporating literal @LaTeX{} code
9850 * Tables in LaTeX export:: Options for exporting tables to @LaTeX{}
9851 * Images in LaTeX export:: How to insert figures into @LaTeX{} output
9852 * Beamer class export:: Turning the file into a presentation
9855 @node LaTeX/PDF export commands, Header and sectioning, LaTeX and PDF export, LaTeX and PDF export
9856 @subsection @LaTeX{} export commands
9858 @cindex region, active
9859 @cindex active region
9860 @cindex transient-mark-mode
9862 @orgcmd{C-c C-e l,org-export-as-latex}
9863 @cindex property EXPORT_FILE_NAME
9864 Export as @LaTeX{} file @file{myfile.tex}. For an Org file
9865 @file{myfile.org}, the ASCII file will be @file{myfile.tex}. The file will
9866 be overwritten without warning. If there is an active region@footnote{This
9867 requires @code{transient-mark-mode} be turned on.}, only the region will be
9868 exported. If the selected region is a single tree@footnote{To select the
9869 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
9870 title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME}
9871 property, that name will be used for the export.
9872 @orgcmd{C-c C-e L,org-export-as-latex-to-buffer}
9873 Export to a temporary buffer. Do not create a file.
9875 Export only the visible part of the document.
9876 @item M-x org-export-region-as-latex
9877 Convert the region to @LaTeX{} under the assumption that it was Org-mode
9878 syntax before. This is a global command that can be invoked in any
9880 @item M-x org-replace-region-by-latex
9881 Replace the active region (assumed to be in Org-mode syntax) by @LaTeX{}
9883 @orgcmd{C-c C-e p,org-export-as-pdf}
9884 Export as @LaTeX{} and then process to PDF.
9885 @orgcmd{C-c C-e d,org-export-as-pdf-and-open}
9886 Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
9889 @cindex headline levels, for exporting
9890 @vindex org-latex-low-levels
9891 In the exported version, the first 3 outline levels will become
9892 headlines, defining a general document structure. Additional levels
9893 will be exported as description lists. The exporter can ignore them or
9894 convert them to a custom string depending on
9895 @code{org-latex-low-levels}.
9897 If you want that transition to occur at a different level, specify it
9898 with a numeric prefix argument. For example,
9905 creates two levels of headings and does the rest as items.
9907 @node Header and sectioning, Quoting LaTeX code, LaTeX/PDF export commands, LaTeX and PDF export
9908 @subsection Header and sectioning structure
9909 @cindex @LaTeX{} class
9910 @cindex @LaTeX{} sectioning structure
9911 @cindex @LaTeX{} header
9912 @cindex header, for LaTeX files
9913 @cindex sectioning structure, for LaTeX export
9915 By default, the @LaTeX{} output uses the class @code{article}.
9917 @vindex org-export-latex-default-class
9918 @vindex org-export-latex-classes
9919 @vindex org-export-latex-default-packages-alist
9920 @vindex org-export-latex-packages-alist
9921 @cindex #+LATEX_HEADER
9922 @cindex #+LATEX_CLASS
9923 @cindex #+LATEX_CLASS_OPTIONS
9924 @cindex property, LATEX_CLASS
9925 @cindex property, LATEX_CLASS_OPTIONS
9926 You can change this globally by setting a different value for
9927 @code{org-export-latex-default-class} or locally by adding an option like
9928 @code{#+LaTeX_CLASS: myclass} in your file, or with a @code{:LaTeX_CLASS:}
9929 property that applies when exporting a region containing only this (sub)tree.
9930 The class must be listed in @code{org-export-latex-classes}. This variable
9931 defines a header template for each class@footnote{Into which the values of
9932 @code{org-export-latex-default-packages-alist} and
9933 @code{org-export-latex-packages-alist} are spliced.}, and allows you to
9934 define the sectioning structure for each class. You can also define your own
9935 classes there. @code{#+LaTeX_CLASS_OPTIONS} or a @code{LaTeX_CLASS_OPTIONS}
9936 property can specify the options for the @code{\documentclass} macro. You
9937 can also use @code{#+LATEX_HEADER: \usepackage@{xyz@}} to add lines to the
9938 header. See the docstring of @code{org-export-latex-classes} for more
9941 @node Quoting LaTeX code, Tables in LaTeX export, Header and sectioning, LaTeX and PDF export
9942 @subsection Quoting @LaTeX{} code
9944 Embedded @LaTeX{} as described in @ref{Embedded LaTeX}, will be correctly
9945 inserted into the @LaTeX{} file. This includes simple macros like
9946 @samp{\ref@{LABEL@}} to create a cross reference to a figure. Furthermore,
9947 you can add special code that should only be present in @LaTeX{} export with
9948 the following constructs:
9951 @cindex #+BEGIN_LaTeX
9953 #+LaTeX: Literal LaTeX code for export
9957 @cindex #+BEGIN_LaTeX
9961 All lines between these markers are exported literally
9966 @node Tables in LaTeX export, Images in LaTeX export, Quoting LaTeX code, LaTeX and PDF export
9967 @subsection Tables in @LaTeX{} export
9968 @cindex tables, in @LaTeX{} export
9970 For @LaTeX{} export of a table, you can specify a label and a caption
9971 (@pxref{Images and tables}). You can also use the @code{ATTR_LaTeX} line to
9972 request a @code{longtable} environment for the table, so that it may span
9973 several pages, or provide the @code{multicolumn} keyword that will make the
9974 table span the page in a multicolumn environment (@code{table*} environment).
9975 Finally, you can set the alignment string:
9979 @cindex #+ATTR_LaTeX
9981 #+CAPTION: A long table
9983 #+ATTR_LaTeX: longtable align=l|lp@{3cm@}r|l
9989 @node Images in LaTeX export, Beamer class export, Tables in LaTeX export, LaTeX and PDF export
9990 @subsection Images in @LaTeX{} export
9991 @cindex images, inline in @LaTeX{}
9992 @cindex inlining images in @LaTeX{}
9994 Images that are linked to without a description part in the link, like
9995 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
9996 output file resulting from @LaTeX{} processing. Org will use an
9997 @code{\includegraphics} macro to insert the image. If you have specified a
9998 caption and/or a label as described in @ref{Images and tables}, the figure
9999 will be wrapped into a @code{figure} environment and thus become a floating
10000 element. You can use an @code{#+ATTR_LaTeX:} line to specify the various
10001 options that can be used in the optional argument of the
10002 @code{\includegraphics} macro. To modify the placement option of the
10003 @code{figure} environment, add something like @samp{placement=[h!]} to the
10006 If you would like to let text flow around the image, add the word @samp{wrap}
10007 to the @code{#+ATTR_LaTeX:} line, which will make the figure occupy the left
10008 half of the page. To fine-tune, the @code{placement} field will be the set
10009 of additional arguments needed by the @code{wrapfigure} environment. Note
10010 that if you change the size of the image, you need to use compatible settings
10011 for @code{\includegraphics} and @code{wrapfigure}.
10015 @cindex #+ATTR_LaTeX
10017 #+CAPTION: The black-body emission of the disk around HR 4049
10018 #+LABEL: fig:SED-HR4049
10019 #+ATTR_LaTeX: width=5cm,angle=90
10020 [[./img/sed-hr4049.pdf]]
10022 #+ATTR_LaTeX: width=0.38\textwidth wrap placement=@{r@}@{0.4\textwidth@}
10026 If you need references to a label created in this way, write
10027 @samp{\ref@{fig:SED-HR4049@}} just like in @LaTeX{}.
10029 @node Beamer class export, , Images in LaTeX export, LaTeX and PDF export
10030 @subsection Beamer class export
10032 The LaTeX class @file{beamer} allows production of high quality presentations
10033 using LaTeX and pdf processing. Org-mode has special support for turning an
10034 Org-mode file or tree into a @file{beamer} presentation.
10036 When the LaTeX class for the current buffer (as set with @code{#+LaTeX_CLASS:
10037 beamer}) or subtree (set with a @code{LaTeX_CLASS} property) is
10038 @code{beamer}, a special export mode will turn the file or tree into a beamer
10039 presentation. Any tree with not-too-deep level nesting should in principle be
10040 exportable as a beamer presentation. By default, the top-level entries (or
10041 the first level below the selected subtree heading) will be turned into
10042 frames, and the outline structure below this level will become itemize lists.
10043 You can also configure the variable @code{org-beamer-frame-level} to a
10044 different level---then the hierarchy above frames will produce the sectioning
10045 structure of the presentation.
10047 A template for useful in-buffer settings or properties can be inserted into
10048 the buffer with @kbd{M-x org-insert-beamer-options-template}. Among other
10049 things, this will install a column view format which is very handy for
10050 editing special properties used by beamer.
10052 You can influence the structure of the presentation using the following
10057 The environment that should be used to format this entry. Valid environments
10058 are defined in the constant @code{org-beamer-environments-default}, and you
10059 can define more in @code{org-beamer-environments-extra}. If this property is
10060 set, the entry will also get a @code{:B_environment:} tag to make this
10061 visible. This tag has no semantic meaning, it is only a visual aid.
10062 @item BEAMER_envargs
10063 The beamer-special arguments that should be used for the environment, like
10064 @code{[t]} or @code{[<+->]} of @code{<2-3>}. If the @code{BEAMER_col}
10065 property is also set, something like @code{C[t]} can be added here as well to
10066 set an options argument for the implied @code{columns} environment.
10067 @code{c[t]} or @code{c<2->} will set an options for the implied @code{column}
10070 The width of a column that should start with this entry. If this property is
10071 set, the entry will also get a @code{:BMCOL:} property to make this visible.
10072 Also this tag is only a visual aid. When this is a plain number, it will be
10073 interpreted as a fraction of @code{\textwidth}. Otherwise it will be assumed
10074 that you have specified the units, like @samp{3cm}. The first such property
10075 in a frame will start a @code{columns} environment to surround the columns.
10076 This environment is closed when an entry has a @code{BEAMER_col} property
10077 with value 0 or 1, or automatically at the end of the frame.
10079 Additional commands that should be inserted after the environment has been
10080 opened. For example, when creating a frame, this can be used to specify
10084 Frames will automatically receive a @code{fragile} option if they contain
10085 source code that uses the verbatim environment. Special @file{beamer}
10086 specific code can be inserted using @code{#+BEAMER:} and
10087 @code{#+BEGIN_beamer...#+end_beamer} constructs, similar to other export
10088 backends, but with the difference that @code{#+LaTeX:} stuff will be included
10089 in the presentation as well.
10091 Outline nodes with @code{BEAMER_env} property value @samp{note} or
10092 @samp{noteNH} will be formatted as beamer notes, i,e, they will be wrapped
10093 into @code{\note@{...@}}. The former will include the heading as part of the
10094 note text, the latter will ignore the heading of that node. To simplify note
10095 generation, it is actually enough to mark the note with a @emph{tag} (either
10096 @code{:B_note:} or @code{:B_noteNH:}) instead of creating the
10097 @code{BEAMER_env} property.
10099 You can turn on a special minor mode @code{org-beamer-mode} for editing
10107 @orgcmd{C-c C-b,org-beamer-select-environment}
10108 In @code{org-beamer-mode}, this key offers fast selection of a beamer
10109 environment or the @code{BEAMER_col} property.
10112 Column view provides a great way to set the environment of a node and other
10113 important parameters. Make sure you are using a COLUMN format that is geared
10114 toward this special purpose. The command @kbd{M-x
10115 org-insert-beamer-options-template} defines such a format.
10117 Here is a simple example Org document that is intended for beamer export.
10120 #+LaTeX_CLASS: beamer
10121 #+TITLE: Example Presentation
10122 #+AUTHOR: Carsten Dominik
10123 #+LaTeX_CLASS_OPTIONS: [presentation]
10124 #+BEAMER_FRAME_LEVEL: 2
10125 #+BEAMER_HEADER_EXTRA: \usetheme@{Madrid@}\usecolortheme@{default@}
10126 #+COLUMNS: %35ITEM %10BEAMER_env(Env) %10BEAMER_envargs(Args) %4BEAMER_col(Col) %8BEAMER_extra(Ex)
10128 * This is the first structural section
10130 ** Frame 1 \\ with a subtitle
10131 *** Thanks to Eric Fraga :BMCOL:B_block:
10134 :BEAMER_envargs: C[t]
10137 for the first viable beamer setup in Org
10138 *** Thanks to everyone else :BMCOL:B_block:
10142 :BEAMER_envargs: <2->
10144 for contributing to the discussion
10145 **** This will be formatted as a beamer note :B_note:
10146 ** Frame 2 \\ where we will not use columns
10147 *** Request :B_block:
10148 Please test this stuff!
10154 For more information, see the documentation on Worg.
10156 @node DocBook export, TaskJuggler export, LaTeX and PDF export, Exporting
10157 @section DocBook export
10158 @cindex DocBook export
10160 @cindex Cui, Baoqiu
10162 Org contains a DocBook exporter written by Baoqiu Cui. Once an Org file is
10163 exported to DocBook format, it can be further processed to produce other
10164 formats, including PDF, HTML, man pages, etc., using many available DocBook
10165 tools and stylesheets.
10167 Currently DocBook exporter only supports DocBook V5.0.
10170 * DocBook export commands:: How to invoke DocBook export
10171 * Quoting DocBook code:: Incorporating DocBook code in Org files
10172 * Recursive sections:: Recursive sections in DocBook
10173 * Tables in DocBook export:: Tables are exported as HTML tables
10174 * Images in DocBook export:: How to insert figures into DocBook output
10175 * Special characters:: How to handle special characters
10178 @node DocBook export commands, Quoting DocBook code, DocBook export, DocBook export
10179 @subsection DocBook export commands
10181 @cindex region, active
10182 @cindex active region
10183 @cindex transient-mark-mode
10185 @orgcmd{C-c C-e D,org-export-as-docbook}
10186 @cindex property EXPORT_FILE_NAME
10187 Export as DocBook file. For an Org file, @file{myfile.org}, the DocBook XML
10188 file will be @file{myfile.xml}. The file will be overwritten without
10189 warning. If there is an active region@footnote{This requires
10190 @code{transient-mark-mode} to be turned on}, only the region will be
10191 exported. If the selected region is a single tree@footnote{To select the
10192 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
10193 title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
10194 property, that name will be used for the export.
10195 @orgcmd{C-c C-e V,org-export-as-docbook-pdf-and-open}
10196 Export as DocBook file, process to PDF, then open the resulting PDF file.
10198 @vindex org-export-docbook-xslt-proc-command
10199 @vindex org-export-docbook-xsl-fo-proc-command
10200 Note that, in order to produce PDF output based on exported DocBook file, you
10201 need to have XSLT processor and XSL-FO processor software installed on your
10202 system. Check variables @code{org-export-docbook-xslt-proc-command} and
10203 @code{org-export-docbook-xsl-fo-proc-command}.
10205 @vindex org-export-docbook-xslt-stylesheet
10206 The stylesheet argument @code{%s} in variable
10207 @code{org-export-docbook-xslt-proc-command} is replaced by the value of
10208 variable @code{org-export-docbook-xslt-stylesheet}, which needs to be set by
10209 the user. You can also overrule this global setting on a per-file basis by
10210 adding an in-buffer setting @code{#+XSLT:} to the Org file.
10212 @orgkey{C-c C-e v D}
10213 Export only the visible part of the document.
10216 @node Quoting DocBook code, Recursive sections, DocBook export commands, DocBook export
10217 @subsection Quoting DocBook code
10219 You can quote DocBook code in Org files and copy it verbatim into exported
10220 DocBook file with the following constructs:
10223 @cindex #+BEGIN_DOCBOOK
10225 #+DOCBOOK: Literal DocBook code for export
10229 @cindex #+BEGIN_DOCBOOK
10233 All lines between these markers are exported by DocBook exporter
10238 For example, you can use the following lines to include a DocBook warning
10239 admonition. As to what this warning says, you should pay attention to the
10240 document context when quoting DocBook code in Org files. You may make
10241 exported DocBook XML files invalid by not quoting DocBook code correctly.
10246 <para>You should know what you are doing when quoting DocBook XML code
10247 in your Org file. Invalid DocBook XML may be generated by
10248 DocBook exporter if you are not careful!</para>
10253 @node Recursive sections, Tables in DocBook export, Quoting DocBook code, DocBook export
10254 @subsection Recursive sections
10255 @cindex DocBook recursive sections
10257 DocBook exporter exports Org files as articles using the @code{article}
10258 element in DocBook. Recursive sections, i.e. @code{section} elements, are
10259 used in exported articles. Top level headlines in Org files are exported as
10260 top level sections, and lower level headlines are exported as nested
10261 sections. The entire structure of Org files will be exported completely, no
10262 matter how many nested levels of headlines there are.
10264 Using recursive sections makes it easy to port and reuse exported DocBook
10265 code in other DocBook document types like @code{book} or @code{set}.
10267 @node Tables in DocBook export, Images in DocBook export, Recursive sections, DocBook export
10268 @subsection Tables in DocBook export
10269 @cindex tables, in DocBook export
10271 Tables in Org files are exported as HTML tables, which have been supported since
10274 If a table does not have a caption, an informal table is generated using the
10275 @code{informaltable} element; otherwise, a formal table will be generated
10276 using the @code{table} element.
10278 @node Images in DocBook export, Special characters, Tables in DocBook export, DocBook export
10279 @subsection Images in DocBook export
10280 @cindex images, inline in DocBook
10281 @cindex inlining images in DocBook
10283 Images that are linked to without a description part in the link, like
10284 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]}, will be exported to DocBook
10285 using @code{mediaobject} elements. Each @code{mediaobject} element contains
10286 an @code{imageobject} that wraps an @code{imagedata} element. If you have
10287 specified a caption for an image as described in @ref{Images and tables}, a
10288 @code{caption} element will be added in @code{mediaobject}. If a label is
10289 also specified, it will be exported as an @code{xml:id} attribute of the
10290 @code{mediaobject} element.
10292 @vindex org-export-docbook-default-image-attributes
10293 Image attributes supported by the @code{imagedata} element, like @code{align}
10294 or @code{width}, can be specified in two ways: you can either customize
10295 variable @code{org-export-docbook-default-image-attributes} or use the
10296 @code{#+ATTR_DOCBOOK:} line. Attributes specified in variable
10297 @code{org-export-docbook-default-image-attributes} are applied to all inline
10298 images in the Org file to be exported (unless they are overridden by image
10299 attributes specified in @code{#+ATTR_DOCBOOK:} lines).
10301 The @code{#+ATTR_DOCBOOK:} line can be used to specify additional image
10302 attributes or override default image attributes for individual images. If
10303 the same attribute appears in both the @code{#+ATTR_DOCBOOK:} line and
10304 variable @code{org-export-docbook-default-image-attributes}, the former
10305 takes precedence. Here is an example about how image attributes can be
10310 @cindex #+ATTR_DOCBOOK
10312 #+CAPTION: The logo of Org-mode
10313 #+LABEL: unicorn-svg
10314 #+ATTR_DOCBOOK: scalefit="1" width="100%" depth="100%"
10315 [[./img/org-mode-unicorn.svg]]
10318 @vindex org-export-docbook-inline-image-extensions
10319 By default, DocBook exporter recognizes the following image file types:
10320 @file{jpeg}, @file{jpg}, @file{png}, @file{gif}, and @file{svg}. You can
10321 customize variable @code{org-export-docbook-inline-image-extensions} to add
10322 more types to this list as long as DocBook supports them.
10324 @node Special characters, , Images in DocBook export, DocBook export
10325 @subsection Special characters in DocBook export
10326 @cindex Special characters in DocBook export
10328 @vindex org-export-docbook-doctype
10329 @vindex org-entities
10330 Special characters that are written in @TeX{}-like syntax, such as @code{\alpha},
10331 @code{\Gamma}, and @code{\Zeta}, are supported by DocBook exporter. These
10332 characters are rewritten to XML entities, like @code{α},
10333 @code{Γ}, and @code{Ζ}, based on the list saved in variable
10334 @code{org-entities}. As long as the generated DocBook file includes the
10335 corresponding entities, these special characters are recognized.
10337 You can customize variable @code{org-export-docbook-doctype} to include the
10338 entities you need. For example, you can set variable
10339 @code{org-export-docbook-doctype} to the following value to recognize all
10340 special characters included in XHTML entities:
10343 "<!DOCTYPE article [
10344 <!ENTITY % xhtml1-symbol PUBLIC
10345 \"-//W3C//ENTITIES Symbol for HTML//EN//XML\"
10346 \"http://www.w3.org/2003/entities/2007/xhtml1-symbol.ent\"
10353 @node TaskJuggler export, Freemind export, DocBook export, Exporting
10354 @section TaskJuggler export
10355 @cindex TaskJuggler export
10356 @cindex Project management
10358 @uref{http://www.taskjuggler.org/, TaskJuggler} is a project management tool.
10359 It provides an optimizing scheduler that computes your project time lines and
10360 resource assignments based on the project outline and the constraints that
10363 The TaskJuggler exporter is a bit different from other exporters, such as the
10364 HTML and LaTeX exporters for example, in that it does not export all the
10365 nodes of a document or strictly follow the order of the nodes in the
10368 Instead the TaskJuggler exporter looks for a tree that defines the tasks and
10369 a optionally tree that defines the resources for this project. It then
10370 creates a TaskJuggler file based on these trees and the attributes defined in
10373 @subsection TaskJuggler export commands
10376 @orgcmd{C-c C-e j,org-export-as-taskjuggler}
10377 Export as TaskJuggler file.
10379 @orgcmd{C-c C-e J,org-export-as-taskjuggler-and-open}
10380 Export as TaskJuggler file and then open the file with TaskJugglerUI.
10385 @vindex org-export-taskjuggler-project-tag
10386 Create your tasks as you usually do with Org-mode. Assign efforts to each
10387 task using properties (it's easiest to do this in the column view). You
10388 should end up with something similar to the example by Peter Jones in
10389 @url{http://www.contextualdevelopment.com/static/artifacts/articles/2008/project-planning/project-planning.org}.
10390 Now mark the top node of your tasks with a tag named
10391 @code{:taskjuggler_project:} (or whatever you customized
10392 @code{org-export-taskjuggler-project-tag} to). You are now ready to export
10393 the project plan with @kbd{C-c C-e J} which will export the project plan and
10394 open a gantt chart in TaskJugglerUI.
10396 @subsection Resources
10398 @vindex org-export-taskjuggler-resource-tag
10399 Next you can define resources and assign those to work on specific tasks. You
10400 can group your resources hierarchically. Tag the top node of the resources
10401 with @code{:taskjuggler_resource:} (or whatever you customized
10402 @code{org-export-taskjuggler-resource-tag} to). You can optionally assign an
10403 identifier (named @samp{resource_id}) to the resources (using the standard
10404 Org properties commands, @pxref{Property syntax}) or you can let the exporter
10405 generate identifiers automatically (the exporter picks the first word of the
10406 headline as the identifier as long as it is unique---see the documentation of
10407 @code{org-taskjuggler-get-unique-id}). Using that identifier you can then
10408 allocate resources to tasks. This is again done with the @samp{allocate}
10409 property on the tasks. Do this in column view or when on the task type
10410 @kbd{C-c C-x p allocate @key{RET} <resource_id> @key{RET}}.
10412 Once the allocations are done you can again export to TaskJuggler and check
10413 in the Resource Allocation Graph which person is working on what task at what
10416 @subsection Export of properties
10418 The exporter also takes TODO state information into consideration, i.e. if a
10419 task is marked as done it will have the corresponding attribute in
10420 TaskJuggler (@samp{complete 100}). Also it will export any property on a task
10421 resource or resource node which is known to TaskJuggler, such as
10422 @samp{limits}, @samp{vacation}, @samp{shift}, @samp{booking},
10423 @samp{efficiency}, @samp{journalentry}, @samp{rate} for resources or
10424 @samp{account}, @samp{start}, @samp{note}, @samp{duration}, @samp{end},
10425 @samp{journalentry}, @samp{milestone}, @samp{reference}, @samp{responsible},
10426 @samp{scheduling}, etc for tasks.
10428 @subsection Dependencies
10430 The exporter will handle dependencies that are defined in the tasks either
10431 with the @samp{ORDERED} attribute (@pxref{TODO dependencies}), with the
10432 @samp{BLOCKER} attribute (see @file{org-depend.el}) or alternatively with a
10433 @samp{depends} attribute. Both the @samp{BLOCKER} and the @samp{depends}
10434 attribute can be either @samp{previous-sibling} or a reference to an
10435 identifier (named @samp{task_id}) which is defined for another task in the
10436 project. @samp{BLOCKER} and the @samp{depends} attribute can define multiple
10437 dependencies separated by either space or comma. You can also specify
10438 optional attributes on the dependency by simply appending it. The following
10439 examples should illustrate this:
10444 :task_id: preparation
10447 * Training material
10449 :task_id: training_material
10452 ** Markup Guidelines
10456 ** Workflow Guidelines
10463 :BLOCKER: training_material @{ gapduration 1d @} preparation
10467 @subsection Reports
10469 @vindex org-export-taskjuggler-default-reports
10470 TaskJuggler can produce many kinds of reports (e.g. gantt chart, resource
10471 allocation, etc). The user defines what kind of reports should be generated
10472 for a project in the TaskJuggler file. The exporter will automatically insert
10473 some default reports in the file. These defaults are defined in
10474 @code{org-export-taskjuggler-default-reports}. They can be modified using
10475 customize along with a number of other options. For a more complete list, see
10476 @kbd{M-x customize-group @key{RET} org-export-taskjuggler @key{RET}}.
10478 For more information and examples see the Org-taskjuggler tutorial at
10479 @uref{http://orgmode.org/worg/org-tutorials/org-taskjuggler.php}.
10481 @node Freemind export, XOXO export, TaskJuggler export, Exporting
10482 @section Freemind export
10483 @cindex Freemind export
10486 The Freemind exporter was written by Lennart Borgman.
10489 @orgcmd{C-c C-e m,org-export-as-freemind}
10490 Export as Freemind mind map @file{myfile.mm}.
10493 @node XOXO export, iCalendar export, Freemind export, Exporting
10494 @section XOXO export
10495 @cindex XOXO export
10497 Org-mode contains an exporter that produces XOXO-style output.
10498 Currently, this exporter only handles the general outline structure and
10499 does not interpret any additional Org-mode features.
10502 @orgcmd{C-c C-e x,org-export-as-xoxo}
10503 Export as XOXO file @file{myfile.html}.
10504 @orgkey{C-c C-e v x}
10505 Export only the visible part of the document.
10508 @node iCalendar export, , XOXO export, Exporting
10509 @section iCalendar export
10510 @cindex iCalendar export
10512 @vindex org-icalendar-include-todo
10513 @vindex org-icalendar-use-deadline
10514 @vindex org-icalendar-use-scheduled
10515 @vindex org-icalendar-categories
10516 @vindex org-icalendar-alarm-time
10517 Some people use Org-mode for keeping track of projects, but still prefer a
10518 standard calendar application for anniversaries and appointments. In this
10519 case it can be useful to show deadlines and other time-stamped items in Org
10520 files in the calendar application. Org-mode can export calendar information
10521 in the standard iCalendar format. If you also want to have TODO entries
10522 included in the export, configure the variable
10523 @code{org-icalendar-include-todo}. Plain timestamps are exported as VEVENT,
10524 and TODO items as VTODO. It will also create events from deadlines that are
10525 in non-TODO items. Deadlines and scheduling dates in TODO items will be used
10526 to set the start and due dates for the TODO entry@footnote{See the variables
10527 @code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}.
10528 As categories, it will use the tags locally defined in the heading, and the
10529 file/tree category@footnote{To add inherited tags or the TODO state,
10530 configure the variable @code{org-icalendar-categories}.}. See the variable
10531 @code{org-icalendar-alarm-time} for a way to assign alarms to entries with a
10534 @vindex org-icalendar-store-UID
10535 @cindex property, ID
10536 The iCalendar standard requires each entry to have a globally unique
10537 identifier (UID). Org creates these identifiers during export. If you set
10538 the variable @code{org-icalendar-store-UID}, the UID will be stored in the
10539 @code{:ID:} property of the entry and re-used next time you report this
10540 entry. Since a single entry can give rise to multiple iCalendar entries (as
10541 a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
10542 prefixes to the UID, depending on what triggered the inclusion of the entry.
10543 In this way the UID remains unique, but a synchronization program can still
10544 figure out from which entry all the different instances originate.
10547 @orgcmd{C-c C-e i,org-export-icalendar-this-file}
10548 Create iCalendar entries for the current file and store them in the same
10549 directory, using a file extension @file{.ics}.
10550 @orgcmd{C-c C-e I, org-export-icalendar-all-agenda-files}
10551 @vindex org-agenda-files
10552 Like @kbd{C-c C-e i}, but do this for all files in
10553 @code{org-agenda-files}. For each of these files, a separate iCalendar
10554 file will be written.
10555 @orgcmd{C-c C-e c,org-export-icalendar-combine-agenda-files}
10556 @vindex org-combined-agenda-icalendar-file
10557 Create a single large iCalendar file from all files in
10558 @code{org-agenda-files} and write it to the file given by
10559 @code{org-combined-agenda-icalendar-file}.
10562 @vindex org-use-property-inheritance
10563 @vindex org-icalendar-include-body
10564 @cindex property, SUMMARY
10565 @cindex property, DESCRIPTION
10566 @cindex property, LOCATION
10567 The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION
10568 property can be inherited from higher in the hierarchy if you configure
10569 @code{org-use-property-inheritance} accordingly.} properties if the selected
10570 entries have them. If not, the summary will be derived from the headline,
10571 and the description from the body (limited to
10572 @code{org-icalendar-include-body} characters).
10574 How this calendar is best read and updated, depends on the application
10575 you are using. The FAQ covers this issue.
10577 @node Publishing, Working With Source Code, Exporting, Top
10578 @chapter Publishing
10581 Org includes a publishing management system that allows you to configure
10582 automatic HTML conversion of @emph{projects} composed of interlinked org
10583 files. You can also configure Org to automatically upload your exported HTML
10584 pages and related attachments, such as images and source code files, to a web
10587 You can also use Org to convert files into PDF, or even combine HTML and PDF
10588 conversion so that files are available in both formats on the server.
10590 Publishing has been contributed to Org by David O'Toole.
10593 * Configuration:: Defining projects
10594 * Uploading files:: How to get files up on the server
10595 * Sample configuration:: Example projects
10596 * Triggering publication:: Publication commands
10599 @node Configuration, Uploading files, Publishing, Publishing
10600 @section Configuration
10602 Publishing needs significant configuration to specify files, destination
10603 and many other properties of a project.
10606 * Project alist:: The central configuration variable
10607 * Sources and destinations:: From here to there
10608 * Selecting files:: What files are part of the project?
10609 * Publishing action:: Setting the function doing the publishing
10610 * Publishing options:: Tweaking HTML export
10611 * Publishing links:: Which links keep working after publishing?
10612 * Sitemap:: Generating a list of all pages
10613 * Generating an index:: An index that reaches across pages
10616 @node Project alist, Sources and destinations, Configuration, Configuration
10617 @subsection The variable @code{org-publish-project-alist}
10618 @cindex org-publish-project-alist
10619 @cindex projects, for publishing
10621 @vindex org-publish-project-alist
10622 Publishing is configured almost entirely through setting the value of one
10623 variable, called @code{org-publish-project-alist}. Each element of the list
10624 configures one project, and may be in one of the two following forms:
10627 ("project-name" :property value :property value ...)
10628 @r{i.e. a well-formed property list with alternating keys and values}
10630 ("project-name" :components ("project-name" "project-name" ...))
10634 In both cases, projects are configured by specifying property values. A
10635 project defines the set of files that will be published, as well as the
10636 publishing configuration to use when publishing those files. When a project
10637 takes the second form listed above, the individual members of the
10638 @code{:components} property are taken to be sub-projects, which group
10639 together files requiring different publishing options. When you publish such
10640 a ``meta-project'', all the components will also be published, in the
10643 @node Sources and destinations, Selecting files, Project alist, Configuration
10644 @subsection Sources and destinations for files
10645 @cindex directories, for publishing
10647 Most properties are optional, but some should always be set. In
10648 particular, Org needs to know where to look for source files,
10649 and where to put published files.
10651 @multitable @columnfractions 0.3 0.7
10652 @item @code{:base-directory}
10653 @tab Directory containing publishing source files
10654 @item @code{:publishing-directory}
10655 @tab Directory where output files will be published. You can directly
10656 publish to a webserver using a file name syntax appropriate for
10657 the Emacs @file{tramp} package. Or you can publish to a local directory and
10658 use external tools to upload your website (@pxref{Uploading files}).
10659 @item @code{:preparation-function}
10660 @tab Function or list of functions to be called before starting the
10661 publishing process, for example, to run @code{make} for updating files to be
10662 published. The project property list is scoped into this call as the
10663 variable @code{project-plist}.
10664 @item @code{:completion-function}
10665 @tab Function or list of functions called after finishing the publishing
10666 process, for example, to change permissions of the resulting files. The
10667 project property list is scoped into this call as the variable
10668 @code{project-plist}.
10672 @node Selecting files, Publishing action, Sources and destinations, Configuration
10673 @subsection Selecting files
10674 @cindex files, selecting for publishing
10676 By default, all files with extension @file{.org} in the base directory
10677 are considered part of the project. This can be modified by setting the
10679 @multitable @columnfractions 0.25 0.75
10680 @item @code{:base-extension}
10681 @tab Extension (without the dot!) of source files. This actually is a
10682 regular expression. Set this to the symbol @code{any} if you want to get all
10683 files in @code{:base-directory}, even without extension.
10685 @item @code{:exclude}
10686 @tab Regular expression to match file names that should not be
10687 published, even though they have been selected on the basis of their
10690 @item @code{:include}
10691 @tab List of files to be included regardless of @code{:base-extension}
10692 and @code{:exclude}.
10694 @item @code{:recursive}
10695 @tab Non-nil means, check base-directory recursively for files to publish.
10698 @node Publishing action, Publishing options, Selecting files, Configuration
10699 @subsection Publishing action
10700 @cindex action, for publishing
10702 Publishing means that a file is copied to the destination directory and
10703 possibly transformed in the process. The default transformation is to export
10704 Org files as HTML files, and this is done by the function
10705 @code{org-publish-org-to-html} which calls the HTML exporter (@pxref{HTML
10706 export}). But you also can publish your content as PDF files using
10707 @code{org-publish-org-to-pdf}, or as @code{ascii}, @code{latin1} or
10708 @code{utf8} encoded files using the corresponding functions. If you want to
10709 publish the Org file itself, but with @i{archived}, @i{commented}, and
10710 @i{tag-excluded} trees removed, use @code{org-publish-org-to-org} and set the
10711 parameters @code{:plain-source} and/or @code{:htmlized-source}. This will
10712 produce @file{file.org} and @file{file.org.html} in the publishing
10713 directory@footnote{@file{file-source.org} and @file{file-source.org.html} if
10714 source and publishing directories are equal. Note that with this kind of
10715 setup, you need to add @code{:exclude "-source\\.org"} to the project
10716 definition in @code{org-publish-project-alist} to prevent the published
10717 source files from being considered as new org files the next time the project
10718 is published.}. Other files like images only need to be copied to the
10719 publishing destination; for this you may use @code{org-publish-attachment}.
10720 For non-Org files, you always need to specify the publishing function:
10722 @multitable @columnfractions 0.3 0.7
10723 @item @code{:publishing-function}
10724 @tab Function executing the publication of a file. This may also be a
10725 list of functions, which will all be called in turn.
10726 @item @code{:plain-source}
10727 @tab Non-nil means, publish plain source.
10728 @item @code{:htmlized-source}
10729 @tab Non-nil means, publish htmlized source.
10732 The function must accept three arguments: a property list containing at least
10733 a @code{:publishing-directory} property, the name of the file to be
10734 published, and the path to the publishing directory of the output file. It
10735 should take the specified file, make the necessary transformation (if any)
10736 and place the result into the destination folder.
10738 @node Publishing options, Publishing links, Publishing action, Configuration
10739 @subsection Options for the HTML/@LaTeX{} exporters
10740 @cindex options, for publishing
10742 The property list can be used to set many export options for the HTML
10743 and @LaTeX{} exporters. In most cases, these properties correspond to user
10744 variables in Org. The table below lists these properties along
10745 with the variable they belong to. See the documentation string for the
10746 respective variable for details.
10748 @vindex org-export-html-link-up
10749 @vindex org-export-html-link-home
10750 @vindex org-export-default-language
10751 @vindex org-display-custom-times
10752 @vindex org-export-headline-levels
10753 @vindex org-export-with-section-numbers
10754 @vindex org-export-section-number-format
10755 @vindex org-export-with-toc
10756 @vindex org-export-preserve-breaks
10757 @vindex org-export-with-archived-trees
10758 @vindex org-export-with-emphasize
10759 @vindex org-export-with-sub-superscripts
10760 @vindex org-export-with-special-strings
10761 @vindex org-export-with-footnotes
10762 @vindex org-export-with-drawers
10763 @vindex org-export-with-tags
10764 @vindex org-export-with-todo-keywords
10765 @vindex org-export-with-priority
10766 @vindex org-export-with-TeX-macros
10767 @vindex org-export-with-LaTeX-fragments
10768 @vindex org-export-skip-text-before-1st-heading
10769 @vindex org-export-with-fixed-width
10770 @vindex org-export-with-timestamps
10771 @vindex org-export-author-info
10772 @vindex org-export-email
10773 @vindex org-export-creator-info
10774 @vindex org-export-with-tables
10775 @vindex org-export-highlight-first-table-line
10776 @vindex org-export-html-style-include-default
10777 @vindex org-export-html-style
10778 @vindex org-export-html-style-extra
10779 @vindex org-export-html-link-org-files-as-html
10780 @vindex org-export-html-inline-images
10781 @vindex org-export-html-extension
10782 @vindex org-export-html-table-tag
10783 @vindex org-export-html-expand
10784 @vindex org-export-html-with-timestamp
10785 @vindex org-export-publishing-directory
10786 @vindex org-export-html-preamble
10787 @vindex org-export-html-postamble
10788 @vindex org-export-html-auto-preamble
10789 @vindex org-export-html-auto-postamble
10790 @vindex user-full-name
10791 @vindex user-mail-address
10792 @vindex org-export-select-tags
10793 @vindex org-export-exclude-tags
10795 @multitable @columnfractions 0.32 0.68
10796 @item @code{:link-up} @tab @code{org-export-html-link-up}
10797 @item @code{:link-home} @tab @code{org-export-html-link-home}
10798 @item @code{:language} @tab @code{org-export-default-language}
10799 @item @code{:customtime} @tab @code{org-display-custom-times}
10800 @item @code{:headline-levels} @tab @code{org-export-headline-levels}
10801 @item @code{:section-numbers} @tab @code{org-export-with-section-numbers}
10802 @item @code{:section-number-format} @tab @code{org-export-section-number-format}
10803 @item @code{:table-of-contents} @tab @code{org-export-with-toc}
10804 @item @code{:preserve-breaks} @tab @code{org-export-preserve-breaks}
10805 @item @code{:archived-trees} @tab @code{org-export-with-archived-trees}
10806 @item @code{:emphasize} @tab @code{org-export-with-emphasize}
10807 @item @code{:sub-superscript} @tab @code{org-export-with-sub-superscripts}
10808 @item @code{:special-strings} @tab @code{org-export-with-special-strings}
10809 @item @code{:footnotes} @tab @code{org-export-with-footnotes}
10810 @item @code{:drawers} @tab @code{org-export-with-drawers}
10811 @item @code{:tags} @tab @code{org-export-with-tags}
10812 @item @code{:todo-keywords} @tab @code{org-export-with-todo-keywords}
10813 @item @code{:priority} @tab @code{org-export-with-priority}
10814 @item @code{:TeX-macros} @tab @code{org-export-with-TeX-macros}
10815 @item @code{:LaTeX-fragments} @tab @code{org-export-with-LaTeX-fragments}
10816 @item @code{:latex-listings} @tab @code{org-export-latex-listings}
10817 @item @code{:skip-before-1st-heading} @tab @code{org-export-skip-text-before-1st-heading}
10818 @item @code{:fixed-width} @tab @code{org-export-with-fixed-width}
10819 @item @code{:timestamps} @tab @code{org-export-with-timestamps}
10820 @item @code{:author-info} @tab @code{org-export-author-info}
10821 @item @code{:email-info} @tab @code{org-export-email-info}
10822 @item @code{:creator-info} @tab @code{org-export-creator-info}
10823 @item @code{:tables} @tab @code{org-export-with-tables}
10824 @item @code{:table-auto-headline} @tab @code{org-export-highlight-first-table-line}
10825 @item @code{:style-include-default} @tab @code{org-export-html-style-include-default}
10826 @item @code{:style} @tab @code{org-export-html-style}
10827 @item @code{:style-extra} @tab @code{org-export-html-style-extra}
10828 @item @code{:convert-org-links} @tab @code{org-export-html-link-org-files-as-html}
10829 @item @code{:inline-images} @tab @code{org-export-html-inline-images}
10830 @item @code{:html-extension} @tab @code{org-export-html-extension}
10831 @item @code{:xml-declaration} @tab @code{org-export-html-xml-declaration}
10832 @item @code{:html-table-tag} @tab @code{org-export-html-table-tag}
10833 @item @code{:expand-quoted-html} @tab @code{org-export-html-expand}
10834 @item @code{:timestamp} @tab @code{org-export-html-with-timestamp}
10835 @item @code{:publishing-directory} @tab @code{org-export-publishing-directory}
10836 @item @code{:preamble} @tab @code{org-export-html-preamble}
10837 @item @code{:postamble} @tab @code{org-export-html-postamble}
10838 @item @code{:auto-preamble} @tab @code{org-export-html-auto-preamble}
10839 @item @code{:auto-postamble} @tab @code{org-export-html-auto-postamble}
10840 @item @code{:author} @tab @code{user-full-name}
10841 @item @code{:email} @tab @code{user-mail-address} : @code{addr;addr;..}
10842 @item @code{:select-tags} @tab @code{org-export-select-tags}
10843 @item @code{:exclude-tags} @tab @code{org-export-exclude-tags}
10844 @item @code{:latex-image-options} @tab @code{org-export-latex-image-default-option}
10847 Most of the @code{org-export-with-*} variables have the same effect in
10848 both HTML and @LaTeX{} exporters, except for @code{:TeX-macros} and
10849 @code{:LaTeX-fragments}, respectively @code{nil} and @code{t} in the
10852 @vindex org-publish-project-alist
10853 When a property is given a value in @code{org-publish-project-alist},
10854 its setting overrides the value of the corresponding user variable (if
10855 any) during publishing. Options set within a file (@pxref{Export
10856 options}), however, override everything.
10858 @node Publishing links, Sitemap, Publishing options, Configuration
10859 @subsection Links between published files
10860 @cindex links, publishing
10862 To create a link from one Org file to another, you would use
10863 something like @samp{[[file:foo.org][The foo]]} or simply
10864 @samp{file:foo.org.} (@pxref{Hyperlinks}). When published, this link
10865 becomes a link to @file{foo.html}. In this way, you can interlink the
10866 pages of your "org web" project and the links will work as expected when
10867 you publish them to HTML. If you also publish the Org source file and want
10868 to link to that, use an @code{http:} link instead of a @code{file:} link,
10869 because @code{file:} links are converted to link to the corresponding
10872 You may also link to related files, such as images. Provided you are careful
10873 with relative file names, and provided you have also configured Org to upload
10874 the related files, these links will work too. See @ref{Complex example}, for
10875 an example of this usage.
10877 Sometimes an Org file to be published may contain links that are
10878 only valid in your production environment, but not in the publishing
10879 location. In this case, use the property
10881 @multitable @columnfractions 0.4 0.6
10882 @item @code{:link-validation-function}
10883 @tab Function to validate links
10887 to define a function for checking link validity. This function must
10888 accept two arguments, the file name and a directory relative to which
10889 the file name is interpreted in the production environment. If this
10890 function returns @code{nil}, then the HTML generator will only insert a
10891 description into the HTML file, but no link. One option for this
10892 function is @code{org-publish-validate-link} which checks if the given
10893 file is part of any project in @code{org-publish-project-alist}.
10895 @node Sitemap, Generating an index, Publishing links, Configuration
10896 @subsection Generating a sitemap
10897 @cindex sitemap, of published pages
10899 The following properties may be used to control publishing of
10900 a map of files for a given project.
10902 @multitable @columnfractions 0.35 0.65
10903 @item @code{:auto-sitemap}
10904 @tab When non-nil, publish a sitemap during @code{org-publish-current-project}
10905 or @code{org-publish-all}.
10907 @item @code{:sitemap-filename}
10908 @tab Filename for output of sitemap. Defaults to @file{sitemap.org} (which
10909 becomes @file{sitemap.html}).
10911 @item @code{:sitemap-title}
10912 @tab Title of sitemap page. Defaults to name of file.
10914 @item @code{:sitemap-function}
10915 @tab Plug-in function to use for generation of the sitemap.
10916 Defaults to @code{org-publish-org-sitemap}, which generates a plain list
10917 of links to all files in the project.
10919 @item @code{:sitemap-sort-folders}
10920 @tab Where folders should appear in the sitemap. Set this to @code{first}
10921 (default) or @code{last} to display folders first or last,
10922 respectively. Any other value will mix files and folders.
10924 @item @code{:sitemap-alphabetically}
10925 @tab The site map is normally sorted alphabetically. Set this explicitly to
10926 @code{nil} to turn off sorting.
10928 @item @code{:sitemap-ignore-case}
10929 @tab Should sorting be case-sensitive? Default @code{nil}.
10933 @node Generating an index, , Sitemap, Configuration
10934 @subsection Generating an index
10935 @cindex index, in a publishing project
10937 Org-mode can generate an index across the files of a publishing project.
10939 @multitable @columnfractions 0.25 0.75
10940 @item @code{:makeindex}
10941 @tab When non-nil, generate in index in the file @file{theindex.org} and
10942 publish it as @file{theindex.html}.
10945 The file will be create when first publishing a project with the
10946 @code{:makeindex} set. The file only contains a statement @code{#+include:
10947 "theindex.inc"}. You can then built around this include statement by adding
10948 a title, style information etc.
10950 @node Uploading files, Sample configuration, Configuration, Publishing
10951 @section Uploading files
10955 For those people already utilizing third party sync tools such as
10956 @command{rsync} or @command{unison}, it might be preferable not to use the built in
10957 @i{remote} publishing facilities of Org-mode which rely heavily on
10958 Tramp. Tramp, while very useful and powerful, tends not to be
10959 so efficient for multiple file transfer and has been known to cause problems
10962 Specialized synchronization utilities offer several advantages. In addition
10963 to timestamp comparison, they also do content and permissions/attribute
10964 checks. For this reason you might prefer to publish your web to a local
10965 directory (possibly even @i{in place} with your Org files) and then use
10966 @file{unison} or @file{rsync} to do the synchronization with the remote host.
10968 Since Unison (for example) can be configured as to which files to transfer to
10969 a certain remote destination, it can greatly simplify the project publishing
10970 definition. Simply keep all files in the correct location, process your Org
10971 files with @code{org-publish} and let the synchronization tool do the rest.
10972 You do not need, in this scenario, to include attachments such as @file{jpg},
10973 @file{css} or @file{gif} files in the project definition since the 3rd party
10976 Publishing to a local directory is also much faster than to a remote one, so
10977 that you can afford more easily to republish entire projects. If you set
10978 @code{org-publish-use-timestamps-flag} to @code{nil}, you gain the main
10979 benefit of re-including any changed external files such as source example
10980 files you might include with @code{#+INCLUDE}. The timestamp mechanism in
10981 Org is not smart enough to detect if included files have been modified.
10983 @node Sample configuration, Triggering publication, Uploading files, Publishing
10984 @section Sample configuration
10986 Below we provide two example configurations. The first one is a simple
10987 project publishing only a set of Org files. The second example is
10988 more complex, with a multi-component project.
10991 * Simple example:: One-component publishing
10992 * Complex example:: A multi-component publishing example
10995 @node Simple example, Complex example, Sample configuration, Sample configuration
10996 @subsection Example: simple publishing configuration
10998 This example publishes a set of Org files to the @file{public_html}
10999 directory on the local machine.
11002 (setq org-publish-project-alist
11004 :base-directory "~/org/"
11005 :publishing-directory "~/public_html"
11006 :section-numbers nil
11007 :table-of-contents nil
11008 :style "<link rel=\"stylesheet\"
11009 href=\"../other/mystyle.css\"
11010 type=\"text/css\"/>")))
11013 @node Complex example, , Simple example, Sample configuration
11014 @subsection Example: complex publishing configuration
11016 This more complicated example publishes an entire website, including
11017 Org files converted to HTML, image files, Emacs Lisp source code, and
11018 style sheets. The publishing directory is remote and private files are
11021 To ensure that links are preserved, care should be taken to replicate
11022 your directory structure on the web server, and to use relative file
11023 paths. For example, if your Org files are kept in @file{~/org} and your
11024 publishable images in @file{~/images}, you would link to an image with
11027 file:../images/myimage.png
11030 On the web server, the relative path to the image should be the
11031 same. You can accomplish this by setting up an "images" folder in the
11032 right place on the web server, and publishing images to it.
11035 (setq org-publish-project-alist
11037 :base-directory "~/org/"
11038 :base-extension "org"
11039 :publishing-directory "/ssh:user@@host:~/html/notebook/"
11040 :publishing-function org-publish-org-to-html
11041 :exclude "PrivatePage.org" ;; regexp
11043 :section-numbers nil
11044 :table-of-contents nil
11045 :style "<link rel=\"stylesheet\"
11046 href=\"../other/mystyle.css\" type=\"text/css\"/>"
11048 :auto-postamble nil)
11051 :base-directory "~/images/"
11052 :base-extension "jpg\\|gif\\|png"
11053 :publishing-directory "/ssh:user@@host:~/html/images/"
11054 :publishing-function org-publish-attachment)
11057 :base-directory "~/other/"
11058 :base-extension "css\\|el"
11059 :publishing-directory "/ssh:user@@host:~/html/other/"
11060 :publishing-function org-publish-attachment)
11061 ("website" :components ("orgfiles" "images" "other"))))
11064 @node Triggering publication, , Sample configuration, Publishing
11065 @section Triggering publication
11067 Once properly configured, Org can publish with the following commands:
11070 @orgcmd{C-c C-e X,org-publish}
11071 Prompt for a specific project and publish all files that belong to it.
11072 @orgcmd{C-c C-e P,org-publish-current-project}
11073 Publish the project containing the current file.
11074 @orgcmd{C-c C-e F,org-publish-current-file}
11075 Publish only the current file.
11076 @orgcmd{C-c C-e E,org-publish-all}
11077 Publish every project.
11080 @vindex org-publish-use-timestamps-flag
11081 Org uses timestamps to track when a file has changed. The above functions
11082 normally only publish changed files. You can override this and force
11083 publishing of all files by giving a prefix argument to any of the commands
11084 above, or by customizing the variable @code{org-publish-use-timestamps-flag}.
11085 This may be necessary in particular if files include other files via
11086 @code{#+SETUPFILE:} or @code{#+INCLUDE:}.
11088 @comment node-name, next, previous, up
11089 @comment Working With Source Code, Miscellaneous, Publishing, Top
11091 @node Working With Source Code, Miscellaneous, Publishing, Top
11092 @chapter Working with source code
11093 @cindex Schulte, Eric
11094 @cindex Davison, Dan
11095 @cindex source code, working with
11097 Source code can be included in Org-mode documents using a @samp{src} block,
11101 #+BEGIN_SRC emacs-lisp
11102 (defun org-xor (a b)
11108 Org-mode provides a number of features for working with live source code,
11109 including editing of code blocks in their native major-mode, evaluation of
11110 code blocks, tangling of code blocks, and exporting code blocks and their
11111 results in several formats. This functionality was contributed by Eric
11112 Schulte and Dan Davison, and was originally named Org-babel.
11114 The following sections describe Org-mode's code block handling facilities.
11117 * Structure of code blocks:: Code block syntax described
11118 * Editing source code:: Language major-mode editing
11119 * Exporting code blocks:: Export contents and/or results
11120 * Extracting source code:: Create pure source code files
11121 * Evaluating code blocks:: Place results of evaluation in the Org-mode buffer
11122 * Library of Babel:: Use and contribute to a library of useful code blocks
11123 * Languages:: List of supported code block languages
11124 * Header arguments:: Configure code block functionality
11125 * Results of evaluation:: How evaluation results are handled
11126 * Noweb reference syntax:: Literate programming in Org-mode
11127 * Key bindings and useful functions:: Work quickly with code blocks
11128 * Batch execution:: Call functions from the command line
11131 @comment node-name, next, previous, up
11132 @comment Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
11134 @node Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
11135 @section Structure of code blocks
11136 @cindex code block, structure
11137 @cindex source code, block structure
11139 The structure of code blocks is as follows:
11143 #+begin_src <language> <switches> <header arguments>
11148 code blocks can also be embedded in text as so called inline code blocks as
11151 src_<language>@{<body>@}
11157 src_<language>[<header arguments>]@{<body>@}
11162 This name is associated with the code block. This is similar to the
11163 @samp{#+tblname} lines that can be used to name tables in Org-mode files.
11164 Referencing the name of a code block makes it possible to evaluate the
11165 block from other places in the file, other files, or from Org-mode table
11166 formulas (see @ref{The spreadsheet}).
11168 The language of the code in the block.
11170 Switches controlling exportation of the code block (see switches discussion in
11171 @ref{Literal examples})
11172 @item <header arguments>
11173 Optional header arguments control many aspects of evaluation, export and
11174 tangling of code blocks. See the @ref{Header arguments}
11175 section. Header arguments can also be set on a per-buffer or per-subtree
11176 basis using properties.
11181 @comment node-name, next, previous, up
11182 @comment Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
11184 @node Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
11185 @section Editing source code
11186 @cindex code block, editing
11187 @cindex source code, editing
11190 Use @kbd{C-c '} to edit the current code block. This brings up
11191 a language major-mode edit buffer containing the body of the code
11192 block. Saving this buffer will write the new contents back to the Org
11193 buffer. Use @kbd{C-c '} again to exit.
11195 The @code{org-src-mode} minor mode will be active in the edit buffer. The
11196 following variables can be used to configure the behavior of the edit
11197 buffer. See also the customization group @code{org-edit-structure} for
11198 further configuration options.
11201 @item org-src-lang-modes
11202 If an Emacs major-mode named @code{<lang>-mode} exists, where
11203 @code{<lang>} is the language named in the header line of the code block,
11204 then the edit buffer will be placed in that major-mode. This variable
11205 can be used to map arbitrary language names to existing major modes.
11206 @item org-src-window-setup
11207 Controls the way Emacs windows are rearranged when the edit buffer is created.
11208 @item org-src-preserve-indentation
11209 This variable is especially useful for tangling languages such as
11210 Python, in which whitespace indentation in the output is critical.
11211 @item org-src-ask-before-returning-to-edit-buffer
11212 By default, Org will ask before returning to an open edit buffer. Set
11213 this variable to nil to switch without asking.
11216 @comment node-name, next, previous, up
11217 @comment Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
11219 @node Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
11220 @section Exporting code blocks
11221 @cindex code block, exporting
11222 @cindex source code, exporting
11224 It is possible to export the @emph{contents} of code blocks, the
11225 @emph{results} of code block evaluation, @emph{neither}, or @emph{both}. For
11226 most languages, the default exports the contents of code blocks. However, for
11227 some languages (e.g. @code{ditaa}) the default exports the results of code
11228 block evaluation. For information on exporting code block bodies, see
11229 @ref{Literal examples}.
11231 The @code{:exports} header argument can be used to specify export
11234 @subsubheading Header arguments:
11236 @item :exports code
11237 The default in most languages. The body of the code block is exported, as
11238 described in @ref{Literal examples}.
11239 @item :exports results
11240 The code block will be evaluated and the results will be placed in the
11241 Org-mode buffer for export, either updating previous results of the code
11242 block located anywhere in the buffer or, if no previous results exist,
11243 placing the results immediately after the code block. The body of the code
11244 block will not be exported.
11245 @item :exports both
11246 Both the code block and its results will be exported.
11247 @item :exports none
11248 Neither the code block nor its results will be exported.
11251 It is possible to inhibit the evaluation of code blocks during export.
11252 Setting the @code{org-export-babel-evaluate} variable to @code{nil} will
11253 ensure that no code blocks are evaluated as part of the export process. This
11254 can be useful in situations where potentially untrusted Org-mode files are
11255 exported in an automated fashion, for example when Org-mode is used as the
11256 markup language for a wiki.
11258 @comment node-name, next, previous, up
11259 @comment Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
11260 @node Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
11261 @section Extracting source code
11262 @cindex source code, extracting
11263 @cindex code block, extracting source code
11265 Creating pure source code files by extracting code from source blocks is
11266 referred to as ``tangling''---a term adopted from the literate programming
11267 community. During ``tangling'' of code blocks their bodies are expanded
11268 using @code{org-babel-expand-src-block} which can expand both variable and
11269 ``noweb'' style references (see @ref{Noweb reference syntax}).
11271 @subsubheading Header arguments
11274 The default. The code block is not included in the tangled output.
11276 Include the code block in the tangled output. The output file name is the
11277 name of the org file with the extension @samp{.org} replaced by the extension
11278 for the block language.
11279 @item :tangle filename
11280 Include the code block in the tangled output to file @samp{filename}.
11284 @subsubheading Functions
11286 @item org-babel-tangle
11287 Tangle the current file. Bound to @kbd{C-c C-v t}.
11288 @item org-babel-tangle-file
11289 Choose a file to tangle. Bound to @kbd{C-c C-v f}.
11292 @subsubheading Hooks
11294 @item org-babel-post-tangle-hook
11295 This hook is run from within code files tangled by @code{org-babel-tangle}.
11296 Example applications could include post-processing, compilation or evaluation
11297 of tangled code files.
11300 @node Evaluating code blocks, Library of Babel, Extracting source code, Working With Source Code
11301 @section Evaluating code blocks
11302 @cindex code block, evaluating
11303 @cindex source code, evaluating
11305 Code blocks can be evaluated@footnote{Whenever code is evaluated there is a
11306 potential for that code to do harm. Org-mode provides a number of safeguards
11307 to ensure that it only evaluates code with explicit confirmation from the
11308 user. For information on these safeguards (and on how to disable them) see
11309 @ref{Code evaluation security}.} and the results placed in the Org-mode
11310 buffer. By default, evaluation is only turned on for @code{emacs-lisp} code
11311 blocks, however support exists for evaluating blocks in many languages. See
11312 @ref{Languages} for a list of supported languages. See @ref{Structure of
11313 code blocks} for information on the syntax used to define a code block.
11316 There are a number of ways to evaluate code blocks. The simplest is to press
11317 @kbd{C-c C-c} or @kbd{C-c C-v e} with the point on a code block@footnote{The
11318 @code{org-babel-no-eval-on-ctrl-c-ctrl-c} variable can be used to remove code
11319 evaluation from the @kbd{C-c C-c} key binding.}. This will call the
11320 @code{org-babel-execute-src-block} function to evaluate the block and insert
11321 its results into the Org-mode buffer.
11323 It is also possible to evaluate named code blocks from anywhere in an
11324 Org-mode buffer or an Org-mode table. @code{#+call} (or synonymously
11325 @code{#+function} or @code{#+lob}) lines can be used to remotely execute code
11326 blocks located in the current Org-mode buffer or in the ``Library of Babel''
11327 (see @ref{Library of Babel}). These lines use the following syntax.
11330 #+call: <name>(<arguments>) <header arguments>
11331 #+function: <name>(<arguments>) <header arguments>
11332 #+lob: <name>(<arguments>) <header arguments>
11337 The name of the code block to be evaluated.
11339 Arguments specified in this section will be passed to the code block.
11340 @item <header arguments>
11341 Header arguments can be placed after the function invocation. See
11342 @ref{Header arguments} for more information on header arguments.
11346 @node Library of Babel, Languages, Evaluating code blocks, Working With Source Code
11347 @section Library of Babel
11348 @cindex babel, library of
11349 @cindex source code, library
11350 @cindex code block, library
11352 The ``Library of Babel'' is a library of code blocks
11353 that can be called from any Org-mode file. The library is housed in an
11354 Org-mode file located in the @samp{contrib} directory of Org-mode.
11355 Org-mode users can deposit functions they believe to be generally
11356 useful in the library.
11358 Code blocks defined in the ``Library of Babel'' can be called remotely as if
11359 they were in the current Org-mode buffer (see @ref{Evaluating code blocks}
11360 for information on the syntax of remote code block evaluation).
11363 Code blocks located in any Org-mode file can be loaded into the ``Library of
11364 Babel'' with the @code{org-babel-lob-ingest} function, bound to @kbd{C-c C-v
11367 @node Languages, Header arguments, Library of Babel, Working With Source Code
11369 @cindex babel, languages
11370 @cindex source code, languages
11371 @cindex code block, languages
11373 Code blocks in the following languages are supported.
11375 @multitable @columnfractions 0.28 0.3 0.22 0.2
11376 @item @b{Language} @tab @b{Identifier} @tab @b{Language} @tab @b{Identifier}
11377 @item Asymptote @tab asymptote @tab C @tab C
11378 @item C++ @tab C++ @tab Clojure @tab clojure
11379 @item CSS @tab css @tab ditaa @tab ditaa
11380 @item Graphviz @tab dot @tab Emacs Lisp @tab emacs-lisp
11381 @item gnuplot @tab gnuplot @tab Haskell @tab haskell
11382 @item LaTeX @tab latex @tab MATLAB @tab matlab
11383 @item Mscgen @tab mscgen @tab Objective Caml @tab ocaml
11384 @item Octave @tab octave @tab Oz @tab oz
11385 @item Perl @tab perl @tab Python @tab python
11386 @item R @tab R @tab Ruby @tab ruby
11387 @item Sass @tab sass @tab GNU Screen @tab screen
11388 @item shell @tab sh @tab SQL @tab sql
11389 @item SQLite @tab sqlite
11392 Language-specific documentation is available for some languages. If
11393 available, it can be found at
11394 @uref{http://orgmode.org/worg/org-contrib/babel/languages}.
11396 The @code{org-babel-load-languages} controls which languages are enabled for
11397 evaluation (by default only @code{emacs-lisp} is enabled). This variable can
11398 be set using the customization interface or by adding code like the following
11399 to your emacs configuration.
11402 The following disables @code{emacs-lisp} evaluation and enables evaluation of
11403 @code{R} code blocks.
11407 (org-babel-do-load-languages
11408 'org-babel-load-languages
11409 '((emacs-lisp . nil)
11413 It is also possible to enable support for a language by loading the related
11414 elisp file with @code{require}.
11417 The following adds support for evaluating @code{clojure} code blocks.
11421 (require 'ob-clojure)
11424 @node Header arguments, Results of evaluation, Languages, Working With Source Code
11425 @section Header arguments
11426 @cindex code block, header arguments
11427 @cindex source code, block header arguments
11429 Code block functionality can be configured with header arguments. This
11430 section provides an overview of the use of header arguments, and then
11431 describes each header argument in detail.
11434 * Using header arguments:: Different ways to set header arguments
11435 * Specific header arguments:: List of header arguments
11438 @node Using header arguments, Specific header arguments, Header arguments, Header arguments
11439 @subsection Using header arguments
11441 The values of header arguments can be set in six different ways, each more
11442 specific (and having higher priority) than the last.
11444 * System-wide header arguments:: Set global default values
11445 * Language-specific header arguments:: Set default values by language
11446 * Buffer-wide header arguments:: Set default values for a specific buffer
11447 * Header arguments in Org-mode properties:: Set default values for a buffer or heading
11448 * Code block specific header arguments:: The most common way to set values
11449 * Header arguments in function calls:: The most specific level
11453 @node System-wide header arguments, Language-specific header arguments, Using header arguments, Using header arguments
11454 @subsubheading System-wide header arguments
11455 @vindex org-babel-default-header-args
11456 System-wide values of header arguments can be specified by customizing the
11457 @code{org-babel-default-header-args} variable:
11461 :results => "replace"
11468 @c org-babel-default-header-args is a variable defined in `org-babel.el'.
11470 @c ((:session . "none")
11471 @c (:results . "replace")
11472 @c (:exports . "code")
11474 @c (:noweb . "no"))
11478 @c Default arguments to use when evaluating a code block.
11481 For example, the following example could be used to set the default value of
11482 @code{:noweb} header arguments to @code{yes}. This would have the effect of
11483 expanding @code{:noweb} references by default when evaluating source code
11487 (setq org-babel-default-header-args
11488 (cons '(:noweb . "yes")
11489 (assq-delete-all :noweb org-babel-default-header-args)))
11492 @node Language-specific header arguments, Buffer-wide header arguments, System-wide header arguments, Using header arguments
11493 @subsubheading Language-specific header arguments
11494 Each language can define its own set of default header arguments. See the
11495 language-specific documentation available online at
11496 @uref{http://orgmode.org/worg/org-contrib/babel}.
11498 @node Buffer-wide header arguments, Header arguments in Org-mode properties, Language-specific header arguments, Using header arguments
11499 @subsubheading Buffer-wide header arguments
11500 Buffer-wide header arguments may be specified through the use of a special
11501 line placed anywhere in an Org-mode file. The line consists of the
11502 @code{#+BABEL:} keyword followed by a series of header arguments which may be
11503 specified using the standard header argument syntax.
11505 For example the following would set @code{session} to @code{*R*}, and
11506 @code{results} to @code{silent} for every code block in the buffer, ensuring
11507 that all execution took place in the same session, and no results would be
11508 inserted into the buffer.
11511 #+BABEL: :session *R* :results silent
11514 @node Header arguments in Org-mode properties, Code block specific header arguments, Buffer-wide header arguments, Using header arguments
11515 @subsubheading Header arguments in Org-mode properties
11517 Header arguments are also read from Org-mode properties (see @ref{Property
11518 syntax}), which can be set on a buffer-wide or per-heading basis. An example
11519 of setting a header argument for all code blocks in a buffer is
11522 #+property: tangle yes
11525 When properties are used to set default header arguments, they are looked up
11526 with inheritance, so the value of the @code{:cache} header argument will default
11527 to @code{yes} in all code blocks in the subtree rooted at the following
11538 @vindex org-babel-default-header-args
11539 Properties defined in this way override the properties set in
11540 @code{org-babel-default-header-args}. It is convenient to use the
11541 @code{org-set-property} function bound to @kbd{C-c C-x p} to set properties
11542 in Org-mode documents.
11544 @node Code block specific header arguments, Header arguments in function calls, Header arguments in Org-mode properties, Using header arguments
11545 @subsubheading Code block specific header arguments
11547 The most common way to assign values to header arguments is at the
11548 code block level. This can be done by listing a sequence of header
11549 arguments and their values as part of the @code{#+begin_src} line.
11550 Properties set in this way override both the values of
11551 @code{org-babel-default-header-args} and header arguments specified as
11552 properties. In the following example, the @code{:results} header argument
11553 is set to @code{silent}, meaning the results of execution will not be
11554 inserted in the buffer, and the @code{:exports} header argument is set to
11555 @code{code}, meaning only the body of the code block will be
11556 preserved on export to HTML or LaTeX.
11559 #+source: factorial
11560 #+begin_src haskell :results silent :exports code :var n=0
11562 fac n = n * fac (n-1)
11565 Similarly, it is possible to set header arguments for inline code blocks:
11568 src_haskell[:exports both]@{fac 5@}
11571 @node Header arguments in function calls, , Code block specific header arguments, Using header arguments
11572 @comment node-name, next, previous, up
11573 @subsubheading Header arguments in function calls
11575 At the most specific level, header arguments for ``Library of Babel'' or
11576 function call lines can be set as shown below:
11579 #+call: factorial(n=5) :exports results
11582 @node Specific header arguments, , Using header arguments, Header arguments
11583 @subsection Specific header arguments
11584 The following header arguments are defined:
11587 * var:: Pass arguments to code blocks
11588 * results:: Specify the type of results and how they will
11589 be collected and handled
11590 * file:: Specify a path for file output
11591 * dir:: Specify the default (possibly remote)
11592 directory for code block execution
11593 * exports:: Export code and/or results
11594 * tangle:: Toggle tangling and specify file name
11595 * comments:: Toggle insertion of comments in tangled
11597 * no-expand:: Turn off variable assignment and noweb
11598 expansion during tangling
11599 * session:: Preserve the state of code evaluation
11600 * noweb:: Toggle expansion of noweb references
11601 * cache:: Avoid re-evaluating unchanged code blocks
11602 * hlines:: Handle horizontal lines in tables
11603 * colnames:: Handle column names in tables
11604 * rownames:: Handle row names in tables
11605 * shebang:: Make tangled files executable
11606 * eval:: Limit evaluation of specific code blocks
11609 @node var, results, Specific header arguments, Specific header arguments
11610 @subsubsection @code{:var}
11611 The @code{:var} header argument is used to pass arguments to code blocks.
11612 The specifics of how arguments are included in a code block vary by language;
11613 these are addressed in the language-specific documentation. However, the
11614 syntax used to specify arguments is the same across all languages. The
11615 values passed to arguments can be literal values, values from org-mode tables
11616 and literal example blocks, or the results of other code blocks.
11618 These values can be indexed in a manner similar to arrays---see the
11619 ``indexable variable values'' heading below.
11621 The following syntax is used to pass arguments to code blocks using the
11622 @code{:var} header argument.
11628 where @code{assign} can take one of the following forms
11631 @item literal value
11632 either a string @code{"string"} or a number @code{9}.
11637 #+tblname: example-table
11643 #+source: table-length
11644 #+begin_src emacs-lisp :var table=example-table
11648 #+results: table-length
11652 a code block name, as assigned by @code{#+srcname:}, followed by
11656 #+begin_src emacs-lisp :var length=table-length()
11664 In addition, an argument can be passed to the code block referenced
11665 by @code{:var}. The argument is passed within the parentheses following the
11670 #+begin_src emacs-lisp :var input=8
11678 #+begin_src emacs-lisp :var input=double(input=1)
11687 @subsubheading Alternate argument syntax
11688 It is also possible to specify arguments in a potentially more natural way
11689 using the @code{#+source:} line of a code block. As in the following
11690 example arguments can be packed inside of parenthesis, separated by commas,
11691 following the source name.
11694 #+source: double(input=0, x=2)
11695 #+begin_src emacs-lisp
11700 @subsubheading Indexable variable values
11701 It is possible to reference portions of variable values by ``indexing'' into
11702 the variables. Indexes are 0 based with negative values counting back from
11703 the end. If an index is separated by @code{,}s then each subsequent section
11704 will index into the next deepest nesting or dimension of the value. The
11705 following example assigns the last cell of the first row the table
11706 @code{example-table} to the variable @code{data}:
11709 #+results: example-table
11715 #+begin_src emacs-lisp :var data=example-table[0,-1]
11723 Ranges of variable values can be referenced using two integers separated by a
11724 @code{:}, in which case the entire inclusive range is referenced. For
11725 example the following assigns the middle three rows of @code{example-table}
11729 #+results: example-table
11736 #+begin_src emacs-lisp :var data=example-table[1:3]
11746 Additionally, an empty index, or the single character @code{*}, are both
11747 interpreted to mean the entire range and as such are equivalent to
11748 @code{0:-1}, as shown in the following example in which the entire first
11749 column is referenced.
11752 #+results: example-table
11758 #+begin_src emacs-lisp :var data=example-table[,0]
11766 It is possible to index into the results of code blocks as well as tables.
11767 Any number of dimensions can be indexed. Dimensions are separated from one
11768 another by commas, as shown in the following example.
11772 #+begin_src emacs-lisp
11773 '(((1 2 3) (4 5 6) (7 8 9))
11774 ((10 11 12) (13 14 15) (16 17 18))
11775 ((19 20 21) (22 23 24) (25 26 27)))
11778 #+begin_src emacs-lisp :var data=3D[1,,1]
11786 @node results, file, var, Specific header arguments
11787 @subsubsection @code{:results}
11789 There are three classes of @code{:results} header argument. Only one option
11790 per class may be supplied per code block.
11794 @b{collection} header arguments specify how the results should be collected
11795 from the code block
11797 @b{type} header arguments specify what type of result the code block will
11798 return---which has implications for how they will be inserted into the
11801 @b{handling} header arguments specify how the results of evaluating the code
11802 block should be handled.
11805 @subsubheading Collection
11806 The following options are mutually exclusive, and specify how the results
11807 should be collected from the code block.
11811 This is the default. The result is the value of the last statement in the
11812 code block. This header argument places the evaluation in functional
11813 mode. Note that in some languages, e.g., Python, use of this result type
11814 requires that a @code{return} statement be included in the body of the source
11815 code block. E.g., @code{:results value}.
11816 @item @code{output}
11817 The result is the collection of everything printed to STDOUT during the
11818 execution of the code block. This header argument places the
11819 evaluation in scripting mode. E.g., @code{:results output}.
11822 @subsubheading Type
11824 The following options are mutually exclusive and specify what type of results
11825 the code block will return. By default, results are inserted as either a
11826 table or scalar depending on their value.
11829 @item @code{table}, @code{vector}
11830 The results should be interpreted as an Org-mode table. If a single value is
11831 returned, it will be converted into a table with one row and one column.
11832 E.g., @code{:results value table}.
11834 The results should be interpreted as an Org-mode list. If a single scalar
11835 value is returned it will be converted into a list with only one element.
11836 @item @code{scalar}, @code{verbatim}
11837 The results should be interpreted literally---they will not be
11838 converted into a table. The results will be inserted into the Org-mode
11839 buffer as quoted text. E.g., @code{:results value verbatim}.
11841 The results will be interpreted as the path to a file, and will be inserted
11842 into the Org-mode buffer as a file link. E.g., @code{:results value file}.
11843 @item @code{raw}, @code{org}
11844 The results are interpreted as raw Org-mode code and are inserted directly
11845 into the buffer. If the results look like a table they will be aligned as
11846 such by Org-mode. E.g., @code{:results value raw}.
11848 Results are assumed to be HTML and will be enclosed in a @code{begin_html}
11849 block. E.g., @code{:results value html}.
11851 Results assumed to be LaTeX and are enclosed in a @code{begin_latex} block.
11852 E.g., @code{:results value latex}.
11854 Result are assumed to be parseable code and are enclosed in a code block.
11855 E.g., @code{:results value code}.
11857 The result is converted to pretty-printed code and is enclosed in a code
11858 block. This option currently supports Emacs Lisp, Python, and Ruby. E.g.,
11859 @code{:results value pp}.
11862 @subsubheading Handling
11863 The following results options indicate what happens with the
11864 results once they are collected.
11867 @item @code{silent}
11868 The results will be echoed in the minibuffer but will not be inserted into
11869 the Org-mode buffer. E.g., @code{:results output silent}.
11870 @item @code{replace}
11871 The default value. Any existing results will be removed, and the new results
11872 will be inserted into the Org-mode buffer in their place. E.g.,
11873 @code{:results output replace}.
11874 @item @code{append}
11875 If there are pre-existing results of the code block then the new results will
11876 be appended to the existing results. Otherwise the new results will be
11877 inserted as with @code{replace}.
11878 @item @code{prepend}
11879 If there are pre-existing results of the code block then the new results will
11880 be prepended to the existing results. Otherwise the new results will be
11881 inserted as with @code{replace}.
11884 @node file, dir, results, Specific header arguments
11885 @subsubsection @code{:file}
11887 The header argument @code{:file} is used to specify a path for file output.
11888 An Org-mode style @code{file:} link is inserted into the buffer as the result
11889 (see @ref{Link format}). Common examples are graphical output from R,
11890 gnuplot, ditaa and LaTeX code blocks.
11892 Note that for some languages, including R, gnuplot, LaTeX and ditaa,
11893 graphical output is sent to the specified file without the file being
11894 referenced explicitly in the code block. See the documentation for the
11895 individual languages for details. In contrast, general purpose languages such
11896 as Python and Ruby require that the code explicitly create output
11897 corresponding to the path indicated by @code{:file}.
11900 @node dir, exports, file, Specific header arguments
11901 @subsubsection @code{:dir} and remote execution
11903 While the @code{:file} header argument can be used to specify the path to the
11904 output file, @code{:dir} specifies the default directory during code block
11905 execution. If it is absent, then the directory associated with the current
11906 buffer is used. In other words, supplying @code{:dir path} temporarily has
11907 the same effect as changing the current directory with @kbd{M-x cd path}, and
11908 then not supplying @code{:dir}. Under the surface, @code{:dir} simply sets
11909 the value of the Emacs variable @code{default-directory}.
11911 When using @code{:dir}, you should supply a relative path for file output
11912 (e.g. @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which
11913 case that path will be interpreted relative to the default directory.
11915 In other words, if you want your plot to go into a folder called @file{Work}
11916 in your home directory, you could use
11919 #+begin_src R :file myplot.png :dir ~/Work
11920 matplot(matrix(rnorm(100), 10), type="l")
11924 @subsubheading Remote execution
11925 A directory on a remote machine can be specified using tramp file syntax, in
11926 which case the code will be evaluated on the remote machine. An example is
11929 #+begin_src R :file plot.png :dir /dand@@yakuba.princeton.edu:
11930 plot(1:10, main=system("hostname", intern=TRUE))
11934 Text results will be returned to the local Org-mode buffer as usual, and file
11935 output will be created on the remote machine with relative paths interpreted
11936 relative to the remote directory. An Org-mode link to the remote file will be
11939 So, in the above example a plot will be created on the remote machine,
11940 and a link of the following form will be inserted in the org buffer:
11943 [[file:/scp:dand@@yakuba.princeton.edu:/home/dand/plot.png][plot.png]]
11946 Most of this functionality follows immediately from the fact that @code{:dir}
11947 sets the value of the Emacs variable @code{default-directory}, thanks to
11948 tramp. Those using XEmacs, or GNU Emacs prior to version 23 may need to
11949 install tramp separately in order for these features to work correctly.
11951 @subsubheading Further points
11955 If @code{:dir} is used in conjunction with @code{:session}, although it will
11956 determine the starting directory for a new session as expected, no attempt is
11957 currently made to alter the directory associated with an existing session.
11959 @code{:dir} should typically not be used to create files during export with
11960 @code{:exports results} or @code{:exports both}. The reason is that, in order
11961 to retain portability of exported material between machines, during export
11962 links inserted into the buffer will *not* be expanded against @code{default
11963 directory}. Therefore, if @code{default-directory} is altered using
11964 @code{:dir}, it is probable that the file will be created in a location to
11965 which the link does not point.
11968 @node exports, tangle, dir, Specific header arguments
11969 @subsubsection @code{:exports}
11971 The @code{:exports} header argument specifies what should be included in HTML
11972 or LaTeX exports of the Org-mode file.
11976 The default. The body of code is included into the exported file. E.g.,
11977 @code{:exports code}.
11978 @item @code{results}
11979 The result of evaluating the code is included in the exported file. E.g.,
11980 @code{:exports results}.
11982 Both the code and results are included in the exported file. E.g.,
11983 @code{:exports both}.
11985 Nothing is included in the exported file. E.g., @code{:exports none}.
11988 @node tangle, comments, exports, Specific header arguments
11989 @subsubsection @code{:tangle}
11991 The @code{:tangle} header argument specifies whether or not the code
11992 block should be included in tangled extraction of source code files.
11995 @item @code{tangle}
11996 The code block is exported to a source code file named after the
11997 basename (name w/o extension) of the Org-mode file. E.g., @code{:tangle
12000 The default. The code block is not exported to a source code file.
12001 E.g., @code{:tangle no}.
12003 Any other string passed to the @code{:tangle} header argument is interpreted
12004 as a file basename to which the block will be exported. E.g., @code{:tangle
12008 @node comments, no-expand, tangle, Specific header arguments
12009 @subsubsection @code{:comments}
12010 By default code blocks are tangled to source-code files without any insertion
12011 of comments beyond those which may already exist in the body of the code
12012 block. The @code{:comments} header argument can be set as follows to control
12013 the insertion of extra comments into the tangled code file.
12017 The default. No extra comments are inserted during tangling.
12019 The code block is wrapped in comments which contain pointers back to the
12020 original Org file from which the code was tangled.
12022 A synonym for ``link'' to maintain backwards compatibility.
12024 Include text from the org-mode file as a comment.
12026 The text is picked from the leading context of the tangled code and is
12027 limited by the nearest headline or source block as the case may be.
12029 Turns on both the ``link'' and ``org'' comment options.
12032 @node no-expand, session, comments, Specific header arguments
12033 @subsubsection @code{:no-expand}
12035 By default, code blocks are expanded with @code{org-babel-expand-src-block}
12036 during tangling. This has the effect of assigning values to variables
12037 specified with @code{:var} (see @ref{var}), and of replacing ``noweb''
12038 references (see @ref{Noweb reference syntax}) with their targets. The
12039 @code{:no-expand} header argument can be used to turn off this behavior.
12041 @node session, noweb, no-expand, Specific header arguments
12042 @subsubsection @code{:session}
12044 The @code{:session} header argument starts a session for an interpreted
12045 language where state is preserved.
12047 By default, a session is not started.
12049 A string passed to the @code{:session} header argument will give the session
12050 a name. This makes it possible to run concurrent sessions for each
12051 interpreted language.
12053 @node noweb, cache, session, Specific header arguments
12054 @subsubsection @code{:noweb}
12056 The @code{:noweb} header argument controls expansion of ``noweb'' style (see
12057 @ref{Noweb reference syntax}) references in a code block. This header
12058 argument can have one of three values: @code{yes} @code{no} or @code{tangle}.
12062 All ``noweb'' syntax references in the body of the code block will be
12063 expanded before the block is evaluated, tangled or exported.
12065 The default. No ``noweb'' syntax specific action is taken on evaluating
12066 code blocks, However, noweb references will still be expanded during
12068 @item @code{tangle}
12069 All ``noweb'' syntax references in the body of the code block will be
12070 expanded before the block is tangled, however ``noweb'' references will not
12071 be expanded when the block is evaluated or exported.
12074 @subsubheading Noweb prefix lines
12075 Noweb insertions are now placed behind the line prefix of the
12076 @code{<<reference>>}.
12077 This behavior is illustrated in the following example. Because the
12078 @code{<<example>>} noweb reference appears behind the SQL comment syntax,
12079 each line of the expanded noweb reference will be commented.
12092 -- multi-line body of example
12095 Note that noweb replacement text that does not contain any newlines will not
12096 be affected by this change, so it is still possible to use inline noweb
12099 @node cache, hlines, noweb, Specific header arguments
12100 @subsubsection @code{:cache}
12102 The @code{:cache} header argument controls the use of in-buffer caching of
12103 the results of evaluating code blocks. It can be used to avoid re-evaluating
12104 unchanged code blocks. This header argument can have one of two
12105 values: @code{yes} or @code{no}.
12109 The default. No caching takes place, and the code block will be evaluated
12110 every time it is called.
12112 Every time the code block is run a SHA1 hash of the code and arguments
12113 passed to the block will be generated. This hash is packed into the
12114 @code{#+results:} line and will be checked on subsequent
12115 executions of the code block. If the code block has not
12116 changed since the last time it was evaluated, it will not be re-evaluated.
12119 @node hlines, colnames, cache, Specific header arguments
12120 @subsubsection @code{:hlines}
12122 Tables are frequently represented with one or more horizontal lines, or
12123 hlines. The @code{:hlines} argument to a code block accepts the
12124 values @code{yes} or @code{no}, with a default value of @code{no}.
12128 Strips horizontal lines from the input table. In most languages this is the
12129 desired effect because an @code{hline} symbol is interpreted as an unbound
12130 variable and raises an error. Setting @code{:hlines no} or relying on the
12131 default value yields the following results.
12134 #+tblname: many-cols
12141 #+source: echo-table
12142 #+begin_src python :var tab=many-cols
12146 #+results: echo-table
12153 Leaves hlines in the table. Setting @code{:hlines yes} has this effect.
12156 #+tblname: many-cols
12163 #+source: echo-table
12164 #+begin_src python :var tab=many-cols :hlines yes
12168 #+results: echo-table
12177 @node colnames, rownames, hlines, Specific header arguments
12178 @subsubsection @code{:colnames}
12180 The @code{:colnames} header argument accepts the values @code{yes},
12181 @code{no}, or @code{nil} for unassigned. The default value is @code{nil}.
12185 If an input table looks like it has column names
12186 (because its second row is an hline), then the column
12187 names will be removed from the table before
12188 processing, then reapplied to the results.
12191 #+tblname: less-cols
12197 #+srcname: echo-table-again
12198 #+begin_src python :var tab=less-cols
12199 return [[val + '*' for val in row] for row in tab]
12202 #+results: echo-table-again
12210 No column name pre-processing takes place
12213 Column names are removed and reapplied as with @code{nil} even if the table
12214 does not ``look like'' it has column names (i.e. the second row is not an
12218 @node rownames, shebang, colnames, Specific header arguments
12219 @subsubsection @code{:rownames}
12221 The @code{:rownames} header argument can take on the values @code{yes}
12222 or @code{no}, with a default value of @code{no}.
12226 No row name pre-processing will take place.
12229 The first column of the table is removed from the table before processing,
12230 and is then reapplied to the results.
12233 #+tblname: with-rownames
12234 | one | 1 | 2 | 3 | 4 | 5 |
12235 | two | 6 | 7 | 8 | 9 | 10 |
12237 #+srcname: echo-table-once-again
12238 #+begin_src python :var tab=with-rownames :rownames yes
12239 return [[val + 10 for val in row] for row in tab]
12242 #+results: echo-table-once-again
12243 | one | 11 | 12 | 13 | 14 | 15 |
12244 | two | 16 | 17 | 18 | 19 | 20 |
12248 @node shebang, eval, rownames, Specific header arguments
12249 @subsubsection @code{:shebang}
12251 Setting the @code{:shebang} header argument to a string value
12252 (e.g. @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the
12253 first line of any tangled file holding the code block, and the file
12254 permissions of the tangled file are set to make it executable.
12256 @node eval, , shebang, Specific header arguments
12257 @subsubsection @code{:eval}
12258 The @code{:eval} header argument can be used to limit the evaluation of
12259 specific code blocks. @code{:eval} accepts two arguments ``never'' and
12260 ``query''. @code{:eval never} will ensure that a code block is never
12261 evaluated, this can be useful for protecting against the evaluation of
12262 dangerous code blocks. @code{:eval query} will require a query for every
12263 execution of a code block regardless of the value of the
12264 @code{org-confirm-babel-evaluate} variable.
12266 @node Results of evaluation, Noweb reference syntax, Header arguments, Working With Source Code
12267 @section Results of evaluation
12268 @cindex code block, results of evaluation
12269 @cindex source code, results of evaluation
12271 The way in which results are handled depends on whether a session is invoked,
12272 as well as on whether @code{:results value} or @code{:results output} is
12273 used. The following table shows the possibilities:
12275 @multitable @columnfractions 0.26 0.33 0.41
12276 @item @tab @b{Non-session} @tab @b{Session}
12277 @item @code{:results value} @tab value of last expression @tab value of last expression
12278 @item @code{:results output} @tab contents of STDOUT @tab concatenation of interpreter output
12281 Note: With @code{:results value}, the result in both @code{:session} and
12282 non-session is returned to Org-mode as a table (a one- or two-dimensional
12283 vector of strings or numbers) when appropriate.
12285 @subsection Non-session
12286 @subsubsection @code{:results value}
12287 This is the default. Internally, the value is obtained by wrapping the code
12288 in a function definition in the external language, and evaluating that
12289 function. Therefore, code should be written as if it were the body of such a
12290 function. In particular, note that Python does not automatically return a
12291 value from a function unless a @code{return} statement is present, and so a
12292 @samp{return} statement will usually be required in Python.
12294 This is the only one of the four evaluation contexts in which the code is
12295 automatically wrapped in a function definition.
12297 @subsubsection @code{:results output}
12298 The code is passed to the interpreter as an external process, and the
12299 contents of the standard output stream are returned as text. (In certain
12300 languages this also contains the error output stream; this is an area for
12303 @subsection Session
12304 @subsubsection @code{:results value}
12305 The code is passed to the interpreter running as an interactive Emacs
12306 inferior process. The result returned is the result of the last evaluation
12307 performed by the interpreter. (This is obtained in a language-specific
12308 manner: the value of the variable @code{_} in Python and Ruby, and the value
12309 of @code{.Last.value} in R).
12311 @subsubsection @code{:results output}
12312 The code is passed to the interpreter running as an interactive Emacs
12313 inferior process. The result returned is the concatenation of the sequence of
12314 (text) output from the interactive interpreter. Notice that this is not
12315 necessarily the same as what would be sent to @code{STDOUT} if the same code
12316 were passed to a non-interactive interpreter running as an external
12317 process. For example, compare the following two blocks:
12320 #+begin_src python :results output
12331 In non-session mode, the `2' is not printed and does not appear.
12333 #+begin_src python :results output :session
12345 But in @code{:session} mode, the interactive interpreter receives input `2'
12346 and prints out its value, `2'. (Indeed, the other print statements are
12349 @node Noweb reference syntax, Key bindings and useful functions, Results of evaluation, Working With Source Code
12350 @section Noweb reference syntax
12351 @cindex code block, noweb reference
12352 @cindex syntax, noweb
12353 @cindex source code, noweb reference
12355 The ``noweb'' (see @uref{http://www.cs.tufts.edu/~nr/noweb/}) Literate
12356 Programming system allows named blocks of code to be referenced by using the
12357 familiar Noweb syntax:
12360 <<code-block-name>>
12363 When a code block is tangled or evaluated, whether or not ``noweb''
12364 references are expanded depends upon the value of the @code{:noweb} header
12365 argument. If @code{:noweb yes}, then a Noweb reference is expanded before
12366 evaluation. If @code{:noweb no}, the default, then the reference is not
12367 expanded before evaluation.
12369 Note: the default value, @code{:noweb no}, was chosen to ensure that
12370 correct code is not broken in a language, such as Ruby, where
12371 @code{<<arg>>} is a syntactically valid construct. If @code{<<arg>>} is not
12372 syntactically valid in languages that you use, then please consider setting
12375 @node Key bindings and useful functions, Batch execution, Noweb reference syntax, Working With Source Code
12376 @section Key bindings and useful functions
12377 @cindex code block, key bindings
12379 Many common Org-mode key sequences are re-bound depending on
12382 Within a code block, the following key bindings
12385 @multitable @columnfractions 0.25 0.75
12387 @item @kbd{C-c C-c} @tab org-babel-execute-src-block
12389 @item @kbd{C-c C-o} @tab org-babel-open-src-block-result
12391 @item @kbd{C-@key{up}} @tab org-babel-load-in-session
12393 @item @kbd{M-@key{down}} @tab org-babel-pop-to-session
12396 In an Org-mode buffer, the following key bindings are active:
12398 @multitable @columnfractions 0.45 0.55
12400 @kindex C-c C-v C-a
12401 @item @kbd{C-c C-v a} @ @ @r{or} @ @ @kbd{C-c C-v C-a} @tab org-babel-sha1-hash
12403 @kindex C-c C-v C-b
12404 @item @kbd{C-c C-v b} @ @ @r{or} @ @ @kbd{C-c C-v C-b} @tab org-babel-execute-buffer
12406 @kindex C-c C-v C-f
12407 @item @kbd{C-c C-v f} @ @ @r{or} @ @ @kbd{C-c C-v C-f} @tab org-babel-tangle-file
12409 @item @kbd{C-c C-v g} @tab org-babel-goto-named-source-block
12411 @item @kbd{C-c C-v h} @tab org-babel-describe-bindings
12413 @kindex C-c C-v C-l
12414 @item @kbd{C-c C-v l} @ @ @r{or} @ @ @kbd{C-c C-v C-l} @tab org-babel-lob-ingest
12416 @kindex C-c C-v C-p
12417 @item @kbd{C-c C-v p} @ @ @r{or} @ @ @kbd{C-c C-v C-p} @tab org-babel-expand-src-block
12419 @kindex C-c C-v C-s
12420 @item @kbd{C-c C-v s} @ @ @r{or} @ @ @kbd{C-c C-v C-s} @tab org-babel-execute-subtree
12422 @kindex C-c C-v C-t
12423 @item @kbd{C-c C-v t} @ @ @r{or} @ @ @kbd{C-c C-v C-t} @tab org-babel-tangle
12425 @kindex C-c C-v C-z
12426 @item @kbd{C-c C-v z} @ @ @r{or} @ @ @kbd{C-c C-v C-z} @tab org-babel-switch-to-session
12429 @c When possible these keybindings were extended to work when the control key is
12430 @c kept pressed, resulting in the following additional keybindings.
12432 @c @multitable @columnfractions 0.25 0.75
12433 @c @item @kbd{C-c C-v C-a} @tab org-babel-sha1-hash
12434 @c @item @kbd{C-c C-v C-b} @tab org-babel-execute-buffer
12435 @c @item @kbd{C-c C-v C-f} @tab org-babel-tangle-file
12436 @c @item @kbd{C-c C-v C-l} @tab org-babel-lob-ingest
12437 @c @item @kbd{C-c C-v C-p} @tab org-babel-expand-src-block
12438 @c @item @kbd{C-c C-v C-s} @tab org-babel-execute-subtree
12439 @c @item @kbd{C-c C-v C-t} @tab org-babel-tangle
12440 @c @item @kbd{C-c C-v C-z} @tab org-babel-switch-to-session
12443 @node Batch execution, , Key bindings and useful functions, Working With Source Code
12444 @section Batch execution
12445 @cindex code block, batch execution
12446 @cindex source code, batch execution
12448 It is possible to call functions from the command line. This shell
12449 script calls @code{org-babel-tangle} on every one of its arguments.
12451 Be sure to adjust the paths to fit your system.
12455 # -*- mode: shell-script -*-
12457 # tangle files with org-mode
12461 ORGINSTALL="~/src/org/lisp/org-install.el"
12463 # wrap each argument in the code required to call tangle on it
12465 FILES="$FILES \"$i\""
12468 emacs -Q --batch -l $ORGINSTALL \
12470 (add-to-list 'load-path (expand-file-name \"~/src/org/lisp/\"))
12471 (add-to-list 'load-path (expand-file-name \"~/src/org/contrib/lisp/\"))
12472 (require 'org)(require 'org-exp)(require 'ob)(require 'ob-tangle)
12473 (mapc (lambda (file)
12474 (find-file (expand-file-name file \"$DIR\"))
12476 (kill-buffer)) '($FILES)))" 2>&1 |grep tangled
12479 @node Miscellaneous, Hacking, Working With Source Code, Top
12480 @chapter Miscellaneous
12483 * Completion:: M-TAB knows what you need
12484 * Easy Templates:: Quick insertion of structural elements
12485 * Speed keys:: Electric commands at the beginning of a headline
12486 * Code evaluation security:: Org mode files evaluate inline code
12487 * Customization:: Adapting Org to your taste
12488 * In-buffer settings:: Overview of the #+KEYWORDS
12489 * The very busy C-c C-c key:: When in doubt, press C-c C-c
12490 * Clean view:: Getting rid of leading stars in the outline
12491 * TTY keys:: Using Org on a tty
12492 * Interaction:: Other Emacs packages
12496 @node Completion, Easy Templates, Miscellaneous, Miscellaneous
12497 @section Completion
12498 @cindex completion, of @TeX{} symbols
12499 @cindex completion, of TODO keywords
12500 @cindex completion, of dictionary words
12501 @cindex completion, of option keywords
12502 @cindex completion, of tags
12503 @cindex completion, of property keys
12504 @cindex completion, of link abbreviations
12505 @cindex @TeX{} symbol completion
12506 @cindex TODO keywords completion
12507 @cindex dictionary word completion
12508 @cindex option keyword completion
12509 @cindex tag completion
12510 @cindex link abbreviations, completion of
12512 Emacs would not be Emacs without completion, and Org-mode uses it whenever it
12513 makes sense. If you prefer an @i{iswitchb}- or @i{ido}-like interface for
12514 some of the completion prompts, you can specify your preference by setting at
12515 most one of the variables @code{org-completion-use-iswitchb}
12516 @code{org-completion-use-ido}.
12518 Org supports in-buffer completion. This type of completion does
12519 not make use of the minibuffer. You simply type a few letters into
12520 the buffer and use the key to complete text right there.
12523 @kindex M-@key{TAB}
12525 Complete word at point
12528 At the beginning of a headline, complete TODO keywords.
12530 After @samp{\}, complete @TeX{} symbols supported by the exporter.
12532 After @samp{*}, complete headlines in the current buffer so that they
12533 can be used in search links like @samp{[[*find this headline]]}.
12535 After @samp{:} in a headline, complete tags. The list of tags is taken
12536 from the variable @code{org-tag-alist} (possibly set through the
12537 @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
12538 dynamically from all tags used in the current buffer.
12540 After @samp{:} and not in a headline, complete property keys. The list
12541 of keys is constructed dynamically from all keys used in the current
12544 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
12546 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
12547 @samp{OPTIONS} which set file-specific options for Org-mode. When the
12548 option keyword is already complete, pressing @kbd{M-@key{TAB}} again
12549 will insert example settings for this keyword.
12551 In the line after @samp{#+STARTUP: }, complete startup keywords,
12552 i.e. valid keys for this line.
12554 Elsewhere, complete dictionary words using Ispell.
12558 @node Easy Templates, Speed keys, Completion, Miscellaneous
12559 @section Easy Templates
12560 @cindex template insertion
12561 @cindex insertion, of templates
12563 Org-mode supports insertion of empty structural elements (like
12564 @code{#+BEGIN_SRC} and @code{#+END_SRC} pairs) with just a few key
12565 strokes. This is achieved through a native template expansion mechanism.
12566 Note that Emacs has several other template mechanisms which could be used in
12567 a similar way, for example @file{yasnippet}.
12569 To insert a structural element, type a @samp{<}, followed by a template
12570 selector and @kbd{@key{TAB}}. Completion takes effect only when the above
12571 keystrokes are typed on a line by itself.
12573 The following template selectors are currently supported.
12575 @multitable @columnfractions 0.1 0.9
12576 @item @kbd{s} @tab @code{#+begin_src ... #+end_src}
12577 @item @kbd{e} @tab @code{#+begin_example ... #+end_example}
12578 @item @kbd{q} @tab @code{#+begin_quote ... #+end_quote}
12579 @item @kbd{v} @tab @code{#+begin_verse ... #+end_verse}
12580 @item @kbd{c} @tab @code{#+begin_center ... #+end_center}
12581 @item @kbd{l} @tab @code{#+begin_latex ... #+end_latex}
12582 @item @kbd{L} @tab @code{#+latex:}
12583 @item @kbd{h} @tab @code{#+begin_html ... #+end_html}
12584 @item @kbd{H} @tab @code{#+html:}
12585 @item @kbd{a} @tab @code{#+begin_ascii ... #+end_ascii}
12586 @item @kbd{A} @tab @code{#+ascii:}
12587 @item @kbd{i} @tab @code{#+include:} line
12590 For example, on an empty line, typing "<e" and then pressing TAB, will expand
12591 into a complete EXAMPLE template.
12593 You can install additional templates by customizing the variable
12594 @code{org-structure-template-alist}. See the docstring of the variable for
12595 additional details.
12597 @node Speed keys, Code evaluation security, Easy Templates, Miscellaneous
12598 @section Speed keys
12600 @vindex org-use-speed-commands
12601 @vindex org-speed-commands-user
12603 Single keys can be made to execute commands when the cursor is at the
12604 beginning of a headline, i.e. before the first star. Configure the variable
12605 @code{org-use-speed-commands} to activate this feature. There is a
12606 pre-defined list of commands, and you can add more such commands using the
12607 variable @code{org-speed-commands-user}. Speed keys do not only speed up
12608 navigation and other commands, but they also provide an alternative way to
12609 execute commands bound to keys that are not or not easily available on a TTY,
12610 or on a small mobile device with a limited keyboard.
12612 To see which commands are available, activate the feature and press @kbd{?}
12613 with the cursor at the beginning of a headline.
12615 @node Code evaluation security, Customization, Speed keys, Miscellaneous
12616 @section Code evaluation and security issues
12618 Org provides tools to work with the code snippets, including evaluating them.
12620 Running code on your machine always comes with a security risk. Badly
12621 written or malicious code can be executed on purpose or by accident. Org has
12622 default settings which will only evaluate such code if you give explicit
12623 permission to do so, and as a casual user of these features you should leave
12624 these precautions intact.
12626 For people who regularly work with such code, the confirmation prompts can
12627 become annoying, and you might want to turn them off. This can be done, but
12628 you must be aware of the risks that are involved.
12630 Code evaluation can happen under the following circumstances:
12633 @item Source code blocks
12634 Source code blocks can be evaluated during export, or when pressing @kbd{C-c
12635 C-c} in the block. The most important thing to realize here is that Org mode
12636 files which contain code snippets are, in a certain sense, like executable
12637 files. So you should accept them and load them into Emacs only from trusted
12638 sources---just like you would do with a program you install on your computer.
12640 Make sure you know what you are doing before customizing the variables
12641 which take off the default security brakes.
12643 @defopt org-confirm-babel-evaluate
12644 When set to t user is queried before code block evaluation
12647 @item Following @code{shell} and @code{elisp} links
12648 Org has two link types that can directly evaluate code (@pxref{External
12649 links}). These links can be problematic because the code to be evaluated is
12652 @defopt org-confirm-shell-link-function
12653 Function to queries user about shell link execution.
12655 @defopt org-confirm-elisp-link-function
12656 Functions to query user for Emacs Lisp link execution.
12659 @item Formulas in tables
12660 Formulas in tables (@pxref{The spreadsheet}) are code that is evaluated
12661 either by the @i{calc} interpreter, or by the @i{Emacs Lisp} interpreter.
12664 @node Customization, In-buffer settings, Code evaluation security, Miscellaneous
12665 @section Customization
12666 @cindex customization
12667 @cindex options, for customization
12668 @cindex variables, for customization
12670 There are more than 180 variables that can be used to customize
12671 Org. For the sake of compactness of the manual, I am not
12672 describing the variables here. A structured overview of customization
12673 variables is available with @kbd{M-x org-customize}. Or select
12674 @code{Browse Org Group} from the @code{Org->Customization} menu. Many
12675 settings can also be activated on a per-file basis, by putting special
12676 lines into the buffer (@pxref{In-buffer settings}).
12678 @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous
12679 @section Summary of in-buffer settings
12680 @cindex in-buffer settings
12681 @cindex special keywords
12683 Org-mode uses special lines in the buffer to define settings on a
12684 per-file basis. These lines start with a @samp{#+} followed by a
12685 keyword, a colon, and then individual words defining a setting. Several
12686 setting words can be in the same line, but you can also have multiple
12687 lines for the keyword. While these settings are described throughout
12688 the manual, here is a summary. After changing any of those lines in the
12689 buffer, press @kbd{C-c C-c} with the cursor still in the line to
12690 activate the changes immediately. Otherwise they become effective only
12691 when the file is visited again in a new Emacs session.
12693 @vindex org-archive-location
12695 @item #+ARCHIVE: %s_done::
12696 This line sets the archive location for the agenda file. It applies for
12697 all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
12698 of the file. The first such line also applies to any entries before it.
12699 The corresponding variable is @code{org-archive-location}.
12701 This line sets the category for the agenda file. The category applies
12702 for all subsequent lines until the next @samp{#+CATEGORY} line, or the
12703 end of the file. The first such line also applies to any entries before it.
12704 @item #+COLUMNS: %25ITEM .....
12705 @cindex property, COLUMNS
12706 Set the default format for columns view. This format applies when
12707 columns view is invoked in locations where no @code{COLUMNS} property
12709 @item #+CONSTANTS: name1=value1 ...
12710 @vindex org-table-formula-constants
12711 @vindex org-table-formula
12712 Set file-local values for constants to be used in table formulas. This
12713 line sets the local variable @code{org-table-formula-constants-local}.
12714 The global version of this variable is
12715 @code{org-table-formula-constants}.
12716 @item #+FILETAGS: :tag1:tag2:tag3:
12717 Set tags that can be inherited by any entry in the file, including the
12719 @item #+DRAWERS: NAME1 .....
12720 @vindex org-drawers
12721 Set the file-local set of drawers. The corresponding global variable is
12722 @code{org-drawers}.
12723 @item #+LINK: linkword replace
12724 @vindex org-link-abbrev-alist
12725 These lines (several are allowed) specify link abbreviations.
12726 @xref{Link abbreviations}. The corresponding variable is
12727 @code{org-link-abbrev-alist}.
12728 @item #+PRIORITIES: highest lowest default
12729 @vindex org-highest-priority
12730 @vindex org-lowest-priority
12731 @vindex org-default-priority
12732 This line sets the limits and the default for the priorities. All three
12733 must be either letters A-Z or numbers 0-9. The highest priority must
12734 have a lower ASCII number than the lowest priority.
12735 @item #+PROPERTY: Property_Name Value
12736 This line sets a default inheritance value for entries in the current
12737 buffer, most useful for specifying the allowed values of a property.
12738 @cindex #+SETUPFILE
12739 @item #+SETUPFILE: file
12740 This line defines a file that holds more in-buffer setup. Normally this is
12741 entirely ignored. Only when the buffer is parsed for option-setting lines
12742 (i.e. when starting Org-mode for a file, when pressing @kbd{C-c C-c} in a
12743 settings line, or when exporting), then the contents of this file are parsed
12744 as if they had been included in the buffer. In particular, the file can be
12745 any other Org-mode file with internal setup. You can visit the file the
12746 cursor is in the line with @kbd{C-c '}.
12749 This line sets options to be used at startup of Org-mode, when an
12750 Org file is being visited.
12752 The first set of options deals with the initial visibility of the outline
12753 tree. The corresponding variable for global default settings is
12754 @code{org-startup-folded}, with a default value @code{t}, which means
12756 @vindex org-startup-folded
12757 @cindex @code{overview}, STARTUP keyword
12758 @cindex @code{content}, STARTUP keyword
12759 @cindex @code{showall}, STARTUP keyword
12760 @cindex @code{showeverything}, STARTUP keyword
12762 overview @r{top-level headlines only}
12763 content @r{all headlines}
12764 showall @r{no folding of any entries}
12765 showeverything @r{show even drawer contents}
12768 @vindex org-startup-indented
12769 @cindex @code{indent}, STARTUP keyword
12770 @cindex @code{noindent}, STARTUP keyword
12771 Dynamic virtual indentation is controlled by the variable
12772 @code{org-startup-indented}@footnote{Emacs 23 and Org-mode 6.29 are required}
12774 indent @r{start with @code{org-indent-mode} turned on}
12775 noindent @r{start with @code{org-indent-mode} turned off}
12778 @vindex org-startup-align-all-tables
12779 Then there are options for aligning tables upon visiting a file. This
12780 is useful in files containing narrowed table columns. The corresponding
12781 variable is @code{org-startup-align-all-tables}, with a default value
12783 @cindex @code{align}, STARTUP keyword
12784 @cindex @code{noalign}, STARTUP keyword
12786 align @r{align all tables}
12787 noalign @r{don't align tables on startup}
12790 @vindex org-startup-with-inline-images
12791 When visiting a file, inline images can be automatically displayed. The
12792 corresponding variable is @code{org-startup-with-inline-images}, with a
12793 default value @code{nil} to avoid delays when visiting a file.
12794 @cindex @code{inlineimages}, STARTUP keyword
12795 @cindex @code{noinlineimages}, STARTUP keyword
12797 inlineimages @r{show inline images}
12798 noinlineimages @r{don't show inline images on startup}
12801 @vindex org-log-done
12802 @vindex org-log-note-clock-out
12803 @vindex org-log-repeat
12804 Logging the closing and reopening of TODO items and clock intervals can be
12805 configured using these options (see variables @code{org-log-done},
12806 @code{org-log-note-clock-out} and @code{org-log-repeat})
12807 @cindex @code{logdone}, STARTUP keyword
12808 @cindex @code{lognotedone}, STARTUP keyword
12809 @cindex @code{nologdone}, STARTUP keyword
12810 @cindex @code{lognoteclock-out}, STARTUP keyword
12811 @cindex @code{nolognoteclock-out}, STARTUP keyword
12812 @cindex @code{logrepeat}, STARTUP keyword
12813 @cindex @code{lognoterepeat}, STARTUP keyword
12814 @cindex @code{nologrepeat}, STARTUP keyword
12815 @cindex @code{logreschedule}, STARTUP keyword
12816 @cindex @code{lognotereschedule}, STARTUP keyword
12817 @cindex @code{nologreschedule}, STARTUP keyword
12818 @cindex @code{logredeadline}, STARTUP keyword
12819 @cindex @code{lognoteredeadline}, STARTUP keyword
12820 @cindex @code{nologredeadline}, STARTUP keyword
12821 @cindex @code{logrefile}, STARTUP keyword
12822 @cindex @code{lognoterefile}, STARTUP keyword
12823 @cindex @code{nologrefile}, STARTUP keyword
12825 logdone @r{record a timestamp when an item is marked DONE}
12826 lognotedone @r{record timestamp and a note when DONE}
12827 nologdone @r{don't record when items are marked DONE}
12828 logrepeat @r{record a time when reinstating a repeating item}
12829 lognoterepeat @r{record a note when reinstating a repeating item}
12830 nologrepeat @r{do not record when reinstating repeating item}
12831 lognoteclock-out @r{record a note when clocking out}
12832 nolognoteclock-out @r{don't record a note when clocking out}
12833 logreschedule @r{record a timestamp when scheduling time changes}
12834 lognotereschedule @r{record a note when scheduling time changes}
12835 nologreschedule @r{do not record when a scheduling date changes}
12836 logredeadline @r{record a timestamp when deadline changes}
12837 lognoteredeadline @r{record a note when deadline changes}
12838 nologredeadline @r{do not record when a deadline date changes}
12839 logrefile @r{record a timestamp when refiling}
12840 lognoterefile @r{record a note when refiling}
12841 nologrefile @r{do not record when refiling}
12843 @vindex org-hide-leading-stars
12844 @vindex org-odd-levels-only
12845 Here are the options for hiding leading stars in outline headings, and for
12846 indenting outlines. The corresponding variables are
12847 @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
12848 default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
12849 @cindex @code{hidestars}, STARTUP keyword
12850 @cindex @code{showstars}, STARTUP keyword
12851 @cindex @code{odd}, STARTUP keyword
12852 @cindex @code{even}, STARTUP keyword
12854 hidestars @r{make all but one of the stars starting a headline invisible.}
12855 showstars @r{show all stars starting a headline}
12856 indent @r{virtual indentation according to outline level}
12857 noindent @r{no virtual indentation according to outline level}
12858 odd @r{allow only odd outline levels (1,3,...)}
12859 oddeven @r{allow all outline levels}
12861 @vindex org-put-time-stamp-overlays
12862 @vindex org-time-stamp-overlay-formats
12863 To turn on custom format overlays over timestamps (variables
12864 @code{org-put-time-stamp-overlays} and
12865 @code{org-time-stamp-overlay-formats}), use
12866 @cindex @code{customtime}, STARTUP keyword
12868 customtime @r{overlay custom time format}
12870 @vindex constants-unit-system
12871 The following options influence the table spreadsheet (variable
12872 @code{constants-unit-system}).
12873 @cindex @code{constcgs}, STARTUP keyword
12874 @cindex @code{constSI}, STARTUP keyword
12876 constcgs @r{@file{constants.el} should use the c-g-s unit system}
12877 constSI @r{@file{constants.el} should use the SI unit system}
12879 @vindex org-footnote-define-inline
12880 @vindex org-footnote-auto-label
12881 @vindex org-footnote-auto-adjust
12882 To influence footnote settings, use the following keywords. The
12883 corresponding variables are @code{org-footnote-define-inline},
12884 @code{org-footnote-auto-label}, and @code{org-footnote-auto-adjust}.
12885 @cindex @code{fninline}, STARTUP keyword
12886 @cindex @code{nofninline}, STARTUP keyword
12887 @cindex @code{fnlocal}, STARTUP keyword
12888 @cindex @code{fnprompt}, STARTUP keyword
12889 @cindex @code{fnauto}, STARTUP keyword
12890 @cindex @code{fnconfirm}, STARTUP keyword
12891 @cindex @code{fnplain}, STARTUP keyword
12892 @cindex @code{fnadjust}, STARTUP keyword
12893 @cindex @code{nofnadjust}, STARTUP keyword
12895 fninline @r{define footnotes inline}
12896 fnnoinline @r{define footnotes in separate section}
12897 fnlocal @r{define footnotes near first reference, but not inline}
12898 fnprompt @r{prompt for footnote labels}
12899 fnauto @r{create [fn:1]-like labels automatically (default)}
12900 fnconfirm @r{offer automatic label for editing or confirmation}
12901 fnplain @r{create [1]-like labels automatically}
12902 fnadjust @r{automatically renumber and sort footnotes}
12903 nofnadjust @r{do not renumber and sort automatically}
12905 @cindex org-hide-block-startup
12906 To hide blocks on startup, use these keywords. The corresponding variable is
12907 @code{org-hide-block-startup}.
12908 @cindex @code{hideblocks}, STARTUP keyword
12909 @cindex @code{nohideblocks}, STARTUP keyword
12911 hideblocks @r{Hide all begin/end blocks on startup}
12912 nohideblocks @r{Do not hide blocks on startup}
12914 @cindex org-pretty-entities
12915 The display of entities as UTF-8 characters is governed by the variable
12916 @code{org-pretty-entities} and the keywords
12917 @cindex @code{entitiespretty}, STARTUP keyword
12918 @cindex @code{entitiesplain}, STARTUP keyword
12920 entitiespretty @r{Show entities as UTF-8 characters where possible}
12921 entitiesplain @r{Leave entities plain}
12923 @item #+TAGS: TAG1(c1) TAG2(c2)
12924 @vindex org-tag-alist
12925 These lines (several such lines are allowed) specify the valid tags in
12926 this file, and (potentially) the corresponding @emph{fast tag selection}
12927 keys. The corresponding variable is @code{org-tag-alist}.
12929 This line contains the formulas for the table directly above the line.
12930 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+DATE:,
12931 @itemx #+OPTIONS:, #+BIND:, #+XSLT:,
12932 @itemx #+DESCRIPTION:, #+KEYWORDS:,
12933 @itemx #+LATEX_HEADER:, #+STYLE:, #+LINK_UP:, #+LINK_HOME:,
12934 @itemx #+EXPORT_SELECT_TAGS:, #+EXPORT_EXCLUDE_TAGS:
12935 These lines provide settings for exporting files. For more details see
12936 @ref{Export options}.
12937 @item #+TODO: #+SEQ_TODO: #+TYP_TODO:
12938 @vindex org-todo-keywords
12939 These lines set the TODO keywords and their interpretation in the
12940 current file. The corresponding variable is @code{org-todo-keywords}.
12943 @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous
12944 @section The very busy C-c C-c key
12946 @cindex C-c C-c, overview
12948 The key @kbd{C-c C-c} has many purposes in Org, which are all
12949 mentioned scattered throughout this manual. One specific function of
12950 this key is to add @emph{tags} to a headline (@pxref{Tags}). In many
12951 other circumstances it means something like @emph{``Hey Org, look
12952 here and update according to what you see here''}. Here is a summary of
12953 what this means in different contexts.
12957 If there are highlights in the buffer from the creation of a sparse
12958 tree, or from clock display, remove these highlights.
12960 If the cursor is in one of the special @code{#+KEYWORD} lines, this
12961 triggers scanning the buffer for these lines and updating the
12964 If the cursor is inside a table, realign the table. This command
12965 works even if the automatic table editor has been turned off.
12967 If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
12970 If the current buffer is a capture buffer, close the note and file it.
12971 With a prefix argument, file it, without further interaction, to the
12974 If the cursor is on a @code{<<<target>>>}, update radio targets and
12975 corresponding links in this buffer.
12977 If the cursor is in a property line or at the start or end of a property
12978 drawer, offer property commands.
12980 If the cursor is at a footnote reference, go to the corresponding
12981 definition, and vice versa.
12983 If the cursor is on a statistics cookie, update it.
12985 If the cursor is in a plain list item with a checkbox, toggle the status
12988 If the cursor is on a numbered item in a plain list, renumber the
12991 If the cursor is on the @code{#+BEGIN} line of a dynamic block, the
12995 @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous
12996 @section A cleaner outline view
12997 @cindex hiding leading stars
12998 @cindex dynamic indentation
12999 @cindex odd-levels-only outlines
13000 @cindex clean outline view
13002 Some people find it noisy and distracting that the Org headlines start with a
13003 potentially large number of stars, and that text below the headlines is not
13004 indented. While this is no problem when writing a @emph{book-like} document
13005 where the outline headings are really section headings, in a more
13006 @emph{list-oriented} outline, indented structure is a lot cleaner:
13010 * Top level headline | * Top level headline
13011 ** Second level | * Second level
13012 *** 3rd level | * 3rd level
13013 some text | some text
13014 *** 3rd level | * 3rd level
13015 more text | more text
13016 * Another top level headline | * Another top level headline
13022 If you are using at least Emacs 23.2@footnote{Emacs 23.1 can actually crash
13023 with @code{org-indent-mode}} and version 6.29 of Org, this kind of view can
13024 be achieved dynamically at display time using @code{org-indent-mode}. In
13025 this minor mode, all lines are prefixed for display with the necessary amount
13026 of space@footnote{@code{org-indent-mode} also sets the @code{wrap-prefix}
13027 property, such that @code{visual-line-mode} (or purely setting
13028 @code{word-wrap}) wraps long lines (including headlines) correctly indented.
13029 }. Also headlines are prefixed with additional stars, so that the amount of
13030 indentation shifts by two@footnote{See the variable
13031 @code{org-indent-indentation-per-level}.} spaces per level. All headline
13032 stars but the last one are made invisible using the @code{org-hide}
13033 face@footnote{Turning on @code{org-indent-mode} sets
13034 @code{org-hide-leading-stars} to @code{t} and @code{org-adapt-indentation} to
13035 @code{nil}.} - see below under @samp{2.} for more information on how this
13036 works. You can turn on @code{org-indent-mode} for all files by customizing
13037 the variable @code{org-startup-indented}, or you can turn it on for
13038 individual files using
13044 If you want a similar effect in an earlier version of Emacs and/or Org, or if
13045 you want the indentation to be hard space characters so that the plain text
13046 file looks as similar as possible to the Emacs display, Org supports you in
13051 @emph{Indentation of text below headlines}@*
13052 You may indent text below each headline to make the left boundary line up
13053 with the headline, like
13057 more text, now indented
13060 @vindex org-adapt-indentation
13061 Org supports this with paragraph filling, line wrapping, and structure
13062 editing@footnote{See also the variable @code{org-adapt-indentation}.},
13063 preserving or adapting the indentation as appropriate.
13066 @vindex org-hide-leading-stars
13067 @emph{Hiding leading stars}@* You can modify the display in such a way that
13068 all leading stars become invisible. To do this in a global way, configure
13069 the variable @code{org-hide-leading-stars} or change this on a per-file basis
13073 #+STARTUP: hidestars
13074 #+STARTUP: showstars
13077 With hidden stars, the tree becomes:
13081 * Top level headline
13089 @vindex org-hide @r{(face)}
13090 The leading stars are not truly replaced by whitespace, they are only
13091 fontified with the face @code{org-hide} that uses the background color as
13092 font color. If you are not using either white or black background, you may
13093 have to customize this face to get the wanted effect. Another possibility is
13094 to set this font such that the extra stars are @i{almost} invisible, for
13095 example using the color @code{grey90} on a white background.
13098 @vindex org-odd-levels-only
13099 Things become cleaner still if you skip all the even levels and use only odd
13100 levels 1, 3, 5..., effectively adding two stars to go from one outline level
13101 to the next@footnote{When you need to specify a level for a property search
13102 or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc@.}. In this
13103 way we get the outline view shown at the beginning of this section. In order
13104 to make the structure editing and export commands handle this convention
13105 correctly, configure the variable @code{org-odd-levels-only}, or set this on
13106 a per-file basis with one of the following lines:
13113 You can convert an Org file from single-star-per-level to the
13114 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
13115 RET} in that file. The reverse operation is @kbd{M-x
13116 org-convert-to-oddeven-levels}.
13119 @node TTY keys, Interaction, Clean view, Miscellaneous
13120 @section Using Org on a tty
13121 @cindex tty key bindings
13123 Because Org contains a large number of commands, by default many of
13124 Org's core commands are bound to keys that are generally not
13125 accessible on a tty, such as the cursor keys (@key{left}, @key{right},
13126 @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
13127 together with modifiers like @key{Meta} and/or @key{Shift}. To access
13128 these commands on a tty when special keys are unavailable, the following
13129 alternative bindings can be used. The tty bindings below will likely be
13130 more cumbersome; you may find for some of the bindings below that a
13131 customized workaround suits you better. For example, changing a timestamp
13132 is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
13133 tty you would rather use @kbd{C-c .} to re-insert the timestamp.
13135 @multitable @columnfractions 0.15 0.2 0.1 0.2
13136 @item @b{Default} @tab @b{Alternative 1} @tab @b{Speed key} @tab @b{Alternative 2}
13137 @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab @kbd{C} @tab
13138 @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{l} @tab @kbd{@key{Esc} @key{left}}
13139 @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab @kbd{L} @tab
13140 @item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{r} @tab @kbd{@key{Esc} @key{right}}
13141 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab @kbd{R} @tab
13142 @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{ } @tab @kbd{@key{Esc} @key{up}}
13143 @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab @kbd{U} @tab
13144 @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{ } @tab @kbd{@key{Esc} @key{down}}
13145 @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab @kbd{D} @tab
13146 @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab @kbd{ } @tab
13147 @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{ } @tab @kbd{@key{Esc} @key{RET}}
13148 @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab @kbd{ } @tab
13149 @item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab @kbd{ } @tab
13150 @item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab @kbd{ } @tab
13151 @item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab @kbd{ } @tab
13152 @item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab @kbd{ } @tab
13153 @item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab @kbd{ } @tab
13154 @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab @kbd{ } @tab
13158 @node Interaction, , TTY keys, Miscellaneous
13159 @section Interaction with other packages
13160 @cindex packages, interaction with other
13161 Org lives in the world of GNU Emacs and interacts in various ways
13162 with other code out there.
13165 * Cooperation:: Packages Org cooperates with
13166 * Conflicts:: Packages that lead to conflicts
13169 @node Cooperation, Conflicts, Interaction, Interaction
13170 @subsection Packages that Org cooperates with
13173 @cindex @file{calc.el}
13174 @cindex Gillespie, Dave
13175 @item @file{calc.el} by Dave Gillespie
13176 Org uses the Calc package for implementing spreadsheet
13177 functionality in its tables (@pxref{The spreadsheet}). Org
13178 checks for the availability of Calc by looking for the function
13179 @code{calc-eval} which will have been autoloaded during setup if Calc has
13180 been installed properly. As of Emacs 22, Calc is part of the Emacs
13181 distribution. Another possibility for interaction between the two
13182 packages is using Calc for embedded calculations. @xref{Embedded Mode,
13183 , Embedded Mode, Calc, GNU Emacs Calc Manual}.
13184 @item @file{constants.el} by Carsten Dominik
13185 @cindex @file{constants.el}
13186 @cindex Dominik, Carsten
13187 @vindex org-table-formula-constants
13188 In a table formula (@pxref{The spreadsheet}), it is possible to use
13189 names for natural constants or units. Instead of defining your own
13190 constants in the variable @code{org-table-formula-constants}, install
13191 the @file{constants} package which defines a large number of constants
13192 and units, and lets you use unit prefixes like @samp{M} for
13193 @samp{Mega}, etc@. You will need version 2.0 of this package, available
13194 at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for
13195 the function @code{constants-get}, which has to be autoloaded in your
13196 setup. See the installation instructions in the file
13197 @file{constants.el}.
13198 @item @file{cdlatex.el} by Carsten Dominik
13199 @cindex @file{cdlatex.el}
13200 @cindex Dominik, Carsten
13201 Org-mode can make use of the CDLa@TeX{} package to efficiently enter
13202 @LaTeX{} fragments into Org files. See @ref{CDLaTeX mode}.
13203 @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
13204 @cindex @file{imenu.el}
13205 Imenu allows menu access to an index of items in a file. Org-mode
13206 supports Imenu---all you need to do to get the index is the following:
13208 (add-hook 'org-mode-hook
13209 (lambda () (imenu-add-to-menubar "Imenu")))
13211 @vindex org-imenu-depth
13212 By default the index is two levels deep---you can modify the depth using
13213 the option @code{org-imenu-depth}.
13214 @item @file{remember.el} by John Wiegley
13215 @cindex @file{remember.el}
13216 @cindex Wiegley, John
13217 Org used to use this package for capture, but no longer does.
13218 @item @file{speedbar.el} by Eric M. Ludlam
13219 @cindex @file{speedbar.el}
13220 @cindex Ludlam, Eric M.
13221 Speedbar is a package that creates a special frame displaying files and
13222 index items in files. Org-mode supports Speedbar and allows you to
13223 drill into Org files directly from the Speedbar. It also allows you to
13224 restrict the scope of agenda commands to a file or a subtree by using
13225 the command @kbd{<} in the Speedbar frame.
13226 @cindex @file{table.el}
13227 @item @file{table.el} by Takaaki Ota
13229 @cindex table editor, @file{table.el}
13230 @cindex @file{table.el}
13231 @cindex Ota, Takaaki
13233 Complex ASCII tables with automatic line wrapping, column- and row-spanning,
13234 and alignment can be created using the Emacs table package by Takaaki Ota
13235 (@uref{http://sourceforge.net/projects/table}, and also part of Emacs 22).
13236 Org-mode will recognize these tables and export them properly. Because of
13237 interference with other Org-mode functionality, you unfortunately cannot edit
13238 these tables directly in the buffer. Instead, you need to use the command
13239 @kbd{C-c '} to edit them, similar to source code snippets.
13242 @orgcmd{C-c ',org-edit-special}
13243 Edit a @file{table.el} table. Works when the cursor is in a table.el table.
13245 @orgcmd{C-c ~,org-table-create-with-table.el}
13246 Insert a @file{table.el} table. If there is already a table at point, this
13247 command converts it between the @file{table.el} format and the Org-mode
13248 format. See the documentation string of the command
13249 @code{org-convert-table} for the restrictions under which this is
13252 @file{table.el} is part of Emacs since Emacs 22.
13253 @item @file{footnote.el} by Steven L. Baur
13254 @cindex @file{footnote.el}
13255 @cindex Baur, Steven L.
13256 Org-mode recognizes numerical footnotes as provided by this package.
13257 However, Org-mode also has its own footnote support (@pxref{Footnotes}),
13258 which makes using @file{footnote.el} unnecessary.
13261 @node Conflicts, , Cooperation, Interaction
13262 @subsection Packages that lead to conflicts with Org-mode
13266 @cindex @code{shift-selection-mode}
13267 @vindex org-support-shift-select
13268 In Emacs 23, @code{shift-selection-mode} is on by default, meaning that
13269 cursor motions combined with the shift key should start or enlarge regions.
13270 This conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change
13271 timestamps, TODO keywords, priorities, and item bullet types if the cursor is
13272 at such a location. By default, @kbd{S-@key{cursor}} commands outside
13273 special contexts don't do anything, but you can customize the variable
13274 @code{org-support-shift-select}. Org-mode then tries to accommodate shift
13275 selection by (i) using it outside of the special contexts where special
13276 commands apply, and by (ii) extending an existing active region even if the
13277 cursor moves across a special context.
13279 @item @file{CUA.el} by Kim. F. Storm
13280 @cindex @file{CUA.el}
13281 @cindex Storm, Kim. F.
13282 @vindex org-replace-disputed-keys
13283 Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by CUA mode
13284 (as well as @code{pc-select-mode} and @code{s-region-mode}) to select and extend the
13285 region. In fact, Emacs 23 has this built-in in the form of
13286 @code{shift-selection-mode}, see previous paragraph. If you are using Emacs
13287 23, you probably don't want to use another package for this purpose. However,
13288 if you prefer to leave these keys to a different package while working in
13289 Org-mode, configure the variable @code{org-replace-disputed-keys}. When set,
13290 Org will move the following key bindings in Org files, and in the agenda
13291 buffer (but not during date selection).
13294 S-UP -> M-p S-DOWN -> M-n
13295 S-LEFT -> M-- S-RIGHT -> M-+
13296 C-S-LEFT -> M-S-- C-S-RIGHT -> M-S-+
13299 @vindex org-disputed-keys
13300 Yes, these are unfortunately more difficult to remember. If you want
13301 to have other replacement keys, look at the variable
13302 @code{org-disputed-keys}.
13304 @item @file{yasnippet.el}
13305 @cindex @file{yasnippet.el}
13306 The way Org-mode binds the TAB key (binding to @code{[tab]} instead of
13307 @code{"\t"}) overrules YASnippet's access to this key. The following code
13308 fixed this problem:
13311 (add-hook 'org-mode-hook
13313 (org-set-local 'yas/trigger-key [tab])
13314 (define-key yas/keymap [tab] 'yas/next-field-group)))
13317 @item @file{windmove.el} by Hovav Shacham
13318 @cindex @file{windmove.el}
13319 This package also uses the @kbd{S-<cursor>} keys, so everything written
13320 in the paragraph above about CUA mode also applies here. If you want make
13321 the windmove function active in locations where Org-mode does not have
13322 special functionality on @kbd{S-@key{cursor}}, add this to your
13326 ;; Make windmove work in org-mode:
13327 (add-hook 'org-shiftup-final-hook 'windmove-up)
13328 (add-hook 'org-shiftleft-final-hook 'windmove-left)
13329 (add-hook 'org-shiftdown-final-hook 'windmove-down)
13330 (add-hook 'org-shiftright-final-hook 'windmove-right)
13333 @item @file{viper.el} by Michael Kifer
13334 @cindex @file{viper.el}
13336 Viper uses @kbd{C-c /} and therefore makes this key not access the
13337 corresponding Org-mode command @code{org-sparse-tree}. You need to find
13338 another key for this command, or override the key in
13339 @code{viper-vi-global-user-map} with
13342 (define-key viper-vi-global-user-map "C-c /" 'org-sparse-tree)
13348 @node Hacking, MobileOrg, Miscellaneous, Top
13352 This appendix covers some aspects where users can extend the functionality of
13356 * Hooks:: Who to reach into Org's internals
13357 * Add-on packages:: Available extensions
13358 * Adding hyperlink types:: New custom link types
13359 * Context-sensitive commands:: How to add functionality to such commands
13360 * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
13361 * Dynamic blocks:: Automatically filled blocks
13362 * Special agenda views:: Customized views
13363 * Extracting agenda information:: Postprocessing of agenda information
13364 * Using the property API:: Writing programs that use entry properties
13365 * Using the mapping API:: Mapping over all or selected entries
13368 @node Hooks, Add-on packages, Hacking, Hacking
13372 Org has a large number of hook variables that can be used to add
13373 functionality. This appendix about hacking is going to illustrate the
13374 use of some of them. A complete list of all hooks with documentation is
13375 maintained by the Worg project and can be found at
13376 @uref{http://orgmode.org/worg/org-configs/org-hooks.php}.
13378 @node Add-on packages, Adding hyperlink types, Hooks, Hacking
13379 @section Add-on packages
13380 @cindex add-on packages
13382 A large number of add-on packages have been written by various authors.
13383 These packages are not part of Emacs, but they are distributed as contributed
13384 packages with the separate release available at the Org-mode home page at
13385 @uref{http://orgmode.org}. The list of contributed packages, along with
13386 documentation about each package, is maintained by the Worg project at
13387 @uref{http://orgmode.org/worg/org-contrib/}.
13391 @node Adding hyperlink types, Context-sensitive commands, Add-on packages, Hacking
13392 @section Adding hyperlink types
13393 @cindex hyperlinks, adding new types
13395 Org has a large number of hyperlink types built-in
13396 (@pxref{Hyperlinks}). If you would like to add new link types, Org
13397 provides an interface for doing so. Let's look at an example file,
13398 @file{org-man.el}, that will add support for creating links like
13399 @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
13403 ;;; org-man.el - Support for links to manpages in Org
13407 (org-add-link-type "man" 'org-man-open)
13408 (add-hook 'org-store-link-functions 'org-man-store-link)
13410 (defcustom org-man-command 'man
13411 "The Emacs command to be used to display a man page."
13413 :type '(choice (const man) (const woman)))
13415 (defun org-man-open (path)
13416 "Visit the manpage on PATH.
13417 PATH should be a topic that can be thrown at the man command."
13418 (funcall org-man-command path))
13420 (defun org-man-store-link ()
13421 "Store a link to a manpage."
13422 (when (memq major-mode '(Man-mode woman-mode))
13423 ;; This is a man page, we do make this link
13424 (let* ((page (org-man-get-page-name))
13425 (link (concat "man:" page))
13426 (description (format "Manpage for %s" page)))
13427 (org-store-link-props
13430 :description description))))
13432 (defun org-man-get-page-name ()
13433 "Extract the page name from the buffer name."
13434 ;; This works for both `Man-mode' and `woman-mode'.
13435 (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
13436 (match-string 1 (buffer-name))
13437 (error "Cannot create link to this man page")))
13441 ;;; org-man.el ends here
13445 You would activate this new link type in @file{.emacs} with
13452 Let's go through the file and see what it does.
13455 It does @code{(require 'org)} to make sure that @file{org.el} has been
13458 The next line calls @code{org-add-link-type} to define a new link type
13459 with prefix @samp{man}. The call also contains the name of a function
13460 that will be called to follow such a link.
13462 @vindex org-store-link-functions
13463 The next line adds a function to @code{org-store-link-functions}, in
13464 order to allow the command @kbd{C-c l} to record a useful link in a
13465 buffer displaying a man page.
13468 The rest of the file defines the necessary variables and functions.
13469 First there is a customization variable that determines which Emacs
13470 command should be used to display man pages. There are two options,
13471 @code{man} and @code{woman}. Then the function to follow a link is
13472 defined. It gets the link path as an argument---in this case the link
13473 path is just a topic for the manual command. The function calls the
13474 value of @code{org-man-command} to display the man page.
13476 Finally the function @code{org-man-store-link} is defined. When you try
13477 to store a link with @kbd{C-c l}, this function will be called to
13478 try to make a link. The function must first decide if it is supposed to
13479 create the link for this buffer type; we do this by checking the value
13480 of the variable @code{major-mode}. If not, the function must exit and
13481 return the value @code{nil}. If yes, the link is created by getting the
13482 manual topic from the buffer name and prefixing it with the string
13483 @samp{man:}. Then it must call the command @code{org-store-link-props}
13484 and set the @code{:type} and @code{:link} properties. Optionally you
13485 can also set the @code{:description} property to provide a default for
13486 the link description when the link is later inserted into an Org
13487 buffer with @kbd{C-c C-l}.
13489 When it makes sense for your new link type, you may also define a function
13490 @code{org-PREFIX-complete-link} that implements special (e.g. completion)
13491 support for inserting such a link with @kbd{C-c C-l}. Such a function should
13492 not accept any arguments, and return the full link with prefix.
13494 @node Context-sensitive commands, Tables in arbitrary syntax, Adding hyperlink types, Hacking
13495 @section Context-sensitive commands
13496 @cindex context-sensitive commands, hooks
13497 @cindex add-ons, context-sensitive commands
13498 @vindex org-ctrl-c-ctrl-c-hook
13500 Org has several commands that act differently depending on context. The most
13501 important example it the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}).
13502 Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys have this property.
13504 Add-ons can tap into this functionality by providing a function that detects
13505 special context for that add-on and executes functionality appropriate for
13506 the context. Here is an example from Dan Davison's @file{org-R.el} which
13507 allows you to evaluate commands based on the @file{R} programming language
13508 @footnote{@file{org-R.el} has been replaced by the org-mode functionality
13509 described in @ref{Working With Source Code} and is now obsolete.}. For this
13510 package, special contexts are lines that start with @code{#+R:} or
13514 (defun org-R-apply-maybe ()
13515 "Detect if this is context for org-R and execute R commands."
13516 (if (save-excursion
13517 (beginning-of-line 1)
13518 (looking-at "#\\+RR?:"))
13519 (progn (call-interactively 'org-R-apply)
13520 t) ;; to signal that we took action
13521 nil)) ;; to signal that we did not
13523 (add-hook 'org-ctrl-c-ctrl-c-hook 'org-R-apply-maybe)
13526 The function first checks if the cursor is in such a line. If that is the
13527 case, @code{org-R-apply} is called and the function returns @code{t} to
13528 signal that action was taken, and @kbd{C-c C-c} will stop looking for other
13529 contexts. If the function finds it should do nothing locally, it returns @code{nil} so that other, similar functions can have a try.
13532 @node Tables in arbitrary syntax, Dynamic blocks, Context-sensitive commands, Hacking
13533 @section Tables and lists in arbitrary syntax
13534 @cindex tables, in other modes
13535 @cindex lists, in other modes
13536 @cindex Orgtbl mode
13538 Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
13539 frequent feature request has been to make it work with native tables in
13540 specific languages, for example @LaTeX{}. However, this is extremely
13541 hard to do in a general way, would lead to a customization nightmare,
13542 and would take away much of the simplicity of the Orgtbl-mode table
13545 This appendix describes a different approach. We keep the Orgtbl mode
13546 table in its native format (the @i{source table}), and use a custom
13547 function to @i{translate} the table to the correct syntax, and to
13548 @i{install} it in the right location (the @i{target table}). This puts
13549 the burden of writing conversion functions on the user, but it allows
13550 for a very flexible system.
13552 Bastien added the ability to do the same with lists, in Orgstruct mode. You
13553 can use Org's facilities to edit and structure lists by turning
13554 @code{orgstruct-mode} on, then locally exporting such lists in another format
13555 (HTML, @LaTeX{} or Texinfo.)
13559 * Radio tables:: Sending and receiving radio tables
13560 * A LaTeX example:: Step by step, almost a tutorial
13561 * Translator functions:: Copy and modify
13562 * Radio lists:: Doing the same for lists
13565 @node Radio tables, A LaTeX example, Tables in arbitrary syntax, Tables in arbitrary syntax
13566 @subsection Radio tables
13567 @cindex radio tables
13569 To define the location of the target table, you first need to create two
13570 lines that are comments in the current mode, but contain magic words for
13571 Orgtbl mode to find. Orgtbl mode will insert the translated table
13572 between these lines, replacing whatever was there before. For example:
13575 /* BEGIN RECEIVE ORGTBL table_name */
13576 /* END RECEIVE ORGTBL table_name */
13580 Just above the source table, we put a special line that tells
13581 Orgtbl mode how to translate this table and where to install it. For
13585 #+ORGTBL: SEND table_name translation_function arguments....
13589 @code{table_name} is the reference name for the table that is also used
13590 in the receiver lines. @code{translation_function} is the Lisp function
13591 that does the translation. Furthermore, the line can contain a list of
13592 arguments (alternating key and value) at the end. The arguments will be
13593 passed as a property list to the translation function for
13594 interpretation. A few standard parameters are already recognized and
13595 acted upon before the translation function is called:
13599 Skip the first N lines of the table. Hlines do count as separate lines for
13602 @item :skipcols (n1 n2 ...)
13603 List of columns that should be skipped. If the table has a column with
13604 calculation marks, that column is automatically discarded as well.
13605 Please note that the translator function sees the table @emph{after} the
13606 removal of these columns, the function never knows that there have been
13607 additional columns.
13611 The one problem remaining is how to keep the source table in the buffer
13612 without disturbing the normal workings of the file, for example during
13613 compilation of a C file or processing of a @LaTeX{} file. There are a
13614 number of different solutions:
13618 The table could be placed in a block comment if that is supported by the
13619 language. For example, in C mode you could wrap the table between
13620 @samp{/*} and @samp{*/} lines.
13622 Sometimes it is possible to put the table after some kind of @i{END}
13623 statement, for example @samp{\bye} in @TeX{} and @samp{\end@{document@}}
13626 You can just comment the table line-by-line whenever you want to process
13627 the file, and uncomment it whenever you need to edit the table. This
13628 only sounds tedious---the command @kbd{M-x orgtbl-toggle-comment}
13629 makes this comment-toggling very easy, in particular if you bind it to a
13633 @node A LaTeX example, Translator functions, Radio tables, Tables in arbitrary syntax
13634 @subsection A @LaTeX{} example of radio tables
13635 @cindex @LaTeX{}, and Orgtbl mode
13637 The best way to wrap the source table in @LaTeX{} is to use the
13638 @code{comment} environment provided by @file{comment.sty}. It has to be
13639 activated by placing @code{\usepackage@{comment@}} into the document
13640 header. Orgtbl mode can insert a radio table skeleton@footnote{By
13641 default this works only for @LaTeX{}, HTML, and Texinfo. Configure the
13642 variable @code{orgtbl-radio-tables} to install templates for other
13643 modes.} with the command @kbd{M-x orgtbl-insert-radio-table}. You will
13644 be prompted for a table name, let's say we use @samp{salesfigures}. You
13645 will then get the following template:
13647 @cindex #+ORGTBL, SEND
13649 % BEGIN RECEIVE ORGTBL salesfigures
13650 % END RECEIVE ORGTBL salesfigures
13652 #+ORGTBL: SEND salesfigures orgtbl-to-latex
13658 @vindex @LaTeX{}-verbatim-environments
13659 The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
13660 @code{orgtbl-to-latex} to convert the table into @LaTeX{} and to put it
13661 into the receiver location with name @code{salesfigures}. You may now
13662 fill in the table---feel free to use the spreadsheet features@footnote{If
13663 the @samp{#+TBLFM} line contains an odd number of dollar characters,
13664 this may cause problems with font-lock in @LaTeX{} mode. As shown in the
13665 example you can fix this by adding an extra line inside the
13666 @code{comment} environment that is used to balance the dollar
13667 expressions. If you are using AUC@TeX{} with the font-latex library, a
13668 much better solution is to add the @code{comment} environment to the
13669 variable @code{LaTeX-verbatim-environments}.}:
13672 % BEGIN RECEIVE ORGTBL salesfigures
13673 % END RECEIVE ORGTBL salesfigures
13675 #+ORGTBL: SEND salesfigures orgtbl-to-latex
13676 | Month | Days | Nr sold | per day |
13677 |-------+------+---------+---------|
13678 | Jan | 23 | 55 | 2.4 |
13679 | Feb | 21 | 16 | 0.8 |
13680 | March | 22 | 278 | 12.6 |
13681 #+TBLFM: $4=$3/$2;%.1f
13682 % $ (optional extra dollar to keep font-lock happy, see footnote)
13687 When you are done, press @kbd{C-c C-c} in the table to get the converted
13688 table inserted between the two marker lines.
13690 Now let's assume you want to make the table header by hand, because you
13691 want to control how columns are aligned, etc@. In this case we make sure
13692 that the table translator skips the first 2 lines of the source
13693 table, and tell the command to work as a @i{splice}, i.e. to not produce
13694 header and footer commands of the target table:
13697 \begin@{tabular@}@{lrrr@}
13698 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
13699 % BEGIN RECEIVE ORGTBL salesfigures
13700 % END RECEIVE ORGTBL salesfigures
13704 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
13705 | Month | Days | Nr sold | per day |
13706 |-------+------+---------+---------|
13707 | Jan | 23 | 55 | 2.4 |
13708 | Feb | 21 | 16 | 0.8 |
13709 | March | 22 | 278 | 12.6 |
13710 #+TBLFM: $4=$3/$2;%.1f
13714 The @LaTeX{} translator function @code{orgtbl-to-latex} is already part of
13715 Orgtbl mode. It uses a @code{tabular} environment to typeset the table
13716 and marks horizontal lines with @code{\hline}. Furthermore, it
13717 interprets the following parameters (see also @pxref{Translator functions}):
13720 @item :splice nil/t
13721 When set to t, return only table body lines, don't wrap them into a
13722 tabular environment. Default is nil.
13725 A format to be used to wrap each field, it should contain @code{%s} for the
13726 original field value. For example, to wrap each field value in dollars,
13727 you could use @code{:fmt "$%s$"}. This may also be a property list with
13728 column numbers and formats. for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
13729 A function of one argument can be used in place of the strings; the
13730 function must return a formatted string.
13733 Use this format to print numbers with exponentials. The format should
13734 have @code{%s} twice for inserting mantissa and exponent, for example
13735 @code{"%s\\times10^@{%s@}"}. The default is @code{"%s\\,(%s)"}. This
13736 may also be a property list with column numbers and formats, for example
13737 @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After
13738 @code{efmt} has been applied to a value, @code{fmt} will also be
13739 applied. Similar to @code{fmt}, functions of two arguments can be
13740 supplied instead of strings.
13743 @node Translator functions, Radio lists, A LaTeX example, Tables in arbitrary syntax
13744 @subsection Translator functions
13745 @cindex HTML, and Orgtbl mode
13746 @cindex translator function
13748 Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
13749 (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
13750 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and @code{orgtbl-to-texinfo}.
13751 Except for @code{orgtbl-to-html}@footnote{The HTML translator uses the same
13752 code that produces tables during HTML export.}, these all use a generic
13753 translator, @code{orgtbl-to-generic}. For example, @code{orgtbl-to-latex}
13754 itself is a very short function that computes the column definitions for the
13755 @code{tabular} environment, defines a few field and line separators and then
13756 hands processing over to the generic translator. Here is the entire code:
13760 (defun orgtbl-to-latex (table params)
13761 "Convert the Orgtbl mode TABLE to LaTeX."
13762 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
13763 org-table-last-alignment ""))
13766 :tstart (concat "\\begin@{tabular@}@{" alignment "@}")
13767 :tend "\\end@{tabular@}"
13768 :lstart "" :lend " \\\\" :sep " & "
13769 :efmt "%s\\,(%s)" :hline "\\hline")))
13770 (orgtbl-to-generic table (org-combine-plists params2 params))))
13774 As you can see, the properties passed into the function (variable
13775 @var{PARAMS}) are combined with the ones newly defined in the function
13776 (variable @var{PARAMS2}). The ones passed into the function (i.e. the
13777 ones set by the @samp{ORGTBL SEND} line) take precedence. So if you
13778 would like to use the @LaTeX{} translator, but wanted the line endings to
13779 be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
13780 overrule the default with
13783 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
13786 For a new language, you can either write your own converter function in
13787 analogy with the @LaTeX{} translator, or you can use the generic function
13788 directly. For example, if you have a language where a table is started
13789 with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are
13790 started with @samp{!BL!}, ended with @samp{!EL!}, and where the field
13791 separator is a TAB, you could call the generic translator like this (on
13795 #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
13796 :lstart "!BL! " :lend " !EL!" :sep "\t"
13800 Please check the documentation string of the function
13801 @code{orgtbl-to-generic} for a full list of parameters understood by
13802 that function, and remember that you can pass each of them into
13803 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
13804 using the generic function.
13806 Of course you can also write a completely new function doing complicated
13807 things the generic translator cannot do. A translator function takes
13808 two arguments. The first argument is the table, a list of lines, each
13809 line either the symbol @code{hline} or a list of fields. The second
13810 argument is the property list containing all parameters specified in the
13811 @samp{#+ORGTBL: SEND} line. The function must return a single string
13812 containing the formatted table. If you write a generally useful
13813 translator, please post it on @email{emacs-orgmode@@gnu.org} so that
13814 others can benefit from your work.
13816 @node Radio lists, , Translator functions, Tables in arbitrary syntax
13817 @subsection Radio lists
13818 @cindex radio lists
13819 @cindex org-list-insert-radio-list
13821 Sending and receiving radio lists works exactly the same way as sending and
13822 receiving radio tables (@pxref{Radio tables}). As for radio tables, you can
13823 insert radio list templates in HTML, @LaTeX{} and Texinfo modes by calling
13824 @code{org-list-insert-radio-list}.
13826 Here are the differences with radio tables:
13830 Orgstruct mode must be active.
13832 Use the @code{ORGLST} keyword instead of @code{ORGTBL}.
13834 The available translation functions for radio lists don't take
13837 @kbd{C-c C-c} will work when pressed on the first item of the list.
13840 Here is a @LaTeX{} example. Let's say that you have this in your
13845 % BEGIN RECEIVE ORGLST to-buy
13846 % END RECEIVE ORGLST to-buy
13848 #+ORGLST: SEND to-buy org-list-to-latex
13857 Pressing `C-c C-c' on @code{a new house} and will insert the converted
13858 @LaTeX{} list between the two marker lines.
13860 @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Hacking
13861 @section Dynamic blocks
13862 @cindex dynamic blocks
13864 Org documents can contain @emph{dynamic blocks}. These are
13865 specially marked regions that are updated by some user-written function.
13866 A good example for such a block is the clock table inserted by the
13867 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
13869 Dynamic blocks are enclosed by a BEGIN-END structure that assigns a name
13870 to the block and can also specify parameters for the function producing
13871 the content of the block.
13873 @cindex #+BEGIN:dynamic block
13875 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
13880 Dynamic blocks are updated with the following commands
13883 @orgcmd{C-c C-x C-u,org-dblock-update}
13884 Update dynamic block at point.
13885 @orgkey{C-u C-c C-x C-u}
13886 Update all dynamic blocks in the current file.
13889 Updating a dynamic block means to remove all the text between BEGIN and
13890 END, parse the BEGIN line for parameters and then call the specific
13891 writer function for this block to insert the new content. If you want
13892 to use the original content in the writer function, you can use the
13893 extra parameter @code{:content}.
13895 For a block with name @code{myblock}, the writer function is
13896 @code{org-dblock-write:myblock} with as only parameter a property list
13897 with the parameters given in the begin line. Here is a trivial example
13898 of a block that keeps track of when the block update function was last
13902 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
13908 The corresponding block writer function could look like this:
13911 (defun org-dblock-write:block-update-time (params)
13912 (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
13913 (insert "Last block update at: "
13914 (format-time-string fmt (current-time)))))
13917 If you want to make sure that all dynamic blocks are always up-to-date,
13918 you could add the function @code{org-update-all-dblocks} to a hook, for
13919 example @code{before-save-hook}. @code{org-update-all-dblocks} is
13920 written in a way such that it does nothing in buffers that are not in
13923 @node Special agenda views, Extracting agenda information, Dynamic blocks, Hacking
13924 @section Special agenda views
13925 @cindex agenda views, user-defined
13927 Org provides a special hook that can be used to narrow down the selection
13928 made by these agenda views: @code{todo}, @code{alltodo}, @code{tags}, @code{tags-todo},
13929 @code{tags-tree}. You may specify a function that is used at each match to verify
13930 if the match should indeed be part of the agenda view, and if not, how
13931 much should be skipped.
13933 Let's say you want to produce a list of projects that contain a WAITING
13934 tag anywhere in the project tree. Let's further assume that you have
13935 marked all tree headings that define a project with the TODO keyword
13936 PROJECT. In this case you would run a TODO search for the keyword
13937 PROJECT, but skip the match unless there is a WAITING tag anywhere in
13938 the subtree belonging to the project line.
13940 To achieve this, you must write a function that searches the subtree for
13941 the tag. If the tag is found, the function must return @code{nil} to
13942 indicate that this match should not be skipped. If there is no such
13943 tag, return the location of the end of the subtree, to indicate that
13944 search should continue from there.
13947 (defun my-skip-unless-waiting ()
13948 "Skip trees that are not waiting"
13949 (let ((subtree-end (save-excursion (org-end-of-subtree t))))
13950 (if (re-search-forward ":waiting:" subtree-end t)
13951 nil ; tag found, do not skip
13952 subtree-end))) ; tag not found, continue after end of subtree
13955 Now you may use this function in an agenda custom command, for example
13959 (org-add-agenda-custom-command
13960 '("b" todo "PROJECT"
13961 ((org-agenda-skip-function 'my-skip-unless-waiting)
13962 (org-agenda-overriding-header "Projects waiting for something: "))))
13965 @vindex org-agenda-overriding-header
13966 Note that this also binds @code{org-agenda-overriding-header} to get a
13967 meaningful header in the agenda view.
13969 @vindex org-odd-levels-only
13970 @vindex org-agenda-skip-function
13971 A general way to create custom searches is to base them on a search for
13972 entries with a certain level limit. If you want to study all entries with
13973 your custom search function, simply do a search for
13974 @samp{LEVEL>0}@footnote{Note that, when using @code{org-odd-levels-only}, a
13975 level number corresponds to order in the hierarchy, not to the number of
13976 stars.}, and then use @code{org-agenda-skip-function} to select the entries
13977 you really want to have.
13979 You may also put a Lisp form into @code{org-agenda-skip-function}. In
13980 particular, you may use the functions @code{org-agenda-skip-entry-if}
13981 and @code{org-agenda-skip-subtree-if} in this form, for example:
13984 @item '(org-agenda-skip-entry-if 'scheduled)
13985 Skip current entry if it has been scheduled.
13986 @item '(org-agenda-skip-entry-if 'notscheduled)
13987 Skip current entry if it has not been scheduled.
13988 @item '(org-agenda-skip-entry-if 'deadline)
13989 Skip current entry if it has a deadline.
13990 @item '(org-agenda-skip-entry-if 'scheduled 'deadline)
13991 Skip current entry if it has a deadline, or if it is scheduled.
13992 @item '(org-agenda-skip-entry-if 'todo '("TODO" "WAITING"))
13993 Skip current entry if the TODO keyword is TODO or WAITING.
13994 @item '(org-agenda-skip-entry-if 'todo 'done)
13995 Skip current entry if the TODO keyword marks a DONE state.
13996 @item '(org-agenda-skip-entry-if 'timestamp)
13997 Skip current entry if it has any timestamp, may also be deadline or scheduled.
13998 @item '(org-agenda-skip-entry 'regexp "regular expression")
13999 Skip current entry if the regular expression matches in the entry.
14000 @item '(org-agenda-skip-entry 'notregexp "regular expression")
14001 Skip current entry unless the regular expression matches.
14002 @item '(org-agenda-skip-subtree-if 'regexp "regular expression")
14003 Same as above, but check and skip the entire subtree.
14006 Therefore we could also have written the search for WAITING projects
14007 like this, even without defining a special function:
14010 (org-add-agenda-custom-command
14011 '("b" todo "PROJECT"
14012 ((org-agenda-skip-function '(org-agenda-skip-subtree-if
14013 'regexp ":waiting:"))
14014 (org-agenda-overriding-header "Projects waiting for something: "))))
14017 @node Extracting agenda information, Using the property API, Special agenda views, Hacking
14018 @section Extracting agenda information
14019 @cindex agenda, pipe
14020 @cindex Scripts, for agenda processing
14022 @vindex org-agenda-custom-commands
14023 Org provides commands to access agenda information for the command
14024 line in Emacs batch mode. This extracted information can be sent
14025 directly to a printer, or it can be read by a program that does further
14026 processing of the data. The first of these commands is the function
14027 @code{org-batch-agenda}, that produces an agenda view and sends it as
14028 ASCII text to STDOUT. The command takes a single string as parameter.
14029 If the string has length 1, it is used as a key to one of the commands
14030 you have configured in @code{org-agenda-custom-commands}, basically any
14031 key you can use after @kbd{C-c a}. For example, to directly print the
14032 current TODO list, you could use
14035 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
14038 If the parameter is a string with 2 or more characters, it is used as a
14039 tags/TODO match string. For example, to print your local shopping list
14040 (all items with the tag @samp{shop}, but excluding the tag
14041 @samp{NewYork}), you could use
14044 emacs -batch -l ~/.emacs \
14045 -eval '(org-batch-agenda "+shop-NewYork")' | lpr
14049 You may also modify parameters on the fly like this:
14052 emacs -batch -l ~/.emacs \
14053 -eval '(org-batch-agenda "a" \
14054 org-agenda-span month \
14055 org-agenda-include-diary nil \
14056 org-agenda-files (quote ("~/org/project.org")))' \
14061 which will produce a 30-day agenda, fully restricted to the Org file
14062 @file{~/org/projects.org}, not even including the diary.
14064 If you want to process the agenda data in more sophisticated ways, you
14065 can use the command @code{org-batch-agenda-csv} to get a comma-separated
14066 list of values for each agenda item. Each line in the output will
14067 contain a number of fields separated by commas. The fields in a line
14071 category @r{The category of the item}
14072 head @r{The headline, without TODO keyword, TAGS and PRIORITY}
14073 type @r{The type of the agenda entry, can be}
14074 todo @r{selected in TODO match}
14075 tagsmatch @r{selected in tags match}
14076 diary @r{imported from diary}
14077 deadline @r{a deadline}
14078 scheduled @r{scheduled}
14079 timestamp @r{appointment, selected by timestamp}
14080 closed @r{entry was closed on date}
14081 upcoming-deadline @r{warning about nearing deadline}
14082 past-scheduled @r{forwarded scheduled item}
14083 block @r{entry has date block including date}
14084 todo @r{The TODO keyword, if any}
14085 tags @r{All tags including inherited ones, separated by colons}
14086 date @r{The relevant date, like 2007-2-14}
14087 time @r{The time, like 15:00-16:50}
14088 extra @r{String with extra planning info}
14089 priority-l @r{The priority letter if any was given}
14090 priority-n @r{The computed numerical priority}
14094 Time and date will only be given if a timestamp (or deadline/scheduled)
14095 led to the selection of the item.
14097 A CSV list like this is very easy to use in a post-processing script.
14098 For example, here is a Perl program that gets the TODO list from
14099 Emacs/Org and prints all the items, preceded by a checkbox:
14104 # define the Emacs command to run
14105 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
14107 # run it and capture the output
14108 $agenda = qx@{$cmd 2>/dev/null@};
14110 # loop over all lines
14111 foreach $line (split(/\n/,$agenda)) @{
14112 # get the individual values
14113 ($category,$head,$type,$todo,$tags,$date,$time,$extra,
14114 $priority_l,$priority_n) = split(/,/,$line);
14115 # process and print
14116 print "[ ] $head\n";
14120 @node Using the property API, Using the mapping API, Extracting agenda information, Hacking
14121 @section Using the property API
14122 @cindex API, for properties
14123 @cindex properties, API
14125 Here is a description of the functions that can be used to work with
14128 @defun org-entry-properties &optional pom which
14129 Get all properties of the entry at point-or-marker POM.@*
14130 This includes the TODO keyword, the tags, time strings for deadline,
14131 scheduled, and clocking, and any additional properties defined in the
14132 entry. The return value is an alist. Keys may occur multiple times
14133 if the property key was used several times.@*
14134 POM may also be nil, in which case the current entry is used.
14135 If WHICH is nil or `all', get all properties. If WHICH is
14136 `special' or `standard', only get that subclass.
14138 @vindex org-use-property-inheritance
14139 @defun org-entry-get pom property &optional inherit
14140 Get value of PROPERTY for entry at point-or-marker POM. By default,
14141 this only looks at properties defined locally in the entry. If INHERIT
14142 is non-nil and the entry does not have the property, then also check
14143 higher levels of the hierarchy. If INHERIT is the symbol
14144 @code{selective}, use inheritance if and only if the setting of
14145 @code{org-use-property-inheritance} selects PROPERTY for inheritance.
14148 @defun org-entry-delete pom property
14149 Delete the property PROPERTY from entry at point-or-marker POM.
14152 @defun org-entry-put pom property value
14153 Set PROPERTY to VALUE for entry at point-or-marker POM.
14156 @defun org-buffer-property-keys &optional include-specials
14157 Get all property keys in the current buffer.
14160 @defun org-insert-property-drawer
14161 Insert a property drawer at point.
14164 @defun org-entry-put-multivalued-property pom property &rest values
14165 Set PROPERTY at point-or-marker POM to VALUES. VALUES should be a list of
14166 strings. They will be concatenated, with spaces as separators.
14169 @defun org-entry-get-multivalued-property pom property
14170 Treat the value of the property PROPERTY as a whitespace-separated list of
14171 values and return the values as a list of strings.
14174 @defun org-entry-add-to-multivalued-property pom property value
14175 Treat the value of the property PROPERTY as a whitespace-separated list of
14176 values and make sure that VALUE is in this list.
14179 @defun org-entry-remove-from-multivalued-property pom property value
14180 Treat the value of the property PROPERTY as a whitespace-separated list of
14181 values and make sure that VALUE is @emph{not} in this list.
14184 @defun org-entry-member-in-multivalued-property pom property value
14185 Treat the value of the property PROPERTY as a whitespace-separated list of
14186 values and check if VALUE is in this list.
14189 @defopt org-property-allowed-value-functions
14190 Hook for functions supplying allowed values for a specific property.
14191 The functions must take a single argument, the name of the property, and
14192 return a flat list of allowed values. If @samp{:ETC} is one of
14193 the values, use the values as completion help, but allow also other values
14194 to be entered. The functions must return @code{nil} if they are not
14195 responsible for this property.
14198 @node Using the mapping API, , Using the property API, Hacking
14199 @section Using the mapping API
14200 @cindex API, for mapping
14201 @cindex mapping entries, API
14203 Org has sophisticated mapping capabilities to find all entries satisfying
14204 certain criteria. Internally, this functionality is used to produce agenda
14205 views, but there is also an API that can be used to execute arbitrary
14206 functions for each or selected entries. The main entry point for this API
14209 @defun org-map-entries func &optional match scope &rest skip
14210 Call FUNC at each headline selected by MATCH in SCOPE.
14212 FUNC is a function or a Lisp form. The function will be called without
14213 arguments, with the cursor positioned at the beginning of the headline.
14214 The return values of all calls to the function will be collected and
14215 returned as a list.
14217 The call to FUNC will be wrapped into a save-excursion form, so FUNC
14218 does not need to preserve point. After evaluation, the cursor will be
14219 moved to the end of the line (presumably of the headline of the
14220 processed entry) and search continues from there. Under some
14221 circumstances, this may not produce the wanted results. For example,
14222 if you have removed (e.g. archived) the current (sub)tree it could
14223 mean that the next entry will be skipped entirely. In such cases, you
14224 can specify the position from where search should continue by making
14225 FUNC set the variable `org-map-continue-from' to the desired buffer
14228 MATCH is a tags/property/todo match as it is used in the agenda match view.
14229 Only headlines that are matched by this query will be considered during
14230 the iteration. When MATCH is nil or t, all headlines will be
14231 visited by the iteration.
14233 SCOPE determines the scope of this command. It can be any of:
14236 nil @r{the current buffer, respecting the restriction if any}
14237 tree @r{the subtree started with the entry at point}
14238 file @r{the current buffer, without restriction}
14240 @r{the current buffer, and any archives associated with it}
14241 agenda @r{all agenda files}
14242 agenda-with-archives
14243 @r{all agenda files with any archive files associated with them}
14245 @r{if this is a list, all files in the list will be scanned}
14248 The remaining args are treated as settings for the skipping facilities of
14249 the scanner. The following items can be given here:
14251 @vindex org-agenda-skip-function
14253 archive @r{skip trees with the archive tag}
14254 comment @r{skip trees with the COMMENT keyword}
14255 function or Lisp form
14256 @r{will be used as value for @code{org-agenda-skip-function},}
14257 @r{so whenever the function returns t, FUNC}
14258 @r{will not be called for that entry and search will}
14259 @r{continue from the point where the function leaves it}
14263 The function given to that mapping routine can really do anything you like.
14264 It can use the property API (@pxref{Using the property API}) to gather more
14265 information about the entry, or in order to change metadata in the entry.
14266 Here are a couple of functions that might be handy:
14268 @defun org-todo &optional arg
14269 Change the TODO state of the entry. See the docstring of the functions for
14270 the many possible values for the argument ARG.
14273 @defun org-priority &optional action
14274 Change the priority of the entry. See the docstring of this function for the
14275 possible values for ACTION.
14278 @defun org-toggle-tag tag &optional onoff
14279 Toggle the tag TAG in the current entry. Setting ONOFF to either @code{on}
14280 or @code{off} will not toggle tag, but ensure that it is either on or off.
14284 Promote the current entry.
14288 Demote the current entry.
14291 Here is a simple example that will turn all entries in the current file with
14292 a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
14293 Entries in comment trees and in archive trees will be ignored.
14297 '(org-todo "UPCOMING")
14298 "+TOMORROW" 'file 'archive 'comment)
14301 The following example counts the number of entries with TODO keyword
14302 @code{WAITING}, in all agenda files.
14305 (length (org-map-entries t "/+WAITING" 'agenda))
14308 @node MobileOrg, History and Acknowledgments, Hacking, Top
14309 @appendix MobileOrg
14313 @uref{http://mobileorg.ncogni.to/, MobileOrg} is an application for the
14314 @i{iPhone/iPod Touch} series of devices, developed by Richard Moreland.
14315 @i{MobileOrg} offers offline viewing and capture support for an Org-mode
14316 system rooted on a ``real'' computer. It does also allow you to record
14317 changes to existing entries. Android users should check out
14318 @uref{http://wiki.github.com/matburt/mobileorg-android/, MobileOrg Android}
14321 This appendix describes the support Org has for creating agenda views in a
14322 format that can be displayed by @i{MobileOrg}, and for integrating notes
14323 captured and changes made by @i{MobileOrg} into the main system.
14325 For changing tags and TODO states in MobileOrg, you should have set up the
14326 customization variables @code{org-todo-keywords} and @code{org-tags-alist} to
14327 cover all important tags and TODO keywords, even if individual files use only
14328 part of these. MobileOrg will also offer you states and tags set up with
14329 in-buffer settings, but it will understand the logistics of TODO state
14330 @i{sets} (@pxref{Per-file keywords}) and @i{mutually exclusive} tags
14331 (@pxref{Setting tags}) only for those set in these variables.
14334 * Setting up the staging area:: Where to interact with the mobile device
14335 * Pushing to MobileOrg:: Uploading Org files and agendas
14336 * Pulling from MobileOrg:: Integrating captured and flagged items
14339 @node Setting up the staging area, Pushing to MobileOrg, MobileOrg, MobileOrg
14340 @section Setting up the staging area
14342 MobileOrg needs to interact with Emacs through a directory on a server. If you
14343 are using a public server, you should consider to encrypt the files that are
14344 uploaded to the server. This can be done with Org-mode 7.02 and with
14345 @i{MobileOrg 1.5} (iPhone version), and you need an @file{openssl}
14346 installation on your system. To turn on encryption, set a password in
14347 @i{MobileOrg} and, on the Emacs side, configure the variable
14348 @code{org-mobile-use-encryption}@footnote{If you can safely store the
14349 password in your Emacs setup, you might also want to configure
14350 @code{org-mobile-encryption-password}. Please read the docstring of that
14351 variable. Note that encryption will apply only to the contents of the
14352 @file{.org} files. The file names themselves will remain visible.}.
14354 The easiest way to create that directory is to use a free
14355 @uref{http://dropbox.com,Dropbox.com} account@footnote{If you cannot use
14356 Dropbox, or if your version of MobileOrg does not support it, you can use a
14357 webdav server. For more information, check out the documentation of MobileOrg and also this
14358 @uref{http://orgmode.org/worg/org-faq.php#mobileorg_webdav, FAQ entry}.}.
14359 When MobileOrg first connects to your Dropbox, it will create a directory
14360 @i{MobileOrg} inside the Dropbox. After the directory has been created, tell
14364 (setq org-mobile-directory "~/Dropbox/MobileOrg")
14367 Org-mode has commands to put files for @i{MobileOrg} into that directory,
14368 and to read captured notes from there.
14370 @node Pushing to MobileOrg, Pulling from MobileOrg, Setting up the staging area, MobileOrg
14371 @section Pushing to MobileOrg
14373 This operation copies all files currently listed in @code{org-mobile-files}
14374 to the directory @code{org-mobile-directory}. By default this list contains
14375 all agenda files (as listed in @code{org-agenda-files}), but additional files
14376 can be included by customizing @code{org-mobiles-files}. File names will be
14377 staged with paths relative to @code{org-directory}, so all files should be
14378 inside this directory. The push operation also creates a special Org file
14379 @file{agendas.org} with all custom agenda view defined by the
14380 user@footnote{While creating the agendas, Org-mode will force ID properties
14381 on all referenced entries, so that these entries can be uniquely identified
14382 if @i{MobileOrg} flags them for further action. If you do not want to get
14383 these properties in so many entries, you can set the variable
14384 @code{org-mobile-force-id-on-agenda-items} to @code{nil}. Org mode will then
14385 rely on outline paths, in the hope that these will be unique enough.}.
14386 Finally, Org writes the file @file{index.org}, containing links to all other
14387 files. @i{MobileOrg} first reads this file from the server, and then
14388 downloads all agendas and Org files listed in it. To speed up the download,
14389 MobileOrg will only read files whose checksums@footnote{stored automatically
14390 in the file @file{checksums.dat}} have changed.
14392 @node Pulling from MobileOrg, , Pushing to MobileOrg, MobileOrg
14393 @section Pulling from MobileOrg
14395 When @i{MobileOrg} synchronizes with the server, it not only pulls the Org
14396 files for viewing. It also appends captured entries and pointers to flagged
14397 and changed entries to the file @file{mobileorg.org} on the server. Org has
14398 a @emph{pull} operation that integrates this information into an inbox file
14399 and operates on the pointers to flagged entries. Here is how it works:
14403 Org moves all entries found in
14404 @file{mobileorg.org}@footnote{@file{mobileorg.org} will be empty after this
14405 operation.} and appends them to the file pointed to by the variable
14406 @code{org-mobile-inbox-for-pull}. Each captured entry and each editing event
14407 will be a top-level entry in the inbox file.
14409 After moving the entries, Org will attempt to implement the changes made in
14410 @i{MobileOrg}. Some changes are applied directly and without user
14411 interaction. Examples are all changes to tags, TODO state, headline and body
14412 text that can be cleanly applied. Entries that have been flagged for further
14413 action will receive a tag @code{:FLAGGED:}, so that they can be easily found
14414 again. When there is a problem finding an entry or applying the change, the
14415 pointer entry will remain in the inbox and will be marked with an error
14416 message. You need to later resolve these issues by hand.
14418 Org will then generate an agenda view with all flagged entries. The user
14419 should then go through these entries and do whatever actions are necessary.
14420 If a note has been stored while flagging an entry in @i{MobileOrg}, that note
14421 will be displayed in the echo area when the cursor is on the corresponding
14426 Pressing @kbd{?} in that special agenda will display the full flagging note in
14427 another window and also push it onto the kill ring. So you could use @kbd{?
14428 z C-y C-c C-c} to store that flagging note as a normal note in the entry.
14429 Pressing @kbd{?} twice in succession will offer to remove the
14430 @code{:FLAGGED:} tag along with the recorded flagging note (which is stored
14431 in a property). In this way you indicate that the intended processing for
14432 this flagged entry is finished.
14437 If you are not able to process all flagged entries directly, you can always
14438 return to this agenda view@footnote{Note, however, that there is a subtle
14439 difference. The view created automatically by @kbd{M-x org-mobile-pull
14440 @key{RET}} is guaranteed to search all files that have been addressed by the
14441 last pull. This might include a file that is not currently in your list of
14442 agenda files. If you later use @kbd{C-c a ?} to regenerate the view, only
14443 the current agenda files will be searched.} using @kbd{C-c a ?}.
14445 @node History and Acknowledgments, Main Index, MobileOrg, Top
14446 @appendix History and acknowledgments
14447 @cindex acknowledgments
14451 Org was born in 2003, out of frustration over the user interface of the Emacs
14452 Outline mode. I was trying to organize my notes and projects, and using
14453 Emacs seemed to be the natural way to go. However, having to remember eleven
14454 different commands with two or three keys per command, only to hide and show
14455 parts of the outline tree, that seemed entirely unacceptable to me. Also,
14456 when using outlines to take notes, I constantly wanted to restructure the
14457 tree, organizing it parallel to my thoughts and plans. @emph{Visibility
14458 cycling} and @emph{structure editing} were originally implemented in the
14459 package @file{outline-magic.el}, but quickly moved to the more general
14460 @file{org.el}. As this environment became comfortable for project planning,
14461 the next step was adding @emph{TODO entries}, basic @emph{timestamps}, and
14462 @emph{table support}. These areas highlighted the two main goals that Org
14463 still has today: to be a new, outline-based, plain text mode with innovative
14464 and intuitive editing features, and to incorporate project planning
14465 functionality directly into a notes file.
14467 Since the first release, literally thousands of emails to me or to
14468 @email{emacs-orgmode@@gnu.org} have provided a constant stream of bug
14469 reports, feedback, new ideas, and sometimes patches and add-on code.
14470 Many thanks to everyone who has helped to improve this package. I am
14471 trying to keep here a list of the people who had significant influence
14472 in shaping one or more aspects of Org. The list may not be
14473 complete, if I have forgotten someone, please accept my apologies and
14476 Before I get to this list, a few special mentions are in order:
14479 @item Bastien Guerry
14480 Bastien has written a large number of extensions to Org (most of them
14481 integrated into the core by now), including the LaTeX exporter and the plain
14482 list parser. His support during the early days, when he basically acted as
14483 co-maintainer, was central to the success of this project. Bastien also
14484 invented Worg, helped establishing the Web presence of Org, and sponsors
14485 hosting costs for the orgmode.org website.
14486 @item Eric Schulte and Dan Davison
14487 Eric and Dan are jointly responsible for the Org-babel system, which turns
14488 Org into a multi-language environment for evaluating code and doing literate
14489 programming and reproducible research.
14491 John has contributed a number of great ideas and patches directly to Org,
14492 including the attachment system (@file{org-attach.el}), integration with
14493 Apple Mail (@file{org-mac-message.el}), hierarchical dependencies of TODO
14494 items, habit tracking (@file{org-habits.el}), and encryption
14495 (@file{org-crypt.el}). Also, the capture system is really an extended copy
14496 of his great @file{remember.el}.
14497 @item Sebastian Rose
14498 Without Sebastian, the HTML/XHTML publishing of Org would be the pitiful work
14499 of an ignorant amateur. Sebastian has pushed this part of Org onto a much
14500 higher level. He also wrote @file{org-info.js}, a Java script for displaying
14501 webpages derived from Org using an Info-like or a folding interface with
14502 single-key navigation.
14505 @noindent OK, now to the full list of contributions! Again, please let me
14506 know what I am missing here!
14511 @i{Russel Adams} came up with the idea for drawers.
14513 @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
14515 @i{Christophe Bataillon} created the great unicorn logo that we use on the
14518 @i{Alex Bochannek} provided a patch for rounding timestamps.
14520 @i{Jan Böcker} wrote @file{org-docview.el}.
14522 @i{Brad Bozarth} showed how to pull RSS feed data into Org-mode files.
14524 @i{Tom Breton} wrote @file{org-choose.el}.
14526 @i{Charles Cave}'s suggestion sparked the implementation of templates
14527 for Remember, which are now templates for capture.
14529 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
14532 @i{Gregory Chernov} patched support for Lisp forms into table
14533 calculations and improved XEmacs compatibility, in particular by porting
14534 @file{nouline.el} to XEmacs.
14536 @i{Sacha Chua} suggested copying some linking code from Planner.
14538 @i{Baoqiu Cui} contributed the DocBook exporter.
14540 @i{Eddward DeVilla} proposed and tested checkbox statistics. He also
14541 came up with the idea of properties, and that there should be an API for
14544 @i{Nick Dokos} tracked down several nasty bugs.
14546 @i{Kees Dullemond} used to edit projects lists directly in HTML and so
14547 inspired some of the early development, including HTML export. He also
14548 asked for a way to narrow wide table columns.
14550 @i{Thomas S. Dye} contributed documentation on Worg and helped integrating
14551 the Org-Babel documentation into the manual.
14553 @i{Christian Egli} converted the documentation into Texinfo format, inspired
14554 the agenda, patched CSS formatting into the HTML exporter, and wrote
14555 @file{org-taskjuggler.el}.
14557 @i{David Emery} provided a patch for custom CSS support in exported
14560 @i{Nic Ferrier} contributed mailcap and XOXO support.
14562 @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
14564 @i{John Foerch} figured out how to make incremental search show context
14565 around a match in a hidden outline tree.
14567 @i{Raimar Finken} wrote @file{org-git-line.el}.
14569 @i{Mikael Fornius} works as a mailing list moderator.
14571 @i{Austin Frank} works as a mailing list moderator.
14573 @i{Eric Fraga} drove the development of BEAMER export with ideas and
14576 @i{Barry Gidden} did proofreading the manual in preparation for the book
14577 publication through Network Theory Ltd.
14579 @i{Niels Giesen} had the idea to automatically archive DONE trees.
14581 @i{Nicolas Goaziou} rewrote much of the plain list code.
14583 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
14585 @i{Brian Gough} of Network Theory Ltd publishes the Org mode manual as a
14588 @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
14589 task state change logging, and the clocktable. His clear explanations have
14590 been critical when we started to adopt the Git version control system.
14592 @i{Manuel Hermenegildo} has contributed various ideas, small fixes and
14595 @i{Phil Jackson} wrote @file{org-irc.el}.
14597 @i{Scott Jaderholm} proposed footnotes, control over whitespace between
14598 folded entries, and column view for properties.
14600 @i{Matt Jones} wrote @i{MobileOrg Android}.
14602 @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
14604 @i{Shidai Liu} ("Leo") asked for embedded @LaTeX{} and tested it. He also
14605 provided frequent feedback and some patches.
14607 @i{Matt Lundin} has proposed last-row references for table formulas and named
14608 invisible anchors. He has also worked a lot on the FAQ.
14610 @i{David Maus} wrote @file{org-atom.el}, maintains the issues file for Org,
14611 and is a prolific contributor on the mailing list with competent replies,
14612 small fixes and patches.
14614 @i{Jason F. McBrayer} suggested agenda export to CSV format.
14616 @i{Max Mikhanosha} came up with the idea of refiling.
14618 @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
14621 @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
14624 @i{Richard Moreland} wrote @i{MobileOrg} for the iPhone.
14626 @i{Rick Moynihan} proposed allowing multiple TODO sequences in a file
14627 and being able to quickly restrict the agenda to a subtree.
14629 @i{Todd Neal} provided patches for links to Info files and Elisp forms.
14631 @i{Greg Newman} refreshed the unicorn logo into its current form.
14633 @i{Tim O'Callaghan} suggested in-file links, search options for general
14634 file links, and TAGS.
14636 @i{Osamu Okano} wrote @file{orgcard2ref.pl}, a Perl program to create a text
14637 version of the reference card.
14639 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
14642 @i{Oliver Oppitz} suggested multi-state TODO items.
14644 @i{Scott Otterson} sparked the introduction of descriptive text for
14645 links, among other things.
14647 @i{Pete Phillips} helped during the development of the TAGS feature, and
14648 provided frequent feedback.
14650 @i{Martin Pohlack} provided the code snippet to bundle character insertion
14651 into bundles of 20 for undo.
14653 @i{T.V. Raman} reported bugs and suggested improvements.
14655 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
14658 @i{Paul Rivier} provided the basic implementation of named footnotes. He
14659 also acted as mailing list moderator for some time.
14661 @i{Kevin Rogers} contributed code to access VM files on remote hosts.
14663 @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
14664 conflict with @file{allout.el}.
14666 @i{Jason Riedy} generalized the send-receive mechanism for Orgtbl tables with
14669 @i{Philip Rooke} created the Org reference card, provided lots
14670 of feedback, developed and applied standards to the Org documentation.
14672 @i{Christian Schlauer} proposed angular brackets around links, among
14675 @i{Paul Sexton} wrote @file{org-ctags.el}.
14677 Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
14678 @file{organizer-mode.el}.
14680 @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal
14681 examples, and remote highlighting for referenced code lines.
14683 @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
14684 now packaged into Org's @file{contrib} directory.
14686 @i{Daniel Sinder} came up with the idea of internal archiving by locking
14689 @i{Dale Smith} proposed link abbreviations.
14691 @i{James TD Smith} has contributed a large number of patches for useful
14692 tweaks and features.
14694 @i{Adam Spiers} asked for global linking commands, inspired the link
14695 extension system, added support for mairix, and proposed the mapping API.
14697 @i{Ulf Stegemann} created the table to translate special symbols to HTML,
14698 LaTeX, UTF-8, Latin-1 and ASCII.
14700 @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content
14701 with links transformation to Org syntax.
14703 @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
14704 chapter about publishing.
14706 @i{Sebastien Vauban} reported many issues with LaTeX and BEAMER export and
14707 enabled source code highlighling in Gnus.
14709 @i{Stefan Vollmar} organized a video-recorded talk at the
14710 Max-Planck-Institute for Neurology. He also inspired the creation of a
14711 concept index for HTML export.
14713 @i{J@"urgen Vollmer} contributed code generating the table of contents
14716 @i{Samuel Wales} has provided important feedback and bug reports.
14718 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
14721 @i{David Wainberg} suggested archiving, and improvements to the linking
14724 @i{Carsten Wimmer} suggested some changes and helped fix a bug in
14727 @i{Roland Winkler} requested additional key bindings to make Org
14730 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
14731 and contributed various ideas and code snippets.
14735 @node Main Index, Key Index, History and Acknowledgments, Top
14736 @unnumbered Concept index
14740 @node Key Index, Command and Function Index, Main Index, Top
14741 @unnumbered Key index
14745 @node Command and Function Index, Variable Index, Key Index, Top
14746 @unnumbered Command and function index
14750 @node Variable Index, , Command and Function Index, Top
14751 @unnumbered Variable index
14753 This is not a complete index of variables and faces, only the ones that are
14754 mentioned in the manual. For a more complete list, use @kbd{M-x
14755 org-customize @key{RET}} and then click yourself through the tree.
14761 @c Local variables:
14763 @c indent-tabs-mode: nil
14764 @c paragraph-start: "
\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|\f\\|[ ]*$"
14765 @c paragraph-separate: "
\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|[ \f]*$"
14769 @c LocalWords: webdavhost pre