3 @setfilename ../../info/org
4 @settitle The Org Manual
9 @c Version and Contact Info
10 @set MAINTAINERSITE @uref{http://orgmode.org,maintainers webpage}
11 @set AUTHOR Carsten Dominik
12 @set MAINTAINER Carsten Dominik
13 @set MAINTAINEREMAIL @email{carsten at orgmode dot org}
14 @set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer}
20 @c @hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed}
35 @c Subheadings inside a table.
36 @macro tsubheading{text}
46 This manual is for Org version @value{VERSION}.
48 Copyright @copyright{} 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation
51 Permission is granted to copy, distribute and/or modify this document
52 under the terms of the GNU Free Documentation License, Version 1.3 or
53 any later version published by the Free Software Foundation; with no
54 Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
55 and with the Back-Cover Texts as in (a) below. A copy of the license
56 is included in the section entitled ``GNU Free Documentation License.''
58 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
59 modify this GNU manual. Buying copies from the FSF supports it in
60 developing GNU and promoting software freedom.''
62 This document is part of a collection distributed under the GNU Free
63 Documentation License. If you want to distribute this document
64 separately from the collection, you can do so by adding a copy of the
65 license to the document, as described in section 6 of the license.
71 * Org Mode: (org). Outline-based notes management and organizer
77 @subtitle Release @value{VERSION}
78 @author by Carsten Dominik
80 @c The following two commands start the copyright page.
82 @vskip 0pt plus 1filll
86 @c Output the table of contents at the beginning.
90 @node Top, Introduction, (dir), (dir)
97 * Introduction:: Getting started
98 * Document Structure:: A tree works like your brain
99 * Tables:: Pure magic for quick formatting
100 * Hyperlinks:: Notes in context
101 * TODO Items:: Every tree branch can be a TODO item
102 * Tags:: Tagging headlines and matching sets of tags
103 * Properties and Columns:: Storing information about an entry
104 * Dates and Times:: Making items useful for planning
105 * Capture:: Creating tasks and attaching files
106 * Agenda Views:: Collecting information into views
107 * Embedded LaTeX:: LaTeX fragments and formulas
108 * Exporting:: Sharing and publishing of notes
109 * Publishing:: Create a web site of linked Org files
110 * Miscellaneous:: All the rest which did not fit elsewhere
111 * Hacking:: How to hack your way around
112 * History and Acknowledgments:: How Org came into being
113 * Main Index:: An index of Org's concepts and features
114 * Key Index:: Key bindings and where they are described
115 * Variable Index:: Variables mentioned in the manual
118 --- The Detailed Node Listing ---
122 * Summary:: Brief summary of what Org does
123 * Installation:: How to install a downloaded version of Org
124 * Activation:: How to activate Org for certain buffers
125 * Feedback:: Bug reports, ideas, patches etc.
126 * Conventions:: Type-setting conventions in the manual
130 * Outlines:: Org is based on Outline mode
131 * Headlines:: How to typeset Org tree headlines
132 * Visibility cycling:: Show and hide, much simplified
133 * Motion:: Jumping to other headlines
134 * Structure editing:: Changing sequence and level of headlines
135 * Archiving:: Move done task trees to a different place
136 * Sparse trees:: Matches embedded in context
137 * Plain lists:: Additional structure within an entry
138 * Drawers:: Tucking stuff away
139 * Blocks:: Folding blocks
140 * Footnotes:: How footnotes are defined in Org's syntax
141 * Orgstruct mode:: Structure editing outside Org
145 * ARCHIVE tag:: Marking a tree as inactive
146 * Moving subtrees:: Moving a tree to an archive file
150 * Built-in table editor:: Simple tables
151 * Column width and alignment:: Overrule the automatic settings
152 * Column groups:: Grouping to trigger vertical lines
153 * Orgtbl mode:: The table editor as minor mode
154 * The spreadsheet:: The table editor has spreadsheet capabilities
155 * Org-Plot:: Plotting from org tables
159 * References:: How to refer to another field or range
160 * Formula syntax for Calc:: Using Calc to compute stuff
161 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
162 * Field formulas:: Formulas valid for a single field
163 * Column formulas:: Formulas valid for an entire column
164 * Editing and debugging formulas:: Fixing formulas
165 * Updating the table:: Recomputing all dependent fields
166 * Advanced features:: Field names, parameters and automatic recalc
170 * Link format:: How links in Org are formatted
171 * Internal links:: Links to other places in the current file
172 * External links:: URL-like links to the world
173 * Handling links:: Creating, inserting and following
174 * Using links outside Org:: Linking from my C source code?
175 * Link abbreviations:: Shortcuts for writing complex links
176 * Search options:: Linking to a specific location
177 * Custom searches:: When the default search is not enough
181 * Radio targets:: Make targets trigger links in plain text
185 * TODO basics:: Marking and displaying TODO entries
186 * TODO extensions:: Workflow and assignments
187 * Progress logging:: Dates and notes for progress
188 * Priorities:: Some things are more important than others
189 * Breaking down tasks:: Splitting a task into manageable pieces
190 * Checkboxes:: Tick-off lists
192 Extended use of TODO keywords
194 * Workflow states:: From TODO to DONE in steps
195 * TODO types:: I do this, Fred does the rest
196 * Multiple sets in one file:: Mixing it all, and still finding your way
197 * Fast access to TODO states:: Single letter selection of a state
198 * Per-file keywords:: Different files, different requirements
199 * Faces for TODO keywords:: Highlighting states
200 * TODO dependencies:: When one task needs to wait for others
204 * Closing items:: When was this entry marked DONE?
205 * Tracking TODO state changes:: When did the status change?
209 * Tag inheritance:: Tags use the tree structure of the outline
210 * Setting tags:: How to assign tags to a headline
211 * Tag searches:: Searching for combinations of tags
213 Properties and Columns
215 * Property syntax:: How properties are spelled out
216 * Special properties:: Access to other Org mode features
217 * Property searches:: Matching property values
218 * Property inheritance:: Passing values down the tree
219 * Column view:: Tabular viewing and editing
220 * Property API:: Properties for Lisp programmers
224 * Defining columns:: The COLUMNS format property
225 * Using column view:: How to create and use column view
226 * Capturing column view:: A dynamic block for column view
230 * Scope of column definitions:: Where defined, where valid?
231 * Column attributes:: Appearance and content of a column
235 * Timestamps:: Assigning a time to a tree entry
236 * Creating timestamps:: Commands which insert timestamps
237 * Deadlines and scheduling:: Planning your work
238 * Clocking work time:: Tracking how long you spend on a task
239 * Effort estimates:: Planning work effort in advance
240 * Relative timer:: Notes with a running timer
244 * The date/time prompt:: How Org mode helps you entering date and time
245 * Custom time format:: Making dates look different
247 Deadlines and scheduling
249 * Inserting deadline/schedule:: Planning items
250 * Repeated tasks:: Items that show up again and again
254 * Remember:: Capture new tasks/ideas with little interruption
255 * Attachments:: Add files to tasks.
256 * RSS Feeds:: Getting input from RSS feeds
257 * Protocols:: External (@eg Browser) access to Emacs and Org
261 * Setting up Remember for Org:: Some code for .emacs to get things going
262 * Remember templates:: Define the outline of different note types
263 * Storing notes:: Directly get the note to where it belongs
264 * Refiling notes:: Moving a note or task to a project
268 * Agenda files:: Files being searched for agenda information
269 * Agenda dispatcher:: Keyboard access to agenda views
270 * Built-in agenda views:: What is available out of the box?
271 * Presentation and sorting:: How agenda items are prepared for display
272 * Agenda commands:: Remote editing of Org trees
273 * Custom agenda views:: Defining special searches and views
274 * Exporting Agenda Views::
275 * Agenda column view:: Using column view for collected entries
277 The built-in agenda views
279 * Weekly/daily agenda:: The calendar page with current tasks
280 * Global TODO list:: All unfinished action items
281 * Matching tags and properties:: Structured information with fine-tuned search
282 * Timeline:: Time-sorted view for single file
283 * Keyword search:: Finding entries by keyword
284 * Stuck projects:: Find projects you need to review
286 Presentation and sorting
288 * Categories:: Not all tasks are equal
289 * Time-of-day specifications:: How the agenda knows the time
290 * Sorting of agenda items:: The order of things
294 * Storing searches:: Type once, use often
295 * Block agenda:: All the stuff you need in a single buffer
296 * Setting Options:: Changing the rules
300 * Math symbols:: @TeX{} macros for symbols and Greek letters
301 * Subscripts and superscripts:: Simple syntax for raising/lowering text
302 * LaTeX fragments:: Complex formulas made easy
303 * Processing LaTeX fragments:: Previewing La@TeX{} processing
304 * CDLaTeX mode:: Speed up entering of formulas
308 * Markup rules:: Which structures are recognized?
309 * Selective export:: Using tags to select and exclude trees
310 * Export options:: Per-file export settings
311 * The export dispatcher:: How to access exporter commands
312 * ASCII export:: Exporting to plain ASCII
313 * HTML export:: Exporting to HTML
314 * LaTeX and PDF export:: Exporting to La@TeX{}, and processing to PDF
315 * DocBook export:: Exporting to DocBook
316 * XOXO export:: Exporting to XOXO
317 * iCalendar export:: Exporting in iCalendar format
321 * Document title:: How the document title is determined
322 * Headings and sections:: The main structure of the exported document
323 * Table of contents:: If, where, how to create a table of contents
324 * Initial text:: Text before the first headline
325 * Lists:: Plain lists are exported
326 * Paragraphs:: What determines beginning and ending
327 * Literal examples:: Source code and other examples
328 * Include files:: Include the contents of a file during export
329 * Tables exported:: Tables are exported richly
330 * Inlined images:: How to inline images during export
331 * Footnote markup:: ASCII representation of footnotes
332 * Emphasis and monospace:: To bold or not to bold
333 * TeX macros and LaTeX fragments:: Create special, rich export.
334 * Horizontal rules:: A line across the page
335 * Comment lines:: Some lines will not be exported
336 * Macro replacement:: Global replacement of place holders
340 * HTML Export commands:: How to invoke HTML export
341 * Quoting HTML tags:: Using direct HTML in Org mode
342 * Links:: Transformation of links for HTML
343 * Tables in HTML export:: How to modify the formatting of tables
344 * Images in HTML export:: How to insert figures into HTML output
345 * Text areas in HTML export:: An alternative way to show an example
346 * CSS support:: Changing the appearance of the output
347 * Javascript support:: Info and Folding in a web browser
349 La@TeX{} and PDF export
351 * LaTeX/PDF export commands:: Which key invokes which commands
352 * Quoting LaTeX code:: Incorporating literal La@TeX{} code
353 * Sectioning structure:: Changing sectioning in La@TeX{} output
354 * Tables in LaTeX export:: Options for exporting tables to La@TeX{}
355 * Images in LaTeX export:: How to insert figures into La@TeX{} output
359 * DocBook export commands:: How to invoke DocBook export
360 * Quoting DocBook code:: Incorporating DocBook code in Org files
361 * Recursive sections:: Recursive sections in DocBook
362 * Tables in DocBook export:: Tables are exported as HTML tables
363 * Images in DocBook export:: How to insert figures into DocBook output
364 * Special characters:: How to handle special characters
368 * Configuration:: Defining projects
369 * Uploading files:: How to get files up on the server
370 * Sample configuration:: Example projects
371 * Triggering publication:: Publication commands
375 * Project alist:: The central configuration variable
376 * Sources and destinations:: From here to there
377 * Selecting files:: What files are part of the project?
378 * Publishing action:: Setting the function doing the publishing
379 * Publishing options:: Tweaking HTML export
380 * Publishing links:: Which links keep working after publishing?
381 * Project page index:: Publishing a list of project files
385 * Simple example:: One-component publishing
386 * Complex example:: A multi-component publishing example
390 * Completion:: M-TAB knows what you need
391 * Customization:: Adapting Org to your taste
392 * In-buffer settings:: Overview of the #+KEYWORDS
393 * The very busy C-c C-c key:: When in doubt, press C-c C-c
394 * Clean view:: Getting rid of leading stars in the outline
395 * TTY keys:: Using Org on a tty
396 * Interaction:: Other Emacs packages
398 Interaction with other packages
400 * Cooperation:: Packages Org cooperates with
401 * Conflicts:: Packages that lead to conflicts
405 * Hooks:: Who to reach into Org's internals
406 * Add-on packages:: Available extensions
407 * Adding hyperlink types:: New custom link types
408 * Context-sensitive commands:: How to add functionality to such commands
409 * Tables in arbitrary syntax:: Orgtbl for La@TeX{} and other programs
410 * Dynamic blocks:: Automatically filled blocks
411 * Special agenda views:: Customized views
412 * Extracting agenda information:: Postprocessing of agenda information
413 * Using the property API:: Writing programs that use entry properties
414 * Using the mapping API:: Mapping over all or selected entries
416 Tables and lists in arbitrary syntax
418 * Radio tables:: Sending and receiving
419 * A LaTeX example:: Step by step, almost a tutorial
420 * Translator functions:: Copy and modify
421 * Radio lists:: Doing the same for lists
426 @node Introduction, Document Structure, Top, Top
427 @chapter Introduction
431 * Summary:: Brief summary of what Org does
432 * Installation:: How to install a downloaded version of Org
433 * Activation:: How to activate Org for certain buffers
434 * Feedback:: Bug reports, ideas, patches etc.
435 * Conventions:: Type-setting conventions in the manual
438 @node Summary, Installation, Introduction, Introduction
442 Org is a mode for keeping notes, maintaining TODO lists, and doing
443 project planning with a fast and effective plain-text system.
445 Org develops organizational tasks around NOTES files that contain
446 lists or information about projects as plain text. Org is
447 implemented on top of Outline mode, which makes it possible to keep the
448 content of large files well structured. Visibility cycling and
449 structure editing help to work with the tree. Tables are easily created
450 with a built-in table editor. Org supports TODO items, deadlines,
451 timestamps, and scheduling. It dynamically compiles entries into an
452 agenda that utilizes and smoothly integrates much of the Emacs calendar
453 and diary. Plain text URL-like links connect to websites, emails,
454 Usenet messages, BBDB entries, and any files related to the projects.
455 For printing and sharing of notes, an Org file can be exported as a
456 structured ASCII file, as HTML, or (TODO and agenda items only) as an
457 iCalendar file. It can also serve as a publishing tool for a set of
460 An important design aspect that distinguishes Org from, for example,
461 Planner/Muse is that it encourages you to store every piece of information
462 only once. In Planner, you have project pages, day pages and possibly
463 other files, duplicating some information such as tasks. In Org,
464 you only have notes files. In your notes you mark entries as tasks, and
465 label them with tags and timestamps. All necessary lists, like a
466 schedule for the day, the agenda for a meeting, tasks lists selected by
467 tags, etc., are created dynamically when you need them.
469 Org keeps simple things simple. When first fired up, it should
470 feel like a straightforward, easy to use outliner. Complexity is not
471 imposed, but a large amount of functionality is available when you need
472 it. Org is a toolbox and can be used in different ways, for
476 @r{@bullet{} an outline extension with visibility cycling and structure editing}
477 @r{@bullet{} an ASCII system and table editor for taking structured notes}
478 @r{@bullet{} an ASCII table editor with spreadsheet-like capabilities}
479 @r{@bullet{} a TODO list editor}
480 @r{@bullet{} a full agenda and planner with deadlines and work scheduling}
481 @pindex GTD, Getting Things Done
482 @r{@bullet{} an environment to implement David Allen's GTD system}
483 @r{@bullet{} a basic database application}
484 @r{@bullet{} a simple hypertext system, with HTML and La@TeX{} export}
485 @r{@bullet{} a publishing tool to create a set of interlinked webpages}
488 Org's automatic, context-sensitive table editor with spreadsheet
489 capabilities can be integrated into any major mode by activating the
490 minor Orgtbl mode. Using a translation step, it can be used to maintain
491 tables in arbitrary file types, for example in La@TeX{}. The structure
492 editing and list creation capabilities can be used outside Org with
493 the minor Orgstruct mode.
496 There is a website for Org which provides links to the newest
497 version of Org, as well as additional information, frequently asked
498 questions (FAQ), links to tutorials, etc@. This page is located at
499 @uref{http://orgmode.org}.
504 @node Installation, Activation, Summary, Introduction
505 @section Installation
509 @b{Important:} @i{If Org is part of the Emacs distribution or an
510 XEmacs package, please skip this section and go directly to
513 If you have downloaded Org from the Web, either as a distribution @file{.zip}
514 or @file{.tar} file, or as a Git archive, you must take the following steps
515 to install it: go into the unpacked Org distribution directory and edit the
516 top section of the file @file{Makefile}. You must set the name of the Emacs
517 binary (likely either @file{emacs} or @file{xemacs}), and the paths to the
518 directories where local Lisp and Info files are kept. If you don't have
519 access to the system-wide directories, you can simply run Org directly from
520 the distribution directory by adding the @file{lisp} subdirectory to the
521 Emacs load path. To do this, add the following line to @file{.emacs}:
524 (setq load-path (cons "~/path/to/orgdir/lisp" load-path))
528 If you plan to use code from the @file{contrib} subdirectory, do a similar
529 step for this directory:
532 (setq load-path (cons "~/path/to/orgdir/contrib/lisp" load-path))
535 @b{XEmacs users now need to install the file @file{noutline.el} from
536 the @file{xemacs} sub-directory of the Org distribution. Use the
540 @b{make install-noutline}
543 @noindent Now byte-compile the Lisp files with the shell command:
549 @noindent If you are running Org from the distribution directory, this is
550 all. If you want to install Org into the system directories, use (as
557 Installing Info files is system dependent, because of differences in the
558 @file{install-info} program. In Debian it copies the info files into the
559 correct directory and modifies the info directory file. In many other
560 systems, the files need to be copied to the correct directory separately, and
561 @file{install-info} then only modifies the directory file. Check your system
562 documentation to find out which of the following commands you need:
566 make install-info-debian
569 @noindent Then add to @file{.emacs}:
572 ;; This line only if Org is not part of the X/Emacs distribution.
573 (require 'org-install)
576 Do not forget to activate Org as described in the following section.
578 @node Activation, Feedback, Installation, Introduction
582 @cindex global key bindings
583 @cindex key bindings, global
586 @b{Important:} @i{If you use copy-and-paste to copy Lisp code from the
587 PDF documentation as viewed by some PDF viewers to your @file{.emacs} file, the
588 single-quote character comes out incorrectly and the code will not work.
589 You need to fix the single-quotes by hand, or copy from Info
593 Add the following lines to your @file{.emacs} file. The last three lines
594 define @emph{global} keys for the commands @command{org-store-link},
595 @command{org-agenda}, and @command{org-iswitchb}---please choose suitable
599 ;; The following lines are always needed. Choose your own keys.
600 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
601 (global-set-key "\C-cl" 'org-store-link)
602 (global-set-key "\C-ca" 'org-agenda)
603 (global-set-key "\C-cb" 'org-iswitchb)
606 Furthermore, you must activate @code{font-lock-mode} in Org
607 buffers, because significant functionality depends on font-locking being
608 active. You can do this with either one of the following two lines
609 (XEmacs users must use the second option):
611 (global-font-lock-mode 1) ; for all buffers
612 (add-hook 'org-mode-hook 'turn-on-font-lock) ; Org buffers only
615 @cindex Org mode, turning on
616 With this setup, all files with extension @samp{.org} will be put
617 into Org mode. As an alternative, make the first line of a file look
621 MY PROJECTS -*- mode: org; -*-
624 @vindex org-insert-mode-line-in-empty-file
625 @noindent which will select Org mode for this buffer no matter what
626 the file's name is. See also the variable
627 @code{org-insert-mode-line-in-empty-file}.
629 Many commands in Org work on the region if the region is @i{active}. To make
630 use of this, you need to have @code{transient-mark-mode}
631 (@code{zmacs-regions} in XEmacs) turned on. In Emacs 23 this is the default,
632 in Emacs 22 you need to do this yourself with
634 (transient-mark-mode 1)
636 @noindent If you do not like @code{transient-mark-mode}, you can create an
637 active region by using the mouse to select a region, or pressing
638 @kbd{C-@key{SPC}} twice before moving the cursor.
640 @node Feedback, Conventions, Activation, Introduction
647 If you find problems with Org, or if you have questions, remarks, or ideas
648 about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}.
649 If you are not a member of the mailing list, your mail will be reviewed by a
650 moderator and then passed through to the list.
652 For bug reports, please provide as much information as possible,
653 including the version information of Emacs (@kbd{C-h v emacs-version
654 @key{RET}}) and Org (@kbd{C-h v org-version @key{RET}}), as well as
655 the Org related setup in @file{.emacs}. If an error occurs, a
656 backtrace can be very useful (see below on how to create one). Often a
657 small example file helps, along with clear information about:
660 @item What exactly did you do?
661 @item What did you expect to happen?
662 @item What happened instead?
664 @noindent Thank you for helping to improve this mode.
666 @subsubheading How to create a useful backtrace
668 @cindex backtrace of an error
669 If working with Org produces an error with a message you don't
670 understand, you may have hit a bug. The best way to report this is by
671 providing, in addition to what was mentioned above, a @emph{backtrace}.
672 This is information from the built-in debugger about where and how the
673 error occurred. Here is how to produce a useful backtrace:
677 Reload uncompiled versions of all Org-mode Lisp files. The backtrace
678 contains much more information if it is produced with uncompiled code.
681 C-u M-x org-reload RET
684 or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the
687 Go to the @code{Options} menu and select @code{Enter Debugger on Error}
688 (XEmacs has this option in the @code{Troubleshooting} sub-menu).
690 Do whatever you have to do to hit the error. Don't forget to
691 document the steps you take.
693 When you hit the error, a @file{*Backtrace*} buffer will appear on the
694 screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and
695 attach it to your bug report.
698 @node Conventions, , Feedback, Introduction
699 @section Typesetting conventions used in this manual
701 Org uses three types of keywords: TODO keywords, tags, and property
702 names. In this manual we use the following conventions:
707 TODO keywords are written with all capitals, even if they are
711 User-defined tags are written in lowercase; built-in tags with special
712 meaning are written with all capitals.
715 User-defined properties are capitalized; built-in properties with
716 special meaning are written with all capitals.
719 @node Document Structure, Tables, Introduction, Top
720 @chapter Document Structure
721 @cindex document structure
722 @cindex structure of document
724 Org is based on Outline mode and provides flexible commands to
725 edit the structure of the document.
728 * Outlines:: Org is based on Outline mode
729 * Headlines:: How to typeset Org tree headlines
730 * Visibility cycling:: Show and hide, much simplified
731 * Motion:: Jumping to other headlines
732 * Structure editing:: Changing sequence and level of headlines
733 * Archiving:: Move done task trees to a different place
734 * Sparse trees:: Matches embedded in context
735 * Plain lists:: Additional structure within an entry
736 * Drawers:: Tucking stuff away
737 * Blocks:: Folding blocks
738 * Footnotes:: How footnotes are defined in Org's syntax
739 * Orgstruct mode:: Structure editing outside Org
742 @node Outlines, Headlines, Document Structure, Document Structure
747 Org is implemented on top of Outline mode. Outlines allow a
748 document to be organized in a hierarchical structure, which (at least
749 for me) is the best representation of notes and thoughts. An overview
750 of this structure is achieved by folding (hiding) large parts of the
751 document to show only the general document structure and the parts
752 currently being worked on. Org greatly simplifies the use of
753 outlines by compressing the entire show/hide functionality into a single
754 command, @command{org-cycle}, which is bound to the @key{TAB} key.
756 @node Headlines, Visibility cycling, Outlines, Document Structure
760 @vindex org-special-ctrl-a/e
762 Headlines define the structure of an outline tree. The headlines in
763 Org start with one or more stars, on the left margin@footnote{See
764 the variable @code{org-special-ctrl-a/e} to configure special behavior
765 of @kbd{C-a} and @kbd{C-e} in headlines.}. For example:
775 * Another top level headline
778 @noindent Some people find the many stars too noisy and would prefer an
779 outline that has whitespace followed by a single star as headline
780 starters. @ref{Clean view}, describes a setup to realize this.
782 @vindex org-cycle-separator-lines
783 An empty line after the end of a subtree is considered part of it and
784 will be hidden when the subtree is folded. However, if you leave at
785 least two empty lines, one empty line will remain visible after folding
786 the subtree, in order to structure the collapsed view. See the
787 variable @code{org-cycle-separator-lines} to modify this behavior.
789 @node Visibility cycling, Motion, Headlines, Document Structure
790 @section Visibility cycling
791 @cindex cycling, visibility
792 @cindex visibility cycling
793 @cindex trees, visibility
794 @cindex show hidden text
797 Outlines make it possible to hide parts of the text in the buffer.
798 Org uses just two commands, bound to @key{TAB} and
799 @kbd{S-@key{TAB}} to change the visibility in the buffer.
801 @cindex subtree visibility states
802 @cindex subtree cycling
803 @cindex folded, subtree visibility state
804 @cindex children, subtree visibility state
805 @cindex subtree, subtree visibility state
809 @emph{Subtree cycling}: Rotate current subtree among the states
812 ,-> FOLDED -> CHILDREN -> SUBTREE --.
813 '-----------------------------------'
816 @vindex org-cycle-emulate-tab
817 @vindex org-cycle-global-at-bob
818 The cursor must be on a headline for this to work@footnote{see, however,
819 the option @code{org-cycle-emulate-tab}.}. When the cursor is at the
820 beginning of the buffer and the first line is not a headline, then
821 @key{TAB} actually runs global cycling (see below)@footnote{see the
822 option @code{org-cycle-global-at-bob}.}. Also when called with a prefix
823 argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
825 @cindex global visibility states
826 @cindex global cycling
827 @cindex overview, global visibility state
828 @cindex contents, global visibility state
829 @cindex show all, global visibility state
833 @emph{Global cycling}: Rotate the entire buffer among the states
836 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
837 '--------------------------------------'
840 When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
841 CONTENTS view up to headlines of level N will be shown. Note that inside
842 tables, @kbd{S-@key{TAB}} jumps to the previous field.
844 @cindex show all, command
845 @kindex C-u C-u C-u @key{TAB}
846 @item C-u C-u C-u @key{TAB}
847 Show all, including drawers.
850 Reveal context around point, showing the current entry, the following heading
851 and the hierarchy above. Useful for working near a location that has been
852 exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
853 (@pxref{Agenda commands}). With a prefix argument show, on each
854 level, all sibling headings.
857 Show the current subtree in an indirect buffer@footnote{The indirect
860 (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
863 (see the Emacs manual for more information about indirect buffers)
865 will contain the entire buffer, but will be narrowed to the current
866 tree. Editing the indirect buffer will also change the original buffer,
867 but without affecting visibility in that buffer.}. With a numeric
868 prefix argument N, go up to level N and then take that tree. If N is
869 negative then go up that many levels. With a @kbd{C-u} prefix, do not remove
870 the previously used indirect buffer.
873 @vindex org-startup-folded
874 @cindex @code{overview}, STARTUP keyword
875 @cindex @code{content}, STARTUP keyword
876 @cindex @code{showall}, STARTUP keyword
878 When Emacs first visits an Org file, the global state is set to
879 OVERVIEW, @ie only the top level headlines are visible. This can be
880 configured through the variable @code{org-startup-folded}, or on a
881 per-file basis by adding one of the following lines anywhere in the
890 @cindex property, VISIBILITY
892 Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
893 and Columns}) will get their visibility adapted accordingly. Allowed values
894 for this property are @code{folded}, @code{children}, @code{content}, and
897 @kindex C-u C-u @key{TAB}
898 @item C-u C-u @key{TAB}
899 Switch back to the startup visibility of the buffer, @ie whatever is
900 requested by startup options and @samp{VISIBILITY} properties in individual
904 @node Motion, Structure editing, Visibility cycling, Document Structure
906 @cindex motion, between headlines
907 @cindex jumping, to headlines
908 @cindex headline navigation
909 The following commands jump to other headlines in the buffer.
920 Next heading same level.
923 Previous heading same level.
926 Backward to higher level heading.
929 Jump to a different place without changing the current outline
930 visibility. Shows the document structure in a temporary buffer, where
931 you can use the following keys to find your destination:
932 @vindex org-goto-auto-isearch
934 @key{TAB} @r{Cycle visibility.}
935 @key{down} / @key{up} @r{Next/previous visible headline.}
936 @key{RET} @r{Select this location.}
937 @kbd{/} @r{Do a Sparse-tree search}
938 @r{The following keys work if you turn off @code{org-goto-auto-isearch}}
939 n / p @r{Next/previous visible headline.}
940 f / b @r{Next/previous headline same level.}
942 0-9 @r{Digit argument.}
945 @vindex org-goto-interface
947 See also the variable @code{org-goto-interface}.
950 @node Structure editing, Archiving, Motion, Document Structure
951 @section Structure editing
952 @cindex structure editing
953 @cindex headline, promotion and demotion
954 @cindex promotion, of subtrees
955 @cindex demotion, of subtrees
956 @cindex subtree, cut and paste
957 @cindex pasting, of subtrees
958 @cindex cutting, of subtrees
959 @cindex copying, of subtrees
960 @cindex sorting, of subtrees
961 @cindex subtrees, cut and paste
966 @vindex org-M-RET-may-split-line
967 Insert new heading with same level as current. If the cursor is in a
968 plain list item, a new item is created (@pxref{Plain lists}). To force
969 creation of a new headline, use a prefix argument, or first press @key{RET}
970 to get to the beginning of the next line. When this command is used in
971 the middle of a line, the line is split and the rest of the line becomes
972 the new headline@footnote{If you do not want the line to be split,
973 customize the variable @code{org-M-RET-may-split-line}.}. If the
974 command is used at the beginning of a headline, the new headline is
975 created before the current line. If at the beginning of any other line,
976 the content of that line is made the new heading. If the command is
977 used at the end of a folded subtree (@ie behind the ellipses at the end
978 of a headline), then a headline like the current one will be inserted
979 after the end of the subtree.
982 Just like @kbd{M-@key{RET}}, except when adding a new heading below the
983 current heading, the new heading is placed after the body instead of before
984 it. This command works from anywhere in the entry.
985 @kindex M-S-@key{RET}
987 @vindex org-treat-insert-todo-heading-as-state-change
988 Insert new TODO entry with same level as current heading. See also the
989 variable @code{org-treat-insert-todo-heading-as-state-change}.
990 @kindex C-S-@key{RET}
992 Insert new TODO entry with same level as current heading. Like
993 @kbd{C-@key{RET}}, the new headline will be inserted after the current
997 Promote current heading by one level.
998 @kindex M-@key{right}
1000 Demote current heading by one level.
1001 @kindex M-S-@key{left}
1002 @item M-S-@key{left}
1003 Promote the current subtree by one level.
1004 @kindex M-S-@key{right}
1005 @item M-S-@key{right}
1006 Demote the current subtree by one level.
1007 @kindex M-S-@key{up}
1009 Move subtree up (swap with previous subtree of same
1011 @kindex M-S-@key{down}
1012 @item M-S-@key{down}
1013 Move subtree down (swap with next subtree of same level).
1016 Kill subtree, @ie remove it from buffer but save in kill ring.
1017 With a numeric prefix argument N, kill N sequential subtrees.
1020 Copy subtree to kill ring. With a numeric prefix argument N, copy the N
1021 sequential subtrees.
1024 Yank subtree from kill ring. This does modify the level of the subtree to
1025 make sure the tree fits in nicely at the yank position. The yank level can
1026 also be specified with a numeric prefix argument, or by yanking after a
1027 headline marker like @samp{****}.
1030 @vindex org-yank-adjusted-subtrees
1031 @vindex org-yank-folded-subtrees
1032 Depending on the variables @code{org-yank-adjusted-subtrees} and
1033 @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
1034 paste subtrees folded and in a clever way, using the same command as @kbd{C-c
1035 C-x C-y}. With the default settings, no level adjustment will take place,
1036 but the yanked tree will be folded unless doing so would swallow text
1037 previously visible. Any prefix argument to this command will force a normal
1038 @code{yank} to be executed, with the prefix passed along. A good way to
1039 force a normal yank is @kbd{C-u C-y}. If you use @code{yank-pop} after a
1040 yank, it will yank previous kill items plainly, without adjustment and
1044 Clone a subtree by making a number of sibling copies of it. You will be
1045 prompted for the number of copies to make, and you can also specify if any
1046 timestamps in the entry should be shifted. This can be useful, for example,
1047 to create a number of tasks related to a series of lectures to prepare. For
1048 more details, see the docstring of the command
1049 @code{org-clone-subtree-with-time-shift}.
1052 Refile entry or region to a different location. @xref{Refiling notes}.
1055 Sort same-level entries. When there is an active region, all entries in the
1056 region will be sorted. Otherwise the children of the current headline are
1057 sorted. The command prompts for the sorting method, which can be
1058 alphabetically, numerically, by time (first timestamp with active preferred,
1059 creation time, scheduled time, deadline time), by priority, by TODO keyword
1060 (in the sequence the keywords have been defined in the setup) or by the value
1061 of a property. Reverse sorting is possible as well. You can also supply
1062 your own function to extract the sorting key. With a @kbd{C-u} prefix,
1063 sorting will be case-sensitive. With two @kbd{C-u C-u} prefixes, duplicate
1064 entries will also be removed.
1067 Narrow buffer to current subtree.
1070 Widen buffer to remove narrowing.
1073 Turn a normal line or plain list item into a headline (so that it becomes a
1074 subheading at its location). Also turn a headline into a normal line by
1075 removing the stars. If there is an active region, turn all lines in the
1076 region into headlines. If the first line in the region was an item, turn
1077 only the item lines into headlines. Finally, if the first line is a
1078 headline, remove the stars from all headlines in the region.
1081 @cindex region, active
1082 @cindex active region
1083 @cindex transient mark mode
1084 When there is an active region (Transient Mark mode), promotion and
1085 demotion work on all headlines in the region. To select a region of
1086 headlines, it is best to place both point and mark at the beginning of a
1087 line, mark at the beginning of the first headline, and point at the line
1088 just after the last headline to change. Note that when the cursor is
1089 inside a table (@pxref{Tables}), the Meta-Cursor keys have different
1092 @node Archiving, Sparse trees, Structure editing, Document Structure
1096 When a project represented by a (sub)tree is finished, you may want
1097 to move the tree out of the way and to stop it from contributing to the
1098 agenda. Org mode knows two ways of archiving. You can mark a tree with
1099 the ARCHIVE tag, or you can move an entire (sub)tree to a different
1103 * ARCHIVE tag:: Marking a tree as inactive
1104 * Moving subtrees:: Moving a tree to an archive file
1107 @node ARCHIVE tag, Moving subtrees, Archiving, Archiving
1108 @subsection The ARCHIVE tag
1109 @cindex internal archiving
1111 A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
1112 its location in the outline tree, but behaves in the following way:
1115 @vindex org-cycle-open-archived-trees
1116 It does not open when you attempt to do so with a visibility cycling
1117 command (@pxref{Visibility cycling}). You can force cycling archived
1118 subtrees with @kbd{C-@key{TAB}}, or by setting the option
1119 @code{org-cycle-open-archived-trees}. Also normal outline commands like
1120 @code{show-all} will open archived subtrees.
1122 @vindex org-sparse-tree-open-archived-trees
1123 During sparse tree construction (@pxref{Sparse trees}), matches in
1124 archived subtrees are not exposed, unless you configure the option
1125 @code{org-sparse-tree-open-archived-trees}.
1127 @vindex org-agenda-skip-archived-trees
1128 During agenda view construction (@pxref{Agenda Views}), the content of
1129 archived trees is ignored unless you configure the option
1130 @code{org-agenda-skip-archived-trees}, in which case these trees will always
1131 be included. In the agenda you can press the @kbd{v} key to get archives
1132 temporarily included.
1134 @vindex org-export-with-archived-trees
1135 Archived trees are not exported (@pxref{Exporting}), only the headline
1136 is. Configure the details using the variable
1137 @code{org-export-with-archived-trees}.
1139 @vindex org-columns-skip-arrchived-trees
1140 Archived trees are excluded from column view unless the variable
1141 @code{org-columns-skip-arrchived-trees} is configured to @code{nil}.
1144 The following commands help managing the ARCHIVE tag:
1149 Toggle the ARCHIVE tag for the current headline. When the tag is set,
1150 the headline changes to a shadowed face, and the subtree below it is
1152 @kindex C-u C-c C-x a
1154 Check if any direct children of the current headline should be archived.
1155 To do this, each subtree is checked for open TODO entries. If none are
1156 found, the command offers to set the ARCHIVE tag for the child. If the
1157 cursor is @emph{not} on a headline when this command is invoked, the
1158 level 1 trees will be checked.
1161 Cycle a tree even if it is tagged with ARCHIVE.
1164 @node Moving subtrees, , ARCHIVE tag, Archiving
1165 @subsection Moving subtrees
1166 @cindex external archiving
1168 Once an entire project is finished, you may want to move it to a different
1169 location. Org can move it to an @emph{Archive Sibling} in the same tree, to a
1170 different tree in the current file, or to a different file, the archive file.
1175 Move the current entry to the @emph{Archive Sibling}. This is a sibling of
1176 the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}
1177 (@pxref{ARCHIVE tag}). The entry becomes a child of that sibling and in this
1178 way retains a lot of its original context, including inherited tags and
1179 approximate position in the outline.
1184 @vindex org-archive-location
1185 Archive the subtree starting at the cursor position to the location
1186 given by @code{org-archive-location}. Context information that could be
1187 lost, like the file name, the category, inherited tags, and the TODO
1188 state will be stored as properties in the entry.
1189 @kindex C-u C-c C-x C-s
1190 @item C-u C-c C-x C-s
1191 Check if any direct children of the current headline could be moved to
1192 the archive. To do this, each subtree is checked for open TODO entries.
1193 If none are found, the command offers to move it to the archive
1194 location. If the cursor is @emph{not} on a headline when this command
1195 is invoked, the level 1 trees will be checked.
1198 @cindex archive locations
1199 The default archive location is a file in the same directory as the
1200 current file, with the name derived by appending @file{_archive} to the
1201 current file name. For information and examples on how to change this,
1202 see the documentation string of the variable
1203 @code{org-archive-location}. There is also an in-buffer option for
1204 setting this variable, for example@footnote{For backward compatibility,
1205 the following also works: If there are several such lines in a file,
1206 each specifies the archive location for the text below it. The first
1207 such line also applies to any text before its definition. However,
1208 using this method is @emph{strongly} deprecated as it is incompatible
1209 with the outline structure of the document. The correct method for
1210 setting multiple archive locations in a buffer is using properties.}:
1214 #+ARCHIVE: %s_done::
1217 @cindex property, ARCHIVE
1219 If you would like to have a special ARCHIVE location for a single entry
1220 or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
1221 location as the value (@pxref{Properties and Columns}).
1223 @vindex org-archive-save-context-info
1224 When a subtree is moved, it receives a number of special properties that
1225 record context information like the file from where the entry came, its
1226 outline path the archiving time etc. Configure the variable
1227 @code{org-archive-save-context-info} to adjust the amount of information
1230 @node Sparse trees, Plain lists, Archiving, Document Structure
1231 @section Sparse trees
1232 @cindex sparse trees
1233 @cindex trees, sparse
1234 @cindex folding, sparse trees
1235 @cindex occur, command
1237 @vindex org-show-hierarchy-above
1238 @vindex org-show-following-heading
1239 @vindex org-show-siblings
1240 @vindex org-show-entry-below
1241 An important feature of Org mode is the ability to construct @emph{sparse
1242 trees} for selected information in an outline tree, so that the entire
1243 document is folded as much as possible, but the selected information is made
1244 visible along with the headline structure above it@footnote{See also the
1245 variables @code{org-show-hierarchy-above}, @code{org-show-following-heading},
1246 @code{org-show-siblings}, and @code{org-show-entry-below} for detailed
1247 control on how much context is shown around each match.}. Just try it out
1248 and you will see immediately how it works.
1250 Org mode contains several commands creating such trees, all these
1251 commands can be accessed through a dispatcher:
1256 This prompts for an extra key to select a sparse-tree creating command.
1259 @vindex org-remove-highlights-with-change
1260 Occur. Prompts for a regexp and shows a sparse tree with all matches. If
1261 the match is in a headline, the headline is made visible. If the match is in
1262 the body of an entry, headline and body are made visible. In order to
1263 provide minimal context, also the full hierarchy of headlines above the match
1264 is shown, as well as the headline following the match. Each match is also
1265 highlighted; the highlights disappear when the buffer is changed by an
1266 editing command@footnote{This depends on the option
1267 @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
1268 When called with a @kbd{C-u} prefix argument, previous highlights are kept,
1269 so several calls to this command can be stacked.
1273 @vindex org-agenda-custom-commands
1274 For frequently used sparse trees of specific search strings, you can
1275 use the variable @code{org-agenda-custom-commands} to define fast
1276 keyboard access to specific sparse trees. These commands will then be
1277 accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
1281 (setq org-agenda-custom-commands
1282 '(("f" occur-tree "FIXME")))
1285 @noindent will define the key @kbd{C-c a f} as a shortcut for creating
1286 a sparse tree matching the string @samp{FIXME}.
1288 The other sparse tree commands select headings based on TODO keywords,
1289 tags, or properties and will be discussed later in this manual.
1292 @cindex printing sparse trees
1293 @cindex visible text, printing
1294 To print a sparse tree, you can use the Emacs command
1295 @code{ps-print-buffer-with-faces} which does not print invisible parts
1296 of the document @footnote{This does not work under XEmacs, because
1297 XEmacs uses selective display for outlining, not text properties.}.
1298 Or you can use the command @kbd{C-c C-e v} to export only the visible
1299 part of the document and print the resulting file.
1301 @node Plain lists, Drawers, Sparse trees, Document Structure
1302 @section Plain lists
1304 @cindex lists, plain
1305 @cindex lists, ordered
1306 @cindex ordered lists
1308 Within an entry of the outline tree, hand-formatted lists can provide
1309 additional structure. They also provide a way to create lists of
1310 checkboxes (@pxref{Checkboxes}). Org supports editing such lists,
1311 and the HTML exporter (@pxref{Exporting}) parses and formats them.
1313 Org knows ordered lists, unordered lists, and description lists.
1316 @emph{Unordered} list items start with @samp{-}, @samp{+}, or
1317 @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
1318 they will be seen as top-level headlines. Also, when you are hiding leading
1319 stars to get a clean outline view, plain list items starting with a star are
1320 visually indistinguishable from true headlines. In short: even though
1321 @samp{*} is supported, it may be better to not use it for plain list items.}
1324 @emph{Ordered} list items start with a numeral followed by either a period or
1325 a right parenthesis, such as @samp{1.} or @samp{1)}.
1327 @emph{Description} list items are like unordered list items, but contain the
1328 separator @samp{ :: } to separate the description @emph{term} from the
1332 @vindex org-empty-line-terminates-plain-lists
1333 Items belonging to the same list must have the same indentation on the first
1334 line. In particular, if an ordered list reaches number @samp{10.}, then the
1335 2--digit numbers must be written left-aligned with the other numbers in the
1336 list. Indentation also determines the end of a list item. It ends before
1337 the next line that is indented like the bullet/number, or less. Empty lines
1338 are part of the previous item, so you can have several paragraphs in one
1339 item. If you would like an empty line to terminate all currently open plain
1340 lists, configure the variable @code{org-empty-line-terminates-plain-lists}.
1345 ** Lord of the Rings
1346 My favorite scenes are (in this order)
1347 1. The attack of the Rohirrim
1348 2. Eowyn's fight with the witch king
1349 + this was already my favorite scene in the book
1350 + I really like Miranda Otto.
1351 3. Peter Jackson being shot by Legolas
1353 He makes a really funny face when it happens.
1354 But in the end, no individual scenes matter but the film as a whole.
1355 Important actors in this film are:
1356 - @b{Elijah Wood} :: He plays Frodo
1357 - @b{Sean Austin} :: He plays Sam, Frodo's friend. I still remember
1358 him very well from his role as Mikey Walsh in @i{The Goonies}.
1362 Org supports these lists by tuning filling and wrapping commands to deal with
1363 them correctly@footnote{Org only changes the filling settings for Emacs. For
1364 XEmacs, you should use Kyle E. Jones' @file{filladapt.el}. To turn this on,
1365 put into @file{.emacs}: @code{(require 'filladapt)}}, and by exporting them
1366 properly (@pxref{Exporting}). Since indentation is what governs the
1367 structure of these lists, many structural constructs like @code{#+BEGIN_...}
1368 blocks can be indented to signal that they should be part of a list item.
1370 The following commands act on items when the cursor is in the first line
1371 of an item (the line with the bullet or number).
1376 @vindex org-cycle-include-plain-lists
1377 Items can be folded just like headline levels. Normally this works only if
1378 the cursor is on a plain list item. For more details, see the variable
1379 @code{org-cycle-include-plain-lists}. to @code{integrate}, plain list items
1380 will be treated like low-level. The level of an item is then given by the
1381 indentation of the bullet/number. Items are always subordinate to real
1382 headlines, however; the hierarchies remain completely separated.
1384 If @code{org-cycle-include-plain-lists} has not been set, @key{TAB}
1385 fixes the indentation of the current line in a heuristic way.
1388 @vindex org-M-RET-may-split-line
1389 Insert new item at current level. With a prefix argument, force a new
1390 heading (@pxref{Structure editing}). If this command is used in the middle
1391 of a line, the line is @emph{split} and the rest of the line becomes the new
1392 item@footnote{If you do not want the line to be split, customize the variable
1393 @code{org-M-RET-may-split-line}.}. If this command is executed in the
1394 @emph{whitespace before a bullet or number}, the new item is created
1395 @emph{before} the current item. If the command is executed in the white
1396 space before the text that is part of an item but does not contain the
1397 bullet, a bullet is added to the current line.
1398 @kindex M-S-@key{RET}
1400 Insert a new item with a checkbox (@pxref{Checkboxes}).
1402 @kindex S-@key{down}
1405 @cindex shift-selection-mode
1406 @vindex org-support-shift-select
1407 Jump to the previous/next item in the current list, but only if
1408 @code{org-support-shift-select} is off. If not, you can still use paragraph
1409 jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite
1411 @kindex M-S-@key{up}
1412 @kindex M-S-@key{down}
1414 @itemx M-S-@key{down}
1415 Move the item including subitems up/down (swap with previous/next item
1416 of same indentation). If the list is ordered, renumbering is
1418 @kindex M-S-@key{left}
1419 @kindex M-S-@key{right}
1420 @item M-S-@key{left}
1421 @itemx M-S-@key{right}
1422 Decrease/increase the indentation of the item, including subitems.
1423 Initially, the item tree is selected based on current indentation.
1424 When these commands are executed several times in direct succession,
1425 the initially selected region is used, even if the new indentation
1426 would imply a different hierarchy. To use the new hierarchy, break
1427 the command chain with a cursor motion or so.
1430 If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
1431 state of the checkbox. If not, this command makes sure that all the
1432 items on this list level use the same bullet. Furthermore, if this is
1433 an ordered list, make sure the numbering is OK.
1436 Cycle the entire list level through the different itemize/enumerate bullets
1437 (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}). With a numeric prefix
1438 argument N, select the Nth bullet from this list. If there is an active
1439 region when calling this, all lines will be converted to list items. If the
1440 first line already was a list item, any item markers will be removed from the
1441 list. Finally, even without an active region, a normal line will be
1442 converted into a list item.
1445 Turn a plain list item into a headline (so that it becomes a subheading at
1446 its location). @xref{Structure editing}, for a detailed explanation.
1447 @kindex S-@key{left}
1448 @kindex S-@key{right}
1449 @item S-@key{left}/@key{right}
1450 @vindex org-support-shift-select
1451 This command also cycles bullet styles when the cursor in on the bullet or
1452 anywhere in an item line, details depending on
1453 @code{org-support-shift-select}.
1456 Sort the plain list. You will be prompted for the sorting method:
1457 numerically, alphabetically, by time, or by custom function.
1460 @node Drawers, Blocks, Plain lists, Document Structure
1464 @cindex visibility cycling, drawers
1467 Sometimes you want to keep information associated with an entry, but you
1468 normally don't want to see it. For this, Org mode has @emph{drawers}.
1469 Drawers need to be configured with the variable
1470 @code{org-drawers}@footnote{You can define drawers on a per-file basis
1471 with a line like @code{#+DRAWERS: HIDDEN PROPERTIES STATE}}. Drawers
1475 ** This is a headline
1476 Still outside the drawer
1478 This is inside the drawer.
1483 Visibility cycling (@pxref{Visibility cycling}) on the headline will hide and
1484 show the entry, but keep the drawer collapsed to a single line. In order to
1485 look inside the drawer, you need to move the cursor to the drawer line and
1486 press @key{TAB} there. Org mode uses the @code{PROPERTIES} drawer for
1487 storing properties (@pxref{Properties and Columns}), and you can also arrange
1488 for state change notes (@pxref{Tracking TODO state changes}) and clock times
1489 (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}.
1491 @node Blocks, Footnotes, Drawers, Document Structure
1494 @vindex org-hide-block-startup
1495 @cindex blocks, folding
1496 Org-mode uses begin...end blocks for various purposes from including source
1497 code examples (@pxref{Literal examples}) to capturing time logging
1498 information (@pxref{Clocking work time}). These blocks can be folded and
1499 unfolded by pressing TAB in the begin line. You can also get all blocks
1500 folded at startup by configuring the variable @code{org-hide-block-startup}
1501 or on a per-file basis by using
1503 @cindex @code{hideblocks}, STARTUP keyword
1504 @cindex @code{nohideblocks}, STARTUP keyword
1506 #+STARTUP: hideblocks
1507 #+STARTUP: nohideblocks
1510 @node Footnotes, Orgstruct mode, Blocks, Document Structure
1514 Org mode supports the creation of footnotes. In contrast to the
1515 @file{footnote.el} package, Org mode's footnotes are designed for work on a
1516 larger document, not only for one-off documents like emails. The basic
1517 syntax is similar to the one used by @file{footnote.el}, @ie a footnote is
1518 defined in a paragraph that is started by a footnote marker in square
1519 brackets in column 0, no indentation allowed. If you need a paragraph break
1520 inside a footnote, use the La@TeX{} idiom @samp{\par}. The footnote reference
1521 is simply the marker in square brackets, inside text. For example:
1524 The Org homepage[fn:1] now looks a lot better than it used to.
1526 [fn:1] The link is: http://orgmode.org
1529 Org mode extends the number-based syntax to @emph{named} footnotes and
1530 optional inline definition. Using plain numbers as markers (as
1531 @file{footnote.el} does) is supported for backward compatibility, but not
1532 encouraged because of possible conflicts with La@TeX{} snippets (@pxref{Embedded
1533 LaTeX}). Here are the valid references:
1537 A plain numeric footnote marker. Compatible with @file{footnote.el}, but not
1538 recommended because somthing like @samp{[1]} could easily be part of a code
1541 A named footnote reference, where @code{name} is a unique label word, or, for
1542 simplicity of automatic creation, a number.
1543 @item [fn:: This is the inline definition of this footnote]
1544 A La@TeX{}-like anonymous footnote where the definition is given directly at the
1546 @item [fn:name: a definition]
1547 An inline definition of a footnote, which also specifies a name for the note.
1548 Since Org allows multiple references to the same note, you can then use
1549 @code{[fn:name]} to create additional references.
1552 @vindex org-footnote-auto-label
1553 Footnote labels can be created automatically, or you can create names yourself.
1554 This is handled by the variable @code{org-footnote-auto-label} and its
1555 corresponding @code{#+STARTUP} keywords, see the docstring of that variable
1558 @noindent The following command handles footnotes:
1563 The footnote action command.
1565 When the cursor is on a footnote reference, jump to the definition. When it
1566 is at a definition, jump to the (first) reference.
1568 @vindex org-footnote-define-inline
1569 @vindex org-footnote-section
1570 @vindex org-footnote-auto-adjust
1571 Otherwise, create a new footnote. Depending on the variable
1572 @code{org-footnote-define-inline}@footnote{The corresponding in-buffer
1573 setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
1574 definition will be placed right into the text as part of the reference, or
1575 separately into the location determined by the variable
1576 @code{org-footnote-section}.
1578 When this command is called with a prefix argument, a menu of additional
1581 s @r{Sort the footnote definitions by reference sequence. During editing,}
1582 @r{Org makes no effort to sort footnote definitions into a particular}
1583 @r{sequence. If you want them sorted, use this command, which will}
1584 @r{also move entries according to @code{org-footnote-section}. Automatic}
1585 @r{sorting after each insertion/deletion can be configured using the}
1586 @r{variable @code{org-footnote-auto-adjust}.}
1587 r @r{Renumber the simple @code{fn:N} footnotes. Automatic renumbering}
1588 @r{after each insertion/deletion can be configured using the variable}
1589 @r{@code{org-footnote-auto-adjust}.}
1590 S @r{Short for first @code{r}, then @code{s} action.}
1591 n @r{Normalize the footnotes by collecting all definitions (including}
1592 @r{inline definitions) into a special section, and then numbering them}
1593 @r{in sequence. The references will then also be numbers. This is}
1594 @r{meant to be the final step before finishing a document (e.g. sending}
1595 @r{off an email). The exporters do this automatically, and so could}
1596 @r{something like @code{message-send-hook}.}
1597 d @r{Delete the footnote at point, and all definitions of and references}
1600 Depending on the variable @code{org-footnote-auto-adjust}@footnote{the
1601 corresponding in-buffer options are @code{fnadjust} and @code{nofnadjust}.},
1602 renumbering and sorting footnotes can be automatic after each insertion or
1607 If the cursor is on a footnote reference, jump to the definition. If it is a
1608 the definition, jump back to the reference. When called at a footnote
1609 location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
1613 @item C-c C-o @r{or} mouse-1/2
1614 Footnote labels are also links to the corresponding definition/reference, and
1615 you can use the usual commands to follow these links.
1618 @node Orgstruct mode, , Footnotes, Document Structure
1619 @section The Orgstruct minor mode
1620 @cindex Orgstruct mode
1621 @cindex minor mode for structure editing
1623 If you like the intuitive way the Org mode structure editing and list
1624 formatting works, you might want to use these commands in other modes like
1625 Text mode or Mail mode as well. The minor mode @code{orgstruct-mode} makes
1626 this possible. Toggle the mode with @kbd{M-x orgstruct-mode}, or
1627 turn it on by default, for example in Mail mode, with one of:
1630 (add-hook 'mail-mode-hook 'turn-on-orgstruct)
1631 (add-hook 'mail-mode-hook 'turn-on-orgstruct++)
1634 When this mode is active and the cursor is on a line that looks to Org like a
1635 headline or the first line of a list item, most structure editing commands
1636 will work, even if the same keys normally have different functionality in the
1637 major mode you are using. If the cursor is not in one of those special
1638 lines, Orgstruct mode lurks silently in the shadow. When you use
1639 @code{orgstruct++-mode}, Org will also export indentation and autofill
1640 settings into that mode, and detect item context after the first line of an
1643 @node Tables, Hyperlinks, Document Structure, Top
1646 @cindex editing tables
1648 Org comes with a fast and intuitive table editor. Spreadsheet-like
1649 calculations are supported in connection with the Emacs @file{calc}
1652 (@pxref{Top,Calc,,Calc,Gnu Emacs Calculator Manual}).
1655 (see the Emacs Calculator manual for more information about the Emacs
1660 * Built-in table editor:: Simple tables
1661 * Column width and alignment:: Overrule the automatic settings
1662 * Column groups:: Grouping to trigger vertical lines
1663 * Orgtbl mode:: The table editor as minor mode
1664 * The spreadsheet:: The table editor has spreadsheet capabilities
1665 * Org-Plot:: Plotting from org tables
1668 @node Built-in table editor, Column width and alignment, Tables, Tables
1669 @section The built-in table editor
1670 @cindex table editor, built-in
1672 Org makes it easy to format tables in plain ASCII. Any line with
1673 @samp{|} as the first non-whitespace character is considered part of a
1674 table. @samp{|} is also the column separator. A table might look like
1678 | Name | Phone | Age |
1679 |-------+-------+-----|
1680 | Peter | 1234 | 17 |
1681 | Anna | 4321 | 25 |
1684 A table is re-aligned automatically each time you press @key{TAB} or
1685 @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to
1686 the next field (@key{RET} to the next row) and creates new table rows
1687 at the end of the table or before horizontal lines. The indentation
1688 of the table is set by the first line. Any line starting with
1689 @samp{|-} is considered as a horizontal separator line and will be
1690 expanded on the next re-align to span the whole table width. So, to
1691 create the above table, you would only type
1698 @noindent and then press @key{TAB} to align the table and start filling in
1699 fields. Even faster would be to type @code{|Name|Phone|Age} followed by
1700 @kbd{C-c @key{RET}}.
1702 @vindex org-enable-table-editor
1703 @vindex org-table-auto-blank-field
1704 When typing text into a field, Org treats @key{DEL},
1705 @key{Backspace}, and all character keys in a special way, so that
1706 inserting and deleting avoids shifting other fields. Also, when
1707 typing @emph{immediately after the cursor was moved into a new field
1708 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
1709 field is automatically made blank. If this behavior is too
1710 unpredictable for you, configure the variables
1711 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
1714 @tsubheading{Creation and conversion}
1717 Convert the active region to table. If every line contains at least one
1718 TAB character, the function assumes that the material is tab separated.
1719 If every line contains a comma, comma-separated values (CSV) are assumed.
1720 If not, lines are split at whitespace into fields. You can use a prefix
1721 argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
1722 C-u} forces TAB, and a numeric argument N indicates that at least N
1723 consecutive spaces, or alternatively a TAB will be the separator.
1725 If there is no active region, this command creates an empty Org
1726 table. But it's easier just to start typing, like
1727 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
1729 @tsubheading{Re-aligning and field motion}
1732 Re-align the table without moving the cursor.
1736 Re-align the table, move to the next field. Creates a new row if
1741 Re-align, move to previous field.
1745 Re-align the table and move down to next row. Creates a new row if
1746 necessary. At the beginning or end of a line, @key{RET} still does
1747 NEWLINE, so it can be used to split a table.
1751 Move to beginning of the current table field, or on to the previous field.
1754 Move to end of the current table field, or on to the next field.
1756 @tsubheading{Column and row editing}
1757 @kindex M-@key{left}
1758 @kindex M-@key{right}
1760 @itemx M-@key{right}
1761 Move the current column left/right.
1763 @kindex M-S-@key{left}
1764 @item M-S-@key{left}
1765 Kill the current column.
1767 @kindex M-S-@key{right}
1768 @item M-S-@key{right}
1769 Insert a new column to the left of the cursor position.
1772 @kindex M-@key{down}
1775 Move the current row up/down.
1777 @kindex M-S-@key{up}
1779 Kill the current row or horizontal line.
1781 @kindex M-S-@key{down}
1782 @item M-S-@key{down}
1783 Insert a new row above the current row. With a prefix argument, the line is
1784 created below the current one.
1788 Insert a horizontal line below current row. With a prefix argument, the line
1789 is created above the current line.
1791 @kindex C-c @key{RET}
1793 Insert a horizontal line below current row, and move the cursor into the row
1798 Sort the table lines in the region. The position of point indicates the
1799 column to be used for sorting, and the range of lines is the range
1800 between the nearest horizontal separator lines, or the entire table. If
1801 point is before the first column, you will be prompted for the sorting
1802 column. If there is an active region, the mark specifies the first line
1803 and the sorting column, while point should be in the last line to be
1804 included into the sorting. The command prompts for the sorting type
1805 (alphabetically, numerically, or by time). When called with a prefix
1806 argument, alphabetic sorting will be case-sensitive.
1808 @tsubheading{Regions}
1811 Copy a rectangular region from a table to a special clipboard. Point and
1812 mark determine edge fields of the rectangle. If there is no active region,
1813 copy just the current field. The process ignores horizontal separator lines.
1817 Copy a rectangular region from a table to a special clipboard, and
1818 blank all fields in the rectangle. So this is the ``cut'' operation.
1822 Paste a rectangular region into a table.
1823 The upper left corner ends up in the current field. All involved fields
1824 will be overwritten. If the rectangle does not fit into the present table,
1825 the table is enlarged as needed. The process ignores horizontal separator
1830 Wrap several fields in a column like a paragraph. If there is an active
1831 region, and both point and mark are in the same column, the text in the
1832 column is wrapped to minimum width for the given number of lines. A numeric
1833 prefix argument may be used to change the number of desired lines. If there
1834 is no region, the current field is split at the cursor position and the text
1835 fragment to the right of the cursor is prepended to the field one line
1836 down. If there is no region, but you specify a prefix argument, the current
1837 field is made blank, and the content is appended to the field above.
1839 @tsubheading{Calculations}
1840 @cindex formula, in tables
1841 @cindex calculations, in tables
1842 @cindex region, active
1843 @cindex active region
1844 @cindex transient mark mode
1847 Sum the numbers in the current column, or in the rectangle defined by
1848 the active region. The result is shown in the echo area and can
1849 be inserted with @kbd{C-y}.
1853 @vindex org-table-copy-increment
1854 When current field is empty, copy from first non-empty field above. When not
1855 empty, copy current field down to next row and move cursor along with it.
1856 Depending on the variable @code{org-table-copy-increment}, integer field
1857 values will be incremented during copy. Integers that are too large will not
1858 be incremented. Also, a @code{0} prefix argument temporarily disables the
1859 increment. This key is also used by shift-selection and related modes
1860 (@pxref{Conflicts}).
1862 @tsubheading{Miscellaneous}
1865 Edit the current field in a separate window. This is useful for fields that
1866 are not fully visible (@pxref{Column width and alignment}). When called with
1867 a @kbd{C-u} prefix, just make the full field visible, so that it can be
1870 @item M-x org-table-import
1871 Import a file as a table. The table should be TAB or whitespace
1872 separated. Use, for example, to import a spreadsheet table or data
1873 from a database, because these programs generally can write
1874 TAB-separated text files. This command works by inserting the file into
1875 the buffer and then converting the region to a table. Any prefix
1876 argument is passed on to the converter, which uses it to determine the
1879 Tables can also be imported by pasting tabular text into the Org
1880 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
1881 @kbd{C-c |} command (see above under @i{Creation and conversion}).
1883 @item M-x org-table-export
1884 @vindex org-table-export-default-format
1885 Export the table, by default as a TAB-separated file. Use for data
1886 exchange with, for example, spreadsheet or database programs. The format
1887 used to export the file can be configured in the variable
1888 @code{org-table-export-default-format}. You may also use properties
1889 @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
1890 name and the format for table export in a subtree. Org supports quite
1891 general formats for exported tables. The exporter format is the same as the
1892 format used by Orgtbl radio tables, see @ref{Translator functions}, for a
1893 detailed description.
1896 If you don't like the automatic table editor because it gets in your
1897 way on lines which you would like to start with @samp{|}, you can turn
1901 (setq org-enable-table-editor nil)
1904 @noindent Then the only table command that still works is
1905 @kbd{C-c C-c} to do a manual re-align.
1907 @node Column width and alignment, Column groups, Built-in table editor, Tables
1908 @section Column width and alignment
1909 @cindex narrow columns in tables
1910 @cindex alignment in tables
1912 The width of columns is automatically determined by the table editor. And
1913 also the alignment of a column is determined automatically from the fraction
1914 of number-like versus non-number fields in the column.
1916 Sometimes a single field or a few fields need to carry more text,
1917 leading to inconveniently wide columns. To limit@footnote{This feature
1918 does not work on XEmacs.} the width of a column, one field anywhere in
1919 the column may contain just the string @samp{<N>} where @samp{N} is an
1920 integer specifying the width of the column in characters. The next
1921 re-align will then set the width of this column to no more than this
1926 |---+------------------------------| |---+--------|
1928 | 1 | one | | 1 | one |
1929 | 2 | two | ----\ | 2 | two |
1930 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
1931 | 4 | four | | 4 | four |
1932 |---+------------------------------| |---+--------|
1937 Fields that are wider become clipped and end in the string @samp{=>}.
1938 Note that the full text is still in the buffer, it is only invisible.
1939 To see the full text, hold the mouse over the field---a tool-tip window
1940 will show the full content. To edit such a field, use the command
1941 @kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will
1942 open a new window with the full field. Edit it and finish with @kbd{C-c
1945 @vindex org-startup-align-all-tables
1946 When visiting a file containing a table with narrowed columns, the
1947 necessary character hiding has not yet happened, and the table needs to
1948 be aligned before it looks nice. Setting the option
1949 @code{org-startup-align-all-tables} will realign all tables in a file
1950 upon visiting, but also slow down startup. You can also set this option
1951 on a per-file basis with:
1958 If you would like to overrule the automatic alignment of number-rich columns
1959 to the right and of string-rich column to the left, you and use @samp{<r>} or
1960 @samp{<l>} in a similar fashion. You may also combine alignment and field
1961 width like this: @samp{<l10>}.
1963 @node Column groups, Orgtbl mode, Column width and alignment, Tables
1964 @section Column groups
1965 @cindex grouping columns in tables
1967 When Org exports tables, it does so by default without vertical
1968 lines because that is visually more satisfying in general. Occasionally
1969 however, vertical lines can be useful to structure a table into groups
1970 of columns, much like horizontal lines can do for groups of rows. In
1971 order to specify column groups, you can use a special row where the
1972 first field contains only @samp{/}. The further fields can either
1973 contain @samp{<} to indicate that this column should start a group,
1974 @samp{>} to indicate the end of a column, or @samp{<>} to make a column
1975 a group of its own. Boundaries between column groups will upon export be
1976 marked with vertical lines. Here is an example:
1979 | | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
1980 |---+----+-----+-----+-----+---------+------------|
1981 | / | <> | < | | > | < | > |
1982 | # | 1 | 1 | 1 | 1 | 1 | 1 |
1983 | # | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
1984 | # | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
1985 |---+----+-----+-----+-----+---------+------------|
1986 #+TBLFM: $3=$2^2::$4=$2^3::$5=$2^4::$6=sqrt($2)::$7=sqrt(sqrt(($2)))
1989 It is also sufficient to just insert the column group starters after
1990 every vertical line you'd like to have:
1993 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
1994 |----+-----+-----+-----+---------+------------|
1998 @node Orgtbl mode, The spreadsheet, Column groups, Tables
1999 @section The Orgtbl minor mode
2001 @cindex minor mode for tables
2003 If you like the intuitive way the Org table editor works, you
2004 might also want to use it in other modes like Text mode or Mail mode.
2005 The minor mode Orgtbl mode makes this possible. You can always toggle
2006 the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for
2007 example in mail mode, use
2010 (add-hook 'mail-mode-hook 'turn-on-orgtbl)
2013 Furthermore, with some special setup, it is possible to maintain tables
2014 in arbitrary syntax with Orgtbl mode. For example, it is possible to
2015 construct La@TeX{} tables with the underlying ease and power of
2016 Orgtbl mode, including spreadsheet capabilities. For details, see
2017 @ref{Tables in arbitrary syntax}.
2019 @node The spreadsheet, Org-Plot, Orgtbl mode, Tables
2020 @section The spreadsheet
2021 @cindex calculations, in tables
2022 @cindex spreadsheet capabilities
2023 @cindex @file{calc} package
2025 The table editor makes use of the Emacs @file{calc} package to implement
2026 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
2027 derive fields from other fields. While fully featured, Org's
2028 implementation is not identical to other spreadsheets. For example,
2029 Org knows the concept of a @emph{column formula} that will be
2030 applied to all non-header fields in a column without having to copy the
2031 formula to each relevant field.
2034 * References:: How to refer to another field or range
2035 * Formula syntax for Calc:: Using Calc to compute stuff
2036 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
2037 * Field formulas:: Formulas valid for a single field
2038 * Column formulas:: Formulas valid for an entire column
2039 * Editing and debugging formulas:: Fixing formulas
2040 * Updating the table:: Recomputing all dependent fields
2041 * Advanced features:: Field names, parameters and automatic recalc
2044 @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet
2045 @subsection References
2048 To compute fields in the table from other fields, formulas must
2049 reference other fields or ranges. In Org, fields can be referenced
2050 by name, by absolute coordinates, and by relative coordinates. To find
2051 out what the coordinates of a field are, press @kbd{C-c ?} in that
2052 field, or press @kbd{C-c @}} to toggle the display of a grid.
2054 @subsubheading Field references
2055 @cindex field references
2056 @cindex references, to fields
2058 Formulas can reference the value of another field in two ways. Like in
2059 any other spreadsheet, you may reference fields with a letter/number
2060 combination like @code{B3}, meaning the 2nd field in the 3rd row.
2061 @c Such references are always fixed to that field, they don't change
2062 @c when you copy and paste a formula to a different field. So
2063 @c Org's @code{B3} behaves like @code{$B$3} in other spreadsheets.
2066 Org also uses another, more general operator that looks like this:
2068 @@@var{row}$@var{column}
2072 Column references can be absolute like @samp{1}, @samp{2},...@samp{@var{N}},
2073 or relative to the current column like @samp{+1} or @samp{-2}.
2075 The row specification only counts data lines and ignores horizontal
2076 separator lines (hlines). You can use absolute row numbers
2077 @samp{1}...@samp{@var{N}}, and row numbers relative to the current row like
2078 @samp{+3} or @samp{-1}. Or specify the row relative to one of the
2079 hlines: @samp{I} refers to the first hline@footnote{Note that only
2080 hlines are counted that @emph{separate} table lines. If the table
2081 starts with a hline above the header, it does not count.}, @samp{II} to
2082 the second, etc@. @samp{-I} refers to the first such line above the
2083 current line, @samp{+I} to the first such line below the current line.
2084 You can also write @samp{III+2} which is the second data line after the
2085 third hline in the table.
2087 @samp{0} refers to the current row and column. Also, if you omit
2088 either the column or the row part of the reference, the current
2089 row/column is implied.
2091 Org's references with @emph{unsigned} numbers are fixed references
2092 in the sense that if you use the same reference in the formula for two
2093 different fields, the same field will be referenced each time.
2094 Org's references with @emph{signed} numbers are floating
2095 references because the same reference operator can reference different
2096 fields depending on the field being calculated by the formula.
2098 As a special case, references like @samp{$LR5} and @samp{$LR12} can be used
2099 to refer in a stable way to the 5th and 12th field in the last row of the
2102 Here are a few examples:
2105 @@2$3 @r{2nd row, 3rd column}
2106 C2 @r{same as previous}
2107 $5 @r{column 5 in the current row}
2108 E& @r{same as previous}
2109 @@2 @r{current column, row 2}
2110 @@-1$-3 @r{the field one row up, three columns to the left}
2111 @@-I$2 @r{field just under hline above current row, column 2}
2114 @subsubheading Range references
2115 @cindex range references
2116 @cindex references, to ranges
2118 You may reference a rectangular range of fields by specifying two field
2119 references connected by two dots @samp{..}. If both fields are in the
2120 current row, you may simply use @samp{$2..$7}, but if at least one field
2121 is in a different row, you need to use the general @code{@@row$column}
2122 format at least for the first field (i.e the reference must start with
2123 @samp{@@} in order to be interpreted correctly). Examples:
2126 $1..$3 @r{First three fields in the current row.}
2127 $P..$Q @r{Range, using column names (see under Advanced)}
2128 @@2$1..@@4$3 @r{6 fields between these two fields.}
2129 A2..C4 @r{Same as above.}
2130 @@-1$-2..@@-1 @r{3 numbers from the column to the left, 2 up to current row}
2133 @noindent Range references return a vector of values that can be fed
2134 into Calc vector functions. Empty fields in ranges are normally
2135 suppressed, so that the vector contains only the non-empty fields (but
2136 see the @samp{E} mode switch below). If there are no non-empty fields,
2137 @samp{[0]} is returned to avoid syntax errors in formulas.
2139 @subsubheading Named references
2140 @cindex named references
2141 @cindex references, named
2142 @cindex name, of column or field
2143 @cindex constants, in calculations
2146 @vindex org-table-formula-constants
2147 @samp{$name} is interpreted as the name of a column, parameter or
2148 constant. Constants are defined globally through the variable
2149 @code{org-table-formula-constants}, and locally (for the file) through a
2153 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
2157 @vindex constants-unit-system
2158 @pindex constants.el
2159 Also properties (@pxref{Properties and Columns}) can be used as
2160 constants in table formulas: for a property @samp{:Xyz:} use the name
2161 @samp{$PROP_Xyz}, and the property will be searched in the current
2162 outline entry and in the hierarchy above it. If you have the
2163 @file{constants.el} package, it will also be used to resolve constants,
2164 including natural constants like @samp{$h} for Planck's constant, and
2165 units like @samp{$km} for kilometers@footnote{@file{constants.el} can
2166 supply the values of constants in two different unit systems, @code{SI}
2167 and @code{cgs}. Which one is used depends on the value of the variable
2168 @code{constants-unit-system}. You can use the @code{#+STARTUP} options
2169 @code{constSI} and @code{constcgs} to set this value for the current
2170 buffer.}. Column names and parameters can be specified in special table
2171 lines. These are described below, see @ref{Advanced features}. All
2172 names must start with a letter, and further consist of letters and
2175 @subsubheading Remote references
2176 @cindex remote references
2177 @cindex references, remote
2178 @cindex references, to a different table
2179 @cindex name, of column or field
2180 @cindex constants, in calculations
2183 You may also reference constants, fields and ranges from a different table,
2184 either in the current file or even in a different file. The syntax is
2187 remote(NAME-OR-ID,REF)
2191 where NAME can be the name of a table in the current file as set by a
2192 @code{#+TBLNAME: NAME} line before the table. It can also be the ID of an
2193 entry, even in a different file, and the reference then refers to the first
2194 table in that entry. REF is an absolute field or range reference as
2195 described above for example @code{@@3$3} or @code{$somename}, valid in the
2198 @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet
2199 @subsection Formula syntax for Calc
2200 @cindex formula syntax, Calc
2201 @cindex syntax, of formulas
2203 A formula can be any algebraic expression understood by the Emacs
2204 @file{Calc} package. @b{Note that @file{calc} has the
2205 non-standard convention that @samp{/} has lower precedence than
2206 @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.} Before
2207 evaluation by @code{calc-eval} (@pxref{Calling Calc from
2208 Your Programs,calc-eval,Calling Calc from Your Lisp Programs,Calc,GNU
2209 Emacs Calc Manual}),
2210 @c FIXME: The link to the Calc manual in HTML does not work.
2211 variable substitution takes place according to the rules described above.
2212 @cindex vectors, in table calculations
2213 The range vectors can be directly fed into the Calc vector functions
2214 like @samp{vmean} and @samp{vsum}.
2216 @cindex format specifier
2217 @cindex mode, for @file{calc}
2218 @vindex org-calc-default-modes
2219 A formula can contain an optional mode string after a semicolon. This
2220 string consists of flags to influence Calc and other modes during
2221 execution. By default, Org uses the standard Calc modes (precision
2222 12, angular units degrees, fraction and symbolic modes off). The display
2223 format, however, has been changed to @code{(float 8)} to keep tables
2224 compact. The default settings can be configured using the variable
2225 @code{org-calc-default-modes}.
2228 p20 @r{switch the internal precision to 20 digits}
2229 n3 s3 e2 f4 @r{normal, scientific, engineering, or fixed display format}
2230 D R @r{angle modes: degrees, radians}
2231 F S @r{fraction and symbolic modes}
2232 N @r{interpret all fields as numbers, use 0 for non-numbers}
2233 T @r{force text interpretation}
2234 E @r{keep empty fields in ranges}
2239 In addition, you may provide a @code{printf} format specifier to
2240 reformat the final result. A few examples:
2243 $1+$2 @r{Sum of first and second field}
2244 $1+$2;%.2f @r{Same, format result to two decimals}
2245 exp($2)+exp($1) @r{Math functions can be used}
2246 $0;%.1f @r{Reformat current cell to 1 decimal}
2247 ($3-32)*5/9 @r{Degrees F -> C conversion}
2248 $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}}
2249 tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1}
2250 sin($1);Dp3%.1e @r{Same, but use printf specifier for display}
2251 vmean($2..$7) @r{Compute column range mean, using vector function}
2252 vmean($2..$7);EN @r{Same, but treat empty fields as 0}
2253 taylor($3,x=7,2) @r{taylor series of $3, at x=7, second degree}
2256 Calc also contains a complete set of logical operations. For example
2259 if($1<20,teen,string("")) @r{``teen'' if age $1 less than 20, else empty}
2262 @node Formula syntax for Lisp, Field formulas, Formula syntax for Calc, The spreadsheet
2263 @subsection Emacs Lisp forms as formulas
2264 @cindex Lisp forms, as table formulas
2266 It is also possible to write a formula in Emacs Lisp; this can be useful
2267 for string manipulation and control structures, if Calc's
2268 functionality is not enough. If a formula starts with a single-quote
2269 followed by an opening parenthesis, then it is evaluated as a Lisp form.
2270 The evaluation should return either a string or a number. Just as with
2271 @file{calc} formulas, you can specify modes and a printf format after a
2272 semicolon. With Emacs Lisp forms, you need to be conscious about the way
2273 field references are interpolated into the form. By default, a
2274 reference will be interpolated as a Lisp string (in double-quotes)
2275 containing the field. If you provide the @samp{N} mode switch, all
2276 referenced elements will be numbers (non-number fields will be zero) and
2277 interpolated as Lisp numbers, without quotes. If you provide the
2278 @samp{L} flag, all fields will be interpolated literally, without quotes.
2279 @Ie{}, if you want a reference to be interpreted as a string by the Lisp
2280 form, enclose the reference operator itself in double-quotes, like
2281 @code{"$3"}. Ranges are inserted as space-separated fields, so you can
2282 embed them in list or vector syntax. A few examples, note how the
2283 @samp{N} mode is used when we do computations in Lisp.
2286 @r{Swap the first two characters of the content of column 1}
2287 '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
2288 @r{Add columns 1 and 2, equivalent to Calc's @code{$1+$2}}
2290 @r{Compute the sum of columns 1-4, like Calc's @code{vsum($1..$4)}}
2291 '(apply '+ '($1..$4));N
2294 @node Field formulas, Column formulas, Formula syntax for Lisp, The spreadsheet
2295 @subsection Field formulas
2296 @cindex field formula
2297 @cindex formula, for individual table field
2299 To assign a formula to a particular field, type it directly into the
2300 field, preceded by @samp{:=}, for example @samp{:=$1+$2}. When you
2301 press @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in
2302 the field, the formula will be stored as the formula for this field,
2303 evaluated, and the current field replaced with the result.
2306 Formulas are stored in a special line starting with @samp{#+TBLFM:}
2307 directly below the table. If you typed the equation in the 4th field of
2308 the 3rd data line in the table, the formula will look like
2309 @samp{@@3$4=$1+$2}. When inserting/deleting/swapping column and rows
2310 with the appropriate commands, @i{absolute references} (but not relative
2311 ones) in stored formulas are modified in order to still reference the
2312 same field. Of course this is not true if you edit the table structure
2313 with normal editing commands---then you must fix the equations yourself.
2314 The left-hand side of a formula may also be a named field (@pxref{Advanced
2315 features}), or a last-row reference like @samp{$LR3}.
2317 Instead of typing an equation into the field, you may also use the
2323 Install a new formula for the current field. The command prompts for a
2324 formula with default taken from the @samp{#+TBLFM:} line, applies
2325 it to the current field, and stores it.
2328 @node Column formulas, Editing and debugging formulas, Field formulas, The spreadsheet
2329 @subsection Column formulas
2330 @cindex column formula
2331 @cindex formula, for table column
2333 Often in a table, the same formula should be used for all fields in a
2334 particular column. Instead of having to copy the formula to all fields
2335 in that column, Org allows you to assign a single formula to an entire
2336 column. If the table contains horizontal separator hlines, everything
2337 before the first such line is considered part of the table @emph{header}
2338 and will not be modified by column formulas.
2340 To assign a formula to a column, type it directly into any field in the
2341 column, preceded by an equal sign, like @samp{=$1+$2}. When you press
2342 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2343 the formula will be stored as the formula for the current column, evaluated
2344 and the current field replaced with the result. If the field contains only
2345 @samp{=}, the previously stored formula for this column is used. For each
2346 column, Org will only remember the most recently used formula. In the
2347 @samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}. The left-hand
2348 side of a column formula cannot currently be the name of column, it
2349 must be the numeric column reference.
2351 Instead of typing an equation into the field, you may also use the
2357 Install a new formula for the current column and replace current field with
2358 the result of the formula. The command prompts for a formula, with default
2359 taken from the @samp{#+TBLFM} line, applies it to the current field and
2360 stores it. With a numeric prefix argument(@eg @kbd{C-5 C-c =}) the command
2361 will apply it to that many consecutive fields in the current column.
2364 @node Editing and debugging formulas, Updating the table, Column formulas, The spreadsheet
2365 @subsection Editing and debugging formulas
2366 @cindex formula editing
2367 @cindex editing, of table formulas
2369 @vindex org-table-use-standard-references
2370 You can edit individual formulas in the minibuffer or directly in the
2371 field. Org can also prepare a special buffer with all active
2372 formulas of a table. When offering a formula for editing, Org
2373 converts references to the standard format (like @code{B3} or @code{D&})
2374 if possible. If you prefer to only work with the internal format (like
2375 @code{@@3$2} or @code{$4}), configure the variable
2376 @code{org-table-use-standard-references}.
2383 Edit the formula associated with the current column/field in the
2384 minibuffer. See @ref{Column formulas}, and @ref{Field formulas}.
2385 @kindex C-u C-u C-c =
2387 Re-insert the active formula (either a
2388 field formula, or a column formula) into the current field, so that you
2389 can edit it directly in the field. The advantage over editing in the
2390 minibuffer is that you can use the command @kbd{C-c ?}.
2393 While editing a formula in a table field, highlight the field(s)
2394 referenced by the reference at the cursor position in the formula.
2397 Toggle the display of row and column numbers for a table, using
2398 overlays. These are updated each time the table is aligned; you can
2399 force it with @kbd{C-c C-c}.
2402 Toggle the formula debugger on and off. See below.
2405 Edit all formulas for the current table in a special buffer, where the
2406 formulas will be displayed one per line. If the current field has an
2407 active formula, the cursor in the formula editor will mark it.
2408 While inside the special buffer, Org will automatically highlight
2409 any field or range reference at the cursor position. You may edit,
2410 remove and add formulas, and use the following commands:
2416 Exit the formula editor and store the modified formulas. With @kbd{C-u}
2417 prefix, also apply the new formulas to the entire table.
2420 Exit the formula editor without installing changes.
2423 Toggle all references in the formula editor between standard (like
2424 @code{B3}) and internal (like @code{@@3$2}).
2427 Pretty-print or indent Lisp formula at point. When in a line containing
2428 a Lisp formula, format the formula according to Emacs Lisp rules.
2429 Another @key{TAB} collapses the formula back again. In the open
2430 formula, @key{TAB} re-indents just like in Emacs Lisp mode.
2433 Complete Lisp symbols, just like in Emacs Lisp mode.
2435 @kindex S-@key{down}
2436 @kindex S-@key{left}
2437 @kindex S-@key{right}
2438 @item S-@key{up}/@key{down}/@key{left}/@key{right}
2439 Shift the reference at point. For example, if the reference is
2440 @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
2441 This also works for relative references and for hline references.
2442 @kindex M-S-@key{up}
2443 @kindex M-S-@key{down}
2444 @item M-S-@key{up}/@key{down}
2445 Move the test line for column formulas in the Org buffer up and
2448 @kindex M-@key{down}
2449 @item M-@key{up}/@key{down}
2450 Scroll the window displaying the table.
2453 Turn the coordinate grid in the table on and off.
2457 Making a table field blank does not remove the formula associated with
2458 the field, because that is stored in a different line (the @samp{#+TBLFM}
2459 line)---during the next recalculation the field will be filled again.
2460 To remove a formula from a field, you have to give an empty reply when
2461 prompted for the formula, or to edit the @samp{#+TBLFM} line.
2464 You may edit the @samp{#+TBLFM} directly and re-apply the changed
2465 equations with @kbd{C-c C-c} in that line or with the normal
2466 recalculation commands in the table.
2468 @subsubheading Debugging formulas
2469 @cindex formula debugging
2470 @cindex debugging, of table formulas
2471 When the evaluation of a formula leads to an error, the field content
2472 becomes the string @samp{#ERROR}. If you would like see what is going
2473 on during variable substitution and calculation in order to find a bug,
2474 turn on formula debugging in the @code{Tbl} menu and repeat the
2475 calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
2476 field. Detailed information will be displayed.
2478 @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet
2479 @subsection Updating the table
2480 @cindex recomputing table fields
2481 @cindex updating, table
2483 Recalculation of a table is normally not automatic, but needs to be
2484 triggered by a command. See @ref{Advanced features}, for a way to make
2485 recalculation at least semi-automatic.
2487 In order to recalculate a line of a table or the entire table, use the
2493 Recalculate the current row by first applying the stored column formulas
2494 from left to right, and all field formulas in the current row.
2500 Recompute the entire table, line by line. Any lines before the first
2501 hline are left alone, assuming that these are part of the table header.
2503 @kindex C-u C-u C-c *
2504 @kindex C-u C-u C-c C-c
2506 @itemx C-u C-u C-c C-c
2507 Iterate the table by recomputing it until no further changes occur.
2508 This may be necessary if some computed fields use the value of other
2509 fields that are computed @i{later} in the calculation sequence.
2512 @node Advanced features, , Updating the table, The spreadsheet
2513 @subsection Advanced features
2515 If you want the recalculation of fields to happen automatically, or if
2516 you want to be able to assign @i{names} to fields and columns, you need
2517 to reserve the first column of the table for special marking characters.
2521 Rotate the calculation mark in first column through the states @samp{},
2522 @samp{#}, @samp{*}, @samp{!}, @samp{$}. When there is an active region,
2523 change all marks in the region.
2526 Here is an example of a table that collects exam results of students and
2527 makes use of these features:
2531 |---+---------+--------+--------+--------+-------+------|
2532 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
2533 |---+---------+--------+--------+--------+-------+------|
2534 | ! | | P1 | P2 | P3 | Tot | |
2535 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
2536 | ^ | | m1 | m2 | m3 | mt | |
2537 |---+---------+--------+--------+--------+-------+------|
2538 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
2539 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
2540 |---+---------+--------+--------+--------+-------+------|
2541 | | Average | | | | 29.7 | |
2542 | ^ | | | | | at | |
2543 | $ | max=50 | | | | | |
2544 |---+---------+--------+--------+--------+-------+------|
2545 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
2549 @noindent @b{Important}: please note that for these special tables,
2550 recalculating the table with @kbd{C-u C-c *} will only affect rows that
2551 are marked @samp{#} or @samp{*}, and fields that have a formula assigned
2552 to the field itself. The column formulas are not applied in rows with
2555 @cindex marking characters, tables
2556 The marking characters have the following meaning:
2559 The fields in this line define names for the columns, so that you may
2560 refer to a column as @samp{$Tot} instead of @samp{$6}.
2562 This row defines names for the fields @emph{above} the row. With such
2563 a definition, any formula in the table may use @samp{$m1} to refer to
2564 the value @samp{10}. Also, if you assign a formula to a names field, it
2565 will be stored as @samp{$name=...}.
2567 Similar to @samp{^}, but defines names for the fields in the row
2570 Fields in this row can define @emph{parameters} for formulas. For
2571 example, if a field in a @samp{$} row contains @samp{max=50}, then
2572 formulas in this table can refer to the value 50 using @samp{$max}.
2573 Parameters work exactly like constants, only that they can be defined on
2576 Fields in this row are automatically recalculated when pressing
2577 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row
2578 is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked
2579 lines will be left alone by this command.
2581 Selects this line for global recalculation with @kbd{C-u C-c *}, but
2582 not for automatic recalculation. Use this when automatic
2583 recalculation slows down editing too much.
2585 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
2586 All lines that should be recalculated should be marked with @samp{#}
2589 Do not export this line. Useful for lines that contain the narrowing
2593 Finally, just to whet your appetite for what can be done with the
2594 fantastic @file{calc.el} package, here is a table that computes the Taylor
2595 series of degree @code{n} at location @code{x} for a couple of
2600 |---+-------------+---+-----+--------------------------------------|
2601 | | Func | n | x | Result |
2602 |---+-------------+---+-----+--------------------------------------|
2603 | # | exp(x) | 1 | x | 1 + x |
2604 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
2605 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
2606 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
2607 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
2608 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
2609 |---+-------------+---+-----+--------------------------------------|
2610 #+TBLFM: $5=taylor($2,$4,$3);n3
2614 @node Org-Plot, , The spreadsheet, Tables
2616 @cindex graph, in tables
2617 @cindex plot tables using gnuplot
2620 Org-Plot can produce 2D and 3D graphs of information stored in org tables
2621 using @file{Gnuplot} @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
2622 @uref{http://cars9.uchicago.edu/~ravel/software/gnuplot-mode.html}. To see
2623 this in action, ensure that you have both Gnuplot and Gnuplot mode installed
2624 on your system, then call @code{org-plot/gnuplot} on the following table.
2628 #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
2629 | Sede | Max cites | H-index |
2630 |-----------+-----------+---------|
2631 | Chile | 257.72 | 21.39 |
2632 | Leeds | 165.77 | 19.68 |
2633 | Sao Paolo | 71.00 | 11.50 |
2634 | Stockholm | 134.19 | 14.33 |
2635 | Morelia | 257.56 | 17.67 |
2639 Notice that Org Plot is smart enough to apply the table's headers as labels.
2640 Further control over the labels, type, content, and appearance of plots can
2641 be exercised through the @code{#+PLOT:} lines preceding a table. See below
2642 for a complete list of Org-plot options. For more information and examples
2643 see the Org-plot tutorial at
2644 @uref{http://orgmode.org/worg/org-tutorials/org-plot.php}.
2646 @subsubheading Plot Options
2650 Specify any @command{gnuplot} option to be set when graphing.
2653 Specify the title of the plot.
2656 Specify which column of the table to use as the @code{x} axis.
2659 Specify the columns to graph as a Lisp style list, surrounded by parentheses
2660 and separated by spaces for example @code{dep:(3 4)} to graph the third and
2661 fourth columns (defaults to graphing all other columns aside from the @code{ind}
2665 Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
2668 Specify a @code{with} option to be inserted for every col being plotted
2669 (@eg @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
2670 Defaults to @code{lines}.
2673 If you want to plot to a file, specify @code{"@var{path/to/desired/output-file}"}.
2676 List of labels to be used for the deps (defaults to the column headers if
2680 Specify an entire line to be inserted in the Gnuplot script.
2683 When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
2684 flat mapping rather than a @code{3d} slope.
2687 Specify format of Org-mode timestamps as they will be parsed by Gnuplot.
2688 Defaults to @samp{%Y-%m-%d-%H:%M:%S}.
2691 If you want total control, you can specify a script file (place the file name
2692 between double-quotes) which will be used to plot. Before plotting, every
2693 instance of @code{$datafile} in the specified script will be replaced with
2694 the path to the generated data file. Note: even if you set this option, you
2695 may still want to specify the plot type, as that can impact the content of
2699 @node Hyperlinks, TODO Items, Tables, Top
2703 Like HTML, Org provides links inside a file, external links to
2704 other files, Usenet articles, emails, and much more.
2707 * Link format:: How links in Org are formatted
2708 * Internal links:: Links to other places in the current file
2709 * External links:: URL-like links to the world
2710 * Handling links:: Creating, inserting and following
2711 * Using links outside Org:: Linking from my C source code?
2712 * Link abbreviations:: Shortcuts for writing complex links
2713 * Search options:: Linking to a specific location
2714 * Custom searches:: When the default search is not enough
2717 @node Link format, Internal links, Hyperlinks, Hyperlinks
2718 @section Link format
2720 @cindex format, of links
2722 Org will recognize plain URL-like links and activate them as
2723 clickable links. The general link format, however, looks like this:
2726 [[link][description]] @r{or alternatively} [[link]]
2730 Once a link in the buffer is complete (all brackets present), Org
2731 will change the display so that @samp{description} is displayed instead
2732 of @samp{[[link][description]]} and @samp{link} is displayed instead of
2733 @samp{[[link]]}. Links will be highlighted in the face @code{org-link},
2734 which by default is an underlined face. You can directly edit the
2735 visible part of a link. Note that this can be either the @samp{link}
2736 part (if there is no description) or the @samp{description} part. To
2737 edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
2740 If you place the cursor at the beginning or just behind the end of the
2741 displayed text and press @key{BACKSPACE}, you will remove the
2742 (invisible) bracket at that location. This makes the link incomplete
2743 and the internals are again displayed as plain text. Inserting the
2744 missing bracket hides the link internals again. To show the
2745 internal structure of all links, use the menu entry
2746 @code{Org->Hyperlinks->Literal links}.
2748 @node Internal links, External links, Link format, Hyperlinks
2749 @section Internal links
2750 @cindex internal links
2751 @cindex links, internal
2752 @cindex targets, for links
2754 @cindex property, CUSTOM_ID
2755 If the link does not look like a URL, it is considered to be internal in the
2756 current file. The most important case is a link like
2757 @samp{[[#my-custom-id]]} which will link to the entry with the
2758 @code{CUSTOM_ID} property @samp{my-custom-id}. Such custom IDs are very good
2759 for HTML export (@pxref{HTML export}) where they produce pretty section
2760 links. You are responsible yourself to make sure these custom IDs are unique
2763 Links such as @samp{[[My Target]]} or @samp{[[My Target][Find my target]]}
2764 lead to a text search in the current file.
2766 The link can be followed with @kbd{C-c C-o} when the cursor is on the link,
2767 or with a mouse click (@pxref{Handling links}). Links to custom IDs will
2768 point to the corresponding headline. The preferred match for a text link is
2769 a @i{dedicated target}: the same string in double angular brackets. Targets
2770 may be located anywhere; sometimes it is convenient to put them into a
2771 comment line. For example
2777 @noindent In HTML export (@pxref{HTML export}), such targets will become
2778 named anchors for direct access through @samp{http} links@footnote{Note that
2779 text before the first headline is usually not exported, so the first such
2780 target should be after the first headline, or in the line directly before the
2783 If no dedicated target exists, Org will search for the words in the link. In
2784 the above example the search would be for @samp{my target}. Links starting
2785 with a star like @samp{*My Target} restrict the search to
2786 headlines@footnote{To insert a link targeting a headline, in-buffer
2787 completion can be used. Just type a star followed by a few optional letters
2788 into the buffer and press @kbd{M-@key{TAB}}. All headlines in the current
2789 buffer will be offered as completions. @xref{Handling links}, for more
2790 commands creating links.}. When searching, Org mode will first try an
2791 exact match, but then move on to more and more lenient searches. For
2792 example, the link @samp{[[*My Targets]]} will find any of the following:
2796 ** TODO my targets are bright
2797 ** my 20 targets are
2801 Following a link pushes a mark onto Org's own mark ring. You can
2802 return to the previous position with @kbd{C-c &}. Using this command
2803 several times in direct succession goes back to positions recorded
2807 * Radio targets:: Make targets trigger links in plain text
2810 @node Radio targets, , Internal links, Internal links
2811 @subsection Radio targets
2812 @cindex radio targets
2813 @cindex targets, radio
2814 @cindex links, radio targets
2816 Org can automatically turn any occurrences of certain target names
2817 in normal text into a link. So without explicitly creating a link, the
2818 text connects to the target radioing its position. Radio targets are
2819 enclosed by triple angular brackets. For example, a target @samp{<<<My
2820 Target>>>} causes each occurrence of @samp{my target} in normal text to
2821 become activated as a link. The Org file is scanned automatically
2822 for radio targets only when the file is first loaded into Emacs. To
2823 update the target list during editing, press @kbd{C-c C-c} with the
2824 cursor on or at a target.
2826 @node External links, Handling links, Internal links, Hyperlinks
2827 @section External links
2828 @cindex links, external
2829 @cindex external links
2830 @cindex links, external
2838 @cindex WANDERLUST links
2840 @cindex USENET links
2845 Org supports links to files, websites, Usenet and email messages,
2846 BBDB database entries and links to both IRC conversations and their
2847 logs. External links are URL-like locators. They start with a short
2848 identifying string followed by a colon. There can be no space after
2849 the colon. The following list shows examples for each link type.
2852 http://www.astro.uva.nl/~dominik @r{on the web}
2853 file:/home/dominik/images/jupiter.jpg @r{file, absolute path}
2854 /home/dominik/images/jupiter.jpg @r{same as above}
2855 file:papers/last.pdf @r{file, relative path}
2856 ./papers/last.pdf @r{same as above}
2857 file:projects.org @r{another Org file}
2858 file:projects.org::some words @r{text search in Org file}
2859 file:projects.org::*task title @r{heading search in Org file}
2860 id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID}
2861 news:comp.emacs @r{Usenet link}
2862 mailto:adent@@galaxy.net @r{Mail link}
2863 vm:folder @r{VM folder link}
2864 vm:folder#id @r{VM message link}
2865 vm://myself@@some.where.org/folder#id @r{VM on remote machine}
2866 wl:folder @r{WANDERLUST folder link}
2867 wl:folder#id @r{WANDERLUST message link}
2868 mhe:folder @r{MH-E folder link}
2869 mhe:folder#id @r{MH-E message link}
2870 rmail:folder @r{RMAIL folder link}
2871 rmail:folder#id @r{RMAIL message link}
2872 gnus:group @r{Gnus group link}
2873 gnus:group#id @r{Gnus article link}
2874 bbdb:R.*Stallman @r{BBDB link (with regexp)}
2875 irc:/irc.com/#emacs/bob @r{IRC link}
2876 shell:ls *.org @r{A shell command}
2877 elisp:org-agenda @r{Interactive Elisp command}
2878 elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
2881 A link should be enclosed in double brackets and may contain a
2882 descriptive text to be displayed instead of the URL (@pxref{Link
2883 format}), for example:
2886 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
2890 If the description is a file name or URL that points to an image, HTML
2891 export (@pxref{HTML export}) will inline the image as a clickable
2892 button. If there is no description at all and the link points to an
2894 that image will be inlined into the exported HTML file.
2896 @cindex square brackets, around links
2897 @cindex plain text external links
2898 Org also finds external links in the normal text and activates them
2899 as links. If spaces must be part of the link (for example in
2900 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
2901 about the end of the link, enclose them in square brackets.
2903 @node Handling links, Using links outside Org, External links, Hyperlinks
2904 @section Handling links
2905 @cindex links, handling
2907 Org provides methods to create a link in the correct syntax, to
2908 insert it into an Org file, and to follow the link.
2912 @cindex storing links
2914 Store a link to the current location. This is a @emph{global} command (you
2915 must create the key binding yourself) which can be used in any buffer to
2916 create a link. The link will be stored for later insertion into an Org
2917 buffer (see below). What kind of link will be created depends on the current
2920 @b{Org-mode buffers}@*
2921 For Org files, if there is a @samp{<<target>>} at the cursor, the link points
2922 to the target. Otherwise it points to the current headline, which will also
2925 @vindex org-link-to-org-use-id
2926 @cindex property, CUSTOM_ID
2927 @cindex property, ID
2928 If the headline has a @code{CUSTOM_ID} property, a link to this custom ID
2929 will be stored. In addition or alternatively (depending on the value of
2930 @code{org-link-to-org-use-id}), a globally unique @code{ID} property will be
2931 created and/or used to construct a link. So using this command in Org
2932 buffers will potentially create two links: a human-readable from the custom
2933 ID, and one that is globally unique and works even if the entry is moved from
2934 file to file. Later, when inserting the link, you need to decide which one
2937 @b{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus}@*
2938 Pretty much all Emacs mail clients are supported. The link will point to the
2939 current article, or, in some GNUS buffers, to the group. The description is
2940 constructed from the author and the subject.
2942 @b{Web browsers: W3 and W3M}@*
2943 Here the link will be the current URL, with the page title as description.
2945 @b{Contacts: BBDB}@*
2946 Links created in a BBDB buffer will point to the current entry.
2949 @vindex org-irc-link-to-logs
2950 For IRC links, if you set the variable @code{org-irc-link-to-logs} to
2951 @code{t}, a @samp{file:/} style link to the relevant point in the logs for
2952 the current conversation is created. Otherwise an @samp{irc:/} style link to
2953 the user/channel/server under the point will be stored.
2956 For any other files, the link will point to the file, with a search string
2957 (@pxref{Search options}) pointing to the contents of the current line. If
2958 there is an active region, the selected words will form the basis of the
2959 search string. If the automatically created link is not working correctly or
2960 accurately enough, you can write custom functions to select the search string
2961 and to do the search for particular file types---see @ref{Custom searches}.
2962 The key binding @kbd{C-c l} is only a suggestion---see @ref{Installation}.
2965 @cindex link completion
2966 @cindex completion, of links
2967 @cindex inserting links
2969 @vindex org-keep-stored-link-after-insertion
2970 Insert a link@footnote{ Note that you don't have to use this command to
2971 insert a link. Links in Org are plain text, and you can type or paste them
2972 straight into the buffer. By using this command, the links are automatically
2973 enclosed in double brackets, and you will be asked for the optional
2974 descriptive text.}. This prompts for a link to be inserted into the buffer.
2975 You can just type a link, using text for an internal link, or one of the link
2976 type prefixes mentioned in the examples above. The link will be inserted
2977 into the buffer@footnote{After insertion of a stored link, the link will be
2978 removed from the list of stored links. To keep it in the list later use, use
2979 a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
2980 @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
2981 If some text was selected when this command is called, the selected text
2982 becomes the default description.
2984 @b{Inserting stored links}@*
2985 All links stored during the
2986 current session are part of the history for this prompt, so you can access
2987 them with @key{up} and @key{down} (or @kbd{M-p/n}).
2989 @b{Completion support}@* Completion with @key{TAB} will help you to insert
2990 valid link prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
2991 defined through link abbreviations (@pxref{Link abbreviations}). If you
2992 press @key{RET} after inserting only the @var{prefix}, Org will offer
2993 specific completion support for some link types@footnote{This works by
2994 calling a special function @code{org-PREFIX-complete-link}.} For
2995 example, if you type @kbd{file @key{RET}}, file name completion (alternative
2996 access: @kbd{C-u C-c C-l}, see below) will be offered, and after @kbd{bbdb
2997 @key{RET}} you can complete contact names.
2999 @cindex file name completion
3000 @cindex completion, of file names
3002 When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
3003 a file will be inserted and you may use file name completion to select
3004 the name of the file. The path to the file is inserted relative to the
3005 directory of the current Org file, if the linked file is in the current
3006 directory or in a sub-directory of it, or if the path is written relative
3007 to the current directory using @samp{../}. Otherwise an absolute path
3008 is used, if possible with @samp{~/} for your home directory. You can
3009 force an absolute path with two @kbd{C-u} prefixes.
3011 @item C-c C-l @r{(with cursor on existing link)}
3012 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
3013 link and description parts of the link.
3015 @cindex following links
3018 @item C-c C-o @r{or} @key{RET}
3019 @vindex org-file-apps
3020 Open link at point. This will launch a web browser for URLs (using
3021 @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
3022 the corresponding links, and execute the command in a shell link. When the
3023 cursor is on an internal link, this commands runs the corresponding search.
3024 When the cursor is on a TAG list in a headline, it creates the corresponding
3025 TAGS view. If the cursor is on a timestamp, it compiles the agenda for that
3026 date. Furthermore, it will visit text and remote files in @samp{file:} links
3027 with Emacs and select a suitable application for local non-text files.
3028 Classification of files is based on file extension only. See option
3029 @code{org-file-apps}. If you want to override the default application and
3030 visit the file with Emacs, use a @kbd{C-u} prefix. If you want to avoid
3031 opening in Emacs, use a @kbd{C-u C-u} prefix.
3037 On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
3038 would. Under Emacs 22, @kbd{mouse-1} will also follow a link.
3042 @vindex org-display-internal-link-with-indirect-buffer
3043 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
3044 internal links to be displayed in another window@footnote{See the
3045 variable @code{org-display-internal-link-with-indirect-buffer}}.
3050 Push the current position onto the mark ring, to be able to return
3051 easily. Commands following an internal link do this automatically.
3053 @cindex links, returning to
3056 Jump back to a recorded position. A position is recorded by the
3057 commands following internal links, and by @kbd{C-c %}. Using this
3058 command several times in direct succession moves through a ring of
3059 previously recorded positions.
3063 @cindex links, finding next/previous
3066 Move forward/backward to the next link in the buffer. At the limit of
3067 the buffer, the search fails once, and then wraps around. The key
3068 bindings for this are really too long, you might want to bind this also
3069 to @kbd{C-n} and @kbd{C-p}
3071 (add-hook 'org-load-hook
3073 (define-key 'org-mode-map "\C-n" 'org-next-link)
3074 (define-key 'org-mode-map "\C-p" 'org-previous-link)))
3078 @node Using links outside Org, Link abbreviations, Handling links, Hyperlinks
3079 @section Using links outside Org
3081 You can insert and follow links that have Org syntax not only in
3082 Org, but in any Emacs buffer. For this, you should create two
3083 global commands, like this (please select suitable global keys
3087 (global-set-key "\C-c L" 'org-insert-link-global)
3088 (global-set-key "\C-c o" 'org-open-at-point-global)
3091 @node Link abbreviations, Search options, Using links outside Org, Hyperlinks
3092 @section Link abbreviations
3093 @cindex link abbreviations
3094 @cindex abbreviation, links
3096 Long URLs can be cumbersome to type, and often many similar links are
3097 needed in a document. For this you can use link abbreviations. An
3098 abbreviated link looks like this
3101 [[linkword:tag][description]]
3105 @vindex org-link-abbrev-alist
3106 where the tag is optional. The @i{linkword} must be a word; letter, numbers,
3107 @samp{-}, and @samp{_} are allowed here. Abbreviations are resolved
3108 according to the information in the variable @code{org-link-abbrev-alist}
3109 that relates the linkwords to replacement text. Here is an example:
3113 (setq org-link-abbrev-alist
3114 '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
3115 ("google" . "http://www.google.com/search?q=")
3116 ("ads" . "http://adsabs.harvard.edu/cgi-bin/
3117 nph-abs_connect?author=%s&db_key=AST")))
3121 If the replacement text contains the string @samp{%s}, it will be
3122 replaced with the tag. Otherwise the tag will be appended to the string
3123 in order to create the link. You may also specify a function that will
3124 be called with the tag as the only argument to create the link.
3126 With the above setting, you could link to a specific bug with
3127 @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
3128 @code{[[google:OrgMode]]} and find out what the Org author is
3129 doing besides Emacs hacking with @code{[[ads:Dominik,C]]}.
3131 If you need special abbreviations just for a single Org buffer, you
3132 can define them in the file with
3136 #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
3137 #+LINK: google http://www.google.com/search?q=%s
3141 In-buffer completion (@pxref{Completion}) can be used after @samp{[} to
3142 complete link abbreviations. You may also define a function
3143 @code{org-PREFIX-complete-link} that implements special (@eg completion)
3144 support for inserting such a link with @kbd{C-c C-l}. Such a function should
3145 not accept any arguments, and return the full link with prefix.
3147 @node Search options, Custom searches, Link abbreviations, Hyperlinks
3148 @section Search options in file links
3149 @cindex search option in file links
3150 @cindex file links, searching
3152 File links can contain additional information to make Emacs jump to a
3153 particular location in the file when following a link. This can be a
3154 line number or a search option after a double@footnote{For backward
3155 compatibility, line numbers can also follow a single colon.} colon. For
3156 example, when the command @kbd{C-c l} creates a link (@pxref{Handling
3157 links}) to a file, it encodes the words in the current line as a search
3158 string that can be used to find this line back later when following the
3159 link with @kbd{C-c C-o}.
3161 Here is the syntax of the different ways to attach a search to a file
3162 link, together with an explanation:
3165 [[file:~/code/main.c::255]]
3166 [[file:~/xx.org::My Target]]
3167 [[file:~/xx.org::*My Target]]
3168 [[file:~/xx.org::/regexp/]]
3175 Search for a link target @samp{<<My Target>>}, or do a text search for
3176 @samp{my target}, similar to the search in internal links, see
3177 @ref{Internal links}. In HTML export (@pxref{HTML export}), such a file
3178 link will become an HTML reference to the corresponding named anchor in
3181 In an Org file, restrict search to headlines.
3183 Do a regular expression search for @code{regexp}. This uses the Emacs
3184 command @code{occur} to list all matches in a separate window. If the
3185 target file is in Org mode, @code{org-occur} is used to create a
3186 sparse tree with the matches.
3187 @c If the target file is a directory,
3188 @c @code{grep} will be used to search all files in the directory.
3191 As a degenerate case, a file link with an empty file name can be used
3192 to search the current file. For example, @code{[[file:::find me]]} does
3193 a search for @samp{find me} in the current file, just as
3194 @samp{[[find me]]} would.
3196 @node Custom searches, , Search options, Hyperlinks
3197 @section Custom Searches
3198 @cindex custom search strings
3199 @cindex search strings, custom
3201 The default mechanism for creating search strings and for doing the
3202 actual search related to a file link may not work correctly in all
3203 cases. For example, Bib@TeX{} database files have many entries like
3204 @samp{year="1993"} which would not result in good search strings,
3205 because the only unique identification for a Bib@TeX{} entry is the
3208 @vindex org-create-file-search-functions
3209 @vindex org-execute-file-search-functions
3210 If you come across such a problem, you can write custom functions to set
3211 the right search string for a particular file type, and to do the search
3212 for the string in the file. Using @code{add-hook}, these functions need
3213 to be added to the hook variables
3214 @code{org-create-file-search-functions} and
3215 @code{org-execute-file-search-functions}. See the docstring for these
3216 variables for more information. Org actually uses this mechanism
3217 for Bib@TeX{} database files, and you can use the corresponding code as
3218 an implementation example. See the file @file{org-bibtex.el}.
3220 @node TODO Items, Tags, Hyperlinks, Top
3224 Org mode does not maintain TODO lists as separate documents@footnote{Of
3225 course, you can make a document that contains only long lists of TODO items,
3226 but this is not required.}. Instead, TODO items are an integral part of the
3227 notes file, because TODO items usually come up while taking notes! With Org
3228 mode, simply mark any entry in a tree as being a TODO item. In this way,
3229 information is not duplicated, and the entire context from which the TODO
3230 item emerged is always present.
3232 Of course, this technique for managing TODO items scatters them
3233 throughout your notes file. Org mode compensates for this by providing
3234 methods to give you an overview of all the things that you have to do.
3237 * TODO basics:: Marking and displaying TODO entries
3238 * TODO extensions:: Workflow and assignments
3239 * Progress logging:: Dates and notes for progress
3240 * Priorities:: Some things are more important than others
3241 * Breaking down tasks:: Splitting a task into manageable pieces
3242 * Checkboxes:: Tick-off lists
3245 @node TODO basics, TODO extensions, TODO Items, TODO Items
3246 @section Basic TODO functionality
3248 Any headline becomes a TODO item when it starts with the word
3249 @samp{TODO}, for example:
3252 *** TODO Write letter to Sam Fortune
3256 The most important commands to work with TODO entries are:
3260 @cindex cycling, of TODO states
3262 Rotate the TODO state of the current item among
3265 ,-> (unmarked) -> TODO -> DONE --.
3266 '--------------------------------'
3269 The same rotation can also be done ``remotely'' from the timeline and
3270 agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}).
3274 Select a specific keyword using completion or (if it has been set up)
3275 the fast selection interface. For the latter, you need to assign keys
3276 to TODO states, see @ref{Per-file keywords}, and @ref{Setting tags}, for
3279 @kindex S-@key{right}
3280 @kindex S-@key{left}
3281 @vindex org-treat-S-cursor-todo-selection-as-state-change
3284 Select the following/preceding TODO state, similar to cycling. Useful
3285 mostly if more than two TODO states are possible (@pxref{TODO
3286 extensions}). See also @ref{Conflicts}, for a discussion of the interaction
3287 with @code{shift-selection-mode}. See also the variable
3288 @code{org-treat-S-cursor-todo-selection-as-state-change}.
3291 @cindex sparse tree, for TODO
3294 @vindex org-todo-keywords
3295 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds the
3296 entire buffer, but shows all TODO items and the headings hierarchy above
3297 them. With a prefix argument, search for a specific TODO. You will be
3298 prompted for the keyword, and you can also give a list of keywords like
3299 @code{KWD1|KWD2|...} to list entries that match any one of these keywords.
3300 With numeric prefix argument N, show the tree for the Nth keyword in the
3301 variable @code{org-todo-keywords}. With two prefix arguments, find all TODO
3305 Show the global TODO list. Collects the TODO items from all agenda
3306 files (@pxref{Agenda Views}) into a single buffer. The new buffer will
3307 be in @code{agenda-mode}, which provides commands to examine and
3308 manipulate the TODO entries from the new buffer (@pxref{Agenda
3309 commands}). @xref{Global TODO list}, for more information.
3310 @kindex S-M-@key{RET}
3312 Insert a new TODO entry below the current one.
3316 @vindex org-todo-state-tags-triggers
3317 Changing a TODO state can also trigger tag changes. See the docstring of the
3318 option @code{org-todo-state-tags-triggers} for details.
3320 @node TODO extensions, Progress logging, TODO basics, TODO Items
3321 @section Extended use of TODO keywords
3322 @cindex extended TODO keywords
3324 @vindex org-todo-keywords
3325 By default, marked TODO entries have one of only two states: TODO and
3326 DONE. Org mode allows you to classify TODO items in more complex ways
3327 with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With
3328 special setup, the TODO keyword system can work differently in different
3331 Note that @i{tags} are another way to classify headlines in general and
3332 TODO items in particular (@pxref{Tags}).
3335 * Workflow states:: From TODO to DONE in steps
3336 * TODO types:: I do this, Fred does the rest
3337 * Multiple sets in one file:: Mixing it all, and still finding your way
3338 * Fast access to TODO states:: Single letter selection of a state
3339 * Per-file keywords:: Different files, different requirements
3340 * Faces for TODO keywords:: Highlighting states
3341 * TODO dependencies:: When one task needs to wait for others
3344 @node Workflow states, TODO types, TODO extensions, TODO extensions
3345 @subsection TODO keywords as workflow states
3346 @cindex TODO workflow
3347 @cindex workflow states as TODO keywords
3349 You can use TODO keywords to indicate different @emph{sequential} states
3350 in the process of working on an item, for example@footnote{Changing
3351 this variable only becomes effective after restarting Org mode in a
3355 (setq org-todo-keywords
3356 '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
3359 The vertical bar separates the TODO keywords (states that @emph{need
3360 action}) from the DONE states (which need @emph{no further action}). If
3361 you don't provide the separator bar, the last state is used as the DONE
3363 @cindex completion, of TODO keywords
3364 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
3365 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED. You may
3366 also use a numeric prefix argument to quickly select a specific state. For
3367 example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY.
3368 Or you can use @kbd{S-@key{left}} to go backward through the sequence. If you
3369 define many keywords, you can use in-buffer completion
3370 (@pxref{Completion}) or even a special one-key selection scheme
3371 (@pxref{Fast access to TODO states}) to insert these words into the
3372 buffer. Changing a TODO state can be logged with a timestamp, see
3373 @ref{Tracking TODO state changes}, for more information.
3375 @node TODO types, Multiple sets in one file, Workflow states, TODO extensions
3376 @subsection TODO keywords as types
3378 @cindex names as TODO keywords
3379 @cindex types as TODO keywords
3381 The second possibility is to use TODO keywords to indicate different
3382 @emph{types} of action items. For example, you might want to indicate
3383 that items are for ``work'' or ``home''. Or, when you work with several
3384 people on a single project, you might want to assign action items
3385 directly to persons, by using their names as TODO keywords. This would
3386 be set up like this:
3389 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
3392 In this case, different keywords do not indicate a sequence, but rather
3393 different types. So the normal work flow would be to assign a task to a
3394 person, and later to mark it DONE. Org mode supports this style by adapting
3395 the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
3396 @kbd{t} command in the timeline and agenda buffers.}. When used several
3397 times in succession, it will still cycle through all names, in order to first
3398 select the right type for a task. But when you return to the item after some
3399 time and execute @kbd{C-c C-t} again, it will switch from any name directly
3400 to DONE. Use prefix arguments or completion to quickly select a specific
3401 name. You can also review the items of a specific TODO type in a sparse tree
3402 by using a numeric prefix to @kbd{C-c C-v}. For example, to see all things
3403 Lucy has to do, you would use @kbd{C-3 C-c C-v}. To collect Lucy's items
3404 from all agenda files into a single buffer, you would use the numeric prefix
3405 argument as well when creating the global TODO list: @kbd{C-3 C-c t}.
3407 @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions
3408 @subsection Multiple keyword sets in one file
3409 @cindex TODO keyword sets
3411 Sometimes you may want to use different sets of TODO keywords in
3412 parallel. For example, you may want to have the basic
3413 @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
3414 separate state indicating that an item has been canceled (so it is not
3415 DONE, but also does not require action). Your setup would then look
3419 (setq org-todo-keywords
3420 '((sequence "TODO" "|" "DONE")
3421 (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
3422 (sequence "|" "CANCELED")))
3425 The keywords should all be different, this helps Org mode to keep track
3426 of which subsequence should be used for a given entry. In this setup,
3427 @kbd{C-c C-t} only operates within a subsequence, so it switches from
3428 @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
3429 (nothing) to @code{REPORT}. Therefore you need a mechanism to initially
3430 select the correct sequence. Besides the obvious ways like typing a
3431 keyword or using completion, you may also apply the following commands:
3434 @kindex C-S-@key{right}
3435 @kindex C-S-@key{left}
3436 @kindex C-u C-u C-c C-t
3437 @item C-u C-u C-c C-t
3438 @itemx C-S-@key{right}
3439 @itemx C-S-@key{left}
3440 These keys jump from one TODO subset to the next. In the above example,
3441 @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{right}} would jump from @code{TODO} or
3442 @code{DONE} to @code{REPORT}, and any of the words in the second row to
3443 @code{CANCELED}. Note that the @kbd{C-S-} key binding conflict with
3444 @code{shift-selection-mode} (@pxref{Conflicts}).
3445 @kindex S-@key{right}
3446 @kindex S-@key{left}
3449 @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through @emph{all}
3450 keywords from all sets, so for example @kbd{S-@key{<right>}} would switch
3451 from @code{DONE} to @code{REPORT} in the example above. See also
3452 @ref{Conflicts}, for a discussion of the interaction with
3453 @code{shift-selection-mode}.
3456 @node Fast access to TODO states, Per-file keywords, Multiple sets in one file, TODO extensions
3457 @subsection Fast access to TODO states
3459 If you would like to quickly change an entry to an arbitrary TODO state
3460 instead of cycling through the states, you can set up keys for
3461 single-letter access to the states. This is done by adding the section
3462 key after each keyword, in parentheses. For example:
3465 (setq org-todo-keywords
3466 '((sequence "TODO(t)" "|" "DONE(d)")
3467 (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
3468 (sequence "|" "CANCELED(c)")))
3471 @vindex org-fast-tag-selection-include-todo
3472 If you then press @code{C-c C-t} followed by the selection key, the entry
3473 will be switched to this state. @key{SPC} can be used to remove any TODO
3474 keyword from an entry.@footnote{Check also the variable
3475 @code{org-fast-tag-selection-include-todo}, it allows you to change the TODO
3476 state through the tags interface (@pxref{Setting tags}), in case you like to
3477 mingle the two concepts. Note that this means you need to come up with
3478 unique keys across both sets of keywords.}
3480 @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions
3481 @subsection Setting up keywords for individual files
3482 @cindex keyword options
3483 @cindex per-file keywords
3488 It can be very useful to use different aspects of the TODO mechanism in
3489 different files. For file-local settings, you need to add special lines
3490 to the file which set the keywords and interpretation for that file
3491 only. For example, to set one of the two examples discussed above, you
3492 need one of the following lines, starting in column zero anywhere in the
3496 #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
3498 @noindent (you may also write @code{#+SEQ_TODO} to be explicit about the
3499 interpretation, but it means the same as @code{#+TODO}), or
3501 #+TYP_TODO: Fred Sara Lucy Mike | DONE
3504 A setup for using several sets in parallel would be:
3508 #+TODO: REPORT BUG KNOWNCAUSE | FIXED
3512 @cindex completion, of option keywords
3514 @noindent To make sure you are using the correct keyword, type
3515 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
3517 @cindex DONE, final TODO keyword
3518 Remember that the keywords after the vertical bar (or the last keyword
3519 if no bar is there) must always mean that the item is DONE (although you
3520 may use a different word). After changing one of these lines, use
3521 @kbd{C-c C-c} with the cursor still in the line to make the changes
3522 known to Org mode@footnote{Org mode parses these lines only when
3523 Org mode is activated after visiting a file. @kbd{C-c C-c} with the
3524 cursor in a line starting with @samp{#+} is simply restarting Org mode
3525 for the current buffer.}.
3527 @node Faces for TODO keywords, TODO dependencies, Per-file keywords, TODO extensions
3528 @subsection Faces for TODO keywords
3529 @cindex faces, for TODO keywords
3531 @vindex org-todo @r{(face)}
3532 @vindex org-done @r{(face)}
3533 @vindex org-todo-keyword-faces
3534 Org mode highlights TODO keywords with special faces: @code{org-todo}
3535 for keywords indicating that an item still has to be acted upon, and
3536 @code{org-done} for keywords indicating that an item is finished. If
3537 you are using more than 2 different states, you might want to use
3538 special faces for some of them. This can be done using the variable
3539 @code{org-todo-keyword-faces}. For example:
3543 (setq org-todo-keyword-faces
3544 '(("TODO" . org-warning)
3545 ("DEFERRED" . shadow)
3546 ("CANCELED" . (:foreground "blue" :weight bold))))
3550 While using a list with face properties as shown for CANCELED
3551 @emph{should} work, this does not aways seem to be the case. If
3552 necessary, define a special face and use that.
3554 @node TODO dependencies, , Faces for TODO keywords, TODO extensions
3555 @subsection TODO dependencies
3556 @cindex TODO dependencies
3557 @cindex dependencies, of TODO states
3559 @vindex org-enforce-todo-dependencies
3560 @cindex property, ORDERED
3561 The structure of Org files (hierarchy and lists) makes it easy to define TODO
3562 dependencies. Usually, a parent TODO task should not be marked DONE until
3563 all subtasks (defined as children tasks) are marked as DONE. And sometimes
3564 there is a logical sequence to a number of (sub)tasks, so that one task
3565 cannot be acted upon before all siblings above it are done. If you customize
3566 the variable @code{org-enforce-todo-dependencies}, Org will block entries
3567 from changing state to DONE while they have children that are not DONE.
3568 Furthermore, if an entry has a property @code{ORDERED}, each of its children
3569 will be blocked until all earlier siblings are marked DONE. Here is an
3573 * TODO Blocked until (two) is done
3582 ** TODO b, needs to wait for (a)
3583 ** TODO c, needs to wait for (a) and (b)
3589 @vindex org-track-ordered-property-with-tag
3590 @cindex property, ORDERED
3591 Toggle the @code{ORDERED} property of the current entry. A property is used
3592 for this behavior because this should be local to the current entry, not
3593 inherited like a tag. However, if you would like to @i{track} the value of
3594 this property with a tag for better visibility, customize the variable
3595 @code{org-track-ordered-property-with-tag}.
3596 @kindex C-u C-u C-u C-c C-t
3597 @item C-u C-u C-u C-c C-t
3598 Change TODO state, circumventing any state blocking.
3601 @vindex org-agenda-dim-blocked-tasks
3602 If you set the variable @code{org-agenda-dim-blocked-tasks}, TODO entries
3603 that cannot be closed because of such dependencies will be shown in a dimmed
3604 font or even made invisible in agenda views (@pxref{Agenda Views}).
3606 @cindex checkboxes and TODO dependencies
3607 @vindex org-enforce-todo-dependencies
3608 You can also block changes of TODO states by looking at checkboxes
3609 (@pxref{Checkboxes}). If you set the variable
3610 @code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked
3611 checkboxes will be blocked from switching to DONE.
3613 If you need more complex dependency structures, for example dependencies
3614 between entries in different trees or files, check out the contributed
3615 module @file{org-depend.el}.
3618 @node Progress logging, Priorities, TODO extensions, TODO Items
3619 @section Progress logging
3620 @cindex progress logging
3621 @cindex logging, of progress
3623 Org mode can automatically record a timestamp and possibly a note when
3624 you mark a TODO item as DONE, or even each time you change the state of
3625 a TODO item. This system is highly configurable, settings can be on a
3626 per-keyword basis and can be localized to a file or even a subtree. For
3627 information on how to clock working time for a task, see @ref{Clocking
3631 * Closing items:: When was this entry marked DONE?
3632 * Tracking TODO state changes:: When did the status change?
3635 @node Closing items, Tracking TODO state changes, Progress logging, Progress logging
3636 @subsection Closing items
3638 The most basic logging is to keep track of @emph{when} a certain TODO
3639 item was finished. This is achieved with@footnote{The corresponding
3640 in-buffer setting is: @code{#+STARTUP: logdone}}.
3643 (setq org-log-done 'time)
3647 Then each time you turn an entry from a TODO (not-done) state into any
3648 of the DONE states, a line @samp{CLOSED: [timestamp]} will be inserted
3649 just after the headline. If you turn the entry back into a TODO item
3650 through further state cycling, that line will be removed again. If you
3651 want to record a note along with the timestamp, use@footnote{The
3652 corresponding in-buffer setting is: @code{#+STARTUP: lognotedone}}
3655 (setq org-log-done 'note)
3659 You will then be prompted for a note, and that note will be stored below
3660 the entry with a @samp{Closing Note} heading.
3662 In the timeline (@pxref{Timeline}) and in the agenda
3663 (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
3664 display the TODO items with a @samp{CLOSED} timestamp on each day,
3665 giving you an overview of what has been done.
3667 @node Tracking TODO state changes, , Closing items, Progress logging
3668 @subsection Tracking TODO state changes
3669 @cindex drawer, for state change recording
3671 @vindex org-log-states-order-reversed
3672 @vindex org-log-into-drawer
3673 @cindex property, LOG_INTO_DRAWER
3674 When TODO keywords are used as workflow states (@pxref{Workflow states}), you
3675 might want to keep track of when a state change occurred and maybe take a
3676 note about this change. You can either record just a timestamp, or a
3677 time-stamped note for a change. These records will be inserted after the
3678 headline as an itemized list, newest first@footnote{See the variable
3679 @code{org-log-states-order-reversed}}. When taking a lot of notes, you might
3680 want to get the notes out of the way into a drawer (@pxref{Drawers}).
3681 Customize the variable @code{org-log-into-drawer} to get this
3682 behavior---the recommended drawer for this is called @code{LOGBOOK}. You can
3683 also overrule the setting of this variable for a subtree by setting a
3684 @code{LOG_INTO_DRAWER} property.
3686 Since it is normally too much to record a note for every state, Org mode
3687 expects configuration on a per-keyword basis for this. This is achieved by
3688 adding special markers @samp{!} (for a timestamp) and @samp{@@} (for a note)
3689 in parentheses after each keyword. For example, with the setting
3692 (setq org-todo-keywords
3693 '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
3697 @vindex org-log-done
3698 you not only define global TODO keywords and fast access keys, but also
3699 request that a time is recorded when the entry is set to
3700 DONE@footnote{It is possible that Org mode will record two timestamps
3701 when you are using both @code{org-log-done} and state change logging.
3702 However, it will never prompt for two notes---if you have configured
3703 both, the state change recording note will take precedence and cancel
3704 the @samp{Closing Note}.}, and that a note is recorded when switching to
3705 WAIT or CANCELED. The setting for WAIT is even more special: the
3706 @samp{!} after the slash means that in addition to the note taken when
3707 entering the state, a timestamp should be recorded when @i{leaving} the
3708 WAIT state, if and only if the @i{target} state does not configure
3709 logging for entering it. So it has no effect when switching from WAIT
3710 to DONE, because DONE is configured to record a timestamp only. But
3711 when switching from WAIT back to TODO, the @samp{/!} in the WAIT
3712 setting now triggers a timestamp even though TODO has no logging
3715 You can use the exact same syntax for setting logging preferences local
3718 #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
3721 @cindex property, LOGGING
3722 In order to define logging settings that are local to a subtree or a
3723 single item, define a LOGGING property in this entry. Any non-empty
3724 LOGGING property resets all logging settings to nil. You may then turn
3725 on logging for this specific tree using STARTUP keywords like
3726 @code{lognotedone} or @code{logrepeat}, as well as adding state specific
3727 settings like @code{TODO(!)}. For example
3730 * TODO Log each state with only a time
3732 :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
3734 * TODO Only log when switching to WAIT, and when repeating
3736 :LOGGING: WAIT(@@) logrepeat
3738 * TODO No logging at all
3744 @node Priorities, Breaking down tasks, Progress logging, TODO Items
3748 If you use Org mode extensively, you may end up enough TODO items that
3749 it starts to make sense to prioritize them. Prioritizing can be done by
3750 placing a @emph{priority cookie} into the headline of a TODO item, like
3754 *** TODO [#A] Write letter to Sam Fortune
3758 By default, Org mode supports three priorities: @samp{A}, @samp{B}, and
3759 @samp{C}. @samp{A} is the highest priority. An entry without a cookie
3760 is treated as priority @samp{B}. Priorities make a difference only in
3761 the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they have
3762 no inherent meaning to Org mode.
3764 Priorities can be attached to any outline tree entries; they do not need
3770 Set the priority of the current headline. The command prompts for a
3771 priority character @samp{A}, @samp{B} or @samp{C}. When you press
3772 @key{SPC} instead, the priority cookie is removed from the headline.
3773 The priorities can also be changed ``remotely'' from the timeline and
3774 agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
3777 @kindex S-@key{down}
3780 @vindex org-priority-start-cycle-with-default
3781 Increase/decrease priority of current headline@footnote{See also the option
3782 @code{org-priority-start-cycle-with-default}.}. Note that these keys are
3783 also used to modify timestamps (@pxref{Creating timestamps}). See also
3784 @ref{Conflicts}, for a discussion of the interaction with
3785 @code{shift-selection-mode}.
3788 @vindex org-highest-priority
3789 @vindex org-lowest-priority
3790 @vindex org-default-priority
3791 You can change the range of allowed priorities by setting the variables
3792 @code{org-highest-priority}, @code{org-lowest-priority}, and
3793 @code{org-default-priority}. For an individual buffer, you may set
3794 these values (highest, lowest, default) like this (please make sure that
3795 the highest priority is earlier in the alphabet than the lowest
3798 @cindex #+PRIORITIES
3803 @node Breaking down tasks, Checkboxes, Priorities, TODO Items
3804 @section Breaking tasks down into subtasks
3805 @cindex tasks, breaking down
3807 @vindex org-agenda-todo-list-sublevels
3808 It is often advisable to break down large tasks into smaller, manageable
3809 subtasks. You can do this by creating an outline tree below a TODO item,
3810 with detailed subtasks on the tree@footnote{To keep subtasks out of the
3811 global TODO list, see the @code{org-agenda-todo-list-sublevels}.}. To keep
3812 the overview over the fraction of subtasks that are already completed, insert
3813 either @samp{[/]} or @samp{[%]} anywhere in the headline. These cookies will
3814 be updates each time the todo status of a child changes. For example:
3817 * Organize Party [33%]
3818 ** TODO Call people [1/2]
3822 ** DONE Talk to neighbor
3825 @cindex property, COOKIE_DATA
3826 If a heading has both checkboxes and TODO children below it, the meaning of
3827 the statistics cookie become ambiguous. Set the property
3828 @code{COOKIE_DATA} to either @samp{checkbox} or @samp{todo} to resolve
3831 If you would like a TODO entry to automatically change to DONE
3832 when all children are done, you can use the following setup:
3835 (defun org-summary-todo (n-done n-not-done)
3836 "Switch entry to DONE when all subentries are done, to TODO otherwise."
3837 (let (org-log-done org-log-states) ; turn off logging
3838 (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
3840 (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
3844 Another possibility is the use of checkboxes to identify (a hierarchy of) a
3845 large number of subtasks (@pxref{Checkboxes}).
3848 @node Checkboxes, , Breaking down tasks, TODO Items
3852 Every item in a plain list (@pxref{Plain lists}) can be made into a
3853 checkbox by starting it with the string @samp{[ ]}. This feature is
3854 similar to TODO items (@pxref{TODO Items}), but is more lightweight.
3855 Checkboxes are not included into the global TODO list, so they are often
3856 great to split a task into a number of simple steps. Or you can use
3857 them in a shopping list. To toggle a checkbox, use @kbd{C-c C-c}, or
3858 use the mouse (thanks to Piotr Zielinski's @file{org-mouse.el}).
3860 Here is an example of a checkbox list.
3863 * TODO Organize party [2/4]
3864 - [-] call people [1/3]
3869 - [ ] think about what music to play
3870 - [X] talk to the neighbors
3873 Checkboxes work hierarchically, so if a checkbox item has children that
3874 are checkboxes, toggling one of the children checkboxes will make the
3875 parent checkbox reflect if none, some, or all of the children are
3878 @cindex statistics, for checkboxes
3879 @cindex checkbox statistics
3880 @cindex property, COOKIE_DATA
3881 The @samp{[2/4]} and @samp{[1/3]} in the first and second line are cookies
3882 indicating how many checkboxes present in this entry have been checked off,
3883 and the total number of checkboxes present. This can give you an idea on how
3884 many checkboxes remain, even without opening a folded entry. The cookies can
3885 be placed into a headline or into (the first line of) a plain list item.
3886 Each cookie covers checkboxes of direct children structurally below the
3887 headline/item on which the cookie appears@footnote{Set the variable
3888 @code{org-recursive-checkbox-statistics} if you want such cookies to
3889 represent the all checkboxes below the cookie, not just the direct
3890 children.}. You have to insert the cookie yourself by typing either
3891 @samp{[/]} or @samp{[%]}. With @samp{[/]} you get an @samp{n out of m}
3892 result, as in the examples above. With @samp{[%]} you get information about
3893 the percentage of checkboxes checked (in the above example, this would be
3894 @samp{[50%]} and @samp{[33%]}, respectively). In a headline, a cookie can
3895 count either checkboxes below the heading or TODO states of children, and it
3896 will display whatever was changed last. Set the property @code{COOKIE_DATA}
3897 to either @samp{checkbox} or @samp{todo} to resolve this issue.
3899 @cindex blocking, of checkboxes
3900 @cindex checkbox blocking
3901 @cindex property, ORDERED
3902 If the current outline node has an @code{ORDERED} property, checkboxes must
3903 be checked off in sequence, and an error will be thrown if you try to check
3904 off a box while there are unchecked boxes above it.
3906 @noindent The following commands work with checkboxes:
3911 Toggle checkbox status or (with prefix arg) checkbox presence at point. With
3912 double prefix argument, set it to @samp{[-]}, which is considered to be an
3916 Toggle checkbox status or (with prefix arg) checkbox presence at point. With
3917 double prefix argument, set it to @samp{[-]}, which is considered to be an
3921 If there is an active region, toggle the first checkbox in the region
3922 and set all remaining boxes to the same status as the first. With a prefix
3923 arg, add or remove the checkbox for all items in the region.
3925 If the cursor is in a headline, toggle checkboxes in the region between
3926 this headline and the next (so @emph{not} the entire subtree).
3928 If there is no active region, just toggle the checkbox at point.
3930 @kindex M-S-@key{RET}
3932 Insert a new item with a checkbox.
3933 This works only if the cursor is already in a plain list item
3934 (@pxref{Plain lists}).
3937 @vindex org-track-ordered-property-with-tag
3938 @cindex property, ORDERED
3939 Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
3940 be checked off in sequence. A property is used for this behavior because
3941 this should be local to the current entry, not inherited like a tag.
3942 However, if you would like to @i{track} the value of this property with a tag
3943 for better visibility, customize the variable
3944 @code{org-track-ordered-property-with-tag}.
3947 Update the checkbox statistics in the current outline entry. When
3948 called with a @kbd{C-u} prefix, update the entire file. Checkbox
3949 statistic cookies are updated automatically if you toggle checkboxes
3950 with @kbd{C-c C-c} and make new ones with @kbd{M-S-@key{RET}}. If you
3951 delete boxes or add/change them by hand, use this command to get things
3952 back into sync. Or simply toggle any checkbox twice with @kbd{C-c C-c}.
3955 @node Tags, Properties and Columns, TODO Items, Top
3958 @cindex headline tagging
3959 @cindex matching, tags
3960 @cindex sparse tree, tag based
3962 An excellent way to implement labels and contexts for cross-correlating
3963 information is to assign @i{tags} to headlines. Org mode has extensive
3966 @vindex org-tag-faces
3967 Every headline can contain a list of tags; they occur at the end of the
3968 headline. Tags are normal words containing letters, numbers, @samp{_}, and
3969 @samp{@@}. Tags must be preceded and followed by a single colon, @eg{},
3970 @samp{:work:}. Several tags can be specified, as in @samp{:work:urgent:}.
3971 Tags will by default be in bold face with the same color as the headline.
3972 You may specify special faces for specific tags using the variable
3973 @code{org-tag-faces}, in much the same way as you can for TODO keywords
3974 (@pxref{Faces for TODO keywords}).
3977 * Tag inheritance:: Tags use the tree structure of the outline
3978 * Setting tags:: How to assign tags to a headline
3979 * Tag searches:: Searching for combinations of tags
3982 @node Tag inheritance, Setting tags, Tags, Tags
3983 @section Tag inheritance
3984 @cindex tag inheritance
3985 @cindex inheritance, of tags
3986 @cindex sublevels, inclusion into tags match
3988 @i{Tags} make use of the hierarchical structure of outline trees. If a
3989 heading has a certain tag, all subheadings will inherit the tag as
3990 well. For example, in the list
3993 * Meeting with the French group :work:
3994 ** Summary by Frank :boss:notes:
3995 *** TODO Prepare slides for him :action:
3999 the final heading will have the tags @samp{:work:}, @samp{:boss:},
4000 @samp{:notes:}, and @samp{:action:} even though the final heading is not
4001 explicitly marked with those tags. You can also set tags that all entries in
4002 a file should inherit just as if these tags were defined in a hypothetical
4003 level zero that surrounds the entire file.
4007 #+FILETAGS: :Peter:Boss:Secret:
4011 @vindex org-use-tag-inheritance
4012 @vindex org-tags-exclude-from-inheritance
4013 To limit tag inheritance to specific tags, or to turn it off entirely, use
4014 the variables @code{org-use-tag-inheritance} and
4015 @code{org-tags-exclude-from-inheritance}.
4017 @vindex org-tags-match-list-sublevels
4018 When a headline matches during a tags search while tag inheritance is turned
4019 on, all the sublevels in the same tree will (for a simple match form) match
4020 as well@footnote{This is only true if the search does not involve more
4021 complex tests including properties (@pxref{Property searches}).}. The list
4022 of matches may then become very long. If you only want to see the first tags
4023 match in a subtree, configure the variable
4024 @code{org-tags-match-list-sublevels} (not recommended).
4026 @node Setting tags, Tag searches, Tag inheritance, Tags
4027 @section Setting tags
4028 @cindex setting tags
4029 @cindex tags, setting
4032 Tags can simply be typed into the buffer at the end of a headline.
4033 After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is
4034 also a special command for inserting tags:
4039 @cindex completion, of tags
4040 @vindex org-tags-column
4041 Enter new tags for the current headline. Org mode will either offer
4042 completion or a special single-key interface for setting tags, see
4043 below. After pressing @key{RET}, the tags will be inserted and aligned
4044 to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all
4045 tags in the current buffer will be aligned to that column, just to make
4046 things look nice. TAGS are automatically realigned after promotion,
4047 demotion, and TODO state changes (@pxref{TODO basics}).
4050 When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
4053 @vindex org-tag-alist
4054 Org will support tag insertion based on a @emph{list of tags}. By
4055 default this list is constructed dynamically, containing all tags
4056 currently used in the buffer. You may also globally specify a hard list
4057 of tags with the variable @code{org-tag-alist}. Finally you can set
4058 the default tags for a given file with lines like
4062 #+TAGS: @@work @@home @@tennisclub
4063 #+TAGS: laptop car pc sailboat
4066 If you have globally defined your preferred set of tags using the
4067 variable @code{org-tag-alist}, but would like to use a dynamic tag list
4068 in a specific file, add an empty TAGS option line to that file:
4074 @vindex org-tag-persistent-alist
4075 If you have a preferred set of tags that you would like to use in every file,
4076 in addition to those defined on a per-file basis by TAGS option lines, then
4077 you may specify a list of tags with the variable
4078 @code{org-tag-persistent-alist}. You may turn this off on a per-file basis
4079 by adding a STARTUP option line to that file:
4085 By default Org mode uses the standard minibuffer completion facilities for
4086 entering tags. However, it also implements another, quicker, tag selection
4087 method called @emph{fast tag selection}. This allows you to select and
4088 deselect tags with just a single key press. For this to work well you should
4089 assign unique letters to most of your commonly used tags. You can do this
4090 globally by configuring the variable @code{org-tag-alist} in your
4091 @file{.emacs} file. For example, you may find the need to tag many items in
4092 different files with @samp{:@@home:}. In this case you can set something
4096 (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
4099 @noindent If the tag is only relevant to the file you are working on, then you
4100 can instead set the TAGS option line as:
4103 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p)
4106 @noindent The tags interface will show the available tags in a splash
4107 window. If you want to start a new line after a specific tag, insert
4108 @samp{\n} into the tag list
4111 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) \n laptop(l) pc(p)
4114 @noindent or write them in two lines:
4117 #+TAGS: @@work(w) @@home(h) @@tennisclub(t)
4118 #+TAGS: laptop(l) pc(p)
4122 You can also group together tags that are mutually exclusive by using
4126 #+TAGS: @{ @@work(w) @@home(h) @@tennisclub(t) @} laptop(l) pc(p)
4129 @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
4130 and @samp{@@tennisclub} should be selected. Multiple such groups are allowed.
4132 @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
4133 these lines to activate any changes.
4136 To set these mutually exclusive groups in the variable @code{org-tags-alist},
4137 you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
4138 of the braces. Similarly, you can use @code{:newline} to indicate a line
4139 break. The previous example would be set globally by the following
4143 (setq org-tag-alist '((:startgroup . nil)
4144 ("@@work" . ?w) ("@@home" . ?h)
4145 ("@@tennisclub" . ?t)
4147 ("laptop" . ?l) ("pc" . ?p)))
4150 If at least one tag has a selection key then pressing @kbd{C-c C-c} will
4151 automatically present you with a special interface, listing inherited tags,
4152 the tags of the current headline, and a list of all valid tags with
4153 corresponding keys@footnote{Keys will automatically be assigned to tags which
4154 have no configured keys.}. In this interface, you can use the following
4159 Pressing keys assigned to tags will add or remove them from the list of
4160 tags in the current line. Selecting a tag in a group of mutually
4161 exclusive tags will turn off any other tags from that group.
4164 Enter a tag in the minibuffer, even if the tag is not in the predefined
4165 list. You will be able to complete on all tags present in the buffer.
4168 Clear all tags for this line.
4171 Accept the modified set.
4173 Abort without installing changes.
4175 If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
4177 Turn off groups of mutually exclusive tags. Use this to (as an
4178 exception) assign several tags from such a group.
4180 Toggle auto-exit after the next change (see below).
4181 If you are using expert mode, the first @kbd{C-c} will display the
4186 This method lets you assign tags to a headline with very few keys. With
4187 the above setup, you could clear the current tags and set @samp{@@home},
4188 @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
4189 C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@home} to
4190 @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
4191 alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag
4192 @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
4193 @key{RET} @key{RET}}.
4195 @vindex org-fast-tag-selection-single-key
4196 If you find that most of the time you need only a single key press to
4197 modify your list of tags, set the variable
4198 @code{org-fast-tag-selection-single-key}. Then you no longer have to
4199 press @key{RET} to exit fast tag selection---it will immediately exit
4200 after the first change. If you then occasionally need more keys, press
4201 @kbd{C-c} to turn off auto-exit for the current tag selection process
4202 (in effect: start selection with @kbd{C-c C-c C-c} instead of @kbd{C-c
4203 C-c}). If you set the variable to the value @code{expert}, the special
4204 window is not even shown for single-key tag selection, it comes up only
4205 when you press an extra @kbd{C-c}.
4207 @node Tag searches, , Setting tags, Tags
4208 @section Tag searches
4209 @cindex tag searches
4210 @cindex searching for tags
4212 Once a system of tags has been set up, it can be used to collect related
4213 information into special lists.
4220 Create a sparse tree with all headlines matching a tags search. With a
4221 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
4224 Create a global list of tag matches from all agenda files.
4225 @xref{Matching tags and properties}.
4228 @vindex org-tags-match-list-sublevels
4229 Create a global list of tag matches from all agenda files, but check
4230 only TODO items and force checking subitems (see variable
4231 @code{org-tags-match-list-sublevels}).
4234 These commands all prompt for a match string which allows basic Boolean logic
4235 like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and
4236 @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries
4237 which are tagged, like @samp{Kathy} or @samp{Sally}. The full syntax of the search
4238 string is rich and allows also matching against TODO keywords, entry levels
4239 and properties. For a complete description with many examples, see
4240 @ref{Matching tags and properties}.
4243 @node Properties and Columns, Dates and Times, Tags, Top
4244 @chapter Properties and Columns
4247 Properties are a set of key-value pairs associated with an entry. There
4248 are two main applications for properties in Org mode. First, properties
4249 are like tags, but with a value. Second, you can use properties to
4250 implement (very basic) database capabilities in an Org buffer. For
4251 an example of the first application, imagine maintaining a file where
4252 you document bugs and plan releases for a piece of software. Instead of
4253 using tags like @code{:release_1:}, @code{:release_2:}, one can use a
4254 property, say @code{:Release:}, that in different subtrees has different
4255 values, such as @code{1.0} or @code{2.0}. For an example of the second
4256 application of properties, imagine keeping track of your music CDs,
4257 where properties could be things such as the album, artist, date of
4258 release, number of tracks, and so on.
4260 Properties can be conveniently edited and viewed in column view
4261 (@pxref{Column view}).
4264 * Property syntax:: How properties are spelled out
4265 * Special properties:: Access to other Org mode features
4266 * Property searches:: Matching property values
4267 * Property inheritance:: Passing values down the tree
4268 * Column view:: Tabular viewing and editing
4269 * Property API:: Properties for Lisp programmers
4272 @node Property syntax, Special properties, Properties and Columns, Properties and Columns
4273 @section Property syntax
4274 @cindex property syntax
4275 @cindex drawer, for properties
4277 Properties are key-value pairs. They need to be inserted into a special
4278 drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property
4279 is specified on a single line, with the key (surrounded by colons)
4280 first, and the value after it. Here is an example:
4285 *** Goldberg Variations
4287 :Title: Goldberg Variations
4288 :Composer: J.S. Bach
4290 :Publisher: Deutsche Grammophon
4295 You may define the allowed values for a particular property @samp{:Xyz:}
4296 by setting a property @samp{:Xyz_ALL:}. This special property is
4297 @emph{inherited}, so if you set it in a level 1 entry, it will apply to
4298 the entire tree. When allowed values are defined, setting the
4299 corresponding property becomes easier and is less prone to typing
4300 errors. For the example with the CD collection, we can predefine
4301 publishers and the number of disks in a box like this:
4306 :NDisks_ALL: 1 2 3 4
4307 :Publisher_ALL: "Deutsche Grammophon" Philips EMI
4311 If you want to set properties that can be inherited by any entry in a
4312 file, use a line like
4313 @cindex property, _ALL
4316 #+PROPERTY: NDisks_ALL 1 2 3 4
4319 @vindex org-global-properties
4320 Property values set with the global variable
4321 @code{org-global-properties} can be inherited by all entries in all
4325 The following commands help to work with properties:
4330 After an initial colon in a line, complete property keys. All keys used
4331 in the current file will be offered as possible completions.
4334 Set a property. This prompts for a property name and a value. If
4335 necessary, the property drawer is created as well.
4336 @item M-x org-insert-property-drawer
4337 Insert a property drawer into the current entry. The drawer will be
4338 inserted early in the entry, but after the lines with planning
4339 information like deadlines.
4342 With the cursor in a property drawer, this executes property commands.
4344 Set a property in the current entry. Both the property and the value
4345 can be inserted using completion.
4346 @kindex S-@key{right}
4347 @kindex S-@key{left}
4348 @item S-@key{left}/@key{right}
4349 Switch property at point to the next/previous allowed value.
4351 Remove a property from the current entry.
4353 Globally remove a property, from all entries in the current file.
4355 Compute the property at point, using the operator and scope from the
4356 nearest column format definition.
4359 @node Special properties, Property searches, Property syntax, Properties and Columns
4360 @section Special properties
4361 @cindex properties, special
4363 Special properties provide an alternative access method to Org mode
4364 features, like the TODO state or the priority of an entry, discussed in the
4365 previous chapters. This interface exists so that you can include
4366 these states in a column view (@pxref{Column view}), or to use them in
4367 queries. The following property names are special and should not be
4368 used as keys in the properties drawer:
4370 @cindex property, special, TODO
4371 @cindex property, special, TAGS
4372 @cindex property, special, ALLTAGS
4373 @cindex property, special, CATEGORY
4374 @cindex property, special, PRIORITY
4375 @cindex property, special, DEADLINE
4376 @cindex property, special, SCHEDULED
4377 @cindex property, special, CLOSED
4378 @cindex property, special, TIMESTAMP
4379 @cindex property, special, TIMESTAMP_IA
4380 @cindex property, special, CLOCKSUM
4381 @c guessing that ITEM is needed in this area; also, should this list be sorted?
4382 @cindex property, special, ITEM
4384 TODO @r{The TODO keyword of the entry.}
4385 TAGS @r{The tags defined directly in the headline.}
4386 ALLTAGS @r{All tags, including inherited ones.}
4387 CATEGORY @r{The category of an entry.}
4388 PRIORITY @r{The priority of the entry, a string with a single letter.}
4389 DEADLINE @r{The deadline time string, without the angular brackets.}
4390 SCHEDULED @r{The scheduling timestamp, without the angular brackets.}
4391 CLOSED @r{When was this entry closed?}
4392 TIMESTAMP @r{The first keyword-less timestamp in the entry.}
4393 TIMESTAMP_IA @r{The first inactive timestamp in the entry.}
4394 CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}}
4395 @r{must be run first to compute the values.}
4396 ITEM @r{The content of the entry.}
4399 @node Property searches, Property inheritance, Special properties, Properties and Columns
4400 @section Property searches
4401 @cindex properties, searching
4402 @cindex searching, of properties
4404 To create sparse trees and special lists with selection based on properties,
4405 the same commands are used as for tag searches (@pxref{Tag searches}).
4411 Create a sparse tree with all matching entries. With a
4412 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
4415 Create a global list of tag/property matches from all agenda files.
4416 @xref{Matching tags and properties}.
4419 @vindex org-tags-match-list-sublevels
4420 Create a global list of tag matches from all agenda files, but check
4421 only TODO items and force checking of subitems (see variable
4422 @code{org-tags-match-list-sublevels}).
4425 The syntax for the search string is described in @ref{Matching tags and
4428 There is also a special command for creating sparse trees based on a
4434 Create a sparse tree based on the value of a property. This first
4435 prompts for the name of a property, and then for a value. A sparse tree
4436 is created with all entries that define this property with the given
4437 value. If you enclose the value into curly braces, it is interpreted as
4438 a regular expression and matched against the property values.
4441 @node Property inheritance, Column view, Property searches, Properties and Columns
4442 @section Property Inheritance
4443 @cindex properties, inheritance
4444 @cindex inheritance, of properties
4446 @vindex org-use-property-inheritance
4447 The outline structure of Org-mode documents lends itself for an
4448 inheritance model of properties: if the parent in a tree has a certain
4449 property, the children can inherit this property. Org mode does not
4450 turn this on by default, because it can slow down property searches
4451 significantly and is often not needed. However, if you find inheritance
4452 useful, you can turn it on by setting the variable
4453 @code{org-use-property-inheritance}. It may be set to @code{t} to make
4454 all properties inherited from the parent, to a list of properties
4455 that should be inherited, or to a regular expression that matches
4456 inherited properties.
4458 Org mode has a few properties for which inheritance is hard-coded, at
4459 least for the special applications for which they are used:
4461 @cindex property, COLUMNS
4464 The @code{:COLUMNS:} property defines the format of column view
4465 (@pxref{Column view}). It is inherited in the sense that the level
4466 where a @code{:COLUMNS:} property is defined is used as the starting
4467 point for a column view table, independently of the location in the
4468 subtree from where columns view is turned on.
4470 @cindex property, CATEGORY
4471 For agenda view, a category set through a @code{:CATEGORY:} property
4472 applies to the entire subtree.
4474 @cindex property, ARCHIVE
4475 For archiving, the @code{:ARCHIVE:} property may define the archive
4476 location for the entire subtree (@pxref{Moving subtrees}).
4478 @cindex property, LOGGING
4479 The LOGGING property may define logging settings for an entry or a
4480 subtree (@pxref{Tracking TODO state changes}).
4483 @node Column view, Property API, Property inheritance, Properties and Columns
4484 @section Column view
4486 A great way to view and edit properties in an outline tree is
4487 @emph{column view}. In column view, each outline node is turned into a
4488 table row. Columns in this table provide access to properties of the
4489 entries. Org mode implements columns by overlaying a tabular structure
4490 over the headline of each item. While the headlines have been turned
4491 into a table row, you can still change the visibility of the outline
4492 tree. For example, you get a compact table by switching to CONTENTS
4493 view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
4494 is active), but you can still open, read, and edit the entry below each
4495 headline. Or, you can switch to column view after executing a sparse
4496 tree command and in this way get a table only for the selected items.
4497 Column view also works in agenda buffers (@pxref{Agenda Views}) where
4498 queries have collected selected items, possibly from a number of files.
4501 * Defining columns:: The COLUMNS format property
4502 * Using column view:: How to create and use column view
4503 * Capturing column view:: A dynamic block for column view
4506 @node Defining columns, Using column view, Column view, Column view
4507 @subsection Defining columns
4508 @cindex column view, for properties
4509 @cindex properties, column view
4511 Setting up a column view first requires defining the columns. This is
4512 done by defining a column format line.
4515 * Scope of column definitions:: Where defined, where valid?
4516 * Column attributes:: Appearance and content of a column
4519 @node Scope of column definitions, Column attributes, Defining columns, Defining columns
4520 @subsubsection Scope of column definitions
4522 To define a column format for an entire file, use a line like
4526 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
4529 To specify a format that only applies to a specific tree, add a
4530 @code{:COLUMNS:} property to the top node of that tree, for example:
4533 ** Top node for columns view
4535 :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
4539 If a @code{:COLUMNS:} property is present in an entry, it defines columns
4540 for the entry itself, and for the entire subtree below it. Since the
4541 column definition is part of the hierarchical structure of the document,
4542 you can define columns on level 1 that are general enough for all
4543 sublevels, and more specific columns further down, when you edit a
4544 deeper part of the tree.
4546 @node Column attributes, , Scope of column definitions, Defining columns
4547 @subsubsection Column attributes
4548 A column definition sets the attributes of a column. The general
4549 definition looks like this:
4552 %[@var{width}]@var{property}[(@var{title})][@{@var{summary-type}@}]
4556 Except for the percent sign and the property name, all items are
4557 optional. The individual parts have the following meaning:
4560 @var{width} @r{An integer specifying the width of the column in characters.}
4561 @r{If omitted, the width will be determined automatically.}
4562 @var{property} @r{The property that should be edited in this column.}
4563 (title) @r{The header text for the column. If omitted, the}
4564 @r{property name is used.}
4565 @{@var{summary-type}@} @r{The summary type. If specified, the column values for}
4566 @r{parent nodes are computed from the children.}
4567 @r{Supported summary types are:}
4568 @{+@} @r{Sum numbers in this column.}
4569 @{+;%.1f@} @r{Like @samp{+}, but format result with @samp{%.1f}.}
4570 @{$@} @r{Currency, short for @samp{+;%.2f}.}
4571 @{:@} @r{Sum times, HH:MM:SS, plain numbers are hours.}
4572 @{X@} @r{Checkbox status, @samp{[X]} if all children are @samp{[X]}.}
4573 @{X/@} @r{Checkbox status, @samp{[n/m]}.}
4574 @{X%@} @r{Checkbox status, @samp{[n%]}.}
4575 @{min@} @r{Smallest number in column.}
4576 @{max@} @r{Largest number.}
4577 @{mean@} @r{Arithmetic mean of numbers.}
4578 @{:min@} @r{Smallest time value in column.}
4579 @{:max@} @r{Largest time value.}
4580 @{:mean@} @r{Arithmetic mean of time values.}
4584 Here is an example for a complete columns definition, along with allowed
4588 :COLUMNS: %20ITEM %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.}
4589 %10Time_Estimate@{:@} %CLOCKSUM
4590 :Owner_ALL: Tammy Mark Karl Lisa Don
4591 :Status_ALL: "In progress" "Not started yet" "Finished" ""
4592 :Approved_ALL: "[ ]" "[X]"
4596 The first column, @samp{%25ITEM}, means the first 25 characters of the
4597 item itself, @ie of the headline. You probably always should start the
4598 column definition with the @samp{ITEM} specifier. The other specifiers
4599 create columns @samp{Owner} with a list of names as allowed values, for
4600 @samp{Status} with four different possible values, and for a checkbox
4601 field @samp{Approved}. When no width is given after the @samp{%}
4602 character, the column will be exactly as wide as it needs to be in order
4603 to fully display all values. The @samp{Approved} column does have a
4604 modified title (@samp{Approved?}, with a question mark). Summaries will
4605 be created for the @samp{Time_Estimate} column by adding time duration
4606 expressions like HH:MM, and for the @samp{Approved} column, by providing
4607 an @samp{[X]} status if all children have been checked. The
4608 @samp{CLOCKSUM} column is special, it lists the sum of CLOCK intervals
4611 @node Using column view, Capturing column view, Defining columns, Column view
4612 @subsection Using column view
4615 @tsubheading{Turning column view on and off}
4618 @vindex org-columns-default-format
4619 Turn on column view. If the cursor is before the first headline in the file,
4620 column view is turned on for the entire file, using the @code{#+COLUMNS}
4621 definition. If the cusor is somewhere inside the outline, this command
4622 searches the hierarchy, up from point, for a @code{:COLUMNS:} property that
4623 defines a format. When one is found, the column view table is established
4624 for the tree starting at the entry that contains the @code{:COLUMNS:}
4625 property. If no such property is found, the format is taken from the
4626 @code{#+COLUMNS} line or from the variable @code{org-columns-default-format},
4627 and column view is established for the current entry and its subtree.
4630 Recreate the column view, to include recent changes made in the buffer.
4637 @tsubheading{Editing values}
4638 @item @key{left} @key{right} @key{up} @key{down}
4639 Move through the column view from field to field.
4640 @kindex S-@key{left}
4641 @kindex S-@key{right}
4642 @item S-@key{left}/@key{right}
4643 Switch to the next/previous allowed value of the field. For this, you
4644 have to have specified allowed values for a property.
4646 Directly select the nth allowed value, @kbd{0} selects the 10th value.
4650 Same as @kbd{S-@key{left}/@key{right}}
4653 Edit the property at point. For the special properties, this will
4654 invoke the same interface that you normally use to change that
4655 property. For example, when editing a TAGS property, the tag completion
4656 or fast selection interface will pop up.
4659 When there is a checkbox at point, toggle it.
4662 View the full value of this property. This is useful if the width of
4663 the column is smaller than that of the value.
4666 Edit the list of allowed values for this property. If the list is found
4667 in the hierarchy, the modified values is stored there. If no list is
4668 found, the new value is stored in the first entry that is part of the
4669 current column view.
4670 @tsubheading{Modifying the table structure}
4674 Make the column narrower/wider by one character.
4675 @kindex S-M-@key{right}
4676 @item S-M-@key{right}
4677 Insert a new column, to the left of the current column.
4678 @kindex S-M-@key{left}
4679 @item S-M-@key{left}
4680 Delete the current column.
4683 @node Capturing column view, , Using column view, Column view
4684 @subsection Capturing column view
4686 Since column view is just an overlay over a buffer, it cannot be
4687 exported or printed directly. If you want to capture a column view, use
4688 a @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame
4689 of this block looks like this:
4691 @cindex #+BEGIN, columnview
4694 #+BEGIN: columnview :hlines 1 :id "label"
4699 @noindent This dynamic block has the following parameters:
4703 This is the most important parameter. Column view is a feature that is
4704 often localized to a certain (sub)tree, and the capture block might be
4705 at a different location in the file. To identify the tree whose view to
4706 capture, you can use 4 values:
4707 @cindex property, ID
4709 local @r{use the tree in which the capture block is located}
4710 global @r{make a global view, including all headings in the file}
4711 "file:@var{path-to-file}"
4712 @r{run column view at the top of this file}
4713 "@var{ID}" @r{call column view in the tree that has an @code{:ID:}}
4714 @r{property with the value @i{label}. You can use}
4715 @r{@kbd{M-x org-id-copy} to create a globally unique ID for}
4716 @r{the current entry and copy it to the kill-ring.}
4719 When @code{t}, insert an hline after every line. When a number @var{N}, insert
4720 an hline before each headline with level @code{<= @var{N}}.
4722 When set to @code{t}, force column groups to get vertical lines.
4724 When set to a number, don't capture entries below this level.
4725 @item :skip-empty-rows
4726 When set to @code{t}, skip rows where the only non-empty specifier of the
4727 column view is @code{ITEM}.
4732 The following commands insert or update the dynamic block:
4737 Insert a dynamic block capturing a column view. You will be prompted
4738 for the scope or ID of the view.
4743 Update dynamic block at point. The cursor needs to be in the
4744 @code{#+BEGIN} line of the dynamic block.
4745 @kindex C-u C-c C-x C-u
4746 @item C-u C-c C-x C-u
4747 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
4748 you have several clock table blocks in a buffer.
4751 You can add formulas to the column view table and you may add plotting
4752 instructions in front of the table---these will survive an update of the
4753 block. If there is a @code{#+TBLFM:} after the table, the table will
4754 actually be recalculated automatically after an update.
4756 An alternative way to capture and process property values into a table is
4757 provided by Eric Schulte's @file{org-collector.el} which is a contributed
4758 package@footnote{Contributed packages are not part of Emacs, but are
4759 distributed with the main distribution of Org (visit
4760 @uref{http://orgmode.org}).}. It provides a general API to collect
4761 properties from entries in a certain scope, and arbitrary Lisp expressions to
4762 process these values before inserting them into a table or a dynamic block.
4764 @node Property API, , Column view, Properties and Columns
4765 @section The Property API
4766 @cindex properties, API
4767 @cindex API, for properties
4769 There is a full API for accessing and changing properties. This API can
4770 be used by Emacs Lisp programs to work with properties and to implement
4771 features based on them. For more information see @ref{Using the
4774 @node Dates and Times, Capture, Properties and Columns, Top
4775 @chapter Dates and Times
4781 To assist project planning, TODO items can be labeled with a date and/or
4782 a time. The specially formatted string carrying the date and time
4783 information is called a @emph{timestamp} in Org mode. This may be a
4784 little confusing because timestamp is often used as indicating when
4785 something was created or last changed. However, in Org mode this term
4786 is used in a much wider sense.
4789 * Timestamps:: Assigning a time to a tree entry
4790 * Creating timestamps:: Commands which insert timestamps
4791 * Deadlines and scheduling:: Planning your work
4792 * Clocking work time:: Tracking how long you spend on a task
4793 * Effort estimates:: Planning work effort in advance
4794 * Relative timer:: Notes with a running timer
4798 @node Timestamps, Creating timestamps, Dates and Times, Dates and Times
4799 @section Timestamps, deadlines, and scheduling
4801 @cindex ranges, time
4806 A timestamp is a specification of a date (possibly with a time or a range
4807 of times) in a special format, either @samp{<2003-09-16 Tue>} or
4808 @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16 Tue
4809 12:00-12:30>}@footnote{This is the standard ISO date/time format. To
4810 use an alternative format, see @ref{Custom time format}.}. A timestamp
4811 can appear anywhere in the headline or body of an Org tree entry. Its
4812 presence causes entries to be shown on specific dates in the agenda
4813 (@pxref{Weekly/daily agenda}). We distinguish:
4816 @item Plain timestamp; Event; Appointment
4818 A simple timestamp just assigns a date/time to an item. This is just
4819 like writing down an appointment or event in a paper agenda. In the
4820 timeline and agenda displays, the headline of an entry associated with a
4821 plain timestamp will be shown exactly on that date.
4824 * Meet Peter at the movies <2006-11-01 Wed 19:15>
4825 * Discussion on climate change <2006-11-02 Thu 20:00-22:00>
4828 @item Timestamp with repeater interval
4829 @cindex timestamp, with repeater interval
4830 A timestamp may contain a @emph{repeater interval}, indicating that it
4831 applies not only on the given date, but again and again after a certain
4832 interval of N days (d), weeks (w), months (m), or years (y). The
4833 following will show up in the agenda every Wednesday:
4836 * Pick up Sam at school <2007-05-16 Wed 12:30 +1w>
4839 @item Diary-style sexp entries
4840 For more complex date specifications, Org mode supports using the
4841 special sexp diary entries implemented in the Emacs calendar/diary
4842 package. For example
4845 * The nerd meeting on every 2nd Thursday of the month
4846 <%%(diary-float t 4 2)>
4849 @item Time/Date range
4852 Two timestamps connected by @samp{--} denote a range. The headline
4853 will be shown on the first and last day of the range, and on any dates
4854 that are displayed and fall in the range. Here is an example:
4857 ** Meeting in Amsterdam
4858 <2004-08-23 Mon>--<2004-08-26 Thu>
4861 @item Inactive timestamp
4862 @cindex timestamp, inactive
4863 @cindex inactive timestamp
4864 Just like a plain timestamp, but with square brackets instead of
4865 angular ones. These timestamps are inactive in the sense that they do
4866 @emph{not} trigger an entry to show up in the agenda.
4869 * Gillian comes late for the fifth time [2006-11-01 Wed]
4874 @node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times
4875 @section Creating timestamps
4876 @cindex creating timestamps
4877 @cindex timestamps, creating
4879 For Org mode to recognize timestamps, they need to be in the specific
4880 format. All commands listed below produce timestamps in the correct
4886 Prompt for a date and insert a corresponding timestamp. When the cursor is
4887 at an existing timestamp in the buffer, the command is used to modify this
4888 timestamp instead of inserting a new one. When this command is used twice in
4889 succession, a time range is inserted.
4893 Like @kbd{C-c .}, but insert an inactive timestamp that will not cause
4900 @vindex org-time-stamp-rounding-minutes
4901 Like @kbd{C-c .} and @kbd{C-c !}, but use the alternative format which
4902 contains date and time. The default time can be rounded to multiples of 5
4903 minutes, see the option @code{org-time-stamp-rounding-minutes}.
4907 Insert a timestamp corresponding to the cursor date in the Calendar.
4911 Access the Emacs calendar for the current date. If there is a
4912 timestamp in the current line, go to the corresponding date
4917 Access the agenda for the date given by the timestamp or -range at
4918 point (@pxref{Weekly/daily agenda}).
4920 @kindex S-@key{left}
4921 @kindex S-@key{right}
4923 @itemx S-@key{right}
4924 Change date at cursor by one day. These key bindings conflict with
4925 shift-selection and related modes (@pxref{Conflicts}).
4928 @kindex S-@key{down}
4931 Change the item under the cursor in a timestamp. The cursor can be on a
4932 year, month, day, hour or minute. When the timestamp contains a time range
4933 like @samp{15:30-16:30}, modifying the first time will also shift the second,
4934 shifting the time block with constant length. To change the length, modify
4935 the second time. Note that if the cursor is in a headline and not at a
4936 timestamp, these same keys modify the priority of an item.
4937 (@pxref{Priorities}). The key bindings also conflict with shift-selection and
4938 related modes (@pxref{Conflicts}).
4941 @cindex evaluate time range
4943 Evaluate a time range by computing the difference between start and end.
4944 With a prefix argument, insert result after the time range (in a table: into
4945 the following column).
4950 * The date/time prompt:: How Org mode helps you entering date and time
4951 * Custom time format:: Making dates look different
4954 @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps
4955 @subsection The date/time prompt
4956 @cindex date, reading in minibuffer
4957 @cindex time, reading in minibuffer
4959 @vindex org-read-date-prefer-future
4960 When Org mode prompts for a date/time, the default is shown as an ISO
4961 date, and the prompt therefore seems to ask for an ISO date. But it
4962 will in fact accept any string containing some date and/or time
4963 information, and it is really smart about interpreting your input. You
4964 can, for example, use @kbd{C-y} to paste a (possibly multi-line) string
4965 copied from an email message. Org mode will find whatever information
4966 is in there and derive anything you have not specified from the
4967 @emph{default date and time}. The default is usually the current date
4968 and time, but when modifying an existing timestamp, or when entering
4969 the second stamp of a range, it is taken from the stamp in the buffer.
4970 When filling in information, Org mode assumes that most of the time you
4971 will want to enter a date in the future: if you omit the month/year and
4972 the given day/month is @i{before} today, it will assume that you mean a
4973 future date@footnote{See the variable
4974 @code{org-read-date-prefer-future}.}.
4976 For example, let's assume that today is @b{June 13, 2006}. Here is how
4977 various inputs will be interpreted, the items filled in by Org mode are
4981 3-2-5 --> 2003-02-05
4982 14 --> @b{2006}-@b{06}-14
4983 12 --> @b{2006}-@b{07}-12
4984 Fri --> nearest Friday (defaultdate or later)
4985 sep 15 --> @b{2006}-09-15
4986 feb 15 --> @b{2007}-02-15
4987 sep 12 9 --> 2009-09-12
4988 12:45 --> @b{2006}-@b{06}-@b{13} 12:45
4989 22 sept 0:34 --> @b{2006}-09-22 0:34
4990 w4 --> ISO week for of the current year @b{2006}
4991 2012 w4 fri --> Friday of ISO week 4 in 2012
4992 2012-w04-5 --> Same as above
4995 Furthermore you can specify a relative date by giving, as the
4996 @emph{first} thing in the input: a plus/minus sign, a number and a
4997 letter ([dwmy]) to indicate change in days, weeks, months, or years. With a
4998 single plus or minus, the date is always relative to today. With a
4999 double plus or minus, it is relative to the default date. If instead of
5000 a single letter, you use the abbreviation of day name, the date will be
5001 the nth such day. @Eg
5006 +4d --> four days from today
5007 +4 --> same as above
5008 +2w --> two weeks from today
5009 ++5 --> five days from default date
5010 +2tue --> second Tuesday from now.
5013 @vindex parse-time-months
5014 @vindex parse-time-weekdays
5015 The function understands English month and weekday abbreviations. If
5016 you want to use unabbreviated names and/or other languages, configure
5017 the variables @code{parse-time-months} and @code{parse-time-weekdays}.
5019 @cindex calendar, for selecting date
5020 @vindex org-popup-calendar-for-date-prompt
5021 Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
5022 you don't need/want the calendar, configure the variable
5023 @code{org-popup-calendar-for-date-prompt}.}. When you exit the date
5024 prompt, either by clicking on a date in the calendar, or by pressing
5025 @key{RET}, the date selected in the calendar will be combined with the
5026 information entered at the prompt. You can control the calendar fully
5027 from the minibuffer:
5032 @kindex S-@key{right}
5033 @kindex S-@key{left}
5034 @kindex S-@key{down}
5036 @kindex M-S-@key{right}
5037 @kindex M-S-@key{left}
5040 > / < @r{Scroll calendar forward/backward by one month.}
5041 mouse-1 @r{Select date by clicking on it.}
5042 S-@key{right}/@key{left} @r{One day forward/backward.}
5043 S-@key{down}/@key{up} @r{One week forward/backward.}
5044 M-S-@key{right}/@key{left} @r{One month forward/backward.}
5045 @key{RET} @r{Choose date in calendar.}
5048 @vindex org-read-date-display-live
5049 The actions of the date/time prompt may seem complex, but I assure you they
5050 will grow on you, and you will start getting annoyed by pretty much any other
5051 way of entering a date/time out there. To help you understand what is going
5052 on, the current interpretation of your input will be displayed live in the
5053 minibuffer@footnote{If you find this distracting, turn the display of with
5054 @code{org-read-date-display-live}.}.
5056 @node Custom time format, , The date/time prompt, Creating timestamps
5057 @subsection Custom time format
5058 @cindex custom date/time format
5059 @cindex time format, custom
5060 @cindex date format, custom
5062 @vindex org-display-custom-times
5063 @vindex org-time-stamp-custom-formats
5064 Org mode uses the standard ISO notation for dates and times as it is
5065 defined in ISO 8601. If you cannot get used to this and require another
5066 representation of date and time to keep you happy, you can get it by
5067 customizing the variables @code{org-display-custom-times} and
5068 @code{org-time-stamp-custom-formats}.
5073 Toggle the display of custom formats for dates and times.
5077 Org mode needs the default format for scanning, so the custom date/time
5078 format does not @emph{replace} the default format---instead it is put
5079 @emph{over} the default format using text properties. This has the
5080 following consequences:
5083 You cannot place the cursor onto a timestamp anymore, only before or
5086 The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
5087 each component of a timestamp. If the cursor is at the beginning of
5088 the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
5089 just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the
5090 time will be changed by one minute.
5092 If the timestamp contains a range of clock times or a repeater, these
5093 will not be overlayed, but remain in the buffer as they were.
5095 When you delete a timestamp character-by-character, it will only
5096 disappear from the buffer after @emph{all} (invisible) characters
5097 belonging to the ISO timestamp have been removed.
5099 If the custom timestamp format is longer than the default and you are
5100 using dates in tables, table alignment will be messed up. If the custom
5101 format is shorter, things do work as expected.
5105 @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times
5106 @section Deadlines and scheduling
5108 A timestamp may be preceded by special keywords to facilitate planning:
5112 @cindex DEADLINE keyword
5114 Meaning: the task (most likely a TODO item, though not necessarily) is supposed
5115 to be finished on that date.
5117 @vindex org-deadline-warning-days
5118 On the deadline date, the task will be listed in the agenda. In
5119 addition, the agenda for @emph{today} will carry a warning about the
5120 approaching or missed deadline, starting
5121 @code{org-deadline-warning-days} before the due date, and continuing
5122 until the entry is marked DONE. An example:
5125 *** TODO write article about the Earth for the Guide
5126 The editor in charge is [[bbdb:Ford Prefect]]
5127 DEADLINE: <2004-02-29 Sun>
5130 You can specify a different lead time for warnings for a specific
5131 deadlines using the following syntax. Here is an example with a warning
5132 period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}.
5135 @cindex SCHEDULED keyword
5137 Meaning: you are planning to start working on that task on the given
5140 @vindex org-agenda-skip-scheduled-if-done
5141 The headline will be listed under the given date@footnote{It will still
5142 be listed on that date after it has been marked DONE. If you don't like
5143 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In
5144 addition, a reminder that the scheduled date has passed will be present
5145 in the compilation for @emph{today}, until the entry is marked DONE.
5146 @Ie the task will automatically be forwarded until completed.
5149 *** TODO Call Trillian for a date on New Years Eve.
5150 SCHEDULED: <2004-12-25 Sat>
5154 @b{Important:} Scheduling an item in Org mode should @i{not} be
5155 understood in the same way that we understand @i{scheduling a meeting}.
5156 Setting a date for a meeting is just a simple appointment, you should
5157 mark this entry with a simple plain timestamp, to get this item shown
5158 on the date where it applies. This is a frequent misunderstanding by
5159 Org users. In Org mode, @i{scheduling} means setting a date when you
5160 want to start working on an action item.
5163 You may use timestamps with repeaters in scheduling and deadline
5164 entries. Org mode will issue early and late warnings based on the
5165 assumption that the timestamp represents the @i{nearest instance} of
5166 the repeater. However, the use of diary sexp entries like
5168 @code{<%%(diary-float t 42)>}
5170 in scheduling and deadline timestamps is limited. Org mode does not
5171 know enough about the internals of each sexp function to issue early and
5172 late warnings. However, it will show the item on each day where the
5176 * Inserting deadline/schedule:: Planning items
5177 * Repeated tasks:: Items that show up again and again
5180 @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling
5181 @subsection Inserting deadlines or schedules
5183 The following commands allow you to quickly insert a deadline or to schedule
5190 Insert @samp{DEADLINE} keyword along with a stamp. The insertion will
5191 happen in the line directly following the headline. When called with a
5192 prefix arg, an existing deadline will be removed from the entry.
5193 @c FIXME Any CLOSED timestamp will be removed.????????
5197 Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will
5198 happen in the line directly following the headline. Any CLOSED
5199 timestamp will be removed. When called with a prefix argument, remove
5200 the scheduling date from the entry.
5206 Mark the current entry for agenda action. After you have marked the entry
5207 like this, you can open the agenda or the calendar to find an appropriate
5208 date. With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to
5209 schedule the marked item.
5212 @cindex sparse tree, for deadlines
5214 @vindex org-deadline-warning-days
5215 Create a sparse tree with all deadlines that are either past-due, or
5216 which will become due within @code{org-deadline-warning-days}.
5217 With @kbd{C-u} prefix, show all deadlines in the file. With a numeric
5218 prefix, check that many days. For example, @kbd{C-1 C-c / d} shows
5219 all deadlines due tomorrow.
5223 Sparse tree for deadlines and scheduled items before a given date.
5227 Sparse tree for deadlines and scheduled items after a given date.
5230 @node Repeated tasks, , Inserting deadline/schedule, Deadlines and scheduling
5231 @subsection Repeated tasks
5232 @cindex tasks, repeated
5233 @cindex repeated tasks
5235 Some tasks need to be repeated again and again. Org mode helps to
5236 organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
5237 or plain timestamp. In the following example
5239 ** TODO Pay the rent
5240 DEADLINE: <2005-10-01 Sat +1m>
5243 the @code{+1m} is a repeater; the intended interpretation is that the task
5244 has a deadline on <2005-10-01> and repeats itself every (one) month starting
5245 from that time. If you need both a repeater and a special warning period in
5246 a deadline entry, the repeater should come first and the warning period last:
5247 @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
5249 Deadlines and scheduled items produce entries in the agenda when they
5250 are over-due, so it is important to be able to mark such an entry as
5251 completed once you have done so. When you mark a DEADLINE or a SCHEDULE
5252 with the TODO keyword DONE, it will no longer produce entries in the
5253 agenda. The problem with this is, however, that then also the
5254 @emph{next} instance of the repeated entry will not be active. Org mode
5255 deals with this in the following way: When you try to mark such an entry
5256 DONE (using @kbd{C-c C-t}), it will shift the base date of the repeating
5257 timestamp by the repeater interval, and immediately set the entry state
5258 back to TODO. In the example above, setting the state to DONE would
5259 actually switch the date like this:
5262 ** TODO Pay the rent
5263 DEADLINE: <2005-11-01 Tue +1m>
5266 @vindex org-log-repeat
5267 A timestamp@footnote{You can change this using the option
5268 @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
5269 @code{lognoterepeat}, and @code{nologrepeat}. With @code{lognoterepeat}, you
5270 will also be prompted for a note.} will be added under the deadline, to keep
5271 a record that you actually acted on the previous instance of this deadline.
5273 As a consequence of shifting the base date, this entry will no longer be
5274 visible in the agenda when checking past dates, but all future instances
5277 With the @samp{+1m} cookie, the date shift will always be exactly one
5278 month. So if you have not paid the rent for three months, marking this
5279 entry DONE will still keep it as an overdue deadline. Depending on the
5280 task, this may not be the best way to handle it. For example, if you
5281 forgot to call you father for 3 weeks, it does not make sense to call
5282 him 3 times in a single day to make up for it. Finally, there are tasks
5283 like changing batteries which should always repeat a certain time
5284 @i{after} the last time you did it. For these tasks, Org mode has
5285 special repeaters markers with @samp{++} and @samp{.+}. For example:
5289 DEADLINE: <2008-02-10 Sun ++1w>
5290 Marking this DONE will shift the date by at least one week,
5291 but also by as many weeks as it takes to get this date into
5292 the future. However, it stays on a Sunday, even if you called
5293 and marked it done on Saturday.
5294 ** TODO Check the batteries in the smoke detectors
5295 DEADLINE: <2005-11-01 Tue .+1m>
5296 Marking this DONE will shift the date to one month after
5300 You may have both scheduling and deadline information for a specific
5301 task---just make sure that the repeater intervals on both are the same.
5303 An alternative to using a repeater is to create a number of copies of a task
5304 subtree, with dates shifted in each copy. The command @kbd{C-c C-x c} was
5305 created for this purpose, it is described in @ref{Structure editing}.
5308 @node Clocking work time, Effort estimates, Deadlines and scheduling, Dates and Times
5309 @section Clocking work time
5311 Org mode allows you to clock the time you spend on specific tasks in a
5312 project. When you start working on an item, you can start the clock.
5313 When you stop working on that task, or when you mark the task done, the
5314 clock is stopped and the corresponding time interval is recorded. It
5315 also computes the total time spent on each subtree of a project.
5317 Normally, the clock does not survive exiting and re-entering Emacs, but you
5318 can arrange for the clock information to persist across Emacs sessions with
5321 (setq org-clock-persist t)
5322 (org-clock-persistence-insinuate)
5328 @vindex org-clock-into-drawer
5329 Start the clock on the current item (clock-in). This inserts the CLOCK
5330 keyword together with a timestamp. If this is not the first clocking of
5331 this item, the multiple CLOCK lines will be wrapped into a
5332 @code{:LOGBOOK:} drawer (see also the variable
5333 @code{org-clock-into-drawer}). When called with a @kbd{C-u} prefix argument,
5334 select the task from a list of recently clocked tasks. With two @kbd{C-u
5335 C-u} prefixes, clock into the task at point and mark it as the default task.
5336 The default task will always be available when selecting a clocking task,
5337 with letter @kbd{d}.@*
5338 @cindex property: CLOCK_MODELINE_TOTAL
5339 @cindex property: LAST_REPEAT
5340 @vindex org-clock-modeline-total
5341 While the clock is running, the current clocking time is shown in the mode
5342 line, along with the title of the task. The clock time shown will be all
5343 time ever clocked for this task and its children. If the task has an effort
5344 estimate (@pxref{Effort estimates}), the mode line displays the current
5345 clocking time against it@footnote{To add an effort estimate ``on the fly'',
5346 hook a function doing this to @code{org-clock-in-prepare-hook}.} If the task
5347 is a repeating one (@pxref{Repeated tasks}), only the time since the last
5348 reset of the task @footnote{as recorded by the @code{LAST_REPEAT} property}
5349 will be shown. More control over what time is shown can be exercised with
5350 the @code{CLOCK_MODELINE_TOTAL} property. It may have the values
5351 @code{current} to show only the current clocking instance, @code{today} to
5352 show all time clocked on this tasks today (see also the variable
5353 @code{org-extend-today-until}), @code{all} to include all time, or
5354 @code{auto} which is the default@footnote{See also the variable
5355 @code{org-clock-modeline-total}.}.@* Clicking with @kbd{mouse-1} onto the
5356 mode line entry will pop up a menu with clocking options.
5359 @vindex org-log-note-clock-out
5360 Stop the clock (clock-out). This inserts another timestamp at the same
5361 location where the clock was last started. It also directly computes
5362 the resulting time in inserts it after the time range as @samp{=>
5363 HH:MM}. See the variable @code{org-log-note-clock-out} for the
5364 possibility to record an additional note together with the clock-out
5365 timestamp@footnote{The corresponding in-buffer setting is:
5366 @code{#+STARTUP: lognoteclock-out}}.
5369 Update the effort estimate for the current clock task.
5372 @item C-c C-y @ @ @r{or}@ @ C-c C-c
5373 Recompute the time interval after changing one of the timestamps. This
5374 is only necessary if you edit the timestamps directly. If you change
5375 them with @kbd{S-@key{cursor}} keys, the update is automatic.
5378 Changing the TODO state of an item to DONE automatically stops the clock
5379 if it is running in this same item.
5382 Cancel the current clock. This is useful if a clock was started by
5383 mistake, or if you ended up working on something else.
5386 Jump to the entry that contains the currently running clock. With a
5387 @kbd{C-u} prefix arg, select the target task from a list of recently clocked
5391 @vindex org-remove-highlights-with-change
5392 Display time summaries for each subtree in the current buffer. This
5393 puts overlays at the end of each headline, showing the total time
5394 recorded under that heading, including the time of any subheadings. You
5395 can use visibility cycling to study the tree, but the overlays disappear
5396 when you change the buffer (see variable
5397 @code{org-remove-highlights-with-change}) or press @kbd{C-c C-c}.
5400 Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
5401 report as an Org-mode table into the current file. When the cursor is
5402 at an existing clock table, just update it. When called with a prefix
5403 argument, jump to the first clock report in the current document and
5405 @cindex #+BEGIN, clocktable
5407 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
5411 If such a block already exists at point, its content is replaced by the
5412 new table. The @samp{BEGIN} line can specify options:
5414 :maxlevel @r{Maximum level depth to which times are listed in the table.}
5415 :emphasize @r{When @code{t}, emphasize level one and level two items.}
5416 :scope @r{The scope to consider. This can be any of the following:}
5417 nil @r{the current buffer or narrowed region}
5418 file @r{the full current buffer}
5419 subtree @r{the subtree where the clocktable is located}
5420 tree@var{N} @r{the surrounding level @var{N} tree, for example @code{tree3}}
5421 tree @r{the surrounding level 1 tree}
5422 agenda @r{all agenda files}
5423 ("file"..) @r{scan these files}
5424 file-with-archives @r{current file and its archives}
5425 agenda-with-archives @r{all agenda files, including archives}
5426 :block @r{The time block to consider. This block is specified either}
5427 @r{absolute, or relative to the current time and may be any of}
5429 2007-12-31 @r{New year eve 2007}
5430 2007-12 @r{December 2007}
5431 2007-W50 @r{ISO-week 50 in 2007}
5432 2007 @r{the year 2007}
5433 today, yesterday, today-@var{N} @r{a relative day}
5434 thisweek, lastweek, thisweek-@var{N} @r{a relative week}
5435 thismonth, lastmonth, thismonth-@var{N} @r{a relative month}
5436 thisyear, lastyear, thisyear-@var{N} @r{a relative year}
5437 @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
5438 :tstart @r{A time string specifying when to start considering times.}
5439 :tend @r{A time string specifying when to stop considering times.}
5440 :step @r{@code{week} or @code{day}, to split the table into chunks.}
5441 @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
5442 :link @r{Link the item headlines in the table to their origins.}
5443 :formula @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
5444 @r{As a special case, @samp{:formula %} adds a column with % time.}
5445 @r{If you do not specify a formula here, any existing formula.}
5446 @r{below the clock table will survive updates and be evaluated.}
5447 :timestamp @r{A timestamp for the entry, when available. Look for SCHEDULED,}
5448 @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.}
5450 To get a clock summary of the current level 1 tree, for the current
5451 day, you could write
5453 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
5457 and to use a specific time range you could write@footnote{Note that all
5458 parameters must be specified in a single line---the line is broken here
5459 only to fit it into the manual.}
5461 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
5462 :tend "<2006-08-10 Thu 12:00>"
5465 A summary of the current subtree with % times would be
5467 #+BEGIN: clocktable :scope subtree :link t :formula %
5474 Update dynamic block at point. The cursor needs to be in the
5475 @code{#+BEGIN} line of the dynamic block.
5476 @kindex C-u C-c C-x C-u
5477 @item C-u C-c C-x C-u
5478 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
5479 you have several clock table blocks in a buffer.
5480 @kindex S-@key{left}
5481 @kindex S-@key{right}
5483 @itemx S-@key{right}
5484 Shift the current @code{:block} interval and update the table. The cursor
5485 needs to be in the @code{#+BEGIN: clocktable} line for this command. If
5486 @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
5489 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
5490 the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
5491 worked on or closed during a day.
5493 @node Effort estimates, Relative timer, Clocking work time, Dates and Times
5494 @section Effort estimates
5495 @cindex effort estimates
5497 @cindex property, Effort
5498 @vindex org-effort-property
5499 If you want to plan your work in a very detailed way, or if you need to
5500 produce offers with quotations of the estimated work effort, you may want to
5501 assign effort estimates to entries. If you are also clocking your work, you
5502 may later want to compare the planned effort with the actual working time, a
5503 great way to improve planning estimates. Effort estimates are stored in a
5504 special property @samp{Effort}@footnote{You may change the property being
5505 used with the variable @code{org-effort-property}.}. Clearly the best way to
5506 work with effort estimates is through column view (@pxref{Column view}). You
5507 should start by setting up discrete values for effort estimates, and a
5508 @code{COLUMNS} format that displays these values together with clock sums (if
5509 you want to clock your time). For a specific buffer you can use
5512 #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00
5513 #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
5517 @vindex org-global-properties
5518 @vindex org-columns-default-format
5519 or, even better, you can set up these values globally by customizing the
5520 variables @code{org-global-properties} and @code{org-columns-default-format}.
5521 In particular if you want to use this setup also in the agenda, a global
5522 setup may be advised.
5524 The way to assign estimates to individual items is then to switch to column
5525 mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
5526 value. The values you enter will immediately be summed up in the hierarchy.
5527 In the column next to it, any clocked time will be displayed.
5529 @vindex org-agenda-columns-add-appointments-to-effort-sum
5530 If you switch to column view in the daily/weekly agenda, the effort column
5531 will summarize the estimated work effort for each day@footnote{Please note
5532 the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
5533 column view}).}, and you can use this to find space in your schedule. To get
5534 an overview of the entire part of the day that is committed, you can set the
5535 option @code{org-agenda-columns-add-appointments-to-effort-sum}. The
5536 appointments on a day that take place over a specified time interval will
5537 then also be added to the load estimate of the day.
5539 Effort estimates can be used in secondary agenda filtering that is triggered
5540 with the @kbd{/} key in the agenda (@pxref{Agenda commands}). If you have
5541 these estimates defined consistently, two or three key presses will narrow
5542 down the list to stuff that fits into an available time slot.
5544 @node Relative timer, , Effort estimates, Dates and Times
5545 @section Taking notes with a relative timer
5546 @cindex relative timer
5548 When taking notes during, for example, a meeting or a video viewing, it can
5549 be useful to have access to times relative to a starting time. Org provides
5550 such a relative timer and make it easy to create timed notes.
5555 Insert a relative time into the buffer. The first time you use this, the
5556 timer will be started. When called with a prefix argument, the timer is
5560 Insert a description list item with the current relative time. With a prefix
5561 argument, first reset the timer to 0.
5564 Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
5568 Pause the timer, or continue it if it is already paused.
5569 @c removed the sentence because it is redundant to the following item
5570 @kindex C-u C-c C-x ,
5572 Stop the timer. After this, you can only start a new timer, not continue the
5573 old one. This command also removes the timer from the mode line.
5576 Reset the timer without inserting anything into the buffer. By default, the
5577 timer is reset to 0. When called with a @kbd{C-u} prefix, reset the timer to
5578 specific starting offset. The user is prompted for the offset, with a
5579 default taken from a timer string at point, if any, So this can be used to
5580 restart taking notes after a break in the process. When called with a double
5581 prefix argument @kbd{C-c C-u}, change all timer strings in the active region
5582 by a certain amount. This can be used to fix timer strings if the timer was
5583 not started at exactly the right moment.
5586 @node Capture, Agenda Views, Dates and Times, Top
5590 An important part of any organization system is the ability to quickly
5591 capture new ideas and tasks, and to associate reference material with them.
5592 Org uses the @file{remember.el} package to create tasks, and stores files
5593 related to a task (@i{attachments}) in a special directory.
5596 * Remember:: Capture new tasks/ideas with little interruption
5597 * Attachments:: Add files to tasks.
5598 * RSS Feeds:: Getting input from RSS feeds
5599 * Protocols:: External (@eg Browser) access to Emacs and Org
5602 @node Remember, Attachments, Capture, Capture
5604 @cindex @file{remember.el}
5606 The Remember package by John Wiegley lets you store quick notes with little
5607 interruption of your work flow. It is an excellent way to add new notes and
5608 tasks to Org files. The @code{remember.el} package is part of Emacs 23, not
5609 Emacs 22. See @uref{http://www.emacswiki.org/cgi-bin/wiki/RememberMode} for
5612 Org significantly expands the possibilities of Remember: you may define
5613 templates for different note types, and associate target files and headlines
5614 with specific templates. It also allows you to select the location where a
5615 note should be stored interactively, on the fly.
5618 * Setting up Remember for Org:: Some code for .emacs to get things going
5619 * Remember templates:: Define the outline of different note types
5620 * Storing notes:: Directly get the note to where it belongs
5621 * Refiling notes:: Moving a note or task to a project
5624 @node Setting up Remember for Org, Remember templates, Remember, Remember
5625 @subsection Setting up Remember for Org
5627 The following customization will tell Remember to use Org files as
5628 target, and to create annotations compatible with Org links.
5631 (org-remember-insinuate)
5632 (setq org-directory "~/path/to/my/orgfiles/")
5633 (setq org-default-notes-file (concat org-directory "/notes.org"))
5634 (define-key global-map "\C-cr" 'org-remember)
5638 The last line binds the command @code{org-remember} to a global
5639 key@footnote{Please select your own key, @kbd{C-c r} is only a
5640 suggestion.}. @code{org-remember} basically just calls Remember,
5641 but it makes a few things easier: if there is an active region, it will
5642 automatically copy the region into the Remember buffer. It also allows
5643 to jump to the buffer and location where Remember notes are being
5644 stored: just call @code{org-remember} with a prefix argument. If you
5645 use two prefix arguments, Org jumps to the location where the last
5646 remember note was stored.
5648 The Remember buffer will actually use @code{org-mode} as its major mode, so
5649 that all editing features of Org mode are available. In addition to this, a
5650 minor mode @code{org-remember-mode} is turned on, for the single purpose that
5651 you can use its keymap @code{org-remember-mode-map} to overwrite some of
5652 Org mode's key bindings.
5654 You can also call @code{org-remember} in a special way from the agenda,
5655 using the @kbd{k r} key combination. With this access, any timestamps
5656 inserted by the selected Remember template (see below) will default to
5657 the cursor date in the agenda, rather than to the current date.
5659 @node Remember templates, Storing notes, Setting up Remember for Org, Remember
5660 @subsection Remember templates
5661 @cindex templates, for Remember
5663 In combination with Org, you can use templates to generate
5664 different types of Remember notes. For example, if you would like
5665 to use one template to create general TODO entries, another one for
5666 journal entries, and a third one for collecting random ideas, you could
5670 (setq org-remember-templates
5671 '(("Todo" ?t "* TODO %?\n %i\n %a" "~/org/TODO.org" "Tasks")
5672 ("Journal" ?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org")
5673 ("Idea" ?i "* %^@{Title@}\n %i\n %a" "~/org/JOURNAL.org" "New Ideas")))
5676 @vindex org-remember-default-headline
5677 @vindex org-directory
5678 @noindent In these entries, the first string is just a name, and the
5679 character specifies how to select the template. It is useful if the
5680 character is also the first letter of the name. The next string specifies
5681 the template. Two more (optional) strings give the file in which, and the
5682 headline under which, the new note should be stored. The file (if not present
5683 or @code{nil}) defaults to @code{org-default-notes-file}, the heading to
5684 @code{org-remember-default-headline}. If the file name is not an absolute
5685 path, it will be interpreted relative to @code{org-directory}. The heading
5686 can also be the symbols @code{top} or @code{bottom} to send notes as level 1
5687 entries to the beginning or end of the file, respectively.
5689 An optional sixth element specifies the contexts in which the user can select
5690 the template. This element can be a list of major modes or a function.
5691 @code{org-remember} will first check whether the function returns @code{t} or
5692 if we are in any of the listed major modes, and exclude templates for which
5693 this condition is not fulfilled. Templates that do not specify this element
5694 at all, or that use @code{nil} or @code{t} as a value will always be
5700 (setq org-remember-templates
5701 '(("Bug" ?b "* BUG %?\n %i\n %a" "~/org/BUGS.org" "Bugs" (emacs-lisp-mode))
5702 ("Journal" ?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org" "X" my-check)
5703 ("Idea" ?i "* %^@{Title@}\n %i\n %a" "~/org/JOURNAL.org" "New Ideas")))
5707 The first template will only be available when invoking @code{org-remember}
5708 from an buffer in @code{emacs-lisp-mode}. The second template will only be
5709 available when the function @code{my-check} returns @code{t}. The third
5710 template will be proposed in any context.
5712 When you call @kbd{M-x org-remember} (or @kbd{M-x remember}) to remember
5713 something, Org will prompt for a key to select the template (if you have
5714 more than one template) and then prepare the buffer like
5717 [[file:@var{link to where you called remember}]]
5721 During expansion of the template, special @kbd{%}-escapes allow dynamic
5722 insertion of content:
5724 %^@{@var{prompt}@} @r{prompt the user for a string and replace this sequence with it.}
5725 @r{You may specify a default value and a completion table with}
5726 @r{%^@{prompt|default|completion2|completion3...@}}
5727 @r{The arrow keys access a prompt-specific history.}
5728 %a @r{annotation, normally the link created with @code{org-store-link}}
5729 %A @r{like @code{%a}, but prompt for the description part}
5730 %i @r{initial content, the region when remember is called with C-u.}
5731 @r{The entire text will be indented like @code{%i} itself.}
5732 %t @r{timestamp, date only}
5733 %T @r{timestamp with date and time}
5734 %u, %U @r{like the above, but inactive timestamps}
5735 %^t @r{like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}}
5736 @r{You may define a prompt like @code{%^@{Birthday@}t}}
5737 %n @r{user name (taken from @code{user-full-name})}
5738 %c @r{Current kill ring head.}
5739 %x @r{Content of the X clipboard.}
5740 %^C @r{Interactive selection of which kill or clip to use.}
5741 %^L @r{Like @code{%^C}, but insert as link.}
5742 %^g @r{prompt for tags, with completion on tags in target file.}
5743 %k @r{title of currently clocked task}
5744 %K @r{link to currently clocked task}
5745 %^G @r{prompt for tags, with completion all tags in all agenda files.}
5746 %^@{@var{prop}@}p @r{Prompt the user for a value for property @var{prop}}
5747 %:keyword @r{specific information for certain link types, see below}
5748 %[@var{file}] @r{insert the contents of the file given by @var{file}}
5749 %(@var{sexp}) @r{evaluate Elisp @var{sexp} and replace with the result}
5750 %! @r{immediately store note after completing the template}
5751 @r{(skipping the @kbd{C-c C-c} that normally triggers storing)}
5752 %& @r{jump to target location immediately after storing note}
5756 For specific link types, the following keywords will be
5757 defined@footnote{If you define your own link types (@pxref{Adding
5758 hyperlink types}), any property you store with
5759 @code{org-store-link-props} can be accessed in remember templates in a
5762 @vindex org-from-is-user-regexp
5764 Link type | Available keywords
5765 -------------------+----------------------------------------------
5766 bbdb | %:name %:company
5767 bbdb | %::server %:port %:nick
5768 vm, wl, mh, rmail | %:type %:subject %:message-id
5769 | %:from %:fromname %:fromaddress
5770 | %:to %:toname %:toaddress
5771 | %: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}.}}
5772 gnus | %:group, @r{for messages also all email fields}
5774 info | %:file %:node
5779 To place the cursor after template expansion use:
5782 %? @r{After completing the template, position cursor here.}
5786 If you change your mind about which template to use, call
5787 @code{org-remember} in the remember buffer. You may then select a new
5788 template that will be filled with the previous context information.
5790 @node Storing notes, Refiling notes, Remember templates, Remember
5791 @subsection Storing notes
5793 @vindex org-remember-clock-out-on-exit
5794 When you are finished preparing a note with Remember, you have to press
5795 @kbd{C-c C-c} to file the note away. If you have started the clock in the
5796 Remember buffer, you will first be asked if you want to clock out
5797 now@footnote{To avoid this query, configure the variable
5798 @code{org-remember-clock-out-on-exit}.}. If you answer @kbd{n}, the clock
5799 will continue to run after the note was filed away.
5801 The handler will then store the note in the file and under the headline
5802 specified in the template, or it will use the default file and headline.
5803 The window configuration will be restored, sending you back to the working
5804 context before the call to Remember. To re-use the location found
5805 during the last call to Remember, exit the Remember buffer with
5806 @kbd{C-0 C-c C-c}, @ie specify a zero prefix argument to @kbd{C-c C-c}.
5807 Another special case is @kbd{C-2 C-c C-c} which files the note as a child of
5808 the currently clocked item.
5810 @vindex org-remember-store-without-prompt
5811 If you want to store the note directly to a different place, use
5812 @kbd{C-1 C-c C-c} instead to exit Remember@footnote{Configure the
5813 variable @code{org-remember-store-without-prompt} to make this behavior
5814 the default.}. The handler will then first prompt for a target file---if
5815 you press @key{RET}, the value specified for the template is used.
5816 Then the command offers the headings tree of the selected file, with the
5817 cursor position at the default headline (if you specified one in the
5818 template). You can either immediately press @key{RET} to get the note
5819 placed there. Or you can use the following keys to find a different
5822 @key{TAB} @r{Cycle visibility.}
5823 @key{down} / @key{up} @r{Next/previous visible headline.}
5824 n / p @r{Next/previous visible headline.}
5825 f / b @r{Next/previous headline same level.}
5827 @c 0-9 @r{Digit argument.}
5830 Pressing @key{RET} or @key{left} or @key{right}
5831 then leads to the following result.
5833 @vindex org-reverse-note-order
5834 @multitable @columnfractions 0.2 0.15 0.65
5835 @item @b{Cursor position} @tab @b{Key} @tab @b{Note gets inserted}
5836 @item on headline @tab @key{RET} @tab as sublevel of the heading at cursor, first or last
5837 @item @tab @tab depending on @code{org-reverse-note-order}.
5838 @item @tab @key{left}/@key{right} @tab as same level, before/after current heading
5839 @item buffer-start @tab @key{RET} @tab as level 2 heading at end of file or level 1 at beginning
5840 @item @tab @tab depending on @code{org-reverse-note-order}.
5841 @item not on headline @tab @key{RET}
5842 @tab at cursor position, level taken from context.
5845 Before inserting the text into a tree, the function ensures that the text has
5846 a headline, @ie a first line that starts with a @samp{*}. If not, a
5847 headline is constructed from the current date. If you have indented the text
5848 of the note below the headline, the indentation will be adapted if inserting
5849 the note into the tree requires demotion from level 1.
5851 @node Refiling notes, , Storing notes, Remember
5852 @subsection Refiling notes
5853 @cindex refiling notes
5855 Remember is usually used to quickly capture notes and tasks into one or
5856 a few capture lists. When reviewing the captured data, you may want to
5857 refile some of the entries into a different list, for example into a
5858 project. Cutting, finding the right location, and then pasting the note
5859 is cumbersome. To simplify this process, you can use the following
5865 @vindex org-reverse-note-order
5866 @vindex org-refile-targets
5867 @vindex org-refile-use-outline-path
5868 @vindex org-outline-path-complete-in-steps
5869 @vindex org-refile-allow-creating-parent-nodes
5870 Refile the entry or region at point. This command offers possible locations
5871 for refiling the entry and lets you select one with completion. The item (or
5872 all items in the region) is filed below the target heading as a subitem.
5873 Depending on @code{org-reverse-note-order}, it will be either the first or
5875 By default, all level 1 headlines in the current buffer are considered to be
5876 targets, but you can have more complex definitions across a number of files.
5877 See the variable @code{org-refile-targets} for details. If you would like to
5878 select a location via a file-path-like completion along the outline path, see
5879 the variables @code{org-refile-use-outline-path} and
5880 @code{org-outline-path-complete-in-steps}. If you would like to be able to
5881 create new nodes as new parents for for refiling on the fly, check the
5882 variable @code{org-refile-allow-creating-parent-nodes}.
5885 Use the refile interface to jump to a heading.
5886 @kindex C-u C-u C-c C-w
5887 @item C-u C-u C-c C-w
5888 Jump to the location where @code{org-refile} last moved a tree to.
5892 @node Attachments, RSS Feeds, Remember, Capture
5893 @section Attachments
5896 @vindex org-attach-directory
5897 It is often useful to associate reference material with an outline node/task.
5898 Small chunks of plain text can simply be stored in the subtree of a project.
5899 Hyperlinks (@pxref{Hyperlinks}) can be used to establish associations with
5900 files that live elsewhere on your computer or in the cloud, like emails or
5901 source code files belonging to a project. Another method is @i{attachments},
5902 which are files located in a directory belonging to an outline node. Org
5903 uses directories named by the unique ID of each entry. These directories are
5904 located in the @file{data} directory which lives in the same directory where
5905 your Org file lives@footnote{If you move entries or Org files from one
5906 directory to another, you may want to configure @code{org-attach-directory}
5907 to contain an absolute path.}. If you initialize this directory with
5908 @code{git init}, Org will automatically commit changes when it sees them.
5909 The attachment system has been contributed to Org by John Wiegley.
5911 In cases where it seems better to do so, you can also attach a directory of your
5912 choice to an entry. You can also make children inherit the attachment
5913 directory from a parent, so that an entire subtree uses the same attached
5916 @noindent The following commands deal with attachments.
5922 The dispatcher for commands related to the attachment system. After these
5923 keys, a list of commands is displayed and you need to press an additional key
5924 to select a command:
5929 @vindex org-attach-method
5930 Select a file and move it into the task's attachment directory. The file
5931 will be copied, moved, or linked, depending on @code{org-attach-method}.
5932 Note that hard links are not supported on all systems.
5938 Attach a file using the copy/move/link method.
5939 Note that hard links are not supported on all systems.
5943 Create a new attachment as an Emacs buffer.
5947 Synchronize the current task with its attachment directory, in case you added
5948 attachments yourself.
5952 @vindex org-file-apps
5953 Open current task's attachment. If there are more than one, prompt for a
5954 file name first. Opening will follow the rules set by @code{org-file-apps}.
5955 For more details, see the information on following hyperlinks
5956 (@pxref{Handling links}).
5960 Also open the attachment, but force opening the file in Emacs.
5964 Open the current task's attachment directory.
5968 Also open the directory, but force using @command{dired} in Emacs.
5972 Select and delete a single attachment.
5976 Delete all of a task's attachments. A safer way is to open the directory in
5977 @command{dired} and delete from there.
5981 @cindex property, ATTACH_DIR
5982 Set a specific directory as the entry's attachment directory. This works by
5983 putting the directory path into the @code{ATTACH_DIR} property.
5987 @cindex property, ATTACH_DIR_INHERIT
5988 Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
5989 same directory for attachments as the parent does.
5993 @node RSS Feeds, Protocols, Attachments, Capture
5997 Org has the capability to add and change entries based on information found in
5998 RSS feeds. You could use this to make a task out of each new podcast in a
5999 podcast feed. Or you could use a phone-based note-creating service on the
6000 web to import tasks into Org. To access feeds, you need to configure the
6001 variable @code{org-feed-alist}. The docstring of this variable has detailed
6002 information. Here is just an example:
6005 (setq org-feed-alist
6006 '(("ReQall" "http://www.reqall.com/user/feeds/rss/a1b2c3....."
6007 "~/org/feeds.org" "ReQall Entries")
6010 will configure that new items from the feed provided by @file{reqall.com}
6011 will result in new entries in the file @file{~/org/feeds.org} under the
6012 heading @samp{ReQall Entries}, whenever the following command is used:
6017 Collect items from the feeds configured in @code{org-feed-alist} and act upon
6021 Prompt for a feed name and go to the inbox configured for this feed.
6024 Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which
6025 it will store information about the status of items in the feed, to avoid
6026 adding the same item several times. You should add @samp{FEEDSTATUS} to the
6027 list of drawers in that file:
6030 #+DRAWERS: LOGBOOK PROPERTIES FEEDSTATUS
6033 For more information, see @file{org-feed.el} and the docstring of
6034 @code{org-feed-alist}.
6036 @node Protocols, , RSS Feeds, Capture
6037 @section Protocols for external access
6038 @cindex protocols, for external access
6041 You can set up Org for handling protocol calls from outside applications that
6042 are passed to Emacs through the @file{emacsserver}. For example, you can
6043 configure bookmarks in your web browser to send a link to the current page to
6044 Org and create a note from it using Remember (@pxref{Remember}). Or you
6045 could create a bookmark that will tell Emacs to open the local source file of
6046 a remote website you are looking at with the browser. See
6047 @uref{http://orgmode.org/worg/org-contrib/org-protocol.php} for detailed
6048 documentation and setup instructions.
6051 @node Agenda Views, Embedded LaTeX, Capture, Top
6052 @chapter Agenda Views
6053 @cindex agenda views
6055 Due to the way Org works, TODO items, time-stamped items, and
6056 tagged headlines can be scattered throughout a file or even a number of
6057 files. To get an overview of open action items, or of events that are
6058 important for a particular date, this information must be collected,
6059 sorted and displayed in an organized way.
6061 Org can select items based on various criteria and display them
6062 in a separate buffer. Seven different view types are provided:
6066 an @emph{agenda} that is like a calendar and shows information
6069 a @emph{TODO list} that covers all unfinished
6072 a @emph{match view}, showings headlines based on the tags, properties, and
6073 TODO state associated with them,
6075 a @emph{timeline view} that shows all events in a single Org file,
6076 in time-sorted view,
6078 a @emph{keyword search view} that shows all entries from multiple files
6079 that contain specified keywords,
6081 a @emph{stuck projects view} showing projects that currently don't move
6084 @emph{custom views} that are special tag/keyword searches and
6085 combinations of different views.
6089 The extracted information is displayed in a special @emph{agenda
6090 buffer}. This buffer is read-only, but provides commands to visit the
6091 corresponding locations in the original Org files, and even to
6092 edit these files remotely.
6094 @vindex org-agenda-window-setup
6095 @vindex org-agenda-restore-windows-after-quit
6096 Two variables control how the agenda buffer is displayed and whether the
6097 window configuration is restored when the agenda exits:
6098 @code{org-agenda-window-setup} and
6099 @code{org-agenda-restore-windows-after-quit}.
6102 * Agenda files:: Files being searched for agenda information
6103 * Agenda dispatcher:: Keyboard access to agenda views
6104 * Built-in agenda views:: What is available out of the box?
6105 * Presentation and sorting:: How agenda items are prepared for display
6106 * Agenda commands:: Remote editing of Org trees
6107 * Custom agenda views:: Defining special searches and views
6108 * Exporting Agenda Views::
6109 * Agenda column view:: Using column view for collected entries
6112 @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views
6113 @section Agenda files
6114 @cindex agenda files
6115 @cindex files for agenda
6117 @vindex org-agenda-files
6118 The information to be shown is normally collected from all @emph{agenda
6119 files}, the files listed in the variable
6120 @code{org-agenda-files}@footnote{If the value of that variable is not a
6121 list, but a single file name, then the list of agenda files will be
6122 maintained in that external file.}. If a directory is part of this list,
6123 all files with the extension @file{.org} in this directory will be part
6126 Thus, even if you only work with a single Org file, that file should
6127 be put into the list@footnote{When using the dispatcher, pressing
6128 @kbd{<} before selecting a command will actually limit the command to
6129 the current file, and ignore @code{org-agenda-files} until the next
6130 dispatcher command.}. You can customize @code{org-agenda-files}, but
6131 the easiest way to maintain it is through the following commands
6133 @cindex files, adding to agenda list
6137 Add current file to the list of agenda files. The file is added to
6138 the front of the list. If it was already in the list, it is moved to
6139 the front. With a prefix argument, file is added/moved to the end.
6142 Remove current file from the list of agenda files.
6147 Cycle through agenda file list, visiting one file after the other.
6148 @kindex M-x org-iswitchb
6149 @item M-x org-iswitchb
6150 Command to use an @code{iswitchb}-like interface to switch to and between Org
6155 The Org menu contains the current list of files and can be used
6156 to visit any of them.
6158 If you would like to focus the agenda temporarily on a file not in
6159 this list, or on just one file in the list, or even on only a subtree in a
6160 file, then this can be done in different ways. For a single agenda command,
6161 you may press @kbd{<} once or several times in the dispatcher
6162 (@pxref{Agenda dispatcher}). To restrict the agenda scope for an
6163 extended period, use the following commands:
6168 Permanently restrict the agenda to the current subtree. When with a
6169 prefix argument, or with the cursor before the first headline in a file,
6170 the agenda scope is set to the entire file. This restriction remains in
6171 effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
6172 or @kbd{>} in the agenda dispatcher. If there is a window displaying an
6173 agenda view, the new restriction takes effect immediately.
6176 Remove the permanent restriction created by @kbd{C-c C-x <}.
6180 When working with @file{speedbar.el}, you can use the following commands in
6184 @item < @r{in the speedbar frame}
6185 Permanently restrict the agenda to the item---either an Org file or a subtree
6186 in such a file---at the cursor in the Speedbar frame.
6187 If there is a window displaying an agenda view, the new restriction takes
6190 @item > @r{in the speedbar frame}
6191 Lift the restriction.
6194 @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views
6195 @section The agenda dispatcher
6196 @cindex agenda dispatcher
6197 @cindex dispatching agenda commands
6198 The views are created through a dispatcher, which should be bound to a
6199 global key---for example @kbd{C-c a} (@pxref{Installation}). In the
6200 following we will assume that @kbd{C-c a} is indeed how the dispatcher
6201 is accessed and list keyboard access to commands accordingly. After
6202 pressing @kbd{C-c a}, an additional letter is required to execute a
6203 command. The dispatcher offers the following default commands:
6206 Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
6208 Create a list of all TODO items (@pxref{Global TODO list}).
6210 Create a list of headlines matching a TAGS expression (@pxref{Matching
6211 tags and properties}).
6213 Create the timeline view for the current buffer (@pxref{Timeline}).
6215 Create a list of entries selected by a boolean expression of keywords
6216 and/or regular expressions that must or must not occur in the entry.
6218 @vindex org-agenda-text-search-extra-files
6219 Search for a regular expression in all agenda files and additionally in
6220 the files listed in @code{org-agenda-text-search-extra-files}. This
6221 uses the Emacs command @code{multi-occur}. A prefix argument can be
6222 used to specify the number of context lines for each match, default is
6225 Create a list of stuck projects (@pxref{Stuck projects}).
6227 Restrict an agenda command to the current buffer@footnote{For backward
6228 compatibility, you can also press @kbd{1} to restrict to the current
6229 buffer.}. After pressing @kbd{<}, you still need to press the character
6230 selecting the command.
6232 If there is an active region, restrict the following agenda command to
6233 the region. Otherwise, restrict it to the current subtree@footnote{For
6234 backward compatibility, you can also press @kbd{0} to restrict to the
6235 current region/subtree.}. After pressing @kbd{< <}, you still need to press the
6236 character selecting the command.
6239 You can also define custom commands that will be accessible through the
6240 dispatcher, just like the default commands. This includes the
6241 possibility to create extended agenda buffers that contain several
6242 blocks together, for example the weekly agenda, the global TODO list and
6243 a number of special tags matches. @xref{Custom agenda views}.
6245 @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda Views
6246 @section The built-in agenda views
6248 In this section we describe the built-in views.
6251 * Weekly/daily agenda:: The calendar page with current tasks
6252 * Global TODO list:: All unfinished action items
6253 * Matching tags and properties:: Structured information with fine-tuned search
6254 * Timeline:: Time-sorted view for single file
6255 * Keyword search:: Finding entries by keyword
6256 * Stuck projects:: Find projects you need to review
6259 @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views
6260 @subsection The weekly/daily agenda
6262 @cindex weekly agenda
6263 @cindex daily agenda
6265 The purpose of the weekly/daily @emph{agenda} is to act like a page of a
6266 paper agenda, showing all the tasks for the current week or day.
6269 @cindex org-agenda, command
6272 @vindex org-agenda-ndays
6273 Compile an agenda for the current week from a list of Org files. The agenda
6274 shows the entries for each day. With a numeric prefix@footnote{For backward
6275 compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
6276 listed before the agenda. This feature is deprecated, use the dedicated TODO
6277 list, or a block agenda instead (@pxref{Block agenda}).} (like @kbd{C-u 2 1
6278 C-c a a}) you may set the number of days to be displayed (see also the
6279 variable @code{org-agenda-ndays})
6282 Remote editing from the agenda buffer means, for example, that you can
6283 change the dates of deadlines and appointments from the agenda buffer.
6284 The commands available in the Agenda buffer are listed in @ref{Agenda
6287 @subsubheading Calendar/Diary integration
6288 @cindex calendar integration
6289 @cindex diary integration
6291 Emacs contains the calendar and diary by Edward M. Reingold. The
6292 calendar displays a three-month calendar with holidays from different
6293 countries and cultures. The diary allows you to keep track of
6294 anniversaries, lunar phases, sunrise/set, recurrent appointments
6295 (weekly, monthly) and more. In this way, it is quite complementary to
6296 Org. It can be very useful to combine output from Org with
6299 In order to include entries from the Emacs diary into Org mode's
6300 agenda, you only need to customize the variable
6303 (setq org-agenda-include-diary t)
6306 @noindent After that, everything will happen automatically. All diary
6307 entries including holidays, anniversaries, etc., will be included in the
6308 agenda buffer created by Org mode. @key{SPC}, @key{TAB}, and
6309 @key{RET} can be used from the agenda buffer to jump to the diary
6310 file in order to edit existing diary entries. The @kbd{i} command to
6311 insert new entries for the current date works in the agenda buffer, as
6312 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
6313 Sunrise/Sunset times, show lunar phases and to convert to other
6314 calendars, respectively. @kbd{c} can be used to switch back and forth
6315 between calendar and agenda.
6317 If you are using the diary only for sexp entries and holidays, it is
6318 faster to not use the above setting, but instead to copy or even move
6319 the entries into an Org file. Org mode evaluates diary-style sexp
6320 entries, and does it faster because there is no overhead for first
6321 creating the diary display. Note that the sexp entries must start at
6322 the left margin, no whitespace is allowed before them. For example,
6323 the following segment of an Org file will be processed and entries
6324 will be made in the agenda:
6327 * Birthdays and similar stuff
6329 %%(org-calendar-holiday) ; special function for holiday names
6331 %%(diary-anniversary 14 5 1956) Arthur Dent is %d years old
6332 %%(diary-anniversary 2 10 1869) Mahatma Gandhi would be %d years old
6335 @subsubheading Anniversaries from BBDB
6336 @cindex BBDB, anniversaries
6337 @cindex anniversaries, from BBDB
6339 If you are using the Big Brothers Database to store your contacts, you will
6340 very likely prefer to store anniversaries in BBDB rather than in a
6341 separate Org or diary file. Org supports this and will show BBDB
6342 anniversaries as part of the agenda. All you need to do is to add the
6343 following to one your your agenda files:
6350 %%(org-bbdb-anniversaries)
6353 You can then go ahead and define anniversaries for a BBDB record. Basically,
6354 you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB
6355 record and then add the date in the format @code{YYYY-MM-DD}, followed by a
6356 space and the class of the anniversary (@samp{birthday} or @samp{wedding}, or
6357 a format string). If you omit the class, it will default to @samp{birthday}.
6358 Here are a few examples, the header for the file @file{org-bbdb.el} contains
6359 more detailed information.
6364 2008-04-14 %s released version 6.01 of org-mode, %d years ago
6367 After a change to BBDB, or for the first agenda display during an Emacs
6368 session, the agenda display will suffer a short delay as Org updates its
6369 hash with anniversaries. However, from then on things will be very fast---much
6370 faster in fact than a long list of @samp{%%(diary-anniversary)} entries
6371 in an Org or Diary file.
6373 @subsubheading Appointment reminders
6374 @cindex @file{appt.el}
6375 @cindex appointment reminders
6377 Org can interact with Emacs appointments notification facility. To add all
6378 the appointments of your agenda files, use the command
6379 @code{org-agenda-to-appt}. This command also lets you filter through the
6380 list of your appointments and add only those belonging to a specific category
6381 or matching a regular expression. See the docstring for details.
6383 @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views
6384 @subsection The global TODO list
6385 @cindex global TODO list
6386 @cindex TODO list, global
6388 The global TODO list contains all unfinished TODO items formatted and
6389 collected into a single place.
6394 Show the global TODO list. This collects the TODO items from all
6395 agenda files (@pxref{Agenda Views}) into a single buffer. The buffer is in
6396 @code{agenda-mode}, so there are commands to examine and manipulate
6397 the TODO entries directly from that buffer (@pxref{Agenda commands}).
6400 @cindex TODO keyword matching
6401 @vindex org-todo-keywords
6402 Like the above, but allows selection of a specific TODO keyword. You
6403 can also do this by specifying a prefix argument to @kbd{C-c a t}. With
6404 a @kbd{C-u} prefix you are prompted for a keyword, and you may also
6405 specify several keywords by separating them with @samp{|} as the boolean OR
6406 operator. With a numeric prefix, the nth keyword in
6407 @code{org-todo-keywords} is selected.
6409 The @kbd{r} key in the agenda buffer regenerates it, and you can give
6410 a prefix argument to this command to change the selected TODO keyword,
6411 for example @kbd{3 r}. If you often need a search for a specific
6412 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
6413 Matching specific TODO keywords can also be done as part of a tags
6414 search (@pxref{Tag searches}).
6417 Remote editing of TODO items means that you can change the state of a
6418 TODO entry with a single key press. The commands available in the
6419 TODO list are described in @ref{Agenda commands}.
6421 @cindex sublevels, inclusion into TODO list
6422 Normally the global TODO list simply shows all headlines with TODO
6423 keywords. This list can become very long. There are two ways to keep
6427 @vindex org-agenda-todo-ignore-scheduled
6428 @vindex org-agenda-todo-ignore-deadlines
6429 @vindex org-agenda-todo-ignore-with-date
6430 Some people view a TODO item that has been @emph{scheduled} for execution or
6431 have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}.
6432 Configure the variables @code{org-agenda-todo-ignore-scheduled},
6433 @code{org-agenda-todo-ignore-deadlines}, and/or
6434 @code{org-agenda-todo-ignore-with-date} to exclude such items from the
6437 @vindex org-agenda-todo-list-sublevels
6438 TODO items may have sublevels to break up the task into subtasks. In
6439 such cases it may be enough to list only the highest level TODO headline
6440 and omit the sublevels from the global list. Configure the variable
6441 @code{org-agenda-todo-list-sublevels} to get this behavior.
6444 @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views
6445 @subsection Matching tags and properties
6446 @cindex matching, of tags
6447 @cindex matching, of properties
6451 If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}),
6452 or have properties (@pxref{Properties and Columns}), you can select headlines
6453 based on this metadata and collect them into an agenda buffer. The match
6454 syntax described here also applies when creating sparse trees with @kbd{C-c /
6460 Produce a list of all headlines that match a given set of tags. The
6461 command prompts for a selection criterion, which is a boolean logic
6462 expression with tags, like @samp{+work+urgent-withboss} or
6463 @samp{work|home} (@pxref{Tags}). If you often need a specific search,
6464 define a custom command for it (@pxref{Agenda dispatcher}).
6467 @vindex org-tags-match-list-sublevels
6468 @vindex org-agenda-tags-todo-honor-ignore-options
6469 Like @kbd{C-c a m}, but only select headlines that are also TODO items and
6470 force checking subitems (see variable @code{org-tags-match-list-sublevels}).
6471 To exclude scheduled/deadline items, see the variable
6472 @code{org-agenda-tags-todo-honor-ignore-options}. Matching specific TODO
6473 keywords together with a tags match is also possible, see @ref{Tag searches}.
6476 The commands available in the tags list are described in @ref{Agenda
6479 @subsubheading Match syntax
6481 @cindex Boolean logic, for tag/property searches
6482 A search string can use Boolean operators @samp{&} for AND and @samp{|} for
6483 OR. @samp{&} binds more strongly than @samp{|}. Parentheses are currently
6484 not implemented. Each element in the search is either a tag, a regular
6485 expression matching tags, or an expression like @code{PROPERTY OPERATOR
6486 VALUE} with a comparison operator, accessing a property value. Each element
6487 may be preceded by @samp{-}, to select against it, and @samp{+} is syntactic
6488 sugar for positive selection. The AND operator @samp{&} is optional when
6489 @samp{+} or @samp{-} is present. Here are some examples, using only tags.
6493 Select headlines tagged @samp{:work:}, but discard those also tagged
6496 Selects lines tagged @samp{:work:} or @samp{:laptop:}.
6497 @item work|laptop+night
6498 Like before, but require the @samp{:laptop:} lines to be tagged also
6502 @cindex regular expressions, with tags search
6503 Instead of a tag, you may also specify a regular expression enclosed in curly
6504 braces. For example,
6505 @samp{work+@{^boss.*@}} matches headlines that contain the tag
6506 @samp{:work:} and any tag @i{starting} with @samp{boss}.
6508 @cindex TODO keyword matching, with tags search
6509 @cindex level, require for tags/property match
6510 @cindex category, require for tags/property match
6511 @vindex org-odd-levels-only
6512 You may also test for properties (@pxref{Properties and Columns}) at the same
6513 time as matching tags. The properties may be real properties, or special
6514 properties that represent other metadata (@pxref{Special properties}). For
6515 example, the ``property'' @code{TODO} represents the TODO keyword of the
6516 entry. Or, the ``property'' @code{LEVEL} represents the level of an entry.
6517 So a search @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines
6518 that have the tag @samp{boss} and are @emph{not} marked with the TODO keyword
6519 DONE. In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not
6520 count the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc.
6522 Here are more examples:
6524 @item work+TODO="WAITING"
6525 Select @samp{:work:}-tagged TODO lines with the specific TODO
6526 keyword @samp{WAITING}.
6527 @item work+TODO="WAITING"|home+TODO="WAITING"
6528 Waiting tasks both at work and at home.
6531 When matching properties, a number of different operators can be used to test
6532 the value of a property. Here is a complex example:
6535 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 \
6536 +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
6540 The type of comparison will depend on how the comparison value is written:
6543 If the comparison value is a plain number, a numerical comparison is done,
6544 and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
6545 @samp{>=}, and @samp{<>}.
6547 If the comparison value is enclosed in double-quotes,
6548 a string comparison is done, and the same operators are allowed.
6550 If the comparison value is enclosed in double-quotes @emph{and} angular
6551 brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
6552 assumed to be date/time specifications in the standard Org way, and the
6553 comparison will be done accordingly. Special values that will be recognized
6554 are @code{"<now>"} for now (including time), and @code{"<today>"}, and
6555 @code{"<tomorrow>"} for these days at 0:00 hours, @ie without a time
6556 specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
6557 @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
6558 respectively, can be used.
6560 If the comparison value is enclosed
6561 in curly braces, a regexp match is performed, with @samp{=} meaning that the
6562 regexp matches the property value, and @samp{<>} meaning that it does not
6566 So the search string in the example finds entries tagged @samp{:work:} but
6567 not @samp{:boss:}, which also have a priority value @samp{A}, a
6568 @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
6569 property that is numerically smaller than 2, a @samp{:With:} property that is
6570 matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
6571 on or after October 11, 2008.
6573 Accessing TODO, LEVEL, and CATEGORY during a search is fast. Accessing any
6574 other properties will slow down the search. However, once you have paid the
6575 price by accessing one property, testing additional properties is cheap
6578 You can configure Org mode to use property inheritance during a search, but
6579 beware that this can slow down searches considerably. See @ref{Property
6580 inheritance}, for details.
6582 For backward compatibility, and also for typing speed, there is also a
6583 different way to test TODO states in a search. For this, terminate the
6584 tags/property part of the search string (which may include several terms
6585 connected with @samp{|}) with a @samp{/} and then specify a Boolean
6586 expression just for TODO keywords. The syntax is then similar to that for
6587 tags, but should be applied with care: for example, a positive
6588 selection on several TODO keywords cannot meaningfully be combined with
6589 boolean AND. However, @emph{negative selection} combined with AND can be
6590 meaningful. To make sure that only lines are checked that actually have any
6591 TODO keyword (resulting in a speed-up), use @kbd{C-c a M}, or equivalently
6592 start the TODO part after the slash with @samp{!}. Examples:
6596 Same as @samp{work+TODO="WAITING"}
6597 @item work/!-WAITING-NEXT
6598 Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
6600 @item work/!+WAITING|+NEXT
6601 Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
6605 @node Timeline, Keyword search, Matching tags and properties, Built-in agenda views
6606 @subsection Timeline for a single file
6607 @cindex timeline, single file
6608 @cindex time-sorted view
6610 The timeline summarizes all time-stamped items from a single Org mode
6611 file in a @emph{time-sorted view}. The main purpose of this command is
6612 to give an overview over events in a project.
6617 Show a time-sorted view of the Org file, with all time-stamped items.
6618 When called with a @kbd{C-u} prefix, all unfinished TODO entries
6619 (scheduled or not) are also listed under the current date.
6623 The commands available in the timeline buffer are listed in
6624 @ref{Agenda commands}.
6626 @node Keyword search, Stuck projects, Timeline, Built-in agenda views
6627 @subsection Keyword search
6628 @cindex keyword search
6629 @cindex searching, for keywords
6631 This agenda view is a general text search facility for Org mode entries.
6632 It is particularly useful to find notes.
6637 This is a special search that lets you select entries by keywords or
6638 regular expression, using a boolean logic. For example, the search
6642 +computer +wifi -ethernet -@{8\.11[bg]@}
6646 will search for note entries that contain the keywords @code{computer}
6647 and @code{wifi}, but not the keyword @code{ethernet}, and which are also
6648 not matched by the regular expression @code{8\.11[bg]}, meaning to
6649 exclude both 8.11b and 8.11g.
6651 @vindex org-agenda-text-search-extra-files
6652 Note that in addition to the agenda files, this command will also search
6653 the files listed in @code{org-agenda-text-search-extra-files}.
6656 @node Stuck projects, , Keyword search, Built-in agenda views
6657 @subsection Stuck projects
6659 If you are following a system like David Allen's GTD to organize your
6660 work, one of the ``duties'' you have is a regular review to make sure
6661 that all projects move along. A @emph{stuck} project is a project that
6662 has no defined next actions, so it will never show up in the TODO lists
6663 Org mode produces. During the review, you need to identify such
6664 projects and define next actions for them.
6669 List projects that are stuck.
6672 @vindex org-stuck-projects
6673 Customize the variable @code{org-stuck-projects} to define what a stuck
6674 project is and how to find it.
6677 You almost certainly will have to configure this view before it will
6678 work for you. The built-in default assumes that all your projects are
6679 level-2 headlines, and that a project is not stuck if it has at least
6680 one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
6682 Let's assume that you, in your own way of using Org mode, identify
6683 projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
6684 indicate a project that should not be considered yet. Let's further
6685 assume that the TODO keyword DONE marks finished projects, and that NEXT
6686 and TODO indicate next actions. The tag @@SHOP indicates shopping and
6687 is a next action even without the NEXT tag. Finally, if the project
6688 contains the special word IGNORE anywhere, it should not be listed
6689 either. In this case you would start by identifying eligible projects
6690 with a tags/todo match@footnote{@xref{Tag searches}.}
6691 @samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT, @@SHOP, and
6692 IGNORE in the subtree to identify projects that are not stuck. The
6693 correct customization for this is
6696 (setq org-stuck-projects
6697 '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
6701 Note that if a project is identified as non-stuck, the subtree of this entry
6702 will still be searched for stuck projects.
6704 @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views
6705 @section Presentation and sorting
6706 @cindex presentation, of agenda items
6708 @vindex org-agenda-prefix-format
6709 Before displaying items in an agenda view, Org mode visually prepares
6710 the items and sorts them. Each item occupies a single line. The line
6711 starts with a @emph{prefix} that contains the @emph{category}
6712 (@pxref{Categories}) of the item and other important information. You can
6713 customize the prefix using the option @code{org-agenda-prefix-format}.
6714 The prefix is followed by a cleaned-up version of the outline headline
6715 associated with the item.
6718 * Categories:: Not all tasks are equal
6719 * Time-of-day specifications:: How the agenda knows the time
6720 * Sorting of agenda items:: The order of things
6723 @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting
6724 @subsection Categories
6727 The category is a broad label assigned to each agenda item. By default,
6728 the category is simply derived from the file name, but you can also
6729 specify it with a special line in the buffer, like this@footnote{For
6730 backward compatibility, the following also works: if there are several
6731 such lines in a file, each specifies the category for the text below it.
6732 The first category also applies to any text before the first CATEGORY
6733 line. However, using this method is @emph{strongly} deprecated as it is
6734 incompatible with the outline structure of the document. The correct
6735 method for setting multiple categories in a buffer is using a
6743 @cindex property, CATEGORY
6744 If you would like to have a special CATEGORY for a single entry or a
6745 (sub)tree, give the entry a @code{:CATEGORY:} property with the
6746 special category you want to apply as the value.
6749 The display in the agenda buffer looks best if the category is not
6750 longer than 10 characters.
6752 @node Time-of-day specifications, Sorting of agenda items, Categories, Presentation and sorting
6753 @subsection Time-of-day specifications
6754 @cindex time-of-day specification
6756 Org mode checks each agenda item for a time-of-day specification. The
6757 time can be part of the timestamp that triggered inclusion into the
6758 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time
6759 ranges can be specified with two timestamps, like
6761 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
6763 In the headline of the entry itself, a time(range) may also appear as
6764 plain text (like @samp{12:45} or a @samp{8:30-1pm}). If the agenda
6765 integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
6766 specifications in diary entries are recognized as well.
6768 For agenda display, Org mode extracts the time and displays it in a
6769 standard 24 hour format as part of the prefix. The example times in
6770 the previous paragraphs would end up in the agenda like this:
6773 8:30-13:00 Arthur Dent lies in front of the bulldozer
6774 12:45...... Ford Prefect arrives and takes Arthur to the pub
6775 19:00...... The Vogon reads his poem
6776 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
6780 If the agenda is in single-day mode, or for the display of today, the
6781 timed entries are embedded in a time grid, like
6784 8:00...... ------------------
6785 8:30-13:00 Arthur Dent lies in front of the bulldozer
6786 10:00...... ------------------
6787 12:00...... ------------------
6788 12:45...... Ford Prefect arrives and takes Arthur to the pub
6789 14:00...... ------------------
6790 16:00...... ------------------
6791 18:00...... ------------------
6792 19:00...... The Vogon reads his poem
6793 20:00...... ------------------
6794 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
6797 @vindex org-agenda-use-time-grid
6798 @vindex org-agenda-time-grid
6799 The time grid can be turned on and off with the variable
6800 @code{org-agenda-use-time-grid}, and can be configured with
6801 @code{org-agenda-time-grid}.
6803 @node Sorting of agenda items, , Time-of-day specifications, Presentation and sorting
6804 @subsection Sorting of agenda items
6805 @cindex sorting, of agenda items
6806 @cindex priorities, of agenda items
6807 Before being inserted into a view, the items are sorted. How this is
6808 done depends on the type of view.
6811 @vindex org-agenda-files
6812 For the daily/weekly agenda, the items for each day are sorted. The
6813 default order is to first collect all items containing an explicit
6814 time-of-day specification. These entries will be shown at the beginning
6815 of the list, as a @emph{schedule} for the day. After that, items remain
6816 grouped in categories, in the sequence given by @code{org-agenda-files}.
6817 Within each category, items are sorted by priority (@pxref{Priorities}),
6818 which is composed of the base priority (2000 for priority @samp{A}, 1000
6819 for @samp{B}, and 0 for @samp{C}), plus additional increments for
6820 overdue scheduled or deadline items.
6822 For the TODO list, items remain in the order of categories, but within
6823 each category, sorting takes place according to priority
6824 (@pxref{Priorities}). The priority used for sorting derives from the
6825 priority cookie, with additions depending on how close an item is to its due
6828 For tags matches, items are not sorted at all, but just appear in the
6829 sequence in which they are found in the agenda files.
6832 @vindex org-agenda-sorting-strategy
6833 Sorting can be customized using the variable
6834 @code{org-agenda-sorting-strategy}, and may also include criteria based on
6835 the estimated effort of an entry (@pxref{Effort estimates}).
6837 @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda Views
6838 @section Commands in the agenda buffer
6839 @cindex commands, in agenda buffer
6841 Entries in the agenda buffer are linked back to the Org file or diary
6842 file where they originate. You are not allowed to edit the agenda
6843 buffer itself, but commands are provided to show and jump to the
6844 original entry location, and to edit the Org files ``remotely'' from
6845 the agenda buffer. In this way, all information is stored only once,
6846 removing the risk that your agenda and note files may diverge.
6848 Some commands can be executed with mouse clicks on agenda lines. For
6849 the other commands, the cursor needs to be in the desired line.
6852 @tsubheading{Motion}
6853 @cindex motion commands in agenda
6856 Next line (same as @key{up} and @kbd{C-p}).
6859 Previous line (same as @key{down} and @kbd{C-n}).
6860 @tsubheading{View/Go to Org file}
6865 Display the original location of the item in another window.
6866 With prefix arg, make sure that the entire entry is made visible in the
6867 outline, not only the heading.
6871 Display original location and recenter that window.
6879 Go to the original location of the item in another window. Under Emacs
6880 22, @kbd{mouse-1} will also works for this.
6884 Go to the original location of the item and delete other windows.
6888 @vindex org-agenda-start-with-follow-mode
6889 Toggle Follow mode. In Follow mode, as you move the cursor through
6890 the agenda buffer, the other window always shows the corresponding
6891 location in the Org file. The initial setting for this mode in new
6892 agenda buffers can be set with the variable
6893 @code{org-agenda-start-with-follow-mode}.
6897 Display the entire subtree of the current item in an indirect buffer. With a
6898 numeric prefix argument N, go up to level N and then take that tree. If N is
6899 negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the
6900 previously used indirect buffer.
6904 @item v l @ @r{or short} @ l
6905 @vindex org-log-done
6906 @vindex org-agenda-log-mode-items
6907 Toggle Logbook mode. In Logbook mode, entries that were marked DONE while
6908 logging was on (variable @code{org-log-done}) are shown in the agenda, as are
6909 entries that have been clocked on that day. You can configure the entry
6910 types that should be included in log mode using the variable
6911 @code{org-agenda-log-mode-items}. When called with a @kbd{C-u} prefix, show
6912 all possible logbook entries, including state changes. When called with two
6913 prefix args @kbd{C-u C-u}, show only logging information, nothing else.
6919 Toggle Archives mode. In Archives mode, trees that are marked
6920 @code{ARCHIVED} are also scanned when producing the agenda. When you use the
6921 capital @kbd{A}, even all archive files are included. To exit archives mode,
6922 press @kbd{v a} again.
6926 @vindex org-agenda-start-with-clockreport-mode
6927 Toggle Clockreport mode. In Clockreport mode, the daily/weekly agenda will
6928 always show a table with the clocked times for the timespan and file scope
6929 covered by the current agenda view. The initial setting for this mode in new
6930 agenda buffers can be set with the variable
6931 @code{org-agenda-start-with-clockreport-mode}.
6933 @tsubheading{Change display}
6934 @cindex display changing, in agenda
6937 Delete other windows.
6945 @item v d @ @r{or short} @ d
6946 @itemx v w @ @r{or short} @ w
6949 Switch to day/week/month/year view. When switching to day or week view,
6950 this setting becomes the default for subsequent agenda commands. Since
6951 month and year views are slow to create, they do not become the default.
6952 A numeric prefix argument may be used to jump directly to a specific day
6953 of the year, ISO week, month, or year, respectively. For example,
6954 @kbd{32 d} jumps to February 1st, @kbd{9 w} to ISO week number 9. When
6955 setting day, week, or month view, a year may be encoded in the prefix
6956 argument as well. For example, @kbd{200712 w} will jump to week 12 in
6957 2007. If such a year specification has only one or two digits, it will
6958 be mapped to the interval 1938-2037.
6962 Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}.
6966 @vindex org-agenda-use-time-grid
6967 @vindex org-agenda-time-grid
6968 Toggle the time grid on and off. See also the variables
6969 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
6973 Recreate the agenda buffer, for example to reflect the changes after
6974 modification of the timestamps of items with @kbd{S-@key{left}} and
6975 @kbd{S-@key{right}}. When the buffer is the global TODO list, a prefix
6976 argument is interpreted to create a selective list for a specific TODO
6986 Save all Org buffers in the current Emacs session, and also the locations of
6991 @vindex org-agenda-ndays
6992 Display the following @code{org-agenda-ndays} days. For example, if
6993 the display covers a week, switch to the following week. With prefix
6994 arg, go forward that many times @code{org-agenda-ndays} days.
6998 Display the previous dates.
7006 Prompt for a date and go there.
7010 @vindex org-columns-default-format
7011 Invoke column view (@pxref{Column view}) in the agenda buffer. The column
7012 view format is taken from the entry at point, or (if there is no entry at
7013 point), from the first entry in the agenda view. So whatever the format for
7014 that entry would be in the original buffer (taken from a property, from a
7015 @code{#+COLUMNS} line, or from the default variable
7016 @code{org-columns-default-format}), will be used in the agenda.
7020 Remove the restriction lock on the agenda, if it is currently restricted to a
7021 file or subtree (@pxref{Agenda files}).
7023 @tsubheading{Secondary filtering and query editing}
7024 @cindex filtering, by tag and effort, in agenda
7025 @cindex tag filtering, in agenda
7026 @cindex effort filtering, in agenda
7027 @cindex query editing, in agenda
7031 @vindex org-agenda-filter-preset
7032 Filter the current agenda view with respect to a tag and/or effort estimates.
7033 The difference between this and a custom agenda command is that filtering is
7034 very fast, so that you can switch quickly between different filters without
7035 having to recreate the agenda@footnote{Custom commands can preset a filter by
7036 binding the variable @code{org-agenda-filter-preset} as an option. This
7037 filter will then be applied to the view and persist as a basic filter through
7038 refreshes and more secondary filtering.}
7040 You will be prompted for a tag selection letter. Pressing @key{TAB} at that
7041 prompt will offer use completion to select a tag (including any tags that do
7042 not have a selection character). The command then hides all entries that do
7043 not contain or inherit this tag. When called with prefix arg, remove the
7044 entries that @emph{do} have the tag. A second @kbd{/} at the prompt will
7045 turn off the filter and unhide any hidden entries. If the first key you
7046 press is either @kbd{+} or @kbd{-}, the previous filter will be narrowed by
7047 requiring or forbidding the selected additional tag. Instead of pressing
7048 @kbd{+} or @kbd{-} after @kbd{/}, you can also immediately use the @kbd{\}
7051 @vindex org-sort-agenda-noeffort-is-high
7052 In order to filter for effort estimates, you should set-up allowed
7053 efforts globally, for example
7055 (setq org-global-properties
7056 '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
7058 You can then filter for an effort by first typing an operator, one of
7059 @kbd{<}, @kbd{>}, and @kbd{=}, and then the one-digit index of an effort
7060 estimate in your array of allowed values, where @kbd{0} means the 10th value.
7061 The filter will then restrict to entries with effort smaller-or-equal, equal,
7062 or larger-or-equal than the selected value. If the digits 0-9 are not used
7063 as fast access keys to tags, you can also simply press the index digit
7064 directly without an operator. In this case, @kbd{<} will be assumed. For
7065 application of the operator, entries without a defined effort will be treated
7066 according to the value of @code{org-sort-agenda-noeffort-is-high}. To filter
7067 for tasks without effort definition, press @kbd{?} as the operator.
7071 Narrow the current agenda filter by an additional condition. When called with
7072 prefix arg, remove the entries that @emph{do} have the tag, or that do match
7073 the effort criterion. You can achieve the same effect by pressing @kbd{+} or
7074 @kbd{-} as the first key after the @kbd{/} command.
7082 @item @r{in} search view
7083 add new search words (@kbd{[} and @kbd{]}) or new regular expressions
7084 (@kbd{@{} and @kbd{@}}) to the query string. The opening bracket/brace will
7085 add a positive search term prefixed by @samp{+}, indicating that this search
7086 term @i{must} occur/match in the entry. The closing bracket/brace will add a
7087 negative search term which @i{must not} occur/match in the entry for it to be
7089 @item @r{in} weekly/daily agenda @r{or}
7090 @itemx @r{in} timeline view
7091 Redisplay with inactive timestamps included.
7094 @tsubheading{Remote editing}
7095 @cindex remote editing, from agenda
7100 @cindex undoing remote-editing events
7101 @cindex remote editing, undo
7104 Undo a change due to a remote editing command. The change is undone
7105 both in the agenda buffer and in the remote buffer.
7109 Change the TODO state of the item, both in the agenda and in the
7114 @vindex org-agenda-confirm-kill
7115 Delete the current agenda item along with the entire subtree belonging
7116 to it in the original Org file. If the text to be deleted remotely
7117 is longer than one line, the kill needs to be confirmed by the user. See
7118 variable @code{org-agenda-confirm-kill}.
7122 Refile the entry at point.
7126 Toggle the ARCHIVE tag for the current headline.
7130 Move the subtree corresponding to the current entry to its @emph{archive
7135 Archive the subtree corresponding to the current headline. This means the
7136 entry will be moved to the configured archive location, most likely a
7141 @vindex org-agenda-show-inherited-tags
7142 Show all tags associated with the current item. This is useful if you have
7143 turned off @code{org-agenda-show-inherited-tags}, but still want to see all
7144 tags of a headline occasionally.
7148 Set tags for the current headline. If there is an active region in the
7149 agenda, change a tag for all headings in the region.
7153 Set the priority for the current item. Org mode prompts for the
7154 priority character. If you reply with @key{SPC}, the priority cookie
7155 is removed from the entry.
7159 Display weighted priority of current item.
7165 Increase the priority of the current item. The priority is changed in
7166 the original buffer, but the agenda is not resorted. Use the @kbd{r}
7170 @kindex S-@key{down}
7173 Decrease the priority of the current item.
7177 @vindex org-log-into-drawer
7178 Add a note to the entry. This note will be recorded, and then files to the
7179 same location where state change notes are put. Depending on
7180 @code{org-log-into-drawer}, this maybe inside a drawer.
7184 Dispatcher for all command related to attachments.
7192 Set a deadline for this item.
7196 Agenda actions, to set dates for selected items to the cursor date.
7197 This command also works in the calendar! The command prompts for an
7200 m @r{Mark the entry at point for action. You can also make entries}
7201 @r{in Org files with @kbd{C-c C-x C-k}.}
7202 d @r{Set the deadline of the marked entry to the date at point.}
7203 s @r{Schedule the marked entry at the date at point.}
7204 r @r{Call @code{org-remember} with the cursor date as default date.}
7207 Press @kbd{r} afterward to refresh the agenda and see the effect of the
7210 @kindex S-@key{right}
7212 Change the timestamp associated with the current line by one day into the
7213 future. With a numeric prefix argument, change it by that many days. For
7214 example, @kbd{3 6 5 S-@key{right}} will change it by a year. With a
7215 @kbd{C-u} prefix, change the time by one hour. If you immediately repeat the
7216 command, it will continue to change hours even without the prefix arg. With
7217 a double @kbd{C-u C-u} prefix, do the same for changing minutes. The stamp
7218 is changed in the original Org file, but the change is not directly reflected
7219 in the agenda buffer. Use @kbd{r} or @kbd{g} to update the buffer.
7221 @kindex S-@key{left}
7223 Change the timestamp associated with the current line by one day
7228 Change the timestamp associated with the current line to today.
7229 The key @kbd{>} has been chosen, because it is the same as @kbd{S-.}
7234 Start the clock on the current item. If a clock is running already, it
7239 Stop the previously started clock.
7243 Cancel the currently running clock.
7247 Jump to the running clock in another window.
7249 @tsubheading{Bulk remote editing selected entries}
7250 @cindex remote editing, bulk, from agenda
7254 Mark the entry at point for bulk action.
7258 Unmark entry for bulk action.
7262 Unmark all marked entries for bulk action.
7266 Bulk action: act on all marked entries in the agenda. This will prompt for
7267 another key to select the action to be applied:
7269 r @r{Prompt for a single refile target and move all entries. The entries}
7270 @r{will no longer be in the agenda, refresh (@kbd{g}) to bring them back.}
7271 $ @r{Archive all selected entries.}
7272 A @r{Archive entries by moving them to their respective archive siblings.}
7273 t @r{Change TODO state. This prompts for a single TODO keyword and}
7274 @r{changes the state of all selected entries, bypassing blocking and}
7275 @r{suppressing logging notes (but not time stamps).}
7276 + @r{Add a tag to all selected entries.}
7277 - @r{Remove a tag from all selected entries.}
7278 s @r{Schedule all items to a new date. To shift existing schedule dates}
7279 @r{by a fixed number of days, use something starting with double plus}
7280 @r{at the prompt, for example @samp{++8d} or @samp{++2w}.}
7281 d @r{Set deadline to a specific date.}
7285 @tsubheading{Calendar commands}
7286 @cindex calendar commands, from agenda
7289 Open the Emacs calendar and move to the date at the agenda cursor.
7292 When in the calendar, compute and show the Org mode agenda for the
7295 @cindex diary entries, creating from agenda
7298 Insert a new entry into the diary. Prompts for the type of entry
7299 (day, weekly, monthly, yearly, anniversary, cyclic) and creates a new
7300 entry in the diary, just as @kbd{i d}, etc., would do in the calendar.
7301 The date is taken from the cursor position.
7305 Show the phases of the moon for the three months around current date.
7309 Show sunrise and sunset times. The geographical location must be set
7310 with calendar variables, see the documentation for the Emacs calendar.
7314 Convert the date at cursor into many other cultural and historic
7319 Show holidays for three months around the cursor date.
7321 @item M-x org-export-icalendar-combine-agenda-files
7322 Export a single iCalendar file containing entries from all agenda files.
7323 This is a globally available command, and also available in the agenda menu.
7325 @tsubheading{Exporting to a file}
7328 @cindex exporting agenda views
7329 @cindex agenda views, exporting
7330 @vindex org-agenda-exporter-settings
7331 Write the agenda view to a file. Depending on the extension of the selected
7332 file name, the view will be exported as HTML (extension @file{.html} or
7333 @file{.htm}), Postscript (extension @file{.ps}), PDF (extension @file{.pdf}),
7334 or plain text (any other extension). When called with a @kbd{C-u} prefix
7335 argument, immediately open the newly created file. Use the variable
7336 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
7337 for @file{htmlize} to be used during export.
7339 @tsubheading{Quit and Exit}
7342 Quit agenda, remove the agenda buffer.
7345 @cindex agenda files, removing buffers
7347 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
7348 for the compilation of the agenda. Buffers created by the user to
7349 visit Org files will not be removed.
7353 @node Custom agenda views, Exporting Agenda Views, Agenda commands, Agenda Views
7354 @section Custom agenda views
7355 @cindex custom agenda views
7356 @cindex agenda views, custom
7358 Custom agenda commands serve two purposes: to store and quickly access
7359 frequently used TODO and tags searches, and to create special composite
7360 agenda buffers. Custom agenda commands will be accessible through the
7361 dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
7364 * Storing searches:: Type once, use often
7365 * Block agenda:: All the stuff you need in a single buffer
7366 * Setting Options:: Changing the rules
7369 @node Storing searches, Block agenda, Custom agenda views, Custom agenda views
7370 @subsection Storing searches
7372 The first application of custom searches is the definition of keyboard
7373 shortcuts for frequently used searches, either creating an agenda
7374 buffer, or a sparse tree (the latter covering of course only the current
7377 @vindex org-agenda-custom-commands
7378 Custom commands are configured in the variable
7379 @code{org-agenda-custom-commands}. You can customize this variable, for
7380 example by pressing @kbd{C-c a C}. You can also directly set it with
7381 Emacs Lisp in @file{.emacs}. The following example contains all valid
7386 (setq org-agenda-custom-commands
7387 '(("w" todo "WAITING")
7388 ("W" todo-tree "WAITING")
7389 ("u" tags "+boss-urgent")
7390 ("v" tags-todo "+boss-urgent")
7391 ("U" tags-tree "+boss-urgent")
7392 ("f" occur-tree "\\<FIXME\\>")
7393 ("h" . "HOME+Name tags searches") ; description for "h" prefix
7394 ("hl" tags "+home+Lisa")
7395 ("hp" tags "+home+Peter")
7396 ("hk" tags "+home+Kim")))
7401 The initial string in each entry defines the keys you have to press
7402 after the dispatcher command @kbd{C-c a} in order to access the command.
7403 Usually this will be just a single character, but if you have many
7404 similar commands, you can also define two-letter combinations where the
7405 first character is the same in several combinations and serves as a
7406 prefix key@footnote{You can provide a description for a prefix key by
7407 inserting a cons cell with the prefix and the description.}. The second
7408 parameter is the search type, followed by the string or regular
7409 expression to be used for the matching. The example above will
7414 as a global search for TODO entries with @samp{WAITING} as the TODO
7417 as the same search, but only in the current buffer and displaying the
7418 results as a sparse tree
7420 as a global tags search for headlines marked @samp{:boss:} but not
7423 as the same search as @kbd{C-c a u}, but limiting the search to
7424 headlines that are also TODO items
7426 as the same search as @kbd{C-c a u}, but only in the current buffer and
7427 displaying the result as a sparse tree
7429 to create a sparse tree (again: current buffer only) with all entries
7430 containing the word @samp{FIXME}
7432 as a prefix command for a HOME tags search where you have to press an
7433 additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
7434 Peter, or Kim) as additional tag to match.
7437 @node Block agenda, Setting Options, Storing searches, Custom agenda views
7438 @subsection Block agenda
7439 @cindex block agenda
7440 @cindex agenda, with block views
7442 Another possibility is the construction of agenda views that comprise
7443 the results of @emph{several} commands, each of which creates a block in
7444 the agenda buffer. The available commands include @code{agenda} for the
7445 daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
7446 for the global TODO list (as constructed with @kbd{C-c a t}), and the
7447 matching commands discussed above: @code{todo}, @code{tags}, and
7448 @code{tags-todo}. Here are two examples:
7452 (setq org-agenda-custom-commands
7453 '(("h" "Agenda and Home-related tasks"
7457 ("o" "Agenda and Office-related tasks"
7465 This will define @kbd{C-c a h} to create a multi-block view for stuff
7466 you need to attend to at home. The resulting agenda buffer will contain
7467 your agenda for the current week, all TODO items that carry the tag
7468 @samp{home}, and also all lines tagged with @samp{garden}. Finally the
7469 command @kbd{C-c a o} provides a similar view for office tasks.
7471 @node Setting Options, , Block agenda, Custom agenda views
7472 @subsection Setting options for custom commands
7473 @cindex options, for custom agenda views
7475 @vindex org-agenda-custom-commands
7476 Org mode contains a number of variables regulating agenda construction
7477 and display. The global variables define the behavior for all agenda
7478 commands, including the custom commands. However, if you want to change
7479 some settings just for a single custom view, you can do so. Setting
7480 options requires inserting a list of variable names and values at the
7481 right spot in @code{org-agenda-custom-commands}. For example:
7485 (setq org-agenda-custom-commands
7486 '(("w" todo "WAITING"
7487 ((org-agenda-sorting-strategy '(priority-down))
7488 (org-agenda-prefix-format " Mixed: ")))
7489 ("U" tags-tree "+boss-urgent"
7490 ((org-show-following-heading nil)
7491 (org-show-hierarchy-above nil)))
7493 ((org-agenda-files '("~org/notes.org"))
7494 (org-agenda-text-search-extra-files nil)))))
7499 Now the @kbd{C-c a w} command will sort the collected entries only by
7500 priority, and the prefix format is modified to just say @samp{ Mixed: }
7501 instead of giving the category of the entry. The sparse tags tree of
7502 @kbd{C-c a U} will now turn out ultra-compact, because neither the
7503 headline hierarchy above the match, nor the headline following the match
7504 will be shown. The command @kbd{C-c a N} will do a text search limited
7505 to only a single file.
7507 @vindex org-agenda-custom-commands
7508 For command sets creating a block agenda,
7509 @code{org-agenda-custom-commands} has two separate spots for setting
7510 options. You can add options that should be valid for just a single
7511 command in the set, and options that should be valid for all commands in
7512 the set. The former are just added to the command entry, the latter
7513 must come after the list of command entries. Going back to the block
7514 agenda example (@pxref{Block agenda}), let's change the sorting strategy
7515 for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
7516 the results for GARDEN tags query in the opposite order,
7517 @code{priority-up}. This would look like this:
7521 (setq org-agenda-custom-commands
7522 '(("h" "Agenda and Home-related tasks"
7526 ((org-agenda-sorting-strategy '(priority-up)))))
7527 ((org-agenda-sorting-strategy '(priority-down))))
7528 ("o" "Agenda and Office-related tasks"
7535 As you see, the values and parentheses setting is a little complex.
7536 When in doubt, use the customize interface to set this variable---it
7537 fully supports its structure. Just one caveat: when setting options in
7538 this interface, the @emph{values} are just Lisp expressions. So if the
7539 value is a string, you need to add the double-quotes around the value
7543 @node Exporting Agenda Views, Agenda column view, Custom agenda views, Agenda Views
7544 @section Exporting Agenda Views
7545 @cindex agenda views, exporting
7547 If you are away from your computer, it can be very useful to have a printed
7548 version of some agenda views to carry around. Org mode can export custom
7549 agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's
7550 @file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the
7551 ghostscript @file{ps2pdf} utility must be installed on the system. Selecting
7552 a PDF file with also create the postscript file.}, and iCalendar files. If
7553 you want to do this only occasionally, use the command
7558 @cindex exporting agenda views
7559 @cindex agenda views, exporting
7560 @vindex org-agenda-exporter-settings
7561 Write the agenda view to a file. Depending on the extension of the
7562 selected file name, the view will be exported as HTML (extension
7563 @file{.html} or @file{.htm}), Postscript (extension @file{.ps}),
7564 iCalendar (extension @file{.ics}), or plain text (any other extension).
7565 Use the variable @code{org-agenda-exporter-settings} to
7566 set options for @file{ps-print} and for @file{htmlize} to be used during
7569 @vindex org-agenda-add-entry-text-maxlines
7570 @vindex htmlize-output-type
7571 @vindex ps-number-of-columns
7572 @vindex ps-landscape-mode
7574 (setq org-agenda-exporter-settings
7575 '((ps-number-of-columns 2)
7576 (ps-landscape-mode t)
7577 (org-agenda-add-entry-text-maxlines 5)
7578 (htmlize-output-type 'css)))
7582 If you need to export certain agenda views frequently, you can associate
7583 any custom agenda command with a list of output file names
7584 @footnote{If you want to store standard views like the weekly agenda
7585 or the global TODO list as well, you need to define custom commands for
7586 them in order to be able to specify file names.}. Here is an example
7587 that first defines custom commands for the agenda and the global
7588 TODO list, together with a number of files to which to export them.
7589 Then we define two block agenda commands and specify file names for them
7590 as well. File names can be relative to the current working directory,
7595 (setq org-agenda-custom-commands
7596 '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
7597 ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
7598 ("h" "Agenda and Home-related tasks"
7603 ("~/views/home.html"))
7604 ("o" "Agenda and Office-related tasks"
7609 ("~/views/office.ps" "~/calendars/office.ics"))))
7613 The extension of the file name determines the type of export. If it is
7614 @file{.html}, Org mode will use the @file{htmlize.el} package to convert
7615 the buffer to HTML and save it to this file name. If the extension is
7616 @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
7617 Postscript output. If the extension is @file{.ics}, iCalendar export is
7618 run export over all files that were used to construct the agenda, and
7619 limit the export to entries listed in the agenda. Any other
7620 extension produces a plain ASCII file.
7622 The export files are @emph{not} created when you use one of those
7623 commands interactively because this might use too much overhead.
7624 Instead, there is a special command to produce @emph{all} specified
7630 Export all agenda views that have export file names associated with
7634 You can use the options section of the custom agenda commands to also
7635 set options for the export commands. For example:
7638 (setq org-agenda-custom-commands
7640 ((ps-number-of-columns 2)
7641 (ps-landscape-mode t)
7642 (org-agenda-prefix-format " [ ] ")
7643 (org-agenda-with-colors nil)
7644 (org-agenda-remove-tags t))
7649 This command sets two options for the Postscript exporter, to make it
7650 print in two columns in landscape format---the resulting page can be cut
7651 in two and then used in a paper agenda. The remaining settings modify
7652 the agenda prefix to omit category and scheduling information, and
7653 instead include a checkbox to check off items. We also remove the tags
7654 to make the lines compact, and we don't want to use colors for the
7655 black-and-white printer. Settings specified in
7656 @code{org-agenda-exporter-settings} will also apply, but the settings
7657 in @code{org-agenda-custom-commands} take precedence.
7660 From the command line you may also use
7662 emacs -f org-batch-store-agenda-views -kill
7665 or, if you need to modify some parameters@footnote{Quoting depends on the
7666 system you use, please check the FAQ for examples.}
7668 emacs -eval '(org-batch-store-agenda-views \
7669 org-agenda-ndays 30 \
7670 org-agenda-start-day "2007-11-01" \
7671 org-agenda-include-diary nil \
7672 org-agenda-files (quote ("~/org/project.org")))' \
7676 which will create the agenda views restricted to the file
7677 @file{~/org/project.org}, without diary entries and with a 30-day
7680 You can also extract agenda information in a way that allows further
7681 processing by other programs. See @ref{Extracting agenda information}, for
7685 @node Agenda column view, , Exporting Agenda Views, Agenda Views
7686 @section Using column view in the agenda
7687 @cindex column view, in agenda
7688 @cindex agenda, column view
7690 Column view (@pxref{Column view}) is normally used to view and edit
7691 properties embedded in the hierarchical structure of an Org file. It can be
7692 quite useful to use column view also from the agenda, where entries are
7693 collected by certain criteria.
7698 Turn on column view in the agenda.
7701 To understand how to use this properly, it is important to realize that the
7702 entries in the agenda are no longer in their proper outline environment.
7703 This causes the following issues:
7707 @vindex org-columns-default-format
7708 @vindex org-overriding-columns-format
7709 Org needs to make a decision which @code{COLUMNS} format to use. Since the
7710 entries in the agenda are collected from different files, and different files
7711 may have different @code{COLUMNS} formats, this is a non-trivial problem.
7712 Org first checks if the variable @code{org-overriding-columns-format} is
7713 currently set, and if so, takes the format from there. Otherwise it takes
7714 the format associated with the first item in the agenda, or, if that item
7715 does not have a specific format (defined in a property, or in its file), it
7716 uses @code{org-columns-default-format}.
7718 @cindex property, special, CLOCKSUM
7719 If any of the columns has a summary type defined (@pxref{Column attributes}),
7720 turning on column view in the agenda will visit all relevant agenda files and
7721 make sure that the computations of this property are up to date. This is
7722 also true for the special @code{CLOCKSUM} property. Org will then sum the
7723 values displayed in the agenda. In the daily/weekly agenda, the sums will
7724 cover a single day, in all other views they cover the entire block. It is
7725 vital to realize that the agenda may show the same entry @emph{twice} (for
7726 example as scheduled and as a deadline), and it may show two entries from the
7727 same hierarchy (for example a @emph{parent} and its @emph{child}). In these
7728 cases, the summation in the agenda will lead to incorrect results because
7729 some values will count double.
7731 When the column view in the agenda shows the @code{CLOCKSUM}, that is always
7732 the entire clocked time for this item. So even in the daily/weekly agenda,
7733 the clocksum listed in column view may originate from times outside the
7734 current view. This has the advantage that you can compare these values with
7735 a column listing the planned total effort for a task---one of the major
7736 applications for column view in the agenda. If you want information about
7737 clocked time in the displayed period use clock table mode (press @kbd{R} in
7742 @node Embedded LaTeX, Exporting, Agenda Views, Top
7743 @chapter Embedded La@TeX{}
7744 @cindex @TeX{} interpretation
7745 @cindex La@TeX{} interpretation
7747 Plain ASCII is normally sufficient for almost all note taking. One
7748 exception, however, are scientific notes which need to be able to contain
7749 mathematical symbols and the occasional formula. La@TeX{}@footnote{La@TeX{}
7750 is a macro system based on Donald E. Knuth's @TeX{} system. Many of the
7751 features described here as ``La@TeX{}'' are really from @TeX{}, but for
7752 simplicity I am blurring this distinction.} is widely used to typeset
7753 scientific documents. Org mode supports embedding La@TeX{} code into its
7754 files, because many academics are used to reading La@TeX{} source code, and
7755 because it can be readily processed into images for HTML production.
7757 It is not necessary to mark La@TeX{} macros and code in any special way.
7758 If you observe a few conventions, Org mode knows how to find it and what
7762 * Math symbols:: @TeX{} macros for symbols and Greek letters
7763 * Subscripts and superscripts:: Simple syntax for raising/lowering text
7764 * LaTeX fragments:: Complex formulas made easy
7765 * Processing LaTeX fragments:: Previewing La@TeX{} processing
7766 * CDLaTeX mode:: Speed up entering of formulas
7769 @node Math symbols, Subscripts and superscripts, Embedded LaTeX, Embedded LaTeX
7770 @section Math symbols
7771 @cindex math symbols
7772 @cindex @TeX{} macros
7774 You can use La@TeX{} macros to insert special symbols like @samp{\alpha} to
7775 indicate the Greek letter, or @samp{\to} to indicate an arrow. Completion
7776 for these macros is available, just type @samp{\} and maybe a few letters,
7777 and press @kbd{M-@key{TAB}} to see possible completions. Unlike La@TeX{}
7778 code, Org mode allows these macros to be present without surrounding math
7779 delimiters, for example:
7782 Angles are written as Greek letters \alpha, \beta and \gamma.
7785 During HTML export (@pxref{HTML export}), these symbols are translated
7786 into the proper syntax for HTML, for the above examples this is
7787 @samp{α} and @samp{→}, respectively. If you need such a symbol
7788 inside a word, terminate it like this: @samp{\Aacute@{@}stor}.
7790 @node Subscripts and superscripts, LaTeX fragments, Math symbols, Embedded LaTeX
7791 @section Subscripts and superscripts
7795 Just like in La@TeX{}, @samp{^} and @samp{_} are used to indicate super-
7796 and subscripts. Again, these can be used without embedding them in
7797 math-mode delimiters. To increase the readability of ASCII text, it is
7798 not necessary (but OK) to surround multi-character sub- and superscripts
7799 with curly braces. For example
7802 The mass if the sun is M_sun = 1.989 x 10^30 kg. The radius of
7803 the sun is R_@{sun@} = 6.96 x 10^8 m.
7806 To avoid interpretation as raised or lowered text, you can quote
7807 @samp{^} and @samp{_} with a backslash: @samp{\^} and @samp{\_}.
7809 During HTML export (@pxref{HTML export}), subscript and superscripts
7810 are surrounded with @code{<sub>} and @code{<sup>} tags, respectively.
7812 @node LaTeX fragments, Processing LaTeX fragments, Subscripts and superscripts, Embedded LaTeX
7813 @section La@TeX{} fragments
7814 @cindex La@TeX{} fragments
7816 @vindex org-format-latex-header
7817 With symbols, sub- and superscripts, HTML is pretty much at its end when
7818 it comes to representing mathematical formulas@footnote{Yes, there is
7819 MathML, but that is not yet fully supported by many browsers, and there
7820 is no decent converter for turning La@TeX{} or ASCII representations of
7821 formulas into MathML. So for the time being, converting formulas into
7822 images seems the way to go.}. More complex expressions need a dedicated
7823 formula processor. To this end, Org mode can contain arbitrary La@TeX{}
7824 fragments. It provides commands to preview the typeset result of these
7825 fragments, and upon export to HTML, all fragments will be converted to
7826 images and inlined into the HTML document@footnote{The La@TeX{} export
7827 will not use images for displaying La@TeX{} fragments but include these
7828 fragments directly into the La@TeX{} code.}. For this to work you
7829 need to be on a system with a working La@TeX{} installation. You also
7830 need the @file{dvipng} program, available at
7831 @url{http://sourceforge.net/projects/dvipng/}. The La@TeX{} header that
7832 will be used when processing a fragment can be configured with the
7833 variable @code{org-format-latex-header}.
7835 La@TeX{} fragments don't need any special marking at all. The following
7836 snippets will be identified as La@TeX{} source code:
7839 Environments of any kind. The only requirement is that the
7840 @code{\begin} statement appears on a new line, preceded by only
7843 Text within the usual La@TeX{} math delimiters. To avoid conflicts with
7844 currency specifications, single @samp{$} characters are only recognized as
7845 math delimiters if the enclosed text contains at most two line breaks, is
7846 directly attached to the @samp{$} characters with no whitespace in between,
7847 and if the closing @samp{$} is followed by whitespace, punctuation or a dash.
7848 For the other delimiters, there is no such restriction, so when in doubt, use
7849 @samp{\(...\)} as inline math delimiters.
7852 @noindent For example:
7855 \begin@{equation@} % arbitrary environments,
7856 x=\sqrt@{b@} % even tables, figures
7857 \end@{equation@} % etc
7859 If $a^2=b$ and \( b=2 \), then the solution must be
7860 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
7864 @vindex org-format-latex-options
7865 If you need any of the delimiter ASCII sequences for other purposes, you
7866 can configure the option @code{org-format-latex-options} to deselect the
7867 ones you do not wish to have interpreted by the La@TeX{} converter.
7869 @node Processing LaTeX fragments, CDLaTeX mode, LaTeX fragments, Embedded LaTeX
7870 @section Processing LaTeX fragments
7871 @cindex LaTeX fragments, preview
7873 La@TeX{} fragments can be processed to produce preview images of the
7874 typeset expressions:
7879 Produce a preview image of the La@TeX{} fragment at point and overlay it
7880 over the source code. If there is no fragment at point, process all
7881 fragments in the current entry (between two headlines). When called
7882 with a prefix argument, process the entire subtree. When called with
7883 two prefix arguments, or when the cursor is before the first headline,
7884 process the entire buffer.
7887 Remove the overlay preview images.
7890 During HTML export (@pxref{HTML export}), all La@TeX{} fragments are
7891 converted into images and inlined into the document if the following
7895 (setq org-export-with-LaTeX-fragments t)
7898 @node CDLaTeX mode, , Processing LaTeX fragments, Embedded LaTeX
7899 @section Using CDLa@TeX{} to enter math
7902 CDLa@TeX{} mode is a minor mode that is normally used in combination with a
7903 major La@TeX{} mode like AUC@TeX{} in order to speed-up insertion of
7904 environments and math templates. Inside Org mode, you can make use of
7905 some of the features of CDLa@TeX{} mode. You need to install
7906 @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
7907 AUC@TeX{}) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
7908 Don't use CDLa@TeX{} mode itself under Org mode, but use the light
7909 version @code{org-cdlatex-mode} that comes as part of Org mode. Turn it
7910 on for the current buffer with @code{M-x org-cdlatex-mode}, or for all
7914 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
7917 When this mode is enabled, the following features are present (for more
7918 details see the documentation of CDLa@TeX{} mode):
7922 Environment templates can be inserted with @kbd{C-c @{}.
7925 The @key{TAB} key will do template expansion if the cursor is inside a
7926 La@TeX{} fragment@footnote{Org mode has a method to test if the cursor is
7927 inside such a fragment, see the documentation of the function
7928 @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will
7929 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
7930 correctly inside the first brace. Another @key{TAB} will get you into
7931 the second brace. Even outside fragments, @key{TAB} will expand
7932 environment abbreviations at the beginning of a line. For example, if
7933 you write @samp{equ} at the beginning of a line and press @key{TAB},
7934 this abbreviation will be expanded to an @code{equation} environment.
7935 To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}.
7939 @vindex cdlatex-simplify-sub-super-scripts
7940 Pressing @kbd{_} and @kbd{^} inside a La@TeX{} fragment will insert these
7941 characters together with a pair of braces. If you use @key{TAB} to move
7942 out of the braces, and if the braces surround only a single character or
7943 macro, they are removed again (depending on the variable
7944 @code{cdlatex-simplify-sub-super-scripts}).
7947 Pressing the backquote @kbd{`} followed by a character inserts math
7948 macros, also outside La@TeX{} fragments. If you wait more than 1.5 seconds
7949 after the backquote, a help window will pop up.
7952 Pressing the single-quote @kbd{'} followed by another character modifies
7953 the symbol before point with an accent or a font. If you wait more than
7954 1.5 seconds after the backquote, a help window will pop up. Character
7955 modification will work only inside La@TeX{} fragments, outside the quote
7959 @node Exporting, Publishing, Embedded LaTeX, Top
7963 Org-mode documents can be exported into a variety of other formats. For
7964 printing and sharing of notes, ASCII export produces a readable and simple
7965 version of an Org file. HTML export allows you to publish a notes file on
7966 the web, while the XOXO format provides a solid base for exchange with a
7967 broad range of other applications. La@TeX{} export lets you use Org mode and
7968 its structured editing functions to easily create La@TeX{} files. DocBook
7969 export makes it possible to convert Org files to many other formats using
7970 DocBook tools. To incorporate entries with associated times like deadlines
7971 or appointments into a desktop calendar program like iCal, Org mode can also
7972 produce extracts in the iCalendar format. Currently Org mode only supports
7973 export, not import of these different formats.
7975 Org supports export of selected regions when @code{transient-mark-mode} is
7976 enabled (default in Emacs 23).
7979 * Markup rules:: Which structures are recognized?
7980 * Selective export:: Using tags to select and exclude trees
7981 * Export options:: Per-file export settings
7982 * The export dispatcher:: How to access exporter commands
7983 * ASCII export:: Exporting to plain ASCII
7984 * HTML export:: Exporting to HTML
7985 * LaTeX and PDF export:: Exporting to La@TeX{}, and processing to PDF
7986 * DocBook export:: Exporting to DocBook
7987 * XOXO export:: Exporting to XOXO
7988 * iCalendar export:: Exporting in iCalendar format
7991 @node Markup rules, Selective export, Exporting, Exporting
7992 @section Markup rules
7994 When exporting Org-mode documents, the exporter tries to reflect the
7995 structure of the document as accurately as possible in the backend. Since
7996 export targets like HTML, La@TeX{}, or DocBook allow much richer formatting,
7997 Org mode has rules on how to prepare text for rich export. This section
7998 summarizes the markup rules used in an Org-mode buffer.
8001 * Document title:: How the document title is determined
8002 * Headings and sections:: The main structure of the exported document
8003 * Table of contents:: If, where, how to create a table of contents
8004 * Initial text:: Text before the first headline
8005 * Lists:: Plain lists are exported
8006 * Paragraphs:: What determines beginning and ending
8007 * Literal examples:: Source code and other examples
8008 * Include files:: Include the contents of a file during export
8009 * Tables exported:: Tables are exported richly
8010 * Inlined images:: How to inline images during export
8011 * Footnote markup:: ASCII representation of footnotes
8012 * Emphasis and monospace:: To bold or not to bold
8013 * TeX macros and LaTeX fragments:: Create special, rich export.
8014 * Horizontal rules:: A line across the page
8015 * Comment lines:: Some lines will not be exported
8016 * Macro replacement:: Global replacement of place holders
8019 @node Document title, Headings and sections, Markup rules, Markup rules
8020 @subheading Document title
8021 @cindex document title, markup rules
8024 The title of the exported document is taken from the special line
8028 #+TITLE: This is the title of the document
8032 If this line does not exist, the title is derived from the first non-empty,
8033 non-comment line in the buffer. If no such line exists, or if you have
8034 turned off exporting of the text before the first headline (see below), the
8035 title will be the file name without extension.
8037 @cindex property, EXPORT_TITLE
8038 If you are exporting only a subtree by marking is as the region, the heading
8039 of the subtree will become the title of the document. If the subtree has a
8040 property @code{EXPORT_TITLE}, that will take precedence.
8042 @node Headings and sections, Table of contents, Document title, Markup rules
8043 @subheading Headings and sections
8044 @cindex headings and sections, markup rules
8046 @vindex org-headline-levels
8047 The outline structure of the document as described in @ref{Document
8048 Structure}, forms the basis for defining sections of the exported document.
8049 However, since the outline structure is also used for (for example) lists of
8050 tasks, only the first three outline levels will be used as headings. Deeper
8051 levels will become itemized lists. You can change the location of this
8052 switch globally by setting the variable @code{org-headline-levels}, or on a
8053 per-file basis with a line
8060 @node Table of contents, Initial text, Headings and sections, Markup rules
8061 @subheading Table of contents
8062 @cindex table of contents, markup rules
8064 @vindex org-export-with-toc
8065 The table of contents is normally inserted directly before the first headline
8066 of the file. If you would like to get it to a different location, insert the
8067 string @code{[TABLE-OF-CONTENTS]} on a line by itself at the desired
8068 location. The depth of the table of contents is by default the same as the
8069 number of headline levels, but you can choose a smaller number, or turn off
8070 the table of contents entirely, by configuring the variable
8071 @code{org-export-with-toc}, or on a per-file basis with a line like
8074 #+OPTIONS: toc:2 (only to two levels in TOC)
8075 #+OPTIONS: toc:nil (no TOC at all)
8078 @node Initial text, Lists, Table of contents, Markup rules
8079 @subheading Text before the first headline
8080 @cindex text before first headline, markup rules
8083 Org mode normally exports the text before the first headline, and even uses
8084 the first line as the document title. The text will be fully marked up. If
8085 you need to include literal HTML, La@TeX{}, or DocBook code, use the special
8086 constructs described below in the sections for the individual exporters.
8088 @vindex org-export-skip-text-before-1st-heading
8089 Some people like to use the space before the first headline for setup and
8090 internal links and therefore would like to control the exported text before
8091 the first headline in a different way. You can do so by setting the variable
8092 @code{org-export-skip-text-before-1st-heading} to @code{t}. On a per-file
8093 basis, you can get the same effect with @samp{#+OPTIONS: skip:t}.
8096 If you still want to have some text before the first headline, use the
8097 @code{#+TEXT} construct:
8101 #+TEXT: This text will go before the *first* headline.
8102 #+TEXT: [TABLE-OF-CONTENTS]
8103 #+TEXT: This goes between the table of contents and the first headline
8106 @node Lists, Paragraphs, Initial text, Markup rules
8108 @cindex lists, markup rules
8110 Plain lists as described in @ref{Plain lists}, are translated to the backend's
8111 syntax for such lists. Most backends support unordered, ordered, and
8114 @node Paragraphs, Literal examples, Lists, Markup rules
8115 @subheading Paragraphs, line breaks, and quoting
8116 @cindex paragraphs, markup rules
8118 Paragraphs are separated by at least one empty line. If you need to enforce
8119 a line break within a paragraph, use @samp{\\} at the end of a line.
8121 To keep the line breaks in a region, but otherwise use normal formatting, you
8122 can use this construct, which can also be used to format poetry.
8124 @cindex #+BEGIN_VERSE
8127 Great clouds overhead
8128 Tiny black birds rise and fall
8135 When quoting a passage from another document, it is customary to format this
8136 as a paragraph that is indented on both the left and the right margin. You
8137 can include quotations in Org-mode documents like this:
8139 @cindex #+BEGIN_QUOTE
8142 Everything should be made as simple as possible,
8143 but not any simpler -- Albert Einstein
8147 If you would like to center some text, do it like this:
8148 @cindex #+BEGIN_CENTER
8151 Everything should be made as simple as possible, \\
8156 @node Literal examples, Include files, Paragraphs, Markup rules
8157 @subheading Literal examples
8158 @cindex literal examples, markup rules
8159 @cindex code line references, markup rules
8161 You can include literal examples that should not be subjected to
8162 markup. Such examples will be typeset in monospace, so this is well suited
8163 for source code and similar examples.
8164 @cindex #+BEGIN_EXAMPLE
8168 Some example from a text file.
8172 Note that such blocks may be @i{indented} in order to align nicely with
8173 indented text and in particular with plain list structure (@pxref{Plain
8174 lists}). For simplicity when using small examples, you can also start the
8175 example lines with a colon followed by a space. There may also be additional
8176 whitespace before the colon:
8180 : Some example from a text file.
8183 @cindex formatting source code, markup rules
8184 If the example is source code from a programming language, or any other text
8185 that can be marked up by font-lock in Emacs, you can ask for the example to
8186 look like the fontified Emacs buffer@footnote{Currently this works for the
8187 HTML backend, and requires the @file{htmlize.el} package version 1.34 or
8188 later. It also works for LaTeX with the listings package, if you turn on the
8189 option @code{org-export-latex-listings} and make sure that the listings
8190 package is included by the LaTeX header.}. This is done with the @samp{src}
8191 block, where you also need to specify the name of the major mode that should
8192 be used to fontify the example:
8196 #+BEGIN_SRC emacs-lisp
8197 (defun org-xor (a b)
8203 Both in @code{example} and in @code{src} snippets, you can add a @code{-n}
8204 switch to the end of the @code{BEGIN} line, to get the lines of the example
8205 numbered. If you use a @code{+n} switch, the numbering from the previous
8206 numbered snippet will be continued in the current one. In literal examples,
8207 Org will interpret strings like @samp{(ref:name)} as labels, and use them as
8208 targets for special hyperlinks like @code{[[(name)]]} (@ie the reference name
8209 enclosed in single parenthesis). In HTML, hovering the mouse over such a
8210 link will remote-highlight the corresponding code line, which is kind of
8213 You can also add a @code{-r} switch which @i{removes} the labels from the
8214 source code@footnote{Adding @code{-k} to @code{-n -r} will @i{keep} the
8215 labels in the source code while using line numbers for the links, which might
8216 be useful to explain those in an org-mode example code.}. With the @code{-n}
8217 switch, links to these references will be labeled by the line numbers from
8218 the code listing, otherwise links will use the labels with no parentheses.
8222 #+BEGIN_SRC emacs-lisp -n -r
8223 (save-excursion (ref:sc)
8224 (goto-char (point-min)) (ref:jump)
8226 In line [[(sc)]] we remember the current position. [[(jump)][Line (jump)]]
8230 @vindex org-coderef-label-format
8231 If the syntax for the label format conflicts with the language syntax, use a
8232 @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
8233 -n -r -l "((%s))"}. See also the variable @code{org-coderef-label-format}.
8235 HTML export also allows examples to be published as text areas, @xref{Text
8236 areas in HTML export}.
8241 Edit the source code example at point in its native mode. This works by
8242 switching to a temporary buffer with the source code. You need to exit by
8243 pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*}
8244 or @samp{#} will get a comma prepended, to keep them from being interpreted
8245 by Org as outline nodes or special comments. These commas will be striped
8246 for editing with @kbd{C-c '}, and also for export.}, the edited version will
8247 then replace the old version in the Org buffer. Fixed-width regions
8248 (where each line starts with a colon followed by a space) will be edited
8249 using @code{artist-mode}@footnote{You may select a different-mode with the
8250 variable @code{org-edit-fixed-width-region-mode}.} to allow creating ASCII
8251 drawings easily. Using this command in an empty line will create a new
8255 Calling @code{org-store-link} while editing a source code example in a
8256 temporary buffer created with @kbd{C-c '} will prompt for a label, make sure
8257 that it is unique in the current buffer, and insert it with the proper
8258 formatting like @samp{(ref:label)} at the end of the current line. Then the
8259 label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
8263 @node Include files, Tables exported, Literal examples, Markup rules
8264 @subheading Include files
8265 @cindex include files, markup rules
8267 During export, you can include the content of another file. For example, to
8268 include your @file{.emacs} file, you could use:
8272 #+INCLUDE: "~/.emacs" src emacs-lisp
8275 The optional second and third parameter are the markup (e.g. @samp{quote},
8276 @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the
8277 language for formatting the contents. The markup is optional, if it is not
8278 given, the text will be assumed to be in Org mode format and will be
8279 processed normally. The include line will also allow additional keyword
8280 parameters @code{:prefix1} and @code{:prefix} to specify prefixes for the
8281 first line and for each following line, as well as any options accepted by
8282 the selected markup. For example, to include a file as an item, use
8285 #+INCLUDE: "~/snippets/xx" :prefix1 " + " :prefix " "
8291 Visit the include file at point.
8294 @node Tables exported, Inlined images, Include files, Markup rules
8296 @cindex tables, markup rules
8298 Both the native Org mode tables (@pxref{Tables}) and tables formatted with
8299 the @file{table.el} package will be exported properly. For Org mode tables,
8300 the lines before the first horizontal separator line will become table header
8301 lines. You can use the following lines somewhere before the table to assign
8302 a caption and a label for cross references:
8305 #+CAPTION: This is the caption for the next table (or link)
8306 #+LABEL: tbl:basic-data
8309 @node Inlined images, Footnote markup, Tables exported, Markup rules
8310 @subheading Inlined Images
8311 @cindex inlined images, markup rules
8313 Some backends (HTML, La@TeX{}, and DocBook) allow you to directly include images
8314 into the exported document. Org does this, if a link to an image files does
8315 not have a description part, for example @code{[[./img/a.jpg]]}. If you wish
8316 to define a caption for the image and maybe a label for internal cross
8317 references, you can use (before, but close to the link)
8320 #+CAPTION: This is the caption for the next figure link (or table)
8321 #+LABEL: fig:SED-HR4049
8324 You may also define additional attributes for the figure. As this is
8325 backend-specific, see the sections about the individual backends for more
8328 @node Footnote markup, Emphasis and monospace, Inlined images, Markup rules
8329 @subheading Footnote markup
8330 @cindex footnotes, markup rules
8331 @cindex @file{footnote.el}
8333 Footnotes defined in the way described in @ref{Footnotes}, will be exported by
8334 all backends. Org allows multiple references to the same note, and
8335 different backends support this to varying degrees.
8337 @node Emphasis and monospace, TeX macros and LaTeX fragments, Footnote markup, Markup rules
8338 @subheading Emphasis and monospace
8340 @cindex underlined text, markup rules
8341 @cindex bold text, markup rules
8342 @cindex italic text, markup rules
8343 @cindex verbatim text, markup rules
8344 @cindex code text, markup rules
8345 @cindex strike-through text, markup rules
8346 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=}
8347 and @code{~verbatim~}, and, if you must, @samp{+strike-through+}. Text
8348 in the code and verbatim string is not processed for Org-mode specific
8349 syntax, it is exported verbatim.
8351 @node TeX macros and LaTeX fragments, Horizontal rules, Emphasis and monospace, Markup rules
8352 @subheading @TeX{} macros and La@TeX{} fragments
8353 @cindex La@TeX{} fragments, markup rules
8354 @cindex @TeX{} macros, markup rules
8355 @cindex HTML entities
8356 @cindex La@TeX{} entities
8358 @vindex org-html-entities
8359 A @TeX{}-like syntax is used to specify special characters. Where possible,
8360 these will be transformed into the native format of the exporter backend.
8361 Strings like @code{\alpha} will be exported as @code{α} in the HTML
8362 output, and as @code{$\alpha$} in the La@TeX{} output. Similarly,
8363 @code{\nbsp} will become @code{ } in HTML and @code{~} in La@TeX{}.
8364 This applies for a large number of entities, with names taken from both HTML
8365 and La@TeX{}, see the variable @code{org-html-entities} for the complete
8366 list. If you are unsure about a name, use @kbd{M-@key{TAB}} for completion
8367 after having typed the backslash and optionally a few characters
8368 (@pxref{Completion}).
8370 La@TeX{} fragments are converted into images for HTML export, and they are
8371 written literally into the La@TeX{} export. See also @ref{Embedded LaTeX}.
8373 Finally, @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
8374 @samp{...} are all converted into special commands creating hyphens of
8375 different lengths or a compact set of dots.
8377 @node Horizontal rules, Comment lines, TeX macros and LaTeX fragments, Markup rules
8378 @subheading Horizontal rules
8379 @cindex horizontal rules, markup rules
8380 A line consisting of only dashes, and at least 5 of them, will be
8381 exported as a horizontal line (@samp{<hr/>} in HTML).
8383 @node Comment lines, Macro replacement, Horizontal rules, Markup rules
8384 @subheading Comment lines
8385 @cindex comment lines
8386 @cindex exporting, not
8387 @cindex #+BEGIN_COMMENT
8389 Lines starting with @samp{#} in column zero are treated as comments and will
8390 never be exported. Also entire subtrees starting with the word
8391 @samp{COMMENT} will never be exported. Finally, regions surrounded by
8392 @samp{#+BEGIN_COMMENT} ... @samp{#+END_COMMENT} will not be exported.
8397 Toggle the COMMENT keyword at the beginning of an entry.
8400 @node Macro replacement, , Comment lines, Markup rules
8401 @subheading Macro replacement
8402 @cindex macro replacement, during export
8405 You can define text snippets with
8408 #+MACRO: name replacement text $1, $2 are arguments
8411 @noindent which can be referenced anywhere in the document (even in
8412 code examples) with @code{@{@{@{name(arg1,arg2)@}@}@}}. In addition to
8413 defined macros, @code{@{@{@{title@}@}@}}, @code{@{@{@{author@}@}@}}, etc.,
8414 will reference information set by the @code{#+TITLE:}, @code{#+AUTHOR:}, and
8415 similar lines. Also, @code{@{@{@{date(@var{FORMAT})@}@}@}} and
8416 @code{@{@{@{modification-time(@var{FORMAT})@}@}@}} refer to current date time
8417 and to the modification time of the file being exported, respectively.
8418 @var{FORMAT} should be a format string understood by
8419 @code{format-time-string}.
8421 @node Selective export, Export options, Markup rules, Exporting
8422 @section Selective export
8423 @cindex export, selective by tags
8425 @vindex org-export-select-tags
8426 @vindex org-export-exclude-tags
8427 You may use tags to select the parts of a document that should be exported,
8428 or to exclude parts from export. This behavior is governed by two variables:
8429 @code{org-export-select-tags} and @code{org-export-exclude-tags}.
8431 Org first checks if any of the @emph{select} tags is present in the buffer.
8432 If yes, all trees that do not carry one of these tags will be excluded. If a
8433 selected tree is a subtree, the heading hierarchy above it will also be
8434 selected for export, but not the text below those headings.
8437 If none of the select tags is found, the whole buffer will be selected for
8441 Finally, all subtrees that are marked by any of the @emph{exclude} tags will
8442 be removed from the export buffer.
8444 @node Export options, The export dispatcher, Selective export, Exporting
8445 @section Export options
8446 @cindex options, for export
8448 @cindex completion, of option keywords
8449 The exporter recognizes special lines in the buffer which provide
8450 additional information. These lines may be put anywhere in the file.
8451 The whole set of lines can be inserted into the buffer with @kbd{C-c
8452 C-e t}. For individual lines, a good way to make sure the keyword is
8453 correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion
8454 (@pxref{Completion}). For a summary of other in-buffer settings not
8455 specifically related to export, see @ref{In-buffer settings}.
8456 In particular, note that you can place commonly-used (export) options in
8457 a separate file which can be included using @code{#+SETUPFILE}.
8462 Insert template with export options, see example below.
8469 @cindex #+DESCRIPTION
8477 @cindex #+EXPORT_SELECT_TAGS
8478 @cindex #+EXPORT_EXCLUDE_TAGS
8479 @cindex #+LATEX_HEADER
8480 @vindex user-full-name
8481 @vindex user-mail-address
8482 @vindex org-export-default-language
8484 #+TITLE: the title to be shown (default is the buffer name)
8485 #+AUTHOR: the author (default taken from @code{user-full-name})
8486 #+DATE: a date, fixed, of a format string for @code{format-time-string}
8487 #+EMAIL: his/her email address (default from @code{user-mail-address})
8488 #+DESCRIPTION: the page description, @eg for the XHTML meta tag
8489 #+KEYWORDS: the page keywords, @eg for the XHTML meta tag
8490 #+LANGUAGE: language for HTML, @eg @samp{en} (@code{org-export-default-language})
8491 #+TEXT: Some descriptive text to be inserted at the beginning.
8492 #+TEXT: Several lines may be given.
8493 #+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ...
8494 #+BIND: lisp-var lisp-val, e.g.: org-export-latex-low-levels itemize
8495 @r{You need to confirm using these, or configure @code{org-export-allow-BIND}}
8496 #+LINK_UP: the ``up'' link of an exported page
8497 #+LINK_HOME: the ``home'' link of an exported page
8498 #+LATEX_HEADER: extra line(s) for the LaTeX header, like \usepackage@{xyz@}
8499 #+EXPORT_SELECT_TAGS: Tags that select a tree for export
8500 #+EXPORT_EXCLUDE_TAGS: Tags that exclude a tree from export
8504 The OPTIONS line is a compact@footnote{If you want to configure many options
8505 this way, you can use several OPTIONS lines.} form to specify export settings. Here
8507 @cindex headline levels
8508 @cindex section-numbers
8509 @cindex table of contents
8510 @cindex line-break preservation
8511 @cindex quoted HTML tags
8512 @cindex fixed-width sections
8514 @cindex @TeX{}-like syntax for sub- and superscripts
8516 @cindex special strings
8517 @cindex emphasized text
8518 @cindex @TeX{} macros
8519 @cindex La@TeX{} fragments
8520 @cindex author info, in export
8521 @cindex time info, in export
8523 H: @r{set the number of headline levels for export}
8524 num: @r{turn on/off section-numbers}
8525 toc: @r{turn on/off table of contents, or set level limit (integer)}
8526 \n: @r{turn on/off line-break-preservation}
8527 @@: @r{turn on/off quoted HTML tags}
8528 :: @r{turn on/off fixed-width sections}
8529 |: @r{turn on/off tables}
8530 ^: @r{turn on/off @TeX{}-like syntax for sub- and superscripts. If}
8531 @r{you write "^:@{@}", @code{a_@{b@}} will be interpreted, but}
8532 @r{the simple @code{a_b} will be left as it is.}
8533 -: @r{turn on/off conversion of special strings.}
8534 f: @r{turn on/off footnotes like this[1].}
8535 todo: @r{turn on/off inclusion of TODO keywords into exported text}
8536 pri: @r{turn on/off priority cookies}
8537 tags: @r{turn on/off inclusion of tags, may also be @code{not-in-toc}}
8538 <: @r{turn on/off inclusion of any time/date stamps like DEADLINES}
8539 *: @r{turn on/off emphasized text (bold, italic, underlined)}
8540 TeX: @r{turn on/off simple @TeX{} macros in plain text}
8541 LaTeX: @r{turn on/off La@TeX{} fragments}
8542 skip: @r{turn on/off skipping the text before the first heading}
8543 author: @r{turn on/off inclusion of author name/email into exported file}
8544 creator: @r{turn on/off inclusion of creator info into exported file}
8545 timestamp: @r{turn on/off inclusion creation time into exported file}
8546 d: @r{turn on/off inclusion of drawers}
8549 These options take effect in both the HTML and La@TeX{} export, except
8550 for @code{TeX} and @code{LaTeX}, which are respectively @code{t} and
8551 @code{nil} for the La@TeX{} export.
8553 When exporting only a single subtree by selecting it with @kbd{C-c @@} before
8554 calling an export command, the subtree can overrule some of the file's export
8555 settings with properties @code{EXPORT_FILE_NAME}, @code{EXPORT_TITLE},
8556 @code{EXPORT_TEXT}, @code{EXPORT_AUTHOR}, @code{EXPORT_DATE}, and
8557 @code{EXPORT_OPTIONS}.
8559 @node The export dispatcher, ASCII export, Export options, Exporting
8560 @section The export dispatcher
8561 @cindex dispatcher, for export commands
8563 All export commands can be reached using the export dispatcher, which is a
8564 prefix key that prompts for an additional key specifying the command.
8565 Normally the entire file is exported, but if there is an active region that
8566 contains one outline tree, the first heading is used as document title and
8567 the subtrees are exported.
8572 @vindex org-export-run-in-background
8573 Dispatcher for export and publishing commands. Displays a help-window
8574 listing the additional key(s) needed to launch an export or publishing
8575 command. The prefix arg is passed through to the exporter. A double prefix
8576 @kbd{C-u C-u} causes most commands to be executed in the background, in a
8577 separate Emacs process@footnote{To make this behavior the default, customize
8578 the variable @code{org-export-run-in-background}.}.
8581 Like @kbd{C-c C-e}, but only export the text that is currently visible
8582 (@ie not hidden by outline visibility).
8583 @kindex C-u C-u C-c C-e
8584 @item C-u C-u C-c C-e
8585 @vindex org-export-run-in-background
8586 Call an the exporter, but reverse the setting of
8587 @code{org-export-run-in-background}, @ie request background processing if
8588 not set, or force processing in the current Emacs process if set.
8591 @node ASCII export, HTML export, The export dispatcher, Exporting
8592 @section ASCII export
8593 @cindex ASCII export
8595 ASCII export produces a simple and very readable version of an Org-mode
8598 @cindex region, active
8599 @cindex active region
8600 @cindex transient-mark-mode
8604 @cindex property, EXPORT_FILE_NAME
8605 Export as ASCII file. For an Org file, @file{myfile.org}, the ASCII file
8606 will be @file{myfile.txt}. The file will be overwritten without
8607 warning. If there is an active region@footnote{This requires
8608 @code{transient-mark-mode} be turned on.}, only the region will be
8609 exported. If the selected region is a single tree@footnote{To select the
8610 current subtree, use @kbd{C-c @@}.}, the tree head will
8611 become the document title. If the tree head entry has or inherits an
8612 @code{EXPORT_FILE_NAME} property, that name will be used for the
8616 Export to a temporary buffer, do not create a file.
8619 Export only the visible part of the document.
8622 @cindex headline levels, for exporting
8623 In the exported version, the first 3 outline levels will become
8624 headlines, defining a general document structure. Additional levels
8625 will be exported as itemized lists. If you want that transition to occur
8626 at a different level, specify it with a prefix argument. For example,
8633 creates only top level headlines and does the rest as items. When
8634 headlines are converted to items, the indentation of the text following
8635 the headline is changed to fit nicely under the item. This is done with
8636 the assumption that the first body line indicates the base indentation of
8637 the body text. Any indentation larger than this is adjusted to preserve
8638 the layout relative to the first line. Should there be lines with less
8639 indentation than the first, these are left alone.
8641 @vindex org-export-ascii-links-to-notes
8642 Links will be exported in a footnote-like style, with the descriptive part in
8643 the text and the link in a note before the next heading. See the variable
8644 @code{org-export-ascii-links-to-notes} for details and other options.
8646 @node HTML export, LaTeX and PDF export, ASCII export, Exporting
8647 @section HTML export
8650 Org mode contains an HTML (XHTML 1.0 strict) exporter with extensive
8651 HTML formatting, in ways similar to John Gruber's @emph{markdown}
8652 language, but with additional support for tables.
8655 * HTML Export commands:: How to invoke HTML export
8656 * Quoting HTML tags:: Using direct HTML in Org mode
8657 * Links:: Transformation of links for HTML
8658 * Tables in HTML export:: How to modify the formatting of tables
8659 * Images in HTML export:: How to insert figures into HTML output
8660 * Text areas in HTML export:: An alternative way to show an example
8661 * CSS support:: Changing the appearance of the output
8662 * Javascript support:: Info and Folding in a web browser
8665 @node HTML Export commands, Quoting HTML tags, HTML export, HTML export
8666 @subsection HTML export commands
8668 @cindex region, active
8669 @cindex active region
8670 @cindex transient-mark-mode
8674 @cindex property, EXPORT_FILE_NAME
8675 Export as HTML file @file{myfile.html}. For an Org file @file{myfile.org},
8676 the ASCII file will be @file{myfile.html}. The file will be overwritten
8677 without warning. If there is an active region@footnote{This requires
8678 @code{transient-mark-mode} be turned on.}, only the region will be
8679 exported. If the selected region is a single tree@footnote{To select the
8680 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
8681 title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
8682 property, that name will be used for the export.
8685 Export as HTML file and immediately open it with a browser.
8688 Export to a temporary buffer, do not create a file.
8691 Export the active region to a temporary buffer. With a prefix argument, do
8692 not produce the file header and footer, but just the plain HTML section for
8693 the region. This is good for cut-and-paste operations.
8702 Export only the visible part of the document.
8703 @item M-x org-export-region-as-html
8704 Convert the region to HTML under the assumption that it was Org-mode
8705 syntax before. This is a global command that can be invoked in any
8707 @item M-x org-replace-region-by-HTML
8708 Replace the active region (assumed to be in Org-mode syntax) by HTML
8712 @cindex headline levels, for exporting
8713 In the exported version, the first 3 outline levels will become headlines,
8714 defining a general document structure. Additional levels will be exported as
8715 itemized lists. If you want that transition to occur at a different level,
8716 specify it with a numeric prefix argument. For example,
8723 creates two levels of headings and does the rest as items.
8725 @node Quoting HTML tags, Links, HTML Export commands, HTML export
8726 @subsection Quoting HTML tags
8728 Plain @samp{<} and @samp{>} are always transformed to @samp{<} and
8729 @samp{>} in HTML export. If you want to include simple HTML tags
8730 which should be interpreted as such, mark them with @samp{@@} as in
8731 @samp{@@<b>bold text@@</b>}. Note that this really works only for
8732 simple tags. For more extensive HTML that should be copied verbatim to
8733 the exported file use either
8736 @cindex #+BEGIN_HTML
8738 #+HTML: Literal HTML code for export
8742 @cindex #+BEGIN_HTML
8746 All lines between these markers are exported literally
8751 @node Links, Tables in HTML export, Quoting HTML tags, HTML export
8754 @cindex links, in HTML export
8755 @cindex internal links, in HTML export
8756 @cindex external links, in HTML export
8757 Internal links (@pxref{Internal links}) will continue to work in HTML. This
8758 includes automatic links created by radio targets (@pxref{Radio
8759 targets}). Links to external files will still work if the target file is on
8760 the same @i{relative} path as the published Org file. Links to other
8761 @file{.org} files will be translated into HTML links under the assumption
8762 that an HTML version also exists of the linked file, at the same relative
8763 path. @samp{id:} links can then be used to jump to specific entries across
8764 files. For information related to linking files while publishing them to a
8765 publishing directory see @ref{Publishing links}.
8767 If you want to specify attributes for links, you can do so using a special
8768 @code{#+ATTR_HTML} line to define attributes that will be added to the
8769 @code{<a>} or @code{<img>} tags. Here is an example that sets @code{title}
8770 and @code{style} attributes for a link:
8774 #+ATTR_HTML: title="The Org-mode homepage" style="color:red;"
8775 [[http://orgmode.org]]
8778 @node Tables in HTML export, Images in HTML export, Links, HTML export
8780 @cindex tables, in HTML
8781 @vindex org-export-html-table-tag
8783 Org-mode tables are exported to HTML using the table tag defined in
8784 @code{org-export-html-table-tag}. The default setting makes tables without
8785 cell borders and frame. If you would like to change this for individual
8786 tables, place somthing like the following before the table:
8790 #+CAPTION: This is a table with lines around and between cells
8791 #+ATTR_HTML: border="2" rules="all" frame="all"
8794 @node Images in HTML export, Text areas in HTML export, Tables in HTML export, HTML export
8797 @cindex images, inline in HTML
8798 @cindex inlining images in HTML
8799 @vindex org-export-html-inline-images
8800 HTML export can inline images given as links in the Org file, and
8801 it can make an image the clickable part of a link. By
8802 default@footnote{But see the variable
8803 @code{org-export-html-inline-images}.}, images are inlined if a link does
8804 not have a description. So @samp{[[file:myimg.jpg]]} will be inlined,
8805 while @samp{[[file:myimg.jpg][the image]]} will just produce a link
8806 @samp{the image} that points to the image. If the description part
8807 itself is a @code{file:} link or a @code{http:} URL pointing to an
8808 image, this image will be inlined and activated so that clicking on the
8809 image will activate the link. For example, to include a thumbnail that
8810 will link to a high resolution version of the image, you could use:
8813 [[file:highres.jpg][file:thumb.jpg]]
8816 If you need to add attributes to an inlines image, use a @code{#+ATTR_HTML},
8821 #+CAPTION: A black cat stalking a spider
8822 #+ATTR_HTML: alt="cat/spider image" title="one second before action"
8827 and you could use @code{http} addresses just as well.
8829 @node Text areas in HTML export, CSS support, Images in HTML export, HTML export
8830 @subsection Text areas
8832 @cindex text areas, in HTML
8833 An alternative way to publish literal code examples in HTML is to use text
8834 areas, where the example can even be edited before pasting it into an
8835 application. It is triggered by a @code{-t} switch at an @code{example} or
8836 @code{src} block. Using this switch disables any options for syntax and
8837 label highlighting, and line numbering, which may be present. You may also
8838 use @code{-h} and @code{-w} switches to specify the height and width of the
8839 text area, which default to the number of lines in the example, and 80,
8840 respectively. For example
8843 #+BEGIN_EXAMPLE -t -w 40
8844 (defun org-xor (a b)
8851 @node CSS support, Javascript support, Text areas in HTML export, HTML export
8852 @subsection CSS support
8853 @cindex CSS, for HTML export
8854 @cindex HTML export, CSS
8856 @vindex org-export-html-todo-kwd-class-prefix
8857 @vindex org-export-html-tag-class-prefix
8858 You can also give style information for the exported file. The HTML exporter
8859 assigns the following special CSS classes@footnote{If the classes on TODO
8860 keywords and tags lead to conflicts, use the variables
8861 @code{org-export-html-todo-kwd-class-prefix} and
8862 @code{org-export-html-tag-class-prefix} to make them unique.} to appropriate
8863 parts of the document---your style specifications may change these, in
8864 addition to any of the standard classes like for headlines, tables, etc.
8866 p.author @r{author information, including email}
8867 p.date @r{publishing date}
8868 p.creator @r{creator info, about org-mode version}
8869 .title @r{document title}
8870 .todo @r{TODO keywords, all not-done states}
8871 .done @r{the DONE keywords, all stated the count as done}
8872 .WAITING @r{each TODO keyword also uses a class named after itself}
8873 .timestamp @r{timestamp}
8874 .timestamp-kwd @r{keyword associated with a timestamp, like SCHEDULED}
8875 .timestamp-wrapper @r{span around keyword plus timestamp}
8876 .tag @r{tag in a headline}
8877 ._HOME @r{each tag uses itself as a class, "@@" replaced by "_"}
8878 .target @r{target for links}
8879 .linenr @r{the line number in a code example}
8880 .code-highlighted @r{for highlighting referenced code lines}
8881 div.outline-N @r{div for outline level N (headline plus text))}
8882 div.outline-text-N @r{extra div for text at outline level N}
8883 .section-number-N @r{section number in headlines, different for each level}
8884 div.figure @r{how to format an inlined image}
8885 pre.src @r{formatted source code}
8886 pre.example @r{normal example}
8887 p.verse @r{verse paragraph}
8888 div.footnotes @r{footnote section headline}
8889 p.footnote @r{footnote definition paragraph, containing a footnote}
8890 .footref @r{a footnote reference number (always a <sup>)}
8891 .footnum @r{footnote number in footnote definition (always <sup>)}
8894 @vindex org-export-html-style-default
8895 @vindex org-export-html-style-include-default
8896 @vindex org-export-html-style
8897 @vindex org-export-html-extra
8898 @vindex org-export-html-style-default
8899 Each exported file contains a compact default style that defines these
8900 classes in a basic way@footnote{This style is defined in the constant
8901 @code{org-export-html-style-default}, which you should not modify. To turn
8902 inclusion of these defaults off, customize
8903 @code{org-export-html-style-include-default}}. You may overwrite these
8904 settings, or add to them by using the variables @code{org-export-html-style}
8905 (for Org-wide settings) and @code{org-export-html-style-extra} (for more
8906 granular settings, like file-local settings). To set the latter variable
8907 individually for each file, you can use
8911 #+STYLE: <link rel="stylesheet" type="text/css" href="stylesheet.css" />
8915 For longer style definitions, you can use several such lines. You could also
8916 directly write a @code{<style>} @code{</style>} section in this way, without
8917 referring to an external file.
8919 @c FIXME: More about header and footer styles
8920 @c FIXME: Talk about links and targets.
8922 @node Javascript support, , CSS support, HTML export
8923 @subsection Javascript supported display of web pages
8925 @cindex Rose, Sebastian
8926 Sebastian Rose has written a JavaScript program especially designed to
8927 enhance the web viewing experience of HTML files created with Org. This
8928 program allows you to view large files in two different ways. The first one
8929 is an @emph{Info}-like mode where each section is displayed separately and
8930 navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
8931 as well, press @kbd{?} for an overview of the available keys). The second
8932 view type is a @emph{folding} view much like Org provides inside Emacs. The
8933 script is available at @url{http://orgmode.org/org-info.js} and you can find
8934 the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
8935 We host the script at our site, but if you use it a lot, you might
8936 not want to be dependent on @url{orgmode.org} and prefer to install a local
8937 copy on your own web server.
8939 To use the script, you need to make sure that the @file{org-jsinfo.el} module
8940 gets loaded. It should be loaded by default, but you can try @kbd{M-x
8941 customize-variable @key{RET} org-modules @key{RET}} to convince yourself that
8942 this is indeed the case. All it then takes to make use of the program is
8943 adding a single line to the Org file:
8945 @cindex #+INFOJS_OPT
8947 #+INFOJS_OPT: view:info toc:nil
8951 If this line is found, the HTML header will automatically contain the code
8952 needed to invoke the script. Using the line above, you can set the following
8956 path: @r{The path to the script. The default is to grab the script from}
8957 @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
8958 @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
8959 view: @r{Initial view when website is first shown. Possible values are:}
8960 info @r{Info-like interface with one section per page.}
8961 overview @r{Folding interface, initially showing only top-level.}
8962 content @r{Folding interface, starting with all headlines visible.}
8963 showall @r{Folding interface, all headlines and text visible.}
8964 sdepth: @r{Maximum headline level that will still become an independent}
8965 @r{section for info and folding modes. The default is taken from}
8966 @r{@code{org-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
8967 @r{If this is smaller than in @code{org-headline-levels}, each}
8968 @r{info/folding section can still contain child headlines.}
8969 toc: @r{Should the table of content @emph{initially} be visible?}
8970 @r{Even when @code{nil}, you can always get to the "toc" with @kbd{i}.}
8971 tdepth: @r{The depth of the table of contents. The defaults are taken from}
8972 @r{the variables @code{org-headline-levels} and @code{org-export-with-toc}.}
8973 ftoc: @r{Does the css of the page specify a fixed position for the "toc"?}
8974 @r{If yes, the toc will never be displayed as a section.}
8975 ltoc: @r{Should there be short contents (children) in each section?}
8976 @r{Make this @code{above} if the section should be above initial text.}
8977 mouse: @r{Headings are highlighted when the mouse is over them. Should be}
8978 @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
8979 buttons: @r{Should view-toggle buttons be everywhere? When @code{nil} (the}
8980 @r{default), only one such button will be present.}
8983 @vindex org-infojs-options
8984 @vindex org-export-html-use-infojs
8985 You can choose default values for these options by customizing the variable
8986 @code{org-infojs-options}. If you always want to apply the script to your
8987 pages, configure the variable @code{org-export-html-use-infojs}.
8989 @node LaTeX and PDF export, DocBook export, HTML export, Exporting
8990 @section La@TeX{} and PDF export
8991 @cindex La@TeX{} export
8993 @cindex Guerry, Bastian
8995 Org mode contains a La@TeX{} exporter written by Bastien Guerry. With
8996 further processing, this backend is also used to produce PDF output. Since
8997 the La@TeX{} output uses @file{hyperref} to implement links and cross
8998 references, the PDF output file will be fully linked.
9001 * LaTeX/PDF export commands:: Which key invokes which commands
9002 * Quoting LaTeX code:: Incorporating literal La@TeX{} code
9003 * Sectioning structure:: Changing sectioning in La@TeX{} output
9004 * Tables in LaTeX export:: Options for exporting tables to La@TeX{}
9005 * Images in LaTeX export:: How to insert figures into La@TeX{} output
9008 @node LaTeX/PDF export commands, Quoting LaTeX code, LaTeX and PDF export, LaTeX and PDF export
9009 @subsection La@TeX{} export commands
9011 @cindex region, active
9012 @cindex active region
9013 @cindex transient-mark-mode
9017 @cindex property EXPORT_FILE_NAME
9018 Export as La@TeX{} file @file{myfile.tex}. For an Org file
9019 @file{myfile.org}, the ASCII file will be @file{myfile.tex}. The file will
9020 be overwritten without warning. If there is an active region@footnote{This
9021 requires @code{transient-mark-mode} be turned on.}, only the region will be
9022 exported. If the selected region is a single tree@footnote{To select the
9023 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
9024 title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME}
9025 property, that name will be used for the export.
9028 Export to a temporary buffer, do not create a file.
9033 Export only the visible part of the document.
9034 @item M-x org-export-region-as-latex
9035 Convert the region to La@TeX{} under the assumption that it was Org mode
9036 syntax before. This is a global command that can be invoked in any
9038 @item M-x org-replace-region-by-latex
9039 Replace the active region (assumed to be in Org mode syntax) by La@TeX{}
9043 Export as La@TeX{} and then process to PDF.
9046 Export as La@TeX{} and then process to PDF, then open the resulting PDF file.
9049 @cindex headline levels, for exporting
9050 @vindex org-latex-low-levels
9051 In the exported version, the first 3 outline levels will become
9052 headlines, defining a general document structure. Additional levels
9053 will be exported as description lists. The exporter can ignore them or
9054 convert them to a custom string depending on
9055 @code{org-latex-low-levels}.
9057 If you want that transition to occur at a different level, specify it
9058 with a numeric prefix argument. For example,
9065 creates two levels of headings and does the rest as items.
9067 @node Quoting LaTeX code, Sectioning structure, LaTeX/PDF export commands, LaTeX and PDF export
9068 @subsection Quoting La@TeX{} code
9070 Embedded La@TeX{} as described in @ref{Embedded LaTeX}, will be correctly
9071 inserted into the La@TeX{} file. This includes simple macros like
9072 @samp{\ref@{LABEL@}} to create a cross reference to a figure. Furthermore,
9073 you can add special code that should only be present in La@TeX{} export with
9074 the following constructs:
9077 @cindex #+BEGIN_LaTeX
9079 #+LaTeX: Literal LaTeX code for export
9083 @cindex #+BEGIN_LaTeX
9087 All lines between these markers are exported literally
9091 @node Sectioning structure, Tables in LaTeX export, Quoting LaTeX code, LaTeX and PDF export
9092 @subsection Sectioning structure
9093 @cindex La@TeX{} class
9094 @cindex La@TeX{} sectioning structure
9096 By default, the La@TeX{} output uses the class @code{article}.
9098 @vindex org-export-latex-default-class
9099 @vindex org-export-latex-classes
9100 @cindex #+LATEX_HEADER
9101 @cindex #+LATEX_CLASS
9102 @cindex property, LATEX_CLASS
9103 You can change this globally by setting a different value for
9104 @code{org-export-latex-default-class} or locally by adding an option like
9105 @code{#+LaTeX_CLASS: myclass} in your file, or with a @code{:LaTeX_CLASS:}
9106 property that applies when exporting a region containing only this (sub)tree.
9107 The class should be listed in @code{org-export-latex-classes}, where you can
9108 also define the sectioning structure for each class, as well as defining
9109 additional classes. You can also use @code{#+LATEX_HEADER:
9110 \usepackage@{xyz@}} to add lines to the header.
9112 @node Tables in LaTeX export, Images in LaTeX export, Sectioning structure, LaTeX and PDF export
9113 @subsection Tables in La@TeX{} export
9114 @cindex tables, in La@TeX{} export
9116 For La@TeX{} export of a table, you can specify a label and a caption
9117 (@pxref{Markup rules}). You can also use the @code{ATTR_LaTeX} line to
9118 request a longtable environment for the table, so that it may span several
9119 pages. Finally, you can set the alignment string:
9123 @cindex #+ATTR_LaTeX
9125 #+CAPTION: A long table
9127 #+ATTR_LaTeX: longtable align=l|lp@{3cm@}r|l
9133 @node Images in LaTeX export, , Tables in LaTeX export, LaTeX and PDF export
9134 @subsection Images in La@TeX{} export
9135 @cindex images, inline in La@TeX{}
9136 @cindex inlining images in La@TeX{}
9138 Images that are linked to without a description part in the link, like
9139 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
9140 output files resulting from La@TeX{} output. Org will use an
9141 @code{\includegraphics} macro to insert the image. If you have specified a
9142 caption and/or a label as described in @ref{Markup rules}, the figure will
9143 be wrapped into a @code{figure} environment and thus become a floating
9144 element. Finally, you can use an @code{#+ATTR_LaTeX:} line to specify the
9145 options that can be used in the optional argument of the
9146 @code{\includegraphics} macro.
9150 @cindex #+ATTR_LaTeX
9152 #+CAPTION: The black-body emission of the disk around HR 4049
9153 #+LABEL: fig:SED-HR4049
9154 #+ATTR_LaTeX: width=5cm,angle=90
9155 [[./img/sed-hr4049.pdf]]
9158 @vindex org-export-latex-inline-image-extensions
9159 If you need references to a label created in this way, write
9160 @samp{\ref@{fig:SED-HR4049@}} just like in La@TeX{}. The default settings will
9161 recognize files types that can be included as images during processing by
9162 @command{pdflatex} (@file{png}, @file{jpg}, and @file{pdf} files). If you process your
9163 files in a different way, you may need to customize the variable
9164 @code{org-export-latex-inline-image-extensions}.
9166 @node DocBook export, XOXO export, LaTeX and PDF export, Exporting
9167 @section DocBook export
9168 @cindex DocBook export
9172 Org contains a DocBook exporter written by Baoqiu Cui. Once an Org file is
9173 exported to DocBook format, it can be further processed to produce other
9174 formats, including PDF, HTML, man pages, etc., using many available DocBook
9175 tools and stylesheets.
9177 Currently DocBook exporter only supports DocBook V5.0.
9180 * DocBook export commands:: How to invoke DocBook export
9181 * Quoting DocBook code:: Incorporating DocBook code in Org files
9182 * Recursive sections:: Recursive sections in DocBook
9183 * Tables in DocBook export:: Tables are exported as HTML tables
9184 * Images in DocBook export:: How to insert figures into DocBook output
9185 * Special characters:: How to handle special characters
9188 @node DocBook export commands, Quoting DocBook code, DocBook export, DocBook export
9189 @subsection DocBook export commands
9191 @cindex region, active
9192 @cindex active region
9193 @cindex transient-mark-mode
9197 @cindex property EXPORT_FILE_NAME
9198 Export as DocBook file. For an Org file, @file{myfile.org}, the DocBook XML
9199 file will be @file{myfile.xml}. The file will be overwritten without
9200 warning. If there is an active region@footnote{This requires
9201 @code{transient-mark-mode} to be turned on}, only the region will be
9202 exported. If the selected region is a single tree@footnote{To select the
9203 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
9204 title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
9205 property, that name will be used for the export.
9208 Export as DocBook file, process to PDF, then open the resulting PDF file.
9210 @vindex org-export-docbook-xslt-proc-command
9211 @vindex org-export-docbook-xsl-fo-proc-command
9212 Note that, in order to produce PDF output based on exported DocBook file, you
9213 need to have XSLT processor and XSL-FO processor software installed on your
9214 system. Check variables @code{org-export-docbook-xslt-proc-command} and
9215 @code{org-export-docbook-xsl-fo-proc-command}.
9219 Export only the visible part of the document.
9222 @node Quoting DocBook code, Recursive sections, DocBook export commands, DocBook export
9223 @subsection Quoting DocBook code
9225 You can quote DocBook code in Org files and copy it verbatim into exported
9226 DocBook file with the following constructs:
9229 @cindex #+BEGIN_DOCBOOK
9231 #+DOCBOOK: Literal DocBook code for export
9235 @cindex #+BEGIN_DOCBOOK
9239 All lines between these markers are exported by DocBook exporter
9244 For example, you can use the following lines to include a DocBook warning
9245 admonition. As to what this warning says, you should pay attention to the
9246 document context when quoting DocBook code in Org files. You may make
9247 exported DocBook XML files invalid by not quoting DocBook code correctly.
9252 <para>You should know what you are doing when quoting DocBook XML code
9253 in your Org file. Invalid DocBook XML file may be generated by
9254 DocBook exporter if you are not careful!</para>
9259 @node Recursive sections, Tables in DocBook export, Quoting DocBook code, DocBook export
9260 @subsection Recursive sections
9261 @cindex DocBook recursive sections
9263 DocBook exporter exports Org files as articles using the @code{article}
9264 element in DocBook. Recursive sections, @ie @code{section} elements, are
9265 used in exported articles. Top level headlines in Org files are exported as
9266 top level sections, and lower level headlines are exported as nested
9267 sections. The entire structure of Org files will be exported completely, no
9268 matter how many nested levels of headlines there are.
9270 Using recursive sections makes it easy to port and reuse exported DocBook
9271 code in other DocBook document types like @code{book} or @code{set}.
9273 @node Tables in DocBook export, Images in DocBook export, Recursive sections, DocBook export
9274 @subsection Tables in DocBook export
9275 @cindex tables, in DocBook export
9277 Tables in Org files are exported as HTML tables, which have been supported since
9280 If a table does not have a caption, an informal table is generated using the
9281 @code{informaltable} element; otherwise, a formal table will be generated
9282 using the @code{table} element.
9284 @node Images in DocBook export, Special characters, Tables in DocBook export, DocBook export
9285 @subsection Images in DocBook export
9286 @cindex images, inline in DocBook
9287 @cindex inlining images in DocBook
9289 Images that are linked to without a description part in the link, like
9290 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]}, will be exported to DocBook
9291 using @code{mediaobject} elements. Each @code{mediaobject} element contains
9292 an @code{imageobject} that wraps an @code{imagedata} element. If you have
9293 specified a caption for an image as described in @ref{Markup rules}, a
9294 @code{caption} element will be added in @code{mediaobject}. If a label is
9295 also specified, it will be exported as an @code{xml:id} attribute of the
9296 @code{mediaobject} element.
9298 @vindex org-export-docbook-default-image-attributes
9299 Image attributes supported by the @code{imagedata} element, like @code{align}
9300 or @code{width}, can be specified in two ways: you can either customize
9301 variable @code{org-export-docbook-default-image-attributes} or use the
9302 @code{#+ATTR_DOCBOOK:} line. Attributes specified in variable
9303 @code{org-export-docbook-default-image-attributes} are applied to all inline
9304 images in the Org file to be exported (unless they are overwritten by image
9305 attributes specified in @code{#+ATTR_DOCBOOK:} lines).
9307 The @code{#+ATTR_DOCBOOK:} line can be used to specify additional image
9308 attributes or overwrite default image attributes for individual images. If
9309 the same attribute appears in both the @code{#+ATTR_DOCBOOK:} line and
9310 variable @code{org-export-docbook-default-image-attributes}, the former
9311 overwrites the latter. Here is an example about how image attributes can be
9316 @cindex #+ATTR_DOCBOOK
9318 #+CAPTION: The logo of Org mode
9319 #+LABEL: unicorn-svg
9320 #+ATTR_DOCBOOK: scalefit="1" width="100%" depth="100%"
9321 [[./img/org-mode-unicorn.svg]]
9324 @vindex org-export-docbook-inline-image-extensions
9325 By default, DocBook exporter recognizes the following image file types:
9326 @file{jpeg}, @file{jpg}, @file{png}, @file{gif}, and @file{svg}. You can
9327 customize variable @code{org-export-docbook-inline-image-extensions} to add
9328 more types to this list as long as DocBook supports them.
9330 @node Special characters, , Images in DocBook export, DocBook export
9331 @subsection Special characters in DocBook export
9332 @cindex Special characters in DocBook export
9334 @vindex org-export-docbook-doctype
9335 @vindex org-html-entities
9336 Special characters that are written in @TeX{}-like syntax, such as @code{\alpha},
9337 @code{\Gamma}, and @code{\Zeta}, are supported by DocBook exporter. These
9338 characters are rewritten to XML entities, like @code{α},
9339 @code{Γ}, and @code{Ζ}, based on the list saved in variable
9340 @code{org-html-entities}. As long as the generated DocBook file includes the
9341 corresponding entities, these special characters are recognized.
9343 You can customize variable @code{org-export-docbook-doctype} to include the
9344 entities you need. For example, you can set variable
9345 @code{org-export-docbook-doctype} to the following value to recognize all
9346 special characters included in XHTML entities:
9349 "<!DOCTYPE article [
9350 <!ENTITY % xhtml1-symbol PUBLIC
9351 \"-//W3C//ENTITIES Symbol for HTML//EN//XML\"
9352 \"http://www.w3.org/2003/entities/2007/xhtml1-symbol.ent\"
9359 @node XOXO export, iCalendar export, DocBook export, Exporting
9360 @section XOXO export
9363 Org mode contains an exporter that produces XOXO-style output.
9364 Currently, this exporter only handles the general outline structure and
9365 does not interpret any additional Org-mode features.
9370 Export as XOXO file @file{myfile.html}.
9373 Export only the visible part of the document.
9376 @node iCalendar export, , XOXO export, Exporting
9377 @section iCalendar export
9378 @cindex iCalendar export
9380 @vindex org-icalendar-include-todo
9381 @vindex org-icalendar-use-deadline
9382 @vindex org-icalendar-use-scheduled
9383 @vindex org-icalendar-categories
9384 Some people use Org mode for keeping track of projects, but still prefer a
9385 standard calendar application for anniversaries and appointments. In this
9386 case it can be useful to show deadlines and other time-stamped items in Org
9387 files in the calendar application. Org mode can export calendar information
9388 in the standard iCalendar format. If you also want to have TODO entries
9389 included in the export, configure the variable
9390 @code{org-icalendar-include-todo}. Plain timestamps are exported as VEVENT,
9391 and TODO items as VTODO. It will also create events from deadlines that are
9392 in non-TODO items. Deadlines and scheduling dates in TODO items will be used
9393 to set the start and due dates for the TODO entry@footnote{See the variables
9394 @code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}.
9395 As categories, it will use the tags locally defined in the heading, and the
9396 file/tree category@footnote{To add inherited tags or the TODO state,
9397 configure the variable @code{org-icalendar-categories}.}.
9399 @vindex org-icalendar-store-UID
9400 @cindex property, ID
9401 The iCalendar standard requires each entry to have a globally unique
9402 identifier (UID). Org creates these identifiers during export. If you set
9403 the variable @code{org-icalendar-store-UID}, the UID will be stored in the
9404 @code{:ID:} property of the entry and re-used next time you report this
9405 entry. Since a single entry can give rise to multiple iCalendar entries (as
9406 a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
9407 prefixes to the UID, depending on what triggered the inclusion of the entry.
9408 In this way the UID remains unique, but a synchronization program can still
9409 figure out from which entry all the different instances originate.
9414 Create iCalendar entries for the current file and store them in the same
9415 directory, using a file extension @file{.ics}.
9418 @vindex org-agenda-files
9419 Like @kbd{C-c C-e i}, but do this for all files in
9420 @code{org-agenda-files}. For each of these files, a separate iCalendar
9421 file will be written.
9424 @vindex org-combined-agenda-icalendar-file
9425 Create a single large iCalendar file from all files in
9426 @code{org-agenda-files} and write it to the file given by
9427 @code{org-combined-agenda-icalendar-file}.
9430 @vindex org-use-property-inheritance
9431 @vindex org-icalendar-include-body
9432 @cindex property, SUMMARY
9433 @cindex property, DESCRIPTION
9434 @cindex property, LOCATION
9435 The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION
9436 property can be inherited from higher in the hierarchy if you configure
9437 @code{org-use-property-inheritance} accordingly.} properties if the selected
9438 entries have them. If not, the summary will be derived from the headline,
9439 and the description from the body (limited to
9440 @code{org-icalendar-include-body} characters).
9442 How this calendar is best read and updated, depends on the application
9443 you are using. The FAQ covers this issue.
9445 @node Publishing, Miscellaneous, Exporting, Top
9448 @cindex O'Toole, David
9450 Org includes a publishing management system that allows you to configure
9451 automatic HTML conversion of @emph{projects} composed of interlinked org
9452 files. You can also configure Org to automatically upload your exported HTML
9453 pages and related attachments, such as images and source code files, to a web
9456 You can also use Org to convert files into PDF, or even combine HTML and PDF
9457 conversion so that files are available in both formats on the server.
9459 Publishing has been contributed to Org by David O'Toole.
9462 * Configuration:: Defining projects
9463 * Uploading files:: How to get files up on the server
9464 * Sample configuration:: Example projects
9465 * Triggering publication:: Publication commands
9468 @node Configuration, Uploading files, Publishing, Publishing
9469 @section Configuration
9471 Publishing needs significant configuration to specify files, destination
9472 and many other properties of a project.
9475 * Project alist:: The central configuration variable
9476 * Sources and destinations:: From here to there
9477 * Selecting files:: What files are part of the project?
9478 * Publishing action:: Setting the function doing the publishing
9479 * Publishing options:: Tweaking HTML export
9480 * Publishing links:: Which links keep working after publishing?
9481 * Project page index:: Publishing a list of project files
9484 @node Project alist, Sources and destinations, Configuration, Configuration
9485 @subsection The variable @code{org-publish-project-alist}
9486 @cindex org-publish-project-alist
9487 @cindex projects, for publishing
9489 @vindex org-publish-project-alist
9490 Publishing is configured almost entirely through setting the value of one
9491 variable, called @code{org-publish-project-alist}. Each element of the list
9492 configures one project, and may be in one of the two following forms:
9495 ("project-name" :property value :property value ...)
9497 ("project-name" :components ("project-name" "project-name" ...))
9501 In both cases, projects are configured by specifying property values. A
9502 project defines the set of files that will be published, as well as the
9503 publishing configuration to use when publishing those files. When a project
9504 takes the second form listed above, the individual members of the
9505 @code{:components} property are taken to be sub-projects, which group
9506 together files requiring different publishing options. When you publish such
9507 a ``meta-project'', all the components will also be published, in the
9510 @node Sources and destinations, Selecting files, Project alist, Configuration
9511 @subsection Sources and destinations for files
9512 @cindex directories, for publishing
9514 Most properties are optional, but some should always be set. In
9515 particular, Org needs to know where to look for source files,
9516 and where to put published files.
9518 @multitable @columnfractions 0.3 0.7
9519 @item @code{:base-directory}
9520 @tab Directory containing publishing source files
9521 @item @code{:publishing-directory}
9522 @tab Directory where output files will be published. You can directly
9523 publish to a webserver using a file name syntax appropriate for
9524 the Emacs @file{tramp} package. Or you can publish to a local directory and
9525 use external tools to upload your website (@pxref{Uploading files}).
9526 @item @code{:preparation-function}
9527 @tab Function called before starting the publishing process, for example, to
9528 run @code{make} for updating files to be published.
9529 @item @code{:completion-function}
9530 @tab Function called after finishing the publishing process, for example, to
9531 change permissions of the resulting files.
9535 @node Selecting files, Publishing action, Sources and destinations, Configuration
9536 @subsection Selecting files
9537 @cindex files, selecting for publishing
9539 By default, all files with extension @file{.org} in the base directory
9540 are considered part of the project. This can be modified by setting the
9542 @multitable @columnfractions 0.25 0.75
9543 @item @code{:base-extension}
9544 @tab Extension (without the dot!) of source files. This actually is a
9545 regular expression. Set this to the symbol @code{any} if you want to get all
9546 files in @code{:base-directory}, even without extension.
9548 @item @code{:exclude}
9549 @tab Regular expression to match file names that should not be
9550 published, even though they have been selected on the basis of their
9553 @item @code{:include}
9554 @tab List of files to be included regardless of @code{:base-extension}
9555 and @code{:exclude}.
9558 @node Publishing action, Publishing options, Selecting files, Configuration
9559 @subsection Publishing action
9560 @cindex action, for publishing
9562 Publishing means that a file is copied to the destination directory and
9563 possibly transformed in the process. The default transformation is to export
9564 Org files as HTML files, and this is done by the function
9565 @code{org-publish-org-to-html} which calls the HTML exporter (@pxref{HTML
9566 export}). But you also can publish your content as PDF files using
9567 @code{org-publish-org-to-pdf}. If you want to publish the Org file itself,
9568 but with @i{archived}, @i{commented}, and @i{tag-excluded} trees removed, use
9569 @code{org-publish-org-to-org} and set the parameters @code{:plain-source}
9570 and/or @code{:htmlized-source}. This will produce @file{file.org} and
9571 @file{file.org.html} in the publishing
9572 directory@footnote{@file{file-source.org} and @file{file-source.org.html} if
9573 source and publishing directories are equal. Note that with this kind of
9574 setup, you need to add @code{:exclude "-source\\.org"} to the project
9575 definition in @code{org-publish-project-alist} to avoid that the published
9576 source files will be considered as new org files the next time the project is
9577 published.}. Other files like images only
9578 need to be copied to the publishing destination, for this you may use
9579 @code{org-publish-attachment}. For non-Org files, you always need to
9580 specify the publishing function:
9582 @multitable @columnfractions 0.3 0.7
9583 @item @code{:publishing-function}
9584 @tab Function executing the publication of a file. This may also be a
9585 list of functions, which will all be called in turn.
9586 @item @code{:plain-source}
9587 @tab Non-nil means, publish plain source.
9588 @item @code{:htmlized-source}
9589 @tab Non-nil means, publish htmlized source.
9592 The function must accept two arguments: a property list containing at least a
9593 @code{:publishing-directory} property, and the name of the file to be
9594 published. It should take the specified file, make the necessary
9595 transformation (if any) and place the result into the destination folder.
9597 @node Publishing options, Publishing links, Publishing action, Configuration
9598 @subsection Options for the HTML/La@TeX{} exporters
9599 @cindex options, for publishing
9601 The property list can be used to set many export options for the HTML
9602 and La@TeX{} exporters. In most cases, these properties correspond to user
9603 variables in Org. The table below lists these properties along
9604 with the variable they belong to. See the documentation string for the
9605 respective variable for details.
9607 @vindex org-export-html-link-up
9608 @vindex org-export-html-link-home
9609 @vindex org-export-default-language
9610 @vindex org-display-custom-times
9611 @vindex org-export-headline-levels
9612 @vindex org-export-with-section-numbers
9613 @vindex org-export-section-number-format
9614 @vindex org-export-with-toc
9615 @vindex org-export-preserve-breaks
9616 @vindex org-export-with-archived-trees
9617 @vindex org-export-with-emphasize
9618 @vindex org-export-with-sub-superscripts
9619 @vindex org-export-with-special-strings
9620 @vindex org-export-with-footnotes
9621 @vindex org-export-with-drawers
9622 @vindex org-export-with-tags
9623 @vindex org-export-with-todo-keywords
9624 @vindex org-export-with-priority
9625 @vindex org-export-with-TeX-macros
9626 @vindex org-export-with-LaTeX-fragments
9627 @vindex org-export-skip-text-before-1st-heading
9628 @vindex org-export-with-fixed-width
9629 @vindex org-export-with-timestamps
9630 @vindex org-export-author-info
9631 @vindex org-export-creator-info
9632 @vindex org-export-with-tables
9633 @vindex org-export-highlight-first-table-line
9634 @vindex org-export-html-style-include-default
9635 @vindex org-export-html-style
9636 @vindex org-export-html-style-extra
9637 @vindex org-export-html-link-org-files-as-html
9638 @vindex org-export-html-inline-images
9639 @vindex org-export-html-extension
9640 @vindex org-export-html-table-tag
9641 @vindex org-export-html-expand
9642 @vindex org-export-html-with-timestamp
9643 @vindex org-export-publishing-directory
9644 @vindex org-export-html-preamble
9645 @vindex org-export-html-postamble
9646 @vindex org-export-html-auto-preamble
9647 @vindex org-export-html-auto-postamble
9648 @vindex user-full-name
9649 @vindex user-mail-address
9650 @vindex org-export-select-tags
9651 @vindex org-export-exclude-tags
9653 @multitable @columnfractions 0.32 0.68
9654 @item @code{:link-up} @tab @code{org-export-html-link-up}
9655 @item @code{:link-home} @tab @code{org-export-html-link-home}
9656 @item @code{:language} @tab @code{org-export-default-language}
9657 @item @code{:customtime} @tab @code{org-display-custom-times}
9658 @item @code{:headline-levels} @tab @code{org-export-headline-levels}
9659 @item @code{:section-numbers} @tab @code{org-export-with-section-numbers}
9660 @item @code{:section-number-format} @tab @code{org-export-section-number-format}
9661 @item @code{:table-of-contents} @tab @code{org-export-with-toc}
9662 @item @code{:preserve-breaks} @tab @code{org-export-preserve-breaks}
9663 @item @code{:archived-trees} @tab @code{org-export-with-archived-trees}
9664 @item @code{:emphasize} @tab @code{org-export-with-emphasize}
9665 @item @code{:sub-superscript} @tab @code{org-export-with-sub-superscripts}
9666 @item @code{:special-strings} @tab @code{org-export-with-special-strings}
9667 @item @code{:footnotes} @tab @code{org-export-with-footnotes}
9668 @item @code{:drawers} @tab @code{org-export-with-drawers}
9669 @item @code{:tags} @tab @code{org-export-with-tags}
9670 @item @code{:todo-keywords} @tab @code{org-export-with-todo-keywords}
9671 @item @code{:priority} @tab @code{org-export-with-priority}
9672 @item @code{:TeX-macros} @tab @code{org-export-with-TeX-macros}
9673 @item @code{:LaTeX-fragments} @tab @code{org-export-with-LaTeX-fragments}
9674 @item @code{:latex-listings} @tab @code{org-export-latex-listings}
9675 @item @code{:skip-before-1st-heading} @tab @code{org-export-skip-text-before-1st-heading}
9676 @item @code{:fixed-width} @tab @code{org-export-with-fixed-width}
9677 @item @code{:timestamps} @tab @code{org-export-with-timestamps}
9678 @item @code{:author-info} @tab @code{org-export-author-info}
9679 @item @code{:creator-info} @tab @code{org-export-creator-info}
9680 @item @code{:tables} @tab @code{org-export-with-tables}
9681 @item @code{:table-auto-headline} @tab @code{org-export-highlight-first-table-line}
9682 @item @code{:style-include-default} @tab @code{org-export-html-style-include-default}
9683 @item @code{:style} @tab @code{org-export-html-style}
9684 @item @code{:style-extra} @tab @code{org-export-html-style-extra}
9685 @item @code{:convert-org-links} @tab @code{org-export-html-link-org-files-as-html}
9686 @item @code{:inline-images} @tab @code{org-export-html-inline-images}
9687 @item @code{:html-extension} @tab @code{org-export-html-extension}
9688 @item @code{:xml-declaration} @tab @code{org-export-html-xml-declaration}
9689 @item @code{:html-table-tag} @tab @code{org-export-html-table-tag}
9690 @item @code{:expand-quoted-html} @tab @code{org-export-html-expand}
9691 @item @code{:timestamp} @tab @code{org-export-html-with-timestamp}
9692 @item @code{:publishing-directory} @tab @code{org-export-publishing-directory}
9693 @item @code{:preamble} @tab @code{org-export-html-preamble}
9694 @item @code{:postamble} @tab @code{org-export-html-postamble}
9695 @item @code{:auto-preamble} @tab @code{org-export-html-auto-preamble}
9696 @item @code{:auto-postamble} @tab @code{org-export-html-auto-postamble}
9697 @item @code{:author} @tab @code{user-full-name}
9698 @item @code{:email} @tab @code{user-mail-address} : @code{addr;addr;..}
9699 @item @code{:select-tags} @tab @code{org-export-select-tags}
9700 @item @code{:exclude-tags} @tab @code{org-export-exclude-tags}
9701 @item @code{:latex-image-options} @tab @code{org-export-latex-image-default-option}
9704 Most of the @code{org-export-with-*} variables have the same effect in
9705 both HTML and La@TeX{} exporters, except for @code{:TeX-macros} and
9706 @code{:LaTeX-fragments}, respectively @code{nil} and @code{t} in the
9709 @vindex org-publish-project-alist
9710 When a property is given a value in @code{org-publish-project-alist},
9711 its setting overrides the value of the corresponding user variable (if
9712 any) during publishing. Options set within a file (@pxref{Export
9713 options}), however, override everything.
9715 @node Publishing links, Project page index, Publishing options, Configuration
9716 @subsection Links between published files
9717 @cindex links, publishing
9719 To create a link from one Org file to another, you would use
9720 something like @samp{[[file:foo.org][The foo]]} or simply
9721 @samp{file:foo.org.} (@pxref{Hyperlinks}). When published, this link
9722 becomes a link to @file{foo.html}. In this way, you can interlink the
9723 pages of your "org web" project and the links will work as expected when
9724 you publish them to HTML. If you also publish the Org source file and want
9725 to link to that, use an @code{http:} link instead of a @code{file:} link,
9726 because @code{file:} links are converted to link to the corresponding
9729 You may also link to related files, such as images. Provided you are careful
9730 with relative file names, and provided you have also configured Org to upload
9731 the related files, these links will work too. See @ref{Complex example}, for
9732 an example of this usage.
9734 Sometimes an Org file to be published may contain links that are
9735 only valid in your production environment, but not in the publishing
9736 location. In this case, use the property
9738 @multitable @columnfractions 0.4 0.6
9739 @item @code{:link-validation-function}
9740 @tab Function to validate links
9744 to define a function for checking link validity. This function must
9745 accept two arguments, the file name and a directory relative to which
9746 the file name is interpreted in the production environment. If this
9747 function returns @code{nil}, then the HTML generator will only insert a
9748 description into the HTML file, but no link. One option for this
9749 function is @code{org-publish-validate-link} which checks if the given
9750 file is part of any project in @code{org-publish-project-alist}.
9752 @node Project page index, , Publishing links, Configuration
9753 @subsection Project page index
9754 @cindex index, of published pages
9756 The following properties may be used to control publishing of an
9757 index of files or a summary page for a given project.
9759 @multitable @columnfractions 0.25 0.75
9760 @item @code{:auto-index}
9761 @tab When non-nil, publish an index during @code{org-publish-current-project}
9762 or @code{org-publish-all}.
9764 @item @code{:index-filename}
9765 @tab Filename for output of index. Defaults to @file{sitemap.org} (which
9766 becomes @file{sitemap.html}).
9768 @item @code{:index-title}
9769 @tab Title of index page. Defaults to name of file.
9771 @item @code{:index-function}
9772 @tab Plug-in function to use for generation of index.
9773 Defaults to @code{org-publish-org-index}, which generates a plain list
9774 of links to all files in the project.
9777 @node Uploading files, Sample configuration, Configuration, Publishing
9778 @section Uploading files
9782 For those people already utilizing third party sync tools such as
9783 @command{rsync} or @command{unison}, it might be preferable not to use the built in
9784 @i{remote} publishing facilities of Org mode which rely heavily on
9785 Tramp. Tramp, while very useful and powerful, tends not to be
9786 so efficient for multiple file transfer and has been known to cause problems
9789 Specialized synchronization utilities offer several advantages. In addition
9790 to timestamp comparison, they also do content and permissions/attribute
9791 checks. For this reason you might prefer to publish your web to a local
9792 directory (possibly even @i{in place} with your Org files) and then use
9793 @file{unison} or @file{rsync} to do the synchronization with the remote host.
9795 Since Unison (for example) can be configured as to which files to transfer to
9796 a certain remote destination, it can greatly simplify the project publishing
9797 definition. Simply keep all files in the correct location, process your Org
9798 files with @code{org-publish} and let the synchronization tool do the rest.
9799 You do not need, in this scenario, to include attachments such as @file{jpg},
9800 @file{css} or @file{gif} files in the project definition since the 3rd party
9803 Publishing to a local directory is also much faster than to a remote one, so
9804 that you can afford more easily to republish entire projects. If you set
9805 @code{org-publish-use-timestamps-flag} to @code{nil}, you gain the main
9806 benefit of re-including any changed external files such as source example
9807 files you might include with @code{#+INCLUDE}. The timestamp mechanism in
9808 Org is not smart enough to detect if included files have been modified.
9810 @node Sample configuration, Triggering publication, Uploading files, Publishing
9811 @section Sample configuration
9813 Below we provide two example configurations. The first one is a simple
9814 project publishing only a set of Org files. The second example is
9815 more complex, with a multi-component project.
9818 * Simple example:: One-component publishing
9819 * Complex example:: A multi-component publishing example
9822 @node Simple example, Complex example, Sample configuration, Sample configuration
9823 @subsection Example: simple publishing configuration
9825 This example publishes a set of Org files to the @file{public_html}
9826 directory on the local machine.
9829 (setq org-publish-project-alist
9831 :base-directory "~/org/"
9832 :publishing-directory "~/public_html"
9833 :section-numbers nil
9834 :table-of-contents nil
9835 :style "<link rel=\"stylesheet\"
9836 href=\"../other/mystyle.css\"
9837 type=\"text/css\"/>")))
9840 @node Complex example, , Simple example, Sample configuration
9841 @subsection Example: complex publishing configuration
9843 This more complicated example publishes an entire website, including
9844 Org files converted to HTML, image files, Emacs Lisp source code, and
9845 style sheets. The publishing directory is remote and private files are
9848 To ensure that links are preserved, care should be taken to replicate
9849 your directory structure on the web server, and to use relative file
9850 paths. For example, if your Org files are kept in @file{~/org} and your
9851 publishable images in @file{~/images}, you'd link to an image with
9854 file:../images/myimage.png
9857 On the web server, the relative path to the image should be the
9858 same. You can accomplish this by setting up an "images" folder in the
9859 right place on the web server, and publishing images to it.
9862 (setq org-publish-project-alist
9864 :base-directory "~/org/"
9865 :base-extension "org"
9866 :publishing-directory "/ssh:user@@host:~/html/notebook/"
9867 :publishing-function org-publish-org-to-html
9868 :exclude "PrivatePage.org" ;; regexp
9870 :section-numbers nil
9871 :table-of-contents nil
9872 :style "<link rel=\"stylesheet\"
9873 href=\"../other/mystyle.css\" type=\"text/css\"/>"
9875 :auto-postamble nil)
9878 :base-directory "~/images/"
9879 :base-extension "jpg\\|gif\\|png"
9880 :publishing-directory "/ssh:user@@host:~/html/images/"
9881 :publishing-function org-publish-attachment)
9884 :base-directory "~/other/"
9885 :base-extension "css\\|el"
9886 :publishing-directory "/ssh:user@@host:~/html/other/"
9887 :publishing-function org-publish-attachment)
9888 ("website" :components ("orgfiles" "images" "other"))))
9891 @node Triggering publication, , Sample configuration, Publishing
9892 @section Triggering publication
9894 Once properly configured, Org can publish with the following commands:
9899 Prompt for a specific project and publish all files that belong to it.
9902 Publish the project containing the current file.
9905 Publish only the current file.
9908 Publish every project.
9911 @vindex org-publish-use-timestamps-flag
9912 Org uses timestamps to track when a file has changed. The above functions
9913 normally only publish changed files. You can override this and force
9914 publishing of all files by giving a prefix argument to any of the commands
9915 above, or by customizing the variable @code{org-publish-use-timestamps-flag}.
9916 This may be necessary in particular if files include other files via
9917 @code{#+SETUPFILE:} or @code{#+INCLUDE:}.
9919 @node Miscellaneous, Hacking, Publishing, Top
9920 @chapter Miscellaneous
9923 * Completion:: M-TAB knows what you need
9924 * Customization:: Adapting Org to your taste
9925 * In-buffer settings:: Overview of the #+KEYWORDS
9926 * The very busy C-c C-c key:: When in doubt, press C-c C-c
9927 * Clean view:: Getting rid of leading stars in the outline
9928 * TTY keys:: Using Org on a tty
9929 * Interaction:: Other Emacs packages
9933 @node Completion, Customization, Miscellaneous, Miscellaneous
9935 @cindex completion, of @TeX{} symbols
9936 @cindex completion, of TODO keywords
9937 @cindex completion, of dictionary words
9938 @cindex completion, of option keywords
9939 @cindex completion, of tags
9940 @cindex completion, of property keys
9941 @cindex completion, of link abbreviations
9942 @cindex @TeX{} symbol completion
9943 @cindex TODO keywords completion
9944 @cindex dictionary word completion
9945 @cindex option keyword completion
9946 @cindex tag completion
9947 @cindex link abbreviations, completion of
9949 Emacs would not be Emacs without completion, and Org-mode uses it whenever it
9950 makes sense. If you prefer an @i{iswitchb}- or @i{ido}-like interface for
9951 some of the completion prompts, you can specify your preferece by setting at
9952 most one of the variables @code{org-completion-use-iswitchb}
9953 @code{org-completion-use-ido}.
9955 Org supports in-buffer completion. This type of completion does
9956 not make use of the minibuffer. You simply type a few letters into
9957 the buffer and use the key to complete text right there.
9962 Complete word at point
9965 At the beginning of a headline, complete TODO keywords.
9967 After @samp{\}, complete @TeX{} symbols supported by the exporter.
9969 After @samp{*}, complete headlines in the current buffer so that they
9970 can be used in search links like @samp{[[*find this headline]]}.
9972 After @samp{:} in a headline, complete tags. The list of tags is taken
9973 from the variable @code{org-tag-alist} (possibly set through the
9974 @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
9975 dynamically from all tags used in the current buffer.
9977 After @samp{:} and not in a headline, complete property keys. The list
9978 of keys is constructed dynamically from all keys used in the current
9981 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
9983 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
9984 @samp{OPTIONS} which set file-specific options for Org mode. When the
9985 option keyword is already complete, pressing @kbd{M-@key{TAB}} again
9986 will insert example settings for this keyword.
9988 In the line after @samp{#+STARTUP: }, complete startup keywords,
9989 @ie valid keys for this line.
9991 Elsewhere, complete dictionary words using Ispell.
9995 @node Customization, In-buffer settings, Completion, Miscellaneous
9996 @section Customization
9997 @cindex customization
9998 @cindex options, for customization
9999 @cindex variables, for customization
10001 There are more than 180 variables that can be used to customize
10002 Org. For the sake of compactness of the manual, I am not
10003 describing the variables here. A structured overview of customization
10004 variables is available with @kbd{M-x org-customize}. Or select
10005 @code{Browse Org Group} from the @code{Org->Customization} menu. Many
10006 settings can also be activated on a per-file basis, by putting special
10007 lines into the buffer (@pxref{In-buffer settings}).
10009 @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous
10010 @section Summary of in-buffer settings
10011 @cindex in-buffer settings
10012 @cindex special keywords
10014 Org mode uses special lines in the buffer to define settings on a
10015 per-file basis. These lines start with a @samp{#+} followed by a
10016 keyword, a colon, and then individual words defining a setting. Several
10017 setting words can be in the same line, but you can also have multiple
10018 lines for the keyword. While these settings are described throughout
10019 the manual, here is a summary. After changing any of those lines in the
10020 buffer, press @kbd{C-c C-c} with the cursor still in the line to
10021 activate the changes immediately. Otherwise they become effective only
10022 when the file is visited again in a new Emacs session.
10024 @vindex org-archive-location
10026 @item #+ARCHIVE: %s_done::
10027 This line sets the archive location for the agenda file. It applies for
10028 all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
10029 of the file. The first such line also applies to any entries before it.
10030 The corresponding variable is @code{org-archive-location}.
10032 This line sets the category for the agenda file. The category applies
10033 for all subsequent lines until the next @samp{#+CATEGORY} line, or the
10034 end of the file. The first such line also applies to any entries before it.
10035 @item #+COLUMNS: %25ITEM .....
10036 @cindex property, COLUMNS
10037 Set the default format for columns view. This format applies when
10038 columns view is invoked in locations where no @code{COLUMNS} property
10040 @item #+CONSTANTS: name1=value1 ...
10041 @vindex org-table-formula-constants
10042 @vindex org-table-formula
10043 Set file-local values for constants to be used in table formulas. This
10044 line set the local variable @code{org-table-formula-constants-local}.
10045 The global version of this variable is
10046 @code{org-table-formula-constants}.
10047 @item #+FILETAGS: :tag1:tag2:tag3:
10048 Set tags that can be inherited by any entry in the file, including the
10050 @item #+DRAWERS: NAME1 .....
10051 @vindex org-drawers
10052 Set the file-local set of drawers. The corresponding global variable is
10053 @code{org-drawers}.
10054 @item #+LINK: linkword replace
10055 @vindex org-link-abbrev-alist
10056 These lines (several are allowed) specify link abbreviations.
10057 @xref{Link abbreviations}. The corresponding variable is
10058 @code{org-link-abbrev-alist}.
10059 @item #+PRIORITIES: highest lowest default
10060 @vindex org-highest-priority
10061 @vindex org-lowest-priority
10062 @vindex org-default-priority
10063 This line sets the limits and the default for the priorities. All three
10064 must be either letters A-Z or numbers 0-9. The highest priority must
10065 have a lower ASCII number that the lowest priority.
10066 @item #+PROPERTY: Property_Name Value
10067 This line sets a default inheritance value for entries in the current
10068 buffer, most useful for specifying the allowed values of a property.
10069 @cindex #+SETUPFILE
10070 @item #+SETUPFILE: file
10071 This line defines a file that holds more in-buffer setup. Normally this is
10072 entirely ignored. Only when the buffer is parsed for option-setting lines
10073 (@ie when starting Org mode for a file, when pressing @kbd{C-c C-c} in a
10074 settings line, or when exporting), then the contents of this file are parsed
10075 as if they had been included in the buffer. In particular, the file can be
10076 any other Org mode file with internal setup. You can visit the file the
10077 cursor is in the line with @kbd{C-c '}.
10080 This line sets options to be used at startup of Org mode, when an
10081 Org file is being visited.
10083 The first set of options deals with the initial visibility of the outline
10084 tree. The corresponding variable for global default settings is
10085 @code{org-startup-folded}, with a default value @code{t}, which means
10087 @vindex org-startup-folded
10088 @cindex @code{overview}, STARTUP keyword
10089 @cindex @code{content}, STARTUP keyword
10090 @cindex @code{showall}, STARTUP keyword
10092 overview @r{top-level headlines only}
10093 content @r{all headlines}
10094 showall @r{no folding at all, show everything}
10097 @vindex org-startup-indented
10098 @cindex @code{indent}, STARTUP keyword
10099 @cindex @code{noindent}, STARTUP keyword
10100 Dynamic virtual indentation is controlled by the variable
10101 @code{org-startup-indented}@footnote{Emacs 23 and Org-mode 6.29 are required}
10103 indent @r{start with @code{org-indent-mode} turned on}
10104 noindent @r{start with @code{org-indent-mode} turned off}
10107 @vindex org-startup-align-all-tables
10108 Then there are options for aligning tables upon visiting a file. This
10109 is useful in files containing narrowed table columns. The corresponding
10110 variable is @code{org-startup-align-all-tables}, with a default value
10112 @cindex @code{align}, STARTUP keyword
10113 @cindex @code{noalign}, STARTUP keyword
10115 align @r{align all tables}
10116 noalign @r{don't align tables on startup}
10118 @vindex org-log-done
10119 @vindex org-log-note-clock-out
10120 @vindex org-log-repeat
10121 Logging the closing and reopening of TODO items and clock intervals can be
10122 configured using these options (see variables @code{org-log-done},
10123 @code{org-log-note-clock-out} and @code{org-log-repeat})
10124 @cindex @code{logdone}, STARTUP keyword
10125 @cindex @code{lognotedone}, STARTUP keyword
10126 @cindex @code{nologdone}, STARTUP keyword
10127 @cindex @code{lognoteclock-out}, STARTUP keyword
10128 @cindex @code{nolognoteclock-out}, STARTUP keyword
10129 @cindex @code{logrepeat}, STARTUP keyword
10130 @cindex @code{lognoterepeat}, STARTUP keyword
10131 @cindex @code{nologrepeat}, STARTUP keyword
10133 logdone @r{record a timestamp when an item is marked DONE}
10134 lognotedone @r{record timestamp and a note when DONE}
10135 nologdone @r{don't record when items are marked DONE}
10136 logrepeat @r{record a time when reinstating a repeating item}
10137 lognoterepeat @r{record a note when reinstating a repeating item}
10138 nologrepeat @r{do not record when reinstating repeating item}
10139 lognoteclock-out @r{record a note when clocking out}
10140 nolognoteclock-out @r{don't record a note when clocking out}
10142 @vindex org-hide-leading-stars
10143 @vindex org-odd-levels-only
10144 Here are the options for hiding leading stars in outline headings, and for
10145 indenting outlines. The corresponding variables are
10146 @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
10147 default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
10148 @cindex @code{hidestars}, STARTUP keyword
10149 @cindex @code{showstars}, STARTUP keyword
10150 @cindex @code{odd}, STARTUP keyword
10151 @cindex @code{even}, STARTUP keyword
10153 hidestars @r{make all but one of the stars starting a headline invisible.}
10154 showstars @r{show all stars starting a headline}
10155 indent @r{virtual indentation according to outline level}
10156 noindent @r{no virtual indentation according to outline level}
10157 odd @r{allow only odd outline levels (1,3,...)}
10158 oddeven @r{allow all outline levels}
10160 @vindex org-put-time-stamp-overlays
10161 @vindex org-time-stamp-overlay-formats
10162 To turn on custom format overlays over timestamps (variables
10163 @code{org-put-time-stamp-overlays} and
10164 @code{org-time-stamp-overlay-formats}), use
10165 @cindex @code{customtime}, STARTUP keyword
10167 customtime @r{overlay custom time format}
10169 @vindex constants-unit-system
10170 The following options influence the table spreadsheet (variable
10171 @code{constants-unit-system}).
10172 @cindex @code{constcgs}, STARTUP keyword
10173 @cindex @code{constSI}, STARTUP keyword
10175 constcgs @r{@file{constants.el} should use the c-g-s unit system}
10176 constSI @r{@file{constants.el} should use the SI unit system}
10178 @vindex org-footnote-define-inline
10179 @vindex org-footnote-auto-label
10180 @vindex org-footnote-auto-adjust
10181 To influence footnote settings, use the following keywords. The
10182 corresponding variables are @code{org-footnote-define-inline},
10183 @code{org-footnote-auto-label}, and @code{org-footnote-auto-adjust}.
10184 @cindex @code{fninline}, STARTUP keyword
10185 @cindex @code{nofninline}, STARTUP keyword
10186 @cindex @code{fnlocal}, STARTUP keyword
10187 @cindex @code{fnprompt}, STARTUP keyword
10188 @cindex @code{fnauto}, STARTUP keyword
10189 @cindex @code{fnconfirm}, STARTUP keyword
10190 @cindex @code{fnplain}, STARTUP keyword
10191 @cindex @code{fnadjust}, STARTUP keyword
10192 @cindex @code{nofnadjust}, STARTUP keyword
10194 fninline @r{define footnotes inline}
10195 fnnoinline @r{define footnotes in separate section}
10196 fnlocal @r{define footnotes near first reference, but not inline}
10197 fnprompt @r{prompt for footnote labels}
10198 fnauto @r{create [fn:1]-like labels automatically (default)}
10199 fnconfirm @r{offer automatic label for editing or confirmation}
10200 fnplain @r{create [1]-like labels automatically}
10201 fnadjust @r{automatically renumber and sort footnotes}
10202 nofnadjust @r{do not renumber and sort automatically}
10204 @cindex org-hide-block-startup
10205 To hide blocks on startup, use these keywords. The corresponding variable is
10206 @code{org-hide-block-startup}.
10207 @cindex @code{hideblocks}, STARTUP keyword
10208 @cindex @code{nohideblocks}, STARTUP keyword
10210 hideblocks @r{Hide all begin/end blocks on startup}
10211 nohideblocks @r{Do not hide blocks on startup}
10213 @item #+TAGS: TAG1(c1) TAG2(c2)
10214 @vindex org-tag-alist
10215 These lines (several such lines are allowed) specify the valid tags in
10216 this file, and (potentially) the corresponding @emph{fast tag selection}
10217 keys. The corresponding variable is @code{org-tag-alist}.
10219 This line contains the formulas for the table directly above the line.
10220 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+DATE:,
10221 @itemx #+OPTIONS:, #+BIND:
10222 @itemx #+DESCRIPTION:, #+KEYWORDS:
10223 @itemx #+LATEX_HEADER:, #+STYLE:, #+LINK_UP:, #+LINK_HOME:,
10224 @itemx #+EXPORT_SELECT_TAGS:, #+EXPORT_EXCLUDE_TAGS:
10225 These lines provide settings for exporting files. For more details see
10226 @ref{Export options}.
10227 @item #+TODO: #+SEQ_TODO: #+TYP_TODO:
10228 @vindex org-todo-keywords
10229 These lines set the TODO keywords and their interpretation in the
10230 current file. The corresponding variable is @code{org-todo-keywords}.
10233 @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous
10234 @section The very busy C-c C-c key
10236 @cindex C-c C-c, overview
10238 The key @kbd{C-c C-c} has many purposes in Org, which are all
10239 mentioned scattered throughout this manual. One specific function of
10240 this key is to add @emph{tags} to a headline (@pxref{Tags}). In many
10241 other circumstances it means something like @emph{``Hey Org, look
10242 here and update according to what you see here''}. Here is a summary of
10243 what this means in different contexts.
10247 If there are highlights in the buffer from the creation of a sparse
10248 tree, or from clock display, remove these highlights.
10250 If the cursor is in one of the special @code{#+KEYWORD} lines, this
10251 triggers scanning the buffer for these lines and updating the
10254 If the cursor is inside a table, realign the table. This command
10255 works even if the automatic table editor has been turned off.
10257 If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
10260 If the cursor is inside a table created by the @file{table.el} package,
10261 activate that table.
10263 If the current buffer is a Remember buffer, close the note and file it.
10264 With a prefix argument, file it, without further interaction, to the
10267 If the cursor is on a @code{<<<target>>>}, update radio targets and
10268 corresponding links in this buffer.
10270 If the cursor is in a property line or at the start or end of a property
10271 drawer, offer property commands.
10273 If the cursor is at a footnote reference, go to the corresponding
10274 definition, and vice versa.
10276 If the cursor is in a plain list item with a checkbox, toggle the status
10279 If the cursor is on a numbered item in a plain list, renumber the
10282 If the cursor is on the @code{#+BEGIN} line of a dynamic block, the
10286 @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous
10287 @section A cleaner outline view
10288 @cindex hiding leading stars
10289 @cindex dynamic indentation
10290 @cindex odd-levels-only outlines
10291 @cindex clean outline view
10293 Some people find it noisy and distracting that the Org headlines start with a
10294 potentially large number of stars, and that text below the headlines is not
10295 indented. While this is no problem when writing a book where the outline
10296 headings are really section headlines, in a more list-oriented outline,
10297 indented structure is a lot cleaner:
10301 * Top level headline | * Top level headline
10302 ** Second level | * Second level
10303 *** 3rd level | * 3rd level
10304 some text | some text
10305 *** 3rd level | * 3rd level
10306 more text | more text
10307 * Another top level headline | * Another top level headline
10312 If you are using Emacs 23 and at least version 6.29 of Org, this kind of view
10313 can be achieved dynamically at display time using @code{org-indent-mode}. In
10314 this minor mode, all lines are prefixed for display with the necessary amount
10315 of space. Also headlines are prefixed with additional stars, so that the
10316 amount of indentation shifts by two@footnote{See the variable
10317 @code{org-indent-indentation-per-level}.} spaces per level. All headline
10318 stars but the last one are made invisible using the @code{org-hide}
10319 face@footnote{Turning on @code{org-indent-mode} sets
10320 @code{org-hide-leading-stars} to @code{t} and @code{org-adapt-indentation} to
10321 @code{nil}.} - see below under @samp{2.} for more information on how this
10322 works. You can turn on @code{org-indent-mode} for all files by customizing
10323 the variable @code{org-startup-indented}, or you can turn it on for
10324 individual files using
10330 If you want a similar effect in earlier version of Emacs and/or Org, or if
10331 you want the indentation to be hard space characters so that the plain text
10332 file looks as similar as possible to the Emacs display, Org supports you in
10337 @emph{Indentation of text below headlines}@*
10338 You may indent text below each headline to make the left boundary line up
10339 with the headline, like
10343 more text, now indented
10346 @vindex org-adapt-indentation
10347 Org supports this with paragraph filling, line wrapping, and structure
10348 editing@footnote{See also the variable @code{org-adapt-indentation}.},
10349 preserving or adapting the indentation as appropriate.
10352 @vindex org-hide-leading-stars
10353 @emph{Hiding leading stars}@* You can modify the display in such a way that
10354 all leading stars become invisible. To do this in a global way, configure
10355 the variable @code{org-hide-leading-stars} or change this on a per-file basis
10359 #+STARTUP: hidestars
10360 #+STARTUP: showstars
10363 With hidden stars, the tree becomes:
10367 * Top level headline
10375 @vindex org-hide @r{(face)}
10376 The leading stars are not truly replaced by whitespace, they are only
10377 fontified with the face @code{org-hide} that uses the background color as
10378 font color. If you are not using either white or black background, you may
10379 have to customize this face to get the wanted effect. Another possibility is
10380 to set this font such that the extra stars are @i{almost} invisible, for
10381 example using the color @code{grey90} on a white background.
10384 @vindex org-odd-levels-only
10385 Things become cleaner still if you skip all the even levels and use only odd
10386 levels 1, 3, 5..., effectively adding two stars to go from one outline level
10387 to the next@footnote{When you need to specify a level for a property search
10388 or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc@.}. In this
10389 way we get the outline view shown at the beginning of this section. In order
10390 to make the structure editing and export commands handle this convention
10391 correctly, configure the variable @code{org-odd-levels-only}, or set this on
10392 a per-file basis with one of the following lines:
10399 You can convert an Org file from single-star-per-level to the
10400 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
10401 RET} in that file. The reverse operation is @kbd{M-x
10402 org-convert-to-oddeven-levels}.
10405 @node TTY keys, Interaction, Clean view, Miscellaneous
10406 @section Using Org on a tty
10407 @cindex tty key bindings
10409 Because Org contains a large number of commands, by default many of
10410 Org's core commands are bound to keys that are generally not
10411 accessible on a tty, such as the cursor keys (@key{left}, @key{right},
10412 @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
10413 together with modifiers like @key{Meta} and/or @key{Shift}. To access
10414 these commands on a tty when special keys are unavailable, the following
10415 alternative bindings can be used. The tty bindings below will likely be
10416 more cumbersome; you may find for some of the bindings below that a
10417 customized workaround suits you better. For example, changing a timestamp
10418 is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
10419 tty you would rather use @kbd{C-c .} to re-insert the timestamp.
10421 @multitable @columnfractions 0.15 0.2 0.2
10422 @item @b{Default} @tab @b{Alternative 1} @tab @b{Alternative 2}
10423 @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab
10424 @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{@key{Esc} @key{left}}
10425 @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab
10426 @item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{@key{Esc} @key{right}}
10427 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab
10428 @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{@key{Esc} @key{up}}
10429 @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab
10430 @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{@key{Esc} @key{down}}
10431 @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab
10432 @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab
10433 @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{@key{Esc} @key{RET}}
10434 @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab
10435 @item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab
10436 @item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab
10437 @item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab
10438 @item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab
10439 @item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab
10440 @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab
10444 @node Interaction, , TTY keys, Miscellaneous
10445 @section Interaction with other packages
10446 @cindex packages, interaction with other
10447 Org lives in the world of GNU Emacs and interacts in various ways
10448 with other code out there.
10451 * Cooperation:: Packages Org cooperates with
10452 * Conflicts:: Packages that lead to conflicts
10455 @node Cooperation, Conflicts, Interaction, Interaction
10456 @subsection Packages that Org cooperates with
10459 @cindex @file{calc.el}
10460 @cindex Gillespie, Dave
10461 @item @file{calc.el} by Dave Gillespie
10462 Org uses the Calc package for implementing spreadsheet
10463 functionality in its tables (@pxref{The spreadsheet}). Org
10464 checks for the availability of Calc by looking for the function
10465 @code{calc-eval} which will have been autoloaded during setup if Calc has
10466 been installed properly. As of Emacs 22, Calc is part of the Emacs
10467 distribution. Another possibility for interaction between the two
10468 packages is using Calc for embedded calculations. @xref{Embedded Mode,
10469 , Embedded Mode, Calc, GNU Emacs Calc Manual}.
10470 @item @file{constants.el} by Carsten Dominik
10471 @cindex @file{constants.el}
10472 @cindex Dominik, Carsten
10473 @vindex org-table-formula-constants
10474 In a table formula (@pxref{The spreadsheet}), it is possible to use
10475 names for natural constants or units. Instead of defining your own
10476 constants in the variable @code{org-table-formula-constants}, install
10477 the @file{constants} package which defines a large number of constants
10478 and units, and lets you use unit prefixes like @samp{M} for
10479 @samp{Mega}, etc@. You will need version 2.0 of this package, available
10480 at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for
10481 the function @code{constants-get}, which has to be autoloaded in your
10482 setup. See the installation instructions in the file
10483 @file{constants.el}.
10484 @item @file{cdlatex.el} by Carsten Dominik
10485 @cindex @file{cdlatex.el}
10486 @cindex Dominik, Carsten
10487 Org mode can make use of the CDLa@TeX{} package to efficiently enter
10488 La@TeX{} fragments into Org files. See @ref{CDLaTeX mode}.
10489 @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
10490 @cindex @file{imenu.el}
10491 Imenu allows menu access to an index of items in a file. Org mode
10492 supports Imenu---all you need to do to get the index is the following:
10494 (add-hook 'org-mode-hook
10495 (lambda () (imenu-add-to-menubar "Imenu")))
10497 @vindex org-imenu-depth
10498 By default the index is two levels deep---you can modify the depth using
10499 the option @code{org-imenu-depth}.
10500 @item @file{remember.el} by John Wiegley
10501 @cindex @file{remember.el}
10502 @cindex Wiegley, John
10503 Org cooperates with remember, see @ref{Remember}.
10504 @file{Remember.el} is not part of Emacs, find it on the web.
10505 @item @file{speedbar.el} by Eric M. Ludlam
10506 @cindex @file{speedbar.el}
10507 @cindex Ludlam, Eric M.
10508 Speedbar is a package that creates a special frame displaying files and
10509 index items in files. Org mode supports Speedbar and allows you to
10510 drill into Org files directly from the Speedbar. It also allows you to
10511 restrict the scope of agenda commands to a file or a subtree by using
10512 the command @kbd{<} in the Speedbar frame.
10513 @cindex @file{table.el}
10514 @item @file{table.el} by Takaaki Ota
10516 @cindex table editor, @file{table.el}
10517 @cindex @file{table.el}
10518 @cindex Ota, Takaaki
10520 Complex ASCII tables with automatic line wrapping, column- and
10521 row-spanning, and alignment can be created using the Emacs table
10522 package by Takaaki Ota (@uref{http://sourceforge.net/projects/table},
10523 and also part of Emacs 22).
10524 When @key{TAB} or @kbd{C-c C-c} is pressed in such a table, Org mode
10525 will call @command{table-recognize-table} and move the cursor into the
10526 table. Inside a table, the keymap of Org mode is inactive. In order
10527 to execute Org mode-related commands, leave the table.
10532 Recognize @file{table.el} table. Works when the cursor is in a
10537 Insert a @file{table.el} table. If there is already a table at point, this
10538 command converts it between the @file{table.el} format and the Org-mode
10539 format. See the documentation string of the command
10540 @code{org-convert-table} for the restrictions under which this is
10543 @file{table.el} is part of Emacs 22.
10544 @item @file{footnote.el} by Steven L. Baur
10545 @cindex @file{footnote.el}
10546 @cindex Baur, Steven L.
10547 Org mode recognizes numerical footnotes as provided by this package.
10548 However, Org mode also has its own footnote support (@pxref{Footnotes}),
10549 which makes using @file{footnote.el} unnecessary.
10552 @node Conflicts, , Cooperation, Interaction
10553 @subsection Packages that lead to conflicts with Org mode
10557 @cindex @code{shift-selection-mode}
10558 @vindex org-support-shift-select
10559 In Emacs 23, @code{shift-selection-mode} is on by default, meaning that
10560 cursor motions combined with the shift key should start or enlarge regions.
10561 This conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change
10562 timestamps, TODO keywords, priorities, and item bullet types if the cursor is
10563 at such a location. By default, @kbd{S-@key{cursor}} commands outside
10564 special contexts don't do anything, but you can customize the variable
10565 @code{org-support-shift-select}. Org mode then tries to accommodate shift
10566 selection by (i) using it outside of the special contexts where special
10567 commands apply, and by (ii) extending an existing active region even if the
10568 cursor moves across a special context.
10570 @item @file{CUA.el} by Kim. F. Storm
10571 @cindex @file{CUA.el}
10572 @cindex Storm, Kim. F.
10573 @vindex org-replace-disputed-keys
10574 Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by CUA mode
10575 (as well as @code{pc-select-mode} and @code{s-region-mode}) to select and extend the
10576 region. In fact, Emacs 23 has this built-in in the form of
10577 @code{shift-selection-mode}, see previous paragraph. If you are using Emacs
10578 23, you probably don't want to use another package for this purpose. However,
10579 if you prefer to leave these keys to a different package while working in
10580 Org mode, configure the variable @code{org-replace-disputed-keys}. When set,
10581 Org will move the following key bindings in Org files, and in the agenda
10582 buffer (but not during date selection).
10585 S-UP -> M-p S-DOWN -> M-n
10586 S-LEFT -> M-- S-RIGHT -> M-+
10587 C-S-LEFT -> M-S-- C-S-RIGHT -> M-S-+
10590 @vindex org-disputed-keys
10591 Yes, these are unfortunately more difficult to remember. If you want
10592 to have other replacement keys, look at the variable
10593 @code{org-disputed-keys}.
10595 @item @file{yasnippet.el}
10596 @cindex @file{yasnippet.el}
10597 The way Org-mode binds the TAB key (binding to @code{[tab]} instead of
10598 @code{"\t"}) overrules yasnippets' access to this key. The following code
10599 fixed this problem:
10602 (add-hook 'org-mode-hook
10604 (org-set-local 'yas/trigger-key [tab])
10605 (define-key yas/keymap [tab] 'yas/next-field-group)))
10608 @item @file{windmove.el} by Hovav Shacham
10609 @cindex @file{windmove.el}
10610 This package also uses the @kbd{S-<cursor>} keys, so everything written
10611 in the paragraph above about CUA mode also applies here.
10615 @node Hacking, History and Acknowledgments, Miscellaneous, Top
10619 This appendix covers some aspects where users can extend the functionality of
10623 * Hooks:: Who to reach into Org's internals
10624 * Add-on packages:: Available extensions
10625 * Adding hyperlink types:: New custom link types
10626 * Context-sensitive commands:: How to add functionality to such commands
10627 * Tables in arbitrary syntax:: Orgtbl for La@TeX{} and other programs
10628 * Dynamic blocks:: Automatically filled blocks
10629 * Special agenda views:: Customized views
10630 * Extracting agenda information:: Postprocessing of agenda information
10631 * Using the property API:: Writing programs that use entry properties
10632 * Using the mapping API:: Mapping over all or selected entries
10635 @node Hooks, Add-on packages, Hacking, Hacking
10639 Org has a large number of hook variables that can be used to add
10640 functionality. This appendix about hacking is going to illustrate the
10641 use of some of them. A complete list of all hooks with documentation is
10642 maintained by the Worg project and can be found at
10643 @uref{http://orgmode.org/worg/org-configs/org-hooks.php}.
10645 @node Add-on packages, Adding hyperlink types, Hooks, Hacking
10646 @section Add-on packages
10647 @cindex add-on packages
10649 A large number of add-on packages have been written by various authors.
10650 These packages are not part of Emacs, but they are distributed as contributed
10651 packages with the separate release available at the Org mode home page at
10652 @uref{http://orgmode.org}. The list of contributed packages, along with
10653 documentation about each package, is maintained by the Worg project at
10654 @uref{http://orgmode.org/worg/org-contrib/}.
10658 @node Adding hyperlink types, Context-sensitive commands, Add-on packages, Hacking
10659 @section Adding hyperlink types
10660 @cindex hyperlinks, adding new types
10662 Org has a large number of hyperlink types built-in
10663 (@pxref{Hyperlinks}). If you would like to add new link types, Org
10664 provides an interface for doing so. Let's look at an example file,
10665 @file{org-man.el}, that will add support for creating links like
10666 @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
10670 ;;; org-man.el - Support for links to manpages in Org
10674 (org-add-link-type "man" 'org-man-open)
10675 (add-hook 'org-store-link-functions 'org-man-store-link)
10677 (defcustom org-man-command 'man
10678 "The Emacs command to be used to display a man page."
10680 :type '(choice (const man) (const woman)))
10682 (defun org-man-open (path)
10683 "Visit the manpage on PATH.
10684 PATH should be a topic that can be thrown at the man command."
10685 (funcall org-man-command path))
10687 (defun org-man-store-link ()
10688 "Store a link to a manpage."
10689 (when (memq major-mode '(Man-mode woman-mode))
10690 ;; This is a man page, we do make this link
10691 (let* ((page (org-man-get-page-name))
10692 (link (concat "man:" page))
10693 (description (format "Manpage for %s" page)))
10694 (org-store-link-props
10697 :description description))))
10699 (defun org-man-get-page-name ()
10700 "Extract the page name from the buffer name."
10701 ;; This works for both `Man-mode' and `woman-mode'.
10702 (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
10703 (match-string 1 (buffer-name))
10704 (error "Cannot create link to this man page")))
10708 ;;; org-man.el ends here
10712 You would activate this new link type in @file{.emacs} with
10719 Let's go through the file and see what it does.
10722 It does @code{(require 'org)} to make sure that @file{org.el} has been
10725 The next line calls @code{org-add-link-type} to define a new link type
10726 with prefix @samp{man}. The call also contains the name of a function
10727 that will be called to follow such a link.
10729 @vindex org-store-link-functions
10730 The next line adds a function to @code{org-store-link-functions}, in
10731 order to allow the command @kbd{C-c l} to record a useful link in a
10732 buffer displaying a man page.
10735 The rest of the file defines the necessary variables and functions.
10736 First there is a customization variable that determines which Emacs
10737 command should be used to display man pages. There are two options,
10738 @code{man} and @code{woman}. Then the function to follow a link is
10739 defined. It gets the link path as an argument---in this case the link
10740 path is just a topic for the manual command. The function calls the
10741 value of @code{org-man-command} to display the man page.
10743 Finally the function @code{org-man-store-link} is defined. When you try
10744 to store a link with @kbd{C-c l}, this function will be called to
10745 try to make a link. The function must first decide if it is supposed to
10746 create the link for this buffer type; we do this by checking the value
10747 of the variable @code{major-mode}. If not, the function must exit and
10748 return the value @code{nil}. If yes, the link is created by getting the
10749 manual topic from the buffer name and prefixing it with the string
10750 @samp{man:}. Then it must call the command @code{org-store-link-props}
10751 and set the @code{:type} and @code{:link} properties. Optionally you
10752 can also set the @code{:description} property to provide a default for
10753 the link description when the link is later inserted into an Org
10754 buffer with @kbd{C-c C-l}.
10756 When is makes sense for your new link type, you may also define a function
10757 @code{org-PREFIX-complete-link} that implements special (@eg completion)
10758 support for inserting such a link with @kbd{C-c C-l}. Such a function should
10759 not accept any arguments, and return the full link with prefix.
10761 @node Context-sensitive commands, Tables in arbitrary syntax, Adding hyperlink types, Hacking
10762 @section Context-sensitive commands
10763 @cindex context-sensitive commands, hooks
10764 @cindex add-ons, context-sensitive commands
10765 @vindex org-ctrl-c-ctrl-c-hook
10767 Org has several commands that act differently depending on context. The most
10768 important example it the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}).
10769 Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys have this property.
10771 Add-ons can tap into this functionality by providing a function that detects
10772 special context for that add-on and executes functionality appropriate for
10773 the context. Here is an example from Dan Davison's @file{org-R.el} which
10774 allows you to evaluate commands based on the @file{R} programming language. For
10775 this package, special contexts are lines that start with @code{#+R:} or
10779 (defun org-R-apply-maybe ()
10780 "Detect if this is context for org-R and execute R commands."
10781 (if (save-excursion
10782 (beginning-of-line 1)
10783 (looking-at "#\\+RR?:"))
10784 (progn (call-interactively 'org-R-apply)
10785 t) ;; to signal that we took action
10786 nil)) ;; to signal that we did not
10788 (add-hook 'org-ctrl-c-ctrl-c-hook 'org-R-apply-maybe)
10791 The function first checks if the cursor is in such a line. If that is the
10792 case, @code{org-R-apply} is called and the function returns @code{t} to
10793 signal that action was taken, and @kbd{C-c C-c} will stop looking for other
10794 contexts. If the function finds it should do nothing locally, it returns @code{nil} so that other, similar functions can have a try.
10797 @node Tables in arbitrary syntax, Dynamic blocks, Context-sensitive commands, Hacking
10798 @section Tables and lists in arbitrary syntax
10799 @cindex tables, in other modes
10800 @cindex lists, in other modes
10801 @cindex Orgtbl mode
10803 Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
10804 frequent feature request has been to make it work with native tables in
10805 specific languages, for example La@TeX{}. However, this is extremely
10806 hard to do in a general way, would lead to a customization nightmare,
10807 and would take away much of the simplicity of the Orgtbl-mode table
10811 This appendix describes a different approach. We keep the Orgtbl mode
10812 table in its native format (the @i{source table}), and use a custom
10813 function to @i{translate} the table to the correct syntax, and to
10814 @i{install} it in the right location (the @i{target table}). This puts
10815 the burden of writing conversion functions on the user, but it allows
10816 for a very flexible system.
10818 Bastien added the ability to do the same with lists. You can use Org's
10819 facilities to edit and structure lists by turning @code{orgstruct-mode}
10820 on, then locally exporting such lists in another format (HTML, La@TeX{}
10825 * Radio tables:: Sending and receiving
10826 * A LaTeX example:: Step by step, almost a tutorial
10827 * Translator functions:: Copy and modify
10828 * Radio lists:: Doing the same for lists
10831 @node Radio tables, A LaTeX example, Tables in arbitrary syntax, Tables in arbitrary syntax
10832 @subsection Radio tables
10833 @cindex radio tables
10835 To define the location of the target table, you first need to create two
10836 lines that are comments in the current mode, but contain magic words for
10837 Orgtbl mode to find. Orgtbl mode will insert the translated table
10838 between these lines, replacing whatever was there before. For example:
10841 /* BEGIN RECEIVE ORGTBL table_name */
10842 /* END RECEIVE ORGTBL table_name */
10846 Just above the source table, we put a special line that tells
10847 Orgtbl mode how to translate this table and where to install it. For
10851 #+ORGTBL: SEND table_name translation_function arguments....
10855 @code{table_name} is the reference name for the table that is also used
10856 in the receiver lines. @code{translation_function} is the Lisp function
10857 that does the translation. Furthermore, the line can contain a list of
10858 arguments (alternating key and value) at the end. The arguments will be
10859 passed as a property list to the translation function for
10860 interpretation. A few standard parameters are already recognized and
10861 acted upon before the translation function is called:
10865 Skip the first N lines of the table. Hlines do count as separate lines for
10868 @item :skipcols (n1 n2 ...)
10869 List of columns that should be skipped. If the table has a column with
10870 calculation marks, that column is automatically discarded as well.
10871 Please note that the translator function sees the table @emph{after} the
10872 removal of these columns, the function never knows that there have been
10873 additional columns.
10877 The one problem remaining is how to keep the source table in the buffer
10878 without disturbing the normal workings of the file, for example during
10879 compilation of a C file or processing of a La@TeX{} file. There are a
10880 number of different solutions:
10884 The table could be placed in a block comment if that is supported by the
10885 language. For example, in C mode you could wrap the table between
10886 @samp{/*} and @samp{*/} lines.
10888 Sometimes it is possible to put the table after some kind of @i{END}
10889 statement, for example @samp{\bye} in @TeX{} and @samp{\end@{document@}}
10892 You can just comment the table line-by-line whenever you want to process
10893 the file, and uncomment it whenever you need to edit the table. This
10894 only sounds tedious---the command @kbd{M-x orgtbl-toggle-comment}
10895 makes this comment-toggling very easy, in particular if you bind it to a
10899 @node A LaTeX example, Translator functions, Radio tables, Tables in arbitrary syntax
10900 @subsection A La@TeX{} example of radio tables
10901 @cindex La@TeX{}, and Orgtbl mode
10903 The best way to wrap the source table in La@TeX{} is to use the
10904 @code{comment} environment provided by @file{comment.sty}. It has to be
10905 activated by placing @code{\usepackage@{comment@}} into the document
10906 header. Orgtbl mode can insert a radio table skeleton@footnote{By
10907 default this works only for La@TeX{}, HTML, and Texinfo. Configure the
10908 variable @code{orgtbl-radio-tables} to install templates for other
10909 modes.} with the command @kbd{M-x orgtbl-insert-radio-table}. You will
10910 be prompted for a table name, let's say we use @samp{salesfigures}. You
10911 will then get the following template:
10913 @cindex #+ORGTBL, SEND
10915 % BEGIN RECEIVE ORGTBL salesfigures
10916 % END RECEIVE ORGTBL salesfigures
10918 #+ORGTBL: SEND salesfigures orgtbl-to-latex
10924 @vindex La@TeX{}-verbatim-environments
10925 The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
10926 @code{orgtbl-to-latex} to convert the table into La@TeX{} and to put it
10927 into the receiver location with name @code{salesfigures}. You may now
10928 fill in the table, feel free to use the spreadsheet features@footnote{If
10929 the @samp{#+TBLFM} line contains an odd number of dollar characters,
10930 this may cause problems with font-lock in La@TeX{} mode. As shown in the
10931 example you can fix this by adding an extra line inside the
10932 @code{comment} environment that is used to balance the dollar
10933 expressions. If you are using AUC@TeX{} with the font-latex library, a
10934 much better solution is to add the @code{comment} environment to the
10935 variable @code{LaTeX-verbatim-environments}.}:
10938 % BEGIN RECEIVE ORGTBL salesfigures
10939 % END RECEIVE ORGTBL salesfigures
10941 #+ORGTBL: SEND salesfigures orgtbl-to-latex
10942 | Month | Days | Nr sold | per day |
10943 |-------+------+---------+---------|
10944 | Jan | 23 | 55 | 2.4 |
10945 | Feb | 21 | 16 | 0.8 |
10946 | March | 22 | 278 | 12.6 |
10947 #+TBLFM: $4=$3/$2;%.1f
10948 % $ (optional extra dollar to keep font-lock happy, see footnote)
10953 When you are done, press @kbd{C-c C-c} in the table to get the converted
10954 table inserted between the two marker lines.
10956 Now let's assume you want to make the table header by hand, because you
10957 want to control how columns are aligned, etc@. In this case we make sure
10958 that the table translator skips the first 2 lines of the source
10959 table, and tell the command to work as a @i{splice}, @ie to not produce
10960 header and footer commands of the target table:
10963 \begin@{tabular@}@{lrrr@}
10964 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
10965 % BEGIN RECEIVE ORGTBL salesfigures
10966 % END RECEIVE ORGTBL salesfigures
10970 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
10971 | Month | Days | Nr sold | per day |
10972 |-------+------+---------+---------|
10973 | Jan | 23 | 55 | 2.4 |
10974 | Feb | 21 | 16 | 0.8 |
10975 | March | 22 | 278 | 12.6 |
10976 #+TBLFM: $4=$3/$2;%.1f
10980 The La@TeX{} translator function @code{orgtbl-to-latex} is already part of
10981 Orgtbl mode. It uses a @code{tabular} environment to typeset the table
10982 and marks horizontal lines with @code{\hline}. Furthermore, it
10983 interprets the following parameters (see also @pxref{Translator functions}):
10986 @item :splice nil/t
10987 When set to t, return only table body lines, don't wrap them into a
10988 tabular environment. Default is nil.
10991 A format to be used to wrap each field, it should contain @code{%s} for the
10992 original field value. For example, to wrap each field value in dollars,
10993 you could use @code{:fmt "$%s$"}. This may also be a property list with
10994 column numbers and formats. for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
10995 A function of one argument can be used in place of the strings; the
10996 function must return a formatted string.
10999 Use this format to print numbers with exponentials. The format should
11000 have @code{%s} twice for inserting mantissa and exponent, for example
11001 @code{"%s\\times10^@{%s@}"}. The default is @code{"%s\\,(%s)"}. This
11002 may also be a property list with column numbers and formats, for example
11003 @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After
11004 @code{efmt} has been applied to a value, @code{fmt} will also be
11005 applied. Similar to @code{fmt}, functions of two arguments can be
11006 supplied instead of strings.
11009 @node Translator functions, Radio lists, A LaTeX example, Tables in arbitrary syntax
11010 @subsection Translator functions
11011 @cindex HTML, and Orgtbl mode
11012 @cindex translator function
11014 Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
11015 (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
11016 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and @code{orgtbl-to-texinfo}.
11017 Except for @code{orgtbl-to-html}@footnote{The HTML translator uses the same
11018 code that produces tables during HTML export.}, these all use a generic
11019 translator, @code{orgtbl-to-generic}. For example, @code{orgtbl-to-latex}
11020 itself is a very short function that computes the column definitions for the
11021 @code{tabular} environment, defines a few field and line separators and then
11022 hands processing over to the generic translator. Here is the entire code:
11026 (defun orgtbl-to-latex (table params)
11027 "Convert the Orgtbl mode TABLE to LaTeX."
11028 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
11029 org-table-last-alignment ""))
11032 :tstart (concat "\\begin@{tabular@}@{" alignment "@}")
11033 :tend "\\end@{tabular@}"
11034 :lstart "" :lend " \\\\" :sep " & "
11035 :efmt "%s\\,(%s)" :hline "\\hline")))
11036 (orgtbl-to-generic table (org-combine-plists params2 params))))
11040 As you can see, the properties passed into the function (variable
11041 @var{PARAMS}) are combined with the ones newly defined in the function
11042 (variable @var{PARAMS2}). The ones passed into the function (@ie the
11043 ones set by the @samp{ORGTBL SEND} line) take precedence. So if you
11044 would like to use the La@TeX{} translator, but wanted the line endings to
11045 be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
11046 overrule the default with
11049 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
11052 For a new language, you can either write your own converter function in
11053 analogy with the La@TeX{} translator, or you can use the generic function
11054 directly. For example, if you have a language where a table is started
11055 with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are
11056 started with @samp{!BL!}, ended with @samp{!EL!}, and where the field
11057 separator is a TAB, you could call the generic translator like this (on
11061 #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
11062 :lstart "!BL! " :lend " !EL!" :sep "\t"
11066 Please check the documentation string of the function
11067 @code{orgtbl-to-generic} for a full list of parameters understood by
11068 that function, and remember that you can pass each of them into
11069 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
11070 using the generic function.
11072 Of course you can also write a completely new function doing complicated
11073 things the generic translator cannot do. A translator function takes
11074 two arguments. The first argument is the table, a list of lines, each
11075 line either the symbol @code{hline} or a list of fields. The second
11076 argument is the property list containing all parameters specified in the
11077 @samp{#+ORGTBL: SEND} line. The function must return a single string
11078 containing the formatted table. If you write a generally useful
11079 translator, please post it on @email{emacs-orgmode@@gnu.org} so that
11080 others can benefit from your work.
11082 @node Radio lists, , Translator functions, Tables in arbitrary syntax
11083 @subsection Radio lists
11084 @cindex radio lists
11085 @cindex org-list-insert-radio-list
11087 Sending and receiving radio lists works exactly the same way than
11088 sending and receiving radio tables (@pxref{Radio tables}) @footnote{You
11089 need to load the @code{org-export-latex.el} package to use radio lists
11090 since the relevant code is there for now.}. As for radio tables, you
11091 can insert radio lists templates in HTML, La@TeX{} and Texinfo modes by
11092 calling @code{org-list-insert-radio-list}.
11094 Here are the differences with radio tables:
11098 Use @code{ORGLST} instead of @code{ORGTBL}.
11100 The available translation functions for radio lists don't take
11103 @kbd{C-c C-c} will work when pressed on the first item of the list.
11106 Here is a La@TeX{} example. Let's say that you have this in your
11111 % BEGIN RECEIVE ORGLST to-buy
11112 % END RECEIVE ORGLST to-buy
11114 #+ORGLIST: SEND to-buy orgtbl-to-latex
11123 Pressing `C-c C-c' on @code{a new house} and will insert the converted
11124 La@TeX{} list between the two marker lines.
11126 @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Hacking
11127 @section Dynamic blocks
11128 @cindex dynamic blocks
11130 Org documents can contain @emph{dynamic blocks}. These are
11131 specially marked regions that are updated by some user-written function.
11132 A good example for such a block is the clock table inserted by the
11133 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
11135 Dynamic block are enclosed by a BEGIN-END structure that assigns a name
11136 to the block and can also specify parameters for the function producing
11137 the content of the block.
11139 #+BEGIN:dynamic block
11141 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
11146 Dynamic blocks are updated with the following commands
11149 @kindex C-c C-x C-u
11151 Update dynamic block at point.
11152 @kindex C-u C-c C-x C-u
11153 @item C-u C-c C-x C-u
11154 Update all dynamic blocks in the current file.
11157 Updating a dynamic block means to remove all the text between BEGIN and
11158 END, parse the BEGIN line for parameters and then call the specific
11159 writer function for this block to insert the new content. If you want
11160 to use the original content in the writer function, you can use the
11161 extra parameter @code{:content}.
11163 For a block with name @code{myblock}, the writer function is
11164 @code{org-dblock-write:myblock} with as only parameter a property list
11165 with the parameters given in the begin line. Here is a trivial example
11166 of a block that keeps track of when the block update function was last
11170 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
11176 The corresponding block writer function could look like this:
11179 (defun org-dblock-write:block-update-time (params)
11180 (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
11181 (insert "Last block update at: "
11182 (format-time-string fmt (current-time)))))
11185 If you want to make sure that all dynamic blocks are always up-to-date,
11186 you could add the function @code{org-update-all-dblocks} to a hook, for
11187 example @code{before-save-hook}. @code{org-update-all-dblocks} is
11188 written in a way such that it does nothing in buffers that are not in
11191 @node Special agenda views, Extracting agenda information, Dynamic blocks, Hacking
11192 @section Special agenda views
11193 @cindex agenda views, user-defined
11195 Org provides a special hook that can be used to narrow down the
11196 selection made by any of the agenda views. You may specify a function
11197 that is used at each match to verify if the match should indeed be part
11198 of the agenda view, and if not, how much should be skipped.
11200 Let's say you want to produce a list of projects that contain a WAITING
11201 tag anywhere in the project tree. Let's further assume that you have
11202 marked all tree headings that define a project with the TODO keyword
11203 PROJECT. In this case you would run a TODO search for the keyword
11204 PROJECT, but skip the match unless there is a WAITING tag anywhere in
11205 the subtree belonging to the project line.
11207 To achieve this, you must write a function that searches the subtree for
11208 the tag. If the tag is found, the function must return @code{nil} to
11209 indicate that this match should not be skipped. If there is no such
11210 tag, return the location of the end of the subtree, to indicate that
11211 search should continue from there.
11214 (defun my-skip-unless-waiting ()
11215 "Skip trees that are not waiting"
11216 (let ((subtree-end (save-excursion (org-end-of-subtree t))))
11217 (if (re-search-forward ":waiting:" subtree-end t)
11218 nil ; tag found, do not skip
11219 subtree-end))) ; tag not found, continue after end of subtree
11222 Now you may use this function in an agenda custom command, for example
11226 (org-add-agenda-custom-command
11227 '("b" todo "PROJECT"
11228 ((org-agenda-skip-function 'my-skip-unless-waiting)
11229 (org-agenda-overriding-header "Projects waiting for something: "))))
11232 @vindex org-agenda-overriding-header
11233 Note that this also binds @code{org-agenda-overriding-header} to get a
11234 meaningful header in the agenda view.
11236 @vindex org-odd-levels-only
11237 @vindex org-agenda-skip-function
11238 A general way to create custom searches is to base them on a search for
11239 entries with a certain level limit. If you want to study all entries with
11240 your custom search function, simply do a search for
11241 @samp{LEVEL>0}@footnote{Note that, when using @code{org-odd-levels-only}, a
11242 level number corresponds to order in the hierarchy, not to the number of
11243 stars.}, and then use @code{org-agenda-skip-function} to select the entries
11244 you really want to have.
11246 You may also put a Lisp form into @code{org-agenda-skip-function}. In
11247 particular, you may use the functions @code{org-agenda-skip-entry-if}
11248 and @code{org-agenda-skip-subtree-if} in this form, for example:
11251 @item '(org-agenda-skip-entry-if 'scheduled)
11252 Skip current entry if it has been scheduled.
11253 @item '(org-agenda-skip-entry-if 'notscheduled)
11254 Skip current entry if it has not been scheduled.
11255 @item '(org-agenda-skip-entry-if 'deadline)
11256 Skip current entry if it has a deadline.
11257 @item '(org-agenda-skip-entry-if 'scheduled 'deadline)
11258 Skip current entry if it has a deadline, or if it is scheduled.
11259 @item '(org-agenda-skip-entry-if 'timestamp)
11260 Skip current entry if it has any timestamp, may also be deadline or scheduled.
11261 @item '(org-agenda-skip-entry 'regexp "regular expression")
11262 Skip current entry if the regular expression matches in the entry.
11263 @item '(org-agenda-skip-entry 'notregexp "regular expression")
11264 Skip current entry unless the regular expression matches.
11265 @item '(org-agenda-skip-subtree-if 'regexp "regular expression")
11266 Same as above, but check and skip the entire subtree.
11269 Therefore we could also have written the search for WAITING projects
11270 like this, even without defining a special function:
11273 (org-add-agenda-custom-command
11274 '("b" todo "PROJECT"
11275 ((org-agenda-skip-function '(org-agenda-skip-subtree-if
11276 'regexp ":waiting:"))
11277 (org-agenda-overriding-header "Projects waiting for something: "))))
11280 @node Extracting agenda information, Using the property API, Special agenda views, Hacking
11281 @section Extracting agenda information
11282 @cindex agenda, pipe
11283 @cindex Scripts, for agenda processing
11285 @vindex org-agenda-custom-commands
11286 Org provides commands to access agenda information for the command
11287 line in Emacs batch mode. This extracted information can be sent
11288 directly to a printer, or it can be read by a program that does further
11289 processing of the data. The first of these commands is the function
11290 @code{org-batch-agenda}, that produces an agenda view and sends it as
11291 ASCII text to STDOUT. The command takes a single string as parameter.
11292 If the string has length 1, it is used as a key to one of the commands
11293 you have configured in @code{org-agenda-custom-commands}, basically any
11294 key you can use after @kbd{C-c a}. For example, to directly print the
11295 current TODO list, you could use
11298 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
11301 If the parameter is a string with 2 or more characters, it is used as a
11302 tags/TODO match string. For example, to print your local shopping list
11303 (all items with the tag @samp{shop}, but excluding the tag
11304 @samp{NewYork}), you could use
11307 emacs -batch -l ~/.emacs \
11308 -eval '(org-batch-agenda "+shop-NewYork")' | lpr
11312 You may also modify parameters on the fly like this:
11315 emacs -batch -l ~/.emacs \
11316 -eval '(org-batch-agenda "a" \
11317 org-agenda-ndays 30 \
11318 org-agenda-include-diary nil \
11319 org-agenda-files (quote ("~/org/project.org")))' \
11324 which will produce a 30-day agenda, fully restricted to the Org file
11325 @file{~/org/projects.org}, not even including the diary.
11327 If you want to process the agenda data in more sophisticated ways, you
11328 can use the command @code{org-batch-agenda-csv} to get a comma-separated
11329 list of values for each agenda item. Each line in the output will
11330 contain a number of fields separated by commas. The fields in a line
11334 category @r{The category of the item}
11335 head @r{The headline, without TODO keyword, TAGS and PRIORITY}
11336 type @r{The type of the agenda entry, can be}
11337 todo @r{selected in TODO match}
11338 tagsmatch @r{selected in tags match}
11339 diary @r{imported from diary}
11340 deadline @r{a deadline}
11341 scheduled @r{scheduled}
11342 timestamp @r{appointment, selected by timestamp}
11343 closed @r{entry was closed on date}
11344 upcoming-deadline @r{warning about nearing deadline}
11345 past-scheduled @r{forwarded scheduled item}
11346 block @r{entry has date block including date}
11347 todo @r{The TODO keyword, if any}
11348 tags @r{All tags including inherited ones, separated by colons}
11349 date @r{The relevant date, like 2007-2-14}
11350 time @r{The time, like 15:00-16:50}
11351 extra @r{String with extra planning info}
11352 priority-l @r{The priority letter if any was given}
11353 priority-n @r{The computed numerical priority}
11357 Time and date will only be given if a timestamp (or deadline/scheduled)
11358 led to the selection of the item.
11360 A CSV list like this is very easy to use in a post-processing script.
11361 For example, here is a Perl program that gets the TODO list from
11362 Emacs/Org and prints all the items, preceded by a checkbox:
11367 # define the Emacs command to run
11368 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
11370 # run it and capture the output
11371 $agenda = qx@{$cmd 2>/dev/null@};
11373 # loop over all lines
11374 foreach $line (split(/\n/,$agenda)) @{
11375 # get the individual values
11376 ($category,$head,$type,$todo,$tags,$date,$time,$extra,
11377 $priority_l,$priority_n) = split(/,/,$line);
11378 # process and print
11379 print "[ ] $head\n";
11396 @node Using the property API, Using the mapping API, Extracting agenda information, Hacking
11397 @section Using the property API
11398 @cindex API, for properties
11399 @cindex properties, API
11401 Here is a description of the functions that can be used to work with
11404 @defun org-entry-properties &optional pom which
11405 Get all properties of the entry at point-or-marker POM.@*
11406 This includes the TODO keyword, the tags, time strings for deadline,
11407 scheduled, and clocking, and any additional properties defined in the
11408 entry. The return value is an alist, keys may occur multiple times
11409 if the property key was used several times.@*
11410 POM may also be nil, in which case the current entry is used.
11411 If WHICH is nil or `all', get all properties. If WHICH is
11412 `special' or `standard', only get that subclass.
11414 @vindex org-use-property-inheritance
11415 @defun org-entry-get pom property &optional inherit
11416 Get value of PROPERTY for entry at point-or-marker POM. By default,
11417 this only looks at properties defined locally in the entry. If INHERIT
11418 is non-nil and the entry does not have the property, then also check
11419 higher levels of the hierarchy. If INHERIT is the symbol
11420 @code{selective}, use inheritance if and only if the setting of
11421 @code{org-use-property-inheritance} selects PROPERTY for inheritance.
11424 @defun org-entry-delete pom property
11425 Delete the property PROPERTY from entry at point-or-marker POM.
11428 @defun org-entry-put pom property value
11429 Set PROPERTY to VALUE for entry at point-or-marker POM.
11432 @defun org-buffer-property-keys &optional include-specials
11433 Get all property keys in the current buffer.
11436 @defun org-insert-property-drawer
11437 Insert a property drawer at point.
11440 @defun org-entry-put-multivalued-property pom property &rest values
11441 Set PROPERTY at point-or-marker POM to VALUES. VALUES should be a list of
11442 strings. They will be concatenated, with spaces as separators.
11445 @defun org-entry-get-multivalued-property pom property
11446 Treat the value of the property PROPERTY as a whitespace-separated list of
11447 values and return the values as a list of strings.
11450 @defun org-entry-add-to-multivalued-property pom property value
11451 Treat the value of the property PROPERTY as a whitespace-separated list of
11452 values and make sure that VALUE is in this list.
11455 @defun org-entry-remove-from-multivalued-property pom property value
11456 Treat the value of the property PROPERTY as a whitespace-separated list of
11457 values and make sure that VALUE is @emph{not} in this list.
11460 @defun org-entry-member-in-multivalued-property pom property value
11461 Treat the value of the property PROPERTY as a whitespace-separated list of
11462 values and check if VALUE is in this list.
11465 @node Using the mapping API, , Using the property API, Hacking
11466 @section Using the mapping API
11467 @cindex API, for mapping
11468 @cindex mapping entries, API
11470 Org has sophisticated mapping capabilities to find all entries satisfying
11471 certain criteria. Internally, this functionality is used to produce agenda
11472 views, but there is also an API that can be used to execute arbitrary
11473 functions for each or selected entries. The main entry point for this API
11476 @defun org-map-entries func &optional match scope &rest skip
11477 Call FUNC at each headline selected by MATCH in SCOPE.
11479 FUNC is a function or a Lisp form. The function will be called without
11480 arguments, with the cursor positioned at the beginning of the headline.
11481 The return values of all calls to the function will be collected and
11482 returned as a list.
11484 The call to FUNC will be wrapped into a save-excursion form, so FUNC
11485 does not need to preserve point. After evaluation, the cursor will be
11486 moved to the end of the line (presumably of the headline of the
11487 processed entry) and search continues from there. Under some
11488 circumstances, this may not produce the wanted results. For example,
11489 if you have removed (@eg archived) the current (sub)tree it could
11490 mean that the next entry will be skipped entirely. In such cases, you
11491 can specify the position from where search should continue by making
11492 FUNC set the variable `org-map-continue-from' to the desired buffer
11495 MATCH is a tags/property/todo match as it is used in the agenda match view.
11496 Only headlines that are matched by this query will be considered during
11497 the iteration. When MATCH is nil or t, all headlines will be
11498 visited by the iteration.
11500 SCOPE determines the scope of this command. It can be any of:
11503 nil @r{the current buffer, respecting the restriction if any}
11504 tree @r{the subtree started with the entry at point}
11505 file @r{the current buffer, without restriction}
11507 @r{the current buffer, and any archives associated with it}
11508 agenda @r{all agenda files}
11509 agenda-with-archives
11510 @r{all agenda files with any archive files associated with them}
11512 @r{if this is a list, all files in the list will be scanned}
11515 The remaining args are treated as settings for the skipping facilities of
11516 the scanner. The following items can be given here:
11518 @vindex org-agenda-skip-function
11520 archive @r{skip trees with the archive tag}
11521 comment @r{skip trees with the COMMENT keyword}
11522 function or Lisp form
11523 @r{will be used as value for @code{org-agenda-skip-function},}
11524 @r{so whenever the function returns t, FUNC}
11525 @r{will not be called for that entry and search will}
11526 @r{continue from the point where the function leaves it}
11530 The function given to that mapping routine can really do anything you like.
11531 It can use the property API (@pxref{Using the property API}) to gather more
11532 information about the entry, or in order to change metadata in the entry.
11533 Here are a couple of functions that might be handy:
11535 @defun org-todo &optional arg
11536 Change the TODO state of the entry, see the docstring of the functions for
11537 the many possible values for the argument ARG.
11540 @defun org-priority &optional action
11541 Change the priority of the entry, see the docstring of this function for the
11542 possible values for ACTION.
11545 @defun org-toggle-tag tag &optional onoff
11546 Toggle the tag TAG in the current entry. Setting ONOFF to either @code{on}
11547 or @code{off} will not toggle tag, but ensure that it is either on or off.
11551 Promote the current entry.
11555 Demote the current entry.
11558 Here is a simple example that will turn all entries in the current file with
11559 a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
11560 Entries in comment trees and in archive trees will be ignored.
11564 '(org-todo "UPCOMING")
11565 "+TOMORROW" 'file 'archive 'comment)
11568 The following example counts the number of entries with TODO keyword
11569 @code{WAITING}, in all agenda files.
11572 (length (org-map-entries t "/+WAITING" 'agenda))
11575 @node History and Acknowledgments, Main Index, Hacking, Top
11576 @appendix History and Acknowledgments
11577 @cindex acknowledgments
11581 Org was born in 2003, out of frustration over the user interface
11582 of the Emacs Outline mode. I was trying to organize my notes and
11583 projects, and using Emacs seemed to be the natural way to go. However,
11584 having to remember eleven different commands with two or three keys per
11585 command, only to hide and show parts of the outline tree, that seemed
11586 entirely unacceptable to me. Also, when using outlines to take notes, I
11587 constantly wanted to restructure the tree, organizing it parallel to my
11588 thoughts and plans. @emph{Visibility cycling} and @emph{structure
11589 editing} were originally implemented in the package
11590 @file{outline-magic.el}, but quickly moved to the more general
11591 @file{org.el}. As this environment became comfortable for project
11592 planning, the next step was adding @emph{TODO entries}, basic
11593 @emph{timestamps}, and @emph{table support}. These areas highlighted the two main
11594 goals that Org still has today: to be a new, outline-based,
11595 plain text mode with innovative and intuitive editing features, and to
11596 incorporate project planning functionality directly into a notes file.
11598 A special thanks goes to @i{Bastien Guerry} who has not only written a large
11599 number of extensions to Org (most of them integrated into the core by now),
11600 but who has also helped in the development and maintenance of Org so much that he
11601 should be considered the main co-contributor to this package.
11603 Since the first release, literally thousands of emails to me or to
11604 @email{emacs-orgmode@@gnu.org} have provided a constant stream of bug
11605 reports, feedback, new ideas, and sometimes patches and add-on code.
11606 Many thanks to everyone who has helped to improve this package. I am
11607 trying to keep here a list of the people who had significant influence
11608 in shaping one or more aspects of Org. The list may not be
11609 complete, if I have forgotten someone, please accept my apologies and
11615 @i{Russel Adams} came up with the idea for drawers.
11617 @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
11619 @i{Christophe Bataillon} created the great unicorn logo that we use on the
11622 @i{Alex Bochannek} provided a patch for rounding timestamps.
11624 @i{Brad Bozarth} showed how to pull RSS feed data into Org-mode files.
11626 @i{Tom Breton} wrote @file{org-choose.el}.
11628 @i{Charles Cave}'s suggestion sparked the implementation of templates
11631 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
11634 @i{Gregory Chernov} patched support for Lisp forms into table
11635 calculations and improved XEmacs compatibility, in particular by porting
11636 @file{nouline.el} to XEmacs.
11638 @i{Sacha Chua} suggested copying some linking code from Planner.
11640 @i{Baoqiu Cui} contributed the DocBook exporter.
11642 @i{Eddward DeVilla} proposed and tested checkbox statistics. He also
11643 came up with the idea of properties, and that there should be an API for
11646 @i{Nick Dokos} tracked down several nasty bugs.
11648 @i{Kees Dullemond} used to edit projects lists directly in HTML and so
11649 inspired some of the early development, including HTML export. He also
11650 asked for a way to narrow wide table columns.
11652 @i{Christian Egli} converted the documentation into Texinfo format,
11653 patched CSS formatting into the HTML exporter, and inspired the agenda.
11655 @i{David Emery} provided a patch for custom CSS support in exported
11658 @i{Nic Ferrier} contributed mailcap and XOXO support.
11660 @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
11662 @i{John Foerch} figured out how to make incremental search show context
11663 around a match in a hidden outline tree.
11665 @i{Niels Giesen} had the idea to automatically archive DONE trees.
11667 @i{Bastien Guerry} wrote the La@TeX{} exporter and @file{org-bibtex.el}, and
11668 has been prolific with patches, ideas, and bug reports.
11670 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
11672 @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
11673 task state change logging, and the clocktable. His clear explanations have
11674 been critical when we started to adopt the Git version control system.
11676 @i{Manuel Hermenegildo} has contributed various ideas, small fixes and
11679 @i{Phil Jackson} wrote @file{org-irc.el}.
11681 @i{Scott Jaderholm} proposed footnotes, control over whitespace between
11682 folded entries, and column view for properties.
11684 @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
11686 @i{Shidai Liu} ("Leo") asked for embedded La@TeX{} and tested it. He also
11687 provided frequent feedback and some patches.
11689 @i{Matt Lundin} has proposed last-row references for table formulas and named
11690 invisible anchors. He has also worked a lot on the FAQ.
11692 @i{Jason F. McBrayer} suggested agenda export to CSV format.
11694 @i{Max Mikhanosha} came up with the idea of refiling.
11696 @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
11699 @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
11702 @i{Rick Moynihan} proposed allowing multiple TODO sequences in a file
11703 and being able to quickly restrict the agenda to a subtree.
11705 @i{Todd Neal} provided patches for links to Info files and Elisp forms.
11707 @i{Greg Newman} refreshed the unicorn logo into its current form.
11709 @i{Tim O'Callaghan} suggested in-file links, search options for general
11710 file links, and TAGS.
11712 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
11715 @i{Oliver Oppitz} suggested multi-state TODO items.
11717 @i{Scott Otterson} sparked the introduction of descriptive text for
11718 links, among other things.
11720 @i{Pete Phillips} helped during the development of the TAGS feature, and
11721 provided frequent feedback.
11723 @i{Martin Pohlack} provided the code snippet to bundle character insertion
11724 into bundles of 20 for undo.
11726 @i{T.V. Raman} reported bugs and suggested improvements.
11728 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
11731 @i{Paul Rivier} provided the basic implementation of named footnotes.
11733 @i{Kevin Rogers} contributed code to access VM files on remote hosts.
11735 @i{Sebastian Rose} wrote @file{org-info.js}, a Java script for displaying
11736 webpages derived from Org using an Info-like or a folding interface with
11737 single-key navigation.
11739 @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
11740 conflict with @file{allout.el}.
11742 @i{Jason Riedy} generalized the send-receive mechanism for Orgtbl tables with
11745 @i{Philip Rooke} created the Org reference card, provided lots
11746 of feedback, developed and applied standards to the Org documentation.
11748 @i{Christian Schlauer} proposed angular brackets around links, among
11751 @i{Eric Schulte} wrote @file{org-plot.el} and contributed various patches,
11752 small features and modules.
11754 Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
11755 @file{organizer-mode.el}.
11757 @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal
11758 examples, and remote highlighting for referenced code lines.
11760 @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
11761 now packaged into Org's @file{contrib} directory.
11763 @i{Daniel Sinder} came up with the idea of internal archiving by locking
11766 @i{Dale Smith} proposed link abbreviations.
11768 @i{James TD Smith} has contributed a large number of patches for useful
11769 tweaks and features.
11771 @i{Adam Spiers} asked for global linking commands, inspired the link
11772 extension system, added support for mairix, and proposed the mapping API.
11774 @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content
11775 with links transformation to Org syntax.
11777 @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
11778 chapter about publishing.
11780 @i{J@"urgen Vollmer} contributed code generating the table of contents
11783 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
11786 @i{David Wainberg} suggested archiving, and improvements to the linking
11789 @i{John Wiegley} wrote @file{emacs-wiki.el}, @file{planner.el}, and
11790 @file{muse.el}, which have some overlap with Org. Initially the development
11791 of Org was fully independent because I was not aware of the existence of
11792 these packages. But with time I have occasionally looked at John's code and
11793 learned a lot from it. John has also contributed a number of great ideas and
11794 patches directly to Org, including the attachment system
11795 (@file{org-attach.el}), integration with Apple Mail
11796 (@file{org-mac-message.el}), and hierarchical dependencies of TODO items.
11798 @i{Carsten Wimmer} suggested some changes and helped fix a bug in
11801 @i{Roland Winkler} requested additional key bindings to make Org
11804 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
11805 and contributed various ideas and code snippets.
11809 @node Main Index, Key Index, History and Acknowledgments, Top
11810 @unnumbered Concept Index
11814 @node Key Index, Variable Index, Main Index, Top
11815 @unnumbered Key Index
11819 @node Variable Index, , Key Index, Top
11820 @unnumbered Variable Index
11822 This is not a complete index of variables and faces, only the ones that are
11823 mentioned in the manual. For a more complete list, use @kbd{M-x
11824 org-customize @key{RET}} and then klick yourself through the tree.
11831 arch-tag: 7893d1Fe-cc57-4d13-b5e5-f494a1CBC7ac
11834 @c Local variables:
11835 @c ispell-local-dictionary: "en_US-w_accents"
11836 @c ispell-local-pdict: "./.aspell.org.pws"