3 @setfilename ../../info/org
4 @settitle The Org Manual
7 @set DATE November 2008
11 * Org Mode: (org). Outline-based notes management and organizer
14 @c Version and Contact Info
15 @set MAINTAINERSITE @uref{http://orgmode.org,maintainers webpage}
16 @set AUTHOR Carsten Dominik
17 @set MAINTAINER Carsten Dominik
18 @set MAINTAINEREMAIL @email{carsten at orgmode dot org}
19 @set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer}
25 @c Subheadings inside a table.
26 @macro tsubheading{text}
36 This manual is for Org (version @value{VERSION}).
38 Copyright @copyright{} 2004, 2005, 2006, 2007, 2008 Free Software Foundation
41 Permission is granted to copy, distribute and/or modify this document
42 under the terms of the GNU Free Documentation License, Version 1.2 or
43 any later version published by the Free Software Foundation; with no
44 Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
45 and with the Back-Cover Texts as in (a) below. A copy of the license
46 is included in the section entitled ``GNU Free Documentation License.''
48 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
49 modify this GNU manual. Buying copies from the FSF supports it in
50 developing GNU and promoting software freedom.''
52 This document is part of a collection distributed under the GNU Free
53 Documentation License. If you want to distribute this document
54 separately from the collection, you can do so by adding a copy of the
55 license to the document, as described in section 6 of the license.
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 * Extensions:: Add-ons for Org mode
97 * Hacking:: How hack your way around
98 * History and Acknowledgments:: How Org came into being
99 * Main Index:: An index of Org's concepts and features
100 * Key Index:: Key bindings and where they are described
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 * Orgstruct mode:: Structure editing outside Org
128 * ARCHIVE tag:: Marking a tree as inactive
129 * Moving subtrees:: Moving a tree to an archive file
133 * Built-in table editor:: Simple tables
134 * Narrow columns:: Stop wasting space in tables
135 * Column groups:: Grouping to trigger vertical lines
136 * Orgtbl mode:: The table editor as minor mode
137 * The spreadsheet:: The table editor has spreadsheet capabilities
138 * Org Plot:: Plotting from org tables
142 * References:: How to refer to another field or range
143 * Formula syntax for Calc:: Using Calc to compute stuff
144 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
145 * Field formulas:: Formulas valid for a single field
146 * Column formulas:: Formulas valid for an entire column
147 * Editing and debugging formulas:: Fixing formulas
148 * Updating the table:: Recomputing all dependent fields
149 * Advanced features:: Field names, parameters and automatic recalc
153 * Link format:: How links in Org are formatted
154 * Internal links:: Links to other places in the current file
155 * External links:: URL-like links to the world
156 * Handling links:: Creating, inserting and following
157 * Using links outside Org:: Linking from my C source code?
158 * Link abbreviations:: Shortcuts for writing complex links
159 * Search options:: Linking to a specific location
160 * Custom searches:: When the default search is not enough
164 * Radio targets:: Make targets trigger links in plain text
168 * TODO basics:: Marking and displaying TODO entries
169 * TODO extensions:: Workflow and assignments
170 * Progress logging:: Dates and notes for progress
171 * Priorities:: Some things are more important than others
172 * Breaking down tasks:: Splitting a task into manageable pieces
173 * Checkboxes:: Tick-off lists
175 Extended use of TODO keywords
177 * Workflow states:: From TODO to DONE in steps
178 * TODO types:: I do this, Fred does the rest
179 * Multiple sets in one file:: Mixing it all, and still finding your way
180 * Fast access to TODO states:: Single letter selection of a state
181 * Per-file keywords:: Different files, different requirements
182 * Faces for TODO keywords:: Highlighting states
186 * Closing items:: When was this entry marked DONE?
187 * Tracking TODO state changes:: When did the status change?
191 * Tag inheritance:: Tags use the tree structure of the outline
192 * Setting tags:: How to assign tags to a headline
193 * Tag searches:: Searching for combinations of tags
195 Properties and Columns
197 * Property syntax:: How properties are spelled out
198 * Special properties:: Access to other Org mode features
199 * Property searches:: Matching property values
200 * Property inheritance:: Passing values down the tree
201 * Column view:: Tabular viewing and editing
202 * Property API:: Properties for Lisp programmers
206 * Defining columns:: The COLUMNS format property
207 * Using column view:: How to create and use column view
208 * Capturing column view:: A dynamic block for column view
212 * Scope of column definitions:: Where defined, where valid?
213 * Column attributes:: Appearance and content of a column
217 * Timestamps:: Assigning a time to a tree entry
218 * Creating timestamps:: Commands which insert timestamps
219 * Deadlines and scheduling:: Planning your work
220 * Clocking work time:: Tracking how long you spend on a task
221 * Effort estimates:: Planning work effort in advance
225 * The date/time prompt:: How Org mode helps you entering date and time
226 * Custom time format:: Making dates look different
228 Deadlines and scheduling
230 * Inserting deadline/schedule:: Planning items
231 * Repeated tasks:: Items that show up again and again
235 * Remember:: Capture new tasks/ideas with little interruption
236 * Attachments:: Add files to tasks.
240 * Setting up Remember:: Some code for .emacs to get things going
241 * Remember templates:: Define the outline of different note types
242 * Storing notes:: Directly get the note to where it belongs
243 * Refiling notes:: Moving a note or task to a project
247 * Agenda files:: Files being searched for agenda information
248 * Agenda dispatcher:: Keyboard access to agenda views
249 * Built-in agenda views:: What is available out of the box?
250 * Presentation and sorting:: How agenda items are prepared for display
251 * Agenda commands:: Remote editing of Org trees
252 * Custom agenda views:: Defining special searches and views
253 * Agenda column view:: Using column view for collected entries
255 The built-in agenda views
257 * Weekly/daily agenda:: The calendar page with current tasks
258 * Global TODO list:: All unfinished action items
259 * Matching tags and properties:: Structured information with fine-tuned search
260 * Timeline:: Time-sorted view for single file
261 * Keyword search:: Finding entries by keyword
262 * Stuck projects:: Find projects you need to review
264 Presentation and sorting
266 * Categories:: Not all tasks are equal
267 * Time-of-day specifications:: How the agenda knows the time
268 * Sorting of agenda items:: The order of things
272 * Storing searches:: Type once, use often
273 * Block agenda:: All the stuff you need in a single buffer
274 * Setting Options:: Changing the rules
275 * Exporting Agenda Views:: Writing agendas to files
276 * Using the agenda elsewhere:: Using agenda information in other programs
280 * Math symbols:: TeX macros for symbols and Greek letters
281 * Subscripts and superscripts:: Simple syntax for raising/lowering text
282 * LaTeX fragments:: Complex formulas made easy
283 * Processing LaTeX fragments:: Previewing LaTeX processing
284 * CDLaTeX mode:: Speed up entering of formulas
288 * Markup rules:: Which structures are recognized?
289 * Selective export:: Using tags to select and exclude trees
290 * Export options:: Per-file export settings
291 * The export dispatcher:: How to access exporter commands
292 * ASCII export:: Exporting to plain ASCII
293 * HTML export:: Exporting to HTML
294 * LaTeX and PDF export:: Exporting to LaTeX, and processing to PDF
295 * XOXO export:: Exporting to XOXO
296 * iCalendar export:: Exporting in iCalendar format
300 * Document title:: How the document title is determined
301 * Headings and sections:: The main structure of the exported document
302 * Table of contents:: If, where, how to create a table of contents
303 * Initial text:: Text before the first headline
304 * Lists:: Plain lists are exported
305 * Paragraphs:: What determines beginning and ending
306 * Literal examples:: Source code and other examples
307 * Include files:: Include the contents of a file during export
308 * Tables exported:: Tables are exported richly
309 * Footnotes:: Numbers like [1]
310 * Emphasis and monospace:: To bold or not to bold
311 * TeX macros and LaTeX fragments:: Create special, rich export.
312 * Horizontal rules:: A line across the page
313 * Comment lines:: Some lines will not be exported
317 * HTML Export commands:: How to invoke HTML export
318 * Quoting HTML tags:: Using direct HTML in Org mode
319 * Links:: Transformation of links for HTML
320 * Images:: How to include images
321 * CSS support:: Changing the appearance of the output
322 * Javascript support:: Info and Folding in a web browser
326 * LaTeX/PDF export commands::
327 * Quoting LaTeX code:: Incorporating literal LaTeX code
328 * Sectioning structure:: Changing sectioning in LaTeX output
332 * Configuration:: Defining projects
333 * Sample configuration:: Example projects
334 * Triggering publication:: Publication commands
338 * Project alist:: The central configuration variable
339 * Sources and destinations:: From here to there
340 * Selecting files:: What files are part of the project?
341 * Publishing action:: Setting the function doing the publishing
342 * Publishing options:: Tweaking HTML export
343 * Publishing links:: Which links keep working after publishing?
344 * Project page index:: Publishing a list of project files
348 * Simple example:: One-component publishing
349 * Complex example:: A multi-component publishing example
353 * Completion:: M-TAB knows what you need
354 * Customization:: Adapting Org to your taste
355 * In-buffer settings:: Overview of the #+KEYWORDS
356 * The very busy C-c C-c key:: When in doubt, press C-c C-c
357 * Clean view:: Getting rid of leading stars in the outline
358 * TTY keys:: Using Org on a tty
359 * Interaction:: Other Emacs packages
360 * Bugs:: Things which do not work perfectly
362 Interaction with other packages
364 * Cooperation:: Packages Org cooperates with
365 * Conflicts:: Packages that lead to conflicts
369 * Extensions in the contrib directory:: These come with the Org distro
370 * Other extensions:: These you have to find on the web.
374 * Adding hyperlink types:: New custom link types
375 * Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs
376 * Dynamic blocks:: Automatically filled blocks
377 * Special agenda views:: Customized views
378 * Using the property API:: Writing programs that use entry properties
379 * Using the mapping API:: Mapping over all or selected entries
381 Tables and lists in arbitrary syntax
383 * Radio tables:: Sending and receiving
384 * A LaTeX example:: Step by step, almost a tutorial
385 * Translator functions:: Copy and modify
386 * Radio lists:: Doing the same for lists
391 @node Introduction, Document Structure, Top, Top
392 @chapter Introduction
396 * Summary:: Brief summary of what Org does
397 * Installation:: How to install a downloaded version of Org
398 * Activation:: How to activate Org for certain buffers
399 * Feedback:: Bug reports, ideas, patches etc.
400 * Conventions:: Type-setting conventions in the manual
403 @node Summary, Installation, Introduction, Introduction
407 Org is a mode for keeping notes, maintaining TODO lists, and doing
408 project planning with a fast and effective plain-text system.
410 Org develops organizational tasks around NOTES files that contain
411 lists or information about projects as plain text. Org is
412 implemented on top of Outline mode, which makes it possible to keep the
413 content of large files well structured. Visibility cycling and
414 structure editing help to work with the tree. Tables are easily created
415 with a built-in table editor. Org supports TODO items, deadlines,
416 time stamps, and scheduling. It dynamically compiles entries into an
417 agenda that utilizes and smoothly integrates much of the Emacs calendar
418 and diary. Plain text URL-like links connect to websites, emails,
419 Usenet messages, BBDB entries, and any files related to the projects.
420 For printing and sharing of notes, an Org file can be exported as a
421 structured ASCII file, as HTML, or (TODO and agenda items only) as an
422 iCalendar file. It can also serve as a publishing tool for a set of
425 An important design aspect that distinguishes Org from for example
426 Planner/Muse is that it encourages to store every piece of information
427 only once. In Planner, you have project pages, day pages and possibly
428 other files, duplicating some information such as tasks. In Org,
429 you only have notes files. In your notes you mark entries as tasks,
430 label them with tags and timestamps. All necessary lists like a
431 schedule for the day, the agenda for a meeting, tasks lists selected by
432 tags etc are created dynamically when you need them.
434 Org keeps simple things simple. When first fired up, it should
435 feel like a straightforward, easy to use outliner. Complexity is not
436 imposed, but a large amount of functionality is available when you need
437 it. Org is a toolbox and can be used in different ways, for
441 @r{@bullet{} outline extension with visibility cycling and structure editing}
442 @r{@bullet{} ASCII system and table editor for taking structured notes}
443 @r{@bullet{} ASCII table editor with spreadsheet-like capabilities}
444 @r{@bullet{} TODO list editor}
445 @r{@bullet{} full agenda and planner with deadlines and work scheduling}
446 @r{@bullet{} environment to implement David Allen's GTD system}
447 @r{@bullet{} a basic database application}
448 @r{@bullet{} simple hypertext system, with HTML and LaTeX export}
449 @r{@bullet{} publishing tool to create a set of interlinked webpages}
452 Org's automatic, context sensitive table editor with spreadsheet
453 capabilities can be integrated into any major mode by activating the
454 minor Orgtbl mode. Using a translation step, it can be used to maintain
455 tables in arbitrary file types, for example in La@TeX{}. The structure
456 editing and list creation capabilities can be used outside Org with
457 the minor Orgstruct mode.
460 There is a website for Org which provides links to the newest
461 version of Org, as well as additional information, frequently asked
462 questions (FAQ), links to tutorials etc. This page is located at
463 @uref{http://orgmode.org}.
468 @node Installation, Activation, Summary, Introduction
469 @section Installation
473 @b{Important:} @i{If Org is part of the Emacs distribution or an
474 XEmacs package, please skip this section and go directly to
477 If you have downloaded Org from the Web, either as a distribution @file{.zip}
478 or @file{.tar} file, or as a GIT archive, you must take the following steps
479 to install it: Go into the unpacked Org distribution directory and edit the
480 top section of the file @file{Makefile}. You must set the name of the Emacs
481 binary (likely either @file{emacs} or @file{xemacs}), and the paths to the
482 directories where local Lisp and Info files are kept. If you don't have
483 access to the system-wide directories, you can simply run Org directly from
484 the distribution directory by adding the @file{lisp} subdirectory to the
485 Emacs load path. To do this, add the following line to @file{.emacs}:
488 (setq load-path (cons "~/path/to/orgdir/lisp" load-path))
492 If you plan to use code from the @file{contrib} subdirectory, do a similar
493 step for this directory:
496 (setq load-path (cons "~/path/to/orgdir/contrib/lisp" load-path))
499 @b{XEmacs users now need to install the file @file{noutline.el} from
500 the @file{xemacs} sub-directory of the Org distribution. Use the
504 @b{make install-noutline}
507 @noindent Now byte-compile the Lisp files with the shell command:
513 @noindent If you are running Org from the distribution directory, this is
514 all. If you want to install into the system directories, use
521 @noindent Then add to @file{.emacs}:
524 ;; This line only if Org is not part of the X/Emacs distribution.
525 (require 'org-install)
529 @node Activation, Feedback, Installation, Introduction
533 @cindex global key bindings
534 @cindex key bindings, global
537 @b{Important:} @i{If you use copy-and-paste to copy lisp code from the
538 PDF documentation as viewed by some PDF viewers to your .emacs file, the
539 single quote character comes out incorrectly and the code will not work.
540 You need to fix the single quotes by hand, or copy from Info
544 Add the following lines to your @file{.emacs} file. The last three lines
545 define @emph{global} keys for the commands @command{org-store-link},
546 @command{org-agenda}, and @command{org-iswitchb} - please choose suitable
550 ;; The following lines are always needed. Choose your own keys.
551 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
552 (global-set-key "\C-cl" 'org-store-link)
553 (global-set-key "\C-ca" 'org-agenda)
554 (global-set-key "\C-cb" 'org-iswitchb)
557 Furthermore, you must activate @code{font-lock-mode} in Org
558 buffers, because significant functionality depends on font-locking being
559 active. You can do this with either one of the following two lines
560 (XEmacs user must use the second option):
562 (global-font-lock-mode 1) ; for all buffers
563 (add-hook 'org-mode-hook 'turn-on-font-lock) ; Org buffers only
566 @cindex Org mode, turning on
567 With this setup, all files with extension @samp{.org} will be put
568 into Org mode. As an alternative, make the first line of a file look
572 MY PROJECTS -*- mode: org; -*-
575 @noindent which will select Org mode for this buffer no matter what
576 the file's name is. See also the variable
577 @code{org-insert-mode-line-in-empty-file}.
579 @node Feedback, Conventions, Activation, Introduction
586 If you find problems with Org, or if you have questions, remarks, or ideas
587 about it, please mail to the Org mailing list @code{emacs-orgmode@@gnu.org}.
588 If you are not a member of the mailing list, your mail will be reviewed by a
589 moderator and then passed through to the list.
591 For bug reports, please provide as much information as possible,
592 including the version information of Emacs (@kbd{C-h v emacs-version
593 @key{RET}}) and Org (@kbd{C-h v org-version @key{RET}}), as well as
594 the Org related setup in @file{.emacs}. If an error occurs, a
595 backtrace can be very useful (see below on how to create one). Often a
596 small example file helps, along with clear information about:
599 @item What exactly did you do?
600 @item What did you expect to happen?
601 @item What happened instead?
603 @noindent Thank you for helping to improve this mode.
605 @subsubheading How to create a useful backtrace
607 @cindex backtrace of an error
608 If working with Org produces an error with a message you don't
609 understand, you may have hit a bug. The best way to report this is by
610 providing, in addition to what was mentioned above, a @emph{Backtrace}.
611 This is information from the built-in debugger about where and how the
612 error occurred. Here is how to produce a useful backtrace:
616 Start a fresh Emacs or XEmacs, and make sure that it will load the
617 original Lisp code in @file{org.el} instead of the compiled version in
618 @file{org.elc}. The backtrace contains much more information if it is
619 produced with uncompiled code. To do this, either rename @file{org.elc}
620 to something else before starting Emacs, or ask Emacs explicitly to load
621 @file{org.el} by using the command line
623 emacs -l /path/to/org.el
626 Go to the @code{Options} menu and select @code{Enter Debugger on Error}
627 (XEmacs has this option in the @code{Troubleshooting} sub-menu).
629 Do whatever you have to do to hit the error. Don't forget to
630 document the steps you take.
632 When you hit the error, a @file{*Backtrace*} buffer will appear on the
633 screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and
634 attach it to your bug report.
637 @node Conventions, , Feedback, Introduction
638 @section Typesetting conventions used in this manual
640 Org uses three types of keywords: TODO keywords, tags, and property
641 names. In this manual we use the following conventions:
646 TODO keywords are written with all capitals, even if they are
650 User-defined tags are written in lowercase; built-in tags with special
651 meaning are written with all capitals.
654 User-defined properties are capitalized; built-in properties with
655 special meaning are written with all capitals.
658 @node Document Structure, Tables, Introduction, Top
659 @chapter Document Structure
660 @cindex document structure
661 @cindex structure of document
663 Org is based on outline mode and provides flexible commands to
664 edit the structure of the document.
667 * Outlines:: Org is based on Outline mode
668 * Headlines:: How to typeset Org tree headlines
669 * Visibility cycling:: Show and hide, much simplified
670 * Motion:: Jumping to other headlines
671 * Structure editing:: Changing sequence and level of headlines
672 * Archiving:: Move done task trees to a different place
673 * Sparse trees:: Matches embedded in context
674 * Plain lists:: Additional structure within an entry
675 * Drawers:: Tucking stuff away
676 * Orgstruct mode:: Structure editing outside Org
679 @node Outlines, Headlines, Document Structure, Document Structure
684 Org is implemented on top of Outline mode. Outlines allow a
685 document to be organized in a hierarchical structure, which (at least
686 for me) is the best representation of notes and thoughts. An overview
687 of this structure is achieved by folding (hiding) large parts of the
688 document to show only the general document structure and the parts
689 currently being worked on. Org greatly simplifies the use of
690 outlines by compressing the entire show/hide functionality into a single
691 command @command{org-cycle}, which is bound to the @key{TAB} key.
693 @node Headlines, Visibility cycling, Outlines, Document Structure
698 Headlines define the structure of an outline tree. The headlines in
699 Org start with one or more stars, on the left margin@footnote{See
700 the variable @code{org-special-ctrl-a/e} to configure special behavior
701 of @kbd{C-a} and @kbd{C-e} in headlines.}. For example:
711 * Another top level headline
714 @noindent Some people find the many stars too noisy and would prefer an
715 outline that has whitespace followed by a single star as headline
716 starters. @ref{Clean view} describes a setup to realize this.
718 An empty line after the end of a subtree is considered part of it and
719 will be hidden when the subtree is folded. However, if you leave at
720 least two empty lines, one empty line will remain visible after folding
721 the subtree, in order to structure the collapsed view. See the
722 variable @code{org-cycle-separator-lines} to modify this behavior.
724 @node Visibility cycling, Motion, Headlines, Document Structure
725 @section Visibility cycling
726 @cindex cycling, visibility
727 @cindex visibility cycling
728 @cindex trees, visibility
729 @cindex show hidden text
732 Outlines make it possible to hide parts of the text in the buffer.
733 Org uses just two commands, bound to @key{TAB} and
734 @kbd{S-@key{TAB}} to change the visibility in the buffer.
736 @cindex subtree visibility states
737 @cindex subtree cycling
738 @cindex folded, subtree visibility state
739 @cindex children, subtree visibility state
740 @cindex subtree, subtree visibility state
744 @emph{Subtree cycling}: Rotate current subtree among the states
747 ,-> FOLDED -> CHILDREN -> SUBTREE --.
748 '-----------------------------------'
751 The cursor must be on a headline for this to work@footnote{see, however,
752 the option @code{org-cycle-emulate-tab}.}. When the cursor is at the
753 beginning of the buffer and the first line is not a headline, then
754 @key{TAB} actually runs global cycling (see below)@footnote{see the
755 option @code{org-cycle-global-at-bob}.}. Also when called with a prefix
756 argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
758 @cindex global visibility states
759 @cindex global cycling
760 @cindex overview, global visibility state
761 @cindex contents, global visibility state
762 @cindex show all, global visibility state
766 @emph{Global cycling}: Rotate the entire buffer among the states
769 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
770 '--------------------------------------'
773 When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
774 CONTENTS view up to headlines of level N will be shown. Note that inside
775 tables, @kbd{S-@key{TAB}} jumps to the previous field.
777 @cindex show all, command
778 @kindex C-u C-u C-u @key{TAB}
779 @item C-u C-u C-u @key{TAB}
780 Show all, including drawers.
783 Reveal context around point, showing the current entry, the following heading
784 and the hierarchy above. Useful for working near a location that has been
785 exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
786 (@pxref{Agenda commands}). With a prefix argument show, on each
787 level, all sibling headings.
790 Show the current subtree in an indirect buffer@footnote{The indirect
793 (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
796 (see the Emacs manual for more information about indirect buffers)
798 will contain the entire buffer, but will be narrowed to the current
799 tree. Editing the indirect buffer will also change the original buffer,
800 but without affecting visibility in that buffer.}. With a numeric
801 prefix argument N, go up to level N and then take that tree. If N is
802 negative then go up that many levels. With a @kbd{C-u} prefix, do not remove
803 the previously used indirect buffer.
806 When Emacs first visits an Org file, the global state is set to
807 OVERVIEW, i.e. only the top level headlines are visible. This can be
808 configured through the variable @code{org-startup-folded}, or on a
809 per-file basis by adding one of the following lines anywhere in the
819 Forthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
820 and Columns}) will get their visibility adapted accordingly. Allowed values
821 for this property are @code{folded}, @code{children}, @code{content}, and
824 @kindex C-u C-u @key{TAB}
825 @item C-u C-u @key{TAB}
826 Switch back to the startup visibility of the buffer, i.e. whatever is
827 requested by startup options and @samp{VISIBILITY} properties in individual
831 @node Motion, Structure editing, Visibility cycling, Document Structure
833 @cindex motion, between headlines
834 @cindex jumping, to headlines
835 @cindex headline navigation
836 The following commands jump to other headlines in the buffer.
847 Next heading same level.
850 Previous heading same level.
853 Backward to higher level heading.
856 Jump to a different place without changing the current outline
857 visibility. Shows the document structure in a temporary buffer, where
858 you can use the following keys to find your destination:
860 @key{TAB} @r{Cycle visibility.}
861 @key{down} / @key{up} @r{Next/previous visible headline.}
862 @key{RET} @r{Select this location.}
863 @kbd{/} @r{Do a Sparse-tree search}
864 @r{The following keys work if you turn off @code{org-goto-auto-isearch}}
865 n / p @r{Next/previous visible headline.}
866 f / b @r{Next/previous headline same level.}
868 0-9 @r{Digit argument.}
873 @node Structure editing, Archiving, Motion, Document Structure
874 @section Structure editing
875 @cindex structure editing
876 @cindex headline, promotion and demotion
877 @cindex promotion, of subtrees
878 @cindex demotion, of subtrees
879 @cindex subtree, cut and paste
880 @cindex pasting, of subtrees
881 @cindex cutting, of subtrees
882 @cindex copying, of subtrees
883 @cindex subtrees, cut and paste
888 Insert new heading with same level as current. If the cursor is in a
889 plain list item, a new item is created (@pxref{Plain lists}). To force
890 creation of a new headline, use a prefix argument, or first press @key{RET}
891 to get to the beginning of the next line. When this command is used in
892 the middle of a line, the line is split and the rest of the line becomes
893 the new headline@footnote{If you do not want the line to be split,
894 customize the variable @code{org-M-RET-may-split-line}.}. If the
895 command is used at the beginning of a headline, the new headline is
896 created before the current line. If at the beginning of any other line,
897 the content of that line is made the new heading. If the command is
898 used at the end of a folded subtree (i.e. behind the ellipses at the end
899 of a headline), then a headline like the current one will be inserted
900 after the end of the subtree.
903 Just like @kbd{M-@key{RET}}, except when adding a new heading below the
904 current heading, the new heading is placed after the body instead of before
905 it. This command works from anywhere in the entry.
906 @kindex M-S-@key{RET}
908 Insert new TODO entry with same level as current heading.
909 @kindex C-S-@key{RET}
911 Insert new TODO entry with same level as current heading. Like
912 @kbd{C-@key{RET}}, the new headline will be inserted after the current
916 Promote current heading by one level.
917 @kindex M-@key{right}
919 Demote current heading by one level.
920 @kindex M-S-@key{left}
922 Promote the current subtree by one level.
923 @kindex M-S-@key{right}
924 @item M-S-@key{right}
925 Demote the current subtree by one level.
928 Move subtree up (swap with previous subtree of same
930 @kindex M-S-@key{down}
932 Move subtree down (swap with next subtree of same level).
935 Kill subtree, i.e. remove it from buffer but save in kill ring.
936 With a numeric prefix argument N, kill N sequential subtrees.
939 Copy subtree to kill ring. With a numeric prefix argument N, copy the N
943 Yank subtree from kill ring. This does modify the level of the subtree to
944 make sure the tree fits in nicely at the yank position. The yank level can
945 also be specified with a numeric prefix argument, or by yanking after a
946 headline marker like @samp{****}.
949 Depending on the variables @code{org-yank-adjusted-subtrees} and
950 @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
951 paste subtrees folded and in a clever way, using the same command as @kbd{C-c
952 C-x C-y}. With the default settings, level adjustment will take place and
953 yanked trees will be folded unless doing so would swallow text previously
954 visible. Any prefix argument to this command will force a normal @code{yank}
955 to be executed, with the prefix passed along. A good way to force a normal
956 yank is @kbd{C-u C-y}. If you use @code{yank-pop} after a yank, it will yank
957 previous kill items plainly, without adjustment and folding.
960 Refile entry or region to a different location. @xref{Refiling notes}.
963 Sort same-level entries. When there is an active region, all entries in the
964 region will be sorted. Otherwise the children of the current headline are
965 sorted. The command prompts for the sorting method, which can be
966 alphabetically, numerically, by time (using the first time stamp in each
967 entry), by priority, or by TODO keyword (in the sequence the keywords have
968 been defined in the setup). Reverse sorting is possible as well. You can
969 also supply your own function to extract the sorting key. With a @kbd{C-u}
970 prefix, sorting will be case-sensitive. With two @kbd{C-u C-u} prefixes,
971 duplicate entries will also be removed.
974 Narrow buffer to current subtree.
977 Widen buffer to remove a narrowing.
980 Turn a normal line or plain list item into a headline (so that it
981 becomes a subheading at its location). Also turn a headline into a
982 normal line by removing the stars. If there is an active region, turn
983 all lines in the region into headlines. Or, if the first line is a
984 headline, remove the stars from all headlines in the region.
987 @cindex region, active
988 @cindex active region
989 @cindex Transient mark mode
990 When there is an active region (Transient mark mode), promotion and
991 demotion work on all headlines in the region. To select a region of
992 headlines, it is best to place both point and mark at the beginning of a
993 line, mark at the beginning of the first headline, and point at the line
994 just after the last headline to change. Note that when the cursor is
995 inside a table (@pxref{Tables}), the Meta-Cursor keys have different
998 @node Archiving, Sparse trees, Structure editing, Document Structure
1002 When a project represented by a (sub)tree is finished, you may want
1003 to move the tree out of the way and to stop it from contributing to the
1004 agenda. Org mode knows two ways of archiving. You can mark a tree with
1005 the ARCHIVE tag, or you can move an entire (sub)tree to a different
1009 * ARCHIVE tag:: Marking a tree as inactive
1010 * Moving subtrees:: Moving a tree to an archive file
1013 @node ARCHIVE tag, Moving subtrees, Archiving, Archiving
1014 @subsection The ARCHIVE tag
1015 @cindex internal archiving
1017 A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
1018 its location in the outline tree, but behaves in the following way:
1021 It does not open when you attempt to do so with a visibility cycling
1022 command (@pxref{Visibility cycling}). You can force cycling archived
1023 subtrees with @kbd{C-@key{TAB}}, or by setting the option
1024 @code{org-cycle-open-archived-trees}. Also normal outline commands like
1025 @code{show-all} will open archived subtrees.
1027 During sparse tree construction (@pxref{Sparse trees}), matches in
1028 archived subtrees are not exposed, unless you configure the option
1029 @code{org-sparse-tree-open-archived-trees}.
1031 During agenda view construction (@pxref{Agenda Views}), the content of
1032 archived trees is ignored unless you configure the option
1033 @code{org-agenda-skip-archived-trees}, in which case these trees will always
1034 be included. In the agenda you can press the @kbd{v} key to get archives
1035 temporarily included.
1037 Archived trees are not exported (@pxref{Exporting}), only the headline
1038 is. Configure the details using the variable
1039 @code{org-export-with-archived-trees}.
1042 The following commands help managing the ARCHIVE tag:
1047 Toggle the ARCHIVE tag for the current headline. When the tag is set,
1048 the headline changes to a shadowed face, and the subtree below it is
1050 @kindex C-u C-c C-x a
1052 Check if any direct children of the current headline should be archived.
1053 To do this, each subtree is checked for open TODO entries. If none are
1054 found, the command offers to set the ARCHIVE tag for the child. If the
1055 cursor is @emph{not} on a headline when this command is invoked, the
1056 level 1 trees will be checked.
1059 Cycle a tree even if it is tagged with ARCHIVE.
1062 @node Moving subtrees, , ARCHIVE tag, Archiving
1063 @subsection Moving subtrees
1064 @cindex external archiving
1066 Once an entire project is finished, you may want to move it to a different
1067 location. Org can move it to an @emph{Archive Sibling} in the same tree, to a
1068 different tree in the current file, or to a different file, the archive file.
1073 Move the current entry to the @emph{Archive Sibling}. This is a sibling of
1074 the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}
1075 (@pxref{ARCHIVE tag}). The entry becomes a child of that sibling and in this
1076 way retains a lot of its original context, including inherited tags and
1077 approximate position in the outline.
1080 Archive the subtree starting at the cursor position to the location
1081 given by @code{org-archive-location}. Context information that could be
1082 lost like the file name, the category, inherited tags, and the TODO
1083 state will be store as properties in the entry.
1084 @kindex C-u C-c C-x C-s
1085 @item C-u C-c C-x C-s
1086 Check if any direct children of the current headline could be moved to
1087 the archive. To do this, each subtree is checked for open TODO entries.
1088 If none are found, the command offers to move it to the archive
1089 location. If the cursor is @emph{not} on a headline when this command
1090 is invoked, the level 1 trees will be checked.
1093 @cindex archive locations
1094 The default archive location is a file in the same directory as the
1095 current file, with the name derived by appending @file{_archive} to the
1096 current file name. For information and examples on how to change this,
1097 see the documentation string of the variable
1098 @code{org-archive-location}. There is also an in-buffer option for
1099 setting this variable, for example@footnote{For backward compatibility,
1100 the following also works: If there are several such lines in a file,
1101 each specifies the archive location for the text below it. The first
1102 such line also applies to any text before its definition. However,
1103 using this method is @emph{strongly} deprecated as it is incompatible
1104 with the outline structure of the document. The correct method for
1105 setting multiple archive locations in a buffer is using a property.}:
1108 #+ARCHIVE: %s_done::
1112 If you would like to have a special ARCHIVE location for a single entry
1113 or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
1114 location as the value (@pxref{Properties and Columns}).
1116 When a subtree is moved, it receives a number of special properties that
1117 record context information like the file from where the entry came, it's
1118 outline path the archiving time etc. Configure the variable
1119 @code{org-archive-save-context-info} to adjust the amount of information
1122 @node Sparse trees, Plain lists, Archiving, Document Structure
1123 @section Sparse trees
1124 @cindex sparse trees
1125 @cindex trees, sparse
1126 @cindex folding, sparse trees
1127 @cindex occur, command
1129 An important feature of Org mode is the ability to construct @emph{sparse
1130 trees} for selected information in an outline tree, so that the entire
1131 document is folded as much as possible, but the selected information is made
1132 visible along with the headline structure above it@footnote{See also the
1133 variables @code{org-show-hierarchy-above}, @code{org-show-following-heading},
1134 @code{org-show-siblings}, and @code{org-show-entry-below} for detailed
1135 control on how much context is shown around each match.}. Just try it out
1136 and you will see immediately how it works.
1138 Org mode contains several commands creating such trees, all these
1139 commands can be accessed through a dispatcher:
1144 This prompts for an extra key to select a sparse-tree creating command.
1147 Occur. Prompts for a regexp and shows a sparse tree with all matches. If
1148 the match is in a headline, the headline is made visible. If the match is in
1149 the body of an entry, headline and body are made visible. In order to
1150 provide minimal context, also the full hierarchy of headlines above the match
1151 is shown, as well as the headline following the match. Each match is also
1152 highlighted; the highlights disappear when the buffer is changed by an
1153 editing command@footnote{depending on the option
1154 @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
1155 When called with a @kbd{C-u} prefix argument, previous highlights are kept,
1156 so several calls to this command can be stacked.
1160 For frequently used sparse trees of specific search strings, you can
1161 use the variable @code{org-agenda-custom-commands} to define fast
1162 keyboard access to specific sparse trees. These commands will then be
1163 accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
1167 (setq org-agenda-custom-commands
1168 '(("f" occur-tree "FIXME")))
1171 @noindent will define the key @kbd{C-c a f} as a shortcut for creating
1172 a sparse tree matching the string @samp{FIXME}.
1174 The other sparse tree commands select headings based on TODO keywords,
1175 tags, or properties and will be discussed later in this manual.
1178 @cindex printing sparse trees
1179 @cindex visible text, printing
1180 To print a sparse tree, you can use the Emacs command
1181 @code{ps-print-buffer-with-faces} which does not print invisible parts
1182 of the document @footnote{This does not work under XEmacs, because
1183 XEmacs uses selective display for outlining, not text properties.}.
1184 Or you can use the command @kbd{C-c C-e v} to export only the visible
1185 part of the document and print the resulting file.
1187 @node Plain lists, Drawers, Sparse trees, Document Structure
1188 @section Plain lists
1190 @cindex lists, plain
1191 @cindex lists, ordered
1192 @cindex ordered lists
1194 Within an entry of the outline tree, hand-formatted lists can provide
1195 additional structure. They also provide a way to create lists of
1196 checkboxes (@pxref{Checkboxes}). Org supports editing such lists,
1197 and the HTML exporter (@pxref{Exporting}) parses and formats them.
1199 Org knows ordered lists, unordered lists, and description lists.
1202 @emph{Unordered} list items start with @samp{-}, @samp{+}, or
1203 @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
1204 they will be seen as top-level headlines. Also, when you are hiding leading
1205 stars to get a clean outline view, plain list items starting with a star are
1206 visually indistinguishable from true headlines. In short: even though
1207 @samp{*} is supported, it may be better to not use it for plain list items.}
1210 @emph{Ordered} list items start with a numeral followed by either a period or
1211 a right parenthesis, such as @samp{1.} or @samp{1)}.
1213 @emph{Description} list items are like unordered list items, but contain the
1214 separator @samp{ :: } to separate the description @emph{term} from the
1218 Items belonging to the same list must have the same indentation on the first
1219 line. In particular, if an ordered list reaches number @samp{10.}, then the
1220 2--digit numbers must be written left-aligned with the other numbers in the
1221 list. Indentation also determines the end of a list item. It ends before
1222 the next line that is indented like the bullet/number, or less. Empty lines
1223 are part of the previous item, so you can have several paragraphs in one
1224 item. If you would like an empty line to terminate all currently open plain
1225 lists, configure the variable @code{org-empty-line-terminates-plain-lists}.
1230 ** Lord of the Rings
1231 My favorite scenes are (in this order)
1232 1. The attack of the Rohirrim
1233 2. Eowyns fight with the witch king
1234 + this was already my favorite scene in the book
1235 + I really like Miranda Otto.
1236 3. Peter Jackson being shot by Legolas
1238 He makes a really funny face when it happens.
1239 But in the end, not individual scenes matter but the film as a whole.
1240 Important actors in this film are:
1241 - @b{Elijah Wood} :: He plays the Frodo
1242 - @b{Sean Austin} :: He plays the Sam, Frodos friend. I still remember
1243 him very well from his role as Mikey Walsh a in the Goonies.
1247 Org supports these lists by tuning filling and wrapping commands to
1248 deal with them correctly@footnote{Org only changes the filling
1249 settings for Emacs. For XEmacs, you should use Kyle E. Jones'
1250 @file{filladapt.el}. To turn this on, put into @file{.emacs}:
1251 @code{(require 'filladapt)}}, and by exporting them properly
1252 (@pxref{Exporting}).
1254 The following commands act on items when the cursor is in the first line
1255 of an item (the line with the bullet or number).
1260 Items can be folded just like headline levels if you set the variable
1261 @code{org-cycle-include-plain-lists}. The level of an item is then
1262 given by the indentation of the bullet/number. Items are always
1263 subordinate to real headlines, however; the hierarchies remain
1264 completely separated.
1266 If @code{org-cycle-include-plain-lists} has not been set, @key{TAB}
1267 fixes the indentation of the current line in a heuristic way.
1270 Insert new item at current level. With a prefix argument, force a new
1271 heading (@pxref{Structure editing}). If this command is used in the middle
1272 of a line, the line is @emph{split} and the rest of the line becomes the new
1273 item@footnote{If you do not want the line to be split, customize the variable
1274 @code{org-M-RET-may-split-line}.}. If this command is executed in the
1275 @emph{whitespace before a bullet or number}, the new item is created
1276 @emph{before} the current item. If the command is executed in the white
1277 space before the text that is part of an item but does not contain the
1278 bullet, a bullet is added to the current line.
1279 @kindex M-S-@key{RET}
1281 Insert a new item with a checkbox (@pxref{Checkboxes}).
1283 @kindex S-@key{down}
1286 Jump to the previous/next item in the current list.
1287 @kindex M-S-@key{up}
1288 @kindex M-S-@key{down}
1290 @itemx M-S-@key{down}
1291 Move the item including subitems up/down (swap with previous/next item
1292 of same indentation). If the list is ordered, renumbering is
1294 @kindex M-S-@key{left}
1295 @kindex M-S-@key{right}
1296 @item M-S-@key{left}
1297 @itemx M-S-@key{right}
1298 Decrease/increase the indentation of the item, including subitems.
1299 Initially, the item tree is selected based on current indentation.
1300 When these commands are executed several times in direct succession,
1301 the initially selected region is used, even if the new indentation
1302 would imply a different hierarchy. To use the new hierarchy, break
1303 the command chain with a cursor motion or so.
1306 If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
1307 state of the checkbox. If not, this command makes sure that all the
1308 items on this list level use the same bullet. Furthermore, if this is
1309 an ordered list, make sure the numbering is OK.
1312 Cycle the entire list level through the different itemize/enumerate bullets
1313 (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}). With a numeric prefix
1314 argument N, select the Nth bullet from this list. If there is an active
1315 region when calling this, all lines will be converted to list items. If the
1316 first line already was a list item, any item markers will be removed from the
1317 list. Finally, even without an active region, a normal line will be
1318 converted into a list item.
1321 @node Drawers, Orgstruct mode, Plain lists, Document Structure
1324 @cindex visibility cycling, drawers
1326 Sometimes you want to keep information associated with an entry, but you
1327 normally don't want to see it. For this, Org mode has @emph{drawers}.
1328 Drawers need to be configured with the variable
1329 @code{org-drawers}@footnote{You can define drawers on a per-file basis
1330 with a line like @code{#+DRAWERS: HIDDEN PROPERTIES STATE}}. Drawers
1334 ** This is a headline
1335 Still outside the drawer
1337 This is inside the drawer.
1342 Visibility cycling (@pxref{Visibility cycling}) on the headline will
1343 hide and show the entry, but keep the drawer collapsed to a single line.
1344 In order to look inside the drawer, you need to move the cursor to the
1345 drawer line and press @key{TAB} there. Org mode uses a drawer for
1346 storing properties (@pxref{Properties and Columns}), and another one for
1347 storing clock times (@pxref{Clocking work time}).
1349 @node Orgstruct mode, , Drawers, Document Structure
1350 @section The Orgstruct minor mode
1351 @cindex Orgstruct mode
1352 @cindex minor mode for structure editing
1354 If you like the intuitive way the Org mode structure editing and list
1355 formatting works, you might want to use these commands in other modes
1356 like Text mode or Mail mode as well. The minor mode Orgstruct mode
1357 makes this possible. You can always toggle the mode with @kbd{M-x
1358 orgstruct-mode}. To turn it on by default, for example in Mail mode,
1362 (add-hook 'mail-mode-hook 'turn-on-orgstruct)
1365 When this mode is active and the cursor is on a line that looks to
1366 Org like a headline of the first line of a list item, most
1367 structure editing commands will work, even if the same keys normally
1368 have different functionality in the major mode you are using. If the
1369 cursor is not in one of those special lines, Orgstruct mode lurks
1370 silently in the shadow.
1372 @node Tables, Hyperlinks, Document Structure, Top
1375 @cindex editing tables
1377 Org comes with a fast and intuitive table editor. Spreadsheet-like
1378 calculations are supported in connection with the Emacs @file{calc}
1381 (@pxref{Top,Calc,,Calc,Gnu Emacs Calculator Manual}).
1384 (see the Emacs Calculator manual for more information about the Emacs
1389 * Built-in table editor:: Simple tables
1390 * Narrow columns:: Stop wasting space in tables
1391 * Column groups:: Grouping to trigger vertical lines
1392 * Orgtbl mode:: The table editor as minor mode
1393 * The spreadsheet:: The table editor has spreadsheet capabilities
1394 * Org Plot:: Plotting from org tables
1397 @node Built-in table editor, Narrow columns, Tables, Tables
1398 @section The built-in table editor
1399 @cindex table editor, built-in
1401 Org makes it easy to format tables in plain ASCII. Any line with
1402 @samp{|} as the first non-whitespace character is considered part of a
1403 table. @samp{|} is also the column separator. A table might look like
1407 | Name | Phone | Age |
1408 |-------+-------+-----|
1409 | Peter | 1234 | 17 |
1410 | Anna | 4321 | 25 |
1413 A table is re-aligned automatically each time you press @key{TAB} or
1414 @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to
1415 the next field (@key{RET} to the next row) and creates new table rows
1416 at the end of the table or before horizontal lines. The indentation
1417 of the table is set by the first line. Any line starting with
1418 @samp{|-} is considered as a horizontal separator line and will be
1419 expanded on the next re-align to span the whole table width. So, to
1420 create the above table, you would only type
1427 @noindent and then press @key{TAB} to align the table and start filling in
1430 When typing text into a field, Org treats @key{DEL},
1431 @key{Backspace}, and all character keys in a special way, so that
1432 inserting and deleting avoids shifting other fields. Also, when
1433 typing @emph{immediately after the cursor was moved into a new field
1434 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
1435 field is automatically made blank. If this behavior is too
1436 unpredictable for you, configure the variables
1437 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
1440 @tsubheading{Creation and conversion}
1443 Convert the active region to table. If every line contains at least one
1444 TAB character, the function assumes that the material is tab separated.
1445 If every line contains a comma, comma-separated values (CSV) are assumed.
1446 If not, lines are split at whitespace into fields. You can use a prefix
1447 argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
1448 C-u} forces TAB, and a numeric argument N indicates that at least N
1449 consecutive spaces, or alternatively a TAB will be the separator.
1451 If there is no active region, this command creates an empty Org
1452 table. But it's easier just to start typing, like
1453 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
1455 @tsubheading{Re-aligning and field motion}
1458 Re-align the table without moving the cursor.
1462 Re-align the table, move to the next field. Creates a new row if
1467 Re-align, move to previous field.
1471 Re-align the table and move down to next row. Creates a new row if
1472 necessary. At the beginning or end of a line, @key{RET} still does
1473 NEWLINE, so it can be used to split a table.
1475 @tsubheading{Column and row editing}
1476 @kindex M-@key{left}
1477 @kindex M-@key{right}
1479 @itemx M-@key{right}
1480 Move the current column left/right.
1482 @kindex M-S-@key{left}
1483 @item M-S-@key{left}
1484 Kill the current column.
1486 @kindex M-S-@key{right}
1487 @item M-S-@key{right}
1488 Insert a new column to the left of the cursor position.
1491 @kindex M-@key{down}
1494 Move the current row up/down.
1496 @kindex M-S-@key{up}
1498 Kill the current row or horizontal line.
1500 @kindex M-S-@key{down}
1501 @item M-S-@key{down}
1502 Insert a new row above the current row. With a prefix argument, the line is
1503 created below the current one.
1507 Insert a horizontal line below current row. With a prefix argument, the line
1508 is created above the current line.
1512 Sort the table lines in the region. The position of point indicates the
1513 column to be used for sorting, and the range of lines is the range
1514 between the nearest horizontal separator lines, or the entire table. If
1515 point is before the first column, you will be prompted for the sorting
1516 column. If there is an active region, the mark specifies the first line
1517 and the sorting column, while point should be in the last line to be
1518 included into the sorting. The command prompts for the sorting type
1519 (alphabetically, numerically, or by time). When called with a prefix
1520 argument, alphabetic sorting will be case-sensitive.
1522 @tsubheading{Regions}
1525 Copy a rectangular region from a table to a special clipboard. Point
1526 and mark determine edge fields of the rectangle. The process ignores
1527 horizontal separator lines.
1531 Copy a rectangular region from a table to a special clipboard, and
1532 blank all fields in the rectangle. So this is the ``cut'' operation.
1536 Paste a rectangular region into a table.
1537 The upper left corner ends up in the current field. All involved fields
1538 will be overwritten. If the rectangle does not fit into the present table,
1539 the table is enlarged as needed. The process ignores horizontal separator
1546 Wrap several fields in a column like a paragraph. If there is an active
1547 region, and both point and mark are in the same column, the text in the
1548 column is wrapped to minimum width for the given number of lines. A numeric
1549 prefix argument may be used to change the number of desired lines. If there
1550 is no region, the current field is split at the cursor position and the text
1551 fragment to the right of the cursor is prepended to the field one line
1552 down. If there is no region, but you specify a prefix argument, the current
1553 field is made blank, and the content is appended to the field above.
1555 @tsubheading{Calculations}
1556 @cindex formula, in tables
1557 @cindex calculations, in tables
1558 @cindex region, active
1559 @cindex active region
1560 @cindex Transient mark mode
1563 Sum the numbers in the current column, or in the rectangle defined by
1564 the active region. The result is shown in the echo area and can
1565 be inserted with @kbd{C-y}.
1569 When current field is empty, copy from first non-empty field above. When not
1570 empty, copy current field down to next row and move cursor along with it.
1571 Depending on the variable @code{org-table-copy-increment}, integer field
1572 values will be incremented during copy. Integers that are too large will not
1573 be incremented. Also, a @code{0} prefix argument temporarily dispables the
1574 increment. This key is also used by CUA mode (@pxref{Cooperation}).
1576 @tsubheading{Miscellaneous}
1579 Edit the current field in a separate window. This is useful for fields
1580 that are not fully visible (@pxref{Narrow columns}). When called with a
1581 @kbd{C-u} prefix, just make the full field visible, so that it can be
1584 @item M-x org-table-import
1585 Import a file as a table. The table should be TAB- or whitespace
1586 separated. Useful, for example, to import a spreadsheet table or data
1587 from a database, because these programs generally can write
1588 TAB-separated text files. This command works by inserting the file into
1589 the buffer and then converting the region to a table. Any prefix
1590 argument is passed on to the converter, which uses it to determine the
1593 Tables can also be imported by pasting tabular text into the Org
1594 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
1595 @kbd{C-c |} command (see above under @i{Creation and conversion}).
1597 @item M-x org-table-export
1598 Export the table, by default as a TAB-separated file. Useful for data
1599 exchange with, for example, spreadsheet or database programs. The format
1600 used to export the file can be configured in the variable
1601 @code{org-table-export-default-format}. You may also use properties
1602 @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
1603 name and the format for table export in a subtree. Org supports quite
1604 general formats for exported tables. The exporter format is the same as the
1605 format used by Orgtbl radio tables, see @ref{Translator functions} for a
1606 detailed description.
1609 If you don't like the automatic table editor because it gets in your
1610 way on lines which you would like to start with @samp{|}, you can turn
1614 (setq org-enable-table-editor nil)
1617 @noindent Then the only table command that still works is
1618 @kbd{C-c C-c} to do a manual re-align.
1620 @node Narrow columns, Column groups, Built-in table editor, Tables
1621 @section Narrow columns
1622 @cindex narrow columns in tables
1624 The width of columns is automatically determined by the table editor.
1625 Sometimes a single field or a few fields need to carry more text,
1626 leading to inconveniently wide columns. To limit@footnote{This feature
1627 does not work on XEmacs.} the width of a column, one field anywhere in
1628 the column may contain just the string @samp{<N>} where @samp{N} is an
1629 integer specifying the width of the column in characters. The next
1630 re-align will then set the width of this column to no more than this
1635 |---+------------------------------| |---+--------|
1637 | 1 | one | | 1 | one |
1638 | 2 | two | ----\ | 2 | two |
1639 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
1640 | 4 | four | | 4 | four |
1641 |---+------------------------------| |---+--------|
1646 Fields that are wider become clipped and end in the string @samp{=>}.
1647 Note that the full text is still in the buffer, it is only invisible.
1648 To see the full text, hold the mouse over the field - a tool-tip window
1649 will show the full content. To edit such a field, use the command
1650 @kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will
1651 open a new window with the full field. Edit it and finish with @kbd{C-c
1654 When visiting a file containing a table with narrowed columns, the
1655 necessary character hiding has not yet happened, and the table needs to
1656 be aligned before it looks nice. Setting the option
1657 @code{org-startup-align-all-tables} will realign all tables in a file
1658 upon visiting, but also slow down startup. You can also set this option
1659 on a per-file basis with:
1666 @node Column groups, Orgtbl mode, Narrow columns, Tables
1667 @section Column groups
1668 @cindex grouping columns in tables
1670 When Org exports tables, it does so by default without vertical
1671 lines because that is visually more satisfying in general. Occasionally
1672 however, vertical lines can be useful to structure a table into groups
1673 of columns, much like horizontal lines can do for groups of rows. In
1674 order to specify column groups, you can use a special row where the
1675 first field contains only @samp{/}. The further fields can either
1676 contain @samp{<} to indicate that this column should start a group,
1677 @samp{>} to indicate the end of a column, or @samp{<>} to make a column
1678 a group of its own. Boundaries between column groups will upon export be
1679 marked with vertical lines. Here is an example:
1682 | | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
1683 |---+----+-----+-----+-----+---------+------------|
1684 | / | <> | < | | > | < | > |
1685 | # | 1 | 1 | 1 | 1 | 1 | 1 |
1686 | # | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
1687 | # | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
1688 |---+----+-----+-----+-----+---------+------------|
1689 #+TBLFM: $3=$2^2::$4=$2^3::$5=$2^4::$6=sqrt($2)::$7=sqrt(sqrt(($2)))
1692 It is also sufficient to just insert the column group starters after
1693 every vertical line you'd like to have:
1696 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
1697 |----+-----+-----+-----+---------+------------|
1701 @node Orgtbl mode, The spreadsheet, Column groups, Tables
1702 @section The Orgtbl minor mode
1704 @cindex minor mode for tables
1706 If you like the intuitive way the Org table editor works, you
1707 might also want to use it in other modes like Text mode or Mail mode.
1708 The minor mode Orgtbl mode makes this possible. You can always toggle
1709 the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for
1710 example in mail mode, use
1713 (add-hook 'mail-mode-hook 'turn-on-orgtbl)
1716 Furthermore, with some special setup, it is possible to maintain tables
1717 in arbitrary syntax with Orgtbl mode. For example, it is possible to
1718 construct La@TeX{} tables with the underlying ease and power of
1719 Orgtbl mode, including spreadsheet capabilities. For details, see
1720 @ref{Tables in arbitrary syntax}.
1722 @node The spreadsheet, Org Plot, Orgtbl mode, Tables
1723 @section The spreadsheet
1724 @cindex calculations, in tables
1725 @cindex spreadsheet capabilities
1726 @cindex @file{calc} package
1728 The table editor makes use of the Emacs @file{calc} package to implement
1729 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
1730 derive fields from other fields. While fully featured, Org's
1731 implementation is not identical to other spreadsheets. For example,
1732 Org knows the concept of a @emph{column formula} that will be
1733 applied to all non-header fields in a column without having to copy the
1734 formula to each relevant field.
1737 * References:: How to refer to another field or range
1738 * Formula syntax for Calc:: Using Calc to compute stuff
1739 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
1740 * Field formulas:: Formulas valid for a single field
1741 * Column formulas:: Formulas valid for an entire column
1742 * Editing and debugging formulas:: Fixing formulas
1743 * Updating the table:: Recomputing all dependent fields
1744 * Advanced features:: Field names, parameters and automatic recalc
1747 @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet
1748 @subsection References
1751 To compute fields in the table from other fields, formulas must
1752 reference other fields or ranges. In Org, fields can be referenced
1753 by name, by absolute coordinates, and by relative coordinates. To find
1754 out what the coordinates of a field are, press @kbd{C-c ?} in that
1755 field, or press @kbd{C-c @}} to toggle the display of a grid.
1757 @subsubheading Field references
1758 @cindex field references
1759 @cindex references, to fields
1761 Formulas can reference the value of another field in two ways. Like in
1762 any other spreadsheet, you may reference fields with a letter/number
1763 combination like @code{B3}, meaning the 2nd field in the 3rd row.
1764 @c Such references are always fixed to that field, they don't change
1765 @c when you copy and paste a formula to a different field. So
1766 @c Org's @code{B3} behaves like @code{$B$3} in other spreadsheets.
1769 Org also uses another, more general operator that looks like this:
1775 Column references can be absolute like @samp{1}, @samp{2},...@samp{N},
1776 or relative to the current column like @samp{+1} or @samp{-2}.
1778 The row specification only counts data lines and ignores horizontal
1779 separator lines (hlines). You can use absolute row numbers
1780 @samp{1}...@samp{N}, and row numbers relative to the current row like
1781 @samp{+3} or @samp{-1}. Or specify the row relative to one of the
1782 hlines: @samp{I} refers to the first hline@footnote{Note that only
1783 hlines are counted that @emph{separate} table lines. If the table
1784 starts with a hline above the header, it does not count.}, @samp{II} to
1785 the second etc. @samp{-I} refers to the first such line above the
1786 current line, @samp{+I} to the first such line below the current line.
1787 You can also write @samp{III+2} which is the second data line after the
1788 third hline in the table. Relative row numbers like @samp{-3} will not
1789 cross hlines if the current line is too close to the hline. Instead,
1790 the value directly at the hline is used.
1792 @samp{0} refers to the current row and column. Also, if you omit
1793 either the column or the row part of the reference, the current
1794 row/column is implied.
1796 Org's references with @emph{unsigned} numbers are fixed references
1797 in the sense that if you use the same reference in the formula for two
1798 different fields, the same field will be referenced each time.
1799 Org's references with @emph{signed} numbers are floating
1800 references because the same reference operator can reference different
1801 fields depending on the field being calculated by the formula.
1803 Here are a few examples:
1806 @@2$3 @r{2nd row, 3rd column}
1807 C2 @r{same as previous}
1808 $5 @r{column 5 in the current row}
1809 E& @r{same as previous}
1810 @@2 @r{current column, row 2}
1811 @@-1$-3 @r{the field one row up, three columns to the left}
1812 @@-I$2 @r{field just under hline above current row, column 2}
1815 @subsubheading Range references
1816 @cindex range references
1817 @cindex references, to ranges
1819 You may reference a rectangular range of fields by specifying two field
1820 references connected by two dots @samp{..}. If both fields are in the
1821 current row, you may simply use @samp{$2..$7}, but if at least one field
1822 is in a different row, you need to use the general @code{@@row$column}
1823 format at least for the first field (i.e the reference must start with
1824 @samp{@@} in order to be interpreted correctly). Examples:
1827 $1..$3 @r{First three fields in the current row.}
1828 $P..$Q @r{Range, using column names (see under Advanced)}
1829 @@2$1..@@4$3 @r{6 fields between these two fields.}
1830 A2..C4 @r{Same as above.}
1831 @@-1$-2..@@-1 @r{3 numbers from the column to the left, 2 up to current row}
1834 @noindent Range references return a vector of values that can be fed
1835 into Calc vector functions. Empty fields in ranges are normally
1836 suppressed, so that the vector contains only the non-empty fields (but
1837 see the @samp{E} mode switch below). If there are no non-empty fields,
1838 @samp{[0]} is returned to avoid syntax errors in formulas.
1840 @subsubheading Named references
1841 @cindex named references
1842 @cindex references, named
1843 @cindex name, of column or field
1844 @cindex constants, in calculations
1846 @samp{$name} is interpreted as the name of a column, parameter or
1847 constant. Constants are defined globally through the variable
1848 @code{org-table-formula-constants}, and locally (for the file) through a
1852 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
1856 Also properties (@pxref{Properties and Columns}) can be used as
1857 constants in table formulas: For a property @samp{:Xyz:} use the name
1858 @samp{$PROP_Xyz}, and the property will be searched in the current
1859 outline entry and in the hierarchy above it. If you have the
1860 @file{constants.el} package, it will also be used to resolve constants,
1861 including natural constants like @samp{$h} for Planck's constant, and
1862 units like @samp{$km} for kilometers@footnote{@file{Constant.el} can
1863 supply the values of constants in two different unit systems, @code{SI}
1864 and @code{cgs}. Which one is used depends on the value of the variable
1865 @code{constants-unit-system}. You can use the @code{#+STARTUP} options
1866 @code{constSI} and @code{constcgs} to set this value for the current
1867 buffer.}. Column names and parameters can be specified in special table
1868 lines. These are described below, see @ref{Advanced features}. All
1869 names must start with a letter, and further consist of letters and
1872 @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet
1873 @subsection Formula syntax for Calc
1874 @cindex formula syntax, Calc
1875 @cindex syntax, of formulas
1877 A formula can be any algebraic expression understood by the Emacs
1878 @file{Calc} package. @b{Note that @file{calc} has the
1879 non-standard convention that @samp{/} has lower precedence than
1880 @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.} Before
1881 evaluation by @code{calc-eval} (@pxref{Calling Calc from
1882 Your Programs,calc-eval,Calling Calc from Your Lisp Programs,Calc,GNU
1883 Emacs Calc Manual}),
1884 @c FIXME: The link to the Calc manual in HTML does not work.
1885 variable substitution takes place according to the rules described above.
1886 @cindex vectors, in table calculations
1887 The range vectors can be directly fed into the Calc vector functions
1888 like @samp{vmean} and @samp{vsum}.
1890 @cindex format specifier
1891 @cindex mode, for @file{calc}
1892 A formula can contain an optional mode string after a semicolon. This
1893 string consists of flags to influence Calc and other modes during
1894 execution. By default, Org uses the standard Calc modes (precision
1895 12, angular units degrees, fraction and symbolic modes off). The display
1896 format, however, has been changed to @code{(float 5)} to keep tables
1897 compact. The default settings can be configured using the variable
1898 @code{org-calc-default-modes}.
1901 p20 @r{switch the internal precision to 20 digits}
1902 n3 s3 e2 f4 @r{normal, scientific, engineering, or fixed display format}
1903 D R @r{angle modes: degrees, radians}
1904 F S @r{fraction and symbolic modes}
1905 N @r{interpret all fields as numbers, use 0 for non-numbers}
1906 T @r{force text interpretation}
1907 E @r{keep empty fields in ranges}
1911 In addition, you may provide a @code{printf} format specifier to
1912 reformat the final result. A few examples:
1915 $1+$2 @r{Sum of first and second field}
1916 $1+$2;%.2f @r{Same, format result to two decimals}
1917 exp($2)+exp($1) @r{Math functions can be used}
1918 $0;%.1f @r{Reformat current cell to 1 decimal}
1919 ($3-32)*5/9 @r{Degrees F -> C conversion}
1920 $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}}
1921 tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1}
1922 sin($1);Dp3%.1e @r{Same, but use printf specifier for display}
1923 vmean($2..$7) @r{Compute column range mean, using vector function}
1924 vmean($2..$7);EN @r{Same, but treat empty fields as 0}
1925 taylor($3,x=7,2) @r{taylor series of $3, at x=7, second degree}
1928 Calc also contains a complete set of logical operations. For example
1931 if($1<20,teen,string("")) @r{``teen'' if age $1 less than 20, else empty}
1934 @node Formula syntax for Lisp, Field formulas, Formula syntax for Calc, The spreadsheet
1935 @subsection Emacs Lisp forms as formulas
1936 @cindex Lisp forms, as table formulas
1938 It is also possible to write a formula in Emacs Lisp; this can be useful
1939 for string manipulation and control structures, if the Calc's
1940 functionality is not enough. If a formula starts with a single quote
1941 followed by an opening parenthesis, then it is evaluated as a lisp form.
1942 The evaluation should return either a string or a number. Just as with
1943 @file{calc} formulas, you can specify modes and a printf format after a
1944 semicolon. With Emacs Lisp forms, you need to be conscious about the way
1945 field references are interpolated into the form. By default, a
1946 reference will be interpolated as a Lisp string (in double quotes)
1947 containing the field. If you provide the @samp{N} mode switch, all
1948 referenced elements will be numbers (non-number fields will be zero) and
1949 interpolated as Lisp numbers, without quotes. If you provide the
1950 @samp{L} flag, all fields will be interpolated literally, without quotes.
1951 I.e., if you want a reference to be interpreted as a string by the Lisp
1952 form, enclose the reference operator itself in double quotes, like
1953 @code{"$3"}. Ranges are inserted as space-separated fields, so you can
1954 embed them in list or vector syntax. A few examples, note how the
1955 @samp{N} mode is used when we do computations in lisp.
1958 @r{Swap the first two characters of the content of column 1}
1959 '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
1960 @r{Add columns 1 and 2, equivalent to the Calc's @code{$1+$2}}
1962 @r{Compute the sum of columns 1-4, like Calc's @code{vsum($1..$4)}}
1963 '(apply '+ '($1..$4));N
1966 @node Field formulas, Column formulas, Formula syntax for Lisp, The spreadsheet
1967 @subsection Field formulas
1968 @cindex field formula
1969 @cindex formula, for individual table field
1971 To assign a formula to a particular field, type it directly into the
1972 field, preceded by @samp{:=}, for example @samp{:=$1+$2}. When you
1973 press @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in
1974 the field, the formula will be stored as the formula for this field,
1975 evaluated, and the current field replaced with the result.
1977 Formulas are stored in a special line starting with @samp{#+TBLFM:}
1978 directly below the table. If you typed the equation in the 4th field of
1979 the 3rd data line in the table, the formula will look like
1980 @samp{@@3$4=$1+$2}. When inserting/deleting/swapping column and rows
1981 with the appropriate commands, @i{absolute references} (but not relative
1982 ones) in stored formulas are modified in order to still reference the
1983 same field. Of cause this is not true if you edit the table structure
1984 with normal editing commands - then you must fix the equations yourself.
1986 Instead of typing an equation into the field, you may also use the
1992 Install a new formula for the current field. The command prompts for a
1993 formula, with default taken from the @samp{#+TBLFM:} line, applies
1994 it to the current field and stores it.
1997 @node Column formulas, Editing and debugging formulas, Field formulas, The spreadsheet
1998 @subsection Column formulas
1999 @cindex column formula
2000 @cindex formula, for table column
2002 Often in a table, the same formula should be used for all fields in a
2003 particular column. Instead of having to copy the formula to all fields
2004 in that column, Org allows to assign a single formula to an entire
2005 column. If the table contains horizontal separator hlines, everything
2006 before the first such line is considered part of the table @emph{header}
2007 and will not be modified by column formulas.
2009 To assign a formula to a column, type it directly into any field in the
2010 column, preceded by an equal sign, like @samp{=$1+$2}. When you press
2011 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the
2012 field, the formula will be stored as the formula for the current column,
2013 evaluated and the current field replaced with the result. If the field
2014 contains only @samp{=}, the previously stored formula for this column is
2015 used. For each column, Org will only remember the most recently
2016 used formula. In the @samp{TBLFM:} line, column formulas will look like
2019 Instead of typing an equation into the field, you may also use the
2025 Install a new formula for the current column and replace current field with
2026 the result of the formula. The command prompts for a formula, with default
2027 taken from the @samp{#+TBLFM} line, applies it to the current field and
2028 stores it. With a numeric prefix argument(e.g. @kbd{C-5 C-c =}) the command
2029 will apply it to that many consecutive fields in the current column.
2032 @node Editing and debugging formulas, Updating the table, Column formulas, The spreadsheet
2033 @subsection Editing and debugging formulas
2034 @cindex formula editing
2035 @cindex editing, of table formulas
2037 You can edit individual formulas in the minibuffer or directly in the
2038 field. Org can also prepare a special buffer with all active
2039 formulas of a table. When offering a formula for editing, Org
2040 converts references to the standard format (like @code{B3} or @code{D&})
2041 if possible. If you prefer to only work with the internal format (like
2042 @code{@@3$2} or @code{$4}), configure the variable
2043 @code{org-table-use-standard-references}.
2050 Edit the formula associated with the current column/field in the
2051 minibuffer. See @ref{Column formulas} and @ref{Field formulas}.
2052 @kindex C-u C-u C-c =
2054 Re-insert the active formula (either a
2055 field formula, or a column formula) into the current field, so that you
2056 can edit it directly in the field. The advantage over editing in the
2057 minibuffer is that you can use the command @kbd{C-c ?}.
2060 While editing a formula in a table field, highlight the field(s)
2061 referenced by the reference at the cursor position in the formula.
2064 Toggle the display of row and column numbers for a table, using
2065 overlays. These are updated each time the table is aligned, you can
2066 force it with @kbd{C-c C-c}.
2069 Toggle the formula debugger on and off. See below.
2072 Edit all formulas for the current table in a special buffer, where the
2073 formulas will be displayed one per line. If the current field has an
2074 active formula, the cursor in the formula editor will mark it.
2075 While inside the special buffer, Org will automatically highlight
2076 any field or range reference at the cursor position. You may edit,
2077 remove and add formulas, and use the following commands:
2083 Exit the formula editor and store the modified formulas. With @kbd{C-u}
2084 prefix, also apply the new formulas to the entire table.
2087 Exit the formula editor without installing changes.
2090 Toggle all references in the formula editor between standard (like
2091 @code{B3}) and internal (like @code{@@3$2}).
2094 Pretty-print or indent lisp formula at point. When in a line containing
2095 a lisp formula, format the formula according to Emacs Lisp rules.
2096 Another @key{TAB} collapses the formula back again. In the open
2097 formula, @key{TAB} re-indents just like in Emacs lisp mode.
2100 Complete Lisp symbols, just like in Emacs lisp mode.
2102 @kindex S-@key{down}
2103 @kindex S-@key{left}
2104 @kindex S-@key{right}
2105 @item S-@key{up}/@key{down}/@key{left}/@key{right}
2106 Shift the reference at point. For example, if the reference is
2107 @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
2108 This also works for relative references, and for hline references.
2109 @kindex M-S-@key{up}
2110 @kindex M-S-@key{down}
2111 @item M-S-@key{up}/@key{down}
2112 Move the test line for column formulas in the Org buffer up and
2115 @kindex M-@key{down}
2116 @item M-@key{up}/@key{down}
2117 Scroll the window displaying the table.
2120 Turn the coordinate grid in the table on and off.
2124 Making a table field blank does not remove the formula associated with
2125 the field, because that is stored in a different line (the @samp{TBLFM}
2126 line) - during the next recalculation the field will be filled again.
2127 To remove a formula from a field, you have to give an empty reply when
2128 prompted for the formula, or to edit the @samp{#+TBLFM} line.
2131 You may edit the @samp{#+TBLFM} directly and re-apply the changed
2132 equations with @kbd{C-c C-c} in that line, or with the normal
2133 recalculation commands in the table.
2135 @subsubheading Debugging formulas
2136 @cindex formula debugging
2137 @cindex debugging, of table formulas
2138 When the evaluation of a formula leads to an error, the field content
2139 becomes the string @samp{#ERROR}. If you would like see what is going
2140 on during variable substitution and calculation in order to find a bug,
2141 turn on formula debugging in the @code{Tbl} menu and repeat the
2142 calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
2143 field. Detailed information will be displayed.
2145 @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet
2146 @subsection Updating the table
2147 @cindex recomputing table fields
2148 @cindex updating, table
2150 Recalculation of a table is normally not automatic, but needs to be
2151 triggered by a command. See @ref{Advanced features} for a way to make
2152 recalculation at least semi-automatically.
2154 In order to recalculate a line of a table or the entire table, use the
2160 Recalculate the current row by first applying the stored column formulas
2161 from left to right, and all field formulas in the current row.
2167 Recompute the entire table, line by line. Any lines before the first
2168 hline are left alone, assuming that these are part of the table header.
2170 @kindex C-u C-u C-c *
2171 @kindex C-u C-u C-c C-c
2173 @itemx C-u C-u C-c C-c
2174 Iterate the table by recomputing it until no further changes occur.
2175 This may be necessary if some computed fields use the value of other
2176 fields that are computed @i{later} in the calculation sequence.
2179 @node Advanced features, , Updating the table, The spreadsheet
2180 @subsection Advanced features
2182 If you want the recalculation of fields to happen automatically, or if
2183 you want to be able to assign @i{names} to fields and columns, you need
2184 to reserve the first column of the table for special marking characters.
2188 Rotate the calculation mark in first column through the states @samp{},
2189 @samp{#}, @samp{*}, @samp{!}, @samp{$}. When there is an active region,
2190 change all marks in the region.
2193 Here is an example of a table that collects exam results of students and
2194 makes use of these features:
2198 |---+---------+--------+--------+--------+-------+------|
2199 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
2200 |---+---------+--------+--------+--------+-------+------|
2201 | ! | | P1 | P2 | P3 | Tot | |
2202 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
2203 | ^ | | m1 | m2 | m3 | mt | |
2204 |---+---------+--------+--------+--------+-------+------|
2205 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
2206 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
2207 |---+---------+--------+--------+--------+-------+------|
2208 | | Average | | | | 29.7 | |
2209 | ^ | | | | | at | |
2210 | $ | max=50 | | | | | |
2211 |---+---------+--------+--------+--------+-------+------|
2212 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
2216 @noindent @b{Important}: Please note that for these special tables,
2217 recalculating the table with @kbd{C-u C-c *} will only affect rows that
2218 are marked @samp{#} or @samp{*}, and fields that have a formula assigned
2219 to the field itself. The column formulas are not applied in rows with
2222 @cindex marking characters, tables
2223 The marking characters have the following meaning:
2226 The fields in this line define names for the columns, so that you may
2227 refer to a column as @samp{$Tot} instead of @samp{$6}.
2229 This row defines names for the fields @emph{above} the row. With such
2230 a definition, any formula in the table may use @samp{$m1} to refer to
2231 the value @samp{10}. Also, if you assign a formula to a names field, it
2232 will be stored as @samp{$name=...}.
2234 Similar to @samp{^}, but defines names for the fields in the row
2237 Fields in this row can define @emph{parameters} for formulas. For
2238 example, if a field in a @samp{$} row contains @samp{max=50}, then
2239 formulas in this table can refer to the value 50 using @samp{$max}.
2240 Parameters work exactly like constants, only that they can be defined on
2243 Fields in this row are automatically recalculated when pressing
2244 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row
2245 is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked
2246 lines will be left alone by this command.
2248 Selects this line for global recalculation with @kbd{C-u C-c *}, but
2249 not for automatic recalculation. Use this when automatic
2250 recalculation slows down editing too much.
2252 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
2253 All lines that should be recalculated should be marked with @samp{#}
2256 Do not export this line. Useful for lines that contain the narrowing
2260 Finally, just to whet your appetite on what can be done with the
2261 fantastic @file{calc} package, here is a table that computes the Taylor
2262 series of degree @code{n} at location @code{x} for a couple of
2267 |---+-------------+---+-----+--------------------------------------|
2268 | | Func | n | x | Result |
2269 |---+-------------+---+-----+--------------------------------------|
2270 | # | exp(x) | 1 | x | 1 + x |
2271 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
2272 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
2273 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
2274 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
2275 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
2276 |---+-------------+---+-----+--------------------------------------|
2277 #+TBLFM: $5=taylor($2,$4,$3);n3
2282 @node Org Plot, , The spreadsheet, Tables
2284 @cindex graph, in tables
2285 @cindex plot tables using gnuplot
2287 Org Plot can produce 2D and 3D graphs of information stored in org tables
2288 using @file{Gnuplot} @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
2289 @uref{http://cars9.uchicago.edu/~ravel/software/gnuplot-mode.html}. To see
2290 this in action ensure that you have both Gnuplot and Gnuplot-mode installed
2291 on your system, then call @code{org-plot/gnuplot} on the following table.
2295 #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
2296 | Sede | Max cites | H-index |
2297 |-----------+-----------+---------|
2298 | Chile | 257.72 | 21.39 |
2299 | Leeds | 165.77 | 19.68 |
2300 | Sao Paolo | 71.00 | 11.50 |
2301 | Stockholm | 134.19 | 14.33 |
2302 | Morelia | 257.56 | 17.67 |
2306 Notice that Org Plot is smart enough to apply the tables headers as labels.
2307 Further control over the labels, type, content, and appearance of plots can
2308 be exercised through the @code{#+Plot:} lines preceding a table. See below
2309 for a complete list of Org plot options. For more information and examples
2310 see the org-plot tutorial at
2311 @uref{http://legito.org/worg/org-tutorials/org-plot.php}.
2313 @subsubheading Plot Options
2317 Specify any @file{gnuplot} option to be set when graphing.
2320 Specify the title of the plot.
2323 Specify which column of the table to use as the @code{x} axis.
2326 Specify the columns to graph as a lisp style list, surrounded by parenthesis
2327 and separated by spaces for example @code{dep:(3 4)} to graph the third and
2328 fourth columns (defaults to graphing all other columns aside from the ind
2332 Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
2335 Specify a @code{with} option to be inserted for every col being plotted
2336 (e.g. @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
2337 Defaults to 'lines'.
2340 If you want to plot to a file specify the @code{"path/to/desired/output-file"}.
2343 List of labels to be used for the deps (defaults to column headers if they
2347 Specify an entire line to be inserted in the gnuplot script.
2350 When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
2351 flat mapping rather than a @code{3d} slope.
2354 Specify format of org-mode timestamps as they will be parsed by gnuplot.
2355 Defaults to '%Y-%m-%d-%H:%M:%S'.
2358 If you want total control you can specify a script file (place the file name
2359 between double quotes) which will be used to plot. Before plotting, every
2360 instance of @code{$datafile} in the specified script will be replaced with
2361 the path to the generated data file. Note even if you set this option you
2362 may still want to specify the plot type, as that can impact the content of
2366 @node Hyperlinks, TODO Items, Tables, Top
2370 Like HTML, Org provides links inside a file, external links to
2371 other files, Usenet articles, emails, and much more.
2374 * Link format:: How links in Org are formatted
2375 * Internal links:: Links to other places in the current file
2376 * External links:: URL-like links to the world
2377 * Handling links:: Creating, inserting and following
2378 * Using links outside Org:: Linking from my C source code?
2379 * Link abbreviations:: Shortcuts for writing complex links
2380 * Search options:: Linking to a specific location
2381 * Custom searches:: When the default search is not enough
2384 @node Link format, Internal links, Hyperlinks, Hyperlinks
2385 @section Link format
2387 @cindex format, of links
2389 Org will recognize plain URL-like links and activate them as
2390 clickable links. The general link format, however, looks like this:
2393 [[link][description]] @r{or alternatively} [[link]]
2396 Once a link in the buffer is complete (all brackets present), Org
2397 will change the display so that @samp{description} is displayed instead
2398 of @samp{[[link][description]]} and @samp{link} is displayed instead of
2399 @samp{[[link]]}. Links will be highlighted in the face @code{org-link},
2400 which by default is an underlined face. You can directly edit the
2401 visible part of a link. Note that this can be either the @samp{link}
2402 part (if there is no description) or the @samp{description} part. To
2403 edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
2406 If you place the cursor at the beginning or just behind the end of the
2407 displayed text and press @key{BACKSPACE}, you will remove the
2408 (invisible) bracket at that location. This makes the link incomplete
2409 and the internals are again displayed as plain text. Inserting the
2410 missing bracket hides the link internals again. To show the
2411 internal structure of all links, use the menu entry
2412 @code{Org->Hyperlinks->Literal links}.
2414 @node Internal links, External links, Link format, Hyperlinks
2415 @section Internal links
2416 @cindex internal links
2417 @cindex links, internal
2418 @cindex targets, for links
2420 If the link does not look like a URL, it is considered to be internal in
2421 the current file. Links such as @samp{[[My Target]]} or @samp{[[My
2422 Target][Find my target]]} lead to a text search in the current file.
2423 The link can be followed with @kbd{C-c C-o} when the cursor is on the
2424 link, or with a mouse click (@pxref{Handling links}). The preferred
2425 match for such a link is a dedicated target: the same string in double
2426 angular brackets. Targets may be located anywhere; sometimes it is
2427 convenient to put them into a comment line. For example
2433 @noindent In HTML export (@pxref{HTML export}), such targets will become
2434 named anchors for direct access through @samp{http} links@footnote{Note
2435 that text before the first headline is usually not exported, so the
2436 first such target should be after the first headline.}.
2438 If no dedicated target exists, Org will search for the words in the
2439 link. In the above example the search would be for @samp{my target}.
2440 Links starting with a star like @samp{*My Target} restrict the search to
2441 headlines. When searching, Org mode will first try an exact match, but
2442 then move on to more and more lenient searches. For example, the link
2443 @samp{[[*My Targets]]} will find any of the following:
2447 ** TODO my targets are bright
2448 ** my 20 targets are
2451 To insert a link targeting a headline, in-buffer completion can be used.
2452 Just type a star followed by a few optional letters into the buffer and
2453 press @kbd{M-@key{TAB}}. All headlines in the current buffer will be
2454 offered as completions. @xref{Handling links}, for more commands
2457 Following a link pushes a mark onto Org's own mark ring. You can
2458 return to the previous position with @kbd{C-c &}. Using this command
2459 several times in direct succession goes back to positions recorded
2463 * Radio targets:: Make targets trigger links in plain text
2466 @node Radio targets, , Internal links, Internal links
2467 @subsection Radio targets
2468 @cindex radio targets
2469 @cindex targets, radio
2470 @cindex links, radio targets
2472 Org can automatically turn any occurrences of certain target names
2473 in normal text into a link. So without explicitly creating a link, the
2474 text connects to the target radioing its position. Radio targets are
2475 enclosed by triple angular brackets. For example, a target @samp{<<<My
2476 Target>>>} causes each occurrence of @samp{my target} in normal text to
2477 become activated as a link. The Org file is scanned automatically
2478 for radio targets only when the file is first loaded into Emacs. To
2479 update the target list during editing, press @kbd{C-c C-c} with the
2480 cursor on or at a target.
2482 @node External links, Handling links, Internal links, Hyperlinks
2483 @section External links
2484 @cindex links, external
2485 @cindex external links
2486 @cindex links, external
2494 @cindex WANDERLUST links
2496 @cindex USENET links
2501 Org supports links to files, websites, Usenet and email messages,
2502 BBDB database entries and links to both IRC conversations and their
2503 logs. External links are URL-like locators. They start with a short
2504 identifying string followed by a colon. There can be no space after
2505 the colon. The following list shows examples for each link type.
2508 http://www.astro.uva.nl/~dominik @r{on the web}
2509 file:/home/dominik/images/jupiter.jpg @r{file, absolute path}
2510 /home/dominik/images/jupiter.jpg @r{same as above}
2511 file:papers/last.pdf @r{file, relative path}
2512 ./papers/last.pdf @r{same as above}
2513 news:comp.emacs @r{Usenet link}
2514 mailto:adent@@galaxy.net @r{Mail link}
2515 vm:folder @r{VM folder link}
2516 vm:folder#id @r{VM message link}
2517 vm://myself@@some.where.org/folder#id @r{VM on remote machine}
2518 wl:folder @r{WANDERLUST folder link}
2519 wl:folder#id @r{WANDERLUST message link}
2520 mhe:folder @r{MH-E folder link}
2521 mhe:folder#id @r{MH-E message link}
2522 rmail:folder @r{RMAIL folder link}
2523 rmail:folder#id @r{RMAIL message link}
2524 gnus:group @r{Gnus group link}
2525 gnus:group#id @r{Gnus article link}
2526 bbdb:R.*Stallman @r{BBDB link (with regexp)}
2527 irc:/irc.com/#emacs/bob @r{IRC link}
2528 shell:ls *.org @r{A shell command}
2529 elisp:org-agenda @r{Interactive elisp command}
2530 elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
2533 A link should be enclosed in double brackets and may contain a
2534 descriptive text to be displayed instead of the URL (@pxref{Link
2535 format}), for example:
2538 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
2542 If the description is a file name or URL that points to an image, HTML
2543 export (@pxref{HTML export}) will inline the image as a clickable
2544 button. If there is no description at all and the link points to an
2546 that image will be inlined into the exported HTML file.
2548 @cindex angular brackets, around links
2549 @cindex plain text external links
2550 Org also finds external links in the normal text and activates them
2551 as links. If spaces must be part of the link (for example in
2552 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
2553 about the end of the link, enclose them in angular brackets.
2555 @node Handling links, Using links outside Org, External links, Hyperlinks
2556 @section Handling links
2557 @cindex links, handling
2559 Org provides methods to create a link in the correct syntax, to
2560 insert it into an Org file, and to follow the link.
2564 @cindex storing links
2566 Store a link to the current location. This is a @emph{global} command
2567 which can be used in any buffer to create a link. The link will be
2568 stored for later insertion into an Org buffer (see below). For
2569 Org files, if there is a @samp{<<target>>} at the cursor, the
2570 link points to the target. Otherwise it points to the current
2571 headline. For VM, Rmail, Wanderlust, MH-E, Gnus and BBDB buffers, the
2572 link will indicate the current article/entry. For W3 and W3M buffers,
2573 the link goes to the current URL. For IRC links, if you set the
2574 variable @code{org-irc-link-to-logs} to non-nil then @kbd{C-c l} will
2575 store a @samp{file:/} style link to the relevant point in the logs for
2576 the current conversation. Otherwise an @samp{irc:/} style link to the
2577 user/channel/server under the point will be stored. For any other
2578 files, the link will point to the file, with a search string
2579 (@pxref{Search options}) pointing to the contents of the current line.
2580 If there is an active region, the selected words will form the basis
2581 of the search string. If the automatically created link is not
2582 working correctly or accurately enough, you can write custom functions
2583 to select the search string and to do the search for particular file
2584 types - see @ref{Custom searches}. The key binding @kbd{C-c l} is
2585 only a suggestion - see @ref{Installation}.
2588 @cindex link completion
2589 @cindex completion, of links
2590 @cindex inserting links
2592 Insert a link. This prompts for a link to be inserted into the buffer. You
2593 can just type a link, using text for an internal link, or one of the link
2594 type prefixes mentioned in the examples above. All links stored during the
2595 current session are part of the history for this prompt, so you can access
2596 them with @key{up} and @key{down} (or @kbd{M-p/n}). Completion, on the other
2597 hand, will help you to insert valid link prefixes like @samp{http:} or
2598 @samp{ftp:}, including the prefixes defined through link abbreviations
2599 (@pxref{Link abbreviations}). The link will be inserted into the
2600 buffer@footnote{After insertion of a stored link, the link will be removed
2601 from the list of stored links. To keep it in the list later use, use a
2602 triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
2603 @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
2604 If some text was selected when this command is called, the selected text
2605 becomes the default description.@* Note that you don't have to use this
2606 command to insert a link. Links in Org are plain text, and you can type
2607 or paste them straight into the buffer. By using this command, the links are
2608 automatically enclosed in double brackets, and you will be asked for the
2609 optional descriptive text.
2611 @c If the link is a @samp{file:} link and
2612 @c the linked file is located in the same directory as the current file or
2613 @c a subdirectory of it, the path of the file will be inserted relative to
2614 @c the current directory.
2617 @cindex file name completion
2618 @cindex completion, of file names
2620 When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
2621 a file will be inserted and you may use file name completion to select
2622 the name of the file. The path to the file is inserted relative to the
2623 directory of the current org file, if the linked file is in the current
2624 directory or in a sub-directory of it, or if the path is written relative
2625 to the current directory using @samp{../}. Otherwise an absolute path
2626 is used, if possible with @samp{~/} for your home directory. You can
2627 force an absolute path with two @kbd{C-u} prefixes.
2629 @item C-c C-l @r{(with cursor on existing link)}
2630 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
2631 link and description parts of the link.
2633 @cindex following links
2636 Open link at point. This will launch a web browser for URLs (using
2637 @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
2638 the corresponding links, and execute the command in a shell link. When the
2639 cursor is on an internal link, this commands runs the corresponding search.
2640 When the cursor is on a TAG list in a headline, it creates the corresponding
2641 TAGS view. If the cursor is on a time stamp, it compiles the agenda for that
2642 date. Furthermore, it will visit text and remote files in @samp{file:} links
2643 with Emacs and select a suitable application for local non-text files.
2644 Classification of files is based on file extension only. See option
2645 @code{org-file-apps}. If you want to override the default application and
2646 visit the file with Emacs, use a @kbd{C-u} prefix. If you want to avoid
2647 opening in Emacs, use a @kbd{C-u C-u} prefix.
2653 On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
2654 would. Under Emacs 22, also @kbd{mouse-1} will follow a link.
2658 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
2659 internal links to be displayed in another window@footnote{See the
2660 variable @code{org-display-internal-link-with-indirect-buffer}}.
2665 Push the current position onto the mark ring, to be able to return
2666 easily. Commands following an internal link do this automatically.
2668 @cindex links, returning to
2671 Jump back to a recorded position. A position is recorded by the
2672 commands following internal links, and by @kbd{C-c %}. Using this
2673 command several times in direct succession moves through a ring of
2674 previously recorded positions.
2678 @cindex links, finding next/previous
2681 Move forward/backward to the next link in the buffer. At the limit of
2682 the buffer, the search fails once, and then wraps around. The key
2683 bindings for this are really too long, you might want to bind this also
2684 to @kbd{C-n} and @kbd{C-p}
2686 (add-hook 'org-load-hook
2688 (define-key 'org-mode-map "\C-n" 'org-next-link)
2689 (define-key 'org-mode-map "\C-p" 'org-previous-link)))
2693 @node Using links outside Org, Link abbreviations, Handling links, Hyperlinks
2694 @section Using links outside Org
2696 You can insert and follow links that have Org syntax not only in
2697 Org, but in any Emacs buffer. For this, you should create two
2698 global commands, like this (please select suitable global keys
2702 (global-set-key "\C-c L" 'org-insert-link-global)
2703 (global-set-key "\C-c o" 'org-open-at-point-global)
2706 @node Link abbreviations, Search options, Using links outside Org, Hyperlinks
2707 @section Link abbreviations
2708 @cindex link abbreviations
2709 @cindex abbreviation, links
2711 Long URLs can be cumbersome to type, and often many similar links are
2712 needed in a document. For this you can use link abbreviations. An
2713 abbreviated link looks like this
2716 [[linkword:tag][description]]
2720 where the tag is optional. Such abbreviations are resolved according to
2721 the information in the variable @code{org-link-abbrev-alist} that
2722 relates the linkwords to replacement text. Here is an example:
2726 (setq org-link-abbrev-alist
2727 '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
2728 ("google" . "http://www.google.com/search?q=")
2729 ("ads" . "http://adsabs.harvard.edu/cgi-bin/
2730 nph-abs_connect?author=%s&db_key=AST")))
2734 If the replacement text contains the string @samp{%s}, it will be
2735 replaced with the tag. Otherwise the tag will be appended to the string
2736 in order to create the link. You may also specify a function that will
2737 be called with the tag as the only argument to create the link.
2739 With the above setting, you could link to a specific bug with
2740 @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
2741 @code{[[google:OrgMode]]} and find out what the Org author is
2742 doing besides Emacs hacking with @code{[[ads:Dominik,C]]}.
2744 If you need special abbreviations just for a single Org buffer, you
2745 can define them in the file with
2748 #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
2749 #+LINK: google http://www.google.com/search?q=%s
2753 In-buffer completion @pxref{Completion} can be used after @samp{[} to
2754 complete link abbreviations.
2756 @node Search options, Custom searches, Link abbreviations, Hyperlinks
2757 @section Search options in file links
2758 @cindex search option in file links
2759 @cindex file links, searching
2761 File links can contain additional information to make Emacs jump to a
2762 particular location in the file when following a link. This can be a
2763 line number or a search option after a double@footnote{For backward
2764 compatibility, line numbers can also follow a single colon.} colon. For
2765 example, when the command @kbd{C-c l} creates a link (@pxref{Handling
2766 links}) to a file, it encodes the words in the current line as a search
2767 string that can be used to find this line back later when following the
2768 link with @kbd{C-c C-o}.
2770 Here is the syntax of the different ways to attach a search to a file
2771 link, together with an explanation:
2774 [[file:~/code/main.c::255]]
2775 [[file:~/xx.org::My Target]]
2776 [[file:~/xx.org::*My Target]]
2777 [[file:~/xx.org::/regexp/]]
2784 Search for a link target @samp{<<My Target>>}, or do a text search for
2785 @samp{my target}, similar to the search in internal links, see
2786 @ref{Internal links}. In HTML export (@pxref{HTML export}), such a file
2787 link will become an HTML reference to the corresponding named anchor in
2790 In an Org file, restrict search to headlines.
2792 Do a regular expression search for @code{regexp}. This uses the Emacs
2793 command @code{occur} to list all matches in a separate window. If the
2794 target file is in Org mode, @code{org-occur} is used to create a
2795 sparse tree with the matches.
2796 @c If the target file is a directory,
2797 @c @code{grep} will be used to search all files in the directory.
2800 As a degenerate case, a file link with an empty file name can be used
2801 to search the current file. For example, @code{[[file:::find me]]} does
2802 a search for @samp{find me} in the current file, just as
2803 @samp{[[find me]]} would.
2805 @node Custom searches, , Search options, Hyperlinks
2806 @section Custom Searches
2807 @cindex custom search strings
2808 @cindex search strings, custom
2810 The default mechanism for creating search strings and for doing the
2811 actual search related to a file link may not work correctly in all
2812 cases. For example, BibTeX database files have many entries like
2813 @samp{year="1993"} which would not result in good search strings,
2814 because the only unique identification for a BibTeX entry is the
2817 If you come across such a problem, you can write custom functions to set
2818 the right search string for a particular file type, and to do the search
2819 for the string in the file. Using @code{add-hook}, these functions need
2820 to be added to the hook variables
2821 @code{org-create-file-search-functions} and
2822 @code{org-execute-file-search-functions}. See the docstring for these
2823 variables for more information. Org actually uses this mechanism
2824 for Bib@TeX{} database files, and you can use the corresponding code as
2825 an implementation example. See the file @file{org-bibtex.el}.
2827 @node TODO Items, Tags, Hyperlinks, Top
2831 Org mode does not maintain TODO lists as separate documents@footnote{Of
2832 course, you can make a document that contains inly long lists of TODO items,
2833 but this is not required.}. Instead, TODO items are an integral part of the
2834 notes file, because TODO items usually come up while taking notes! With Org
2835 mode, simply mark any entry in a tree as being a TODO item. In this way,
2836 information is not duplicated, and the entire context from which the TODO
2837 item emerged is always present.
2839 Of course, this technique for managing TODO items scatters them
2840 throughout your notes file. Org mode compensates for this by providing
2841 methods to give you an overview of all the things that you have to do.
2844 * TODO basics:: Marking and displaying TODO entries
2845 * TODO extensions:: Workflow and assignments
2846 * Progress logging:: Dates and notes for progress
2847 * Priorities:: Some things are more important than others
2848 * Breaking down tasks:: Splitting a task into manageable pieces
2849 * Checkboxes:: Tick-off lists
2852 @node TODO basics, TODO extensions, TODO Items, TODO Items
2853 @section Basic TODO functionality
2855 Any headline becomes a TODO item when it starts with the word
2856 @samp{TODO}, for example:
2859 *** TODO Write letter to Sam Fortune
2863 The most important commands to work with TODO entries are:
2867 @cindex cycling, of TODO states
2869 Rotate the TODO state of the current item among
2872 ,-> (unmarked) -> TODO -> DONE --.
2873 '--------------------------------'
2876 The same rotation can also be done ``remotely'' from the timeline and
2877 agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}).
2881 Select a specific keyword using completion or (if it has been set up)
2882 the fast selection interface. For the latter, you need to assign keys
2883 to TODO states, see @ref{Per-file keywords} and @ref{Setting tags} for
2886 @kindex S-@key{right}
2887 @kindex S-@key{left}
2890 Select the following/preceding TODO state, similar to cycling. Useful
2891 mostly if more than two TODO states are possible (@pxref{TODO
2895 @cindex sparse tree, for TODO
2898 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds
2899 the entire buffer, but shows all TODO items and the headings hierarchy
2900 above them. With a prefix argument, search for a specific TODO. You will be
2901 prompted for the keyword, and you can also give a list of keywords like
2902 @code{KWD1|KWD2|...}. With numeric prefix argument N, show the tree for the
2903 Nth keyword in the variable @code{org-todo-keywords}. With two prefix
2904 arguments, find all TODO and DONE entries.
2907 Show the global TODO list. Collects the TODO items from all agenda
2908 files (@pxref{Agenda Views}) into a single buffer. The new buffer will
2909 be in @code{agenda-mode}, which provides commands to examine and
2910 manipulate the TODO entries from the new buffer (@pxref{Agenda
2911 commands}). @xref{Global TODO list}, for more information.
2912 @kindex S-M-@key{RET}
2914 Insert a new TODO entry below the current one.
2918 Changing a TODO state can also trigger tag changes. See the docstring of the
2919 option @code{org-todo-state-tags-triggers} for details.
2921 @node TODO extensions, Progress logging, TODO basics, TODO Items
2922 @section Extended use of TODO keywords
2923 @cindex extended TODO keywords
2925 By default, marked TODO entries have one of only two states: TODO and
2926 DONE. Org mode allows you to classify TODO items in more complex ways
2927 with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With
2928 special setup, the TODO keyword system can work differently in different
2931 Note that @i{tags} are another way to classify headlines in general and
2932 TODO items in particular (@pxref{Tags}).
2935 * Workflow states:: From TODO to DONE in steps
2936 * TODO types:: I do this, Fred does the rest
2937 * Multiple sets in one file:: Mixing it all, and still finding your way
2938 * Fast access to TODO states:: Single letter selection of a state
2939 * Per-file keywords:: Different files, different requirements
2940 * Faces for TODO keywords:: Highlighting states
2943 @node Workflow states, TODO types, TODO extensions, TODO extensions
2944 @subsection TODO keywords as workflow states
2945 @cindex TODO workflow
2946 @cindex workflow states as TODO keywords
2948 You can use TODO keywords to indicate different @emph{sequential} states
2949 in the process of working on an item, for example@footnote{Changing
2950 this variable only becomes effective after restarting Org mode in a
2954 (setq org-todo-keywords
2955 '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
2958 The vertical bar separates the TODO keywords (states that @emph{need
2959 action}) from the DONE states (which need @emph{no further action}). If
2960 you don't provide the separator bar, the last state is used as the DONE
2962 @cindex completion, of TODO keywords
2963 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
2964 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED. You may
2965 also use a numeric prefix argument to quickly select a specific state. For
2966 example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY.
2967 Or you can use @kbd{S-left} to go backward through the sequence. If you
2968 define many keywords, you can use in-buffer completion
2969 (@pxref{Completion}) or even a special one-key selection scheme
2970 (@pxref{Fast access to TODO states}) to insert these words into the
2971 buffer. Changing a TODO state can be logged with a timestamp, see
2972 @ref{Tracking TODO state changes} for more information.
2974 @node TODO types, Multiple sets in one file, Workflow states, TODO extensions
2975 @subsection TODO keywords as types
2977 @cindex names as TODO keywords
2978 @cindex types as TODO keywords
2980 The second possibility is to use TODO keywords to indicate different
2981 @emph{types} of action items. For example, you might want to indicate
2982 that items are for ``work'' or ``home''. Or, when you work with several
2983 people on a single project, you might want to assign action items
2984 directly to persons, by using their names as TODO keywords. This would
2985 be set up like this:
2988 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
2991 In this case, different keywords do not indicate a sequence, but rather
2992 different types. So the normal work flow would be to assign a task to a
2993 person, and later to mark it DONE. Org mode supports this style by adapting
2994 the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
2995 @kbd{t} command in the timeline and agenda buffers.}. When used several
2996 times in succession, it will still cycle through all names, in order to first
2997 select the right type for a task. But when you return to the item after some
2998 time and execute @kbd{C-c C-t} again, it will switch from any name directly
2999 to DONE. Use prefix arguments or completion to quickly select a specific
3000 name. You can also review the items of a specific TODO type in a sparse tree
3001 by using a numeric prefix to @kbd{C-c C-v}. For example, to see all things
3002 Lucy has to do, you would use @kbd{C-3 C-c C-v}. To collect Lucy's items
3003 from all agenda files into a single buffer, you would use the numeric prefix
3004 argument as well when creating the global TODO list: @kbd{C-3 C-c t}.
3006 @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions
3007 @subsection Multiple keyword sets in one file
3008 @cindex TODO keyword sets
3010 Sometimes you may want to use different sets of TODO keywords in
3011 parallel. For example, you may want to have the basic
3012 @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
3013 separate state indicating that an item has been canceled (so it is not
3014 DONE, but also does not require action). Your setup would then look
3018 (setq org-todo-keywords
3019 '((sequence "TODO" "|" "DONE")
3020 (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
3021 (sequence "|" "CANCELED")))
3024 The keywords should all be different, this helps Org mode to keep track
3025 of which subsequence should be used for a given entry. In this setup,
3026 @kbd{C-c C-t} only operates within a subsequence, so it switches from
3027 @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
3028 (nothing) to @code{REPORT}. Therefore you need a mechanism to initially
3029 select the correct sequence. Besides the obvious ways like typing a
3030 keyword or using completion, you may also apply the following commands:
3033 @kindex C-S-@key{right}
3034 @kindex C-S-@key{left}
3035 @item C-S-@key{right}
3036 @itemx C-S-@key{left}
3037 These keys jump from one TODO subset to the next. In the above example,
3038 @kbd{C-S-@key{right}} would jump from @code{TODO} or @code{DONE} to
3039 @code{REPORT}, and any of the words in the second row to @code{CANCELED}.
3040 @kindex S-@key{right}
3041 @kindex S-@key{left}
3044 @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through
3045 @emph{all} keywords from all sets, so for example @kbd{S-@key{<right>}}
3046 would switch from @code{DONE} to @code{REPORT} in the example above.
3049 @node Fast access to TODO states, Per-file keywords, Multiple sets in one file, TODO extensions
3050 @subsection Fast access to TODO states
3052 If you would like to quickly change an entry to an arbitrary TODO state
3053 instead of cycling through the states, you can set up keys for
3054 single-letter access to the states. This is done by adding the section
3055 key after each keyword, in parenthesis. For example:
3058 (setq org-todo-keywords
3059 '((sequence "TODO(t)" "|" "DONE(d)")
3060 (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
3061 (sequence "|" "CANCELED(c)")))
3064 If you then press @code{C-u C-c C-t} followed by the selection key, the
3065 entry will be switched to this state. @key{SPC} can be used to remove
3066 any TODO keyword from an entry. Should you like this way of selecting
3067 TODO states a lot, you might want to set the variable
3068 @code{org-use-fast-todo-selection} to @code{t} and make this behavior
3069 the default. Check also the variable
3070 @code{org-fast-tag-selection-include-todo}, it allows to change the TODO
3071 state through the tags interface (@pxref{Setting tags}), in case you
3072 like to mingle the two concepts.
3074 @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions
3075 @subsection Setting up keywords for individual files
3076 @cindex keyword options
3077 @cindex per-file keywords
3079 It can be very useful to use different aspects of the TODO mechanism in
3080 different files. For file-local settings, you need to add special lines
3081 to the file which set the keywords and interpretation for that file
3082 only. For example, to set one of the two examples discussed above, you
3083 need one of the following lines, starting in column zero anywhere in the
3087 #+SEQ_TODO: TODO FEEDBACK VERIFY | DONE CANCELED
3091 #+TYP_TODO: Fred Sara Lucy Mike | DONE
3094 A setup for using several sets in parallel would be:
3097 #+SEQ_TODO: TODO | DONE
3098 #+SEQ_TODO: REPORT BUG KNOWNCAUSE | FIXED
3099 #+SEQ_TODO: | CANCELED
3102 @cindex completion, of option keywords
3104 @noindent To make sure you are using the correct keyword, type
3105 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
3107 @cindex DONE, final TODO keyword
3108 Remember that the keywords after the vertical bar (or the last keyword
3109 if no bar is there) must always mean that the item is DONE (although you
3110 may use a different word). After changing one of these lines, use
3111 @kbd{C-c C-c} with the cursor still in the line to make the changes
3112 known to Org mode@footnote{Org mode parses these lines only when
3113 Org mode is activated after visiting a file. @kbd{C-c C-c} with the
3114 cursor in a line starting with @samp{#+} is simply restarting Org mode
3115 for the current buffer.}.
3117 @node Faces for TODO keywords, , Per-file keywords, TODO extensions
3118 @subsection Faces for TODO keywords
3119 @cindex faces, for TODO keywords
3121 Org mode highlights TODO keywords with special faces: @code{org-todo}
3122 for keywords indicating that an item still has to be acted upon, and
3123 @code{org-done} for keywords indicating that an item is finished. If
3124 you are using more than 2 different states, you might want to use
3125 special faces for some of them. This can be done using the variable
3126 @code{org-todo-keyword-faces}. For example:
3129 (setq org-todo-keyword-faces
3130 '(("TODO" . org-warning)
3131 ("DEFERRED" . shadow)
3132 ("CANCELED" . (:foreground "blue" :weight bold))))
3135 While using a list with face properties as shown for CANCELED
3136 @emph{should} work, this does not aways seem to be the case. If
3137 necessary, define a special face and use that.
3140 @node Progress logging, Priorities, TODO extensions, TODO Items
3141 @section Progress logging
3142 @cindex progress logging
3143 @cindex logging, of progress
3145 Org mode can automatically record a time stamp and possibly a note when
3146 you mark a TODO item as DONE, or even each time you change the state of
3147 a TODO item. This system is highly configurable, settings can be on a
3148 per-keyword basis and can be localized to a file or even a subtree. For
3149 information on how to clock working time for a task, see @ref{Clocking
3153 * Closing items:: When was this entry marked DONE?
3154 * Tracking TODO state changes:: When did the status change?
3157 @node Closing items, Tracking TODO state changes, Progress logging, Progress logging
3158 @subsection Closing items
3160 The most basic logging is to keep track of @emph{when} a certain TODO
3161 item was finished. This is achieved with@footnote{The corresponding
3162 in-buffer setting is: @code{#+STARTUP: logdone}}.
3165 (setq org-log-done 'time)
3169 Then each time you turn an entry from a TODO (not-done) state into any
3170 of the DONE states, a line @samp{CLOSED: [timestamp]} will be inserted
3171 just after the headline. If you turn the entry back into a TODO item
3172 through further state cycling, that line will be removed again. If you
3173 want to record a note along with the timestamp, use@footnote{The
3174 corresponding in-buffer setting is: @code{#+STARTUP: lognotedone}}
3177 (setq org-log-done 'note)
3181 You will then be prompted for a note, and that note will be stored below
3182 the entry with a @samp{Closing Note} heading.
3184 In the timeline (@pxref{Timeline}) and in the agenda
3185 (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
3186 display the TODO items with a @samp{CLOSED} timestamp on each day,
3187 giving you an overview of what has been done.
3189 @node Tracking TODO state changes, , Closing items, Progress logging
3190 @subsection Tracking TODO state changes
3192 When TODO keywords are used as workflow states (@pxref{Workflow
3193 states}), you might want to keep track of when a state change occurred
3194 and maybe take a note about this change. Since it is normally too much
3195 to record a note for every state, Org mode expects configuration on a
3196 per-keyword basis for this. This is achieved by adding special markers
3197 @samp{!} (for a time stamp) and @samp{@@} (for a note) in parenthesis
3198 after each keyword. For example, with the setting
3201 (setq org-todo-keywords
3202 '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
3206 you not only define global TODO keywords and fast access keys, but also
3207 request that a time is recorded when the entry is turned into
3208 DONE@footnote{It is possible that Org mode will record two time stamps
3209 when you are using both @code{org-log-done} and state change logging.
3210 However, it will never prompt for two notes - if you have configured
3211 both, the state change recording note will take precedence and cancel
3212 the @samp{Closing Note}.}, and that a note is recorded when switching to
3213 WAIT or CANCELED. The setting for WAIT is even more special: The
3214 @samp{!} after the slash means that in addition to the note taken when
3215 entering the state, a time stamp should be recorded when @i{leaving} the
3216 WAIT state, if and only if the @i{target} state does not configure
3217 logging for entering it. So it has no effect when switching from WAIT
3218 to DONE, because DONE is configured to record a timestamp only. But
3219 when switching from WAIT back to TODO, the @samp{/!} in the WAIT
3220 setting now triggers a timestamp even though TODO has no logging
3223 You can use the exact same syntax for setting logging preferences local
3226 #+SEQ_TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
3229 In order to define logging settings that are local to a subtree or a
3230 single item, define a LOGGING property in this entry. Any non-empty
3231 LOGGING property resets all logging settings to nil. You may then turn
3232 on logging for this specific tree using STARTUP keywords like
3233 @code{lognotedone} or @code{logrepeat}, as well as adding state specific
3234 settings like @code{TODO(!)}. For example
3237 * TODO Log each state with only a time
3239 :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
3241 * TODO Only log when switching to WAIT, and when repeating
3243 :LOGGING: WAIT(@@) logrepeat
3245 * TODO No logging at all
3251 @node Priorities, Breaking down tasks, Progress logging, TODO Items
3255 If you use Org mode extensively, you may end up enough TODO items that
3256 it starts to make sense to prioritize them. Prioritizing can be done by
3257 placing a @emph{priority cookie} into the headline of a TODO item, like
3261 *** TODO [#A] Write letter to Sam Fortune
3265 By default, Org mode supports three priorities: @samp{A}, @samp{B}, and
3266 @samp{C}. @samp{A} is the highest priority. An entry without a cookie
3267 is treated as priority @samp{B}. Priorities make a difference only in
3268 the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they have
3269 no inherent meaning to Org mode.
3271 Priorities can be attached to any outline tree entries; they do not need
3277 Set the priority of the current headline. The command prompts for a
3278 priority character @samp{A}, @samp{B} or @samp{C}. When you press
3279 @key{SPC} instead, the priority cookie is removed from the headline.
3280 The priorities can also be changed ``remotely'' from the timeline and
3281 agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
3284 @kindex S-@key{down}
3287 Increase/decrease priority of current headline@footnote{See also the
3288 option @code{org-priority-start-cycle-with-default'}.}. Note that these
3289 keys are also used to modify time stamps (@pxref{Creating timestamps}).
3290 Furthermore, these keys are also used by CUA mode (@pxref{Conflicts}).
3293 You can change the range of allowed priorities by setting the variables
3294 @code{org-highest-priority}, @code{org-lowest-priority}, and
3295 @code{org-default-priority}. For an individual buffer, you may set
3296 these values (highest, lowest, default) like this (please make sure that
3297 the highest priority is earlier in the alphabet than the lowest
3304 @node Breaking down tasks, Checkboxes, Priorities, TODO Items
3305 @section Breaking tasks down into subtasks
3306 @cindex tasks, breaking down
3308 It is often advisable to break down large tasks into smaller, manageable
3309 subtasks. You can do this by creating an outline tree below a TODO item,
3310 with detailed subtasks on the tree@footnote{To keep subtasks out of the
3311 global TODO list, see the @code{org-agenda-todo-list-sublevels}.}. To keep
3312 the overview over the fraction of subtasks that are already completed, insert
3313 either @samp{[/]} or @samp{[%]} anywhere in the headline. These cookies will
3314 be updates each time the todo status of a child changes. For example:
3317 * Organize Party [33%]
3318 ** TODO Call people [1/2]
3322 ** DONE Talk to neighbor
3325 If you would like a TODO entry to automatically change to DONE when all
3326 chilrden are done, you can use the following setup:
3329 (defun org-summary-todo (n-done n-not-done)
3330 "Switch entry to DONE when all subentries are done, to TODO otherwise."
3331 (let (org-log-done org-log-states) ; turn off logging
3332 (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
3334 (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
3338 Another possibility is the use of checkboxes to identify (a hierarchy of) a
3339 large number of subtasks (@pxref{Checkboxes}).
3342 @node Checkboxes, , Breaking down tasks, TODO Items
3346 Every item in a plain list (@pxref{Plain lists}) can be made into a
3347 checkbox by starting it with the string @samp{[ ]}. This feature is
3348 similar to TODO items (@pxref{TODO Items}), but is more lightweight.
3349 Checkboxes are not included into the global TODO list, so they are often
3350 great to split a task into a number of simple steps. Or you can use
3351 them in a shopping list. To toggle a checkbox, use @kbd{C-c C-c}, or
3352 use the mouse (thanks to Piotr Zielinski's @file{org-mouse.el}).
3354 Here is an example of a checkbox list.
3357 * TODO Organize party [2/4]
3358 - [-] call people [1/3]
3363 - [ ] think about what music to play
3364 - [X] talk to the neighbors
3367 Checkboxes work hierarchically, so if a checkbox item has children that
3368 are checkboxes, toggling one of the children checkboxes will make the
3369 parent checkbox reflect if none, some, or all of the children are
3372 @cindex statistics, for checkboxes
3373 @cindex checkbox statistics
3374 The @samp{[2/4]} and @samp{[1/3]} in the first and second line are
3375 cookies indicating how many checkboxes present in this entry have been
3376 checked off, and the total number of checkboxes are present. This can
3377 give you an idea on how many checkboxes remain, even without opening a
3378 folded entry. The cookies can be placed into a headline or into (the
3379 first line of) a plain list item. Each cookie covers all checkboxes
3380 structurally below the headline/item on which the cookie appear. You
3381 have to insert the cookie yourself by typing either @samp{[/]} or
3382 @samp{[%]}. With @samp{[/]} you get an @samp{n out of m} result, as in
3383 the examples above. With @samp{[%]} you get information about the
3384 percentage of checkboxes checked (in the above example, this would be
3385 @samp{[50%]} and @samp{[33%]}, respectively).
3387 @noindent The following commands work with checkboxes:
3392 Toggle checkbox at point. With a prefix argument, set it to @samp{[-]},
3393 which is considered to be an intermediate state.
3396 Toggle checkbox at point.
3399 If there is an active region, toggle the first checkbox in the region
3400 and set all remaining boxes to the same status as the first. If you
3401 want to toggle all boxes in the region independently, use a prefix
3404 If the cursor is in a headline, toggle checkboxes in the region between
3405 this headline and the next (so @emph{not} the entire subtree).
3407 If there is no active region, just toggle the checkbox at point.
3409 @kindex M-S-@key{RET}
3411 Insert a new item with a checkbox.
3412 This works only if the cursor is already in a plain list item
3413 (@pxref{Plain lists}).
3416 Update the checkbox statistics in the current outline entry. When
3417 called with a @kbd{C-u} prefix, update the entire file. Checkbox
3418 statistic cookies are updated automatically if you toggle checkboxes
3419 with @kbd{C-c C-c} and make new ones with @kbd{M-S-@key{RET}}. If you
3420 delete boxes or add/change them by hand, use this command to get things
3421 back into synch. Or simply toggle any checkbox twice with @kbd{C-c C-c}.
3424 @node Tags, Properties and Columns, TODO Items, Top
3427 @cindex headline tagging
3428 @cindex matching, tags
3429 @cindex sparse tree, tag based
3431 An excellent way to implement labels and contexts for cross-correlating
3432 information is to assign @i{tags} to headlines. Org mode has extensive
3435 Every headline can contain a list of tags; they occur at the end of the
3436 headline. Tags are normal words containing letters, numbers, @samp{_},
3437 and @samp{@@}. Tags must be preceded and followed by a single colon,
3438 e.g., @samp{:work:}. Several tags can be specified, as in
3439 @samp{:work:urgent:}.
3442 * Tag inheritance:: Tags use the tree structure of the outline
3443 * Setting tags:: How to assign tags to a headline
3444 * Tag searches:: Searching for combinations of tags
3447 @node Tag inheritance, Setting tags, Tags, Tags
3448 @section Tag inheritance
3449 @cindex tag inheritance
3450 @cindex inheritance, of tags
3451 @cindex sublevels, inclusion into tags match
3453 @i{Tags} make use of the hierarchical structure of outline trees. If a
3454 heading has a certain tag, all subheadings will inherit the tag as
3455 well. For example, in the list
3458 * Meeting with the French group :work:
3459 ** Summary by Frank :boss:notes:
3460 *** TODO Prepare slides for him :action:
3464 the final heading will have the tags @samp{:work:}, @samp{:boss:},
3465 @samp{:notes:}, and @samp{:action:} even though the final heading is not
3466 explicitly marked with those tags. You can also set tags that all entries in
3467 a file should inherit as if these tags would be defined in a hypothetical
3468 level zero that surounds the entire file.
3471 #+FILETAGS: :Peter:Boss:Secret:
3475 To limit tag inheritance to specific tags, or to turn it off entirely, use
3476 the variable @code{org-use-tag-inheritance}.
3478 When a headline matches during a tags search while tag inheritance is turned
3479 on, all the sublevels in the same tree will match as well@footnote{This is
3480 only true if the the search does not involve more complex tests including
3481 properties (@pxref{Property searches}).}. The list of matches may then
3482 become very long. If you only want to see the first tags match in a subtree,
3483 configure the variable @code{org-tags-match-list-sublevels}.
3485 @node Setting tags, Tag searches, Tag inheritance, Tags
3486 @section Setting tags
3487 @cindex setting tags
3488 @cindex tags, setting
3491 Tags can simply be typed into the buffer at the end of a headline.
3492 After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is
3493 also a special command for inserting tags:
3498 @cindex completion, of tags
3499 Enter new tags for the current headline. Org mode will either offer
3500 completion or a special single-key interface for setting tags, see
3501 below. After pressing @key{RET}, the tags will be inserted and aligned
3502 to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all
3503 tags in the current buffer will be aligned to that column, just to make
3504 things look nice. TAGS are automatically realigned after promotion,
3505 demotion, and TODO state changes (@pxref{TODO basics}).
3508 When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
3511 Org will support tag insertion based on a @emph{list of tags}. By
3512 default this list is constructed dynamically, containing all tags
3513 currently used in the buffer. You may also globally specify a hard list
3514 of tags with the variable @code{org-tag-alist}. Finally you can set
3515 the default tags for a given file with lines like
3518 #+TAGS: @@work @@home @@tennisclub
3519 #+TAGS: laptop car pc sailboat
3522 If you have globally defined your preferred set of tags using the
3523 variable @code{org-tag-alist}, but would like to use a dynamic tag list
3524 in a specific file, add an empty TAGS option line to that file:
3530 By default Org mode uses the standard minibuffer completion facilities for
3531 entering tags. However, it also implements another, quicker, tag selection
3532 method called @emph{fast tag selection}. This allows you to select and
3533 deselect tags with just a single key press. For this to work well you should
3534 assign unique letters to most of your commonly used tags. You can do this
3535 globally by configuring the variable @code{org-tag-alist} in your
3536 @file{.emacs} file. For example, you may find the need to tag many items in
3537 different files with @samp{:@@home:}. In this case you can set something
3541 (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
3544 @noindent If the tag is only relevant to the file you are working on then you
3545 can, instead, set the TAGS option line as:
3548 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p)
3552 You can also group together tags that are mutually exclusive. By using
3556 #+TAGS: @{ @@work(w) @@home(h) @@tennisclub(t) @} laptop(l) pc(p)
3559 @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
3560 and @samp{@@tennisclub} should be selected. Multiple such groups are allowed.
3562 @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
3563 these lines to activate any changes.
3566 To set these mutually exclusive groups in the variable @code{org-mode-alist}
3567 you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
3568 of the braces. The previous example would be set globally by the following
3572 (setq org-tag-alist '((:startgroup . nil)
3573 ("@@work" . ?w) ("@@home" . ?h)
3574 ("@@tennisclub" . ?t)
3576 ("laptop" . ?l) ("pc" . ?p)))
3579 If at least one tag has a selection key then pressing @kbd{C-c C-c} will
3580 automatically present you with a special interface, listing inherited tags,
3581 the tags of the current headline, and a list of all valid tags with
3582 corresponding keys@footnote{Keys will automatically be assigned to tags which
3583 have no configured keys.}. In this interface, you can use the following
3588 Pressing keys assigned to tags will add or remove them from the list of
3589 tags in the current line. Selecting a tag in a group of mutually
3590 exclusive tags will turn off any other tags from that group.
3593 Enter a tag in the minibuffer, even if the tag is not in the predefined
3594 list. You will be able to complete on all tags present in the buffer.
3597 Clear all tags for this line.
3600 Accept the modified set.
3602 Abort without installing changes.
3604 If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
3606 Turn off groups of mutually exclusive tags. Use this to (as an
3607 exception) assign several tags from such a group.
3609 Toggle auto-exit after the next change (see below).
3610 If you are using expert mode, the first @kbd{C-c} will display the
3615 This method lets you assign tags to a headline with very few keys. With
3616 the above setup, you could clear the current tags and set @samp{@@home},
3617 @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
3618 C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@home} to
3619 @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
3620 alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag
3621 @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
3622 @key{RET} @key{RET}}.
3624 If you find that most of the time, you need only a single key press to
3625 modify your list of tags, set the variable
3626 @code{org-fast-tag-selection-single-key}. Then you no longer have to
3627 press @key{RET} to exit fast tag selection - it will immediately exit
3628 after the first change. If you then occasionally need more keys, press
3629 @kbd{C-c} to turn off auto-exit for the current tag selection process
3630 (in effect: start selection with @kbd{C-c C-c C-c} instead of @kbd{C-c
3631 C-c}). If you set the variable to the value @code{expert}, the special
3632 window is not even shown for single-key tag selection, it comes up only
3633 when you press an extra @kbd{C-c}.
3635 @node Tag searches, , Setting tags, Tags
3636 @section Tag searches
3637 @cindex tag searches
3638 @cindex searching for tags
3640 Once a system of tags has been set up, it can be used to collect related
3641 information into special lists.
3648 Create a sparse tree with all headlines matching a tags search. With a
3649 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
3652 Create a global list of tag matches from all agenda files.
3653 @xref{Matching tags and properties}.
3656 Create a global list of tag matches from all agenda files, but check
3657 only TODO items and force checking subitems (see variable
3658 @code{org-tags-match-list-sublevels}).
3661 @cindex Boolean logic, for tag searches
3662 A @i{tags} search string can use Boolean operators @samp{&} for AND and
3663 @samp{|} for OR. @samp{&} binds more strongly than @samp{|}.
3664 Parenthesis are currently not implemented. A tag may also be preceded
3665 by @samp{-}, to select against it, and @samp{+} is syntactic sugar for
3666 positive selection. The AND operator @samp{&} is optional when @samp{+}
3667 or @samp{-} is present. Examples:
3671 Select headlines tagged @samp{:work:}, but discard those also tagged
3674 Selects lines tagged @samp{:work:} or @samp{:laptop:}.
3675 @item work|laptop&night
3676 Like before, but require the @samp{:laptop:} lines to be tagged also
3680 @cindex TODO keyword matching, with tags search
3681 You may also test for TODO keywords (@pxref{TODO extensions}) and properties
3682 (@pxref{Properties and Columns}) at the same time as matching tags. For a
3683 guide on how to match properties, see @ref{Property searches}. To match a
3684 specific TODO keyword, include an expression like @samp{+TODO="NEXT"} as one
3685 of the terms in a tags search.
3687 There is also the possibility to end the tags part of the match (which may
3688 include several terms connected with @samp{|}) with a @samp{/} and then
3689 specify a Boolean expression just for TODO keywords. The syntax is then
3690 similar to the tag matches, but should be applied with consideration: For
3691 example, a positive selection on several TODO keywords can not meaningfully
3692 be combined with boolean AND. However, @emph{negative selection} combined
3693 with AND can be meaningful. To make sure that only lines are checked that
3694 actually have any TODO keyword (resulting in a speed-up), use @kbd{C-c a M},
3695 or equivalently start the TODO part after the slash with @samp{!}. Examples:
3698 @item work+TODO="WAITING"
3699 Select @samp{:work:}-tagged TODO lines with the specific TODO
3700 keyword @samp{WAITING}.
3701 @item work+TODO="WAITING"|home+TODO="WAITING"
3702 Waiting tasks both at work and at home.
3704 Same as the first example.
3705 @item work/!-WAITING-NEXT
3706 Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
3708 @item work/!+WAITING|+NEXT
3709 Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
3713 @cindex regular expressions, with tags search
3714 Any element of the tag/todo match can be a regular expression - in this
3715 case it must be enclosed in curly braces. For example,
3716 @samp{work+@{^boss.*@}} matches headlines that contain the tag
3717 @samp{:work:} and any tag @i{starting} with @samp{boss}. You may also use a
3718 regular expression in @samp{TODO=@{^W@}} which would match TODO keywords
3719 starting with the letter @samp{W}.
3721 @cindex level, require for tags/property match
3722 @cindex category, require for tags/property match
3723 You can also require a headline to be of a certain level or category, by
3724 writing instead of any TAG an expression like @samp{LEVEL=3} or
3725 @samp{CATEGORY="work"}, respectively. For example, a search
3726 @samp{+LEVEL=3+boss/-DONE} lists all level three headlines that have the
3727 tag @samp{boss} and are @emph{not} marked with the TODO keyword DONE.
3729 Accessing TODO, LEVEL, and CATEGORY during a search is fast. Accessing any
3730 other properties will slow down the search.
3732 @node Properties and Columns, Dates and Times, Tags, Top
3733 @chapter Properties and Columns
3736 Properties are a set of key-value pairs associated with an entry. There
3737 are two main applications for properties in Org mode. First, properties
3738 are like tags, but with a value. Second, you can use properties to
3739 implement (very basic) database capabilities in an Org buffer. For
3740 an example of the first application, imagine maintaining a file where
3741 you document bugs and plan releases of a piece of software. Instead of
3742 using tags like @code{:release_1:}, @code{:release_2:}, one can use a
3743 property, say @code{:Release:}, that in different subtrees has different
3744 values, such as @code{1.0} or @code{2.0}. For an example of the second
3745 application of properties, imagine keeping track of your music CD's,
3746 where properties could be things such as the album artist, date of
3747 release, number of tracks, and so on.
3749 Properties can be conveniently edited and viewed in column view
3750 (@pxref{Column view}).
3753 * Property syntax:: How properties are spelled out
3754 * Special properties:: Access to other Org mode features
3755 * Property searches:: Matching property values
3756 * Property inheritance:: Passing values down the tree
3757 * Column view:: Tabular viewing and editing
3758 * Property API:: Properties for Lisp programmers
3761 @node Property syntax, Special properties, Properties and Columns, Properties and Columns
3762 @section Property syntax
3763 @cindex property syntax
3764 @cindex drawer, for properties
3766 Properties are key-value pairs. They need to be inserted into a special
3767 drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property
3768 is specified on a single line, with the key (surrounded by colons)
3769 first, and the value after it. Here is an example:
3774 *** Goldberg Variations
3776 :Title: Goldberg Variations
3777 :Composer: J.S. Bach
3779 :Publisher: Deutsche Grammphon
3784 You may define the allowed values for a particular property @samp{:Xyz:}
3785 by setting a property @samp{:Xyz_ALL:}. This special property is
3786 @emph{inherited}, so if you set it in a level 1 entry, it will apply to
3787 the entire tree. When allowed values are defined, setting the
3788 corresponding property becomes easier and is less prone to typing
3789 errors. For the example with the CD collection, we can predefine
3790 publishers and the number of disks in a box like this:
3795 :NDisks_ALL: 1 2 3 4
3796 :Publisher_ALL: "Deutsche Grammophon" Philips EMI
3800 If you want to set properties that can be inherited by any entry in a
3801 file, use a line like
3804 #+PROPERTY: NDisks_ALL 1 2 3 4
3807 Property values set with the global variable
3808 @code{org-global-properties} can be inherited by all entries in all
3812 The following commands help to work with properties:
3817 After an initial colon in a line, complete property keys. All keys used
3818 in the current file will be offered as possible completions.
3821 Set a property. This prompts for a property name and a value. If
3822 necessary, the property drawer is created as well.
3823 @item M-x org-insert-property-drawer
3824 Insert a property drawer into the current entry. The drawer will be
3825 inserted early in the entry, but after the lines with planning
3826 information like deadlines.
3829 With the cursor in a property drawer, this executes property commands.
3831 Set a property in the current entry. Both the property and the value
3832 can be inserted using completion.
3833 @kindex S-@key{right}
3834 @kindex S-@key{left}
3835 @item S-@key{left}/@key{right}
3836 Switch property at point to the next/previous allowed value.
3838 Remove a property from the current entry.
3840 Globally remove a property, from all entries in the current file.
3842 Compute the property at point, using the operator and scope from the
3843 nearest column format definition.
3846 @node Special properties, Property searches, Property syntax, Properties and Columns
3847 @section Special properties
3848 @cindex properties, special
3850 Special properties provide alternative access method to Org mode
3851 features discussed in the previous chapters, like the TODO state or the
3852 priority of an entry. This interface exists so that you can include
3853 these states into columns view (@pxref{Column view}), or to use them in
3854 queries. The following property names are special and should not be
3855 used as keys in the properties drawer:
3858 TODO @r{The TODO keyword of the entry.}
3859 TAGS @r{The tags defined directly in the headline.}
3860 ALLTAGS @r{All tags, including inherited ones.}
3861 PRIORITY @r{The priority of the entry, a string with a single letter.}
3862 DEADLINE @r{The deadline time string, without the angular brackets.}
3863 SCHEDULED @r{The scheduling time stamp, without the angular brackets.}
3864 TIMESTAMP @r{The first keyword-less time stamp in the entry.}
3865 TIMESTAMP_IA @r{The first inactive time stamp in the entry.}
3866 CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}}
3867 @r{must be run first to compute the values.}
3870 @node Property searches, Property inheritance, Special properties, Properties and Columns
3871 @section Property searches
3872 @cindex properties, searching
3873 @cindex searching, of properties
3875 To create sparse trees and special lists with selection based on properties,
3876 the same commands are used as for tag searches (@pxref{Tag searches}), and
3877 the same logic applies. For example, here is a search string:
3880 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 \
3881 +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
3885 The type of comparison will depend on how the comparison value is written:
3888 If the comparison value is a plain number, a numerical comparison is done,
3889 and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
3890 @samp{>=}, and @samp{<>}.
3892 If the comparison value is enclosed in double
3893 quotes, a string comparison is done, and the same operators are allowed.
3895 If the comparison value is enclosed in double quotes @emph{and} angular
3896 brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
3897 assumed to be date/time specifications in the standard Org way@footnote{The
3898 only special values that will be recognized are @samp{"<now>"} for now
3899 (including time), and @samp{"<today>"}, @samp{<tomorrow>}, and
3900 @samp{<yesterday>} for these days at 0:00 hours, i.e. without a time
3901 specification.}, and the comparison will be done accordingly.
3903 If the comparison value is enclosed
3904 in curly braces, a regexp match is performed, with @samp{=} meaning that the
3905 regexp matches the property value, and @samp{<>} meaning that it does not
3909 So the search string in the example finds entries tagged @samp{:work:} but
3910 not @samp{:boss:}, which also have a priority value @samp{A}, a
3911 @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
3912 property that is numerically smaller than 2, a @samp{:With:} property that is
3913 matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
3914 on or after October 11, 2008.
3916 You can configure Org mode to use property inheritance during a search, but
3917 beware that this can slow down searches considerably. See @ref{Property
3918 inheritance} for details.
3920 There is also a special command for creating sparse trees based on a
3926 Create a sparse tree based on the value of a property. This first
3927 prompts for the name of a property, and then for a value. A sparse tree
3928 is created with all entries that define this property with the given
3929 value. If you enclose the value into curly braces, it is interpreted as
3930 a regular expression and matched against the property values.
3933 @node Property inheritance, Column view, Property searches, Properties and Columns
3934 @section Property Inheritance
3935 @cindex properties, inheritance
3936 @cindex inheritance, of properties
3938 The outline structure of Org mode documents lends itself for an
3939 inheritance model of properties: If the parent in a tree has a certain
3940 property, the children can inherit this property. Org mode does not
3941 turn this on by default, because it can slow down property searches
3942 significantly and is often not needed. However, if you find inheritance
3943 useful, you can turn it on by setting the variable
3944 @code{org-use-property-inheritance}. It may be set to @code{t}, to make
3945 all properties inherited from the parent, to a list of properties
3946 that should be inherited, or to a regular expression that matches
3947 inherited properties.
3949 Org mode has a few properties for which inheritance is hard-coded, at
3950 least for the special applications for which they are used:
3954 The @code{:COLUMNS:} property defines the format of column view
3955 (@pxref{Column view}). It is inherited in the sense that the level
3956 where a @code{:COLUMNS:} property is defined is used as the starting
3957 point for a column view table, independently of the location in the
3958 subtree from where columns view is turned on.
3960 For agenda view, a category set through a @code{:CATEGORY:} property
3961 applies to the entire subtree.
3963 For archiving, the @code{:ARCHIVE:} property may define the archive
3964 location for the entire subtree (@pxref{Moving subtrees}).
3966 The LOGGING property may define logging settings for an entry or a
3967 subtree (@pxref{Tracking TODO state changes}).
3970 @node Column view, Property API, Property inheritance, Properties and Columns
3971 @section Column view
3973 A great way to view and edit properties in an outline tree is
3974 @emph{column view}. In column view, each outline item is turned into a
3975 table row. Columns in this table provide access to properties of the
3976 entries. Org mode implements columns by overlaying a tabular structure
3977 over the headline of each item. While the headlines have been turned
3978 into a table row, you can still change the visibility of the outline
3979 tree. For example, you get a compact table by switching to CONTENTS
3980 view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
3981 is active), but you can still open, read, and edit the entry below each
3982 headline. Or, you can switch to column view after executing a sparse
3983 tree command and in this way get a table only for the selected items.
3984 Column view also works in agenda buffers (@pxref{Agenda Views}) where
3985 queries have collected selected items, possibly from a number of files.
3988 * Defining columns:: The COLUMNS format property
3989 * Using column view:: How to create and use column view
3990 * Capturing column view:: A dynamic block for column view
3993 @node Defining columns, Using column view, Column view, Column view
3994 @subsection Defining columns
3995 @cindex column view, for properties
3996 @cindex properties, column view
3998 Setting up a column view first requires defining the columns. This is
3999 done by defining a column format line.
4002 * Scope of column definitions:: Where defined, where valid?
4003 * Column attributes:: Appearance and content of a column
4006 @node Scope of column definitions, Column attributes, Defining columns, Defining columns
4007 @subsubsection Scope of column definitions
4009 To define a column format for an entire file, use a line like
4012 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
4015 To specify a format that only applies to a specific tree, add a
4016 @code{:COLUMNS:} property to the top node of that tree, for example:
4019 ** Top node for columns view
4021 :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
4025 If a @code{:COLUMNS:} property is present in an entry, it defines columns
4026 for the entry itself, and for the entire subtree below it. Since the
4027 column definition is part of the hierarchical structure of the document,
4028 you can define columns on level 1 that are general enough for all
4029 sublevels, and more specific columns further down, when you edit a
4030 deeper part of the tree.
4032 @node Column attributes, , Scope of column definitions, Defining columns
4033 @subsubsection Column attributes
4034 A column definition sets the attributes of a column. The general
4035 definition looks like this:
4038 %[width]property[(title)][@{summary-type@}]
4042 Except for the percent sign and the property name, all items are
4043 optional. The individual parts have the following meaning:
4046 width @r{An integer specifying the width of the column in characters.}
4047 @r{If omitted, the width will be determined automatically.}
4048 property @r{The property that should be edited in this column.}
4049 (title) @r{The header text for the column. If omitted, the}
4050 @r{property name is used.}
4051 @{summary-type@} @r{The summary type. If specified, the column values for}
4052 @r{parent nodes are computed from the children.}
4053 @r{Supported summary types are:}
4054 @{+@} @r{Sum numbers in this column.}
4055 @{+;%.1f@} @r{Like @samp{+}, but format result with @samp{%.1f}.}
4056 @{$@} @r{Currency, short for @samp{+;%.2f}.}
4057 @{:@} @r{Sum times, HH:MM:SS, plain numbers are hours.}
4058 @{X@} @r{Checkbox status, [X] if all children are [X].}
4059 @{X/@} @r{Checkbox status, [n/m].}
4060 @{X%@} @r{Checkbox status, [n%].}
4064 Here is an example for a complete columns definition, along with allowed
4068 :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.}
4069 %10Time_Estimate@{:@} %CLOCKSUM
4070 :Owner_ALL: Tammy Mark Karl Lisa Don
4071 :Status_ALL: "In progress" "Not started yet" "Finished" ""
4072 :Approved_ALL: "[ ]" "[X]"
4075 The first column, @samp{%25ITEM}, means the first 25 characters of the
4076 item itself, i.e. of the headline. You probably always should start the
4077 column definition with the @samp{ITEM} specifier. The other specifiers
4078 create columns @samp{Owner} with a list of names as allowed values, for
4079 @samp{Status} with four different possible values, and for a checkbox
4080 field @samp{Approved}. When no width is given after the @samp{%}
4081 character, the column will be exactly as wide as it needs to be in order
4082 to fully display all values. The @samp{Approved} column does have a
4083 modified title (@samp{Approved?}, with a question mark). Summaries will
4084 be created for the @samp{Time_Estimate} column by adding time duration
4085 expressions like HH:MM, and for the @samp{Approved} column, by providing
4086 an @samp{[X]} status if all children have been checked. The
4087 @samp{CLOCKSUM} column is special, it lists the sum of CLOCK intervals
4090 @node Using column view, Capturing column view, Defining columns, Column view
4091 @subsection Using column view
4094 @tsubheading{Turning column view on and off}
4097 Create the column view for the local environment. This command searches
4098 the hierarchy, up from point, for a @code{:COLUMNS:} property that defines
4099 a format. When one is found, the column view table is established for
4100 the entire tree, starting from the entry that contains the @code{:COLUMNS:}
4101 property. If none is found, the format is taken from the @code{#+COLUMNS}
4102 line or from the variable @code{org-columns-default-format}, and column
4103 view is established for the current entry and its subtree.
4106 Recreate the column view, to include recent changes made in the buffer.
4113 @tsubheading{Editing values}
4114 @item @key{left} @key{right} @key{up} @key{down}
4115 Move through the column view from field to field.
4116 @kindex S-@key{left}
4117 @kindex S-@key{right}
4118 @item S-@key{left}/@key{right}
4119 Switch to the next/previous allowed value of the field. For this, you
4120 have to have specified allowed values for a property.
4122 Directly select the nth allowed value, @kbd{0} selects the 10th value.
4126 Same as @kbd{S-@key{left}/@key{right}}
4129 Edit the property at point. For the special properties, this will
4130 invoke the same interface that you normally use to change that
4131 property. For example, when editing a TAGS property, the tag completion
4132 or fast selection interface will pop up.
4135 When there is a checkbox at point, toggle it.
4138 View the full value of this property. This is useful if the width of
4139 the column is smaller than that of the value.
4142 Edit the list of allowed values for this property. If the list is found
4143 in the hierarchy, the modified values is stored there. If no list is
4144 found, the new value is stored in the first entry that is part of the
4145 current column view.
4146 @tsubheading{Modifying the table structure}
4150 Make the column narrower/wider by one character.
4151 @kindex S-M-@key{right}
4152 @item S-M-@key{right}
4153 Insert a new column, to the left of the current column.
4154 @kindex S-M-@key{left}
4155 @item S-M-@key{left}
4156 Delete the current column.
4159 @node Capturing column view, , Using column view, Column view
4160 @subsection Capturing column view
4162 Since column view is just an overlay over a buffer, it cannot be
4163 exported or printed directly. If you want to capture a column view, use
4164 this @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame
4165 of this block looks like this:
4167 @cindex #+BEGIN: columnview
4170 #+BEGIN: columnview :hlines 1 :id "label"
4175 @noindent This dynamic block has the following parameters:
4179 This is most important parameter. Column view is a feature that is
4180 often localized to a certain (sub)tree, and the capture block might be
4181 in a different location in the file. To identify the tree whose view to
4182 capture, you can use 3 values:
4184 local @r{use the tree in which the capture block is located}
4185 global @r{make a global view, including all headings in the file}
4186 "label" @r{call column view in the tree that has an @code{:ID:}}
4187 @r{property with the value @i{label}. You can use}
4188 @r{@kbd{M-x org-id-copy} to create a globally unique ID for}
4189 @r{the current entry and copy it to the kill-ring.}
4192 When @code{t}, insert a hline after every line. When a number N, insert
4193 a hline before each headline with level @code{<= N}.
4195 When set to @code{t}, enforce column groups to get vertical lines.
4197 When set to a number, don't capture entries below this level.
4198 @item :skip-empty-rows
4199 When set to @code{t}, skip row where the only non-empty specifier of the
4200 column view is @code{ITEM}.
4205 The following commands insert or update the dynamic block:
4210 Insert a dynamic block capturing a column view. You will be prompted
4211 for the scope or id of the view.
4216 Update dynamical block at point. The cursor needs to be in the
4217 @code{#+BEGIN} line of the dynamic block.
4218 @kindex C-u C-c C-x C-u
4219 @item C-u C-c C-x C-u
4220 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
4221 you have several clock table blocks in a buffer.
4224 You can add formulas to the column view table and you may add plotting
4225 instructions in front of the table - these will survive an update of the
4226 block. If there is a @code{#+TBLFM:} after the table, the table will
4227 actually be recalculated automatically after an update.
4229 @node Property API, , Column view, Properties and Columns
4230 @section The Property API
4231 @cindex properties, API
4232 @cindex API, for properties
4234 There is a full API for accessing and changing properties. This API can
4235 be used by Emacs Lisp programs to work with properties and to implement
4236 features based on them. For more information see @ref{Using the
4239 @node Dates and Times, Capture, Properties and Columns, Top
4240 @chapter Dates and Times
4246 To assist project planning, TODO items can be labeled with a date and/or
4247 a time. The specially formatted string carrying the date and time
4248 information is called a @emph{timestamp} in Org mode. This may be a
4249 little confusing because timestamp is often used as indicating when
4250 something was created or last changed. However, in Org mode this term
4251 is used in a much wider sense.
4254 * Timestamps:: Assigning a time to a tree entry
4255 * Creating timestamps:: Commands which insert timestamps
4256 * Deadlines and scheduling:: Planning your work
4257 * Clocking work time:: Tracking how long you spend on a task
4258 * Effort estimates:: Planning work effort in advance
4262 @node Timestamps, Creating timestamps, Dates and Times, Dates and Times
4263 @section Timestamps, deadlines and scheduling
4265 @cindex ranges, time
4270 A time stamp is a specification of a date (possibly with time or a range
4271 of times) in a special format, either @samp{<2003-09-16 Tue>} or
4272 @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16 Tue
4273 12:00-12:30>}@footnote{This is the standard ISO date/time format. To
4274 use an alternative format, see @ref{Custom time format}.}. A time stamp
4275 can appear anywhere in the headline or body of an Org tree entry. Its
4276 presence causes entries to be shown on specific dates in the agenda
4277 (@pxref{Weekly/daily agenda}). We distinguish:
4280 @item Plain time stamp; Event; Appointment
4282 A simple time stamp just assigns a date/time to an item. This is just
4283 like writing down an appointment or event in a paper agenda. In the
4284 timeline and agenda displays, the headline of an entry associated with a
4285 plain time stamp will be shown exactly on that date.
4288 * Meet Peter at the movies <2006-11-01 Wed 19:15>
4289 * Discussion on climate change <2006-11-02 Thu 20:00-22:00>
4292 @item Time stamp with repeater interval
4293 @cindex timestamp, with repeater interval
4294 A time stamp may contain a @emph{repeater interval}, indicating that it
4295 applies not only on the given date, but again and again after a certain
4296 interval of N days (d), weeks (w), months(m), or years(y). The
4297 following will show up in the agenda every Wednesday:
4300 * Pick up Sam at school <2007-05-16 Wed 12:30 +1w>
4303 @item Diary-style sexp entries
4304 For more complex date specifications, Org mode supports using the
4305 special sexp diary entries implemented in the Emacs calendar/diary
4306 package. For example
4309 * The nerd meeting on every 2nd Thursday of the month
4310 <%%(diary-float t 4 2)>
4313 @item Time/Date range
4316 Two time stamps connected by @samp{--} denote a range. The headline
4317 will be shown on the first and last day of the range, and on any dates
4318 that are displayed and fall in the range. Here is an example:
4321 ** Meeting in Amsterdam
4322 <2004-08-23 Mon>--<2004-08-26 Thu>
4325 @item Inactive time stamp
4326 @cindex timestamp, inactive
4327 @cindex inactive timestamp
4328 Just like a plain time stamp, but with square brackets instead of
4329 angular ones. These time stamps are inactive in the sense that they do
4330 @emph{not} trigger an entry to show up in the agenda.
4333 * Gillian comes late for the fifth time [2006-11-01 Wed]
4338 @node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times
4339 @section Creating timestamps
4340 @cindex creating timestamps
4341 @cindex timestamps, creating
4343 For Org mode to recognize time stamps, they need to be in the specific
4344 format. All commands listed below produce time stamps in the correct
4350 Prompt for a date and insert a corresponding time stamp. When the cursor is
4351 at an existing time stamp in the buffer, the command is used to modify this
4352 timestamp instead of inserting a new one. When this command is used twice in
4353 succession, a time range is inserted.
4357 Like @kbd{C-c .}, but use the alternative format which contains date
4358 and time. The default time can be rounded to multiples of 5 minutes,
4359 see the option @code{org-time-stamp-rounding-minutes}.
4363 Like @kbd{C-c .}, but insert an inactive time stamp that will not cause
4368 Insert a time stamp corresponding to the cursor date in the Calendar.
4372 Access the Emacs calendar for the current date. If there is a
4373 timestamp in the current line, go to the corresponding date
4378 Access the agenda for the date given by the time stamp or -range at
4379 point (@pxref{Weekly/daily agenda}).
4381 @kindex S-@key{left}
4382 @kindex S-@key{right}
4384 @itemx S-@key{right}
4385 Change date at cursor by one day. These key bindings conflict with
4386 CUA mode (@pxref{Conflicts}).
4389 @kindex S-@key{down}
4392 Change the item under the cursor in a timestamp. The cursor can be on a
4393 year, month, day, hour or minute. Note that if the cursor is in a
4394 headline and not at a time stamp, these same keys modify the priority of
4395 an item. (@pxref{Priorities}). The key bindings also conflict with
4396 CUA mode (@pxref{Conflicts}).
4399 @cindex evaluate time range
4401 Evaluate a time range by computing the difference between start and end.
4402 With a prefix argument, insert result after the time range (in a table: into
4403 the following column).
4408 * The date/time prompt:: How Org mode helps you entering date and time
4409 * Custom time format:: Making dates look different
4412 @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps
4413 @subsection The date/time prompt
4414 @cindex date, reading in minibuffer
4415 @cindex time, reading in minibuffer
4417 When Org mode prompts for a date/time, the default is shown as an ISO
4418 date, and the prompt therefore seems to ask for an ISO date. But it
4419 will in fact accept any string containing some date and/or time
4420 information, and it is really smart about interpreting your input. You
4421 can, for example, use @kbd{C-y} to paste a (possibly multi-line) string
4422 copied from an email message. Org mode will find whatever information
4423 is in there and derive anything you have not specified from the
4424 @emph{default date and time}. The default is usually the current date
4425 and time, but when modifying an existing time stamp, or when entering
4426 the second stamp of a range, it is taken from the stamp in the buffer.
4427 When filling in information, Org mode assumes that most of the time you
4428 will want to enter a date in the future: If you omit the month/year and
4429 the given day/month is @i{before} today, it will assume that you mean a
4430 future date@footnote{See the variable
4431 @code{org-read-date-prefer-future}.}.
4433 For example, lets assume that today is @b{June 13, 2006}. Here is how
4434 various inputs will be interpreted, the items filled in by Org mode are
4438 3-2-5 --> 2003-02-05
4439 14 --> @b{2006}-@b{06}-14
4440 12 --> @b{2006}-@b{07}-12
4441 Fri --> nearest Friday (defaultdate or later)
4442 sep 15 --> @b{2006}-11-15
4443 feb 15 --> @b{2007}-02-15
4444 sep 12 9 --> 2009-09-12
4445 12:45 --> @b{2006}-@b{06}-@b{13} 12:45
4446 22 sept 0:34 --> @b{2006}-09-22 0:34
4447 w4 --> ISO week for of the current year @b{2006}
4448 2012 w4 fri --> Friday of ISO week 4 in 2012
4449 2012-w04-5 --> Same as above
4452 Furthermore you can specify a relative date by giving, as the
4453 @emph{first} thing in the input: a plus/minus sign, a number and a
4454 letter [dwmy] to indicate change in days weeks, months, years. With a
4455 single plus or minus, the date is always relative to today. With a
4456 double plus or minus, it is relative to the default date. If instead of
4457 a single letter, you use the abbreviation of day name, the date will be
4458 the nth such day. E.g.
4463 +4d --> four days from today
4464 +4 --> same as above
4465 +2w --> two weeks from today
4466 ++5 --> five days from default date
4467 +2tue --> second tuesday from now.
4470 The function understands English month and weekday abbreviations. If
4471 you want to use unabbreviated names and/or other languages, configure
4472 the variables @code{parse-time-months} and @code{parse-time-weekdays}.
4474 @cindex calendar, for selecting date
4475 Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
4476 you don't need/want the calendar, configure the variable
4477 @code{org-popup-calendar-for-date-prompt}.}. When you exit the date
4478 prompt, either by clicking on a date in the calendar, or by pressing
4479 @key{RET}, the date selected in the calendar will be combined with the
4480 information entered at the prompt. You can control the calendar fully
4481 from the minibuffer:
4486 @kindex S-@key{right}
4487 @kindex S-@key{left}
4488 @kindex S-@key{down}
4490 @kindex M-S-@key{right}
4491 @kindex M-S-@key{left}
4494 > / < @r{Scroll calendar forward/backward by one month.}
4495 mouse-1 @r{Select date by clicking on it.}
4496 S-@key{right}/@key{left} @r{One day forward/backward.}
4497 S-@key{down}/@key{up} @r{One week forward/backward.}
4498 M-S-@key{right}/@key{left} @r{One month forward/backward.}
4499 @key{RET} @r{Choose date in calendar.}
4502 The actions of the date/time prompt may seem complex, but I assure you they
4503 will grow on you, and you will start getting annoyed by pretty much any other
4504 way of entering a date/time out there. To help you understand what is going
4505 on, the current interpretation of your input will be displayed live in the
4506 minibuffer@footnote{If you find this distracting, turn the display of with
4507 @code{org-read-date-display-live}.}.
4509 @node Custom time format, , The date/time prompt, Creating timestamps
4510 @subsection Custom time format
4511 @cindex custom date/time format
4512 @cindex time format, custom
4513 @cindex date format, custom
4515 Org mode uses the standard ISO notation for dates and times as it is
4516 defined in ISO 8601. If you cannot get used to this and require another
4517 representation of date and time to keep you happy, you can get it by
4518 customizing the variables @code{org-display-custom-times} and
4519 @code{org-time-stamp-custom-formats}.
4524 Toggle the display of custom formats for dates and times.
4528 Org mode needs the default format for scanning, so the custom date/time
4529 format does not @emph{replace} the default format - instead it is put
4530 @emph{over} the default format using text properties. This has the
4531 following consequences:
4534 You cannot place the cursor onto a time stamp anymore, only before or
4537 The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
4538 each component of a time stamp. If the cursor is at the beginning of
4539 the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
4540 just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the
4541 time will be changed by one minute.
4543 If the time stamp contains a range of clock times or a repeater, these
4544 will not be overlayed, but remain in the buffer as they were.
4546 When you delete a time stamp character-by-character, it will only
4547 disappear from the buffer after @emph{all} (invisible) characters
4548 belonging to the ISO timestamp have been removed.
4550 If the custom time stamp format is longer than the default and you are
4551 using dates in tables, table alignment will be messed up. If the custom
4552 format is shorter, things do work as expected.
4556 @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times
4557 @section Deadlines and scheduling
4559 A time stamp may be preceded by special keywords to facilitate planning:
4563 @cindex DEADLINE keyword
4565 Meaning: the task (most likely a TODO item, though not necessarily) is supposed
4566 to be finished on that date.
4568 On the deadline date, the task will be listed in the agenda. In
4569 addition, the agenda for @emph{today} will carry a warning about the
4570 approaching or missed deadline, starting
4571 @code{org-deadline-warning-days} before the due date, and continuing
4572 until the entry is marked DONE. An example:
4575 *** TODO write article about the Earth for the Guide
4576 The editor in charge is [[bbdb:Ford Prefect]]
4577 DEADLINE: <2004-02-29 Sun>
4580 You can specify a different lead time for warnings for a specific
4581 deadlines using the following syntax. Here is an example with a warning
4582 period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}.
4585 @cindex SCHEDULED keyword
4587 Meaning: you are planning to start working on that task on the given
4590 The headline will be listed under the given date@footnote{It will still
4591 be listed on that date after it has been marked DONE. If you don't like
4592 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In
4593 addition, a reminder that the scheduled date has passed will be present
4594 in the compilation for @emph{today}, until the entry is marked DONE.
4595 I.e., the task will automatically be forwarded until completed.
4598 *** TODO Call Trillian for a date on New Years Eve.
4599 SCHEDULED: <2004-12-25 Sat>
4603 @b{Important:} Scheduling an item in Org mode should @i{not} be
4604 understood in the same way that we understand @i{scheduling a meeting}.
4605 Setting a date for a meeting is just a simple appointment, you should
4606 mark this entry with a simple plain time stamp, to get this item shown
4607 on the date where it applies. This is a frequent mis-understanding from
4608 Org-users. In Org mode, @i{scheduling} means setting a date when you
4609 want to start working on an action item.
4612 You may use time stamps with repeaters in scheduling and deadline
4613 entries. Org mode will issue early and late warnings based on the
4614 assumption that the time stamp represents the @i{nearest instance} of
4615 the repeater. However, the use of diary sexp entries like
4617 @code{<%%(diary-float t 42)>}
4619 in scheduling and deadline timestamps is limited. Org mode does not
4620 know enough about the internals of each sexp function to issue early and
4621 late warnings. However, it will show the item on each day where the
4625 * Inserting deadline/schedule:: Planning items
4626 * Repeated tasks:: Items that show up again and again
4629 @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling
4630 @subsection Inserting deadlines or schedules
4632 The following commands allow to quickly insert a deadline or to schedule
4639 Insert @samp{DEADLINE} keyword along with a stamp. The insertion will
4640 happen in the line directly following the headline. When called with a
4641 prefix arg, an existing deadline will be removed from the entry.
4642 @c FIXME Any CLOSED timestamp will be removed.????????
4645 @cindex sparse tree, for deadlines
4647 Create a sparse tree with all deadlines that are either past-due, or
4648 which will become due within @code{org-deadline-warning-days}.
4649 With @kbd{C-u} prefix, show all deadlines in the file. With a numeric
4650 prefix, check that many days. For example, @kbd{C-1 C-c / d} shows
4651 all deadlines due tomorrow.
4655 Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will
4656 happen in the line directly following the headline. Any CLOSED
4657 timestamp will be removed. When called with a prefix argument, remove
4658 the scheduling date from the entry.
4664 Mark the current entry for agenda action. After you have marked the entry
4665 like this, you can open the agenda or the calendar to find an appropriate
4666 date. With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to
4667 schedule the marked item.
4670 @node Repeated tasks, , Inserting deadline/schedule, Deadlines and scheduling
4671 @subsection Repeated tasks
4673 Some tasks need to be repeated again and again. Org mode helps to
4674 organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
4675 or plain time stamp. In the following example
4677 ** TODO Pay the rent
4678 DEADLINE: <2005-10-01 Sat +1m>
4680 the @code{+1m} is a repeater; the intended interpretation is that the
4681 task has a deadline on <2005-10-01> and repeats itself every (one) month
4682 starting from that time. If you need both a repeater and a special
4683 warning period in a deadline entry, the repeater comes first and the
4684 warning period last: @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
4686 Deadlines and scheduled items produce entries in the agenda when they
4687 are over-due, so it is important to be able to mark such an entry as
4688 completed once you have done so. When you mark a DEADLINE or a SCHEDULE
4689 with the TODO keyword DONE, it will no longer produce entries in the
4690 agenda. The problem with this is, however, that then also the
4691 @emph{next} instance of the repeated entry will not be active. Org mode
4692 deals with this in the following way: When you try to mark such an entry
4693 DONE (using @kbd{C-c C-t}), it will shift the base date of the repeating
4694 time stamp by the repeater interval, and immediately set the entry state
4695 back to TODO. In the example above, setting the state to DONE would
4696 actually switch the date like this:
4699 ** TODO Pay the rent
4700 DEADLINE: <2005-11-01 Tue +1m>
4703 A timestamp@footnote{You can change this using the option
4704 @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
4705 @code{lognoterepeat}, and @code{nologrepeat}. With @code{lognoterepeat}, you
4706 will aslo be prompted for a note.} will be added under the deadline, to keep
4707 a record that you actually acted on the previous instance of this deadline.
4709 As a consequence of shifting the base date, this entry will no longer be
4710 visible in the agenda when checking past dates, but all future instances
4713 With the @samp{+1m} cookie, the date shift will always be exactly one
4714 month. So if you have not payed the rent for three months, marking this
4715 entry DONE will still keep it as an overdue deadline. Depending on the
4716 task, this may not be the best way to handle it. For example, if you
4717 forgot to call you father for 3 weeks, it does not make sense to call
4718 him 3 times in a single day to make up for it. Finally, there are tasks
4719 like changing batteries which should always repeat a certain time
4720 @i{after} the last time you did it. For these tasks, Org mode has
4721 special repeaters markers with @samp{++} and @samp{.+}. For example:
4725 DEADLINE: <2008-02-10 Sun ++1w>
4726 Marking this DONE will shift the date by at least one week,
4727 but also by as many weeks as it takes to get this date into
4728 the future. However, it stays on a Sunday, even if you called
4729 and marked it done on Saturday.
4730 ** TODO Check the batteries in the smoke detectors
4731 DEADLINE: <2005-11-01 Tue .+1m>
4732 Marking this DONE will shift the date to one month after
4736 You may have both scheduling and deadline information for a specific
4737 task - just make sure that the repeater intervals on both are the same.
4739 @node Clocking work time, Effort estimates, Deadlines and scheduling, Dates and Times
4740 @section Clocking work time
4742 Org mode allows you to clock the time you spent on specific tasks in a
4743 project. When you start working on an item, you can start the clock.
4744 When you stop working on that task, or when you mark the task done, the
4745 clock is stopped and the corresponding time interval is recorded. It
4746 also computes the total time spent on each subtree of a project.
4751 Start the clock on the current item (clock-in). This inserts the CLOCK
4752 keyword together with a timestamp. If this is not the first clocking of
4753 this item, the multiple CLOCK lines will be wrapped into a
4754 @code{:CLOCK:} drawer (see also the variable
4755 @code{org-clock-into-drawer}). When called with a @kbd{C-u} prefix argument,
4756 select the task from a list of recently clocked tasks. With two @kbd{C-u
4757 C-u} prefixes, clock into the task at point and mark it as the default task.
4758 The default task will always be available when selecting a clocking task,
4759 with letter @kbd{d}.
4762 Stop the clock (clock-out). The inserts another timestamp at the same
4763 location where the clock was last started. It also directly computes
4764 the resulting time in inserts it after the time range as @samp{=>
4765 HH:MM}. See the variable @code{org-log-note-clock-out} for the
4766 possibility to record an additional note together with the clock-out
4767 time stamp@footnote{The corresponding in-buffer setting is:
4768 @code{#+STARTUP: lognoteclock-out}}.
4771 Recompute the time interval after changing one of the time stamps. This
4772 is only necessary if you edit the time stamps directly. If you change
4773 them with @kbd{S-@key{cursor}} keys, the update is automatic.
4776 Changing the TODO state of an item to DONE automatically stops the clock
4777 if it is running in this same item.
4780 Cancel the current clock. This is useful if a clock was started by
4781 mistake, or if you ended up working on something else.
4784 Jump to the entry that contains the currently running clock. With a
4785 @kbd{C-u} prefix arg, select the target task from a list of recently clocked
4789 Display time summaries for each subtree in the current buffer. This
4790 puts overlays at the end of each headline, showing the total time
4791 recorded under that heading, including the time of any subheadings. You
4792 can use visibility cycling to study the tree, but the overlays disappear
4793 when you change the buffer (see variable
4794 @code{org-remove-highlights-with-change}) or press @kbd{C-c C-c}.
4797 Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
4798 report as an Org mode table into the current file. When the cursor is
4799 at an existing clock table, just update it. When called with a prefix
4800 argument, jump to the first clock report in the current document and
4802 @cindex #+BEGIN: clocktable
4804 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
4808 If such a block already exists at point, its content is replaced by the
4809 new table. The @samp{BEGIN} line can specify options:
4811 :maxlevel @r{Maximum level depth to which times are listed in the table.}
4812 :emphasize @r{When @code{t}, emphasize level one and level two items}
4813 :scope @r{The scope to consider. This can be any of the following:}
4814 nil @r{the current buffer or narrowed region}
4815 file @r{the full current buffer}
4816 subtree @r{the subtree where the clocktable is located}
4817 treeN @r{the surrounding level N tree, for example @code{tree3}}
4818 tree @r{the surrounding level 1 tree}
4819 agenda @r{all agenda files}
4820 ("file"..) @r{scan these files}
4821 file-with-archives @r{current file and its archives}
4822 agenda-with-archives @r{all agenda files, including archives}
4823 :block @r{The time block to consider. This block is specified either}
4824 @r{absolute, or relative to the current time and may be any of}
4826 2007-12-31 @r{New year eve 2007}
4827 2007-12 @r{December 2007}
4828 2007-W50 @r{ISO-week 50 in 2007}
4829 2007 @r{the year 2007}
4830 today, yesterday, today-N @r{a relative day}
4831 thisweek, lastweek, thisweek-N @r{a relative week}
4832 thismonth, lastmonth, thismonth-N @r{a relative month}
4833 thisyear, lastyear, thisyear-N @r{a relative year}
4834 @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
4835 :tstart @r{A time string specifying when to start considering times}
4836 :tend @r{A time string specifying when to stop considering times}
4837 :step @r{@code{week} or @code{day}, to split the table into chunks.}
4838 @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
4839 :link @r{Link the item headlines in the table to their origins}
4840 :formula @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
4841 @r{As a special case, @samp{:formula %} adds column with % time.}
4842 @r{If you do not specify a formula here, any existing formula}
4843 @r{below the clock table will survive updates and be evaluated.}
4845 So to get a clock summary of the current level 1 tree, for the current
4846 day, you could write
4848 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
4851 and to use a specific time range you could write@footnote{Note that all
4852 parameters must be specified in a single line - the line is broken here
4853 only to fit it onto the manual.}
4855 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
4856 :tend "<2006-08-10 Thu 12:00>"
4859 A summary of the current subtree with % times would be
4861 #+BEGIN: clocktable :scope subtree :link t :formula %
4868 Update dynamical block at point. The cursor needs to be in the
4869 @code{#+BEGIN} line of the dynamic block.
4870 @kindex C-u C-c C-x C-u
4871 @item C-u C-c C-x C-u
4872 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
4873 you have several clock table blocks in a buffer.
4874 @kindex S-@key{left}
4875 @kindex S-@key{right}
4877 @itemx S-@key{right}
4878 Shift the current @code{:block} interval and update the table. The cursor
4879 needs to be in the @code{#+BEGIN: clocktable} line for this command. If
4880 @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
4883 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
4884 the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
4885 worked on or closed during a day.
4887 @node Effort estimates, , Clocking work time, Dates and Times
4888 @section Effort estimates
4889 @cindex Effort estimates
4891 If you want to plan your work in a very detailed way, or if you need to
4892 produce offers with quotations of the estimated work effort, you may want to
4893 assign effort estimates to entries. If you are also clocking your work, you
4894 may later want to compare the planned effort with the actual working time, a
4895 great way to improve planning estimates. Effort estimates are stored in a
4896 special property @samp{Effort}@footnote{You may change the property being
4897 used with the variable @code{org-effort-property}.}. Clearly the best way to
4898 work with effort estimates is through column view (@pxref{Column view}). You
4899 should start by setting up discrete values for effort estimates, and a
4900 @code{COLUMNS} format that displays these values together with clock sums (if
4901 you want to clock your time). For a specific buffer you can use
4904 #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00
4905 #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
4909 or, even better, you can set up these values globally by customizing the
4910 variables @code{org-global-properties} and @code{org-columns-default-format}.
4911 In particular if you want to use this setup also in the agenda, a global
4912 setup may be advised.
4914 The way to assign estimates to individual items is then to switch to column
4915 mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
4916 value. The values you enter will immediately be summed up in the hierarchy.
4917 In the column next to it, any clocked time will be displayed.
4919 If you switch to column view in the daily/weekly agenda, the effort column
4920 will summarize the estimated work effort for each day@footnote{Please note
4921 the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
4922 column view}).}, and you can use this to find space in your schedule. To get
4923 an overview of the entire part of the day that is committed, you can set the
4924 option @code{org-agenda-columns-add-appointments-to-effort-sum}. The
4925 appointments on a day that take place over a specified time interval will
4926 then also be added to the load estimate of the day.
4928 Effort estimates can be used in secondary agenda filtering that is triggered
4929 with the @kbd{/} key in the agenda (@pxref{Agenda commands}). If you have
4930 these estimates defined consistently, two or three key presses will narrow
4931 down the list to stuff that fits into an available time slot.
4933 @node Capture, Agenda Views, Dates and Times, Top
4937 An important part of any organization system is the ability to quickly
4938 capture new ideas and tasks, and to associate reference material with them.
4939 Org uses the @file{remember} package to create tasks, and stores files
4940 related to a task (@i{attachments}) in a special directory.
4943 * Remember:: Capture new tasks/ideas with little interruption
4944 * Attachments:: Add files to tasks.
4947 @node Remember, Attachments, Capture, Capture
4949 @cindex @file{remember.el}
4951 The @i{Remember} package by John Wiegley lets you store quick notes with
4952 little interruption of your work flow. See
4953 @uref{http://www.emacswiki.org/cgi-bin/wiki/RememberMode} for more
4954 information. It is an excellent way to add new notes and tasks to
4955 Org files. Org significantly expands the possibilities of
4956 @i{remember}: You may define templates for different note types, and
4957 associate target files and headlines with specific templates. It also
4958 allows you to select the location where a note should be stored
4959 interactively, on the fly.
4962 * Setting up Remember:: Some code for .emacs to get things going
4963 * Remember templates:: Define the outline of different note types
4964 * Storing notes:: Directly get the note to where it belongs
4965 * Refiling notes:: Moving a note or task to a project
4968 @node Setting up Remember, Remember templates, Remember, Remember
4969 @subsection Setting up Remember
4971 The following customization will tell @i{remember} to use org files as
4972 target, and to create annotations compatible with Org links.
4975 (org-remember-insinuate)
4976 (setq org-directory "~/path/to/my/orgfiles/")
4977 (setq org-default-notes-file (concat org-directory "/notes.org"))
4978 (define-key global-map "\C-cr" 'org-remember)
4981 The last line binds the command @code{org-remember} to a global
4982 key@footnote{Please select your own key, @kbd{C-c r} is only a
4983 suggestion.}. @code{org-remember} basically just calls @code{remember},
4984 but it makes a few things easier: If there is an active region, it will
4985 automatically copy the region into the remember buffer. It also allows
4986 to jump to the buffer and location where remember notes are being
4987 stored: Just call @code{org-remember} with a prefix argument. If you
4988 use two prefix arguments, Org jumps to the location where the last
4989 remember note was stored.
4991 The remember buffer will actually use @code{org-mode} as its major mode, so
4992 that all editing features of Org-mode are available. In addition to this, a
4993 minor mode @code{org-remember-mode} is turned on, for the single purpose that
4994 you can use its keymap @code{org-remember-mode-map} to overwrite some of
4995 Org-mode's key bindings.
4997 You can also call @code{org-remember} in a special way from the agenda,
4998 using the @kbd{k r} key combination. With this access, any time stamps
4999 inserted by the selected remember template (see below) will default to
5000 the cursor date in the agenda, rather than to the current date.
5002 @node Remember templates, Storing notes, Setting up Remember, Remember
5003 @subsection Remember templates
5004 @cindex templates, for remember
5006 In combination with Org, you can use templates to generate
5007 different types of @i{remember} notes. For example, if you would like
5008 to use one template to create general TODO entries, another one for
5009 journal entries, and a third one for collecting random ideas, you could
5013 (setq org-remember-templates
5014 '(("Todo" ?t "* TODO %?\n %i\n %a" "~/org/TODO.org" "Tasks")
5015 ("Journal" ?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org")
5016 ("Idea" ?i "* %^@{Title@}\n %i\n %a" "~/org/JOURNAL.org" "New Ideas")))
5019 @noindent In these entries, the first string is just a name, and the
5020 character specifies how to select the template. It is useful if the
5021 character is also the first letter of the name. The next string specifies
5022 the template. Two more (optional) strings give the file in which, and the
5023 headline under which the new note should be stored. The file (if not present
5024 or @code{nil}) defaults to @code{org-default-notes-file}, the heading to
5025 @code{org-remember-default-headline}. If the file name is not an absolute
5026 path, it will be interpreted relative to @code{org-directory}. The heading
5027 can also be the symbols @code{top} or @code{bottom} to send note as level 1
5028 entries to the beginning or end of the file, respectively.
5030 An optional sixth element specifies the contexts in which the user can select
5031 the template. This element can be a list of major modes or a function.
5032 @code{org-remember} will first check whether the function returns @code{t} or
5033 if we are in any of the listed major mode, and exclude templates fo which
5034 this condition is not fulfilled. Templates that do not specify this element
5035 at all, or that use @code{nil} or @code{t} as a value will always be
5041 (setq org-remember-templates
5042 '(("Bug" ?b "* BUG %?\n %i\n %a" "~/org/BUGS.org" "Bugs" (emacs-lisp-mode))
5043 ("Journal" ?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org" "X" my-check)
5044 ("Idea" ?i "* %^@{Title@}\n %i\n %a" "~/org/JOURNAL.org" "New Ideas")))
5047 The first template will only be available when invoking @code{org-remember}
5048 from an buffer in @code{emacs-lisp-mode}. The second template will only be
5049 available when the function @code{my-check} returns @code{t}. The third
5050 template will be proposed in any context.
5052 When you call @kbd{M-x org-remember} (or @kbd{M-x remember}) to remember
5053 something, Org will prompt for a key to select the template (if you have
5054 more than one template) and then prepare the buffer like
5057 [[file:link to where you called remember]]
5061 During expansion of the template, special @kbd{%}-escapes allow dynamic
5062 insertion of content:
5064 %^@{prompt@} @r{prompt the user for a string and replace this sequence with it.}
5065 @r{You may specify a default value and a completion table with}
5066 @r{%^@{prompt|default|completion2|completion3...@}}
5067 @r{The arrow keys access a prompt-specific history.}
5068 %a @r{annotation, normally the link created with @code{org-store-link}}
5069 %A @r{like @code{%a}, but prompt for the description part}
5070 %i @r{initial content, the region when remember is called with C-u.}
5071 @r{The entire text will be indented like @code{%i} itself.}
5072 %t @r{time stamp, date only}
5073 %T @r{time stamp with date and time}
5074 %u, %U @r{like the above, but inactive time stamps}
5075 %^t @r{like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}}
5076 @r{You may define a prompt like @code{%^@{Birthday@}t}}
5077 %n @r{user name (taken from @code{user-full-name})}
5078 %c @r{Current kill ring head.}
5079 %x @r{Content of the X clipboard.}
5080 %^C @r{Interactive selection of which kill or clip to use.}
5081 %^L @r{Like @code{%^C}, but insert as link.}
5082 %^g @r{prompt for tags, with completion on tags in target file.}
5083 %k @r{title of currently clocked task}
5084 %K @r{link to currently clocked task}
5085 %^G @r{prompt for tags, with completion all tags in all agenda files.}
5086 %^@{prop@}p @r{Prompt the user for a value for property @code{prop}}
5087 %:keyword @r{specific information for certain link types, see below}
5088 %[pathname] @r{insert the contents of the file given by @code{pathname}}
5089 %(sexp) @r{evaluate elisp @code{(sexp)} and replace with the result}
5090 %! @r{immediately store note after completing the template}
5091 @r{(skipping the @kbd{C-c C-c} that normally triggers storing)}
5092 %& @r{jump to target location immediately after storing note}
5096 For specific link types, the following keywords will be
5097 defined@footnote{If you define your own link types (@pxref{Adding
5098 hyperlink types}), any property you store with
5099 @code{org-store-link-props} can be accessed in remember templates in a
5103 Link type | Available keywords
5104 -------------------+----------------------------------------------
5105 bbdb | %:name %:company
5106 bbdb | %::server %:port %:nick
5107 vm, wl, mh, rmail | %:type %:subject %:message-id
5108 | %:from %:fromname %:fromaddress
5109 | %:to %:toname %:toaddress
5110 | %: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}.}}
5111 gnus | %:group, @r{for messages also all email fields}
5113 info | %:file %:node
5118 To place the cursor after template expansion use:
5121 %? @r{After completing the template, position cursor here.}
5125 If you change your mind about which template to use, call
5126 @code{org-remember} in the remember buffer. You may then select a new
5127 template that will be filled with the previous context information.
5129 @node Storing notes, Refiling notes, Remember templates, Remember
5130 @subsection Storing notes
5132 When you are finished preparing a note with @i{remember}, you have to press
5133 @kbd{C-c C-c} to file the note away. If you have started the clock in the
5134 remember buffer, you will first be asked if you want to clock out
5135 now@footnote{To avoid this query, configure the variable
5136 @code{org-remember-clock-out-on-exit}.}. If you answer @kbd{n}, the clock
5137 will continue to run after the note was filed away.
5139 The handler will then store the note in the file and under the headline
5140 specified in the template, or it will use the default file and headlines.
5141 The window configuration will be restored, sending you back to the working
5142 context before the call to @code{remember}. To re-use the location found
5143 during the last call to @code{remember}, exit the remember buffer with
5144 @kbd{C-0 C-c C-c}, i.e. specify a zero prefix argument to @kbd{C-c C-c}.
5145 Another special case is @kbd{C-2 C-c C-c} which files the note as a child of
5146 the currently clocked item.
5148 If you want to store the note directly to a different place, use
5149 @kbd{C-1 C-c C-c} instead to exit remember@footnote{Configure the
5150 variable @code{org-remember-store-without-prompt} to make this behavior
5151 the default.}. The handler will then first prompt for a target file -
5152 if you press @key{RET}, the value specified for the template is used.
5153 Then the command offers the headings tree of the selected file, with the
5154 cursor position at the default headline (if you had specified one in the
5155 template). You can either immediately press @key{RET} to get the note
5156 placed there. Or you can use the following keys to find a different
5159 @key{TAB} @r{Cycle visibility.}
5160 @key{down} / @key{up} @r{Next/previous visible headline.}
5161 n / p @r{Next/previous visible headline.}
5162 f / b @r{Next/previous headline same level.}
5164 @c 0-9 @r{Digit argument.}
5167 Pressing @key{RET} or @key{left} or @key{right}
5168 then leads to the following result.
5170 @multitable @columnfractions 0.2 0.15 0.65
5171 @item @b{Cursor position} @tab @b{Key} @tab @b{Note gets inserted}
5172 @item on headline @tab @key{RET} @tab as sublevel of the heading at cursor, first or last
5173 @item @tab @tab depending on @code{org-reverse-note-order}.
5174 @item @tab @key{left}/@key{right} @tab as same level, before/after current heading
5175 @item buffer-start @tab @key{RET} @tab as level 2 heading at end of file or level 1 at beginning
5176 @item @tab @tab depending on @code{org-reverse-note-order}.
5177 @item not on headline @tab @key{RET}
5178 @tab at cursor position, level taken from context.
5181 Before inserting the text into a tree, the function ensures that the text has
5182 a headline, i.e. a first line that starts with a @samp{*}. If not, a
5183 headline is constructed from the current date. If you have indented the text
5184 of the note below the headline, the indentation will be adapted if inserting
5185 the note into the tree requires demotion from level 1.
5187 @node Refiling notes, , Storing notes, Remember
5188 @subsection Refiling notes
5189 @cindex refiling notes
5191 Remember is usually used to quickly capture notes and tasks into one or
5192 a few capture lists. When reviewing the captured data, you may want to
5193 refile some of the entries into a different list, for example into a
5194 project. Cutting, finding the right location and then pasting the note
5195 is cumbersome. To simplify this process, you can use the following
5201 Refile the entry or region at point. This command offers possible locations
5202 for refiling the entry and lets you select one with completion. The item (or
5203 all items in the region) is filed below the target heading as a subitem.
5204 Depending on @code{org-reverse-note-order}, it will be either the first of
5206 By default, all level 1 headlines in the current buffer are considered to be
5207 targets, but you can have more complex definitions across a number of files.
5208 See the variable @code{org-refile-targets} for details. If you would like to
5209 select a location via a file-pathlike completion along the outline path, see
5210 the variable @code{org-refile-use-outline-path}.
5213 Use the refile interface to jump to a heading.
5214 @kindex C-u C-u C-c C-w
5215 @item C-u C-u C-c C-w
5216 Jump to the location where @code{org-refile} last moved a tree to.
5219 @node Attachments, , Remember, Capture
5220 @section Attachments
5223 It is often useful to associate reference material with an outline node/task.
5224 Small chunks of plain text can simply be stored in the subtree of a project.
5225 Hyperlinks (@pxref{Hyperlinks}) can be used to establish associations with
5226 files that live elsewhere on your computer or in the cloud, like emails or
5227 source code files belonging to a project. Another method is @i{attachments},
5228 which are files located in a directory belonging to an outline node. Org
5229 uses directories named by the unique ID of each entry. These directories are
5230 located in the @file{data} directory which lives in the same directory where
5231 your org-file lives@footnote{If you move entries or Org-files from one
5232 directory to the next, you may want to configure @code{org-attach-directory}
5233 to contain an absolute path.}. If you initialize this directory with
5234 @code{git-init}, Org will automatically commit changes when it sees them.
5235 The attachment system has been contributed to Org by John Wiegley.
5237 @noindent The following commands deal with attachments.
5243 The dispatcher for commands related to the attachment system. After these
5244 keys, a list of commands is displayed and you need to press an additional key
5245 to select a command:
5250 Select a file and move it into the task's attachment directory. The file
5251 will be copied, moved, or linked, depending on @code{org-attach-method}.
5252 Note that hard links are not supported on all systems.
5258 Attach a file using the copy/move/link method.
5259 Note that hard links are not supported on all systems.
5263 Create a new attachment as an Emacs buffer.
5267 Synchronize the current task with its attachment directory, in case you added
5268 attachments yourself.
5272 Open current task's attachment. If there are more than one, prompt for a
5273 file name first. Opening will follow the rules set by @code{org-file-apps}.
5274 For more details, see the information on following hyperlings
5275 (@pxref{Handling links}).
5279 Also open the attachment, but force opening the file in Emacs.
5283 Open the current task's attachment directory.
5287 Also open the directory, but force using @code{dired} in Emacs.
5291 Select and delete a single attachment.
5295 Delete all of a task's attachments. A safer way is to open the directory in
5296 dired and delete from there.
5300 @node Agenda Views, Embedded LaTeX, Capture, Top
5301 @chapter Agenda Views
5302 @cindex agenda views
5304 Due to the way Org works, TODO items, time-stamped items, and
5305 tagged headlines can be scattered throughout a file or even a number of
5306 files. To get an overview of open action items, or of events that are
5307 important for a particular date, this information must be collected,
5308 sorted and displayed in an organized way.
5310 Org can select items based on various criteria, and display them
5311 in a separate buffer. Seven different view types are provided:
5315 an @emph{agenda} that is like a calendar and shows information
5318 a @emph{TODO list} that covers all unfinished
5321 a @emph{match view}, showings headlines based on the tags, properties and
5322 TODO state associated with them,
5324 a @emph{timeline view} that shows all events in a single Org file,
5325 in time-sorted view,
5327 a @emph{keyword search view} that shows all entries from multiple files
5328 that contain specified keywords.
5330 a @emph{stuck projects view} showing projects that currently don't move
5333 @emph{custom views} that are special tag/keyword searches and
5334 combinations of different views.
5338 The extracted information is displayed in a special @emph{agenda
5339 buffer}. This buffer is read-only, but provides commands to visit the
5340 corresponding locations in the original Org files, and even to
5341 edit these files remotely.
5343 Two variables control how the agenda buffer is displayed and whether the
5344 window configuration is restored when the agenda exits:
5345 @code{org-agenda-window-setup} and
5346 @code{org-agenda-restore-windows-after-quit}.
5349 * Agenda files:: Files being searched for agenda information
5350 * Agenda dispatcher:: Keyboard access to agenda views
5351 * Built-in agenda views:: What is available out of the box?
5352 * Presentation and sorting:: How agenda items are prepared for display
5353 * Agenda commands:: Remote editing of Org trees
5354 * Custom agenda views:: Defining special searches and views
5355 * Agenda column view:: Using column view for collected entries
5358 @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views
5359 @section Agenda files
5360 @cindex agenda files
5361 @cindex files for agenda
5363 The information to be shown is normally collected from all @emph{agenda
5364 files}, the files listed in the variable
5365 @code{org-agenda-files}@footnote{If the value of that variable is not a
5366 list, but a single file name, then the list of agenda files will be
5367 maintained in that external file.}. If a directory is part of this list,
5368 all files with the extension @file{.org} in this directory will be part
5371 Thus even if you only work with a single Org file, this file should
5372 be put into that list@footnote{When using the dispatcher, pressing
5373 @kbd{<} before selecting a command will actually limit the command to
5374 the current file, and ignore @code{org-agenda-files} until the next
5375 dispatcher command.}. You can customize @code{org-agenda-files}, but
5376 the easiest way to maintain it is through the following commands
5378 @cindex files, adding to agenda list
5382 Add current file to the list of agenda files. The file is added to
5383 the front of the list. If it was already in the list, it is moved to
5384 the front. With a prefix argument, file is added/moved to the end.
5387 Remove current file from the list of agenda files.
5392 Cycle through agenda file list, visiting one file after the other.
5393 @kindex M-x org-iswitchb
5394 @item M-x org-iswitchb
5395 Command to use an @code{iswitchb}-like interface to switch to and between Org
5400 The Org menu contains the current list of files and can be used
5401 to visit any of them.
5403 If you would like to focus the agenda temporarily onto a file not in
5404 this list, or onto just one file in the list or even only a subtree in a
5405 file, this can be done in different ways. For a single agenda command,
5406 you may press @kbd{<} once or several times in the dispatcher
5407 (@pxref{Agenda dispatcher}). To restrict the agenda scope for an
5408 extended period, use the following commands:
5413 Permanently restrict the agenda to the current subtree. When with a
5414 prefix argument, or with the cursor before the first headline in a file,
5415 the agenda scope is set to the entire file. This restriction remains in
5416 effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
5417 or @kbd{>} in the agenda dispatcher. If there is a window displaying an
5418 agenda view, the new restriction takes effect immediately.
5421 Remove the permanent restriction created by @kbd{C-c C-x <}.
5425 When working with @file{Speedbar}, you can use the following commands in
5429 @item < @r{in the speedbar frame}
5430 Permanently restrict the agenda to the item at the cursor in the
5431 Speedbar frame, either an Org file or a subtree in such a file.
5432 If there is a window displaying an agenda view, the new restriction takes
5435 @item > @r{in the speedbar frame}
5436 Lift the restriction again.
5439 @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views
5440 @section The agenda dispatcher
5441 @cindex agenda dispatcher
5442 @cindex dispatching agenda commands
5443 The views are created through a dispatcher that should be bound to a
5444 global key, for example @kbd{C-c a} (@pxref{Installation}). In the
5445 following we will assume that @kbd{C-c a} is indeed how the dispatcher
5446 is accessed and list keyboard access to commands accordingly. After
5447 pressing @kbd{C-c a}, an additional letter is required to execute a
5448 command. The dispatcher offers the following default commands:
5451 Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
5453 Create a list of all TODO items (@pxref{Global TODO list}).
5455 Create a list of headlines matching a TAGS expression (@pxref{Matching
5456 tags and properties}).
5458 Create the timeline view for the current buffer (@pxref{Timeline}).
5460 Create a list of entries selected by a boolean expression of keywords
5461 and/or regular expressions that must or must not occur in the entry.
5463 Search for a regular expression in all agenda files and additionally in
5464 the files listed in @code{org-agenda-multi-occur-extra-files}. This
5465 uses the Emacs command @code{multi-occur}. A prefix argument can be
5466 used to specify the number of context lines for each match, default is
5469 Create a list of stuck projects (@pxref{Stuck projects}).
5471 Restrict an agenda command to the current buffer@footnote{For backward
5472 compatibility, you can also press @kbd{1} to restrict to the current
5473 buffer.}. After pressing @kbd{<}, you still need to press the character
5474 selecting the command.
5476 If there is an active region, restrict the following agenda command to
5477 the region. Otherwise, restrict it to the current subtree@footnote{For
5478 backward compatibility, you can also press @kbd{0} to restrict to the
5479 current buffer.}. After pressing @kbd{< <}, you still need to press the
5480 character selecting the command.
5483 You can also define custom commands that will be accessible through the
5484 dispatcher, just like the default commands. This includes the
5485 possibility to create extended agenda buffers that contain several
5486 blocks together, for example the weekly agenda, the global TODO list and
5487 a number of special tags matches. @xref{Custom agenda views}.
5489 @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda Views
5490 @section The built-in agenda views
5492 In this section we describe the built-in views.
5495 * Weekly/daily agenda:: The calendar page with current tasks
5496 * Global TODO list:: All unfinished action items
5497 * Matching tags and properties:: Structured information with fine-tuned search
5498 * Timeline:: Time-sorted view for single file
5499 * Keyword search:: Finding entries by keyword
5500 * Stuck projects:: Find projects you need to review
5503 @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views
5504 @subsection The weekly/daily agenda
5506 @cindex weekly agenda
5507 @cindex daily agenda
5509 The purpose of the weekly/daily @emph{agenda} is to act like a page of a
5510 paper agenda, showing all the tasks for the current week or day.
5513 @cindex org-agenda, command
5516 Compile an agenda for the current week from a list of org files. The agenda
5517 shows the entries for each day. With a numeric prefix@footnote{For backward
5518 compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
5519 listed before the agenda. This feature is deprecated, use the dedicated TODO
5520 list, or a block agenda instead (@pxref{Block agenda}).} (like @kbd{C-u 2 1
5521 C-c a a}) you may set the number of days to be displayed (see also the
5522 variable @code{org-agenda-ndays})
5525 Remote editing from the agenda buffer means, for example, that you can
5526 change the dates of deadlines and appointments from the agenda buffer.
5527 The commands available in the Agenda buffer are listed in @ref{Agenda
5530 @subsubheading Calendar/Diary integration
5531 @cindex calendar integration
5532 @cindex diary integration
5534 Emacs contains the calendar and diary by Edward M. Reingold. The
5535 calendar displays a three-month calendar with holidays from different
5536 countries and cultures. The diary allows you to keep track of
5537 anniversaries, lunar phases, sunrise/set, recurrent appointments
5538 (weekly, monthly) and more. In this way, it is quite complementary to
5539 Org. It can be very useful to combine output from Org with
5542 In order to include entries from the Emacs diary into Org mode's
5543 agenda, you only need to customize the variable
5546 (setq org-agenda-include-diary t)
5549 @noindent After that, everything will happen automatically. All diary
5550 entries including holidays, anniversaries etc will be included in the
5551 agenda buffer created by Org mode. @key{SPC}, @key{TAB}, and
5552 @key{RET} can be used from the agenda buffer to jump to the diary
5553 file in order to edit existing diary entries. The @kbd{i} command to
5554 insert new entries for the current date works in the agenda buffer, as
5555 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
5556 Sunrise/Sunset times, show lunar phases and to convert to other
5557 calendars, respectively. @kbd{c} can be used to switch back and forth
5558 between calendar and agenda.
5560 If you are using the diary only for sexp entries and holidays, it is
5561 faster to not use the above setting, but instead to copy or even move
5562 the entries into an Org file. Org mode evaluates diary-style sexp
5563 entries, and does it faster because there is no overhead for first
5564 creating the diary display. Note that the sexp entries must start at
5565 the left margin, no white space is allowed before them. For example,
5566 the following segment of an Org file will be processed and entries
5567 will be made in the agenda:
5570 * Birthdays and similar stuff
5572 %%(org-calendar-holiday) ; special function for holiday names
5574 %%(diary-anniversary 14 5 1956) Arthur Dent is %d years old
5575 %%(diary-anniversary 2 10 1869) Mahatma Gandhi would be %d years old
5578 @subsubheading Appointment reminders
5579 @cindex @file{appt.el}
5580 @cindex appointment reminders
5582 Org can interact with Emacs appointments notification facility.
5584 To add all the appointments of your agenda files, use the command
5585 @code{org-agenda-to-appt}. This commands also lets you filter through
5586 the list of your appointments and add only those belonging to a specific
5587 category or matching a regular expression. See the docstring for
5590 @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views
5591 @subsection The global TODO list
5592 @cindex global TODO list
5593 @cindex TODO list, global
5595 The global TODO list contains all unfinished TODO items, formatted and
5596 collected into a single place.
5601 Show the global TODO list. This collects the TODO items from all
5602 agenda files (@pxref{Agenda Views}) into a single buffer. The buffer is in
5603 @code{agenda-mode}, so there are commands to examine and manipulate
5604 the TODO entries directly from that buffer (@pxref{Agenda commands}).
5607 @cindex TODO keyword matching
5608 Like the above, but allows selection of a specific TODO keyword. You
5609 can also do this by specifying a prefix argument to @kbd{C-c a t}. With
5610 a @kbd{C-u} prefix you are prompted for a keyword, and you may also
5611 specify several keywords by separating them with @samp{|} as boolean OR
5612 operator. With a numeric prefix, the Nth keyword in
5613 @code{org-todo-keywords} is selected.
5615 The @kbd{r} key in the agenda buffer regenerates it, and you can give
5616 a prefix argument to this command to change the selected TODO keyword,
5617 for example @kbd{3 r}. If you often need a search for a specific
5618 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
5619 Matching specific TODO keywords can also be done as part of a tags
5620 search (@pxref{Tag searches}).
5623 Remote editing of TODO items means that you can change the state of a
5624 TODO entry with a single key press. The commands available in the
5625 TODO list are described in @ref{Agenda commands}.
5627 @cindex sublevels, inclusion into TODO list
5628 Normally the global TODO list simply shows all headlines with TODO
5629 keywords. This list can become very long. There are two ways to keep
5633 Some people view a TODO item that has been @emph{scheduled} for
5634 execution (@pxref{Timestamps}) as no longer @emph{open}. Configure the
5635 variable @code{org-agenda-todo-ignore-scheduled} to exclude scheduled
5636 items from the global TODO list.
5638 TODO items may have sublevels to break up the task into subtasks. In
5639 such cases it may be enough to list only the highest level TODO headline
5640 and omit the sublevels from the global list. Configure the variable
5641 @code{org-agenda-todo-list-sublevels} to get this behavior.
5644 @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views
5645 @subsection Matching tags and properties
5646 @cindex matching, of tags
5647 @cindex matching, of properties
5651 If headlines in the agenda files are marked with @emph{tags}
5652 (@pxref{Tags}), you can select headlines based on the tags that apply
5653 to them and collect them into an agenda buffer.
5658 Produce a list of all headlines that match a given set of tags. The
5659 command prompts for a selection criterion, which is a boolean logic
5660 expression with tags, like @samp{+work+urgent-withboss} or
5661 @samp{work|home} (@pxref{Tags}). If you often need a specific search,
5662 define a custom command for it (@pxref{Agenda dispatcher}).
5665 Like @kbd{C-c a m}, but only select headlines that are also TODO items
5666 and force checking subitems (see variable
5667 @code{org-tags-match-list-sublevels}). Matching specific TODO keywords
5668 together with a tags match is also possible, see @ref{Tag searches}.
5671 The commands available in the tags list are described in @ref{Agenda
5674 @node Timeline, Keyword search, Matching tags and properties, Built-in agenda views
5675 @subsection Timeline for a single file
5676 @cindex timeline, single file
5677 @cindex time-sorted view
5679 The timeline summarizes all time-stamped items from a single Org mode
5680 file in a @emph{time-sorted view}. The main purpose of this command is
5681 to give an overview over events in a project.
5686 Show a time-sorted view of the org file, with all time-stamped items.
5687 When called with a @kbd{C-u} prefix, all unfinished TODO entries
5688 (scheduled or not) are also listed under the current date.
5692 The commands available in the timeline buffer are listed in
5693 @ref{Agenda commands}.
5695 @node Keyword search, Stuck projects, Timeline, Built-in agenda views
5696 @subsection Keyword search
5697 @cindex keyword search
5698 @cindex searching, for keywords
5700 This agenda view is a general text search facility for Org mode entries.
5701 It is particularly useful to find notes.
5706 This is a special search that lets you select entries by keywords or
5707 regular expression, using a boolean logic. For example, the search
5711 +computer +wifi -ethernet -@{8\.11[bg]@}
5715 will search for note entries that contain the keywords @code{computer}
5716 and @code{wifi}, but not the keyword @code{ethernet}, and which are also
5717 not matched by the regular expression @code{8\.11[bg]}, meaning to
5718 exclude both 8.11b and 8.11g.
5720 Note that in addition to the agenda files, this command will also search
5721 the files listed in @code{org-agenda-text-search-extra-files}.
5724 @node Stuck projects, , Keyword search, Built-in agenda views
5725 @subsection Stuck projects
5727 If you are following a system like David Allen's GTD to organize your
5728 work, one of the ``duties'' you have is a regular review to make sure
5729 that all projects move along. A @emph{stuck} project is a project that
5730 has no defined next actions, so it will never show up in the TODO lists
5731 Org mode produces. During the review, you need to identify such
5732 projects and define next actions for them.
5737 List projects that are stuck.
5740 Customize the variable @code{org-stuck-projects} to define what a stuck
5741 project is and how to find it.
5744 You almost certainly will have to configure this view before it will
5745 work for you. The built-in default assumes that all your projects are
5746 level-2 headlines, and that a project is not stuck if it has at least
5747 one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
5749 Let's assume that you, in your own way of using Org mode, identify
5750 projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
5751 indicate a project that should not be considered yet. Let's further
5752 assume that the TODO keyword DONE marks finished projects, and that NEXT
5753 and TODO indicate next actions. The tag @@SHOP indicates shopping and
5754 is a next action even without the NEXT tag. Finally, if the project
5755 contains the special word IGNORE anywhere, it should not be listed
5756 either. In this case you would start by identifying eligible projects
5757 with a tags/todo match @samp{+PROJECT/-MAYBE-DONE}, and then check for
5758 TODO, NEXT, @@SHOP, and IGNORE in the subtree to identify projects that
5759 are not stuck. The correct customization for this is
5762 (setq org-stuck-projects
5763 '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
5768 @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views
5769 @section Presentation and sorting
5770 @cindex presentation, of agenda items
5772 Before displaying items in an agenda view, Org mode visually prepares
5773 the items and sorts them. Each item occupies a single line. The line
5774 starts with a @emph{prefix} that contains the @emph{category}
5775 (@pxref{Categories}) of the item and other important information. You can
5776 customize the prefix using the option @code{org-agenda-prefix-format}.
5777 The prefix is followed by a cleaned-up version of the outline headline
5778 associated with the item.
5781 * Categories:: Not all tasks are equal
5782 * Time-of-day specifications:: How the agenda knows the time
5783 * Sorting of agenda items:: The order of things
5786 @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting
5787 @subsection Categories
5790 The category is a broad label assigned to each agenda item. By default,
5791 the category is simply derived from the file name, but you can also
5792 specify it with a special line in the buffer, like this@footnote{For
5793 backward compatibility, the following also works: If there are several
5794 such lines in a file, each specifies the category for the text below it.
5795 The first category also applies to any text before the first CATEGORY
5796 line. However, using this method is @emph{strongly} deprecated as it is
5797 incompatible with the outline structure of the document. The correct
5798 method for setting multiple categories in a buffer is using a
5806 If you would like to have a special CATEGORY for a single entry or a
5807 (sub)tree, give the entry a @code{:CATEGORY:} property with the location
5808 as the value (@pxref{Properties and Columns}).
5811 The display in the agenda buffer looks best if the category is not
5812 longer than 10 characters.
5814 @node Time-of-day specifications, Sorting of agenda items, Categories, Presentation and sorting
5815 @subsection Time-of-day specifications
5816 @cindex time-of-day specification
5818 Org mode checks each agenda item for a time-of-day specification. The
5819 time can be part of the time stamp that triggered inclusion into the
5820 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time
5821 ranges can be specified with two time stamps, like
5823 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
5825 In the headline of the entry itself, a time(range) may also appear as
5826 plain text (like @samp{12:45} or a @samp{8:30-1pm}). If the agenda
5827 integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
5828 specifications in diary entries are recognized as well.
5830 For agenda display, Org mode extracts the time and displays it in a
5831 standard 24 hour format as part of the prefix. The example times in
5832 the previous paragraphs would end up in the agenda like this:
5835 8:30-13:00 Arthur Dent lies in front of the bulldozer
5836 12:45...... Ford Prefect arrives and takes Arthur to the pub
5837 19:00...... The Vogon reads his poem
5838 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
5842 If the agenda is in single-day mode, or for the display of today, the
5843 timed entries are embedded in a time grid, like
5846 8:00...... ------------------
5847 8:30-13:00 Arthur Dent lies in front of the bulldozer
5848 10:00...... ------------------
5849 12:00...... ------------------
5850 12:45...... Ford Prefect arrives and takes Arthur to the pub
5851 14:00...... ------------------
5852 16:00...... ------------------
5853 18:00...... ------------------
5854 19:00...... The Vogon reads his poem
5855 20:00...... ------------------
5856 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
5859 The time grid can be turned on and off with the variable
5860 @code{org-agenda-use-time-grid}, and can be configured with
5861 @code{org-agenda-time-grid}.
5863 @node Sorting of agenda items, , Time-of-day specifications, Presentation and sorting
5864 @subsection Sorting of agenda items
5865 @cindex sorting, of agenda items
5866 @cindex priorities, of agenda items
5867 Before being inserted into a view, the items are sorted. How this is
5868 done depends on the type of view.
5871 For the daily/weekly agenda, the items for each day are sorted. The
5872 default order is to first collect all items containing an explicit
5873 time-of-day specification. These entries will be shown at the beginning
5874 of the list, as a @emph{schedule} for the day. After that, items remain
5875 grouped in categories, in the sequence given by @code{org-agenda-files}.
5876 Within each category, items are sorted by priority (@pxref{Priorities}),
5877 which is composed of the base priority (2000 for priority @samp{A}, 1000
5878 for @samp{B}, and 0 for @samp{C}), plus additional increments for
5879 overdue scheduled or deadline items.
5881 For the TODO list, items remain in the order of categories, but within
5882 each category, sorting takes place according to priority
5883 (@pxref{Priorities}).
5885 For tags matches, items are not sorted at all, but just appear in the
5886 sequence in which they are found in the agenda files.
5889 Sorting can be customized using the variable
5890 @code{org-agenda-sorting-strategy}, and may also include criteria based on
5891 the estimated effort of an entry (@pxref{Effort estimates}).
5893 @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda Views
5894 @section Commands in the agenda buffer
5895 @cindex commands, in agenda buffer
5897 Entries in the agenda buffer are linked back to the org file or diary
5898 file where they originate. You are not allowed to edit the agenda
5899 buffer itself, but commands are provided to show and jump to the
5900 original entry location, and to edit the org-files ``remotely'' from
5901 the agenda buffer. In this way, all information is stored only once,
5902 removing the risk that your agenda and note files may diverge.
5904 Some commands can be executed with mouse clicks on agenda lines. For
5905 the other commands, the cursor needs to be in the desired line.
5908 @tsubheading{Motion}
5909 @cindex motion commands in agenda
5912 Next line (same as @key{up} and @kbd{C-p}).
5915 Previous line (same as @key{down} and @kbd{C-n}).
5916 @tsubheading{View/Go to org file}
5921 Display the original location of the item in another window.
5925 Display original location and recenter that window.
5933 Go to the original location of the item in another window. Under Emacs
5934 22, @kbd{mouse-1} will also works for this.
5938 Go to the original location of the item and delete other windows.
5942 Toggle Follow mode. In Follow mode, as you move the cursor through
5943 the agenda buffer, the other window always shows the corresponding
5944 location in the org file. The initial setting for this mode in new
5945 agenda buffers can be set with the variable
5946 @code{org-agenda-start-with-follow-mode}.
5950 Display the entire subtree of the current item in an indirect buffer. With a
5951 numeric prefix argument N, go up to level N and then take that tree. If N is
5952 negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the
5953 previously used indirect buffer.
5957 Toggle Logbook mode. In Logbook mode, entries that where marked DONE while
5958 logging was on (variable @code{org-log-done}) are shown in the agenda, as are
5959 entries that have been clocked on that day. You can configure the entry
5960 types that should be included in log mode using the variable
5961 @code{org-agenda-log-mode-items}. When called with a @kbd{C-u} prefix, show
5962 all possible logbook entries, including state changes. When called with two
5963 prefix args @kbd{C-u C-u}, show only logging information, nothing else.
5967 Toggle Archives mode. In archives mode, trees that are marked are also
5968 scanned when producing the agenda. When you call this command with a
5969 @kbd{C-u} prefix argument, even all archive files are included. To exit
5970 archives mode, press @kbd{v} again.
5974 Toggle Clockreport mode. In clockreport mode, the daily/weekly agenda will
5975 always show a table with the clocked times for the timespan and file scope
5976 covered by the current agenda view. The initial setting for this mode in new
5977 agenda buffers can be set with the variable
5978 @code{org-agenda-start-with-clockreport-mode}.
5980 @tsubheading{Change display}
5981 @cindex display changing, in agenda
5984 Delete other windows.
5991 Switch to day/week/month/year view. When switching to day or week view,
5992 this setting becomes the default for subsequent agenda commands. Since
5993 month and year views are slow to create, they do not become the default.
5994 A numeric prefix argument may be used to jump directly to a specific day
5995 of the year, ISO week, month, or year, respectively. For example,
5996 @kbd{32 d} jumps to February 1st, @kbd{9 w} to ISO week number 9. When
5997 setting day, week, or month view, a year may be encoded in the prefix
5998 argument as well. For example, @kbd{200712 w} will jump to week 12 in
5999 2007. If such a year specification has only one or two digits, it will
6000 be mapped to the interval 1938-2037.
6004 Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}.
6008 Toggle the time grid on and off. See also the variables
6009 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
6013 Recreate the agenda buffer, for example to reflect the changes
6014 after modification of the time stamps of items with S-@key{left} and
6015 S-@key{right}. When the buffer is the global TODO list, a prefix
6016 argument is interpreted to create a selective list for a specific TODO
6026 Save all Org buffers in the current Emacs session.
6030 Display the following @code{org-agenda-ndays} days. For example, if
6031 the display covers a week, switch to the following week. With prefix
6032 arg, go forward that many times @code{org-agenda-ndays} days.
6036 Display the previous dates.
6044 Invoke column view (@pxref{Column view}) in the agenda buffer. The column
6045 view format is taken from the entry at point, or (if there is no entry at
6046 point), from the first entry in the agenda view. So whatever the format for
6047 that entry would be in the original buffer (taken from a property, from a
6048 @code{#+COLUMNS} line, or from the default variable
6049 @code{org-columns-default-format}), will be used in the agenda.
6051 @tsubheading{Secondary filtering and query editing}
6052 @cindex filtering, by tag and effort, in agenda
6053 @cindex tag filtering, in agenda
6054 @cindex effort filtering, in agenda
6055 @cindex query editing, in agenda
6059 Filter the current agenda view with respect to a tag and/or effort estimates.
6060 The difference between this and a custom agenda commands is that filtering is
6061 very fast, so that you can switch quickly between different filters without
6062 having to recreate the agenda.
6064 You will be prompted for a tag selection letter. Pressing @key{TAB} at that
6065 prompt will offer use completion to select a tag (including any tags that do
6066 not have a selection character). The command then hides all entries that do
6067 not contain or inherit this tag. When called with prefix arg, remove the
6068 entries that @emph{do} have the tag. A second @kbd{/} at the prompt will
6069 turn off the filter and unhide any hidden entries. If the first key you
6070 press is either @kbd{+} or @kbd{-}, the previous filter will be narrowed by
6071 requiring or forbidding the selected additional tag. Instead of pressing
6072 @kbd{+} or @kbd{-}, you can also use the @kbd{\} command.
6074 In order to filter for effort estimates, you should set-up allowed
6075 efforts globally, for example
6077 (setq org-global-properties
6078 '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
6080 You can then filter for an effort by first typing an operator, one of @kbd{<},
6081 @kbd{>}, and @kbd{=}, and then the one-digit index of an effort estimate in
6082 your array of allowed values, where @kbd{0} means the 10th value. The filter
6083 will then restrict to entries with effort smaller-or-equal, equal, or
6084 larger-or-equal than the selected value. If the digits 0-9 are not used as
6085 fast access keys to tags, you can also simply press the index digit directly
6086 without an operator. In this case, @kbd{<} will be assumed.
6090 Narrow the current agenda filter by an additional condition. When called with
6091 prefix arg, remove the entries that @emph{do} have the tag, or that do match
6092 the effort criterion. You can achieve the same effect by pressing @kbd{+} or
6093 @kbd{-} as the first key after the @kbd{/} command.
6100 In the @i{search view} (@pxref{Keyword search}), these keys add new search
6101 words (@kbd{[} and @kbd{]}) or new regular expressions (@kbd{@{} and
6102 @kbd{@}}) to the query string. The opening bracket/brace will add a positive
6103 search term prefixed by @samp{+}, indicating that this search term @i{must}
6104 occur/match in the entry. The closing bracket/brace will add a negative
6105 search term which @i{must not} occur/match in the entry for it to be
6109 @tsubheading{Remote editing}
6110 @cindex remote editing, from agenda
6115 @cindex undoing remote-editing events
6116 @cindex remote editing, undo
6119 Undo a change due to a remote editing command. The change is undone
6120 both in the agenda buffer and in the remote buffer.
6124 Change the TODO state of the item, both in the agenda and in the
6129 Delete the current agenda item along with the entire subtree belonging
6130 to it in the original Org file. If the text to be deleted remotely
6131 is longer than one line, the kill needs to be confirmed by the user. See
6132 variable @code{org-agenda-confirm-kill}.
6136 Toggle the ARCHIVE tag for the current headline.
6140 Move the subtree corresponding to the current entry to its @emph{Archive
6145 Archive the subtree corresponding to the current headline. This means the
6146 entry will be moved to the configured archive location, most likely a
6151 Show all tags associated with the current item. Because of
6152 inheritance, this may be more than the tags listed in the line itself.
6156 Set tags for the current headline. If there is an active region in the
6157 agenda, change a tag for all headings in the region.
6161 Set the priority for the current item. Org mode prompts for the
6162 priority character. If you reply with @key{SPC}, the priority cookie
6163 is removed from the entry.
6167 Display weighted priority of current item.
6173 Increase the priority of the current item. The priority is changed in
6174 the original buffer, but the agenda is not resorted. Use the @kbd{r}
6178 @kindex S-@key{down}
6181 Decrease the priority of the current item.
6185 Dispatcher for all command related to attachments.
6193 Set a deadline for this item.
6197 Agenda actions, to set dates for selected items to the cursor date.
6198 This command also works in the calendar! The command prompts for an
6201 m @r{Mark the entry at point for action. You can also make entries}
6202 @r{in Org files with @kbd{C-c C-x C-k}.}
6203 d @r{Set the deadline of the marked entry to the date at point.}
6204 s @r{Schedule the marked entry at the date at point.}
6205 r @r{Call @code{org-remember} with the cursor date as default date.}
6207 Press @kbd{r} afterwards to refresh the agenda and see the effect of the
6210 @kindex S-@key{right}
6212 Change the time stamp associated with the current line by one day into the
6213 future. With a numeric prefix argument, change it by that many days. For
6214 example, @kbd{3 6 5 S-@key{right}} will change it by a year. The stamp is
6215 changed in the original org file, but the change is not directly reflected in
6216 the agenda buffer. Use the @kbd{r} key to update the buffer.
6218 @kindex S-@key{left}
6220 Change the time stamp associated with the current line by one day
6225 Change the time stamp associated with the current line to today.
6226 The key @kbd{>} has been chosen, because it is the same as @kbd{S-.}
6231 Start the clock on the current item. If a clock is running already, it
6236 Stop the previously started clock.
6240 Cancel the currently running clock.
6244 Jump to the running clock in another window.
6246 @tsubheading{Calendar commands}
6247 @cindex calendar commands, from agenda
6250 Open the Emacs calendar and move to the date at the agenda cursor.
6253 When in the calendar, compute and show the Org mode agenda for the
6256 @cindex diary entries, creating from agenda
6259 Insert a new entry into the diary. Prompts for the type of entry
6260 (day, weekly, monthly, yearly, anniversary, cyclic) and creates a new
6261 entry in the diary, just as @kbd{i d} etc. would do in the calendar.
6262 The date is taken from the cursor position.
6266 Show the phases of the moon for the three months around current date.
6270 Show sunrise and sunset times. The geographical location must be set
6271 with calendar variables, see documentation of the Emacs calendar.
6275 Convert the date at cursor into many other cultural and historic
6280 Show holidays for three month around the cursor date.
6282 @item M-x org-export-icalendar-combine-agenda-files
6283 Export a single iCalendar file containing entries from all agenda files.
6284 This is a globally available command, and also available in the agenda menu.
6286 @tsubheading{Exporting to a file}
6289 @cindex exporting agenda views
6290 @cindex agenda views, exporting
6291 Write the agenda view to a file. Depending on the extension of the
6292 selected file name, the view will be exported as HTML (extension
6293 @file{.html} or @file{.htm}), Postscript (extension @file{.ps}), or
6294 plain text (any other extension). Use the variable
6295 @code{org-agenda-exporter-settings} to set options for @file{ps-print}
6296 and for @file{htmlize} to be used during export.
6298 @tsubheading{Quit and Exit}
6301 Quit agenda, remove the agenda buffer.
6304 @cindex agenda files, removing buffers
6306 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
6307 for the compilation of the agenda. Buffers created by the user to
6308 visit org files will not be removed.
6312 @node Custom agenda views, Agenda column view, Agenda commands, Agenda Views
6313 @section Custom agenda views
6314 @cindex custom agenda views
6315 @cindex agenda views, custom
6317 Custom agenda commands serve two purposes: to store and quickly access
6318 frequently used TODO and tags searches, and to create special composite
6319 agenda buffers. Custom agenda commands will be accessible through the
6320 dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
6323 * Storing searches:: Type once, use often
6324 * Block agenda:: All the stuff you need in a single buffer
6325 * Setting Options:: Changing the rules
6326 * Exporting Agenda Views:: Writing agendas to files
6327 * Using the agenda elsewhere:: Using agenda information in other programs
6330 @node Storing searches, Block agenda, Custom agenda views, Custom agenda views
6331 @subsection Storing searches
6333 The first application of custom searches is the definition of keyboard
6334 shortcuts for frequently used searches, either creating an agenda
6335 buffer, or a sparse tree (the latter covering of course only the current
6338 Custom commands are configured in the variable
6339 @code{org-agenda-custom-commands}. You can customize this variable, for
6340 example by pressing @kbd{C-c a C}. You can also directly set it with
6341 Emacs Lisp in @file{.emacs}. The following example contains all valid
6346 (setq org-agenda-custom-commands
6347 '(("w" todo "WAITING")
6348 ("W" todo-tree "WAITING")
6349 ("u" tags "+boss-urgent")
6350 ("v" tags-todo "+boss-urgent")
6351 ("U" tags-tree "+boss-urgent")
6352 ("f" occur-tree "\\<FIXME\\>")
6353 ("h" . "HOME+Name tags searches") ; description for "h" prefix
6354 ("hl" tags "+home+Lisa")
6355 ("hp" tags "+home+Peter")
6356 ("hk" tags "+home+Kim")))
6361 The initial string in each entry defines the keys you have to press
6362 after the dispatcher command @kbd{C-c a} in order to access the command.
6363 Usually this will be just a single character, but if you have many
6364 similar commands, you can also define two-letter combinations where the
6365 first character is the same in several combinations and serves as a
6366 prefix key@footnote{You can provide a description for a prefix key by
6367 inserting a cons cell with the prefix and the description.}. The second
6368 parameter is the search type, followed by the string or regular
6369 expression to be used for the matching. The example above will
6374 as a global search for TODO entries with @samp{WAITING} as the TODO
6377 as the same search, but only in the current buffer and displaying the
6378 results as a sparse tree
6380 as a global tags search for headlines marked @samp{:boss:} but not
6383 as the same search as @kbd{C-c a u}, but limiting the search to
6384 headlines that are also TODO items
6386 as the same search as @kbd{C-c a u}, but only in the current buffer and
6387 displaying the result as a sparse tree
6389 to create a sparse tree (again: current buffer only) with all entries
6390 containing the word @samp{FIXME}
6392 as a prefix command for a HOME tags search where you have to press an
6393 additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
6394 Peter, or Kim) as additional tag to match.
6397 @node Block agenda, Setting Options, Storing searches, Custom agenda views
6398 @subsection Block agenda
6399 @cindex block agenda
6400 @cindex agenda, with block views
6402 Another possibility is the construction of agenda views that comprise
6403 the results of @emph{several} commands, each of which creates a block in
6404 the agenda buffer. The available commands include @code{agenda} for the
6405 daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
6406 for the global TODO list (as constructed with @kbd{C-c a t}), and the
6407 matching commands discussed above: @code{todo}, @code{tags}, and
6408 @code{tags-todo}. Here are two examples:
6412 (setq org-agenda-custom-commands
6413 '(("h" "Agenda and Home-related tasks"
6417 ("o" "Agenda and Office-related tasks"
6425 This will define @kbd{C-c a h} to create a multi-block view for stuff
6426 you need to attend to at home. The resulting agenda buffer will contain
6427 your agenda for the current week, all TODO items that carry the tag
6428 @samp{home}, and also all lines tagged with @samp{garden}. Finally the
6429 command @kbd{C-c a o} provides a similar view for office tasks.
6431 @node Setting Options, Exporting Agenda Views, Block agenda, Custom agenda views
6432 @subsection Setting options for custom commands
6433 @cindex options, for custom agenda views
6435 Org mode contains a number of variables regulating agenda construction
6436 and display. The global variables define the behavior for all agenda
6437 commands, including the custom commands. However, if you want to change
6438 some settings just for a single custom view, you can do so. Setting
6439 options requires inserting a list of variable names and values at the
6440 right spot in @code{org-agenda-custom-commands}. For example:
6444 (setq org-agenda-custom-commands
6445 '(("w" todo "WAITING"
6446 ((org-agenda-sorting-strategy '(priority-down))
6447 (org-agenda-prefix-format " Mixed: ")))
6448 ("U" tags-tree "+boss-urgent"
6449 ((org-show-following-heading nil)
6450 (org-show-hierarchy-above nil)))
6452 ((org-agenda-files '("~org/notes.org"))
6453 (org-agenda-text-search-extra-files nil)))))
6458 Now the @kbd{C-c a w} command will sort the collected entries only by
6459 priority, and the prefix format is modified to just say @samp{ Mixed: }
6460 instead of giving the category of the entry. The sparse tags tree of
6461 @kbd{C-c a U} will now turn out ultra-compact, because neither the
6462 headline hierarchy above the match, nor the headline following the match
6463 will be shown. The command @kbd{C-c a N} will do a text search limited
6464 to only a single file.
6466 For command sets creating a block agenda,
6467 @code{org-agenda-custom-commands} has two separate spots for setting
6468 options. You can add options that should be valid for just a single
6469 command in the set, and options that should be valid for all commands in
6470 the set. The former are just added to the command entry, the latter
6471 must come after the list of command entries. Going back to the block
6472 agenda example (@pxref{Block agenda}), let's change the sorting strategy
6473 for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
6474 the results for GARDEN tags query in the opposite order,
6475 @code{priority-up}. This would look like this:
6479 (setq org-agenda-custom-commands
6480 '(("h" "Agenda and Home-related tasks"
6484 ((org-agenda-sorting-strategy '(priority-up)))))
6485 ((org-agenda-sorting-strategy '(priority-down))))
6486 ("o" "Agenda and Office-related tasks"
6493 As you see, the values and parenthesis setting is a little complex.
6494 When in doubt, use the customize interface to set this variable - it
6495 fully supports its structure. Just one caveat: When setting options in
6496 this interface, the @emph{values} are just lisp expressions. So if the
6497 value is a string, you need to add the double quotes around the value
6501 @node Exporting Agenda Views, Using the agenda elsewhere, Setting Options, Custom agenda views
6502 @subsection Exporting Agenda Views
6503 @cindex agenda views, exporting
6505 If you are away from your computer, it can be very useful to have a
6506 printed version of some agenda views to carry around. Org mode can
6507 export custom agenda views as plain text, HTML@footnote{You need to
6508 install Hrvoje Niksic' @file{htmlize.el}.} postscript, and iCalendar
6509 files. If you want to do this only occasionally, use the command
6514 @cindex exporting agenda views
6515 @cindex agenda views, exporting
6516 Write the agenda view to a file. Depending on the extension of the
6517 selected file name, the view will be exported as HTML (extension
6518 @file{.html} or @file{.htm}), Postscript (extension @file{.ps}),
6519 iCalendar (extension @file{.ics}), or plain text (any other extension).
6520 Use the variable @code{org-agenda-exporter-settings} to
6521 set options for @file{ps-print} and for @file{htmlize} to be used during
6525 (setq org-agenda-exporter-settings
6526 '((ps-number-of-columns 2)
6527 (ps-landscape-mode t)
6528 (htmlize-output-type 'css)))
6532 If you need to export certain agenda views frequently, you can associate
6533 any custom agenda command with a list of output file names
6534 @footnote{If you want to store standard views like the weekly agenda
6535 or the global TODO list as well, you need to define custom commands for
6536 them in order to be able to specify file names.}. Here is an example
6537 that first does define custom commands for the agenda and the global
6538 todo list, together with a number of files to which to export them.
6539 Then we define two block agenda commands and specify file names for them
6540 as well. File names can be relative to the current working directory,
6545 (setq org-agenda-custom-commands
6546 '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
6547 ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
6548 ("h" "Agenda and Home-related tasks"
6553 ("~/views/home.html"))
6554 ("o" "Agenda and Office-related tasks"
6559 ("~/views/office.ps" "~/calendars/office.ics"))))
6563 The extension of the file name determines the type of export. If it is
6564 @file{.html}, Org mode will use the @file{htmlize.el} package to convert
6565 the buffer to HTML and save it to this file name. If the extension is
6566 @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
6567 postscript output. If the extension is @file{.ics}, iCalendar export is
6568 run export over all files that were used to construct the agenda, and
6569 limit the export to entries listed in the agenda now. Any other
6570 extension produces a plain ASCII file.
6572 The export files are @emph{not} created when you use one of those
6573 commands interactively because this might use too much overhead.
6574 Instead, there is a special command to produce @emph{all} specified
6580 Export all agenda views that have export file names associated with
6584 You can use the options section of the custom agenda commands to also
6585 set options for the export commands. For example:
6588 (setq org-agenda-custom-commands
6590 ((ps-number-of-columns 2)
6591 (ps-landscape-mode t)
6592 (org-agenda-prefix-format " [ ] ")
6593 (org-agenda-with-colors nil)
6594 (org-agenda-remove-tags t))
6599 This command sets two options for the postscript exporter, to make it
6600 print in two columns in landscape format - the resulting page can be cut
6601 in two and then used in a paper agenda. The remaining settings modify
6602 the agenda prefix to omit category and scheduling information, and
6603 instead include a checkbox to check off items. We also remove the tags
6604 to make the lines compact, and we don't want to use colors for the
6605 black-and-white printer. Settings specified in
6606 @code{org-agenda-exporter-settings} will also apply, but the settings
6607 in @code{org-agenda-custom-commands} take precedence.
6610 From the command line you may also use
6612 emacs -f org-batch-store-agenda-views -kill
6615 or, if you need to modify some parameters@footnote{Quoting may depend on the
6616 system you use, please check th FAQ for examples.}
6618 emacs -eval '(org-batch-store-agenda-views \
6619 org-agenda-ndays 30 \
6620 org-agenda-start-day "2007-11-01" \
6621 org-agenda-include-diary nil \
6622 org-agenda-files (quote ("~/org/project.org")))' \
6626 which will create the agenda views restricted to the file
6627 @file{~/org/project.org}, without diary entries and with 30 days
6630 @node Using the agenda elsewhere, , Exporting Agenda Views, Custom agenda views
6631 @subsection Using agenda information outside of Org
6632 @cindex agenda, pipe
6633 @cindex Scripts, for agenda processing
6635 Org provides commands to access agenda information for the command
6636 line in emacs batch mode. This extracted information can be sent
6637 directly to a printer, or it can be read by a program that does further
6638 processing of the data. The first of these commands is the function
6639 @code{org-batch-agenda}, that produces an agenda view and sends it as
6640 ASCII text to STDOUT. The command takes a single string as parameter.
6641 If the string has length 1, it is used as a key to one of the commands
6642 you have configured in @code{org-agenda-custom-commands}, basically any
6643 key you can use after @kbd{C-c a}. For example, to directly print the
6644 current TODO list, you could use
6647 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
6650 If the parameter is a string with 2 or more characters, it is used as a
6651 tags/todo match string. For example, to print your local shopping list
6652 (all items with the tag @samp{shop}, but excluding the tag
6653 @samp{NewYork}), you could use
6656 emacs -batch -l ~/.emacs \
6657 -eval '(org-batch-agenda "+shop-NewYork")' | lpr
6661 You may also modify parameters on the fly like this:
6664 emacs -batch -l ~/.emacs \
6665 -eval '(org-batch-agenda "a" \
6666 org-agenda-ndays 30 \
6667 org-agenda-include-diary nil \
6668 org-agenda-files (quote ("~/org/project.org")))' \
6673 which will produce a 30 day agenda, fully restricted to the Org file
6674 @file{~/org/projects.org}, not even including the diary.
6676 If you want to process the agenda data in more sophisticated ways, you
6677 can use the command @code{org-batch-agenda-csv} to get a comma-separated
6678 list of values for each agenda item. Each line in the output will
6679 contain a number of fields separated by commas. The fields in a line
6683 category @r{The category of the item}
6684 head @r{The headline, without TODO kwd, TAGS and PRIORITY}
6685 type @r{The type of the agenda entry, can be}
6686 todo @r{selected in TODO match}
6687 tagsmatch @r{selected in tags match}
6688 diary @r{imported from diary}
6689 deadline @r{a deadline}
6690 scheduled @r{scheduled}
6691 timestamp @r{appointment, selected by timestamp}
6692 closed @r{entry was closed on date}
6693 upcoming-deadline @r{warning about nearing deadline}
6694 past-scheduled @r{forwarded scheduled item}
6695 block @r{entry has date block including date}
6696 todo @r{The TODO keyword, if any}
6697 tags @r{All tags including inherited ones, separated by colons}
6698 date @r{The relevant date, like 2007-2-14}
6699 time @r{The time, like 15:00-16:50}
6700 extra @r{String with extra planning info}
6701 priority-l @r{The priority letter if any was given}
6702 priority-n @r{The computed numerical priority}
6706 Time and date will only be given if a timestamp (or deadline/scheduled)
6707 lead to the selection of the item.
6709 A CSV list like this is very easy to use in a post processing script.
6710 For example, here is a Perl program that gets the TODO list from
6711 Emacs/Org and prints all the items, preceded by a checkbox:
6717 # define the Emacs command to run
6718 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
6720 # run it and capture the output
6721 $agenda = qx@{$cmd 2>/dev/null@};
6723 # loop over all lines
6724 foreach $line (split(/\n/,$agenda)) @{
6726 # get the individual values
6727 ($category,$head,$type,$todo,$tags,$date,$time,$extra,
6728 $priority_l,$priority_n) = split(/,/,$line);
6730 # proccess and print
6731 print "[ ] $head\n";
6736 @node Agenda column view, , Custom agenda views, Agenda Views
6737 @section Using column view in the agenda
6738 @cindex column view, in agenda
6739 @cindex agenda, column view
6741 Column view (@pxref{Column view}) is normally used to view and edit
6742 properties embedded in the hierarchical structure of an Org file. It can be
6743 quite useful to use column view also from the agenda, where entries are
6744 collected by certain criteria.
6749 Turn on column view in the agenda.
6752 To understand how to use this properly, it is important to realize that the
6753 entries in the agenda are no longer in their proper outline environment.
6754 This causes the following issues:
6758 Org needs to make a decision which @code{COLUMNS} format to use. Since the
6759 entries in the agenda are collected from different files, and different files
6760 may have different @code{COLUMNS} formats, this is a non-trivial problem.
6761 Org first checks if the variable @code{org-overriding-columns-format} is
6762 currently set, and if yes takes the format from there. Otherwise it takes
6763 the format associated with the first item in the agenda, or, if that item
6764 does not have a specific format (defined in a property, or in it's file), it
6765 uses @code{org-columns-default-format}.
6767 If any of the columns has a summary type defined (@pxref{Column attributes}),
6768 turning on column view in the agenda will visit all relevant agenda files and
6769 make sure that the computations of this property are up to date. This is
6770 also true for the special @code{CLOCKSUM} property. Org will then sum the
6771 values displayed in the agenda. In the daily/weekly agenda, the sums will
6772 cover a single day, in all other views they cover the entire block. It is
6773 vital to realize that the agenda may show the same entry @emph{twice} (for
6774 example as scheduled and as a deadline), and it may show two entries from the
6775 same hierarchy (for example a @emph{parent} and it's @emph{child}). In these
6776 cases, the summation in the agenda will lead to incorrect results because
6777 some values will count double.
6779 When the column view in the agenda shows the @code{CLOCKSUM}, that is always
6780 the entire clocked time for this item. So even in the daily/weekly agenda,
6781 the clocksum listed in column view may originate from times outside the
6782 current view. This has the advantage that you can compare these values with
6783 a column listing the planned total effort for a task - one of the major
6784 applications for column view in the agenda. If you want information about
6785 clocked time in the displayed period use clock table mode (press @kbd{R} in
6790 @node Embedded LaTeX, Exporting, Agenda Views, Top
6791 @chapter Embedded LaTeX
6792 @cindex @TeX{} interpretation
6793 @cindex La@TeX{} interpretation
6795 Plain ASCII is normally sufficient for almost all note taking. One
6796 exception, however, are scientific notes which need to be able to contain
6797 mathematical symbols and the occasional formula. La@TeX{}@footnote{La@TeX{}
6798 is a macro system based on Donald E. Knuth's @TeX{} system. Many of the
6799 features described here as ``La@TeX{}'' are really from @TeX{}, but for
6800 simplicity I am blurring this distinction.} is widely used to typeset
6801 scientific documents. Org mode supports embedding La@TeX{} code into its
6802 files, because many academics are used to reading La@TeX{} source code, and
6803 because it can be readily processed into images for HTML production.
6805 It is not necessary to mark La@TeX{} macros and code in any special way.
6806 If you observe a few conventions, Org mode knows how to find it and what
6810 * Math symbols:: TeX macros for symbols and Greek letters
6811 * Subscripts and superscripts:: Simple syntax for raising/lowering text
6812 * LaTeX fragments:: Complex formulas made easy
6813 * Processing LaTeX fragments:: Previewing LaTeX processing
6814 * CDLaTeX mode:: Speed up entering of formulas
6817 @node Math symbols, Subscripts and superscripts, Embedded LaTeX, Embedded LaTeX
6818 @section Math symbols
6819 @cindex math symbols
6822 You can use La@TeX{} macros to insert special symbols like @samp{\alpha}
6823 to indicate the Greek letter, or @samp{\to} to indicate an arrow.
6824 Completion for these macros is available, just type @samp{\} and maybe a
6825 few letters, and press @kbd{M-@key{TAB}} to see possible completions.
6826 Unlike La@TeX{} code, Org mode allows these macros to be present
6827 without surrounding math delimiters, for example:
6830 Angles are written as Greek letters \alpha, \beta and \gamma.
6833 During HTML export (@pxref{HTML export}), these symbols are translated
6834 into the proper syntax for HTML, for the above examples this is
6835 @samp{α} and @samp{→}, respectively. If you need such a symbol
6836 inside a word, terminate it like this: @samp{\Aacute@{@}stor}.
6838 @node Subscripts and superscripts, LaTeX fragments, Math symbols, Embedded LaTeX
6839 @section Subscripts and superscripts
6843 Just like in La@TeX{}, @samp{^} and @samp{_} are used to indicate super-
6844 and subscripts. Again, these can be used without embedding them in
6845 math-mode delimiters. To increase the readability of ASCII text, it is
6846 not necessary (but OK) to surround multi-character sub- and superscripts
6847 with curly braces. For example
6850 The mass if the sun is M_sun = 1.989 x 10^30 kg. The radius of
6851 the sun is R_@{sun@} = 6.96 x 10^8 m.
6854 To avoid interpretation as raised or lowered text, you can quote
6855 @samp{^} and @samp{_} with a backslash: @samp{\_} and @samp{\^}.
6857 During HTML export (@pxref{HTML export}), subscript and superscripts
6858 are surrounded with @code{<sub>} and @code{<sup>} tags, respectively.
6860 @node LaTeX fragments, Processing LaTeX fragments, Subscripts and superscripts, Embedded LaTeX
6861 @section LaTeX fragments
6862 @cindex LaTeX fragments
6864 With symbols, sub- and superscripts, HTML is pretty much at its end when
6865 it comes to representing mathematical formulas@footnote{Yes, there is
6866 MathML, but that is not yet fully supported by many browsers, and there
6867 is no decent converter for turning La@TeX{} or ASCII representations of
6868 formulas into MathML. So for the time being, converting formulas into
6869 images seems the way to go.}. More complex expressions need a dedicated
6870 formula processor. To this end, Org mode can contain arbitrary La@TeX{}
6871 fragments. It provides commands to preview the typeset result of these
6872 fragments, and upon export to HTML, all fragments will be converted to
6873 images and inlined into the HTML document@footnote{The La@TeX{} export
6874 will not use images for displaying La@TeX{} fragments but include these
6875 fragments directly into the La@TeX{} code.}. For this to work you
6876 need to be on a system with a working La@TeX{} installation. You also
6877 need the @file{dvipng} program, available at
6878 @url{http://sourceforge.net/projects/dvipng/}. The La@TeX{} header that
6879 will be used when processing a fragment can be configured with the
6880 variable @code{org-format-latex-header}.
6882 La@TeX{} fragments don't need any special marking at all. The following
6883 snippets will be identified as La@TeX{} source code:
6886 Environments of any kind. The only requirement is that the
6887 @code{\begin} statement appears on a new line, preceded by only
6890 Text within the usual La@TeX{} math delimiters. To avoid conflicts with
6891 currency specifications, single @samp{$} characters are only recognized
6892 as math delimiters if the enclosed text contains at most two line breaks,
6893 is directly attached to the @samp{$} characters with no whitespace in
6894 between, and if the closing @samp{$} is followed by whitespace or
6895 punctuation. For the other delimiters, there is no such restriction, so
6896 when in doubt, use @samp{\(...\)} as inline math delimiters.
6899 @noindent For example:
6902 \begin@{equation@} % arbitrary environments,
6903 x=\sqrt@{b@} % even tables, figures
6904 \end@{equation@} % etc
6906 If $a^2=b$ and \( b=2 \), then the solution must be
6907 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
6911 If you need any of the delimiter ASCII sequences for other purposes, you
6912 can configure the option @code{org-format-latex-options} to deselect the
6913 ones you do not wish to have interpreted by the La@TeX{} converter.
6915 @node Processing LaTeX fragments, CDLaTeX mode, LaTeX fragments, Embedded LaTeX
6916 @section Processing LaTeX fragments
6917 @cindex LaTeX fragments, preview
6919 La@TeX{} fragments can be processed to produce a preview images of the
6920 typeset expressions:
6925 Produce a preview image of the La@TeX{} fragment at point and overlay it
6926 over the source code. If there is no fragment at point, process all
6927 fragments in the current entry (between two headlines). When called
6928 with a prefix argument, process the entire subtree. When called with
6929 two prefix arguments, or when the cursor is before the first headline,
6930 process the entire buffer.
6933 Remove the overlay preview images.
6936 During HTML export (@pxref{HTML export}), all La@TeX{} fragments are
6937 converted into images and inlined into the document if the following
6941 (setq org-export-with-LaTeX-fragments t)
6944 @node CDLaTeX mode, , Processing LaTeX fragments, Embedded LaTeX
6945 @section Using CDLaTeX to enter math
6948 CDLaTeX mode is a minor mode that is normally used in combination with a
6949 major La@TeX{} mode like AUCTeX in order to speed-up insertion of
6950 environments and math templates. Inside Org mode, you can make use of
6951 some of the features of CDLaTeX mode. You need to install
6952 @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
6953 AUCTeX) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
6954 Don't use CDLaTeX mode itself under Org mode, but use the light
6955 version @code{org-cdlatex-mode} that comes as part of Org mode. Turn it
6956 on for the current buffer with @code{M-x org-cdlatex-mode}, or for all
6960 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
6963 When this mode is enabled, the following features are present (for more
6964 details see the documentation of CDLaTeX mode):
6968 Environment templates can be inserted with @kbd{C-c @{}.
6971 The @key{TAB} key will do template expansion if the cursor is inside a
6972 La@TeX{} fragment@footnote{Org mode has a method to test if the cursor is
6973 inside such a fragment, see the documentation of the function
6974 @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will
6975 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
6976 correctly inside the first brace. Another @key{TAB} will get you into
6977 the second brace. Even outside fragments, @key{TAB} will expand
6978 environment abbreviations at the beginning of a line. For example, if
6979 you write @samp{equ} at the beginning of a line and press @key{TAB},
6980 this abbreviation will be expanded to an @code{equation} environment.
6981 To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}.
6985 Pressing @kbd{_} and @kbd{^} inside a La@TeX{} fragment will insert these
6986 characters together with a pair of braces. If you use @key{TAB} to move
6987 out of the braces, and if the braces surround only a single character or
6988 macro, they are removed again (depending on the variable
6989 @code{cdlatex-simplify-sub-super-scripts}).
6992 Pressing the backquote @kbd{`} followed by a character inserts math
6993 macros, also outside La@TeX{} fragments. If you wait more than 1.5 seconds
6994 after the backquote, a help window will pop up.
6997 Pressing the normal quote @kbd{'} followed by another character modifies
6998 the symbol before point with an accent or a font. If you wait more than
6999 1.5 seconds after the backquote, a help window will pop up. Character
7000 modification will work only inside La@TeX{} fragments, outside the quote
7004 @node Exporting, Publishing, Embedded LaTeX, Top
7008 Org mode documents can be exported into a variety of other formats. For
7009 printing and sharing of notes, ASCII export produces a readable and
7010 simple version of an Org file. HTML export allows you to publish a
7011 notes file on the web, while the XOXO format provides a solid base for
7012 exchange with a broad range of other applications. La@TeX{} export lets
7013 you use Org mode and its structured editing functions to easily create
7014 La@TeX{} files. To incorporate entries with associated times like
7015 deadlines or appointments into a desktop calendar program like iCal,
7016 Org mode can also produce extracts in the iCalendar format. Currently
7017 Org mode only supports export, not import of these different formats.
7020 * Markup rules:: Which structures are recognized?
7021 * Selective export:: Using tags to select and exclude trees
7022 * Export options:: Per-file export settings
7023 * The export dispatcher:: How to access exporter commands
7024 * ASCII export:: Exporting to plain ASCII
7025 * HTML export:: Exporting to HTML
7026 * LaTeX and PDF export:: Exporting to LaTeX, and processing to PDF
7027 * XOXO export:: Exporting to XOXO
7028 * iCalendar export:: Exporting in iCalendar format
7031 @node Markup rules, Selective export, Exporting, Exporting
7032 @section Markup rules
7034 When exporting Org mode documents, the exporter tries to reflect the
7035 structure of the document as accurately as possible in the back-end. Since
7036 export targets like HTML or La@TeX{} allow much richer formatting, Org mode
7037 has rules how to prepare text for rich export. This section summarizes the
7038 markup rule used in an Org mode buffer.
7041 * Document title:: How the document title is determined
7042 * Headings and sections:: The main structure of the exported document
7043 * Table of contents:: If, where, how to create a table of contents
7044 * Initial text:: Text before the first headline
7045 * Lists:: Plain lists are exported
7046 * Paragraphs:: What determines beginning and ending
7047 * Literal examples:: Source code and other examples
7048 * Include files:: Include the contents of a file during export
7049 * Tables exported:: Tables are exported richly
7050 * Footnotes:: Numbers like [1]
7051 * Emphasis and monospace:: To bold or not to bold
7052 * TeX macros and LaTeX fragments:: Create special, rich export.
7053 * Horizontal rules:: A line across the page
7054 * Comment lines:: Some lines will not be exported
7057 @node Document title, Headings and sections, Markup rules, Markup rules
7058 @subheading Document title
7059 @cindex document title, markup rules
7062 The title of the exported document is taken from the special line
7065 #+TITLE: This is the title of the document
7069 If this line does not exist, the title is derived from the first non-empty,
7070 non-comment line in the buffer. If no such line exists, or if you have
7071 turned off exporting of the text before the first headline (see below), the
7072 title will be the file name without extension.
7074 If you are exporting only a subtree by marking is as the region, the heading
7075 of the subtree will become the title of the document. If the subtree has a
7076 property @code{EXPORT_TITLE}, that will take precedence.
7078 @node Headings and sections, Table of contents, Document title, Markup rules
7079 @subheading Headings and sections
7080 @cindex headings and sections, markup rules
7082 The outline structure of the document as described in @ref{Document
7083 Structure} forms the basis for defining sections of the exported document.
7084 However, since the outline structure is also used for (for example) lists of
7085 tasks, only the first three outline levels will be used as headings. Deeper
7086 levels will become itemized lists. You can change the location of this
7087 switch, globally by setting the variable @code{org-headline-levels}, or on a
7088 per file basis with a line
7094 @node Table of contents, Initial text, Headings and sections, Markup rules
7095 @subheading Table of contents
7096 @cindex table of contents, markup rules
7098 The table of contents is normally inserted directly before the first headline
7099 of the file. If you would like to get it to a different location, insert the
7100 string @code{[TABLE-OF-CONTENTS]} on a line by itself at the desired
7101 location. The depth of the table of contents is by default the same as the
7102 number of headline levels, but you can choose a smaller number or turn off
7103 the table of contents entirely by configuring the variable
7104 @code{org-export-with-toc}, or on a per-file basis with a line like
7107 #+OPTIONS: toc:2 (only to two levels in TOC)
7108 #+OPTIONS: toc:nil (no TOC at all)
7111 @node Initial text, Lists, Table of contents, Markup rules
7112 @subheading Text before the first headline
7113 @cindex text before first headline, markup rules
7116 Org mode normally exports the text before the first headline, and even uses
7117 the first line as the document title. The text will be fully marked up. If
7118 you need to include literal HTML or La@TeX{} code, use the special constructs
7119 described below in the sections for the individual exporters.
7121 Some people like to use the space before the first headline for setup and
7122 internal links and therefore would like to control the exported text before
7123 the first headline in a different way. You can do so by setting the variable
7124 @code{org-export-skip-text-before-1st-heading} to @code{t}. On a per-file
7125 basis, you can get the same effect with @samp{#+OPTIONS: skip:t}.
7128 If you still want to have some text before the first headline, use the
7129 @code{#+TEXT} construct:
7133 #+TEXT: This text will go before the *first* headline.
7134 #+TEXT: [TABLE-OF-CONTENTS]
7135 #+TEXT: This goes between the table of contents and the first headline
7138 @node Lists, Paragraphs, Initial text, Markup rules
7140 @cindex lists, markup rules
7142 Plain lists as described in @ref{Plain lists} are translated to the back-ends
7143 syntax for such lists. Most back-ends support unordered, ordered, and
7146 @node Paragraphs, Literal examples, Lists, Markup rules
7147 @subheading Paragraphs, line breaks, and quoting
7148 @cindex paragraphs, markup rules
7150 Paragraphs are separated by at least one empty line. If you need to enforce
7151 a line break within a paragraph, use @samp{\\} at the end of a line.
7153 To keep the line breaks in a region, but otherwise use normal formatting, you
7154 can use this construct, which can also be used to format poetry.
7158 Great clouds overhead
7159 Tiny black birds rise and fall
7166 When quoting a passage from another document, it is customary to format this
7167 as a paragraph that is indented on both the left and the right margin. You
7168 can include quotations in Org mode documents like this:
7172 Everything should be made as simple as possible,
7173 but not any simpler -- Albert Einstein
7178 @node Literal examples, Include files, Paragraphs, Markup rules
7179 @subheading Literal examples
7180 @cindex literal examples, markup rules
7182 You can include literal examples that should not be subjected to
7183 markup. Such examples will be typeset in monospace, so this is well suited
7184 for source code and similar examples.
7185 @cindex #+BEGIN_EXAMPLE
7189 Some example from a text file.
7193 For simplicity when using small examples, you can also start the example
7197 : Some example from a text file.
7200 @cindex formatting source code, markup rules
7201 If the example is source code from a programming language, or any other text
7202 that can be marked up by font-lock in Emacs, you can ask for the example to
7203 look like the fontified Emacs buffer@footnote{Currently this works only for
7204 the HTML back-end, and requires the @file{htmlize.el} package version 1.34 or
7205 later.}. This is done with the @samp{src} block, where you also need to
7206 specify the name of the major mode that should be used to fontify the
7211 #+BEGIN_SRC emacs-lisp
7212 (defun org-xor (a b)
7221 Edit the source code example at point in its native mode. This works by
7222 switching to an indirect buffer, narrowing the buffer and switching to the
7223 other mode. You need to exit by pressing @kbd{C-c '} again@footnote{Upon
7224 exit, lines starting with @samp{*} or @samp{#} will get a comma prepended, to
7225 keep them from being interpreted by Org as outline nodes or special
7226 comments. These commas will be striped for editing with @kbd{C-c '}, and
7227 also for export.}. Fixed-width
7228 regions (where each line starts with a colon followed by a space) will be
7229 edited using @code{artist-mode}@footnote{You may select a different-mode with
7230 the variable @code{org-edit-fixed-width-region-mode}.} to allow creating
7231 ASCII drawings easily. Using this command in an empty line will create a new
7236 @node Include files, Tables exported, Literal examples, Markup rules
7237 @subheading Include files
7238 @cindex include files, markup rules
7240 During export, you can include the content of another file. For example, to
7241 include your .emacs file, you could use:
7245 #+INCLUDE: "~/.emacs" src emacs-lisp
7248 The optional second and third parameter are the markup (@samp{quote},
7249 @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the
7250 language for formatting the contents. The markup is optional, if it is not
7251 given, the text will be assumed to be in Org mode format and will be
7252 processed normally. The include line will also allow additional keyword
7253 parameters @code{:prefix1} and @code{:prefix} to specify prefixes for the
7254 first line and for each following line. For example, to include a file as an
7258 #+INCLUDE: "~/snippets/xx" :prefix1 " + " :prefix " "
7264 Visit the include file at point.
7267 @node Tables exported, Footnotes, Include files, Markup rules
7269 @cindex tables, markup rules
7271 Both the native Org mode tables (@pxref{Tables}) and tables formatted with
7272 the @file{table.el} package will be exported properly. For Org mode tables,
7273 the lines before the first horizontal separator line will become table header
7276 @node Footnotes, Emphasis and monospace, Tables exported, Markup rules
7277 @subheading Footnotes
7278 @cindex footnotes, markup rules
7279 @cindex @file{footnote.el}
7282 Numbers in square brackets are treated as footnote markers, and lines
7283 starting with such a marker are interpreted as the footnote itself. You can
7284 use the Emacs package @file{footnote.el} to create footnotes@footnote{The
7285 @file{footnote} package uses @kbd{C-c !} to invoke its commands. This
7286 binding conflicts with the Org mode command for inserting inactive time
7287 stamps. You could use the variable @code{footnote-prefix} to switch
7288 footnotes commands to another key. Or, if you are too used to this binding,
7289 you could use @code{org-replace-disputed-keys} and @code{org-disputed-keys}
7290 to change the settings in Org.}. For example:
7293 The Org homepage[1] now looks a lot better than it used to.
7295 [1] The link is: http://orgmode.org
7298 @node Emphasis and monospace, TeX macros and LaTeX fragments, Footnotes, Markup rules
7299 @subheading Emphasis and monospace
7301 @cindex underlined text, markup rules
7302 @cindex bold text, markup rules
7303 @cindex italic text, markup rules
7304 @cindex verbatim text, markup rules
7305 @cindex code text, markup rules
7306 @cindex strike-through text, markup rules
7307 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=}
7308 and @code{~verbatim~}, and, if you must, @samp{+strike-through+}. Text
7309 in the code and verbatim string is not processed for Org mode specific
7310 syntax, it is exported verbatim.
7312 @node TeX macros and LaTeX fragments, Horizontal rules, Emphasis and monospace, Markup rules
7313 @subheading @TeX{} macros and La@TeX{} fragments
7314 @cindex LaTeX fragments, markup rules
7315 @cindex TeX macros, markup rules
7316 @cindex HTML entities
7317 @cindex LaTeX entities
7319 A @TeX{}-like syntax is used to specify special characters. Where possible,
7320 these will be transformed into the native format of the exporter back-end.
7321 Strings like @code{\alpha} will be exported as @code{α} in the HTML
7322 output, and as @code{$\alpha$} in the La@TeX{} output. Similarly,
7323 @code{\nbsp} will become @code{ } in HTML and @code{~} in La@TeX{}.
7324 This applies for a large number of entities, with names taken from both HTML
7325 and La@TeX{}, see the variable @code{org-html-entities} for the complete
7326 list. If you are unsure about a name, use @kbd{M-@key{TAB}} for completion
7327 after having types the backslash and maybe a few characters
7328 (@pxref{Completion}).
7330 La@TeX{} fragments are converted into images for HTML export, and they are
7331 written literally into the La@TeX{} export. See also @ref{Embedded LaTeX}.
7333 Finally, @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
7334 @samp{...} are all converted into special commands creating hyphens of
7335 different lengths or a compact set of dots.
7337 @node Horizontal rules, Comment lines, TeX macros and LaTeX fragments, Markup rules
7338 @subheading Horizontal rules
7339 @cindex horizontal rules, markup rules
7340 A line consisting of only dashes, and at least 5 of them, will be
7341 exported as a horizontal line (@samp{<hr/>} in HTML).
7343 @node Comment lines, , Horizontal rules, Markup rules
7344 @subheading Comment lines
7345 @cindex comment lines
7346 @cindex exporting, not
7348 Lines starting with @samp{#} in column zero are treated as comments and will
7349 never be exported. Also entire subtrees starting with the word
7350 @samp{COMMENT} will never be exported. Finally, regions surrounded by
7351 @samp{#+BEGIN_COMMENT} ... @samp{#+END_COMMENT} will not be exported.
7356 Toggle the COMMENT keyword at the beginning of an entry.
7359 @node Selective export, Export options, Markup rules, Exporting
7360 @section Selective export
7361 @cindex export, selective by tags
7363 You may use tags to select the parts of a document that should be exported,
7364 or to exclude parts from export. This behavior is governed by two variables:
7365 @code{org-export-select-tags} and @code{org-export-exclude-tags}.
7367 Org first checks if any of the @emph{select} tags is present in the buffer.
7368 If yes, all trees that do not carry one of these tags will be excluded. If a
7369 selected tree is a subtree, the heading hierarchy above it will also be
7370 selected for export, but not the text below those headings.
7373 If none of the select tags is found, the whole buffer will be selected for
7377 Finally, all subtrees that are marked by any of the @emph{exclude} tags will
7378 be removed from the export buffer.
7380 @node Export options, The export dispatcher, Selective export, Exporting
7381 @section Export options
7382 @cindex options, for export
7384 @cindex completion, of option keywords
7385 The exporter recognizes special lines in the buffer which provide
7386 additional information. These lines may be put anywhere in the file.
7387 The whole set of lines can be inserted into the buffer with @kbd{C-c
7388 C-e t}. For individual lines, a good way to make sure the keyword is
7389 correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion
7390 (@pxref{Completion}).
7395 Insert template with export options, see example below.
7406 @cindex #+LINK_HOME:
7407 @cindex #+EXPORT_SELECT_TAGS:
7408 @cindex #+EXPORT_EXCLUDE_TAGS:
7410 #+TITLE: the title to be shown (default is the buffer name)
7411 #+AUTHOR: the author (default taken from @code{user-full-name})
7412 #+DATE: A date, fixed, of a format string for @code{format-time-string}
7413 #+EMAIL: his/her email address (default from @code{user-mail-address})
7414 #+LANGUAGE: language for HTML, e.g. @samp{en} (@code{org-export-default-language})
7415 #+TEXT: Some descriptive text to be inserted at the beginning.
7416 #+TEXT: Several lines may be given.
7417 #+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ...
7418 #+LINK_UP: the ``up'' link of an exported page
7419 #+LINK_HOME: the ``home'' link of an exported page
7420 #+EXPORT_SELECT_TAGS: Tags that select a tree for export
7421 #+EXPORT_EXCLUDE_TAGS: Tags that exclude a tree from export
7425 The OPTIONS line is a compact@footnote{If you want to configure many options
7426 this way, you can use several OPTIONS lines.} form to specify export settings. Here
7428 @cindex headline levels
7429 @cindex section-numbers
7430 @cindex table of contents
7431 @cindex line-break preservation
7432 @cindex quoted HTML tags
7433 @cindex fixed-width sections
7435 @cindex @TeX{}-like syntax for sub- and superscripts
7437 @cindex special strings
7438 @cindex emphasized text
7439 @cindex @TeX{} macros
7440 @cindex La@TeX{} fragments
7441 @cindex author info, in export
7442 @cindex time info, in export
7444 H: @r{set the number of headline levels for export}
7445 num: @r{turn on/off section-numbers}
7446 toc: @r{turn on/off table of contents, or set level limit (integer)}
7447 \n: @r{turn on/off line-break-preservation}
7448 @@: @r{turn on/off quoted HTML tags}
7449 :: @r{turn on/off fixed-width sections}
7450 |: @r{turn on/off tables}
7451 ^: @r{turn on/off @TeX{}-like syntax for sub- and superscripts. If}
7452 @r{you write "^:@{@}", @code{a_@{b@}} will be interpreted, but}
7453 @r{the simple @code{a_b} will be left as it is.}
7454 -: @r{turn on/off conversion of special strings.}
7455 f: @r{turn on/off footnotes like this[1].}
7456 *: @r{turn on/off emphasized text (bold, italic, underlined)}
7457 TeX: @r{turn on/off simple @TeX{} macros in plain text}
7458 LaTeX: @r{turn on/off La@TeX{} fragments}
7459 skip: @r{turn on/off skipping the text before the first heading}
7460 author: @r{turn on/off inclusion of author name/email into exported file}
7461 creator: @r{turn on/off inclusion of creator info into exported file}
7462 timestamp: @r{turn on/off inclusion creation time into exported file}
7463 d: @r{turn on/off inclusion of drawers}
7466 These options take effect in both the HTML and La@TeX{} export, except
7467 for @code{TeX} and @code{LaTeX}, which are respectively @code{t} and
7468 @code{nil} for the La@TeX{} export.
7470 When exporting only a single subtree by selecting it with @kbd{C-c @@} before
7471 calling an export command, the subtree can overrule some of the file's export
7472 settings with properties @code{EXPORT_FILE_NAME}, @code{EXPORT_TITLE},
7473 @code{EXPORT_TEXT}, and @code{EXPORT_OPTIONS}.
7475 @node The export dispatcher, ASCII export, Export options, Exporting
7476 @section The export dispatcher
7477 @cindex dispatcher, for export commands
7479 All export commands can be reached using the export dispatcher, which is a
7480 prefix key that prompts for an additional key specifying the command.
7481 Normally the entire file is exported, but if there is an active region that
7482 contains one outline tree, the first heading is used as document title and
7483 the subtrees are exported.
7488 Dispatcher for export and publishing commands. Displays a help-window
7489 listing the additional key(s) needed to launch an export or publishing
7490 command. The prefix arg is passed through to the exporter. If the option
7491 @code{org-export-run-in-background} is set, Org will run the command in the
7492 background if that seems useful for the specific command (i.e. commands that
7496 Like @kbd{C-c C-e}, but only export the text that is currently visible
7497 (i.e. not hidden by outline visibility).
7498 @kindex C-u C-u C-c C-e
7499 @item C-u C-u C-c C-e
7500 Call an the exporter, but reverse the setting of
7501 @code{org-export-run-in-background}, i.e. request background processing if
7502 not set, or force processing in the current Emacs process if st.
7505 @node ASCII export, HTML export, The export dispatcher, Exporting
7506 @section ASCII export
7507 @cindex ASCII export
7509 ASCII export produces a simple and very readable version of an Org mode
7512 @cindex region, active
7513 @cindex active region
7514 @cindex Transient mark mode
7518 Export as ASCII file. For an org file @file{myfile.org}, the ASCII file
7519 will be @file{myfile.txt}. The file will be overwritten without
7520 warning. If there is an active region, only the region will be
7521 exported. If the selected region is a single tree@footnote{To select the
7522 current subtree, use @kbd{C-c @@}.}, the tree head will
7523 become the document title. If the tree head entry has or inherits an
7524 @code{EXPORT_FILE_NAME} property, that name will be used for the
7528 Export only the visible part of the document.
7531 @cindex headline levels, for exporting
7532 In the exported version, the first 3 outline levels will become
7533 headlines, defining a general document structure. Additional levels
7534 will be exported as itemized lists. If you want that transition to occur
7535 at a different level, specify it with a prefix argument. For example,
7542 creates only top level headlines and does the rest as items. When
7543 headlines are converted to items, the indentation of the text following
7544 the headline is changed to fit nicely under the item. This is done with
7545 the assumption that the first body line indicates the base indentation of
7546 the body text. Any indentation larger than this is adjusted to preserve
7547 the layout relative to the first line. Should there be lines with less
7548 indentation than the first, these are left alone.
7550 @node HTML export, LaTeX and PDF export, ASCII export, Exporting
7551 @section HTML export
7554 Org mode contains an HTML (XHTML 1.0 strict) exporter with extensive
7555 HTML formatting, in ways similar to John Grubers @emph{markdown}
7556 language, but with additional support for tables.
7559 * HTML Export commands:: How to invoke HTML export
7560 * Quoting HTML tags:: Using direct HTML in Org mode
7561 * Links:: Transformation of links for HTML
7562 * Images:: How to include images
7563 * CSS support:: Changing the appearance of the output
7564 * Javascript support:: Info and Folding in a web browser
7567 @node HTML Export commands, Quoting HTML tags, HTML export, HTML export
7568 @subsection HTML export commands
7570 @cindex region, active
7571 @cindex active region
7572 @cindex Transient mark mode
7576 Export as HTML file @file{myfile.html}. For an org file @file{myfile.org},
7577 the ASCII file will be @file{myfile.html}. The file will be overwritten
7578 without warning. If there is an active region, only the region will be
7579 exported. If the selected region is a single tree@footnote{To select the
7580 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
7581 title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME}
7582 property, that name will be used for the export.
7585 Export as HTML file and immediately open it with a browser.
7588 Export to a temporary buffer, do not create a file.
7591 Export the active region to a temporary buffer. With a prefix argument, do
7592 not produce the file header and footer, but just the plain HTML section for
7593 the region. This is good for cut-and-paste operations.
7602 Export only the visible part of the document.
7603 @item M-x org-export-region-as-html
7604 Convert the region to HTML under the assumption that it was Org mode
7605 syntax before. This is a global command that can be invoked in any
7607 @item M-x org-replace-region-by-HTML
7608 Replace the active region (assumed to be in Org mode syntax) by HTML
7612 @cindex headline levels, for exporting
7613 In the exported version, the first 3 outline levels will become headlines,
7614 defining a general document structure. Additional levels will be exported as
7615 itemized lists. If you want that transition to occur at a different level,
7616 specify it with a numeric prefix argument. For example,
7623 creates two levels of headings and does the rest as items.
7625 @node Quoting HTML tags, Links, HTML Export commands, HTML export
7626 @subsection Quoting HTML tags
7628 Plain @samp{<} and @samp{>} are always transformed to @samp{<} and
7629 @samp{>} in HTML export. If you want to include simple HTML tags
7630 which should be interpreted as such, mark them with @samp{@@} as in
7631 @samp{@@<b>bold text@@</b>}. Note that this really works only for
7632 simple tags. For more extensive HTML that should be copied verbatim to
7633 the exported file use either
7636 #+HTML: Literal HTML code for export
7640 @cindex #+BEGIN_HTML
7644 All lines between these markers are exported literally
7649 @node Links, Images, Quoting HTML tags, HTML export
7652 @cindex links, in HTML export
7653 @cindex internal links, in HTML export
7654 @cindex external links, in HTML export
7655 Internal links (@pxref{Internal links}) will continue to work in HTML
7656 files only if they match a dedicated @samp{<<target>>}. Automatic links
7657 created by radio targets (@pxref{Radio targets}) will also work in the
7658 HTML file. Links to external files will still work if the HTML file is
7659 in the same directory as the Org file. Links to other @file{.org}
7660 files will be translated into HTML links under the assumption that an
7661 HTML version also exists of the linked file. For information related to
7662 linking files while publishing them to a publishing directory see
7663 @ref{Publishing links}.
7665 If you want to specify attributes for links, you can do so using a special
7666 syntax. Here is an example that sets @code{alt} and @code{title} attributes
7667 for an inlined image:
7670 [[./img/a.jpg@{@{alt="This is image A" title="Image with no action"@}@}]]
7673 @node Images, CSS support, Links, HTML export
7676 @cindex images, inline in HTML
7677 @cindex inlining images in HTML
7678 HTML export can inline images given as links in the Org file, and
7679 it can make an image the clickable part of a link. By
7680 default@footnote{but see the variable
7681 @code{org-export-html-inline-images}}, images are inlined if a link does
7682 not have a description. So @samp{[[file:myimg.jpg]]} will be inlined,
7683 while @samp{[[file:myimg.jpg][the image]]} will just produce a link
7684 @samp{the image} that points to the image. If the description part
7685 itself is a @code{file:} link or a @code{http:} URL pointing to an
7686 image, this image will be inlined and activated so that clicking on the
7687 image will activate the link. For example, to include a thumbnail that
7688 will link to a high resolution version of the image, you could use:
7691 [[file:highres.jpg][file:thumb.jpg]]
7695 and you could use @code{http} addresses just as well.
7697 @node CSS support, Javascript support, Images, HTML export
7698 @subsection CSS support
7699 @cindex CSS, for HTML export
7700 @cindex HTML export, CSS
7702 You can also give style information for the exported file. The HTML
7703 exporter assigns the following CSS classes to appropriate parts of the
7704 document - your style specifications may change these:
7706 .todo @r{TODO keywords}
7707 .done @r{the DONE keyword}
7708 .timestamp @r{time stamp}
7709 .timestamp-kwd @r{keyword associated with a time stamp, like SCHEDULED}
7710 .tag @r{tag in a headline}
7711 .target @r{target for links}
7714 Each exported files contains a compact default style that defines these
7715 classes in a basic way@footnote{This style is defined in the constant
7716 @code{org-export-html-style-default}, which you should not modify. To turn
7717 inclusion of these defaults off, customize
7718 @code{org-export-html-style-include-default}}. You may overwrite these
7719 settings, or add to them by using the variables @code{org-export-html-style}
7720 (for Org-wide settings) and @code{org-export-html-style-extra} (for more
7721 granular settings, like file-local settings). To set the latter variable
7722 individually for each file, you can use
7725 #+STYLE: <link rel="stylesheet" type="text/css" href="stylesheet.css" />
7729 For longer style definitions, you can use several such lines. You could also
7730 directly write a @code{<style>} @code{</style>} section in this way, without
7731 referring to an external file.
7733 @c FIXME: More about header and footer styles
7734 @c FIXME: Talk about links and targets.
7736 @node Javascript support, , CSS support, HTML export
7737 @subsection Javascript supported display of web pages
7739 @emph{Sebastian Rose} has written a JavaScript program especially designed to
7740 enhance the web viewing experience of HTML files created with Org. This
7741 program allows to view large files in two different ways. The first one is
7742 an @emph{Info}-like mode where each section is displayed separately and
7743 navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
7744 as well, press @kbd{?} for an overview of the available keys). The second
7745 view type is a @emph{folding} view much like Org provides it inside Emacs.
7746 The script is available at @url{http://orgmode.org/org-info.js} and you can
7747 find the documentation for it at
7748 @url{http://orgmode.org/worg/code/org-info-js/org-info.js.html}. We are
7749 serving the script from our site, but if you use it a lot, you might not want
7750 to be dependent on @url{orgmode.org} and prefer to install a local copy on
7751 your own web server.
7753 To use the script, you need to make sure that the @file{org-jsinfo.el} module
7754 gets loaded. It should be loaded by default, try @kbd{M-x customize-variable
7755 @key{RET} org-modules @key{RET}} to convince yourself that this is indeed the
7756 case. All it then takes to make use of the program is adding a single line
7760 #+INFOJS_OPT: view:info toc:nil
7764 If this line is found, the HTML header will automatically contain the code
7765 needed to invoke the script. Using the line above, you can set the following
7769 path: @r{The path to the script. The default is to grab the script from}
7770 @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
7771 @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
7772 view: @r{Initial view when website is first shown. Possible values are:}
7773 info @r{Info-like interface with one section per page.}
7774 overview @r{Folding interface, initially showing only top-level.}
7775 content @r{Folding interface, starting with all headlines visible.}
7776 showall @r{Folding interface, all headlines and text visible.}
7777 sdepth: @r{Maximum headline level that will still become an independent}
7778 @r{section for info and folding modes. The default is taken from}
7779 @r{@code{org-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
7780 @r{If this is smaller than in @code{org-headline-levels}, each}
7781 @r{info/folding section can still contain children headlines.}
7782 toc: @r{Should the table of content @emph{initially} be visible?}
7783 @r{Even when @code{nil}, you can always get to the toc with @kbd{i}.}
7784 tdepth: @r{The depth of the table of contents. The defaults are taken from}
7785 @r{the variables @code{org-headline-levels} and @code{org-export-with-toc}.}
7786 ftoc: @r{Does the css of the page specify a fixed position for the toc?}
7787 @r{If yes, the toc will never be displayed as a section.}
7788 ltoc: @r{Should there be short contents (children) in each section?}
7789 mouse: @r{Headings are highlighted when the mouse is over them. Should be}
7790 @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
7791 buttons: @r{Should view-toggle buttons be everywhere? When @code{nil} (the}
7792 @r{default), only one such button will be present.}
7795 You can choose default values for these options by customizing the variable
7796 @code{org-infojs-options}. If you always want to apply the script to your
7797 pages, configure the variable @code{org-export-html-use-infojs}.
7799 @node LaTeX and PDF export, XOXO export, HTML export, Exporting
7800 @section LaTeX and PDF export
7801 @cindex LaTeX export
7804 Org mode contains a La@TeX{} exporter written by Bastien Guerry. With
7805 further processing, this backend is also used to produce PDF output. Since
7806 the LaTeX output uses @file{hyperref} to implement links and cross
7807 references, the PDF output file will be fully linked.
7810 * LaTeX/PDF export commands::
7811 * Quoting LaTeX code:: Incorporating literal LaTeX code
7812 * Sectioning structure:: Changing sectioning in LaTeX output
7815 @node LaTeX/PDF export commands, Quoting LaTeX code, LaTeX and PDF export, LaTeX and PDF export
7816 @subsection LaTeX export commands
7821 Export as La@TeX{} file @file{myfile.tex}. For an org file
7822 @file{myfile.org}, the ASCII file will be @file{myfile.tex}. The file will
7823 be overwritten without warning. If there is an active region, only the
7824 region will be exported. If the selected region is a single tree@footnote{To
7825 select the current subtree, use @kbd{C-c @@}.}, the tree head will become the
7826 document title. If the tree head entry has or inherits an
7827 @code{EXPORT_FILE_NAME} property, that name will be used for the export.
7830 Export to a temporary buffer, do not create a file.
7835 Export only the visible part of the document.
7836 @item M-x org-export-region-as-latex
7837 Convert the region to La@TeX{} under the assumption that it was Org mode
7838 syntax before. This is a global command that can be invoked in any
7840 @item M-x org-replace-region-by-latex
7841 Replace the active region (assumed to be in Org mode syntax) by La@TeX{}
7845 Export as LaTeX and then process to PDF.
7848 Export as LaTeX and then process to PDF, then open the resulting PDF file.
7851 @cindex headline levels, for exporting
7852 In the exported version, the first 3 outline levels will become
7853 headlines, defining a general document structure. Additional levels
7854 will be exported as description lists. The exporter can ignore them or
7855 convert them to a custom string depending on
7856 @code{org-latex-low-levels}.
7858 If you want that transition to occur at a different level, specify it
7859 with a numeric prefix argument. For example,
7866 creates two levels of headings and does the rest as items.
7868 @node Quoting LaTeX code, Sectioning structure, LaTeX/PDF export commands, LaTeX and PDF export
7869 @subsection Quoting LaTeX code
7871 Embedded La@TeX{} as described in @ref{Embedded LaTeX} will be correctly
7872 inserted into the La@TeX{} file. Furthermore, you can add special code
7873 that should only be present in La@TeX{} export with the following
7877 #+LaTeX: Literal LaTeX code for export
7881 @cindex #+BEGIN_LaTeX
7885 All lines between these markers are exported literally
7889 @node Sectioning structure, , Quoting LaTeX code, LaTeX and PDF export
7890 @subsection Sectioning structure
7892 @cindex LaTeX sectioning structure
7894 By default, the La@TeX{} output uses the class @code{article}.
7896 You can change this globally by setting a different value for
7897 @code{org-export-latex-default-class} or locally by adding an option like
7898 @code{#+LaTeX_CLASS: myclass} in your file. The class should be listed in
7899 @code{org-export-latex-classes}, where you can also define the sectioning
7900 structure for each class, as well as defining additonal classes.
7903 @node XOXO export, iCalendar export, LaTeX and PDF export, Exporting
7904 @section XOXO export
7907 Org mode contains an exporter that produces XOXO-style output.
7908 Currently, this exporter only handles the general outline structure and
7909 does not interpret any additional Org mode features.
7914 Export as XOXO file @file{myfile.html}.
7917 Export only the visible part of the document.
7920 @node iCalendar export, , XOXO export, Exporting
7921 @section iCalendar export
7922 @cindex iCalendar export
7924 Some people like to use Org mode for keeping track of projects, but still
7925 prefer a standard calendar application for anniversaries and appointments.
7926 In this case it can be useful to have deadlines and other time-stamped items
7927 in Org files show up in the calendar application. Org mode can export
7928 calendar information in the standard iCalendar format. If you also want to
7929 have TODO entries included in the export, configure the variable
7930 @code{org-icalendar-include-todo}. iCalendar export will export plain time
7931 stamps as VEVENT, and TODO items as VTODO. It will also create events from
7932 deadlines that are in non-TODO items. Deadlines and scheduling dates in TODO
7933 items will be used to set the start and due dates for the todo
7934 entry@footnote{See the variables @code{org-icalendar-use-deadline} and
7935 @code{org-icalendar-use-scheduled}.}. As categories, it will use the tags
7936 locally defined in the heading, and the file/tree category@footnote{To add
7937 inherited tags or the TODO state, configure the variable
7938 @code{org-icalendar-categories}.}.
7940 The iCalendar standard requires each entry to have a globally unique
7941 identifier (UID). Org creates these identifiers during export. If you set
7942 the variable @code{org-icalendar-store-UID}, the UID will be stored in the
7943 @code{:ID:} property of the entry and re-used next time you report this
7944 entry. Since a single entry can give rise to multiple iCalendar entries (as
7945 a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
7946 prefixes to the UID, depending on what triggered the inclusion of the entry.
7947 In this way the UID remains unique, but a synchronization program can still
7948 figure out from which entry all the different instances originate.
7953 Create iCalendar entries for the current file and store them in the same
7954 directory, using a file extension @file{.ics}.
7957 Like @kbd{C-c C-e i}, but do this for all files in
7958 @code{org-agenda-files}. For each of these files, a separate iCalendar
7959 file will be written.
7962 Create a single large iCalendar file from all files in
7963 @code{org-agenda-files} and write it to the file given by
7964 @code{org-combined-agenda-icalendar-file}.
7967 The export will honor SUMMARY, DESCRIPTION and LOCATION properties if
7968 the selected entries have them. If not, the summary will be derived
7969 from the headline, and the description from the body (limited to
7970 @code{org-icalendar-include-body} characters).
7972 How this calendar is best read and updated, that depends on the application
7973 you are using. The FAQ covers this issue.
7975 @node Publishing, Miscellaneous, Exporting, Top
7979 Org includes@footnote{@file{org-publish.el} is not distributed with
7980 Emacs 21, if you are still using Emacs 21, you need you need to download
7981 this file separately.} a publishing management system that allows you to
7982 configure automatic HTML conversion of @emph{projects} composed of
7983 interlinked org files. This system is called @emph{org-publish}. You can
7984 also configure org-publish to automatically upload your exported HTML
7985 pages and related attachments, such as images and source code files, to
7986 a web server. Org-publish turns Org into a web-site authoring tool.
7988 You can also use Org-publish to convert files into La@TeX{}, or even
7989 combine HTML and La@TeX{} conversion so that files are available in both
7990 formats on the server@footnote{Since La@TeX{} files on a server are not
7991 that helpful, you surely want to perform further conversion on them --
7992 e.g. convert them to @code{PDF} format.}.
7994 Org-publish has been contributed to Org by David O'Toole.
7997 * Configuration:: Defining projects
7998 * Sample configuration:: Example projects
7999 * Triggering publication:: Publication commands
8002 @node Configuration, Sample configuration, Publishing, Publishing
8003 @section Configuration
8005 Publishing needs significant configuration to specify files, destination
8006 and many other properties of a project.
8009 * Project alist:: The central configuration variable
8010 * Sources and destinations:: From here to there
8011 * Selecting files:: What files are part of the project?
8012 * Publishing action:: Setting the function doing the publishing
8013 * Publishing options:: Tweaking HTML export
8014 * Publishing links:: Which links keep working after publishing?
8015 * Project page index:: Publishing a list of project files
8018 @node Project alist, Sources and destinations, Configuration, Configuration
8019 @subsection The variable @code{org-publish-project-alist}
8020 @cindex org-publish-project-alist
8021 @cindex projects, for publishing
8023 Org-publish is configured almost entirely through setting the value of
8024 one variable, called @code{org-publish-project-alist}.
8025 Each element of the list configures one project, and may be in one of
8026 the two following forms:
8029 ("project-name" :property value :property value ...)
8033 ("project-name" :components ("project-name" "project-name" ...))
8037 In both cases, projects are configured by specifying property values.
8038 A project defines the set of files that will be published, as well as
8039 the publishing configuration to use when publishing those files. When
8040 a project takes the second form listed above, the individual members
8041 of the ``components'' property are taken to be components of the
8042 project, which group together files requiring different publishing
8043 options. When you publish such a ``meta-project'' all the components
8046 @node Sources and destinations, Selecting files, Project alist, Configuration
8047 @subsection Sources and destinations for files
8048 @cindex directories, for publishing
8050 Most properties are optional, but some should always be set. In
8051 particular, org-publish needs to know where to look for source files,
8052 and where to put published files.
8054 @multitable @columnfractions 0.3 0.7
8055 @item @code{:base-directory}
8056 @tab Directory containing publishing source files
8057 @item @code{:publishing-directory}
8058 @tab Directory (possibly remote) where output files will be published.
8059 @item @code{:preparation-function}
8060 @tab Function called before starting the publishing process, for example to
8061 run @code{make} for updating files to be published.
8062 @item @code{:completion-function}
8063 @tab Function called after finishing the publishing process, for example to
8064 change permissions of the resulting files.
8068 @node Selecting files, Publishing action, Sources and destinations, Configuration
8069 @subsection Selecting files
8070 @cindex files, selecting for publishing
8072 By default, all files with extension @file{.org} in the base directory
8073 are considered part of the project. This can be modified by setting the
8075 @multitable @columnfractions 0.25 0.75
8076 @item @code{:base-extension}
8077 @tab Extension (without the dot!) of source files. This actually is a
8080 @item @code{:exclude}
8081 @tab Regular expression to match file names that should not be
8082 published, even though they have been selected on the basis of their
8085 @item @code{:include}
8086 @tab List of files to be included regardless of @code{:base-extension}
8087 and @code{:exclude}.
8090 @node Publishing action, Publishing options, Selecting files, Configuration
8091 @subsection Publishing action
8092 @cindex action, for publishing
8094 Publishing means that a file is copied to the destination directory and
8095 possibly transformed in the process. The default transformation is to export
8096 Org files as HTML files, and this is done by the function
8097 @code{org-publish-org-to-html} which calls the HTML exporter (@pxref{HTML
8098 export}). But you also can publish your files in La@TeX{} by using the
8099 function @code{org-publish-org-to-latex} instead, or as PDF files using
8100 @code{org-publish-org-to-pdf}. Other files like images only need to be
8101 copied to the publishing destination. For non-Org files, you need to provide
8102 your own publishing function:
8104 @multitable @columnfractions 0.3 0.7
8105 @item @code{:publishing-function}
8106 @tab Function executing the publication of a file. This may also be a
8107 list of functions, which will all be called in turn.
8110 The function must accept two arguments: a property list containing at
8111 least a @code{:publishing-directory} property, and the name of the file
8112 to be published. It should take the specified file, make the necessary
8113 transformation (if any) and place the result into the destination folder.
8114 You can write your own publishing function, but @code{org-publish}
8115 provides one for attachments (files that only need to be copied):
8116 @code{org-publish-attachment}.
8118 @node Publishing options, Publishing links, Publishing action, Configuration
8119 @subsection Options for the HTML/LaTeX exporters
8120 @cindex options, for publishing
8122 The property list can be used to set many export options for the HTML
8123 and La@TeX{} exporters. In most cases, these properties correspond to user
8124 variables in Org. The table below lists these properties along
8125 with the variable they belong to. See the documentation string for the
8126 respective variable for details.
8128 @multitable @columnfractions 0.3 0.7
8129 @item @code{:language} @tab @code{org-export-default-language}
8130 @item @code{:headline-levels} @tab @code{org-export-headline-levels}
8131 @item @code{:section-numbers} @tab @code{org-export-with-section-numbers}
8132 @item @code{:table-of-contents} @tab @code{org-export-with-toc}
8133 @item @code{:archived-trees} @tab @code{org-export-with-archived-trees}
8134 @item @code{:emphasize} @tab @code{org-export-with-emphasize}
8135 @item @code{:sub-superscript} @tab @code{org-export-with-sub-superscripts}
8136 @item @code{:special-strings} @tab @code{org-export-with-special-strings}
8137 @item @code{:TeX-macros} @tab @code{org-export-with-TeX-macros}
8138 @item @code{:LaTeX-fragments} @tab @code{org-export-with-LaTeX-fragments}
8139 @item @code{:fixed-width} @tab @code{org-export-with-fixed-width}
8140 @item @code{:timestamps} @tab @code{org-export-with-timestamps}
8141 @item @code{:author-info} @tab @code{org-export-author-info}
8142 @item @code{:creator-info} @tab @code{org-export-creator-info}
8143 @item @code{:tags} @tab @code{org-export-with-tags}
8144 @item @code{:tables} @tab @code{org-export-with-tables}
8145 @item @code{:table-auto-headline} @tab @code{org-export-highlight-first-table-line}
8146 @item @code{:style-include-default} @tab @code{org-export-html-style-include-default}
8147 @item @code{:style} @tab @code{org-export-html-style}
8148 @item @code{:style-extra} @tab @code{org-export-html-style-extra}
8149 @item @code{:convert-org-links} @tab @code{org-export-html-link-org-files-as-html}
8150 @item @code{:inline-images} @tab @code{org-export-html-inline-images}
8151 @item @code{:expand-quoted-html} @tab @code{org-export-html-expand}
8152 @item @code{:timestamp} @tab @code{org-export-html-with-timestamp}
8153 @item @code{:publishing-directory} @tab @code{org-export-publishing-directory}
8154 @item @code{:preamble} @tab @code{org-export-html-preamble}
8155 @item @code{:postamble} @tab @code{org-export-html-postamble}
8156 @item @code{:auto-preamble} @tab @code{org-export-html-auto-preamble}
8157 @item @code{:auto-postamble} @tab @code{org-export-html-auto-postamble}
8158 @item @code{:author} @tab @code{user-full-name}
8159 @item @code{:email} @tab @code{user-mail-address}
8160 @item @code{:select-tags} @tab @code{org-export-select-tags}
8161 @item @code{:exclude-tags} @tab @code{org-export-exclude-tags}
8164 If you use several email addresses, separate them by a semi-column.
8166 Most of the @code{org-export-with-*} variables have the same effect in
8167 both HTML and La@TeX{} exporters, except for @code{:TeX-macros} and
8168 @code{:LaTeX-fragments}, respectively @code{nil} and @code{t} in the
8171 When a property is given a value in @code{org-publish-project-alist},
8172 its setting overrides the value of the corresponding user variable (if
8173 any) during publishing. Options set within a file (@pxref{Export
8174 options}), however, override everything.
8176 @node Publishing links, Project page index, Publishing options, Configuration
8177 @subsection Links between published files
8178 @cindex links, publishing
8180 To create a link from one Org file to another, you would use
8181 something like @samp{[[file:foo.org][The foo]]} or simply
8182 @samp{file:foo.org.} (@pxref{Hyperlinks}). Upon publishing this link
8183 becomes a link to @file{foo.html}. In this way, you can interlink the
8184 pages of your "org web" project and the links will work as expected when
8185 you publish them to HTML.
8187 You may also link to related files, such as images. Provided you are
8188 careful with relative pathnames, and provided you have also configured
8189 @code{org-publish} to upload the related files, these links will work
8190 too. @ref{Complex example} for an example of this usage.
8192 Sometime an Org file to be published may contain links that are
8193 only valid in your production environment, but not in the publishing
8194 location. In this case, use the property
8196 @multitable @columnfractions 0.4 0.6
8197 @item @code{:link-validation-function}
8198 @tab Function to validate links
8202 to define a function for checking link validity. This function must
8203 accept two arguments, the file name and a directory relative to which
8204 the file name is interpreted in the production environment. If this
8205 function returns @code{nil}, then the HTML generator will only insert a
8206 description into the HTML file, but no link. One option for this
8207 function is @code{org-publish-validate-link} which checks if the given
8208 file is part of any project in @code{org-publish-project-alist}.
8210 @node Project page index, , Publishing links, Configuration
8211 @subsection Project page index
8212 @cindex index, of published pages
8214 The following properties may be used to control publishing of an
8215 index of files or summary page for a given project.
8217 @multitable @columnfractions 0.25 0.75
8218 @item @code{:auto-index}
8219 @tab When non-nil, publish an index during org-publish-current-project or
8222 @item @code{:index-filename}
8223 @tab Filename for output of index. Defaults to @file{index.org} (which
8224 becomes @file{index.html}).
8226 @item @code{:index-title}
8227 @tab Title of index page. Defaults to name of file.
8229 @item @code{:index-function}
8230 @tab Plug-in function to use for generation of index.
8231 Defaults to @code{org-publish-org-index}, which generates a plain list
8232 of links to all files in the project.
8235 @node Sample configuration, Triggering publication, Configuration, Publishing
8236 @section Sample configuration
8238 Below we provide two example configurations. The first one is a simple
8239 project publishing only a set of Org files. The second example is
8240 more complex, with a multi-component project.
8243 * Simple example:: One-component publishing
8244 * Complex example:: A multi-component publishing example
8247 @node Simple example, Complex example, Sample configuration, Sample configuration
8248 @subsection Example: simple publishing configuration
8250 This example publishes a set of Org files to the @file{public_html}
8251 directory on the local machine.
8254 (setq org-publish-project-alist
8256 :base-directory "~/org/"
8257 :publishing-directory "~/public_html"
8258 :section-numbers nil
8259 :table-of-contents nil
8260 :style "<link rel=\"stylesheet\"
8261 href=\"../other/mystyle.css\"
8262 type=\"text/css\">")))
8265 @node Complex example, , Simple example, Sample configuration
8266 @subsection Example: complex publishing configuration
8268 This more complicated example publishes an entire website, including
8269 org files converted to HTML, image files, emacs lisp source code, and
8270 style sheets. The publishing-directory is remote and private files are
8273 To ensure that links are preserved, care should be taken to replicate
8274 your directory structure on the web server, and to use relative file
8275 paths. For example, if your org files are kept in @file{~/org} and your
8276 publishable images in @file{~/images}, you'd link to an image with
8279 file:../images/myimage.png
8282 On the web server, the relative path to the image should be the
8283 same. You can accomplish this by setting up an "images" folder in the
8284 right place on the web server, and publishing images to it.
8287 (setq org-publish-project-alist
8289 :base-directory "~/org/"
8290 :base-extension "org"
8291 :publishing-directory "/ssh:user@@host:~/html/notebook/"
8292 :publishing-function org-publish-org-to-html
8293 :exclude "PrivatePage.org" ;; regexp
8295 :section-numbers nil
8296 :table-of-contents nil
8297 :style "<link rel=\"stylesheet\"
8298 href=\"../other/mystyle.css\" type=\"text/css\">"
8300 :auto-postamble nil)
8303 :base-directory "~/images/"
8304 :base-extension "jpg\\|gif\\|png"
8305 :publishing-directory "/ssh:user@@host:~/html/images/"
8306 :publishing-function org-publish-attachment)
8309 :base-directory "~/other/"
8310 :base-extension "css\\|el"
8311 :publishing-directory "/ssh:user@@host:~/html/other/"
8312 :publishing-function org-publish-attachment)
8313 ("website" :components ("orgfiles" "images" "other"))))
8316 @node Triggering publication, , Sample configuration, Publishing
8317 @section Triggering publication
8319 Once org-publish is properly configured, you can publish with the
8320 following functions:
8324 Prompt for a specific project and publish all files that belong to it.
8326 Publish the project containing the current file.
8328 Publish only the current file.
8330 Publish all projects.
8333 Org uses timestamps to track when a file has changed. The above
8334 functions normally only publish changed files. You can override this and
8335 force publishing of all files by giving a prefix argument.
8337 @node Miscellaneous, Extensions, Publishing, Top
8338 @chapter Miscellaneous
8341 * Completion:: M-TAB knows what you need
8342 * Customization:: Adapting Org to your taste
8343 * In-buffer settings:: Overview of the #+KEYWORDS
8344 * The very busy C-c C-c key:: When in doubt, press C-c C-c
8345 * Clean view:: Getting rid of leading stars in the outline
8346 * TTY keys:: Using Org on a tty
8347 * Interaction:: Other Emacs packages
8348 * Bugs:: Things which do not work perfectly
8351 @node Completion, Customization, Miscellaneous, Miscellaneous
8353 @cindex completion, of @TeX{} symbols
8354 @cindex completion, of TODO keywords
8355 @cindex completion, of dictionary words
8356 @cindex completion, of option keywords
8357 @cindex completion, of tags
8358 @cindex completion, of property keys
8359 @cindex completion, of link abbreviations
8360 @cindex @TeX{} symbol completion
8361 @cindex TODO keywords completion
8362 @cindex dictionary word completion
8363 @cindex option keyword completion
8364 @cindex tag completion
8365 @cindex link abbreviations, completion of
8367 Org supports in-buffer completion. This type of completion does
8368 not make use of the minibuffer. You simply type a few letters into
8369 the buffer and use the key to complete text right there.
8374 Complete word at point
8377 At the beginning of a headline, complete TODO keywords.
8379 After @samp{\}, complete @TeX{} symbols supported by the exporter.
8381 After @samp{*}, complete headlines in the current buffer so that they
8382 can be used in search links like @samp{[[*find this headline]]}.
8384 After @samp{:} in a headline, complete tags. The list of tags is taken
8385 from the variable @code{org-tag-alist} (possibly set through the
8386 @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
8387 dynamically from all tags used in the current buffer.
8389 After @samp{:} and not in a headline, complete property keys. The list
8390 of keys is constructed dynamically from all keys used in the current
8393 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
8395 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
8396 @samp{OPTIONS} which set file-specific options for Org mode. When the
8397 option keyword is already complete, pressing @kbd{M-@key{TAB}} again
8398 will insert example settings for this keyword.
8400 In the line after @samp{#+STARTUP: }, complete startup keywords,
8401 i.e. valid keys for this line.
8403 Elsewhere, complete dictionary words using Ispell.
8407 @node Customization, In-buffer settings, Completion, Miscellaneous
8408 @section Customization
8409 @cindex customization
8410 @cindex options, for customization
8411 @cindex variables, for customization
8413 There are more than 180 variables that can be used to customize
8414 Org. For the sake of compactness of the manual, I am not
8415 describing the variables here. A structured overview of customization
8416 variables is available with @kbd{M-x org-customize}. Or select
8417 @code{Browse Org Group} from the @code{Org->Customization} menu. Many
8418 settings can also be activated on a per-file basis, by putting special
8419 lines into the buffer (@pxref{In-buffer settings}).
8421 @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous
8422 @section Summary of in-buffer settings
8423 @cindex in-buffer settings
8424 @cindex special keywords
8426 Org mode uses special lines in the buffer to define settings on a
8427 per-file basis. These lines start with a @samp{#+} followed by a
8428 keyword, a colon, and then individual words defining a setting. Several
8429 setting words can be in the same line, but you can also have multiple
8430 lines for the keyword. While these settings are described throughout
8431 the manual, here is a summary. After changing any of those lines in the
8432 buffer, press @kbd{C-c C-c} with the cursor still in the line to
8433 activate the changes immediately. Otherwise they become effective only
8434 when the file is visited again in a new Emacs session.
8437 @item #+ARCHIVE: %s_done::
8438 This line sets the archive location for the agenda file. It applies for
8439 all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
8440 of the file. The first such line also applies to any entries before it.
8441 The corresponding variable is @code{org-archive-location}.
8443 This line sets the category for the agenda file. The category applies
8444 for all subsequent lines until the next @samp{#+CATEGORY} line, or the
8445 end of the file. The first such line also applies to any entries before it.
8446 @item #+COLUMNS: %25ITEM .....
8447 Set the default format for columns view. This format applies when
8448 columns view is invoked in location where no @code{COLUMNS} property
8450 @item #+CONSTANTS: name1=value1 ...
8451 Set file-local values for constants to be used in table formulas. This
8452 line set the local variable @code{org-table-formula-constants-local}.
8453 The global version of this variable is
8454 @code{org-table-formula-constants}.
8455 @item #+FILETAGS: :tag1:tag2:tag3:
8456 Set tags that can be inherited by any entry in the file, including the
8458 @item #+DRAWERS: NAME1 .....
8459 Set the file-local set of drawers. The corresponding global variable is
8461 @item #+LINK: linkword replace
8462 These lines (several are allowed) specify link abbreviations.
8463 @xref{Link abbreviations}. The corresponding variable is
8464 @code{org-link-abbrev-alist}.
8465 @item #+PRIORITIES: highest lowest default
8466 This line sets the limits and the default for the priorities. All three
8467 must be either letters A-Z or numbers 0-9. The highest priority must
8468 have a lower ASCII number that the lowest priority.
8469 @item #+PROPERTY: Property_Name Value
8470 This line sets a default inheritance value for entries in the current
8471 buffer, most useful for specifying the allowed values of a property.
8472 @item #+SETUPFILE: file
8473 This line defines a file that holds more in-buffer setup. Normally this is
8474 entirely ignored. Only when the buffer is parsed for option-setting lines
8475 (i.e. when starting Org mode for a file, when pressing @kbd{C-c C-c} in a
8476 settings line, or when exporting), then the contents of this file are parsed
8477 as if they had been included in the buffer. In particlar, the file can be
8478 any other Org mode file with internal setup. You can visit the file the
8479 cursor is in the line with @kbd{C-c '}.
8481 This line sets options to be used at startup of Org mode, when an
8482 Org file is being visited. The first set of options deals with the
8483 initial visibility of the outline tree. The corresponding variable for
8484 global default settings is @code{org-startup-folded}, with a default
8485 value @code{t}, which means @code{overview}.
8486 @cindex @code{overview}, STARTUP keyword
8487 @cindex @code{content}, STARTUP keyword
8488 @cindex @code{showall}, STARTUP keyword
8490 overview @r{top-level headlines only}
8491 content @r{all headlines}
8492 showall @r{no folding at all, show everything}
8494 Then there are options for aligning tables upon visiting a file. This
8495 is useful in files containing narrowed table columns. The corresponding
8496 variable is @code{org-startup-align-all-tables}, with a default value
8498 @cindex @code{align}, STARTUP keyword
8499 @cindex @code{noalign}, STARTUP keyword
8501 align @r{align all tables}
8502 noalign @r{don't align tables on startup}
8504 Logging closing and reinstating TODO items, and clock intervals
8505 (variables @code{org-log-done}, @code{org-log-note-clock-out}, and
8506 @code{org-log-repeat}) can be configured using these options.
8507 @cindex @code{logdone}, STARTUP keyword
8508 @cindex @code{lognotedone}, STARTUP keyword
8509 @cindex @code{nologdone}, STARTUP keyword
8510 @cindex @code{lognoteclock-out}, STARTUP keyword
8511 @cindex @code{nolognoteclock-out}, STARTUP keyword
8512 @cindex @code{logrepeat}, STARTUP keyword
8513 @cindex @code{lognoterepeat}, STARTUP keyword
8514 @cindex @code{nologrepeat}, STARTUP keyword
8516 logdone @r{record a timestamp when an item is marked DONE}
8517 lognotedone @r{record timestamp and a note when DONE}
8518 nologdone @r{don't record when items are marked DONE}
8519 logrepeat @r{record a time when reinstating a repeating item}
8520 lognoterepeat @r{record a note when reinstating a repeating item}
8521 nologrepeat @r{do not record when reinstating repeating item}
8522 lognoteclock-out @r{record a note when clocking out}
8523 nolognoteclock-out @r{don't record a note when clocking out}
8525 Here are the options for hiding leading stars in outline headings, and for
8526 indenting outlines. The corresponding variables are
8527 @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
8528 default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
8529 @cindex @code{hidestars}, STARTUP keyword
8530 @cindex @code{showstars}, STARTUP keyword
8531 @cindex @code{odd}, STARTUP keyword
8532 @cindex @code{even}, STARTUP keyword
8534 hidestars @r{make all but one of the stars starting a headline invisible.}
8535 showstars @r{show all stars starting a headline}
8536 indent @r{virtual indentation according to outline level}
8537 noindent @r{no virtual indentation according to outline level}
8538 odd @r{allow only odd outline levels (1,3,...)}
8539 oddeven @r{allow all outline levels}
8541 To turn on custom format overlays over time stamps (variables
8542 @code{org-put-time-stamp-overlays} and
8543 @code{org-time-stamp-overlay-formats}), use
8544 @cindex @code{customtime}, STARTUP keyword
8546 customtime @r{overlay custom time format}
8548 The following options influence the table spreadsheet (variable
8549 @code{constants-unit-system}).
8550 @cindex @code{constcgs}, STARTUP keyword
8551 @cindex @code{constSI}, STARTUP keyword
8553 constcgs @r{@file{constants.el} should use the c-g-s unit system}
8554 constSI @r{@file{constants.el} should use the SI unit system}
8556 @item #+TAGS: TAG1(c1) TAG2(c2)
8557 These lines (several such lines are allowed) specify the valid tags in
8558 this file, and (potentially) the corresponding @emph{fast tag selection}
8559 keys. The corresponding variable is @code{org-tag-alist}.
8561 This line contains the formulas for the table directly above the line.
8562 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS, #+DATE:
8563 These lines provide settings for exporting files. For more details see
8564 @ref{Export options}.
8565 @item #+SEQ_TODO: #+TYP_TODO:
8566 These lines set the TODO keywords and their interpretation in the
8567 current file. The corresponding variables are @code{org-todo-keywords}
8568 and @code{org-todo-interpretation}.
8571 @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous
8572 @section The very busy C-c C-c key
8574 @cindex C-c C-c, overview
8576 The key @kbd{C-c C-c} has many purposes in Org, which are all
8577 mentioned scattered throughout this manual. One specific function of
8578 this key is to add @emph{tags} to a headline (@pxref{Tags}). In many
8579 other circumstances it means something like @emph{Hey Org, look
8580 here and update according to what you see here}. Here is a summary of
8581 what this means in different contexts.
8585 If there are highlights in the buffer from the creation of a sparse
8586 tree, or from clock display, remove these highlights.
8588 If the cursor is in one of the special @code{#+KEYWORD} lines, this
8589 triggers scanning the buffer for these lines and updating the
8592 If the cursor is inside a table, realign the table. This command
8593 works even if the automatic table editor has been turned off.
8595 If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
8598 If the cursor is inside a table created by the @file{table.el} package,
8599 activate that table.
8601 If the current buffer is a remember buffer, close the note and file it.
8602 With a prefix argument, file it, without further interaction, to the
8605 If the cursor is on a @code{<<<target>>>}, update radio targets and
8606 corresponding links in this buffer.
8608 If the cursor is in a property line or at the start or end of a property
8609 drawer, offer property commands.
8611 If the cursor is in a plain list item with a checkbox, toggle the status
8614 If the cursor is on a numbered item in a plain list, renumber the
8617 If the cursor is on the @code{#+BEGIN} line of a dynamical block, the
8621 @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous
8622 @section A cleaner outline view
8623 @cindex hiding leading stars
8624 @cindex dynamic indentation
8625 @cindex odd-levels-only outlines
8626 @cindex clean outline view
8628 Some people find it noisy and distracting that the Org headlines are starting
8629 with a potentially large number of stars, and that text below the headlines
8630 is not indented. This is not really a problem when you are writing a book
8631 where the outline headings are really section headlines. However, in a more
8632 list-oriented outline, it is clear that an indented structure is a lot
8633 cleaner, as can be seen by comparing the two columns in the following
8638 * Top level headline | * Top level headline
8639 ** Second level | * Second level
8640 *** 3rd level | * 3rd level
8641 some text | some text
8642 *** 3rd level | * 3rd level
8643 more text | more text
8644 * Another top level headline | * Another top level headline
8649 It is non-trivial to make such a look work in Emacs, but Org contains three
8650 separate features that, combined, achieve just that.
8654 @emph{Indentation of text below headlines}@*
8655 You may indent text below each headline to make the left boundary line up
8656 with the headline, like
8660 more text, now indented
8663 A good way to get this indentation is by hand, and Org supports this with
8664 paragraph filling, line wrapping, and structure editing@footnote{See also the
8665 variable @code{org-adapt-indentation}.} preserving or adapting the
8666 indentation appropriate. A different approach would be to have a way to
8667 automatically indent lines according to outline structure by adding overlays
8668 or text properties. But I have not yet found a robust and efficient way to
8669 do this in large files.
8672 @emph{Hiding leading stars}@* You can modify the display in such a way that
8673 all leading stars become invisible. To do this in a global way, configure
8674 the variable @code{org-hide-leading-stars} or change this on a per-file basis
8678 #+STARTUP: hidestars
8682 Note that the opposite behavior is selected with @code{showstars}.
8684 With hidden stars, the tree becomes:
8688 * Top level headline
8696 Note that the leading stars are not truly replaced by whitespace, they
8697 are only fontified with the face @code{org-hide} that uses the
8698 background color as font color. If you are not using either white or
8699 black background, you may have to customize this face to get the wanted
8700 effect. Another possibility is to set this font such that the extra
8701 stars are @i{almost} invisible, for example using the color
8702 @code{grey90} on a white background.
8705 Things become cleaner still if you skip all the even levels and use only odd
8706 levels 1, 3, 5..., effectively adding two stars to go from one outline level
8707 to the next. In this way we get the outline view shown at the beginning of
8708 this section. In order to make the structure editing and export commands
8709 handle this convention correctly, configure the variable
8710 @code{org-odd-levels-only}, or set this on a per-file basis with one of the
8718 You can convert an Org file from single-star-per-level to the
8719 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
8720 RET} in that file. The reverse operation is @kbd{M-x
8721 org-convert-to-oddeven-levels}.
8724 @node TTY keys, Interaction, Clean view, Miscellaneous
8725 @section Using Org on a tty
8726 @cindex tty key bindings
8728 Because Org contains a large number of commands, by default much of
8729 Org's core commands are bound to keys that are generally not
8730 accessible on a tty, such as the cursor keys (@key{left}, @key{right},
8731 @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
8732 together with modifiers like @key{Meta} and/or @key{Shift}. To access
8733 these commands on a tty when special keys are unavailable, the following
8734 alternative bindings can be used. The tty bindings below will likely be
8735 more cumbersome; you may find for some of the bindings below that a
8736 customized work-around suits you better. For example, changing a time
8737 stamp is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
8738 tty you would rather use @kbd{C-c .} to re-insert the timestamp.
8740 @multitable @columnfractions 0.15 0.2 0.2
8741 @item @b{Default} @tab @b{Alternative 1} @tab @b{Alternative 2}
8742 @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab
8743 @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{@key{Esc} @key{left}}
8744 @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab
8745 @item @kbd{M-@key{right}} @tab @kbd{C-c C-x i} @tab @kbd{@key{Esc} @key{right}}
8746 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab
8747 @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{@key{Esc} @key{up}}
8748 @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab
8749 @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{@key{Esc} @key{down}}
8750 @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab
8751 @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab
8752 @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{@key{Esc} @key{RET}}
8753 @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab
8754 @item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab
8755 @item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab
8756 @item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab
8757 @item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab
8758 @item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab
8759 @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab
8762 @node Interaction, Bugs, TTY keys, Miscellaneous
8763 @section Interaction with other packages
8764 @cindex packages, interaction with other
8765 Org lives in the world of GNU Emacs and interacts in various ways
8766 with other code out there.
8769 * Cooperation:: Packages Org cooperates with
8770 * Conflicts:: Packages that lead to conflicts
8773 @node Cooperation, Conflicts, Interaction, Interaction
8774 @subsection Packages that Org cooperates with
8777 @cindex @file{calc.el}
8778 @item @file{calc.el} by Dave Gillespie
8779 Org uses the Calc package for implementing spreadsheet
8780 functionality in its tables (@pxref{The spreadsheet}). Org
8781 checks for the availability of Calc by looking for the function
8782 @code{calc-eval} which should be autoloaded in your setup if Calc has
8783 been installed properly. As of Emacs 22, Calc is part of the Emacs
8784 distribution. Another possibility for interaction between the two
8785 packages is using Calc for embedded calculations. @xref{Embedded Mode,
8786 , Embedded Mode, Calc, GNU Emacs Calc Manual}.
8787 @cindex @file{constants.el}
8788 @item @file{constants.el} by Carsten Dominik
8789 In a table formula (@pxref{The spreadsheet}), it is possible to use
8790 names for natural constants or units. Instead of defining your own
8791 constants in the variable @code{org-table-formula-constants}, install
8792 the @file{constants} package which defines a large number of constants
8793 and units, and lets you use unit prefixes like @samp{M} for
8794 @samp{Mega} etc. You will need version 2.0 of this package, available
8795 at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for
8796 the function @code{constants-get}, which has to be autoloaded in your
8797 setup. See the installation instructions in the file
8798 @file{constants.el}.
8799 @item @file{cdlatex.el} by Carsten Dominik
8800 @cindex @file{cdlatex.el}
8801 Org mode can make use of the CDLaTeX package to efficiently enter
8802 La@TeX{} fragments into Org files. See @ref{CDLaTeX mode}.
8803 @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
8804 @cindex @file{imenu.el}
8805 Imenu allows menu access to an index of items in a file. Org mode
8806 supports Imenu - all you need to do to get the index is the following:
8808 (add-hook 'org-mode-hook
8809 (lambda () (imenu-add-to-menubar "Imenu")))
8811 By default the index is two levels deep - you can modify the depth using
8812 the option @code{org-imenu-depth}.
8813 @item @file{remember.el} by John Wiegley
8814 @cindex @file{remember.el}
8815 Org cooperates with remember, see @ref{Remember}.
8816 @file{Remember.el} is not part of Emacs, find it on the web.
8817 @item @file{speedbar.el} by Eric M. Ludlam
8818 @cindex @file{speedbar.el}
8819 Speedbar is a package that creates a special frame displaying files and
8820 index items in files. Org mode supports Speedbar and allows you to
8821 drill into Org files directly from the Speedbar. It also allows to
8822 restrict the scope of agenda commands to a file or a subtree by using
8823 the command @kbd{<} in the Speedbar frame.
8824 @cindex @file{table.el}
8825 @item @file{table.el} by Takaaki Ota
8827 @cindex table editor, @file{table.el}
8828 @cindex @file{table.el}
8830 Complex ASCII tables with automatic line wrapping, column- and
8831 row-spanning, and alignment can be created using the Emacs table
8832 package by Takaaki Ota (@uref{http://sourceforge.net/projects/table},
8833 and also part of Emacs 22).
8834 When @key{TAB} or @kbd{C-c C-c} is pressed in such a table, Org mode
8835 will call @command{table-recognize-table} and move the cursor into the
8836 table. Inside a table, the keymap of Org mode is inactive. In order
8837 to execute Org mode-related commands, leave the table.
8842 Recognize @file{table.el} table. Works when the cursor is in a
8847 Insert a table.el table. If there is already a table at point, this
8848 command converts it between the table.el format and the Org mode
8849 format. See the documentation string of the command
8850 @code{org-convert-table} for the restrictions under which this is
8853 @file{table.el} is part of Emacs 22.
8854 @cindex @file{footnote.el}
8855 @item @file{footnote.el} by Steven L. Baur
8856 Org mode recognizes numerical footnotes as provided by this package
8857 (@pxref{Footnotes}).
8860 @node Conflicts, , Cooperation, Interaction
8861 @subsection Packages that lead to conflicts with Org mode
8865 @cindex @file{allout.el}
8866 @item @file{allout.el} by Ken Manheimer
8867 Startup of Org may fail with the error message
8868 @code{(wrong-type-argument keymapp nil)} when there is an outdated
8869 version @file{allout.el} on the load path, for example the version
8870 distributed with Emacs 21.x. Upgrade to Emacs 22 and this problem will
8871 disappear. If for some reason you cannot do this, make sure that org.el
8872 is loaded @emph{before} @file{allout.el}, for example by putting
8873 @code{(require 'org)} early enough into your @file{.emacs} file.
8875 @cindex @file{CUA.el}
8876 @item @file{CUA.el} by Kim. F. Storm
8877 Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by
8878 CUA mode (as well as pc-select-mode and s-region-mode) to select and
8879 extend the region. If you want to use one of these packages along with
8880 Org, configure the variable @code{org-replace-disputed-keys}. When
8881 set, Org will move the following key bindings in Org files, and
8882 in the agenda buffer (but not during date selection).
8885 S-UP -> M-p S-DOWN -> M-n
8886 S-LEFT -> M-- S-RIGHT -> M-+
8889 Yes, these are unfortunately more difficult to remember. If you want
8890 to have other replacement keys, look at the variable
8891 @code{org-disputed-keys}.
8892 @item @file{windmove.el} by Hovav Shacham
8893 @cindex @file{windmove.el}
8894 Also this package uses the @kbd{S-<cursor>} keys, so everything written
8895 in the paragraph above about CUA mode also applies here.
8897 @cindex @file{footnote.el}
8898 @item @file{footnote.el} by Steven L. Baur
8899 Org supports the syntax of the footnote package, but only the
8900 numerical footnote markers. Also, the default key for footnote
8901 commands, @kbd{C-c !} is already used by Org. You could use the
8902 variable @code{footnote-prefix} to switch footnotes commands to another
8903 key. Or, you could use @code{org-replace-disputed-keys} and
8904 @code{org-disputed-keys} to change the settings in Org.
8909 @node Bugs, , Interaction, Miscellaneous
8913 Here is a list of things that should work differently, but which I
8914 have found too hard to fix.
8918 If a table field starts with a link, and if the corresponding table
8919 column is narrowed (@pxref{Narrow columns}) to a width too small to
8920 display the link, the field would look entirely empty even though it is
8921 not. To prevent this, Org throws an error. The work-around is to
8922 make the column wide enough to fit the link, or to add some text (at
8923 least 2 characters) before the link in the same field.
8925 Narrowing table columns does not work on XEmacs, because the
8926 @code{format} function does not transport text properties.
8928 Text in an entry protected with the @samp{QUOTE} keyword should not
8931 When the application called by @kbd{C-c C-o} to open a file link fails
8932 (for example because the application does not exist or refuses to open
8933 the file), it does so silently. No error message is displayed.
8935 Recalculating a table line applies the formulas from left to right.
8936 If a formula uses @emph{calculated} fields further down the row,
8937 multiple recalculation may be needed to get all fields consistent. You
8938 may use the command @code{org-table-iterate} (@kbd{C-u C-c *}) to
8939 recalculate until convergence.
8941 The exporters work well, but could be made more efficient.
8945 @node Extensions, Hacking, Miscellaneous, Top
8946 @appendix Extensions
8948 This appendix lists the extension modules that have been written for Org.
8949 Many of these extensions live in the @file{contrib} directory of the Org
8950 distribution, others are available somewhere on the web.
8953 * Extensions in the contrib directory:: These come with the Org distro
8954 * Other extensions:: These you have to find on the web.
8957 @node Extensions in the contrib directory, Other extensions, Extensions, Extensions
8958 @section Extensions in the @file{contrib} directory
8961 @item @file{org-annotate-file.el} by @i{Philip Jackson}
8962 Annotate a file with org syntax, in a separate file, with links back to
8964 @item @file{org-annotation-helper.el} by @i{Bastien Guerry and Daniel E. German}
8965 Call @i{remember} directly from Firefox/Opera, or from Adobe Reader.
8966 When activating a special link or bookmark, Emacs receives a trigger to
8967 create a note with a link back to the website. Requires some setup, a
8968 detailes description is in
8969 @file{contrib/packages/org-annotation-helper}.
8970 @item @file{org-bookmark.el} by @i{Tokuya Kameshima}
8971 Support for links to Emacs bookmarks.
8972 @item @file{org-depend.el} by @i{Carsten Dominik}
8973 TODO dependencies for Org-mode. Make TODO state changes in one entry
8974 trigger changes in another, or be blocked by the state of another
8975 entry. Also, easily create chains of TODO items with exactly one
8976 active item at any time.
8977 @item @file{org-elisp-symbol.el} by @i{Bastien Guerry}
8978 Org links to emacs-lisp symbols. This can create annotated links that
8979 exactly point to the definition location of a variable of function.
8980 @item @file{org-eval.el} by @i{Carsten Dominik}
8981 The @code{<lisp>} tag, adapted from Emacs Wiki and Emacs Muse, allows
8982 to include text in a document that is the result of evaluating some
8983 code. Other scripting languages like @code{perl} can be supported with
8984 this package as well.
8985 @item @file{org-expiry.el} by @i{Bastien Guerry}
8986 Expiry mechanism for Org entries.
8987 @item @file{org-indent.el} by @i{Carsten Dominik}
8988 Dynamic indentation of Org outlines. The plan is to indent an outline
8989 according to level, but so far this is too hard for a proper and stable
8990 implementation. Still, it works somewhat.
8991 @item @file{org-interactive-query.el} by @i{Christopher League}
8992 Interactive modification of tags queries. After running a general
8993 query in Org, this package allows to narrow down the results by adding
8994 more tags or keywords.
8995 @item @file{org-mairix.el} by @i{Georg C. F. Greve}
8996 Hook mairix search into Org for different MUAs.
8997 @item @file{org-man.el} by @i{Carsten Dominik}
8998 Support for links to manpages in Org-mode.
8999 @item @file{org-mtags.el} by @i{Carsten Dominik}
9000 Support for some Muse-like tags in Org-mode. This package allows you
9001 to write @code{<example>} and @code{<src>} and other syntax copied from
9002 Emacs Muse, right inside an Org file. The goal here is to make it easy
9003 to publish the same file using either org-publish or Muse.
9004 @item @file{org-panel.el} by @i{Lennard Borgman}
9005 Simplified and display-aided access to some Org commands.
9006 @c @item @file{org-plot.el} by @i{Eric Schulte}
9007 @c Plotting Org tables with Gnuplot.
9008 @item @file{org-registry.el} by @i{Bastien Guerry}
9009 A registry for Org links, to find out from where links point to a given
9011 @item @file{org2rem.el} by @i{Bastien Guerry}
9012 Convert org appointments into reminders for the @file{remind} program.
9013 @item @file{org-screen.el} by @i{Andrew Hyatt}
9014 Visit screen sessions through Org-mode links.
9015 @item @file{org-toc.el} by @i{Bastien Guerry}
9016 Table of contents in a separate buffer, with fast access to sections
9017 and easy visibility cycling.
9018 @item @file{orgtbl-sqlinsert.el} by @i{Jason Riedy}
9019 Convert Org-mode tables to SQL insertions. Documentation for this can
9020 be found on the Worg pages.
9024 @node Other extensions, , Extensions in the contrib directory, Extensions
9025 @section Other extensions
9029 @node Hacking, History and Acknowledgments, Extensions, Top
9032 This appendix covers some aspects where users can extend the functionality of
9036 * Adding hyperlink types:: New custom link types
9037 * Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs
9038 * Dynamic blocks:: Automatically filled blocks
9039 * Special agenda views:: Customized views
9040 * Using the property API:: Writing programs that use entry properties
9041 * Using the mapping API:: Mapping over all or selected entries
9044 @node Adding hyperlink types, Tables in arbitrary syntax, Hacking, Hacking
9045 @section Adding hyperlink types
9046 @cindex hyperlinks, adding new types
9048 Org has a large number of hyperlink types built-in
9049 (@pxref{Hyperlinks}). If you would like to add new link types, it
9050 provides an interface for doing so. Let's look at an example file
9051 @file{org-man.el} that will add support for creating links like
9052 @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
9056 ;;; org-man.el - Support for links to manpages in Org
9060 (org-add-link-type "man" 'org-man-open)
9061 (add-hook 'org-store-link-functions 'org-man-store-link)
9063 (defcustom org-man-command 'man
9064 "The Emacs command to be used to display a man page."
9066 :type '(choice (const man) (const woman)))
9068 (defun org-man-open (path)
9069 "Visit the manpage on PATH.
9070 PATH should be a topic that can be thrown at the man command."
9071 (funcall org-man-command path))
9073 (defun org-man-store-link ()
9074 "Store a link to a manpage."
9075 (when (memq major-mode '(Man-mode woman-mode))
9076 ;; This is a man page, we do make this link
9077 (let* ((page (org-man-get-page-name))
9078 (link (concat "man:" page))
9079 (description (format "Manpage for %s" page)))
9080 (org-store-link-props
9083 :description description))))
9085 (defun org-man-get-page-name ()
9086 "Extract the page name from the buffer name."
9087 ;; This works for both `Man-mode' and `woman-mode'.
9088 (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
9089 (match-string 1 (buffer-name))
9090 (error "Cannot create link to this man page")))
9094 ;;; org-man.el ends here
9098 You would activate this new link type in @file{.emacs} with
9105 Let's go through the file and see what it does.
9108 It does @code{(require 'org)} to make sure that @file{org.el} has been
9111 The next line calls @code{org-add-link-type} to define a new link type
9112 with prefix @samp{man}. The call also contains the name of a function
9113 that will be called to follow such a link.
9115 The next line adds a function to @code{org-store-link-functions}, in
9116 order to allow the command @kbd{C-c l} to record a useful link in a
9117 buffer displaying a man page.
9120 The rest of the file defines the necessary variables and functions.
9121 First there is a customization variable that determines which emacs
9122 command should be used to display man pages. There are two options,
9123 @code{man} and @code{woman}. Then the function to follow a link is
9124 defined. It gets the link path as an argument - in this case the link
9125 path is just a topic for the manual command. The function calls the
9126 value of @code{org-man-command} to display the man page.
9128 Finally the function @code{org-man-store-link} is defined. When you try
9129 to store a link with @kbd{C-c l}, also this function will be called to
9130 try to make a link. The function must first decide if it is supposed to
9131 create the link for this buffer type, we do this by checking the value
9132 of the variable @code{major-mode}. If not, the function must exit and
9133 return the value @code{nil}. If yes, the link is created by getting the
9134 manual topic from the buffer name and prefixing it with the string
9135 @samp{man:}. Then it must call the command @code{org-store-link-props}
9136 and set the @code{:type} and @code{:link} properties. Optionally you
9137 can also set the @code{:description} property to provide a default for
9138 the link description when the link is later inserted into an Org
9139 buffer with @kbd{C-c C-l}.
9141 @node Tables in arbitrary syntax, Dynamic blocks, Adding hyperlink types, Hacking
9142 @section Tables and lists in arbitrary syntax
9143 @cindex tables, in other modes
9144 @cindex lists, in other modes
9147 Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
9148 frequent feature request has been to make it work with native tables in
9149 specific languages, for example La@TeX{}. However, this is extremely
9150 hard to do in a general way, would lead to a customization nightmare,
9151 and would take away much of the simplicity of the Orgtbl mode table
9155 This appendix describes a different approach. We keep the Orgtbl mode
9156 table in its native format (the @i{source table}), and use a custom
9157 function to @i{translate} the table to the correct syntax, and to
9158 @i{install} it in the right location (the @i{target table}). This puts
9159 the burden of writing conversion functions on the user, but it allows
9160 for a very flexible system.
9162 Bastien added the ability to do the same with lists. You can use Org's
9163 facilities to edit and structure lists by turning @code{orgstruct-mode}
9164 on, then locally exporting such lists in another format (HTML, La@TeX{}
9169 * Radio tables:: Sending and receiving
9170 * A LaTeX example:: Step by step, almost a tutorial
9171 * Translator functions:: Copy and modify
9172 * Radio lists:: Doing the same for lists
9175 @node Radio tables, A LaTeX example, Tables in arbitrary syntax, Tables in arbitrary syntax
9176 @subsection Radio tables
9177 @cindex radio tables
9179 To define the location of the target table, you first need to create two
9180 lines that are comments in the current mode, but contain magic words for
9181 Orgtbl mode to find. Orgtbl mode will insert the translated table
9182 between these lines, replacing whatever was there before. For example:
9185 /* BEGIN RECEIVE ORGTBL table_name */
9186 /* END RECEIVE ORGTBL table_name */
9190 Just above the source table, we put a special line that tells
9191 Orgtbl mode how to translate this table and where to install it. For
9194 #+ORGTBL: SEND table_name translation_function arguments....
9198 @code{table_name} is the reference name for the table that is also used
9199 in the receiver lines. @code{translation_function} is the Lisp function
9200 that does the translation. Furthermore, the line can contain a list of
9201 arguments (alternating key and value) at the end. The arguments will be
9202 passed as a property list to the translation function for
9203 interpretation. A few standard parameters are already recognized and
9204 acted upon before the translation function is called:
9208 Skip the first N lines of the table. Hlines do count as separate lines for
9211 @item :skipcols (n1 n2 ...)
9212 List of columns that should be skipped. If the table has a column with
9213 calculation marks, that column is automatically discarded as well.
9214 Please note that the translator function sees the table @emph{after} the
9215 removal of these columns, the function never knows that there have been
9220 The one problem remaining is how to keep the source table in the buffer
9221 without disturbing the normal workings of the file, for example during
9222 compilation of a C file or processing of a La@TeX{} file. There are a
9223 number of different solutions:
9227 The table could be placed in a block comment if that is supported by the
9228 language. For example, in C mode you could wrap the table between
9229 @samp{/*} and @samp{*/} lines.
9231 Sometimes it is possible to put the table after some kind of @i{END}
9232 statement, for example @samp{\bye} in TeX and @samp{\end@{document@}}
9235 You can just comment the table line by line whenever you want to process
9236 the file, and uncomment it whenever you need to edit the table. This
9237 only sounds tedious - the command @kbd{M-x orgtbl-toggle-comment} does
9238 make this comment-toggling very easy, in particular if you bind it to a
9242 @node A LaTeX example, Translator functions, Radio tables, Tables in arbitrary syntax
9243 @subsection A LaTeX example of radio tables
9244 @cindex LaTeX, and Orgtbl mode
9246 The best way to wrap the source table in La@TeX{} is to use the
9247 @code{comment} environment provided by @file{comment.sty}. It has to be
9248 activated by placing @code{\usepackage@{comment@}} into the document
9249 header. Orgtbl mode can insert a radio table skeleton@footnote{By
9250 default this works only for La@TeX{}, HTML, and Texinfo. Configure the
9251 variable @code{orgtbl-radio-tables} to install templates for other
9252 modes.} with the command @kbd{M-x orgtbl-insert-radio-table}. You will
9253 be prompted for a table name, lets say we use @samp{salesfigures}. You
9254 will then get the following template:
9256 @cindex #+ORGTBL: SEND
9258 % BEGIN RECEIVE ORGTBL salesfigures
9259 % END RECEIVE ORGTBL salesfigures
9261 #+ORGTBL: SEND salesfigures orgtbl-to-latex
9267 The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
9268 @code{orgtbl-to-latex} to convert the table into La@TeX{} and to put it
9269 into the receiver location with name @code{salesfigures}. You may now
9270 fill in the table, feel free to use the spreadsheet features@footnote{If
9271 the @samp{#+TBLFM} line contains an odd number of dollar characters,
9272 this may cause problems with font-lock in LaTeX mode. As shown in the
9273 example you can fix this by adding an extra line inside the
9274 @code{comment} environment that is used to balance the dollar
9275 expressions. If you are using AUCTeX with the font-latex library, a
9276 much better solution is to add the @code{comment} environment to the
9277 variable @code{LaTeX-verbatim-environments}.}:
9280 % BEGIN RECEIVE ORGTBL salesfigures
9281 % END RECEIVE ORGTBL salesfigures
9283 #+ORGTBL: SEND salesfigures orgtbl-to-latex
9284 | Month | Days | Nr sold | per day |
9285 |-------+------+---------+---------|
9286 | Jan | 23 | 55 | 2.4 |
9287 | Feb | 21 | 16 | 0.8 |
9288 | March | 22 | 278 | 12.6 |
9289 #+TBLFM: $4=$3/$2;%.1f
9290 % $ (optional extra dollar to keep font-lock happy, see footnote)
9295 When you are done, press @kbd{C-c C-c} in the table to get the converted
9296 table inserted between the two marker lines.
9298 Now lets assume you want to make the table header by hand, because you
9299 want to control how columns are aligned etc. In this case we make sure
9300 that the table translator does skip the first 2 lines of the source
9301 table, and tell the command to work as a @i{splice}, i.e. to not produce
9302 header and footer commands of the target table:
9305 \begin@{tabular@}@{lrrr@}
9306 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
9307 % BEGIN RECEIVE ORGTBL salesfigures
9308 % END RECEIVE ORGTBL salesfigures
9312 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
9313 | Month | Days | Nr sold | per day |
9314 |-------+------+---------+---------|
9315 | Jan | 23 | 55 | 2.4 |
9316 | Feb | 21 | 16 | 0.8 |
9317 | March | 22 | 278 | 12.6 |
9318 #+TBLFM: $4=$3/$2;%.1f
9322 The La@TeX{} translator function @code{orgtbl-to-latex} is already part of
9323 Orgtbl mode. It uses a @code{tabular} environment to typeset the table
9324 and marks horizontal lines with @code{\hline}. Furthermore, it
9325 interprets the following parameters (see also @ref{Translator functions}):
9329 When set to t, return only table body lines, don't wrap them into a
9330 tabular environment. Default is nil.
9333 A format to be used to wrap each field, should contain @code{%s} for the
9334 original field value. For example, to wrap each field value in dollars,
9335 you could use @code{:fmt "$%s$"}. This may also be a property list with
9336 column numbers and formats. for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
9337 A function of one argument can be used in place of the strings; the
9338 function must return a formatted string.
9341 Use this format to print numbers with exponentials. The format should
9342 have @code{%s} twice for inserting mantissa and exponent, for example
9343 @code{"%s\\times10^@{%s@}"}. The default is @code{"%s\\,(%s)"}. This
9344 may also be a property list with column numbers and formats, for example
9345 @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After
9346 @code{efmt} has been applied to a value, @code{fmt} will also be
9347 applied. Similar to @code{fmt}, functions of two arguments can be
9348 supplied instead of strings.
9351 @node Translator functions, Radio lists, A LaTeX example, Tables in arbitrary syntax
9352 @subsection Translator functions
9353 @cindex HTML, and Orgtbl mode
9354 @cindex translator function
9356 Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
9357 (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
9358 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and @code{orgtbl-to-texinfo}.
9359 Except for @code{orgtbl-to-html}@footnote{The HTML translator uses the same
9360 code that produces tables during HTML export.}, these all use a generic
9361 translator, @code{orgtbl-to-generic}. For example, @code{orgtbl-to-latex}
9362 itself is a very short function that computes the column definitions for the
9363 @code{tabular} environment, defines a few field and line separators and then
9364 hands over to the generic translator. Here is the entire code:
9368 (defun orgtbl-to-latex (table params)
9369 "Convert the Orgtbl mode TABLE to LaTeX."
9370 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
9371 org-table-last-alignment ""))
9374 :tstart (concat "\\begin@{tabular@}@{" alignment "@}")
9375 :tend "\\end@{tabular@}"
9376 :lstart "" :lend " \\\\" :sep " & "
9377 :efmt "%s\\,(%s)" :hline "\\hline")))
9378 (orgtbl-to-generic table (org-combine-plists params2 params))))
9382 As you can see, the properties passed into the function (variable
9383 @var{PARAMS}) are combined with the ones newly defined in the function
9384 (variable @var{PARAMS2}). The ones passed into the function (i.e. the
9385 ones set by the @samp{ORGTBL SEND} line) take precedence. So if you
9386 would like to use the La@TeX{} translator, but wanted the line endings to
9387 be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
9388 overrule the default with
9391 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
9394 For a new language, you can either write your own converter function in
9395 analogy with the La@TeX{} translator, or you can use the generic function
9396 directly. For example, if you have a language where a table is started
9397 with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are
9398 started with @samp{!BL!}, ended with @samp{!EL!} and where the field
9399 separator is a TAB, you could call the generic translator like this (on
9403 #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
9404 :lstart "!BL! " :lend " !EL!" :sep "\t"
9408 Please check the documentation string of the function
9409 @code{orgtbl-to-generic} for a full list of parameters understood by
9410 that function and remember that you can pass each of them into
9411 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
9412 using the generic function.
9414 Of course you can also write a completely new function doing complicated
9415 things the generic translator cannot do. A translator function takes
9416 two arguments. The first argument is the table, a list of lines, each
9417 line either the symbol @code{hline} or a list of fields. The second
9418 argument is the property list containing all parameters specified in the
9419 @samp{#+ORGTBL: SEND} line. The function must return a single string
9420 containing the formatted table. If you write a generally useful
9421 translator, please post it on @code{emacs-orgmode@@gnu.org} so that
9422 others can benefit from your work.
9424 @node Radio lists, , Translator functions, Tables in arbitrary syntax
9425 @subsection Radio lists
9427 @cindex org-list-insert-radio-list
9429 Sending and receiving radio lists works exactly the same way than
9430 sending and receiving radio tables (@pxref{Radio tables}) @footnote{You
9431 need to load the @code{org-export-latex.el} package to use radio lists
9432 since the relevant code is there for now.}. As for radio tables, you
9433 can insert radio lists templates in HTML, La@TeX{} and Texinfo modes by
9434 calling @code{org-list-insert-radio-list}.
9436 Here are the differences with radio tables:
9440 Use @code{ORGLST} instead of @code{ORGTBL}.
9442 The available translation functions for radio lists don't take
9445 `C-c C-c' will work when pressed on the first item of the list.
9448 Here is a La@TeX{} example. Let's say that you have this in your
9452 % BEGIN RECEIVE ORGLST to-buy
9453 % END RECEIVE ORGLST to-buy
9455 #+ORGLIST: SEND to-buy orgtbl-to-latex
9464 Pressing `C-c C-c' on @code{a new house} and will insert the converted
9465 La@TeX{} list between the two marker lines.
9467 @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Hacking
9468 @section Dynamic blocks
9469 @cindex dynamic blocks
9471 Org documents can contain @emph{dynamic blocks}. These are
9472 specially marked regions that are updated by some user-written function.
9473 A good example for such a block is the clock table inserted by the
9474 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
9476 Dynamic block are enclosed by a BEGIN-END structure that assigns a name
9477 to the block and can also specify parameters for the function producing
9478 the content of the block.
9480 #+BEGIN:dynamic block
9482 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
9487 Dynamic blocks are updated with the following commands
9492 Update dynamic block at point.
9493 @kindex C-u C-c C-x C-u
9494 @item C-u C-c C-x C-u
9495 Update all dynamic blocks in the current file.
9498 Updating a dynamic block means to remove all the text between BEGIN and
9499 END, parse the BEGIN line for parameters and then call the specific
9500 writer function for this block to insert the new content. If you want
9501 to use the original content in the writer function, you can use the
9502 extra parameter @code{:content}.
9504 For a block with name @code{myblock}, the writer function is
9505 @code{org-dblock-write:myblock} with as only parameter a property list
9506 with the parameters given in the begin line. Here is a trivial example
9507 of a block that keeps track of when the block update function was last
9511 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
9517 The corresponding block writer function could look like this:
9520 (defun org-dblock-write:block-update-time (params)
9521 (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
9522 (insert "Last block update at: "
9523 (format-time-string fmt (current-time)))))
9526 If you want to make sure that all dynamic blocks are always up-to-date,
9527 you could add the function @code{org-update-all-dblocks} to a hook, for
9528 example @code{before-save-hook}. @code{org-update-all-dblocks} is
9529 written in a way that is does nothing in buffers that are not in
9532 @node Special agenda views, Using the property API, Dynamic blocks, Hacking
9533 @section Special agenda views
9534 @cindex agenda views, user-defined
9536 Org provides a special hook that can be used to narrow down the
9537 selection made by any of the agenda views. You may specify a function
9538 that is used at each match to verify if the match should indeed be part
9539 of the agenda view, and if not, how much should be skipped.
9541 Let's say you want to produce a list of projects that contain a WAITING
9542 tag anywhere in the project tree. Let's further assume that you have
9543 marked all tree headings that define a project with the TODO keyword
9544 PROJECT. In this case you would run a TODO search for the keyword
9545 PROJECT, but skip the match unless there is a WAITING tag anywhere in
9546 the subtree belonging to the project line.
9548 To achieve this, you must write a function that searches the subtree for
9549 the tag. If the tag is found, the function must return @code{nil} to
9550 indicate that this match should not be skipped. If there is no such
9551 tag, return the location of the end of the subtree, to indicate that
9552 search should continue from there.
9555 (defun my-skip-unless-waiting ()
9556 "Skip trees that are not waiting"
9557 (let ((subtree-end (save-excursion (org-end-of-subtree t))))
9558 (if (re-search-forward ":waiting:" subtree-end t)
9559 nil ; tag found, do not skip
9560 subtree-end))) ; tag not found, continue after end of subtree
9563 Now you may use this function in an agenda custom command, for example
9567 (org-add-agenda-custom-command
9568 '("b" todo "PROJECT"
9569 ((org-agenda-skip-function 'my-skip-unless-waiting)
9570 (org-agenda-overriding-header "Projects waiting for something: "))))
9573 Note that this also binds @code{org-agenda-overriding-header} to get a
9574 meaningful header in the agenda view.
9576 A general way to create custom searches is to base them on a search for
9577 entries with a certain level limit. If you want to study all entries with
9578 your custom search function, simply do a search for @samp{LEVEL>0}, and then
9579 use @code{org-agenda-skip-function} to select the entries you really want to
9582 You may also put a Lisp form into @code{org-agenda-skip-function}. In
9583 particular, you may use the functions @code{org-agenda-skip-entry-if}
9584 and @code{org-agenda-skip-subtree-if} in this form, for example:
9587 @item '(org-agenda-skip-entry-if 'scheduled)
9588 Skip current entry if it has been scheduled.
9589 @item '(org-agenda-skip-entry-if 'notscheduled)
9590 Skip current entry if it has not been scheduled.
9591 @item '(org-agenda-skip-entry-if 'deadline)
9592 Skip current entry if it has a deadline.
9593 @item '(org-agenda-skip-entry-if 'scheduled 'deadline)
9594 Skip current entry if it has a deadline, or if it is scheduled.
9595 @item '(org-agenda-skip-entry 'regexp "regular expression")
9596 Skip current entry if the regular expression matches in the entry.
9597 @item '(org-agenda-skip-entry 'notregexp "regular expression")
9598 Skip current entry unless the regular expression matches.
9599 @item '(org-agenda-skip-subtree-if 'regexp "regular expression")
9600 Same as above, but check and skip the entire subtree.
9603 Therefore we could also have written the search for WAITING projects
9604 like this, even without defining a special function:
9607 (org-add-agenda-custom-command
9608 '("b" todo "PROJECT"
9609 ((org-agenda-skip-function '(org-agenda-skip-subtree-if
9610 'regexp ":waiting:"))
9611 (org-agenda-overriding-header "Projects waiting for something: "))))
9614 @node Using the property API, Using the mapping API, Special agenda views, Hacking
9615 @section Using the property API
9616 @cindex API, for properties
9617 @cindex properties, API
9619 Here is a description of the functions that can be used to work with
9622 @defun org-entry-properties &optional pom which
9623 Get all properties of the entry at point-or-marker POM.
9624 This includes the TODO keyword, the tags, time strings for deadline,
9625 scheduled, and clocking, and any additional properties defined in the
9626 entry. The return value is an alist, keys may occur multiple times
9627 if the property key was used several times.
9628 POM may also be nil, in which case the current entry is used.
9629 If WHICH is nil or `all', get all properties. If WHICH is
9630 `special' or `standard', only get that subclass.
9632 @defun org-entry-get pom property &optional inherit
9633 Get value of PROPERTY for entry at point-or-marker POM. By default,
9634 this only looks at properties defined locally in the entry. If INHERIT
9635 is non-nil and the entry does not have the property, then also check
9636 higher levels of the hierarchy. If INHERIT is the symbol
9637 @code{selective}, use inheritance if and only if the setting of
9638 @code{org-use-property-inheritance} selects PROPERTY for inheritance.
9641 @defun org-entry-delete pom property
9642 Delete the property PROPERTY from entry at point-or-marker POM.
9645 @defun org-entry-put pom property value
9646 Set PROPERTY to VALUE for entry at point-or-marker POM.
9649 @defun org-buffer-property-keys &optional include-specials
9650 Get all property keys in the current buffer.
9653 @defun org-insert-property-drawer
9654 Insert a property drawer at point.
9657 @defun org-entry-put-multivalued-property pom property &rest values
9658 Set PROPERTY at point-or-marker POM to VALUES. VALUES should be a list of
9659 strings. They will be concatenated, with spaces as separators.
9662 @defun org-entry-get-multivalued-property pom property
9663 Treat the value of the property PROPERTY as a whitespace-separated list of
9664 values and return the values as a list of strings.
9667 @defun org-entry-add-to-multivalued-property pom property value
9668 Treat the value of the property PROPERTY as a whitespace-separated list of
9669 values and make sure that VALUE is in this list.
9672 @defun org-entry-remove-from-multivalued-property pom property value
9673 Treat the value of the property PROPERTY as a whitespace-separated list of
9674 values and make sure that VALUE is @emph{not} in this list.
9677 @defun org-entry-member-in-multivalued-property pom property value
9678 Treat the value of the property PROPERTY as a whitespace-separated list of
9679 values and check if VALUE is in this list.
9682 @node Using the mapping API, , Using the property API, Hacking
9683 @section Using the mapping API
9684 @cindex API, for mapping
9685 @cindex mapping entries, API
9687 Org has sophisticated mapping capabilities to find all entries satisfying
9688 certain criteria. Internally, this functionality is used to produce agenda
9689 views, but there is also an API that can be used to execute arbitrary
9690 functions for each or selected entries. The main entry point for this API
9693 @defun org-map-entries func &optional match scope &rest skip
9694 Call FUNC at each headline selected by MATCH in SCOPE.
9696 FUNC is a function or a lisp form. The function will be called without
9697 arguments, with the cursor positioned at the beginning of the headline.
9698 The return values of all calls to the function will be collected and
9701 MATCH is a tags/property/todo match as it is used in the agenda match view.
9702 Only headlines that are matched by this query will be considered during
9703 the iteration. When MATCH is nil or t, all headlines will be
9704 visited by the iteration.
9706 SCOPE determines the scope of this command. It can be any of:
9709 nil @r{the current buffer, respecting the restriction if any}
9710 tree @r{the subtree started with the entry at point}
9711 file @r{the current buffer, without restriction}
9713 @r{the current buffer, and any archives associated with it}
9714 agenda @r{all agenda files}
9715 agenda-with-archives
9716 @r{all agenda files with any archive files associated with them}
9718 @r{if this is a list, all files in the list will be scanned}
9721 The remaining args are treated as settings for the skipping facilities of
9722 the scanner. The following items can be given here:
9725 archive @r{skip trees with the archive tag}
9726 comment @r{skip trees with the COMMENT keyword}
9727 function or Lisp form
9728 @r{will be used as value for @code{org-agenda-skip-function},}
9729 @r{so whenever the the function returns t, FUNC}
9730 @r{will not be called for that entry and search will}
9731 @r{continue from the point where the function leaves it}
9735 The function given to that mapping routine can really do anything you like.
9736 It can uce the property API (@pxref{Using the property API}) to gather more
9737 information about the entry, or in order to change metadate in the entry.
9738 Here are a couple of functions that might be handy:
9740 @defun org-todo &optional arg
9741 Change the TODO state of the entry, see the docstring of the functions for
9742 the many possible values for the argument ARG.
9745 @defun org-priority &optional action
9746 Change the priority of the entry, see the docstring of this function for the
9747 possible values for ACTION.
9750 @defun org-toggle-tag tag &optional onoff
9751 Toggle the tag TAG in the current entry. Setting ONOFF to either @code{on}
9752 or @code{off} will not toggle tag, but ensure that it is either on or off.
9756 Promote the current entry.
9760 Demote the current entry.
9763 Here is a simple example that will turn all entries in the current file with
9764 a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
9765 Entries in comment trees and in archive trees will be ignored.
9769 '(org-todo "UPCOMING")
9770 "+TOMORROW" 'file 'archive 'comment)
9773 The following example counts the number of entries with TODO keyword
9774 @code{WAITING}, in all agenda files.
9777 (length (org-map-entries t "/+WAITING" nil 'agenda))
9780 @node History and Acknowledgments, Main Index, Hacking, Top
9781 @appendix History and Acknowledgments
9782 @cindex acknowledgments
9786 Org was borne in 2003, out of frustration over the user interface
9787 of the Emacs Outline mode. I was trying to organize my notes and
9788 projects, and using Emacs seemed to be the natural way to go. However,
9789 having to remember eleven different commands with two or three keys per
9790 command, only to hide and show parts of the outline tree, that seemed
9791 entirely unacceptable to me. Also, when using outlines to take notes, I
9792 constantly want to restructure the tree, organizing it parallel to my
9793 thoughts and plans. @emph{Visibility cycling} and @emph{structure
9794 editing} were originally implemented in the package
9795 @file{outline-magic.el}, but quickly moved to the more general
9796 @file{org.el}. As this environment became comfortable for project
9797 planning, the next step was adding @emph{TODO entries}, basic @emph{time
9798 stamps}, and @emph{table support}. These areas highlight the two main
9799 goals that Org still has today: To create a new, outline-based,
9800 plain text mode with innovative and intuitive editing features, and to
9801 incorporate project planning functionality directly into a notes file.
9803 A special thanks goes to @i{Bastien Guerry} who has not only writen a large
9804 number of extensions to Org (most of them integrated into the core by now),
9805 but has also helped the development and maintenance of Org so much that he
9806 should be considered co-author of this package.
9808 Since the first release, literally thousands of emails to me or on
9809 @code{emacs-orgmode@@gnu.org} have provided a constant stream of bug
9810 reports, feedback, new ideas, and sometimes patches and add-on code.
9811 Many thanks to everyone who has helped to improve this package. I am
9812 trying to keep here a list of the people who had significant influence
9813 in shaping one or more aspects of Org. The list may not be
9814 complete, if I have forgotten someone, please accept my apologies and
9820 @i{Russel Adams} came up with the idea for drawers.
9822 @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
9824 @i{Christophe Bataillon} created the great unicorn logo that we use on the
9827 @i{Alex Bochannek} provided a patch for rounding time stamps.
9829 @i{Charles Cave}'s suggestion sparked the implementation of templates
9832 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
9835 @i{Gregory Chernov} patched support for lisp forms into table
9836 calculations and improved XEmacs compatibility, in particular by porting
9837 @file{nouline.el} to XEmacs.
9839 @i{Sacha Chua} suggested to copy some linking code from Planner.
9841 @i{Eddward DeVilla} proposed and tested checkbox statistics. He also
9842 came up with the idea of properties, and that there should be an API for
9845 @i{Kees Dullemond} used to edit projects lists directly in HTML and so
9846 inspired some of the early development, including HTML export. He also
9847 asked for a way to narrow wide table columns.
9849 @i{Christian Egli} converted the documentation into Texinfo format,
9850 patched CSS formatting into the HTML exporter, and inspired the agenda.
9852 @i{David Emery} provided a patch for custom CSS support in exported
9855 @i{Nic Ferrier} contributed mailcap and XOXO support.
9857 @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
9859 @i{John Foerch} figured out how to make incremental search show context
9860 around a match in a hidden outline tree.
9862 @i{Niels Giesen} had the idea to automatically archive DONE trees.
9864 @i{Bastien Guerry} wrote the La@TeX{} exporter and @file{org-bibtex.el}, and
9865 has been prolific with patches, ideas, and bug reports.
9867 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
9869 @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
9870 task state change logging, and the clocktable. His clear explanations have
9871 been critical when we started to adopt the GIT version control system.
9873 @i{Manuel Hermenegildo} has contributed various ideas, small fixed and
9876 @i{Phil Jackson} wrote @file{org-irc.el}.
9878 @i{Scott Jaderholm} proposed footnotes, control over whitespace between
9879 folded entries, and column view for properties.
9881 @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
9883 @i{Shidai Liu} ("Leo") asked for embedded La@TeX{} and tested it. He also
9884 provided frequent feedback and some patches.
9886 @i{Jason F. McBrayer} suggested agenda export to CSV format.
9888 @i{Max Mikhanosha} came up with the idea of refiling.
9890 @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
9893 @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
9896 @i{Rick Moynihan} proposed to allow multiple TODO sequences in a file
9897 and to be able to quickly restrict the agenda to a subtree.
9899 @i{Todd Neal} provided patches for links to Info files and elisp forms.
9901 @i{Tim O'Callaghan} suggested in-file links, search options for general
9902 file links, and TAGS.
9904 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
9907 @i{Oliver Oppitz} suggested multi-state TODO items.
9909 @i{Scott Otterson} sparked the introduction of descriptive text for
9910 links, among other things.
9912 @i{Pete Phillips} helped during the development of the TAGS feature, and
9913 provided frequent feedback.
9915 @i{T.V. Raman} reported bugs and suggested improvements.
9917 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
9920 @i{Kevin Rogers} contributed code to access VM files on remote hosts.
9922 @i{Sebastian Rose} wrote @file{org-info.js}, a Java script for displaying
9923 webpages derived from Org using an Info-like, or a folding interface with
9924 single key navigation.
9926 @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
9927 conflict with @file{allout.el}.
9929 @i{Jason Riedy} generalized the send-receive mechanism for orgtbl tables with
9932 @i{Philip Rooke} created the Org reference card, provided lots
9933 of feedback, developed and applied standards to the Org documentation.
9935 @i{Christian Schlauer} proposed angular brackets around links, among
9938 @i{Eric Schulte} wrote @file{org-plot.el}.
9940 Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
9941 @file{organizer-mode.el}.
9943 @i{Ilya Shlyakhter} proposed the Archive Sibling.
9945 @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
9946 now packaged into Org's @file{contrib} directory.
9948 @i{Daniel Sinder} came up with the idea of internal archiving by locking
9951 @i{Dale Smith} proposed link abbreviations.
9953 @i{James TD Smith} has contributed a large number of patches for useful
9954 tweaks and features.
9956 @i{Adam Spiers} asked for global linking commands, inspired the link
9957 extension system, added support for mairix, and proposed the mapping API.
9959 @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
9960 chapter about publishing.
9962 @i{J@"urgen Vollmer} contributed code generating the table of contents
9965 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
9968 @i{David Wainberg} suggested archiving, and improvements to the linking
9971 @i{John Wiegley} wrote @file{emacs-wiki.el}, @file{planner.el}, and
9972 @file{muse.el}, which have similar goals as Org. Initially the
9973 development of Org was fully independent because I was not aware of the
9974 existence of these packages. But with time I have accasionally looked
9975 at John's code and learned a lot from it. John has also contributed a
9976 number of great ideas and patches directly to Org, including the attachment
9977 system (@file{org-attach.el}) and integration with Apple Mail
9978 (@file{org-mac-message.el}).
9980 @i{Carsten Wimmer} suggested some changes and helped fix a bug in
9983 @i{Roland Winkler} requested additional key bindings to make Org
9986 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
9987 and contributed various ideas and code snippets.
9991 @node Main Index, Key Index, History and Acknowledgments, Top
9992 @unnumbered The Main Index
9996 @node Key Index, , Main Index, Top
9997 @unnumbered Key Index
10004 arch-tag: 7893d1Fe-cc57-4d13-b5e5-f494a1CBC7ac
10007 @c Local variables:
10008 @c ispell-local-dictionary: "en_US-w_accents"
10009 @c ispell-local-pdict: "./.aspell.org.pws"