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 * MobileOrg:: Viewing and capture on a mobile device
113 * History and Acknowledgments:: How Org came into being
114 * Main Index:: An index of Org's concepts and features
115 * Key Index:: Key bindings and where they are described
116 * Variable Index:: Variables mentioned in the manual
119 --- The Detailed Node Listing ---
123 * Summary:: Brief summary of what Org does
124 * Installation:: How to install a downloaded version of Org
125 * Activation:: How to activate Org for certain buffers
126 * Feedback:: Bug reports, ideas, patches etc.
127 * Conventions:: Type-setting conventions in the manual
131 * Outlines:: Org is based on Outline mode
132 * Headlines:: How to typeset Org tree headlines
133 * Visibility cycling:: Show and hide, much simplified
134 * Motion:: Jumping to other headlines
135 * Structure editing:: Changing sequence and level of headlines
136 * Archiving:: Move done task trees to a different place
137 * Sparse trees:: Matches embedded in context
138 * Plain lists:: Additional structure within an entry
139 * Drawers:: Tucking stuff away
140 * Blocks:: Folding blocks
141 * Footnotes:: How footnotes are defined in Org's syntax
142 * Orgstruct mode:: Structure editing outside Org
146 * ARCHIVE tag:: Marking a tree as inactive
147 * Moving subtrees:: Moving a tree to an archive file
151 * Built-in table editor:: Simple tables
152 * Column width and alignment:: Overrule the automatic settings
153 * Column groups:: Grouping to trigger vertical lines
154 * Orgtbl mode:: The table editor as minor mode
155 * The spreadsheet:: The table editor has spreadsheet capabilities
156 * Org-Plot:: Plotting from org tables
160 * References:: How to refer to another field or range
161 * Formula syntax for Calc:: Using Calc to compute stuff
162 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
163 * Field formulas:: Formulas valid for a single field
164 * Column formulas:: Formulas valid for an entire column
165 * Editing and debugging formulas:: Fixing formulas
166 * Updating the table:: Recomputing all dependent fields
167 * Advanced features:: Field names, parameters and automatic recalc
171 * Link format:: How links in Org are formatted
172 * Internal links:: Links to other places in the current file
173 * External links:: URL-like links to the world
174 * Handling links:: Creating, inserting and following
175 * Using links outside Org:: Linking from my C source code?
176 * Link abbreviations:: Shortcuts for writing complex links
177 * Search options:: Linking to a specific location
178 * Custom searches:: When the default search is not enough
182 * Radio targets:: Make targets trigger links in plain text
186 * TODO basics:: Marking and displaying TODO entries
187 * TODO extensions:: Workflow and assignments
188 * Progress logging:: Dates and notes for progress
189 * Priorities:: Some things are more important than others
190 * Breaking down tasks:: Splitting a task into manageable pieces
191 * Checkboxes:: Tick-off lists
193 Extended use of TODO keywords
195 * Workflow states:: From TODO to DONE in steps
196 * TODO types:: I do this, Fred does the rest
197 * Multiple sets in one file:: Mixing it all, and still finding your way
198 * Fast access to TODO states:: Single letter selection of a state
199 * Per-file keywords:: Different files, different requirements
200 * Faces for TODO keywords:: Highlighting states
201 * TODO dependencies:: When one task needs to wait for others
205 * Closing items:: When was this entry marked DONE?
206 * Tracking TODO state changes:: When did the status change?
210 * Tag inheritance:: Tags use the tree structure of the outline
211 * Setting tags:: How to assign tags to a headline
212 * Tag searches:: Searching for combinations of tags
214 Properties and Columns
216 * Property syntax:: How properties are spelled out
217 * Special properties:: Access to other Org mode features
218 * Property searches:: Matching property values
219 * Property inheritance:: Passing values down the tree
220 * Column view:: Tabular viewing and editing
221 * Property API:: Properties for Lisp programmers
225 * Defining columns:: The COLUMNS format property
226 * Using column view:: How to create and use column view
227 * Capturing column view:: A dynamic block for column view
231 * Scope of column definitions:: Where defined, where valid?
232 * Column attributes:: Appearance and content of a column
236 * Timestamps:: Assigning a time to a tree entry
237 * Creating timestamps:: Commands which insert timestamps
238 * Deadlines and scheduling:: Planning your work
239 * Clocking work time:: Tracking how long you spend on a task
240 * Effort estimates:: Planning work effort in advance
241 * Relative timer:: Notes with a running timer
245 * The date/time prompt:: How Org mode helps you entering date and time
246 * Custom time format:: Making dates look different
248 Deadlines and scheduling
250 * Inserting deadline/schedule:: Planning items
251 * Repeated tasks:: Items that show up again and again
255 * Remember:: Capture new tasks/ideas with little interruption
256 * Attachments:: Add files to tasks.
257 * RSS Feeds:: Getting input from RSS feeds
258 * Protocols:: External (@eg Browser) access to Emacs and Org
262 * Setting up Remember for Org:: Some code for .emacs to get things going
263 * Remember templates:: Define the outline of different note types
264 * Storing notes:: Directly get the note to where it belongs
265 * Refiling notes:: Moving a note or task to a project
269 * Agenda files:: Files being searched for agenda information
270 * Agenda dispatcher:: Keyboard access to agenda views
271 * Built-in agenda views:: What is available out of the box?
272 * Presentation and sorting:: How agenda items are prepared for display
273 * Agenda commands:: Remote editing of Org trees
274 * Custom agenda views:: Defining special searches and views
275 * Exporting Agenda Views:: Writing a view to a file
276 * Agenda column view:: Using column view for collected entries
278 The built-in agenda views
280 * Weekly/daily agenda:: The calendar page with current tasks
281 * Global TODO list:: All unfinished action items
282 * Matching tags and properties:: Structured information with fine-tuned search
283 * Timeline:: Time-sorted view for single file
284 * Keyword search:: Finding entries by keyword
285 * Stuck projects:: Find projects you need to review
287 Presentation and sorting
289 * Categories:: Not all tasks are equal
290 * Time-of-day specifications:: How the agenda knows the time
291 * Sorting of agenda items:: The order of things
295 * Storing searches:: Type once, use often
296 * Block agenda:: All the stuff you need in a single buffer
297 * Setting Options:: Changing the rules
301 * Math symbols:: @TeX{} macros for symbols and Greek letters
302 * Subscripts and superscripts:: Simple syntax for raising/lowering text
303 * LaTeX fragments:: Complex formulas made easy
304 * Processing LaTeX fragments:: Previewing La@TeX{} processing
305 * CDLaTeX mode:: Speed up entering of formulas
309 * Markup rules:: Which structures are recognized?
310 * Selective export:: Using tags to select and exclude trees
311 * Export options:: Per-file export settings
312 * The export dispatcher:: How to access exporter commands
313 * ASCII export:: Exporting to plain ASCII
314 * HTML export:: Exporting to HTML
315 * LaTeX and PDF export:: Exporting to La@TeX{}, and processing to PDF
316 * DocBook export:: Exporting to DocBook
317 * XOXO export:: Exporting to XOXO
318 * iCalendar export:: Exporting in iCalendar format
322 * Document title:: How the document title is determined
323 * Headings and sections:: The main structure of the exported document
324 * Table of contents:: If, where, how to create a table of contents
325 * Initial text:: Text before the first headline
326 * Lists:: Plain lists are exported
327 * Paragraphs:: What determines beginning and ending
328 * Literal examples:: Source code and other examples
329 * Include files:: Include the contents of a file during export
330 * Tables exported:: Tables are exported richly
331 * Inlined images:: How to inline images during export
332 * Footnote markup:: ASCII representation of footnotes
333 * Emphasis and monospace:: To bold or not to bold
334 * TeX macros and LaTeX fragments:: Create special, rich export.
335 * Horizontal rules:: A line across the page
336 * Comment lines:: Some lines will not be exported
337 * Macro replacement:: Global replacement of place holders
341 * HTML Export commands:: How to invoke HTML export
342 * Quoting HTML tags:: Using direct HTML in Org mode
343 * Links:: Transformation of links for HTML
344 * Tables in HTML export:: How to modify the formatting of tables
345 * Images in HTML export:: How to insert figures into HTML output
346 * Text areas in HTML export:: An alternative way to show an example
347 * CSS support:: Changing the appearance of the output
348 * Javascript support:: Info and Folding in a web browser
350 La@TeX{} and PDF export
352 * LaTeX/PDF export commands:: Which key invokes which commands
353 * Quoting LaTeX code:: Incorporating literal La@TeX{} code
354 * Sectioning structure:: Changing sectioning in La@TeX{} output
355 * Tables in LaTeX export:: Options for exporting tables to La@TeX{}
356 * Images in LaTeX export:: How to insert figures into La@TeX{} output
360 * DocBook export commands:: How to invoke DocBook export
361 * Quoting DocBook code:: Incorporating DocBook code in Org files
362 * Recursive sections:: Recursive sections in DocBook
363 * Tables in DocBook export:: Tables are exported as HTML tables
364 * Images in DocBook export:: How to insert figures into DocBook output
365 * Special characters:: How to handle special characters
369 * Configuration:: Defining projects
370 * Uploading files:: How to get files up on the server
371 * Sample configuration:: Example projects
372 * Triggering publication:: Publication commands
376 * Project alist:: The central configuration variable
377 * Sources and destinations:: From here to there
378 * Selecting files:: What files are part of the project?
379 * Publishing action:: Setting the function doing the publishing
380 * Publishing options:: Tweaking HTML export
381 * Publishing links:: Which links keep working after publishing?
382 * Project page index:: Publishing a list of project files
386 * Simple example:: One-component publishing
387 * Complex example:: A multi-component publishing example
391 * Completion:: M-TAB knows what you need
392 * Customization:: Adapting Org to your taste
393 * In-buffer settings:: Overview of the #+KEYWORDS
394 * The very busy C-c C-c key:: When in doubt, press C-c C-c
395 * Clean view:: Getting rid of leading stars in the outline
396 * TTY keys:: Using Org on a tty
397 * Interaction:: Other Emacs packages
399 Interaction with other packages
401 * Cooperation:: Packages Org cooperates with
402 * Conflicts:: Packages that lead to conflicts
406 * Hooks:: Who to reach into Org's internals
407 * Add-on packages:: Available extensions
408 * Adding hyperlink types:: New custom link types
409 * Context-sensitive commands:: How to add functionality to such commands
410 * Tables in arbitrary syntax:: Orgtbl for La@TeX{} and other programs
411 * Dynamic blocks:: Automatically filled blocks
412 * Special agenda views:: Customized views
413 * Extracting agenda information:: Postprocessing of agenda information
414 * Using the property API:: Writing programs that use entry properties
415 * Using the mapping API:: Mapping over all or selected entries
417 Tables and lists in arbitrary syntax
419 * Radio tables:: Sending and receiving radio tables
420 * A LaTeX example:: Step by step, almost a tutorial
421 * Translator functions:: Copy and modify
422 * Radio lists:: Doing the same for lists
426 * Setting up the staging area:: Where to interact with the mobile device
427 * Pushing to MobileOrg:: Uploading Org files and agendas
428 * Pulling from MobileOrg:: Integrating captured and flagged items
433 @node Introduction, Document Structure, Top, Top
434 @chapter Introduction
438 * Summary:: Brief summary of what Org does
439 * Installation:: How to install a downloaded version of Org
440 * Activation:: How to activate Org for certain buffers
441 * Feedback:: Bug reports, ideas, patches etc.
442 * Conventions:: Type-setting conventions in the manual
445 @node Summary, Installation, Introduction, Introduction
449 Org is a mode for keeping notes, maintaining TODO lists, and doing
450 project planning with a fast and effective plain-text system.
452 Org develops organizational tasks around NOTES files that contain
453 lists or information about projects as plain text. Org is
454 implemented on top of Outline mode, which makes it possible to keep the
455 content of large files well structured. Visibility cycling and
456 structure editing help to work with the tree. Tables are easily created
457 with a built-in table editor. Org supports TODO items, deadlines,
458 timestamps, and scheduling. It dynamically compiles entries into an
459 agenda that utilizes and smoothly integrates much of the Emacs calendar
460 and diary. Plain text URL-like links connect to websites, emails,
461 Usenet messages, BBDB entries, and any files related to the projects.
462 For printing and sharing of notes, an Org file can be exported as a
463 structured ASCII file, as HTML, or (TODO and agenda items only) as an
464 iCalendar file. It can also serve as a publishing tool for a set of
467 An important design aspect that distinguishes Org from, for example,
468 Planner/Muse is that it encourages you to store every piece of information
469 only once. In Planner, you have project pages, day pages and possibly
470 other files, duplicating some information such as tasks. In Org,
471 you only have notes files. In your notes you mark entries as tasks, and
472 label them with tags and timestamps. All necessary lists, like a
473 schedule for the day, the agenda for a meeting, tasks lists selected by
474 tags, etc., are created dynamically when you need them.
476 Org keeps simple things simple. When first fired up, it should
477 feel like a straightforward, easy to use outliner. Complexity is not
478 imposed, but a large amount of functionality is available when you need
479 it. Org is a toolbox and can be used in different ways, for
483 @r{@bullet{} an outline extension with visibility cycling and structure editing}
484 @r{@bullet{} an ASCII system and table editor for taking structured notes}
485 @r{@bullet{} an ASCII table editor with spreadsheet-like capabilities}
486 @r{@bullet{} a TODO list editor}
487 @r{@bullet{} a full agenda and planner with deadlines and work scheduling}
488 @pindex GTD, Getting Things Done
489 @r{@bullet{} an environment to implement David Allen's GTD system}
490 @r{@bullet{} a basic database application}
491 @r{@bullet{} a simple hypertext system, with HTML and La@TeX{} export}
492 @r{@bullet{} a publishing tool to create a set of interlinked webpages}
495 Org's automatic, context-sensitive table editor with spreadsheet
496 capabilities can be integrated into any major mode by activating the
497 minor Orgtbl mode. Using a translation step, it can be used to maintain
498 tables in arbitrary file types, for example in La@TeX{}. The structure
499 editing and list creation capabilities can be used outside Org with
500 the minor Orgstruct mode.
503 There is a website for Org which provides links to the newest
504 version of Org, as well as additional information, frequently asked
505 questions (FAQ), links to tutorials, etc@. This page is located at
506 @uref{http://orgmode.org}.
511 @node Installation, Activation, Summary, Introduction
512 @section Installation
516 @b{Important:} @i{If you are using a version of Org that is part of the Emacs
517 distribution or an XEmacs package, please skip this section and go directly
518 to @ref{Activation}.}
520 If you have downloaded Org from the Web, either as a distribution @file{.zip}
521 or @file{.tar} file, or as a Git archive, you must take the following steps
522 to install it: go into the unpacked Org distribution directory and edit the
523 top section of the file @file{Makefile}. You must set the name of the Emacs
524 binary (likely either @file{emacs} or @file{xemacs}), and the paths to the
525 directories where local Lisp and Info files are kept. If you don't have
526 access to the system-wide directories, you can simply run Org directly from
527 the distribution directory by adding the @file{lisp} subdirectory to the
528 Emacs load path. To do this, add the following line to @file{.emacs}:
531 (setq load-path (cons "~/path/to/orgdir/lisp" load-path))
535 If you plan to use code from the @file{contrib} subdirectory, do a similar
536 step for this directory:
539 (setq load-path (cons "~/path/to/orgdir/contrib/lisp" load-path))
544 XEmacs users now need to install the file @file{noutline.el} from
545 the @file{xemacs} sub-directory of the Org distribution. Use the
549 make install-noutline
554 @noindent Now byte-compile the Lisp files with the shell command:
560 @noindent If you are running Org from the distribution directory, this is
561 all. If you want to install Org into the system directories, use (as
568 Installing Info files is system dependent, because of differences in the
569 @file{install-info} program. In Debian it copies the info files into the
570 correct directory and modifies the info directory file. In many other
571 systems, the files need to be copied to the correct directory separately, and
572 @file{install-info} then only modifies the directory file. Check your system
573 documentation to find out which of the following commands you need:
577 make install-info-debian
580 Then add the following line to @file{.emacs}. It is needed so that
581 Emacs can autoload functions that are located in files not immediately loaded
582 when Org-mode starts.
584 (require 'org-install)
587 Do not forget to activate Org as described in the following section.
590 @node Activation, Feedback, Installation, Introduction
594 @cindex global key bindings
595 @cindex key bindings, global
598 @b{Important:} @i{If you use copy-and-paste to copy Lisp code from the
599 PDF documentation as viewed by some PDF viewers to your @file{.emacs} file, the
600 single-quote character comes out incorrectly and the code will not work.
601 You need to fix the single-quotes by hand, or copy from Info
605 Add the following lines to your @file{.emacs} file. The last three lines
606 define @emph{global} keys for the commands @command{org-store-link},
607 @command{org-agenda}, and @command{org-iswitchb}---please choose suitable
611 ;; The following lines are always needed. Choose your own keys.
612 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
613 (global-set-key "\C-cl" 'org-store-link)
614 (global-set-key "\C-ca" 'org-agenda)
615 (global-set-key "\C-cb" 'org-iswitchb)
618 Furthermore, you must activate @code{font-lock-mode} in Org
619 buffers, because significant functionality depends on font-locking being
620 active. You can do this with either one of the following two lines
621 (XEmacs users must use the second option):
623 (global-font-lock-mode 1) ; for all buffers
624 (add-hook 'org-mode-hook 'turn-on-font-lock) ; Org buffers only
627 @cindex Org mode, turning on
628 With this setup, all files with extension @samp{.org} will be put
629 into Org mode. As an alternative, make the first line of a file look
633 MY PROJECTS -*- mode: org; -*-
636 @vindex org-insert-mode-line-in-empty-file
637 @noindent which will select Org mode for this buffer no matter what
638 the file's name is. See also the variable
639 @code{org-insert-mode-line-in-empty-file}.
641 Many commands in Org work on the region if the region is @i{active}. To make
642 use of this, you need to have @code{transient-mark-mode}
643 (@code{zmacs-regions} in XEmacs) turned on. In Emacs 23 this is the default,
644 in Emacs 22 you need to do this yourself with
646 (transient-mark-mode 1)
648 @noindent If you do not like @code{transient-mark-mode}, you can create an
649 active region by using the mouse to select a region, or pressing
650 @kbd{C-@key{SPC}} twice before moving the cursor.
652 @node Feedback, Conventions, Activation, Introduction
659 If you find problems with Org, or if you have questions, remarks, or ideas
660 about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}.
661 If you are not a member of the mailing list, your mail will be passed to the
662 list after a moderator has approved it.
664 For bug reports, please provide as much information as possible, including
665 the version information of Emacs (@kbd{M-x emacs-version @key{RET}}) and Org
666 (@kbd{M-x org-version @key{RET}}), as well as the Org related setup in
667 @file{.emacs}. The easiest way to do this is to use the command
669 @kbd{M-x org-submit-bug-report}
671 @noindent which will put all this information into an Emacs mail buffer so
672 that you only need to add your description. If you re not sending the Email
673 from within Emacs, please copy and paste the content into your Email program.
675 If an error occurs, a backtrace can be very useful (see below on how to
676 create one). Often a small example file helps, along with clear information
680 @item What exactly did you do?
681 @item What did you expect to happen?
682 @item What happened instead?
684 @noindent Thank you for helping to improve this mode.
686 @subsubheading How to create a useful backtrace
688 @cindex backtrace of an error
689 If working with Org produces an error with a message you don't
690 understand, you may have hit a bug. The best way to report this is by
691 providing, in addition to what was mentioned above, a @emph{backtrace}.
692 This is information from the built-in debugger about where and how the
693 error occurred. Here is how to produce a useful backtrace:
697 Reload uncompiled versions of all Org-mode Lisp files. The backtrace
698 contains much more information if it is produced with uncompiled code.
701 C-u M-x org-reload RET
704 or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the
707 Go to the @code{Options} menu and select @code{Enter Debugger on Error}
708 (XEmacs has this option in the @code{Troubleshooting} sub-menu).
710 Do whatever you have to do to hit the error. Don't forget to
711 document the steps you take.
713 When you hit the error, a @file{*Backtrace*} buffer will appear on the
714 screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and
715 attach it to your bug report.
718 @node Conventions, , Feedback, Introduction
719 @section Typesetting conventions used in this manual
721 Org uses three types of keywords: TODO keywords, tags, and property
722 names. In this manual we use the following conventions:
727 TODO keywords are written with all capitals, even if they are
731 User-defined tags are written in lowercase; built-in tags with special
732 meaning are written with all capitals.
735 User-defined properties are capitalized; built-in properties with
736 special meaning are written with all capitals.
739 @node Document Structure, Tables, Introduction, Top
740 @chapter Document Structure
741 @cindex document structure
742 @cindex structure of document
744 Org is based on Outline mode and provides flexible commands to
745 edit the structure of the document.
748 * Outlines:: Org is based on Outline mode
749 * Headlines:: How to typeset Org tree headlines
750 * Visibility cycling:: Show and hide, much simplified
751 * Motion:: Jumping to other headlines
752 * Structure editing:: Changing sequence and level of headlines
753 * Archiving:: Move done task trees to a different place
754 * Sparse trees:: Matches embedded in context
755 * Plain lists:: Additional structure within an entry
756 * Drawers:: Tucking stuff away
757 * Blocks:: Folding blocks
758 * Footnotes:: How footnotes are defined in Org's syntax
759 * Orgstruct mode:: Structure editing outside Org
762 @node Outlines, Headlines, Document Structure, Document Structure
767 Org is implemented on top of Outline mode. Outlines allow a
768 document to be organized in a hierarchical structure, which (at least
769 for me) is the best representation of notes and thoughts. An overview
770 of this structure is achieved by folding (hiding) large parts of the
771 document to show only the general document structure and the parts
772 currently being worked on. Org greatly simplifies the use of
773 outlines by compressing the entire show/hide functionality into a single
774 command, @command{org-cycle}, which is bound to the @key{TAB} key.
776 @node Headlines, Visibility cycling, Outlines, Document Structure
780 @vindex org-special-ctrl-a/e
782 Headlines define the structure of an outline tree. The headlines in
783 Org start with one or more stars, on the left margin@footnote{See
784 the variable @code{org-special-ctrl-a/e} to configure special behavior
785 of @kbd{C-a} and @kbd{C-e} in headlines.}. For example:
795 * Another top level headline
798 @noindent Some people find the many stars too noisy and would prefer an
799 outline that has whitespace followed by a single star as headline
800 starters. @ref{Clean view}, describes a setup to realize this.
802 @vindex org-cycle-separator-lines
803 An empty line after the end of a subtree is considered part of it and
804 will be hidden when the subtree is folded. However, if you leave at
805 least two empty lines, one empty line will remain visible after folding
806 the subtree, in order to structure the collapsed view. See the
807 variable @code{org-cycle-separator-lines} to modify this behavior.
809 @node Visibility cycling, Motion, Headlines, Document Structure
810 @section Visibility cycling
811 @cindex cycling, visibility
812 @cindex visibility cycling
813 @cindex trees, visibility
814 @cindex show hidden text
817 Outlines make it possible to hide parts of the text in the buffer.
818 Org uses just two commands, bound to @key{TAB} and
819 @kbd{S-@key{TAB}} to change the visibility in the buffer.
821 @cindex subtree visibility states
822 @cindex subtree cycling
823 @cindex folded, subtree visibility state
824 @cindex children, subtree visibility state
825 @cindex subtree, subtree visibility state
829 @emph{Subtree cycling}: Rotate current subtree among the states
832 ,-> FOLDED -> CHILDREN -> SUBTREE --.
833 '-----------------------------------'
836 @vindex org-cycle-emulate-tab
837 @vindex org-cycle-global-at-bob
838 The cursor must be on a headline for this to work@footnote{see, however,
839 the option @code{org-cycle-emulate-tab}.}. When the cursor is at the
840 beginning of the buffer and the first line is not a headline, then
841 @key{TAB} actually runs global cycling (see below)@footnote{see the
842 option @code{org-cycle-global-at-bob}.}. Also when called with a prefix
843 argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
845 @cindex global visibility states
846 @cindex global cycling
847 @cindex overview, global visibility state
848 @cindex contents, global visibility state
849 @cindex show all, global visibility state
853 @emph{Global cycling}: Rotate the entire buffer among the states
856 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
857 '--------------------------------------'
860 When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
861 CONTENTS view up to headlines of level N will be shown. Note that inside
862 tables, @kbd{S-@key{TAB}} jumps to the previous field.
864 @cindex show all, command
865 @kindex C-u C-u C-u @key{TAB}
866 @item C-u C-u C-u @key{TAB}
867 Show all, including drawers.
870 Reveal context around point, showing the current entry, the following heading
871 and the hierarchy above. Useful for working near a location that has been
872 exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
873 (@pxref{Agenda commands}). With a prefix argument show, on each
874 level, all sibling headings.
877 Show the current subtree in an indirect buffer@footnote{The indirect
880 (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
883 (see the Emacs manual for more information about indirect buffers)
885 will contain the entire buffer, but will be narrowed to the current
886 tree. Editing the indirect buffer will also change the original buffer,
887 but without affecting visibility in that buffer.}. With a numeric
888 prefix argument N, go up to level N and then take that tree. If N is
889 negative then go up that many levels. With a @kbd{C-u} prefix, do not remove
890 the previously used indirect buffer.
893 @vindex org-startup-folded
894 @cindex @code{overview}, STARTUP keyword
895 @cindex @code{content}, STARTUP keyword
896 @cindex @code{showall}, STARTUP keyword
897 @cindex @code{showeverything}, STARTUP keyword
899 When Emacs first visits an Org file, the global state is set to
900 OVERVIEW, @ie only the top level headlines are visible. This can be
901 configured through the variable @code{org-startup-folded}, or on a
902 per-file basis by adding one of the following lines anywhere in the
909 #+STARTUP: showeverything
912 @cindex property, VISIBILITY
914 Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
915 and Columns}) will get their visibility adapted accordingly. Allowed values
916 for this property are @code{folded}, @code{children}, @code{content}, and
919 @kindex C-u C-u @key{TAB}
920 @item C-u C-u @key{TAB}
921 Switch back to the startup visibility of the buffer, @ie whatever is
922 requested by startup options and @samp{VISIBILITY} properties in individual
926 @node Motion, Structure editing, Visibility cycling, Document Structure
928 @cindex motion, between headlines
929 @cindex jumping, to headlines
930 @cindex headline navigation
931 The following commands jump to other headlines in the buffer.
942 Next heading same level.
945 Previous heading same level.
948 Backward to higher level heading.
951 Jump to a different place without changing the current outline
952 visibility. Shows the document structure in a temporary buffer, where
953 you can use the following keys to find your destination:
954 @vindex org-goto-auto-isearch
956 @key{TAB} @r{Cycle visibility.}
957 @key{down} / @key{up} @r{Next/previous visible headline.}
958 @key{RET} @r{Select this location.}
959 @kbd{/} @r{Do a Sparse-tree search}
960 @r{The following keys work if you turn off @code{org-goto-auto-isearch}}
961 n / p @r{Next/previous visible headline.}
962 f / b @r{Next/previous headline same level.}
964 0-9 @r{Digit argument.}
967 @vindex org-goto-interface
969 See also the variable @code{org-goto-interface}.
972 @node Structure editing, Archiving, Motion, Document Structure
973 @section Structure editing
974 @cindex structure editing
975 @cindex headline, promotion and demotion
976 @cindex promotion, of subtrees
977 @cindex demotion, of subtrees
978 @cindex subtree, cut and paste
979 @cindex pasting, of subtrees
980 @cindex cutting, of subtrees
981 @cindex copying, of subtrees
982 @cindex sorting, of subtrees
983 @cindex subtrees, cut and paste
988 @vindex org-M-RET-may-split-line
989 Insert new heading with same level as current. If the cursor is in a
990 plain list item, a new item is created (@pxref{Plain lists}). To force
991 creation of a new headline, use a prefix argument, or first press @key{RET}
992 to get to the beginning of the next line. When this command is used in
993 the middle of a line, the line is split and the rest of the line becomes
994 the new headline@footnote{If you do not want the line to be split,
995 customize the variable @code{org-M-RET-may-split-line}.}. If the
996 command is used at the beginning of a headline, the new headline is
997 created before the current line. If at the beginning of any other line,
998 the content of that line is made the new heading. If the command is
999 used at the end of a folded subtree (@ie behind the ellipses at the end
1000 of a headline), then a headline like the current one will be inserted
1001 after the end of the subtree.
1004 Just like @kbd{M-@key{RET}}, except when adding a new heading below the
1005 current heading, the new heading is placed after the body instead of before
1006 it. This command works from anywhere in the entry.
1007 @kindex M-S-@key{RET}
1009 @vindex org-treat-insert-todo-heading-as-state-change
1010 Insert new TODO entry with same level as current heading. See also the
1011 variable @code{org-treat-insert-todo-heading-as-state-change}.
1012 @kindex C-S-@key{RET}
1014 Insert new TODO entry with same level as current heading. Like
1015 @kbd{C-@key{RET}}, the new headline will be inserted after the current
1017 @kindex M-@key{left}
1019 Promote current heading by one level.
1020 @kindex M-@key{right}
1022 Demote current heading by one level.
1023 @kindex M-S-@key{left}
1024 @item M-S-@key{left}
1025 Promote the current subtree by one level.
1026 @kindex M-S-@key{right}
1027 @item M-S-@key{right}
1028 Demote the current subtree by one level.
1029 @kindex M-S-@key{up}
1031 Move subtree up (swap with previous subtree of same
1033 @kindex M-S-@key{down}
1034 @item M-S-@key{down}
1035 Move subtree down (swap with next subtree of same level).
1038 Kill subtree, @ie remove it from buffer but save in kill ring.
1039 With a numeric prefix argument N, kill N sequential subtrees.
1042 Copy subtree to kill ring. With a numeric prefix argument N, copy the N
1043 sequential subtrees.
1046 Yank subtree from kill ring. This does modify the level of the subtree to
1047 make sure the tree fits in nicely at the yank position. The yank level can
1048 also be specified with a numeric prefix argument, or by yanking after a
1049 headline marker like @samp{****}.
1052 @vindex org-yank-adjusted-subtrees
1053 @vindex org-yank-folded-subtrees
1054 Depending on the variables @code{org-yank-adjusted-subtrees} and
1055 @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
1056 paste subtrees folded and in a clever way, using the same command as @kbd{C-c
1057 C-x C-y}. With the default settings, no level adjustment will take place,
1058 but the yanked tree will be folded unless doing so would swallow text
1059 previously visible. Any prefix argument to this command will force a normal
1060 @code{yank} to be executed, with the prefix passed along. A good way to
1061 force a normal yank is @kbd{C-u C-y}. If you use @code{yank-pop} after a
1062 yank, it will yank previous kill items plainly, without adjustment and
1066 Clone a subtree by making a number of sibling copies of it. You will be
1067 prompted for the number of copies to make, and you can also specify if any
1068 timestamps in the entry should be shifted. This can be useful, for example,
1069 to create a number of tasks related to a series of lectures to prepare. For
1070 more details, see the docstring of the command
1071 @code{org-clone-subtree-with-time-shift}.
1074 Refile entry or region to a different location. @xref{Refiling notes}.
1077 Sort same-level entries. When there is an active region, all entries in the
1078 region will be sorted. Otherwise the children of the current headline are
1079 sorted. The command prompts for the sorting method, which can be
1080 alphabetically, numerically, by time (first timestamp with active preferred,
1081 creation time, scheduled time, deadline time), by priority, by TODO keyword
1082 (in the sequence the keywords have been defined in the setup) or by the value
1083 of a property. Reverse sorting is possible as well. You can also supply
1084 your own function to extract the sorting key. With a @kbd{C-u} prefix,
1085 sorting will be case-sensitive. With two @kbd{C-u C-u} prefixes, duplicate
1086 entries will also be removed.
1089 Narrow buffer to current subtree.
1092 Widen buffer to remove narrowing.
1095 Turn a normal line or plain list item into a headline (so that it becomes a
1096 subheading at its location). Also turn a headline into a normal line by
1097 removing the stars. If there is an active region, turn all lines in the
1098 region into headlines. If the first line in the region was an item, turn
1099 only the item lines into headlines. Finally, if the first line is a
1100 headline, remove the stars from all headlines in the region.
1103 @cindex region, active
1104 @cindex active region
1105 @cindex transient mark mode
1106 When there is an active region (Transient Mark mode), promotion and
1107 demotion work on all headlines in the region. To select a region of
1108 headlines, it is best to place both point and mark at the beginning of a
1109 line, mark at the beginning of the first headline, and point at the line
1110 just after the last headline to change. Note that when the cursor is
1111 inside a table (@pxref{Tables}), the Meta-Cursor keys have different
1114 @node Archiving, Sparse trees, Structure editing, Document Structure
1118 When a project represented by a (sub)tree is finished, you may want
1119 to move the tree out of the way and to stop it from contributing to the
1120 agenda. Org mode knows two ways of archiving. You can mark a tree with
1121 the ARCHIVE tag, or you can move an entire (sub)tree to a different
1125 * ARCHIVE tag:: Marking a tree as inactive
1126 * Moving subtrees:: Moving a tree to an archive file
1129 @node ARCHIVE tag, Moving subtrees, Archiving, Archiving
1130 @subsection The ARCHIVE tag
1131 @cindex internal archiving
1133 A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
1134 its location in the outline tree, but behaves in the following way:
1137 @vindex org-cycle-open-archived-trees
1138 It does not open when you attempt to do so with a visibility cycling
1139 command (@pxref{Visibility cycling}). You can force cycling archived
1140 subtrees with @kbd{C-@key{TAB}}, or by setting the option
1141 @code{org-cycle-open-archived-trees}. Also normal outline commands like
1142 @code{show-all} will open archived subtrees.
1144 @vindex org-sparse-tree-open-archived-trees
1145 During sparse tree construction (@pxref{Sparse trees}), matches in
1146 archived subtrees are not exposed, unless you configure the option
1147 @code{org-sparse-tree-open-archived-trees}.
1149 @vindex org-agenda-skip-archived-trees
1150 During agenda view construction (@pxref{Agenda Views}), the content of
1151 archived trees is ignored unless you configure the option
1152 @code{org-agenda-skip-archived-trees}, in which case these trees will always
1153 be included. In the agenda you can press the @kbd{v} key to get archives
1154 temporarily included.
1156 @vindex org-export-with-archived-trees
1157 Archived trees are not exported (@pxref{Exporting}), only the headline
1158 is. Configure the details using the variable
1159 @code{org-export-with-archived-trees}.
1161 @vindex org-columns-skip-arrchived-trees
1162 Archived trees are excluded from column view unless the variable
1163 @code{org-columns-skip-arrchived-trees} is configured to @code{nil}.
1166 The following commands help managing the ARCHIVE tag:
1171 Toggle the ARCHIVE tag for the current headline. When the tag is set,
1172 the headline changes to a shadowed face, and the subtree below it is
1174 @kindex C-u C-c C-x a
1176 Check if any direct children of the current headline should be archived.
1177 To do this, each subtree is checked for open TODO entries. If none are
1178 found, the command offers to set the ARCHIVE tag for the child. If the
1179 cursor is @emph{not} on a headline when this command is invoked, the
1180 level 1 trees will be checked.
1183 Cycle a tree even if it is tagged with ARCHIVE.
1186 @node Moving subtrees, , ARCHIVE tag, Archiving
1187 @subsection Moving subtrees
1188 @cindex external archiving
1190 Once an entire project is finished, you may want to move it to a different
1191 location. Org can move it to an @emph{Archive Sibling} in the same tree, to a
1192 different tree in the current file, or to a different file, the archive file.
1197 Move the current entry to the @emph{Archive Sibling}. This is a sibling of
1198 the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}
1199 (@pxref{ARCHIVE tag}). The entry becomes a child of that sibling and in this
1200 way retains a lot of its original context, including inherited tags and
1201 approximate position in the outline.
1206 @vindex org-archive-location
1207 Archive the subtree starting at the cursor position to the location
1208 given by @code{org-archive-location}. Context information that could be
1209 lost, like the file name, the category, inherited tags, and the TODO
1210 state will be stored as properties in the entry.
1211 @kindex C-u C-c C-x C-s
1212 @item C-u C-c C-x C-s
1213 Check if any direct children of the current headline could be moved to
1214 the archive. To do this, each subtree is checked for open TODO entries.
1215 If none are found, the command offers to move it to the archive
1216 location. If the cursor is @emph{not} on a headline when this command
1217 is invoked, the level 1 trees will be checked.
1220 @cindex archive locations
1221 The default archive location is a file in the same directory as the
1222 current file, with the name derived by appending @file{_archive} to the
1223 current file name. For information and examples on how to change this,
1224 see the documentation string of the variable
1225 @code{org-archive-location}. There is also an in-buffer option for
1226 setting this variable, for example@footnote{For backward compatibility,
1227 the following also works: If there are several such lines in a file,
1228 each specifies the archive location for the text below it. The first
1229 such line also applies to any text before its definition. However,
1230 using this method is @emph{strongly} deprecated as it is incompatible
1231 with the outline structure of the document. The correct method for
1232 setting multiple archive locations in a buffer is using properties.}:
1236 #+ARCHIVE: %s_done::
1239 @cindex property, ARCHIVE
1241 If you would like to have a special ARCHIVE location for a single entry
1242 or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
1243 location as the value (@pxref{Properties and Columns}).
1245 @vindex org-archive-save-context-info
1246 When a subtree is moved, it receives a number of special properties that
1247 record context information like the file from where the entry came, its
1248 outline path the archiving time etc. Configure the variable
1249 @code{org-archive-save-context-info} to adjust the amount of information
1252 @node Sparse trees, Plain lists, Archiving, Document Structure
1253 @section Sparse trees
1254 @cindex sparse trees
1255 @cindex trees, sparse
1256 @cindex folding, sparse trees
1257 @cindex occur, command
1259 @vindex org-show-hierarchy-above
1260 @vindex org-show-following-heading
1261 @vindex org-show-siblings
1262 @vindex org-show-entry-below
1263 An important feature of Org mode is the ability to construct @emph{sparse
1264 trees} for selected information in an outline tree, so that the entire
1265 document is folded as much as possible, but the selected information is made
1266 visible along with the headline structure above it@footnote{See also the
1267 variables @code{org-show-hierarchy-above}, @code{org-show-following-heading},
1268 @code{org-show-siblings}, and @code{org-show-entry-below} for detailed
1269 control on how much context is shown around each match.}. Just try it out
1270 and you will see immediately how it works.
1272 Org mode contains several commands creating such trees, all these
1273 commands can be accessed through a dispatcher:
1278 This prompts for an extra key to select a sparse-tree creating command.
1281 @vindex org-remove-highlights-with-change
1282 Occur. Prompts for a regexp and shows a sparse tree with all matches. If
1283 the match is in a headline, the headline is made visible. If the match is in
1284 the body of an entry, headline and body are made visible. In order to
1285 provide minimal context, also the full hierarchy of headlines above the match
1286 is shown, as well as the headline following the match. Each match is also
1287 highlighted; the highlights disappear when the buffer is changed by an
1288 editing command@footnote{This depends on the option
1289 @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
1290 When called with a @kbd{C-u} prefix argument, previous highlights are kept,
1291 so several calls to this command can be stacked.
1295 @vindex org-agenda-custom-commands
1296 For frequently used sparse trees of specific search strings, you can
1297 use the variable @code{org-agenda-custom-commands} to define fast
1298 keyboard access to specific sparse trees. These commands will then be
1299 accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
1303 (setq org-agenda-custom-commands
1304 '(("f" occur-tree "FIXME")))
1307 @noindent will define the key @kbd{C-c a f} as a shortcut for creating
1308 a sparse tree matching the string @samp{FIXME}.
1310 The other sparse tree commands select headings based on TODO keywords,
1311 tags, or properties and will be discussed later in this manual.
1314 @cindex printing sparse trees
1315 @cindex visible text, printing
1316 To print a sparse tree, you can use the Emacs command
1317 @code{ps-print-buffer-with-faces} which does not print invisible parts
1318 of the document @footnote{This does not work under XEmacs, because
1319 XEmacs uses selective display for outlining, not text properties.}.
1320 Or you can use the command @kbd{C-c C-e v} to export only the visible
1321 part of the document and print the resulting file.
1323 @node Plain lists, Drawers, Sparse trees, Document Structure
1324 @section Plain lists
1326 @cindex lists, plain
1327 @cindex lists, ordered
1328 @cindex ordered lists
1330 Within an entry of the outline tree, hand-formatted lists can provide
1331 additional structure. They also provide a way to create lists of
1332 checkboxes (@pxref{Checkboxes}). Org supports editing such lists,
1333 and the HTML exporter (@pxref{Exporting}) parses and formats them.
1335 Org knows ordered lists, unordered lists, and description lists.
1338 @emph{Unordered} list items start with @samp{-}, @samp{+}, or
1339 @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
1340 they will be seen as top-level headlines. Also, when you are hiding leading
1341 stars to get a clean outline view, plain list items starting with a star are
1342 visually indistinguishable from true headlines. In short: even though
1343 @samp{*} is supported, it may be better to not use it for plain list items.}
1346 @emph{Ordered} list items start with a numeral followed by either a period or
1347 a right parenthesis, such as @samp{1.} or @samp{1)}.
1349 @emph{Description} list items are like unordered list items, but contain the
1350 separator @samp{ :: } to separate the description @emph{term} from the
1354 @vindex org-empty-line-terminates-plain-lists
1355 Items belonging to the same list must have the same indentation on the first
1356 line. In particular, if an ordered list reaches number @samp{10.}, then the
1357 2--digit numbers must be written left-aligned with the other numbers in the
1358 list. Indentation also determines the end of a list item. It ends before
1359 the next line that is indented like the bullet/number, or less. Empty lines
1360 are part of the previous item, so you can have several paragraphs in one
1361 item. If you would like an empty line to terminate all currently open plain
1362 lists, configure the variable @code{org-empty-line-terminates-plain-lists}.
1367 ** Lord of the Rings
1368 My favorite scenes are (in this order)
1369 1. The attack of the Rohirrim
1370 2. Eowyn's fight with the witch king
1371 + this was already my favorite scene in the book
1372 + I really like Miranda Otto.
1373 3. Peter Jackson being shot by Legolas
1375 He makes a really funny face when it happens.
1376 But in the end, no individual scenes matter but the film as a whole.
1377 Important actors in this film are:
1378 - @b{Elijah Wood} :: He plays Frodo
1379 - @b{Sean Austin} :: He plays Sam, Frodo's friend. I still remember
1380 him very well from his role as Mikey Walsh in @i{The Goonies}.
1384 Org supports these lists by tuning filling and wrapping commands to deal with
1385 them correctly@footnote{Org only changes the filling settings for Emacs. For
1386 XEmacs, you should use Kyle E. Jones' @file{filladapt.el}. To turn this on,
1387 put into @file{.emacs}: @code{(require 'filladapt)}}, and by exporting them
1388 properly (@pxref{Exporting}). Since indentation is what governs the
1389 structure of these lists, many structural constructs like @code{#+BEGIN_...}
1390 blocks can be indented to signal that they should be part of a list item.
1392 The following commands act on items when the cursor is in the first line
1393 of an item (the line with the bullet or number).
1398 @vindex org-cycle-include-plain-lists
1399 Items can be folded just like headline levels. Normally this works only if
1400 the cursor is on a plain list item. For more details, see the variable
1401 @code{org-cycle-include-plain-lists}. to @code{integrate}, plain list items
1402 will be treated like low-level. The level of an item is then given by the
1403 indentation of the bullet/number. Items are always subordinate to real
1404 headlines, however; the hierarchies remain completely separated.
1406 If @code{org-cycle-include-plain-lists} has not been set, @key{TAB}
1407 fixes the indentation of the current line in a heuristic way.
1410 @vindex org-M-RET-may-split-line
1411 Insert new item at current level. With a prefix argument, force a new
1412 heading (@pxref{Structure editing}). If this command is used in the middle
1413 of a line, the line is @emph{split} and the rest of the line becomes the new
1414 item@footnote{If you do not want the line to be split, customize the variable
1415 @code{org-M-RET-may-split-line}.}. If this command is executed in the
1416 @emph{whitespace before a bullet or number}, the new item is created
1417 @emph{before} the current item. If the command is executed in the white
1418 space before the text that is part of an item but does not contain the
1419 bullet, a bullet is added to the current line.
1420 @kindex M-S-@key{RET}
1422 Insert a new item with a checkbox (@pxref{Checkboxes}).
1424 @kindex S-@key{down}
1427 @cindex shift-selection-mode
1428 @vindex org-support-shift-select
1429 Jump to the previous/next item in the current list, but only if
1430 @code{org-support-shift-select} is off. If not, you can still use paragraph
1431 jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite
1433 @kindex M-S-@key{up}
1434 @kindex M-S-@key{down}
1436 @itemx M-S-@key{down}
1437 Move the item including subitems up/down (swap with previous/next item
1438 of same indentation). If the list is ordered, renumbering is
1440 @kindex M-S-@key{left}
1441 @kindex M-S-@key{right}
1442 @item M-S-@key{left}
1443 @itemx M-S-@key{right}
1444 Decrease/increase the indentation of the item, including subitems.
1445 Initially, the item tree is selected based on current indentation.
1446 When these commands are executed several times in direct succession,
1447 the initially selected region is used, even if the new indentation
1448 would imply a different hierarchy. To use the new hierarchy, break
1449 the command chain with a cursor motion or so.
1452 If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
1453 state of the checkbox. If not, this command makes sure that all the
1454 items on this list level use the same bullet. Furthermore, if this is
1455 an ordered list, make sure the numbering is OK.
1458 Cycle the entire list level through the different itemize/enumerate bullets
1459 (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}). With a numeric prefix
1460 argument N, select the Nth bullet from this list. If there is an active
1461 region when calling this, all lines will be converted to list items. If the
1462 first line already was a list item, any item markers will be removed from the
1463 list. Finally, even without an active region, a normal line will be
1464 converted into a list item.
1467 Turn a plain list item into a headline (so that it becomes a subheading at
1468 its location). @xref{Structure editing}, for a detailed explanation.
1469 @kindex S-@key{left}
1470 @kindex S-@key{right}
1471 @item S-@key{left}/@key{right}
1472 @vindex org-support-shift-select
1473 This command also cycles bullet styles when the cursor in on the bullet or
1474 anywhere in an item line, details depending on
1475 @code{org-support-shift-select}.
1478 Sort the plain list. You will be prompted for the sorting method:
1479 numerically, alphabetically, by time, or by custom function.
1482 @node Drawers, Blocks, Plain lists, Document Structure
1486 @cindex visibility cycling, drawers
1489 Sometimes you want to keep information associated with an entry, but you
1490 normally don't want to see it. For this, Org mode has @emph{drawers}.
1491 Drawers need to be configured with the variable
1492 @code{org-drawers}@footnote{You can define drawers on a per-file basis
1493 with a line like @code{#+DRAWERS: HIDDEN PROPERTIES STATE}}. Drawers
1497 ** This is a headline
1498 Still outside the drawer
1500 This is inside the drawer.
1505 Visibility cycling (@pxref{Visibility cycling}) on the headline will hide and
1506 show the entry, but keep the drawer collapsed to a single line. In order to
1507 look inside the drawer, you need to move the cursor to the drawer line and
1508 press @key{TAB} there. Org mode uses the @code{PROPERTIES} drawer for
1509 storing properties (@pxref{Properties and Columns}), and you can also arrange
1510 for state change notes (@pxref{Tracking TODO state changes}) and clock times
1511 (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}.
1513 @node Blocks, Footnotes, Drawers, Document Structure
1516 @vindex org-hide-block-startup
1517 @cindex blocks, folding
1518 Org-mode uses begin...end blocks for various purposes from including source
1519 code examples (@pxref{Literal examples}) to capturing time logging
1520 information (@pxref{Clocking work time}). These blocks can be folded and
1521 unfolded by pressing TAB in the begin line. You can also get all blocks
1522 folded at startup by configuring the variable @code{org-hide-block-startup}
1523 or on a per-file basis by using
1525 @cindex @code{hideblocks}, STARTUP keyword
1526 @cindex @code{nohideblocks}, STARTUP keyword
1528 #+STARTUP: hideblocks
1529 #+STARTUP: nohideblocks
1532 @node Footnotes, Orgstruct mode, Blocks, Document Structure
1536 Org mode supports the creation of footnotes. In contrast to the
1537 @file{footnote.el} package, Org mode's footnotes are designed for work on a
1538 larger document, not only for one-off documents like emails. The basic
1539 syntax is similar to the one used by @file{footnote.el}, @ie a footnote is
1540 defined in a paragraph that is started by a footnote marker in square
1541 brackets in column 0, no indentation allowed. If you need a paragraph break
1542 inside a footnote, use the La@TeX{} idiom @samp{\par}. The footnote reference
1543 is simply the marker in square brackets, inside text. For example:
1546 The Org homepage[fn:1] now looks a lot better than it used to.
1548 [fn:1] The link is: http://orgmode.org
1551 Org mode extends the number-based syntax to @emph{named} footnotes and
1552 optional inline definition. Using plain numbers as markers (as
1553 @file{footnote.el} does) is supported for backward compatibility, but not
1554 encouraged because of possible conflicts with La@TeX{} snippets (@pxref{Embedded
1555 LaTeX}). Here are the valid references:
1559 A plain numeric footnote marker. Compatible with @file{footnote.el}, but not
1560 recommended because somthing like @samp{[1]} could easily be part of a code
1563 A named footnote reference, where @code{name} is a unique label word, or, for
1564 simplicity of automatic creation, a number.
1565 @item [fn:: This is the inline definition of this footnote]
1566 A La@TeX{}-like anonymous footnote where the definition is given directly at the
1568 @item [fn:name: a definition]
1569 An inline definition of a footnote, which also specifies a name for the note.
1570 Since Org allows multiple references to the same note, you can then use
1571 @code{[fn:name]} to create additional references.
1574 @vindex org-footnote-auto-label
1575 Footnote labels can be created automatically, or you can create names yourself.
1576 This is handled by the variable @code{org-footnote-auto-label} and its
1577 corresponding @code{#+STARTUP} keywords, see the docstring of that variable
1580 @noindent The following command handles footnotes:
1585 The footnote action command.
1587 When the cursor is on a footnote reference, jump to the definition. When it
1588 is at a definition, jump to the (first) reference.
1590 @vindex org-footnote-define-inline
1591 @vindex org-footnote-section
1592 @vindex org-footnote-auto-adjust
1593 Otherwise, create a new footnote. Depending on the variable
1594 @code{org-footnote-define-inline}@footnote{The corresponding in-buffer
1595 setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
1596 definition will be placed right into the text as part of the reference, or
1597 separately into the location determined by the variable
1598 @code{org-footnote-section}.
1600 When this command is called with a prefix argument, a menu of additional
1603 s @r{Sort the footnote definitions by reference sequence. During editing,}
1604 @r{Org makes no effort to sort footnote definitions into a particular}
1605 @r{sequence. If you want them sorted, use this command, which will}
1606 @r{also move entries according to @code{org-footnote-section}. Automatic}
1607 @r{sorting after each insertion/deletion can be configured using the}
1608 @r{variable @code{org-footnote-auto-adjust}.}
1609 r @r{Renumber the simple @code{fn:N} footnotes. Automatic renumbering}
1610 @r{after each insertion/deletion can be configured using the variable}
1611 @r{@code{org-footnote-auto-adjust}.}
1612 S @r{Short for first @code{r}, then @code{s} action.}
1613 n @r{Normalize the footnotes by collecting all definitions (including}
1614 @r{inline definitions) into a special section, and then numbering them}
1615 @r{in sequence. The references will then also be numbers. This is}
1616 @r{meant to be the final step before finishing a document (e.g. sending}
1617 @r{off an email). The exporters do this automatically, and so could}
1618 @r{something like @code{message-send-hook}.}
1619 d @r{Delete the footnote at point, and all definitions of and references}
1622 Depending on the variable @code{org-footnote-auto-adjust}@footnote{the
1623 corresponding in-buffer options are @code{fnadjust} and @code{nofnadjust}.},
1624 renumbering and sorting footnotes can be automatic after each insertion or
1629 If the cursor is on a footnote reference, jump to the definition. If it is a
1630 the definition, jump back to the reference. When called at a footnote
1631 location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
1635 @item C-c C-o @r{or} mouse-1/2
1636 Footnote labels are also links to the corresponding definition/reference, and
1637 you can use the usual commands to follow these links.
1640 @node Orgstruct mode, , Footnotes, Document Structure
1641 @section The Orgstruct minor mode
1642 @cindex Orgstruct mode
1643 @cindex minor mode for structure editing
1645 If you like the intuitive way the Org mode structure editing and list
1646 formatting works, you might want to use these commands in other modes like
1647 Text mode or Mail mode as well. The minor mode @code{orgstruct-mode} makes
1648 this possible. Toggle the mode with @kbd{M-x orgstruct-mode}, or
1649 turn it on by default, for example in Mail mode, with one of:
1652 (add-hook 'mail-mode-hook 'turn-on-orgstruct)
1653 (add-hook 'mail-mode-hook 'turn-on-orgstruct++)
1656 When this mode is active and the cursor is on a line that looks to Org like a
1657 headline or the first line of a list item, most structure editing commands
1658 will work, even if the same keys normally have different functionality in the
1659 major mode you are using. If the cursor is not in one of those special
1660 lines, Orgstruct mode lurks silently in the shadow. When you use
1661 @code{orgstruct++-mode}, Org will also export indentation and autofill
1662 settings into that mode, and detect item context after the first line of an
1665 @node Tables, Hyperlinks, Document Structure, Top
1668 @cindex editing tables
1670 Org comes with a fast and intuitive table editor. Spreadsheet-like
1671 calculations are supported in connection with the Emacs @file{calc}
1674 (@pxref{Top,Calc,,Calc,Gnu Emacs Calculator Manual}).
1677 (see the Emacs Calculator manual for more information about the Emacs
1682 * Built-in table editor:: Simple tables
1683 * Column width and alignment:: Overrule the automatic settings
1684 * Column groups:: Grouping to trigger vertical lines
1685 * Orgtbl mode:: The table editor as minor mode
1686 * The spreadsheet:: The table editor has spreadsheet capabilities
1687 * Org-Plot:: Plotting from org tables
1690 @node Built-in table editor, Column width and alignment, Tables, Tables
1691 @section The built-in table editor
1692 @cindex table editor, built-in
1694 Org makes it easy to format tables in plain ASCII. Any line with
1695 @samp{|} as the first non-whitespace character is considered part of a
1696 table. @samp{|} is also the column separator. A table might look like
1700 | Name | Phone | Age |
1701 |-------+-------+-----|
1702 | Peter | 1234 | 17 |
1703 | Anna | 4321 | 25 |
1706 A table is re-aligned automatically each time you press @key{TAB} or
1707 @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to
1708 the next field (@key{RET} to the next row) and creates new table rows
1709 at the end of the table or before horizontal lines. The indentation
1710 of the table is set by the first line. Any line starting with
1711 @samp{|-} is considered as a horizontal separator line and will be
1712 expanded on the next re-align to span the whole table width. So, to
1713 create the above table, you would only type
1720 @noindent and then press @key{TAB} to align the table and start filling in
1721 fields. Even faster would be to type @code{|Name|Phone|Age} followed by
1722 @kbd{C-c @key{RET}}.
1724 @vindex org-enable-table-editor
1725 @vindex org-table-auto-blank-field
1726 When typing text into a field, Org treats @key{DEL},
1727 @key{Backspace}, and all character keys in a special way, so that
1728 inserting and deleting avoids shifting other fields. Also, when
1729 typing @emph{immediately after the cursor was moved into a new field
1730 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
1731 field is automatically made blank. If this behavior is too
1732 unpredictable for you, configure the variables
1733 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
1736 @tsubheading{Creation and conversion}
1739 Convert the active region to table. If every line contains at least one
1740 TAB character, the function assumes that the material is tab separated.
1741 If every line contains a comma, comma-separated values (CSV) are assumed.
1742 If not, lines are split at whitespace into fields. You can use a prefix
1743 argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
1744 C-u} forces TAB, and a numeric argument N indicates that at least N
1745 consecutive spaces, or alternatively a TAB will be the separator.
1747 If there is no active region, this command creates an empty Org
1748 table. But it's easier just to start typing, like
1749 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
1751 @tsubheading{Re-aligning and field motion}
1754 Re-align the table without moving the cursor.
1758 Re-align the table, move to the next field. Creates a new row if
1763 Re-align, move to previous field.
1767 Re-align the table and move down to next row. Creates a new row if
1768 necessary. At the beginning or end of a line, @key{RET} still does
1769 NEWLINE, so it can be used to split a table.
1773 Move to beginning of the current table field, or on to the previous field.
1776 Move to end of the current table field, or on to the next field.
1778 @tsubheading{Column and row editing}
1779 @kindex M-@key{left}
1780 @kindex M-@key{right}
1782 @itemx M-@key{right}
1783 Move the current column left/right.
1785 @kindex M-S-@key{left}
1786 @item M-S-@key{left}
1787 Kill the current column.
1789 @kindex M-S-@key{right}
1790 @item M-S-@key{right}
1791 Insert a new column to the left of the cursor position.
1794 @kindex M-@key{down}
1797 Move the current row up/down.
1799 @kindex M-S-@key{up}
1801 Kill the current row or horizontal line.
1803 @kindex M-S-@key{down}
1804 @item M-S-@key{down}
1805 Insert a new row above the current row. With a prefix argument, the line is
1806 created below the current one.
1810 Insert a horizontal line below current row. With a prefix argument, the line
1811 is created above the current line.
1813 @kindex C-c @key{RET}
1815 Insert a horizontal line below current row, and move the cursor into the row
1820 Sort the table lines in the region. The position of point indicates the
1821 column to be used for sorting, and the range of lines is the range
1822 between the nearest horizontal separator lines, or the entire table. If
1823 point is before the first column, you will be prompted for the sorting
1824 column. If there is an active region, the mark specifies the first line
1825 and the sorting column, while point should be in the last line to be
1826 included into the sorting. The command prompts for the sorting type
1827 (alphabetically, numerically, or by time). When called with a prefix
1828 argument, alphabetic sorting will be case-sensitive.
1830 @tsubheading{Regions}
1833 Copy a rectangular region from a table to a special clipboard. Point and
1834 mark determine edge fields of the rectangle. If there is no active region,
1835 copy just the current field. The process ignores horizontal separator lines.
1839 Copy a rectangular region from a table to a special clipboard, and
1840 blank all fields in the rectangle. So this is the ``cut'' operation.
1844 Paste a rectangular region into a table.
1845 The upper left corner ends up in the current field. All involved fields
1846 will be overwritten. If the rectangle does not fit into the present table,
1847 the table is enlarged as needed. The process ignores horizontal separator
1852 Wrap several fields in a column like a paragraph. If there is an active
1853 region, and both point and mark are in the same column, the text in the
1854 column is wrapped to minimum width for the given number of lines. A numeric
1855 prefix argument may be used to change the number of desired lines. If there
1856 is no region, the current field is split at the cursor position and the text
1857 fragment to the right of the cursor is prepended to the field one line
1858 down. If there is no region, but you specify a prefix argument, the current
1859 field is made blank, and the content is appended to the field above.
1861 @tsubheading{Calculations}
1862 @cindex formula, in tables
1863 @cindex calculations, in tables
1864 @cindex region, active
1865 @cindex active region
1866 @cindex transient mark mode
1869 Sum the numbers in the current column, or in the rectangle defined by
1870 the active region. The result is shown in the echo area and can
1871 be inserted with @kbd{C-y}.
1875 @vindex org-table-copy-increment
1876 When current field is empty, copy from first non-empty field above. When not
1877 empty, copy current field down to next row and move cursor along with it.
1878 Depending on the variable @code{org-table-copy-increment}, integer field
1879 values will be incremented during copy. Integers that are too large will not
1880 be incremented. Also, a @code{0} prefix argument temporarily disables the
1881 increment. This key is also used by shift-selection and related modes
1882 (@pxref{Conflicts}).
1884 @tsubheading{Miscellaneous}
1887 Edit the current field in a separate window. This is useful for fields that
1888 are not fully visible (@pxref{Column width and alignment}). When called with
1889 a @kbd{C-u} prefix, just make the full field visible, so that it can be
1892 @item M-x org-table-import
1893 Import a file as a table. The table should be TAB or whitespace
1894 separated. Use, for example, to import a spreadsheet table or data
1895 from a database, because these programs generally can write
1896 TAB-separated text files. This command works by inserting the file into
1897 the buffer and then converting the region to a table. Any prefix
1898 argument is passed on to the converter, which uses it to determine the
1901 Tables can also be imported by pasting tabular text into the Org
1902 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
1903 @kbd{C-c |} command (see above under @i{Creation and conversion}).
1905 @item M-x org-table-export
1906 @vindex org-table-export-default-format
1907 Export the table, by default as a TAB-separated file. Use for data
1908 exchange with, for example, spreadsheet or database programs. The format
1909 used to export the file can be configured in the variable
1910 @code{org-table-export-default-format}. You may also use properties
1911 @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
1912 name and the format for table export in a subtree. Org supports quite
1913 general formats for exported tables. The exporter format is the same as the
1914 format used by Orgtbl radio tables, see @ref{Translator functions}, for a
1915 detailed description.
1918 If you don't like the automatic table editor because it gets in your
1919 way on lines which you would like to start with @samp{|}, you can turn
1923 (setq org-enable-table-editor nil)
1926 @noindent Then the only table command that still works is
1927 @kbd{C-c C-c} to do a manual re-align.
1929 @node Column width and alignment, Column groups, Built-in table editor, Tables
1930 @section Column width and alignment
1931 @cindex narrow columns in tables
1932 @cindex alignment in tables
1934 The width of columns is automatically determined by the table editor. And
1935 also the alignment of a column is determined automatically from the fraction
1936 of number-like versus non-number fields in the column.
1938 Sometimes a single field or a few fields need to carry more text,
1939 leading to inconveniently wide columns. To limit@footnote{This feature
1940 does not work on XEmacs.} the width of a column, one field anywhere in
1941 the column may contain just the string @samp{<N>} where @samp{N} is an
1942 integer specifying the width of the column in characters. The next
1943 re-align will then set the width of this column to no more than this
1948 |---+------------------------------| |---+--------|
1950 | 1 | one | | 1 | one |
1951 | 2 | two | ----\ | 2 | two |
1952 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
1953 | 4 | four | | 4 | four |
1954 |---+------------------------------| |---+--------|
1959 Fields that are wider become clipped and end in the string @samp{=>}.
1960 Note that the full text is still in the buffer, it is only invisible.
1961 To see the full text, hold the mouse over the field---a tool-tip window
1962 will show the full content. To edit such a field, use the command
1963 @kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will
1964 open a new window with the full field. Edit it and finish with @kbd{C-c
1967 @vindex org-startup-align-all-tables
1968 When visiting a file containing a table with narrowed columns, the
1969 necessary character hiding has not yet happened, and the table needs to
1970 be aligned before it looks nice. Setting the option
1971 @code{org-startup-align-all-tables} will realign all tables in a file
1972 upon visiting, but also slow down startup. You can also set this option
1973 on a per-file basis with:
1980 If you would like to overrule the automatic alignment of number-rich columns
1981 to the right and of string-rich column to the left, you and use @samp{<r>} or
1982 @samp{<l>} in a similar fashion. You may also combine alignment and field
1983 width like this: @samp{<l10>}.
1985 @node Column groups, Orgtbl mode, Column width and alignment, Tables
1986 @section Column groups
1987 @cindex grouping columns in tables
1989 When Org exports tables, it does so by default without vertical
1990 lines because that is visually more satisfying in general. Occasionally
1991 however, vertical lines can be useful to structure a table into groups
1992 of columns, much like horizontal lines can do for groups of rows. In
1993 order to specify column groups, you can use a special row where the
1994 first field contains only @samp{/}. The further fields can either
1995 contain @samp{<} to indicate that this column should start a group,
1996 @samp{>} to indicate the end of a column, or @samp{<>} to make a column
1997 a group of its own. Boundaries between column groups will upon export be
1998 marked with vertical lines. Here is an example:
2001 | | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2002 |---+----+-----+-----+-----+---------+------------|
2003 | / | <> | < | | > | < | > |
2004 | # | 1 | 1 | 1 | 1 | 1 | 1 |
2005 | # | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
2006 | # | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
2007 |---+----+-----+-----+-----+---------+------------|
2008 #+TBLFM: $3=$2^2::$4=$2^3::$5=$2^4::$6=sqrt($2)::$7=sqrt(sqrt(($2)))
2011 It is also sufficient to just insert the column group starters after
2012 every vertical line you'd like to have:
2015 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2016 |----+-----+-----+-----+---------+------------|
2020 @node Orgtbl mode, The spreadsheet, Column groups, Tables
2021 @section The Orgtbl minor mode
2023 @cindex minor mode for tables
2025 If you like the intuitive way the Org table editor works, you
2026 might also want to use it in other modes like Text mode or Mail mode.
2027 The minor mode Orgtbl mode makes this possible. You can always toggle
2028 the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for
2029 example in mail mode, use
2032 (add-hook 'mail-mode-hook 'turn-on-orgtbl)
2035 Furthermore, with some special setup, it is possible to maintain tables
2036 in arbitrary syntax with Orgtbl mode. For example, it is possible to
2037 construct La@TeX{} tables with the underlying ease and power of
2038 Orgtbl mode, including spreadsheet capabilities. For details, see
2039 @ref{Tables in arbitrary syntax}.
2041 @node The spreadsheet, Org-Plot, Orgtbl mode, Tables
2042 @section The spreadsheet
2043 @cindex calculations, in tables
2044 @cindex spreadsheet capabilities
2045 @cindex @file{calc} package
2047 The table editor makes use of the Emacs @file{calc} package to implement
2048 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
2049 derive fields from other fields. While fully featured, Org's
2050 implementation is not identical to other spreadsheets. For example,
2051 Org knows the concept of a @emph{column formula} that will be
2052 applied to all non-header fields in a column without having to copy the
2053 formula to each relevant field.
2056 * References:: How to refer to another field or range
2057 * Formula syntax for Calc:: Using Calc to compute stuff
2058 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
2059 * Field formulas:: Formulas valid for a single field
2060 * Column formulas:: Formulas valid for an entire column
2061 * Editing and debugging formulas:: Fixing formulas
2062 * Updating the table:: Recomputing all dependent fields
2063 * Advanced features:: Field names, parameters and automatic recalc
2066 @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet
2067 @subsection References
2070 To compute fields in the table from other fields, formulas must
2071 reference other fields or ranges. In Org, fields can be referenced
2072 by name, by absolute coordinates, and by relative coordinates. To find
2073 out what the coordinates of a field are, press @kbd{C-c ?} in that
2074 field, or press @kbd{C-c @}} to toggle the display of a grid.
2076 @subsubheading Field references
2077 @cindex field references
2078 @cindex references, to fields
2080 Formulas can reference the value of another field in two ways. Like in
2081 any other spreadsheet, you may reference fields with a letter/number
2082 combination like @code{B3}, meaning the 2nd field in the 3rd row.
2083 @c Such references are always fixed to that field, they don't change
2084 @c when you copy and paste a formula to a different field. So
2085 @c Org's @code{B3} behaves like @code{$B$3} in other spreadsheets.
2088 Org also uses another, more general operator that looks like this:
2090 @@@var{row}$@var{column}
2094 Column references can be absolute like @samp{1}, @samp{2},...@samp{@var{N}},
2095 or relative to the current column like @samp{+1} or @samp{-2}.
2097 The row specification only counts data lines and ignores horizontal
2098 separator lines (hlines). You can use absolute row numbers
2099 @samp{1}...@samp{@var{N}}, and row numbers relative to the current row like
2100 @samp{+3} or @samp{-1}. Or specify the row relative to one of the
2101 hlines: @samp{I} refers to the first hline@footnote{Note that only
2102 hlines are counted that @emph{separate} table lines. If the table
2103 starts with a hline above the header, it does not count.}, @samp{II} to
2104 the second, etc@. @samp{-I} refers to the first such line above the
2105 current line, @samp{+I} to the first such line below the current line.
2106 You can also write @samp{III+2} which is the second data line after the
2107 third hline in the table.
2109 @samp{0} refers to the current row and column. Also, if you omit
2110 either the column or the row part of the reference, the current
2111 row/column is implied.
2113 Org's references with @emph{unsigned} numbers are fixed references
2114 in the sense that if you use the same reference in the formula for two
2115 different fields, the same field will be referenced each time.
2116 Org's references with @emph{signed} numbers are floating
2117 references because the same reference operator can reference different
2118 fields depending on the field being calculated by the formula.
2120 As a special case, references like @samp{$LR5} and @samp{$LR12} can be used
2121 to refer in a stable way to the 5th and 12th field in the last row of the
2124 Here are a few examples:
2127 @@2$3 @r{2nd row, 3rd column}
2128 C2 @r{same as previous}
2129 $5 @r{column 5 in the current row}
2130 E& @r{same as previous}
2131 @@2 @r{current column, row 2}
2132 @@-1$-3 @r{the field one row up, three columns to the left}
2133 @@-I$2 @r{field just under hline above current row, column 2}
2136 @subsubheading Range references
2137 @cindex range references
2138 @cindex references, to ranges
2140 You may reference a rectangular range of fields by specifying two field
2141 references connected by two dots @samp{..}. If both fields are in the
2142 current row, you may simply use @samp{$2..$7}, but if at least one field
2143 is in a different row, you need to use the general @code{@@row$column}
2144 format at least for the first field (i.e the reference must start with
2145 @samp{@@} in order to be interpreted correctly). Examples:
2148 $1..$3 @r{First three fields in the current row.}
2149 $P..$Q @r{Range, using column names (see under Advanced)}
2150 @@2$1..@@4$3 @r{6 fields between these two fields.}
2151 A2..C4 @r{Same as above.}
2152 @@-1$-2..@@-1 @r{3 numbers from the column to the left, 2 up to current row}
2155 @noindent Range references return a vector of values that can be fed
2156 into Calc vector functions. Empty fields in ranges are normally
2157 suppressed, so that the vector contains only the non-empty fields (but
2158 see the @samp{E} mode switch below). If there are no non-empty fields,
2159 @samp{[0]} is returned to avoid syntax errors in formulas.
2161 @subsubheading Named references
2162 @cindex named references
2163 @cindex references, named
2164 @cindex name, of column or field
2165 @cindex constants, in calculations
2168 @vindex org-table-formula-constants
2169 @samp{$name} is interpreted as the name of a column, parameter or
2170 constant. Constants are defined globally through the variable
2171 @code{org-table-formula-constants}, and locally (for the file) through a
2175 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
2179 @vindex constants-unit-system
2180 @pindex constants.el
2181 Also properties (@pxref{Properties and Columns}) can be used as
2182 constants in table formulas: for a property @samp{:Xyz:} use the name
2183 @samp{$PROP_Xyz}, and the property will be searched in the current
2184 outline entry and in the hierarchy above it. If you have the
2185 @file{constants.el} package, it will also be used to resolve constants,
2186 including natural constants like @samp{$h} for Planck's constant, and
2187 units like @samp{$km} for kilometers@footnote{@file{constants.el} can
2188 supply the values of constants in two different unit systems, @code{SI}
2189 and @code{cgs}. Which one is used depends on the value of the variable
2190 @code{constants-unit-system}. You can use the @code{#+STARTUP} options
2191 @code{constSI} and @code{constcgs} to set this value for the current
2192 buffer.}. Column names and parameters can be specified in special table
2193 lines. These are described below, see @ref{Advanced features}. All
2194 names must start with a letter, and further consist of letters and
2197 @subsubheading Remote references
2198 @cindex remote references
2199 @cindex references, remote
2200 @cindex references, to a different table
2201 @cindex name, of column or field
2202 @cindex constants, in calculations
2205 You may also reference constants, fields and ranges from a different table,
2206 either in the current file or even in a different file. The syntax is
2209 remote(NAME-OR-ID,REF)
2213 where NAME can be the name of a table in the current file as set by a
2214 @code{#+TBLNAME: NAME} line before the table. It can also be the ID of an
2215 entry, even in a different file, and the reference then refers to the first
2216 table in that entry. REF is an absolute field or range reference as
2217 described above for example @code{@@3$3} or @code{$somename}, valid in the
2220 @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet
2221 @subsection Formula syntax for Calc
2222 @cindex formula syntax, Calc
2223 @cindex syntax, of formulas
2225 A formula can be any algebraic expression understood by the Emacs
2226 @file{Calc} package. @b{Note that @file{calc} has the
2227 non-standard convention that @samp{/} has lower precedence than
2228 @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.} Before
2229 evaluation by @code{calc-eval} (@pxref{Calling Calc from
2230 Your Programs,calc-eval,Calling Calc from Your Lisp Programs,Calc,GNU
2231 Emacs Calc Manual}),
2232 @c FIXME: The link to the Calc manual in HTML does not work.
2233 variable substitution takes place according to the rules described above.
2234 @cindex vectors, in table calculations
2235 The range vectors can be directly fed into the Calc vector functions
2236 like @samp{vmean} and @samp{vsum}.
2238 @cindex format specifier
2239 @cindex mode, for @file{calc}
2240 @vindex org-calc-default-modes
2241 A formula can contain an optional mode string after a semicolon. This
2242 string consists of flags to influence Calc and other modes during
2243 execution. By default, Org uses the standard Calc modes (precision
2244 12, angular units degrees, fraction and symbolic modes off). The display
2245 format, however, has been changed to @code{(float 8)} to keep tables
2246 compact. The default settings can be configured using the variable
2247 @code{org-calc-default-modes}.
2250 p20 @r{switch the internal precision to 20 digits}
2251 n3 s3 e2 f4 @r{normal, scientific, engineering, or fixed display format}
2252 D R @r{angle modes: degrees, radians}
2253 F S @r{fraction and symbolic modes}
2254 N @r{interpret all fields as numbers, use 0 for non-numbers}
2255 T @r{force text interpretation}
2256 E @r{keep empty fields in ranges}
2261 In addition, you may provide a @code{printf} format specifier to
2262 reformat the final result. A few examples:
2265 $1+$2 @r{Sum of first and second field}
2266 $1+$2;%.2f @r{Same, format result to two decimals}
2267 exp($2)+exp($1) @r{Math functions can be used}
2268 $0;%.1f @r{Reformat current cell to 1 decimal}
2269 ($3-32)*5/9 @r{Degrees F -> C conversion}
2270 $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}}
2271 tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1}
2272 sin($1);Dp3%.1e @r{Same, but use printf specifier for display}
2273 vmean($2..$7) @r{Compute column range mean, using vector function}
2274 vmean($2..$7);EN @r{Same, but treat empty fields as 0}
2275 taylor($3,x=7,2) @r{taylor series of $3, at x=7, second degree}
2278 Calc also contains a complete set of logical operations. For example
2281 if($1<20,teen,string("")) @r{``teen'' if age $1 less than 20, else empty}
2284 @node Formula syntax for Lisp, Field formulas, Formula syntax for Calc, The spreadsheet
2285 @subsection Emacs Lisp forms as formulas
2286 @cindex Lisp forms, as table formulas
2288 It is also possible to write a formula in Emacs Lisp; this can be useful
2289 for string manipulation and control structures, if Calc's
2290 functionality is not enough. If a formula starts with a single-quote
2291 followed by an opening parenthesis, then it is evaluated as a Lisp form.
2292 The evaluation should return either a string or a number. Just as with
2293 @file{calc} formulas, you can specify modes and a printf format after a
2294 semicolon. With Emacs Lisp forms, you need to be conscious about the way
2295 field references are interpolated into the form. By default, a
2296 reference will be interpolated as a Lisp string (in double-quotes)
2297 containing the field. If you provide the @samp{N} mode switch, all
2298 referenced elements will be numbers (non-number fields will be zero) and
2299 interpolated as Lisp numbers, without quotes. If you provide the
2300 @samp{L} flag, all fields will be interpolated literally, without quotes.
2301 @Ie{}, if you want a reference to be interpreted as a string by the Lisp
2302 form, enclose the reference operator itself in double-quotes, like
2303 @code{"$3"}. Ranges are inserted as space-separated fields, so you can
2304 embed them in list or vector syntax. A few examples, note how the
2305 @samp{N} mode is used when we do computations in Lisp.
2308 @r{Swap the first two characters of the content of column 1}
2309 '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
2310 @r{Add columns 1 and 2, equivalent to Calc's @code{$1+$2}}
2312 @r{Compute the sum of columns 1-4, like Calc's @code{vsum($1..$4)}}
2313 '(apply '+ '($1..$4));N
2316 @node Field formulas, Column formulas, Formula syntax for Lisp, The spreadsheet
2317 @subsection Field formulas
2318 @cindex field formula
2319 @cindex formula, for individual table field
2321 To assign a formula to a particular field, type it directly into the
2322 field, preceded by @samp{:=}, for example @samp{:=$1+$2}. When you
2323 press @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in
2324 the field, the formula will be stored as the formula for this field,
2325 evaluated, and the current field replaced with the result.
2328 Formulas are stored in a special line starting with @samp{#+TBLFM:}
2329 directly below the table. If you typed the equation in the 4th field of
2330 the 3rd data line in the table, the formula will look like
2331 @samp{@@3$4=$1+$2}. When inserting/deleting/swapping column and rows
2332 with the appropriate commands, @i{absolute references} (but not relative
2333 ones) in stored formulas are modified in order to still reference the
2334 same field. Of course this is not true if you edit the table structure
2335 with normal editing commands---then you must fix the equations yourself.
2336 The left-hand side of a formula may also be a named field (@pxref{Advanced
2337 features}), or a last-row reference like @samp{$LR3}.
2339 Instead of typing an equation into the field, you may also use the
2345 Install a new formula for the current field. The command prompts for a
2346 formula with default taken from the @samp{#+TBLFM:} line, applies
2347 it to the current field, and stores it.
2350 @node Column formulas, Editing and debugging formulas, Field formulas, The spreadsheet
2351 @subsection Column formulas
2352 @cindex column formula
2353 @cindex formula, for table column
2355 Often in a table, the same formula should be used for all fields in a
2356 particular column. Instead of having to copy the formula to all fields
2357 in that column, Org allows you to assign a single formula to an entire
2358 column. If the table contains horizontal separator hlines, everything
2359 before the first such line is considered part of the table @emph{header}
2360 and will not be modified by column formulas.
2362 To assign a formula to a column, type it directly into any field in the
2363 column, preceded by an equal sign, like @samp{=$1+$2}. When you press
2364 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2365 the formula will be stored as the formula for the current column, evaluated
2366 and the current field replaced with the result. If the field contains only
2367 @samp{=}, the previously stored formula for this column is used. For each
2368 column, Org will only remember the most recently used formula. In the
2369 @samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}. The left-hand
2370 side of a column formula cannot currently be the name of column, it
2371 must be the numeric column reference.
2373 Instead of typing an equation into the field, you may also use the
2379 Install a new formula for the current column and replace current field with
2380 the result of the formula. The command prompts for a formula, with default
2381 taken from the @samp{#+TBLFM} line, applies it to the current field and
2382 stores it. With a numeric prefix argument(@eg @kbd{C-5 C-c =}) the command
2383 will apply it to that many consecutive fields in the current column.
2386 @node Editing and debugging formulas, Updating the table, Column formulas, The spreadsheet
2387 @subsection Editing and debugging formulas
2388 @cindex formula editing
2389 @cindex editing, of table formulas
2391 @vindex org-table-use-standard-references
2392 You can edit individual formulas in the minibuffer or directly in the
2393 field. Org can also prepare a special buffer with all active
2394 formulas of a table. When offering a formula for editing, Org
2395 converts references to the standard format (like @code{B3} or @code{D&})
2396 if possible. If you prefer to only work with the internal format (like
2397 @code{@@3$2} or @code{$4}), configure the variable
2398 @code{org-table-use-standard-references}.
2405 Edit the formula associated with the current column/field in the
2406 minibuffer. See @ref{Column formulas}, and @ref{Field formulas}.
2407 @kindex C-u C-u C-c =
2409 Re-insert the active formula (either a
2410 field formula, or a column formula) into the current field, so that you
2411 can edit it directly in the field. The advantage over editing in the
2412 minibuffer is that you can use the command @kbd{C-c ?}.
2415 While editing a formula in a table field, highlight the field(s)
2416 referenced by the reference at the cursor position in the formula.
2419 Toggle the display of row and column numbers for a table, using
2420 overlays. These are updated each time the table is aligned; you can
2421 force it with @kbd{C-c C-c}.
2424 Toggle the formula debugger on and off. See below.
2427 Edit all formulas for the current table in a special buffer, where the
2428 formulas will be displayed one per line. If the current field has an
2429 active formula, the cursor in the formula editor will mark it.
2430 While inside the special buffer, Org will automatically highlight
2431 any field or range reference at the cursor position. You may edit,
2432 remove and add formulas, and use the following commands:
2438 Exit the formula editor and store the modified formulas. With @kbd{C-u}
2439 prefix, also apply the new formulas to the entire table.
2442 Exit the formula editor without installing changes.
2445 Toggle all references in the formula editor between standard (like
2446 @code{B3}) and internal (like @code{@@3$2}).
2449 Pretty-print or indent Lisp formula at point. When in a line containing
2450 a Lisp formula, format the formula according to Emacs Lisp rules.
2451 Another @key{TAB} collapses the formula back again. In the open
2452 formula, @key{TAB} re-indents just like in Emacs Lisp mode.
2455 Complete Lisp symbols, just like in Emacs Lisp mode.
2457 @kindex S-@key{down}
2458 @kindex S-@key{left}
2459 @kindex S-@key{right}
2460 @item S-@key{up}/@key{down}/@key{left}/@key{right}
2461 Shift the reference at point. For example, if the reference is
2462 @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
2463 This also works for relative references and for hline references.
2464 @kindex M-S-@key{up}
2465 @kindex M-S-@key{down}
2466 @item M-S-@key{up}/@key{down}
2467 Move the test line for column formulas in the Org buffer up and
2470 @kindex M-@key{down}
2471 @item M-@key{up}/@key{down}
2472 Scroll the window displaying the table.
2475 Turn the coordinate grid in the table on and off.
2479 Making a table field blank does not remove the formula associated with
2480 the field, because that is stored in a different line (the @samp{#+TBLFM}
2481 line)---during the next recalculation the field will be filled again.
2482 To remove a formula from a field, you have to give an empty reply when
2483 prompted for the formula, or to edit the @samp{#+TBLFM} line.
2486 You may edit the @samp{#+TBLFM} directly and re-apply the changed
2487 equations with @kbd{C-c C-c} in that line or with the normal
2488 recalculation commands in the table.
2490 @subsubheading Debugging formulas
2491 @cindex formula debugging
2492 @cindex debugging, of table formulas
2493 When the evaluation of a formula leads to an error, the field content
2494 becomes the string @samp{#ERROR}. If you would like see what is going
2495 on during variable substitution and calculation in order to find a bug,
2496 turn on formula debugging in the @code{Tbl} menu and repeat the
2497 calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
2498 field. Detailed information will be displayed.
2500 @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet
2501 @subsection Updating the table
2502 @cindex recomputing table fields
2503 @cindex updating, table
2505 Recalculation of a table is normally not automatic, but needs to be
2506 triggered by a command. See @ref{Advanced features}, for a way to make
2507 recalculation at least semi-automatic.
2509 In order to recalculate a line of a table or the entire table, use the
2515 Recalculate the current row by first applying the stored column formulas
2516 from left to right, and all field formulas in the current row.
2522 Recompute the entire table, line by line. Any lines before the first
2523 hline are left alone, assuming that these are part of the table header.
2525 @kindex C-u C-u C-c *
2526 @kindex C-u C-u C-c C-c
2528 @itemx C-u C-u C-c C-c
2529 Iterate the table by recomputing it until no further changes occur.
2530 This may be necessary if some computed fields use the value of other
2531 fields that are computed @i{later} in the calculation sequence.
2534 @node Advanced features, , Updating the table, The spreadsheet
2535 @subsection Advanced features
2537 If you want the recalculation of fields to happen automatically, or if
2538 you want to be able to assign @i{names} to fields and columns, you need
2539 to reserve the first column of the table for special marking characters.
2543 Rotate the calculation mark in first column through the states @samp{},
2544 @samp{#}, @samp{*}, @samp{!}, @samp{$}. When there is an active region,
2545 change all marks in the region.
2548 Here is an example of a table that collects exam results of students and
2549 makes use of these features:
2553 |---+---------+--------+--------+--------+-------+------|
2554 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
2555 |---+---------+--------+--------+--------+-------+------|
2556 | ! | | P1 | P2 | P3 | Tot | |
2557 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
2558 | ^ | | m1 | m2 | m3 | mt | |
2559 |---+---------+--------+--------+--------+-------+------|
2560 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
2561 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
2562 |---+---------+--------+--------+--------+-------+------|
2563 | | Average | | | | 29.7 | |
2564 | ^ | | | | | at | |
2565 | $ | max=50 | | | | | |
2566 |---+---------+--------+--------+--------+-------+------|
2567 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
2571 @noindent @b{Important}: please note that for these special tables,
2572 recalculating the table with @kbd{C-u C-c *} will only affect rows that
2573 are marked @samp{#} or @samp{*}, and fields that have a formula assigned
2574 to the field itself. The column formulas are not applied in rows with
2577 @cindex marking characters, tables
2578 The marking characters have the following meaning:
2581 The fields in this line define names for the columns, so that you may
2582 refer to a column as @samp{$Tot} instead of @samp{$6}.
2584 This row defines names for the fields @emph{above} the row. With such
2585 a definition, any formula in the table may use @samp{$m1} to refer to
2586 the value @samp{10}. Also, if you assign a formula to a names field, it
2587 will be stored as @samp{$name=...}.
2589 Similar to @samp{^}, but defines names for the fields in the row
2592 Fields in this row can define @emph{parameters} for formulas. For
2593 example, if a field in a @samp{$} row contains @samp{max=50}, then
2594 formulas in this table can refer to the value 50 using @samp{$max}.
2595 Parameters work exactly like constants, only that they can be defined on
2598 Fields in this row are automatically recalculated when pressing
2599 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row
2600 is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked
2601 lines will be left alone by this command.
2603 Selects this line for global recalculation with @kbd{C-u C-c *}, but
2604 not for automatic recalculation. Use this when automatic
2605 recalculation slows down editing too much.
2607 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
2608 All lines that should be recalculated should be marked with @samp{#}
2611 Do not export this line. Useful for lines that contain the narrowing
2612 @samp{<N>} markers or column group markers.
2615 Finally, just to whet your appetite for what can be done with the
2616 fantastic @file{calc.el} package, here is a table that computes the Taylor
2617 series of degree @code{n} at location @code{x} for a couple of
2622 |---+-------------+---+-----+--------------------------------------|
2623 | | Func | n | x | Result |
2624 |---+-------------+---+-----+--------------------------------------|
2625 | # | exp(x) | 1 | x | 1 + x |
2626 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
2627 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
2628 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
2629 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
2630 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
2631 |---+-------------+---+-----+--------------------------------------|
2632 #+TBLFM: $5=taylor($2,$4,$3);n3
2636 @node Org-Plot, , The spreadsheet, Tables
2638 @cindex graph, in tables
2639 @cindex plot tables using gnuplot
2642 Org-Plot can produce 2D and 3D graphs of information stored in org tables
2643 using @file{Gnuplot} @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
2644 @uref{http://cars9.uchicago.edu/~ravel/software/gnuplot-mode.html}. To see
2645 this in action, ensure that you have both Gnuplot and Gnuplot mode installed
2646 on your system, then call @code{org-plot/gnuplot} on the following table.
2650 #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
2651 | Sede | Max cites | H-index |
2652 |-----------+-----------+---------|
2653 | Chile | 257.72 | 21.39 |
2654 | Leeds | 165.77 | 19.68 |
2655 | Sao Paolo | 71.00 | 11.50 |
2656 | Stockholm | 134.19 | 14.33 |
2657 | Morelia | 257.56 | 17.67 |
2661 Notice that Org Plot is smart enough to apply the table's headers as labels.
2662 Further control over the labels, type, content, and appearance of plots can
2663 be exercised through the @code{#+PLOT:} lines preceding a table. See below
2664 for a complete list of Org-plot options. For more information and examples
2665 see the Org-plot tutorial at
2666 @uref{http://orgmode.org/worg/org-tutorials/org-plot.php}.
2668 @subsubheading Plot Options
2672 Specify any @command{gnuplot} option to be set when graphing.
2675 Specify the title of the plot.
2678 Specify which column of the table to use as the @code{x} axis.
2681 Specify the columns to graph as a Lisp style list, surrounded by parentheses
2682 and separated by spaces for example @code{dep:(3 4)} to graph the third and
2683 fourth columns (defaults to graphing all other columns aside from the @code{ind}
2687 Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
2690 Specify a @code{with} option to be inserted for every col being plotted
2691 (@eg @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
2692 Defaults to @code{lines}.
2695 If you want to plot to a file, specify @code{"@var{path/to/desired/output-file}"}.
2698 List of labels to be used for the deps (defaults to the column headers if
2702 Specify an entire line to be inserted in the Gnuplot script.
2705 When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
2706 flat mapping rather than a @code{3d} slope.
2709 Specify format of Org-mode timestamps as they will be parsed by Gnuplot.
2710 Defaults to @samp{%Y-%m-%d-%H:%M:%S}.
2713 If you want total control, you can specify a script file (place the file name
2714 between double-quotes) which will be used to plot. Before plotting, every
2715 instance of @code{$datafile} in the specified script will be replaced with
2716 the path to the generated data file. Note: even if you set this option, you
2717 may still want to specify the plot type, as that can impact the content of
2721 @node Hyperlinks, TODO Items, Tables, Top
2725 Like HTML, Org provides links inside a file, external links to
2726 other files, Usenet articles, emails, and much more.
2729 * Link format:: How links in Org are formatted
2730 * Internal links:: Links to other places in the current file
2731 * External links:: URL-like links to the world
2732 * Handling links:: Creating, inserting and following
2733 * Using links outside Org:: Linking from my C source code?
2734 * Link abbreviations:: Shortcuts for writing complex links
2735 * Search options:: Linking to a specific location
2736 * Custom searches:: When the default search is not enough
2739 @node Link format, Internal links, Hyperlinks, Hyperlinks
2740 @section Link format
2742 @cindex format, of links
2744 Org will recognize plain URL-like links and activate them as
2745 clickable links. The general link format, however, looks like this:
2748 [[link][description]] @r{or alternatively} [[link]]
2752 Once a link in the buffer is complete (all brackets present), Org
2753 will change the display so that @samp{description} is displayed instead
2754 of @samp{[[link][description]]} and @samp{link} is displayed instead of
2755 @samp{[[link]]}. Links will be highlighted in the face @code{org-link},
2756 which by default is an underlined face. You can directly edit the
2757 visible part of a link. Note that this can be either the @samp{link}
2758 part (if there is no description) or the @samp{description} part. To
2759 edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
2762 If you place the cursor at the beginning or just behind the end of the
2763 displayed text and press @key{BACKSPACE}, you will remove the
2764 (invisible) bracket at that location. This makes the link incomplete
2765 and the internals are again displayed as plain text. Inserting the
2766 missing bracket hides the link internals again. To show the
2767 internal structure of all links, use the menu entry
2768 @code{Org->Hyperlinks->Literal links}.
2770 @node Internal links, External links, Link format, Hyperlinks
2771 @section Internal links
2772 @cindex internal links
2773 @cindex links, internal
2774 @cindex targets, for links
2776 @cindex property, CUSTOM_ID
2777 If the link does not look like a URL, it is considered to be internal in the
2778 current file. The most important case is a link like
2779 @samp{[[#my-custom-id]]} which will link to the entry with the
2780 @code{CUSTOM_ID} property @samp{my-custom-id}. Such custom IDs are very good
2781 for HTML export (@pxref{HTML export}) where they produce pretty section
2782 links. You are responsible yourself to make sure these custom IDs are unique
2785 Links such as @samp{[[My Target]]} or @samp{[[My Target][Find my target]]}
2786 lead to a text search in the current file.
2788 The link can be followed with @kbd{C-c C-o} when the cursor is on the link,
2789 or with a mouse click (@pxref{Handling links}). Links to custom IDs will
2790 point to the corresponding headline. The preferred match for a text link is
2791 a @i{dedicated target}: the same string in double angular brackets. Targets
2792 may be located anywhere; sometimes it is convenient to put them into a
2793 comment line. For example
2799 @noindent In HTML export (@pxref{HTML export}), such targets will become
2800 named anchors for direct access through @samp{http} links@footnote{Note that
2801 text before the first headline is usually not exported, so the first such
2802 target should be after the first headline, or in the line directly before the
2805 If no dedicated target exists, Org will search for the words in the link. In
2806 the above example the search would be for @samp{my target}. Links starting
2807 with a star like @samp{*My Target} restrict the search to
2808 headlines@footnote{To insert a link targeting a headline, in-buffer
2809 completion can be used. Just type a star followed by a few optional letters
2810 into the buffer and press @kbd{M-@key{TAB}}. All headlines in the current
2811 buffer will be offered as completions. @xref{Handling links}, for more
2812 commands creating links.}. When searching, Org mode will first try an
2813 exact match, but then move on to more and more lenient searches. For
2814 example, the link @samp{[[*My Targets]]} will find any of the following:
2818 ** TODO my targets are bright
2819 ** my 20 targets are
2823 Following a link pushes a mark onto Org's own mark ring. You can
2824 return to the previous position with @kbd{C-c &}. Using this command
2825 several times in direct succession goes back to positions recorded
2829 * Radio targets:: Make targets trigger links in plain text
2832 @node Radio targets, , Internal links, Internal links
2833 @subsection Radio targets
2834 @cindex radio targets
2835 @cindex targets, radio
2836 @cindex links, radio targets
2838 Org can automatically turn any occurrences of certain target names
2839 in normal text into a link. So without explicitly creating a link, the
2840 text connects to the target radioing its position. Radio targets are
2841 enclosed by triple angular brackets. For example, a target @samp{<<<My
2842 Target>>>} causes each occurrence of @samp{my target} in normal text to
2843 become activated as a link. The Org file is scanned automatically
2844 for radio targets only when the file is first loaded into Emacs. To
2845 update the target list during editing, press @kbd{C-c C-c} with the
2846 cursor on or at a target.
2848 @node External links, Handling links, Internal links, Hyperlinks
2849 @section External links
2850 @cindex links, external
2851 @cindex external links
2852 @cindex links, external
2860 @cindex WANDERLUST links
2862 @cindex USENET links
2867 Org supports links to files, websites, Usenet and email messages,
2868 BBDB database entries and links to both IRC conversations and their
2869 logs. External links are URL-like locators. They start with a short
2870 identifying string followed by a colon. There can be no space after
2871 the colon. The following list shows examples for each link type.
2874 http://www.astro.uva.nl/~dominik @r{on the web}
2875 file:/home/dominik/images/jupiter.jpg @r{file, absolute path}
2876 /home/dominik/images/jupiter.jpg @r{same as above}
2877 file:papers/last.pdf @r{file, relative path}
2878 ./papers/last.pdf @r{same as above}
2879 file:projects.org @r{another Org file}
2880 file:projects.org::some words @r{text search in Org file}
2881 file:projects.org::*task title @r{heading search in Org file}
2882 id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID}
2883 news:comp.emacs @r{Usenet link}
2884 mailto:adent@@galaxy.net @r{Mail link}
2885 vm:folder @r{VM folder link}
2886 vm:folder#id @r{VM message link}
2887 vm://myself@@some.where.org/folder#id @r{VM on remote machine}
2888 wl:folder @r{WANDERLUST folder link}
2889 wl:folder#id @r{WANDERLUST message link}
2890 mhe:folder @r{MH-E folder link}
2891 mhe:folder#id @r{MH-E message link}
2892 rmail:folder @r{RMAIL folder link}
2893 rmail:folder#id @r{RMAIL message link}
2894 gnus:group @r{Gnus group link}
2895 gnus:group#id @r{Gnus article link}
2896 bbdb:R.*Stallman @r{BBDB link (with regexp)}
2897 irc:/irc.com/#emacs/bob @r{IRC link}
2898 shell:ls *.org @r{A shell command}
2899 elisp:org-agenda @r{Interactive Elisp command}
2900 elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
2903 A link should be enclosed in double brackets and may contain a
2904 descriptive text to be displayed instead of the URL (@pxref{Link
2905 format}), for example:
2908 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
2912 If the description is a file name or URL that points to an image, HTML
2913 export (@pxref{HTML export}) will inline the image as a clickable
2914 button. If there is no description at all and the link points to an
2916 that image will be inlined into the exported HTML file.
2918 @cindex square brackets, around links
2919 @cindex plain text external links
2920 Org also finds external links in the normal text and activates them
2921 as links. If spaces must be part of the link (for example in
2922 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
2923 about the end of the link, enclose them in square brackets.
2925 @node Handling links, Using links outside Org, External links, Hyperlinks
2926 @section Handling links
2927 @cindex links, handling
2929 Org provides methods to create a link in the correct syntax, to
2930 insert it into an Org file, and to follow the link.
2934 @cindex storing links
2936 Store a link to the current location. This is a @emph{global} command (you
2937 must create the key binding yourself) which can be used in any buffer to
2938 create a link. The link will be stored for later insertion into an Org
2939 buffer (see below). What kind of link will be created depends on the current
2942 @b{Org-mode buffers}@*
2943 For Org files, if there is a @samp{<<target>>} at the cursor, the link points
2944 to the target. Otherwise it points to the current headline, which will also
2947 @vindex org-link-to-org-use-id
2948 @cindex property, CUSTOM_ID
2949 @cindex property, ID
2950 If the headline has a @code{CUSTOM_ID} property, a link to this custom ID
2951 will be stored. In addition or alternatively (depending on the value of
2952 @code{org-link-to-org-use-id}), a globally unique @code{ID} property will be
2953 created and/or used to construct a link. So using this command in Org
2954 buffers will potentially create two links: a human-readable from the custom
2955 ID, and one that is globally unique and works even if the entry is moved from
2956 file to file. Later, when inserting the link, you need to decide which one
2959 @b{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus}@*
2960 Pretty much all Emacs mail clients are supported. The link will point to the
2961 current article, or, in some GNUS buffers, to the group. The description is
2962 constructed from the author and the subject.
2964 @b{Web browsers: W3 and W3M}@*
2965 Here the link will be the current URL, with the page title as description.
2967 @b{Contacts: BBDB}@*
2968 Links created in a BBDB buffer will point to the current entry.
2971 @vindex org-irc-link-to-logs
2972 For IRC links, if you set the variable @code{org-irc-link-to-logs} to
2973 @code{t}, a @samp{file:/} style link to the relevant point in the logs for
2974 the current conversation is created. Otherwise an @samp{irc:/} style link to
2975 the user/channel/server under the point will be stored.
2978 For any other files, the link will point to the file, with a search string
2979 (@pxref{Search options}) pointing to the contents of the current line. If
2980 there is an active region, the selected words will form the basis of the
2981 search string. If the automatically created link is not working correctly or
2982 accurately enough, you can write custom functions to select the search string
2983 and to do the search for particular file types---see @ref{Custom searches}.
2984 The key binding @kbd{C-c l} is only a suggestion---see @ref{Installation}.
2987 When the cursor is in an agenda view, the created link points to the
2988 entry referenced by the current line.
2992 @cindex link completion
2993 @cindex completion, of links
2994 @cindex inserting links
2996 @vindex org-keep-stored-link-after-insertion
2997 Insert a link@footnote{ Note that you don't have to use this command to
2998 insert a link. Links in Org are plain text, and you can type or paste them
2999 straight into the buffer. By using this command, the links are automatically
3000 enclosed in double brackets, and you will be asked for the optional
3001 descriptive text.}. This prompts for a link to be inserted into the buffer.
3002 You can just type a link, using text for an internal link, or one of the link
3003 type prefixes mentioned in the examples above. The link will be inserted
3004 into the buffer@footnote{After insertion of a stored link, the link will be
3005 removed from the list of stored links. To keep it in the list later use, use
3006 a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
3007 @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
3008 If some text was selected when this command is called, the selected text
3009 becomes the default description.
3011 @b{Inserting stored links}@*
3012 All links stored during the
3013 current session are part of the history for this prompt, so you can access
3014 them with @key{up} and @key{down} (or @kbd{M-p/n}).
3016 @b{Completion support}@* Completion with @key{TAB} will help you to insert
3017 valid link prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
3018 defined through link abbreviations (@pxref{Link abbreviations}). If you
3019 press @key{RET} after inserting only the @var{prefix}, Org will offer
3020 specific completion support for some link types@footnote{This works by
3021 calling a special function @code{org-PREFIX-complete-link}.} For
3022 example, if you type @kbd{file @key{RET}}, file name completion (alternative
3023 access: @kbd{C-u C-c C-l}, see below) will be offered, and after @kbd{bbdb
3024 @key{RET}} you can complete contact names.
3026 @cindex file name completion
3027 @cindex completion, of file names
3029 When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
3030 a file will be inserted and you may use file name completion to select
3031 the name of the file. The path to the file is inserted relative to the
3032 directory of the current Org file, if the linked file is in the current
3033 directory or in a sub-directory of it, or if the path is written relative
3034 to the current directory using @samp{../}. Otherwise an absolute path
3035 is used, if possible with @samp{~/} for your home directory. You can
3036 force an absolute path with two @kbd{C-u} prefixes.
3038 @item C-c C-l @r{(with cursor on existing link)}
3039 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
3040 link and description parts of the link.
3042 @cindex following links
3045 @item C-c C-o @r{or} @key{RET}
3046 @vindex org-file-apps
3047 Open link at point. This will launch a web browser for URLs (using
3048 @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
3049 the corresponding links, and execute the command in a shell link. When the
3050 cursor is on an internal link, this commands runs the corresponding search.
3051 When the cursor is on a TAG list in a headline, it creates the corresponding
3052 TAGS view. If the cursor is on a timestamp, it compiles the agenda for that
3053 date. Furthermore, it will visit text and remote files in @samp{file:} links
3054 with Emacs and select a suitable application for local non-text files.
3055 Classification of files is based on file extension only. See option
3056 @code{org-file-apps}. If you want to override the default application and
3057 visit the file with Emacs, use a @kbd{C-u} prefix. If you want to avoid
3058 opening in Emacs, use a @kbd{C-u C-u} prefix.@*
3059 If the cursor is on a headline, but not on a link, offer all links in the
3060 headline and entry text.
3066 On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
3067 would. Under Emacs 22, @kbd{mouse-1} will also follow a link.
3071 @vindex org-display-internal-link-with-indirect-buffer
3072 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
3073 internal links to be displayed in another window@footnote{See the
3074 variable @code{org-display-internal-link-with-indirect-buffer}}.
3079 Push the current position onto the mark ring, to be able to return
3080 easily. Commands following an internal link do this automatically.
3082 @cindex links, returning to
3085 Jump back to a recorded position. A position is recorded by the
3086 commands following internal links, and by @kbd{C-c %}. Using this
3087 command several times in direct succession moves through a ring of
3088 previously recorded positions.
3092 @cindex links, finding next/previous
3095 Move forward/backward to the next link in the buffer. At the limit of
3096 the buffer, the search fails once, and then wraps around. The key
3097 bindings for this are really too long, you might want to bind this also
3098 to @kbd{C-n} and @kbd{C-p}
3100 (add-hook 'org-load-hook
3102 (define-key 'org-mode-map "\C-n" 'org-next-link)
3103 (define-key 'org-mode-map "\C-p" 'org-previous-link)))
3107 @node Using links outside Org, Link abbreviations, Handling links, Hyperlinks
3108 @section Using links outside Org
3110 You can insert and follow links that have Org syntax not only in
3111 Org, but in any Emacs buffer. For this, you should create two
3112 global commands, like this (please select suitable global keys
3116 (global-set-key "\C-c L" 'org-insert-link-global)
3117 (global-set-key "\C-c o" 'org-open-at-point-global)
3120 @node Link abbreviations, Search options, Using links outside Org, Hyperlinks
3121 @section Link abbreviations
3122 @cindex link abbreviations
3123 @cindex abbreviation, links
3125 Long URLs can be cumbersome to type, and often many similar links are
3126 needed in a document. For this you can use link abbreviations. An
3127 abbreviated link looks like this
3130 [[linkword:tag][description]]
3134 @vindex org-link-abbrev-alist
3135 where the tag is optional. The @i{linkword} must be a word; letter, numbers,
3136 @samp{-}, and @samp{_} are allowed here. Abbreviations are resolved
3137 according to the information in the variable @code{org-link-abbrev-alist}
3138 that relates the linkwords to replacement text. Here is an example:
3142 (setq org-link-abbrev-alist
3143 '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
3144 ("google" . "http://www.google.com/search?q=")
3145 ("ads" . "http://adsabs.harvard.edu/cgi-bin/
3146 nph-abs_connect?author=%s&db_key=AST")))
3150 If the replacement text contains the string @samp{%s}, it will be
3151 replaced with the tag. Otherwise the tag will be appended to the string
3152 in order to create the link. You may also specify a function that will
3153 be called with the tag as the only argument to create the link.
3155 With the above setting, you could link to a specific bug with
3156 @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
3157 @code{[[google:OrgMode]]} and find out what the Org author is
3158 doing besides Emacs hacking with @code{[[ads:Dominik,C]]}.
3160 If you need special abbreviations just for a single Org buffer, you
3161 can define them in the file with
3165 #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
3166 #+LINK: google http://www.google.com/search?q=%s
3170 In-buffer completion (@pxref{Completion}) can be used after @samp{[} to
3171 complete link abbreviations. You may also define a function
3172 @code{org-PREFIX-complete-link} that implements special (@eg completion)
3173 support for inserting such a link with @kbd{C-c C-l}. Such a function should
3174 not accept any arguments, and return the full link with prefix.
3176 @node Search options, Custom searches, Link abbreviations, Hyperlinks
3177 @section Search options in file links
3178 @cindex search option in file links
3179 @cindex file links, searching
3181 File links can contain additional information to make Emacs jump to a
3182 particular location in the file when following a link. This can be a
3183 line number or a search option after a double@footnote{For backward
3184 compatibility, line numbers can also follow a single colon.} colon. For
3185 example, when the command @kbd{C-c l} creates a link (@pxref{Handling
3186 links}) to a file, it encodes the words in the current line as a search
3187 string that can be used to find this line back later when following the
3188 link with @kbd{C-c C-o}.
3190 Here is the syntax of the different ways to attach a search to a file
3191 link, together with an explanation:
3194 [[file:~/code/main.c::255]]
3195 [[file:~/xx.org::My Target]]
3196 [[file:~/xx.org::*My Target]]
3197 [[file:~/xx.org::/regexp/]]
3204 Search for a link target @samp{<<My Target>>}, or do a text search for
3205 @samp{my target}, similar to the search in internal links, see
3206 @ref{Internal links}. In HTML export (@pxref{HTML export}), such a file
3207 link will become an HTML reference to the corresponding named anchor in
3210 In an Org file, restrict search to headlines.
3212 Do a regular expression search for @code{regexp}. This uses the Emacs
3213 command @code{occur} to list all matches in a separate window. If the
3214 target file is in Org mode, @code{org-occur} is used to create a
3215 sparse tree with the matches.
3216 @c If the target file is a directory,
3217 @c @code{grep} will be used to search all files in the directory.
3220 As a degenerate case, a file link with an empty file name can be used
3221 to search the current file. For example, @code{[[file:::find me]]} does
3222 a search for @samp{find me} in the current file, just as
3223 @samp{[[find me]]} would.
3225 @node Custom searches, , Search options, Hyperlinks
3226 @section Custom Searches
3227 @cindex custom search strings
3228 @cindex search strings, custom
3230 The default mechanism for creating search strings and for doing the
3231 actual search related to a file link may not work correctly in all
3232 cases. For example, Bib@TeX{} database files have many entries like
3233 @samp{year="1993"} which would not result in good search strings,
3234 because the only unique identification for a Bib@TeX{} entry is the
3237 @vindex org-create-file-search-functions
3238 @vindex org-execute-file-search-functions
3239 If you come across such a problem, you can write custom functions to set
3240 the right search string for a particular file type, and to do the search
3241 for the string in the file. Using @code{add-hook}, these functions need
3242 to be added to the hook variables
3243 @code{org-create-file-search-functions} and
3244 @code{org-execute-file-search-functions}. See the docstring for these
3245 variables for more information. Org actually uses this mechanism
3246 for Bib@TeX{} database files, and you can use the corresponding code as
3247 an implementation example. See the file @file{org-bibtex.el}.
3249 @node TODO Items, Tags, Hyperlinks, Top
3253 Org mode does not maintain TODO lists as separate documents@footnote{Of
3254 course, you can make a document that contains only long lists of TODO items,
3255 but this is not required.}. Instead, TODO items are an integral part of the
3256 notes file, because TODO items usually come up while taking notes! With Org
3257 mode, simply mark any entry in a tree as being a TODO item. In this way,
3258 information is not duplicated, and the entire context from which the TODO
3259 item emerged is always present.
3261 Of course, this technique for managing TODO items scatters them
3262 throughout your notes file. Org mode compensates for this by providing
3263 methods to give you an overview of all the things that you have to do.
3266 * TODO basics:: Marking and displaying TODO entries
3267 * TODO extensions:: Workflow and assignments
3268 * Progress logging:: Dates and notes for progress
3269 * Priorities:: Some things are more important than others
3270 * Breaking down tasks:: Splitting a task into manageable pieces
3271 * Checkboxes:: Tick-off lists
3274 @node TODO basics, TODO extensions, TODO Items, TODO Items
3275 @section Basic TODO functionality
3277 Any headline becomes a TODO item when it starts with the word
3278 @samp{TODO}, for example:
3281 *** TODO Write letter to Sam Fortune
3285 The most important commands to work with TODO entries are:
3289 @cindex cycling, of TODO states
3291 Rotate the TODO state of the current item among
3294 ,-> (unmarked) -> TODO -> DONE --.
3295 '--------------------------------'
3298 The same rotation can also be done ``remotely'' from the timeline and
3299 agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}).
3303 Select a specific keyword using completion or (if it has been set up)
3304 the fast selection interface. For the latter, you need to assign keys
3305 to TODO states, see @ref{Per-file keywords}, and @ref{Setting tags}, for
3308 @kindex S-@key{right}
3309 @kindex S-@key{left}
3310 @vindex org-treat-S-cursor-todo-selection-as-state-change
3313 Select the following/preceding TODO state, similar to cycling. Useful
3314 mostly if more than two TODO states are possible (@pxref{TODO
3315 extensions}). See also @ref{Conflicts}, for a discussion of the interaction
3316 with @code{shift-selection-mode}. See also the variable
3317 @code{org-treat-S-cursor-todo-selection-as-state-change}.
3320 @cindex sparse tree, for TODO
3323 @vindex org-todo-keywords
3324 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds the
3325 entire buffer, but shows all TODO items and the headings hierarchy above
3326 them. With a prefix argument, search for a specific TODO. You will be
3327 prompted for the keyword, and you can also give a list of keywords like
3328 @code{KWD1|KWD2|...} to list entries that match any one of these keywords.
3329 With numeric prefix argument N, show the tree for the Nth keyword in the
3330 variable @code{org-todo-keywords}. With two prefix arguments, find all TODO
3334 Show the global TODO list. Collects the TODO items from all agenda
3335 files (@pxref{Agenda Views}) into a single buffer. The new buffer will
3336 be in @code{agenda-mode}, which provides commands to examine and
3337 manipulate the TODO entries from the new buffer (@pxref{Agenda
3338 commands}). @xref{Global TODO list}, for more information.
3339 @kindex S-M-@key{RET}
3341 Insert a new TODO entry below the current one.
3345 @vindex org-todo-state-tags-triggers
3346 Changing a TODO state can also trigger tag changes. See the docstring of the
3347 option @code{org-todo-state-tags-triggers} for details.
3349 @node TODO extensions, Progress logging, TODO basics, TODO Items
3350 @section Extended use of TODO keywords
3351 @cindex extended TODO keywords
3353 @vindex org-todo-keywords
3354 By default, marked TODO entries have one of only two states: TODO and
3355 DONE. Org mode allows you to classify TODO items in more complex ways
3356 with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With
3357 special setup, the TODO keyword system can work differently in different
3360 Note that @i{tags} are another way to classify headlines in general and
3361 TODO items in particular (@pxref{Tags}).
3364 * Workflow states:: From TODO to DONE in steps
3365 * TODO types:: I do this, Fred does the rest
3366 * Multiple sets in one file:: Mixing it all, and still finding your way
3367 * Fast access to TODO states:: Single letter selection of a state
3368 * Per-file keywords:: Different files, different requirements
3369 * Faces for TODO keywords:: Highlighting states
3370 * TODO dependencies:: When one task needs to wait for others
3373 @node Workflow states, TODO types, TODO extensions, TODO extensions
3374 @subsection TODO keywords as workflow states
3375 @cindex TODO workflow
3376 @cindex workflow states as TODO keywords
3378 You can use TODO keywords to indicate different @emph{sequential} states
3379 in the process of working on an item, for example@footnote{Changing
3380 this variable only becomes effective after restarting Org mode in a
3384 (setq org-todo-keywords
3385 '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
3388 The vertical bar separates the TODO keywords (states that @emph{need
3389 action}) from the DONE states (which need @emph{no further action}). If
3390 you don't provide the separator bar, the last state is used as the DONE
3392 @cindex completion, of TODO keywords
3393 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
3394 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED. You may
3395 also use a numeric prefix argument to quickly select a specific state. For
3396 example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY.
3397 Or you can use @kbd{S-@key{left}} to go backward through the sequence. If you
3398 define many keywords, you can use in-buffer completion
3399 (@pxref{Completion}) or even a special one-key selection scheme
3400 (@pxref{Fast access to TODO states}) to insert these words into the
3401 buffer. Changing a TODO state can be logged with a timestamp, see
3402 @ref{Tracking TODO state changes}, for more information.
3404 @node TODO types, Multiple sets in one file, Workflow states, TODO extensions
3405 @subsection TODO keywords as types
3407 @cindex names as TODO keywords
3408 @cindex types as TODO keywords
3410 The second possibility is to use TODO keywords to indicate different
3411 @emph{types} of action items. For example, you might want to indicate
3412 that items are for ``work'' or ``home''. Or, when you work with several
3413 people on a single project, you might want to assign action items
3414 directly to persons, by using their names as TODO keywords. This would
3415 be set up like this:
3418 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
3421 In this case, different keywords do not indicate a sequence, but rather
3422 different types. So the normal work flow would be to assign a task to a
3423 person, and later to mark it DONE. Org mode supports this style by adapting
3424 the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
3425 @kbd{t} command in the timeline and agenda buffers.}. When used several
3426 times in succession, it will still cycle through all names, in order to first
3427 select the right type for a task. But when you return to the item after some
3428 time and execute @kbd{C-c C-t} again, it will switch from any name directly
3429 to DONE. Use prefix arguments or completion to quickly select a specific
3430 name. You can also review the items of a specific TODO type in a sparse tree
3431 by using a numeric prefix to @kbd{C-c C-v}. For example, to see all things
3432 Lucy has to do, you would use @kbd{C-3 C-c C-v}. To collect Lucy's items
3433 from all agenda files into a single buffer, you would use the numeric prefix
3434 argument as well when creating the global TODO list: @kbd{C-3 C-c t}.
3436 @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions
3437 @subsection Multiple keyword sets in one file
3438 @cindex TODO keyword sets
3440 Sometimes you may want to use different sets of TODO keywords in
3441 parallel. For example, you may want to have the basic
3442 @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
3443 separate state indicating that an item has been canceled (so it is not
3444 DONE, but also does not require action). Your setup would then look
3448 (setq org-todo-keywords
3449 '((sequence "TODO" "|" "DONE")
3450 (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
3451 (sequence "|" "CANCELED")))
3454 The keywords should all be different, this helps Org mode to keep track
3455 of which subsequence should be used for a given entry. In this setup,
3456 @kbd{C-c C-t} only operates within a subsequence, so it switches from
3457 @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
3458 (nothing) to @code{REPORT}. Therefore you need a mechanism to initially
3459 select the correct sequence. Besides the obvious ways like typing a
3460 keyword or using completion, you may also apply the following commands:
3463 @kindex C-S-@key{right}
3464 @kindex C-S-@key{left}
3465 @kindex C-u C-u C-c C-t
3466 @item C-u C-u C-c C-t
3467 @itemx C-S-@key{right}
3468 @itemx C-S-@key{left}
3469 These keys jump from one TODO subset to the next. In the above example,
3470 @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{right}} would jump from @code{TODO} or
3471 @code{DONE} to @code{REPORT}, and any of the words in the second row to
3472 @code{CANCELED}. Note that the @kbd{C-S-} key binding conflict with
3473 @code{shift-selection-mode} (@pxref{Conflicts}).
3474 @kindex S-@key{right}
3475 @kindex S-@key{left}
3478 @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through @emph{all}
3479 keywords from all sets, so for example @kbd{S-@key{<right>}} would switch
3480 from @code{DONE} to @code{REPORT} in the example above. See also
3481 @ref{Conflicts}, for a discussion of the interaction with
3482 @code{shift-selection-mode}.
3485 @node Fast access to TODO states, Per-file keywords, Multiple sets in one file, TODO extensions
3486 @subsection Fast access to TODO states
3488 If you would like to quickly change an entry to an arbitrary TODO state
3489 instead of cycling through the states, you can set up keys for
3490 single-letter access to the states. This is done by adding the section
3491 key after each keyword, in parentheses. For example:
3494 (setq org-todo-keywords
3495 '((sequence "TODO(t)" "|" "DONE(d)")
3496 (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
3497 (sequence "|" "CANCELED(c)")))
3500 @vindex org-fast-tag-selection-include-todo
3501 If you then press @code{C-c C-t} followed by the selection key, the entry
3502 will be switched to this state. @key{SPC} can be used to remove any TODO
3503 keyword from an entry.@footnote{Check also the variable
3504 @code{org-fast-tag-selection-include-todo}, it allows you to change the TODO
3505 state through the tags interface (@pxref{Setting tags}), in case you like to
3506 mingle the two concepts. Note that this means you need to come up with
3507 unique keys across both sets of keywords.}
3509 @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions
3510 @subsection Setting up keywords for individual files
3511 @cindex keyword options
3512 @cindex per-file keywords
3517 It can be very useful to use different aspects of the TODO mechanism in
3518 different files. For file-local settings, you need to add special lines
3519 to the file which set the keywords and interpretation for that file
3520 only. For example, to set one of the two examples discussed above, you
3521 need one of the following lines, starting in column zero anywhere in the
3525 #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
3527 @noindent (you may also write @code{#+SEQ_TODO} to be explicit about the
3528 interpretation, but it means the same as @code{#+TODO}), or
3530 #+TYP_TODO: Fred Sara Lucy Mike | DONE
3533 A setup for using several sets in parallel would be:
3537 #+TODO: REPORT BUG KNOWNCAUSE | FIXED
3541 @cindex completion, of option keywords
3543 @noindent To make sure you are using the correct keyword, type
3544 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
3546 @cindex DONE, final TODO keyword
3547 Remember that the keywords after the vertical bar (or the last keyword
3548 if no bar is there) must always mean that the item is DONE (although you
3549 may use a different word). After changing one of these lines, use
3550 @kbd{C-c C-c} with the cursor still in the line to make the changes
3551 known to Org mode@footnote{Org mode parses these lines only when
3552 Org mode is activated after visiting a file. @kbd{C-c C-c} with the
3553 cursor in a line starting with @samp{#+} is simply restarting Org mode
3554 for the current buffer.}.
3556 @node Faces for TODO keywords, TODO dependencies, Per-file keywords, TODO extensions
3557 @subsection Faces for TODO keywords
3558 @cindex faces, for TODO keywords
3560 @vindex org-todo @r{(face)}
3561 @vindex org-done @r{(face)}
3562 @vindex org-todo-keyword-faces
3563 Org mode highlights TODO keywords with special faces: @code{org-todo}
3564 for keywords indicating that an item still has to be acted upon, and
3565 @code{org-done} for keywords indicating that an item is finished. If
3566 you are using more than 2 different states, you might want to use
3567 special faces for some of them. This can be done using the variable
3568 @code{org-todo-keyword-faces}. For example:
3572 (setq org-todo-keyword-faces
3573 '(("TODO" . org-warning)
3574 ("DEFERRED" . shadow)
3575 ("CANCELED" . (:foreground "blue" :weight bold))))
3579 While using a list with face properties as shown for CANCELED
3580 @emph{should} work, this does not aways seem to be the case. If
3581 necessary, define a special face and use that.
3583 @node TODO dependencies, , Faces for TODO keywords, TODO extensions
3584 @subsection TODO dependencies
3585 @cindex TODO dependencies
3586 @cindex dependencies, of TODO states
3588 @vindex org-enforce-todo-dependencies
3589 @cindex property, ORDERED
3590 The structure of Org files (hierarchy and lists) makes it easy to define TODO
3591 dependencies. Usually, a parent TODO task should not be marked DONE until
3592 all subtasks (defined as children tasks) are marked as DONE. And sometimes
3593 there is a logical sequence to a number of (sub)tasks, so that one task
3594 cannot be acted upon before all siblings above it are done. If you customize
3595 the variable @code{org-enforce-todo-dependencies}, Org will block entries
3596 from changing state to DONE while they have children that are not DONE.
3597 Furthermore, if an entry has a property @code{ORDERED}, each of its children
3598 will be blocked until all earlier siblings are marked DONE. Here is an
3602 * TODO Blocked until (two) is done
3611 ** TODO b, needs to wait for (a)
3612 ** TODO c, needs to wait for (a) and (b)
3618 @vindex org-track-ordered-property-with-tag
3619 @cindex property, ORDERED
3620 Toggle the @code{ORDERED} property of the current entry. A property is used
3621 for this behavior because this should be local to the current entry, not
3622 inherited like a tag. However, if you would like to @i{track} the value of
3623 this property with a tag for better visibility, customize the variable
3624 @code{org-track-ordered-property-with-tag}.
3625 @kindex C-u C-u C-u C-c C-t
3626 @item C-u C-u C-u C-c C-t
3627 Change TODO state, circumventing any state blocking.
3630 @vindex org-agenda-dim-blocked-tasks
3631 If you set the variable @code{org-agenda-dim-blocked-tasks}, TODO entries
3632 that cannot be closed because of such dependencies will be shown in a dimmed
3633 font or even made invisible in agenda views (@pxref{Agenda Views}).
3635 @cindex checkboxes and TODO dependencies
3636 @vindex org-enforce-todo-dependencies
3637 You can also block changes of TODO states by looking at checkboxes
3638 (@pxref{Checkboxes}). If you set the variable
3639 @code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked
3640 checkboxes will be blocked from switching to DONE.
3642 If you need more complex dependency structures, for example dependencies
3643 between entries in different trees or files, check out the contributed
3644 module @file{org-depend.el}.
3647 @node Progress logging, Priorities, TODO extensions, TODO Items
3648 @section Progress logging
3649 @cindex progress logging
3650 @cindex logging, of progress
3652 Org mode can automatically record a timestamp and possibly a note when
3653 you mark a TODO item as DONE, or even each time you change the state of
3654 a TODO item. This system is highly configurable, settings can be on a
3655 per-keyword basis and can be localized to a file or even a subtree. For
3656 information on how to clock working time for a task, see @ref{Clocking
3660 * Closing items:: When was this entry marked DONE?
3661 * Tracking TODO state changes:: When did the status change?
3664 @node Closing items, Tracking TODO state changes, Progress logging, Progress logging
3665 @subsection Closing items
3667 The most basic logging is to keep track of @emph{when} a certain TODO
3668 item was finished. This is achieved with@footnote{The corresponding
3669 in-buffer setting is: @code{#+STARTUP: logdone}}.
3672 (setq org-log-done 'time)
3676 Then each time you turn an entry from a TODO (not-done) state into any
3677 of the DONE states, a line @samp{CLOSED: [timestamp]} will be inserted
3678 just after the headline. If you turn the entry back into a TODO item
3679 through further state cycling, that line will be removed again. If you
3680 want to record a note along with the timestamp, use@footnote{The
3681 corresponding in-buffer setting is: @code{#+STARTUP: lognotedone}}
3684 (setq org-log-done 'note)
3688 You will then be prompted for a note, and that note will be stored below
3689 the entry with a @samp{Closing Note} heading.
3691 In the timeline (@pxref{Timeline}) and in the agenda
3692 (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
3693 display the TODO items with a @samp{CLOSED} timestamp on each day,
3694 giving you an overview of what has been done.
3696 @node Tracking TODO state changes, , Closing items, Progress logging
3697 @subsection Tracking TODO state changes
3698 @cindex drawer, for state change recording
3700 @vindex org-log-states-order-reversed
3701 @vindex org-log-into-drawer
3702 @cindex property, LOG_INTO_DRAWER
3703 When TODO keywords are used as workflow states (@pxref{Workflow states}), you
3704 might want to keep track of when a state change occurred and maybe take a
3705 note about this change. You can either record just a timestamp, or a
3706 time-stamped note for a change. These records will be inserted after the
3707 headline as an itemized list, newest first@footnote{See the variable
3708 @code{org-log-states-order-reversed}}. When taking a lot of notes, you might
3709 want to get the notes out of the way into a drawer (@pxref{Drawers}).
3710 Customize the variable @code{org-log-into-drawer} to get this
3711 behavior---the recommended drawer for this is called @code{LOGBOOK}. You can
3712 also overrule the setting of this variable for a subtree by setting a
3713 @code{LOG_INTO_DRAWER} property.
3715 Since it is normally too much to record a note for every state, Org mode
3716 expects configuration on a per-keyword basis for this. This is achieved by
3717 adding special markers @samp{!} (for a timestamp) and @samp{@@} (for a note)
3718 in parentheses after each keyword. For example, with the setting
3721 (setq org-todo-keywords
3722 '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
3726 @vindex org-log-done
3727 you not only define global TODO keywords and fast access keys, but also
3728 request that a time is recorded when the entry is set to
3729 DONE@footnote{It is possible that Org mode will record two timestamps
3730 when you are using both @code{org-log-done} and state change logging.
3731 However, it will never prompt for two notes---if you have configured
3732 both, the state change recording note will take precedence and cancel
3733 the @samp{Closing Note}.}, and that a note is recorded when switching to
3734 WAIT or CANCELED. The setting for WAIT is even more special: the
3735 @samp{!} after the slash means that in addition to the note taken when
3736 entering the state, a timestamp should be recorded when @i{leaving} the
3737 WAIT state, if and only if the @i{target} state does not configure
3738 logging for entering it. So it has no effect when switching from WAIT
3739 to DONE, because DONE is configured to record a timestamp only. But
3740 when switching from WAIT back to TODO, the @samp{/!} in the WAIT
3741 setting now triggers a timestamp even though TODO has no logging
3744 You can use the exact same syntax for setting logging preferences local
3747 #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
3750 @cindex property, LOGGING
3751 In order to define logging settings that are local to a subtree or a
3752 single item, define a LOGGING property in this entry. Any non-empty
3753 LOGGING property resets all logging settings to nil. You may then turn
3754 on logging for this specific tree using STARTUP keywords like
3755 @code{lognotedone} or @code{logrepeat}, as well as adding state specific
3756 settings like @code{TODO(!)}. For example
3759 * TODO Log each state with only a time
3761 :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
3763 * TODO Only log when switching to WAIT, and when repeating
3765 :LOGGING: WAIT(@@) logrepeat
3767 * TODO No logging at all
3773 @node Priorities, Breaking down tasks, Progress logging, TODO Items
3777 If you use Org mode extensively, you may end up enough TODO items that
3778 it starts to make sense to prioritize them. Prioritizing can be done by
3779 placing a @emph{priority cookie} into the headline of a TODO item, like
3783 *** TODO [#A] Write letter to Sam Fortune
3787 By default, Org mode supports three priorities: @samp{A}, @samp{B}, and
3788 @samp{C}. @samp{A} is the highest priority. An entry without a cookie
3789 is treated as priority @samp{B}. Priorities make a difference only in
3790 the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they have
3791 no inherent meaning to Org mode.
3793 Priorities can be attached to any outline tree entries; they do not need
3799 Set the priority of the current headline. The command prompts for a
3800 priority character @samp{A}, @samp{B} or @samp{C}. When you press
3801 @key{SPC} instead, the priority cookie is removed from the headline.
3802 The priorities can also be changed ``remotely'' from the timeline and
3803 agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
3806 @kindex S-@key{down}
3809 @vindex org-priority-start-cycle-with-default
3810 Increase/decrease priority of current headline@footnote{See also the option
3811 @code{org-priority-start-cycle-with-default}.}. Note that these keys are
3812 also used to modify timestamps (@pxref{Creating timestamps}). See also
3813 @ref{Conflicts}, for a discussion of the interaction with
3814 @code{shift-selection-mode}.
3817 @vindex org-highest-priority
3818 @vindex org-lowest-priority
3819 @vindex org-default-priority
3820 You can change the range of allowed priorities by setting the variables
3821 @code{org-highest-priority}, @code{org-lowest-priority}, and
3822 @code{org-default-priority}. For an individual buffer, you may set
3823 these values (highest, lowest, default) like this (please make sure that
3824 the highest priority is earlier in the alphabet than the lowest
3827 @cindex #+PRIORITIES
3832 @node Breaking down tasks, Checkboxes, Priorities, TODO Items
3833 @section Breaking tasks down into subtasks
3834 @cindex tasks, breaking down
3835 @cindex statistics, for TODO items
3837 @vindex org-agenda-todo-list-sublevels
3838 It is often advisable to break down large tasks into smaller, manageable
3839 subtasks. You can do this by creating an outline tree below a TODO item,
3840 with detailed subtasks on the tree@footnote{To keep subtasks out of the
3841 global TODO list, see the @code{org-agenda-todo-list-sublevels}.}. To keep
3842 the overview over the fraction of subtasks that are already completed, insert
3843 either @samp{[/]} or @samp{[%]} anywhere in the headline. These cookies will
3844 be updates each time the todo status of a child changes, or when pressing
3845 @kbd{C-c C-c} on the cookie. For example:
3848 * Organize Party [33%]
3849 ** TODO Call people [1/2]
3853 ** DONE Talk to neighbor
3856 @cindex property, COOKIE_DATA
3857 If a heading has both checkboxes and TODO children below it, the meaning of
3858 the statistics cookie become ambiguous. Set the property
3859 @code{COOKIE_DATA} to either @samp{checkbox} or @samp{todo} to resolve
3862 @vindex org-hierarchical-todo-statistics
3863 If you would like to have the statistics cookie count any TODO entries in the
3864 subtree (not just direct children), confgure the variable
3865 @code{org-hierarchical-todo-statistics}. To do this for a single subtree,
3866 include the word @samp{recursive} into the value of the @code{COOKIE_DATA}
3870 * Parent capturing statistics [2/20]
3872 :COOKIE_DATA: todo recursive
3876 If you would like a TODO entry to automatically change to DONE
3877 when all children are done, you can use the following setup:
3880 (defun org-summary-todo (n-done n-not-done)
3881 "Switch entry to DONE when all subentries are done, to TODO otherwise."
3882 (let (org-log-done org-log-states) ; turn off logging
3883 (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
3885 (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
3889 Another possibility is the use of checkboxes to identify (a hierarchy of) a
3890 large number of subtasks (@pxref{Checkboxes}).
3893 @node Checkboxes, , Breaking down tasks, TODO Items
3897 Every item in a plain list (@pxref{Plain lists}) can be made into a
3898 checkbox by starting it with the string @samp{[ ]}. This feature is
3899 similar to TODO items (@pxref{TODO Items}), but is more lightweight.
3900 Checkboxes are not included into the global TODO list, so they are often
3901 great to split a task into a number of simple steps. Or you can use
3902 them in a shopping list. To toggle a checkbox, use @kbd{C-c C-c}, or
3903 use the mouse (thanks to Piotr Zielinski's @file{org-mouse.el}).
3905 Here is an example of a checkbox list.
3908 * TODO Organize party [2/4]
3909 - [-] call people [1/3]
3914 - [ ] think about what music to play
3915 - [X] talk to the neighbors
3918 Checkboxes work hierarchically, so if a checkbox item has children that
3919 are checkboxes, toggling one of the children checkboxes will make the
3920 parent checkbox reflect if none, some, or all of the children are
3923 @cindex statistics, for checkboxes
3924 @cindex checkbox statistics
3925 @cindex property, COOKIE_DATA
3926 @vindex org-hierarchical-checkbox-statistics
3927 The @samp{[2/4]} and @samp{[1/3]} in the first and second line are cookies
3928 indicating how many checkboxes present in this entry have been checked off,
3929 and the total number of checkboxes present. This can give you an idea on how
3930 many checkboxes remain, even without opening a folded entry. The cookies can
3931 be placed into a headline or into (the first line of) a plain list item.
3932 Each cookie covers checkboxes of direct children structurally below the
3933 headline/item on which the cookie appears@footnote{Set the variable
3934 @code{org-hierarchical-checkbox-statistics} if you want such cookies to
3935 represent the all checkboxes below the cookie, not just the direct
3936 children.}. You have to insert the cookie yourself by typing either
3937 @samp{[/]} or @samp{[%]}. With @samp{[/]} you get an @samp{n out of m}
3938 result, as in the examples above. With @samp{[%]} you get information about
3939 the percentage of checkboxes checked (in the above example, this would be
3940 @samp{[50%]} and @samp{[33%]}, respectively). In a headline, a cookie can
3941 count either checkboxes below the heading or TODO states of children, and it
3942 will display whatever was changed last. Set the property @code{COOKIE_DATA}
3943 to either @samp{checkbox} or @samp{todo} to resolve this issue.
3945 @cindex blocking, of checkboxes
3946 @cindex checkbox blocking
3947 @cindex property, ORDERED
3948 If the current outline node has an @code{ORDERED} property, checkboxes must
3949 be checked off in sequence, and an error will be thrown if you try to check
3950 off a box while there are unchecked boxes above it.
3952 @noindent The following commands work with checkboxes:
3957 Toggle checkbox status or (with prefix arg) checkbox presence at point. With
3958 double prefix argument, set it to @samp{[-]}, which is considered to be an
3962 Toggle checkbox status or (with prefix arg) checkbox presence at point. With
3963 double prefix argument, set it to @samp{[-]}, which is considered to be an
3967 If there is an active region, toggle the first checkbox in the region
3968 and set all remaining boxes to the same status as the first. With a prefix
3969 arg, add or remove the checkbox for all items in the region.
3971 If the cursor is in a headline, toggle checkboxes in the region between
3972 this headline and the next (so @emph{not} the entire subtree).
3974 If there is no active region, just toggle the checkbox at point.
3976 @kindex M-S-@key{RET}
3978 Insert a new item with a checkbox.
3979 This works only if the cursor is already in a plain list item
3980 (@pxref{Plain lists}).
3983 @vindex org-track-ordered-property-with-tag
3984 @cindex property, ORDERED
3985 Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
3986 be checked off in sequence. A property is used for this behavior because
3987 this should be local to the current entry, not inherited like a tag.
3988 However, if you would like to @i{track} the value of this property with a tag
3989 for better visibility, customize the variable
3990 @code{org-track-ordered-property-with-tag}.
3993 Update the statistics cookie in the current outline entry. When called with
3994 a @kbd{C-u} prefix, update the entire file. Checkbox statistic cookies are
3995 updated automatically if you toggle checkboxes with @kbd{C-c C-c} and make
3996 new ones with @kbd{M-S-@key{RET}}. TODO statistics cookies update when
3997 changing TODO states. If you delete boxes/entries or add/change them by
3998 hand, use this command to get things back into sync. Or simply toggle any
3999 entry twice (checkboxes with @kbd{C-c C-c}).
4002 @node Tags, Properties and Columns, TODO Items, Top
4005 @cindex headline tagging
4006 @cindex matching, tags
4007 @cindex sparse tree, tag based
4009 An excellent way to implement labels and contexts for cross-correlating
4010 information is to assign @i{tags} to headlines. Org mode has extensive
4013 @vindex org-tag-faces
4014 Every headline can contain a list of tags; they occur at the end of the
4015 headline. Tags are normal words containing letters, numbers, @samp{_}, and
4016 @samp{@@}. Tags must be preceded and followed by a single colon, @eg{},
4017 @samp{:work:}. Several tags can be specified, as in @samp{:work:urgent:}.
4018 Tags will by default be in bold face with the same color as the headline.
4019 You may specify special faces for specific tags using the variable
4020 @code{org-tag-faces}, in much the same way as you can for TODO keywords
4021 (@pxref{Faces for TODO keywords}).
4024 * Tag inheritance:: Tags use the tree structure of the outline
4025 * Setting tags:: How to assign tags to a headline
4026 * Tag searches:: Searching for combinations of tags
4029 @node Tag inheritance, Setting tags, Tags, Tags
4030 @section Tag inheritance
4031 @cindex tag inheritance
4032 @cindex inheritance, of tags
4033 @cindex sublevels, inclusion into tags match
4035 @i{Tags} make use of the hierarchical structure of outline trees. If a
4036 heading has a certain tag, all subheadings will inherit the tag as
4037 well. For example, in the list
4040 * Meeting with the French group :work:
4041 ** Summary by Frank :boss:notes:
4042 *** TODO Prepare slides for him :action:
4046 the final heading will have the tags @samp{:work:}, @samp{:boss:},
4047 @samp{:notes:}, and @samp{:action:} even though the final heading is not
4048 explicitly marked with those tags. You can also set tags that all entries in
4049 a file should inherit just as if these tags were defined in a hypothetical
4050 level zero that surrounds the entire file. Use a line like this@footnote{As
4051 with all these in-buffer settings, pressing @kbd{C-c C-c} activates any
4052 changes in the line.}:
4056 #+FILETAGS: :Peter:Boss:Secret:
4060 @vindex org-use-tag-inheritance
4061 @vindex org-tags-exclude-from-inheritance
4062 To limit tag inheritance to specific tags, or to turn it off entirely, use
4063 the variables @code{org-use-tag-inheritance} and
4064 @code{org-tags-exclude-from-inheritance}.
4066 @vindex org-tags-match-list-sublevels
4067 When a headline matches during a tags search while tag inheritance is turned
4068 on, all the sublevels in the same tree will (for a simple match form) match
4069 as well@footnote{This is only true if the search does not involve more
4070 complex tests including properties (@pxref{Property searches}).}. The list
4071 of matches may then become very long. If you only want to see the first tags
4072 match in a subtree, configure the variable
4073 @code{org-tags-match-list-sublevels} (not recommended).
4075 @node Setting tags, Tag searches, Tag inheritance, Tags
4076 @section Setting tags
4077 @cindex setting tags
4078 @cindex tags, setting
4081 Tags can simply be typed into the buffer at the end of a headline.
4082 After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is
4083 also a special command for inserting tags:
4088 @cindex completion, of tags
4089 @vindex org-tags-column
4090 Enter new tags for the current headline. Org mode will either offer
4091 completion or a special single-key interface for setting tags, see
4092 below. After pressing @key{RET}, the tags will be inserted and aligned
4093 to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all
4094 tags in the current buffer will be aligned to that column, just to make
4095 things look nice. TAGS are automatically realigned after promotion,
4096 demotion, and TODO state changes (@pxref{TODO basics}).
4099 When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
4102 @vindex org-tag-alist
4103 Org will support tag insertion based on a @emph{list of tags}. By
4104 default this list is constructed dynamically, containing all tags
4105 currently used in the buffer. You may also globally specify a hard list
4106 of tags with the variable @code{org-tag-alist}. Finally you can set
4107 the default tags for a given file with lines like
4111 #+TAGS: @@work @@home @@tennisclub
4112 #+TAGS: laptop car pc sailboat
4115 If you have globally defined your preferred set of tags using the
4116 variable @code{org-tag-alist}, but would like to use a dynamic tag list
4117 in a specific file, add an empty TAGS option line to that file:
4123 @vindex org-tag-persistent-alist
4124 If you have a preferred set of tags that you would like to use in every file,
4125 in addition to those defined on a per-file basis by TAGS option lines, then
4126 you may specify a list of tags with the variable
4127 @code{org-tag-persistent-alist}. You may turn this off on a per-file basis
4128 by adding a STARTUP option line to that file:
4134 By default Org mode uses the standard minibuffer completion facilities for
4135 entering tags. However, it also implements another, quicker, tag selection
4136 method called @emph{fast tag selection}. This allows you to select and
4137 deselect tags with just a single key press. For this to work well you should
4138 assign unique letters to most of your commonly used tags. You can do this
4139 globally by configuring the variable @code{org-tag-alist} in your
4140 @file{.emacs} file. For example, you may find the need to tag many items in
4141 different files with @samp{:@@home:}. In this case you can set something
4145 (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
4148 @noindent If the tag is only relevant to the file you are working on, then you
4149 can instead set the TAGS option line as:
4152 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p)
4155 @noindent The tags interface will show the available tags in a splash
4156 window. If you want to start a new line after a specific tag, insert
4157 @samp{\n} into the tag list
4160 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) \n laptop(l) pc(p)
4163 @noindent or write them in two lines:
4166 #+TAGS: @@work(w) @@home(h) @@tennisclub(t)
4167 #+TAGS: laptop(l) pc(p)
4171 You can also group together tags that are mutually exclusive by using
4175 #+TAGS: @{ @@work(w) @@home(h) @@tennisclub(t) @} laptop(l) pc(p)
4178 @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
4179 and @samp{@@tennisclub} should be selected. Multiple such groups are allowed.
4181 @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
4182 these lines to activate any changes.
4185 To set these mutually exclusive groups in the variable @code{org-tags-alist},
4186 you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
4187 of the braces. Similarly, you can use @code{:newline} to indicate a line
4188 break. The previous example would be set globally by the following
4192 (setq org-tag-alist '((:startgroup . nil)
4193 ("@@work" . ?w) ("@@home" . ?h)
4194 ("@@tennisclub" . ?t)
4196 ("laptop" . ?l) ("pc" . ?p)))
4199 If at least one tag has a selection key then pressing @kbd{C-c C-c} will
4200 automatically present you with a special interface, listing inherited tags,
4201 the tags of the current headline, and a list of all valid tags with
4202 corresponding keys@footnote{Keys will automatically be assigned to tags which
4203 have no configured keys.}. In this interface, you can use the following
4208 Pressing keys assigned to tags will add or remove them from the list of
4209 tags in the current line. Selecting a tag in a group of mutually
4210 exclusive tags will turn off any other tags from that group.
4213 Enter a tag in the minibuffer, even if the tag is not in the predefined
4214 list. You will be able to complete on all tags present in the buffer.
4217 Clear all tags for this line.
4220 Accept the modified set.
4222 Abort without installing changes.
4224 If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
4226 Turn off groups of mutually exclusive tags. Use this to (as an
4227 exception) assign several tags from such a group.
4229 Toggle auto-exit after the next change (see below).
4230 If you are using expert mode, the first @kbd{C-c} will display the
4235 This method lets you assign tags to a headline with very few keys. With
4236 the above setup, you could clear the current tags and set @samp{@@home},
4237 @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
4238 C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@home} to
4239 @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
4240 alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag
4241 @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
4242 @key{RET} @key{RET}}.
4244 @vindex org-fast-tag-selection-single-key
4245 If you find that most of the time you need only a single key press to
4246 modify your list of tags, set the variable
4247 @code{org-fast-tag-selection-single-key}. Then you no longer have to
4248 press @key{RET} to exit fast tag selection---it will immediately exit
4249 after the first change. If you then occasionally need more keys, press
4250 @kbd{C-c} to turn off auto-exit for the current tag selection process
4251 (in effect: start selection with @kbd{C-c C-c C-c} instead of @kbd{C-c
4252 C-c}). If you set the variable to the value @code{expert}, the special
4253 window is not even shown for single-key tag selection, it comes up only
4254 when you press an extra @kbd{C-c}.
4256 @node Tag searches, , Setting tags, Tags
4257 @section Tag searches
4258 @cindex tag searches
4259 @cindex searching for tags
4261 Once a system of tags has been set up, it can be used to collect related
4262 information into special lists.
4269 Create a sparse tree with all headlines matching a tags search. With a
4270 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
4273 Create a global list of tag matches from all agenda files.
4274 @xref{Matching tags and properties}.
4277 @vindex org-tags-match-list-sublevels
4278 Create a global list of tag matches from all agenda files, but check
4279 only TODO items and force checking subitems (see variable
4280 @code{org-tags-match-list-sublevels}).
4283 These commands all prompt for a match string which allows basic Boolean logic
4284 like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and
4285 @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries
4286 which are tagged, like @samp{Kathy} or @samp{Sally}. The full syntax of the search
4287 string is rich and allows also matching against TODO keywords, entry levels
4288 and properties. For a complete description with many examples, see
4289 @ref{Matching tags and properties}.
4292 @node Properties and Columns, Dates and Times, Tags, Top
4293 @chapter Properties and Columns
4296 Properties are a set of key-value pairs associated with an entry. There
4297 are two main applications for properties in Org mode. First, properties
4298 are like tags, but with a value. Second, you can use properties to
4299 implement (very basic) database capabilities in an Org buffer. For
4300 an example of the first application, imagine maintaining a file where
4301 you document bugs and plan releases for a piece of software. Instead of
4302 using tags like @code{:release_1:}, @code{:release_2:}, one can use a
4303 property, say @code{:Release:}, that in different subtrees has different
4304 values, such as @code{1.0} or @code{2.0}. For an example of the second
4305 application of properties, imagine keeping track of your music CDs,
4306 where properties could be things such as the album, artist, date of
4307 release, number of tracks, and so on.
4309 Properties can be conveniently edited and viewed in column view
4310 (@pxref{Column view}).
4313 * Property syntax:: How properties are spelled out
4314 * Special properties:: Access to other Org mode features
4315 * Property searches:: Matching property values
4316 * Property inheritance:: Passing values down the tree
4317 * Column view:: Tabular viewing and editing
4318 * Property API:: Properties for Lisp programmers
4321 @node Property syntax, Special properties, Properties and Columns, Properties and Columns
4322 @section Property syntax
4323 @cindex property syntax
4324 @cindex drawer, for properties
4326 Properties are key-value pairs. They need to be inserted into a special
4327 drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property
4328 is specified on a single line, with the key (surrounded by colons)
4329 first, and the value after it. Here is an example:
4334 *** Goldberg Variations
4336 :Title: Goldberg Variations
4337 :Composer: J.S. Bach
4339 :Publisher: Deutsche Grammophon
4344 You may define the allowed values for a particular property @samp{:Xyz:}
4345 by setting a property @samp{:Xyz_ALL:}. This special property is
4346 @emph{inherited}, so if you set it in a level 1 entry, it will apply to
4347 the entire tree. When allowed values are defined, setting the
4348 corresponding property becomes easier and is less prone to typing
4349 errors. For the example with the CD collection, we can predefine
4350 publishers and the number of disks in a box like this:
4355 :NDisks_ALL: 1 2 3 4
4356 :Publisher_ALL: "Deutsche Grammophon" Philips EMI
4360 If you want to set properties that can be inherited by any entry in a
4361 file, use a line like
4362 @cindex property, _ALL
4365 #+PROPERTY: NDisks_ALL 1 2 3 4
4368 @vindex org-global-properties
4369 Property values set with the global variable
4370 @code{org-global-properties} can be inherited by all entries in all
4374 The following commands help to work with properties:
4379 After an initial colon in a line, complete property keys. All keys used
4380 in the current file will be offered as possible completions.
4383 Set a property. This prompts for a property name and a value. If
4384 necessary, the property drawer is created as well.
4385 @item M-x org-insert-property-drawer
4386 Insert a property drawer into the current entry. The drawer will be
4387 inserted early in the entry, but after the lines with planning
4388 information like deadlines.
4391 With the cursor in a property drawer, this executes property commands.
4393 Set a property in the current entry. Both the property and the value
4394 can be inserted using completion.
4395 @kindex S-@key{right}
4396 @kindex S-@key{left}
4397 @item S-@key{left}/@key{right}
4398 Switch property at point to the next/previous allowed value.
4400 Remove a property from the current entry.
4402 Globally remove a property, from all entries in the current file.
4404 Compute the property at point, using the operator and scope from the
4405 nearest column format definition.
4408 @node Special properties, Property searches, Property syntax, Properties and Columns
4409 @section Special properties
4410 @cindex properties, special
4412 Special properties provide an alternative access method to Org mode
4413 features, like the TODO state or the priority of an entry, discussed in the
4414 previous chapters. This interface exists so that you can include
4415 these states in a column view (@pxref{Column view}), or to use them in
4416 queries. The following property names are special and should not be
4417 used as keys in the properties drawer:
4419 @cindex property, special, TODO
4420 @cindex property, special, TAGS
4421 @cindex property, special, ALLTAGS
4422 @cindex property, special, CATEGORY
4423 @cindex property, special, PRIORITY
4424 @cindex property, special, DEADLINE
4425 @cindex property, special, SCHEDULED
4426 @cindex property, special, CLOSED
4427 @cindex property, special, TIMESTAMP
4428 @cindex property, special, TIMESTAMP_IA
4429 @cindex property, special, CLOCKSUM
4430 @c guessing that ITEM is needed in this area; also, should this list be sorted?
4431 @cindex property, special, ITEM
4433 TODO @r{The TODO keyword of the entry.}
4434 TAGS @r{The tags defined directly in the headline.}
4435 ALLTAGS @r{All tags, including inherited ones.}
4436 CATEGORY @r{The category of an entry.}
4437 PRIORITY @r{The priority of the entry, a string with a single letter.}
4438 DEADLINE @r{The deadline time string, without the angular brackets.}
4439 SCHEDULED @r{The scheduling timestamp, without the angular brackets.}
4440 CLOSED @r{When was this entry closed?}
4441 TIMESTAMP @r{The first keyword-less timestamp in the entry.}
4442 TIMESTAMP_IA @r{The first inactive timestamp in the entry.}
4443 CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}}
4444 @r{must be run first to compute the values.}
4445 ITEM @r{The content of the entry.}
4448 @node Property searches, Property inheritance, Special properties, Properties and Columns
4449 @section Property searches
4450 @cindex properties, searching
4451 @cindex searching, of properties
4453 To create sparse trees and special lists with selection based on properties,
4454 the same commands are used as for tag searches (@pxref{Tag searches}).
4460 Create a sparse tree with all matching entries. With a
4461 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
4464 Create a global list of tag/property matches from all agenda files.
4465 @xref{Matching tags and properties}.
4468 @vindex org-tags-match-list-sublevels
4469 Create a global list of tag matches from all agenda files, but check
4470 only TODO items and force checking of subitems (see variable
4471 @code{org-tags-match-list-sublevels}).
4474 The syntax for the search string is described in @ref{Matching tags and
4477 There is also a special command for creating sparse trees based on a
4483 Create a sparse tree based on the value of a property. This first
4484 prompts for the name of a property, and then for a value. A sparse tree
4485 is created with all entries that define this property with the given
4486 value. If you enclose the value into curly braces, it is interpreted as
4487 a regular expression and matched against the property values.
4490 @node Property inheritance, Column view, Property searches, Properties and Columns
4491 @section Property Inheritance
4492 @cindex properties, inheritance
4493 @cindex inheritance, of properties
4495 @vindex org-use-property-inheritance
4496 The outline structure of Org-mode documents lends itself for an
4497 inheritance model of properties: if the parent in a tree has a certain
4498 property, the children can inherit this property. Org mode does not
4499 turn this on by default, because it can slow down property searches
4500 significantly and is often not needed. However, if you find inheritance
4501 useful, you can turn it on by setting the variable
4502 @code{org-use-property-inheritance}. It may be set to @code{t} to make
4503 all properties inherited from the parent, to a list of properties
4504 that should be inherited, or to a regular expression that matches
4505 inherited properties.
4507 Org mode has a few properties for which inheritance is hard-coded, at
4508 least for the special applications for which they are used:
4510 @cindex property, COLUMNS
4513 The @code{:COLUMNS:} property defines the format of column view
4514 (@pxref{Column view}). It is inherited in the sense that the level
4515 where a @code{:COLUMNS:} property is defined is used as the starting
4516 point for a column view table, independently of the location in the
4517 subtree from where columns view is turned on.
4519 @cindex property, CATEGORY
4520 For agenda view, a category set through a @code{:CATEGORY:} property
4521 applies to the entire subtree.
4523 @cindex property, ARCHIVE
4524 For archiving, the @code{:ARCHIVE:} property may define the archive
4525 location for the entire subtree (@pxref{Moving subtrees}).
4527 @cindex property, LOGGING
4528 The LOGGING property may define logging settings for an entry or a
4529 subtree (@pxref{Tracking TODO state changes}).
4532 @node Column view, Property API, Property inheritance, Properties and Columns
4533 @section Column view
4535 A great way to view and edit properties in an outline tree is
4536 @emph{column view}. In column view, each outline node is turned into a
4537 table row. Columns in this table provide access to properties of the
4538 entries. Org mode implements columns by overlaying a tabular structure
4539 over the headline of each item. While the headlines have been turned
4540 into a table row, you can still change the visibility of the outline
4541 tree. For example, you get a compact table by switching to CONTENTS
4542 view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
4543 is active), but you can still open, read, and edit the entry below each
4544 headline. Or, you can switch to column view after executing a sparse
4545 tree command and in this way get a table only for the selected items.
4546 Column view also works in agenda buffers (@pxref{Agenda Views}) where
4547 queries have collected selected items, possibly from a number of files.
4550 * Defining columns:: The COLUMNS format property
4551 * Using column view:: How to create and use column view
4552 * Capturing column view:: A dynamic block for column view
4555 @node Defining columns, Using column view, Column view, Column view
4556 @subsection Defining columns
4557 @cindex column view, for properties
4558 @cindex properties, column view
4560 Setting up a column view first requires defining the columns. This is
4561 done by defining a column format line.
4564 * Scope of column definitions:: Where defined, where valid?
4565 * Column attributes:: Appearance and content of a column
4568 @node Scope of column definitions, Column attributes, Defining columns, Defining columns
4569 @subsubsection Scope of column definitions
4571 To define a column format for an entire file, use a line like
4575 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
4578 To specify a format that only applies to a specific tree, add a
4579 @code{:COLUMNS:} property to the top node of that tree, for example:
4582 ** Top node for columns view
4584 :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
4588 If a @code{:COLUMNS:} property is present in an entry, it defines columns
4589 for the entry itself, and for the entire subtree below it. Since the
4590 column definition is part of the hierarchical structure of the document,
4591 you can define columns on level 1 that are general enough for all
4592 sublevels, and more specific columns further down, when you edit a
4593 deeper part of the tree.
4595 @node Column attributes, , Scope of column definitions, Defining columns
4596 @subsubsection Column attributes
4597 A column definition sets the attributes of a column. The general
4598 definition looks like this:
4601 %[@var{width}]@var{property}[(@var{title})][@{@var{summary-type}@}]
4605 Except for the percent sign and the property name, all items are
4606 optional. The individual parts have the following meaning:
4609 @var{width} @r{An integer specifying the width of the column in characters.}
4610 @r{If omitted, the width will be determined automatically.}
4611 @var{property} @r{The property that should be edited in this column.}
4612 (title) @r{The header text for the column. If omitted, the}
4613 @r{property name is used.}
4614 @{@var{summary-type}@} @r{The summary type. If specified, the column values for}
4615 @r{parent nodes are computed from the children.}
4616 @r{Supported summary types are:}
4617 @{+@} @r{Sum numbers in this column.}
4618 @{+;%.1f@} @r{Like @samp{+}, but format result with @samp{%.1f}.}
4619 @{$@} @r{Currency, short for @samp{+;%.2f}.}
4620 @{:@} @r{Sum times, HH:MM:SS, plain numbers are hours.}
4621 @{X@} @r{Checkbox status, @samp{[X]} if all children are @samp{[X]}.}
4622 @{X/@} @r{Checkbox status, @samp{[n/m]}.}
4623 @{X%@} @r{Checkbox status, @samp{[n%]}.}
4624 @{min@} @r{Smallest number in column.}
4625 @{max@} @r{Largest number.}
4626 @{mean@} @r{Arithmetic mean of numbers.}
4627 @{:min@} @r{Smallest time value in column.}
4628 @{:max@} @r{Largest time value.}
4629 @{:mean@} @r{Arithmetic mean of time values.}
4633 Here is an example for a complete columns definition, along with allowed
4637 :COLUMNS: %25ITEM %9Approved(Approved?)@{X@} %Owner %11Status \@footnote{Please note that the COLUMNS definition must be on a single line---it is wrapped here only because of formatting constraints.}
4638 %10Time_Estimate@{:@} %CLOCKSUM
4639 :Owner_ALL: Tammy Mark Karl Lisa Don
4640 :Status_ALL: "In progress" "Not started yet" "Finished" ""
4641 :Approved_ALL: "[ ]" "[X]"
4645 The first column, @samp{%25ITEM}, means the first 25 characters of the
4646 item itself, @ie of the headline. You probably always should start the
4647 column definition with the @samp{ITEM} specifier. The other specifiers
4648 create columns @samp{Owner} with a list of names as allowed values, for
4649 @samp{Status} with four different possible values, and for a checkbox
4650 field @samp{Approved}. When no width is given after the @samp{%}
4651 character, the column will be exactly as wide as it needs to be in order
4652 to fully display all values. The @samp{Approved} column does have a
4653 modified title (@samp{Approved?}, with a question mark). Summaries will
4654 be created for the @samp{Time_Estimate} column by adding time duration
4655 expressions like HH:MM, and for the @samp{Approved} column, by providing
4656 an @samp{[X]} status if all children have been checked. The
4657 @samp{CLOCKSUM} column is special, it lists the sum of CLOCK intervals
4660 @node Using column view, Capturing column view, Defining columns, Column view
4661 @subsection Using column view
4664 @tsubheading{Turning column view on and off}
4667 @vindex org-columns-default-format
4668 Turn on column view. If the cursor is before the first headline in the file,
4669 column view is turned on for the entire file, using the @code{#+COLUMNS}
4670 definition. If the cusor is somewhere inside the outline, this command
4671 searches the hierarchy, up from point, for a @code{:COLUMNS:} property that
4672 defines a format. When one is found, the column view table is established
4673 for the tree starting at the entry that contains the @code{:COLUMNS:}
4674 property. If no such property is found, the format is taken from the
4675 @code{#+COLUMNS} line or from the variable @code{org-columns-default-format},
4676 and column view is established for the current entry and its subtree.
4679 Recreate the column view, to include recent changes made in the buffer.
4686 @tsubheading{Editing values}
4687 @item @key{left} @key{right} @key{up} @key{down}
4688 Move through the column view from field to field.
4689 @kindex S-@key{left}
4690 @kindex S-@key{right}
4691 @item S-@key{left}/@key{right}
4692 Switch to the next/previous allowed value of the field. For this, you
4693 have to have specified allowed values for a property.
4695 Directly select the nth allowed value, @kbd{0} selects the 10th value.
4699 Same as @kbd{S-@key{left}/@key{right}}
4702 Edit the property at point. For the special properties, this will
4703 invoke the same interface that you normally use to change that
4704 property. For example, when editing a TAGS property, the tag completion
4705 or fast selection interface will pop up.
4708 When there is a checkbox at point, toggle it.
4711 View the full value of this property. This is useful if the width of
4712 the column is smaller than that of the value.
4715 Edit the list of allowed values for this property. If the list is found
4716 in the hierarchy, the modified values is stored there. If no list is
4717 found, the new value is stored in the first entry that is part of the
4718 current column view.
4719 @tsubheading{Modifying the table structure}
4723 Make the column narrower/wider by one character.
4724 @kindex S-M-@key{right}
4725 @item S-M-@key{right}
4726 Insert a new column, to the left of the current column.
4727 @kindex S-M-@key{left}
4728 @item S-M-@key{left}
4729 Delete the current column.
4732 @node Capturing column view, , Using column view, Column view
4733 @subsection Capturing column view
4735 Since column view is just an overlay over a buffer, it cannot be
4736 exported or printed directly. If you want to capture a column view, use
4737 a @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame
4738 of this block looks like this:
4740 @cindex #+BEGIN, columnview
4743 #+BEGIN: columnview :hlines 1 :id "label"
4748 @noindent This dynamic block has the following parameters:
4752 This is the most important parameter. Column view is a feature that is
4753 often localized to a certain (sub)tree, and the capture block might be
4754 at a different location in the file. To identify the tree whose view to
4755 capture, you can use 4 values:
4756 @cindex property, ID
4758 local @r{use the tree in which the capture block is located}
4759 global @r{make a global view, including all headings in the file}
4760 "file:@var{path-to-file}"
4761 @r{run column view at the top of this file}
4762 "@var{ID}" @r{call column view in the tree that has an @code{:ID:}}
4763 @r{property with the value @i{label}. You can use}
4764 @r{@kbd{M-x org-id-copy} to create a globally unique ID for}
4765 @r{the current entry and copy it to the kill-ring.}
4768 When @code{t}, insert an hline after every line. When a number @var{N}, insert
4769 an hline before each headline with level @code{<= @var{N}}.
4771 When set to @code{t}, force column groups to get vertical lines.
4773 When set to a number, don't capture entries below this level.
4774 @item :skip-empty-rows
4775 When set to @code{t}, skip rows where the only non-empty specifier of the
4776 column view is @code{ITEM}.
4781 The following commands insert or update the dynamic block:
4786 Insert a dynamic block capturing a column view. You will be prompted
4787 for the scope or ID of the view.
4792 Update dynamic block at point. The cursor needs to be in the
4793 @code{#+BEGIN} line of the dynamic block.
4794 @kindex C-u C-c C-x C-u
4795 @item C-u C-c C-x C-u
4796 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
4797 you have several clock table blocks in a buffer.
4800 You can add formulas to the column view table and you may add plotting
4801 instructions in front of the table---these will survive an update of the
4802 block. If there is a @code{#+TBLFM:} after the table, the table will
4803 actually be recalculated automatically after an update.
4805 An alternative way to capture and process property values into a table is
4806 provided by Eric Schulte's @file{org-collector.el} which is a contributed
4807 package@footnote{Contributed packages are not part of Emacs, but are
4808 distributed with the main distribution of Org (visit
4809 @uref{http://orgmode.org}).}. It provides a general API to collect
4810 properties from entries in a certain scope, and arbitrary Lisp expressions to
4811 process these values before inserting them into a table or a dynamic block.
4813 @node Property API, , Column view, Properties and Columns
4814 @section The Property API
4815 @cindex properties, API
4816 @cindex API, for properties
4818 There is a full API for accessing and changing properties. This API can
4819 be used by Emacs Lisp programs to work with properties and to implement
4820 features based on them. For more information see @ref{Using the
4823 @node Dates and Times, Capture, Properties and Columns, Top
4824 @chapter Dates and Times
4830 To assist project planning, TODO items can be labeled with a date and/or
4831 a time. The specially formatted string carrying the date and time
4832 information is called a @emph{timestamp} in Org mode. This may be a
4833 little confusing because timestamp is often used as indicating when
4834 something was created or last changed. However, in Org mode this term
4835 is used in a much wider sense.
4838 * Timestamps:: Assigning a time to a tree entry
4839 * Creating timestamps:: Commands which insert timestamps
4840 * Deadlines and scheduling:: Planning your work
4841 * Clocking work time:: Tracking how long you spend on a task
4842 * Effort estimates:: Planning work effort in advance
4843 * Relative timer:: Notes with a running timer
4847 @node Timestamps, Creating timestamps, Dates and Times, Dates and Times
4848 @section Timestamps, deadlines, and scheduling
4850 @cindex ranges, time
4855 A timestamp is a specification of a date (possibly with a time or a range of
4856 times) in a special format, either @samp{<2003-09-16 Tue>} or
4857 @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16 Tue
4858 12:00-12:30>}@footnote{This is inspired by the standard ISO 6801 date/time
4859 format. To use an alternative format, see @ref{Custom time format}.}. A
4860 timestamp can appear anywhere in the headline or body of an Org tree entry.
4861 Its presence causes entries to be shown on specific dates in the agenda
4862 (@pxref{Weekly/daily agenda}). We distinguish:
4865 @item Plain timestamp; Event; Appointment
4867 A simple timestamp just assigns a date/time to an item. This is just
4868 like writing down an appointment or event in a paper agenda. In the
4869 timeline and agenda displays, the headline of an entry associated with a
4870 plain timestamp will be shown exactly on that date.
4873 * Meet Peter at the movies <2006-11-01 Wed 19:15>
4874 * Discussion on climate change <2006-11-02 Thu 20:00-22:00>
4877 @item Timestamp with repeater interval
4878 @cindex timestamp, with repeater interval
4879 A timestamp may contain a @emph{repeater interval}, indicating that it
4880 applies not only on the given date, but again and again after a certain
4881 interval of N days (d), weeks (w), months (m), or years (y). The
4882 following will show up in the agenda every Wednesday:
4885 * Pick up Sam at school <2007-05-16 Wed 12:30 +1w>
4888 @item Diary-style sexp entries
4889 For more complex date specifications, Org mode supports using the
4890 special sexp diary entries implemented in the Emacs calendar/diary
4891 package. For example
4894 * The nerd meeting on every 2nd Thursday of the month
4895 <%%(diary-float t 4 2)>
4898 @item Time/Date range
4901 Two timestamps connected by @samp{--} denote a range. The headline
4902 will be shown on the first and last day of the range, and on any dates
4903 that are displayed and fall in the range. Here is an example:
4906 ** Meeting in Amsterdam
4907 <2004-08-23 Mon>--<2004-08-26 Thu>
4910 @item Inactive timestamp
4911 @cindex timestamp, inactive
4912 @cindex inactive timestamp
4913 Just like a plain timestamp, but with square brackets instead of
4914 angular ones. These timestamps are inactive in the sense that they do
4915 @emph{not} trigger an entry to show up in the agenda.
4918 * Gillian comes late for the fifth time [2006-11-01 Wed]
4923 @node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times
4924 @section Creating timestamps
4925 @cindex creating timestamps
4926 @cindex timestamps, creating
4928 For Org mode to recognize timestamps, they need to be in the specific
4929 format. All commands listed below produce timestamps in the correct
4935 Prompt for a date and insert a corresponding timestamp. When the cursor is
4936 at an existing timestamp in the buffer, the command is used to modify this
4937 timestamp instead of inserting a new one. When this command is used twice in
4938 succession, a time range is inserted.
4942 Like @kbd{C-c .}, but insert an inactive timestamp that will not cause
4949 @vindex org-time-stamp-rounding-minutes
4950 Like @kbd{C-c .} and @kbd{C-c !}, but use the alternative format which
4951 contains date and time. The default time can be rounded to multiples of 5
4952 minutes, see the option @code{org-time-stamp-rounding-minutes}.
4956 Insert a timestamp corresponding to the cursor date in the Calendar.
4960 Access the Emacs calendar for the current date. If there is a
4961 timestamp in the current line, go to the corresponding date
4966 Access the agenda for the date given by the timestamp or -range at
4967 point (@pxref{Weekly/daily agenda}).
4969 @kindex S-@key{left}
4970 @kindex S-@key{right}
4972 @itemx S-@key{right}
4973 Change date at cursor by one day. These key bindings conflict with
4974 shift-selection and related modes (@pxref{Conflicts}).
4977 @kindex S-@key{down}
4980 Change the item under the cursor in a timestamp. The cursor can be on a
4981 year, month, day, hour or minute. When the timestamp contains a time range
4982 like @samp{15:30-16:30}, modifying the first time will also shift the second,
4983 shifting the time block with constant length. To change the length, modify
4984 the second time. Note that if the cursor is in a headline and not at a
4985 timestamp, these same keys modify the priority of an item.
4986 (@pxref{Priorities}). The key bindings also conflict with shift-selection and
4987 related modes (@pxref{Conflicts}).
4990 @cindex evaluate time range
4992 Evaluate a time range by computing the difference between start and end.
4993 With a prefix argument, insert result after the time range (in a table: into
4994 the following column).
4999 * The date/time prompt:: How Org mode helps you entering date and time
5000 * Custom time format:: Making dates look different
5003 @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps
5004 @subsection The date/time prompt
5005 @cindex date, reading in minibuffer
5006 @cindex time, reading in minibuffer
5008 @vindex org-read-date-prefer-future
5009 When Org mode prompts for a date/time, the default is shown in default
5010 date/time format, and the prompt therefore seems to ask for a specific
5011 format. But it will in fact accept any string containing some date and/or
5012 time information, and it is really smart about interpreting your input. You
5013 can, for example, use @kbd{C-y} to paste a (possibly multi-line) string
5014 copied from an email message. Org mode will find whatever information is in
5015 there and derive anything you have not specified from the @emph{default date
5016 and time}. The default is usually the current date and time, but when
5017 modifying an existing timestamp, or when entering the second stamp of a
5018 range, it is taken from the stamp in the buffer. When filling in
5019 information, Org mode assumes that most of the time you will want to enter a
5020 date in the future: if you omit the month/year and the given day/month is
5021 @i{before} today, it will assume that you mean a future date@footnote{See the
5022 variable @code{org-read-date-prefer-future}.}.
5024 For example, let's assume that today is @b{June 13, 2006}. Here is how
5025 various inputs will be interpreted, the items filled in by Org mode are
5029 3-2-5 --> 2003-02-05
5030 14 --> @b{2006}-@b{06}-14
5031 12 --> @b{2006}-@b{07}-12
5032 Fri --> nearest Friday (defaultdate or later)
5033 sep 15 --> @b{2006}-09-15
5034 feb 15 --> @b{2007}-02-15
5035 sep 12 9 --> 2009-09-12
5036 12:45 --> @b{2006}-@b{06}-@b{13} 12:45
5037 22 sept 0:34 --> @b{2006}-09-22 0:34
5038 w4 --> ISO week for of the current year @b{2006}
5039 2012 w4 fri --> Friday of ISO week 4 in 2012
5040 2012-w04-5 --> Same as above
5043 Furthermore you can specify a relative date by giving, as the
5044 @emph{first} thing in the input: a plus/minus sign, a number and a
5045 letter ([dwmy]) to indicate change in days, weeks, months, or years. With a
5046 single plus or minus, the date is always relative to today. With a
5047 double plus or minus, it is relative to the default date. If instead of
5048 a single letter, you use the abbreviation of day name, the date will be
5049 the nth such day. @Eg
5054 +4d --> four days from today
5055 +4 --> same as above
5056 +2w --> two weeks from today
5057 ++5 --> five days from default date
5058 +2tue --> second Tuesday from now.
5061 @vindex parse-time-months
5062 @vindex parse-time-weekdays
5063 The function understands English month and weekday abbreviations. If
5064 you want to use unabbreviated names and/or other languages, configure
5065 the variables @code{parse-time-months} and @code{parse-time-weekdays}.
5067 @cindex calendar, for selecting date
5068 @vindex org-popup-calendar-for-date-prompt
5069 Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
5070 you don't need/want the calendar, configure the variable
5071 @code{org-popup-calendar-for-date-prompt}.}. When you exit the date
5072 prompt, either by clicking on a date in the calendar, or by pressing
5073 @key{RET}, the date selected in the calendar will be combined with the
5074 information entered at the prompt. You can control the calendar fully
5075 from the minibuffer:
5080 @kindex S-@key{right}
5081 @kindex S-@key{left}
5082 @kindex S-@key{down}
5084 @kindex M-S-@key{right}
5085 @kindex M-S-@key{left}
5088 > / < @r{Scroll calendar forward/backward by one month.}
5089 mouse-1 @r{Select date by clicking on it.}
5090 S-@key{right}/@key{left} @r{One day forward/backward.}
5091 S-@key{down}/@key{up} @r{One week forward/backward.}
5092 M-S-@key{right}/@key{left} @r{One month forward/backward.}
5093 @key{RET} @r{Choose date in calendar.}
5096 @vindex org-read-date-display-live
5097 The actions of the date/time prompt may seem complex, but I assure you they
5098 will grow on you, and you will start getting annoyed by pretty much any other
5099 way of entering a date/time out there. To help you understand what is going
5100 on, the current interpretation of your input will be displayed live in the
5101 minibuffer@footnote{If you find this distracting, turn the display of with
5102 @code{org-read-date-display-live}.}.
5104 @node Custom time format, , The date/time prompt, Creating timestamps
5105 @subsection Custom time format
5106 @cindex custom date/time format
5107 @cindex time format, custom
5108 @cindex date format, custom
5110 @vindex org-display-custom-times
5111 @vindex org-time-stamp-custom-formats
5112 Org mode uses the standard ISO notation for dates and times as it is
5113 defined in ISO 8601. If you cannot get used to this and require another
5114 representation of date and time to keep you happy, you can get it by
5115 customizing the variables @code{org-display-custom-times} and
5116 @code{org-time-stamp-custom-formats}.
5121 Toggle the display of custom formats for dates and times.
5125 Org mode needs the default format for scanning, so the custom date/time
5126 format does not @emph{replace} the default format---instead it is put
5127 @emph{over} the default format using text properties. This has the
5128 following consequences:
5131 You cannot place the cursor onto a timestamp anymore, only before or
5134 The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
5135 each component of a timestamp. If the cursor is at the beginning of
5136 the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
5137 just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the
5138 time will be changed by one minute.
5140 If the timestamp contains a range of clock times or a repeater, these
5141 will not be overlayed, but remain in the buffer as they were.
5143 When you delete a timestamp character-by-character, it will only
5144 disappear from the buffer after @emph{all} (invisible) characters
5145 belonging to the ISO timestamp have been removed.
5147 If the custom timestamp format is longer than the default and you are
5148 using dates in tables, table alignment will be messed up. If the custom
5149 format is shorter, things do work as expected.
5153 @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times
5154 @section Deadlines and scheduling
5156 A timestamp may be preceded by special keywords to facilitate planning:
5160 @cindex DEADLINE keyword
5162 Meaning: the task (most likely a TODO item, though not necessarily) is supposed
5163 to be finished on that date.
5165 @vindex org-deadline-warning-days
5166 On the deadline date, the task will be listed in the agenda. In
5167 addition, the agenda for @emph{today} will carry a warning about the
5168 approaching or missed deadline, starting
5169 @code{org-deadline-warning-days} before the due date, and continuing
5170 until the entry is marked DONE. An example:
5173 *** TODO write article about the Earth for the Guide
5174 The editor in charge is [[bbdb:Ford Prefect]]
5175 DEADLINE: <2004-02-29 Sun>
5178 You can specify a different lead time for warnings for a specific
5179 deadlines using the following syntax. Here is an example with a warning
5180 period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}.
5183 @cindex SCHEDULED keyword
5185 Meaning: you are planning to start working on that task on the given
5188 @vindex org-agenda-skip-scheduled-if-done
5189 The headline will be listed under the given date@footnote{It will still
5190 be listed on that date after it has been marked DONE. If you don't like
5191 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In
5192 addition, a reminder that the scheduled date has passed will be present
5193 in the compilation for @emph{today}, until the entry is marked DONE.
5194 @Ie the task will automatically be forwarded until completed.
5197 *** TODO Call Trillian for a date on New Years Eve.
5198 SCHEDULED: <2004-12-25 Sat>
5202 @b{Important:} Scheduling an item in Org mode should @i{not} be
5203 understood in the same way that we understand @i{scheduling a meeting}.
5204 Setting a date for a meeting is just a simple appointment, you should
5205 mark this entry with a simple plain timestamp, to get this item shown
5206 on the date where it applies. This is a frequent misunderstanding by
5207 Org users. In Org mode, @i{scheduling} means setting a date when you
5208 want to start working on an action item.
5211 You may use timestamps with repeaters in scheduling and deadline
5212 entries. Org mode will issue early and late warnings based on the
5213 assumption that the timestamp represents the @i{nearest instance} of
5214 the repeater. However, the use of diary sexp entries like
5216 @code{<%%(diary-float t 42)>}
5218 in scheduling and deadline timestamps is limited. Org mode does not
5219 know enough about the internals of each sexp function to issue early and
5220 late warnings. However, it will show the item on each day where the
5224 * Inserting deadline/schedule:: Planning items
5225 * Repeated tasks:: Items that show up again and again
5228 @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling
5229 @subsection Inserting deadlines or schedules
5231 The following commands allow you to quickly insert a deadline or to schedule
5238 Insert @samp{DEADLINE} keyword along with a stamp. The insertion will
5239 happen in the line directly following the headline. When called with a
5240 prefix arg, an existing deadline will be removed from the entry.
5241 @c FIXME Any CLOSED timestamp will be removed.????????
5245 Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will
5246 happen in the line directly following the headline. Any CLOSED
5247 timestamp will be removed. When called with a prefix argument, remove
5248 the scheduling date from the entry.
5254 Mark the current entry for agenda action. After you have marked the entry
5255 like this, you can open the agenda or the calendar to find an appropriate
5256 date. With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to
5257 schedule the marked item.
5260 @cindex sparse tree, for deadlines
5262 @vindex org-deadline-warning-days
5263 Create a sparse tree with all deadlines that are either past-due, or
5264 which will become due within @code{org-deadline-warning-days}.
5265 With @kbd{C-u} prefix, show all deadlines in the file. With a numeric
5266 prefix, check that many days. For example, @kbd{C-1 C-c / d} shows
5267 all deadlines due tomorrow.
5271 Sparse tree for deadlines and scheduled items before a given date.
5275 Sparse tree for deadlines and scheduled items after a given date.
5278 @node Repeated tasks, , Inserting deadline/schedule, Deadlines and scheduling
5279 @subsection Repeated tasks
5280 @cindex tasks, repeated
5281 @cindex repeated tasks
5283 Some tasks need to be repeated again and again. Org mode helps to
5284 organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
5285 or plain timestamp. In the following example
5287 ** TODO Pay the rent
5288 DEADLINE: <2005-10-01 Sat +1m>
5291 the @code{+1m} is a repeater; the intended interpretation is that the task
5292 has a deadline on <2005-10-01> and repeats itself every (one) month starting
5293 from that time. If you need both a repeater and a special warning period in
5294 a deadline entry, the repeater should come first and the warning period last:
5295 @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
5297 Deadlines and scheduled items produce entries in the agenda when they
5298 are over-due, so it is important to be able to mark such an entry as
5299 completed once you have done so. When you mark a DEADLINE or a SCHEDULE
5300 with the TODO keyword DONE, it will no longer produce entries in the
5301 agenda. The problem with this is, however, that then also the
5302 @emph{next} instance of the repeated entry will not be active. Org mode
5303 deals with this in the following way: When you try to mark such an entry
5304 DONE (using @kbd{C-c C-t}), it will shift the base date of the repeating
5305 timestamp by the repeater interval, and immediately set the entry state
5306 back to TODO. In the example above, setting the state to DONE would
5307 actually switch the date like this:
5310 ** TODO Pay the rent
5311 DEADLINE: <2005-11-01 Tue +1m>
5314 @vindex org-log-repeat
5315 A timestamp@footnote{You can change this using the option
5316 @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
5317 @code{lognoterepeat}, and @code{nologrepeat}. With @code{lognoterepeat}, you
5318 will also be prompted for a note.} will be added under the deadline, to keep
5319 a record that you actually acted on the previous instance of this deadline.
5321 As a consequence of shifting the base date, this entry will no longer be
5322 visible in the agenda when checking past dates, but all future instances
5325 With the @samp{+1m} cookie, the date shift will always be exactly one
5326 month. So if you have not paid the rent for three months, marking this
5327 entry DONE will still keep it as an overdue deadline. Depending on the
5328 task, this may not be the best way to handle it. For example, if you
5329 forgot to call you father for 3 weeks, it does not make sense to call
5330 him 3 times in a single day to make up for it. Finally, there are tasks
5331 like changing batteries which should always repeat a certain time
5332 @i{after} the last time you did it. For these tasks, Org mode has
5333 special repeaters markers with @samp{++} and @samp{.+}. For example:
5337 DEADLINE: <2008-02-10 Sun ++1w>
5338 Marking this DONE will shift the date by at least one week,
5339 but also by as many weeks as it takes to get this date into
5340 the future. However, it stays on a Sunday, even if you called
5341 and marked it done on Saturday.
5342 ** TODO Check the batteries in the smoke detectors
5343 DEADLINE: <2005-11-01 Tue .+1m>
5344 Marking this DONE will shift the date to one month after
5348 You may have both scheduling and deadline information for a specific
5349 task---just make sure that the repeater intervals on both are the same.
5351 An alternative to using a repeater is to create a number of copies of a task
5352 subtree, with dates shifted in each copy. The command @kbd{C-c C-x c} was
5353 created for this purpose, it is described in @ref{Structure editing}.
5356 @node Clocking work time, Effort estimates, Deadlines and scheduling, Dates and Times
5357 @section Clocking work time
5359 Org mode allows you to clock the time you spend on specific tasks in a
5360 project. When you start working on an item, you can start the clock.
5361 When you stop working on that task, or when you mark the task done, the
5362 clock is stopped and the corresponding time interval is recorded. It
5363 also computes the total time spent on each subtree of a project.
5365 Normally, the clock does not survive exiting and re-entering Emacs, but you
5366 can arrange for the clock information to persist across Emacs sessions with
5369 (setq org-clock-persist t)
5370 (org-clock-persistence-insinuate)
5376 @vindex org-clock-into-drawer
5377 Start the clock on the current item (clock-in). This inserts the CLOCK
5378 keyword together with a timestamp. If this is not the first clocking of
5379 this item, the multiple CLOCK lines will be wrapped into a
5380 @code{:LOGBOOK:} drawer (see also the variable
5381 @code{org-clock-into-drawer}). When called with a @kbd{C-u} prefix argument,
5382 select the task from a list of recently clocked tasks. With two @kbd{C-u
5383 C-u} prefixes, clock into the task at point and mark it as the default task.
5384 The default task will always be available when selecting a clocking task,
5385 with letter @kbd{d}.@*
5386 @cindex property: CLOCK_MODELINE_TOTAL
5387 @cindex property: LAST_REPEAT
5388 @vindex org-clock-modeline-total
5389 While the clock is running, the current clocking time is shown in the mode
5390 line, along with the title of the task. The clock time shown will be all
5391 time ever clocked for this task and its children. If the task has an effort
5392 estimate (@pxref{Effort estimates}), the mode line displays the current
5393 clocking time against it@footnote{To add an effort estimate ``on the fly'',
5394 hook a function doing this to @code{org-clock-in-prepare-hook}.} If the task
5395 is a repeating one (@pxref{Repeated tasks}), only the time since the last
5396 reset of the task @footnote{as recorded by the @code{LAST_REPEAT} property}
5397 will be shown. More control over what time is shown can be exercised with
5398 the @code{CLOCK_MODELINE_TOTAL} property. It may have the values
5399 @code{current} to show only the current clocking instance, @code{today} to
5400 show all time clocked on this tasks today (see also the variable
5401 @code{org-extend-today-until}), @code{all} to include all time, or
5402 @code{auto} which is the default@footnote{See also the variable
5403 @code{org-clock-modeline-total}.}.@* Clicking with @kbd{mouse-1} onto the
5404 mode line entry will pop up a menu with clocking options.
5407 @vindex org-log-note-clock-out
5408 Stop the clock (clock-out). This inserts another timestamp at the same
5409 location where the clock was last started. It also directly computes
5410 the resulting time in inserts it after the time range as @samp{=>
5411 HH:MM}. See the variable @code{org-log-note-clock-out} for the
5412 possibility to record an additional note together with the clock-out
5413 timestamp@footnote{The corresponding in-buffer setting is:
5414 @code{#+STARTUP: lognoteclock-out}}.
5417 Update the effort estimate for the current clock task.
5420 @item C-c C-y @ @ @r{or}@ @ C-c C-c
5421 Recompute the time interval after changing one of the timestamps. This
5422 is only necessary if you edit the timestamps directly. If you change
5423 them with @kbd{S-@key{cursor}} keys, the update is automatic.
5426 Changing the TODO state of an item to DONE automatically stops the clock
5427 if it is running in this same item.
5430 Cancel the current clock. This is useful if a clock was started by
5431 mistake, or if you ended up working on something else.
5434 Jump to the entry that contains the currently running clock. With a
5435 @kbd{C-u} prefix arg, select the target task from a list of recently clocked
5439 @vindex org-remove-highlights-with-change
5440 Display time summaries for each subtree in the current buffer. This
5441 puts overlays at the end of each headline, showing the total time
5442 recorded under that heading, including the time of any subheadings. You
5443 can use visibility cycling to study the tree, but the overlays disappear
5444 when you change the buffer (see variable
5445 @code{org-remove-highlights-with-change}) or press @kbd{C-c C-c}.
5448 Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
5449 report as an Org-mode table into the current file. When the cursor is
5450 at an existing clock table, just update it. When called with a prefix
5451 argument, jump to the first clock report in the current document and
5453 @cindex #+BEGIN, clocktable
5455 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
5459 If such a block already exists at point, its content is replaced by the
5460 new table. The @samp{BEGIN} line can specify options:
5462 :maxlevel @r{Maximum level depth to which times are listed in the table.}
5463 :emphasize @r{When @code{t}, emphasize level one and level two items.}
5464 :scope @r{The scope to consider. This can be any of the following:}
5465 nil @r{the current buffer or narrowed region}
5466 file @r{the full current buffer}
5467 subtree @r{the subtree where the clocktable is located}
5468 tree@var{N} @r{the surrounding level @var{N} tree, for example @code{tree3}}
5469 tree @r{the surrounding level 1 tree}
5470 agenda @r{all agenda files}
5471 ("file"..) @r{scan these files}
5472 file-with-archives @r{current file and its archives}
5473 agenda-with-archives @r{all agenda files, including archives}
5474 :block @r{The time block to consider. This block is specified either}
5475 @r{absolute, or relative to the current time and may be any of}
5477 2007-12-31 @r{New year eve 2007}
5478 2007-12 @r{December 2007}
5479 2007-W50 @r{ISO-week 50 in 2007}
5480 2007 @r{the year 2007}
5481 today, yesterday, today-@var{N} @r{a relative day}
5482 thisweek, lastweek, thisweek-@var{N} @r{a relative week}
5483 thismonth, lastmonth, thismonth-@var{N} @r{a relative month}
5484 thisyear, lastyear, thisyear-@var{N} @r{a relative year}
5485 @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
5486 :tstart @r{A time string specifying when to start considering times.}
5487 :tend @r{A time string specifying when to stop considering times.}
5488 :step @r{@code{week} or @code{day}, to split the table into chunks.}
5489 @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
5490 :link @r{Link the item headlines in the table to their origins.}
5491 :formula @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
5492 @r{As a special case, @samp{:formula %} adds a column with % time.}
5493 @r{If you do not specify a formula here, any existing formula.}
5494 @r{below the clock table will survive updates and be evaluated.}
5495 :timestamp @r{A timestamp for the entry, when available. Look for SCHEDULED,}
5496 @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.}
5498 To get a clock summary of the current level 1 tree, for the current
5499 day, you could write
5501 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
5505 and to use a specific time range you could write@footnote{Note that all
5506 parameters must be specified in a single line---the line is broken here
5507 only to fit it into the manual.}
5509 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
5510 :tend "<2006-08-10 Thu 12:00>"
5513 A summary of the current subtree with % times would be
5515 #+BEGIN: clocktable :scope subtree :link t :formula %
5522 Update dynamic block at point. The cursor needs to be in the
5523 @code{#+BEGIN} line of the dynamic block.
5524 @kindex C-u C-c C-x C-u
5525 @item C-u C-c C-x C-u
5526 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
5527 you have several clock table blocks in a buffer.
5528 @kindex S-@key{left}
5529 @kindex S-@key{right}
5531 @itemx S-@key{right}
5532 Shift the current @code{:block} interval and update the table. The cursor
5533 needs to be in the @code{#+BEGIN: clocktable} line for this command. If
5534 @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
5537 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
5538 the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
5539 worked on or closed during a day.
5541 @node Effort estimates, Relative timer, Clocking work time, Dates and Times
5542 @section Effort estimates
5543 @cindex effort estimates
5545 @cindex property, Effort
5546 @vindex org-effort-property
5547 If you want to plan your work in a very detailed way, or if you need to
5548 produce offers with quotations of the estimated work effort, you may want to
5549 assign effort estimates to entries. If you are also clocking your work, you
5550 may later want to compare the planned effort with the actual working time, a
5551 great way to improve planning estimates. Effort estimates are stored in a
5552 special property @samp{Effort}@footnote{You may change the property being
5553 used with the variable @code{org-effort-property}.}. You can set the effort
5554 for an entry with the following commands:
5559 Set the effort estimate for the current entry. With a numeric prefix
5560 argument, set it to the NTH allowed value (see below). This command is also
5561 accessible from the agenda with the @kbd{e} key.
5564 Modify the effort estimate of the item currently being clocked.
5567 Clearly the best way to work with effort estimates is through column view
5568 (@pxref{Column view}). You should start by setting up discrete values for
5569 effort estimates, and a @code{COLUMNS} format that displays these values
5570 together with clock sums (if you want to clock your time). For a specific
5574 #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00
5575 #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
5579 @vindex org-global-properties
5580 @vindex org-columns-default-format
5581 or, even better, you can set up these values globally by customizing the
5582 variables @code{org-global-properties} and @code{org-columns-default-format}.
5583 In particular if you want to use this setup also in the agenda, a global
5584 setup may be advised.
5586 The way to assign estimates to individual items is then to switch to column
5587 mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
5588 value. The values you enter will immediately be summed up in the hierarchy.
5589 In the column next to it, any clocked time will be displayed.
5591 @vindex org-agenda-columns-add-appointments-to-effort-sum
5592 If you switch to column view in the daily/weekly agenda, the effort column
5593 will summarize the estimated work effort for each day@footnote{Please note
5594 the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
5595 column view}).}, and you can use this to find space in your schedule. To get
5596 an overview of the entire part of the day that is committed, you can set the
5597 option @code{org-agenda-columns-add-appointments-to-effort-sum}. The
5598 appointments on a day that take place over a specified time interval will
5599 then also be added to the load estimate of the day.
5601 Effort estimates can be used in secondary agenda filtering that is triggered
5602 with the @kbd{/} key in the agenda (@pxref{Agenda commands}). If you have
5603 these estimates defined consistently, two or three key presses will narrow
5604 down the list to stuff that fits into an available time slot.
5606 @node Relative timer, , Effort estimates, Dates and Times
5607 @section Taking notes with a relative timer
5608 @cindex relative timer
5610 When taking notes during, for example, a meeting or a video viewing, it can
5611 be useful to have access to times relative to a starting time. Org provides
5612 such a relative timer and make it easy to create timed notes.
5617 Insert a relative time into the buffer. The first time you use this, the
5618 timer will be started. When called with a prefix argument, the timer is
5622 Insert a description list item with the current relative time. With a prefix
5623 argument, first reset the timer to 0.
5626 Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
5630 Pause the timer, or continue it if it is already paused.
5631 @c removed the sentence because it is redundant to the following item
5632 @kindex C-u C-c C-x ,
5634 Stop the timer. After this, you can only start a new timer, not continue the
5635 old one. This command also removes the timer from the mode line.
5638 Reset the timer without inserting anything into the buffer. By default, the
5639 timer is reset to 0. When called with a @kbd{C-u} prefix, reset the timer to
5640 specific starting offset. The user is prompted for the offset, with a
5641 default taken from a timer string at point, if any, So this can be used to
5642 restart taking notes after a break in the process. When called with a double
5643 prefix argument @kbd{C-c C-u}, change all timer strings in the active region
5644 by a certain amount. This can be used to fix timer strings if the timer was
5645 not started at exactly the right moment.
5648 @node Capture, Agenda Views, Dates and Times, Top
5652 An important part of any organization system is the ability to quickly
5653 capture new ideas and tasks, and to associate reference material with them.
5654 Org uses the @file{remember.el} package to create tasks, and stores files
5655 related to a task (@i{attachments}) in a special directory.
5658 * Remember:: Capture new tasks/ideas with little interruption
5659 * Attachments:: Add files to tasks.
5660 * RSS Feeds:: Getting input from RSS feeds
5661 * Protocols:: External (@eg Browser) access to Emacs and Org
5664 @node Remember, Attachments, Capture, Capture
5666 @cindex @file{remember.el}
5668 The Remember package by John Wiegley lets you store quick notes with little
5669 interruption of your work flow. It is an excellent way to add new notes and
5670 tasks to Org files. The @code{remember.el} package is part of Emacs 23, not
5671 Emacs 22. See @uref{http://www.emacswiki.org/cgi-bin/wiki/RememberMode} for
5674 Org significantly expands the possibilities of Remember: you may define
5675 templates for different note types, and associate target files and headlines
5676 with specific templates. It also allows you to select the location where a
5677 note should be stored interactively, on the fly.
5680 * Setting up Remember for Org:: Some code for .emacs to get things going
5681 * Remember templates:: Define the outline of different note types
5682 * Storing notes:: Directly get the note to where it belongs
5683 * Refiling notes:: Moving a note or task to a project
5686 @node Setting up Remember for Org, Remember templates, Remember, Remember
5687 @subsection Setting up Remember for Org
5689 The following customization will tell Remember to use Org files as
5690 target, and to create annotations compatible with Org links.
5693 (org-remember-insinuate)
5694 (setq org-directory "~/path/to/my/orgfiles/")
5695 (setq org-default-notes-file (concat org-directory "/notes.org"))
5696 (define-key global-map "\C-cr" 'org-remember)
5700 The last line binds the command @code{org-remember} to a global
5701 key@footnote{Please select your own key, @kbd{C-c r} is only a
5702 suggestion.}. @code{org-remember} basically just calls Remember,
5703 but it makes a few things easier: if there is an active region, it will
5704 automatically copy the region into the Remember buffer. It also allows
5705 to jump to the buffer and location where Remember notes are being
5706 stored: just call @code{org-remember} with a prefix argument. If you
5707 use two prefix arguments, Org jumps to the location where the last
5708 remember note was stored.
5710 The Remember buffer will actually use @code{org-mode} as its major mode, so
5711 that all editing features of Org mode are available. In addition to this, a
5712 minor mode @code{org-remember-mode} is turned on, for the single purpose that
5713 you can use its keymap @code{org-remember-mode-map} to overwrite some of
5714 Org mode's key bindings.
5716 You can also call @code{org-remember} in a special way from the agenda,
5717 using the @kbd{k r} key combination. With this access, any timestamps
5718 inserted by the selected Remember template (see below) will default to
5719 the cursor date in the agenda, rather than to the current date.
5721 @node Remember templates, Storing notes, Setting up Remember for Org, Remember
5722 @subsection Remember templates
5723 @cindex templates, for Remember
5725 In combination with Org, you can use templates to generate
5726 different types of Remember notes. For example, if you would like
5727 to use one template to create general TODO entries, another one for
5728 journal entries, and a third one for collecting random ideas, you could
5732 (setq org-remember-templates
5733 '(("Todo" ?t "* TODO %?\n %i\n %a" "~/org/TODO.org" "Tasks")
5734 ("Journal" ?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org")
5735 ("Idea" ?i "* %^@{Title@}\n %i\n %a" "~/org/JOURNAL.org" "New Ideas")))
5738 @vindex org-remember-default-headline
5739 @vindex org-directory
5740 @noindent In these entries, the first string is just a name, and the
5741 character specifies how to select the template. It is useful if the
5742 character is also the first letter of the name. The next string specifies
5743 the template. Two more (optional) strings give the file in which, and the
5744 headline under which, the new note should be stored. The file (if not present
5745 or @code{nil}) defaults to @code{org-default-notes-file}, the heading to
5746 @code{org-remember-default-headline}. If the file name is not an absolute
5747 path, it will be interpreted relative to @code{org-directory}. The heading
5748 can also be the symbols @code{top} or @code{bottom} to send notes as level 1
5749 entries to the beginning or end of the file, respectively.
5751 An optional sixth element specifies the contexts in which the user can select
5752 the template. This element can be a list of major modes or a function.
5753 @code{org-remember} will first check whether the function returns @code{t} or
5754 if we are in any of the listed major modes, and exclude templates for which
5755 this condition is not fulfilled. Templates that do not specify this element
5756 at all, or that use @code{nil} or @code{t} as a value will always be
5762 (setq org-remember-templates
5763 '(("Bug" ?b "* BUG %?\n %i\n %a" "~/org/BUGS.org" "Bugs" (emacs-lisp-mode))
5764 ("Journal" ?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org" "X" my-check)
5765 ("Idea" ?i "* %^@{Title@}\n %i\n %a" "~/org/JOURNAL.org" "New Ideas")))
5769 The first template will only be available when invoking @code{org-remember}
5770 from an buffer in @code{emacs-lisp-mode}. The second template will only be
5771 available when the function @code{my-check} returns @code{t}. The third
5772 template will be proposed in any context.
5774 When you call @kbd{M-x org-remember} (or @kbd{M-x remember}) to remember
5775 something, Org will prompt for a key to select the template (if you have
5776 more than one template) and then prepare the buffer like
5779 [[file:@var{link to where you called remember}]]
5783 During expansion of the template, special @kbd{%}-escapes@footnote{If you
5784 need one of these sequences literally, escape the @kbd{%} with a backslash.}
5785 allow dynamic insertion of content:
5787 %^@{@var{prompt}@} @r{prompt the user for a string and replace this sequence with it.}
5788 @r{You may specify a default value and a completion table with}
5789 @r{%^@{prompt|default|completion2|completion3...@}}
5790 @r{The arrow keys access a prompt-specific history.}
5791 %a @r{annotation, normally the link created with @code{org-store-link}}
5792 %A @r{like @code{%a}, but prompt for the description part}
5793 %i @r{initial content, the region when remember is called with C-u.}
5794 @r{The entire text will be indented like @code{%i} itself.}
5795 %t @r{timestamp, date only}
5796 %T @r{timestamp with date and time}
5797 %u, %U @r{like the above, but inactive timestamps}
5798 %^t @r{like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}}
5799 @r{You may define a prompt like @code{%^@{Birthday@}t}}
5800 %n @r{user name (taken from @code{user-full-name})}
5801 %c @r{Current kill ring head.}
5802 %x @r{Content of the X clipboard.}
5803 %^C @r{Interactive selection of which kill or clip to use.}
5804 %^L @r{Like @code{%^C}, but insert as link.}
5805 %^g @r{prompt for tags, with completion on tags in target file.}
5806 %k @r{title of currently clocked task}
5807 %K @r{link to currently clocked task}
5808 %^G @r{prompt for tags, with completion all tags in all agenda files.}
5809 %^@{@var{prop}@}p @r{Prompt the user for a value for property @var{prop}}
5810 %:keyword @r{specific information for certain link types, see below}
5811 %[@var{file}] @r{insert the contents of the file given by @var{file}}
5812 %(@var{sexp}) @r{evaluate Elisp @var{sexp} and replace with the result}
5813 %! @r{immediately store note after completing the template}
5814 @r{(skipping the @kbd{C-c C-c} that normally triggers storing)}
5815 %& @r{jump to target location immediately after storing note}
5819 For specific link types, the following keywords will be
5820 defined@footnote{If you define your own link types (@pxref{Adding
5821 hyperlink types}), any property you store with
5822 @code{org-store-link-props} can be accessed in remember templates in a
5825 @vindex org-from-is-user-regexp
5827 Link type | Available keywords
5828 -------------------+----------------------------------------------
5829 bbdb | %:name %:company
5830 bbdb | %::server %:port %:nick
5831 vm, wl, mh, rmail | %:type %:subject %:message-id
5832 | %:from %:fromname %:fromaddress
5833 | %:to %:toname %:toaddress
5834 | %: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}.}}
5835 gnus | %:group, @r{for messages also all email fields}
5837 info | %:file %:node
5842 To place the cursor after template expansion use:
5845 %? @r{After completing the template, position cursor here.}
5849 If you change your mind about which template to use, call
5850 @code{org-remember} in the remember buffer. You may then select a new
5851 template that will be filled with the previous context information.
5853 @node Storing notes, Refiling notes, Remember templates, Remember
5854 @subsection Storing notes
5856 @vindex org-remember-clock-out-on-exit
5857 When you are finished preparing a note with Remember, you have to press
5858 @kbd{C-c C-c} to file the note away. If you have started the clock in the
5859 Remember buffer, you will first be asked if you want to clock out
5860 now@footnote{To avoid this query, configure the variable
5861 @code{org-remember-clock-out-on-exit}.}. If you answer @kbd{n}, the clock
5862 will continue to run after the note was filed away.
5864 The handler will then store the note in the file and under the headline
5865 specified in the template, or it will use the default file and headline.
5866 The window configuration will be restored, sending you back to the working
5867 context before the call to Remember. To re-use the location found
5868 during the last call to Remember, exit the Remember buffer with
5869 @kbd{C-0 C-c C-c}, @ie specify a zero prefix argument to @kbd{C-c C-c}.
5870 Another special case is @kbd{C-2 C-c C-c} which files the note as a child of
5871 the currently clocked item.
5873 @vindex org-remember-store-without-prompt
5874 If you want to store the note directly to a different place, use
5875 @kbd{C-1 C-c C-c} instead to exit Remember@footnote{Configure the
5876 variable @code{org-remember-store-without-prompt} to make this behavior
5877 the default.}. The handler will then first prompt for a target file---if
5878 you press @key{RET}, the value specified for the template is used.
5879 Then the command offers the headings tree of the selected file, with the
5880 cursor position at the default headline (if you specified one in the
5881 template). You can either immediately press @key{RET} to get the note
5882 placed there. Or you can use the following keys to find a different
5885 @key{TAB} @r{Cycle visibility.}
5886 @key{down} / @key{up} @r{Next/previous visible headline.}
5887 n / p @r{Next/previous visible headline.}
5888 f / b @r{Next/previous headline same level.}
5890 @c 0-9 @r{Digit argument.}
5893 Pressing @key{RET} or @key{left} or @key{right}
5894 then leads to the following result.
5896 @vindex org-reverse-note-order
5897 @multitable @columnfractions 0.2 0.15 0.65
5898 @item @b{Cursor position} @tab @b{Key} @tab @b{Note gets inserted}
5899 @item on headline @tab @key{RET} @tab as sublevel of the heading at cursor, first or last
5900 @item @tab @tab depending on @code{org-reverse-note-order}.
5901 @item @tab @key{left}/@key{right} @tab as same level, before/after current heading
5902 @item buffer-start @tab @key{RET} @tab as level 2 heading at end of file or level 1 at beginning
5903 @item @tab @tab depending on @code{org-reverse-note-order}.
5904 @item not on headline @tab @key{RET}
5905 @tab at cursor position, level taken from context.
5908 Before inserting the text into a tree, the function ensures that the text has
5909 a headline, @ie a first line that starts with a @samp{*}. If not, a
5910 headline is constructed from the current date. If you have indented the text
5911 of the note below the headline, the indentation will be adapted if inserting
5912 the note into the tree requires demotion from level 1.
5914 @node Refiling notes, , Storing notes, Remember
5915 @subsection Refiling notes
5916 @cindex refiling notes
5918 Remember is usually used to quickly capture notes and tasks into one or
5919 a few capture lists. When reviewing the captured data, you may want to
5920 refile some of the entries into a different list, for example into a
5921 project. Cutting, finding the right location, and then pasting the note
5922 is cumbersome. To simplify this process, you can use the following
5928 @vindex org-reverse-note-order
5929 @vindex org-refile-targets
5930 @vindex org-refile-use-outline-path
5931 @vindex org-outline-path-complete-in-steps
5932 @vindex org-refile-allow-creating-parent-nodes
5933 Refile the entry or region at point. This command offers possible locations
5934 for refiling the entry and lets you select one with completion. The item (or
5935 all items in the region) is filed below the target heading as a subitem.
5936 Depending on @code{org-reverse-note-order}, it will be either the first or
5938 By default, all level 1 headlines in the current buffer are considered to be
5939 targets, but you can have more complex definitions across a number of files.
5940 See the variable @code{org-refile-targets} for details. If you would like to
5941 select a location via a file-path-like completion along the outline path, see
5942 the variables @code{org-refile-use-outline-path} and
5943 @code{org-outline-path-complete-in-steps}. If you would like to be able to
5944 create new nodes as new parents for for refiling on the fly, check the
5945 variable @code{org-refile-allow-creating-parent-nodes}.
5948 Use the refile interface to jump to a heading.
5949 @kindex C-u C-u C-c C-w
5950 @item C-u C-u C-c C-w
5951 Jump to the location where @code{org-refile} last moved a tree to.
5955 @node Attachments, RSS Feeds, Remember, Capture
5956 @section Attachments
5959 @vindex org-attach-directory
5960 It is often useful to associate reference material with an outline node/task.
5961 Small chunks of plain text can simply be stored in the subtree of a project.
5962 Hyperlinks (@pxref{Hyperlinks}) can be used to establish associations with
5963 files that live elsewhere on your computer or in the cloud, like emails or
5964 source code files belonging to a project. Another method is @i{attachments},
5965 which are files located in a directory belonging to an outline node. Org
5966 uses directories named by the unique ID of each entry. These directories are
5967 located in the @file{data} directory which lives in the same directory where
5968 your Org file lives@footnote{If you move entries or Org files from one
5969 directory to another, you may want to configure @code{org-attach-directory}
5970 to contain an absolute path.}. If you initialize this directory with
5971 @code{git init}, Org will automatically commit changes when it sees them.
5972 The attachment system has been contributed to Org by John Wiegley.
5974 In cases where it seems better to do so, you can also attach a directory of your
5975 choice to an entry. You can also make children inherit the attachment
5976 directory from a parent, so that an entire subtree uses the same attached
5979 @noindent The following commands deal with attachments.
5985 The dispatcher for commands related to the attachment system. After these
5986 keys, a list of commands is displayed and you need to press an additional key
5987 to select a command:
5992 @vindex org-attach-method
5993 Select a file and move it into the task's attachment directory. The file
5994 will be copied, moved, or linked, depending on @code{org-attach-method}.
5995 Note that hard links are not supported on all systems.
6001 Attach a file using the copy/move/link method.
6002 Note that hard links are not supported on all systems.
6006 Create a new attachment as an Emacs buffer.
6010 Synchronize the current task with its attachment directory, in case you added
6011 attachments yourself.
6015 @vindex org-file-apps
6016 Open current task's attachment. If there are more than one, prompt for a
6017 file name first. Opening will follow the rules set by @code{org-file-apps}.
6018 For more details, see the information on following hyperlinks
6019 (@pxref{Handling links}).
6023 Also open the attachment, but force opening the file in Emacs.
6027 Open the current task's attachment directory.
6031 Also open the directory, but force using @command{dired} in Emacs.
6035 Select and delete a single attachment.
6039 Delete all of a task's attachments. A safer way is to open the directory in
6040 @command{dired} and delete from there.
6044 @cindex property, ATTACH_DIR
6045 Set a specific directory as the entry's attachment directory. This works by
6046 putting the directory path into the @code{ATTACH_DIR} property.
6050 @cindex property, ATTACH_DIR_INHERIT
6051 Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
6052 same directory for attachments as the parent does.
6056 @node RSS Feeds, Protocols, Attachments, Capture
6060 Org has the capability to add and change entries based on information found in
6061 RSS feeds. You could use this to make a task out of each new podcast in a
6062 podcast feed. Or you could use a phone-based note-creating service on the
6063 web to import tasks into Org. To access feeds, you need to configure the
6064 variable @code{org-feed-alist}. The docstring of this variable has detailed
6065 information. Here is just an example:
6068 (setq org-feed-alist
6069 '(("ReQall" "http://www.reqall.com/user/feeds/rss/a1b2c3....."
6070 "~/org/feeds.org" "ReQall Entries")
6073 will configure that new items from the feed provided by @file{reqall.com}
6074 will result in new entries in the file @file{~/org/feeds.org} under the
6075 heading @samp{ReQall Entries}, whenever the following command is used:
6080 Collect items from the feeds configured in @code{org-feed-alist} and act upon
6084 Prompt for a feed name and go to the inbox configured for this feed.
6087 Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which
6088 it will store information about the status of items in the feed, to avoid
6089 adding the same item several times. You should add @samp{FEEDSTATUS} to the
6090 list of drawers in that file:
6093 #+DRAWERS: LOGBOOK PROPERTIES FEEDSTATUS
6096 For more information, see @file{org-feed.el} and the docstring of
6097 @code{org-feed-alist}.
6099 @node Protocols, , RSS Feeds, Capture
6100 @section Protocols for external access
6101 @cindex protocols, for external access
6104 You can set up Org for handling protocol calls from outside applications that
6105 are passed to Emacs through the @file{emacsserver}. For example, you can
6106 configure bookmarks in your web browser to send a link to the current page to
6107 Org and create a note from it using Remember (@pxref{Remember}). Or you
6108 could create a bookmark that will tell Emacs to open the local source file of
6109 a remote website you are looking at with the browser. See
6110 @uref{http://orgmode.org/worg/org-contrib/org-protocol.php} for detailed
6111 documentation and setup instructions.
6114 @node Agenda Views, Embedded LaTeX, Capture, Top
6115 @chapter Agenda Views
6116 @cindex agenda views
6118 Due to the way Org works, TODO items, time-stamped items, and
6119 tagged headlines can be scattered throughout a file or even a number of
6120 files. To get an overview of open action items, or of events that are
6121 important for a particular date, this information must be collected,
6122 sorted and displayed in an organized way.
6124 Org can select items based on various criteria and display them
6125 in a separate buffer. Seven different view types are provided:
6129 an @emph{agenda} that is like a calendar and shows information
6132 a @emph{TODO list} that covers all unfinished
6135 a @emph{match view}, showings headlines based on the tags, properties, and
6136 TODO state associated with them,
6138 a @emph{timeline view} that shows all events in a single Org file,
6139 in time-sorted view,
6141 a @emph{keyword search view} that shows all entries from multiple files
6142 that contain specified keywords,
6144 a @emph{stuck projects view} showing projects that currently don't move
6147 @emph{custom views} that are special tag/keyword searches and
6148 combinations of different views.
6152 The extracted information is displayed in a special @emph{agenda
6153 buffer}. This buffer is read-only, but provides commands to visit the
6154 corresponding locations in the original Org files, and even to
6155 edit these files remotely.
6157 @vindex org-agenda-window-setup
6158 @vindex org-agenda-restore-windows-after-quit
6159 Two variables control how the agenda buffer is displayed and whether the
6160 window configuration is restored when the agenda exits:
6161 @code{org-agenda-window-setup} and
6162 @code{org-agenda-restore-windows-after-quit}.
6165 * Agenda files:: Files being searched for agenda information
6166 * Agenda dispatcher:: Keyboard access to agenda views
6167 * Built-in agenda views:: What is available out of the box?
6168 * Presentation and sorting:: How agenda items are prepared for display
6169 * Agenda commands:: Remote editing of Org trees
6170 * Custom agenda views:: Defining special searches and views
6171 * Exporting Agenda Views:: Writing a view to a file
6172 * Agenda column view:: Using column view for collected entries
6175 @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views
6176 @section Agenda files
6177 @cindex agenda files
6178 @cindex files for agenda
6180 @vindex org-agenda-files
6181 The information to be shown is normally collected from all @emph{agenda
6182 files}, the files listed in the variable
6183 @code{org-agenda-files}@footnote{If the value of that variable is not a
6184 list, but a single file name, then the list of agenda files will be
6185 maintained in that external file.}. If a directory is part of this list,
6186 all files with the extension @file{.org} in this directory will be part
6189 Thus, even if you only work with a single Org file, that file should
6190 be put into the list@footnote{When using the dispatcher, pressing
6191 @kbd{<} before selecting a command will actually limit the command to
6192 the current file, and ignore @code{org-agenda-files} until the next
6193 dispatcher command.}. You can customize @code{org-agenda-files}, but
6194 the easiest way to maintain it is through the following commands
6196 @cindex files, adding to agenda list
6200 Add current file to the list of agenda files. The file is added to
6201 the front of the list. If it was already in the list, it is moved to
6202 the front. With a prefix argument, file is added/moved to the end.
6205 Remove current file from the list of agenda files.
6210 Cycle through agenda file list, visiting one file after the other.
6211 @kindex M-x org-iswitchb
6212 @item M-x org-iswitchb
6213 Command to use an @code{iswitchb}-like interface to switch to and between Org
6218 The Org menu contains the current list of files and can be used
6219 to visit any of them.
6221 If you would like to focus the agenda temporarily on a file not in
6222 this list, or on just one file in the list, or even on only a subtree in a
6223 file, then this can be done in different ways. For a single agenda command,
6224 you may press @kbd{<} once or several times in the dispatcher
6225 (@pxref{Agenda dispatcher}). To restrict the agenda scope for an
6226 extended period, use the following commands:
6231 Permanently restrict the agenda to the current subtree. When with a
6232 prefix argument, or with the cursor before the first headline in a file,
6233 the agenda scope is set to the entire file. This restriction remains in
6234 effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
6235 or @kbd{>} in the agenda dispatcher. If there is a window displaying an
6236 agenda view, the new restriction takes effect immediately.
6239 Remove the permanent restriction created by @kbd{C-c C-x <}.
6243 When working with @file{speedbar.el}, you can use the following commands in
6247 @item < @r{in the speedbar frame}
6248 Permanently restrict the agenda to the item---either an Org file or a subtree
6249 in such a file---at the cursor in the Speedbar frame.
6250 If there is a window displaying an agenda view, the new restriction takes
6253 @item > @r{in the speedbar frame}
6254 Lift the restriction.
6257 @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views
6258 @section The agenda dispatcher
6259 @cindex agenda dispatcher
6260 @cindex dispatching agenda commands
6261 The views are created through a dispatcher, which should be bound to a
6262 global key---for example @kbd{C-c a} (@pxref{Installation}). In the
6263 following we will assume that @kbd{C-c a} is indeed how the dispatcher
6264 is accessed and list keyboard access to commands accordingly. After
6265 pressing @kbd{C-c a}, an additional letter is required to execute a
6266 command. The dispatcher offers the following default commands:
6269 Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
6271 Create a list of all TODO items (@pxref{Global TODO list}).
6273 Create a list of headlines matching a TAGS expression (@pxref{Matching
6274 tags and properties}).
6276 Create the timeline view for the current buffer (@pxref{Timeline}).
6278 Create a list of entries selected by a boolean expression of keywords
6279 and/or regular expressions that must or must not occur in the entry.
6281 @vindex org-agenda-text-search-extra-files
6282 Search for a regular expression in all agenda files and additionally in
6283 the files listed in @code{org-agenda-text-search-extra-files}. This
6284 uses the Emacs command @code{multi-occur}. A prefix argument can be
6285 used to specify the number of context lines for each match, default is
6288 Create a list of stuck projects (@pxref{Stuck projects}).
6290 Restrict an agenda command to the current buffer@footnote{For backward
6291 compatibility, you can also press @kbd{1} to restrict to the current
6292 buffer.}. After pressing @kbd{<}, you still need to press the character
6293 selecting the command.
6295 If there is an active region, restrict the following agenda command to
6296 the region. Otherwise, restrict it to the current subtree@footnote{For
6297 backward compatibility, you can also press @kbd{0} to restrict to the
6298 current region/subtree.}. After pressing @kbd{< <}, you still need to press the
6299 character selecting the command.
6302 You can also define custom commands that will be accessible through the
6303 dispatcher, just like the default commands. This includes the
6304 possibility to create extended agenda buffers that contain several
6305 blocks together, for example the weekly agenda, the global TODO list and
6306 a number of special tags matches. @xref{Custom agenda views}.
6308 @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda Views
6309 @section The built-in agenda views
6311 In this section we describe the built-in views.
6314 * Weekly/daily agenda:: The calendar page with current tasks
6315 * Global TODO list:: All unfinished action items
6316 * Matching tags and properties:: Structured information with fine-tuned search
6317 * Timeline:: Time-sorted view for single file
6318 * Keyword search:: Finding entries by keyword
6319 * Stuck projects:: Find projects you need to review
6322 @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views
6323 @subsection The weekly/daily agenda
6325 @cindex weekly agenda
6326 @cindex daily agenda
6328 The purpose of the weekly/daily @emph{agenda} is to act like a page of a
6329 paper agenda, showing all the tasks for the current week or day.
6332 @cindex org-agenda, command
6335 @vindex org-agenda-ndays
6336 Compile an agenda for the current week from a list of Org files. The agenda
6337 shows the entries for each day. With a numeric prefix@footnote{For backward
6338 compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
6339 listed before the agenda. This feature is deprecated, use the dedicated TODO
6340 list, or a block agenda instead (@pxref{Block agenda}).} (like @kbd{C-u 2 1
6341 C-c a a}) you may set the number of days to be displayed (see also the
6342 variable @code{org-agenda-ndays})
6345 Remote editing from the agenda buffer means, for example, that you can
6346 change the dates of deadlines and appointments from the agenda buffer.
6347 The commands available in the Agenda buffer are listed in @ref{Agenda
6350 @subsubheading Calendar/Diary integration
6351 @cindex calendar integration
6352 @cindex diary integration
6354 Emacs contains the calendar and diary by Edward M. Reingold. The
6355 calendar displays a three-month calendar with holidays from different
6356 countries and cultures. The diary allows you to keep track of
6357 anniversaries, lunar phases, sunrise/set, recurrent appointments
6358 (weekly, monthly) and more. In this way, it is quite complementary to
6359 Org. It can be very useful to combine output from Org with
6362 In order to include entries from the Emacs diary into Org mode's
6363 agenda, you only need to customize the variable
6366 (setq org-agenda-include-diary t)
6369 @noindent After that, everything will happen automatically. All diary
6370 entries including holidays, anniversaries, etc., will be included in the
6371 agenda buffer created by Org mode. @key{SPC}, @key{TAB}, and
6372 @key{RET} can be used from the agenda buffer to jump to the diary
6373 file in order to edit existing diary entries. The @kbd{i} command to
6374 insert new entries for the current date works in the agenda buffer, as
6375 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
6376 Sunrise/Sunset times, show lunar phases and to convert to other
6377 calendars, respectively. @kbd{c} can be used to switch back and forth
6378 between calendar and agenda.
6380 If you are using the diary only for sexp entries and holidays, it is
6381 faster to not use the above setting, but instead to copy or even move
6382 the entries into an Org file. Org mode evaluates diary-style sexp
6383 entries, and does it faster because there is no overhead for first
6384 creating the diary display. Note that the sexp entries must start at
6385 the left margin, no whitespace is allowed before them. For example,
6386 the following segment of an Org file will be processed and entries
6387 will be made in the agenda:
6390 * Birthdays and similar stuff
6392 %%(org-calendar-holiday) ; special function for holiday names
6394 %%(diary-anniversary 14 5 1956) Arthur Dent is %d years old
6395 %%(diary-anniversary 2 10 1869) Mahatma Gandhi would be %d years old
6398 @subsubheading Anniversaries from BBDB
6399 @cindex BBDB, anniversaries
6400 @cindex anniversaries, from BBDB
6402 If you are using the Big Brothers Database to store your contacts, you will
6403 very likely prefer to store anniversaries in BBDB rather than in a
6404 separate Org or diary file. Org supports this and will show BBDB
6405 anniversaries as part of the agenda. All you need to do is to add the
6406 following to one your your agenda files:
6413 %%(org-bbdb-anniversaries)
6416 You can then go ahead and define anniversaries for a BBDB record. Basically,
6417 you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB
6418 record and then add the date in the format @code{YYYY-MM-DD}, followed by a
6419 space and the class of the anniversary (@samp{birthday} or @samp{wedding}, or
6420 a format string). If you omit the class, it will default to @samp{birthday}.
6421 Here are a few examples, the header for the file @file{org-bbdb.el} contains
6422 more detailed information.
6427 2008-04-14 %s released version 6.01 of org-mode, %d years ago
6430 After a change to BBDB, or for the first agenda display during an Emacs
6431 session, the agenda display will suffer a short delay as Org updates its
6432 hash with anniversaries. However, from then on things will be very fast---much
6433 faster in fact than a long list of @samp{%%(diary-anniversary)} entries
6434 in an Org or Diary file.
6436 @subsubheading Appointment reminders
6437 @cindex @file{appt.el}
6438 @cindex appointment reminders
6440 Org can interact with Emacs appointments notification facility. To add all
6441 the appointments of your agenda files, use the command
6442 @code{org-agenda-to-appt}. This command also lets you filter through the
6443 list of your appointments and add only those belonging to a specific category
6444 or matching a regular expression. See the docstring for details.
6446 @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views
6447 @subsection The global TODO list
6448 @cindex global TODO list
6449 @cindex TODO list, global
6451 The global TODO list contains all unfinished TODO items formatted and
6452 collected into a single place.
6457 Show the global TODO list. This collects the TODO items from all
6458 agenda files (@pxref{Agenda Views}) into a single buffer. The buffer is in
6459 @code{agenda-mode}, so there are commands to examine and manipulate
6460 the TODO entries directly from that buffer (@pxref{Agenda commands}).
6463 @cindex TODO keyword matching
6464 @vindex org-todo-keywords
6465 Like the above, but allows selection of a specific TODO keyword. You
6466 can also do this by specifying a prefix argument to @kbd{C-c a t}. With
6467 a @kbd{C-u} prefix you are prompted for a keyword, and you may also
6468 specify several keywords by separating them with @samp{|} as the boolean OR
6469 operator. With a numeric prefix, the nth keyword in
6470 @code{org-todo-keywords} is selected.
6472 The @kbd{r} key in the agenda buffer regenerates it, and you can give
6473 a prefix argument to this command to change the selected TODO keyword,
6474 for example @kbd{3 r}. If you often need a search for a specific
6475 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
6476 Matching specific TODO keywords can also be done as part of a tags
6477 search (@pxref{Tag searches}).
6480 Remote editing of TODO items means that you can change the state of a
6481 TODO entry with a single key press. The commands available in the
6482 TODO list are described in @ref{Agenda commands}.
6484 @cindex sublevels, inclusion into TODO list
6485 Normally the global TODO list simply shows all headlines with TODO
6486 keywords. This list can become very long. There are two ways to keep
6490 @vindex org-agenda-todo-ignore-scheduled
6491 @vindex org-agenda-todo-ignore-deadlines
6492 @vindex org-agenda-todo-ignore-with-date
6493 Some people view a TODO item that has been @emph{scheduled} for execution or
6494 have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}.
6495 Configure the variables @code{org-agenda-todo-ignore-scheduled},
6496 @code{org-agenda-todo-ignore-deadlines}, and/or
6497 @code{org-agenda-todo-ignore-with-date} to exclude such items from the
6500 @vindex org-agenda-todo-list-sublevels
6501 TODO items may have sublevels to break up the task into subtasks. In
6502 such cases it may be enough to list only the highest level TODO headline
6503 and omit the sublevels from the global list. Configure the variable
6504 @code{org-agenda-todo-list-sublevels} to get this behavior.
6507 @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views
6508 @subsection Matching tags and properties
6509 @cindex matching, of tags
6510 @cindex matching, of properties
6514 If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}),
6515 or have properties (@pxref{Properties and Columns}), you can select headlines
6516 based on this metadata and collect them into an agenda buffer. The match
6517 syntax described here also applies when creating sparse trees with @kbd{C-c /
6523 Produce a list of all headlines that match a given set of tags. The
6524 command prompts for a selection criterion, which is a boolean logic
6525 expression with tags, like @samp{+work+urgent-withboss} or
6526 @samp{work|home} (@pxref{Tags}). If you often need a specific search,
6527 define a custom command for it (@pxref{Agenda dispatcher}).
6530 @vindex org-tags-match-list-sublevels
6531 @vindex org-agenda-tags-todo-honor-ignore-options
6532 Like @kbd{C-c a m}, but only select headlines that are also TODO items and
6533 force checking subitems (see variable @code{org-tags-match-list-sublevels}).
6534 To exclude scheduled/deadline items, see the variable
6535 @code{org-agenda-tags-todo-honor-ignore-options}. Matching specific TODO
6536 keywords together with a tags match is also possible, see @ref{Tag searches}.
6539 The commands available in the tags list are described in @ref{Agenda
6542 @subsubheading Match syntax
6544 @cindex Boolean logic, for tag/property searches
6545 A search string can use Boolean operators @samp{&} for AND and @samp{|} for
6546 OR. @samp{&} binds more strongly than @samp{|}. Parentheses are currently
6547 not implemented. Each element in the search is either a tag, a regular
6548 expression matching tags, or an expression like @code{PROPERTY OPERATOR
6549 VALUE} with a comparison operator, accessing a property value. Each element
6550 may be preceded by @samp{-}, to select against it, and @samp{+} is syntactic
6551 sugar for positive selection. The AND operator @samp{&} is optional when
6552 @samp{+} or @samp{-} is present. Here are some examples, using only tags.
6556 Select headlines tagged @samp{:work:}, but discard those also tagged
6559 Selects lines tagged @samp{:work:} or @samp{:laptop:}.
6560 @item work|laptop+night
6561 Like before, but require the @samp{:laptop:} lines to be tagged also
6565 @cindex regular expressions, with tags search
6566 Instead of a tag, you may also specify a regular expression enclosed in curly
6567 braces. For example,
6568 @samp{work+@{^boss.*@}} matches headlines that contain the tag
6569 @samp{:work:} and any tag @i{starting} with @samp{boss}.
6571 @cindex TODO keyword matching, with tags search
6572 @cindex level, require for tags/property match
6573 @cindex category, require for tags/property match
6574 @vindex org-odd-levels-only
6575 You may also test for properties (@pxref{Properties and Columns}) at the same
6576 time as matching tags. The properties may be real properties, or special
6577 properties that represent other metadata (@pxref{Special properties}). For
6578 example, the ``property'' @code{TODO} represents the TODO keyword of the
6579 entry. Or, the ``property'' @code{LEVEL} represents the level of an entry.
6580 So a search @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines
6581 that have the tag @samp{boss} and are @emph{not} marked with the TODO keyword
6582 DONE. In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not
6583 count the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc.
6585 Here are more examples:
6587 @item work+TODO="WAITING"
6588 Select @samp{:work:}-tagged TODO lines with the specific TODO
6589 keyword @samp{WAITING}.
6590 @item work+TODO="WAITING"|home+TODO="WAITING"
6591 Waiting tasks both at work and at home.
6594 When matching properties, a number of different operators can be used to test
6595 the value of a property. Here is a complex example:
6598 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 \
6599 +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
6603 The type of comparison will depend on how the comparison value is written:
6606 If the comparison value is a plain number, a numerical comparison is done,
6607 and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
6608 @samp{>=}, and @samp{<>}.
6610 If the comparison value is enclosed in double-quotes,
6611 a string comparison is done, and the same operators are allowed.
6613 If the comparison value is enclosed in double-quotes @emph{and} angular
6614 brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
6615 assumed to be date/time specifications in the standard Org way, and the
6616 comparison will be done accordingly. Special values that will be recognized
6617 are @code{"<now>"} for now (including time), and @code{"<today>"}, and
6618 @code{"<tomorrow>"} for these days at 0:00 hours, @ie without a time
6619 specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
6620 @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
6621 respectively, can be used.
6623 If the comparison value is enclosed
6624 in curly braces, a regexp match is performed, with @samp{=} meaning that the
6625 regexp matches the property value, and @samp{<>} meaning that it does not
6629 So the search string in the example finds entries tagged @samp{:work:} but
6630 not @samp{:boss:}, which also have a priority value @samp{A}, a
6631 @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
6632 property that is numerically smaller than 2, a @samp{:With:} property that is
6633 matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
6634 on or after October 11, 2008.
6636 Accessing TODO, LEVEL, and CATEGORY during a search is fast. Accessing any
6637 other properties will slow down the search. However, once you have paid the
6638 price by accessing one property, testing additional properties is cheap
6641 You can configure Org mode to use property inheritance during a search, but
6642 beware that this can slow down searches considerably. See @ref{Property
6643 inheritance}, for details.
6645 For backward compatibility, and also for typing speed, there is also a
6646 different way to test TODO states in a search. For this, terminate the
6647 tags/property part of the search string (which may include several terms
6648 connected with @samp{|}) with a @samp{/} and then specify a Boolean
6649 expression just for TODO keywords. The syntax is then similar to that for
6650 tags, but should be applied with care: for example, a positive
6651 selection on several TODO keywords cannot meaningfully be combined with
6652 boolean AND. However, @emph{negative selection} combined with AND can be
6653 meaningful. To make sure that only lines are checked that actually have any
6654 TODO keyword (resulting in a speed-up), use @kbd{C-c a M}, or equivalently
6655 start the TODO part after the slash with @samp{!}. Examples:
6659 Same as @samp{work+TODO="WAITING"}
6660 @item work/!-WAITING-NEXT
6661 Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
6663 @item work/!+WAITING|+NEXT
6664 Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
6668 @node Timeline, Keyword search, Matching tags and properties, Built-in agenda views
6669 @subsection Timeline for a single file
6670 @cindex timeline, single file
6671 @cindex time-sorted view
6673 The timeline summarizes all time-stamped items from a single Org mode
6674 file in a @emph{time-sorted view}. The main purpose of this command is
6675 to give an overview over events in a project.
6680 Show a time-sorted view of the Org file, with all time-stamped items.
6681 When called with a @kbd{C-u} prefix, all unfinished TODO entries
6682 (scheduled or not) are also listed under the current date.
6686 The commands available in the timeline buffer are listed in
6687 @ref{Agenda commands}.
6689 @node Keyword search, Stuck projects, Timeline, Built-in agenda views
6690 @subsection Keyword search
6691 @cindex keyword search
6692 @cindex searching, for keywords
6694 This agenda view is a general text search facility for Org mode entries.
6695 It is particularly useful to find notes.
6700 This is a special search that lets you select entries by keywords or
6701 regular expression, using a boolean logic. For example, the search
6705 +computer +wifi -ethernet -@{8\.11[bg]@}
6709 will search for note entries that contain the keywords @code{computer}
6710 and @code{wifi}, but not the keyword @code{ethernet}, and which are also
6711 not matched by the regular expression @code{8\.11[bg]}, meaning to
6712 exclude both 8.11b and 8.11g.
6714 @vindex org-agenda-text-search-extra-files
6715 Note that in addition to the agenda files, this command will also search
6716 the files listed in @code{org-agenda-text-search-extra-files}.
6719 @node Stuck projects, , Keyword search, Built-in agenda views
6720 @subsection Stuck projects
6722 If you are following a system like David Allen's GTD to organize your
6723 work, one of the ``duties'' you have is a regular review to make sure
6724 that all projects move along. A @emph{stuck} project is a project that
6725 has no defined next actions, so it will never show up in the TODO lists
6726 Org mode produces. During the review, you need to identify such
6727 projects and define next actions for them.
6732 List projects that are stuck.
6735 @vindex org-stuck-projects
6736 Customize the variable @code{org-stuck-projects} to define what a stuck
6737 project is and how to find it.
6740 You almost certainly will have to configure this view before it will
6741 work for you. The built-in default assumes that all your projects are
6742 level-2 headlines, and that a project is not stuck if it has at least
6743 one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
6745 Let's assume that you, in your own way of using Org mode, identify
6746 projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
6747 indicate a project that should not be considered yet. Let's further
6748 assume that the TODO keyword DONE marks finished projects, and that NEXT
6749 and TODO indicate next actions. The tag @@SHOP indicates shopping and
6750 is a next action even without the NEXT tag. Finally, if the project
6751 contains the special word IGNORE anywhere, it should not be listed
6752 either. In this case you would start by identifying eligible projects
6753 with a tags/todo match@footnote{@xref{Tag searches}.}
6754 @samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT, @@SHOP, and
6755 IGNORE in the subtree to identify projects that are not stuck. The
6756 correct customization for this is
6759 (setq org-stuck-projects
6760 '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
6764 Note that if a project is identified as non-stuck, the subtree of this entry
6765 will still be searched for stuck projects.
6767 @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views
6768 @section Presentation and sorting
6769 @cindex presentation, of agenda items
6771 @vindex org-agenda-prefix-format
6772 Before displaying items in an agenda view, Org mode visually prepares
6773 the items and sorts them. Each item occupies a single line. The line
6774 starts with a @emph{prefix} that contains the @emph{category}
6775 (@pxref{Categories}) of the item and other important information. You can
6776 customize the prefix using the option @code{org-agenda-prefix-format}.
6777 The prefix is followed by a cleaned-up version of the outline headline
6778 associated with the item.
6781 * Categories:: Not all tasks are equal
6782 * Time-of-day specifications:: How the agenda knows the time
6783 * Sorting of agenda items:: The order of things
6786 @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting
6787 @subsection Categories
6790 The category is a broad label assigned to each agenda item. By default,
6791 the category is simply derived from the file name, but you can also
6792 specify it with a special line in the buffer, like this@footnote{For
6793 backward compatibility, the following also works: if there are several
6794 such lines in a file, each specifies the category for the text below it.
6795 The first category also applies to any text before the first CATEGORY
6796 line. However, using this method is @emph{strongly} deprecated as it is
6797 incompatible with the outline structure of the document. The correct
6798 method for setting multiple categories in a buffer is using a
6806 @cindex property, CATEGORY
6807 If you would like to have a special CATEGORY for a single entry or a
6808 (sub)tree, give the entry a @code{:CATEGORY:} property with the
6809 special category you want to apply as the value.
6812 The display in the agenda buffer looks best if the category is not
6813 longer than 10 characters.
6815 @node Time-of-day specifications, Sorting of agenda items, Categories, Presentation and sorting
6816 @subsection Time-of-day specifications
6817 @cindex time-of-day specification
6819 Org mode checks each agenda item for a time-of-day specification. The
6820 time can be part of the timestamp that triggered inclusion into the
6821 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time
6822 ranges can be specified with two timestamps, like
6824 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
6826 In the headline of the entry itself, a time(range) may also appear as
6827 plain text (like @samp{12:45} or a @samp{8:30-1pm}). If the agenda
6828 integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
6829 specifications in diary entries are recognized as well.
6831 For agenda display, Org mode extracts the time and displays it in a
6832 standard 24 hour format as part of the prefix. The example times in
6833 the previous paragraphs would end up in the agenda like this:
6836 8:30-13:00 Arthur Dent lies in front of the bulldozer
6837 12:45...... Ford Prefect arrives and takes Arthur to the pub
6838 19:00...... The Vogon reads his poem
6839 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
6843 If the agenda is in single-day mode, or for the display of today, the
6844 timed entries are embedded in a time grid, like
6847 8:00...... ------------------
6848 8:30-13:00 Arthur Dent lies in front of the bulldozer
6849 10:00...... ------------------
6850 12:00...... ------------------
6851 12:45...... Ford Prefect arrives and takes Arthur to the pub
6852 14:00...... ------------------
6853 16:00...... ------------------
6854 18:00...... ------------------
6855 19:00...... The Vogon reads his poem
6856 20:00...... ------------------
6857 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
6860 @vindex org-agenda-use-time-grid
6861 @vindex org-agenda-time-grid
6862 The time grid can be turned on and off with the variable
6863 @code{org-agenda-use-time-grid}, and can be configured with
6864 @code{org-agenda-time-grid}.
6866 @node Sorting of agenda items, , Time-of-day specifications, Presentation and sorting
6867 @subsection Sorting of agenda items
6868 @cindex sorting, of agenda items
6869 @cindex priorities, of agenda items
6870 Before being inserted into a view, the items are sorted. How this is
6871 done depends on the type of view.
6874 @vindex org-agenda-files
6875 For the daily/weekly agenda, the items for each day are sorted. The
6876 default order is to first collect all items containing an explicit
6877 time-of-day specification. These entries will be shown at the beginning
6878 of the list, as a @emph{schedule} for the day. After that, items remain
6879 grouped in categories, in the sequence given by @code{org-agenda-files}.
6880 Within each category, items are sorted by priority (@pxref{Priorities}),
6881 which is composed of the base priority (2000 for priority @samp{A}, 1000
6882 for @samp{B}, and 0 for @samp{C}), plus additional increments for
6883 overdue scheduled or deadline items.
6885 For the TODO list, items remain in the order of categories, but within
6886 each category, sorting takes place according to priority
6887 (@pxref{Priorities}). The priority used for sorting derives from the
6888 priority cookie, with additions depending on how close an item is to its due
6891 For tags matches, items are not sorted at all, but just appear in the
6892 sequence in which they are found in the agenda files.
6895 @vindex org-agenda-sorting-strategy
6896 Sorting can be customized using the variable
6897 @code{org-agenda-sorting-strategy}, and may also include criteria based on
6898 the estimated effort of an entry (@pxref{Effort estimates}).
6900 @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda Views
6901 @section Commands in the agenda buffer
6902 @cindex commands, in agenda buffer
6904 Entries in the agenda buffer are linked back to the Org file or diary
6905 file where they originate. You are not allowed to edit the agenda
6906 buffer itself, but commands are provided to show and jump to the
6907 original entry location, and to edit the Org files ``remotely'' from
6908 the agenda buffer. In this way, all information is stored only once,
6909 removing the risk that your agenda and note files may diverge.
6911 Some commands can be executed with mouse clicks on agenda lines. For
6912 the other commands, the cursor needs to be in the desired line.
6915 @tsubheading{Motion}
6916 @cindex motion commands in agenda
6919 Next line (same as @key{up} and @kbd{C-p}).
6922 Previous line (same as @key{down} and @kbd{C-n}).
6923 @tsubheading{View/Go to Org file}
6928 Display the original location of the item in another window.
6929 With prefix arg, make sure that the entire entry is made visible in the
6930 outline, not only the heading.
6934 Display original location and recenter that window.
6942 Go to the original location of the item in another window. Under Emacs
6943 22, @kbd{mouse-1} will also works for this.
6947 Go to the original location of the item and delete other windows.
6951 @vindex org-agenda-start-with-follow-mode
6952 Toggle Follow mode. In Follow mode, as you move the cursor through
6953 the agenda buffer, the other window always shows the corresponding
6954 location in the Org file. The initial setting for this mode in new
6955 agenda buffers can be set with the variable
6956 @code{org-agenda-start-with-follow-mode}.
6960 Display the entire subtree of the current item in an indirect buffer. With a
6961 numeric prefix argument N, go up to level N and then take that tree. If N is
6962 negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the
6963 previously used indirect buffer.
6967 Follow a link in the entry. This will offer a selection of any links in the
6968 text belonging to the referenced Org node. If there is only one link, it
6969 will be followed without a selection prompt.
6971 @tsubheading{Change display}
6972 @cindex display changing, in agenda
6975 Delete other windows.
6983 @item v d @ @r{or short} @ d
6984 @itemx v w @ @r{or short} @ w
6987 Switch to day/week/month/year view. When switching to day or week view,
6988 this setting becomes the default for subsequent agenda commands. Since
6989 month and year views are slow to create, they do not become the default.
6990 A numeric prefix argument may be used to jump directly to a specific day
6991 of the year, ISO week, month, or year, respectively. For example,
6992 @kbd{32 d} jumps to February 1st, @kbd{9 w} to ISO week number 9. When
6993 setting day, week, or month view, a year may be encoded in the prefix
6994 argument as well. For example, @kbd{200712 w} will jump to week 12 in
6995 2007. If such a year specification has only one or two digits, it will
6996 be mapped to the interval 1938-2037.
7000 @vindex org-agenda-ndays
7001 Go forward in time to display the following @code{org-agenda-ndays} days.
7002 For example, if the display covers a week, switch to the following week.
7003 With prefix arg, go forward that many times @code{org-agenda-ndays} days.
7007 Go backward in time to display earlier dates.
7015 Prompt for a date and go there.
7019 Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}.
7023 @item v l @ @r{or short} @ l
7024 @vindex org-log-done
7025 @vindex org-agenda-log-mode-items
7026 Toggle Logbook mode. In Logbook mode, entries that were marked DONE while
7027 logging was on (variable @code{org-log-done}) are shown in the agenda, as are
7028 entries that have been clocked on that day. You can configure the entry
7029 types that should be included in log mode using the variable
7030 @code{org-agenda-log-mode-items}. When called with a @kbd{C-u} prefix, show
7031 all possible logbook entries, including state changes. When called with two
7032 prefix args @kbd{C-u C-u}, show only logging information, nothing else.
7036 @item v [ @ @r{or short} @ [
7037 Include inactive timestamps into the current view. Only for weekly/daily
7038 agenda and timeline views.
7044 Toggle Archives mode. In Archives mode, trees that are marked
7045 @code{ARCHIVED} are also scanned when producing the agenda. When you use the
7046 capital @kbd{A}, even all archive files are included. To exit archives mode,
7047 press @kbd{v a} again.
7051 @item v R @ @r{or short} @ R
7052 @vindex org-agenda-start-with-clockreport-mode
7053 Toggle Clockreport mode. In Clockreport mode, the daily/weekly agenda will
7054 always show a table with the clocked times for the timespan and file scope
7055 covered by the current agenda view. The initial setting for this mode in new
7056 agenda buffers can be set with the variable
7057 @code{org-agenda-start-with-clockreport-mode}.
7061 @item v E @ @r{or short} @ E
7062 @vindex org-agenda-start-with-entry-text-mode
7063 @vindex org-agenda-entry-text-maxlines
7064 Toggle entry text mode. In entry text mode, a number of lines from the Org
7065 outline node referenced by an agenda line will be displayed below the line.
7066 The maximum number of lines is given by the variable
7067 @code{org-agenda-entry-text-maxlines}. Calling this command with a numeric
7068 prefix argument will temporarily modify that number to the prefix value.
7072 @vindex org-agenda-use-time-grid
7073 @vindex org-agenda-time-grid
7074 Toggle the time grid on and off. See also the variables
7075 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
7079 Recreate the agenda buffer, for example to reflect the changes after
7080 modification of the timestamps of items with @kbd{S-@key{left}} and
7081 @kbd{S-@key{right}}. When the buffer is the global TODO list, a prefix
7082 argument is interpreted to create a selective list for a specific TODO
7092 Save all Org buffers in the current Emacs session, and also the locations of
7097 @vindex org-columns-default-format
7098 Invoke column view (@pxref{Column view}) in the agenda buffer. The column
7099 view format is taken from the entry at point, or (if there is no entry at
7100 point), from the first entry in the agenda view. So whatever the format for
7101 that entry would be in the original buffer (taken from a property, from a
7102 @code{#+COLUMNS} line, or from the default variable
7103 @code{org-columns-default-format}), will be used in the agenda.
7107 Remove the restriction lock on the agenda, if it is currently restricted to a
7108 file or subtree (@pxref{Agenda files}).
7110 @tsubheading{Secondary filtering and query editing}
7111 @cindex filtering, by tag and effort, in agenda
7112 @cindex tag filtering, in agenda
7113 @cindex effort filtering, in agenda
7114 @cindex query editing, in agenda
7118 @vindex org-agenda-filter-preset
7119 Filter the current agenda view with respect to a tag and/or effort estimates.
7120 The difference between this and a custom agenda command is that filtering is
7121 very fast, so that you can switch quickly between different filters without
7122 having to recreate the agenda@footnote{Custom commands can preset a filter by
7123 binding the variable @code{org-agenda-filter-preset} as an option. This
7124 filter will then be applied to the view and persist as a basic filter through
7125 refreshes and more secondary filtering.}
7127 You will be prompted for a tag selection letter. Pressing @key{TAB} at that
7128 prompt will offer use completion to select a tag (including any tags that do
7129 not have a selection character). The command then hides all entries that do
7130 not contain or inherit this tag. When called with prefix arg, remove the
7131 entries that @emph{do} have the tag. A second @kbd{/} at the prompt will
7132 turn off the filter and unhide any hidden entries. If the first key you
7133 press is either @kbd{+} or @kbd{-}, the previous filter will be narrowed by
7134 requiring or forbidding the selected additional tag. Instead of pressing
7135 @kbd{+} or @kbd{-} after @kbd{/}, you can also immediately use the @kbd{\}
7138 @vindex org-sort-agenda-noeffort-is-high
7139 In order to filter for effort estimates, you should set-up allowed
7140 efforts globally, for example
7142 (setq org-global-properties
7143 '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
7145 You can then filter for an effort by first typing an operator, one of
7146 @kbd{<}, @kbd{>}, and @kbd{=}, and then the one-digit index of an effort
7147 estimate in your array of allowed values, where @kbd{0} means the 10th value.
7148 The filter will then restrict to entries with effort smaller-or-equal, equal,
7149 or larger-or-equal than the selected value. If the digits 0-9 are not used
7150 as fast access keys to tags, you can also simply press the index digit
7151 directly without an operator. In this case, @kbd{<} will be assumed. For
7152 application of the operator, entries without a defined effort will be treated
7153 according to the value of @code{org-sort-agenda-noeffort-is-high}. To filter
7154 for tasks without effort definition, press @kbd{?} as the operator.
7158 Narrow the current agenda filter by an additional condition. When called with
7159 prefix arg, remove the entries that @emph{do} have the tag, or that do match
7160 the effort criterion. You can achieve the same effect by pressing @kbd{+} or
7161 @kbd{-} as the first key after the @kbd{/} command.
7169 @item @r{in} search view
7170 add new search words (@kbd{[} and @kbd{]}) or new regular expressions
7171 (@kbd{@{} and @kbd{@}}) to the query string. The opening bracket/brace will
7172 add a positive search term prefixed by @samp{+}, indicating that this search
7173 term @i{must} occur/match in the entry. The closing bracket/brace will add a
7174 negative search term which @i{must not} occur/match in the entry for it to be
7178 @tsubheading{Remote editing}
7179 @cindex remote editing, from agenda
7184 @cindex undoing remote-editing events
7185 @cindex remote editing, undo
7188 Undo a change due to a remote editing command. The change is undone
7189 both in the agenda buffer and in the remote buffer.
7193 Change the TODO state of the item, both in the agenda and in the
7198 @vindex org-agenda-confirm-kill
7199 Delete the current agenda item along with the entire subtree belonging
7200 to it in the original Org file. If the text to be deleted remotely
7201 is longer than one line, the kill needs to be confirmed by the user. See
7202 variable @code{org-agenda-confirm-kill}.
7206 Refile the entry at point.
7210 Toggle the ARCHIVE tag for the current headline.
7214 Move the subtree corresponding to the current entry to its @emph{archive
7219 Archive the subtree corresponding to the current headline. This means the
7220 entry will be moved to the configured archive location, most likely a
7225 @vindex org-agenda-show-inherited-tags
7226 Show all tags associated with the current item. This is useful if you have
7227 turned off @code{org-agenda-show-inherited-tags}, but still want to see all
7228 tags of a headline occasionally.
7232 Set tags for the current headline. If there is an active region in the
7233 agenda, change a tag for all headings in the region.
7237 Set the priority for the current item. Org mode prompts for the
7238 priority character. If you reply with @key{SPC}, the priority cookie
7239 is removed from the entry.
7243 Display weighted priority of current item.
7249 Increase the priority of the current item. The priority is changed in
7250 the original buffer, but the agenda is not resorted. Use the @kbd{r}
7254 @kindex S-@key{down}
7257 Decrease the priority of the current item.
7261 @vindex org-log-into-drawer
7262 Add a note to the entry. This note will be recorded, and then files to the
7263 same location where state change notes are put. Depending on
7264 @code{org-log-into-drawer}, this maybe inside a drawer.
7268 Dispatcher for all command related to attachments.
7276 Set a deadline for this item.
7280 Agenda actions, to set dates for selected items to the cursor date.
7281 This command also works in the calendar! The command prompts for an
7284 m @r{Mark the entry at point for action. You can also make entries}
7285 @r{in Org files with @kbd{C-c C-x C-k}.}
7286 d @r{Set the deadline of the marked entry to the date at point.}
7287 s @r{Schedule the marked entry at the date at point.}
7288 r @r{Call @code{org-remember} with the cursor date as default date.}
7291 Press @kbd{r} afterward to refresh the agenda and see the effect of the
7294 @kindex S-@key{right}
7296 Change the timestamp associated with the current line by one day into the
7297 future. With a numeric prefix argument, change it by that many days. For
7298 example, @kbd{3 6 5 S-@key{right}} will change it by a year. With a
7299 @kbd{C-u} prefix, change the time by one hour. If you immediately repeat the
7300 command, it will continue to change hours even without the prefix arg. With
7301 a double @kbd{C-u C-u} prefix, do the same for changing minutes. The stamp
7302 is changed in the original Org file, but the change is not directly reflected
7303 in the agenda buffer. Use @kbd{r} or @kbd{g} to update the buffer.
7305 @kindex S-@key{left}
7307 Change the timestamp associated with the current line by one day
7312 Change the timestamp associated with the current line to today.
7313 The key @kbd{>} has been chosen, because it is the same as @kbd{S-.}
7318 Start the clock on the current item. If a clock is running already, it
7323 Stop the previously started clock.
7327 Cancel the currently running clock.
7331 Jump to the running clock in another window.
7333 @tsubheading{Bulk remote editing selected entries}
7334 @cindex remote editing, bulk, from agenda
7338 Mark the entry at point for bulk action.
7342 Unmark entry for bulk action.
7346 Unmark all marked entries for bulk action.
7350 Bulk action: act on all marked entries in the agenda. This will prompt for
7351 another key to select the action to be applied:
7353 r @r{Prompt for a single refile target and move all entries. The entries}
7354 @r{will no longer be in the agenda, refresh (@kbd{g}) to bring them back.}
7355 $ @r{Archive all selected entries.}
7356 A @r{Archive entries by moving them to their respective archive siblings.}
7357 t @r{Change TODO state. This prompts for a single TODO keyword and}
7358 @r{changes the state of all selected entries, bypassing blocking and}
7359 @r{suppressing logging notes (but not time stamps).}
7360 + @r{Add a tag to all selected entries.}
7361 - @r{Remove a tag from all selected entries.}
7362 s @r{Schedule all items to a new date. To shift existing schedule dates}
7363 @r{by a fixed number of days, use something starting with double plus}
7364 @r{at the prompt, for example @samp{++8d} or @samp{++2w}.}
7365 d @r{Set deadline to a specific date.}
7369 @tsubheading{Calendar commands}
7370 @cindex calendar commands, from agenda
7373 Open the Emacs calendar and move to the date at the agenda cursor.
7376 When in the calendar, compute and show the Org mode agenda for the
7379 @cindex diary entries, creating from agenda
7382 Insert a new entry into the diary. Prompts for the type of entry
7383 (day, weekly, monthly, yearly, anniversary, cyclic) and creates a new
7384 entry in the diary, just as @kbd{i d}, etc., would do in the calendar.
7385 The date is taken from the cursor position.
7389 Show the phases of the moon for the three months around current date.
7393 Show sunrise and sunset times. The geographical location must be set
7394 with calendar variables, see the documentation for the Emacs calendar.
7398 Convert the date at cursor into many other cultural and historic
7403 Show holidays for three months around the cursor date.
7405 @item M-x org-export-icalendar-combine-agenda-files
7406 Export a single iCalendar file containing entries from all agenda files.
7407 This is a globally available command, and also available in the agenda menu.
7409 @tsubheading{Exporting to a file}
7412 @cindex exporting agenda views
7413 @cindex agenda views, exporting
7414 @vindex org-agenda-exporter-settings
7415 Write the agenda view to a file. Depending on the extension of the selected
7416 file name, the view will be exported as HTML (extension @file{.html} or
7417 @file{.htm}), Postscript (extension @file{.ps}), PDF (extension @file{.pdf}),
7418 Org-mode (extension @file{.org}), and plain text (any other extension). When
7419 called with a @kbd{C-u} prefix argument, immediately open the newly created
7420 file. Use the variable @code{org-agenda-exporter-settings} to set options
7421 for @file{ps-print} and for @file{htmlize} to be used during export.
7423 @tsubheading{Quit and Exit}
7426 Quit agenda, remove the agenda buffer.
7429 @cindex agenda files, removing buffers
7431 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
7432 for the compilation of the agenda. Buffers created by the user to
7433 visit Org files will not be removed.
7437 @node Custom agenda views, Exporting Agenda Views, Agenda commands, Agenda Views
7438 @section Custom agenda views
7439 @cindex custom agenda views
7440 @cindex agenda views, custom
7442 Custom agenda commands serve two purposes: to store and quickly access
7443 frequently used TODO and tags searches, and to create special composite
7444 agenda buffers. Custom agenda commands will be accessible through the
7445 dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
7448 * Storing searches:: Type once, use often
7449 * Block agenda:: All the stuff you need in a single buffer
7450 * Setting Options:: Changing the rules
7453 @node Storing searches, Block agenda, Custom agenda views, Custom agenda views
7454 @subsection Storing searches
7456 The first application of custom searches is the definition of keyboard
7457 shortcuts for frequently used searches, either creating an agenda
7458 buffer, or a sparse tree (the latter covering of course only the current
7461 @vindex org-agenda-custom-commands
7462 Custom commands are configured in the variable
7463 @code{org-agenda-custom-commands}. You can customize this variable, for
7464 example by pressing @kbd{C-c a C}. You can also directly set it with
7465 Emacs Lisp in @file{.emacs}. The following example contains all valid
7470 (setq org-agenda-custom-commands
7471 '(("w" todo "WAITING")
7472 ("W" todo-tree "WAITING")
7473 ("u" tags "+boss-urgent")
7474 ("v" tags-todo "+boss-urgent")
7475 ("U" tags-tree "+boss-urgent")
7476 ("f" occur-tree "\\<FIXME\\>")
7477 ("h" . "HOME+Name tags searches") ; description for "h" prefix
7478 ("hl" tags "+home+Lisa")
7479 ("hp" tags "+home+Peter")
7480 ("hk" tags "+home+Kim")))
7485 The initial string in each entry defines the keys you have to press
7486 after the dispatcher command @kbd{C-c a} in order to access the command.
7487 Usually this will be just a single character, but if you have many
7488 similar commands, you can also define two-letter combinations where the
7489 first character is the same in several combinations and serves as a
7490 prefix key@footnote{You can provide a description for a prefix key by
7491 inserting a cons cell with the prefix and the description.}. The second
7492 parameter is the search type, followed by the string or regular
7493 expression to be used for the matching. The example above will
7498 as a global search for TODO entries with @samp{WAITING} as the TODO
7501 as the same search, but only in the current buffer and displaying the
7502 results as a sparse tree
7504 as a global tags search for headlines marked @samp{:boss:} but not
7507 as the same search as @kbd{C-c a u}, but limiting the search to
7508 headlines that are also TODO items
7510 as the same search as @kbd{C-c a u}, but only in the current buffer and
7511 displaying the result as a sparse tree
7513 to create a sparse tree (again: current buffer only) with all entries
7514 containing the word @samp{FIXME}
7516 as a prefix command for a HOME tags search where you have to press an
7517 additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
7518 Peter, or Kim) as additional tag to match.
7521 @node Block agenda, Setting Options, Storing searches, Custom agenda views
7522 @subsection Block agenda
7523 @cindex block agenda
7524 @cindex agenda, with block views
7526 Another possibility is the construction of agenda views that comprise
7527 the results of @emph{several} commands, each of which creates a block in
7528 the agenda buffer. The available commands include @code{agenda} for the
7529 daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
7530 for the global TODO list (as constructed with @kbd{C-c a t}), and the
7531 matching commands discussed above: @code{todo}, @code{tags}, and
7532 @code{tags-todo}. Here are two examples:
7536 (setq org-agenda-custom-commands
7537 '(("h" "Agenda and Home-related tasks"
7541 ("o" "Agenda and Office-related tasks"
7549 This will define @kbd{C-c a h} to create a multi-block view for stuff
7550 you need to attend to at home. The resulting agenda buffer will contain
7551 your agenda for the current week, all TODO items that carry the tag
7552 @samp{home}, and also all lines tagged with @samp{garden}. Finally the
7553 command @kbd{C-c a o} provides a similar view for office tasks.
7555 @node Setting Options, , Block agenda, Custom agenda views
7556 @subsection Setting options for custom commands
7557 @cindex options, for custom agenda views
7559 @vindex org-agenda-custom-commands
7560 Org mode contains a number of variables regulating agenda construction
7561 and display. The global variables define the behavior for all agenda
7562 commands, including the custom commands. However, if you want to change
7563 some settings just for a single custom view, you can do so. Setting
7564 options requires inserting a list of variable names and values at the
7565 right spot in @code{org-agenda-custom-commands}. For example:
7569 (setq org-agenda-custom-commands
7570 '(("w" todo "WAITING"
7571 ((org-agenda-sorting-strategy '(priority-down))
7572 (org-agenda-prefix-format " Mixed: ")))
7573 ("U" tags-tree "+boss-urgent"
7574 ((org-show-following-heading nil)
7575 (org-show-hierarchy-above nil)))
7577 ((org-agenda-files '("~org/notes.org"))
7578 (org-agenda-text-search-extra-files nil)))))
7583 Now the @kbd{C-c a w} command will sort the collected entries only by
7584 priority, and the prefix format is modified to just say @samp{ Mixed: }
7585 instead of giving the category of the entry. The sparse tags tree of
7586 @kbd{C-c a U} will now turn out ultra-compact, because neither the
7587 headline hierarchy above the match, nor the headline following the match
7588 will be shown. The command @kbd{C-c a N} will do a text search limited
7589 to only a single file.
7591 @vindex org-agenda-custom-commands
7592 For command sets creating a block agenda,
7593 @code{org-agenda-custom-commands} has two separate spots for setting
7594 options. You can add options that should be valid for just a single
7595 command in the set, and options that should be valid for all commands in
7596 the set. The former are just added to the command entry, the latter
7597 must come after the list of command entries. Going back to the block
7598 agenda example (@pxref{Block agenda}), let's change the sorting strategy
7599 for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
7600 the results for GARDEN tags query in the opposite order,
7601 @code{priority-up}. This would look like this:
7605 (setq org-agenda-custom-commands
7606 '(("h" "Agenda and Home-related tasks"
7610 ((org-agenda-sorting-strategy '(priority-up)))))
7611 ((org-agenda-sorting-strategy '(priority-down))))
7612 ("o" "Agenda and Office-related tasks"
7619 As you see, the values and parentheses setting is a little complex.
7620 When in doubt, use the customize interface to set this variable---it
7621 fully supports its structure. Just one caveat: when setting options in
7622 this interface, the @emph{values} are just Lisp expressions. So if the
7623 value is a string, you need to add the double-quotes around the value
7627 @node Exporting Agenda Views, Agenda column view, Custom agenda views, Agenda Views
7628 @section Exporting Agenda Views
7629 @cindex agenda views, exporting
7631 If you are away from your computer, it can be very useful to have a printed
7632 version of some agenda views to carry around. Org mode can export custom
7633 agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's
7634 @file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the
7635 ghostscript @file{ps2pdf} utility must be installed on the system. Selecting
7636 a PDF file with also create the postscript file.}, and iCalendar files. If
7637 you want to do this only occasionally, use the command
7642 @cindex exporting agenda views
7643 @cindex agenda views, exporting
7644 @vindex org-agenda-exporter-settings
7645 Write the agenda view to a file. Depending on the extension of the selected
7646 file name, the view will be exported as HTML (extension @file{.html} or
7647 @file{.htm}), Postscript (extension @file{.ps}), iCalendar (extension
7648 @file{.ics}), Org-mode (extension @file{.org}), or plain text (any other
7649 extension). Use the variable @code{org-agenda-exporter-settings} to set
7650 options for @file{ps-print} and for @file{htmlize} to be used during export,
7653 @vindex org-agenda-add-entry-text-maxlines
7654 @vindex htmlize-output-type
7655 @vindex ps-number-of-columns
7656 @vindex ps-landscape-mode
7658 (setq org-agenda-exporter-settings
7659 '((ps-number-of-columns 2)
7660 (ps-landscape-mode t)
7661 (org-agenda-add-entry-text-maxlines 5)
7662 (htmlize-output-type 'css)))
7666 If you need to export certain agenda views frequently, you can associate
7667 any custom agenda command with a list of output file names
7668 @footnote{If you want to store standard views like the weekly agenda
7669 or the global TODO list as well, you need to define custom commands for
7670 them in order to be able to specify file names.}. Here is an example
7671 that first defines custom commands for the agenda and the global
7672 TODO list, together with a number of files to which to export them.
7673 Then we define two block agenda commands and specify file names for them
7674 as well. File names can be relative to the current working directory,
7679 (setq org-agenda-custom-commands
7680 '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
7681 ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
7682 ("h" "Agenda and Home-related tasks"
7687 ("~/views/home.html"))
7688 ("o" "Agenda and Office-related tasks"
7693 ("~/views/office.ps" "~/calendars/office.ics"))))
7697 The extension of the file name determines the type of export. If it is
7698 @file{.html}, Org mode will use the @file{htmlize.el} package to convert
7699 the buffer to HTML and save it to this file name. If the extension is
7700 @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
7701 Postscript output. If the extension is @file{.ics}, iCalendar export is
7702 run export over all files that were used to construct the agenda, and
7703 limit the export to entries listed in the agenda. Any other
7704 extension produces a plain ASCII file.
7706 The export files are @emph{not} created when you use one of those
7707 commands interactively because this might use too much overhead.
7708 Instead, there is a special command to produce @emph{all} specified
7714 Export all agenda views that have export file names associated with
7718 You can use the options section of the custom agenda commands to also
7719 set options for the export commands. For example:
7722 (setq org-agenda-custom-commands
7724 ((ps-number-of-columns 2)
7725 (ps-landscape-mode t)
7726 (org-agenda-prefix-format " [ ] ")
7727 (org-agenda-with-colors nil)
7728 (org-agenda-remove-tags t))
7733 This command sets two options for the Postscript exporter, to make it
7734 print in two columns in landscape format---the resulting page can be cut
7735 in two and then used in a paper agenda. The remaining settings modify
7736 the agenda prefix to omit category and scheduling information, and
7737 instead include a checkbox to check off items. We also remove the tags
7738 to make the lines compact, and we don't want to use colors for the
7739 black-and-white printer. Settings specified in
7740 @code{org-agenda-exporter-settings} will also apply, but the settings
7741 in @code{org-agenda-custom-commands} take precedence.
7744 From the command line you may also use
7746 emacs -f org-batch-store-agenda-views -kill
7749 or, if you need to modify some parameters@footnote{Quoting depends on the
7750 system you use, please check the FAQ for examples.}
7752 emacs -eval '(org-batch-store-agenda-views \
7753 org-agenda-ndays 30 \
7754 org-agenda-start-day "2007-11-01" \
7755 org-agenda-include-diary nil \
7756 org-agenda-files (quote ("~/org/project.org")))' \
7760 which will create the agenda views restricted to the file
7761 @file{~/org/project.org}, without diary entries and with a 30-day
7764 You can also extract agenda information in a way that allows further
7765 processing by other programs. See @ref{Extracting agenda information}, for
7769 @node Agenda column view, , Exporting Agenda Views, Agenda Views
7770 @section Using column view in the agenda
7771 @cindex column view, in agenda
7772 @cindex agenda, column view
7774 Column view (@pxref{Column view}) is normally used to view and edit
7775 properties embedded in the hierarchical structure of an Org file. It can be
7776 quite useful to use column view also from the agenda, where entries are
7777 collected by certain criteria.
7782 Turn on column view in the agenda.
7785 To understand how to use this properly, it is important to realize that the
7786 entries in the agenda are no longer in their proper outline environment.
7787 This causes the following issues:
7791 @vindex org-columns-default-format
7792 @vindex org-overriding-columns-format
7793 Org needs to make a decision which @code{COLUMNS} format to use. Since the
7794 entries in the agenda are collected from different files, and different files
7795 may have different @code{COLUMNS} formats, this is a non-trivial problem.
7796 Org first checks if the variable @code{org-overriding-columns-format} is
7797 currently set, and if so, takes the format from there. Otherwise it takes
7798 the format associated with the first item in the agenda, or, if that item
7799 does not have a specific format (defined in a property, or in its file), it
7800 uses @code{org-columns-default-format}.
7802 @cindex property, special, CLOCKSUM
7803 If any of the columns has a summary type defined (@pxref{Column attributes}),
7804 turning on column view in the agenda will visit all relevant agenda files and
7805 make sure that the computations of this property are up to date. This is
7806 also true for the special @code{CLOCKSUM} property. Org will then sum the
7807 values displayed in the agenda. In the daily/weekly agenda, the sums will
7808 cover a single day, in all other views they cover the entire block. It is
7809 vital to realize that the agenda may show the same entry @emph{twice} (for
7810 example as scheduled and as a deadline), and it may show two entries from the
7811 same hierarchy (for example a @emph{parent} and its @emph{child}). In these
7812 cases, the summation in the agenda will lead to incorrect results because
7813 some values will count double.
7815 When the column view in the agenda shows the @code{CLOCKSUM}, that is always
7816 the entire clocked time for this item. So even in the daily/weekly agenda,
7817 the clocksum listed in column view may originate from times outside the
7818 current view. This has the advantage that you can compare these values with
7819 a column listing the planned total effort for a task---one of the major
7820 applications for column view in the agenda. If you want information about
7821 clocked time in the displayed period use clock table mode (press @kbd{R} in
7826 @node Embedded LaTeX, Exporting, Agenda Views, Top
7827 @chapter Embedded La@TeX{}
7828 @cindex @TeX{} interpretation
7829 @cindex La@TeX{} interpretation
7831 Plain ASCII is normally sufficient for almost all note taking. One
7832 exception, however, are scientific notes which need to be able to contain
7833 mathematical symbols and the occasional formula. La@TeX{}@footnote{La@TeX{}
7834 is a macro system based on Donald E. Knuth's @TeX{} system. Many of the
7835 features described here as ``La@TeX{}'' are really from @TeX{}, but for
7836 simplicity I am blurring this distinction.} is widely used to typeset
7837 scientific documents. Org mode supports embedding La@TeX{} code into its
7838 files, because many academics are used to reading La@TeX{} source code, and
7839 because it can be readily processed into images for HTML production.
7841 It is not necessary to mark La@TeX{} macros and code in any special way.
7842 If you observe a few conventions, Org mode knows how to find it and what
7846 * Math symbols:: @TeX{} macros for symbols and Greek letters
7847 * Subscripts and superscripts:: Simple syntax for raising/lowering text
7848 * LaTeX fragments:: Complex formulas made easy
7849 * Processing LaTeX fragments:: Previewing La@TeX{} processing
7850 * CDLaTeX mode:: Speed up entering of formulas
7853 @node Math symbols, Subscripts and superscripts, Embedded LaTeX, Embedded LaTeX
7854 @section Math symbols
7855 @cindex math symbols
7856 @cindex @TeX{} macros
7858 You can use La@TeX{} macros to insert special symbols like @samp{\alpha} to
7859 indicate the Greek letter, or @samp{\to} to indicate an arrow. Completion
7860 for these macros is available, just type @samp{\} and maybe a few letters,
7861 and press @kbd{M-@key{TAB}} to see possible completions. Unlike La@TeX{}
7862 code, Org mode allows these macros to be present without surrounding math
7863 delimiters, for example:
7866 Angles are written as Greek letters \alpha, \beta and \gamma.
7869 During HTML export (@pxref{HTML export}), these symbols are translated
7870 into the proper syntax for HTML, for the above examples this is
7871 @samp{α} and @samp{→}, respectively. If you need such a symbol
7872 inside a word, terminate it like this: @samp{\Aacute@{@}stor}.
7874 @node Subscripts and superscripts, LaTeX fragments, Math symbols, Embedded LaTeX
7875 @section Subscripts and superscripts
7879 Just like in La@TeX{}, @samp{^} and @samp{_} are used to indicate super-
7880 and subscripts. Again, these can be used without embedding them in
7881 math-mode delimiters. To increase the readability of ASCII text, it is
7882 not necessary (but OK) to surround multi-character sub- and superscripts
7883 with curly braces. For example
7886 The mass if the sun is M_sun = 1.989 x 10^30 kg. The radius of
7887 the sun is R_@{sun@} = 6.96 x 10^8 m.
7890 To avoid interpretation as raised or lowered text, you can quote
7891 @samp{^} and @samp{_} with a backslash: @samp{\^} and @samp{\_}.
7893 During HTML export (@pxref{HTML export}), subscript and superscripts
7894 are surrounded with @code{<sub>} and @code{<sup>} tags, respectively.
7896 @node LaTeX fragments, Processing LaTeX fragments, Subscripts and superscripts, Embedded LaTeX
7897 @section La@TeX{} fragments
7898 @cindex La@TeX{} fragments
7900 @vindex org-format-latex-header
7901 With symbols, sub- and superscripts, HTML is pretty much at its end when
7902 it comes to representing mathematical formulas@footnote{Yes, there is
7903 MathML, but that is not yet fully supported by many browsers, and there
7904 is no decent converter for turning La@TeX{} or ASCII representations of
7905 formulas into MathML. So for the time being, converting formulas into
7906 images seems the way to go.}. More complex expressions need a dedicated
7907 formula processor. To this end, Org mode can contain arbitrary La@TeX{}
7908 fragments. It provides commands to preview the typeset result of these
7909 fragments, and upon export to HTML, all fragments will be converted to
7910 images and inlined into the HTML document@footnote{The La@TeX{} export
7911 will not use images for displaying La@TeX{} fragments but include these
7912 fragments directly into the La@TeX{} code.}. For this to work you
7913 need to be on a system with a working La@TeX{} installation. You also
7914 need the @file{dvipng} program, available at
7915 @url{http://sourceforge.net/projects/dvipng/}. The La@TeX{} header that
7916 will be used when processing a fragment can be configured with the
7917 variable @code{org-format-latex-header}.
7919 La@TeX{} fragments don't need any special marking at all. The following
7920 snippets will be identified as La@TeX{} source code:
7923 Environments of any kind. The only requirement is that the
7924 @code{\begin} statement appears on a new line, preceded by only
7927 Text within the usual La@TeX{} math delimiters. To avoid conflicts with
7928 currency specifications, single @samp{$} characters are only recognized as
7929 math delimiters if the enclosed text contains at most two line breaks, is
7930 directly attached to the @samp{$} characters with no whitespace in between,
7931 and if the closing @samp{$} is followed by whitespace, punctuation or a dash.
7932 For the other delimiters, there is no such restriction, so when in doubt, use
7933 @samp{\(...\)} as inline math delimiters.
7936 @noindent For example:
7939 \begin@{equation@} % arbitrary environments,
7940 x=\sqrt@{b@} % even tables, figures
7941 \end@{equation@} % etc
7943 If $a^2=b$ and \( b=2 \), then the solution must be
7944 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
7948 @vindex org-format-latex-options
7949 If you need any of the delimiter ASCII sequences for other purposes, you
7950 can configure the option @code{org-format-latex-options} to deselect the
7951 ones you do not wish to have interpreted by the La@TeX{} converter.
7953 @node Processing LaTeX fragments, CDLaTeX mode, LaTeX fragments, Embedded LaTeX
7954 @section Processing LaTeX fragments
7955 @cindex LaTeX fragments, preview
7957 La@TeX{} fragments can be processed to produce preview images of the
7958 typeset expressions:
7963 Produce a preview image of the La@TeX{} fragment at point and overlay it
7964 over the source code. If there is no fragment at point, process all
7965 fragments in the current entry (between two headlines). When called
7966 with a prefix argument, process the entire subtree. When called with
7967 two prefix arguments, or when the cursor is before the first headline,
7968 process the entire buffer.
7971 Remove the overlay preview images.
7974 @vindex org-format-latex-options
7975 You can customize the variable @code{org-format-latex-options} to influence
7976 some aspects of the preview. In particular, the @code{:scale} (and for HTML
7977 export, @code{:html-scale}) property can be used to adjust the size of the
7980 During HTML export (@pxref{HTML export}), all La@TeX{} fragments are
7981 converted into images and inlined into the document if the following
7985 (setq org-export-with-LaTeX-fragments t)
7988 @node CDLaTeX mode, , Processing LaTeX fragments, Embedded LaTeX
7989 @section Using CDLa@TeX{} to enter math
7992 CDLa@TeX{} mode is a minor mode that is normally used in combination with a
7993 major La@TeX{} mode like AUC@TeX{} in order to speed-up insertion of
7994 environments and math templates. Inside Org mode, you can make use of
7995 some of the features of CDLa@TeX{} mode. You need to install
7996 @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
7997 AUC@TeX{}) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
7998 Don't use CDLa@TeX{} mode itself under Org mode, but use the light
7999 version @code{org-cdlatex-mode} that comes as part of Org mode. Turn it
8000 on for the current buffer with @code{M-x org-cdlatex-mode}, or for all
8004 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
8007 When this mode is enabled, the following features are present (for more
8008 details see the documentation of CDLa@TeX{} mode):
8012 Environment templates can be inserted with @kbd{C-c @{}.
8015 The @key{TAB} key will do template expansion if the cursor is inside a
8016 La@TeX{} fragment@footnote{Org mode has a method to test if the cursor is
8017 inside such a fragment, see the documentation of the function
8018 @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will
8019 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
8020 correctly inside the first brace. Another @key{TAB} will get you into
8021 the second brace. Even outside fragments, @key{TAB} will expand
8022 environment abbreviations at the beginning of a line. For example, if
8023 you write @samp{equ} at the beginning of a line and press @key{TAB},
8024 this abbreviation will be expanded to an @code{equation} environment.
8025 To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}.
8029 @vindex cdlatex-simplify-sub-super-scripts
8030 Pressing @kbd{_} and @kbd{^} inside a La@TeX{} fragment will insert these
8031 characters together with a pair of braces. If you use @key{TAB} to move
8032 out of the braces, and if the braces surround only a single character or
8033 macro, they are removed again (depending on the variable
8034 @code{cdlatex-simplify-sub-super-scripts}).
8037 Pressing the backquote @kbd{`} followed by a character inserts math
8038 macros, also outside La@TeX{} fragments. If you wait more than 1.5 seconds
8039 after the backquote, a help window will pop up.
8042 Pressing the single-quote @kbd{'} followed by another character modifies
8043 the symbol before point with an accent or a font. If you wait more than
8044 1.5 seconds after the backquote, a help window will pop up. Character
8045 modification will work only inside La@TeX{} fragments, outside the quote
8049 @node Exporting, Publishing, Embedded LaTeX, Top
8053 Org-mode documents can be exported into a variety of other formats. For
8054 printing and sharing of notes, ASCII export produces a readable and simple
8055 version of an Org file. HTML export allows you to publish a notes file on
8056 the web, while the XOXO format provides a solid base for exchange with a
8057 broad range of other applications. La@TeX{} export lets you use Org mode and
8058 its structured editing functions to easily create La@TeX{} files. DocBook
8059 export makes it possible to convert Org files to many other formats using
8060 DocBook tools. To incorporate entries with associated times like deadlines
8061 or appointments into a desktop calendar program like iCal, Org mode can also
8062 produce extracts in the iCalendar format. Currently Org mode only supports
8063 export, not import of these different formats.
8065 Org supports export of selected regions when @code{transient-mark-mode} is
8066 enabled (default in Emacs 23).
8069 * Markup rules:: Which structures are recognized?
8070 * Selective export:: Using tags to select and exclude trees
8071 * Export options:: Per-file export settings
8072 * The export dispatcher:: How to access exporter commands
8073 * ASCII export:: Exporting to plain ASCII
8074 * HTML export:: Exporting to HTML
8075 * LaTeX and PDF export:: Exporting to La@TeX{}, and processing to PDF
8076 * DocBook export:: Exporting to DocBook
8077 * XOXO export:: Exporting to XOXO
8078 * iCalendar export:: Exporting in iCalendar format
8081 @node Markup rules, Selective export, Exporting, Exporting
8082 @section Markup rules
8084 When exporting Org-mode documents, the exporter tries to reflect the
8085 structure of the document as accurately as possible in the backend. Since
8086 export targets like HTML, La@TeX{}, or DocBook allow much richer formatting,
8087 Org mode has rules on how to prepare text for rich export. This section
8088 summarizes the markup rules used in an Org-mode buffer.
8091 * Document title:: How the document title is determined
8092 * Headings and sections:: The main structure of the exported document
8093 * Table of contents:: If, where, how to create a table of contents
8094 * Initial text:: Text before the first headline
8095 * Lists:: Plain lists are exported
8096 * Paragraphs:: What determines beginning and ending
8097 * Literal examples:: Source code and other examples
8098 * Include files:: Include the contents of a file during export
8099 * Tables exported:: Tables are exported richly
8100 * Inlined images:: How to inline images during export
8101 * Footnote markup:: ASCII representation of footnotes
8102 * Emphasis and monospace:: To bold or not to bold
8103 * TeX macros and LaTeX fragments:: Create special, rich export.
8104 * Horizontal rules:: A line across the page
8105 * Comment lines:: Some lines will not be exported
8106 * Macro replacement:: Global replacement of place holders
8109 @node Document title, Headings and sections, Markup rules, Markup rules
8110 @subheading Document title
8111 @cindex document title, markup rules
8114 The title of the exported document is taken from the special line
8118 #+TITLE: This is the title of the document
8122 If this line does not exist, the title is derived from the first non-empty,
8123 non-comment line in the buffer. If no such line exists, or if you have
8124 turned off exporting of the text before the first headline (see below), the
8125 title will be the file name without extension.
8127 @cindex property, EXPORT_TITLE
8128 If you are exporting only a subtree by marking is as the region, the heading
8129 of the subtree will become the title of the document. If the subtree has a
8130 property @code{EXPORT_TITLE}, that will take precedence.
8132 @node Headings and sections, Table of contents, Document title, Markup rules
8133 @subheading Headings and sections
8134 @cindex headings and sections, markup rules
8136 @vindex org-export-headline-levels
8137 The outline structure of the document as described in @ref{Document
8138 Structure}, forms the basis for defining sections of the exported document.
8139 However, since the outline structure is also used for (for example) lists of
8140 tasks, only the first three outline levels will be used as headings. Deeper
8141 levels will become itemized lists. You can change the location of this
8142 switch globally by setting the variable @code{org-export-headline-levels}, or on a
8143 per-file basis with a line
8150 @node Table of contents, Initial text, Headings and sections, Markup rules
8151 @subheading Table of contents
8152 @cindex table of contents, markup rules
8154 @vindex org-export-with-toc
8155 The table of contents is normally inserted directly before the first headline
8156 of the file. If you would like to get it to a different location, insert the
8157 string @code{[TABLE-OF-CONTENTS]} on a line by itself at the desired
8158 location. The depth of the table of contents is by default the same as the
8159 number of headline levels, but you can choose a smaller number, or turn off
8160 the table of contents entirely, by configuring the variable
8161 @code{org-export-with-toc}, or on a per-file basis with a line like
8164 #+OPTIONS: toc:2 (only to two levels in TOC)
8165 #+OPTIONS: toc:nil (no TOC at all)
8168 @node Initial text, Lists, Table of contents, Markup rules
8169 @subheading Text before the first headline
8170 @cindex text before first headline, markup rules
8173 Org mode normally exports the text before the first headline, and even uses
8174 the first line as the document title. The text will be fully marked up. If
8175 you need to include literal HTML, La@TeX{}, or DocBook code, use the special
8176 constructs described below in the sections for the individual exporters.
8178 @vindex org-export-skip-text-before-1st-heading
8179 Some people like to use the space before the first headline for setup and
8180 internal links and therefore would like to control the exported text before
8181 the first headline in a different way. You can do so by setting the variable
8182 @code{org-export-skip-text-before-1st-heading} to @code{t}. On a per-file
8183 basis, you can get the same effect with @samp{#+OPTIONS: skip:t}.
8186 If you still want to have some text before the first headline, use the
8187 @code{#+TEXT} construct:
8191 #+TEXT: This text will go before the *first* headline.
8192 #+TEXT: [TABLE-OF-CONTENTS]
8193 #+TEXT: This goes between the table of contents and the first headline
8196 @node Lists, Paragraphs, Initial text, Markup rules
8198 @cindex lists, markup rules
8200 Plain lists as described in @ref{Plain lists}, are translated to the backend's
8201 syntax for such lists. Most backends support unordered, ordered, and
8204 @node Paragraphs, Literal examples, Lists, Markup rules
8205 @subheading Paragraphs, line breaks, and quoting
8206 @cindex paragraphs, markup rules
8208 Paragraphs are separated by at least one empty line. If you need to enforce
8209 a line break within a paragraph, use @samp{\\} at the end of a line.
8211 To keep the line breaks in a region, but otherwise use normal formatting, you
8212 can use this construct, which can also be used to format poetry.
8214 @cindex #+BEGIN_VERSE
8217 Great clouds overhead
8218 Tiny black birds rise and fall
8225 When quoting a passage from another document, it is customary to format this
8226 as a paragraph that is indented on both the left and the right margin. You
8227 can include quotations in Org-mode documents like this:
8229 @cindex #+BEGIN_QUOTE
8232 Everything should be made as simple as possible,
8233 but not any simpler -- Albert Einstein
8237 If you would like to center some text, do it like this:
8238 @cindex #+BEGIN_CENTER
8241 Everything should be made as simple as possible, \\
8246 @node Literal examples, Include files, Paragraphs, Markup rules
8247 @subheading Literal examples
8248 @cindex literal examples, markup rules
8249 @cindex code line references, markup rules
8251 You can include literal examples that should not be subjected to
8252 markup. Such examples will be typeset in monospace, so this is well suited
8253 for source code and similar examples.
8254 @cindex #+BEGIN_EXAMPLE
8258 Some example from a text file.
8262 Note that such blocks may be @i{indented} in order to align nicely with
8263 indented text and in particular with plain list structure (@pxref{Plain
8264 lists}). For simplicity when using small examples, you can also start the
8265 example lines with a colon followed by a space. There may also be additional
8266 whitespace before the colon:
8270 : Some example from a text file.
8273 @cindex formatting source code, markup rules
8274 If the example is source code from a programming language, or any other text
8275 that can be marked up by font-lock in Emacs, you can ask for the example to
8276 look like the fontified Emacs buffer@footnote{Currently this works for the
8277 HTML backend, and requires the @file{htmlize.el} package version 1.34 or
8278 later. It also works for LaTeX with the listings package, if you turn on the
8279 option @code{org-export-latex-listings} and make sure that the listings
8280 package is included by the LaTeX header.}. This is done with the @samp{src}
8281 block, where you also need to specify the name of the major mode that should
8282 be used to fontify the example:
8286 #+BEGIN_SRC emacs-lisp
8287 (defun org-xor (a b)
8293 Both in @code{example} and in @code{src} snippets, you can add a @code{-n}
8294 switch to the end of the @code{BEGIN} line, to get the lines of the example
8295 numbered. If you use a @code{+n} switch, the numbering from the previous
8296 numbered snippet will be continued in the current one. In literal examples,
8297 Org will interpret strings like @samp{(ref:name)} as labels, and use them as
8298 targets for special hyperlinks like @code{[[(name)]]} (@ie the reference name
8299 enclosed in single parenthesis). In HTML, hovering the mouse over such a
8300 link will remote-highlight the corresponding code line, which is kind of
8303 You can also add a @code{-r} switch which @i{removes} the labels from the
8304 source code@footnote{Adding @code{-k} to @code{-n -r} will @i{keep} the
8305 labels in the source code while using line numbers for the links, which might
8306 be useful to explain those in an org-mode example code.}. With the @code{-n}
8307 switch, links to these references will be labeled by the line numbers from
8308 the code listing, otherwise links will use the labels with no parentheses.
8312 #+BEGIN_SRC emacs-lisp -n -r
8313 (save-excursion (ref:sc)
8314 (goto-char (point-min)) (ref:jump)
8316 In line [[(sc)]] we remember the current position. [[(jump)][Line (jump)]]
8320 @vindex org-coderef-label-format
8321 If the syntax for the label format conflicts with the language syntax, use a
8322 @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
8323 -n -r -l "((%s))"}. See also the variable @code{org-coderef-label-format}.
8325 HTML export also allows examples to be published as text areas, @xref{Text
8326 areas in HTML export}.
8331 Edit the source code example at point in its native mode. This works by
8332 switching to a temporary buffer with the source code. You need to exit by
8333 pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*}
8334 or @samp{#} will get a comma prepended, to keep them from being interpreted
8335 by Org as outline nodes or special comments. These commas will be striped
8336 for editing with @kbd{C-c '}, and also for export.}, the edited version will
8337 then replace the old version in the Org buffer. Fixed-width regions
8338 (where each line starts with a colon followed by a space) will be edited
8339 using @code{artist-mode}@footnote{You may select a different-mode with the
8340 variable @code{org-edit-fixed-width-region-mode}.} to allow creating ASCII
8341 drawings easily. Using this command in an empty line will create a new
8345 Calling @code{org-store-link} while editing a source code example in a
8346 temporary buffer created with @kbd{C-c '} will prompt for a label, make sure
8347 that it is unique in the current buffer, and insert it with the proper
8348 formatting like @samp{(ref:label)} at the end of the current line. Then the
8349 label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
8353 @node Include files, Tables exported, Literal examples, Markup rules
8354 @subheading Include files
8355 @cindex include files, markup rules
8357 During export, you can include the content of another file. For example, to
8358 include your @file{.emacs} file, you could use:
8362 #+INCLUDE: "~/.emacs" src emacs-lisp
8365 The optional second and third parameter are the markup (e.g. @samp{quote},
8366 @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the
8367 language for formatting the contents. The markup is optional, if it is not
8368 given, the text will be assumed to be in Org mode format and will be
8369 processed normally. The include line will also allow additional keyword
8370 parameters @code{:prefix1} and @code{:prefix} to specify prefixes for the
8371 first line and for each following line, as well as any options accepted by
8372 the selected markup. For example, to include a file as an item, use
8375 #+INCLUDE: "~/snippets/xx" :prefix1 " + " :prefix " "
8381 Visit the include file at point.
8384 @node Tables exported, Inlined images, Include files, Markup rules
8386 @cindex tables, markup rules
8388 Both the native Org mode tables (@pxref{Tables}) and tables formatted with
8389 the @file{table.el} package will be exported properly. For Org mode tables,
8390 the lines before the first horizontal separator line will become table header
8391 lines. You can use the following lines somewhere before the table to assign
8392 a caption and a label for cross references:
8395 #+CAPTION: This is the caption for the next table (or link)
8396 #+LABEL: tbl:basic-data
8399 @node Inlined images, Footnote markup, Tables exported, Markup rules
8400 @subheading Inlined Images
8401 @cindex inlined images, markup rules
8403 Some backends (HTML, La@TeX{}, and DocBook) allow you to directly include images
8404 into the exported document. Org does this, if a link to an image files does
8405 not have a description part, for example @code{[[./img/a.jpg]]}. If you wish
8406 to define a caption for the image and maybe a label for internal cross
8407 references, you can use (before, but close to the link)
8410 #+CAPTION: This is the caption for the next figure link (or table)
8411 #+LABEL: fig:SED-HR4049
8414 You may also define additional attributes for the figure. As this is
8415 backend-specific, see the sections about the individual backends for more
8418 @node Footnote markup, Emphasis and monospace, Inlined images, Markup rules
8419 @subheading Footnote markup
8420 @cindex footnotes, markup rules
8421 @cindex @file{footnote.el}
8423 Footnotes defined in the way described in @ref{Footnotes}, will be exported by
8424 all backends. Org allows multiple references to the same note, and
8425 different backends support this to varying degrees.
8427 @node Emphasis and monospace, TeX macros and LaTeX fragments, Footnote markup, Markup rules
8428 @subheading Emphasis and monospace
8430 @cindex underlined text, markup rules
8431 @cindex bold text, markup rules
8432 @cindex italic text, markup rules
8433 @cindex verbatim text, markup rules
8434 @cindex code text, markup rules
8435 @cindex strike-through text, markup rules
8436 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=}
8437 and @code{~verbatim~}, and, if you must, @samp{+strike-through+}. Text
8438 in the code and verbatim string is not processed for Org-mode specific
8439 syntax, it is exported verbatim.
8441 @node TeX macros and LaTeX fragments, Horizontal rules, Emphasis and monospace, Markup rules
8442 @subheading @TeX{} macros and La@TeX{} fragments
8443 @cindex La@TeX{} fragments, markup rules
8444 @cindex @TeX{} macros, markup rules
8445 @cindex HTML entities
8446 @cindex La@TeX{} entities
8448 @vindex org-html-entities
8449 A @TeX{}-like syntax is used to specify special characters. Where possible,
8450 these will be transformed into the native format of the exporter backend.
8451 Strings like @code{\alpha} will be exported as @code{α} in the HTML
8452 output, and as @code{$\alpha$} in the La@TeX{} output. Similarly,
8453 @code{\nbsp} will become @code{ } in HTML and @code{~} in La@TeX{}.
8454 This applies for a large number of entities, with names taken from both HTML
8455 and La@TeX{}, see the variable @code{org-html-entities} for the complete
8456 list. If you are unsure about a name, use @kbd{M-@key{TAB}} for completion
8457 after having typed the backslash and optionally a few characters
8458 (@pxref{Completion}).
8460 La@TeX{} fragments are converted into images for HTML export, and they are
8461 written literally into the La@TeX{} export. See also @ref{Embedded LaTeX}.
8463 Finally, @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
8464 @samp{...} are all converted into special commands creating hyphens of
8465 different lengths or a compact set of dots.
8467 @node Horizontal rules, Comment lines, TeX macros and LaTeX fragments, Markup rules
8468 @subheading Horizontal rules
8469 @cindex horizontal rules, markup rules
8470 A line consisting of only dashes, and at least 5 of them, will be
8471 exported as a horizontal line (@samp{<hr/>} in HTML).
8473 @node Comment lines, Macro replacement, Horizontal rules, Markup rules
8474 @subheading Comment lines
8475 @cindex comment lines
8476 @cindex exporting, not
8477 @cindex #+BEGIN_COMMENT
8479 Lines starting with @samp{#} in column zero are treated as comments and will
8480 never be exported. If you want an indented line to be treated as a comment,
8481 start it with @samp{#+ }. Also entire subtrees starting with the word
8482 @samp{COMMENT} will never be exported. Finally, regions surrounded by
8483 @samp{#+BEGIN_COMMENT} ... @samp{#+END_COMMENT} will not be exported.
8488 Toggle the COMMENT keyword at the beginning of an entry.
8491 @node Macro replacement, , Comment lines, Markup rules
8492 @subheading Macro replacement
8493 @cindex macro replacement, during export
8496 You can define text snippets with
8499 #+MACRO: name replacement text $1, $2 are arguments
8502 @noindent which can be referenced anywhere in the document (even in
8503 code examples) with @code{@{@{@{name(arg1,arg2)@}@}@}}. In addition to
8504 defined macros, @code{@{@{@{title@}@}@}}, @code{@{@{@{author@}@}@}}, etc.,
8505 will reference information set by the @code{#+TITLE:}, @code{#+AUTHOR:}, and
8506 similar lines. Also, @code{@{@{@{date(@var{FORMAT})@}@}@}} and
8507 @code{@{@{@{modification-time(@var{FORMAT})@}@}@}} refer to current date time
8508 and to the modification time of the file being exported, respectively.
8509 @var{FORMAT} should be a format string understood by
8510 @code{format-time-string}.
8512 @node Selective export, Export options, Markup rules, Exporting
8513 @section Selective export
8514 @cindex export, selective by tags
8516 @vindex org-export-select-tags
8517 @vindex org-export-exclude-tags
8518 You may use tags to select the parts of a document that should be exported,
8519 or to exclude parts from export. This behavior is governed by two variables:
8520 @code{org-export-select-tags} and @code{org-export-exclude-tags}.
8522 Org first checks if any of the @emph{select} tags is present in the buffer.
8523 If yes, all trees that do not carry one of these tags will be excluded. If a
8524 selected tree is a subtree, the heading hierarchy above it will also be
8525 selected for export, but not the text below those headings.
8528 If none of the select tags is found, the whole buffer will be selected for
8532 Finally, all subtrees that are marked by any of the @emph{exclude} tags will
8533 be removed from the export buffer.
8535 @node Export options, The export dispatcher, Selective export, Exporting
8536 @section Export options
8537 @cindex options, for export
8539 @cindex completion, of option keywords
8540 The exporter recognizes special lines in the buffer which provide
8541 additional information. These lines may be put anywhere in the file.
8542 The whole set of lines can be inserted into the buffer with @kbd{C-c
8543 C-e t}. For individual lines, a good way to make sure the keyword is
8544 correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion
8545 (@pxref{Completion}). For a summary of other in-buffer settings not
8546 specifically related to export, see @ref{In-buffer settings}.
8547 In particular, note that you can place commonly-used (export) options in
8548 a separate file which can be included using @code{#+SETUPFILE}.
8553 Insert template with export options, see example below.
8560 @cindex #+DESCRIPTION
8568 @cindex #+EXPORT_SELECT_TAGS
8569 @cindex #+EXPORT_EXCLUDE_TAGS
8570 @cindex #+LATEX_HEADER
8571 @vindex user-full-name
8572 @vindex user-mail-address
8573 @vindex org-export-default-language
8575 #+TITLE: the title to be shown (default is the buffer name)
8576 #+AUTHOR: the author (default taken from @code{user-full-name})
8577 #+DATE: a date, fixed, of a format string for @code{format-time-string}
8578 #+EMAIL: his/her email address (default from @code{user-mail-address})
8579 #+DESCRIPTION: the page description, @eg for the XHTML meta tag
8580 #+KEYWORDS: the page keywords, @eg for the XHTML meta tag
8581 #+LANGUAGE: language for HTML, @eg @samp{en} (@code{org-export-default-language})
8582 #+TEXT: Some descriptive text to be inserted at the beginning.
8583 #+TEXT: Several lines may be given.
8584 #+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ...
8585 #+BIND: lisp-var lisp-val, e.g.: org-export-latex-low-levels itemize
8586 @r{You need to confirm using these, or configure @code{org-export-allow-BIND}}
8587 #+LINK_UP: the ``up'' link of an exported page
8588 #+LINK_HOME: the ``home'' link of an exported page
8589 #+LATEX_HEADER: extra line(s) for the LaTeX header, like \usepackage@{xyz@}
8590 #+EXPORT_SELECT_TAGS: Tags that select a tree for export
8591 #+EXPORT_EXCLUDE_TAGS: Tags that exclude a tree from export
8595 The OPTIONS line is a compact@footnote{If you want to configure many options
8596 this way, you can use several OPTIONS lines.} form to specify export settings. Here
8598 @cindex headline levels
8599 @cindex section-numbers
8600 @cindex table of contents
8601 @cindex line-break preservation
8602 @cindex quoted HTML tags
8603 @cindex fixed-width sections
8605 @cindex @TeX{}-like syntax for sub- and superscripts
8607 @cindex special strings
8608 @cindex emphasized text
8609 @cindex @TeX{} macros
8610 @cindex La@TeX{} fragments
8611 @cindex author info, in export
8612 @cindex time info, in export
8614 H: @r{set the number of headline levels for export}
8615 num: @r{turn on/off section-numbers}
8616 toc: @r{turn on/off table of contents, or set level limit (integer)}
8617 \n: @r{turn on/off line-break-preservation}
8618 @@: @r{turn on/off quoted HTML tags}
8619 :: @r{turn on/off fixed-width sections}
8620 |: @r{turn on/off tables}
8621 ^: @r{turn on/off @TeX{}-like syntax for sub- and superscripts. If}
8622 @r{you write "^:@{@}", @code{a_@{b@}} will be interpreted, but}
8623 @r{the simple @code{a_b} will be left as it is.}
8624 -: @r{turn on/off conversion of special strings.}
8625 f: @r{turn on/off footnotes like this[1].}
8626 todo: @r{turn on/off inclusion of TODO keywords into exported text}
8627 pri: @r{turn on/off priority cookies}
8628 tags: @r{turn on/off inclusion of tags, may also be @code{not-in-toc}}
8629 <: @r{turn on/off inclusion of any time/date stamps like DEADLINES}
8630 *: @r{turn on/off emphasized text (bold, italic, underlined)}
8631 TeX: @r{turn on/off simple @TeX{} macros in plain text}
8632 LaTeX: @r{turn on/off La@TeX{} fragments}
8633 skip: @r{turn on/off skipping the text before the first heading}
8634 author: @r{turn on/off inclusion of author name/email into exported file}
8635 creator: @r{turn on/off inclusion of creator info into exported file}
8636 timestamp: @r{turn on/off inclusion creation time into exported file}
8637 d: @r{turn on/off inclusion of drawers}
8640 These options take effect in both the HTML and La@TeX{} export, except
8641 for @code{TeX} and @code{LaTeX}, which are respectively @code{t} and
8642 @code{nil} for the La@TeX{} export.
8644 When exporting only a single subtree by selecting it with @kbd{C-c @@} before
8645 calling an export command, the subtree can overrule some of the file's export
8646 settings with properties @code{EXPORT_FILE_NAME}, @code{EXPORT_TITLE},
8647 @code{EXPORT_TEXT}, @code{EXPORT_AUTHOR}, @code{EXPORT_DATE}, and
8648 @code{EXPORT_OPTIONS}.
8650 @node The export dispatcher, ASCII export, Export options, Exporting
8651 @section The export dispatcher
8652 @cindex dispatcher, for export commands
8654 All export commands can be reached using the export dispatcher, which is a
8655 prefix key that prompts for an additional key specifying the command.
8656 Normally the entire file is exported, but if there is an active region that
8657 contains one outline tree, the first heading is used as document title and
8658 the subtrees are exported.
8663 @vindex org-export-run-in-background
8664 Dispatcher for export and publishing commands. Displays a help-window
8665 listing the additional key(s) needed to launch an export or publishing
8666 command. The prefix arg is passed through to the exporter. A double prefix
8667 @kbd{C-u C-u} causes most commands to be executed in the background, in a
8668 separate Emacs process@footnote{To make this behavior the default, customize
8669 the variable @code{org-export-run-in-background}.}.
8672 Like @kbd{C-c C-e}, but only export the text that is currently visible
8673 (@ie not hidden by outline visibility).
8674 @kindex C-u C-u C-c C-e
8675 @item C-u C-u C-c C-e
8676 @vindex org-export-run-in-background
8677 Call an the exporter, but reverse the setting of
8678 @code{org-export-run-in-background}, @ie request background processing if
8679 not set, or force processing in the current Emacs process if set.
8682 @node ASCII export, HTML export, The export dispatcher, Exporting
8683 @section ASCII export
8684 @cindex ASCII export
8686 ASCII export produces a simple and very readable version of an Org-mode
8689 @cindex region, active
8690 @cindex active region
8691 @cindex transient-mark-mode
8695 @cindex property, EXPORT_FILE_NAME
8696 Export as ASCII file. For an Org file, @file{myfile.org}, the ASCII file
8697 will be @file{myfile.txt}. The file will be overwritten without
8698 warning. If there is an active region@footnote{This requires
8699 @code{transient-mark-mode} be turned on.}, only the region will be
8700 exported. If the selected region is a single tree@footnote{To select the
8701 current subtree, use @kbd{C-c @@}.}, the tree head will
8702 become the document title. If the tree head entry has or inherits an
8703 @code{EXPORT_FILE_NAME} property, that name will be used for the
8707 Export to a temporary buffer, do not create a file.
8710 Export only the visible part of the document.
8713 @cindex headline levels, for exporting
8714 In the exported version, the first 3 outline levels will become
8715 headlines, defining a general document structure. Additional levels
8716 will be exported as itemized lists. If you want that transition to occur
8717 at a different level, specify it with a prefix argument. For example,
8724 creates only top level headlines and does the rest as items. When
8725 headlines are converted to items, the indentation of the text following
8726 the headline is changed to fit nicely under the item. This is done with
8727 the assumption that the first body line indicates the base indentation of
8728 the body text. Any indentation larger than this is adjusted to preserve
8729 the layout relative to the first line. Should there be lines with less
8730 indentation than the first, these are left alone.
8732 @vindex org-export-ascii-links-to-notes
8733 Links will be exported in a footnote-like style, with the descriptive part in
8734 the text and the link in a note before the next heading. See the variable
8735 @code{org-export-ascii-links-to-notes} for details and other options.
8737 @node HTML export, LaTeX and PDF export, ASCII export, Exporting
8738 @section HTML export
8741 Org mode contains an HTML (XHTML 1.0 strict) exporter with extensive
8742 HTML formatting, in ways similar to John Gruber's @emph{markdown}
8743 language, but with additional support for tables.
8746 * HTML Export commands:: How to invoke HTML export
8747 * Quoting HTML tags:: Using direct HTML in Org mode
8748 * Links:: Transformation of links for HTML
8749 * Tables in HTML export:: How to modify the formatting of tables
8750 * Images in HTML export:: How to insert figures into HTML output
8751 * Text areas in HTML export:: An alternative way to show an example
8752 * CSS support:: Changing the appearance of the output
8753 * Javascript support:: Info and Folding in a web browser
8756 @node HTML Export commands, Quoting HTML tags, HTML export, HTML export
8757 @subsection HTML export commands
8759 @cindex region, active
8760 @cindex active region
8761 @cindex transient-mark-mode
8765 @cindex property, EXPORT_FILE_NAME
8766 Export as HTML file @file{myfile.html}. For an Org file @file{myfile.org},
8767 the ASCII file will be @file{myfile.html}. The file will be overwritten
8768 without warning. If there is an active region@footnote{This requires
8769 @code{transient-mark-mode} be turned on.}, only the region will be
8770 exported. If the selected region is a single tree@footnote{To select the
8771 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
8772 title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
8773 property, that name will be used for the export.
8776 Export as HTML file and immediately open it with a browser.
8779 Export to a temporary buffer, do not create a file.
8782 Export the active region to a temporary buffer. With a prefix argument, do
8783 not produce the file header and footer, but just the plain HTML section for
8784 the region. This is good for cut-and-paste operations.
8793 Export only the visible part of the document.
8794 @item M-x org-export-region-as-html
8795 Convert the region to HTML under the assumption that it was Org-mode
8796 syntax before. This is a global command that can be invoked in any
8798 @item M-x org-replace-region-by-HTML
8799 Replace the active region (assumed to be in Org-mode syntax) by HTML
8803 @cindex headline levels, for exporting
8804 In the exported version, the first 3 outline levels will become headlines,
8805 defining a general document structure. Additional levels will be exported as
8806 itemized lists. If you want that transition to occur at a different level,
8807 specify it with a numeric prefix argument. For example,
8814 creates two levels of headings and does the rest as items.
8816 @node Quoting HTML tags, Links, HTML Export commands, HTML export
8817 @subsection Quoting HTML tags
8819 Plain @samp{<} and @samp{>} are always transformed to @samp{<} and
8820 @samp{>} in HTML export. If you want to include simple HTML tags
8821 which should be interpreted as such, mark them with @samp{@@} as in
8822 @samp{@@<b>bold text@@</b>}. Note that this really works only for
8823 simple tags. For more extensive HTML that should be copied verbatim to
8824 the exported file use either
8827 @cindex #+BEGIN_HTML
8829 #+HTML: Literal HTML code for export
8833 @cindex #+BEGIN_HTML
8837 All lines between these markers are exported literally
8842 @node Links, Tables in HTML export, Quoting HTML tags, HTML export
8845 @cindex links, in HTML export
8846 @cindex internal links, in HTML export
8847 @cindex external links, in HTML export
8848 Internal links (@pxref{Internal links}) will continue to work in HTML. This
8849 includes automatic links created by radio targets (@pxref{Radio
8850 targets}). Links to external files will still work if the target file is on
8851 the same @i{relative} path as the published Org file. Links to other
8852 @file{.org} files will be translated into HTML links under the assumption
8853 that an HTML version also exists of the linked file, at the same relative
8854 path. @samp{id:} links can then be used to jump to specific entries across
8855 files. For information related to linking files while publishing them to a
8856 publishing directory see @ref{Publishing links}.
8858 If you want to specify attributes for links, you can do so using a special
8859 @code{#+ATTR_HTML} line to define attributes that will be added to the
8860 @code{<a>} or @code{<img>} tags. Here is an example that sets @code{title}
8861 and @code{style} attributes for a link:
8865 #+ATTR_HTML: title="The Org-mode homepage" style="color:red;"
8866 [[http://orgmode.org]]
8869 @node Tables in HTML export, Images in HTML export, Links, HTML export
8871 @cindex tables, in HTML
8872 @vindex org-export-html-table-tag
8874 Org-mode tables are exported to HTML using the table tag defined in
8875 @code{org-export-html-table-tag}. The default setting makes tables without
8876 cell borders and frame. If you would like to change this for individual
8877 tables, place somthing like the following before the table:
8881 #+CAPTION: This is a table with lines around and between cells
8882 #+ATTR_HTML: border="2" rules="all" frame="all"
8885 @node Images in HTML export, Text areas in HTML export, Tables in HTML export, HTML export
8888 @cindex images, inline in HTML
8889 @cindex inlining images in HTML
8890 @vindex org-export-html-inline-images
8891 HTML export can inline images given as links in the Org file, and
8892 it can make an image the clickable part of a link. By
8893 default@footnote{But see the variable
8894 @code{org-export-html-inline-images}.}, images are inlined if a link does
8895 not have a description. So @samp{[[file:myimg.jpg]]} will be inlined,
8896 while @samp{[[file:myimg.jpg][the image]]} will just produce a link
8897 @samp{the image} that points to the image. If the description part
8898 itself is a @code{file:} link or a @code{http:} URL pointing to an
8899 image, this image will be inlined and activated so that clicking on the
8900 image will activate the link. For example, to include a thumbnail that
8901 will link to a high resolution version of the image, you could use:
8904 [[file:highres.jpg][file:thumb.jpg]]
8907 If you need to add attributes to an inlines image, use a @code{#+ATTR_HTML},
8912 #+CAPTION: A black cat stalking a spider
8913 #+ATTR_HTML: alt="cat/spider image" title="one second before action"
8918 and you could use @code{http} addresses just as well.
8920 @node Text areas in HTML export, CSS support, Images in HTML export, HTML export
8921 @subsection Text areas
8923 @cindex text areas, in HTML
8924 An alternative way to publish literal code examples in HTML is to use text
8925 areas, where the example can even be edited before pasting it into an
8926 application. It is triggered by a @code{-t} switch at an @code{example} or
8927 @code{src} block. Using this switch disables any options for syntax and
8928 label highlighting, and line numbering, which may be present. You may also
8929 use @code{-h} and @code{-w} switches to specify the height and width of the
8930 text area, which default to the number of lines in the example, and 80,
8931 respectively. For example
8934 #+BEGIN_EXAMPLE -t -w 40
8935 (defun org-xor (a b)
8942 @node CSS support, Javascript support, Text areas in HTML export, HTML export
8943 @subsection CSS support
8944 @cindex CSS, for HTML export
8945 @cindex HTML export, CSS
8947 @vindex org-export-html-todo-kwd-class-prefix
8948 @vindex org-export-html-tag-class-prefix
8949 You can also give style information for the exported file. The HTML exporter
8950 assigns the following special CSS classes@footnote{If the classes on TODO
8951 keywords and tags lead to conflicts, use the variables
8952 @code{org-export-html-todo-kwd-class-prefix} and
8953 @code{org-export-html-tag-class-prefix} to make them unique.} to appropriate
8954 parts of the document---your style specifications may change these, in
8955 addition to any of the standard classes like for headlines, tables, etc.
8957 p.author @r{author information, including email}
8958 p.date @r{publishing date}
8959 p.creator @r{creator info, about org-mode version}
8960 .title @r{document title}
8961 .todo @r{TODO keywords, all not-done states}
8962 .done @r{the DONE keywords, all stated the count as done}
8963 .WAITING @r{each TODO keyword also uses a class named after itself}
8964 .timestamp @r{timestamp}
8965 .timestamp-kwd @r{keyword associated with a timestamp, like SCHEDULED}
8966 .timestamp-wrapper @r{span around keyword plus timestamp}
8967 .tag @r{tag in a headline}
8968 ._HOME @r{each tag uses itself as a class, "@@" replaced by "_"}
8969 .target @r{target for links}
8970 .linenr @r{the line number in a code example}
8971 .code-highlighted @r{for highlighting referenced code lines}
8972 div.outline-N @r{div for outline level N (headline plus text))}
8973 div.outline-text-N @r{extra div for text at outline level N}
8974 .section-number-N @r{section number in headlines, different for each level}
8975 div.figure @r{how to format an inlined image}
8976 pre.src @r{formatted source code}
8977 pre.example @r{normal example}
8978 p.verse @r{verse paragraph}
8979 div.footnotes @r{footnote section headline}
8980 p.footnote @r{footnote definition paragraph, containing a footnote}
8981 .footref @r{a footnote reference number (always a <sup>)}
8982 .footnum @r{footnote number in footnote definition (always <sup>)}
8985 @vindex org-export-html-style-default
8986 @vindex org-export-html-style-include-default
8987 @vindex org-export-html-style
8988 @vindex org-export-html-extra
8989 @vindex org-export-html-style-default
8990 Each exported file contains a compact default style that defines these
8991 classes in a basic way@footnote{This style is defined in the constant
8992 @code{org-export-html-style-default}, which you should not modify. To turn
8993 inclusion of these defaults off, customize
8994 @code{org-export-html-style-include-default}}. You may overwrite these
8995 settings, or add to them by using the variables @code{org-export-html-style}
8996 (for Org-wide settings) and @code{org-export-html-style-extra} (for more
8997 granular settings, like file-local settings). To set the latter variable
8998 individually for each file, you can use
9002 #+STYLE: <link rel="stylesheet" type="text/css" href="stylesheet.css" />
9006 For longer style definitions, you can use several such lines. You could also
9007 directly write a @code{<style>} @code{</style>} section in this way, without
9008 referring to an external file.
9010 @c FIXME: More about header and footer styles
9011 @c FIXME: Talk about links and targets.
9013 @node Javascript support, , CSS support, HTML export
9014 @subsection Javascript supported display of web pages
9016 @cindex Rose, Sebastian
9017 Sebastian Rose has written a JavaScript program especially designed to
9018 enhance the web viewing experience of HTML files created with Org. This
9019 program allows you to view large files in two different ways. The first one
9020 is an @emph{Info}-like mode where each section is displayed separately and
9021 navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
9022 as well, press @kbd{?} for an overview of the available keys). The second
9023 view type is a @emph{folding} view much like Org provides inside Emacs. The
9024 script is available at @url{http://orgmode.org/org-info.js} and you can find
9025 the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
9026 We host the script at our site, but if you use it a lot, you might
9027 not want to be dependent on @url{orgmode.org} and prefer to install a local
9028 copy on your own web server.
9030 To use the script, you need to make sure that the @file{org-jsinfo.el} module
9031 gets loaded. It should be loaded by default, but you can try @kbd{M-x
9032 customize-variable @key{RET} org-modules @key{RET}} to convince yourself that
9033 this is indeed the case. All it then takes to make use of the program is
9034 adding a single line to the Org file:
9036 @cindex #+INFOJS_OPT
9038 #+INFOJS_OPT: view:info toc:nil
9042 If this line is found, the HTML header will automatically contain the code
9043 needed to invoke the script. Using the line above, you can set the following
9047 path: @r{The path to the script. The default is to grab the script from}
9048 @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
9049 @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
9050 view: @r{Initial view when website is first shown. Possible values are:}
9051 info @r{Info-like interface with one section per page.}
9052 overview @r{Folding interface, initially showing only top-level.}
9053 content @r{Folding interface, starting with all headlines visible.}
9054 showall @r{Folding interface, all headlines and text visible.}
9055 sdepth: @r{Maximum headline level that will still become an independent}
9056 @r{section for info and folding modes. The default is taken from}
9057 @r{@code{org-export-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
9058 @r{If this is smaller than in @code{org-export-headline-levels}, each}
9059 @r{info/folding section can still contain child headlines.}
9060 toc: @r{Should the table of content @emph{initially} be visible?}
9061 @r{Even when @code{nil}, you can always get to the "toc" with @kbd{i}.}
9062 tdepth: @r{The depth of the table of contents. The defaults are taken from}
9063 @r{the variables @code{org-export-headline-levels} and @code{org-export-with-toc}.}
9064 ftoc: @r{Does the css of the page specify a fixed position for the "toc"?}
9065 @r{If yes, the toc will never be displayed as a section.}
9066 ltoc: @r{Should there be short contents (children) in each section?}
9067 @r{Make this @code{above} if the section should be above initial text.}
9068 mouse: @r{Headings are highlighted when the mouse is over them. Should be}
9069 @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
9070 buttons: @r{Should view-toggle buttons be everywhere? When @code{nil} (the}
9071 @r{default), only one such button will be present.}
9074 @vindex org-infojs-options
9075 @vindex org-export-html-use-infojs
9076 You can choose default values for these options by customizing the variable
9077 @code{org-infojs-options}. If you always want to apply the script to your
9078 pages, configure the variable @code{org-export-html-use-infojs}.
9080 @node LaTeX and PDF export, DocBook export, HTML export, Exporting
9081 @section La@TeX{} and PDF export
9082 @cindex La@TeX{} export
9084 @cindex Guerry, Bastian
9086 Org mode contains a La@TeX{} exporter written by Bastien Guerry. With
9087 further processing, this backend is also used to produce PDF output. Since
9088 the La@TeX{} output uses @file{hyperref} to implement links and cross
9089 references, the PDF output file will be fully linked.
9092 * LaTeX/PDF export commands:: Which key invokes which commands
9093 * Quoting LaTeX code:: Incorporating literal La@TeX{} code
9094 * Sectioning structure:: Changing sectioning in La@TeX{} output
9095 * Tables in LaTeX export:: Options for exporting tables to La@TeX{}
9096 * Images in LaTeX export:: How to insert figures into La@TeX{} output
9099 @node LaTeX/PDF export commands, Quoting LaTeX code, LaTeX and PDF export, LaTeX and PDF export
9100 @subsection La@TeX{} export commands
9102 @cindex region, active
9103 @cindex active region
9104 @cindex transient-mark-mode
9108 @cindex property EXPORT_FILE_NAME
9109 Export as La@TeX{} file @file{myfile.tex}. For an Org file
9110 @file{myfile.org}, the ASCII file will be @file{myfile.tex}. The file will
9111 be overwritten without warning. If there is an active region@footnote{This
9112 requires @code{transient-mark-mode} be turned on.}, only the region will be
9113 exported. If the selected region is a single tree@footnote{To select the
9114 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
9115 title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME}
9116 property, that name will be used for the export.
9119 Export to a temporary buffer, do not create a file.
9124 Export only the visible part of the document.
9125 @item M-x org-export-region-as-latex
9126 Convert the region to La@TeX{} under the assumption that it was Org mode
9127 syntax before. This is a global command that can be invoked in any
9129 @item M-x org-replace-region-by-latex
9130 Replace the active region (assumed to be in Org mode syntax) by La@TeX{}
9134 Export as La@TeX{} and then process to PDF.
9137 Export as La@TeX{} and then process to PDF, then open the resulting PDF file.
9140 @cindex headline levels, for exporting
9141 @vindex org-latex-low-levels
9142 In the exported version, the first 3 outline levels will become
9143 headlines, defining a general document structure. Additional levels
9144 will be exported as description lists. The exporter can ignore them or
9145 convert them to a custom string depending on
9146 @code{org-latex-low-levels}.
9148 If you want that transition to occur at a different level, specify it
9149 with a numeric prefix argument. For example,
9156 creates two levels of headings and does the rest as items.
9158 @node Quoting LaTeX code, Sectioning structure, LaTeX/PDF export commands, LaTeX and PDF export
9159 @subsection Quoting La@TeX{} code
9161 Embedded La@TeX{} as described in @ref{Embedded LaTeX}, will be correctly
9162 inserted into the La@TeX{} file. This includes simple macros like
9163 @samp{\ref@{LABEL@}} to create a cross reference to a figure. Furthermore,
9164 you can add special code that should only be present in La@TeX{} export with
9165 the following constructs:
9168 @cindex #+BEGIN_LaTeX
9170 #+LaTeX: Literal LaTeX code for export
9174 @cindex #+BEGIN_LaTeX
9178 All lines between these markers are exported literally
9182 @node Sectioning structure, Tables in LaTeX export, Quoting LaTeX code, LaTeX and PDF export
9183 @subsection Sectioning structure
9184 @cindex La@TeX{} class
9185 @cindex La@TeX{} sectioning structure
9187 By default, the La@TeX{} output uses the class @code{article}.
9189 @vindex org-export-latex-default-class
9190 @vindex org-export-latex-classes
9191 @cindex #+LATEX_HEADER
9192 @cindex #+LATEX_CLASS
9193 @cindex property, LATEX_CLASS
9194 You can change this globally by setting a different value for
9195 @code{org-export-latex-default-class} or locally by adding an option like
9196 @code{#+LaTeX_CLASS: myclass} in your file, or with a @code{:LaTeX_CLASS:}
9197 property that applies when exporting a region containing only this (sub)tree.
9198 The class should be listed in @code{org-export-latex-classes}, where you can
9199 also define the sectioning structure for each class, as well as defining
9200 additional classes. You can also use @code{#+LATEX_HEADER:
9201 \usepackage@{xyz@}} to add lines to the header.
9203 @node Tables in LaTeX export, Images in LaTeX export, Sectioning structure, LaTeX and PDF export
9204 @subsection Tables in La@TeX{} export
9205 @cindex tables, in La@TeX{} export
9207 For La@TeX{} export of a table, you can specify a label and a caption
9208 (@pxref{Markup rules}). You can also use the @code{ATTR_LaTeX} line to
9209 request a longtable environment for the table, so that it may span several
9210 pages. Finally, you can set the alignment string:
9214 @cindex #+ATTR_LaTeX
9216 #+CAPTION: A long table
9218 #+ATTR_LaTeX: longtable align=l|lp@{3cm@}r|l
9224 @node Images in LaTeX export, , Tables in LaTeX export, LaTeX and PDF export
9225 @subsection Images in La@TeX{} export
9226 @cindex images, inline in La@TeX{}
9227 @cindex inlining images in La@TeX{}
9229 Images that are linked to without a description part in the link, like
9230 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
9231 output files resulting from La@TeX{} output. Org will use an
9232 @code{\includegraphics} macro to insert the image. If you have specified a
9233 caption and/or a label as described in @ref{Markup rules}, the figure will
9234 be wrapped into a @code{figure} environment and thus become a floating
9235 element. Finally, you can use an @code{#+ATTR_LaTeX:} line to specify the
9236 options that can be used in the optional argument of the
9237 @code{\includegraphics} macro.
9241 @cindex #+ATTR_LaTeX
9243 #+CAPTION: The black-body emission of the disk around HR 4049
9244 #+LABEL: fig:SED-HR4049
9245 #+ATTR_LaTeX: width=5cm,angle=90
9246 [[./img/sed-hr4049.pdf]]
9249 @vindex org-export-latex-inline-image-extensions
9250 If you need references to a label created in this way, write
9251 @samp{\ref@{fig:SED-HR4049@}} just like in La@TeX{}. The default settings will
9252 recognize files types that can be included as images during processing by
9253 @command{pdflatex} (@file{png}, @file{jpg}, and @file{pdf} files). If you process your
9254 files in a different way, you may need to customize the variable
9255 @code{org-export-latex-inline-image-extensions}.
9257 @node DocBook export, XOXO export, LaTeX and PDF export, Exporting
9258 @section DocBook export
9259 @cindex DocBook export
9263 Org contains a DocBook exporter written by Baoqiu Cui. Once an Org file is
9264 exported to DocBook format, it can be further processed to produce other
9265 formats, including PDF, HTML, man pages, etc., using many available DocBook
9266 tools and stylesheets.
9268 Currently DocBook exporter only supports DocBook V5.0.
9271 * DocBook export commands:: How to invoke DocBook export
9272 * Quoting DocBook code:: Incorporating DocBook code in Org files
9273 * Recursive sections:: Recursive sections in DocBook
9274 * Tables in DocBook export:: Tables are exported as HTML tables
9275 * Images in DocBook export:: How to insert figures into DocBook output
9276 * Special characters:: How to handle special characters
9279 @node DocBook export commands, Quoting DocBook code, DocBook export, DocBook export
9280 @subsection DocBook export commands
9282 @cindex region, active
9283 @cindex active region
9284 @cindex transient-mark-mode
9288 @cindex property EXPORT_FILE_NAME
9289 Export as DocBook file. For an Org file, @file{myfile.org}, the DocBook XML
9290 file will be @file{myfile.xml}. The file will be overwritten without
9291 warning. If there is an active region@footnote{This requires
9292 @code{transient-mark-mode} to be turned on}, only the region will be
9293 exported. If the selected region is a single tree@footnote{To select the
9294 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
9295 title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
9296 property, that name will be used for the export.
9299 Export as DocBook file, process to PDF, then open the resulting PDF file.
9301 @vindex org-export-docbook-xslt-proc-command
9302 @vindex org-export-docbook-xsl-fo-proc-command
9303 Note that, in order to produce PDF output based on exported DocBook file, you
9304 need to have XSLT processor and XSL-FO processor software installed on your
9305 system. Check variables @code{org-export-docbook-xslt-proc-command} and
9306 @code{org-export-docbook-xsl-fo-proc-command}.
9310 Export only the visible part of the document.
9313 @node Quoting DocBook code, Recursive sections, DocBook export commands, DocBook export
9314 @subsection Quoting DocBook code
9316 You can quote DocBook code in Org files and copy it verbatim into exported
9317 DocBook file with the following constructs:
9320 @cindex #+BEGIN_DOCBOOK
9322 #+DOCBOOK: Literal DocBook code for export
9326 @cindex #+BEGIN_DOCBOOK
9330 All lines between these markers are exported by DocBook exporter
9335 For example, you can use the following lines to include a DocBook warning
9336 admonition. As to what this warning says, you should pay attention to the
9337 document context when quoting DocBook code in Org files. You may make
9338 exported DocBook XML files invalid by not quoting DocBook code correctly.
9343 <para>You should know what you are doing when quoting DocBook XML code
9344 in your Org file. Invalid DocBook XML file may be generated by
9345 DocBook exporter if you are not careful!</para>
9350 @node Recursive sections, Tables in DocBook export, Quoting DocBook code, DocBook export
9351 @subsection Recursive sections
9352 @cindex DocBook recursive sections
9354 DocBook exporter exports Org files as articles using the @code{article}
9355 element in DocBook. Recursive sections, @ie @code{section} elements, are
9356 used in exported articles. Top level headlines in Org files are exported as
9357 top level sections, and lower level headlines are exported as nested
9358 sections. The entire structure of Org files will be exported completely, no
9359 matter how many nested levels of headlines there are.
9361 Using recursive sections makes it easy to port and reuse exported DocBook
9362 code in other DocBook document types like @code{book} or @code{set}.
9364 @node Tables in DocBook export, Images in DocBook export, Recursive sections, DocBook export
9365 @subsection Tables in DocBook export
9366 @cindex tables, in DocBook export
9368 Tables in Org files are exported as HTML tables, which have been supported since
9371 If a table does not have a caption, an informal table is generated using the
9372 @code{informaltable} element; otherwise, a formal table will be generated
9373 using the @code{table} element.
9375 @node Images in DocBook export, Special characters, Tables in DocBook export, DocBook export
9376 @subsection Images in DocBook export
9377 @cindex images, inline in DocBook
9378 @cindex inlining images in DocBook
9380 Images that are linked to without a description part in the link, like
9381 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]}, will be exported to DocBook
9382 using @code{mediaobject} elements. Each @code{mediaobject} element contains
9383 an @code{imageobject} that wraps an @code{imagedata} element. If you have
9384 specified a caption for an image as described in @ref{Markup rules}, a
9385 @code{caption} element will be added in @code{mediaobject}. If a label is
9386 also specified, it will be exported as an @code{xml:id} attribute of the
9387 @code{mediaobject} element.
9389 @vindex org-export-docbook-default-image-attributes
9390 Image attributes supported by the @code{imagedata} element, like @code{align}
9391 or @code{width}, can be specified in two ways: you can either customize
9392 variable @code{org-export-docbook-default-image-attributes} or use the
9393 @code{#+ATTR_DOCBOOK:} line. Attributes specified in variable
9394 @code{org-export-docbook-default-image-attributes} are applied to all inline
9395 images in the Org file to be exported (unless they are overwritten by image
9396 attributes specified in @code{#+ATTR_DOCBOOK:} lines).
9398 The @code{#+ATTR_DOCBOOK:} line can be used to specify additional image
9399 attributes or overwrite default image attributes for individual images. If
9400 the same attribute appears in both the @code{#+ATTR_DOCBOOK:} line and
9401 variable @code{org-export-docbook-default-image-attributes}, the former
9402 overwrites the latter. Here is an example about how image attributes can be
9407 @cindex #+ATTR_DOCBOOK
9409 #+CAPTION: The logo of Org mode
9410 #+LABEL: unicorn-svg
9411 #+ATTR_DOCBOOK: scalefit="1" width="100%" depth="100%"
9412 [[./img/org-mode-unicorn.svg]]
9415 @vindex org-export-docbook-inline-image-extensions
9416 By default, DocBook exporter recognizes the following image file types:
9417 @file{jpeg}, @file{jpg}, @file{png}, @file{gif}, and @file{svg}. You can
9418 customize variable @code{org-export-docbook-inline-image-extensions} to add
9419 more types to this list as long as DocBook supports them.
9421 @node Special characters, , Images in DocBook export, DocBook export
9422 @subsection Special characters in DocBook export
9423 @cindex Special characters in DocBook export
9425 @vindex org-export-docbook-doctype
9426 @vindex org-html-entities
9427 Special characters that are written in @TeX{}-like syntax, such as @code{\alpha},
9428 @code{\Gamma}, and @code{\Zeta}, are supported by DocBook exporter. These
9429 characters are rewritten to XML entities, like @code{α},
9430 @code{Γ}, and @code{Ζ}, based on the list saved in variable
9431 @code{org-html-entities}. As long as the generated DocBook file includes the
9432 corresponding entities, these special characters are recognized.
9434 You can customize variable @code{org-export-docbook-doctype} to include the
9435 entities you need. For example, you can set variable
9436 @code{org-export-docbook-doctype} to the following value to recognize all
9437 special characters included in XHTML entities:
9440 "<!DOCTYPE article [
9441 <!ENTITY % xhtml1-symbol PUBLIC
9442 \"-//W3C//ENTITIES Symbol for HTML//EN//XML\"
9443 \"http://www.w3.org/2003/entities/2007/xhtml1-symbol.ent\"
9450 @node XOXO export, iCalendar export, DocBook export, Exporting
9451 @section XOXO export
9454 Org mode contains an exporter that produces XOXO-style output.
9455 Currently, this exporter only handles the general outline structure and
9456 does not interpret any additional Org-mode features.
9461 Export as XOXO file @file{myfile.html}.
9464 Export only the visible part of the document.
9467 @node iCalendar export, , XOXO export, Exporting
9468 @section iCalendar export
9469 @cindex iCalendar export
9471 @vindex org-icalendar-include-todo
9472 @vindex org-icalendar-use-deadline
9473 @vindex org-icalendar-use-scheduled
9474 @vindex org-icalendar-categories
9475 Some people use Org mode for keeping track of projects, but still prefer a
9476 standard calendar application for anniversaries and appointments. In this
9477 case it can be useful to show deadlines and other time-stamped items in Org
9478 files in the calendar application. Org mode can export calendar information
9479 in the standard iCalendar format. If you also want to have TODO entries
9480 included in the export, configure the variable
9481 @code{org-icalendar-include-todo}. Plain timestamps are exported as VEVENT,
9482 and TODO items as VTODO. It will also create events from deadlines that are
9483 in non-TODO items. Deadlines and scheduling dates in TODO items will be used
9484 to set the start and due dates for the TODO entry@footnote{See the variables
9485 @code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}.
9486 As categories, it will use the tags locally defined in the heading, and the
9487 file/tree category@footnote{To add inherited tags or the TODO state,
9488 configure the variable @code{org-icalendar-categories}.}.
9490 @vindex org-icalendar-store-UID
9491 @cindex property, ID
9492 The iCalendar standard requires each entry to have a globally unique
9493 identifier (UID). Org creates these identifiers during export. If you set
9494 the variable @code{org-icalendar-store-UID}, the UID will be stored in the
9495 @code{:ID:} property of the entry and re-used next time you report this
9496 entry. Since a single entry can give rise to multiple iCalendar entries (as
9497 a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
9498 prefixes to the UID, depending on what triggered the inclusion of the entry.
9499 In this way the UID remains unique, but a synchronization program can still
9500 figure out from which entry all the different instances originate.
9505 Create iCalendar entries for the current file and store them in the same
9506 directory, using a file extension @file{.ics}.
9509 @vindex org-agenda-files
9510 Like @kbd{C-c C-e i}, but do this for all files in
9511 @code{org-agenda-files}. For each of these files, a separate iCalendar
9512 file will be written.
9515 @vindex org-combined-agenda-icalendar-file
9516 Create a single large iCalendar file from all files in
9517 @code{org-agenda-files} and write it to the file given by
9518 @code{org-combined-agenda-icalendar-file}.
9521 @vindex org-use-property-inheritance
9522 @vindex org-icalendar-include-body
9523 @cindex property, SUMMARY
9524 @cindex property, DESCRIPTION
9525 @cindex property, LOCATION
9526 The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION
9527 property can be inherited from higher in the hierarchy if you configure
9528 @code{org-use-property-inheritance} accordingly.} properties if the selected
9529 entries have them. If not, the summary will be derived from the headline,
9530 and the description from the body (limited to
9531 @code{org-icalendar-include-body} characters).
9533 How this calendar is best read and updated, depends on the application
9534 you are using. The FAQ covers this issue.
9536 @node Publishing, Miscellaneous, Exporting, Top
9539 @cindex O'Toole, David
9541 Org includes a publishing management system that allows you to configure
9542 automatic HTML conversion of @emph{projects} composed of interlinked org
9543 files. You can also configure Org to automatically upload your exported HTML
9544 pages and related attachments, such as images and source code files, to a web
9547 You can also use Org to convert files into PDF, or even combine HTML and PDF
9548 conversion so that files are available in both formats on the server.
9550 Publishing has been contributed to Org by David O'Toole.
9553 * Configuration:: Defining projects
9554 * Uploading files:: How to get files up on the server
9555 * Sample configuration:: Example projects
9556 * Triggering publication:: Publication commands
9559 @node Configuration, Uploading files, Publishing, Publishing
9560 @section Configuration
9562 Publishing needs significant configuration to specify files, destination
9563 and many other properties of a project.
9566 * Project alist:: The central configuration variable
9567 * Sources and destinations:: From here to there
9568 * Selecting files:: What files are part of the project?
9569 * Publishing action:: Setting the function doing the publishing
9570 * Publishing options:: Tweaking HTML export
9571 * Publishing links:: Which links keep working after publishing?
9572 * Project page index:: Publishing a list of project files
9575 @node Project alist, Sources and destinations, Configuration, Configuration
9576 @subsection The variable @code{org-publish-project-alist}
9577 @cindex org-publish-project-alist
9578 @cindex projects, for publishing
9580 @vindex org-publish-project-alist
9581 Publishing is configured almost entirely through setting the value of one
9582 variable, called @code{org-publish-project-alist}. Each element of the list
9583 configures one project, and may be in one of the two following forms:
9586 ("project-name" :property value :property value ...)
9588 ("project-name" :components ("project-name" "project-name" ...))
9592 In both cases, projects are configured by specifying property values. A
9593 project defines the set of files that will be published, as well as the
9594 publishing configuration to use when publishing those files. When a project
9595 takes the second form listed above, the individual members of the
9596 @code{:components} property are taken to be sub-projects, which group
9597 together files requiring different publishing options. When you publish such
9598 a ``meta-project'', all the components will also be published, in the
9601 @node Sources and destinations, Selecting files, Project alist, Configuration
9602 @subsection Sources and destinations for files
9603 @cindex directories, for publishing
9605 Most properties are optional, but some should always be set. In
9606 particular, Org needs to know where to look for source files,
9607 and where to put published files.
9609 @multitable @columnfractions 0.3 0.7
9610 @item @code{:base-directory}
9611 @tab Directory containing publishing source files
9612 @item @code{:publishing-directory}
9613 @tab Directory where output files will be published. You can directly
9614 publish to a webserver using a file name syntax appropriate for
9615 the Emacs @file{tramp} package. Or you can publish to a local directory and
9616 use external tools to upload your website (@pxref{Uploading files}).
9617 @item @code{:preparation-function}
9618 @tab Function called before starting the publishing process, for example, to
9619 run @code{make} for updating files to be published.
9620 @item @code{:completion-function}
9621 @tab Function called after finishing the publishing process, for example, to
9622 change permissions of the resulting files.
9626 @node Selecting files, Publishing action, Sources and destinations, Configuration
9627 @subsection Selecting files
9628 @cindex files, selecting for publishing
9630 By default, all files with extension @file{.org} in the base directory
9631 are considered part of the project. This can be modified by setting the
9633 @multitable @columnfractions 0.25 0.75
9634 @item @code{:base-extension}
9635 @tab Extension (without the dot!) of source files. This actually is a
9636 regular expression. Set this to the symbol @code{any} if you want to get all
9637 files in @code{:base-directory}, even without extension.
9639 @item @code{:exclude}
9640 @tab Regular expression to match file names that should not be
9641 published, even though they have been selected on the basis of their
9644 @item @code{:include}
9645 @tab List of files to be included regardless of @code{:base-extension}
9646 and @code{:exclude}.
9649 @node Publishing action, Publishing options, Selecting files, Configuration
9650 @subsection Publishing action
9651 @cindex action, for publishing
9653 Publishing means that a file is copied to the destination directory and
9654 possibly transformed in the process. The default transformation is to export
9655 Org files as HTML files, and this is done by the function
9656 @code{org-publish-org-to-html} which calls the HTML exporter (@pxref{HTML
9657 export}). But you also can publish your content as PDF files using
9658 @code{org-publish-org-to-pdf}. If you want to publish the Org file itself,
9659 but with @i{archived}, @i{commented}, and @i{tag-excluded} trees removed, use
9660 @code{org-publish-org-to-org} and set the parameters @code{:plain-source}
9661 and/or @code{:htmlized-source}. This will produce @file{file.org} and
9662 @file{file.org.html} in the publishing
9663 directory@footnote{@file{file-source.org} and @file{file-source.org.html} if
9664 source and publishing directories are equal. Note that with this kind of
9665 setup, you need to add @code{:exclude "-source\\.org"} to the project
9666 definition in @code{org-publish-project-alist} to avoid that the published
9667 source files will be considered as new org files the next time the project is
9668 published.}. Other files like images only
9669 need to be copied to the publishing destination, for this you may use
9670 @code{org-publish-attachment}. For non-Org files, you always need to
9671 specify the publishing function:
9673 @multitable @columnfractions 0.3 0.7
9674 @item @code{:publishing-function}
9675 @tab Function executing the publication of a file. This may also be a
9676 list of functions, which will all be called in turn.
9677 @item @code{:plain-source}
9678 @tab Non-nil means, publish plain source.
9679 @item @code{:htmlized-source}
9680 @tab Non-nil means, publish htmlized source.
9683 The function must accept two arguments: a property list containing at least a
9684 @code{:publishing-directory} property, and the name of the file to be
9685 published. It should take the specified file, make the necessary
9686 transformation (if any) and place the result into the destination folder.
9688 @node Publishing options, Publishing links, Publishing action, Configuration
9689 @subsection Options for the HTML/La@TeX{} exporters
9690 @cindex options, for publishing
9692 The property list can be used to set many export options for the HTML
9693 and La@TeX{} exporters. In most cases, these properties correspond to user
9694 variables in Org. The table below lists these properties along
9695 with the variable they belong to. See the documentation string for the
9696 respective variable for details.
9698 @vindex org-export-html-link-up
9699 @vindex org-export-html-link-home
9700 @vindex org-export-default-language
9701 @vindex org-display-custom-times
9702 @vindex org-export-headline-levels
9703 @vindex org-export-with-section-numbers
9704 @vindex org-export-section-number-format
9705 @vindex org-export-with-toc
9706 @vindex org-export-preserve-breaks
9707 @vindex org-export-with-archived-trees
9708 @vindex org-export-with-emphasize
9709 @vindex org-export-with-sub-superscripts
9710 @vindex org-export-with-special-strings
9711 @vindex org-export-with-footnotes
9712 @vindex org-export-with-drawers
9713 @vindex org-export-with-tags
9714 @vindex org-export-with-todo-keywords
9715 @vindex org-export-with-priority
9716 @vindex org-export-with-TeX-macros
9717 @vindex org-export-with-LaTeX-fragments
9718 @vindex org-export-skip-text-before-1st-heading
9719 @vindex org-export-with-fixed-width
9720 @vindex org-export-with-timestamps
9721 @vindex org-export-author-info
9722 @vindex org-export-creator-info
9723 @vindex org-export-with-tables
9724 @vindex org-export-highlight-first-table-line
9725 @vindex org-export-html-style-include-default
9726 @vindex org-export-html-style
9727 @vindex org-export-html-style-extra
9728 @vindex org-export-html-link-org-files-as-html
9729 @vindex org-export-html-inline-images
9730 @vindex org-export-html-extension
9731 @vindex org-export-html-table-tag
9732 @vindex org-export-html-expand
9733 @vindex org-export-html-with-timestamp
9734 @vindex org-export-publishing-directory
9735 @vindex org-export-html-preamble
9736 @vindex org-export-html-postamble
9737 @vindex org-export-html-auto-preamble
9738 @vindex org-export-html-auto-postamble
9739 @vindex user-full-name
9740 @vindex user-mail-address
9741 @vindex org-export-select-tags
9742 @vindex org-export-exclude-tags
9744 @multitable @columnfractions 0.32 0.68
9745 @item @code{:link-up} @tab @code{org-export-html-link-up}
9746 @item @code{:link-home} @tab @code{org-export-html-link-home}
9747 @item @code{:language} @tab @code{org-export-default-language}
9748 @item @code{:customtime} @tab @code{org-display-custom-times}
9749 @item @code{:headline-levels} @tab @code{org-export-headline-levels}
9750 @item @code{:section-numbers} @tab @code{org-export-with-section-numbers}
9751 @item @code{:section-number-format} @tab @code{org-export-section-number-format}
9752 @item @code{:table-of-contents} @tab @code{org-export-with-toc}
9753 @item @code{:preserve-breaks} @tab @code{org-export-preserve-breaks}
9754 @item @code{:archived-trees} @tab @code{org-export-with-archived-trees}
9755 @item @code{:emphasize} @tab @code{org-export-with-emphasize}
9756 @item @code{:sub-superscript} @tab @code{org-export-with-sub-superscripts}
9757 @item @code{:special-strings} @tab @code{org-export-with-special-strings}
9758 @item @code{:footnotes} @tab @code{org-export-with-footnotes}
9759 @item @code{:drawers} @tab @code{org-export-with-drawers}
9760 @item @code{:tags} @tab @code{org-export-with-tags}
9761 @item @code{:todo-keywords} @tab @code{org-export-with-todo-keywords}
9762 @item @code{:priority} @tab @code{org-export-with-priority}
9763 @item @code{:TeX-macros} @tab @code{org-export-with-TeX-macros}
9764 @item @code{:LaTeX-fragments} @tab @code{org-export-with-LaTeX-fragments}
9765 @item @code{:latex-listings} @tab @code{org-export-latex-listings}
9766 @item @code{:skip-before-1st-heading} @tab @code{org-export-skip-text-before-1st-heading}
9767 @item @code{:fixed-width} @tab @code{org-export-with-fixed-width}
9768 @item @code{:timestamps} @tab @code{org-export-with-timestamps}
9769 @item @code{:author-info} @tab @code{org-export-author-info}
9770 @item @code{:creator-info} @tab @code{org-export-creator-info}
9771 @item @code{:tables} @tab @code{org-export-with-tables}
9772 @item @code{:table-auto-headline} @tab @code{org-export-highlight-first-table-line}
9773 @item @code{:style-include-default} @tab @code{org-export-html-style-include-default}
9774 @item @code{:style} @tab @code{org-export-html-style}
9775 @item @code{:style-extra} @tab @code{org-export-html-style-extra}
9776 @item @code{:convert-org-links} @tab @code{org-export-html-link-org-files-as-html}
9777 @item @code{:inline-images} @tab @code{org-export-html-inline-images}
9778 @item @code{:html-extension} @tab @code{org-export-html-extension}
9779 @item @code{:xml-declaration} @tab @code{org-export-html-xml-declaration}
9780 @item @code{:html-table-tag} @tab @code{org-export-html-table-tag}
9781 @item @code{:expand-quoted-html} @tab @code{org-export-html-expand}
9782 @item @code{:timestamp} @tab @code{org-export-html-with-timestamp}
9783 @item @code{:publishing-directory} @tab @code{org-export-publishing-directory}
9784 @item @code{:preamble} @tab @code{org-export-html-preamble}
9785 @item @code{:postamble} @tab @code{org-export-html-postamble}
9786 @item @code{:auto-preamble} @tab @code{org-export-html-auto-preamble}
9787 @item @code{:auto-postamble} @tab @code{org-export-html-auto-postamble}
9788 @item @code{:author} @tab @code{user-full-name}
9789 @item @code{:email} @tab @code{user-mail-address} : @code{addr;addr;..}
9790 @item @code{:select-tags} @tab @code{org-export-select-tags}
9791 @item @code{:exclude-tags} @tab @code{org-export-exclude-tags}
9792 @item @code{:latex-image-options} @tab @code{org-export-latex-image-default-option}
9795 Most of the @code{org-export-with-*} variables have the same effect in
9796 both HTML and La@TeX{} exporters, except for @code{:TeX-macros} and
9797 @code{:LaTeX-fragments}, respectively @code{nil} and @code{t} in the
9800 @vindex org-publish-project-alist
9801 When a property is given a value in @code{org-publish-project-alist},
9802 its setting overrides the value of the corresponding user variable (if
9803 any) during publishing. Options set within a file (@pxref{Export
9804 options}), however, override everything.
9806 @node Publishing links, Project page index, Publishing options, Configuration
9807 @subsection Links between published files
9808 @cindex links, publishing
9810 To create a link from one Org file to another, you would use
9811 something like @samp{[[file:foo.org][The foo]]} or simply
9812 @samp{file:foo.org.} (@pxref{Hyperlinks}). When published, this link
9813 becomes a link to @file{foo.html}. In this way, you can interlink the
9814 pages of your "org web" project and the links will work as expected when
9815 you publish them to HTML. If you also publish the Org source file and want
9816 to link to that, use an @code{http:} link instead of a @code{file:} link,
9817 because @code{file:} links are converted to link to the corresponding
9820 You may also link to related files, such as images. Provided you are careful
9821 with relative file names, and provided you have also configured Org to upload
9822 the related files, these links will work too. See @ref{Complex example}, for
9823 an example of this usage.
9825 Sometimes an Org file to be published may contain links that are
9826 only valid in your production environment, but not in the publishing
9827 location. In this case, use the property
9829 @multitable @columnfractions 0.4 0.6
9830 @item @code{:link-validation-function}
9831 @tab Function to validate links
9835 to define a function for checking link validity. This function must
9836 accept two arguments, the file name and a directory relative to which
9837 the file name is interpreted in the production environment. If this
9838 function returns @code{nil}, then the HTML generator will only insert a
9839 description into the HTML file, but no link. One option for this
9840 function is @code{org-publish-validate-link} which checks if the given
9841 file is part of any project in @code{org-publish-project-alist}.
9843 @node Project page index, , Publishing links, Configuration
9844 @subsection Project page index
9845 @cindex index, of published pages
9847 The following properties may be used to control publishing of an
9848 index of files or a summary page for a given project.
9850 @multitable @columnfractions 0.25 0.75
9851 @item @code{:auto-index}
9852 @tab When non-nil, publish an index during @code{org-publish-current-project}
9853 or @code{org-publish-all}.
9855 @item @code{:index-filename}
9856 @tab Filename for output of index. Defaults to @file{sitemap.org} (which
9857 becomes @file{sitemap.html}).
9859 @item @code{:index-title}
9860 @tab Title of index page. Defaults to name of file.
9862 @item @code{:index-function}
9863 @tab Plug-in function to use for generation of index.
9864 Defaults to @code{org-publish-org-index}, which generates a plain list
9865 of links to all files in the project.
9868 @node Uploading files, Sample configuration, Configuration, Publishing
9869 @section Uploading files
9873 For those people already utilizing third party sync tools such as
9874 @command{rsync} or @command{unison}, it might be preferable not to use the built in
9875 @i{remote} publishing facilities of Org mode which rely heavily on
9876 Tramp. Tramp, while very useful and powerful, tends not to be
9877 so efficient for multiple file transfer and has been known to cause problems
9880 Specialized synchronization utilities offer several advantages. In addition
9881 to timestamp comparison, they also do content and permissions/attribute
9882 checks. For this reason you might prefer to publish your web to a local
9883 directory (possibly even @i{in place} with your Org files) and then use
9884 @file{unison} or @file{rsync} to do the synchronization with the remote host.
9886 Since Unison (for example) can be configured as to which files to transfer to
9887 a certain remote destination, it can greatly simplify the project publishing
9888 definition. Simply keep all files in the correct location, process your Org
9889 files with @code{org-publish} and let the synchronization tool do the rest.
9890 You do not need, in this scenario, to include attachments such as @file{jpg},
9891 @file{css} or @file{gif} files in the project definition since the 3rd party
9894 Publishing to a local directory is also much faster than to a remote one, so
9895 that you can afford more easily to republish entire projects. If you set
9896 @code{org-publish-use-timestamps-flag} to @code{nil}, you gain the main
9897 benefit of re-including any changed external files such as source example
9898 files you might include with @code{#+INCLUDE}. The timestamp mechanism in
9899 Org is not smart enough to detect if included files have been modified.
9901 @node Sample configuration, Triggering publication, Uploading files, Publishing
9902 @section Sample configuration
9904 Below we provide two example configurations. The first one is a simple
9905 project publishing only a set of Org files. The second example is
9906 more complex, with a multi-component project.
9909 * Simple example:: One-component publishing
9910 * Complex example:: A multi-component publishing example
9913 @node Simple example, Complex example, Sample configuration, Sample configuration
9914 @subsection Example: simple publishing configuration
9916 This example publishes a set of Org files to the @file{public_html}
9917 directory on the local machine.
9920 (setq org-publish-project-alist
9922 :base-directory "~/org/"
9923 :publishing-directory "~/public_html"
9924 :section-numbers nil
9925 :table-of-contents nil
9926 :style "<link rel=\"stylesheet\"
9927 href=\"../other/mystyle.css\"
9928 type=\"text/css\"/>")))
9931 @node Complex example, , Simple example, Sample configuration
9932 @subsection Example: complex publishing configuration
9934 This more complicated example publishes an entire website, including
9935 Org files converted to HTML, image files, Emacs Lisp source code, and
9936 style sheets. The publishing directory is remote and private files are
9939 To ensure that links are preserved, care should be taken to replicate
9940 your directory structure on the web server, and to use relative file
9941 paths. For example, if your Org files are kept in @file{~/org} and your
9942 publishable images in @file{~/images}, you'd link to an image with
9945 file:../images/myimage.png
9948 On the web server, the relative path to the image should be the
9949 same. You can accomplish this by setting up an "images" folder in the
9950 right place on the web server, and publishing images to it.
9953 (setq org-publish-project-alist
9955 :base-directory "~/org/"
9956 :base-extension "org"
9957 :publishing-directory "/ssh:user@@host:~/html/notebook/"
9958 :publishing-function org-publish-org-to-html
9959 :exclude "PrivatePage.org" ;; regexp
9961 :section-numbers nil
9962 :table-of-contents nil
9963 :style "<link rel=\"stylesheet\"
9964 href=\"../other/mystyle.css\" type=\"text/css\"/>"
9966 :auto-postamble nil)
9969 :base-directory "~/images/"
9970 :base-extension "jpg\\|gif\\|png"
9971 :publishing-directory "/ssh:user@@host:~/html/images/"
9972 :publishing-function org-publish-attachment)
9975 :base-directory "~/other/"
9976 :base-extension "css\\|el"
9977 :publishing-directory "/ssh:user@@host:~/html/other/"
9978 :publishing-function org-publish-attachment)
9979 ("website" :components ("orgfiles" "images" "other"))))
9982 @node Triggering publication, , Sample configuration, Publishing
9983 @section Triggering publication
9985 Once properly configured, Org can publish with the following commands:
9990 Prompt for a specific project and publish all files that belong to it.
9993 Publish the project containing the current file.
9996 Publish only the current file.
9999 Publish every project.
10002 @vindex org-publish-use-timestamps-flag
10003 Org uses timestamps to track when a file has changed. The above functions
10004 normally only publish changed files. You can override this and force
10005 publishing of all files by giving a prefix argument to any of the commands
10006 above, or by customizing the variable @code{org-publish-use-timestamps-flag}.
10007 This may be necessary in particular if files include other files via
10008 @code{#+SETUPFILE:} or @code{#+INCLUDE:}.
10010 @node Miscellaneous, Hacking, Publishing, Top
10011 @chapter Miscellaneous
10014 * Completion:: M-TAB knows what you need
10015 * Customization:: Adapting Org to your taste
10016 * In-buffer settings:: Overview of the #+KEYWORDS
10017 * The very busy C-c C-c key:: When in doubt, press C-c C-c
10018 * Clean view:: Getting rid of leading stars in the outline
10019 * TTY keys:: Using Org on a tty
10020 * Interaction:: Other Emacs packages
10024 @node Completion, Customization, Miscellaneous, Miscellaneous
10025 @section Completion
10026 @cindex completion, of @TeX{} symbols
10027 @cindex completion, of TODO keywords
10028 @cindex completion, of dictionary words
10029 @cindex completion, of option keywords
10030 @cindex completion, of tags
10031 @cindex completion, of property keys
10032 @cindex completion, of link abbreviations
10033 @cindex @TeX{} symbol completion
10034 @cindex TODO keywords completion
10035 @cindex dictionary word completion
10036 @cindex option keyword completion
10037 @cindex tag completion
10038 @cindex link abbreviations, completion of
10040 Emacs would not be Emacs without completion, and Org-mode uses it whenever it
10041 makes sense. If you prefer an @i{iswitchb}- or @i{ido}-like interface for
10042 some of the completion prompts, you can specify your preferece by setting at
10043 most one of the variables @code{org-completion-use-iswitchb}
10044 @code{org-completion-use-ido}.
10046 Org supports in-buffer completion. This type of completion does
10047 not make use of the minibuffer. You simply type a few letters into
10048 the buffer and use the key to complete text right there.
10051 @kindex M-@key{TAB}
10053 Complete word at point
10056 At the beginning of a headline, complete TODO keywords.
10058 After @samp{\}, complete @TeX{} symbols supported by the exporter.
10060 After @samp{*}, complete headlines in the current buffer so that they
10061 can be used in search links like @samp{[[*find this headline]]}.
10063 After @samp{:} in a headline, complete tags. The list of tags is taken
10064 from the variable @code{org-tag-alist} (possibly set through the
10065 @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
10066 dynamically from all tags used in the current buffer.
10068 After @samp{:} and not in a headline, complete property keys. The list
10069 of keys is constructed dynamically from all keys used in the current
10072 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
10074 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
10075 @samp{OPTIONS} which set file-specific options for Org mode. When the
10076 option keyword is already complete, pressing @kbd{M-@key{TAB}} again
10077 will insert example settings for this keyword.
10079 In the line after @samp{#+STARTUP: }, complete startup keywords,
10080 @ie valid keys for this line.
10082 Elsewhere, complete dictionary words using Ispell.
10086 @node Customization, In-buffer settings, Completion, Miscellaneous
10087 @section Customization
10088 @cindex customization
10089 @cindex options, for customization
10090 @cindex variables, for customization
10092 There are more than 180 variables that can be used to customize
10093 Org. For the sake of compactness of the manual, I am not
10094 describing the variables here. A structured overview of customization
10095 variables is available with @kbd{M-x org-customize}. Or select
10096 @code{Browse Org Group} from the @code{Org->Customization} menu. Many
10097 settings can also be activated on a per-file basis, by putting special
10098 lines into the buffer (@pxref{In-buffer settings}).
10100 @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous
10101 @section Summary of in-buffer settings
10102 @cindex in-buffer settings
10103 @cindex special keywords
10105 Org mode uses special lines in the buffer to define settings on a
10106 per-file basis. These lines start with a @samp{#+} followed by a
10107 keyword, a colon, and then individual words defining a setting. Several
10108 setting words can be in the same line, but you can also have multiple
10109 lines for the keyword. While these settings are described throughout
10110 the manual, here is a summary. After changing any of those lines in the
10111 buffer, press @kbd{C-c C-c} with the cursor still in the line to
10112 activate the changes immediately. Otherwise they become effective only
10113 when the file is visited again in a new Emacs session.
10115 @vindex org-archive-location
10117 @item #+ARCHIVE: %s_done::
10118 This line sets the archive location for the agenda file. It applies for
10119 all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
10120 of the file. The first such line also applies to any entries before it.
10121 The corresponding variable is @code{org-archive-location}.
10123 This line sets the category for the agenda file. The category applies
10124 for all subsequent lines until the next @samp{#+CATEGORY} line, or the
10125 end of the file. The first such line also applies to any entries before it.
10126 @item #+COLUMNS: %25ITEM .....
10127 @cindex property, COLUMNS
10128 Set the default format for columns view. This format applies when
10129 columns view is invoked in locations where no @code{COLUMNS} property
10131 @item #+CONSTANTS: name1=value1 ...
10132 @vindex org-table-formula-constants
10133 @vindex org-table-formula
10134 Set file-local values for constants to be used in table formulas. This
10135 line set the local variable @code{org-table-formula-constants-local}.
10136 The global version of this variable is
10137 @code{org-table-formula-constants}.
10138 @item #+FILETAGS: :tag1:tag2:tag3:
10139 Set tags that can be inherited by any entry in the file, including the
10141 @item #+DRAWERS: NAME1 .....
10142 @vindex org-drawers
10143 Set the file-local set of drawers. The corresponding global variable is
10144 @code{org-drawers}.
10145 @item #+LINK: linkword replace
10146 @vindex org-link-abbrev-alist
10147 These lines (several are allowed) specify link abbreviations.
10148 @xref{Link abbreviations}. The corresponding variable is
10149 @code{org-link-abbrev-alist}.
10150 @item #+PRIORITIES: highest lowest default
10151 @vindex org-highest-priority
10152 @vindex org-lowest-priority
10153 @vindex org-default-priority
10154 This line sets the limits and the default for the priorities. All three
10155 must be either letters A-Z or numbers 0-9. The highest priority must
10156 have a lower ASCII number that the lowest priority.
10157 @item #+PROPERTY: Property_Name Value
10158 This line sets a default inheritance value for entries in the current
10159 buffer, most useful for specifying the allowed values of a property.
10160 @cindex #+SETUPFILE
10161 @item #+SETUPFILE: file
10162 This line defines a file that holds more in-buffer setup. Normally this is
10163 entirely ignored. Only when the buffer is parsed for option-setting lines
10164 (@ie when starting Org mode for a file, when pressing @kbd{C-c C-c} in a
10165 settings line, or when exporting), then the contents of this file are parsed
10166 as if they had been included in the buffer. In particular, the file can be
10167 any other Org mode file with internal setup. You can visit the file the
10168 cursor is in the line with @kbd{C-c '}.
10171 This line sets options to be used at startup of Org mode, when an
10172 Org file is being visited.
10174 The first set of options deals with the initial visibility of the outline
10175 tree. The corresponding variable for global default settings is
10176 @code{org-startup-folded}, with a default value @code{t}, which means
10178 @vindex org-startup-folded
10179 @cindex @code{overview}, STARTUP keyword
10180 @cindex @code{content}, STARTUP keyword
10181 @cindex @code{showall}, STARTUP keyword
10182 @cindex @code{showeverything}, STARTUP keyword
10184 overview @r{top-level headlines only}
10185 content @r{all headlines}
10186 showall @r{no folding of any entries}
10187 showeverything @r{show even drawer contents}
10190 @vindex org-startup-indented
10191 @cindex @code{indent}, STARTUP keyword
10192 @cindex @code{noindent}, STARTUP keyword
10193 Dynamic virtual indentation is controlled by the variable
10194 @code{org-startup-indented}@footnote{Emacs 23 and Org-mode 6.29 are required}
10196 indent @r{start with @code{org-indent-mode} turned on}
10197 noindent @r{start with @code{org-indent-mode} turned off}
10200 @vindex org-startup-align-all-tables
10201 Then there are options for aligning tables upon visiting a file. This
10202 is useful in files containing narrowed table columns. The corresponding
10203 variable is @code{org-startup-align-all-tables}, with a default value
10205 @cindex @code{align}, STARTUP keyword
10206 @cindex @code{noalign}, STARTUP keyword
10208 align @r{align all tables}
10209 noalign @r{don't align tables on startup}
10211 @vindex org-log-done
10212 @vindex org-log-note-clock-out
10213 @vindex org-log-repeat
10214 Logging the closing and reopening of TODO items and clock intervals can be
10215 configured using these options (see variables @code{org-log-done},
10216 @code{org-log-note-clock-out} and @code{org-log-repeat})
10217 @cindex @code{logdone}, STARTUP keyword
10218 @cindex @code{lognotedone}, STARTUP keyword
10219 @cindex @code{nologdone}, STARTUP keyword
10220 @cindex @code{lognoteclock-out}, STARTUP keyword
10221 @cindex @code{nolognoteclock-out}, STARTUP keyword
10222 @cindex @code{logrepeat}, STARTUP keyword
10223 @cindex @code{lognoterepeat}, STARTUP keyword
10224 @cindex @code{nologrepeat}, STARTUP keyword
10226 logdone @r{record a timestamp when an item is marked DONE}
10227 lognotedone @r{record timestamp and a note when DONE}
10228 nologdone @r{don't record when items are marked DONE}
10229 logrepeat @r{record a time when reinstating a repeating item}
10230 lognoterepeat @r{record a note when reinstating a repeating item}
10231 nologrepeat @r{do not record when reinstating repeating item}
10232 lognoteclock-out @r{record a note when clocking out}
10233 nolognoteclock-out @r{don't record a note when clocking out}
10235 @vindex org-hide-leading-stars
10236 @vindex org-odd-levels-only
10237 Here are the options for hiding leading stars in outline headings, and for
10238 indenting outlines. The corresponding variables are
10239 @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
10240 default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
10241 @cindex @code{hidestars}, STARTUP keyword
10242 @cindex @code{showstars}, STARTUP keyword
10243 @cindex @code{odd}, STARTUP keyword
10244 @cindex @code{even}, STARTUP keyword
10246 hidestars @r{make all but one of the stars starting a headline invisible.}
10247 showstars @r{show all stars starting a headline}
10248 indent @r{virtual indentation according to outline level}
10249 noindent @r{no virtual indentation according to outline level}
10250 odd @r{allow only odd outline levels (1,3,...)}
10251 oddeven @r{allow all outline levels}
10253 @vindex org-put-time-stamp-overlays
10254 @vindex org-time-stamp-overlay-formats
10255 To turn on custom format overlays over timestamps (variables
10256 @code{org-put-time-stamp-overlays} and
10257 @code{org-time-stamp-overlay-formats}), use
10258 @cindex @code{customtime}, STARTUP keyword
10260 customtime @r{overlay custom time format}
10262 @vindex constants-unit-system
10263 The following options influence the table spreadsheet (variable
10264 @code{constants-unit-system}).
10265 @cindex @code{constcgs}, STARTUP keyword
10266 @cindex @code{constSI}, STARTUP keyword
10268 constcgs @r{@file{constants.el} should use the c-g-s unit system}
10269 constSI @r{@file{constants.el} should use the SI unit system}
10271 @vindex org-footnote-define-inline
10272 @vindex org-footnote-auto-label
10273 @vindex org-footnote-auto-adjust
10274 To influence footnote settings, use the following keywords. The
10275 corresponding variables are @code{org-footnote-define-inline},
10276 @code{org-footnote-auto-label}, and @code{org-footnote-auto-adjust}.
10277 @cindex @code{fninline}, STARTUP keyword
10278 @cindex @code{nofninline}, STARTUP keyword
10279 @cindex @code{fnlocal}, STARTUP keyword
10280 @cindex @code{fnprompt}, STARTUP keyword
10281 @cindex @code{fnauto}, STARTUP keyword
10282 @cindex @code{fnconfirm}, STARTUP keyword
10283 @cindex @code{fnplain}, STARTUP keyword
10284 @cindex @code{fnadjust}, STARTUP keyword
10285 @cindex @code{nofnadjust}, STARTUP keyword
10287 fninline @r{define footnotes inline}
10288 fnnoinline @r{define footnotes in separate section}
10289 fnlocal @r{define footnotes near first reference, but not inline}
10290 fnprompt @r{prompt for footnote labels}
10291 fnauto @r{create [fn:1]-like labels automatically (default)}
10292 fnconfirm @r{offer automatic label for editing or confirmation}
10293 fnplain @r{create [1]-like labels automatically}
10294 fnadjust @r{automatically renumber and sort footnotes}
10295 nofnadjust @r{do not renumber and sort automatically}
10297 @cindex org-hide-block-startup
10298 To hide blocks on startup, use these keywords. The corresponding variable is
10299 @code{org-hide-block-startup}.
10300 @cindex @code{hideblocks}, STARTUP keyword
10301 @cindex @code{nohideblocks}, STARTUP keyword
10303 hideblocks @r{Hide all begin/end blocks on startup}
10304 nohideblocks @r{Do not hide blocks on startup}
10306 @item #+TAGS: TAG1(c1) TAG2(c2)
10307 @vindex org-tag-alist
10308 These lines (several such lines are allowed) specify the valid tags in
10309 this file, and (potentially) the corresponding @emph{fast tag selection}
10310 keys. The corresponding variable is @code{org-tag-alist}.
10312 This line contains the formulas for the table directly above the line.
10313 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+DATE:,
10314 @itemx #+OPTIONS:, #+BIND:
10315 @itemx #+DESCRIPTION:, #+KEYWORDS:
10316 @itemx #+LATEX_HEADER:, #+STYLE:, #+LINK_UP:, #+LINK_HOME:,
10317 @itemx #+EXPORT_SELECT_TAGS:, #+EXPORT_EXCLUDE_TAGS:
10318 These lines provide settings for exporting files. For more details see
10319 @ref{Export options}.
10320 @item #+TODO: #+SEQ_TODO: #+TYP_TODO:
10321 @vindex org-todo-keywords
10322 These lines set the TODO keywords and their interpretation in the
10323 current file. The corresponding variable is @code{org-todo-keywords}.
10326 @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous
10327 @section The very busy C-c C-c key
10329 @cindex C-c C-c, overview
10331 The key @kbd{C-c C-c} has many purposes in Org, which are all
10332 mentioned scattered throughout this manual. One specific function of
10333 this key is to add @emph{tags} to a headline (@pxref{Tags}). In many
10334 other circumstances it means something like @emph{``Hey Org, look
10335 here and update according to what you see here''}. Here is a summary of
10336 what this means in different contexts.
10340 If there are highlights in the buffer from the creation of a sparse
10341 tree, or from clock display, remove these highlights.
10343 If the cursor is in one of the special @code{#+KEYWORD} lines, this
10344 triggers scanning the buffer for these lines and updating the
10347 If the cursor is inside a table, realign the table. This command
10348 works even if the automatic table editor has been turned off.
10350 If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
10353 If the cursor is inside a table created by the @file{table.el} package,
10354 activate that table.
10356 If the current buffer is a Remember buffer, close the note and file it.
10357 With a prefix argument, file it, without further interaction, to the
10360 If the cursor is on a @code{<<<target>>>}, update radio targets and
10361 corresponding links in this buffer.
10363 If the cursor is in a property line or at the start or end of a property
10364 drawer, offer property commands.
10366 If the cursor is at a footnote reference, go to the corresponding
10367 definition, and vice versa.
10369 If the cursor is on a statistics cookie, update it.
10371 If the cursor is in a plain list item with a checkbox, toggle the status
10374 If the cursor is on a numbered item in a plain list, renumber the
10377 If the cursor is on the @code{#+BEGIN} line of a dynamic block, the
10381 @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous
10382 @section A cleaner outline view
10383 @cindex hiding leading stars
10384 @cindex dynamic indentation
10385 @cindex odd-levels-only outlines
10386 @cindex clean outline view
10388 Some people find it noisy and distracting that the Org headlines start with a
10389 potentially large number of stars, and that text below the headlines is not
10390 indented. While this is no problem when writing a @emph{book-like} document
10391 where the outline headings are really section headings, in a more
10392 @emph{list-oriented} outline, indented structure is a lot cleaner:
10396 * Top level headline | * Top level headline
10397 ** Second level | * Second level
10398 *** 3rd level | * 3rd level
10399 some text | some text
10400 *** 3rd level | * 3rd level
10401 more text | more text
10402 * Another top level headline | * Another top level headline
10407 If you are using at least Emacs 23.1.50.3 and version 6.29 of Org, this kind
10408 of view can be achieved dynamically at display time using
10409 @code{org-indent-mode}. In this minor mode, all lines are prefixed for
10410 display with the necessary amount of space. Also headlines are prefixed with
10411 additional stars, so that the amount of indentation shifts by
10412 two@footnote{See the variable @code{org-indent-indentation-per-level}.}
10413 spaces per level. All headline stars but the last one are made invisible
10414 using the @code{org-hide} face@footnote{Turning on @code{org-indent-mode}
10415 sets @code{org-hide-leading-stars} to @code{t} and
10416 @code{org-adapt-indentation} to @code{nil}.} - see below under @samp{2.} for
10417 more information on how this works. You can turn on @code{org-indent-mode}
10418 for all files by customizing the variable @code{org-startup-indented}, or you
10419 can turn it on for individual files using
10425 If you want a similar effect in earlier version of Emacs and/or Org, or if
10426 you want the indentation to be hard space characters so that the plain text
10427 file looks as similar as possible to the Emacs display, Org supports you in
10432 @emph{Indentation of text below headlines}@*
10433 You may indent text below each headline to make the left boundary line up
10434 with the headline, like
10438 more text, now indented
10441 @vindex org-adapt-indentation
10442 Org supports this with paragraph filling, line wrapping, and structure
10443 editing@footnote{See also the variable @code{org-adapt-indentation}.},
10444 preserving or adapting the indentation as appropriate.
10447 @vindex org-hide-leading-stars
10448 @emph{Hiding leading stars}@* You can modify the display in such a way that
10449 all leading stars become invisible. To do this in a global way, configure
10450 the variable @code{org-hide-leading-stars} or change this on a per-file basis
10454 #+STARTUP: hidestars
10455 #+STARTUP: showstars
10458 With hidden stars, the tree becomes:
10462 * Top level headline
10470 @vindex org-hide @r{(face)}
10471 The leading stars are not truly replaced by whitespace, they are only
10472 fontified with the face @code{org-hide} that uses the background color as
10473 font color. If you are not using either white or black background, you may
10474 have to customize this face to get the wanted effect. Another possibility is
10475 to set this font such that the extra stars are @i{almost} invisible, for
10476 example using the color @code{grey90} on a white background.
10479 @vindex org-odd-levels-only
10480 Things become cleaner still if you skip all the even levels and use only odd
10481 levels 1, 3, 5..., effectively adding two stars to go from one outline level
10482 to the next@footnote{When you need to specify a level for a property search
10483 or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc@.}. In this
10484 way we get the outline view shown at the beginning of this section. In order
10485 to make the structure editing and export commands handle this convention
10486 correctly, configure the variable @code{org-odd-levels-only}, or set this on
10487 a per-file basis with one of the following lines:
10494 You can convert an Org file from single-star-per-level to the
10495 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
10496 RET} in that file. The reverse operation is @kbd{M-x
10497 org-convert-to-oddeven-levels}.
10500 @node TTY keys, Interaction, Clean view, Miscellaneous
10501 @section Using Org on a tty
10502 @cindex tty key bindings
10504 Because Org contains a large number of commands, by default many of
10505 Org's core commands are bound to keys that are generally not
10506 accessible on a tty, such as the cursor keys (@key{left}, @key{right},
10507 @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
10508 together with modifiers like @key{Meta} and/or @key{Shift}. To access
10509 these commands on a tty when special keys are unavailable, the following
10510 alternative bindings can be used. The tty bindings below will likely be
10511 more cumbersome; you may find for some of the bindings below that a
10512 customized workaround suits you better. For example, changing a timestamp
10513 is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
10514 tty you would rather use @kbd{C-c .} to re-insert the timestamp.
10516 @multitable @columnfractions 0.15 0.2 0.2
10517 @item @b{Default} @tab @b{Alternative 1} @tab @b{Alternative 2}
10518 @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab
10519 @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{@key{Esc} @key{left}}
10520 @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab
10521 @item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{@key{Esc} @key{right}}
10522 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab
10523 @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{@key{Esc} @key{up}}
10524 @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab
10525 @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{@key{Esc} @key{down}}
10526 @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab
10527 @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab
10528 @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{@key{Esc} @key{RET}}
10529 @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab
10530 @item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab
10531 @item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab
10532 @item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab
10533 @item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab
10534 @item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab
10535 @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab
10539 @node Interaction, , TTY keys, Miscellaneous
10540 @section Interaction with other packages
10541 @cindex packages, interaction with other
10542 Org lives in the world of GNU Emacs and interacts in various ways
10543 with other code out there.
10546 * Cooperation:: Packages Org cooperates with
10547 * Conflicts:: Packages that lead to conflicts
10550 @node Cooperation, Conflicts, Interaction, Interaction
10551 @subsection Packages that Org cooperates with
10554 @cindex @file{calc.el}
10555 @cindex Gillespie, Dave
10556 @item @file{calc.el} by Dave Gillespie
10557 Org uses the Calc package for implementing spreadsheet
10558 functionality in its tables (@pxref{The spreadsheet}). Org
10559 checks for the availability of Calc by looking for the function
10560 @code{calc-eval} which will have been autoloaded during setup if Calc has
10561 been installed properly. As of Emacs 22, Calc is part of the Emacs
10562 distribution. Another possibility for interaction between the two
10563 packages is using Calc for embedded calculations. @xref{Embedded Mode,
10564 , Embedded Mode, Calc, GNU Emacs Calc Manual}.
10565 @item @file{constants.el} by Carsten Dominik
10566 @cindex @file{constants.el}
10567 @cindex Dominik, Carsten
10568 @vindex org-table-formula-constants
10569 In a table formula (@pxref{The spreadsheet}), it is possible to use
10570 names for natural constants or units. Instead of defining your own
10571 constants in the variable @code{org-table-formula-constants}, install
10572 the @file{constants} package which defines a large number of constants
10573 and units, and lets you use unit prefixes like @samp{M} for
10574 @samp{Mega}, etc@. You will need version 2.0 of this package, available
10575 at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for
10576 the function @code{constants-get}, which has to be autoloaded in your
10577 setup. See the installation instructions in the file
10578 @file{constants.el}.
10579 @item @file{cdlatex.el} by Carsten Dominik
10580 @cindex @file{cdlatex.el}
10581 @cindex Dominik, Carsten
10582 Org mode can make use of the CDLa@TeX{} package to efficiently enter
10583 La@TeX{} fragments into Org files. See @ref{CDLaTeX mode}.
10584 @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
10585 @cindex @file{imenu.el}
10586 Imenu allows menu access to an index of items in a file. Org mode
10587 supports Imenu---all you need to do to get the index is the following:
10589 (add-hook 'org-mode-hook
10590 (lambda () (imenu-add-to-menubar "Imenu")))
10592 @vindex org-imenu-depth
10593 By default the index is two levels deep---you can modify the depth using
10594 the option @code{org-imenu-depth}.
10595 @item @file{remember.el} by John Wiegley
10596 @cindex @file{remember.el}
10597 @cindex Wiegley, John
10598 Org cooperates with remember, see @ref{Remember}.
10599 @file{Remember.el} is not part of Emacs, find it on the web.
10600 @item @file{speedbar.el} by Eric M. Ludlam
10601 @cindex @file{speedbar.el}
10602 @cindex Ludlam, Eric M.
10603 Speedbar is a package that creates a special frame displaying files and
10604 index items in files. Org mode supports Speedbar and allows you to
10605 drill into Org files directly from the Speedbar. It also allows you to
10606 restrict the scope of agenda commands to a file or a subtree by using
10607 the command @kbd{<} in the Speedbar frame.
10608 @cindex @file{table.el}
10609 @item @file{table.el} by Takaaki Ota
10611 @cindex table editor, @file{table.el}
10612 @cindex @file{table.el}
10613 @cindex Ota, Takaaki
10615 Complex ASCII tables with automatic line wrapping, column- and
10616 row-spanning, and alignment can be created using the Emacs table
10617 package by Takaaki Ota (@uref{http://sourceforge.net/projects/table},
10618 and also part of Emacs 22).
10619 When @key{TAB} or @kbd{C-c C-c} is pressed in such a table, Org mode
10620 will call @command{table-recognize-table} and move the cursor into the
10621 table. Inside a table, the keymap of Org mode is inactive. In order
10622 to execute Org mode-related commands, leave the table.
10627 Recognize @file{table.el} table. Works when the cursor is in a
10632 Insert a @file{table.el} table. If there is already a table at point, this
10633 command converts it between the @file{table.el} format and the Org-mode
10634 format. See the documentation string of the command
10635 @code{org-convert-table} for the restrictions under which this is
10638 @file{table.el} is part of Emacs 22.
10639 @item @file{footnote.el} by Steven L. Baur
10640 @cindex @file{footnote.el}
10641 @cindex Baur, Steven L.
10642 Org mode recognizes numerical footnotes as provided by this package.
10643 However, Org mode also has its own footnote support (@pxref{Footnotes}),
10644 which makes using @file{footnote.el} unnecessary.
10647 @node Conflicts, , Cooperation, Interaction
10648 @subsection Packages that lead to conflicts with Org mode
10652 @cindex @code{shift-selection-mode}
10653 @vindex org-support-shift-select
10654 In Emacs 23, @code{shift-selection-mode} is on by default, meaning that
10655 cursor motions combined with the shift key should start or enlarge regions.
10656 This conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change
10657 timestamps, TODO keywords, priorities, and item bullet types if the cursor is
10658 at such a location. By default, @kbd{S-@key{cursor}} commands outside
10659 special contexts don't do anything, but you can customize the variable
10660 @code{org-support-shift-select}. Org mode then tries to accommodate shift
10661 selection by (i) using it outside of the special contexts where special
10662 commands apply, and by (ii) extending an existing active region even if the
10663 cursor moves across a special context.
10665 @item @file{CUA.el} by Kim. F. Storm
10666 @cindex @file{CUA.el}
10667 @cindex Storm, Kim. F.
10668 @vindex org-replace-disputed-keys
10669 Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by CUA mode
10670 (as well as @code{pc-select-mode} and @code{s-region-mode}) to select and extend the
10671 region. In fact, Emacs 23 has this built-in in the form of
10672 @code{shift-selection-mode}, see previous paragraph. If you are using Emacs
10673 23, you probably don't want to use another package for this purpose. However,
10674 if you prefer to leave these keys to a different package while working in
10675 Org mode, configure the variable @code{org-replace-disputed-keys}. When set,
10676 Org will move the following key bindings in Org files, and in the agenda
10677 buffer (but not during date selection).
10680 S-UP -> M-p S-DOWN -> M-n
10681 S-LEFT -> M-- S-RIGHT -> M-+
10682 C-S-LEFT -> M-S-- C-S-RIGHT -> M-S-+
10685 @vindex org-disputed-keys
10686 Yes, these are unfortunately more difficult to remember. If you want
10687 to have other replacement keys, look at the variable
10688 @code{org-disputed-keys}.
10690 @item @file{yasnippet.el}
10691 @cindex @file{yasnippet.el}
10692 The way Org-mode binds the TAB key (binding to @code{[tab]} instead of
10693 @code{"\t"}) overrules yasnippets' access to this key. The following code
10694 fixed this problem:
10697 (add-hook 'org-mode-hook
10699 (org-set-local 'yas/trigger-key [tab])
10700 (define-key yas/keymap [tab] 'yas/next-field-group)))
10703 @item @file{windmove.el} by Hovav Shacham
10704 @cindex @file{windmove.el}
10705 This package also uses the @kbd{S-<cursor>} keys, so everything written
10706 in the paragraph above about CUA mode also applies here.
10711 @node Hacking, MobileOrg, Miscellaneous, Top
10715 This appendix covers some aspects where users can extend the functionality of
10719 * Hooks:: Who to reach into Org's internals
10720 * Add-on packages:: Available extensions
10721 * Adding hyperlink types:: New custom link types
10722 * Context-sensitive commands:: How to add functionality to such commands
10723 * Tables in arbitrary syntax:: Orgtbl for La@TeX{} and other programs
10724 * Dynamic blocks:: Automatically filled blocks
10725 * Special agenda views:: Customized views
10726 * Extracting agenda information:: Postprocessing of agenda information
10727 * Using the property API:: Writing programs that use entry properties
10728 * Using the mapping API:: Mapping over all or selected entries
10731 @node Hooks, Add-on packages, Hacking, Hacking
10735 Org has a large number of hook variables that can be used to add
10736 functionality. This appendix about hacking is going to illustrate the
10737 use of some of them. A complete list of all hooks with documentation is
10738 maintained by the Worg project and can be found at
10739 @uref{http://orgmode.org/worg/org-configs/org-hooks.php}.
10741 @node Add-on packages, Adding hyperlink types, Hooks, Hacking
10742 @section Add-on packages
10743 @cindex add-on packages
10745 A large number of add-on packages have been written by various authors.
10746 These packages are not part of Emacs, but they are distributed as contributed
10747 packages with the separate release available at the Org mode home page at
10748 @uref{http://orgmode.org}. The list of contributed packages, along with
10749 documentation about each package, is maintained by the Worg project at
10750 @uref{http://orgmode.org/worg/org-contrib/}.
10754 @node Adding hyperlink types, Context-sensitive commands, Add-on packages, Hacking
10755 @section Adding hyperlink types
10756 @cindex hyperlinks, adding new types
10758 Org has a large number of hyperlink types built-in
10759 (@pxref{Hyperlinks}). If you would like to add new link types, Org
10760 provides an interface for doing so. Let's look at an example file,
10761 @file{org-man.el}, that will add support for creating links like
10762 @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
10766 ;;; org-man.el - Support for links to manpages in Org
10770 (org-add-link-type "man" 'org-man-open)
10771 (add-hook 'org-store-link-functions 'org-man-store-link)
10773 (defcustom org-man-command 'man
10774 "The Emacs command to be used to display a man page."
10776 :type '(choice (const man) (const woman)))
10778 (defun org-man-open (path)
10779 "Visit the manpage on PATH.
10780 PATH should be a topic that can be thrown at the man command."
10781 (funcall org-man-command path))
10783 (defun org-man-store-link ()
10784 "Store a link to a manpage."
10785 (when (memq major-mode '(Man-mode woman-mode))
10786 ;; This is a man page, we do make this link
10787 (let* ((page (org-man-get-page-name))
10788 (link (concat "man:" page))
10789 (description (format "Manpage for %s" page)))
10790 (org-store-link-props
10793 :description description))))
10795 (defun org-man-get-page-name ()
10796 "Extract the page name from the buffer name."
10797 ;; This works for both `Man-mode' and `woman-mode'.
10798 (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
10799 (match-string 1 (buffer-name))
10800 (error "Cannot create link to this man page")))
10804 ;;; org-man.el ends here
10808 You would activate this new link type in @file{.emacs} with
10815 Let's go through the file and see what it does.
10818 It does @code{(require 'org)} to make sure that @file{org.el} has been
10821 The next line calls @code{org-add-link-type} to define a new link type
10822 with prefix @samp{man}. The call also contains the name of a function
10823 that will be called to follow such a link.
10825 @vindex org-store-link-functions
10826 The next line adds a function to @code{org-store-link-functions}, in
10827 order to allow the command @kbd{C-c l} to record a useful link in a
10828 buffer displaying a man page.
10831 The rest of the file defines the necessary variables and functions.
10832 First there is a customization variable that determines which Emacs
10833 command should be used to display man pages. There are two options,
10834 @code{man} and @code{woman}. Then the function to follow a link is
10835 defined. It gets the link path as an argument---in this case the link
10836 path is just a topic for the manual command. The function calls the
10837 value of @code{org-man-command} to display the man page.
10839 Finally the function @code{org-man-store-link} is defined. When you try
10840 to store a link with @kbd{C-c l}, this function will be called to
10841 try to make a link. The function must first decide if it is supposed to
10842 create the link for this buffer type; we do this by checking the value
10843 of the variable @code{major-mode}. If not, the function must exit and
10844 return the value @code{nil}. If yes, the link is created by getting the
10845 manual topic from the buffer name and prefixing it with the string
10846 @samp{man:}. Then it must call the command @code{org-store-link-props}
10847 and set the @code{:type} and @code{:link} properties. Optionally you
10848 can also set the @code{:description} property to provide a default for
10849 the link description when the link is later inserted into an Org
10850 buffer with @kbd{C-c C-l}.
10852 When is makes sense for your new link type, you may also define a function
10853 @code{org-PREFIX-complete-link} that implements special (@eg completion)
10854 support for inserting such a link with @kbd{C-c C-l}. Such a function should
10855 not accept any arguments, and return the full link with prefix.
10857 @node Context-sensitive commands, Tables in arbitrary syntax, Adding hyperlink types, Hacking
10858 @section Context-sensitive commands
10859 @cindex context-sensitive commands, hooks
10860 @cindex add-ons, context-sensitive commands
10861 @vindex org-ctrl-c-ctrl-c-hook
10863 Org has several commands that act differently depending on context. The most
10864 important example it the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}).
10865 Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys have this property.
10867 Add-ons can tap into this functionality by providing a function that detects
10868 special context for that add-on and executes functionality appropriate for
10869 the context. Here is an example from Dan Davison's @file{org-R.el} which
10870 allows you to evaluate commands based on the @file{R} programming language. For
10871 this package, special contexts are lines that start with @code{#+R:} or
10875 (defun org-R-apply-maybe ()
10876 "Detect if this is context for org-R and execute R commands."
10877 (if (save-excursion
10878 (beginning-of-line 1)
10879 (looking-at "#\\+RR?:"))
10880 (progn (call-interactively 'org-R-apply)
10881 t) ;; to signal that we took action
10882 nil)) ;; to signal that we did not
10884 (add-hook 'org-ctrl-c-ctrl-c-hook 'org-R-apply-maybe)
10887 The function first checks if the cursor is in such a line. If that is the
10888 case, @code{org-R-apply} is called and the function returns @code{t} to
10889 signal that action was taken, and @kbd{C-c C-c} will stop looking for other
10890 contexts. If the function finds it should do nothing locally, it returns @code{nil} so that other, similar functions can have a try.
10893 @node Tables in arbitrary syntax, Dynamic blocks, Context-sensitive commands, Hacking
10894 @section Tables and lists in arbitrary syntax
10895 @cindex tables, in other modes
10896 @cindex lists, in other modes
10897 @cindex Orgtbl mode
10899 Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
10900 frequent feature request has been to make it work with native tables in
10901 specific languages, for example La@TeX{}. However, this is extremely
10902 hard to do in a general way, would lead to a customization nightmare,
10903 and would take away much of the simplicity of the Orgtbl-mode table
10907 This appendix describes a different approach. We keep the Orgtbl mode
10908 table in its native format (the @i{source table}), and use a custom
10909 function to @i{translate} the table to the correct syntax, and to
10910 @i{install} it in the right location (the @i{target table}). This puts
10911 the burden of writing conversion functions on the user, but it allows
10912 for a very flexible system.
10914 Bastien added the ability to do the same with lists. You can use Org's
10915 facilities to edit and structure lists by turning @code{orgstruct-mode}
10916 on, then locally exporting such lists in another format (HTML, La@TeX{}
10921 * Radio tables:: Sending and receiving radio tables
10922 * A LaTeX example:: Step by step, almost a tutorial
10923 * Translator functions:: Copy and modify
10924 * Radio lists:: Doing the same for lists
10927 @node Radio tables, A LaTeX example, Tables in arbitrary syntax, Tables in arbitrary syntax
10928 @subsection Radio tables
10929 @cindex radio tables
10931 To define the location of the target table, you first need to create two
10932 lines that are comments in the current mode, but contain magic words for
10933 Orgtbl mode to find. Orgtbl mode will insert the translated table
10934 between these lines, replacing whatever was there before. For example:
10937 /* BEGIN RECEIVE ORGTBL table_name */
10938 /* END RECEIVE ORGTBL table_name */
10942 Just above the source table, we put a special line that tells
10943 Orgtbl mode how to translate this table and where to install it. For
10947 #+ORGTBL: SEND table_name translation_function arguments....
10951 @code{table_name} is the reference name for the table that is also used
10952 in the receiver lines. @code{translation_function} is the Lisp function
10953 that does the translation. Furthermore, the line can contain a list of
10954 arguments (alternating key and value) at the end. The arguments will be
10955 passed as a property list to the translation function for
10956 interpretation. A few standard parameters are already recognized and
10957 acted upon before the translation function is called:
10961 Skip the first N lines of the table. Hlines do count as separate lines for
10964 @item :skipcols (n1 n2 ...)
10965 List of columns that should be skipped. If the table has a column with
10966 calculation marks, that column is automatically discarded as well.
10967 Please note that the translator function sees the table @emph{after} the
10968 removal of these columns, the function never knows that there have been
10969 additional columns.
10973 The one problem remaining is how to keep the source table in the buffer
10974 without disturbing the normal workings of the file, for example during
10975 compilation of a C file or processing of a La@TeX{} file. There are a
10976 number of different solutions:
10980 The table could be placed in a block comment if that is supported by the
10981 language. For example, in C mode you could wrap the table between
10982 @samp{/*} and @samp{*/} lines.
10984 Sometimes it is possible to put the table after some kind of @i{END}
10985 statement, for example @samp{\bye} in @TeX{} and @samp{\end@{document@}}
10988 You can just comment the table line-by-line whenever you want to process
10989 the file, and uncomment it whenever you need to edit the table. This
10990 only sounds tedious---the command @kbd{M-x orgtbl-toggle-comment}
10991 makes this comment-toggling very easy, in particular if you bind it to a
10995 @node A LaTeX example, Translator functions, Radio tables, Tables in arbitrary syntax
10996 @subsection A La@TeX{} example of radio tables
10997 @cindex La@TeX{}, and Orgtbl mode
10999 The best way to wrap the source table in La@TeX{} is to use the
11000 @code{comment} environment provided by @file{comment.sty}. It has to be
11001 activated by placing @code{\usepackage@{comment@}} into the document
11002 header. Orgtbl mode can insert a radio table skeleton@footnote{By
11003 default this works only for La@TeX{}, HTML, and Texinfo. Configure the
11004 variable @code{orgtbl-radio-tables} to install templates for other
11005 modes.} with the command @kbd{M-x orgtbl-insert-radio-table}. You will
11006 be prompted for a table name, let's say we use @samp{salesfigures}. You
11007 will then get the following template:
11009 @cindex #+ORGTBL, SEND
11011 % BEGIN RECEIVE ORGTBL salesfigures
11012 % END RECEIVE ORGTBL salesfigures
11014 #+ORGTBL: SEND salesfigures orgtbl-to-latex
11020 @vindex La@TeX{}-verbatim-environments
11021 The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
11022 @code{orgtbl-to-latex} to convert the table into La@TeX{} and to put it
11023 into the receiver location with name @code{salesfigures}. You may now
11024 fill in the table, feel free to use the spreadsheet features@footnote{If
11025 the @samp{#+TBLFM} line contains an odd number of dollar characters,
11026 this may cause problems with font-lock in La@TeX{} mode. As shown in the
11027 example you can fix this by adding an extra line inside the
11028 @code{comment} environment that is used to balance the dollar
11029 expressions. If you are using AUC@TeX{} with the font-latex library, a
11030 much better solution is to add the @code{comment} environment to the
11031 variable @code{LaTeX-verbatim-environments}.}:
11034 % BEGIN RECEIVE ORGTBL salesfigures
11035 % END RECEIVE ORGTBL salesfigures
11037 #+ORGTBL: SEND salesfigures orgtbl-to-latex
11038 | Month | Days | Nr sold | per day |
11039 |-------+------+---------+---------|
11040 | Jan | 23 | 55 | 2.4 |
11041 | Feb | 21 | 16 | 0.8 |
11042 | March | 22 | 278 | 12.6 |
11043 #+TBLFM: $4=$3/$2;%.1f
11044 % $ (optional extra dollar to keep font-lock happy, see footnote)
11049 When you are done, press @kbd{C-c C-c} in the table to get the converted
11050 table inserted between the two marker lines.
11052 Now let's assume you want to make the table header by hand, because you
11053 want to control how columns are aligned, etc@. In this case we make sure
11054 that the table translator skips the first 2 lines of the source
11055 table, and tell the command to work as a @i{splice}, @ie to not produce
11056 header and footer commands of the target table:
11059 \begin@{tabular@}@{lrrr@}
11060 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
11061 % BEGIN RECEIVE ORGTBL salesfigures
11062 % END RECEIVE ORGTBL salesfigures
11066 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
11067 | Month | Days | Nr sold | per day |
11068 |-------+------+---------+---------|
11069 | Jan | 23 | 55 | 2.4 |
11070 | Feb | 21 | 16 | 0.8 |
11071 | March | 22 | 278 | 12.6 |
11072 #+TBLFM: $4=$3/$2;%.1f
11076 The La@TeX{} translator function @code{orgtbl-to-latex} is already part of
11077 Orgtbl mode. It uses a @code{tabular} environment to typeset the table
11078 and marks horizontal lines with @code{\hline}. Furthermore, it
11079 interprets the following parameters (see also @pxref{Translator functions}):
11082 @item :splice nil/t
11083 When set to t, return only table body lines, don't wrap them into a
11084 tabular environment. Default is nil.
11087 A format to be used to wrap each field, it should contain @code{%s} for the
11088 original field value. For example, to wrap each field value in dollars,
11089 you could use @code{:fmt "$%s$"}. This may also be a property list with
11090 column numbers and formats. for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
11091 A function of one argument can be used in place of the strings; the
11092 function must return a formatted string.
11095 Use this format to print numbers with exponentials. The format should
11096 have @code{%s} twice for inserting mantissa and exponent, for example
11097 @code{"%s\\times10^@{%s@}"}. The default is @code{"%s\\,(%s)"}. This
11098 may also be a property list with column numbers and formats, for example
11099 @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After
11100 @code{efmt} has been applied to a value, @code{fmt} will also be
11101 applied. Similar to @code{fmt}, functions of two arguments can be
11102 supplied instead of strings.
11105 @node Translator functions, Radio lists, A LaTeX example, Tables in arbitrary syntax
11106 @subsection Translator functions
11107 @cindex HTML, and Orgtbl mode
11108 @cindex translator function
11110 Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
11111 (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
11112 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and @code{orgtbl-to-texinfo}.
11113 Except for @code{orgtbl-to-html}@footnote{The HTML translator uses the same
11114 code that produces tables during HTML export.}, these all use a generic
11115 translator, @code{orgtbl-to-generic}. For example, @code{orgtbl-to-latex}
11116 itself is a very short function that computes the column definitions for the
11117 @code{tabular} environment, defines a few field and line separators and then
11118 hands processing over to the generic translator. Here is the entire code:
11122 (defun orgtbl-to-latex (table params)
11123 "Convert the Orgtbl mode TABLE to LaTeX."
11124 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
11125 org-table-last-alignment ""))
11128 :tstart (concat "\\begin@{tabular@}@{" alignment "@}")
11129 :tend "\\end@{tabular@}"
11130 :lstart "" :lend " \\\\" :sep " & "
11131 :efmt "%s\\,(%s)" :hline "\\hline")))
11132 (orgtbl-to-generic table (org-combine-plists params2 params))))
11136 As you can see, the properties passed into the function (variable
11137 @var{PARAMS}) are combined with the ones newly defined in the function
11138 (variable @var{PARAMS2}). The ones passed into the function (@ie the
11139 ones set by the @samp{ORGTBL SEND} line) take precedence. So if you
11140 would like to use the La@TeX{} translator, but wanted the line endings to
11141 be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
11142 overrule the default with
11145 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
11148 For a new language, you can either write your own converter function in
11149 analogy with the La@TeX{} translator, or you can use the generic function
11150 directly. For example, if you have a language where a table is started
11151 with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are
11152 started with @samp{!BL!}, ended with @samp{!EL!}, and where the field
11153 separator is a TAB, you could call the generic translator like this (on
11157 #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
11158 :lstart "!BL! " :lend " !EL!" :sep "\t"
11162 Please check the documentation string of the function
11163 @code{orgtbl-to-generic} for a full list of parameters understood by
11164 that function, and remember that you can pass each of them into
11165 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
11166 using the generic function.
11168 Of course you can also write a completely new function doing complicated
11169 things the generic translator cannot do. A translator function takes
11170 two arguments. The first argument is the table, a list of lines, each
11171 line either the symbol @code{hline} or a list of fields. The second
11172 argument is the property list containing all parameters specified in the
11173 @samp{#+ORGTBL: SEND} line. The function must return a single string
11174 containing the formatted table. If you write a generally useful
11175 translator, please post it on @email{emacs-orgmode@@gnu.org} so that
11176 others can benefit from your work.
11178 @node Radio lists, , Translator functions, Tables in arbitrary syntax
11179 @subsection Radio lists
11180 @cindex radio lists
11181 @cindex org-list-insert-radio-list
11183 Sending and receiving radio lists works exactly the same way than sending and
11184 receiving radio tables (@pxref{Radio tables}). As for radio tables, you can
11185 insert radio lists templates in HTML, La@TeX{} and Texinfo modes by calling
11186 @code{org-list-insert-radio-list}.
11188 Here are the differences with radio tables:
11192 Use @code{ORGLST} instead of @code{ORGTBL}.
11194 The available translation functions for radio lists don't take
11197 @kbd{C-c C-c} will work when pressed on the first item of the list.
11200 Here is a La@TeX{} example. Let's say that you have this in your
11205 % BEGIN RECEIVE ORGLST to-buy
11206 % END RECEIVE ORGLST to-buy
11208 #+ORGLIST: SEND to-buy orgtbl-to-latex
11217 Pressing `C-c C-c' on @code{a new house} and will insert the converted
11218 La@TeX{} list between the two marker lines.
11220 @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Hacking
11221 @section Dynamic blocks
11222 @cindex dynamic blocks
11224 Org documents can contain @emph{dynamic blocks}. These are
11225 specially marked regions that are updated by some user-written function.
11226 A good example for such a block is the clock table inserted by the
11227 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
11229 Dynamic block are enclosed by a BEGIN-END structure that assigns a name
11230 to the block and can also specify parameters for the function producing
11231 the content of the block.
11233 #+BEGIN:dynamic block
11235 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
11240 Dynamic blocks are updated with the following commands
11243 @kindex C-c C-x C-u
11245 Update dynamic block at point.
11246 @kindex C-u C-c C-x C-u
11247 @item C-u C-c C-x C-u
11248 Update all dynamic blocks in the current file.
11251 Updating a dynamic block means to remove all the text between BEGIN and
11252 END, parse the BEGIN line for parameters and then call the specific
11253 writer function for this block to insert the new content. If you want
11254 to use the original content in the writer function, you can use the
11255 extra parameter @code{:content}.
11257 For a block with name @code{myblock}, the writer function is
11258 @code{org-dblock-write:myblock} with as only parameter a property list
11259 with the parameters given in the begin line. Here is a trivial example
11260 of a block that keeps track of when the block update function was last
11264 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
11270 The corresponding block writer function could look like this:
11273 (defun org-dblock-write:block-update-time (params)
11274 (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
11275 (insert "Last block update at: "
11276 (format-time-string fmt (current-time)))))
11279 If you want to make sure that all dynamic blocks are always up-to-date,
11280 you could add the function @code{org-update-all-dblocks} to a hook, for
11281 example @code{before-save-hook}. @code{org-update-all-dblocks} is
11282 written in a way such that it does nothing in buffers that are not in
11285 @node Special agenda views, Extracting agenda information, Dynamic blocks, Hacking
11286 @section Special agenda views
11287 @cindex agenda views, user-defined
11289 Org provides a special hook that can be used to narrow down the
11290 selection made by any of the agenda views. You may specify a function
11291 that is used at each match to verify if the match should indeed be part
11292 of the agenda view, and if not, how much should be skipped.
11294 Let's say you want to produce a list of projects that contain a WAITING
11295 tag anywhere in the project tree. Let's further assume that you have
11296 marked all tree headings that define a project with the TODO keyword
11297 PROJECT. In this case you would run a TODO search for the keyword
11298 PROJECT, but skip the match unless there is a WAITING tag anywhere in
11299 the subtree belonging to the project line.
11301 To achieve this, you must write a function that searches the subtree for
11302 the tag. If the tag is found, the function must return @code{nil} to
11303 indicate that this match should not be skipped. If there is no such
11304 tag, return the location of the end of the subtree, to indicate that
11305 search should continue from there.
11308 (defun my-skip-unless-waiting ()
11309 "Skip trees that are not waiting"
11310 (let ((subtree-end (save-excursion (org-end-of-subtree t))))
11311 (if (re-search-forward ":waiting:" subtree-end t)
11312 nil ; tag found, do not skip
11313 subtree-end))) ; tag not found, continue after end of subtree
11316 Now you may use this function in an agenda custom command, for example
11320 (org-add-agenda-custom-command
11321 '("b" todo "PROJECT"
11322 ((org-agenda-skip-function 'my-skip-unless-waiting)
11323 (org-agenda-overriding-header "Projects waiting for something: "))))
11326 @vindex org-agenda-overriding-header
11327 Note that this also binds @code{org-agenda-overriding-header} to get a
11328 meaningful header in the agenda view.
11330 @vindex org-odd-levels-only
11331 @vindex org-agenda-skip-function
11332 A general way to create custom searches is to base them on a search for
11333 entries with a certain level limit. If you want to study all entries with
11334 your custom search function, simply do a search for
11335 @samp{LEVEL>0}@footnote{Note that, when using @code{org-odd-levels-only}, a
11336 level number corresponds to order in the hierarchy, not to the number of
11337 stars.}, and then use @code{org-agenda-skip-function} to select the entries
11338 you really want to have.
11340 You may also put a Lisp form into @code{org-agenda-skip-function}. In
11341 particular, you may use the functions @code{org-agenda-skip-entry-if}
11342 and @code{org-agenda-skip-subtree-if} in this form, for example:
11345 @item '(org-agenda-skip-entry-if 'scheduled)
11346 Skip current entry if it has been scheduled.
11347 @item '(org-agenda-skip-entry-if 'notscheduled)
11348 Skip current entry if it has not been scheduled.
11349 @item '(org-agenda-skip-entry-if 'deadline)
11350 Skip current entry if it has a deadline.
11351 @item '(org-agenda-skip-entry-if 'scheduled 'deadline)
11352 Skip current entry if it has a deadline, or if it is scheduled.
11353 @item '(org-agenda-skip-entry-if 'timestamp)
11354 Skip current entry if it has any timestamp, may also be deadline or scheduled.
11355 @item '(org-agenda-skip-entry 'regexp "regular expression")
11356 Skip current entry if the regular expression matches in the entry.
11357 @item '(org-agenda-skip-entry 'notregexp "regular expression")
11358 Skip current entry unless the regular expression matches.
11359 @item '(org-agenda-skip-subtree-if 'regexp "regular expression")
11360 Same as above, but check and skip the entire subtree.
11363 Therefore we could also have written the search for WAITING projects
11364 like this, even without defining a special function:
11367 (org-add-agenda-custom-command
11368 '("b" todo "PROJECT"
11369 ((org-agenda-skip-function '(org-agenda-skip-subtree-if
11370 'regexp ":waiting:"))
11371 (org-agenda-overriding-header "Projects waiting for something: "))))
11374 @node Extracting agenda information, Using the property API, Special agenda views, Hacking
11375 @section Extracting agenda information
11376 @cindex agenda, pipe
11377 @cindex Scripts, for agenda processing
11379 @vindex org-agenda-custom-commands
11380 Org provides commands to access agenda information for the command
11381 line in Emacs batch mode. This extracted information can be sent
11382 directly to a printer, or it can be read by a program that does further
11383 processing of the data. The first of these commands is the function
11384 @code{org-batch-agenda}, that produces an agenda view and sends it as
11385 ASCII text to STDOUT. The command takes a single string as parameter.
11386 If the string has length 1, it is used as a key to one of the commands
11387 you have configured in @code{org-agenda-custom-commands}, basically any
11388 key you can use after @kbd{C-c a}. For example, to directly print the
11389 current TODO list, you could use
11392 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
11395 If the parameter is a string with 2 or more characters, it is used as a
11396 tags/TODO match string. For example, to print your local shopping list
11397 (all items with the tag @samp{shop}, but excluding the tag
11398 @samp{NewYork}), you could use
11401 emacs -batch -l ~/.emacs \
11402 -eval '(org-batch-agenda "+shop-NewYork")' | lpr
11406 You may also modify parameters on the fly like this:
11409 emacs -batch -l ~/.emacs \
11410 -eval '(org-batch-agenda "a" \
11411 org-agenda-ndays 30 \
11412 org-agenda-include-diary nil \
11413 org-agenda-files (quote ("~/org/project.org")))' \
11418 which will produce a 30-day agenda, fully restricted to the Org file
11419 @file{~/org/projects.org}, not even including the diary.
11421 If you want to process the agenda data in more sophisticated ways, you
11422 can use the command @code{org-batch-agenda-csv} to get a comma-separated
11423 list of values for each agenda item. Each line in the output will
11424 contain a number of fields separated by commas. The fields in a line
11428 category @r{The category of the item}
11429 head @r{The headline, without TODO keyword, TAGS and PRIORITY}
11430 type @r{The type of the agenda entry, can be}
11431 todo @r{selected in TODO match}
11432 tagsmatch @r{selected in tags match}
11433 diary @r{imported from diary}
11434 deadline @r{a deadline}
11435 scheduled @r{scheduled}
11436 timestamp @r{appointment, selected by timestamp}
11437 closed @r{entry was closed on date}
11438 upcoming-deadline @r{warning about nearing deadline}
11439 past-scheduled @r{forwarded scheduled item}
11440 block @r{entry has date block including date}
11441 todo @r{The TODO keyword, if any}
11442 tags @r{All tags including inherited ones, separated by colons}
11443 date @r{The relevant date, like 2007-2-14}
11444 time @r{The time, like 15:00-16:50}
11445 extra @r{String with extra planning info}
11446 priority-l @r{The priority letter if any was given}
11447 priority-n @r{The computed numerical priority}
11451 Time and date will only be given if a timestamp (or deadline/scheduled)
11452 led to the selection of the item.
11454 A CSV list like this is very easy to use in a post-processing script.
11455 For example, here is a Perl program that gets the TODO list from
11456 Emacs/Org and prints all the items, preceded by a checkbox:
11461 # define the Emacs command to run
11462 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
11464 # run it and capture the output
11465 $agenda = qx@{$cmd 2>/dev/null@};
11467 # loop over all lines
11468 foreach $line (split(/\n/,$agenda)) @{
11469 # get the individual values
11470 ($category,$head,$type,$todo,$tags,$date,$time,$extra,
11471 $priority_l,$priority_n) = split(/,/,$line);
11472 # process and print
11473 print "[ ] $head\n";
11477 @node Using the property API, Using the mapping API, Extracting agenda information, Hacking
11478 @section Using the property API
11479 @cindex API, for properties
11480 @cindex properties, API
11482 Here is a description of the functions that can be used to work with
11485 @defun org-entry-properties &optional pom which
11486 Get all properties of the entry at point-or-marker POM.@*
11487 This includes the TODO keyword, the tags, time strings for deadline,
11488 scheduled, and clocking, and any additional properties defined in the
11489 entry. The return value is an alist, keys may occur multiple times
11490 if the property key was used several times.@*
11491 POM may also be nil, in which case the current entry is used.
11492 If WHICH is nil or `all', get all properties. If WHICH is
11493 `special' or `standard', only get that subclass.
11495 @vindex org-use-property-inheritance
11496 @defun org-entry-get pom property &optional inherit
11497 Get value of PROPERTY for entry at point-or-marker POM. By default,
11498 this only looks at properties defined locally in the entry. If INHERIT
11499 is non-nil and the entry does not have the property, then also check
11500 higher levels of the hierarchy. If INHERIT is the symbol
11501 @code{selective}, use inheritance if and only if the setting of
11502 @code{org-use-property-inheritance} selects PROPERTY for inheritance.
11505 @defun org-entry-delete pom property
11506 Delete the property PROPERTY from entry at point-or-marker POM.
11509 @defun org-entry-put pom property value
11510 Set PROPERTY to VALUE for entry at point-or-marker POM.
11513 @defun org-buffer-property-keys &optional include-specials
11514 Get all property keys in the current buffer.
11517 @defun org-insert-property-drawer
11518 Insert a property drawer at point.
11521 @defun org-entry-put-multivalued-property pom property &rest values
11522 Set PROPERTY at point-or-marker POM to VALUES. VALUES should be a list of
11523 strings. They will be concatenated, with spaces as separators.
11526 @defun org-entry-get-multivalued-property pom property
11527 Treat the value of the property PROPERTY as a whitespace-separated list of
11528 values and return the values as a list of strings.
11531 @defun org-entry-add-to-multivalued-property pom property value
11532 Treat the value of the property PROPERTY as a whitespace-separated list of
11533 values and make sure that VALUE is in this list.
11536 @defun org-entry-remove-from-multivalued-property pom property value
11537 Treat the value of the property PROPERTY as a whitespace-separated list of
11538 values and make sure that VALUE is @emph{not} in this list.
11541 @defun org-entry-member-in-multivalued-property pom property value
11542 Treat the value of the property PROPERTY as a whitespace-separated list of
11543 values and check if VALUE is in this list.
11546 @node Using the mapping API, , Using the property API, Hacking
11547 @section Using the mapping API
11548 @cindex API, for mapping
11549 @cindex mapping entries, API
11551 Org has sophisticated mapping capabilities to find all entries satisfying
11552 certain criteria. Internally, this functionality is used to produce agenda
11553 views, but there is also an API that can be used to execute arbitrary
11554 functions for each or selected entries. The main entry point for this API
11557 @defun org-map-entries func &optional match scope &rest skip
11558 Call FUNC at each headline selected by MATCH in SCOPE.
11560 FUNC is a function or a Lisp form. The function will be called without
11561 arguments, with the cursor positioned at the beginning of the headline.
11562 The return values of all calls to the function will be collected and
11563 returned as a list.
11565 The call to FUNC will be wrapped into a save-excursion form, so FUNC
11566 does not need to preserve point. After evaluation, the cursor will be
11567 moved to the end of the line (presumably of the headline of the
11568 processed entry) and search continues from there. Under some
11569 circumstances, this may not produce the wanted results. For example,
11570 if you have removed (@eg archived) the current (sub)tree it could
11571 mean that the next entry will be skipped entirely. In such cases, you
11572 can specify the position from where search should continue by making
11573 FUNC set the variable `org-map-continue-from' to the desired buffer
11576 MATCH is a tags/property/todo match as it is used in the agenda match view.
11577 Only headlines that are matched by this query will be considered during
11578 the iteration. When MATCH is nil or t, all headlines will be
11579 visited by the iteration.
11581 SCOPE determines the scope of this command. It can be any of:
11584 nil @r{the current buffer, respecting the restriction if any}
11585 tree @r{the subtree started with the entry at point}
11586 file @r{the current buffer, without restriction}
11588 @r{the current buffer, and any archives associated with it}
11589 agenda @r{all agenda files}
11590 agenda-with-archives
11591 @r{all agenda files with any archive files associated with them}
11593 @r{if this is a list, all files in the list will be scanned}
11596 The remaining args are treated as settings for the skipping facilities of
11597 the scanner. The following items can be given here:
11599 @vindex org-agenda-skip-function
11601 archive @r{skip trees with the archive tag}
11602 comment @r{skip trees with the COMMENT keyword}
11603 function or Lisp form
11604 @r{will be used as value for @code{org-agenda-skip-function},}
11605 @r{so whenever the function returns t, FUNC}
11606 @r{will not be called for that entry and search will}
11607 @r{continue from the point where the function leaves it}
11611 The function given to that mapping routine can really do anything you like.
11612 It can use the property API (@pxref{Using the property API}) to gather more
11613 information about the entry, or in order to change metadata in the entry.
11614 Here are a couple of functions that might be handy:
11616 @defun org-todo &optional arg
11617 Change the TODO state of the entry, see the docstring of the functions for
11618 the many possible values for the argument ARG.
11621 @defun org-priority &optional action
11622 Change the priority of the entry, see the docstring of this function for the
11623 possible values for ACTION.
11626 @defun org-toggle-tag tag &optional onoff
11627 Toggle the tag TAG in the current entry. Setting ONOFF to either @code{on}
11628 or @code{off} will not toggle tag, but ensure that it is either on or off.
11632 Promote the current entry.
11636 Demote the current entry.
11639 Here is a simple example that will turn all entries in the current file with
11640 a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
11641 Entries in comment trees and in archive trees will be ignored.
11645 '(org-todo "UPCOMING")
11646 "+TOMORROW" 'file 'archive 'comment)
11649 The following example counts the number of entries with TODO keyword
11650 @code{WAITING}, in all agenda files.
11653 (length (org-map-entries t "/+WAITING" 'agenda))
11656 @node MobileOrg, History and Acknowledgments, Hacking, Top
11657 @appendix MobileOrg
11661 @i{MobileOrg} is an application for the @i{iPhone/iPod Touch} series of
11662 devices, developed by Richard Moreland. Instead of trying to implement the
11663 full feature set of Org and fighting with synchronization issues, this
11664 application chooses a different path. @i{MobileOrg} provides offline viewing
11665 and capture support for an Org-mode system rooted on a ``real'' computer.
11666 Synchronization issues are avoided by making @i{MobileOrg} only @i{write} to
11667 a special capture file, that is only @i{read} by the computer-based system.
11669 This appendix describes the support Org has for creating agenda views in a
11670 format that can be displayed by @i{MobileOrg}, and for integrating notes
11671 captured by @i{MobileOrg} into the main system. It does not cover the
11672 operation of @i{MobileOrg} itself (see @uref{http://ncogni.to/mobileorg/}).
11675 * Setting up the staging area:: Where to interact with the mobile device
11676 * Pushing to MobileOrg:: Uploading Org files and agendas
11677 * Pulling from MobileOrg:: Integrating captured and flagged items
11680 @node Setting up the staging area, Pushing to MobileOrg, MobileOrg, MobileOrg
11681 @section Setting up the staging area
11683 Org-mode has commands to prepare a directory with files for @i{MobileOrg},
11684 and to read captured notes from there. If Emacs can directly write to the
11685 WebDAV directory accessed by @i{MobileOrg}, all you need to do is to point to
11686 this directory using the variable @code{org-mobile-directory}.
11688 If Emacs cannot access the WebDAV directory directly, you can use a local
11689 directory for staging. Other means must then be used to keep this directory
11690 in sync with the WebDAV directory. In the following example, files are
11691 staged in @file{~/stage}, and Org-mode hooks take care of moving files to and
11692 from the WebDAV directory using @file{scp}.
11695 (setq org-mobile-directory "~/stage/")
11696 (add-hook 'org-mobile-post-push-hook
11698 (shell-command "scp ~/stage/* user@@webdavhost:mobile/")))
11699 (add-hook 'org-mobile-pre-pull-hook
11701 (shell-command "scp user@@webdavhost:mobile/mobileorg.org ~/stage/ ")))
11702 (add-hook 'org-mobile-post-pull-hook
11704 (shell-command "scp ~/stage/mobileorg.org user@@webdavhost:mobile/")))
11707 @node Pushing to MobileOrg, Pulling from MobileOrg, Setting up the staging area, MobileOrg
11708 @section Pushing to MobileOrg
11710 This operation copies all files currently listed in @code{org-mobile-files}
11711 to the directory @code{org-mobile-directory}. By default this list contains
11712 all agenda files (as listed in @code{org-agenda-files}), but additional files
11713 can be included by customizing @code{org-mobiles-files}. The push operation
11714 also creates (in the same directory) a special Org file @file{agendas.org}.
11715 This file is an Org-mode style outline, containing every custom agenda view
11716 defined by the user. While creating the agendas, Org-mode will
11717 force@footnote{See the variable @code{org-mobile-force-id-on-agenda-items}.}
11718 an ID property on all entries referenced by the agendas, so that these
11719 entries can be uniquely identified if @i{MobileOrg} flags them for further
11720 action. Finally, Org writes the file @file{index.org}, containing links to
11721 all other files. If @i{MobileOrg} is configured to request this file from
11722 the WebDAV server, all agendas and Org files will be downloaded to the
11723 iPhone. To speed up the download, MobileOrg will only read files whose
11724 checksums@footnote{stored automatically in the file @file{checksums.dat}}
11727 @node Pulling from MobileOrg, , Pushing to MobileOrg, MobileOrg
11728 @section Pulling from MobileOrg
11730 When @i{MobileOrg} synchronizes with the WebDAV server, it not only pulls the
11731 Org files for viewing. It also appends captured entries and pointers to
11732 flagged entries to the file @file{mobileorg.org} on the server. Org has
11733 a @emph{pull} operation that integrates this information into an inbox file
11734 and operates on the pointers to flagged entries. Here is how it works:
11738 Org moves all entries found in
11739 @file{mobileorg.org}@footnote{@file{mobileorg.org} will be empty after this
11740 operation.} and appends them to the file pointed to by the variable
11741 @code{org-mobile-inbox-for-pull}. Each captured entry will be a top-level
11742 entry in the inbox file.
11744 After moving the entries, Org will attempt to act on the flags. Some flags
11745 specify simple operations that will be executed directly and without user
11746 interaction. Examples are marking an entry as DONE and/or archiving
11747 it@footnote{as specified by the variable @code{org-archive-default-action}}.
11748 All other flagged entries will receive a tag @code{:FLAGGED:}, so that they
11749 can be easily found again. When there is a problem finding the entry that
11750 should be flagged, the pointer entry will remain in the inbox and will be
11751 marked with an error message.
11753 Org will then generate an agenda view with all flagged entries. The user
11754 should then go through these entries and do whatever actions are necessary.
11755 If a note has been stored while flagging an entry in @i{MobileOrg}, that note
11756 will be displayed in the echo area when the cursor is on the corresponding
11761 Pressing @kbd{?} in that special agenda will display the full flagging note in
11762 another window and also push it onto the kill ring. So you could use @kbd{?
11763 z C-y C-c C-c} to store that flagging note as a normal note in the entry.
11764 Pressing @kbd{?} twice in succession will offer to remove the
11765 @code{:FLAGGED:} tag along with the recorded flagging note (which is stored
11771 If you are not able to process all flagged entries directly, you can always
11772 return to this agenda view using @kbd{C-c a ?}. Note, however, that there is
11773 a subtle difference. The view created automatically by @kbd{M-x
11774 org-mobile-pull RET} is guaranteed to search all files that have been
11775 addressed by the last pull. This might include a file that is not currently
11776 in your list of agenda files. If you later use @kbd{C-c a ?} to regenerate
11777 the view, only the current agenda files will be searched.
11779 @node History and Acknowledgments, Main Index, MobileOrg, Top
11780 @appendix History and Acknowledgments
11781 @cindex acknowledgments
11785 Org was born in 2003, out of frustration over the user interface
11786 of the Emacs Outline mode. I was trying to organize my notes and
11787 projects, and using Emacs seemed to be the natural way to go. However,
11788 having to remember eleven different commands with two or three keys per
11789 command, only to hide and show parts of the outline tree, that seemed
11790 entirely unacceptable to me. Also, when using outlines to take notes, I
11791 constantly wanted to restructure the tree, organizing it parallel to my
11792 thoughts and plans. @emph{Visibility cycling} and @emph{structure
11793 editing} were originally implemented in the package
11794 @file{outline-magic.el}, but quickly moved to the more general
11795 @file{org.el}. As this environment became comfortable for project
11796 planning, the next step was adding @emph{TODO entries}, basic
11797 @emph{timestamps}, and @emph{table support}. These areas highlighted the two main
11798 goals that Org still has today: to be a new, outline-based,
11799 plain text mode with innovative and intuitive editing features, and to
11800 incorporate project planning functionality directly into a notes file.
11802 A special thanks goes to @i{Bastien Guerry} who has not only written a large
11803 number of extensions to Org (most of them integrated into the core by now),
11804 but who has also helped in the development and maintenance of Org so much that he
11805 should be considered the main co-contributor to this package.
11807 Since the first release, literally thousands of emails to me or to
11808 @email{emacs-orgmode@@gnu.org} have provided a constant stream of bug
11809 reports, feedback, new ideas, and sometimes patches and add-on code.
11810 Many thanks to everyone who has helped to improve this package. I am
11811 trying to keep here a list of the people who had significant influence
11812 in shaping one or more aspects of Org. The list may not be
11813 complete, if I have forgotten someone, please accept my apologies and
11819 @i{Russel Adams} came up with the idea for drawers.
11821 @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
11823 @i{Christophe Bataillon} created the great unicorn logo that we use on the
11826 @i{Alex Bochannek} provided a patch for rounding timestamps.
11828 @i{Brad Bozarth} showed how to pull RSS feed data into Org-mode files.
11830 @i{Tom Breton} wrote @file{org-choose.el}.
11832 @i{Charles Cave}'s suggestion sparked the implementation of templates
11835 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
11838 @i{Gregory Chernov} patched support for Lisp forms into table
11839 calculations and improved XEmacs compatibility, in particular by porting
11840 @file{nouline.el} to XEmacs.
11842 @i{Sacha Chua} suggested copying some linking code from Planner.
11844 @i{Baoqiu Cui} contributed the DocBook exporter.
11846 @i{Eddward DeVilla} proposed and tested checkbox statistics. He also
11847 came up with the idea of properties, and that there should be an API for
11850 @i{Nick Dokos} tracked down several nasty bugs.
11852 @i{Kees Dullemond} used to edit projects lists directly in HTML and so
11853 inspired some of the early development, including HTML export. He also
11854 asked for a way to narrow wide table columns.
11856 @i{Christian Egli} converted the documentation into Texinfo format,
11857 patched CSS formatting into the HTML exporter, and inspired the agenda.
11859 @i{David Emery} provided a patch for custom CSS support in exported
11862 @i{Nic Ferrier} contributed mailcap and XOXO support.
11864 @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
11866 @i{John Foerch} figured out how to make incremental search show context
11867 around a match in a hidden outline tree.
11869 @i{Niels Giesen} had the idea to automatically archive DONE trees.
11871 @i{Bastien Guerry} wrote the La@TeX{} exporter and @file{org-bibtex.el}, and
11872 has been prolific with patches, ideas, and bug reports.
11874 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
11876 @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
11877 task state change logging, and the clocktable. His clear explanations have
11878 been critical when we started to adopt the Git version control system.
11880 @i{Manuel Hermenegildo} has contributed various ideas, small fixes and
11883 @i{Phil Jackson} wrote @file{org-irc.el}.
11885 @i{Scott Jaderholm} proposed footnotes, control over whitespace between
11886 folded entries, and column view for properties.
11888 @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
11890 @i{Shidai Liu} ("Leo") asked for embedded La@TeX{} and tested it. He also
11891 provided frequent feedback and some patches.
11893 @i{Matt Lundin} has proposed last-row references for table formulas and named
11894 invisible anchors. He has also worked a lot on the FAQ.
11896 @i{Jason F. McBrayer} suggested agenda export to CSV format.
11898 @i{Max Mikhanosha} came up with the idea of refiling.
11900 @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
11903 @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
11906 @i{Richard Moreland} wrote @i{MobileOrg} for the iPhone.
11908 @i{Rick Moynihan} proposed allowing multiple TODO sequences in a file
11909 and being able to quickly restrict the agenda to a subtree.
11911 @i{Todd Neal} provided patches for links to Info files and Elisp forms.
11913 @i{Greg Newman} refreshed the unicorn logo into its current form.
11915 @i{Tim O'Callaghan} suggested in-file links, search options for general
11916 file links, and TAGS.
11918 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
11921 @i{Oliver Oppitz} suggested multi-state TODO items.
11923 @i{Scott Otterson} sparked the introduction of descriptive text for
11924 links, among other things.
11926 @i{Pete Phillips} helped during the development of the TAGS feature, and
11927 provided frequent feedback.
11929 @i{Martin Pohlack} provided the code snippet to bundle character insertion
11930 into bundles of 20 for undo.
11932 @i{T.V. Raman} reported bugs and suggested improvements.
11934 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
11937 @i{Paul Rivier} provided the basic implementation of named footnotes.
11939 @i{Kevin Rogers} contributed code to access VM files on remote hosts.
11941 @i{Sebastian Rose} wrote @file{org-info.js}, a Java script for displaying
11942 webpages derived from Org using an Info-like or a folding interface with
11943 single-key navigation.
11945 @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
11946 conflict with @file{allout.el}.
11948 @i{Jason Riedy} generalized the send-receive mechanism for Orgtbl tables with
11951 @i{Philip Rooke} created the Org reference card, provided lots
11952 of feedback, developed and applied standards to the Org documentation.
11954 @i{Christian Schlauer} proposed angular brackets around links, among
11957 @i{Eric Schulte} wrote @file{org-plot.el} and contributed various patches,
11958 small features and modules.
11960 Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
11961 @file{organizer-mode.el}.
11963 @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal
11964 examples, and remote highlighting for referenced code lines.
11966 @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
11967 now packaged into Org's @file{contrib} directory.
11969 @i{Daniel Sinder} came up with the idea of internal archiving by locking
11972 @i{Dale Smith} proposed link abbreviations.
11974 @i{James TD Smith} has contributed a large number of patches for useful
11975 tweaks and features.
11977 @i{Adam Spiers} asked for global linking commands, inspired the link
11978 extension system, added support for mairix, and proposed the mapping API.
11980 @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content
11981 with links transformation to Org syntax.
11983 @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
11984 chapter about publishing.
11986 @i{J@"urgen Vollmer} contributed code generating the table of contents
11989 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
11992 @i{David Wainberg} suggested archiving, and improvements to the linking
11995 @i{John Wiegley} wrote @file{emacs-wiki.el}, @file{planner.el}, and
11996 @file{muse.el}, which have some overlap with Org. Initially the development
11997 of Org was fully independent because I was not aware of the existence of
11998 these packages. But with time I have occasionally looked at John's code and
11999 learned a lot from it. John has also contributed a number of great ideas and
12000 patches directly to Org, including the attachment system
12001 (@file{org-attach.el}), integration with Apple Mail
12002 (@file{org-mac-message.el}), and hierarchical dependencies of TODO items.
12004 @i{Carsten Wimmer} suggested some changes and helped fix a bug in
12007 @i{Roland Winkler} requested additional key bindings to make Org
12010 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
12011 and contributed various ideas and code snippets.
12015 @node Main Index, Key Index, History and Acknowledgments, Top
12016 @unnumbered Concept Index
12020 @node Key Index, Variable Index, Main Index, Top
12021 @unnumbered Key Index
12025 @node Variable Index, , Key Index, Top
12026 @unnumbered Variable Index
12028 This is not a complete index of variables and faces, only the ones that are
12029 mentioned in the manual. For a more complete list, use @kbd{M-x
12030 org-customize @key{RET}} and then klick yourself through the tree.
12037 arch-tag: 7893d1Fe-cc57-4d13-b5e5-f494a1CBC7ac
12040 @c Local variables:
12041 @c ispell-local-dictionary: "en_US-w_accents"
12042 @c ispell-local-pdict: "./.aspell.org.pws"
12047 @c LocalWords: webdavhost pre