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 Subheadings inside a table.
21 @macro tsubheading{text}
31 This manual is for Org version @value{VERSION}.
33 Copyright @copyright{} 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation
36 Permission is granted to copy, distribute and/or modify this document
37 under the terms of the GNU Free Documentation License, Version 1.3 or
38 any later version published by the Free Software Foundation; with no
39 Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
40 and with the Back-Cover Texts as in (a) below. A copy of the license
41 is included in the section entitled ``GNU Free Documentation License.''
43 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
44 modify this GNU manual. Buying copies from the FSF supports it in
45 developing GNU and promoting software freedom.''
47 This document is part of a collection distributed under the GNU Free
48 Documentation License. If you want to distribute this document
49 separately from the collection, you can do so by adding a copy of the
50 license to the document, as described in section 6 of the license.
56 * Org Mode: (org). Outline-based notes management and organizer
62 @subtitle Release @value{VERSION}
63 @author by Carsten Dominik
65 @c The following two commands start the copyright page.
67 @vskip 0pt plus 1filll
71 @c Output the table of contents at the beginning.
75 @node Top, Introduction, (dir), (dir)
82 * Introduction:: Getting started
83 * Document Structure:: A tree works like your brain
84 * Tables:: Pure magic for quick formatting
85 * Hyperlinks:: Notes in context
86 * TODO Items:: Every tree branch can be a TODO item
87 * Tags:: Tagging headlines and matching sets of tags
88 * Properties and Columns:: Storing information about an entry
89 * Dates and Times:: Making items useful for planning
90 * Capture:: Creating tasks and attaching files
91 * Agenda Views:: Collecting information into views
92 * Embedded LaTeX:: LaTeX fragments and formulas
93 * Exporting:: Sharing and publishing of notes
94 * Publishing:: Create a web site of linked Org files
95 * Miscellaneous:: All the rest which did not fit elsewhere
96 * Hacking:: How to hack your way around
97 * History and Acknowledgments:: How Org came into being
98 * Main Index:: An index of Org's concepts and features
99 * Key Index:: Key bindings and where they are described
100 * Variable and Faces Index:: Index for variables and faces discussed
103 --- The Detailed Node Listing ---
107 * Summary:: Brief summary of what Org does
108 * Installation:: How to install a downloaded version of Org
109 * Activation:: How to activate Org for certain buffers
110 * Feedback:: Bug reports, ideas, patches etc.
111 * Conventions:: Type-setting conventions in the manual
115 * Outlines:: Org is based on Outline mode
116 * Headlines:: How to typeset Org tree headlines
117 * Visibility cycling:: Show and hide, much simplified
118 * Motion:: Jumping to other headlines
119 * Structure editing:: Changing sequence and level of headlines
120 * Archiving:: Move done task trees to a different place
121 * Sparse trees:: Matches embedded in context
122 * Plain lists:: Additional structure within an entry
123 * Drawers:: Tucking stuff away
124 * Footnotes:: How footnotes are defined in Org's syntax
125 * Orgstruct mode:: Structure editing outside Org
129 * ARCHIVE tag:: Marking a tree as inactive
130 * Moving subtrees:: Moving a tree to an archive file
134 * Built-in table editor:: Simple tables
135 * Narrow columns:: Stop wasting space in tables
136 * Column groups:: Grouping to trigger vertical lines
137 * Orgtbl mode:: The table editor as minor mode
138 * The spreadsheet:: The table editor has spreadsheet capabilities
139 * Org Plot:: Plotting from org tables
143 * References:: How to refer to another field or range
144 * Formula syntax for Calc:: Using Calc to compute stuff
145 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
146 * Field formulas:: Formulas valid for a single field
147 * Column formulas:: Formulas valid for an entire column
148 * Editing and debugging formulas:: Fixing formulas
149 * Updating the table:: Recomputing all dependent fields
150 * Advanced features:: Field names, parameters and automatic recalc
154 * Link format:: How links in Org are formatted
155 * Internal links:: Links to other places in the current file
156 * External links:: URL-like links to the world
157 * Handling links:: Creating, inserting and following
158 * Using links outside Org:: Linking from my C source code?
159 * Link abbreviations:: Shortcuts for writing complex links
160 * Search options:: Linking to a specific location
161 * Custom searches:: When the default search is not enough
165 * Radio targets:: Make targets trigger links in plain text
169 * TODO basics:: Marking and displaying TODO entries
170 * TODO extensions:: Workflow and assignments
171 * Progress logging:: Dates and notes for progress
172 * Priorities:: Some things are more important than others
173 * Breaking down tasks:: Splitting a task into manageable pieces
174 * Checkboxes:: Tick-off lists
176 Extended use of TODO keywords
178 * Workflow states:: From TODO to DONE in steps
179 * TODO types:: I do this, Fred does the rest
180 * Multiple sets in one file:: Mixing it all, and still finding your way
181 * Fast access to TODO states:: Single letter selection of a state
182 * Per-file keywords:: Different files, different requirements
183 * Faces for TODO keywords:: Highlighting states
184 * TODO dependencies:: When one task needs to wait for others
188 * Closing items:: When was this entry marked DONE?
189 * Tracking TODO state changes:: When did the status change?
193 * Tag inheritance:: Tags use the tree structure of the outline
194 * Setting tags:: How to assign tags to a headline
195 * Tag searches:: Searching for combinations of tags
197 Properties and Columns
199 * Property syntax:: How properties are spelled out
200 * Special properties:: Access to other Org mode features
201 * Property searches:: Matching property values
202 * Property inheritance:: Passing values down the tree
203 * Column view:: Tabular viewing and editing
204 * Property API:: Properties for Lisp programmers
208 * Defining columns:: The COLUMNS format property
209 * Using column view:: How to create and use column view
210 * Capturing column view:: A dynamic block for column view
214 * Scope of column definitions:: Where defined, where valid?
215 * Column attributes:: Appearance and content of a column
219 * Timestamps:: Assigning a time to a tree entry
220 * Creating timestamps:: Commands which insert timestamps
221 * Deadlines and scheduling:: Planning your work
222 * Clocking work time:: Tracking how long you spend on a task
223 * Effort estimates:: Planning work effort in advance
224 * Relative timer:: Notes with a running timer
228 * The date/time prompt:: How Org mode helps you entering date and time
229 * Custom time format:: Making dates look different
231 Deadlines and scheduling
233 * Inserting deadline/schedule:: Planning items
234 * Repeated tasks:: Items that show up again and again
238 * Remember:: Capture new tasks/ideas with little interruption
239 * RSS Feeds:: Getting input from RSS feeds
240 * Attachments:: Add files to tasks.
244 * Setting up Remember:: Some code for .emacs to get things going
245 * Remember templates:: Define the outline of different note types
246 * Storing notes:: Directly get the note to where it belongs
247 * Refiling notes:: Moving a note or task to a project
251 * Agenda files:: Files being searched for agenda information
252 * Agenda dispatcher:: Keyboard access to agenda views
253 * Built-in agenda views:: What is available out of the box?
254 * Presentation and sorting:: How agenda items are prepared for display
255 * Agenda commands:: Remote editing of Org trees
256 * Custom agenda views:: Defining special searches and views
257 * Agenda column view:: Using column view for collected entries
259 The built-in agenda views
261 * Weekly/daily agenda:: The calendar page with current tasks
262 * Global TODO list:: All unfinished action items
263 * Matching tags and properties:: Structured information with fine-tuned search
264 * Timeline:: Time-sorted view for single file
265 * Keyword search:: Finding entries by keyword
266 * Stuck projects:: Find projects you need to review
268 Presentation and sorting
270 * Categories:: Not all tasks are equal
271 * Time-of-day specifications:: How the agenda knows the time
272 * Sorting of agenda items:: The order of things
276 * Storing searches:: Type once, use often
277 * Block agenda:: All the stuff you need in a single buffer
278 * Setting Options:: Changing the rules
279 * Exporting Agenda Views:: Writing agendas to files
280 * Using the agenda elsewhere:: Using agenda information in other programs
284 * Math symbols:: TeX macros for symbols and Greek letters
285 * Subscripts and superscripts:: Simple syntax for raising/lowering text
286 * LaTeX fragments:: Complex formulas made easy
287 * Processing LaTeX fragments:: Previewing LaTeX processing
288 * CDLaTeX mode:: Speed up entering of formulas
292 * Markup rules:: Which structures are recognized?
293 * Selective export:: Using tags to select and exclude trees
294 * Export options:: Per-file export settings
295 * The export dispatcher:: How to access exporter commands
296 * ASCII export:: Exporting to plain ASCII
297 * HTML export:: Exporting to HTML
298 * LaTeX and PDF export:: Exporting to LaTeX, and processing to PDF
299 * Docbook export:: Exporting to Docbook
300 * XOXO export:: Exporting to XOXO
301 * iCalendar export:: Exporting in iCalendar format
305 * Document title:: How the document title is determined
306 * Headings and sections:: The main structure of the exported document
307 * Table of contents:: If, where, how to create a table of contents
308 * Initial text:: Text before the first headline
309 * Lists:: Plain lists are exported
310 * Paragraphs:: What determines beginning and ending
311 * Literal examples:: Source code and other examples
312 * Include files:: Include the contents of a file during export
313 * Tables exported:: Tables are exported richly
314 * Inlined images:: How to inline images during export
315 * Footnote markup:: ASCII representation of footnotes
316 * Emphasis and monospace:: To bold or not to bold
317 * TeX macros and LaTeX fragments:: Create special, rich export.
318 * Horizontal rules:: A line across the page
319 * Comment lines:: Some lines will not be exported
320 * Macro replacement:: Global replacement of place holdes
324 * HTML Export commands:: How to invoke HTML export
325 * Quoting HTML tags:: Using direct HTML in Org mode
326 * Links:: Transformation of links for HTML
327 * Images in HTML export:: How to insert figures into HTML output
328 * Text areas in HTML export:: An alternative way to show an example
329 * CSS support:: Changing the appearance of the output
330 * Javascript support:: Info and Folding in a web browser
334 * LaTeX/PDF export commands:: Which key invokes which commands
335 * Quoting LaTeX code:: Incorporating literal LaTeX code
336 * Sectioning structure:: Changing sectioning in LaTeX output
337 * Tables in LaTeX export:: Options for exporting tables to LaTeX
338 * Images in LaTeX export:: How to insert figures into LaTeX output
342 * Configuration:: Defining projects
343 * Uploading files:: How to get files up on the server
344 * Sample configuration:: Example projects
345 * Triggering publication:: Publication commands
349 * Project alist:: The central configuration variable
350 * Sources and destinations:: From here to there
351 * Selecting files:: What files are part of the project?
352 * Publishing action:: Setting the function doing the publishing
353 * Publishing options:: Tweaking HTML export
354 * Publishing links:: Which links keep working after publishing?
355 * Project page index:: Publishing a list of project files
359 * Simple example:: One-component publishing
360 * Complex example:: A multi-component publishing example
364 * Completion:: M-TAB knows what you need
365 * Customization:: Adapting Org to your taste
366 * In-buffer settings:: Overview of the #+KEYWORDS
367 * The very busy C-c C-c key:: When in doubt, press C-c C-c
368 * Clean view:: Getting rid of leading stars in the outline
369 * TTY keys:: Using Org on a tty
370 * Interaction:: Other Emacs packages
372 Interaction with other packages
374 * Cooperation:: Packages Org cooperates with
375 * Conflicts:: Packages that lead to conflicts
379 * Hooks:: Who to reach into Org's internals
380 * Add-on packages:: Available extensions
381 * Adding hyperlink types:: New custom link types
382 * Context-sensitive commands:: How to add functioality to such commands
383 * Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs
384 * Dynamic blocks:: Automatically filled blocks
385 * Special agenda views:: Customized views
386 * Using the property API:: Writing programs that use entry properties
387 * Using the mapping API:: Mapping over all or selected entries
389 Tables and lists in arbitrary syntax
391 * Radio tables:: Sending and receiving
392 * A LaTeX example:: Step by step, almost a tutorial
393 * Translator functions:: Copy and modify
394 * Radio lists:: Doing the same for lists
399 @node Introduction, Document Structure, Top, Top
400 @chapter Introduction
404 * Summary:: Brief summary of what Org does
405 * Installation:: How to install a downloaded version of Org
406 * Activation:: How to activate Org for certain buffers
407 * Feedback:: Bug reports, ideas, patches etc.
408 * Conventions:: Type-setting conventions in the manual
411 @node Summary, Installation, Introduction, Introduction
415 Org is a mode for keeping notes, maintaining TODO lists, and doing
416 project planning with a fast and effective plain-text system.
418 Org develops organizational tasks around NOTES files that contain
419 lists or information about projects as plain text. Org is
420 implemented on top of Outline mode, which makes it possible to keep the
421 content of large files well structured. Visibility cycling and
422 structure editing help to work with the tree. Tables are easily created
423 with a built-in table editor. Org supports TODO items, deadlines,
424 time stamps, and scheduling. It dynamically compiles entries into an
425 agenda that utilizes and smoothly integrates much of the Emacs calendar
426 and diary. Plain text URL-like links connect to websites, emails,
427 Usenet messages, BBDB entries, and any files related to the projects.
428 For printing and sharing of notes, an Org file can be exported as a
429 structured ASCII file, as HTML, or (TODO and agenda items only) as an
430 iCalendar file. It can also serve as a publishing tool for a set of
433 An important design aspect that distinguishes Org from for example
434 Planner/Muse is that it encourages to store every piece of information
435 only once. In Planner, you have project pages, day pages and possibly
436 other files, duplicating some information such as tasks. In Org,
437 you only have notes files. In your notes you mark entries as tasks,
438 label them with tags and timestamps. All necessary lists like a
439 schedule for the day, the agenda for a meeting, tasks lists selected by
440 tags etc are created dynamically when you need them.
442 Org keeps simple things simple. When first fired up, it should
443 feel like a straightforward, easy to use outliner. Complexity is not
444 imposed, but a large amount of functionality is available when you need
445 it. Org is a toolbox and can be used in different ways, for
449 @r{@bullet{} outline extension with visibility cycling and structure editing}
450 @r{@bullet{} ASCII system and table editor for taking structured notes}
451 @r{@bullet{} ASCII table editor with spreadsheet-like capabilities}
452 @r{@bullet{} TODO list editor}
453 @r{@bullet{} full agenda and planner with deadlines and work scheduling}
454 @r{@bullet{} environment to implement David Allen's GTD system}
455 @r{@bullet{} a basic database application}
456 @r{@bullet{} simple hypertext system, with HTML and LaTeX export}
457 @r{@bullet{} publishing tool to create a set of interlinked webpages}
460 Org's automatic, context sensitive table editor with spreadsheet
461 capabilities can be integrated into any major mode by activating the
462 minor Orgtbl mode. Using a translation step, it can be used to maintain
463 tables in arbitrary file types, for example in La@TeX{}. The structure
464 editing and list creation capabilities can be used outside Org with
465 the minor Orgstruct mode.
468 There is a website for Org which provides links to the newest
469 version of Org, as well as additional information, frequently asked
470 questions (FAQ), links to tutorials etc. This page is located at
471 @uref{http://orgmode.org}.
476 @node Installation, Activation, Summary, Introduction
477 @section Installation
481 @b{Important:} @i{If Org is part of the Emacs distribution or an
482 XEmacs package, please skip this section and go directly to
485 If you have downloaded Org from the Web, either as a distribution @file{.zip}
486 or @file{.tar} file, or as a GIT archive, you must take the following steps
487 to install it: Go into the unpacked Org distribution directory and edit the
488 top section of the file @file{Makefile}. You must set the name of the Emacs
489 binary (likely either @file{emacs} or @file{xemacs}), and the paths to the
490 directories where local Lisp and Info files are kept. If you don't have
491 access to the system-wide directories, you can simply run Org directly from
492 the distribution directory by adding the @file{lisp} subdirectory to the
493 Emacs load path. To do this, add the following line to @file{.emacs}:
496 (setq load-path (cons "~/path/to/orgdir/lisp" load-path))
500 If you plan to use code from the @file{contrib} subdirectory, do a similar
501 step for this directory:
504 (setq load-path (cons "~/path/to/orgdir/contrib/lisp" load-path))
507 @b{XEmacs users now need to install the file @file{noutline.el} from
508 the @file{xemacs} sub-directory of the Org distribution. Use the
512 @b{make install-noutline}
515 @noindent Now byte-compile the Lisp files with the shell command:
521 @noindent If you are running Org from the distribution directory, this is
522 all. If you want to install into the system directories, use (as
528 Installing Info files is system dependent, because of differences in the
529 @file{install-info} program. In Debian it does copy the info files into the
530 correct directory and modifies the info directory file. In many other
531 systems, the files need to be copied to the correct directory separately, and
532 @file{install-info} then only modifies the directory file. Check your system
533 documentation to find out which of the following commands you need:
537 make install-info-debian
540 @noindent Then add to @file{.emacs}:
543 ;; This line only if Org is not part of the X/Emacs distribution.
544 (require 'org-install)
547 Do not forget to activate Org as described in the following section.
549 @node Activation, Feedback, Installation, Introduction
553 @cindex global key bindings
554 @cindex key bindings, global
557 @b{Important:} @i{If you use copy-and-paste to copy lisp code from the
558 PDF documentation as viewed by some PDF viewers to your .emacs file, the
559 single quote character comes out incorrectly and the code will not work.
560 You need to fix the single quotes by hand, or copy from Info
564 Add the following lines to your @file{.emacs} file. The last three lines
565 define @emph{global} keys for the commands @command{org-store-link},
566 @command{org-agenda}, and @command{org-iswitchb} - please choose suitable
570 ;; The following lines are always needed. Choose your own keys.
571 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
572 (global-set-key "\C-cl" 'org-store-link)
573 (global-set-key "\C-ca" 'org-agenda)
574 (global-set-key "\C-cb" 'org-iswitchb)
577 Furthermore, you must activate @code{font-lock-mode} in Org
578 buffers, because significant functionality depends on font-locking being
579 active. You can do this with either one of the following two lines
580 (XEmacs user must use the second option):
582 (global-font-lock-mode 1) ; for all buffers
583 (add-hook 'org-mode-hook 'turn-on-font-lock) ; Org buffers only
586 @cindex Org mode, turning on
587 With this setup, all files with extension @samp{.org} will be put
588 into Org mode. As an alternative, make the first line of a file look
592 MY PROJECTS -*- mode: org; -*-
595 @vindex org-insert-mode-line-in-empty-file
596 @noindent which will select Org mode for this buffer no matter what
597 the file's name is. See also the variable
598 @code{org-insert-mode-line-in-empty-file}.
600 Many commands in Org work on the region if the region is @i{active}. To make
601 use of this, you need to have @code{transient-mark-mode}
602 (@code{zmacs-regions} in XEmacs) turned on. In Emacs 23 this is the default,
603 in Emacs 22 you need to do this yourself with
605 (transient-mark-mode 1)
607 @noindent If you do not like @code{transient-make-mode}, you can create an
608 active region by using the mouse to select a region, or pressing
609 @kbd{C-@key{SPC}} twice before moving the cursor.
611 @node Feedback, Conventions, Activation, Introduction
618 If you find problems with Org, or if you have questions, remarks, or ideas
619 about it, please mail to the Org mailing list @code{emacs-orgmode@@gnu.org}.
620 If you are not a member of the mailing list, your mail will be reviewed by a
621 moderator and then passed through to the list.
623 For bug reports, please provide as much information as possible,
624 including the version information of Emacs (@kbd{C-h v emacs-version
625 @key{RET}}) and Org (@kbd{C-h v org-version @key{RET}}), as well as
626 the Org related setup in @file{.emacs}. If an error occurs, a
627 backtrace can be very useful (see below on how to create one). Often a
628 small example file helps, along with clear information about:
631 @item What exactly did you do?
632 @item What did you expect to happen?
633 @item What happened instead?
635 @noindent Thank you for helping to improve this mode.
637 @subsubheading How to create a useful backtrace
639 @cindex backtrace of an error
640 If working with Org produces an error with a message you don't
641 understand, you may have hit a bug. The best way to report this is by
642 providing, in addition to what was mentioned above, a @emph{Backtrace}.
643 This is information from the built-in debugger about where and how the
644 error occurred. Here is how to produce a useful backtrace:
648 Reload uncompiled versions of all Org-mode lisp files. The backtrace
649 contains much more information if it is produced with uncompiled code.
652 C-u M-x org-reload RET
654 or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the
657 Go to the @code{Options} menu and select @code{Enter Debugger on Error}
658 (XEmacs has this option in the @code{Troubleshooting} sub-menu).
660 Do whatever you have to do to hit the error. Don't forget to
661 document the steps you take.
663 When you hit the error, a @file{*Backtrace*} buffer will appear on the
664 screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and
665 attach it to your bug report.
668 @node Conventions, , Feedback, Introduction
669 @section Typesetting conventions used in this manual
671 Org uses three types of keywords: TODO keywords, tags, and property
672 names. In this manual we use the following conventions:
677 TODO keywords are written with all capitals, even if they are
681 User-defined tags are written in lowercase; built-in tags with special
682 meaning are written with all capitals.
685 User-defined properties are capitalized; built-in properties with
686 special meaning are written with all capitals.
689 @node Document Structure, Tables, Introduction, Top
690 @chapter Document Structure
691 @cindex document structure
692 @cindex structure of document
694 Org is based on outline mode and provides flexible commands to
695 edit the structure of the document.
698 * Outlines:: Org is based on Outline mode
699 * Headlines:: How to typeset Org tree headlines
700 * Visibility cycling:: Show and hide, much simplified
701 * Motion:: Jumping to other headlines
702 * Structure editing:: Changing sequence and level of headlines
703 * Archiving:: Move done task trees to a different place
704 * Sparse trees:: Matches embedded in context
705 * Plain lists:: Additional structure within an entry
706 * Drawers:: Tucking stuff away
707 * Footnotes:: How footnotes are defined in Org's syntax
708 * Orgstruct mode:: Structure editing outside Org
711 @node Outlines, Headlines, Document Structure, Document Structure
716 Org is implemented on top of Outline mode. Outlines allow a
717 document to be organized in a hierarchical structure, which (at least
718 for me) is the best representation of notes and thoughts. An overview
719 of this structure is achieved by folding (hiding) large parts of the
720 document to show only the general document structure and the parts
721 currently being worked on. Org greatly simplifies the use of
722 outlines by compressing the entire show/hide functionality into a single
723 command @command{org-cycle}, which is bound to the @key{TAB} key.
725 @node Headlines, Visibility cycling, Outlines, Document Structure
729 @vindex org-special-ctrl-a/e
731 Headlines define the structure of an outline tree. The headlines in
732 Org start with one or more stars, on the left margin@footnote{See
733 the variable @code{org-special-ctrl-a/e} to configure special behavior
734 of @kbd{C-a} and @kbd{C-e} in headlines.}. For example:
744 * Another top level headline
747 @noindent Some people find the many stars too noisy and would prefer an
748 outline that has whitespace followed by a single star as headline
749 starters. @ref{Clean view} describes a setup to realize this.
751 @vindex org-cycle-separator-lines
752 An empty line after the end of a subtree is considered part of it and
753 will be hidden when the subtree is folded. However, if you leave at
754 least two empty lines, one empty line will remain visible after folding
755 the subtree, in order to structure the collapsed view. See the
756 variable @code{org-cycle-separator-lines} to modify this behavior.
758 @node Visibility cycling, Motion, Headlines, Document Structure
759 @section Visibility cycling
760 @cindex cycling, visibility
761 @cindex visibility cycling
762 @cindex trees, visibility
763 @cindex show hidden text
766 Outlines make it possible to hide parts of the text in the buffer.
767 Org uses just two commands, bound to @key{TAB} and
768 @kbd{S-@key{TAB}} to change the visibility in the buffer.
770 @cindex subtree visibility states
771 @cindex subtree cycling
772 @cindex folded, subtree visibility state
773 @cindex children, subtree visibility state
774 @cindex subtree, subtree visibility state
778 @emph{Subtree cycling}: Rotate current subtree among the states
781 ,-> FOLDED -> CHILDREN -> SUBTREE --.
782 '-----------------------------------'
785 @vindex org-cycle-emulate-tab
786 @vindex org-cycle-global-at-bob
787 The cursor must be on a headline for this to work@footnote{see, however,
788 the option @code{org-cycle-emulate-tab}.}. When the cursor is at the
789 beginning of the buffer and the first line is not a headline, then
790 @key{TAB} actually runs global cycling (see below)@footnote{see the
791 option @code{org-cycle-global-at-bob}.}. Also when called with a prefix
792 argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
794 @cindex global visibility states
795 @cindex global cycling
796 @cindex overview, global visibility state
797 @cindex contents, global visibility state
798 @cindex show all, global visibility state
802 @emph{Global cycling}: Rotate the entire buffer among the states
805 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
806 '--------------------------------------'
809 When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
810 CONTENTS view up to headlines of level N will be shown. Note that inside
811 tables, @kbd{S-@key{TAB}} jumps to the previous field.
813 @cindex show all, command
814 @kindex C-u C-u C-u @key{TAB}
815 @item C-u C-u C-u @key{TAB}
816 Show all, including drawers.
819 Reveal context around point, showing the current entry, the following heading
820 and the hierarchy above. Useful for working near a location that has been
821 exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
822 (@pxref{Agenda commands}). With a prefix argument show, on each
823 level, all sibling headings.
826 Show the current subtree in an indirect buffer@footnote{The indirect
829 (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
832 (see the Emacs manual for more information about indirect buffers)
834 will contain the entire buffer, but will be narrowed to the current
835 tree. Editing the indirect buffer will also change the original buffer,
836 but without affecting visibility in that buffer.}. With a numeric
837 prefix argument N, go up to level N and then take that tree. If N is
838 negative then go up that many levels. With a @kbd{C-u} prefix, do not remove
839 the previously used indirect buffer.
842 @vindex org-startup-folded
843 When Emacs first visits an Org file, the global state is set to
844 OVERVIEW, i.e. only the top level headlines are visible. This can be
845 configured through the variable @code{org-startup-folded}, or on a
846 per-file basis by adding one of the following lines anywhere in the
856 Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
857 and Columns}) will get their visibility adapted accordingly. Allowed values
858 for this property are @code{folded}, @code{children}, @code{content}, and
861 @kindex C-u C-u @key{TAB}
862 @item C-u C-u @key{TAB}
863 Switch back to the startup visibility of the buffer, i.e. whatever is
864 requested by startup options and @samp{VISIBILITY} properties in individual
868 @node Motion, Structure editing, Visibility cycling, Document Structure
870 @cindex motion, between headlines
871 @cindex jumping, to headlines
872 @cindex headline navigation
873 The following commands jump to other headlines in the buffer.
884 Next heading same level.
887 Previous heading same level.
890 Backward to higher level heading.
893 Jump to a different place without changing the current outline
894 visibility. Shows the document structure in a temporary buffer, where
895 you can use the following keys to find your destination:
896 @vindex org-goto-auto-isearch
898 @key{TAB} @r{Cycle visibility.}
899 @key{down} / @key{up} @r{Next/previous visible headline.}
900 @key{RET} @r{Select this location.}
901 @kbd{/} @r{Do a Sparse-tree search}
902 @r{The following keys work if you turn off @code{org-goto-auto-isearch}}
903 n / p @r{Next/previous visible headline.}
904 f / b @r{Next/previous headline same level.}
906 0-9 @r{Digit argument.}
909 @vindex org-goto-interface
910 See also the variable @code{org-goto-interface}.
913 @node Structure editing, Archiving, Motion, Document Structure
914 @section Structure editing
915 @cindex structure editing
916 @cindex headline, promotion and demotion
917 @cindex promotion, of subtrees
918 @cindex demotion, of subtrees
919 @cindex subtree, cut and paste
920 @cindex pasting, of subtrees
921 @cindex cutting, of subtrees
922 @cindex copying, of subtrees
923 @cindex subtrees, cut and paste
928 @vindex org-M-RET-may-split-line
929 Insert new heading with same level as current. If the cursor is in a
930 plain list item, a new item is created (@pxref{Plain lists}). To force
931 creation of a new headline, use a prefix argument, or first press @key{RET}
932 to get to the beginning of the next line. When this command is used in
933 the middle of a line, the line is split and the rest of the line becomes
934 the new headline@footnote{If you do not want the line to be split,
935 customize the variable @code{org-M-RET-may-split-line}.}. If the
936 command is used at the beginning of a headline, the new headline is
937 created before the current line. If at the beginning of any other line,
938 the content of that line is made the new heading. If the command is
939 used at the end of a folded subtree (i.e. behind the ellipses at the end
940 of a headline), then a headline like the current one will be inserted
941 after the end of the subtree.
944 Just like @kbd{M-@key{RET}}, except when adding a new heading below the
945 current heading, the new heading is placed after the body instead of before
946 it. This command works from anywhere in the entry.
947 @kindex M-S-@key{RET}
949 Insert new TODO entry with same level as current heading.
950 @kindex C-S-@key{RET}
952 Insert new TODO entry with same level as current heading. Like
953 @kbd{C-@key{RET}}, the new headline will be inserted after the current
957 Promote current heading by one level.
958 @kindex M-@key{right}
960 Demote current heading by one level.
961 @kindex M-S-@key{left}
963 Promote the current subtree by one level.
964 @kindex M-S-@key{right}
965 @item M-S-@key{right}
966 Demote the current subtree by one level.
969 Move subtree up (swap with previous subtree of same
971 @kindex M-S-@key{down}
973 Move subtree down (swap with next subtree of same level).
976 Kill subtree, i.e. remove it from buffer but save in kill ring.
977 With a numeric prefix argument N, kill N sequential subtrees.
980 Copy subtree to kill ring. With a numeric prefix argument N, copy the N
984 Yank subtree from kill ring. This does modify the level of the subtree to
985 make sure the tree fits in nicely at the yank position. The yank level can
986 also be specified with a numeric prefix argument, or by yanking after a
987 headline marker like @samp{****}.
990 @vindex org-yank-adjusted-subtrees
991 @vindex org-yank-folded-subtrees
992 Depending on the variables @code{org-yank-adjusted-subtrees} and
993 @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
994 paste subtrees folded and in a clever way, using the same command as @kbd{C-c
995 C-x C-y}. With the default settings, no level adjustment will take place,
996 but the yanked tree will be folded unless doing so would swallow text
997 previously visible. Any prefix argument to this command will force a normal
998 @code{yank} to be executed, with the prefix passed along. A good way to
999 force a normal yank is @kbd{C-u C-y}. If you use @code{yank-pop} after a
1000 yank, it will yank previous kill items plainly, without adjustment and
1004 Clone a subtree by making a number of sibling copies of it. You will be
1005 prompted for the number of copies to make, and you can also specify if any
1006 time stamps in the entry should be shifted. This can be useful, for example,
1007 to create a number of tasks related to a series of lectures to prepare. For
1008 more details, see the docstring of the command
1009 @code{org-clone-subtree-with-time-shift}.
1012 Refile entry or region to a different location. @xref{Refiling notes}.
1015 Sort same-level entries. When there is an active region, all entries in the
1016 region will be sorted. Otherwise the children of the current headline are
1017 sorted. The command prompts for the sorting method, which can be
1018 alphabetically, numerically, by time (using the first time stamp in each
1019 entry), by priority, or by TODO keyword (in the sequence the keywords have
1020 been defined in the setup). Reverse sorting is possible as well. You can
1021 also supply your own function to extract the sorting key. With a @kbd{C-u}
1022 prefix, sorting will be case-sensitive. With two @kbd{C-u C-u} prefixes,
1023 duplicate entries will also be removed.
1026 Narrow buffer to current subtree.
1029 Widen buffer to remove a narrowing.
1032 Turn a normal line or plain list item into a headline (so that it becomes a
1033 subheading at its location). Also turn a headline into a normal line by
1034 removing the stars. If there is an active region, turn all lines in the
1035 region into headlines. If the first line in the region was an item, turn
1036 only the item lines into headlines. Finally, if the first line is a
1037 headline, remove the stars from all headlines in the region.
1040 @cindex region, active
1041 @cindex active region
1042 @cindex Transient mark mode
1043 When there is an active region (Transient mark mode), promotion and
1044 demotion work on all headlines in the region. To select a region of
1045 headlines, it is best to place both point and mark at the beginning of a
1046 line, mark at the beginning of the first headline, and point at the line
1047 just after the last headline to change. Note that when the cursor is
1048 inside a table (@pxref{Tables}), the Meta-Cursor keys have different
1051 @node Archiving, Sparse trees, Structure editing, Document Structure
1055 When a project represented by a (sub)tree is finished, you may want
1056 to move the tree out of the way and to stop it from contributing to the
1057 agenda. Org mode knows two ways of archiving. You can mark a tree with
1058 the ARCHIVE tag, or you can move an entire (sub)tree to a different
1062 * ARCHIVE tag:: Marking a tree as inactive
1063 * Moving subtrees:: Moving a tree to an archive file
1066 @node ARCHIVE tag, Moving subtrees, Archiving, Archiving
1067 @subsection The ARCHIVE tag
1068 @cindex internal archiving
1070 A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
1071 its location in the outline tree, but behaves in the following way:
1074 @vindex org-cycle-open-archived-trees
1075 It does not open when you attempt to do so with a visibility cycling
1076 command (@pxref{Visibility cycling}). You can force cycling archived
1077 subtrees with @kbd{C-@key{TAB}}, or by setting the option
1078 @code{org-cycle-open-archived-trees}. Also normal outline commands like
1079 @code{show-all} will open archived subtrees.
1081 @vindex org-sparse-tree-open-archived-trees
1082 During sparse tree construction (@pxref{Sparse trees}), matches in
1083 archived subtrees are not exposed, unless you configure the option
1084 @code{org-sparse-tree-open-archived-trees}.
1086 @vindex org-agenda-skip-archived-trees
1087 During agenda view construction (@pxref{Agenda Views}), the content of
1088 archived trees is ignored unless you configure the option
1089 @code{org-agenda-skip-archived-trees}, in which case these trees will always
1090 be included. In the agenda you can press the @kbd{v} key to get archives
1091 temporarily included.
1093 @vindex org-export-with-archived-trees
1094 Archived trees are not exported (@pxref{Exporting}), only the headline
1095 is. Configure the details using the variable
1096 @code{org-export-with-archived-trees}.
1098 @vindex org-columns-skip-arrchived-trees
1099 Archived trees are excluded from column view unless the variable
1100 @code{org-columns-skip-arrchived-trees} is configured to @code{nil}.
1103 The following commands help managing the ARCHIVE tag:
1108 Toggle the ARCHIVE tag for the current headline. When the tag is set,
1109 the headline changes to a shadowed face, and the subtree below it is
1111 @kindex C-u C-c C-x a
1113 Check if any direct children of the current headline should be archived.
1114 To do this, each subtree is checked for open TODO entries. If none are
1115 found, the command offers to set the ARCHIVE tag for the child. If the
1116 cursor is @emph{not} on a headline when this command is invoked, the
1117 level 1 trees will be checked.
1120 Cycle a tree even if it is tagged with ARCHIVE.
1123 @node Moving subtrees, , ARCHIVE tag, Archiving
1124 @subsection Moving subtrees
1125 @cindex external archiving
1127 Once an entire project is finished, you may want to move it to a different
1128 location. Org can move it to an @emph{Archive Sibling} in the same tree, to a
1129 different tree in the current file, or to a different file, the archive file.
1134 Move the current entry to the @emph{Archive Sibling}. This is a sibling of
1135 the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}
1136 (@pxref{ARCHIVE tag}). The entry becomes a child of that sibling and in this
1137 way retains a lot of its original context, including inherited tags and
1138 approximate position in the outline.
1143 @vindex org-archive-location
1144 Archive the subtree starting at the cursor position to the location
1145 given by @code{org-archive-location}. Context information that could be
1146 lost like the file name, the category, inherited tags, and the TODO
1147 state will be store as properties in the entry.
1148 @kindex C-u C-c C-x C-s
1149 @item C-u C-c C-x C-s
1150 Check if any direct children of the current headline could be moved to
1151 the archive. To do this, each subtree is checked for open TODO entries.
1152 If none are found, the command offers to move it to the archive
1153 location. If the cursor is @emph{not} on a headline when this command
1154 is invoked, the level 1 trees will be checked.
1157 @cindex archive locations
1158 The default archive location is a file in the same directory as the
1159 current file, with the name derived by appending @file{_archive} to the
1160 current file name. For information and examples on how to change this,
1161 see the documentation string of the variable
1162 @code{org-archive-location}. There is also an in-buffer option for
1163 setting this variable, for example@footnote{For backward compatibility,
1164 the following also works: If there are several such lines in a file,
1165 each specifies the archive location for the text below it. The first
1166 such line also applies to any text before its definition. However,
1167 using this method is @emph{strongly} deprecated as it is incompatible
1168 with the outline structure of the document. The correct method for
1169 setting multiple archive locations in a buffer is using properties.}:
1172 #+ARCHIVE: %s_done::
1176 If you would like to have a special ARCHIVE location for a single entry
1177 or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
1178 location as the value (@pxref{Properties and Columns}).
1180 @vindex org-archive-save-context-info
1181 When a subtree is moved, it receives a number of special properties that
1182 record context information like the file from where the entry came, it's
1183 outline path the archiving time etc. Configure the variable
1184 @code{org-archive-save-context-info} to adjust the amount of information
1187 @node Sparse trees, Plain lists, Archiving, Document Structure
1188 @section Sparse trees
1189 @cindex sparse trees
1190 @cindex trees, sparse
1191 @cindex folding, sparse trees
1192 @cindex occur, command
1194 @vindex org-show-hierarchy-above
1195 @vindex org-show-following-heading
1196 @vindex org-show-siblings
1197 @vindex org-show-entry-below
1198 An important feature of Org mode is the ability to construct @emph{sparse
1199 trees} for selected information in an outline tree, so that the entire
1200 document is folded as much as possible, but the selected information is made
1201 visible along with the headline structure above it@footnote{See also the
1202 variables @code{org-show-hierarchy-above}, @code{org-show-following-heading},
1203 @code{org-show-siblings}, and @code{org-show-entry-below} for detailed
1204 control on how much context is shown around each match.}. Just try it out
1205 and you will see immediately how it works.
1207 Org mode contains several commands creating such trees, all these
1208 commands can be accessed through a dispatcher:
1213 This prompts for an extra key to select a sparse-tree creating command.
1216 @vindex org-remove-highlights-with-change
1217 Occur. Prompts for a regexp and shows a sparse tree with all matches. If
1218 the match is in a headline, the headline is made visible. If the match is in
1219 the body of an entry, headline and body are made visible. In order to
1220 provide minimal context, also the full hierarchy of headlines above the match
1221 is shown, as well as the headline following the match. Each match is also
1222 highlighted; the highlights disappear when the buffer is changed by an
1223 editing command@footnote{depending on the option
1224 @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
1225 When called with a @kbd{C-u} prefix argument, previous highlights are kept,
1226 so several calls to this command can be stacked.
1230 @vindex org-agenda-custom-commands
1231 For frequently used sparse trees of specific search strings, you can
1232 use the variable @code{org-agenda-custom-commands} to define fast
1233 keyboard access to specific sparse trees. These commands will then be
1234 accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
1238 (setq org-agenda-custom-commands
1239 '(("f" occur-tree "FIXME")))
1242 @noindent will define the key @kbd{C-c a f} as a shortcut for creating
1243 a sparse tree matching the string @samp{FIXME}.
1245 The other sparse tree commands select headings based on TODO keywords,
1246 tags, or properties and will be discussed later in this manual.
1249 @cindex printing sparse trees
1250 @cindex visible text, printing
1251 To print a sparse tree, you can use the Emacs command
1252 @code{ps-print-buffer-with-faces} which does not print invisible parts
1253 of the document @footnote{This does not work under XEmacs, because
1254 XEmacs uses selective display for outlining, not text properties.}.
1255 Or you can use the command @kbd{C-c C-e v} to export only the visible
1256 part of the document and print the resulting file.
1258 @node Plain lists, Drawers, Sparse trees, Document Structure
1259 @section Plain lists
1261 @cindex lists, plain
1262 @cindex lists, ordered
1263 @cindex ordered lists
1265 Within an entry of the outline tree, hand-formatted lists can provide
1266 additional structure. They also provide a way to create lists of
1267 checkboxes (@pxref{Checkboxes}). Org supports editing such lists,
1268 and the HTML exporter (@pxref{Exporting}) parses and formats them.
1270 Org knows ordered lists, unordered lists, and description lists.
1273 @emph{Unordered} list items start with @samp{-}, @samp{+}, or
1274 @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
1275 they will be seen as top-level headlines. Also, when you are hiding leading
1276 stars to get a clean outline view, plain list items starting with a star are
1277 visually indistinguishable from true headlines. In short: even though
1278 @samp{*} is supported, it may be better to not use it for plain list items.}
1281 @emph{Ordered} list items start with a numeral followed by either a period or
1282 a right parenthesis, such as @samp{1.} or @samp{1)}.
1284 @emph{Description} list items are like unordered list items, but contain the
1285 separator @samp{ :: } to separate the description @emph{term} from the
1289 @vindex org-empty-line-terminates-plain-lists
1290 Items belonging to the same list must have the same indentation on the first
1291 line. In particular, if an ordered list reaches number @samp{10.}, then the
1292 2--digit numbers must be written left-aligned with the other numbers in the
1293 list. Indentation also determines the end of a list item. It ends before
1294 the next line that is indented like the bullet/number, or less. Empty lines
1295 are part of the previous item, so you can have several paragraphs in one
1296 item. If you would like an empty line to terminate all currently open plain
1297 lists, configure the variable @code{org-empty-line-terminates-plain-lists}.
1302 ** Lord of the Rings
1303 My favorite scenes are (in this order)
1304 1. The attack of the Rohirrim
1305 2. Eowyn's fight with the witch king
1306 + this was already my favorite scene in the book
1307 + I really like Miranda Otto.
1308 3. Peter Jackson being shot by Legolas
1310 He makes a really funny face when it happens.
1311 But in the end, no individual scenes matter but the film as a whole.
1312 Important actors in this film are:
1313 - @b{Elijah Wood} :: He plays Frodo
1314 - @b{Sean Austin} :: He plays Sam, Frodo's friend. I still remember
1315 him very well from his role as Mikey Walsh in the Goonies.
1319 Org supports these lists by tuning filling and wrapping commands to
1320 deal with them correctly@footnote{Org only changes the filling
1321 settings for Emacs. For XEmacs, you should use Kyle E. Jones'
1322 @file{filladapt.el}. To turn this on, put into @file{.emacs}:
1323 @code{(require 'filladapt)}}, and by exporting them properly
1324 (@pxref{Exporting}).
1326 The following commands act on items when the cursor is in the first line
1327 of an item (the line with the bullet or number).
1332 @vindex org-cycle-include-plain-lists
1333 Items can be folded just like headline levels if you set the variable
1334 @code{org-cycle-include-plain-lists}. The level of an item is then
1335 given by the indentation of the bullet/number. Items are always
1336 subordinate to real headlines, however; the hierarchies remain
1337 completely separated.
1339 If @code{org-cycle-include-plain-lists} has not been set, @key{TAB}
1340 fixes the indentation of the current line in a heuristic way.
1343 @vindex org-M-RET-may-split-line
1344 Insert new item at current level. With a prefix argument, force a new
1345 heading (@pxref{Structure editing}). If this command is used in the middle
1346 of a line, the line is @emph{split} and the rest of the line becomes the new
1347 item@footnote{If you do not want the line to be split, customize the variable
1348 @code{org-M-RET-may-split-line}.}. If this command is executed in the
1349 @emph{whitespace before a bullet or number}, the new item is created
1350 @emph{before} the current item. If the command is executed in the white
1351 space before the text that is part of an item but does not contain the
1352 bullet, a bullet is added to the current line.
1353 @kindex M-S-@key{RET}
1355 Insert a new item with a checkbox (@pxref{Checkboxes}).
1357 @kindex S-@key{down}
1360 @cindex shift-selection-mode
1361 @vindex org-support-shift-select
1362 Jump to the previous/next item in the current list, but only if
1363 @code{org-support-shift-select} is off. If not, you can still use paragraph
1364 jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite
1366 @kindex M-S-@key{up}
1367 @kindex M-S-@key{down}
1369 @itemx M-S-@key{down}
1370 Move the item including subitems up/down (swap with previous/next item
1371 of same indentation). If the list is ordered, renumbering is
1373 @kindex M-S-@key{left}
1374 @kindex M-S-@key{right}
1375 @item M-S-@key{left}
1376 @itemx M-S-@key{right}
1377 Decrease/increase the indentation of the item, including subitems.
1378 Initially, the item tree is selected based on current indentation.
1379 When these commands are executed several times in direct succession,
1380 the initially selected region is used, even if the new indentation
1381 would imply a different hierarchy. To use the new hierarchy, break
1382 the command chain with a cursor motion or so.
1385 If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
1386 state of the checkbox. If not, this command makes sure that all the
1387 items on this list level use the same bullet. Furthermore, if this is
1388 an ordered list, make sure the numbering is OK.
1391 Cycle the entire list level through the different itemize/enumerate bullets
1392 (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}). With a numeric prefix
1393 argument N, select the Nth bullet from this list. If there is an active
1394 region when calling this, all lines will be converted to list items. If the
1395 first line already was a list item, any item markers will be removed from the
1396 list. Finally, even without an active region, a normal line will be
1397 converted into a list item.
1398 @kindex S-@key{left}
1399 @kindex S-@key{right}
1400 @item S-@key{left}/@key{right}
1401 @vindex org-support-shift-select
1402 This command also cycles bullet styles when the cursor in on the bullet or
1403 anywhere in an item line, details depending on
1404 @code{org-support-shift-select}.
1407 @node Drawers, Footnotes, Plain lists, Document Structure
1410 @cindex visibility cycling, drawers
1413 Sometimes you want to keep information associated with an entry, but you
1414 normally don't want to see it. For this, Org mode has @emph{drawers}.
1415 Drawers need to be configured with the variable
1416 @code{org-drawers}@footnote{You can define drawers on a per-file basis
1417 with a line like @code{#+DRAWERS: HIDDEN PROPERTIES STATE}}. Drawers
1421 ** This is a headline
1422 Still outside the drawer
1424 This is inside the drawer.
1429 Visibility cycling (@pxref{Visibility cycling}) on the headline will hide and
1430 show the entry, but keep the drawer collapsed to a single line. In order to
1431 look inside the drawer, you need to move the cursor to the drawer line and
1432 press @key{TAB} there. Org mode uses the @code{PROPERTIES} drawer for
1433 storing properties (@pxref{Properties and Columns}), and you can also arrange
1434 for state change notes @pxref{Tracking TODO state changes} and clock times
1435 (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}.
1437 @node Footnotes, Orgstruct mode, Drawers, Document Structure
1441 Org-mode supports the creation of footnotes. In contrast to the
1442 @file{footnote.el} package, Org-mode's footnotes are designed for work on a
1443 larger document, not only for one-off documents like emails. The basic
1444 syntax is similar to the one used by @file{footnote.el}, i.e. a footnote is
1445 defined in a paragraph that is started by a footnote marker in square
1446 brackets in column 0, no indentation allowed. If you need a paragraph break
1447 inside a footnote, use the LaTeX idiom @samp{\par}. The footnote reference
1448 is simply the marker in square brackets, inside text. For example:
1451 The Org homepage[fn:1] now looks a lot better than it used to.
1453 [fn:1] The link is: http://orgmode.org
1456 Org-mode extends the number-based syntax to @emph{named} footnotes and
1457 optional inline definition. Using plain numbers as markers (as
1458 @file{footnote.el} does) is supported for backward compatibility, but not
1459 encouraged because of possible conflicts with LaTeX snippets @pxref{Embedded
1460 LaTeX}. Here are the valid references:
1464 A plain numeric footnote marker.
1466 A named footnote reference, where @code{name} is a unique label word, or, for
1467 simplicity of automatic creation, a number.
1468 @item [fn:: This is the inline definition of this footnote]
1469 A LaTeX-like anonymous footnote where the definition is given directly at the
1471 @item [fn:name: a definition]
1472 An inline definition of a footnote, which also specifies a name for the note.
1473 Since Org allows multiple references to the same note, you can then use
1474 @code{[fn:name]} to create additional references.
1477 @vindex org-footnote-auto-label
1478 Footnote labels can be created automatically, or you create names yourself.
1479 This is handled by the variable @code{org-footnote-auto-label} and its
1480 corresponding @code{#+STARTUP} keywords, see the docstring of that variable
1483 @noindent The following command handles footnotes:
1488 The footnote action command.
1490 When the cursor is on a footnote reference, jump to the definition. When it
1491 is at a definition, jump to the (first) reference.
1493 @vindex org-footnote-define-inline
1494 @vindex org-footnote-section
1495 Otherwise, create a new footnote. Depending on the variable
1496 @code{org-footnote-define-inline}@footnote{The corresponding in-buffer
1497 setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
1498 definition will be placed right into the text as part of the reference, or
1499 separately into the location determined by the variable
1500 @code{org-footnote-section}.
1502 When this command is called with a prefix argument, a menu of additional
1505 s @r{Sort the footnote definitions by reference sequence. During editing,}
1506 @r{Org makes no effort to sort footnote definitions into a particular}
1507 @r{sequence. If you want them sorted, use this command, which will}
1508 @r{also move entries according to @code{org-footnote-section}.}
1509 n @r{Normalize the footnotes by collecting all definitions (including}
1510 @r{inline definitions) into a special section, and then numbering them}
1511 @r{in sequence. The references will then also be numbers. This is}
1512 @r{meant to be the final step before finishing a document (e.g. sending}
1513 @r{off an email). The exporters do this automatically, and so could}
1514 @r{something like @code{message-send-hook}.}
1515 d @r{Delete the footnote at point, and all definitions of and references}
1520 If the cursor is on a footnote reference, jump to the definition. If it is a
1521 the definition, jump back to the reference. When called at a footnote
1522 location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
1526 @item C-c C-c @r{or} mouse-1/2
1527 Footnote labels are also links to the corresponding definition/reference, and
1528 you can use the usual commands to follow these links.
1531 @node Orgstruct mode, , Footnotes, Document Structure
1532 @section The Orgstruct minor mode
1533 @cindex Orgstruct mode
1534 @cindex minor mode for structure editing
1536 If you like the intuitive way the Org mode structure editing and list
1537 formatting works, you might want to use these commands in other modes like
1538 Text mode or Mail mode as well. The minor mode @code{orgstruct-mode} makes
1539 this possible. Toggle the mode with @kbd{M-x orgstruct-mode}, or
1540 turn it on by default, for example in Mail mode, with one of:
1543 (add-hook 'mail-mode-hook 'turn-on-orgstruct)
1544 (add-hook 'mail-mode-hook 'turn-on-orgstruct++)
1547 When this mode is active and the cursor is on a line that looks to Org like a
1548 headline or the first line of a list item, most structure editing commands
1549 will work, even if the same keys normally have different functionality in the
1550 major mode you are using. If the cursor is not in one of those special
1551 lines, Orgstruct mode lurks silently in the shadow. When you use
1552 @code{orgstruct++-mode}, Org will also export indentation and autofill
1553 settings into that mode, and detect item context after the first line of an
1556 @node Tables, Hyperlinks, Document Structure, Top
1559 @cindex editing tables
1561 Org comes with a fast and intuitive table editor. Spreadsheet-like
1562 calculations are supported in connection with the Emacs @file{calc}
1565 (@pxref{Top,Calc,,Calc,Gnu Emacs Calculator Manual}).
1568 (see the Emacs Calculator manual for more information about the Emacs
1573 * Built-in table editor:: Simple tables
1574 * Narrow columns:: Stop wasting space in tables
1575 * Column groups:: Grouping to trigger vertical lines
1576 * Orgtbl mode:: The table editor as minor mode
1577 * The spreadsheet:: The table editor has spreadsheet capabilities
1578 * Org Plot:: Plotting from org tables
1581 @node Built-in table editor, Narrow columns, Tables, Tables
1582 @section The built-in table editor
1583 @cindex table editor, built-in
1585 Org makes it easy to format tables in plain ASCII. Any line with
1586 @samp{|} as the first non-whitespace character is considered part of a
1587 table. @samp{|} is also the column separator. A table might look like
1591 | Name | Phone | Age |
1592 |-------+-------+-----|
1593 | Peter | 1234 | 17 |
1594 | Anna | 4321 | 25 |
1597 A table is re-aligned automatically each time you press @key{TAB} or
1598 @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to
1599 the next field (@key{RET} to the next row) and creates new table rows
1600 at the end of the table or before horizontal lines. The indentation
1601 of the table is set by the first line. Any line starting with
1602 @samp{|-} is considered as a horizontal separator line and will be
1603 expanded on the next re-align to span the whole table width. So, to
1604 create the above table, you would only type
1611 @noindent and then press @key{TAB} to align the table and start filling in
1612 fields. Even faster would be to type @code{|Name|Phone|Age} followed by
1613 @kbd{C-c @key{RET}}.
1615 @vindex org-enable-table-editor
1616 @vindex org-table-auto-blank-field
1617 When typing text into a field, Org treats @key{DEL},
1618 @key{Backspace}, and all character keys in a special way, so that
1619 inserting and deleting avoids shifting other fields. Also, when
1620 typing @emph{immediately after the cursor was moved into a new field
1621 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
1622 field is automatically made blank. If this behavior is too
1623 unpredictable for you, configure the variables
1624 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
1627 @tsubheading{Creation and conversion}
1630 Convert the active region to table. If every line contains at least one
1631 TAB character, the function assumes that the material is tab separated.
1632 If every line contains a comma, comma-separated values (CSV) are assumed.
1633 If not, lines are split at whitespace into fields. You can use a prefix
1634 argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
1635 C-u} forces TAB, and a numeric argument N indicates that at least N
1636 consecutive spaces, or alternatively a TAB will be the separator.
1638 If there is no active region, this command creates an empty Org
1639 table. But it's easier just to start typing, like
1640 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
1642 @tsubheading{Re-aligning and field motion}
1645 Re-align the table without moving the cursor.
1649 Re-align the table, move to the next field. Creates a new row if
1654 Re-align, move to previous field.
1658 Re-align the table and move down to next row. Creates a new row if
1659 necessary. At the beginning or end of a line, @key{RET} still does
1660 NEWLINE, so it can be used to split a table.
1664 Move to beginning of the current table field, or on to the previous field.
1667 Move to end of the current table field, or on to the next field.
1669 @tsubheading{Column and row editing}
1670 @kindex M-@key{left}
1671 @kindex M-@key{right}
1673 @itemx M-@key{right}
1674 Move the current column left/right.
1676 @kindex M-S-@key{left}
1677 @item M-S-@key{left}
1678 Kill the current column.
1680 @kindex M-S-@key{right}
1681 @item M-S-@key{right}
1682 Insert a new column to the left of the cursor position.
1685 @kindex M-@key{down}
1688 Move the current row up/down.
1690 @kindex M-S-@key{up}
1692 Kill the current row or horizontal line.
1694 @kindex M-S-@key{down}
1695 @item M-S-@key{down}
1696 Insert a new row above the current row. With a prefix argument, the line is
1697 created below the current one.
1701 Insert a horizontal line below current row. With a prefix argument, the line
1702 is created above the current line.
1704 @kindex C-c @key{RET}
1706 Insert a horizontal line below current row, and move the cursor into the row
1711 Sort the table lines in the region. The position of point indicates the
1712 column to be used for sorting, and the range of lines is the range
1713 between the nearest horizontal separator lines, or the entire table. If
1714 point is before the first column, you will be prompted for the sorting
1715 column. If there is an active region, the mark specifies the first line
1716 and the sorting column, while point should be in the last line to be
1717 included into the sorting. The command prompts for the sorting type
1718 (alphabetically, numerically, or by time). When called with a prefix
1719 argument, alphabetic sorting will be case-sensitive.
1721 @tsubheading{Regions}
1724 Copy a rectangular region from a table to a special clipboard. Point
1725 and mark determine edge fields of the rectangle. The process ignores
1726 horizontal separator lines.
1730 Copy a rectangular region from a table to a special clipboard, and
1731 blank all fields in the rectangle. So this is the ``cut'' operation.
1735 Paste a rectangular region into a table.
1736 The upper left corner ends up in the current field. All involved fields
1737 will be overwritten. If the rectangle does not fit into the present table,
1738 the table is enlarged as needed. The process ignores horizontal separator
1743 Wrap several fields in a column like a paragraph. If there is an active
1744 region, and both point and mark are in the same column, the text in the
1745 column is wrapped to minimum width for the given number of lines. A numeric
1746 prefix argument may be used to change the number of desired lines. If there
1747 is no region, the current field is split at the cursor position and the text
1748 fragment to the right of the cursor is prepended to the field one line
1749 down. If there is no region, but you specify a prefix argument, the current
1750 field is made blank, and the content is appended to the field above.
1752 @tsubheading{Calculations}
1753 @cindex formula, in tables
1754 @cindex calculations, in tables
1755 @cindex region, active
1756 @cindex active region
1757 @cindex Transient mark mode
1760 Sum the numbers in the current column, or in the rectangle defined by
1761 the active region. The result is shown in the echo area and can
1762 be inserted with @kbd{C-y}.
1766 @vindex org-table-copy-increment
1767 When current field is empty, copy from first non-empty field above. When not
1768 empty, copy current field down to next row and move cursor along with it.
1769 Depending on the variable @code{org-table-copy-increment}, integer field
1770 values will be incremented during copy. Integers that are too large will not
1771 be incremented. Also, a @code{0} prefix argument temporarily disables the
1772 increment. This key is also used by shift-selection and related modes
1773 (@pxref{Conflicts}).
1775 @tsubheading{Miscellaneous}
1778 Edit the current field in a separate window. This is useful for fields
1779 that are not fully visible (@pxref{Narrow columns}). When called with a
1780 @kbd{C-u} prefix, just make the full field visible, so that it can be
1783 @item M-x org-table-import
1784 Import a file as a table. The table should be TAB- or whitespace
1785 separated. Useful, for example, to import a spreadsheet table or data
1786 from a database, because these programs generally can write
1787 TAB-separated text files. This command works by inserting the file into
1788 the buffer and then converting the region to a table. Any prefix
1789 argument is passed on to the converter, which uses it to determine the
1792 Tables can also be imported by pasting tabular text into the Org
1793 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
1794 @kbd{C-c |} command (see above under @i{Creation and conversion}).
1796 @item M-x org-table-export
1797 @vindex org-table-export-default-format
1798 Export the table, by default as a TAB-separated file. Useful for data
1799 exchange with, for example, spreadsheet or database programs. The format
1800 used to export the file can be configured in the variable
1801 @code{org-table-export-default-format}. You may also use properties
1802 @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
1803 name and the format for table export in a subtree. Org supports quite
1804 general formats for exported tables. The exporter format is the same as the
1805 format used by Orgtbl radio tables, see @ref{Translator functions} for a
1806 detailed description.
1809 If you don't like the automatic table editor because it gets in your
1810 way on lines which you would like to start with @samp{|}, you can turn
1814 (setq org-enable-table-editor nil)
1817 @noindent Then the only table command that still works is
1818 @kbd{C-c C-c} to do a manual re-align.
1820 @node Narrow columns, Column groups, Built-in table editor, Tables
1821 @section Narrow columns
1822 @cindex narrow columns in tables
1824 The width of columns is automatically determined by the table editor.
1825 Sometimes a single field or a few fields need to carry more text,
1826 leading to inconveniently wide columns. To limit@footnote{This feature
1827 does not work on XEmacs.} the width of a column, one field anywhere in
1828 the column may contain just the string @samp{<N>} where @samp{N} is an
1829 integer specifying the width of the column in characters. The next
1830 re-align will then set the width of this column to no more than this
1835 |---+------------------------------| |---+--------|
1837 | 1 | one | | 1 | one |
1838 | 2 | two | ----\ | 2 | two |
1839 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
1840 | 4 | four | | 4 | four |
1841 |---+------------------------------| |---+--------|
1846 Fields that are wider become clipped and end in the string @samp{=>}.
1847 Note that the full text is still in the buffer, it is only invisible.
1848 To see the full text, hold the mouse over the field - a tool-tip window
1849 will show the full content. To edit such a field, use the command
1850 @kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will
1851 open a new window with the full field. Edit it and finish with @kbd{C-c
1854 @vindex org-startup-align-all-tables
1855 When visiting a file containing a table with narrowed columns, the
1856 necessary character hiding has not yet happened, and the table needs to
1857 be aligned before it looks nice. Setting the option
1858 @code{org-startup-align-all-tables} will realign all tables in a file
1859 upon visiting, but also slow down startup. You can also set this option
1860 on a per-file basis with:
1867 @node Column groups, Orgtbl mode, Narrow columns, Tables
1868 @section Column groups
1869 @cindex grouping columns in tables
1871 When Org exports tables, it does so by default without vertical
1872 lines because that is visually more satisfying in general. Occasionally
1873 however, vertical lines can be useful to structure a table into groups
1874 of columns, much like horizontal lines can do for groups of rows. In
1875 order to specify column groups, you can use a special row where the
1876 first field contains only @samp{/}. The further fields can either
1877 contain @samp{<} to indicate that this column should start a group,
1878 @samp{>} to indicate the end of a column, or @samp{<>} to make a column
1879 a group of its own. Boundaries between column groups will upon export be
1880 marked with vertical lines. Here is an example:
1883 | | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
1884 |---+----+-----+-----+-----+---------+------------|
1885 | / | <> | < | | > | < | > |
1886 | # | 1 | 1 | 1 | 1 | 1 | 1 |
1887 | # | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
1888 | # | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
1889 |---+----+-----+-----+-----+---------+------------|
1890 #+TBLFM: $3=$2^2::$4=$2^3::$5=$2^4::$6=sqrt($2)::$7=sqrt(sqrt(($2)))
1893 It is also sufficient to just insert the column group starters after
1894 every vertical line you'd like to have:
1897 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
1898 |----+-----+-----+-----+---------+------------|
1902 @node Orgtbl mode, The spreadsheet, Column groups, Tables
1903 @section The Orgtbl minor mode
1905 @cindex minor mode for tables
1907 If you like the intuitive way the Org table editor works, you
1908 might also want to use it in other modes like Text mode or Mail mode.
1909 The minor mode Orgtbl mode makes this possible. You can always toggle
1910 the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for
1911 example in mail mode, use
1914 (add-hook 'mail-mode-hook 'turn-on-orgtbl)
1917 Furthermore, with some special setup, it is possible to maintain tables
1918 in arbitrary syntax with Orgtbl mode. For example, it is possible to
1919 construct La@TeX{} tables with the underlying ease and power of
1920 Orgtbl mode, including spreadsheet capabilities. For details, see
1921 @ref{Tables in arbitrary syntax}.
1923 @node The spreadsheet, Org Plot, Orgtbl mode, Tables
1924 @section The spreadsheet
1925 @cindex calculations, in tables
1926 @cindex spreadsheet capabilities
1927 @cindex @file{calc} package
1929 The table editor makes use of the Emacs @file{calc} package to implement
1930 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
1931 derive fields from other fields. While fully featured, Org's
1932 implementation is not identical to other spreadsheets. For example,
1933 Org knows the concept of a @emph{column formula} that will be
1934 applied to all non-header fields in a column without having to copy the
1935 formula to each relevant field.
1938 * References:: How to refer to another field or range
1939 * Formula syntax for Calc:: Using Calc to compute stuff
1940 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
1941 * Field formulas:: Formulas valid for a single field
1942 * Column formulas:: Formulas valid for an entire column
1943 * Editing and debugging formulas:: Fixing formulas
1944 * Updating the table:: Recomputing all dependent fields
1945 * Advanced features:: Field names, parameters and automatic recalc
1948 @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet
1949 @subsection References
1952 To compute fields in the table from other fields, formulas must
1953 reference other fields or ranges. In Org, fields can be referenced
1954 by name, by absolute coordinates, and by relative coordinates. To find
1955 out what the coordinates of a field are, press @kbd{C-c ?} in that
1956 field, or press @kbd{C-c @}} to toggle the display of a grid.
1958 @subsubheading Field references
1959 @cindex field references
1960 @cindex references, to fields
1962 Formulas can reference the value of another field in two ways. Like in
1963 any other spreadsheet, you may reference fields with a letter/number
1964 combination like @code{B3}, meaning the 2nd field in the 3rd row.
1965 @c Such references are always fixed to that field, they don't change
1966 @c when you copy and paste a formula to a different field. So
1967 @c Org's @code{B3} behaves like @code{$B$3} in other spreadsheets.
1970 Org also uses another, more general operator that looks like this:
1976 Column references can be absolute like @samp{1}, @samp{2},...@samp{N},
1977 or relative to the current column like @samp{+1} or @samp{-2}.
1979 The row specification only counts data lines and ignores horizontal
1980 separator lines (hlines). You can use absolute row numbers
1981 @samp{1}...@samp{N}, and row numbers relative to the current row like
1982 @samp{+3} or @samp{-1}. Or specify the row relative to one of the
1983 hlines: @samp{I} refers to the first hline@footnote{Note that only
1984 hlines are counted that @emph{separate} table lines. If the table
1985 starts with a hline above the header, it does not count.}, @samp{II} to
1986 the second etc. @samp{-I} refers to the first such line above the
1987 current line, @samp{+I} to the first such line below the current line.
1988 You can also write @samp{III+2} which is the second data line after the
1989 third hline in the table. Relative row numbers like @samp{-3} will not
1990 cross hlines if the current line is too close to the hline. Instead,
1991 the value directly at the hline is used.
1993 @samp{0} refers to the current row and column. Also, if you omit
1994 either the column or the row part of the reference, the current
1995 row/column is implied.
1997 Org's references with @emph{unsigned} numbers are fixed references
1998 in the sense that if you use the same reference in the formula for two
1999 different fields, the same field will be referenced each time.
2000 Org's references with @emph{signed} numbers are floating
2001 references because the same reference operator can reference different
2002 fields depending on the field being calculated by the formula.
2004 As a special case references like @samp{$LR5} and @samp{$LR12} can be used to
2005 refer in a stable way to the 5th and 12th field in the last row of the
2008 Here are a few examples:
2011 @@2$3 @r{2nd row, 3rd column}
2012 C2 @r{same as previous}
2013 $5 @r{column 5 in the current row}
2014 E& @r{same as previous}
2015 @@2 @r{current column, row 2}
2016 @@-1$-3 @r{the field one row up, three columns to the left}
2017 @@-I$2 @r{field just under hline above current row, column 2}
2020 @subsubheading Range references
2021 @cindex range references
2022 @cindex references, to ranges
2024 You may reference a rectangular range of fields by specifying two field
2025 references connected by two dots @samp{..}. If both fields are in the
2026 current row, you may simply use @samp{$2..$7}, but if at least one field
2027 is in a different row, you need to use the general @code{@@row$column}
2028 format at least for the first field (i.e the reference must start with
2029 @samp{@@} in order to be interpreted correctly). Examples:
2032 $1..$3 @r{First three fields in the current row.}
2033 $P..$Q @r{Range, using column names (see under Advanced)}
2034 @@2$1..@@4$3 @r{6 fields between these two fields.}
2035 A2..C4 @r{Same as above.}
2036 @@-1$-2..@@-1 @r{3 numbers from the column to the left, 2 up to current row}
2039 @noindent Range references return a vector of values that can be fed
2040 into Calc vector functions. Empty fields in ranges are normally
2041 suppressed, so that the vector contains only the non-empty fields (but
2042 see the @samp{E} mode switch below). If there are no non-empty fields,
2043 @samp{[0]} is returned to avoid syntax errors in formulas.
2045 @subsubheading Named references
2046 @cindex named references
2047 @cindex references, named
2048 @cindex name, of column or field
2049 @cindex constants, in calculations
2051 @vindex org-table-formula-constants
2052 @samp{$name} is interpreted as the name of a column, parameter or
2053 constant. Constants are defined globally through the variable
2054 @code{org-table-formula-constants}, and locally (for the file) through a
2058 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
2062 @vindex constants-unit-system
2063 Also properties (@pxref{Properties and Columns}) can be used as
2064 constants in table formulas: For a property @samp{:Xyz:} use the name
2065 @samp{$PROP_Xyz}, and the property will be searched in the current
2066 outline entry and in the hierarchy above it. If you have the
2067 @file{constants.el} package, it will also be used to resolve constants,
2068 including natural constants like @samp{$h} for Planck's constant, and
2069 units like @samp{$km} for kilometers@footnote{@file{Constant.el} can
2070 supply the values of constants in two different unit systems, @code{SI}
2071 and @code{cgs}. Which one is used depends on the value of the variable
2072 @code{constants-unit-system}. You can use the @code{#+STARTUP} options
2073 @code{constSI} and @code{constcgs} to set this value for the current
2074 buffer.}. Column names and parameters can be specified in special table
2075 lines. These are described below, see @ref{Advanced features}. All
2076 names must start with a letter, and further consist of letters and
2079 @subsubheading Remote references
2080 @cindex remote references
2081 @cindex references, remote
2082 @cindex references, to a different table
2083 @cindex name, of column or field
2084 @cindex constants, in calculations
2086 You may also reference constants, fields and ranges from a different table,
2087 either in the current file or even in a different file. The syntax is
2090 remote(NAME-OR-ID,REF)
2094 where NAME can be the name of a table in the current file as set by a
2095 @code{#+TBLNAME: NAME} line before the table. It can also be the ID of an
2096 entry, even in a different file, and the reference then refers to the first
2097 table in that entry. REF is an absolute field or range reference as
2098 described above, valid in the referenced table.
2100 @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet
2101 @subsection Formula syntax for Calc
2102 @cindex formula syntax, Calc
2103 @cindex syntax, of formulas
2105 A formula can be any algebraic expression understood by the Emacs
2106 @file{Calc} package. @b{Note that @file{calc} has the
2107 non-standard convention that @samp{/} has lower precedence than
2108 @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.} Before
2109 evaluation by @code{calc-eval} (@pxref{Calling Calc from
2110 Your Programs,calc-eval,Calling Calc from Your Lisp Programs,Calc,GNU
2111 Emacs Calc Manual}),
2112 @c FIXME: The link to the Calc manual in HTML does not work.
2113 variable substitution takes place according to the rules described above.
2114 @cindex vectors, in table calculations
2115 The range vectors can be directly fed into the Calc vector functions
2116 like @samp{vmean} and @samp{vsum}.
2118 @cindex format specifier
2119 @cindex mode, for @file{calc}
2120 @vindex org-calc-default-modes
2121 A formula can contain an optional mode string after a semicolon. This
2122 string consists of flags to influence Calc and other modes during
2123 execution. By default, Org uses the standard Calc modes (precision
2124 12, angular units degrees, fraction and symbolic modes off). The display
2125 format, however, has been changed to @code{(float 5)} to keep tables
2126 compact. The default settings can be configured using the variable
2127 @code{org-calc-default-modes}.
2130 p20 @r{switch the internal precision to 20 digits}
2131 n3 s3 e2 f4 @r{normal, scientific, engineering, or fixed display format}
2132 D R @r{angle modes: degrees, radians}
2133 F S @r{fraction and symbolic modes}
2134 N @r{interpret all fields as numbers, use 0 for non-numbers}
2135 T @r{force text interpretation}
2136 E @r{keep empty fields in ranges}
2140 In addition, you may provide a @code{printf} format specifier to
2141 reformat the final result. A few examples:
2144 $1+$2 @r{Sum of first and second field}
2145 $1+$2;%.2f @r{Same, format result to two decimals}
2146 exp($2)+exp($1) @r{Math functions can be used}
2147 $0;%.1f @r{Reformat current cell to 1 decimal}
2148 ($3-32)*5/9 @r{Degrees F -> C conversion}
2149 $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}}
2150 tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1}
2151 sin($1);Dp3%.1e @r{Same, but use printf specifier for display}
2152 vmean($2..$7) @r{Compute column range mean, using vector function}
2153 vmean($2..$7);EN @r{Same, but treat empty fields as 0}
2154 taylor($3,x=7,2) @r{taylor series of $3, at x=7, second degree}
2157 Calc also contains a complete set of logical operations. For example
2160 if($1<20,teen,string("")) @r{``teen'' if age $1 less than 20, else empty}
2163 @node Formula syntax for Lisp, Field formulas, Formula syntax for Calc, The spreadsheet
2164 @subsection Emacs Lisp forms as formulas
2165 @cindex Lisp forms, as table formulas
2167 It is also possible to write a formula in Emacs Lisp; this can be useful
2168 for string manipulation and control structures, if Calc's
2169 functionality is not enough. If a formula starts with a single quote
2170 followed by an opening parenthesis, then it is evaluated as a lisp form.
2171 The evaluation should return either a string or a number. Just as with
2172 @file{calc} formulas, you can specify modes and a printf format after a
2173 semicolon. With Emacs Lisp forms, you need to be conscious about the way
2174 field references are interpolated into the form. By default, a
2175 reference will be interpolated as a Lisp string (in double quotes)
2176 containing the field. If you provide the @samp{N} mode switch, all
2177 referenced elements will be numbers (non-number fields will be zero) and
2178 interpolated as Lisp numbers, without quotes. If you provide the
2179 @samp{L} flag, all fields will be interpolated literally, without quotes.
2180 I.e., if you want a reference to be interpreted as a string by the Lisp
2181 form, enclose the reference operator itself in double quotes, like
2182 @code{"$3"}. Ranges are inserted as space-separated fields, so you can
2183 embed them in list or vector syntax. A few examples, note how the
2184 @samp{N} mode is used when we do computations in lisp.
2187 @r{Swap the first two characters of the content of column 1}
2188 '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
2189 @r{Add columns 1 and 2, equivalent to Calc's @code{$1+$2}}
2191 @r{Compute the sum of columns 1-4, like Calc's @code{vsum($1..$4)}}
2192 '(apply '+ '($1..$4));N
2195 @node Field formulas, Column formulas, Formula syntax for Lisp, The spreadsheet
2196 @subsection Field formulas
2197 @cindex field formula
2198 @cindex formula, for individual table field
2200 To assign a formula to a particular field, type it directly into the
2201 field, preceded by @samp{:=}, for example @samp{:=$1+$2}. When you
2202 press @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in
2203 the field, the formula will be stored as the formula for this field,
2204 evaluated, and the current field replaced with the result.
2206 Formulas are stored in a special line starting with @samp{#+TBLFM:}
2207 directly below the table. If you typed the equation in the 4th field of
2208 the 3rd data line in the table, the formula will look like
2209 @samp{@@3$4=$1+$2}. When inserting/deleting/swapping column and rows
2210 with the appropriate commands, @i{absolute references} (but not relative
2211 ones) in stored formulas are modified in order to still reference the
2212 same field. Of cause this is not true if you edit the table structure
2213 with normal editing commands - then you must fix the equations yourself.
2214 The left hand side of a formula may also be a named field (@pxref{Advanced
2215 features}), or a last-row reference like @samp{$LR3}.
2217 Instead of typing an equation into the field, you may also use the
2223 Install a new formula for the current field. The command prompts for a
2224 formula, with default taken from the @samp{#+TBLFM:} line, applies
2225 it to the current field and stores it.
2228 @node Column formulas, Editing and debugging formulas, Field formulas, The spreadsheet
2229 @subsection Column formulas
2230 @cindex column formula
2231 @cindex formula, for table column
2233 Often in a table, the same formula should be used for all fields in a
2234 particular column. Instead of having to copy the formula to all fields
2235 in that column, Org allows to assign a single formula to an entire
2236 column. If the table contains horizontal separator hlines, everything
2237 before the first such line is considered part of the table @emph{header}
2238 and will not be modified by column formulas.
2240 To assign a formula to a column, type it directly into any field in the
2241 column, preceded by an equal sign, like @samp{=$1+$2}. When you press
2242 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2243 the formula will be stored as the formula for the current column, evaluated
2244 and the current field replaced with the result. If the field contains only
2245 @samp{=}, the previously stored formula for this column is used. For each
2246 column, Org will only remember the most recently used formula. In the
2247 @samp{TBLFM:} line, column formulas will look like @samp{$4=$1+$2}. The left
2248 hand side of a column formula can currently not be the name of column, it
2249 must be the numeric column reference.
2251 Instead of typing an equation into the field, you may also use the
2257 Install a new formula for the current column and replace current field with
2258 the result of the formula. The command prompts for a formula, with default
2259 taken from the @samp{#+TBLFM} line, applies it to the current field and
2260 stores it. With a numeric prefix argument(e.g. @kbd{C-5 C-c =}) the command
2261 will apply it to that many consecutive fields in the current column.
2264 @node Editing and debugging formulas, Updating the table, Column formulas, The spreadsheet
2265 @subsection Editing and debugging formulas
2266 @cindex formula editing
2267 @cindex editing, of table formulas
2269 @vindex org-table-use-standard-references
2270 You can edit individual formulas in the minibuffer or directly in the
2271 field. Org can also prepare a special buffer with all active
2272 formulas of a table. When offering a formula for editing, Org
2273 converts references to the standard format (like @code{B3} or @code{D&})
2274 if possible. If you prefer to only work with the internal format (like
2275 @code{@@3$2} or @code{$4}), configure the variable
2276 @code{org-table-use-standard-references}.
2283 Edit the formula associated with the current column/field in the
2284 minibuffer. See @ref{Column formulas} and @ref{Field formulas}.
2285 @kindex C-u C-u C-c =
2287 Re-insert the active formula (either a
2288 field formula, or a column formula) into the current field, so that you
2289 can edit it directly in the field. The advantage over editing in the
2290 minibuffer is that you can use the command @kbd{C-c ?}.
2293 While editing a formula in a table field, highlight the field(s)
2294 referenced by the reference at the cursor position in the formula.
2297 Toggle the display of row and column numbers for a table, using
2298 overlays. These are updated each time the table is aligned, you can
2299 force it with @kbd{C-c C-c}.
2302 Toggle the formula debugger on and off. See below.
2305 Edit all formulas for the current table in a special buffer, where the
2306 formulas will be displayed one per line. If the current field has an
2307 active formula, the cursor in the formula editor will mark it.
2308 While inside the special buffer, Org will automatically highlight
2309 any field or range reference at the cursor position. You may edit,
2310 remove and add formulas, and use the following commands:
2316 Exit the formula editor and store the modified formulas. With @kbd{C-u}
2317 prefix, also apply the new formulas to the entire table.
2320 Exit the formula editor without installing changes.
2323 Toggle all references in the formula editor between standard (like
2324 @code{B3}) and internal (like @code{@@3$2}).
2327 Pretty-print or indent lisp formula at point. When in a line containing
2328 a lisp formula, format the formula according to Emacs Lisp rules.
2329 Another @key{TAB} collapses the formula back again. In the open
2330 formula, @key{TAB} re-indents just like in Emacs lisp mode.
2333 Complete Lisp symbols, just like in Emacs lisp mode.
2335 @kindex S-@key{down}
2336 @kindex S-@key{left}
2337 @kindex S-@key{right}
2338 @item S-@key{up}/@key{down}/@key{left}/@key{right}
2339 Shift the reference at point. For example, if the reference is
2340 @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
2341 This also works for relative references, and for hline references.
2342 @kindex M-S-@key{up}
2343 @kindex M-S-@key{down}
2344 @item M-S-@key{up}/@key{down}
2345 Move the test line for column formulas in the Org buffer up and
2348 @kindex M-@key{down}
2349 @item M-@key{up}/@key{down}
2350 Scroll the window displaying the table.
2353 Turn the coordinate grid in the table on and off.
2357 Making a table field blank does not remove the formula associated with
2358 the field, because that is stored in a different line (the @samp{TBLFM}
2359 line) - during the next recalculation the field will be filled again.
2360 To remove a formula from a field, you have to give an empty reply when
2361 prompted for the formula, or to edit the @samp{#+TBLFM} line.
2364 You may edit the @samp{#+TBLFM} directly and re-apply the changed
2365 equations with @kbd{C-c C-c} in that line, or with the normal
2366 recalculation commands in the table.
2368 @subsubheading Debugging formulas
2369 @cindex formula debugging
2370 @cindex debugging, of table formulas
2371 When the evaluation of a formula leads to an error, the field content
2372 becomes the string @samp{#ERROR}. If you would like see what is going
2373 on during variable substitution and calculation in order to find a bug,
2374 turn on formula debugging in the @code{Tbl} menu and repeat the
2375 calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
2376 field. Detailed information will be displayed.
2378 @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet
2379 @subsection Updating the table
2380 @cindex recomputing table fields
2381 @cindex updating, table
2383 Recalculation of a table is normally not automatic, but needs to be
2384 triggered by a command. See @ref{Advanced features} for a way to make
2385 recalculation at least semi-automatically.
2387 In order to recalculate a line of a table or the entire table, use the
2393 Recalculate the current row by first applying the stored column formulas
2394 from left to right, and all field formulas in the current row.
2400 Recompute the entire table, line by line. Any lines before the first
2401 hline are left alone, assuming that these are part of the table header.
2403 @kindex C-u C-u C-c *
2404 @kindex C-u C-u C-c C-c
2406 @itemx C-u C-u C-c C-c
2407 Iterate the table by recomputing it until no further changes occur.
2408 This may be necessary if some computed fields use the value of other
2409 fields that are computed @i{later} in the calculation sequence.
2412 @node Advanced features, , Updating the table, The spreadsheet
2413 @subsection Advanced features
2415 If you want the recalculation of fields to happen automatically, or if
2416 you want to be able to assign @i{names} to fields and columns, you need
2417 to reserve the first column of the table for special marking characters.
2421 Rotate the calculation mark in first column through the states @samp{},
2422 @samp{#}, @samp{*}, @samp{!}, @samp{$}. When there is an active region,
2423 change all marks in the region.
2426 Here is an example of a table that collects exam results of students and
2427 makes use of these features:
2431 |---+---------+--------+--------+--------+-------+------|
2432 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
2433 |---+---------+--------+--------+--------+-------+------|
2434 | ! | | P1 | P2 | P3 | Tot | |
2435 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
2436 | ^ | | m1 | m2 | m3 | mt | |
2437 |---+---------+--------+--------+--------+-------+------|
2438 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
2439 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
2440 |---+---------+--------+--------+--------+-------+------|
2441 | | Average | | | | 29.7 | |
2442 | ^ | | | | | at | |
2443 | $ | max=50 | | | | | |
2444 |---+---------+--------+--------+--------+-------+------|
2445 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
2449 @noindent @b{Important}: Please note that for these special tables,
2450 recalculating the table with @kbd{C-u C-c *} will only affect rows that
2451 are marked @samp{#} or @samp{*}, and fields that have a formula assigned
2452 to the field itself. The column formulas are not applied in rows with
2455 @cindex marking characters, tables
2456 The marking characters have the following meaning:
2459 The fields in this line define names for the columns, so that you may
2460 refer to a column as @samp{$Tot} instead of @samp{$6}.
2462 This row defines names for the fields @emph{above} the row. With such
2463 a definition, any formula in the table may use @samp{$m1} to refer to
2464 the value @samp{10}. Also, if you assign a formula to a names field, it
2465 will be stored as @samp{$name=...}.
2467 Similar to @samp{^}, but defines names for the fields in the row
2470 Fields in this row can define @emph{parameters} for formulas. For
2471 example, if a field in a @samp{$} row contains @samp{max=50}, then
2472 formulas in this table can refer to the value 50 using @samp{$max}.
2473 Parameters work exactly like constants, only that they can be defined on
2476 Fields in this row are automatically recalculated when pressing
2477 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row
2478 is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked
2479 lines will be left alone by this command.
2481 Selects this line for global recalculation with @kbd{C-u C-c *}, but
2482 not for automatic recalculation. Use this when automatic
2483 recalculation slows down editing too much.
2485 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
2486 All lines that should be recalculated should be marked with @samp{#}
2489 Do not export this line. Useful for lines that contain the narrowing
2493 Finally, just to whet your appetite on what can be done with the
2494 fantastic @file{calc} package, here is a table that computes the Taylor
2495 series of degree @code{n} at location @code{x} for a couple of
2500 |---+-------------+---+-----+--------------------------------------|
2501 | | Func | n | x | Result |
2502 |---+-------------+---+-----+--------------------------------------|
2503 | # | exp(x) | 1 | x | 1 + x |
2504 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
2505 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
2506 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
2507 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
2508 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
2509 |---+-------------+---+-----+--------------------------------------|
2510 #+TBLFM: $5=taylor($2,$4,$3);n3
2515 @node Org Plot, , The spreadsheet, Tables
2517 @cindex graph, in tables
2518 @cindex plot tables using gnuplot
2520 Org Plot can produce 2D and 3D graphs of information stored in org tables
2521 using @file{Gnuplot} @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
2522 @uref{http://cars9.uchicago.edu/~ravel/software/gnuplot-mode.html}. To see
2523 this in action ensure that you have both Gnuplot and Gnuplot-mode installed
2524 on your system, then call @code{org-plot/gnuplot} on the following table.
2528 #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
2529 | Sede | Max cites | H-index |
2530 |-----------+-----------+---------|
2531 | Chile | 257.72 | 21.39 |
2532 | Leeds | 165.77 | 19.68 |
2533 | Sao Paolo | 71.00 | 11.50 |
2534 | Stockholm | 134.19 | 14.33 |
2535 | Morelia | 257.56 | 17.67 |
2539 Notice that Org Plot is smart enough to apply the tables headers as labels.
2540 Further control over the labels, type, content, and appearance of plots can
2541 be exercised through the @code{#+Plot:} lines preceding a table. See below
2542 for a complete list of Org plot options. For more information and examples
2543 see the org-plot tutorial at
2544 @uref{http://orgmode.org/worg/org-tutorials/org-plot.php}.
2546 @subsubheading Plot Options
2550 Specify any @file{gnuplot} option to be set when graphing.
2553 Specify the title of the plot.
2556 Specify which column of the table to use as the @code{x} axis.
2559 Specify the columns to graph as a lisp style list, surrounded by parenthesis
2560 and separated by spaces for example @code{dep:(3 4)} to graph the third and
2561 fourth columns (defaults to graphing all other columns aside from the ind
2565 Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
2568 Specify a @code{with} option to be inserted for every col being plotted
2569 (e.g. @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
2570 Defaults to 'lines'.
2573 If you want to plot to a file specify the @code{"path/to/desired/output-file"}.
2576 List of labels to be used for the deps (defaults to column headers if they
2580 Specify an entire line to be inserted in the gnuplot script.
2583 When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
2584 flat mapping rather than a @code{3d} slope.
2587 Specify format of org-mode timestamps as they will be parsed by gnuplot.
2588 Defaults to '%Y-%m-%d-%H:%M:%S'.
2591 If you want total control you can specify a script file (place the file name
2592 between double quotes) which will be used to plot. Before plotting, every
2593 instance of @code{$datafile} in the specified script will be replaced with
2594 the path to the generated data file. Note even if you set this option you
2595 may still want to specify the plot type, as that can impact the content of
2599 @node Hyperlinks, TODO Items, Tables, Top
2603 Like HTML, Org provides links inside a file, external links to
2604 other files, Usenet articles, emails, and much more.
2607 * Link format:: How links in Org are formatted
2608 * Internal links:: Links to other places in the current file
2609 * External links:: URL-like links to the world
2610 * Handling links:: Creating, inserting and following
2611 * Using links outside Org:: Linking from my C source code?
2612 * Link abbreviations:: Shortcuts for writing complex links
2613 * Search options:: Linking to a specific location
2614 * Custom searches:: When the default search is not enough
2617 @node Link format, Internal links, Hyperlinks, Hyperlinks
2618 @section Link format
2620 @cindex format, of links
2622 Org will recognize plain URL-like links and activate them as
2623 clickable links. The general link format, however, looks like this:
2626 [[link][description]] @r{or alternatively} [[link]]
2629 Once a link in the buffer is complete (all brackets present), Org
2630 will change the display so that @samp{description} is displayed instead
2631 of @samp{[[link][description]]} and @samp{link} is displayed instead of
2632 @samp{[[link]]}. Links will be highlighted in the face @code{org-link},
2633 which by default is an underlined face. You can directly edit the
2634 visible part of a link. Note that this can be either the @samp{link}
2635 part (if there is no description) or the @samp{description} part. To
2636 edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
2639 If you place the cursor at the beginning or just behind the end of the
2640 displayed text and press @key{BACKSPACE}, you will remove the
2641 (invisible) bracket at that location. This makes the link incomplete
2642 and the internals are again displayed as plain text. Inserting the
2643 missing bracket hides the link internals again. To show the
2644 internal structure of all links, use the menu entry
2645 @code{Org->Hyperlinks->Literal links}.
2647 @node Internal links, External links, Link format, Hyperlinks
2648 @section Internal links
2649 @cindex internal links
2650 @cindex links, internal
2651 @cindex targets, for links
2653 If the link does not look like a URL, it is considered to be internal in
2654 the current file. Links such as @samp{[[My Target]]} or @samp{[[My
2655 Target][Find my target]]} lead to a text search in the current file.
2656 The link can be followed with @kbd{C-c C-o} when the cursor is on the
2657 link, or with a mouse click (@pxref{Handling links}). The preferred
2658 match for such a link is a dedicated target: the same string in double
2659 angular brackets. Targets may be located anywhere; sometimes it is
2660 convenient to put them into a comment line. For example
2666 @noindent In HTML export (@pxref{HTML export}), such targets will become
2667 named anchors for direct access through @samp{http} links@footnote{Note that
2668 text before the first headline is usually not exported, so the first such
2669 target should be after the first headline, or in the line directly before the
2672 If no dedicated target exists, Org will search for the words in the
2673 link. In the above example the search would be for @samp{my target}.
2674 Links starting with a star like @samp{*My Target} restrict the search to
2675 headlines. When searching, Org mode will first try an exact match, but
2676 then move on to more and more lenient searches. For example, the link
2677 @samp{[[*My Targets]]} will find any of the following:
2681 ** TODO my targets are bright
2682 ** my 20 targets are
2685 To insert a link targeting a headline, in-buffer completion can be used.
2686 Just type a star followed by a few optional letters into the buffer and
2687 press @kbd{M-@key{TAB}}. All headlines in the current buffer will be
2688 offered as completions. @xref{Handling links}, for more commands
2691 Following a link pushes a mark onto Org's own mark ring. You can
2692 return to the previous position with @kbd{C-c &}. Using this command
2693 several times in direct succession goes back to positions recorded
2697 * Radio targets:: Make targets trigger links in plain text
2700 @node Radio targets, , Internal links, Internal links
2701 @subsection Radio targets
2702 @cindex radio targets
2703 @cindex targets, radio
2704 @cindex links, radio targets
2706 Org can automatically turn any occurrences of certain target names
2707 in normal text into a link. So without explicitly creating a link, the
2708 text connects to the target radioing its position. Radio targets are
2709 enclosed by triple angular brackets. For example, a target @samp{<<<My
2710 Target>>>} causes each occurrence of @samp{my target} in normal text to
2711 become activated as a link. The Org file is scanned automatically
2712 for radio targets only when the file is first loaded into Emacs. To
2713 update the target list during editing, press @kbd{C-c C-c} with the
2714 cursor on or at a target.
2716 @node External links, Handling links, Internal links, Hyperlinks
2717 @section External links
2718 @cindex links, external
2719 @cindex external links
2720 @cindex links, external
2728 @cindex WANDERLUST links
2730 @cindex USENET links
2735 Org supports links to files, websites, Usenet and email messages,
2736 BBDB database entries and links to both IRC conversations and their
2737 logs. External links are URL-like locators. They start with a short
2738 identifying string followed by a colon. There can be no space after
2739 the colon. The following list shows examples for each link type.
2742 http://www.astro.uva.nl/~dominik @r{on the web}
2743 file:/home/dominik/images/jupiter.jpg @r{file, absolute path}
2744 /home/dominik/images/jupiter.jpg @r{same as above}
2745 file:papers/last.pdf @r{file, relative path}
2746 ./papers/last.pdf @r{same as above}
2747 file:projects.org @r{another org file}
2748 file:projects.org::some words @r{text search in org file}
2749 file:projects.org::*task title @r{heading search in org file}
2750 id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID}
2751 news:comp.emacs @r{Usenet link}
2752 mailto:adent@@galaxy.net @r{Mail link}
2753 vm:folder @r{VM folder link}
2754 vm:folder#id @r{VM message link}
2755 vm://myself@@some.where.org/folder#id @r{VM on remote machine}
2756 wl:folder @r{WANDERLUST folder link}
2757 wl:folder#id @r{WANDERLUST message link}
2758 mhe:folder @r{MH-E folder link}
2759 mhe:folder#id @r{MH-E message link}
2760 rmail:folder @r{RMAIL folder link}
2761 rmail:folder#id @r{RMAIL message link}
2762 gnus:group @r{Gnus group link}
2763 gnus:group#id @r{Gnus article link}
2764 bbdb:R.*Stallman @r{BBDB link (with regexp)}
2765 irc:/irc.com/#emacs/bob @r{IRC link}
2766 shell:ls *.org @r{A shell command}
2767 elisp:org-agenda @r{Interactive elisp command}
2768 elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
2771 A link should be enclosed in double brackets and may contain a
2772 descriptive text to be displayed instead of the URL (@pxref{Link
2773 format}), for example:
2776 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
2780 If the description is a file name or URL that points to an image, HTML
2781 export (@pxref{HTML export}) will inline the image as a clickable
2782 button. If there is no description at all and the link points to an
2784 that image will be inlined into the exported HTML file.
2786 @cindex angular brackets, around links
2787 @cindex plain text external links
2788 Org also finds external links in the normal text and activates them
2789 as links. If spaces must be part of the link (for example in
2790 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
2791 about the end of the link, enclose them in angular brackets.
2793 @node Handling links, Using links outside Org, External links, Hyperlinks
2794 @section Handling links
2795 @cindex links, handling
2797 Org provides methods to create a link in the correct syntax, to
2798 insert it into an Org file, and to follow the link.
2802 @cindex storing links
2804 Store a link to the current location. This is a @emph{global} command (you
2805 must create the key binding yourself) which can be used in any buffer to
2806 create a link. The link will be stored for later insertion into an Org
2809 @vindex org-link-to-org-use-id
2810 For Org files, if there is a @samp{<<target>>} at the cursor, the link points
2811 to the target. Otherwise it points to the current headline, either by text
2812 (unsafe), or, if @file{org-id.el} is loaded and @code{org-link-to-org-use-id}
2813 is set, by ID property.
2815 @vindex org-irc-link-to-logs
2816 For VM, Rmail, Wanderlust, MH-E, Gnus and BBDB buffers, the link will
2817 indicate the current article/entry. For W3 and W3M buffers, the link goes to
2818 the current URL. For IRC links, if you set the variable
2819 @code{org-irc-link-to-logs} to non-nil then @kbd{C-c l} will store a
2820 @samp{file:/} style link to the relevant point in the logs for the current
2821 conversation. Otherwise an @samp{irc:/} style link to the user/channel/server
2822 under the point will be stored.
2824 For any other files, the link will point to the file, with a search string
2825 (@pxref{Search options}) pointing to the contents of the current line. If
2826 there is an active region, the selected words will form the basis of the
2827 search string. If the automatically created link is not working correctly or
2828 accurately enough, you can write custom functions to select the search string
2829 and to do the search for particular file types - see @ref{Custom searches}.
2830 The key binding @kbd{C-c l} is only a suggestion - see @ref{Installation}.
2833 @cindex link completion
2834 @cindex completion, of links
2835 @cindex inserting links
2837 @vindex org-keep-stored-link-after-insertion
2838 Insert a link. This prompts for a link to be inserted into the buffer. You
2839 can just type a link, using text for an internal link, or one of the link
2840 type prefixes mentioned in the examples above. All links stored during the
2841 current session are part of the history for this prompt, so you can access
2842 them with @key{up} and @key{down} (or @kbd{M-p/n}). Completion, on the other
2843 hand, will help you to insert valid link prefixes like @samp{http:} or
2844 @samp{ftp:}, including the prefixes defined through link abbreviations
2845 (@pxref{Link abbreviations}). The link will be inserted into the
2846 buffer@footnote{After insertion of a stored link, the link will be removed
2847 from the list of stored links. To keep it in the list later use, use a
2848 triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
2849 @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
2850 If some text was selected when this command is called, the selected text
2851 becomes the default description.@* Note that you don't have to use this
2852 command to insert a link. Links in Org are plain text, and you can type
2853 or paste them straight into the buffer. By using this command, the links are
2854 automatically enclosed in double brackets, and you will be asked for the
2855 optional descriptive text.
2857 @c If the link is a @samp{file:} link and
2858 @c the linked file is located in the same directory as the current file or
2859 @c a subdirectory of it, the path of the file will be inserted relative to
2860 @c the current directory.
2863 @cindex file name completion
2864 @cindex completion, of file names
2866 When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
2867 a file will be inserted and you may use file name completion to select
2868 the name of the file. The path to the file is inserted relative to the
2869 directory of the current org file, if the linked file is in the current
2870 directory or in a sub-directory of it, or if the path is written relative
2871 to the current directory using @samp{../}. Otherwise an absolute path
2872 is used, if possible with @samp{~/} for your home directory. You can
2873 force an absolute path with two @kbd{C-u} prefixes.
2875 @item C-c C-l @r{(with cursor on existing link)}
2876 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
2877 link and description parts of the link.
2879 @cindex following links
2882 @item C-c C-o @r{or} @key{RET}
2883 @vindex org-file-apps
2884 Open link at point. This will launch a web browser for URLs (using
2885 @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
2886 the corresponding links, and execute the command in a shell link. When the
2887 cursor is on an internal link, this commands runs the corresponding search.
2888 When the cursor is on a TAG list in a headline, it creates the corresponding
2889 TAGS view. If the cursor is on a time stamp, it compiles the agenda for that
2890 date. Furthermore, it will visit text and remote files in @samp{file:} links
2891 with Emacs and select a suitable application for local non-text files.
2892 Classification of files is based on file extension only. See option
2893 @code{org-file-apps}. If you want to override the default application and
2894 visit the file with Emacs, use a @kbd{C-u} prefix. If you want to avoid
2895 opening in Emacs, use a @kbd{C-u C-u} prefix.
2901 On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
2902 would. Under Emacs 22, also @kbd{mouse-1} will follow a link.
2906 @vindex org-display-internal-link-with-indirect-buffer
2907 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
2908 internal links to be displayed in another window@footnote{See the
2909 variable @code{org-display-internal-link-with-indirect-buffer}}.
2914 Push the current position onto the mark ring, to be able to return
2915 easily. Commands following an internal link do this automatically.
2917 @cindex links, returning to
2920 Jump back to a recorded position. A position is recorded by the
2921 commands following internal links, and by @kbd{C-c %}. Using this
2922 command several times in direct succession moves through a ring of
2923 previously recorded positions.
2927 @cindex links, finding next/previous
2930 Move forward/backward to the next link in the buffer. At the limit of
2931 the buffer, the search fails once, and then wraps around. The key
2932 bindings for this are really too long, you might want to bind this also
2933 to @kbd{C-n} and @kbd{C-p}
2935 (add-hook 'org-load-hook
2937 (define-key 'org-mode-map "\C-n" 'org-next-link)
2938 (define-key 'org-mode-map "\C-p" 'org-previous-link)))
2942 @node Using links outside Org, Link abbreviations, Handling links, Hyperlinks
2943 @section Using links outside Org
2945 You can insert and follow links that have Org syntax not only in
2946 Org, but in any Emacs buffer. For this, you should create two
2947 global commands, like this (please select suitable global keys
2951 (global-set-key "\C-c L" 'org-insert-link-global)
2952 (global-set-key "\C-c o" 'org-open-at-point-global)
2955 @node Link abbreviations, Search options, Using links outside Org, Hyperlinks
2956 @section Link abbreviations
2957 @cindex link abbreviations
2958 @cindex abbreviation, links
2960 Long URLs can be cumbersome to type, and often many similar links are
2961 needed in a document. For this you can use link abbreviations. An
2962 abbreviated link looks like this
2965 [[linkword:tag][description]]
2969 @vindex org-link-abbrev-alist
2970 where the tag is optional. The @i{linkword} must be a word; letter, numbers,
2971 @samp{-}, and @samp{_} are allowed here. Abbreviations are resolved
2972 according to the information in the variable @code{org-link-abbrev-alist}
2973 that relates the linkwords to replacement text. Here is an example:
2977 (setq org-link-abbrev-alist
2978 '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
2979 ("google" . "http://www.google.com/search?q=")
2980 ("ads" . "http://adsabs.harvard.edu/cgi-bin/
2981 nph-abs_connect?author=%s&db_key=AST")))
2985 If the replacement text contains the string @samp{%s}, it will be
2986 replaced with the tag. Otherwise the tag will be appended to the string
2987 in order to create the link. You may also specify a function that will
2988 be called with the tag as the only argument to create the link.
2990 With the above setting, you could link to a specific bug with
2991 @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
2992 @code{[[google:OrgMode]]} and find out what the Org author is
2993 doing besides Emacs hacking with @code{[[ads:Dominik,C]]}.
2995 If you need special abbreviations just for a single Org buffer, you
2996 can define them in the file with
2999 #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
3000 #+LINK: google http://www.google.com/search?q=%s
3004 In-buffer completion @pxref{Completion} can be used after @samp{[} to
3005 complete link abbreviations.
3007 @node Search options, Custom searches, Link abbreviations, Hyperlinks
3008 @section Search options in file links
3009 @cindex search option in file links
3010 @cindex file links, searching
3012 File links can contain additional information to make Emacs jump to a
3013 particular location in the file when following a link. This can be a
3014 line number or a search option after a double@footnote{For backward
3015 compatibility, line numbers can also follow a single colon.} colon. For
3016 example, when the command @kbd{C-c l} creates a link (@pxref{Handling
3017 links}) to a file, it encodes the words in the current line as a search
3018 string that can be used to find this line back later when following the
3019 link with @kbd{C-c C-o}.
3021 Here is the syntax of the different ways to attach a search to a file
3022 link, together with an explanation:
3025 [[file:~/code/main.c::255]]
3026 [[file:~/xx.org::My Target]]
3027 [[file:~/xx.org::*My Target]]
3028 [[file:~/xx.org::/regexp/]]
3035 Search for a link target @samp{<<My Target>>}, or do a text search for
3036 @samp{my target}, similar to the search in internal links, see
3037 @ref{Internal links}. In HTML export (@pxref{HTML export}), such a file
3038 link will become an HTML reference to the corresponding named anchor in
3041 In an Org file, restrict search to headlines.
3043 Do a regular expression search for @code{regexp}. This uses the Emacs
3044 command @code{occur} to list all matches in a separate window. If the
3045 target file is in Org mode, @code{org-occur} is used to create a
3046 sparse tree with the matches.
3047 @c If the target file is a directory,
3048 @c @code{grep} will be used to search all files in the directory.
3051 As a degenerate case, a file link with an empty file name can be used
3052 to search the current file. For example, @code{[[file:::find me]]} does
3053 a search for @samp{find me} in the current file, just as
3054 @samp{[[find me]]} would.
3056 @node Custom searches, , Search options, Hyperlinks
3057 @section Custom Searches
3058 @cindex custom search strings
3059 @cindex search strings, custom
3061 The default mechanism for creating search strings and for doing the
3062 actual search related to a file link may not work correctly in all
3063 cases. For example, BibTeX database files have many entries like
3064 @samp{year="1993"} which would not result in good search strings,
3065 because the only unique identification for a BibTeX entry is the
3068 @vindex org-create-file-search-functions
3069 @vindex org-execute-file-search-functions
3070 If you come across such a problem, you can write custom functions to set
3071 the right search string for a particular file type, and to do the search
3072 for the string in the file. Using @code{add-hook}, these functions need
3073 to be added to the hook variables
3074 @code{org-create-file-search-functions} and
3075 @code{org-execute-file-search-functions}. See the docstring for these
3076 variables for more information. Org actually uses this mechanism
3077 for Bib@TeX{} database files, and you can use the corresponding code as
3078 an implementation example. See the file @file{org-bibtex.el}.
3080 @node TODO Items, Tags, Hyperlinks, Top
3084 Org mode does not maintain TODO lists as separate documents@footnote{Of
3085 course, you can make a document that contains only long lists of TODO items,
3086 but this is not required.}. Instead, TODO items are an integral part of the
3087 notes file, because TODO items usually come up while taking notes! With Org
3088 mode, simply mark any entry in a tree as being a TODO item. In this way,
3089 information is not duplicated, and the entire context from which the TODO
3090 item emerged is always present.
3092 Of course, this technique for managing TODO items scatters them
3093 throughout your notes file. Org mode compensates for this by providing
3094 methods to give you an overview of all the things that you have to do.
3097 * TODO basics:: Marking and displaying TODO entries
3098 * TODO extensions:: Workflow and assignments
3099 * Progress logging:: Dates and notes for progress
3100 * Priorities:: Some things are more important than others
3101 * Breaking down tasks:: Splitting a task into manageable pieces
3102 * Checkboxes:: Tick-off lists
3105 @node TODO basics, TODO extensions, TODO Items, TODO Items
3106 @section Basic TODO functionality
3108 Any headline becomes a TODO item when it starts with the word
3109 @samp{TODO}, for example:
3112 *** TODO Write letter to Sam Fortune
3116 The most important commands to work with TODO entries are:
3120 @cindex cycling, of TODO states
3122 Rotate the TODO state of the current item among
3125 ,-> (unmarked) -> TODO -> DONE --.
3126 '--------------------------------'
3129 The same rotation can also be done ``remotely'' from the timeline and
3130 agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}).
3134 Select a specific keyword using completion or (if it has been set up)
3135 the fast selection interface. For the latter, you need to assign keys
3136 to TODO states, see @ref{Per-file keywords} and @ref{Setting tags} for
3139 @kindex S-@key{right}
3140 @kindex S-@key{left}
3143 Select the following/preceding TODO state, similar to cycling. Useful
3144 mostly if more than two TODO states are possible (@pxref{TODO
3145 extensions}). See also @ref{Conflicts} for a discussion of the interaction
3146 with @code{shift-selection-mode}.
3149 @cindex sparse tree, for TODO
3152 @vindex org-todo-keywords
3153 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds the
3154 entire buffer, but shows all TODO items and the headings hierarchy above
3155 them. With a prefix argument, search for a specific TODO. You will be
3156 prompted for the keyword, and you can also give a list of keywords like
3157 @code{KWD1|KWD2|...} to list entries that match any one of these keywords.
3158 With numeric prefix argument N, show the tree for the Nth keyword in the
3159 variable @code{org-todo-keywords}. With two prefix arguments, find all TODO
3163 Show the global TODO list. Collects the TODO items from all agenda
3164 files (@pxref{Agenda Views}) into a single buffer. The new buffer will
3165 be in @code{agenda-mode}, which provides commands to examine and
3166 manipulate the TODO entries from the new buffer (@pxref{Agenda
3167 commands}). @xref{Global TODO list}, for more information.
3168 @kindex S-M-@key{RET}
3170 Insert a new TODO entry below the current one.
3174 @vindex org-todo-state-tags-triggers
3175 Changing a TODO state can also trigger tag changes. See the docstring of the
3176 option @code{org-todo-state-tags-triggers} for details.
3178 @node TODO extensions, Progress logging, TODO basics, TODO Items
3179 @section Extended use of TODO keywords
3180 @cindex extended TODO keywords
3182 @vindex org-todo-keywords
3183 By default, marked TODO entries have one of only two states: TODO and
3184 DONE. Org mode allows you to classify TODO items in more complex ways
3185 with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With
3186 special setup, the TODO keyword system can work differently in different
3189 Note that @i{tags} are another way to classify headlines in general and
3190 TODO items in particular (@pxref{Tags}).
3193 * Workflow states:: From TODO to DONE in steps
3194 * TODO types:: I do this, Fred does the rest
3195 * Multiple sets in one file:: Mixing it all, and still finding your way
3196 * Fast access to TODO states:: Single letter selection of a state
3197 * Per-file keywords:: Different files, different requirements
3198 * Faces for TODO keywords:: Highlighting states
3199 * TODO dependencies:: When one task needs to wait for others
3202 @node Workflow states, TODO types, TODO extensions, TODO extensions
3203 @subsection TODO keywords as workflow states
3204 @cindex TODO workflow
3205 @cindex workflow states as TODO keywords
3207 You can use TODO keywords to indicate different @emph{sequential} states
3208 in the process of working on an item, for example@footnote{Changing
3209 this variable only becomes effective after restarting Org mode in a
3213 (setq org-todo-keywords
3214 '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
3217 The vertical bar separates the TODO keywords (states that @emph{need
3218 action}) from the DONE states (which need @emph{no further action}). If
3219 you don't provide the separator bar, the last state is used as the DONE
3221 @cindex completion, of TODO keywords
3222 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
3223 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED. You may
3224 also use a numeric prefix argument to quickly select a specific state. For
3225 example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY.
3226 Or you can use @kbd{S-left} to go backward through the sequence. If you
3227 define many keywords, you can use in-buffer completion
3228 (@pxref{Completion}) or even a special one-key selection scheme
3229 (@pxref{Fast access to TODO states}) to insert these words into the
3230 buffer. Changing a TODO state can be logged with a timestamp, see
3231 @ref{Tracking TODO state changes} for more information.
3233 @node TODO types, Multiple sets in one file, Workflow states, TODO extensions
3234 @subsection TODO keywords as types
3236 @cindex names as TODO keywords
3237 @cindex types as TODO keywords
3239 The second possibility is to use TODO keywords to indicate different
3240 @emph{types} of action items. For example, you might want to indicate
3241 that items are for ``work'' or ``home''. Or, when you work with several
3242 people on a single project, you might want to assign action items
3243 directly to persons, by using their names as TODO keywords. This would
3244 be set up like this:
3247 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
3250 In this case, different keywords do not indicate a sequence, but rather
3251 different types. So the normal work flow would be to assign a task to a
3252 person, and later to mark it DONE. Org mode supports this style by adapting
3253 the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
3254 @kbd{t} command in the timeline and agenda buffers.}. When used several
3255 times in succession, it will still cycle through all names, in order to first
3256 select the right type for a task. But when you return to the item after some
3257 time and execute @kbd{C-c C-t} again, it will switch from any name directly
3258 to DONE. Use prefix arguments or completion to quickly select a specific
3259 name. You can also review the items of a specific TODO type in a sparse tree
3260 by using a numeric prefix to @kbd{C-c C-v}. For example, to see all things
3261 Lucy has to do, you would use @kbd{C-3 C-c C-v}. To collect Lucy's items
3262 from all agenda files into a single buffer, you would use the numeric prefix
3263 argument as well when creating the global TODO list: @kbd{C-3 C-c t}.
3265 @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions
3266 @subsection Multiple keyword sets in one file
3267 @cindex TODO keyword sets
3269 Sometimes you may want to use different sets of TODO keywords in
3270 parallel. For example, you may want to have the basic
3271 @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
3272 separate state indicating that an item has been canceled (so it is not
3273 DONE, but also does not require action). Your setup would then look
3277 (setq org-todo-keywords
3278 '((sequence "TODO" "|" "DONE")
3279 (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
3280 (sequence "|" "CANCELED")))
3283 The keywords should all be different, this helps Org mode to keep track
3284 of which subsequence should be used for a given entry. In this setup,
3285 @kbd{C-c C-t} only operates within a subsequence, so it switches from
3286 @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
3287 (nothing) to @code{REPORT}. Therefore you need a mechanism to initially
3288 select the correct sequence. Besides the obvious ways like typing a
3289 keyword or using completion, you may also apply the following commands:
3292 @kindex C-S-@key{right}
3293 @kindex C-S-@key{left}
3294 @kindex C-u C-u C-c C-t
3295 @item C-u C-u C-c C-t
3296 @itemx C-S-@key{right}
3297 @itemx C-S-@key{left}
3298 These keys jump from one TODO subset to the next. In the above example,
3299 @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{right}} would jump from @code{TODO} or
3300 @code{DONE} to @code{REPORT}, and any of the words in the second row to
3301 @code{CANCELED}. Note that the @kbd{C-S-} key binding conflict with
3302 @code{shift-selection-mode} (@pxref{Conflicts}).
3303 @kindex S-@key{right}
3304 @kindex S-@key{left}
3307 @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through @emph{all}
3308 keywords from all sets, so for example @kbd{S-@key{<right>}} would switch
3309 from @code{DONE} to @code{REPORT} in the example above. See also
3310 @ref{Conflicts} for a discussion of the interaction with
3311 @code{shift-selection-mode}.
3314 @node Fast access to TODO states, Per-file keywords, Multiple sets in one file, TODO extensions
3315 @subsection Fast access to TODO states
3317 If you would like to quickly change an entry to an arbitrary TODO state
3318 instead of cycling through the states, you can set up keys for
3319 single-letter access to the states. This is done by adding the section
3320 key after each keyword, in parenthesis. For example:
3323 (setq org-todo-keywords
3324 '((sequence "TODO(t)" "|" "DONE(d)")
3325 (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
3326 (sequence "|" "CANCELED(c)")))
3329 @vindex org-fast-tag-selection-include-todo
3330 If you then press @code{C-c C-t} followed by the selection key, the entry
3331 will be switched to this state. @key{SPC} can be used to remove any TODO
3332 keyword from an entry.@footnote{Check also the variable
3333 @code{org-fast-tag-selection-include-todo}, it allows to change the TODO
3334 state through the tags interface (@pxref{Setting tags}), in case you like to
3335 mingle the two concepts. Note that this means you need to come up with
3336 unique keys across both sets of keywords.}
3338 @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions
3339 @subsection Setting up keywords for individual files
3340 @cindex keyword options
3341 @cindex per-file keywords
3343 It can be very useful to use different aspects of the TODO mechanism in
3344 different files. For file-local settings, you need to add special lines
3345 to the file which set the keywords and interpretation for that file
3346 only. For example, to set one of the two examples discussed above, you
3347 need one of the following lines, starting in column zero anywhere in the
3351 #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
3353 @noindent (you may also write @code{#+SEQ_TODO} to be explicit about the
3354 interpretation, but it means the same as @code{#+TODO}), or
3356 #+TYP_TODO: Fred Sara Lucy Mike | DONE
3359 A setup for using several sets in parallel would be:
3363 #+TODO: REPORT BUG KNOWNCAUSE | FIXED
3367 @cindex completion, of option keywords
3369 @noindent To make sure you are using the correct keyword, type
3370 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
3372 @cindex DONE, final TODO keyword
3373 Remember that the keywords after the vertical bar (or the last keyword
3374 if no bar is there) must always mean that the item is DONE (although you
3375 may use a different word). After changing one of these lines, use
3376 @kbd{C-c C-c} with the cursor still in the line to make the changes
3377 known to Org mode@footnote{Org mode parses these lines only when
3378 Org mode is activated after visiting a file. @kbd{C-c C-c} with the
3379 cursor in a line starting with @samp{#+} is simply restarting Org mode
3380 for the current buffer.}.
3382 @node Faces for TODO keywords, TODO dependencies, Per-file keywords, TODO extensions
3383 @subsection Faces for TODO keywords
3384 @cindex faces, for TODO keywords
3386 @vindex org-todo @r{(face)}
3387 @vindex org-done @r{(face)}
3388 @vindex org-todo-keyword-faces
3389 Org mode highlights TODO keywords with special faces: @code{org-todo}
3390 for keywords indicating that an item still has to be acted upon, and
3391 @code{org-done} for keywords indicating that an item is finished. If
3392 you are using more than 2 different states, you might want to use
3393 special faces for some of them. This can be done using the variable
3394 @code{org-todo-keyword-faces}. For example:
3398 (setq org-todo-keyword-faces
3399 '(("TODO" . org-warning)
3400 ("DEFERRED" . shadow)
3401 ("CANCELED" . (:foreground "blue" :weight bold))))
3405 While using a list with face properties as shown for CANCELED
3406 @emph{should} work, this does not aways seem to be the case. If
3407 necessary, define a special face and use that.
3409 @node TODO dependencies, , Faces for TODO keywords, TODO extensions
3410 @subsection TODO dependencies
3411 @cindex TODO dependencies
3412 @cindex dependencies, of TODO states
3414 @vindex org-enforce-todo-dependencies
3415 The structure of Org files (hierarchy and lists) makes it easy to define TODO
3416 dependencies. Usually, a parent TODO task should not be marked DONE until
3417 all subtasks (defined as children tasks) are marked as DONE. And sometimes
3418 there is a logical sequence to a number of (sub)tasks, so that one task
3419 cannot be acted upon before all siblings above it are done. If you customize
3420 the variable @code{org-enforce-todo-dependencies}, Org will block entries
3421 from changing state to DONE while they have children that are not DONE.
3422 Furthermore, if an entry has a property @code{ORDERED}, each of its children
3423 will be blocked until all earlier siblings are marked DONE. Here is an
3427 * TODO Blocked until (two) is done
3436 ** TODO b, needs to wait for (a)
3437 ** TODO c, needs to wait for (a) and (b)
3443 @vindex org-track-ordered-property-with-tag
3444 Toggle the @code{ORDERED} property of the current entry. A property is used
3445 for this behavior because this should be local to the current entry, not
3446 inherited like a tag. However, if you would like to @i{track} the value of
3447 this property with a tag for better visibility, customize the variable
3448 @code{org-track-ordered-property-with-tag}.
3449 @kindex C-u C-u C-u C-c C-t
3450 @item C-u C-u C-u C-c C-t
3451 Change TODO state, circumventin any state blocking.
3454 @vindex org-agenda-dim-blocked-tasks
3455 If you set the variable @code{org-agenda-dim-blocked-tasks}, TODO entries
3456 that cannot be closed because of such dependencies will be shown in a dimmed
3457 font or even made invisible in agenda views (@pxref{Agenda Views}).
3459 @cindex checkboxes and TODO dependencies
3460 @vindex org-enforce-todo-dependencies
3461 You can also block changes of TODO states by looking at checkboxes
3462 (@pxref{Checkboxes}). If you set the variable
3463 @code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked
3464 checkboxes will be blocked from switching to DONE.
3466 If you need more complex dependency structures, for example dependencies
3467 between entries in different trees or files, check out the contributed
3468 module @file{org-depend.el}.
3471 @node Progress logging, Priorities, TODO extensions, TODO Items
3472 @section Progress logging
3473 @cindex progress logging
3474 @cindex logging, of progress
3476 Org mode can automatically record a time stamp and possibly a note when
3477 you mark a TODO item as DONE, or even each time you change the state of
3478 a TODO item. This system is highly configurable, settings can be on a
3479 per-keyword basis and can be localized to a file or even a subtree. For
3480 information on how to clock working time for a task, see @ref{Clocking
3484 * Closing items:: When was this entry marked DONE?
3485 * Tracking TODO state changes:: When did the status change?
3488 @node Closing items, Tracking TODO state changes, Progress logging, Progress logging
3489 @subsection Closing items
3491 The most basic logging is to keep track of @emph{when} a certain TODO
3492 item was finished. This is achieved with@footnote{The corresponding
3493 in-buffer setting is: @code{#+STARTUP: logdone}}.
3496 (setq org-log-done 'time)
3500 Then each time you turn an entry from a TODO (not-done) state into any
3501 of the DONE states, a line @samp{CLOSED: [timestamp]} will be inserted
3502 just after the headline. If you turn the entry back into a TODO item
3503 through further state cycling, that line will be removed again. If you
3504 want to record a note along with the timestamp, use@footnote{The
3505 corresponding in-buffer setting is: @code{#+STARTUP: lognotedone}}
3508 (setq org-log-done 'note)
3512 You will then be prompted for a note, and that note will be stored below
3513 the entry with a @samp{Closing Note} heading.
3515 In the timeline (@pxref{Timeline}) and in the agenda
3516 (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
3517 display the TODO items with a @samp{CLOSED} timestamp on each day,
3518 giving you an overview of what has been done.
3520 @node Tracking TODO state changes, , Closing items, Progress logging
3521 @subsection Tracking TODO state changes
3522 @cindex drawer, for state change recording
3524 @vindex org-log-states-order-reversed
3525 @vindex org-log-state-notes-into-drawer
3526 When TODO keywords are used as workflow states (@pxref{Workflow states}), you
3527 might want to keep track of when a state change occurred and maybe take a
3528 note about this change. You can either record just a timestamp, or a
3529 timestamped note for a change. These records will be inserted after the
3530 headline as an itemized list, newest first@footnote{See the variable
3531 @code{org-log-states-order-reversed}}. When taking a lot of notes, you might
3532 want to get the notes out of a way into a drawer (@pxref{Drawers}).
3533 Customize the variable @code{org-log-state-notes-into-drawer} to get this
3534 behavior - the recommended drawer for this is called @code{LOGBOOK}.
3536 Since it is normally too much to record a note for every state, Org mode
3537 expects configuration on a per-keyword basis for this. This is achieved by
3538 adding special markers @samp{!} (for a time stamp) and @samp{@@} (for a note)
3539 in parenthesis after each keyword. For example, with the setting
3542 (setq org-todo-keywords
3543 '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
3547 @vindex org-log-done
3548 you not only define global TODO keywords and fast access keys, but also
3549 request that a time is recorded when the entry is turned into
3550 DONE@footnote{It is possible that Org mode will record two time stamps
3551 when you are using both @code{org-log-done} and state change logging.
3552 However, it will never prompt for two notes - if you have configured
3553 both, the state change recording note will take precedence and cancel
3554 the @samp{Closing Note}.}, and that a note is recorded when switching to
3555 WAIT or CANCELED. The setting for WAIT is even more special: The
3556 @samp{!} after the slash means that in addition to the note taken when
3557 entering the state, a time stamp should be recorded when @i{leaving} the
3558 WAIT state, if and only if the @i{target} state does not configure
3559 logging for entering it. So it has no effect when switching from WAIT
3560 to DONE, because DONE is configured to record a timestamp only. But
3561 when switching from WAIT back to TODO, the @samp{/!} in the WAIT
3562 setting now triggers a timestamp even though TODO has no logging
3565 You can use the exact same syntax for setting logging preferences local
3568 #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
3571 In order to define logging settings that are local to a subtree or a
3572 single item, define a LOGGING property in this entry. Any non-empty
3573 LOGGING property resets all logging settings to nil. You may then turn
3574 on logging for this specific tree using STARTUP keywords like
3575 @code{lognotedone} or @code{logrepeat}, as well as adding state specific
3576 settings like @code{TODO(!)}. For example
3579 * TODO Log each state with only a time
3581 :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
3583 * TODO Only log when switching to WAIT, and when repeating
3585 :LOGGING: WAIT(@@) logrepeat
3587 * TODO No logging at all
3593 @node Priorities, Breaking down tasks, Progress logging, TODO Items
3597 If you use Org mode extensively, you may end up enough TODO items that
3598 it starts to make sense to prioritize them. Prioritizing can be done by
3599 placing a @emph{priority cookie} into the headline of a TODO item, like
3603 *** TODO [#A] Write letter to Sam Fortune
3607 By default, Org mode supports three priorities: @samp{A}, @samp{B}, and
3608 @samp{C}. @samp{A} is the highest priority. An entry without a cookie
3609 is treated as priority @samp{B}. Priorities make a difference only in
3610 the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they have
3611 no inherent meaning to Org mode.
3613 Priorities can be attached to any outline tree entries; they do not need
3619 Set the priority of the current headline. The command prompts for a
3620 priority character @samp{A}, @samp{B} or @samp{C}. When you press
3621 @key{SPC} instead, the priority cookie is removed from the headline.
3622 The priorities can also be changed ``remotely'' from the timeline and
3623 agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
3626 @kindex S-@key{down}
3629 @vindex org-priority-start-cycle-with-default
3630 Increase/decrease priority of current headline@footnote{See also the option
3631 @code{org-priority-start-cycle-with-default}.}. Note that these keys are
3632 also used to modify time stamps (@pxref{Creating timestamps}). See also
3633 @ref{Conflicts} for a discussion of the interaction with
3634 @code{shift-selection-mode}.
3637 @vindex org-highest-priority
3638 @vindex org-lowest-priority
3639 @vindex org-default-priority
3640 You can change the range of allowed priorities by setting the variables
3641 @code{org-highest-priority}, @code{org-lowest-priority}, and
3642 @code{org-default-priority}. For an individual buffer, you may set
3643 these values (highest, lowest, default) like this (please make sure that
3644 the highest priority is earlier in the alphabet than the lowest
3651 @node Breaking down tasks, Checkboxes, Priorities, TODO Items
3652 @section Breaking tasks down into subtasks
3653 @cindex tasks, breaking down
3655 @vindex org-agenda-todo-list-sublevels
3656 It is often advisable to break down large tasks into smaller, manageable
3657 subtasks. You can do this by creating an outline tree below a TODO item,
3658 with detailed subtasks on the tree@footnote{To keep subtasks out of the
3659 global TODO list, see the @code{org-agenda-todo-list-sublevels}.}. To keep
3660 the overview over the fraction of subtasks that are already completed, insert
3661 either @samp{[/]} or @samp{[%]} anywhere in the headline. These cookies will
3662 be updates each time the todo status of a child changes. For example:
3665 * Organize Party [33%]
3666 ** TODO Call people [1/2]
3670 ** DONE Talk to neighbor
3673 If you would like a TODO entry to automatically change to DONE when all
3674 children are done, you can use the following setup:
3677 (defun org-summary-todo (n-done n-not-done)
3678 "Switch entry to DONE when all subentries are done, to TODO otherwise."
3679 (let (org-log-done org-log-states) ; turn off logging
3680 (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
3682 (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
3686 Another possibility is the use of checkboxes to identify (a hierarchy of) a
3687 large number of subtasks (@pxref{Checkboxes}).
3690 @node Checkboxes, , Breaking down tasks, TODO Items
3694 Every item in a plain list (@pxref{Plain lists}) can be made into a
3695 checkbox by starting it with the string @samp{[ ]}. This feature is
3696 similar to TODO items (@pxref{TODO Items}), but is more lightweight.
3697 Checkboxes are not included into the global TODO list, so they are often
3698 great to split a task into a number of simple steps. Or you can use
3699 them in a shopping list. To toggle a checkbox, use @kbd{C-c C-c}, or
3700 use the mouse (thanks to Piotr Zielinski's @file{org-mouse.el}).
3702 Here is an example of a checkbox list.
3705 * TODO Organize party [2/4]
3706 - [-] call people [1/3]
3711 - [ ] think about what music to play
3712 - [X] talk to the neighbors
3715 Checkboxes work hierarchically, so if a checkbox item has children that
3716 are checkboxes, toggling one of the children checkboxes will make the
3717 parent checkbox reflect if none, some, or all of the children are
3720 @cindex statistics, for checkboxes
3721 @cindex checkbox statistics
3722 The @samp{[2/4]} and @samp{[1/3]} in the first and second line are
3723 cookies indicating how many checkboxes present in this entry have been
3724 checked off, and the total number of checkboxes are present. This can
3725 give you an idea on how many checkboxes remain, even without opening a
3726 folded entry. The cookies can be placed into a headline or into (the
3727 first line of) a plain list item. Each cookie covers all checkboxes
3728 structurally below the headline/item on which the cookie appear. You
3729 have to insert the cookie yourself by typing either @samp{[/]} or
3730 @samp{[%]}. With @samp{[/]} you get an @samp{n out of m} result, as in
3731 the examples above. With @samp{[%]} you get information about the
3732 percentage of checkboxes checked (in the above example, this would be
3733 @samp{[50%]} and @samp{[33%]}, respectively).
3735 @cindex blocking, of checkboxes
3736 @cindex checkbox blocking
3737 If the current outline node has an @code{ORDERED} property, checkboxes must
3738 be checked off in sequence, and an error will be thrown if you try to check
3739 off a box while there are unchecked boxes bove it.
3741 @noindent The following commands work with checkboxes:
3746 Toggle checkbox status or (with prefix arg) checkbox presence at point. With
3747 double prefix argument, set it to @samp{[-]}, which is considered to be an
3751 Toggle checkbox status or (with prefix arg) checkbox presence at point. With
3752 double prefix argument, set it to @samp{[-]}, which is considered to be an
3756 If there is an active region, toggle the first checkbox in the region
3757 and set all remaining boxes to the same status as the first. With a prefix
3758 arg, add or remove the checkbox for all items in the region.
3760 If the cursor is in a headline, toggle checkboxes in the region between
3761 this headline and the next (so @emph{not} the entire subtree).
3763 If there is no active region, just toggle the checkbox at point.
3765 @kindex M-S-@key{RET}
3767 Insert a new item with a checkbox.
3768 This works only if the cursor is already in a plain list item
3769 (@pxref{Plain lists}).
3772 @vindex org-track-ordered-property-with-tag
3773 Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
3774 be checked off in sequence. A property is used for this behavior because
3775 this should be local to the current entry, not inherited like a tag.
3776 However, if you would like to @i{track} the value of this property with a tag
3777 for better visibility, customize the variable
3778 @code{org-track-ordered-property-with-tag}.
3781 Update the checkbox statistics in the current outline entry. When
3782 called with a @kbd{C-u} prefix, update the entire file. Checkbox
3783 statistic cookies are updated automatically if you toggle checkboxes
3784 with @kbd{C-c C-c} and make new ones with @kbd{M-S-@key{RET}}. If you
3785 delete boxes or add/change them by hand, use this command to get things
3786 back into sync. Or simply toggle any checkbox twice with @kbd{C-c C-c}.
3789 @node Tags, Properties and Columns, TODO Items, Top
3792 @cindex headline tagging
3793 @cindex matching, tags
3794 @cindex sparse tree, tag based
3796 An excellent way to implement labels and contexts for cross-correlating
3797 information is to assign @i{tags} to headlines. Org mode has extensive
3800 @vindex org-tag-faces
3801 Every headline can contain a list of tags; they occur at the end of the
3802 headline. Tags are normal words containing letters, numbers, @samp{_}, and
3803 @samp{@@}. Tags must be preceded and followed by a single colon, e.g.,
3804 @samp{:work:}. Several tags can be specified, as in @samp{:work:urgent:}.
3805 Tags will by default get a bold face with the same color as the headline.
3806 You may specify special faces for specific tags using the variable
3807 @code{org-tag-faces}, much in the same way as you can do for TODO keywords
3808 (@pxref{Faces for TODO keywords}).
3811 * Tag inheritance:: Tags use the tree structure of the outline
3812 * Setting tags:: How to assign tags to a headline
3813 * Tag searches:: Searching for combinations of tags
3816 @node Tag inheritance, Setting tags, Tags, Tags
3817 @section Tag inheritance
3818 @cindex tag inheritance
3819 @cindex inheritance, of tags
3820 @cindex sublevels, inclusion into tags match
3822 @i{Tags} make use of the hierarchical structure of outline trees. If a
3823 heading has a certain tag, all subheadings will inherit the tag as
3824 well. For example, in the list
3827 * Meeting with the French group :work:
3828 ** Summary by Frank :boss:notes:
3829 *** TODO Prepare slides for him :action:
3833 the final heading will have the tags @samp{:work:}, @samp{:boss:},
3834 @samp{:notes:}, and @samp{:action:} even though the final heading is not
3835 explicitly marked with those tags. You can also set tags that all entries in
3836 a file should inherit as if these tags would be defined in a hypothetical
3837 level zero that surrounds the entire file.
3840 #+FILETAGS: :Peter:Boss:Secret:
3844 @vindex org-use-tag-inheritance
3845 @vindex org-tags-exclude-from-inheritance
3846 To limit tag inheritance to specific tags, or to turn it off entirely, use
3847 the variables @code{org-use-tag-inheritance} and
3848 @code{org-tags-exclude-from-inheritance}.
3850 @vindex org-tags-match-list-sublevels
3851 When a headline matches during a tags search while tag inheritance is turned
3852 on, all the sublevels in the same tree will (for a simple match form) match
3853 as well@footnote{This is only true if the search does not involve more
3854 complex tests including properties (@pxref{Property searches}).}. The list
3855 of matches may then become very long. If you only want to see the first tags
3856 match in a subtree, configure the variable
3857 @code{org-tags-match-list-sublevels} (not recommended).
3859 @node Setting tags, Tag searches, Tag inheritance, Tags
3860 @section Setting tags
3861 @cindex setting tags
3862 @cindex tags, setting
3865 Tags can simply be typed into the buffer at the end of a headline.
3866 After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is
3867 also a special command for inserting tags:
3872 @cindex completion, of tags
3873 @vindex org-tags-column
3874 Enter new tags for the current headline. Org mode will either offer
3875 completion or a special single-key interface for setting tags, see
3876 below. After pressing @key{RET}, the tags will be inserted and aligned
3877 to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all
3878 tags in the current buffer will be aligned to that column, just to make
3879 things look nice. TAGS are automatically realigned after promotion,
3880 demotion, and TODO state changes (@pxref{TODO basics}).
3883 When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
3886 @vindex org-tag-alist
3887 Org will support tag insertion based on a @emph{list of tags}. By
3888 default this list is constructed dynamically, containing all tags
3889 currently used in the buffer. You may also globally specify a hard list
3890 of tags with the variable @code{org-tag-alist}. Finally you can set
3891 the default tags for a given file with lines like
3894 #+TAGS: @@work @@home @@tennisclub
3895 #+TAGS: laptop car pc sailboat
3898 If you have globally defined your preferred set of tags using the
3899 variable @code{org-tag-alist}, but would like to use a dynamic tag list
3900 in a specific file, add an empty TAGS option line to that file:
3906 @vindex org-tag-persistent-alist
3907 If you have a preferred set of tags that you would like to use in every file,
3908 in addition to those defined on a per file basis by TAGS option lines, then
3909 you may specify a list of tags with the variable
3910 @code{org-tag-persistent-alist}. You may turn this off on a per file basis
3911 by adding a STARTUP option line to that file:
3917 By default Org mode uses the standard minibuffer completion facilities for
3918 entering tags. However, it also implements another, quicker, tag selection
3919 method called @emph{fast tag selection}. This allows you to select and
3920 deselect tags with just a single key press. For this to work well you should
3921 assign unique letters to most of your commonly used tags. You can do this
3922 globally by configuring the variable @code{org-tag-alist} in your
3923 @file{.emacs} file. For example, you may find the need to tag many items in
3924 different files with @samp{:@@home:}. In this case you can set something
3928 (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
3931 @noindent If the tag is only relevant to the file you are working on then you
3932 can, instead, set the TAGS option line as:
3935 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p)
3938 @noindent The tags interface will show the available tags in a splash
3939 window. If you would to start a new line after a specific tag, insert
3940 @samp{\n} into the tag list
3943 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) \n laptop(l) pc(p)
3946 @noindent or write them in two lines:
3949 #+TAGS: @@work(w) @@home(h) @@tennisclub(t)
3950 #+TAGS: laptop(l) pc(p)
3954 You can also group together tags that are mutually exclusive. By using
3958 #+TAGS: @{ @@work(w) @@home(h) @@tennisclub(t) @} laptop(l) pc(p)
3961 @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
3962 and @samp{@@tennisclub} should be selected. Multiple such groups are allowed.
3964 @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
3965 these lines to activate any changes.
3968 To set these mutually exclusive groups in the variable @code{org-tags-alist}
3969 you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
3970 of the braces. Similarly, you can use @code{:newline} to indicate a line
3971 break. The previous example would be set globally by the following
3975 (setq org-tag-alist '((:startgroup . nil)
3976 ("@@work" . ?w) ("@@home" . ?h)
3977 ("@@tennisclub" . ?t)
3979 ("laptop" . ?l) ("pc" . ?p)))
3982 If at least one tag has a selection key then pressing @kbd{C-c C-c} will
3983 automatically present you with a special interface, listing inherited tags,
3984 the tags of the current headline, and a list of all valid tags with
3985 corresponding keys@footnote{Keys will automatically be assigned to tags which
3986 have no configured keys.}. In this interface, you can use the following
3991 Pressing keys assigned to tags will add or remove them from the list of
3992 tags in the current line. Selecting a tag in a group of mutually
3993 exclusive tags will turn off any other tags from that group.
3996 Enter a tag in the minibuffer, even if the tag is not in the predefined
3997 list. You will be able to complete on all tags present in the buffer.
4000 Clear all tags for this line.
4003 Accept the modified set.
4005 Abort without installing changes.
4007 If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
4009 Turn off groups of mutually exclusive tags. Use this to (as an
4010 exception) assign several tags from such a group.
4012 Toggle auto-exit after the next change (see below).
4013 If you are using expert mode, the first @kbd{C-c} will display the
4018 This method lets you assign tags to a headline with very few keys. With
4019 the above setup, you could clear the current tags and set @samp{@@home},
4020 @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
4021 C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@home} to
4022 @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
4023 alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag
4024 @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
4025 @key{RET} @key{RET}}.
4027 @vindex org-fast-tag-selection-single-key
4028 If you find that most of the time, you need only a single key press to
4029 modify your list of tags, set the variable
4030 @code{org-fast-tag-selection-single-key}. Then you no longer have to
4031 press @key{RET} to exit fast tag selection - it will immediately exit
4032 after the first change. If you then occasionally need more keys, press
4033 @kbd{C-c} to turn off auto-exit for the current tag selection process
4034 (in effect: start selection with @kbd{C-c C-c C-c} instead of @kbd{C-c
4035 C-c}). If you set the variable to the value @code{expert}, the special
4036 window is not even shown for single-key tag selection, it comes up only
4037 when you press an extra @kbd{C-c}.
4039 @node Tag searches, , Setting tags, Tags
4040 @section Tag searches
4041 @cindex tag searches
4042 @cindex searching for tags
4044 Once a system of tags has been set up, it can be used to collect related
4045 information into special lists.
4052 Create a sparse tree with all headlines matching a tags search. With a
4053 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
4056 Create a global list of tag matches from all agenda files.
4057 @xref{Matching tags and properties}.
4060 @vindex org-tags-match-list-sublevels
4061 Create a global list of tag matches from all agenda files, but check
4062 only TODO items and force checking subitems (see variable
4063 @code{org-tags-match-list-sublevels}).
4066 These commands all prompt for a match string which allows basic Boolean logic
4067 like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and
4068 @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries
4069 which are tagged @samp{Kathy} or @samp{Sally}. The full syntax of the search
4070 string is rich and allows also matching against TODO keywords, entry levels
4071 and properties. For a complete description with many examples, see
4072 @ref{Matching tags and properties}.
4075 @node Properties and Columns, Dates and Times, Tags, Top
4076 @chapter Properties and Columns
4079 Properties are a set of key-value pairs associated with an entry. There
4080 are two main applications for properties in Org mode. First, properties
4081 are like tags, but with a value. Second, you can use properties to
4082 implement (very basic) database capabilities in an Org buffer. For
4083 an example of the first application, imagine maintaining a file where
4084 you document bugs and plan releases of a piece of software. Instead of
4085 using tags like @code{:release_1:}, @code{:release_2:}, one can use a
4086 property, say @code{:Release:}, that in different subtrees has different
4087 values, such as @code{1.0} or @code{2.0}. For an example of the second
4088 application of properties, imagine keeping track of your music CDs,
4089 where properties could be things such as the album artist, date of
4090 release, number of tracks, and so on.
4092 Properties can be conveniently edited and viewed in column view
4093 (@pxref{Column view}).
4096 * Property syntax:: How properties are spelled out
4097 * Special properties:: Access to other Org mode features
4098 * Property searches:: Matching property values
4099 * Property inheritance:: Passing values down the tree
4100 * Column view:: Tabular viewing and editing
4101 * Property API:: Properties for Lisp programmers
4104 @node Property syntax, Special properties, Properties and Columns, Properties and Columns
4105 @section Property syntax
4106 @cindex property syntax
4107 @cindex drawer, for properties
4109 Properties are key-value pairs. They need to be inserted into a special
4110 drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property
4111 is specified on a single line, with the key (surrounded by colons)
4112 first, and the value after it. Here is an example:
4117 *** Goldberg Variations
4119 :Title: Goldberg Variations
4120 :Composer: J.S. Bach
4122 :Publisher: Deutsche Grammophon
4127 You may define the allowed values for a particular property @samp{:Xyz:}
4128 by setting a property @samp{:Xyz_ALL:}. This special property is
4129 @emph{inherited}, so if you set it in a level 1 entry, it will apply to
4130 the entire tree. When allowed values are defined, setting the
4131 corresponding property becomes easier and is less prone to typing
4132 errors. For the example with the CD collection, we can predefine
4133 publishers and the number of disks in a box like this:
4138 :NDisks_ALL: 1 2 3 4
4139 :Publisher_ALL: "Deutsche Grammophon" Philips EMI
4143 If you want to set properties that can be inherited by any entry in a
4144 file, use a line like
4147 #+PROPERTY: NDisks_ALL 1 2 3 4
4150 @vindex org-global-properties
4151 Property values set with the global variable
4152 @code{org-global-properties} can be inherited by all entries in all
4156 The following commands help to work with properties:
4161 After an initial colon in a line, complete property keys. All keys used
4162 in the current file will be offered as possible completions.
4165 Set a property. This prompts for a property name and a value. If
4166 necessary, the property drawer is created as well.
4167 @item M-x org-insert-property-drawer
4168 Insert a property drawer into the current entry. The drawer will be
4169 inserted early in the entry, but after the lines with planning
4170 information like deadlines.
4173 With the cursor in a property drawer, this executes property commands.
4175 Set a property in the current entry. Both the property and the value
4176 can be inserted using completion.
4177 @kindex S-@key{right}
4178 @kindex S-@key{left}
4179 @item S-@key{left}/@key{right}
4180 Switch property at point to the next/previous allowed value.
4182 Remove a property from the current entry.
4184 Globally remove a property, from all entries in the current file.
4186 Compute the property at point, using the operator and scope from the
4187 nearest column format definition.
4190 @node Special properties, Property searches, Property syntax, Properties and Columns
4191 @section Special properties
4192 @cindex properties, special
4194 Special properties provide alternative access method to Org mode
4195 features discussed in the previous chapters, like the TODO state or the
4196 priority of an entry. This interface exists so that you can include
4197 these states into columns view (@pxref{Column view}), or to use them in
4198 queries. The following property names are special and should not be
4199 used as keys in the properties drawer:
4202 TODO @r{The TODO keyword of the entry.}
4203 TAGS @r{The tags defined directly in the headline.}
4204 ALLTAGS @r{All tags, including inherited ones.}
4205 CATEGORY @r{The category of an entry.}
4206 PRIORITY @r{The priority of the entry, a string with a single letter.}
4207 DEADLINE @r{The deadline time string, without the angular brackets.}
4208 SCHEDULED @r{The scheduling time stamp, without the angular brackets.}
4209 CLOSED @r{When was this entry closed?}
4210 TIMESTAMP @r{The first keyword-less time stamp in the entry.}
4211 TIMESTAMP_IA @r{The first inactive time stamp in the entry.}
4212 CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}}
4213 @r{must be run first to compute the values.}
4216 @node Property searches, Property inheritance, Special properties, Properties and Columns
4217 @section Property searches
4218 @cindex properties, searching
4219 @cindex searching, of properties
4221 To create sparse trees and special lists with selection based on properties,
4222 the same commands are used as for tag searches (@pxref{Tag searches}).
4228 Create a sparse tree with all matching entries. With a
4229 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
4232 Create a global list of tag/property matches from all agenda files.
4233 @xref{Matching tags and properties}.
4236 @vindex org-tags-match-list-sublevels
4237 Create a global list of tag matches from all agenda files, but check
4238 only TODO items and force checking subitems (see variable
4239 @code{org-tags-match-list-sublevels}).
4242 The syntax for the search string is described in @ref{Matching tags and
4245 There is also a special command for creating sparse trees based on a
4251 Create a sparse tree based on the value of a property. This first
4252 prompts for the name of a property, and then for a value. A sparse tree
4253 is created with all entries that define this property with the given
4254 value. If you enclose the value into curly braces, it is interpreted as
4255 a regular expression and matched against the property values.
4258 @node Property inheritance, Column view, Property searches, Properties and Columns
4259 @section Property Inheritance
4260 @cindex properties, inheritance
4261 @cindex inheritance, of properties
4263 @vindex org-use-property-inheritance
4264 The outline structure of Org mode documents lends itself for an
4265 inheritance model of properties: If the parent in a tree has a certain
4266 property, the children can inherit this property. Org mode does not
4267 turn this on by default, because it can slow down property searches
4268 significantly and is often not needed. However, if you find inheritance
4269 useful, you can turn it on by setting the variable
4270 @code{org-use-property-inheritance}. It may be set to @code{t}, to make
4271 all properties inherited from the parent, to a list of properties
4272 that should be inherited, or to a regular expression that matches
4273 inherited properties.
4275 Org mode has a few properties for which inheritance is hard-coded, at
4276 least for the special applications for which they are used:
4280 The @code{:COLUMNS:} property defines the format of column view
4281 (@pxref{Column view}). It is inherited in the sense that the level
4282 where a @code{:COLUMNS:} property is defined is used as the starting
4283 point for a column view table, independently of the location in the
4284 subtree from where columns view is turned on.
4286 For agenda view, a category set through a @code{:CATEGORY:} property
4287 applies to the entire subtree.
4289 For archiving, the @code{:ARCHIVE:} property may define the archive
4290 location for the entire subtree (@pxref{Moving subtrees}).
4292 The LOGGING property may define logging settings for an entry or a
4293 subtree (@pxref{Tracking TODO state changes}).
4296 @node Column view, Property API, Property inheritance, Properties and Columns
4297 @section Column view
4299 A great way to view and edit properties in an outline tree is
4300 @emph{column view}. In column view, each outline item is turned into a
4301 table row. Columns in this table provide access to properties of the
4302 entries. Org mode implements columns by overlaying a tabular structure
4303 over the headline of each item. While the headlines have been turned
4304 into a table row, you can still change the visibility of the outline
4305 tree. For example, you get a compact table by switching to CONTENTS
4306 view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
4307 is active), but you can still open, read, and edit the entry below each
4308 headline. Or, you can switch to column view after executing a sparse
4309 tree command and in this way get a table only for the selected items.
4310 Column view also works in agenda buffers (@pxref{Agenda Views}) where
4311 queries have collected selected items, possibly from a number of files.
4314 * Defining columns:: The COLUMNS format property
4315 * Using column view:: How to create and use column view
4316 * Capturing column view:: A dynamic block for column view
4319 @node Defining columns, Using column view, Column view, Column view
4320 @subsection Defining columns
4321 @cindex column view, for properties
4322 @cindex properties, column view
4324 Setting up a column view first requires defining the columns. This is
4325 done by defining a column format line.
4328 * Scope of column definitions:: Where defined, where valid?
4329 * Column attributes:: Appearance and content of a column
4332 @node Scope of column definitions, Column attributes, Defining columns, Defining columns
4333 @subsubsection Scope of column definitions
4335 To define a column format for an entire file, use a line like
4338 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
4341 To specify a format that only applies to a specific tree, add a
4342 @code{:COLUMNS:} property to the top node of that tree, for example:
4345 ** Top node for columns view
4347 :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
4351 If a @code{:COLUMNS:} property is present in an entry, it defines columns
4352 for the entry itself, and for the entire subtree below it. Since the
4353 column definition is part of the hierarchical structure of the document,
4354 you can define columns on level 1 that are general enough for all
4355 sublevels, and more specific columns further down, when you edit a
4356 deeper part of the tree.
4358 @node Column attributes, , Scope of column definitions, Defining columns
4359 @subsubsection Column attributes
4360 A column definition sets the attributes of a column. The general
4361 definition looks like this:
4364 %[width]property[(title)][@{summary-type@}]
4368 Except for the percent sign and the property name, all items are
4369 optional. The individual parts have the following meaning:
4372 width @r{An integer specifying the width of the column in characters.}
4373 @r{If omitted, the width will be determined automatically.}
4374 property @r{The property that should be edited in this column.}
4375 (title) @r{The header text for the column. If omitted, the}
4376 @r{property name is used.}
4377 @{summary-type@} @r{The summary type. If specified, the column values for}
4378 @r{parent nodes are computed from the children.}
4379 @r{Supported summary types are:}
4380 @{+@} @r{Sum numbers in this column.}
4381 @{+;%.1f@} @r{Like @samp{+}, but format result with @samp{%.1f}.}
4382 @{$@} @r{Currency, short for @samp{+;%.2f}.}
4383 @{:@} @r{Sum times, HH:MM:SS, plain numbers are hours.}
4384 @{X@} @r{Checkbox status, [X] if all children are [X].}
4385 @{X/@} @r{Checkbox status, [n/m].}
4386 @{X%@} @r{Checkbox status, [n%].}
4390 Here is an example for a complete columns definition, along with allowed
4394 :COLUMNS: %20ITEM %9Approved(Approved?)@{X@} %Owner %11Status \@footnote{Please note that the COLUMNS definition must be on a single line - it is wrapped here only because of formatting constraints.}
4395 %10Time_Estimate@{:@} %CLOCKSUM
4396 :Owner_ALL: Tammy Mark Karl Lisa Don
4397 :Status_ALL: "In progress" "Not started yet" "Finished" ""
4398 :Approved_ALL: "[ ]" "[X]"
4401 The first column, @samp{%25ITEM}, means the first 25 characters of the
4402 item itself, i.e. of the headline. You probably always should start the
4403 column definition with the @samp{ITEM} specifier. The other specifiers
4404 create columns @samp{Owner} with a list of names as allowed values, for
4405 @samp{Status} with four different possible values, and for a checkbox
4406 field @samp{Approved}. When no width is given after the @samp{%}
4407 character, the column will be exactly as wide as it needs to be in order
4408 to fully display all values. The @samp{Approved} column does have a
4409 modified title (@samp{Approved?}, with a question mark). Summaries will
4410 be created for the @samp{Time_Estimate} column by adding time duration
4411 expressions like HH:MM, and for the @samp{Approved} column, by providing
4412 an @samp{[X]} status if all children have been checked. The
4413 @samp{CLOCKSUM} column is special, it lists the sum of CLOCK intervals
4416 @node Using column view, Capturing column view, Defining columns, Column view
4417 @subsection Using column view
4420 @tsubheading{Turning column view on and off}
4423 @vindex org-columns-default-format
4424 Create the column view for the local environment. This command searches
4425 the hierarchy, up from point, for a @code{:COLUMNS:} property that defines
4426 a format. When one is found, the column view table is established for
4427 the entire tree, starting from the entry that contains the @code{:COLUMNS:}
4428 property. If none is found, the format is taken from the @code{#+COLUMNS}
4429 line or from the variable @code{org-columns-default-format}, and column
4430 view is established for the current entry and its subtree.
4433 Recreate the column view, to include recent changes made in the buffer.
4440 @tsubheading{Editing values}
4441 @item @key{left} @key{right} @key{up} @key{down}
4442 Move through the column view from field to field.
4443 @kindex S-@key{left}
4444 @kindex S-@key{right}
4445 @item S-@key{left}/@key{right}
4446 Switch to the next/previous allowed value of the field. For this, you
4447 have to have specified allowed values for a property.
4449 Directly select the nth allowed value, @kbd{0} selects the 10th value.
4453 Same as @kbd{S-@key{left}/@key{right}}
4456 Edit the property at point. For the special properties, this will
4457 invoke the same interface that you normally use to change that
4458 property. For example, when editing a TAGS property, the tag completion
4459 or fast selection interface will pop up.
4462 When there is a checkbox at point, toggle it.
4465 View the full value of this property. This is useful if the width of
4466 the column is smaller than that of the value.
4469 Edit the list of allowed values for this property. If the list is found
4470 in the hierarchy, the modified values is stored there. If no list is
4471 found, the new value is stored in the first entry that is part of the
4472 current column view.
4473 @tsubheading{Modifying the table structure}
4477 Make the column narrower/wider by one character.
4478 @kindex S-M-@key{right}
4479 @item S-M-@key{right}
4480 Insert a new column, to the left of the current column.
4481 @kindex S-M-@key{left}
4482 @item S-M-@key{left}
4483 Delete the current column.
4486 @node Capturing column view, , Using column view, Column view
4487 @subsection Capturing column view
4489 Since column view is just an overlay over a buffer, it cannot be
4490 exported or printed directly. If you want to capture a column view, use
4491 this @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame
4492 of this block looks like this:
4494 @cindex #+BEGIN: columnview
4497 #+BEGIN: columnview :hlines 1 :id "label"
4502 @noindent This dynamic block has the following parameters:
4506 This is most important parameter. Column view is a feature that is
4507 often localized to a certain (sub)tree, and the capture block might be
4508 in a different location in the file. To identify the tree whose view to
4509 capture, you can use 3 values:
4511 local @r{use the tree in which the capture block is located}
4512 global @r{make a global view, including all headings in the file}
4514 @r{run column view at the top of this file}
4515 "ID" @r{call column view in the tree that has an @code{:ID:}}
4516 @r{property with the value @i{label}. You can use}
4517 @r{@kbd{M-x org-id-copy} to create a globally unique ID for}
4518 @r{the current entry and copy it to the kill-ring.}
4521 When @code{t}, insert a hline after every line. When a number N, insert
4522 a hline before each headline with level @code{<= N}.
4524 When set to @code{t}, enforce column groups to get vertical lines.
4526 When set to a number, don't capture entries below this level.
4527 @item :skip-empty-rows
4528 When set to @code{t}, skip row where the only non-empty specifier of the
4529 column view is @code{ITEM}.
4534 The following commands insert or update the dynamic block:
4539 Insert a dynamic block capturing a column view. You will be prompted
4540 for the scope or id of the view.
4545 Update dynamical block at point. The cursor needs to be in the
4546 @code{#+BEGIN} line of the dynamic block.
4547 @kindex C-u C-c C-x C-u
4548 @item C-u C-c C-x C-u
4549 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
4550 you have several clock table blocks in a buffer.
4553 You can add formulas to the column view table and you may add plotting
4554 instructions in front of the table - these will survive an update of the
4555 block. If there is a @code{#+TBLFM:} after the table, the table will
4556 actually be recalculated automatically after an update.
4558 An alternative way to capture and process property values into a table is
4559 provided by Eric Schulte's @file{org-collector.el} which is a contributed
4560 package@footnote{Contributed packages are not part of Emacs, but are
4561 distributed with the main distribution of Org (see
4562 @uref{http://orgmode.org}).}. It provides a general API to collect
4563 properties from entries in a certain scope, and arbitrary Lisp expressions to
4564 process these values before inserting them into a table or a dynamic block.
4566 @node Property API, , Column view, Properties and Columns
4567 @section The Property API
4568 @cindex properties, API
4569 @cindex API, for properties
4571 There is a full API for accessing and changing properties. This API can
4572 be used by Emacs Lisp programs to work with properties and to implement
4573 features based on them. For more information see @ref{Using the
4576 @node Dates and Times, Capture, Properties and Columns, Top
4577 @chapter Dates and Times
4583 To assist project planning, TODO items can be labeled with a date and/or
4584 a time. The specially formatted string carrying the date and time
4585 information is called a @emph{timestamp} in Org mode. This may be a
4586 little confusing because timestamp is often used as indicating when
4587 something was created or last changed. However, in Org mode this term
4588 is used in a much wider sense.
4591 * Timestamps:: Assigning a time to a tree entry
4592 * Creating timestamps:: Commands which insert timestamps
4593 * Deadlines and scheduling:: Planning your work
4594 * Clocking work time:: Tracking how long you spend on a task
4595 * Effort estimates:: Planning work effort in advance
4596 * Relative timer:: Notes with a running timer
4600 @node Timestamps, Creating timestamps, Dates and Times, Dates and Times
4601 @section Timestamps, deadlines and scheduling
4603 @cindex ranges, time
4608 A time stamp is a specification of a date (possibly with time or a range
4609 of times) in a special format, either @samp{<2003-09-16 Tue>} or
4610 @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16 Tue
4611 12:00-12:30>}@footnote{This is the standard ISO date/time format. To
4612 use an alternative format, see @ref{Custom time format}.}. A time stamp
4613 can appear anywhere in the headline or body of an Org tree entry. Its
4614 presence causes entries to be shown on specific dates in the agenda
4615 (@pxref{Weekly/daily agenda}). We distinguish:
4618 @item Plain time stamp; Event; Appointment
4620 A simple time stamp just assigns a date/time to an item. This is just
4621 like writing down an appointment or event in a paper agenda. In the
4622 timeline and agenda displays, the headline of an entry associated with a
4623 plain time stamp will be shown exactly on that date.
4626 * Meet Peter at the movies <2006-11-01 Wed 19:15>
4627 * Discussion on climate change <2006-11-02 Thu 20:00-22:00>
4630 @item Time stamp with repeater interval
4631 @cindex timestamp, with repeater interval
4632 A time stamp may contain a @emph{repeater interval}, indicating that it
4633 applies not only on the given date, but again and again after a certain
4634 interval of N days (d), weeks (w), months(m), or years(y). The
4635 following will show up in the agenda every Wednesday:
4638 * Pick up Sam at school <2007-05-16 Wed 12:30 +1w>
4641 @item Diary-style sexp entries
4642 For more complex date specifications, Org mode supports using the
4643 special sexp diary entries implemented in the Emacs calendar/diary
4644 package. For example
4647 * The nerd meeting on every 2nd Thursday of the month
4648 <%%(diary-float t 4 2)>
4651 @item Time/Date range
4654 Two time stamps connected by @samp{--} denote a range. The headline
4655 will be shown on the first and last day of the range, and on any dates
4656 that are displayed and fall in the range. Here is an example:
4659 ** Meeting in Amsterdam
4660 <2004-08-23 Mon>--<2004-08-26 Thu>
4663 @item Inactive time stamp
4664 @cindex timestamp, inactive
4665 @cindex inactive timestamp
4666 Just like a plain time stamp, but with square brackets instead of
4667 angular ones. These time stamps are inactive in the sense that they do
4668 @emph{not} trigger an entry to show up in the agenda.
4671 * Gillian comes late for the fifth time [2006-11-01 Wed]
4676 @node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times
4677 @section Creating timestamps
4678 @cindex creating timestamps
4679 @cindex timestamps, creating
4681 For Org mode to recognize time stamps, they need to be in the specific
4682 format. All commands listed below produce time stamps in the correct
4688 Prompt for a date and insert a corresponding time stamp. When the cursor is
4689 at an existing time stamp in the buffer, the command is used to modify this
4690 timestamp instead of inserting a new one. When this command is used twice in
4691 succession, a time range is inserted.
4695 Like @kbd{C-c .}, but insert an inactive time stamp that will not cause
4702 @vindex org-time-stamp-rounding-minutes
4703 Like @kbd{C-c .} and @kbd{C-c !}, but use the alternative format which
4704 contains date and time. The default time can be rounded to multiples of 5
4705 minutes, see the option @code{org-time-stamp-rounding-minutes}.
4709 Insert a time stamp corresponding to the cursor date in the Calendar.
4713 Access the Emacs calendar for the current date. If there is a
4714 timestamp in the current line, go to the corresponding date
4719 Access the agenda for the date given by the time stamp or -range at
4720 point (@pxref{Weekly/daily agenda}).
4722 @kindex S-@key{left}
4723 @kindex S-@key{right}
4725 @itemx S-@key{right}
4726 Change date at cursor by one day. These key bindings conflict with
4727 shift-selection and related modes (@pxref{Conflicts}).
4730 @kindex S-@key{down}
4733 Change the item under the cursor in a timestamp. The cursor can be on a
4734 year, month, day, hour or minute. When the time stamp contains a time range
4735 like @samp{15:30-16:30}, modifying the first time will also shift the second,
4736 shifting the time block with constant length. To change the length, modify
4737 the second time. Note that if the cursor is in a headline and not at a time
4738 stamp, these same keys modify the priority of an item.
4739 (@pxref{Priorities}). The key bindings also conflict with shift-selection and
4740 related modes (@pxref{Conflicts}).
4743 @cindex evaluate time range
4745 Evaluate a time range by computing the difference between start and end.
4746 With a prefix argument, insert result after the time range (in a table: into
4747 the following column).
4752 * The date/time prompt:: How Org mode helps you entering date and time
4753 * Custom time format:: Making dates look different
4756 @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps
4757 @subsection The date/time prompt
4758 @cindex date, reading in minibuffer
4759 @cindex time, reading in minibuffer
4761 @vindex org-read-date-prefer-future
4762 When Org mode prompts for a date/time, the default is shown as an ISO
4763 date, and the prompt therefore seems to ask for an ISO date. But it
4764 will in fact accept any string containing some date and/or time
4765 information, and it is really smart about interpreting your input. You
4766 can, for example, use @kbd{C-y} to paste a (possibly multi-line) string
4767 copied from an email message. Org mode will find whatever information
4768 is in there and derive anything you have not specified from the
4769 @emph{default date and time}. The default is usually the current date
4770 and time, but when modifying an existing time stamp, or when entering
4771 the second stamp of a range, it is taken from the stamp in the buffer.
4772 When filling in information, Org mode assumes that most of the time you
4773 will want to enter a date in the future: If you omit the month/year and
4774 the given day/month is @i{before} today, it will assume that you mean a
4775 future date@footnote{See the variable
4776 @code{org-read-date-prefer-future}.}.
4778 For example, let's assume that today is @b{June 13, 2006}. Here is how
4779 various inputs will be interpreted, the items filled in by Org mode are
4783 3-2-5 --> 2003-02-05
4784 14 --> @b{2006}-@b{06}-14
4785 12 --> @b{2006}-@b{07}-12
4786 Fri --> nearest Friday (defaultdate or later)
4787 sep 15 --> @b{2006}-09-15
4788 feb 15 --> @b{2007}-02-15
4789 sep 12 9 --> 2009-09-12
4790 12:45 --> @b{2006}-@b{06}-@b{13} 12:45
4791 22 sept 0:34 --> @b{2006}-09-22 0:34
4792 w4 --> ISO week for of the current year @b{2006}
4793 2012 w4 fri --> Friday of ISO week 4 in 2012
4794 2012-w04-5 --> Same as above
4797 Furthermore you can specify a relative date by giving, as the
4798 @emph{first} thing in the input: a plus/minus sign, a number and a
4799 letter [dwmy] to indicate change in days weeks, months, years. With a
4800 single plus or minus, the date is always relative to today. With a
4801 double plus or minus, it is relative to the default date. If instead of
4802 a single letter, you use the abbreviation of day name, the date will be
4803 the nth such day. E.g.
4808 +4d --> four days from today
4809 +4 --> same as above
4810 +2w --> two weeks from today
4811 ++5 --> five days from default date
4812 +2tue --> second tuesday from now.
4815 @vindex parse-time-months
4816 @vindex parse-time-weekdays
4817 The function understands English month and weekday abbreviations. If
4818 you want to use unabbreviated names and/or other languages, configure
4819 the variables @code{parse-time-months} and @code{parse-time-weekdays}.
4821 @cindex calendar, for selecting date
4822 @vindex org-popup-calendar-for-date-prompt
4823 Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
4824 you don't need/want the calendar, configure the variable
4825 @code{org-popup-calendar-for-date-prompt}.}. When you exit the date
4826 prompt, either by clicking on a date in the calendar, or by pressing
4827 @key{RET}, the date selected in the calendar will be combined with the
4828 information entered at the prompt. You can control the calendar fully
4829 from the minibuffer:
4834 @kindex S-@key{right}
4835 @kindex S-@key{left}
4836 @kindex S-@key{down}
4838 @kindex M-S-@key{right}
4839 @kindex M-S-@key{left}
4842 > / < @r{Scroll calendar forward/backward by one month.}
4843 mouse-1 @r{Select date by clicking on it.}
4844 S-@key{right}/@key{left} @r{One day forward/backward.}
4845 S-@key{down}/@key{up} @r{One week forward/backward.}
4846 M-S-@key{right}/@key{left} @r{One month forward/backward.}
4847 @key{RET} @r{Choose date in calendar.}
4850 @vindex org-read-date-display-live
4851 The actions of the date/time prompt may seem complex, but I assure you they
4852 will grow on you, and you will start getting annoyed by pretty much any other
4853 way of entering a date/time out there. To help you understand what is going
4854 on, the current interpretation of your input will be displayed live in the
4855 minibuffer@footnote{If you find this distracting, turn the display of with
4856 @code{org-read-date-display-live}.}.
4858 @node Custom time format, , The date/time prompt, Creating timestamps
4859 @subsection Custom time format
4860 @cindex custom date/time format
4861 @cindex time format, custom
4862 @cindex date format, custom
4864 @vindex org-display-custom-times
4865 @vindex org-time-stamp-custom-formats
4866 Org mode uses the standard ISO notation for dates and times as it is
4867 defined in ISO 8601. If you cannot get used to this and require another
4868 representation of date and time to keep you happy, you can get it by
4869 customizing the variables @code{org-display-custom-times} and
4870 @code{org-time-stamp-custom-formats}.
4875 Toggle the display of custom formats for dates and times.
4879 Org mode needs the default format for scanning, so the custom date/time
4880 format does not @emph{replace} the default format - instead it is put
4881 @emph{over} the default format using text properties. This has the
4882 following consequences:
4885 You cannot place the cursor onto a time stamp anymore, only before or
4888 The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
4889 each component of a time stamp. If the cursor is at the beginning of
4890 the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
4891 just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the
4892 time will be changed by one minute.
4894 If the time stamp contains a range of clock times or a repeater, these
4895 will not be overlayed, but remain in the buffer as they were.
4897 When you delete a time stamp character-by-character, it will only
4898 disappear from the buffer after @emph{all} (invisible) characters
4899 belonging to the ISO timestamp have been removed.
4901 If the custom time stamp format is longer than the default and you are
4902 using dates in tables, table alignment will be messed up. If the custom
4903 format is shorter, things do work as expected.
4907 @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times
4908 @section Deadlines and scheduling
4910 A time stamp may be preceded by special keywords to facilitate planning:
4914 @cindex DEADLINE keyword
4916 Meaning: the task (most likely a TODO item, though not necessarily) is supposed
4917 to be finished on that date.
4919 @vindex org-deadline-warning-days
4920 On the deadline date, the task will be listed in the agenda. In
4921 addition, the agenda for @emph{today} will carry a warning about the
4922 approaching or missed deadline, starting
4923 @code{org-deadline-warning-days} before the due date, and continuing
4924 until the entry is marked DONE. An example:
4927 *** TODO write article about the Earth for the Guide
4928 The editor in charge is [[bbdb:Ford Prefect]]
4929 DEADLINE: <2004-02-29 Sun>
4932 You can specify a different lead time for warnings for a specific
4933 deadlines using the following syntax. Here is an example with a warning
4934 period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}.
4937 @cindex SCHEDULED keyword
4939 Meaning: you are planning to start working on that task on the given
4942 @vindex org-agenda-skip-scheduled-if-done
4943 The headline will be listed under the given date@footnote{It will still
4944 be listed on that date after it has been marked DONE. If you don't like
4945 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In
4946 addition, a reminder that the scheduled date has passed will be present
4947 in the compilation for @emph{today}, until the entry is marked DONE.
4948 I.e., the task will automatically be forwarded until completed.
4951 *** TODO Call Trillian for a date on New Years Eve.
4952 SCHEDULED: <2004-12-25 Sat>
4956 @b{Important:} Scheduling an item in Org mode should @i{not} be
4957 understood in the same way that we understand @i{scheduling a meeting}.
4958 Setting a date for a meeting is just a simple appointment, you should
4959 mark this entry with a simple plain time stamp, to get this item shown
4960 on the date where it applies. This is a frequent mis-understanding from
4961 Org-users. In Org mode, @i{scheduling} means setting a date when you
4962 want to start working on an action item.
4965 You may use time stamps with repeaters in scheduling and deadline
4966 entries. Org mode will issue early and late warnings based on the
4967 assumption that the time stamp represents the @i{nearest instance} of
4968 the repeater. However, the use of diary sexp entries like
4970 @code{<%%(diary-float t 42)>}
4972 in scheduling and deadline timestamps is limited. Org mode does not
4973 know enough about the internals of each sexp function to issue early and
4974 late warnings. However, it will show the item on each day where the
4978 * Inserting deadline/schedule:: Planning items
4979 * Repeated tasks:: Items that show up again and again
4982 @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling
4983 @subsection Inserting deadlines or schedules
4985 The following commands allow to quickly insert a deadline or to schedule
4992 Insert @samp{DEADLINE} keyword along with a stamp. The insertion will
4993 happen in the line directly following the headline. When called with a
4994 prefix arg, an existing deadline will be removed from the entry.
4995 @c FIXME Any CLOSED timestamp will be removed.????????
4999 Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will
5000 happen in the line directly following the headline. Any CLOSED
5001 timestamp will be removed. When called with a prefix argument, remove
5002 the scheduling date from the entry.
5008 Mark the current entry for agenda action. After you have marked the entry
5009 like this, you can open the agenda or the calendar to find an appropriate
5010 date. With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to
5011 schedule the marked item.
5014 @cindex sparse tree, for deadlines
5016 @vindex org-deadline-warning-days
5017 Create a sparse tree with all deadlines that are either past-due, or
5018 which will become due within @code{org-deadline-warning-days}.
5019 With @kbd{C-u} prefix, show all deadlines in the file. With a numeric
5020 prefix, check that many days. For example, @kbd{C-1 C-c / d} shows
5021 all deadlines due tomorrow.
5025 Sparse tree for deadlines and scheduled items before a given date.
5029 Sparse tree for deadlines and scheduled items after a given date.
5032 @node Repeated tasks, , Inserting deadline/schedule, Deadlines and scheduling
5033 @subsection Repeated tasks
5034 @cindex tasks, repeated
5035 @cindex repeated tasks
5037 Some tasks need to be repeated again and again. Org mode helps to
5038 organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
5039 or plain time stamp. In the following example
5041 ** TODO Pay the rent
5042 DEADLINE: <2005-10-01 Sat +1m>
5044 the @code{+1m} is a repeater; the intended interpretation is that the task
5045 has a deadline on <2005-10-01> and repeats itself every (one) month starting
5046 from that time. If you need both a repeater and a special warning period in
5047 a deadline entry, the repeater should come first and the warning period last:
5048 @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
5050 Deadlines and scheduled items produce entries in the agenda when they
5051 are over-due, so it is important to be able to mark such an entry as
5052 completed once you have done so. When you mark a DEADLINE or a SCHEDULE
5053 with the TODO keyword DONE, it will no longer produce entries in the
5054 agenda. The problem with this is, however, that then also the
5055 @emph{next} instance of the repeated entry will not be active. Org mode
5056 deals with this in the following way: When you try to mark such an entry
5057 DONE (using @kbd{C-c C-t}), it will shift the base date of the repeating
5058 time stamp by the repeater interval, and immediately set the entry state
5059 back to TODO. In the example above, setting the state to DONE would
5060 actually switch the date like this:
5063 ** TODO Pay the rent
5064 DEADLINE: <2005-11-01 Tue +1m>
5067 @vindex org-log-repeat
5068 A timestamp@footnote{You can change this using the option
5069 @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
5070 @code{lognoterepeat}, and @code{nologrepeat}. With @code{lognoterepeat}, you
5071 will also be prompted for a note.} will be added under the deadline, to keep
5072 a record that you actually acted on the previous instance of this deadline.
5074 As a consequence of shifting the base date, this entry will no longer be
5075 visible in the agenda when checking past dates, but all future instances
5078 With the @samp{+1m} cookie, the date shift will always be exactly one
5079 month. So if you have not payed the rent for three months, marking this
5080 entry DONE will still keep it as an overdue deadline. Depending on the
5081 task, this may not be the best way to handle it. For example, if you
5082 forgot to call you father for 3 weeks, it does not make sense to call
5083 him 3 times in a single day to make up for it. Finally, there are tasks
5084 like changing batteries which should always repeat a certain time
5085 @i{after} the last time you did it. For these tasks, Org mode has
5086 special repeaters markers with @samp{++} and @samp{.+}. For example:
5090 DEADLINE: <2008-02-10 Sun ++1w>
5091 Marking this DONE will shift the date by at least one week,
5092 but also by as many weeks as it takes to get this date into
5093 the future. However, it stays on a Sunday, even if you called
5094 and marked it done on Saturday.
5095 ** TODO Check the batteries in the smoke detectors
5096 DEADLINE: <2005-11-01 Tue .+1m>
5097 Marking this DONE will shift the date to one month after
5101 You may have both scheduling and deadline information for a specific
5102 task - just make sure that the repeater intervals on both are the same.
5104 An alternative to using a repeater is to create a number of copies of a task
5105 subtree, with dates shifted in each copy. The command @kbd{C-c C-x c} was
5106 created for this purpose, it is described in @ref{Structure editing}.
5109 @node Clocking work time, Effort estimates, Deadlines and scheduling, Dates and Times
5110 @section Clocking work time
5112 Org mode allows you to clock the time you spent on specific tasks in a
5113 project. When you start working on an item, you can start the clock.
5114 When you stop working on that task, or when you mark the task done, the
5115 clock is stopped and the corresponding time interval is recorded. It
5116 also computes the total time spent on each subtree of a project.
5118 Normally, the clock does not survive xiting and re-entereing Emacs, but you
5119 can arrange for the clock information to persisst accress Emacs sessions with
5122 (setq org-clock-persist t)
5123 (org-clock-persistence-insinuate)
5129 @vindex org-clock-into-drawer
5130 Start the clock on the current item (clock-in). This inserts the CLOCK
5131 keyword together with a timestamp. If this is not the first clocking of
5132 this item, the multiple CLOCK lines will be wrapped into a
5133 @code{:CLOCK:} drawer (see also the variable
5134 @code{org-clock-into-drawer}). When called with a @kbd{C-u} prefix argument,
5135 select the task from a list of recently clocked tasks. With two @kbd{C-u
5136 C-u} prefixes, clock into the task at point and mark it as the default task.
5137 The default task will always be available when selecting a clocking task,
5138 with letter @kbd{d}.
5141 @vindex org-log-note-clock-out
5142 Stop the clock (clock-out). This inserts another timestamp at the same
5143 location where the clock was last started. It also directly computes
5144 the resulting time in inserts it after the time range as @samp{=>
5145 HH:MM}. See the variable @code{org-log-note-clock-out} for the
5146 possibility to record an additional note together with the clock-out
5147 time stamp@footnote{The corresponding in-buffer setting is:
5148 @code{#+STARTUP: lognoteclock-out}}.
5151 Recompute the time interval after changing one of the time stamps. This
5152 is only necessary if you edit the time stamps directly. If you change
5153 them with @kbd{S-@key{cursor}} keys, the update is automatic.
5156 Changing the TODO state of an item to DONE automatically stops the clock
5157 if it is running in this same item.
5160 Cancel the current clock. This is useful if a clock was started by
5161 mistake, or if you ended up working on something else.
5164 Jump to the entry that contains the currently running clock. With a
5165 @kbd{C-u} prefix arg, select the target task from a list of recently clocked
5169 @vindex org-remove-highlights-with-change
5170 Display time summaries for each subtree in the current buffer. This
5171 puts overlays at the end of each headline, showing the total time
5172 recorded under that heading, including the time of any subheadings. You
5173 can use visibility cycling to study the tree, but the overlays disappear
5174 when you change the buffer (see variable
5175 @code{org-remove-highlights-with-change}) or press @kbd{C-c C-c}.
5178 Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
5179 report as an Org mode table into the current file. When the cursor is
5180 at an existing clock table, just update it. When called with a prefix
5181 argument, jump to the first clock report in the current document and
5183 @cindex #+BEGIN: clocktable
5185 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
5189 If such a block already exists at point, its content is replaced by the
5190 new table. The @samp{BEGIN} line can specify options:
5192 :maxlevel @r{Maximum level depth to which times are listed in the table.}
5193 :emphasize @r{When @code{t}, emphasize level one and level two items}
5194 :scope @r{The scope to consider. This can be any of the following:}
5195 nil @r{the current buffer or narrowed region}
5196 file @r{the full current buffer}
5197 subtree @r{the subtree where the clocktable is located}
5198 treeN @r{the surrounding level N tree, for example @code{tree3}}
5199 tree @r{the surrounding level 1 tree}
5200 agenda @r{all agenda files}
5201 ("file"..) @r{scan these files}
5202 file-with-archives @r{current file and its archives}
5203 agenda-with-archives @r{all agenda files, including archives}
5204 :block @r{The time block to consider. This block is specified either}
5205 @r{absolute, or relative to the current time and may be any of}
5207 2007-12-31 @r{New year eve 2007}
5208 2007-12 @r{December 2007}
5209 2007-W50 @r{ISO-week 50 in 2007}
5210 2007 @r{the year 2007}
5211 today, yesterday, today-N @r{a relative day}
5212 thisweek, lastweek, thisweek-N @r{a relative week}
5213 thismonth, lastmonth, thismonth-N @r{a relative month}
5214 thisyear, lastyear, thisyear-N @r{a relative year}
5215 @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
5216 :tstart @r{A time string specifying when to start considering times}
5217 :tend @r{A time string specifying when to stop considering times}
5218 :step @r{@code{week} or @code{day}, to split the table into chunks.}
5219 @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
5220 :link @r{Link the item headlines in the table to their origins}
5221 :formula @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
5222 @r{As a special case, @samp{:formula %} adds column with % time.}
5223 @r{If you do not specify a formula here, any existing formula}
5224 @r{below the clock table will survive updates and be evaluated.}
5226 So to get a clock summary of the current level 1 tree, for the current
5227 day, you could write
5229 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
5232 and to use a specific time range you could write@footnote{Note that all
5233 parameters must be specified in a single line - the line is broken here
5234 only to fit it onto the manual.}
5236 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
5237 :tend "<2006-08-10 Thu 12:00>"
5240 A summary of the current subtree with % times would be
5242 #+BEGIN: clocktable :scope subtree :link t :formula %
5249 Update dynamical block at point. The cursor needs to be in the
5250 @code{#+BEGIN} line of the dynamic block.
5251 @kindex C-u C-c C-x C-u
5252 @item C-u C-c C-x C-u
5253 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
5254 you have several clock table blocks in a buffer.
5255 @kindex S-@key{left}
5256 @kindex S-@key{right}
5258 @itemx S-@key{right}
5259 Shift the current @code{:block} interval and update the table. The cursor
5260 needs to be in the @code{#+BEGIN: clocktable} line for this command. If
5261 @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
5264 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
5265 the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
5266 worked on or closed during a day.
5268 @node Effort estimates, Relative timer, Clocking work time, Dates and Times
5269 @section Effort estimates
5270 @cindex effort estimates
5272 @vindex org-effort-property
5273 If you want to plan your work in a very detailed way, or if you need to
5274 produce offers with quotations of the estimated work effort, you may want to
5275 assign effort estimates to entries. If you are also clocking your work, you
5276 may later want to compare the planned effort with the actual working time, a
5277 great way to improve planning estimates. Effort estimates are stored in a
5278 special property @samp{Effort}@footnote{You may change the property being
5279 used with the variable @code{org-effort-property}.}. Clearly the best way to
5280 work with effort estimates is through column view (@pxref{Column view}). You
5281 should start by setting up discrete values for effort estimates, and a
5282 @code{COLUMNS} format that displays these values together with clock sums (if
5283 you want to clock your time). For a specific buffer you can use
5286 #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00
5287 #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
5291 @vindex org-global-properties
5292 @vindex org-columns-default-format
5293 or, even better, you can set up these values globally by customizing the
5294 variables @code{org-global-properties} and @code{org-columns-default-format}.
5295 In particular if you want to use this setup also in the agenda, a global
5296 setup may be advised.
5298 The way to assign estimates to individual items is then to switch to column
5299 mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
5300 value. The values you enter will immediately be summed up in the hierarchy.
5301 In the column next to it, any clocked time will be displayed.
5303 @vindex org-agenda-columns-add-appointments-to-effort-sum
5304 If you switch to column view in the daily/weekly agenda, the effort column
5305 will summarize the estimated work effort for each day@footnote{Please note
5306 the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
5307 column view}).}, and you can use this to find space in your schedule. To get
5308 an overview of the entire part of the day that is committed, you can set the
5309 option @code{org-agenda-columns-add-appointments-to-effort-sum}. The
5310 appointments on a day that take place over a specified time interval will
5311 then also be added to the load estimate of the day.
5313 Effort estimates can be used in secondary agenda filtering that is triggered
5314 with the @kbd{/} key in the agenda (@pxref{Agenda commands}). If you have
5315 these estimates defined consistently, two or three key presses will narrow
5316 down the list to stuff that fits into an available time slot.
5318 @node Relative timer, , Effort estimates, Dates and Times
5319 @section Taking notes with a relative timer
5320 @cindex relative timer
5322 When taking notes during, for example, a meeting or a video viewing, it can
5323 be useful to have access to times relative to a starting time. Org provides
5324 such a relative timer and make it easy to create timed notes.
5329 Insert a relative time into the buffer. The first time you use this, the
5330 timer will be started. When called with a prefix argument, the timer is
5334 Insert a description list item with the current relative time. With a prefix
5335 argument, first reset the timer to 0.
5338 Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
5342 Pause the timer, or continue it if it is already paused. With prefix
5343 argument, stop it entirely.
5344 @kindex C-u C-c C-x ,
5346 Stop the timer. After this, you can only start a new timer, not continue the
5347 old one. This command also removes the timer from the mode line.
5350 Reset the timer without inserting anything into the buffer. By default, the
5351 timer is reset to 0. When called with a @kbd{C-u} prefix, reset the timer to
5352 specific starting offset. The user is prompted for the offset, with a
5353 default taken from a timer string at point, if any, So this can be used to
5354 restart taking notes after a break in the process. When called with a double
5355 prefix argument @kbd{C-c C-u}, change all timer strings in the active region
5356 by a certain amount. This can be used to fix timer strings if the timer was
5357 not started at exactly the right moment.
5360 @node Capture, Agenda Views, Dates and Times, Top
5364 An important part of any organization system is the ability to quickly
5365 capture new ideas and tasks, and to associate reference material with them.
5366 Org uses the @file{remember} package to create tasks, and stores files
5367 related to a task (@i{attachments}) in a special directory.
5370 * Remember:: Capture new tasks/ideas with little interruption
5371 * RSS Feeds:: Getting input from RSS feeds
5372 * Attachments:: Add files to tasks.
5375 @node Remember, RSS Feeds, Capture, Capture
5377 @cindex @file{remember.el}
5379 The @i{Remember} package by John Wiegley lets you store quick notes with
5380 little interruption of your work flow. See
5381 @uref{http://www.emacswiki.org/cgi-bin/wiki/RememberMode} for more
5382 information. It is an excellent way to add new notes and tasks to
5383 Org files. Org significantly expands the possibilities of
5384 @i{remember}: You may define templates for different note types, and
5385 associate target files and headlines with specific templates. It also
5386 allows you to select the location where a note should be stored
5387 interactively, on the fly.
5390 * Setting up Remember:: Some code for .emacs to get things going
5391 * Remember templates:: Define the outline of different note types
5392 * Storing notes:: Directly get the note to where it belongs
5393 * Refiling notes:: Moving a note or task to a project
5396 @node Setting up Remember, Remember templates, Remember, Remember
5397 @subsection Setting up Remember
5399 The following customization will tell @i{remember} to use org files as
5400 target, and to create annotations compatible with Org links.
5403 (org-remember-insinuate)
5404 (setq org-directory "~/path/to/my/orgfiles/")
5405 (setq org-default-notes-file (concat org-directory "/notes.org"))
5406 (define-key global-map "\C-cr" 'org-remember)
5409 The last line binds the command @code{org-remember} to a global
5410 key@footnote{Please select your own key, @kbd{C-c r} is only a
5411 suggestion.}. @code{org-remember} basically just calls @code{remember},
5412 but it makes a few things easier: If there is an active region, it will
5413 automatically copy the region into the remember buffer. It also allows
5414 to jump to the buffer and location where remember notes are being
5415 stored: Just call @code{org-remember} with a prefix argument. If you
5416 use two prefix arguments, Org jumps to the location where the last
5417 remember note was stored.
5419 The remember buffer will actually use @code{org-mode} as its major mode, so
5420 that all editing features of Org-mode are available. In addition to this, a
5421 minor mode @code{org-remember-mode} is turned on, for the single purpose that
5422 you can use its keymap @code{org-remember-mode-map} to overwrite some of
5423 Org-mode's key bindings.
5425 You can also call @code{org-remember} in a special way from the agenda,
5426 using the @kbd{k r} key combination. With this access, any time stamps
5427 inserted by the selected remember template (see below) will default to
5428 the cursor date in the agenda, rather than to the current date.
5430 @node Remember templates, Storing notes, Setting up Remember, Remember
5431 @subsection Remember templates
5432 @cindex templates, for remember
5434 In combination with Org, you can use templates to generate
5435 different types of @i{remember} notes. For example, if you would like
5436 to use one template to create general TODO entries, another one for
5437 journal entries, and a third one for collecting random ideas, you could
5441 (setq org-remember-templates
5442 '(("Todo" ?t "* TODO %?\n %i\n %a" "~/org/TODO.org" "Tasks")
5443 ("Journal" ?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org")
5444 ("Idea" ?i "* %^@{Title@}\n %i\n %a" "~/org/JOURNAL.org" "New Ideas")))
5447 @vindex org-remember-default-headline
5448 @vindex org-directory
5449 @noindent In these entries, the first string is just a name, and the
5450 character specifies how to select the template. It is useful if the
5451 character is also the first letter of the name. The next string specifies
5452 the template. Two more (optional) strings give the file in which, and the
5453 headline under which the new note should be stored. The file (if not present
5454 or @code{nil}) defaults to @code{org-default-notes-file}, the heading to
5455 @code{org-remember-default-headline}. If the file name is not an absolute
5456 path, it will be interpreted relative to @code{org-directory}. The heading
5457 can also be the symbols @code{top} or @code{bottom} to send note as level 1
5458 entries to the beginning or end of the file, respectively.
5460 An optional sixth element specifies the contexts in which the user can select
5461 the template. This element can be a list of major modes or a function.
5462 @code{org-remember} will first check whether the function returns @code{t} or
5463 if we are in any of the listed major mode, and exclude templates for which
5464 this condition is not fulfilled. Templates that do not specify this element
5465 at all, or that use @code{nil} or @code{t} as a value will always be
5471 (setq org-remember-templates
5472 '(("Bug" ?b "* BUG %?\n %i\n %a" "~/org/BUGS.org" "Bugs" (emacs-lisp-mode))
5473 ("Journal" ?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org" "X" my-check)
5474 ("Idea" ?i "* %^@{Title@}\n %i\n %a" "~/org/JOURNAL.org" "New Ideas")))
5477 The first template will only be available when invoking @code{org-remember}
5478 from an buffer in @code{emacs-lisp-mode}. The second template will only be
5479 available when the function @code{my-check} returns @code{t}. The third
5480 template will be proposed in any context.
5482 When you call @kbd{M-x org-remember} (or @kbd{M-x remember}) to remember
5483 something, Org will prompt for a key to select the template (if you have
5484 more than one template) and then prepare the buffer like
5487 [[file:link to where you called remember]]
5491 During expansion of the template, special @kbd{%}-escapes allow dynamic
5492 insertion of content:
5494 %^@{prompt@} @r{prompt the user for a string and replace this sequence with it.}
5495 @r{You may specify a default value and a completion table with}
5496 @r{%^@{prompt|default|completion2|completion3...@}}
5497 @r{The arrow keys access a prompt-specific history.}
5498 %a @r{annotation, normally the link created with @code{org-store-link}}
5499 %A @r{like @code{%a}, but prompt for the description part}
5500 %i @r{initial content, the region when remember is called with C-u.}
5501 @r{The entire text will be indented like @code{%i} itself.}
5502 %t @r{time stamp, date only}
5503 %T @r{time stamp with date and time}
5504 %u, %U @r{like the above, but inactive time stamps}
5505 %^t @r{like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}}
5506 @r{You may define a prompt like @code{%^@{Birthday@}t}}
5507 %n @r{user name (taken from @code{user-full-name})}
5508 %c @r{Current kill ring head.}
5509 %x @r{Content of the X clipboard.}
5510 %^C @r{Interactive selection of which kill or clip to use.}
5511 %^L @r{Like @code{%^C}, but insert as link.}
5512 %^g @r{prompt for tags, with completion on tags in target file.}
5513 %k @r{title of currently clocked task}
5514 %K @r{link to currently clocked task}
5515 %^G @r{prompt for tags, with completion all tags in all agenda files.}
5516 %^@{prop@}p @r{Prompt the user for a value for property @code{prop}}
5517 %:keyword @r{specific information for certain link types, see below}
5518 %[pathname] @r{insert the contents of the file given by @code{pathname}}
5519 %(sexp) @r{evaluate elisp @code{(sexp)} and replace with the result}
5520 %! @r{immediately store note after completing the template}
5521 @r{(skipping the @kbd{C-c C-c} that normally triggers storing)}
5522 %& @r{jump to target location immediately after storing note}
5526 For specific link types, the following keywords will be
5527 defined@footnote{If you define your own link types (@pxref{Adding
5528 hyperlink types}), any property you store with
5529 @code{org-store-link-props} can be accessed in remember templates in a
5532 @vindex org-from-is-user-regexp
5534 Link type | Available keywords
5535 -------------------+----------------------------------------------
5536 bbdb | %:name %:company
5537 bbdb | %::server %:port %:nick
5538 vm, wl, mh, rmail | %:type %:subject %:message-id
5539 | %:from %:fromname %:fromaddress
5540 | %:to %:toname %:toaddress
5541 | %: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}.}}
5542 gnus | %:group, @r{for messages also all email fields}
5544 info | %:file %:node
5549 To place the cursor after template expansion use:
5552 %? @r{After completing the template, position cursor here.}
5556 If you change your mind about which template to use, call
5557 @code{org-remember} in the remember buffer. You may then select a new
5558 template that will be filled with the previous context information.
5560 @node Storing notes, Refiling notes, Remember templates, Remember
5561 @subsection Storing notes
5563 @vindex org-remember-clock-out-on-exit
5564 When you are finished preparing a note with @i{remember}, you have to press
5565 @kbd{C-c C-c} to file the note away. If you have started the clock in the
5566 remember buffer, you will first be asked if you want to clock out
5567 now@footnote{To avoid this query, configure the variable
5568 @code{org-remember-clock-out-on-exit}.}. If you answer @kbd{n}, the clock
5569 will continue to run after the note was filed away.
5571 The handler will then store the note in the file and under the headline
5572 specified in the template, or it will use the default file and headlines.
5573 The window configuration will be restored, sending you back to the working
5574 context before the call to @code{remember}. To re-use the location found
5575 during the last call to @code{remember}, exit the remember buffer with
5576 @kbd{C-0 C-c C-c}, i.e. specify a zero prefix argument to @kbd{C-c C-c}.
5577 Another special case is @kbd{C-2 C-c C-c} which files the note as a child of
5578 the currently clocked item.
5580 @vindex org-remember-store-without-prompt
5581 If you want to store the note directly to a different place, use
5582 @kbd{C-1 C-c C-c} instead to exit remember@footnote{Configure the
5583 variable @code{org-remember-store-without-prompt} to make this behavior
5584 the default.}. The handler will then first prompt for a target file -
5585 if you press @key{RET}, the value specified for the template is used.
5586 Then the command offers the headings tree of the selected file, with the
5587 cursor position at the default headline (if you had specified one in the
5588 template). You can either immediately press @key{RET} to get the note
5589 placed there. Or you can use the following keys to find a different
5592 @key{TAB} @r{Cycle visibility.}
5593 @key{down} / @key{up} @r{Next/previous visible headline.}
5594 n / p @r{Next/previous visible headline.}
5595 f / b @r{Next/previous headline same level.}
5597 @c 0-9 @r{Digit argument.}
5600 Pressing @key{RET} or @key{left} or @key{right}
5601 then leads to the following result.
5603 @vindex org-reverse-note-order
5604 @multitable @columnfractions 0.2 0.15 0.65
5605 @item @b{Cursor position} @tab @b{Key} @tab @b{Note gets inserted}
5606 @item on headline @tab @key{RET} @tab as sublevel of the heading at cursor, first or last
5607 @item @tab @tab depending on @code{org-reverse-note-order}.
5608 @item @tab @key{left}/@key{right} @tab as same level, before/after current heading
5609 @item buffer-start @tab @key{RET} @tab as level 2 heading at end of file or level 1 at beginning
5610 @item @tab @tab depending on @code{org-reverse-note-order}.
5611 @item not on headline @tab @key{RET}
5612 @tab at cursor position, level taken from context.
5615 Before inserting the text into a tree, the function ensures that the text has
5616 a headline, i.e. a first line that starts with a @samp{*}. If not, a
5617 headline is constructed from the current date. If you have indented the text
5618 of the note below the headline, the indentation will be adapted if inserting
5619 the note into the tree requires demotion from level 1.
5621 @node Refiling notes, , Storing notes, Remember
5622 @subsection Refiling notes
5623 @cindex refiling notes
5625 Remember is usually used to quickly capture notes and tasks into one or
5626 a few capture lists. When reviewing the captured data, you may want to
5627 refile some of the entries into a different list, for example into a
5628 project. Cutting, finding the right location and then pasting the note
5629 is cumbersome. To simplify this process, you can use the following
5635 @vindex org-reverse-note-order
5636 @vindex org-refile-targets
5637 @vindex org-refile-use-outline-path
5638 @vindex org-outline-path-complete-in-steps
5639 Refile the entry or region at point. This command offers possible locations
5640 for refiling the entry and lets you select one with completion. The item (or
5641 all items in the region) is filed below the target heading as a subitem.
5642 Depending on @code{org-reverse-note-order}, it will be either the first or
5644 By default, all level 1 headlines in the current buffer are considered to be
5645 targets, but you can have more complex definitions across a number of files.
5646 See the variable @code{org-refile-targets} for details. If you would like to
5647 select a location via a file-path-like completion along the outline path, see
5648 the variables @code{org-refile-use-outline-path} and
5649 @code{org-outline-path-complete-in-steps}.
5652 Use the refile interface to jump to a heading.
5653 @kindex C-u C-u C-c C-w
5654 @item C-u C-u C-c C-w
5655 Jump to the location where @code{org-refile} last moved a tree to.
5658 @node RSS Feeds, Attachments, Remember, Capture
5661 Org has the capablity to add and change entries based on information found in
5662 RSS feeds. You could use this to make a task out of each new podcast in a
5663 podcast feed. Or you could use a phone-based note-creating service on the
5664 web to import tasks into Org.
5666 To access feeds, you need to configure the variable @code{org-feed-alist}.
5667 The docstring of this variable has detailed information. Here is just an
5671 (setq org-feed-alist
5673 "http://www.reqall.com/user/feeds/rss/a1b2c3....."
5674 "~/org/feeds.org" "ReQall Entries")
5677 will configure that new items from the feed provided by @file{reqall.com}
5678 will result in new entries in the file @file{~/org/feeds.org} under the
5679 heading @samp{ReQall Entries}, whenever the following command is used:
5684 Collect items from the feeds configured in @code{org-feed-alist} and act upon
5688 Prompt for a feed name and go to the inbox configured for this feed.
5691 Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which
5692 it will store information about the status of items in the feed, to avoid
5693 adding the same item several times. You should add @samp{FEEDSTATUS} to the
5694 list of drawers in the file where you collect feed data:
5697 #+DRAWERS: LOGBOOK PROPERTIES FEEDSTATUS
5700 For more information, see the file header of @file{org-feed.el} and the
5701 docstring of @code{org-feed-alist}.
5703 @node Attachments, , RSS Feeds, Capture
5704 @section Attachments
5707 @vindex org-attach-directory
5708 It is often useful to associate reference material with an outline node/task.
5709 Small chunks of plain text can simply be stored in the subtree of a project.
5710 Hyperlinks (@pxref{Hyperlinks}) can be used to establish associations with
5711 files that live elsewhere on your computer or in the cloud, like emails or
5712 source code files belonging to a project. Another method is @i{attachments},
5713 which are files located in a directory belonging to an outline node. Org
5714 uses directories named by the unique ID of each entry. These directories are
5715 located in the @file{data} directory which lives in the same directory where
5716 your org-file lives@footnote{If you move entries or Org-files from one
5717 directory to the next, you may want to configure @code{org-attach-directory}
5718 to contain an absolute path.}. If you initialize this directory with
5719 @code{git init}, Org will automatically commit changes when it sees them.
5720 The attachment system has been contributed to Org by John Wiegley.
5722 In cases where this seems better, you can also attach a directory of your
5723 choice to an entry. You can also make children inherit the attachment
5724 directory from a parent, so that an entire subtree uses the same attached
5727 @noindent The following commands deal with attachments.
5733 The dispatcher for commands related to the attachment system. After these
5734 keys, a list of commands is displayed and you need to press an additional key
5735 to select a command:
5740 @vindex org-attach-method
5741 Select a file and move it into the task's attachment directory. The file
5742 will be copied, moved, or linked, depending on @code{org-attach-method}.
5743 Note that hard links are not supported on all systems.
5749 Attach a file using the copy/move/link method.
5750 Note that hard links are not supported on all systems.
5754 Create a new attachment as an Emacs buffer.
5758 Synchronize the current task with its attachment directory, in case you added
5759 attachments yourself.
5763 @vindex org-file-apps
5764 Open current task's attachment. If there are more than one, prompt for a
5765 file name first. Opening will follow the rules set by @code{org-file-apps}.
5766 For more details, see the information on following hyperlinks
5767 (@pxref{Handling links}).
5771 Also open the attachment, but force opening the file in Emacs.
5775 Open the current task's attachment directory.
5779 Also open the directory, but force using @code{dired} in Emacs.
5783 Select and delete a single attachment.
5787 Delete all of a task's attachments. A safer way is to open the directory in
5788 dired and delete from there.
5792 Set a specific directory as the entry's attachment directory. This works by
5793 putting the directory path into the @code{ATTACH_DIR} property.
5797 Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
5798 same directory for attachments as the parent.
5802 @node Agenda Views, Embedded LaTeX, Capture, Top
5803 @chapter Agenda Views
5804 @cindex agenda views
5806 Due to the way Org works, TODO items, time-stamped items, and
5807 tagged headlines can be scattered throughout a file or even a number of
5808 files. To get an overview of open action items, or of events that are
5809 important for a particular date, this information must be collected,
5810 sorted and displayed in an organized way.
5812 Org can select items based on various criteria, and display them
5813 in a separate buffer. Seven different view types are provided:
5817 an @emph{agenda} that is like a calendar and shows information
5820 a @emph{TODO list} that covers all unfinished
5823 a @emph{match view}, showings headlines based on the tags, properties and
5824 TODO state associated with them,
5826 a @emph{timeline view} that shows all events in a single Org file,
5827 in time-sorted view,
5829 a @emph{keyword search view} that shows all entries from multiple files
5830 that contain specified keywords.
5832 a @emph{stuck projects view} showing projects that currently don't move
5835 @emph{custom views} that are special tag/keyword searches and
5836 combinations of different views.
5840 The extracted information is displayed in a special @emph{agenda
5841 buffer}. This buffer is read-only, but provides commands to visit the
5842 corresponding locations in the original Org files, and even to
5843 edit these files remotely.
5845 @vindex org-agenda-window-setup
5846 @vindex org-agenda-restore-windows-after-quit
5847 Two variables control how the agenda buffer is displayed and whether the
5848 window configuration is restored when the agenda exits:
5849 @code{org-agenda-window-setup} and
5850 @code{org-agenda-restore-windows-after-quit}.
5853 * Agenda files:: Files being searched for agenda information
5854 * Agenda dispatcher:: Keyboard access to agenda views
5855 * Built-in agenda views:: What is available out of the box?
5856 * Presentation and sorting:: How agenda items are prepared for display
5857 * Agenda commands:: Remote editing of Org trees
5858 * Custom agenda views:: Defining special searches and views
5859 * Agenda column view:: Using column view for collected entries
5862 @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views
5863 @section Agenda files
5864 @cindex agenda files
5865 @cindex files for agenda
5867 @vindex org-agenda-files
5868 The information to be shown is normally collected from all @emph{agenda
5869 files}, the files listed in the variable
5870 @code{org-agenda-files}@footnote{If the value of that variable is not a
5871 list, but a single file name, then the list of agenda files will be
5872 maintained in that external file.}. If a directory is part of this list,
5873 all files with the extension @file{.org} in this directory will be part
5876 Thus even if you only work with a single Org file, this file should
5877 be put into that list@footnote{When using the dispatcher, pressing
5878 @kbd{<} before selecting a command will actually limit the command to
5879 the current file, and ignore @code{org-agenda-files} until the next
5880 dispatcher command.}. You can customize @code{org-agenda-files}, but
5881 the easiest way to maintain it is through the following commands
5883 @cindex files, adding to agenda list
5887 Add current file to the list of agenda files. The file is added to
5888 the front of the list. If it was already in the list, it is moved to
5889 the front. With a prefix argument, file is added/moved to the end.
5892 Remove current file from the list of agenda files.
5897 Cycle through agenda file list, visiting one file after the other.
5898 @kindex M-x org-iswitchb
5899 @item M-x org-iswitchb
5900 Command to use an @code{iswitchb}-like interface to switch to and between Org
5905 The Org menu contains the current list of files and can be used
5906 to visit any of them.
5908 If you would like to focus the agenda temporarily onto a file not in
5909 this list, or onto just one file in the list or even only a subtree in a
5910 file, this can be done in different ways. For a single agenda command,
5911 you may press @kbd{<} once or several times in the dispatcher
5912 (@pxref{Agenda dispatcher}). To restrict the agenda scope for an
5913 extended period, use the following commands:
5918 Permanently restrict the agenda to the current subtree. When with a
5919 prefix argument, or with the cursor before the first headline in a file,
5920 the agenda scope is set to the entire file. This restriction remains in
5921 effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
5922 or @kbd{>} in the agenda dispatcher. If there is a window displaying an
5923 agenda view, the new restriction takes effect immediately.
5926 Remove the permanent restriction created by @kbd{C-c C-x <}.
5930 When working with @file{Speedbar}, you can use the following commands in
5934 @item < @r{in the speedbar frame}
5935 Permanently restrict the agenda to the item at the cursor in the
5936 Speedbar frame, either an Org file or a subtree in such a file.
5937 If there is a window displaying an agenda view, the new restriction takes
5940 @item > @r{in the speedbar frame}
5941 Lift the restriction again.
5944 @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views
5945 @section The agenda dispatcher
5946 @cindex agenda dispatcher
5947 @cindex dispatching agenda commands
5948 The views are created through a dispatcher that should be bound to a
5949 global key, for example @kbd{C-c a} (@pxref{Installation}). In the
5950 following we will assume that @kbd{C-c a} is indeed how the dispatcher
5951 is accessed and list keyboard access to commands accordingly. After
5952 pressing @kbd{C-c a}, an additional letter is required to execute a
5953 command. The dispatcher offers the following default commands:
5956 Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
5958 Create a list of all TODO items (@pxref{Global TODO list}).
5960 Create a list of headlines matching a TAGS expression (@pxref{Matching
5961 tags and properties}).
5963 Create the timeline view for the current buffer (@pxref{Timeline}).
5965 Create a list of entries selected by a boolean expression of keywords
5966 and/or regular expressions that must or must not occur in the entry.
5968 @vindex org-agenda-text-search-extra-files
5969 Search for a regular expression in all agenda files and additionally in
5970 the files listed in @code{org-agenda-text-search-extra-files}. This
5971 uses the Emacs command @code{multi-occur}. A prefix argument can be
5972 used to specify the number of context lines for each match, default is
5975 Create a list of stuck projects (@pxref{Stuck projects}).
5977 Restrict an agenda command to the current buffer@footnote{For backward
5978 compatibility, you can also press @kbd{1} to restrict to the current
5979 buffer.}. After pressing @kbd{<}, you still need to press the character
5980 selecting the command.
5982 If there is an active region, restrict the following agenda command to
5983 the region. Otherwise, restrict it to the current subtree@footnote{For
5984 backward compatibility, you can also press @kbd{0} to restrict to the
5985 current buffer.}. After pressing @kbd{< <}, you still need to press the
5986 character selecting the command.
5989 You can also define custom commands that will be accessible through the
5990 dispatcher, just like the default commands. This includes the
5991 possibility to create extended agenda buffers that contain several
5992 blocks together, for example the weekly agenda, the global TODO list and
5993 a number of special tags matches. @xref{Custom agenda views}.
5995 @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda Views
5996 @section The built-in agenda views
5998 In this section we describe the built-in views.
6001 * Weekly/daily agenda:: The calendar page with current tasks
6002 * Global TODO list:: All unfinished action items
6003 * Matching tags and properties:: Structured information with fine-tuned search
6004 * Timeline:: Time-sorted view for single file
6005 * Keyword search:: Finding entries by keyword
6006 * Stuck projects:: Find projects you need to review
6009 @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views
6010 @subsection The weekly/daily agenda
6012 @cindex weekly agenda
6013 @cindex daily agenda
6015 The purpose of the weekly/daily @emph{agenda} is to act like a page of a
6016 paper agenda, showing all the tasks for the current week or day.
6019 @cindex org-agenda, command
6022 @vindex org-agenda-ndays
6023 Compile an agenda for the current week from a list of org files. The agenda
6024 shows the entries for each day. With a numeric prefix@footnote{For backward
6025 compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
6026 listed before the agenda. This feature is deprecated, use the dedicated TODO
6027 list, or a block agenda instead (@pxref{Block agenda}).} (like @kbd{C-u 2 1
6028 C-c a a}) you may set the number of days to be displayed (see also the
6029 variable @code{org-agenda-ndays})
6032 Remote editing from the agenda buffer means, for example, that you can
6033 change the dates of deadlines and appointments from the agenda buffer.
6034 The commands available in the Agenda buffer are listed in @ref{Agenda
6037 @subsubheading Calendar/Diary integration
6038 @cindex calendar integration
6039 @cindex diary integration
6041 Emacs contains the calendar and diary by Edward M. Reingold. The
6042 calendar displays a three-month calendar with holidays from different
6043 countries and cultures. The diary allows you to keep track of
6044 anniversaries, lunar phases, sunrise/set, recurrent appointments
6045 (weekly, monthly) and more. In this way, it is quite complementary to
6046 Org. It can be very useful to combine output from Org with
6049 In order to include entries from the Emacs diary into Org mode's
6050 agenda, you only need to customize the variable
6053 (setq org-agenda-include-diary t)
6056 @noindent After that, everything will happen automatically. All diary
6057 entries including holidays, anniversaries etc will be included in the
6058 agenda buffer created by Org mode. @key{SPC}, @key{TAB}, and
6059 @key{RET} can be used from the agenda buffer to jump to the diary
6060 file in order to edit existing diary entries. The @kbd{i} command to
6061 insert new entries for the current date works in the agenda buffer, as
6062 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
6063 Sunrise/Sunset times, show lunar phases and to convert to other
6064 calendars, respectively. @kbd{c} can be used to switch back and forth
6065 between calendar and agenda.
6067 If you are using the diary only for sexp entries and holidays, it is
6068 faster to not use the above setting, but instead to copy or even move
6069 the entries into an Org file. Org mode evaluates diary-style sexp
6070 entries, and does it faster because there is no overhead for first
6071 creating the diary display. Note that the sexp entries must start at
6072 the left margin, no white space is allowed before them. For example,
6073 the following segment of an Org file will be processed and entries
6074 will be made in the agenda:
6077 * Birthdays and similar stuff
6079 %%(org-calendar-holiday) ; special function for holiday names
6081 %%(diary-anniversary 14 5 1956) Arthur Dent is %d years old
6082 %%(diary-anniversary 2 10 1869) Mahatma Gandhi would be %d years old
6085 @subsubheading Anniversaries from BBDB
6086 @cindex BBDB, anniversaries
6087 @cindex anniversaries, from BBDB
6089 If you are using the Big Brothers Database to store your contacts, you will
6090 very likely prefer to store anniversaries in BBDB rather than in a
6091 separate Org or diary file. Org supports this and will show BBDB
6092 anniversaries as part of the agenda. All you need to do is to add the
6093 following to one your your agenda files:
6100 %%(org-bbdb-anniversaries)
6103 You can then go ahead and define anniversaries for a BBDB record. Basically,
6104 you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB
6105 record and then add the date in the format @code{YYYY-MM-DD}, followed by a
6106 space and the class of the anniversary (@samp{birthday} or @samp{wedding}, or
6107 a format string). If you omit the class, it will default to @samp{birthday}.
6108 Here are a few examples, the header for the file @file{org-bbdb.el} contains
6109 more detailed information.
6114 2008-04-14 %s released version 6.01 of Org-mode, %d years ago
6117 After a change to BBDB, or for the first agenda display during an Emacs
6118 session, the agenda display will suffer a short delay as Org updates it's
6119 hash with anniversaries. However, from then on things will be very fast -
6120 much faster in fact than a long list of @samp{%%(diary-anniversary)} entries
6121 in an Org or Diary file.
6123 @subsubheading Appointment reminders
6124 @cindex @file{appt.el}
6125 @cindex appointment reminders
6127 Org can interact with Emacs appointments notification facility. To add all
6128 the appointments of your agenda files, use the command
6129 @code{org-agenda-to-appt}. This commands also lets you filter through the
6130 list of your appointments and add only those belonging to a specific category
6131 or matching a regular expression. See the docstring for details.
6133 @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views
6134 @subsection The global TODO list
6135 @cindex global TODO list
6136 @cindex TODO list, global
6138 The global TODO list contains all unfinished TODO items, formatted and
6139 collected into a single place.
6144 Show the global TODO list. This collects the TODO items from all
6145 agenda files (@pxref{Agenda Views}) into a single buffer. The buffer is in
6146 @code{agenda-mode}, so there are commands to examine and manipulate
6147 the TODO entries directly from that buffer (@pxref{Agenda commands}).
6150 @cindex TODO keyword matching
6151 @vindex org-todo-keywords
6152 Like the above, but allows selection of a specific TODO keyword. You
6153 can also do this by specifying a prefix argument to @kbd{C-c a t}. With
6154 a @kbd{C-u} prefix you are prompted for a keyword, and you may also
6155 specify several keywords by separating them with @samp{|} as boolean OR
6156 operator. With a numeric prefix, the Nth keyword in
6157 @code{org-todo-keywords} is selected.
6159 The @kbd{r} key in the agenda buffer regenerates it, and you can give
6160 a prefix argument to this command to change the selected TODO keyword,
6161 for example @kbd{3 r}. If you often need a search for a specific
6162 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
6163 Matching specific TODO keywords can also be done as part of a tags
6164 search (@pxref{Tag searches}).
6167 Remote editing of TODO items means that you can change the state of a
6168 TODO entry with a single key press. The commands available in the
6169 TODO list are described in @ref{Agenda commands}.
6171 @cindex sublevels, inclusion into TODO list
6172 Normally the global TODO list simply shows all headlines with TODO
6173 keywords. This list can become very long. There are two ways to keep
6177 @vindex org-agenda-todo-ignore-scheduled
6178 @vindex org-agenda-todo-ignore-deadlines
6179 @vindex org-agenda-todo-ignore-with-date
6180 Some people view a TODO item that has been @emph{scheduled} for execution or
6181 have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}
6182 Configure the variables @code{org-agenda-todo-ignore-scheduled},
6183 @code{org-agenda-todo-ignore-deadlines}, and/or
6184 @code{org-agenda-todo-ignore-with-date} to exclude such items from the
6187 @vindex org-agenda-todo-list-sublevels
6188 TODO items may have sublevels to break up the task into subtasks. In
6189 such cases it may be enough to list only the highest level TODO headline
6190 and omit the sublevels from the global list. Configure the variable
6191 @code{org-agenda-todo-list-sublevels} to get this behavior.
6194 @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views
6195 @subsection Matching tags and properties
6196 @cindex matching, of tags
6197 @cindex matching, of properties
6201 If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}),
6202 or have properties @pxref{Properties and Columns}, you can select headlines
6203 based on this meta data and collect them into an agenda buffer. The match
6204 syntax described here also applies when creating sparse trees with @kbd{C-c /
6210 Produce a list of all headlines that match a given set of tags. The
6211 command prompts for a selection criterion, which is a boolean logic
6212 expression with tags, like @samp{+work+urgent-withboss} or
6213 @samp{work|home} (@pxref{Tags}). If you often need a specific search,
6214 define a custom command for it (@pxref{Agenda dispatcher}).
6217 @vindex org-tags-match-list-sublevels
6218 @vindex org-agenda-tags-todo-honor-ignore-options
6219 Like @kbd{C-c a m}, but only select headlines that are also TODO items and
6220 force checking subitems (see variable @code{org-tags-match-list-sublevels}).
6221 To exclude scheduled/deadline items, see the variable
6222 @code{org-agenda-tags-todo-honor-ignore-options}. Matching specific TODO
6223 keywords together with a tags match is also possible, see @ref{Tag searches}.
6226 The commands available in the tags list are described in @ref{Agenda
6229 @subsubheading Match syntax
6231 @cindex Boolean logic, for tag/property searches
6232 A search string can use Boolean operators @samp{&} for AND and @samp{|} for
6233 OR. @samp{&} binds more strongly than @samp{|}. Parenthesis are currently
6234 not implemented. Each element in the search is either a tag, a regular
6235 expression matching tags, or an expression like @code{PROPERTY OPERATOR
6236 VALUE} with a comparison operator, accessing a property value. Each element
6237 may be preceded by @samp{-}, to select against it, and @samp{+} is syntactic
6238 sugar for positive selection. The AND operator @samp{&} is optional when
6239 @samp{+} or @samp{-} is present. Here are some examples, using only tags.
6243 Select headlines tagged @samp{:work:}, but discard those also tagged
6246 Selects lines tagged @samp{:work:} or @samp{:laptop:}.
6247 @item work|laptop+night
6248 Like before, but require the @samp{:laptop:} lines to be tagged also
6252 @cindex regular expressions, with tags search
6253 Instead of a tag, you may also specify a regular expression enclosed in curly
6254 braces. For example,
6255 @samp{work+@{^boss.*@}} matches headlines that contain the tag
6256 @samp{:work:} and any tag @i{starting} with @samp{boss}.
6258 @cindex TODO keyword matching, with tags search
6259 @cindex level, require for tags/property match
6260 @cindex category, require for tags/property match
6261 @vindex org-odd-levels-only
6262 You may also test for properties (@pxref{Properties and Columns}) at the same
6263 time as matching tags. The properties may be real properties, or special
6264 properties that represent other meta data (@pxref{Special properties}). For
6265 example, the ``property'' @code{TODO} represents the TODO keyword of the
6266 entry. Or, the ``property'' @code{LEVEL} represents the level of an entry.
6267 So a search @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines
6268 that have the tag @samp{boss} and are @emph{not} marked with the TODO keyword
6269 DONE. In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not
6270 count the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc.
6272 Here are more examples:
6274 @item work+TODO="WAITING"
6275 Select @samp{:work:}-tagged TODO lines with the specific TODO
6276 keyword @samp{WAITING}.
6277 @item work+TODO="WAITING"|home+TODO="WAITING"
6278 Waiting tasks both at work and at home.
6281 When matching properties, a number of different operators can be used to test
6282 the value of a property. Here is a complex example:
6285 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 \
6286 +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
6290 The type of comparison will depend on how the comparison value is written:
6293 If the comparison value is a plain number, a numerical comparison is done,
6294 and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
6295 @samp{>=}, and @samp{<>}.
6297 If the comparison value is enclosed in double
6298 quotes, a string comparison is done, and the same operators are allowed.
6300 If the comparison value is enclosed in double quotes @emph{and} angular
6301 brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
6302 assumed to be date/time specifications in the standard Org way, and the
6303 comparison will be done accordingly. Special values that will be recognized
6304 are @code{"<now>"} for now (including time), and @code{"<today>"}, and
6305 @code{"<tomorrow>"} for these days at 0:00 hours, i.e. without a time
6306 specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
6307 @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
6308 respectively, can be used.
6310 If the comparison value is enclosed
6311 in curly braces, a regexp match is performed, with @samp{=} meaning that the
6312 regexp matches the property value, and @samp{<>} meaning that it does not
6316 So the search string in the example finds entries tagged @samp{:work:} but
6317 not @samp{:boss:}, which also have a priority value @samp{A}, a
6318 @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
6319 property that is numerically smaller than 2, a @samp{:With:} property that is
6320 matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
6321 on or after October 11, 2008.
6323 Accessing TODO, LEVEL, and CATEGORY during a search is fast. Accessing any
6324 other properties will slow down the search. However, once you have payed the
6325 price by accessig one property, testing additional properties is cheap
6328 You can configure Org mode to use property inheritance during a search, but
6329 beware that this can slow down searches considerably. See @ref{Property
6330 inheritance} for details.
6332 For backward compatibility, and also for typing speed, there is also a
6333 different way to test TODO states in a search. For this, terminalte the
6334 tags/property part of the search string (which may include several terms
6335 connected with @samp{|}) with a @samp{/} and then specify a Boolean
6336 expression just for TODO keywords. The syntax is then similar to that for
6337 tags, but should be applied with consideration: For example, a positive
6338 selection on several TODO keywords can not meaningfully be combined with
6339 boolean AND. However, @emph{negative selection} combined with AND can be
6340 meaningful. To make sure that only lines are checked that actually have any
6341 TODO keyword (resulting in a speed-up), use @kbd{C-c a M}, or equivalently
6342 start the TODO part after the slash with @samp{!}. Examples:
6346 Same as @samp{work+TODO="WAITING"}
6347 @item work/!-WAITING-NEXT
6348 Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
6350 @item work/!+WAITING|+NEXT
6351 Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
6355 @node Timeline, Keyword search, Matching tags and properties, Built-in agenda views
6356 @subsection Timeline for a single file
6357 @cindex timeline, single file
6358 @cindex time-sorted view
6360 The timeline summarizes all time-stamped items from a single Org mode
6361 file in a @emph{time-sorted view}. The main purpose of this command is
6362 to give an overview over events in a project.
6367 Show a time-sorted view of the org file, with all time-stamped items.
6368 When called with a @kbd{C-u} prefix, all unfinished TODO entries
6369 (scheduled or not) are also listed under the current date.
6373 The commands available in the timeline buffer are listed in
6374 @ref{Agenda commands}.
6376 @node Keyword search, Stuck projects, Timeline, Built-in agenda views
6377 @subsection Keyword search
6378 @cindex keyword search
6379 @cindex searching, for keywords
6381 This agenda view is a general text search facility for Org mode entries.
6382 It is particularly useful to find notes.
6387 This is a special search that lets you select entries by keywords or
6388 regular expression, using a boolean logic. For example, the search
6392 +computer +wifi -ethernet -@{8\.11[bg]@}
6396 will search for note entries that contain the keywords @code{computer}
6397 and @code{wifi}, but not the keyword @code{ethernet}, and which are also
6398 not matched by the regular expression @code{8\.11[bg]}, meaning to
6399 exclude both 8.11b and 8.11g.
6401 @vindex org-agenda-text-search-extra-files
6402 Note that in addition to the agenda files, this command will also search
6403 the files listed in @code{org-agenda-text-search-extra-files}.
6406 @node Stuck projects, , Keyword search, Built-in agenda views
6407 @subsection Stuck projects
6409 If you are following a system like David Allen's GTD to organize your
6410 work, one of the ``duties'' you have is a regular review to make sure
6411 that all projects move along. A @emph{stuck} project is a project that
6412 has no defined next actions, so it will never show up in the TODO lists
6413 Org mode produces. During the review, you need to identify such
6414 projects and define next actions for them.
6419 List projects that are stuck.
6422 @vindex org-stuck-projects
6423 Customize the variable @code{org-stuck-projects} to define what a stuck
6424 project is and how to find it.
6427 You almost certainly will have to configure this view before it will
6428 work for you. The built-in default assumes that all your projects are
6429 level-2 headlines, and that a project is not stuck if it has at least
6430 one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
6432 Let's assume that you, in your own way of using Org mode, identify
6433 projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
6434 indicate a project that should not be considered yet. Let's further
6435 assume that the TODO keyword DONE marks finished projects, and that NEXT
6436 and TODO indicate next actions. The tag @@SHOP indicates shopping and
6437 is a next action even without the NEXT tag. Finally, if the project
6438 contains the special word IGNORE anywhere, it should not be listed
6439 either. In this case you would start by identifying eligible projects
6440 with a tags/todo match@footnote{@ref{Tag searches}}
6441 @samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT, @@SHOP, and
6442 IGNORE in the subtree to identify projects that are not stuck. The
6443 correct customization for this is
6446 (setq org-stuck-projects
6447 '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
6451 Note that if a project is identified as non-stuck, the subtree of this entry
6452 will still be search for stuck projets.
6454 @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views
6455 @section Presentation and sorting
6456 @cindex presentation, of agenda items
6458 @vindex org-agenda-prefix-format
6459 Before displaying items in an agenda view, Org mode visually prepares
6460 the items and sorts them. Each item occupies a single line. The line
6461 starts with a @emph{prefix} that contains the @emph{category}
6462 (@pxref{Categories}) of the item and other important information. You can
6463 customize the prefix using the option @code{org-agenda-prefix-format}.
6464 The prefix is followed by a cleaned-up version of the outline headline
6465 associated with the item.
6468 * Categories:: Not all tasks are equal
6469 * Time-of-day specifications:: How the agenda knows the time
6470 * Sorting of agenda items:: The order of things
6473 @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting
6474 @subsection Categories
6477 The category is a broad label assigned to each agenda item. By default,
6478 the category is simply derived from the file name, but you can also
6479 specify it with a special line in the buffer, like this@footnote{For
6480 backward compatibility, the following also works: If there are several
6481 such lines in a file, each specifies the category for the text below it.
6482 The first category also applies to any text before the first CATEGORY
6483 line. However, using this method is @emph{strongly} deprecated as it is
6484 incompatible with the outline structure of the document. The correct
6485 method for setting multiple categories in a buffer is using a
6493 If you would like to have a special CATEGORY for a single entry or a
6494 (sub)tree, give the entry a @code{:CATEGORY:} property with the
6495 special category you want to apply as the value.
6498 The display in the agenda buffer looks best if the category is not
6499 longer than 10 characters.
6501 @node Time-of-day specifications, Sorting of agenda items, Categories, Presentation and sorting
6502 @subsection Time-of-day specifications
6503 @cindex time-of-day specification
6505 Org mode checks each agenda item for a time-of-day specification. The
6506 time can be part of the time stamp that triggered inclusion into the
6507 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time
6508 ranges can be specified with two time stamps, like
6510 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
6512 In the headline of the entry itself, a time(range) may also appear as
6513 plain text (like @samp{12:45} or a @samp{8:30-1pm}). If the agenda
6514 integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
6515 specifications in diary entries are recognized as well.
6517 For agenda display, Org mode extracts the time and displays it in a
6518 standard 24 hour format as part of the prefix. The example times in
6519 the previous paragraphs would end up in the agenda like this:
6522 8:30-13:00 Arthur Dent lies in front of the bulldozer
6523 12:45...... Ford Prefect arrives and takes Arthur to the pub
6524 19:00...... The Vogon reads his poem
6525 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
6529 If the agenda is in single-day mode, or for the display of today, the
6530 timed entries are embedded in a time grid, like
6533 8:00...... ------------------
6534 8:30-13:00 Arthur Dent lies in front of the bulldozer
6535 10:00...... ------------------
6536 12:00...... ------------------
6537 12:45...... Ford Prefect arrives and takes Arthur to the pub
6538 14:00...... ------------------
6539 16:00...... ------------------
6540 18:00...... ------------------
6541 19:00...... The Vogon reads his poem
6542 20:00...... ------------------
6543 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
6546 @vindex org-agenda-use-time-grid
6547 @vindex org-agenda-time-grid
6548 The time grid can be turned on and off with the variable
6549 @code{org-agenda-use-time-grid}, and can be configured with
6550 @code{org-agenda-time-grid}.
6552 @node Sorting of agenda items, , Time-of-day specifications, Presentation and sorting
6553 @subsection Sorting of agenda items
6554 @cindex sorting, of agenda items
6555 @cindex priorities, of agenda items
6556 Before being inserted into a view, the items are sorted. How this is
6557 done depends on the type of view.
6560 @vindex org-agenda-files
6561 For the daily/weekly agenda, the items for each day are sorted. The
6562 default order is to first collect all items containing an explicit
6563 time-of-day specification. These entries will be shown at the beginning
6564 of the list, as a @emph{schedule} for the day. After that, items remain
6565 grouped in categories, in the sequence given by @code{org-agenda-files}.
6566 Within each category, items are sorted by priority (@pxref{Priorities}),
6567 which is composed of the base priority (2000 for priority @samp{A}, 1000
6568 for @samp{B}, and 0 for @samp{C}), plus additional increments for
6569 overdue scheduled or deadline items.
6571 For the TODO list, items remain in the order of categories, but within
6572 each category, sorting takes place according to priority
6573 (@pxref{Priorities}).
6575 For tags matches, items are not sorted at all, but just appear in the
6576 sequence in which they are found in the agenda files.
6579 @vindex org-agenda-sorting-strategy
6580 Sorting can be customized using the variable
6581 @code{org-agenda-sorting-strategy}, and may also include criteria based on
6582 the estimated effort of an entry (@pxref{Effort estimates}).
6584 @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda Views
6585 @section Commands in the agenda buffer
6586 @cindex commands, in agenda buffer
6588 Entries in the agenda buffer are linked back to the org file or diary
6589 file where they originate. You are not allowed to edit the agenda
6590 buffer itself, but commands are provided to show and jump to the
6591 original entry location, and to edit the org-files ``remotely'' from
6592 the agenda buffer. In this way, all information is stored only once,
6593 removing the risk that your agenda and note files may diverge.
6595 Some commands can be executed with mouse clicks on agenda lines. For
6596 the other commands, the cursor needs to be in the desired line.
6599 @tsubheading{Motion}
6600 @cindex motion commands in agenda
6603 Next line (same as @key{up} and @kbd{C-p}).
6606 Previous line (same as @key{down} and @kbd{C-n}).
6607 @tsubheading{View/Go to org file}
6612 Display the original location of the item in another window.
6613 With prefix arg, make sure that the entire entry is made visible in the
6614 outline, not only the heading.
6618 Display original location and recenter that window.
6626 Go to the original location of the item in another window. Under Emacs
6627 22, @kbd{mouse-1} will also works for this.
6631 Go to the original location of the item and delete other windows.
6635 @vindex org-agenda-start-with-follow-mode
6636 Toggle Follow mode. In Follow mode, as you move the cursor through
6637 the agenda buffer, the other window always shows the corresponding
6638 location in the org file. The initial setting for this mode in new
6639 agenda buffers can be set with the variable
6640 @code{org-agenda-start-with-follow-mode}.
6644 Display the entire subtree of the current item in an indirect buffer. With a
6645 numeric prefix argument N, go up to level N and then take that tree. If N is
6646 negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the
6647 previously used indirect buffer.
6651 @vindex org-log-done
6652 @vindex org-agenda-log-mode-items
6653 Toggle Logbook mode. In Logbook mode, entries that were marked DONE while
6654 logging was on (variable @code{org-log-done}) are shown in the agenda, as are
6655 entries that have been clocked on that day. You can configure the entry
6656 types that should be included in log mode using the variable
6657 @code{org-agenda-log-mode-items}. When called with a @kbd{C-u} prefix, show
6658 all possible logbook entries, including state changes. When called with two
6659 prefix args @kbd{C-u C-u}, show only logging information, nothing else.
6663 Toggle Archives mode. In archives mode, trees that are marked
6664 @code{ARCHIVED} are also scanned when producing the agenda. When you call
6665 this command with a @kbd{C-u} prefix argument, even all archive files are
6666 included. To exit archives mode, press @kbd{v} again.
6670 @vindex org-agenda-start-with-clockreport-mode
6671 Toggle Clockreport mode. In clockreport mode, the daily/weekly agenda will
6672 always show a table with the clocked times for the timespan and file scope
6673 covered by the current agenda view. The initial setting for this mode in new
6674 agenda buffers can be set with the variable
6675 @code{org-agenda-start-with-clockreport-mode}.
6677 @tsubheading{Change display}
6678 @cindex display changing, in agenda
6681 Delete other windows.
6688 Switch to day/week/month/year view. When switching to day or week view,
6689 this setting becomes the default for subsequent agenda commands. Since
6690 month and year views are slow to create, they do not become the default.
6691 A numeric prefix argument may be used to jump directly to a specific day
6692 of the year, ISO week, month, or year, respectively. For example,
6693 @kbd{32 d} jumps to February 1st, @kbd{9 w} to ISO week number 9. When
6694 setting day, week, or month view, a year may be encoded in the prefix
6695 argument as well. For example, @kbd{200712 w} will jump to week 12 in
6696 2007. If such a year specification has only one or two digits, it will
6697 be mapped to the interval 1938-2037.
6701 Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}.
6705 @vindex org-agenda-use-time-grid
6706 @vindex org-agenda-time-grid
6707 Toggle the time grid on and off. See also the variables
6708 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
6712 Recreate the agenda buffer, for example to reflect the changes
6713 after modification of the time stamps of items with S-@key{left} and
6714 S-@key{right}. When the buffer is the global TODO list, a prefix
6715 argument is interpreted to create a selective list for a specific TODO
6725 Save all Org buffers in the current Emacs session, and also the locations of
6730 @vindex org-agenda-ndays
6731 Display the following @code{org-agenda-ndays} days. For example, if
6732 the display covers a week, switch to the following week. With prefix
6733 arg, go forward that many times @code{org-agenda-ndays} days.
6737 Display the previous dates.
6745 @vindex org-columns-default-format
6746 Invoke column view (@pxref{Column view}) in the agenda buffer. The column
6747 view format is taken from the entry at point, or (if there is no entry at
6748 point), from the first entry in the agenda view. So whatever the format for
6749 that entry would be in the original buffer (taken from a property, from a
6750 @code{#+COLUMNS} line, or from the default variable
6751 @code{org-columns-default-format}), will be used in the agenda.
6753 @tsubheading{Secondary filtering and query editing}
6754 @cindex filtering, by tag and effort, in agenda
6755 @cindex tag filtering, in agenda
6756 @cindex effort filtering, in agenda
6757 @cindex query editing, in agenda
6761 @vindex org-agenda-filter-preset
6762 Filter the current agenda view with respect to a tag and/or effort estimates.
6763 The difference between this and a custom agenda command is that filtering is
6764 very fast, so that you can switch quickly between different filters without
6765 having to recreate the agenda@footnote{Custom commands can preset a filter by
6766 binding the variable @code{org-agenda-filter-preset} as an option. This
6767 filter will then be applied to the view and presist as a basic filter through
6768 refreshes and more secondary filtering.}
6770 You will be prompted for a tag selection letter. Pressing @key{TAB} at that
6771 prompt will offer use completion to select a tag (including any tags that do
6772 not have a selection character). The command then hides all entries that do
6773 not contain or inherit this tag. When called with prefix arg, remove the
6774 entries that @emph{do} have the tag. A second @kbd{/} at the prompt will
6775 turn off the filter and unhide any hidden entries. If the first key you
6776 press is either @kbd{+} or @kbd{-}, the previous filter will be narrowed by
6777 requiring or forbidding the selected additional tag. Instead of pressing
6778 @kbd{+} or @kbd{-} after @kbd{/}, you can also immediately use the @kbd{\}
6781 In order to filter for effort estimates, you should set-up allowed
6782 efforts globally, for example
6784 (setq org-global-properties
6785 '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
6787 You can then filter for an effort by first typing an operator, one of @kbd{<},
6788 @kbd{>}, and @kbd{=}, and then the one-digit index of an effort estimate in
6789 your array of allowed values, where @kbd{0} means the 10th value. The filter
6790 will then restrict to entries with effort smaller-or-equal, equal, or
6791 larger-or-equal than the selected value. If the digits 0-9 are not used as
6792 fast access keys to tags, you can also simply press the index digit directly
6793 without an operator. In this case, @kbd{<} will be assumed.
6797 Narrow the current agenda filter by an additional condition. When called with
6798 prefix arg, remove the entries that @emph{do} have the tag, or that do match
6799 the effort criterion. You can achieve the same effect by pressing @kbd{+} or
6800 @kbd{-} as the first key after the @kbd{/} command.
6807 In the @i{search view} (@pxref{Keyword search}), these keys add new search
6808 words (@kbd{[} and @kbd{]}) or new regular expressions (@kbd{@{} and
6809 @kbd{@}}) to the query string. The opening bracket/brace will add a positive
6810 search term prefixed by @samp{+}, indicating that this search term @i{must}
6811 occur/match in the entry. The closing bracket/brace will add a negative
6812 search term which @i{must not} occur/match in the entry for it to be
6816 @tsubheading{Remote editing}
6817 @cindex remote editing, from agenda
6822 @cindex undoing remote-editing events
6823 @cindex remote editing, undo
6826 Undo a change due to a remote editing command. The change is undone
6827 both in the agenda buffer and in the remote buffer.
6831 Change the TODO state of the item, both in the agenda and in the
6836 @vindex org-agenda-confirm-kill
6837 Delete the current agenda item along with the entire subtree belonging
6838 to it in the original Org file. If the text to be deleted remotely
6839 is longer than one line, the kill needs to be confirmed by the user. See
6840 variable @code{org-agenda-confirm-kill}.
6844 Toggle the ARCHIVE tag for the current headline.
6848 Move the subtree corresponding to the current entry to its @emph{Archive
6853 Archive the subtree corresponding to the current headline. This means the
6854 entry will be moved to the configured archive location, most likely a
6859 @vindex org-agenda-show-inherited-tags
6860 Show all tags associated with the current item. This is useful if you have
6861 turned off @code{org-agenda-show-inherited-tags}, but still want to see all
6862 tags of a headline occasionally.
6866 Set tags for the current headline. If there is an active region in the
6867 agenda, change a tag for all headings in the region.
6871 Set the priority for the current item. Org mode prompts for the
6872 priority character. If you reply with @key{SPC}, the priority cookie
6873 is removed from the entry.
6877 Display weighted priority of current item.
6883 Increase the priority of the current item. The priority is changed in
6884 the original buffer, but the agenda is not resorted. Use the @kbd{r}
6888 @kindex S-@key{down}
6891 Decrease the priority of the current item.
6895 @vindex org-log-state-notes-into-drawer
6896 Add a note to the entry. This note will be recorded, and then files to the
6897 same location where state change notes a put. Depending on
6898 @code{org-log-state-notes-into-drawer}, this maybe inside a drawer.
6902 Dispatcher for all command related to attachments.
6910 Set a deadline for this item.
6914 Agenda actions, to set dates for selected items to the cursor date.
6915 This command also works in the calendar! The command prompts for an
6918 m @r{Mark the entry at point for action. You can also make entries}
6919 @r{in Org files with @kbd{C-c C-x C-k}.}
6920 d @r{Set the deadline of the marked entry to the date at point.}
6921 s @r{Schedule the marked entry at the date at point.}
6922 r @r{Call @code{org-remember} with the cursor date as default date.}
6924 Press @kbd{r} afterward to refresh the agenda and see the effect of the
6927 @kindex S-@key{right}
6929 Change the time stamp associated with the current line by one day into the
6930 future. With a numeric prefix argument, change it by that many days. For
6931 example, @kbd{3 6 5 S-@key{right}} will change it by a year. With a
6932 @kbd{C-u} prefix, change the time by one hour. If you immediately repeat the
6933 command, it will continue to change hours even without the prefix arg. With
6934 a double @kbd{C-u C-u} prefix, do the same for changing minutes. The stamp
6935 is changed in the original org file, but the change is not directly reflected
6936 in the agenda buffer. Use @kbd{r} or @kbd{g} to update the buffer.
6938 @kindex S-@key{left}
6940 Change the time stamp associated with the current line by one day
6945 Change the time stamp associated with the current line to today.
6946 The key @kbd{>} has been chosen, because it is the same as @kbd{S-.}
6951 Start the clock on the current item. If a clock is running already, it
6956 Stop the previously started clock.
6960 Cancel the currently running clock.
6964 Jump to the running clock in another window.
6966 @tsubheading{Calendar commands}
6967 @cindex calendar commands, from agenda
6970 Open the Emacs calendar and move to the date at the agenda cursor.
6973 When in the calendar, compute and show the Org mode agenda for the
6976 @cindex diary entries, creating from agenda
6979 Insert a new entry into the diary. Prompts for the type of entry
6980 (day, weekly, monthly, yearly, anniversary, cyclic) and creates a new
6981 entry in the diary, just as @kbd{i d} etc. would do in the calendar.
6982 The date is taken from the cursor position.
6986 Show the phases of the moon for the three months around current date.
6990 Show sunrise and sunset times. The geographical location must be set
6991 with calendar variables, see documentation of the Emacs calendar.
6995 Convert the date at cursor into many other cultural and historic
7000 Show holidays for three month around the cursor date.
7002 @item M-x org-export-icalendar-combine-agenda-files
7003 Export a single iCalendar file containing entries from all agenda files.
7004 This is a globally available command, and also available in the agenda menu.
7006 @tsubheading{Exporting to a file}
7009 @cindex exporting agenda views
7010 @cindex agenda views, exporting
7011 @vindex org-agenda-exporter-settings
7012 Write the agenda view to a file. Depending on the extension of the selected
7013 file name, the view will be exported as HTML (extension @file{.html} or
7014 @file{.htm}), Postscript (extension @file{.ps}), PDF (extension @file{.pdf}),
7015 or plain text (any other extension). When called with a @kbd{C-u} prefix
7016 argument, immediately open the newly created file. Use the variable
7017 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
7018 for @file{htmlize} to be used during export.
7020 @tsubheading{Quit and Exit}
7023 Quit agenda, remove the agenda buffer.
7026 @cindex agenda files, removing buffers
7028 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
7029 for the compilation of the agenda. Buffers created by the user to
7030 visit org files will not be removed.
7034 @node Custom agenda views, Agenda column view, Agenda commands, Agenda Views
7035 @section Custom agenda views
7036 @cindex custom agenda views
7037 @cindex agenda views, custom
7039 Custom agenda commands serve two purposes: to store and quickly access
7040 frequently used TODO and tags searches, and to create special composite
7041 agenda buffers. Custom agenda commands will be accessible through the
7042 dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
7045 * Storing searches:: Type once, use often
7046 * Block agenda:: All the stuff you need in a single buffer
7047 * Setting Options:: Changing the rules
7048 * Exporting Agenda Views:: Writing agendas to files
7049 * Using the agenda elsewhere:: Using agenda information in other programs
7052 @node Storing searches, Block agenda, Custom agenda views, Custom agenda views
7053 @subsection Storing searches
7055 The first application of custom searches is the definition of keyboard
7056 shortcuts for frequently used searches, either creating an agenda
7057 buffer, or a sparse tree (the latter covering of course only the current
7060 @vindex org-agenda-custom-commands
7061 Custom commands are configured in the variable
7062 @code{org-agenda-custom-commands}. You can customize this variable, for
7063 example by pressing @kbd{C-c a C}. You can also directly set it with
7064 Emacs Lisp in @file{.emacs}. The following example contains all valid
7069 (setq org-agenda-custom-commands
7070 '(("w" todo "WAITING")
7071 ("W" todo-tree "WAITING")
7072 ("u" tags "+boss-urgent")
7073 ("v" tags-todo "+boss-urgent")
7074 ("U" tags-tree "+boss-urgent")
7075 ("f" occur-tree "\\<FIXME\\>")
7076 ("h" . "HOME+Name tags searches") ; description for "h" prefix
7077 ("hl" tags "+home+Lisa")
7078 ("hp" tags "+home+Peter")
7079 ("hk" tags "+home+Kim")))
7084 The initial string in each entry defines the keys you have to press
7085 after the dispatcher command @kbd{C-c a} in order to access the command.
7086 Usually this will be just a single character, but if you have many
7087 similar commands, you can also define two-letter combinations where the
7088 first character is the same in several combinations and serves as a
7089 prefix key@footnote{You can provide a description for a prefix key by
7090 inserting a cons cell with the prefix and the description.}. The second
7091 parameter is the search type, followed by the string or regular
7092 expression to be used for the matching. The example above will
7097 as a global search for TODO entries with @samp{WAITING} as the TODO
7100 as the same search, but only in the current buffer and displaying the
7101 results as a sparse tree
7103 as a global tags search for headlines marked @samp{:boss:} but not
7106 as the same search as @kbd{C-c a u}, but limiting the search to
7107 headlines that are also TODO items
7109 as the same search as @kbd{C-c a u}, but only in the current buffer and
7110 displaying the result as a sparse tree
7112 to create a sparse tree (again: current buffer only) with all entries
7113 containing the word @samp{FIXME}
7115 as a prefix command for a HOME tags search where you have to press an
7116 additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
7117 Peter, or Kim) as additional tag to match.
7120 @node Block agenda, Setting Options, Storing searches, Custom agenda views
7121 @subsection Block agenda
7122 @cindex block agenda
7123 @cindex agenda, with block views
7125 Another possibility is the construction of agenda views that comprise
7126 the results of @emph{several} commands, each of which creates a block in
7127 the agenda buffer. The available commands include @code{agenda} for the
7128 daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
7129 for the global TODO list (as constructed with @kbd{C-c a t}), and the
7130 matching commands discussed above: @code{todo}, @code{tags}, and
7131 @code{tags-todo}. Here are two examples:
7135 (setq org-agenda-custom-commands
7136 '(("h" "Agenda and Home-related tasks"
7140 ("o" "Agenda and Office-related tasks"
7148 This will define @kbd{C-c a h} to create a multi-block view for stuff
7149 you need to attend to at home. The resulting agenda buffer will contain
7150 your agenda for the current week, all TODO items that carry the tag
7151 @samp{home}, and also all lines tagged with @samp{garden}. Finally the
7152 command @kbd{C-c a o} provides a similar view for office tasks.
7154 @node Setting Options, Exporting Agenda Views, Block agenda, Custom agenda views
7155 @subsection Setting options for custom commands
7156 @cindex options, for custom agenda views
7158 @vindex org-agenda-custom-commands
7159 Org mode contains a number of variables regulating agenda construction
7160 and display. The global variables define the behavior for all agenda
7161 commands, including the custom commands. However, if you want to change
7162 some settings just for a single custom view, you can do so. Setting
7163 options requires inserting a list of variable names and values at the
7164 right spot in @code{org-agenda-custom-commands}. For example:
7168 (setq org-agenda-custom-commands
7169 '(("w" todo "WAITING"
7170 ((org-agenda-sorting-strategy '(priority-down))
7171 (org-agenda-prefix-format " Mixed: ")))
7172 ("U" tags-tree "+boss-urgent"
7173 ((org-show-following-heading nil)
7174 (org-show-hierarchy-above nil)))
7176 ((org-agenda-files '("~org/notes.org"))
7177 (org-agenda-text-search-extra-files nil)))))
7182 Now the @kbd{C-c a w} command will sort the collected entries only by
7183 priority, and the prefix format is modified to just say @samp{ Mixed: }
7184 instead of giving the category of the entry. The sparse tags tree of
7185 @kbd{C-c a U} will now turn out ultra-compact, because neither the
7186 headline hierarchy above the match, nor the headline following the match
7187 will be shown. The command @kbd{C-c a N} will do a text search limited
7188 to only a single file.
7190 @vindex org-agenda-custom-commands
7191 For command sets creating a block agenda,
7192 @code{org-agenda-custom-commands} has two separate spots for setting
7193 options. You can add options that should be valid for just a single
7194 command in the set, and options that should be valid for all commands in
7195 the set. The former are just added to the command entry, the latter
7196 must come after the list of command entries. Going back to the block
7197 agenda example (@pxref{Block agenda}), let's change the sorting strategy
7198 for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
7199 the results for GARDEN tags query in the opposite order,
7200 @code{priority-up}. This would look like this:
7204 (setq org-agenda-custom-commands
7205 '(("h" "Agenda and Home-related tasks"
7209 ((org-agenda-sorting-strategy '(priority-up)))))
7210 ((org-agenda-sorting-strategy '(priority-down))))
7211 ("o" "Agenda and Office-related tasks"
7218 As you see, the values and parenthesis setting is a little complex.
7219 When in doubt, use the customize interface to set this variable - it
7220 fully supports its structure. Just one caveat: When setting options in
7221 this interface, the @emph{values} are just lisp expressions. So if the
7222 value is a string, you need to add the double quotes around the value
7226 @node Exporting Agenda Views, Using the agenda elsewhere, Setting Options, Custom agenda views
7227 @subsection Exporting Agenda Views
7228 @cindex agenda views, exporting
7230 If you are away from your computer, it can be very useful to have a printed
7231 version of some agenda views to carry around. Org mode can export custom
7232 agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's
7233 @file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the
7234 ghostscript @file{ps2pdf} utility must be installed on the system. Selecting
7235 a pdf file with also create the postscript file.}, and iCalendar files. If
7236 you want to do this only occasionally, use the command
7241 @cindex exporting agenda views
7242 @cindex agenda views, exporting
7243 @vindex org-agenda-exporter-settings
7244 Write the agenda view to a file. Depending on the extension of the
7245 selected file name, the view will be exported as HTML (extension
7246 @file{.html} or @file{.htm}), Postscript (extension @file{.ps}),
7247 iCalendar (extension @file{.ics}), or plain text (any other extension).
7248 Use the variable @code{org-agenda-exporter-settings} to
7249 set options for @file{ps-print} and for @file{htmlize} to be used during
7252 @vindex org-agenda-add-entry-text-maxlines
7253 @vindex htmlize-output-type
7254 @vindex ps-number-of-columns
7255 @vindex ps-landscape-mode
7257 (setq org-agenda-exporter-settings
7258 '((ps-number-of-columns 2)
7259 (ps-landscape-mode t)
7260 (org-agenda-add-entry-text-maxlines 5)
7261 (htmlize-output-type 'css)))
7265 If you need to export certain agenda views frequently, you can associate
7266 any custom agenda command with a list of output file names
7267 @footnote{If you want to store standard views like the weekly agenda
7268 or the global TODO list as well, you need to define custom commands for
7269 them in order to be able to specify file names.}. Here is an example
7270 that first does define custom commands for the agenda and the global
7271 todo list, together with a number of files to which to export them.
7272 Then we define two block agenda commands and specify file names for them
7273 as well. File names can be relative to the current working directory,
7278 (setq org-agenda-custom-commands
7279 '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
7280 ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
7281 ("h" "Agenda and Home-related tasks"
7286 ("~/views/home.html"))
7287 ("o" "Agenda and Office-related tasks"
7292 ("~/views/office.ps" "~/calendars/office.ics"))))
7296 The extension of the file name determines the type of export. If it is
7297 @file{.html}, Org mode will use the @file{htmlize.el} package to convert
7298 the buffer to HTML and save it to this file name. If the extension is
7299 @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
7300 postscript output. If the extension is @file{.ics}, iCalendar export is
7301 run export over all files that were used to construct the agenda, and
7302 limit the export to entries listed in the agenda now. Any other
7303 extension produces a plain ASCII file.
7305 The export files are @emph{not} created when you use one of those
7306 commands interactively because this might use too much overhead.
7307 Instead, there is a special command to produce @emph{all} specified
7313 Export all agenda views that have export file names associated with
7317 You can use the options section of the custom agenda commands to also
7318 set options for the export commands. For example:
7321 (setq org-agenda-custom-commands
7323 ((ps-number-of-columns 2)
7324 (ps-landscape-mode t)
7325 (org-agenda-prefix-format " [ ] ")
7326 (org-agenda-with-colors nil)
7327 (org-agenda-remove-tags t))
7332 This command sets two options for the postscript exporter, to make it
7333 print in two columns in landscape format - the resulting page can be cut
7334 in two and then used in a paper agenda. The remaining settings modify
7335 the agenda prefix to omit category and scheduling information, and
7336 instead include a checkbox to check off items. We also remove the tags
7337 to make the lines compact, and we don't want to use colors for the
7338 black-and-white printer. Settings specified in
7339 @code{org-agenda-exporter-settings} will also apply, but the settings
7340 in @code{org-agenda-custom-commands} take precedence.
7343 From the command line you may also use
7345 emacs -f org-batch-store-agenda-views -kill
7348 or, if you need to modify some parameters@footnote{Quoting may depend on the
7349 system you use, please check th FAQ for examples.}
7351 emacs -eval '(org-batch-store-agenda-views \
7352 org-agenda-ndays 30 \
7353 org-agenda-start-day "2007-11-01" \
7354 org-agenda-include-diary nil \
7355 org-agenda-files (quote ("~/org/project.org")))' \
7359 which will create the agenda views restricted to the file
7360 @file{~/org/project.org}, without diary entries and with 30 days
7363 @node Using the agenda elsewhere, , Exporting Agenda Views, Custom agenda views
7364 @subsection Using agenda information outside of Org
7365 @cindex agenda, pipe
7366 @cindex Scripts, for agenda processing
7368 @vindex org-agenda-custom-commands
7369 Org provides commands to access agenda information for the command
7370 line in emacs batch mode. This extracted information can be sent
7371 directly to a printer, or it can be read by a program that does further
7372 processing of the data. The first of these commands is the function
7373 @code{org-batch-agenda}, that produces an agenda view and sends it as
7374 ASCII text to STDOUT. The command takes a single string as parameter.
7375 If the string has length 1, it is used as a key to one of the commands
7376 you have configured in @code{org-agenda-custom-commands}, basically any
7377 key you can use after @kbd{C-c a}. For example, to directly print the
7378 current TODO list, you could use
7381 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
7384 If the parameter is a string with 2 or more characters, it is used as a
7385 tags/todo match string. For example, to print your local shopping list
7386 (all items with the tag @samp{shop}, but excluding the tag
7387 @samp{NewYork}), you could use
7390 emacs -batch -l ~/.emacs \
7391 -eval '(org-batch-agenda "+shop-NewYork")' | lpr
7395 You may also modify parameters on the fly like this:
7398 emacs -batch -l ~/.emacs \
7399 -eval '(org-batch-agenda "a" \
7400 org-agenda-ndays 30 \
7401 org-agenda-include-diary nil \
7402 org-agenda-files (quote ("~/org/project.org")))' \
7407 which will produce a 30 day agenda, fully restricted to the Org file
7408 @file{~/org/projects.org}, not even including the diary.
7410 If you want to process the agenda data in more sophisticated ways, you
7411 can use the command @code{org-batch-agenda-csv} to get a comma-separated
7412 list of values for each agenda item. Each line in the output will
7413 contain a number of fields separated by commas. The fields in a line
7417 category @r{The category of the item}
7418 head @r{The headline, without TODO kwd, TAGS and PRIORITY}
7419 type @r{The type of the agenda entry, can be}
7420 todo @r{selected in TODO match}
7421 tagsmatch @r{selected in tags match}
7422 diary @r{imported from diary}
7423 deadline @r{a deadline}
7424 scheduled @r{scheduled}
7425 timestamp @r{appointment, selected by timestamp}
7426 closed @r{entry was closed on date}
7427 upcoming-deadline @r{warning about nearing deadline}
7428 past-scheduled @r{forwarded scheduled item}
7429 block @r{entry has date block including date}
7430 todo @r{The TODO keyword, if any}
7431 tags @r{All tags including inherited ones, separated by colons}
7432 date @r{The relevant date, like 2007-2-14}
7433 time @r{The time, like 15:00-16:50}
7434 extra @r{String with extra planning info}
7435 priority-l @r{The priority letter if any was given}
7436 priority-n @r{The computed numerical priority}
7440 Time and date will only be given if a timestamp (or deadline/scheduled)
7441 lead to the selection of the item.
7443 A CSV list like this is very easy to use in a post processing script.
7444 For example, here is a Perl program that gets the TODO list from
7445 Emacs/Org and prints all the items, preceded by a checkbox:
7450 # define the Emacs command to run
7451 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
7453 # run it and capture the output
7454 $agenda = qx@{$cmd 2>/dev/null@};
7456 # loop over all lines
7457 foreach $line (split(/\n/,$agenda)) @{
7458 # get the individual values
7459 ($category,$head,$type,$todo,$tags,$date,$time,$extra,
7460 $priority_l,$priority_n) = split(/,/,$line);
7462 print "[ ] $head\n";
7466 @node Agenda column view, , Custom agenda views, Agenda Views
7467 @section Using column view in the agenda
7468 @cindex column view, in agenda
7469 @cindex agenda, column view
7471 Column view (@pxref{Column view}) is normally used to view and edit
7472 properties embedded in the hierarchical structure of an Org file. It can be
7473 quite useful to use column view also from the agenda, where entries are
7474 collected by certain criteria.
7479 Turn on column view in the agenda.
7482 To understand how to use this properly, it is important to realize that the
7483 entries in the agenda are no longer in their proper outline environment.
7484 This causes the following issues:
7488 @vindex org-columns-default-format
7489 @vindex org-overriding-columns-format
7490 Org needs to make a decision which @code{COLUMNS} format to use. Since the
7491 entries in the agenda are collected from different files, and different files
7492 may have different @code{COLUMNS} formats, this is a non-trivial problem.
7493 Org first checks if the variable @code{org-overriding-columns-format} is
7494 currently set, and if yes takes the format from there. Otherwise it takes
7495 the format associated with the first item in the agenda, or, if that item
7496 does not have a specific format (defined in a property, or in it's file), it
7497 uses @code{org-columns-default-format}.
7499 If any of the columns has a summary type defined (@pxref{Column attributes}),
7500 turning on column view in the agenda will visit all relevant agenda files and
7501 make sure that the computations of this property are up to date. This is
7502 also true for the special @code{CLOCKSUM} property. Org will then sum the
7503 values displayed in the agenda. In the daily/weekly agenda, the sums will
7504 cover a single day, in all other views they cover the entire block. It is
7505 vital to realize that the agenda may show the same entry @emph{twice} (for
7506 example as scheduled and as a deadline), and it may show two entries from the
7507 same hierarchy (for example a @emph{parent} and it's @emph{child}). In these
7508 cases, the summation in the agenda will lead to incorrect results because
7509 some values will count double.
7511 When the column view in the agenda shows the @code{CLOCKSUM}, that is always
7512 the entire clocked time for this item. So even in the daily/weekly agenda,
7513 the clocksum listed in column view may originate from times outside the
7514 current view. This has the advantage that you can compare these values with
7515 a column listing the planned total effort for a task - one of the major
7516 applications for column view in the agenda. If you want information about
7517 clocked time in the displayed period use clock table mode (press @kbd{R} in
7522 @node Embedded LaTeX, Exporting, Agenda Views, Top
7523 @chapter Embedded LaTeX
7524 @cindex @TeX{} interpretation
7525 @cindex La@TeX{} interpretation
7527 Plain ASCII is normally sufficient for almost all note taking. One
7528 exception, however, are scientific notes which need to be able to contain
7529 mathematical symbols and the occasional formula. La@TeX{}@footnote{La@TeX{}
7530 is a macro system based on Donald E. Knuth's @TeX{} system. Many of the
7531 features described here as ``La@TeX{}'' are really from @TeX{}, but for
7532 simplicity I am blurring this distinction.} is widely used to typeset
7533 scientific documents. Org mode supports embedding La@TeX{} code into its
7534 files, because many academics are used to reading La@TeX{} source code, and
7535 because it can be readily processed into images for HTML production.
7537 It is not necessary to mark La@TeX{} macros and code in any special way.
7538 If you observe a few conventions, Org mode knows how to find it and what
7542 * Math symbols:: TeX macros for symbols and Greek letters
7543 * Subscripts and superscripts:: Simple syntax for raising/lowering text
7544 * LaTeX fragments:: Complex formulas made easy
7545 * Processing LaTeX fragments:: Previewing LaTeX processing
7546 * CDLaTeX mode:: Speed up entering of formulas
7549 @node Math symbols, Subscripts and superscripts, Embedded LaTeX, Embedded LaTeX
7550 @section Math symbols
7551 @cindex math symbols
7554 You can use La@TeX{} macros to insert special symbols like @samp{\alpha} to
7555 indicate the Greek letter, or @samp{\to} to indicate an arrow. Completion
7556 for these macros is available, just type @samp{\} and maybe a few letters,
7557 and press @kbd{M-@key{TAB}} to see possible completions. Unlike La@TeX{}
7558 code, Org mode allows these macros to be present without surrounding math
7559 delimiters, for example:
7562 Angles are written as Greek letters \alpha, \beta and \gamma.
7565 During HTML export (@pxref{HTML export}), these symbols are translated
7566 into the proper syntax for HTML, for the above examples this is
7567 @samp{α} and @samp{→}, respectively. If you need such a symbol
7568 inside a word, terminate it like this: @samp{\Aacute@{@}stor}.
7570 @node Subscripts and superscripts, LaTeX fragments, Math symbols, Embedded LaTeX
7571 @section Subscripts and superscripts
7575 Just like in La@TeX{}, @samp{^} and @samp{_} are used to indicate super-
7576 and subscripts. Again, these can be used without embedding them in
7577 math-mode delimiters. To increase the readability of ASCII text, it is
7578 not necessary (but OK) to surround multi-character sub- and superscripts
7579 with curly braces. For example
7582 The mass if the sun is M_sun = 1.989 x 10^30 kg. The radius of
7583 the sun is R_@{sun@} = 6.96 x 10^8 m.
7586 To avoid interpretation as raised or lowered text, you can quote
7587 @samp{^} and @samp{_} with a backslash: @samp{\_} and @samp{\^}.
7589 During HTML export (@pxref{HTML export}), subscript and superscripts
7590 are surrounded with @code{<sub>} and @code{<sup>} tags, respectively.
7592 @node LaTeX fragments, Processing LaTeX fragments, Subscripts and superscripts, Embedded LaTeX
7593 @section LaTeX fragments
7594 @cindex LaTeX fragments
7596 @vindex org-format-latex-header
7597 With symbols, sub- and superscripts, HTML is pretty much at its end when
7598 it comes to representing mathematical formulas@footnote{Yes, there is
7599 MathML, but that is not yet fully supported by many browsers, and there
7600 is no decent converter for turning La@TeX{} or ASCII representations of
7601 formulas into MathML. So for the time being, converting formulas into
7602 images seems the way to go.}. More complex expressions need a dedicated
7603 formula processor. To this end, Org mode can contain arbitrary La@TeX{}
7604 fragments. It provides commands to preview the typeset result of these
7605 fragments, and upon export to HTML, all fragments will be converted to
7606 images and inlined into the HTML document@footnote{The La@TeX{} export
7607 will not use images for displaying La@TeX{} fragments but include these
7608 fragments directly into the La@TeX{} code.}. For this to work you
7609 need to be on a system with a working La@TeX{} installation. You also
7610 need the @file{dvipng} program, available at
7611 @url{http://sourceforge.net/projects/dvipng/}. The La@TeX{} header that
7612 will be used when processing a fragment can be configured with the
7613 variable @code{org-format-latex-header}.
7615 La@TeX{} fragments don't need any special marking at all. The following
7616 snippets will be identified as La@TeX{} source code:
7619 Environments of any kind. The only requirement is that the
7620 @code{\begin} statement appears on a new line, preceded by only
7623 Text within the usual La@TeX{} math delimiters. To avoid conflicts with
7624 currency specifications, single @samp{$} characters are only recognized as
7625 math delimiters if the enclosed text contains at most two line breaks, is
7626 directly attached to the @samp{$} characters with no whitespace in between,
7627 and if the closing @samp{$} is followed by whitespace, punctuation or a dash.
7628 For the other delimiters, there is no such restriction, so when in doubt, use
7629 @samp{\(...\)} as inline math delimiters.
7632 @noindent For example:
7635 \begin@{equation@} % arbitrary environments,
7636 x=\sqrt@{b@} % even tables, figures
7637 \end@{equation@} % etc
7639 If $a^2=b$ and \( b=2 \), then the solution must be
7640 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
7644 @vindex org-format-latex-options
7645 If you need any of the delimiter ASCII sequences for other purposes, you
7646 can configure the option @code{org-format-latex-options} to deselect the
7647 ones you do not wish to have interpreted by the La@TeX{} converter.
7649 @node Processing LaTeX fragments, CDLaTeX mode, LaTeX fragments, Embedded LaTeX
7650 @section Processing LaTeX fragments
7651 @cindex LaTeX fragments, preview
7653 La@TeX{} fragments can be processed to produce a preview images of the
7654 typeset expressions:
7659 Produce a preview image of the La@TeX{} fragment at point and overlay it
7660 over the source code. If there is no fragment at point, process all
7661 fragments in the current entry (between two headlines). When called
7662 with a prefix argument, process the entire subtree. When called with
7663 two prefix arguments, or when the cursor is before the first headline,
7664 process the entire buffer.
7667 Remove the overlay preview images.
7670 During HTML export (@pxref{HTML export}), all La@TeX{} fragments are
7671 converted into images and inlined into the document if the following
7675 (setq org-export-with-LaTeX-fragments t)
7678 @node CDLaTeX mode, , Processing LaTeX fragments, Embedded LaTeX
7679 @section Using CDLaTeX to enter math
7682 CDLaTeX mode is a minor mode that is normally used in combination with a
7683 major La@TeX{} mode like AUCTeX in order to speed-up insertion of
7684 environments and math templates. Inside Org mode, you can make use of
7685 some of the features of CDLaTeX mode. You need to install
7686 @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
7687 AUCTeX) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
7688 Don't use CDLaTeX mode itself under Org mode, but use the light
7689 version @code{org-cdlatex-mode} that comes as part of Org mode. Turn it
7690 on for the current buffer with @code{M-x org-cdlatex-mode}, or for all
7694 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
7697 When this mode is enabled, the following features are present (for more
7698 details see the documentation of CDLaTeX mode):
7702 Environment templates can be inserted with @kbd{C-c @{}.
7705 The @key{TAB} key will do template expansion if the cursor is inside a
7706 La@TeX{} fragment@footnote{Org mode has a method to test if the cursor is
7707 inside such a fragment, see the documentation of the function
7708 @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will
7709 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
7710 correctly inside the first brace. Another @key{TAB} will get you into
7711 the second brace. Even outside fragments, @key{TAB} will expand
7712 environment abbreviations at the beginning of a line. For example, if
7713 you write @samp{equ} at the beginning of a line and press @key{TAB},
7714 this abbreviation will be expanded to an @code{equation} environment.
7715 To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}.
7719 @vindex cdlatex-simplify-sub-super-scripts
7720 Pressing @kbd{_} and @kbd{^} inside a La@TeX{} fragment will insert these
7721 characters together with a pair of braces. If you use @key{TAB} to move
7722 out of the braces, and if the braces surround only a single character or
7723 macro, they are removed again (depending on the variable
7724 @code{cdlatex-simplify-sub-super-scripts}).
7727 Pressing the backquote @kbd{`} followed by a character inserts math
7728 macros, also outside La@TeX{} fragments. If you wait more than 1.5 seconds
7729 after the backquote, a help window will pop up.
7732 Pressing the normal quote @kbd{'} followed by another character modifies
7733 the symbol before point with an accent or a font. If you wait more than
7734 1.5 seconds after the backquote, a help window will pop up. Character
7735 modification will work only inside La@TeX{} fragments, outside the quote
7739 @node Exporting, Publishing, Embedded LaTeX, Top
7743 Org mode documents can be exported into a variety of other formats. For
7744 printing and sharing of notes, ASCII export produces a readable and
7745 simple version of an Org file. HTML export allows you to publish a
7746 notes file on the web, while the XOXO format provides a solid base for
7747 exchange with a broad range of other applications. La@TeX{} export lets
7748 you use Org mode and its structured editing functions to easily create
7749 La@TeX{} files. To incorporate entries with associated times like
7750 deadlines or appointments into a desktop calendar program like iCal,
7751 Org mode can also produce extracts in the iCalendar format. Currently
7752 Org mode only supports export, not import of these different formats.
7754 Org supports export of selected regions when @code{transient-mark-mode} is
7755 enabled (default in Emacs 23).
7758 * Markup rules:: Which structures are recognized?
7759 * Selective export:: Using tags to select and exclude trees
7760 * Export options:: Per-file export settings
7761 * The export dispatcher:: How to access exporter commands
7762 * ASCII export:: Exporting to plain ASCII
7763 * HTML export:: Exporting to HTML
7764 * LaTeX and PDF export:: Exporting to LaTeX, and processing to PDF
7765 * Docbook export:: Exporting to Docbook
7766 * XOXO export:: Exporting to XOXO
7767 * iCalendar export:: Exporting in iCalendar format
7770 @node Markup rules, Selective export, Exporting, Exporting
7771 @section Markup rules
7773 When exporting Org mode documents, the exporter tries to reflect the
7774 structure of the document as accurately as possible in the back-end. Since
7775 export targets like HTML or La@TeX{} allow much richer formatting, Org mode
7776 has rules how to prepare text for rich export. This section summarizes the
7777 markup rule used in an Org mode buffer.
7780 * Document title:: How the document title is determined
7781 * Headings and sections:: The main structure of the exported document
7782 * Table of contents:: If, where, how to create a table of contents
7783 * Initial text:: Text before the first headline
7784 * Lists:: Plain lists are exported
7785 * Paragraphs:: What determines beginning and ending
7786 * Literal examples:: Source code and other examples
7787 * Include files:: Include the contents of a file during export
7788 * Tables exported:: Tables are exported richly
7789 * Inlined images:: How to inline images during export
7790 * Footnote markup:: ASCII representation of footnotes
7791 * Emphasis and monospace:: To bold or not to bold
7792 * TeX macros and LaTeX fragments:: Create special, rich export.
7793 * Horizontal rules:: A line across the page
7794 * Comment lines:: Some lines will not be exported
7795 * Macro replacement:: Global replacement of place holdes
7798 @node Document title, Headings and sections, Markup rules, Markup rules
7799 @subheading Document title
7800 @cindex document title, markup rules
7803 The title of the exported document is taken from the special line
7806 #+TITLE: This is the title of the document
7810 If this line does not exist, the title is derived from the first non-empty,
7811 non-comment line in the buffer. If no such line exists, or if you have
7812 turned off exporting of the text before the first headline (see below), the
7813 title will be the file name without extension.
7815 If you are exporting only a subtree by marking is as the region, the heading
7816 of the subtree will become the title of the document. If the subtree has a
7817 property @code{EXPORT_TITLE}, that will take precedence.
7819 @node Headings and sections, Table of contents, Document title, Markup rules
7820 @subheading Headings and sections
7821 @cindex headings and sections, markup rules
7823 @vindex org-headline-levels
7824 The outline structure of the document as described in @ref{Document
7825 Structure} forms the basis for defining sections of the exported document.
7826 However, since the outline structure is also used for (for example) lists of
7827 tasks, only the first three outline levels will be used as headings. Deeper
7828 levels will become itemized lists. You can change the location of this
7829 switch, globally by setting the variable @code{org-headline-levels}, or on a
7830 per file basis with a line
7836 @node Table of contents, Initial text, Headings and sections, Markup rules
7837 @subheading Table of contents
7838 @cindex table of contents, markup rules
7840 @vindex org-export-with-toc
7841 The table of contents is normally inserted directly before the first headline
7842 of the file. If you would like to get it to a different location, insert the
7843 string @code{[TABLE-OF-CONTENTS]} on a line by itself at the desired
7844 location. The depth of the table of contents is by default the same as the
7845 number of headline levels, but you can choose a smaller number or turn off
7846 the table of contents entirely by configuring the variable
7847 @code{org-export-with-toc}, or on a per-file basis with a line like
7850 #+OPTIONS: toc:2 (only to two levels in TOC)
7851 #+OPTIONS: toc:nil (no TOC at all)
7854 @node Initial text, Lists, Table of contents, Markup rules
7855 @subheading Text before the first headline
7856 @cindex text before first headline, markup rules
7859 Org mode normally exports the text before the first headline, and even uses
7860 the first line as the document title. The text will be fully marked up. If
7861 you need to include literal HTML or La@TeX{} code, use the special constructs
7862 described below in the sections for the individual exporters.
7864 @vindex org-export-skip-text-before-1st-heading
7865 Some people like to use the space before the first headline for setup and
7866 internal links and therefore would like to control the exported text before
7867 the first headline in a different way. You can do so by setting the variable
7868 @code{org-export-skip-text-before-1st-heading} to @code{t}. On a per-file
7869 basis, you can get the same effect with @samp{#+OPTIONS: skip:t}.
7872 If you still want to have some text before the first headline, use the
7873 @code{#+TEXT} construct:
7877 #+TEXT: This text will go before the *first* headline.
7878 #+TEXT: [TABLE-OF-CONTENTS]
7879 #+TEXT: This goes between the table of contents and the first headline
7882 @node Lists, Paragraphs, Initial text, Markup rules
7884 @cindex lists, markup rules
7886 Plain lists as described in @ref{Plain lists} are translated to the back-ends
7887 syntax for such lists. Most back-ends support unordered, ordered, and
7890 @node Paragraphs, Literal examples, Lists, Markup rules
7891 @subheading Paragraphs, line breaks, and quoting
7892 @cindex paragraphs, markup rules
7894 Paragraphs are separated by at least one empty line. If you need to enforce
7895 a line break within a paragraph, use @samp{\\} at the end of a line.
7897 To keep the line breaks in a region, but otherwise use normal formatting, you
7898 can use this construct, which can also be used to format poetry.
7902 Great clouds overhead
7903 Tiny black birds rise and fall
7910 When quoting a passage from another document, it is customary to format this
7911 as a paragraph that is indented on both the left and the right margin. You
7912 can include quotations in Org mode documents like this:
7916 Everything should be made as simple as possible,
7917 but not any simpler -- Albert Einstein
7921 If you would like to center some text, do it like this:
7924 Everything should be made as simple as possible, \\
7929 @node Literal examples, Include files, Paragraphs, Markup rules
7930 @subheading Literal examples
7931 @cindex literal examples, markup rules
7932 @cindex code line refenences, markup rules
7934 You can include literal examples that should not be subjected to
7935 markup. Such examples will be typeset in monospace, so this is well suited
7936 for source code and similar examples.
7937 @cindex #+BEGIN_EXAMPLE
7941 Some example from a text file.
7945 For simplicity when using small examples, you can also start the example
7946 lines with a colon followed by a space. There may also be additional
7947 whitespace before the colon:
7951 : Some example from a text file.
7954 @cindex formatting source code, markup rules
7955 If the example is source code from a programming language, or any other text
7956 that can be marked up by font-lock in Emacs, you can ask for the example to
7957 look like the fontified Emacs buffer@footnote{Currently this works only for
7958 the HTML back-end, and requires the @file{htmlize.el} package version 1.34 or
7959 later.}. This is done with the @samp{src} block, where you also need to
7960 specify the name of the major mode that should be used to fontify the
7965 #+BEGIN_SRC emacs-lisp
7966 (defun org-xor (a b)
7972 Both in @code{example} and in @code{src} snippets, you can add a @code{-n}
7973 switch to the end of the @code{BEGIN} line, to get the lines of the example
7974 numbered. If you use a @code{+n} switch, the numbering from the previous
7975 numbered snippet will be continued in the current one. In literal examples,
7976 Org will interpret strings like @samp{(ref:name)} as labels, and use them as
7977 targets for special hyperlinks like @code{[[(name)]]} (i.e. the reference
7978 name enclosed in single parenthesis). In HTML, hovering the mouse over such
7979 a link will remote-highlight the corresponding code line, which is kind of
7980 cool. If the example/src snippet is numbered, you can also add a @code{-r}
7981 switch. Then labels will be @i{removed} from the source code and the links
7982 will be @i{replaced}@footnote{If you want to explain the use of such labels
7983 themelves in org-mode example code, you can use the @code{-k} switch to make
7984 sure they are not touched.} with line numbers from the code listing. Here is
7988 #+BEGIN_SRC emacs-lisp -n -r
7989 (save-excursion (ref:sc)
7990 (goto-char (point-min)) (ref:jump)
7992 In line [[(sc)]] we remember the current positon. [[(jump)][Line (jump)]]
7996 @vindex org-coderef-label-format
7997 If the syntax for the label format conflicts with the language syntax, use a
7998 @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
7999 -n -r -l "((%s))"}. See also the variable @code{org-coderef-label-format}.
8001 HTML export also allows examples to be published as text areas, @pxref{Text
8002 areas in HTML export}.
8007 Edit the source code example at point in its native mode. This works by
8008 switching to an indirect buffer, narrowing the buffer and switching to the
8009 other mode. You need to exit by pressing @kbd{C-c '} again@footnote{Upon
8010 exit, lines starting with @samp{*} or @samp{#} will get a comma prepended, to
8011 keep them from being interpreted by Org as outline nodes or special
8012 comments. These commas will be striped for editing with @kbd{C-c '}, and
8013 also for export.}. Fixed-width
8014 regions (where each line starts with a colon followed by a space) will be
8015 edited using @code{artist-mode}@footnote{You may select a different-mode with
8016 the variable @code{org-edit-fixed-width-region-mode}.} to allow creating
8017 ASCII drawings easily. Using this command in an empty line will create a new
8021 Calling @code{org-store-link} while editing a source code example in a
8022 temporary buffer created with @kbd{C-c '} will prompt for a label, make sure
8023 that it is unique in the current buffer, and insert it with the proper
8024 formatting like @samp{(ref:label)} at the end of the current line. Then the
8025 label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
8029 @node Include files, Tables exported, Literal examples, Markup rules
8030 @subheading Include files
8031 @cindex include files, markup rules
8033 During export, you can include the content of another file. For example, to
8034 include your .emacs file, you could use:
8038 #+INCLUDE: "~/.emacs" src emacs-lisp
8041 The optional second and third parameter are the markup (@samp{quote},
8042 @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the
8043 language for formatting the contents. The markup is optional, if it is not
8044 given, the text will be assumed to be in Org mode format and will be
8045 processed normally. The include line will also allow additional keyword
8046 parameters @code{:prefix1} and @code{:prefix} to specify prefixes for the
8047 first line and for each following line, as well as any options accepted by
8048 the selected markup. For example, to include a file as an item, use
8051 #+INCLUDE: "~/snippets/xx" :prefix1 " + " :prefix " "
8057 Visit the include file at point.
8060 @node Tables exported, Inlined images, Include files, Markup rules
8062 @cindex tables, markup rules
8064 Both the native Org mode tables (@pxref{Tables}) and tables formatted with
8065 the @file{table.el} package will be exported properly. For Org mode tables,
8066 the lines before the first horizontal separator line will become table header
8067 lines. You can use the following lines somewhere before the table to assign
8068 a caption and a label for cross references:
8071 #+CAPTION: This is the caption for the next table (or link)
8072 #+LABEL: tbl:basic-data
8075 @node Inlined images, Footnote markup, Tables exported, Markup rules
8076 @subheading Inlined Images
8077 @cindex inlined images, markup rules
8079 Some backends (HTML and LaTeX) allow to directly include images into the
8080 exported document. Org does this, if a link to an image files does not have
8081 a description part, for example @code{[[./img/a.jpg]]}. If you wish to
8082 define a caption for the image and maybe a label for internal cross
8083 references, you can use (before, but close to the link)
8086 #+CAPTION: This is the caption for the next figure link (or table)
8087 #+LABEL: fig:SED-HR4049
8090 You may also define additional attributes for the figure. As this is
8091 backend-specific, see the sections about the individual backends for more
8094 @node Footnote markup, Emphasis and monospace, Inlined images, Markup rules
8095 @subheading Footnote markup
8096 @cindex footnotes, markup rules
8097 @cindex @file{footnote.el}
8099 Footnotes defined in the way descriped in @ref{Footnotes} will be exported by
8100 all backends. Org does allow multiple references to the same note, and
8101 different backends support this to varying degree.
8103 @node Emphasis and monospace, TeX macros and LaTeX fragments, Footnote markup, Markup rules
8104 @subheading Emphasis and monospace
8106 @cindex underlined text, markup rules
8107 @cindex bold text, markup rules
8108 @cindex italic text, markup rules
8109 @cindex verbatim text, markup rules
8110 @cindex code text, markup rules
8111 @cindex strike-through text, markup rules
8112 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=}
8113 and @code{~verbatim~}, and, if you must, @samp{+strike-through+}. Text
8114 in the code and verbatim string is not processed for Org mode specific
8115 syntax, it is exported verbatim.
8117 @node TeX macros and LaTeX fragments, Horizontal rules, Emphasis and monospace, Markup rules
8118 @subheading @TeX{} macros and La@TeX{} fragments
8119 @cindex LaTeX fragments, markup rules
8120 @cindex TeX macros, markup rules
8121 @cindex HTML entities
8122 @cindex LaTeX entities
8124 @vindex org-html-entities
8125 A @TeX{}-like syntax is used to specify special characters. Where possible,
8126 these will be transformed into the native format of the exporter back-end.
8127 Strings like @code{\alpha} will be exported as @code{α} in the HTML
8128 output, and as @code{$\alpha$} in the La@TeX{} output. Similarly,
8129 @code{\nbsp} will become @code{ } in HTML and @code{~} in La@TeX{}.
8130 This applies for a large number of entities, with names taken from both HTML
8131 and La@TeX{}, see the variable @code{org-html-entities} for the complete
8132 list. If you are unsure about a name, use @kbd{M-@key{TAB}} for completion
8133 after having typed the backslash and maybe a few characters
8134 (@pxref{Completion}).
8136 La@TeX{} fragments are converted into images for HTML export, and they are
8137 written literally into the La@TeX{} export. See also @ref{Embedded LaTeX}.
8139 Finally, @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
8140 @samp{...} are all converted into special commands creating hyphens of
8141 different lengths or a compact set of dots.
8143 @node Horizontal rules, Comment lines, TeX macros and LaTeX fragments, Markup rules
8144 @subheading Horizontal rules
8145 @cindex horizontal rules, markup rules
8146 A line consisting of only dashes, and at least 5 of them, will be
8147 exported as a horizontal line (@samp{<hr/>} in HTML).
8149 @node Comment lines, Macro replacement, Horizontal rules, Markup rules
8150 @subheading Comment lines
8151 @cindex comment lines
8152 @cindex exporting, not
8154 Lines starting with @samp{#} in column zero are treated as comments and will
8155 never be exported. Also entire subtrees starting with the word
8156 @samp{COMMENT} will never be exported. Finally, regions surrounded by
8157 @samp{#+BEGIN_COMMENT} ... @samp{#+END_COMMENT} will not be exported.
8162 Toggle the COMMENT keyword at the beginning of an entry.
8165 @node Macro replacement, , Comment lines, Markup rules
8166 @subheading Macro replacement
8168 You can define text snippets with
8171 #+MACRO: name replacement text
8174 @noindent which can be referenced anywhere in the document (even in
8175 code examples) with @code{@{@{@{name@}@}@}}. In addition to defined macros,
8176 @code{@{@{@{title@}@}@}}, @code{@{@{@{author@}@}@}}, etc will reference
8177 information set by the @code{#+TITLE:}, @code{#+AUTHOR:}, and similar lines.
8179 @node Selective export, Export options, Markup rules, Exporting
8180 @section Selective export
8181 @cindex export, selective by tags
8183 @vindex org-export-select-tags
8184 @vindex org-export-exclude-tags
8185 You may use tags to select the parts of a document that should be exported,
8186 or to exclude parts from export. This behavior is governed by two variables:
8187 @code{org-export-select-tags} and @code{org-export-exclude-tags}.
8189 Org first checks if any of the @emph{select} tags is present in the buffer.
8190 If yes, all trees that do not carry one of these tags will be excluded. If a
8191 selected tree is a subtree, the heading hierarchy above it will also be
8192 selected for export, but not the text below those headings.
8195 If none of the select tags is found, the whole buffer will be selected for
8199 Finally, all subtrees that are marked by any of the @emph{exclude} tags will
8200 be removed from the export buffer.
8202 @node Export options, The export dispatcher, Selective export, Exporting
8203 @section Export options
8204 @cindex options, for export
8206 @cindex completion, of option keywords
8207 The exporter recognizes special lines in the buffer which provide
8208 additional information. These lines may be put anywhere in the file.
8209 The whole set of lines can be inserted into the buffer with @kbd{C-c
8210 C-e t}. For individual lines, a good way to make sure the keyword is
8211 correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion
8212 (@pxref{Completion}).
8217 Insert template with export options, see example below.
8224 @cindex #+DESCRIPTION:
8230 @cindex #+LINK_HOME:
8231 @cindex #+EXPORT_SELECT_TAGS:
8232 @cindex #+EXPORT_EXCLUDE_TAGS:
8233 @cindex #+LATEX_HEADER:
8234 @vindex user-full-name
8235 @vindex user-mail-address
8236 @vindex org-export-default-language
8238 #+TITLE: the title to be shown (default is the buffer name)
8239 #+AUTHOR: the author (default taken from @code{user-full-name})
8240 #+DATE: a date, fixed, of a format string for @code{format-time-string}
8241 #+EMAIL: his/her email address (default from @code{user-mail-address})
8242 #+DESCRIPTION: the page description, e.g. for the XHTML meta tag
8243 #+KEYWORDS: the page keywords, e.g. for the XHTML meta tag
8244 #+LANGUAGE: language for HTML, e.g. @samp{en} (@code{org-export-default-language})
8245 #+TEXT: Some descriptive text to be inserted at the beginning.
8246 #+TEXT: Several lines may be given.
8247 #+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ...
8248 #+LINK_UP: the ``up'' link of an exported page
8249 #+LINK_HOME: the ``home'' link of an exported page
8250 #+LATEX_HEADER: extra line(s) for the LaTeX header, like \usepackage@{xyz@}
8251 #+EXPORT_SELECT_TAGS: Tags that select a tree for export
8252 #+EXPORT_EXCLUDE_TAGS: Tags that exclude a tree from export
8256 The OPTIONS line is a compact@footnote{If you want to configure many options
8257 this way, you can use several OPTIONS lines.} form to specify export settings. Here
8259 @cindex headline levels
8260 @cindex section-numbers
8261 @cindex table of contents
8262 @cindex line-break preservation
8263 @cindex quoted HTML tags
8264 @cindex fixed-width sections
8266 @cindex @TeX{}-like syntax for sub- and superscripts
8268 @cindex special strings
8269 @cindex emphasized text
8270 @cindex @TeX{} macros
8271 @cindex La@TeX{} fragments
8272 @cindex author info, in export
8273 @cindex time info, in export
8275 H: @r{set the number of headline levels for export}
8276 num: @r{turn on/off section-numbers}
8277 toc: @r{turn on/off table of contents, or set level limit (integer)}
8278 \n: @r{turn on/off line-break-preservation}
8279 @@: @r{turn on/off quoted HTML tags}
8280 :: @r{turn on/off fixed-width sections}
8281 |: @r{turn on/off tables}
8282 ^: @r{turn on/off @TeX{}-like syntax for sub- and superscripts. If}
8283 @r{you write "^:@{@}", @code{a_@{b@}} will be interpreted, but}
8284 @r{the simple @code{a_b} will be left as it is.}
8285 -: @r{turn on/off conversion of special strings.}
8286 f: @r{turn on/off footnotes like this[1].}
8287 todo: @r{turn on/off inclusion of TODO keywords into exported text}
8288 pri: @r{turn on/off priority cookies}
8289 tags: @r{turn on/off inclusion of tags, may also be @code{not-in-toc}}
8290 <: @r{turn on/off inclusion of any time/date stamps like DEADLINES}
8291 *: @r{turn on/off emphasized text (bold, italic, underlined)}
8292 TeX: @r{turn on/off simple @TeX{} macros in plain text}
8293 LaTeX: @r{turn on/off La@TeX{} fragments}
8294 skip: @r{turn on/off skipping the text before the first heading}
8295 author: @r{turn on/off inclusion of author name/email into exported file}
8296 creator: @r{turn on/off inclusion of creator info into exported file}
8297 timestamp: @r{turn on/off inclusion creation time into exported file}
8298 d: @r{turn on/off inclusion of drawers}
8301 These options take effect in both the HTML and La@TeX{} export, except
8302 for @code{TeX} and @code{LaTeX}, which are respectively @code{t} and
8303 @code{nil} for the La@TeX{} export.
8305 When exporting only a single subtree by selecting it with @kbd{C-c @@} before
8306 calling an export command, the subtree can overrule some of the file's export
8307 settings with properties @code{EXPORT_FILE_NAME}, @code{EXPORT_TITLE},
8308 @code{EXPORT_TEXT}, and @code{EXPORT_OPTIONS}.
8310 @node The export dispatcher, ASCII export, Export options, Exporting
8311 @section The export dispatcher
8312 @cindex dispatcher, for export commands
8314 All export commands can be reached using the export dispatcher, which is a
8315 prefix key that prompts for an additional key specifying the command.
8316 Normally the entire file is exported, but if there is an active region that
8317 contains one outline tree, the first heading is used as document title and
8318 the subtrees are exported.
8323 @vindex org-export-run-in-background
8324 Dispatcher for export and publishing commands. Displays a help-window
8325 listing the additional key(s) needed to launch an export or publishing
8326 command. The prefix arg is passed through to the exporter. A double prefix
8327 @kbd{C-u C-u} causes most commands to be executed in the background, in a
8328 separate emacs process@footnote{To make this behavior the default, customize
8329 the variable @code{org-export-run-in-background}.}.
8332 Like @kbd{C-c C-e}, but only export the text that is currently visible
8333 (i.e. not hidden by outline visibility).
8334 @kindex C-u C-u C-c C-e
8335 @item C-u C-u C-c C-e
8336 @vindex org-export-run-in-background
8337 Call an the exporter, but reverse the setting of
8338 @code{org-export-run-in-background}, i.e. request background processing if
8339 not set, or force processing in the current Emacs process if st.
8342 @node ASCII export, HTML export, The export dispatcher, Exporting
8343 @section ASCII export
8344 @cindex ASCII export
8346 ASCII export produces a simple and very readable version of an Org mode
8349 @cindex region, active
8350 @cindex active region
8351 @cindex transient-mark-mode
8355 Export as ASCII file. For an org file @file{myfile.org}, the ASCII file
8356 will be @file{myfile.txt}. The file will be overwritten without
8357 warning. If there is an active region@footnote{this requires
8358 @code{transient-mark-mode} to be turned on}, only the region will be
8359 exported. If the selected region is a single tree@footnote{To select the
8360 current subtree, use @kbd{C-c @@}.}, the tree head will
8361 become the document title. If the tree head entry has or inherits an
8362 @code{EXPORT_FILE_NAME} property, that name will be used for the
8366 Export only the visible part of the document.
8369 @cindex headline levels, for exporting
8370 In the exported version, the first 3 outline levels will become
8371 headlines, defining a general document structure. Additional levels
8372 will be exported as itemized lists. If you want that transition to occur
8373 at a different level, specify it with a prefix argument. For example,
8380 creates only top level headlines and does the rest as items. When
8381 headlines are converted to items, the indentation of the text following
8382 the headline is changed to fit nicely under the item. This is done with
8383 the assumption that the first body line indicates the base indentation of
8384 the body text. Any indentation larger than this is adjusted to preserve
8385 the layout relative to the first line. Should there be lines with less
8386 indentation than the first, these are left alone.
8388 @vindex org-export-ascii-links-to-notes
8389 Links will be exported in a footnote-like style, with the descriptive part in
8390 the text and the link in a note before the next heading. See the variable
8391 @code{org-export-ascii-links-to-notes} for details and other options.
8393 @node HTML export, LaTeX and PDF export, ASCII export, Exporting
8394 @section HTML export
8397 Org mode contains an HTML (XHTML 1.0 strict) exporter with extensive
8398 HTML formatting, in ways similar to John Gruber's @emph{markdown}
8399 language, but with additional support for tables.
8402 * HTML Export commands:: How to invoke HTML export
8403 * Quoting HTML tags:: Using direct HTML in Org mode
8404 * Links:: Transformation of links for HTML
8405 * Images in HTML export:: How to insert figures into HTML output
8406 * Text areas in HTML export:: An alternative way to show an example
8407 * CSS support:: Changing the appearance of the output
8408 * Javascript support:: Info and Folding in a web browser
8411 @node HTML Export commands, Quoting HTML tags, HTML export, HTML export
8412 @subsection HTML export commands
8414 @cindex region, active
8415 @cindex active region
8416 @cindex transient-mark-mode
8420 Export as HTML file @file{myfile.html}. For an org file @file{myfile.org},
8421 the ASCII file will be @file{myfile.html}. The file will be overwritten
8422 without warning. If there is an active region@footnote{this requires
8423 @code{transient-mark-mode} to be turned on}, only the region will be
8424 exported. If the selected region is a single tree@footnote{To select the
8425 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
8426 title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
8427 property, that name will be used for the export.
8430 Export as HTML file and immediately open it with a browser.
8433 Export to a temporary buffer, do not create a file.
8436 Export the active region to a temporary buffer. With a prefix argument, do
8437 not produce the file header and footer, but just the plain HTML section for
8438 the region. This is good for cut-and-paste operations.
8447 Export only the visible part of the document.
8448 @item M-x org-export-region-as-html
8449 Convert the region to HTML under the assumption that it was Org mode
8450 syntax before. This is a global command that can be invoked in any
8452 @item M-x org-replace-region-by-HTML
8453 Replace the active region (assumed to be in Org mode syntax) by HTML
8457 @cindex headline levels, for exporting
8458 In the exported version, the first 3 outline levels will become headlines,
8459 defining a general document structure. Additional levels will be exported as
8460 itemized lists. If you want that transition to occur at a different level,
8461 specify it with a numeric prefix argument. For example,
8468 creates two levels of headings and does the rest as items.
8470 @node Quoting HTML tags, Links, HTML Export commands, HTML export
8471 @subsection Quoting HTML tags
8473 Plain @samp{<} and @samp{>} are always transformed to @samp{<} and
8474 @samp{>} in HTML export. If you want to include simple HTML tags
8475 which should be interpreted as such, mark them with @samp{@@} as in
8476 @samp{@@<b>bold text@@</b>}. Note that this really works only for
8477 simple tags. For more extensive HTML that should be copied verbatim to
8478 the exported file use either
8481 #+HTML: Literal HTML code for export
8485 @cindex #+BEGIN_HTML
8489 All lines between these markers are exported literally
8494 @node Links, Images in HTML export, Quoting HTML tags, HTML export
8497 @cindex links, in HTML export
8498 @cindex internal links, in HTML export
8499 @cindex external links, in HTML export
8500 Internal links (@pxref{Internal links}) will continue to work in HTML. This
8501 does include automatic links created by radio targets (@pxref{Radio
8502 targets}). Links to external files will still work if the target file is on
8503 the same @i{relative} path as the published Org file. Links to other
8504 @file{.org} files will be translated into HTML links under the assumption
8505 that an HTML version also exists of the linked file, at the same relative
8506 path. @samp{id:} links can then be used to jump to specific entries across
8507 files. For information related to linking files while publishing them to a
8508 publishing directory see @ref{Publishing links}.
8510 If you want to specify attributes for links, you can do so using a special
8511 @code{#+ATTR_HTML} line to define attributes that will be added to the
8512 @code{<a>} or @code{<img>} tags. Here is an example that sets @code{title}
8513 and @code{style} attributes for a link:
8516 #+ATTR_HTML: title="The Org-mode homepage" style="color:red;"
8517 [[http://orgmode.org]]
8520 @node Images in HTML export, Text areas in HTML export, Links, HTML export
8523 @cindex images, inline in HTML
8524 @cindex inlining images in HTML
8525 @vindex org-export-html-inline-images
8526 HTML export can inline images given as links in the Org file, and
8527 it can make an image the clickable part of a link. By
8528 default@footnote{but see the variable
8529 @code{org-export-html-inline-images}}, images are inlined if a link does
8530 not have a description. So @samp{[[file:myimg.jpg]]} will be inlined,
8531 while @samp{[[file:myimg.jpg][the image]]} will just produce a link
8532 @samp{the image} that points to the image. If the description part
8533 itself is a @code{file:} link or a @code{http:} URL pointing to an
8534 image, this image will be inlined and activated so that clicking on the
8535 image will activate the link. For example, to include a thumbnail that
8536 will link to a high resolution version of the image, you could use:
8539 [[file:highres.jpg][file:thumb.jpg]]
8542 If you need to add attributes to an inlines image, use a @code{#+ATTR_HTML},
8546 #+CAPTION: A black cat stalking a spider
8547 #+ATTR_HTML: alt="cat/spider image" title="one second before action"
8552 and you could use @code{http} addresses just as well.
8554 @node Text areas in HTML export, CSS support, Images in HTML export, HTML export
8555 @subsection Text areas
8557 @cindex text areas, in HTML
8558 An alternative way to publish literal code examples in HTML is to use text
8559 areas, where the example can even be edited before pasting it into an
8560 application. It is triggered by a @code{-t} switch at an @code{example} or
8561 @code{src} block. Using this switch disables any options for syntax and
8562 label highlighting, and line numbering, which may be present. You may also
8563 use @code{-h} and @code{-w} switches to specify the height and width of the
8564 text area, which default to the number of lines in the example, and 80,
8565 respectively. For example
8568 #+BEGIN_EXAMPLE -t -w 40
8569 (defun org-xor (a b)
8576 @node CSS support, Javascript support, Text areas in HTML export, HTML export
8577 @subsection CSS support
8578 @cindex CSS, for HTML export
8579 @cindex HTML export, CSS
8581 @vindex org-export-html-todo-kwd-class-prefix
8582 @vindex org-export-html-tag-class-prefix
8583 You can also give style information for the exported file. The HTML exporter
8584 assigns the following special CSS classes@footnote{If the classes on TODO
8585 keywords and tags lead to conflicts, use the variables
8586 @code{org-export-html-todo-kwd-class-prefix} and
8587 @code{org-export-html-tag-class-prefix} to make them unique.} to appropriate
8588 parts of the document - your style specifications may change these, in
8589 addition to any of the standard classes like for headlines, tables etc.
8591 p.author @r{author information, including email}
8592 p.date @r{publishing date}
8593 p.creator @r{creator info, about Org-mode version}
8594 .title @r{document title}
8595 .todo @r{TODO keywords, all not-done states}
8596 .done @r{the DONE keywords, all stated the count as done}
8597 .WAITING @r{each TODO keyword also uses a class named after itself}
8598 .timestamp @r{time stamp}
8599 .timestamp-kwd @r{keyword associated with a time stamp, like SCHEDULED}
8600 .tag @r{tag in a headline}
8601 ._HOME @r{each tag uses itself as a class, "@@" replaced by "_"}
8602 .target @r{target for links}
8603 .linenr @r{the line number in a code example}
8604 .code-highlighted @r{for highlighting referenced code lines}
8605 div.outline-N @r{div for outline level N (headline plus text))}
8606 div.outline-text-N @r{extra div for text at outline level N}
8607 .section-number-N @r{section number in headlines, different for each level}
8608 div.figure @r{how to format an inlined image}
8609 pre.src @r{formatted source code}
8610 pre.example @r{normal example}
8611 p.verse @r{verse paragraph}
8612 div.footnotes @r{footnote section headline}
8613 p.footnote @r{footnote definition paragraph, containing a footnote}
8614 .footref @r{a footnote reference number (always a <sup>)}
8615 .footnum @r{footnote number in footnote definition (always <sup>)}
8618 @vindex org-export-html-style-default
8619 @vindex org-export-html-style-include-default
8620 @vindex org-export-html-style
8621 @vindex org-export-html-extra
8622 @vindex org-export-html-style-default
8623 Each exported files contains a compact default style that defines these
8624 classes in a basic way@footnote{This style is defined in the constant
8625 @code{org-export-html-style-default}, which you should not modify. To turn
8626 inclusion of these defaults off, customize
8627 @code{org-export-html-style-include-default}}. You may overwrite these
8628 settings, or add to them by using the variables @code{org-export-html-style}
8629 (for Org-wide settings) and @code{org-export-html-style-extra} (for more
8630 granular settings, like file-local settings). To set the latter variable
8631 individually for each file, you can use
8634 #+STYLE: <link rel="stylesheet" type="text/css" href="stylesheet.css" />
8638 For longer style definitions, you can use several such lines. You could also
8639 directly write a @code{<style>} @code{</style>} section in this way, without
8640 referring to an external file.
8642 @c FIXME: More about header and footer styles
8643 @c FIXME: Talk about links and targets.
8645 @node Javascript support, , CSS support, HTML export
8646 @subsection Javascript supported display of web pages
8648 @emph{Sebastian Rose} has written a JavaScript program especially designed to
8649 enhance the web viewing experience of HTML files created with Org. This
8650 program allows you to view large files in two different ways. The first one
8651 is an @emph{Info}-like mode where each section is displayed separately and
8652 navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
8653 as well, press @kbd{?} for an overview of the available keys). The second
8654 view type is a @emph{folding} view much like Org provides inside Emacs. The
8655 script is available at @url{http://orgmode.org/org-info.js} and you can find
8656 the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
8657 We are serving the script from our site, but if you use it a lot, you might
8658 not want to be dependent on @url{orgmode.org} and prefer to install a local
8659 copy on your own web server.
8661 To use the script, you need to make sure that the @file{org-jsinfo.el} module
8662 gets loaded. It should be loaded by default, but you can try @kbd{M-x
8663 customize-variable @key{RET} org-modules @key{RET}} to convince yourself that
8664 this is indeed the case. All it then takes to make use of the program is
8665 adding a single line to the Org file:
8668 #+INFOJS_OPT: view:info toc:nil
8672 If this line is found, the HTML header will automatically contain the code
8673 needed to invoke the script. Using the line above, you can set the following
8677 path: @r{The path to the script. The default is to grab the script from}
8678 @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
8679 @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
8680 view: @r{Initial view when website is first shown. Possible values are:}
8681 info @r{Info-like interface with one section per page.}
8682 overview @r{Folding interface, initially showing only top-level.}
8683 content @r{Folding interface, starting with all headlines visible.}
8684 showall @r{Folding interface, all headlines and text visible.}
8685 sdepth: @r{Maximum headline level that will still become an independent}
8686 @r{section for info and folding modes. The default is taken from}
8687 @r{@code{org-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
8688 @r{If this is smaller than in @code{org-headline-levels}, each}
8689 @r{info/folding section can still contain children headlines.}
8690 toc: @r{Should the table of content @emph{initially} be visible?}
8691 @r{Even when @code{nil}, you can always get to the toc with @kbd{i}.}
8692 tdepth: @r{The depth of the table of contents. The defaults are taken from}
8693 @r{the variables @code{org-headline-levels} and @code{org-export-with-toc}.}
8694 ftoc: @r{Does the css of the page specify a fixed position for the toc?}
8695 @r{If yes, the toc will never be displayed as a section.}
8696 ltoc: @r{Should there be short contents (children) in each section?}
8697 @r{Make this @code{above} it the section should be above initial text.}
8698 mouse: @r{Headings are highlighted when the mouse is over them. Should be}
8699 @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
8700 buttons: @r{Should view-toggle buttons be everywhere? When @code{nil} (the}
8701 @r{default), only one such button will be present.}
8704 @vindex org-infojs-options
8705 @vindex org-export-html-use-infojs
8706 You can choose default values for these options by customizing the variable
8707 @code{org-infojs-options}. If you always want to apply the script to your
8708 pages, configure the variable @code{org-export-html-use-infojs}.
8710 @node LaTeX and PDF export, Docbook export, HTML export, Exporting
8711 @section LaTeX and PDF export
8712 @cindex LaTeX export
8715 Org mode contains a La@TeX{} exporter written by Bastien Guerry. With
8716 further processing, this backend is also used to produce PDF output. Since
8717 the LaTeX output uses @file{hyperref} to implement links and cross
8718 references, the PDF output file will be fully linked.
8721 * LaTeX/PDF export commands:: Which key invokes which commands
8722 * Quoting LaTeX code:: Incorporating literal LaTeX code
8723 * Sectioning structure:: Changing sectioning in LaTeX output
8724 * Tables in LaTeX export:: Options for exporting tables to LaTeX
8725 * Images in LaTeX export:: How to insert figures into LaTeX output
8728 @node LaTeX/PDF export commands, Quoting LaTeX code, LaTeX and PDF export, LaTeX and PDF export
8729 @subsection LaTeX export commands
8731 @cindex region, active
8732 @cindex active region
8733 @cindex transient-mark-mode
8737 Export as La@TeX{} file @file{myfile.tex}. For an org file
8738 @file{myfile.org}, the ASCII file will be @file{myfile.tex}. The file will
8739 be overwritten without warning. If there is an active region@footnote{this
8740 requires @code{transient-mark-mode} to be turned on}, only the region will be
8741 exported. If the selected region is a single tree@footnote{To select the
8742 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
8743 title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME}
8744 property, that name will be used for the export.
8747 Export to a temporary buffer, do not create a file.
8752 Export only the visible part of the document.
8753 @item M-x org-export-region-as-latex
8754 Convert the region to La@TeX{} under the assumption that it was Org mode
8755 syntax before. This is a global command that can be invoked in any
8757 @item M-x org-replace-region-by-latex
8758 Replace the active region (assumed to be in Org mode syntax) by La@TeX{}
8762 Export as LaTeX and then process to PDF.
8765 Export as LaTeX and then process to PDF, then open the resulting PDF file.
8768 @cindex headline levels, for exporting
8769 @vindex org-latex-low-levels
8770 In the exported version, the first 3 outline levels will become
8771 headlines, defining a general document structure. Additional levels
8772 will be exported as description lists. The exporter can ignore them or
8773 convert them to a custom string depending on
8774 @code{org-latex-low-levels}.
8776 If you want that transition to occur at a different level, specify it
8777 with a numeric prefix argument. For example,
8784 creates two levels of headings and does the rest as items.
8786 @node Quoting LaTeX code, Sectioning structure, LaTeX/PDF export commands, LaTeX and PDF export
8787 @subsection Quoting LaTeX code
8789 Embedded La@TeX{} as described in @ref{Embedded LaTeX} will be correctly
8790 inserted into the La@TeX{} file. This includes simple macros like
8791 @samp{\ref@{LABEL@}} to create a cross reference to a figure. Furthermore,
8792 you can add special code that should only be present in La@TeX{} export with
8793 the following constructs:
8796 #+LaTeX: Literal LaTeX code for export
8800 @cindex #+BEGIN_LaTeX
8804 All lines between these markers are exported literally
8808 @node Sectioning structure, Tables in LaTeX export, Quoting LaTeX code, LaTeX and PDF export
8809 @subsection Sectioning structure
8811 @cindex LaTeX sectioning structure
8813 By default, the La@TeX{} output uses the class @code{article}.
8815 @vindex org-export-latex-default-class
8816 @vindex org-export-latex-classes
8817 @cindex #+LATEX_HEADER:
8818 You can change this globally by setting a different value for
8819 @code{org-export-latex-default-class} or locally by adding an option like
8820 @code{#+LaTeX_CLASS: myclass} in your file, or with a @code{:LaTeX_CLASS:}
8821 property that applies when exporting a region containing only this (sub)tree.
8822 The class should be listed in @code{org-export-latex-classes}, where you can
8823 also define the sectioning structure for each class, as well as defining
8824 additional classes. You can also use @code{#+LATEX_HEADER:
8825 \usepackage@{xyz@}} to add lines to the header.
8827 @node Tables in LaTeX export, Images in LaTeX export, Sectioning structure, LaTeX and PDF export
8828 @subsection Tables in LaTeX export
8829 @cindex tables, in LaTeX export
8831 For LaTeX export of a table, you can specify a label and a caption
8832 (@pxref{Markup rules}). You can also use the @code{ATTR_LaTeX} line to
8833 request a longtable environment for the table, so that it may span several
8837 #+CAPTION: A long table
8839 #+ATTR_LaTeX: longtable
8845 @node Images in LaTeX export, , Tables in LaTeX export, LaTeX and PDF export
8846 @subsection Images in LaTeX export
8847 @cindex images, inline in LaTeX
8848 @cindex inlining images in LaTeX
8850 Images that are linked to without a description part in the link, like
8851 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
8852 output files resulting from LaTeX output. Org will use an
8853 @code{\includegraphics} macro to insert the image. If you have specified a
8854 caption and/or a label as described in @ref{Markup rules}, the figure will
8855 be wrapped into a @code{figure} environment and thus become a floating
8856 element. Finally, you can use an @code{#+ATTR_LaTeX:} line to specify the
8857 options that can be used in the optional argument of the
8858 @code{\includegraphics} macro.
8861 #+CAPTION: The black-body emission of the disk around HR 4049
8862 #+LABEL: fig:SED-HR4049
8863 #+ATTR_LaTeX: width=5cm,angle=90
8864 [[./img/sed-hr4049.pdf]]
8867 @vindex org-export-latex-inline-image-extensions
8868 If you need references to a label created in this way, write
8869 @samp{\ref@{fig:SED-HR4049@}} just like in LaTeX. The default settings will
8870 recognize files types that can be included as images during processing by
8871 pdflatex (@file{png}, @file{jpg}, and @file{pdf} files). If you process your
8872 files in a different way, you may need to customize the variable
8873 @code{org-export-latex-inline-image-extensions}.
8875 @node Docbook export, XOXO export, LaTeX and PDF export, Exporting
8876 @section Docbook export
8877 @cindex Docbook export
8879 The Docbook exporter was contributed to Org by Baoqiu Cui.
8884 Export as Docbook file @file{myfile.xml}.
8887 Export as Docbook file and launch a viewer.
8890 Export only the visible part of the document.
8893 @node XOXO export, iCalendar export, Docbook export, Exporting
8894 @section XOXO export
8897 Org mode contains an exporter that produces XOXO-style output.
8898 Currently, this exporter only handles the general outline structure and
8899 does not interpret any additional Org mode features.
8904 Export as XOXO file @file{myfile.html}.
8907 Export only the visible part of the document.
8910 @node iCalendar export, , XOXO export, Exporting
8911 @section iCalendar export
8912 @cindex iCalendar export
8914 @vindex org-icalendar-include-todo
8915 @vindex org-icalendar-use-deadline
8916 @vindex org-icalendar-use-scheduled
8917 @vindex org-icalendar-categories
8918 Some people like to use Org mode for keeping track of projects, but still
8919 prefer a standard calendar application for anniversaries and appointments.
8920 In this case it can be useful to have deadlines and other time-stamped items
8921 in Org files show up in the calendar application. Org mode can export
8922 calendar information in the standard iCalendar format. If you also want to
8923 have TODO entries included in the export, configure the variable
8924 @code{org-icalendar-include-todo}. iCalendar export will export plain time
8925 stamps as VEVENT, and TODO items as VTODO. It will also create events from
8926 deadlines that are in non-TODO items. Deadlines and scheduling dates in TODO
8927 items will be used to set the start and due dates for the todo
8928 entry@footnote{See the variables @code{org-icalendar-use-deadline} and
8929 @code{org-icalendar-use-scheduled}.}. As categories, it will use the tags
8930 locally defined in the heading, and the file/tree category@footnote{To add
8931 inherited tags or the TODO state, configure the variable
8932 @code{org-icalendar-categories}.}.
8934 @vindex org-icalendar-store-UID
8935 The iCalendar standard requires each entry to have a globally unique
8936 identifier (UID). Org creates these identifiers during export. If you set
8937 the variable @code{org-icalendar-store-UID}, the UID will be stored in the
8938 @code{:ID:} property of the entry and re-used next time you report this
8939 entry. Since a single entry can give rise to multiple iCalendar entries (as
8940 a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
8941 prefixes to the UID, depending on what triggered the inclusion of the entry.
8942 In this way the UID remains unique, but a synchronization program can still
8943 figure out from which entry all the different instances originate.
8948 Create iCalendar entries for the current file and store them in the same
8949 directory, using a file extension @file{.ics}.
8952 @vindex org-agenda-files
8953 Like @kbd{C-c C-e i}, but do this for all files in
8954 @code{org-agenda-files}. For each of these files, a separate iCalendar
8955 file will be written.
8958 @vindex org-combined-agenda-icalendar-file
8959 Create a single large iCalendar file from all files in
8960 @code{org-agenda-files} and write it to the file given by
8961 @code{org-combined-agenda-icalendar-file}.
8964 @vindex org-use-property-inheritance
8965 @vindex org-icalendar-include-body
8966 The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION
8967 property can be inherited from higher in the hierarchy if you configure
8968 @code{org-use-property-inheritance} accordingly.} properties if the selected
8969 entries have them. If not, the summary will be derived from the headline,
8970 and the description from the body (limited to
8971 @code{org-icalendar-include-body} characters).
8973 How this calendar is best read and updated, that depends on the application
8974 you are using. The FAQ covers this issue.
8976 @node Publishing, Miscellaneous, Exporting, Top
8980 Org includes a publishing management system that allows you to configure
8981 automatic HTML conversion of @emph{projects} composed of interlinked org
8982 files. You can also configure Org to automatically upload your exported HTML
8983 pages and related attachments, such as images and source code files, to a web
8984 server. With htese features, Org becomes a web-site authoring tool.
8986 You can also use Org to convert files into PDF, or even combine HTML and PDF
8987 conversion so that files are available in both formats on the server.
8989 Publishing has been contributed to Org by David O'Toole.
8992 * Configuration:: Defining projects
8993 * Uploading files:: How to get files up on the server
8994 * Sample configuration:: Example projects
8995 * Triggering publication:: Publication commands
8998 @node Configuration, Uploading files, Publishing, Publishing
8999 @section Configuration
9001 Publishing needs significant configuration to specify files, destination
9002 and many other properties of a project.
9005 * Project alist:: The central configuration variable
9006 * Sources and destinations:: From here to there
9007 * Selecting files:: What files are part of the project?
9008 * Publishing action:: Setting the function doing the publishing
9009 * Publishing options:: Tweaking HTML export
9010 * Publishing links:: Which links keep working after publishing?
9011 * Project page index:: Publishing a list of project files
9014 @node Project alist, Sources and destinations, Configuration, Configuration
9015 @subsection The variable @code{org-publish-project-alist}
9016 @cindex org-publish-project-alist
9017 @cindex projects, for publishing
9019 @vindex org-publish-project-alist
9020 Publishing is configured almost entirely through setting the value of one
9021 variable, called @code{org-publish-project-alist}. Each element of the list
9022 configures one project, and may be in one of the two following forms:
9025 ("project-name" :property value :property value ...)
9027 ("project-name" :components ("project-name" "project-name" ...))
9031 In both cases, projects are configured by specifying property values. A
9032 project defines the set of files that will be published, as well as the
9033 publishing configuration to use when publishing those files. When a project
9034 takes the second form listed above, the individual members of the
9035 @code{:components} property are taken to be sub-projects, which group
9036 together files requiring different publishing options. When you publish such
9037 a ``meta-project'', all the components will also be published, in the
9040 @node Sources and destinations, Selecting files, Project alist, Configuration
9041 @subsection Sources and destinations for files
9042 @cindex directories, for publishing
9044 Most properties are optional, but some should always be set. In
9045 particular, Org needs to know where to look for source files,
9046 and where to put published files.
9048 @multitable @columnfractions 0.3 0.7
9049 @item @code{:base-directory}
9050 @tab Directory containing publishing source files
9051 @item @code{:publishing-directory}
9052 @tab Directory where output files will be published. You can directly
9053 publish to a webserver using a file name syntax appropriate for
9054 the Emacs @file{tramp} package. Or you can publish to a local directory and
9055 use external tools to upload your website (@pxref{Uploading files}).
9056 @item @code{:preparation-function}
9057 @tab Function called before starting the publishing process, for example to
9058 run @code{make} for updating files to be published.
9059 @item @code{:completion-function}
9060 @tab Function called after finishing the publishing process, for example to
9061 change permissions of the resulting files.
9065 @node Selecting files, Publishing action, Sources and destinations, Configuration
9066 @subsection Selecting files
9067 @cindex files, selecting for publishing
9069 By default, all files with extension @file{.org} in the base directory
9070 are considered part of the project. This can be modified by setting the
9072 @multitable @columnfractions 0.25 0.75
9073 @item @code{:base-extension}
9074 @tab Extension (without the dot!) of source files. This actually is a
9075 regular expression. Set this to the symbol @code{any} if you want to get all
9076 files in @code{:base-directory}, even without extension.
9078 @item @code{:exclude}
9079 @tab Regular expression to match file names that should not be
9080 published, even though they have been selected on the basis of their
9083 @item @code{:include}
9084 @tab List of files to be included regardless of @code{:base-extension}
9085 and @code{:exclude}.
9088 @node Publishing action, Publishing options, Selecting files, Configuration
9089 @subsection Publishing action
9090 @cindex action, for publishing
9092 Publishing means that a file is copied to the destination directory and
9093 possibly transformed in the process. The default transformation is to export
9094 Org files as HTML files, and this is done by the function
9095 @code{org-publish-org-to-html} which calls the HTML exporter (@pxref{HTML
9096 export}). But you also can publish your as PDF files using
9097 @code{org-publish-org-to-pdf}. Other files like images only need to be
9098 copied to the publishing destination, for this you may use
9099 @code{org-publish-attachment}. For non-Org files, you always need to provide
9100 specify the publishing function:
9102 @multitable @columnfractions 0.3 0.7
9103 @item @code{:publishing-function}
9104 @tab Function executing the publication of a file. This may also be a
9105 list of functions, which will all be called in turn.
9108 The function must accept two arguments: a property list containing at least a
9109 @code{:publishing-directory} property, and the name of the file to be
9110 published. It should take the specified file, make the necessary
9111 transformation (if any) and place the result into the destination folder.
9113 @node Publishing options, Publishing links, Publishing action, Configuration
9114 @subsection Options for the HTML/LaTeX exporters
9115 @cindex options, for publishing
9117 The property list can be used to set many export options for the HTML
9118 and La@TeX{} exporters. In most cases, these properties correspond to user
9119 variables in Org. The table below lists these properties along
9120 with the variable they belong to. See the documentation string for the
9121 respective variable for details.
9123 @vindex org-export-html-link-up
9124 @vindex org-export-html-link-home
9125 @vindex org-export-default-language
9126 @vindex org-display-custom-times
9127 @vindex org-export-headline-levels
9128 @vindex org-export-with-section-numbers
9129 @vindex org-export-section-number-format
9130 @vindex org-export-with-toc
9131 @vindex org-export-preserve-breaks
9132 @vindex org-export-with-archived-trees
9133 @vindex org-export-with-emphasize
9134 @vindex org-export-with-sub-superscripts
9135 @vindex org-export-with-special-strings
9136 @vindex org-export-with-footnotes
9137 @vindex org-export-with-drawers
9138 @vindex org-export-with-tags
9139 @vindex org-export-with-todo-keywords
9140 @vindex org-export-with-priority
9141 @vindex org-export-with-TeX-macros
9142 @vindex org-export-with-LaTeX-fragments
9143 @vindex org-export-skip-text-before-1st-heading
9144 @vindex org-export-with-fixed-width
9145 @vindex org-export-with-timestamps
9146 @vindex org-export-author-info
9147 @vindex org-export-creator-info
9148 @vindex org-export-with-tables
9149 @vindex org-export-highlight-first-table-line
9150 @vindex org-export-html-style-include-default
9151 @vindex org-export-html-style
9152 @vindex org-export-html-style-extra
9153 @vindex org-export-html-link-org-files-as-html
9154 @vindex org-export-html-inline-images
9155 @vindex org-export-html-extension
9156 @vindex org-export-html-table-tag
9157 @vindex org-export-html-expand
9158 @vindex org-export-html-with-timestamp
9159 @vindex org-export-publishing-directory
9160 @vindex org-export-html-preamble
9161 @vindex org-export-html-postamble
9162 @vindex org-export-html-auto-preamble
9163 @vindex org-export-html-auto-postamble
9164 @vindex user-full-name
9165 @vindex user-mail-address
9166 @vindex org-export-select-tags
9167 @vindex org-export-exclude-tags
9169 @multitable @columnfractions 0.32 0.68
9170 @item @code{:link-up} @tab @code{org-export-html-link-up}
9171 @item @code{:link-home} @tab @code{org-export-html-link-home}
9172 @item @code{:language} @tab @code{org-export-default-language}
9173 @item @code{:customtime} @tab @code{org-display-custom-times}
9174 @item @code{:headline-levels} @tab @code{org-export-headline-levels}
9175 @item @code{:section-numbers} @tab @code{org-export-with-section-numbers}
9176 @item @code{:section-number-format} @tab @code{org-export-section-number-format}
9177 @item @code{:table-of-contents} @tab @code{org-export-with-toc}
9178 @item @code{:preserve-breaks} @tab @code{org-export-preserve-breaks}
9179 @item @code{:archived-trees} @tab @code{org-export-with-archived-trees}
9180 @item @code{:emphasize} @tab @code{org-export-with-emphasize}
9181 @item @code{:sub-superscript} @tab @code{org-export-with-sub-superscripts}
9182 @item @code{:special-strings} @tab @code{org-export-with-special-strings}
9183 @item @code{:footnotes} @tab @code{org-export-with-footnotes}
9184 @item @code{:drawers} @tab @code{org-export-with-drawers}
9185 @item @code{:tags} @tab @code{org-export-with-tags}
9186 @item @code{:todo-keywords} @tab @code{org-export-with-todo-keywords}
9187 @item @code{:priority} @tab @code{org-export-with-priority}
9188 @item @code{:TeX-macros} @tab @code{org-export-with-TeX-macros}
9189 @item @code{:LaTeX-fragments} @tab @code{org-export-with-LaTeX-fragments}
9190 @item @code{:skip-before-1st-heading} @tab @code{org-export-skip-text-before-1st-heading}
9191 @item @code{:fixed-width} @tab @code{org-export-with-fixed-width}
9192 @item @code{:timestamps} @tab @code{org-export-with-timestamps}
9193 @item @code{:author-info} @tab @code{org-export-author-info}
9194 @item @code{:creator-info} @tab @code{org-export-creator-info}
9195 @item @code{:tables} @tab @code{org-export-with-tables}
9196 @item @code{:table-auto-headline} @tab @code{org-export-highlight-first-table-line}
9197 @item @code{:style-include-default} @tab @code{org-export-html-style-include-default}
9198 @item @code{:style} @tab @code{org-export-html-style}
9199 @item @code{:style-extra} @tab @code{org-export-html-style-extra}
9200 @item @code{:convert-org-links} @tab @code{org-export-html-link-org-files-as-html}
9201 @item @code{:inline-images} @tab @code{org-export-html-inline-images}
9202 @item @code{:html-extension} @tab @code{org-export-html-extension}
9203 @item @code{:html-table-tag} @tab @code{org-export-html-table-tag}
9204 @item @code{:expand-quoted-html} @tab @code{org-export-html-expand}
9205 @item @code{:timestamp} @tab @code{org-export-html-with-timestamp}
9206 @item @code{:publishing-directory} @tab @code{org-export-publishing-directory}
9207 @item @code{:preamble} @tab @code{org-export-html-preamble}
9208 @item @code{:postamble} @tab @code{org-export-html-postamble}
9209 @item @code{:auto-preamble} @tab @code{org-export-html-auto-preamble}
9210 @item @code{:auto-postamble} @tab @code{org-export-html-auto-postamble}
9211 @item @code{:author} @tab @code{user-full-name}
9212 @item @code{:email} @tab @code{user-mail-address} : @code{addr;addr;..}
9213 @item @code{:select-tags} @tab @code{org-export-select-tags}
9214 @item @code{:exclude-tags} @tab @code{org-export-exclude-tags}
9217 Most of the @code{org-export-with-*} variables have the same effect in
9218 both HTML and La@TeX{} exporters, except for @code{:TeX-macros} and
9219 @code{:LaTeX-fragments}, respectively @code{nil} and @code{t} in the
9222 @vindex org-publish-project-alist
9223 When a property is given a value in @code{org-publish-project-alist},
9224 its setting overrides the value of the corresponding user variable (if
9225 any) during publishing. Options set within a file (@pxref{Export
9226 options}), however, override everything.
9228 @node Publishing links, Project page index, Publishing options, Configuration
9229 @subsection Links between published files
9230 @cindex links, publishing
9232 To create a link from one Org file to another, you would use
9233 something like @samp{[[file:foo.org][The foo]]} or simply
9234 @samp{file:foo.org.} (@pxref{Hyperlinks}). Upon publishing this link
9235 becomes a link to @file{foo.html}. In this way, you can interlink the
9236 pages of your "org web" project and the links will work as expected when
9237 you publish them to HTML.
9239 You may also link to related files, such as images. Provided you are careful
9240 with relative pathnames, and provided you have also configured Org to upload
9241 the related files, these links will work too. See @ref{Complex example} for
9242 an example of this usage.
9244 Sometimes an Org file to be published may contain links that are
9245 only valid in your production environment, but not in the publishing
9246 location. In this case, use the property
9248 @multitable @columnfractions 0.4 0.6
9249 @item @code{:link-validation-function}
9250 @tab Function to validate links
9254 to define a function for checking link validity. This function must
9255 accept two arguments, the file name and a directory relative to which
9256 the file name is interpreted in the production environment. If this
9257 function returns @code{nil}, then the HTML generator will only insert a
9258 description into the HTML file, but no link. One option for this
9259 function is @code{org-publish-validate-link} which checks if the given
9260 file is part of any project in @code{org-publish-project-alist}.
9262 @node Project page index, , Publishing links, Configuration
9263 @subsection Project page index
9264 @cindex index, of published pages
9266 The following properties may be used to control publishing of an
9267 index of files or a summary page for a given project.
9269 @multitable @columnfractions 0.25 0.75
9270 @item @code{:auto-index}
9271 @tab When non-nil, publish an index during @code{org-publish-current-project}
9272 or @code{org-publish-all}.
9274 @item @code{:index-filename}
9275 @tab Filename for output of index. Defaults to @file{sitemap.org} (which
9276 becomes @file{sitemap.html}).
9278 @item @code{:index-title}
9279 @tab Title of index page. Defaults to name of file.
9281 @item @code{:index-function}
9282 @tab Plug-in function to use for generation of index.
9283 Defaults to @code{org-publish-org-index}, which generates a plain list
9284 of links to all files in the project.
9287 @node Uploading files, Sample configuration, Configuration, Publishing
9288 @section Uploading files
9292 For those people already utilising third party sync tools such as
9293 @file{rsync} or @file{unison}, it might be preferable not to use the built in
9294 @i{remote} publishing facilities of Org-mode which rely heavily on
9295 @file{Tramp}. @file{Tramp}, while very useful and powerful, tends not to be
9296 so efficient for multiple file transfer and has been known to cause problems
9299 Specialised synchronization utilities offer several advantages. In addition
9300 to timestamp comparison, they also do content and permissions/attribute
9301 checks. For this reason you might prefer to publish your web to a local
9302 directory (possibly even @i{in place} with your Org files) and then use
9303 @file{unison} or @file{rsync} to do the synchronisation with the remote host.
9305 Since Unison (for example) can be configured as to which files to transfer to
9306 a certain remote destination, it can greatly simplify the project publishing
9307 definition. Simply keep all files in the correct location, process your Org
9308 files with @code{org-publish} and let the synchronization tool do the rest.
9309 You do not need, in this scenario, to include attachments such as @file{jpg},
9310 @file{css} or @file{gif} files in the project definition since the 3rd party
9313 Publishing to a local directory is also much faster than to a remote one, so
9314 that you can afford more easily to republish entire projects. If you set
9315 @code{org-publish-use-timestamps-flag} to @code{nil}, you gain the main
9316 benefit of re-including any changed external files such as source example
9317 files you might include with @code{#+INCLUDE}. The timestamp mechanism in
9318 Org is not smart enough to detect if included files have been modified.
9320 @node Sample configuration, Triggering publication, Uploading files, Publishing
9321 @section Sample configuration
9323 Below we provide two example configurations. The first one is a simple
9324 project publishing only a set of Org files. The second example is
9325 more complex, with a multi-component project.
9328 * Simple example:: One-component publishing
9329 * Complex example:: A multi-component publishing example
9332 @node Simple example, Complex example, Sample configuration, Sample configuration
9333 @subsection Example: simple publishing configuration
9335 This example publishes a set of Org files to the @file{public_html}
9336 directory on the local machine.
9339 (setq org-publish-project-alist
9341 :base-directory "~/org/"
9342 :publishing-directory "~/public_html"
9343 :section-numbers nil
9344 :table-of-contents nil
9345 :style "<link rel=\"stylesheet\"
9346 href=\"../other/mystyle.css\"
9347 type=\"text/css\">")))
9350 @node Complex example, , Simple example, Sample configuration
9351 @subsection Example: complex publishing configuration
9353 This more complicated example publishes an entire website, including
9354 org files converted to HTML, image files, emacs lisp source code, and
9355 style sheets. The publishing-directory is remote and private files are
9358 To ensure that links are preserved, care should be taken to replicate
9359 your directory structure on the web server, and to use relative file
9360 paths. For example, if your org files are kept in @file{~/org} and your
9361 publishable images in @file{~/images}, you'd link to an image with
9364 file:../images/myimage.png
9367 On the web server, the relative path to the image should be the
9368 same. You can accomplish this by setting up an "images" folder in the
9369 right place on the web server, and publishing images to it.
9372 (setq org-publish-project-alist
9374 :base-directory "~/org/"
9375 :base-extension "org"
9376 :publishing-directory "/ssh:user@@host:~/html/notebook/"
9377 :publishing-function org-publish-org-to-html
9378 :exclude "PrivatePage.org" ;; regexp
9380 :section-numbers nil
9381 :table-of-contents nil
9382 :style "<link rel=\"stylesheet\"
9383 href=\"../other/mystyle.css\" type=\"text/css\">"
9385 :auto-postamble nil)
9388 :base-directory "~/images/"
9389 :base-extension "jpg\\|gif\\|png"
9390 :publishing-directory "/ssh:user@@host:~/html/images/"
9391 :publishing-function org-publish-attachment)
9394 :base-directory "~/other/"
9395 :base-extension "css\\|el"
9396 :publishing-directory "/ssh:user@@host:~/html/other/"
9397 :publishing-function org-publish-attachment)
9398 ("website" :components ("orgfiles" "images" "other"))))
9401 @node Triggering publication, , Sample configuration, Publishing
9402 @section Triggering publication
9404 Once properly configured, Org can publish with the following commands:
9408 Prompt for a specific project and publish all files that belong to it.
9410 Publish the project containing the current file.
9412 Publish only the current file.
9414 Publish all projects.
9417 @vindex org-publish-use-timestamps-flag
9418 Org uses timestamps to track when a file has changed. The above functions
9419 normally only publish changed files. You can override this and force
9420 publishing of all files by giving a prefix argument, or by customizing the
9421 variable @code{org-publish-use-timestamps-flag}. This may be necessary in
9422 particular if files include other files via @code{#+SETUPFILE:} or
9425 @node Miscellaneous, Hacking, Publishing, Top
9426 @chapter Miscellaneous
9429 * Completion:: M-TAB knows what you need
9430 * Customization:: Adapting Org to your taste
9431 * In-buffer settings:: Overview of the #+KEYWORDS
9432 * The very busy C-c C-c key:: When in doubt, press C-c C-c
9433 * Clean view:: Getting rid of leading stars in the outline
9434 * TTY keys:: Using Org on a tty
9435 * Interaction:: Other Emacs packages
9439 @node Completion, Customization, Miscellaneous, Miscellaneous
9441 @cindex completion, of @TeX{} symbols
9442 @cindex completion, of TODO keywords
9443 @cindex completion, of dictionary words
9444 @cindex completion, of option keywords
9445 @cindex completion, of tags
9446 @cindex completion, of property keys
9447 @cindex completion, of link abbreviations
9448 @cindex @TeX{} symbol completion
9449 @cindex TODO keywords completion
9450 @cindex dictionary word completion
9451 @cindex option keyword completion
9452 @cindex tag completion
9453 @cindex link abbreviations, completion of
9455 Org supports in-buffer completion. This type of completion does
9456 not make use of the minibuffer. You simply type a few letters into
9457 the buffer and use the key to complete text right there.
9462 Complete word at point
9465 At the beginning of a headline, complete TODO keywords.
9467 After @samp{\}, complete @TeX{} symbols supported by the exporter.
9469 After @samp{*}, complete headlines in the current buffer so that they
9470 can be used in search links like @samp{[[*find this headline]]}.
9472 After @samp{:} in a headline, complete tags. The list of tags is taken
9473 from the variable @code{org-tag-alist} (possibly set through the
9474 @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
9475 dynamically from all tags used in the current buffer.
9477 After @samp{:} and not in a headline, complete property keys. The list
9478 of keys is constructed dynamically from all keys used in the current
9481 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
9483 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
9484 @samp{OPTIONS} which set file-specific options for Org mode. When the
9485 option keyword is already complete, pressing @kbd{M-@key{TAB}} again
9486 will insert example settings for this keyword.
9488 In the line after @samp{#+STARTUP: }, complete startup keywords,
9489 i.e. valid keys for this line.
9491 Elsewhere, complete dictionary words using Ispell.
9495 @node Customization, In-buffer settings, Completion, Miscellaneous
9496 @section Customization
9497 @cindex customization
9498 @cindex options, for customization
9499 @cindex variables, for customization
9501 There are more than 180 variables that can be used to customize
9502 Org. For the sake of compactness of the manual, I am not
9503 describing the variables here. A structured overview of customization
9504 variables is available with @kbd{M-x org-customize}. Or select
9505 @code{Browse Org Group} from the @code{Org->Customization} menu. Many
9506 settings can also be activated on a per-file basis, by putting special
9507 lines into the buffer (@pxref{In-buffer settings}).
9509 @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous
9510 @section Summary of in-buffer settings
9511 @cindex in-buffer settings
9512 @cindex special keywords
9514 Org mode uses special lines in the buffer to define settings on a
9515 per-file basis. These lines start with a @samp{#+} followed by a
9516 keyword, a colon, and then individual words defining a setting. Several
9517 setting words can be in the same line, but you can also have multiple
9518 lines for the keyword. While these settings are described throughout
9519 the manual, here is a summary. After changing any of those lines in the
9520 buffer, press @kbd{C-c C-c} with the cursor still in the line to
9521 activate the changes immediately. Otherwise they become effective only
9522 when the file is visited again in a new Emacs session.
9524 @vindex org-archive-location
9526 @item #+ARCHIVE: %s_done::
9527 This line sets the archive location for the agenda file. It applies for
9528 all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
9529 of the file. The first such line also applies to any entries before it.
9530 The corresponding variable is @code{org-archive-location}.
9532 This line sets the category for the agenda file. The category applies
9533 for all subsequent lines until the next @samp{#+CATEGORY} line, or the
9534 end of the file. The first such line also applies to any entries before it.
9535 @item #+COLUMNS: %25ITEM .....
9536 Set the default format for columns view. This format applies when
9537 columns view is invoked in location where no @code{COLUMNS} property
9539 @item #+CONSTANTS: name1=value1 ...
9540 @vindex org-table-formula-constants
9541 @vindex org-table-formula
9542 Set file-local values for constants to be used in table formulas. This
9543 line set the local variable @code{org-table-formula-constants-local}.
9544 The global version of this variable is
9545 @code{org-table-formula-constants}.
9546 @item #+FILETAGS: :tag1:tag2:tag3:
9547 Set tags that can be inherited by any entry in the file, including the
9549 @item #+DRAWERS: NAME1 .....
9551 Set the file-local set of drawers. The corresponding global variable is
9553 @item #+LINK: linkword replace
9554 @vindex org-link-abbrev-alist
9555 These lines (several are allowed) specify link abbreviations.
9556 @xref{Link abbreviations}. The corresponding variable is
9557 @code{org-link-abbrev-alist}.
9558 @item #+PRIORITIES: highest lowest default
9559 @vindex org-highest-priority
9560 @vindex org-lowest-priority
9561 @vindex org-default-priority
9562 This line sets the limits and the default for the priorities. All three
9563 must be either letters A-Z or numbers 0-9. The highest priority must
9564 have a lower ASCII number that the lowest priority.
9565 @item #+PROPERTY: Property_Name Value
9566 This line sets a default inheritance value for entries in the current
9567 buffer, most useful for specifying the allowed values of a property.
9568 @item #+SETUPFILE: file
9569 This line defines a file that holds more in-buffer setup. Normally this is
9570 entirely ignored. Only when the buffer is parsed for option-setting lines
9571 (i.e. when starting Org mode for a file, when pressing @kbd{C-c C-c} in a
9572 settings line, or when exporting), then the contents of this file are parsed
9573 as if they had been included in the buffer. In particular, the file can be
9574 any other Org mode file with internal setup. You can visit the file the
9575 cursor is in the line with @kbd{C-c '}.
9577 @vindex org-startup-folded
9578 This line sets options to be used at startup of Org mode, when an
9579 Org file is being visited. The first set of options deals with the
9580 initial visibility of the outline tree. The corresponding variable for
9581 global default settings is @code{org-startup-folded}, with a default
9582 value @code{t}, which means @code{overview}.
9583 @cindex @code{overview}, STARTUP keyword
9584 @cindex @code{content}, STARTUP keyword
9585 @cindex @code{showall}, STARTUP keyword
9587 overview @r{top-level headlines only}
9588 content @r{all headlines}
9589 showall @r{no folding at all, show everything}
9591 @vindex org-startup-align-all-tables
9592 Then there are options for aligning tables upon visiting a file. This
9593 is useful in files containing narrowed table columns. The corresponding
9594 variable is @code{org-startup-align-all-tables}, with a default value
9596 @cindex @code{align}, STARTUP keyword
9597 @cindex @code{noalign}, STARTUP keyword
9599 align @r{align all tables}
9600 noalign @r{don't align tables on startup}
9602 @vindex org-log-done
9603 @vindex org-log-note-clock-out
9604 @vindex org-log-repeat
9605 Logging closing and reinstating TODO items, and clock intervals
9606 (variables @code{org-log-done}, @code{org-log-note-clock-out}, and
9607 @code{org-log-repeat}) can be configured using these options.
9608 @cindex @code{logdone}, STARTUP keyword
9609 @cindex @code{lognotedone}, STARTUP keyword
9610 @cindex @code{nologdone}, STARTUP keyword
9611 @cindex @code{lognoteclock-out}, STARTUP keyword
9612 @cindex @code{nolognoteclock-out}, STARTUP keyword
9613 @cindex @code{logrepeat}, STARTUP keyword
9614 @cindex @code{lognoterepeat}, STARTUP keyword
9615 @cindex @code{nologrepeat}, STARTUP keyword
9617 logdone @r{record a timestamp when an item is marked DONE}
9618 lognotedone @r{record timestamp and a note when DONE}
9619 nologdone @r{don't record when items are marked DONE}
9620 logrepeat @r{record a time when reinstating a repeating item}
9621 lognoterepeat @r{record a note when reinstating a repeating item}
9622 nologrepeat @r{do not record when reinstating repeating item}
9623 lognoteclock-out @r{record a note when clocking out}
9624 nolognoteclock-out @r{don't record a note when clocking out}
9626 @vindex org-hide-leading-stars
9627 @vindex org-odd-levels-only
9628 Here are the options for hiding leading stars in outline headings, and for
9629 indenting outlines. The corresponding variables are
9630 @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
9631 default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
9632 @cindex @code{hidestars}, STARTUP keyword
9633 @cindex @code{showstars}, STARTUP keyword
9634 @cindex @code{odd}, STARTUP keyword
9635 @cindex @code{even}, STARTUP keyword
9637 hidestars @r{make all but one of the stars starting a headline invisible.}
9638 showstars @r{show all stars starting a headline}
9639 indent @r{virtual indentation according to outline level}
9640 noindent @r{no virtual indentation according to outline level}
9641 odd @r{allow only odd outline levels (1,3,...)}
9642 oddeven @r{allow all outline levels}
9644 @vindex org-put-time-stamp-overlays
9645 @vindex org-time-stamp-overlay-formats
9646 To turn on custom format overlays over time stamps (variables
9647 @code{org-put-time-stamp-overlays} and
9648 @code{org-time-stamp-overlay-formats}), use
9649 @cindex @code{customtime}, STARTUP keyword
9651 customtime @r{overlay custom time format}
9653 @vindex constants-unit-system
9654 The following options influence the table spreadsheet (variable
9655 @code{constants-unit-system}).
9656 @cindex @code{constcgs}, STARTUP keyword
9657 @cindex @code{constSI}, STARTUP keyword
9659 constcgs @r{@file{constants.el} should use the c-g-s unit system}
9660 constSI @r{@file{constants.el} should use the SI unit system}
9662 @vindex org-footnote-define-inline
9663 @vindex org-footnote-auto-label
9664 To influence footnote settings, use the following keywords. The
9665 corresponding variables are @code{org-footnote-define-inline} and
9666 @code{org-footnote-auto-label}.
9667 @cindex @code{fninline}, STARTUP keyword
9668 @cindex @code{fnnoinline}, STARTUP keyword
9669 @cindex @code{fnlocal}, STARTUP keyword
9670 @cindex @code{fnprompt}, STARTUP keyword
9671 @cindex @code{fnauto}, STARTUP keyword
9672 @cindex @code{fnconfirm}, STARTUP keyword
9673 @cindex @code{fnplain}, STARTUP keyword
9675 fninline @r{define footnotes inline}
9676 fnnoinline @r{define footnotes in separate section}
9677 fnlocal @r{define footnotes near first reference, but not inline}
9678 fnprompt @r{prompt for footnote labels}
9679 fnauto @r{create [fn:1]-like labels automatically (default)}
9680 fnconfirm @r{offer automatic label for editing or confirmation}
9681 fnplain @r{create [1]-like labels automatically}
9683 @item #+TAGS: TAG1(c1) TAG2(c2)
9684 @vindex org-tag-alist
9685 These lines (several such lines are allowed) specify the valid tags in
9686 this file, and (potentially) the corresponding @emph{fast tag selection}
9687 keys. The corresponding variable is @code{org-tag-alist}.
9689 This line contains the formulas for the table directly above the line.
9690 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS, #+DATE:,
9691 @itemx #+DESCRIPTION:, #+KEYWORDS:
9692 @itemx #+LATEX_HEADER:, #+STYLE:, #+LINK_UP:, #+LINK_HOME:,
9693 @itemx #+EXPORT_SELECT_TAGS:, #+EXPORT_EXCLUDE_TAGS:
9694 These lines provide settings for exporting files. For more details see
9695 @ref{Export options}.
9696 @item #+TODO: #+SEQ_TODO: #+TYP_TODO:
9697 @vindex org-todo-keywords
9698 These lines set the TODO keywords and their interpretation in the
9699 current file. The corresponding variable is @code{org-todo-keywords}.
9702 @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous
9703 @section The very busy C-c C-c key
9705 @cindex C-c C-c, overview
9707 The key @kbd{C-c C-c} has many purposes in Org, which are all
9708 mentioned scattered throughout this manual. One specific function of
9709 this key is to add @emph{tags} to a headline (@pxref{Tags}). In many
9710 other circumstances it means something like @emph{Hey Org, look
9711 here and update according to what you see here}. Here is a summary of
9712 what this means in different contexts.
9716 If there are highlights in the buffer from the creation of a sparse
9717 tree, or from clock display, remove these highlights.
9719 If the cursor is in one of the special @code{#+KEYWORD} lines, this
9720 triggers scanning the buffer for these lines and updating the
9723 If the cursor is inside a table, realign the table. This command
9724 works even if the automatic table editor has been turned off.
9726 If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
9729 If the cursor is inside a table created by the @file{table.el} package,
9730 activate that table.
9732 If the current buffer is a remember buffer, close the note and file it.
9733 With a prefix argument, file it, without further interaction, to the
9736 If the cursor is on a @code{<<<target>>>}, update radio targets and
9737 corresponding links in this buffer.
9739 If the cursor is in a property line or at the start or end of a property
9740 drawer, offer property commands.
9742 If the cursor is at a footnote reference, go to the corresponding
9743 definition, and vice versa.
9745 If the cursor is in a plain list item with a checkbox, toggle the status
9748 If the cursor is on a numbered item in a plain list, renumber the
9751 If the cursor is on the @code{#+BEGIN} line of a dynamical block, the
9755 @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous
9756 @section A cleaner outline view
9757 @cindex hiding leading stars
9758 @cindex dynamic indentation
9759 @cindex odd-levels-only outlines
9760 @cindex clean outline view
9762 Some people find it noisy and distracting that the Org headlines are starting
9763 with a potentially large number of stars, and that text below the headlines
9764 is not indented. This is not really a problem when you are writing a book
9765 where the outline headings are really section headlines. However, in a more
9766 list-oriented outline, it is clear that an indented structure is a lot
9767 cleaner, as can be seen by comparing the two columns in the following
9772 * Top level headline | * Top level headline
9773 ** Second level | * Second level
9774 *** 3rd level | * 3rd level
9775 some text | some text
9776 *** 3rd level | * 3rd level
9777 more text | more text
9778 * Another top level headline | * Another top level headline
9783 It is non-trivial to make such a look work in Emacs, but Org contains three
9784 separate features that, combined, achieve just that.
9788 @emph{Indentation of text below headlines}@*
9789 You may indent text below each headline to make the left boundary line up
9790 with the headline, like
9794 more text, now indented
9797 @vindex org-adapt-indentation
9798 A good way to get this indentation is by hand, and Org supports this with
9799 paragraph filling, line wrapping, and structure editing@footnote{See also the
9800 variable @code{org-adapt-indentation}.} preserving or adapting the
9801 indentation appropriate. A different approach would be to have a way to
9802 automatically indent lines according to outline structure by adding overlays
9803 or text properties. But I have not yet found a robust and efficient way to
9804 do this in large files.
9807 @vindex org-hide-leading-stars
9808 @emph{Hiding leading stars}@* You can modify the display in such a way that
9809 all leading stars become invisible. To do this in a global way, configure
9810 the variable @code{org-hide-leading-stars} or change this on a per-file basis
9814 #+STARTUP: hidestars
9818 Note that the opposite behavior is selected with @code{showstars}.
9820 With hidden stars, the tree becomes:
9824 * Top level headline
9832 @vindex org-hide @r{(face)}
9833 Note that the leading stars are not truly replaced by whitespace, they
9834 are only fontified with the face @code{org-hide} that uses the
9835 background color as font color. If you are not using either white or
9836 black background, you may have to customize this face to get the wanted
9837 effect. Another possibility is to set this font such that the extra
9838 stars are @i{almost} invisible, for example using the color
9839 @code{grey90} on a white background.
9842 @cindex org-odd-levels-only
9843 Things become cleaner still if you skip all the even levels and use only odd
9844 levels 1, 3, 5..., effectively adding two stars to go from one outline level
9845 to the next@footnote{When you need to specify a level for a property search
9846 or refile targets, @samp{LEVEL=2} will correspond to 3 stars etc.}. In this
9847 way we get the outline view shown at the beginning of this section. In order
9848 to make the structure editing and export commands handle this convention
9849 correctly, configure the variable @code{org-odd-levels-only}, or set this on
9850 a per-file basis with one of the following lines:
9857 You can convert an Org file from single-star-per-level to the
9858 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
9859 RET} in that file. The reverse operation is @kbd{M-x
9860 org-convert-to-oddeven-levels}.
9863 @node TTY keys, Interaction, Clean view, Miscellaneous
9864 @section Using Org on a tty
9865 @cindex tty key bindings
9867 Because Org contains a large number of commands, by default much of
9868 Org's core commands are bound to keys that are generally not
9869 accessible on a tty, such as the cursor keys (@key{left}, @key{right},
9870 @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
9871 together with modifiers like @key{Meta} and/or @key{Shift}. To access
9872 these commands on a tty when special keys are unavailable, the following
9873 alternative bindings can be used. The tty bindings below will likely be
9874 more cumbersome; you may find for some of the bindings below that a
9875 customized work-around suits you better. For example, changing a time
9876 stamp is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
9877 tty you would rather use @kbd{C-c .} to re-insert the timestamp.
9879 @multitable @columnfractions 0.15 0.2 0.2
9880 @item @b{Default} @tab @b{Alternative 1} @tab @b{Alternative 2}
9881 @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab
9882 @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{@key{Esc} @key{left}}
9883 @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab
9884 @item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{@key{Esc} @key{right}}
9885 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab
9886 @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{@key{Esc} @key{up}}
9887 @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab
9888 @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{@key{Esc} @key{down}}
9889 @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab
9890 @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab
9891 @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{@key{Esc} @key{RET}}
9892 @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab
9893 @item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab
9894 @item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab
9895 @item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab
9896 @item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab
9897 @item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab
9898 @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab
9902 @node Interaction, , TTY keys, Miscellaneous
9903 @section Interaction with other packages
9904 @cindex packages, interaction with other
9905 Org lives in the world of GNU Emacs and interacts in various ways
9906 with other code out there.
9909 * Cooperation:: Packages Org cooperates with
9910 * Conflicts:: Packages that lead to conflicts
9913 @node Cooperation, Conflicts, Interaction, Interaction
9914 @subsection Packages that Org cooperates with
9917 @cindex @file{calc.el}
9918 @item @file{calc.el} by Dave Gillespie
9919 Org uses the Calc package for implementing spreadsheet
9920 functionality in its tables (@pxref{The spreadsheet}). Org
9921 checks for the availability of Calc by looking for the function
9922 @code{calc-eval} which should be autoloaded in your setup if Calc has
9923 been installed properly. As of Emacs 22, Calc is part of the Emacs
9924 distribution. Another possibility for interaction between the two
9925 packages is using Calc for embedded calculations. @xref{Embedded Mode,
9926 , Embedded Mode, Calc, GNU Emacs Calc Manual}.
9927 @cindex @file{constants.el}
9928 @item @file{constants.el} by Carsten Dominik
9929 @vindex org-table-formula-constants
9930 In a table formula (@pxref{The spreadsheet}), it is possible to use
9931 names for natural constants or units. Instead of defining your own
9932 constants in the variable @code{org-table-formula-constants}, install
9933 the @file{constants} package which defines a large number of constants
9934 and units, and lets you use unit prefixes like @samp{M} for
9935 @samp{Mega} etc. You will need version 2.0 of this package, available
9936 at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for
9937 the function @code{constants-get}, which has to be autoloaded in your
9938 setup. See the installation instructions in the file
9939 @file{constants.el}.
9940 @item @file{cdlatex.el} by Carsten Dominik
9941 @cindex @file{cdlatex.el}
9942 Org mode can make use of the CDLaTeX package to efficiently enter
9943 La@TeX{} fragments into Org files. See @ref{CDLaTeX mode}.
9944 @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
9945 @cindex @file{imenu.el}
9946 Imenu allows menu access to an index of items in a file. Org mode
9947 supports Imenu - all you need to do to get the index is the following:
9949 (add-hook 'org-mode-hook
9950 (lambda () (imenu-add-to-menubar "Imenu")))
9952 @vindex org-imenu-depth
9953 By default the index is two levels deep - you can modify the depth using
9954 the option @code{org-imenu-depth}.
9955 @item @file{remember.el} by John Wiegley
9956 @cindex @file{remember.el}
9957 Org cooperates with remember, see @ref{Remember}.
9958 @file{Remember.el} is not part of Emacs, find it on the web.
9959 @item @file{speedbar.el} by Eric M. Ludlam
9960 @cindex @file{speedbar.el}
9961 Speedbar is a package that creates a special frame displaying files and
9962 index items in files. Org mode supports Speedbar and allows you to
9963 drill into Org files directly from the Speedbar. It also allows to
9964 restrict the scope of agenda commands to a file or a subtree by using
9965 the command @kbd{<} in the Speedbar frame.
9966 @cindex @file{table.el}
9967 @item @file{table.el} by Takaaki Ota
9969 @cindex table editor, @file{table.el}
9970 @cindex @file{table.el}
9972 Complex ASCII tables with automatic line wrapping, column- and
9973 row-spanning, and alignment can be created using the Emacs table
9974 package by Takaaki Ota (@uref{http://sourceforge.net/projects/table},
9975 and also part of Emacs 22).
9976 When @key{TAB} or @kbd{C-c C-c} is pressed in such a table, Org mode
9977 will call @command{table-recognize-table} and move the cursor into the
9978 table. Inside a table, the keymap of Org mode is inactive. In order
9979 to execute Org mode-related commands, leave the table.
9984 Recognize @file{table.el} table. Works when the cursor is in a
9989 Insert a table.el table. If there is already a table at point, this
9990 command converts it between the table.el format and the Org mode
9991 format. See the documentation string of the command
9992 @code{org-convert-table} for the restrictions under which this is
9995 @file{table.el} is part of Emacs 22.
9996 @cindex @file{footnote.el}
9997 @item @file{footnote.el} by Steven L. Baur
9998 Org mode recognizes numerical footnotes as provided by this package.
9999 However, Org-mode also has its own footnote support (@pxref{Footnotes}),
10000 which makes using @file{footnote.el} unnecessary.
10003 @node Conflicts, , Cooperation, Interaction
10004 @subsection Packages that lead to conflicts with Org mode
10008 @cindex @code{shift-selection-mode}
10009 @vindex org-support-shift-select
10010 In Emacs 23, @code{shift-selection-mode} is on by default, meaning that
10011 cursor motions combined with the shift key should start or enlarge regions.
10012 This conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change
10013 timestamps, TODO keywords, priorities, and item bullet types if the cursor is
10014 at such a location. By default, @kbd{S-@key{cursor}} commands outside
10015 special contexts don't do anything, but you can customize the variable
10016 @code{org-support-shift-select}. Org-mode then tries to accommodate shift
10017 selection by (i) using it outside of the special contexts where special
10018 commands apply, and by (ii) extending an existing active region even if the
10019 cursor moves across a special context.
10021 @cindex @file{CUA.el}
10022 @item @file{CUA.el} by Kim. F. Storm
10023 @vindex org-replace-disputed-keys
10024 Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by CUA mode
10025 (as well as pc-select-mode and s-region-mode) to select and extend the
10026 region. In fact, Emacs 23 has this built-in in the form of
10027 @code{shift-selection-mode}, see previous paragraph. If you are using Emacs
10028 23, you probably don't want to use another package for this purpose. However,
10029 if you prefer to leave these keys to a different package while working in
10030 Org-mode, configure the variable @code{org-replace-disputed-keys}. When set,
10031 Org will move the following key bindings in Org files, and in the agenda
10032 buffer (but not during date selection).
10035 S-UP -> M-p S-DOWN -> M-n
10036 S-LEFT -> M-- S-RIGHT -> M-+
10037 C-S-LEFT -> M-S-- C-S-RIGHT -> M-S-+
10040 @vindex org-disputed-keys
10041 Yes, these are unfortunately more difficult to remember. If you want
10042 to have other replacement keys, look at the variable
10043 @code{org-disputed-keys}.
10045 @item @file{windmove.el} by Hovav Shacham
10046 @cindex @file{windmove.el}
10047 Also this package uses the @kbd{S-<cursor>} keys, so everything written
10048 in the paragraph above about CUA mode also applies here.
10052 @node Hacking, History and Acknowledgments, Miscellaneous, Top
10056 This appendix covers some aspects where users can extend the functionality of
10060 * Hooks:: Who to reach into Org's internals
10061 * Add-on packages:: Available extensions
10062 * Adding hyperlink types:: New custom link types
10063 * Context-sensitive commands:: How to add functioality to such commands
10064 * Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs
10065 * Dynamic blocks:: Automatically filled blocks
10066 * Special agenda views:: Customized views
10067 * Using the property API:: Writing programs that use entry properties
10068 * Using the mapping API:: Mapping over all or selected entries
10071 @node Hooks, Add-on packages, Hacking, Hacking
10075 Org has a large number of hook variables that can be used to add
10076 functionality to it. This appendix about hacking is going to illustrate the
10077 use of some of them. A complete list of all hooks with documentation is
10078 maintained by the worg project and can be found at
10079 @uref{http://orgmode.org/worg/org-configs/org-hooks.php}.
10081 @node Add-on packages, Adding hyperlink types, Hooks, Hacking
10082 @section Add-on packages
10083 @cindex add-on packages
10085 A large number of add-on packages have been written by various authors.
10086 These packages are not part of Emacs, but they are distributed as contributed
10087 packages with the separate release available at the Org-mode home page at
10088 @uref{http://orgmode.org}. The list of contributed packages, along with
10089 documentation about each package, is maintained by the Worg project at
10090 @uref{http://orgmode.org/worg/org-contrib/}.
10094 @node Adding hyperlink types, Context-sensitive commands, Add-on packages, Hacking
10095 @section Adding hyperlink types
10096 @cindex hyperlinks, adding new types
10098 Org has a large number of hyperlink types built-in
10099 (@pxref{Hyperlinks}). If you would like to add new link types, it
10100 provides an interface for doing so. Let's look at an example file
10101 @file{org-man.el} that will add support for creating links like
10102 @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
10106 ;;; org-man.el - Support for links to manpages in Org
10110 (org-add-link-type "man" 'org-man-open)
10111 (add-hook 'org-store-link-functions 'org-man-store-link)
10113 (defcustom org-man-command 'man
10114 "The Emacs command to be used to display a man page."
10116 :type '(choice (const man) (const woman)))
10118 (defun org-man-open (path)
10119 "Visit the manpage on PATH.
10120 PATH should be a topic that can be thrown at the man command."
10121 (funcall org-man-command path))
10123 (defun org-man-store-link ()
10124 "Store a link to a manpage."
10125 (when (memq major-mode '(Man-mode woman-mode))
10126 ;; This is a man page, we do make this link
10127 (let* ((page (org-man-get-page-name))
10128 (link (concat "man:" page))
10129 (description (format "Manpage for %s" page)))
10130 (org-store-link-props
10133 :description description))))
10135 (defun org-man-get-page-name ()
10136 "Extract the page name from the buffer name."
10137 ;; This works for both `Man-mode' and `woman-mode'.
10138 (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
10139 (match-string 1 (buffer-name))
10140 (error "Cannot create link to this man page")))
10144 ;;; org-man.el ends here
10148 You would activate this new link type in @file{.emacs} with
10155 Let's go through the file and see what it does.
10158 It does @code{(require 'org)} to make sure that @file{org.el} has been
10161 The next line calls @code{org-add-link-type} to define a new link type
10162 with prefix @samp{man}. The call also contains the name of a function
10163 that will be called to follow such a link.
10165 @vindex org-store-link-functions
10166 The next line adds a function to @code{org-store-link-functions}, in
10167 order to allow the command @kbd{C-c l} to record a useful link in a
10168 buffer displaying a man page.
10171 The rest of the file defines the necessary variables and functions.
10172 First there is a customization variable that determines which emacs
10173 command should be used to display man pages. There are two options,
10174 @code{man} and @code{woman}. Then the function to follow a link is
10175 defined. It gets the link path as an argument - in this case the link
10176 path is just a topic for the manual command. The function calls the
10177 value of @code{org-man-command} to display the man page.
10179 Finally the function @code{org-man-store-link} is defined. When you try
10180 to store a link with @kbd{C-c l}, also this function will be called to
10181 try to make a link. The function must first decide if it is supposed to
10182 create the link for this buffer type, we do this by checking the value
10183 of the variable @code{major-mode}. If not, the function must exit and
10184 return the value @code{nil}. If yes, the link is created by getting the
10185 manual topic from the buffer name and prefixing it with the string
10186 @samp{man:}. Then it must call the command @code{org-store-link-props}
10187 and set the @code{:type} and @code{:link} properties. Optionally you
10188 can also set the @code{:description} property to provide a default for
10189 the link description when the link is later inserted into an Org
10190 buffer with @kbd{C-c C-l}.
10192 @node Context-sensitive commands, Tables in arbitrary syntax, Adding hyperlink types, Hacking
10193 @section Context-sensitive commands
10194 @cindex context-sensitive commands, hooks
10195 @cindex add-ons, context-sensitive commands
10196 @vindex org-ctrl-c-ctrl-c-hook
10198 Org has several commands that act differently depending on context. The most
10199 important example it the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}).
10200 Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys do have this property.
10202 Add-ons can tap into this functionality by providing a function that detects
10203 special context for that add-on and executes functionality appropriate for
10204 the context. Here is an example from Dan Davison's @file{org-R.el} which
10205 allows to evaluate commands based on the @file{R} programming language. For
10206 this package, special contexts are lines that start with @code{#+R:} or
10210 (defun org-R-apply-maybe ()
10211 "Detect if this is context for org-R and execute R commands."
10212 (if (save-excursion
10213 (beginning-of-line 1)
10214 (looking-at "#\\+RR?:"))
10215 (progn (call-interactively 'org-R-apply)
10216 t) ;; to signal that we took action
10217 nil)) ;; to signal that we did not
10219 (add-hook 'org-ctrl-c-ctrl-c-hook 'org-R-apply-maybe)
10222 The function first checks if the cursor is in such a line. If that is the
10223 case, @code{org-R-apply} is called and the function returns @code{t} to
10224 signal that action was taken, and @kbd{C-c C-c} will stop looking for other
10225 contexts. If the function finds it should do nothing locally, it returns @code{nil} so that other, similar functions can have a try.
10228 @node Tables in arbitrary syntax, Dynamic blocks, Context-sensitive commands, Hacking
10229 @section Tables and lists in arbitrary syntax
10230 @cindex tables, in other modes
10231 @cindex lists, in other modes
10232 @cindex Orgtbl mode
10234 Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
10235 frequent feature request has been to make it work with native tables in
10236 specific languages, for example La@TeX{}. However, this is extremely
10237 hard to do in a general way, would lead to a customization nightmare,
10238 and would take away much of the simplicity of the Orgtbl mode table
10242 This appendix describes a different approach. We keep the Orgtbl mode
10243 table in its native format (the @i{source table}), and use a custom
10244 function to @i{translate} the table to the correct syntax, and to
10245 @i{install} it in the right location (the @i{target table}). This puts
10246 the burden of writing conversion functions on the user, but it allows
10247 for a very flexible system.
10249 Bastien added the ability to do the same with lists. You can use Org's
10250 facilities to edit and structure lists by turning @code{orgstruct-mode}
10251 on, then locally exporting such lists in another format (HTML, La@TeX{}
10256 * Radio tables:: Sending and receiving
10257 * A LaTeX example:: Step by step, almost a tutorial
10258 * Translator functions:: Copy and modify
10259 * Radio lists:: Doing the same for lists
10262 @node Radio tables, A LaTeX example, Tables in arbitrary syntax, Tables in arbitrary syntax
10263 @subsection Radio tables
10264 @cindex radio tables
10266 To define the location of the target table, you first need to create two
10267 lines that are comments in the current mode, but contain magic words for
10268 Orgtbl mode to find. Orgtbl mode will insert the translated table
10269 between these lines, replacing whatever was there before. For example:
10272 /* BEGIN RECEIVE ORGTBL table_name */
10273 /* END RECEIVE ORGTBL table_name */
10277 Just above the source table, we put a special line that tells
10278 Orgtbl mode how to translate this table and where to install it. For
10281 #+ORGTBL: SEND table_name translation_function arguments....
10285 @code{table_name} is the reference name for the table that is also used
10286 in the receiver lines. @code{translation_function} is the Lisp function
10287 that does the translation. Furthermore, the line can contain a list of
10288 arguments (alternating key and value) at the end. The arguments will be
10289 passed as a property list to the translation function for
10290 interpretation. A few standard parameters are already recognized and
10291 acted upon before the translation function is called:
10295 Skip the first N lines of the table. Hlines do count as separate lines for
10298 @item :skipcols (n1 n2 ...)
10299 List of columns that should be skipped. If the table has a column with
10300 calculation marks, that column is automatically discarded as well.
10301 Please note that the translator function sees the table @emph{after} the
10302 removal of these columns, the function never knows that there have been
10303 additional columns.
10307 The one problem remaining is how to keep the source table in the buffer
10308 without disturbing the normal workings of the file, for example during
10309 compilation of a C file or processing of a La@TeX{} file. There are a
10310 number of different solutions:
10314 The table could be placed in a block comment if that is supported by the
10315 language. For example, in C mode you could wrap the table between
10316 @samp{/*} and @samp{*/} lines.
10318 Sometimes it is possible to put the table after some kind of @i{END}
10319 statement, for example @samp{\bye} in TeX and @samp{\end@{document@}}
10322 You can just comment the table line by line whenever you want to process
10323 the file, and uncomment it whenever you need to edit the table. This
10324 only sounds tedious - the command @kbd{M-x orgtbl-toggle-comment} does
10325 make this comment-toggling very easy, in particular if you bind it to a
10329 @node A LaTeX example, Translator functions, Radio tables, Tables in arbitrary syntax
10330 @subsection A LaTeX example of radio tables
10331 @cindex LaTeX, and Orgtbl mode
10333 The best way to wrap the source table in La@TeX{} is to use the
10334 @code{comment} environment provided by @file{comment.sty}. It has to be
10335 activated by placing @code{\usepackage@{comment@}} into the document
10336 header. Orgtbl mode can insert a radio table skeleton@footnote{By
10337 default this works only for La@TeX{}, HTML, and Texinfo. Configure the
10338 variable @code{orgtbl-radio-tables} to install templates for other
10339 modes.} with the command @kbd{M-x orgtbl-insert-radio-table}. You will
10340 be prompted for a table name, let's say we use @samp{salesfigures}. You
10341 will then get the following template:
10343 @cindex #+ORGTBL: SEND
10345 % BEGIN RECEIVE ORGTBL salesfigures
10346 % END RECEIVE ORGTBL salesfigures
10348 #+ORGTBL: SEND salesfigures orgtbl-to-latex
10354 @vindex LaTeX-verbatim-environments
10355 The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
10356 @code{orgtbl-to-latex} to convert the table into La@TeX{} and to put it
10357 into the receiver location with name @code{salesfigures}. You may now
10358 fill in the table, feel free to use the spreadsheet features@footnote{If
10359 the @samp{#+TBLFM} line contains an odd number of dollar characters,
10360 this may cause problems with font-lock in LaTeX mode. As shown in the
10361 example you can fix this by adding an extra line inside the
10362 @code{comment} environment that is used to balance the dollar
10363 expressions. If you are using AUCTeX with the font-latex library, a
10364 much better solution is to add the @code{comment} environment to the
10365 variable @code{LaTeX-verbatim-environments}.}:
10368 % BEGIN RECEIVE ORGTBL salesfigures
10369 % END RECEIVE ORGTBL salesfigures
10371 #+ORGTBL: SEND salesfigures orgtbl-to-latex
10372 | Month | Days | Nr sold | per day |
10373 |-------+------+---------+---------|
10374 | Jan | 23 | 55 | 2.4 |
10375 | Feb | 21 | 16 | 0.8 |
10376 | March | 22 | 278 | 12.6 |
10377 #+TBLFM: $4=$3/$2;%.1f
10378 % $ (optional extra dollar to keep font-lock happy, see footnote)
10383 When you are done, press @kbd{C-c C-c} in the table to get the converted
10384 table inserted between the two marker lines.
10386 Now let's assume you want to make the table header by hand, because you
10387 want to control how columns are aligned etc. In this case we make sure
10388 that the table translator does skip the first 2 lines of the source
10389 table, and tell the command to work as a @i{splice}, i.e. to not produce
10390 header and footer commands of the target table:
10393 \begin@{tabular@}@{lrrr@}
10394 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
10395 % BEGIN RECEIVE ORGTBL salesfigures
10396 % END RECEIVE ORGTBL salesfigures
10400 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
10401 | Month | Days | Nr sold | per day |
10402 |-------+------+---------+---------|
10403 | Jan | 23 | 55 | 2.4 |
10404 | Feb | 21 | 16 | 0.8 |
10405 | March | 22 | 278 | 12.6 |
10406 #+TBLFM: $4=$3/$2;%.1f
10410 The La@TeX{} translator function @code{orgtbl-to-latex} is already part of
10411 Orgtbl mode. It uses a @code{tabular} environment to typeset the table
10412 and marks horizontal lines with @code{\hline}. Furthermore, it
10413 interprets the following parameters (see also @ref{Translator functions}):
10416 @item :splice nil/t
10417 When set to t, return only table body lines, don't wrap them into a
10418 tabular environment. Default is nil.
10421 A format to be used to wrap each field, should contain @code{%s} for the
10422 original field value. For example, to wrap each field value in dollars,
10423 you could use @code{:fmt "$%s$"}. This may also be a property list with
10424 column numbers and formats. for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
10425 A function of one argument can be used in place of the strings; the
10426 function must return a formatted string.
10429 Use this format to print numbers with exponentials. The format should
10430 have @code{%s} twice for inserting mantissa and exponent, for example
10431 @code{"%s\\times10^@{%s@}"}. The default is @code{"%s\\,(%s)"}. This
10432 may also be a property list with column numbers and formats, for example
10433 @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After
10434 @code{efmt} has been applied to a value, @code{fmt} will also be
10435 applied. Similar to @code{fmt}, functions of two arguments can be
10436 supplied instead of strings.
10439 @node Translator functions, Radio lists, A LaTeX example, Tables in arbitrary syntax
10440 @subsection Translator functions
10441 @cindex HTML, and Orgtbl mode
10442 @cindex translator function
10444 Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
10445 (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
10446 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and @code{orgtbl-to-texinfo}.
10447 Except for @code{orgtbl-to-html}@footnote{The HTML translator uses the same
10448 code that produces tables during HTML export.}, these all use a generic
10449 translator, @code{orgtbl-to-generic}. For example, @code{orgtbl-to-latex}
10450 itself is a very short function that computes the column definitions for the
10451 @code{tabular} environment, defines a few field and line separators and then
10452 hands over to the generic translator. Here is the entire code:
10456 (defun orgtbl-to-latex (table params)
10457 "Convert the Orgtbl mode TABLE to LaTeX."
10458 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
10459 org-table-last-alignment ""))
10462 :tstart (concat "\\begin@{tabular@}@{" alignment "@}")
10463 :tend "\\end@{tabular@}"
10464 :lstart "" :lend " \\\\" :sep " & "
10465 :efmt "%s\\,(%s)" :hline "\\hline")))
10466 (orgtbl-to-generic table (org-combine-plists params2 params))))
10470 As you can see, the properties passed into the function (variable
10471 @var{PARAMS}) are combined with the ones newly defined in the function
10472 (variable @var{PARAMS2}). The ones passed into the function (i.e. the
10473 ones set by the @samp{ORGTBL SEND} line) take precedence. So if you
10474 would like to use the La@TeX{} translator, but wanted the line endings to
10475 be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
10476 overrule the default with
10479 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
10482 For a new language, you can either write your own converter function in
10483 analogy with the La@TeX{} translator, or you can use the generic function
10484 directly. For example, if you have a language where a table is started
10485 with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are
10486 started with @samp{!BL!}, ended with @samp{!EL!} and where the field
10487 separator is a TAB, you could call the generic translator like this (on
10491 #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
10492 :lstart "!BL! " :lend " !EL!" :sep "\t"
10496 Please check the documentation string of the function
10497 @code{orgtbl-to-generic} for a full list of parameters understood by
10498 that function and remember that you can pass each of them into
10499 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
10500 using the generic function.
10502 Of course you can also write a completely new function doing complicated
10503 things the generic translator cannot do. A translator function takes
10504 two arguments. The first argument is the table, a list of lines, each
10505 line either the symbol @code{hline} or a list of fields. The second
10506 argument is the property list containing all parameters specified in the
10507 @samp{#+ORGTBL: SEND} line. The function must return a single string
10508 containing the formatted table. If you write a generally useful
10509 translator, please post it on @code{emacs-orgmode@@gnu.org} so that
10510 others can benefit from your work.
10512 @node Radio lists, , Translator functions, Tables in arbitrary syntax
10513 @subsection Radio lists
10514 @cindex radio lists
10515 @cindex org-list-insert-radio-list
10517 Sending and receiving radio lists works exactly the same way than
10518 sending and receiving radio tables (@pxref{Radio tables}) @footnote{You
10519 need to load the @code{org-export-latex.el} package to use radio lists
10520 since the relevant code is there for now.}. As for radio tables, you
10521 can insert radio lists templates in HTML, La@TeX{} and Texinfo modes by
10522 calling @code{org-list-insert-radio-list}.
10524 Here are the differences with radio tables:
10528 Use @code{ORGLST} instead of @code{ORGTBL}.
10530 The available translation functions for radio lists don't take
10533 `C-c C-c' will work when pressed on the first item of the list.
10536 Here is a La@TeX{} example. Let's say that you have this in your
10540 % BEGIN RECEIVE ORGLST to-buy
10541 % END RECEIVE ORGLST to-buy
10543 #+ORGLIST: SEND to-buy orgtbl-to-latex
10552 Pressing `C-c C-c' on @code{a new house} and will insert the converted
10553 La@TeX{} list between the two marker lines.
10555 @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Hacking
10556 @section Dynamic blocks
10557 @cindex dynamic blocks
10559 Org documents can contain @emph{dynamic blocks}. These are
10560 specially marked regions that are updated by some user-written function.
10561 A good example for such a block is the clock table inserted by the
10562 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
10564 Dynamic block are enclosed by a BEGIN-END structure that assigns a name
10565 to the block and can also specify parameters for the function producing
10566 the content of the block.
10568 #+BEGIN:dynamic block
10570 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
10575 Dynamic blocks are updated with the following commands
10578 @kindex C-c C-x C-u
10580 Update dynamic block at point.
10581 @kindex C-u C-c C-x C-u
10582 @item C-u C-c C-x C-u
10583 Update all dynamic blocks in the current file.
10586 Updating a dynamic block means to remove all the text between BEGIN and
10587 END, parse the BEGIN line for parameters and then call the specific
10588 writer function for this block to insert the new content. If you want
10589 to use the original content in the writer function, you can use the
10590 extra parameter @code{:content}.
10592 For a block with name @code{myblock}, the writer function is
10593 @code{org-dblock-write:myblock} with as only parameter a property list
10594 with the parameters given in the begin line. Here is a trivial example
10595 of a block that keeps track of when the block update function was last
10599 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
10605 The corresponding block writer function could look like this:
10608 (defun org-dblock-write:block-update-time (params)
10609 (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
10610 (insert "Last block update at: "
10611 (format-time-string fmt (current-time)))))
10614 If you want to make sure that all dynamic blocks are always up-to-date,
10615 you could add the function @code{org-update-all-dblocks} to a hook, for
10616 example @code{before-save-hook}. @code{org-update-all-dblocks} is
10617 written in a way that is does nothing in buffers that are not in
10620 @node Special agenda views, Using the property API, Dynamic blocks, Hacking
10621 @section Special agenda views
10622 @cindex agenda views, user-defined
10624 Org provides a special hook that can be used to narrow down the
10625 selection made by any of the agenda views. You may specify a function
10626 that is used at each match to verify if the match should indeed be part
10627 of the agenda view, and if not, how much should be skipped.
10629 Let's say you want to produce a list of projects that contain a WAITING
10630 tag anywhere in the project tree. Let's further assume that you have
10631 marked all tree headings that define a project with the TODO keyword
10632 PROJECT. In this case you would run a TODO search for the keyword
10633 PROJECT, but skip the match unless there is a WAITING tag anywhere in
10634 the subtree belonging to the project line.
10636 To achieve this, you must write a function that searches the subtree for
10637 the tag. If the tag is found, the function must return @code{nil} to
10638 indicate that this match should not be skipped. If there is no such
10639 tag, return the location of the end of the subtree, to indicate that
10640 search should continue from there.
10643 (defun my-skip-unless-waiting ()
10644 "Skip trees that are not waiting"
10645 (let ((subtree-end (save-excursion (org-end-of-subtree t))))
10646 (if (re-search-forward ":waiting:" subtree-end t)
10647 nil ; tag found, do not skip
10648 subtree-end))) ; tag not found, continue after end of subtree
10651 Now you may use this function in an agenda custom command, for example
10655 (org-add-agenda-custom-command
10656 '("b" todo "PROJECT"
10657 ((org-agenda-skip-function 'my-skip-unless-waiting)
10658 (org-agenda-overriding-header "Projects waiting for something: "))))
10661 @vindex org-agenda-overriding-header
10662 Note that this also binds @code{org-agenda-overriding-header} to get a
10663 meaningful header in the agenda view.
10665 @vindex org-odd-levels-only
10666 @vindex org-agenda-skip-function
10667 A general way to create custom searches is to base them on a search for
10668 entries with a certain level limit. If you want to study all entries with
10669 your custom search function, simply do a search for
10670 @samp{LEVEL>0}@footnote{Note that, when using @code{org-odd-levels-only}, a
10671 level number corresponds to order in the hierarchy, not to the number of
10672 stars.}, and then use @code{org-agenda-skip-function} to select the entries
10673 you really want to have.
10675 You may also put a Lisp form into @code{org-agenda-skip-function}. In
10676 particular, you may use the functions @code{org-agenda-skip-entry-if}
10677 and @code{org-agenda-skip-subtree-if} in this form, for example:
10680 @item '(org-agenda-skip-entry-if 'scheduled)
10681 Skip current entry if it has been scheduled.
10682 @item '(org-agenda-skip-entry-if 'notscheduled)
10683 Skip current entry if it has not been scheduled.
10684 @item '(org-agenda-skip-entry-if 'deadline)
10685 Skip current entry if it has a deadline.
10686 @item '(org-agenda-skip-entry-if 'scheduled 'deadline)
10687 Skip current entry if it has a deadline, or if it is scheduled.
10688 @item '(org-agenda-skip-entry-if 'timestamp)
10689 Skip current entry if it has any timestamp, may also be deadline or scheduled.
10690 @item '(org-agenda-skip-entry 'regexp "regular expression")
10691 Skip current entry if the regular expression matches in the entry.
10692 @item '(org-agenda-skip-entry 'notregexp "regular expression")
10693 Skip current entry unless the regular expression matches.
10694 @item '(org-agenda-skip-subtree-if 'regexp "regular expression")
10695 Same as above, but check and skip the entire subtree.
10698 Therefore we could also have written the search for WAITING projects
10699 like this, even without defining a special function:
10702 (org-add-agenda-custom-command
10703 '("b" todo "PROJECT"
10704 ((org-agenda-skip-function '(org-agenda-skip-subtree-if
10705 'regexp ":waiting:"))
10706 (org-agenda-overriding-header "Projects waiting for something: "))))
10709 @node Using the property API, Using the mapping API, Special agenda views, Hacking
10710 @section Using the property API
10711 @cindex API, for properties
10712 @cindex properties, API
10714 Here is a description of the functions that can be used to work with
10717 @defun org-entry-properties &optional pom which
10718 Get all properties of the entry at point-or-marker POM.
10719 This includes the TODO keyword, the tags, time strings for deadline,
10720 scheduled, and clocking, and any additional properties defined in the
10721 entry. The return value is an alist, keys may occur multiple times
10722 if the property key was used several times.
10723 POM may also be nil, in which case the current entry is used.
10724 If WHICH is nil or `all', get all properties. If WHICH is
10725 `special' or `standard', only get that subclass.
10727 @vindex org-use-property-inheritance
10728 @defun org-entry-get pom property &optional inherit
10729 Get value of PROPERTY for entry at point-or-marker POM. By default,
10730 this only looks at properties defined locally in the entry. If INHERIT
10731 is non-nil and the entry does not have the property, then also check
10732 higher levels of the hierarchy. If INHERIT is the symbol
10733 @code{selective}, use inheritance if and only if the setting of
10734 @code{org-use-property-inheritance} selects PROPERTY for inheritance.
10737 @defun org-entry-delete pom property
10738 Delete the property PROPERTY from entry at point-or-marker POM.
10741 @defun org-entry-put pom property value
10742 Set PROPERTY to VALUE for entry at point-or-marker POM.
10745 @defun org-buffer-property-keys &optional include-specials
10746 Get all property keys in the current buffer.
10749 @defun org-insert-property-drawer
10750 Insert a property drawer at point.
10753 @defun org-entry-put-multivalued-property pom property &rest values
10754 Set PROPERTY at point-or-marker POM to VALUES. VALUES should be a list of
10755 strings. They will be concatenated, with spaces as separators.
10758 @defun org-entry-get-multivalued-property pom property
10759 Treat the value of the property PROPERTY as a whitespace-separated list of
10760 values and return the values as a list of strings.
10763 @defun org-entry-add-to-multivalued-property pom property value
10764 Treat the value of the property PROPERTY as a whitespace-separated list of
10765 values and make sure that VALUE is in this list.
10768 @defun org-entry-remove-from-multivalued-property pom property value
10769 Treat the value of the property PROPERTY as a whitespace-separated list of
10770 values and make sure that VALUE is @emph{not} in this list.
10773 @defun org-entry-member-in-multivalued-property pom property value
10774 Treat the value of the property PROPERTY as a whitespace-separated list of
10775 values and check if VALUE is in this list.
10778 @node Using the mapping API, , Using the property API, Hacking
10779 @section Using the mapping API
10780 @cindex API, for mapping
10781 @cindex mapping entries, API
10783 Org has sophisticated mapping capabilities to find all entries satisfying
10784 certain criteria. Internally, this functionality is used to produce agenda
10785 views, but there is also an API that can be used to execute arbitrary
10786 functions for each or selected entries. The main entry point for this API
10789 @defun org-map-entries func &optional match scope &rest skip
10790 Call FUNC at each headline selected by MATCH in SCOPE.
10792 FUNC is a function or a lisp form. The function will be called without
10793 arguments, with the cursor positioned at the beginning of the headline.
10794 The return values of all calls to the function will be collected and
10795 returned as a list.
10797 MATCH is a tags/property/todo match as it is used in the agenda match view.
10798 Only headlines that are matched by this query will be considered during
10799 the iteration. When MATCH is nil or t, all headlines will be
10800 visited by the iteration.
10802 SCOPE determines the scope of this command. It can be any of:
10805 nil @r{the current buffer, respecting the restriction if any}
10806 tree @r{the subtree started with the entry at point}
10807 file @r{the current buffer, without restriction}
10809 @r{the current buffer, and any archives associated with it}
10810 agenda @r{all agenda files}
10811 agenda-with-archives
10812 @r{all agenda files with any archive files associated with them}
10814 @r{if this is a list, all files in the list will be scanned}
10817 The remaining args are treated as settings for the skipping facilities of
10818 the scanner. The following items can be given here:
10820 @vindex org-agenda-skip-function
10822 archive @r{skip trees with the archive tag}
10823 comment @r{skip trees with the COMMENT keyword}
10824 function or Lisp form
10825 @r{will be used as value for @code{org-agenda-skip-function},}
10826 @r{so whenever the function returns t, FUNC}
10827 @r{will not be called for that entry and search will}
10828 @r{continue from the point where the function leaves it}
10832 The function given to that mapping routine can really do anything you like.
10833 It can use the property API (@pxref{Using the property API}) to gather more
10834 information about the entry, or in order to change metadata in the entry.
10835 Here are a couple of functions that might be handy:
10837 @defun org-todo &optional arg
10838 Change the TODO state of the entry, see the docstring of the functions for
10839 the many possible values for the argument ARG.
10842 @defun org-priority &optional action
10843 Change the priority of the entry, see the docstring of this function for the
10844 possible values for ACTION.
10847 @defun org-toggle-tag tag &optional onoff
10848 Toggle the tag TAG in the current entry. Setting ONOFF to either @code{on}
10849 or @code{off} will not toggle tag, but ensure that it is either on or off.
10853 Promote the current entry.
10857 Demote the current entry.
10860 Here is a simple example that will turn all entries in the current file with
10861 a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
10862 Entries in comment trees and in archive trees will be ignored.
10866 '(org-todo "UPCOMING")
10867 "+TOMORROW" 'file 'archive 'comment)
10870 The following example counts the number of entries with TODO keyword
10871 @code{WAITING}, in all agenda files.
10874 (length (org-map-entries t "/+WAITING" 'agenda))
10877 @node History and Acknowledgments, Main Index, Hacking, Top
10878 @appendix History and Acknowledgments
10879 @cindex acknowledgments
10883 Org was borne in 2003, out of frustration over the user interface
10884 of the Emacs Outline mode. I was trying to organize my notes and
10885 projects, and using Emacs seemed to be the natural way to go. However,
10886 having to remember eleven different commands with two or three keys per
10887 command, only to hide and show parts of the outline tree, that seemed
10888 entirely unacceptable to me. Also, when using outlines to take notes, I
10889 constantly want to restructure the tree, organizing it parallel to my
10890 thoughts and plans. @emph{Visibility cycling} and @emph{structure
10891 editing} were originally implemented in the package
10892 @file{outline-magic.el}, but quickly moved to the more general
10893 @file{org.el}. As this environment became comfortable for project
10894 planning, the next step was adding @emph{TODO entries}, basic @emph{time
10895 stamps}, and @emph{table support}. These areas highlight the two main
10896 goals that Org still has today: To create a new, outline-based,
10897 plain text mode with innovative and intuitive editing features, and to
10898 incorporate project planning functionality directly into a notes file.
10900 A special thanks goes to @i{Bastien Guerry} who has not only written a large
10901 number of extensions to Org (most of them integrated into the core by now),
10902 but has also helped the development and maintenance of Org so much that he
10903 should be considered the main co-contributor to this package.
10905 Since the first release, literally thousands of emails to me or on
10906 @code{emacs-orgmode@@gnu.org} have provided a constant stream of bug
10907 reports, feedback, new ideas, and sometimes patches and add-on code.
10908 Many thanks to everyone who has helped to improve this package. I am
10909 trying to keep here a list of the people who had significant influence
10910 in shaping one or more aspects of Org. The list may not be
10911 complete, if I have forgotten someone, please accept my apologies and
10917 @i{Russel Adams} came up with the idea for drawers.
10919 @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
10921 @i{Christophe Bataillon} created the great unicorn logo that we use on the
10924 @i{Alex Bochannek} provided a patch for rounding time stamps.
10926 @i{Tom Breton} wrote @file{org-choose.el}.
10928 @i{Charles Cave}'s suggestion sparked the implementation of templates
10931 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
10934 @i{Gregory Chernov} patched support for lisp forms into table
10935 calculations and improved XEmacs compatibility, in particular by porting
10936 @file{nouline.el} to XEmacs.
10938 @i{Sacha Chua} suggested to copy some linking code from Planner.
10940 @i{Eddward DeVilla} proposed and tested checkbox statistics. He also
10941 came up with the idea of properties, and that there should be an API for
10944 @i{Nick Dokos} tracked down several nasty bugs.
10946 @i{Kees Dullemond} used to edit projects lists directly in HTML and so
10947 inspired some of the early development, including HTML export. He also
10948 asked for a way to narrow wide table columns.
10950 @i{Christian Egli} converted the documentation into Texinfo format,
10951 patched CSS formatting into the HTML exporter, and inspired the agenda.
10953 @i{David Emery} provided a patch for custom CSS support in exported
10956 @i{Nic Ferrier} contributed mailcap and XOXO support.
10958 @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
10960 @i{John Foerch} figured out how to make incremental search show context
10961 around a match in a hidden outline tree.
10963 @i{Niels Giesen} had the idea to automatically archive DONE trees.
10965 @i{Bastien Guerry} wrote the La@TeX{} exporter and @file{org-bibtex.el}, and
10966 has been prolific with patches, ideas, and bug reports.
10968 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
10970 @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
10971 task state change logging, and the clocktable. His clear explanations have
10972 been critical when we started to adopt the GIT version control system.
10974 @i{Manuel Hermenegildo} has contributed various ideas, small fixed and
10977 @i{Phil Jackson} wrote @file{org-irc.el}.
10979 @i{Scott Jaderholm} proposed footnotes, control over whitespace between
10980 folded entries, and column view for properties.
10982 @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
10984 @i{Shidai Liu} ("Leo") asked for embedded La@TeX{} and tested it. He also
10985 provided frequent feedback and some patches.
10987 @i{Matt Lundin} has proposed last-row references for table formulas and named
10988 invisible anchors. He has also worked a lot on the FAQ.
10990 @i{Jason F. McBrayer} suggested agenda export to CSV format.
10992 @i{Max Mikhanosha} came up with the idea of refiling.
10994 @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
10997 @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
11000 @i{Rick Moynihan} proposed to allow multiple TODO sequences in a file
11001 and to be able to quickly restrict the agenda to a subtree.
11003 @i{Todd Neal} provided patches for links to Info files and elisp forms.
11005 @i{Tim O'Callaghan} suggested in-file links, search options for general
11006 file links, and TAGS.
11008 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
11011 @i{Oliver Oppitz} suggested multi-state TODO items.
11013 @i{Scott Otterson} sparked the introduction of descriptive text for
11014 links, among other things.
11016 @i{Pete Phillips} helped during the development of the TAGS feature, and
11017 provided frequent feedback.
11019 @i{Martin Pohlack} provided the code snippet to bundle character insertion
11020 into bundles of 20 for undo.
11022 @i{T.V. Raman} reported bugs and suggested improvements.
11024 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
11027 @i{Paul Rivier} provided the basic implementation of named footnotes.
11029 @i{Kevin Rogers} contributed code to access VM files on remote hosts.
11031 @i{Sebastian Rose} wrote @file{org-info.js}, a Java script for displaying
11032 webpages derived from Org using an Info-like, or a folding interface with
11033 single key navigation.
11035 @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
11036 conflict with @file{allout.el}.
11038 @i{Jason Riedy} generalized the send-receive mechanism for orgtbl tables with
11041 @i{Philip Rooke} created the Org reference card, provided lots
11042 of feedback, developed and applied standards to the Org documentation.
11044 @i{Christian Schlauer} proposed angular brackets around links, among
11047 @i{Eric Schulte} wrote @file{org-plot.el}.
11049 Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
11050 @file{organizer-mode.el}.
11052 @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal
11053 examples, and remote highlighting for referenced code lines.
11055 @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
11056 now packaged into Org's @file{contrib} directory.
11058 @i{Daniel Sinder} came up with the idea of internal archiving by locking
11061 @i{Dale Smith} proposed link abbreviations.
11063 @i{James TD Smith} has contributed a large number of patches for useful
11064 tweaks and features.
11066 @i{Adam Spiers} asked for global linking commands, inspired the link
11067 extension system, added support for mairix, and proposed the mapping API.
11069 @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content
11070 with links transformation to Org syntax.
11072 @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
11073 chapter about publishing.
11075 @i{J@"urgen Vollmer} contributed code generating the table of contents
11078 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
11081 @i{David Wainberg} suggested archiving, and improvements to the linking
11084 @i{John Wiegley} wrote @file{emacs-wiki.el}, @file{planner.el}, and
11085 @file{muse.el}, which have some overlap with Org. Initially the development
11086 of Org was fully independent because I was not aware of the existence of
11087 these packages. But with time I have occasionally looked at John's code and
11088 learned a lot from it. John has also contributed a number of great ideas and
11089 patches directly to Org, including the attachment system
11090 (@file{org-attach.el}), integration with Apple Mail
11091 (@file{org-mac-message.el}), and hierarchical dependencies of TODO items.
11093 @i{Carsten Wimmer} suggested some changes and helped fix a bug in
11096 @i{Roland Winkler} requested additional key bindings to make Org
11099 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
11100 and contributed various ideas and code snippets.
11104 @node Main Index, Key Index, History and Acknowledgments, Top
11105 @unnumbered Concept Index
11109 @node Key Index, Variable and Faces Index, Main Index, Top
11110 @unnumbered Key Index
11114 @node Variable and Faces Index, , Key Index, Top
11115 @unnumbered Variable Index
11117 This is not a complete index of variables and faces, only the ones that are
11118 mentioned in the manual. For a more complete list, use @kbd{M-x
11119 org-customize @key{RET}} and then klick yourself through the tree.
11126 arch-tag: 7893d1Fe-cc57-4d13-b5e5-f494a1CBC7ac
11129 @c Local variables:
11130 @c ispell-local-dictionary: "en_US-w_accents"
11131 @c ispell-local-pdict: "./.aspell.org.pws"