4 @setfilename ../../info/org
5 @settitle The Org Manual
10 @c Use proper quote and backtick for code sections in PDF output
11 @c Cf. Texinfo manual 14.2
12 @set txicodequoteundirected
13 @set txicodequotebacktick
15 @c Version and Contact Info
16 @set MAINTAINERSITE @uref{http://orgmode.org,maintainers webpage}
17 @set AUTHOR Carsten Dominik
18 @set MAINTAINER Carsten Dominik
19 @set MAINTAINEREMAIL @email{carsten at orgmode dot org}
20 @set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer}
26 @c @hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed}
41 @c Subheadings inside a table.
42 @macro tsubheading{text}
52 This manual is for Org version @value{VERSION}.
54 Copyright @copyright{} 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation
57 Permission is granted to copy, distribute and/or modify this document
58 under the terms of the GNU Free Documentation License, Version 1.3 or
59 any later version published by the Free Software Foundation; with no
60 Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
61 and with the Back-Cover Texts as in (a) below. A copy of the license
62 is included in the section entitled ``GNU Free Documentation License.''
64 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
65 modify this GNU manual. Buying copies from the FSF supports it in
66 developing GNU and promoting software freedom.''
68 This document is part of a collection distributed under the GNU Free
69 Documentation License. If you want to distribute this document
70 separately from the collection, you can do so by adding a copy of the
71 license to the document, as described in section 6 of the license.
77 * Org Mode: (org). Outline-based notes management and organizer
83 @subtitle Release @value{VERSION}
84 @author by Carsten Dominik
85 with contributions by David O'Toole, Bastien Guerry, Philip Rooke, Dan Davison, Eric Schulte, and Thomas Dye
87 @c The following two commands start the copyright page.
89 @vskip 0pt plus 1filll
93 @c Output the table of contents at the beginning.
97 @node Top, Introduction, (dir), (dir)
104 * Introduction:: Getting started
105 * Document Structure:: A tree works like your brain
106 * Tables:: Pure magic for quick formatting
107 * Hyperlinks:: Notes in context
108 * TODO Items:: Every tree branch can be a TODO item
109 * Tags:: Tagging headlines and matching sets of tags
110 * Properties and Columns:: Storing information about an entry
111 * Dates and Times:: Making items useful for planning
112 * Capture - Refile - Archive:: The ins and outs for projects
113 * Agenda Views:: Collecting information into views
114 * Markup:: Prepare text for rich export
115 * Exporting:: Sharing and publishing of notes
116 * Publishing:: Create a web site of linked Org files
117 * Working With Source Code:: Export, evaluate, and tangle code blocks
118 * Miscellaneous:: All the rest which did not fit elsewhere
119 * Hacking:: How to hack your way around
120 * MobileOrg:: Viewing and capture on a mobile device
121 * History and Acknowledgments:: How Org came into being
122 * Main Index:: An index of Org's concepts and features
123 * Key Index:: Key bindings and where they are described
124 * Variable Index:: Variables mentioned in the manual
127 --- The Detailed Node Listing ---
131 * Summary:: Brief summary of what Org does
132 * Installation:: How to install a downloaded version of Org
133 * Activation:: How to activate Org for certain buffers
134 * Feedback:: Bug reports, ideas, patches etc.
135 * Conventions:: Type-setting conventions in the manual
139 * Outlines:: Org is based on Outline mode
140 * Headlines:: How to typeset Org tree headlines
141 * Visibility cycling:: Show and hide, much simplified
142 * Motion:: Jumping to other headlines
143 * Structure editing:: Changing sequence and level of headlines
144 * Sparse trees:: Matches embedded in context
145 * Plain lists:: Additional structure within an entry
146 * Drawers:: Tucking stuff away
147 * Blocks:: Folding blocks
148 * Footnotes:: How footnotes are defined in Org's syntax
149 * Orgstruct mode:: Structure editing outside Org
153 * Built-in table editor:: Simple tables
154 * Column width and alignment:: Overrule the automatic settings
155 * Column groups:: Grouping to trigger vertical lines
156 * Orgtbl mode:: The table editor as minor mode
157 * The spreadsheet:: The table editor has spreadsheet capabilities
158 * Org-Plot:: Plotting from org tables
162 * References:: How to refer to another field or range
163 * Formula syntax for Calc:: Using Calc to compute stuff
164 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
165 * Field formulas:: Formulas valid for a single field
166 * Column formulas:: Formulas valid for an entire column
167 * Editing and debugging formulas:: Fixing formulas
168 * Updating the table:: Recomputing all dependent fields
169 * Advanced features:: Field names, parameters and automatic recalc
173 * Link format:: How links in Org are formatted
174 * Internal links:: Links to other places in the current file
175 * External links:: URL-like links to the world
176 * Handling links:: Creating, inserting and following
177 * Using links outside Org:: Linking from my C source code?
178 * Link abbreviations:: Shortcuts for writing complex links
179 * Search options:: Linking to a specific location
180 * Custom searches:: When the default search is not enough
184 * Radio targets:: Make targets trigger links in plain text
188 * TODO basics:: Marking and displaying TODO entries
189 * TODO extensions:: Workflow and assignments
190 * Progress logging:: Dates and notes for progress
191 * Priorities:: Some things are more important than others
192 * Breaking down tasks:: Splitting a task into manageable pieces
193 * Checkboxes:: Tick-off lists
195 Extended use of TODO keywords
197 * Workflow states:: From TODO to DONE in steps
198 * TODO types:: I do this, Fred does the rest
199 * Multiple sets in one file:: Mixing it all, and still finding your way
200 * Fast access to TODO states:: Single letter selection of a state
201 * Per-file keywords:: Different files, different requirements
202 * Faces for TODO keywords:: Highlighting states
203 * TODO dependencies:: When one task needs to wait for others
207 * Closing items:: When was this entry marked DONE?
208 * Tracking TODO state changes:: When did the status change?
209 * Tracking your habits:: How consistent have you been?
213 * Tag inheritance:: Tags use the tree structure of the outline
214 * Setting tags:: How to assign tags to a headline
215 * Tag searches:: Searching for combinations of tags
217 Properties and columns
219 * Property syntax:: How properties are spelled out
220 * Special properties:: Access to other Org-mode features
221 * Property searches:: Matching property values
222 * Property inheritance:: Passing values down the tree
223 * Column view:: Tabular viewing and editing
224 * Property API:: Properties for Lisp programmers
228 * Defining columns:: The COLUMNS format property
229 * Using column view:: How to create and use column view
230 * Capturing column view:: A dynamic block for column view
234 * Scope of column definitions:: Where defined, where valid?
235 * Column attributes:: Appearance and content of a column
239 * Timestamps:: Assigning a time to a tree entry
240 * Creating timestamps:: Commands which insert timestamps
241 * Deadlines and scheduling:: Planning your work
242 * Clocking work time:: Tracking how long you spend on a task
243 * Resolving idle time:: Resolving time if you've been idle
244 * Effort estimates:: Planning work effort in advance
245 * Relative timer:: Notes with a running timer
249 * The date/time prompt:: How Org-mode helps you entering date and time
250 * Custom time format:: Making dates look different
252 Deadlines and scheduling
254 * Inserting deadline/schedule:: Planning items
255 * Repeated tasks:: Items that show up again and again
257 Capture - Refile - Archive
259 * Capture:: Capturing new stuff
260 * Attachments:: Add files to tasks
261 * RSS Feeds:: Getting input from RSS feeds
262 * Protocols:: External (e.g. Browser) access to Emacs and Org
263 * Refiling notes:: Moving a tree from one place to another
264 * Archiving:: What to do with finished projects
268 * Setting up capture:: Where notes will be stored
269 * Using capture:: Commands to invoke and terminate capture
270 * Capture templates:: Define the outline of different note types
274 * Template elements:: What is needed for a complete template entry
275 * Template expansion:: Filling in information about time and context
279 * Moving subtrees:: Moving a tree to an archive file
280 * Internal archiving:: Switch off a tree but keep it in the file
284 * Agenda files:: Files being searched for agenda information
285 * Agenda dispatcher:: Keyboard access to agenda views
286 * Built-in agenda views:: What is available out of the box?
287 * Presentation and sorting:: How agenda items are prepared for display
288 * Agenda commands:: Remote editing of Org trees
289 * Custom agenda views:: Defining special searches and views
290 * Exporting Agenda Views:: Writing a view to a file
291 * Agenda column view:: Using column view for collected entries
293 The built-in agenda views
295 * Weekly/daily agenda:: The calendar page with current tasks
296 * Global TODO list:: All unfinished action items
297 * Matching tags and properties:: Structured information with fine-tuned search
298 * Timeline:: Time-sorted view for single file
299 * Search view:: Find entries by searching for text
300 * Stuck projects:: Find projects you need to review
302 Presentation and sorting
304 * Categories:: Not all tasks are equal
305 * Time-of-day specifications:: How the agenda knows the time
306 * Sorting of agenda items:: The order of things
310 * Storing searches:: Type once, use often
311 * Block agenda:: All the stuff you need in a single buffer
312 * Setting Options:: Changing the rules
314 Markup for rich export
316 * Structural markup elements:: The basic structure as seen by the exporter
317 * Images and tables:: Tables and Images will be included
318 * Literal examples:: Source code examples with special formatting
319 * Include files:: Include additional files into a document
320 * Index entries:: Making an index
321 * Macro replacement:: Use macros to create complex output
322 * Embedded LaTeX:: LaTeX can be freely used inside Org documents
324 Structural markup elements
326 * Document title:: Where the title is taken from
327 * Headings and sections:: The document structure as seen by the exporter
328 * Table of contents:: The if and where of the table of contents
329 * Initial text:: Text before the first heading?
331 * Paragraphs:: Paragraphs
332 * Footnote markup:: Footnotes
333 * Emphasis and monospace:: Bold, italic, etc.
334 * Horizontal rules:: Make a line
335 * Comment lines:: What will *not* be exported
339 * Special symbols:: Greek letters and other symbols
340 * Subscripts and superscripts:: Simple syntax for raising/lowering text
341 * LaTeX fragments:: Complex formulas made easy
342 * Previewing LaTeX fragments:: What will this snippet look like?
343 * CDLaTeX mode:: Speed up entering of formulas
347 * Selective export:: Using tags to select and exclude trees
348 * Export options:: Per-file export settings
349 * The export dispatcher:: How to access exporter commands
350 * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
351 * HTML export:: Exporting to HTML
352 * LaTeX and PDF export:: Exporting to La@TeX{}, and processing to PDF
353 * DocBook export:: Exporting to DocBook
354 * TaskJuggler export:: Exporting to TaskJuggler
355 * Freemind export:: Exporting to Freemind mind maps
356 * XOXO export:: Exporting to XOXO
357 * iCalendar export:: Exporting in iCalendar format
361 * HTML Export commands:: How to invoke HTML export
362 * Quoting HTML tags:: Using direct HTML in Org-mode
363 * Links in HTML export:: How links will be interpreted and formatted
364 * Tables in HTML export:: How to modify the formatting of tables
365 * Images in HTML export:: How to insert figures into HTML output
366 * Text areas in HTML export:: An alternative way to show an example
367 * CSS support:: Changing the appearance of the output
368 * JavaScript support:: Info and Folding in a web browser
370 La@TeX{} and PDF export
372 * LaTeX/PDF export commands:: Which key invokes which commands
373 * Header and sectioning:: Setting up the export file structure
374 * Quoting LaTeX code:: Incorporating literal La@TeX{} code
375 * Tables in LaTeX export:: Options for exporting tables to La@TeX{}
376 * Images in LaTeX export:: How to insert figures into La@TeX{} output
377 * Beamer class export:: Turning the file into a presentation
381 * DocBook export commands:: How to invoke DocBook export
382 * Quoting DocBook code:: Incorporating DocBook code in Org files
383 * Recursive sections:: Recursive sections in DocBook
384 * Tables in DocBook export:: Tables are exported as HTML tables
385 * Images in DocBook export:: How to insert figures into DocBook output
386 * Special characters:: How to handle special characters
390 * Configuration:: Defining projects
391 * Uploading files:: How to get files up on the server
392 * Sample configuration:: Example projects
393 * Triggering publication:: Publication commands
397 * Project alist:: The central configuration variable
398 * Sources and destinations:: From here to there
399 * Selecting files:: What files are part of the project?
400 * Publishing action:: Setting the function doing the publishing
401 * Publishing options:: Tweaking HTML export
402 * Publishing links:: Which links keep working after publishing?
403 * Sitemap:: Generating a list of all pages
404 * Generating an index:: An index that reaches across pages
408 * Simple example:: One-component publishing
409 * Complex example:: A multi-component publishing example
411 Working with source code
413 * Structure of code blocks:: Code block syntax described
414 * Editing source code:: Language major-mode editing
415 * Exporting code blocks:: Export contents and/or results
416 * Extracting source code:: Create pure source code files
417 * Evaluating code blocks:: Place results of evaluation in the Org-mode buffer
418 * Library of Babel:: Use and contribute to a library of useful code blocks
419 * Languages:: List of supported code block languages
420 * Header arguments:: Configure code block functionality
421 * Results of evaluation:: How evaluation results are handled
422 * Noweb reference syntax:: Literate programming in Org-mode
423 * Key bindings and useful functions:: Work quickly with code blocks
424 * Batch execution:: Call functions from the command line
428 * Using header arguments:: Different ways to set header arguments
429 * Specific header arguments:: List of header arguments
431 Using header arguments
433 * System-wide header arguments:: Set global default values
434 * Language-specific header arguments:: Set default values by language
435 * Buffer-wide header arguments:: Set default values for a specific buffer
436 * Header arguments in Org-mode properties:: Set default values for a buffer or heading
437 * Code block specific header arguments:: The most common way to set values
439 Specific header arguments
441 * var:: Pass arguments to code blocks
442 * results:: Specify the type of results and how they will be collected and handled
443 * file:: Specify a path for file output
444 * dir:: Specify the default directory for code block execution
445 * exports:: Export code and/or results
446 * tangle:: Toggle tangling and specify file name
447 * no-expand:: Turn off variable assignment and noweb expansion during tangling
448 * session:: Preserve the state of code evaluation
449 * noweb:: Toggle expansion of noweb references
450 * cache:: Avoid re-evaluating unchanged code blocks
451 * hlines:: Handle horizontal lines in tables
452 * colnames:: Handle column names in tables
453 * rownames:: Handle row names in tables
454 * shebang:: Make tangled files executable
458 * Completion:: M-TAB knows what you need
459 * Speed keys:: Electric commands at the beginning of a headline
460 * Code evaluation security:: Org mode files evaluate inline code
461 * Customization:: Adapting Org to your taste
462 * In-buffer settings:: Overview of the #+KEYWORDS
463 * The very busy C-c C-c key:: When in doubt, press C-c C-c
464 * Clean view:: Getting rid of leading stars in the outline
465 * TTY keys:: Using Org on a tty
466 * Interaction:: Other Emacs packages
468 Interaction with other packages
470 * Cooperation:: Packages Org cooperates with
471 * Conflicts:: Packages that lead to conflicts
475 * Hooks:: Who to reach into Org's internals
476 * Add-on packages:: Available extensions
477 * Adding hyperlink types:: New custom link types
478 * Context-sensitive commands:: How to add functionality to such commands
479 * Tables in arbitrary syntax:: Orgtbl for La@TeX{} and other programs
480 * Dynamic blocks:: Automatically filled blocks
481 * Special agenda views:: Customized views
482 * Extracting agenda information:: Postprocessing of agenda information
483 * Using the property API:: Writing programs that use entry properties
484 * Using the mapping API:: Mapping over all or selected entries
486 Tables and lists in arbitrary syntax
488 * Radio tables:: Sending and receiving radio tables
489 * A LaTeX example:: Step by step, almost a tutorial
490 * Translator functions:: Copy and modify
491 * Radio lists:: Doing the same for lists
495 * Setting up the staging area:: Where to interact with the mobile device
496 * Pushing to MobileOrg:: Uploading Org files and agendas
497 * Pulling from MobileOrg:: Integrating captured and flagged items
502 @node Introduction, Document Structure, Top, Top
503 @chapter Introduction
507 * Summary:: Brief summary of what Org does
508 * Installation:: How to install a downloaded version of Org
509 * Activation:: How to activate Org for certain buffers
510 * Feedback:: Bug reports, ideas, patches etc.
511 * Conventions:: Type-setting conventions in the manual
514 @node Summary, Installation, Introduction, Introduction
518 Org is a mode for keeping notes, maintaining TODO lists, and doing
519 project planning with a fast and effective plain-text system.
521 Org develops organizational tasks around NOTES files that contain
522 lists or information about projects as plain text. Org is
523 implemented on top of Outline mode, which makes it possible to keep the
524 content of large files well structured. Visibility cycling and
525 structure editing help to work with the tree. Tables are easily created
526 with a built-in table editor. Org supports TODO items, deadlines,
527 timestamps, and scheduling. It dynamically compiles entries into an
528 agenda that utilizes and smoothly integrates much of the Emacs calendar
529 and diary. Plain text URL-like links connect to websites, emails,
530 Usenet messages, BBDB entries, and any files related to the projects.
531 For printing and sharing of notes, an Org file can be exported as a
532 structured ASCII file, as HTML, or (TODO and agenda items only) as an
533 iCalendar file. It can also serve as a publishing tool for a set of
536 As a project planning environment, Org works by adding metadata to outline
537 nodes. Based on this data, specific entries can be extracted in queries and
538 create dynamic @i{agenda views}.
540 Org mode contains the Org Babel environment which allows to work with
541 embedded source code block in a file, to facilitate code evaluation,
542 documentation, and tangling.
544 Org's automatic, context-sensitive table editor with spreadsheet
545 capabilities can be integrated into any major mode by activating the
546 minor Orgtbl mode. Using a translation step, it can be used to maintain
547 tables in arbitrary file types, for example in La@TeX{}. The structure
548 editing and list creation capabilities can be used outside Org with
549 the minor Orgstruct mode.
551 Org keeps simple things simple. When first fired up, it should
552 feel like a straightforward, easy to use outliner. Complexity is not
553 imposed, but a large amount of functionality is available when you need
554 it. Org is a toolbox and can be used in different ways and for different
558 @r{@bullet{} an outline extension with visibility cycling and structure editing}
559 @r{@bullet{} an ASCII system and table editor for taking structured notes}
560 @r{@bullet{} a TODO list editor}
561 @r{@bullet{} a full agenda and planner with deadlines and work scheduling}
562 @pindex GTD, Getting Things Done
563 @r{@bullet{} an environment in which to implement David Allen's GTD system}
564 @r{@bullet{} a simple hypertext system, with HTML and La@TeX{} export}
565 @r{@bullet{} a publishing tool to create a set of interlinked webpages}
566 @r{@bullet{} an environment for literate programming}
571 There is a website for Org which provides links to the newest
572 version of Org, as well as additional information, frequently asked
573 questions (FAQ), links to tutorials, etc@. This page is located at
574 @uref{http://orgmode.org}.
579 @node Installation, Activation, Summary, Introduction
580 @section Installation
584 @b{Important:} @i{If you are using a version of Org that is part of the Emacs
585 distribution or an XEmacs package, please skip this section and go directly
586 to @ref{Activation}.}
588 If you have downloaded Org from the Web, either as a distribution @file{.zip}
589 or @file{.tar} file, or as a Git archive, you must take the following steps
590 to install it: go into the unpacked Org distribution directory and edit the
591 top section of the file @file{Makefile}. You must set the name of the Emacs
592 binary (likely either @file{emacs} or @file{xemacs}), and the paths to the
593 directories where local Lisp and Info files are kept. If you don't have
594 access to the system-wide directories, you can simply run Org directly from
595 the distribution directory by adding the @file{lisp} subdirectory to the
596 Emacs load path. To do this, add the following line to @file{.emacs}:
599 (setq load-path (cons "~/path/to/orgdir/lisp" load-path))
603 If you plan to use code from the @file{contrib} subdirectory, do a similar
604 step for this directory:
607 (setq load-path (cons "~/path/to/orgdir/contrib/lisp" load-path))
612 XEmacs users now need to install the file @file{noutline.el} from
613 the @file{xemacs} sub-directory of the Org distribution. Use the
617 make install-noutline
622 @noindent Now byte-compile the Lisp files with the shell command:
628 @noindent If you are running Org from the distribution directory, this is
629 all. If you want to install Org into the system directories, use (as
636 Installing Info files is system dependent, because of differences in the
637 @file{install-info} program. In Debian it copies the info files into the
638 correct directory and modifies the info directory file. In many other
639 systems, the files need to be copied to the correct directory separately, and
640 @file{install-info} then only modifies the directory file. Check your system
641 documentation to find out which of the following commands you need:
645 make install-info-debian
648 Then add the following line to @file{.emacs}. It is needed so that
649 Emacs can autoload functions that are located in files not immediately loaded
650 when Org-mode starts.
652 (require 'org-install)
655 Do not forget to activate Org as described in the following section.
658 @node Activation, Feedback, Installation, Introduction
662 @cindex global key bindings
663 @cindex key bindings, global
665 Add the following lines to your @file{.emacs} file. The last three lines
666 define @emph{global} keys for the commands @command{org-store-link},
667 @command{org-agenda}, and @command{org-iswitchb}---please choose suitable
671 ;; The following lines are always needed. Choose your own keys.
672 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
673 (global-set-key "\C-cl" 'org-store-link)
674 (global-set-key "\C-ca" 'org-agenda)
675 (global-set-key "\C-cb" 'org-iswitchb)
678 Furthermore, you must activate @code{font-lock-mode} in Org
679 buffers, because significant functionality depends on font-locking being
680 active. You can do this with either one of the following two lines
681 (XEmacs users must use the second option):
683 (global-font-lock-mode 1) ; for all buffers
684 (add-hook 'org-mode-hook 'turn-on-font-lock) ; Org buffers only
687 @cindex Org-mode, turning on
688 With this setup, all files with extension @samp{.org} will be put
689 into Org-mode. As an alternative, make the first line of a file look
693 MY PROJECTS -*- mode: org; -*-
696 @vindex org-insert-mode-line-in-empty-file
697 @noindent which will select Org-mode for this buffer no matter what
698 the file's name is. See also the variable
699 @code{org-insert-mode-line-in-empty-file}.
701 Many commands in Org work on the region if the region is @i{active}. To make
702 use of this, you need to have @code{transient-mark-mode}
703 (@code{zmacs-regions} in XEmacs) turned on. In Emacs 23 this is the default,
704 in Emacs 22 you need to do this yourself with
706 (transient-mark-mode 1)
708 @noindent If you do not like @code{transient-mark-mode}, you can create an
709 active region by using the mouse to select a region, or pressing
710 @kbd{C-@key{SPC}} twice before moving the cursor.
712 @node Feedback, Conventions, Activation, Introduction
719 If you find problems with Org, or if you have questions, remarks, or ideas
720 about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}.
721 If you are not a member of the mailing list, your mail will be passed to the
722 list after a moderator has approved it.
724 For bug reports, please provide as much information as possible, including
725 the version information of Emacs (@kbd{M-x emacs-version @key{RET}}) and Org
726 (@kbd{M-x org-version @key{RET}}), as well as the Org related setup in
727 @file{.emacs}. The easiest way to do this is to use the command
729 @kbd{M-x org-submit-bug-report}
731 @noindent which will put all this information into an Emacs mail buffer so
732 that you only need to add your description. If you re not sending the Email
733 from within Emacs, please copy and paste the content into your Email program.
735 If an error occurs, a backtrace can be very useful (see below on how to
736 create one). Often a small example file helps, along with clear information
740 @item What exactly did you do?
741 @item What did you expect to happen?
742 @item What happened instead?
744 @noindent Thank you for helping to improve this mode.
746 @subsubheading How to create a useful backtrace
748 @cindex backtrace of an error
749 If working with Org produces an error with a message you don't
750 understand, you may have hit a bug. The best way to report this is by
751 providing, in addition to what was mentioned above, a @emph{backtrace}.
752 This is information from the built-in debugger about where and how the
753 error occurred. Here is how to produce a useful backtrace:
757 Reload uncompiled versions of all Org-mode Lisp files. The backtrace
758 contains much more information if it is produced with uncompiled code.
761 C-u M-x org-reload RET
764 or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the
767 Go to the @code{Options} menu and select @code{Enter Debugger on Error}
768 (XEmacs has this option in the @code{Troubleshooting} sub-menu).
770 Do whatever you have to do to hit the error. Don't forget to
771 document the steps you take.
773 When you hit the error, a @file{*Backtrace*} buffer will appear on the
774 screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and
775 attach it to your bug report.
778 @node Conventions, , Feedback, Introduction
779 @section Typesetting conventions used in this manual
781 Org uses three types of keywords: TODO keywords, tags, and property
782 names. In this manual we use the following conventions:
787 TODO keywords are written with all capitals, even if they are
791 User-defined tags are written in lowercase; built-in tags with special
792 meaning are written with all capitals.
795 User-defined properties are capitalized; built-in properties with
796 special meaning are written with all capitals.
799 @node Document Structure, Tables, Introduction, Top
800 @chapter Document structure
801 @cindex document structure
802 @cindex structure of document
804 Org is based on Outline mode and provides flexible commands to
805 edit the structure of the document.
808 * Outlines:: Org is based on Outline mode
809 * Headlines:: How to typeset Org tree headlines
810 * Visibility cycling:: Show and hide, much simplified
811 * Motion:: Jumping to other headlines
812 * Structure editing:: Changing sequence and level of headlines
813 * Sparse trees:: Matches embedded in context
814 * Plain lists:: Additional structure within an entry
815 * Drawers:: Tucking stuff away
816 * Blocks:: Folding blocks
817 * Footnotes:: How footnotes are defined in Org's syntax
818 * Orgstruct mode:: Structure editing outside Org
821 @node Outlines, Headlines, Document Structure, Document Structure
826 Org is implemented on top of Outline mode. Outlines allow a
827 document to be organized in a hierarchical structure, which (at least
828 for me) is the best representation of notes and thoughts. An overview
829 of this structure is achieved by folding (hiding) large parts of the
830 document to show only the general document structure and the parts
831 currently being worked on. Org greatly simplifies the use of
832 outlines by compressing the entire show/hide functionality into a single
833 command, @command{org-cycle}, which is bound to the @key{TAB} key.
835 @node Headlines, Visibility cycling, Outlines, Document Structure
839 @vindex org-special-ctrl-a/e
840 @vindex org-special-ctrl-k
841 @vindex org-ctrl-k-protect-subtree
843 Headlines define the structure of an outline tree. The headlines in Org
844 start with one or more stars, on the left margin@footnote{See the variables
845 @code{org-special-ctrl-a/e}, @code{org-special-ctrl-k}, and
846 @code{org-ctrl-k-protect-subtree} to configure special behavior of @kbd{C-a},
847 @kbd{C-e}, and @kbd{C-k} in headlines.}. For example:
857 * Another top level headline
860 @noindent Some people find the many stars too noisy and would prefer an
861 outline that has whitespace followed by a single star as headline
862 starters. @ref{Clean view}, describes a setup to realize this.
864 @vindex org-cycle-separator-lines
865 An empty line after the end of a subtree is considered part of it and
866 will be hidden when the subtree is folded. However, if you leave at
867 least two empty lines, one empty line will remain visible after folding
868 the subtree, in order to structure the collapsed view. See the
869 variable @code{org-cycle-separator-lines} to modify this behavior.
871 @node Visibility cycling, Motion, Headlines, Document Structure
872 @section Visibility cycling
873 @cindex cycling, visibility
874 @cindex visibility cycling
875 @cindex trees, visibility
876 @cindex show hidden text
879 Outlines make it possible to hide parts of the text in the buffer.
880 Org uses just two commands, bound to @key{TAB} and
881 @kbd{S-@key{TAB}} to change the visibility in the buffer.
883 @cindex subtree visibility states
884 @cindex subtree cycling
885 @cindex folded, subtree visibility state
886 @cindex children, subtree visibility state
887 @cindex subtree, subtree visibility state
891 @emph{Subtree cycling}: Rotate current subtree among the states
894 ,-> FOLDED -> CHILDREN -> SUBTREE --.
895 '-----------------------------------'
898 @vindex org-cycle-emulate-tab
899 @vindex org-cycle-global-at-bob
900 The cursor must be on a headline for this to work@footnote{see, however,
901 the option @code{org-cycle-emulate-tab}.}. When the cursor is at the
902 beginning of the buffer and the first line is not a headline, then
903 @key{TAB} actually runs global cycling (see below)@footnote{see the
904 option @code{org-cycle-global-at-bob}.}. Also when called with a prefix
905 argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
907 @cindex global visibility states
908 @cindex global cycling
909 @cindex overview, global visibility state
910 @cindex contents, global visibility state
911 @cindex show all, global visibility state
915 @emph{Global cycling}: Rotate the entire buffer among the states
918 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
919 '--------------------------------------'
922 When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
923 CONTENTS view up to headlines of level N will be shown. Note that inside
924 tables, @kbd{S-@key{TAB}} jumps to the previous field.
926 @cindex show all, command
927 @kindex C-u C-u C-u @key{TAB}
928 @item C-u C-u C-u @key{TAB}
929 Show all, including drawers.
932 Reveal context around point, showing the current entry, the following heading
933 and the hierarchy above. Useful for working near a location that has been
934 exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
935 (@pxref{Agenda commands}). With a prefix argument show, on each
936 level, all sibling headings. With double prefix arg, also show the entire
937 subtree of the parent.
940 Expose all the headings of the subtree, CONTENT view for just one subtree.
943 Show the current subtree in an indirect buffer@footnote{The indirect
946 (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
949 (see the Emacs manual for more information about indirect buffers)
951 will contain the entire buffer, but will be narrowed to the current
952 tree. Editing the indirect buffer will also change the original buffer,
953 but without affecting visibility in that buffer.}. With a numeric
954 prefix argument N, go up to level N and then take that tree. If N is
955 negative then go up that many levels. With a @kbd{C-u} prefix, do not remove
956 the previously used indirect buffer.
959 @vindex org-startup-folded
960 @cindex @code{overview}, STARTUP keyword
961 @cindex @code{content}, STARTUP keyword
962 @cindex @code{showall}, STARTUP keyword
963 @cindex @code{showeverything}, STARTUP keyword
965 When Emacs first visits an Org file, the global state is set to
966 OVERVIEW, i.e. only the top level headlines are visible. This can be
967 configured through the variable @code{org-startup-folded}, or on a
968 per-file basis by adding one of the following lines anywhere in the
975 #+STARTUP: showeverything
978 @cindex property, VISIBILITY
980 Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
981 and Columns}) will get their visibility adapted accordingly. Allowed values
982 for this property are @code{folded}, @code{children}, @code{content}, and
985 @kindex C-u C-u @key{TAB}
986 @item C-u C-u @key{TAB}
987 Switch back to the startup visibility of the buffer, i.e. whatever is
988 requested by startup options and @samp{VISIBILITY} properties in individual
992 @node Motion, Structure editing, Visibility cycling, Document Structure
994 @cindex motion, between headlines
995 @cindex jumping, to headlines
996 @cindex headline navigation
997 The following commands jump to other headlines in the buffer.
1008 Next heading same level.
1011 Previous heading same level.
1014 Backward to higher level heading.
1017 Jump to a different place without changing the current outline
1018 visibility. Shows the document structure in a temporary buffer, where
1019 you can use the following keys to find your destination:
1020 @vindex org-goto-auto-isearch
1022 @key{TAB} @r{Cycle visibility.}
1023 @key{down} / @key{up} @r{Next/previous visible headline.}
1024 @key{RET} @r{Select this location.}
1025 @kbd{/} @r{Do a Sparse-tree search}
1026 @r{The following keys work if you turn off @code{org-goto-auto-isearch}}
1027 n / p @r{Next/previous visible headline.}
1028 f / b @r{Next/previous headline same level.}
1030 0-9 @r{Digit argument.}
1033 @vindex org-goto-interface
1035 See also the variable @code{org-goto-interface}.
1038 @node Structure editing, Sparse trees, Motion, Document Structure
1039 @section Structure editing
1040 @cindex structure editing
1041 @cindex headline, promotion and demotion
1042 @cindex promotion, of subtrees
1043 @cindex demotion, of subtrees
1044 @cindex subtree, cut and paste
1045 @cindex pasting, of subtrees
1046 @cindex cutting, of subtrees
1047 @cindex copying, of subtrees
1048 @cindex sorting, of subtrees
1049 @cindex subtrees, cut and paste
1054 @vindex org-M-RET-may-split-line
1055 Insert new heading with same level as current. If the cursor is in a
1056 plain list item, a new item is created (@pxref{Plain lists}). To force
1057 creation of a new headline, use a prefix argument, or first press @key{RET}
1058 to get to the beginning of the next line. When this command is used in
1059 the middle of a line, the line is split and the rest of the line becomes
1060 the new headline@footnote{If you do not want the line to be split,
1061 customize the variable @code{org-M-RET-may-split-line}.}. If the
1062 command is used at the beginning of a headline, the new headline is
1063 created before the current line. If at the beginning of any other line,
1064 the content of that line is made the new heading. If the command is
1065 used at the end of a folded subtree (i.e. behind the ellipses at the end
1066 of a headline), then a headline like the current one will be inserted
1067 after the end of the subtree.
1070 Just like @kbd{M-@key{RET}}, except when adding a new heading below the
1071 current heading, the new heading is placed after the body instead of before
1072 it. This command works from anywhere in the entry.
1073 @kindex M-S-@key{RET}
1075 @vindex org-treat-insert-todo-heading-as-state-change
1076 Insert new TODO entry with same level as current heading. See also the
1077 variable @code{org-treat-insert-todo-heading-as-state-change}.
1078 @kindex C-S-@key{RET}
1080 Insert new TODO entry with same level as current heading. Like
1081 @kbd{C-@key{RET}}, the new headline will be inserted after the current
1084 @item @key{TAB} @r{in new, empty entry}
1085 In a new entry with no text yet, the first @key{TAB} demotes the entry to
1086 become a child of the previous one. The next @key{TAB} makes it a parent,
1087 and so on, all the way to top level. Yet another @key{TAB}, and you are back
1088 to the initial level.
1089 @kindex M-@key{left}
1091 Promote current heading by one level.
1092 @kindex M-@key{right}
1094 Demote current heading by one level.
1095 @kindex M-S-@key{left}
1096 @item M-S-@key{left}
1097 Promote the current subtree by one level.
1098 @kindex M-S-@key{right}
1099 @item M-S-@key{right}
1100 Demote the current subtree by one level.
1101 @kindex M-S-@key{up}
1103 Move subtree up (swap with previous subtree of same
1105 @kindex M-S-@key{down}
1106 @item M-S-@key{down}
1107 Move subtree down (swap with next subtree of same level).
1110 Kill subtree, i.e. remove it from buffer but save in kill ring.
1111 With a numeric prefix argument N, kill N sequential subtrees.
1114 Copy subtree to kill ring. With a numeric prefix argument N, copy the N
1115 sequential subtrees.
1118 Yank subtree from kill ring. This does modify the level of the subtree to
1119 make sure the tree fits in nicely at the yank position. The yank level can
1120 also be specified with a numeric prefix argument, or by yanking after a
1121 headline marker like @samp{****}.
1124 @vindex org-yank-adjusted-subtrees
1125 @vindex org-yank-folded-subtrees
1126 Depending on the variables @code{org-yank-adjusted-subtrees} and
1127 @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
1128 paste subtrees folded and in a clever way, using the same command as @kbd{C-c
1129 C-x C-y}. With the default settings, no level adjustment will take place,
1130 but the yanked tree will be folded unless doing so would swallow text
1131 previously visible. Any prefix argument to this command will force a normal
1132 @code{yank} to be executed, with the prefix passed along. A good way to
1133 force a normal yank is @kbd{C-u C-y}. If you use @code{yank-pop} after a
1134 yank, it will yank previous kill items plainly, without adjustment and
1138 Clone a subtree by making a number of sibling copies of it. You will be
1139 prompted for the number of copies to make, and you can also specify if any
1140 timestamps in the entry should be shifted. This can be useful, for example,
1141 to create a number of tasks related to a series of lectures to prepare. For
1142 more details, see the docstring of the command
1143 @code{org-clone-subtree-with-time-shift}.
1146 Refile entry or region to a different location. @xref{Refiling notes}.
1149 Sort same-level entries. When there is an active region, all entries in the
1150 region will be sorted. Otherwise the children of the current headline are
1151 sorted. The command prompts for the sorting method, which can be
1152 alphabetically, numerically, by time (first timestamp with active preferred,
1153 creation time, scheduled time, deadline time), by priority, by TODO keyword
1154 (in the sequence the keywords have been defined in the setup) or by the value
1155 of a property. Reverse sorting is possible as well. You can also supply
1156 your own function to extract the sorting key. With a @kbd{C-u} prefix,
1157 sorting will be case-sensitive. With two @kbd{C-u C-u} prefixes, duplicate
1158 entries will also be removed.
1161 Narrow buffer to current subtree.
1164 Widen buffer to remove narrowing.
1167 Turn a normal line or plain list item into a headline (so that it becomes a
1168 subheading at its location). Also turn a headline into a normal line by
1169 removing the stars. If there is an active region, turn all lines in the
1170 region into headlines. If the first line in the region was an item, turn
1171 only the item lines into headlines. Finally, if the first line is a
1172 headline, remove the stars from all headlines in the region.
1175 @cindex region, active
1176 @cindex active region
1177 @cindex transient mark mode
1178 When there is an active region (Transient Mark mode), promotion and
1179 demotion work on all headlines in the region. To select a region of
1180 headlines, it is best to place both point and mark at the beginning of a
1181 line, mark at the beginning of the first headline, and point at the line
1182 just after the last headline to change. Note that when the cursor is
1183 inside a table (@pxref{Tables}), the Meta-Cursor keys have different
1187 @node Sparse trees, Plain lists, Structure editing, Document Structure
1188 @section Sparse trees
1189 @cindex sparse trees
1190 @cindex trees, sparse
1191 @cindex folding, sparse trees
1192 @cindex occur, command
1194 @vindex org-show-hierarchy-above
1195 @vindex org-show-following-heading
1196 @vindex org-show-siblings
1197 @vindex org-show-entry-below
1198 An important feature of Org-mode is the ability to construct @emph{sparse
1199 trees} for selected information in an outline tree, so that the entire
1200 document is folded as much as possible, but the selected information is made
1201 visible along with the headline structure above it@footnote{See also the
1202 variables @code{org-show-hierarchy-above}, @code{org-show-following-heading},
1203 @code{org-show-siblings}, and @code{org-show-entry-below} for detailed
1204 control on how much context is shown around each match.}. Just try it out
1205 and you will see immediately how it works.
1207 Org-mode contains several commands creating such trees, all these
1208 commands can be accessed through a dispatcher:
1213 This prompts for an extra key to select a sparse-tree creating command.
1216 @vindex org-remove-highlights-with-change
1217 Occur. Prompts for a regexp and shows a sparse tree with all matches. If
1218 the match is in a headline, the headline is made visible. If the match is in
1219 the body of an entry, headline and body are made visible. In order to
1220 provide minimal context, also the full hierarchy of headlines above the match
1221 is shown, as well as the headline following the match. Each match is also
1222 highlighted; the highlights disappear when the buffer is changed by an
1223 editing command@footnote{This depends on the option
1224 @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
1225 When called with a @kbd{C-u} prefix argument, previous highlights are kept,
1226 so several calls to this command can be stacked.
1230 @vindex org-agenda-custom-commands
1231 For frequently used sparse trees of specific search strings, you can
1232 use the variable @code{org-agenda-custom-commands} to define fast
1233 keyboard access to specific sparse trees. These commands will then be
1234 accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
1238 (setq org-agenda-custom-commands
1239 '(("f" occur-tree "FIXME")))
1242 @noindent will define the key @kbd{C-c a f} as a shortcut for creating
1243 a sparse tree matching the string @samp{FIXME}.
1245 The other sparse tree commands select headings based on TODO keywords,
1246 tags, or properties and will be discussed later in this manual.
1249 @cindex printing sparse trees
1250 @cindex visible text, printing
1251 To print a sparse tree, you can use the Emacs command
1252 @code{ps-print-buffer-with-faces} which does not print invisible parts
1253 of the document @footnote{This does not work under XEmacs, because
1254 XEmacs uses selective display for outlining, not text properties.}.
1255 Or you can use the command @kbd{C-c C-e v} to export only the visible
1256 part of the document and print the resulting file.
1258 @node Plain lists, Drawers, Sparse trees, Document Structure
1259 @section Plain lists
1261 @cindex lists, plain
1262 @cindex lists, ordered
1263 @cindex ordered lists
1265 Within an entry of the outline tree, hand-formatted lists can provide
1266 additional structure. They also provide a way to create lists of
1267 checkboxes (@pxref{Checkboxes}). Org supports editing such lists,
1268 and the HTML exporter (@pxref{Exporting}) parses and formats them.
1270 Org knows ordered lists, unordered lists, and description lists.
1273 @emph{Unordered} list items start with @samp{-}, @samp{+}, or
1274 @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
1275 they will be seen as top-level headlines. Also, when you are hiding leading
1276 stars to get a clean outline view, plain list items starting with a star are
1277 visually indistinguishable from true headlines. In short: even though
1278 @samp{*} is supported, it may be better to not use it for plain list items.}
1281 @emph{Ordered} list items start with a numeral followed by either a period or
1282 a right parenthesis, such as @samp{1.} or @samp{1)}. If you want a list to
1283 start a different value (e.g. 20), start the text of the item with
1284 @code{[@@start:20]}.
1286 @emph{Description} list items are unordered list items, and contain the
1287 separator @samp{ :: } to separate the description @emph{term} from the
1291 @vindex org-empty-line-terminates-plain-lists
1292 Items belonging to the same list must have the same indentation on the first
1293 line. In particular, if an ordered list reaches number @samp{10.}, then the
1294 2--digit numbers must be written left-aligned with the other numbers in the
1295 list. Indentation also determines the end of a list item. It ends before
1296 the next line that is indented like the bullet/number, or less. Empty lines
1297 are part of the previous item, so you can have several paragraphs in one
1298 item. If you would like an empty line to terminate all currently open plain
1299 lists, configure the variable @code{org-empty-line-terminates-plain-lists}.
1304 ** Lord of the Rings
1305 My favorite scenes are (in this order)
1306 1. The attack of the Rohirrim
1307 2. Eowyn's fight with the witch king
1308 + this was already my favorite scene in the book
1309 + I really like Miranda Otto.
1310 3. Peter Jackson being shot by Legolas
1312 He makes a really funny face when it happens.
1313 But in the end, no individual scenes matter but the film as a whole.
1314 Important actors in this film are:
1315 - @b{Elijah Wood} :: He plays Frodo
1316 - @b{Sean Austin} :: He plays Sam, Frodo's friend. I still remember
1317 him very well from his role as Mikey Walsh in @i{The Goonies}.
1321 Org supports these lists by tuning filling and wrapping commands to deal with
1322 them correctly@footnote{Org only changes the filling settings for Emacs. For
1323 XEmacs, you should use Kyle E. Jones' @file{filladapt.el}. To turn this on,
1324 put into @file{.emacs}: @code{(require 'filladapt)}}, and by exporting them
1325 properly (@pxref{Exporting}). Since indentation is what governs the
1326 structure of these lists, many structural constructs like @code{#+BEGIN_...}
1327 blocks can be indented to signal that they should be part of a list item.
1329 @vindex org-list-demote-modify-bullet
1330 If you find that using a different bullet for a sub-list (than that used for
1331 the current list-level) improves readability, customize the variable
1332 @code{org-list-demote-modify-bullet}.
1334 The following commands act on items when the cursor is in the first line
1335 of an item (the line with the bullet or number).
1340 @vindex org-cycle-include-plain-lists
1341 Items can be folded just like headline levels. Normally this works only if
1342 the cursor is on a plain list item. For more details, see the variable
1343 @code{org-cycle-include-plain-lists}. to @code{integrate}, plain list items
1344 will be treated like low-level. The level of an item is then given by the
1345 indentation of the bullet/number. Items are always subordinate to real
1346 headlines, however; the hierarchies remain completely separated.
1348 If @code{org-cycle-include-plain-lists} has not been set, @key{TAB}
1349 fixes the indentation of the current line in a heuristic way.
1352 @vindex org-M-RET-may-split-line
1353 Insert new item at current level. With a prefix argument, force a new
1354 heading (@pxref{Structure editing}). If this command is used in the middle
1355 of a line, the line is @emph{split} and the rest of the line becomes the new
1356 item@footnote{If you do not want the line to be split, customize the variable
1357 @code{org-M-RET-may-split-line}.}. If this command is executed in the
1358 @emph{whitespace before a bullet or number}, the new item is created
1359 @emph{before} the current item. If the command is executed in the white
1360 space before the text that is part of an item but does not contain the
1361 bullet, a bullet is added to the current line.
1362 @kindex M-S-@key{RET}
1364 Insert a new item with a checkbox (@pxref{Checkboxes}).
1366 @item @key{TAB} @r{in new, empty item}
1367 In a new item with no text yet, the first @key{TAB} demotes the item to
1368 become a child of the previous one. The next @key{TAB} makes it a parent,
1369 and so on, all the way to the left margin. Yet another @key{TAB}, and you
1370 are back to the initial level.
1372 @kindex S-@key{down}
1375 @cindex shift-selection-mode
1376 @vindex org-support-shift-select
1377 Jump to the previous/next item in the current list, but only if
1378 @code{org-support-shift-select} is off. If not, you can still use paragraph
1379 jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite
1381 @kindex M-S-@key{up}
1382 @kindex M-S-@key{down}
1384 @itemx M-S-@key{down}
1385 Move the item including subitems up/down (swap with previous/next item
1386 of same indentation). If the list is ordered, renumbering is
1388 @kindex M-@key{left}
1389 @kindex M-@key{right}
1391 @itemx M-@key{right}
1392 Decrease/increase the indentation of an item, leaving children alone.
1393 @kindex M-S-@key{left}
1394 @kindex M-S-@key{right}
1395 @item M-S-@key{left}
1396 @itemx M-S-@key{right}
1397 Decrease/increase the indentation of the item, including subitems.
1398 Initially, the item tree is selected based on current indentation.
1399 When these commands are executed several times in direct succession,
1400 the initially selected region is used, even if the new indentation
1401 would imply a different hierarchy. To use the new hierarchy, break
1402 the command chain with a cursor motion or so.
1405 If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
1406 state of the checkbox. If not, this command makes sure that all the
1407 items on this list level use the same bullet. Furthermore, if this is
1408 an ordered list, make sure the numbering is OK.
1411 Cycle the entire list level through the different itemize/enumerate bullets
1412 (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}). With a numeric prefix
1413 argument N, select the Nth bullet from this list. If there is an active
1414 region when calling this, all lines will be converted to list items. If the
1415 first line already was a list item, any item markers will be removed from the
1416 list. Finally, even without an active region, a normal line will be
1417 converted into a list item.
1420 Turn a plain list item into a headline (so that it becomes a subheading at
1421 its location). @xref{Structure editing}, for a detailed explanation.
1422 @kindex S-@key{left}
1423 @kindex S-@key{right}
1424 @item S-@key{left}/@key{right}
1425 @vindex org-support-shift-select
1426 This command also cycles bullet styles when the cursor in on the bullet or
1427 anywhere in an item line, details depending on
1428 @code{org-support-shift-select}.
1431 Sort the plain list. You will be prompted for the sorting method:
1432 numerically, alphabetically, by time, or by custom function.
1435 @node Drawers, Blocks, Plain lists, Document Structure
1439 @cindex visibility cycling, drawers
1442 Sometimes you want to keep information associated with an entry, but you
1443 normally don't want to see it. For this, Org-mode has @emph{drawers}.
1444 Drawers need to be configured with the variable
1445 @code{org-drawers}@footnote{You can define drawers on a per-file basis
1446 with a line like @code{#+DRAWERS: HIDDEN PROPERTIES STATE}}. Drawers
1450 ** This is a headline
1451 Still outside the drawer
1453 This is inside the drawer.
1458 Visibility cycling (@pxref{Visibility cycling}) on the headline will hide and
1459 show the entry, but keep the drawer collapsed to a single line. In order to
1460 look inside the drawer, you need to move the cursor to the drawer line and
1461 press @key{TAB} there. Org-mode uses the @code{PROPERTIES} drawer for
1462 storing properties (@pxref{Properties and Columns}), and you can also arrange
1463 for state change notes (@pxref{Tracking TODO state changes}) and clock times
1464 (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}. If you
1465 want to store a quick note in the LOGBOOK drawer, in a similar way as this is
1466 done by state changes, use
1471 Add a time-stamped note to the LOGBOOK drawer.
1474 @node Blocks, Footnotes, Drawers, Document Structure
1477 @vindex org-hide-block-startup
1478 @cindex blocks, folding
1479 Org-mode uses begin...end blocks for various purposes from including source
1480 code examples (@pxref{Literal examples}) to capturing time logging
1481 information (@pxref{Clocking work time}). These blocks can be folded and
1482 unfolded by pressing TAB in the begin line. You can also get all blocks
1483 folded at startup by configuring the variable @code{org-hide-block-startup}
1484 or on a per-file basis by using
1486 @cindex @code{hideblocks}, STARTUP keyword
1487 @cindex @code{nohideblocks}, STARTUP keyword
1489 #+STARTUP: hideblocks
1490 #+STARTUP: nohideblocks
1493 @node Footnotes, Orgstruct mode, Blocks, Document Structure
1497 Org-mode supports the creation of footnotes. In contrast to the
1498 @file{footnote.el} package, Org-mode's footnotes are designed for work on a
1499 larger document, not only for one-off documents like emails. The basic
1500 syntax is similar to the one used by @file{footnote.el}, i.e. a footnote is
1501 defined in a paragraph that is started by a footnote marker in square
1502 brackets in column 0, no indentation allowed. If you need a paragraph break
1503 inside a footnote, use the La@TeX{} idiom @samp{\par}. The footnote reference
1504 is simply the marker in square brackets, inside text. For example:
1507 The Org homepage[fn:1] now looks a lot better than it used to.
1509 [fn:1] The link is: http://orgmode.org
1512 Org-mode extends the number-based syntax to @emph{named} footnotes and
1513 optional inline definition. Using plain numbers as markers (as
1514 @file{footnote.el} does) is supported for backward compatibility, but not
1515 encouraged because of possible conflicts with La@TeX{} snippets (@pxref{Embedded
1516 LaTeX}). Here are the valid references:
1520 A plain numeric footnote marker. Compatible with @file{footnote.el}, but not
1521 recommended because something like @samp{[1]} could easily be part of a code
1524 A named footnote reference, where @code{name} is a unique label word, or, for
1525 simplicity of automatic creation, a number.
1526 @item [fn:: This is the inline definition of this footnote]
1527 A La@TeX{}-like anonymous footnote where the definition is given directly at the
1529 @item [fn:name: a definition]
1530 An inline definition of a footnote, which also specifies a name for the note.
1531 Since Org allows multiple references to the same note, you can then use
1532 @code{[fn:name]} to create additional references.
1535 @vindex org-footnote-auto-label
1536 Footnote labels can be created automatically, or you can create names yourself.
1537 This is handled by the variable @code{org-footnote-auto-label} and its
1538 corresponding @code{#+STARTUP} keywords, see the docstring of that variable
1541 @noindent The following command handles footnotes:
1546 The footnote action command.
1548 When the cursor is on a footnote reference, jump to the definition. When it
1549 is at a definition, jump to the (first) reference.
1551 @vindex org-footnote-define-inline
1552 @vindex org-footnote-section
1553 @vindex org-footnote-auto-adjust
1554 Otherwise, create a new footnote. Depending on the variable
1555 @code{org-footnote-define-inline}@footnote{The corresponding in-buffer
1556 setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
1557 definition will be placed right into the text as part of the reference, or
1558 separately into the location determined by the variable
1559 @code{org-footnote-section}.
1561 When this command is called with a prefix argument, a menu of additional
1564 s @r{Sort the footnote definitions by reference sequence. During editing,}
1565 @r{Org makes no effort to sort footnote definitions into a particular}
1566 @r{sequence. If you want them sorted, use this command, which will}
1567 @r{also move entries according to @code{org-footnote-section}. Automatic}
1568 @r{sorting after each insertion/deletion can be configured using the}
1569 @r{variable @code{org-footnote-auto-adjust}.}
1570 r @r{Renumber the simple @code{fn:N} footnotes. Automatic renumbering}
1571 @r{after each insertion/deletion can be configured using the variable}
1572 @r{@code{org-footnote-auto-adjust}.}
1573 S @r{Short for first @code{r}, then @code{s} action.}
1574 n @r{Normalize the footnotes by collecting all definitions (including}
1575 @r{inline definitions) into a special section, and then numbering them}
1576 @r{in sequence. The references will then also be numbers. This is}
1577 @r{meant to be the final step before finishing a document (e.g. sending}
1578 @r{off an email). The exporters do this automatically, and so could}
1579 @r{something like @code{message-send-hook}.}
1580 d @r{Delete the footnote at point, and all definitions of and references}
1583 Depending on the variable @code{org-footnote-auto-adjust}@footnote{the
1584 corresponding in-buffer options are @code{fnadjust} and @code{nofnadjust}.},
1585 renumbering and sorting footnotes can be automatic after each insertion or
1590 If the cursor is on a footnote reference, jump to the definition. If it is a
1591 the definition, jump back to the reference. When called at a footnote
1592 location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
1596 @item C-c C-o @r{or} mouse-1/2
1597 Footnote labels are also links to the corresponding definition/reference, and
1598 you can use the usual commands to follow these links.
1601 @node Orgstruct mode, , Footnotes, Document Structure
1602 @section The Orgstruct minor mode
1603 @cindex Orgstruct mode
1604 @cindex minor mode for structure editing
1606 If you like the intuitive way the Org-mode structure editing and list
1607 formatting works, you might want to use these commands in other modes like
1608 Text mode or Mail mode as well. The minor mode @code{orgstruct-mode} makes
1609 this possible. Toggle the mode with @kbd{M-x orgstruct-mode}, or
1610 turn it on by default, for example in Mail mode, with one of:
1613 (add-hook 'mail-mode-hook 'turn-on-orgstruct)
1614 (add-hook 'mail-mode-hook 'turn-on-orgstruct++)
1617 When this mode is active and the cursor is on a line that looks to Org like a
1618 headline or the first line of a list item, most structure editing commands
1619 will work, even if the same keys normally have different functionality in the
1620 major mode you are using. If the cursor is not in one of those special
1621 lines, Orgstruct mode lurks silently in the shadow. When you use
1622 @code{orgstruct++-mode}, Org will also export indentation and autofill
1623 settings into that mode, and detect item context after the first line of an
1626 @node Tables, Hyperlinks, Document Structure, Top
1629 @cindex editing tables
1631 Org comes with a fast and intuitive table editor. Spreadsheet-like
1632 calculations are supported in connection with the Emacs @file{calc}
1635 (@pxref{Top,Calc,,Calc,Gnu Emacs Calculator Manual}).
1638 (see the Emacs Calculator manual for more information about the Emacs
1643 * Built-in table editor:: Simple tables
1644 * Column width and alignment:: Overrule the automatic settings
1645 * Column groups:: Grouping to trigger vertical lines
1646 * Orgtbl mode:: The table editor as minor mode
1647 * The spreadsheet:: The table editor has spreadsheet capabilities
1648 * Org-Plot:: Plotting from org tables
1651 @node Built-in table editor, Column width and alignment, Tables, Tables
1652 @section The built-in table editor
1653 @cindex table editor, built-in
1655 Org makes it easy to format tables in plain ASCII. Any line with
1656 @samp{|} as the first non-whitespace character is considered part of a
1657 table. @samp{|} is also the column separator. A table might look like
1661 | Name | Phone | Age |
1662 |-------+-------+-----|
1663 | Peter | 1234 | 17 |
1664 | Anna | 4321 | 25 |
1667 A table is re-aligned automatically each time you press @key{TAB} or
1668 @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to
1669 the next field (@key{RET} to the next row) and creates new table rows
1670 at the end of the table or before horizontal lines. The indentation
1671 of the table is set by the first line. Any line starting with
1672 @samp{|-} is considered as a horizontal separator line and will be
1673 expanded on the next re-align to span the whole table width. So, to
1674 create the above table, you would only type
1681 @noindent and then press @key{TAB} to align the table and start filling in
1682 fields. Even faster would be to type @code{|Name|Phone|Age} followed by
1683 @kbd{C-c @key{RET}}.
1685 @vindex org-enable-table-editor
1686 @vindex org-table-auto-blank-field
1687 When typing text into a field, Org treats @key{DEL},
1688 @key{Backspace}, and all character keys in a special way, so that
1689 inserting and deleting avoids shifting other fields. Also, when
1690 typing @emph{immediately after the cursor was moved into a new field
1691 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
1692 field is automatically made blank. If this behavior is too
1693 unpredictable for you, configure the variables
1694 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
1697 @tsubheading{Creation and conversion}
1700 Convert the active region to table. If every line contains at least one
1701 TAB character, the function assumes that the material is tab separated.
1702 If every line contains a comma, comma-separated values (CSV) are assumed.
1703 If not, lines are split at whitespace into fields. You can use a prefix
1704 argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
1705 C-u} forces TAB, and a numeric argument N indicates that at least N
1706 consecutive spaces, or alternatively a TAB will be the separator.
1708 If there is no active region, this command creates an empty Org
1709 table. But it's easier just to start typing, like
1710 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
1712 @tsubheading{Re-aligning and field motion}
1715 Re-align the table without moving the cursor.
1719 Re-align the table, move to the next field. Creates a new row if
1724 Re-align, move to previous field.
1728 Re-align the table and move down to next row. Creates a new row if
1729 necessary. At the beginning or end of a line, @key{RET} still does
1730 NEWLINE, so it can be used to split a table.
1734 Move to beginning of the current table field, or on to the previous field.
1737 Move to end of the current table field, or on to the next field.
1739 @tsubheading{Column and row editing}
1740 @kindex M-@key{left}
1741 @kindex M-@key{right}
1743 @itemx M-@key{right}
1744 Move the current column left/right.
1746 @kindex M-S-@key{left}
1747 @item M-S-@key{left}
1748 Kill the current column.
1750 @kindex M-S-@key{right}
1751 @item M-S-@key{right}
1752 Insert a new column to the left of the cursor position.
1755 @kindex M-@key{down}
1758 Move the current row up/down.
1760 @kindex M-S-@key{up}
1762 Kill the current row or horizontal line.
1764 @kindex M-S-@key{down}
1765 @item M-S-@key{down}
1766 Insert a new row above the current row. With a prefix argument, the line is
1767 created below the current one.
1771 Insert a horizontal line below current row. With a prefix argument, the line
1772 is created above the current line.
1774 @kindex C-c @key{RET}
1776 Insert a horizontal line below current row, and move the cursor into the row
1781 Sort the table lines in the region. The position of point indicates the
1782 column to be used for sorting, and the range of lines is the range
1783 between the nearest horizontal separator lines, or the entire table. If
1784 point is before the first column, you will be prompted for the sorting
1785 column. If there is an active region, the mark specifies the first line
1786 and the sorting column, while point should be in the last line to be
1787 included into the sorting. The command prompts for the sorting type
1788 (alphabetically, numerically, or by time). When called with a prefix
1789 argument, alphabetic sorting will be case-sensitive.
1791 @tsubheading{Regions}
1794 Copy a rectangular region from a table to a special clipboard. Point and
1795 mark determine edge fields of the rectangle. If there is no active region,
1796 copy just the current field. The process ignores horizontal separator lines.
1800 Copy a rectangular region from a table to a special clipboard, and
1801 blank all fields in the rectangle. So this is the ``cut'' operation.
1805 Paste a rectangular region into a table.
1806 The upper left corner ends up in the current field. All involved fields
1807 will be overwritten. If the rectangle does not fit into the present table,
1808 the table is enlarged as needed. The process ignores horizontal separator
1813 Wrap several fields in a column like a paragraph. If there is an active
1814 region, and both point and mark are in the same column, the text in the
1815 column is wrapped to minimum width for the given number of lines. A numeric
1816 prefix argument may be used to change the number of desired lines. If there
1817 is no region, the current field is split at the cursor position and the text
1818 fragment to the right of the cursor is prepended to the field one line
1819 down. If there is no region, but you specify a prefix argument, the current
1820 field is made blank, and the content is appended to the field above.
1822 @tsubheading{Calculations}
1823 @cindex formula, in tables
1824 @cindex calculations, in tables
1825 @cindex region, active
1826 @cindex active region
1827 @cindex transient mark mode
1830 Sum the numbers in the current column, or in the rectangle defined by
1831 the active region. The result is shown in the echo area and can
1832 be inserted with @kbd{C-y}.
1836 @vindex org-table-copy-increment
1837 When current field is empty, copy from first non-empty field above. When not
1838 empty, copy current field down to next row and move cursor along with it.
1839 Depending on the variable @code{org-table-copy-increment}, integer field
1840 values will be incremented during copy. Integers that are too large will not
1841 be incremented. Also, a @code{0} prefix argument temporarily disables the
1842 increment. This key is also used by shift-selection and related modes
1843 (@pxref{Conflicts}).
1845 @tsubheading{Miscellaneous}
1848 Edit the current field in a separate window. This is useful for fields that
1849 are not fully visible (@pxref{Column width and alignment}). When called with
1850 a @kbd{C-u} prefix, just make the full field visible, so that it can be
1853 @item M-x org-table-import
1854 Import a file as a table. The table should be TAB or whitespace
1855 separated. Use, for example, to import a spreadsheet table or data
1856 from a database, because these programs generally can write
1857 TAB-separated text files. This command works by inserting the file into
1858 the buffer and then converting the region to a table. Any prefix
1859 argument is passed on to the converter, which uses it to determine the
1862 Tables can also be imported by pasting tabular text into the Org
1863 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
1864 @kbd{C-c |} command (see above under @i{Creation and conversion}).
1866 @item M-x org-table-export
1867 @vindex org-table-export-default-format
1868 Export the table, by default as a TAB-separated file. Use for data
1869 exchange with, for example, spreadsheet or database programs. The format
1870 used to export the file can be configured in the variable
1871 @code{org-table-export-default-format}. You may also use properties
1872 @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
1873 name and the format for table export in a subtree. Org supports quite
1874 general formats for exported tables. The exporter format is the same as the
1875 format used by Orgtbl radio tables, see @ref{Translator functions}, for a
1876 detailed description.
1879 If you don't like the automatic table editor because it gets in your
1880 way on lines which you would like to start with @samp{|}, you can turn
1884 (setq org-enable-table-editor nil)
1887 @noindent Then the only table command that still works is
1888 @kbd{C-c C-c} to do a manual re-align.
1890 @node Column width and alignment, Column groups, Built-in table editor, Tables
1891 @section Column width and alignment
1892 @cindex narrow columns in tables
1893 @cindex alignment in tables
1895 The width of columns is automatically determined by the table editor. And
1896 also the alignment of a column is determined automatically from the fraction
1897 of number-like versus non-number fields in the column.
1899 Sometimes a single field or a few fields need to carry more text, leading to
1900 inconveniently wide columns. Or maybe you want to make a table with several
1901 columns having a fixed width, regardless of content. To set@footnote{This
1902 feature does not work on XEmacs.} the width of a column, one field anywhere
1903 in the column may contain just the string @samp{<N>} where @samp{N} is an
1904 integer specifying the width of the column in characters. The next re-align
1905 will then set the width of this column to this value.
1909 |---+------------------------------| |---+--------|
1911 | 1 | one | | 1 | one |
1912 | 2 | two | ----\ | 2 | two |
1913 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
1914 | 4 | four | | 4 | four |
1915 |---+------------------------------| |---+--------|
1920 Fields that are wider become clipped and end in the string @samp{=>}.
1921 Note that the full text is still in the buffer, it is only invisible.
1922 To see the full text, hold the mouse over the field---a tool-tip window
1923 will show the full content. To edit such a field, use the command
1924 @kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will
1925 open a new window with the full field. Edit it and finish with @kbd{C-c
1928 @vindex org-startup-align-all-tables
1929 When visiting a file containing a table with narrowed columns, the
1930 necessary character hiding has not yet happened, and the table needs to
1931 be aligned before it looks nice. Setting the option
1932 @code{org-startup-align-all-tables} will realign all tables in a file
1933 upon visiting, but also slow down startup. You can also set this option
1934 on a per-file basis with:
1941 If you would like to overrule the automatic alignment of number-rich columns
1942 to the right and of string-rich column to the left, you and use @samp{<r>} or
1943 @samp{<l>} in a similar fashion. You may also combine alignment and field
1944 width like this: @samp{<l10>}.
1946 Lines which only contain these formatting cookies will be removed
1947 automatically when exporting the document.
1949 @node Column groups, Orgtbl mode, Column width and alignment, Tables
1950 @section Column groups
1951 @cindex grouping columns in tables
1953 When Org exports tables, it does so by default without vertical
1954 lines because that is visually more satisfying in general. Occasionally
1955 however, vertical lines can be useful to structure a table into groups
1956 of columns, much like horizontal lines can do for groups of rows. In
1957 order to specify column groups, you can use a special row where the
1958 first field contains only @samp{/}. The further fields can either
1959 contain @samp{<} to indicate that this column should start a group,
1960 @samp{>} to indicate the end of a column, or @samp{<>} to make a column
1961 a group of its own. Boundaries between column groups will upon export be
1962 marked with vertical lines. Here is an example:
1965 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
1966 |---+-----+-----+-----+---------+------------|
1967 | / | < | | > | < | > |
1968 | 1 | 1 | 1 | 1 | 1 | 1 |
1969 | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
1970 | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
1971 |---+-----+-----+-----+---------+------------|
1972 #+TBLFM: $2=$1^2::$3=$1^3::$4=$1^4::$5=sqrt($1)::$6=sqrt(sqrt(($1)))
1975 It is also sufficient to just insert the column group starters after
1976 every vertical line you would like to have:
1979 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
1980 |----+-----+-----+-----+---------+------------|
1984 @node Orgtbl mode, The spreadsheet, Column groups, Tables
1985 @section The Orgtbl minor mode
1987 @cindex minor mode for tables
1989 If you like the intuitive way the Org table editor works, you
1990 might also want to use it in other modes like Text mode or Mail mode.
1991 The minor mode Orgtbl mode makes this possible. You can always toggle
1992 the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for
1993 example in mail mode, use
1996 (add-hook 'mail-mode-hook 'turn-on-orgtbl)
1999 Furthermore, with some special setup, it is possible to maintain tables
2000 in arbitrary syntax with Orgtbl mode. For example, it is possible to
2001 construct La@TeX{} tables with the underlying ease and power of
2002 Orgtbl mode, including spreadsheet capabilities. For details, see
2003 @ref{Tables in arbitrary syntax}.
2005 @node The spreadsheet, Org-Plot, Orgtbl mode, Tables
2006 @section The spreadsheet
2007 @cindex calculations, in tables
2008 @cindex spreadsheet capabilities
2009 @cindex @file{calc} package
2011 The table editor makes use of the Emacs @file{calc} package to implement
2012 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
2013 derive fields from other fields. While fully featured, Org's implementation
2014 is not identical to other spreadsheets. For example, Org knows the concept
2015 of a @emph{column formula} that will be applied to all non-header fields in a
2016 column without having to copy the formula to each relevant field. There is
2017 also a formula debugger, and a formula editor with features for highlighting
2018 fields in the table corresponding to the references at the point in the
2019 formula, moving these references by arrow keys
2022 * References:: How to refer to another field or range
2023 * Formula syntax for Calc:: Using Calc to compute stuff
2024 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
2025 * Field formulas:: Formulas valid for a single field
2026 * Column formulas:: Formulas valid for an entire column
2027 * Editing and debugging formulas:: Fixing formulas
2028 * Updating the table:: Recomputing all dependent fields
2029 * Advanced features:: Field names, parameters and automatic recalc
2032 @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet
2033 @subsection References
2036 To compute fields in the table from other fields, formulas must
2037 reference other fields or ranges. In Org, fields can be referenced
2038 by name, by absolute coordinates, and by relative coordinates. To find
2039 out what the coordinates of a field are, press @kbd{C-c ?} in that
2040 field, or press @kbd{C-c @}} to toggle the display of a grid.
2042 @subsubheading Field references
2043 @cindex field references
2044 @cindex references, to fields
2046 Formulas can reference the value of another field in two ways. Like in
2047 any other spreadsheet, you may reference fields with a letter/number
2048 combination like @code{B3}, meaning the 2nd field in the 3rd row.
2049 @c Such references are always fixed to that field, they don't change
2050 @c when you copy and paste a formula to a different field. So
2051 @c Org's @code{B3} behaves like @code{$B$3} in other spreadsheets.
2054 Org also uses another, more general operator that looks like this:
2056 @@@var{row}$@var{column}
2060 Column references can be absolute like @samp{1}, @samp{2},...@samp{@var{N}},
2061 or relative to the current column like @samp{+1} or @samp{-2}.
2063 The row specification only counts data lines and ignores horizontal
2064 separator lines (hlines). You can use absolute row numbers
2065 @samp{1}...@samp{@var{N}}, and row numbers relative to the current row like
2066 @samp{+3} or @samp{-1}. Or specify the row relative to one of the
2067 hlines: @samp{I} refers to the first hline@footnote{Note that only
2068 hlines are counted that @emph{separate} table lines. If the table
2069 starts with a hline above the header, it does not count.}, @samp{II} to
2070 the second, etc@. @samp{-I} refers to the first such line above the
2071 current line, @samp{+I} to the first such line below the current line.
2072 You can also write @samp{III+2} which is the second data line after the
2073 third hline in the table.
2075 @samp{0} refers to the current row and column. Also, if you omit
2076 either the column or the row part of the reference, the current
2077 row/column is implied.
2079 Org's references with @emph{unsigned} numbers are fixed references
2080 in the sense that if you use the same reference in the formula for two
2081 different fields, the same field will be referenced each time.
2082 Org's references with @emph{signed} numbers are floating
2083 references because the same reference operator can reference different
2084 fields depending on the field being calculated by the formula.
2086 As a special case, references like @samp{$LR5} and @samp{$LR12} can be used
2087 to refer in a stable way to the 5th and 12th field in the last row of the
2090 Here are a few examples:
2093 @@2$3 @r{2nd row, 3rd column}
2094 C2 @r{same as previous}
2095 $5 @r{column 5 in the current row}
2096 E& @r{same as previous}
2097 @@2 @r{current column, row 2}
2098 @@-1$-3 @r{the field one row up, three columns to the left}
2099 @@-I$2 @r{field just under hline above current row, column 2}
2102 @subsubheading Range references
2103 @cindex range references
2104 @cindex references, to ranges
2106 You may reference a rectangular range of fields by specifying two field
2107 references connected by two dots @samp{..}. If both fields are in the
2108 current row, you may simply use @samp{$2..$7}, but if at least one field
2109 is in a different row, you need to use the general @code{@@row$column}
2110 format at least for the first field (i.e the reference must start with
2111 @samp{@@} in order to be interpreted correctly). Examples:
2114 $1..$3 @r{First three fields in the current row.}
2115 $P..$Q @r{Range, using column names (see under Advanced)}
2116 @@2$1..@@4$3 @r{6 fields between these two fields.}
2117 A2..C4 @r{Same as above.}
2118 @@-1$-2..@@-1 @r{3 numbers from the column to the left, 2 up to current row}
2121 @noindent Range references return a vector of values that can be fed
2122 into Calc vector functions. Empty fields in ranges are normally
2123 suppressed, so that the vector contains only the non-empty fields (but
2124 see the @samp{E} mode switch below). If there are no non-empty fields,
2125 @samp{[0]} is returned to avoid syntax errors in formulas.
2127 @subsubheading Field coordinates in formulas
2128 @cindex field coordinates
2129 @cindex coordinates, of field
2130 @cindex row, of field coordinates
2131 @cindex column, of field coordinates
2133 For Calc formulas and Lisp formulas @code{@@#} and @code{$#} can be used to
2134 get the row or column number of the field where the formula result goes.
2135 The traditional Lisp formula equivalents are @code{org-table-current-dline}
2136 and @code{org-table-current-column}. Examples:
2139 if(@@# % 2, $#, string("")) @r{column number on odd lines only}
2140 $3 = remote(FOO, @@@@#$2) @r{copy column 2 from table FOO into}
2141 @r{column 3 of the current table}
2144 @noindent For the second example, table FOO must have at least as many rows
2145 as the current table. Inefficient@footnote{The computation time scales as
2146 O(N^2) because table FOO is parsed for each field to be copied.} for large
2149 @subsubheading Named references
2150 @cindex named references
2151 @cindex references, named
2152 @cindex name, of column or field
2153 @cindex constants, in calculations
2156 @vindex org-table-formula-constants
2157 @samp{$name} is interpreted as the name of a column, parameter or
2158 constant. Constants are defined globally through the variable
2159 @code{org-table-formula-constants}, and locally (for the file) through a
2163 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
2167 @vindex constants-unit-system
2168 @pindex constants.el
2169 Also properties (@pxref{Properties and Columns}) can be used as
2170 constants in table formulas: for a property @samp{:Xyz:} use the name
2171 @samp{$PROP_Xyz}, and the property will be searched in the current
2172 outline entry and in the hierarchy above it. If you have the
2173 @file{constants.el} package, it will also be used to resolve constants,
2174 including natural constants like @samp{$h} for Planck's constant, and
2175 units like @samp{$km} for kilometers@footnote{@file{constants.el} can
2176 supply the values of constants in two different unit systems, @code{SI}
2177 and @code{cgs}. Which one is used depends on the value of the variable
2178 @code{constants-unit-system}. You can use the @code{#+STARTUP} options
2179 @code{constSI} and @code{constcgs} to set this value for the current
2180 buffer.}. Column names and parameters can be specified in special table
2181 lines. These are described below, see @ref{Advanced features}. All
2182 names must start with a letter, and further consist of letters and
2185 @subsubheading Remote references
2186 @cindex remote references
2187 @cindex references, remote
2188 @cindex references, to a different table
2189 @cindex name, of column or field
2190 @cindex constants, in calculations
2193 You may also reference constants, fields and ranges from a different table,
2194 either in the current file or even in a different file. The syntax is
2197 remote(NAME-OR-ID,REF)
2201 where NAME can be the name of a table in the current file as set by a
2202 @code{#+TBLNAME: NAME} line before the table. It can also be the ID of an
2203 entry, even in a different file, and the reference then refers to the first
2204 table in that entry. REF is an absolute field or range reference as
2205 described above for example @code{@@3$3} or @code{$somename}, valid in the
2208 @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet
2209 @subsection Formula syntax for Calc
2210 @cindex formula syntax, Calc
2211 @cindex syntax, of formulas
2213 A formula can be any algebraic expression understood by the Emacs
2214 @file{Calc} package. @b{Note that @file{calc} has the
2215 non-standard convention that @samp{/} has lower precedence than
2216 @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.} Before
2217 evaluation by @code{calc-eval} (@pxref{Calling Calc from
2218 Your Programs,calc-eval,Calling Calc from Your Lisp Programs,Calc,GNU
2219 Emacs Calc Manual}),
2220 @c FIXME: The link to the Calc manual in HTML does not work.
2221 variable substitution takes place according to the rules described above.
2222 @cindex vectors, in table calculations
2223 The range vectors can be directly fed into the Calc vector functions
2224 like @samp{vmean} and @samp{vsum}.
2226 @cindex format specifier
2227 @cindex mode, for @file{calc}
2228 @vindex org-calc-default-modes
2229 A formula can contain an optional mode string after a semicolon. This
2230 string consists of flags to influence Calc and other modes during
2231 execution. By default, Org uses the standard Calc modes (precision
2232 12, angular units degrees, fraction and symbolic modes off). The display
2233 format, however, has been changed to @code{(float 8)} to keep tables
2234 compact. The default settings can be configured using the variable
2235 @code{org-calc-default-modes}.
2238 p20 @r{set the internal Calc calculation precision to 20 digits}
2239 n3 s3 e2 f4 @r{Normal, scientific, engineering, or fixed}
2240 @r{format of the result of Calc passed back to Org.}
2241 @r{Calc formatting is unlimited in precision as}
2242 @r{long as the Calc calculation precision is greater.}
2243 D R @r{angle modes: degrees, radians}
2244 F S @r{fraction and symbolic modes}
2245 N @r{interpret all fields as numbers, use 0 for non-numbers}
2246 T @r{force text interpretation}
2247 E @r{keep empty fields in ranges}
2252 Unless you use large integer numbers or high-precision-calculation
2253 and -display for floating point numbers you may alternatively provide a
2254 @code{printf} format specifier to reformat the Calc result after it has been
2255 passed back to Org instead of letting Calc already do the
2256 formatting@footnote{The @code{printf} reformatting is limited in precision
2257 because the value passed to it is converted into an @code{integer} or
2258 @code{double}. The @code{integer} is limited in size by truncating the
2259 signed value to 32 bits. The @code{double} is limited in precision to 64
2260 bits overall which leaves approximately 16 significant decimal digits.}.
2264 $1+$2 @r{Sum of first and second field}
2265 $1+$2;%.2f @r{Same, format result to two decimals}
2266 exp($2)+exp($1) @r{Math functions can be used}
2267 $0;%.1f @r{Reformat current cell to 1 decimal}
2268 ($3-32)*5/9 @r{Degrees F -> C conversion}
2269 $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}}
2270 tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1}
2271 sin($1);Dp3%.1e @r{Same, but use printf specifier for display}
2272 vmean($2..$7) @r{Compute column range mean, using vector function}
2273 vmean($2..$7);EN @r{Same, but treat empty fields as 0}
2274 taylor($3,x=7,2) @r{taylor series of $3, at x=7, second degree}
2277 Calc also contains a complete set of logical operations. For example
2280 if($1<20,teen,string("")) @r{``teen'' if age $1 less than 20, else empty}
2283 @node Formula syntax for Lisp, Field formulas, Formula syntax for Calc, The spreadsheet
2284 @subsection Emacs Lisp forms as formulas
2285 @cindex Lisp forms, as table formulas
2287 It is also possible to write a formula in Emacs Lisp; this can be useful
2288 for string manipulation and control structures, if Calc's
2289 functionality is not enough. If a formula starts with a single-quote
2290 followed by an opening parenthesis, then it is evaluated as a Lisp form.
2291 The evaluation should return either a string or a number. Just as with
2292 @file{calc} formulas, you can specify modes and a printf format after a
2293 semicolon. With Emacs Lisp forms, you need to be conscious about the way
2294 field references are interpolated into the form. By default, a
2295 reference will be interpolated as a Lisp string (in double-quotes)
2296 containing the field. If you provide the @samp{N} mode switch, all
2297 referenced elements will be numbers (non-number fields will be zero) and
2298 interpolated as Lisp numbers, without quotes. If you provide the
2299 @samp{L} flag, all fields will be interpolated literally, without quotes.
2300 I.e., if you want a reference to be interpreted as a string by the Lisp
2301 form, enclose the reference operator itself in double-quotes, like
2302 @code{"$3"}. Ranges are inserted as space-separated fields, so you can
2303 embed them in list or vector syntax. A few examples, note how the
2304 @samp{N} mode is used when we do computations in Lisp.
2307 @r{Swap the first two characters of the content of column 1}
2308 '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
2309 @r{Add columns 1 and 2, equivalent to Calc's @code{$1+$2}}
2311 @r{Compute the sum of columns 1-4, like Calc's @code{vsum($1..$4)}}
2312 '(apply '+ '($1..$4));N
2315 @node Field formulas, Column formulas, Formula syntax for Lisp, The spreadsheet
2316 @subsection Field formulas
2317 @cindex field formula
2318 @cindex formula, for individual table field
2320 To assign a formula to a particular field, type it directly into the
2321 field, preceded by @samp{:=}, for example @samp{:=$1+$2}. When you
2322 press @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in
2323 the field, the formula will be stored as the formula for this field,
2324 evaluated, and the current field replaced with the result.
2327 Formulas are stored in a special line starting with @samp{#+TBLFM:}
2328 directly below the table. If you typed the equation in the 4th field of
2329 the 3rd data line in the table, the formula will look like
2330 @samp{@@3$4=$1+$2}. When inserting/deleting/swapping column and rows
2331 with the appropriate commands, @i{absolute references} (but not relative
2332 ones) in stored formulas are modified in order to still reference the
2333 same field. Of course this is not true if you edit the table structure
2334 with normal editing commands---then you must fix the equations yourself.
2335 The left-hand side of a formula may also be a named field (@pxref{Advanced
2336 features}), or a last-row reference like @samp{$LR3}.
2338 Instead of typing an equation into the field, you may also use the
2344 Install a new formula for the current field. The command prompts for a
2345 formula with default taken from the @samp{#+TBLFM:} line, applies
2346 it to the current field, and stores it.
2349 @node Column formulas, Editing and debugging formulas, Field formulas, The spreadsheet
2350 @subsection Column formulas
2351 @cindex column formula
2352 @cindex formula, for table column
2354 Often in a table, the same formula should be used for all fields in a
2355 particular column. Instead of having to copy the formula to all fields
2356 in that column, Org allows you to assign a single formula to an entire
2357 column. If the table contains horizontal separator hlines, everything
2358 before the first such line is considered part of the table @emph{header}
2359 and will not be modified by column formulas.
2361 To assign a formula to a column, type it directly into any field in the
2362 column, preceded by an equal sign, like @samp{=$1+$2}. When you press
2363 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2364 the formula will be stored as the formula for the current column, evaluated
2365 and the current field replaced with the result. If the field contains only
2366 @samp{=}, the previously stored formula for this column is used. For each
2367 column, Org will only remember the most recently used formula. In the
2368 @samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}. The left-hand
2369 side of a column formula cannot currently be the name of column, it
2370 must be the numeric column reference.
2372 Instead of typing an equation into the field, you may also use the
2378 Install a new formula for the current column and replace current field with
2379 the result of the formula. The command prompts for a formula, with default
2380 taken from the @samp{#+TBLFM} line, applies it to the current field and
2381 stores it. With a numeric prefix argument(e.g. @kbd{C-5 C-c =}) the command
2382 will apply it to that many consecutive fields in the current column.
2385 @node Editing and debugging formulas, Updating the table, Column formulas, The spreadsheet
2386 @subsection Editing and debugging formulas
2387 @cindex formula editing
2388 @cindex editing, of table formulas
2390 @vindex org-table-use-standard-references
2391 You can edit individual formulas in the minibuffer or directly in the
2392 field. Org can also prepare a special buffer with all active
2393 formulas of a table. When offering a formula for editing, Org
2394 converts references to the standard format (like @code{B3} or @code{D&})
2395 if possible. If you prefer to only work with the internal format (like
2396 @code{@@3$2} or @code{$4}), configure the variable
2397 @code{org-table-use-standard-references}.
2404 Edit the formula associated with the current column/field in the
2405 minibuffer. See @ref{Column formulas}, and @ref{Field formulas}.
2406 @kindex C-u C-u C-c =
2408 Re-insert the active formula (either a
2409 field formula, or a column formula) into the current field, so that you
2410 can edit it directly in the field. The advantage over editing in the
2411 minibuffer is that you can use the command @kbd{C-c ?}.
2414 While editing a formula in a table field, highlight the field(s)
2415 referenced by the reference at the cursor position in the formula.
2418 Toggle the display of row and column numbers for a table, using
2419 overlays. These are updated each time the table is aligned; you can
2420 force it with @kbd{C-c C-c}.
2423 Toggle the formula debugger on and off. See below.
2426 Edit all formulas for the current table in a special buffer, where the
2427 formulas will be displayed one per line. If the current field has an
2428 active formula, the cursor in the formula editor will mark it.
2429 While inside the special buffer, Org will automatically highlight
2430 any field or range reference at the cursor position. You may edit,
2431 remove and add formulas, and use the following commands:
2437 Exit the formula editor and store the modified formulas. With @kbd{C-u}
2438 prefix, also apply the new formulas to the entire table.
2441 Exit the formula editor without installing changes.
2444 Toggle all references in the formula editor between standard (like
2445 @code{B3}) and internal (like @code{@@3$2}).
2448 Pretty-print or indent Lisp formula at point. When in a line containing
2449 a Lisp formula, format the formula according to Emacs Lisp rules.
2450 Another @key{TAB} collapses the formula back again. In the open
2451 formula, @key{TAB} re-indents just like in Emacs Lisp mode.
2454 Complete Lisp symbols, just like in Emacs Lisp mode.
2456 @kindex S-@key{down}
2457 @kindex S-@key{left}
2458 @kindex S-@key{right}
2459 @item S-@key{up}/@key{down}/@key{left}/@key{right}
2460 Shift the reference at point. For example, if the reference is
2461 @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
2462 This also works for relative references and for hline references.
2463 @kindex M-S-@key{up}
2464 @kindex M-S-@key{down}
2465 @item M-S-@key{up}/@key{down}
2466 Move the test line for column formulas in the Org buffer up and
2469 @kindex M-@key{down}
2470 @item M-@key{up}/@key{down}
2471 Scroll the window displaying the table.
2474 Turn the coordinate grid in the table on and off.
2478 Making a table field blank does not remove the formula associated with
2479 the field, because that is stored in a different line (the @samp{#+TBLFM}
2480 line)---during the next recalculation the field will be filled again.
2481 To remove a formula from a field, you have to give an empty reply when
2482 prompted for the formula, or to edit the @samp{#+TBLFM} line.
2485 You may edit the @samp{#+TBLFM} directly and re-apply the changed
2486 equations with @kbd{C-c C-c} in that line or with the normal
2487 recalculation commands in the table.
2489 @subsubheading Debugging formulas
2490 @cindex formula debugging
2491 @cindex debugging, of table formulas
2492 When the evaluation of a formula leads to an error, the field content
2493 becomes the string @samp{#ERROR}. If you would like see what is going
2494 on during variable substitution and calculation in order to find a bug,
2495 turn on formula debugging in the @code{Tbl} menu and repeat the
2496 calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
2497 field. Detailed information will be displayed.
2499 @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet
2500 @subsection Updating the table
2501 @cindex recomputing table fields
2502 @cindex updating, table
2504 Recalculation of a table is normally not automatic, but needs to be
2505 triggered by a command. See @ref{Advanced features}, for a way to make
2506 recalculation at least semi-automatic.
2508 In order to recalculate a line of a table or the entire table, use the
2514 Recalculate the current row by first applying the stored column formulas
2515 from left to right, and all field formulas in the current row.
2521 Recompute the entire table, line by line. Any lines before the first
2522 hline are left alone, assuming that these are part of the table header.
2524 @kindex C-u C-u C-c *
2525 @kindex C-u C-u C-c C-c
2527 @itemx C-u C-u C-c C-c
2528 Iterate the table by recomputing it until no further changes occur.
2529 This may be necessary if some computed fields use the value of other
2530 fields that are computed @i{later} in the calculation sequence.
2531 @item M-x org-table-recalculate-buffer-tables
2532 Recompute all tables in the current buffer.
2533 @item M-x org-table-iterate-buffer-tables
2534 Iterate all tables in the current buffer, in order to converge table-to-table
2538 @node Advanced features, , Updating the table, The spreadsheet
2539 @subsection Advanced features
2541 If you want the recalculation of fields to happen automatically, or if
2542 you want to be able to assign @i{names} to fields and columns, you need
2543 to reserve the first column of the table for special marking characters.
2547 Rotate the calculation mark in first column through the states @samp{ },
2548 @samp{#}, @samp{*}, @samp{!}, @samp{$}. When there is an active region,
2549 change all marks in the region.
2552 Here is an example of a table that collects exam results of students and
2553 makes use of these features:
2557 |---+---------+--------+--------+--------+-------+------|
2558 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
2559 |---+---------+--------+--------+--------+-------+------|
2560 | ! | | P1 | P2 | P3 | Tot | |
2561 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
2562 | ^ | | m1 | m2 | m3 | mt | |
2563 |---+---------+--------+--------+--------+-------+------|
2564 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
2565 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
2566 |---+---------+--------+--------+--------+-------+------|
2567 | | Average | | | | 29.7 | |
2568 | ^ | | | | | at | |
2569 | $ | max=50 | | | | | |
2570 |---+---------+--------+--------+--------+-------+------|
2571 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
2575 @noindent @b{Important}: please note that for these special tables,
2576 recalculating the table with @kbd{C-u C-c *} will only affect rows that
2577 are marked @samp{#} or @samp{*}, and fields that have a formula assigned
2578 to the field itself. The column formulas are not applied in rows with
2581 @cindex marking characters, tables
2582 The marking characters have the following meaning:
2585 The fields in this line define names for the columns, so that you may
2586 refer to a column as @samp{$Tot} instead of @samp{$6}.
2588 This row defines names for the fields @emph{above} the row. With such
2589 a definition, any formula in the table may use @samp{$m1} to refer to
2590 the value @samp{10}. Also, if you assign a formula to a names field, it
2591 will be stored as @samp{$name=...}.
2593 Similar to @samp{^}, but defines names for the fields in the row
2596 Fields in this row can define @emph{parameters} for formulas. For
2597 example, if a field in a @samp{$} row contains @samp{max=50}, then
2598 formulas in this table can refer to the value 50 using @samp{$max}.
2599 Parameters work exactly like constants, only that they can be defined on
2602 Fields in this row are automatically recalculated when pressing
2603 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row
2604 is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked
2605 lines will be left alone by this command.
2607 Selects this line for global recalculation with @kbd{C-u C-c *}, but
2608 not for automatic recalculation. Use this when automatic
2609 recalculation slows down editing too much.
2611 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
2612 All lines that should be recalculated should be marked with @samp{#}
2615 Do not export this line. Useful for lines that contain the narrowing
2616 @samp{<N>} markers or column group markers.
2619 Finally, just to whet your appetite for what can be done with the
2620 fantastic @file{calc.el} package, here is a table that computes the Taylor
2621 series of degree @code{n} at location @code{x} for a couple of
2626 |---+-------------+---+-----+--------------------------------------|
2627 | | Func | n | x | Result |
2628 |---+-------------+---+-----+--------------------------------------|
2629 | # | exp(x) | 1 | x | 1 + x |
2630 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
2631 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
2632 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
2633 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
2634 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
2635 |---+-------------+---+-----+--------------------------------------|
2636 #+TBLFM: $5=taylor($2,$4,$3);n3
2640 @node Org-Plot, , The spreadsheet, Tables
2642 @cindex graph, in tables
2643 @cindex plot tables using Gnuplot
2646 Org-Plot can produce 2D and 3D graphs of information stored in org tables
2647 using @file{Gnuplot} @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
2648 @uref{http://cars9.uchicago.edu/~ravel/software/gnuplot-mode.html}. To see
2649 this in action, ensure that you have both Gnuplot and Gnuplot mode installed
2650 on your system, then call @code{org-plot/gnuplot} on the following table.
2654 #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
2655 | Sede | Max cites | H-index |
2656 |-----------+-----------+---------|
2657 | Chile | 257.72 | 21.39 |
2658 | Leeds | 165.77 | 19.68 |
2659 | Sao Paolo | 71.00 | 11.50 |
2660 | Stockholm | 134.19 | 14.33 |
2661 | Morelia | 257.56 | 17.67 |
2665 Notice that Org Plot is smart enough to apply the table's headers as labels.
2666 Further control over the labels, type, content, and appearance of plots can
2667 be exercised through the @code{#+PLOT:} lines preceding a table. See below
2668 for a complete list of Org-plot options. For more information and examples
2669 see the Org-plot tutorial at
2670 @uref{http://orgmode.org/worg/org-tutorials/org-plot.php}.
2672 @subsubheading Plot Options
2676 Specify any @command{gnuplot} option to be set when graphing.
2679 Specify the title of the plot.
2682 Specify which column of the table to use as the @code{x} axis.
2685 Specify the columns to graph as a Lisp style list, surrounded by parentheses
2686 and separated by spaces for example @code{dep:(3 4)} to graph the third and
2687 fourth columns (defaults to graphing all other columns aside from the @code{ind}
2691 Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
2694 Specify a @code{with} option to be inserted for every col being plotted
2695 (e.g. @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
2696 Defaults to @code{lines}.
2699 If you want to plot to a file, specify @code{"@var{path/to/desired/output-file}"}.
2702 List of labels to be used for the deps (defaults to the column headers if
2706 Specify an entire line to be inserted in the Gnuplot script.
2709 When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
2710 flat mapping rather than a @code{3d} slope.
2713 Specify format of Org-mode timestamps as they will be parsed by Gnuplot.
2714 Defaults to @samp{%Y-%m-%d-%H:%M:%S}.
2717 If you want total control, you can specify a script file (place the file name
2718 between double-quotes) which will be used to plot. Before plotting, every
2719 instance of @code{$datafile} in the specified script will be replaced with
2720 the path to the generated data file. Note: even if you set this option, you
2721 may still want to specify the plot type, as that can impact the content of
2725 @node Hyperlinks, TODO Items, Tables, Top
2729 Like HTML, Org provides links inside a file, external links to
2730 other files, Usenet articles, emails, and much more.
2733 * Link format:: How links in Org are formatted
2734 * Internal links:: Links to other places in the current file
2735 * External links:: URL-like links to the world
2736 * Handling links:: Creating, inserting and following
2737 * Using links outside Org:: Linking from my C source code?
2738 * Link abbreviations:: Shortcuts for writing complex links
2739 * Search options:: Linking to a specific location
2740 * Custom searches:: When the default search is not enough
2743 @node Link format, Internal links, Hyperlinks, Hyperlinks
2744 @section Link format
2746 @cindex format, of links
2748 Org will recognize plain URL-like links and activate them as
2749 clickable links. The general link format, however, looks like this:
2752 [[link][description]] @r{or alternatively} [[link]]
2756 Once a link in the buffer is complete (all brackets present), Org
2757 will change the display so that @samp{description} is displayed instead
2758 of @samp{[[link][description]]} and @samp{link} is displayed instead of
2759 @samp{[[link]]}. Links will be highlighted in the face @code{org-link},
2760 which by default is an underlined face. You can directly edit the
2761 visible part of a link. Note that this can be either the @samp{link}
2762 part (if there is no description) or the @samp{description} part. To
2763 edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
2766 If you place the cursor at the beginning or just behind the end of the
2767 displayed text and press @key{BACKSPACE}, you will remove the
2768 (invisible) bracket at that location. This makes the link incomplete
2769 and the internals are again displayed as plain text. Inserting the
2770 missing bracket hides the link internals again. To show the
2771 internal structure of all links, use the menu entry
2772 @code{Org->Hyperlinks->Literal links}.
2774 @node Internal links, External links, Link format, Hyperlinks
2775 @section Internal links
2776 @cindex internal links
2777 @cindex links, internal
2778 @cindex targets, for links
2780 @cindex property, CUSTOM_ID
2781 If the link does not look like a URL, it is considered to be internal in the
2782 current file. The most important case is a link like
2783 @samp{[[#my-custom-id]]} which will link to the entry with the
2784 @code{CUSTOM_ID} property @samp{my-custom-id}. Such custom IDs are very good
2785 for HTML export (@pxref{HTML export}) where they produce pretty section
2786 links. You are responsible yourself to make sure these custom IDs are unique
2789 Links such as @samp{[[My Target]]} or @samp{[[My Target][Find my target]]}
2790 lead to a text search in the current file.
2792 The link can be followed with @kbd{C-c C-o} when the cursor is on the link,
2793 or with a mouse click (@pxref{Handling links}). Links to custom IDs will
2794 point to the corresponding headline. The preferred match for a text link is
2795 a @i{dedicated target}: the same string in double angular brackets. Targets
2796 may be located anywhere; sometimes it is convenient to put them into a
2797 comment line. For example
2803 @noindent In HTML export (@pxref{HTML export}), such targets will become
2804 named anchors for direct access through @samp{http} links@footnote{Note that
2805 text before the first headline is usually not exported, so the first such
2806 target should be after the first headline, or in the line directly before the
2809 If no dedicated target exists, Org will search for the words in the link. In
2810 the above example the search would be for @samp{my target}. Links starting
2811 with a star like @samp{*My Target} restrict the search to
2812 headlines@footnote{To insert a link targeting a headline, in-buffer
2813 completion can be used. Just type a star followed by a few optional letters
2814 into the buffer and press @kbd{M-@key{TAB}}. All headlines in the current
2815 buffer will be offered as completions. @xref{Handling links}, for more
2816 commands creating links.}. When searching, Org-mode will first try an
2817 exact match, but then move on to more and more lenient searches. For
2818 example, the link @samp{[[*My Targets]]} will find any of the following:
2822 ** TODO my targets are bright
2823 ** my 20 targets are
2827 Following a link pushes a mark onto Org's own mark ring. You can
2828 return to the previous position with @kbd{C-c &}. Using this command
2829 several times in direct succession goes back to positions recorded
2833 * Radio targets:: Make targets trigger links in plain text
2836 @node Radio targets, , Internal links, Internal links
2837 @subsection Radio targets
2838 @cindex radio targets
2839 @cindex targets, radio
2840 @cindex links, radio targets
2842 Org can automatically turn any occurrences of certain target names
2843 in normal text into a link. So without explicitly creating a link, the
2844 text connects to the target radioing its position. Radio targets are
2845 enclosed by triple angular brackets. For example, a target @samp{<<<My
2846 Target>>>} causes each occurrence of @samp{my target} in normal text to
2847 become activated as a link. The Org file is scanned automatically
2848 for radio targets only when the file is first loaded into Emacs. To
2849 update the target list during editing, press @kbd{C-c C-c} with the
2850 cursor on or at a target.
2852 @node External links, Handling links, Internal links, Hyperlinks
2853 @section External links
2854 @cindex links, external
2855 @cindex external links
2856 @cindex links, external
2864 @cindex WANDERLUST links
2866 @cindex USENET links
2871 Org supports links to files, websites, Usenet and email messages,
2872 BBDB database entries and links to both IRC conversations and their
2873 logs. External links are URL-like locators. They start with a short
2874 identifying string followed by a colon. There can be no space after
2875 the colon. The following list shows examples for each link type.
2878 http://www.astro.uva.nl/~dominik @r{on the web}
2879 doi:10.1000/182 @r{DOI for an electronic resource}
2880 file:/home/dominik/images/jupiter.jpg @r{file, absolute path}
2881 /home/dominik/images/jupiter.jpg @r{same as above}
2882 file:papers/last.pdf @r{file, relative path}
2883 ./papers/last.pdf @r{same as above}
2884 file:/myself@@some.where:papers/last.pdf @r{file, path on remote machine}
2885 /myself@@some.where:papers/last.pdf @r{same as above}
2886 file:sometextfile::NNN @r{file with line number to jump to}
2887 file:projects.org @r{another Org file}
2888 file:projects.org::some words @r{text search in Org file}
2889 file:projects.org::*task title @r{heading search in Org file}
2890 docview:papers/last.pdf::NNN @r{open file in doc-view mode at page NNN}
2891 id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID}
2892 news:comp.emacs @r{Usenet link}
2893 mailto:adent@@galaxy.net @r{Mail link}
2894 vm:folder @r{VM folder link}
2895 vm:folder#id @r{VM message link}
2896 vm://myself@@some.where.org/folder#id @r{VM on remote machine}
2897 wl:folder @r{WANDERLUST folder link}
2898 wl:folder#id @r{WANDERLUST message link}
2899 mhe:folder @r{MH-E folder link}
2900 mhe:folder#id @r{MH-E message link}
2901 rmail:folder @r{RMAIL folder link}
2902 rmail:folder#id @r{RMAIL message link}
2903 gnus:group @r{Gnus group link}
2904 gnus:group#id @r{Gnus article link}
2905 bbdb:R.*Stallman @r{BBDB link (with regexp)}
2906 irc:/irc.com/#emacs/bob @r{IRC link}
2907 info:org:External%20links @r{Info node link (with encoded space)}
2908 shell:ls *.org @r{A shell command}
2909 elisp:org-agenda @r{Interactive Elisp command}
2910 elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
2913 A link should be enclosed in double brackets and may contain a
2914 descriptive text to be displayed instead of the URL (@pxref{Link
2915 format}), for example:
2918 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
2922 If the description is a file name or URL that points to an image, HTML
2923 export (@pxref{HTML export}) will inline the image as a clickable
2924 button. If there is no description at all and the link points to an
2926 that image will be inlined into the exported HTML file.
2928 @cindex square brackets, around links
2929 @cindex plain text external links
2930 Org also finds external links in the normal text and activates them
2931 as links. If spaces must be part of the link (for example in
2932 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
2933 about the end of the link, enclose them in square brackets.
2935 @node Handling links, Using links outside Org, External links, Hyperlinks
2936 @section Handling links
2937 @cindex links, handling
2939 Org provides methods to create a link in the correct syntax, to
2940 insert it into an Org file, and to follow the link.
2944 @cindex storing links
2946 Store a link to the current location. This is a @emph{global} command (you
2947 must create the key binding yourself) which can be used in any buffer to
2948 create a link. The link will be stored for later insertion into an Org
2949 buffer (see below). What kind of link will be created depends on the current
2952 @b{Org-mode buffers}@*
2953 For Org files, if there is a @samp{<<target>>} at the cursor, the link points
2954 to the target. Otherwise it points to the current headline, which will also
2957 @vindex org-link-to-org-use-id
2958 @cindex property, CUSTOM_ID
2959 @cindex property, ID
2960 If the headline has a @code{CUSTOM_ID} property, a link to this custom ID
2961 will be stored. In addition or alternatively (depending on the value of
2962 @code{org-link-to-org-use-id}), a globally unique @code{ID} property will be
2963 created and/or used to construct a link. So using this command in Org
2964 buffers will potentially create two links: a human-readable from the custom
2965 ID, and one that is globally unique and works even if the entry is moved from
2966 file to file. Later, when inserting the link, you need to decide which one
2969 @b{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus}@*
2970 Pretty much all Emacs mail clients are supported. The link will point to the
2971 current article, or, in some GNUS buffers, to the group. The description is
2972 constructed from the author and the subject.
2974 @b{Web browsers: W3 and W3M}@*
2975 Here the link will be the current URL, with the page title as description.
2977 @b{Contacts: BBDB}@*
2978 Links created in a BBDB buffer will point to the current entry.
2981 @vindex org-irc-link-to-logs
2982 For IRC links, if you set the variable @code{org-irc-link-to-logs} to
2983 @code{t}, a @samp{file:/} style link to the relevant point in the logs for
2984 the current conversation is created. Otherwise an @samp{irc:/} style link to
2985 the user/channel/server under the point will be stored.
2988 For any other files, the link will point to the file, with a search string
2989 (@pxref{Search options}) pointing to the contents of the current line. If
2990 there is an active region, the selected words will form the basis of the
2991 search string. If the automatically created link is not working correctly or
2992 accurately enough, you can write custom functions to select the search string
2993 and to do the search for particular file types---see @ref{Custom searches}.
2994 The key binding @kbd{C-c l} is only a suggestion---see @ref{Installation}.
2997 When the cursor is in an agenda view, the created link points to the
2998 entry referenced by the current line.
3002 @cindex link completion
3003 @cindex completion, of links
3004 @cindex inserting links
3006 @vindex org-keep-stored-link-after-insertion
3007 Insert a link@footnote{ Note that you don't have to use this command to
3008 insert a link. Links in Org are plain text, and you can type or paste them
3009 straight into the buffer. By using this command, the links are automatically
3010 enclosed in double brackets, and you will be asked for the optional
3011 descriptive text.}. This prompts for a link to be inserted into the buffer.
3012 You can just type a link, using text for an internal link, or one of the link
3013 type prefixes mentioned in the examples above. The link will be inserted
3014 into the buffer@footnote{After insertion of a stored link, the link will be
3015 removed from the list of stored links. To keep it in the list later use, use
3016 a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
3017 @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
3018 If some text was selected when this command is called, the selected text
3019 becomes the default description.
3021 @b{Inserting stored links}@*
3022 All links stored during the
3023 current session are part of the history for this prompt, so you can access
3024 them with @key{up} and @key{down} (or @kbd{M-p/n}).
3026 @b{Completion support}@* Completion with @key{TAB} will help you to insert
3027 valid link prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
3028 defined through link abbreviations (@pxref{Link abbreviations}). If you
3029 press @key{RET} after inserting only the @var{prefix}, Org will offer
3030 specific completion support for some link types@footnote{This works by
3031 calling a special function @code{org-PREFIX-complete-link}.} For
3032 example, if you type @kbd{file @key{RET}}, file name completion (alternative
3033 access: @kbd{C-u C-c C-l}, see below) will be offered, and after @kbd{bbdb
3034 @key{RET}} you can complete contact names.
3036 @cindex file name completion
3037 @cindex completion, of file names
3039 When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
3040 a file will be inserted and you may use file name completion to select
3041 the name of the file. The path to the file is inserted relative to the
3042 directory of the current Org file, if the linked file is in the current
3043 directory or in a sub-directory of it, or if the path is written relative
3044 to the current directory using @samp{../}. Otherwise an absolute path
3045 is used, if possible with @samp{~/} for your home directory. You can
3046 force an absolute path with two @kbd{C-u} prefixes.
3048 @item C-c C-l @ @r{(with cursor on existing link)}
3049 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
3050 link and description parts of the link.
3052 @cindex following links
3055 @item C-c C-o @ @r{(or, if @code{org-return-follows-link} is set, also} @key{RET}
3056 @vindex org-file-apps
3057 Open link at point. This will launch a web browser for URLs (using
3058 @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
3059 the corresponding links, and execute the command in a shell link. When the
3060 cursor is on an internal link, this command runs the corresponding search.
3061 When the cursor is on a TAG list in a headline, it creates the corresponding
3062 TAGS view. If the cursor is on a timestamp, it compiles the agenda for that
3063 date. Furthermore, it will visit text and remote files in @samp{file:} links
3064 with Emacs and select a suitable application for local non-text files.
3065 Classification of files is based on file extension only. See option
3066 @code{org-file-apps}. If you want to override the default application and
3067 visit the file with Emacs, use a @kbd{C-u} prefix. If you want to avoid
3068 opening in Emacs, use a @kbd{C-u C-u} prefix.@*
3069 If the cursor is on a headline, but not on a link, offer all links in the
3070 headline and entry text.
3076 On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
3077 would. Under Emacs 22, @kbd{mouse-1} will also follow a link.
3081 @vindex org-display-internal-link-with-indirect-buffer
3082 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
3083 internal links to be displayed in another window@footnote{See the
3084 variable @code{org-display-internal-link-with-indirect-buffer}}.
3086 @cindex inlining images
3087 @cindex images, inlining
3090 Toggle the inline display of linked images. Normally this will only inline
3091 images that have no description part in the link, i.e. images that will also
3092 be inlined during export. When called with a prefix argument, also display
3093 images that do have a link description.
3097 Push the current position onto the mark ring, to be able to return
3098 easily. Commands following an internal link do this automatically.
3100 @cindex links, returning to
3103 Jump back to a recorded position. A position is recorded by the
3104 commands following internal links, and by @kbd{C-c %}. Using this
3105 command several times in direct succession moves through a ring of
3106 previously recorded positions.
3110 @cindex links, finding next/previous
3113 Move forward/backward to the next link in the buffer. At the limit of
3114 the buffer, the search fails once, and then wraps around. The key
3115 bindings for this are really too long, you might want to bind this also
3116 to @kbd{C-n} and @kbd{C-p}
3118 (add-hook 'org-load-hook
3120 (define-key 'org-mode-map "\C-n" 'org-next-link)
3121 (define-key 'org-mode-map "\C-p" 'org-previous-link)))
3125 @node Using links outside Org, Link abbreviations, Handling links, Hyperlinks
3126 @section Using links outside Org
3128 You can insert and follow links that have Org syntax not only in
3129 Org, but in any Emacs buffer. For this, you should create two
3130 global commands, like this (please select suitable global keys
3134 (global-set-key "\C-c L" 'org-insert-link-global)
3135 (global-set-key "\C-c o" 'org-open-at-point-global)
3138 @node Link abbreviations, Search options, Using links outside Org, Hyperlinks
3139 @section Link abbreviations
3140 @cindex link abbreviations
3141 @cindex abbreviation, links
3143 Long URLs can be cumbersome to type, and often many similar links are
3144 needed in a document. For this you can use link abbreviations. An
3145 abbreviated link looks like this
3148 [[linkword:tag][description]]
3152 @vindex org-link-abbrev-alist
3153 where the tag is optional.
3154 The @i{linkword} must be a word, starting with a letter, followed by
3155 letters, numbers, @samp{-}, and @samp{_}. Abbreviations are resolved
3156 according to the information in the variable @code{org-link-abbrev-alist}
3157 that relates the linkwords to replacement text. Here is an example:
3161 (setq org-link-abbrev-alist
3162 '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
3163 ("google" . "http://www.google.com/search?q=")
3164 ("ads" . "http://adsabs.harvard.edu/cgi-bin/
3165 nph-abs_connect?author=%s&db_key=AST")))
3169 If the replacement text contains the string @samp{%s}, it will be
3170 replaced with the tag. Otherwise the tag will be appended to the string
3171 in order to create the link. You may also specify a function that will
3172 be called with the tag as the only argument to create the link.
3174 With the above setting, you could link to a specific bug with
3175 @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
3176 @code{[[google:OrgMode]]} and find out what the Org author is
3177 doing besides Emacs hacking with @code{[[ads:Dominik,C]]}.
3179 If you need special abbreviations just for a single Org buffer, you
3180 can define them in the file with
3184 #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
3185 #+LINK: google http://www.google.com/search?q=%s
3189 In-buffer completion (@pxref{Completion}) can be used after @samp{[} to
3190 complete link abbreviations. You may also define a function
3191 @code{org-PREFIX-complete-link} that implements special (e.g. completion)
3192 support for inserting such a link with @kbd{C-c C-l}. Such a function should
3193 not accept any arguments, and return the full link with prefix.
3195 @node Search options, Custom searches, Link abbreviations, Hyperlinks
3196 @section Search options in file links
3197 @cindex search option in file links
3198 @cindex file links, searching
3200 File links can contain additional information to make Emacs jump to a
3201 particular location in the file when following a link. This can be a
3202 line number or a search option after a double@footnote{For backward
3203 compatibility, line numbers can also follow a single colon.} colon. For
3204 example, when the command @kbd{C-c l} creates a link (@pxref{Handling
3205 links}) to a file, it encodes the words in the current line as a search
3206 string that can be used to find this line back later when following the
3207 link with @kbd{C-c C-o}.
3209 Here is the syntax of the different ways to attach a search to a file
3210 link, together with an explanation:
3213 [[file:~/code/main.c::255]]
3214 [[file:~/xx.org::My Target]]
3215 [[file:~/xx.org::*My Target]]
3216 [[file:~/xx.org::#my-custom-id]]
3217 [[file:~/xx.org::/regexp/]]
3224 Search for a link target @samp{<<My Target>>}, or do a text search for
3225 @samp{my target}, similar to the search in internal links, see
3226 @ref{Internal links}. In HTML export (@pxref{HTML export}), such a file
3227 link will become an HTML reference to the corresponding named anchor in
3230 In an Org file, restrict search to headlines.
3232 Link to a heading with a @code{CUSTOM_ID} property
3234 Do a regular expression search for @code{regexp}. This uses the Emacs
3235 command @code{occur} to list all matches in a separate window. If the
3236 target file is in Org-mode, @code{org-occur} is used to create a
3237 sparse tree with the matches.
3238 @c If the target file is a directory,
3239 @c @code{grep} will be used to search all files in the directory.
3242 As a degenerate case, a file link with an empty file name can be used
3243 to search the current file. For example, @code{[[file:::find me]]} does
3244 a search for @samp{find me} in the current file, just as
3245 @samp{[[find me]]} would.
3247 @node Custom searches, , Search options, Hyperlinks
3248 @section Custom Searches
3249 @cindex custom search strings
3250 @cindex search strings, custom
3252 The default mechanism for creating search strings and for doing the
3253 actual search related to a file link may not work correctly in all
3254 cases. For example, Bib@TeX{} database files have many entries like
3255 @samp{year="1993"} which would not result in good search strings,
3256 because the only unique identification for a Bib@TeX{} entry is the
3259 @vindex org-create-file-search-functions
3260 @vindex org-execute-file-search-functions
3261 If you come across such a problem, you can write custom functions to set
3262 the right search string for a particular file type, and to do the search
3263 for the string in the file. Using @code{add-hook}, these functions need
3264 to be added to the hook variables
3265 @code{org-create-file-search-functions} and
3266 @code{org-execute-file-search-functions}. See the docstring for these
3267 variables for more information. Org actually uses this mechanism
3268 for Bib@TeX{} database files, and you can use the corresponding code as
3269 an implementation example. See the file @file{org-bibtex.el}.
3271 @node TODO Items, Tags, Hyperlinks, Top
3275 Org-mode does not maintain TODO lists as separate documents@footnote{Of
3276 course, you can make a document that contains only long lists of TODO items,
3277 but this is not required.}. Instead, TODO items are an integral part of the
3278 notes file, because TODO items usually come up while taking notes! With Org
3279 mode, simply mark any entry in a tree as being a TODO item. In this way,
3280 information is not duplicated, and the entire context from which the TODO
3281 item emerged is always present.
3283 Of course, this technique for managing TODO items scatters them
3284 throughout your notes file. Org-mode compensates for this by providing
3285 methods to give you an overview of all the things that you have to do.
3288 * TODO basics:: Marking and displaying TODO entries
3289 * TODO extensions:: Workflow and assignments
3290 * Progress logging:: Dates and notes for progress
3291 * Priorities:: Some things are more important than others
3292 * Breaking down tasks:: Splitting a task into manageable pieces
3293 * Checkboxes:: Tick-off lists
3296 @node TODO basics, TODO extensions, TODO Items, TODO Items
3297 @section Basic TODO functionality
3299 Any headline becomes a TODO item when it starts with the word
3300 @samp{TODO}, for example:
3303 *** TODO Write letter to Sam Fortune
3307 The most important commands to work with TODO entries are:
3311 @cindex cycling, of TODO states
3313 Rotate the TODO state of the current item among
3316 ,-> (unmarked) -> TODO -> DONE --.
3317 '--------------------------------'
3320 The same rotation can also be done ``remotely'' from the timeline and
3321 agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}).
3325 Select a specific keyword using completion or (if it has been set up)
3326 the fast selection interface. For the latter, you need to assign keys
3327 to TODO states, see @ref{Per-file keywords}, and @ref{Setting tags}, for
3330 @kindex S-@key{right}
3331 @kindex S-@key{left}
3332 @vindex org-treat-S-cursor-todo-selection-as-state-change
3335 Select the following/preceding TODO state, similar to cycling. Useful
3336 mostly if more than two TODO states are possible (@pxref{TODO
3337 extensions}). See also @ref{Conflicts}, for a discussion of the interaction
3338 with @code{shift-selection-mode}. See also the variable
3339 @code{org-treat-S-cursor-todo-selection-as-state-change}.
3341 @cindex sparse tree, for TODO
3343 @vindex org-todo-keywords
3344 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds the
3345 entire buffer, but shows all TODO items (with not-DONE state) and the
3346 headings hierarchy above them. With a prefix argument (or by using @kbd{C-c
3347 / T}), search for a specific TODO. You will be prompted for the keyword, and
3348 you can also give a list of keywords like @code{KWD1|KWD2|...} to list
3349 entries that match any one of these keywords. With numeric prefix argument
3350 N, show the tree for the Nth keyword in the variable
3351 @code{org-todo-keywords}. With two prefix arguments, find all TODO states,
3352 both un-done and done.
3355 Show the global TODO list. Collects the TODO items (with not-DONE states)
3356 from all agenda files (@pxref{Agenda Views}) into a single buffer. The new
3357 buffer will be in @code{agenda-mode}, which provides commands to examine and
3358 manipulate the TODO entries from the new buffer (@pxref{Agenda commands}).
3359 @xref{Global TODO list}, for more information.
3360 @kindex S-M-@key{RET}
3362 Insert a new TODO entry below the current one.
3366 @vindex org-todo-state-tags-triggers
3367 Changing a TODO state can also trigger tag changes. See the docstring of the
3368 option @code{org-todo-state-tags-triggers} for details.
3370 @node TODO extensions, Progress logging, TODO basics, TODO Items
3371 @section Extended use of TODO keywords
3372 @cindex extended TODO keywords
3374 @vindex org-todo-keywords
3375 By default, marked TODO entries have one of only two states: TODO and
3376 DONE. Org-mode allows you to classify TODO items in more complex ways
3377 with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With
3378 special setup, the TODO keyword system can work differently in different
3381 Note that @i{tags} are another way to classify headlines in general and
3382 TODO items in particular (@pxref{Tags}).
3385 * Workflow states:: From TODO to DONE in steps
3386 * TODO types:: I do this, Fred does the rest
3387 * Multiple sets in one file:: Mixing it all, and still finding your way
3388 * Fast access to TODO states:: Single letter selection of a state
3389 * Per-file keywords:: Different files, different requirements
3390 * Faces for TODO keywords:: Highlighting states
3391 * TODO dependencies:: When one task needs to wait for others
3394 @node Workflow states, TODO types, TODO extensions, TODO extensions
3395 @subsection TODO keywords as workflow states
3396 @cindex TODO workflow
3397 @cindex workflow states as TODO keywords
3399 You can use TODO keywords to indicate different @emph{sequential} states
3400 in the process of working on an item, for example@footnote{Changing
3401 this variable only becomes effective after restarting Org-mode in a
3405 (setq org-todo-keywords
3406 '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
3409 The vertical bar separates the TODO keywords (states that @emph{need
3410 action}) from the DONE states (which need @emph{no further action}). If
3411 you don't provide the separator bar, the last state is used as the DONE
3413 @cindex completion, of TODO keywords
3414 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
3415 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED. You may
3416 also use a numeric prefix argument to quickly select a specific state. For
3417 example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY.
3418 Or you can use @kbd{S-@key{left}} to go backward through the sequence. If you
3419 define many keywords, you can use in-buffer completion
3420 (@pxref{Completion}) or even a special one-key selection scheme
3421 (@pxref{Fast access to TODO states}) to insert these words into the
3422 buffer. Changing a TODO state can be logged with a timestamp, see
3423 @ref{Tracking TODO state changes}, for more information.
3425 @node TODO types, Multiple sets in one file, Workflow states, TODO extensions
3426 @subsection TODO keywords as types
3428 @cindex names as TODO keywords
3429 @cindex types as TODO keywords
3431 The second possibility is to use TODO keywords to indicate different
3432 @emph{types} of action items. For example, you might want to indicate
3433 that items are for ``work'' or ``home''. Or, when you work with several
3434 people on a single project, you might want to assign action items
3435 directly to persons, by using their names as TODO keywords. This would
3436 be set up like this:
3439 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
3442 In this case, different keywords do not indicate a sequence, but rather
3443 different types. So the normal work flow would be to assign a task to a
3444 person, and later to mark it DONE. Org-mode supports this style by adapting
3445 the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
3446 @kbd{t} command in the timeline and agenda buffers.}. When used several
3447 times in succession, it will still cycle through all names, in order to first
3448 select the right type for a task. But when you return to the item after some
3449 time and execute @kbd{C-c C-t} again, it will switch from any name directly
3450 to DONE. Use prefix arguments or completion to quickly select a specific
3451 name. You can also review the items of a specific TODO type in a sparse tree
3452 by using a numeric prefix to @kbd{C-c / t}. For example, to see all things
3453 Lucy has to do, you would use @kbd{C-3 C-c / t}. To collect Lucy's items
3454 from all agenda files into a single buffer, you would use the numeric prefix
3455 argument as well when creating the global TODO list: @kbd{C-3 C-c a t}.
3457 @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions
3458 @subsection Multiple keyword sets in one file
3459 @cindex TODO keyword sets
3461 Sometimes you may want to use different sets of TODO keywords in
3462 parallel. For example, you may want to have the basic
3463 @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
3464 separate state indicating that an item has been canceled (so it is not
3465 DONE, but also does not require action). Your setup would then look
3469 (setq org-todo-keywords
3470 '((sequence "TODO" "|" "DONE")
3471 (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
3472 (sequence "|" "CANCELED")))
3475 The keywords should all be different, this helps Org-mode to keep track
3476 of which subsequence should be used for a given entry. In this setup,
3477 @kbd{C-c C-t} only operates within a subsequence, so it switches from
3478 @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
3479 (nothing) to @code{REPORT}. Therefore you need a mechanism to initially
3480 select the correct sequence. Besides the obvious ways like typing a
3481 keyword or using completion, you may also apply the following commands:
3484 @kindex C-S-@key{right}
3485 @kindex C-S-@key{left}
3486 @kindex C-u C-u C-c C-t
3487 @item C-u C-u C-c C-t
3488 @itemx C-S-@key{right}
3489 @itemx C-S-@key{left}
3490 These keys jump from one TODO subset to the next. In the above example,
3491 @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{right}} would jump from @code{TODO} or
3492 @code{DONE} to @code{REPORT}, and any of the words in the second row to
3493 @code{CANCELED}. Note that the @kbd{C-S-} key binding conflict with
3494 @code{shift-selection-mode} (@pxref{Conflicts}).
3495 @kindex S-@key{right}
3496 @kindex S-@key{left}
3499 @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through @emph{all}
3500 keywords from all sets, so for example @kbd{S-@key{<right>}} would switch
3501 from @code{DONE} to @code{REPORT} in the example above. See also
3502 @ref{Conflicts}, for a discussion of the interaction with
3503 @code{shift-selection-mode}.
3506 @node Fast access to TODO states, Per-file keywords, Multiple sets in one file, TODO extensions
3507 @subsection Fast access to TODO states
3509 If you would like to quickly change an entry to an arbitrary TODO state
3510 instead of cycling through the states, you can set up keys for
3511 single-letter access to the states. This is done by adding the section
3512 key after each keyword, in parentheses. For example:
3515 (setq org-todo-keywords
3516 '((sequence "TODO(t)" "|" "DONE(d)")
3517 (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
3518 (sequence "|" "CANCELED(c)")))
3521 @vindex org-fast-tag-selection-include-todo
3522 If you then press @code{C-c C-t} followed by the selection key, the entry
3523 will be switched to this state. @key{SPC} can be used to remove any TODO
3524 keyword from an entry.@footnote{Check also the variable
3525 @code{org-fast-tag-selection-include-todo}, it allows you to change the TODO
3526 state through the tags interface (@pxref{Setting tags}), in case you like to
3527 mingle the two concepts. Note that this means you need to come up with
3528 unique keys across both sets of keywords.}
3530 @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions
3531 @subsection Setting up keywords for individual files
3532 @cindex keyword options
3533 @cindex per-file keywords
3538 It can be very useful to use different aspects of the TODO mechanism in
3539 different files. For file-local settings, you need to add special lines
3540 to the file which set the keywords and interpretation for that file
3541 only. For example, to set one of the two examples discussed above, you
3542 need one of the following lines, starting in column zero anywhere in the
3546 #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
3548 @noindent (you may also write @code{#+SEQ_TODO} to be explicit about the
3549 interpretation, but it means the same as @code{#+TODO}), or
3551 #+TYP_TODO: Fred Sara Lucy Mike | DONE
3554 A setup for using several sets in parallel would be:
3558 #+TODO: REPORT BUG KNOWNCAUSE | FIXED
3562 @cindex completion, of option keywords
3564 @noindent To make sure you are using the correct keyword, type
3565 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
3567 @cindex DONE, final TODO keyword
3568 Remember that the keywords after the vertical bar (or the last keyword
3569 if no bar is there) must always mean that the item is DONE (although you
3570 may use a different word). After changing one of these lines, use
3571 @kbd{C-c C-c} with the cursor still in the line to make the changes
3572 known to Org-mode@footnote{Org-mode parses these lines only when
3573 Org-mode is activated after visiting a file. @kbd{C-c C-c} with the
3574 cursor in a line starting with @samp{#+} is simply restarting Org-mode
3575 for the current buffer.}.
3577 @node Faces for TODO keywords, TODO dependencies, Per-file keywords, TODO extensions
3578 @subsection Faces for TODO keywords
3579 @cindex faces, for TODO keywords
3581 @vindex org-todo @r{(face)}
3582 @vindex org-done @r{(face)}
3583 @vindex org-todo-keyword-faces
3584 Org-mode highlights TODO keywords with special faces: @code{org-todo}
3585 for keywords indicating that an item still has to be acted upon, and
3586 @code{org-done} for keywords indicating that an item is finished. If
3587 you are using more than 2 different states, you might want to use
3588 special faces for some of them. This can be done using the variable
3589 @code{org-todo-keyword-faces}. For example:
3593 (setq org-todo-keyword-faces
3594 '(("TODO" . org-warning) ("STARTED" . "yellow")
3595 ("CANCELED" . (:foreground "blue" :weight bold))))
3599 While using a list with face properties as shown for CANCELED @emph{should}
3600 work, this does not aways seem to be the case. If necessary, define a
3601 special face and use that. A string is interpreted as a color. The variable
3602 @code{org-faces-easy-properties} determines if that color is interpreted as a
3603 foreground or a background color.
3605 @node TODO dependencies, , Faces for TODO keywords, TODO extensions
3606 @subsection TODO dependencies
3607 @cindex TODO dependencies
3608 @cindex dependencies, of TODO states
3610 @vindex org-enforce-todo-dependencies
3611 @cindex property, ORDERED
3612 The structure of Org files (hierarchy and lists) makes it easy to define TODO
3613 dependencies. Usually, a parent TODO task should not be marked DONE until
3614 all subtasks (defined as children tasks) are marked as DONE. And sometimes
3615 there is a logical sequence to a number of (sub)tasks, so that one task
3616 cannot be acted upon before all siblings above it are done. If you customize
3617 the variable @code{org-enforce-todo-dependencies}, Org will block entries
3618 from changing state to DONE while they have children that are not DONE.
3619 Furthermore, if an entry has a property @code{ORDERED}, each of its children
3620 will be blocked until all earlier siblings are marked DONE. Here is an
3624 * TODO Blocked until (two) is done
3633 ** TODO b, needs to wait for (a)
3634 ** TODO c, needs to wait for (a) and (b)
3640 @vindex org-track-ordered-property-with-tag
3641 @cindex property, ORDERED
3642 Toggle the @code{ORDERED} property of the current entry. A property is used
3643 for this behavior because this should be local to the current entry, not
3644 inherited like a tag. However, if you would like to @i{track} the value of
3645 this property with a tag for better visibility, customize the variable
3646 @code{org-track-ordered-property-with-tag}.
3647 @kindex C-u C-u C-u C-c C-t
3648 @item C-u C-u C-u C-c C-t
3649 Change TODO state, circumventing any state blocking.
3652 @vindex org-agenda-dim-blocked-tasks
3653 If you set the variable @code{org-agenda-dim-blocked-tasks}, TODO entries
3654 that cannot be closed because of such dependencies will be shown in a dimmed
3655 font or even made invisible in agenda views (@pxref{Agenda Views}).
3657 @cindex checkboxes and TODO dependencies
3658 @vindex org-enforce-todo-dependencies
3659 You can also block changes of TODO states by looking at checkboxes
3660 (@pxref{Checkboxes}). If you set the variable
3661 @code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked
3662 checkboxes will be blocked from switching to DONE.
3664 If you need more complex dependency structures, for example dependencies
3665 between entries in different trees or files, check out the contributed
3666 module @file{org-depend.el}.
3669 @node Progress logging, Priorities, TODO extensions, TODO Items
3670 @section Progress logging
3671 @cindex progress logging
3672 @cindex logging, of progress
3674 Org-mode can automatically record a timestamp and possibly a note when
3675 you mark a TODO item as DONE, or even each time you change the state of
3676 a TODO item. This system is highly configurable, settings can be on a
3677 per-keyword basis and can be localized to a file or even a subtree. For
3678 information on how to clock working time for a task, see @ref{Clocking
3682 * Closing items:: When was this entry marked DONE?
3683 * Tracking TODO state changes:: When did the status change?
3684 * Tracking your habits:: How consistent have you been?
3687 @node Closing items, Tracking TODO state changes, Progress logging, Progress logging
3688 @subsection Closing items
3690 The most basic logging is to keep track of @emph{when} a certain TODO
3691 item was finished. This is achieved with@footnote{The corresponding
3692 in-buffer setting is: @code{#+STARTUP: logdone}}.
3695 (setq org-log-done 'time)
3699 Then each time you turn an entry from a TODO (not-done) state into any
3700 of the DONE states, a line @samp{CLOSED: [timestamp]} will be inserted
3701 just after the headline. If you turn the entry back into a TODO item
3702 through further state cycling, that line will be removed again. If you
3703 want to record a note along with the timestamp, use@footnote{The
3704 corresponding in-buffer setting is: @code{#+STARTUP: lognotedone}}
3707 (setq org-log-done 'note)
3711 You will then be prompted for a note, and that note will be stored below
3712 the entry with a @samp{Closing Note} heading.
3714 In the timeline (@pxref{Timeline}) and in the agenda
3715 (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
3716 display the TODO items with a @samp{CLOSED} timestamp on each day,
3717 giving you an overview of what has been done.
3719 @node Tracking TODO state changes, Tracking your habits, Closing items, Progress logging
3720 @subsection Tracking TODO state changes
3721 @cindex drawer, for state change recording
3723 @vindex org-log-states-order-reversed
3724 @vindex org-log-into-drawer
3725 @cindex property, LOG_INTO_DRAWER
3726 When TODO keywords are used as workflow states (@pxref{Workflow states}), you
3727 might want to keep track of when a state change occurred and maybe take a
3728 note about this change. You can either record just a timestamp, or a
3729 time-stamped note for a change. These records will be inserted after the
3730 headline as an itemized list, newest first@footnote{See the variable
3731 @code{org-log-states-order-reversed}}. When taking a lot of notes, you might
3732 want to get the notes out of the way into a drawer (@pxref{Drawers}).
3733 Customize the variable @code{org-log-into-drawer} to get this
3734 behavior---the recommended drawer for this is called @code{LOGBOOK}. You can
3735 also overrule the setting of this variable for a subtree by setting a
3736 @code{LOG_INTO_DRAWER} property.
3738 Since it is normally too much to record a note for every state, Org-mode
3739 expects configuration on a per-keyword basis for this. This is achieved by
3740 adding special markers @samp{!} (for a timestamp) and @samp{@@} (for a note)
3741 in parentheses after each keyword. For example, with the setting
3744 (setq org-todo-keywords
3745 '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
3749 @vindex org-log-done
3750 you not only define global TODO keywords and fast access keys, but also
3751 request that a time is recorded when the entry is set to
3752 DONE@footnote{It is possible that Org-mode will record two timestamps
3753 when you are using both @code{org-log-done} and state change logging.
3754 However, it will never prompt for two notes---if you have configured
3755 both, the state change recording note will take precedence and cancel
3756 the @samp{Closing Note}.}, and that a note is recorded when switching to
3757 WAIT or CANCELED. The setting for WAIT is even more special: the
3758 @samp{!} after the slash means that in addition to the note taken when
3759 entering the state, a timestamp should be recorded when @i{leaving} the
3760 WAIT state, if and only if the @i{target} state does not configure
3761 logging for entering it. So it has no effect when switching from WAIT
3762 to DONE, because DONE is configured to record a timestamp only. But
3763 when switching from WAIT back to TODO, the @samp{/!} in the WAIT
3764 setting now triggers a timestamp even though TODO has no logging
3767 You can use the exact same syntax for setting logging preferences local
3770 #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
3773 @cindex property, LOGGING
3774 In order to define logging settings that are local to a subtree or a
3775 single item, define a LOGGING property in this entry. Any non-empty
3776 LOGGING property resets all logging settings to nil. You may then turn
3777 on logging for this specific tree using STARTUP keywords like
3778 @code{lognotedone} or @code{logrepeat}, as well as adding state specific
3779 settings like @code{TODO(!)}. For example
3782 * TODO Log each state with only a time
3784 :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
3786 * TODO Only log when switching to WAIT, and when repeating
3788 :LOGGING: WAIT(@@) logrepeat
3790 * TODO No logging at all
3796 @node Tracking your habits, , Tracking TODO state changes, Progress logging
3797 @subsection Tracking your habits
3800 Org has the ability to track the consistency of a special category of TODOs,
3801 called ``habits''. A habit has the following properties:
3805 You have enabled the @code{habits} module by customizing the variable
3808 The habit is a TODO, with a TODO keyword representing an open state.
3810 The property @code{STYLE} is set to the value @code{habit}.
3812 The TODO has a scheduled date, with a @code{.+} style repeat interval.
3814 The TODO may also have minimum and maximum ranges specified by using the
3815 syntax @samp{.+2d/3d}, which says that you want to do the task at least every
3816 three days, but at most every two days.
3818 You must also have state logging for the @code{DONE} state enabled, in order
3819 for historical data to be represented in the consistency graph. If it's not
3820 enabled it's not an error, but the consistency graphs will be largely
3824 To give you an idea of what the above rules look like in action, here's an
3825 actual habit with some history:
3829 SCHEDULED: <2009-10-17 Sat .+2d/4d>
3830 - State "DONE" from "TODO" [2009-10-15 Thu]
3831 - State "DONE" from "TODO" [2009-10-12 Mon]
3832 - State "DONE" from "TODO" [2009-10-10 Sat]
3833 - State "DONE" from "TODO" [2009-10-04 Sun]
3834 - State "DONE" from "TODO" [2009-10-02 Fri]
3835 - State "DONE" from "TODO" [2009-09-29 Tue]
3836 - State "DONE" from "TODO" [2009-09-25 Fri]
3837 - State "DONE" from "TODO" [2009-09-19 Sat]
3838 - State "DONE" from "TODO" [2009-09-16 Wed]
3839 - State "DONE" from "TODO" [2009-09-12 Sat]
3842 :LAST_REPEAT: [2009-10-19 Mon 00:36]
3846 What this habit says is: I want to shave at most every 2 days (given by the
3847 @code{SCHEDULED} date and repeat interval) and at least every 4 days. If
3848 today is the 15th, then the habit first appears in the agenda on Oct 17,
3849 after the minimum of 2 days has elapsed, and will appear overdue on Oct 19,
3850 after four days have elapsed.
3852 What's really useful about habits is that they are displayed along with a
3853 consistency graph, to show how consistent you've been at getting that task
3854 done in the past. This graph shows every day that the task was done over the
3855 past three weeks, with colors for each day. The colors used are:
3859 If the task wasn't to be done yet on that day.
3861 If the task could have been done on that day.
3863 If the task was going to be overdue the next day.
3865 If the task was overdue on that day.
3868 In addition to coloring each day, the day is also marked with an asterisk if
3869 the task was actually done that day, and an exclamation mark to show where
3870 the current day falls in the graph.
3872 There are several configuration variables that can be used to change the way
3873 habits are displayed in the agenda.
3876 @item org-habit-graph-column
3877 The buffer column at which the consistency graph should be drawn. This will
3878 overwrite any text in that column, so it's a good idea to keep your habits'
3879 titles brief and to the point.
3880 @item org-habit-preceding-days
3881 The amount of history, in days before today, to appear in consistency graphs.
3882 @item org-habit-following-days
3883 The number of days after today that will appear in consistency graphs.
3884 @item org-habit-show-habits-only-for-today
3885 If non-nil, only show habits in today's agenda view. This is set to true by
3889 Lastly, pressing @kbd{K} in the agenda buffer will cause habits to
3890 temporarily be disabled and they won't appear at all. Press @kbd{K} again to
3891 bring them back. They are also subject to tag filtering, if you have habits
3892 which should only be done in certain contexts, for example.
3894 @node Priorities, Breaking down tasks, Progress logging, TODO Items
3898 If you use Org-mode extensively, you may end up with enough TODO items that
3899 it starts to make sense to prioritize them. Prioritizing can be done by
3900 placing a @emph{priority cookie} into the headline of a TODO item, like this
3903 *** TODO [#A] Write letter to Sam Fortune
3907 @vindex org-priority-faces
3908 By default, Org-mode supports three priorities: @samp{A}, @samp{B}, and
3909 @samp{C}. @samp{A} is the highest priority. An entry without a cookie is
3910 treated as priority @samp{B}. Priorities make a difference only in the
3911 agenda (@pxref{Weekly/daily agenda}); outside the agenda, they have no
3912 inherent meaning to Org-mode. The cookies can be highlighted with special
3913 faces by customizing the variable @code{org-priority-faces}.
3915 Priorities can be attached to any outline tree entries; they do not need
3921 Set the priority of the current headline. The command prompts for a
3922 priority character @samp{A}, @samp{B} or @samp{C}. When you press
3923 @key{SPC} instead, the priority cookie is removed from the headline.
3924 The priorities can also be changed ``remotely'' from the timeline and
3925 agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
3928 @kindex S-@key{down}
3931 @vindex org-priority-start-cycle-with-default
3932 Increase/decrease priority of current headline@footnote{See also the option
3933 @code{org-priority-start-cycle-with-default}.}. Note that these keys are
3934 also used to modify timestamps (@pxref{Creating timestamps}). See also
3935 @ref{Conflicts}, for a discussion of the interaction with
3936 @code{shift-selection-mode}.
3939 @vindex org-highest-priority
3940 @vindex org-lowest-priority
3941 @vindex org-default-priority
3942 You can change the range of allowed priorities by setting the variables
3943 @code{org-highest-priority}, @code{org-lowest-priority}, and
3944 @code{org-default-priority}. For an individual buffer, you may set
3945 these values (highest, lowest, default) like this (please make sure that
3946 the highest priority is earlier in the alphabet than the lowest
3949 @cindex #+PRIORITIES
3954 @node Breaking down tasks, Checkboxes, Priorities, TODO Items
3955 @section Breaking tasks down into subtasks
3956 @cindex tasks, breaking down
3957 @cindex statistics, for TODO items
3959 @vindex org-agenda-todo-list-sublevels
3960 It is often advisable to break down large tasks into smaller, manageable
3961 subtasks. You can do this by creating an outline tree below a TODO item,
3962 with detailed subtasks on the tree@footnote{To keep subtasks out of the
3963 global TODO list, see the @code{org-agenda-todo-list-sublevels}.}. To keep
3964 the overview over the fraction of subtasks that are already completed, insert
3965 either @samp{[/]} or @samp{[%]} anywhere in the headline. These cookies will
3966 be updated each time the TODO status of a child changes, or when pressing
3967 @kbd{C-c C-c} on the cookie. For example:
3970 * Organize Party [33%]
3971 ** TODO Call people [1/2]
3975 ** DONE Talk to neighbor
3978 @cindex property, COOKIE_DATA
3979 If a heading has both checkboxes and TODO children below it, the meaning of
3980 the statistics cookie become ambiguous. Set the property
3981 @code{COOKIE_DATA} to either @samp{checkbox} or @samp{todo} to resolve
3984 @vindex org-hierarchical-todo-statistics
3985 If you would like to have the statistics cookie count any TODO entries in the
3986 subtree (not just direct children), configure the variable
3987 @code{org-hierarchical-todo-statistics}. To do this for a single subtree,
3988 include the word @samp{recursive} into the value of the @code{COOKIE_DATA}
3992 * Parent capturing statistics [2/20]
3994 :COOKIE_DATA: todo recursive
3998 If you would like a TODO entry to automatically change to DONE
3999 when all children are done, you can use the following setup:
4002 (defun org-summary-todo (n-done n-not-done)
4003 "Switch entry to DONE when all subentries are done, to TODO otherwise."
4004 (let (org-log-done org-log-states) ; turn off logging
4005 (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
4007 (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
4011 Another possibility is the use of checkboxes to identify (a hierarchy of) a
4012 large number of subtasks (@pxref{Checkboxes}).
4015 @node Checkboxes, , Breaking down tasks, TODO Items
4019 Every item in a plain list (@pxref{Plain lists}) can be made into a
4020 checkbox by starting it with the string @samp{[ ]}. This feature is
4021 similar to TODO items (@pxref{TODO Items}), but is more lightweight.
4022 Checkboxes are not included into the global TODO list, so they are often
4023 great to split a task into a number of simple steps. Or you can use
4024 them in a shopping list. To toggle a checkbox, use @kbd{C-c C-c}, or
4025 use the mouse (thanks to Piotr Zielinski's @file{org-mouse.el}).
4027 Here is an example of a checkbox list.
4030 * TODO Organize party [2/4]
4031 - [-] call people [1/3]
4036 - [ ] think about what music to play
4037 - [X] talk to the neighbors
4040 Checkboxes work hierarchically, so if a checkbox item has children that
4041 are checkboxes, toggling one of the children checkboxes will make the
4042 parent checkbox reflect if none, some, or all of the children are
4045 @cindex statistics, for checkboxes
4046 @cindex checkbox statistics
4047 @cindex property, COOKIE_DATA
4048 @vindex org-hierarchical-checkbox-statistics
4049 The @samp{[2/4]} and @samp{[1/3]} in the first and second line are cookies
4050 indicating how many checkboxes present in this entry have been checked off,
4051 and the total number of checkboxes present. This can give you an idea on how
4052 many checkboxes remain, even without opening a folded entry. The cookies can
4053 be placed into a headline or into (the first line of) a plain list item.
4054 Each cookie covers checkboxes of direct children structurally below the
4055 headline/item on which the cookie appears@footnote{Set the variable
4056 @code{org-hierarchical-checkbox-statistics} if you want such cookies to
4057 represent the all checkboxes below the cookie, not just the direct
4058 children.}. You have to insert the cookie yourself by typing either
4059 @samp{[/]} or @samp{[%]}. With @samp{[/]} you get an @samp{n out of m}
4060 result, as in the examples above. With @samp{[%]} you get information about
4061 the percentage of checkboxes checked (in the above example, this would be
4062 @samp{[50%]} and @samp{[33%]}, respectively). In a headline, a cookie can
4063 count either checkboxes below the heading or TODO states of children, and it
4064 will display whatever was changed last. Set the property @code{COOKIE_DATA}
4065 to either @samp{checkbox} or @samp{todo} to resolve this issue.
4067 @cindex blocking, of checkboxes
4068 @cindex checkbox blocking
4069 @cindex property, ORDERED
4070 If the current outline node has an @code{ORDERED} property, checkboxes must
4071 be checked off in sequence, and an error will be thrown if you try to check
4072 off a box while there are unchecked boxes above it.
4074 @noindent The following commands work with checkboxes:
4079 Toggle checkbox status or (with prefix arg) checkbox presence at point. With
4080 double prefix argument, set it to @samp{[-]}, which is considered to be an
4084 Toggle checkbox status or (with prefix arg) checkbox presence at point. With
4085 double prefix argument, set it to @samp{[-]}, which is considered to be an
4089 If there is an active region, toggle the first checkbox in the region
4090 and set all remaining boxes to the same status as the first. With a prefix
4091 arg, add or remove the checkbox for all items in the region.
4093 If the cursor is in a headline, toggle checkboxes in the region between
4094 this headline and the next (so @emph{not} the entire subtree).
4096 If there is no active region, just toggle the checkbox at point.
4098 @kindex M-S-@key{RET}
4100 Insert a new item with a checkbox.
4101 This works only if the cursor is already in a plain list item
4102 (@pxref{Plain lists}).
4105 @vindex org-track-ordered-property-with-tag
4106 @cindex property, ORDERED
4107 Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
4108 be checked off in sequence. A property is used for this behavior because
4109 this should be local to the current entry, not inherited like a tag.
4110 However, if you would like to @i{track} the value of this property with a tag
4111 for better visibility, customize the variable
4112 @code{org-track-ordered-property-with-tag}.
4115 Update the statistics cookie in the current outline entry. When called with
4116 a @kbd{C-u} prefix, update the entire file. Checkbox statistic cookies are
4117 updated automatically if you toggle checkboxes with @kbd{C-c C-c} and make
4118 new ones with @kbd{M-S-@key{RET}}. TODO statistics cookies update when
4119 changing TODO states. If you delete boxes/entries or add/change them by
4120 hand, use this command to get things back into sync. Or simply toggle any
4121 entry twice (checkboxes with @kbd{C-c C-c}).
4124 @node Tags, Properties and Columns, TODO Items, Top
4127 @cindex headline tagging
4128 @cindex matching, tags
4129 @cindex sparse tree, tag based
4131 An excellent way to implement labels and contexts for cross-correlating
4132 information is to assign @i{tags} to headlines. Org-mode has extensive
4135 @vindex org-tag-faces
4136 Every headline can contain a list of tags; they occur at the end of the
4137 headline. Tags are normal words containing letters, numbers, @samp{_}, and
4138 @samp{@@}. Tags must be preceded and followed by a single colon, e.g.,
4139 @samp{:work:}. Several tags can be specified, as in @samp{:work:urgent:}.
4140 Tags will by default be in bold face with the same color as the headline.
4141 You may specify special faces for specific tags using the variable
4142 @code{org-tag-faces}, in much the same way as you can for TODO keywords
4143 (@pxref{Faces for TODO keywords}).
4146 * Tag inheritance:: Tags use the tree structure of the outline
4147 * Setting tags:: How to assign tags to a headline
4148 * Tag searches:: Searching for combinations of tags
4151 @node Tag inheritance, Setting tags, Tags, Tags
4152 @section Tag inheritance
4153 @cindex tag inheritance
4154 @cindex inheritance, of tags
4155 @cindex sublevels, inclusion into tags match
4157 @i{Tags} make use of the hierarchical structure of outline trees. If a
4158 heading has a certain tag, all subheadings will inherit the tag as
4159 well. For example, in the list
4162 * Meeting with the French group :work:
4163 ** Summary by Frank :boss:notes:
4164 *** TODO Prepare slides for him :action:
4168 the final heading will have the tags @samp{:work:}, @samp{:boss:},
4169 @samp{:notes:}, and @samp{:action:} even though the final heading is not
4170 explicitly marked with those tags. You can also set tags that all entries in
4171 a file should inherit just as if these tags were defined in a hypothetical
4172 level zero that surrounds the entire file. Use a line like this@footnote{As
4173 with all these in-buffer settings, pressing @kbd{C-c C-c} activates any
4174 changes in the line.}:
4178 #+FILETAGS: :Peter:Boss:Secret:
4182 @vindex org-use-tag-inheritance
4183 @vindex org-tags-exclude-from-inheritance
4184 To limit tag inheritance to specific tags, or to turn it off entirely, use
4185 the variables @code{org-use-tag-inheritance} and
4186 @code{org-tags-exclude-from-inheritance}.
4188 @vindex org-tags-match-list-sublevels
4189 When a headline matches during a tags search while tag inheritance is turned
4190 on, all the sublevels in the same tree will (for a simple match form) match
4191 as well@footnote{This is only true if the search does not involve more
4192 complex tests including properties (@pxref{Property searches}).}. The list
4193 of matches may then become very long. If you only want to see the first tags
4194 match in a subtree, configure the variable
4195 @code{org-tags-match-list-sublevels} (not recommended).
4197 @node Setting tags, Tag searches, Tag inheritance, Tags
4198 @section Setting tags
4199 @cindex setting tags
4200 @cindex tags, setting
4203 Tags can simply be typed into the buffer at the end of a headline.
4204 After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is
4205 also a special command for inserting tags:
4210 @cindex completion, of tags
4211 @vindex org-tags-column
4212 Enter new tags for the current headline. Org-mode will either offer
4213 completion or a special single-key interface for setting tags, see
4214 below. After pressing @key{RET}, the tags will be inserted and aligned
4215 to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all
4216 tags in the current buffer will be aligned to that column, just to make
4217 things look nice. TAGS are automatically realigned after promotion,
4218 demotion, and TODO state changes (@pxref{TODO basics}).
4221 When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
4224 @vindex org-tag-alist
4225 Org will support tag insertion based on a @emph{list of tags}. By
4226 default this list is constructed dynamically, containing all tags
4227 currently used in the buffer. You may also globally specify a hard list
4228 of tags with the variable @code{org-tag-alist}. Finally you can set
4229 the default tags for a given file with lines like
4233 #+TAGS: @@work @@home @@tennisclub
4234 #+TAGS: laptop car pc sailboat
4237 If you have globally defined your preferred set of tags using the
4238 variable @code{org-tag-alist}, but would like to use a dynamic tag list
4239 in a specific file, add an empty TAGS option line to that file:
4245 @vindex org-tag-persistent-alist
4246 If you have a preferred set of tags that you would like to use in every file,
4247 in addition to those defined on a per-file basis by TAGS option lines, then
4248 you may specify a list of tags with the variable
4249 @code{org-tag-persistent-alist}. You may turn this off on a per-file basis
4250 by adding a STARTUP option line to that file:
4256 By default Org-mode uses the standard minibuffer completion facilities for
4257 entering tags. However, it also implements another, quicker, tag selection
4258 method called @emph{fast tag selection}. This allows you to select and
4259 deselect tags with just a single key press. For this to work well you should
4260 assign unique letters to most of your commonly used tags. You can do this
4261 globally by configuring the variable @code{org-tag-alist} in your
4262 @file{.emacs} file. For example, you may find the need to tag many items in
4263 different files with @samp{:@@home:}. In this case you can set something
4267 (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
4270 @noindent If the tag is only relevant to the file you are working on, then you
4271 can instead set the TAGS option line as:
4274 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p)
4277 @noindent The tags interface will show the available tags in a splash
4278 window. If you want to start a new line after a specific tag, insert
4279 @samp{\n} into the tag list
4282 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) \n laptop(l) pc(p)
4285 @noindent or write them in two lines:
4288 #+TAGS: @@work(w) @@home(h) @@tennisclub(t)
4289 #+TAGS: laptop(l) pc(p)
4293 You can also group together tags that are mutually exclusive by using
4297 #+TAGS: @{ @@work(w) @@home(h) @@tennisclub(t) @} laptop(l) pc(p)
4300 @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
4301 and @samp{@@tennisclub} should be selected. Multiple such groups are allowed.
4303 @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
4304 these lines to activate any changes.
4307 To set these mutually exclusive groups in the variable @code{org-tags-alist},
4308 you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
4309 of the braces. Similarly, you can use @code{:newline} to indicate a line
4310 break. The previous example would be set globally by the following
4314 (setq org-tag-alist '((:startgroup . nil)
4315 ("@@work" . ?w) ("@@home" . ?h)
4316 ("@@tennisclub" . ?t)
4318 ("laptop" . ?l) ("pc" . ?p)))
4321 If at least one tag has a selection key then pressing @kbd{C-c C-c} will
4322 automatically present you with a special interface, listing inherited tags,
4323 the tags of the current headline, and a list of all valid tags with
4324 corresponding keys@footnote{Keys will automatically be assigned to tags which
4325 have no configured keys.}. In this interface, you can use the following
4330 Pressing keys assigned to tags will add or remove them from the list of
4331 tags in the current line. Selecting a tag in a group of mutually
4332 exclusive tags will turn off any other tags from that group.
4335 Enter a tag in the minibuffer, even if the tag is not in the predefined
4336 list. You will be able to complete on all tags present in the buffer.
4339 Clear all tags for this line.
4342 Accept the modified set.
4344 Abort without installing changes.
4346 If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
4348 Turn off groups of mutually exclusive tags. Use this to (as an
4349 exception) assign several tags from such a group.
4351 Toggle auto-exit after the next change (see below).
4352 If you are using expert mode, the first @kbd{C-c} will display the
4357 This method lets you assign tags to a headline with very few keys. With
4358 the above setup, you could clear the current tags and set @samp{@@home},
4359 @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
4360 C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@home} to
4361 @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
4362 alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag
4363 @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
4364 @key{RET} @key{RET}}.
4366 @vindex org-fast-tag-selection-single-key
4367 If you find that most of the time you need only a single key press to
4368 modify your list of tags, set the variable
4369 @code{org-fast-tag-selection-single-key}. Then you no longer have to
4370 press @key{RET} to exit fast tag selection---it will immediately exit
4371 after the first change. If you then occasionally need more keys, press
4372 @kbd{C-c} to turn off auto-exit for the current tag selection process
4373 (in effect: start selection with @kbd{C-c C-c C-c} instead of @kbd{C-c
4374 C-c}). If you set the variable to the value @code{expert}, the special
4375 window is not even shown for single-key tag selection, it comes up only
4376 when you press an extra @kbd{C-c}.
4378 @node Tag searches, , Setting tags, Tags
4379 @section Tag searches
4380 @cindex tag searches
4381 @cindex searching for tags
4383 Once a system of tags has been set up, it can be used to collect related
4384 information into special lists.
4391 Create a sparse tree with all headlines matching a tags search. With a
4392 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
4395 Create a global list of tag matches from all agenda files.
4396 @xref{Matching tags and properties}.
4399 @vindex org-tags-match-list-sublevels
4400 Create a global list of tag matches from all agenda files, but check
4401 only TODO items and force checking subitems (see variable
4402 @code{org-tags-match-list-sublevels}).
4405 These commands all prompt for a match string which allows basic Boolean logic
4406 like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and
4407 @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries
4408 which are tagged, like @samp{Kathy} or @samp{Sally}. The full syntax of the search
4409 string is rich and allows also matching against TODO keywords, entry levels
4410 and properties. For a complete description with many examples, see
4411 @ref{Matching tags and properties}.
4414 @node Properties and Columns, Dates and Times, Tags, Top
4415 @chapter Properties and columns
4418 Properties are a set of key-value pairs associated with an entry. There
4419 are two main applications for properties in Org-mode. First, properties
4420 are like tags, but with a value. Second, you can use properties to
4421 implement (very basic) database capabilities in an Org buffer. For
4422 an example of the first application, imagine maintaining a file where
4423 you document bugs and plan releases for a piece of software. Instead of
4424 using tags like @code{:release_1:}, @code{:release_2:}, one can use a
4425 property, say @code{:Release:}, that in different subtrees has different
4426 values, such as @code{1.0} or @code{2.0}. For an example of the second
4427 application of properties, imagine keeping track of your music CDs,
4428 where properties could be things such as the album, artist, date of
4429 release, number of tracks, and so on.
4431 Properties can be conveniently edited and viewed in column view
4432 (@pxref{Column view}).
4435 * Property syntax:: How properties are spelled out
4436 * Special properties:: Access to other Org-mode features
4437 * Property searches:: Matching property values
4438 * Property inheritance:: Passing values down the tree
4439 * Column view:: Tabular viewing and editing
4440 * Property API:: Properties for Lisp programmers
4443 @node Property syntax, Special properties, Properties and Columns, Properties and Columns
4444 @section Property syntax
4445 @cindex property syntax
4446 @cindex drawer, for properties
4448 Properties are key-value pairs. They need to be inserted into a special
4449 drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property
4450 is specified on a single line, with the key (surrounded by colons)
4451 first, and the value after it. Here is an example:
4456 *** Goldberg Variations
4458 :Title: Goldberg Variations
4459 :Composer: J.S. Bach
4461 :Publisher: Deutsche Grammophon
4466 You may define the allowed values for a particular property @samp{:Xyz:}
4467 by setting a property @samp{:Xyz_ALL:}. This special property is
4468 @emph{inherited}, so if you set it in a level 1 entry, it will apply to
4469 the entire tree. When allowed values are defined, setting the
4470 corresponding property becomes easier and is less prone to typing
4471 errors. For the example with the CD collection, we can predefine
4472 publishers and the number of disks in a box like this:
4477 :NDisks_ALL: 1 2 3 4
4478 :Publisher_ALL: "Deutsche Grammophon" Philips EMI
4482 If you want to set properties that can be inherited by any entry in a
4483 file, use a line like
4484 @cindex property, _ALL
4487 #+PROPERTY: NDisks_ALL 1 2 3 4
4490 @vindex org-global-properties
4491 Property values set with the global variable
4492 @code{org-global-properties} can be inherited by all entries in all
4496 The following commands help to work with properties:
4501 After an initial colon in a line, complete property keys. All keys used
4502 in the current file will be offered as possible completions.
4505 Set a property. This prompts for a property name and a value. If
4506 necessary, the property drawer is created as well.
4507 @item M-x org-insert-property-drawer
4508 Insert a property drawer into the current entry. The drawer will be
4509 inserted early in the entry, but after the lines with planning
4510 information like deadlines.
4513 With the cursor in a property drawer, this executes property commands.
4515 Set a property in the current entry. Both the property and the value
4516 can be inserted using completion.
4517 @kindex S-@key{right}
4518 @kindex S-@key{left}
4519 @item S-@key{left}/@key{right}
4520 Switch property at point to the next/previous allowed value.
4522 Remove a property from the current entry.
4524 Globally remove a property, from all entries in the current file.
4526 Compute the property at point, using the operator and scope from the
4527 nearest column format definition.
4530 @node Special properties, Property searches, Property syntax, Properties and Columns
4531 @section Special properties
4532 @cindex properties, special
4534 Special properties provide an alternative access method to Org-mode
4535 features, like the TODO state or the priority of an entry, discussed in the
4536 previous chapters. This interface exists so that you can include
4537 these states in a column view (@pxref{Column view}), or to use them in
4538 queries. The following property names are special and should not be
4539 used as keys in the properties drawer:
4541 @cindex property, special, TODO
4542 @cindex property, special, TAGS
4543 @cindex property, special, ALLTAGS
4544 @cindex property, special, CATEGORY
4545 @cindex property, special, PRIORITY
4546 @cindex property, special, DEADLINE
4547 @cindex property, special, SCHEDULED
4548 @cindex property, special, CLOSED
4549 @cindex property, special, TIMESTAMP
4550 @cindex property, special, TIMESTAMP_IA
4551 @cindex property, special, CLOCKSUM
4552 @cindex property, special, BLOCKED
4553 @c guessing that ITEM is needed in this area; also, should this list be sorted?
4554 @cindex property, special, ITEM
4556 TODO @r{The TODO keyword of the entry.}
4557 TAGS @r{The tags defined directly in the headline.}
4558 ALLTAGS @r{All tags, including inherited ones.}
4559 CATEGORY @r{The category of an entry.}
4560 PRIORITY @r{The priority of the entry, a string with a single letter.}
4561 DEADLINE @r{The deadline time string, without the angular brackets.}
4562 SCHEDULED @r{The scheduling timestamp, without the angular brackets.}
4563 CLOSED @r{When was this entry closed?}
4564 TIMESTAMP @r{The first keyword-less timestamp in the entry.}
4565 TIMESTAMP_IA @r{The first inactive timestamp in the entry.}
4566 CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}}
4567 @r{must be run first to compute the values.}
4568 BLOCKED @r{"t" if task is currently blocked by children or siblings}
4569 ITEM @r{The content of the entry.}
4572 @node Property searches, Property inheritance, Special properties, Properties and Columns
4573 @section Property searches
4574 @cindex properties, searching
4575 @cindex searching, of properties
4577 To create sparse trees and special lists with selection based on properties,
4578 the same commands are used as for tag searches (@pxref{Tag searches}).
4584 Create a sparse tree with all matching entries. With a
4585 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
4588 Create a global list of tag/property matches from all agenda files.
4589 @xref{Matching tags and properties}.
4592 @vindex org-tags-match-list-sublevels
4593 Create a global list of tag matches from all agenda files, but check
4594 only TODO items and force checking of subitems (see variable
4595 @code{org-tags-match-list-sublevels}).
4598 The syntax for the search string is described in @ref{Matching tags and
4601 There is also a special command for creating sparse trees based on a
4607 Create a sparse tree based on the value of a property. This first
4608 prompts for the name of a property, and then for a value. A sparse tree
4609 is created with all entries that define this property with the given
4610 value. If you enclose the value into curly braces, it is interpreted as
4611 a regular expression and matched against the property values.
4614 @node Property inheritance, Column view, Property searches, Properties and Columns
4615 @section Property Inheritance
4616 @cindex properties, inheritance
4617 @cindex inheritance, of properties
4619 @vindex org-use-property-inheritance
4620 The outline structure of Org-mode documents lends itself for an
4621 inheritance model of properties: if the parent in a tree has a certain
4622 property, the children can inherit this property. Org-mode does not
4623 turn this on by default, because it can slow down property searches
4624 significantly and is often not needed. However, if you find inheritance
4625 useful, you can turn it on by setting the variable
4626 @code{org-use-property-inheritance}. It may be set to @code{t} to make
4627 all properties inherited from the parent, to a list of properties
4628 that should be inherited, or to a regular expression that matches
4629 inherited properties. If a property has the value @samp{nil}, this is
4630 interpreted as an explicit undefine of he property, so that inheritance
4631 search will stop at this value and return @code{nil}.
4633 Org-mode has a few properties for which inheritance is hard-coded, at
4634 least for the special applications for which they are used:
4636 @cindex property, COLUMNS
4639 The @code{:COLUMNS:} property defines the format of column view
4640 (@pxref{Column view}). It is inherited in the sense that the level
4641 where a @code{:COLUMNS:} property is defined is used as the starting
4642 point for a column view table, independently of the location in the
4643 subtree from where columns view is turned on.
4645 @cindex property, CATEGORY
4646 For agenda view, a category set through a @code{:CATEGORY:} property
4647 applies to the entire subtree.
4649 @cindex property, ARCHIVE
4650 For archiving, the @code{:ARCHIVE:} property may define the archive
4651 location for the entire subtree (@pxref{Moving subtrees}).
4653 @cindex property, LOGGING
4654 The LOGGING property may define logging settings for an entry or a
4655 subtree (@pxref{Tracking TODO state changes}).
4658 @node Column view, Property API, Property inheritance, Properties and Columns
4659 @section Column view
4661 A great way to view and edit properties in an outline tree is
4662 @emph{column view}. In column view, each outline node is turned into a
4663 table row. Columns in this table provide access to properties of the
4664 entries. Org-mode implements columns by overlaying a tabular structure
4665 over the headline of each item. While the headlines have been turned
4666 into a table row, you can still change the visibility of the outline
4667 tree. For example, you get a compact table by switching to CONTENTS
4668 view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
4669 is active), but you can still open, read, and edit the entry below each
4670 headline. Or, you can switch to column view after executing a sparse
4671 tree command and in this way get a table only for the selected items.
4672 Column view also works in agenda buffers (@pxref{Agenda Views}) where
4673 queries have collected selected items, possibly from a number of files.
4676 * Defining columns:: The COLUMNS format property
4677 * Using column view:: How to create and use column view
4678 * Capturing column view:: A dynamic block for column view
4681 @node Defining columns, Using column view, Column view, Column view
4682 @subsection Defining columns
4683 @cindex column view, for properties
4684 @cindex properties, column view
4686 Setting up a column view first requires defining the columns. This is
4687 done by defining a column format line.
4690 * Scope of column definitions:: Where defined, where valid?
4691 * Column attributes:: Appearance and content of a column
4694 @node Scope of column definitions, Column attributes, Defining columns, Defining columns
4695 @subsubsection Scope of column definitions
4697 To define a column format for an entire file, use a line like
4701 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
4704 To specify a format that only applies to a specific tree, add a
4705 @code{:COLUMNS:} property to the top node of that tree, for example:
4708 ** Top node for columns view
4710 :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
4714 If a @code{:COLUMNS:} property is present in an entry, it defines columns
4715 for the entry itself, and for the entire subtree below it. Since the
4716 column definition is part of the hierarchical structure of the document,
4717 you can define columns on level 1 that are general enough for all
4718 sublevels, and more specific columns further down, when you edit a
4719 deeper part of the tree.
4721 @node Column attributes, , Scope of column definitions, Defining columns
4722 @subsubsection Column attributes
4723 A column definition sets the attributes of a column. The general
4724 definition looks like this:
4727 %[@var{width}]@var{property}[(@var{title})][@{@var{summary-type}@}]
4731 Except for the percent sign and the property name, all items are
4732 optional. The individual parts have the following meaning:
4735 @var{width} @r{An integer specifying the width of the column in characters.}
4736 @r{If omitted, the width will be determined automatically.}
4737 @var{property} @r{The property that should be edited in this column.}
4738 @r{Special properties representing meta data are allowed here}
4739 @r{as well (@pxref{Special properties})}
4740 (title) @r{The header text for the column. If omitted, the}
4741 @r{property name is used.}
4742 @{@var{summary-type}@} @r{The summary type. If specified, the column values for}
4743 @r{parent nodes are computed from the children.}
4744 @r{Supported summary types are:}
4745 @{+@} @r{Sum numbers in this column.}
4746 @{+;%.1f@} @r{Like @samp{+}, but format result with @samp{%.1f}.}
4747 @{$@} @r{Currency, short for @samp{+;%.2f}.}
4748 @{:@} @r{Sum times, HH:MM, plain numbers are hours.}
4749 @{X@} @r{Checkbox status, @samp{[X]} if all children are @samp{[X]}.}
4750 @{X/@} @r{Checkbox status, @samp{[n/m]}.}
4751 @{X%@} @r{Checkbox status, @samp{[n%]}.}
4752 @{min@} @r{Smallest number in column.}
4753 @{max@} @r{Largest number.}
4754 @{mean@} @r{Arithmetic mean of numbers.}
4755 @{:min@} @r{Smallest time value in column.}
4756 @{:max@} @r{Largest time value.}
4757 @{:mean@} @r{Arithmetic mean of time values.}
4758 @{@@min@} @r{Minimum age (in days/hours/mins/seconds).}
4759 @{@@max@} @r{Maximum age (in days/hours/mins/seconds).}
4760 @{@@mean@} @r{Arithmetic mean of ages (in days/hours/mins/seconds).}
4761 @{est+@} @r{Add low-high estimates.}
4765 Be aware that you can only have one summary type for any property you
4766 include. Subsequent columns referencing the same property will all display the
4767 same summary information.
4769 The @code{est+} summary type requires further explanation. It is used for
4770 combining estimates, expressed as low-high ranges. For example, instead
4771 of estimating a particular task will take 5 days, you might estimate it as
4772 5-6 days if you're fairly confident you know how much woark is required, or
4773 1-10 days if you don't really know what needs to be done. Both ranges
4774 average at 5.5 days, but the first represents a more predictable delivery.
4776 When combining a set of such estimates, simply adding the lows and highs
4777 produces an unrealistically wide result. Instead, @code{est+} adds the
4778 statistical mean and variance of the sub-tasks, generating a final estimate
4779 from the sum. For example, suppose you had ten tasks, each of which was
4780 estimated at 0.5 to 2 days of work. Straight addition produces an estimate
4781 of 5 to 20 days, representing what to expect if everything goes either
4782 extremely well or extremely poorly. In contrast, @code{est+} estimates the
4783 full job more realistically, at 10-15 days.
4785 Here is an example for a complete columns definition, along with allowed
4789 :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.}
4790 %10Time_Estimate@{:@} %CLOCKSUM
4791 :Owner_ALL: Tammy Mark Karl Lisa Don
4792 :Status_ALL: "In progress" "Not started yet" "Finished" ""
4793 :Approved_ALL: "[ ]" "[X]"
4797 The first column, @samp{%25ITEM}, means the first 25 characters of the
4798 item itself, i.e. of the headline. You probably always should start the
4799 column definition with the @samp{ITEM} specifier. The other specifiers
4800 create columns @samp{Owner} with a list of names as allowed values, for
4801 @samp{Status} with four different possible values, and for a checkbox
4802 field @samp{Approved}. When no width is given after the @samp{%}
4803 character, the column will be exactly as wide as it needs to be in order
4804 to fully display all values. The @samp{Approved} column does have a
4805 modified title (@samp{Approved?}, with a question mark). Summaries will
4806 be created for the @samp{Time_Estimate} column by adding time duration
4807 expressions like HH:MM, and for the @samp{Approved} column, by providing
4808 an @samp{[X]} status if all children have been checked. The
4809 @samp{CLOCKSUM} column is special, it lists the sum of CLOCK intervals
4812 @node Using column view, Capturing column view, Defining columns, Column view
4813 @subsection Using column view
4816 @tsubheading{Turning column view on and off}
4819 @vindex org-columns-default-format
4820 Turn on column view. If the cursor is before the first headline in the file,
4821 column view is turned on for the entire file, using the @code{#+COLUMNS}
4822 definition. If the cursor is somewhere inside the outline, this command
4823 searches the hierarchy, up from point, for a @code{:COLUMNS:} property that
4824 defines a format. When one is found, the column view table is established
4825 for the tree starting at the entry that contains the @code{:COLUMNS:}
4826 property. If no such property is found, the format is taken from the
4827 @code{#+COLUMNS} line or from the variable @code{org-columns-default-format},
4828 and column view is established for the current entry and its subtree.
4831 Recreate the column view, to include recent changes made in the buffer.
4838 @tsubheading{Editing values}
4839 @item @key{left} @key{right} @key{up} @key{down}
4840 Move through the column view from field to field.
4841 @kindex S-@key{left}
4842 @kindex S-@key{right}
4843 @item S-@key{left}/@key{right}
4844 Switch to the next/previous allowed value of the field. For this, you
4845 have to have specified allowed values for a property.
4847 Directly select the nth allowed value, @kbd{0} selects the 10th value.
4851 Same as @kbd{S-@key{left}/@key{right}}
4854 Edit the property at point. For the special properties, this will
4855 invoke the same interface that you normally use to change that
4856 property. For example, when editing a TAGS property, the tag completion
4857 or fast selection interface will pop up.
4860 When there is a checkbox at point, toggle it.
4863 View the full value of this property. This is useful if the width of
4864 the column is smaller than that of the value.
4867 Edit the list of allowed values for this property. If the list is found
4868 in the hierarchy, the modified values is stored there. If no list is
4869 found, the new value is stored in the first entry that is part of the
4870 current column view.
4871 @tsubheading{Modifying the table structure}
4875 Make the column narrower/wider by one character.
4876 @kindex S-M-@key{right}
4877 @item S-M-@key{right}
4878 Insert a new column, to the left of the current column.
4879 @kindex S-M-@key{left}
4880 @item S-M-@key{left}
4881 Delete the current column.
4884 @node Capturing column view, , Using column view, Column view
4885 @subsection Capturing column view
4887 Since column view is just an overlay over a buffer, it cannot be
4888 exported or printed directly. If you want to capture a column view, use
4889 a @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame
4890 of this block looks like this:
4892 @cindex #+BEGIN, columnview
4895 #+BEGIN: columnview :hlines 1 :id "label"
4900 @noindent This dynamic block has the following parameters:
4904 This is the most important parameter. Column view is a feature that is
4905 often localized to a certain (sub)tree, and the capture block might be
4906 at a different location in the file. To identify the tree whose view to
4907 capture, you can use 4 values:
4908 @cindex property, ID
4910 local @r{use the tree in which the capture block is located}
4911 global @r{make a global view, including all headings in the file}
4912 "file:@var{path-to-file}"
4913 @r{run column view at the top of this file}
4914 "@var{ID}" @r{call column view in the tree that has an @code{:ID:}}
4915 @r{property with the value @i{label}. You can use}
4916 @r{@kbd{M-x org-id-copy} to create a globally unique ID for}
4917 @r{the current entry and copy it to the kill-ring.}
4920 When @code{t}, insert an hline after every line. When a number @var{N}, insert
4921 an hline before each headline with level @code{<= @var{N}}.
4923 When set to @code{t}, force column groups to get vertical lines.
4925 When set to a number, don't capture entries below this level.
4926 @item :skip-empty-rows
4927 When set to @code{t}, skip rows where the only non-empty specifier of the
4928 column view is @code{ITEM}.
4933 The following commands insert or update the dynamic block:
4938 Insert a dynamic block capturing a column view. You will be prompted
4939 for the scope or ID of the view.
4944 Update dynamic block at point. The cursor needs to be in the
4945 @code{#+BEGIN} line of the dynamic block.
4946 @kindex C-u C-c C-x C-u
4947 @item C-u C-c C-x C-u
4948 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
4949 you have several clock table blocks in a buffer.
4952 You can add formulas to the column view table and you may add plotting
4953 instructions in front of the table---these will survive an update of the
4954 block. If there is a @code{#+TBLFM:} after the table, the table will
4955 actually be recalculated automatically after an update.
4957 An alternative way to capture and process property values into a table is
4958 provided by Eric Schulte's @file{org-collector.el} which is a contributed
4959 package@footnote{Contributed packages are not part of Emacs, but are
4960 distributed with the main distribution of Org (visit
4961 @uref{http://orgmode.org}).}. It provides a general API to collect
4962 properties from entries in a certain scope, and arbitrary Lisp expressions to
4963 process these values before inserting them into a table or a dynamic block.
4965 @node Property API, , Column view, Properties and Columns
4966 @section The Property API
4967 @cindex properties, API
4968 @cindex API, for properties
4970 There is a full API for accessing and changing properties. This API can
4971 be used by Emacs Lisp programs to work with properties and to implement
4972 features based on them. For more information see @ref{Using the
4975 @node Dates and Times, Capture - Refile - Archive, Properties and Columns, Top
4976 @chapter Dates and times
4982 To assist project planning, TODO items can be labeled with a date and/or
4983 a time. The specially formatted string carrying the date and time
4984 information is called a @emph{timestamp} in Org-mode. This may be a
4985 little confusing because timestamp is often used as indicating when
4986 something was created or last changed. However, in Org-mode this term
4987 is used in a much wider sense.
4990 * Timestamps:: Assigning a time to a tree entry
4991 * Creating timestamps:: Commands which insert timestamps
4992 * Deadlines and scheduling:: Planning your work
4993 * Clocking work time:: Tracking how long you spend on a task
4994 * Resolving idle time:: Resolving time if you've been idle
4995 * Effort estimates:: Planning work effort in advance
4996 * Relative timer:: Notes with a running timer
5000 @node Timestamps, Creating timestamps, Dates and Times, Dates and Times
5001 @section Timestamps, deadlines, and scheduling
5003 @cindex ranges, time
5008 A timestamp is a specification of a date (possibly with a time or a range of
5009 times) in a special format, either @samp{<2003-09-16 Tue>} or
5010 @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16 Tue
5011 12:00-12:30>}@footnote{This is inspired by the standard ISO 8601 date/time
5012 format. To use an alternative format, see @ref{Custom time format}.}. A
5013 timestamp can appear anywhere in the headline or body of an Org tree entry.
5014 Its presence causes entries to be shown on specific dates in the agenda
5015 (@pxref{Weekly/daily agenda}). We distinguish:
5018 @item Plain timestamp; Event; Appointment
5020 A simple timestamp just assigns a date/time to an item. This is just
5021 like writing down an appointment or event in a paper agenda. In the
5022 timeline and agenda displays, the headline of an entry associated with a
5023 plain timestamp will be shown exactly on that date.
5026 * Meet Peter at the movies <2006-11-01 Wed 19:15>
5027 * Discussion on climate change <2006-11-02 Thu 20:00-22:00>
5030 @item Timestamp with repeater interval
5031 @cindex timestamp, with repeater interval
5032 A timestamp may contain a @emph{repeater interval}, indicating that it
5033 applies not only on the given date, but again and again after a certain
5034 interval of N days (d), weeks (w), months (m), or years (y). The
5035 following will show up in the agenda every Wednesday:
5038 * Pick up Sam at school <2007-05-16 Wed 12:30 +1w>
5041 @item Diary-style sexp entries
5042 For more complex date specifications, Org-mode supports using the
5043 special sexp diary entries implemented in the Emacs calendar/diary
5044 package. For example
5047 * The nerd meeting on every 2nd Thursday of the month
5048 <%%(diary-float t 4 2)>
5051 @item Time/Date range
5054 Two timestamps connected by @samp{--} denote a range. The headline
5055 will be shown on the first and last day of the range, and on any dates
5056 that are displayed and fall in the range. Here is an example:
5059 ** Meeting in Amsterdam
5060 <2004-08-23 Mon>--<2004-08-26 Thu>
5063 @item Inactive timestamp
5064 @cindex timestamp, inactive
5065 @cindex inactive timestamp
5066 Just like a plain timestamp, but with square brackets instead of
5067 angular ones. These timestamps are inactive in the sense that they do
5068 @emph{not} trigger an entry to show up in the agenda.
5071 * Gillian comes late for the fifth time [2006-11-01 Wed]
5076 @node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times
5077 @section Creating timestamps
5078 @cindex creating timestamps
5079 @cindex timestamps, creating
5081 For Org-mode to recognize timestamps, they need to be in the specific
5082 format. All commands listed below produce timestamps in the correct
5088 Prompt for a date and insert a corresponding timestamp. When the cursor is
5089 at an existing timestamp in the buffer, the command is used to modify this
5090 timestamp instead of inserting a new one. When this command is used twice in
5091 succession, a time range is inserted.
5095 Like @kbd{C-c .}, but insert an inactive timestamp that will not cause
5102 @vindex org-time-stamp-rounding-minutes
5103 Like @kbd{C-c .} and @kbd{C-c !}, but use the alternative format which
5104 contains date and time. The default time can be rounded to multiples of 5
5105 minutes, see the option @code{org-time-stamp-rounding-minutes}.
5109 Insert a timestamp corresponding to the cursor date in the Calendar.
5113 Access the Emacs calendar for the current date. If there is a
5114 timestamp in the current line, go to the corresponding date
5119 Access the agenda for the date given by the timestamp or -range at
5120 point (@pxref{Weekly/daily agenda}).
5122 @kindex S-@key{left}
5123 @kindex S-@key{right}
5125 @itemx S-@key{right}
5126 Change date at cursor by one day. These key bindings conflict with
5127 shift-selection and related modes (@pxref{Conflicts}).
5130 @kindex S-@key{down}
5133 Change the item under the cursor in a timestamp. The cursor can be on a
5134 year, month, day, hour or minute. When the timestamp contains a time range
5135 like @samp{15:30-16:30}, modifying the first time will also shift the second,
5136 shifting the time block with constant length. To change the length, modify
5137 the second time. Note that if the cursor is in a headline and not at a
5138 timestamp, these same keys modify the priority of an item.
5139 (@pxref{Priorities}). The key bindings also conflict with shift-selection and
5140 related modes (@pxref{Conflicts}).
5143 @cindex evaluate time range
5145 Evaluate a time range by computing the difference between start and end.
5146 With a prefix argument, insert result after the time range (in a table: into
5147 the following column).
5152 * The date/time prompt:: How Org-mode helps you entering date and time
5153 * Custom time format:: Making dates look different
5156 @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps
5157 @subsection The date/time prompt
5158 @cindex date, reading in minibuffer
5159 @cindex time, reading in minibuffer
5161 @vindex org-read-date-prefer-future
5162 When Org-mode prompts for a date/time, the default is shown in default
5163 date/time format, and the prompt therefore seems to ask for a specific
5164 format. But it will in fact accept any string containing some date and/or
5165 time information, and it is really smart about interpreting your input. You
5166 can, for example, use @kbd{C-y} to paste a (possibly multi-line) string
5167 copied from an email message. Org-mode will find whatever information is in
5168 there and derive anything you have not specified from the @emph{default date
5169 and time}. The default is usually the current date and time, but when
5170 modifying an existing timestamp, or when entering the second stamp of a
5171 range, it is taken from the stamp in the buffer. When filling in
5172 information, Org-mode assumes that most of the time you will want to enter a
5173 date in the future: if you omit the month/year and the given day/month is
5174 @i{before} today, it will assume that you mean a future date@footnote{See the
5175 variable @code{org-read-date-prefer-future}. You may set that variable to
5176 the symbol @code{time} to even make a time before now shift the date to
5177 tomorrow.}. If the date has been automatically shifted into the future, the
5178 time prompt will show this with @samp{(=>F).}
5180 For example, let's assume that today is @b{June 13, 2006}. Here is how
5181 various inputs will be interpreted, the items filled in by Org-mode are
5185 3-2-5 --> 2003-02-05
5186 2/5/3 --> 2003-02-05
5187 14 --> @b{2006}-@b{06}-14
5188 12 --> @b{2006}-@b{07}-12
5189 2/5 --> @b{2007}-02-05
5190 Fri --> nearest Friday (default date or later)
5191 sep 15 --> @b{2006}-09-15
5192 feb 15 --> @b{2007}-02-15
5193 sep 12 9 --> 2009-09-12
5194 12:45 --> @b{2006}-@b{06}-@b{13} 12:45
5195 22 sept 0:34 --> @b{2006}-09-22 0:34
5196 w4 --> ISO week for of the current year @b{2006}
5197 2012 w4 fri --> Friday of ISO week 4 in 2012
5198 2012-w04-5 --> Same as above
5201 Furthermore you can specify a relative date by giving, as the
5202 @emph{first} thing in the input: a plus/minus sign, a number and a
5203 letter ([dwmy]) to indicate change in days, weeks, months, or years. With a
5204 single plus or minus, the date is always relative to today. With a
5205 double plus or minus, it is relative to the default date. If instead of
5206 a single letter, you use the abbreviation of day name, the date will be
5207 the nth such day. E.g.
5212 +4d --> four days from today
5213 +4 --> same as above
5214 +2w --> two weeks from today
5215 ++5 --> five days from default date
5216 +2tue --> second Tuesday from now.
5219 @vindex parse-time-months
5220 @vindex parse-time-weekdays
5221 The function understands English month and weekday abbreviations. If
5222 you want to use unabbreviated names and/or other languages, configure
5223 the variables @code{parse-time-months} and @code{parse-time-weekdays}.
5225 @cindex calendar, for selecting date
5226 @vindex org-popup-calendar-for-date-prompt
5227 Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
5228 you don't need/want the calendar, configure the variable
5229 @code{org-popup-calendar-for-date-prompt}.}. When you exit the date
5230 prompt, either by clicking on a date in the calendar, or by pressing
5231 @key{RET}, the date selected in the calendar will be combined with the
5232 information entered at the prompt. You can control the calendar fully
5233 from the minibuffer:
5240 @kindex S-@key{right}
5241 @kindex S-@key{left}
5242 @kindex S-@key{down}
5244 @kindex M-S-@key{right}
5245 @kindex M-S-@key{left}
5248 @key{RET} @r{Choose date at cursor in calendar.}
5249 mouse-1 @r{Select date by clicking on it.}
5250 S-@key{right}/@key{left} @r{One day forward/backward.}
5251 S-@key{down}/@key{up} @r{One week forward/backward.}
5252 M-S-@key{right}/@key{left} @r{One month forward/backward.}
5253 > / < @r{Scroll calendar forward/backward by one month.}
5254 M-v / C-v @r{Scroll calendar forward/backward by 3 months.}
5257 @vindex org-read-date-display-live
5258 The actions of the date/time prompt may seem complex, but I assure you they
5259 will grow on you, and you will start getting annoyed by pretty much any other
5260 way of entering a date/time out there. To help you understand what is going
5261 on, the current interpretation of your input will be displayed live in the
5262 minibuffer@footnote{If you find this distracting, turn the display of with
5263 @code{org-read-date-display-live}.}.
5265 @node Custom time format, , The date/time prompt, Creating timestamps
5266 @subsection Custom time format
5267 @cindex custom date/time format
5268 @cindex time format, custom
5269 @cindex date format, custom
5271 @vindex org-display-custom-times
5272 @vindex org-time-stamp-custom-formats
5273 Org-mode uses the standard ISO notation for dates and times as it is
5274 defined in ISO 8601. If you cannot get used to this and require another
5275 representation of date and time to keep you happy, you can get it by
5276 customizing the variables @code{org-display-custom-times} and
5277 @code{org-time-stamp-custom-formats}.
5282 Toggle the display of custom formats for dates and times.
5286 Org-mode needs the default format for scanning, so the custom date/time
5287 format does not @emph{replace} the default format---instead it is put
5288 @emph{over} the default format using text properties. This has the
5289 following consequences:
5292 You cannot place the cursor onto a timestamp anymore, only before or
5295 The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
5296 each component of a timestamp. If the cursor is at the beginning of
5297 the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
5298 just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the
5299 time will be changed by one minute.
5301 If the timestamp contains a range of clock times or a repeater, these
5302 will not be overlayed, but remain in the buffer as they were.
5304 When you delete a timestamp character-by-character, it will only
5305 disappear from the buffer after @emph{all} (invisible) characters
5306 belonging to the ISO timestamp have been removed.
5308 If the custom timestamp format is longer than the default and you are
5309 using dates in tables, table alignment will be messed up. If the custom
5310 format is shorter, things do work as expected.
5314 @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times
5315 @section Deadlines and scheduling
5317 A timestamp may be preceded by special keywords to facilitate planning:
5321 @cindex DEADLINE keyword
5323 Meaning: the task (most likely a TODO item, though not necessarily) is supposed
5324 to be finished on that date.
5326 @vindex org-deadline-warning-days
5327 On the deadline date, the task will be listed in the agenda. In
5328 addition, the agenda for @emph{today} will carry a warning about the
5329 approaching or missed deadline, starting
5330 @code{org-deadline-warning-days} before the due date, and continuing
5331 until the entry is marked DONE. An example:
5334 *** TODO write article about the Earth for the Guide
5335 The editor in charge is [[bbdb:Ford Prefect]]
5336 DEADLINE: <2004-02-29 Sun>
5339 You can specify a different lead time for warnings for a specific
5340 deadlines using the following syntax. Here is an example with a warning
5341 period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}.
5344 @cindex SCHEDULED keyword
5346 Meaning: you are planning to start working on that task on the given
5349 @vindex org-agenda-skip-scheduled-if-done
5350 The headline will be listed under the given date@footnote{It will still
5351 be listed on that date after it has been marked DONE. If you don't like
5352 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In
5353 addition, a reminder that the scheduled date has passed will be present
5354 in the compilation for @emph{today}, until the entry is marked DONE.
5355 I.e. the task will automatically be forwarded until completed.
5358 *** TODO Call Trillian for a date on New Years Eve.
5359 SCHEDULED: <2004-12-25 Sat>
5363 @b{Important:} Scheduling an item in Org-mode should @i{not} be
5364 understood in the same way that we understand @i{scheduling a meeting}.
5365 Setting a date for a meeting is just a simple appointment, you should
5366 mark this entry with a simple plain timestamp, to get this item shown
5367 on the date where it applies. This is a frequent misunderstanding by
5368 Org users. In Org-mode, @i{scheduling} means setting a date when you
5369 want to start working on an action item.
5372 You may use timestamps with repeaters in scheduling and deadline
5373 entries. Org-mode will issue early and late warnings based on the
5374 assumption that the timestamp represents the @i{nearest instance} of
5375 the repeater. However, the use of diary sexp entries like
5377 @code{<%%(diary-float t 42)>}
5379 in scheduling and deadline timestamps is limited. Org-mode does not
5380 know enough about the internals of each sexp function to issue early and
5381 late warnings. However, it will show the item on each day where the
5385 * Inserting deadline/schedule:: Planning items
5386 * Repeated tasks:: Items that show up again and again
5389 @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling
5390 @subsection Inserting deadlines or schedules
5392 The following commands allow you to quickly insert a deadline or to schedule
5399 Insert @samp{DEADLINE} keyword along with a stamp. The insertion will happen
5400 in the line directly following the headline. When called with a prefix arg,
5401 an existing deadline will be removed from the entry. Depending on the
5402 variable @code{org-log-redeadline}@footnote{with corresponding
5403 @code{#+STARTUP} keywords @code{logredeadline}, @code{lognoteredeadline},
5404 and @code{nologredeadline}}, a note will be taken when changing an existing
5406 @c FIXME Any CLOSED timestamp will be removed.????????
5410 Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will
5411 happen in the line directly following the headline. Any CLOSED timestamp
5412 will be removed. When called with a prefix argument, remove the scheduling
5413 date from the entry. Depending on the variable
5414 @code{org-log-reschedule}@footnote{with corresponding @code{#+STARTUP}
5415 keywords @code{logredeadline}, @code{lognoteredeadline}, and
5416 @code{nologredeadline}}, a note will be taken when changing an existing
5423 Mark the current entry for agenda action. After you have marked the entry
5424 like this, you can open the agenda or the calendar to find an appropriate
5425 date. With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to
5426 schedule the marked item.
5429 @cindex sparse tree, for deadlines
5431 @vindex org-deadline-warning-days
5432 Create a sparse tree with all deadlines that are either past-due, or
5433 which will become due within @code{org-deadline-warning-days}.
5434 With @kbd{C-u} prefix, show all deadlines in the file. With a numeric
5435 prefix, check that many days. For example, @kbd{C-1 C-c / d} shows
5436 all deadlines due tomorrow.
5440 Sparse tree for deadlines and scheduled items before a given date.
5444 Sparse tree for deadlines and scheduled items after a given date.
5447 @node Repeated tasks, , Inserting deadline/schedule, Deadlines and scheduling
5448 @subsection Repeated tasks
5449 @cindex tasks, repeated
5450 @cindex repeated tasks
5452 Some tasks need to be repeated again and again. Org-mode helps to
5453 organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
5454 or plain timestamp. In the following example
5456 ** TODO Pay the rent
5457 DEADLINE: <2005-10-01 Sat +1m>
5460 the @code{+1m} is a repeater; the intended interpretation is that the task
5461 has a deadline on <2005-10-01> and repeats itself every (one) month starting
5462 from that time. If you need both a repeater and a special warning period in
5463 a deadline entry, the repeater should come first and the warning period last:
5464 @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
5466 @vindex org-todo-repeat-to-state
5467 Deadlines and scheduled items produce entries in the agenda when they are
5468 over-due, so it is important to be able to mark such an entry as completed
5469 once you have done so. When you mark a DEADLINE or a SCHEDULE with the TODO
5470 keyword DONE, it will no longer produce entries in the agenda. The problem
5471 with this is, however, that then also the @emph{next} instance of the
5472 repeated entry will not be active. Org-mode deals with this in the following
5473 way: When you try to mark such an entry DONE (using @kbd{C-c C-t}), it will
5474 shift the base date of the repeating timestamp by the repeater interval, and
5475 immediately set the entry state back to TODO@footnote{In fact, the target
5476 state is taken from, in this sequence, the @code{REPEAT_TO_STATE} property or
5477 the variable @code{org-todo-repeat-to-state}. If neither of these is
5478 specified, the target state defaults to the first state of the TODO state
5479 sequence.}. In the example above, setting the state to DONE would actually
5480 switch the date like this:
5483 ** TODO Pay the rent
5484 DEADLINE: <2005-11-01 Tue +1m>
5487 @vindex org-log-repeat
5488 A timestamp@footnote{You can change this using the option
5489 @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
5490 @code{lognoterepeat}, and @code{nologrepeat}. With @code{lognoterepeat}, you
5491 will also be prompted for a note.} will be added under the deadline, to keep
5492 a record that you actually acted on the previous instance of this deadline.
5494 As a consequence of shifting the base date, this entry will no longer be
5495 visible in the agenda when checking past dates, but all future instances
5498 With the @samp{+1m} cookie, the date shift will always be exactly one
5499 month. So if you have not paid the rent for three months, marking this
5500 entry DONE will still keep it as an overdue deadline. Depending on the
5501 task, this may not be the best way to handle it. For example, if you
5502 forgot to call you father for 3 weeks, it does not make sense to call
5503 him 3 times in a single day to make up for it. Finally, there are tasks
5504 like changing batteries which should always repeat a certain time
5505 @i{after} the last time you did it. For these tasks, Org-mode has
5506 special repeaters markers with @samp{++} and @samp{.+}. For example:
5510 DEADLINE: <2008-02-10 Sun ++1w>
5511 Marking this DONE will shift the date by at least one week,
5512 but also by as many weeks as it takes to get this date into
5513 the future. However, it stays on a Sunday, even if you called
5514 and marked it done on Saturday.
5515 ** TODO Check the batteries in the smoke detectors
5516 DEADLINE: <2005-11-01 Tue .+1m>
5517 Marking this DONE will shift the date to one month after
5521 You may have both scheduling and deadline information for a specific
5522 task---just make sure that the repeater intervals on both are the same.
5524 An alternative to using a repeater is to create a number of copies of a task
5525 subtree, with dates shifted in each copy. The command @kbd{C-c C-x c} was
5526 created for this purpose, it is described in @ref{Structure editing}.
5529 @node Clocking work time, Resolving idle time, Deadlines and scheduling, Dates and Times
5530 @section Clocking work time
5532 Org-mode allows you to clock the time you spend on specific tasks in a
5533 project. When you start working on an item, you can start the clock.
5534 When you stop working on that task, or when you mark the task done, the
5535 clock is stopped and the corresponding time interval is recorded. It
5536 also computes the total time spent on each subtree of a project. And it
5537 remembers a history or tasks recently clocked, to that you can jump quickly
5538 between a number of tasks absorbing your time.
5540 To save the clock history across Emacs sessions, use
5542 (setq org-clock-persist 'history)
5543 (org-clock-persistence-insinuate)
5545 When you clock into a new task after resuming Emacs, the incomplete
5546 clock@footnote{To resume the clock under the assumption that you have worked
5547 on this task while outside Emacs, use @code{(setq org-clock-persist t)}.}
5548 will be found (@pxref{Resolving idle time}) and you will be prompted about
5554 @vindex org-clock-into-drawer
5555 Start the clock on the current item (clock-in). This inserts the CLOCK
5556 keyword together with a timestamp. If this is not the first clocking of
5557 this item, the multiple CLOCK lines will be wrapped into a
5558 @code{:LOGBOOK:} drawer (see also the variable
5559 @code{org-clock-into-drawer}). When called with a @kbd{C-u} prefix argument,
5560 select the task from a list of recently clocked tasks. With two @kbd{C-u
5561 C-u} prefixes, clock into the task at point and mark it as the default task.
5562 The default task will always be available when selecting a clocking task,
5563 with letter @kbd{d}.@*
5564 @cindex property: CLOCK_MODELINE_TOTAL
5565 @cindex property: LAST_REPEAT
5566 @vindex org-clock-modeline-total
5567 While the clock is running, the current clocking time is shown in the mode
5568 line, along with the title of the task. The clock time shown will be all
5569 time ever clocked for this task and its children. If the task has an effort
5570 estimate (@pxref{Effort estimates}), the mode line displays the current
5571 clocking time against it@footnote{To add an effort estimate ``on the fly'',
5572 hook a function doing this to @code{org-clock-in-prepare-hook}.} If the task
5573 is a repeating one (@pxref{Repeated tasks}), only the time since the last
5574 reset of the task @footnote{as recorded by the @code{LAST_REPEAT} property}
5575 will be shown. More control over what time is shown can be exercised with
5576 the @code{CLOCK_MODELINE_TOTAL} property. It may have the values
5577 @code{current} to show only the current clocking instance, @code{today} to
5578 show all time clocked on this tasks today (see also the variable
5579 @code{org-extend-today-until}), @code{all} to include all time, or
5580 @code{auto} which is the default@footnote{See also the variable
5581 @code{org-clock-modeline-total}.}.@* Clicking with @kbd{mouse-1} onto the
5582 mode line entry will pop up a menu with clocking options.
5585 @vindex org-log-note-clock-out
5586 Stop the clock (clock-out). This inserts another timestamp at the same
5587 location where the clock was last started. It also directly computes
5588 the resulting time in inserts it after the time range as @samp{=>
5589 HH:MM}. See the variable @code{org-log-note-clock-out} for the
5590 possibility to record an additional note together with the clock-out
5591 timestamp@footnote{The corresponding in-buffer setting is:
5592 @code{#+STARTUP: lognoteclock-out}}.
5595 Update the effort estimate for the current clock task.
5598 @item C-c C-y @ @ @r{or}@ @ C-c C-c
5599 Recompute the time interval after changing one of the timestamps. This
5600 is only necessary if you edit the timestamps directly. If you change
5601 them with @kbd{S-@key{cursor}} keys, the update is automatic.
5604 Changing the TODO state of an item to DONE automatically stops the clock
5605 if it is running in this same item.
5608 Cancel the current clock. This is useful if a clock was started by
5609 mistake, or if you ended up working on something else.
5612 Jump to the entry that contains the currently running clock. With a
5613 @kbd{C-u} prefix arg, select the target task from a list of recently clocked
5617 @vindex org-remove-highlights-with-change
5618 Display time summaries for each subtree in the current buffer. This
5619 puts overlays at the end of each headline, showing the total time
5620 recorded under that heading, including the time of any subheadings. You
5621 can use visibility cycling to study the tree, but the overlays disappear
5622 when you change the buffer (see variable
5623 @code{org-remove-highlights-with-change}) or press @kbd{C-c C-c}.
5626 Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
5627 report as an Org-mode table into the current file. When the cursor is
5628 at an existing clock table, just update it. When called with a prefix
5629 argument, jump to the first clock report in the current document and
5631 @cindex #+BEGIN, clocktable
5633 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
5637 If such a block already exists at point, its content is replaced by the
5638 new table. The @samp{BEGIN} line can specify options:
5640 :maxlevel @r{Maximum level depth to which times are listed in the table.}
5641 :emphasize @r{When @code{t}, emphasize level one and level two items.}
5642 :scope @r{The scope to consider. This can be any of the following:}
5643 nil @r{the current buffer or narrowed region}
5644 file @r{the full current buffer}
5645 subtree @r{the subtree where the clocktable is located}
5646 tree@var{N} @r{the surrounding level @var{N} tree, for example @code{tree3}}
5647 tree @r{the surrounding level 1 tree}
5648 agenda @r{all agenda files}
5649 ("file"..) @r{scan these files}
5650 file-with-archives @r{current file and its archives}
5651 agenda-with-archives @r{all agenda files, including archives}
5652 :block @r{The time block to consider. This block is specified either}
5653 @r{absolute, or relative to the current time and may be any of}
5655 2007-12-31 @r{New year eve 2007}
5656 2007-12 @r{December 2007}
5657 2007-W50 @r{ISO-week 50 in 2007}
5658 2007 @r{the year 2007}
5659 today, yesterday, today-@var{N} @r{a relative day}
5660 thisweek, lastweek, thisweek-@var{N} @r{a relative week}
5661 thismonth, lastmonth, thismonth-@var{N} @r{a relative month}
5662 thisyear, lastyear, thisyear-@var{N} @r{a relative year}
5663 @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
5664 :tstart @r{A time string specifying when to start considering times.}
5665 :tend @r{A time string specifying when to stop considering times.}
5666 :step @r{@code{week} or @code{day}, to split the table into chunks.}
5667 @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
5668 :stepskip0 @r{Don't show steps that have zero time}
5669 :tags @r{A tags match to select entries that should contribute}
5670 :link @r{Link the item headlines in the table to their origins.}
5671 :formula @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
5672 @r{As a special case, @samp{:formula %} adds a column with % time.}
5673 @r{If you do not specify a formula here, any existing formula.}
5674 @r{below the clock table will survive updates and be evaluated.}
5675 :timestamp @r{A timestamp for the entry, when available. Look for SCHEDULED,}
5676 @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.}
5678 To get a clock summary of the current level 1 tree, for the current
5679 day, you could write
5681 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
5685 and to use a specific time range you could write@footnote{Note that all
5686 parameters must be specified in a single line---the line is broken here
5687 only to fit it into the manual.}
5689 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
5690 :tend "<2006-08-10 Thu 12:00>"
5693 A summary of the current subtree with % times would be
5695 #+BEGIN: clocktable :scope subtree :link t :formula %
5702 Update dynamic block at point. The cursor needs to be in the
5703 @code{#+BEGIN} line of the dynamic block.
5704 @kindex C-u C-c C-x C-u
5705 @item C-u C-c C-x C-u
5706 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
5707 you have several clock table blocks in a buffer.
5708 @kindex S-@key{left}
5709 @kindex S-@key{right}
5711 @itemx S-@key{right}
5712 Shift the current @code{:block} interval and update the table. The cursor
5713 needs to be in the @code{#+BEGIN: clocktable} line for this command. If
5714 @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
5717 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
5718 the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
5719 worked on or closed during a day.
5721 @node Resolving idle time, Effort estimates, Clocking work time, Dates and Times
5722 @section Resolving idle time
5723 @cindex resolve idle time
5725 @cindex idle, resolve, dangling
5726 If you clock in on a work item, and then walk away from your
5727 computer---perhaps to take a phone call---you often need to ``resolve'' the
5728 time you were away by either subtracting it from the current clock, or
5729 applying it to another one.
5731 @vindex org-clock-idle-time
5732 By customizing the variable @code{org-clock-idle-time} to some integer, such
5733 as 10 or 15, Emacs can alert you when you get back to your computer after
5734 being idle for that many minutes@footnote{On computers using Mac OS X,
5735 idleness is based on actual user idleness, not just Emacs' idle time. For
5736 X11, you can install a utility program @file{x11idle.c}, available in the
5737 UTILITIES directory of the Org git distribution, to get the same general
5738 treatment of idleness. On other systems, idle time refers to Emacs idle time
5739 only.}, and ask what you want to do with the idle time. There will be a
5740 question waiting for you when you get back, indicating how much idle time has
5741 passed (constantly updated with the current amount), as well as a set of
5742 choices to correct the discrepancy:
5746 To keep some or all of the minutes and stay clocked in, press @kbd{k}. Org
5747 will ask how many of the minutes to keep. Press @key{RET} to keep them all,
5748 effectively changing nothing, or enter a number to keep that many minutes.
5750 If you use the shift key and press @kbd{K}, it will keep however many minutes
5751 you request and then immediately clock out of that task. If you keep all of
5752 the minutes, this is the same as just clocking out of the current task.
5754 To keep none of the minutes, use @kbd{s} to subtract all the away time from
5755 the clock, and then check back in from the moment you returned.
5757 To keep none of the minutes and just clock out at the start of the away time,
5758 use the shift key and press @kbd{S}. Remember that using shift will always
5759 leave you clocked out, no matter which option you choose.
5761 To cancel the clock altogether, use @kbd{C}. Note that if instead of
5762 canceling you subtract the away time, and the resulting clock amount is less
5763 than a minute, the clock will still be canceled rather than clutter up the
5764 log with an empty entry.
5767 What if you subtracted those away minutes from the current clock, and now
5768 want to apply them to a new clock? Simply clock in to any task immediately
5769 after the subtraction. Org will notice that you have subtracted time ``on
5770 the books'', so to speak, and will ask if you want to apply those minutes to
5771 the next task you clock in on.
5773 There is one other instance when this clock resolution magic occurs. Say you
5774 were clocked in and hacking away, and suddenly your cat chased a mouse who
5775 scared a hamster that crashed into your UPS's power button! You suddenly
5776 lose all your buffers, but thanks to auto-save you still have your recent Org
5777 mode changes, including your last clock in.
5779 If you restart Emacs and clock into any task, Org will notice that you have a
5780 dangling clock which was never clocked out from your last session. Using
5781 that clock's starting time as the beginning of the unaccounted-for period,
5782 Org will ask how you want to resolve that time. The logic and behavior is
5783 identical to dealing with away time due to idleness, it's just happening due
5784 to a recovery event rather than a set amount of idle time.
5786 You can also check all the files visited by your Org agenda for dangling
5787 clocks at any time using @kbd{M-x org-resolve-clocks}.
5789 @node Effort estimates, Relative timer, Resolving idle time, Dates and Times
5790 @section Effort estimates
5791 @cindex effort estimates
5793 @cindex property, Effort
5794 @vindex org-effort-property
5795 If you want to plan your work in a very detailed way, or if you need to
5796 produce offers with quotations of the estimated work effort, you may want to
5797 assign effort estimates to entries. If you are also clocking your work, you
5798 may later want to compare the planned effort with the actual working time, a
5799 great way to improve planning estimates. Effort estimates are stored in a
5800 special property @samp{Effort}@footnote{You may change the property being
5801 used with the variable @code{org-effort-property}.}. You can set the effort
5802 for an entry with the following commands:
5807 Set the effort estimate for the current entry. With a numeric prefix
5808 argument, set it to the NTH allowed value (see below). This command is also
5809 accessible from the agenda with the @kbd{e} key.
5812 Modify the effort estimate of the item currently being clocked.
5815 Clearly the best way to work with effort estimates is through column view
5816 (@pxref{Column view}). You should start by setting up discrete values for
5817 effort estimates, and a @code{COLUMNS} format that displays these values
5818 together with clock sums (if you want to clock your time). For a specific
5822 #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00
5823 #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
5827 @vindex org-global-properties
5828 @vindex org-columns-default-format
5829 or, even better, you can set up these values globally by customizing the
5830 variables @code{org-global-properties} and @code{org-columns-default-format}.
5831 In particular if you want to use this setup also in the agenda, a global
5832 setup may be advised.
5834 The way to assign estimates to individual items is then to switch to column
5835 mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
5836 value. The values you enter will immediately be summed up in the hierarchy.
5837 In the column next to it, any clocked time will be displayed.
5839 @vindex org-agenda-columns-add-appointments-to-effort-sum
5840 If you switch to column view in the daily/weekly agenda, the effort column
5841 will summarize the estimated work effort for each day@footnote{Please note
5842 the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
5843 column view}).}, and you can use this to find space in your schedule. To get
5844 an overview of the entire part of the day that is committed, you can set the
5845 option @code{org-agenda-columns-add-appointments-to-effort-sum}. The
5846 appointments on a day that take place over a specified time interval will
5847 then also be added to the load estimate of the day.
5849 Effort estimates can be used in secondary agenda filtering that is triggered
5850 with the @kbd{/} key in the agenda (@pxref{Agenda commands}). If you have
5851 these estimates defined consistently, two or three key presses will narrow
5852 down the list to stuff that fits into an available time slot.
5854 @node Relative timer, , Effort estimates, Dates and Times
5855 @section Taking notes with a relative timer
5856 @cindex relative timer
5858 When taking notes during, for example, a meeting or a video viewing, it can
5859 be useful to have access to times relative to a starting time. Org provides
5860 such a relative timer and make it easy to create timed notes.
5865 Insert a relative time into the buffer. The first time you use this, the
5866 timer will be started. When called with a prefix argument, the timer is
5870 Insert a description list item with the current relative time. With a prefix
5871 argument, first reset the timer to 0.
5874 Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
5878 Pause the timer, or continue it if it is already paused.
5879 @c removed the sentence because it is redundant to the following item
5880 @kindex C-u C-c C-x ,
5882 Stop the timer. After this, you can only start a new timer, not continue the
5883 old one. This command also removes the timer from the mode line.
5886 Reset the timer without inserting anything into the buffer. By default, the
5887 timer is reset to 0. When called with a @kbd{C-u} prefix, reset the timer to
5888 specific starting offset. The user is prompted for the offset, with a
5889 default taken from a timer string at point, if any, So this can be used to
5890 restart taking notes after a break in the process. When called with a double
5891 prefix argument @kbd{C-u C-u}, change all timer strings in the active region
5892 by a certain amount. This can be used to fix timer strings if the timer was
5893 not started at exactly the right moment.
5896 @node Capture - Refile - Archive, Agenda Views, Dates and Times, Top
5897 @chapter Capture - Refile - Archive
5900 An important part of any organization system is the ability to quickly
5901 capture new ideas and tasks, and to associate reference material with them.
5902 Org does this using a process called @i{capture}. It also can store files
5903 related to a task (@i{attachments}) in a special directory. Once in the
5904 system, tasks and projects need to be moved around. Moving completed project
5905 trees to an archive file keeps the system compact and fast.
5908 * Capture:: Capturing new stuff
5909 * Attachments:: Add files to tasks
5910 * RSS Feeds:: Getting input from RSS feeds
5911 * Protocols:: External (e.g. Browser) access to Emacs and Org
5912 * Refiling notes:: Moving a tree from one place to another
5913 * Archiving:: What to do with finished projects
5916 @node Capture, Attachments, Capture - Refile - Archive, Capture - Refile - Archive
5920 Org's method for capturing new items is heavily inspired by John Wiegley
5921 excellent remember package. Up to version 6.36 Org used a special setup
5922 for @file{remember.el}. @file{org-remember.el} is still part of Org-mode for
5923 backward compatibility with existing setups. You can find the documentation
5924 for org-remember at @url{http://orgmode.org/org-remember.pdf}.
5926 The new capturing setup described here is preferred and should be used by new
5927 users. To convert your @code{org-remember-templates}, run the command
5929 @kbd{M-x org-capture-import-remember-templates @key{RET}}
5931 @noindent and then customize the new variable with @kbd{M-x
5932 customize-variable org-capture-templates}, check the result, and save the
5933 customization. You can then use both remember and capture until
5934 you are familiar with the new mechanism.
5936 Capture lets you quickly store notes with little interruption of your work
5937 flow. The basic process of capturing is very similar to remember, but Org
5938 does enhance it with templates and more.
5941 * Setting up capture:: Where notes will be stored
5942 * Using capture:: Commands to invoke and terminate capture
5943 * Capture templates:: Define the outline of different note types
5946 @node Setting up capture, Using capture, Capture, Capture
5947 @subsection Setting up capture
5949 The following customization sets a default target file for notes, and defines
5950 a global key@footnote{Please select your own key, @kbd{C-c c} is only a
5951 suggestion.} for capturing new material.
5953 @vindex org-default-notes-file
5955 (setq org-default-notes-file (concat org-directory "/notes.org"))
5956 (define-key global-map "\C-cc" 'org-capture)
5959 @node Using capture, Capture templates, Setting up capture, Capture
5960 @subsection Using capture
5965 Call the command @code{org-capture}. If you have templates defined
5966 @pxref{Capture templates}, it will offer these templates for selection or use
5967 a new Org outline node as the default template. It will insert the template
5968 into the target file and switch to an indirect buffer narrowed to this new
5969 node. You may then insert the information you want.
5973 Once you have finished entering information into the capture buffer,
5974 @kbd{C-c C-c} will return you to the window configuration before the capture
5975 process, so that you can resume your work without further distraction.
5979 Finalize the capture process by refiling (@pxref{Refiling notes}) the note to
5984 Abort the capture process and return to the previous state.
5987 You can also call @code{org-capture} in a special way from the agenda, using
5988 the @kbd{k c} key combination. With this access, any timestamps inserted by
5989 the selected capture template will default to the cursor date in the agenda,
5990 rather than to the current date.
5992 @node Capture templates, , Using capture, Capture
5993 @subsection Capture templates
5994 @cindex templates, for Capture
5996 You can use templates for different types of capture items, and
5997 for different target locations. The easiest way to create such templates is
5998 through the customize interface.
6003 Customize the variable @code{org-capture-templates}.
6006 Before we give the formal description of template definitions, let's look at
6007 an example. Say you would like to use one template to create general TODO
6008 entries, and you want to put these entries under the heading @samp{Tasks} in
6009 your file @file{~/org/gtd.org}. Also, a date tree in the file
6010 @file{journal.org} should capture journal entries. A possible configuration
6014 (setq org-capture-templates
6015 '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks")
6016 "* TODO %?\n %i\n %a")
6017 ("j" "Journal" entry (file+datetree "~/org/journal.org")
6018 "* %?\nEntered on %U\n %i\n %a")))
6021 @noindent If you then press @kbd{C-c c t}, Org will prepare the template
6025 [[file:@var{link to where you initiated capture}]]
6029 During expansion of the template, @code{%a} has been replaced by a link to
6030 the location from where you called the capture command. This can be
6031 extremely useful for deriving tasks from emails, for example. You fill in
6032 the task definition, press @code{C-c C-c} and Org returns you to the same
6033 place where you started the capture process.
6037 * Template elements:: What is needed for a complete template entry
6038 * Template expansion:: Filling in information about time and context
6041 @node Template elements, Template expansion, Capture templates, Capture templates
6042 @subsubsection Template elements
6044 Now lets look at the elements of a template definition. Each entry in
6045 @code{org-capture-templates} is a list with the following items:
6049 The keys that will select the template, as a string, characters
6050 only, for example @code{"a"} for a template to be selected with a
6051 single key, or @code{"bt"} for selection with two keys. When using
6052 several keys, keys using the same prefix key must be sequential
6053 in the list and preceded by a 2-element entry explaining the
6054 prefix key, for example
6056 ("b" "Templates for marking stuff to buy")
6058 @noindent If you do not define a template for the @kbd{C} key, this key will
6059 be used to open the customize buffer for this complex variable.
6062 A short string describing the template, which will be shown during
6066 The type of entry, a symbol. Valid values are:
6069 An Org-mode node, with a headline. Will be filed as the child of the
6070 target entry or as a top-level entry. The target file should be an Org-mode
6073 A plain list item, placed in the first plain list at the target
6074 location. Again the target file should be an Org file.
6076 A checkbox item. This only differs from the plain list item by the
6079 a new line in the first table at the target location. Where exactly the
6080 line will be inserted depends on the properties @code{:prepend} and
6081 @code{:table-line-pos} (see below).
6083 Text to be inserted as it is.
6087 @vindex org-default-notes-file
6088 Specification of where the captured item should be placed. In Org-mode
6089 files, targets usually define a node. Entries will become children of this
6090 node, other types will be added to the table or list in the body of this
6091 node. Most target specifications contain a file name. If that file name is
6092 the empty string, it defaults to @code{org-default-notes-file}.
6096 @item (file "path/to/file")
6097 Text will be placed at the beginning or end of that file.
6099 @item (id "id of existing org entry")
6100 Filing as child of this entry, or in the body of the entry.
6102 @item (file+headline "path/to/file" "node headline")
6103 Fast configuration if the target heading is unique in the file.
6105 @item (file+olp "path/to/file" "Level 1 heading" "Level 2" ...)
6106 For non-unique headings, the full path is safer.
6108 @item (file+regexp "path/to/file" "regexp to find location")
6109 Use a regular expression to position the cursor.
6111 @item (file+datetree "path/to/file")
6112 Will create a heading in a date tree.
6114 @item (file+function "path/to/file" function-finding-location)
6115 A function to find the right location in the file.
6118 File to the entry that is currently being clocked.
6120 @item (function function-finding-location)
6121 Most general way, write your own function to find both
6126 The template for creating the capture item. If you leave this empty, an
6127 appropriate default template will be used. Otherwise this is a string with
6128 escape codes, which will be replaced depending on time and context of the
6129 capture call. The string with escapes may be loaded from a template file,
6130 using the special syntax @code{(file "path/to/template")}. See below for
6134 The rest of the entry is a property list of additional options.
6135 Recognized properties are:
6138 Normally new captured information will be appended at
6139 the target location (last child, last table line, last list item...).
6140 Setting this property will change that.
6142 @item :immediate-finish
6143 When set, do not offer to edit the information, just
6144 file it away immediately. This makes sense if the template only needs
6145 information that can be added automatically.
6148 Set this to the number of lines to insert
6149 before and after the new item. Default 0, only common other value is 1.
6152 Start the clock in this item.
6155 If starting the capture interrupted a clock, restart that clock when finished
6159 Do not narrow the target buffer, simply show the full buffer. Default is to
6160 narrow it so that you only see the new material.
6164 @node Template expansion, , Template elements, Capture templates
6165 @subsubsection Template expansion
6167 In the template itself, special @kbd{%}-escapes@footnote{If you need one of
6168 these sequences literally, escape the @kbd{%} with a backslash.} allow
6169 dynamic insertion of content:
6171 @comment SJE: should these sentences terminate in period?
6173 %^@{@var{prompt}@} @r{prompt the user for a string and replace this sequence with it.}
6174 @r{You may specify a default value and a completion table with}
6175 @r{%^@{prompt|default|completion2|completion3...@}}
6176 @r{The arrow keys access a prompt-specific history.}
6177 %a @r{annotation, normally the link created with @code{org-store-link}}
6178 %A @r{like @code{%a}, but prompt for the description part}
6179 %i @r{initial content, the region when capture is called while the}
6180 @r{region is active.}
6181 @r{The entire text will be indented like @code{%i} itself.}
6182 %t @r{timestamp, date only}
6183 %T @r{timestamp with date and time}
6184 %u, %U @r{like the above, but inactive timestamps}
6185 %^t @r{like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}}
6186 @r{You may define a prompt like @code{%^@{Birthday@}t}}
6187 %n @r{user name (taken from @code{user-full-name})}
6188 %c @r{Current kill ring head.}
6189 %x @r{Content of the X clipboard.}
6190 %^C @r{Interactive selection of which kill or clip to use.}
6191 %^L @r{Like @code{%^C}, but insert as link.}
6192 %k @r{title of the currently clocked task}
6193 %K @r{link to the currently clocked task}
6194 %^g @r{prompt for tags, with completion on tags in target file.}
6195 %^G @r{prompt for tags, with completion all tags in all agenda files.}
6196 %^@{@var{prop}@}p @r{Prompt the user for a value for property @var{prop}}
6197 %:keyword @r{specific information for certain link types, see below}
6198 %[@var{file}] @r{insert the contents of the file given by @var{file}}
6199 %(@var{sexp}) @r{evaluate Elisp @var{sexp} and replace with the result}
6203 For specific link types, the following keywords will be
6204 defined@footnote{If you define your own link types (@pxref{Adding
6205 hyperlink types}), any property you store with
6206 @code{org-store-link-props} can be accessed in capture templates in a
6209 @vindex org-from-is-user-regexp
6211 Link type | Available keywords
6212 -------------------+----------------------------------------------
6213 bbdb | %:name %:company
6214 bbdb | %::server %:port %:nick
6215 vm, wl, mh, rmail | %:type %:subject %:message-id
6216 | %:from %:fromname %:fromaddress
6217 | %:to %:toname %:toaddress
6218 | %: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}.}}
6219 gnus | %:group, @r{for messages also all email fields}
6221 info | %:file %:node
6226 To place the cursor after template expansion use:
6229 %? @r{After completing the template, position cursor here.}
6233 @node Attachments, RSS Feeds, Capture, Capture - Refile - Archive
6234 @section Attachments
6237 @vindex org-attach-directory
6238 It is often useful to associate reference material with an outline node/task.
6239 Small chunks of plain text can simply be stored in the subtree of a project.
6240 Hyperlinks (@pxref{Hyperlinks}) can establish associations with
6241 files that live elsewhere on your computer or in the cloud, like emails or
6242 source code files belonging to a project. Another method is @i{attachments},
6243 which are files located in a directory belonging to an outline node. Org
6244 uses directories named by the unique ID of each entry. These directories are
6245 located in the @file{data} directory which lives in the same directory where
6246 your Org file lives@footnote{If you move entries or Org files from one
6247 directory to another, you may want to configure @code{org-attach-directory}
6248 to contain an absolute path.}. If you initialize this directory with
6249 @code{git init}, Org will automatically commit changes when it sees them.
6250 The attachment system has been contributed to Org by John Wiegley.
6252 In cases where it seems better to do so, you can also attach a directory of your
6253 choice to an entry. You can also make children inherit the attachment
6254 directory from a parent, so that an entire subtree uses the same attached
6257 @noindent The following commands deal with attachments:
6263 The dispatcher for commands related to the attachment system. After these
6264 keys, a list of commands is displayed and you must press an additional key
6265 to select a command:
6270 @vindex org-attach-method
6271 Select a file and move it into the task's attachment directory. The file
6272 will be copied, moved, or linked, depending on @code{org-attach-method}.
6273 Note that hard links are not supported on all systems.
6279 Attach a file using the copy/move/link method.
6280 Note that hard links are not supported on all systems.
6284 Create a new attachment as an Emacs buffer.
6288 Synchronize the current task with its attachment directory, in case you added
6289 attachments yourself.
6293 @vindex org-file-apps
6294 Open current task's attachment. If there is more than one, prompt for a
6295 file name first. Opening will follow the rules set by @code{org-file-apps}.
6296 For more details, see the information on following hyperlinks
6297 (@pxref{Handling links}).
6301 Also open the attachment, but force opening the file in Emacs.
6305 Open the current task's attachment directory.
6309 Also open the directory, but force using @command{dired} in Emacs.
6313 Select and delete a single attachment.
6317 Delete all of a task's attachments. A safer way is to open the directory in
6318 @command{dired} and delete from there.
6322 @cindex property, ATTACH_DIR
6323 Set a specific directory as the entry's attachment directory. This works by
6324 putting the directory path into the @code{ATTACH_DIR} property.
6328 @cindex property, ATTACH_DIR_INHERIT
6329 Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
6330 same directory for attachments as the parent does.
6334 @node RSS Feeds, Protocols, Attachments, Capture - Refile - Archive
6339 Org can add and change entries based on information found in RSS feeds and
6340 Atom feeds. You could use this to make a task out of each new podcast in a
6341 podcast feed. Or you could use a phone-based note-creating service on the
6342 web to import tasks into Org. To access feeds, configure the variable
6343 @code{org-feed-alist}. The docstring of this variable has detailed
6344 information. Here is just an example:
6347 (setq org-feed-alist
6349 "http://rss.slashdot.org/Slashdot/slashdot"
6350 "~/txt/org/feeds.org" "Slashdot Entries")))
6354 will configure that new items from the feed provided by
6355 @code{rss.slashdot.org} will result in new entries in the file
6356 @file{~/org/feeds.org} under the heading @samp{Slashdot Entries}, whenever
6357 the following command is used:
6362 Collect items from the feeds configured in @code{org-feed-alist} and act upon
6366 Prompt for a feed name and go to the inbox configured for this feed.
6369 Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which
6370 it will store information about the status of items in the feed, to avoid
6371 adding the same item several times. You should add @samp{FEEDSTATUS} to the
6372 list of drawers in that file:
6375 #+DRAWERS: LOGBOOK PROPERTIES FEEDSTATUS
6378 For more information, including how to read atom feeds, see
6379 @file{org-feed.el} and the docstring of @code{org-feed-alist}.
6381 @node Protocols, Refiling notes, RSS Feeds, Capture - Refile - Archive
6382 @section Protocols for external access
6383 @cindex protocols, for external access
6386 You can set up Org for handling protocol calls from outside applications that
6387 are passed to Emacs through the @file{emacsserver}. For example, you can
6388 configure bookmarks in your web browser to send a link to the current page to
6389 Org and create a note from it using capture (@pxref{Capture}). Or you
6390 could create a bookmark that will tell Emacs to open the local source file of
6391 a remote website you are looking at with the browser. See
6392 @uref{http://orgmode.org/worg/org-contrib/org-protocol.php} for detailed
6393 documentation and setup instructions.
6395 @node Refiling notes, Archiving, Protocols, Capture - Refile - Archive
6396 @section Refiling notes
6397 @cindex refiling notes
6399 When reviewing the captured data, you may want to refile some of the entries
6400 into a different list, for example into a project. Cutting, finding the
6401 right location, and then pasting the note is cumbersome. To simplify this
6402 process, you can use the following special command:
6407 @vindex org-reverse-note-order
6408 @vindex org-refile-targets
6409 @vindex org-refile-use-outline-path
6410 @vindex org-outline-path-complete-in-steps
6411 @vindex org-refile-allow-creating-parent-nodes
6412 @vindex org-log-refile
6413 @vindex org-refile-use-cache
6414 Refile the entry or region at point. This command offers possible locations
6415 for refiling the entry and lets you select one with completion. The item (or
6416 all items in the region) is filed below the target heading as a subitem.
6417 Depending on @code{org-reverse-note-order}, it will be either the first or
6419 By default, all level 1 headlines in the current buffer are considered to be
6420 targets, but you can have more complex definitions across a number of files.
6421 See the variable @code{org-refile-targets} for details. If you would like to
6422 select a location via a file-path-like completion along the outline path, see
6423 the variables @code{org-refile-use-outline-path} and
6424 @code{org-outline-path-complete-in-steps}. If you would like to be able to
6425 create new nodes as new parents for refiling on the fly, check the
6426 variable @code{org-refile-allow-creating-parent-nodes}.
6427 When the variable @code{org-log-refile}@footnote{with corresponding
6428 @code{#+STARTUP} keywords @code{logrefile}, @code{lognoterefile},
6429 and @code{nologrefile}} is set, a time stamp or a note will be
6430 recorded when an entry has been refiled.
6433 Use the refile interface to jump to a heading.
6434 @kindex C-u C-u C-c C-w
6435 @item C-u C-u C-c C-w
6436 Jump to the location where @code{org-refile} last moved a tree to.
6438 Refile as the child of the item currently being clocked.
6439 @item C-0 C-c C-w @ @r{or} @ C-u C-u C-u C-c C-w
6440 Clear the target cache. Caching of refile targets can be turned on by
6441 setting @code{org-refile-use-cache}. To make the command seen new possible
6442 targets, you have to clear the cache with this command.
6445 @node Archiving, , Refiling notes, Capture - Refile - Archive
6449 When a project represented by a (sub)tree is finished, you may want
6450 to move the tree out of the way and to stop it from contributing to the
6451 agenda. Archiving is important to keep your working files compact and global
6452 searches like the construction of agenda views fast.
6457 @vindex org-archive-default-command
6458 Archive the current entry using the command specified in the variable
6459 @code{org-archive-default-command}.
6463 * Moving subtrees:: Moving a tree to an archive file
6464 * Internal archiving:: Switch off a tree but keep it in the file
6467 @node Moving subtrees, Internal archiving, Archiving, Archiving
6468 @subsection Moving a tree to the archive file
6469 @cindex external archiving
6471 The most common archiving action is to move a project tree to another file,
6477 @item C-c C-x C-s@ @r{or short} @ C-c $
6478 @vindex org-archive-location
6479 Archive the subtree starting at the cursor position to the location
6480 given by @code{org-archive-location}.
6481 @kindex C-u C-c C-x C-s
6482 @item C-u C-c C-x C-s
6483 Check if any direct children of the current headline could be moved to
6484 the archive. To do this, each subtree is checked for open TODO entries.
6485 If none are found, the command offers to move it to the archive
6486 location. If the cursor is @emph{not} on a headline when this command
6487 is invoked, the level 1 trees will be checked.
6490 @cindex archive locations
6491 The default archive location is a file in the same directory as the
6492 current file, with the name derived by appending @file{_archive} to the
6493 current file name. For information and examples on how to change this,
6494 see the documentation string of the variable
6495 @code{org-archive-location}. There is also an in-buffer option for
6496 setting this variable, for example@footnote{For backward compatibility,
6497 the following also works: If there are several such lines in a file,
6498 each specifies the archive location for the text below it. The first
6499 such line also applies to any text before its definition. However,
6500 using this method is @emph{strongly} deprecated as it is incompatible
6501 with the outline structure of the document. The correct method for
6502 setting multiple archive locations in a buffer is using properties.}:
6506 #+ARCHIVE: %s_done::
6509 @cindex property, ARCHIVE
6511 If you would like to have a special ARCHIVE location for a single entry
6512 or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
6513 location as the value (@pxref{Properties and Columns}).
6515 @vindex org-archive-save-context-info
6516 When a subtree is moved, it receives a number of special properties that
6517 record context information like the file from where the entry came, its
6518 outline path the archiving time etc. Configure the variable
6519 @code{org-archive-save-context-info} to adjust the amount of information
6523 @node Internal archiving, , Moving subtrees, Archiving
6524 @subsection Internal archiving
6526 If you want to just switch off (for agenda views) certain subtrees without
6527 moving them to a different file, you can use the @code{ARCHIVE tag}.
6529 A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
6530 its location in the outline tree, but behaves in the following way:
6533 @vindex org-cycle-open-archived-trees
6534 It does not open when you attempt to do so with a visibility cycling
6535 command (@pxref{Visibility cycling}). You can force cycling archived
6536 subtrees with @kbd{C-@key{TAB}}, or by setting the option
6537 @code{org-cycle-open-archived-trees}. Also normal outline commands like
6538 @code{show-all} will open archived subtrees.
6540 @vindex org-sparse-tree-open-archived-trees
6541 During sparse tree construction (@pxref{Sparse trees}), matches in
6542 archived subtrees are not exposed, unless you configure the option
6543 @code{org-sparse-tree-open-archived-trees}.
6545 @vindex org-agenda-skip-archived-trees
6546 During agenda view construction (@pxref{Agenda Views}), the content of
6547 archived trees is ignored unless you configure the option
6548 @code{org-agenda-skip-archived-trees}, in which case these trees will always
6549 be included. In the agenda you can press @kbd{v a} to get archives
6550 temporarily included.
6552 @vindex org-export-with-archived-trees
6553 Archived trees are not exported (@pxref{Exporting}), only the headline
6554 is. Configure the details using the variable
6555 @code{org-export-with-archived-trees}.
6557 @vindex org-columns-skip-archived-trees
6558 Archived trees are excluded from column view unless the variable
6559 @code{org-columns-skip-archived-trees} is configured to @code{nil}.
6562 The following commands help manage the ARCHIVE tag:
6567 Toggle the ARCHIVE tag for the current headline. When the tag is set,
6568 the headline changes to a shadowed face, and the subtree below it is
6570 @kindex C-u C-c C-x a
6572 Check if any direct children of the current headline should be archived.
6573 To do this, each subtree is checked for open TODO entries. If none are
6574 found, the command offers to set the ARCHIVE tag for the child. If the
6575 cursor is @emph{not} on a headline when this command is invoked, the
6576 level 1 trees will be checked.
6579 Cycle a tree even if it is tagged with ARCHIVE.
6582 Move the current entry to the @emph{Archive Sibling}. This is a sibling of
6583 the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}. The
6584 entry becomes a child of that sibling and in this way retains a lot of its
6585 original context, including inherited tags and approximate position in the
6590 @node Agenda Views, Markup, Capture - Refile - Archive, Top
6591 @chapter Agenda views
6592 @cindex agenda views
6594 Due to the way Org works, TODO items, time-stamped items, and
6595 tagged headlines can be scattered throughout a file or even a number of
6596 files. To get an overview of open action items, or of events that are
6597 important for a particular date, this information must be collected,
6598 sorted and displayed in an organized way.
6600 Org can select items based on various criteria and display them
6601 in a separate buffer. Seven different view types are provided:
6605 an @emph{agenda} that is like a calendar and shows information
6608 a @emph{TODO list} that covers all unfinished
6611 a @emph{match view}, showings headlines based on the tags, properties, and
6612 TODO state associated with them,
6614 a @emph{timeline view} that shows all events in a single Org file,
6615 in time-sorted view,
6617 a @emph{text search view} that shows all entries from multiple files
6618 that contain specified keywords,
6620 a @emph{stuck projects view} showing projects that currently don't move
6623 @emph{custom views} that are special searches and combinations of different
6628 The extracted information is displayed in a special @emph{agenda
6629 buffer}. This buffer is read-only, but provides commands to visit the
6630 corresponding locations in the original Org files, and even to
6631 edit these files remotely.
6633 @vindex org-agenda-window-setup
6634 @vindex org-agenda-restore-windows-after-quit
6635 Two variables control how the agenda buffer is displayed and whether the
6636 window configuration is restored when the agenda exits:
6637 @code{org-agenda-window-setup} and
6638 @code{org-agenda-restore-windows-after-quit}.
6641 * Agenda files:: Files being searched for agenda information
6642 * Agenda dispatcher:: Keyboard access to agenda views
6643 * Built-in agenda views:: What is available out of the box?
6644 * Presentation and sorting:: How agenda items are prepared for display
6645 * Agenda commands:: Remote editing of Org trees
6646 * Custom agenda views:: Defining special searches and views
6647 * Exporting Agenda Views:: Writing a view to a file
6648 * Agenda column view:: Using column view for collected entries
6651 @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views
6652 @section Agenda files
6653 @cindex agenda files
6654 @cindex files for agenda
6656 @vindex org-agenda-files
6657 The information to be shown is normally collected from all @emph{agenda
6658 files}, the files listed in the variable
6659 @code{org-agenda-files}@footnote{If the value of that variable is not a
6660 list, but a single file name, then the list of agenda files will be
6661 maintained in that external file.}. If a directory is part of this list,
6662 all files with the extension @file{.org} in this directory will be part
6665 Thus, even if you only work with a single Org file, that file should
6666 be put into the list@footnote{When using the dispatcher, pressing
6667 @kbd{<} before selecting a command will actually limit the command to
6668 the current file, and ignore @code{org-agenda-files} until the next
6669 dispatcher command.}. You can customize @code{org-agenda-files}, but
6670 the easiest way to maintain it is through the following commands
6672 @cindex files, adding to agenda list
6676 Add current file to the list of agenda files. The file is added to
6677 the front of the list. If it was already in the list, it is moved to
6678 the front. With a prefix argument, file is added/moved to the end.
6681 Remove current file from the list of agenda files.
6686 Cycle through agenda file list, visiting one file after the other.
6687 @kindex M-x org-iswitchb
6688 @item M-x org-iswitchb
6689 Command to use an @code{iswitchb}-like interface to switch to and between Org
6694 The Org menu contains the current list of files and can be used
6695 to visit any of them.
6697 If you would like to focus the agenda temporarily on a file not in
6698 this list, or on just one file in the list, or even on only a subtree in a
6699 file, then this can be done in different ways. For a single agenda command,
6700 you may press @kbd{<} once or several times in the dispatcher
6701 (@pxref{Agenda dispatcher}). To restrict the agenda scope for an
6702 extended period, use the following commands:
6707 Permanently restrict the agenda to the current subtree. When with a
6708 prefix argument, or with the cursor before the first headline in a file,
6709 the agenda scope is set to the entire file. This restriction remains in
6710 effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
6711 or @kbd{>} in the agenda dispatcher. If there is a window displaying an
6712 agenda view, the new restriction takes effect immediately.
6715 Remove the permanent restriction created by @kbd{C-c C-x <}.
6719 When working with @file{speedbar.el}, you can use the following commands in
6723 @item < @r{in the speedbar frame}
6724 Permanently restrict the agenda to the item---either an Org file or a subtree
6725 in such a file---at the cursor in the Speedbar frame.
6726 If there is a window displaying an agenda view, the new restriction takes
6729 @item > @r{in the speedbar frame}
6730 Lift the restriction.
6733 @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views
6734 @section The agenda dispatcher
6735 @cindex agenda dispatcher
6736 @cindex dispatching agenda commands
6737 The views are created through a dispatcher, which should be bound to a
6738 global key---for example @kbd{C-c a} (@pxref{Installation}). In the
6739 following we will assume that @kbd{C-c a} is indeed how the dispatcher
6740 is accessed and list keyboard access to commands accordingly. After
6741 pressing @kbd{C-c a}, an additional letter is required to execute a
6742 command. The dispatcher offers the following default commands:
6745 Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
6747 Create a list of all TODO items (@pxref{Global TODO list}).
6749 Create a list of headlines matching a TAGS expression (@pxref{Matching
6750 tags and properties}).
6752 Create the timeline view for the current buffer (@pxref{Timeline}).
6754 Create a list of entries selected by a boolean expression of keywords
6755 and/or regular expressions that must or must not occur in the entry.
6757 @vindex org-agenda-text-search-extra-files
6758 Search for a regular expression in all agenda files and additionally in
6759 the files listed in @code{org-agenda-text-search-extra-files}. This
6760 uses the Emacs command @code{multi-occur}. A prefix argument can be
6761 used to specify the number of context lines for each match, default is
6764 Create a list of stuck projects (@pxref{Stuck projects}).
6766 Restrict an agenda command to the current buffer@footnote{For backward
6767 compatibility, you can also press @kbd{1} to restrict to the current
6768 buffer.}. After pressing @kbd{<}, you still need to press the character
6769 selecting the command.
6771 If there is an active region, restrict the following agenda command to
6772 the region. Otherwise, restrict it to the current subtree@footnote{For
6773 backward compatibility, you can also press @kbd{0} to restrict to the
6774 current region/subtree.}. After pressing @kbd{< <}, you still need to press the
6775 character selecting the command.
6778 You can also define custom commands that will be accessible through the
6779 dispatcher, just like the default commands. This includes the
6780 possibility to create extended agenda buffers that contain several
6781 blocks together, for example the weekly agenda, the global TODO list and
6782 a number of special tags matches. @xref{Custom agenda views}.
6784 @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda Views
6785 @section The built-in agenda views
6787 In this section we describe the built-in views.
6790 * Weekly/daily agenda:: The calendar page with current tasks
6791 * Global TODO list:: All unfinished action items
6792 * Matching tags and properties:: Structured information with fine-tuned search
6793 * Timeline:: Time-sorted view for single file
6794 * Search view:: Find entries by searching for text
6795 * Stuck projects:: Find projects you need to review
6798 @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views
6799 @subsection The weekly/daily agenda
6801 @cindex weekly agenda
6802 @cindex daily agenda
6804 The purpose of the weekly/daily @emph{agenda} is to act like a page of a
6805 paper agenda, showing all the tasks for the current week or day.
6808 @cindex org-agenda, command
6811 @vindex org-agenda-ndays
6812 Compile an agenda for the current week from a list of Org files. The agenda
6813 shows the entries for each day. With a numeric prefix@footnote{For backward
6814 compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
6815 listed before the agenda. This feature is deprecated, use the dedicated TODO
6816 list, or a block agenda instead (@pxref{Block agenda}).} (like @kbd{C-u 2 1
6817 C-c a a}) you may set the number of days to be displayed (see also the
6818 variable @code{org-agenda-ndays})
6821 Remote editing from the agenda buffer means, for example, that you can
6822 change the dates of deadlines and appointments from the agenda buffer.
6823 The commands available in the Agenda buffer are listed in @ref{Agenda
6826 @subsubheading Calendar/Diary integration
6827 @cindex calendar integration
6828 @cindex diary integration
6830 Emacs contains the calendar and diary by Edward M. Reingold. The
6831 calendar displays a three-month calendar with holidays from different
6832 countries and cultures. The diary allows you to keep track of
6833 anniversaries, lunar phases, sunrise/set, recurrent appointments
6834 (weekly, monthly) and more. In this way, it is quite complementary to
6835 Org. It can be very useful to combine output from Org with
6838 In order to include entries from the Emacs diary into Org-mode's
6839 agenda, you only need to customize the variable
6842 (setq org-agenda-include-diary t)
6845 @noindent After that, everything will happen automatically. All diary
6846 entries including holidays, anniversaries, etc., will be included in the
6847 agenda buffer created by Org-mode. @key{SPC}, @key{TAB}, and
6848 @key{RET} can be used from the agenda buffer to jump to the diary
6849 file in order to edit existing diary entries. The @kbd{i} command to
6850 insert new entries for the current date works in the agenda buffer, as
6851 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
6852 Sunrise/Sunset times, show lunar phases and to convert to other
6853 calendars, respectively. @kbd{c} can be used to switch back and forth
6854 between calendar and agenda.
6856 If you are using the diary only for sexp entries and holidays, it is
6857 faster to not use the above setting, but instead to copy or even move
6858 the entries into an Org file. Org-mode evaluates diary-style sexp
6859 entries, and does it faster because there is no overhead for first
6860 creating the diary display. Note that the sexp entries must start at
6861 the left margin, no whitespace is allowed before them. For example,
6862 the following segment of an Org file will be processed and entries
6863 will be made in the agenda:
6866 * Birthdays and similar stuff
6868 %%(org-calendar-holiday) ; special function for holiday names
6870 %%(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
6871 %%(diary-anniversary 10 2 1869) Mahatma Gandhi would be %d years old
6874 @subsubheading Anniversaries from BBDB
6875 @cindex BBDB, anniversaries
6876 @cindex anniversaries, from BBDB
6878 If you are using the Big Brothers Database to store your contacts, you will
6879 very likely prefer to store anniversaries in BBDB rather than in a
6880 separate Org or diary file. Org supports this and will show BBDB
6881 anniversaries as part of the agenda. All you need to do is to add the
6882 following to one your your agenda files:
6889 %%(org-bbdb-anniversaries)
6892 You can then go ahead and define anniversaries for a BBDB record. Basically,
6893 you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB
6894 record and then add the date in the format @code{YYYY-MM-DD}, followed by a
6895 space and the class of the anniversary (@samp{birthday} or @samp{wedding}, or
6896 a format string). If you omit the class, it will default to @samp{birthday}.
6897 Here are a few examples, the header for the file @file{org-bbdb.el} contains
6898 more detailed information.
6903 2008-04-14 %s released version 6.01 of org-mode, %d years ago
6906 After a change to BBDB, or for the first agenda display during an Emacs
6907 session, the agenda display will suffer a short delay as Org updates its
6908 hash with anniversaries. However, from then on things will be very fast---much
6909 faster in fact than a long list of @samp{%%(diary-anniversary)} entries
6910 in an Org or Diary file.
6912 @subsubheading Appointment reminders
6913 @cindex @file{appt.el}
6914 @cindex appointment reminders
6916 Org can interact with Emacs appointments notification facility. To add all
6917 the appointments of your agenda files, use the command
6918 @code{org-agenda-to-appt}. This command also lets you filter through the
6919 list of your appointments and add only those belonging to a specific category
6920 or matching a regular expression. See the docstring for details.
6922 @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views
6923 @subsection The global TODO list
6924 @cindex global TODO list
6925 @cindex TODO list, global
6927 The global TODO list contains all unfinished TODO items formatted and
6928 collected into a single place.
6933 Show the global TODO list. This collects the TODO items from all agenda
6934 files (@pxref{Agenda Views}) into a single buffer. By default, this lists
6935 items with a state the is not a DONE state. The buffer is in
6936 @code{agenda-mode}, so there are commands to examine and manipulate the TODO
6937 entries directly from that buffer (@pxref{Agenda commands}).
6940 @cindex TODO keyword matching
6941 @vindex org-todo-keywords
6942 Like the above, but allows selection of a specific TODO keyword. You can
6943 also do this by specifying a prefix argument to @kbd{C-c a t}. You are
6944 prompted for a keyword, and you may also specify several keywords by
6945 separating them with @samp{|} as the boolean OR operator. With a numeric
6946 prefix, the nth keyword in @code{org-todo-keywords} is selected.
6948 The @kbd{r} key in the agenda buffer regenerates it, and you can give
6949 a prefix argument to this command to change the selected TODO keyword,
6950 for example @kbd{3 r}. If you often need a search for a specific
6951 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
6952 Matching specific TODO keywords can also be done as part of a tags
6953 search (@pxref{Tag searches}).
6956 Remote editing of TODO items means that you can change the state of a
6957 TODO entry with a single key press. The commands available in the
6958 TODO list are described in @ref{Agenda commands}.
6960 @cindex sublevels, inclusion into TODO list
6961 Normally the global TODO list simply shows all headlines with TODO
6962 keywords. This list can become very long. There are two ways to keep
6966 @vindex org-agenda-todo-ignore-scheduled
6967 @vindex org-agenda-todo-ignore-deadlines
6968 @vindex org-agenda-todo-ignore-with-date
6969 Some people view a TODO item that has been @emph{scheduled} for execution or
6970 have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}.
6971 Configure the variables @code{org-agenda-todo-ignore-scheduled},
6972 @code{org-agenda-todo-ignore-deadlines}, and/or
6973 @code{org-agenda-todo-ignore-with-date} to exclude such items from the
6976 @vindex org-agenda-todo-list-sublevels
6977 TODO items may have sublevels to break up the task into subtasks. In
6978 such cases it may be enough to list only the highest level TODO headline
6979 and omit the sublevels from the global list. Configure the variable
6980 @code{org-agenda-todo-list-sublevels} to get this behavior.
6983 @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views
6984 @subsection Matching tags and properties
6985 @cindex matching, of tags
6986 @cindex matching, of properties
6990 If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}),
6991 or have properties (@pxref{Properties and Columns}), you can select headlines
6992 based on this metadata and collect them into an agenda buffer. The match
6993 syntax described here also applies when creating sparse trees with @kbd{C-c /
6999 Produce a list of all headlines that match a given set of tags. The
7000 command prompts for a selection criterion, which is a boolean logic
7001 expression with tags, like @samp{+work+urgent-withboss} or
7002 @samp{work|home} (@pxref{Tags}). If you often need a specific search,
7003 define a custom command for it (@pxref{Agenda dispatcher}).
7006 @vindex org-tags-match-list-sublevels
7007 @vindex org-agenda-tags-todo-honor-ignore-options
7008 Like @kbd{C-c a m}, but only select headlines that are also TODO items in a
7009 not-DONE state and force checking subitems (see variable
7010 @code{org-tags-match-list-sublevels}). To exclude scheduled/deadline items,
7011 see the variable @code{org-agenda-tags-todo-honor-ignore-options}. Matching
7012 specific TODO keywords together with a tags match is also possible, see
7016 The commands available in the tags list are described in @ref{Agenda
7019 @subsubheading Match syntax
7021 @cindex Boolean logic, for tag/property searches
7022 A search string can use Boolean operators @samp{&} for AND and @samp{|} for
7023 OR. @samp{&} binds more strongly than @samp{|}. Parentheses are currently
7024 not implemented. Each element in the search is either a tag, a regular
7025 expression matching tags, or an expression like @code{PROPERTY OPERATOR
7026 VALUE} with a comparison operator, accessing a property value. Each element
7027 may be preceded by @samp{-}, to select against it, and @samp{+} is syntactic
7028 sugar for positive selection. The AND operator @samp{&} is optional when
7029 @samp{+} or @samp{-} is present. Here are some examples, using only tags.
7033 Select headlines tagged @samp{:work:}, but discard those also tagged
7036 Selects lines tagged @samp{:work:} or @samp{:laptop:}.
7037 @item work|laptop+night
7038 Like before, but require the @samp{:laptop:} lines to be tagged also
7042 @cindex regular expressions, with tags search
7043 Instead of a tag, you may also specify a regular expression enclosed in curly
7044 braces. For example,
7045 @samp{work+@{^boss.*@}} matches headlines that contain the tag
7046 @samp{:work:} and any tag @i{starting} with @samp{boss}.
7048 @cindex TODO keyword matching, with tags search
7049 @cindex level, require for tags/property match
7050 @cindex category, require for tags/property match
7051 @vindex org-odd-levels-only
7052 You may also test for properties (@pxref{Properties and Columns}) at the same
7053 time as matching tags. The properties may be real properties, or special
7054 properties that represent other metadata (@pxref{Special properties}). For
7055 example, the ``property'' @code{TODO} represents the TODO keyword of the
7056 entry. Or, the ``property'' @code{LEVEL} represents the level of an entry.
7057 So a search @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines
7058 that have the tag @samp{boss} and are @emph{not} marked with the TODO keyword
7059 DONE. In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not
7060 count the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc.
7062 Here are more examples:
7064 @item work+TODO="WAITING"
7065 Select @samp{:work:}-tagged TODO lines with the specific TODO
7066 keyword @samp{WAITING}.
7067 @item work+TODO="WAITING"|home+TODO="WAITING"
7068 Waiting tasks both at work and at home.
7071 When matching properties, a number of different operators can be used to test
7072 the value of a property. Here is a complex example:
7075 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 \
7076 +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
7080 The type of comparison will depend on how the comparison value is written:
7083 If the comparison value is a plain number, a numerical comparison is done,
7084 and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
7085 @samp{>=}, and @samp{<>}.
7087 If the comparison value is enclosed in double-quotes,
7088 a string comparison is done, and the same operators are allowed.
7090 If the comparison value is enclosed in double-quotes @emph{and} angular
7091 brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
7092 assumed to be date/time specifications in the standard Org way, and the
7093 comparison will be done accordingly. Special values that will be recognized
7094 are @code{"<now>"} for now (including time), and @code{"<today>"}, and
7095 @code{"<tomorrow>"} for these days at 0:00 hours, i.e. without a time
7096 specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
7097 @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
7098 respectively, can be used.
7100 If the comparison value is enclosed
7101 in curly braces, a regexp match is performed, with @samp{=} meaning that the
7102 regexp matches the property value, and @samp{<>} meaning that it does not
7106 So the search string in the example finds entries tagged @samp{:work:} but
7107 not @samp{:boss:}, which also have a priority value @samp{A}, a
7108 @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
7109 property that is numerically smaller than 2, a @samp{:With:} property that is
7110 matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
7111 on or after October 11, 2008.
7113 Accessing TODO, LEVEL, and CATEGORY during a search is fast. Accessing any
7114 other properties will slow down the search. However, once you have paid the
7115 price by accessing one property, testing additional properties is cheap
7118 You can configure Org-mode to use property inheritance during a search, but
7119 beware that this can slow down searches considerably. See @ref{Property
7120 inheritance}, for details.
7122 For backward compatibility, and also for typing speed, there is also a
7123 different way to test TODO states in a search. For this, terminate the
7124 tags/property part of the search string (which may include several terms
7125 connected with @samp{|}) with a @samp{/} and then specify a Boolean
7126 expression just for TODO keywords. The syntax is then similar to that for
7127 tags, but should be applied with care: for example, a positive selection on
7128 several TODO keywords cannot meaningfully be combined with boolean AND.
7129 However, @emph{negative selection} combined with AND can be meaningful. To
7130 make sure that only lines are checked that actually have any TODO keyword
7131 (resulting in a speed-up), use @kbd{C-c a M}, or equivalently start the TODO
7132 part after the slash with @samp{!}. Using @kbd{C-c a M} or @samp{/!} will
7133 not match TODO keywords in a DONE state. Examples:
7137 Same as @samp{work+TODO="WAITING"}
7138 @item work/!-WAITING-NEXT
7139 Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
7141 @item work/!+WAITING|+NEXT
7142 Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
7146 @node Timeline, Search view, Matching tags and properties, Built-in agenda views
7147 @subsection Timeline for a single file
7148 @cindex timeline, single file
7149 @cindex time-sorted view
7151 The timeline summarizes all time-stamped items from a single Org-mode
7152 file in a @emph{time-sorted view}. The main purpose of this command is
7153 to give an overview over events in a project.
7158 Show a time-sorted view of the Org file, with all time-stamped items.
7159 When called with a @kbd{C-u} prefix, all unfinished TODO entries
7160 (scheduled or not) are also listed under the current date.
7164 The commands available in the timeline buffer are listed in
7165 @ref{Agenda commands}.
7167 @node Search view, Stuck projects, Timeline, Built-in agenda views
7168 @subsection Search view
7171 @cindex searching, for text
7173 This agenda view is a general text search facility for Org-mode entries.
7174 It is particularly useful to find notes.
7179 This is a special search that lets you select entries by matching a substring
7180 or specific words using a boolean logic.
7182 For example, the search string @samp{computer equipment} will find entries
7183 that contain @samp{computer equipment} as a substring. If the two words are
7184 separated by more space or a line break, the search will still match.
7185 Search view can also search for specific keywords in the entry, using Boolean
7186 logic. The search string @samp{+computer +wifi -ethernet -@{8\.11[bg]@}}
7187 will search for note entries that contain the keywords @code{computer}
7188 and @code{wifi}, but not the keyword @code{ethernet}, and which are also
7189 not matched by the regular expression @code{8\.11[bg]}, meaning to
7190 exclude both 8.11b and 8.11g. The first @samp{+} is necessary to turn on
7191 word search, other @samp{+} characters are optional. For more details, see
7192 the docstring of the command @code{org-search-view}.
7194 @vindex org-agenda-text-search-extra-files
7195 Note that in addition to the agenda files, this command will also search
7196 the files listed in @code{org-agenda-text-search-extra-files}.
7198 @node Stuck projects, , Search view, Built-in agenda views
7199 @subsection Stuck projects
7201 If you are following a system like David Allen's GTD to organize your
7202 work, one of the ``duties'' you have is a regular review to make sure
7203 that all projects move along. A @emph{stuck} project is a project that
7204 has no defined next actions, so it will never show up in the TODO lists
7205 Org-mode produces. During the review, you need to identify such
7206 projects and define next actions for them.
7211 List projects that are stuck.
7214 @vindex org-stuck-projects
7215 Customize the variable @code{org-stuck-projects} to define what a stuck
7216 project is and how to find it.
7219 You almost certainly will have to configure this view before it will
7220 work for you. The built-in default assumes that all your projects are
7221 level-2 headlines, and that a project is not stuck if it has at least
7222 one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
7224 Let's assume that you, in your own way of using Org-mode, identify
7225 projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
7226 indicate a project that should not be considered yet. Let's further
7227 assume that the TODO keyword DONE marks finished projects, and that NEXT
7228 and TODO indicate next actions. The tag @@SHOP indicates shopping and
7229 is a next action even without the NEXT tag. Finally, if the project
7230 contains the special word IGNORE anywhere, it should not be listed
7231 either. In this case you would start by identifying eligible projects
7232 with a tags/todo match@footnote{@xref{Tag searches}.}
7233 @samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT, @@SHOP, and
7234 IGNORE in the subtree to identify projects that are not stuck. The
7235 correct customization for this is
7238 (setq org-stuck-projects
7239 '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
7243 Note that if a project is identified as non-stuck, the subtree of this entry
7244 will still be searched for stuck projects.
7246 @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views
7247 @section Presentation and sorting
7248 @cindex presentation, of agenda items
7250 @vindex org-agenda-prefix-format
7251 Before displaying items in an agenda view, Org-mode visually prepares
7252 the items and sorts them. Each item occupies a single line. The line
7253 starts with a @emph{prefix} that contains the @emph{category}
7254 (@pxref{Categories}) of the item and other important information. You can
7255 customize the prefix using the option @code{org-agenda-prefix-format}.
7256 The prefix is followed by a cleaned-up version of the outline headline
7257 associated with the item.
7260 * Categories:: Not all tasks are equal
7261 * Time-of-day specifications:: How the agenda knows the time
7262 * Sorting of agenda items:: The order of things
7265 @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting
7266 @subsection Categories
7269 The category is a broad label assigned to each agenda item. By default,
7270 the category is simply derived from the file name, but you can also
7271 specify it with a special line in the buffer, like this@footnote{For
7272 backward compatibility, the following also works: if there are several
7273 such lines in a file, each specifies the category for the text below it.
7274 The first category also applies to any text before the first CATEGORY
7275 line. However, using this method is @emph{strongly} deprecated as it is
7276 incompatible with the outline structure of the document. The correct
7277 method for setting multiple categories in a buffer is using a
7285 @cindex property, CATEGORY
7286 If you would like to have a special CATEGORY for a single entry or a
7287 (sub)tree, give the entry a @code{:CATEGORY:} property with the
7288 special category you want to apply as the value.
7291 The display in the agenda buffer looks best if the category is not
7292 longer than 10 characters.
7294 @node Time-of-day specifications, Sorting of agenda items, Categories, Presentation and sorting
7295 @subsection Time-of-day specifications
7296 @cindex time-of-day specification
7298 Org-mode checks each agenda item for a time-of-day specification. The
7299 time can be part of the timestamp that triggered inclusion into the
7300 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time
7301 ranges can be specified with two timestamps, like
7303 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
7305 In the headline of the entry itself, a time(range) may also appear as
7306 plain text (like @samp{12:45} or a @samp{8:30-1pm}). If the agenda
7307 integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
7308 specifications in diary entries are recognized as well.
7310 For agenda display, Org-mode extracts the time and displays it in a
7311 standard 24 hour format as part of the prefix. The example times in
7312 the previous paragraphs would end up in the agenda like this:
7315 8:30-13:00 Arthur Dent lies in front of the bulldozer
7316 12:45...... Ford Prefect arrives and takes Arthur to the pub
7317 19:00...... The Vogon reads his poem
7318 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
7322 If the agenda is in single-day mode, or for the display of today, the
7323 timed entries are embedded in a time grid, like
7326 8:00...... ------------------
7327 8:30-13:00 Arthur Dent lies in front of the bulldozer
7328 10:00...... ------------------
7329 12:00...... ------------------
7330 12:45...... Ford Prefect arrives and takes Arthur to the pub
7331 14:00...... ------------------
7332 16:00...... ------------------
7333 18:00...... ------------------
7334 19:00...... The Vogon reads his poem
7335 20:00...... ------------------
7336 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
7339 @vindex org-agenda-use-time-grid
7340 @vindex org-agenda-time-grid
7341 The time grid can be turned on and off with the variable
7342 @code{org-agenda-use-time-grid}, and can be configured with
7343 @code{org-agenda-time-grid}.
7345 @node Sorting of agenda items, , Time-of-day specifications, Presentation and sorting
7346 @subsection Sorting of agenda items
7347 @cindex sorting, of agenda items
7348 @cindex priorities, of agenda items
7349 Before being inserted into a view, the items are sorted. How this is
7350 done depends on the type of view.
7353 @vindex org-agenda-files
7354 For the daily/weekly agenda, the items for each day are sorted. The
7355 default order is to first collect all items containing an explicit
7356 time-of-day specification. These entries will be shown at the beginning
7357 of the list, as a @emph{schedule} for the day. After that, items remain
7358 grouped in categories, in the sequence given by @code{org-agenda-files}.
7359 Within each category, items are sorted by priority (@pxref{Priorities}),
7360 which is composed of the base priority (2000 for priority @samp{A}, 1000
7361 for @samp{B}, and 0 for @samp{C}), plus additional increments for
7362 overdue scheduled or deadline items.
7364 For the TODO list, items remain in the order of categories, but within
7365 each category, sorting takes place according to priority
7366 (@pxref{Priorities}). The priority used for sorting derives from the
7367 priority cookie, with additions depending on how close an item is to its due
7370 For tags matches, items are not sorted at all, but just appear in the
7371 sequence in which they are found in the agenda files.
7374 @vindex org-agenda-sorting-strategy
7375 Sorting can be customized using the variable
7376 @code{org-agenda-sorting-strategy}, and may also include criteria based on
7377 the estimated effort of an entry (@pxref{Effort estimates}).
7379 @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda Views
7380 @section Commands in the agenda buffer
7381 @cindex commands, in agenda buffer
7383 Entries in the agenda buffer are linked back to the Org file or diary
7384 file where they originate. You are not allowed to edit the agenda
7385 buffer itself, but commands are provided to show and jump to the
7386 original entry location, and to edit the Org files ``remotely'' from
7387 the agenda buffer. In this way, all information is stored only once,
7388 removing the risk that your agenda and note files may diverge.
7390 Some commands can be executed with mouse clicks on agenda lines. For
7391 the other commands, the cursor needs to be in the desired line.
7394 @tsubheading{Motion}
7395 @cindex motion commands in agenda
7398 Next line (same as @key{up} and @kbd{C-p}).
7401 Previous line (same as @key{down} and @kbd{C-n}).
7402 @tsubheading{View/Go to Org file}
7407 Display the original location of the item in another window.
7408 With prefix arg, make sure that the entire entry is made visible in the
7409 outline, not only the heading.
7413 Display original location and recenter that window.
7421 Go to the original location of the item in another window. Under Emacs
7422 22, @kbd{mouse-1} will also works for this.
7426 Go to the original location of the item and delete other windows.
7430 @vindex org-agenda-start-with-follow-mode
7431 Toggle Follow mode. In Follow mode, as you move the cursor through
7432 the agenda buffer, the other window always shows the corresponding
7433 location in the Org file. The initial setting for this mode in new
7434 agenda buffers can be set with the variable
7435 @code{org-agenda-start-with-follow-mode}.
7439 Display the entire subtree of the current item in an indirect buffer. With a
7440 numeric prefix argument N, go up to level N and then take that tree. If N is
7441 negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the
7442 previously used indirect buffer.
7446 Follow a link in the entry. This will offer a selection of any links in the
7447 text belonging to the referenced Org node. If there is only one link, it
7448 will be followed without a selection prompt.
7450 @tsubheading{Change display}
7451 @cindex display changing, in agenda
7454 Delete other windows.
7462 @item v d @ @r{or short} @ d
7463 @itemx v w @ @r{or short} @ w
7466 Switch to day/week/month/year view. When switching to day or week view,
7467 this setting becomes the default for subsequent agenda commands. Since
7468 month and year views are slow to create, they do not become the default.
7469 A numeric prefix argument may be used to jump directly to a specific day
7470 of the year, ISO week, month, or year, respectively. For example,
7471 @kbd{32 d} jumps to February 1st, @kbd{9 w} to ISO week number 9. When
7472 setting day, week, or month view, a year may be encoded in the prefix
7473 argument as well. For example, @kbd{200712 w} will jump to week 12 in
7474 2007. If such a year specification has only one or two digits, it will
7475 be mapped to the interval 1938-2037.
7479 @vindex org-agenda-ndays
7480 Go forward in time to display the following @code{org-agenda-ndays} days.
7481 For example, if the display covers a week, switch to the following week.
7482 With prefix arg, go forward that many times @code{org-agenda-ndays} days.
7486 Go backward in time to display earlier dates.
7494 Prompt for a date and go there.
7498 Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}.
7503 @item v l @ @r{or short} @ l
7504 @vindex org-log-done
7505 @vindex org-agenda-log-mode-items
7506 Toggle Logbook mode. In Logbook mode, entries that were marked DONE while
7507 logging was on (variable @code{org-log-done}) are shown in the agenda, as are
7508 entries that have been clocked on that day. You can configure the entry
7509 types that should be included in log mode using the variable
7510 @code{org-agenda-log-mode-items}. When called with a @kbd{C-u} prefix, show
7511 all possible logbook entries, including state changes. When called with two
7512 prefix args @kbd{C-u C-u}, show only logging information, nothing else.
7513 @kbd{v L} is equivalent to @kbd{C-u v l}.
7517 @item v [ @ @r{or short} @ [
7518 Include inactive timestamps into the current view. Only for weekly/daily
7519 agenda and timeline views.
7525 Toggle Archives mode. In Archives mode, trees that are marked
7526 @code{ARCHIVED} are also scanned when producing the agenda. When you use the
7527 capital @kbd{A}, even all archive files are included. To exit archives mode,
7528 press @kbd{v a} again.
7532 @item v R @ @r{or short} @ R
7533 @vindex org-agenda-start-with-clockreport-mode
7534 Toggle Clockreport mode. In Clockreport mode, the daily/weekly agenda will
7535 always show a table with the clocked times for the timespan and file scope
7536 covered by the current agenda view. The initial setting for this mode in new
7537 agenda buffers can be set with the variable
7538 @code{org-agenda-start-with-clockreport-mode}.
7542 @item v E @ @r{or short} @ E
7543 @vindex org-agenda-start-with-entry-text-mode
7544 @vindex org-agenda-entry-text-maxlines
7545 Toggle entry text mode. In entry text mode, a number of lines from the Org
7546 outline node referenced by an agenda line will be displayed below the line.
7547 The maximum number of lines is given by the variable
7548 @code{org-agenda-entry-text-maxlines}. Calling this command with a numeric
7549 prefix argument will temporarily modify that number to the prefix value.
7553 @vindex org-agenda-use-time-grid
7554 @vindex org-agenda-time-grid
7555 Toggle the time grid on and off. See also the variables
7556 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
7560 Recreate the agenda buffer, for example to reflect the changes after
7561 modification of the timestamps of items with @kbd{S-@key{left}} and
7562 @kbd{S-@key{right}}. When the buffer is the global TODO list, a prefix
7563 argument is interpreted to create a selective list for a specific TODO
7573 Save all Org buffers in the current Emacs session, and also the locations of
7578 @vindex org-columns-default-format
7579 Invoke column view (@pxref{Column view}) in the agenda buffer. The column
7580 view format is taken from the entry at point, or (if there is no entry at
7581 point), from the first entry in the agenda view. So whatever the format for
7582 that entry would be in the original buffer (taken from a property, from a
7583 @code{#+COLUMNS} line, or from the default variable
7584 @code{org-columns-default-format}), will be used in the agenda.
7588 Remove the restriction lock on the agenda, if it is currently restricted to a
7589 file or subtree (@pxref{Agenda files}).
7591 @tsubheading{Secondary filtering and query editing}
7592 @cindex filtering, by tag and effort, in agenda
7593 @cindex tag filtering, in agenda
7594 @cindex effort filtering, in agenda
7595 @cindex query editing, in agenda
7599 @vindex org-agenda-filter-preset
7600 Filter the current agenda view with respect to a tag and/or effort estimates.
7601 The difference between this and a custom agenda command is that filtering is
7602 very fast, so that you can switch quickly between different filters without
7603 having to recreate the agenda@footnote{Custom commands can preset a filter by
7604 binding the variable @code{org-agenda-filter-preset} as an option. This
7605 filter will then be applied to the view and persist as a basic filter through
7606 refreshes and more secondary filtering. The filter is a global property of
7607 the entire agenda view - in a block agenda, you should only set this in the
7608 global options section, not in the section of an individual block.}
7610 You will be prompted for a tag selection letter, SPC will mean any tag at
7611 all. Pressing @key{TAB} at that prompt will offer use completion to select a
7612 tag (including any tags that do not have a selection character). The command
7613 then hides all entries that do not contain or inherit this tag. When called
7614 with prefix arg, remove the entries that @emph{do} have the tag. A second
7615 @kbd{/} at the prompt will turn off the filter and unhide any hidden entries.
7616 If the first key you press is either @kbd{+} or @kbd{-}, the previous filter
7617 will be narrowed by requiring or forbidding the selected additional tag.
7618 Instead of pressing @kbd{+} or @kbd{-} after @kbd{/}, you can also
7619 immediately use the @kbd{\} command.
7621 @vindex org-sort-agenda-noeffort-is-high
7622 In order to filter for effort estimates, you should set-up allowed
7623 efforts globally, for example
7625 (setq org-global-properties
7626 '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
7628 You can then filter for an effort by first typing an operator, one of
7629 @kbd{<}, @kbd{>}, and @kbd{=}, and then the one-digit index of an effort
7630 estimate in your array of allowed values, where @kbd{0} means the 10th value.
7631 The filter will then restrict to entries with effort smaller-or-equal, equal,
7632 or larger-or-equal than the selected value. If the digits 0-9 are not used
7633 as fast access keys to tags, you can also simply press the index digit
7634 directly without an operator. In this case, @kbd{<} will be assumed. For
7635 application of the operator, entries without a defined effort will be treated
7636 according to the value of @code{org-sort-agenda-noeffort-is-high}. To filter
7637 for tasks without effort definition, press @kbd{?} as the operator.
7639 Org also supports automatic, context-aware tag filtering. If the variable
7640 @code{org-agenda-auto-exclude-function} is set to a user-defined function,
7641 that function can decide which tags should be excluded from the agenda
7642 automatically. Once this is set, the @kbd{/} command then accepts @kbd{RET}
7643 as a sub-option key and runs the auto exclusion logic. For example, let's
7644 say you use a @code{Net} tag to identify tasks which need network access, an
7645 @code{Errand} tag for errands in town, and a @code{Call} tag for making phone
7646 calls. You could auto-exclude these tags based on the availability of the
7647 Internet, and outside of business hours, with something like this:
7651 (defun org-my-auto-exclude-function (tag)
7653 ((string= tag "Net")
7654 (/= 0 (call-process "/sbin/ping" nil nil nil
7655 "-c1" "-q" "-t1" "mail.gnu.org")))
7656 ((or (string= tag "Errand") (string= tag "Call"))
7657 (let ((hour (nth 2 (decode-time))))
7658 (or (< hour 8) (> hour 21)))))
7661 (setq org-agenda-auto-exclude-function 'org-my-auto-exclude-function)
7667 Narrow the current agenda filter by an additional condition. When called with
7668 prefix arg, remove the entries that @emph{do} have the tag, or that do match
7669 the effort criterion. You can achieve the same effect by pressing @kbd{+} or
7670 @kbd{-} as the first key after the @kbd{/} command.
7678 @item @r{in} search view
7679 add new search words (@kbd{[} and @kbd{]}) or new regular expressions
7680 (@kbd{@{} and @kbd{@}}) to the query string. The opening bracket/brace will
7681 add a positive search term prefixed by @samp{+}, indicating that this search
7682 term @i{must} occur/match in the entry. The closing bracket/brace will add a
7683 negative search term which @i{must not} occur/match in the entry for it to be
7688 @tsubheading{Remote editing}
7689 @cindex remote editing, from agenda
7694 @cindex undoing remote-editing events
7695 @cindex remote editing, undo
7698 Undo a change due to a remote editing command. The change is undone
7699 both in the agenda buffer and in the remote buffer.
7703 Change the TODO state of the item, both in the agenda and in the
7706 @kindex C-S-@key{right}
7707 @kindex C-S-@key{left}
7708 @item C-S-@key{right}@r{/}@key{left}
7709 Switch to the next/previous set of TODO keywords.
7713 @vindex org-agenda-confirm-kill
7714 Delete the current agenda item along with the entire subtree belonging
7715 to it in the original Org file. If the text to be deleted remotely
7716 is longer than one line, the kill needs to be confirmed by the user. See
7717 variable @code{org-agenda-confirm-kill}.
7721 Refile the entry at point.
7725 @item C-c C-x C-a @ @r{or short} @ a
7726 @vindex org-archive-default-command
7727 Archive the subtree corresponding to the entry at point using the default
7728 archiving command set in @code{org-archive-default-command}. When using the
7729 @code{a} key, confirmation will be required.
7733 Toggle the ARCHIVE tag for the current headline.
7737 Move the subtree corresponding to the current entry to its @emph{archive
7742 @item C-c C-x C-s @ @r{or short} @ $
7743 Archive the subtree corresponding to the current headline. This means the
7744 entry will be moved to the configured archive location, most likely a
7749 @vindex org-agenda-show-inherited-tags
7750 Show all tags associated with the current item. This is useful if you have
7751 turned off @code{org-agenda-show-inherited-tags}, but still want to see all
7752 tags of a headline occasionally.
7756 Set tags for the current headline. If there is an active region in the
7757 agenda, change a tag for all headings in the region.
7761 Set the priority for the current item. Org-mode prompts for the
7762 priority character. If you reply with @key{SPC}, the priority cookie
7763 is removed from the entry.
7767 Display weighted priority of current item.
7773 Increase the priority of the current item. The priority is changed in
7774 the original buffer, but the agenda is not resorted. Use the @kbd{r}
7778 @kindex S-@key{down}
7781 Decrease the priority of the current item.
7785 @item z @ @r{or also} @ C-c C-z
7786 @vindex org-log-into-drawer
7787 Add a note to the entry. This note will be recorded, and then files to the
7788 same location where state change notes are put. Depending on
7789 @code{org-log-into-drawer}, this maybe inside a drawer.
7793 Dispatcher for all command related to attachments.
7797 Schedule this item, with prefix arg remove the scheduling timestamp
7801 Set a deadline for this item, with prefix arg remove the deadline.
7805 Agenda actions, to set dates for selected items to the cursor date.
7806 This command also works in the calendar! The command prompts for an
7809 m @r{Mark the entry at point for action. You can also make entries}
7810 @r{in Org files with @kbd{C-c C-x C-k}.}
7811 d @r{Set the deadline of the marked entry to the date at point.}
7812 s @r{Schedule the marked entry at the date at point.}
7813 r @r{Call @code{org-capture} with the cursor date as default date.}
7816 Press @kbd{r} afterward to refresh the agenda and see the effect of the
7819 @kindex S-@key{right}
7821 Change the timestamp associated with the current line by one day into the
7822 future. With a numeric prefix argument, change it by that many days. For
7823 example, @kbd{3 6 5 S-@key{right}} will change it by a year. With a
7824 @kbd{C-u} prefix, change the time by one hour. If you immediately repeat the
7825 command, it will continue to change hours even without the prefix arg. With
7826 a double @kbd{C-u C-u} prefix, do the same for changing minutes. The stamp
7827 is changed in the original Org file, but the change is not directly reflected
7828 in the agenda buffer. Use @kbd{r} or @kbd{g} to update the buffer.
7830 @kindex S-@key{left}
7832 Change the timestamp associated with the current line by one day
7837 Change the timestamp associated with the current line. The key @kbd{>} has
7838 been chosen, because it is the same as @kbd{S-.} on my keyboard.
7842 Start the clock on the current item. If a clock is running already, it
7847 Stop the previously started clock.
7851 Cancel the currently running clock.
7855 Jump to the running clock in another window.
7857 @tsubheading{Bulk remote editing selected entries}
7858 @cindex remote editing, bulk, from agenda
7862 Mark the entry at point for bulk action.
7866 Unmark entry for bulk action.
7870 Unmark all marked entries for bulk action.
7874 Bulk action: act on all marked entries in the agenda. This will prompt for
7875 another key to select the action to be applied. The prefix arg to @kbd{B}
7876 will be passed through to the @kbd{s} and @kbd{d} commands, to bulk-remove
7877 these special timestamps.
7879 r @r{Prompt for a single refile target and move all entries. The entries}
7880 @r{will no longer be in the agenda, refresh (@kbd{g}) to bring them back.}
7881 $ @r{Archive all selected entries.}
7882 A @r{Archive entries by moving them to their respective archive siblings.}
7883 t @r{Change TODO state. This prompts for a single TODO keyword and}
7884 @r{changes the state of all selected entries, bypassing blocking and}
7885 @r{suppressing logging notes (but not time stamps).}
7886 + @r{Add a tag to all selected entries.}
7887 - @r{Remove a tag from all selected entries.}
7888 s @r{Schedule all items to a new date. To shift existing schedule dates}
7889 @r{by a fixed number of days, use something starting with double plus}
7890 @r{at the prompt, for example @samp{++8d} or @samp{++2w}.}
7891 d @r{Set deadline to a specific date.}
7895 @tsubheading{Calendar commands}
7896 @cindex calendar commands, from agenda
7899 Open the Emacs calendar and move to the date at the agenda cursor.
7902 When in the calendar, compute and show the Org-mode agenda for the
7905 @cindex diary entries, creating from agenda
7908 @vindex org-agenda-diary-file
7909 Insert a new entry into the diary, using the date at the cursor and (for
7910 block entries) the date at the mark. This will add to the Emacs diary
7911 file@footnote{This file is parsed for the agenda when
7912 @code{org-agenda-include-diary} is set.}, in a way similar to the @kbd{i}
7913 command in the calendar. The diary file will pop up in another window, where
7914 you can add the entry.
7916 If you configure @code{org-agenda-diary-file} to point to an Org-mode file,
7917 Org will create entries (in org-mode syntax) in that file instead. Most
7918 entries will be stored in a date-based outline tree that will later make it
7919 easy to archive appointments from previous months/years. The tree will be
7920 built under an entry with a @code{DATE_TREE} property, or else with years as
7921 top-level entries. Emacs will prompt you for the entry text - if you specify
7922 it, the entry will be created in @code{org-agenda-diary-file} without further
7923 interaction. If you directly press @key{RET} at the prompt without typing
7924 text, the target file will be shown in another window for you to finish the
7925 entry there. See also the @kbd{k r} command.
7929 Show the phases of the moon for the three months around current date.
7933 Show sunrise and sunset times. The geographical location must be set
7934 with calendar variables, see the documentation for the Emacs calendar.
7938 Convert the date at cursor into many other cultural and historic
7943 Show holidays for three months around the cursor date.
7945 @item M-x org-export-icalendar-combine-agenda-files
7946 Export a single iCalendar file containing entries from all agenda files.
7947 This is a globally available command, and also available in the agenda menu.
7949 @tsubheading{Exporting to a file}
7952 @cindex exporting agenda views
7953 @cindex agenda views, exporting
7954 @vindex org-agenda-exporter-settings
7955 Write the agenda view to a file. Depending on the extension of the selected
7956 file name, the view will be exported as HTML (extension @file{.html} or
7957 @file{.htm}), Postscript (extension @file{.ps}), PDF (extension @file{.pdf}),
7958 and plain text (any other extension). When called with a @kbd{C-u} prefix
7959 argument, immediately open the newly created file. Use the variable
7960 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
7961 for @file{htmlize} to be used during export.
7963 @tsubheading{Quit and Exit}
7966 Quit agenda, remove the agenda buffer.
7969 @cindex agenda files, removing buffers
7971 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
7972 for the compilation of the agenda. Buffers created by the user to
7973 visit Org files will not be removed.
7977 @node Custom agenda views, Exporting Agenda Views, Agenda commands, Agenda Views
7978 @section Custom agenda views
7979 @cindex custom agenda views
7980 @cindex agenda views, custom
7982 Custom agenda commands serve two purposes: to store and quickly access
7983 frequently used TODO and tags searches, and to create special composite
7984 agenda buffers. Custom agenda commands will be accessible through the
7985 dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
7988 * Storing searches:: Type once, use often
7989 * Block agenda:: All the stuff you need in a single buffer
7990 * Setting Options:: Changing the rules
7993 @node Storing searches, Block agenda, Custom agenda views, Custom agenda views
7994 @subsection Storing searches
7996 The first application of custom searches is the definition of keyboard
7997 shortcuts for frequently used searches, either creating an agenda
7998 buffer, or a sparse tree (the latter covering of course only the current
8001 @vindex org-agenda-custom-commands
8002 Custom commands are configured in the variable
8003 @code{org-agenda-custom-commands}. You can customize this variable, for
8004 example by pressing @kbd{C-c a C}. You can also directly set it with
8005 Emacs Lisp in @file{.emacs}. The following example contains all valid
8010 (setq org-agenda-custom-commands
8011 '(("w" todo "WAITING")
8012 ("W" todo-tree "WAITING")
8013 ("u" tags "+boss-urgent")
8014 ("v" tags-todo "+boss-urgent")
8015 ("U" tags-tree "+boss-urgent")
8016 ("f" occur-tree "\\<FIXME\\>")
8017 ("h" . "HOME+Name tags searches") ; description for "h" prefix
8018 ("hl" tags "+home+Lisa")
8019 ("hp" tags "+home+Peter")
8020 ("hk" tags "+home+Kim")))
8025 The initial string in each entry defines the keys you have to press
8026 after the dispatcher command @kbd{C-c a} in order to access the command.
8027 Usually this will be just a single character, but if you have many
8028 similar commands, you can also define two-letter combinations where the
8029 first character is the same in several combinations and serves as a
8030 prefix key@footnote{You can provide a description for a prefix key by
8031 inserting a cons cell with the prefix and the description.}. The second
8032 parameter is the search type, followed by the string or regular
8033 expression to be used for the matching. The example above will
8038 as a global search for TODO entries with @samp{WAITING} as the TODO
8041 as the same search, but only in the current buffer and displaying the
8042 results as a sparse tree
8044 as a global tags search for headlines marked @samp{:boss:} but not
8047 as the same search as @kbd{C-c a u}, but limiting the search to
8048 headlines that are also TODO items
8050 as the same search as @kbd{C-c a u}, but only in the current buffer and
8051 displaying the result as a sparse tree
8053 to create a sparse tree (again: current buffer only) with all entries
8054 containing the word @samp{FIXME}
8056 as a prefix command for a HOME tags search where you have to press an
8057 additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
8058 Peter, or Kim) as additional tag to match.
8061 @node Block agenda, Setting Options, Storing searches, Custom agenda views
8062 @subsection Block agenda
8063 @cindex block agenda
8064 @cindex agenda, with block views
8066 Another possibility is the construction of agenda views that comprise
8067 the results of @emph{several} commands, each of which creates a block in
8068 the agenda buffer. The available commands include @code{agenda} for the
8069 daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
8070 for the global TODO list (as constructed with @kbd{C-c a t}), and the
8071 matching commands discussed above: @code{todo}, @code{tags}, and
8072 @code{tags-todo}. Here are two examples:
8076 (setq org-agenda-custom-commands
8077 '(("h" "Agenda and Home-related tasks"
8081 ("o" "Agenda and Office-related tasks"
8089 This will define @kbd{C-c a h} to create a multi-block view for stuff
8090 you need to attend to at home. The resulting agenda buffer will contain
8091 your agenda for the current week, all TODO items that carry the tag
8092 @samp{home}, and also all lines tagged with @samp{garden}. Finally the
8093 command @kbd{C-c a o} provides a similar view for office tasks.
8095 @node Setting Options, , Block agenda, Custom agenda views
8096 @subsection Setting options for custom commands
8097 @cindex options, for custom agenda views
8099 @vindex org-agenda-custom-commands
8100 Org-mode contains a number of variables regulating agenda construction
8101 and display. The global variables define the behavior for all agenda
8102 commands, including the custom commands. However, if you want to change
8103 some settings just for a single custom view, you can do so. Setting
8104 options requires inserting a list of variable names and values at the
8105 right spot in @code{org-agenda-custom-commands}. For example:
8109 (setq org-agenda-custom-commands
8110 '(("w" todo "WAITING"
8111 ((org-agenda-sorting-strategy '(priority-down))
8112 (org-agenda-prefix-format " Mixed: ")))
8113 ("U" tags-tree "+boss-urgent"
8114 ((org-show-following-heading nil)
8115 (org-show-hierarchy-above nil)))
8117 ((org-agenda-files '("~org/notes.org"))
8118 (org-agenda-text-search-extra-files nil)))))
8123 Now the @kbd{C-c a w} command will sort the collected entries only by
8124 priority, and the prefix format is modified to just say @samp{ Mixed: }
8125 instead of giving the category of the entry. The sparse tags tree of
8126 @kbd{C-c a U} will now turn out ultra-compact, because neither the
8127 headline hierarchy above the match, nor the headline following the match
8128 will be shown. The command @kbd{C-c a N} will do a text search limited
8129 to only a single file.
8131 @vindex org-agenda-custom-commands
8132 For command sets creating a block agenda,
8133 @code{org-agenda-custom-commands} has two separate spots for setting
8134 options. You can add options that should be valid for just a single
8135 command in the set, and options that should be valid for all commands in
8136 the set. The former are just added to the command entry, the latter
8137 must come after the list of command entries. Going back to the block
8138 agenda example (@pxref{Block agenda}), let's change the sorting strategy
8139 for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
8140 the results for GARDEN tags query in the opposite order,
8141 @code{priority-up}. This would look like this:
8145 (setq org-agenda-custom-commands
8146 '(("h" "Agenda and Home-related tasks"
8150 ((org-agenda-sorting-strategy '(priority-up)))))
8151 ((org-agenda-sorting-strategy '(priority-down))))
8152 ("o" "Agenda and Office-related tasks"
8159 As you see, the values and parentheses setting is a little complex.
8160 When in doubt, use the customize interface to set this variable---it
8161 fully supports its structure. Just one caveat: when setting options in
8162 this interface, the @emph{values} are just Lisp expressions. So if the
8163 value is a string, you need to add the double-quotes around the value
8167 @node Exporting Agenda Views, Agenda column view, Custom agenda views, Agenda Views
8168 @section Exporting Agenda Views
8169 @cindex agenda views, exporting
8171 If you are away from your computer, it can be very useful to have a printed
8172 version of some agenda views to carry around. Org-mode can export custom
8173 agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's
8174 @file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the
8175 ghostscript @file{ps2pdf} utility must be installed on the system. Selecting
8176 a PDF file with also create the postscript file.}, and iCalendar files. If
8177 you want to do this only occasionally, use the command
8182 @cindex exporting agenda views
8183 @cindex agenda views, exporting
8184 @vindex org-agenda-exporter-settings
8185 Write the agenda view to a file. Depending on the extension of the selected
8186 file name, the view will be exported as HTML (extension @file{.html} or
8187 @file{.htm}), Postscript (extension @file{.ps}), iCalendar (extension
8188 @file{.ics}), or plain text (any other extension). Use the variable
8189 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
8190 for @file{htmlize} to be used during export, for example
8192 @vindex org-agenda-add-entry-text-maxlines
8193 @vindex htmlize-output-type
8194 @vindex ps-number-of-columns
8195 @vindex ps-landscape-mode
8197 (setq org-agenda-exporter-settings
8198 '((ps-number-of-columns 2)
8199 (ps-landscape-mode t)
8200 (org-agenda-add-entry-text-maxlines 5)
8201 (htmlize-output-type 'css)))
8205 If you need to export certain agenda views frequently, you can associate
8206 any custom agenda command with a list of output file names
8207 @footnote{If you want to store standard views like the weekly agenda
8208 or the global TODO list as well, you need to define custom commands for
8209 them in order to be able to specify file names.}. Here is an example
8210 that first defines custom commands for the agenda and the global
8211 TODO list, together with a number of files to which to export them.
8212 Then we define two block agenda commands and specify file names for them
8213 as well. File names can be relative to the current working directory,
8218 (setq org-agenda-custom-commands
8219 '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
8220 ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
8221 ("h" "Agenda and Home-related tasks"
8226 ("~/views/home.html"))
8227 ("o" "Agenda and Office-related tasks"
8232 ("~/views/office.ps" "~/calendars/office.ics"))))
8236 The extension of the file name determines the type of export. If it is
8237 @file{.html}, Org-mode will use the @file{htmlize.el} package to convert
8238 the buffer to HTML and save it to this file name. If the extension is
8239 @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
8240 Postscript output. If the extension is @file{.ics}, iCalendar export is
8241 run export over all files that were used to construct the agenda, and
8242 limit the export to entries listed in the agenda. Any other
8243 extension produces a plain ASCII file.
8245 The export files are @emph{not} created when you use one of those
8246 commands interactively because this might use too much overhead.
8247 Instead, there is a special command to produce @emph{all} specified
8253 Export all agenda views that have export file names associated with
8257 You can use the options section of the custom agenda commands to also
8258 set options for the export commands. For example:
8261 (setq org-agenda-custom-commands
8263 ((ps-number-of-columns 2)
8264 (ps-landscape-mode t)
8265 (org-agenda-prefix-format " [ ] ")
8266 (org-agenda-with-colors nil)
8267 (org-agenda-remove-tags t))
8272 This command sets two options for the Postscript exporter, to make it
8273 print in two columns in landscape format---the resulting page can be cut
8274 in two and then used in a paper agenda. The remaining settings modify
8275 the agenda prefix to omit category and scheduling information, and
8276 instead include a checkbox to check off items. We also remove the tags
8277 to make the lines compact, and we don't want to use colors for the
8278 black-and-white printer. Settings specified in
8279 @code{org-agenda-exporter-settings} will also apply, but the settings
8280 in @code{org-agenda-custom-commands} take precedence.
8283 From the command line you may also use
8285 emacs -f org-batch-store-agenda-views -kill
8288 or, if you need to modify some parameters@footnote{Quoting depends on the
8289 system you use, please check the FAQ for examples.}
8291 emacs -eval '(org-batch-store-agenda-views \
8292 org-agenda-ndays 30 \
8293 org-agenda-start-day "2007-11-01" \
8294 org-agenda-include-diary nil \
8295 org-agenda-files (quote ("~/org/project.org")))' \
8299 which will create the agenda views restricted to the file
8300 @file{~/org/project.org}, without diary entries and with a 30-day
8303 You can also extract agenda information in a way that allows further
8304 processing by other programs. See @ref{Extracting agenda information}, for
8308 @node Agenda column view, , Exporting Agenda Views, Agenda Views
8309 @section Using column view in the agenda
8310 @cindex column view, in agenda
8311 @cindex agenda, column view
8313 Column view (@pxref{Column view}) is normally used to view and edit
8314 properties embedded in the hierarchical structure of an Org file. It can be
8315 quite useful to use column view also from the agenda, where entries are
8316 collected by certain criteria.
8321 Turn on column view in the agenda.
8324 To understand how to use this properly, it is important to realize that the
8325 entries in the agenda are no longer in their proper outline environment.
8326 This causes the following issues:
8330 @vindex org-columns-default-format
8331 @vindex org-overriding-columns-format
8332 Org needs to make a decision which @code{COLUMNS} format to use. Since the
8333 entries in the agenda are collected from different files, and different files
8334 may have different @code{COLUMNS} formats, this is a non-trivial problem.
8335 Org first checks if the variable @code{org-overriding-columns-format} is
8336 currently set, and if so, takes the format from there. Otherwise it takes
8337 the format associated with the first item in the agenda, or, if that item
8338 does not have a specific format (defined in a property, or in its file), it
8339 uses @code{org-columns-default-format}.
8341 @cindex property, special, CLOCKSUM
8342 If any of the columns has a summary type defined (@pxref{Column attributes}),
8343 turning on column view in the agenda will visit all relevant agenda files and
8344 make sure that the computations of this property are up to date. This is
8345 also true for the special @code{CLOCKSUM} property. Org will then sum the
8346 values displayed in the agenda. In the daily/weekly agenda, the sums will
8347 cover a single day, in all other views they cover the entire block. It is
8348 vital to realize that the agenda may show the same entry @emph{twice} (for
8349 example as scheduled and as a deadline), and it may show two entries from the
8350 same hierarchy (for example a @emph{parent} and its @emph{child}). In these
8351 cases, the summation in the agenda will lead to incorrect results because
8352 some values will count double.
8354 When the column view in the agenda shows the @code{CLOCKSUM}, that is always
8355 the entire clocked time for this item. So even in the daily/weekly agenda,
8356 the clocksum listed in column view may originate from times outside the
8357 current view. This has the advantage that you can compare these values with
8358 a column listing the planned total effort for a task---one of the major
8359 applications for column view in the agenda. If you want information about
8360 clocked time in the displayed period use clock table mode (press @kbd{R} in
8365 @node Markup, Exporting, Agenda Views, Top
8366 @chapter Markup for rich export
8368 When exporting Org-mode documents, the exporter tries to reflect the
8369 structure of the document as accurately as possible in the backend. Since
8370 export targets like HTML, La@TeX{}, or DocBook allow much richer formatting,
8371 Org-mode has rules on how to prepare text for rich export. This section
8372 summarizes the markup rules used in an Org-mode buffer.
8375 * Structural markup elements:: The basic structure as seen by the exporter
8376 * Images and tables:: Tables and Images will be included
8377 * Literal examples:: Source code examples with special formatting
8378 * Include files:: Include additional files into a document
8379 * Index entries:: Making an index
8380 * Macro replacement:: Use macros to create complex output
8381 * Embedded LaTeX:: LaTeX can be freely used inside Org documents
8384 @node Structural markup elements, Images and tables, Markup, Markup
8385 @section Structural markup elements
8388 * Document title:: Where the title is taken from
8389 * Headings and sections:: The document structure as seen by the exporter
8390 * Table of contents:: The if and where of the table of contents
8391 * Initial text:: Text before the first heading?
8393 * Paragraphs:: Paragraphs
8394 * Footnote markup:: Footnotes
8395 * Emphasis and monospace:: Bold, italic, etc.
8396 * Horizontal rules:: Make a line
8397 * Comment lines:: What will *not* be exported
8400 @node Document title, Headings and sections, Structural markup elements, Structural markup elements
8401 @subheading Document title
8402 @cindex document title, markup rules
8405 The title of the exported document is taken from the special line
8409 #+TITLE: This is the title of the document
8413 If this line does not exist, the title is derived from the first non-empty,
8414 non-comment line in the buffer. If no such line exists, or if you have
8415 turned off exporting of the text before the first headline (see below), the
8416 title will be the file name without extension.
8418 @cindex property, EXPORT_TITLE
8419 If you are exporting only a subtree by marking is as the region, the heading
8420 of the subtree will become the title of the document. If the subtree has a
8421 property @code{EXPORT_TITLE}, that will take precedence.
8423 @node Headings and sections, Table of contents, Document title, Structural markup elements
8424 @subheading Headings and sections
8425 @cindex headings and sections, markup rules
8427 @vindex org-export-headline-levels
8428 The outline structure of the document as described in @ref{Document
8429 Structure}, forms the basis for defining sections of the exported document.
8430 However, since the outline structure is also used for (for example) lists of
8431 tasks, only the first three outline levels will be used as headings. Deeper
8432 levels will become itemized lists. You can change the location of this
8433 switch globally by setting the variable @code{org-export-headline-levels}, or on a
8434 per-file basis with a line
8441 @node Table of contents, Initial text, Headings and sections, Structural markup elements
8442 @subheading Table of contents
8443 @cindex table of contents, markup rules
8445 @vindex org-export-with-toc
8446 The table of contents is normally inserted directly before the first headline
8447 of the file. If you would like to get it to a different location, insert the
8448 string @code{[TABLE-OF-CONTENTS]} on a line by itself at the desired
8449 location. The depth of the table of contents is by default the same as the
8450 number of headline levels, but you can choose a smaller number, or turn off
8451 the table of contents entirely, by configuring the variable
8452 @code{org-export-with-toc}, or on a per-file basis with a line like
8455 #+OPTIONS: toc:2 (only to two levels in TOC)
8456 #+OPTIONS: toc:nil (no TOC at all)
8459 @node Initial text, Lists, Table of contents, Structural markup elements
8460 @subheading Text before the first headline
8461 @cindex text before first headline, markup rules
8464 Org-mode normally exports the text before the first headline, and even uses
8465 the first line as the document title. The text will be fully marked up. If
8466 you need to include literal HTML, La@TeX{}, or DocBook code, use the special
8467 constructs described below in the sections for the individual exporters.
8469 @vindex org-export-skip-text-before-1st-heading
8470 Some people like to use the space before the first headline for setup and
8471 internal links and therefore would like to control the exported text before
8472 the first headline in a different way. You can do so by setting the variable
8473 @code{org-export-skip-text-before-1st-heading} to @code{t}. On a per-file
8474 basis, you can get the same effect with @samp{#+OPTIONS: skip:t}.
8477 If you still want to have some text before the first headline, use the
8478 @code{#+TEXT} construct:
8482 #+TEXT: This text will go before the *first* headline.
8483 #+TEXT: [TABLE-OF-CONTENTS]
8484 #+TEXT: This goes between the table of contents and the first headline
8487 @node Lists, Paragraphs, Initial text, Structural markup elements
8489 @cindex lists, markup rules
8491 Plain lists as described in @ref{Plain lists}, are translated to the backend's
8492 syntax for such lists. Most backends support unordered, ordered, and
8495 @node Paragraphs, Footnote markup, Lists, Structural markup elements
8496 @subheading Paragraphs, line breaks, and quoting
8497 @cindex paragraphs, markup rules
8499 Paragraphs are separated by at least one empty line. If you need to enforce
8500 a line break within a paragraph, use @samp{\\} at the end of a line.
8502 To keep the line breaks in a region, but otherwise use normal formatting, you
8503 can use this construct, which can also be used to format poetry.
8505 @cindex #+BEGIN_VERSE
8508 Great clouds overhead
8509 Tiny black birds rise and fall
8516 When quoting a passage from another document, it is customary to format this
8517 as a paragraph that is indented on both the left and the right margin. You
8518 can include quotations in Org-mode documents like this:
8520 @cindex #+BEGIN_QUOTE
8523 Everything should be made as simple as possible,
8524 but not any simpler -- Albert Einstein
8528 If you would like to center some text, do it like this:
8529 @cindex #+BEGIN_CENTER
8532 Everything should be made as simple as possible, \\
8538 @node Footnote markup, Emphasis and monospace, Paragraphs, Structural markup elements
8539 @subheading Footnote markup
8540 @cindex footnotes, markup rules
8541 @cindex @file{footnote.el}
8543 Footnotes defined in the way described in @ref{Footnotes}, will be exported by
8544 all backends. Org allows multiple references to the same note, and
8545 different backends support this to varying degrees.
8547 @node Emphasis and monospace, Horizontal rules, Footnote markup, Structural markup elements
8548 @subheading Emphasis and monospace
8550 @cindex underlined text, markup rules
8551 @cindex bold text, markup rules
8552 @cindex italic text, markup rules
8553 @cindex verbatim text, markup rules
8554 @cindex code text, markup rules
8555 @cindex strike-through text, markup rules
8556 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=}
8557 and @code{~verbatim~}, and, if you must, @samp{+strike-through+}. Text
8558 in the code and verbatim string is not processed for Org-mode specific
8559 syntax, it is exported verbatim.
8561 @node Horizontal rules, Comment lines, Emphasis and monospace, Structural markup elements
8562 @subheading Horizontal rules
8563 @cindex horizontal rules, markup rules
8564 A line consisting of only dashes, and at least 5 of them, will be
8565 exported as a horizontal line (@samp{<hr/>} in HTML).
8567 @node Comment lines, , Horizontal rules, Structural markup elements
8568 @subheading Comment lines
8569 @cindex comment lines
8570 @cindex exporting, not
8571 @cindex #+BEGIN_COMMENT
8573 Lines starting with @samp{#} in column zero are treated as comments and will
8574 never be exported. If you want an indented line to be treated as a comment,
8575 start it with @samp{#+ }. Also entire subtrees starting with the word
8576 @samp{COMMENT} will never be exported. Finally, regions surrounded by
8577 @samp{#+BEGIN_COMMENT} ... @samp{#+END_COMMENT} will not be exported.
8582 Toggle the COMMENT keyword at the beginning of an entry.
8586 @node Images and tables, Literal examples, Structural markup elements, Markup
8587 @section Images and Tables
8589 @cindex tables, markup rules
8592 Both the native Org-mode tables (@pxref{Tables}) and tables formatted with
8593 the @file{table.el} package will be exported properly. For Org-mode tables,
8594 the lines before the first horizontal separator line will become table header
8595 lines. You can use the following lines somewhere before the table to assign
8596 a caption and a label for cross references, and in the text you can refer to
8597 the object with @code{\ref@{tab:basic-data@}}:
8600 #+CAPTION: This is the caption for the next table (or link)
8601 #+LABEL: tbl:basic-data
8606 @cindex inlined images, markup rules
8607 Some backends (HTML, La@TeX{}, and DocBook) allow you to directly include
8608 images into the exported document. Org does this, if a link to an image
8609 files does not have a description part, for example @code{[[./img/a.jpg]]}.
8610 If you wish to define a caption for the image and maybe a label for internal
8611 cross references, make sure that the link is on a line by itself and precede
8612 it with @code{#+CAPTION} and @code{#+LABEL} as follows:
8615 #+CAPTION: This is the caption for the next figure link (or table)
8616 #+LABEL: fig:SED-HR4049
8620 You may also define additional attributes for the figure. As this is
8621 backend-specific, see the sections about the individual backends for more
8625 @node Literal examples, Include files, Images and tables, Markup
8626 @section Literal examples
8627 @cindex literal examples, markup rules
8628 @cindex code line references, markup rules
8630 You can include literal examples that should not be subjected to
8631 markup. Such examples will be typeset in monospace, so this is well suited
8632 for source code and similar examples.
8633 @cindex #+BEGIN_EXAMPLE
8637 Some example from a text file.
8641 Note that such blocks may be @i{indented} in order to align nicely with
8642 indented text and in particular with plain list structure (@pxref{Plain
8643 lists}). For simplicity when using small examples, you can also start the
8644 example lines with a colon followed by a space. There may also be additional
8645 whitespace before the colon:
8649 : Some example from a text file.
8652 @cindex formatting source code, markup rules
8653 If the example is source code from a programming language, or any other text
8654 that can be marked up by font-lock in Emacs, you can ask for the example to
8655 look like the fontified Emacs buffer@footnote{Currently this works for the
8656 HTML backend, and requires the @file{htmlize.el} package version 1.34 or
8657 later. It also works for LaTeX with the listings package, if you turn on the
8658 option @code{org-export-latex-listings} and make sure that the listings
8659 package is included by the LaTeX header.}. This is done with the @samp{src}
8660 block, where you also need to specify the name of the major mode that should
8661 be used to fontify the example:
8665 #+BEGIN_SRC emacs-lisp
8666 (defun org-xor (a b)
8672 Both in @code{example} and in @code{src} snippets, you can add a @code{-n}
8673 switch to the end of the @code{BEGIN} line, to get the lines of the example
8674 numbered. If you use a @code{+n} switch, the numbering from the previous
8675 numbered snippet will be continued in the current one. In literal examples,
8676 Org will interpret strings like @samp{(ref:name)} as labels, and use them as
8677 targets for special hyperlinks like @code{[[(name)]]} (i.e. the reference name
8678 enclosed in single parenthesis). In HTML, hovering the mouse over such a
8679 link will remote-highlight the corresponding code line, which is kind of
8682 You can also add a @code{-r} switch which @i{removes} the labels from the
8683 source code@footnote{Adding @code{-k} to @code{-n -r} will @i{keep} the
8684 labels in the source code while using line numbers for the links, which might
8685 be useful to explain those in an org-mode example code.}. With the @code{-n}
8686 switch, links to these references will be labeled by the line numbers from
8687 the code listing, otherwise links will use the labels with no parentheses.
8691 #+BEGIN_SRC emacs-lisp -n -r
8692 (save-excursion (ref:sc)
8693 (goto-char (point-min)) (ref:jump)
8695 In line [[(sc)]] we remember the current position. [[(jump)][Line (jump)]]
8699 @vindex org-coderef-label-format
8700 If the syntax for the label format conflicts with the language syntax, use a
8701 @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
8702 -n -r -l "((%s))"}. See also the variable @code{org-coderef-label-format}.
8704 HTML export also allows examples to be published as text areas, @xref{Text
8705 areas in HTML export}.
8710 Edit the source code example at point in its native mode. This works by
8711 switching to a temporary buffer with the source code. You need to exit by
8712 pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*}
8713 or @samp{#} will get a comma prepended, to keep them from being interpreted
8714 by Org as outline nodes or special comments. These commas will be stripped
8715 for editing with @kbd{C-c '}, and also for export.}, the edited version will
8716 then replace the old version in the Org buffer. Fixed-width regions
8717 (where each line starts with a colon followed by a space) will be edited
8718 using @code{artist-mode}@footnote{You may select a different-mode with the
8719 variable @code{org-edit-fixed-width-region-mode}.} to allow creating ASCII
8720 drawings easily. Using this command in an empty line will create a new
8724 Calling @code{org-store-link} while editing a source code example in a
8725 temporary buffer created with @kbd{C-c '} will prompt for a label, make sure
8726 that it is unique in the current buffer, and insert it with the proper
8727 formatting like @samp{(ref:label)} at the end of the current line. Then the
8728 label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
8732 @node Include files, Index entries, Literal examples, Markup
8733 @section Include files
8734 @cindex include files, markup rules
8736 During export, you can include the content of another file. For example, to
8737 include your @file{.emacs} file, you could use:
8741 #+INCLUDE: "~/.emacs" src emacs-lisp
8744 The optional second and third parameter are the markup (e.g. @samp{quote},
8745 @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the
8746 language for formatting the contents. The markup is optional, if it is not
8747 given, the text will be assumed to be in Org-mode format and will be
8748 processed normally. The include line will also allow additional keyword
8749 parameters @code{:prefix1} and @code{:prefix} to specify prefixes for the
8750 first line and for each following line, as well as any options accepted by
8751 the selected markup. For example, to include a file as an item, use
8754 #+INCLUDE: "~/snippets/xx" :prefix1 " + " :prefix " "
8760 Visit the include file at point.
8763 @node Index entries, Macro replacement, Include files, Markup
8764 @section Index entries
8765 @cindex index entries, for publishing
8767 You can specify entries that will be used for generating an index during
8768 publishing. This is done by lines starting with @code{#+INDEX}. An entry
8769 the contains an exclamation mark will create a sub item. See @ref{Generating
8770 an index} for more information.
8775 #+INDEX: Application!CV
8781 @node Macro replacement, Embedded LaTeX, Index entries, Markup
8782 @section Macro replacement
8783 @cindex macro replacement, during export
8786 You can define text snippets with
8789 #+MACRO: name replacement text $1, $2 are arguments
8792 @noindent which can be referenced anywhere in the document (even in
8793 code examples) with @code{@{@{@{name(arg1,arg2)@}@}@}}. In addition to
8794 defined macros, @code{@{@{@{title@}@}@}}, @code{@{@{@{author@}@}@}}, etc.,
8795 will reference information set by the @code{#+TITLE:}, @code{#+AUTHOR:}, and
8796 similar lines. Also, @code{@{@{@{date(@var{FORMAT})@}@}@}} and
8797 @code{@{@{@{modification-time(@var{FORMAT})@}@}@}} refer to current date time
8798 and to the modification time of the file being exported, respectively.
8799 @var{FORMAT} should be a format string understood by
8800 @code{format-time-string}.
8802 Macro expansion takes place during export, and some people use it to
8803 construct complex HTML code.
8806 @node Embedded LaTeX, , Macro replacement, Markup
8807 @section Embedded La@TeX{}
8808 @cindex @TeX{} interpretation
8809 @cindex La@TeX{} interpretation
8811 Plain ASCII is normally sufficient for almost all note taking. One
8812 exception, however, are scientific notes which need to be able to contain
8813 mathematical symbols and the occasional formula. La@TeX{}@footnote{La@TeX{}
8814 is a macro system based on Donald E. Knuth's @TeX{} system. Many of the
8815 features described here as ``La@TeX{}'' are really from @TeX{}, but for
8816 simplicity I am blurring this distinction.} is widely used to typeset
8817 scientific documents. Org-mode supports embedding La@TeX{} code into its
8818 files, because many academics are used to reading La@TeX{} source code, and
8819 because it can be readily processed into images for HTML production.
8821 It is not necessary to mark La@TeX{} macros and code in any special way.
8822 If you observe a few conventions, Org-mode knows how to find it and what
8826 * Special symbols:: Greek letters and other symbols
8827 * Subscripts and superscripts:: Simple syntax for raising/lowering text
8828 * LaTeX fragments:: Complex formulas made easy
8829 * Previewing LaTeX fragments:: What will this snippet look like?
8830 * CDLaTeX mode:: Speed up entering of formulas
8833 @node Special symbols, Subscripts and superscripts, Embedded LaTeX, Embedded LaTeX
8834 @subsection Special symbols
8835 @cindex math symbols
8836 @cindex special symbols
8837 @cindex @TeX{} macros
8838 @cindex La@TeX{} fragments, markup rules
8839 @cindex HTML entities
8840 @cindex La@TeX{} entities
8842 You can use La@TeX{} macros to insert special symbols like @samp{\alpha} to
8843 indicate the Greek letter, or @samp{\to} to indicate an arrow. Completion
8844 for these macros is available, just type @samp{\} and maybe a few letters,
8845 and press @kbd{M-@key{TAB}} to see possible completions. Unlike La@TeX{}
8846 code, Org-mode allows these macros to be present without surrounding math
8847 delimiters, for example:
8850 Angles are written as Greek letters \alpha, \beta and \gamma.
8853 @vindex org-entities
8854 During export, these symbols will be transformed into the native format of
8855 the exporter backend. Strings like @code{\alpha} will be exported as
8856 @code{α} in the HTML output, and as @code{$\alpha$} in the La@TeX{}
8857 output. Similarly, @code{\nbsp} will become @code{ } in HTML and
8858 @code{~} in La@TeX{}. If you need such a symbol inside a word, terminate it
8859 like this: @samp{\Aacute@{@}stor}.
8861 A large number of entities is provided, with names taken from both HTML and
8862 La@TeX{}, see the variable @code{org-entities} for the complete list.
8863 @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
8864 @samp{...} are all converted into special commands creating hyphens of
8865 different lengths or a compact set of dots.
8867 If you would like to see entities displayed as utf8 characters, use the
8868 following command@footnote{You can turn this on by default by setting the
8869 variable @code{org-pretty-entities}, or on a per-file base with the
8870 @code{#+STARTUP} option @code{entitiespretty}.}:
8875 Toggle display of entities as UTF8 characters. This does not change the
8876 buffer content which remains plain ASCII, but it overlays the UTF8 character
8877 for display purposes only.
8880 @node Subscripts and superscripts, LaTeX fragments, Special symbols, Embedded LaTeX
8881 @subsection Subscripts and superscripts
8885 Just like in La@TeX{}, @samp{^} and @samp{_} are used to indicate super-
8886 and subscripts. Again, these can be used without embedding them in
8887 math-mode delimiters. To increase the readability of ASCII text, it is
8888 not necessary (but OK) to surround multi-character sub- and superscripts
8889 with curly braces. For example
8892 The mass if the sun is M_sun = 1.989 x 10^30 kg. The radius of
8893 the sun is R_@{sun@} = 6.96 x 10^8 m.
8896 @vindex org-export-with-sub-superscripts
8897 To avoid interpretation as raised or lowered text, you can quote @samp{^} and
8898 @samp{_} with a backslash: @samp{\^} and @samp{\_}. If you write a text
8899 where the underscore is often used in a different context, Org's convention
8900 to always interpret these as subscripts can get in your way. Configure the
8901 variable @code{org-export-with-sub-superscripts} to globally change this
8902 convention, or use, on a per-file basis:
8911 In addition to showing entities as UTF8 characters, this command will also
8912 format sub- and superscripts in a WYSIWYM way.
8915 @node LaTeX fragments, Previewing LaTeX fragments, Subscripts and superscripts, Embedded LaTeX
8916 @subsection La@TeX{} fragments
8917 @cindex La@TeX{} fragments
8919 @vindex org-format-latex-header
8920 With symbols, sub- and superscripts, HTML is pretty much at its end when
8921 it comes to representing mathematical formulas@footnote{Yes, there is
8922 MathML, but that is not yet fully supported by many browsers, and there
8923 is no decent converter for turning La@TeX{} or ASCII representations of
8924 formulas into MathML. So for the time being, converting formulas into
8925 images seems the way to go.}. More complex expressions need a dedicated
8926 formula processor. To this end, Org-mode can contain arbitrary La@TeX{}
8927 fragments. It provides commands to preview the typeset result of these
8928 fragments, and upon export to HTML, all fragments will be converted to
8929 images and inlined into the HTML document@footnote{The La@TeX{} export
8930 will not use images for displaying La@TeX{} fragments but include these
8931 fragments directly into the La@TeX{} code.}. For this to work you
8932 need to be on a system with a working La@TeX{} installation. You also
8933 need the @file{dvipng} program, available at
8934 @url{http://sourceforge.net/projects/dvipng/}. The La@TeX{} header that
8935 will be used when processing a fragment can be configured with the
8936 variable @code{org-format-latex-header}.
8938 La@TeX{} fragments don't need any special marking at all. The following
8939 snippets will be identified as La@TeX{} source code:
8942 Environments of any kind. The only requirement is that the
8943 @code{\begin} statement appears on a new line, preceded by only
8946 Text within the usual La@TeX{} math delimiters. To avoid conflicts with
8947 currency specifications, single @samp{$} characters are only recognized as
8948 math delimiters if the enclosed text contains at most two line breaks, is
8949 directly attached to the @samp{$} characters with no whitespace in between,
8950 and if the closing @samp{$} is followed by whitespace, punctuation or a dash.
8951 For the other delimiters, there is no such restriction, so when in doubt, use
8952 @samp{\(...\)} as inline math delimiters.
8955 @noindent For example:
8958 \begin@{equation@} % arbitrary environments,
8959 x=\sqrt@{b@} % even tables, figures
8960 \end@{equation@} % etc
8962 If $a^2=b$ and \( b=2 \), then the solution must be
8963 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
8967 @vindex org-format-latex-options
8968 If you need any of the delimiter ASCII sequences for other purposes, you
8969 can configure the option @code{org-format-latex-options} to deselect the
8970 ones you do not wish to have interpreted by the La@TeX{} converter.
8972 @node Previewing LaTeX fragments, CDLaTeX mode, LaTeX fragments, Embedded LaTeX
8973 @subsection Previewing LaTeX fragments
8974 @cindex LaTeX fragments, preview
8976 La@TeX{} fragments can be processed to produce preview images of the
8977 typeset expressions:
8982 Produce a preview image of the La@TeX{} fragment at point and overlay it
8983 over the source code. If there is no fragment at point, process all
8984 fragments in the current entry (between two headlines). When called
8985 with a prefix argument, process the entire subtree. When called with
8986 two prefix arguments, or when the cursor is before the first headline,
8987 process the entire buffer.
8990 Remove the overlay preview images.
8993 @vindex org-format-latex-options
8994 You can customize the variable @code{org-format-latex-options} to influence
8995 some aspects of the preview. In particular, the @code{:scale} (and for HTML
8996 export, @code{:html-scale}) property can be used to adjust the size of the
8999 During HTML export (@pxref{HTML export}), all La@TeX{} fragments are
9000 converted into images and inlined into the document if the following
9004 (setq org-export-with-LaTeX-fragments t)
9007 @node CDLaTeX mode, , Previewing LaTeX fragments, Embedded LaTeX
9008 @subsection Using CDLa@TeX{} to enter math
9011 CDLa@TeX{} mode is a minor mode that is normally used in combination with a
9012 major La@TeX{} mode like AUC@TeX{} in order to speed-up insertion of
9013 environments and math templates. Inside Org-mode, you can make use of
9014 some of the features of CDLa@TeX{} mode. You need to install
9015 @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
9016 AUC@TeX{}) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
9017 Don't use CDLa@TeX{} mode itself under Org-mode, but use the light
9018 version @code{org-cdlatex-mode} that comes as part of Org-mode. Turn it
9019 on for the current buffer with @code{M-x org-cdlatex-mode}, or for all
9023 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
9026 When this mode is enabled, the following features are present (for more
9027 details see the documentation of CDLa@TeX{} mode):
9031 Environment templates can be inserted with @kbd{C-c @{}.
9034 The @key{TAB} key will do template expansion if the cursor is inside a
9035 La@TeX{} fragment@footnote{Org-mode has a method to test if the cursor is
9036 inside such a fragment, see the documentation of the function
9037 @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will
9038 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
9039 correctly inside the first brace. Another @key{TAB} will get you into
9040 the second brace. Even outside fragments, @key{TAB} will expand
9041 environment abbreviations at the beginning of a line. For example, if
9042 you write @samp{equ} at the beginning of a line and press @key{TAB},
9043 this abbreviation will be expanded to an @code{equation} environment.
9044 To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}.
9048 @vindex cdlatex-simplify-sub-super-scripts
9049 Pressing @kbd{_} and @kbd{^} inside a La@TeX{} fragment will insert these
9050 characters together with a pair of braces. If you use @key{TAB} to move
9051 out of the braces, and if the braces surround only a single character or
9052 macro, they are removed again (depending on the variable
9053 @code{cdlatex-simplify-sub-super-scripts}).
9056 Pressing the backquote @kbd{`} followed by a character inserts math
9057 macros, also outside La@TeX{} fragments. If you wait more than 1.5 seconds
9058 after the backquote, a help window will pop up.
9061 Pressing the single-quote @kbd{'} followed by another character modifies
9062 the symbol before point with an accent or a font. If you wait more than
9063 1.5 seconds after the backquote, a help window will pop up. Character
9064 modification will work only inside La@TeX{} fragments, outside the quote
9068 @node Exporting, Publishing, Markup, Top
9072 Org-mode documents can be exported into a variety of other formats. For
9073 printing and sharing of notes, ASCII export produces a readable and simple
9074 version of an Org file. HTML export allows you to publish a notes file on
9075 the web, while the XOXO format provides a solid base for exchange with a
9076 broad range of other applications. La@TeX{} export lets you use Org-mode and
9077 its structured editing functions to easily create La@TeX{} files. DocBook
9078 export makes it possible to convert Org files to many other formats using
9079 DocBook tools. For project management you can create gantt and resource
9080 charts by using TaskJuggler export. To incorporate entries with associated
9081 times like deadlines or appointments into a desktop calendar program like
9082 iCal, Org-mode can also produce extracts in the iCalendar format. Currently
9083 Org-mode only supports export, not import of these different formats.
9085 Org supports export of selected regions when @code{transient-mark-mode} is
9086 enabled (default in Emacs 23).
9089 * Selective export:: Using tags to select and exclude trees
9090 * Export options:: Per-file export settings
9091 * The export dispatcher:: How to access exporter commands
9092 * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
9093 * HTML export:: Exporting to HTML
9094 * LaTeX and PDF export:: Exporting to La@TeX{}, and processing to PDF
9095 * DocBook export:: Exporting to DocBook
9096 * TaskJuggler export:: Exporting to TaskJuggler
9097 * Freemind export:: Exporting to Freemind mind maps
9098 * XOXO export:: Exporting to XOXO
9099 * iCalendar export:: Exporting in iCalendar format
9102 @node Selective export, Export options, Exporting, Exporting
9103 @section Selective export
9104 @cindex export, selective by tags
9106 @vindex org-export-select-tags
9107 @vindex org-export-exclude-tags
9108 You may use tags to select the parts of a document that should be exported,
9109 or to exclude parts from export. This behavior is governed by two variables:
9110 @code{org-export-select-tags} and @code{org-export-exclude-tags}.
9112 Org first checks if any of the @emph{select} tags is present in the buffer.
9113 If yes, all trees that do not carry one of these tags will be excluded. If a
9114 selected tree is a subtree, the heading hierarchy above it will also be
9115 selected for export, but not the text below those headings.
9118 If none of the select tags is found, the whole buffer will be selected for
9122 Finally, all subtrees that are marked by any of the @emph{exclude} tags will
9123 be removed from the export buffer.
9125 @node Export options, The export dispatcher, Selective export, Exporting
9126 @section Export options
9127 @cindex options, for export
9129 @cindex completion, of option keywords
9130 The exporter recognizes special lines in the buffer which provide
9131 additional information. These lines may be put anywhere in the file.
9132 The whole set of lines can be inserted into the buffer with @kbd{C-c
9133 C-e t}. For individual lines, a good way to make sure the keyword is
9134 correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion
9135 (@pxref{Completion}). For a summary of other in-buffer settings not
9136 specifically related to export, see @ref{In-buffer settings}.
9137 In particular, note that you can place commonly-used (export) options in
9138 a separate file which can be included using @code{#+SETUPFILE}.
9143 Insert template with export options, see example below.
9150 @cindex #+DESCRIPTION
9158 @cindex #+EXPORT_SELECT_TAGS
9159 @cindex #+EXPORT_EXCLUDE_TAGS
9161 @cindex #+LATEX_HEADER
9162 @vindex user-full-name
9163 @vindex user-mail-address
9164 @vindex org-export-default-language
9166 #+TITLE: the title to be shown (default is the buffer name)
9167 #+AUTHOR: the author (default taken from @code{user-full-name})
9168 #+DATE: a date, fixed, of a format string for @code{format-time-string}
9169 #+EMAIL: his/her email address (default from @code{user-mail-address})
9170 #+DESCRIPTION: the page description, e.g. for the XHTML meta tag
9171 #+KEYWORDS: the page keywords, e.g. for the XHTML meta tag
9172 #+LANGUAGE: language for HTML, e.g. @samp{en} (@code{org-export-default-language})
9173 #+TEXT: Some descriptive text to be inserted at the beginning.
9174 #+TEXT: Several lines may be given.
9175 #+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ...
9176 #+BIND: lisp-var lisp-val, e.g.: org-export-latex-low-levels itemize
9177 @r{You need to confirm using these, or configure @code{org-export-allow-BIND}}
9178 #+LINK_UP: the ``up'' link of an exported page
9179 #+LINK_HOME: the ``home'' link of an exported page
9180 #+LATEX_HEADER: extra line(s) for the LaTeX header, like \usepackage@{xyz@}
9181 #+EXPORT_SELECT_TAGS: Tags that select a tree for export
9182 #+EXPORT_EXCLUDE_TAGS: Tags that exclude a tree from export
9183 #+XSLT: the XSLT stylesheet used by DocBook exporter to generate FO file
9187 The OPTIONS line is a compact@footnote{If you want to configure many options
9188 this way, you can use several OPTIONS lines.} form to specify export settings. Here
9190 @cindex headline levels
9191 @cindex section-numbers
9192 @cindex table of contents
9193 @cindex line-break preservation
9194 @cindex quoted HTML tags
9195 @cindex fixed-width sections
9197 @cindex @TeX{}-like syntax for sub- and superscripts
9199 @cindex special strings
9200 @cindex emphasized text
9201 @cindex @TeX{} macros
9202 @cindex La@TeX{} fragments
9203 @cindex author info, in export
9204 @cindex time info, in export
9206 H: @r{set the number of headline levels for export}
9207 num: @r{turn on/off section-numbers}
9208 toc: @r{turn on/off table of contents, or set level limit (integer)}
9209 \n: @r{turn on/off line-break-preservation (DOES NOT WORK)}
9210 @@: @r{turn on/off quoted HTML tags}
9211 :: @r{turn on/off fixed-width sections}
9212 |: @r{turn on/off tables}
9213 ^: @r{turn on/off @TeX{}-like syntax for sub- and superscripts. If}
9214 @r{you write "^:@{@}", @code{a_@{b@}} will be interpreted, but}
9215 @r{the simple @code{a_b} will be left as it is.}
9216 -: @r{turn on/off conversion of special strings.}
9217 f: @r{turn on/off footnotes like this[1].}
9218 todo: @r{turn on/off inclusion of TODO keywords into exported text}
9219 pri: @r{turn on/off priority cookies}
9220 tags: @r{turn on/off inclusion of tags, may also be @code{not-in-toc}}
9221 <: @r{turn on/off inclusion of any time/date stamps like DEADLINES}
9222 *: @r{turn on/off emphasized text (bold, italic, underlined)}
9223 TeX: @r{turn on/off simple @TeX{} macros in plain text}
9224 LaTeX: @r{turn on/off La@TeX{} fragments}
9225 skip: @r{turn on/off skipping the text before the first heading}
9226 author: @r{turn on/off inclusion of author name/email into exported file}
9227 email: @r{turn on/off inclusion of author email into exported file}
9228 creator: @r{turn on/off inclusion of creator info into exported file}
9229 timestamp: @r{turn on/off inclusion creation time into exported file}
9230 d: @r{turn on/off inclusion of drawers}
9233 These options take effect in both the HTML and La@TeX{} export, except
9234 for @code{TeX} and @code{LaTeX}, which are respectively @code{t} and
9235 @code{nil} for the La@TeX{} export.
9237 When exporting only a single subtree by selecting it with @kbd{C-c @@} before
9238 calling an export command, the subtree can overrule some of the file's export
9239 settings with properties @code{EXPORT_FILE_NAME}, @code{EXPORT_TITLE},
9240 @code{EXPORT_TEXT}, @code{EXPORT_AUTHOR}, @code{EXPORT_DATE}, and
9241 @code{EXPORT_OPTIONS}.
9243 @node The export dispatcher, ASCII/Latin-1/UTF-8 export, Export options, Exporting
9244 @section The export dispatcher
9245 @cindex dispatcher, for export commands
9247 All export commands can be reached using the export dispatcher, which is a
9248 prefix key that prompts for an additional key specifying the command.
9249 Normally the entire file is exported, but if there is an active region that
9250 contains one outline tree, the first heading is used as document title and
9251 the subtrees are exported.
9256 @vindex org-export-run-in-background
9257 Dispatcher for export and publishing commands. Displays a help-window
9258 listing the additional key(s) needed to launch an export or publishing
9259 command. The prefix arg is passed through to the exporter. A double prefix
9260 @kbd{C-u C-u} causes most commands to be executed in the background, in a
9261 separate Emacs process@footnote{To make this behavior the default, customize
9262 the variable @code{org-export-run-in-background}.}.
9265 Like @kbd{C-c C-e}, but only export the text that is currently visible
9266 (i.e. not hidden by outline visibility).
9267 @kindex C-u C-u C-c C-e
9268 @item C-u C-u C-c C-e
9269 @vindex org-export-run-in-background
9270 Call an the exporter, but reverse the setting of
9271 @code{org-export-run-in-background}, i.e. request background processing if
9272 not set, or force processing in the current Emacs process if set.
9275 @node ASCII/Latin-1/UTF-8 export, HTML export, The export dispatcher, Exporting
9276 @section ASCII/Latin-1/UTF-8 export
9277 @cindex ASCII export
9278 @cindex Latin-1 export
9279 @cindex UTF-8 export
9281 ASCII export produces a simple and very readable version of an Org-mode
9282 file, containing only plain ASCII. Latin-1 and UTF-8 export augment the file
9283 with special characters and symbols available in these encodings.
9285 @cindex region, active
9286 @cindex active region
9287 @cindex transient-mark-mode
9291 @cindex property, EXPORT_FILE_NAME
9292 Export as ASCII file. For an Org file, @file{myfile.org}, the ASCII file
9293 will be @file{myfile.txt}. The file will be overwritten without
9294 warning. If there is an active region@footnote{This requires
9295 @code{transient-mark-mode} be turned on.}, only the region will be
9296 exported. If the selected region is a single tree@footnote{To select the
9297 current subtree, use @kbd{C-c @@}.}, the tree head will
9298 become the document title. If the tree head entry has or inherits an
9299 @code{EXPORT_FILE_NAME} property, that name will be used for the
9303 Export to a temporary buffer, do not create a file.
9306 @item C-c C-e n @ @ @r{and} @ @ C-c C-e N
9307 Like the above commands, but use Latin-1 encoding.
9310 @item C-c C-e u @ @ @r{and} @ @ C-c C-e U
9311 Like the above commands, but use UTF-8 encoding.
9315 @item C-c C-e v a @ @ @r{and} @ @ C-c C-e v n @ @ @r{and} @ @ C-c C-e v u
9316 Export only the visible part of the document.
9319 @cindex headline levels, for exporting
9320 In the exported version, the first 3 outline levels will become
9321 headlines, defining a general document structure. Additional levels
9322 will be exported as itemized lists. If you want that transition to occur
9323 at a different level, specify it with a prefix argument. For example,
9330 creates only top level headlines and does the rest as items. When
9331 headlines are converted to items, the indentation of the text following
9332 the headline is changed to fit nicely under the item. This is done with
9333 the assumption that the first body line indicates the base indentation of
9334 the body text. Any indentation larger than this is adjusted to preserve
9335 the layout relative to the first line. Should there be lines with less
9336 indentation than the first, these are left alone.
9338 @vindex org-export-ascii-links-to-notes
9339 Links will be exported in a footnote-like style, with the descriptive part in
9340 the text and the link in a note before the next heading. See the variable
9341 @code{org-export-ascii-links-to-notes} for details and other options.
9343 @node HTML export, LaTeX and PDF export, ASCII/Latin-1/UTF-8 export, Exporting
9344 @section HTML export
9347 Org-mode contains an HTML (XHTML 1.0 strict) exporter with extensive
9348 HTML formatting, in ways similar to John Gruber's @emph{markdown}
9349 language, but with additional support for tables.
9352 * HTML Export commands:: How to invoke HTML export
9353 * Quoting HTML tags:: Using direct HTML in Org-mode
9354 * Links in HTML export:: How links will be interpreted and formatted
9355 * Tables in HTML export:: How to modify the formatting of tables
9356 * Images in HTML export:: How to insert figures into HTML output
9357 * Text areas in HTML export:: An alternative way to show an example
9358 * CSS support:: Changing the appearance of the output
9359 * JavaScript support:: Info and Folding in a web browser
9362 @node HTML Export commands, Quoting HTML tags, HTML export, HTML export
9363 @subsection HTML export commands
9365 @cindex region, active
9366 @cindex active region
9367 @cindex transient-mark-mode
9371 @cindex property, EXPORT_FILE_NAME
9372 Export as HTML file @file{myfile.html}. For an Org file @file{myfile.org},
9373 the ASCII file will be @file{myfile.html}. The file will be overwritten
9374 without warning. If there is an active region@footnote{This requires
9375 @code{transient-mark-mode} be turned on.}, only the region will be
9376 exported. If the selected region is a single tree@footnote{To select the
9377 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
9378 title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
9379 property, that name will be used for the export.
9382 Export as HTML file and immediately open it with a browser.
9385 Export to a temporary buffer, do not create a file.
9388 Export the active region to a temporary buffer. With a prefix argument, do
9389 not produce the file header and footer, but just the plain HTML section for
9390 the region. This is good for cut-and-paste operations.
9399 Export only the visible part of the document.
9400 @item M-x org-export-region-as-html
9401 Convert the region to HTML under the assumption that it was Org-mode
9402 syntax before. This is a global command that can be invoked in any
9404 @item M-x org-replace-region-by-HTML
9405 Replace the active region (assumed to be in Org-mode syntax) by HTML
9409 @cindex headline levels, for exporting
9410 In the exported version, the first 3 outline levels will become headlines,
9411 defining a general document structure. Additional levels will be exported as
9412 itemized lists. If you want that transition to occur at a different level,
9413 specify it with a numeric prefix argument. For example,
9420 creates two levels of headings and does the rest as items.
9422 @node Quoting HTML tags, Links in HTML export, HTML Export commands, HTML export
9423 @subsection Quoting HTML tags
9425 Plain @samp{<} and @samp{>} are always transformed to @samp{<} and
9426 @samp{>} in HTML export. If you want to include simple HTML tags
9427 which should be interpreted as such, mark them with @samp{@@} as in
9428 @samp{@@<b>bold text@@</b>}. Note that this really works only for
9429 simple tags. For more extensive HTML that should be copied verbatim to
9430 the exported file use either
9433 @cindex #+BEGIN_HTML
9435 #+HTML: Literal HTML code for export
9439 @cindex #+BEGIN_HTML
9443 All lines between these markers are exported literally
9448 @node Links in HTML export, Tables in HTML export, Quoting HTML tags, HTML export
9449 @subsection Links in HTML export
9451 @cindex links, in HTML export
9452 @cindex internal links, in HTML export
9453 @cindex external links, in HTML export
9454 Internal links (@pxref{Internal links}) will continue to work in HTML. This
9455 includes automatic links created by radio targets (@pxref{Radio
9456 targets}). Links to external files will still work if the target file is on
9457 the same @i{relative} path as the published Org file. Links to other
9458 @file{.org} files will be translated into HTML links under the assumption
9459 that an HTML version also exists of the linked file, at the same relative
9460 path. @samp{id:} links can then be used to jump to specific entries across
9461 files. For information related to linking files while publishing them to a
9462 publishing directory see @ref{Publishing links}.
9464 If you want to specify attributes for links, you can do so using a special
9465 @code{#+ATTR_HTML} line to define attributes that will be added to the
9466 @code{<a>} or @code{<img>} tags. Here is an example that sets @code{title}
9467 and @code{style} attributes for a link:
9471 #+ATTR_HTML: title="The Org-mode homepage" style="color:red;"
9472 [[http://orgmode.org]]
9475 @node Tables in HTML export, Images in HTML export, Links in HTML export, HTML export
9477 @cindex tables, in HTML
9478 @vindex org-export-html-table-tag
9480 Org-mode tables are exported to HTML using the table tag defined in
9481 @code{org-export-html-table-tag}. The default setting makes tables without
9482 cell borders and frame. If you would like to change this for individual
9483 tables, place something like the following before the table:
9488 #+CAPTION: This is a table with lines around and between cells
9489 #+ATTR_HTML: border="2" rules="all" frame="all"
9492 @node Images in HTML export, Text areas in HTML export, Tables in HTML export, HTML export
9493 @subsection Images in HTML export
9495 @cindex images, inline in HTML
9496 @cindex inlining images in HTML
9497 @vindex org-export-html-inline-images
9498 HTML export can inline images given as links in the Org file, and
9499 it can make an image the clickable part of a link. By
9500 default@footnote{But see the variable
9501 @code{org-export-html-inline-images}.}, images are inlined if a link does
9502 not have a description. So @samp{[[file:myimg.jpg]]} will be inlined,
9503 while @samp{[[file:myimg.jpg][the image]]} will just produce a link
9504 @samp{the image} that points to the image. If the description part
9505 itself is a @code{file:} link or a @code{http:} URL pointing to an
9506 image, this image will be inlined and activated so that clicking on the
9507 image will activate the link. For example, to include a thumbnail that
9508 will link to a high resolution version of the image, you could use:
9511 [[file:highres.jpg][file:thumb.jpg]]
9514 If you need to add attributes to an inlined image, use a @code{#+ATTR_HTML}.
9515 In the example below we specify the @code{alt} and @code{title} attributes to
9516 support text viewers and accessibility, and align it to the right.
9521 #+CAPTION: A black cat stalking a spider
9522 #+ATTR_HTML: alt="cat/spider image" title="Action!" align="right"
9527 and you could use @code{http} addresses just as well.
9529 @node Text areas in HTML export, CSS support, Images in HTML export, HTML export
9530 @subsection Text areas in HTML export
9532 @cindex text areas, in HTML
9533 An alternative way to publish literal code examples in HTML is to use text
9534 areas, where the example can even be edited before pasting it into an
9535 application. It is triggered by a @code{-t} switch at an @code{example} or
9536 @code{src} block. Using this switch disables any options for syntax and
9537 label highlighting, and line numbering, which may be present. You may also
9538 use @code{-h} and @code{-w} switches to specify the height and width of the
9539 text area, which default to the number of lines in the example, and 80,
9540 respectively. For example
9543 #+BEGIN_EXAMPLE -t -w 40
9544 (defun org-xor (a b)
9551 @node CSS support, JavaScript support, Text areas in HTML export, HTML export
9552 @subsection CSS support
9553 @cindex CSS, for HTML export
9554 @cindex HTML export, CSS
9556 @vindex org-export-html-todo-kwd-class-prefix
9557 @vindex org-export-html-tag-class-prefix
9558 You can also give style information for the exported file. The HTML exporter
9559 assigns the following special CSS classes@footnote{If the classes on TODO
9560 keywords and tags lead to conflicts, use the variables
9561 @code{org-export-html-todo-kwd-class-prefix} and
9562 @code{org-export-html-tag-class-prefix} to make them unique.} to appropriate
9563 parts of the document---your style specifications may change these, in
9564 addition to any of the standard classes like for headlines, tables, etc.
9566 p.author @r{author information, including email}
9567 p.date @r{publishing date}
9568 p.creator @r{creator info, about org-mode version}
9569 .title @r{document title}
9570 .todo @r{TODO keywords, all not-done states}
9571 .done @r{the DONE keywords, all stated the count as done}
9572 .WAITING @r{each TODO keyword also uses a class named after itself}
9573 .timestamp @r{timestamp}
9574 .timestamp-kwd @r{keyword associated with a timestamp, like SCHEDULED}
9575 .timestamp-wrapper @r{span around keyword plus timestamp}
9576 .tag @r{tag in a headline}
9577 ._HOME @r{each tag uses itself as a class, "@@" replaced by "_"}
9578 .target @r{target for links}
9579 .linenr @r{the line number in a code example}
9580 .code-highlighted @r{for highlighting referenced code lines}
9581 div.outline-N @r{div for outline level N (headline plus text))}
9582 div.outline-text-N @r{extra div for text at outline level N}
9583 .section-number-N @r{section number in headlines, different for each level}
9584 div.figure @r{how to format an inlined image}
9585 pre.src @r{formatted source code}
9586 pre.example @r{normal example}
9587 p.verse @r{verse paragraph}
9588 div.footnotes @r{footnote section headline}
9589 p.footnote @r{footnote definition paragraph, containing a footnote}
9590 .footref @r{a footnote reference number (always a <sup>)}
9591 .footnum @r{footnote number in footnote definition (always <sup>)}
9594 @vindex org-export-html-style-default
9595 @vindex org-export-html-style-include-default
9596 @vindex org-export-html-style
9597 @vindex org-export-html-extra
9598 @vindex org-export-html-style-default
9599 Each exported file contains a compact default style that defines these
9600 classes in a basic way@footnote{This style is defined in the constant
9601 @code{org-export-html-style-default}, which you should not modify. To turn
9602 inclusion of these defaults off, customize
9603 @code{org-export-html-style-include-default}}. You may overwrite these
9604 settings, or add to them by using the variables @code{org-export-html-style}
9605 (for Org-wide settings) and @code{org-export-html-style-extra} (for more
9606 granular settings, like file-local settings). To set the latter variable
9607 individually for each file, you can use
9611 #+STYLE: <link rel="stylesheet" type="text/css" href="stylesheet.css" />
9615 For longer style definitions, you can use several such lines. You could also
9616 directly write a @code{<style>} @code{</style>} section in this way, without
9617 referring to an external file.
9619 @c FIXME: More about header and footer styles
9620 @c FIXME: Talk about links and targets.
9622 @node JavaScript support, , CSS support, HTML export
9623 @subsection JavaScript supported display of web pages
9625 @cindex Rose, Sebastian
9626 Sebastian Rose has written a JavaScript program especially designed to
9627 enhance the web viewing experience of HTML files created with Org. This
9628 program allows you to view large files in two different ways. The first one
9629 is an @emph{Info}-like mode where each section is displayed separately and
9630 navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
9631 as well, press @kbd{?} for an overview of the available keys). The second
9632 view type is a @emph{folding} view much like Org provides inside Emacs. The
9633 script is available at @url{http://orgmode.org/org-info.js} and you can find
9634 the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
9635 We host the script at our site, but if you use it a lot, you might
9636 not want to be dependent on @url{orgmode.org} and prefer to install a local
9637 copy on your own web server.
9639 To use the script, you need to make sure that the @file{org-jsinfo.el} module
9640 gets loaded. It should be loaded by default, but you can try @kbd{M-x
9641 customize-variable @key{RET} org-modules @key{RET}} to convince yourself that
9642 this is indeed the case. All it then takes to make use of the program is
9643 adding a single line to the Org file:
9645 @cindex #+INFOJS_OPT
9647 #+INFOJS_OPT: view:info toc:nil
9651 If this line is found, the HTML header will automatically contain the code
9652 needed to invoke the script. Using the line above, you can set the following
9656 path: @r{The path to the script. The default is to grab the script from}
9657 @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
9658 @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
9659 view: @r{Initial view when website is first shown. Possible values are:}
9660 info @r{Info-like interface with one section per page.}
9661 overview @r{Folding interface, initially showing only top-level.}
9662 content @r{Folding interface, starting with all headlines visible.}
9663 showall @r{Folding interface, all headlines and text visible.}
9664 sdepth: @r{Maximum headline level that will still become an independent}
9665 @r{section for info and folding modes. The default is taken from}
9666 @r{@code{org-export-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
9667 @r{If this is smaller than in @code{org-export-headline-levels}, each}
9668 @r{info/folding section can still contain child headlines.}
9669 toc: @r{Should the table of content @emph{initially} be visible?}
9670 @r{Even when @code{nil}, you can always get to the "toc" with @kbd{i}.}
9671 tdepth: @r{The depth of the table of contents. The defaults are taken from}
9672 @r{the variables @code{org-export-headline-levels} and @code{org-export-with-toc}.}
9673 ftoc: @r{Does the css of the page specify a fixed position for the "toc"?}
9674 @r{If yes, the toc will never be displayed as a section.}
9675 ltoc: @r{Should there be short contents (children) in each section?}
9676 @r{Make this @code{above} if the section should be above initial text.}
9677 mouse: @r{Headings are highlighted when the mouse is over them. Should be}
9678 @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
9679 buttons: @r{Should view-toggle buttons be everywhere? When @code{nil} (the}
9680 @r{default), only one such button will be present.}
9683 @vindex org-infojs-options
9684 @vindex org-export-html-use-infojs
9685 You can choose default values for these options by customizing the variable
9686 @code{org-infojs-options}. If you always want to apply the script to your
9687 pages, configure the variable @code{org-export-html-use-infojs}.
9689 @node LaTeX and PDF export, DocBook export, HTML export, Exporting
9690 @section La@TeX{} and PDF export
9691 @cindex La@TeX{} export
9693 @cindex Guerry, Bastien
9695 Org-mode contains a La@TeX{} exporter written by Bastien Guerry. With
9696 further processing@footnote{The default LaTeX output is designed for
9697 processing with pdftex or latex. It includes packages that are not
9698 compatible with xetex and possibly luatex. See the variables
9699 @code{org-export-latex-default-packages-alist} and
9700 @code{org-export-latex-packages-alist}.}, this backend is also used to
9701 produce PDF output. Since the La@TeX{} output uses @file{hyperref} to
9702 implement links and cross references, the PDF output file will be fully
9706 * LaTeX/PDF export commands:: Which key invokes which commands
9707 * Header and sectioning:: Setting up the export file structure
9708 * Quoting LaTeX code:: Incorporating literal La@TeX{} code
9709 * Tables in LaTeX export:: Options for exporting tables to La@TeX{}
9710 * Images in LaTeX export:: How to insert figures into La@TeX{} output
9711 * Beamer class export:: Turning the file into a presentation
9714 @node LaTeX/PDF export commands, Header and sectioning, LaTeX and PDF export, LaTeX and PDF export
9715 @subsection La@TeX{} export commands
9717 @cindex region, active
9718 @cindex active region
9719 @cindex transient-mark-mode
9723 @cindex property EXPORT_FILE_NAME
9724 Export as La@TeX{} file @file{myfile.tex}. For an Org file
9725 @file{myfile.org}, the ASCII file will be @file{myfile.tex}. The file will
9726 be overwritten without warning. If there is an active region@footnote{This
9727 requires @code{transient-mark-mode} be turned on.}, only the region will be
9728 exported. If the selected region is a single tree@footnote{To select the
9729 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
9730 title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME}
9731 property, that name will be used for the export.
9734 Export to a temporary buffer, do not create a file.
9739 Export only the visible part of the document.
9740 @item M-x org-export-region-as-latex
9741 Convert the region to La@TeX{} under the assumption that it was Org-mode
9742 syntax before. This is a global command that can be invoked in any
9744 @item M-x org-replace-region-by-latex
9745 Replace the active region (assumed to be in Org-mode syntax) by La@TeX{}
9749 Export as La@TeX{} and then process to PDF.
9752 Export as La@TeX{} and then process to PDF, then open the resulting PDF file.
9755 @cindex headline levels, for exporting
9756 @vindex org-latex-low-levels
9757 In the exported version, the first 3 outline levels will become
9758 headlines, defining a general document structure. Additional levels
9759 will be exported as description lists. The exporter can ignore them or
9760 convert them to a custom string depending on
9761 @code{org-latex-low-levels}.
9763 If you want that transition to occur at a different level, specify it
9764 with a numeric prefix argument. For example,
9771 creates two levels of headings and does the rest as items.
9773 @node Header and sectioning, Quoting LaTeX code, LaTeX/PDF export commands, LaTeX and PDF export
9774 @subsection Header and sectioning structure
9775 @cindex La@TeX{} class
9776 @cindex La@TeX{} sectioning structure
9777 @cindex La@TeX{} header
9778 @cindex header, for LaTeX files
9779 @cindex sectioning structure, for LaTeX export
9781 By default, the La@TeX{} output uses the class @code{article}.
9783 @vindex org-export-latex-default-class
9784 @vindex org-export-latex-classes
9785 @vindex org-export-latex-default-packages-alist
9786 @vindex org-export-latex-packages-alist
9787 @cindex #+LATEX_HEADER
9788 @cindex #+LATEX_CLASS
9789 @cindex #+LATEX_CLASS_OPTIONS
9790 @cindex property, LATEX_CLASS
9791 @cindex property, LATEX_CLASS_OPTIONS
9792 You can change this globally by setting a different value for
9793 @code{org-export-latex-default-class} or locally by adding an option like
9794 @code{#+LaTeX_CLASS: myclass} in your file, or with a @code{:LaTeX_CLASS:}
9795 property that applies when exporting a region containing only this (sub)tree.
9796 The class must be listed in @code{org-export-latex-classes}. This variable
9797 defines a header template for each class@footnote{Into which the values of
9798 @code{org-export-latex-default-packages-alist} and
9799 @code{org-export-latex-packages-alist} are spliced.}, and allows you to
9800 define the sectioning structure for each class. You can also define your own
9801 classes there. @code{#+LaTeX_CLASS_OPTIONS} or a @code{LaTeX_CLASS_OPTIONS}
9802 property can specify the options for the @code{\documentclass} macro. You
9803 can also use @code{#+LATEX_HEADER: \usepackage@{xyz@}} to add lines to the
9804 header. See the docstring of @code{org-export-latex-classes} for more
9807 @node Quoting LaTeX code, Tables in LaTeX export, Header and sectioning, LaTeX and PDF export
9808 @subsection Quoting La@TeX{} code
9810 Embedded La@TeX{} as described in @ref{Embedded LaTeX}, will be correctly
9811 inserted into the La@TeX{} file. This includes simple macros like
9812 @samp{\ref@{LABEL@}} to create a cross reference to a figure. Furthermore,
9813 you can add special code that should only be present in La@TeX{} export with
9814 the following constructs:
9817 @cindex #+BEGIN_LaTeX
9819 #+LaTeX: Literal LaTeX code for export
9823 @cindex #+BEGIN_LaTeX
9827 All lines between these markers are exported literally
9832 @node Tables in LaTeX export, Images in LaTeX export, Quoting LaTeX code, LaTeX and PDF export
9833 @subsection Tables in La@TeX{} export
9834 @cindex tables, in La@TeX{} export
9836 For La@TeX{} export of a table, you can specify a label and a caption
9837 (@pxref{Images and tables}). You can also use the @code{ATTR_LaTeX} line to
9838 request a @code{longtable} environment for the table, so that it may span
9839 several pages, or provide the @code{multicolumn} keyword that will make the
9840 table span the page in a multicolumn environment (@code{table*} environment).
9841 Finally, you can set the alignment string:
9845 @cindex #+ATTR_LaTeX
9847 #+CAPTION: A long table
9849 #+ATTR_LaTeX: longtable align=l|lp@{3cm@}r|l
9855 @node Images in LaTeX export, Beamer class export, Tables in LaTeX export, LaTeX and PDF export
9856 @subsection Images in La@TeX{} export
9857 @cindex images, inline in La@TeX{}
9858 @cindex inlining images in La@TeX{}
9860 Images that are linked to without a description part in the link, like
9861 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
9862 output file resulting from La@TeX{} processing. Org will use an
9863 @code{\includegraphics} macro to insert the image. If you have specified a
9864 caption and/or a label as described in @ref{Images and tables}, the figure
9865 will be wrapped into a @code{figure} environment and thus become a floating
9866 element. You can use an @code{#+ATTR_LaTeX:} line to specify the various
9867 options that can be used in the optional argument of the
9868 @code{\includegraphics} macro. To modify the placement option of the
9869 @code{figure} environment, add something like @samp{placement=[h!]} to the
9872 If you would like to let text flow around the image, add the word @samp{wrap}
9873 to the @code{#+ATTR_LaTeX:} line, which will make the figure occupy the left
9874 half of the page. To fine-tune, the @code{placement} field will be the set
9875 of additional arguments needed by the @code{wrapfigure} environment. Note
9876 that if you change the size of the image, you need to use compatible settings
9877 for @code{\includegraphics} and @code{wrapfigure}.
9881 @cindex #+ATTR_LaTeX
9883 #+CAPTION: The black-body emission of the disk around HR 4049
9884 #+LABEL: fig:SED-HR4049
9885 #+ATTR_LaTeX: width=5cm,angle=90
9886 [[./img/sed-hr4049.pdf]]
9888 #+ATTR_LaTeX: width=0.38\textwidth wrap placement=@{r@}@{0.4\textwidth@}
9892 If you need references to a label created in this way, write
9893 @samp{\ref@{fig:SED-HR4049@}} just like in La@TeX{}.
9895 @node Beamer class export, , Images in LaTeX export, LaTeX and PDF export
9896 @subsection Beamer class export
9898 The LaTeX class @file{beamer} allows production of high quality presentations
9899 using LaTeX and pdf processing. Org-mode has special support for turning an
9900 Org-mode file or tree into a @file{beamer} presentation.
9902 When the LaTeX class for the current buffer (as set with @code{#+LaTeX_CLASS:
9903 beamer}) or subtree (set with a @code{LaTeX_CLASS} property) is
9904 @code{beamer}, a special export mode will turn the file or tree into a beamer
9905 presentation. Any tree with not-too-deep level nesting should in principle be
9906 exportable as a beamer presentation. By default, the top-level entries (or
9907 the first level below the selected subtree heading) will be turned into
9908 frames, and the outline structure below this level will become itemize lists.
9909 You can also configure the variable @code{org-beamer-frame-level} to a
9910 different level - then the hierarchy above frames will produce the sectioning
9911 structure of the presentation.
9913 A template for useful in-buffer settings or properties can be inserted into
9914 the buffer with @kbd{M-x org-insert-beamer-options-template}. Among other
9915 things, this will install a column view format which is very handy for
9916 editing special properties used by beamer.
9918 You can influence the structure of the presentation using the following
9923 The environment that should be used to format this entry. Valid environments
9924 are defined in the constant @code{org-beamer-environments-default}, and you
9925 can define more in @code{org-beamer-environments-extra}. If this property is
9926 set, the entry will also get a @code{:B_environment:} tag to make this
9927 visible. This tag has no semantic meaning, it is only a visual aid.
9928 @item BEAMER_envargs
9929 The beamer-special arguments that should be used for the environment, like
9930 @code{[t]} or @code{[<+->]} of @code{<2-3>}. If the @code{BEAMER_col}
9931 property is also set, something like @code{C[t]} can be added here as well to
9932 set an options argument for the implied @code{columns} environment.
9933 @code{c[t]} will set an option for the implied @code{column} environment.
9935 The width of a column that should start with this entry. If this property is
9936 set, the entry will also get a @code{:BMCOL:} property to make this visible.
9937 Also this tag is only a visual aid. When this is a plain number, it will be
9938 interpreted as a fraction of @code{\textwidth}. Otherwise it will be assumed
9939 that you have specified the units, like @samp{3cm}. The first such property
9940 in a frame will start a @code{columns} environment to surround the columns.
9941 This environment is closed when an entry has a @code{BEAMER_col} property
9942 with value 0 or 1, or automatically at the end of the frame.
9944 Additional commands that should be inserted after the environment has been
9945 opened. For example, when creating a frame, this can be used to specify
9949 Frames will automatically receive a @code{fragile} option if they contain
9950 source code that uses the verbatim environment. Special @file{beamer}
9951 specific code can be inserted using @code{#+BEAMER:} and
9952 @code{#+BEGIN_beamer...#+end_beamer} constructs, similar to other export
9953 backends, but with the difference that @code{#+LaTeX:} stuff will be included
9954 in the presentation as well.
9956 Outline nodes with @code{BEAMER_env} property value @samp{note} or
9957 @samp{noteNH} will be formatted as beamer notes, i,e, they will be wrapped
9958 into @code{\note@{...@}}. The former will include the heading as part of the
9959 note text, the latter will ignore the heading of that node. To simplify note
9960 generation, it is actually enough to mark the note with a @emph{tag} (either
9961 @code{:B_note:} or @code{:B_noteNH:}) instead of creating the
9962 @code{BEAMER_env} property.
9964 You can turn on a special minor mode @code{org-beamer-mode} for editing
9974 In @code{org-beamer-mode}, this key offers fast selection of a beamer
9975 environment or the @code{BEAMER_col} property.
9978 Column view provides a great way to set the environment of a node and other
9979 important parameters. Make sure you are using a COLUMN format that is geared
9980 toward this special purpose. The command @kbd{M-x
9981 org-insert-beamer-options-template} defines such a format.
9983 Here is a simple example Org document that is intended for beamer export.
9986 #+LaTeX_CLASS: beamer
9987 #+TITLE: Example Presentation
9988 #+AUTHOR: Carsten Dominik
9989 #+LaTeX_CLASS_OPTIONS: [presentation]
9990 #+BEAMER_FRAME_LEVEL: 2
9991 #+BEAMER_HEADER_EXTRA: \usetheme@{Madrid@}\usecolortheme@{default@}
9992 #+COLUMNS: %35ITEM %10BEAMER_env(Env) %10BEAMER_envargs(Args) %4BEAMER_col(Col) %8BEAMER_extra(Ex)
9994 * This is the first structural section
9996 ** Frame 1 \\ with a subtitle
9997 *** Thanks to Eric Fraga :BMCOL:B_block:
10000 :BEAMER_envargs: C[t]
10003 for the first viable beamer setup in Org
10004 *** Thanks to everyone else :BMCOL:B_block:
10008 :BEAMER_envargs: <2->
10010 for contributing to the discussion
10011 **** This will be formatted as a beamer note :B_note:
10012 ** Frame 2 \\ where we will not use columns
10013 *** Request :B_block:
10014 Please test this stuff!
10020 For more information, see the documentation on Worg.
10022 @node DocBook export, TaskJuggler export, LaTeX and PDF export, Exporting
10023 @section DocBook export
10024 @cindex DocBook export
10026 @cindex Cui, Baoqiu
10028 Org contains a DocBook exporter written by Baoqiu Cui. Once an Org file is
10029 exported to DocBook format, it can be further processed to produce other
10030 formats, including PDF, HTML, man pages, etc., using many available DocBook
10031 tools and stylesheets.
10033 Currently DocBook exporter only supports DocBook V5.0.
10036 * DocBook export commands:: How to invoke DocBook export
10037 * Quoting DocBook code:: Incorporating DocBook code in Org files
10038 * Recursive sections:: Recursive sections in DocBook
10039 * Tables in DocBook export:: Tables are exported as HTML tables
10040 * Images in DocBook export:: How to insert figures into DocBook output
10041 * Special characters:: How to handle special characters
10044 @node DocBook export commands, Quoting DocBook code, DocBook export, DocBook export
10045 @subsection DocBook export commands
10047 @cindex region, active
10048 @cindex active region
10049 @cindex transient-mark-mode
10053 @cindex property EXPORT_FILE_NAME
10054 Export as DocBook file. For an Org file, @file{myfile.org}, the DocBook XML
10055 file will be @file{myfile.xml}. The file will be overwritten without
10056 warning. If there is an active region@footnote{This requires
10057 @code{transient-mark-mode} to be turned on}, only the region will be
10058 exported. If the selected region is a single tree@footnote{To select the
10059 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
10060 title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
10061 property, that name will be used for the export.
10064 Export as DocBook file, process to PDF, then open the resulting PDF file.
10066 @vindex org-export-docbook-xslt-proc-command
10067 @vindex org-export-docbook-xsl-fo-proc-command
10068 Note that, in order to produce PDF output based on exported DocBook file, you
10069 need to have XSLT processor and XSL-FO processor software installed on your
10070 system. Check variables @code{org-export-docbook-xslt-proc-command} and
10071 @code{org-export-docbook-xsl-fo-proc-command}.
10073 @vindex org-export-docbook-xslt-stylesheet
10074 The stylesheet argument @code{%s} in variable
10075 @code{org-export-docbook-xslt-proc-command} is replaced by the value of
10076 variable @code{org-export-docbook-xslt-stylesheet}, which needs to be set by
10077 the user. You can also overrule this global setting on a per-file basis by
10078 adding an in-buffer setting @code{#+XSLT:} to the Org file.
10080 @kindex C-c C-e v D
10082 Export only the visible part of the document.
10085 @node Quoting DocBook code, Recursive sections, DocBook export commands, DocBook export
10086 @subsection Quoting DocBook code
10088 You can quote DocBook code in Org files and copy it verbatim into exported
10089 DocBook file with the following constructs:
10092 @cindex #+BEGIN_DOCBOOK
10094 #+DOCBOOK: Literal DocBook code for export
10098 @cindex #+BEGIN_DOCBOOK
10102 All lines between these markers are exported by DocBook exporter
10107 For example, you can use the following lines to include a DocBook warning
10108 admonition. As to what this warning says, you should pay attention to the
10109 document context when quoting DocBook code in Org files. You may make
10110 exported DocBook XML files invalid by not quoting DocBook code correctly.
10115 <para>You should know what you are doing when quoting DocBook XML code
10116 in your Org file. Invalid DocBook XML file may be generated by
10117 DocBook exporter if you are not careful!</para>
10122 @node Recursive sections, Tables in DocBook export, Quoting DocBook code, DocBook export
10123 @subsection Recursive sections
10124 @cindex DocBook recursive sections
10126 DocBook exporter exports Org files as articles using the @code{article}
10127 element in DocBook. Recursive sections, i.e. @code{section} elements, are
10128 used in exported articles. Top level headlines in Org files are exported as
10129 top level sections, and lower level headlines are exported as nested
10130 sections. The entire structure of Org files will be exported completely, no
10131 matter how many nested levels of headlines there are.
10133 Using recursive sections makes it easy to port and reuse exported DocBook
10134 code in other DocBook document types like @code{book} or @code{set}.
10136 @node Tables in DocBook export, Images in DocBook export, Recursive sections, DocBook export
10137 @subsection Tables in DocBook export
10138 @cindex tables, in DocBook export
10140 Tables in Org files are exported as HTML tables, which have been supported since
10143 If a table does not have a caption, an informal table is generated using the
10144 @code{informaltable} element; otherwise, a formal table will be generated
10145 using the @code{table} element.
10147 @node Images in DocBook export, Special characters, Tables in DocBook export, DocBook export
10148 @subsection Images in DocBook export
10149 @cindex images, inline in DocBook
10150 @cindex inlining images in DocBook
10152 Images that are linked to without a description part in the link, like
10153 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]}, will be exported to DocBook
10154 using @code{mediaobject} elements. Each @code{mediaobject} element contains
10155 an @code{imageobject} that wraps an @code{imagedata} element. If you have
10156 specified a caption for an image as described in @ref{Images and tables}, a
10157 @code{caption} element will be added in @code{mediaobject}. If a label is
10158 also specified, it will be exported as an @code{xml:id} attribute of the
10159 @code{mediaobject} element.
10161 @vindex org-export-docbook-default-image-attributes
10162 Image attributes supported by the @code{imagedata} element, like @code{align}
10163 or @code{width}, can be specified in two ways: you can either customize
10164 variable @code{org-export-docbook-default-image-attributes} or use the
10165 @code{#+ATTR_DOCBOOK:} line. Attributes specified in variable
10166 @code{org-export-docbook-default-image-attributes} are applied to all inline
10167 images in the Org file to be exported (unless they are overridden by image
10168 attributes specified in @code{#+ATTR_DOCBOOK:} lines).
10170 The @code{#+ATTR_DOCBOOK:} line can be used to specify additional image
10171 attributes or override default image attributes for individual images. If
10172 the same attribute appears in both the @code{#+ATTR_DOCBOOK:} line and
10173 variable @code{org-export-docbook-default-image-attributes}, the former
10174 takes precedence. Here is an example about how image attributes can be
10179 @cindex #+ATTR_DOCBOOK
10181 #+CAPTION: The logo of Org-mode
10182 #+LABEL: unicorn-svg
10183 #+ATTR_DOCBOOK: scalefit="1" width="100%" depth="100%"
10184 [[./img/org-mode-unicorn.svg]]
10187 @vindex org-export-docbook-inline-image-extensions
10188 By default, DocBook exporter recognizes the following image file types:
10189 @file{jpeg}, @file{jpg}, @file{png}, @file{gif}, and @file{svg}. You can
10190 customize variable @code{org-export-docbook-inline-image-extensions} to add
10191 more types to this list as long as DocBook supports them.
10193 @node Special characters, , Images in DocBook export, DocBook export
10194 @subsection Special characters in DocBook export
10195 @cindex Special characters in DocBook export
10197 @vindex org-export-docbook-doctype
10198 @vindex org-entities
10199 Special characters that are written in @TeX{}-like syntax, such as @code{\alpha},
10200 @code{\Gamma}, and @code{\Zeta}, are supported by DocBook exporter. These
10201 characters are rewritten to XML entities, like @code{α},
10202 @code{Γ}, and @code{Ζ}, based on the list saved in variable
10203 @code{org-entities}. As long as the generated DocBook file includes the
10204 corresponding entities, these special characters are recognized.
10206 You can customize variable @code{org-export-docbook-doctype} to include the
10207 entities you need. For example, you can set variable
10208 @code{org-export-docbook-doctype} to the following value to recognize all
10209 special characters included in XHTML entities:
10212 "<!DOCTYPE article [
10213 <!ENTITY % xhtml1-symbol PUBLIC
10214 \"-//W3C//ENTITIES Symbol for HTML//EN//XML\"
10215 \"http://www.w3.org/2003/entities/2007/xhtml1-symbol.ent\"
10222 @node TaskJuggler export, Freemind export, DocBook export, Exporting
10223 @section TaskJuggler export
10224 @cindex TaskJuggler export
10225 @cindex Project management
10227 @uref{http://www.taskjuggler.org/, TaskJuggler} is a project management tool.
10228 It provides an optimizing scheduler that computes your project time lines and
10229 resource assignments based on the project outline and the constraints that
10232 The TaskJuggler exporter is a bit different from other exporters, such as the
10233 HTML and LaTeX exporters for example, in that it does not export all the
10234 nodes of a document or strictly follow the order of the nodes in the
10237 Instead the TaskJuggler exporter looks for a tree that defines the tasks and
10238 a optionally tree that defines the resources for this project. It then
10239 creates a TaskJuggler file based on these trees and the attributes defined in
10242 @subsection TaskJuggler export commands
10247 Export as TaskJuggler file.
10251 Export as TaskJuggler file and then open the file with TaskJugglerUI.
10256 @vindex org-export-taskjuggler-project-tag
10257 Create your tasks as you usually do with Org-mode. Assign efforts to each
10258 task using properties (it's easiest to do this in the column view). You
10259 should end up with something similar to the example by Peter Jones in
10260 @url{http://www.contextualdevelopment.com/static/artifacts/articles/2008/project-planning/project-planning.org}.
10261 Now mark the top node of your tasks with a tag named
10262 @code{:taskjuggler_project:} (or whatever you customized
10263 @code{org-export-taskjuggler-project-tag} to). You are now ready to export
10264 the project plan with @kbd{C-c C-e J} which will export the project plan and
10265 open a gantt chart in TaskJugglerUI.
10267 @subsection Resources
10269 @vindex org-export-taskjuggler-resource-tag
10270 Next you can define resources and assign those to work on specific tasks. You
10271 can group your resources hierarchically. Tag the top node of the resources
10272 with @code{:taskjuggler_resource:} (or whatever you customized
10273 @code{org-export-taskjuggler-resource-tag} to). You can optionally assign an
10274 identifier (named @samp{resource_id}) to the resources (using the standard
10275 Org properties commands, @pxref{Property syntax}) or you can let the exporter
10276 generate identifiers automatically (the exporter picks the first word of the
10277 headline as the identifier as long as it is unique, see the documentation of
10278 @code{org-taskjuggler-get-unique-id}). Using that identifier you can then
10279 allocate resources to tasks. This is again done with the @samp{allocate}
10280 property on the tasks. Do this in column view or when on the task type
10281 @kbd{C-c C-x p allocate @key{RET} <resource_id> @key{RET}}.
10283 Once the allocations are done you can again export to TaskJuggler and check
10284 in the Resource Allocation Graph which person is working on what task at what
10287 @subsection Export of properties
10289 The exporter also takes TODO state information into consideration, i.e. if a
10290 task is marked as done it will have the corresponding attribute in
10291 TaskJuggler (@samp{complete 100}). Also it will export any property on a task
10292 resource or resource node which is known to TaskJuggler, such as
10293 @samp{limits}, @samp{vacation}, @samp{shift}, @samp{booking},
10294 @samp{efficiency}, @samp{journalentry}, @samp{rate} for resources or
10295 @samp{account}, @samp{start}, @samp{note}, @samp{duration}, @samp{end},
10296 @samp{journalentry}, @samp{milestone}, @samp{reference}, @samp{responsible},
10297 @samp{scheduling}, etc for tasks.
10299 @subsection Dependencies
10301 The exporter will handle dependencies that are defined in the tasks either
10302 with the @samp{ORDERED} attribute (@pxref{TODO dependencies}), with the
10303 @samp{BLOCKER} attribute (see org-depend.el) or alternatively with a
10304 @samp{depends} attribute. Both the @samp{BLOCKER} and the @samp{depends}
10305 attribute can be either @samp{previous-sibling} or a reference to an
10306 identifier (named @samp{task_id}) which is defined for another task in the
10307 project. @samp{BLOCKER} and the @samp{depends} attribute can define multiple
10308 dependencies separated by either space or comma. You can also specify
10309 optional attributes on the dependency by simply appending it. The following
10310 examples should illustrate this:
10315 :task_id: preparation
10318 * Training material
10320 :task_id: training_material
10323 ** Markup Guidelines
10327 ** Workflow Guidelines
10334 :BLOCKER: training_material @{ gapduration 1d @} preparation
10338 @subsection Reports
10340 @vindex org-export-taskjuggler-default-reports
10341 TaskJuggler can produce many kinds of reports (e.g. gantt chart, resource
10342 allocation, etc). The user defines what kind of reports should be generated
10343 for a project in the TaskJuggler file. The exporter will automatically insert
10344 some default reports in the file. These defaults are defined in
10345 @code{org-export-taskjuggler-default-reports}. They can be modified using
10346 customize along with a number of other options. For a more complete list, see
10347 @kbd{M-x customize-group @key{RET} org-export-taskjuggler @key{RET}}.
10349 For more information and examples see the Org-taskjuggler tutorial at
10350 @uref{http://orgmode.org/worg/org-tutorials/org-taskjuggler.php}.
10352 @node Freemind export, XOXO export, TaskJuggler export, Exporting
10353 @section Freemind export
10354 @cindex Freemind export
10357 The Freemind exporter was written by Lennart Borgman.
10362 Export as Freemind mind map @file{myfile.mm}.
10365 @node XOXO export, iCalendar export, Freemind export, Exporting
10366 @section XOXO export
10367 @cindex XOXO export
10369 Org-mode contains an exporter that produces XOXO-style output.
10370 Currently, this exporter only handles the general outline structure and
10371 does not interpret any additional Org-mode features.
10376 Export as XOXO file @file{myfile.html}.
10379 Export only the visible part of the document.
10382 @node iCalendar export, , XOXO export, Exporting
10383 @section iCalendar export
10384 @cindex iCalendar export
10386 @vindex org-icalendar-include-todo
10387 @vindex org-icalendar-use-deadline
10388 @vindex org-icalendar-use-scheduled
10389 @vindex org-icalendar-categories
10390 @vindex org-icalendar-alarm-time
10391 Some people use Org-mode for keeping track of projects, but still prefer a
10392 standard calendar application for anniversaries and appointments. In this
10393 case it can be useful to show deadlines and other time-stamped items in Org
10394 files in the calendar application. Org-mode can export calendar information
10395 in the standard iCalendar format. If you also want to have TODO entries
10396 included in the export, configure the variable
10397 @code{org-icalendar-include-todo}. Plain timestamps are exported as VEVENT,
10398 and TODO items as VTODO. It will also create events from deadlines that are
10399 in non-TODO items. Deadlines and scheduling dates in TODO items will be used
10400 to set the start and due dates for the TODO entry@footnote{See the variables
10401 @code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}.
10402 As categories, it will use the tags locally defined in the heading, and the
10403 file/tree category@footnote{To add inherited tags or the TODO state,
10404 configure the variable @code{org-icalendar-categories}.}. See the variable
10405 @code{org-icalendar-alarm-time} for a way to assign alarms to entries with a
10408 @vindex org-icalendar-store-UID
10409 @cindex property, ID
10410 The iCalendar standard requires each entry to have a globally unique
10411 identifier (UID). Org creates these identifiers during export. If you set
10412 the variable @code{org-icalendar-store-UID}, the UID will be stored in the
10413 @code{:ID:} property of the entry and re-used next time you report this
10414 entry. Since a single entry can give rise to multiple iCalendar entries (as
10415 a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
10416 prefixes to the UID, depending on what triggered the inclusion of the entry.
10417 In this way the UID remains unique, but a synchronization program can still
10418 figure out from which entry all the different instances originate.
10423 Create iCalendar entries for the current file and store them in the same
10424 directory, using a file extension @file{.ics}.
10427 @vindex org-agenda-files
10428 Like @kbd{C-c C-e i}, but do this for all files in
10429 @code{org-agenda-files}. For each of these files, a separate iCalendar
10430 file will be written.
10433 @vindex org-combined-agenda-icalendar-file
10434 Create a single large iCalendar file from all files in
10435 @code{org-agenda-files} and write it to the file given by
10436 @code{org-combined-agenda-icalendar-file}.
10439 @vindex org-use-property-inheritance
10440 @vindex org-icalendar-include-body
10441 @cindex property, SUMMARY
10442 @cindex property, DESCRIPTION
10443 @cindex property, LOCATION
10444 The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION
10445 property can be inherited from higher in the hierarchy if you configure
10446 @code{org-use-property-inheritance} accordingly.} properties if the selected
10447 entries have them. If not, the summary will be derived from the headline,
10448 and the description from the body (limited to
10449 @code{org-icalendar-include-body} characters).
10451 How this calendar is best read and updated, depends on the application
10452 you are using. The FAQ covers this issue.
10454 @node Publishing, Working With Source Code, Exporting, Top
10455 @chapter Publishing
10458 Org includes a publishing management system that allows you to configure
10459 automatic HTML conversion of @emph{projects} composed of interlinked org
10460 files. You can also configure Org to automatically upload your exported HTML
10461 pages and related attachments, such as images and source code files, to a web
10464 You can also use Org to convert files into PDF, or even combine HTML and PDF
10465 conversion so that files are available in both formats on the server.
10467 Publishing has been contributed to Org by David O'Toole.
10470 * Configuration:: Defining projects
10471 * Uploading files:: How to get files up on the server
10472 * Sample configuration:: Example projects
10473 * Triggering publication:: Publication commands
10476 @node Configuration, Uploading files, Publishing, Publishing
10477 @section Configuration
10479 Publishing needs significant configuration to specify files, destination
10480 and many other properties of a project.
10483 * Project alist:: The central configuration variable
10484 * Sources and destinations:: From here to there
10485 * Selecting files:: What files are part of the project?
10486 * Publishing action:: Setting the function doing the publishing
10487 * Publishing options:: Tweaking HTML export
10488 * Publishing links:: Which links keep working after publishing?
10489 * Sitemap:: Generating a list of all pages
10490 * Generating an index:: An index that reaches across pages
10493 @node Project alist, Sources and destinations, Configuration, Configuration
10494 @subsection The variable @code{org-publish-project-alist}
10495 @cindex org-publish-project-alist
10496 @cindex projects, for publishing
10498 @vindex org-publish-project-alist
10499 Publishing is configured almost entirely through setting the value of one
10500 variable, called @code{org-publish-project-alist}. Each element of the list
10501 configures one project, and may be in one of the two following forms:
10504 ("project-name" :property value :property value ...)
10506 ("project-name" :components ("project-name" "project-name" ...))
10510 In both cases, projects are configured by specifying property values. A
10511 project defines the set of files that will be published, as well as the
10512 publishing configuration to use when publishing those files. When a project
10513 takes the second form listed above, the individual members of the
10514 @code{:components} property are taken to be sub-projects, which group
10515 together files requiring different publishing options. When you publish such
10516 a ``meta-project'', all the components will also be published, in the
10519 @node Sources and destinations, Selecting files, Project alist, Configuration
10520 @subsection Sources and destinations for files
10521 @cindex directories, for publishing
10523 Most properties are optional, but some should always be set. In
10524 particular, Org needs to know where to look for source files,
10525 and where to put published files.
10527 @multitable @columnfractions 0.3 0.7
10528 @item @code{:base-directory}
10529 @tab Directory containing publishing source files
10530 @item @code{:publishing-directory}
10531 @tab Directory where output files will be published. You can directly
10532 publish to a webserver using a file name syntax appropriate for
10533 the Emacs @file{tramp} package. Or you can publish to a local directory and
10534 use external tools to upload your website (@pxref{Uploading files}).
10535 @item @code{:preparation-function}
10536 @tab Function or list of functions to be called before starting the
10537 publishing process, for example, to run @code{make} for updating files to be
10538 published. The project property list is scoped into this call as the
10539 variable @code{project-plist}.
10540 @item @code{:completion-function}
10541 @tab Function or list of functions called after finishing the publishing
10542 process, for example, to change permissions of the resulting files. The
10543 project property list is scoped into this call as the variable
10544 @code{project-plist}.
10548 @node Selecting files, Publishing action, Sources and destinations, Configuration
10549 @subsection Selecting files
10550 @cindex files, selecting for publishing
10552 By default, all files with extension @file{.org} in the base directory
10553 are considered part of the project. This can be modified by setting the
10555 @multitable @columnfractions 0.25 0.75
10556 @item @code{:base-extension}
10557 @tab Extension (without the dot!) of source files. This actually is a
10558 regular expression. Set this to the symbol @code{any} if you want to get all
10559 files in @code{:base-directory}, even without extension.
10561 @item @code{:exclude}
10562 @tab Regular expression to match file names that should not be
10563 published, even though they have been selected on the basis of their
10566 @item @code{:include}
10567 @tab List of files to be included regardless of @code{:base-extension}
10568 and @code{:exclude}.
10571 @node Publishing action, Publishing options, Selecting files, Configuration
10572 @subsection Publishing action
10573 @cindex action, for publishing
10575 Publishing means that a file is copied to the destination directory and
10576 possibly transformed in the process. The default transformation is to export
10577 Org files as HTML files, and this is done by the function
10578 @code{org-publish-org-to-html} which calls the HTML exporter (@pxref{HTML
10579 export}). But you also can publish your content as PDF files using
10580 @code{org-publish-org-to-pdf}. If you want to publish the Org file itself,
10581 but with @i{archived}, @i{commented}, and @i{tag-excluded} trees removed, use
10582 @code{org-publish-org-to-org} and set the parameters @code{:plain-source}
10583 and/or @code{:htmlized-source}. This will produce @file{file.org} and
10584 @file{file.org.html} in the publishing
10585 directory@footnote{@file{file-source.org} and @file{file-source.org.html} if
10586 source and publishing directories are equal. Note that with this kind of
10587 setup, you need to add @code{:exclude "-source\\.org"} to the project
10588 definition in @code{org-publish-project-alist} to avoid that the published
10589 source files will be considered as new org files the next time the project is
10590 published.}. Other files like images only
10591 need to be copied to the publishing destination, for this you may use
10592 @code{org-publish-attachment}. For non-Org files, you always need to
10593 specify the publishing function:
10595 @multitable @columnfractions 0.3 0.7
10596 @item @code{:publishing-function}
10597 @tab Function executing the publication of a file. This may also be a
10598 list of functions, which will all be called in turn.
10599 @item @code{:plain-source}
10600 @tab Non-nil means, publish plain source.
10601 @item @code{:htmlized-source}
10602 @tab Non-nil means, publish htmlized source.
10605 The function must accept three arguments: a property list containing at least
10606 a @code{:publishing-directory} property, the name of the file to be
10607 published, and the path to the publishing directory of the output file. It
10608 should take the specified file, make the necessary transformation (if any)
10609 and place the result into the destination folder.
10611 @node Publishing options, Publishing links, Publishing action, Configuration
10612 @subsection Options for the HTML/La@TeX{} exporters
10613 @cindex options, for publishing
10615 The property list can be used to set many export options for the HTML
10616 and La@TeX{} exporters. In most cases, these properties correspond to user
10617 variables in Org. The table below lists these properties along
10618 with the variable they belong to. See the documentation string for the
10619 respective variable for details.
10621 @vindex org-export-html-link-up
10622 @vindex org-export-html-link-home
10623 @vindex org-export-default-language
10624 @vindex org-display-custom-times
10625 @vindex org-export-headline-levels
10626 @vindex org-export-with-section-numbers
10627 @vindex org-export-section-number-format
10628 @vindex org-export-with-toc
10629 @vindex org-export-preserve-breaks
10630 @vindex org-export-with-archived-trees
10631 @vindex org-export-with-emphasize
10632 @vindex org-export-with-sub-superscripts
10633 @vindex org-export-with-special-strings
10634 @vindex org-export-with-footnotes
10635 @vindex org-export-with-drawers
10636 @vindex org-export-with-tags
10637 @vindex org-export-with-todo-keywords
10638 @vindex org-export-with-priority
10639 @vindex org-export-with-TeX-macros
10640 @vindex org-export-with-LaTeX-fragments
10641 @vindex org-export-skip-text-before-1st-heading
10642 @vindex org-export-with-fixed-width
10643 @vindex org-export-with-timestamps
10644 @vindex org-export-author-info
10645 @vindex org-export-email
10646 @vindex org-export-creator-info
10647 @vindex org-export-with-tables
10648 @vindex org-export-highlight-first-table-line
10649 @vindex org-export-html-style-include-default
10650 @vindex org-export-html-style
10651 @vindex org-export-html-style-extra
10652 @vindex org-export-html-link-org-files-as-html
10653 @vindex org-export-html-inline-images
10654 @vindex org-export-html-extension
10655 @vindex org-export-html-table-tag
10656 @vindex org-export-html-expand
10657 @vindex org-export-html-with-timestamp
10658 @vindex org-export-publishing-directory
10659 @vindex org-export-html-preamble
10660 @vindex org-export-html-postamble
10661 @vindex org-export-html-auto-preamble
10662 @vindex org-export-html-auto-postamble
10663 @vindex user-full-name
10664 @vindex user-mail-address
10665 @vindex org-export-select-tags
10666 @vindex org-export-exclude-tags
10668 @multitable @columnfractions 0.32 0.68
10669 @item @code{:link-up} @tab @code{org-export-html-link-up}
10670 @item @code{:link-home} @tab @code{org-export-html-link-home}
10671 @item @code{:language} @tab @code{org-export-default-language}
10672 @item @code{:customtime} @tab @code{org-display-custom-times}
10673 @item @code{:headline-levels} @tab @code{org-export-headline-levels}
10674 @item @code{:section-numbers} @tab @code{org-export-with-section-numbers}
10675 @item @code{:section-number-format} @tab @code{org-export-section-number-format}
10676 @item @code{:table-of-contents} @tab @code{org-export-with-toc}
10677 @item @code{:preserve-breaks} @tab @code{org-export-preserve-breaks}
10678 @item @code{:archived-trees} @tab @code{org-export-with-archived-trees}
10679 @item @code{:emphasize} @tab @code{org-export-with-emphasize}
10680 @item @code{:sub-superscript} @tab @code{org-export-with-sub-superscripts}
10681 @item @code{:special-strings} @tab @code{org-export-with-special-strings}
10682 @item @code{:footnotes} @tab @code{org-export-with-footnotes}
10683 @item @code{:drawers} @tab @code{org-export-with-drawers}
10684 @item @code{:tags} @tab @code{org-export-with-tags}
10685 @item @code{:todo-keywords} @tab @code{org-export-with-todo-keywords}
10686 @item @code{:priority} @tab @code{org-export-with-priority}
10687 @item @code{:TeX-macros} @tab @code{org-export-with-TeX-macros}
10688 @item @code{:LaTeX-fragments} @tab @code{org-export-with-LaTeX-fragments}
10689 @item @code{:latex-listings} @tab @code{org-export-latex-listings}
10690 @item @code{:skip-before-1st-heading} @tab @code{org-export-skip-text-before-1st-heading}
10691 @item @code{:fixed-width} @tab @code{org-export-with-fixed-width}
10692 @item @code{:timestamps} @tab @code{org-export-with-timestamps}
10693 @item @code{:author-info} @tab @code{org-export-author-info}
10694 @item @code{:email-info} @tab @code{org-export-email-info}
10695 @item @code{:creator-info} @tab @code{org-export-creator-info}
10696 @item @code{:tables} @tab @code{org-export-with-tables}
10697 @item @code{:table-auto-headline} @tab @code{org-export-highlight-first-table-line}
10698 @item @code{:style-include-default} @tab @code{org-export-html-style-include-default}
10699 @item @code{:style} @tab @code{org-export-html-style}
10700 @item @code{:style-extra} @tab @code{org-export-html-style-extra}
10701 @item @code{:convert-org-links} @tab @code{org-export-html-link-org-files-as-html}
10702 @item @code{:inline-images} @tab @code{org-export-html-inline-images}
10703 @item @code{:html-extension} @tab @code{org-export-html-extension}
10704 @item @code{:xml-declaration} @tab @code{org-export-html-xml-declaration}
10705 @item @code{:html-table-tag} @tab @code{org-export-html-table-tag}
10706 @item @code{:expand-quoted-html} @tab @code{org-export-html-expand}
10707 @item @code{:timestamp} @tab @code{org-export-html-with-timestamp}
10708 @item @code{:publishing-directory} @tab @code{org-export-publishing-directory}
10709 @item @code{:preamble} @tab @code{org-export-html-preamble}
10710 @item @code{:postamble} @tab @code{org-export-html-postamble}
10711 @item @code{:auto-preamble} @tab @code{org-export-html-auto-preamble}
10712 @item @code{:auto-postamble} @tab @code{org-export-html-auto-postamble}
10713 @item @code{:author} @tab @code{user-full-name}
10714 @item @code{:email} @tab @code{user-mail-address} : @code{addr;addr;..}
10715 @item @code{:select-tags} @tab @code{org-export-select-tags}
10716 @item @code{:exclude-tags} @tab @code{org-export-exclude-tags}
10717 @item @code{:latex-image-options} @tab @code{org-export-latex-image-default-option}
10720 Most of the @code{org-export-with-*} variables have the same effect in
10721 both HTML and La@TeX{} exporters, except for @code{:TeX-macros} and
10722 @code{:LaTeX-fragments}, respectively @code{nil} and @code{t} in the
10725 @vindex org-publish-project-alist
10726 When a property is given a value in @code{org-publish-project-alist},
10727 its setting overrides the value of the corresponding user variable (if
10728 any) during publishing. Options set within a file (@pxref{Export
10729 options}), however, override everything.
10731 @node Publishing links, Sitemap, Publishing options, Configuration
10732 @subsection Links between published files
10733 @cindex links, publishing
10735 To create a link from one Org file to another, you would use
10736 something like @samp{[[file:foo.org][The foo]]} or simply
10737 @samp{file:foo.org.} (@pxref{Hyperlinks}). When published, this link
10738 becomes a link to @file{foo.html}. In this way, you can interlink the
10739 pages of your "org web" project and the links will work as expected when
10740 you publish them to HTML. If you also publish the Org source file and want
10741 to link to that, use an @code{http:} link instead of a @code{file:} link,
10742 because @code{file:} links are converted to link to the corresponding
10745 You may also link to related files, such as images. Provided you are careful
10746 with relative file names, and provided you have also configured Org to upload
10747 the related files, these links will work too. See @ref{Complex example}, for
10748 an example of this usage.
10750 Sometimes an Org file to be published may contain links that are
10751 only valid in your production environment, but not in the publishing
10752 location. In this case, use the property
10754 @multitable @columnfractions 0.4 0.6
10755 @item @code{:link-validation-function}
10756 @tab Function to validate links
10760 to define a function for checking link validity. This function must
10761 accept two arguments, the file name and a directory relative to which
10762 the file name is interpreted in the production environment. If this
10763 function returns @code{nil}, then the HTML generator will only insert a
10764 description into the HTML file, but no link. One option for this
10765 function is @code{org-publish-validate-link} which checks if the given
10766 file is part of any project in @code{org-publish-project-alist}.
10768 @node Sitemap, Generating an index, Publishing links, Configuration
10769 @subsection Generating a sitemap
10770 @cindex sitemap, of published pages
10772 The following properties may be used to control publishing of
10773 a map of files for a given project.
10775 @multitable @columnfractions 0.35 0.65
10776 @item @code{:auto-sitemap}
10777 @tab When non-nil, publish a sitemap during @code{org-publish-current-project}
10778 or @code{org-publish-all}.
10780 @item @code{:sitemap-filename}
10781 @tab Filename for output of sitemap. Defaults to @file{sitemap.org} (which
10782 becomes @file{sitemap.html}).
10784 @item @code{:sitemap-title}
10785 @tab Title of sitemap page. Defaults to name of file.
10787 @item @code{:sitemap-function}
10788 @tab Plug-in function to use for generation of the sitemap.
10789 Defaults to @code{org-publish-org-sitemap}, which generates a plain list
10790 of links to all files in the project.
10792 @item @code{:sitemap-sort-folders}
10793 @tab Where folders should appear in the sitemap. Set this to @code{first}
10794 (default) or @code{last} to display folders first or last,
10795 respectively. Any other value will mix files and folders.
10797 @item @code{:sitemap-alphabetically}
10798 @tab The site map is normally sorted alphabetically. Set this explicitly to
10799 @code{nil} to turn off sorting.
10801 @item @code{:sitemap-ignore-case}
10802 @tab Should sorting be case-sensitive? Default @code{nil}.
10806 @node Generating an index, , Sitemap, Configuration
10807 @subsection Generating an index
10808 @cindex index, in a publishing project
10810 Org-mode can generate an index across the files of a publishing project.
10812 @multitable @columnfractions 0.25 0.75
10813 @item @code{:makeindex}
10814 @tab When non-nil, generate in index in the file @file{theindex.org} and
10815 publish it as @file{theindex.html}.
10818 The file will be create when first publishing a project with the
10819 @code{:makeindex} set. The file only contains a statement @code{#+include:
10820 "theindex.inc"}. You can then built around this include statement by adding
10821 a title, style information etc.
10823 @node Uploading files, Sample configuration, Configuration, Publishing
10824 @section Uploading files
10828 For those people already utilizing third party sync tools such as
10829 @command{rsync} or @command{unison}, it might be preferable not to use the built in
10830 @i{remote} publishing facilities of Org-mode which rely heavily on
10831 Tramp. Tramp, while very useful and powerful, tends not to be
10832 so efficient for multiple file transfer and has been known to cause problems
10835 Specialized synchronization utilities offer several advantages. In addition
10836 to timestamp comparison, they also do content and permissions/attribute
10837 checks. For this reason you might prefer to publish your web to a local
10838 directory (possibly even @i{in place} with your Org files) and then use
10839 @file{unison} or @file{rsync} to do the synchronization with the remote host.
10841 Since Unison (for example) can be configured as to which files to transfer to
10842 a certain remote destination, it can greatly simplify the project publishing
10843 definition. Simply keep all files in the correct location, process your Org
10844 files with @code{org-publish} and let the synchronization tool do the rest.
10845 You do not need, in this scenario, to include attachments such as @file{jpg},
10846 @file{css} or @file{gif} files in the project definition since the 3rd party
10849 Publishing to a local directory is also much faster than to a remote one, so
10850 that you can afford more easily to republish entire projects. If you set
10851 @code{org-publish-use-timestamps-flag} to @code{nil}, you gain the main
10852 benefit of re-including any changed external files such as source example
10853 files you might include with @code{#+INCLUDE}. The timestamp mechanism in
10854 Org is not smart enough to detect if included files have been modified.
10856 @node Sample configuration, Triggering publication, Uploading files, Publishing
10857 @section Sample configuration
10859 Below we provide two example configurations. The first one is a simple
10860 project publishing only a set of Org files. The second example is
10861 more complex, with a multi-component project.
10864 * Simple example:: One-component publishing
10865 * Complex example:: A multi-component publishing example
10868 @node Simple example, Complex example, Sample configuration, Sample configuration
10869 @subsection Example: simple publishing configuration
10871 This example publishes a set of Org files to the @file{public_html}
10872 directory on the local machine.
10875 (setq org-publish-project-alist
10877 :base-directory "~/org/"
10878 :publishing-directory "~/public_html"
10879 :section-numbers nil
10880 :table-of-contents nil
10881 :style "<link rel=\"stylesheet\"
10882 href=\"../other/mystyle.css\"
10883 type=\"text/css\"/>")))
10886 @node Complex example, , Simple example, Sample configuration
10887 @subsection Example: complex publishing configuration
10889 This more complicated example publishes an entire website, including
10890 Org files converted to HTML, image files, Emacs Lisp source code, and
10891 style sheets. The publishing directory is remote and private files are
10894 To ensure that links are preserved, care should be taken to replicate
10895 your directory structure on the web server, and to use relative file
10896 paths. For example, if your Org files are kept in @file{~/org} and your
10897 publishable images in @file{~/images}, you would link to an image with
10900 file:../images/myimage.png
10903 On the web server, the relative path to the image should be the
10904 same. You can accomplish this by setting up an "images" folder in the
10905 right place on the web server, and publishing images to it.
10908 (setq org-publish-project-alist
10910 :base-directory "~/org/"
10911 :base-extension "org"
10912 :publishing-directory "/ssh:user@@host:~/html/notebook/"
10913 :publishing-function org-publish-org-to-html
10914 :exclude "PrivatePage.org" ;; regexp
10916 :section-numbers nil
10917 :table-of-contents nil
10918 :style "<link rel=\"stylesheet\"
10919 href=\"../other/mystyle.css\" type=\"text/css\"/>"
10921 :auto-postamble nil)
10924 :base-directory "~/images/"
10925 :base-extension "jpg\\|gif\\|png"
10926 :publishing-directory "/ssh:user@@host:~/html/images/"
10927 :publishing-function org-publish-attachment)
10930 :base-directory "~/other/"
10931 :base-extension "css\\|el"
10932 :publishing-directory "/ssh:user@@host:~/html/other/"
10933 :publishing-function org-publish-attachment)
10934 ("website" :components ("orgfiles" "images" "other"))))
10937 @node Triggering publication, , Sample configuration, Publishing
10938 @section Triggering publication
10940 Once properly configured, Org can publish with the following commands:
10945 Prompt for a specific project and publish all files that belong to it.
10948 Publish the project containing the current file.
10951 Publish only the current file.
10954 Publish every project.
10957 @vindex org-publish-use-timestamps-flag
10958 Org uses timestamps to track when a file has changed. The above functions
10959 normally only publish changed files. You can override this and force
10960 publishing of all files by giving a prefix argument to any of the commands
10961 above, or by customizing the variable @code{org-publish-use-timestamps-flag}.
10962 This may be necessary in particular if files include other files via
10963 @code{#+SETUPFILE:} or @code{#+INCLUDE:}.
10965 @comment node-name, next, previous, up
10966 @comment Working With Source Code, Miscellaneous, Publishing, Top
10968 @node Working With Source Code, Miscellaneous, Publishing, Top
10969 @chapter Working with source code
10970 @cindex Schulte, Eric
10971 @cindex Davison, Dan
10972 @cindex source code, working with
10974 Source code can be included in Org-mode documents using a @samp{src} block,
10978 #+BEGIN_SRC emacs-lisp
10979 (defun org-xor (a b)
10985 Org-mode provides a number of features for working with live source code,
10986 including editing of code blocks in their native major-mode, evaluation of
10987 code blocks, tangling of code blocks, and exporting code blocks and their
10988 results in several formats. This functionality was contributed by Eric
10989 Schulte and Dan Davison, and was originally named Org-babel.
10991 The following sections describe Org-mode's code block handling facilities.
10994 * Structure of code blocks:: Code block syntax described
10995 * Editing source code:: Language major-mode editing
10996 * Exporting code blocks:: Export contents and/or results
10997 * Extracting source code:: Create pure source code files
10998 * Evaluating code blocks:: Place results of evaluation in the Org-mode buffer
10999 * Library of Babel:: Use and contribute to a library of useful code blocks
11000 * Languages:: List of supported code block languages
11001 * Header arguments:: Configure code block functionality
11002 * Results of evaluation:: How evaluation results are handled
11003 * Noweb reference syntax:: Literate programming in Org-mode
11004 * Key bindings and useful functions:: Work quickly with code blocks
11005 * Batch execution:: Call functions from the command line
11008 @comment node-name, next, previous, up
11009 @comment Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
11011 @node Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
11012 @section Structure of code blocks
11013 @cindex code block, structure
11014 @cindex source code, block structure
11016 The structure of code blocks is as follows:
11020 #+begin_src <language> <switches> <header arguments>
11027 This name is associated with the code block. This is similar to the
11028 @samp{#+tblname} lines that can be used to name tables in Org-mode files.
11029 Referencing the name of a code block makes it possible to evaluate the
11030 block from other places in the file, other files, or from Org-mode table
11031 formulas (see @ref{The spreadsheet}).
11033 The language of the code in the block.
11035 Switches controlling exportation of the code block (see switches discussion in
11036 @ref{Literal examples})
11037 @item <header arguments>
11038 Optional header arguments control many aspects of evaluation, export and
11039 tangling of code blocks. See the @ref{Header arguments}
11040 section. Header arguments can also be set on a per-buffer or per-subtree
11041 basis using properties.
11046 @comment node-name, next, previous, up
11047 @comment Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
11049 @node Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
11050 @section Editing source code
11051 @cindex code block, editing
11052 @cindex source code, editing
11055 Use @kbd{C-c '} to edit the current code block. This brings up
11056 a language major-mode edit buffer containing the body of the code
11057 block. Saving this buffer will write the new contents back to the Org
11058 buffer. Use @kbd{C-c '} again to exit.
11060 The @code{org-src-mode} minor mode will be active in the edit buffer. The
11061 following variables can be used to configure the behavior of the edit
11062 buffer. See also the customization group @code{org-edit-structure} for
11063 further configuration options.
11066 @item org-src-lang-modes
11067 If an Emacs major-mode named @code{<lang>-mode} exists, where
11068 @code{<lang>} is the language named in the header line of the code block,
11069 then the edit buffer will be placed in that major-mode. This variable
11070 can be used to map arbitrary language names to existing major modes.
11071 @item org-src-window-setup
11072 Controls the way Emacs windows are rearranged when the edit buffer is created.
11073 @item org-src-preserve-indentation
11074 This variable is especially useful for tangling languages such as
11075 python, in which whitespace indentation in the output is critical.
11076 @item org-src-ask-before-returning-to-edit-buffer
11077 By default, Org will ask before returning to an open edit buffer. Set
11078 this variable to nil to switch without asking.
11081 @comment node-name, next, previous, up
11082 @comment Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
11084 @node Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
11085 @section Exporting code blocks
11086 @cindex code block, exporting
11087 @cindex source code, exporting
11089 It is possible to export the @emph{contents} of code blocks, the
11090 @emph{results} of code block evaluation, @emph{neither}, or @emph{both}. For
11091 most languages, the default exports the contents of code blocks. However, for
11092 some languages (e.g. @code{ditaa}) the default exports the results of code
11093 block evaluation. For information on exporting code block bodies, see
11094 @ref{Literal examples}.
11096 The @code{:exports} header argument can be used to specify export
11099 @subsubheading Header arguments:
11101 @item :exports code
11102 The default in most languages. The body of the code block is exported, as
11103 described in @ref{Literal examples}.
11104 @item :exports results
11105 The code block will be evaluated and the results will be placed in the
11106 Org-mode buffer for export, either updating previous results of the code
11107 block located anywhere in the buffer or, if no previous results exist,
11108 placing the results immediately after the code block. The body of the code
11109 block will not be exported.
11110 @item :exports both
11111 Both the code block and its results will be exported.
11112 @item :exports none
11113 Neither the code block nor its results will be exported.
11116 It is possible to inhibit the evaluation of code blocks during export.
11117 Setting the the @code{org-export-babel-evaluate} variable to @code{nil} will
11118 ensure that no code blocks are evaluated as part of the export process. This
11119 can be useful in situations where potentially untrusted Org-mode files are
11120 exported in an automated fashion, for example when Org-mode is used as the
11121 markup language for a wiki.
11123 @comment node-name, next, previous, up
11124 @comment Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
11125 @node Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
11126 @section Extracting source code
11127 @cindex source code, extracting
11128 @cindex code block, extracting source code
11130 Creating pure source code files by extracting code from source blocks is
11131 referred to as ``tangling''---a term adopted from the literate programming
11132 community. During ``tangling'' of code blocks their bodies are expanded
11133 using @code{org-babel-expand-src-block} which can expand both variable and
11134 ``noweb'' style references (see @ref{Noweb reference syntax}).
11136 @subsubheading Header arguments
11139 The default. The code block is not included in the tangled output.
11141 Include the code block in the tangled output. The output file name is the
11142 name of the org file with the extension @samp{.org} replaced by the extension
11143 for the block language.
11144 @item :tangle filename
11145 Include the code block in the tangled output to file @samp{filename}.
11149 @subsubheading Functions
11151 @item org-babel-tangle @kbd{C-c C-v t}
11152 Tangle the current file.
11153 @item org-babel-tangle-file
11154 Choose a file to tangle.
11157 @subsubheading Hooks
11159 @item org-babel-post-tangle-hook
11160 This hook is run from within code files tangled by @code{org-babel-tangle}.
11161 Example applications could include post-processing, compilation or evaluation
11162 of tangled code files.
11165 @node Evaluating code blocks, Library of Babel, Extracting source code, Working With Source Code
11166 @section Evaluating code blocks
11167 @cindex code block, evaluating
11168 @cindex source code, evaluating
11170 Code blocks can be evaluated@footnote{Whenever code is evaluated there is a
11171 potential for that code to do harm. Org-mode provides a number of safeguards
11172 to ensure that it only evaluates code with explicit confirmation from the
11173 user. For information on these safeguards (and on how to disable them) see
11174 @ref{Code evaluation security}.} and the results placed in the Org-mode
11175 buffer. By default, evaluation is only turned on for @code{emacs-lisp} code
11176 blocks, however support exists for evaluating blocks in many languages. See
11177 @ref{Languages} for a list of supported languages. See @ref{Structure of
11178 code blocks} for information on the syntax used to define a code block.
11181 There are a number of ways to evaluate code blocks. The simplest is to press
11182 @kbd{C-c C-c} or @kbd{C-c C-v e} with the point on a code block@footnote{The
11183 @code{org-babel-no-eval-on-ctrl-c-ctrl-c} variable can be used to remove code
11184 evaluation from the @kbd{C-c C-c} key binding.}. This will call the
11185 @code{org-babel-execute-src-block} function to evaluate the block and insert
11186 its results into the Org-mode buffer.
11188 It is also possible to evaluate named code blocks from anywhere in an
11189 Org-mode buffer or an Org-mode table. @code{#+call} (or synonymously
11190 @code{#+function} or @code{#+lob}) lines can be used to remotely execute code
11191 blocks located in the current Org-mode buffer or in the ``Library of Babel''
11192 (see @ref{Library of Babel}). These lines use the following syntax.
11195 #+call: <name>(<arguments>) <header arguments>
11196 #+function: <name>(<arguments>) <header arguments>
11197 #+lob: <name>(<arguments>) <header arguments>
11202 The name of the code block to be evaluated.
11204 Arguments specified in this section will be passed to the code block.
11205 @item <header arguments>
11206 Header arguments can be placed after the function invocation. See
11207 @ref{Header arguments} for more information on header arguments.
11211 @node Library of Babel, Languages, Evaluating code blocks, Working With Source Code
11212 @section Library of Babel
11213 @cindex babel, library of
11214 @cindex source code, library
11215 @cindex code block, library
11217 The ``Library of Babel'' is a library of code blocks
11218 that can be called from any Org-mode file. The library is housed in an
11219 Org-mode file located in the @samp{contrib} directory of Org-mode.
11220 Org-mode users can deposit functions they believe to be generally
11221 useful in the library.
11223 Code blocks defined in the ``Library of Babel'' can be called remotely as if
11224 they were in the current Org-mode buffer (see @ref{Evaluating code blocks}
11225 for information on the syntax of remote code block evaluation).
11228 Code blocks located in any Org-mode file can be loaded into the ``Library of
11229 Babel'' with the @code{org-babel-lob-ingest} function, bound to @kbd{C-c C-v
11232 @node Languages, Header arguments, Library of Babel, Working With Source Code
11234 @cindex babel, languages
11235 @cindex source code, languages
11236 @cindex code block, languages
11238 Code blocks in the following languages are supported.
11240 @multitable @columnfractions 0.28 0.3 0.22 0.2
11241 @item @b{Language} @tab @b{Identifier} @tab @b{Language} @tab @b{Identifier}
11242 @item Asymptote @tab asymptote @tab C @tab C
11243 @item C++ @tab C++ @tab Clojure @tab clojure
11244 @item css @tab css @tab ditaa @tab ditaa
11245 @item Graphviz @tab dot @tab Emacs Lisp @tab emacs-lisp
11246 @item gnuplot @tab gnuplot @tab Haskell @tab haskell
11247 @item LaTeX @tab latex @tab Matlab @tab matlab
11248 @item Mscgen @tab mscgen @tab Objective Caml @tab ocaml
11249 @item Octave @tab octave @tab OZ @tab oz
11250 @item Perl @tab perl @tab Python @tab python
11251 @item R @tab R @tab Ruby @tab ruby
11252 @item Sass @tab sass @tab GNU Screen @tab screen
11253 @item shell @tab sh @tab SQL @tab sql
11254 @item Sqlite @tab sqlite
11257 Language-specific documentation is available for some languages. If
11258 available, it can be found at
11259 @uref{http://orgmode.org/worg/org-contrib/babel/languages}.
11261 The @code{org-babel-load-languages} controls which languages are enabled for
11262 evaluation (by default only @code{emacs-lisp} is enabled). This variable can
11263 be set using the customization interface or by adding code like the following
11264 to your emacs configuration.
11267 The following disables @code{emacs-lisp} evaluation and enables evaluation of
11268 @code{R} code blocks.
11272 (org-babel-do-load-languages
11273 'org-babel-load-languages
11274 '((emacs-lisp . nil)
11278 It is also possible to enable support for a language by loading the related
11279 elisp file with @code{require}.
11282 The following adds support for evaluating @code{clojure} code blocks.
11286 (require 'ob-clojure)
11289 @node Header arguments, Results of evaluation, Languages, Working With Source Code
11290 @section Header arguments
11291 @cindex code block, header arguments
11292 @cindex source code, block header arguments
11294 Code block functionality can be configured with header arguments. This
11295 section provides an overview of the use of header arguments, and then
11296 describes each header argument in detail.
11299 * Using header arguments:: Different ways to set header arguments
11300 * Specific header arguments:: List of header arguments
11303 @node Using header arguments, Specific header arguments, Header arguments, Header arguments
11304 @subsection Using header arguments
11306 The values of header arguments can be set in five different ways, each more
11307 specific (and having higher priority) than the last.
11309 * System-wide header arguments:: Set global default values
11310 * Language-specific header arguments:: Set default values by language
11311 * Buffer-wide header arguments:: Set default values for a specific buffer
11312 * Header arguments in Org-mode properties:: Set default values for a buffer or heading
11313 * Code block specific header arguments:: The most common way to set values
11317 @node System-wide header arguments, Language-specific header arguments, Using header arguments, Using header arguments
11318 @subsubheading System-wide header arguments
11319 @vindex org-babel-default-header-args
11320 System-wide values of header arguments can be specified by customizing the
11321 @code{org-babel-default-header-args} variable:
11325 :results => "replace"
11332 @c org-babel-default-header-args is a variable defined in `org-babel.el'.
11334 @c ((:session . "none")
11335 @c (:results . "replace")
11336 @c (:exports . "code")
11338 @c (:noweb . "no"))
11342 @c Default arguments to use when evaluating a code block.
11345 For example, the following example could be used to set the default value of
11346 @code{:noweb} header arguments to @code{yes}. This would have the effect of
11347 expanding @code{:noweb} references by default when evaluating source code
11351 (setq org-babel-default-header-args
11352 (cons '(:noweb . "yes")
11353 (assq-delete-all :noweb org-babel-default-header-args)))
11356 @node Language-specific header arguments, Buffer-wide header arguments, System-wide header arguments, Using header arguments
11357 @subsubheading Language-specific header arguments
11358 Each language can define its own set of default header arguments. See the
11359 language-specific documentation available online at
11360 @uref{http://orgmode.org/worg/org-contrib/babel}.
11362 @node Buffer-wide header arguments, Header arguments in Org-mode properties, Language-specific header arguments, Using header arguments
11363 @subsubheading Buffer-wide header arguments
11364 Buffer-wide header arguments may be specified through the use of a special
11365 line placed anywhere in an Org-mode file. The line consists of the
11366 @code{#+BABEL:} keyword followed by a series of header arguments which may be
11367 specified using the standard header argument syntax.
11369 For example the following would set @code{session} to @code{*R*}, and
11370 @code{results} to @code{silent} for every code block in the buffer, ensuring
11371 that all execution took place in the same session, and no results would be
11372 inserted into the buffer.
11375 #+BABEL: :session *R* :results silent
11378 @node Header arguments in Org-mode properties, Code block specific header arguments, Buffer-wide header arguments, Using header arguments
11379 @subsubheading Header arguments in Org-mode properties
11381 Header arguments are also read from Org-mode properties (see @ref{Property
11382 syntax}), which can be set on a buffer-wide or per-heading basis. An example
11383 of setting a header argument for all code blocks in a buffer is
11386 #+property: tangle yes
11389 When properties are used to set default header arguments, they are looked up
11390 with inheritance, so the value of the @code{:cache} header argument will default
11391 to @code{yes} in all code blocks in the subtree rooted at the following
11402 @vindex org-babel-default-header-args
11403 Properties defined in this way override the properties set in
11404 @code{org-babel-default-header-args}. It is convenient to use the
11405 @code{org-set-property} function bound to @kbd{C-c C-x p} to set properties
11406 in Org-mode documents.
11408 @node Code block specific header arguments, , Header arguments in Org-mode properties, Using header arguments
11409 @subsubheading Code block specific header arguments
11411 The most common way to assign values to header arguments is at the
11412 code block level. This can be done by listing a sequence of header
11413 arguments and their values as part of the @code{#+begin_src} line.
11414 Properties set in this way override both the values of
11415 @code{org-babel-default-header-args} and header arguments specified as
11416 properties. In the following example, the @code{:results} header argument
11417 is set to @code{silent}, meaning the results of execution will not be
11418 inserted in the buffer, and the @code{:exports} header argument is set to
11419 @code{code}, meaning only the body of the code block will be
11420 preserved on export to HTML or LaTeX.
11423 #+source: factorial
11424 #+begin_src haskell :results silent :exports code :var n=0
11426 fac n = n * fac (n-1)
11430 Similarly, it is possible to set header arguments for inline code blocks:
11433 src_haskell[:exports both]@{fac 5@}
11436 Header arguments for ``Library of Babel'' or function call lines can be set as shown below:
11439 #+call: factorial(n=5) :exports results
11442 @node Specific header arguments, , Using header arguments, Header arguments
11443 @subsection Specific header arguments
11444 The following header arguments are defined:
11447 * var:: Pass arguments to code blocks
11448 * results:: Specify the type of results and how they will
11449 be collected and handled
11450 * file:: Specify a path for file output
11451 * dir:: Specify the default (possibly remote)
11452 directory for code block execution
11453 * exports:: Export code and/or results
11454 * tangle:: Toggle tangling and specify file name
11455 * no-expand:: Turn off variable assignment and noweb
11456 expansion during tangling
11457 * comments:: Toggle insertion of comments in tangled
11459 * session:: Preserve the state of code evaluation
11460 * noweb:: Toggle expansion of noweb references
11461 * cache:: Avoid re-evaluating unchanged code blocks
11462 * hlines:: Handle horizontal lines in tables
11463 * colnames:: Handle column names in tables
11464 * rownames:: Handle row names in tables
11465 * shebang:: Make tangled files executable
11466 * eval:: Limit evaluation of specific code blocks
11469 @node var, results, Specific header arguments, Specific header arguments
11470 @subsubsection @code{:var}
11471 The @code{:var} header argument is used to pass arguments to code blocks.
11472 The specifics of how arguments are included in a code block vary by language;
11473 these are addressed in the language-specific documentation. However, the
11474 syntax used to specify arguments is the same across all languages. The
11475 values passed to arguments can be literal values, values from org-mode tables
11476 and literal example blocks, or the results of other code blocks.
11478 These values can be indexed in a manner similar to arrays---see the
11479 ``indexable variable values'' heading below.
11481 The following syntax is used to pass arguments to code blocks using the
11482 @code{:var} header argument.
11488 where @code{assign} can take one of the following forms
11491 @item literal value
11492 either a string @code{"string"} or a number @code{9}.
11497 #+tblname: example-table
11503 #+source: table-length
11504 #+begin_src emacs-lisp :var table=example-table
11508 #+results: table-length
11512 a code block name, as assigned by @code{#+srcname:}, followed by
11516 #+begin_src emacs-lisp :var length=table-length()
11524 In addition, an argument can be passed to the code block referenced
11525 by @code{:var}. The argument is passed within the parentheses following the
11530 #+begin_src emacs-lisp :var input=8
11538 #+begin_src emacs-lisp :var input=double(input=1)
11547 @subsubheading Alternate argument syntax
11548 It is also possible to specify arguments in a potentially more natural way
11549 using the @code{#+source:} line of a code block. As in the following
11550 example arguments can be packed inside of parenthesis, separated by commas,
11551 following the source name.
11554 #+source: double(input=0, x=2)
11555 #+begin_src emacs-lisp
11560 @subsubheading Indexable variable values
11561 It is possible to reference portions of variable values by ``indexing'' into
11562 the variables. Indexes are 0 based with negative values counting back from
11563 the end. If an index is separated by @code{,}s then each subsequent section
11564 will index into the next deepest nesting or dimension of the value. The
11565 following example assigns the last cell of the first row the table
11566 @code{example-table} to the variable @code{data}:
11569 #+results: example-table
11575 #+begin_src emacs-lisp :var data=example-table[0,-1]
11583 Ranges of variable values can be referenced using two integers separated by a
11584 @code{:}, in which case the entire inclusive range is referenced. For
11585 example the following assigns the middle three rows of @code{example-table}
11589 #+results: example-table
11596 #+begin_src emacs-lisp :var data=example-table[1:3]
11606 Additionally, an empty index, or the single character @code{*}, are both
11607 interpreted to mean the entire range and as such are equivalent to
11608 @code{0:-1}, as shown in the following example in which the entire first
11609 column is referenced.
11612 #+results: example-table
11618 #+begin_src emacs-lisp :var data=example-table[,0]
11626 It is possible to index into the results of code blocks as well as tables.
11627 Any number of dimensions can be indexed. Dimensions are separated from one
11628 another by commas, as shown in the following example.
11632 #+begin_src emacs-lisp
11633 '(((1 2 3) (4 5 6) (7 8 9))
11634 ((10 11 12) (13 14 15) (16 17 18))
11635 ((19 20 21) (22 23 24) (25 26 27)))
11638 #+begin_src emacs-lisp :var data=3D[1,,1]
11646 @node results, file, var, Specific header arguments
11647 @subsubsection @code{:results}
11649 There are three classes of @code{:results} header argument. Only one option of
11650 each type may be supplied per code block.
11654 @b{collection} header arguments specify how the results should be collected
11655 from the code block
11657 @b{type} header arguments specify what type of result the code block will
11658 return---which has implications for how they will be inserted into the
11661 @b{handling} header arguments specify how the results of evaluating the code
11662 block should be handled.
11665 @subsubheading Collection
11666 The following options are mutually exclusive, and specify how the results
11667 should be collected from the code block.
11671 This is the default. The result is the value of the last statement in the
11672 code block. This header argument places the evaluation in functional
11673 mode. Note that in some languages, e.g., python, use of this result type
11674 requires that a @code{return} statement be included in the body of the source
11675 code block. E.g., @code{:results value}.
11676 @item @code{output}
11677 The result is the collection of everything printed to STDOUT during the
11678 execution of the code block. This header argument places the
11679 evaluation in scripting mode. E.g., @code{:results output}.
11682 @subsubheading Type
11684 The following options are mutually exclusive and specify what type of results
11685 the code block will return. By default, results are inserted as either a
11686 table or scalar depending on their value.
11689 @item @code{table}, @code{vector}
11690 The results should be interpreted as an Org-mode table. If a single value is
11691 returned, it will be converted into a table with one row and one column.
11692 E.g., @code{:results value table}.
11693 @item @code{scalar}, @code{verbatim}
11694 The results should be interpreted literally---they will not be
11695 converted into a table. The results will be inserted into the Org-mode
11696 buffer as quoted text. E.g., @code{:results value verbatim}.
11698 The results will be interpreted as the path to a file, and will be inserted
11699 into the Org-mode buffer as a file link. E.g., @code{:results value file}.
11700 @item @code{raw}, @code{org}
11701 The results are interpreted as raw Org-mode code and are inserted directly
11702 into the buffer. If the results look like a table they will be aligned as
11703 such by Org-mode. E.g., @code{:results value raw}.
11705 Results are assumed to be HTML and will be enclosed in a @code{begin_html}
11706 block. E.g., @code{:results value html}.
11708 Results assumed to be LaTeX and are enclosed in a @code{begin_latex} block.
11709 E.g., @code{:results value latex}.
11711 Result are assumed to be parseable code and are enclosed in a code block.
11712 E.g., @code{:results value code}.
11714 The result is converted to pretty-printed code and is enclosed in a code
11715 block. This option currently supports Emacs Lisp, python, and ruby. E.g.,
11716 @code{:results value pp}.
11719 @subsubheading Handling
11720 The following results options indicate what happens with the
11721 results once they are collected.
11724 @item @code{silent}
11725 The results will be echoed in the minibuffer but will not be inserted into
11726 the Org-mode buffer. E.g., @code{:results output silent}.
11727 @item @code{replace}
11728 The default value. Any existing results will be removed, and the new results
11729 will be inserted into the Org-mode buffer in their place. E.g.,
11730 @code{:results output replace}.
11731 @item @code{append}
11732 If there are pre-existing results of the code block then the new results will
11733 be appended to the existing results. Otherwise the new results will be
11734 inserted as with @code{replace}.
11735 @item @code{prepend}
11736 If there are pre-existing results of the code block then the new results will
11737 be prepended to the existing results. Otherwise the new results will be
11738 inserted as with @code{replace}.
11741 @node file, dir, results, Specific header arguments
11742 @subsubsection @code{:file}
11744 The header argument @code{:file} is used to specify a path for file output.
11745 An Org-mode style @code{file:} link is inserted into the buffer as the result
11746 (see @ref{Link format}). Common examples are graphical output from R,
11747 gnuplot, ditaa and LaTeX code blocks.
11749 Note that for some languages, including R, gnuplot, LaTeX and ditaa,
11750 graphical output is sent to the specified file without the file being
11751 referenced explicitly in the code block. See the documentation for the
11752 individual languages for details. In contrast, general purpose languages such
11753 as python and ruby require that the code explicitly create output
11754 corresponding to the path indicated by @code{:file}.
11757 @node dir, exports, file, Specific header arguments
11758 @subsubsection @code{:dir} and remote execution
11760 While the @code{:file} header argument can be used to specify the path to the
11761 output file, @code{:dir} specifies the default directory during code block
11762 execution. If it is absent, then the directory associated with the current
11763 buffer is used. In other words, supplying @code{:dir path} temporarily has
11764 the same effect as changing the current directory with @kbd{M-x cd path}, and
11765 then not supplying @code{:dir}. Under the surface, @code{:dir} simply sets
11766 the value of the Emacs variable @code{default-directory}.
11768 When using @code{:dir}, you should supply a relative path for file output
11769 (e.g. @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which
11770 case that path will be interpreted relative to the default directory.
11772 In other words, if you want your plot to go into a folder called Work in your
11773 home directory, you could use
11776 #+begin_src R :file myplot.png :dir ~/Work
11777 matplot(matrix(rnorm(100), 10), type="l")
11781 @subsubheading Remote execution
11782 A directory on a remote machine can be specified using tramp file syntax, in
11783 which case the code will be evaluated on the remote machine. An example is
11786 #+begin_src R :file plot.png :dir /dand@@yakuba.princeton.edu:
11787 plot(1:10, main=system("hostname", intern=TRUE))
11791 Text results will be returned to the local Org-mode buffer as usual, and file
11792 output will be created on the remote machine with relative paths interpreted
11793 relative to the remote directory. An Org-mode link to the remote file will be
11796 So, in the above example a plot will be created on the remote machine,
11797 and a link of the following form will be inserted in the org buffer:
11800 [[file:/scp:dand@@yakuba.princeton.edu:/home/dand/plot.png][plot.png]]
11803 Most of this functionality follows immediately from the fact that @code{:dir}
11804 sets the value of the Emacs variable @code{default-directory}, thanks to
11805 tramp. Those using XEmacs, or GNU Emacs prior to version 23 may need to
11806 install tramp separately in order for the these features to work correctly.
11808 @subsubheading Further points
11812 If @code{:dir} is used in conjunction with @code{:session}, although it will
11813 determine the starting directory for a new session as expected, no attempt is
11814 currently made to alter the directory associated with an existing session.
11816 @code{:dir} should typically not be used to create files during export with
11817 @code{:exports results} or @code{:exports both}. The reason is that, in order
11818 to retain portability of exported material between machines, during export
11819 links inserted into the buffer will *not* be expanded against @code{default
11820 directory}. Therefore, if @code{default-directory} is altered using
11821 @code{:dir}, it is probable that the file will be created in a location to
11822 which the link does not point.
11825 @node exports, tangle, dir, Specific header arguments
11826 @subsubsection @code{:exports}
11828 The @code{:exports} header argument specifies what should be included in HTML
11829 or LaTeX exports of the Org-mode file.
11833 The default. The body of code is included into the exported file. E.g.,
11834 @code{:exports code}.
11835 @item @code{results}
11836 The result of evaluating the code is included in the exported file. E.g.,
11837 @code{:exports results}.
11839 Both the code and results are included in the exported file. E.g.,
11840 @code{:exports both}.
11842 Nothing is included in the exported file. E.g., @code{:exports none}.
11845 @node tangle, comments, exports, Specific header arguments
11846 @subsubsection @code{:tangle}
11848 The @code{:tangle} header argument specifies whether or not the code
11849 block should be included in tangled extraction of source code files.
11853 The code block is exported to a source code file named after the
11854 basename (name w/o extension) of the Org-mode file. E.g., @code{:tangle
11857 The default. The code block is not exported to a source code file.
11858 E.g., @code{:tangle no}.
11860 Any other string passed to the @code{:tangle} header argument is interpreted
11861 as a file basename to which the block will be exported. E.g., @code{:tangle
11865 @node comments, no-expand, tangle, Specific header arguments
11866 @subsubsection @code{:comments}
11867 By default code blocks are tangled to source-code files without any insertion
11868 of comments beyond those which may already exist in the body of the code
11869 block. The @code{:comments} header argument can be set to ``yes''
11870 e.g. @code{:comments yes} to enable the insertion of comments around code
11871 blocks during tangling. The inserted comments contain pointers back to the
11872 original Org file from which the comment was tangled.
11874 @node no-expand, session, comments, Specific header arguments
11875 @subsubsection @code{:no-expand}
11877 By default, code blocks are expanded with @code{org-babel-expand-src-block}
11878 during tangling. This has the effect of assigning values to variables
11879 specified with @code{:var} (see @ref{var}), and of replacing ``noweb''
11880 references (see @ref{Noweb reference syntax}) with their targets. The
11881 @code{:no-expand} header argument can be used to turn off this behavior.
11883 @node session, noweb, no-expand, Specific header arguments
11884 @subsubsection @code{:session}
11886 The @code{:session} header argument starts a session for an interpreted
11887 language where state is preserved.
11889 By default, a session is not started.
11891 A string passed to the @code{:session} header argument will give the session
11892 a name. This makes it possible to run concurrent sessions for each
11893 interpreted language.
11895 @node noweb, cache, session, Specific header arguments
11896 @subsubsection @code{:noweb}
11898 The @code{:noweb} header argument controls expansion of ``noweb'' style (see
11899 @ref{Noweb reference syntax}) references in a code block. This header
11900 argument can have one of two values: @code{yes} or @code{no}.
11904 The default. No ``noweb'' syntax specific action is taken on evaluating
11905 code blocks, However, noweb references will still be expanded during
11908 All ``noweb'' syntax references in the body of the code block will be
11909 expanded before the block is evaluated.
11912 @subsubheading Noweb prefix lines
11913 Noweb insertions are now placed behind the line prefix of the
11914 @code{<<reference>>}.
11915 This behavior is illustrated in the following example. Because the
11916 @code{<<example>>} noweb reference appears behind the SQL comment syntax,
11917 each line of the expanded noweb reference will be commented.
11930 -- multi-line body of example
11933 Note that noweb replacement text that does not contain any newlines will not
11934 be affected by this change, so it is still possible to use inline noweb
11937 @node cache, hlines, noweb, Specific header arguments
11938 @subsubsection @code{:cache}
11940 The @code{:cache} header argument controls the use of in-buffer caching of
11941 the results of evaluating code blocks. It can be used to avoid re-evaluating
11942 unchanged code blocks. This header argument can have one of two
11943 values: @code{yes} or @code{no}.
11947 The default. No caching takes place, and the code block will be evaluated
11948 every time it is called.
11950 Every time the code block is run a sha1 hash of the code and arguments
11951 passed to the block will be generated. This hash is packed into the
11952 @code{#+results:} line and will be checked on subsequent
11953 executions of the code block. If the code block has not
11954 changed since the last time it was evaluated, it will not be re-evaluated.
11957 @node hlines, colnames, cache, Specific header arguments
11958 @subsubsection @code{:hlines}
11960 Tables are frequently represented with one or more horizontal lines, or
11961 hlines. The @code{:hlines} argument to a code block accepts the
11962 values @code{yes} or @code{no}, with a default value of @code{no}.
11966 Strips horizontal lines from the input table. In most languages this is the
11967 desired effect because an @code{hline} symbol is interpreted as an unbound
11968 variable and raises an error. Setting @code{:hlines no} or relying on the
11969 default value yields the following results.
11972 #+tblname: many-cols
11979 #+source: echo-table
11980 #+begin_src python :var tab=many-cols
11984 #+results: echo-table
11991 Leaves hlines in the table. Setting @code{:hlines yes} has this effect.
11994 #+tblname: many-cols
12001 #+source: echo-table
12002 #+begin_src python :var tab=many-cols :hlines yes
12006 #+results: echo-table
12015 @node colnames, rownames, hlines, Specific header arguments
12016 @subsubsection @code{:colnames}
12018 The @code{:colnames} header argument accepts the values @code{yes},
12019 @code{no}, or @code{nil} for unassigned. The default value is @code{nil}.
12023 If an input table looks like it has column names
12024 (because its second row is an hline), then the column
12025 names will be removed from the table before
12026 processing, then reapplied to the results.
12029 #+tblname: less-cols
12035 #+srcname: echo-table-again
12036 #+begin_src python :var tab=less-cols
12037 return [[val + '*' for val in row] for row in tab]
12040 #+results: echo-table-again
12048 No column name pre-processing takes place
12051 Column names are removed and reapplied as with @code{nil} even if the table
12052 does not ``look like'' it has column names (i.e. the second row is not an
12056 @node rownames, shebang, colnames, Specific header arguments
12057 @subsubsection @code{:rownames}
12059 The @code{:rownames} header argument can take on the values @code{yes}
12060 or @code{no}, with a default value of @code{no}.
12064 No row name pre-processing will take place.
12067 The first column of the table is removed from the table before processing,
12068 and is then reapplied to the results.
12071 #+tblname: with-rownames
12072 | one | 1 | 2 | 3 | 4 | 5 |
12073 | two | 6 | 7 | 8 | 9 | 10 |
12075 #+srcname: echo-table-once-again
12076 #+begin_src python :var tab=with-rownames :rownames yes
12077 return [[val + 10 for val in row] for row in tab]
12080 #+results: echo-table-once-again
12081 | one | 11 | 12 | 13 | 14 | 15 |
12082 | two | 16 | 17 | 18 | 19 | 20 |
12086 @node shebang, eval, rownames, Specific header arguments
12087 @subsubsection @code{:shebang}
12089 Setting the @code{:shebang} header argument to a string value
12090 (e.g. @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the
12091 first line of any tangled file holding the code block, and the file
12092 permissions of the tangled file are set to make it executable.
12094 @node eval, , shebang, Specific header arguments
12095 @subsubsection @code{:eval}
12096 The @code{:eval} header argument can be used to limit the evaluation of
12097 specific code blocks. @code{:eval} accepts two arguments ``never'' and
12098 ``query''. @code{:eval never} will ensure that a code block is never
12099 evaluated, this can be useful for protecting against the evaluation of
12100 dangerous code blocks. @code{:eval query} will require a query for every
12101 execution of a code block regardless of the value of the
12102 @code{org-confirm-babel-evaluate} variable.
12104 @node Results of evaluation, Noweb reference syntax, Header arguments, Working With Source Code
12105 @section Results of evaluation
12106 @cindex code block, results of evaluation
12107 @cindex source code, results of evaluation
12109 The way in which results are handled depends on whether a session is invoked,
12110 as well as on whether @code{:results value} or @code{:results output} is
12111 used. The following table shows the possibilities:
12113 @multitable @columnfractions 0.26 0.33 0.41
12114 @item @tab @b{Non-session} @tab @b{Session}
12115 @item @code{:results value} @tab value of last expression @tab value of last expression
12116 @item @code{:results output} @tab contents of STDOUT @tab concatenation of interpreter output
12119 Note: With @code{:results value}, the result in both @code{:session} and
12120 non-session is returned to Org-mode as a table (a one- or two-dimensional
12121 vector of strings or numbers) when appropriate.
12123 @subsection Non-session
12124 @subsubsection @code{:results value}
12125 This is the default. Internally, the value is obtained by wrapping the code
12126 in a function definition in the external language, and evaluating that
12127 function. Therefore, code should be written as if it were the body of such a
12128 function. In particular, note that python does not automatically return a
12129 value from a function unless a @code{return} statement is present, and so a
12130 @samp{return} statement will usually be required in python.
12132 This is the only one of the four evaluation contexts in which the code is
12133 automatically wrapped in a function definition.
12135 @subsubsection @code{:results output}
12136 The code is passed to the interpreter as an external process, and the
12137 contents of the standard output stream are returned as text. (In certain
12138 languages this also contains the error output stream; this is an area for
12141 @subsection @code{:session}
12142 @subsubsection @code{:results value}
12143 The code is passed to the interpreter running as an interactive Emacs
12144 inferior process. The result returned is the result of the last evaluation
12145 performed by the interpreter. (This is obtained in a language-specific
12146 manner: the value of the variable @code{_} in python and ruby, and the value
12147 of @code{.Last.value} in R).
12149 @subsubsection @code{:results output}
12150 The code is passed to the interpreter running as an interactive Emacs
12151 inferior process. The result returned is the concatenation of the sequence of
12152 (text) output from the interactive interpreter. Notice that this is not
12153 necessarily the same as what would be sent to @code{STDOUT} if the same code
12154 were passed to a non-interactive interpreter running as an external
12155 process. For example, compare the following two blocks:
12158 #+begin_src python :results output
12169 In non-session mode, the '2' is not printed and does not appear.
12171 #+begin_src python :results output :session
12183 But in @code{:session} mode, the interactive interpreter receives input '2'
12184 and prints out its value, '2'. (Indeed, the other print statements are
12187 @node Noweb reference syntax, Key bindings and useful functions, Results of evaluation, Working With Source Code
12188 @section Noweb reference syntax
12189 @cindex code block, noweb reference
12190 @cindex syntax, noweb
12191 @cindex source code, noweb reference
12193 The ``noweb'' (see @uref{http://www.cs.tufts.edu/~nr/noweb/}) Literate
12194 Programming system allows named blocks of code to be referenced by using the
12195 familiar Noweb syntax:
12198 <<code-block-name>>
12201 When a code block is tangled or evaluated, whether or not ``noweb''
12202 references are expanded depends upon the value of the @code{:noweb} header
12203 argument. If @code{:noweb yes}, then a Noweb reference is expanded before
12204 evaluation. If @code{:noweb no}, the default, then the reference is not
12205 expanded before evaluation.
12207 Note: the default value, @code{:noweb no}, was chosen to ensure that
12208 correct code is not broken in a language, such as Ruby, where
12209 @code{<<arg>>} is a syntactically valid construct. If @code{<<arg>>} is not
12210 syntactically valid in languages that you use, then please consider setting
12213 @node Key bindings and useful functions, Batch execution, Noweb reference syntax, Working With Source Code
12214 @section Key bindings and useful functions
12215 @cindex code block, key bindings
12217 Many common Org-mode key sequences are re-bound depending on
12220 Within a code block, the following key bindings
12223 @multitable @columnfractions 0.25 0.75
12225 @item @kbd{C-c C-c} @tab org-babel-execute-src-block
12227 @item @kbd{C-c C-o} @tab org-babel-open-src-block-result
12229 @item @kbd{C-@key{up}} @tab org-babel-load-in-session
12231 @item @kbd{M-@key{down}} @tab org-babel-pop-to-session
12234 In an Org-mode buffer, the following key bindings are active:
12236 @multitable @columnfractions 0.45 0.55
12238 @kindex C-c C-v C-a
12239 @item @kbd{C-c C-v a} @ @ @r{or} @ @ @kbd{C-c C-v C-a} @tab org-babel-sha1-hash
12241 @kindex C-c C-v C-b
12242 @item @kbd{C-c C-v b} @ @ @r{or} @ @ @kbd{C-c C-v C-b} @tab org-babel-execute-buffer
12244 @kindex C-c C-v C-f
12245 @item @kbd{C-c C-v f} @ @ @r{or} @ @ @kbd{C-c C-v C-f} @tab org-babel-tangle-file
12247 @item @kbd{C-c C-v g} @tab org-babel-goto-named-source-block
12249 @item @kbd{C-c C-v h} @tab org-babel-describe-bindings
12251 @kindex C-c C-v C-l
12252 @item @kbd{C-c C-v l} @ @ @r{or} @ @ @kbd{C-c C-v C-l} @tab org-babel-lob-ingest
12254 @kindex C-c C-v C-p
12255 @item @kbd{C-c C-v p} @ @ @r{or} @ @ @kbd{C-c C-v C-p} @tab org-babel-expand-src-block
12257 @kindex C-c C-v C-s
12258 @item @kbd{C-c C-v s} @ @ @r{or} @ @ @kbd{C-c C-v C-s} @tab org-babel-execute-subtree
12260 @kindex C-c C-v C-t
12261 @item @kbd{C-c C-v t} @ @ @r{or} @ @ @kbd{C-c C-v C-t} @tab org-babel-tangle
12263 @kindex C-c C-v C-z
12264 @item @kbd{C-c C-v z} @ @ @r{or} @ @ @kbd{C-c C-v C-z} @tab org-babel-switch-to-session
12267 @c When possible these keybindings were extended to work when the control key is
12268 @c kept pressed, resulting in the following additional keybindings.
12270 @c @multitable @columnfractions 0.25 0.75
12271 @c @item @kbd{C-c C-v C-a} @tab org-babel-sha1-hash
12272 @c @item @kbd{C-c C-v C-b} @tab org-babel-execute-buffer
12273 @c @item @kbd{C-c C-v C-f} @tab org-babel-tangle-file
12274 @c @item @kbd{C-c C-v C-l} @tab org-babel-lob-ingest
12275 @c @item @kbd{C-c C-v C-p} @tab org-babel-expand-src-block
12276 @c @item @kbd{C-c C-v C-s} @tab org-babel-execute-subtree
12277 @c @item @kbd{C-c C-v C-t} @tab org-babel-tangle
12278 @c @item @kbd{C-c C-v C-z} @tab org-babel-switch-to-session
12281 @node Batch execution, , Key bindings and useful functions, Working With Source Code
12282 @section Batch execution
12283 @cindex code block, batch execution
12284 @cindex source code, batch execution
12286 It is possible to call functions from the command line. This shell
12287 script calls @code{org-babel-tangle} on every one of its arguments.
12289 Be sure to adjust the paths to fit your system.
12293 # -*- mode: shell-script -*-
12295 # tangle a file with org-mode
12300 # wrap each argument in the code required to call tangle on it
12302 FILES="$FILES \"$i\""
12307 (add-to-list 'load-path (expand-file-name \"~/src/org/lisp/\"))
12308 (add-to-list 'load-path (expand-file-name \"~/src/org/contrib/lisp/\"))
12309 (require 'org)(require 'org-exp)(require 'ob)(require 'ob-tangle)
12310 (mapc (lambda (file)
12311 (find-file (expand-file-name file \"$DIR\"))
12313 (kill-buffer)) '($FILES)))"
12316 @node Miscellaneous, Hacking, Working With Source Code, Top
12317 @chapter Miscellaneous
12320 * Completion:: M-TAB knows what you need
12321 * Speed keys:: Electric commands at the beginning of a headline
12322 * Code evaluation security:: Org mode files evaluate inline code
12323 * Customization:: Adapting Org to your taste
12324 * In-buffer settings:: Overview of the #+KEYWORDS
12325 * The very busy C-c C-c key:: When in doubt, press C-c C-c
12326 * Clean view:: Getting rid of leading stars in the outline
12327 * TTY keys:: Using Org on a tty
12328 * Interaction:: Other Emacs packages
12332 @node Completion, Speed keys, Miscellaneous, Miscellaneous
12333 @section Completion
12334 @cindex completion, of @TeX{} symbols
12335 @cindex completion, of TODO keywords
12336 @cindex completion, of dictionary words
12337 @cindex completion, of option keywords
12338 @cindex completion, of tags
12339 @cindex completion, of property keys
12340 @cindex completion, of link abbreviations
12341 @cindex @TeX{} symbol completion
12342 @cindex TODO keywords completion
12343 @cindex dictionary word completion
12344 @cindex option keyword completion
12345 @cindex tag completion
12346 @cindex link abbreviations, completion of
12348 Emacs would not be Emacs without completion, and Org-mode uses it whenever it
12349 makes sense. If you prefer an @i{iswitchb}- or @i{ido}-like interface for
12350 some of the completion prompts, you can specify your preference by setting at
12351 most one of the variables @code{org-completion-use-iswitchb}
12352 @code{org-completion-use-ido}.
12354 Org supports in-buffer completion. This type of completion does
12355 not make use of the minibuffer. You simply type a few letters into
12356 the buffer and use the key to complete text right there.
12359 @kindex M-@key{TAB}
12361 Complete word at point
12364 At the beginning of a headline, complete TODO keywords.
12366 After @samp{\}, complete @TeX{} symbols supported by the exporter.
12368 After @samp{*}, complete headlines in the current buffer so that they
12369 can be used in search links like @samp{[[*find this headline]]}.
12371 After @samp{:} in a headline, complete tags. The list of tags is taken
12372 from the variable @code{org-tag-alist} (possibly set through the
12373 @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
12374 dynamically from all tags used in the current buffer.
12376 After @samp{:} and not in a headline, complete property keys. The list
12377 of keys is constructed dynamically from all keys used in the current
12380 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
12382 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
12383 @samp{OPTIONS} which set file-specific options for Org-mode. When the
12384 option keyword is already complete, pressing @kbd{M-@key{TAB}} again
12385 will insert example settings for this keyword.
12387 In the line after @samp{#+STARTUP: }, complete startup keywords,
12388 i.e. valid keys for this line.
12390 Elsewhere, complete dictionary words using Ispell.
12394 @node Speed keys, Code evaluation security, Completion, Miscellaneous
12395 @section Speed keys
12397 @vindex org-use-speed-commands
12398 @vindex org-speed-commands-user
12400 Single keys can be made to execute commands when the cursor is at the
12401 beginning of a headline, i.e. before the first star. Configure the variable
12402 @code{org-use-speed-commands} to activate this feature. There is a
12403 pre-defined list of commands, and you can add more such commands using the
12404 variable @code{org-speed-commands-user}. Speed keys do not only speed up
12405 navigation and other commands, but they also provide an alternative way to
12406 execute commands bound to keys that are not or not easily available on a tty,
12407 or on a small mobile device with a limited keyboard.
12409 To see which commands are available, activate the feature and press @kbd{?}
12410 with the cursor at the beginning of a headline.
12412 @node Code evaluation security, Customization, Speed keys, Miscellaneous
12413 @section Code evaluation and security issues
12415 Org provides tools to work with the code snippets, including evaluating them.
12417 Running code on your machine always comes with a security risk. Badly
12418 written or malicious code can be executed on purpose or by accident. Org has
12419 default settings which will only evaluate such code if you give explicit
12420 permission to do so, and as a casual user of these features you should leave
12421 these precautions intact.
12423 For people who regularly work with such code, the confirmation prompts can
12424 become annoying, and you might want to turn them off. This can be done, but
12425 you must be aware of the risks that are involved.
12427 Code evaluation can happen under the following circumstances:
12430 @item Source code blocks
12431 Source code blocks can be evaluated during export, or when pressing @kbd{C-c
12432 C-c} in the block. The most important thing to realize here is that Org mode
12433 files which contain code snippets are, in a certain sense, like executable
12434 files. So you should accept them and load them into Emacs only from trusted
12435 sources - just like you would do with a program you install on your computer.
12437 Make sure you know what you are doing before customizing the variables
12438 which take off the default security brakes.
12440 @defopt org-confirm-babel-evaluate
12441 When set to t user is queried before code block evaluation
12444 @item Following @code{shell} and @code{elisp} links
12445 Org has two link types that can directly evaluate code (@pxref{External
12446 links}). These links can be problematic because the code to be evaluated is
12449 @defopt org-confirm-shell-link-function
12450 Function to queries user about shell link execution.
12452 @defopt org-confirm-elisp-link-function
12453 Functions to query user for Emacs Lisp link execution.
12456 @item Formulas in tables
12457 Formulas in tables (@pxref{The spreadsheet}) are code that is evaluated
12458 either by the @i{calc} interpreter, or by the @i{Emacs Lisp} interpreter.
12461 @node Customization, In-buffer settings, Code evaluation security, Miscellaneous
12462 @section Customization
12463 @cindex customization
12464 @cindex options, for customization
12465 @cindex variables, for customization
12467 There are more than 180 variables that can be used to customize
12468 Org. For the sake of compactness of the manual, I am not
12469 describing the variables here. A structured overview of customization
12470 variables is available with @kbd{M-x org-customize}. Or select
12471 @code{Browse Org Group} from the @code{Org->Customization} menu. Many
12472 settings can also be activated on a per-file basis, by putting special
12473 lines into the buffer (@pxref{In-buffer settings}).
12475 @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous
12476 @section Summary of in-buffer settings
12477 @cindex in-buffer settings
12478 @cindex special keywords
12480 Org-mode uses special lines in the buffer to define settings on a
12481 per-file basis. These lines start with a @samp{#+} followed by a
12482 keyword, a colon, and then individual words defining a setting. Several
12483 setting words can be in the same line, but you can also have multiple
12484 lines for the keyword. While these settings are described throughout
12485 the manual, here is a summary. After changing any of those lines in the
12486 buffer, press @kbd{C-c C-c} with the cursor still in the line to
12487 activate the changes immediately. Otherwise they become effective only
12488 when the file is visited again in a new Emacs session.
12490 @vindex org-archive-location
12492 @item #+ARCHIVE: %s_done::
12493 This line sets the archive location for the agenda file. It applies for
12494 all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
12495 of the file. The first such line also applies to any entries before it.
12496 The corresponding variable is @code{org-archive-location}.
12498 This line sets the category for the agenda file. The category applies
12499 for all subsequent lines until the next @samp{#+CATEGORY} line, or the
12500 end of the file. The first such line also applies to any entries before it.
12501 @item #+COLUMNS: %25ITEM .....
12502 @cindex property, COLUMNS
12503 Set the default format for columns view. This format applies when
12504 columns view is invoked in locations where no @code{COLUMNS} property
12506 @item #+CONSTANTS: name1=value1 ...
12507 @vindex org-table-formula-constants
12508 @vindex org-table-formula
12509 Set file-local values for constants to be used in table formulas. This
12510 line set the local variable @code{org-table-formula-constants-local}.
12511 The global version of this variable is
12512 @code{org-table-formula-constants}.
12513 @item #+FILETAGS: :tag1:tag2:tag3:
12514 Set tags that can be inherited by any entry in the file, including the
12516 @item #+DRAWERS: NAME1 .....
12517 @vindex org-drawers
12518 Set the file-local set of drawers. The corresponding global variable is
12519 @code{org-drawers}.
12520 @item #+LINK: linkword replace
12521 @vindex org-link-abbrev-alist
12522 These lines (several are allowed) specify link abbreviations.
12523 @xref{Link abbreviations}. The corresponding variable is
12524 @code{org-link-abbrev-alist}.
12525 @item #+PRIORITIES: highest lowest default
12526 @vindex org-highest-priority
12527 @vindex org-lowest-priority
12528 @vindex org-default-priority
12529 This line sets the limits and the default for the priorities. All three
12530 must be either letters A-Z or numbers 0-9. The highest priority must
12531 have a lower ASCII number that the lowest priority.
12532 @item #+PROPERTY: Property_Name Value
12533 This line sets a default inheritance value for entries in the current
12534 buffer, most useful for specifying the allowed values of a property.
12535 @cindex #+SETUPFILE
12536 @item #+SETUPFILE: file
12537 This line defines a file that holds more in-buffer setup. Normally this is
12538 entirely ignored. Only when the buffer is parsed for option-setting lines
12539 (i.e. when starting Org-mode for a file, when pressing @kbd{C-c C-c} in a
12540 settings line, or when exporting), then the contents of this file are parsed
12541 as if they had been included in the buffer. In particular, the file can be
12542 any other Org-mode file with internal setup. You can visit the file the
12543 cursor is in the line with @kbd{C-c '}.
12546 This line sets options to be used at startup of Org-mode, when an
12547 Org file is being visited.
12549 The first set of options deals with the initial visibility of the outline
12550 tree. The corresponding variable for global default settings is
12551 @code{org-startup-folded}, with a default value @code{t}, which means
12553 @vindex org-startup-folded
12554 @cindex @code{overview}, STARTUP keyword
12555 @cindex @code{content}, STARTUP keyword
12556 @cindex @code{showall}, STARTUP keyword
12557 @cindex @code{showeverything}, STARTUP keyword
12559 overview @r{top-level headlines only}
12560 content @r{all headlines}
12561 showall @r{no folding of any entries}
12562 showeverything @r{show even drawer contents}
12565 @vindex org-startup-indented
12566 @cindex @code{indent}, STARTUP keyword
12567 @cindex @code{noindent}, STARTUP keyword
12568 Dynamic virtual indentation is controlled by the variable
12569 @code{org-startup-indented}@footnote{Emacs 23 and Org-mode 6.29 are required}
12571 indent @r{start with @code{org-indent-mode} turned on}
12572 noindent @r{start with @code{org-indent-mode} turned off}
12575 @vindex org-startup-align-all-tables
12576 Then there are options for aligning tables upon visiting a file. This
12577 is useful in files containing narrowed table columns. The corresponding
12578 variable is @code{org-startup-align-all-tables}, with a default value
12580 @cindex @code{align}, STARTUP keyword
12581 @cindex @code{noalign}, STARTUP keyword
12583 align @r{align all tables}
12584 noalign @r{don't align tables on startup}
12586 @vindex org-log-done
12587 @vindex org-log-note-clock-out
12588 @vindex org-log-repeat
12589 Logging the closing and reopening of TODO items and clock intervals can be
12590 configured using these options (see variables @code{org-log-done},
12591 @code{org-log-note-clock-out} and @code{org-log-repeat})
12592 @cindex @code{logdone}, STARTUP keyword
12593 @cindex @code{lognotedone}, STARTUP keyword
12594 @cindex @code{nologdone}, STARTUP keyword
12595 @cindex @code{lognoteclock-out}, STARTUP keyword
12596 @cindex @code{nolognoteclock-out}, STARTUP keyword
12597 @cindex @code{logrepeat}, STARTUP keyword
12598 @cindex @code{lognoterepeat}, STARTUP keyword
12599 @cindex @code{nologrepeat}, STARTUP keyword
12600 @cindex @code{logreschedule}, STARTUP keyword
12601 @cindex @code{lognotereschedule}, STARTUP keyword
12602 @cindex @code{nologreschedule}, STARTUP keyword
12603 @cindex @code{logredeadline}, STARTUP keyword
12604 @cindex @code{lognoteredeadline}, STARTUP keyword
12605 @cindex @code{nologredeadline}, STARTUP keyword
12606 @cindex @code{logrefile}, STARTUP keyword
12607 @cindex @code{lognoterefile}, STARTUP keyword
12608 @cindex @code{nologrefile}, STARTUP keyword
12610 logdone @r{record a timestamp when an item is marked DONE}
12611 lognotedone @r{record timestamp and a note when DONE}
12612 nologdone @r{don't record when items are marked DONE}
12613 logrepeat @r{record a time when reinstating a repeating item}
12614 lognoterepeat @r{record a note when reinstating a repeating item}
12615 nologrepeat @r{do not record when reinstating repeating item}
12616 lognoteclock-out @r{record a note when clocking out}
12617 nolognoteclock-out @r{don't record a note when clocking out}
12618 logreschedule @r{record a timestamp when scheduling time changes}
12619 lognotereschedule @r{record a note when scheduling time changes}
12620 nologreschedule @r{do not record when a scheduling date changes}
12621 logredeadline @r{record a timestamp when deadline changes}
12622 lognoteredeadline @r{record a note when deadline changes}
12623 nologredeadline @r{do not record when a deadline date changes}
12624 logrefile @r{record a timestamp when refiling}
12625 lognoterefile @r{record a note when refiling}
12626 nologrefile @r{do not record when refiling}
12628 @vindex org-hide-leading-stars
12629 @vindex org-odd-levels-only
12630 Here are the options for hiding leading stars in outline headings, and for
12631 indenting outlines. The corresponding variables are
12632 @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
12633 default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
12634 @cindex @code{hidestars}, STARTUP keyword
12635 @cindex @code{showstars}, STARTUP keyword
12636 @cindex @code{odd}, STARTUP keyword
12637 @cindex @code{even}, STARTUP keyword
12639 hidestars @r{make all but one of the stars starting a headline invisible.}
12640 showstars @r{show all stars starting a headline}
12641 indent @r{virtual indentation according to outline level}
12642 noindent @r{no virtual indentation according to outline level}
12643 odd @r{allow only odd outline levels (1,3,...)}
12644 oddeven @r{allow all outline levels}
12646 @vindex org-put-time-stamp-overlays
12647 @vindex org-time-stamp-overlay-formats
12648 To turn on custom format overlays over timestamps (variables
12649 @code{org-put-time-stamp-overlays} and
12650 @code{org-time-stamp-overlay-formats}), use
12651 @cindex @code{customtime}, STARTUP keyword
12653 customtime @r{overlay custom time format}
12655 @vindex constants-unit-system
12656 The following options influence the table spreadsheet (variable
12657 @code{constants-unit-system}).
12658 @cindex @code{constcgs}, STARTUP keyword
12659 @cindex @code{constSI}, STARTUP keyword
12661 constcgs @r{@file{constants.el} should use the c-g-s unit system}
12662 constSI @r{@file{constants.el} should use the SI unit system}
12664 @vindex org-footnote-define-inline
12665 @vindex org-footnote-auto-label
12666 @vindex org-footnote-auto-adjust
12667 To influence footnote settings, use the following keywords. The
12668 corresponding variables are @code{org-footnote-define-inline},
12669 @code{org-footnote-auto-label}, and @code{org-footnote-auto-adjust}.
12670 @cindex @code{fninline}, STARTUP keyword
12671 @cindex @code{nofninline}, STARTUP keyword
12672 @cindex @code{fnlocal}, STARTUP keyword
12673 @cindex @code{fnprompt}, STARTUP keyword
12674 @cindex @code{fnauto}, STARTUP keyword
12675 @cindex @code{fnconfirm}, STARTUP keyword
12676 @cindex @code{fnplain}, STARTUP keyword
12677 @cindex @code{fnadjust}, STARTUP keyword
12678 @cindex @code{nofnadjust}, STARTUP keyword
12680 fninline @r{define footnotes inline}
12681 fnnoinline @r{define footnotes in separate section}
12682 fnlocal @r{define footnotes near first reference, but not inline}
12683 fnprompt @r{prompt for footnote labels}
12684 fnauto @r{create [fn:1]-like labels automatically (default)}
12685 fnconfirm @r{offer automatic label for editing or confirmation}
12686 fnplain @r{create [1]-like labels automatically}
12687 fnadjust @r{automatically renumber and sort footnotes}
12688 nofnadjust @r{do not renumber and sort automatically}
12690 @cindex org-hide-block-startup
12691 To hide blocks on startup, use these keywords. The corresponding variable is
12692 @code{org-hide-block-startup}.
12693 @cindex @code{hideblocks}, STARTUP keyword
12694 @cindex @code{nohideblocks}, STARTUP keyword
12696 hideblocks @r{Hide all begin/end blocks on startup}
12697 nohideblocks @r{Do not hide blocks on startup}
12699 @cindex org-pretty-entities
12700 The the display of entities as UTF8 characters is governed by the variable
12701 @code{org-pretty-entities} and the keywords
12702 @cindex @code{entitiespretty}, STARTUP keyword
12703 @cindex @code{entitiesplain}, STARTUP keyword
12705 entitiespretty @r{Show entities as UTF8 characters where possible}
12706 entitiesplain @r{Leave entities plain}
12708 @item #+TAGS: TAG1(c1) TAG2(c2)
12709 @vindex org-tag-alist
12710 These lines (several such lines are allowed) specify the valid tags in
12711 this file, and (potentially) the corresponding @emph{fast tag selection}
12712 keys. The corresponding variable is @code{org-tag-alist}.
12714 This line contains the formulas for the table directly above the line.
12715 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+DATE:,
12716 @itemx #+OPTIONS:, #+BIND:, #+XSLT:,
12717 @itemx #+DESCRIPTION:, #+KEYWORDS:,
12718 @itemx #+LATEX_HEADER:, #+STYLE:, #+LINK_UP:, #+LINK_HOME:,
12719 @itemx #+EXPORT_SELECT_TAGS:, #+EXPORT_EXCLUDE_TAGS:
12720 These lines provide settings for exporting files. For more details see
12721 @ref{Export options}.
12722 @item #+TODO: #+SEQ_TODO: #+TYP_TODO:
12723 @vindex org-todo-keywords
12724 These lines set the TODO keywords and their interpretation in the
12725 current file. The corresponding variable is @code{org-todo-keywords}.
12728 @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous
12729 @section The very busy C-c C-c key
12731 @cindex C-c C-c, overview
12733 The key @kbd{C-c C-c} has many purposes in Org, which are all
12734 mentioned scattered throughout this manual. One specific function of
12735 this key is to add @emph{tags} to a headline (@pxref{Tags}). In many
12736 other circumstances it means something like @emph{``Hey Org, look
12737 here and update according to what you see here''}. Here is a summary of
12738 what this means in different contexts.
12742 If there are highlights in the buffer from the creation of a sparse
12743 tree, or from clock display, remove these highlights.
12745 If the cursor is in one of the special @code{#+KEYWORD} lines, this
12746 triggers scanning the buffer for these lines and updating the
12749 If the cursor is inside a table, realign the table. This command
12750 works even if the automatic table editor has been turned off.
12752 If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
12755 If the current buffer is a capture buffer, close the note and file it.
12756 With a prefix argument, file it, without further interaction, to the
12759 If the cursor is on a @code{<<<target>>>}, update radio targets and
12760 corresponding links in this buffer.
12762 If the cursor is in a property line or at the start or end of a property
12763 drawer, offer property commands.
12765 If the cursor is at a footnote reference, go to the corresponding
12766 definition, and vice versa.
12768 If the cursor is on a statistics cookie, update it.
12770 If the cursor is in a plain list item with a checkbox, toggle the status
12773 If the cursor is on a numbered item in a plain list, renumber the
12776 If the cursor is on the @code{#+BEGIN} line of a dynamic block, the
12780 @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous
12781 @section A cleaner outline view
12782 @cindex hiding leading stars
12783 @cindex dynamic indentation
12784 @cindex odd-levels-only outlines
12785 @cindex clean outline view
12787 Some people find it noisy and distracting that the Org headlines start with a
12788 potentially large number of stars, and that text below the headlines is not
12789 indented. While this is no problem when writing a @emph{book-like} document
12790 where the outline headings are really section headings, in a more
12791 @emph{list-oriented} outline, indented structure is a lot cleaner:
12795 * Top level headline | * Top level headline
12796 ** Second level | * Second level
12797 *** 3rd level | * 3rd level
12798 some text | some text
12799 *** 3rd level | * 3rd level
12800 more text | more text
12801 * Another top level headline | * Another top level headline
12807 If you are using at least Emacs 23.2@footnote{Emacs 23.1 can actually crash
12808 with @code{org-indent-mode}} and version 6.29 of Org, this kind of view can
12809 be achieved dynamically at display time using @code{org-indent-mode}. In
12810 this minor mode, all lines are prefixed for display with the necessary amount
12811 of space@footnote{@code{org-indent-mode} also sets the @code{wrap-prefix}
12812 property, such that @code{visual-line-mode} (or purely setting
12813 @code{word-wrap}) wraps long lines (including headlines) correctly indented.
12814 }. Also headlines are prefixed with additional stars, so that the amount of
12815 indentation shifts by two@footnote{See the variable
12816 @code{org-indent-indentation-per-level}.} spaces per level. All headline
12817 stars but the last one are made invisible using the @code{org-hide}
12818 face@footnote{Turning on @code{org-indent-mode} sets
12819 @code{org-hide-leading-stars} to @code{t} and @code{org-adapt-indentation} to
12820 @code{nil}.} - see below under @samp{2.} for more information on how this
12821 works. You can turn on @code{org-indent-mode} for all files by customizing
12822 the variable @code{org-startup-indented}, or you can turn it on for
12823 individual files using
12829 If you want a similar effect in earlier version of Emacs and/or Org, or if
12830 you want the indentation to be hard space characters so that the plain text
12831 file looks as similar as possible to the Emacs display, Org supports you in
12836 @emph{Indentation of text below headlines}@*
12837 You may indent text below each headline to make the left boundary line up
12838 with the headline, like
12842 more text, now indented
12845 @vindex org-adapt-indentation
12846 Org supports this with paragraph filling, line wrapping, and structure
12847 editing@footnote{See also the variable @code{org-adapt-indentation}.},
12848 preserving or adapting the indentation as appropriate.
12851 @vindex org-hide-leading-stars
12852 @emph{Hiding leading stars}@* You can modify the display in such a way that
12853 all leading stars become invisible. To do this in a global way, configure
12854 the variable @code{org-hide-leading-stars} or change this on a per-file basis
12858 #+STARTUP: hidestars
12859 #+STARTUP: showstars
12862 With hidden stars, the tree becomes:
12866 * Top level headline
12874 @vindex org-hide @r{(face)}
12875 The leading stars are not truly replaced by whitespace, they are only
12876 fontified with the face @code{org-hide} that uses the background color as
12877 font color. If you are not using either white or black background, you may
12878 have to customize this face to get the wanted effect. Another possibility is
12879 to set this font such that the extra stars are @i{almost} invisible, for
12880 example using the color @code{grey90} on a white background.
12883 @vindex org-odd-levels-only
12884 Things become cleaner still if you skip all the even levels and use only odd
12885 levels 1, 3, 5..., effectively adding two stars to go from one outline level
12886 to the next@footnote{When you need to specify a level for a property search
12887 or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc@.}. In this
12888 way we get the outline view shown at the beginning of this section. In order
12889 to make the structure editing and export commands handle this convention
12890 correctly, configure the variable @code{org-odd-levels-only}, or set this on
12891 a per-file basis with one of the following lines:
12898 You can convert an Org file from single-star-per-level to the
12899 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
12900 RET} in that file. The reverse operation is @kbd{M-x
12901 org-convert-to-oddeven-levels}.
12904 @node TTY keys, Interaction, Clean view, Miscellaneous
12905 @section Using Org on a tty
12906 @cindex tty key bindings
12908 Because Org contains a large number of commands, by default many of
12909 Org's core commands are bound to keys that are generally not
12910 accessible on a tty, such as the cursor keys (@key{left}, @key{right},
12911 @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
12912 together with modifiers like @key{Meta} and/or @key{Shift}. To access
12913 these commands on a tty when special keys are unavailable, the following
12914 alternative bindings can be used. The tty bindings below will likely be
12915 more cumbersome; you may find for some of the bindings below that a
12916 customized workaround suits you better. For example, changing a timestamp
12917 is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
12918 tty you would rather use @kbd{C-c .} to re-insert the timestamp.
12920 @multitable @columnfractions 0.15 0.2 0.1 0.2
12921 @item @b{Default} @tab @b{Alternative 1} @tab @b{Speed key} @tab @b{Alternative 2}
12922 @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab @kbd{C} @tab
12923 @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{l} @tab @kbd{@key{Esc} @key{left}}
12924 @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab @kbd{L} @tab
12925 @item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{r} @tab @kbd{@key{Esc} @key{right}}
12926 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab @kbd{R} @tab
12927 @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{ } @tab @kbd{@key{Esc} @key{up}}
12928 @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab @kbd{U} @tab
12929 @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{ } @tab @kbd{@key{Esc} @key{down}}
12930 @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab @kbd{D} @tab
12931 @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab @kbd{ } @tab
12932 @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{ } @tab @kbd{@key{Esc} @key{RET}}
12933 @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab @kbd{ } @tab
12934 @item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab @kbd{ } @tab
12935 @item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab @kbd{ } @tab
12936 @item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab @kbd{ } @tab
12937 @item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab @kbd{ } @tab
12938 @item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab @kbd{ } @tab
12939 @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab @kbd{ } @tab
12943 @node Interaction, , TTY keys, Miscellaneous
12944 @section Interaction with other packages
12945 @cindex packages, interaction with other
12946 Org lives in the world of GNU Emacs and interacts in various ways
12947 with other code out there.
12950 * Cooperation:: Packages Org cooperates with
12951 * Conflicts:: Packages that lead to conflicts
12954 @node Cooperation, Conflicts, Interaction, Interaction
12955 @subsection Packages that Org cooperates with
12958 @cindex @file{calc.el}
12959 @cindex Gillespie, Dave
12960 @item @file{calc.el} by Dave Gillespie
12961 Org uses the Calc package for implementing spreadsheet
12962 functionality in its tables (@pxref{The spreadsheet}). Org
12963 checks for the availability of Calc by looking for the function
12964 @code{calc-eval} which will have been autoloaded during setup if Calc has
12965 been installed properly. As of Emacs 22, Calc is part of the Emacs
12966 distribution. Another possibility for interaction between the two
12967 packages is using Calc for embedded calculations. @xref{Embedded Mode,
12968 , Embedded Mode, Calc, GNU Emacs Calc Manual}.
12969 @item @file{constants.el} by Carsten Dominik
12970 @cindex @file{constants.el}
12971 @cindex Dominik, Carsten
12972 @vindex org-table-formula-constants
12973 In a table formula (@pxref{The spreadsheet}), it is possible to use
12974 names for natural constants or units. Instead of defining your own
12975 constants in the variable @code{org-table-formula-constants}, install
12976 the @file{constants} package which defines a large number of constants
12977 and units, and lets you use unit prefixes like @samp{M} for
12978 @samp{Mega}, etc@. You will need version 2.0 of this package, available
12979 at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for
12980 the function @code{constants-get}, which has to be autoloaded in your
12981 setup. See the installation instructions in the file
12982 @file{constants.el}.
12983 @item @file{cdlatex.el} by Carsten Dominik
12984 @cindex @file{cdlatex.el}
12985 @cindex Dominik, Carsten
12986 Org-mode can make use of the CDLa@TeX{} package to efficiently enter
12987 La@TeX{} fragments into Org files. See @ref{CDLaTeX mode}.
12988 @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
12989 @cindex @file{imenu.el}
12990 Imenu allows menu access to an index of items in a file. Org-mode
12991 supports Imenu---all you need to do to get the index is the following:
12993 (add-hook 'org-mode-hook
12994 (lambda () (imenu-add-to-menubar "Imenu")))
12996 @vindex org-imenu-depth
12997 By default the index is two levels deep---you can modify the depth using
12998 the option @code{org-imenu-depth}.
12999 @item @file{remember.el} by John Wiegley
13000 @cindex @file{remember.el}
13001 @cindex Wiegley, John
13002 Org used to use this package for capture, but no longer does.
13003 @item @file{speedbar.el} by Eric M. Ludlam
13004 @cindex @file{speedbar.el}
13005 @cindex Ludlam, Eric M.
13006 Speedbar is a package that creates a special frame displaying files and
13007 index items in files. Org-mode supports Speedbar and allows you to
13008 drill into Org files directly from the Speedbar. It also allows you to
13009 restrict the scope of agenda commands to a file or a subtree by using
13010 the command @kbd{<} in the Speedbar frame.
13011 @cindex @file{table.el}
13012 @item @file{table.el} by Takaaki Ota
13014 @cindex table editor, @file{table.el}
13015 @cindex @file{table.el}
13016 @cindex Ota, Takaaki
13018 Complex ASCII tables with automatic line wrapping, column- and row-spanning,
13019 and alignment can be created using the Emacs table package by Takaaki Ota
13020 (@uref{http://sourceforge.net/projects/table}, and also part of Emacs 22).
13021 Org-mode will recognize these tables and export them properly. Because of
13022 interference with other Org-mode functionality, you unfortunately cannot edit
13023 these tables directly in the buffer. Instead, you need to use the command
13024 @kbd{C-c '} to edit them, similar to source code snippets.
13029 Edit a @file{table.el} table. Works when the cursor is in a table.el table.
13033 Insert a @file{table.el} table. If there is already a table at point, this
13034 command converts it between the @file{table.el} format and the Org-mode
13035 format. See the documentation string of the command
13036 @code{org-convert-table} for the restrictions under which this is
13039 @file{table.el} is part of Emacs since Emacs 22.
13040 @item @file{footnote.el} by Steven L. Baur
13041 @cindex @file{footnote.el}
13042 @cindex Baur, Steven L.
13043 Org-mode recognizes numerical footnotes as provided by this package.
13044 However, Org-mode also has its own footnote support (@pxref{Footnotes}),
13045 which makes using @file{footnote.el} unnecessary.
13048 @node Conflicts, , Cooperation, Interaction
13049 @subsection Packages that lead to conflicts with Org-mode
13053 @cindex @code{shift-selection-mode}
13054 @vindex org-support-shift-select
13055 In Emacs 23, @code{shift-selection-mode} is on by default, meaning that
13056 cursor motions combined with the shift key should start or enlarge regions.
13057 This conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change
13058 timestamps, TODO keywords, priorities, and item bullet types if the cursor is
13059 at such a location. By default, @kbd{S-@key{cursor}} commands outside
13060 special contexts don't do anything, but you can customize the variable
13061 @code{org-support-shift-select}. Org-mode then tries to accommodate shift
13062 selection by (i) using it outside of the special contexts where special
13063 commands apply, and by (ii) extending an existing active region even if the
13064 cursor moves across a special context.
13066 @item @file{CUA.el} by Kim. F. Storm
13067 @cindex @file{CUA.el}
13068 @cindex Storm, Kim. F.
13069 @vindex org-replace-disputed-keys
13070 Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by CUA mode
13071 (as well as @code{pc-select-mode} and @code{s-region-mode}) to select and extend the
13072 region. In fact, Emacs 23 has this built-in in the form of
13073 @code{shift-selection-mode}, see previous paragraph. If you are using Emacs
13074 23, you probably don't want to use another package for this purpose. However,
13075 if you prefer to leave these keys to a different package while working in
13076 Org-mode, configure the variable @code{org-replace-disputed-keys}. When set,
13077 Org will move the following key bindings in Org files, and in the agenda
13078 buffer (but not during date selection).
13081 S-UP -> M-p S-DOWN -> M-n
13082 S-LEFT -> M-- S-RIGHT -> M-+
13083 C-S-LEFT -> M-S-- C-S-RIGHT -> M-S-+
13086 @vindex org-disputed-keys
13087 Yes, these are unfortunately more difficult to remember. If you want
13088 to have other replacement keys, look at the variable
13089 @code{org-disputed-keys}.
13091 @item @file{yasnippet.el}
13092 @cindex @file{yasnippet.el}
13093 The way Org-mode binds the TAB key (binding to @code{[tab]} instead of
13094 @code{"\t"}) overrules yasnippets' access to this key. The following code
13095 fixed this problem:
13098 (add-hook 'org-mode-hook
13100 (org-set-local 'yas/trigger-key [tab])
13101 (define-key yas/keymap [tab] 'yas/next-field-group)))
13104 @item @file{windmove.el} by Hovav Shacham
13105 @cindex @file{windmove.el}
13106 This package also uses the @kbd{S-<cursor>} keys, so everything written
13107 in the paragraph above about CUA mode also applies here. If you want make
13108 the windmove function active in locations where Org-mode does not have
13109 special functionality on @kbd{S-@key{cursor}}, add this to your
13113 ;; Make windmove work in org-mode:
13114 (add-hook 'org-shiftup-final-hook 'windmove-up)
13115 (add-hook 'org-shiftleft-final-hook 'windmove-left)
13116 (add-hook 'org-shiftdown-final-hook 'windmove-down)
13117 (add-hook 'org-shiftright-final-hook 'windmove-right)
13120 @item @file{viper.el} by Michael Kifer
13121 @cindex @file{viper.el}
13123 Viper uses @kbd{C-c /} and therefore makes this key not access the
13124 corresponding Org-mode command @code{org-sparse-tree}. You need to find
13125 another key for this command, or override the key in
13126 @code{viper-vi-global-user-map} with
13129 (define-key viper-vi-global-user-map "C-c /" 'org-sparse-tree)
13135 @node Hacking, MobileOrg, Miscellaneous, Top
13139 This appendix covers some aspects where users can extend the functionality of
13143 * Hooks:: Who to reach into Org's internals
13144 * Add-on packages:: Available extensions
13145 * Adding hyperlink types:: New custom link types
13146 * Context-sensitive commands:: How to add functionality to such commands
13147 * Tables in arbitrary syntax:: Orgtbl for La@TeX{} and other programs
13148 * Dynamic blocks:: Automatically filled blocks
13149 * Special agenda views:: Customized views
13150 * Extracting agenda information:: Postprocessing of agenda information
13151 * Using the property API:: Writing programs that use entry properties
13152 * Using the mapping API:: Mapping over all or selected entries
13155 @node Hooks, Add-on packages, Hacking, Hacking
13159 Org has a large number of hook variables that can be used to add
13160 functionality. This appendix about hacking is going to illustrate the
13161 use of some of them. A complete list of all hooks with documentation is
13162 maintained by the Worg project and can be found at
13163 @uref{http://orgmode.org/worg/org-configs/org-hooks.php}.
13165 @node Add-on packages, Adding hyperlink types, Hooks, Hacking
13166 @section Add-on packages
13167 @cindex add-on packages
13169 A large number of add-on packages have been written by various authors.
13170 These packages are not part of Emacs, but they are distributed as contributed
13171 packages with the separate release available at the Org-mode home page at
13172 @uref{http://orgmode.org}. The list of contributed packages, along with
13173 documentation about each package, is maintained by the Worg project at
13174 @uref{http://orgmode.org/worg/org-contrib/}.
13178 @node Adding hyperlink types, Context-sensitive commands, Add-on packages, Hacking
13179 @section Adding hyperlink types
13180 @cindex hyperlinks, adding new types
13182 Org has a large number of hyperlink types built-in
13183 (@pxref{Hyperlinks}). If you would like to add new link types, Org
13184 provides an interface for doing so. Let's look at an example file,
13185 @file{org-man.el}, that will add support for creating links like
13186 @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
13190 ;;; org-man.el - Support for links to manpages in Org
13194 (org-add-link-type "man" 'org-man-open)
13195 (add-hook 'org-store-link-functions 'org-man-store-link)
13197 (defcustom org-man-command 'man
13198 "The Emacs command to be used to display a man page."
13200 :type '(choice (const man) (const woman)))
13202 (defun org-man-open (path)
13203 "Visit the manpage on PATH.
13204 PATH should be a topic that can be thrown at the man command."
13205 (funcall org-man-command path))
13207 (defun org-man-store-link ()
13208 "Store a link to a manpage."
13209 (when (memq major-mode '(Man-mode woman-mode))
13210 ;; This is a man page, we do make this link
13211 (let* ((page (org-man-get-page-name))
13212 (link (concat "man:" page))
13213 (description (format "Manpage for %s" page)))
13214 (org-store-link-props
13217 :description description))))
13219 (defun org-man-get-page-name ()
13220 "Extract the page name from the buffer name."
13221 ;; This works for both `Man-mode' and `woman-mode'.
13222 (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
13223 (match-string 1 (buffer-name))
13224 (error "Cannot create link to this man page")))
13228 ;;; org-man.el ends here
13232 You would activate this new link type in @file{.emacs} with
13239 Let's go through the file and see what it does.
13242 It does @code{(require 'org)} to make sure that @file{org.el} has been
13245 The next line calls @code{org-add-link-type} to define a new link type
13246 with prefix @samp{man}. The call also contains the name of a function
13247 that will be called to follow such a link.
13249 @vindex org-store-link-functions
13250 The next line adds a function to @code{org-store-link-functions}, in
13251 order to allow the command @kbd{C-c l} to record a useful link in a
13252 buffer displaying a man page.
13255 The rest of the file defines the necessary variables and functions.
13256 First there is a customization variable that determines which Emacs
13257 command should be used to display man pages. There are two options,
13258 @code{man} and @code{woman}. Then the function to follow a link is
13259 defined. It gets the link path as an argument---in this case the link
13260 path is just a topic for the manual command. The function calls the
13261 value of @code{org-man-command} to display the man page.
13263 Finally the function @code{org-man-store-link} is defined. When you try
13264 to store a link with @kbd{C-c l}, this function will be called to
13265 try to make a link. The function must first decide if it is supposed to
13266 create the link for this buffer type; we do this by checking the value
13267 of the variable @code{major-mode}. If not, the function must exit and
13268 return the value @code{nil}. If yes, the link is created by getting the
13269 manual topic from the buffer name and prefixing it with the string
13270 @samp{man:}. Then it must call the command @code{org-store-link-props}
13271 and set the @code{:type} and @code{:link} properties. Optionally you
13272 can also set the @code{:description} property to provide a default for
13273 the link description when the link is later inserted into an Org
13274 buffer with @kbd{C-c C-l}.
13276 When is makes sense for your new link type, you may also define a function
13277 @code{org-PREFIX-complete-link} that implements special (e.g. completion)
13278 support for inserting such a link with @kbd{C-c C-l}. Such a function should
13279 not accept any arguments, and return the full link with prefix.
13281 @node Context-sensitive commands, Tables in arbitrary syntax, Adding hyperlink types, Hacking
13282 @section Context-sensitive commands
13283 @cindex context-sensitive commands, hooks
13284 @cindex add-ons, context-sensitive commands
13285 @vindex org-ctrl-c-ctrl-c-hook
13287 Org has several commands that act differently depending on context. The most
13288 important example it the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}).
13289 Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys have this property.
13291 Add-ons can tap into this functionality by providing a function that detects
13292 special context for that add-on and executes functionality appropriate for
13293 the context. Here is an example from Dan Davison's @file{org-R.el} which
13294 allows you to evaluate commands based on the @file{R} programming language
13295 @footnote{@file{org-R.el} has been replaced by the org-mode functionality
13296 described in @ref{Working With Source Code} and is now obsolete.}. For this
13297 package, special contexts are lines that start with @code{#+R:} or
13301 (defun org-R-apply-maybe ()
13302 "Detect if this is context for org-R and execute R commands."
13303 (if (save-excursion
13304 (beginning-of-line 1)
13305 (looking-at "#\\+RR?:"))
13306 (progn (call-interactively 'org-R-apply)
13307 t) ;; to signal that we took action
13308 nil)) ;; to signal that we did not
13310 (add-hook 'org-ctrl-c-ctrl-c-hook 'org-R-apply-maybe)
13313 The function first checks if the cursor is in such a line. If that is the
13314 case, @code{org-R-apply} is called and the function returns @code{t} to
13315 signal that action was taken, and @kbd{C-c C-c} will stop looking for other
13316 contexts. If the function finds it should do nothing locally, it returns @code{nil} so that other, similar functions can have a try.
13319 @node Tables in arbitrary syntax, Dynamic blocks, Context-sensitive commands, Hacking
13320 @section Tables and lists in arbitrary syntax
13321 @cindex tables, in other modes
13322 @cindex lists, in other modes
13323 @cindex Orgtbl mode
13325 Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
13326 frequent feature request has been to make it work with native tables in
13327 specific languages, for example La@TeX{}. However, this is extremely
13328 hard to do in a general way, would lead to a customization nightmare,
13329 and would take away much of the simplicity of the Orgtbl-mode table
13332 This appendix describes a different approach. We keep the Orgtbl mode
13333 table in its native format (the @i{source table}), and use a custom
13334 function to @i{translate} the table to the correct syntax, and to
13335 @i{install} it in the right location (the @i{target table}). This puts
13336 the burden of writing conversion functions on the user, but it allows
13337 for a very flexible system.
13339 Bastien added the ability to do the same with lists, in Orgstruct mode. You
13340 can use Org's facilities to edit and structure lists by turning
13341 @code{orgstruct-mode} on, then locally exporting such lists in another format
13342 (HTML, La@TeX{} or Texinfo.)
13346 * Radio tables:: Sending and receiving radio tables
13347 * A LaTeX example:: Step by step, almost a tutorial
13348 * Translator functions:: Copy and modify
13349 * Radio lists:: Doing the same for lists
13352 @node Radio tables, A LaTeX example, Tables in arbitrary syntax, Tables in arbitrary syntax
13353 @subsection Radio tables
13354 @cindex radio tables
13356 To define the location of the target table, you first need to create two
13357 lines that are comments in the current mode, but contain magic words for
13358 Orgtbl mode to find. Orgtbl mode will insert the translated table
13359 between these lines, replacing whatever was there before. For example:
13362 /* BEGIN RECEIVE ORGTBL table_name */
13363 /* END RECEIVE ORGTBL table_name */
13367 Just above the source table, we put a special line that tells
13368 Orgtbl mode how to translate this table and where to install it. For
13372 #+ORGTBL: SEND table_name translation_function arguments....
13376 @code{table_name} is the reference name for the table that is also used
13377 in the receiver lines. @code{translation_function} is the Lisp function
13378 that does the translation. Furthermore, the line can contain a list of
13379 arguments (alternating key and value) at the end. The arguments will be
13380 passed as a property list to the translation function for
13381 interpretation. A few standard parameters are already recognized and
13382 acted upon before the translation function is called:
13386 Skip the first N lines of the table. Hlines do count as separate lines for
13389 @item :skipcols (n1 n2 ...)
13390 List of columns that should be skipped. If the table has a column with
13391 calculation marks, that column is automatically discarded as well.
13392 Please note that the translator function sees the table @emph{after} the
13393 removal of these columns, the function never knows that there have been
13394 additional columns.
13398 The one problem remaining is how to keep the source table in the buffer
13399 without disturbing the normal workings of the file, for example during
13400 compilation of a C file or processing of a La@TeX{} file. There are a
13401 number of different solutions:
13405 The table could be placed in a block comment if that is supported by the
13406 language. For example, in C mode you could wrap the table between
13407 @samp{/*} and @samp{*/} lines.
13409 Sometimes it is possible to put the table after some kind of @i{END}
13410 statement, for example @samp{\bye} in @TeX{} and @samp{\end@{document@}}
13413 You can just comment the table line-by-line whenever you want to process
13414 the file, and uncomment it whenever you need to edit the table. This
13415 only sounds tedious---the command @kbd{M-x orgtbl-toggle-comment}
13416 makes this comment-toggling very easy, in particular if you bind it to a
13420 @node A LaTeX example, Translator functions, Radio tables, Tables in arbitrary syntax
13421 @subsection A La@TeX{} example of radio tables
13422 @cindex La@TeX{}, and Orgtbl mode
13424 The best way to wrap the source table in La@TeX{} is to use the
13425 @code{comment} environment provided by @file{comment.sty}. It has to be
13426 activated by placing @code{\usepackage@{comment@}} into the document
13427 header. Orgtbl mode can insert a radio table skeleton@footnote{By
13428 default this works only for La@TeX{}, HTML, and Texinfo. Configure the
13429 variable @code{orgtbl-radio-tables} to install templates for other
13430 modes.} with the command @kbd{M-x orgtbl-insert-radio-table}. You will
13431 be prompted for a table name, let's say we use @samp{salesfigures}. You
13432 will then get the following template:
13434 @cindex #+ORGTBL, SEND
13436 % BEGIN RECEIVE ORGTBL salesfigures
13437 % END RECEIVE ORGTBL salesfigures
13439 #+ORGTBL: SEND salesfigures orgtbl-to-latex
13445 @vindex La@TeX{}-verbatim-environments
13446 The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
13447 @code{orgtbl-to-latex} to convert the table into La@TeX{} and to put it
13448 into the receiver location with name @code{salesfigures}. You may now
13449 fill in the table, feel free to use the spreadsheet features@footnote{If
13450 the @samp{#+TBLFM} line contains an odd number of dollar characters,
13451 this may cause problems with font-lock in La@TeX{} mode. As shown in the
13452 example you can fix this by adding an extra line inside the
13453 @code{comment} environment that is used to balance the dollar
13454 expressions. If you are using AUC@TeX{} with the font-latex library, a
13455 much better solution is to add the @code{comment} environment to the
13456 variable @code{LaTeX-verbatim-environments}.}:
13459 % BEGIN RECEIVE ORGTBL salesfigures
13460 % END RECEIVE ORGTBL salesfigures
13462 #+ORGTBL: SEND salesfigures orgtbl-to-latex
13463 | Month | Days | Nr sold | per day |
13464 |-------+------+---------+---------|
13465 | Jan | 23 | 55 | 2.4 |
13466 | Feb | 21 | 16 | 0.8 |
13467 | March | 22 | 278 | 12.6 |
13468 #+TBLFM: $4=$3/$2;%.1f
13469 % $ (optional extra dollar to keep font-lock happy, see footnote)
13474 When you are done, press @kbd{C-c C-c} in the table to get the converted
13475 table inserted between the two marker lines.
13477 Now let's assume you want to make the table header by hand, because you
13478 want to control how columns are aligned, etc@. In this case we make sure
13479 that the table translator skips the first 2 lines of the source
13480 table, and tell the command to work as a @i{splice}, i.e. to not produce
13481 header and footer commands of the target table:
13484 \begin@{tabular@}@{lrrr@}
13485 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
13486 % BEGIN RECEIVE ORGTBL salesfigures
13487 % END RECEIVE ORGTBL salesfigures
13491 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
13492 | Month | Days | Nr sold | per day |
13493 |-------+------+---------+---------|
13494 | Jan | 23 | 55 | 2.4 |
13495 | Feb | 21 | 16 | 0.8 |
13496 | March | 22 | 278 | 12.6 |
13497 #+TBLFM: $4=$3/$2;%.1f
13501 The La@TeX{} translator function @code{orgtbl-to-latex} is already part of
13502 Orgtbl mode. It uses a @code{tabular} environment to typeset the table
13503 and marks horizontal lines with @code{\hline}. Furthermore, it
13504 interprets the following parameters (see also @pxref{Translator functions}):
13507 @item :splice nil/t
13508 When set to t, return only table body lines, don't wrap them into a
13509 tabular environment. Default is nil.
13512 A format to be used to wrap each field, it should contain @code{%s} for the
13513 original field value. For example, to wrap each field value in dollars,
13514 you could use @code{:fmt "$%s$"}. This may also be a property list with
13515 column numbers and formats. for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
13516 A function of one argument can be used in place of the strings; the
13517 function must return a formatted string.
13520 Use this format to print numbers with exponentials. The format should
13521 have @code{%s} twice for inserting mantissa and exponent, for example
13522 @code{"%s\\times10^@{%s@}"}. The default is @code{"%s\\,(%s)"}. This
13523 may also be a property list with column numbers and formats, for example
13524 @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After
13525 @code{efmt} has been applied to a value, @code{fmt} will also be
13526 applied. Similar to @code{fmt}, functions of two arguments can be
13527 supplied instead of strings.
13530 @node Translator functions, Radio lists, A LaTeX example, Tables in arbitrary syntax
13531 @subsection Translator functions
13532 @cindex HTML, and Orgtbl mode
13533 @cindex translator function
13535 Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
13536 (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
13537 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and @code{orgtbl-to-texinfo}.
13538 Except for @code{orgtbl-to-html}@footnote{The HTML translator uses the same
13539 code that produces tables during HTML export.}, these all use a generic
13540 translator, @code{orgtbl-to-generic}. For example, @code{orgtbl-to-latex}
13541 itself is a very short function that computes the column definitions for the
13542 @code{tabular} environment, defines a few field and line separators and then
13543 hands processing over to the generic translator. Here is the entire code:
13547 (defun orgtbl-to-latex (table params)
13548 "Convert the Orgtbl mode TABLE to LaTeX."
13549 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
13550 org-table-last-alignment ""))
13553 :tstart (concat "\\begin@{tabular@}@{" alignment "@}")
13554 :tend "\\end@{tabular@}"
13555 :lstart "" :lend " \\\\" :sep " & "
13556 :efmt "%s\\,(%s)" :hline "\\hline")))
13557 (orgtbl-to-generic table (org-combine-plists params2 params))))
13561 As you can see, the properties passed into the function (variable
13562 @var{PARAMS}) are combined with the ones newly defined in the function
13563 (variable @var{PARAMS2}). The ones passed into the function (i.e. the
13564 ones set by the @samp{ORGTBL SEND} line) take precedence. So if you
13565 would like to use the La@TeX{} translator, but wanted the line endings to
13566 be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
13567 overrule the default with
13570 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
13573 For a new language, you can either write your own converter function in
13574 analogy with the La@TeX{} translator, or you can use the generic function
13575 directly. For example, if you have a language where a table is started
13576 with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are
13577 started with @samp{!BL!}, ended with @samp{!EL!}, and where the field
13578 separator is a TAB, you could call the generic translator like this (on
13582 #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
13583 :lstart "!BL! " :lend " !EL!" :sep "\t"
13587 Please check the documentation string of the function
13588 @code{orgtbl-to-generic} for a full list of parameters understood by
13589 that function, and remember that you can pass each of them into
13590 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
13591 using the generic function.
13593 Of course you can also write a completely new function doing complicated
13594 things the generic translator cannot do. A translator function takes
13595 two arguments. The first argument is the table, a list of lines, each
13596 line either the symbol @code{hline} or a list of fields. The second
13597 argument is the property list containing all parameters specified in the
13598 @samp{#+ORGTBL: SEND} line. The function must return a single string
13599 containing the formatted table. If you write a generally useful
13600 translator, please post it on @email{emacs-orgmode@@gnu.org} so that
13601 others can benefit from your work.
13603 @node Radio lists, , Translator functions, Tables in arbitrary syntax
13604 @subsection Radio lists
13605 @cindex radio lists
13606 @cindex org-list-insert-radio-list
13608 Sending and receiving radio lists works exactly the same way than sending and
13609 receiving radio tables (@pxref{Radio tables}). As for radio tables, you can
13610 insert radio lists templates in HTML, La@TeX{} and Texinfo modes by calling
13611 @code{org-list-insert-radio-list}.
13613 Here are the differences with radio tables:
13617 Orgstruct mode must be active.
13619 Use the @code{ORGLST} keyword instead of @code{ORGTBL}.
13621 The available translation functions for radio lists don't take
13624 @kbd{C-c C-c} will work when pressed on the first item of the list.
13627 Here is a La@TeX{} example. Let's say that you have this in your
13632 % BEGIN RECEIVE ORGLST to-buy
13633 % END RECEIVE ORGLST to-buy
13635 #+ORGLST: SEND to-buy org-list-to-latex
13644 Pressing `C-c C-c' on @code{a new house} and will insert the converted
13645 La@TeX{} list between the two marker lines.
13647 @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Hacking
13648 @section Dynamic blocks
13649 @cindex dynamic blocks
13651 Org documents can contain @emph{dynamic blocks}. These are
13652 specially marked regions that are updated by some user-written function.
13653 A good example for such a block is the clock table inserted by the
13654 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
13656 Dynamic block are enclosed by a BEGIN-END structure that assigns a name
13657 to the block and can also specify parameters for the function producing
13658 the content of the block.
13660 #+BEGIN:dynamic block
13662 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
13667 Dynamic blocks are updated with the following commands
13670 @kindex C-c C-x C-u
13672 Update dynamic block at point.
13673 @kindex C-u C-c C-x C-u
13674 @item C-u C-c C-x C-u
13675 Update all dynamic blocks in the current file.
13678 Updating a dynamic block means to remove all the text between BEGIN and
13679 END, parse the BEGIN line for parameters and then call the specific
13680 writer function for this block to insert the new content. If you want
13681 to use the original content in the writer function, you can use the
13682 extra parameter @code{:content}.
13684 For a block with name @code{myblock}, the writer function is
13685 @code{org-dblock-write:myblock} with as only parameter a property list
13686 with the parameters given in the begin line. Here is a trivial example
13687 of a block that keeps track of when the block update function was last
13691 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
13697 The corresponding block writer function could look like this:
13700 (defun org-dblock-write:block-update-time (params)
13701 (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
13702 (insert "Last block update at: "
13703 (format-time-string fmt (current-time)))))
13706 If you want to make sure that all dynamic blocks are always up-to-date,
13707 you could add the function @code{org-update-all-dblocks} to a hook, for
13708 example @code{before-save-hook}. @code{org-update-all-dblocks} is
13709 written in a way such that it does nothing in buffers that are not in
13712 @node Special agenda views, Extracting agenda information, Dynamic blocks, Hacking
13713 @section Special agenda views
13714 @cindex agenda views, user-defined
13716 Org provides a special hook that can be used to narrow down the
13717 selection made by any of the agenda views. You may specify a function
13718 that is used at each match to verify if the match should indeed be part
13719 of the agenda view, and if not, how much should be skipped.
13721 Let's say you want to produce a list of projects that contain a WAITING
13722 tag anywhere in the project tree. Let's further assume that you have
13723 marked all tree headings that define a project with the TODO keyword
13724 PROJECT. In this case you would run a TODO search for the keyword
13725 PROJECT, but skip the match unless there is a WAITING tag anywhere in
13726 the subtree belonging to the project line.
13728 To achieve this, you must write a function that searches the subtree for
13729 the tag. If the tag is found, the function must return @code{nil} to
13730 indicate that this match should not be skipped. If there is no such
13731 tag, return the location of the end of the subtree, to indicate that
13732 search should continue from there.
13735 (defun my-skip-unless-waiting ()
13736 "Skip trees that are not waiting"
13737 (let ((subtree-end (save-excursion (org-end-of-subtree t))))
13738 (if (re-search-forward ":waiting:" subtree-end t)
13739 nil ; tag found, do not skip
13740 subtree-end))) ; tag not found, continue after end of subtree
13743 Now you may use this function in an agenda custom command, for example
13747 (org-add-agenda-custom-command
13748 '("b" todo "PROJECT"
13749 ((org-agenda-skip-function 'my-skip-unless-waiting)
13750 (org-agenda-overriding-header "Projects waiting for something: "))))
13753 @vindex org-agenda-overriding-header
13754 Note that this also binds @code{org-agenda-overriding-header} to get a
13755 meaningful header in the agenda view.
13757 @vindex org-odd-levels-only
13758 @vindex org-agenda-skip-function
13759 A general way to create custom searches is to base them on a search for
13760 entries with a certain level limit. If you want to study all entries with
13761 your custom search function, simply do a search for
13762 @samp{LEVEL>0}@footnote{Note that, when using @code{org-odd-levels-only}, a
13763 level number corresponds to order in the hierarchy, not to the number of
13764 stars.}, and then use @code{org-agenda-skip-function} to select the entries
13765 you really want to have.
13767 You may also put a Lisp form into @code{org-agenda-skip-function}. In
13768 particular, you may use the functions @code{org-agenda-skip-entry-if}
13769 and @code{org-agenda-skip-subtree-if} in this form, for example:
13772 @item '(org-agenda-skip-entry-if 'scheduled)
13773 Skip current entry if it has been scheduled.
13774 @item '(org-agenda-skip-entry-if 'notscheduled)
13775 Skip current entry if it has not been scheduled.
13776 @item '(org-agenda-skip-entry-if 'deadline)
13777 Skip current entry if it has a deadline.
13778 @item '(org-agenda-skip-entry-if 'scheduled 'deadline)
13779 Skip current entry if it has a deadline, or if it is scheduled.
13780 @item '(org-agenda-skip-entry-if 'todo '("TODO" "WAITING"))
13781 Skip current entry if the TODO keyword is TODO or WAITING.
13782 @item '(org-agenda-skip-entry-if 'todo 'done)
13783 Skip current entry if the TODO keyword marks a DONE state.
13784 @item '(org-agenda-skip-entry-if 'timestamp)
13785 Skip current entry if it has any timestamp, may also be deadline or scheduled.
13786 @item '(org-agenda-skip-entry 'regexp "regular expression")
13787 Skip current entry if the regular expression matches in the entry.
13788 @item '(org-agenda-skip-entry 'notregexp "regular expression")
13789 Skip current entry unless the regular expression matches.
13790 @item '(org-agenda-skip-subtree-if 'regexp "regular expression")
13791 Same as above, but check and skip the entire subtree.
13794 Therefore we could also have written the search for WAITING projects
13795 like this, even without defining a special function:
13798 (org-add-agenda-custom-command
13799 '("b" todo "PROJECT"
13800 ((org-agenda-skip-function '(org-agenda-skip-subtree-if
13801 'regexp ":waiting:"))
13802 (org-agenda-overriding-header "Projects waiting for something: "))))
13805 @node Extracting agenda information, Using the property API, Special agenda views, Hacking
13806 @section Extracting agenda information
13807 @cindex agenda, pipe
13808 @cindex Scripts, for agenda processing
13810 @vindex org-agenda-custom-commands
13811 Org provides commands to access agenda information for the command
13812 line in Emacs batch mode. This extracted information can be sent
13813 directly to a printer, or it can be read by a program that does further
13814 processing of the data. The first of these commands is the function
13815 @code{org-batch-agenda}, that produces an agenda view and sends it as
13816 ASCII text to STDOUT. The command takes a single string as parameter.
13817 If the string has length 1, it is used as a key to one of the commands
13818 you have configured in @code{org-agenda-custom-commands}, basically any
13819 key you can use after @kbd{C-c a}. For example, to directly print the
13820 current TODO list, you could use
13823 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
13826 If the parameter is a string with 2 or more characters, it is used as a
13827 tags/TODO match string. For example, to print your local shopping list
13828 (all items with the tag @samp{shop}, but excluding the tag
13829 @samp{NewYork}), you could use
13832 emacs -batch -l ~/.emacs \
13833 -eval '(org-batch-agenda "+shop-NewYork")' | lpr
13837 You may also modify parameters on the fly like this:
13840 emacs -batch -l ~/.emacs \
13841 -eval '(org-batch-agenda "a" \
13842 org-agenda-ndays 30 \
13843 org-agenda-include-diary nil \
13844 org-agenda-files (quote ("~/org/project.org")))' \
13849 which will produce a 30-day agenda, fully restricted to the Org file
13850 @file{~/org/projects.org}, not even including the diary.
13852 If you want to process the agenda data in more sophisticated ways, you
13853 can use the command @code{org-batch-agenda-csv} to get a comma-separated
13854 list of values for each agenda item. Each line in the output will
13855 contain a number of fields separated by commas. The fields in a line
13859 category @r{The category of the item}
13860 head @r{The headline, without TODO keyword, TAGS and PRIORITY}
13861 type @r{The type of the agenda entry, can be}
13862 todo @r{selected in TODO match}
13863 tagsmatch @r{selected in tags match}
13864 diary @r{imported from diary}
13865 deadline @r{a deadline}
13866 scheduled @r{scheduled}
13867 timestamp @r{appointment, selected by timestamp}
13868 closed @r{entry was closed on date}
13869 upcoming-deadline @r{warning about nearing deadline}
13870 past-scheduled @r{forwarded scheduled item}
13871 block @r{entry has date block including date}
13872 todo @r{The TODO keyword, if any}
13873 tags @r{All tags including inherited ones, separated by colons}
13874 date @r{The relevant date, like 2007-2-14}
13875 time @r{The time, like 15:00-16:50}
13876 extra @r{String with extra planning info}
13877 priority-l @r{The priority letter if any was given}
13878 priority-n @r{The computed numerical priority}
13882 Time and date will only be given if a timestamp (or deadline/scheduled)
13883 led to the selection of the item.
13885 A CSV list like this is very easy to use in a post-processing script.
13886 For example, here is a Perl program that gets the TODO list from
13887 Emacs/Org and prints all the items, preceded by a checkbox:
13892 # define the Emacs command to run
13893 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
13895 # run it and capture the output
13896 $agenda = qx@{$cmd 2>/dev/null@};
13898 # loop over all lines
13899 foreach $line (split(/\n/,$agenda)) @{
13900 # get the individual values
13901 ($category,$head,$type,$todo,$tags,$date,$time,$extra,
13902 $priority_l,$priority_n) = split(/,/,$line);
13903 # process and print
13904 print "[ ] $head\n";
13908 @node Using the property API, Using the mapping API, Extracting agenda information, Hacking
13909 @section Using the property API
13910 @cindex API, for properties
13911 @cindex properties, API
13913 Here is a description of the functions that can be used to work with
13916 @defun org-entry-properties &optional pom which
13917 Get all properties of the entry at point-or-marker POM.@*
13918 This includes the TODO keyword, the tags, time strings for deadline,
13919 scheduled, and clocking, and any additional properties defined in the
13920 entry. The return value is an alist, keys may occur multiple times
13921 if the property key was used several times.@*
13922 POM may also be nil, in which case the current entry is used.
13923 If WHICH is nil or `all', get all properties. If WHICH is
13924 `special' or `standard', only get that subclass.
13926 @vindex org-use-property-inheritance
13927 @defun org-entry-get pom property &optional inherit
13928 Get value of PROPERTY for entry at point-or-marker POM. By default,
13929 this only looks at properties defined locally in the entry. If INHERIT
13930 is non-nil and the entry does not have the property, then also check
13931 higher levels of the hierarchy. If INHERIT is the symbol
13932 @code{selective}, use inheritance if and only if the setting of
13933 @code{org-use-property-inheritance} selects PROPERTY for inheritance.
13936 @defun org-entry-delete pom property
13937 Delete the property PROPERTY from entry at point-or-marker POM.
13940 @defun org-entry-put pom property value
13941 Set PROPERTY to VALUE for entry at point-or-marker POM.
13944 @defun org-buffer-property-keys &optional include-specials
13945 Get all property keys in the current buffer.
13948 @defun org-insert-property-drawer
13949 Insert a property drawer at point.
13952 @defun org-entry-put-multivalued-property pom property &rest values
13953 Set PROPERTY at point-or-marker POM to VALUES. VALUES should be a list of
13954 strings. They will be concatenated, with spaces as separators.
13957 @defun org-entry-get-multivalued-property pom property
13958 Treat the value of the property PROPERTY as a whitespace-separated list of
13959 values and return the values as a list of strings.
13962 @defun org-entry-add-to-multivalued-property pom property value
13963 Treat the value of the property PROPERTY as a whitespace-separated list of
13964 values and make sure that VALUE is in this list.
13967 @defun org-entry-remove-from-multivalued-property pom property value
13968 Treat the value of the property PROPERTY as a whitespace-separated list of
13969 values and make sure that VALUE is @emph{not} in this list.
13972 @defun org-entry-member-in-multivalued-property pom property value
13973 Treat the value of the property PROPERTY as a whitespace-separated list of
13974 values and check if VALUE is in this list.
13977 @defopt org-property-allowed-value-functions
13978 Hook for functions supplying allowed values for specific.
13979 The functions must take a single argument, the name of the property, and
13980 return a flat list of allowed values. If @samp{:ETC} is one of
13981 the values, use the values as completion help, but allow also other values
13982 to be entered. The functions must return @code{nil} if they are not
13983 responsible for this property.
13986 @node Using the mapping API, , Using the property API, Hacking
13987 @section Using the mapping API
13988 @cindex API, for mapping
13989 @cindex mapping entries, API
13991 Org has sophisticated mapping capabilities to find all entries satisfying
13992 certain criteria. Internally, this functionality is used to produce agenda
13993 views, but there is also an API that can be used to execute arbitrary
13994 functions for each or selected entries. The main entry point for this API
13997 @defun org-map-entries func &optional match scope &rest skip
13998 Call FUNC at each headline selected by MATCH in SCOPE.
14000 FUNC is a function or a Lisp form. The function will be called without
14001 arguments, with the cursor positioned at the beginning of the headline.
14002 The return values of all calls to the function will be collected and
14003 returned as a list.
14005 The call to FUNC will be wrapped into a save-excursion form, so FUNC
14006 does not need to preserve point. After evaluation, the cursor will be
14007 moved to the end of the line (presumably of the headline of the
14008 processed entry) and search continues from there. Under some
14009 circumstances, this may not produce the wanted results. For example,
14010 if you have removed (e.g. archived) the current (sub)tree it could
14011 mean that the next entry will be skipped entirely. In such cases, you
14012 can specify the position from where search should continue by making
14013 FUNC set the variable `org-map-continue-from' to the desired buffer
14016 MATCH is a tags/property/todo match as it is used in the agenda match view.
14017 Only headlines that are matched by this query will be considered during
14018 the iteration. When MATCH is nil or t, all headlines will be
14019 visited by the iteration.
14021 SCOPE determines the scope of this command. It can be any of:
14024 nil @r{the current buffer, respecting the restriction if any}
14025 tree @r{the subtree started with the entry at point}
14026 file @r{the current buffer, without restriction}
14028 @r{the current buffer, and any archives associated with it}
14029 agenda @r{all agenda files}
14030 agenda-with-archives
14031 @r{all agenda files with any archive files associated with them}
14033 @r{if this is a list, all files in the list will be scanned}
14036 The remaining args are treated as settings for the skipping facilities of
14037 the scanner. The following items can be given here:
14039 @vindex org-agenda-skip-function
14041 archive @r{skip trees with the archive tag}
14042 comment @r{skip trees with the COMMENT keyword}
14043 function or Lisp form
14044 @r{will be used as value for @code{org-agenda-skip-function},}
14045 @r{so whenever the function returns t, FUNC}
14046 @r{will not be called for that entry and search will}
14047 @r{continue from the point where the function leaves it}
14051 The function given to that mapping routine can really do anything you like.
14052 It can use the property API (@pxref{Using the property API}) to gather more
14053 information about the entry, or in order to change metadata in the entry.
14054 Here are a couple of functions that might be handy:
14056 @defun org-todo &optional arg
14057 Change the TODO state of the entry, see the docstring of the functions for
14058 the many possible values for the argument ARG.
14061 @defun org-priority &optional action
14062 Change the priority of the entry, see the docstring of this function for the
14063 possible values for ACTION.
14066 @defun org-toggle-tag tag &optional onoff
14067 Toggle the tag TAG in the current entry. Setting ONOFF to either @code{on}
14068 or @code{off} will not toggle tag, but ensure that it is either on or off.
14072 Promote the current entry.
14076 Demote the current entry.
14079 Here is a simple example that will turn all entries in the current file with
14080 a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
14081 Entries in comment trees and in archive trees will be ignored.
14085 '(org-todo "UPCOMING")
14086 "+TOMORROW" 'file 'archive 'comment)
14089 The following example counts the number of entries with TODO keyword
14090 @code{WAITING}, in all agenda files.
14093 (length (org-map-entries t "/+WAITING" 'agenda))
14096 @node MobileOrg, History and Acknowledgments, Hacking, Top
14097 @appendix MobileOrg
14101 @uref{http://mobileorg.ncogni.to/, MobileOrg} is an application for the
14102 @i{iPhone/iPod Touch} series of devices, developed by Richard Moreland.
14103 @i{MobileOrg} offers offline viewing and capture support for an Org-mode
14104 system rooted on a ``real'' computer. It does also allow you to record
14105 changes to existing entries. Android users should check out
14106 @uref{http://wiki.github.com/matburt/mobileorg-android/, MobileOrg Android}
14109 This appendix describes the support Org has for creating agenda views in a
14110 format that can be displayed by @i{MobileOrg}, and for integrating notes
14111 captured and changes made by @i{MobileOrg} into the main system.
14113 For changing tags and TODO states in MobileOrg, you should have set up the
14114 customization variables @code{org-todo-keywords} and @code{org-tags-alist} to
14115 cover all important tags and TODO keywords, even if individual files use only
14116 part of these. MobileOrg will also offer you states and tags set up with
14117 in-buffer settings, but it will understand the logistics of TODO state
14118 @i{sets} (@pxref{Per-file keywords}) and @i{mutually exclusive} tags
14119 (@pxref{Setting tags}) only for those set in these variables.
14122 * Setting up the staging area:: Where to interact with the mobile device
14123 * Pushing to MobileOrg:: Uploading Org files and agendas
14124 * Pulling from MobileOrg:: Integrating captured and flagged items
14127 @node Setting up the staging area, Pushing to MobileOrg, MobileOrg, MobileOrg
14128 @section Setting up the staging area
14130 MobileOrg needs to interact with Emacs through directory on a
14131 server@footnote{If you are using a public server, you might prefer to encrypt
14132 the files on the server. This can be done with Org-mode 6.35 and, hopefully,
14133 with MobileOrg 1.4 (please check before trying to use this). On the Emacs
14134 side, configure the variables @code{org-mobile-use-encryption} and
14135 @code{org-mobile-encryption-password}.}. The easiest way to create that
14136 directory is to use a free @uref{http://dropbox.com,Dropbox.com}
14137 account@footnote{If you cannot use Dropbox, or if your version of MobileOrg
14138 does not support it, you can use a webdav server. For more information,
14139 check out the the documentation of MobileOrg and also this
14140 @uref{http://orgmode.org/worg/org-faq.php#mobileorg_webdav, FAQ entry}.}.
14141 When MobileOrg first connects to your Dropbox, it will create a directory
14142 @i{MobileOrg} inside the Dropbox. After the directory has been created, tell
14146 (setq org-mobile-directory "~/Dropbox/MobileOrg")
14149 Org-mode has commands to put files for @i{MobileOrg} into that directory,
14150 and to read captured notes from there.
14152 @node Pushing to MobileOrg, Pulling from MobileOrg, Setting up the staging area, MobileOrg
14153 @section Pushing to MobileOrg
14155 This operation copies all files currently listed in @code{org-mobile-files}
14156 to the directory @code{org-mobile-directory}. By default this list contains
14157 all agenda files (as listed in @code{org-agenda-files}), but additional files
14158 can be included by customizing @code{org-mobiles-files}. File names will be
14159 staged with path relative to @code{org-directory}, so all files should be
14160 inside this directory. The push operation also creates a special Org file
14161 @file{agendas.org} with all custom agenda view defined by the
14162 user@footnote{While creating the agendas, Org-mode will force (see the
14163 variable @code{org-mobile-force-id-on-agenda-items}) ID properties on all
14164 referenced entries, so that these entries can be uniquely
14165 identified if @i{MobileOrg} flags them for further action.}. Finally, Org
14166 writes the file @file{index.org}, containing links to all other files.
14167 @i{MobileOrg} first reads this file from the server, and then downloads all
14168 agendas and Org files listed in it. To speed up the download, MobileOrg will
14169 only read files whose checksums@footnote{stored automatically in the file
14170 @file{checksums.dat}} have changed.
14172 @node Pulling from MobileOrg, , Pushing to MobileOrg, MobileOrg
14173 @section Pulling from MobileOrg
14175 When @i{MobileOrg} synchronizes with the server, it not only pulls the Org
14176 files for viewing. It also appends captured entries and pointers to flagged
14177 and changed entries to the file @file{mobileorg.org} on the server. Org has
14178 a @emph{pull} operation that integrates this information into an inbox file
14179 and operates on the pointers to flagged entries. Here is how it works:
14183 Org moves all entries found in
14184 @file{mobileorg.org}@footnote{@file{mobileorg.org} will be empty after this
14185 operation.} and appends them to the file pointed to by the variable
14186 @code{org-mobile-inbox-for-pull}. Each captured entry and each editing event
14187 will be a top-level entry in the inbox file.
14189 After moving the entries, Org will attempt to implement the changes made in
14190 @i{MobileOrg}. Some changes are applied directly and without user
14191 interaction. Examples are all changes to tags, TODO state, headline and body
14192 text that can be cleanly applied. Entries that have been flagged for further
14193 action will receive a tag @code{:FLAGGED:}, so that they can be easily found
14194 again. When there is a problem finding an entry or applying the change, the
14195 pointer entry will remain in the inbox and will be marked with an error
14196 message. You need to later resolve these issues by hand.
14198 Org will then generate an agenda view with all flagged entries. The user
14199 should then go through these entries and do whatever actions are necessary.
14200 If a note has been stored while flagging an entry in @i{MobileOrg}, that note
14201 will be displayed in the echo area when the cursor is on the corresponding
14206 Pressing @kbd{?} in that special agenda will display the full flagging note in
14207 another window and also push it onto the kill ring. So you could use @kbd{?
14208 z C-y C-c C-c} to store that flagging note as a normal note in the entry.
14209 Pressing @kbd{?} twice in succession will offer to remove the
14210 @code{:FLAGGED:} tag along with the recorded flagging note (which is stored
14211 in a property). In this way you indicate, that the intended processing for
14212 this flagged entry is finished.
14217 If you are not able to process all flagged entries directly, you can always
14218 return to this agenda view using @kbd{C-c a ?}. Note, however, that there is
14219 a subtle difference. The view created automatically by @kbd{M-x
14220 org-mobile-pull @key{RET}} is guaranteed to search all files that have been
14221 addressed by the last pull. This might include a file that is not currently
14222 in your list of agenda files. If you later use @kbd{C-c a ?} to regenerate
14223 the view, only the current agenda files will be searched.
14225 @node History and Acknowledgments, Main Index, MobileOrg, Top
14226 @appendix History and acknowledgments
14227 @cindex acknowledgments
14231 Org was born in 2003, out of frustration over the user interface of the Emacs
14232 Outline mode. I was trying to organize my notes and projects, and using
14233 Emacs seemed to be the natural way to go. However, having to remember eleven
14234 different commands with two or three keys per command, only to hide and show
14235 parts of the outline tree, that seemed entirely unacceptable to me. Also,
14236 when using outlines to take notes, I constantly wanted to restructure the
14237 tree, organizing it parallel to my thoughts and plans. @emph{Visibility
14238 cycling} and @emph{structure editing} were originally implemented in the
14239 package @file{outline-magic.el}, but quickly moved to the more general
14240 @file{org.el}. As this environment became comfortable for project planning,
14241 the next step was adding @emph{TODO entries}, basic @emph{timestamps}, and
14242 @emph{table support}. These areas highlighted the two main goals that Org
14243 still has today: to be a new, outline-based, plain text mode with innovative
14244 and intuitive editing features, and to incorporate project planning
14245 functionality directly into a notes file.
14247 Since the first release, literally thousands of emails to me or to
14248 @email{emacs-orgmode@@gnu.org} have provided a constant stream of bug
14249 reports, feedback, new ideas, and sometimes patches and add-on code.
14250 Many thanks to everyone who has helped to improve this package. I am
14251 trying to keep here a list of the people who had significant influence
14252 in shaping one or more aspects of Org. The list may not be
14253 complete, if I have forgotten someone, please accept my apologies and
14256 Before I get to this list, a few special mentions are in order:
14259 @item Bastien Guerry
14260 Bastien has written a large number of extensions to Org (most of them
14261 integrated into the core by now), including the LaTeX exporter and the plain
14262 list parser. His support during the early days, when he basically acted as
14263 co-maintainer, was central to the success of this project. Bastien also
14264 invented Worg, helped establishing the Web presence of Org, and sponsors
14265 hosting costs for the orgmode.org website.
14266 @item Eric Schulte and Dan Davison
14267 Eric and Dan are jointly responsible for the Org-babel system, which turns
14268 Org into a multi-language environment for evaluating code and doing literate
14269 programming and reproducible research.
14271 John has also contributed a number of great ideas and patches
14272 directly to Org, including the attachment system (@file{org-attach.el}),
14273 integration with Apple Mail (@file{org-mac-message.el}), hierarchical
14274 dependencies of TODO items, habit tracking (@file{org-habits.el}), and
14275 encryption (@file{org-crypt.el}). Also, the capture system is really an
14276 extended copy of his great @file{remember.el}.
14277 @item Sebastian Rose
14278 Without Sebastian, the HTML/XHTML publishing of Org would be the pitiful work
14279 of an ignorant amateur. Sebastian has pushed this part of Org onto a much
14280 higher level. He also wrote @file{org-info.js}, a Java script for displaying
14281 webpages derived from Org using an Info-like or a folding interface with
14282 single-key navigation.
14285 @noindent OK, now to the full list of contributions! Again, please let me
14286 know what I am missing here!
14291 @i{Russel Adams} came up with the idea for drawers.
14293 @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
14295 @i{Christophe Bataillon} created the great unicorn logo that we use on the
14298 @i{Alex Bochannek} provided a patch for rounding timestamps.
14300 @i{Jan Böcker} wrote @file{org-docview.el}.
14302 @i{Brad Bozarth} showed how to pull RSS feed data into Org-mode files.
14304 @i{Tom Breton} wrote @file{org-choose.el}.
14306 @i{Charles Cave}'s suggestion sparked the implementation of templates
14307 for Remember, which are now templates for capture.
14309 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
14312 @i{Gregory Chernov} patched support for Lisp forms into table
14313 calculations and improved XEmacs compatibility, in particular by porting
14314 @file{nouline.el} to XEmacs.
14316 @i{Sacha Chua} suggested copying some linking code from Planner.
14318 @i{Baoqiu Cui} contributed the DocBook exporter.
14320 @i{Eddward DeVilla} proposed and tested checkbox statistics. He also
14321 came up with the idea of properties, and that there should be an API for
14324 @i{Nick Dokos} tracked down several nasty bugs.
14326 @i{Kees Dullemond} used to edit projects lists directly in HTML and so
14327 inspired some of the early development, including HTML export. He also
14328 asked for a way to narrow wide table columns.
14330 @i{Thomas S. Dye} contributed documentation on Worg and helped integrating
14331 the Org-Babel documentation into the manual.
14333 @i{Christian Egli} converted the documentation into Texinfo format,
14334 patched CSS formatting into the HTML exporter, and inspired the agenda.
14336 @i{David Emery} provided a patch for custom CSS support in exported
14339 @i{Nic Ferrier} contributed mailcap and XOXO support.
14341 @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
14343 @i{John Foerch} figured out how to make incremental search show context
14344 around a match in a hidden outline tree.
14346 @i{Raimar Finken} wrote @file{org-git-line.el}.
14348 @i{Mikael Fornius} works as a mailing list moderator.
14350 @i{Austin Frank} works as a mailing list moderator.
14352 @i{Niels Giesen} had the idea to automatically archive DONE trees.
14354 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
14356 @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
14357 task state change logging, and the clocktable. His clear explanations have
14358 been critical when we started to adopt the Git version control system.
14360 @i{Manuel Hermenegildo} has contributed various ideas, small fixes and
14363 @i{Phil Jackson} wrote @file{org-irc.el}.
14365 @i{Scott Jaderholm} proposed footnotes, control over whitespace between
14366 folded entries, and column view for properties.
14368 @i{Matt Jones} wrote @i{MobileOrg Android}.
14370 @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
14372 @i{Shidai Liu} ("Leo") asked for embedded La@TeX{} and tested it. He also
14373 provided frequent feedback and some patches.
14375 @i{Matt Lundin} has proposed last-row references for table formulas and named
14376 invisible anchors. He has also worked a lot on the FAQ.
14378 @i{David Maus} wrote @file{org-atom.el}, maintains the issues file for Org,
14379 and is a prolific contributor on the mailing list with competent replies,
14380 small fixes and patches.
14382 @i{Jason F. McBrayer} suggested agenda export to CSV format.
14384 @i{Max Mikhanosha} came up with the idea of refiling.
14386 @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
14389 @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
14392 @i{Richard Moreland} wrote @i{MobileOrg} for the iPhone.
14394 @i{Rick Moynihan} proposed allowing multiple TODO sequences in a file
14395 and being able to quickly restrict the agenda to a subtree.
14397 @i{Todd Neal} provided patches for links to Info files and Elisp forms.
14399 @i{Greg Newman} refreshed the unicorn logo into its current form.
14401 @i{Tim O'Callaghan} suggested in-file links, search options for general
14402 file links, and TAGS.
14404 @i{Osamu Okano} wrote @file{orgcard2ref.pl}, a perl program to create a text
14405 version of the reference card.
14407 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
14410 @i{Oliver Oppitz} suggested multi-state TODO items.
14412 @i{Scott Otterson} sparked the introduction of descriptive text for
14413 links, among other things.
14415 @i{Pete Phillips} helped during the development of the TAGS feature, and
14416 provided frequent feedback.
14418 @i{Martin Pohlack} provided the code snippet to bundle character insertion
14419 into bundles of 20 for undo.
14421 @i{T.V. Raman} reported bugs and suggested improvements.
14423 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
14426 @i{Paul Rivier} provided the basic implementation of named footnotes. He
14427 also acted as mailing list moderator for some time.
14429 @i{Kevin Rogers} contributed code to access VM files on remote hosts.
14431 @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
14432 conflict with @file{allout.el}.
14434 @i{Jason Riedy} generalized the send-receive mechanism for Orgtbl tables with
14437 @i{Philip Rooke} created the Org reference card, provided lots
14438 of feedback, developed and applied standards to the Org documentation.
14440 @i{Christian Schlauer} proposed angular brackets around links, among
14443 @i{Paul Sexton} wrote @file{org-ctags.el}.
14445 Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
14446 @file{organizer-mode.el}.
14448 @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal
14449 examples, and remote highlighting for referenced code lines.
14451 @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
14452 now packaged into Org's @file{contrib} directory.
14454 @i{Daniel Sinder} came up with the idea of internal archiving by locking
14457 @i{Dale Smith} proposed link abbreviations.
14459 @i{James TD Smith} has contributed a large number of patches for useful
14460 tweaks and features.
14462 @i{Adam Spiers} asked for global linking commands, inspired the link
14463 extension system, added support for mairix, and proposed the mapping API.
14465 @i{Ulf Stegemann} created the table to translate special symbols to HTML,
14466 LaTeX, UTF-8, Latin-1 and ASCII.
14468 @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content
14469 with links transformation to Org syntax.
14471 @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
14472 chapter about publishing.
14474 @i{Stefan Vollmar} organized a video-recorded talk at the
14475 Max-Planck-Institute for Neurology. He also inspired the creation of a
14476 concept index for HTML export.
14478 @i{J@"urgen Vollmer} contributed code generating the table of contents
14481 @i{Samuel Wales} has provided important feedback and bug reports.
14483 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
14486 @i{David Wainberg} suggested archiving, and improvements to the linking
14489 @i{Carsten Wimmer} suggested some changes and helped fix a bug in
14492 @i{Roland Winkler} requested additional key bindings to make Org
14495 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
14496 and contributed various ideas and code snippets.
14500 @node Main Index, Key Index, History and Acknowledgments, Top
14501 @unnumbered Concept index
14505 @node Key Index, Variable Index, Main Index, Top
14506 @unnumbered Key index
14510 @node Variable Index, , Key Index, Top
14511 @unnumbered Variable index
14513 This is not a complete index of variables and faces, only the ones that are
14514 mentioned in the manual. For a more complete list, use @kbd{M-x
14515 org-customize @key{RET}} and then click yourself through the tree.
14522 arch-tag: 7893d1Fe-cc57-4d13-b5e5-f494a1CBC7ac
14525 @c Local variables:
14530 @c LocalWords: webdavhost pre