4 @setfilename ../../info/org
5 @settitle The Org Manual
10 @c Use proper quote and backtick for code sections in PDF output
11 @c Cf. Texinfo manual 14.2
12 @set txicodequoteundirected
13 @set txicodequotebacktick
15 @c Version and Contact Info
16 @set MAINTAINERSITE @uref{http://orgmode.org,maintainers webpage}
17 @set AUTHOR Carsten Dominik
18 @set MAINTAINER Carsten Dominik
19 @set MAINTAINEREMAIL @email{carsten at orgmode dot org}
20 @set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer}
25 @macro orgcmd{key,command}
29 @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
34 @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
44 @c @hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed}
59 @c Subheadings inside a table.
60 @macro tsubheading{text}
70 This manual is for Org version @value{VERSION}.
72 Copyright @copyright{} 2004, 2005, 2006, 2007, 2008, 2009, 2010
73 Free Software Foundation, Inc.
76 Permission is granted to copy, distribute and/or modify this document
77 under the terms of the GNU Free Documentation License, Version 1.3 or
78 any later version published by the Free Software Foundation; with no
79 Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
80 and with the Back-Cover Texts as in (a) below. A copy of the license
81 is included in the section entitled ``GNU Free Documentation License.''
83 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
84 modify this GNU manual. Buying copies from the FSF supports it in
85 developing GNU and promoting software freedom.''
87 This document is part of a collection distributed under the GNU Free
88 Documentation License. If you want to distribute this document
89 separately from the collection, you can do so by adding a copy of the
90 license to the document, as described in section 6 of the license.
96 * Org Mode: (org). Outline-based notes management and organizer
100 @title The Org Manual
102 @subtitle Release @value{VERSION}
103 @author by Carsten Dominik
104 with contributions by David O'Toole, Bastien Guerry, Philip Rooke, Dan Davison, Eric Schulte, and Thomas Dye
106 @c The following two commands start the copyright page.
108 @vskip 0pt plus 1filll
112 @c Output the table of contents at the beginning.
116 @node Top, Introduction, (dir), (dir)
123 * Introduction:: Getting started
124 * Document Structure:: A tree works like your brain
125 * Tables:: Pure magic for quick formatting
126 * Hyperlinks:: Notes in context
127 * TODO Items:: Every tree branch can be a TODO item
128 * Tags:: Tagging headlines and matching sets of tags
129 * Properties and Columns:: Storing information about an entry
130 * Dates and Times:: Making items useful for planning
131 * Capture - Refile - Archive:: The ins and outs for projects
132 * Agenda Views:: Collecting information into views
133 * Markup:: Prepare text for rich export
134 * Exporting:: Sharing and publishing of notes
135 * Publishing:: Create a web site of linked Org files
136 * Working With Source Code:: Export, evaluate, and tangle code blocks
137 * Miscellaneous:: All the rest which did not fit elsewhere
138 * Hacking:: How to hack your way around
139 * MobileOrg:: Viewing and capture on a mobile device
140 * History and Acknowledgments:: How Org came into being
141 * Main Index:: An index of Org's concepts and features
142 * Key Index:: Key bindings and where they are described
143 * Command and Function Index:: Command names and some internal functions
144 * Variable Index:: Variables mentioned in the manual
147 --- The Detailed Node Listing ---
151 * Summary:: Brief summary of what Org does
152 * Installation:: How to install a downloaded version of Org
153 * Activation:: How to activate Org for certain buffers
154 * Feedback:: Bug reports, ideas, patches etc.
155 * Conventions:: Type-setting conventions in the manual
159 * Outlines:: Org is based on Outline mode
160 * Headlines:: How to typeset Org tree headlines
161 * Visibility cycling:: Show and hide, much simplified
162 * Motion:: Jumping to other headlines
163 * Structure editing:: Changing sequence and level of headlines
164 * Sparse trees:: Matches embedded in context
165 * Plain lists:: Additional structure within an entry
166 * Drawers:: Tucking stuff away
167 * Blocks:: Folding blocks
168 * Footnotes:: How footnotes are defined in Org's syntax
169 * Orgstruct mode:: Structure editing outside Org
173 * Built-in table editor:: Simple tables
174 * Column width and alignment:: Overrule the automatic settings
175 * Column groups:: Grouping to trigger vertical lines
176 * Orgtbl mode:: The table editor as minor mode
177 * The spreadsheet:: The table editor has spreadsheet capabilities
178 * Org-Plot:: Plotting from org tables
182 * References:: How to refer to another field or range
183 * Formula syntax for Calc:: Using Calc to compute stuff
184 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
185 * Field formulas:: Formulas valid for a single field
186 * Column formulas:: Formulas valid for an entire column
187 * Editing and debugging formulas:: Fixing formulas
188 * Updating the table:: Recomputing all dependent fields
189 * Advanced features:: Field names, parameters and automatic recalc
193 * Link format:: How links in Org are formatted
194 * Internal links:: Links to other places in the current file
195 * External links:: URL-like links to the world
196 * Handling links:: Creating, inserting and following
197 * Using links outside Org:: Linking from my C source code?
198 * Link abbreviations:: Shortcuts for writing complex links
199 * Search options:: Linking to a specific location
200 * Custom searches:: When the default search is not enough
204 * Radio targets:: Make targets trigger links in plain text
208 * TODO basics:: Marking and displaying TODO entries
209 * TODO extensions:: Workflow and assignments
210 * Progress logging:: Dates and notes for progress
211 * Priorities:: Some things are more important than others
212 * Breaking down tasks:: Splitting a task into manageable pieces
213 * Checkboxes:: Tick-off lists
215 Extended use of TODO keywords
217 * Workflow states:: From TODO to DONE in steps
218 * TODO types:: I do this, Fred does the rest
219 * Multiple sets in one file:: Mixing it all, and still finding your way
220 * Fast access to TODO states:: Single letter selection of a state
221 * Per-file keywords:: Different files, different requirements
222 * Faces for TODO keywords:: Highlighting states
223 * TODO dependencies:: When one task needs to wait for others
227 * Closing items:: When was this entry marked DONE?
228 * Tracking TODO state changes:: When did the status change?
229 * Tracking your habits:: How consistent have you been?
233 * Tag inheritance:: Tags use the tree structure of the outline
234 * Setting tags:: How to assign tags to a headline
235 * Tag searches:: Searching for combinations of tags
237 Properties and columns
239 * Property syntax:: How properties are spelled out
240 * Special properties:: Access to other Org-mode features
241 * Property searches:: Matching property values
242 * Property inheritance:: Passing values down the tree
243 * Column view:: Tabular viewing and editing
244 * Property API:: Properties for Lisp programmers
248 * Defining columns:: The COLUMNS format property
249 * Using column view:: How to create and use column view
250 * Capturing column view:: A dynamic block for column view
254 * Scope of column definitions:: Where defined, where valid?
255 * Column attributes:: Appearance and content of a column
259 * Timestamps:: Assigning a time to a tree entry
260 * Creating timestamps:: Commands which insert timestamps
261 * Deadlines and scheduling:: Planning your work
262 * Clocking work time:: Tracking how long you spend on a task
263 * Resolving idle time:: Resolving time if you've been idle
264 * Effort estimates:: Planning work effort in advance
265 * Relative timer:: Notes with a running timer
269 * The date/time prompt:: How Org-mode helps you entering date and time
270 * Custom time format:: Making dates look different
272 Deadlines and scheduling
274 * Inserting deadline/schedule:: Planning items
275 * Repeated tasks:: Items that show up again and again
277 Capture - Refile - Archive
279 * Capture:: Capturing new stuff
280 * Attachments:: Add files to tasks
281 * RSS Feeds:: Getting input from RSS feeds
282 * Protocols:: External (e.g. Browser) access to Emacs and Org
283 * Refiling notes:: Moving a tree from one place to another
284 * Archiving:: What to do with finished projects
288 * Setting up capture:: Where notes will be stored
289 * Using capture:: Commands to invoke and terminate capture
290 * Capture templates:: Define the outline of different note types
294 * Template elements:: What is needed for a complete template entry
295 * Template expansion:: Filling in information about time and context
299 * Moving subtrees:: Moving a tree to an archive file
300 * Internal archiving:: Switch off a tree but keep it in the file
304 * Agenda files:: Files being searched for agenda information
305 * Agenda dispatcher:: Keyboard access to agenda views
306 * Built-in agenda views:: What is available out of the box?
307 * Presentation and sorting:: How agenda items are prepared for display
308 * Agenda commands:: Remote editing of Org trees
309 * Custom agenda views:: Defining special searches and views
310 * Exporting Agenda Views:: Writing a view to a file
311 * Agenda column view:: Using column view for collected entries
313 The built-in agenda views
315 * Weekly/daily agenda:: The calendar page with current tasks
316 * Global TODO list:: All unfinished action items
317 * Matching tags and properties:: Structured information with fine-tuned search
318 * Timeline:: Time-sorted view for single file
319 * Search view:: Find entries by searching for text
320 * Stuck projects:: Find projects you need to review
322 Presentation and sorting
324 * Categories:: Not all tasks are equal
325 * Time-of-day specifications:: How the agenda knows the time
326 * Sorting of agenda items:: The order of things
330 * Storing searches:: Type once, use often
331 * Block agenda:: All the stuff you need in a single buffer
332 * Setting Options:: Changing the rules
334 Markup for rich export
336 * Structural markup elements:: The basic structure as seen by the exporter
337 * Images and tables:: Tables and Images will be included
338 * Literal examples:: Source code examples with special formatting
339 * Include files:: Include additional files into a document
340 * Index entries:: Making an index
341 * Macro replacement:: Use macros to create complex output
342 * Embedded LaTeX:: LaTeX can be freely used inside Org documents
344 Structural markup elements
346 * Document title:: Where the title is taken from
347 * Headings and sections:: The document structure as seen by the exporter
348 * Table of contents:: The if and where of the table of contents
349 * Initial text:: Text before the first heading?
351 * Paragraphs:: Paragraphs
352 * Footnote markup:: Footnotes
353 * Emphasis and monospace:: Bold, italic, etc.
354 * Horizontal rules:: Make a line
355 * Comment lines:: What will *not* be exported
359 * Special symbols:: Greek letters and other symbols
360 * Subscripts and superscripts:: Simple syntax for raising/lowering text
361 * LaTeX fragments:: Complex formulas made easy
362 * Previewing LaTeX fragments:: What will this snippet look like?
363 * CDLaTeX mode:: Speed up entering of formulas
367 * Selective export:: Using tags to select and exclude trees
368 * Export options:: Per-file export settings
369 * The export dispatcher:: How to access exporter commands
370 * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
371 * HTML export:: Exporting to HTML
372 * LaTeX and PDF export:: Exporting to La@TeX{}, and processing to PDF
373 * DocBook export:: Exporting to DocBook
374 * TaskJuggler export:: Exporting to TaskJuggler
375 * Freemind export:: Exporting to Freemind mind maps
376 * XOXO export:: Exporting to XOXO
377 * iCalendar export:: Exporting in iCalendar format
381 * HTML Export commands:: How to invoke HTML export
382 * Quoting HTML tags:: Using direct HTML in Org-mode
383 * Links in HTML export:: How links will be interpreted and formatted
384 * Tables in HTML export:: How to modify the formatting of tables
385 * Images in HTML export:: How to insert figures into HTML output
386 * Math formatting in HTML export:: Beautiful math also on the web
387 * Text areas in HTML export:: An alternative way to show an example
388 * CSS support:: Changing the appearance of the output
389 * JavaScript support:: Info and Folding in a web browser
391 La@TeX{} and PDF export
393 * LaTeX/PDF export commands:: Which key invokes which commands
394 * Header and sectioning:: Setting up the export file structure
395 * Quoting LaTeX code:: Incorporating literal La@TeX{} code
396 * Tables in LaTeX export:: Options for exporting tables to La@TeX{}
397 * Images in LaTeX export:: How to insert figures into La@TeX{} output
398 * Beamer class export:: Turning the file into a presentation
402 * DocBook export commands:: How to invoke DocBook export
403 * Quoting DocBook code:: Incorporating DocBook code in Org files
404 * Recursive sections:: Recursive sections in DocBook
405 * Tables in DocBook export:: Tables are exported as HTML tables
406 * Images in DocBook export:: How to insert figures into DocBook output
407 * Special characters:: How to handle special characters
411 * Configuration:: Defining projects
412 * Uploading files:: How to get files up on the server
413 * Sample configuration:: Example projects
414 * Triggering publication:: Publication commands
418 * Project alist:: The central configuration variable
419 * Sources and destinations:: From here to there
420 * Selecting files:: What files are part of the project?
421 * Publishing action:: Setting the function doing the publishing
422 * Publishing options:: Tweaking HTML export
423 * Publishing links:: Which links keep working after publishing?
424 * Sitemap:: Generating a list of all pages
425 * Generating an index:: An index that reaches across pages
429 * Simple example:: One-component publishing
430 * Complex example:: A multi-component publishing example
432 Working with source code
434 * Structure of code blocks:: Code block syntax described
435 * Editing source code:: Language major-mode editing
436 * Exporting code blocks:: Export contents and/or results
437 * Extracting source code:: Create pure source code files
438 * Evaluating code blocks:: Place results of evaluation in the Org-mode buffer
439 * Library of Babel:: Use and contribute to a library of useful code blocks
440 * Languages:: List of supported code block languages
441 * Header arguments:: Configure code block functionality
442 * Results of evaluation:: How evaluation results are handled
443 * Noweb reference syntax:: Literate programming in Org-mode
444 * Key bindings and useful functions:: Work quickly with code blocks
445 * Batch execution:: Call functions from the command line
449 * Using header arguments:: Different ways to set header arguments
450 * Specific header arguments:: List of header arguments
452 Using header arguments
454 * System-wide header arguments:: Set global default values
455 * Language-specific header arguments:: Set default values by language
456 * Buffer-wide header arguments:: Set default values for a specific buffer
457 * Header arguments in Org-mode properties:: Set default values for a buffer or heading
458 * Code block specific header arguments:: The most common way to set values
460 Specific header arguments
462 * var:: Pass arguments to code blocks
463 * results:: Specify the type of results and how they will
464 be collected and handled
465 * file:: Specify a path for file output
466 * dir:: Specify the default (possibly remote)
467 directory for code block execution
468 * exports:: Export code and/or results
469 * tangle:: Toggle tangling and specify file name
470 * comments:: Toggle insertion of comments in tangled
472 * no-expand:: Turn off variable assignment and noweb
473 expansion during tangling
474 * session:: Preserve the state of code evaluation
475 * noweb:: Toggle expansion of noweb references
476 * cache:: Avoid re-evaluating unchanged code blocks
477 * hlines:: Handle horizontal lines in tables
478 * colnames:: Handle column names in tables
479 * rownames:: Handle row names in tables
480 * shebang:: Make tangled files executable
481 * eval:: Limit evaluation of specific code blocks
485 * Completion:: M-TAB knows what you need
486 * Easy Templates:: Quick insertion of structural elements
487 * Speed keys:: Electric commands at the beginning of a headline
488 * Code evaluation security:: Org mode files evaluate inline code
489 * Customization:: Adapting Org to your taste
490 * In-buffer settings:: Overview of the #+KEYWORDS
491 * The very busy C-c C-c key:: When in doubt, press C-c C-c
492 * Clean view:: Getting rid of leading stars in the outline
493 * TTY keys:: Using Org on a tty
494 * Interaction:: Other Emacs packages
496 Interaction with other packages
498 * Cooperation:: Packages Org cooperates with
499 * Conflicts:: Packages that lead to conflicts
503 * Hooks:: Who to reach into Org's internals
504 * Add-on packages:: Available extensions
505 * Adding hyperlink types:: New custom link types
506 * Context-sensitive commands:: How to add functionality to such commands
507 * Tables in arbitrary syntax:: Orgtbl for La@TeX{} and other programs
508 * Dynamic blocks:: Automatically filled blocks
509 * Special agenda views:: Customized views
510 * Extracting agenda information:: Postprocessing of agenda information
511 * Using the property API:: Writing programs that use entry properties
512 * Using the mapping API:: Mapping over all or selected entries
514 Tables and lists in arbitrary syntax
516 * Radio tables:: Sending and receiving radio tables
517 * A LaTeX example:: Step by step, almost a tutorial
518 * Translator functions:: Copy and modify
519 * Radio lists:: Doing the same for lists
523 * Setting up the staging area:: Where to interact with the mobile device
524 * Pushing to MobileOrg:: Uploading Org files and agendas
525 * Pulling from MobileOrg:: Integrating captured and flagged items
530 @node Introduction, Document Structure, Top, Top
531 @chapter Introduction
535 * Summary:: Brief summary of what Org does
536 * Installation:: How to install a downloaded version of Org
537 * Activation:: How to activate Org for certain buffers
538 * Feedback:: Bug reports, ideas, patches etc.
539 * Conventions:: Type-setting conventions in the manual
542 @node Summary, Installation, Introduction, Introduction
546 Org is a mode for keeping notes, maintaining TODO lists, and doing
547 project planning with a fast and effective plain-text system.
549 Org develops organizational tasks around NOTES files that contain
550 lists or information about projects as plain text. Org is
551 implemented on top of Outline mode, which makes it possible to keep the
552 content of large files well structured. Visibility cycling and
553 structure editing help to work with the tree. Tables are easily created
554 with a built-in table editor. Org supports TODO items, deadlines,
555 timestamps, and scheduling. It dynamically compiles entries into an
556 agenda that utilizes and smoothly integrates much of the Emacs calendar
557 and diary. Plain text URL-like links connect to websites, emails,
558 Usenet messages, BBDB entries, and any files related to the projects.
559 For printing and sharing of notes, an Org file can be exported as a
560 structured ASCII file, as HTML, or (TODO and agenda items only) as an
561 iCalendar file. It can also serve as a publishing tool for a set of
564 As a project planning environment, Org works by adding metadata to outline
565 nodes. Based on this data, specific entries can be extracted in queries and
566 create dynamic @i{agenda views}.
568 Org mode contains the Org Babel environment which allows to work with
569 embedded source code block in a file, to facilitate code evaluation,
570 documentation, and tangling.
572 Org's automatic, context-sensitive table editor with spreadsheet
573 capabilities can be integrated into any major mode by activating the
574 minor Orgtbl mode. Using a translation step, it can be used to maintain
575 tables in arbitrary file types, for example in La@TeX{}. The structure
576 editing and list creation capabilities can be used outside Org with
577 the minor Orgstruct mode.
579 Org keeps simple things simple. When first fired up, it should
580 feel like a straightforward, easy to use outliner. Complexity is not
581 imposed, but a large amount of functionality is available when you need
582 it. Org is a toolbox and can be used in different ways and for different
586 @r{@bullet{} an outline extension with visibility cycling and structure editing}
587 @r{@bullet{} an ASCII system and table editor for taking structured notes}
588 @r{@bullet{} a TODO list editor}
589 @r{@bullet{} a full agenda and planner with deadlines and work scheduling}
590 @pindex GTD, Getting Things Done
591 @r{@bullet{} an environment in which to implement David Allen's GTD system}
592 @r{@bullet{} a simple hypertext system, with HTML and La@TeX{} export}
593 @r{@bullet{} a publishing tool to create a set of interlinked webpages}
594 @r{@bullet{} an environment for literate programming}
599 There is a website for Org which provides links to the newest
600 version of Org, as well as additional information, frequently asked
601 questions (FAQ), links to tutorials, etc@. This page is located at
602 @uref{http://orgmode.org}.
607 @node Installation, Activation, Summary, Introduction
608 @section Installation
612 @b{Important:} @i{If you are using a version of Org that is part of the Emacs
613 distribution or an XEmacs package, please skip this section and go directly
614 to @ref{Activation}.}
616 If you have downloaded Org from the Web, either as a distribution @file{.zip}
617 or @file{.tar} file, or as a Git archive, you must take the following steps
618 to install it: go into the unpacked Org distribution directory and edit the
619 top section of the file @file{Makefile}. You must set the name of the Emacs
620 binary (likely either @file{emacs} or @file{xemacs}), and the paths to the
621 directories where local Lisp and Info files are kept. If you don't have
622 access to the system-wide directories, you can simply run Org directly from
623 the distribution directory by adding the @file{lisp} subdirectory to the
624 Emacs load path. To do this, add the following line to @file{.emacs}:
627 (setq load-path (cons "~/path/to/orgdir/lisp" load-path))
631 If you plan to use code from the @file{contrib} subdirectory, do a similar
632 step for this directory:
635 (setq load-path (cons "~/path/to/orgdir/contrib/lisp" load-path))
638 @noindent Now byte-compile the Lisp files with the shell command:
644 @noindent If you are running Org from the distribution directory, this is
645 all. If you want to install Org into the system directories, use (as
652 Installing Info files is system dependent, because of differences in the
653 @file{install-info} program. In Debian it copies the info files into the
654 correct directory and modifies the info directory file. In many other
655 systems, the files need to be copied to the correct directory separately, and
656 @file{install-info} then only modifies the directory file. Check your system
657 documentation to find out which of the following commands you need:
661 make install-info-debian
664 Then add the following line to @file{.emacs}. It is needed so that
665 Emacs can autoload functions that are located in files not immediately loaded
666 when Org-mode starts.
668 (require 'org-install)
671 Do not forget to activate Org as described in the following section.
674 @node Activation, Feedback, Installation, Introduction
678 @cindex global key bindings
679 @cindex key bindings, global
681 Add the following lines to your @file{.emacs} file. The last three lines
682 define @emph{global} keys for the commands @command{org-store-link},
683 @command{org-agenda}, and @command{org-iswitchb}---please choose suitable
687 ;; The following lines are always needed. Choose your own keys.
688 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
689 (global-set-key "\C-cl" 'org-store-link)
690 (global-set-key "\C-ca" 'org-agenda)
691 (global-set-key "\C-cb" 'org-iswitchb)
694 Furthermore, you must activate @code{font-lock-mode} in Org
695 buffers, because significant functionality depends on font-locking being
696 active. You can do this with either one of the following two lines
697 (XEmacs users must use the second option):
699 (global-font-lock-mode 1) ; for all buffers
700 (add-hook 'org-mode-hook 'turn-on-font-lock) ; Org buffers only
703 @cindex Org-mode, turning on
704 With this setup, all files with extension @samp{.org} will be put
705 into Org-mode. As an alternative, make the first line of a file look
709 MY PROJECTS -*- mode: org; -*-
712 @vindex org-insert-mode-line-in-empty-file
713 @noindent which will select Org-mode for this buffer no matter what
714 the file's name is. See also the variable
715 @code{org-insert-mode-line-in-empty-file}.
717 Many commands in Org work on the region if the region is @i{active}. To make
718 use of this, you need to have @code{transient-mark-mode}
719 (@code{zmacs-regions} in XEmacs) turned on. In Emacs 23 this is the default,
720 in Emacs 22 you need to do this yourself with
722 (transient-mark-mode 1)
724 @noindent If you do not like @code{transient-mark-mode}, you can create an
725 active region by using the mouse to select a region, or pressing
726 @kbd{C-@key{SPC}} twice before moving the cursor.
728 @node Feedback, Conventions, Activation, Introduction
735 If you find problems with Org, or if you have questions, remarks, or ideas
736 about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}.
737 If you are not a member of the mailing list, your mail will be passed to the
738 list after a moderator has approved it@footnote{Please consider subscribing
739 to the mailing list, in order to minimize the work the mailing list
740 moderators have to do.}.
742 For bug reports, please first try to reproduce the bug with the latest
743 version of Org available - if you are running an outdated version, it is
744 quite possible that the bug has been fixed already. If the bug persists,
745 prepare a report and provide as much information as possible, including the
746 version information of Emacs (@kbd{M-x emacs-version @key{RET}}) and Org
747 (@kbd{M-x org-version @key{RET}}), as well as the Org related setup in
748 @file{.emacs}. The easiest way to do this is to use the command
750 @kbd{M-x org-submit-bug-report}
752 @noindent which will put all this information into an Emacs mail buffer so
753 that you only need to add your description. If you re not sending the Email
754 from within Emacs, please copy and paste the content into your Email program.
756 If an error occurs, a backtrace can be very useful (see below on how to
757 create one). Often a small example file helps, along with clear information
761 @item What exactly did you do?
762 @item What did you expect to happen?
763 @item What happened instead?
765 @noindent Thank you for helping to improve this program.
767 @subsubheading How to create a useful backtrace
769 @cindex backtrace of an error
770 If working with Org produces an error with a message you don't
771 understand, you may have hit a bug. The best way to report this is by
772 providing, in addition to what was mentioned above, a @emph{backtrace}.
773 This is information from the built-in debugger about where and how the
774 error occurred. Here is how to produce a useful backtrace:
778 Reload uncompiled versions of all Org-mode Lisp files. The backtrace
779 contains much more information if it is produced with uncompiled code.
782 C-u M-x org-reload RET
785 or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the
788 Go to the @code{Options} menu and select @code{Enter Debugger on Error}
789 (XEmacs has this option in the @code{Troubleshooting} sub-menu).
791 Do whatever you have to do to hit the error. Don't forget to
792 document the steps you take.
794 When you hit the error, a @file{*Backtrace*} buffer will appear on the
795 screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and
796 attach it to your bug report.
799 @node Conventions, , Feedback, Introduction
800 @section Typesetting conventions used in this manual
802 Org uses three types of keywords: TODO keywords, tags, and property
803 names. In this manual we use the following conventions:
808 TODO keywords are written with all capitals, even if they are
812 User-defined tags are written in lowercase; built-in tags with special
813 meaning are written with all capitals.
816 User-defined properties are capitalized; built-in properties with
817 special meaning are written with all capitals.
820 @node Document Structure, Tables, Introduction, Top
821 @chapter Document structure
822 @cindex document structure
823 @cindex structure of document
825 Org is based on Outline mode and provides flexible commands to
826 edit the structure of the document.
829 * Outlines:: Org is based on Outline mode
830 * Headlines:: How to typeset Org tree headlines
831 * Visibility cycling:: Show and hide, much simplified
832 * Motion:: Jumping to other headlines
833 * Structure editing:: Changing sequence and level of headlines
834 * Sparse trees:: Matches embedded in context
835 * Plain lists:: Additional structure within an entry
836 * Drawers:: Tucking stuff away
837 * Blocks:: Folding blocks
838 * Footnotes:: How footnotes are defined in Org's syntax
839 * Orgstruct mode:: Structure editing outside Org
842 @node Outlines, Headlines, Document Structure, Document Structure
847 Org is implemented on top of Outline mode. Outlines allow a
848 document to be organized in a hierarchical structure, which (at least
849 for me) is the best representation of notes and thoughts. An overview
850 of this structure is achieved by folding (hiding) large parts of the
851 document to show only the general document structure and the parts
852 currently being worked on. Org greatly simplifies the use of
853 outlines by compressing the entire show/hide functionality into a single
854 command, @command{org-cycle}, which is bound to the @key{TAB} key.
856 @node Headlines, Visibility cycling, Outlines, Document Structure
860 @vindex org-special-ctrl-a/e
861 @vindex org-special-ctrl-k
862 @vindex org-ctrl-k-protect-subtree
864 Headlines define the structure of an outline tree. The headlines in Org
865 start with one or more stars, on the left margin@footnote{See the variables
866 @code{org-special-ctrl-a/e}, @code{org-special-ctrl-k}, and
867 @code{org-ctrl-k-protect-subtree} to configure special behavior of @kbd{C-a},
868 @kbd{C-e}, and @kbd{C-k} in headlines.}. For example:
878 * Another top level headline
881 @noindent Some people find the many stars too noisy and would prefer an
882 outline that has whitespace followed by a single star as headline
883 starters. @ref{Clean view}, describes a setup to realize this.
885 @vindex org-cycle-separator-lines
886 An empty line after the end of a subtree is considered part of it and
887 will be hidden when the subtree is folded. However, if you leave at
888 least two empty lines, one empty line will remain visible after folding
889 the subtree, in order to structure the collapsed view. See the
890 variable @code{org-cycle-separator-lines} to modify this behavior.
892 @node Visibility cycling, Motion, Headlines, Document Structure
893 @section Visibility cycling
894 @cindex cycling, visibility
895 @cindex visibility cycling
896 @cindex trees, visibility
897 @cindex show hidden text
900 Outlines make it possible to hide parts of the text in the buffer.
901 Org uses just two commands, bound to @key{TAB} and
902 @kbd{S-@key{TAB}} to change the visibility in the buffer.
904 @cindex subtree visibility states
905 @cindex subtree cycling
906 @cindex folded, subtree visibility state
907 @cindex children, subtree visibility state
908 @cindex subtree, subtree visibility state
910 @orgcmd{@key{TAB},org-cycle}
911 @emph{Subtree cycling}: Rotate current subtree among the states
914 ,-> FOLDED -> CHILDREN -> SUBTREE --.
915 '-----------------------------------'
918 @vindex org-cycle-emulate-tab
919 @vindex org-cycle-global-at-bob
920 The cursor must be on a headline for this to work@footnote{see, however,
921 the option @code{org-cycle-emulate-tab}.}. When the cursor is at the
922 beginning of the buffer and the first line is not a headline, then
923 @key{TAB} actually runs global cycling (see below)@footnote{see the
924 option @code{org-cycle-global-at-bob}.}. Also when called with a prefix
925 argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
927 @cindex global visibility states
928 @cindex global cycling
929 @cindex overview, global visibility state
930 @cindex contents, global visibility state
931 @cindex show all, global visibility state
932 @orgcmd{S-@key{TAB},org-global-cycle}
934 @emph{Global cycling}: Rotate the entire buffer among the states
937 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
938 '--------------------------------------'
941 When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
942 CONTENTS view up to headlines of level N will be shown. Note that inside
943 tables, @kbd{S-@key{TAB}} jumps to the previous field.
945 @cindex show all, command
946 @orgcmd{C-u C-u C-u @key{TAB},show-all}
947 Show all, including drawers.
948 @orgcmd{C-c C-r,org-reveal}
949 Reveal context around point, showing the current entry, the following heading
950 and the hierarchy above. Useful for working near a location that has been
951 exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
952 (@pxref{Agenda commands}). With a prefix argument show, on each
953 level, all sibling headings. With double prefix arg, also show the entire
954 subtree of the parent.
955 @orgcmd{C-c C-k,show-branches}
956 Expose all the headings of the subtree, CONTENT view for just one subtree.
957 @orgcmd{C-c C-x b,org-tree-to-indirect-buffer}
958 Show the current subtree in an indirect buffer@footnote{The indirect
961 (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
964 (see the Emacs manual for more information about indirect buffers)
966 will contain the entire buffer, but will be narrowed to the current
967 tree. Editing the indirect buffer will also change the original buffer,
968 but without affecting visibility in that buffer.}. With a numeric
969 prefix argument N, go up to level N and then take that tree. If N is
970 negative then go up that many levels. With a @kbd{C-u} prefix, do not remove
971 the previously used indirect buffer.
974 @vindex org-startup-folded
975 @cindex @code{overview}, STARTUP keyword
976 @cindex @code{content}, STARTUP keyword
977 @cindex @code{showall}, STARTUP keyword
978 @cindex @code{showeverything}, STARTUP keyword
980 When Emacs first visits an Org file, the global state is set to
981 OVERVIEW, i.e. only the top level headlines are visible. This can be
982 configured through the variable @code{org-startup-folded}, or on a
983 per-file basis by adding one of the following lines anywhere in the
990 #+STARTUP: showeverything
993 @cindex property, VISIBILITY
995 Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
996 and Columns}) will get their visibility adapted accordingly. Allowed values
997 for this property are @code{folded}, @code{children}, @code{content}, and
1000 @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
1001 Switch back to the startup visibility of the buffer, i.e. whatever is
1002 requested by startup options and @samp{VISIBILITY} properties in individual
1006 @node Motion, Structure editing, Visibility cycling, Document Structure
1008 @cindex motion, between headlines
1009 @cindex jumping, to headlines
1010 @cindex headline navigation
1011 The following commands jump to other headlines in the buffer.
1014 @orgcmd{C-c C-n,outline-next-visible-heading}
1016 @orgcmd{C-c C-p,outline-previous-visible-heading}
1018 @orgcmd{C-c C-f,org-forward-same-level}
1019 Next heading same level.
1020 @orgcmd{C-c C-b,org-backward-same-level}
1021 Previous heading same level.
1022 @orgcmd{C-c C-u,outline-up-heading}
1023 Backward to higher level heading.
1024 @orgcmd{C-c C-j,org-goto}
1025 Jump to a different place without changing the current outline
1026 visibility. Shows the document structure in a temporary buffer, where
1027 you can use the following keys to find your destination:
1028 @vindex org-goto-auto-isearch
1030 @key{TAB} @r{Cycle visibility.}
1031 @key{down} / @key{up} @r{Next/previous visible headline.}
1032 @key{RET} @r{Select this location.}
1033 @kbd{/} @r{Do a Sparse-tree search}
1034 @r{The following keys work if you turn off @code{org-goto-auto-isearch}}
1035 n / p @r{Next/previous visible headline.}
1036 f / b @r{Next/previous headline same level.}
1038 0-9 @r{Digit argument.}
1041 @vindex org-goto-interface
1043 See also the variable @code{org-goto-interface}.
1046 @node Structure editing, Sparse trees, Motion, Document Structure
1047 @section Structure editing
1048 @cindex structure editing
1049 @cindex headline, promotion and demotion
1050 @cindex promotion, of subtrees
1051 @cindex demotion, of subtrees
1052 @cindex subtree, cut and paste
1053 @cindex pasting, of subtrees
1054 @cindex cutting, of subtrees
1055 @cindex copying, of subtrees
1056 @cindex sorting, of subtrees
1057 @cindex subtrees, cut and paste
1060 @orgcmd{M-@key{RET},org-insert-heading}
1061 @vindex org-M-RET-may-split-line
1062 Insert new heading with same level as current. If the cursor is in a
1063 plain list item, a new item is created (@pxref{Plain lists}). To force
1064 creation of a new headline, use a prefix argument, or first press @key{RET}
1065 to get to the beginning of the next line. When this command is used in
1066 the middle of a line, the line is split and the rest of the line becomes
1067 the new headline@footnote{If you do not want the line to be split,
1068 customize the variable @code{org-M-RET-may-split-line}.}. If the
1069 command is used at the beginning of a headline, the new headline is
1070 created before the current line. If at the beginning of any other line,
1071 the content of that line is made the new heading. If the command is
1072 used at the end of a folded subtree (i.e. behind the ellipses at the end
1073 of a headline), then a headline like the current one will be inserted
1074 after the end of the subtree.
1077 Just like @kbd{M-@key{RET}}, except when adding a new heading below the
1078 current heading, the new heading is placed after the body instead of before
1079 it. This command works from anywhere in the entry.
1080 @kindex M-S-@key{RET}
1082 @vindex org-treat-insert-todo-heading-as-state-change
1083 Insert new TODO entry with same level as current heading. See also the
1084 variable @code{org-treat-insert-todo-heading-as-state-change}.
1085 @kindex C-S-@key{RET}
1087 Insert new TODO entry with same level as current heading. Like
1088 @kbd{C-@key{RET}}, the new headline will be inserted after the current
1090 @orgcmd{@key{TAB},org-cycle}
1091 In a new entry with no text yet, the first @key{TAB} demotes the entry to
1092 become a child of the previous one. The next @key{TAB} makes it a parent,
1093 and so on, all the way to top level. Yet another @key{TAB}, and you are back
1094 to the initial level.
1095 @orgcmd{M-@key{left},org-do-promote}
1096 Promote current heading by one level.
1097 @orgcmd{M-@key{right},org-do-demote}
1098 Demote current heading by one level.
1099 @orgcmd{M-S-@key{left},org-promote-subtree}
1100 Promote the current subtree by one level.
1101 @orgcmd{M-S-@key{right},org-demote-subtree}
1102 Demote the current subtree by one level.
1103 @orgcmd{M-S-@key{up},org-move-subtree-up}
1104 Move subtree up (swap with previous subtree of same
1106 @orgcmd{M-S-@key{down},org-move-subtree-down}
1107 Move subtree down (swap with next subtree of same level).
1108 @orgcmd{C-c C-x C-w,org-cut-subtree}
1109 Kill subtree, i.e. remove it from buffer but save in kill ring.
1110 With a numeric prefix argument N, kill N sequential subtrees.
1111 @orgcmd{C-c C-x M-w,org-copy-subtree}
1112 Copy subtree to kill ring. With a numeric prefix argument N, copy the N
1113 sequential subtrees.
1114 @orgcmd{C-c C-x C-y,org-paste-subtree}
1115 Yank subtree from kill ring. This does modify the level of the subtree to
1116 make sure the tree fits in nicely at the yank position. The yank level can
1117 also be specified with a numeric prefix argument, or by yanking after a
1118 headline marker like @samp{****}.
1119 @orgcmd{C-y,org-yank}
1120 @vindex org-yank-adjusted-subtrees
1121 @vindex org-yank-folded-subtrees
1122 Depending on the variables @code{org-yank-adjusted-subtrees} and
1123 @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
1124 paste subtrees folded and in a clever way, using the same command as @kbd{C-c
1125 C-x C-y}. With the default settings, no level adjustment will take place,
1126 but the yanked tree will be folded unless doing so would swallow text
1127 previously visible. Any prefix argument to this command will force a normal
1128 @code{yank} to be executed, with the prefix passed along. A good way to
1129 force a normal yank is @kbd{C-u C-y}. If you use @code{yank-pop} after a
1130 yank, it will yank previous kill items plainly, without adjustment and
1132 @orgcmd{C-c C-x c,org-clone-subtree-with-time-shift}
1133 Clone a subtree by making a number of sibling copies of it. You will be
1134 prompted for the number of copies to make, and you can also specify if any
1135 timestamps in the entry should be shifted. This can be useful, for example,
1136 to create a number of tasks related to a series of lectures to prepare. For
1137 more details, see the docstring of the command
1138 @code{org-clone-subtree-with-time-shift}.
1139 @orgcmd{C-c C-w,org-refile}
1140 Refile entry or region to a different location. @xref{Refiling notes}.
1141 @orgcmd{C-c ^,org-sort-entries-or-items}
1142 Sort same-level entries. When there is an active region, all entries in the
1143 region will be sorted. Otherwise the children of the current headline are
1144 sorted. The command prompts for the sorting method, which can be
1145 alphabetically, numerically, by time (first timestamp with active preferred,
1146 creation time, scheduled time, deadline time), by priority, by TODO keyword
1147 (in the sequence the keywords have been defined in the setup) or by the value
1148 of a property. Reverse sorting is possible as well. You can also supply
1149 your own function to extract the sorting key. With a @kbd{C-u} prefix,
1150 sorting will be case-sensitive. With two @kbd{C-u C-u} prefixes, duplicate
1151 entries will also be removed.
1152 @orgcmd{C-x n s,org-narrow-to-subtree}
1153 Narrow buffer to current subtree.
1154 @orgcmd{C-x n w,widen}
1155 Widen buffer to remove narrowing.
1156 @orgcmd{C-c *,org-toggle-heading}
1157 Turn a normal line or plain list item into a headline (so that it becomes a
1158 subheading at its location). Also turn a headline into a normal line by
1159 removing the stars. If there is an active region, turn all lines in the
1160 region into headlines. If the first line in the region was an item, turn
1161 only the item lines into headlines. Finally, if the first line is a
1162 headline, remove the stars from all headlines in the region.
1165 @cindex region, active
1166 @cindex active region
1167 @cindex transient mark mode
1168 When there is an active region (Transient Mark mode), promotion and
1169 demotion work on all headlines in the region. To select a region of
1170 headlines, it is best to place both point and mark at the beginning of a
1171 line, mark at the beginning of the first headline, and point at the line
1172 just after the last headline to change. Note that when the cursor is
1173 inside a table (@pxref{Tables}), the Meta-Cursor keys have different
1177 @node Sparse trees, Plain lists, Structure editing, Document Structure
1178 @section Sparse trees
1179 @cindex sparse trees
1180 @cindex trees, sparse
1181 @cindex folding, sparse trees
1182 @cindex occur, command
1184 @vindex org-show-hierarchy-above
1185 @vindex org-show-following-heading
1186 @vindex org-show-siblings
1187 @vindex org-show-entry-below
1188 An important feature of Org-mode is the ability to construct @emph{sparse
1189 trees} for selected information in an outline tree, so that the entire
1190 document is folded as much as possible, but the selected information is made
1191 visible along with the headline structure above it@footnote{See also the
1192 variables @code{org-show-hierarchy-above}, @code{org-show-following-heading},
1193 @code{org-show-siblings}, and @code{org-show-entry-below} for detailed
1194 control on how much context is shown around each match.}. Just try it out
1195 and you will see immediately how it works.
1197 Org-mode contains several commands creating such trees, all these
1198 commands can be accessed through a dispatcher:
1201 @orgcmd{C-c /,org-sparse-tree}
1202 This prompts for an extra key to select a sparse-tree creating command.
1205 @vindex org-remove-highlights-with-change
1206 Occur. Prompts for a regexp and shows a sparse tree with all matches. If
1207 the match is in a headline, the headline is made visible. If the match is in
1208 the body of an entry, headline and body are made visible. In order to
1209 provide minimal context, also the full hierarchy of headlines above the match
1210 is shown, as well as the headline following the match. Each match is also
1211 highlighted; the highlights disappear when the buffer is changed by an
1212 editing command@footnote{This depends on the option
1213 @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
1214 When called with a @kbd{C-u} prefix argument, previous highlights are kept,
1215 so several calls to this command can be stacked.
1219 @vindex org-agenda-custom-commands
1220 For frequently used sparse trees of specific search strings, you can
1221 use the variable @code{org-agenda-custom-commands} to define fast
1222 keyboard access to specific sparse trees. These commands will then be
1223 accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
1227 (setq org-agenda-custom-commands
1228 '(("f" occur-tree "FIXME")))
1231 @noindent will define the key @kbd{C-c a f} as a shortcut for creating
1232 a sparse tree matching the string @samp{FIXME}.
1234 The other sparse tree commands select headings based on TODO keywords,
1235 tags, or properties and will be discussed later in this manual.
1238 @cindex printing sparse trees
1239 @cindex visible text, printing
1240 To print a sparse tree, you can use the Emacs command
1241 @code{ps-print-buffer-with-faces} which does not print invisible parts
1242 of the document @footnote{This does not work under XEmacs, because
1243 XEmacs uses selective display for outlining, not text properties.}.
1244 Or you can use the command @kbd{C-c C-e v} to export only the visible
1245 part of the document and print the resulting file.
1247 @node Plain lists, Drawers, Sparse trees, Document Structure
1248 @section Plain lists
1250 @cindex lists, plain
1251 @cindex lists, ordered
1252 @cindex ordered lists
1254 Within an entry of the outline tree, hand-formatted lists can provide
1255 additional structure. They also provide a way to create lists of
1256 checkboxes (@pxref{Checkboxes}). Org supports editing such lists,
1257 and the HTML exporter (@pxref{Exporting}) parses and formats them.
1259 Org knows ordered lists, unordered lists, and description lists.
1262 @emph{Unordered} list items start with @samp{-}, @samp{+}, or
1263 @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
1264 they will be seen as top-level headlines. Also, when you are hiding leading
1265 stars to get a clean outline view, plain list items starting with a star are
1266 visually indistinguishable from true headlines. In short: even though
1267 @samp{*} is supported, it may be better to not use it for plain list items.}
1270 @emph{Ordered} list items start with a numeral followed by either a period or
1271 a right parenthesis, such as @samp{1.} or @samp{1)}. If you want a list to
1272 start a different value (e.g. 20), start the text of the item with
1273 @code{[@@start:20]}.
1275 @emph{Description} list items are unordered list items, and contain the
1276 separator @samp{ :: } to separate the description @emph{term} from the
1280 @vindex org-empty-line-terminates-plain-lists
1281 Items belonging to the same list must have the same indentation on the first
1282 line. In particular, if an ordered list reaches number @samp{10.}, then the
1283 2--digit numbers must be written left-aligned with the other numbers in the
1284 list. Indentation also determines the end of a list item. It ends before
1285 the next line that is indented like the bullet/number, or less. Empty lines
1286 are part of the previous item, so you can have several paragraphs in one
1287 item. If you would like an empty line to terminate all currently open plain
1288 lists, configure the variable @code{org-empty-line-terminates-plain-lists}.
1293 ** Lord of the Rings
1294 My favorite scenes are (in this order)
1295 1. The attack of the Rohirrim
1296 2. Eowyn's fight with the witch king
1297 + this was already my favorite scene in the book
1298 + I really like Miranda Otto.
1299 3. Peter Jackson being shot by Legolas
1301 He makes a really funny face when it happens.
1302 But in the end, no individual scenes matter but the film as a whole.
1303 Important actors in this film are:
1304 - @b{Elijah Wood} :: He plays Frodo
1305 - @b{Sean Austin} :: He plays Sam, Frodo's friend. I still remember
1306 him very well from his role as Mikey Walsh in @i{The Goonies}.
1310 Org supports these lists by tuning filling and wrapping commands to deal with
1311 them correctly@footnote{Org only changes the filling settings for Emacs. For
1312 XEmacs, you should use Kyle E. Jones' @file{filladapt.el}. To turn this on,
1313 put into @file{.emacs}: @code{(require 'filladapt)}}, and by exporting them
1314 properly (@pxref{Exporting}). Since indentation is what governs the
1315 structure of these lists, many structural constructs like @code{#+BEGIN_...}
1316 blocks can be indented to signal that they should be part of a list item.
1318 @vindex org-list-demote-modify-bullet
1319 If you find that using a different bullet for a sub-list (than that used for
1320 the current list-level) improves readability, customize the variable
1321 @code{org-list-demote-modify-bullet}.
1323 The following commands act on items when the cursor is in the first line
1324 of an item (the line with the bullet or number).
1327 @orgcmd{@key{TAB},org-cycle}
1328 @vindex org-cycle-include-plain-lists
1329 Items can be folded just like headline levels. Normally this works only if
1330 the cursor is on a plain list item. For more details, see the variable
1331 @code{org-cycle-include-plain-lists}. to @code{integrate}, plain list items
1332 will be treated like low-level. The level of an item is then given by the
1333 indentation of the bullet/number. Items are always subordinate to real
1334 headlines, however; the hierarchies remain completely separated.
1336 If @code{org-cycle-include-plain-lists} has not been set, @key{TAB}
1337 fixes the indentation of the current line in a heuristic way.
1338 @orgcmd{M-@key{RET},org-insert-heading}
1339 @vindex org-M-RET-may-split-line
1340 Insert new item at current level. With a prefix argument, force a new
1341 heading (@pxref{Structure editing}). If this command is used in the middle
1342 of a line, the line is @emph{split} and the rest of the line becomes the new
1343 item@footnote{If you do not want the line to be split, customize the variable
1344 @code{org-M-RET-may-split-line}.}. If this command is executed in the
1345 @emph{whitespace before a bullet or number}, the new item is created
1346 @emph{before} the current item. If the command is executed in the white
1347 space before the text that is part of an item but does not contain the
1348 bullet, a bullet is added to the current line.
1349 @kindex M-S-@key{RET}
1351 Insert a new item with a checkbox (@pxref{Checkboxes}).
1352 @orgcmd{@key{TAB},org-cycle}
1353 In a new item with no text yet, the first @key{TAB} demotes the item to
1354 become a child of the previous one. The next @key{TAB} makes it a parent,
1355 and so on, all the way to the left margin. Yet another @key{TAB}, and you
1356 are back to the initial level.
1357 @kindex S-@key{down}
1360 @cindex shift-selection-mode
1361 @vindex org-support-shift-select
1362 Jump to the previous/next item in the current list, but only if
1363 @code{org-support-shift-select} is off. If not, you can still use paragraph
1364 jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite
1366 @kindex M-S-@key{up}
1367 @kindex M-S-@key{down}
1369 @itemx M-S-@key{down}
1370 Move the item including subitems up/down (swap with previous/next item
1371 of same indentation). If the list is ordered, renumbering is
1373 @kindex M-@key{left}
1374 @kindex M-@key{right}
1376 @itemx M-@key{right}
1377 Decrease/increase the indentation of an item, leaving children alone.
1378 @kindex M-S-@key{left}
1379 @kindex M-S-@key{right}
1380 @item M-S-@key{left}
1381 @itemx M-S-@key{right}
1382 Decrease/increase the indentation of the item, including subitems.
1383 Initially, the item tree is selected based on current indentation.
1384 When these commands are executed several times in direct succession,
1385 the initially selected region is used, even if the new indentation
1386 would imply a different hierarchy. To use the new hierarchy, break
1387 the command chain with a cursor motion or so.
1390 If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
1391 state of the checkbox. If not, this command makes sure that all the
1392 items on this list level use the same bullet. Furthermore, if this is
1393 an ordered list, make sure the numbering is OK.
1396 Cycle the entire list level through the different itemize/enumerate bullets
1397 (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}). With a numeric prefix
1398 argument N, select the Nth bullet from this list. If there is an active
1399 region when calling this, all lines will be converted to list items. If the
1400 first line already was a list item, any item markers will be removed from the
1401 list. Finally, even without an active region, a normal line will be
1402 converted into a list item.
1405 Turn a plain list item into a headline (so that it becomes a subheading at
1406 its location). @xref{Structure editing}, for a detailed explanation.
1407 @kindex S-@key{left}
1408 @kindex S-@key{right}
1409 @item S-@key{left}/@key{right}
1410 @vindex org-support-shift-select
1411 This command also cycles bullet styles when the cursor in on the bullet or
1412 anywhere in an item line, details depending on
1413 @code{org-support-shift-select}.
1416 Sort the plain list. You will be prompted for the sorting method:
1417 numerically, alphabetically, by time, or by custom function.
1420 @node Drawers, Blocks, Plain lists, Document Structure
1424 @cindex visibility cycling, drawers
1427 Sometimes you want to keep information associated with an entry, but you
1428 normally don't want to see it. For this, Org-mode has @emph{drawers}.
1429 Drawers need to be configured with the variable
1430 @code{org-drawers}@footnote{You can define drawers on a per-file basis
1431 with a line like @code{#+DRAWERS: HIDDEN PROPERTIES STATE}}. Drawers
1435 ** This is a headline
1436 Still outside the drawer
1438 This is inside the drawer.
1443 Visibility cycling (@pxref{Visibility cycling}) on the headline will hide and
1444 show the entry, but keep the drawer collapsed to a single line. In order to
1445 look inside the drawer, you need to move the cursor to the drawer line and
1446 press @key{TAB} there. Org-mode uses the @code{PROPERTIES} drawer for
1447 storing properties (@pxref{Properties and Columns}), and you can also arrange
1448 for state change notes (@pxref{Tracking TODO state changes}) and clock times
1449 (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}. If you
1450 want to store a quick note in the LOGBOOK drawer, in a similar way as this is
1451 done by state changes, use
1456 Add a time-stamped note to the LOGBOOK drawer.
1459 @node Blocks, Footnotes, Drawers, Document Structure
1462 @vindex org-hide-block-startup
1463 @cindex blocks, folding
1464 Org-mode uses begin...end blocks for various purposes from including source
1465 code examples (@pxref{Literal examples}) to capturing time logging
1466 information (@pxref{Clocking work time}). These blocks can be folded and
1467 unfolded by pressing TAB in the begin line. You can also get all blocks
1468 folded at startup by configuring the variable @code{org-hide-block-startup}
1469 or on a per-file basis by using
1471 @cindex @code{hideblocks}, STARTUP keyword
1472 @cindex @code{nohideblocks}, STARTUP keyword
1474 #+STARTUP: hideblocks
1475 #+STARTUP: nohideblocks
1478 @node Footnotes, Orgstruct mode, Blocks, Document Structure
1482 Org-mode supports the creation of footnotes. In contrast to the
1483 @file{footnote.el} package, Org-mode's footnotes are designed for work on a
1484 larger document, not only for one-off documents like emails. The basic
1485 syntax is similar to the one used by @file{footnote.el}, i.e. a footnote is
1486 defined in a paragraph that is started by a footnote marker in square
1487 brackets in column 0, no indentation allowed. If you need a paragraph break
1488 inside a footnote, use the La@TeX{} idiom @samp{\par}. The footnote reference
1489 is simply the marker in square brackets, inside text. For example:
1492 The Org homepage[fn:1] now looks a lot better than it used to.
1494 [fn:1] The link is: http://orgmode.org
1497 Org-mode extends the number-based syntax to @emph{named} footnotes and
1498 optional inline definition. Using plain numbers as markers (as
1499 @file{footnote.el} does) is supported for backward compatibility, but not
1500 encouraged because of possible conflicts with La@TeX{} snippets (@pxref{Embedded
1501 LaTeX}). Here are the valid references:
1505 A plain numeric footnote marker. Compatible with @file{footnote.el}, but not
1506 recommended because something like @samp{[1]} could easily be part of a code
1509 A named footnote reference, where @code{name} is a unique label word, or, for
1510 simplicity of automatic creation, a number.
1511 @item [fn:: This is the inline definition of this footnote]
1512 A La@TeX{}-like anonymous footnote where the definition is given directly at the
1514 @item [fn:name: a definition]
1515 An inline definition of a footnote, which also specifies a name for the note.
1516 Since Org allows multiple references to the same note, you can then use
1517 @code{[fn:name]} to create additional references.
1520 @vindex org-footnote-auto-label
1521 Footnote labels can be created automatically, or you can create names yourself.
1522 This is handled by the variable @code{org-footnote-auto-label} and its
1523 corresponding @code{#+STARTUP} keywords, see the docstring of that variable
1526 @noindent The following command handles footnotes:
1531 The footnote action command.
1533 When the cursor is on a footnote reference, jump to the definition. When it
1534 is at a definition, jump to the (first) reference.
1536 @vindex org-footnote-define-inline
1537 @vindex org-footnote-section
1538 @vindex org-footnote-auto-adjust
1539 Otherwise, create a new footnote. Depending on the variable
1540 @code{org-footnote-define-inline}@footnote{The corresponding in-buffer
1541 setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
1542 definition will be placed right into the text as part of the reference, or
1543 separately into the location determined by the variable
1544 @code{org-footnote-section}.
1546 When this command is called with a prefix argument, a menu of additional
1549 s @r{Sort the footnote definitions by reference sequence. During editing,}
1550 @r{Org makes no effort to sort footnote definitions into a particular}
1551 @r{sequence. If you want them sorted, use this command, which will}
1552 @r{also move entries according to @code{org-footnote-section}. Automatic}
1553 @r{sorting after each insertion/deletion can be configured using the}
1554 @r{variable @code{org-footnote-auto-adjust}.}
1555 r @r{Renumber the simple @code{fn:N} footnotes. Automatic renumbering}
1556 @r{after each insertion/deletion can be configured using the variable}
1557 @r{@code{org-footnote-auto-adjust}.}
1558 S @r{Short for first @code{r}, then @code{s} action.}
1559 n @r{Normalize the footnotes by collecting all definitions (including}
1560 @r{inline definitions) into a special section, and then numbering them}
1561 @r{in sequence. The references will then also be numbers. This is}
1562 @r{meant to be the final step before finishing a document (e.g. sending}
1563 @r{off an email). The exporters do this automatically, and so could}
1564 @r{something like @code{message-send-hook}.}
1565 d @r{Delete the footnote at point, and all definitions of and references}
1568 Depending on the variable @code{org-footnote-auto-adjust}@footnote{the
1569 corresponding in-buffer options are @code{fnadjust} and @code{nofnadjust}.},
1570 renumbering and sorting footnotes can be automatic after each insertion or
1575 If the cursor is on a footnote reference, jump to the definition. If it is a
1576 the definition, jump back to the reference. When called at a footnote
1577 location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
1581 @item C-c C-o @r{or} mouse-1/2
1582 Footnote labels are also links to the corresponding definition/reference, and
1583 you can use the usual commands to follow these links.
1586 @node Orgstruct mode, , Footnotes, Document Structure
1587 @section The Orgstruct minor mode
1588 @cindex Orgstruct mode
1589 @cindex minor mode for structure editing
1591 If you like the intuitive way the Org-mode structure editing and list
1592 formatting works, you might want to use these commands in other modes like
1593 Text mode or Mail mode as well. The minor mode @code{orgstruct-mode} makes
1594 this possible. Toggle the mode with @kbd{M-x orgstruct-mode}, or
1595 turn it on by default, for example in Mail mode, with one of:
1598 (add-hook 'mail-mode-hook 'turn-on-orgstruct)
1599 (add-hook 'mail-mode-hook 'turn-on-orgstruct++)
1602 When this mode is active and the cursor is on a line that looks to Org like a
1603 headline or the first line of a list item, most structure editing commands
1604 will work, even if the same keys normally have different functionality in the
1605 major mode you are using. If the cursor is not in one of those special
1606 lines, Orgstruct mode lurks silently in the shadow. When you use
1607 @code{orgstruct++-mode}, Org will also export indentation and autofill
1608 settings into that mode, and detect item context after the first line of an
1611 @node Tables, Hyperlinks, Document Structure, Top
1614 @cindex editing tables
1616 Org comes with a fast and intuitive table editor. Spreadsheet-like
1617 calculations are supported in connection with the Emacs @file{calc}
1620 (@pxref{Top,Calc,,Calc,Gnu Emacs Calculator Manual}).
1623 (see the Emacs Calculator manual for more information about the Emacs
1628 * Built-in table editor:: Simple tables
1629 * Column width and alignment:: Overrule the automatic settings
1630 * Column groups:: Grouping to trigger vertical lines
1631 * Orgtbl mode:: The table editor as minor mode
1632 * The spreadsheet:: The table editor has spreadsheet capabilities
1633 * Org-Plot:: Plotting from org tables
1636 @node Built-in table editor, Column width and alignment, Tables, Tables
1637 @section The built-in table editor
1638 @cindex table editor, built-in
1640 Org makes it easy to format tables in plain ASCII. Any line with
1641 @samp{|} as the first non-whitespace character is considered part of a
1642 table. @samp{|} is also the column separator. A table might look like
1646 | Name | Phone | Age |
1647 |-------+-------+-----|
1648 | Peter | 1234 | 17 |
1649 | Anna | 4321 | 25 |
1652 A table is re-aligned automatically each time you press @key{TAB} or
1653 @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to
1654 the next field (@key{RET} to the next row) and creates new table rows
1655 at the end of the table or before horizontal lines. The indentation
1656 of the table is set by the first line. Any line starting with
1657 @samp{|-} is considered as a horizontal separator line and will be
1658 expanded on the next re-align to span the whole table width. So, to
1659 create the above table, you would only type
1666 @noindent and then press @key{TAB} to align the table and start filling in
1667 fields. Even faster would be to type @code{|Name|Phone|Age} followed by
1668 @kbd{C-c @key{RET}}.
1670 @vindex org-enable-table-editor
1671 @vindex org-table-auto-blank-field
1672 When typing text into a field, Org treats @key{DEL},
1673 @key{Backspace}, and all character keys in a special way, so that
1674 inserting and deleting avoids shifting other fields. Also, when
1675 typing @emph{immediately after the cursor was moved into a new field
1676 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
1677 field is automatically made blank. If this behavior is too
1678 unpredictable for you, configure the variables
1679 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
1682 @tsubheading{Creation and conversion}
1685 Convert the active region to table. If every line contains at least one
1686 TAB character, the function assumes that the material is tab separated.
1687 If every line contains a comma, comma-separated values (CSV) are assumed.
1688 If not, lines are split at whitespace into fields. You can use a prefix
1689 argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
1690 C-u} forces TAB, and a numeric argument N indicates that at least N
1691 consecutive spaces, or alternatively a TAB will be the separator.
1693 If there is no active region, this command creates an empty Org
1694 table. But it's easier just to start typing, like
1695 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
1697 @tsubheading{Re-aligning and field motion}
1700 Re-align the table without moving the cursor.
1704 Re-align the table, move to the next field. Creates a new row if
1709 Re-align, move to previous field.
1713 Re-align the table and move down to next row. Creates a new row if
1714 necessary. At the beginning or end of a line, @key{RET} still does
1715 NEWLINE, so it can be used to split a table.
1719 Move to beginning of the current table field, or on to the previous field.
1722 Move to end of the current table field, or on to the next field.
1724 @tsubheading{Column and row editing}
1725 @kindex M-@key{left}
1726 @kindex M-@key{right}
1728 @itemx M-@key{right}
1729 Move the current column left/right.
1731 @kindex M-S-@key{left}
1732 @item M-S-@key{left}
1733 Kill the current column.
1735 @kindex M-S-@key{right}
1736 @item M-S-@key{right}
1737 Insert a new column to the left of the cursor position.
1740 @kindex M-@key{down}
1743 Move the current row up/down.
1745 @kindex M-S-@key{up}
1747 Kill the current row or horizontal line.
1749 @kindex M-S-@key{down}
1750 @item M-S-@key{down}
1751 Insert a new row above the current row. With a prefix argument, the line is
1752 created below the current one.
1756 Insert a horizontal line below current row. With a prefix argument, the line
1757 is created above the current line.
1759 @kindex C-c @key{RET}
1761 Insert a horizontal line below current row, and move the cursor into the row
1766 Sort the table lines in the region. The position of point indicates the
1767 column to be used for sorting, and the range of lines is the range
1768 between the nearest horizontal separator lines, or the entire table. If
1769 point is before the first column, you will be prompted for the sorting
1770 column. If there is an active region, the mark specifies the first line
1771 and the sorting column, while point should be in the last line to be
1772 included into the sorting. The command prompts for the sorting type
1773 (alphabetically, numerically, or by time). When called with a prefix
1774 argument, alphabetic sorting will be case-sensitive.
1776 @tsubheading{Regions}
1779 Copy a rectangular region from a table to a special clipboard. Point and
1780 mark determine edge fields of the rectangle. If there is no active region,
1781 copy just the current field. The process ignores horizontal separator lines.
1785 Copy a rectangular region from a table to a special clipboard, and
1786 blank all fields in the rectangle. So this is the ``cut'' operation.
1790 Paste a rectangular region into a table.
1791 The upper left corner ends up in the current field. All involved fields
1792 will be overwritten. If the rectangle does not fit into the present table,
1793 the table is enlarged as needed. The process ignores horizontal separator
1798 Wrap several fields in a column like a paragraph. If there is an active
1799 region, and both point and mark are in the same column, the text in the
1800 column is wrapped to minimum width for the given number of lines. A numeric
1801 prefix argument may be used to change the number of desired lines. If there
1802 is no region, the current field is split at the cursor position and the text
1803 fragment to the right of the cursor is prepended to the field one line
1804 down. If there is no region, but you specify a prefix argument, the current
1805 field is made blank, and the content is appended to the field above.
1807 @tsubheading{Calculations}
1808 @cindex formula, in tables
1809 @cindex calculations, in tables
1810 @cindex region, active
1811 @cindex active region
1812 @cindex transient mark mode
1815 Sum the numbers in the current column, or in the rectangle defined by
1816 the active region. The result is shown in the echo area and can
1817 be inserted with @kbd{C-y}.
1821 @vindex org-table-copy-increment
1822 When current field is empty, copy from first non-empty field above. When not
1823 empty, copy current field down to next row and move cursor along with it.
1824 Depending on the variable @code{org-table-copy-increment}, integer field
1825 values will be incremented during copy. Integers that are too large will not
1826 be incremented. Also, a @code{0} prefix argument temporarily disables the
1827 increment. This key is also used by shift-selection and related modes
1828 (@pxref{Conflicts}).
1830 @tsubheading{Miscellaneous}
1833 Edit the current field in a separate window. This is useful for fields that
1834 are not fully visible (@pxref{Column width and alignment}). When called with
1835 a @kbd{C-u} prefix, just make the full field visible, so that it can be
1838 @item M-x org-table-import
1839 Import a file as a table. The table should be TAB or whitespace
1840 separated. Use, for example, to import a spreadsheet table or data
1841 from a database, because these programs generally can write
1842 TAB-separated text files. This command works by inserting the file into
1843 the buffer and then converting the region to a table. Any prefix
1844 argument is passed on to the converter, which uses it to determine the
1847 Tables can also be imported by pasting tabular text into the Org
1848 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
1849 @kbd{C-c |} command (see above under @i{Creation and conversion}).
1851 @item M-x org-table-export
1852 @vindex org-table-export-default-format
1853 Export the table, by default as a TAB-separated file. Use for data
1854 exchange with, for example, spreadsheet or database programs. The format
1855 used to export the file can be configured in the variable
1856 @code{org-table-export-default-format}. You may also use properties
1857 @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
1858 name and the format for table export in a subtree. Org supports quite
1859 general formats for exported tables. The exporter format is the same as the
1860 format used by Orgtbl radio tables, see @ref{Translator functions}, for a
1861 detailed description.
1864 If you don't like the automatic table editor because it gets in your
1865 way on lines which you would like to start with @samp{|}, you can turn
1869 (setq org-enable-table-editor nil)
1872 @noindent Then the only table command that still works is
1873 @kbd{C-c C-c} to do a manual re-align.
1875 @node Column width and alignment, Column groups, Built-in table editor, Tables
1876 @section Column width and alignment
1877 @cindex narrow columns in tables
1878 @cindex alignment in tables
1880 The width of columns is automatically determined by the table editor. And
1881 also the alignment of a column is determined automatically from the fraction
1882 of number-like versus non-number fields in the column.
1884 Sometimes a single field or a few fields need to carry more text, leading to
1885 inconveniently wide columns. Or maybe you want to make a table with several
1886 columns having a fixed width, regardless of content. To set@footnote{This
1887 feature does not work on XEmacs.} the width of a column, one field anywhere
1888 in the column may contain just the string @samp{<N>} where @samp{N} is an
1889 integer specifying the width of the column in characters. The next re-align
1890 will then set the width of this column to this value.
1894 |---+------------------------------| |---+--------|
1896 | 1 | one | | 1 | one |
1897 | 2 | two | ----\ | 2 | two |
1898 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
1899 | 4 | four | | 4 | four |
1900 |---+------------------------------| |---+--------|
1905 Fields that are wider become clipped and end in the string @samp{=>}.
1906 Note that the full text is still in the buffer, it is only invisible.
1907 To see the full text, hold the mouse over the field---a tool-tip window
1908 will show the full content. To edit such a field, use the command
1909 @kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will
1910 open a new window with the full field. Edit it and finish with @kbd{C-c
1913 @vindex org-startup-align-all-tables
1914 When visiting a file containing a table with narrowed columns, the
1915 necessary character hiding has not yet happened, and the table needs to
1916 be aligned before it looks nice. Setting the option
1917 @code{org-startup-align-all-tables} will realign all tables in a file
1918 upon visiting, but also slow down startup. You can also set this option
1919 on a per-file basis with:
1926 If you would like to overrule the automatic alignment of number-rich columns
1927 to the right and of string-rich column to the left, you and use @samp{<r>} or
1928 @samp{<l>} in a similar fashion. You may also combine alignment and field
1929 width like this: @samp{<l10>}.
1931 Lines which only contain these formatting cookies will be removed
1932 automatically when exporting the document.
1934 @node Column groups, Orgtbl mode, Column width and alignment, Tables
1935 @section Column groups
1936 @cindex grouping columns in tables
1938 When Org exports tables, it does so by default without vertical
1939 lines because that is visually more satisfying in general. Occasionally
1940 however, vertical lines can be useful to structure a table into groups
1941 of columns, much like horizontal lines can do for groups of rows. In
1942 order to specify column groups, you can use a special row where the
1943 first field contains only @samp{/}. The further fields can either
1944 contain @samp{<} to indicate that this column should start a group,
1945 @samp{>} to indicate the end of a column, or @samp{<>} to make a column
1946 a group of its own. Boundaries between column groups will upon export be
1947 marked with vertical lines. Here is an example:
1950 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
1951 |---+-----+-----+-----+---------+------------|
1952 | / | < | | > | < | > |
1953 | 1 | 1 | 1 | 1 | 1 | 1 |
1954 | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
1955 | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
1956 |---+-----+-----+-----+---------+------------|
1957 #+TBLFM: $2=$1^2::$3=$1^3::$4=$1^4::$5=sqrt($1)::$6=sqrt(sqrt(($1)))
1960 It is also sufficient to just insert the column group starters after
1961 every vertical line you would like to have:
1964 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
1965 |----+-----+-----+-----+---------+------------|
1969 @node Orgtbl mode, The spreadsheet, Column groups, Tables
1970 @section The Orgtbl minor mode
1972 @cindex minor mode for tables
1974 If you like the intuitive way the Org table editor works, you
1975 might also want to use it in other modes like Text mode or Mail mode.
1976 The minor mode Orgtbl mode makes this possible. You can always toggle
1977 the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for
1978 example in mail mode, use
1981 (add-hook 'mail-mode-hook 'turn-on-orgtbl)
1984 Furthermore, with some special setup, it is possible to maintain tables
1985 in arbitrary syntax with Orgtbl mode. For example, it is possible to
1986 construct La@TeX{} tables with the underlying ease and power of
1987 Orgtbl mode, including spreadsheet capabilities. For details, see
1988 @ref{Tables in arbitrary syntax}.
1990 @node The spreadsheet, Org-Plot, Orgtbl mode, Tables
1991 @section The spreadsheet
1992 @cindex calculations, in tables
1993 @cindex spreadsheet capabilities
1994 @cindex @file{calc} package
1996 The table editor makes use of the Emacs @file{calc} package to implement
1997 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
1998 derive fields from other fields. While fully featured, Org's implementation
1999 is not identical to other spreadsheets. For example, Org knows the concept
2000 of a @emph{column formula} that will be applied to all non-header fields in a
2001 column without having to copy the formula to each relevant field. There is
2002 also a formula debugger, and a formula editor with features for highlighting
2003 fields in the table corresponding to the references at the point in the
2004 formula, moving these references by arrow keys
2007 * References:: How to refer to another field or range
2008 * Formula syntax for Calc:: Using Calc to compute stuff
2009 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
2010 * Field formulas:: Formulas valid for a single field
2011 * Column formulas:: Formulas valid for an entire column
2012 * Editing and debugging formulas:: Fixing formulas
2013 * Updating the table:: Recomputing all dependent fields
2014 * Advanced features:: Field names, parameters and automatic recalc
2017 @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet
2018 @subsection References
2021 To compute fields in the table from other fields, formulas must
2022 reference other fields or ranges. In Org, fields can be referenced
2023 by name, by absolute coordinates, and by relative coordinates. To find
2024 out what the coordinates of a field are, press @kbd{C-c ?} in that
2025 field, or press @kbd{C-c @}} to toggle the display of a grid.
2027 @subsubheading Field references
2028 @cindex field references
2029 @cindex references, to fields
2031 Formulas can reference the value of another field in two ways. Like in
2032 any other spreadsheet, you may reference fields with a letter/number
2033 combination like @code{B3}, meaning the 2nd field in the 3rd row.
2034 @c Such references are always fixed to that field, they don't change
2035 @c when you copy and paste a formula to a different field. So
2036 @c Org's @code{B3} behaves like @code{$B$3} in other spreadsheets.
2039 Org also uses another, more general operator that looks like this:
2041 @@@var{row}$@var{column}
2045 Column references can be absolute like @samp{1}, @samp{2},...@samp{@var{N}},
2046 or relative to the current column like @samp{+1} or @samp{-2}.
2048 The row specification only counts data lines and ignores horizontal
2049 separator lines (hlines). You can use absolute row numbers
2050 @samp{1}...@samp{@var{N}}, and row numbers relative to the current row like
2051 @samp{+3} or @samp{-1}. Or specify the row relative to one of the
2052 hlines: @samp{I} refers to the first hline@footnote{Note that only
2053 hlines are counted that @emph{separate} table lines. If the table
2054 starts with a hline above the header, it does not count.}, @samp{II} to
2055 the second, etc@. @samp{-I} refers to the first such line above the
2056 current line, @samp{+I} to the first such line below the current line.
2057 You can also write @samp{III+2} which is the second data line after the
2058 third hline in the table.
2060 @samp{0} refers to the current row and column. Also, if you omit
2061 either the column or the row part of the reference, the current
2062 row/column is implied.
2064 Org's references with @emph{unsigned} numbers are fixed references
2065 in the sense that if you use the same reference in the formula for two
2066 different fields, the same field will be referenced each time.
2067 Org's references with @emph{signed} numbers are floating
2068 references because the same reference operator can reference different
2069 fields depending on the field being calculated by the formula.
2071 As a special case, references like @samp{$LR5} and @samp{$LR12} can be used
2072 to refer in a stable way to the 5th and 12th field in the last row of the
2075 Here are a few examples:
2078 @@2$3 @r{2nd row, 3rd column}
2079 C2 @r{same as previous}
2080 $5 @r{column 5 in the current row}
2081 E& @r{same as previous}
2082 @@2 @r{current column, row 2}
2083 @@-1$-3 @r{the field one row up, three columns to the left}
2084 @@-I$2 @r{field just under hline above current row, column 2}
2087 @subsubheading Range references
2088 @cindex range references
2089 @cindex references, to ranges
2091 You may reference a rectangular range of fields by specifying two field
2092 references connected by two dots @samp{..}. If both fields are in the
2093 current row, you may simply use @samp{$2..$7}, but if at least one field
2094 is in a different row, you need to use the general @code{@@row$column}
2095 format at least for the first field (i.e the reference must start with
2096 @samp{@@} in order to be interpreted correctly). Examples:
2099 $1..$3 @r{First three fields in the current row.}
2100 $P..$Q @r{Range, using column names (see under Advanced)}
2101 @@2$1..@@4$3 @r{6 fields between these two fields.}
2102 A2..C4 @r{Same as above.}
2103 @@-1$-2..@@-1 @r{3 numbers from the column to the left, 2 up to current row}
2106 @noindent Range references return a vector of values that can be fed
2107 into Calc vector functions. Empty fields in ranges are normally
2108 suppressed, so that the vector contains only the non-empty fields (but
2109 see the @samp{E} mode switch below). If there are no non-empty fields,
2110 @samp{[0]} is returned to avoid syntax errors in formulas.
2112 @subsubheading Field coordinates in formulas
2113 @cindex field coordinates
2114 @cindex coordinates, of field
2115 @cindex row, of field coordinates
2116 @cindex column, of field coordinates
2118 For Calc formulas and Lisp formulas @code{@@#} and @code{$#} can be used to
2119 get the row or column number of the field where the formula result goes.
2120 The traditional Lisp formula equivalents are @code{org-table-current-dline}
2121 and @code{org-table-current-column}. Examples:
2124 if(@@# % 2, $#, string("")) @r{column number on odd lines only}
2125 $3 = remote(FOO, @@@@#$2) @r{copy column 2 from table FOO into}
2126 @r{column 3 of the current table}
2129 @noindent For the second example, table FOO must have at least as many rows
2130 as the current table. Inefficient@footnote{The computation time scales as
2131 O(N^2) because table FOO is parsed for each field to be copied.} for large
2134 @subsubheading Named references
2135 @cindex named references
2136 @cindex references, named
2137 @cindex name, of column or field
2138 @cindex constants, in calculations
2141 @vindex org-table-formula-constants
2142 @samp{$name} is interpreted as the name of a column, parameter or
2143 constant. Constants are defined globally through the variable
2144 @code{org-table-formula-constants}, and locally (for the file) through a
2148 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
2152 @vindex constants-unit-system
2153 @pindex constants.el
2154 Also properties (@pxref{Properties and Columns}) can be used as
2155 constants in table formulas: for a property @samp{:Xyz:} use the name
2156 @samp{$PROP_Xyz}, and the property will be searched in the current
2157 outline entry and in the hierarchy above it. If you have the
2158 @file{constants.el} package, it will also be used to resolve constants,
2159 including natural constants like @samp{$h} for Planck's constant, and
2160 units like @samp{$km} for kilometers@footnote{@file{constants.el} can
2161 supply the values of constants in two different unit systems, @code{SI}
2162 and @code{cgs}. Which one is used depends on the value of the variable
2163 @code{constants-unit-system}. You can use the @code{#+STARTUP} options
2164 @code{constSI} and @code{constcgs} to set this value for the current
2165 buffer.}. Column names and parameters can be specified in special table
2166 lines. These are described below, see @ref{Advanced features}. All
2167 names must start with a letter, and further consist of letters and
2170 @subsubheading Remote references
2171 @cindex remote references
2172 @cindex references, remote
2173 @cindex references, to a different table
2174 @cindex name, of column or field
2175 @cindex constants, in calculations
2178 You may also reference constants, fields and ranges from a different table,
2179 either in the current file or even in a different file. The syntax is
2182 remote(NAME-OR-ID,REF)
2186 where NAME can be the name of a table in the current file as set by a
2187 @code{#+TBLNAME: NAME} line before the table. It can also be the ID of an
2188 entry, even in a different file, and the reference then refers to the first
2189 table in that entry. REF is an absolute field or range reference as
2190 described above for example @code{@@3$3} or @code{$somename}, valid in the
2193 @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet
2194 @subsection Formula syntax for Calc
2195 @cindex formula syntax, Calc
2196 @cindex syntax, of formulas
2198 A formula can be any algebraic expression understood by the Emacs
2199 @file{Calc} package. @b{Note that @file{calc} has the
2200 non-standard convention that @samp{/} has lower precedence than
2201 @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.} Before
2202 evaluation by @code{calc-eval} (@pxref{Calling Calc from
2203 Your Programs,calc-eval,Calling Calc from Your Lisp Programs,Calc,GNU
2204 Emacs Calc Manual}),
2205 @c FIXME: The link to the Calc manual in HTML does not work.
2206 variable substitution takes place according to the rules described above.
2207 @cindex vectors, in table calculations
2208 The range vectors can be directly fed into the Calc vector functions
2209 like @samp{vmean} and @samp{vsum}.
2211 @cindex format specifier
2212 @cindex mode, for @file{calc}
2213 @vindex org-calc-default-modes
2214 A formula can contain an optional mode string after a semicolon. This
2215 string consists of flags to influence Calc and other modes during
2216 execution. By default, Org uses the standard Calc modes (precision
2217 12, angular units degrees, fraction and symbolic modes off). The display
2218 format, however, has been changed to @code{(float 8)} to keep tables
2219 compact. The default settings can be configured using the variable
2220 @code{org-calc-default-modes}.
2223 p20 @r{set the internal Calc calculation precision to 20 digits}
2224 n3 s3 e2 f4 @r{Normal, scientific, engineering, or fixed}
2225 @r{format of the result of Calc passed back to Org.}
2226 @r{Calc formatting is unlimited in precision as}
2227 @r{long as the Calc calculation precision is greater.}
2228 D R @r{angle modes: degrees, radians}
2229 F S @r{fraction and symbolic modes}
2230 N @r{interpret all fields as numbers, use 0 for non-numbers}
2231 T @r{force text interpretation}
2232 E @r{keep empty fields in ranges}
2237 Unless you use large integer numbers or high-precision-calculation
2238 and -display for floating point numbers you may alternatively provide a
2239 @code{printf} format specifier to reformat the Calc result after it has been
2240 passed back to Org instead of letting Calc already do the
2241 formatting@footnote{The @code{printf} reformatting is limited in precision
2242 because the value passed to it is converted into an @code{integer} or
2243 @code{double}. The @code{integer} is limited in size by truncating the
2244 signed value to 32 bits. The @code{double} is limited in precision to 64
2245 bits overall which leaves approximately 16 significant decimal digits.}.
2249 $1+$2 @r{Sum of first and second field}
2250 $1+$2;%.2f @r{Same, format result to two decimals}
2251 exp($2)+exp($1) @r{Math functions can be used}
2252 $0;%.1f @r{Reformat current cell to 1 decimal}
2253 ($3-32)*5/9 @r{Degrees F -> C conversion}
2254 $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}}
2255 tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1}
2256 sin($1);Dp3%.1e @r{Same, but use printf specifier for display}
2257 vmean($2..$7) @r{Compute column range mean, using vector function}
2258 vmean($2..$7);EN @r{Same, but treat empty fields as 0}
2259 taylor($3,x=7,2) @r{taylor series of $3, at x=7, second degree}
2262 Calc also contains a complete set of logical operations. For example
2265 if($1<20,teen,string("")) @r{``teen'' if age $1 less than 20, else empty}
2268 @node Formula syntax for Lisp, Field formulas, Formula syntax for Calc, The spreadsheet
2269 @subsection Emacs Lisp forms as formulas
2270 @cindex Lisp forms, as table formulas
2272 It is also possible to write a formula in Emacs Lisp; this can be useful
2273 for string manipulation and control structures, if Calc's
2274 functionality is not enough. If a formula starts with a single-quote
2275 followed by an opening parenthesis, then it is evaluated as a Lisp form.
2276 The evaluation should return either a string or a number. Just as with
2277 @file{calc} formulas, you can specify modes and a printf format after a
2278 semicolon. With Emacs Lisp forms, you need to be conscious about the way
2279 field references are interpolated into the form. By default, a
2280 reference will be interpolated as a Lisp string (in double-quotes)
2281 containing the field. If you provide the @samp{N} mode switch, all
2282 referenced elements will be numbers (non-number fields will be zero) and
2283 interpolated as Lisp numbers, without quotes. If you provide the
2284 @samp{L} flag, all fields will be interpolated literally, without quotes.
2285 I.e., if you want a reference to be interpreted as a string by the Lisp
2286 form, enclose the reference operator itself in double-quotes, like
2287 @code{"$3"}. Ranges are inserted as space-separated fields, so you can
2288 embed them in list or vector syntax. A few examples, note how the
2289 @samp{N} mode is used when we do computations in Lisp.
2292 @r{Swap the first two characters of the content of column 1}
2293 '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
2294 @r{Add columns 1 and 2, equivalent to Calc's @code{$1+$2}}
2296 @r{Compute the sum of columns 1-4, like Calc's @code{vsum($1..$4)}}
2297 '(apply '+ '($1..$4));N
2300 @node Field formulas, Column formulas, Formula syntax for Lisp, The spreadsheet
2301 @subsection Field formulas
2302 @cindex field formula
2303 @cindex formula, for individual table field
2305 To assign a formula to a particular field, type it directly into the
2306 field, preceded by @samp{:=}, for example @samp{:=$1+$2}. When you
2307 press @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in
2308 the field, the formula will be stored as the formula for this field,
2309 evaluated, and the current field replaced with the result.
2312 Formulas are stored in a special line starting with @samp{#+TBLFM:}
2313 directly below the table. If you typed the equation in the 4th field of
2314 the 3rd data line in the table, the formula will look like
2315 @samp{@@3$4=$1+$2}. When inserting/deleting/swapping column and rows
2316 with the appropriate commands, @i{absolute references} (but not relative
2317 ones) in stored formulas are modified in order to still reference the
2318 same field. Of course this is not true if you edit the table structure
2319 with normal editing commands---then you must fix the equations yourself.
2320 The left-hand side of a formula may also be a named field (@pxref{Advanced
2321 features}), or a last-row reference like @samp{$LR3}.
2323 Instead of typing an equation into the field, you may also use the
2329 Install a new formula for the current field. The command prompts for a
2330 formula with default taken from the @samp{#+TBLFM:} line, applies
2331 it to the current field, and stores it.
2334 @node Column formulas, Editing and debugging formulas, Field formulas, The spreadsheet
2335 @subsection Column formulas
2336 @cindex column formula
2337 @cindex formula, for table column
2339 Often in a table, the same formula should be used for all fields in a
2340 particular column. Instead of having to copy the formula to all fields
2341 in that column, Org allows you to assign a single formula to an entire
2342 column. If the table contains horizontal separator hlines, everything
2343 before the first such line is considered part of the table @emph{header}
2344 and will not be modified by column formulas.
2346 To assign a formula to a column, type it directly into any field in the
2347 column, preceded by an equal sign, like @samp{=$1+$2}. When you press
2348 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2349 the formula will be stored as the formula for the current column, evaluated
2350 and the current field replaced with the result. If the field contains only
2351 @samp{=}, the previously stored formula for this column is used. For each
2352 column, Org will only remember the most recently used formula. In the
2353 @samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}. The left-hand
2354 side of a column formula cannot currently be the name of column, it
2355 must be the numeric column reference.
2357 Instead of typing an equation into the field, you may also use the
2363 Install a new formula for the current column and replace current field with
2364 the result of the formula. The command prompts for a formula, with default
2365 taken from the @samp{#+TBLFM} line, applies it to the current field and
2366 stores it. With a numeric prefix argument(e.g. @kbd{C-5 C-c =}) the command
2367 will apply it to that many consecutive fields in the current column.
2370 @node Editing and debugging formulas, Updating the table, Column formulas, The spreadsheet
2371 @subsection Editing and debugging formulas
2372 @cindex formula editing
2373 @cindex editing, of table formulas
2375 @vindex org-table-use-standard-references
2376 You can edit individual formulas in the minibuffer or directly in the
2377 field. Org can also prepare a special buffer with all active
2378 formulas of a table. When offering a formula for editing, Org
2379 converts references to the standard format (like @code{B3} or @code{D&})
2380 if possible. If you prefer to only work with the internal format (like
2381 @code{@@3$2} or @code{$4}), configure the variable
2382 @code{org-table-use-standard-references}.
2389 Edit the formula associated with the current column/field in the
2390 minibuffer. See @ref{Column formulas}, and @ref{Field formulas}.
2391 @kindex C-u C-u C-c =
2393 Re-insert the active formula (either a
2394 field formula, or a column formula) into the current field, so that you
2395 can edit it directly in the field. The advantage over editing in the
2396 minibuffer is that you can use the command @kbd{C-c ?}.
2399 While editing a formula in a table field, highlight the field(s)
2400 referenced by the reference at the cursor position in the formula.
2403 Toggle the display of row and column numbers for a table, using
2404 overlays. These are updated each time the table is aligned; you can
2405 force it with @kbd{C-c C-c}.
2408 Toggle the formula debugger on and off. See below.
2411 Edit all formulas for the current table in a special buffer, where the
2412 formulas will be displayed one per line. If the current field has an
2413 active formula, the cursor in the formula editor will mark it.
2414 While inside the special buffer, Org will automatically highlight
2415 any field or range reference at the cursor position. You may edit,
2416 remove and add formulas, and use the following commands:
2422 Exit the formula editor and store the modified formulas. With @kbd{C-u}
2423 prefix, also apply the new formulas to the entire table.
2426 Exit the formula editor without installing changes.
2429 Toggle all references in the formula editor between standard (like
2430 @code{B3}) and internal (like @code{@@3$2}).
2433 Pretty-print or indent Lisp formula at point. When in a line containing
2434 a Lisp formula, format the formula according to Emacs Lisp rules.
2435 Another @key{TAB} collapses the formula back again. In the open
2436 formula, @key{TAB} re-indents just like in Emacs Lisp mode.
2439 Complete Lisp symbols, just like in Emacs Lisp mode.
2441 @kindex S-@key{down}
2442 @kindex S-@key{left}
2443 @kindex S-@key{right}
2444 @item S-@key{up}/@key{down}/@key{left}/@key{right}
2445 Shift the reference at point. For example, if the reference is
2446 @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
2447 This also works for relative references and for hline references.
2448 @kindex M-S-@key{up}
2449 @kindex M-S-@key{down}
2450 @item M-S-@key{up}/@key{down}
2451 Move the test line for column formulas in the Org buffer up and
2454 @kindex M-@key{down}
2455 @item M-@key{up}/@key{down}
2456 Scroll the window displaying the table.
2459 Turn the coordinate grid in the table on and off.
2463 Making a table field blank does not remove the formula associated with
2464 the field, because that is stored in a different line (the @samp{#+TBLFM}
2465 line)---during the next recalculation the field will be filled again.
2466 To remove a formula from a field, you have to give an empty reply when
2467 prompted for the formula, or to edit the @samp{#+TBLFM} line.
2470 You may edit the @samp{#+TBLFM} directly and re-apply the changed
2471 equations with @kbd{C-c C-c} in that line or with the normal
2472 recalculation commands in the table.
2474 @subsubheading Debugging formulas
2475 @cindex formula debugging
2476 @cindex debugging, of table formulas
2477 When the evaluation of a formula leads to an error, the field content
2478 becomes the string @samp{#ERROR}. If you would like see what is going
2479 on during variable substitution and calculation in order to find a bug,
2480 turn on formula debugging in the @code{Tbl} menu and repeat the
2481 calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
2482 field. Detailed information will be displayed.
2484 @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet
2485 @subsection Updating the table
2486 @cindex recomputing table fields
2487 @cindex updating, table
2489 Recalculation of a table is normally not automatic, but needs to be
2490 triggered by a command. See @ref{Advanced features}, for a way to make
2491 recalculation at least semi-automatic.
2493 In order to recalculate a line of a table or the entire table, use the
2499 Recalculate the current row by first applying the stored column formulas
2500 from left to right, and all field formulas in the current row.
2506 Recompute the entire table, line by line. Any lines before the first
2507 hline are left alone, assuming that these are part of the table header.
2509 @kindex C-u C-u C-c *
2510 @kindex C-u C-u C-c C-c
2512 @itemx C-u C-u C-c C-c
2513 Iterate the table by recomputing it until no further changes occur.
2514 This may be necessary if some computed fields use the value of other
2515 fields that are computed @i{later} in the calculation sequence.
2516 @item M-x org-table-recalculate-buffer-tables
2517 Recompute all tables in the current buffer.
2518 @item M-x org-table-iterate-buffer-tables
2519 Iterate all tables in the current buffer, in order to converge table-to-table
2523 @node Advanced features, , Updating the table, The spreadsheet
2524 @subsection Advanced features
2526 If you want the recalculation of fields to happen automatically, or if
2527 you want to be able to assign @i{names} to fields and columns, you need
2528 to reserve the first column of the table for special marking characters.
2532 Rotate the calculation mark in first column through the states @samp{ },
2533 @samp{#}, @samp{*}, @samp{!}, @samp{$}. When there is an active region,
2534 change all marks in the region.
2537 Here is an example of a table that collects exam results of students and
2538 makes use of these features:
2542 |---+---------+--------+--------+--------+-------+------|
2543 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
2544 |---+---------+--------+--------+--------+-------+------|
2545 | ! | | P1 | P2 | P3 | Tot | |
2546 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
2547 | ^ | | m1 | m2 | m3 | mt | |
2548 |---+---------+--------+--------+--------+-------+------|
2549 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
2550 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
2551 |---+---------+--------+--------+--------+-------+------|
2552 | | Average | | | | 29.7 | |
2553 | ^ | | | | | at | |
2554 | $ | max=50 | | | | | |
2555 |---+---------+--------+--------+--------+-------+------|
2556 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
2560 @noindent @b{Important}: please note that for these special tables,
2561 recalculating the table with @kbd{C-u C-c *} will only affect rows that
2562 are marked @samp{#} or @samp{*}, and fields that have a formula assigned
2563 to the field itself. The column formulas are not applied in rows with
2566 @cindex marking characters, tables
2567 The marking characters have the following meaning:
2570 The fields in this line define names for the columns, so that you may
2571 refer to a column as @samp{$Tot} instead of @samp{$6}.
2573 This row defines names for the fields @emph{above} the row. With such
2574 a definition, any formula in the table may use @samp{$m1} to refer to
2575 the value @samp{10}. Also, if you assign a formula to a names field, it
2576 will be stored as @samp{$name=...}.
2578 Similar to @samp{^}, but defines names for the fields in the row
2581 Fields in this row can define @emph{parameters} for formulas. For
2582 example, if a field in a @samp{$} row contains @samp{max=50}, then
2583 formulas in this table can refer to the value 50 using @samp{$max}.
2584 Parameters work exactly like constants, only that they can be defined on
2587 Fields in this row are automatically recalculated when pressing
2588 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row
2589 is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked
2590 lines will be left alone by this command.
2592 Selects this line for global recalculation with @kbd{C-u C-c *}, but
2593 not for automatic recalculation. Use this when automatic
2594 recalculation slows down editing too much.
2596 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
2597 All lines that should be recalculated should be marked with @samp{#}
2600 Do not export this line. Useful for lines that contain the narrowing
2601 @samp{<N>} markers or column group markers.
2604 Finally, just to whet your appetite for what can be done with the
2605 fantastic @file{calc.el} package, here is a table that computes the Taylor
2606 series of degree @code{n} at location @code{x} for a couple of
2611 |---+-------------+---+-----+--------------------------------------|
2612 | | Func | n | x | Result |
2613 |---+-------------+---+-----+--------------------------------------|
2614 | # | exp(x) | 1 | x | 1 + x |
2615 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
2616 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
2617 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
2618 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
2619 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
2620 |---+-------------+---+-----+--------------------------------------|
2621 #+TBLFM: $5=taylor($2,$4,$3);n3
2625 @node Org-Plot, , The spreadsheet, Tables
2627 @cindex graph, in tables
2628 @cindex plot tables using Gnuplot
2631 Org-Plot can produce 2D and 3D graphs of information stored in org tables
2632 using @file{Gnuplot} @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
2633 @uref{http://cars9.uchicago.edu/~ravel/software/gnuplot-mode.html}. To see
2634 this in action, ensure that you have both Gnuplot and Gnuplot mode installed
2635 on your system, then call @code{org-plot/gnuplot} on the following table.
2639 #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
2640 | Sede | Max cites | H-index |
2641 |-----------+-----------+---------|
2642 | Chile | 257.72 | 21.39 |
2643 | Leeds | 165.77 | 19.68 |
2644 | Sao Paolo | 71.00 | 11.50 |
2645 | Stockholm | 134.19 | 14.33 |
2646 | Morelia | 257.56 | 17.67 |
2650 Notice that Org Plot is smart enough to apply the table's headers as labels.
2651 Further control over the labels, type, content, and appearance of plots can
2652 be exercised through the @code{#+PLOT:} lines preceding a table. See below
2653 for a complete list of Org-plot options. For more information and examples
2654 see the Org-plot tutorial at
2655 @uref{http://orgmode.org/worg/org-tutorials/org-plot.php}.
2657 @subsubheading Plot Options
2661 Specify any @command{gnuplot} option to be set when graphing.
2664 Specify the title of the plot.
2667 Specify which column of the table to use as the @code{x} axis.
2670 Specify the columns to graph as a Lisp style list, surrounded by parentheses
2671 and separated by spaces for example @code{dep:(3 4)} to graph the third and
2672 fourth columns (defaults to graphing all other columns aside from the @code{ind}
2676 Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
2679 Specify a @code{with} option to be inserted for every col being plotted
2680 (e.g. @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
2681 Defaults to @code{lines}.
2684 If you want to plot to a file, specify @code{"@var{path/to/desired/output-file}"}.
2687 List of labels to be used for the deps (defaults to the column headers if
2691 Specify an entire line to be inserted in the Gnuplot script.
2694 When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
2695 flat mapping rather than a @code{3d} slope.
2698 Specify format of Org-mode timestamps as they will be parsed by Gnuplot.
2699 Defaults to @samp{%Y-%m-%d-%H:%M:%S}.
2702 If you want total control, you can specify a script file (place the file name
2703 between double-quotes) which will be used to plot. Before plotting, every
2704 instance of @code{$datafile} in the specified script will be replaced with
2705 the path to the generated data file. Note: even if you set this option, you
2706 may still want to specify the plot type, as that can impact the content of
2710 @node Hyperlinks, TODO Items, Tables, Top
2714 Like HTML, Org provides links inside a file, external links to
2715 other files, Usenet articles, emails, and much more.
2718 * Link format:: How links in Org are formatted
2719 * Internal links:: Links to other places in the current file
2720 * External links:: URL-like links to the world
2721 * Handling links:: Creating, inserting and following
2722 * Using links outside Org:: Linking from my C source code?
2723 * Link abbreviations:: Shortcuts for writing complex links
2724 * Search options:: Linking to a specific location
2725 * Custom searches:: When the default search is not enough
2728 @node Link format, Internal links, Hyperlinks, Hyperlinks
2729 @section Link format
2731 @cindex format, of links
2733 Org will recognize plain URL-like links and activate them as
2734 clickable links. The general link format, however, looks like this:
2737 [[link][description]] @r{or alternatively} [[link]]
2741 Once a link in the buffer is complete (all brackets present), Org
2742 will change the display so that @samp{description} is displayed instead
2743 of @samp{[[link][description]]} and @samp{link} is displayed instead of
2744 @samp{[[link]]}. Links will be highlighted in the face @code{org-link},
2745 which by default is an underlined face. You can directly edit the
2746 visible part of a link. Note that this can be either the @samp{link}
2747 part (if there is no description) or the @samp{description} part. To
2748 edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
2751 If you place the cursor at the beginning or just behind the end of the
2752 displayed text and press @key{BACKSPACE}, you will remove the
2753 (invisible) bracket at that location. This makes the link incomplete
2754 and the internals are again displayed as plain text. Inserting the
2755 missing bracket hides the link internals again. To show the
2756 internal structure of all links, use the menu entry
2757 @code{Org->Hyperlinks->Literal links}.
2759 @node Internal links, External links, Link format, Hyperlinks
2760 @section Internal links
2761 @cindex internal links
2762 @cindex links, internal
2763 @cindex targets, for links
2765 @cindex property, CUSTOM_ID
2766 If the link does not look like a URL, it is considered to be internal in the
2767 current file. The most important case is a link like
2768 @samp{[[#my-custom-id]]} which will link to the entry with the
2769 @code{CUSTOM_ID} property @samp{my-custom-id}. Such custom IDs are very good
2770 for HTML export (@pxref{HTML export}) where they produce pretty section
2771 links. You are responsible yourself to make sure these custom IDs are unique
2774 Links such as @samp{[[My Target]]} or @samp{[[My Target][Find my target]]}
2775 lead to a text search in the current file.
2777 The link can be followed with @kbd{C-c C-o} when the cursor is on the link,
2778 or with a mouse click (@pxref{Handling links}). Links to custom IDs will
2779 point to the corresponding headline. The preferred match for a text link is
2780 a @i{dedicated target}: the same string in double angular brackets. Targets
2781 may be located anywhere; sometimes it is convenient to put them into a
2782 comment line. For example
2788 @noindent In HTML export (@pxref{HTML export}), such targets will become
2789 named anchors for direct access through @samp{http} links@footnote{Note that
2790 text before the first headline is usually not exported, so the first such
2791 target should be after the first headline, or in the line directly before the
2794 If no dedicated target exists, Org will search for a headline that is exactly
2795 the link text but may also include a TODO keyword and tags@footnote{To insert
2796 a link targeting a headline, in-buffer completion can be used. Just type a
2797 star followed by a few optional letters into the buffer and press
2798 @kbd{M-@key{TAB}}. All headlines in the current buffer will be offered as
2799 completions.}. In non-Org files, the search will look for the words in the
2800 link text, in the above example the search would be for @samp{my target}.
2802 Following a link pushes a mark onto Org's own mark ring. You can
2803 return to the previous position with @kbd{C-c &}. Using this command
2804 several times in direct succession goes back to positions recorded
2808 * Radio targets:: Make targets trigger links in plain text
2811 @node Radio targets, , Internal links, Internal links
2812 @subsection Radio targets
2813 @cindex radio targets
2814 @cindex targets, radio
2815 @cindex links, radio targets
2817 Org can automatically turn any occurrences of certain target names
2818 in normal text into a link. So without explicitly creating a link, the
2819 text connects to the target radioing its position. Radio targets are
2820 enclosed by triple angular brackets. For example, a target @samp{<<<My
2821 Target>>>} causes each occurrence of @samp{my target} in normal text to
2822 become activated as a link. The Org file is scanned automatically
2823 for radio targets only when the file is first loaded into Emacs. To
2824 update the target list during editing, press @kbd{C-c C-c} with the
2825 cursor on or at a target.
2827 @node External links, Handling links, Internal links, Hyperlinks
2828 @section External links
2829 @cindex links, external
2830 @cindex external links
2831 @cindex links, external
2839 @cindex WANDERLUST links
2841 @cindex USENET links
2846 Org supports links to files, websites, Usenet and email messages,
2847 BBDB database entries and links to both IRC conversations and their
2848 logs. External links are URL-like locators. They start with a short
2849 identifying string followed by a colon. There can be no space after
2850 the colon. The following list shows examples for each link type.
2853 http://www.astro.uva.nl/~dominik @r{on the web}
2854 doi:10.1000/182 @r{DOI for an electronic resource}
2855 file:/home/dominik/images/jupiter.jpg @r{file, absolute path}
2856 /home/dominik/images/jupiter.jpg @r{same as above}
2857 file:papers/last.pdf @r{file, relative path}
2858 ./papers/last.pdf @r{same as above}
2859 file:/myself@@some.where:papers/last.pdf @r{file, path on remote machine}
2860 /myself@@some.where:papers/last.pdf @r{same as above}
2861 file:sometextfile::NNN @r{file with line number to jump to}
2862 file:projects.org @r{another Org file}
2863 file:projects.org::some words @r{text search in Org file}
2864 file:projects.org::*task title @r{heading search in Org file}
2865 docview:papers/last.pdf::NNN @r{open file in doc-view mode at page NNN}
2866 id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID}
2867 news:comp.emacs @r{Usenet link}
2868 mailto:adent@@galaxy.net @r{Mail link}
2869 vm:folder @r{VM folder link}
2870 vm:folder#id @r{VM message link}
2871 vm://myself@@some.where.org/folder#id @r{VM on remote machine}
2872 wl:folder @r{WANDERLUST folder link}
2873 wl:folder#id @r{WANDERLUST message link}
2874 mhe:folder @r{MH-E folder link}
2875 mhe:folder#id @r{MH-E message link}
2876 rmail:folder @r{RMAIL folder link}
2877 rmail:folder#id @r{RMAIL message link}
2878 gnus:group @r{Gnus group link}
2879 gnus:group#id @r{Gnus article link}
2880 bbdb:R.*Stallman @r{BBDB link (with regexp)}
2881 irc:/irc.com/#emacs/bob @r{IRC link}
2882 info:org:External%20links @r{Info node link (with encoded space)}
2883 shell:ls *.org @r{A shell command}
2884 elisp:org-agenda @r{Interactive Elisp command}
2885 elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
2888 A link should be enclosed in double brackets and may contain a
2889 descriptive text to be displayed instead of the URL (@pxref{Link
2890 format}), for example:
2893 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
2897 If the description is a file name or URL that points to an image, HTML
2898 export (@pxref{HTML export}) will inline the image as a clickable
2899 button. If there is no description at all and the link points to an
2901 that image will be inlined into the exported HTML file.
2903 @cindex square brackets, around links
2904 @cindex plain text external links
2905 Org also finds external links in the normal text and activates them
2906 as links. If spaces must be part of the link (for example in
2907 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
2908 about the end of the link, enclose them in square brackets.
2910 @node Handling links, Using links outside Org, External links, Hyperlinks
2911 @section Handling links
2912 @cindex links, handling
2914 Org provides methods to create a link in the correct syntax, to
2915 insert it into an Org file, and to follow the link.
2919 @cindex storing links
2921 Store a link to the current location. This is a @emph{global} command (you
2922 must create the key binding yourself) which can be used in any buffer to
2923 create a link. The link will be stored for later insertion into an Org
2924 buffer (see below). What kind of link will be created depends on the current
2927 @b{Org-mode buffers}@*
2928 For Org files, if there is a @samp{<<target>>} at the cursor, the link points
2929 to the target. Otherwise it points to the current headline, which will also
2932 @vindex org-link-to-org-use-id
2933 @cindex property, CUSTOM_ID
2934 @cindex property, ID
2935 If the headline has a @code{CUSTOM_ID} property, a link to this custom ID
2936 will be stored. In addition or alternatively (depending on the value of
2937 @code{org-link-to-org-use-id}), a globally unique @code{ID} property will be
2938 created and/or used to construct a link. So using this command in Org
2939 buffers will potentially create two links: a human-readable from the custom
2940 ID, and one that is globally unique and works even if the entry is moved from
2941 file to file. Later, when inserting the link, you need to decide which one
2944 @b{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus}@*
2945 Pretty much all Emacs mail clients are supported. The link will point to the
2946 current article, or, in some GNUS buffers, to the group. The description is
2947 constructed from the author and the subject.
2949 @b{Web browsers: W3 and W3M}@*
2950 Here the link will be the current URL, with the page title as description.
2952 @b{Contacts: BBDB}@*
2953 Links created in a BBDB buffer will point to the current entry.
2956 @vindex org-irc-link-to-logs
2957 For IRC links, if you set the variable @code{org-irc-link-to-logs} to
2958 @code{t}, a @samp{file:/} style link to the relevant point in the logs for
2959 the current conversation is created. Otherwise an @samp{irc:/} style link to
2960 the user/channel/server under the point will be stored.
2963 For any other files, the link will point to the file, with a search string
2964 (@pxref{Search options}) pointing to the contents of the current line. If
2965 there is an active region, the selected words will form the basis of the
2966 search string. If the automatically created link is not working correctly or
2967 accurately enough, you can write custom functions to select the search string
2968 and to do the search for particular file types---see @ref{Custom searches}.
2969 The key binding @kbd{C-c l} is only a suggestion---see @ref{Installation}.
2972 When the cursor is in an agenda view, the created link points to the
2973 entry referenced by the current line.
2977 @cindex link completion
2978 @cindex completion, of links
2979 @cindex inserting links
2981 @vindex org-keep-stored-link-after-insertion
2982 Insert a link@footnote{ Note that you don't have to use this command to
2983 insert a link. Links in Org are plain text, and you can type or paste them
2984 straight into the buffer. By using this command, the links are automatically
2985 enclosed in double brackets, and you will be asked for the optional
2986 descriptive text.}. This prompts for a link to be inserted into the buffer.
2987 You can just type a link, using text for an internal link, or one of the link
2988 type prefixes mentioned in the examples above. The link will be inserted
2989 into the buffer@footnote{After insertion of a stored link, the link will be
2990 removed from the list of stored links. To keep it in the list later use, use
2991 a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
2992 @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
2993 If some text was selected when this command is called, the selected text
2994 becomes the default description.
2996 @b{Inserting stored links}@*
2997 All links stored during the
2998 current session are part of the history for this prompt, so you can access
2999 them with @key{up} and @key{down} (or @kbd{M-p/n}).
3001 @b{Completion support}@* Completion with @key{TAB} will help you to insert
3002 valid link prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
3003 defined through link abbreviations (@pxref{Link abbreviations}). If you
3004 press @key{RET} after inserting only the @var{prefix}, Org will offer
3005 specific completion support for some link types@footnote{This works by
3006 calling a special function @code{org-PREFIX-complete-link}.} For
3007 example, if you type @kbd{file @key{RET}}, file name completion (alternative
3008 access: @kbd{C-u C-c C-l}, see below) will be offered, and after @kbd{bbdb
3009 @key{RET}} you can complete contact names.
3011 @cindex file name completion
3012 @cindex completion, of file names
3014 When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
3015 a file will be inserted and you may use file name completion to select
3016 the name of the file. The path to the file is inserted relative to the
3017 directory of the current Org file, if the linked file is in the current
3018 directory or in a sub-directory of it, or if the path is written relative
3019 to the current directory using @samp{../}. Otherwise an absolute path
3020 is used, if possible with @samp{~/} for your home directory. You can
3021 force an absolute path with two @kbd{C-u} prefixes.
3023 @item C-c C-l @ @r{(with cursor on existing link)}
3024 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
3025 link and description parts of the link.
3027 @cindex following links
3030 @item C-c C-o @ @r{(or, if @code{org-return-follows-link} is set, also} @key{RET}
3031 @vindex org-file-apps
3032 Open link at point. This will launch a web browser for URLs (using
3033 @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
3034 the corresponding links, and execute the command in a shell link. When the
3035 cursor is on an internal link, this command runs the corresponding search.
3036 When the cursor is on a TAG list in a headline, it creates the corresponding
3037 TAGS view. If the cursor is on a timestamp, it compiles the agenda for that
3038 date. Furthermore, it will visit text and remote files in @samp{file:} links
3039 with Emacs and select a suitable application for local non-text files.
3040 Classification of files is based on file extension only. See option
3041 @code{org-file-apps}. If you want to override the default application and
3042 visit the file with Emacs, use a @kbd{C-u} prefix. If you want to avoid
3043 opening in Emacs, use a @kbd{C-u C-u} prefix.@*
3044 If the cursor is on a headline, but not on a link, offer all links in the
3045 headline and entry text.
3051 On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
3052 would. Under Emacs 22, @kbd{mouse-1} will also follow a link.
3056 @vindex org-display-internal-link-with-indirect-buffer
3057 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
3058 internal links to be displayed in another window@footnote{See the
3059 variable @code{org-display-internal-link-with-indirect-buffer}}.
3061 @cindex inlining images
3062 @cindex images, inlining
3064 @vindex org-startup-with-inline-images
3065 @cindex @code{inlineimages}, STARTUP keyword
3066 @cindex @code{noinlineimages}, STARTUP keyword
3068 Toggle the inline display of linked images. Normally this will only inline
3069 images that have no description part in the link, i.e. images that will also
3070 be inlined during export. When called with a prefix argument, also display
3071 images that do have a link description. You can ask for inline images to be
3072 displayed at startup by configuring the variable
3073 @code{org-startup-with-inline-images}@footnote{with corresponding
3074 @code{#+STARTUP} keywords @code{inlineimages} and @code{inlineimages}}.
3078 Push the current position onto the mark ring, to be able to return
3079 easily. Commands following an internal link do this automatically.
3081 @cindex links, returning to
3084 Jump back to a recorded position. A position is recorded by the
3085 commands following internal links, and by @kbd{C-c %}. Using this
3086 command several times in direct succession moves through a ring of
3087 previously recorded positions.
3091 @cindex links, finding next/previous
3094 Move forward/backward to the next link in the buffer. At the limit of
3095 the buffer, the search fails once, and then wraps around. The key
3096 bindings for this are really too long, you might want to bind this also
3097 to @kbd{C-n} and @kbd{C-p}
3099 (add-hook 'org-load-hook
3101 (define-key 'org-mode-map "\C-n" 'org-next-link)
3102 (define-key 'org-mode-map "\C-p" 'org-previous-link)))
3106 @node Using links outside Org, Link abbreviations, Handling links, Hyperlinks
3107 @section Using links outside Org
3109 You can insert and follow links that have Org syntax not only in
3110 Org, but in any Emacs buffer. For this, you should create two
3111 global commands, like this (please select suitable global keys
3115 (global-set-key "\C-c L" 'org-insert-link-global)
3116 (global-set-key "\C-c o" 'org-open-at-point-global)
3119 @node Link abbreviations, Search options, Using links outside Org, Hyperlinks
3120 @section Link abbreviations
3121 @cindex link abbreviations
3122 @cindex abbreviation, links
3124 Long URLs can be cumbersome to type, and often many similar links are
3125 needed in a document. For this you can use link abbreviations. An
3126 abbreviated link looks like this
3129 [[linkword:tag][description]]
3133 @vindex org-link-abbrev-alist
3134 where the tag is optional.
3135 The @i{linkword} must be a word, starting with a letter, followed by
3136 letters, numbers, @samp{-}, and @samp{_}. Abbreviations are resolved
3137 according to the information in the variable @code{org-link-abbrev-alist}
3138 that relates the linkwords to replacement text. Here is an example:
3142 (setq org-link-abbrev-alist
3143 '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
3144 ("google" . "http://www.google.com/search?q=")
3145 ("gmap" . "http://maps.google.com/maps?q=%s")
3146 ("omap" . "http://nominatim.openstreetmap.org/search?q=%s&polygon=1")
3147 ("ads" . "http://adsabs.harvard.edu/cgi-bin/nph-abs_connect?author=%s&db_key=AST")))
3151 If the replacement text contains the string @samp{%s}, it will be
3152 replaced with the tag. Otherwise the tag will be appended to the string
3153 in order to create the link. You may also specify a function that will
3154 be called with the tag as the only argument to create the link.
3156 With the above setting, you could link to a specific bug with
3157 @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
3158 @code{[[google:OrgMode]]}, show the map location of the Free Software
3159 Foundation @code{[[gmap:51 Franklin Street, Boston]]} or of Carsten office
3160 @code{[[omap:Science Park 904, Amsterdam, The Netherlands]]} and find out
3161 what the Org author is doing besides Emacs hacking with
3162 @code{[[ads:Dominik,C]]}.
3164 If you need special abbreviations just for a single Org buffer, you
3165 can define them in the file with
3169 #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
3170 #+LINK: google http://www.google.com/search?q=%s
3174 In-buffer completion (@pxref{Completion}) can be used after @samp{[} to
3175 complete link abbreviations. You may also define a function
3176 @code{org-PREFIX-complete-link} that implements special (e.g. completion)
3177 support for inserting such a link with @kbd{C-c C-l}. Such a function should
3178 not accept any arguments, and return the full link with prefix.
3180 @node Search options, Custom searches, Link abbreviations, Hyperlinks
3181 @section Search options in file links
3182 @cindex search option in file links
3183 @cindex file links, searching
3185 File links can contain additional information to make Emacs jump to a
3186 particular location in the file when following a link. This can be a
3187 line number or a search option after a double@footnote{For backward
3188 compatibility, line numbers can also follow a single colon.} colon. For
3189 example, when the command @kbd{C-c l} creates a link (@pxref{Handling
3190 links}) to a file, it encodes the words in the current line as a search
3191 string that can be used to find this line back later when following the
3192 link with @kbd{C-c C-o}.
3194 Here is the syntax of the different ways to attach a search to a file
3195 link, together with an explanation:
3198 [[file:~/code/main.c::255]]
3199 [[file:~/xx.org::My Target]]
3200 [[file:~/xx.org::*My Target]]
3201 [[file:~/xx.org::#my-custom-id]]
3202 [[file:~/xx.org::/regexp/]]
3209 Search for a link target @samp{<<My Target>>}, or do a text search for
3210 @samp{my target}, similar to the search in internal links, see
3211 @ref{Internal links}. In HTML export (@pxref{HTML export}), such a file
3212 link will become an HTML reference to the corresponding named anchor in
3215 In an Org file, restrict search to headlines.
3217 Link to a heading with a @code{CUSTOM_ID} property
3219 Do a regular expression search for @code{regexp}. This uses the Emacs
3220 command @code{occur} to list all matches in a separate window. If the
3221 target file is in Org-mode, @code{org-occur} is used to create a
3222 sparse tree with the matches.
3223 @c If the target file is a directory,
3224 @c @code{grep} will be used to search all files in the directory.
3227 As a degenerate case, a file link with an empty file name can be used
3228 to search the current file. For example, @code{[[file:::find me]]} does
3229 a search for @samp{find me} in the current file, just as
3230 @samp{[[find me]]} would.
3232 @node Custom searches, , Search options, Hyperlinks
3233 @section Custom Searches
3234 @cindex custom search strings
3235 @cindex search strings, custom
3237 The default mechanism for creating search strings and for doing the
3238 actual search related to a file link may not work correctly in all
3239 cases. For example, Bib@TeX{} database files have many entries like
3240 @samp{year="1993"} which would not result in good search strings,
3241 because the only unique identification for a Bib@TeX{} entry is the
3244 @vindex org-create-file-search-functions
3245 @vindex org-execute-file-search-functions
3246 If you come across such a problem, you can write custom functions to set
3247 the right search string for a particular file type, and to do the search
3248 for the string in the file. Using @code{add-hook}, these functions need
3249 to be added to the hook variables
3250 @code{org-create-file-search-functions} and
3251 @code{org-execute-file-search-functions}. See the docstring for these
3252 variables for more information. Org actually uses this mechanism
3253 for Bib@TeX{} database files, and you can use the corresponding code as
3254 an implementation example. See the file @file{org-bibtex.el}.
3256 @node TODO Items, Tags, Hyperlinks, Top
3260 Org-mode does not maintain TODO lists as separate documents@footnote{Of
3261 course, you can make a document that contains only long lists of TODO items,
3262 but this is not required.}. Instead, TODO items are an integral part of the
3263 notes file, because TODO items usually come up while taking notes! With Org
3264 mode, simply mark any entry in a tree as being a TODO item. In this way,
3265 information is not duplicated, and the entire context from which the TODO
3266 item emerged is always present.
3268 Of course, this technique for managing TODO items scatters them
3269 throughout your notes file. Org-mode compensates for this by providing
3270 methods to give you an overview of all the things that you have to do.
3273 * TODO basics:: Marking and displaying TODO entries
3274 * TODO extensions:: Workflow and assignments
3275 * Progress logging:: Dates and notes for progress
3276 * Priorities:: Some things are more important than others
3277 * Breaking down tasks:: Splitting a task into manageable pieces
3278 * Checkboxes:: Tick-off lists
3281 @node TODO basics, TODO extensions, TODO Items, TODO Items
3282 @section Basic TODO functionality
3284 Any headline becomes a TODO item when it starts with the word
3285 @samp{TODO}, for example:
3288 *** TODO Write letter to Sam Fortune
3292 The most important commands to work with TODO entries are:
3296 @cindex cycling, of TODO states
3298 Rotate the TODO state of the current item among
3301 ,-> (unmarked) -> TODO -> DONE --.
3302 '--------------------------------'
3305 The same rotation can also be done ``remotely'' from the timeline and
3306 agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}).
3310 Select a specific keyword using completion or (if it has been set up)
3311 the fast selection interface. For the latter, you need to assign keys
3312 to TODO states, see @ref{Per-file keywords}, and @ref{Setting tags}, for
3315 @kindex S-@key{right}
3316 @kindex S-@key{left}
3317 @vindex org-treat-S-cursor-todo-selection-as-state-change
3320 Select the following/preceding TODO state, similar to cycling. Useful
3321 mostly if more than two TODO states are possible (@pxref{TODO
3322 extensions}). See also @ref{Conflicts}, for a discussion of the interaction
3323 with @code{shift-selection-mode}. See also the variable
3324 @code{org-treat-S-cursor-todo-selection-as-state-change}.
3326 @cindex sparse tree, for TODO
3328 @vindex org-todo-keywords
3329 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds the
3330 entire buffer, but shows all TODO items (with not-DONE state) and the
3331 headings hierarchy above them. With a prefix argument (or by using @kbd{C-c
3332 / T}), search for a specific TODO. You will be prompted for the keyword, and
3333 you can also give a list of keywords like @code{KWD1|KWD2|...} to list
3334 entries that match any one of these keywords. With numeric prefix argument
3335 N, show the tree for the Nth keyword in the variable
3336 @code{org-todo-keywords}. With two prefix arguments, find all TODO states,
3337 both un-done and done.
3340 Show the global TODO list. Collects the TODO items (with not-DONE states)
3341 from all agenda files (@pxref{Agenda Views}) into a single buffer. The new
3342 buffer will be in @code{agenda-mode}, which provides commands to examine and
3343 manipulate the TODO entries from the new buffer (@pxref{Agenda commands}).
3344 @xref{Global TODO list}, for more information.
3345 @kindex S-M-@key{RET}
3347 Insert a new TODO entry below the current one.
3351 @vindex org-todo-state-tags-triggers
3352 Changing a TODO state can also trigger tag changes. See the docstring of the
3353 option @code{org-todo-state-tags-triggers} for details.
3355 @node TODO extensions, Progress logging, TODO basics, TODO Items
3356 @section Extended use of TODO keywords
3357 @cindex extended TODO keywords
3359 @vindex org-todo-keywords
3360 By default, marked TODO entries have one of only two states: TODO and
3361 DONE. Org-mode allows you to classify TODO items in more complex ways
3362 with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With
3363 special setup, the TODO keyword system can work differently in different
3366 Note that @i{tags} are another way to classify headlines in general and
3367 TODO items in particular (@pxref{Tags}).
3370 * Workflow states:: From TODO to DONE in steps
3371 * TODO types:: I do this, Fred does the rest
3372 * Multiple sets in one file:: Mixing it all, and still finding your way
3373 * Fast access to TODO states:: Single letter selection of a state
3374 * Per-file keywords:: Different files, different requirements
3375 * Faces for TODO keywords:: Highlighting states
3376 * TODO dependencies:: When one task needs to wait for others
3379 @node Workflow states, TODO types, TODO extensions, TODO extensions
3380 @subsection TODO keywords as workflow states
3381 @cindex TODO workflow
3382 @cindex workflow states as TODO keywords
3384 You can use TODO keywords to indicate different @emph{sequential} states
3385 in the process of working on an item, for example@footnote{Changing
3386 this variable only becomes effective after restarting Org-mode in a
3390 (setq org-todo-keywords
3391 '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
3394 The vertical bar separates the TODO keywords (states that @emph{need
3395 action}) from the DONE states (which need @emph{no further action}). If
3396 you don't provide the separator bar, the last state is used as the DONE
3398 @cindex completion, of TODO keywords
3399 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
3400 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED. You may
3401 also use a numeric prefix argument to quickly select a specific state. For
3402 example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY.
3403 Or you can use @kbd{S-@key{left}} to go backward through the sequence. If you
3404 define many keywords, you can use in-buffer completion
3405 (@pxref{Completion}) or even a special one-key selection scheme
3406 (@pxref{Fast access to TODO states}) to insert these words into the
3407 buffer. Changing a TODO state can be logged with a timestamp, see
3408 @ref{Tracking TODO state changes}, for more information.
3410 @node TODO types, Multiple sets in one file, Workflow states, TODO extensions
3411 @subsection TODO keywords as types
3413 @cindex names as TODO keywords
3414 @cindex types as TODO keywords
3416 The second possibility is to use TODO keywords to indicate different
3417 @emph{types} of action items. For example, you might want to indicate
3418 that items are for ``work'' or ``home''. Or, when you work with several
3419 people on a single project, you might want to assign action items
3420 directly to persons, by using their names as TODO keywords. This would
3421 be set up like this:
3424 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
3427 In this case, different keywords do not indicate a sequence, but rather
3428 different types. So the normal work flow would be to assign a task to a
3429 person, and later to mark it DONE. Org-mode supports this style by adapting
3430 the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
3431 @kbd{t} command in the timeline and agenda buffers.}. When used several
3432 times in succession, it will still cycle through all names, in order to first
3433 select the right type for a task. But when you return to the item after some
3434 time and execute @kbd{C-c C-t} again, it will switch from any name directly
3435 to DONE. Use prefix arguments or completion to quickly select a specific
3436 name. You can also review the items of a specific TODO type in a sparse tree
3437 by using a numeric prefix to @kbd{C-c / t}. For example, to see all things
3438 Lucy has to do, you would use @kbd{C-3 C-c / t}. To collect Lucy's items
3439 from all agenda files into a single buffer, you would use the numeric prefix
3440 argument as well when creating the global TODO list: @kbd{C-3 C-c a t}.
3442 @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions
3443 @subsection Multiple keyword sets in one file
3444 @cindex TODO keyword sets
3446 Sometimes you may want to use different sets of TODO keywords in
3447 parallel. For example, you may want to have the basic
3448 @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
3449 separate state indicating that an item has been canceled (so it is not
3450 DONE, but also does not require action). Your setup would then look
3454 (setq org-todo-keywords
3455 '((sequence "TODO" "|" "DONE")
3456 (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
3457 (sequence "|" "CANCELED")))
3460 The keywords should all be different, this helps Org-mode to keep track
3461 of which subsequence should be used for a given entry. In this setup,
3462 @kbd{C-c C-t} only operates within a subsequence, so it switches from
3463 @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
3464 (nothing) to @code{REPORT}. Therefore you need a mechanism to initially
3465 select the correct sequence. Besides the obvious ways like typing a
3466 keyword or using completion, you may also apply the following commands:
3469 @kindex C-S-@key{right}
3470 @kindex C-S-@key{left}
3471 @kindex C-u C-u C-c C-t
3472 @item C-u C-u C-c C-t
3473 @itemx C-S-@key{right}
3474 @itemx C-S-@key{left}
3475 These keys jump from one TODO subset to the next. In the above example,
3476 @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{right}} would jump from @code{TODO} or
3477 @code{DONE} to @code{REPORT}, and any of the words in the second row to
3478 @code{CANCELED}. Note that the @kbd{C-S-} key binding conflict with
3479 @code{shift-selection-mode} (@pxref{Conflicts}).
3480 @kindex S-@key{right}
3481 @kindex S-@key{left}
3484 @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through @emph{all}
3485 keywords from all sets, so for example @kbd{S-@key{<right>}} would switch
3486 from @code{DONE} to @code{REPORT} in the example above. See also
3487 @ref{Conflicts}, for a discussion of the interaction with
3488 @code{shift-selection-mode}.
3491 @node Fast access to TODO states, Per-file keywords, Multiple sets in one file, TODO extensions
3492 @subsection Fast access to TODO states
3494 If you would like to quickly change an entry to an arbitrary TODO state
3495 instead of cycling through the states, you can set up keys for
3496 single-letter access to the states. This is done by adding the section
3497 key after each keyword, in parentheses. For example:
3500 (setq org-todo-keywords
3501 '((sequence "TODO(t)" "|" "DONE(d)")
3502 (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
3503 (sequence "|" "CANCELED(c)")))
3506 @vindex org-fast-tag-selection-include-todo
3507 If you then press @code{C-c C-t} followed by the selection key, the entry
3508 will be switched to this state. @key{SPC} can be used to remove any TODO
3509 keyword from an entry.@footnote{Check also the variable
3510 @code{org-fast-tag-selection-include-todo}, it allows you to change the TODO
3511 state through the tags interface (@pxref{Setting tags}), in case you like to
3512 mingle the two concepts. Note that this means you need to come up with
3513 unique keys across both sets of keywords.}
3515 @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions
3516 @subsection Setting up keywords for individual files
3517 @cindex keyword options
3518 @cindex per-file keywords
3523 It can be very useful to use different aspects of the TODO mechanism in
3524 different files. For file-local settings, you need to add special lines
3525 to the file which set the keywords and interpretation for that file
3526 only. For example, to set one of the two examples discussed above, you
3527 need one of the following lines, starting in column zero anywhere in the
3531 #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
3533 @noindent (you may also write @code{#+SEQ_TODO} to be explicit about the
3534 interpretation, but it means the same as @code{#+TODO}), or
3536 #+TYP_TODO: Fred Sara Lucy Mike | DONE
3539 A setup for using several sets in parallel would be:
3543 #+TODO: REPORT BUG KNOWNCAUSE | FIXED
3547 @cindex completion, of option keywords
3549 @noindent To make sure you are using the correct keyword, type
3550 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
3552 @cindex DONE, final TODO keyword
3553 Remember that the keywords after the vertical bar (or the last keyword
3554 if no bar is there) must always mean that the item is DONE (although you
3555 may use a different word). After changing one of these lines, use
3556 @kbd{C-c C-c} with the cursor still in the line to make the changes
3557 known to Org-mode@footnote{Org-mode parses these lines only when
3558 Org-mode is activated after visiting a file. @kbd{C-c C-c} with the
3559 cursor in a line starting with @samp{#+} is simply restarting Org-mode
3560 for the current buffer.}.
3562 @node Faces for TODO keywords, TODO dependencies, Per-file keywords, TODO extensions
3563 @subsection Faces for TODO keywords
3564 @cindex faces, for TODO keywords
3566 @vindex org-todo @r{(face)}
3567 @vindex org-done @r{(face)}
3568 @vindex org-todo-keyword-faces
3569 Org-mode highlights TODO keywords with special faces: @code{org-todo}
3570 for keywords indicating that an item still has to be acted upon, and
3571 @code{org-done} for keywords indicating that an item is finished. If
3572 you are using more than 2 different states, you might want to use
3573 special faces for some of them. This can be done using the variable
3574 @code{org-todo-keyword-faces}. For example:
3578 (setq org-todo-keyword-faces
3579 '(("TODO" . org-warning) ("STARTED" . "yellow")
3580 ("CANCELED" . (:foreground "blue" :weight bold))))
3584 While using a list with face properties as shown for CANCELED @emph{should}
3585 work, this does not aways seem to be the case. If necessary, define a
3586 special face and use that. A string is interpreted as a color. The variable
3587 @code{org-faces-easy-properties} determines if that color is interpreted as a
3588 foreground or a background color.
3590 @node TODO dependencies, , Faces for TODO keywords, TODO extensions
3591 @subsection TODO dependencies
3592 @cindex TODO dependencies
3593 @cindex dependencies, of TODO states
3595 @vindex org-enforce-todo-dependencies
3596 @cindex property, ORDERED
3597 The structure of Org files (hierarchy and lists) makes it easy to define TODO
3598 dependencies. Usually, a parent TODO task should not be marked DONE until
3599 all subtasks (defined as children tasks) are marked as DONE. And sometimes
3600 there is a logical sequence to a number of (sub)tasks, so that one task
3601 cannot be acted upon before all siblings above it are done. If you customize
3602 the variable @code{org-enforce-todo-dependencies}, Org will block entries
3603 from changing state to DONE while they have children that are not DONE.
3604 Furthermore, if an entry has a property @code{ORDERED}, each of its children
3605 will be blocked until all earlier siblings are marked DONE. Here is an
3609 * TODO Blocked until (two) is done
3618 ** TODO b, needs to wait for (a)
3619 ** TODO c, needs to wait for (a) and (b)
3625 @vindex org-track-ordered-property-with-tag
3626 @cindex property, ORDERED
3627 Toggle the @code{ORDERED} property of the current entry. A property is used
3628 for this behavior because this should be local to the current entry, not
3629 inherited like a tag. However, if you would like to @i{track} the value of
3630 this property with a tag for better visibility, customize the variable
3631 @code{org-track-ordered-property-with-tag}.
3632 @kindex C-u C-u C-u C-c C-t
3633 @item C-u C-u C-u C-c C-t
3634 Change TODO state, circumventing any state blocking.
3637 @vindex org-agenda-dim-blocked-tasks
3638 If you set the variable @code{org-agenda-dim-blocked-tasks}, TODO entries
3639 that cannot be closed because of such dependencies will be shown in a dimmed
3640 font or even made invisible in agenda views (@pxref{Agenda Views}).
3642 @cindex checkboxes and TODO dependencies
3643 @vindex org-enforce-todo-dependencies
3644 You can also block changes of TODO states by looking at checkboxes
3645 (@pxref{Checkboxes}). If you set the variable
3646 @code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked
3647 checkboxes will be blocked from switching to DONE.
3649 If you need more complex dependency structures, for example dependencies
3650 between entries in different trees or files, check out the contributed
3651 module @file{org-depend.el}.
3654 @node Progress logging, Priorities, TODO extensions, TODO Items
3655 @section Progress logging
3656 @cindex progress logging
3657 @cindex logging, of progress
3659 Org-mode can automatically record a timestamp and possibly a note when
3660 you mark a TODO item as DONE, or even each time you change the state of
3661 a TODO item. This system is highly configurable, settings can be on a
3662 per-keyword basis and can be localized to a file or even a subtree. For
3663 information on how to clock working time for a task, see @ref{Clocking
3667 * Closing items:: When was this entry marked DONE?
3668 * Tracking TODO state changes:: When did the status change?
3669 * Tracking your habits:: How consistent have you been?
3672 @node Closing items, Tracking TODO state changes, Progress logging, Progress logging
3673 @subsection Closing items
3675 The most basic logging is to keep track of @emph{when} a certain TODO
3676 item was finished. This is achieved with@footnote{The corresponding
3677 in-buffer setting is: @code{#+STARTUP: logdone}}.
3680 (setq org-log-done 'time)
3684 Then each time you turn an entry from a TODO (not-done) state into any
3685 of the DONE states, a line @samp{CLOSED: [timestamp]} will be inserted
3686 just after the headline. If you turn the entry back into a TODO item
3687 through further state cycling, that line will be removed again. If you
3688 want to record a note along with the timestamp, use@footnote{The
3689 corresponding in-buffer setting is: @code{#+STARTUP: lognotedone}}
3692 (setq org-log-done 'note)
3696 You will then be prompted for a note, and that note will be stored below
3697 the entry with a @samp{Closing Note} heading.
3699 In the timeline (@pxref{Timeline}) and in the agenda
3700 (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
3701 display the TODO items with a @samp{CLOSED} timestamp on each day,
3702 giving you an overview of what has been done.
3704 @node Tracking TODO state changes, Tracking your habits, Closing items, Progress logging
3705 @subsection Tracking TODO state changes
3706 @cindex drawer, for state change recording
3708 @vindex org-log-states-order-reversed
3709 @vindex org-log-into-drawer
3710 @cindex property, LOG_INTO_DRAWER
3711 When TODO keywords are used as workflow states (@pxref{Workflow states}), you
3712 might want to keep track of when a state change occurred and maybe take a
3713 note about this change. You can either record just a timestamp, or a
3714 time-stamped note for a change. These records will be inserted after the
3715 headline as an itemized list, newest first@footnote{See the variable
3716 @code{org-log-states-order-reversed}}. When taking a lot of notes, you might
3717 want to get the notes out of the way into a drawer (@pxref{Drawers}).
3718 Customize the variable @code{org-log-into-drawer} to get this
3719 behavior---the recommended drawer for this is called @code{LOGBOOK}. You can
3720 also overrule the setting of this variable for a subtree by setting a
3721 @code{LOG_INTO_DRAWER} property.
3723 Since it is normally too much to record a note for every state, Org-mode
3724 expects configuration on a per-keyword basis for this. This is achieved by
3725 adding special markers @samp{!} (for a timestamp) and @samp{@@} (for a note)
3726 in parentheses after each keyword. For example, with the setting
3729 (setq org-todo-keywords
3730 '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
3734 @vindex org-log-done
3735 you not only define global TODO keywords and fast access keys, but also
3736 request that a time is recorded when the entry is set to
3737 DONE@footnote{It is possible that Org-mode will record two timestamps
3738 when you are using both @code{org-log-done} and state change logging.
3739 However, it will never prompt for two notes---if you have configured
3740 both, the state change recording note will take precedence and cancel
3741 the @samp{Closing Note}.}, and that a note is recorded when switching to
3742 WAIT or CANCELED. The setting for WAIT is even more special: the
3743 @samp{!} after the slash means that in addition to the note taken when
3744 entering the state, a timestamp should be recorded when @i{leaving} the
3745 WAIT state, if and only if the @i{target} state does not configure
3746 logging for entering it. So it has no effect when switching from WAIT
3747 to DONE, because DONE is configured to record a timestamp only. But
3748 when switching from WAIT back to TODO, the @samp{/!} in the WAIT
3749 setting now triggers a timestamp even though TODO has no logging
3752 You can use the exact same syntax for setting logging preferences local
3755 #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
3758 @cindex property, LOGGING
3759 In order to define logging settings that are local to a subtree or a
3760 single item, define a LOGGING property in this entry. Any non-empty
3761 LOGGING property resets all logging settings to nil. You may then turn
3762 on logging for this specific tree using STARTUP keywords like
3763 @code{lognotedone} or @code{logrepeat}, as well as adding state specific
3764 settings like @code{TODO(!)}. For example
3767 * TODO Log each state with only a time
3769 :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
3771 * TODO Only log when switching to WAIT, and when repeating
3773 :LOGGING: WAIT(@@) logrepeat
3775 * TODO No logging at all
3781 @node Tracking your habits, , Tracking TODO state changes, Progress logging
3782 @subsection Tracking your habits
3785 Org has the ability to track the consistency of a special category of TODOs,
3786 called ``habits''. A habit has the following properties:
3790 You have enabled the @code{habits} module by customizing the variable
3793 The habit is a TODO, with a TODO keyword representing an open state.
3795 The property @code{STYLE} is set to the value @code{habit}.
3797 The TODO has a scheduled date, with a @code{.+} style repeat interval.
3799 The TODO may also have minimum and maximum ranges specified by using the
3800 syntax @samp{.+2d/3d}, which says that you want to do the task at least every
3801 three days, but at most every two days.
3803 You must also have state logging for the @code{DONE} state enabled, in order
3804 for historical data to be represented in the consistency graph. If it's not
3805 enabled it's not an error, but the consistency graphs will be largely
3809 To give you an idea of what the above rules look like in action, here's an
3810 actual habit with some history:
3814 SCHEDULED: <2009-10-17 Sat .+2d/4d>
3815 - State "DONE" from "TODO" [2009-10-15 Thu]
3816 - State "DONE" from "TODO" [2009-10-12 Mon]
3817 - State "DONE" from "TODO" [2009-10-10 Sat]
3818 - State "DONE" from "TODO" [2009-10-04 Sun]
3819 - State "DONE" from "TODO" [2009-10-02 Fri]
3820 - State "DONE" from "TODO" [2009-09-29 Tue]
3821 - State "DONE" from "TODO" [2009-09-25 Fri]
3822 - State "DONE" from "TODO" [2009-09-19 Sat]
3823 - State "DONE" from "TODO" [2009-09-16 Wed]
3824 - State "DONE" from "TODO" [2009-09-12 Sat]
3827 :LAST_REPEAT: [2009-10-19 Mon 00:36]
3831 What this habit says is: I want to shave at most every 2 days (given by the
3832 @code{SCHEDULED} date and repeat interval) and at least every 4 days. If
3833 today is the 15th, then the habit first appears in the agenda on Oct 17,
3834 after the minimum of 2 days has elapsed, and will appear overdue on Oct 19,
3835 after four days have elapsed.
3837 What's really useful about habits is that they are displayed along with a
3838 consistency graph, to show how consistent you've been at getting that task
3839 done in the past. This graph shows every day that the task was done over the
3840 past three weeks, with colors for each day. The colors used are:
3844 If the task wasn't to be done yet on that day.
3846 If the task could have been done on that day.
3848 If the task was going to be overdue the next day.
3850 If the task was overdue on that day.
3853 In addition to coloring each day, the day is also marked with an asterisk if
3854 the task was actually done that day, and an exclamation mark to show where
3855 the current day falls in the graph.
3857 There are several configuration variables that can be used to change the way
3858 habits are displayed in the agenda.
3861 @item org-habit-graph-column
3862 The buffer column at which the consistency graph should be drawn. This will
3863 overwrite any text in that column, so it's a good idea to keep your habits'
3864 titles brief and to the point.
3865 @item org-habit-preceding-days
3866 The amount of history, in days before today, to appear in consistency graphs.
3867 @item org-habit-following-days
3868 The number of days after today that will appear in consistency graphs.
3869 @item org-habit-show-habits-only-for-today
3870 If non-nil, only show habits in today's agenda view. This is set to true by
3874 Lastly, pressing @kbd{K} in the agenda buffer will cause habits to
3875 temporarily be disabled and they won't appear at all. Press @kbd{K} again to
3876 bring them back. They are also subject to tag filtering, if you have habits
3877 which should only be done in certain contexts, for example.
3879 @node Priorities, Breaking down tasks, Progress logging, TODO Items
3883 If you use Org-mode extensively, you may end up with enough TODO items that
3884 it starts to make sense to prioritize them. Prioritizing can be done by
3885 placing a @emph{priority cookie} into the headline of a TODO item, like this
3888 *** TODO [#A] Write letter to Sam Fortune
3892 @vindex org-priority-faces
3893 By default, Org-mode supports three priorities: @samp{A}, @samp{B}, and
3894 @samp{C}. @samp{A} is the highest priority. An entry without a cookie is
3895 treated as priority @samp{B}. Priorities make a difference only in the
3896 agenda (@pxref{Weekly/daily agenda}); outside the agenda, they have no
3897 inherent meaning to Org-mode. The cookies can be highlighted with special
3898 faces by customizing the variable @code{org-priority-faces}.
3900 Priorities can be attached to any outline tree entries; they do not need
3906 Set the priority of the current headline. The command prompts for a
3907 priority character @samp{A}, @samp{B} or @samp{C}. When you press
3908 @key{SPC} instead, the priority cookie is removed from the headline.
3909 The priorities can also be changed ``remotely'' from the timeline and
3910 agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
3913 @kindex S-@key{down}
3916 @vindex org-priority-start-cycle-with-default
3917 Increase/decrease priority of current headline@footnote{See also the option
3918 @code{org-priority-start-cycle-with-default}.}. Note that these keys are
3919 also used to modify timestamps (@pxref{Creating timestamps}). See also
3920 @ref{Conflicts}, for a discussion of the interaction with
3921 @code{shift-selection-mode}.
3924 @vindex org-highest-priority
3925 @vindex org-lowest-priority
3926 @vindex org-default-priority
3927 You can change the range of allowed priorities by setting the variables
3928 @code{org-highest-priority}, @code{org-lowest-priority}, and
3929 @code{org-default-priority}. For an individual buffer, you may set
3930 these values (highest, lowest, default) like this (please make sure that
3931 the highest priority is earlier in the alphabet than the lowest
3934 @cindex #+PRIORITIES
3939 @node Breaking down tasks, Checkboxes, Priorities, TODO Items
3940 @section Breaking tasks down into subtasks
3941 @cindex tasks, breaking down
3942 @cindex statistics, for TODO items
3944 @vindex org-agenda-todo-list-sublevels
3945 It is often advisable to break down large tasks into smaller, manageable
3946 subtasks. You can do this by creating an outline tree below a TODO item,
3947 with detailed subtasks on the tree@footnote{To keep subtasks out of the
3948 global TODO list, see the @code{org-agenda-todo-list-sublevels}.}. To keep
3949 the overview over the fraction of subtasks that are already completed, insert
3950 either @samp{[/]} or @samp{[%]} anywhere in the headline. These cookies will
3951 be updated each time the TODO status of a child changes, or when pressing
3952 @kbd{C-c C-c} on the cookie. For example:
3955 * Organize Party [33%]
3956 ** TODO Call people [1/2]
3960 ** DONE Talk to neighbor
3963 @cindex property, COOKIE_DATA
3964 If a heading has both checkboxes and TODO children below it, the meaning of
3965 the statistics cookie become ambiguous. Set the property
3966 @code{COOKIE_DATA} to either @samp{checkbox} or @samp{todo} to resolve
3969 @vindex org-hierarchical-todo-statistics
3970 If you would like to have the statistics cookie count any TODO entries in the
3971 subtree (not just direct children), configure the variable
3972 @code{org-hierarchical-todo-statistics}. To do this for a single subtree,
3973 include the word @samp{recursive} into the value of the @code{COOKIE_DATA}
3977 * Parent capturing statistics [2/20]
3979 :COOKIE_DATA: todo recursive
3983 If you would like a TODO entry to automatically change to DONE
3984 when all children are done, you can use the following setup:
3987 (defun org-summary-todo (n-done n-not-done)
3988 "Switch entry to DONE when all subentries are done, to TODO otherwise."
3989 (let (org-log-done org-log-states) ; turn off logging
3990 (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
3992 (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
3996 Another possibility is the use of checkboxes to identify (a hierarchy of) a
3997 large number of subtasks (@pxref{Checkboxes}).
4000 @node Checkboxes, , Breaking down tasks, TODO Items
4004 Every item in a plain list (@pxref{Plain lists}) can be made into a
4005 checkbox by starting it with the string @samp{[ ]}. This feature is
4006 similar to TODO items (@pxref{TODO Items}), but is more lightweight.
4007 Checkboxes are not included into the global TODO list, so they are often
4008 great to split a task into a number of simple steps. Or you can use
4009 them in a shopping list. To toggle a checkbox, use @kbd{C-c C-c}, or
4010 use the mouse (thanks to Piotr Zielinski's @file{org-mouse.el}).
4012 Here is an example of a checkbox list.
4015 * TODO Organize party [2/4]
4016 - [-] call people [1/3]
4021 - [ ] think about what music to play
4022 - [X] talk to the neighbors
4025 Checkboxes work hierarchically, so if a checkbox item has children that
4026 are checkboxes, toggling one of the children checkboxes will make the
4027 parent checkbox reflect if none, some, or all of the children are
4030 @cindex statistics, for checkboxes
4031 @cindex checkbox statistics
4032 @cindex property, COOKIE_DATA
4033 @vindex org-hierarchical-checkbox-statistics
4034 The @samp{[2/4]} and @samp{[1/3]} in the first and second line are cookies
4035 indicating how many checkboxes present in this entry have been checked off,
4036 and the total number of checkboxes present. This can give you an idea on how
4037 many checkboxes remain, even without opening a folded entry. The cookies can
4038 be placed into a headline or into (the first line of) a plain list item.
4039 Each cookie covers checkboxes of direct children structurally below the
4040 headline/item on which the cookie appears@footnote{Set the variable
4041 @code{org-hierarchical-checkbox-statistics} if you want such cookies to
4042 represent the all checkboxes below the cookie, not just the direct
4043 children.}. You have to insert the cookie yourself by typing either
4044 @samp{[/]} or @samp{[%]}. With @samp{[/]} you get an @samp{n out of m}
4045 result, as in the examples above. With @samp{[%]} you get information about
4046 the percentage of checkboxes checked (in the above example, this would be
4047 @samp{[50%]} and @samp{[33%]}, respectively). In a headline, a cookie can
4048 count either checkboxes below the heading or TODO states of children, and it
4049 will display whatever was changed last. Set the property @code{COOKIE_DATA}
4050 to either @samp{checkbox} or @samp{todo} to resolve this issue.
4052 @cindex blocking, of checkboxes
4053 @cindex checkbox blocking
4054 @cindex property, ORDERED
4055 If the current outline node has an @code{ORDERED} property, checkboxes must
4056 be checked off in sequence, and an error will be thrown if you try to check
4057 off a box while there are unchecked boxes above it.
4059 @noindent The following commands work with checkboxes:
4064 Toggle checkbox status or (with prefix arg) checkbox presence at point. With
4065 double prefix argument, set it to @samp{[-]}, which is considered to be an
4069 Toggle checkbox status or (with prefix arg) checkbox presence at point. With
4070 double prefix argument, set it to @samp{[-]}, which is considered to be an
4074 If there is an active region, toggle the first checkbox in the region
4075 and set all remaining boxes to the same status as the first. With a prefix
4076 arg, add or remove the checkbox for all items in the region.
4078 If the cursor is in a headline, toggle checkboxes in the region between
4079 this headline and the next (so @emph{not} the entire subtree).
4081 If there is no active region, just toggle the checkbox at point.
4083 @kindex M-S-@key{RET}
4085 Insert a new item with a checkbox.
4086 This works only if the cursor is already in a plain list item
4087 (@pxref{Plain lists}).
4090 @vindex org-track-ordered-property-with-tag
4091 @cindex property, ORDERED
4092 Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
4093 be checked off in sequence. A property is used for this behavior because
4094 this should be local to the current entry, not inherited like a tag.
4095 However, if you would like to @i{track} the value of this property with a tag
4096 for better visibility, customize the variable
4097 @code{org-track-ordered-property-with-tag}.
4100 Update the statistics cookie in the current outline entry. When called with
4101 a @kbd{C-u} prefix, update the entire file. Checkbox statistic cookies are
4102 updated automatically if you toggle checkboxes with @kbd{C-c C-c} and make
4103 new ones with @kbd{M-S-@key{RET}}. TODO statistics cookies update when
4104 changing TODO states. If you delete boxes/entries or add/change them by
4105 hand, use this command to get things back into sync. Or simply toggle any
4106 entry twice (checkboxes with @kbd{C-c C-c}).
4109 @node Tags, Properties and Columns, TODO Items, Top
4112 @cindex headline tagging
4113 @cindex matching, tags
4114 @cindex sparse tree, tag based
4116 An excellent way to implement labels and contexts for cross-correlating
4117 information is to assign @i{tags} to headlines. Org-mode has extensive
4120 @vindex org-tag-faces
4121 Every headline can contain a list of tags; they occur at the end of the
4122 headline. Tags are normal words containing letters, numbers, @samp{_}, and
4123 @samp{@@}. Tags must be preceded and followed by a single colon, e.g.,
4124 @samp{:work:}. Several tags can be specified, as in @samp{:work:urgent:}.
4125 Tags will by default be in bold face with the same color as the headline.
4126 You may specify special faces for specific tags using the variable
4127 @code{org-tag-faces}, in much the same way as you can for TODO keywords
4128 (@pxref{Faces for TODO keywords}).
4131 * Tag inheritance:: Tags use the tree structure of the outline
4132 * Setting tags:: How to assign tags to a headline
4133 * Tag searches:: Searching for combinations of tags
4136 @node Tag inheritance, Setting tags, Tags, Tags
4137 @section Tag inheritance
4138 @cindex tag inheritance
4139 @cindex inheritance, of tags
4140 @cindex sublevels, inclusion into tags match
4142 @i{Tags} make use of the hierarchical structure of outline trees. If a
4143 heading has a certain tag, all subheadings will inherit the tag as
4144 well. For example, in the list
4147 * Meeting with the French group :work:
4148 ** Summary by Frank :boss:notes:
4149 *** TODO Prepare slides for him :action:
4153 the final heading will have the tags @samp{:work:}, @samp{:boss:},
4154 @samp{:notes:}, and @samp{:action:} even though the final heading is not
4155 explicitly marked with those tags. You can also set tags that all entries in
4156 a file should inherit just as if these tags were defined in a hypothetical
4157 level zero that surrounds the entire file. Use a line like this@footnote{As
4158 with all these in-buffer settings, pressing @kbd{C-c C-c} activates any
4159 changes in the line.}:
4163 #+FILETAGS: :Peter:Boss:Secret:
4167 @vindex org-use-tag-inheritance
4168 @vindex org-tags-exclude-from-inheritance
4169 To limit tag inheritance to specific tags, or to turn it off entirely, use
4170 the variables @code{org-use-tag-inheritance} and
4171 @code{org-tags-exclude-from-inheritance}.
4173 @vindex org-tags-match-list-sublevels
4174 When a headline matches during a tags search while tag inheritance is turned
4175 on, all the sublevels in the same tree will (for a simple match form) match
4176 as well@footnote{This is only true if the search does not involve more
4177 complex tests including properties (@pxref{Property searches}).}. The list
4178 of matches may then become very long. If you only want to see the first tags
4179 match in a subtree, configure the variable
4180 @code{org-tags-match-list-sublevels} (not recommended).
4182 @node Setting tags, Tag searches, Tag inheritance, Tags
4183 @section Setting tags
4184 @cindex setting tags
4185 @cindex tags, setting
4188 Tags can simply be typed into the buffer at the end of a headline.
4189 After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is
4190 also a special command for inserting tags:
4195 @cindex completion, of tags
4196 @vindex org-tags-column
4197 Enter new tags for the current headline. Org-mode will either offer
4198 completion or a special single-key interface for setting tags, see
4199 below. After pressing @key{RET}, the tags will be inserted and aligned
4200 to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all
4201 tags in the current buffer will be aligned to that column, just to make
4202 things look nice. TAGS are automatically realigned after promotion,
4203 demotion, and TODO state changes (@pxref{TODO basics}).
4206 When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
4209 @vindex org-tag-alist
4210 Org will support tag insertion based on a @emph{list of tags}. By
4211 default this list is constructed dynamically, containing all tags
4212 currently used in the buffer. You may also globally specify a hard list
4213 of tags with the variable @code{org-tag-alist}. Finally you can set
4214 the default tags for a given file with lines like
4218 #+TAGS: @@work @@home @@tennisclub
4219 #+TAGS: laptop car pc sailboat
4222 If you have globally defined your preferred set of tags using the
4223 variable @code{org-tag-alist}, but would like to use a dynamic tag list
4224 in a specific file, add an empty TAGS option line to that file:
4230 @vindex org-tag-persistent-alist
4231 If you have a preferred set of tags that you would like to use in every file,
4232 in addition to those defined on a per-file basis by TAGS option lines, then
4233 you may specify a list of tags with the variable
4234 @code{org-tag-persistent-alist}. You may turn this off on a per-file basis
4235 by adding a STARTUP option line to that file:
4241 By default Org-mode uses the standard minibuffer completion facilities for
4242 entering tags. However, it also implements another, quicker, tag selection
4243 method called @emph{fast tag selection}. This allows you to select and
4244 deselect tags with just a single key press. For this to work well you should
4245 assign unique letters to most of your commonly used tags. You can do this
4246 globally by configuring the variable @code{org-tag-alist} in your
4247 @file{.emacs} file. For example, you may find the need to tag many items in
4248 different files with @samp{:@@home:}. In this case you can set something
4252 (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
4255 @noindent If the tag is only relevant to the file you are working on, then you
4256 can instead set the TAGS option line as:
4259 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p)
4262 @noindent The tags interface will show the available tags in a splash
4263 window. If you want to start a new line after a specific tag, insert
4264 @samp{\n} into the tag list
4267 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) \n laptop(l) pc(p)
4270 @noindent or write them in two lines:
4273 #+TAGS: @@work(w) @@home(h) @@tennisclub(t)
4274 #+TAGS: laptop(l) pc(p)
4278 You can also group together tags that are mutually exclusive by using
4282 #+TAGS: @{ @@work(w) @@home(h) @@tennisclub(t) @} laptop(l) pc(p)
4285 @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
4286 and @samp{@@tennisclub} should be selected. Multiple such groups are allowed.
4288 @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
4289 these lines to activate any changes.
4292 To set these mutually exclusive groups in the variable @code{org-tags-alist},
4293 you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
4294 of the braces. Similarly, you can use @code{:newline} to indicate a line
4295 break. The previous example would be set globally by the following
4299 (setq org-tag-alist '((:startgroup . nil)
4300 ("@@work" . ?w) ("@@home" . ?h)
4301 ("@@tennisclub" . ?t)
4303 ("laptop" . ?l) ("pc" . ?p)))
4306 If at least one tag has a selection key then pressing @kbd{C-c C-c} will
4307 automatically present you with a special interface, listing inherited tags,
4308 the tags of the current headline, and a list of all valid tags with
4309 corresponding keys@footnote{Keys will automatically be assigned to tags which
4310 have no configured keys.}. In this interface, you can use the following
4315 Pressing keys assigned to tags will add or remove them from the list of
4316 tags in the current line. Selecting a tag in a group of mutually
4317 exclusive tags will turn off any other tags from that group.
4320 Enter a tag in the minibuffer, even if the tag is not in the predefined
4321 list. You will be able to complete on all tags present in the buffer.
4324 Clear all tags for this line.
4327 Accept the modified set.
4329 Abort without installing changes.
4331 If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
4333 Turn off groups of mutually exclusive tags. Use this to (as an
4334 exception) assign several tags from such a group.
4336 Toggle auto-exit after the next change (see below).
4337 If you are using expert mode, the first @kbd{C-c} will display the
4342 This method lets you assign tags to a headline with very few keys. With
4343 the above setup, you could clear the current tags and set @samp{@@home},
4344 @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
4345 C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@home} to
4346 @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
4347 alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag
4348 @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
4349 @key{RET} @key{RET}}.
4351 @vindex org-fast-tag-selection-single-key
4352 If you find that most of the time you need only a single key press to
4353 modify your list of tags, set the variable
4354 @code{org-fast-tag-selection-single-key}. Then you no longer have to
4355 press @key{RET} to exit fast tag selection---it will immediately exit
4356 after the first change. If you then occasionally need more keys, press
4357 @kbd{C-c} to turn off auto-exit for the current tag selection process
4358 (in effect: start selection with @kbd{C-c C-c C-c} instead of @kbd{C-c
4359 C-c}). If you set the variable to the value @code{expert}, the special
4360 window is not even shown for single-key tag selection, it comes up only
4361 when you press an extra @kbd{C-c}.
4363 @node Tag searches, , Setting tags, Tags
4364 @section Tag searches
4365 @cindex tag searches
4366 @cindex searching for tags
4368 Once a system of tags has been set up, it can be used to collect related
4369 information into special lists.
4376 Create a sparse tree with all headlines matching a tags search. With a
4377 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
4380 Create a global list of tag matches from all agenda files.
4381 @xref{Matching tags and properties}.
4384 @vindex org-tags-match-list-sublevels
4385 Create a global list of tag matches from all agenda files, but check
4386 only TODO items and force checking subitems (see variable
4387 @code{org-tags-match-list-sublevels}).
4390 These commands all prompt for a match string which allows basic Boolean logic
4391 like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and
4392 @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries
4393 which are tagged, like @samp{Kathy} or @samp{Sally}. The full syntax of the search
4394 string is rich and allows also matching against TODO keywords, entry levels
4395 and properties. For a complete description with many examples, see
4396 @ref{Matching tags and properties}.
4399 @node Properties and Columns, Dates and Times, Tags, Top
4400 @chapter Properties and columns
4403 Properties are a set of key-value pairs associated with an entry. There
4404 are two main applications for properties in Org-mode. First, properties
4405 are like tags, but with a value. Second, you can use properties to
4406 implement (very basic) database capabilities in an Org buffer. For
4407 an example of the first application, imagine maintaining a file where
4408 you document bugs and plan releases for a piece of software. Instead of
4409 using tags like @code{:release_1:}, @code{:release_2:}, one can use a
4410 property, say @code{:Release:}, that in different subtrees has different
4411 values, such as @code{1.0} or @code{2.0}. For an example of the second
4412 application of properties, imagine keeping track of your music CDs,
4413 where properties could be things such as the album, artist, date of
4414 release, number of tracks, and so on.
4416 Properties can be conveniently edited and viewed in column view
4417 (@pxref{Column view}).
4420 * Property syntax:: How properties are spelled out
4421 * Special properties:: Access to other Org-mode features
4422 * Property searches:: Matching property values
4423 * Property inheritance:: Passing values down the tree
4424 * Column view:: Tabular viewing and editing
4425 * Property API:: Properties for Lisp programmers
4428 @node Property syntax, Special properties, Properties and Columns, Properties and Columns
4429 @section Property syntax
4430 @cindex property syntax
4431 @cindex drawer, for properties
4433 Properties are key-value pairs. They need to be inserted into a special
4434 drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property
4435 is specified on a single line, with the key (surrounded by colons)
4436 first, and the value after it. Here is an example:
4441 *** Goldberg Variations
4443 :Title: Goldberg Variations
4444 :Composer: J.S. Bach
4446 :Publisher: Deutsche Grammophon
4451 You may define the allowed values for a particular property @samp{:Xyz:}
4452 by setting a property @samp{:Xyz_ALL:}. This special property is
4453 @emph{inherited}, so if you set it in a level 1 entry, it will apply to
4454 the entire tree. When allowed values are defined, setting the
4455 corresponding property becomes easier and is less prone to typing
4456 errors. For the example with the CD collection, we can predefine
4457 publishers and the number of disks in a box like this:
4462 :NDisks_ALL: 1 2 3 4
4463 :Publisher_ALL: "Deutsche Grammophon" Philips EMI
4467 If you want to set properties that can be inherited by any entry in a
4468 file, use a line like
4469 @cindex property, _ALL
4472 #+PROPERTY: NDisks_ALL 1 2 3 4
4475 @vindex org-global-properties
4476 Property values set with the global variable
4477 @code{org-global-properties} can be inherited by all entries in all
4481 The following commands help to work with properties:
4486 After an initial colon in a line, complete property keys. All keys used
4487 in the current file will be offered as possible completions.
4490 Set a property. This prompts for a property name and a value. If
4491 necessary, the property drawer is created as well.
4492 @item M-x org-insert-property-drawer
4493 Insert a property drawer into the current entry. The drawer will be
4494 inserted early in the entry, but after the lines with planning
4495 information like deadlines.
4498 With the cursor in a property drawer, this executes property commands.
4500 Set a property in the current entry. Both the property and the value
4501 can be inserted using completion.
4502 @kindex S-@key{right}
4503 @kindex S-@key{left}
4504 @item S-@key{left}/@key{right}
4505 Switch property at point to the next/previous allowed value.
4507 Remove a property from the current entry.
4509 Globally remove a property, from all entries in the current file.
4511 Compute the property at point, using the operator and scope from the
4512 nearest column format definition.
4515 @node Special properties, Property searches, Property syntax, Properties and Columns
4516 @section Special properties
4517 @cindex properties, special
4519 Special properties provide an alternative access method to Org-mode
4520 features, like the TODO state or the priority of an entry, discussed in the
4521 previous chapters. This interface exists so that you can include
4522 these states in a column view (@pxref{Column view}), or to use them in
4523 queries. The following property names are special and should not be
4524 used as keys in the properties drawer:
4526 @cindex property, special, TODO
4527 @cindex property, special, TAGS
4528 @cindex property, special, ALLTAGS
4529 @cindex property, special, CATEGORY
4530 @cindex property, special, PRIORITY
4531 @cindex property, special, DEADLINE
4532 @cindex property, special, SCHEDULED
4533 @cindex property, special, CLOSED
4534 @cindex property, special, TIMESTAMP
4535 @cindex property, special, TIMESTAMP_IA
4536 @cindex property, special, CLOCKSUM
4537 @cindex property, special, BLOCKED
4538 @c guessing that ITEM is needed in this area; also, should this list be sorted?
4539 @cindex property, special, ITEM
4541 TODO @r{The TODO keyword of the entry.}
4542 TAGS @r{The tags defined directly in the headline.}
4543 ALLTAGS @r{All tags, including inherited ones.}
4544 CATEGORY @r{The category of an entry.}
4545 PRIORITY @r{The priority of the entry, a string with a single letter.}
4546 DEADLINE @r{The deadline time string, without the angular brackets.}
4547 SCHEDULED @r{The scheduling timestamp, without the angular brackets.}
4548 CLOSED @r{When was this entry closed?}
4549 TIMESTAMP @r{The first keyword-less timestamp in the entry.}
4550 TIMESTAMP_IA @r{The first inactive timestamp in the entry.}
4551 CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}}
4552 @r{must be run first to compute the values.}
4553 BLOCKED @r{"t" if task is currently blocked by children or siblings}
4554 ITEM @r{The content of the entry.}
4557 @node Property searches, Property inheritance, Special properties, Properties and Columns
4558 @section Property searches
4559 @cindex properties, searching
4560 @cindex searching, of properties
4562 To create sparse trees and special lists with selection based on properties,
4563 the same commands are used as for tag searches (@pxref{Tag searches}).
4569 Create a sparse tree with all matching entries. With a
4570 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
4573 Create a global list of tag/property matches from all agenda files.
4574 @xref{Matching tags and properties}.
4577 @vindex org-tags-match-list-sublevels
4578 Create a global list of tag matches from all agenda files, but check
4579 only TODO items and force checking of subitems (see variable
4580 @code{org-tags-match-list-sublevels}).
4583 The syntax for the search string is described in @ref{Matching tags and
4586 There is also a special command for creating sparse trees based on a
4592 Create a sparse tree based on the value of a property. This first
4593 prompts for the name of a property, and then for a value. A sparse tree
4594 is created with all entries that define this property with the given
4595 value. If you enclose the value into curly braces, it is interpreted as
4596 a regular expression and matched against the property values.
4599 @node Property inheritance, Column view, Property searches, Properties and Columns
4600 @section Property Inheritance
4601 @cindex properties, inheritance
4602 @cindex inheritance, of properties
4604 @vindex org-use-property-inheritance
4605 The outline structure of Org-mode documents lends itself for an
4606 inheritance model of properties: if the parent in a tree has a certain
4607 property, the children can inherit this property. Org-mode does not
4608 turn this on by default, because it can slow down property searches
4609 significantly and is often not needed. However, if you find inheritance
4610 useful, you can turn it on by setting the variable
4611 @code{org-use-property-inheritance}. It may be set to @code{t} to make
4612 all properties inherited from the parent, to a list of properties
4613 that should be inherited, or to a regular expression that matches
4614 inherited properties. If a property has the value @samp{nil}, this is
4615 interpreted as an explicit undefine of he property, so that inheritance
4616 search will stop at this value and return @code{nil}.
4618 Org-mode has a few properties for which inheritance is hard-coded, at
4619 least for the special applications for which they are used:
4621 @cindex property, COLUMNS
4624 The @code{:COLUMNS:} property defines the format of column view
4625 (@pxref{Column view}). It is inherited in the sense that the level
4626 where a @code{:COLUMNS:} property is defined is used as the starting
4627 point for a column view table, independently of the location in the
4628 subtree from where columns view is turned on.
4630 @cindex property, CATEGORY
4631 For agenda view, a category set through a @code{:CATEGORY:} property
4632 applies to the entire subtree.
4634 @cindex property, ARCHIVE
4635 For archiving, the @code{:ARCHIVE:} property may define the archive
4636 location for the entire subtree (@pxref{Moving subtrees}).
4638 @cindex property, LOGGING
4639 The LOGGING property may define logging settings for an entry or a
4640 subtree (@pxref{Tracking TODO state changes}).
4643 @node Column view, Property API, Property inheritance, Properties and Columns
4644 @section Column view
4646 A great way to view and edit properties in an outline tree is
4647 @emph{column view}. In column view, each outline node is turned into a
4648 table row. Columns in this table provide access to properties of the
4649 entries. Org-mode implements columns by overlaying a tabular structure
4650 over the headline of each item. While the headlines have been turned
4651 into a table row, you can still change the visibility of the outline
4652 tree. For example, you get a compact table by switching to CONTENTS
4653 view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
4654 is active), but you can still open, read, and edit the entry below each
4655 headline. Or, you can switch to column view after executing a sparse
4656 tree command and in this way get a table only for the selected items.
4657 Column view also works in agenda buffers (@pxref{Agenda Views}) where
4658 queries have collected selected items, possibly from a number of files.
4661 * Defining columns:: The COLUMNS format property
4662 * Using column view:: How to create and use column view
4663 * Capturing column view:: A dynamic block for column view
4666 @node Defining columns, Using column view, Column view, Column view
4667 @subsection Defining columns
4668 @cindex column view, for properties
4669 @cindex properties, column view
4671 Setting up a column view first requires defining the columns. This is
4672 done by defining a column format line.
4675 * Scope of column definitions:: Where defined, where valid?
4676 * Column attributes:: Appearance and content of a column
4679 @node Scope of column definitions, Column attributes, Defining columns, Defining columns
4680 @subsubsection Scope of column definitions
4682 To define a column format for an entire file, use a line like
4686 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
4689 To specify a format that only applies to a specific tree, add a
4690 @code{:COLUMNS:} property to the top node of that tree, for example:
4693 ** Top node for columns view
4695 :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
4699 If a @code{:COLUMNS:} property is present in an entry, it defines columns
4700 for the entry itself, and for the entire subtree below it. Since the
4701 column definition is part of the hierarchical structure of the document,
4702 you can define columns on level 1 that are general enough for all
4703 sublevels, and more specific columns further down, when you edit a
4704 deeper part of the tree.
4706 @node Column attributes, , Scope of column definitions, Defining columns
4707 @subsubsection Column attributes
4708 A column definition sets the attributes of a column. The general
4709 definition looks like this:
4712 %[@var{width}]@var{property}[(@var{title})][@{@var{summary-type}@}]
4716 Except for the percent sign and the property name, all items are
4717 optional. The individual parts have the following meaning:
4720 @var{width} @r{An integer specifying the width of the column in characters.}
4721 @r{If omitted, the width will be determined automatically.}
4722 @var{property} @r{The property that should be edited in this column.}
4723 @r{Special properties representing meta data are allowed here}
4724 @r{as well (@pxref{Special properties})}
4725 @var{title} @r{The header text for the column. If omitted, the property}
4727 @{@var{summary-type}@} @r{The summary type. If specified, the column values for}
4728 @r{parent nodes are computed from the children.}
4729 @r{Supported summary types are:}
4730 @{+@} @r{Sum numbers in this column.}
4731 @{+;%.1f@} @r{Like @samp{+}, but format result with @samp{%.1f}.}
4732 @{$@} @r{Currency, short for @samp{+;%.2f}.}
4733 @{:@} @r{Sum times, HH:MM, plain numbers are hours.}
4734 @{X@} @r{Checkbox status, @samp{[X]} if all children are @samp{[X]}.}
4735 @{X/@} @r{Checkbox status, @samp{[n/m]}.}
4736 @{X%@} @r{Checkbox status, @samp{[n%]}.}
4737 @{min@} @r{Smallest number in column.}
4738 @{max@} @r{Largest number.}
4739 @{mean@} @r{Arithmetic mean of numbers.}
4740 @{:min@} @r{Smallest time value in column.}
4741 @{:max@} @r{Largest time value.}
4742 @{:mean@} @r{Arithmetic mean of time values.}
4743 @{@@min@} @r{Minimum age (in days/hours/mins/seconds).}
4744 @{@@max@} @r{Maximum age (in days/hours/mins/seconds).}
4745 @{@@mean@} @r{Arithmetic mean of ages (in days/hours/mins/seconds).}
4746 @{est+@} @r{Add low-high estimates.}
4750 Be aware that you can only have one summary type for any property you
4751 include. Subsequent columns referencing the same property will all display the
4752 same summary information.
4754 The @code{est+} summary type requires further explanation. It is used for
4755 combining estimates, expressed as low-high ranges. For example, instead
4756 of estimating a particular task will take 5 days, you might estimate it as
4757 5-6 days if you're fairly confident you know how much woark is required, or
4758 1-10 days if you don't really know what needs to be done. Both ranges
4759 average at 5.5 days, but the first represents a more predictable delivery.
4761 When combining a set of such estimates, simply adding the lows and highs
4762 produces an unrealistically wide result. Instead, @code{est+} adds the
4763 statistical mean and variance of the sub-tasks, generating a final estimate
4764 from the sum. For example, suppose you had ten tasks, each of which was
4765 estimated at 0.5 to 2 days of work. Straight addition produces an estimate
4766 of 5 to 20 days, representing what to expect if everything goes either
4767 extremely well or extremely poorly. In contrast, @code{est+} estimates the
4768 full job more realistically, at 10-15 days.
4770 Here is an example for a complete columns definition, along with allowed
4774 :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.}
4775 %10Time_Estimate@{:@} %CLOCKSUM
4776 :Owner_ALL: Tammy Mark Karl Lisa Don
4777 :Status_ALL: "In progress" "Not started yet" "Finished" ""
4778 :Approved_ALL: "[ ]" "[X]"
4782 The first column, @samp{%25ITEM}, means the first 25 characters of the
4783 item itself, i.e. of the headline. You probably always should start the
4784 column definition with the @samp{ITEM} specifier. The other specifiers
4785 create columns @samp{Owner} with a list of names as allowed values, for
4786 @samp{Status} with four different possible values, and for a checkbox
4787 field @samp{Approved}. When no width is given after the @samp{%}
4788 character, the column will be exactly as wide as it needs to be in order
4789 to fully display all values. The @samp{Approved} column does have a
4790 modified title (@samp{Approved?}, with a question mark). Summaries will
4791 be created for the @samp{Time_Estimate} column by adding time duration
4792 expressions like HH:MM, and for the @samp{Approved} column, by providing
4793 an @samp{[X]} status if all children have been checked. The
4794 @samp{CLOCKSUM} column is special, it lists the sum of CLOCK intervals
4797 @node Using column view, Capturing column view, Defining columns, Column view
4798 @subsection Using column view
4801 @tsubheading{Turning column view on and off}
4804 @vindex org-columns-default-format
4805 Turn on column view. If the cursor is before the first headline in the file,
4806 column view is turned on for the entire file, using the @code{#+COLUMNS}
4807 definition. If the cursor is somewhere inside the outline, this command
4808 searches the hierarchy, up from point, for a @code{:COLUMNS:} property that
4809 defines a format. When one is found, the column view table is established
4810 for the tree starting at the entry that contains the @code{:COLUMNS:}
4811 property. If no such property is found, the format is taken from the
4812 @code{#+COLUMNS} line or from the variable @code{org-columns-default-format},
4813 and column view is established for the current entry and its subtree.
4816 Recreate the column view, to include recent changes made in the buffer.
4823 @tsubheading{Editing values}
4824 @item @key{left} @key{right} @key{up} @key{down}
4825 Move through the column view from field to field.
4826 @kindex S-@key{left}
4827 @kindex S-@key{right}
4828 @item S-@key{left}/@key{right}
4829 Switch to the next/previous allowed value of the field. For this, you
4830 have to have specified allowed values for a property.
4832 Directly select the nth allowed value, @kbd{0} selects the 10th value.
4836 Same as @kbd{S-@key{left}/@key{right}}
4839 Edit the property at point. For the special properties, this will
4840 invoke the same interface that you normally use to change that
4841 property. For example, when editing a TAGS property, the tag completion
4842 or fast selection interface will pop up.
4845 When there is a checkbox at point, toggle it.
4848 View the full value of this property. This is useful if the width of
4849 the column is smaller than that of the value.
4852 Edit the list of allowed values for this property. If the list is found
4853 in the hierarchy, the modified values is stored there. If no list is
4854 found, the new value is stored in the first entry that is part of the
4855 current column view.
4856 @tsubheading{Modifying the table structure}
4860 Make the column narrower/wider by one character.
4861 @kindex S-M-@key{right}
4862 @item S-M-@key{right}
4863 Insert a new column, to the left of the current column.
4864 @kindex S-M-@key{left}
4865 @item S-M-@key{left}
4866 Delete the current column.
4869 @node Capturing column view, , Using column view, Column view
4870 @subsection Capturing column view
4872 Since column view is just an overlay over a buffer, it cannot be
4873 exported or printed directly. If you want to capture a column view, use
4874 a @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame
4875 of this block looks like this:
4877 @cindex #+BEGIN, columnview
4880 #+BEGIN: columnview :hlines 1 :id "label"
4885 @noindent This dynamic block has the following parameters:
4889 This is the most important parameter. Column view is a feature that is
4890 often localized to a certain (sub)tree, and the capture block might be
4891 at a different location in the file. To identify the tree whose view to
4892 capture, you can use 4 values:
4893 @cindex property, ID
4895 local @r{use the tree in which the capture block is located}
4896 global @r{make a global view, including all headings in the file}
4897 "file:@var{path-to-file}"
4898 @r{run column view at the top of this file}
4899 "@var{ID}" @r{call column view in the tree that has an @code{:ID:}}
4900 @r{property with the value @i{label}. You can use}
4901 @r{@kbd{M-x org-id-copy} to create a globally unique ID for}
4902 @r{the current entry and copy it to the kill-ring.}
4905 When @code{t}, insert an hline after every line. When a number @var{N}, insert
4906 an hline before each headline with level @code{<= @var{N}}.
4908 When set to @code{t}, force column groups to get vertical lines.
4910 When set to a number, don't capture entries below this level.
4911 @item :skip-empty-rows
4912 When set to @code{t}, skip rows where the only non-empty specifier of the
4913 column view is @code{ITEM}.
4918 The following commands insert or update the dynamic block:
4923 Insert a dynamic block capturing a column view. You will be prompted
4924 for the scope or ID of the view.
4929 Update dynamic block at point. The cursor needs to be in the
4930 @code{#+BEGIN} line of the dynamic block.
4931 @kindex C-u C-c C-x C-u
4932 @item C-u C-c C-x C-u
4933 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
4934 you have several clock table blocks in a buffer.
4937 You can add formulas to the column view table and you may add plotting
4938 instructions in front of the table---these will survive an update of the
4939 block. If there is a @code{#+TBLFM:} after the table, the table will
4940 actually be recalculated automatically after an update.
4942 An alternative way to capture and process property values into a table is
4943 provided by Eric Schulte's @file{org-collector.el} which is a contributed
4944 package@footnote{Contributed packages are not part of Emacs, but are
4945 distributed with the main distribution of Org (visit
4946 @uref{http://orgmode.org}).}. It provides a general API to collect
4947 properties from entries in a certain scope, and arbitrary Lisp expressions to
4948 process these values before inserting them into a table or a dynamic block.
4950 @node Property API, , Column view, Properties and Columns
4951 @section The Property API
4952 @cindex properties, API
4953 @cindex API, for properties
4955 There is a full API for accessing and changing properties. This API can
4956 be used by Emacs Lisp programs to work with properties and to implement
4957 features based on them. For more information see @ref{Using the
4960 @node Dates and Times, Capture - Refile - Archive, Properties and Columns, Top
4961 @chapter Dates and times
4967 To assist project planning, TODO items can be labeled with a date and/or
4968 a time. The specially formatted string carrying the date and time
4969 information is called a @emph{timestamp} in Org-mode. This may be a
4970 little confusing because timestamp is often used as indicating when
4971 something was created or last changed. However, in Org-mode this term
4972 is used in a much wider sense.
4975 * Timestamps:: Assigning a time to a tree entry
4976 * Creating timestamps:: Commands which insert timestamps
4977 * Deadlines and scheduling:: Planning your work
4978 * Clocking work time:: Tracking how long you spend on a task
4979 * Resolving idle time:: Resolving time if you've been idle
4980 * Effort estimates:: Planning work effort in advance
4981 * Relative timer:: Notes with a running timer
4985 @node Timestamps, Creating timestamps, Dates and Times, Dates and Times
4986 @section Timestamps, deadlines, and scheduling
4988 @cindex ranges, time
4993 A timestamp is a specification of a date (possibly with a time or a range of
4994 times) in a special format, either @samp{<2003-09-16 Tue>} or
4995 @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16 Tue
4996 12:00-12:30>}@footnote{This is inspired by the standard ISO 8601 date/time
4997 format. To use an alternative format, see @ref{Custom time format}.}. A
4998 timestamp can appear anywhere in the headline or body of an Org tree entry.
4999 Its presence causes entries to be shown on specific dates in the agenda
5000 (@pxref{Weekly/daily agenda}). We distinguish:
5003 @item Plain timestamp; Event; Appointment
5005 A simple timestamp just assigns a date/time to an item. This is just
5006 like writing down an appointment or event in a paper agenda. In the
5007 timeline and agenda displays, the headline of an entry associated with a
5008 plain timestamp will be shown exactly on that date.
5011 * Meet Peter at the movies <2006-11-01 Wed 19:15>
5012 * Discussion on climate change <2006-11-02 Thu 20:00-22:00>
5015 @item Timestamp with repeater interval
5016 @cindex timestamp, with repeater interval
5017 A timestamp may contain a @emph{repeater interval}, indicating that it
5018 applies not only on the given date, but again and again after a certain
5019 interval of N days (d), weeks (w), months (m), or years (y). The
5020 following will show up in the agenda every Wednesday:
5023 * Pick up Sam at school <2007-05-16 Wed 12:30 +1w>
5026 @item Diary-style sexp entries
5027 For more complex date specifications, Org-mode supports using the
5028 special sexp diary entries implemented in the Emacs calendar/diary
5029 package. For example
5032 * The nerd meeting on every 2nd Thursday of the month
5033 <%%(diary-float t 4 2)>
5036 @item Time/Date range
5039 Two timestamps connected by @samp{--} denote a range. The headline
5040 will be shown on the first and last day of the range, and on any dates
5041 that are displayed and fall in the range. Here is an example:
5044 ** Meeting in Amsterdam
5045 <2004-08-23 Mon>--<2004-08-26 Thu>
5048 @item Inactive timestamp
5049 @cindex timestamp, inactive
5050 @cindex inactive timestamp
5051 Just like a plain timestamp, but with square brackets instead of
5052 angular ones. These timestamps are inactive in the sense that they do
5053 @emph{not} trigger an entry to show up in the agenda.
5056 * Gillian comes late for the fifth time [2006-11-01 Wed]
5061 @node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times
5062 @section Creating timestamps
5063 @cindex creating timestamps
5064 @cindex timestamps, creating
5066 For Org-mode to recognize timestamps, they need to be in the specific
5067 format. All commands listed below produce timestamps in the correct
5073 Prompt for a date and insert a corresponding timestamp. When the cursor is
5074 at an existing timestamp in the buffer, the command is used to modify this
5075 timestamp instead of inserting a new one. When this command is used twice in
5076 succession, a time range is inserted.
5080 Like @kbd{C-c .}, but insert an inactive timestamp that will not cause
5087 @vindex org-time-stamp-rounding-minutes
5088 Like @kbd{C-c .} and @kbd{C-c !}, but use the alternative format which
5089 contains date and time. The default time can be rounded to multiples of 5
5090 minutes, see the option @code{org-time-stamp-rounding-minutes}.
5094 Insert a timestamp corresponding to the cursor date in the Calendar.
5098 Access the Emacs calendar for the current date. If there is a
5099 timestamp in the current line, go to the corresponding date
5104 Access the agenda for the date given by the timestamp or -range at
5105 point (@pxref{Weekly/daily agenda}).
5107 @kindex S-@key{left}
5108 @kindex S-@key{right}
5110 @itemx S-@key{right}
5111 Change date at cursor by one day. These key bindings conflict with
5112 shift-selection and related modes (@pxref{Conflicts}).
5115 @kindex S-@key{down}
5118 Change the item under the cursor in a timestamp. The cursor can be on a
5119 year, month, day, hour or minute. When the timestamp contains a time range
5120 like @samp{15:30-16:30}, modifying the first time will also shift the second,
5121 shifting the time block with constant length. To change the length, modify
5122 the second time. Note that if the cursor is in a headline and not at a
5123 timestamp, these same keys modify the priority of an item.
5124 (@pxref{Priorities}). The key bindings also conflict with shift-selection and
5125 related modes (@pxref{Conflicts}).
5128 @cindex evaluate time range
5130 Evaluate a time range by computing the difference between start and end.
5131 With a prefix argument, insert result after the time range (in a table: into
5132 the following column).
5137 * The date/time prompt:: How Org-mode helps you entering date and time
5138 * Custom time format:: Making dates look different
5141 @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps
5142 @subsection The date/time prompt
5143 @cindex date, reading in minibuffer
5144 @cindex time, reading in minibuffer
5146 @vindex org-read-date-prefer-future
5147 When Org-mode prompts for a date/time, the default is shown in default
5148 date/time format, and the prompt therefore seems to ask for a specific
5149 format. But it will in fact accept any string containing some date and/or
5150 time information, and it is really smart about interpreting your input. You
5151 can, for example, use @kbd{C-y} to paste a (possibly multi-line) string
5152 copied from an email message. Org-mode will find whatever information is in
5153 there and derive anything you have not specified from the @emph{default date
5154 and time}. The default is usually the current date and time, but when
5155 modifying an existing timestamp, or when entering the second stamp of a
5156 range, it is taken from the stamp in the buffer. When filling in
5157 information, Org-mode assumes that most of the time you will want to enter a
5158 date in the future: if you omit the month/year and the given day/month is
5159 @i{before} today, it will assume that you mean a future date@footnote{See the
5160 variable @code{org-read-date-prefer-future}. You may set that variable to
5161 the symbol @code{time} to even make a time before now shift the date to
5162 tomorrow.}. If the date has been automatically shifted into the future, the
5163 time prompt will show this with @samp{(=>F).}
5165 For example, let's assume that today is @b{June 13, 2006}. Here is how
5166 various inputs will be interpreted, the items filled in by Org-mode are
5170 3-2-5 --> 2003-02-05
5171 2/5/3 --> 2003-02-05
5172 14 --> @b{2006}-@b{06}-14
5173 12 --> @b{2006}-@b{07}-12
5174 2/5 --> @b{2007}-02-05
5175 Fri --> nearest Friday (default date or later)
5176 sep 15 --> @b{2006}-09-15
5177 feb 15 --> @b{2007}-02-15
5178 sep 12 9 --> 2009-09-12
5179 12:45 --> @b{2006}-@b{06}-@b{13} 12:45
5180 22 sept 0:34 --> @b{2006}-09-22 0:34
5181 w4 --> ISO week for of the current year @b{2006}
5182 2012 w4 fri --> Friday of ISO week 4 in 2012
5183 2012-w04-5 --> Same as above
5186 Furthermore you can specify a relative date by giving, as the
5187 @emph{first} thing in the input: a plus/minus sign, a number and a
5188 letter ([dwmy]) to indicate change in days, weeks, months, or years. With a
5189 single plus or minus, the date is always relative to today. With a
5190 double plus or minus, it is relative to the default date. If instead of
5191 a single letter, you use the abbreviation of day name, the date will be
5192 the nth such day. E.g.
5197 +4d --> four days from today
5198 +4 --> same as above
5199 +2w --> two weeks from today
5200 ++5 --> five days from default date
5201 +2tue --> second Tuesday from now.
5204 @vindex parse-time-months
5205 @vindex parse-time-weekdays
5206 The function understands English month and weekday abbreviations. If
5207 you want to use unabbreviated names and/or other languages, configure
5208 the variables @code{parse-time-months} and @code{parse-time-weekdays}.
5210 You can specify a time range by giving start and end times or by giving a
5211 start time and a duration (in HH:MM format). Use '-' or '--' as the separator
5212 in the former case and use '+' as the separator in the latter case. E.g.
5215 11am-1:15pm --> 11:00-13:15
5216 11am--1:15pm --> same as above
5217 11am+2:15 --> same as above
5220 @cindex calendar, for selecting date
5221 @vindex org-popup-calendar-for-date-prompt
5222 Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
5223 you don't need/want the calendar, configure the variable
5224 @code{org-popup-calendar-for-date-prompt}.}. When you exit the date
5225 prompt, either by clicking on a date in the calendar, or by pressing
5226 @key{RET}, the date selected in the calendar will be combined with the
5227 information entered at the prompt. You can control the calendar fully
5228 from the minibuffer:
5235 @kindex S-@key{right}
5236 @kindex S-@key{left}
5237 @kindex S-@key{down}
5239 @kindex M-S-@key{right}
5240 @kindex M-S-@key{left}
5243 @key{RET} @r{Choose date at cursor in calendar.}
5244 mouse-1 @r{Select date by clicking on it.}
5245 S-@key{right}/@key{left} @r{One day forward/backward.}
5246 S-@key{down}/@key{up} @r{One week forward/backward.}
5247 M-S-@key{right}/@key{left} @r{One month forward/backward.}
5248 > / < @r{Scroll calendar forward/backward by one month.}
5249 M-v / C-v @r{Scroll calendar forward/backward by 3 months.}
5252 @vindex org-read-date-display-live
5253 The actions of the date/time prompt may seem complex, but I assure you they
5254 will grow on you, and you will start getting annoyed by pretty much any other
5255 way of entering a date/time out there. To help you understand what is going
5256 on, the current interpretation of your input will be displayed live in the
5257 minibuffer@footnote{If you find this distracting, turn the display of with
5258 @code{org-read-date-display-live}.}.
5260 @node Custom time format, , The date/time prompt, Creating timestamps
5261 @subsection Custom time format
5262 @cindex custom date/time format
5263 @cindex time format, custom
5264 @cindex date format, custom
5266 @vindex org-display-custom-times
5267 @vindex org-time-stamp-custom-formats
5268 Org-mode uses the standard ISO notation for dates and times as it is
5269 defined in ISO 8601. If you cannot get used to this and require another
5270 representation of date and time to keep you happy, you can get it by
5271 customizing the variables @code{org-display-custom-times} and
5272 @code{org-time-stamp-custom-formats}.
5277 Toggle the display of custom formats for dates and times.
5281 Org-mode needs the default format for scanning, so the custom date/time
5282 format does not @emph{replace} the default format---instead it is put
5283 @emph{over} the default format using text properties. This has the
5284 following consequences:
5287 You cannot place the cursor onto a timestamp anymore, only before or
5290 The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
5291 each component of a timestamp. If the cursor is at the beginning of
5292 the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
5293 just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the
5294 time will be changed by one minute.
5296 If the timestamp contains a range of clock times or a repeater, these
5297 will not be overlayed, but remain in the buffer as they were.
5299 When you delete a timestamp character-by-character, it will only
5300 disappear from the buffer after @emph{all} (invisible) characters
5301 belonging to the ISO timestamp have been removed.
5303 If the custom timestamp format is longer than the default and you are
5304 using dates in tables, table alignment will be messed up. If the custom
5305 format is shorter, things do work as expected.
5309 @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times
5310 @section Deadlines and scheduling
5312 A timestamp may be preceded by special keywords to facilitate planning:
5316 @cindex DEADLINE keyword
5318 Meaning: the task (most likely a TODO item, though not necessarily) is supposed
5319 to be finished on that date.
5321 @vindex org-deadline-warning-days
5322 On the deadline date, the task will be listed in the agenda. In
5323 addition, the agenda for @emph{today} will carry a warning about the
5324 approaching or missed deadline, starting
5325 @code{org-deadline-warning-days} before the due date, and continuing
5326 until the entry is marked DONE. An example:
5329 *** TODO write article about the Earth for the Guide
5330 The editor in charge is [[bbdb:Ford Prefect]]
5331 DEADLINE: <2004-02-29 Sun>
5334 You can specify a different lead time for warnings for a specific
5335 deadlines using the following syntax. Here is an example with a warning
5336 period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}.
5339 @cindex SCHEDULED keyword
5341 Meaning: you are planning to start working on that task on the given
5344 @vindex org-agenda-skip-scheduled-if-done
5345 The headline will be listed under the given date@footnote{It will still
5346 be listed on that date after it has been marked DONE. If you don't like
5347 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In
5348 addition, a reminder that the scheduled date has passed will be present
5349 in the compilation for @emph{today}, until the entry is marked DONE.
5350 I.e. the task will automatically be forwarded until completed.
5353 *** TODO Call Trillian for a date on New Years Eve.
5354 SCHEDULED: <2004-12-25 Sat>
5358 @b{Important:} Scheduling an item in Org-mode should @i{not} be
5359 understood in the same way that we understand @i{scheduling a meeting}.
5360 Setting a date for a meeting is just a simple appointment, you should
5361 mark this entry with a simple plain timestamp, to get this item shown
5362 on the date where it applies. This is a frequent misunderstanding by
5363 Org users. In Org-mode, @i{scheduling} means setting a date when you
5364 want to start working on an action item.
5367 You may use timestamps with repeaters in scheduling and deadline
5368 entries. Org-mode will issue early and late warnings based on the
5369 assumption that the timestamp represents the @i{nearest instance} of
5370 the repeater. However, the use of diary sexp entries like
5372 @code{<%%(diary-float t 42)>}
5374 in scheduling and deadline timestamps is limited. Org-mode does not
5375 know enough about the internals of each sexp function to issue early and
5376 late warnings. However, it will show the item on each day where the
5380 * Inserting deadline/schedule:: Planning items
5381 * Repeated tasks:: Items that show up again and again
5384 @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling
5385 @subsection Inserting deadlines or schedules
5387 The following commands allow you to quickly insert a deadline or to schedule
5394 Insert @samp{DEADLINE} keyword along with a stamp. The insertion will happen
5395 in the line directly following the headline. When called with a prefix arg,
5396 an existing deadline will be removed from the entry. Depending on the
5397 variable @code{org-log-redeadline}@footnote{with corresponding
5398 @code{#+STARTUP} keywords @code{logredeadline}, @code{lognoteredeadline},
5399 and @code{nologredeadline}}, a note will be taken when changing an existing
5401 @c FIXME Any CLOSED timestamp will be removed.????????
5405 Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will
5406 happen in the line directly following the headline. Any CLOSED timestamp
5407 will be removed. When called with a prefix argument, remove the scheduling
5408 date from the entry. Depending on the variable
5409 @code{org-log-reschedule}@footnote{with corresponding @code{#+STARTUP}
5410 keywords @code{logredeadline}, @code{lognoteredeadline}, and
5411 @code{nologredeadline}}, a note will be taken when changing an existing
5418 Mark the current entry for agenda action. After you have marked the entry
5419 like this, you can open the agenda or the calendar to find an appropriate
5420 date. With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to
5421 schedule the marked item.
5424 @cindex sparse tree, for deadlines
5426 @vindex org-deadline-warning-days
5427 Create a sparse tree with all deadlines that are either past-due, or
5428 which will become due within @code{org-deadline-warning-days}.
5429 With @kbd{C-u} prefix, show all deadlines in the file. With a numeric
5430 prefix, check that many days. For example, @kbd{C-1 C-c / d} shows
5431 all deadlines due tomorrow.
5435 Sparse tree for deadlines and scheduled items before a given date.
5439 Sparse tree for deadlines and scheduled items after a given date.
5442 @node Repeated tasks, , Inserting deadline/schedule, Deadlines and scheduling
5443 @subsection Repeated tasks
5444 @cindex tasks, repeated
5445 @cindex repeated tasks
5447 Some tasks need to be repeated again and again. Org-mode helps to
5448 organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
5449 or plain timestamp. In the following example
5451 ** TODO Pay the rent
5452 DEADLINE: <2005-10-01 Sat +1m>
5455 the @code{+1m} is a repeater; the intended interpretation is that the task
5456 has a deadline on <2005-10-01> and repeats itself every (one) month starting
5457 from that time. If you need both a repeater and a special warning period in
5458 a deadline entry, the repeater should come first and the warning period last:
5459 @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
5461 @vindex org-todo-repeat-to-state
5462 Deadlines and scheduled items produce entries in the agenda when they are
5463 over-due, so it is important to be able to mark such an entry as completed
5464 once you have done so. When you mark a DEADLINE or a SCHEDULE with the TODO
5465 keyword DONE, it will no longer produce entries in the agenda. The problem
5466 with this is, however, that then also the @emph{next} instance of the
5467 repeated entry will not be active. Org-mode deals with this in the following
5468 way: When you try to mark such an entry DONE (using @kbd{C-c C-t}), it will
5469 shift the base date of the repeating timestamp by the repeater interval, and
5470 immediately set the entry state back to TODO@footnote{In fact, the target
5471 state is taken from, in this sequence, the @code{REPEAT_TO_STATE} property or
5472 the variable @code{org-todo-repeat-to-state}. If neither of these is
5473 specified, the target state defaults to the first state of the TODO state
5474 sequence.}. In the example above, setting the state to DONE would actually
5475 switch the date like this:
5478 ** TODO Pay the rent
5479 DEADLINE: <2005-11-01 Tue +1m>
5482 @vindex org-log-repeat
5483 A timestamp@footnote{You can change this using the option
5484 @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
5485 @code{lognoterepeat}, and @code{nologrepeat}. With @code{lognoterepeat}, you
5486 will also be prompted for a note.} will be added under the deadline, to keep
5487 a record that you actually acted on the previous instance of this deadline.
5489 As a consequence of shifting the base date, this entry will no longer be
5490 visible in the agenda when checking past dates, but all future instances
5493 With the @samp{+1m} cookie, the date shift will always be exactly one
5494 month. So if you have not paid the rent for three months, marking this
5495 entry DONE will still keep it as an overdue deadline. Depending on the
5496 task, this may not be the best way to handle it. For example, if you
5497 forgot to call you father for 3 weeks, it does not make sense to call
5498 him 3 times in a single day to make up for it. Finally, there are tasks
5499 like changing batteries which should always repeat a certain time
5500 @i{after} the last time you did it. For these tasks, Org-mode has
5501 special repeaters markers with @samp{++} and @samp{.+}. For example:
5505 DEADLINE: <2008-02-10 Sun ++1w>
5506 Marking this DONE will shift the date by at least one week,
5507 but also by as many weeks as it takes to get this date into
5508 the future. However, it stays on a Sunday, even if you called
5509 and marked it done on Saturday.
5510 ** TODO Check the batteries in the smoke detectors
5511 DEADLINE: <2005-11-01 Tue .+1m>
5512 Marking this DONE will shift the date to one month after
5516 You may have both scheduling and deadline information for a specific
5517 task---just make sure that the repeater intervals on both are the same.
5519 An alternative to using a repeater is to create a number of copies of a task
5520 subtree, with dates shifted in each copy. The command @kbd{C-c C-x c} was
5521 created for this purpose, it is described in @ref{Structure editing}.
5524 @node Clocking work time, Resolving idle time, Deadlines and scheduling, Dates and Times
5525 @section Clocking work time
5527 Org-mode allows you to clock the time you spend on specific tasks in a
5528 project. When you start working on an item, you can start the clock.
5529 When you stop working on that task, or when you mark the task done, the
5530 clock is stopped and the corresponding time interval is recorded. It
5531 also computes the total time spent on each subtree of a project. And it
5532 remembers a history or tasks recently clocked, to that you can jump quickly
5533 between a number of tasks absorbing your time.
5535 To save the clock history across Emacs sessions, use
5537 (setq org-clock-persist 'history)
5538 (org-clock-persistence-insinuate)
5540 When you clock into a new task after resuming Emacs, the incomplete
5541 clock@footnote{To resume the clock under the assumption that you have worked
5542 on this task while outside Emacs, use @code{(setq org-clock-persist t)}.}
5543 will be found (@pxref{Resolving idle time}) and you will be prompted about
5549 @vindex org-clock-into-drawer
5550 Start the clock on the current item (clock-in). This inserts the CLOCK
5551 keyword together with a timestamp. If this is not the first clocking of
5552 this item, the multiple CLOCK lines will be wrapped into a
5553 @code{:LOGBOOK:} drawer (see also the variable
5554 @code{org-clock-into-drawer}). When called with a @kbd{C-u} prefix argument,
5555 select the task from a list of recently clocked tasks. With two @kbd{C-u
5556 C-u} prefixes, clock into the task at point and mark it as the default task.
5557 The default task will always be available when selecting a clocking task,
5558 with letter @kbd{d}.@*
5559 @cindex property: CLOCK_MODELINE_TOTAL
5560 @cindex property: LAST_REPEAT
5561 @vindex org-clock-modeline-total
5562 While the clock is running, the current clocking time is shown in the mode
5563 line, along with the title of the task. The clock time shown will be all
5564 time ever clocked for this task and its children. If the task has an effort
5565 estimate (@pxref{Effort estimates}), the mode line displays the current
5566 clocking time against it@footnote{To add an effort estimate ``on the fly'',
5567 hook a function doing this to @code{org-clock-in-prepare-hook}.} If the task
5568 is a repeating one (@pxref{Repeated tasks}), only the time since the last
5569 reset of the task @footnote{as recorded by the @code{LAST_REPEAT} property}
5570 will be shown. More control over what time is shown can be exercised with
5571 the @code{CLOCK_MODELINE_TOTAL} property. It may have the values
5572 @code{current} to show only the current clocking instance, @code{today} to
5573 show all time clocked on this tasks today (see also the variable
5574 @code{org-extend-today-until}), @code{all} to include all time, or
5575 @code{auto} which is the default@footnote{See also the variable
5576 @code{org-clock-modeline-total}.}.@* Clicking with @kbd{mouse-1} onto the
5577 mode line entry will pop up a menu with clocking options.
5580 @vindex org-log-note-clock-out
5581 Stop the clock (clock-out). This inserts another timestamp at the same
5582 location where the clock was last started. It also directly computes
5583 the resulting time in inserts it after the time range as @samp{=>
5584 HH:MM}. See the variable @code{org-log-note-clock-out} for the
5585 possibility to record an additional note together with the clock-out
5586 timestamp@footnote{The corresponding in-buffer setting is:
5587 @code{#+STARTUP: lognoteclock-out}}.
5590 Update the effort estimate for the current clock task.
5593 @item C-c C-y @ @ @r{or}@ @ C-c C-c
5594 Recompute the time interval after changing one of the timestamps. This
5595 is only necessary if you edit the timestamps directly. If you change
5596 them with @kbd{S-@key{cursor}} keys, the update is automatic.
5599 Changing the TODO state of an item to DONE automatically stops the clock
5600 if it is running in this same item.
5603 Cancel the current clock. This is useful if a clock was started by
5604 mistake, or if you ended up working on something else.
5607 Jump to the headline of the currently clocked in task. With a @kbd{C-u}
5608 prefix arg, select the target task from a list of recently clocked tasks.
5611 @vindex org-remove-highlights-with-change
5612 Display time summaries for each subtree in the current buffer. This
5613 puts overlays at the end of each headline, showing the total time
5614 recorded under that heading, including the time of any subheadings. You
5615 can use visibility cycling to study the tree, but the overlays disappear
5616 when you change the buffer (see variable
5617 @code{org-remove-highlights-with-change}) or press @kbd{C-c C-c}.
5620 Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
5621 report as an Org-mode table into the current file. When the cursor is
5622 at an existing clock table, just update it. When called with a prefix
5623 argument, jump to the first clock report in the current document and
5625 @cindex #+BEGIN, clocktable
5627 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
5631 If such a block already exists at point, its content is replaced by the
5632 new table. The @samp{BEGIN} line can specify options:
5634 :maxlevel @r{Maximum level depth to which times are listed in the table.}
5635 :emphasize @r{When @code{t}, emphasize level one and level two items.}
5636 :scope @r{The scope to consider. This can be any of the following:}
5637 nil @r{the current buffer or narrowed region}
5638 file @r{the full current buffer}
5639 subtree @r{the subtree where the clocktable is located}
5640 tree@var{N} @r{the surrounding level @var{N} tree, for example @code{tree3}}
5641 tree @r{the surrounding level 1 tree}
5642 agenda @r{all agenda files}
5643 ("file"..) @r{scan these files}
5644 file-with-archives @r{current file and its archives}
5645 agenda-with-archives @r{all agenda files, including archives}
5646 :block @r{The time block to consider. This block is specified either}
5647 @r{absolute, or relative to the current time and may be any of}
5649 2007-12-31 @r{New year eve 2007}
5650 2007-12 @r{December 2007}
5651 2007-W50 @r{ISO-week 50 in 2007}
5652 2007 @r{the year 2007}
5653 today, yesterday, today-@var{N} @r{a relative day}
5654 thisweek, lastweek, thisweek-@var{N} @r{a relative week}
5655 thismonth, lastmonth, thismonth-@var{N} @r{a relative month}
5656 thisyear, lastyear, thisyear-@var{N} @r{a relative year}
5657 @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
5658 :tstart @r{A time string specifying when to start considering times.}
5659 :tend @r{A time string specifying when to stop considering times.}
5660 :step @r{@code{week} or @code{day}, to split the table into chunks.}
5661 @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
5662 :stepskip0 @r{Don't show steps that have zero time}
5663 :tags @r{A tags match to select entries that should contribute}
5664 :link @r{Link the item headlines in the table to their origins.}
5665 :formula @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
5666 @r{As a special case, @samp{:formula %} adds a column with % time.}
5667 @r{If you do not specify a formula here, any existing formula.}
5668 @r{below the clock table will survive updates and be evaluated.}
5669 :timestamp @r{A timestamp for the entry, when available. Look for SCHEDULED,}
5670 @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.}
5672 To get a clock summary of the current level 1 tree, for the current
5673 day, you could write
5675 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
5679 and to use a specific time range you could write@footnote{Note that all
5680 parameters must be specified in a single line---the line is broken here
5681 only to fit it into the manual.}
5683 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
5684 :tend "<2006-08-10 Thu 12:00>"
5687 A summary of the current subtree with % times would be
5689 #+BEGIN: clocktable :scope subtree :link t :formula %
5696 Update dynamic block at point. The cursor needs to be in the
5697 @code{#+BEGIN} line of the dynamic block.
5698 @kindex C-u C-c C-x C-u
5699 @item C-u C-c C-x C-u
5700 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
5701 you have several clock table blocks in a buffer.
5702 @kindex S-@key{left}
5703 @kindex S-@key{right}
5705 @itemx S-@key{right}
5706 Shift the current @code{:block} interval and update the table. The cursor
5707 needs to be in the @code{#+BEGIN: clocktable} line for this command. If
5708 @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
5711 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
5712 the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
5713 worked on or closed during a day.
5715 @node Resolving idle time, Effort estimates, Clocking work time, Dates and Times
5716 @section Resolving idle time
5717 @cindex resolve idle time
5719 @cindex idle, resolve, dangling
5720 If you clock in on a work item, and then walk away from your
5721 computer---perhaps to take a phone call---you often need to ``resolve'' the
5722 time you were away by either subtracting it from the current clock, or
5723 applying it to another one.
5725 @vindex org-clock-idle-time
5726 By customizing the variable @code{org-clock-idle-time} to some integer, such
5727 as 10 or 15, Emacs can alert you when you get back to your computer after
5728 being idle for that many minutes@footnote{On computers using Mac OS X,
5729 idleness is based on actual user idleness, not just Emacs' idle time. For
5730 X11, you can install a utility program @file{x11idle.c}, available in the
5731 UTILITIES directory of the Org git distribution, to get the same general
5732 treatment of idleness. On other systems, idle time refers to Emacs idle time
5733 only.}, and ask what you want to do with the idle time. There will be a
5734 question waiting for you when you get back, indicating how much idle time has
5735 passed (constantly updated with the current amount), as well as a set of
5736 choices to correct the discrepancy:
5740 To keep some or all of the minutes and stay clocked in, press @kbd{k}. Org
5741 will ask how many of the minutes to keep. Press @key{RET} to keep them all,
5742 effectively changing nothing, or enter a number to keep that many minutes.
5744 If you use the shift key and press @kbd{K}, it will keep however many minutes
5745 you request and then immediately clock out of that task. If you keep all of
5746 the minutes, this is the same as just clocking out of the current task.
5748 To keep none of the minutes, use @kbd{s} to subtract all the away time from
5749 the clock, and then check back in from the moment you returned.
5751 To keep none of the minutes and just clock out at the start of the away time,
5752 use the shift key and press @kbd{S}. Remember that using shift will always
5753 leave you clocked out, no matter which option you choose.
5755 To cancel the clock altogether, use @kbd{C}. Note that if instead of
5756 canceling you subtract the away time, and the resulting clock amount is less
5757 than a minute, the clock will still be canceled rather than clutter up the
5758 log with an empty entry.
5761 What if you subtracted those away minutes from the current clock, and now
5762 want to apply them to a new clock? Simply clock in to any task immediately
5763 after the subtraction. Org will notice that you have subtracted time ``on
5764 the books'', so to speak, and will ask if you want to apply those minutes to
5765 the next task you clock in on.
5767 There is one other instance when this clock resolution magic occurs. Say you
5768 were clocked in and hacking away, and suddenly your cat chased a mouse who
5769 scared a hamster that crashed into your UPS's power button! You suddenly
5770 lose all your buffers, but thanks to auto-save you still have your recent Org
5771 mode changes, including your last clock in.
5773 If you restart Emacs and clock into any task, Org will notice that you have a
5774 dangling clock which was never clocked out from your last session. Using
5775 that clock's starting time as the beginning of the unaccounted-for period,
5776 Org will ask how you want to resolve that time. The logic and behavior is
5777 identical to dealing with away time due to idleness, it's just happening due
5778 to a recovery event rather than a set amount of idle time.
5780 You can also check all the files visited by your Org agenda for dangling
5781 clocks at any time using @kbd{M-x org-resolve-clocks}.
5783 @node Effort estimates, Relative timer, Resolving idle time, Dates and Times
5784 @section Effort estimates
5785 @cindex effort estimates
5787 @cindex property, Effort
5788 @vindex org-effort-property
5789 If you want to plan your work in a very detailed way, or if you need to
5790 produce offers with quotations of the estimated work effort, you may want to
5791 assign effort estimates to entries. If you are also clocking your work, you
5792 may later want to compare the planned effort with the actual working time, a
5793 great way to improve planning estimates. Effort estimates are stored in a
5794 special property @samp{Effort}@footnote{You may change the property being
5795 used with the variable @code{org-effort-property}.}. You can set the effort
5796 for an entry with the following commands:
5801 Set the effort estimate for the current entry. With a numeric prefix
5802 argument, set it to the NTH allowed value (see below). This command is also
5803 accessible from the agenda with the @kbd{e} key.
5806 Modify the effort estimate of the item currently being clocked.
5809 Clearly the best way to work with effort estimates is through column view
5810 (@pxref{Column view}). You should start by setting up discrete values for
5811 effort estimates, and a @code{COLUMNS} format that displays these values
5812 together with clock sums (if you want to clock your time). For a specific
5816 #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00
5817 #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
5821 @vindex org-global-properties
5822 @vindex org-columns-default-format
5823 or, even better, you can set up these values globally by customizing the
5824 variables @code{org-global-properties} and @code{org-columns-default-format}.
5825 In particular if you want to use this setup also in the agenda, a global
5826 setup may be advised.
5828 The way to assign estimates to individual items is then to switch to column
5829 mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
5830 value. The values you enter will immediately be summed up in the hierarchy.
5831 In the column next to it, any clocked time will be displayed.
5833 @vindex org-agenda-columns-add-appointments-to-effort-sum
5834 If you switch to column view in the daily/weekly agenda, the effort column
5835 will summarize the estimated work effort for each day@footnote{Please note
5836 the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
5837 column view}).}, and you can use this to find space in your schedule. To get
5838 an overview of the entire part of the day that is committed, you can set the
5839 option @code{org-agenda-columns-add-appointments-to-effort-sum}. The
5840 appointments on a day that take place over a specified time interval will
5841 then also be added to the load estimate of the day.
5843 Effort estimates can be used in secondary agenda filtering that is triggered
5844 with the @kbd{/} key in the agenda (@pxref{Agenda commands}). If you have
5845 these estimates defined consistently, two or three key presses will narrow
5846 down the list to stuff that fits into an available time slot.
5848 @node Relative timer, , Effort estimates, Dates and Times
5849 @section Taking notes with a relative timer
5850 @cindex relative timer
5852 When taking notes during, for example, a meeting or a video viewing, it can
5853 be useful to have access to times relative to a starting time. Org provides
5854 such a relative timer and make it easy to create timed notes.
5859 Insert a relative time into the buffer. The first time you use this, the
5860 timer will be started. When called with a prefix argument, the timer is
5864 Insert a description list item with the current relative time. With a prefix
5865 argument, first reset the timer to 0.
5868 Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
5872 Pause the timer, or continue it if it is already paused.
5873 @c removed the sentence because it is redundant to the following item
5874 @kindex C-u C-c C-x ,
5876 Stop the timer. After this, you can only start a new timer, not continue the
5877 old one. This command also removes the timer from the mode line.
5880 Reset the timer without inserting anything into the buffer. By default, the
5881 timer is reset to 0. When called with a @kbd{C-u} prefix, reset the timer to
5882 specific starting offset. The user is prompted for the offset, with a
5883 default taken from a timer string at point, if any, So this can be used to
5884 restart taking notes after a break in the process. When called with a double
5885 prefix argument @kbd{C-u C-u}, change all timer strings in the active region
5886 by a certain amount. This can be used to fix timer strings if the timer was
5887 not started at exactly the right moment.
5890 @node Capture - Refile - Archive, Agenda Views, Dates and Times, Top
5891 @chapter Capture - Refile - Archive
5894 An important part of any organization system is the ability to quickly
5895 capture new ideas and tasks, and to associate reference material with them.
5896 Org does this using a process called @i{capture}. It also can store files
5897 related to a task (@i{attachments}) in a special directory. Once in the
5898 system, tasks and projects need to be moved around. Moving completed project
5899 trees to an archive file keeps the system compact and fast.
5902 * Capture:: Capturing new stuff
5903 * Attachments:: Add files to tasks
5904 * RSS Feeds:: Getting input from RSS feeds
5905 * Protocols:: External (e.g. Browser) access to Emacs and Org
5906 * Refiling notes:: Moving a tree from one place to another
5907 * Archiving:: What to do with finished projects
5910 @node Capture, Attachments, Capture - Refile - Archive, Capture - Refile - Archive
5914 Org's method for capturing new items is heavily inspired by John Wiegley
5915 excellent remember package. Up to version 6.36 Org used a special setup
5916 for @file{remember.el}. @file{org-remember.el} is still part of Org-mode for
5917 backward compatibility with existing setups. You can find the documentation
5918 for org-remember at @url{http://orgmode.org/org-remember.pdf}.
5920 The new capturing setup described here is preferred and should be used by new
5921 users. To convert your @code{org-remember-templates}, run the command
5923 @kbd{M-x org-capture-import-remember-templates @key{RET}}
5925 @noindent and then customize the new variable with @kbd{M-x
5926 customize-variable org-capture-templates}, check the result, and save the
5927 customization. You can then use both remember and capture until
5928 you are familiar with the new mechanism.
5930 Capture lets you quickly store notes with little interruption of your work
5931 flow. The basic process of capturing is very similar to remember, but Org
5932 does enhance it with templates and more.
5935 * Setting up capture:: Where notes will be stored
5936 * Using capture:: Commands to invoke and terminate capture
5937 * Capture templates:: Define the outline of different note types
5940 @node Setting up capture, Using capture, Capture, Capture
5941 @subsection Setting up capture
5943 The following customization sets a default target file for notes, and defines
5944 a global key@footnote{Please select your own key, @kbd{C-c c} is only a
5945 suggestion.} for capturing new material.
5947 @vindex org-default-notes-file
5949 (setq org-default-notes-file (concat org-directory "/notes.org"))
5950 (define-key global-map "\C-cc" 'org-capture)
5953 @node Using capture, Capture templates, Setting up capture, Capture
5954 @subsection Using capture
5959 Call the command @code{org-capture}. If you have templates defined
5960 @pxref{Capture templates}, it will offer these templates for selection or use
5961 a new Org outline node as the default template. It will insert the template
5962 into the target file and switch to an indirect buffer narrowed to this new
5963 node. You may then insert the information you want.
5967 Once you have finished entering information into the capture buffer,
5968 @kbd{C-c C-c} will return you to the window configuration before the capture
5969 process, so that you can resume your work without further distraction.
5973 Finalize the capture process by refiling (@pxref{Refiling notes}) the note to
5978 Abort the capture process and return to the previous state.
5981 You can also call @code{org-capture} in a special way from the agenda, using
5982 the @kbd{k c} key combination. With this access, any timestamps inserted by
5983 the selected capture template will default to the cursor date in the agenda,
5984 rather than to the current date.
5986 @node Capture templates, , Using capture, Capture
5987 @subsection Capture templates
5988 @cindex templates, for Capture
5990 You can use templates for different types of capture items, and
5991 for different target locations. The easiest way to create such templates is
5992 through the customize interface.
5997 Customize the variable @code{org-capture-templates}.
6000 Before we give the formal description of template definitions, let's look at
6001 an example. Say you would like to use one template to create general TODO
6002 entries, and you want to put these entries under the heading @samp{Tasks} in
6003 your file @file{~/org/gtd.org}. Also, a date tree in the file
6004 @file{journal.org} should capture journal entries. A possible configuration
6008 (setq org-capture-templates
6009 '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks")
6010 "* TODO %?\n %i\n %a")
6011 ("j" "Journal" entry (file+datetree "~/org/journal.org")
6012 "* %?\nEntered on %U\n %i\n %a")))
6015 @noindent If you then press @kbd{C-c c t}, Org will prepare the template
6019 [[file:@var{link to where you initiated capture}]]
6023 During expansion of the template, @code{%a} has been replaced by a link to
6024 the location from where you called the capture command. This can be
6025 extremely useful for deriving tasks from emails, for example. You fill in
6026 the task definition, press @code{C-c C-c} and Org returns you to the same
6027 place where you started the capture process.
6031 * Template elements:: What is needed for a complete template entry
6032 * Template expansion:: Filling in information about time and context
6035 @node Template elements, Template expansion, Capture templates, Capture templates
6036 @subsubsection Template elements
6038 Now lets look at the elements of a template definition. Each entry in
6039 @code{org-capture-templates} is a list with the following items:
6043 The keys that will select the template, as a string, characters
6044 only, for example @code{"a"} for a template to be selected with a
6045 single key, or @code{"bt"} for selection with two keys. When using
6046 several keys, keys using the same prefix key must be sequential
6047 in the list and preceded by a 2-element entry explaining the
6048 prefix key, for example
6050 ("b" "Templates for marking stuff to buy")
6052 @noindent If you do not define a template for the @kbd{C} key, this key will
6053 be used to open the customize buffer for this complex variable.
6056 A short string describing the template, which will be shown during
6060 The type of entry, a symbol. Valid values are:
6063 An Org-mode node, with a headline. Will be filed as the child of the
6064 target entry or as a top-level entry. The target file should be an Org-mode
6067 A plain list item, placed in the first plain list at the target
6068 location. Again the target file should be an Org file.
6070 A checkbox item. This only differs from the plain list item by the
6073 a new line in the first table at the target location. Where exactly the
6074 line will be inserted depends on the properties @code{:prepend} and
6075 @code{:table-line-pos} (see below).
6077 Text to be inserted as it is.
6081 @vindex org-default-notes-file
6082 Specification of where the captured item should be placed. In Org-mode
6083 files, targets usually define a node. Entries will become children of this
6084 node, other types will be added to the table or list in the body of this
6085 node. Most target specifications contain a file name. If that file name is
6086 the empty string, it defaults to @code{org-default-notes-file}.
6090 @item (file "path/to/file")
6091 Text will be placed at the beginning or end of that file.
6093 @item (id "id of existing org entry")
6094 Filing as child of this entry, or in the body of the entry.
6096 @item (file+headline "path/to/file" "node headline")
6097 Fast configuration if the target heading is unique in the file.
6099 @item (file+olp "path/to/file" "Level 1 heading" "Level 2" ...)
6100 For non-unique headings, the full path is safer.
6102 @item (file+regexp "path/to/file" "regexp to find location")
6103 Use a regular expression to position the cursor.
6105 @item (file+datetree "path/to/file")
6106 Will create a heading in a date tree.
6108 @item (file+function "path/to/file" function-finding-location)
6109 A function to find the right location in the file.
6112 File to the entry that is currently being clocked.
6114 @item (function function-finding-location)
6115 Most general way, write your own function to find both
6120 The template for creating the capture item. If you leave this empty, an
6121 appropriate default template will be used. Otherwise this is a string with
6122 escape codes, which will be replaced depending on time and context of the
6123 capture call. The string with escapes may be loaded from a template file,
6124 using the special syntax @code{(file "path/to/template")}. See below for
6128 The rest of the entry is a property list of additional options.
6129 Recognized properties are:
6132 Normally new captured information will be appended at
6133 the target location (last child, last table line, last list item...).
6134 Setting this property will change that.
6136 @item :immediate-finish
6137 When set, do not offer to edit the information, just
6138 file it away immediately. This makes sense if the template only needs
6139 information that can be added automatically.
6142 Set this to the number of lines to insert
6143 before and after the new item. Default 0, only common other value is 1.
6146 Start the clock in this item.
6149 If starting the capture interrupted a clock, restart that clock when finished
6153 Do not narrow the target buffer, simply show the full buffer. Default is to
6154 narrow it so that you only see the new material.
6158 @node Template expansion, , Template elements, Capture templates
6159 @subsubsection Template expansion
6161 In the template itself, special @kbd{%}-escapes@footnote{If you need one of
6162 these sequences literally, escape the @kbd{%} with a backslash.} allow
6163 dynamic insertion of content:
6165 @comment SJE: should these sentences terminate in period?
6167 %^@{@var{prompt}@} @r{prompt the user for a string and replace this sequence with it.}
6168 @r{You may specify a default value and a completion table with}
6169 @r{%^@{prompt|default|completion2|completion3...@}}
6170 @r{The arrow keys access a prompt-specific history.}
6171 %a @r{annotation, normally the link created with @code{org-store-link}}
6172 %A @r{like @code{%a}, but prompt for the description part}
6173 %i @r{initial content, the region when capture is called while the}
6174 @r{region is active.}
6175 @r{The entire text will be indented like @code{%i} itself.}
6176 %t @r{timestamp, date only}
6177 %T @r{timestamp with date and time}
6178 %u, %U @r{like the above, but inactive timestamps}
6179 %^t @r{like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}}
6180 @r{You may define a prompt like @code{%^@{Birthday@}t}}
6181 %n @r{user name (taken from @code{user-full-name})}
6182 %c @r{Current kill ring head.}
6183 %x @r{Content of the X clipboard.}
6184 %^C @r{Interactive selection of which kill or clip to use.}
6185 %^L @r{Like @code{%^C}, but insert as link.}
6186 %k @r{title of the currently clocked task}
6187 %K @r{link to the currently clocked task}
6188 %^g @r{prompt for tags, with completion on tags in target file.}
6189 %^G @r{prompt for tags, with completion all tags in all agenda files.}
6190 %^@{@var{prop}@}p @r{Prompt the user for a value for property @var{prop}}
6191 %:keyword @r{specific information for certain link types, see below}
6192 %[@var{file}] @r{insert the contents of the file given by @var{file}}
6193 %(@var{sexp}) @r{evaluate Elisp @var{sexp} and replace with the result}
6197 For specific link types, the following keywords will be
6198 defined@footnote{If you define your own link types (@pxref{Adding
6199 hyperlink types}), any property you store with
6200 @code{org-store-link-props} can be accessed in capture templates in a
6203 @vindex org-from-is-user-regexp
6205 Link type | Available keywords
6206 -------------------+----------------------------------------------
6207 bbdb | %:name %:company
6208 irc | %:server %:port %:nick
6209 vm, wl, mh, mew, rmail | %:type %:subject %:message-id
6210 | %:from %:fromname %:fromaddress
6211 | %:to %:toname %:toaddress
6212 | %:date @r{(message date header field)}
6213 | %:date-timestamp @r{(date as active timestamp)}
6214 | %:date-timestamp-inactive @r{(date as inactive timestamp)}
6215 | %: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}.}}
6216 gnus | %:group, @r{for messages also all email fields}
6218 info | %:file %:node
6223 To place the cursor after template expansion use:
6226 %? @r{After completing the template, position cursor here.}
6230 @node Attachments, RSS Feeds, Capture, Capture - Refile - Archive
6231 @section Attachments
6234 @vindex org-attach-directory
6235 It is often useful to associate reference material with an outline node/task.
6236 Small chunks of plain text can simply be stored in the subtree of a project.
6237 Hyperlinks (@pxref{Hyperlinks}) can establish associations with
6238 files that live elsewhere on your computer or in the cloud, like emails or
6239 source code files belonging to a project. Another method is @i{attachments},
6240 which are files located in a directory belonging to an outline node. Org
6241 uses directories named by the unique ID of each entry. These directories are
6242 located in the @file{data} directory which lives in the same directory where
6243 your Org file lives@footnote{If you move entries or Org files from one
6244 directory to another, you may want to configure @code{org-attach-directory}
6245 to contain an absolute path.}. If you initialize this directory with
6246 @code{git init}, Org will automatically commit changes when it sees them.
6247 The attachment system has been contributed to Org by John Wiegley.
6249 In cases where it seems better to do so, you can also attach a directory of your
6250 choice to an entry. You can also make children inherit the attachment
6251 directory from a parent, so that an entire subtree uses the same attached
6254 @noindent The following commands deal with attachments:
6260 The dispatcher for commands related to the attachment system. After these
6261 keys, a list of commands is displayed and you must press an additional key
6262 to select a command:
6267 @vindex org-attach-method
6268 Select a file and move it into the task's attachment directory. The file
6269 will be copied, moved, or linked, depending on @code{org-attach-method}.
6270 Note that hard links are not supported on all systems.
6276 Attach a file using the copy/move/link method.
6277 Note that hard links are not supported on all systems.
6281 Create a new attachment as an Emacs buffer.
6285 Synchronize the current task with its attachment directory, in case you added
6286 attachments yourself.
6290 @vindex org-file-apps
6291 Open current task's attachment. If there is more than one, prompt for a
6292 file name first. Opening will follow the rules set by @code{org-file-apps}.
6293 For more details, see the information on following hyperlinks
6294 (@pxref{Handling links}).
6298 Also open the attachment, but force opening the file in Emacs.
6302 Open the current task's attachment directory.
6306 Also open the directory, but force using @command{dired} in Emacs.
6310 Select and delete a single attachment.
6314 Delete all of a task's attachments. A safer way is to open the directory in
6315 @command{dired} and delete from there.
6319 @cindex property, ATTACH_DIR
6320 Set a specific directory as the entry's attachment directory. This works by
6321 putting the directory path into the @code{ATTACH_DIR} property.
6325 @cindex property, ATTACH_DIR_INHERIT
6326 Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
6327 same directory for attachments as the parent does.
6331 @node RSS Feeds, Protocols, Attachments, Capture - Refile - Archive
6336 Org can add and change entries based on information found in RSS feeds and
6337 Atom feeds. You could use this to make a task out of each new podcast in a
6338 podcast feed. Or you could use a phone-based note-creating service on the
6339 web to import tasks into Org. To access feeds, configure the variable
6340 @code{org-feed-alist}. The docstring of this variable has detailed
6341 information. Here is just an example:
6344 (setq org-feed-alist
6346 "http://rss.slashdot.org/Slashdot/slashdot"
6347 "~/txt/org/feeds.org" "Slashdot Entries")))
6351 will configure that new items from the feed provided by
6352 @code{rss.slashdot.org} will result in new entries in the file
6353 @file{~/org/feeds.org} under the heading @samp{Slashdot Entries}, whenever
6354 the following command is used:
6359 Collect items from the feeds configured in @code{org-feed-alist} and act upon
6363 Prompt for a feed name and go to the inbox configured for this feed.
6366 Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which
6367 it will store information about the status of items in the feed, to avoid
6368 adding the same item several times. You should add @samp{FEEDSTATUS} to the
6369 list of drawers in that file:
6372 #+DRAWERS: LOGBOOK PROPERTIES FEEDSTATUS
6375 For more information, including how to read atom feeds, see
6376 @file{org-feed.el} and the docstring of @code{org-feed-alist}.
6378 @node Protocols, Refiling notes, RSS Feeds, Capture - Refile - Archive
6379 @section Protocols for external access
6380 @cindex protocols, for external access
6383 You can set up Org for handling protocol calls from outside applications that
6384 are passed to Emacs through the @file{emacsserver}. For example, you can
6385 configure bookmarks in your web browser to send a link to the current page to
6386 Org and create a note from it using capture (@pxref{Capture}). Or you
6387 could create a bookmark that will tell Emacs to open the local source file of
6388 a remote website you are looking at with the browser. See
6389 @uref{http://orgmode.org/worg/org-contrib/org-protocol.php} for detailed
6390 documentation and setup instructions.
6392 @node Refiling notes, Archiving, Protocols, Capture - Refile - Archive
6393 @section Refiling notes
6394 @cindex refiling notes
6396 When reviewing the captured data, you may want to refile some of the entries
6397 into a different list, for example into a project. Cutting, finding the
6398 right location, and then pasting the note is cumbersome. To simplify this
6399 process, you can use the following special command:
6404 @vindex org-reverse-note-order
6405 @vindex org-refile-targets
6406 @vindex org-refile-use-outline-path
6407 @vindex org-outline-path-complete-in-steps
6408 @vindex org-refile-allow-creating-parent-nodes
6409 @vindex org-log-refile
6410 @vindex org-refile-use-cache
6411 Refile the entry or region at point. This command offers possible locations
6412 for refiling the entry and lets you select one with completion. The item (or
6413 all items in the region) is filed below the target heading as a subitem.
6414 Depending on @code{org-reverse-note-order}, it will be either the first or
6416 By default, all level 1 headlines in the current buffer are considered to be
6417 targets, but you can have more complex definitions across a number of files.
6418 See the variable @code{org-refile-targets} for details. If you would like to
6419 select a location via a file-path-like completion along the outline path, see
6420 the variables @code{org-refile-use-outline-path} and
6421 @code{org-outline-path-complete-in-steps}. If you would like to be able to
6422 create new nodes as new parents for refiling on the fly, check the
6423 variable @code{org-refile-allow-creating-parent-nodes}.
6424 When the variable @code{org-log-refile}@footnote{with corresponding
6425 @code{#+STARTUP} keywords @code{logrefile}, @code{lognoterefile},
6426 and @code{nologrefile}} is set, a time stamp or a note will be
6427 recorded when an entry has been refiled.
6430 Use the refile interface to jump to a heading.
6431 @kindex C-u C-u C-c C-w
6432 @item C-u C-u C-c C-w
6433 Jump to the location where @code{org-refile} last moved a tree to.
6435 Refile as the child of the item currently being clocked.
6436 @item C-0 C-c C-w @ @r{or} @ C-u C-u C-u C-c C-w
6437 Clear the target cache. Caching of refile targets can be turned on by
6438 setting @code{org-refile-use-cache}. To make the command seen new possible
6439 targets, you have to clear the cache with this command.
6442 @node Archiving, , Refiling notes, Capture - Refile - Archive
6446 When a project represented by a (sub)tree is finished, you may want
6447 to move the tree out of the way and to stop it from contributing to the
6448 agenda. Archiving is important to keep your working files compact and global
6449 searches like the construction of agenda views fast.
6454 @vindex org-archive-default-command
6455 Archive the current entry using the command specified in the variable
6456 @code{org-archive-default-command}.
6460 * Moving subtrees:: Moving a tree to an archive file
6461 * Internal archiving:: Switch off a tree but keep it in the file
6464 @node Moving subtrees, Internal archiving, Archiving, Archiving
6465 @subsection Moving a tree to the archive file
6466 @cindex external archiving
6468 The most common archiving action is to move a project tree to another file,
6474 @item C-c C-x C-s@ @r{or short} @ C-c $
6475 @vindex org-archive-location
6476 Archive the subtree starting at the cursor position to the location
6477 given by @code{org-archive-location}.
6478 @kindex C-u C-c C-x C-s
6479 @item C-u C-c C-x C-s
6480 Check if any direct children of the current headline could be moved to
6481 the archive. To do this, each subtree is checked for open TODO entries.
6482 If none are found, the command offers to move it to the archive
6483 location. If the cursor is @emph{not} on a headline when this command
6484 is invoked, the level 1 trees will be checked.
6487 @cindex archive locations
6488 The default archive location is a file in the same directory as the
6489 current file, with the name derived by appending @file{_archive} to the
6490 current file name. For information and examples on how to change this,
6491 see the documentation string of the variable
6492 @code{org-archive-location}. There is also an in-buffer option for
6493 setting this variable, for example@footnote{For backward compatibility,
6494 the following also works: If there are several such lines in a file,
6495 each specifies the archive location for the text below it. The first
6496 such line also applies to any text before its definition. However,
6497 using this method is @emph{strongly} deprecated as it is incompatible
6498 with the outline structure of the document. The correct method for
6499 setting multiple archive locations in a buffer is using properties.}:
6503 #+ARCHIVE: %s_done::
6506 @cindex property, ARCHIVE
6508 If you would like to have a special ARCHIVE location for a single entry
6509 or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
6510 location as the value (@pxref{Properties and Columns}).
6512 @vindex org-archive-save-context-info
6513 When a subtree is moved, it receives a number of special properties that
6514 record context information like the file from where the entry came, its
6515 outline path the archiving time etc. Configure the variable
6516 @code{org-archive-save-context-info} to adjust the amount of information
6520 @node Internal archiving, , Moving subtrees, Archiving
6521 @subsection Internal archiving
6523 If you want to just switch off (for agenda views) certain subtrees without
6524 moving them to a different file, you can use the @code{ARCHIVE tag}.
6526 A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
6527 its location in the outline tree, but behaves in the following way:
6530 @vindex org-cycle-open-archived-trees
6531 It does not open when you attempt to do so with a visibility cycling
6532 command (@pxref{Visibility cycling}). You can force cycling archived
6533 subtrees with @kbd{C-@key{TAB}}, or by setting the option
6534 @code{org-cycle-open-archived-trees}. Also normal outline commands like
6535 @code{show-all} will open archived subtrees.
6537 @vindex org-sparse-tree-open-archived-trees
6538 During sparse tree construction (@pxref{Sparse trees}), matches in
6539 archived subtrees are not exposed, unless you configure the option
6540 @code{org-sparse-tree-open-archived-trees}.
6542 @vindex org-agenda-skip-archived-trees
6543 During agenda view construction (@pxref{Agenda Views}), the content of
6544 archived trees is ignored unless you configure the option
6545 @code{org-agenda-skip-archived-trees}, in which case these trees will always
6546 be included. In the agenda you can press @kbd{v a} to get archives
6547 temporarily included.
6549 @vindex org-export-with-archived-trees
6550 Archived trees are not exported (@pxref{Exporting}), only the headline
6551 is. Configure the details using the variable
6552 @code{org-export-with-archived-trees}.
6554 @vindex org-columns-skip-archived-trees
6555 Archived trees are excluded from column view unless the variable
6556 @code{org-columns-skip-archived-trees} is configured to @code{nil}.
6559 The following commands help manage the ARCHIVE tag:
6564 Toggle the ARCHIVE tag for the current headline. When the tag is set,
6565 the headline changes to a shadowed face, and the subtree below it is
6567 @kindex C-u C-c C-x a
6569 Check if any direct children of the current headline should be archived.
6570 To do this, each subtree is checked for open TODO entries. If none are
6571 found, the command offers to set the ARCHIVE tag for the child. If the
6572 cursor is @emph{not} on a headline when this command is invoked, the
6573 level 1 trees will be checked.
6576 Cycle a tree even if it is tagged with ARCHIVE.
6579 Move the current entry to the @emph{Archive Sibling}. This is a sibling of
6580 the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}. The
6581 entry becomes a child of that sibling and in this way retains a lot of its
6582 original context, including inherited tags and approximate position in the
6587 @node Agenda Views, Markup, Capture - Refile - Archive, Top
6588 @chapter Agenda views
6589 @cindex agenda views
6591 Due to the way Org works, TODO items, time-stamped items, and
6592 tagged headlines can be scattered throughout a file or even a number of
6593 files. To get an overview of open action items, or of events that are
6594 important for a particular date, this information must be collected,
6595 sorted and displayed in an organized way.
6597 Org can select items based on various criteria and display them
6598 in a separate buffer. Seven different view types are provided:
6602 an @emph{agenda} that is like a calendar and shows information
6605 a @emph{TODO list} that covers all unfinished
6608 a @emph{match view}, showings headlines based on the tags, properties, and
6609 TODO state associated with them,
6611 a @emph{timeline view} that shows all events in a single Org file,
6612 in time-sorted view,
6614 a @emph{text search view} that shows all entries from multiple files
6615 that contain specified keywords,
6617 a @emph{stuck projects view} showing projects that currently don't move
6620 @emph{custom views} that are special searches and combinations of different
6625 The extracted information is displayed in a special @emph{agenda
6626 buffer}. This buffer is read-only, but provides commands to visit the
6627 corresponding locations in the original Org files, and even to
6628 edit these files remotely.
6630 @vindex org-agenda-window-setup
6631 @vindex org-agenda-restore-windows-after-quit
6632 Two variables control how the agenda buffer is displayed and whether the
6633 window configuration is restored when the agenda exits:
6634 @code{org-agenda-window-setup} and
6635 @code{org-agenda-restore-windows-after-quit}.
6638 * Agenda files:: Files being searched for agenda information
6639 * Agenda dispatcher:: Keyboard access to agenda views
6640 * Built-in agenda views:: What is available out of the box?
6641 * Presentation and sorting:: How agenda items are prepared for display
6642 * Agenda commands:: Remote editing of Org trees
6643 * Custom agenda views:: Defining special searches and views
6644 * Exporting Agenda Views:: Writing a view to a file
6645 * Agenda column view:: Using column view for collected entries
6648 @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views
6649 @section Agenda files
6650 @cindex agenda files
6651 @cindex files for agenda
6653 @vindex org-agenda-files
6654 The information to be shown is normally collected from all @emph{agenda
6655 files}, the files listed in the variable
6656 @code{org-agenda-files}@footnote{If the value of that variable is not a
6657 list, but a single file name, then the list of agenda files will be
6658 maintained in that external file.}. If a directory is part of this list,
6659 all files with the extension @file{.org} in this directory will be part
6662 Thus, even if you only work with a single Org file, that file should
6663 be put into the list@footnote{When using the dispatcher, pressing
6664 @kbd{<} before selecting a command will actually limit the command to
6665 the current file, and ignore @code{org-agenda-files} until the next
6666 dispatcher command.}. You can customize @code{org-agenda-files}, but
6667 the easiest way to maintain it is through the following commands
6669 @cindex files, adding to agenda list
6673 Add current file to the list of agenda files. The file is added to
6674 the front of the list. If it was already in the list, it is moved to
6675 the front. With a prefix argument, file is added/moved to the end.
6678 Remove current file from the list of agenda files.
6683 Cycle through agenda file list, visiting one file after the other.
6684 @kindex M-x org-iswitchb
6685 @item M-x org-iswitchb
6686 Command to use an @code{iswitchb}-like interface to switch to and between Org
6691 The Org menu contains the current list of files and can be used
6692 to visit any of them.
6694 If you would like to focus the agenda temporarily on a file not in
6695 this list, or on just one file in the list, or even on only a subtree in a
6696 file, then this can be done in different ways. For a single agenda command,
6697 you may press @kbd{<} once or several times in the dispatcher
6698 (@pxref{Agenda dispatcher}). To restrict the agenda scope for an
6699 extended period, use the following commands:
6704 Permanently restrict the agenda to the current subtree. When with a
6705 prefix argument, or with the cursor before the first headline in a file,
6706 the agenda scope is set to the entire file. This restriction remains in
6707 effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
6708 or @kbd{>} in the agenda dispatcher. If there is a window displaying an
6709 agenda view, the new restriction takes effect immediately.
6712 Remove the permanent restriction created by @kbd{C-c C-x <}.
6716 When working with @file{speedbar.el}, you can use the following commands in
6720 @item < @r{in the speedbar frame}
6721 Permanently restrict the agenda to the item---either an Org file or a subtree
6722 in such a file---at the cursor in the Speedbar frame.
6723 If there is a window displaying an agenda view, the new restriction takes
6726 @item > @r{in the speedbar frame}
6727 Lift the restriction.
6730 @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views
6731 @section The agenda dispatcher
6732 @cindex agenda dispatcher
6733 @cindex dispatching agenda commands
6734 The views are created through a dispatcher, which should be bound to a
6735 global key---for example @kbd{C-c a} (@pxref{Installation}). In the
6736 following we will assume that @kbd{C-c a} is indeed how the dispatcher
6737 is accessed and list keyboard access to commands accordingly. After
6738 pressing @kbd{C-c a}, an additional letter is required to execute a
6739 command. The dispatcher offers the following default commands:
6742 Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
6744 Create a list of all TODO items (@pxref{Global TODO list}).
6746 Create a list of headlines matching a TAGS expression (@pxref{Matching
6747 tags and properties}).
6749 Create the timeline view for the current buffer (@pxref{Timeline}).
6751 Create a list of entries selected by a boolean expression of keywords
6752 and/or regular expressions that must or must not occur in the entry.
6754 @vindex org-agenda-text-search-extra-files
6755 Search for a regular expression in all agenda files and additionally in
6756 the files listed in @code{org-agenda-text-search-extra-files}. This
6757 uses the Emacs command @code{multi-occur}. A prefix argument can be
6758 used to specify the number of context lines for each match, default is
6761 Create a list of stuck projects (@pxref{Stuck projects}).
6763 Restrict an agenda command to the current buffer@footnote{For backward
6764 compatibility, you can also press @kbd{1} to restrict to the current
6765 buffer.}. After pressing @kbd{<}, you still need to press the character
6766 selecting the command.
6768 If there is an active region, restrict the following agenda command to
6769 the region. Otherwise, restrict it to the current subtree@footnote{For
6770 backward compatibility, you can also press @kbd{0} to restrict to the
6771 current region/subtree.}. After pressing @kbd{< <}, you still need to press the
6772 character selecting the command.
6775 You can also define custom commands that will be accessible through the
6776 dispatcher, just like the default commands. This includes the
6777 possibility to create extended agenda buffers that contain several
6778 blocks together, for example the weekly agenda, the global TODO list and
6779 a number of special tags matches. @xref{Custom agenda views}.
6781 @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda Views
6782 @section The built-in agenda views
6784 In this section we describe the built-in views.
6787 * Weekly/daily agenda:: The calendar page with current tasks
6788 * Global TODO list:: All unfinished action items
6789 * Matching tags and properties:: Structured information with fine-tuned search
6790 * Timeline:: Time-sorted view for single file
6791 * Search view:: Find entries by searching for text
6792 * Stuck projects:: Find projects you need to review
6795 @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views
6796 @subsection The weekly/daily agenda
6798 @cindex weekly agenda
6799 @cindex daily agenda
6801 The purpose of the weekly/daily @emph{agenda} is to act like a page of a
6802 paper agenda, showing all the tasks for the current week or day.
6805 @cindex org-agenda, command
6808 @vindex org-agenda-ndays
6809 Compile an agenda for the current week from a list of Org files. The agenda
6810 shows the entries for each day. With a numeric prefix@footnote{For backward
6811 compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
6812 listed before the agenda. This feature is deprecated, use the dedicated TODO
6813 list, or a block agenda instead (@pxref{Block agenda}).} (like @kbd{C-u 2 1
6814 C-c a a}) you may set the number of days to be displayed (see also the
6815 variable @code{org-agenda-ndays})
6818 Remote editing from the agenda buffer means, for example, that you can
6819 change the dates of deadlines and appointments from the agenda buffer.
6820 The commands available in the Agenda buffer are listed in @ref{Agenda
6823 @subsubheading Calendar/Diary integration
6824 @cindex calendar integration
6825 @cindex diary integration
6827 Emacs contains the calendar and diary by Edward M. Reingold. The
6828 calendar displays a three-month calendar with holidays from different
6829 countries and cultures. The diary allows you to keep track of
6830 anniversaries, lunar phases, sunrise/set, recurrent appointments
6831 (weekly, monthly) and more. In this way, it is quite complementary to
6832 Org. It can be very useful to combine output from Org with
6835 In order to include entries from the Emacs diary into Org-mode's
6836 agenda, you only need to customize the variable
6839 (setq org-agenda-include-diary t)
6842 @noindent After that, everything will happen automatically. All diary
6843 entries including holidays, anniversaries, etc., will be included in the
6844 agenda buffer created by Org-mode. @key{SPC}, @key{TAB}, and
6845 @key{RET} can be used from the agenda buffer to jump to the diary
6846 file in order to edit existing diary entries. The @kbd{i} command to
6847 insert new entries for the current date works in the agenda buffer, as
6848 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
6849 Sunrise/Sunset times, show lunar phases and to convert to other
6850 calendars, respectively. @kbd{c} can be used to switch back and forth
6851 between calendar and agenda.
6853 If you are using the diary only for sexp entries and holidays, it is
6854 faster to not use the above setting, but instead to copy or even move
6855 the entries into an Org file. Org-mode evaluates diary-style sexp
6856 entries, and does it faster because there is no overhead for first
6857 creating the diary display. Note that the sexp entries must start at
6858 the left margin, no whitespace is allowed before them. For example,
6859 the following segment of an Org file will be processed and entries
6860 will be made in the agenda:
6863 * Birthdays and similar stuff
6865 %%(org-calendar-holiday) ; special function for holiday names
6867 %%(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
6868 %%(diary-anniversary 10 2 1869) Mahatma Gandhi would be %d years old
6871 @subsubheading Anniversaries from BBDB
6872 @cindex BBDB, anniversaries
6873 @cindex anniversaries, from BBDB
6875 If you are using the Big Brothers Database to store your contacts, you will
6876 very likely prefer to store anniversaries in BBDB rather than in a
6877 separate Org or diary file. Org supports this and will show BBDB
6878 anniversaries as part of the agenda. All you need to do is to add the
6879 following to one your your agenda files:
6886 %%(org-bbdb-anniversaries)
6889 You can then go ahead and define anniversaries for a BBDB record. Basically,
6890 you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB
6891 record and then add the date in the format @code{YYYY-MM-DD}, followed by a
6892 space and the class of the anniversary (@samp{birthday} or @samp{wedding}, or
6893 a format string). If you omit the class, it will default to @samp{birthday}.
6894 Here are a few examples, the header for the file @file{org-bbdb.el} contains
6895 more detailed information.
6900 2008-04-14 %s released version 6.01 of org-mode, %d years ago
6903 After a change to BBDB, or for the first agenda display during an Emacs
6904 session, the agenda display will suffer a short delay as Org updates its
6905 hash with anniversaries. However, from then on things will be very fast---much
6906 faster in fact than a long list of @samp{%%(diary-anniversary)} entries
6907 in an Org or Diary file.
6909 @subsubheading Appointment reminders
6910 @cindex @file{appt.el}
6911 @cindex appointment reminders
6913 Org can interact with Emacs appointments notification facility. To add all
6914 the appointments of your agenda files, use the command
6915 @code{org-agenda-to-appt}. This command also lets you filter through the
6916 list of your appointments and add only those belonging to a specific category
6917 or matching a regular expression. See the docstring for details.
6919 @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views
6920 @subsection The global TODO list
6921 @cindex global TODO list
6922 @cindex TODO list, global
6924 The global TODO list contains all unfinished TODO items formatted and
6925 collected into a single place.
6930 Show the global TODO list. This collects the TODO items from all agenda
6931 files (@pxref{Agenda Views}) into a single buffer. By default, this lists
6932 items with a state the is not a DONE state. The buffer is in
6933 @code{agenda-mode}, so there are commands to examine and manipulate the TODO
6934 entries directly from that buffer (@pxref{Agenda commands}).
6937 @cindex TODO keyword matching
6938 @vindex org-todo-keywords
6939 Like the above, but allows selection of a specific TODO keyword. You can
6940 also do this by specifying a prefix argument to @kbd{C-c a t}. You are
6941 prompted for a keyword, and you may also specify several keywords by
6942 separating them with @samp{|} as the boolean OR operator. With a numeric
6943 prefix, the nth keyword in @code{org-todo-keywords} is selected.
6945 The @kbd{r} key in the agenda buffer regenerates it, and you can give
6946 a prefix argument to this command to change the selected TODO keyword,
6947 for example @kbd{3 r}. If you often need a search for a specific
6948 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
6949 Matching specific TODO keywords can also be done as part of a tags
6950 search (@pxref{Tag searches}).
6953 Remote editing of TODO items means that you can change the state of a
6954 TODO entry with a single key press. The commands available in the
6955 TODO list are described in @ref{Agenda commands}.
6957 @cindex sublevels, inclusion into TODO list
6958 Normally the global TODO list simply shows all headlines with TODO
6959 keywords. This list can become very long. There are two ways to keep
6963 @vindex org-agenda-todo-ignore-scheduled
6964 @vindex org-agenda-todo-ignore-deadlines
6965 @vindex org-agenda-todo-ignore-with-date
6966 Some people view a TODO item that has been @emph{scheduled} for execution or
6967 have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}.
6968 Configure the variables @code{org-agenda-todo-ignore-scheduled},
6969 @code{org-agenda-todo-ignore-deadlines}, and/or
6970 @code{org-agenda-todo-ignore-with-date} to exclude such items from the
6973 @vindex org-agenda-todo-list-sublevels
6974 TODO items may have sublevels to break up the task into subtasks. In
6975 such cases it may be enough to list only the highest level TODO headline
6976 and omit the sublevels from the global list. Configure the variable
6977 @code{org-agenda-todo-list-sublevels} to get this behavior.
6980 @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views
6981 @subsection Matching tags and properties
6982 @cindex matching, of tags
6983 @cindex matching, of properties
6987 If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}),
6988 or have properties (@pxref{Properties and Columns}), you can select headlines
6989 based on this metadata and collect them into an agenda buffer. The match
6990 syntax described here also applies when creating sparse trees with @kbd{C-c /
6996 Produce a list of all headlines that match a given set of tags. The
6997 command prompts for a selection criterion, which is a boolean logic
6998 expression with tags, like @samp{+work+urgent-withboss} or
6999 @samp{work|home} (@pxref{Tags}). If you often need a specific search,
7000 define a custom command for it (@pxref{Agenda dispatcher}).
7003 @vindex org-tags-match-list-sublevels
7004 @vindex org-agenda-tags-todo-honor-ignore-options
7005 Like @kbd{C-c a m}, but only select headlines that are also TODO items in a
7006 not-DONE state and force checking subitems (see variable
7007 @code{org-tags-match-list-sublevels}). To exclude scheduled/deadline items,
7008 see the variable @code{org-agenda-tags-todo-honor-ignore-options}. Matching
7009 specific TODO keywords together with a tags match is also possible, see
7013 The commands available in the tags list are described in @ref{Agenda
7016 @subsubheading Match syntax
7018 @cindex Boolean logic, for tag/property searches
7019 A search string can use Boolean operators @samp{&} for AND and @samp{|} for
7020 OR. @samp{&} binds more strongly than @samp{|}. Parentheses are currently
7021 not implemented. Each element in the search is either a tag, a regular
7022 expression matching tags, or an expression like @code{PROPERTY OPERATOR
7023 VALUE} with a comparison operator, accessing a property value. Each element
7024 may be preceded by @samp{-}, to select against it, and @samp{+} is syntactic
7025 sugar for positive selection. The AND operator @samp{&} is optional when
7026 @samp{+} or @samp{-} is present. Here are some examples, using only tags.
7030 Select headlines tagged @samp{:work:}, but discard those also tagged
7033 Selects lines tagged @samp{:work:} or @samp{:laptop:}.
7034 @item work|laptop+night
7035 Like before, but require the @samp{:laptop:} lines to be tagged also
7039 @cindex regular expressions, with tags search
7040 Instead of a tag, you may also specify a regular expression enclosed in curly
7041 braces. For example,
7042 @samp{work+@{^boss.*@}} matches headlines that contain the tag
7043 @samp{:work:} and any tag @i{starting} with @samp{boss}.
7045 @cindex TODO keyword matching, with tags search
7046 @cindex level, require for tags/property match
7047 @cindex category, require for tags/property match
7048 @vindex org-odd-levels-only
7049 You may also test for properties (@pxref{Properties and Columns}) at the same
7050 time as matching tags. The properties may be real properties, or special
7051 properties that represent other metadata (@pxref{Special properties}). For
7052 example, the ``property'' @code{TODO} represents the TODO keyword of the
7053 entry. Or, the ``property'' @code{LEVEL} represents the level of an entry.
7054 So a search @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines
7055 that have the tag @samp{boss} and are @emph{not} marked with the TODO keyword
7056 DONE. In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not
7057 count the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc.
7059 Here are more examples:
7061 @item work+TODO="WAITING"
7062 Select @samp{:work:}-tagged TODO lines with the specific TODO
7063 keyword @samp{WAITING}.
7064 @item work+TODO="WAITING"|home+TODO="WAITING"
7065 Waiting tasks both at work and at home.
7068 When matching properties, a number of different operators can be used to test
7069 the value of a property. Here is a complex example:
7072 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 \
7073 +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
7077 The type of comparison will depend on how the comparison value is written:
7080 If the comparison value is a plain number, a numerical comparison is done,
7081 and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
7082 @samp{>=}, and @samp{<>}.
7084 If the comparison value is enclosed in double-quotes,
7085 a string comparison is done, and the same operators are allowed.
7087 If the comparison value is enclosed in double-quotes @emph{and} angular
7088 brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
7089 assumed to be date/time specifications in the standard Org way, and the
7090 comparison will be done accordingly. Special values that will be recognized
7091 are @code{"<now>"} for now (including time), and @code{"<today>"}, and
7092 @code{"<tomorrow>"} for these days at 0:00 hours, i.e. without a time
7093 specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
7094 @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
7095 respectively, can be used.
7097 If the comparison value is enclosed
7098 in curly braces, a regexp match is performed, with @samp{=} meaning that the
7099 regexp matches the property value, and @samp{<>} meaning that it does not
7103 So the search string in the example finds entries tagged @samp{:work:} but
7104 not @samp{:boss:}, which also have a priority value @samp{A}, a
7105 @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
7106 property that is numerically smaller than 2, a @samp{:With:} property that is
7107 matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
7108 on or after October 11, 2008.
7110 Accessing TODO, LEVEL, and CATEGORY during a search is fast. Accessing any
7111 other properties will slow down the search. However, once you have paid the
7112 price by accessing one property, testing additional properties is cheap
7115 You can configure Org-mode to use property inheritance during a search, but
7116 beware that this can slow down searches considerably. See @ref{Property
7117 inheritance}, for details.
7119 For backward compatibility, and also for typing speed, there is also a
7120 different way to test TODO states in a search. For this, terminate the
7121 tags/property part of the search string (which may include several terms
7122 connected with @samp{|}) with a @samp{/} and then specify a Boolean
7123 expression just for TODO keywords. The syntax is then similar to that for
7124 tags, but should be applied with care: for example, a positive selection on
7125 several TODO keywords cannot meaningfully be combined with boolean AND.
7126 However, @emph{negative selection} combined with AND can be meaningful. To
7127 make sure that only lines are checked that actually have any TODO keyword
7128 (resulting in a speed-up), use @kbd{C-c a M}, or equivalently start the TODO
7129 part after the slash with @samp{!}. Using @kbd{C-c a M} or @samp{/!} will
7130 not match TODO keywords in a DONE state. Examples:
7134 Same as @samp{work+TODO="WAITING"}
7135 @item work/!-WAITING-NEXT
7136 Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
7138 @item work/!+WAITING|+NEXT
7139 Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
7143 @node Timeline, Search view, Matching tags and properties, Built-in agenda views
7144 @subsection Timeline for a single file
7145 @cindex timeline, single file
7146 @cindex time-sorted view
7148 The timeline summarizes all time-stamped items from a single Org-mode
7149 file in a @emph{time-sorted view}. The main purpose of this command is
7150 to give an overview over events in a project.
7155 Show a time-sorted view of the Org file, with all time-stamped items.
7156 When called with a @kbd{C-u} prefix, all unfinished TODO entries
7157 (scheduled or not) are also listed under the current date.
7161 The commands available in the timeline buffer are listed in
7162 @ref{Agenda commands}.
7164 @node Search view, Stuck projects, Timeline, Built-in agenda views
7165 @subsection Search view
7168 @cindex searching, for text
7170 This agenda view is a general text search facility for Org-mode entries.
7171 It is particularly useful to find notes.
7176 This is a special search that lets you select entries by matching a substring
7177 or specific words using a boolean logic.
7179 For example, the search string @samp{computer equipment} will find entries
7180 that contain @samp{computer equipment} as a substring. If the two words are
7181 separated by more space or a line break, the search will still match.
7182 Search view can also search for specific keywords in the entry, using Boolean
7183 logic. The search string @samp{+computer +wifi -ethernet -@{8\.11[bg]@}}
7184 will search for note entries that contain the keywords @code{computer}
7185 and @code{wifi}, but not the keyword @code{ethernet}, and which are also
7186 not matched by the regular expression @code{8\.11[bg]}, meaning to
7187 exclude both 8.11b and 8.11g. The first @samp{+} is necessary to turn on
7188 word search, other @samp{+} characters are optional. For more details, see
7189 the docstring of the command @code{org-search-view}.
7191 @vindex org-agenda-text-search-extra-files
7192 Note that in addition to the agenda files, this command will also search
7193 the files listed in @code{org-agenda-text-search-extra-files}.
7195 @node Stuck projects, , Search view, Built-in agenda views
7196 @subsection Stuck projects
7198 If you are following a system like David Allen's GTD to organize your
7199 work, one of the ``duties'' you have is a regular review to make sure
7200 that all projects move along. A @emph{stuck} project is a project that
7201 has no defined next actions, so it will never show up in the TODO lists
7202 Org-mode produces. During the review, you need to identify such
7203 projects and define next actions for them.
7208 List projects that are stuck.
7211 @vindex org-stuck-projects
7212 Customize the variable @code{org-stuck-projects} to define what a stuck
7213 project is and how to find it.
7216 You almost certainly will have to configure this view before it will
7217 work for you. The built-in default assumes that all your projects are
7218 level-2 headlines, and that a project is not stuck if it has at least
7219 one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
7221 Let's assume that you, in your own way of using Org-mode, identify
7222 projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
7223 indicate a project that should not be considered yet. Let's further
7224 assume that the TODO keyword DONE marks finished projects, and that NEXT
7225 and TODO indicate next actions. The tag @@SHOP indicates shopping and
7226 is a next action even without the NEXT tag. Finally, if the project
7227 contains the special word IGNORE anywhere, it should not be listed
7228 either. In this case you would start by identifying eligible projects
7229 with a tags/todo match@footnote{@xref{Tag searches}.}
7230 @samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT, @@SHOP, and
7231 IGNORE in the subtree to identify projects that are not stuck. The
7232 correct customization for this is
7235 (setq org-stuck-projects
7236 '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
7240 Note that if a project is identified as non-stuck, the subtree of this entry
7241 will still be searched for stuck projects.
7243 @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views
7244 @section Presentation and sorting
7245 @cindex presentation, of agenda items
7247 @vindex org-agenda-prefix-format
7248 Before displaying items in an agenda view, Org-mode visually prepares
7249 the items and sorts them. Each item occupies a single line. The line
7250 starts with a @emph{prefix} that contains the @emph{category}
7251 (@pxref{Categories}) of the item and other important information. You can
7252 customize the prefix using the option @code{org-agenda-prefix-format}.
7253 The prefix is followed by a cleaned-up version of the outline headline
7254 associated with the item.
7257 * Categories:: Not all tasks are equal
7258 * Time-of-day specifications:: How the agenda knows the time
7259 * Sorting of agenda items:: The order of things
7262 @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting
7263 @subsection Categories
7266 The category is a broad label assigned to each agenda item. By default,
7267 the category is simply derived from the file name, but you can also
7268 specify it with a special line in the buffer, like this@footnote{For
7269 backward compatibility, the following also works: if there are several
7270 such lines in a file, each specifies the category for the text below it.
7271 The first category also applies to any text before the first CATEGORY
7272 line. However, using this method is @emph{strongly} deprecated as it is
7273 incompatible with the outline structure of the document. The correct
7274 method for setting multiple categories in a buffer is using a
7282 @cindex property, CATEGORY
7283 If you would like to have a special CATEGORY for a single entry or a
7284 (sub)tree, give the entry a @code{:CATEGORY:} property with the
7285 special category you want to apply as the value.
7288 The display in the agenda buffer looks best if the category is not
7289 longer than 10 characters.
7291 @node Time-of-day specifications, Sorting of agenda items, Categories, Presentation and sorting
7292 @subsection Time-of-day specifications
7293 @cindex time-of-day specification
7295 Org-mode checks each agenda item for a time-of-day specification. The
7296 time can be part of the timestamp that triggered inclusion into the
7297 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time
7298 ranges can be specified with two timestamps, like
7300 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
7302 In the headline of the entry itself, a time(range) may also appear as
7303 plain text (like @samp{12:45} or a @samp{8:30-1pm}). If the agenda
7304 integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
7305 specifications in diary entries are recognized as well.
7307 For agenda display, Org-mode extracts the time and displays it in a
7308 standard 24 hour format as part of the prefix. The example times in
7309 the previous paragraphs would end up in the agenda like this:
7312 8:30-13:00 Arthur Dent lies in front of the bulldozer
7313 12:45...... Ford Prefect arrives and takes Arthur to the pub
7314 19:00...... The Vogon reads his poem
7315 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
7319 If the agenda is in single-day mode, or for the display of today, the
7320 timed entries are embedded in a time grid, like
7323 8:00...... ------------------
7324 8:30-13:00 Arthur Dent lies in front of the bulldozer
7325 10:00...... ------------------
7326 12:00...... ------------------
7327 12:45...... Ford Prefect arrives and takes Arthur to the pub
7328 14:00...... ------------------
7329 16:00...... ------------------
7330 18:00...... ------------------
7331 19:00...... The Vogon reads his poem
7332 20:00...... ------------------
7333 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
7336 @vindex org-agenda-use-time-grid
7337 @vindex org-agenda-time-grid
7338 The time grid can be turned on and off with the variable
7339 @code{org-agenda-use-time-grid}, and can be configured with
7340 @code{org-agenda-time-grid}.
7342 @node Sorting of agenda items, , Time-of-day specifications, Presentation and sorting
7343 @subsection Sorting of agenda items
7344 @cindex sorting, of agenda items
7345 @cindex priorities, of agenda items
7346 Before being inserted into a view, the items are sorted. How this is
7347 done depends on the type of view.
7350 @vindex org-agenda-files
7351 For the daily/weekly agenda, the items for each day are sorted. The
7352 default order is to first collect all items containing an explicit
7353 time-of-day specification. These entries will be shown at the beginning
7354 of the list, as a @emph{schedule} for the day. After that, items remain
7355 grouped in categories, in the sequence given by @code{org-agenda-files}.
7356 Within each category, items are sorted by priority (@pxref{Priorities}),
7357 which is composed of the base priority (2000 for priority @samp{A}, 1000
7358 for @samp{B}, and 0 for @samp{C}), plus additional increments for
7359 overdue scheduled or deadline items.
7361 For the TODO list, items remain in the order of categories, but within
7362 each category, sorting takes place according to priority
7363 (@pxref{Priorities}). The priority used for sorting derives from the
7364 priority cookie, with additions depending on how close an item is to its due
7367 For tags matches, items are not sorted at all, but just appear in the
7368 sequence in which they are found in the agenda files.
7371 @vindex org-agenda-sorting-strategy
7372 Sorting can be customized using the variable
7373 @code{org-agenda-sorting-strategy}, and may also include criteria based on
7374 the estimated effort of an entry (@pxref{Effort estimates}).
7376 @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda Views
7377 @section Commands in the agenda buffer
7378 @cindex commands, in agenda buffer
7380 Entries in the agenda buffer are linked back to the Org file or diary
7381 file where they originate. You are not allowed to edit the agenda
7382 buffer itself, but commands are provided to show and jump to the
7383 original entry location, and to edit the Org files ``remotely'' from
7384 the agenda buffer. In this way, all information is stored only once,
7385 removing the risk that your agenda and note files may diverge.
7387 Some commands can be executed with mouse clicks on agenda lines. For
7388 the other commands, the cursor needs to be in the desired line.
7391 @tsubheading{Motion}
7392 @cindex motion commands in agenda
7395 Next line (same as @key{up} and @kbd{C-p}).
7398 Previous line (same as @key{down} and @kbd{C-n}).
7399 @tsubheading{View/Go to Org file}
7404 Display the original location of the item in another window.
7405 With prefix arg, make sure that the entire entry is made visible in the
7406 outline, not only the heading.
7410 Display original location and recenter that window.
7418 Go to the original location of the item in another window. Under Emacs
7419 22, @kbd{mouse-1} will also works for this.
7423 Go to the original location of the item and delete other windows.
7427 @vindex org-agenda-start-with-follow-mode
7428 Toggle Follow mode. In Follow mode, as you move the cursor through
7429 the agenda buffer, the other window always shows the corresponding
7430 location in the Org file. The initial setting for this mode in new
7431 agenda buffers can be set with the variable
7432 @code{org-agenda-start-with-follow-mode}.
7436 Display the entire subtree of the current item in an indirect buffer. With a
7437 numeric prefix argument N, go up to level N and then take that tree. If N is
7438 negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the
7439 previously used indirect buffer.
7443 Follow a link in the entry. This will offer a selection of any links in the
7444 text belonging to the referenced Org node. If there is only one link, it
7445 will be followed without a selection prompt.
7447 @tsubheading{Change display}
7448 @cindex display changing, in agenda
7451 Delete other windows.
7459 @item v d @ @r{or short} @ d
7460 @itemx v w @ @r{or short} @ w
7463 Switch to day/week/month/year view. When switching to day or week view,
7464 this setting becomes the default for subsequent agenda commands. Since
7465 month and year views are slow to create, they do not become the default.
7466 A numeric prefix argument may be used to jump directly to a specific day
7467 of the year, ISO week, month, or year, respectively. For example,
7468 @kbd{32 d} jumps to February 1st, @kbd{9 w} to ISO week number 9. When
7469 setting day, week, or month view, a year may be encoded in the prefix
7470 argument as well. For example, @kbd{200712 w} will jump to week 12 in
7471 2007. If such a year specification has only one or two digits, it will
7472 be mapped to the interval 1938-2037.
7476 @vindex org-agenda-ndays
7477 Go forward in time to display the following @code{org-agenda-ndays} days.
7478 For example, if the display covers a week, switch to the following week.
7479 With prefix arg, go forward that many times @code{org-agenda-ndays} days.
7483 Go backward in time to display earlier dates.
7491 Prompt for a date and go there.
7495 Go to the currently clocked in task in the agenda buffer.
7499 Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}.
7504 @item v l @ @r{or short} @ l
7505 @vindex org-log-done
7506 @vindex org-agenda-log-mode-items
7507 Toggle Logbook mode. In Logbook mode, entries that were marked DONE while
7508 logging was on (variable @code{org-log-done}) are shown in the agenda, as are
7509 entries that have been clocked on that day. You can configure the entry
7510 types that should be included in log mode using the variable
7511 @code{org-agenda-log-mode-items}. When called with a @kbd{C-u} prefix, show
7512 all possible logbook entries, including state changes. When called with two
7513 prefix args @kbd{C-u C-u}, show only logging information, nothing else.
7514 @kbd{v L} is equivalent to @kbd{C-u v l}.
7518 @item v [ @ @r{or short} @ [
7519 Include inactive timestamps into the current view. Only for weekly/daily
7520 agenda and timeline views.
7526 Toggle Archives mode. In Archives mode, trees that are marked
7527 @code{ARCHIVED} are also scanned when producing the agenda. When you use the
7528 capital @kbd{A}, even all archive files are included. To exit archives mode,
7529 press @kbd{v a} again.
7533 @item v R @ @r{or short} @ R
7534 @vindex org-agenda-start-with-clockreport-mode
7535 Toggle Clockreport mode. In Clockreport mode, the daily/weekly agenda will
7536 always show a table with the clocked times for the timespan and file scope
7537 covered by the current agenda view. The initial setting for this mode in new
7538 agenda buffers can be set with the variable
7539 @code{org-agenda-start-with-clockreport-mode}.
7543 @item v E @ @r{or short} @ E
7544 @vindex org-agenda-start-with-entry-text-mode
7545 @vindex org-agenda-entry-text-maxlines
7546 Toggle entry text mode. In entry text mode, a number of lines from the Org
7547 outline node referenced by an agenda line will be displayed below the line.
7548 The maximum number of lines is given by the variable
7549 @code{org-agenda-entry-text-maxlines}. Calling this command with a numeric
7550 prefix argument will temporarily modify that number to the prefix value.
7554 @vindex org-agenda-use-time-grid
7555 @vindex org-agenda-time-grid
7556 Toggle the time grid on and off. See also the variables
7557 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
7561 Recreate the agenda buffer, for example to reflect the changes after
7562 modification of the timestamps of items with @kbd{S-@key{left}} and
7563 @kbd{S-@key{right}}. When the buffer is the global TODO list, a prefix
7564 argument is interpreted to create a selective list for a specific TODO
7574 Save all Org buffers in the current Emacs session, and also the locations of
7579 @vindex org-columns-default-format
7580 Invoke column view (@pxref{Column view}) in the agenda buffer. The column
7581 view format is taken from the entry at point, or (if there is no entry at
7582 point), from the first entry in the agenda view. So whatever the format for
7583 that entry would be in the original buffer (taken from a property, from a
7584 @code{#+COLUMNS} line, or from the default variable
7585 @code{org-columns-default-format}), will be used in the agenda.
7589 Remove the restriction lock on the agenda, if it is currently restricted to a
7590 file or subtree (@pxref{Agenda files}).
7592 @tsubheading{Secondary filtering and query editing}
7593 @cindex filtering, by tag and effort, in agenda
7594 @cindex tag filtering, in agenda
7595 @cindex effort filtering, in agenda
7596 @cindex query editing, in agenda
7600 @vindex org-agenda-filter-preset
7601 Filter the current agenda view with respect to a tag and/or effort estimates.
7602 The difference between this and a custom agenda command is that filtering is
7603 very fast, so that you can switch quickly between different filters without
7604 having to recreate the agenda@footnote{Custom commands can preset a filter by
7605 binding the variable @code{org-agenda-filter-preset} as an option. This
7606 filter will then be applied to the view and persist as a basic filter through
7607 refreshes and more secondary filtering. The filter is a global property of
7608 the entire agenda view - in a block agenda, you should only set this in the
7609 global options section, not in the section of an individual block.}
7611 You will be prompted for a tag selection letter, SPC will mean any tag at
7612 all. Pressing @key{TAB} at that prompt will offer use completion to select a
7613 tag (including any tags that do not have a selection character). The command
7614 then hides all entries that do not contain or inherit this tag. When called
7615 with prefix arg, remove the entries that @emph{do} have the tag. A second
7616 @kbd{/} at the prompt will turn off the filter and unhide any hidden entries.
7617 If the first key you press is either @kbd{+} or @kbd{-}, the previous filter
7618 will be narrowed by requiring or forbidding the selected additional tag.
7619 Instead of pressing @kbd{+} or @kbd{-} after @kbd{/}, you can also
7620 immediately use the @kbd{\} command.
7622 @vindex org-sort-agenda-noeffort-is-high
7623 In order to filter for effort estimates, you should set-up allowed
7624 efforts globally, for example
7626 (setq org-global-properties
7627 '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
7629 You can then filter for an effort by first typing an operator, one of
7630 @kbd{<}, @kbd{>}, and @kbd{=}, and then the one-digit index of an effort
7631 estimate in your array of allowed values, where @kbd{0} means the 10th value.
7632 The filter will then restrict to entries with effort smaller-or-equal, equal,
7633 or larger-or-equal than the selected value. If the digits 0-9 are not used
7634 as fast access keys to tags, you can also simply press the index digit
7635 directly without an operator. In this case, @kbd{<} will be assumed. For
7636 application of the operator, entries without a defined effort will be treated
7637 according to the value of @code{org-sort-agenda-noeffort-is-high}. To filter
7638 for tasks without effort definition, press @kbd{?} as the operator.
7640 Org also supports automatic, context-aware tag filtering. If the variable
7641 @code{org-agenda-auto-exclude-function} is set to a user-defined function,
7642 that function can decide which tags should be excluded from the agenda
7643 automatically. Once this is set, the @kbd{/} command then accepts @kbd{RET}
7644 as a sub-option key and runs the auto exclusion logic. For example, let's
7645 say you use a @code{Net} tag to identify tasks which need network access, an
7646 @code{Errand} tag for errands in town, and a @code{Call} tag for making phone
7647 calls. You could auto-exclude these tags based on the availability of the
7648 Internet, and outside of business hours, with something like this:
7652 (defun org-my-auto-exclude-function (tag)
7654 ((string= tag "Net")
7655 (/= 0 (call-process "/sbin/ping" nil nil nil
7656 "-c1" "-q" "-t1" "mail.gnu.org")))
7657 ((or (string= tag "Errand") (string= tag "Call"))
7658 (let ((hour (nth 2 (decode-time))))
7659 (or (< hour 8) (> hour 21)))))
7662 (setq org-agenda-auto-exclude-function 'org-my-auto-exclude-function)
7668 Narrow the current agenda filter by an additional condition. When called with
7669 prefix arg, remove the entries that @emph{do} have the tag, or that do match
7670 the effort criterion. You can achieve the same effect by pressing @kbd{+} or
7671 @kbd{-} as the first key after the @kbd{/} command.
7679 @item @r{in} search view
7680 add new search words (@kbd{[} and @kbd{]}) or new regular expressions
7681 (@kbd{@{} and @kbd{@}}) to the query string. The opening bracket/brace will
7682 add a positive search term prefixed by @samp{+}, indicating that this search
7683 term @i{must} occur/match in the entry. The closing bracket/brace will add a
7684 negative search term which @i{must not} occur/match in the entry for it to be
7689 @tsubheading{Remote editing}
7690 @cindex remote editing, from agenda
7695 @cindex undoing remote-editing events
7696 @cindex remote editing, undo
7699 Undo a change due to a remote editing command. The change is undone
7700 both in the agenda buffer and in the remote buffer.
7704 Change the TODO state of the item, both in the agenda and in the
7707 @kindex C-S-@key{right}
7708 @kindex C-S-@key{left}
7709 @item C-S-@key{right}@r{/}@key{left}
7710 Switch to the next/previous set of TODO keywords.
7714 @vindex org-agenda-confirm-kill
7715 Delete the current agenda item along with the entire subtree belonging
7716 to it in the original Org file. If the text to be deleted remotely
7717 is longer than one line, the kill needs to be confirmed by the user. See
7718 variable @code{org-agenda-confirm-kill}.
7722 Refile the entry at point.
7726 @item C-c C-x C-a @ @r{or short} @ a
7727 @vindex org-archive-default-command
7728 Archive the subtree corresponding to the entry at point using the default
7729 archiving command set in @code{org-archive-default-command}. When using the
7730 @code{a} key, confirmation will be required.
7734 Toggle the ARCHIVE tag for the current headline.
7738 Move the subtree corresponding to the current entry to its @emph{archive
7743 @item C-c C-x C-s @ @r{or short} @ $
7744 Archive the subtree corresponding to the current headline. This means the
7745 entry will be moved to the configured archive location, most likely a
7750 @vindex org-agenda-show-inherited-tags
7751 Show all tags associated with the current item. This is useful if you have
7752 turned off @code{org-agenda-show-inherited-tags}, but still want to see all
7753 tags of a headline occasionally.
7757 Set tags for the current headline. If there is an active region in the
7758 agenda, change a tag for all headings in the region.
7762 Set the priority for the current item. Org-mode prompts for the
7763 priority character. If you reply with @key{SPC}, the priority cookie
7764 is removed from the entry.
7768 Display weighted priority of current item.
7774 Increase the priority of the current item. The priority is changed in
7775 the original buffer, but the agenda is not resorted. Use the @kbd{r}
7779 @kindex S-@key{down}
7782 Decrease the priority of the current item.
7786 @item z @ @r{or also} @ C-c C-z
7787 @vindex org-log-into-drawer
7788 Add a note to the entry. This note will be recorded, and then files to the
7789 same location where state change notes are put. Depending on
7790 @code{org-log-into-drawer}, this maybe inside a drawer.
7794 Dispatcher for all command related to attachments.
7798 Schedule this item, with prefix arg remove the scheduling timestamp
7802 Set a deadline for this item, with prefix arg remove the deadline.
7806 Agenda actions, to set dates for selected items to the cursor date.
7807 This command also works in the calendar! The command prompts for an
7810 m @r{Mark the entry at point for action. You can also make entries}
7811 @r{in Org files with @kbd{C-c C-x C-k}.}
7812 d @r{Set the deadline of the marked entry to the date at point.}
7813 s @r{Schedule the marked entry at the date at point.}
7814 r @r{Call @code{org-capture} with the cursor date as default date.}
7817 Press @kbd{r} afterward to refresh the agenda and see the effect of the
7820 @kindex S-@key{right}
7822 Change the timestamp associated with the current line by one day into the
7823 future. With a numeric prefix argument, change it by that many days. For
7824 example, @kbd{3 6 5 S-@key{right}} will change it by a year. With a
7825 @kbd{C-u} prefix, change the time by one hour. If you immediately repeat the
7826 command, it will continue to change hours even without the prefix arg. With
7827 a double @kbd{C-u C-u} prefix, do the same for changing minutes. The stamp
7828 is changed in the original Org file, but the change is not directly reflected
7829 in the agenda buffer. Use @kbd{r} or @kbd{g} to update the buffer.
7831 @kindex S-@key{left}
7833 Change the timestamp associated with the current line by one day
7838 Change the timestamp associated with the current line. The key @kbd{>} has
7839 been chosen, because it is the same as @kbd{S-.} on my keyboard.
7843 Start the clock on the current item. If a clock is running already, it
7848 Stop the previously started clock.
7852 Cancel the currently running clock.
7856 Jump to the running clock in another window.
7858 @tsubheading{Bulk remote editing selected entries}
7859 @cindex remote editing, bulk, from agenda
7863 Mark the entry at point for bulk action.
7867 Unmark entry for bulk action.
7871 Unmark all marked entries for bulk action.
7875 Bulk action: act on all marked entries in the agenda. This will prompt for
7876 another key to select the action to be applied. The prefix arg to @kbd{B}
7877 will be passed through to the @kbd{s} and @kbd{d} commands, to bulk-remove
7878 these special timestamps.
7880 r @r{Prompt for a single refile target and move all entries. The entries}
7881 @r{will no longer be in the agenda, refresh (@kbd{g}) to bring them back.}
7882 $ @r{Archive all selected entries.}
7883 A @r{Archive entries by moving them to their respective archive siblings.}
7884 t @r{Change TODO state. This prompts for a single TODO keyword and}
7885 @r{changes the state of all selected entries, bypassing blocking and}
7886 @r{suppressing logging notes (but not time stamps).}
7887 + @r{Add a tag to all selected entries.}
7888 - @r{Remove a tag from all selected entries.}
7889 s @r{Schedule all items to a new date. To shift existing schedule dates}
7890 @r{by a fixed number of days, use something starting with double plus}
7891 @r{at the prompt, for example @samp{++8d} or @samp{++2w}.}
7892 d @r{Set deadline to a specific date.}
7896 @tsubheading{Calendar commands}
7897 @cindex calendar commands, from agenda
7900 Open the Emacs calendar and move to the date at the agenda cursor.
7903 When in the calendar, compute and show the Org-mode agenda for the
7906 @cindex diary entries, creating from agenda
7909 @vindex org-agenda-diary-file
7910 Insert a new entry into the diary, using the date at the cursor and (for
7911 block entries) the date at the mark. This will add to the Emacs diary
7912 file@footnote{This file is parsed for the agenda when
7913 @code{org-agenda-include-diary} is set.}, in a way similar to the @kbd{i}
7914 command in the calendar. The diary file will pop up in another window, where
7915 you can add the entry.
7917 If you configure @code{org-agenda-diary-file} to point to an Org-mode file,
7918 Org will create entries (in org-mode syntax) in that file instead. Most
7919 entries will be stored in a date-based outline tree that will later make it
7920 easy to archive appointments from previous months/years. The tree will be
7921 built under an entry with a @code{DATE_TREE} property, or else with years as
7922 top-level entries. Emacs will prompt you for the entry text - if you specify
7923 it, the entry will be created in @code{org-agenda-diary-file} without further
7924 interaction. If you directly press @key{RET} at the prompt without typing
7925 text, the target file will be shown in another window for you to finish the
7926 entry there. See also the @kbd{k r} command.
7930 Show the phases of the moon for the three months around current date.
7934 Show sunrise and sunset times. The geographical location must be set
7935 with calendar variables, see the documentation for the Emacs calendar.
7939 Convert the date at cursor into many other cultural and historic
7944 Show holidays for three months around the cursor date.
7946 @item M-x org-export-icalendar-combine-agenda-files
7947 Export a single iCalendar file containing entries from all agenda files.
7948 This is a globally available command, and also available in the agenda menu.
7950 @tsubheading{Exporting to a file}
7953 @cindex exporting agenda views
7954 @cindex agenda views, exporting
7955 @vindex org-agenda-exporter-settings
7956 Write the agenda view to a file. Depending on the extension of the selected
7957 file name, the view will be exported as HTML (extension @file{.html} or
7958 @file{.htm}), Postscript (extension @file{.ps}), PDF (extension @file{.pdf}),
7959 and plain text (any other extension). When called with a @kbd{C-u} prefix
7960 argument, immediately open the newly created file. Use the variable
7961 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
7962 for @file{htmlize} to be used during export.
7964 @tsubheading{Quit and Exit}
7967 Quit agenda, remove the agenda buffer.
7970 @cindex agenda files, removing buffers
7972 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
7973 for the compilation of the agenda. Buffers created by the user to
7974 visit Org files will not be removed.
7978 @node Custom agenda views, Exporting Agenda Views, Agenda commands, Agenda Views
7979 @section Custom agenda views
7980 @cindex custom agenda views
7981 @cindex agenda views, custom
7983 Custom agenda commands serve two purposes: to store and quickly access
7984 frequently used TODO and tags searches, and to create special composite
7985 agenda buffers. Custom agenda commands will be accessible through the
7986 dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
7989 * Storing searches:: Type once, use often
7990 * Block agenda:: All the stuff you need in a single buffer
7991 * Setting Options:: Changing the rules
7994 @node Storing searches, Block agenda, Custom agenda views, Custom agenda views
7995 @subsection Storing searches
7997 The first application of custom searches is the definition of keyboard
7998 shortcuts for frequently used searches, either creating an agenda
7999 buffer, or a sparse tree (the latter covering of course only the current
8002 @vindex org-agenda-custom-commands
8003 Custom commands are configured in the variable
8004 @code{org-agenda-custom-commands}. You can customize this variable, for
8005 example by pressing @kbd{C-c a C}. You can also directly set it with
8006 Emacs Lisp in @file{.emacs}. The following example contains all valid
8011 (setq org-agenda-custom-commands
8012 '(("w" todo "WAITING")
8013 ("W" todo-tree "WAITING")
8014 ("u" tags "+boss-urgent")
8015 ("v" tags-todo "+boss-urgent")
8016 ("U" tags-tree "+boss-urgent")
8017 ("f" occur-tree "\\<FIXME\\>")
8018 ("h" . "HOME+Name tags searches") ; description for "h" prefix
8019 ("hl" tags "+home+Lisa")
8020 ("hp" tags "+home+Peter")
8021 ("hk" tags "+home+Kim")))
8026 The initial string in each entry defines the keys you have to press
8027 after the dispatcher command @kbd{C-c a} in order to access the command.
8028 Usually this will be just a single character, but if you have many
8029 similar commands, you can also define two-letter combinations where the
8030 first character is the same in several combinations and serves as a
8031 prefix key@footnote{You can provide a description for a prefix key by
8032 inserting a cons cell with the prefix and the description.}. The second
8033 parameter is the search type, followed by the string or regular
8034 expression to be used for the matching. The example above will
8039 as a global search for TODO entries with @samp{WAITING} as the TODO
8042 as the same search, but only in the current buffer and displaying the
8043 results as a sparse tree
8045 as a global tags search for headlines marked @samp{:boss:} but not
8048 as the same search as @kbd{C-c a u}, but limiting the search to
8049 headlines that are also TODO items
8051 as the same search as @kbd{C-c a u}, but only in the current buffer and
8052 displaying the result as a sparse tree
8054 to create a sparse tree (again: current buffer only) with all entries
8055 containing the word @samp{FIXME}
8057 as a prefix command for a HOME tags search where you have to press an
8058 additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
8059 Peter, or Kim) as additional tag to match.
8062 @node Block agenda, Setting Options, Storing searches, Custom agenda views
8063 @subsection Block agenda
8064 @cindex block agenda
8065 @cindex agenda, with block views
8067 Another possibility is the construction of agenda views that comprise
8068 the results of @emph{several} commands, each of which creates a block in
8069 the agenda buffer. The available commands include @code{agenda} for the
8070 daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
8071 for the global TODO list (as constructed with @kbd{C-c a t}), and the
8072 matching commands discussed above: @code{todo}, @code{tags}, and
8073 @code{tags-todo}. Here are two examples:
8077 (setq org-agenda-custom-commands
8078 '(("h" "Agenda and Home-related tasks"
8082 ("o" "Agenda and Office-related tasks"
8090 This will define @kbd{C-c a h} to create a multi-block view for stuff
8091 you need to attend to at home. The resulting agenda buffer will contain
8092 your agenda for the current week, all TODO items that carry the tag
8093 @samp{home}, and also all lines tagged with @samp{garden}. Finally the
8094 command @kbd{C-c a o} provides a similar view for office tasks.
8096 @node Setting Options, , Block agenda, Custom agenda views
8097 @subsection Setting options for custom commands
8098 @cindex options, for custom agenda views
8100 @vindex org-agenda-custom-commands
8101 Org-mode contains a number of variables regulating agenda construction
8102 and display. The global variables define the behavior for all agenda
8103 commands, including the custom commands. However, if you want to change
8104 some settings just for a single custom view, you can do so. Setting
8105 options requires inserting a list of variable names and values at the
8106 right spot in @code{org-agenda-custom-commands}. For example:
8110 (setq org-agenda-custom-commands
8111 '(("w" todo "WAITING"
8112 ((org-agenda-sorting-strategy '(priority-down))
8113 (org-agenda-prefix-format " Mixed: ")))
8114 ("U" tags-tree "+boss-urgent"
8115 ((org-show-following-heading nil)
8116 (org-show-hierarchy-above nil)))
8118 ((org-agenda-files '("~org/notes.org"))
8119 (org-agenda-text-search-extra-files nil)))))
8124 Now the @kbd{C-c a w} command will sort the collected entries only by
8125 priority, and the prefix format is modified to just say @samp{ Mixed: }
8126 instead of giving the category of the entry. The sparse tags tree of
8127 @kbd{C-c a U} will now turn out ultra-compact, because neither the
8128 headline hierarchy above the match, nor the headline following the match
8129 will be shown. The command @kbd{C-c a N} will do a text search limited
8130 to only a single file.
8132 @vindex org-agenda-custom-commands
8133 For command sets creating a block agenda,
8134 @code{org-agenda-custom-commands} has two separate spots for setting
8135 options. You can add options that should be valid for just a single
8136 command in the set, and options that should be valid for all commands in
8137 the set. The former are just added to the command entry, the latter
8138 must come after the list of command entries. Going back to the block
8139 agenda example (@pxref{Block agenda}), let's change the sorting strategy
8140 for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
8141 the results for GARDEN tags query in the opposite order,
8142 @code{priority-up}. This would look like this:
8146 (setq org-agenda-custom-commands
8147 '(("h" "Agenda and Home-related tasks"
8151 ((org-agenda-sorting-strategy '(priority-up)))))
8152 ((org-agenda-sorting-strategy '(priority-down))))
8153 ("o" "Agenda and Office-related tasks"
8160 As you see, the values and parentheses setting is a little complex.
8161 When in doubt, use the customize interface to set this variable---it
8162 fully supports its structure. Just one caveat: when setting options in
8163 this interface, the @emph{values} are just Lisp expressions. So if the
8164 value is a string, you need to add the double-quotes around the value
8168 @node Exporting Agenda Views, Agenda column view, Custom agenda views, Agenda Views
8169 @section Exporting Agenda Views
8170 @cindex agenda views, exporting
8172 If you are away from your computer, it can be very useful to have a printed
8173 version of some agenda views to carry around. Org-mode can export custom
8174 agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's
8175 @file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the
8176 ghostscript @file{ps2pdf} utility must be installed on the system. Selecting
8177 a PDF file with also create the postscript file.}, and iCalendar files. If
8178 you want to do this only occasionally, use the command
8183 @cindex exporting agenda views
8184 @cindex agenda views, exporting
8185 @vindex org-agenda-exporter-settings
8186 Write the agenda view to a file. Depending on the extension of the selected
8187 file name, the view will be exported as HTML (extension @file{.html} or
8188 @file{.htm}), Postscript (extension @file{.ps}), iCalendar (extension
8189 @file{.ics}), or plain text (any other extension). Use the variable
8190 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
8191 for @file{htmlize} to be used during export, for example
8193 @vindex org-agenda-add-entry-text-maxlines
8194 @vindex htmlize-output-type
8195 @vindex ps-number-of-columns
8196 @vindex ps-landscape-mode
8198 (setq org-agenda-exporter-settings
8199 '((ps-number-of-columns 2)
8200 (ps-landscape-mode t)
8201 (org-agenda-add-entry-text-maxlines 5)
8202 (htmlize-output-type 'css)))
8206 If you need to export certain agenda views frequently, you can associate
8207 any custom agenda command with a list of output file names
8208 @footnote{If you want to store standard views like the weekly agenda
8209 or the global TODO list as well, you need to define custom commands for
8210 them in order to be able to specify file names.}. Here is an example
8211 that first defines custom commands for the agenda and the global
8212 TODO list, together with a number of files to which to export them.
8213 Then we define two block agenda commands and specify file names for them
8214 as well. File names can be relative to the current working directory,
8219 (setq org-agenda-custom-commands
8220 '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
8221 ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
8222 ("h" "Agenda and Home-related tasks"
8227 ("~/views/home.html"))
8228 ("o" "Agenda and Office-related tasks"
8233 ("~/views/office.ps" "~/calendars/office.ics"))))
8237 The extension of the file name determines the type of export. If it is
8238 @file{.html}, Org-mode will use the @file{htmlize.el} package to convert
8239 the buffer to HTML and save it to this file name. If the extension is
8240 @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
8241 Postscript output. If the extension is @file{.ics}, iCalendar export is
8242 run export over all files that were used to construct the agenda, and
8243 limit the export to entries listed in the agenda. Any other
8244 extension produces a plain ASCII file.
8246 The export files are @emph{not} created when you use one of those
8247 commands interactively because this might use too much overhead.
8248 Instead, there is a special command to produce @emph{all} specified
8254 Export all agenda views that have export file names associated with
8258 You can use the options section of the custom agenda commands to also
8259 set options for the export commands. For example:
8262 (setq org-agenda-custom-commands
8264 ((ps-number-of-columns 2)
8265 (ps-landscape-mode t)
8266 (org-agenda-prefix-format " [ ] ")
8267 (org-agenda-with-colors nil)
8268 (org-agenda-remove-tags t))
8273 This command sets two options for the Postscript exporter, to make it
8274 print in two columns in landscape format---the resulting page can be cut
8275 in two and then used in a paper agenda. The remaining settings modify
8276 the agenda prefix to omit category and scheduling information, and
8277 instead include a checkbox to check off items. We also remove the tags
8278 to make the lines compact, and we don't want to use colors for the
8279 black-and-white printer. Settings specified in
8280 @code{org-agenda-exporter-settings} will also apply, but the settings
8281 in @code{org-agenda-custom-commands} take precedence.
8284 From the command line you may also use
8286 emacs -f org-batch-store-agenda-views -kill
8289 or, if you need to modify some parameters@footnote{Quoting depends on the
8290 system you use, please check the FAQ for examples.}
8292 emacs -eval '(org-batch-store-agenda-views \
8293 org-agenda-ndays 30 \
8294 org-agenda-start-day "2007-11-01" \
8295 org-agenda-include-diary nil \
8296 org-agenda-files (quote ("~/org/project.org")))' \
8300 which will create the agenda views restricted to the file
8301 @file{~/org/project.org}, without diary entries and with a 30-day
8304 You can also extract agenda information in a way that allows further
8305 processing by other programs. See @ref{Extracting agenda information}, for
8309 @node Agenda column view, , Exporting Agenda Views, Agenda Views
8310 @section Using column view in the agenda
8311 @cindex column view, in agenda
8312 @cindex agenda, column view
8314 Column view (@pxref{Column view}) is normally used to view and edit
8315 properties embedded in the hierarchical structure of an Org file. It can be
8316 quite useful to use column view also from the agenda, where entries are
8317 collected by certain criteria.
8322 Turn on column view in the agenda.
8325 To understand how to use this properly, it is important to realize that the
8326 entries in the agenda are no longer in their proper outline environment.
8327 This causes the following issues:
8331 @vindex org-columns-default-format
8332 @vindex org-overriding-columns-format
8333 Org needs to make a decision which @code{COLUMNS} format to use. Since the
8334 entries in the agenda are collected from different files, and different files
8335 may have different @code{COLUMNS} formats, this is a non-trivial problem.
8336 Org first checks if the variable @code{org-overriding-columns-format} is
8337 currently set, and if so, takes the format from there. Otherwise it takes
8338 the format associated with the first item in the agenda, or, if that item
8339 does not have a specific format (defined in a property, or in its file), it
8340 uses @code{org-columns-default-format}.
8342 @cindex property, special, CLOCKSUM
8343 If any of the columns has a summary type defined (@pxref{Column attributes}),
8344 turning on column view in the agenda will visit all relevant agenda files and
8345 make sure that the computations of this property are up to date. This is
8346 also true for the special @code{CLOCKSUM} property. Org will then sum the
8347 values displayed in the agenda. In the daily/weekly agenda, the sums will
8348 cover a single day, in all other views they cover the entire block. It is
8349 vital to realize that the agenda may show the same entry @emph{twice} (for
8350 example as scheduled and as a deadline), and it may show two entries from the
8351 same hierarchy (for example a @emph{parent} and its @emph{child}). In these
8352 cases, the summation in the agenda will lead to incorrect results because
8353 some values will count double.
8355 When the column view in the agenda shows the @code{CLOCKSUM}, that is always
8356 the entire clocked time for this item. So even in the daily/weekly agenda,
8357 the clocksum listed in column view may originate from times outside the
8358 current view. This has the advantage that you can compare these values with
8359 a column listing the planned total effort for a task---one of the major
8360 applications for column view in the agenda. If you want information about
8361 clocked time in the displayed period use clock table mode (press @kbd{R} in
8366 @node Markup, Exporting, Agenda Views, Top
8367 @chapter Markup for rich export
8369 When exporting Org-mode documents, the exporter tries to reflect the
8370 structure of the document as accurately as possible in the backend. Since
8371 export targets like HTML, La@TeX{}, or DocBook allow much richer formatting,
8372 Org-mode has rules on how to prepare text for rich export. This section
8373 summarizes the markup rules used in an Org-mode buffer.
8376 * Structural markup elements:: The basic structure as seen by the exporter
8377 * Images and tables:: Tables and Images will be included
8378 * Literal examples:: Source code examples with special formatting
8379 * Include files:: Include additional files into a document
8380 * Index entries:: Making an index
8381 * Macro replacement:: Use macros to create complex output
8382 * Embedded LaTeX:: LaTeX can be freely used inside Org documents
8385 @node Structural markup elements, Images and tables, Markup, Markup
8386 @section Structural markup elements
8389 * Document title:: Where the title is taken from
8390 * Headings and sections:: The document structure as seen by the exporter
8391 * Table of contents:: The if and where of the table of contents
8392 * Initial text:: Text before the first heading?
8394 * Paragraphs:: Paragraphs
8395 * Footnote markup:: Footnotes
8396 * Emphasis and monospace:: Bold, italic, etc.
8397 * Horizontal rules:: Make a line
8398 * Comment lines:: What will *not* be exported
8401 @node Document title, Headings and sections, Structural markup elements, Structural markup elements
8402 @subheading Document title
8403 @cindex document title, markup rules
8406 The title of the exported document is taken from the special line
8410 #+TITLE: This is the title of the document
8414 If this line does not exist, the title is derived from the first non-empty,
8415 non-comment line in the buffer. If no such line exists, or if you have
8416 turned off exporting of the text before the first headline (see below), the
8417 title will be the file name without extension.
8419 @cindex property, EXPORT_TITLE
8420 If you are exporting only a subtree by marking is as the region, the heading
8421 of the subtree will become the title of the document. If the subtree has a
8422 property @code{EXPORT_TITLE}, that will take precedence.
8424 @node Headings and sections, Table of contents, Document title, Structural markup elements
8425 @subheading Headings and sections
8426 @cindex headings and sections, markup rules
8428 @vindex org-export-headline-levels
8429 The outline structure of the document as described in @ref{Document
8430 Structure}, forms the basis for defining sections of the exported document.
8431 However, since the outline structure is also used for (for example) lists of
8432 tasks, only the first three outline levels will be used as headings. Deeper
8433 levels will become itemized lists. You can change the location of this
8434 switch globally by setting the variable @code{org-export-headline-levels}, or on a
8435 per-file basis with a line
8442 @node Table of contents, Initial text, Headings and sections, Structural markup elements
8443 @subheading Table of contents
8444 @cindex table of contents, markup rules
8446 @vindex org-export-with-toc
8447 The table of contents is normally inserted directly before the first headline
8448 of the file. If you would like to get it to a different location, insert the
8449 string @code{[TABLE-OF-CONTENTS]} on a line by itself at the desired
8450 location. The depth of the table of contents is by default the same as the
8451 number of headline levels, but you can choose a smaller number, or turn off
8452 the table of contents entirely, by configuring the variable
8453 @code{org-export-with-toc}, or on a per-file basis with a line like
8456 #+OPTIONS: toc:2 (only to two levels in TOC)
8457 #+OPTIONS: toc:nil (no TOC at all)
8460 @node Initial text, Lists, Table of contents, Structural markup elements
8461 @subheading Text before the first headline
8462 @cindex text before first headline, markup rules
8465 Org-mode normally exports the text before the first headline, and even uses
8466 the first line as the document title. The text will be fully marked up. If
8467 you need to include literal HTML, La@TeX{}, or DocBook code, use the special
8468 constructs described below in the sections for the individual exporters.
8470 @vindex org-export-skip-text-before-1st-heading
8471 Some people like to use the space before the first headline for setup and
8472 internal links and therefore would like to control the exported text before
8473 the first headline in a different way. You can do so by setting the variable
8474 @code{org-export-skip-text-before-1st-heading} to @code{t}. On a per-file
8475 basis, you can get the same effect with @samp{#+OPTIONS: skip:t}.
8478 If you still want to have some text before the first headline, use the
8479 @code{#+TEXT} construct:
8483 #+TEXT: This text will go before the *first* headline.
8484 #+TEXT: [TABLE-OF-CONTENTS]
8485 #+TEXT: This goes between the table of contents and the first headline
8488 @node Lists, Paragraphs, Initial text, Structural markup elements
8490 @cindex lists, markup rules
8492 Plain lists as described in @ref{Plain lists}, are translated to the backend's
8493 syntax for such lists. Most backends support unordered, ordered, and
8496 @node Paragraphs, Footnote markup, Lists, Structural markup elements
8497 @subheading Paragraphs, line breaks, and quoting
8498 @cindex paragraphs, markup rules
8500 Paragraphs are separated by at least one empty line. If you need to enforce
8501 a line break within a paragraph, use @samp{\\} at the end of a line.
8503 To keep the line breaks in a region, but otherwise use normal formatting, you
8504 can use this construct, which can also be used to format poetry.
8506 @cindex #+BEGIN_VERSE
8509 Great clouds overhead
8510 Tiny black birds rise and fall
8517 When quoting a passage from another document, it is customary to format this
8518 as a paragraph that is indented on both the left and the right margin. You
8519 can include quotations in Org-mode documents like this:
8521 @cindex #+BEGIN_QUOTE
8524 Everything should be made as simple as possible,
8525 but not any simpler -- Albert Einstein
8529 If you would like to center some text, do it like this:
8530 @cindex #+BEGIN_CENTER
8533 Everything should be made as simple as possible, \\
8539 @node Footnote markup, Emphasis and monospace, Paragraphs, Structural markup elements
8540 @subheading Footnote markup
8541 @cindex footnotes, markup rules
8542 @cindex @file{footnote.el}
8544 Footnotes defined in the way described in @ref{Footnotes}, will be exported by
8545 all backends. Org allows multiple references to the same note, and
8546 different backends support this to varying degrees.
8548 @node Emphasis and monospace, Horizontal rules, Footnote markup, Structural markup elements
8549 @subheading Emphasis and monospace
8551 @cindex underlined text, markup rules
8552 @cindex bold text, markup rules
8553 @cindex italic text, markup rules
8554 @cindex verbatim text, markup rules
8555 @cindex code text, markup rules
8556 @cindex strike-through text, markup rules
8557 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=}
8558 and @code{~verbatim~}, and, if you must, @samp{+strike-through+}. Text
8559 in the code and verbatim string is not processed for Org-mode specific
8560 syntax, it is exported verbatim.
8562 @node Horizontal rules, Comment lines, Emphasis and monospace, Structural markup elements
8563 @subheading Horizontal rules
8564 @cindex horizontal rules, markup rules
8565 A line consisting of only dashes, and at least 5 of them, will be
8566 exported as a horizontal line (@samp{<hr/>} in HTML).
8568 @node Comment lines, , Horizontal rules, Structural markup elements
8569 @subheading Comment lines
8570 @cindex comment lines
8571 @cindex exporting, not
8572 @cindex #+BEGIN_COMMENT
8574 Lines starting with @samp{#} in column zero are treated as comments and will
8575 never be exported. If you want an indented line to be treated as a comment,
8576 start it with @samp{#+ }. Also entire subtrees starting with the word
8577 @samp{COMMENT} will never be exported. Finally, regions surrounded by
8578 @samp{#+BEGIN_COMMENT} ... @samp{#+END_COMMENT} will not be exported.
8583 Toggle the COMMENT keyword at the beginning of an entry.
8587 @node Images and tables, Literal examples, Structural markup elements, Markup
8588 @section Images and Tables
8590 @cindex tables, markup rules
8593 Both the native Org-mode tables (@pxref{Tables}) and tables formatted with
8594 the @file{table.el} package will be exported properly. For Org-mode tables,
8595 the lines before the first horizontal separator line will become table header
8596 lines. You can use the following lines somewhere before the table to assign
8597 a caption and a label for cross references, and in the text you can refer to
8598 the object with @code{\ref@{tab:basic-data@}}:
8601 #+CAPTION: This is the caption for the next table (or link)
8602 #+LABEL: tbl:basic-data
8607 @cindex inlined images, markup rules
8608 Some backends (HTML, La@TeX{}, and DocBook) allow you to directly include
8609 images into the exported document. Org does this, if a link to an image
8610 files does not have a description part, for example @code{[[./img/a.jpg]]}.
8611 If you wish to define a caption for the image and maybe a label for internal
8612 cross references, make sure that the link is on a line by itself and precede
8613 it with @code{#+CAPTION} and @code{#+LABEL} as follows:
8616 #+CAPTION: This is the caption for the next figure link (or table)
8617 #+LABEL: fig:SED-HR4049
8621 You may also define additional attributes for the figure. As this is
8622 backend-specific, see the sections about the individual backends for more
8626 @node Literal examples, Include files, Images and tables, Markup
8627 @section Literal examples
8628 @cindex literal examples, markup rules
8629 @cindex code line references, markup rules
8631 You can include literal examples that should not be subjected to
8632 markup. Such examples will be typeset in monospace, so this is well suited
8633 for source code and similar examples.
8634 @cindex #+BEGIN_EXAMPLE
8638 Some example from a text file.
8642 Note that such blocks may be @i{indented} in order to align nicely with
8643 indented text and in particular with plain list structure (@pxref{Plain
8644 lists}). For simplicity when using small examples, you can also start the
8645 example lines with a colon followed by a space. There may also be additional
8646 whitespace before the colon:
8650 : Some example from a text file.
8653 @cindex formatting source code, markup rules
8654 If the example is source code from a programming language, or any other text
8655 that can be marked up by font-lock in Emacs, you can ask for the example to
8656 look like the fontified Emacs buffer@footnote{Currently this works for the
8657 HTML backend, and requires the @file{htmlize.el} package version 1.34 or
8658 later. It also works for LaTeX with the listings package, if you turn on the
8659 option @code{org-export-latex-listings} and make sure that the listings
8660 package is included by the LaTeX header.}. This is done with the @samp{src}
8661 block, where you also need to specify the name of the major mode that should
8662 be used to fontify the example:
8666 #+BEGIN_SRC emacs-lisp
8667 (defun org-xor (a b)
8673 Both in @code{example} and in @code{src} snippets, you can add a @code{-n}
8674 switch to the end of the @code{BEGIN} line, to get the lines of the example
8675 numbered. If you use a @code{+n} switch, the numbering from the previous
8676 numbered snippet will be continued in the current one. In literal examples,
8677 Org will interpret strings like @samp{(ref:name)} as labels, and use them as
8678 targets for special hyperlinks like @code{[[(name)]]} (i.e. the reference name
8679 enclosed in single parenthesis). In HTML, hovering the mouse over such a
8680 link will remote-highlight the corresponding code line, which is kind of
8683 You can also add a @code{-r} switch which @i{removes} the labels from the
8684 source code@footnote{Adding @code{-k} to @code{-n -r} will @i{keep} the
8685 labels in the source code while using line numbers for the links, which might
8686 be useful to explain those in an org-mode example code.}. With the @code{-n}
8687 switch, links to these references will be labeled by the line numbers from
8688 the code listing, otherwise links will use the labels with no parentheses.
8692 #+BEGIN_SRC emacs-lisp -n -r
8693 (save-excursion (ref:sc)
8694 (goto-char (point-min)) (ref:jump)
8696 In line [[(sc)]] we remember the current position. [[(jump)][Line (jump)]]
8700 @vindex org-coderef-label-format
8701 If the syntax for the label format conflicts with the language syntax, use a
8702 @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
8703 -n -r -l "((%s))"}. See also the variable @code{org-coderef-label-format}.
8705 HTML export also allows examples to be published as text areas, @xref{Text
8706 areas in HTML export}.
8711 Edit the source code example at point in its native mode. This works by
8712 switching to a temporary buffer with the source code. You need to exit by
8713 pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*}
8714 or @samp{#} will get a comma prepended, to keep them from being interpreted
8715 by Org as outline nodes or special comments. These commas will be stripped
8716 for editing with @kbd{C-c '}, and also for export.}, the edited version will
8717 then replace the old version in the Org buffer. Fixed-width regions
8718 (where each line starts with a colon followed by a space) will be edited
8719 using @code{artist-mode}@footnote{You may select a different-mode with the
8720 variable @code{org-edit-fixed-width-region-mode}.} to allow creating ASCII
8721 drawings easily. Using this command in an empty line will create a new
8725 Calling @code{org-store-link} while editing a source code example in a
8726 temporary buffer created with @kbd{C-c '} will prompt for a label, make sure
8727 that it is unique in the current buffer, and insert it with the proper
8728 formatting like @samp{(ref:label)} at the end of the current line. Then the
8729 label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
8733 @node Include files, Index entries, Literal examples, Markup
8734 @section Include files
8735 @cindex include files, markup rules
8737 During export, you can include the content of another file. For example, to
8738 include your @file{.emacs} file, you could use:
8742 #+INCLUDE: "~/.emacs" src emacs-lisp
8745 The optional second and third parameter are the markup (e.g. @samp{quote},
8746 @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the
8747 language for formatting the contents. The markup is optional, if it is not
8748 given, the text will be assumed to be in Org-mode format and will be
8749 processed normally. The include line will also allow additional keyword
8750 parameters @code{:prefix1} and @code{:prefix} to specify prefixes for the
8751 first line and for each following line, as well as any options accepted by
8752 the selected markup. For example, to include a file as an item, use
8755 #+INCLUDE: "~/snippets/xx" :prefix1 " + " :prefix " "
8761 Visit the include file at point.
8764 @node Index entries, Macro replacement, Include files, Markup
8765 @section Index entries
8766 @cindex index entries, for publishing
8768 You can specify entries that will be used for generating an index during
8769 publishing. This is done by lines starting with @code{#+INDEX}. An entry
8770 the contains an exclamation mark will create a sub item. See @ref{Generating
8771 an index} for more information.
8776 #+INDEX: Application!CV
8782 @node Macro replacement, Embedded LaTeX, Index entries, Markup
8783 @section Macro replacement
8784 @cindex macro replacement, during export
8787 You can define text snippets with
8790 #+MACRO: name replacement text $1, $2 are arguments
8793 @noindent which can be referenced anywhere in the document (even in
8794 code examples) with @code{@{@{@{name(arg1,arg2)@}@}@}}. In addition to
8795 defined macros, @code{@{@{@{title@}@}@}}, @code{@{@{@{author@}@}@}}, etc.,
8796 will reference information set by the @code{#+TITLE:}, @code{#+AUTHOR:}, and
8797 similar lines. Also, @code{@{@{@{date(@var{FORMAT})@}@}@}} and
8798 @code{@{@{@{modification-time(@var{FORMAT})@}@}@}} refer to current date time
8799 and to the modification time of the file being exported, respectively.
8800 @var{FORMAT} should be a format string understood by
8801 @code{format-time-string}.
8803 Macro expansion takes place during export, and some people use it to
8804 construct complex HTML code.
8807 @node Embedded LaTeX, , Macro replacement, Markup
8808 @section Embedded La@TeX{}
8809 @cindex @TeX{} interpretation
8810 @cindex La@TeX{} interpretation
8812 Plain ASCII is normally sufficient for almost all note taking. One
8813 exception, however, are scientific notes which need to be able to contain
8814 mathematical symbols and the occasional formula. La@TeX{}@footnote{La@TeX{}
8815 is a macro system based on Donald E. Knuth's @TeX{} system. Many of the
8816 features described here as ``La@TeX{}'' are really from @TeX{}, but for
8817 simplicity I am blurring this distinction.} is widely used to typeset
8818 scientific documents. Org-mode supports embedding La@TeX{} code into its
8819 files, because many academics are used to writing and reading La@TeX{} source
8820 code, and because it can be readily processed to produce pretty output for a
8821 number of export backends.
8824 * Special symbols:: Greek letters and other symbols
8825 * Subscripts and superscripts:: Simple syntax for raising/lowering text
8826 * LaTeX fragments:: Complex formulas made easy
8827 * Previewing LaTeX fragments:: What will this snippet look like?
8828 * CDLaTeX mode:: Speed up entering of formulas
8831 @node Special symbols, Subscripts and superscripts, Embedded LaTeX, Embedded LaTeX
8832 @subsection Special symbols
8833 @cindex math symbols
8834 @cindex special symbols
8835 @cindex @TeX{} macros
8836 @cindex La@TeX{} fragments, markup rules
8837 @cindex HTML entities
8838 @cindex La@TeX{} entities
8840 You can use La@TeX{} macros to insert special symbols like @samp{\alpha} to
8841 indicate the Greek letter, or @samp{\to} to indicate an arrow. Completion
8842 for these macros is available, just type @samp{\} and maybe a few letters,
8843 and press @kbd{M-@key{TAB}} to see possible completions. Unlike La@TeX{}
8844 code, Org-mode allows these macros to be present without surrounding math
8845 delimiters, for example:
8848 Angles are written as Greek letters \alpha, \beta and \gamma.
8851 @vindex org-entities
8852 During export, these symbols will be transformed into the native format of
8853 the exporter backend. Strings like @code{\alpha} will be exported as
8854 @code{α} in the HTML output, and as @code{$\alpha$} in the La@TeX{}
8855 output. Similarly, @code{\nbsp} will become @code{ } in HTML and
8856 @code{~} in La@TeX{}. If you need such a symbol inside a word, terminate it
8857 like this: @samp{\Aacute@{@}stor}.
8859 A large number of entities is provided, with names taken from both HTML and
8860 La@TeX{}, see the variable @code{org-entities} for the complete list.
8861 @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
8862 @samp{...} are all converted into special commands creating hyphens of
8863 different lengths or a compact set of dots.
8865 If you would like to see entities displayed as UTF8 characters, use the
8866 following command@footnote{You can turn this on by default by setting the
8867 variable @code{org-pretty-entities}, or on a per-file base with the
8868 @code{#+STARTUP} option @code{entitiespretty}.}:
8873 Toggle display of entities as UTF8 characters. This does not change the
8874 buffer content which remains plain ASCII, but it overlays the UTF8 character
8875 for display purposes only.
8878 @node Subscripts and superscripts, LaTeX fragments, Special symbols, Embedded LaTeX
8879 @subsection Subscripts and superscripts
8883 Just like in La@TeX{}, @samp{^} and @samp{_} are used to indicate super-
8884 and subscripts. Again, these can be used without embedding them in
8885 math-mode delimiters. To increase the readability of ASCII text, it is
8886 not necessary (but OK) to surround multi-character sub- and superscripts
8887 with curly braces. For example
8890 The mass if the sun is M_sun = 1.989 x 10^30 kg. The radius of
8891 the sun is R_@{sun@} = 6.96 x 10^8 m.
8894 @vindex org-export-with-sub-superscripts
8895 To avoid interpretation as raised or lowered text, you can quote @samp{^} and
8896 @samp{_} with a backslash: @samp{\^} and @samp{\_}. If you write a text
8897 where the underscore is often used in a different context, Org's convention
8898 to always interpret these as subscripts can get in your way. Configure the
8899 variable @code{org-export-with-sub-superscripts} to globally change this
8900 convention, or use, on a per-file basis:
8906 @noindent With this setting, @samp{a_b} will not be interpreted as a
8907 subscript, but @samp{a_@{b@}} will.
8912 In addition to showing entities as UTF8 characters, this command will also
8913 format sub- and superscripts in a WYSIWYM way.
8916 @node LaTeX fragments, Previewing LaTeX fragments, Subscripts and superscripts, Embedded LaTeX
8917 @subsection La@TeX{} fragments
8918 @cindex La@TeX{} fragments
8920 @vindex org-format-latex-header
8921 Going beyond symbols and sub- and superscripts, a full formula language is
8922 needed. Org-mode can contain La@TeX{} math fragments, and it supports ways
8923 to process these for several export backends. When exporting to La@TeX{},
8924 the code is obviously left as it is. When exporting to HTML, Org invokes the
8925 @uref{http://www.mathjax.org, MathJax library} (@pxref{Math formatting in
8926 HTML export}) to process and display the math@footnote{If you plan to use
8927 this regularly or on pages with significant page views, you should install
8928 @file{MathJax} on your own server in order to limit the load of our server.}.
8929 Finally, it can also process the mathematical expressions into
8930 images@footnote{For this to work you need to be on a system with a working
8931 La@TeX{} installation. You also need the @file{dvipng} program, available at
8932 @url{http://sourceforge.net/projects/dvipng/}. The La@TeX{} header that will
8933 be used when processing a fragment can be configured with the variable
8934 @code{org-format-latex-header}.} that can be displayed in a browser or in
8937 La@TeX{} fragments don't need any special marking at all. The following
8938 snippets will be identified as La@TeX{} source code:
8941 Environments of any kind@footnote{When @file{MathJax} is used, only the
8942 environment recognized by @file{MathJax} will be processed. When dvipng is
8943 used to create images, any La@TeX{} environments will be handled.}. The only
8944 requirement is that the @code{\begin} statement appears on a new line,
8945 preceded by only whitespace.
8947 Text within the usual La@TeX{} math delimiters. To avoid conflicts with
8948 currency specifications, single @samp{$} characters are only recognized as
8949 math delimiters if the enclosed text contains at most two line breaks, is
8950 directly attached to the @samp{$} characters with no whitespace in between,
8951 and if the closing @samp{$} is followed by whitespace, punctuation or a dash.
8952 For the other delimiters, there is no such restriction, so when in doubt, use
8953 @samp{\(...\)} as inline math delimiters.
8956 @noindent For example:
8959 \begin@{equation@} % arbitrary environments,
8960 x=\sqrt@{b@} % even tables, figures
8961 \end@{equation@} % etc
8963 If $a^2=b$ and \( b=2 \), then the solution must be
8964 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
8968 @vindex org-format-latex-options
8969 If you need any of the delimiter ASCII sequences for other purposes, you
8970 can configure the option @code{org-format-latex-options} to deselect the
8971 ones you do not wish to have interpreted by the La@TeX{} converter.
8973 @vindex org-export-with-LaTeX-fragments
8974 LaTeX processing can be configured with the variable
8975 @code{org-export-with-LaTeX-fragments}. The default setting is @code{t}
8976 which means @file{MathJax} for HTML, and no processing for DocBook, ASCII and
8977 LaTeX backends. You can also set this variable on a per-file basis using one
8981 #+OPTIONS: LaTeX:t @r{Do the right thing automatically (MathJax)}
8982 #+OPTIONS: LaTeX:dvipng @r{Force using dvipng images}
8983 #+OPTIONS: LaTeX:nil @r{Do not process La@TeX{} fragments at all}
8984 #+OPTIONS: LaTeX:verbatim @r{Verbatim export, for jsMath or so}
8987 @node Previewing LaTeX fragments, CDLaTeX mode, LaTeX fragments, Embedded LaTeX
8988 @subsection Previewing LaTeX fragments
8989 @cindex LaTeX fragments, preview
8991 If you have @file{dvipng} installed, La@TeX{} fragments can be processed to
8992 produce preview images of the typeset expressions:
8997 Produce a preview image of the La@TeX{} fragment at point and overlay it
8998 over the source code. If there is no fragment at point, process all
8999 fragments in the current entry (between two headlines). When called
9000 with a prefix argument, process the entire subtree. When called with
9001 two prefix arguments, or when the cursor is before the first headline,
9002 process the entire buffer.
9005 Remove the overlay preview images.
9008 @vindex org-format-latex-options
9009 You can customize the variable @code{org-format-latex-options} to influence
9010 some aspects of the preview. In particular, the @code{:scale} (and for HTML
9011 export, @code{:html-scale}) property can be used to adjust the size of the
9014 @node CDLaTeX mode, , Previewing LaTeX fragments, Embedded LaTeX
9015 @subsection Using CDLa@TeX{} to enter math
9018 CDLa@TeX{} mode is a minor mode that is normally used in combination with a
9019 major La@TeX{} mode like AUC@TeX{} in order to speed-up insertion of
9020 environments and math templates. Inside Org-mode, you can make use of
9021 some of the features of CDLa@TeX{} mode. You need to install
9022 @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
9023 AUC@TeX{}) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
9024 Don't use CDLa@TeX{} mode itself under Org-mode, but use the light
9025 version @code{org-cdlatex-mode} that comes as part of Org-mode. Turn it
9026 on for the current buffer with @code{M-x org-cdlatex-mode}, or for all
9030 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
9033 When this mode is enabled, the following features are present (for more
9034 details see the documentation of CDLa@TeX{} mode):
9038 Environment templates can be inserted with @kbd{C-c @{}.
9041 The @key{TAB} key will do template expansion if the cursor is inside a
9042 La@TeX{} fragment@footnote{Org-mode has a method to test if the cursor is
9043 inside such a fragment, see the documentation of the function
9044 @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will
9045 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
9046 correctly inside the first brace. Another @key{TAB} will get you into
9047 the second brace. Even outside fragments, @key{TAB} will expand
9048 environment abbreviations at the beginning of a line. For example, if
9049 you write @samp{equ} at the beginning of a line and press @key{TAB},
9050 this abbreviation will be expanded to an @code{equation} environment.
9051 To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}.
9055 @vindex cdlatex-simplify-sub-super-scripts
9056 Pressing @kbd{_} and @kbd{^} inside a La@TeX{} fragment will insert these
9057 characters together with a pair of braces. If you use @key{TAB} to move
9058 out of the braces, and if the braces surround only a single character or
9059 macro, they are removed again (depending on the variable
9060 @code{cdlatex-simplify-sub-super-scripts}).
9063 Pressing the backquote @kbd{`} followed by a character inserts math
9064 macros, also outside La@TeX{} fragments. If you wait more than 1.5 seconds
9065 after the backquote, a help window will pop up.
9068 Pressing the single-quote @kbd{'} followed by another character modifies
9069 the symbol before point with an accent or a font. If you wait more than
9070 1.5 seconds after the backquote, a help window will pop up. Character
9071 modification will work only inside La@TeX{} fragments, outside the quote
9075 @node Exporting, Publishing, Markup, Top
9079 Org-mode documents can be exported into a variety of other formats. For
9080 printing and sharing of notes, ASCII export produces a readable and simple
9081 version of an Org file. HTML export allows you to publish a notes file on
9082 the web, while the XOXO format provides a solid base for exchange with a
9083 broad range of other applications. La@TeX{} export lets you use Org-mode and
9084 its structured editing functions to easily create La@TeX{} files. DocBook
9085 export makes it possible to convert Org files to many other formats using
9086 DocBook tools. For project management you can create gantt and resource
9087 charts by using TaskJuggler export. To incorporate entries with associated
9088 times like deadlines or appointments into a desktop calendar program like
9089 iCal, Org-mode can also produce extracts in the iCalendar format. Currently
9090 Org-mode only supports export, not import of these different formats.
9092 Org supports export of selected regions when @code{transient-mark-mode} is
9093 enabled (default in Emacs 23).
9096 * Selective export:: Using tags to select and exclude trees
9097 * Export options:: Per-file export settings
9098 * The export dispatcher:: How to access exporter commands
9099 * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
9100 * HTML export:: Exporting to HTML
9101 * LaTeX and PDF export:: Exporting to La@TeX{}, and processing to PDF
9102 * DocBook export:: Exporting to DocBook
9103 * TaskJuggler export:: Exporting to TaskJuggler
9104 * Freemind export:: Exporting to Freemind mind maps
9105 * XOXO export:: Exporting to XOXO
9106 * iCalendar export:: Exporting in iCalendar format
9109 @node Selective export, Export options, Exporting, Exporting
9110 @section Selective export
9111 @cindex export, selective by tags
9113 @vindex org-export-select-tags
9114 @vindex org-export-exclude-tags
9115 You may use tags to select the parts of a document that should be exported,
9116 or to exclude parts from export. This behavior is governed by two variables:
9117 @code{org-export-select-tags} and @code{org-export-exclude-tags}.
9119 Org first checks if any of the @emph{select} tags is present in the buffer.
9120 If yes, all trees that do not carry one of these tags will be excluded. If a
9121 selected tree is a subtree, the heading hierarchy above it will also be
9122 selected for export, but not the text below those headings.
9125 If none of the select tags is found, the whole buffer will be selected for
9129 Finally, all subtrees that are marked by any of the @emph{exclude} tags will
9130 be removed from the export buffer.
9132 @node Export options, The export dispatcher, Selective export, Exporting
9133 @section Export options
9134 @cindex options, for export
9136 @cindex completion, of option keywords
9137 The exporter recognizes special lines in the buffer which provide
9138 additional information. These lines may be put anywhere in the file.
9139 The whole set of lines can be inserted into the buffer with @kbd{C-c
9140 C-e t}. For individual lines, a good way to make sure the keyword is
9141 correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion
9142 (@pxref{Completion}). For a summary of other in-buffer settings not
9143 specifically related to export, see @ref{In-buffer settings}.
9144 In particular, note that you can place commonly-used (export) options in
9145 a separate file which can be included using @code{#+SETUPFILE}.
9150 Insert template with export options, see example below.
9157 @cindex #+DESCRIPTION
9165 @cindex #+EXPORT_SELECT_TAGS
9166 @cindex #+EXPORT_EXCLUDE_TAGS
9168 @cindex #+LATEX_HEADER
9169 @vindex user-full-name
9170 @vindex user-mail-address
9171 @vindex org-export-default-language
9173 #+TITLE: the title to be shown (default is the buffer name)
9174 #+AUTHOR: the author (default taken from @code{user-full-name})
9175 #+DATE: a date, fixed, of a format string for @code{format-time-string}
9176 #+EMAIL: his/her email address (default from @code{user-mail-address})
9177 #+DESCRIPTION: the page description, e.g. for the XHTML meta tag
9178 #+KEYWORDS: the page keywords, e.g. for the XHTML meta tag
9179 #+LANGUAGE: language for HTML, e.g. @samp{en} (@code{org-export-default-language})
9180 #+TEXT: Some descriptive text to be inserted at the beginning.
9181 #+TEXT: Several lines may be given.
9182 #+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ...
9183 #+BIND: lisp-var lisp-val, e.g.: org-export-latex-low-levels itemize
9184 @r{You need to confirm using these, or configure @code{org-export-allow-BIND}}
9185 #+LINK_UP: the ``up'' link of an exported page
9186 #+LINK_HOME: the ``home'' link of an exported page
9187 #+LATEX_HEADER: extra line(s) for the LaTeX header, like \usepackage@{xyz@}
9188 #+EXPORT_SELECT_TAGS: Tags that select a tree for export
9189 #+EXPORT_EXCLUDE_TAGS: Tags that exclude a tree from export
9190 #+XSLT: the XSLT stylesheet used by DocBook exporter to generate FO file
9194 The OPTIONS line is a compact@footnote{If you want to configure many options
9195 this way, you can use several OPTIONS lines.} form to specify export settings. Here
9197 @cindex headline levels
9198 @cindex section-numbers
9199 @cindex table of contents
9200 @cindex line-break preservation
9201 @cindex quoted HTML tags
9202 @cindex fixed-width sections
9204 @cindex @TeX{}-like syntax for sub- and superscripts
9206 @cindex special strings
9207 @cindex emphasized text
9208 @cindex @TeX{} macros
9209 @cindex La@TeX{} fragments
9210 @cindex author info, in export
9211 @cindex time info, in export
9213 H: @r{set the number of headline levels for export}
9214 num: @r{turn on/off section-numbers}
9215 toc: @r{turn on/off table of contents, or set level limit (integer)}
9216 \n: @r{turn on/off line-break-preservation (DOES NOT WORK)}
9217 @@: @r{turn on/off quoted HTML tags}
9218 :: @r{turn on/off fixed-width sections}
9219 |: @r{turn on/off tables}
9220 ^: @r{turn on/off @TeX{}-like syntax for sub- and superscripts. If}
9221 @r{you write "^:@{@}", @code{a_@{b@}} will be interpreted, but}
9222 @r{the simple @code{a_b} will be left as it is.}
9223 -: @r{turn on/off conversion of special strings.}
9224 f: @r{turn on/off footnotes like this[1].}
9225 todo: @r{turn on/off inclusion of TODO keywords into exported text}
9226 pri: @r{turn on/off priority cookies}
9227 tags: @r{turn on/off inclusion of tags, may also be @code{not-in-toc}}
9228 <: @r{turn on/off inclusion of any time/date stamps like DEADLINES}
9229 *: @r{turn on/off emphasized text (bold, italic, underlined)}
9230 TeX: @r{turn on/off simple @TeX{} macros in plain text}
9231 LaTeX: @r{configure export of La@TeX{} fragments. Default @code{auto}}
9232 skip: @r{turn on/off skipping the text before the first heading}
9233 author: @r{turn on/off inclusion of author name/email into exported file}
9234 email: @r{turn on/off inclusion of author email into exported file}
9235 creator: @r{turn on/off inclusion of creator info into exported file}
9236 timestamp: @r{turn on/off inclusion creation time into exported file}
9237 d: @r{turn on/off inclusion of drawers}
9240 These options take effect in both the HTML and La@TeX{} export, except
9241 for @code{TeX} and @code{LaTeX}, which are respectively @code{t} and
9242 @code{nil} for the La@TeX{} export.
9244 When exporting only a single subtree by selecting it with @kbd{C-c @@} before
9245 calling an export command, the subtree can overrule some of the file's export
9246 settings with properties @code{EXPORT_FILE_NAME}, @code{EXPORT_TITLE},
9247 @code{EXPORT_TEXT}, @code{EXPORT_AUTHOR}, @code{EXPORT_DATE}, and
9248 @code{EXPORT_OPTIONS}.
9250 @node The export dispatcher, ASCII/Latin-1/UTF-8 export, Export options, Exporting
9251 @section The export dispatcher
9252 @cindex dispatcher, for export commands
9254 All export commands can be reached using the export dispatcher, which is a
9255 prefix key that prompts for an additional key specifying the command.
9256 Normally the entire file is exported, but if there is an active region that
9257 contains one outline tree, the first heading is used as document title and
9258 the subtrees are exported.
9263 @vindex org-export-run-in-background
9264 Dispatcher for export and publishing commands. Displays a help-window
9265 listing the additional key(s) needed to launch an export or publishing
9266 command. The prefix arg is passed through to the exporter. A double prefix
9267 @kbd{C-u C-u} causes most commands to be executed in the background, in a
9268 separate Emacs process@footnote{To make this behavior the default, customize
9269 the variable @code{org-export-run-in-background}.}.
9272 Like @kbd{C-c C-e}, but only export the text that is currently visible
9273 (i.e. not hidden by outline visibility).
9274 @kindex C-u C-u C-c C-e
9275 @item C-u C-u C-c C-e
9276 @vindex org-export-run-in-background
9277 Call an the exporter, but reverse the setting of
9278 @code{org-export-run-in-background}, i.e. request background processing if
9279 not set, or force processing in the current Emacs process if set.
9282 @node ASCII/Latin-1/UTF-8 export, HTML export, The export dispatcher, Exporting
9283 @section ASCII/Latin-1/UTF-8 export
9284 @cindex ASCII export
9285 @cindex Latin-1 export
9286 @cindex UTF-8 export
9288 ASCII export produces a simple and very readable version of an Org-mode
9289 file, containing only plain ASCII. Latin-1 and UTF-8 export augment the file
9290 with special characters and symbols available in these encodings.
9292 @cindex region, active
9293 @cindex active region
9294 @cindex transient-mark-mode
9298 @cindex property, EXPORT_FILE_NAME
9299 Export as ASCII file. For an Org file, @file{myfile.org}, the ASCII file
9300 will be @file{myfile.txt}. The file will be overwritten without
9301 warning. If there is an active region@footnote{This requires
9302 @code{transient-mark-mode} be turned on.}, only the region will be
9303 exported. If the selected region is a single tree@footnote{To select the
9304 current subtree, use @kbd{C-c @@}.}, the tree head will
9305 become the document title. If the tree head entry has or inherits an
9306 @code{EXPORT_FILE_NAME} property, that name will be used for the
9310 Export to a temporary buffer, do not create a file.
9313 @item C-c C-e n @ @ @r{and} @ @ C-c C-e N
9314 Like the above commands, but use Latin-1 encoding.
9317 @item C-c C-e u @ @ @r{and} @ @ C-c C-e U
9318 Like the above commands, but use UTF-8 encoding.
9322 @item C-c C-e v a @ @ @r{and} @ @ C-c C-e v n @ @ @r{and} @ @ C-c C-e v u
9323 Export only the visible part of the document.
9326 @cindex headline levels, for exporting
9327 In the exported version, the first 3 outline levels will become
9328 headlines, defining a general document structure. Additional levels
9329 will be exported as itemized lists. If you want that transition to occur
9330 at a different level, specify it with a prefix argument. For example,
9337 creates only top level headlines and does the rest as items. When
9338 headlines are converted to items, the indentation of the text following
9339 the headline is changed to fit nicely under the item. This is done with
9340 the assumption that the first body line indicates the base indentation of
9341 the body text. Any indentation larger than this is adjusted to preserve
9342 the layout relative to the first line. Should there be lines with less
9343 indentation than the first, these are left alone.
9345 @vindex org-export-ascii-links-to-notes
9346 Links will be exported in a footnote-like style, with the descriptive part in
9347 the text and the link in a note before the next heading. See the variable
9348 @code{org-export-ascii-links-to-notes} for details and other options.
9350 @node HTML export, LaTeX and PDF export, ASCII/Latin-1/UTF-8 export, Exporting
9351 @section HTML export
9354 Org-mode contains an HTML (XHTML 1.0 strict) exporter with extensive
9355 HTML formatting, in ways similar to John Gruber's @emph{markdown}
9356 language, but with additional support for tables.
9359 * HTML Export commands:: How to invoke HTML export
9360 * Quoting HTML tags:: Using direct HTML in Org-mode
9361 * Links in HTML export:: How links will be interpreted and formatted
9362 * Tables in HTML export:: How to modify the formatting of tables
9363 * Images in HTML export:: How to insert figures into HTML output
9364 * Math formatting in HTML export:: Beautiful math also on the web
9365 * Text areas in HTML export:: An alternative way to show an example
9366 * CSS support:: Changing the appearance of the output
9367 * JavaScript support:: Info and Folding in a web browser
9370 @node HTML Export commands, Quoting HTML tags, HTML export, HTML export
9371 @subsection HTML export commands
9373 @cindex region, active
9374 @cindex active region
9375 @cindex transient-mark-mode
9379 @cindex property, EXPORT_FILE_NAME
9380 Export as HTML file @file{myfile.html}. For an Org file @file{myfile.org},
9381 the ASCII file will be @file{myfile.html}. The file will be overwritten
9382 without warning. If there is an active region@footnote{This requires
9383 @code{transient-mark-mode} be turned on.}, only the region will be
9384 exported. If the selected region is a single tree@footnote{To select the
9385 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
9386 title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
9387 property, that name will be used for the export.
9390 Export as HTML file and immediately open it with a browser.
9393 Export to a temporary buffer, do not create a file.
9396 Export the active region to a temporary buffer. With a prefix argument, do
9397 not produce the file header and footer, but just the plain HTML section for
9398 the region. This is good for cut-and-paste operations.
9407 Export only the visible part of the document.
9408 @item M-x org-export-region-as-html
9409 Convert the region to HTML under the assumption that it was Org-mode
9410 syntax before. This is a global command that can be invoked in any
9412 @item M-x org-replace-region-by-HTML
9413 Replace the active region (assumed to be in Org-mode syntax) by HTML
9417 @cindex headline levels, for exporting
9418 In the exported version, the first 3 outline levels will become headlines,
9419 defining a general document structure. Additional levels will be exported as
9420 itemized lists. If you want that transition to occur at a different level,
9421 specify it with a numeric prefix argument. For example,
9428 creates two levels of headings and does the rest as items.
9430 @node Quoting HTML tags, Links in HTML export, HTML Export commands, HTML export
9431 @subsection Quoting HTML tags
9433 Plain @samp{<} and @samp{>} are always transformed to @samp{<} and
9434 @samp{>} in HTML export. If you want to include simple HTML tags
9435 which should be interpreted as such, mark them with @samp{@@} as in
9436 @samp{@@<b>bold text@@</b>}. Note that this really works only for
9437 simple tags. For more extensive HTML that should be copied verbatim to
9438 the exported file use either
9441 @cindex #+BEGIN_HTML
9443 #+HTML: Literal HTML code for export
9447 @cindex #+BEGIN_HTML
9451 All lines between these markers are exported literally
9456 @node Links in HTML export, Tables in HTML export, Quoting HTML tags, HTML export
9457 @subsection Links in HTML export
9459 @cindex links, in HTML export
9460 @cindex internal links, in HTML export
9461 @cindex external links, in HTML export
9462 Internal links (@pxref{Internal links}) will continue to work in HTML. This
9463 includes automatic links created by radio targets (@pxref{Radio
9464 targets}). Links to external files will still work if the target file is on
9465 the same @i{relative} path as the published Org file. Links to other
9466 @file{.org} files will be translated into HTML links under the assumption
9467 that an HTML version also exists of the linked file, at the same relative
9468 path. @samp{id:} links can then be used to jump to specific entries across
9469 files. For information related to linking files while publishing them to a
9470 publishing directory see @ref{Publishing links}.
9472 If you want to specify attributes for links, you can do so using a special
9473 @code{#+ATTR_HTML} line to define attributes that will be added to the
9474 @code{<a>} or @code{<img>} tags. Here is an example that sets @code{title}
9475 and @code{style} attributes for a link:
9479 #+ATTR_HTML: title="The Org-mode homepage" style="color:red;"
9480 [[http://orgmode.org]]
9483 @node Tables in HTML export, Images in HTML export, Links in HTML export, HTML export
9485 @cindex tables, in HTML
9486 @vindex org-export-html-table-tag
9488 Org-mode tables are exported to HTML using the table tag defined in
9489 @code{org-export-html-table-tag}. The default setting makes tables without
9490 cell borders and frame. If you would like to change this for individual
9491 tables, place something like the following before the table:
9496 #+CAPTION: This is a table with lines around and between cells
9497 #+ATTR_HTML: border="2" rules="all" frame="all"
9500 @node Images in HTML export, Math formatting in HTML export, Tables in HTML export, HTML export
9501 @subsection Images in HTML export
9503 @cindex images, inline in HTML
9504 @cindex inlining images in HTML
9505 @vindex org-export-html-inline-images
9506 HTML export can inline images given as links in the Org file, and
9507 it can make an image the clickable part of a link. By
9508 default@footnote{But see the variable
9509 @code{org-export-html-inline-images}.}, images are inlined if a link does
9510 not have a description. So @samp{[[file:myimg.jpg]]} will be inlined,
9511 while @samp{[[file:myimg.jpg][the image]]} will just produce a link
9512 @samp{the image} that points to the image. If the description part
9513 itself is a @code{file:} link or a @code{http:} URL pointing to an
9514 image, this image will be inlined and activated so that clicking on the
9515 image will activate the link. For example, to include a thumbnail that
9516 will link to a high resolution version of the image, you could use:
9519 [[file:highres.jpg][file:thumb.jpg]]
9522 If you need to add attributes to an inlined image, use a @code{#+ATTR_HTML}.
9523 In the example below we specify the @code{alt} and @code{title} attributes to
9524 support text viewers and accessibility, and align it to the right.
9529 #+CAPTION: A black cat stalking a spider
9530 #+ATTR_HTML: alt="cat/spider image" title="Action!" align="right"
9535 and you could use @code{http} addresses just as well.
9537 @node Math formatting in HTML export, Text areas in HTML export, Images in HTML export, HTML export
9538 @subsection Math formatting in HTML export
9542 La@TeX{} math snippets (@pxref{LaTeX fragments}) can be displayed in two
9543 different ways on HTML pages. The default is to use the
9544 @uref{http://www.mathjax.org, MathJax system} which should work out of the
9545 box with Org mode installation because @code{http://orgmode.org} serves
9546 @file{MathJax} for Org-mode users for small applications and for testing
9547 purposes. @b{If you plan to use this regularly or on pages with significant
9548 page views, you should install MathJax on your own server in order to limit
9549 the load of our server.} To configure @file{MathJax}, use the variable
9550 @code{org-export-html-mathjax-options} or insert something like the following
9554 #+MATHJAX: align:"left" mathml:t path:"/MathJax/MathJax.js"
9557 @noindent See the docstring of the variable
9558 @code{org-export-html-mathjax-options} for the meaning of the parameters in
9561 If you prefer, you can also request that La@TeX{} are processed into small
9562 images that will be inserted into the browser page. Before the availability
9563 of MathJax, this was the default method for Org files. This method requires
9564 that the @file{dvipng} program is available on your system. You can still
9565 get this processing with
9568 #+OPTIONS: LaTeX:dvipng
9571 @node Text areas in HTML export, CSS support, Math formatting in HTML export, HTML export
9572 @subsection Text areas in HTML export
9574 @cindex text areas, in HTML
9575 An alternative way to publish literal code examples in HTML is to use text
9576 areas, where the example can even be edited before pasting it into an
9577 application. It is triggered by a @code{-t} switch at an @code{example} or
9578 @code{src} block. Using this switch disables any options for syntax and
9579 label highlighting, and line numbering, which may be present. You may also
9580 use @code{-h} and @code{-w} switches to specify the height and width of the
9581 text area, which default to the number of lines in the example, and 80,
9582 respectively. For example
9585 #+BEGIN_EXAMPLE -t -w 40
9586 (defun org-xor (a b)
9593 @node CSS support, JavaScript support, Text areas in HTML export, HTML export
9594 @subsection CSS support
9595 @cindex CSS, for HTML export
9596 @cindex HTML export, CSS
9598 @vindex org-export-html-todo-kwd-class-prefix
9599 @vindex org-export-html-tag-class-prefix
9600 You can also give style information for the exported file. The HTML exporter
9601 assigns the following special CSS classes@footnote{If the classes on TODO
9602 keywords and tags lead to conflicts, use the variables
9603 @code{org-export-html-todo-kwd-class-prefix} and
9604 @code{org-export-html-tag-class-prefix} to make them unique.} to appropriate
9605 parts of the document---your style specifications may change these, in
9606 addition to any of the standard classes like for headlines, tables, etc.
9608 p.author @r{author information, including email}
9609 p.date @r{publishing date}
9610 p.creator @r{creator info, about org-mode version}
9611 .title @r{document title}
9612 .todo @r{TODO keywords, all not-done states}
9613 .done @r{the DONE keywords, all stated the count as done}
9614 .WAITING @r{each TODO keyword also uses a class named after itself}
9615 .timestamp @r{timestamp}
9616 .timestamp-kwd @r{keyword associated with a timestamp, like SCHEDULED}
9617 .timestamp-wrapper @r{span around keyword plus timestamp}
9618 .tag @r{tag in a headline}
9619 ._HOME @r{each tag uses itself as a class, "@@" replaced by "_"}
9620 .target @r{target for links}
9621 .linenr @r{the line number in a code example}
9622 .code-highlighted @r{for highlighting referenced code lines}
9623 div.outline-N @r{div for outline level N (headline plus text))}
9624 div.outline-text-N @r{extra div for text at outline level N}
9625 .section-number-N @r{section number in headlines, different for each level}
9626 div.figure @r{how to format an inlined image}
9627 pre.src @r{formatted source code}
9628 pre.example @r{normal example}
9629 p.verse @r{verse paragraph}
9630 div.footnotes @r{footnote section headline}
9631 p.footnote @r{footnote definition paragraph, containing a footnote}
9632 .footref @r{a footnote reference number (always a <sup>)}
9633 .footnum @r{footnote number in footnote definition (always <sup>)}
9636 @vindex org-export-html-style-default
9637 @vindex org-export-html-style-include-default
9638 @vindex org-export-html-style
9639 @vindex org-export-html-extra
9640 @vindex org-export-html-style-default
9641 Each exported file contains a compact default style that defines these
9642 classes in a basic way@footnote{This style is defined in the constant
9643 @code{org-export-html-style-default}, which you should not modify. To turn
9644 inclusion of these defaults off, customize
9645 @code{org-export-html-style-include-default}}. You may overwrite these
9646 settings, or add to them by using the variables @code{org-export-html-style}
9647 (for Org-wide settings) and @code{org-export-html-style-extra} (for more
9648 granular settings, like file-local settings). To set the latter variable
9649 individually for each file, you can use
9653 #+STYLE: <link rel="stylesheet" type="text/css" href="stylesheet.css" />
9657 For longer style definitions, you can use several such lines. You could also
9658 directly write a @code{<style>} @code{</style>} section in this way, without
9659 referring to an external file.
9661 @c FIXME: More about header and footer styles
9662 @c FIXME: Talk about links and targets.
9664 @node JavaScript support, , CSS support, HTML export
9665 @subsection JavaScript supported display of web pages
9667 @cindex Rose, Sebastian
9668 Sebastian Rose has written a JavaScript program especially designed to
9669 enhance the web viewing experience of HTML files created with Org. This
9670 program allows you to view large files in two different ways. The first one
9671 is an @emph{Info}-like mode where each section is displayed separately and
9672 navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
9673 as well, press @kbd{?} for an overview of the available keys). The second
9674 view type is a @emph{folding} view much like Org provides inside Emacs. The
9675 script is available at @url{http://orgmode.org/org-info.js} and you can find
9676 the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
9677 We host the script at our site, but if you use it a lot, you might
9678 not want to be dependent on @url{orgmode.org} and prefer to install a local
9679 copy on your own web server.
9681 To use the script, you need to make sure that the @file{org-jsinfo.el} module
9682 gets loaded. It should be loaded by default, but you can try @kbd{M-x
9683 customize-variable @key{RET} org-modules @key{RET}} to convince yourself that
9684 this is indeed the case. All it then takes to make use of the program is
9685 adding a single line to the Org file:
9687 @cindex #+INFOJS_OPT
9689 #+INFOJS_OPT: view:info toc:nil
9693 If this line is found, the HTML header will automatically contain the code
9694 needed to invoke the script. Using the line above, you can set the following
9698 path: @r{The path to the script. The default is to grab the script from}
9699 @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
9700 @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
9701 view: @r{Initial view when website is first shown. Possible values are:}
9702 info @r{Info-like interface with one section per page.}
9703 overview @r{Folding interface, initially showing only top-level.}
9704 content @r{Folding interface, starting with all headlines visible.}
9705 showall @r{Folding interface, all headlines and text visible.}
9706 sdepth: @r{Maximum headline level that will still become an independent}
9707 @r{section for info and folding modes. The default is taken from}
9708 @r{@code{org-export-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
9709 @r{If this is smaller than in @code{org-export-headline-levels}, each}
9710 @r{info/folding section can still contain child headlines.}
9711 toc: @r{Should the table of content @emph{initially} be visible?}
9712 @r{Even when @code{nil}, you can always get to the "toc" with @kbd{i}.}
9713 tdepth: @r{The depth of the table of contents. The defaults are taken from}
9714 @r{the variables @code{org-export-headline-levels} and @code{org-export-with-toc}.}
9715 ftoc: @r{Does the css of the page specify a fixed position for the "toc"?}
9716 @r{If yes, the toc will never be displayed as a section.}
9717 ltoc: @r{Should there be short contents (children) in each section?}
9718 @r{Make this @code{above} if the section should be above initial text.}
9719 mouse: @r{Headings are highlighted when the mouse is over them. Should be}
9720 @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
9721 buttons: @r{Should view-toggle buttons be everywhere? When @code{nil} (the}
9722 @r{default), only one such button will be present.}
9725 @vindex org-infojs-options
9726 @vindex org-export-html-use-infojs
9727 You can choose default values for these options by customizing the variable
9728 @code{org-infojs-options}. If you always want to apply the script to your
9729 pages, configure the variable @code{org-export-html-use-infojs}.
9731 @node LaTeX and PDF export, DocBook export, HTML export, Exporting
9732 @section La@TeX{} and PDF export
9733 @cindex La@TeX{} export
9735 @cindex Guerry, Bastien
9737 Org-mode contains a La@TeX{} exporter written by Bastien Guerry. With
9738 further processing@footnote{The default LaTeX output is designed for
9739 processing with pdftex or latex. It includes packages that are not
9740 compatible with xetex and possibly luatex. See the variables
9741 @code{org-export-latex-default-packages-alist} and
9742 @code{org-export-latex-packages-alist}.}, this backend is also used to
9743 produce PDF output. Since the La@TeX{} output uses @file{hyperref} to
9744 implement links and cross references, the PDF output file will be fully
9748 * LaTeX/PDF export commands:: Which key invokes which commands
9749 * Header and sectioning:: Setting up the export file structure
9750 * Quoting LaTeX code:: Incorporating literal La@TeX{} code
9751 * Tables in LaTeX export:: Options for exporting tables to La@TeX{}
9752 * Images in LaTeX export:: How to insert figures into La@TeX{} output
9753 * Beamer class export:: Turning the file into a presentation
9756 @node LaTeX/PDF export commands, Header and sectioning, LaTeX and PDF export, LaTeX and PDF export
9757 @subsection La@TeX{} export commands
9759 @cindex region, active
9760 @cindex active region
9761 @cindex transient-mark-mode
9765 @cindex property EXPORT_FILE_NAME
9766 Export as La@TeX{} file @file{myfile.tex}. For an Org file
9767 @file{myfile.org}, the ASCII file will be @file{myfile.tex}. The file will
9768 be overwritten without warning. If there is an active region@footnote{This
9769 requires @code{transient-mark-mode} be turned on.}, only the region will be
9770 exported. If the selected region is a single tree@footnote{To select the
9771 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
9772 title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME}
9773 property, that name will be used for the export.
9776 Export to a temporary buffer, do not create a file.
9781 Export only the visible part of the document.
9782 @item M-x org-export-region-as-latex
9783 Convert the region to La@TeX{} under the assumption that it was Org-mode
9784 syntax before. This is a global command that can be invoked in any
9786 @item M-x org-replace-region-by-latex
9787 Replace the active region (assumed to be in Org-mode syntax) by La@TeX{}
9791 Export as La@TeX{} and then process to PDF.
9794 Export as La@TeX{} and then process to PDF, then open the resulting PDF file.
9797 @cindex headline levels, for exporting
9798 @vindex org-latex-low-levels
9799 In the exported version, the first 3 outline levels will become
9800 headlines, defining a general document structure. Additional levels
9801 will be exported as description lists. The exporter can ignore them or
9802 convert them to a custom string depending on
9803 @code{org-latex-low-levels}.
9805 If you want that transition to occur at a different level, specify it
9806 with a numeric prefix argument. For example,
9813 creates two levels of headings and does the rest as items.
9815 @node Header and sectioning, Quoting LaTeX code, LaTeX/PDF export commands, LaTeX and PDF export
9816 @subsection Header and sectioning structure
9817 @cindex La@TeX{} class
9818 @cindex La@TeX{} sectioning structure
9819 @cindex La@TeX{} header
9820 @cindex header, for LaTeX files
9821 @cindex sectioning structure, for LaTeX export
9823 By default, the La@TeX{} output uses the class @code{article}.
9825 @vindex org-export-latex-default-class
9826 @vindex org-export-latex-classes
9827 @vindex org-export-latex-default-packages-alist
9828 @vindex org-export-latex-packages-alist
9829 @cindex #+LATEX_HEADER
9830 @cindex #+LATEX_CLASS
9831 @cindex #+LATEX_CLASS_OPTIONS
9832 @cindex property, LATEX_CLASS
9833 @cindex property, LATEX_CLASS_OPTIONS
9834 You can change this globally by setting a different value for
9835 @code{org-export-latex-default-class} or locally by adding an option like
9836 @code{#+LaTeX_CLASS: myclass} in your file, or with a @code{:LaTeX_CLASS:}
9837 property that applies when exporting a region containing only this (sub)tree.
9838 The class must be listed in @code{org-export-latex-classes}. This variable
9839 defines a header template for each class@footnote{Into which the values of
9840 @code{org-export-latex-default-packages-alist} and
9841 @code{org-export-latex-packages-alist} are spliced.}, and allows you to
9842 define the sectioning structure for each class. You can also define your own
9843 classes there. @code{#+LaTeX_CLASS_OPTIONS} or a @code{LaTeX_CLASS_OPTIONS}
9844 property can specify the options for the @code{\documentclass} macro. You
9845 can also use @code{#+LATEX_HEADER: \usepackage@{xyz@}} to add lines to the
9846 header. See the docstring of @code{org-export-latex-classes} for more
9849 @node Quoting LaTeX code, Tables in LaTeX export, Header and sectioning, LaTeX and PDF export
9850 @subsection Quoting La@TeX{} code
9852 Embedded La@TeX{} as described in @ref{Embedded LaTeX}, will be correctly
9853 inserted into the La@TeX{} file. This includes simple macros like
9854 @samp{\ref@{LABEL@}} to create a cross reference to a figure. Furthermore,
9855 you can add special code that should only be present in La@TeX{} export with
9856 the following constructs:
9859 @cindex #+BEGIN_LaTeX
9861 #+LaTeX: Literal LaTeX code for export
9865 @cindex #+BEGIN_LaTeX
9869 All lines between these markers are exported literally
9874 @node Tables in LaTeX export, Images in LaTeX export, Quoting LaTeX code, LaTeX and PDF export
9875 @subsection Tables in La@TeX{} export
9876 @cindex tables, in La@TeX{} export
9878 For La@TeX{} export of a table, you can specify a label and a caption
9879 (@pxref{Images and tables}). You can also use the @code{ATTR_LaTeX} line to
9880 request a @code{longtable} environment for the table, so that it may span
9881 several pages, or provide the @code{multicolumn} keyword that will make the
9882 table span the page in a multicolumn environment (@code{table*} environment).
9883 Finally, you can set the alignment string:
9887 @cindex #+ATTR_LaTeX
9889 #+CAPTION: A long table
9891 #+ATTR_LaTeX: longtable align=l|lp@{3cm@}r|l
9897 @node Images in LaTeX export, Beamer class export, Tables in LaTeX export, LaTeX and PDF export
9898 @subsection Images in La@TeX{} export
9899 @cindex images, inline in La@TeX{}
9900 @cindex inlining images in La@TeX{}
9902 Images that are linked to without a description part in the link, like
9903 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
9904 output file resulting from La@TeX{} processing. Org will use an
9905 @code{\includegraphics} macro to insert the image. If you have specified a
9906 caption and/or a label as described in @ref{Images and tables}, the figure
9907 will be wrapped into a @code{figure} environment and thus become a floating
9908 element. You can use an @code{#+ATTR_LaTeX:} line to specify the various
9909 options that can be used in the optional argument of the
9910 @code{\includegraphics} macro. To modify the placement option of the
9911 @code{figure} environment, add something like @samp{placement=[h!]} to the
9914 If you would like to let text flow around the image, add the word @samp{wrap}
9915 to the @code{#+ATTR_LaTeX:} line, which will make the figure occupy the left
9916 half of the page. To fine-tune, the @code{placement} field will be the set
9917 of additional arguments needed by the @code{wrapfigure} environment. Note
9918 that if you change the size of the image, you need to use compatible settings
9919 for @code{\includegraphics} and @code{wrapfigure}.
9923 @cindex #+ATTR_LaTeX
9925 #+CAPTION: The black-body emission of the disk around HR 4049
9926 #+LABEL: fig:SED-HR4049
9927 #+ATTR_LaTeX: width=5cm,angle=90
9928 [[./img/sed-hr4049.pdf]]
9930 #+ATTR_LaTeX: width=0.38\textwidth wrap placement=@{r@}@{0.4\textwidth@}
9934 If you need references to a label created in this way, write
9935 @samp{\ref@{fig:SED-HR4049@}} just like in La@TeX{}.
9937 @node Beamer class export, , Images in LaTeX export, LaTeX and PDF export
9938 @subsection Beamer class export
9940 The LaTeX class @file{beamer} allows production of high quality presentations
9941 using LaTeX and pdf processing. Org-mode has special support for turning an
9942 Org-mode file or tree into a @file{beamer} presentation.
9944 When the LaTeX class for the current buffer (as set with @code{#+LaTeX_CLASS:
9945 beamer}) or subtree (set with a @code{LaTeX_CLASS} property) is
9946 @code{beamer}, a special export mode will turn the file or tree into a beamer
9947 presentation. Any tree with not-too-deep level nesting should in principle be
9948 exportable as a beamer presentation. By default, the top-level entries (or
9949 the first level below the selected subtree heading) will be turned into
9950 frames, and the outline structure below this level will become itemize lists.
9951 You can also configure the variable @code{org-beamer-frame-level} to a
9952 different level - then the hierarchy above frames will produce the sectioning
9953 structure of the presentation.
9955 A template for useful in-buffer settings or properties can be inserted into
9956 the buffer with @kbd{M-x org-insert-beamer-options-template}. Among other
9957 things, this will install a column view format which is very handy for
9958 editing special properties used by beamer.
9960 You can influence the structure of the presentation using the following
9965 The environment that should be used to format this entry. Valid environments
9966 are defined in the constant @code{org-beamer-environments-default}, and you
9967 can define more in @code{org-beamer-environments-extra}. If this property is
9968 set, the entry will also get a @code{:B_environment:} tag to make this
9969 visible. This tag has no semantic meaning, it is only a visual aid.
9970 @item BEAMER_envargs
9971 The beamer-special arguments that should be used for the environment, like
9972 @code{[t]} or @code{[<+->]} of @code{<2-3>}. If the @code{BEAMER_col}
9973 property is also set, something like @code{C[t]} can be added here as well to
9974 set an options argument for the implied @code{columns} environment.
9975 @code{c[t]} will set an option for the implied @code{column} environment.
9977 The width of a column that should start with this entry. If this property is
9978 set, the entry will also get a @code{:BMCOL:} property to make this visible.
9979 Also this tag is only a visual aid. When this is a plain number, it will be
9980 interpreted as a fraction of @code{\textwidth}. Otherwise it will be assumed
9981 that you have specified the units, like @samp{3cm}. The first such property
9982 in a frame will start a @code{columns} environment to surround the columns.
9983 This environment is closed when an entry has a @code{BEAMER_col} property
9984 with value 0 or 1, or automatically at the end of the frame.
9986 Additional commands that should be inserted after the environment has been
9987 opened. For example, when creating a frame, this can be used to specify
9991 Frames will automatically receive a @code{fragile} option if they contain
9992 source code that uses the verbatim environment. Special @file{beamer}
9993 specific code can be inserted using @code{#+BEAMER:} and
9994 @code{#+BEGIN_beamer...#+end_beamer} constructs, similar to other export
9995 backends, but with the difference that @code{#+LaTeX:} stuff will be included
9996 in the presentation as well.
9998 Outline nodes with @code{BEAMER_env} property value @samp{note} or
9999 @samp{noteNH} will be formatted as beamer notes, i,e, they will be wrapped
10000 into @code{\note@{...@}}. The former will include the heading as part of the
10001 note text, the latter will ignore the heading of that node. To simplify note
10002 generation, it is actually enough to mark the note with a @emph{tag} (either
10003 @code{:B_note:} or @code{:B_noteNH:}) instead of creating the
10004 @code{BEAMER_env} property.
10006 You can turn on a special minor mode @code{org-beamer-mode} for editing
10016 In @code{org-beamer-mode}, this key offers fast selection of a beamer
10017 environment or the @code{BEAMER_col} property.
10020 Column view provides a great way to set the environment of a node and other
10021 important parameters. Make sure you are using a COLUMN format that is geared
10022 toward this special purpose. The command @kbd{M-x
10023 org-insert-beamer-options-template} defines such a format.
10025 Here is a simple example Org document that is intended for beamer export.
10028 #+LaTeX_CLASS: beamer
10029 #+TITLE: Example Presentation
10030 #+AUTHOR: Carsten Dominik
10031 #+LaTeX_CLASS_OPTIONS: [presentation]
10032 #+BEAMER_FRAME_LEVEL: 2
10033 #+BEAMER_HEADER_EXTRA: \usetheme@{Madrid@}\usecolortheme@{default@}
10034 #+COLUMNS: %35ITEM %10BEAMER_env(Env) %10BEAMER_envargs(Args) %4BEAMER_col(Col) %8BEAMER_extra(Ex)
10036 * This is the first structural section
10038 ** Frame 1 \\ with a subtitle
10039 *** Thanks to Eric Fraga :BMCOL:B_block:
10042 :BEAMER_envargs: C[t]
10045 for the first viable beamer setup in Org
10046 *** Thanks to everyone else :BMCOL:B_block:
10050 :BEAMER_envargs: <2->
10052 for contributing to the discussion
10053 **** This will be formatted as a beamer note :B_note:
10054 ** Frame 2 \\ where we will not use columns
10055 *** Request :B_block:
10056 Please test this stuff!
10062 For more information, see the documentation on Worg.
10064 @node DocBook export, TaskJuggler export, LaTeX and PDF export, Exporting
10065 @section DocBook export
10066 @cindex DocBook export
10068 @cindex Cui, Baoqiu
10070 Org contains a DocBook exporter written by Baoqiu Cui. Once an Org file is
10071 exported to DocBook format, it can be further processed to produce other
10072 formats, including PDF, HTML, man pages, etc., using many available DocBook
10073 tools and stylesheets.
10075 Currently DocBook exporter only supports DocBook V5.0.
10078 * DocBook export commands:: How to invoke DocBook export
10079 * Quoting DocBook code:: Incorporating DocBook code in Org files
10080 * Recursive sections:: Recursive sections in DocBook
10081 * Tables in DocBook export:: Tables are exported as HTML tables
10082 * Images in DocBook export:: How to insert figures into DocBook output
10083 * Special characters:: How to handle special characters
10086 @node DocBook export commands, Quoting DocBook code, DocBook export, DocBook export
10087 @subsection DocBook export commands
10089 @cindex region, active
10090 @cindex active region
10091 @cindex transient-mark-mode
10095 @cindex property EXPORT_FILE_NAME
10096 Export as DocBook file. For an Org file, @file{myfile.org}, the DocBook XML
10097 file will be @file{myfile.xml}. The file will be overwritten without
10098 warning. If there is an active region@footnote{This requires
10099 @code{transient-mark-mode} to be turned on}, only the region will be
10100 exported. If the selected region is a single tree@footnote{To select the
10101 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
10102 title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
10103 property, that name will be used for the export.
10106 Export as DocBook file, process to PDF, then open the resulting PDF file.
10108 @vindex org-export-docbook-xslt-proc-command
10109 @vindex org-export-docbook-xsl-fo-proc-command
10110 Note that, in order to produce PDF output based on exported DocBook file, you
10111 need to have XSLT processor and XSL-FO processor software installed on your
10112 system. Check variables @code{org-export-docbook-xslt-proc-command} and
10113 @code{org-export-docbook-xsl-fo-proc-command}.
10115 @vindex org-export-docbook-xslt-stylesheet
10116 The stylesheet argument @code{%s} in variable
10117 @code{org-export-docbook-xslt-proc-command} is replaced by the value of
10118 variable @code{org-export-docbook-xslt-stylesheet}, which needs to be set by
10119 the user. You can also overrule this global setting on a per-file basis by
10120 adding an in-buffer setting @code{#+XSLT:} to the Org file.
10122 @kindex C-c C-e v D
10124 Export only the visible part of the document.
10127 @node Quoting DocBook code, Recursive sections, DocBook export commands, DocBook export
10128 @subsection Quoting DocBook code
10130 You can quote DocBook code in Org files and copy it verbatim into exported
10131 DocBook file with the following constructs:
10134 @cindex #+BEGIN_DOCBOOK
10136 #+DOCBOOK: Literal DocBook code for export
10140 @cindex #+BEGIN_DOCBOOK
10144 All lines between these markers are exported by DocBook exporter
10149 For example, you can use the following lines to include a DocBook warning
10150 admonition. As to what this warning says, you should pay attention to the
10151 document context when quoting DocBook code in Org files. You may make
10152 exported DocBook XML files invalid by not quoting DocBook code correctly.
10157 <para>You should know what you are doing when quoting DocBook XML code
10158 in your Org file. Invalid DocBook XML file may be generated by
10159 DocBook exporter if you are not careful!</para>
10164 @node Recursive sections, Tables in DocBook export, Quoting DocBook code, DocBook export
10165 @subsection Recursive sections
10166 @cindex DocBook recursive sections
10168 DocBook exporter exports Org files as articles using the @code{article}
10169 element in DocBook. Recursive sections, i.e. @code{section} elements, are
10170 used in exported articles. Top level headlines in Org files are exported as
10171 top level sections, and lower level headlines are exported as nested
10172 sections. The entire structure of Org files will be exported completely, no
10173 matter how many nested levels of headlines there are.
10175 Using recursive sections makes it easy to port and reuse exported DocBook
10176 code in other DocBook document types like @code{book} or @code{set}.
10178 @node Tables in DocBook export, Images in DocBook export, Recursive sections, DocBook export
10179 @subsection Tables in DocBook export
10180 @cindex tables, in DocBook export
10182 Tables in Org files are exported as HTML tables, which have been supported since
10185 If a table does not have a caption, an informal table is generated using the
10186 @code{informaltable} element; otherwise, a formal table will be generated
10187 using the @code{table} element.
10189 @node Images in DocBook export, Special characters, Tables in DocBook export, DocBook export
10190 @subsection Images in DocBook export
10191 @cindex images, inline in DocBook
10192 @cindex inlining images in DocBook
10194 Images that are linked to without a description part in the link, like
10195 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]}, will be exported to DocBook
10196 using @code{mediaobject} elements. Each @code{mediaobject} element contains
10197 an @code{imageobject} that wraps an @code{imagedata} element. If you have
10198 specified a caption for an image as described in @ref{Images and tables}, a
10199 @code{caption} element will be added in @code{mediaobject}. If a label is
10200 also specified, it will be exported as an @code{xml:id} attribute of the
10201 @code{mediaobject} element.
10203 @vindex org-export-docbook-default-image-attributes
10204 Image attributes supported by the @code{imagedata} element, like @code{align}
10205 or @code{width}, can be specified in two ways: you can either customize
10206 variable @code{org-export-docbook-default-image-attributes} or use the
10207 @code{#+ATTR_DOCBOOK:} line. Attributes specified in variable
10208 @code{org-export-docbook-default-image-attributes} are applied to all inline
10209 images in the Org file to be exported (unless they are overridden by image
10210 attributes specified in @code{#+ATTR_DOCBOOK:} lines).
10212 The @code{#+ATTR_DOCBOOK:} line can be used to specify additional image
10213 attributes or override default image attributes for individual images. If
10214 the same attribute appears in both the @code{#+ATTR_DOCBOOK:} line and
10215 variable @code{org-export-docbook-default-image-attributes}, the former
10216 takes precedence. Here is an example about how image attributes can be
10221 @cindex #+ATTR_DOCBOOK
10223 #+CAPTION: The logo of Org-mode
10224 #+LABEL: unicorn-svg
10225 #+ATTR_DOCBOOK: scalefit="1" width="100%" depth="100%"
10226 [[./img/org-mode-unicorn.svg]]
10229 @vindex org-export-docbook-inline-image-extensions
10230 By default, DocBook exporter recognizes the following image file types:
10231 @file{jpeg}, @file{jpg}, @file{png}, @file{gif}, and @file{svg}. You can
10232 customize variable @code{org-export-docbook-inline-image-extensions} to add
10233 more types to this list as long as DocBook supports them.
10235 @node Special characters, , Images in DocBook export, DocBook export
10236 @subsection Special characters in DocBook export
10237 @cindex Special characters in DocBook export
10239 @vindex org-export-docbook-doctype
10240 @vindex org-entities
10241 Special characters that are written in @TeX{}-like syntax, such as @code{\alpha},
10242 @code{\Gamma}, and @code{\Zeta}, are supported by DocBook exporter. These
10243 characters are rewritten to XML entities, like @code{α},
10244 @code{Γ}, and @code{Ζ}, based on the list saved in variable
10245 @code{org-entities}. As long as the generated DocBook file includes the
10246 corresponding entities, these special characters are recognized.
10248 You can customize variable @code{org-export-docbook-doctype} to include the
10249 entities you need. For example, you can set variable
10250 @code{org-export-docbook-doctype} to the following value to recognize all
10251 special characters included in XHTML entities:
10254 "<!DOCTYPE article [
10255 <!ENTITY % xhtml1-symbol PUBLIC
10256 \"-//W3C//ENTITIES Symbol for HTML//EN//XML\"
10257 \"http://www.w3.org/2003/entities/2007/xhtml1-symbol.ent\"
10264 @node TaskJuggler export, Freemind export, DocBook export, Exporting
10265 @section TaskJuggler export
10266 @cindex TaskJuggler export
10267 @cindex Project management
10269 @uref{http://www.taskjuggler.org/, TaskJuggler} is a project management tool.
10270 It provides an optimizing scheduler that computes your project time lines and
10271 resource assignments based on the project outline and the constraints that
10274 The TaskJuggler exporter is a bit different from other exporters, such as the
10275 HTML and LaTeX exporters for example, in that it does not export all the
10276 nodes of a document or strictly follow the order of the nodes in the
10279 Instead the TaskJuggler exporter looks for a tree that defines the tasks and
10280 a optionally tree that defines the resources for this project. It then
10281 creates a TaskJuggler file based on these trees and the attributes defined in
10284 @subsection TaskJuggler export commands
10289 Export as TaskJuggler file.
10293 Export as TaskJuggler file and then open the file with TaskJugglerUI.
10298 @vindex org-export-taskjuggler-project-tag
10299 Create your tasks as you usually do with Org-mode. Assign efforts to each
10300 task using properties (it's easiest to do this in the column view). You
10301 should end up with something similar to the example by Peter Jones in
10302 @url{http://www.contextualdevelopment.com/static/artifacts/articles/2008/project-planning/project-planning.org}.
10303 Now mark the top node of your tasks with a tag named
10304 @code{:taskjuggler_project:} (or whatever you customized
10305 @code{org-export-taskjuggler-project-tag} to). You are now ready to export
10306 the project plan with @kbd{C-c C-e J} which will export the project plan and
10307 open a gantt chart in TaskJugglerUI.
10309 @subsection Resources
10311 @vindex org-export-taskjuggler-resource-tag
10312 Next you can define resources and assign those to work on specific tasks. You
10313 can group your resources hierarchically. Tag the top node of the resources
10314 with @code{:taskjuggler_resource:} (or whatever you customized
10315 @code{org-export-taskjuggler-resource-tag} to). You can optionally assign an
10316 identifier (named @samp{resource_id}) to the resources (using the standard
10317 Org properties commands, @pxref{Property syntax}) or you can let the exporter
10318 generate identifiers automatically (the exporter picks the first word of the
10319 headline as the identifier as long as it is unique, see the documentation of
10320 @code{org-taskjuggler-get-unique-id}). Using that identifier you can then
10321 allocate resources to tasks. This is again done with the @samp{allocate}
10322 property on the tasks. Do this in column view or when on the task type
10323 @kbd{C-c C-x p allocate @key{RET} <resource_id> @key{RET}}.
10325 Once the allocations are done you can again export to TaskJuggler and check
10326 in the Resource Allocation Graph which person is working on what task at what
10329 @subsection Export of properties
10331 The exporter also takes TODO state information into consideration, i.e. if a
10332 task is marked as done it will have the corresponding attribute in
10333 TaskJuggler (@samp{complete 100}). Also it will export any property on a task
10334 resource or resource node which is known to TaskJuggler, such as
10335 @samp{limits}, @samp{vacation}, @samp{shift}, @samp{booking},
10336 @samp{efficiency}, @samp{journalentry}, @samp{rate} for resources or
10337 @samp{account}, @samp{start}, @samp{note}, @samp{duration}, @samp{end},
10338 @samp{journalentry}, @samp{milestone}, @samp{reference}, @samp{responsible},
10339 @samp{scheduling}, etc for tasks.
10341 @subsection Dependencies
10343 The exporter will handle dependencies that are defined in the tasks either
10344 with the @samp{ORDERED} attribute (@pxref{TODO dependencies}), with the
10345 @samp{BLOCKER} attribute (see org-depend.el) or alternatively with a
10346 @samp{depends} attribute. Both the @samp{BLOCKER} and the @samp{depends}
10347 attribute can be either @samp{previous-sibling} or a reference to an
10348 identifier (named @samp{task_id}) which is defined for another task in the
10349 project. @samp{BLOCKER} and the @samp{depends} attribute can define multiple
10350 dependencies separated by either space or comma. You can also specify
10351 optional attributes on the dependency by simply appending it. The following
10352 examples should illustrate this:
10357 :task_id: preparation
10360 * Training material
10362 :task_id: training_material
10365 ** Markup Guidelines
10369 ** Workflow Guidelines
10376 :BLOCKER: training_material @{ gapduration 1d @} preparation
10380 @subsection Reports
10382 @vindex org-export-taskjuggler-default-reports
10383 TaskJuggler can produce many kinds of reports (e.g. gantt chart, resource
10384 allocation, etc). The user defines what kind of reports should be generated
10385 for a project in the TaskJuggler file. The exporter will automatically insert
10386 some default reports in the file. These defaults are defined in
10387 @code{org-export-taskjuggler-default-reports}. They can be modified using
10388 customize along with a number of other options. For a more complete list, see
10389 @kbd{M-x customize-group @key{RET} org-export-taskjuggler @key{RET}}.
10391 For more information and examples see the Org-taskjuggler tutorial at
10392 @uref{http://orgmode.org/worg/org-tutorials/org-taskjuggler.php}.
10394 @node Freemind export, XOXO export, TaskJuggler export, Exporting
10395 @section Freemind export
10396 @cindex Freemind export
10399 The Freemind exporter was written by Lennart Borgman.
10404 Export as Freemind mind map @file{myfile.mm}.
10407 @node XOXO export, iCalendar export, Freemind export, Exporting
10408 @section XOXO export
10409 @cindex XOXO export
10411 Org-mode contains an exporter that produces XOXO-style output.
10412 Currently, this exporter only handles the general outline structure and
10413 does not interpret any additional Org-mode features.
10418 Export as XOXO file @file{myfile.html}.
10421 Export only the visible part of the document.
10424 @node iCalendar export, , XOXO export, Exporting
10425 @section iCalendar export
10426 @cindex iCalendar export
10428 @vindex org-icalendar-include-todo
10429 @vindex org-icalendar-use-deadline
10430 @vindex org-icalendar-use-scheduled
10431 @vindex org-icalendar-categories
10432 @vindex org-icalendar-alarm-time
10433 Some people use Org-mode for keeping track of projects, but still prefer a
10434 standard calendar application for anniversaries and appointments. In this
10435 case it can be useful to show deadlines and other time-stamped items in Org
10436 files in the calendar application. Org-mode can export calendar information
10437 in the standard iCalendar format. If you also want to have TODO entries
10438 included in the export, configure the variable
10439 @code{org-icalendar-include-todo}. Plain timestamps are exported as VEVENT,
10440 and TODO items as VTODO. It will also create events from deadlines that are
10441 in non-TODO items. Deadlines and scheduling dates in TODO items will be used
10442 to set the start and due dates for the TODO entry@footnote{See the variables
10443 @code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}.
10444 As categories, it will use the tags locally defined in the heading, and the
10445 file/tree category@footnote{To add inherited tags or the TODO state,
10446 configure the variable @code{org-icalendar-categories}.}. See the variable
10447 @code{org-icalendar-alarm-time} for a way to assign alarms to entries with a
10450 @vindex org-icalendar-store-UID
10451 @cindex property, ID
10452 The iCalendar standard requires each entry to have a globally unique
10453 identifier (UID). Org creates these identifiers during export. If you set
10454 the variable @code{org-icalendar-store-UID}, the UID will be stored in the
10455 @code{:ID:} property of the entry and re-used next time you report this
10456 entry. Since a single entry can give rise to multiple iCalendar entries (as
10457 a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
10458 prefixes to the UID, depending on what triggered the inclusion of the entry.
10459 In this way the UID remains unique, but a synchronization program can still
10460 figure out from which entry all the different instances originate.
10465 Create iCalendar entries for the current file and store them in the same
10466 directory, using a file extension @file{.ics}.
10469 @vindex org-agenda-files
10470 Like @kbd{C-c C-e i}, but do this for all files in
10471 @code{org-agenda-files}. For each of these files, a separate iCalendar
10472 file will be written.
10475 @vindex org-combined-agenda-icalendar-file
10476 Create a single large iCalendar file from all files in
10477 @code{org-agenda-files} and write it to the file given by
10478 @code{org-combined-agenda-icalendar-file}.
10481 @vindex org-use-property-inheritance
10482 @vindex org-icalendar-include-body
10483 @cindex property, SUMMARY
10484 @cindex property, DESCRIPTION
10485 @cindex property, LOCATION
10486 The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION
10487 property can be inherited from higher in the hierarchy if you configure
10488 @code{org-use-property-inheritance} accordingly.} properties if the selected
10489 entries have them. If not, the summary will be derived from the headline,
10490 and the description from the body (limited to
10491 @code{org-icalendar-include-body} characters).
10493 How this calendar is best read and updated, depends on the application
10494 you are using. The FAQ covers this issue.
10496 @node Publishing, Working With Source Code, Exporting, Top
10497 @chapter Publishing
10500 Org includes a publishing management system that allows you to configure
10501 automatic HTML conversion of @emph{projects} composed of interlinked org
10502 files. You can also configure Org to automatically upload your exported HTML
10503 pages and related attachments, such as images and source code files, to a web
10506 You can also use Org to convert files into PDF, or even combine HTML and PDF
10507 conversion so that files are available in both formats on the server.
10509 Publishing has been contributed to Org by David O'Toole.
10512 * Configuration:: Defining projects
10513 * Uploading files:: How to get files up on the server
10514 * Sample configuration:: Example projects
10515 * Triggering publication:: Publication commands
10518 @node Configuration, Uploading files, Publishing, Publishing
10519 @section Configuration
10521 Publishing needs significant configuration to specify files, destination
10522 and many other properties of a project.
10525 * Project alist:: The central configuration variable
10526 * Sources and destinations:: From here to there
10527 * Selecting files:: What files are part of the project?
10528 * Publishing action:: Setting the function doing the publishing
10529 * Publishing options:: Tweaking HTML export
10530 * Publishing links:: Which links keep working after publishing?
10531 * Sitemap:: Generating a list of all pages
10532 * Generating an index:: An index that reaches across pages
10535 @node Project alist, Sources and destinations, Configuration, Configuration
10536 @subsection The variable @code{org-publish-project-alist}
10537 @cindex org-publish-project-alist
10538 @cindex projects, for publishing
10540 @vindex org-publish-project-alist
10541 Publishing is configured almost entirely through setting the value of one
10542 variable, called @code{org-publish-project-alist}. Each element of the list
10543 configures one project, and may be in one of the two following forms:
10546 ("project-name" :property value :property value ...)
10548 ("project-name" :components ("project-name" "project-name" ...))
10552 In both cases, projects are configured by specifying property values. A
10553 project defines the set of files that will be published, as well as the
10554 publishing configuration to use when publishing those files. When a project
10555 takes the second form listed above, the individual members of the
10556 @code{:components} property are taken to be sub-projects, which group
10557 together files requiring different publishing options. When you publish such
10558 a ``meta-project'', all the components will also be published, in the
10561 @node Sources and destinations, Selecting files, Project alist, Configuration
10562 @subsection Sources and destinations for files
10563 @cindex directories, for publishing
10565 Most properties are optional, but some should always be set. In
10566 particular, Org needs to know where to look for source files,
10567 and where to put published files.
10569 @multitable @columnfractions 0.3 0.7
10570 @item @code{:base-directory}
10571 @tab Directory containing publishing source files
10572 @item @code{:publishing-directory}
10573 @tab Directory where output files will be published. You can directly
10574 publish to a webserver using a file name syntax appropriate for
10575 the Emacs @file{tramp} package. Or you can publish to a local directory and
10576 use external tools to upload your website (@pxref{Uploading files}).
10577 @item @code{:preparation-function}
10578 @tab Function or list of functions to be called before starting the
10579 publishing process, for example, to run @code{make} for updating files to be
10580 published. The project property list is scoped into this call as the
10581 variable @code{project-plist}.
10582 @item @code{:completion-function}
10583 @tab Function or list of functions called after finishing the publishing
10584 process, for example, to change permissions of the resulting files. The
10585 project property list is scoped into this call as the variable
10586 @code{project-plist}.
10590 @node Selecting files, Publishing action, Sources and destinations, Configuration
10591 @subsection Selecting files
10592 @cindex files, selecting for publishing
10594 By default, all files with extension @file{.org} in the base directory
10595 are considered part of the project. This can be modified by setting the
10597 @multitable @columnfractions 0.25 0.75
10598 @item @code{:base-extension}
10599 @tab Extension (without the dot!) of source files. This actually is a
10600 regular expression. Set this to the symbol @code{any} if you want to get all
10601 files in @code{:base-directory}, even without extension.
10603 @item @code{:exclude}
10604 @tab Regular expression to match file names that should not be
10605 published, even though they have been selected on the basis of their
10608 @item @code{:include}
10609 @tab List of files to be included regardless of @code{:base-extension}
10610 and @code{:exclude}.
10613 @node Publishing action, Publishing options, Selecting files, Configuration
10614 @subsection Publishing action
10615 @cindex action, for publishing
10617 Publishing means that a file is copied to the destination directory and
10618 possibly transformed in the process. The default transformation is to export
10619 Org files as HTML files, and this is done by the function
10620 @code{org-publish-org-to-html} which calls the HTML exporter (@pxref{HTML
10621 export}). But you also can publish your content as PDF files using
10622 @code{org-publish-org-to-pdf}. If you want to publish the Org file itself,
10623 but with @i{archived}, @i{commented}, and @i{tag-excluded} trees removed, use
10624 @code{org-publish-org-to-org} and set the parameters @code{:plain-source}
10625 and/or @code{:htmlized-source}. This will produce @file{file.org} and
10626 @file{file.org.html} in the publishing
10627 directory@footnote{@file{file-source.org} and @file{file-source.org.html} if
10628 source and publishing directories are equal. Note that with this kind of
10629 setup, you need to add @code{:exclude "-source\\.org"} to the project
10630 definition in @code{org-publish-project-alist} to avoid that the published
10631 source files will be considered as new org files the next time the project is
10632 published.}. Other files like images only
10633 need to be copied to the publishing destination, for this you may use
10634 @code{org-publish-attachment}. For non-Org files, you always need to
10635 specify the publishing function:
10637 @multitable @columnfractions 0.3 0.7
10638 @item @code{:publishing-function}
10639 @tab Function executing the publication of a file. This may also be a
10640 list of functions, which will all be called in turn.
10641 @item @code{:plain-source}
10642 @tab Non-nil means, publish plain source.
10643 @item @code{:htmlized-source}
10644 @tab Non-nil means, publish htmlized source.
10647 The function must accept three arguments: a property list containing at least
10648 a @code{:publishing-directory} property, the name of the file to be
10649 published, and the path to the publishing directory of the output file. It
10650 should take the specified file, make the necessary transformation (if any)
10651 and place the result into the destination folder.
10653 @node Publishing options, Publishing links, Publishing action, Configuration
10654 @subsection Options for the HTML/La@TeX{} exporters
10655 @cindex options, for publishing
10657 The property list can be used to set many export options for the HTML
10658 and La@TeX{} exporters. In most cases, these properties correspond to user
10659 variables in Org. The table below lists these properties along
10660 with the variable they belong to. See the documentation string for the
10661 respective variable for details.
10663 @vindex org-export-html-link-up
10664 @vindex org-export-html-link-home
10665 @vindex org-export-default-language
10666 @vindex org-display-custom-times
10667 @vindex org-export-headline-levels
10668 @vindex org-export-with-section-numbers
10669 @vindex org-export-section-number-format
10670 @vindex org-export-with-toc
10671 @vindex org-export-preserve-breaks
10672 @vindex org-export-with-archived-trees
10673 @vindex org-export-with-emphasize
10674 @vindex org-export-with-sub-superscripts
10675 @vindex org-export-with-special-strings
10676 @vindex org-export-with-footnotes
10677 @vindex org-export-with-drawers
10678 @vindex org-export-with-tags
10679 @vindex org-export-with-todo-keywords
10680 @vindex org-export-with-priority
10681 @vindex org-export-with-TeX-macros
10682 @vindex org-export-with-LaTeX-fragments
10683 @vindex org-export-skip-text-before-1st-heading
10684 @vindex org-export-with-fixed-width
10685 @vindex org-export-with-timestamps
10686 @vindex org-export-author-info
10687 @vindex org-export-email
10688 @vindex org-export-creator-info
10689 @vindex org-export-with-tables
10690 @vindex org-export-highlight-first-table-line
10691 @vindex org-export-html-style-include-default
10692 @vindex org-export-html-style
10693 @vindex org-export-html-style-extra
10694 @vindex org-export-html-link-org-files-as-html
10695 @vindex org-export-html-inline-images
10696 @vindex org-export-html-extension
10697 @vindex org-export-html-table-tag
10698 @vindex org-export-html-expand
10699 @vindex org-export-html-with-timestamp
10700 @vindex org-export-publishing-directory
10701 @vindex org-export-html-preamble
10702 @vindex org-export-html-postamble
10703 @vindex org-export-html-auto-preamble
10704 @vindex org-export-html-auto-postamble
10705 @vindex user-full-name
10706 @vindex user-mail-address
10707 @vindex org-export-select-tags
10708 @vindex org-export-exclude-tags
10710 @multitable @columnfractions 0.32 0.68
10711 @item @code{:link-up} @tab @code{org-export-html-link-up}
10712 @item @code{:link-home} @tab @code{org-export-html-link-home}
10713 @item @code{:language} @tab @code{org-export-default-language}
10714 @item @code{:customtime} @tab @code{org-display-custom-times}
10715 @item @code{:headline-levels} @tab @code{org-export-headline-levels}
10716 @item @code{:section-numbers} @tab @code{org-export-with-section-numbers}
10717 @item @code{:section-number-format} @tab @code{org-export-section-number-format}
10718 @item @code{:table-of-contents} @tab @code{org-export-with-toc}
10719 @item @code{:preserve-breaks} @tab @code{org-export-preserve-breaks}
10720 @item @code{:archived-trees} @tab @code{org-export-with-archived-trees}
10721 @item @code{:emphasize} @tab @code{org-export-with-emphasize}
10722 @item @code{:sub-superscript} @tab @code{org-export-with-sub-superscripts}
10723 @item @code{:special-strings} @tab @code{org-export-with-special-strings}
10724 @item @code{:footnotes} @tab @code{org-export-with-footnotes}
10725 @item @code{:drawers} @tab @code{org-export-with-drawers}
10726 @item @code{:tags} @tab @code{org-export-with-tags}
10727 @item @code{:todo-keywords} @tab @code{org-export-with-todo-keywords}
10728 @item @code{:priority} @tab @code{org-export-with-priority}
10729 @item @code{:TeX-macros} @tab @code{org-export-with-TeX-macros}
10730 @item @code{:LaTeX-fragments} @tab @code{org-export-with-LaTeX-fragments}
10731 @item @code{:latex-listings} @tab @code{org-export-latex-listings}
10732 @item @code{:skip-before-1st-heading} @tab @code{org-export-skip-text-before-1st-heading}
10733 @item @code{:fixed-width} @tab @code{org-export-with-fixed-width}
10734 @item @code{:timestamps} @tab @code{org-export-with-timestamps}
10735 @item @code{:author-info} @tab @code{org-export-author-info}
10736 @item @code{:email-info} @tab @code{org-export-email-info}
10737 @item @code{:creator-info} @tab @code{org-export-creator-info}
10738 @item @code{:tables} @tab @code{org-export-with-tables}
10739 @item @code{:table-auto-headline} @tab @code{org-export-highlight-first-table-line}
10740 @item @code{:style-include-default} @tab @code{org-export-html-style-include-default}
10741 @item @code{:style} @tab @code{org-export-html-style}
10742 @item @code{:style-extra} @tab @code{org-export-html-style-extra}
10743 @item @code{:convert-org-links} @tab @code{org-export-html-link-org-files-as-html}
10744 @item @code{:inline-images} @tab @code{org-export-html-inline-images}
10745 @item @code{:html-extension} @tab @code{org-export-html-extension}
10746 @item @code{:xml-declaration} @tab @code{org-export-html-xml-declaration}
10747 @item @code{:html-table-tag} @tab @code{org-export-html-table-tag}
10748 @item @code{:expand-quoted-html} @tab @code{org-export-html-expand}
10749 @item @code{:timestamp} @tab @code{org-export-html-with-timestamp}
10750 @item @code{:publishing-directory} @tab @code{org-export-publishing-directory}
10751 @item @code{:preamble} @tab @code{org-export-html-preamble}
10752 @item @code{:postamble} @tab @code{org-export-html-postamble}
10753 @item @code{:auto-preamble} @tab @code{org-export-html-auto-preamble}
10754 @item @code{:auto-postamble} @tab @code{org-export-html-auto-postamble}
10755 @item @code{:author} @tab @code{user-full-name}
10756 @item @code{:email} @tab @code{user-mail-address} : @code{addr;addr;..}
10757 @item @code{:select-tags} @tab @code{org-export-select-tags}
10758 @item @code{:exclude-tags} @tab @code{org-export-exclude-tags}
10759 @item @code{:latex-image-options} @tab @code{org-export-latex-image-default-option}
10762 Most of the @code{org-export-with-*} variables have the same effect in
10763 both HTML and La@TeX{} exporters, except for @code{:TeX-macros} and
10764 @code{:LaTeX-fragments}, respectively @code{nil} and @code{t} in the
10767 @vindex org-publish-project-alist
10768 When a property is given a value in @code{org-publish-project-alist},
10769 its setting overrides the value of the corresponding user variable (if
10770 any) during publishing. Options set within a file (@pxref{Export
10771 options}), however, override everything.
10773 @node Publishing links, Sitemap, Publishing options, Configuration
10774 @subsection Links between published files
10775 @cindex links, publishing
10777 To create a link from one Org file to another, you would use
10778 something like @samp{[[file:foo.org][The foo]]} or simply
10779 @samp{file:foo.org.} (@pxref{Hyperlinks}). When published, this link
10780 becomes a link to @file{foo.html}. In this way, you can interlink the
10781 pages of your "org web" project and the links will work as expected when
10782 you publish them to HTML. If you also publish the Org source file and want
10783 to link to that, use an @code{http:} link instead of a @code{file:} link,
10784 because @code{file:} links are converted to link to the corresponding
10787 You may also link to related files, such as images. Provided you are careful
10788 with relative file names, and provided you have also configured Org to upload
10789 the related files, these links will work too. See @ref{Complex example}, for
10790 an example of this usage.
10792 Sometimes an Org file to be published may contain links that are
10793 only valid in your production environment, but not in the publishing
10794 location. In this case, use the property
10796 @multitable @columnfractions 0.4 0.6
10797 @item @code{:link-validation-function}
10798 @tab Function to validate links
10802 to define a function for checking link validity. This function must
10803 accept two arguments, the file name and a directory relative to which
10804 the file name is interpreted in the production environment. If this
10805 function returns @code{nil}, then the HTML generator will only insert a
10806 description into the HTML file, but no link. One option for this
10807 function is @code{org-publish-validate-link} which checks if the given
10808 file is part of any project in @code{org-publish-project-alist}.
10810 @node Sitemap, Generating an index, Publishing links, Configuration
10811 @subsection Generating a sitemap
10812 @cindex sitemap, of published pages
10814 The following properties may be used to control publishing of
10815 a map of files for a given project.
10817 @multitable @columnfractions 0.35 0.65
10818 @item @code{:auto-sitemap}
10819 @tab When non-nil, publish a sitemap during @code{org-publish-current-project}
10820 or @code{org-publish-all}.
10822 @item @code{:sitemap-filename}
10823 @tab Filename for output of sitemap. Defaults to @file{sitemap.org} (which
10824 becomes @file{sitemap.html}).
10826 @item @code{:sitemap-title}
10827 @tab Title of sitemap page. Defaults to name of file.
10829 @item @code{:sitemap-function}
10830 @tab Plug-in function to use for generation of the sitemap.
10831 Defaults to @code{org-publish-org-sitemap}, which generates a plain list
10832 of links to all files in the project.
10834 @item @code{:sitemap-sort-folders}
10835 @tab Where folders should appear in the sitemap. Set this to @code{first}
10836 (default) or @code{last} to display folders first or last,
10837 respectively. Any other value will mix files and folders.
10839 @item @code{:sitemap-alphabetically}
10840 @tab The site map is normally sorted alphabetically. Set this explicitly to
10841 @code{nil} to turn off sorting.
10843 @item @code{:sitemap-ignore-case}
10844 @tab Should sorting be case-sensitive? Default @code{nil}.
10848 @node Generating an index, , Sitemap, Configuration
10849 @subsection Generating an index
10850 @cindex index, in a publishing project
10852 Org-mode can generate an index across the files of a publishing project.
10854 @multitable @columnfractions 0.25 0.75
10855 @item @code{:makeindex}
10856 @tab When non-nil, generate in index in the file @file{theindex.org} and
10857 publish it as @file{theindex.html}.
10860 The file will be create when first publishing a project with the
10861 @code{:makeindex} set. The file only contains a statement @code{#+include:
10862 "theindex.inc"}. You can then built around this include statement by adding
10863 a title, style information etc.
10865 @node Uploading files, Sample configuration, Configuration, Publishing
10866 @section Uploading files
10870 For those people already utilizing third party sync tools such as
10871 @command{rsync} or @command{unison}, it might be preferable not to use the built in
10872 @i{remote} publishing facilities of Org-mode which rely heavily on
10873 Tramp. Tramp, while very useful and powerful, tends not to be
10874 so efficient for multiple file transfer and has been known to cause problems
10877 Specialized synchronization utilities offer several advantages. In addition
10878 to timestamp comparison, they also do content and permissions/attribute
10879 checks. For this reason you might prefer to publish your web to a local
10880 directory (possibly even @i{in place} with your Org files) and then use
10881 @file{unison} or @file{rsync} to do the synchronization with the remote host.
10883 Since Unison (for example) can be configured as to which files to transfer to
10884 a certain remote destination, it can greatly simplify the project publishing
10885 definition. Simply keep all files in the correct location, process your Org
10886 files with @code{org-publish} and let the synchronization tool do the rest.
10887 You do not need, in this scenario, to include attachments such as @file{jpg},
10888 @file{css} or @file{gif} files in the project definition since the 3rd party
10891 Publishing to a local directory is also much faster than to a remote one, so
10892 that you can afford more easily to republish entire projects. If you set
10893 @code{org-publish-use-timestamps-flag} to @code{nil}, you gain the main
10894 benefit of re-including any changed external files such as source example
10895 files you might include with @code{#+INCLUDE}. The timestamp mechanism in
10896 Org is not smart enough to detect if included files have been modified.
10898 @node Sample configuration, Triggering publication, Uploading files, Publishing
10899 @section Sample configuration
10901 Below we provide two example configurations. The first one is a simple
10902 project publishing only a set of Org files. The second example is
10903 more complex, with a multi-component project.
10906 * Simple example:: One-component publishing
10907 * Complex example:: A multi-component publishing example
10910 @node Simple example, Complex example, Sample configuration, Sample configuration
10911 @subsection Example: simple publishing configuration
10913 This example publishes a set of Org files to the @file{public_html}
10914 directory on the local machine.
10917 (setq org-publish-project-alist
10919 :base-directory "~/org/"
10920 :publishing-directory "~/public_html"
10921 :section-numbers nil
10922 :table-of-contents nil
10923 :style "<link rel=\"stylesheet\"
10924 href=\"../other/mystyle.css\"
10925 type=\"text/css\"/>")))
10928 @node Complex example, , Simple example, Sample configuration
10929 @subsection Example: complex publishing configuration
10931 This more complicated example publishes an entire website, including
10932 Org files converted to HTML, image files, Emacs Lisp source code, and
10933 style sheets. The publishing directory is remote and private files are
10936 To ensure that links are preserved, care should be taken to replicate
10937 your directory structure on the web server, and to use relative file
10938 paths. For example, if your Org files are kept in @file{~/org} and your
10939 publishable images in @file{~/images}, you would link to an image with
10942 file:../images/myimage.png
10945 On the web server, the relative path to the image should be the
10946 same. You can accomplish this by setting up an "images" folder in the
10947 right place on the web server, and publishing images to it.
10950 (setq org-publish-project-alist
10952 :base-directory "~/org/"
10953 :base-extension "org"
10954 :publishing-directory "/ssh:user@@host:~/html/notebook/"
10955 :publishing-function org-publish-org-to-html
10956 :exclude "PrivatePage.org" ;; regexp
10958 :section-numbers nil
10959 :table-of-contents nil
10960 :style "<link rel=\"stylesheet\"
10961 href=\"../other/mystyle.css\" type=\"text/css\"/>"
10963 :auto-postamble nil)
10966 :base-directory "~/images/"
10967 :base-extension "jpg\\|gif\\|png"
10968 :publishing-directory "/ssh:user@@host:~/html/images/"
10969 :publishing-function org-publish-attachment)
10972 :base-directory "~/other/"
10973 :base-extension "css\\|el"
10974 :publishing-directory "/ssh:user@@host:~/html/other/"
10975 :publishing-function org-publish-attachment)
10976 ("website" :components ("orgfiles" "images" "other"))))
10979 @node Triggering publication, , Sample configuration, Publishing
10980 @section Triggering publication
10982 Once properly configured, Org can publish with the following commands:
10987 Prompt for a specific project and publish all files that belong to it.
10990 Publish the project containing the current file.
10993 Publish only the current file.
10996 Publish every project.
10999 @vindex org-publish-use-timestamps-flag
11000 Org uses timestamps to track when a file has changed. The above functions
11001 normally only publish changed files. You can override this and force
11002 publishing of all files by giving a prefix argument to any of the commands
11003 above, or by customizing the variable @code{org-publish-use-timestamps-flag}.
11004 This may be necessary in particular if files include other files via
11005 @code{#+SETUPFILE:} or @code{#+INCLUDE:}.
11007 @comment node-name, next, previous, up
11008 @comment Working With Source Code, Miscellaneous, Publishing, Top
11010 @node Working With Source Code, Miscellaneous, Publishing, Top
11011 @chapter Working with source code
11012 @cindex Schulte, Eric
11013 @cindex Davison, Dan
11014 @cindex source code, working with
11016 Source code can be included in Org-mode documents using a @samp{src} block,
11020 #+BEGIN_SRC emacs-lisp
11021 (defun org-xor (a b)
11027 Org-mode provides a number of features for working with live source code,
11028 including editing of code blocks in their native major-mode, evaluation of
11029 code blocks, tangling of code blocks, and exporting code blocks and their
11030 results in several formats. This functionality was contributed by Eric
11031 Schulte and Dan Davison, and was originally named Org-babel.
11033 The following sections describe Org-mode's code block handling facilities.
11036 * Structure of code blocks:: Code block syntax described
11037 * Editing source code:: Language major-mode editing
11038 * Exporting code blocks:: Export contents and/or results
11039 * Extracting source code:: Create pure source code files
11040 * Evaluating code blocks:: Place results of evaluation in the Org-mode buffer
11041 * Library of Babel:: Use and contribute to a library of useful code blocks
11042 * Languages:: List of supported code block languages
11043 * Header arguments:: Configure code block functionality
11044 * Results of evaluation:: How evaluation results are handled
11045 * Noweb reference syntax:: Literate programming in Org-mode
11046 * Key bindings and useful functions:: Work quickly with code blocks
11047 * Batch execution:: Call functions from the command line
11050 @comment node-name, next, previous, up
11051 @comment Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
11053 @node Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
11054 @section Structure of code blocks
11055 @cindex code block, structure
11056 @cindex source code, block structure
11058 The structure of code blocks is as follows:
11062 #+begin_src <language> <switches> <header arguments>
11067 code blocks can also be embedded in text as so called inline code blocks as
11070 src_<language>@{<body>@}
11076 src_<language>[<header arguments>]@{<body>@}
11081 This name is associated with the code block. This is similar to the
11082 @samp{#+tblname} lines that can be used to name tables in Org-mode files.
11083 Referencing the name of a code block makes it possible to evaluate the
11084 block from other places in the file, other files, or from Org-mode table
11085 formulas (see @ref{The spreadsheet}).
11087 The language of the code in the block.
11089 Switches controlling exportation of the code block (see switches discussion in
11090 @ref{Literal examples})
11091 @item <header arguments>
11092 Optional header arguments control many aspects of evaluation, export and
11093 tangling of code blocks. See the @ref{Header arguments}
11094 section. Header arguments can also be set on a per-buffer or per-subtree
11095 basis using properties.
11100 @comment node-name, next, previous, up
11101 @comment Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
11103 @node Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
11104 @section Editing source code
11105 @cindex code block, editing
11106 @cindex source code, editing
11109 Use @kbd{C-c '} to edit the current code block. This brings up
11110 a language major-mode edit buffer containing the body of the code
11111 block. Saving this buffer will write the new contents back to the Org
11112 buffer. Use @kbd{C-c '} again to exit.
11114 The @code{org-src-mode} minor mode will be active in the edit buffer. The
11115 following variables can be used to configure the behavior of the edit
11116 buffer. See also the customization group @code{org-edit-structure} for
11117 further configuration options.
11120 @item org-src-lang-modes
11121 If an Emacs major-mode named @code{<lang>-mode} exists, where
11122 @code{<lang>} is the language named in the header line of the code block,
11123 then the edit buffer will be placed in that major-mode. This variable
11124 can be used to map arbitrary language names to existing major modes.
11125 @item org-src-window-setup
11126 Controls the way Emacs windows are rearranged when the edit buffer is created.
11127 @item org-src-preserve-indentation
11128 This variable is especially useful for tangling languages such as
11129 python, in which whitespace indentation in the output is critical.
11130 @item org-src-ask-before-returning-to-edit-buffer
11131 By default, Org will ask before returning to an open edit buffer. Set
11132 this variable to nil to switch without asking.
11135 @comment node-name, next, previous, up
11136 @comment Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
11138 @node Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
11139 @section Exporting code blocks
11140 @cindex code block, exporting
11141 @cindex source code, exporting
11143 It is possible to export the @emph{contents} of code blocks, the
11144 @emph{results} of code block evaluation, @emph{neither}, or @emph{both}. For
11145 most languages, the default exports the contents of code blocks. However, for
11146 some languages (e.g. @code{ditaa}) the default exports the results of code
11147 block evaluation. For information on exporting code block bodies, see
11148 @ref{Literal examples}.
11150 The @code{:exports} header argument can be used to specify export
11153 @subsubheading Header arguments:
11155 @item :exports code
11156 The default in most languages. The body of the code block is exported, as
11157 described in @ref{Literal examples}.
11158 @item :exports results
11159 The code block will be evaluated and the results will be placed in the
11160 Org-mode buffer for export, either updating previous results of the code
11161 block located anywhere in the buffer or, if no previous results exist,
11162 placing the results immediately after the code block. The body of the code
11163 block will not be exported.
11164 @item :exports both
11165 Both the code block and its results will be exported.
11166 @item :exports none
11167 Neither the code block nor its results will be exported.
11170 It is possible to inhibit the evaluation of code blocks during export.
11171 Setting the the @code{org-export-babel-evaluate} variable to @code{nil} will
11172 ensure that no code blocks are evaluated as part of the export process. This
11173 can be useful in situations where potentially untrusted Org-mode files are
11174 exported in an automated fashion, for example when Org-mode is used as the
11175 markup language for a wiki.
11177 @comment node-name, next, previous, up
11178 @comment Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
11179 @node Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
11180 @section Extracting source code
11181 @cindex source code, extracting
11182 @cindex code block, extracting source code
11184 Creating pure source code files by extracting code from source blocks is
11185 referred to as ``tangling''---a term adopted from the literate programming
11186 community. During ``tangling'' of code blocks their bodies are expanded
11187 using @code{org-babel-expand-src-block} which can expand both variable and
11188 ``noweb'' style references (see @ref{Noweb reference syntax}).
11190 @subsubheading Header arguments
11193 The default. The code block is not included in the tangled output.
11195 Include the code block in the tangled output. The output file name is the
11196 name of the org file with the extension @samp{.org} replaced by the extension
11197 for the block language.
11198 @item :tangle filename
11199 Include the code block in the tangled output to file @samp{filename}.
11203 @subsubheading Functions
11205 @item org-babel-tangle
11206 Tangle the current file. Bound to @kbd{C-c C-v t}.
11207 @item org-babel-tangle-file
11208 Choose a file to tangle. Bound to @kbd{C-c C-v f}.
11211 @subsubheading Hooks
11213 @item org-babel-post-tangle-hook
11214 This hook is run from within code files tangled by @code{org-babel-tangle}.
11215 Example applications could include post-processing, compilation or evaluation
11216 of tangled code files.
11219 @node Evaluating code blocks, Library of Babel, Extracting source code, Working With Source Code
11220 @section Evaluating code blocks
11221 @cindex code block, evaluating
11222 @cindex source code, evaluating
11224 Code blocks can be evaluated@footnote{Whenever code is evaluated there is a
11225 potential for that code to do harm. Org-mode provides a number of safeguards
11226 to ensure that it only evaluates code with explicit confirmation from the
11227 user. For information on these safeguards (and on how to disable them) see
11228 @ref{Code evaluation security}.} and the results placed in the Org-mode
11229 buffer. By default, evaluation is only turned on for @code{emacs-lisp} code
11230 blocks, however support exists for evaluating blocks in many languages. See
11231 @ref{Languages} for a list of supported languages. See @ref{Structure of
11232 code blocks} for information on the syntax used to define a code block.
11235 There are a number of ways to evaluate code blocks. The simplest is to press
11236 @kbd{C-c C-c} or @kbd{C-c C-v e} with the point on a code block@footnote{The
11237 @code{org-babel-no-eval-on-ctrl-c-ctrl-c} variable can be used to remove code
11238 evaluation from the @kbd{C-c C-c} key binding.}. This will call the
11239 @code{org-babel-execute-src-block} function to evaluate the block and insert
11240 its results into the Org-mode buffer.
11242 It is also possible to evaluate named code blocks from anywhere in an
11243 Org-mode buffer or an Org-mode table. @code{#+call} (or synonymously
11244 @code{#+function} or @code{#+lob}) lines can be used to remotely execute code
11245 blocks located in the current Org-mode buffer or in the ``Library of Babel''
11246 (see @ref{Library of Babel}). These lines use the following syntax.
11249 #+call: <name>(<arguments>) <header arguments>
11250 #+function: <name>(<arguments>) <header arguments>
11251 #+lob: <name>(<arguments>) <header arguments>
11256 The name of the code block to be evaluated.
11258 Arguments specified in this section will be passed to the code block.
11259 @item <header arguments>
11260 Header arguments can be placed after the function invocation. See
11261 @ref{Header arguments} for more information on header arguments.
11265 @node Library of Babel, Languages, Evaluating code blocks, Working With Source Code
11266 @section Library of Babel
11267 @cindex babel, library of
11268 @cindex source code, library
11269 @cindex code block, library
11271 The ``Library of Babel'' is a library of code blocks
11272 that can be called from any Org-mode file. The library is housed in an
11273 Org-mode file located in the @samp{contrib} directory of Org-mode.
11274 Org-mode users can deposit functions they believe to be generally
11275 useful in the library.
11277 Code blocks defined in the ``Library of Babel'' can be called remotely as if
11278 they were in the current Org-mode buffer (see @ref{Evaluating code blocks}
11279 for information on the syntax of remote code block evaluation).
11282 Code blocks located in any Org-mode file can be loaded into the ``Library of
11283 Babel'' with the @code{org-babel-lob-ingest} function, bound to @kbd{C-c C-v
11286 @node Languages, Header arguments, Library of Babel, Working With Source Code
11288 @cindex babel, languages
11289 @cindex source code, languages
11290 @cindex code block, languages
11292 Code blocks in the following languages are supported.
11294 @multitable @columnfractions 0.28 0.3 0.22 0.2
11295 @item @b{Language} @tab @b{Identifier} @tab @b{Language} @tab @b{Identifier}
11296 @item Asymptote @tab asymptote @tab C @tab C
11297 @item C++ @tab C++ @tab Clojure @tab clojure
11298 @item css @tab css @tab ditaa @tab ditaa
11299 @item Graphviz @tab dot @tab Emacs Lisp @tab emacs-lisp
11300 @item gnuplot @tab gnuplot @tab Haskell @tab haskell
11301 @item LaTeX @tab latex @tab Matlab @tab matlab
11302 @item Mscgen @tab mscgen @tab Objective Caml @tab ocaml
11303 @item Octave @tab octave @tab OZ @tab oz
11304 @item Perl @tab perl @tab Python @tab python
11305 @item R @tab R @tab Ruby @tab ruby
11306 @item Sass @tab sass @tab GNU Screen @tab screen
11307 @item shell @tab sh @tab SQL @tab sql
11308 @item Sqlite @tab sqlite
11311 Language-specific documentation is available for some languages. If
11312 available, it can be found at
11313 @uref{http://orgmode.org/worg/org-contrib/babel/languages}.
11315 The @code{org-babel-load-languages} controls which languages are enabled for
11316 evaluation (by default only @code{emacs-lisp} is enabled). This variable can
11317 be set using the customization interface or by adding code like the following
11318 to your emacs configuration.
11321 The following disables @code{emacs-lisp} evaluation and enables evaluation of
11322 @code{R} code blocks.
11326 (org-babel-do-load-languages
11327 'org-babel-load-languages
11328 '((emacs-lisp . nil)
11332 It is also possible to enable support for a language by loading the related
11333 elisp file with @code{require}.
11336 The following adds support for evaluating @code{clojure} code blocks.
11340 (require 'ob-clojure)
11343 @node Header arguments, Results of evaluation, Languages, Working With Source Code
11344 @section Header arguments
11345 @cindex code block, header arguments
11346 @cindex source code, block header arguments
11348 Code block functionality can be configured with header arguments. This
11349 section provides an overview of the use of header arguments, and then
11350 describes each header argument in detail.
11353 * Using header arguments:: Different ways to set header arguments
11354 * Specific header arguments:: List of header arguments
11357 @node Using header arguments, Specific header arguments, Header arguments, Header arguments
11358 @subsection Using header arguments
11360 The values of header arguments can be set in five different ways, each more
11361 specific (and having higher priority) than the last.
11363 * System-wide header arguments:: Set global default values
11364 * Language-specific header arguments:: Set default values by language
11365 * Buffer-wide header arguments:: Set default values for a specific buffer
11366 * Header arguments in Org-mode properties:: Set default values for a buffer or heading
11367 * Code block specific header arguments:: The most common way to set values
11371 @node System-wide header arguments, Language-specific header arguments, Using header arguments, Using header arguments
11372 @subsubheading System-wide header arguments
11373 @vindex org-babel-default-header-args
11374 System-wide values of header arguments can be specified by customizing the
11375 @code{org-babel-default-header-args} variable:
11379 :results => "replace"
11386 @c org-babel-default-header-args is a variable defined in `org-babel.el'.
11388 @c ((:session . "none")
11389 @c (:results . "replace")
11390 @c (:exports . "code")
11392 @c (:noweb . "no"))
11396 @c Default arguments to use when evaluating a code block.
11399 For example, the following example could be used to set the default value of
11400 @code{:noweb} header arguments to @code{yes}. This would have the effect of
11401 expanding @code{:noweb} references by default when evaluating source code
11405 (setq org-babel-default-header-args
11406 (cons '(:noweb . "yes")
11407 (assq-delete-all :noweb org-babel-default-header-args)))
11410 @node Language-specific header arguments, Buffer-wide header arguments, System-wide header arguments, Using header arguments
11411 @subsubheading Language-specific header arguments
11412 Each language can define its own set of default header arguments. See the
11413 language-specific documentation available online at
11414 @uref{http://orgmode.org/worg/org-contrib/babel}.
11416 @node Buffer-wide header arguments, Header arguments in Org-mode properties, Language-specific header arguments, Using header arguments
11417 @subsubheading Buffer-wide header arguments
11418 Buffer-wide header arguments may be specified through the use of a special
11419 line placed anywhere in an Org-mode file. The line consists of the
11420 @code{#+BABEL:} keyword followed by a series of header arguments which may be
11421 specified using the standard header argument syntax.
11423 For example the following would set @code{session} to @code{*R*}, and
11424 @code{results} to @code{silent} for every code block in the buffer, ensuring
11425 that all execution took place in the same session, and no results would be
11426 inserted into the buffer.
11429 #+BABEL: :session *R* :results silent
11432 @node Header arguments in Org-mode properties, Code block specific header arguments, Buffer-wide header arguments, Using header arguments
11433 @subsubheading Header arguments in Org-mode properties
11435 Header arguments are also read from Org-mode properties (see @ref{Property
11436 syntax}), which can be set on a buffer-wide or per-heading basis. An example
11437 of setting a header argument for all code blocks in a buffer is
11440 #+property: tangle yes
11443 When properties are used to set default header arguments, they are looked up
11444 with inheritance, so the value of the @code{:cache} header argument will default
11445 to @code{yes} in all code blocks in the subtree rooted at the following
11456 @vindex org-babel-default-header-args
11457 Properties defined in this way override the properties set in
11458 @code{org-babel-default-header-args}. It is convenient to use the
11459 @code{org-set-property} function bound to @kbd{C-c C-x p} to set properties
11460 in Org-mode documents.
11462 @node Code block specific header arguments, , Header arguments in Org-mode properties, Using header arguments
11463 @subsubheading Code block specific header arguments
11465 The most common way to assign values to header arguments is at the
11466 code block level. This can be done by listing a sequence of header
11467 arguments and their values as part of the @code{#+begin_src} line.
11468 Properties set in this way override both the values of
11469 @code{org-babel-default-header-args} and header arguments specified as
11470 properties. In the following example, the @code{:results} header argument
11471 is set to @code{silent}, meaning the results of execution will not be
11472 inserted in the buffer, and the @code{:exports} header argument is set to
11473 @code{code}, meaning only the body of the code block will be
11474 preserved on export to HTML or LaTeX.
11477 #+source: factorial
11478 #+begin_src haskell :results silent :exports code :var n=0
11480 fac n = n * fac (n-1)
11484 Similarly, it is possible to set header arguments for inline code blocks:
11487 src_haskell[:exports both]@{fac 5@}
11490 Header arguments for ``Library of Babel'' or function call lines can be set as shown below:
11493 #+call: factorial(n=5) :exports results
11496 @node Specific header arguments, , Using header arguments, Header arguments
11497 @subsection Specific header arguments
11498 The following header arguments are defined:
11501 * var:: Pass arguments to code blocks
11502 * results:: Specify the type of results and how they will
11503 be collected and handled
11504 * file:: Specify a path for file output
11505 * dir:: Specify the default (possibly remote)
11506 directory for code block execution
11507 * exports:: Export code and/or results
11508 * tangle:: Toggle tangling and specify file name
11509 * comments:: Toggle insertion of comments in tangled
11511 * no-expand:: Turn off variable assignment and noweb
11512 expansion during tangling
11513 * session:: Preserve the state of code evaluation
11514 * noweb:: Toggle expansion of noweb references
11515 * cache:: Avoid re-evaluating unchanged code blocks
11516 * hlines:: Handle horizontal lines in tables
11517 * colnames:: Handle column names in tables
11518 * rownames:: Handle row names in tables
11519 * shebang:: Make tangled files executable
11520 * eval:: Limit evaluation of specific code blocks
11523 @node var, results, Specific header arguments, Specific header arguments
11524 @subsubsection @code{:var}
11525 The @code{:var} header argument is used to pass arguments to code blocks.
11526 The specifics of how arguments are included in a code block vary by language;
11527 these are addressed in the language-specific documentation. However, the
11528 syntax used to specify arguments is the same across all languages. The
11529 values passed to arguments can be literal values, values from org-mode tables
11530 and literal example blocks, or the results of other code blocks.
11532 These values can be indexed in a manner similar to arrays---see the
11533 ``indexable variable values'' heading below.
11535 The following syntax is used to pass arguments to code blocks using the
11536 @code{:var} header argument.
11542 where @code{assign} can take one of the following forms
11545 @item literal value
11546 either a string @code{"string"} or a number @code{9}.
11551 #+tblname: example-table
11557 #+source: table-length
11558 #+begin_src emacs-lisp :var table=example-table
11562 #+results: table-length
11566 a code block name, as assigned by @code{#+srcname:}, followed by
11570 #+begin_src emacs-lisp :var length=table-length()
11578 In addition, an argument can be passed to the code block referenced
11579 by @code{:var}. The argument is passed within the parentheses following the
11584 #+begin_src emacs-lisp :var input=8
11592 #+begin_src emacs-lisp :var input=double(input=1)
11601 @subsubheading Alternate argument syntax
11602 It is also possible to specify arguments in a potentially more natural way
11603 using the @code{#+source:} line of a code block. As in the following
11604 example arguments can be packed inside of parenthesis, separated by commas,
11605 following the source name.
11608 #+source: double(input=0, x=2)
11609 #+begin_src emacs-lisp
11614 @subsubheading Indexable variable values
11615 It is possible to reference portions of variable values by ``indexing'' into
11616 the variables. Indexes are 0 based with negative values counting back from
11617 the end. If an index is separated by @code{,}s then each subsequent section
11618 will index into the next deepest nesting or dimension of the value. The
11619 following example assigns the last cell of the first row the table
11620 @code{example-table} to the variable @code{data}:
11623 #+results: example-table
11629 #+begin_src emacs-lisp :var data=example-table[0,-1]
11637 Ranges of variable values can be referenced using two integers separated by a
11638 @code{:}, in which case the entire inclusive range is referenced. For
11639 example the following assigns the middle three rows of @code{example-table}
11643 #+results: example-table
11650 #+begin_src emacs-lisp :var data=example-table[1:3]
11660 Additionally, an empty index, or the single character @code{*}, are both
11661 interpreted to mean the entire range and as such are equivalent to
11662 @code{0:-1}, as shown in the following example in which the entire first
11663 column is referenced.
11666 #+results: example-table
11672 #+begin_src emacs-lisp :var data=example-table[,0]
11680 It is possible to index into the results of code blocks as well as tables.
11681 Any number of dimensions can be indexed. Dimensions are separated from one
11682 another by commas, as shown in the following example.
11686 #+begin_src emacs-lisp
11687 '(((1 2 3) (4 5 6) (7 8 9))
11688 ((10 11 12) (13 14 15) (16 17 18))
11689 ((19 20 21) (22 23 24) (25 26 27)))
11692 #+begin_src emacs-lisp :var data=3D[1,,1]
11700 @node results, file, var, Specific header arguments
11701 @subsubsection @code{:results}
11703 There are three classes of @code{:results} header argument. Only one option of
11704 each type may be supplied per code block.
11708 @b{collection} header arguments specify how the results should be collected
11709 from the code block
11711 @b{type} header arguments specify what type of result the code block will
11712 return---which has implications for how they will be inserted into the
11715 @b{handling} header arguments specify how the results of evaluating the code
11716 block should be handled.
11719 @subsubheading Collection
11720 The following options are mutually exclusive, and specify how the results
11721 should be collected from the code block.
11725 This is the default. The result is the value of the last statement in the
11726 code block. This header argument places the evaluation in functional
11727 mode. Note that in some languages, e.g., python, use of this result type
11728 requires that a @code{return} statement be included in the body of the source
11729 code block. E.g., @code{:results value}.
11730 @item @code{output}
11731 The result is the collection of everything printed to STDOUT during the
11732 execution of the code block. This header argument places the
11733 evaluation in scripting mode. E.g., @code{:results output}.
11736 @subsubheading Type
11738 The following options are mutually exclusive and specify what type of results
11739 the code block will return. By default, results are inserted as either a
11740 table or scalar depending on their value.
11743 @item @code{table}, @code{vector}
11744 The results should be interpreted as an Org-mode table. If a single value is
11745 returned, it will be converted into a table with one row and one column.
11746 E.g., @code{:results value table}.
11747 @item @code{scalar}, @code{verbatim}
11748 The results should be interpreted literally---they will not be
11749 converted into a table. The results will be inserted into the Org-mode
11750 buffer as quoted text. E.g., @code{:results value verbatim}.
11752 The results will be interpreted as the path to a file, and will be inserted
11753 into the Org-mode buffer as a file link. E.g., @code{:results value file}.
11754 @item @code{raw}, @code{org}
11755 The results are interpreted as raw Org-mode code and are inserted directly
11756 into the buffer. If the results look like a table they will be aligned as
11757 such by Org-mode. E.g., @code{:results value raw}.
11759 Results are assumed to be HTML and will be enclosed in a @code{begin_html}
11760 block. E.g., @code{:results value html}.
11762 Results assumed to be LaTeX and are enclosed in a @code{begin_latex} block.
11763 E.g., @code{:results value latex}.
11765 Result are assumed to be parseable code and are enclosed in a code block.
11766 E.g., @code{:results value code}.
11768 The result is converted to pretty-printed code and is enclosed in a code
11769 block. This option currently supports Emacs Lisp, python, and ruby. E.g.,
11770 @code{:results value pp}.
11773 @subsubheading Handling
11774 The following results options indicate what happens with the
11775 results once they are collected.
11778 @item @code{silent}
11779 The results will be echoed in the minibuffer but will not be inserted into
11780 the Org-mode buffer. E.g., @code{:results output silent}.
11781 @item @code{replace}
11782 The default value. Any existing results will be removed, and the new results
11783 will be inserted into the Org-mode buffer in their place. E.g.,
11784 @code{:results output replace}.
11785 @item @code{append}
11786 If there are pre-existing results of the code block then the new results will
11787 be appended to the existing results. Otherwise the new results will be
11788 inserted as with @code{replace}.
11789 @item @code{prepend}
11790 If there are pre-existing results of the code block then the new results will
11791 be prepended to the existing results. Otherwise the new results will be
11792 inserted as with @code{replace}.
11795 @node file, dir, results, Specific header arguments
11796 @subsubsection @code{:file}
11798 The header argument @code{:file} is used to specify a path for file output.
11799 An Org-mode style @code{file:} link is inserted into the buffer as the result
11800 (see @ref{Link format}). Common examples are graphical output from R,
11801 gnuplot, ditaa and LaTeX code blocks.
11803 Note that for some languages, including R, gnuplot, LaTeX and ditaa,
11804 graphical output is sent to the specified file without the file being
11805 referenced explicitly in the code block. See the documentation for the
11806 individual languages for details. In contrast, general purpose languages such
11807 as python and ruby require that the code explicitly create output
11808 corresponding to the path indicated by @code{:file}.
11811 @node dir, exports, file, Specific header arguments
11812 @subsubsection @code{:dir} and remote execution
11814 While the @code{:file} header argument can be used to specify the path to the
11815 output file, @code{:dir} specifies the default directory during code block
11816 execution. If it is absent, then the directory associated with the current
11817 buffer is used. In other words, supplying @code{:dir path} temporarily has
11818 the same effect as changing the current directory with @kbd{M-x cd path}, and
11819 then not supplying @code{:dir}. Under the surface, @code{:dir} simply sets
11820 the value of the Emacs variable @code{default-directory}.
11822 When using @code{:dir}, you should supply a relative path for file output
11823 (e.g. @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which
11824 case that path will be interpreted relative to the default directory.
11826 In other words, if you want your plot to go into a folder called Work in your
11827 home directory, you could use
11830 #+begin_src R :file myplot.png :dir ~/Work
11831 matplot(matrix(rnorm(100), 10), type="l")
11835 @subsubheading Remote execution
11836 A directory on a remote machine can be specified using tramp file syntax, in
11837 which case the code will be evaluated on the remote machine. An example is
11840 #+begin_src R :file plot.png :dir /dand@@yakuba.princeton.edu:
11841 plot(1:10, main=system("hostname", intern=TRUE))
11845 Text results will be returned to the local Org-mode buffer as usual, and file
11846 output will be created on the remote machine with relative paths interpreted
11847 relative to the remote directory. An Org-mode link to the remote file will be
11850 So, in the above example a plot will be created on the remote machine,
11851 and a link of the following form will be inserted in the org buffer:
11854 [[file:/scp:dand@@yakuba.princeton.edu:/home/dand/plot.png][plot.png]]
11857 Most of this functionality follows immediately from the fact that @code{:dir}
11858 sets the value of the Emacs variable @code{default-directory}, thanks to
11859 tramp. Those using XEmacs, or GNU Emacs prior to version 23 may need to
11860 install tramp separately in order for the these features to work correctly.
11862 @subsubheading Further points
11866 If @code{:dir} is used in conjunction with @code{:session}, although it will
11867 determine the starting directory for a new session as expected, no attempt is
11868 currently made to alter the directory associated with an existing session.
11870 @code{:dir} should typically not be used to create files during export with
11871 @code{:exports results} or @code{:exports both}. The reason is that, in order
11872 to retain portability of exported material between machines, during export
11873 links inserted into the buffer will *not* be expanded against @code{default
11874 directory}. Therefore, if @code{default-directory} is altered using
11875 @code{:dir}, it is probable that the file will be created in a location to
11876 which the link does not point.
11879 @node exports, tangle, dir, Specific header arguments
11880 @subsubsection @code{:exports}
11882 The @code{:exports} header argument specifies what should be included in HTML
11883 or LaTeX exports of the Org-mode file.
11887 The default. The body of code is included into the exported file. E.g.,
11888 @code{:exports code}.
11889 @item @code{results}
11890 The result of evaluating the code is included in the exported file. E.g.,
11891 @code{:exports results}.
11893 Both the code and results are included in the exported file. E.g.,
11894 @code{:exports both}.
11896 Nothing is included in the exported file. E.g., @code{:exports none}.
11899 @node tangle, comments, exports, Specific header arguments
11900 @subsubsection @code{:tangle}
11902 The @code{:tangle} header argument specifies whether or not the code
11903 block should be included in tangled extraction of source code files.
11907 The code block is exported to a source code file named after the
11908 basename (name w/o extension) of the Org-mode file. E.g., @code{:tangle
11911 The default. The code block is not exported to a source code file.
11912 E.g., @code{:tangle no}.
11914 Any other string passed to the @code{:tangle} header argument is interpreted
11915 as a file basename to which the block will be exported. E.g., @code{:tangle
11919 @node comments, no-expand, tangle, Specific header arguments
11920 @subsubsection @code{:comments}
11921 By default code blocks are tangled to source-code files without any insertion
11922 of comments beyond those which may already exist in the body of the code
11923 block. The @code{:comments} header argument can be set as follows to control
11924 the insertion of extra comments into the tangled code file.
11928 The default. No extra comments are inserted during tangling.
11930 The code block is wrapped in comments which contain pointers back to the
11931 original Org file from which the code was tangled.
11933 A synonym for ``link'' to maintain backwards compatibility.
11935 Include text from the org-mode file as a comment.
11937 The text is picked from the leading context of the tangled code and is
11938 limited by the nearest headline or source block as the case may be.
11940 Turns on both the ``link'' and ``org'' comment options.
11943 @node no-expand, session, comments, Specific header arguments
11944 @subsubsection @code{:no-expand}
11946 By default, code blocks are expanded with @code{org-babel-expand-src-block}
11947 during tangling. This has the effect of assigning values to variables
11948 specified with @code{:var} (see @ref{var}), and of replacing ``noweb''
11949 references (see @ref{Noweb reference syntax}) with their targets. The
11950 @code{:no-expand} header argument can be used to turn off this behavior.
11952 @node session, noweb, no-expand, Specific header arguments
11953 @subsubsection @code{:session}
11955 The @code{:session} header argument starts a session for an interpreted
11956 language where state is preserved.
11958 By default, a session is not started.
11960 A string passed to the @code{:session} header argument will give the session
11961 a name. This makes it possible to run concurrent sessions for each
11962 interpreted language.
11964 @node noweb, cache, session, Specific header arguments
11965 @subsubsection @code{:noweb}
11967 The @code{:noweb} header argument controls expansion of ``noweb'' style (see
11968 @ref{Noweb reference syntax}) references in a code block. This header
11969 argument can have one of three values: @code{yes} @code{no} or @code{tangle}.
11973 All ``noweb'' syntax references in the body of the code block will be
11974 expanded before the block is evaluated, tangled or exported.
11976 The default. No ``noweb'' syntax specific action is taken on evaluating
11977 code blocks, However, noweb references will still be expanded during
11980 All ``noweb'' syntax references in the body of the code block will be
11981 expanded before the block is tangled, however ``noweb'' references will not
11982 be expanded when the block is evaluated or exported.
11985 @subsubheading Noweb prefix lines
11986 Noweb insertions are now placed behind the line prefix of the
11987 @code{<<reference>>}.
11988 This behavior is illustrated in the following example. Because the
11989 @code{<<example>>} noweb reference appears behind the SQL comment syntax,
11990 each line of the expanded noweb reference will be commented.
12003 -- multi-line body of example
12006 Note that noweb replacement text that does not contain any newlines will not
12007 be affected by this change, so it is still possible to use inline noweb
12010 @node cache, hlines, noweb, Specific header arguments
12011 @subsubsection @code{:cache}
12013 The @code{:cache} header argument controls the use of in-buffer caching of
12014 the results of evaluating code blocks. It can be used to avoid re-evaluating
12015 unchanged code blocks. This header argument can have one of two
12016 values: @code{yes} or @code{no}.
12020 The default. No caching takes place, and the code block will be evaluated
12021 every time it is called.
12023 Every time the code block is run a sha1 hash of the code and arguments
12024 passed to the block will be generated. This hash is packed into the
12025 @code{#+results:} line and will be checked on subsequent
12026 executions of the code block. If the code block has not
12027 changed since the last time it was evaluated, it will not be re-evaluated.
12030 @node hlines, colnames, cache, Specific header arguments
12031 @subsubsection @code{:hlines}
12033 Tables are frequently represented with one or more horizontal lines, or
12034 hlines. The @code{:hlines} argument to a code block accepts the
12035 values @code{yes} or @code{no}, with a default value of @code{no}.
12039 Strips horizontal lines from the input table. In most languages this is the
12040 desired effect because an @code{hline} symbol is interpreted as an unbound
12041 variable and raises an error. Setting @code{:hlines no} or relying on the
12042 default value yields the following results.
12045 #+tblname: many-cols
12052 #+source: echo-table
12053 #+begin_src python :var tab=many-cols
12057 #+results: echo-table
12064 Leaves hlines in the table. Setting @code{:hlines yes} has this effect.
12067 #+tblname: many-cols
12074 #+source: echo-table
12075 #+begin_src python :var tab=many-cols :hlines yes
12079 #+results: echo-table
12088 @node colnames, rownames, hlines, Specific header arguments
12089 @subsubsection @code{:colnames}
12091 The @code{:colnames} header argument accepts the values @code{yes},
12092 @code{no}, or @code{nil} for unassigned. The default value is @code{nil}.
12096 If an input table looks like it has column names
12097 (because its second row is an hline), then the column
12098 names will be removed from the table before
12099 processing, then reapplied to the results.
12102 #+tblname: less-cols
12108 #+srcname: echo-table-again
12109 #+begin_src python :var tab=less-cols
12110 return [[val + '*' for val in row] for row in tab]
12113 #+results: echo-table-again
12121 No column name pre-processing takes place
12124 Column names are removed and reapplied as with @code{nil} even if the table
12125 does not ``look like'' it has column names (i.e. the second row is not an
12129 @node rownames, shebang, colnames, Specific header arguments
12130 @subsubsection @code{:rownames}
12132 The @code{:rownames} header argument can take on the values @code{yes}
12133 or @code{no}, with a default value of @code{no}.
12137 No row name pre-processing will take place.
12140 The first column of the table is removed from the table before processing,
12141 and is then reapplied to the results.
12144 #+tblname: with-rownames
12145 | one | 1 | 2 | 3 | 4 | 5 |
12146 | two | 6 | 7 | 8 | 9 | 10 |
12148 #+srcname: echo-table-once-again
12149 #+begin_src python :var tab=with-rownames :rownames yes
12150 return [[val + 10 for val in row] for row in tab]
12153 #+results: echo-table-once-again
12154 | one | 11 | 12 | 13 | 14 | 15 |
12155 | two | 16 | 17 | 18 | 19 | 20 |
12159 @node shebang, eval, rownames, Specific header arguments
12160 @subsubsection @code{:shebang}
12162 Setting the @code{:shebang} header argument to a string value
12163 (e.g. @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the
12164 first line of any tangled file holding the code block, and the file
12165 permissions of the tangled file are set to make it executable.
12167 @node eval, , shebang, Specific header arguments
12168 @subsubsection @code{:eval}
12169 The @code{:eval} header argument can be used to limit the evaluation of
12170 specific code blocks. @code{:eval} accepts two arguments ``never'' and
12171 ``query''. @code{:eval never} will ensure that a code block is never
12172 evaluated, this can be useful for protecting against the evaluation of
12173 dangerous code blocks. @code{:eval query} will require a query for every
12174 execution of a code block regardless of the value of the
12175 @code{org-confirm-babel-evaluate} variable.
12177 @node Results of evaluation, Noweb reference syntax, Header arguments, Working With Source Code
12178 @section Results of evaluation
12179 @cindex code block, results of evaluation
12180 @cindex source code, results of evaluation
12182 The way in which results are handled depends on whether a session is invoked,
12183 as well as on whether @code{:results value} or @code{:results output} is
12184 used. The following table shows the possibilities:
12186 @multitable @columnfractions 0.26 0.33 0.41
12187 @item @tab @b{Non-session} @tab @b{Session}
12188 @item @code{:results value} @tab value of last expression @tab value of last expression
12189 @item @code{:results output} @tab contents of STDOUT @tab concatenation of interpreter output
12192 Note: With @code{:results value}, the result in both @code{:session} and
12193 non-session is returned to Org-mode as a table (a one- or two-dimensional
12194 vector of strings or numbers) when appropriate.
12196 @subsection Non-session
12197 @subsubsection @code{:results value}
12198 This is the default. Internally, the value is obtained by wrapping the code
12199 in a function definition in the external language, and evaluating that
12200 function. Therefore, code should be written as if it were the body of such a
12201 function. In particular, note that python does not automatically return a
12202 value from a function unless a @code{return} statement is present, and so a
12203 @samp{return} statement will usually be required in python.
12205 This is the only one of the four evaluation contexts in which the code is
12206 automatically wrapped in a function definition.
12208 @subsubsection @code{:results output}
12209 The code is passed to the interpreter as an external process, and the
12210 contents of the standard output stream are returned as text. (In certain
12211 languages this also contains the error output stream; this is an area for
12214 @subsection @code{:session}
12215 @subsubsection @code{:results value}
12216 The code is passed to the interpreter running as an interactive Emacs
12217 inferior process. The result returned is the result of the last evaluation
12218 performed by the interpreter. (This is obtained in a language-specific
12219 manner: the value of the variable @code{_} in python and ruby, and the value
12220 of @code{.Last.value} in R).
12222 @subsubsection @code{:results output}
12223 The code is passed to the interpreter running as an interactive Emacs
12224 inferior process. The result returned is the concatenation of the sequence of
12225 (text) output from the interactive interpreter. Notice that this is not
12226 necessarily the same as what would be sent to @code{STDOUT} if the same code
12227 were passed to a non-interactive interpreter running as an external
12228 process. For example, compare the following two blocks:
12231 #+begin_src python :results output
12242 In non-session mode, the '2' is not printed and does not appear.
12244 #+begin_src python :results output :session
12256 But in @code{:session} mode, the interactive interpreter receives input '2'
12257 and prints out its value, '2'. (Indeed, the other print statements are
12260 @node Noweb reference syntax, Key bindings and useful functions, Results of evaluation, Working With Source Code
12261 @section Noweb reference syntax
12262 @cindex code block, noweb reference
12263 @cindex syntax, noweb
12264 @cindex source code, noweb reference
12266 The ``noweb'' (see @uref{http://www.cs.tufts.edu/~nr/noweb/}) Literate
12267 Programming system allows named blocks of code to be referenced by using the
12268 familiar Noweb syntax:
12271 <<code-block-name>>
12274 When a code block is tangled or evaluated, whether or not ``noweb''
12275 references are expanded depends upon the value of the @code{:noweb} header
12276 argument. If @code{:noweb yes}, then a Noweb reference is expanded before
12277 evaluation. If @code{:noweb no}, the default, then the reference is not
12278 expanded before evaluation.
12280 Note: the default value, @code{:noweb no}, was chosen to ensure that
12281 correct code is not broken in a language, such as Ruby, where
12282 @code{<<arg>>} is a syntactically valid construct. If @code{<<arg>>} is not
12283 syntactically valid in languages that you use, then please consider setting
12286 @node Key bindings and useful functions, Batch execution, Noweb reference syntax, Working With Source Code
12287 @section Key bindings and useful functions
12288 @cindex code block, key bindings
12290 Many common Org-mode key sequences are re-bound depending on
12293 Within a code block, the following key bindings
12296 @multitable @columnfractions 0.25 0.75
12298 @item @kbd{C-c C-c} @tab org-babel-execute-src-block
12300 @item @kbd{C-c C-o} @tab org-babel-open-src-block-result
12302 @item @kbd{C-@key{up}} @tab org-babel-load-in-session
12304 @item @kbd{M-@key{down}} @tab org-babel-pop-to-session
12307 In an Org-mode buffer, the following key bindings are active:
12309 @multitable @columnfractions 0.45 0.55
12311 @kindex C-c C-v C-a
12312 @item @kbd{C-c C-v a} @ @ @r{or} @ @ @kbd{C-c C-v C-a} @tab org-babel-sha1-hash
12314 @kindex C-c C-v C-b
12315 @item @kbd{C-c C-v b} @ @ @r{or} @ @ @kbd{C-c C-v C-b} @tab org-babel-execute-buffer
12317 @kindex C-c C-v C-f
12318 @item @kbd{C-c C-v f} @ @ @r{or} @ @ @kbd{C-c C-v C-f} @tab org-babel-tangle-file
12320 @item @kbd{C-c C-v g} @tab org-babel-goto-named-source-block
12322 @item @kbd{C-c C-v h} @tab org-babel-describe-bindings
12324 @kindex C-c C-v C-l
12325 @item @kbd{C-c C-v l} @ @ @r{or} @ @ @kbd{C-c C-v C-l} @tab org-babel-lob-ingest
12327 @kindex C-c C-v C-p
12328 @item @kbd{C-c C-v p} @ @ @r{or} @ @ @kbd{C-c C-v C-p} @tab org-babel-expand-src-block
12330 @kindex C-c C-v C-s
12331 @item @kbd{C-c C-v s} @ @ @r{or} @ @ @kbd{C-c C-v C-s} @tab org-babel-execute-subtree
12333 @kindex C-c C-v C-t
12334 @item @kbd{C-c C-v t} @ @ @r{or} @ @ @kbd{C-c C-v C-t} @tab org-babel-tangle
12336 @kindex C-c C-v C-z
12337 @item @kbd{C-c C-v z} @ @ @r{or} @ @ @kbd{C-c C-v C-z} @tab org-babel-switch-to-session
12340 @c When possible these keybindings were extended to work when the control key is
12341 @c kept pressed, resulting in the following additional keybindings.
12343 @c @multitable @columnfractions 0.25 0.75
12344 @c @item @kbd{C-c C-v C-a} @tab org-babel-sha1-hash
12345 @c @item @kbd{C-c C-v C-b} @tab org-babel-execute-buffer
12346 @c @item @kbd{C-c C-v C-f} @tab org-babel-tangle-file
12347 @c @item @kbd{C-c C-v C-l} @tab org-babel-lob-ingest
12348 @c @item @kbd{C-c C-v C-p} @tab org-babel-expand-src-block
12349 @c @item @kbd{C-c C-v C-s} @tab org-babel-execute-subtree
12350 @c @item @kbd{C-c C-v C-t} @tab org-babel-tangle
12351 @c @item @kbd{C-c C-v C-z} @tab org-babel-switch-to-session
12354 @node Batch execution, , Key bindings and useful functions, Working With Source Code
12355 @section Batch execution
12356 @cindex code block, batch execution
12357 @cindex source code, batch execution
12359 It is possible to call functions from the command line. This shell
12360 script calls @code{org-babel-tangle} on every one of its arguments.
12362 Be sure to adjust the paths to fit your system.
12366 # -*- mode: shell-script -*-
12368 # tangle files with org-mode
12372 ORGINSTALL="~/src/org/lisp/org-install.el"
12374 # wrap each argument in the code required to call tangle on it
12376 FILES="$FILES \"$i\""
12379 emacs -Q --batch -l $ORGINSTALL \
12381 (add-to-list 'load-path (expand-file-name \"~/src/org/lisp/\"))
12382 (add-to-list 'load-path (expand-file-name \"~/src/org/contrib/lisp/\"))
12383 (require 'org)(require 'org-exp)(require 'ob)(require 'ob-tangle)
12384 (mapc (lambda (file)
12385 (find-file (expand-file-name file \"$DIR\"))
12387 (kill-buffer)) '($FILES)))" 2>&1 |grep tangled
12390 @node Miscellaneous, Hacking, Working With Source Code, Top
12391 @chapter Miscellaneous
12394 * Completion:: M-TAB knows what you need
12395 * Easy Templates:: Quick insertion of structural elements
12396 * Speed keys:: Electric commands at the beginning of a headline
12397 * Code evaluation security:: Org mode files evaluate inline code
12398 * Customization:: Adapting Org to your taste
12399 * In-buffer settings:: Overview of the #+KEYWORDS
12400 * The very busy C-c C-c key:: When in doubt, press C-c C-c
12401 * Clean view:: Getting rid of leading stars in the outline
12402 * TTY keys:: Using Org on a tty
12403 * Interaction:: Other Emacs packages
12407 @node Completion, Easy Templates, Miscellaneous, Miscellaneous
12408 @section Completion
12409 @cindex completion, of @TeX{} symbols
12410 @cindex completion, of TODO keywords
12411 @cindex completion, of dictionary words
12412 @cindex completion, of option keywords
12413 @cindex completion, of tags
12414 @cindex completion, of property keys
12415 @cindex completion, of link abbreviations
12416 @cindex @TeX{} symbol completion
12417 @cindex TODO keywords completion
12418 @cindex dictionary word completion
12419 @cindex option keyword completion
12420 @cindex tag completion
12421 @cindex link abbreviations, completion of
12423 Emacs would not be Emacs without completion, and Org-mode uses it whenever it
12424 makes sense. If you prefer an @i{iswitchb}- or @i{ido}-like interface for
12425 some of the completion prompts, you can specify your preference by setting at
12426 most one of the variables @code{org-completion-use-iswitchb}
12427 @code{org-completion-use-ido}.
12429 Org supports in-buffer completion. This type of completion does
12430 not make use of the minibuffer. You simply type a few letters into
12431 the buffer and use the key to complete text right there.
12434 @kindex M-@key{TAB}
12436 Complete word at point
12439 At the beginning of a headline, complete TODO keywords.
12441 After @samp{\}, complete @TeX{} symbols supported by the exporter.
12443 After @samp{*}, complete headlines in the current buffer so that they
12444 can be used in search links like @samp{[[*find this headline]]}.
12446 After @samp{:} in a headline, complete tags. The list of tags is taken
12447 from the variable @code{org-tag-alist} (possibly set through the
12448 @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
12449 dynamically from all tags used in the current buffer.
12451 After @samp{:} and not in a headline, complete property keys. The list
12452 of keys is constructed dynamically from all keys used in the current
12455 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
12457 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
12458 @samp{OPTIONS} which set file-specific options for Org-mode. When the
12459 option keyword is already complete, pressing @kbd{M-@key{TAB}} again
12460 will insert example settings for this keyword.
12462 In the line after @samp{#+STARTUP: }, complete startup keywords,
12463 i.e. valid keys for this line.
12465 Elsewhere, complete dictionary words using Ispell.
12469 @node Easy Templates, Speed keys, Completion, Miscellaneous
12470 @section Easy Templates
12471 @cindex template insertion
12472 @cindex insertion, of templates
12474 Org-mode supports insertion of empty structural elements (like
12475 @code{#+BEGIN_SRC} and @code{#+END_SRC} pairs) with just a few key
12476 strokes. This is achieved through a native template expansion mechanism.
12477 Note that Emacs has several other template mechanisms which could be used in
12478 a similar way, for example @file{yasnippet}.
12480 To insert a structural element, type a @samp{<}, followed by a template
12481 selector and @kbd{@key{TAB}}. Completion takes effect only when the above
12482 keystrokes are typed on a line by itself.
12484 The following template selectors are currently supported.
12486 @multitable @columnfractions 0.1 0.9
12487 @item @kbd{s} @tab @code{#+begin_src ... #+end_src}
12488 @item @kbd{e} @tab @code{#+begin_example ... #+end_example}
12489 @item @kbd{q} @tab @code{#+begin_quote ... #+end_quote}
12490 @item @kbd{v} @tab @code{#+begin_verse ... #+end_verse}
12491 @item @kbd{c} @tab @code{#+begin_center ... #+end_center}
12492 @item @kbd{l} @tab @code{#+begin_latex ... #+end_latex}
12493 @item @kbd{L} @tab @code{#+latex:}
12494 @item @kbd{h} @tab @code{#+begin_html ... #+end_html}
12495 @item @kbd{H} @tab @code{#+html:}
12496 @item @kbd{a} @tab @code{#+begin_ascii ... #+end_ascii}
12497 @item @kbd{A} @tab @code{#+ascii:}
12498 @item @kbd{i} @tab @code{#+include:} line
12501 For example, on an empty line, typing "<e" and then pressing TAB, will expand
12502 into a complete EXAMPLE template.
12504 You can install additional templates by customizing the variable
12505 @code{org-structure-template-alist}. Refer docstring of the variable for
12506 additional details.
12508 @node Speed keys, Code evaluation security, Easy Templates, Miscellaneous
12509 @section Speed keys
12511 @vindex org-use-speed-commands
12512 @vindex org-speed-commands-user
12514 Single keys can be made to execute commands when the cursor is at the
12515 beginning of a headline, i.e. before the first star. Configure the variable
12516 @code{org-use-speed-commands} to activate this feature. There is a
12517 pre-defined list of commands, and you can add more such commands using the
12518 variable @code{org-speed-commands-user}. Speed keys do not only speed up
12519 navigation and other commands, but they also provide an alternative way to
12520 execute commands bound to keys that are not or not easily available on a tty,
12521 or on a small mobile device with a limited keyboard.
12523 To see which commands are available, activate the feature and press @kbd{?}
12524 with the cursor at the beginning of a headline.
12526 @node Code evaluation security, Customization, Speed keys, Miscellaneous
12527 @section Code evaluation and security issues
12529 Org provides tools to work with the code snippets, including evaluating them.
12531 Running code on your machine always comes with a security risk. Badly
12532 written or malicious code can be executed on purpose or by accident. Org has
12533 default settings which will only evaluate such code if you give explicit
12534 permission to do so, and as a casual user of these features you should leave
12535 these precautions intact.
12537 For people who regularly work with such code, the confirmation prompts can
12538 become annoying, and you might want to turn them off. This can be done, but
12539 you must be aware of the risks that are involved.
12541 Code evaluation can happen under the following circumstances:
12544 @item Source code blocks
12545 Source code blocks can be evaluated during export, or when pressing @kbd{C-c
12546 C-c} in the block. The most important thing to realize here is that Org mode
12547 files which contain code snippets are, in a certain sense, like executable
12548 files. So you should accept them and load them into Emacs only from trusted
12549 sources - just like you would do with a program you install on your computer.
12551 Make sure you know what you are doing before customizing the variables
12552 which take off the default security brakes.
12554 @defopt org-confirm-babel-evaluate
12555 When set to t user is queried before code block evaluation
12558 @item Following @code{shell} and @code{elisp} links
12559 Org has two link types that can directly evaluate code (@pxref{External
12560 links}). These links can be problematic because the code to be evaluated is
12563 @defopt org-confirm-shell-link-function
12564 Function to queries user about shell link execution.
12566 @defopt org-confirm-elisp-link-function
12567 Functions to query user for Emacs Lisp link execution.
12570 @item Formulas in tables
12571 Formulas in tables (@pxref{The spreadsheet}) are code that is evaluated
12572 either by the @i{calc} interpreter, or by the @i{Emacs Lisp} interpreter.
12575 @node Customization, In-buffer settings, Code evaluation security, Miscellaneous
12576 @section Customization
12577 @cindex customization
12578 @cindex options, for customization
12579 @cindex variables, for customization
12581 There are more than 180 variables that can be used to customize
12582 Org. For the sake of compactness of the manual, I am not
12583 describing the variables here. A structured overview of customization
12584 variables is available with @kbd{M-x org-customize}. Or select
12585 @code{Browse Org Group} from the @code{Org->Customization} menu. Many
12586 settings can also be activated on a per-file basis, by putting special
12587 lines into the buffer (@pxref{In-buffer settings}).
12589 @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous
12590 @section Summary of in-buffer settings
12591 @cindex in-buffer settings
12592 @cindex special keywords
12594 Org-mode uses special lines in the buffer to define settings on a
12595 per-file basis. These lines start with a @samp{#+} followed by a
12596 keyword, a colon, and then individual words defining a setting. Several
12597 setting words can be in the same line, but you can also have multiple
12598 lines for the keyword. While these settings are described throughout
12599 the manual, here is a summary. After changing any of those lines in the
12600 buffer, press @kbd{C-c C-c} with the cursor still in the line to
12601 activate the changes immediately. Otherwise they become effective only
12602 when the file is visited again in a new Emacs session.
12604 @vindex org-archive-location
12606 @item #+ARCHIVE: %s_done::
12607 This line sets the archive location for the agenda file. It applies for
12608 all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
12609 of the file. The first such line also applies to any entries before it.
12610 The corresponding variable is @code{org-archive-location}.
12612 This line sets the category for the agenda file. The category applies
12613 for all subsequent lines until the next @samp{#+CATEGORY} line, or the
12614 end of the file. The first such line also applies to any entries before it.
12615 @item #+COLUMNS: %25ITEM .....
12616 @cindex property, COLUMNS
12617 Set the default format for columns view. This format applies when
12618 columns view is invoked in locations where no @code{COLUMNS} property
12620 @item #+CONSTANTS: name1=value1 ...
12621 @vindex org-table-formula-constants
12622 @vindex org-table-formula
12623 Set file-local values for constants to be used in table formulas. This
12624 line set the local variable @code{org-table-formula-constants-local}.
12625 The global version of this variable is
12626 @code{org-table-formula-constants}.
12627 @item #+FILETAGS: :tag1:tag2:tag3:
12628 Set tags that can be inherited by any entry in the file, including the
12630 @item #+DRAWERS: NAME1 .....
12631 @vindex org-drawers
12632 Set the file-local set of drawers. The corresponding global variable is
12633 @code{org-drawers}.
12634 @item #+LINK: linkword replace
12635 @vindex org-link-abbrev-alist
12636 These lines (several are allowed) specify link abbreviations.
12637 @xref{Link abbreviations}. The corresponding variable is
12638 @code{org-link-abbrev-alist}.
12639 @item #+PRIORITIES: highest lowest default
12640 @vindex org-highest-priority
12641 @vindex org-lowest-priority
12642 @vindex org-default-priority
12643 This line sets the limits and the default for the priorities. All three
12644 must be either letters A-Z or numbers 0-9. The highest priority must
12645 have a lower ASCII number that the lowest priority.
12646 @item #+PROPERTY: Property_Name Value
12647 This line sets a default inheritance value for entries in the current
12648 buffer, most useful for specifying the allowed values of a property.
12649 @cindex #+SETUPFILE
12650 @item #+SETUPFILE: file
12651 This line defines a file that holds more in-buffer setup. Normally this is
12652 entirely ignored. Only when the buffer is parsed for option-setting lines
12653 (i.e. when starting Org-mode for a file, when pressing @kbd{C-c C-c} in a
12654 settings line, or when exporting), then the contents of this file are parsed
12655 as if they had been included in the buffer. In particular, the file can be
12656 any other Org-mode file with internal setup. You can visit the file the
12657 cursor is in the line with @kbd{C-c '}.
12660 This line sets options to be used at startup of Org-mode, when an
12661 Org file is being visited.
12663 The first set of options deals with the initial visibility of the outline
12664 tree. The corresponding variable for global default settings is
12665 @code{org-startup-folded}, with a default value @code{t}, which means
12667 @vindex org-startup-folded
12668 @cindex @code{overview}, STARTUP keyword
12669 @cindex @code{content}, STARTUP keyword
12670 @cindex @code{showall}, STARTUP keyword
12671 @cindex @code{showeverything}, STARTUP keyword
12673 overview @r{top-level headlines only}
12674 content @r{all headlines}
12675 showall @r{no folding of any entries}
12676 showeverything @r{show even drawer contents}
12679 @vindex org-startup-indented
12680 @cindex @code{indent}, STARTUP keyword
12681 @cindex @code{noindent}, STARTUP keyword
12682 Dynamic virtual indentation is controlled by the variable
12683 @code{org-startup-indented}@footnote{Emacs 23 and Org-mode 6.29 are required}
12685 indent @r{start with @code{org-indent-mode} turned on}
12686 noindent @r{start with @code{org-indent-mode} turned off}
12689 @vindex org-startup-align-all-tables
12690 Then there are options for aligning tables upon visiting a file. This
12691 is useful in files containing narrowed table columns. The corresponding
12692 variable is @code{org-startup-align-all-tables}, with a default value
12694 @cindex @code{align}, STARTUP keyword
12695 @cindex @code{noalign}, STARTUP keyword
12697 align @r{align all tables}
12698 noalign @r{don't align tables on startup}
12701 @vindex org-startup-with-inline-images
12702 When visiting a file, inline images can be automatically displayed. The
12703 corresponding variable is @code{org-startup-with-inline-images}, with a
12704 default value @code{nil} to avoid delays when visiting a file.
12705 @cindex @code{inlineimages}, STARTUP keyword
12706 @cindex @code{noinlineimages}, STARTUP keyword
12708 inlineimages @r{show inline images}
12709 noinlineimages @r{don't show inline images on startup}
12712 @vindex org-log-done
12713 @vindex org-log-note-clock-out
12714 @vindex org-log-repeat
12715 Logging the closing and reopening of TODO items and clock intervals can be
12716 configured using these options (see variables @code{org-log-done},
12717 @code{org-log-note-clock-out} and @code{org-log-repeat})
12718 @cindex @code{logdone}, STARTUP keyword
12719 @cindex @code{lognotedone}, STARTUP keyword
12720 @cindex @code{nologdone}, STARTUP keyword
12721 @cindex @code{lognoteclock-out}, STARTUP keyword
12722 @cindex @code{nolognoteclock-out}, STARTUP keyword
12723 @cindex @code{logrepeat}, STARTUP keyword
12724 @cindex @code{lognoterepeat}, STARTUP keyword
12725 @cindex @code{nologrepeat}, STARTUP keyword
12726 @cindex @code{logreschedule}, STARTUP keyword
12727 @cindex @code{lognotereschedule}, STARTUP keyword
12728 @cindex @code{nologreschedule}, STARTUP keyword
12729 @cindex @code{logredeadline}, STARTUP keyword
12730 @cindex @code{lognoteredeadline}, STARTUP keyword
12731 @cindex @code{nologredeadline}, STARTUP keyword
12732 @cindex @code{logrefile}, STARTUP keyword
12733 @cindex @code{lognoterefile}, STARTUP keyword
12734 @cindex @code{nologrefile}, STARTUP keyword
12736 logdone @r{record a timestamp when an item is marked DONE}
12737 lognotedone @r{record timestamp and a note when DONE}
12738 nologdone @r{don't record when items are marked DONE}
12739 logrepeat @r{record a time when reinstating a repeating item}
12740 lognoterepeat @r{record a note when reinstating a repeating item}
12741 nologrepeat @r{do not record when reinstating repeating item}
12742 lognoteclock-out @r{record a note when clocking out}
12743 nolognoteclock-out @r{don't record a note when clocking out}
12744 logreschedule @r{record a timestamp when scheduling time changes}
12745 lognotereschedule @r{record a note when scheduling time changes}
12746 nologreschedule @r{do not record when a scheduling date changes}
12747 logredeadline @r{record a timestamp when deadline changes}
12748 lognoteredeadline @r{record a note when deadline changes}
12749 nologredeadline @r{do not record when a deadline date changes}
12750 logrefile @r{record a timestamp when refiling}
12751 lognoterefile @r{record a note when refiling}
12752 nologrefile @r{do not record when refiling}
12754 @vindex org-hide-leading-stars
12755 @vindex org-odd-levels-only
12756 Here are the options for hiding leading stars in outline headings, and for
12757 indenting outlines. The corresponding variables are
12758 @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
12759 default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
12760 @cindex @code{hidestars}, STARTUP keyword
12761 @cindex @code{showstars}, STARTUP keyword
12762 @cindex @code{odd}, STARTUP keyword
12763 @cindex @code{even}, STARTUP keyword
12765 hidestars @r{make all but one of the stars starting a headline invisible.}
12766 showstars @r{show all stars starting a headline}
12767 indent @r{virtual indentation according to outline level}
12768 noindent @r{no virtual indentation according to outline level}
12769 odd @r{allow only odd outline levels (1,3,...)}
12770 oddeven @r{allow all outline levels}
12772 @vindex org-put-time-stamp-overlays
12773 @vindex org-time-stamp-overlay-formats
12774 To turn on custom format overlays over timestamps (variables
12775 @code{org-put-time-stamp-overlays} and
12776 @code{org-time-stamp-overlay-formats}), use
12777 @cindex @code{customtime}, STARTUP keyword
12779 customtime @r{overlay custom time format}
12781 @vindex constants-unit-system
12782 The following options influence the table spreadsheet (variable
12783 @code{constants-unit-system}).
12784 @cindex @code{constcgs}, STARTUP keyword
12785 @cindex @code{constSI}, STARTUP keyword
12787 constcgs @r{@file{constants.el} should use the c-g-s unit system}
12788 constSI @r{@file{constants.el} should use the SI unit system}
12790 @vindex org-footnote-define-inline
12791 @vindex org-footnote-auto-label
12792 @vindex org-footnote-auto-adjust
12793 To influence footnote settings, use the following keywords. The
12794 corresponding variables are @code{org-footnote-define-inline},
12795 @code{org-footnote-auto-label}, and @code{org-footnote-auto-adjust}.
12796 @cindex @code{fninline}, STARTUP keyword
12797 @cindex @code{nofninline}, STARTUP keyword
12798 @cindex @code{fnlocal}, STARTUP keyword
12799 @cindex @code{fnprompt}, STARTUP keyword
12800 @cindex @code{fnauto}, STARTUP keyword
12801 @cindex @code{fnconfirm}, STARTUP keyword
12802 @cindex @code{fnplain}, STARTUP keyword
12803 @cindex @code{fnadjust}, STARTUP keyword
12804 @cindex @code{nofnadjust}, STARTUP keyword
12806 fninline @r{define footnotes inline}
12807 fnnoinline @r{define footnotes in separate section}
12808 fnlocal @r{define footnotes near first reference, but not inline}
12809 fnprompt @r{prompt for footnote labels}
12810 fnauto @r{create [fn:1]-like labels automatically (default)}
12811 fnconfirm @r{offer automatic label for editing or confirmation}
12812 fnplain @r{create [1]-like labels automatically}
12813 fnadjust @r{automatically renumber and sort footnotes}
12814 nofnadjust @r{do not renumber and sort automatically}
12816 @cindex org-hide-block-startup
12817 To hide blocks on startup, use these keywords. The corresponding variable is
12818 @code{org-hide-block-startup}.
12819 @cindex @code{hideblocks}, STARTUP keyword
12820 @cindex @code{nohideblocks}, STARTUP keyword
12822 hideblocks @r{Hide all begin/end blocks on startup}
12823 nohideblocks @r{Do not hide blocks on startup}
12825 @cindex org-pretty-entities
12826 The the display of entities as UTF8 characters is governed by the variable
12827 @code{org-pretty-entities} and the keywords
12828 @cindex @code{entitiespretty}, STARTUP keyword
12829 @cindex @code{entitiesplain}, STARTUP keyword
12831 entitiespretty @r{Show entities as UTF8 characters where possible}
12832 entitiesplain @r{Leave entities plain}
12834 @item #+TAGS: TAG1(c1) TAG2(c2)
12835 @vindex org-tag-alist
12836 These lines (several such lines are allowed) specify the valid tags in
12837 this file, and (potentially) the corresponding @emph{fast tag selection}
12838 keys. The corresponding variable is @code{org-tag-alist}.
12840 This line contains the formulas for the table directly above the line.
12841 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+DATE:,
12842 @itemx #+OPTIONS:, #+BIND:, #+XSLT:,
12843 @itemx #+DESCRIPTION:, #+KEYWORDS:,
12844 @itemx #+LATEX_HEADER:, #+STYLE:, #+LINK_UP:, #+LINK_HOME:,
12845 @itemx #+EXPORT_SELECT_TAGS:, #+EXPORT_EXCLUDE_TAGS:
12846 These lines provide settings for exporting files. For more details see
12847 @ref{Export options}.
12848 @item #+TODO: #+SEQ_TODO: #+TYP_TODO:
12849 @vindex org-todo-keywords
12850 These lines set the TODO keywords and their interpretation in the
12851 current file. The corresponding variable is @code{org-todo-keywords}.
12854 @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous
12855 @section The very busy C-c C-c key
12857 @cindex C-c C-c, overview
12859 The key @kbd{C-c C-c} has many purposes in Org, which are all
12860 mentioned scattered throughout this manual. One specific function of
12861 this key is to add @emph{tags} to a headline (@pxref{Tags}). In many
12862 other circumstances it means something like @emph{``Hey Org, look
12863 here and update according to what you see here''}. Here is a summary of
12864 what this means in different contexts.
12868 If there are highlights in the buffer from the creation of a sparse
12869 tree, or from clock display, remove these highlights.
12871 If the cursor is in one of the special @code{#+KEYWORD} lines, this
12872 triggers scanning the buffer for these lines and updating the
12875 If the cursor is inside a table, realign the table. This command
12876 works even if the automatic table editor has been turned off.
12878 If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
12881 If the current buffer is a capture buffer, close the note and file it.
12882 With a prefix argument, file it, without further interaction, to the
12885 If the cursor is on a @code{<<<target>>>}, update radio targets and
12886 corresponding links in this buffer.
12888 If the cursor is in a property line or at the start or end of a property
12889 drawer, offer property commands.
12891 If the cursor is at a footnote reference, go to the corresponding
12892 definition, and vice versa.
12894 If the cursor is on a statistics cookie, update it.
12896 If the cursor is in a plain list item with a checkbox, toggle the status
12899 If the cursor is on a numbered item in a plain list, renumber the
12902 If the cursor is on the @code{#+BEGIN} line of a dynamic block, the
12906 @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous
12907 @section A cleaner outline view
12908 @cindex hiding leading stars
12909 @cindex dynamic indentation
12910 @cindex odd-levels-only outlines
12911 @cindex clean outline view
12913 Some people find it noisy and distracting that the Org headlines start with a
12914 potentially large number of stars, and that text below the headlines is not
12915 indented. While this is no problem when writing a @emph{book-like} document
12916 where the outline headings are really section headings, in a more
12917 @emph{list-oriented} outline, indented structure is a lot cleaner:
12921 * Top level headline | * Top level headline
12922 ** Second level | * Second level
12923 *** 3rd level | * 3rd level
12924 some text | some text
12925 *** 3rd level | * 3rd level
12926 more text | more text
12927 * Another top level headline | * Another top level headline
12933 If you are using at least Emacs 23.2@footnote{Emacs 23.1 can actually crash
12934 with @code{org-indent-mode}} and version 6.29 of Org, this kind of view can
12935 be achieved dynamically at display time using @code{org-indent-mode}. In
12936 this minor mode, all lines are prefixed for display with the necessary amount
12937 of space@footnote{@code{org-indent-mode} also sets the @code{wrap-prefix}
12938 property, such that @code{visual-line-mode} (or purely setting
12939 @code{word-wrap}) wraps long lines (including headlines) correctly indented.
12940 }. Also headlines are prefixed with additional stars, so that the amount of
12941 indentation shifts by two@footnote{See the variable
12942 @code{org-indent-indentation-per-level}.} spaces per level. All headline
12943 stars but the last one are made invisible using the @code{org-hide}
12944 face@footnote{Turning on @code{org-indent-mode} sets
12945 @code{org-hide-leading-stars} to @code{t} and @code{org-adapt-indentation} to
12946 @code{nil}.} - see below under @samp{2.} for more information on how this
12947 works. You can turn on @code{org-indent-mode} for all files by customizing
12948 the variable @code{org-startup-indented}, or you can turn it on for
12949 individual files using
12955 If you want a similar effect in earlier version of Emacs and/or Org, or if
12956 you want the indentation to be hard space characters so that the plain text
12957 file looks as similar as possible to the Emacs display, Org supports you in
12962 @emph{Indentation of text below headlines}@*
12963 You may indent text below each headline to make the left boundary line up
12964 with the headline, like
12968 more text, now indented
12971 @vindex org-adapt-indentation
12972 Org supports this with paragraph filling, line wrapping, and structure
12973 editing@footnote{See also the variable @code{org-adapt-indentation}.},
12974 preserving or adapting the indentation as appropriate.
12977 @vindex org-hide-leading-stars
12978 @emph{Hiding leading stars}@* You can modify the display in such a way that
12979 all leading stars become invisible. To do this in a global way, configure
12980 the variable @code{org-hide-leading-stars} or change this on a per-file basis
12984 #+STARTUP: hidestars
12985 #+STARTUP: showstars
12988 With hidden stars, the tree becomes:
12992 * Top level headline
13000 @vindex org-hide @r{(face)}
13001 The leading stars are not truly replaced by whitespace, they are only
13002 fontified with the face @code{org-hide} that uses the background color as
13003 font color. If you are not using either white or black background, you may
13004 have to customize this face to get the wanted effect. Another possibility is
13005 to set this font such that the extra stars are @i{almost} invisible, for
13006 example using the color @code{grey90} on a white background.
13009 @vindex org-odd-levels-only
13010 Things become cleaner still if you skip all the even levels and use only odd
13011 levels 1, 3, 5..., effectively adding two stars to go from one outline level
13012 to the next@footnote{When you need to specify a level for a property search
13013 or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc@.}. In this
13014 way we get the outline view shown at the beginning of this section. In order
13015 to make the structure editing and export commands handle this convention
13016 correctly, configure the variable @code{org-odd-levels-only}, or set this on
13017 a per-file basis with one of the following lines:
13024 You can convert an Org file from single-star-per-level to the
13025 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
13026 RET} in that file. The reverse operation is @kbd{M-x
13027 org-convert-to-oddeven-levels}.
13030 @node TTY keys, Interaction, Clean view, Miscellaneous
13031 @section Using Org on a tty
13032 @cindex tty key bindings
13034 Because Org contains a large number of commands, by default many of
13035 Org's core commands are bound to keys that are generally not
13036 accessible on a tty, such as the cursor keys (@key{left}, @key{right},
13037 @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
13038 together with modifiers like @key{Meta} and/or @key{Shift}. To access
13039 these commands on a tty when special keys are unavailable, the following
13040 alternative bindings can be used. The tty bindings below will likely be
13041 more cumbersome; you may find for some of the bindings below that a
13042 customized workaround suits you better. For example, changing a timestamp
13043 is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
13044 tty you would rather use @kbd{C-c .} to re-insert the timestamp.
13046 @multitable @columnfractions 0.15 0.2 0.1 0.2
13047 @item @b{Default} @tab @b{Alternative 1} @tab @b{Speed key} @tab @b{Alternative 2}
13048 @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab @kbd{C} @tab
13049 @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{l} @tab @kbd{@key{Esc} @key{left}}
13050 @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab @kbd{L} @tab
13051 @item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{r} @tab @kbd{@key{Esc} @key{right}}
13052 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab @kbd{R} @tab
13053 @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{ } @tab @kbd{@key{Esc} @key{up}}
13054 @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab @kbd{U} @tab
13055 @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{ } @tab @kbd{@key{Esc} @key{down}}
13056 @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab @kbd{D} @tab
13057 @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab @kbd{ } @tab
13058 @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{ } @tab @kbd{@key{Esc} @key{RET}}
13059 @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab @kbd{ } @tab
13060 @item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab @kbd{ } @tab
13061 @item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab @kbd{ } @tab
13062 @item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab @kbd{ } @tab
13063 @item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab @kbd{ } @tab
13064 @item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab @kbd{ } @tab
13065 @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab @kbd{ } @tab
13069 @node Interaction, , TTY keys, Miscellaneous
13070 @section Interaction with other packages
13071 @cindex packages, interaction with other
13072 Org lives in the world of GNU Emacs and interacts in various ways
13073 with other code out there.
13076 * Cooperation:: Packages Org cooperates with
13077 * Conflicts:: Packages that lead to conflicts
13080 @node Cooperation, Conflicts, Interaction, Interaction
13081 @subsection Packages that Org cooperates with
13084 @cindex @file{calc.el}
13085 @cindex Gillespie, Dave
13086 @item @file{calc.el} by Dave Gillespie
13087 Org uses the Calc package for implementing spreadsheet
13088 functionality in its tables (@pxref{The spreadsheet}). Org
13089 checks for the availability of Calc by looking for the function
13090 @code{calc-eval} which will have been autoloaded during setup if Calc has
13091 been installed properly. As of Emacs 22, Calc is part of the Emacs
13092 distribution. Another possibility for interaction between the two
13093 packages is using Calc for embedded calculations. @xref{Embedded Mode,
13094 , Embedded Mode, Calc, GNU Emacs Calc Manual}.
13095 @item @file{constants.el} by Carsten Dominik
13096 @cindex @file{constants.el}
13097 @cindex Dominik, Carsten
13098 @vindex org-table-formula-constants
13099 In a table formula (@pxref{The spreadsheet}), it is possible to use
13100 names for natural constants or units. Instead of defining your own
13101 constants in the variable @code{org-table-formula-constants}, install
13102 the @file{constants} package which defines a large number of constants
13103 and units, and lets you use unit prefixes like @samp{M} for
13104 @samp{Mega}, etc@. You will need version 2.0 of this package, available
13105 at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for
13106 the function @code{constants-get}, which has to be autoloaded in your
13107 setup. See the installation instructions in the file
13108 @file{constants.el}.
13109 @item @file{cdlatex.el} by Carsten Dominik
13110 @cindex @file{cdlatex.el}
13111 @cindex Dominik, Carsten
13112 Org-mode can make use of the CDLa@TeX{} package to efficiently enter
13113 La@TeX{} fragments into Org files. See @ref{CDLaTeX mode}.
13114 @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
13115 @cindex @file{imenu.el}
13116 Imenu allows menu access to an index of items in a file. Org-mode
13117 supports Imenu---all you need to do to get the index is the following:
13119 (add-hook 'org-mode-hook
13120 (lambda () (imenu-add-to-menubar "Imenu")))
13122 @vindex org-imenu-depth
13123 By default the index is two levels deep---you can modify the depth using
13124 the option @code{org-imenu-depth}.
13125 @item @file{remember.el} by John Wiegley
13126 @cindex @file{remember.el}
13127 @cindex Wiegley, John
13128 Org used to use this package for capture, but no longer does.
13129 @item @file{speedbar.el} by Eric M. Ludlam
13130 @cindex @file{speedbar.el}
13131 @cindex Ludlam, Eric M.
13132 Speedbar is a package that creates a special frame displaying files and
13133 index items in files. Org-mode supports Speedbar and allows you to
13134 drill into Org files directly from the Speedbar. It also allows you to
13135 restrict the scope of agenda commands to a file or a subtree by using
13136 the command @kbd{<} in the Speedbar frame.
13137 @cindex @file{table.el}
13138 @item @file{table.el} by Takaaki Ota
13140 @cindex table editor, @file{table.el}
13141 @cindex @file{table.el}
13142 @cindex Ota, Takaaki
13144 Complex ASCII tables with automatic line wrapping, column- and row-spanning,
13145 and alignment can be created using the Emacs table package by Takaaki Ota
13146 (@uref{http://sourceforge.net/projects/table}, and also part of Emacs 22).
13147 Org-mode will recognize these tables and export them properly. Because of
13148 interference with other Org-mode functionality, you unfortunately cannot edit
13149 these tables directly in the buffer. Instead, you need to use the command
13150 @kbd{C-c '} to edit them, similar to source code snippets.
13155 Edit a @file{table.el} table. Works when the cursor is in a table.el table.
13159 Insert a @file{table.el} table. If there is already a table at point, this
13160 command converts it between the @file{table.el} format and the Org-mode
13161 format. See the documentation string of the command
13162 @code{org-convert-table} for the restrictions under which this is
13165 @file{table.el} is part of Emacs since Emacs 22.
13166 @item @file{footnote.el} by Steven L. Baur
13167 @cindex @file{footnote.el}
13168 @cindex Baur, Steven L.
13169 Org-mode recognizes numerical footnotes as provided by this package.
13170 However, Org-mode also has its own footnote support (@pxref{Footnotes}),
13171 which makes using @file{footnote.el} unnecessary.
13174 @node Conflicts, , Cooperation, Interaction
13175 @subsection Packages that lead to conflicts with Org-mode
13179 @cindex @code{shift-selection-mode}
13180 @vindex org-support-shift-select
13181 In Emacs 23, @code{shift-selection-mode} is on by default, meaning that
13182 cursor motions combined with the shift key should start or enlarge regions.
13183 This conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change
13184 timestamps, TODO keywords, priorities, and item bullet types if the cursor is
13185 at such a location. By default, @kbd{S-@key{cursor}} commands outside
13186 special contexts don't do anything, but you can customize the variable
13187 @code{org-support-shift-select}. Org-mode then tries to accommodate shift
13188 selection by (i) using it outside of the special contexts where special
13189 commands apply, and by (ii) extending an existing active region even if the
13190 cursor moves across a special context.
13192 @item @file{CUA.el} by Kim. F. Storm
13193 @cindex @file{CUA.el}
13194 @cindex Storm, Kim. F.
13195 @vindex org-replace-disputed-keys
13196 Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by CUA mode
13197 (as well as @code{pc-select-mode} and @code{s-region-mode}) to select and extend the
13198 region. In fact, Emacs 23 has this built-in in the form of
13199 @code{shift-selection-mode}, see previous paragraph. If you are using Emacs
13200 23, you probably don't want to use another package for this purpose. However,
13201 if you prefer to leave these keys to a different package while working in
13202 Org-mode, configure the variable @code{org-replace-disputed-keys}. When set,
13203 Org will move the following key bindings in Org files, and in the agenda
13204 buffer (but not during date selection).
13207 S-UP -> M-p S-DOWN -> M-n
13208 S-LEFT -> M-- S-RIGHT -> M-+
13209 C-S-LEFT -> M-S-- C-S-RIGHT -> M-S-+
13212 @vindex org-disputed-keys
13213 Yes, these are unfortunately more difficult to remember. If you want
13214 to have other replacement keys, look at the variable
13215 @code{org-disputed-keys}.
13217 @item @file{yasnippet.el}
13218 @cindex @file{yasnippet.el}
13219 The way Org-mode binds the TAB key (binding to @code{[tab]} instead of
13220 @code{"\t"}) overrules yasnippets' access to this key. The following code
13221 fixed this problem:
13224 (add-hook 'org-mode-hook
13226 (org-set-local 'yas/trigger-key [tab])
13227 (define-key yas/keymap [tab] 'yas/next-field-group)))
13230 @item @file{windmove.el} by Hovav Shacham
13231 @cindex @file{windmove.el}
13232 This package also uses the @kbd{S-<cursor>} keys, so everything written
13233 in the paragraph above about CUA mode also applies here. If you want make
13234 the windmove function active in locations where Org-mode does not have
13235 special functionality on @kbd{S-@key{cursor}}, add this to your
13239 ;; Make windmove work in org-mode:
13240 (add-hook 'org-shiftup-final-hook 'windmove-up)
13241 (add-hook 'org-shiftleft-final-hook 'windmove-left)
13242 (add-hook 'org-shiftdown-final-hook 'windmove-down)
13243 (add-hook 'org-shiftright-final-hook 'windmove-right)
13246 @item @file{viper.el} by Michael Kifer
13247 @cindex @file{viper.el}
13249 Viper uses @kbd{C-c /} and therefore makes this key not access the
13250 corresponding Org-mode command @code{org-sparse-tree}. You need to find
13251 another key for this command, or override the key in
13252 @code{viper-vi-global-user-map} with
13255 (define-key viper-vi-global-user-map "C-c /" 'org-sparse-tree)
13261 @node Hacking, MobileOrg, Miscellaneous, Top
13265 This appendix covers some aspects where users can extend the functionality of
13269 * Hooks:: Who to reach into Org's internals
13270 * Add-on packages:: Available extensions
13271 * Adding hyperlink types:: New custom link types
13272 * Context-sensitive commands:: How to add functionality to such commands
13273 * Tables in arbitrary syntax:: Orgtbl for La@TeX{} and other programs
13274 * Dynamic blocks:: Automatically filled blocks
13275 * Special agenda views:: Customized views
13276 * Extracting agenda information:: Postprocessing of agenda information
13277 * Using the property API:: Writing programs that use entry properties
13278 * Using the mapping API:: Mapping over all or selected entries
13281 @node Hooks, Add-on packages, Hacking, Hacking
13285 Org has a large number of hook variables that can be used to add
13286 functionality. This appendix about hacking is going to illustrate the
13287 use of some of them. A complete list of all hooks with documentation is
13288 maintained by the Worg project and can be found at
13289 @uref{http://orgmode.org/worg/org-configs/org-hooks.php}.
13291 @node Add-on packages, Adding hyperlink types, Hooks, Hacking
13292 @section Add-on packages
13293 @cindex add-on packages
13295 A large number of add-on packages have been written by various authors.
13296 These packages are not part of Emacs, but they are distributed as contributed
13297 packages with the separate release available at the Org-mode home page at
13298 @uref{http://orgmode.org}. The list of contributed packages, along with
13299 documentation about each package, is maintained by the Worg project at
13300 @uref{http://orgmode.org/worg/org-contrib/}.
13304 @node Adding hyperlink types, Context-sensitive commands, Add-on packages, Hacking
13305 @section Adding hyperlink types
13306 @cindex hyperlinks, adding new types
13308 Org has a large number of hyperlink types built-in
13309 (@pxref{Hyperlinks}). If you would like to add new link types, Org
13310 provides an interface for doing so. Let's look at an example file,
13311 @file{org-man.el}, that will add support for creating links like
13312 @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
13316 ;;; org-man.el - Support for links to manpages in Org
13320 (org-add-link-type "man" 'org-man-open)
13321 (add-hook 'org-store-link-functions 'org-man-store-link)
13323 (defcustom org-man-command 'man
13324 "The Emacs command to be used to display a man page."
13326 :type '(choice (const man) (const woman)))
13328 (defun org-man-open (path)
13329 "Visit the manpage on PATH.
13330 PATH should be a topic that can be thrown at the man command."
13331 (funcall org-man-command path))
13333 (defun org-man-store-link ()
13334 "Store a link to a manpage."
13335 (when (memq major-mode '(Man-mode woman-mode))
13336 ;; This is a man page, we do make this link
13337 (let* ((page (org-man-get-page-name))
13338 (link (concat "man:" page))
13339 (description (format "Manpage for %s" page)))
13340 (org-store-link-props
13343 :description description))))
13345 (defun org-man-get-page-name ()
13346 "Extract the page name from the buffer name."
13347 ;; This works for both `Man-mode' and `woman-mode'.
13348 (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
13349 (match-string 1 (buffer-name))
13350 (error "Cannot create link to this man page")))
13354 ;;; org-man.el ends here
13358 You would activate this new link type in @file{.emacs} with
13365 Let's go through the file and see what it does.
13368 It does @code{(require 'org)} to make sure that @file{org.el} has been
13371 The next line calls @code{org-add-link-type} to define a new link type
13372 with prefix @samp{man}. The call also contains the name of a function
13373 that will be called to follow such a link.
13375 @vindex org-store-link-functions
13376 The next line adds a function to @code{org-store-link-functions}, in
13377 order to allow the command @kbd{C-c l} to record a useful link in a
13378 buffer displaying a man page.
13381 The rest of the file defines the necessary variables and functions.
13382 First there is a customization variable that determines which Emacs
13383 command should be used to display man pages. There are two options,
13384 @code{man} and @code{woman}. Then the function to follow a link is
13385 defined. It gets the link path as an argument---in this case the link
13386 path is just a topic for the manual command. The function calls the
13387 value of @code{org-man-command} to display the man page.
13389 Finally the function @code{org-man-store-link} is defined. When you try
13390 to store a link with @kbd{C-c l}, this function will be called to
13391 try to make a link. The function must first decide if it is supposed to
13392 create the link for this buffer type; we do this by checking the value
13393 of the variable @code{major-mode}. If not, the function must exit and
13394 return the value @code{nil}. If yes, the link is created by getting the
13395 manual topic from the buffer name and prefixing it with the string
13396 @samp{man:}. Then it must call the command @code{org-store-link-props}
13397 and set the @code{:type} and @code{:link} properties. Optionally you
13398 can also set the @code{:description} property to provide a default for
13399 the link description when the link is later inserted into an Org
13400 buffer with @kbd{C-c C-l}.
13402 When is makes sense for your new link type, you may also define a function
13403 @code{org-PREFIX-complete-link} that implements special (e.g. completion)
13404 support for inserting such a link with @kbd{C-c C-l}. Such a function should
13405 not accept any arguments, and return the full link with prefix.
13407 @node Context-sensitive commands, Tables in arbitrary syntax, Adding hyperlink types, Hacking
13408 @section Context-sensitive commands
13409 @cindex context-sensitive commands, hooks
13410 @cindex add-ons, context-sensitive commands
13411 @vindex org-ctrl-c-ctrl-c-hook
13413 Org has several commands that act differently depending on context. The most
13414 important example it the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}).
13415 Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys have this property.
13417 Add-ons can tap into this functionality by providing a function that detects
13418 special context for that add-on and executes functionality appropriate for
13419 the context. Here is an example from Dan Davison's @file{org-R.el} which
13420 allows you to evaluate commands based on the @file{R} programming language
13421 @footnote{@file{org-R.el} has been replaced by the org-mode functionality
13422 described in @ref{Working With Source Code} and is now obsolete.}. For this
13423 package, special contexts are lines that start with @code{#+R:} or
13427 (defun org-R-apply-maybe ()
13428 "Detect if this is context for org-R and execute R commands."
13429 (if (save-excursion
13430 (beginning-of-line 1)
13431 (looking-at "#\\+RR?:"))
13432 (progn (call-interactively 'org-R-apply)
13433 t) ;; to signal that we took action
13434 nil)) ;; to signal that we did not
13436 (add-hook 'org-ctrl-c-ctrl-c-hook 'org-R-apply-maybe)
13439 The function first checks if the cursor is in such a line. If that is the
13440 case, @code{org-R-apply} is called and the function returns @code{t} to
13441 signal that action was taken, and @kbd{C-c C-c} will stop looking for other
13442 contexts. If the function finds it should do nothing locally, it returns @code{nil} so that other, similar functions can have a try.
13445 @node Tables in arbitrary syntax, Dynamic blocks, Context-sensitive commands, Hacking
13446 @section Tables and lists in arbitrary syntax
13447 @cindex tables, in other modes
13448 @cindex lists, in other modes
13449 @cindex Orgtbl mode
13451 Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
13452 frequent feature request has been to make it work with native tables in
13453 specific languages, for example La@TeX{}. However, this is extremely
13454 hard to do in a general way, would lead to a customization nightmare,
13455 and would take away much of the simplicity of the Orgtbl-mode table
13458 This appendix describes a different approach. We keep the Orgtbl mode
13459 table in its native format (the @i{source table}), and use a custom
13460 function to @i{translate} the table to the correct syntax, and to
13461 @i{install} it in the right location (the @i{target table}). This puts
13462 the burden of writing conversion functions on the user, but it allows
13463 for a very flexible system.
13465 Bastien added the ability to do the same with lists, in Orgstruct mode. You
13466 can use Org's facilities to edit and structure lists by turning
13467 @code{orgstruct-mode} on, then locally exporting such lists in another format
13468 (HTML, La@TeX{} or Texinfo.)
13472 * Radio tables:: Sending and receiving radio tables
13473 * A LaTeX example:: Step by step, almost a tutorial
13474 * Translator functions:: Copy and modify
13475 * Radio lists:: Doing the same for lists
13478 @node Radio tables, A LaTeX example, Tables in arbitrary syntax, Tables in arbitrary syntax
13479 @subsection Radio tables
13480 @cindex radio tables
13482 To define the location of the target table, you first need to create two
13483 lines that are comments in the current mode, but contain magic words for
13484 Orgtbl mode to find. Orgtbl mode will insert the translated table
13485 between these lines, replacing whatever was there before. For example:
13488 /* BEGIN RECEIVE ORGTBL table_name */
13489 /* END RECEIVE ORGTBL table_name */
13493 Just above the source table, we put a special line that tells
13494 Orgtbl mode how to translate this table and where to install it. For
13498 #+ORGTBL: SEND table_name translation_function arguments....
13502 @code{table_name} is the reference name for the table that is also used
13503 in the receiver lines. @code{translation_function} is the Lisp function
13504 that does the translation. Furthermore, the line can contain a list of
13505 arguments (alternating key and value) at the end. The arguments will be
13506 passed as a property list to the translation function for
13507 interpretation. A few standard parameters are already recognized and
13508 acted upon before the translation function is called:
13512 Skip the first N lines of the table. Hlines do count as separate lines for
13515 @item :skipcols (n1 n2 ...)
13516 List of columns that should be skipped. If the table has a column with
13517 calculation marks, that column is automatically discarded as well.
13518 Please note that the translator function sees the table @emph{after} the
13519 removal of these columns, the function never knows that there have been
13520 additional columns.
13524 The one problem remaining is how to keep the source table in the buffer
13525 without disturbing the normal workings of the file, for example during
13526 compilation of a C file or processing of a La@TeX{} file. There are a
13527 number of different solutions:
13531 The table could be placed in a block comment if that is supported by the
13532 language. For example, in C mode you could wrap the table between
13533 @samp{/*} and @samp{*/} lines.
13535 Sometimes it is possible to put the table after some kind of @i{END}
13536 statement, for example @samp{\bye} in @TeX{} and @samp{\end@{document@}}
13539 You can just comment the table line-by-line whenever you want to process
13540 the file, and uncomment it whenever you need to edit the table. This
13541 only sounds tedious---the command @kbd{M-x orgtbl-toggle-comment}
13542 makes this comment-toggling very easy, in particular if you bind it to a
13546 @node A LaTeX example, Translator functions, Radio tables, Tables in arbitrary syntax
13547 @subsection A La@TeX{} example of radio tables
13548 @cindex La@TeX{}, and Orgtbl mode
13550 The best way to wrap the source table in La@TeX{} is to use the
13551 @code{comment} environment provided by @file{comment.sty}. It has to be
13552 activated by placing @code{\usepackage@{comment@}} into the document
13553 header. Orgtbl mode can insert a radio table skeleton@footnote{By
13554 default this works only for La@TeX{}, HTML, and Texinfo. Configure the
13555 variable @code{orgtbl-radio-tables} to install templates for other
13556 modes.} with the command @kbd{M-x orgtbl-insert-radio-table}. You will
13557 be prompted for a table name, let's say we use @samp{salesfigures}. You
13558 will then get the following template:
13560 @cindex #+ORGTBL, SEND
13562 % BEGIN RECEIVE ORGTBL salesfigures
13563 % END RECEIVE ORGTBL salesfigures
13565 #+ORGTBL: SEND salesfigures orgtbl-to-latex
13571 @vindex La@TeX{}-verbatim-environments
13572 The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
13573 @code{orgtbl-to-latex} to convert the table into La@TeX{} and to put it
13574 into the receiver location with name @code{salesfigures}. You may now
13575 fill in the table, feel free to use the spreadsheet features@footnote{If
13576 the @samp{#+TBLFM} line contains an odd number of dollar characters,
13577 this may cause problems with font-lock in La@TeX{} mode. As shown in the
13578 example you can fix this by adding an extra line inside the
13579 @code{comment} environment that is used to balance the dollar
13580 expressions. If you are using AUC@TeX{} with the font-latex library, a
13581 much better solution is to add the @code{comment} environment to the
13582 variable @code{LaTeX-verbatim-environments}.}:
13585 % BEGIN RECEIVE ORGTBL salesfigures
13586 % END RECEIVE ORGTBL salesfigures
13588 #+ORGTBL: SEND salesfigures orgtbl-to-latex
13589 | Month | Days | Nr sold | per day |
13590 |-------+------+---------+---------|
13591 | Jan | 23 | 55 | 2.4 |
13592 | Feb | 21 | 16 | 0.8 |
13593 | March | 22 | 278 | 12.6 |
13594 #+TBLFM: $4=$3/$2;%.1f
13595 % $ (optional extra dollar to keep font-lock happy, see footnote)
13600 When you are done, press @kbd{C-c C-c} in the table to get the converted
13601 table inserted between the two marker lines.
13603 Now let's assume you want to make the table header by hand, because you
13604 want to control how columns are aligned, etc@. In this case we make sure
13605 that the table translator skips the first 2 lines of the source
13606 table, and tell the command to work as a @i{splice}, i.e. to not produce
13607 header and footer commands of the target table:
13610 \begin@{tabular@}@{lrrr@}
13611 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
13612 % BEGIN RECEIVE ORGTBL salesfigures
13613 % END RECEIVE ORGTBL salesfigures
13617 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
13618 | Month | Days | Nr sold | per day |
13619 |-------+------+---------+---------|
13620 | Jan | 23 | 55 | 2.4 |
13621 | Feb | 21 | 16 | 0.8 |
13622 | March | 22 | 278 | 12.6 |
13623 #+TBLFM: $4=$3/$2;%.1f
13627 The La@TeX{} translator function @code{orgtbl-to-latex} is already part of
13628 Orgtbl mode. It uses a @code{tabular} environment to typeset the table
13629 and marks horizontal lines with @code{\hline}. Furthermore, it
13630 interprets the following parameters (see also @pxref{Translator functions}):
13633 @item :splice nil/t
13634 When set to t, return only table body lines, don't wrap them into a
13635 tabular environment. Default is nil.
13638 A format to be used to wrap each field, it should contain @code{%s} for the
13639 original field value. For example, to wrap each field value in dollars,
13640 you could use @code{:fmt "$%s$"}. This may also be a property list with
13641 column numbers and formats. for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
13642 A function of one argument can be used in place of the strings; the
13643 function must return a formatted string.
13646 Use this format to print numbers with exponentials. The format should
13647 have @code{%s} twice for inserting mantissa and exponent, for example
13648 @code{"%s\\times10^@{%s@}"}. The default is @code{"%s\\,(%s)"}. This
13649 may also be a property list with column numbers and formats, for example
13650 @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After
13651 @code{efmt} has been applied to a value, @code{fmt} will also be
13652 applied. Similar to @code{fmt}, functions of two arguments can be
13653 supplied instead of strings.
13656 @node Translator functions, Radio lists, A LaTeX example, Tables in arbitrary syntax
13657 @subsection Translator functions
13658 @cindex HTML, and Orgtbl mode
13659 @cindex translator function
13661 Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
13662 (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
13663 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and @code{orgtbl-to-texinfo}.
13664 Except for @code{orgtbl-to-html}@footnote{The HTML translator uses the same
13665 code that produces tables during HTML export.}, these all use a generic
13666 translator, @code{orgtbl-to-generic}. For example, @code{orgtbl-to-latex}
13667 itself is a very short function that computes the column definitions for the
13668 @code{tabular} environment, defines a few field and line separators and then
13669 hands processing over to the generic translator. Here is the entire code:
13673 (defun orgtbl-to-latex (table params)
13674 "Convert the Orgtbl mode TABLE to LaTeX."
13675 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
13676 org-table-last-alignment ""))
13679 :tstart (concat "\\begin@{tabular@}@{" alignment "@}")
13680 :tend "\\end@{tabular@}"
13681 :lstart "" :lend " \\\\" :sep " & "
13682 :efmt "%s\\,(%s)" :hline "\\hline")))
13683 (orgtbl-to-generic table (org-combine-plists params2 params))))
13687 As you can see, the properties passed into the function (variable
13688 @var{PARAMS}) are combined with the ones newly defined in the function
13689 (variable @var{PARAMS2}). The ones passed into the function (i.e. the
13690 ones set by the @samp{ORGTBL SEND} line) take precedence. So if you
13691 would like to use the La@TeX{} translator, but wanted the line endings to
13692 be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
13693 overrule the default with
13696 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
13699 For a new language, you can either write your own converter function in
13700 analogy with the La@TeX{} translator, or you can use the generic function
13701 directly. For example, if you have a language where a table is started
13702 with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are
13703 started with @samp{!BL!}, ended with @samp{!EL!}, and where the field
13704 separator is a TAB, you could call the generic translator like this (on
13708 #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
13709 :lstart "!BL! " :lend " !EL!" :sep "\t"
13713 Please check the documentation string of the function
13714 @code{orgtbl-to-generic} for a full list of parameters understood by
13715 that function, and remember that you can pass each of them into
13716 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
13717 using the generic function.
13719 Of course you can also write a completely new function doing complicated
13720 things the generic translator cannot do. A translator function takes
13721 two arguments. The first argument is the table, a list of lines, each
13722 line either the symbol @code{hline} or a list of fields. The second
13723 argument is the property list containing all parameters specified in the
13724 @samp{#+ORGTBL: SEND} line. The function must return a single string
13725 containing the formatted table. If you write a generally useful
13726 translator, please post it on @email{emacs-orgmode@@gnu.org} so that
13727 others can benefit from your work.
13729 @node Radio lists, , Translator functions, Tables in arbitrary syntax
13730 @subsection Radio lists
13731 @cindex radio lists
13732 @cindex org-list-insert-radio-list
13734 Sending and receiving radio lists works exactly the same way than sending and
13735 receiving radio tables (@pxref{Radio tables}). As for radio tables, you can
13736 insert radio lists templates in HTML, La@TeX{} and Texinfo modes by calling
13737 @code{org-list-insert-radio-list}.
13739 Here are the differences with radio tables:
13743 Orgstruct mode must be active.
13745 Use the @code{ORGLST} keyword instead of @code{ORGTBL}.
13747 The available translation functions for radio lists don't take
13750 @kbd{C-c C-c} will work when pressed on the first item of the list.
13753 Here is a La@TeX{} example. Let's say that you have this in your
13758 % BEGIN RECEIVE ORGLST to-buy
13759 % END RECEIVE ORGLST to-buy
13761 #+ORGLST: SEND to-buy org-list-to-latex
13770 Pressing `C-c C-c' on @code{a new house} and will insert the converted
13771 La@TeX{} list between the two marker lines.
13773 @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Hacking
13774 @section Dynamic blocks
13775 @cindex dynamic blocks
13777 Org documents can contain @emph{dynamic blocks}. These are
13778 specially marked regions that are updated by some user-written function.
13779 A good example for such a block is the clock table inserted by the
13780 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
13782 Dynamic block are enclosed by a BEGIN-END structure that assigns a name
13783 to the block and can also specify parameters for the function producing
13784 the content of the block.
13786 #+BEGIN:dynamic block
13788 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
13793 Dynamic blocks are updated with the following commands
13796 @kindex C-c C-x C-u
13798 Update dynamic block at point.
13799 @kindex C-u C-c C-x C-u
13800 @item C-u C-c C-x C-u
13801 Update all dynamic blocks in the current file.
13804 Updating a dynamic block means to remove all the text between BEGIN and
13805 END, parse the BEGIN line for parameters and then call the specific
13806 writer function for this block to insert the new content. If you want
13807 to use the original content in the writer function, you can use the
13808 extra parameter @code{:content}.
13810 For a block with name @code{myblock}, the writer function is
13811 @code{org-dblock-write:myblock} with as only parameter a property list
13812 with the parameters given in the begin line. Here is a trivial example
13813 of a block that keeps track of when the block update function was last
13817 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
13823 The corresponding block writer function could look like this:
13826 (defun org-dblock-write:block-update-time (params)
13827 (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
13828 (insert "Last block update at: "
13829 (format-time-string fmt (current-time)))))
13832 If you want to make sure that all dynamic blocks are always up-to-date,
13833 you could add the function @code{org-update-all-dblocks} to a hook, for
13834 example @code{before-save-hook}. @code{org-update-all-dblocks} is
13835 written in a way such that it does nothing in buffers that are not in
13838 @node Special agenda views, Extracting agenda information, Dynamic blocks, Hacking
13839 @section Special agenda views
13840 @cindex agenda views, user-defined
13842 Org provides a special hook that can be used to narrow down the selection
13843 made by these agenda views: @code{todo}, @code{alltodo}, @code{tags}, @code{tags-todo},
13844 @code{tags-tree}. You may specify a function that is used at each match to verify
13845 if the match should indeed be part of the agenda view, and if not, how
13846 much should be skipped.
13848 Let's say you want to produce a list of projects that contain a WAITING
13849 tag anywhere in the project tree. Let's further assume that you have
13850 marked all tree headings that define a project with the TODO keyword
13851 PROJECT. In this case you would run a TODO search for the keyword
13852 PROJECT, but skip the match unless there is a WAITING tag anywhere in
13853 the subtree belonging to the project line.
13855 To achieve this, you must write a function that searches the subtree for
13856 the tag. If the tag is found, the function must return @code{nil} to
13857 indicate that this match should not be skipped. If there is no such
13858 tag, return the location of the end of the subtree, to indicate that
13859 search should continue from there.
13862 (defun my-skip-unless-waiting ()
13863 "Skip trees that are not waiting"
13864 (let ((subtree-end (save-excursion (org-end-of-subtree t))))
13865 (if (re-search-forward ":waiting:" subtree-end t)
13866 nil ; tag found, do not skip
13867 subtree-end))) ; tag not found, continue after end of subtree
13870 Now you may use this function in an agenda custom command, for example
13874 (org-add-agenda-custom-command
13875 '("b" todo "PROJECT"
13876 ((org-agenda-skip-function 'my-skip-unless-waiting)
13877 (org-agenda-overriding-header "Projects waiting for something: "))))
13880 @vindex org-agenda-overriding-header
13881 Note that this also binds @code{org-agenda-overriding-header} to get a
13882 meaningful header in the agenda view.
13884 @vindex org-odd-levels-only
13885 @vindex org-agenda-skip-function
13886 A general way to create custom searches is to base them on a search for
13887 entries with a certain level limit. If you want to study all entries with
13888 your custom search function, simply do a search for
13889 @samp{LEVEL>0}@footnote{Note that, when using @code{org-odd-levels-only}, a
13890 level number corresponds to order in the hierarchy, not to the number of
13891 stars.}, and then use @code{org-agenda-skip-function} to select the entries
13892 you really want to have.
13894 You may also put a Lisp form into @code{org-agenda-skip-function}. In
13895 particular, you may use the functions @code{org-agenda-skip-entry-if}
13896 and @code{org-agenda-skip-subtree-if} in this form, for example:
13899 @item '(org-agenda-skip-entry-if 'scheduled)
13900 Skip current entry if it has been scheduled.
13901 @item '(org-agenda-skip-entry-if 'notscheduled)
13902 Skip current entry if it has not been scheduled.
13903 @item '(org-agenda-skip-entry-if 'deadline)
13904 Skip current entry if it has a deadline.
13905 @item '(org-agenda-skip-entry-if 'scheduled 'deadline)
13906 Skip current entry if it has a deadline, or if it is scheduled.
13907 @item '(org-agenda-skip-entry-if 'todo '("TODO" "WAITING"))
13908 Skip current entry if the TODO keyword is TODO or WAITING.
13909 @item '(org-agenda-skip-entry-if 'todo 'done)
13910 Skip current entry if the TODO keyword marks a DONE state.
13911 @item '(org-agenda-skip-entry-if 'timestamp)
13912 Skip current entry if it has any timestamp, may also be deadline or scheduled.
13913 @item '(org-agenda-skip-entry 'regexp "regular expression")
13914 Skip current entry if the regular expression matches in the entry.
13915 @item '(org-agenda-skip-entry 'notregexp "regular expression")
13916 Skip current entry unless the regular expression matches.
13917 @item '(org-agenda-skip-subtree-if 'regexp "regular expression")
13918 Same as above, but check and skip the entire subtree.
13921 Therefore we could also have written the search for WAITING projects
13922 like this, even without defining a special function:
13925 (org-add-agenda-custom-command
13926 '("b" todo "PROJECT"
13927 ((org-agenda-skip-function '(org-agenda-skip-subtree-if
13928 'regexp ":waiting:"))
13929 (org-agenda-overriding-header "Projects waiting for something: "))))
13932 @node Extracting agenda information, Using the property API, Special agenda views, Hacking
13933 @section Extracting agenda information
13934 @cindex agenda, pipe
13935 @cindex Scripts, for agenda processing
13937 @vindex org-agenda-custom-commands
13938 Org provides commands to access agenda information for the command
13939 line in Emacs batch mode. This extracted information can be sent
13940 directly to a printer, or it can be read by a program that does further
13941 processing of the data. The first of these commands is the function
13942 @code{org-batch-agenda}, that produces an agenda view and sends it as
13943 ASCII text to STDOUT. The command takes a single string as parameter.
13944 If the string has length 1, it is used as a key to one of the commands
13945 you have configured in @code{org-agenda-custom-commands}, basically any
13946 key you can use after @kbd{C-c a}. For example, to directly print the
13947 current TODO list, you could use
13950 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
13953 If the parameter is a string with 2 or more characters, it is used as a
13954 tags/TODO match string. For example, to print your local shopping list
13955 (all items with the tag @samp{shop}, but excluding the tag
13956 @samp{NewYork}), you could use
13959 emacs -batch -l ~/.emacs \
13960 -eval '(org-batch-agenda "+shop-NewYork")' | lpr
13964 You may also modify parameters on the fly like this:
13967 emacs -batch -l ~/.emacs \
13968 -eval '(org-batch-agenda "a" \
13969 org-agenda-ndays 30 \
13970 org-agenda-include-diary nil \
13971 org-agenda-files (quote ("~/org/project.org")))' \
13976 which will produce a 30-day agenda, fully restricted to the Org file
13977 @file{~/org/projects.org}, not even including the diary.
13979 If you want to process the agenda data in more sophisticated ways, you
13980 can use the command @code{org-batch-agenda-csv} to get a comma-separated
13981 list of values for each agenda item. Each line in the output will
13982 contain a number of fields separated by commas. The fields in a line
13986 category @r{The category of the item}
13987 head @r{The headline, without TODO keyword, TAGS and PRIORITY}
13988 type @r{The type of the agenda entry, can be}
13989 todo @r{selected in TODO match}
13990 tagsmatch @r{selected in tags match}
13991 diary @r{imported from diary}
13992 deadline @r{a deadline}
13993 scheduled @r{scheduled}
13994 timestamp @r{appointment, selected by timestamp}
13995 closed @r{entry was closed on date}
13996 upcoming-deadline @r{warning about nearing deadline}
13997 past-scheduled @r{forwarded scheduled item}
13998 block @r{entry has date block including date}
13999 todo @r{The TODO keyword, if any}
14000 tags @r{All tags including inherited ones, separated by colons}
14001 date @r{The relevant date, like 2007-2-14}
14002 time @r{The time, like 15:00-16:50}
14003 extra @r{String with extra planning info}
14004 priority-l @r{The priority letter if any was given}
14005 priority-n @r{The computed numerical priority}
14009 Time and date will only be given if a timestamp (or deadline/scheduled)
14010 led to the selection of the item.
14012 A CSV list like this is very easy to use in a post-processing script.
14013 For example, here is a Perl program that gets the TODO list from
14014 Emacs/Org and prints all the items, preceded by a checkbox:
14019 # define the Emacs command to run
14020 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
14022 # run it and capture the output
14023 $agenda = qx@{$cmd 2>/dev/null@};
14025 # loop over all lines
14026 foreach $line (split(/\n/,$agenda)) @{
14027 # get the individual values
14028 ($category,$head,$type,$todo,$tags,$date,$time,$extra,
14029 $priority_l,$priority_n) = split(/,/,$line);
14030 # process and print
14031 print "[ ] $head\n";
14035 @node Using the property API, Using the mapping API, Extracting agenda information, Hacking
14036 @section Using the property API
14037 @cindex API, for properties
14038 @cindex properties, API
14040 Here is a description of the functions that can be used to work with
14043 @defun org-entry-properties &optional pom which
14044 Get all properties of the entry at point-or-marker POM.@*
14045 This includes the TODO keyword, the tags, time strings for deadline,
14046 scheduled, and clocking, and any additional properties defined in the
14047 entry. The return value is an alist, keys may occur multiple times
14048 if the property key was used several times.@*
14049 POM may also be nil, in which case the current entry is used.
14050 If WHICH is nil or `all', get all properties. If WHICH is
14051 `special' or `standard', only get that subclass.
14053 @vindex org-use-property-inheritance
14054 @defun org-entry-get pom property &optional inherit
14055 Get value of PROPERTY for entry at point-or-marker POM. By default,
14056 this only looks at properties defined locally in the entry. If INHERIT
14057 is non-nil and the entry does not have the property, then also check
14058 higher levels of the hierarchy. If INHERIT is the symbol
14059 @code{selective}, use inheritance if and only if the setting of
14060 @code{org-use-property-inheritance} selects PROPERTY for inheritance.
14063 @defun org-entry-delete pom property
14064 Delete the property PROPERTY from entry at point-or-marker POM.
14067 @defun org-entry-put pom property value
14068 Set PROPERTY to VALUE for entry at point-or-marker POM.
14071 @defun org-buffer-property-keys &optional include-specials
14072 Get all property keys in the current buffer.
14075 @defun org-insert-property-drawer
14076 Insert a property drawer at point.
14079 @defun org-entry-put-multivalued-property pom property &rest values
14080 Set PROPERTY at point-or-marker POM to VALUES. VALUES should be a list of
14081 strings. They will be concatenated, with spaces as separators.
14084 @defun org-entry-get-multivalued-property pom property
14085 Treat the value of the property PROPERTY as a whitespace-separated list of
14086 values and return the values as a list of strings.
14089 @defun org-entry-add-to-multivalued-property pom property value
14090 Treat the value of the property PROPERTY as a whitespace-separated list of
14091 values and make sure that VALUE is in this list.
14094 @defun org-entry-remove-from-multivalued-property pom property value
14095 Treat the value of the property PROPERTY as a whitespace-separated list of
14096 values and make sure that VALUE is @emph{not} in this list.
14099 @defun org-entry-member-in-multivalued-property pom property value
14100 Treat the value of the property PROPERTY as a whitespace-separated list of
14101 values and check if VALUE is in this list.
14104 @defopt org-property-allowed-value-functions
14105 Hook for functions supplying allowed values for specific.
14106 The functions must take a single argument, the name of the property, and
14107 return a flat list of allowed values. If @samp{:ETC} is one of
14108 the values, use the values as completion help, but allow also other values
14109 to be entered. The functions must return @code{nil} if they are not
14110 responsible for this property.
14113 @node Using the mapping API, , Using the property API, Hacking
14114 @section Using the mapping API
14115 @cindex API, for mapping
14116 @cindex mapping entries, API
14118 Org has sophisticated mapping capabilities to find all entries satisfying
14119 certain criteria. Internally, this functionality is used to produce agenda
14120 views, but there is also an API that can be used to execute arbitrary
14121 functions for each or selected entries. The main entry point for this API
14124 @defun org-map-entries func &optional match scope &rest skip
14125 Call FUNC at each headline selected by MATCH in SCOPE.
14127 FUNC is a function or a Lisp form. The function will be called without
14128 arguments, with the cursor positioned at the beginning of the headline.
14129 The return values of all calls to the function will be collected and
14130 returned as a list.
14132 The call to FUNC will be wrapped into a save-excursion form, so FUNC
14133 does not need to preserve point. After evaluation, the cursor will be
14134 moved to the end of the line (presumably of the headline of the
14135 processed entry) and search continues from there. Under some
14136 circumstances, this may not produce the wanted results. For example,
14137 if you have removed (e.g. archived) the current (sub)tree it could
14138 mean that the next entry will be skipped entirely. In such cases, you
14139 can specify the position from where search should continue by making
14140 FUNC set the variable `org-map-continue-from' to the desired buffer
14143 MATCH is a tags/property/todo match as it is used in the agenda match view.
14144 Only headlines that are matched by this query will be considered during
14145 the iteration. When MATCH is nil or t, all headlines will be
14146 visited by the iteration.
14148 SCOPE determines the scope of this command. It can be any of:
14151 nil @r{the current buffer, respecting the restriction if any}
14152 tree @r{the subtree started with the entry at point}
14153 file @r{the current buffer, without restriction}
14155 @r{the current buffer, and any archives associated with it}
14156 agenda @r{all agenda files}
14157 agenda-with-archives
14158 @r{all agenda files with any archive files associated with them}
14160 @r{if this is a list, all files in the list will be scanned}
14163 The remaining args are treated as settings for the skipping facilities of
14164 the scanner. The following items can be given here:
14166 @vindex org-agenda-skip-function
14168 archive @r{skip trees with the archive tag}
14169 comment @r{skip trees with the COMMENT keyword}
14170 function or Lisp form
14171 @r{will be used as value for @code{org-agenda-skip-function},}
14172 @r{so whenever the function returns t, FUNC}
14173 @r{will not be called for that entry and search will}
14174 @r{continue from the point where the function leaves it}
14178 The function given to that mapping routine can really do anything you like.
14179 It can use the property API (@pxref{Using the property API}) to gather more
14180 information about the entry, or in order to change metadata in the entry.
14181 Here are a couple of functions that might be handy:
14183 @defun org-todo &optional arg
14184 Change the TODO state of the entry, see the docstring of the functions for
14185 the many possible values for the argument ARG.
14188 @defun org-priority &optional action
14189 Change the priority of the entry, see the docstring of this function for the
14190 possible values for ACTION.
14193 @defun org-toggle-tag tag &optional onoff
14194 Toggle the tag TAG in the current entry. Setting ONOFF to either @code{on}
14195 or @code{off} will not toggle tag, but ensure that it is either on or off.
14199 Promote the current entry.
14203 Demote the current entry.
14206 Here is a simple example that will turn all entries in the current file with
14207 a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
14208 Entries in comment trees and in archive trees will be ignored.
14212 '(org-todo "UPCOMING")
14213 "+TOMORROW" 'file 'archive 'comment)
14216 The following example counts the number of entries with TODO keyword
14217 @code{WAITING}, in all agenda files.
14220 (length (org-map-entries t "/+WAITING" 'agenda))
14223 @node MobileOrg, History and Acknowledgments, Hacking, Top
14224 @appendix MobileOrg
14228 @uref{http://mobileorg.ncogni.to/, MobileOrg} is an application for the
14229 @i{iPhone/iPod Touch} series of devices, developed by Richard Moreland.
14230 @i{MobileOrg} offers offline viewing and capture support for an Org-mode
14231 system rooted on a ``real'' computer. It does also allow you to record
14232 changes to existing entries. Android users should check out
14233 @uref{http://wiki.github.com/matburt/mobileorg-android/, MobileOrg Android}
14236 This appendix describes the support Org has for creating agenda views in a
14237 format that can be displayed by @i{MobileOrg}, and for integrating notes
14238 captured and changes made by @i{MobileOrg} into the main system.
14240 For changing tags and TODO states in MobileOrg, you should have set up the
14241 customization variables @code{org-todo-keywords} and @code{org-tags-alist} to
14242 cover all important tags and TODO keywords, even if individual files use only
14243 part of these. MobileOrg will also offer you states and tags set up with
14244 in-buffer settings, but it will understand the logistics of TODO state
14245 @i{sets} (@pxref{Per-file keywords}) and @i{mutually exclusive} tags
14246 (@pxref{Setting tags}) only for those set in these variables.
14249 * Setting up the staging area:: Where to interact with the mobile device
14250 * Pushing to MobileOrg:: Uploading Org files and agendas
14251 * Pulling from MobileOrg:: Integrating captured and flagged items
14254 @node Setting up the staging area, Pushing to MobileOrg, MobileOrg, MobileOrg
14255 @section Setting up the staging area
14257 MobileOrg needs to interact with Emacs through directory on a
14258 server@footnote{If you are using a public server, you might prefer to encrypt
14259 the files on the server. This can be done with Org-mode 7.02 and with
14260 MobileOrg 1.5. On the Emacs side, configure the variable
14261 @code{org-mobile-use-encryption}. If you can safely store the password in
14262 your Emacs setup, you might also want to configure
14263 @code{org-mobile-encryption-password}. Please read the docstring of that
14264 variable.}. The easiest way to create that directory is to use a free
14265 @uref{http://dropbox.com,Dropbox.com} account@footnote{If you cannot use
14266 Dropbox, or if your version of MobileOrg does not support it, you can use a
14267 webdav server. For more information, check out the the documentation of
14268 MobileOrg and also this
14269 @uref{http://orgmode.org/worg/org-faq.php#mobileorg_webdav, FAQ entry}.}.
14270 When MobileOrg first connects to your Dropbox, it will create a directory
14271 @i{MobileOrg} inside the Dropbox. After the directory has been created, tell
14275 (setq org-mobile-directory "~/Dropbox/MobileOrg")
14278 Org-mode has commands to put files for @i{MobileOrg} into that directory,
14279 and to read captured notes from there.
14281 @node Pushing to MobileOrg, Pulling from MobileOrg, Setting up the staging area, MobileOrg
14282 @section Pushing to MobileOrg
14284 This operation copies all files currently listed in @code{org-mobile-files}
14285 to the directory @code{org-mobile-directory}. By default this list contains
14286 all agenda files (as listed in @code{org-agenda-files}), but additional files
14287 can be included by customizing @code{org-mobiles-files}. File names will be
14288 staged with path relative to @code{org-directory}, so all files should be
14289 inside this directory. The push operation also creates a special Org file
14290 @file{agendas.org} with all custom agenda view defined by the
14291 user@footnote{While creating the agendas, Org-mode will force ID properties
14292 on all referenced entries, so that these entries can be uniquely identified
14293 if @i{MobileOrg} flags them for further action. If you do not want to get
14294 these properties in so many entries, you can set the variable
14295 @code{org-mobile-force-id-on-agenda-items} to @code{nil}. Org mode will then
14296 rely on outline paths, in the hope that these will be unique enough.}.
14297 Finally, Org writes the file @file{index.org}, containing links to all other
14298 files. @i{MobileOrg} first reads this file from the server, and then
14299 downloads all agendas and Org files listed in it. To speed up the download,
14300 MobileOrg will only read files whose checksums@footnote{stored automatically
14301 in the file @file{checksums.dat}} have changed.
14303 @node Pulling from MobileOrg, , Pushing to MobileOrg, MobileOrg
14304 @section Pulling from MobileOrg
14306 When @i{MobileOrg} synchronizes with the server, it not only pulls the Org
14307 files for viewing. It also appends captured entries and pointers to flagged
14308 and changed entries to the file @file{mobileorg.org} on the server. Org has
14309 a @emph{pull} operation that integrates this information into an inbox file
14310 and operates on the pointers to flagged entries. Here is how it works:
14314 Org moves all entries found in
14315 @file{mobileorg.org}@footnote{@file{mobileorg.org} will be empty after this
14316 operation.} and appends them to the file pointed to by the variable
14317 @code{org-mobile-inbox-for-pull}. Each captured entry and each editing event
14318 will be a top-level entry in the inbox file.
14320 After moving the entries, Org will attempt to implement the changes made in
14321 @i{MobileOrg}. Some changes are applied directly and without user
14322 interaction. Examples are all changes to tags, TODO state, headline and body
14323 text that can be cleanly applied. Entries that have been flagged for further
14324 action will receive a tag @code{:FLAGGED:}, so that they can be easily found
14325 again. When there is a problem finding an entry or applying the change, the
14326 pointer entry will remain in the inbox and will be marked with an error
14327 message. You need to later resolve these issues by hand.
14329 Org will then generate an agenda view with all flagged entries. The user
14330 should then go through these entries and do whatever actions are necessary.
14331 If a note has been stored while flagging an entry in @i{MobileOrg}, that note
14332 will be displayed in the echo area when the cursor is on the corresponding
14337 Pressing @kbd{?} in that special agenda will display the full flagging note in
14338 another window and also push it onto the kill ring. So you could use @kbd{?
14339 z C-y C-c C-c} to store that flagging note as a normal note in the entry.
14340 Pressing @kbd{?} twice in succession will offer to remove the
14341 @code{:FLAGGED:} tag along with the recorded flagging note (which is stored
14342 in a property). In this way you indicate, that the intended processing for
14343 this flagged entry is finished.
14348 If you are not able to process all flagged entries directly, you can always
14349 return to this agenda view using @kbd{C-c a ?}. Note, however, that there is
14350 a subtle difference. The view created automatically by @kbd{M-x
14351 org-mobile-pull @key{RET}} is guaranteed to search all files that have been
14352 addressed by the last pull. This might include a file that is not currently
14353 in your list of agenda files. If you later use @kbd{C-c a ?} to regenerate
14354 the view, only the current agenda files will be searched.
14356 @node History and Acknowledgments, Main Index, MobileOrg, Top
14357 @appendix History and acknowledgments
14358 @cindex acknowledgments
14362 Org was born in 2003, out of frustration over the user interface of the Emacs
14363 Outline mode. I was trying to organize my notes and projects, and using
14364 Emacs seemed to be the natural way to go. However, having to remember eleven
14365 different commands with two or three keys per command, only to hide and show
14366 parts of the outline tree, that seemed entirely unacceptable to me. Also,
14367 when using outlines to take notes, I constantly wanted to restructure the
14368 tree, organizing it parallel to my thoughts and plans. @emph{Visibility
14369 cycling} and @emph{structure editing} were originally implemented in the
14370 package @file{outline-magic.el}, but quickly moved to the more general
14371 @file{org.el}. As this environment became comfortable for project planning,
14372 the next step was adding @emph{TODO entries}, basic @emph{timestamps}, and
14373 @emph{table support}. These areas highlighted the two main goals that Org
14374 still has today: to be a new, outline-based, plain text mode with innovative
14375 and intuitive editing features, and to incorporate project planning
14376 functionality directly into a notes file.
14378 Since the first release, literally thousands of emails to me or to
14379 @email{emacs-orgmode@@gnu.org} have provided a constant stream of bug
14380 reports, feedback, new ideas, and sometimes patches and add-on code.
14381 Many thanks to everyone who has helped to improve this package. I am
14382 trying to keep here a list of the people who had significant influence
14383 in shaping one or more aspects of Org. The list may not be
14384 complete, if I have forgotten someone, please accept my apologies and
14387 Before I get to this list, a few special mentions are in order:
14390 @item Bastien Guerry
14391 Bastien has written a large number of extensions to Org (most of them
14392 integrated into the core by now), including the LaTeX exporter and the plain
14393 list parser. His support during the early days, when he basically acted as
14394 co-maintainer, was central to the success of this project. Bastien also
14395 invented Worg, helped establishing the Web presence of Org, and sponsors
14396 hosting costs for the orgmode.org website.
14397 @item Eric Schulte and Dan Davison
14398 Eric and Dan are jointly responsible for the Org-babel system, which turns
14399 Org into a multi-language environment for evaluating code and doing literate
14400 programming and reproducible research.
14402 John has also contributed a number of great ideas and patches
14403 directly to Org, including the attachment system (@file{org-attach.el}),
14404 integration with Apple Mail (@file{org-mac-message.el}), hierarchical
14405 dependencies of TODO items, habit tracking (@file{org-habits.el}), and
14406 encryption (@file{org-crypt.el}). Also, the capture system is really an
14407 extended copy of his great @file{remember.el}.
14408 @item Sebastian Rose
14409 Without Sebastian, the HTML/XHTML publishing of Org would be the pitiful work
14410 of an ignorant amateur. Sebastian has pushed this part of Org onto a much
14411 higher level. He also wrote @file{org-info.js}, a Java script for displaying
14412 webpages derived from Org using an Info-like or a folding interface with
14413 single-key navigation.
14416 @noindent OK, now to the full list of contributions! Again, please let me
14417 know what I am missing here!
14422 @i{Russel Adams} came up with the idea for drawers.
14424 @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
14426 @i{Christophe Bataillon} created the great unicorn logo that we use on the
14429 @i{Alex Bochannek} provided a patch for rounding timestamps.
14431 @i{Jan Böcker} wrote @file{org-docview.el}.
14433 @i{Brad Bozarth} showed how to pull RSS feed data into Org-mode files.
14435 @i{Tom Breton} wrote @file{org-choose.el}.
14437 @i{Charles Cave}'s suggestion sparked the implementation of templates
14438 for Remember, which are now templates for capture.
14440 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
14443 @i{Gregory Chernov} patched support for Lisp forms into table
14444 calculations and improved XEmacs compatibility, in particular by porting
14445 @file{nouline.el} to XEmacs.
14447 @i{Sacha Chua} suggested copying some linking code from Planner.
14449 @i{Baoqiu Cui} contributed the DocBook exporter.
14451 @i{Eddward DeVilla} proposed and tested checkbox statistics. He also
14452 came up with the idea of properties, and that there should be an API for
14455 @i{Nick Dokos} tracked down several nasty bugs.
14457 @i{Kees Dullemond} used to edit projects lists directly in HTML and so
14458 inspired some of the early development, including HTML export. He also
14459 asked for a way to narrow wide table columns.
14461 @i{Thomas S. Dye} contributed documentation on Worg and helped integrating
14462 the Org-Babel documentation into the manual.
14464 @i{Christian Egli} converted the documentation into Texinfo format,
14465 patched CSS formatting into the HTML exporter, and inspired the agenda.
14467 @i{David Emery} provided a patch for custom CSS support in exported
14470 @i{Nic Ferrier} contributed mailcap and XOXO support.
14472 @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
14474 @i{John Foerch} figured out how to make incremental search show context
14475 around a match in a hidden outline tree.
14477 @i{Raimar Finken} wrote @file{org-git-line.el}.
14479 @i{Mikael Fornius} works as a mailing list moderator.
14481 @i{Austin Frank} works as a mailing list moderator.
14483 @i{Niels Giesen} had the idea to automatically archive DONE trees.
14485 @i{Nicolas Goaziou} rewrote much of the plain list code.
14487 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
14489 @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
14490 task state change logging, and the clocktable. His clear explanations have
14491 been critical when we started to adopt the Git version control system.
14493 @i{Manuel Hermenegildo} has contributed various ideas, small fixes and
14496 @i{Phil Jackson} wrote @file{org-irc.el}.
14498 @i{Scott Jaderholm} proposed footnotes, control over whitespace between
14499 folded entries, and column view for properties.
14501 @i{Matt Jones} wrote @i{MobileOrg Android}.
14503 @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
14505 @i{Shidai Liu} ("Leo") asked for embedded La@TeX{} and tested it. He also
14506 provided frequent feedback and some patches.
14508 @i{Matt Lundin} has proposed last-row references for table formulas and named
14509 invisible anchors. He has also worked a lot on the FAQ.
14511 @i{David Maus} wrote @file{org-atom.el}, maintains the issues file for Org,
14512 and is a prolific contributor on the mailing list with competent replies,
14513 small fixes and patches.
14515 @i{Jason F. McBrayer} suggested agenda export to CSV format.
14517 @i{Max Mikhanosha} came up with the idea of refiling.
14519 @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
14522 @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
14525 @i{Richard Moreland} wrote @i{MobileOrg} for the iPhone.
14527 @i{Rick Moynihan} proposed allowing multiple TODO sequences in a file
14528 and being able to quickly restrict the agenda to a subtree.
14530 @i{Todd Neal} provided patches for links to Info files and Elisp forms.
14532 @i{Greg Newman} refreshed the unicorn logo into its current form.
14534 @i{Tim O'Callaghan} suggested in-file links, search options for general
14535 file links, and TAGS.
14537 @i{Osamu Okano} wrote @file{orgcard2ref.pl}, a perl program to create a text
14538 version of the reference card.
14540 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
14543 @i{Oliver Oppitz} suggested multi-state TODO items.
14545 @i{Scott Otterson} sparked the introduction of descriptive text for
14546 links, among other things.
14548 @i{Pete Phillips} helped during the development of the TAGS feature, and
14549 provided frequent feedback.
14551 @i{Martin Pohlack} provided the code snippet to bundle character insertion
14552 into bundles of 20 for undo.
14554 @i{T.V. Raman} reported bugs and suggested improvements.
14556 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
14559 @i{Paul Rivier} provided the basic implementation of named footnotes. He
14560 also acted as mailing list moderator for some time.
14562 @i{Kevin Rogers} contributed code to access VM files on remote hosts.
14564 @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
14565 conflict with @file{allout.el}.
14567 @i{Jason Riedy} generalized the send-receive mechanism for Orgtbl tables with
14570 @i{Philip Rooke} created the Org reference card, provided lots
14571 of feedback, developed and applied standards to the Org documentation.
14573 @i{Christian Schlauer} proposed angular brackets around links, among
14576 @i{Paul Sexton} wrote @file{org-ctags.el}.
14578 Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
14579 @file{organizer-mode.el}.
14581 @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal
14582 examples, and remote highlighting for referenced code lines.
14584 @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
14585 now packaged into Org's @file{contrib} directory.
14587 @i{Daniel Sinder} came up with the idea of internal archiving by locking
14590 @i{Dale Smith} proposed link abbreviations.
14592 @i{James TD Smith} has contributed a large number of patches for useful
14593 tweaks and features.
14595 @i{Adam Spiers} asked for global linking commands, inspired the link
14596 extension system, added support for mairix, and proposed the mapping API.
14598 @i{Ulf Stegemann} created the table to translate special symbols to HTML,
14599 LaTeX, UTF-8, Latin-1 and ASCII.
14601 @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content
14602 with links transformation to Org syntax.
14604 @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
14605 chapter about publishing.
14607 @i{Stefan Vollmar} organized a video-recorded talk at the
14608 Max-Planck-Institute for Neurology. He also inspired the creation of a
14609 concept index for HTML export.
14611 @i{J@"urgen Vollmer} contributed code generating the table of contents
14614 @i{Samuel Wales} has provided important feedback and bug reports.
14616 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
14619 @i{David Wainberg} suggested archiving, and improvements to the linking
14622 @i{Carsten Wimmer} suggested some changes and helped fix a bug in
14625 @i{Roland Winkler} requested additional key bindings to make Org
14628 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
14629 and contributed various ideas and code snippets.
14633 @node Main Index, Key Index, History and Acknowledgments, Top
14634 @unnumbered Concept index
14638 @node Key Index, Command and Function Index, Main Index, Top
14639 @unnumbered Key index
14643 @node Command and Function Index, Variable Index, Key Index, Top
14644 @unnumbered Command and function index
14648 @node Variable Index, , Command and Function Index, Top
14649 @unnumbered Variable index
14651 This is not a complete index of variables and faces, only the ones that are
14652 mentioned in the manual. For a more complete list, use @kbd{M-x
14653 org-customize @key{RET}} and then click yourself through the tree.
14660 arch-tag: 7893d1Fe-cc57-4d13-b5e5-f494a1CBC7ac
14663 @c Local variables:
14665 @c indent-tabs-mode: nil
14669 @c LocalWords: webdavhost pre