3 @setfilename ../../info/org
4 @settitle The Org Manual
9 @c Version and Contact Info
10 @set MAINTAINERSITE @uref{http://orgmode.org,maintainers webpage}
11 @set AUTHOR Carsten Dominik
12 @set MAINTAINER Carsten Dominik
13 @set MAINTAINEREMAIL @email{carsten at orgmode dot org}
14 @set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer}
20 @c @hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed}
35 @c Subheadings inside a table.
36 @macro tsubheading{text}
46 This manual is for Org version @value{VERSION}.
48 Copyright @copyright{} 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation
51 Permission is granted to copy, distribute and/or modify this document
52 under the terms of the GNU Free Documentation License, Version 1.3 or
53 any later version published by the Free Software Foundation; with no
54 Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
55 and with the Back-Cover Texts as in (a) below. A copy of the license
56 is included in the section entitled ``GNU Free Documentation License.''
58 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
59 modify this GNU manual. Buying copies from the FSF supports it in
60 developing GNU and promoting software freedom.''
62 This document is part of a collection distributed under the GNU Free
63 Documentation License. If you want to distribute this document
64 separately from the collection, you can do so by adding a copy of the
65 license to the document, as described in section 6 of the license.
71 * Org Mode: (org). Outline-based notes management and organizer
77 @subtitle Release @value{VERSION}
78 @author by Carsten Dominik
80 @c The following two commands start the copyright page.
82 @vskip 0pt plus 1filll
86 @c Output the table of contents at the beginning.
90 @node Top, Introduction, (dir), (dir)
97 * Introduction:: Getting started
98 * Document Structure:: A tree works like your brain
99 * Tables:: Pure magic for quick formatting
100 * Hyperlinks:: Notes in context
101 * TODO Items:: Every tree branch can be a TODO item
102 * Tags:: Tagging headlines and matching sets of tags
103 * Properties and Columns:: Storing information about an entry
104 * Dates and Times:: Making items useful for planning
105 * Capture:: Creating tasks and attaching files
106 * Agenda Views:: Collecting information into views
107 * Embedded LaTeX:: LaTeX fragments and formulas
108 * Exporting:: Sharing and publishing of notes
109 * Publishing:: Create a web site of linked Org files
110 * Miscellaneous:: All the rest which did not fit elsewhere
111 * Hacking:: How to hack your way around
112 * History and Acknowledgments:: How Org came into being
113 * Main Index:: An index of Org's concepts and features
114 * Key Index:: Key bindings and where they are described
115 * Variable Index:: Variables mentioned in the manual
118 --- The Detailed Node Listing ---
122 * Summary:: Brief summary of what Org does
123 * Installation:: How to install a downloaded version of Org
124 * Activation:: How to activate Org for certain buffers
125 * Feedback:: Bug reports, ideas, patches etc.
126 * Conventions:: Type-setting conventions in the manual
130 * Outlines:: Org is based on Outline mode
131 * Headlines:: How to typeset Org tree headlines
132 * Visibility cycling:: Show and hide, much simplified
133 * Motion:: Jumping to other headlines
134 * Structure editing:: Changing sequence and level of headlines
135 * Archiving:: Move done task trees to a different place
136 * Sparse trees:: Matches embedded in context
137 * Plain lists:: Additional structure within an entry
138 * Drawers:: Tucking stuff away
139 * Blocks:: Folding blocks
140 * Footnotes:: How footnotes are defined in Org's syntax
141 * Orgstruct mode:: Structure editing outside Org
145 * ARCHIVE tag:: Marking a tree as inactive
146 * Moving subtrees:: Moving a tree to an archive file
150 * Built-in table editor:: Simple tables
151 * Column width and alignment:: Overrule the automatic settings
152 * Column groups:: Grouping to trigger vertical lines
153 * Orgtbl mode:: The table editor as minor mode
154 * The spreadsheet:: The table editor has spreadsheet capabilities
155 * Org-Plot:: Plotting from org tables
159 * References:: How to refer to another field or range
160 * Formula syntax for Calc:: Using Calc to compute stuff
161 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
162 * Field formulas:: Formulas valid for a single field
163 * Column formulas:: Formulas valid for an entire column
164 * Editing and debugging formulas:: Fixing formulas
165 * Updating the table:: Recomputing all dependent fields
166 * Advanced features:: Field names, parameters and automatic recalc
170 * Link format:: How links in Org are formatted
171 * Internal links:: Links to other places in the current file
172 * External links:: URL-like links to the world
173 * Handling links:: Creating, inserting and following
174 * Using links outside Org:: Linking from my C source code?
175 * Link abbreviations:: Shortcuts for writing complex links
176 * Search options:: Linking to a specific location
177 * Custom searches:: When the default search is not enough
181 * Radio targets:: Make targets trigger links in plain text
185 * TODO basics:: Marking and displaying TODO entries
186 * TODO extensions:: Workflow and assignments
187 * Progress logging:: Dates and notes for progress
188 * Priorities:: Some things are more important than others
189 * Breaking down tasks:: Splitting a task into manageable pieces
190 * Checkboxes:: Tick-off lists
192 Extended use of TODO keywords
194 * Workflow states:: From TODO to DONE in steps
195 * TODO types:: I do this, Fred does the rest
196 * Multiple sets in one file:: Mixing it all, and still finding your way
197 * Fast access to TODO states:: Single letter selection of a state
198 * Per-file keywords:: Different files, different requirements
199 * Faces for TODO keywords:: Highlighting states
200 * TODO dependencies:: When one task needs to wait for others
204 * Closing items:: When was this entry marked DONE?
205 * Tracking TODO state changes:: When did the status change?
209 * Tag inheritance:: Tags use the tree structure of the outline
210 * Setting tags:: How to assign tags to a headline
211 * Tag searches:: Searching for combinations of tags
213 Properties and Columns
215 * Property syntax:: How properties are spelled out
216 * Special properties:: Access to other Org mode features
217 * Property searches:: Matching property values
218 * Property inheritance:: Passing values down the tree
219 * Column view:: Tabular viewing and editing
220 * Property API:: Properties for Lisp programmers
224 * Defining columns:: The COLUMNS format property
225 * Using column view:: How to create and use column view
226 * Capturing column view:: A dynamic block for column view
230 * Scope of column definitions:: Where defined, where valid?
231 * Column attributes:: Appearance and content of a column
235 * Timestamps:: Assigning a time to a tree entry
236 * Creating timestamps:: Commands which insert timestamps
237 * Deadlines and scheduling:: Planning your work
238 * Clocking work time:: Tracking how long you spend on a task
239 * Effort estimates:: Planning work effort in advance
240 * Relative timer:: Notes with a running timer
244 * The date/time prompt:: How Org mode helps you entering date and time
245 * Custom time format:: Making dates look different
247 Deadlines and scheduling
249 * Inserting deadline/schedule:: Planning items
250 * Repeated tasks:: Items that show up again and again
254 * Remember:: Capture new tasks/ideas with little interruption
255 * Attachments:: Add files to tasks.
256 * RSS Feeds:: Getting input from RSS feeds
257 * Protocols:: External (@eg Browser) access to Emacs and Org
261 * Setting up Remember for Org:: Some code for .emacs to get things going
262 * Remember templates:: Define the outline of different note types
263 * Storing notes:: Directly get the note to where it belongs
264 * Refiling notes:: Moving a note or task to a project
268 * Agenda files:: Files being searched for agenda information
269 * Agenda dispatcher:: Keyboard access to agenda views
270 * Built-in agenda views:: What is available out of the box?
271 * Presentation and sorting:: How agenda items are prepared for display
272 * Agenda commands:: Remote editing of Org trees
273 * Custom agenda views:: Defining special searches and views
274 * Exporting Agenda Views::
275 * Agenda column view:: Using column view for collected entries
277 The built-in agenda views
279 * Weekly/daily agenda:: The calendar page with current tasks
280 * Global TODO list:: All unfinished action items
281 * Matching tags and properties:: Structured information with fine-tuned search
282 * Timeline:: Time-sorted view for single file
283 * Keyword search:: Finding entries by keyword
284 * Stuck projects:: Find projects you need to review
286 Presentation and sorting
288 * Categories:: Not all tasks are equal
289 * Time-of-day specifications:: How the agenda knows the time
290 * Sorting of agenda items:: The order of things
294 * Storing searches:: Type once, use often
295 * Block agenda:: All the stuff you need in a single buffer
296 * Setting Options:: Changing the rules
300 * Math symbols:: @TeX{} macros for symbols and Greek letters
301 * Subscripts and superscripts:: Simple syntax for raising/lowering text
302 * LaTeX fragments:: Complex formulas made easy
303 * Processing LaTeX fragments:: Previewing La@TeX{} processing
304 * CDLaTeX mode:: Speed up entering of formulas
308 * Markup rules:: Which structures are recognized?
309 * Selective export:: Using tags to select and exclude trees
310 * Export options:: Per-file export settings
311 * The export dispatcher:: How to access exporter commands
312 * ASCII export:: Exporting to plain ASCII
313 * HTML export:: Exporting to HTML
314 * LaTeX and PDF export:: Exporting to La@TeX{}, and processing to PDF
315 * DocBook export:: Exporting to DocBook
316 * XOXO export:: Exporting to XOXO
317 * iCalendar export:: Exporting in iCalendar format
321 * Document title:: How the document title is determined
322 * Headings and sections:: The main structure of the exported document
323 * Table of contents:: If, where, how to create a table of contents
324 * Initial text:: Text before the first headline
325 * Lists:: Plain lists are exported
326 * Paragraphs:: What determines beginning and ending
327 * Literal examples:: Source code and other examples
328 * Include files:: Include the contents of a file during export
329 * Tables exported:: Tables are exported richly
330 * Inlined images:: How to inline images during export
331 * Footnote markup:: ASCII representation of footnotes
332 * Emphasis and monospace:: To bold or not to bold
333 * TeX macros and LaTeX fragments:: Create special, rich export.
334 * Horizontal rules:: A line across the page
335 * Comment lines:: Some lines will not be exported
336 * Macro replacement:: Global replacement of place holders
340 * HTML Export commands:: How to invoke HTML export
341 * Quoting HTML tags:: Using direct HTML in Org mode
342 * Links:: Transformation of links for HTML
343 * Tables in HTML export:: How to modify the formatting of tables
344 * Images in HTML export:: How to insert figures into HTML output
345 * Text areas in HTML export:: An alternative way to show an example
346 * CSS support:: Changing the appearance of the output
347 * Javascript support:: Info and Folding in a web browser
349 La@TeX{} and PDF export
351 * LaTeX/PDF export commands:: Which key invokes which commands
352 * Quoting LaTeX code:: Incorporating literal La@TeX{} code
353 * Sectioning structure:: Changing sectioning in La@TeX{} output
354 * Tables in LaTeX export:: Options for exporting tables to La@TeX{}
355 * Images in LaTeX export:: How to insert figures into La@TeX{} output
359 * DocBook export commands:: How to invoke DocBook export
360 * Quoting DocBook code:: Incorporating DocBook code in Org files
361 * Recursive sections:: Recursive sections in DocBook
362 * Tables in DocBook export:: Tables are exported as HTML tables
363 * Images in DocBook export:: How to insert figures into DocBook output
364 * Special characters:: How to handle special characters
368 * Configuration:: Defining projects
369 * Uploading files:: How to get files up on the server
370 * Sample configuration:: Example projects
371 * Triggering publication:: Publication commands
375 * Project alist:: The central configuration variable
376 * Sources and destinations:: From here to there
377 * Selecting files:: What files are part of the project?
378 * Publishing action:: Setting the function doing the publishing
379 * Publishing options:: Tweaking HTML export
380 * Publishing links:: Which links keep working after publishing?
381 * Project page index:: Publishing a list of project files
385 * Simple example:: One-component publishing
386 * Complex example:: A multi-component publishing example
390 * Completion:: M-TAB knows what you need
391 * Customization:: Adapting Org to your taste
392 * In-buffer settings:: Overview of the #+KEYWORDS
393 * The very busy C-c C-c key:: When in doubt, press C-c C-c
394 * Clean view:: Getting rid of leading stars in the outline
395 * TTY keys:: Using Org on a tty
396 * Interaction:: Other Emacs packages
398 Interaction with other packages
400 * Cooperation:: Packages Org cooperates with
401 * Conflicts:: Packages that lead to conflicts
405 * Hooks:: Who to reach into Org's internals
406 * Add-on packages:: Available extensions
407 * Adding hyperlink types:: New custom link types
408 * Context-sensitive commands:: How to add functionality to such commands
409 * Tables in arbitrary syntax:: Orgtbl for La@TeX{} and other programs
410 * Dynamic blocks:: Automatically filled blocks
411 * Special agenda views:: Customized views
412 * Extracting agenda information:: Postprocessing of agenda information
413 * Using the property API:: Writing programs that use entry properties
414 * Using the mapping API:: Mapping over all or selected entries
416 Tables and lists in arbitrary syntax
418 * Radio tables:: Sending and receiving radio tables
419 * A LaTeX example:: Step by step, almost a tutorial
420 * Translator functions:: Copy and modify
421 * Radio lists:: Doing the same for lists
426 @node Introduction, Document Structure, Top, Top
427 @chapter Introduction
431 * Summary:: Brief summary of what Org does
432 * Installation:: How to install a downloaded version of Org
433 * Activation:: How to activate Org for certain buffers
434 * Feedback:: Bug reports, ideas, patches etc.
435 * Conventions:: Type-setting conventions in the manual
438 @node Summary, Installation, Introduction, Introduction
442 Org is a mode for keeping notes, maintaining TODO lists, and doing
443 project planning with a fast and effective plain-text system.
445 Org develops organizational tasks around NOTES files that contain
446 lists or information about projects as plain text. Org is
447 implemented on top of Outline mode, which makes it possible to keep the
448 content of large files well structured. Visibility cycling and
449 structure editing help to work with the tree. Tables are easily created
450 with a built-in table editor. Org supports TODO items, deadlines,
451 timestamps, and scheduling. It dynamically compiles entries into an
452 agenda that utilizes and smoothly integrates much of the Emacs calendar
453 and diary. Plain text URL-like links connect to websites, emails,
454 Usenet messages, BBDB entries, and any files related to the projects.
455 For printing and sharing of notes, an Org file can be exported as a
456 structured ASCII file, as HTML, or (TODO and agenda items only) as an
457 iCalendar file. It can also serve as a publishing tool for a set of
460 An important design aspect that distinguishes Org from, for example,
461 Planner/Muse is that it encourages you to store every piece of information
462 only once. In Planner, you have project pages, day pages and possibly
463 other files, duplicating some information such as tasks. In Org,
464 you only have notes files. In your notes you mark entries as tasks, and
465 label them with tags and timestamps. All necessary lists, like a
466 schedule for the day, the agenda for a meeting, tasks lists selected by
467 tags, etc., are created dynamically when you need them.
469 Org keeps simple things simple. When first fired up, it should
470 feel like a straightforward, easy to use outliner. Complexity is not
471 imposed, but a large amount of functionality is available when you need
472 it. Org is a toolbox and can be used in different ways, for
476 @r{@bullet{} an outline extension with visibility cycling and structure editing}
477 @r{@bullet{} an ASCII system and table editor for taking structured notes}
478 @r{@bullet{} an ASCII table editor with spreadsheet-like capabilities}
479 @r{@bullet{} a TODO list editor}
480 @r{@bullet{} a full agenda and planner with deadlines and work scheduling}
481 @pindex GTD, Getting Things Done
482 @r{@bullet{} an environment to implement David Allen's GTD system}
483 @r{@bullet{} a basic database application}
484 @r{@bullet{} a simple hypertext system, with HTML and La@TeX{} export}
485 @r{@bullet{} a publishing tool to create a set of interlinked webpages}
488 Org's automatic, context-sensitive table editor with spreadsheet
489 capabilities can be integrated into any major mode by activating the
490 minor Orgtbl mode. Using a translation step, it can be used to maintain
491 tables in arbitrary file types, for example in La@TeX{}. The structure
492 editing and list creation capabilities can be used outside Org with
493 the minor Orgstruct mode.
496 There is a website for Org which provides links to the newest
497 version of Org, as well as additional information, frequently asked
498 questions (FAQ), links to tutorials, etc@. This page is located at
499 @uref{http://orgmode.org}.
504 @node Installation, Activation, Summary, Introduction
505 @section Installation
509 @b{Important:} @i{If Org is part of the Emacs distribution or an
510 XEmacs package, please skip this section and go directly to
513 If you have downloaded Org from the Web, either as a distribution @file{.zip}
514 or @file{.tar} file, or as a Git archive, you must take the following steps
515 to install it: go into the unpacked Org distribution directory and edit the
516 top section of the file @file{Makefile}. You must set the name of the Emacs
517 binary (likely either @file{emacs} or @file{xemacs}), and the paths to the
518 directories where local Lisp and Info files are kept. If you don't have
519 access to the system-wide directories, you can simply run Org directly from
520 the distribution directory by adding the @file{lisp} subdirectory to the
521 Emacs load path. To do this, add the following line to @file{.emacs}:
524 (setq load-path (cons "~/path/to/orgdir/lisp" load-path))
528 If you plan to use code from the @file{contrib} subdirectory, do a similar
529 step for this directory:
532 (setq load-path (cons "~/path/to/orgdir/contrib/lisp" load-path))
535 @b{XEmacs users now need to install the file @file{noutline.el} from
536 the @file{xemacs} sub-directory of the Org distribution. Use the
540 @b{make install-noutline}
543 @noindent Now byte-compile the Lisp files with the shell command:
549 @noindent If you are running Org from the distribution directory, this is
550 all. If you want to install Org into the system directories, use (as
557 Installing Info files is system dependent, because of differences in the
558 @file{install-info} program. In Debian it copies the info files into the
559 correct directory and modifies the info directory file. In many other
560 systems, the files need to be copied to the correct directory separately, and
561 @file{install-info} then only modifies the directory file. Check your system
562 documentation to find out which of the following commands you need:
566 make install-info-debian
569 @noindent Then add to @file{.emacs}:
572 ;; This line only if Org is not part of the X/Emacs distribution.
573 (require 'org-install)
576 Do not forget to activate Org as described in the following section.
578 @node Activation, Feedback, Installation, Introduction
582 @cindex global key bindings
583 @cindex key bindings, global
586 @b{Important:} @i{If you use copy-and-paste to copy Lisp code from the
587 PDF documentation as viewed by some PDF viewers to your @file{.emacs} file, the
588 single-quote character comes out incorrectly and the code will not work.
589 You need to fix the single-quotes by hand, or copy from Info
593 Add the following lines to your @file{.emacs} file. The last three lines
594 define @emph{global} keys for the commands @command{org-store-link},
595 @command{org-agenda}, and @command{org-iswitchb}---please choose suitable
599 ;; The following lines are always needed. Choose your own keys.
600 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
601 (global-set-key "\C-cl" 'org-store-link)
602 (global-set-key "\C-ca" 'org-agenda)
603 (global-set-key "\C-cb" 'org-iswitchb)
606 Furthermore, you must activate @code{font-lock-mode} in Org
607 buffers, because significant functionality depends on font-locking being
608 active. You can do this with either one of the following two lines
609 (XEmacs users must use the second option):
611 (global-font-lock-mode 1) ; for all buffers
612 (add-hook 'org-mode-hook 'turn-on-font-lock) ; Org buffers only
615 @cindex Org mode, turning on
616 With this setup, all files with extension @samp{.org} will be put
617 into Org mode. As an alternative, make the first line of a file look
621 MY PROJECTS -*- mode: org; -*-
624 @vindex org-insert-mode-line-in-empty-file
625 @noindent which will select Org mode for this buffer no matter what
626 the file's name is. See also the variable
627 @code{org-insert-mode-line-in-empty-file}.
629 Many commands in Org work on the region if the region is @i{active}. To make
630 use of this, you need to have @code{transient-mark-mode}
631 (@code{zmacs-regions} in XEmacs) turned on. In Emacs 23 this is the default,
632 in Emacs 22 you need to do this yourself with
634 (transient-mark-mode 1)
636 @noindent If you do not like @code{transient-mark-mode}, you can create an
637 active region by using the mouse to select a region, or pressing
638 @kbd{C-@key{SPC}} twice before moving the cursor.
640 @node Feedback, Conventions, Activation, Introduction
647 If you find problems with Org, or if you have questions, remarks, or ideas
648 about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}.
649 If you are not a member of the mailing list, your mail will be passed to the
650 list after a moderator has approved it.
652 For bug reports, please provide as much information as possible, including
653 the version information of Emacs (@kbd{M-x emacs-version @key{RET}}) and Org
654 (@kbd{M-x org-version @key{RET}}), as well as the Org related setup in
655 @file{.emacs}. The easiest way to do this is to use the command
657 @kbd{M-x org-submit-bug-report}
659 @noindent which will put all this information into an Emacs mail buffer so
660 that you only need to add your description. If you re not sending the Email
661 from within Emacs, please copy and paste the content into your Email program.
663 If an error occurs, a backtrace can be very useful (see below on how to
664 create one). Often a small example file helps, along with clear information
668 @item What exactly did you do?
669 @item What did you expect to happen?
670 @item What happened instead?
672 @noindent Thank you for helping to improve this mode.
674 @subsubheading How to create a useful backtrace
676 @cindex backtrace of an error
677 If working with Org produces an error with a message you don't
678 understand, you may have hit a bug. The best way to report this is by
679 providing, in addition to what was mentioned above, a @emph{backtrace}.
680 This is information from the built-in debugger about where and how the
681 error occurred. Here is how to produce a useful backtrace:
685 Reload uncompiled versions of all Org-mode Lisp files. The backtrace
686 contains much more information if it is produced with uncompiled code.
689 C-u M-x org-reload RET
692 or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the
695 Go to the @code{Options} menu and select @code{Enter Debugger on Error}
696 (XEmacs has this option in the @code{Troubleshooting} sub-menu).
698 Do whatever you have to do to hit the error. Don't forget to
699 document the steps you take.
701 When you hit the error, a @file{*Backtrace*} buffer will appear on the
702 screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and
703 attach it to your bug report.
706 @node Conventions, , Feedback, Introduction
707 @section Typesetting conventions used in this manual
709 Org uses three types of keywords: TODO keywords, tags, and property
710 names. In this manual we use the following conventions:
715 TODO keywords are written with all capitals, even if they are
719 User-defined tags are written in lowercase; built-in tags with special
720 meaning are written with all capitals.
723 User-defined properties are capitalized; built-in properties with
724 special meaning are written with all capitals.
727 @node Document Structure, Tables, Introduction, Top
728 @chapter Document Structure
729 @cindex document structure
730 @cindex structure of document
732 Org is based on Outline mode and provides flexible commands to
733 edit the structure of the document.
736 * Outlines:: Org is based on Outline mode
737 * Headlines:: How to typeset Org tree headlines
738 * Visibility cycling:: Show and hide, much simplified
739 * Motion:: Jumping to other headlines
740 * Structure editing:: Changing sequence and level of headlines
741 * Archiving:: Move done task trees to a different place
742 * Sparse trees:: Matches embedded in context
743 * Plain lists:: Additional structure within an entry
744 * Drawers:: Tucking stuff away
745 * Blocks:: Folding blocks
746 * Footnotes:: How footnotes are defined in Org's syntax
747 * Orgstruct mode:: Structure editing outside Org
750 @node Outlines, Headlines, Document Structure, Document Structure
755 Org is implemented on top of Outline mode. Outlines allow a
756 document to be organized in a hierarchical structure, which (at least
757 for me) is the best representation of notes and thoughts. An overview
758 of this structure is achieved by folding (hiding) large parts of the
759 document to show only the general document structure and the parts
760 currently being worked on. Org greatly simplifies the use of
761 outlines by compressing the entire show/hide functionality into a single
762 command, @command{org-cycle}, which is bound to the @key{TAB} key.
764 @node Headlines, Visibility cycling, Outlines, Document Structure
768 @vindex org-special-ctrl-a/e
770 Headlines define the structure of an outline tree. The headlines in
771 Org start with one or more stars, on the left margin@footnote{See
772 the variable @code{org-special-ctrl-a/e} to configure special behavior
773 of @kbd{C-a} and @kbd{C-e} in headlines.}. For example:
783 * Another top level headline
786 @noindent Some people find the many stars too noisy and would prefer an
787 outline that has whitespace followed by a single star as headline
788 starters. @ref{Clean view}, describes a setup to realize this.
790 @vindex org-cycle-separator-lines
791 An empty line after the end of a subtree is considered part of it and
792 will be hidden when the subtree is folded. However, if you leave at
793 least two empty lines, one empty line will remain visible after folding
794 the subtree, in order to structure the collapsed view. See the
795 variable @code{org-cycle-separator-lines} to modify this behavior.
797 @node Visibility cycling, Motion, Headlines, Document Structure
798 @section Visibility cycling
799 @cindex cycling, visibility
800 @cindex visibility cycling
801 @cindex trees, visibility
802 @cindex show hidden text
805 Outlines make it possible to hide parts of the text in the buffer.
806 Org uses just two commands, bound to @key{TAB} and
807 @kbd{S-@key{TAB}} to change the visibility in the buffer.
809 @cindex subtree visibility states
810 @cindex subtree cycling
811 @cindex folded, subtree visibility state
812 @cindex children, subtree visibility state
813 @cindex subtree, subtree visibility state
817 @emph{Subtree cycling}: Rotate current subtree among the states
820 ,-> FOLDED -> CHILDREN -> SUBTREE --.
821 '-----------------------------------'
824 @vindex org-cycle-emulate-tab
825 @vindex org-cycle-global-at-bob
826 The cursor must be on a headline for this to work@footnote{see, however,
827 the option @code{org-cycle-emulate-tab}.}. When the cursor is at the
828 beginning of the buffer and the first line is not a headline, then
829 @key{TAB} actually runs global cycling (see below)@footnote{see the
830 option @code{org-cycle-global-at-bob}.}. Also when called with a prefix
831 argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
833 @cindex global visibility states
834 @cindex global cycling
835 @cindex overview, global visibility state
836 @cindex contents, global visibility state
837 @cindex show all, global visibility state
841 @emph{Global cycling}: Rotate the entire buffer among the states
844 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
845 '--------------------------------------'
848 When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
849 CONTENTS view up to headlines of level N will be shown. Note that inside
850 tables, @kbd{S-@key{TAB}} jumps to the previous field.
852 @cindex show all, command
853 @kindex C-u C-u C-u @key{TAB}
854 @item C-u C-u C-u @key{TAB}
855 Show all, including drawers.
858 Reveal context around point, showing the current entry, the following heading
859 and the hierarchy above. Useful for working near a location that has been
860 exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
861 (@pxref{Agenda commands}). With a prefix argument show, on each
862 level, all sibling headings.
865 Show the current subtree in an indirect buffer@footnote{The indirect
868 (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
871 (see the Emacs manual for more information about indirect buffers)
873 will contain the entire buffer, but will be narrowed to the current
874 tree. Editing the indirect buffer will also change the original buffer,
875 but without affecting visibility in that buffer.}. With a numeric
876 prefix argument N, go up to level N and then take that tree. If N is
877 negative then go up that many levels. With a @kbd{C-u} prefix, do not remove
878 the previously used indirect buffer.
881 @vindex org-startup-folded
882 @cindex @code{overview}, STARTUP keyword
883 @cindex @code{content}, STARTUP keyword
884 @cindex @code{showall}, STARTUP keyword
886 When Emacs first visits an Org file, the global state is set to
887 OVERVIEW, @ie only the top level headlines are visible. This can be
888 configured through the variable @code{org-startup-folded}, or on a
889 per-file basis by adding one of the following lines anywhere in the
898 @cindex property, VISIBILITY
900 Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
901 and Columns}) will get their visibility adapted accordingly. Allowed values
902 for this property are @code{folded}, @code{children}, @code{content}, and
905 @kindex C-u C-u @key{TAB}
906 @item C-u C-u @key{TAB}
907 Switch back to the startup visibility of the buffer, @ie whatever is
908 requested by startup options and @samp{VISIBILITY} properties in individual
912 @node Motion, Structure editing, Visibility cycling, Document Structure
914 @cindex motion, between headlines
915 @cindex jumping, to headlines
916 @cindex headline navigation
917 The following commands jump to other headlines in the buffer.
928 Next heading same level.
931 Previous heading same level.
934 Backward to higher level heading.
937 Jump to a different place without changing the current outline
938 visibility. Shows the document structure in a temporary buffer, where
939 you can use the following keys to find your destination:
940 @vindex org-goto-auto-isearch
942 @key{TAB} @r{Cycle visibility.}
943 @key{down} / @key{up} @r{Next/previous visible headline.}
944 @key{RET} @r{Select this location.}
945 @kbd{/} @r{Do a Sparse-tree search}
946 @r{The following keys work if you turn off @code{org-goto-auto-isearch}}
947 n / p @r{Next/previous visible headline.}
948 f / b @r{Next/previous headline same level.}
950 0-9 @r{Digit argument.}
953 @vindex org-goto-interface
955 See also the variable @code{org-goto-interface}.
958 @node Structure editing, Archiving, Motion, Document Structure
959 @section Structure editing
960 @cindex structure editing
961 @cindex headline, promotion and demotion
962 @cindex promotion, of subtrees
963 @cindex demotion, of subtrees
964 @cindex subtree, cut and paste
965 @cindex pasting, of subtrees
966 @cindex cutting, of subtrees
967 @cindex copying, of subtrees
968 @cindex sorting, of subtrees
969 @cindex subtrees, cut and paste
974 @vindex org-M-RET-may-split-line
975 Insert new heading with same level as current. If the cursor is in a
976 plain list item, a new item is created (@pxref{Plain lists}). To force
977 creation of a new headline, use a prefix argument, or first press @key{RET}
978 to get to the beginning of the next line. When this command is used in
979 the middle of a line, the line is split and the rest of the line becomes
980 the new headline@footnote{If you do not want the line to be split,
981 customize the variable @code{org-M-RET-may-split-line}.}. If the
982 command is used at the beginning of a headline, the new headline is
983 created before the current line. If at the beginning of any other line,
984 the content of that line is made the new heading. If the command is
985 used at the end of a folded subtree (@ie behind the ellipses at the end
986 of a headline), then a headline like the current one will be inserted
987 after the end of the subtree.
990 Just like @kbd{M-@key{RET}}, except when adding a new heading below the
991 current heading, the new heading is placed after the body instead of before
992 it. This command works from anywhere in the entry.
993 @kindex M-S-@key{RET}
995 @vindex org-treat-insert-todo-heading-as-state-change
996 Insert new TODO entry with same level as current heading. See also the
997 variable @code{org-treat-insert-todo-heading-as-state-change}.
998 @kindex C-S-@key{RET}
1000 Insert new TODO entry with same level as current heading. Like
1001 @kbd{C-@key{RET}}, the new headline will be inserted after the current
1003 @kindex M-@key{left}
1005 Promote current heading by one level.
1006 @kindex M-@key{right}
1008 Demote current heading by one level.
1009 @kindex M-S-@key{left}
1010 @item M-S-@key{left}
1011 Promote the current subtree by one level.
1012 @kindex M-S-@key{right}
1013 @item M-S-@key{right}
1014 Demote the current subtree by one level.
1015 @kindex M-S-@key{up}
1017 Move subtree up (swap with previous subtree of same
1019 @kindex M-S-@key{down}
1020 @item M-S-@key{down}
1021 Move subtree down (swap with next subtree of same level).
1024 Kill subtree, @ie remove it from buffer but save in kill ring.
1025 With a numeric prefix argument N, kill N sequential subtrees.
1028 Copy subtree to kill ring. With a numeric prefix argument N, copy the N
1029 sequential subtrees.
1032 Yank subtree from kill ring. This does modify the level of the subtree to
1033 make sure the tree fits in nicely at the yank position. The yank level can
1034 also be specified with a numeric prefix argument, or by yanking after a
1035 headline marker like @samp{****}.
1038 @vindex org-yank-adjusted-subtrees
1039 @vindex org-yank-folded-subtrees
1040 Depending on the variables @code{org-yank-adjusted-subtrees} and
1041 @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
1042 paste subtrees folded and in a clever way, using the same command as @kbd{C-c
1043 C-x C-y}. With the default settings, no level adjustment will take place,
1044 but the yanked tree will be folded unless doing so would swallow text
1045 previously visible. Any prefix argument to this command will force a normal
1046 @code{yank} to be executed, with the prefix passed along. A good way to
1047 force a normal yank is @kbd{C-u C-y}. If you use @code{yank-pop} after a
1048 yank, it will yank previous kill items plainly, without adjustment and
1052 Clone a subtree by making a number of sibling copies of it. You will be
1053 prompted for the number of copies to make, and you can also specify if any
1054 timestamps in the entry should be shifted. This can be useful, for example,
1055 to create a number of tasks related to a series of lectures to prepare. For
1056 more details, see the docstring of the command
1057 @code{org-clone-subtree-with-time-shift}.
1060 Refile entry or region to a different location. @xref{Refiling notes}.
1063 Sort same-level entries. When there is an active region, all entries in the
1064 region will be sorted. Otherwise the children of the current headline are
1065 sorted. The command prompts for the sorting method, which can be
1066 alphabetically, numerically, by time (first timestamp with active preferred,
1067 creation time, scheduled time, deadline time), by priority, by TODO keyword
1068 (in the sequence the keywords have been defined in the setup) or by the value
1069 of a property. Reverse sorting is possible as well. You can also supply
1070 your own function to extract the sorting key. With a @kbd{C-u} prefix,
1071 sorting will be case-sensitive. With two @kbd{C-u C-u} prefixes, duplicate
1072 entries will also be removed.
1075 Narrow buffer to current subtree.
1078 Widen buffer to remove narrowing.
1081 Turn a normal line or plain list item into a headline (so that it becomes a
1082 subheading at its location). Also turn a headline into a normal line by
1083 removing the stars. If there is an active region, turn all lines in the
1084 region into headlines. If the first line in the region was an item, turn
1085 only the item lines into headlines. Finally, if the first line is a
1086 headline, remove the stars from all headlines in the region.
1089 @cindex region, active
1090 @cindex active region
1091 @cindex transient mark mode
1092 When there is an active region (Transient Mark mode), promotion and
1093 demotion work on all headlines in the region. To select a region of
1094 headlines, it is best to place both point and mark at the beginning of a
1095 line, mark at the beginning of the first headline, and point at the line
1096 just after the last headline to change. Note that when the cursor is
1097 inside a table (@pxref{Tables}), the Meta-Cursor keys have different
1100 @node Archiving, Sparse trees, Structure editing, Document Structure
1104 When a project represented by a (sub)tree is finished, you may want
1105 to move the tree out of the way and to stop it from contributing to the
1106 agenda. Org mode knows two ways of archiving. You can mark a tree with
1107 the ARCHIVE tag, or you can move an entire (sub)tree to a different
1111 * ARCHIVE tag:: Marking a tree as inactive
1112 * Moving subtrees:: Moving a tree to an archive file
1115 @node ARCHIVE tag, Moving subtrees, Archiving, Archiving
1116 @subsection The ARCHIVE tag
1117 @cindex internal archiving
1119 A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
1120 its location in the outline tree, but behaves in the following way:
1123 @vindex org-cycle-open-archived-trees
1124 It does not open when you attempt to do so with a visibility cycling
1125 command (@pxref{Visibility cycling}). You can force cycling archived
1126 subtrees with @kbd{C-@key{TAB}}, or by setting the option
1127 @code{org-cycle-open-archived-trees}. Also normal outline commands like
1128 @code{show-all} will open archived subtrees.
1130 @vindex org-sparse-tree-open-archived-trees
1131 During sparse tree construction (@pxref{Sparse trees}), matches in
1132 archived subtrees are not exposed, unless you configure the option
1133 @code{org-sparse-tree-open-archived-trees}.
1135 @vindex org-agenda-skip-archived-trees
1136 During agenda view construction (@pxref{Agenda Views}), the content of
1137 archived trees is ignored unless you configure the option
1138 @code{org-agenda-skip-archived-trees}, in which case these trees will always
1139 be included. In the agenda you can press the @kbd{v} key to get archives
1140 temporarily included.
1142 @vindex org-export-with-archived-trees
1143 Archived trees are not exported (@pxref{Exporting}), only the headline
1144 is. Configure the details using the variable
1145 @code{org-export-with-archived-trees}.
1147 @vindex org-columns-skip-arrchived-trees
1148 Archived trees are excluded from column view unless the variable
1149 @code{org-columns-skip-arrchived-trees} is configured to @code{nil}.
1152 The following commands help managing the ARCHIVE tag:
1157 Toggle the ARCHIVE tag for the current headline. When the tag is set,
1158 the headline changes to a shadowed face, and the subtree below it is
1160 @kindex C-u C-c C-x a
1162 Check if any direct children of the current headline should be archived.
1163 To do this, each subtree is checked for open TODO entries. If none are
1164 found, the command offers to set the ARCHIVE tag for the child. If the
1165 cursor is @emph{not} on a headline when this command is invoked, the
1166 level 1 trees will be checked.
1169 Cycle a tree even if it is tagged with ARCHIVE.
1172 @node Moving subtrees, , ARCHIVE tag, Archiving
1173 @subsection Moving subtrees
1174 @cindex external archiving
1176 Once an entire project is finished, you may want to move it to a different
1177 location. Org can move it to an @emph{Archive Sibling} in the same tree, to a
1178 different tree in the current file, or to a different file, the archive file.
1183 Move the current entry to the @emph{Archive Sibling}. This is a sibling of
1184 the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}
1185 (@pxref{ARCHIVE tag}). The entry becomes a child of that sibling and in this
1186 way retains a lot of its original context, including inherited tags and
1187 approximate position in the outline.
1192 @vindex org-archive-location
1193 Archive the subtree starting at the cursor position to the location
1194 given by @code{org-archive-location}. Context information that could be
1195 lost, like the file name, the category, inherited tags, and the TODO
1196 state will be stored as properties in the entry.
1197 @kindex C-u C-c C-x C-s
1198 @item C-u C-c C-x C-s
1199 Check if any direct children of the current headline could be moved to
1200 the archive. To do this, each subtree is checked for open TODO entries.
1201 If none are found, the command offers to move it to the archive
1202 location. If the cursor is @emph{not} on a headline when this command
1203 is invoked, the level 1 trees will be checked.
1206 @cindex archive locations
1207 The default archive location is a file in the same directory as the
1208 current file, with the name derived by appending @file{_archive} to the
1209 current file name. For information and examples on how to change this,
1210 see the documentation string of the variable
1211 @code{org-archive-location}. There is also an in-buffer option for
1212 setting this variable, for example@footnote{For backward compatibility,
1213 the following also works: If there are several such lines in a file,
1214 each specifies the archive location for the text below it. The first
1215 such line also applies to any text before its definition. However,
1216 using this method is @emph{strongly} deprecated as it is incompatible
1217 with the outline structure of the document. The correct method for
1218 setting multiple archive locations in a buffer is using properties.}:
1222 #+ARCHIVE: %s_done::
1225 @cindex property, ARCHIVE
1227 If you would like to have a special ARCHIVE location for a single entry
1228 or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
1229 location as the value (@pxref{Properties and Columns}).
1231 @vindex org-archive-save-context-info
1232 When a subtree is moved, it receives a number of special properties that
1233 record context information like the file from where the entry came, its
1234 outline path the archiving time etc. Configure the variable
1235 @code{org-archive-save-context-info} to adjust the amount of information
1238 @node Sparse trees, Plain lists, Archiving, Document Structure
1239 @section Sparse trees
1240 @cindex sparse trees
1241 @cindex trees, sparse
1242 @cindex folding, sparse trees
1243 @cindex occur, command
1245 @vindex org-show-hierarchy-above
1246 @vindex org-show-following-heading
1247 @vindex org-show-siblings
1248 @vindex org-show-entry-below
1249 An important feature of Org mode is the ability to construct @emph{sparse
1250 trees} for selected information in an outline tree, so that the entire
1251 document is folded as much as possible, but the selected information is made
1252 visible along with the headline structure above it@footnote{See also the
1253 variables @code{org-show-hierarchy-above}, @code{org-show-following-heading},
1254 @code{org-show-siblings}, and @code{org-show-entry-below} for detailed
1255 control on how much context is shown around each match.}. Just try it out
1256 and you will see immediately how it works.
1258 Org mode contains several commands creating such trees, all these
1259 commands can be accessed through a dispatcher:
1264 This prompts for an extra key to select a sparse-tree creating command.
1267 @vindex org-remove-highlights-with-change
1268 Occur. Prompts for a regexp and shows a sparse tree with all matches. If
1269 the match is in a headline, the headline is made visible. If the match is in
1270 the body of an entry, headline and body are made visible. In order to
1271 provide minimal context, also the full hierarchy of headlines above the match
1272 is shown, as well as the headline following the match. Each match is also
1273 highlighted; the highlights disappear when the buffer is changed by an
1274 editing command@footnote{This depends on the option
1275 @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
1276 When called with a @kbd{C-u} prefix argument, previous highlights are kept,
1277 so several calls to this command can be stacked.
1281 @vindex org-agenda-custom-commands
1282 For frequently used sparse trees of specific search strings, you can
1283 use the variable @code{org-agenda-custom-commands} to define fast
1284 keyboard access to specific sparse trees. These commands will then be
1285 accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
1289 (setq org-agenda-custom-commands
1290 '(("f" occur-tree "FIXME")))
1293 @noindent will define the key @kbd{C-c a f} as a shortcut for creating
1294 a sparse tree matching the string @samp{FIXME}.
1296 The other sparse tree commands select headings based on TODO keywords,
1297 tags, or properties and will be discussed later in this manual.
1300 @cindex printing sparse trees
1301 @cindex visible text, printing
1302 To print a sparse tree, you can use the Emacs command
1303 @code{ps-print-buffer-with-faces} which does not print invisible parts
1304 of the document @footnote{This does not work under XEmacs, because
1305 XEmacs uses selective display for outlining, not text properties.}.
1306 Or you can use the command @kbd{C-c C-e v} to export only the visible
1307 part of the document and print the resulting file.
1309 @node Plain lists, Drawers, Sparse trees, Document Structure
1310 @section Plain lists
1312 @cindex lists, plain
1313 @cindex lists, ordered
1314 @cindex ordered lists
1316 Within an entry of the outline tree, hand-formatted lists can provide
1317 additional structure. They also provide a way to create lists of
1318 checkboxes (@pxref{Checkboxes}). Org supports editing such lists,
1319 and the HTML exporter (@pxref{Exporting}) parses and formats them.
1321 Org knows ordered lists, unordered lists, and description lists.
1324 @emph{Unordered} list items start with @samp{-}, @samp{+}, or
1325 @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
1326 they will be seen as top-level headlines. Also, when you are hiding leading
1327 stars to get a clean outline view, plain list items starting with a star are
1328 visually indistinguishable from true headlines. In short: even though
1329 @samp{*} is supported, it may be better to not use it for plain list items.}
1332 @emph{Ordered} list items start with a numeral followed by either a period or
1333 a right parenthesis, such as @samp{1.} or @samp{1)}.
1335 @emph{Description} list items are like unordered list items, but contain the
1336 separator @samp{ :: } to separate the description @emph{term} from the
1340 @vindex org-empty-line-terminates-plain-lists
1341 Items belonging to the same list must have the same indentation on the first
1342 line. In particular, if an ordered list reaches number @samp{10.}, then the
1343 2--digit numbers must be written left-aligned with the other numbers in the
1344 list. Indentation also determines the end of a list item. It ends before
1345 the next line that is indented like the bullet/number, or less. Empty lines
1346 are part of the previous item, so you can have several paragraphs in one
1347 item. If you would like an empty line to terminate all currently open plain
1348 lists, configure the variable @code{org-empty-line-terminates-plain-lists}.
1353 ** Lord of the Rings
1354 My favorite scenes are (in this order)
1355 1. The attack of the Rohirrim
1356 2. Eowyn's fight with the witch king
1357 + this was already my favorite scene in the book
1358 + I really like Miranda Otto.
1359 3. Peter Jackson being shot by Legolas
1361 He makes a really funny face when it happens.
1362 But in the end, no individual scenes matter but the film as a whole.
1363 Important actors in this film are:
1364 - @b{Elijah Wood} :: He plays Frodo
1365 - @b{Sean Austin} :: He plays Sam, Frodo's friend. I still remember
1366 him very well from his role as Mikey Walsh in @i{The Goonies}.
1370 Org supports these lists by tuning filling and wrapping commands to deal with
1371 them correctly@footnote{Org only changes the filling settings for Emacs. For
1372 XEmacs, you should use Kyle E. Jones' @file{filladapt.el}. To turn this on,
1373 put into @file{.emacs}: @code{(require 'filladapt)}}, and by exporting them
1374 properly (@pxref{Exporting}). Since indentation is what governs the
1375 structure of these lists, many structural constructs like @code{#+BEGIN_...}
1376 blocks can be indented to signal that they should be part of a list item.
1378 The following commands act on items when the cursor is in the first line
1379 of an item (the line with the bullet or number).
1384 @vindex org-cycle-include-plain-lists
1385 Items can be folded just like headline levels. Normally this works only if
1386 the cursor is on a plain list item. For more details, see the variable
1387 @code{org-cycle-include-plain-lists}. to @code{integrate}, plain list items
1388 will be treated like low-level. The level of an item is then given by the
1389 indentation of the bullet/number. Items are always subordinate to real
1390 headlines, however; the hierarchies remain completely separated.
1392 If @code{org-cycle-include-plain-lists} has not been set, @key{TAB}
1393 fixes the indentation of the current line in a heuristic way.
1396 @vindex org-M-RET-may-split-line
1397 Insert new item at current level. With a prefix argument, force a new
1398 heading (@pxref{Structure editing}). If this command is used in the middle
1399 of a line, the line is @emph{split} and the rest of the line becomes the new
1400 item@footnote{If you do not want the line to be split, customize the variable
1401 @code{org-M-RET-may-split-line}.}. If this command is executed in the
1402 @emph{whitespace before a bullet or number}, the new item is created
1403 @emph{before} the current item. If the command is executed in the white
1404 space before the text that is part of an item but does not contain the
1405 bullet, a bullet is added to the current line.
1406 @kindex M-S-@key{RET}
1408 Insert a new item with a checkbox (@pxref{Checkboxes}).
1410 @kindex S-@key{down}
1413 @cindex shift-selection-mode
1414 @vindex org-support-shift-select
1415 Jump to the previous/next item in the current list, but only if
1416 @code{org-support-shift-select} is off. If not, you can still use paragraph
1417 jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite
1419 @kindex M-S-@key{up}
1420 @kindex M-S-@key{down}
1422 @itemx M-S-@key{down}
1423 Move the item including subitems up/down (swap with previous/next item
1424 of same indentation). If the list is ordered, renumbering is
1426 @kindex M-S-@key{left}
1427 @kindex M-S-@key{right}
1428 @item M-S-@key{left}
1429 @itemx M-S-@key{right}
1430 Decrease/increase the indentation of the item, including subitems.
1431 Initially, the item tree is selected based on current indentation.
1432 When these commands are executed several times in direct succession,
1433 the initially selected region is used, even if the new indentation
1434 would imply a different hierarchy. To use the new hierarchy, break
1435 the command chain with a cursor motion or so.
1438 If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
1439 state of the checkbox. If not, this command makes sure that all the
1440 items on this list level use the same bullet. Furthermore, if this is
1441 an ordered list, make sure the numbering is OK.
1444 Cycle the entire list level through the different itemize/enumerate bullets
1445 (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}). With a numeric prefix
1446 argument N, select the Nth bullet from this list. If there is an active
1447 region when calling this, all lines will be converted to list items. If the
1448 first line already was a list item, any item markers will be removed from the
1449 list. Finally, even without an active region, a normal line will be
1450 converted into a list item.
1453 Turn a plain list item into a headline (so that it becomes a subheading at
1454 its location). @xref{Structure editing}, for a detailed explanation.
1455 @kindex S-@key{left}
1456 @kindex S-@key{right}
1457 @item S-@key{left}/@key{right}
1458 @vindex org-support-shift-select
1459 This command also cycles bullet styles when the cursor in on the bullet or
1460 anywhere in an item line, details depending on
1461 @code{org-support-shift-select}.
1464 Sort the plain list. You will be prompted for the sorting method:
1465 numerically, alphabetically, by time, or by custom function.
1468 @node Drawers, Blocks, Plain lists, Document Structure
1472 @cindex visibility cycling, drawers
1475 Sometimes you want to keep information associated with an entry, but you
1476 normally don't want to see it. For this, Org mode has @emph{drawers}.
1477 Drawers need to be configured with the variable
1478 @code{org-drawers}@footnote{You can define drawers on a per-file basis
1479 with a line like @code{#+DRAWERS: HIDDEN PROPERTIES STATE}}. Drawers
1483 ** This is a headline
1484 Still outside the drawer
1486 This is inside the drawer.
1491 Visibility cycling (@pxref{Visibility cycling}) on the headline will hide and
1492 show the entry, but keep the drawer collapsed to a single line. In order to
1493 look inside the drawer, you need to move the cursor to the drawer line and
1494 press @key{TAB} there. Org mode uses the @code{PROPERTIES} drawer for
1495 storing properties (@pxref{Properties and Columns}), and you can also arrange
1496 for state change notes (@pxref{Tracking TODO state changes}) and clock times
1497 (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}.
1499 @node Blocks, Footnotes, Drawers, Document Structure
1502 @vindex org-hide-block-startup
1503 @cindex blocks, folding
1504 Org-mode uses begin...end blocks for various purposes from including source
1505 code examples (@pxref{Literal examples}) to capturing time logging
1506 information (@pxref{Clocking work time}). These blocks can be folded and
1507 unfolded by pressing TAB in the begin line. You can also get all blocks
1508 folded at startup by configuring the variable @code{org-hide-block-startup}
1509 or on a per-file basis by using
1511 @cindex @code{hideblocks}, STARTUP keyword
1512 @cindex @code{nohideblocks}, STARTUP keyword
1514 #+STARTUP: hideblocks
1515 #+STARTUP: nohideblocks
1518 @node Footnotes, Orgstruct mode, Blocks, Document Structure
1522 Org mode supports the creation of footnotes. In contrast to the
1523 @file{footnote.el} package, Org mode's footnotes are designed for work on a
1524 larger document, not only for one-off documents like emails. The basic
1525 syntax is similar to the one used by @file{footnote.el}, @ie a footnote is
1526 defined in a paragraph that is started by a footnote marker in square
1527 brackets in column 0, no indentation allowed. If you need a paragraph break
1528 inside a footnote, use the La@TeX{} idiom @samp{\par}. The footnote reference
1529 is simply the marker in square brackets, inside text. For example:
1532 The Org homepage[fn:1] now looks a lot better than it used to.
1534 [fn:1] The link is: http://orgmode.org
1537 Org mode extends the number-based syntax to @emph{named} footnotes and
1538 optional inline definition. Using plain numbers as markers (as
1539 @file{footnote.el} does) is supported for backward compatibility, but not
1540 encouraged because of possible conflicts with La@TeX{} snippets (@pxref{Embedded
1541 LaTeX}). Here are the valid references:
1545 A plain numeric footnote marker. Compatible with @file{footnote.el}, but not
1546 recommended because somthing like @samp{[1]} could easily be part of a code
1549 A named footnote reference, where @code{name} is a unique label word, or, for
1550 simplicity of automatic creation, a number.
1551 @item [fn:: This is the inline definition of this footnote]
1552 A La@TeX{}-like anonymous footnote where the definition is given directly at the
1554 @item [fn:name: a definition]
1555 An inline definition of a footnote, which also specifies a name for the note.
1556 Since Org allows multiple references to the same note, you can then use
1557 @code{[fn:name]} to create additional references.
1560 @vindex org-footnote-auto-label
1561 Footnote labels can be created automatically, or you can create names yourself.
1562 This is handled by the variable @code{org-footnote-auto-label} and its
1563 corresponding @code{#+STARTUP} keywords, see the docstring of that variable
1566 @noindent The following command handles footnotes:
1571 The footnote action command.
1573 When the cursor is on a footnote reference, jump to the definition. When it
1574 is at a definition, jump to the (first) reference.
1576 @vindex org-footnote-define-inline
1577 @vindex org-footnote-section
1578 @vindex org-footnote-auto-adjust
1579 Otherwise, create a new footnote. Depending on the variable
1580 @code{org-footnote-define-inline}@footnote{The corresponding in-buffer
1581 setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
1582 definition will be placed right into the text as part of the reference, or
1583 separately into the location determined by the variable
1584 @code{org-footnote-section}.
1586 When this command is called with a prefix argument, a menu of additional
1589 s @r{Sort the footnote definitions by reference sequence. During editing,}
1590 @r{Org makes no effort to sort footnote definitions into a particular}
1591 @r{sequence. If you want them sorted, use this command, which will}
1592 @r{also move entries according to @code{org-footnote-section}. Automatic}
1593 @r{sorting after each insertion/deletion can be configured using the}
1594 @r{variable @code{org-footnote-auto-adjust}.}
1595 r @r{Renumber the simple @code{fn:N} footnotes. Automatic renumbering}
1596 @r{after each insertion/deletion can be configured using the variable}
1597 @r{@code{org-footnote-auto-adjust}.}
1598 S @r{Short for first @code{r}, then @code{s} action.}
1599 n @r{Normalize the footnotes by collecting all definitions (including}
1600 @r{inline definitions) into a special section, and then numbering them}
1601 @r{in sequence. The references will then also be numbers. This is}
1602 @r{meant to be the final step before finishing a document (e.g. sending}
1603 @r{off an email). The exporters do this automatically, and so could}
1604 @r{something like @code{message-send-hook}.}
1605 d @r{Delete the footnote at point, and all definitions of and references}
1608 Depending on the variable @code{org-footnote-auto-adjust}@footnote{the
1609 corresponding in-buffer options are @code{fnadjust} and @code{nofnadjust}.},
1610 renumbering and sorting footnotes can be automatic after each insertion or
1615 If the cursor is on a footnote reference, jump to the definition. If it is a
1616 the definition, jump back to the reference. When called at a footnote
1617 location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
1621 @item C-c C-o @r{or} mouse-1/2
1622 Footnote labels are also links to the corresponding definition/reference, and
1623 you can use the usual commands to follow these links.
1626 @node Orgstruct mode, , Footnotes, Document Structure
1627 @section The Orgstruct minor mode
1628 @cindex Orgstruct mode
1629 @cindex minor mode for structure editing
1631 If you like the intuitive way the Org mode structure editing and list
1632 formatting works, you might want to use these commands in other modes like
1633 Text mode or Mail mode as well. The minor mode @code{orgstruct-mode} makes
1634 this possible. Toggle the mode with @kbd{M-x orgstruct-mode}, or
1635 turn it on by default, for example in Mail mode, with one of:
1638 (add-hook 'mail-mode-hook 'turn-on-orgstruct)
1639 (add-hook 'mail-mode-hook 'turn-on-orgstruct++)
1642 When this mode is active and the cursor is on a line that looks to Org like a
1643 headline or the first line of a list item, most structure editing commands
1644 will work, even if the same keys normally have different functionality in the
1645 major mode you are using. If the cursor is not in one of those special
1646 lines, Orgstruct mode lurks silently in the shadow. When you use
1647 @code{orgstruct++-mode}, Org will also export indentation and autofill
1648 settings into that mode, and detect item context after the first line of an
1651 @node Tables, Hyperlinks, Document Structure, Top
1654 @cindex editing tables
1656 Org comes with a fast and intuitive table editor. Spreadsheet-like
1657 calculations are supported in connection with the Emacs @file{calc}
1660 (@pxref{Top,Calc,,Calc,Gnu Emacs Calculator Manual}).
1663 (see the Emacs Calculator manual for more information about the Emacs
1668 * Built-in table editor:: Simple tables
1669 * Column width and alignment:: Overrule the automatic settings
1670 * Column groups:: Grouping to trigger vertical lines
1671 * Orgtbl mode:: The table editor as minor mode
1672 * The spreadsheet:: The table editor has spreadsheet capabilities
1673 * Org-Plot:: Plotting from org tables
1676 @node Built-in table editor, Column width and alignment, Tables, Tables
1677 @section The built-in table editor
1678 @cindex table editor, built-in
1680 Org makes it easy to format tables in plain ASCII. Any line with
1681 @samp{|} as the first non-whitespace character is considered part of a
1682 table. @samp{|} is also the column separator. A table might look like
1686 | Name | Phone | Age |
1687 |-------+-------+-----|
1688 | Peter | 1234 | 17 |
1689 | Anna | 4321 | 25 |
1692 A table is re-aligned automatically each time you press @key{TAB} or
1693 @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to
1694 the next field (@key{RET} to the next row) and creates new table rows
1695 at the end of the table or before horizontal lines. The indentation
1696 of the table is set by the first line. Any line starting with
1697 @samp{|-} is considered as a horizontal separator line and will be
1698 expanded on the next re-align to span the whole table width. So, to
1699 create the above table, you would only type
1706 @noindent and then press @key{TAB} to align the table and start filling in
1707 fields. Even faster would be to type @code{|Name|Phone|Age} followed by
1708 @kbd{C-c @key{RET}}.
1710 @vindex org-enable-table-editor
1711 @vindex org-table-auto-blank-field
1712 When typing text into a field, Org treats @key{DEL},
1713 @key{Backspace}, and all character keys in a special way, so that
1714 inserting and deleting avoids shifting other fields. Also, when
1715 typing @emph{immediately after the cursor was moved into a new field
1716 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
1717 field is automatically made blank. If this behavior is too
1718 unpredictable for you, configure the variables
1719 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
1722 @tsubheading{Creation and conversion}
1725 Convert the active region to table. If every line contains at least one
1726 TAB character, the function assumes that the material is tab separated.
1727 If every line contains a comma, comma-separated values (CSV) are assumed.
1728 If not, lines are split at whitespace into fields. You can use a prefix
1729 argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
1730 C-u} forces TAB, and a numeric argument N indicates that at least N
1731 consecutive spaces, or alternatively a TAB will be the separator.
1733 If there is no active region, this command creates an empty Org
1734 table. But it's easier just to start typing, like
1735 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
1737 @tsubheading{Re-aligning and field motion}
1740 Re-align the table without moving the cursor.
1744 Re-align the table, move to the next field. Creates a new row if
1749 Re-align, move to previous field.
1753 Re-align the table and move down to next row. Creates a new row if
1754 necessary. At the beginning or end of a line, @key{RET} still does
1755 NEWLINE, so it can be used to split a table.
1759 Move to beginning of the current table field, or on to the previous field.
1762 Move to end of the current table field, or on to the next field.
1764 @tsubheading{Column and row editing}
1765 @kindex M-@key{left}
1766 @kindex M-@key{right}
1768 @itemx M-@key{right}
1769 Move the current column left/right.
1771 @kindex M-S-@key{left}
1772 @item M-S-@key{left}
1773 Kill the current column.
1775 @kindex M-S-@key{right}
1776 @item M-S-@key{right}
1777 Insert a new column to the left of the cursor position.
1780 @kindex M-@key{down}
1783 Move the current row up/down.
1785 @kindex M-S-@key{up}
1787 Kill the current row or horizontal line.
1789 @kindex M-S-@key{down}
1790 @item M-S-@key{down}
1791 Insert a new row above the current row. With a prefix argument, the line is
1792 created below the current one.
1796 Insert a horizontal line below current row. With a prefix argument, the line
1797 is created above the current line.
1799 @kindex C-c @key{RET}
1801 Insert a horizontal line below current row, and move the cursor into the row
1806 Sort the table lines in the region. The position of point indicates the
1807 column to be used for sorting, and the range of lines is the range
1808 between the nearest horizontal separator lines, or the entire table. If
1809 point is before the first column, you will be prompted for the sorting
1810 column. If there is an active region, the mark specifies the first line
1811 and the sorting column, while point should be in the last line to be
1812 included into the sorting. The command prompts for the sorting type
1813 (alphabetically, numerically, or by time). When called with a prefix
1814 argument, alphabetic sorting will be case-sensitive.
1816 @tsubheading{Regions}
1819 Copy a rectangular region from a table to a special clipboard. Point and
1820 mark determine edge fields of the rectangle. If there is no active region,
1821 copy just the current field. The process ignores horizontal separator lines.
1825 Copy a rectangular region from a table to a special clipboard, and
1826 blank all fields in the rectangle. So this is the ``cut'' operation.
1830 Paste a rectangular region into a table.
1831 The upper left corner ends up in the current field. All involved fields
1832 will be overwritten. If the rectangle does not fit into the present table,
1833 the table is enlarged as needed. The process ignores horizontal separator
1838 Wrap several fields in a column like a paragraph. If there is an active
1839 region, and both point and mark are in the same column, the text in the
1840 column is wrapped to minimum width for the given number of lines. A numeric
1841 prefix argument may be used to change the number of desired lines. If there
1842 is no region, the current field is split at the cursor position and the text
1843 fragment to the right of the cursor is prepended to the field one line
1844 down. If there is no region, but you specify a prefix argument, the current
1845 field is made blank, and the content is appended to the field above.
1847 @tsubheading{Calculations}
1848 @cindex formula, in tables
1849 @cindex calculations, in tables
1850 @cindex region, active
1851 @cindex active region
1852 @cindex transient mark mode
1855 Sum the numbers in the current column, or in the rectangle defined by
1856 the active region. The result is shown in the echo area and can
1857 be inserted with @kbd{C-y}.
1861 @vindex org-table-copy-increment
1862 When current field is empty, copy from first non-empty field above. When not
1863 empty, copy current field down to next row and move cursor along with it.
1864 Depending on the variable @code{org-table-copy-increment}, integer field
1865 values will be incremented during copy. Integers that are too large will not
1866 be incremented. Also, a @code{0} prefix argument temporarily disables the
1867 increment. This key is also used by shift-selection and related modes
1868 (@pxref{Conflicts}).
1870 @tsubheading{Miscellaneous}
1873 Edit the current field in a separate window. This is useful for fields that
1874 are not fully visible (@pxref{Column width and alignment}). When called with
1875 a @kbd{C-u} prefix, just make the full field visible, so that it can be
1878 @item M-x org-table-import
1879 Import a file as a table. The table should be TAB or whitespace
1880 separated. Use, for example, to import a spreadsheet table or data
1881 from a database, because these programs generally can write
1882 TAB-separated text files. This command works by inserting the file into
1883 the buffer and then converting the region to a table. Any prefix
1884 argument is passed on to the converter, which uses it to determine the
1887 Tables can also be imported by pasting tabular text into the Org
1888 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
1889 @kbd{C-c |} command (see above under @i{Creation and conversion}).
1891 @item M-x org-table-export
1892 @vindex org-table-export-default-format
1893 Export the table, by default as a TAB-separated file. Use for data
1894 exchange with, for example, spreadsheet or database programs. The format
1895 used to export the file can be configured in the variable
1896 @code{org-table-export-default-format}. You may also use properties
1897 @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
1898 name and the format for table export in a subtree. Org supports quite
1899 general formats for exported tables. The exporter format is the same as the
1900 format used by Orgtbl radio tables, see @ref{Translator functions}, for a
1901 detailed description.
1904 If you don't like the automatic table editor because it gets in your
1905 way on lines which you would like to start with @samp{|}, you can turn
1909 (setq org-enable-table-editor nil)
1912 @noindent Then the only table command that still works is
1913 @kbd{C-c C-c} to do a manual re-align.
1915 @node Column width and alignment, Column groups, Built-in table editor, Tables
1916 @section Column width and alignment
1917 @cindex narrow columns in tables
1918 @cindex alignment in tables
1920 The width of columns is automatically determined by the table editor. And
1921 also the alignment of a column is determined automatically from the fraction
1922 of number-like versus non-number fields in the column.
1924 Sometimes a single field or a few fields need to carry more text,
1925 leading to inconveniently wide columns. To limit@footnote{This feature
1926 does not work on XEmacs.} the width of a column, one field anywhere in
1927 the column may contain just the string @samp{<N>} where @samp{N} is an
1928 integer specifying the width of the column in characters. The next
1929 re-align will then set the width of this column to no more than this
1934 |---+------------------------------| |---+--------|
1936 | 1 | one | | 1 | one |
1937 | 2 | two | ----\ | 2 | two |
1938 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
1939 | 4 | four | | 4 | four |
1940 |---+------------------------------| |---+--------|
1945 Fields that are wider become clipped and end in the string @samp{=>}.
1946 Note that the full text is still in the buffer, it is only invisible.
1947 To see the full text, hold the mouse over the field---a tool-tip window
1948 will show the full content. To edit such a field, use the command
1949 @kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will
1950 open a new window with the full field. Edit it and finish with @kbd{C-c
1953 @vindex org-startup-align-all-tables
1954 When visiting a file containing a table with narrowed columns, the
1955 necessary character hiding has not yet happened, and the table needs to
1956 be aligned before it looks nice. Setting the option
1957 @code{org-startup-align-all-tables} will realign all tables in a file
1958 upon visiting, but also slow down startup. You can also set this option
1959 on a per-file basis with:
1966 If you would like to overrule the automatic alignment of number-rich columns
1967 to the right and of string-rich column to the left, you and use @samp{<r>} or
1968 @samp{<l>} in a similar fashion. You may also combine alignment and field
1969 width like this: @samp{<l10>}.
1971 @node Column groups, Orgtbl mode, Column width and alignment, Tables
1972 @section Column groups
1973 @cindex grouping columns in tables
1975 When Org exports tables, it does so by default without vertical
1976 lines because that is visually more satisfying in general. Occasionally
1977 however, vertical lines can be useful to structure a table into groups
1978 of columns, much like horizontal lines can do for groups of rows. In
1979 order to specify column groups, you can use a special row where the
1980 first field contains only @samp{/}. The further fields can either
1981 contain @samp{<} to indicate that this column should start a group,
1982 @samp{>} to indicate the end of a column, or @samp{<>} to make a column
1983 a group of its own. Boundaries between column groups will upon export be
1984 marked with vertical lines. Here is an example:
1987 | | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
1988 |---+----+-----+-----+-----+---------+------------|
1989 | / | <> | < | | > | < | > |
1990 | # | 1 | 1 | 1 | 1 | 1 | 1 |
1991 | # | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
1992 | # | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
1993 |---+----+-----+-----+-----+---------+------------|
1994 #+TBLFM: $3=$2^2::$4=$2^3::$5=$2^4::$6=sqrt($2)::$7=sqrt(sqrt(($2)))
1997 It is also sufficient to just insert the column group starters after
1998 every vertical line you'd like to have:
2001 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2002 |----+-----+-----+-----+---------+------------|
2006 @node Orgtbl mode, The spreadsheet, Column groups, Tables
2007 @section The Orgtbl minor mode
2009 @cindex minor mode for tables
2011 If you like the intuitive way the Org table editor works, you
2012 might also want to use it in other modes like Text mode or Mail mode.
2013 The minor mode Orgtbl mode makes this possible. You can always toggle
2014 the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for
2015 example in mail mode, use
2018 (add-hook 'mail-mode-hook 'turn-on-orgtbl)
2021 Furthermore, with some special setup, it is possible to maintain tables
2022 in arbitrary syntax with Orgtbl mode. For example, it is possible to
2023 construct La@TeX{} tables with the underlying ease and power of
2024 Orgtbl mode, including spreadsheet capabilities. For details, see
2025 @ref{Tables in arbitrary syntax}.
2027 @node The spreadsheet, Org-Plot, Orgtbl mode, Tables
2028 @section The spreadsheet
2029 @cindex calculations, in tables
2030 @cindex spreadsheet capabilities
2031 @cindex @file{calc} package
2033 The table editor makes use of the Emacs @file{calc} package to implement
2034 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
2035 derive fields from other fields. While fully featured, Org's
2036 implementation is not identical to other spreadsheets. For example,
2037 Org knows the concept of a @emph{column formula} that will be
2038 applied to all non-header fields in a column without having to copy the
2039 formula to each relevant field.
2042 * References:: How to refer to another field or range
2043 * Formula syntax for Calc:: Using Calc to compute stuff
2044 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
2045 * Field formulas:: Formulas valid for a single field
2046 * Column formulas:: Formulas valid for an entire column
2047 * Editing and debugging formulas:: Fixing formulas
2048 * Updating the table:: Recomputing all dependent fields
2049 * Advanced features:: Field names, parameters and automatic recalc
2052 @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet
2053 @subsection References
2056 To compute fields in the table from other fields, formulas must
2057 reference other fields or ranges. In Org, fields can be referenced
2058 by name, by absolute coordinates, and by relative coordinates. To find
2059 out what the coordinates of a field are, press @kbd{C-c ?} in that
2060 field, or press @kbd{C-c @}} to toggle the display of a grid.
2062 @subsubheading Field references
2063 @cindex field references
2064 @cindex references, to fields
2066 Formulas can reference the value of another field in two ways. Like in
2067 any other spreadsheet, you may reference fields with a letter/number
2068 combination like @code{B3}, meaning the 2nd field in the 3rd row.
2069 @c Such references are always fixed to that field, they don't change
2070 @c when you copy and paste a formula to a different field. So
2071 @c Org's @code{B3} behaves like @code{$B$3} in other spreadsheets.
2074 Org also uses another, more general operator that looks like this:
2076 @@@var{row}$@var{column}
2080 Column references can be absolute like @samp{1}, @samp{2},...@samp{@var{N}},
2081 or relative to the current column like @samp{+1} or @samp{-2}.
2083 The row specification only counts data lines and ignores horizontal
2084 separator lines (hlines). You can use absolute row numbers
2085 @samp{1}...@samp{@var{N}}, and row numbers relative to the current row like
2086 @samp{+3} or @samp{-1}. Or specify the row relative to one of the
2087 hlines: @samp{I} refers to the first hline@footnote{Note that only
2088 hlines are counted that @emph{separate} table lines. If the table
2089 starts with a hline above the header, it does not count.}, @samp{II} to
2090 the second, etc@. @samp{-I} refers to the first such line above the
2091 current line, @samp{+I} to the first such line below the current line.
2092 You can also write @samp{III+2} which is the second data line after the
2093 third hline in the table.
2095 @samp{0} refers to the current row and column. Also, if you omit
2096 either the column or the row part of the reference, the current
2097 row/column is implied.
2099 Org's references with @emph{unsigned} numbers are fixed references
2100 in the sense that if you use the same reference in the formula for two
2101 different fields, the same field will be referenced each time.
2102 Org's references with @emph{signed} numbers are floating
2103 references because the same reference operator can reference different
2104 fields depending on the field being calculated by the formula.
2106 As a special case, references like @samp{$LR5} and @samp{$LR12} can be used
2107 to refer in a stable way to the 5th and 12th field in the last row of the
2110 Here are a few examples:
2113 @@2$3 @r{2nd row, 3rd column}
2114 C2 @r{same as previous}
2115 $5 @r{column 5 in the current row}
2116 E& @r{same as previous}
2117 @@2 @r{current column, row 2}
2118 @@-1$-3 @r{the field one row up, three columns to the left}
2119 @@-I$2 @r{field just under hline above current row, column 2}
2122 @subsubheading Range references
2123 @cindex range references
2124 @cindex references, to ranges
2126 You may reference a rectangular range of fields by specifying two field
2127 references connected by two dots @samp{..}. If both fields are in the
2128 current row, you may simply use @samp{$2..$7}, but if at least one field
2129 is in a different row, you need to use the general @code{@@row$column}
2130 format at least for the first field (i.e the reference must start with
2131 @samp{@@} in order to be interpreted correctly). Examples:
2134 $1..$3 @r{First three fields in the current row.}
2135 $P..$Q @r{Range, using column names (see under Advanced)}
2136 @@2$1..@@4$3 @r{6 fields between these two fields.}
2137 A2..C4 @r{Same as above.}
2138 @@-1$-2..@@-1 @r{3 numbers from the column to the left, 2 up to current row}
2141 @noindent Range references return a vector of values that can be fed
2142 into Calc vector functions. Empty fields in ranges are normally
2143 suppressed, so that the vector contains only the non-empty fields (but
2144 see the @samp{E} mode switch below). If there are no non-empty fields,
2145 @samp{[0]} is returned to avoid syntax errors in formulas.
2147 @subsubheading Named references
2148 @cindex named references
2149 @cindex references, named
2150 @cindex name, of column or field
2151 @cindex constants, in calculations
2154 @vindex org-table-formula-constants
2155 @samp{$name} is interpreted as the name of a column, parameter or
2156 constant. Constants are defined globally through the variable
2157 @code{org-table-formula-constants}, and locally (for the file) through a
2161 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
2165 @vindex constants-unit-system
2166 @pindex constants.el
2167 Also properties (@pxref{Properties and Columns}) can be used as
2168 constants in table formulas: for a property @samp{:Xyz:} use the name
2169 @samp{$PROP_Xyz}, and the property will be searched in the current
2170 outline entry and in the hierarchy above it. If you have the
2171 @file{constants.el} package, it will also be used to resolve constants,
2172 including natural constants like @samp{$h} for Planck's constant, and
2173 units like @samp{$km} for kilometers@footnote{@file{constants.el} can
2174 supply the values of constants in two different unit systems, @code{SI}
2175 and @code{cgs}. Which one is used depends on the value of the variable
2176 @code{constants-unit-system}. You can use the @code{#+STARTUP} options
2177 @code{constSI} and @code{constcgs} to set this value for the current
2178 buffer.}. Column names and parameters can be specified in special table
2179 lines. These are described below, see @ref{Advanced features}. All
2180 names must start with a letter, and further consist of letters and
2183 @subsubheading Remote references
2184 @cindex remote references
2185 @cindex references, remote
2186 @cindex references, to a different table
2187 @cindex name, of column or field
2188 @cindex constants, in calculations
2191 You may also reference constants, fields and ranges from a different table,
2192 either in the current file or even in a different file. The syntax is
2195 remote(NAME-OR-ID,REF)
2199 where NAME can be the name of a table in the current file as set by a
2200 @code{#+TBLNAME: NAME} line before the table. It can also be the ID of an
2201 entry, even in a different file, and the reference then refers to the first
2202 table in that entry. REF is an absolute field or range reference as
2203 described above for example @code{@@3$3} or @code{$somename}, valid in the
2206 @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet
2207 @subsection Formula syntax for Calc
2208 @cindex formula syntax, Calc
2209 @cindex syntax, of formulas
2211 A formula can be any algebraic expression understood by the Emacs
2212 @file{Calc} package. @b{Note that @file{calc} has the
2213 non-standard convention that @samp{/} has lower precedence than
2214 @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.} Before
2215 evaluation by @code{calc-eval} (@pxref{Calling Calc from
2216 Your Programs,calc-eval,Calling Calc from Your Lisp Programs,Calc,GNU
2217 Emacs Calc Manual}),
2218 @c FIXME: The link to the Calc manual in HTML does not work.
2219 variable substitution takes place according to the rules described above.
2220 @cindex vectors, in table calculations
2221 The range vectors can be directly fed into the Calc vector functions
2222 like @samp{vmean} and @samp{vsum}.
2224 @cindex format specifier
2225 @cindex mode, for @file{calc}
2226 @vindex org-calc-default-modes
2227 A formula can contain an optional mode string after a semicolon. This
2228 string consists of flags to influence Calc and other modes during
2229 execution. By default, Org uses the standard Calc modes (precision
2230 12, angular units degrees, fraction and symbolic modes off). The display
2231 format, however, has been changed to @code{(float 8)} to keep tables
2232 compact. The default settings can be configured using the variable
2233 @code{org-calc-default-modes}.
2236 p20 @r{switch the internal precision to 20 digits}
2237 n3 s3 e2 f4 @r{normal, scientific, engineering, or fixed display format}
2238 D R @r{angle modes: degrees, radians}
2239 F S @r{fraction and symbolic modes}
2240 N @r{interpret all fields as numbers, use 0 for non-numbers}
2241 T @r{force text interpretation}
2242 E @r{keep empty fields in ranges}
2247 In addition, you may provide a @code{printf} format specifier to
2248 reformat the final result. A few examples:
2251 $1+$2 @r{Sum of first and second field}
2252 $1+$2;%.2f @r{Same, format result to two decimals}
2253 exp($2)+exp($1) @r{Math functions can be used}
2254 $0;%.1f @r{Reformat current cell to 1 decimal}
2255 ($3-32)*5/9 @r{Degrees F -> C conversion}
2256 $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}}
2257 tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1}
2258 sin($1);Dp3%.1e @r{Same, but use printf specifier for display}
2259 vmean($2..$7) @r{Compute column range mean, using vector function}
2260 vmean($2..$7);EN @r{Same, but treat empty fields as 0}
2261 taylor($3,x=7,2) @r{taylor series of $3, at x=7, second degree}
2264 Calc also contains a complete set of logical operations. For example
2267 if($1<20,teen,string("")) @r{``teen'' if age $1 less than 20, else empty}
2270 @node Formula syntax for Lisp, Field formulas, Formula syntax for Calc, The spreadsheet
2271 @subsection Emacs Lisp forms as formulas
2272 @cindex Lisp forms, as table formulas
2274 It is also possible to write a formula in Emacs Lisp; this can be useful
2275 for string manipulation and control structures, if Calc's
2276 functionality is not enough. If a formula starts with a single-quote
2277 followed by an opening parenthesis, then it is evaluated as a Lisp form.
2278 The evaluation should return either a string or a number. Just as with
2279 @file{calc} formulas, you can specify modes and a printf format after a
2280 semicolon. With Emacs Lisp forms, you need to be conscious about the way
2281 field references are interpolated into the form. By default, a
2282 reference will be interpolated as a Lisp string (in double-quotes)
2283 containing the field. If you provide the @samp{N} mode switch, all
2284 referenced elements will be numbers (non-number fields will be zero) and
2285 interpolated as Lisp numbers, without quotes. If you provide the
2286 @samp{L} flag, all fields will be interpolated literally, without quotes.
2287 @Ie{}, if you want a reference to be interpreted as a string by the Lisp
2288 form, enclose the reference operator itself in double-quotes, like
2289 @code{"$3"}. Ranges are inserted as space-separated fields, so you can
2290 embed them in list or vector syntax. A few examples, note how the
2291 @samp{N} mode is used when we do computations in Lisp.
2294 @r{Swap the first two characters of the content of column 1}
2295 '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
2296 @r{Add columns 1 and 2, equivalent to Calc's @code{$1+$2}}
2298 @r{Compute the sum of columns 1-4, like Calc's @code{vsum($1..$4)}}
2299 '(apply '+ '($1..$4));N
2302 @node Field formulas, Column formulas, Formula syntax for Lisp, The spreadsheet
2303 @subsection Field formulas
2304 @cindex field formula
2305 @cindex formula, for individual table field
2307 To assign a formula to a particular field, type it directly into the
2308 field, preceded by @samp{:=}, for example @samp{:=$1+$2}. When you
2309 press @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in
2310 the field, the formula will be stored as the formula for this field,
2311 evaluated, and the current field replaced with the result.
2314 Formulas are stored in a special line starting with @samp{#+TBLFM:}
2315 directly below the table. If you typed the equation in the 4th field of
2316 the 3rd data line in the table, the formula will look like
2317 @samp{@@3$4=$1+$2}. When inserting/deleting/swapping column and rows
2318 with the appropriate commands, @i{absolute references} (but not relative
2319 ones) in stored formulas are modified in order to still reference the
2320 same field. Of course this is not true if you edit the table structure
2321 with normal editing commands---then you must fix the equations yourself.
2322 The left-hand side of a formula may also be a named field (@pxref{Advanced
2323 features}), or a last-row reference like @samp{$LR3}.
2325 Instead of typing an equation into the field, you may also use the
2331 Install a new formula for the current field. The command prompts for a
2332 formula with default taken from the @samp{#+TBLFM:} line, applies
2333 it to the current field, and stores it.
2336 @node Column formulas, Editing and debugging formulas, Field formulas, The spreadsheet
2337 @subsection Column formulas
2338 @cindex column formula
2339 @cindex formula, for table column
2341 Often in a table, the same formula should be used for all fields in a
2342 particular column. Instead of having to copy the formula to all fields
2343 in that column, Org allows you to assign a single formula to an entire
2344 column. If the table contains horizontal separator hlines, everything
2345 before the first such line is considered part of the table @emph{header}
2346 and will not be modified by column formulas.
2348 To assign a formula to a column, type it directly into any field in the
2349 column, preceded by an equal sign, like @samp{=$1+$2}. When you press
2350 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2351 the formula will be stored as the formula for the current column, evaluated
2352 and the current field replaced with the result. If the field contains only
2353 @samp{=}, the previously stored formula for this column is used. For each
2354 column, Org will only remember the most recently used formula. In the
2355 @samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}. The left-hand
2356 side of a column formula cannot currently be the name of column, it
2357 must be the numeric column reference.
2359 Instead of typing an equation into the field, you may also use the
2365 Install a new formula for the current column and replace current field with
2366 the result of the formula. The command prompts for a formula, with default
2367 taken from the @samp{#+TBLFM} line, applies it to the current field and
2368 stores it. With a numeric prefix argument(@eg @kbd{C-5 C-c =}) the command
2369 will apply it to that many consecutive fields in the current column.
2372 @node Editing and debugging formulas, Updating the table, Column formulas, The spreadsheet
2373 @subsection Editing and debugging formulas
2374 @cindex formula editing
2375 @cindex editing, of table formulas
2377 @vindex org-table-use-standard-references
2378 You can edit individual formulas in the minibuffer or directly in the
2379 field. Org can also prepare a special buffer with all active
2380 formulas of a table. When offering a formula for editing, Org
2381 converts references to the standard format (like @code{B3} or @code{D&})
2382 if possible. If you prefer to only work with the internal format (like
2383 @code{@@3$2} or @code{$4}), configure the variable
2384 @code{org-table-use-standard-references}.
2391 Edit the formula associated with the current column/field in the
2392 minibuffer. See @ref{Column formulas}, and @ref{Field formulas}.
2393 @kindex C-u C-u C-c =
2395 Re-insert the active formula (either a
2396 field formula, or a column formula) into the current field, so that you
2397 can edit it directly in the field. The advantage over editing in the
2398 minibuffer is that you can use the command @kbd{C-c ?}.
2401 While editing a formula in a table field, highlight the field(s)
2402 referenced by the reference at the cursor position in the formula.
2405 Toggle the display of row and column numbers for a table, using
2406 overlays. These are updated each time the table is aligned; you can
2407 force it with @kbd{C-c C-c}.
2410 Toggle the formula debugger on and off. See below.
2413 Edit all formulas for the current table in a special buffer, where the
2414 formulas will be displayed one per line. If the current field has an
2415 active formula, the cursor in the formula editor will mark it.
2416 While inside the special buffer, Org will automatically highlight
2417 any field or range reference at the cursor position. You may edit,
2418 remove and add formulas, and use the following commands:
2424 Exit the formula editor and store the modified formulas. With @kbd{C-u}
2425 prefix, also apply the new formulas to the entire table.
2428 Exit the formula editor without installing changes.
2431 Toggle all references in the formula editor between standard (like
2432 @code{B3}) and internal (like @code{@@3$2}).
2435 Pretty-print or indent Lisp formula at point. When in a line containing
2436 a Lisp formula, format the formula according to Emacs Lisp rules.
2437 Another @key{TAB} collapses the formula back again. In the open
2438 formula, @key{TAB} re-indents just like in Emacs Lisp mode.
2441 Complete Lisp symbols, just like in Emacs Lisp mode.
2443 @kindex S-@key{down}
2444 @kindex S-@key{left}
2445 @kindex S-@key{right}
2446 @item S-@key{up}/@key{down}/@key{left}/@key{right}
2447 Shift the reference at point. For example, if the reference is
2448 @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
2449 This also works for relative references and for hline references.
2450 @kindex M-S-@key{up}
2451 @kindex M-S-@key{down}
2452 @item M-S-@key{up}/@key{down}
2453 Move the test line for column formulas in the Org buffer up and
2456 @kindex M-@key{down}
2457 @item M-@key{up}/@key{down}
2458 Scroll the window displaying the table.
2461 Turn the coordinate grid in the table on and off.
2465 Making a table field blank does not remove the formula associated with
2466 the field, because that is stored in a different line (the @samp{#+TBLFM}
2467 line)---during the next recalculation the field will be filled again.
2468 To remove a formula from a field, you have to give an empty reply when
2469 prompted for the formula, or to edit the @samp{#+TBLFM} line.
2472 You may edit the @samp{#+TBLFM} directly and re-apply the changed
2473 equations with @kbd{C-c C-c} in that line or with the normal
2474 recalculation commands in the table.
2476 @subsubheading Debugging formulas
2477 @cindex formula debugging
2478 @cindex debugging, of table formulas
2479 When the evaluation of a formula leads to an error, the field content
2480 becomes the string @samp{#ERROR}. If you would like see what is going
2481 on during variable substitution and calculation in order to find a bug,
2482 turn on formula debugging in the @code{Tbl} menu and repeat the
2483 calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
2484 field. Detailed information will be displayed.
2486 @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet
2487 @subsection Updating the table
2488 @cindex recomputing table fields
2489 @cindex updating, table
2491 Recalculation of a table is normally not automatic, but needs to be
2492 triggered by a command. See @ref{Advanced features}, for a way to make
2493 recalculation at least semi-automatic.
2495 In order to recalculate a line of a table or the entire table, use the
2501 Recalculate the current row by first applying the stored column formulas
2502 from left to right, and all field formulas in the current row.
2508 Recompute the entire table, line by line. Any lines before the first
2509 hline are left alone, assuming that these are part of the table header.
2511 @kindex C-u C-u C-c *
2512 @kindex C-u C-u C-c C-c
2514 @itemx C-u C-u C-c C-c
2515 Iterate the table by recomputing it until no further changes occur.
2516 This may be necessary if some computed fields use the value of other
2517 fields that are computed @i{later} in the calculation sequence.
2520 @node Advanced features, , Updating the table, The spreadsheet
2521 @subsection Advanced features
2523 If you want the recalculation of fields to happen automatically, or if
2524 you want to be able to assign @i{names} to fields and columns, you need
2525 to reserve the first column of the table for special marking characters.
2529 Rotate the calculation mark in first column through the states @samp{},
2530 @samp{#}, @samp{*}, @samp{!}, @samp{$}. When there is an active region,
2531 change all marks in the region.
2534 Here is an example of a table that collects exam results of students and
2535 makes use of these features:
2539 |---+---------+--------+--------+--------+-------+------|
2540 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
2541 |---+---------+--------+--------+--------+-------+------|
2542 | ! | | P1 | P2 | P3 | Tot | |
2543 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
2544 | ^ | | m1 | m2 | m3 | mt | |
2545 |---+---------+--------+--------+--------+-------+------|
2546 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
2547 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
2548 |---+---------+--------+--------+--------+-------+------|
2549 | | Average | | | | 29.7 | |
2550 | ^ | | | | | at | |
2551 | $ | max=50 | | | | | |
2552 |---+---------+--------+--------+--------+-------+------|
2553 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
2557 @noindent @b{Important}: please note that for these special tables,
2558 recalculating the table with @kbd{C-u C-c *} will only affect rows that
2559 are marked @samp{#} or @samp{*}, and fields that have a formula assigned
2560 to the field itself. The column formulas are not applied in rows with
2563 @cindex marking characters, tables
2564 The marking characters have the following meaning:
2567 The fields in this line define names for the columns, so that you may
2568 refer to a column as @samp{$Tot} instead of @samp{$6}.
2570 This row defines names for the fields @emph{above} the row. With such
2571 a definition, any formula in the table may use @samp{$m1} to refer to
2572 the value @samp{10}. Also, if you assign a formula to a names field, it
2573 will be stored as @samp{$name=...}.
2575 Similar to @samp{^}, but defines names for the fields in the row
2578 Fields in this row can define @emph{parameters} for formulas. For
2579 example, if a field in a @samp{$} row contains @samp{max=50}, then
2580 formulas in this table can refer to the value 50 using @samp{$max}.
2581 Parameters work exactly like constants, only that they can be defined on
2584 Fields in this row are automatically recalculated when pressing
2585 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row
2586 is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked
2587 lines will be left alone by this command.
2589 Selects this line for global recalculation with @kbd{C-u C-c *}, but
2590 not for automatic recalculation. Use this when automatic
2591 recalculation slows down editing too much.
2593 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
2594 All lines that should be recalculated should be marked with @samp{#}
2597 Do not export this line. Useful for lines that contain the narrowing
2598 @samp{<N>} markers or column group markers.
2601 Finally, just to whet your appetite for what can be done with the
2602 fantastic @file{calc.el} package, here is a table that computes the Taylor
2603 series of degree @code{n} at location @code{x} for a couple of
2608 |---+-------------+---+-----+--------------------------------------|
2609 | | Func | n | x | Result |
2610 |---+-------------+---+-----+--------------------------------------|
2611 | # | exp(x) | 1 | x | 1 + x |
2612 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
2613 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
2614 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
2615 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
2616 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
2617 |---+-------------+---+-----+--------------------------------------|
2618 #+TBLFM: $5=taylor($2,$4,$3);n3
2622 @node Org-Plot, , The spreadsheet, Tables
2624 @cindex graph, in tables
2625 @cindex plot tables using gnuplot
2628 Org-Plot can produce 2D and 3D graphs of information stored in org tables
2629 using @file{Gnuplot} @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
2630 @uref{http://cars9.uchicago.edu/~ravel/software/gnuplot-mode.html}. To see
2631 this in action, ensure that you have both Gnuplot and Gnuplot mode installed
2632 on your system, then call @code{org-plot/gnuplot} on the following table.
2636 #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
2637 | Sede | Max cites | H-index |
2638 |-----------+-----------+---------|
2639 | Chile | 257.72 | 21.39 |
2640 | Leeds | 165.77 | 19.68 |
2641 | Sao Paolo | 71.00 | 11.50 |
2642 | Stockholm | 134.19 | 14.33 |
2643 | Morelia | 257.56 | 17.67 |
2647 Notice that Org Plot is smart enough to apply the table's headers as labels.
2648 Further control over the labels, type, content, and appearance of plots can
2649 be exercised through the @code{#+PLOT:} lines preceding a table. See below
2650 for a complete list of Org-plot options. For more information and examples
2651 see the Org-plot tutorial at
2652 @uref{http://orgmode.org/worg/org-tutorials/org-plot.php}.
2654 @subsubheading Plot Options
2658 Specify any @command{gnuplot} option to be set when graphing.
2661 Specify the title of the plot.
2664 Specify which column of the table to use as the @code{x} axis.
2667 Specify the columns to graph as a Lisp style list, surrounded by parentheses
2668 and separated by spaces for example @code{dep:(3 4)} to graph the third and
2669 fourth columns (defaults to graphing all other columns aside from the @code{ind}
2673 Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
2676 Specify a @code{with} option to be inserted for every col being plotted
2677 (@eg @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
2678 Defaults to @code{lines}.
2681 If you want to plot to a file, specify @code{"@var{path/to/desired/output-file}"}.
2684 List of labels to be used for the deps (defaults to the column headers if
2688 Specify an entire line to be inserted in the Gnuplot script.
2691 When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
2692 flat mapping rather than a @code{3d} slope.
2695 Specify format of Org-mode timestamps as they will be parsed by Gnuplot.
2696 Defaults to @samp{%Y-%m-%d-%H:%M:%S}.
2699 If you want total control, you can specify a script file (place the file name
2700 between double-quotes) which will be used to plot. Before plotting, every
2701 instance of @code{$datafile} in the specified script will be replaced with
2702 the path to the generated data file. Note: even if you set this option, you
2703 may still want to specify the plot type, as that can impact the content of
2707 @node Hyperlinks, TODO Items, Tables, Top
2711 Like HTML, Org provides links inside a file, external links to
2712 other files, Usenet articles, emails, and much more.
2715 * Link format:: How links in Org are formatted
2716 * Internal links:: Links to other places in the current file
2717 * External links:: URL-like links to the world
2718 * Handling links:: Creating, inserting and following
2719 * Using links outside Org:: Linking from my C source code?
2720 * Link abbreviations:: Shortcuts for writing complex links
2721 * Search options:: Linking to a specific location
2722 * Custom searches:: When the default search is not enough
2725 @node Link format, Internal links, Hyperlinks, Hyperlinks
2726 @section Link format
2728 @cindex format, of links
2730 Org will recognize plain URL-like links and activate them as
2731 clickable links. The general link format, however, looks like this:
2734 [[link][description]] @r{or alternatively} [[link]]
2738 Once a link in the buffer is complete (all brackets present), Org
2739 will change the display so that @samp{description} is displayed instead
2740 of @samp{[[link][description]]} and @samp{link} is displayed instead of
2741 @samp{[[link]]}. Links will be highlighted in the face @code{org-link},
2742 which by default is an underlined face. You can directly edit the
2743 visible part of a link. Note that this can be either the @samp{link}
2744 part (if there is no description) or the @samp{description} part. To
2745 edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
2748 If you place the cursor at the beginning or just behind the end of the
2749 displayed text and press @key{BACKSPACE}, you will remove the
2750 (invisible) bracket at that location. This makes the link incomplete
2751 and the internals are again displayed as plain text. Inserting the
2752 missing bracket hides the link internals again. To show the
2753 internal structure of all links, use the menu entry
2754 @code{Org->Hyperlinks->Literal links}.
2756 @node Internal links, External links, Link format, Hyperlinks
2757 @section Internal links
2758 @cindex internal links
2759 @cindex links, internal
2760 @cindex targets, for links
2762 @cindex property, CUSTOM_ID
2763 If the link does not look like a URL, it is considered to be internal in the
2764 current file. The most important case is a link like
2765 @samp{[[#my-custom-id]]} which will link to the entry with the
2766 @code{CUSTOM_ID} property @samp{my-custom-id}. Such custom IDs are very good
2767 for HTML export (@pxref{HTML export}) where they produce pretty section
2768 links. You are responsible yourself to make sure these custom IDs are unique
2771 Links such as @samp{[[My Target]]} or @samp{[[My Target][Find my target]]}
2772 lead to a text search in the current file.
2774 The link can be followed with @kbd{C-c C-o} when the cursor is on the link,
2775 or with a mouse click (@pxref{Handling links}). Links to custom IDs will
2776 point to the corresponding headline. The preferred match for a text link is
2777 a @i{dedicated target}: the same string in double angular brackets. Targets
2778 may be located anywhere; sometimes it is convenient to put them into a
2779 comment line. For example
2785 @noindent In HTML export (@pxref{HTML export}), such targets will become
2786 named anchors for direct access through @samp{http} links@footnote{Note that
2787 text before the first headline is usually not exported, so the first such
2788 target should be after the first headline, or in the line directly before the
2791 If no dedicated target exists, Org will search for the words in the link. In
2792 the above example the search would be for @samp{my target}. Links starting
2793 with a star like @samp{*My Target} restrict the search to
2794 headlines@footnote{To insert a link targeting a headline, in-buffer
2795 completion can be used. Just type a star followed by a few optional letters
2796 into the buffer and press @kbd{M-@key{TAB}}. All headlines in the current
2797 buffer will be offered as completions. @xref{Handling links}, for more
2798 commands creating links.}. When searching, Org mode will first try an
2799 exact match, but then move on to more and more lenient searches. For
2800 example, the link @samp{[[*My Targets]]} will find any of the following:
2804 ** TODO my targets are bright
2805 ** my 20 targets are
2809 Following a link pushes a mark onto Org's own mark ring. You can
2810 return to the previous position with @kbd{C-c &}. Using this command
2811 several times in direct succession goes back to positions recorded
2815 * Radio targets:: Make targets trigger links in plain text
2818 @node Radio targets, , Internal links, Internal links
2819 @subsection Radio targets
2820 @cindex radio targets
2821 @cindex targets, radio
2822 @cindex links, radio targets
2824 Org can automatically turn any occurrences of certain target names
2825 in normal text into a link. So without explicitly creating a link, the
2826 text connects to the target radioing its position. Radio targets are
2827 enclosed by triple angular brackets. For example, a target @samp{<<<My
2828 Target>>>} causes each occurrence of @samp{my target} in normal text to
2829 become activated as a link. The Org file is scanned automatically
2830 for radio targets only when the file is first loaded into Emacs. To
2831 update the target list during editing, press @kbd{C-c C-c} with the
2832 cursor on or at a target.
2834 @node External links, Handling links, Internal links, Hyperlinks
2835 @section External links
2836 @cindex links, external
2837 @cindex external links
2838 @cindex links, external
2846 @cindex WANDERLUST links
2848 @cindex USENET links
2853 Org supports links to files, websites, Usenet and email messages,
2854 BBDB database entries and links to both IRC conversations and their
2855 logs. External links are URL-like locators. They start with a short
2856 identifying string followed by a colon. There can be no space after
2857 the colon. The following list shows examples for each link type.
2860 http://www.astro.uva.nl/~dominik @r{on the web}
2861 file:/home/dominik/images/jupiter.jpg @r{file, absolute path}
2862 /home/dominik/images/jupiter.jpg @r{same as above}
2863 file:papers/last.pdf @r{file, relative path}
2864 ./papers/last.pdf @r{same as above}
2865 file:projects.org @r{another Org file}
2866 file:projects.org::some words @r{text search in Org file}
2867 file:projects.org::*task title @r{heading search in Org file}
2868 id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID}
2869 news:comp.emacs @r{Usenet link}
2870 mailto:adent@@galaxy.net @r{Mail link}
2871 vm:folder @r{VM folder link}
2872 vm:folder#id @r{VM message link}
2873 vm://myself@@some.where.org/folder#id @r{VM on remote machine}
2874 wl:folder @r{WANDERLUST folder link}
2875 wl:folder#id @r{WANDERLUST message link}
2876 mhe:folder @r{MH-E folder link}
2877 mhe:folder#id @r{MH-E message link}
2878 rmail:folder @r{RMAIL folder link}
2879 rmail:folder#id @r{RMAIL message link}
2880 gnus:group @r{Gnus group link}
2881 gnus:group#id @r{Gnus article link}
2882 bbdb:R.*Stallman @r{BBDB link (with regexp)}
2883 irc:/irc.com/#emacs/bob @r{IRC link}
2884 shell:ls *.org @r{A shell command}
2885 elisp:org-agenda @r{Interactive Elisp command}
2886 elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
2889 A link should be enclosed in double brackets and may contain a
2890 descriptive text to be displayed instead of the URL (@pxref{Link
2891 format}), for example:
2894 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
2898 If the description is a file name or URL that points to an image, HTML
2899 export (@pxref{HTML export}) will inline the image as a clickable
2900 button. If there is no description at all and the link points to an
2902 that image will be inlined into the exported HTML file.
2904 @cindex square brackets, around links
2905 @cindex plain text external links
2906 Org also finds external links in the normal text and activates them
2907 as links. If spaces must be part of the link (for example in
2908 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
2909 about the end of the link, enclose them in square brackets.
2911 @node Handling links, Using links outside Org, External links, Hyperlinks
2912 @section Handling links
2913 @cindex links, handling
2915 Org provides methods to create a link in the correct syntax, to
2916 insert it into an Org file, and to follow the link.
2920 @cindex storing links
2922 Store a link to the current location. This is a @emph{global} command (you
2923 must create the key binding yourself) which can be used in any buffer to
2924 create a link. The link will be stored for later insertion into an Org
2925 buffer (see below). What kind of link will be created depends on the current
2928 @b{Org-mode buffers}@*
2929 For Org files, if there is a @samp{<<target>>} at the cursor, the link points
2930 to the target. Otherwise it points to the current headline, which will also
2933 @vindex org-link-to-org-use-id
2934 @cindex property, CUSTOM_ID
2935 @cindex property, ID
2936 If the headline has a @code{CUSTOM_ID} property, a link to this custom ID
2937 will be stored. In addition or alternatively (depending on the value of
2938 @code{org-link-to-org-use-id}), a globally unique @code{ID} property will be
2939 created and/or used to construct a link. So using this command in Org
2940 buffers will potentially create two links: a human-readable from the custom
2941 ID, and one that is globally unique and works even if the entry is moved from
2942 file to file. Later, when inserting the link, you need to decide which one
2945 @b{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus}@*
2946 Pretty much all Emacs mail clients are supported. The link will point to the
2947 current article, or, in some GNUS buffers, to the group. The description is
2948 constructed from the author and the subject.
2950 @b{Web browsers: W3 and W3M}@*
2951 Here the link will be the current URL, with the page title as description.
2953 @b{Contacts: BBDB}@*
2954 Links created in a BBDB buffer will point to the current entry.
2957 @vindex org-irc-link-to-logs
2958 For IRC links, if you set the variable @code{org-irc-link-to-logs} to
2959 @code{t}, a @samp{file:/} style link to the relevant point in the logs for
2960 the current conversation is created. Otherwise an @samp{irc:/} style link to
2961 the user/channel/server under the point will be stored.
2964 For any other files, the link will point to the file, with a search string
2965 (@pxref{Search options}) pointing to the contents of the current line. If
2966 there is an active region, the selected words will form the basis of the
2967 search string. If the automatically created link is not working correctly or
2968 accurately enough, you can write custom functions to select the search string
2969 and to do the search for particular file types---see @ref{Custom searches}.
2970 The key binding @kbd{C-c l} is only a suggestion---see @ref{Installation}.
2973 @cindex link completion
2974 @cindex completion, of links
2975 @cindex inserting links
2977 @vindex org-keep-stored-link-after-insertion
2978 Insert a link@footnote{ Note that you don't have to use this command to
2979 insert a link. Links in Org are plain text, and you can type or paste them
2980 straight into the buffer. By using this command, the links are automatically
2981 enclosed in double brackets, and you will be asked for the optional
2982 descriptive text.}. This prompts for a link to be inserted into the buffer.
2983 You can just type a link, using text for an internal link, or one of the link
2984 type prefixes mentioned in the examples above. The link will be inserted
2985 into the buffer@footnote{After insertion of a stored link, the link will be
2986 removed from the list of stored links. To keep it in the list later use, use
2987 a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
2988 @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
2989 If some text was selected when this command is called, the selected text
2990 becomes the default description.
2992 @b{Inserting stored links}@*
2993 All links stored during the
2994 current session are part of the history for this prompt, so you can access
2995 them with @key{up} and @key{down} (or @kbd{M-p/n}).
2997 @b{Completion support}@* Completion with @key{TAB} will help you to insert
2998 valid link prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
2999 defined through link abbreviations (@pxref{Link abbreviations}). If you
3000 press @key{RET} after inserting only the @var{prefix}, Org will offer
3001 specific completion support for some link types@footnote{This works by
3002 calling a special function @code{org-PREFIX-complete-link}.} For
3003 example, if you type @kbd{file @key{RET}}, file name completion (alternative
3004 access: @kbd{C-u C-c C-l}, see below) will be offered, and after @kbd{bbdb
3005 @key{RET}} you can complete contact names.
3007 @cindex file name completion
3008 @cindex completion, of file names
3010 When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
3011 a file will be inserted and you may use file name completion to select
3012 the name of the file. The path to the file is inserted relative to the
3013 directory of the current Org file, if the linked file is in the current
3014 directory or in a sub-directory of it, or if the path is written relative
3015 to the current directory using @samp{../}. Otherwise an absolute path
3016 is used, if possible with @samp{~/} for your home directory. You can
3017 force an absolute path with two @kbd{C-u} prefixes.
3019 @item C-c C-l @r{(with cursor on existing link)}
3020 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
3021 link and description parts of the link.
3023 @cindex following links
3026 @item C-c C-o @r{or} @key{RET}
3027 @vindex org-file-apps
3028 Open link at point. This will launch a web browser for URLs (using
3029 @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
3030 the corresponding links, and execute the command in a shell link. When the
3031 cursor is on an internal link, this commands runs the corresponding search.
3032 When the cursor is on a TAG list in a headline, it creates the corresponding
3033 TAGS view. If the cursor is on a timestamp, it compiles the agenda for that
3034 date. Furthermore, it will visit text and remote files in @samp{file:} links
3035 with Emacs and select a suitable application for local non-text files.
3036 Classification of files is based on file extension only. See option
3037 @code{org-file-apps}. If you want to override the default application and
3038 visit the file with Emacs, use a @kbd{C-u} prefix. If you want to avoid
3039 opening in Emacs, use a @kbd{C-u C-u} prefix.
3045 On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
3046 would. Under Emacs 22, @kbd{mouse-1} will also follow a link.
3050 @vindex org-display-internal-link-with-indirect-buffer
3051 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
3052 internal links to be displayed in another window@footnote{See the
3053 variable @code{org-display-internal-link-with-indirect-buffer}}.
3058 Push the current position onto the mark ring, to be able to return
3059 easily. Commands following an internal link do this automatically.
3061 @cindex links, returning to
3064 Jump back to a recorded position. A position is recorded by the
3065 commands following internal links, and by @kbd{C-c %}. Using this
3066 command several times in direct succession moves through a ring of
3067 previously recorded positions.
3071 @cindex links, finding next/previous
3074 Move forward/backward to the next link in the buffer. At the limit of
3075 the buffer, the search fails once, and then wraps around. The key
3076 bindings for this are really too long, you might want to bind this also
3077 to @kbd{C-n} and @kbd{C-p}
3079 (add-hook 'org-load-hook
3081 (define-key 'org-mode-map "\C-n" 'org-next-link)
3082 (define-key 'org-mode-map "\C-p" 'org-previous-link)))
3086 @node Using links outside Org, Link abbreviations, Handling links, Hyperlinks
3087 @section Using links outside Org
3089 You can insert and follow links that have Org syntax not only in
3090 Org, but in any Emacs buffer. For this, you should create two
3091 global commands, like this (please select suitable global keys
3095 (global-set-key "\C-c L" 'org-insert-link-global)
3096 (global-set-key "\C-c o" 'org-open-at-point-global)
3099 @node Link abbreviations, Search options, Using links outside Org, Hyperlinks
3100 @section Link abbreviations
3101 @cindex link abbreviations
3102 @cindex abbreviation, links
3104 Long URLs can be cumbersome to type, and often many similar links are
3105 needed in a document. For this you can use link abbreviations. An
3106 abbreviated link looks like this
3109 [[linkword:tag][description]]
3113 @vindex org-link-abbrev-alist
3114 where the tag is optional. The @i{linkword} must be a word; letter, numbers,
3115 @samp{-}, and @samp{_} are allowed here. Abbreviations are resolved
3116 according to the information in the variable @code{org-link-abbrev-alist}
3117 that relates the linkwords to replacement text. Here is an example:
3121 (setq org-link-abbrev-alist
3122 '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
3123 ("google" . "http://www.google.com/search?q=")
3124 ("ads" . "http://adsabs.harvard.edu/cgi-bin/
3125 nph-abs_connect?author=%s&db_key=AST")))
3129 If the replacement text contains the string @samp{%s}, it will be
3130 replaced with the tag. Otherwise the tag will be appended to the string
3131 in order to create the link. You may also specify a function that will
3132 be called with the tag as the only argument to create the link.
3134 With the above setting, you could link to a specific bug with
3135 @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
3136 @code{[[google:OrgMode]]} and find out what the Org author is
3137 doing besides Emacs hacking with @code{[[ads:Dominik,C]]}.
3139 If you need special abbreviations just for a single Org buffer, you
3140 can define them in the file with
3144 #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
3145 #+LINK: google http://www.google.com/search?q=%s
3149 In-buffer completion (@pxref{Completion}) can be used after @samp{[} to
3150 complete link abbreviations. You may also define a function
3151 @code{org-PREFIX-complete-link} that implements special (@eg completion)
3152 support for inserting such a link with @kbd{C-c C-l}. Such a function should
3153 not accept any arguments, and return the full link with prefix.
3155 @node Search options, Custom searches, Link abbreviations, Hyperlinks
3156 @section Search options in file links
3157 @cindex search option in file links
3158 @cindex file links, searching
3160 File links can contain additional information to make Emacs jump to a
3161 particular location in the file when following a link. This can be a
3162 line number or a search option after a double@footnote{For backward
3163 compatibility, line numbers can also follow a single colon.} colon. For
3164 example, when the command @kbd{C-c l} creates a link (@pxref{Handling
3165 links}) to a file, it encodes the words in the current line as a search
3166 string that can be used to find this line back later when following the
3167 link with @kbd{C-c C-o}.
3169 Here is the syntax of the different ways to attach a search to a file
3170 link, together with an explanation:
3173 [[file:~/code/main.c::255]]
3174 [[file:~/xx.org::My Target]]
3175 [[file:~/xx.org::*My Target]]
3176 [[file:~/xx.org::/regexp/]]
3183 Search for a link target @samp{<<My Target>>}, or do a text search for
3184 @samp{my target}, similar to the search in internal links, see
3185 @ref{Internal links}. In HTML export (@pxref{HTML export}), such a file
3186 link will become an HTML reference to the corresponding named anchor in
3189 In an Org file, restrict search to headlines.
3191 Do a regular expression search for @code{regexp}. This uses the Emacs
3192 command @code{occur} to list all matches in a separate window. If the
3193 target file is in Org mode, @code{org-occur} is used to create a
3194 sparse tree with the matches.
3195 @c If the target file is a directory,
3196 @c @code{grep} will be used to search all files in the directory.
3199 As a degenerate case, a file link with an empty file name can be used
3200 to search the current file. For example, @code{[[file:::find me]]} does
3201 a search for @samp{find me} in the current file, just as
3202 @samp{[[find me]]} would.
3204 @node Custom searches, , Search options, Hyperlinks
3205 @section Custom Searches
3206 @cindex custom search strings
3207 @cindex search strings, custom
3209 The default mechanism for creating search strings and for doing the
3210 actual search related to a file link may not work correctly in all
3211 cases. For example, Bib@TeX{} database files have many entries like
3212 @samp{year="1993"} which would not result in good search strings,
3213 because the only unique identification for a Bib@TeX{} entry is the
3216 @vindex org-create-file-search-functions
3217 @vindex org-execute-file-search-functions
3218 If you come across such a problem, you can write custom functions to set
3219 the right search string for a particular file type, and to do the search
3220 for the string in the file. Using @code{add-hook}, these functions need
3221 to be added to the hook variables
3222 @code{org-create-file-search-functions} and
3223 @code{org-execute-file-search-functions}. See the docstring for these
3224 variables for more information. Org actually uses this mechanism
3225 for Bib@TeX{} database files, and you can use the corresponding code as
3226 an implementation example. See the file @file{org-bibtex.el}.
3228 @node TODO Items, Tags, Hyperlinks, Top
3232 Org mode does not maintain TODO lists as separate documents@footnote{Of
3233 course, you can make a document that contains only long lists of TODO items,
3234 but this is not required.}. Instead, TODO items are an integral part of the
3235 notes file, because TODO items usually come up while taking notes! With Org
3236 mode, simply mark any entry in a tree as being a TODO item. In this way,
3237 information is not duplicated, and the entire context from which the TODO
3238 item emerged is always present.
3240 Of course, this technique for managing TODO items scatters them
3241 throughout your notes file. Org mode compensates for this by providing
3242 methods to give you an overview of all the things that you have to do.
3245 * TODO basics:: Marking and displaying TODO entries
3246 * TODO extensions:: Workflow and assignments
3247 * Progress logging:: Dates and notes for progress
3248 * Priorities:: Some things are more important than others
3249 * Breaking down tasks:: Splitting a task into manageable pieces
3250 * Checkboxes:: Tick-off lists
3253 @node TODO basics, TODO extensions, TODO Items, TODO Items
3254 @section Basic TODO functionality
3256 Any headline becomes a TODO item when it starts with the word
3257 @samp{TODO}, for example:
3260 *** TODO Write letter to Sam Fortune
3264 The most important commands to work with TODO entries are:
3268 @cindex cycling, of TODO states
3270 Rotate the TODO state of the current item among
3273 ,-> (unmarked) -> TODO -> DONE --.
3274 '--------------------------------'
3277 The same rotation can also be done ``remotely'' from the timeline and
3278 agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}).
3282 Select a specific keyword using completion or (if it has been set up)
3283 the fast selection interface. For the latter, you need to assign keys
3284 to TODO states, see @ref{Per-file keywords}, and @ref{Setting tags}, for
3287 @kindex S-@key{right}
3288 @kindex S-@key{left}
3289 @vindex org-treat-S-cursor-todo-selection-as-state-change
3292 Select the following/preceding TODO state, similar to cycling. Useful
3293 mostly if more than two TODO states are possible (@pxref{TODO
3294 extensions}). See also @ref{Conflicts}, for a discussion of the interaction
3295 with @code{shift-selection-mode}. See also the variable
3296 @code{org-treat-S-cursor-todo-selection-as-state-change}.
3299 @cindex sparse tree, for TODO
3302 @vindex org-todo-keywords
3303 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds the
3304 entire buffer, but shows all TODO items and the headings hierarchy above
3305 them. With a prefix argument, search for a specific TODO. You will be
3306 prompted for the keyword, and you can also give a list of keywords like
3307 @code{KWD1|KWD2|...} to list entries that match any one of these keywords.
3308 With numeric prefix argument N, show the tree for the Nth keyword in the
3309 variable @code{org-todo-keywords}. With two prefix arguments, find all TODO
3313 Show the global TODO list. Collects the TODO items from all agenda
3314 files (@pxref{Agenda Views}) into a single buffer. The new buffer will
3315 be in @code{agenda-mode}, which provides commands to examine and
3316 manipulate the TODO entries from the new buffer (@pxref{Agenda
3317 commands}). @xref{Global TODO list}, for more information.
3318 @kindex S-M-@key{RET}
3320 Insert a new TODO entry below the current one.
3324 @vindex org-todo-state-tags-triggers
3325 Changing a TODO state can also trigger tag changes. See the docstring of the
3326 option @code{org-todo-state-tags-triggers} for details.
3328 @node TODO extensions, Progress logging, TODO basics, TODO Items
3329 @section Extended use of TODO keywords
3330 @cindex extended TODO keywords
3332 @vindex org-todo-keywords
3333 By default, marked TODO entries have one of only two states: TODO and
3334 DONE. Org mode allows you to classify TODO items in more complex ways
3335 with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With
3336 special setup, the TODO keyword system can work differently in different
3339 Note that @i{tags} are another way to classify headlines in general and
3340 TODO items in particular (@pxref{Tags}).
3343 * Workflow states:: From TODO to DONE in steps
3344 * TODO types:: I do this, Fred does the rest
3345 * Multiple sets in one file:: Mixing it all, and still finding your way
3346 * Fast access to TODO states:: Single letter selection of a state
3347 * Per-file keywords:: Different files, different requirements
3348 * Faces for TODO keywords:: Highlighting states
3349 * TODO dependencies:: When one task needs to wait for others
3352 @node Workflow states, TODO types, TODO extensions, TODO extensions
3353 @subsection TODO keywords as workflow states
3354 @cindex TODO workflow
3355 @cindex workflow states as TODO keywords
3357 You can use TODO keywords to indicate different @emph{sequential} states
3358 in the process of working on an item, for example@footnote{Changing
3359 this variable only becomes effective after restarting Org mode in a
3363 (setq org-todo-keywords
3364 '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
3367 The vertical bar separates the TODO keywords (states that @emph{need
3368 action}) from the DONE states (which need @emph{no further action}). If
3369 you don't provide the separator bar, the last state is used as the DONE
3371 @cindex completion, of TODO keywords
3372 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
3373 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED. You may
3374 also use a numeric prefix argument to quickly select a specific state. For
3375 example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY.
3376 Or you can use @kbd{S-@key{left}} to go backward through the sequence. If you
3377 define many keywords, you can use in-buffer completion
3378 (@pxref{Completion}) or even a special one-key selection scheme
3379 (@pxref{Fast access to TODO states}) to insert these words into the
3380 buffer. Changing a TODO state can be logged with a timestamp, see
3381 @ref{Tracking TODO state changes}, for more information.
3383 @node TODO types, Multiple sets in one file, Workflow states, TODO extensions
3384 @subsection TODO keywords as types
3386 @cindex names as TODO keywords
3387 @cindex types as TODO keywords
3389 The second possibility is to use TODO keywords to indicate different
3390 @emph{types} of action items. For example, you might want to indicate
3391 that items are for ``work'' or ``home''. Or, when you work with several
3392 people on a single project, you might want to assign action items
3393 directly to persons, by using their names as TODO keywords. This would
3394 be set up like this:
3397 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
3400 In this case, different keywords do not indicate a sequence, but rather
3401 different types. So the normal work flow would be to assign a task to a
3402 person, and later to mark it DONE. Org mode supports this style by adapting
3403 the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
3404 @kbd{t} command in the timeline and agenda buffers.}. When used several
3405 times in succession, it will still cycle through all names, in order to first
3406 select the right type for a task. But when you return to the item after some
3407 time and execute @kbd{C-c C-t} again, it will switch from any name directly
3408 to DONE. Use prefix arguments or completion to quickly select a specific
3409 name. You can also review the items of a specific TODO type in a sparse tree
3410 by using a numeric prefix to @kbd{C-c C-v}. For example, to see all things
3411 Lucy has to do, you would use @kbd{C-3 C-c C-v}. To collect Lucy's items
3412 from all agenda files into a single buffer, you would use the numeric prefix
3413 argument as well when creating the global TODO list: @kbd{C-3 C-c t}.
3415 @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions
3416 @subsection Multiple keyword sets in one file
3417 @cindex TODO keyword sets
3419 Sometimes you may want to use different sets of TODO keywords in
3420 parallel. For example, you may want to have the basic
3421 @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
3422 separate state indicating that an item has been canceled (so it is not
3423 DONE, but also does not require action). Your setup would then look
3427 (setq org-todo-keywords
3428 '((sequence "TODO" "|" "DONE")
3429 (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
3430 (sequence "|" "CANCELED")))
3433 The keywords should all be different, this helps Org mode to keep track
3434 of which subsequence should be used for a given entry. In this setup,
3435 @kbd{C-c C-t} only operates within a subsequence, so it switches from
3436 @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
3437 (nothing) to @code{REPORT}. Therefore you need a mechanism to initially
3438 select the correct sequence. Besides the obvious ways like typing a
3439 keyword or using completion, you may also apply the following commands:
3442 @kindex C-S-@key{right}
3443 @kindex C-S-@key{left}
3444 @kindex C-u C-u C-c C-t
3445 @item C-u C-u C-c C-t
3446 @itemx C-S-@key{right}
3447 @itemx C-S-@key{left}
3448 These keys jump from one TODO subset to the next. In the above example,
3449 @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{right}} would jump from @code{TODO} or
3450 @code{DONE} to @code{REPORT}, and any of the words in the second row to
3451 @code{CANCELED}. Note that the @kbd{C-S-} key binding conflict with
3452 @code{shift-selection-mode} (@pxref{Conflicts}).
3453 @kindex S-@key{right}
3454 @kindex S-@key{left}
3457 @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through @emph{all}
3458 keywords from all sets, so for example @kbd{S-@key{<right>}} would switch
3459 from @code{DONE} to @code{REPORT} in the example above. See also
3460 @ref{Conflicts}, for a discussion of the interaction with
3461 @code{shift-selection-mode}.
3464 @node Fast access to TODO states, Per-file keywords, Multiple sets in one file, TODO extensions
3465 @subsection Fast access to TODO states
3467 If you would like to quickly change an entry to an arbitrary TODO state
3468 instead of cycling through the states, you can set up keys for
3469 single-letter access to the states. This is done by adding the section
3470 key after each keyword, in parentheses. For example:
3473 (setq org-todo-keywords
3474 '((sequence "TODO(t)" "|" "DONE(d)")
3475 (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
3476 (sequence "|" "CANCELED(c)")))
3479 @vindex org-fast-tag-selection-include-todo
3480 If you then press @code{C-c C-t} followed by the selection key, the entry
3481 will be switched to this state. @key{SPC} can be used to remove any TODO
3482 keyword from an entry.@footnote{Check also the variable
3483 @code{org-fast-tag-selection-include-todo}, it allows you to change the TODO
3484 state through the tags interface (@pxref{Setting tags}), in case you like to
3485 mingle the two concepts. Note that this means you need to come up with
3486 unique keys across both sets of keywords.}
3488 @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions
3489 @subsection Setting up keywords for individual files
3490 @cindex keyword options
3491 @cindex per-file keywords
3496 It can be very useful to use different aspects of the TODO mechanism in
3497 different files. For file-local settings, you need to add special lines
3498 to the file which set the keywords and interpretation for that file
3499 only. For example, to set one of the two examples discussed above, you
3500 need one of the following lines, starting in column zero anywhere in the
3504 #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
3506 @noindent (you may also write @code{#+SEQ_TODO} to be explicit about the
3507 interpretation, but it means the same as @code{#+TODO}), or
3509 #+TYP_TODO: Fred Sara Lucy Mike | DONE
3512 A setup for using several sets in parallel would be:
3516 #+TODO: REPORT BUG KNOWNCAUSE | FIXED
3520 @cindex completion, of option keywords
3522 @noindent To make sure you are using the correct keyword, type
3523 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
3525 @cindex DONE, final TODO keyword
3526 Remember that the keywords after the vertical bar (or the last keyword
3527 if no bar is there) must always mean that the item is DONE (although you
3528 may use a different word). After changing one of these lines, use
3529 @kbd{C-c C-c} with the cursor still in the line to make the changes
3530 known to Org mode@footnote{Org mode parses these lines only when
3531 Org mode is activated after visiting a file. @kbd{C-c C-c} with the
3532 cursor in a line starting with @samp{#+} is simply restarting Org mode
3533 for the current buffer.}.
3535 @node Faces for TODO keywords, TODO dependencies, Per-file keywords, TODO extensions
3536 @subsection Faces for TODO keywords
3537 @cindex faces, for TODO keywords
3539 @vindex org-todo @r{(face)}
3540 @vindex org-done @r{(face)}
3541 @vindex org-todo-keyword-faces
3542 Org mode highlights TODO keywords with special faces: @code{org-todo}
3543 for keywords indicating that an item still has to be acted upon, and
3544 @code{org-done} for keywords indicating that an item is finished. If
3545 you are using more than 2 different states, you might want to use
3546 special faces for some of them. This can be done using the variable
3547 @code{org-todo-keyword-faces}. For example:
3551 (setq org-todo-keyword-faces
3552 '(("TODO" . org-warning)
3553 ("DEFERRED" . shadow)
3554 ("CANCELED" . (:foreground "blue" :weight bold))))
3558 While using a list with face properties as shown for CANCELED
3559 @emph{should} work, this does not aways seem to be the case. If
3560 necessary, define a special face and use that.
3562 @node TODO dependencies, , Faces for TODO keywords, TODO extensions
3563 @subsection TODO dependencies
3564 @cindex TODO dependencies
3565 @cindex dependencies, of TODO states
3567 @vindex org-enforce-todo-dependencies
3568 @cindex property, ORDERED
3569 The structure of Org files (hierarchy and lists) makes it easy to define TODO
3570 dependencies. Usually, a parent TODO task should not be marked DONE until
3571 all subtasks (defined as children tasks) are marked as DONE. And sometimes
3572 there is a logical sequence to a number of (sub)tasks, so that one task
3573 cannot be acted upon before all siblings above it are done. If you customize
3574 the variable @code{org-enforce-todo-dependencies}, Org will block entries
3575 from changing state to DONE while they have children that are not DONE.
3576 Furthermore, if an entry has a property @code{ORDERED}, each of its children
3577 will be blocked until all earlier siblings are marked DONE. Here is an
3581 * TODO Blocked until (two) is done
3590 ** TODO b, needs to wait for (a)
3591 ** TODO c, needs to wait for (a) and (b)
3597 @vindex org-track-ordered-property-with-tag
3598 @cindex property, ORDERED
3599 Toggle the @code{ORDERED} property of the current entry. A property is used
3600 for this behavior because this should be local to the current entry, not
3601 inherited like a tag. However, if you would like to @i{track} the value of
3602 this property with a tag for better visibility, customize the variable
3603 @code{org-track-ordered-property-with-tag}.
3604 @kindex C-u C-u C-u C-c C-t
3605 @item C-u C-u C-u C-c C-t
3606 Change TODO state, circumventing any state blocking.
3609 @vindex org-agenda-dim-blocked-tasks
3610 If you set the variable @code{org-agenda-dim-blocked-tasks}, TODO entries
3611 that cannot be closed because of such dependencies will be shown in a dimmed
3612 font or even made invisible in agenda views (@pxref{Agenda Views}).
3614 @cindex checkboxes and TODO dependencies
3615 @vindex org-enforce-todo-dependencies
3616 You can also block changes of TODO states by looking at checkboxes
3617 (@pxref{Checkboxes}). If you set the variable
3618 @code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked
3619 checkboxes will be blocked from switching to DONE.
3621 If you need more complex dependency structures, for example dependencies
3622 between entries in different trees or files, check out the contributed
3623 module @file{org-depend.el}.
3626 @node Progress logging, Priorities, TODO extensions, TODO Items
3627 @section Progress logging
3628 @cindex progress logging
3629 @cindex logging, of progress
3631 Org mode can automatically record a timestamp and possibly a note when
3632 you mark a TODO item as DONE, or even each time you change the state of
3633 a TODO item. This system is highly configurable, settings can be on a
3634 per-keyword basis and can be localized to a file or even a subtree. For
3635 information on how to clock working time for a task, see @ref{Clocking
3639 * Closing items:: When was this entry marked DONE?
3640 * Tracking TODO state changes:: When did the status change?
3643 @node Closing items, Tracking TODO state changes, Progress logging, Progress logging
3644 @subsection Closing items
3646 The most basic logging is to keep track of @emph{when} a certain TODO
3647 item was finished. This is achieved with@footnote{The corresponding
3648 in-buffer setting is: @code{#+STARTUP: logdone}}.
3651 (setq org-log-done 'time)
3655 Then each time you turn an entry from a TODO (not-done) state into any
3656 of the DONE states, a line @samp{CLOSED: [timestamp]} will be inserted
3657 just after the headline. If you turn the entry back into a TODO item
3658 through further state cycling, that line will be removed again. If you
3659 want to record a note along with the timestamp, use@footnote{The
3660 corresponding in-buffer setting is: @code{#+STARTUP: lognotedone}}
3663 (setq org-log-done 'note)
3667 You will then be prompted for a note, and that note will be stored below
3668 the entry with a @samp{Closing Note} heading.
3670 In the timeline (@pxref{Timeline}) and in the agenda
3671 (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
3672 display the TODO items with a @samp{CLOSED} timestamp on each day,
3673 giving you an overview of what has been done.
3675 @node Tracking TODO state changes, , Closing items, Progress logging
3676 @subsection Tracking TODO state changes
3677 @cindex drawer, for state change recording
3679 @vindex org-log-states-order-reversed
3680 @vindex org-log-into-drawer
3681 @cindex property, LOG_INTO_DRAWER
3682 When TODO keywords are used as workflow states (@pxref{Workflow states}), you
3683 might want to keep track of when a state change occurred and maybe take a
3684 note about this change. You can either record just a timestamp, or a
3685 time-stamped note for a change. These records will be inserted after the
3686 headline as an itemized list, newest first@footnote{See the variable
3687 @code{org-log-states-order-reversed}}. When taking a lot of notes, you might
3688 want to get the notes out of the way into a drawer (@pxref{Drawers}).
3689 Customize the variable @code{org-log-into-drawer} to get this
3690 behavior---the recommended drawer for this is called @code{LOGBOOK}. You can
3691 also overrule the setting of this variable for a subtree by setting a
3692 @code{LOG_INTO_DRAWER} property.
3694 Since it is normally too much to record a note for every state, Org mode
3695 expects configuration on a per-keyword basis for this. This is achieved by
3696 adding special markers @samp{!} (for a timestamp) and @samp{@@} (for a note)
3697 in parentheses after each keyword. For example, with the setting
3700 (setq org-todo-keywords
3701 '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
3705 @vindex org-log-done
3706 you not only define global TODO keywords and fast access keys, but also
3707 request that a time is recorded when the entry is set to
3708 DONE@footnote{It is possible that Org mode will record two timestamps
3709 when you are using both @code{org-log-done} and state change logging.
3710 However, it will never prompt for two notes---if you have configured
3711 both, the state change recording note will take precedence and cancel
3712 the @samp{Closing Note}.}, and that a note is recorded when switching to
3713 WAIT or CANCELED. The setting for WAIT is even more special: the
3714 @samp{!} after the slash means that in addition to the note taken when
3715 entering the state, a timestamp should be recorded when @i{leaving} the
3716 WAIT state, if and only if the @i{target} state does not configure
3717 logging for entering it. So it has no effect when switching from WAIT
3718 to DONE, because DONE is configured to record a timestamp only. But
3719 when switching from WAIT back to TODO, the @samp{/!} in the WAIT
3720 setting now triggers a timestamp even though TODO has no logging
3723 You can use the exact same syntax for setting logging preferences local
3726 #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
3729 @cindex property, LOGGING
3730 In order to define logging settings that are local to a subtree or a
3731 single item, define a LOGGING property in this entry. Any non-empty
3732 LOGGING property resets all logging settings to nil. You may then turn
3733 on logging for this specific tree using STARTUP keywords like
3734 @code{lognotedone} or @code{logrepeat}, as well as adding state specific
3735 settings like @code{TODO(!)}. For example
3738 * TODO Log each state with only a time
3740 :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
3742 * TODO Only log when switching to WAIT, and when repeating
3744 :LOGGING: WAIT(@@) logrepeat
3746 * TODO No logging at all
3752 @node Priorities, Breaking down tasks, Progress logging, TODO Items
3756 If you use Org mode extensively, you may end up enough TODO items that
3757 it starts to make sense to prioritize them. Prioritizing can be done by
3758 placing a @emph{priority cookie} into the headline of a TODO item, like
3762 *** TODO [#A] Write letter to Sam Fortune
3766 By default, Org mode supports three priorities: @samp{A}, @samp{B}, and
3767 @samp{C}. @samp{A} is the highest priority. An entry without a cookie
3768 is treated as priority @samp{B}. Priorities make a difference only in
3769 the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they have
3770 no inherent meaning to Org mode.
3772 Priorities can be attached to any outline tree entries; they do not need
3778 Set the priority of the current headline. The command prompts for a
3779 priority character @samp{A}, @samp{B} or @samp{C}. When you press
3780 @key{SPC} instead, the priority cookie is removed from the headline.
3781 The priorities can also be changed ``remotely'' from the timeline and
3782 agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
3785 @kindex S-@key{down}
3788 @vindex org-priority-start-cycle-with-default
3789 Increase/decrease priority of current headline@footnote{See also the option
3790 @code{org-priority-start-cycle-with-default}.}. Note that these keys are
3791 also used to modify timestamps (@pxref{Creating timestamps}). See also
3792 @ref{Conflicts}, for a discussion of the interaction with
3793 @code{shift-selection-mode}.
3796 @vindex org-highest-priority
3797 @vindex org-lowest-priority
3798 @vindex org-default-priority
3799 You can change the range of allowed priorities by setting the variables
3800 @code{org-highest-priority}, @code{org-lowest-priority}, and
3801 @code{org-default-priority}. For an individual buffer, you may set
3802 these values (highest, lowest, default) like this (please make sure that
3803 the highest priority is earlier in the alphabet than the lowest
3806 @cindex #+PRIORITIES
3811 @node Breaking down tasks, Checkboxes, Priorities, TODO Items
3812 @section Breaking tasks down into subtasks
3813 @cindex tasks, breaking down
3814 @cindex statistics, for TODO items
3816 @vindex org-agenda-todo-list-sublevels
3817 It is often advisable to break down large tasks into smaller, manageable
3818 subtasks. You can do this by creating an outline tree below a TODO item,
3819 with detailed subtasks on the tree@footnote{To keep subtasks out of the
3820 global TODO list, see the @code{org-agenda-todo-list-sublevels}.}. To keep
3821 the overview over the fraction of subtasks that are already completed, insert
3822 either @samp{[/]} or @samp{[%]} anywhere in the headline. These cookies will
3823 be updates each time the todo status of a child changes. For example:
3826 * Organize Party [33%]
3827 ** TODO Call people [1/2]
3831 ** DONE Talk to neighbor
3834 @cindex property, COOKIE_DATA
3835 If a heading has both checkboxes and TODO children below it, the meaning of
3836 the statistics cookie become ambiguous. Set the property
3837 @code{COOKIE_DATA} to either @samp{checkbox} or @samp{todo} to resolve
3840 @vindex org-hierarchical-todo-statistics
3841 If you would like to have the statistics cookie count any TODO entries in the
3842 subtree (not just direct children), confgure the variable
3843 @code{org-hierarchical-todo-statistics}. To do this for a single subtree,
3844 include the word @samp{recursive} into the value of the @code{COOKIE_DATA}
3848 * Parent capturing statistics [2/20]
3850 :COOKIE_DATA: todo recursive
3854 If you would like a TODO entry to automatically change to DONE
3855 when all children are done, you can use the following setup:
3858 (defun org-summary-todo (n-done n-not-done)
3859 "Switch entry to DONE when all subentries are done, to TODO otherwise."
3860 (let (org-log-done org-log-states) ; turn off logging
3861 (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
3863 (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
3867 Another possibility is the use of checkboxes to identify (a hierarchy of) a
3868 large number of subtasks (@pxref{Checkboxes}).
3871 @node Checkboxes, , Breaking down tasks, TODO Items
3875 Every item in a plain list (@pxref{Plain lists}) can be made into a
3876 checkbox by starting it with the string @samp{[ ]}. This feature is
3877 similar to TODO items (@pxref{TODO Items}), but is more lightweight.
3878 Checkboxes are not included into the global TODO list, so they are often
3879 great to split a task into a number of simple steps. Or you can use
3880 them in a shopping list. To toggle a checkbox, use @kbd{C-c C-c}, or
3881 use the mouse (thanks to Piotr Zielinski's @file{org-mouse.el}).
3883 Here is an example of a checkbox list.
3886 * TODO Organize party [2/4]
3887 - [-] call people [1/3]
3892 - [ ] think about what music to play
3893 - [X] talk to the neighbors
3896 Checkboxes work hierarchically, so if a checkbox item has children that
3897 are checkboxes, toggling one of the children checkboxes will make the
3898 parent checkbox reflect if none, some, or all of the children are
3901 @cindex statistics, for checkboxes
3902 @cindex checkbox statistics
3903 @cindex property, COOKIE_DATA
3904 @vindex org-hierarchical-checkbox-statistics
3905 The @samp{[2/4]} and @samp{[1/3]} in the first and second line are cookies
3906 indicating how many checkboxes present in this entry have been checked off,
3907 and the total number of checkboxes present. This can give you an idea on how
3908 many checkboxes remain, even without opening a folded entry. The cookies can
3909 be placed into a headline or into (the first line of) a plain list item.
3910 Each cookie covers checkboxes of direct children structurally below the
3911 headline/item on which the cookie appears@footnote{Set the variable
3912 @code{org-hierarchical-checkbox-statistics} if you want such cookies to
3913 represent the all checkboxes below the cookie, not just the direct
3914 children.}. You have to insert the cookie yourself by typing either
3915 @samp{[/]} or @samp{[%]}. With @samp{[/]} you get an @samp{n out of m}
3916 result, as in the examples above. With @samp{[%]} you get information about
3917 the percentage of checkboxes checked (in the above example, this would be
3918 @samp{[50%]} and @samp{[33%]}, respectively). In a headline, a cookie can
3919 count either checkboxes below the heading or TODO states of children, and it
3920 will display whatever was changed last. Set the property @code{COOKIE_DATA}
3921 to either @samp{checkbox} or @samp{todo} to resolve this issue.
3923 @cindex blocking, of checkboxes
3924 @cindex checkbox blocking
3925 @cindex property, ORDERED
3926 If the current outline node has an @code{ORDERED} property, checkboxes must
3927 be checked off in sequence, and an error will be thrown if you try to check
3928 off a box while there are unchecked boxes above it.
3930 @noindent The following commands work with checkboxes:
3935 Toggle checkbox status or (with prefix arg) checkbox presence at point. With
3936 double prefix argument, set it to @samp{[-]}, which is considered to be an
3940 Toggle checkbox status or (with prefix arg) checkbox presence at point. With
3941 double prefix argument, set it to @samp{[-]}, which is considered to be an
3945 If there is an active region, toggle the first checkbox in the region
3946 and set all remaining boxes to the same status as the first. With a prefix
3947 arg, add or remove the checkbox for all items in the region.
3949 If the cursor is in a headline, toggle checkboxes in the region between
3950 this headline and the next (so @emph{not} the entire subtree).
3952 If there is no active region, just toggle the checkbox at point.
3954 @kindex M-S-@key{RET}
3956 Insert a new item with a checkbox.
3957 This works only if the cursor is already in a plain list item
3958 (@pxref{Plain lists}).
3961 @vindex org-track-ordered-property-with-tag
3962 @cindex property, ORDERED
3963 Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
3964 be checked off in sequence. A property is used for this behavior because
3965 this should be local to the current entry, not inherited like a tag.
3966 However, if you would like to @i{track} the value of this property with a tag
3967 for better visibility, customize the variable
3968 @code{org-track-ordered-property-with-tag}.
3971 Update the checkbox statistics in the current outline entry. When
3972 called with a @kbd{C-u} prefix, update the entire file. Checkbox
3973 statistic cookies are updated automatically if you toggle checkboxes
3974 with @kbd{C-c C-c} and make new ones with @kbd{M-S-@key{RET}}. If you
3975 delete boxes or add/change them by hand, use this command to get things
3976 back into sync. Or simply toggle any checkbox twice with @kbd{C-c C-c}.
3979 @node Tags, Properties and Columns, TODO Items, Top
3982 @cindex headline tagging
3983 @cindex matching, tags
3984 @cindex sparse tree, tag based
3986 An excellent way to implement labels and contexts for cross-correlating
3987 information is to assign @i{tags} to headlines. Org mode has extensive
3990 @vindex org-tag-faces
3991 Every headline can contain a list of tags; they occur at the end of the
3992 headline. Tags are normal words containing letters, numbers, @samp{_}, and
3993 @samp{@@}. Tags must be preceded and followed by a single colon, @eg{},
3994 @samp{:work:}. Several tags can be specified, as in @samp{:work:urgent:}.
3995 Tags will by default be in bold face with the same color as the headline.
3996 You may specify special faces for specific tags using the variable
3997 @code{org-tag-faces}, in much the same way as you can for TODO keywords
3998 (@pxref{Faces for TODO keywords}).
4001 * Tag inheritance:: Tags use the tree structure of the outline
4002 * Setting tags:: How to assign tags to a headline
4003 * Tag searches:: Searching for combinations of tags
4006 @node Tag inheritance, Setting tags, Tags, Tags
4007 @section Tag inheritance
4008 @cindex tag inheritance
4009 @cindex inheritance, of tags
4010 @cindex sublevels, inclusion into tags match
4012 @i{Tags} make use of the hierarchical structure of outline trees. If a
4013 heading has a certain tag, all subheadings will inherit the tag as
4014 well. For example, in the list
4017 * Meeting with the French group :work:
4018 ** Summary by Frank :boss:notes:
4019 *** TODO Prepare slides for him :action:
4023 the final heading will have the tags @samp{:work:}, @samp{:boss:},
4024 @samp{:notes:}, and @samp{:action:} even though the final heading is not
4025 explicitly marked with those tags. You can also set tags that all entries in
4026 a file should inherit just as if these tags were defined in a hypothetical
4027 level zero that surrounds the entire file.
4031 #+FILETAGS: :Peter:Boss:Secret:
4035 @vindex org-use-tag-inheritance
4036 @vindex org-tags-exclude-from-inheritance
4037 To limit tag inheritance to specific tags, or to turn it off entirely, use
4038 the variables @code{org-use-tag-inheritance} and
4039 @code{org-tags-exclude-from-inheritance}.
4041 @vindex org-tags-match-list-sublevels
4042 When a headline matches during a tags search while tag inheritance is turned
4043 on, all the sublevels in the same tree will (for a simple match form) match
4044 as well@footnote{This is only true if the search does not involve more
4045 complex tests including properties (@pxref{Property searches}).}. The list
4046 of matches may then become very long. If you only want to see the first tags
4047 match in a subtree, configure the variable
4048 @code{org-tags-match-list-sublevels} (not recommended).
4050 @node Setting tags, Tag searches, Tag inheritance, Tags
4051 @section Setting tags
4052 @cindex setting tags
4053 @cindex tags, setting
4056 Tags can simply be typed into the buffer at the end of a headline.
4057 After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is
4058 also a special command for inserting tags:
4063 @cindex completion, of tags
4064 @vindex org-tags-column
4065 Enter new tags for the current headline. Org mode will either offer
4066 completion or a special single-key interface for setting tags, see
4067 below. After pressing @key{RET}, the tags will be inserted and aligned
4068 to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all
4069 tags in the current buffer will be aligned to that column, just to make
4070 things look nice. TAGS are automatically realigned after promotion,
4071 demotion, and TODO state changes (@pxref{TODO basics}).
4074 When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
4077 @vindex org-tag-alist
4078 Org will support tag insertion based on a @emph{list of tags}. By
4079 default this list is constructed dynamically, containing all tags
4080 currently used in the buffer. You may also globally specify a hard list
4081 of tags with the variable @code{org-tag-alist}. Finally you can set
4082 the default tags for a given file with lines like
4086 #+TAGS: @@work @@home @@tennisclub
4087 #+TAGS: laptop car pc sailboat
4090 If you have globally defined your preferred set of tags using the
4091 variable @code{org-tag-alist}, but would like to use a dynamic tag list
4092 in a specific file, add an empty TAGS option line to that file:
4098 @vindex org-tag-persistent-alist
4099 If you have a preferred set of tags that you would like to use in every file,
4100 in addition to those defined on a per-file basis by TAGS option lines, then
4101 you may specify a list of tags with the variable
4102 @code{org-tag-persistent-alist}. You may turn this off on a per-file basis
4103 by adding a STARTUP option line to that file:
4109 By default Org mode uses the standard minibuffer completion facilities for
4110 entering tags. However, it also implements another, quicker, tag selection
4111 method called @emph{fast tag selection}. This allows you to select and
4112 deselect tags with just a single key press. For this to work well you should
4113 assign unique letters to most of your commonly used tags. You can do this
4114 globally by configuring the variable @code{org-tag-alist} in your
4115 @file{.emacs} file. For example, you may find the need to tag many items in
4116 different files with @samp{:@@home:}. In this case you can set something
4120 (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
4123 @noindent If the tag is only relevant to the file you are working on, then you
4124 can instead set the TAGS option line as:
4127 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p)
4130 @noindent The tags interface will show the available tags in a splash
4131 window. If you want to start a new line after a specific tag, insert
4132 @samp{\n} into the tag list
4135 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) \n laptop(l) pc(p)
4138 @noindent or write them in two lines:
4141 #+TAGS: @@work(w) @@home(h) @@tennisclub(t)
4142 #+TAGS: laptop(l) pc(p)
4146 You can also group together tags that are mutually exclusive by using
4150 #+TAGS: @{ @@work(w) @@home(h) @@tennisclub(t) @} laptop(l) pc(p)
4153 @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
4154 and @samp{@@tennisclub} should be selected. Multiple such groups are allowed.
4156 @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
4157 these lines to activate any changes.
4160 To set these mutually exclusive groups in the variable @code{org-tags-alist},
4161 you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
4162 of the braces. Similarly, you can use @code{:newline} to indicate a line
4163 break. The previous example would be set globally by the following
4167 (setq org-tag-alist '((:startgroup . nil)
4168 ("@@work" . ?w) ("@@home" . ?h)
4169 ("@@tennisclub" . ?t)
4171 ("laptop" . ?l) ("pc" . ?p)))
4174 If at least one tag has a selection key then pressing @kbd{C-c C-c} will
4175 automatically present you with a special interface, listing inherited tags,
4176 the tags of the current headline, and a list of all valid tags with
4177 corresponding keys@footnote{Keys will automatically be assigned to tags which
4178 have no configured keys.}. In this interface, you can use the following
4183 Pressing keys assigned to tags will add or remove them from the list of
4184 tags in the current line. Selecting a tag in a group of mutually
4185 exclusive tags will turn off any other tags from that group.
4188 Enter a tag in the minibuffer, even if the tag is not in the predefined
4189 list. You will be able to complete on all tags present in the buffer.
4192 Clear all tags for this line.
4195 Accept the modified set.
4197 Abort without installing changes.
4199 If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
4201 Turn off groups of mutually exclusive tags. Use this to (as an
4202 exception) assign several tags from such a group.
4204 Toggle auto-exit after the next change (see below).
4205 If you are using expert mode, the first @kbd{C-c} will display the
4210 This method lets you assign tags to a headline with very few keys. With
4211 the above setup, you could clear the current tags and set @samp{@@home},
4212 @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
4213 C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@home} to
4214 @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
4215 alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag
4216 @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
4217 @key{RET} @key{RET}}.
4219 @vindex org-fast-tag-selection-single-key
4220 If you find that most of the time you need only a single key press to
4221 modify your list of tags, set the variable
4222 @code{org-fast-tag-selection-single-key}. Then you no longer have to
4223 press @key{RET} to exit fast tag selection---it will immediately exit
4224 after the first change. If you then occasionally need more keys, press
4225 @kbd{C-c} to turn off auto-exit for the current tag selection process
4226 (in effect: start selection with @kbd{C-c C-c C-c} instead of @kbd{C-c
4227 C-c}). If you set the variable to the value @code{expert}, the special
4228 window is not even shown for single-key tag selection, it comes up only
4229 when you press an extra @kbd{C-c}.
4231 @node Tag searches, , Setting tags, Tags
4232 @section Tag searches
4233 @cindex tag searches
4234 @cindex searching for tags
4236 Once a system of tags has been set up, it can be used to collect related
4237 information into special lists.
4244 Create a sparse tree with all headlines matching a tags search. With a
4245 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
4248 Create a global list of tag matches from all agenda files.
4249 @xref{Matching tags and properties}.
4252 @vindex org-tags-match-list-sublevels
4253 Create a global list of tag matches from all agenda files, but check
4254 only TODO items and force checking subitems (see variable
4255 @code{org-tags-match-list-sublevels}).
4258 These commands all prompt for a match string which allows basic Boolean logic
4259 like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and
4260 @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries
4261 which are tagged, like @samp{Kathy} or @samp{Sally}. The full syntax of the search
4262 string is rich and allows also matching against TODO keywords, entry levels
4263 and properties. For a complete description with many examples, see
4264 @ref{Matching tags and properties}.
4267 @node Properties and Columns, Dates and Times, Tags, Top
4268 @chapter Properties and Columns
4271 Properties are a set of key-value pairs associated with an entry. There
4272 are two main applications for properties in Org mode. First, properties
4273 are like tags, but with a value. Second, you can use properties to
4274 implement (very basic) database capabilities in an Org buffer. For
4275 an example of the first application, imagine maintaining a file where
4276 you document bugs and plan releases for a piece of software. Instead of
4277 using tags like @code{:release_1:}, @code{:release_2:}, one can use a
4278 property, say @code{:Release:}, that in different subtrees has different
4279 values, such as @code{1.0} or @code{2.0}. For an example of the second
4280 application of properties, imagine keeping track of your music CDs,
4281 where properties could be things such as the album, artist, date of
4282 release, number of tracks, and so on.
4284 Properties can be conveniently edited and viewed in column view
4285 (@pxref{Column view}).
4288 * Property syntax:: How properties are spelled out
4289 * Special properties:: Access to other Org mode features
4290 * Property searches:: Matching property values
4291 * Property inheritance:: Passing values down the tree
4292 * Column view:: Tabular viewing and editing
4293 * Property API:: Properties for Lisp programmers
4296 @node Property syntax, Special properties, Properties and Columns, Properties and Columns
4297 @section Property syntax
4298 @cindex property syntax
4299 @cindex drawer, for properties
4301 Properties are key-value pairs. They need to be inserted into a special
4302 drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property
4303 is specified on a single line, with the key (surrounded by colons)
4304 first, and the value after it. Here is an example:
4309 *** Goldberg Variations
4311 :Title: Goldberg Variations
4312 :Composer: J.S. Bach
4314 :Publisher: Deutsche Grammophon
4319 You may define the allowed values for a particular property @samp{:Xyz:}
4320 by setting a property @samp{:Xyz_ALL:}. This special property is
4321 @emph{inherited}, so if you set it in a level 1 entry, it will apply to
4322 the entire tree. When allowed values are defined, setting the
4323 corresponding property becomes easier and is less prone to typing
4324 errors. For the example with the CD collection, we can predefine
4325 publishers and the number of disks in a box like this:
4330 :NDisks_ALL: 1 2 3 4
4331 :Publisher_ALL: "Deutsche Grammophon" Philips EMI
4335 If you want to set properties that can be inherited by any entry in a
4336 file, use a line like
4337 @cindex property, _ALL
4340 #+PROPERTY: NDisks_ALL 1 2 3 4
4343 @vindex org-global-properties
4344 Property values set with the global variable
4345 @code{org-global-properties} can be inherited by all entries in all
4349 The following commands help to work with properties:
4354 After an initial colon in a line, complete property keys. All keys used
4355 in the current file will be offered as possible completions.
4358 Set a property. This prompts for a property name and a value. If
4359 necessary, the property drawer is created as well.
4360 @item M-x org-insert-property-drawer
4361 Insert a property drawer into the current entry. The drawer will be
4362 inserted early in the entry, but after the lines with planning
4363 information like deadlines.
4366 With the cursor in a property drawer, this executes property commands.
4368 Set a property in the current entry. Both the property and the value
4369 can be inserted using completion.
4370 @kindex S-@key{right}
4371 @kindex S-@key{left}
4372 @item S-@key{left}/@key{right}
4373 Switch property at point to the next/previous allowed value.
4375 Remove a property from the current entry.
4377 Globally remove a property, from all entries in the current file.
4379 Compute the property at point, using the operator and scope from the
4380 nearest column format definition.
4383 @node Special properties, Property searches, Property syntax, Properties and Columns
4384 @section Special properties
4385 @cindex properties, special
4387 Special properties provide an alternative access method to Org mode
4388 features, like the TODO state or the priority of an entry, discussed in the
4389 previous chapters. This interface exists so that you can include
4390 these states in a column view (@pxref{Column view}), or to use them in
4391 queries. The following property names are special and should not be
4392 used as keys in the properties drawer:
4394 @cindex property, special, TODO
4395 @cindex property, special, TAGS
4396 @cindex property, special, ALLTAGS
4397 @cindex property, special, CATEGORY
4398 @cindex property, special, PRIORITY
4399 @cindex property, special, DEADLINE
4400 @cindex property, special, SCHEDULED
4401 @cindex property, special, CLOSED
4402 @cindex property, special, TIMESTAMP
4403 @cindex property, special, TIMESTAMP_IA
4404 @cindex property, special, CLOCKSUM
4405 @c guessing that ITEM is needed in this area; also, should this list be sorted?
4406 @cindex property, special, ITEM
4408 TODO @r{The TODO keyword of the entry.}
4409 TAGS @r{The tags defined directly in the headline.}
4410 ALLTAGS @r{All tags, including inherited ones.}
4411 CATEGORY @r{The category of an entry.}
4412 PRIORITY @r{The priority of the entry, a string with a single letter.}
4413 DEADLINE @r{The deadline time string, without the angular brackets.}
4414 SCHEDULED @r{The scheduling timestamp, without the angular brackets.}
4415 CLOSED @r{When was this entry closed?}
4416 TIMESTAMP @r{The first keyword-less timestamp in the entry.}
4417 TIMESTAMP_IA @r{The first inactive timestamp in the entry.}
4418 CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}}
4419 @r{must be run first to compute the values.}
4420 ITEM @r{The content of the entry.}
4423 @node Property searches, Property inheritance, Special properties, Properties and Columns
4424 @section Property searches
4425 @cindex properties, searching
4426 @cindex searching, of properties
4428 To create sparse trees and special lists with selection based on properties,
4429 the same commands are used as for tag searches (@pxref{Tag searches}).
4435 Create a sparse tree with all matching entries. With a
4436 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
4439 Create a global list of tag/property matches from all agenda files.
4440 @xref{Matching tags and properties}.
4443 @vindex org-tags-match-list-sublevels
4444 Create a global list of tag matches from all agenda files, but check
4445 only TODO items and force checking of subitems (see variable
4446 @code{org-tags-match-list-sublevels}).
4449 The syntax for the search string is described in @ref{Matching tags and
4452 There is also a special command for creating sparse trees based on a
4458 Create a sparse tree based on the value of a property. This first
4459 prompts for the name of a property, and then for a value. A sparse tree
4460 is created with all entries that define this property with the given
4461 value. If you enclose the value into curly braces, it is interpreted as
4462 a regular expression and matched against the property values.
4465 @node Property inheritance, Column view, Property searches, Properties and Columns
4466 @section Property Inheritance
4467 @cindex properties, inheritance
4468 @cindex inheritance, of properties
4470 @vindex org-use-property-inheritance
4471 The outline structure of Org-mode documents lends itself for an
4472 inheritance model of properties: if the parent in a tree has a certain
4473 property, the children can inherit this property. Org mode does not
4474 turn this on by default, because it can slow down property searches
4475 significantly and is often not needed. However, if you find inheritance
4476 useful, you can turn it on by setting the variable
4477 @code{org-use-property-inheritance}. It may be set to @code{t} to make
4478 all properties inherited from the parent, to a list of properties
4479 that should be inherited, or to a regular expression that matches
4480 inherited properties.
4482 Org mode has a few properties for which inheritance is hard-coded, at
4483 least for the special applications for which they are used:
4485 @cindex property, COLUMNS
4488 The @code{:COLUMNS:} property defines the format of column view
4489 (@pxref{Column view}). It is inherited in the sense that the level
4490 where a @code{:COLUMNS:} property is defined is used as the starting
4491 point for a column view table, independently of the location in the
4492 subtree from where columns view is turned on.
4494 @cindex property, CATEGORY
4495 For agenda view, a category set through a @code{:CATEGORY:} property
4496 applies to the entire subtree.
4498 @cindex property, ARCHIVE
4499 For archiving, the @code{:ARCHIVE:} property may define the archive
4500 location for the entire subtree (@pxref{Moving subtrees}).
4502 @cindex property, LOGGING
4503 The LOGGING property may define logging settings for an entry or a
4504 subtree (@pxref{Tracking TODO state changes}).
4507 @node Column view, Property API, Property inheritance, Properties and Columns
4508 @section Column view
4510 A great way to view and edit properties in an outline tree is
4511 @emph{column view}. In column view, each outline node is turned into a
4512 table row. Columns in this table provide access to properties of the
4513 entries. Org mode implements columns by overlaying a tabular structure
4514 over the headline of each item. While the headlines have been turned
4515 into a table row, you can still change the visibility of the outline
4516 tree. For example, you get a compact table by switching to CONTENTS
4517 view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
4518 is active), but you can still open, read, and edit the entry below each
4519 headline. Or, you can switch to column view after executing a sparse
4520 tree command and in this way get a table only for the selected items.
4521 Column view also works in agenda buffers (@pxref{Agenda Views}) where
4522 queries have collected selected items, possibly from a number of files.
4525 * Defining columns:: The COLUMNS format property
4526 * Using column view:: How to create and use column view
4527 * Capturing column view:: A dynamic block for column view
4530 @node Defining columns, Using column view, Column view, Column view
4531 @subsection Defining columns
4532 @cindex column view, for properties
4533 @cindex properties, column view
4535 Setting up a column view first requires defining the columns. This is
4536 done by defining a column format line.
4539 * Scope of column definitions:: Where defined, where valid?
4540 * Column attributes:: Appearance and content of a column
4543 @node Scope of column definitions, Column attributes, Defining columns, Defining columns
4544 @subsubsection Scope of column definitions
4546 To define a column format for an entire file, use a line like
4550 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
4553 To specify a format that only applies to a specific tree, add a
4554 @code{:COLUMNS:} property to the top node of that tree, for example:
4557 ** Top node for columns view
4559 :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
4563 If a @code{:COLUMNS:} property is present in an entry, it defines columns
4564 for the entry itself, and for the entire subtree below it. Since the
4565 column definition is part of the hierarchical structure of the document,
4566 you can define columns on level 1 that are general enough for all
4567 sublevels, and more specific columns further down, when you edit a
4568 deeper part of the tree.
4570 @node Column attributes, , Scope of column definitions, Defining columns
4571 @subsubsection Column attributes
4572 A column definition sets the attributes of a column. The general
4573 definition looks like this:
4576 %[@var{width}]@var{property}[(@var{title})][@{@var{summary-type}@}]
4580 Except for the percent sign and the property name, all items are
4581 optional. The individual parts have the following meaning:
4584 @var{width} @r{An integer specifying the width of the column in characters.}
4585 @r{If omitted, the width will be determined automatically.}
4586 @var{property} @r{The property that should be edited in this column.}
4587 (title) @r{The header text for the column. If omitted, the}
4588 @r{property name is used.}
4589 @{@var{summary-type}@} @r{The summary type. If specified, the column values for}
4590 @r{parent nodes are computed from the children.}
4591 @r{Supported summary types are:}
4592 @{+@} @r{Sum numbers in this column.}
4593 @{+;%.1f@} @r{Like @samp{+}, but format result with @samp{%.1f}.}
4594 @{$@} @r{Currency, short for @samp{+;%.2f}.}
4595 @{:@} @r{Sum times, HH:MM:SS, plain numbers are hours.}
4596 @{X@} @r{Checkbox status, @samp{[X]} if all children are @samp{[X]}.}
4597 @{X/@} @r{Checkbox status, @samp{[n/m]}.}
4598 @{X%@} @r{Checkbox status, @samp{[n%]}.}
4599 @{min@} @r{Smallest number in column.}
4600 @{max@} @r{Largest number.}
4601 @{mean@} @r{Arithmetic mean of numbers.}
4602 @{:min@} @r{Smallest time value in column.}
4603 @{:max@} @r{Largest time value.}
4604 @{:mean@} @r{Arithmetic mean of time values.}
4608 Here is an example for a complete columns definition, along with allowed
4612 :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.}
4613 %10Time_Estimate@{:@} %CLOCKSUM
4614 :Owner_ALL: Tammy Mark Karl Lisa Don
4615 :Status_ALL: "In progress" "Not started yet" "Finished" ""
4616 :Approved_ALL: "[ ]" "[X]"
4620 The first column, @samp{%25ITEM}, means the first 25 characters of the
4621 item itself, @ie of the headline. You probably always should start the
4622 column definition with the @samp{ITEM} specifier. The other specifiers
4623 create columns @samp{Owner} with a list of names as allowed values, for
4624 @samp{Status} with four different possible values, and for a checkbox
4625 field @samp{Approved}. When no width is given after the @samp{%}
4626 character, the column will be exactly as wide as it needs to be in order
4627 to fully display all values. The @samp{Approved} column does have a
4628 modified title (@samp{Approved?}, with a question mark). Summaries will
4629 be created for the @samp{Time_Estimate} column by adding time duration
4630 expressions like HH:MM, and for the @samp{Approved} column, by providing
4631 an @samp{[X]} status if all children have been checked. The
4632 @samp{CLOCKSUM} column is special, it lists the sum of CLOCK intervals
4635 @node Using column view, Capturing column view, Defining columns, Column view
4636 @subsection Using column view
4639 @tsubheading{Turning column view on and off}
4642 @vindex org-columns-default-format
4643 Turn on column view. If the cursor is before the first headline in the file,
4644 column view is turned on for the entire file, using the @code{#+COLUMNS}
4645 definition. If the cusor is somewhere inside the outline, this command
4646 searches the hierarchy, up from point, for a @code{:COLUMNS:} property that
4647 defines a format. When one is found, the column view table is established
4648 for the tree starting at the entry that contains the @code{:COLUMNS:}
4649 property. If no such property is found, the format is taken from the
4650 @code{#+COLUMNS} line or from the variable @code{org-columns-default-format},
4651 and column view is established for the current entry and its subtree.
4654 Recreate the column view, to include recent changes made in the buffer.
4661 @tsubheading{Editing values}
4662 @item @key{left} @key{right} @key{up} @key{down}
4663 Move through the column view from field to field.
4664 @kindex S-@key{left}
4665 @kindex S-@key{right}
4666 @item S-@key{left}/@key{right}
4667 Switch to the next/previous allowed value of the field. For this, you
4668 have to have specified allowed values for a property.
4670 Directly select the nth allowed value, @kbd{0} selects the 10th value.
4674 Same as @kbd{S-@key{left}/@key{right}}
4677 Edit the property at point. For the special properties, this will
4678 invoke the same interface that you normally use to change that
4679 property. For example, when editing a TAGS property, the tag completion
4680 or fast selection interface will pop up.
4683 When there is a checkbox at point, toggle it.
4686 View the full value of this property. This is useful if the width of
4687 the column is smaller than that of the value.
4690 Edit the list of allowed values for this property. If the list is found
4691 in the hierarchy, the modified values is stored there. If no list is
4692 found, the new value is stored in the first entry that is part of the
4693 current column view.
4694 @tsubheading{Modifying the table structure}
4698 Make the column narrower/wider by one character.
4699 @kindex S-M-@key{right}
4700 @item S-M-@key{right}
4701 Insert a new column, to the left of the current column.
4702 @kindex S-M-@key{left}
4703 @item S-M-@key{left}
4704 Delete the current column.
4707 @node Capturing column view, , Using column view, Column view
4708 @subsection Capturing column view
4710 Since column view is just an overlay over a buffer, it cannot be
4711 exported or printed directly. If you want to capture a column view, use
4712 a @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame
4713 of this block looks like this:
4715 @cindex #+BEGIN, columnview
4718 #+BEGIN: columnview :hlines 1 :id "label"
4723 @noindent This dynamic block has the following parameters:
4727 This is the most important parameter. Column view is a feature that is
4728 often localized to a certain (sub)tree, and the capture block might be
4729 at a different location in the file. To identify the tree whose view to
4730 capture, you can use 4 values:
4731 @cindex property, ID
4733 local @r{use the tree in which the capture block is located}
4734 global @r{make a global view, including all headings in the file}
4735 "file:@var{path-to-file}"
4736 @r{run column view at the top of this file}
4737 "@var{ID}" @r{call column view in the tree that has an @code{:ID:}}
4738 @r{property with the value @i{label}. You can use}
4739 @r{@kbd{M-x org-id-copy} to create a globally unique ID for}
4740 @r{the current entry and copy it to the kill-ring.}
4743 When @code{t}, insert an hline after every line. When a number @var{N}, insert
4744 an hline before each headline with level @code{<= @var{N}}.
4746 When set to @code{t}, force column groups to get vertical lines.
4748 When set to a number, don't capture entries below this level.
4749 @item :skip-empty-rows
4750 When set to @code{t}, skip rows where the only non-empty specifier of the
4751 column view is @code{ITEM}.
4756 The following commands insert or update the dynamic block:
4761 Insert a dynamic block capturing a column view. You will be prompted
4762 for the scope or ID of the view.
4767 Update dynamic block at point. The cursor needs to be in the
4768 @code{#+BEGIN} line of the dynamic block.
4769 @kindex C-u C-c C-x C-u
4770 @item C-u C-c C-x C-u
4771 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
4772 you have several clock table blocks in a buffer.
4775 You can add formulas to the column view table and you may add plotting
4776 instructions in front of the table---these will survive an update of the
4777 block. If there is a @code{#+TBLFM:} after the table, the table will
4778 actually be recalculated automatically after an update.
4780 An alternative way to capture and process property values into a table is
4781 provided by Eric Schulte's @file{org-collector.el} which is a contributed
4782 package@footnote{Contributed packages are not part of Emacs, but are
4783 distributed with the main distribution of Org (visit
4784 @uref{http://orgmode.org}).}. It provides a general API to collect
4785 properties from entries in a certain scope, and arbitrary Lisp expressions to
4786 process these values before inserting them into a table or a dynamic block.
4788 @node Property API, , Column view, Properties and Columns
4789 @section The Property API
4790 @cindex properties, API
4791 @cindex API, for properties
4793 There is a full API for accessing and changing properties. This API can
4794 be used by Emacs Lisp programs to work with properties and to implement
4795 features based on them. For more information see @ref{Using the
4798 @node Dates and Times, Capture, Properties and Columns, Top
4799 @chapter Dates and Times
4805 To assist project planning, TODO items can be labeled with a date and/or
4806 a time. The specially formatted string carrying the date and time
4807 information is called a @emph{timestamp} in Org mode. This may be a
4808 little confusing because timestamp is often used as indicating when
4809 something was created or last changed. However, in Org mode this term
4810 is used in a much wider sense.
4813 * Timestamps:: Assigning a time to a tree entry
4814 * Creating timestamps:: Commands which insert timestamps
4815 * Deadlines and scheduling:: Planning your work
4816 * Clocking work time:: Tracking how long you spend on a task
4817 * Effort estimates:: Planning work effort in advance
4818 * Relative timer:: Notes with a running timer
4822 @node Timestamps, Creating timestamps, Dates and Times, Dates and Times
4823 @section Timestamps, deadlines, and scheduling
4825 @cindex ranges, time
4830 A timestamp is a specification of a date (possibly with a time or a range
4831 of times) in a special format, either @samp{<2003-09-16 Tue>} or
4832 @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16 Tue
4833 12:00-12:30>}@footnote{This is the standard ISO date/time format. To
4834 use an alternative format, see @ref{Custom time format}.}. A timestamp
4835 can appear anywhere in the headline or body of an Org tree entry. Its
4836 presence causes entries to be shown on specific dates in the agenda
4837 (@pxref{Weekly/daily agenda}). We distinguish:
4840 @item Plain timestamp; Event; Appointment
4842 A simple timestamp just assigns a date/time to an item. This is just
4843 like writing down an appointment or event in a paper agenda. In the
4844 timeline and agenda displays, the headline of an entry associated with a
4845 plain timestamp will be shown exactly on that date.
4848 * Meet Peter at the movies <2006-11-01 Wed 19:15>
4849 * Discussion on climate change <2006-11-02 Thu 20:00-22:00>
4852 @item Timestamp with repeater interval
4853 @cindex timestamp, with repeater interval
4854 A timestamp may contain a @emph{repeater interval}, indicating that it
4855 applies not only on the given date, but again and again after a certain
4856 interval of N days (d), weeks (w), months (m), or years (y). The
4857 following will show up in the agenda every Wednesday:
4860 * Pick up Sam at school <2007-05-16 Wed 12:30 +1w>
4863 @item Diary-style sexp entries
4864 For more complex date specifications, Org mode supports using the
4865 special sexp diary entries implemented in the Emacs calendar/diary
4866 package. For example
4869 * The nerd meeting on every 2nd Thursday of the month
4870 <%%(diary-float t 4 2)>
4873 @item Time/Date range
4876 Two timestamps connected by @samp{--} denote a range. The headline
4877 will be shown on the first and last day of the range, and on any dates
4878 that are displayed and fall in the range. Here is an example:
4881 ** Meeting in Amsterdam
4882 <2004-08-23 Mon>--<2004-08-26 Thu>
4885 @item Inactive timestamp
4886 @cindex timestamp, inactive
4887 @cindex inactive timestamp
4888 Just like a plain timestamp, but with square brackets instead of
4889 angular ones. These timestamps are inactive in the sense that they do
4890 @emph{not} trigger an entry to show up in the agenda.
4893 * Gillian comes late for the fifth time [2006-11-01 Wed]
4898 @node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times
4899 @section Creating timestamps
4900 @cindex creating timestamps
4901 @cindex timestamps, creating
4903 For Org mode to recognize timestamps, they need to be in the specific
4904 format. All commands listed below produce timestamps in the correct
4910 Prompt for a date and insert a corresponding timestamp. When the cursor is
4911 at an existing timestamp in the buffer, the command is used to modify this
4912 timestamp instead of inserting a new one. When this command is used twice in
4913 succession, a time range is inserted.
4917 Like @kbd{C-c .}, but insert an inactive timestamp that will not cause
4924 @vindex org-time-stamp-rounding-minutes
4925 Like @kbd{C-c .} and @kbd{C-c !}, but use the alternative format which
4926 contains date and time. The default time can be rounded to multiples of 5
4927 minutes, see the option @code{org-time-stamp-rounding-minutes}.
4931 Insert a timestamp corresponding to the cursor date in the Calendar.
4935 Access the Emacs calendar for the current date. If there is a
4936 timestamp in the current line, go to the corresponding date
4941 Access the agenda for the date given by the timestamp or -range at
4942 point (@pxref{Weekly/daily agenda}).
4944 @kindex S-@key{left}
4945 @kindex S-@key{right}
4947 @itemx S-@key{right}
4948 Change date at cursor by one day. These key bindings conflict with
4949 shift-selection and related modes (@pxref{Conflicts}).
4952 @kindex S-@key{down}
4955 Change the item under the cursor in a timestamp. The cursor can be on a
4956 year, month, day, hour or minute. When the timestamp contains a time range
4957 like @samp{15:30-16:30}, modifying the first time will also shift the second,
4958 shifting the time block with constant length. To change the length, modify
4959 the second time. Note that if the cursor is in a headline and not at a
4960 timestamp, these same keys modify the priority of an item.
4961 (@pxref{Priorities}). The key bindings also conflict with shift-selection and
4962 related modes (@pxref{Conflicts}).
4965 @cindex evaluate time range
4967 Evaluate a time range by computing the difference between start and end.
4968 With a prefix argument, insert result after the time range (in a table: into
4969 the following column).
4974 * The date/time prompt:: How Org mode helps you entering date and time
4975 * Custom time format:: Making dates look different
4978 @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps
4979 @subsection The date/time prompt
4980 @cindex date, reading in minibuffer
4981 @cindex time, reading in minibuffer
4983 @vindex org-read-date-prefer-future
4984 When Org mode prompts for a date/time, the default is shown as an ISO
4985 date, and the prompt therefore seems to ask for an ISO date. But it
4986 will in fact accept any string containing some date and/or time
4987 information, and it is really smart about interpreting your input. You
4988 can, for example, use @kbd{C-y} to paste a (possibly multi-line) string
4989 copied from an email message. Org mode will find whatever information
4990 is in there and derive anything you have not specified from the
4991 @emph{default date and time}. The default is usually the current date
4992 and time, but when modifying an existing timestamp, or when entering
4993 the second stamp of a range, it is taken from the stamp in the buffer.
4994 When filling in information, Org mode assumes that most of the time you
4995 will want to enter a date in the future: if you omit the month/year and
4996 the given day/month is @i{before} today, it will assume that you mean a
4997 future date@footnote{See the variable
4998 @code{org-read-date-prefer-future}.}.
5000 For example, let's assume that today is @b{June 13, 2006}. Here is how
5001 various inputs will be interpreted, the items filled in by Org mode are
5005 3-2-5 --> 2003-02-05
5006 14 --> @b{2006}-@b{06}-14
5007 12 --> @b{2006}-@b{07}-12
5008 Fri --> nearest Friday (defaultdate or later)
5009 sep 15 --> @b{2006}-09-15
5010 feb 15 --> @b{2007}-02-15
5011 sep 12 9 --> 2009-09-12
5012 12:45 --> @b{2006}-@b{06}-@b{13} 12:45
5013 22 sept 0:34 --> @b{2006}-09-22 0:34
5014 w4 --> ISO week for of the current year @b{2006}
5015 2012 w4 fri --> Friday of ISO week 4 in 2012
5016 2012-w04-5 --> Same as above
5019 Furthermore you can specify a relative date by giving, as the
5020 @emph{first} thing in the input: a plus/minus sign, a number and a
5021 letter ([dwmy]) to indicate change in days, weeks, months, or years. With a
5022 single plus or minus, the date is always relative to today. With a
5023 double plus or minus, it is relative to the default date. If instead of
5024 a single letter, you use the abbreviation of day name, the date will be
5025 the nth such day. @Eg
5030 +4d --> four days from today
5031 +4 --> same as above
5032 +2w --> two weeks from today
5033 ++5 --> five days from default date
5034 +2tue --> second Tuesday from now.
5037 @vindex parse-time-months
5038 @vindex parse-time-weekdays
5039 The function understands English month and weekday abbreviations. If
5040 you want to use unabbreviated names and/or other languages, configure
5041 the variables @code{parse-time-months} and @code{parse-time-weekdays}.
5043 @cindex calendar, for selecting date
5044 @vindex org-popup-calendar-for-date-prompt
5045 Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
5046 you don't need/want the calendar, configure the variable
5047 @code{org-popup-calendar-for-date-prompt}.}. When you exit the date
5048 prompt, either by clicking on a date in the calendar, or by pressing
5049 @key{RET}, the date selected in the calendar will be combined with the
5050 information entered at the prompt. You can control the calendar fully
5051 from the minibuffer:
5056 @kindex S-@key{right}
5057 @kindex S-@key{left}
5058 @kindex S-@key{down}
5060 @kindex M-S-@key{right}
5061 @kindex M-S-@key{left}
5064 > / < @r{Scroll calendar forward/backward by one month.}
5065 mouse-1 @r{Select date by clicking on it.}
5066 S-@key{right}/@key{left} @r{One day forward/backward.}
5067 S-@key{down}/@key{up} @r{One week forward/backward.}
5068 M-S-@key{right}/@key{left} @r{One month forward/backward.}
5069 @key{RET} @r{Choose date in calendar.}
5072 @vindex org-read-date-display-live
5073 The actions of the date/time prompt may seem complex, but I assure you they
5074 will grow on you, and you will start getting annoyed by pretty much any other
5075 way of entering a date/time out there. To help you understand what is going
5076 on, the current interpretation of your input will be displayed live in the
5077 minibuffer@footnote{If you find this distracting, turn the display of with
5078 @code{org-read-date-display-live}.}.
5080 @node Custom time format, , The date/time prompt, Creating timestamps
5081 @subsection Custom time format
5082 @cindex custom date/time format
5083 @cindex time format, custom
5084 @cindex date format, custom
5086 @vindex org-display-custom-times
5087 @vindex org-time-stamp-custom-formats
5088 Org mode uses the standard ISO notation for dates and times as it is
5089 defined in ISO 8601. If you cannot get used to this and require another
5090 representation of date and time to keep you happy, you can get it by
5091 customizing the variables @code{org-display-custom-times} and
5092 @code{org-time-stamp-custom-formats}.
5097 Toggle the display of custom formats for dates and times.
5101 Org mode needs the default format for scanning, so the custom date/time
5102 format does not @emph{replace} the default format---instead it is put
5103 @emph{over} the default format using text properties. This has the
5104 following consequences:
5107 You cannot place the cursor onto a timestamp anymore, only before or
5110 The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
5111 each component of a timestamp. If the cursor is at the beginning of
5112 the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
5113 just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the
5114 time will be changed by one minute.
5116 If the timestamp contains a range of clock times or a repeater, these
5117 will not be overlayed, but remain in the buffer as they were.
5119 When you delete a timestamp character-by-character, it will only
5120 disappear from the buffer after @emph{all} (invisible) characters
5121 belonging to the ISO timestamp have been removed.
5123 If the custom timestamp format is longer than the default and you are
5124 using dates in tables, table alignment will be messed up. If the custom
5125 format is shorter, things do work as expected.
5129 @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times
5130 @section Deadlines and scheduling
5132 A timestamp may be preceded by special keywords to facilitate planning:
5136 @cindex DEADLINE keyword
5138 Meaning: the task (most likely a TODO item, though not necessarily) is supposed
5139 to be finished on that date.
5141 @vindex org-deadline-warning-days
5142 On the deadline date, the task will be listed in the agenda. In
5143 addition, the agenda for @emph{today} will carry a warning about the
5144 approaching or missed deadline, starting
5145 @code{org-deadline-warning-days} before the due date, and continuing
5146 until the entry is marked DONE. An example:
5149 *** TODO write article about the Earth for the Guide
5150 The editor in charge is [[bbdb:Ford Prefect]]
5151 DEADLINE: <2004-02-29 Sun>
5154 You can specify a different lead time for warnings for a specific
5155 deadlines using the following syntax. Here is an example with a warning
5156 period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}.
5159 @cindex SCHEDULED keyword
5161 Meaning: you are planning to start working on that task on the given
5164 @vindex org-agenda-skip-scheduled-if-done
5165 The headline will be listed under the given date@footnote{It will still
5166 be listed on that date after it has been marked DONE. If you don't like
5167 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In
5168 addition, a reminder that the scheduled date has passed will be present
5169 in the compilation for @emph{today}, until the entry is marked DONE.
5170 @Ie the task will automatically be forwarded until completed.
5173 *** TODO Call Trillian for a date on New Years Eve.
5174 SCHEDULED: <2004-12-25 Sat>
5178 @b{Important:} Scheduling an item in Org mode should @i{not} be
5179 understood in the same way that we understand @i{scheduling a meeting}.
5180 Setting a date for a meeting is just a simple appointment, you should
5181 mark this entry with a simple plain timestamp, to get this item shown
5182 on the date where it applies. This is a frequent misunderstanding by
5183 Org users. In Org mode, @i{scheduling} means setting a date when you
5184 want to start working on an action item.
5187 You may use timestamps with repeaters in scheduling and deadline
5188 entries. Org mode will issue early and late warnings based on the
5189 assumption that the timestamp represents the @i{nearest instance} of
5190 the repeater. However, the use of diary sexp entries like
5192 @code{<%%(diary-float t 42)>}
5194 in scheduling and deadline timestamps is limited. Org mode does not
5195 know enough about the internals of each sexp function to issue early and
5196 late warnings. However, it will show the item on each day where the
5200 * Inserting deadline/schedule:: Planning items
5201 * Repeated tasks:: Items that show up again and again
5204 @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling
5205 @subsection Inserting deadlines or schedules
5207 The following commands allow you to quickly insert a deadline or to schedule
5214 Insert @samp{DEADLINE} keyword along with a stamp. The insertion will
5215 happen in the line directly following the headline. When called with a
5216 prefix arg, an existing deadline will be removed from the entry.
5217 @c FIXME Any CLOSED timestamp will be removed.????????
5221 Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will
5222 happen in the line directly following the headline. Any CLOSED
5223 timestamp will be removed. When called with a prefix argument, remove
5224 the scheduling date from the entry.
5230 Mark the current entry for agenda action. After you have marked the entry
5231 like this, you can open the agenda or the calendar to find an appropriate
5232 date. With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to
5233 schedule the marked item.
5236 @cindex sparse tree, for deadlines
5238 @vindex org-deadline-warning-days
5239 Create a sparse tree with all deadlines that are either past-due, or
5240 which will become due within @code{org-deadline-warning-days}.
5241 With @kbd{C-u} prefix, show all deadlines in the file. With a numeric
5242 prefix, check that many days. For example, @kbd{C-1 C-c / d} shows
5243 all deadlines due tomorrow.
5247 Sparse tree for deadlines and scheduled items before a given date.
5251 Sparse tree for deadlines and scheduled items after a given date.
5254 @node Repeated tasks, , Inserting deadline/schedule, Deadlines and scheduling
5255 @subsection Repeated tasks
5256 @cindex tasks, repeated
5257 @cindex repeated tasks
5259 Some tasks need to be repeated again and again. Org mode helps to
5260 organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
5261 or plain timestamp. In the following example
5263 ** TODO Pay the rent
5264 DEADLINE: <2005-10-01 Sat +1m>
5267 the @code{+1m} is a repeater; the intended interpretation is that the task
5268 has a deadline on <2005-10-01> and repeats itself every (one) month starting
5269 from that time. If you need both a repeater and a special warning period in
5270 a deadline entry, the repeater should come first and the warning period last:
5271 @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
5273 Deadlines and scheduled items produce entries in the agenda when they
5274 are over-due, so it is important to be able to mark such an entry as
5275 completed once you have done so. When you mark a DEADLINE or a SCHEDULE
5276 with the TODO keyword DONE, it will no longer produce entries in the
5277 agenda. The problem with this is, however, that then also the
5278 @emph{next} instance of the repeated entry will not be active. Org mode
5279 deals with this in the following way: When you try to mark such an entry
5280 DONE (using @kbd{C-c C-t}), it will shift the base date of the repeating
5281 timestamp by the repeater interval, and immediately set the entry state
5282 back to TODO. In the example above, setting the state to DONE would
5283 actually switch the date like this:
5286 ** TODO Pay the rent
5287 DEADLINE: <2005-11-01 Tue +1m>
5290 @vindex org-log-repeat
5291 A timestamp@footnote{You can change this using the option
5292 @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
5293 @code{lognoterepeat}, and @code{nologrepeat}. With @code{lognoterepeat}, you
5294 will also be prompted for a note.} will be added under the deadline, to keep
5295 a record that you actually acted on the previous instance of this deadline.
5297 As a consequence of shifting the base date, this entry will no longer be
5298 visible in the agenda when checking past dates, but all future instances
5301 With the @samp{+1m} cookie, the date shift will always be exactly one
5302 month. So if you have not paid the rent for three months, marking this
5303 entry DONE will still keep it as an overdue deadline. Depending on the
5304 task, this may not be the best way to handle it. For example, if you
5305 forgot to call you father for 3 weeks, it does not make sense to call
5306 him 3 times in a single day to make up for it. Finally, there are tasks
5307 like changing batteries which should always repeat a certain time
5308 @i{after} the last time you did it. For these tasks, Org mode has
5309 special repeaters markers with @samp{++} and @samp{.+}. For example:
5313 DEADLINE: <2008-02-10 Sun ++1w>
5314 Marking this DONE will shift the date by at least one week,
5315 but also by as many weeks as it takes to get this date into
5316 the future. However, it stays on a Sunday, even if you called
5317 and marked it done on Saturday.
5318 ** TODO Check the batteries in the smoke detectors
5319 DEADLINE: <2005-11-01 Tue .+1m>
5320 Marking this DONE will shift the date to one month after
5324 You may have both scheduling and deadline information for a specific
5325 task---just make sure that the repeater intervals on both are the same.
5327 An alternative to using a repeater is to create a number of copies of a task
5328 subtree, with dates shifted in each copy. The command @kbd{C-c C-x c} was
5329 created for this purpose, it is described in @ref{Structure editing}.
5332 @node Clocking work time, Effort estimates, Deadlines and scheduling, Dates and Times
5333 @section Clocking work time
5335 Org mode allows you to clock the time you spend on specific tasks in a
5336 project. When you start working on an item, you can start the clock.
5337 When you stop working on that task, or when you mark the task done, the
5338 clock is stopped and the corresponding time interval is recorded. It
5339 also computes the total time spent on each subtree of a project.
5341 Normally, the clock does not survive exiting and re-entering Emacs, but you
5342 can arrange for the clock information to persist across Emacs sessions with
5345 (setq org-clock-persist t)
5346 (org-clock-persistence-insinuate)
5352 @vindex org-clock-into-drawer
5353 Start the clock on the current item (clock-in). This inserts the CLOCK
5354 keyword together with a timestamp. If this is not the first clocking of
5355 this item, the multiple CLOCK lines will be wrapped into a
5356 @code{:LOGBOOK:} drawer (see also the variable
5357 @code{org-clock-into-drawer}). When called with a @kbd{C-u} prefix argument,
5358 select the task from a list of recently clocked tasks. With two @kbd{C-u
5359 C-u} prefixes, clock into the task at point and mark it as the default task.
5360 The default task will always be available when selecting a clocking task,
5361 with letter @kbd{d}.@*
5362 @cindex property: CLOCK_MODELINE_TOTAL
5363 @cindex property: LAST_REPEAT
5364 @vindex org-clock-modeline-total
5365 While the clock is running, the current clocking time is shown in the mode
5366 line, along with the title of the task. The clock time shown will be all
5367 time ever clocked for this task and its children. If the task has an effort
5368 estimate (@pxref{Effort estimates}), the mode line displays the current
5369 clocking time against it@footnote{To add an effort estimate ``on the fly'',
5370 hook a function doing this to @code{org-clock-in-prepare-hook}.} If the task
5371 is a repeating one (@pxref{Repeated tasks}), only the time since the last
5372 reset of the task @footnote{as recorded by the @code{LAST_REPEAT} property}
5373 will be shown. More control over what time is shown can be exercised with
5374 the @code{CLOCK_MODELINE_TOTAL} property. It may have the values
5375 @code{current} to show only the current clocking instance, @code{today} to
5376 show all time clocked on this tasks today (see also the variable
5377 @code{org-extend-today-until}), @code{all} to include all time, or
5378 @code{auto} which is the default@footnote{See also the variable
5379 @code{org-clock-modeline-total}.}.@* Clicking with @kbd{mouse-1} onto the
5380 mode line entry will pop up a menu with clocking options.
5383 @vindex org-log-note-clock-out
5384 Stop the clock (clock-out). This inserts another timestamp at the same
5385 location where the clock was last started. It also directly computes
5386 the resulting time in inserts it after the time range as @samp{=>
5387 HH:MM}. See the variable @code{org-log-note-clock-out} for the
5388 possibility to record an additional note together with the clock-out
5389 timestamp@footnote{The corresponding in-buffer setting is:
5390 @code{#+STARTUP: lognoteclock-out}}.
5393 Update the effort estimate for the current clock task.
5396 @item C-c C-y @ @ @r{or}@ @ C-c C-c
5397 Recompute the time interval after changing one of the timestamps. This
5398 is only necessary if you edit the timestamps directly. If you change
5399 them with @kbd{S-@key{cursor}} keys, the update is automatic.
5402 Changing the TODO state of an item to DONE automatically stops the clock
5403 if it is running in this same item.
5406 Cancel the current clock. This is useful if a clock was started by
5407 mistake, or if you ended up working on something else.
5410 Jump to the entry that contains the currently running clock. With a
5411 @kbd{C-u} prefix arg, select the target task from a list of recently clocked
5415 @vindex org-remove-highlights-with-change
5416 Display time summaries for each subtree in the current buffer. This
5417 puts overlays at the end of each headline, showing the total time
5418 recorded under that heading, including the time of any subheadings. You
5419 can use visibility cycling to study the tree, but the overlays disappear
5420 when you change the buffer (see variable
5421 @code{org-remove-highlights-with-change}) or press @kbd{C-c C-c}.
5424 Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
5425 report as an Org-mode table into the current file. When the cursor is
5426 at an existing clock table, just update it. When called with a prefix
5427 argument, jump to the first clock report in the current document and
5429 @cindex #+BEGIN, clocktable
5431 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
5435 If such a block already exists at point, its content is replaced by the
5436 new table. The @samp{BEGIN} line can specify options:
5438 :maxlevel @r{Maximum level depth to which times are listed in the table.}
5439 :emphasize @r{When @code{t}, emphasize level one and level two items.}
5440 :scope @r{The scope to consider. This can be any of the following:}
5441 nil @r{the current buffer or narrowed region}
5442 file @r{the full current buffer}
5443 subtree @r{the subtree where the clocktable is located}
5444 tree@var{N} @r{the surrounding level @var{N} tree, for example @code{tree3}}
5445 tree @r{the surrounding level 1 tree}
5446 agenda @r{all agenda files}
5447 ("file"..) @r{scan these files}
5448 file-with-archives @r{current file and its archives}
5449 agenda-with-archives @r{all agenda files, including archives}
5450 :block @r{The time block to consider. This block is specified either}
5451 @r{absolute, or relative to the current time and may be any of}
5453 2007-12-31 @r{New year eve 2007}
5454 2007-12 @r{December 2007}
5455 2007-W50 @r{ISO-week 50 in 2007}
5456 2007 @r{the year 2007}
5457 today, yesterday, today-@var{N} @r{a relative day}
5458 thisweek, lastweek, thisweek-@var{N} @r{a relative week}
5459 thismonth, lastmonth, thismonth-@var{N} @r{a relative month}
5460 thisyear, lastyear, thisyear-@var{N} @r{a relative year}
5461 @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
5462 :tstart @r{A time string specifying when to start considering times.}
5463 :tend @r{A time string specifying when to stop considering times.}
5464 :step @r{@code{week} or @code{day}, to split the table into chunks.}
5465 @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
5466 :link @r{Link the item headlines in the table to their origins.}
5467 :formula @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
5468 @r{As a special case, @samp{:formula %} adds a column with % time.}
5469 @r{If you do not specify a formula here, any existing formula.}
5470 @r{below the clock table will survive updates and be evaluated.}
5471 :timestamp @r{A timestamp for the entry, when available. Look for SCHEDULED,}
5472 @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.}
5474 To get a clock summary of the current level 1 tree, for the current
5475 day, you could write
5477 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
5481 and to use a specific time range you could write@footnote{Note that all
5482 parameters must be specified in a single line---the line is broken here
5483 only to fit it into the manual.}
5485 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
5486 :tend "<2006-08-10 Thu 12:00>"
5489 A summary of the current subtree with % times would be
5491 #+BEGIN: clocktable :scope subtree :link t :formula %
5498 Update dynamic block at point. The cursor needs to be in the
5499 @code{#+BEGIN} line of the dynamic block.
5500 @kindex C-u C-c C-x C-u
5501 @item C-u C-c C-x C-u
5502 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
5503 you have several clock table blocks in a buffer.
5504 @kindex S-@key{left}
5505 @kindex S-@key{right}
5507 @itemx S-@key{right}
5508 Shift the current @code{:block} interval and update the table. The cursor
5509 needs to be in the @code{#+BEGIN: clocktable} line for this command. If
5510 @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
5513 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
5514 the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
5515 worked on or closed during a day.
5517 @node Effort estimates, Relative timer, Clocking work time, Dates and Times
5518 @section Effort estimates
5519 @cindex effort estimates
5521 @cindex property, Effort
5522 @vindex org-effort-property
5523 If you want to plan your work in a very detailed way, or if you need to
5524 produce offers with quotations of the estimated work effort, you may want to
5525 assign effort estimates to entries. If you are also clocking your work, you
5526 may later want to compare the planned effort with the actual working time, a
5527 great way to improve planning estimates. Effort estimates are stored in a
5528 special property @samp{Effort}@footnote{You may change the property being
5529 used with the variable @code{org-effort-property}.}. Clearly the best way to
5530 work with effort estimates is through column view (@pxref{Column view}). You
5531 should start by setting up discrete values for effort estimates, and a
5532 @code{COLUMNS} format that displays these values together with clock sums (if
5533 you want to clock your time). For a specific buffer you can use
5536 #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00
5537 #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
5541 @vindex org-global-properties
5542 @vindex org-columns-default-format
5543 or, even better, you can set up these values globally by customizing the
5544 variables @code{org-global-properties} and @code{org-columns-default-format}.
5545 In particular if you want to use this setup also in the agenda, a global
5546 setup may be advised.
5548 The way to assign estimates to individual items is then to switch to column
5549 mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
5550 value. The values you enter will immediately be summed up in the hierarchy.
5551 In the column next to it, any clocked time will be displayed.
5553 @vindex org-agenda-columns-add-appointments-to-effort-sum
5554 If you switch to column view in the daily/weekly agenda, the effort column
5555 will summarize the estimated work effort for each day@footnote{Please note
5556 the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
5557 column view}).}, and you can use this to find space in your schedule. To get
5558 an overview of the entire part of the day that is committed, you can set the
5559 option @code{org-agenda-columns-add-appointments-to-effort-sum}. The
5560 appointments on a day that take place over a specified time interval will
5561 then also be added to the load estimate of the day.
5563 Effort estimates can be used in secondary agenda filtering that is triggered
5564 with the @kbd{/} key in the agenda (@pxref{Agenda commands}). If you have
5565 these estimates defined consistently, two or three key presses will narrow
5566 down the list to stuff that fits into an available time slot.
5568 @node Relative timer, , Effort estimates, Dates and Times
5569 @section Taking notes with a relative timer
5570 @cindex relative timer
5572 When taking notes during, for example, a meeting or a video viewing, it can
5573 be useful to have access to times relative to a starting time. Org provides
5574 such a relative timer and make it easy to create timed notes.
5579 Insert a relative time into the buffer. The first time you use this, the
5580 timer will be started. When called with a prefix argument, the timer is
5584 Insert a description list item with the current relative time. With a prefix
5585 argument, first reset the timer to 0.
5588 Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
5592 Pause the timer, or continue it if it is already paused.
5593 @c removed the sentence because it is redundant to the following item
5594 @kindex C-u C-c C-x ,
5596 Stop the timer. After this, you can only start a new timer, not continue the
5597 old one. This command also removes the timer from the mode line.
5600 Reset the timer without inserting anything into the buffer. By default, the
5601 timer is reset to 0. When called with a @kbd{C-u} prefix, reset the timer to
5602 specific starting offset. The user is prompted for the offset, with a
5603 default taken from a timer string at point, if any, So this can be used to
5604 restart taking notes after a break in the process. When called with a double
5605 prefix argument @kbd{C-c C-u}, change all timer strings in the active region
5606 by a certain amount. This can be used to fix timer strings if the timer was
5607 not started at exactly the right moment.
5610 @node Capture, Agenda Views, Dates and Times, Top
5614 An important part of any organization system is the ability to quickly
5615 capture new ideas and tasks, and to associate reference material with them.
5616 Org uses the @file{remember.el} package to create tasks, and stores files
5617 related to a task (@i{attachments}) in a special directory.
5620 * Remember:: Capture new tasks/ideas with little interruption
5621 * Attachments:: Add files to tasks.
5622 * RSS Feeds:: Getting input from RSS feeds
5623 * Protocols:: External (@eg Browser) access to Emacs and Org
5626 @node Remember, Attachments, Capture, Capture
5628 @cindex @file{remember.el}
5630 The Remember package by John Wiegley lets you store quick notes with little
5631 interruption of your work flow. It is an excellent way to add new notes and
5632 tasks to Org files. The @code{remember.el} package is part of Emacs 23, not
5633 Emacs 22. See @uref{http://www.emacswiki.org/cgi-bin/wiki/RememberMode} for
5636 Org significantly expands the possibilities of Remember: you may define
5637 templates for different note types, and associate target files and headlines
5638 with specific templates. It also allows you to select the location where a
5639 note should be stored interactively, on the fly.
5642 * Setting up Remember for Org:: Some code for .emacs to get things going
5643 * Remember templates:: Define the outline of different note types
5644 * Storing notes:: Directly get the note to where it belongs
5645 * Refiling notes:: Moving a note or task to a project
5648 @node Setting up Remember for Org, Remember templates, Remember, Remember
5649 @subsection Setting up Remember for Org
5651 The following customization will tell Remember to use Org files as
5652 target, and to create annotations compatible with Org links.
5655 (org-remember-insinuate)
5656 (setq org-directory "~/path/to/my/orgfiles/")
5657 (setq org-default-notes-file (concat org-directory "/notes.org"))
5658 (define-key global-map "\C-cr" 'org-remember)
5662 The last line binds the command @code{org-remember} to a global
5663 key@footnote{Please select your own key, @kbd{C-c r} is only a
5664 suggestion.}. @code{org-remember} basically just calls Remember,
5665 but it makes a few things easier: if there is an active region, it will
5666 automatically copy the region into the Remember buffer. It also allows
5667 to jump to the buffer and location where Remember notes are being
5668 stored: just call @code{org-remember} with a prefix argument. If you
5669 use two prefix arguments, Org jumps to the location where the last
5670 remember note was stored.
5672 The Remember buffer will actually use @code{org-mode} as its major mode, so
5673 that all editing features of Org mode are available. In addition to this, a
5674 minor mode @code{org-remember-mode} is turned on, for the single purpose that
5675 you can use its keymap @code{org-remember-mode-map} to overwrite some of
5676 Org mode's key bindings.
5678 You can also call @code{org-remember} in a special way from the agenda,
5679 using the @kbd{k r} key combination. With this access, any timestamps
5680 inserted by the selected Remember template (see below) will default to
5681 the cursor date in the agenda, rather than to the current date.
5683 @node Remember templates, Storing notes, Setting up Remember for Org, Remember
5684 @subsection Remember templates
5685 @cindex templates, for Remember
5687 In combination with Org, you can use templates to generate
5688 different types of Remember notes. For example, if you would like
5689 to use one template to create general TODO entries, another one for
5690 journal entries, and a third one for collecting random ideas, you could
5694 (setq org-remember-templates
5695 '(("Todo" ?t "* TODO %?\n %i\n %a" "~/org/TODO.org" "Tasks")
5696 ("Journal" ?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org")
5697 ("Idea" ?i "* %^@{Title@}\n %i\n %a" "~/org/JOURNAL.org" "New Ideas")))
5700 @vindex org-remember-default-headline
5701 @vindex org-directory
5702 @noindent In these entries, the first string is just a name, and the
5703 character specifies how to select the template. It is useful if the
5704 character is also the first letter of the name. The next string specifies
5705 the template. Two more (optional) strings give the file in which, and the
5706 headline under which, the new note should be stored. The file (if not present
5707 or @code{nil}) defaults to @code{org-default-notes-file}, the heading to
5708 @code{org-remember-default-headline}. If the file name is not an absolute
5709 path, it will be interpreted relative to @code{org-directory}. The heading
5710 can also be the symbols @code{top} or @code{bottom} to send notes as level 1
5711 entries to the beginning or end of the file, respectively.
5713 An optional sixth element specifies the contexts in which the user can select
5714 the template. This element can be a list of major modes or a function.
5715 @code{org-remember} will first check whether the function returns @code{t} or
5716 if we are in any of the listed major modes, and exclude templates for which
5717 this condition is not fulfilled. Templates that do not specify this element
5718 at all, or that use @code{nil} or @code{t} as a value will always be
5724 (setq org-remember-templates
5725 '(("Bug" ?b "* BUG %?\n %i\n %a" "~/org/BUGS.org" "Bugs" (emacs-lisp-mode))
5726 ("Journal" ?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org" "X" my-check)
5727 ("Idea" ?i "* %^@{Title@}\n %i\n %a" "~/org/JOURNAL.org" "New Ideas")))
5731 The first template will only be available when invoking @code{org-remember}
5732 from an buffer in @code{emacs-lisp-mode}. The second template will only be
5733 available when the function @code{my-check} returns @code{t}. The third
5734 template will be proposed in any context.
5736 When you call @kbd{M-x org-remember} (or @kbd{M-x remember}) to remember
5737 something, Org will prompt for a key to select the template (if you have
5738 more than one template) and then prepare the buffer like
5741 [[file:@var{link to where you called remember}]]
5745 During expansion of the template, special @kbd{%}-escapes@footnote{If you
5746 need one of these sequences literally, escape the @kbd{%} with a backslash.}
5747 allow dynamic insertion of content:
5749 %^@{@var{prompt}@} @r{prompt the user for a string and replace this sequence with it.}
5750 @r{You may specify a default value and a completion table with}
5751 @r{%^@{prompt|default|completion2|completion3...@}}
5752 @r{The arrow keys access a prompt-specific history.}
5753 %a @r{annotation, normally the link created with @code{org-store-link}}
5754 %A @r{like @code{%a}, but prompt for the description part}
5755 %i @r{initial content, the region when remember is called with C-u.}
5756 @r{The entire text will be indented like @code{%i} itself.}
5757 %t @r{timestamp, date only}
5758 %T @r{timestamp with date and time}
5759 %u, %U @r{like the above, but inactive timestamps}
5760 %^t @r{like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}}
5761 @r{You may define a prompt like @code{%^@{Birthday@}t}}
5762 %n @r{user name (taken from @code{user-full-name})}
5763 %c @r{Current kill ring head.}
5764 %x @r{Content of the X clipboard.}
5765 %^C @r{Interactive selection of which kill or clip to use.}
5766 %^L @r{Like @code{%^C}, but insert as link.}
5767 %^g @r{prompt for tags, with completion on tags in target file.}
5768 %k @r{title of currently clocked task}
5769 %K @r{link to currently clocked task}
5770 %^G @r{prompt for tags, with completion all tags in all agenda files.}
5771 %^@{@var{prop}@}p @r{Prompt the user for a value for property @var{prop}}
5772 %:keyword @r{specific information for certain link types, see below}
5773 %[@var{file}] @r{insert the contents of the file given by @var{file}}
5774 %(@var{sexp}) @r{evaluate Elisp @var{sexp} and replace with the result}
5775 %! @r{immediately store note after completing the template}
5776 @r{(skipping the @kbd{C-c C-c} that normally triggers storing)}
5777 %& @r{jump to target location immediately after storing note}
5781 For specific link types, the following keywords will be
5782 defined@footnote{If you define your own link types (@pxref{Adding
5783 hyperlink types}), any property you store with
5784 @code{org-store-link-props} can be accessed in remember templates in a
5787 @vindex org-from-is-user-regexp
5789 Link type | Available keywords
5790 -------------------+----------------------------------------------
5791 bbdb | %:name %:company
5792 bbdb | %::server %:port %:nick
5793 vm, wl, mh, rmail | %:type %:subject %:message-id
5794 | %:from %:fromname %:fromaddress
5795 | %:to %:toname %:toaddress
5796 | %: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}.}}
5797 gnus | %:group, @r{for messages also all email fields}
5799 info | %:file %:node
5804 To place the cursor after template expansion use:
5807 %? @r{After completing the template, position cursor here.}
5811 If you change your mind about which template to use, call
5812 @code{org-remember} in the remember buffer. You may then select a new
5813 template that will be filled with the previous context information.
5815 @node Storing notes, Refiling notes, Remember templates, Remember
5816 @subsection Storing notes
5818 @vindex org-remember-clock-out-on-exit
5819 When you are finished preparing a note with Remember, you have to press
5820 @kbd{C-c C-c} to file the note away. If you have started the clock in the
5821 Remember buffer, you will first be asked if you want to clock out
5822 now@footnote{To avoid this query, configure the variable
5823 @code{org-remember-clock-out-on-exit}.}. If you answer @kbd{n}, the clock
5824 will continue to run after the note was filed away.
5826 The handler will then store the note in the file and under the headline
5827 specified in the template, or it will use the default file and headline.
5828 The window configuration will be restored, sending you back to the working
5829 context before the call to Remember. To re-use the location found
5830 during the last call to Remember, exit the Remember buffer with
5831 @kbd{C-0 C-c C-c}, @ie specify a zero prefix argument to @kbd{C-c C-c}.
5832 Another special case is @kbd{C-2 C-c C-c} which files the note as a child of
5833 the currently clocked item.
5835 @vindex org-remember-store-without-prompt
5836 If you want to store the note directly to a different place, use
5837 @kbd{C-1 C-c C-c} instead to exit Remember@footnote{Configure the
5838 variable @code{org-remember-store-without-prompt} to make this behavior
5839 the default.}. The handler will then first prompt for a target file---if
5840 you press @key{RET}, the value specified for the template is used.
5841 Then the command offers the headings tree of the selected file, with the
5842 cursor position at the default headline (if you specified one in the
5843 template). You can either immediately press @key{RET} to get the note
5844 placed there. Or you can use the following keys to find a different
5847 @key{TAB} @r{Cycle visibility.}
5848 @key{down} / @key{up} @r{Next/previous visible headline.}
5849 n / p @r{Next/previous visible headline.}
5850 f / b @r{Next/previous headline same level.}
5852 @c 0-9 @r{Digit argument.}
5855 Pressing @key{RET} or @key{left} or @key{right}
5856 then leads to the following result.
5858 @vindex org-reverse-note-order
5859 @multitable @columnfractions 0.2 0.15 0.65
5860 @item @b{Cursor position} @tab @b{Key} @tab @b{Note gets inserted}
5861 @item on headline @tab @key{RET} @tab as sublevel of the heading at cursor, first or last
5862 @item @tab @tab depending on @code{org-reverse-note-order}.
5863 @item @tab @key{left}/@key{right} @tab as same level, before/after current heading
5864 @item buffer-start @tab @key{RET} @tab as level 2 heading at end of file or level 1 at beginning
5865 @item @tab @tab depending on @code{org-reverse-note-order}.
5866 @item not on headline @tab @key{RET}
5867 @tab at cursor position, level taken from context.
5870 Before inserting the text into a tree, the function ensures that the text has
5871 a headline, @ie a first line that starts with a @samp{*}. If not, a
5872 headline is constructed from the current date. If you have indented the text
5873 of the note below the headline, the indentation will be adapted if inserting
5874 the note into the tree requires demotion from level 1.
5876 @node Refiling notes, , Storing notes, Remember
5877 @subsection Refiling notes
5878 @cindex refiling notes
5880 Remember is usually used to quickly capture notes and tasks into one or
5881 a few capture lists. When reviewing the captured data, you may want to
5882 refile some of the entries into a different list, for example into a
5883 project. Cutting, finding the right location, and then pasting the note
5884 is cumbersome. To simplify this process, you can use the following
5890 @vindex org-reverse-note-order
5891 @vindex org-refile-targets
5892 @vindex org-refile-use-outline-path
5893 @vindex org-outline-path-complete-in-steps
5894 @vindex org-refile-allow-creating-parent-nodes
5895 Refile the entry or region at point. This command offers possible locations
5896 for refiling the entry and lets you select one with completion. The item (or
5897 all items in the region) is filed below the target heading as a subitem.
5898 Depending on @code{org-reverse-note-order}, it will be either the first or
5900 By default, all level 1 headlines in the current buffer are considered to be
5901 targets, but you can have more complex definitions across a number of files.
5902 See the variable @code{org-refile-targets} for details. If you would like to
5903 select a location via a file-path-like completion along the outline path, see
5904 the variables @code{org-refile-use-outline-path} and
5905 @code{org-outline-path-complete-in-steps}. If you would like to be able to
5906 create new nodes as new parents for for refiling on the fly, check the
5907 variable @code{org-refile-allow-creating-parent-nodes}.
5910 Use the refile interface to jump to a heading.
5911 @kindex C-u C-u C-c C-w
5912 @item C-u C-u C-c C-w
5913 Jump to the location where @code{org-refile} last moved a tree to.
5917 @node Attachments, RSS Feeds, Remember, Capture
5918 @section Attachments
5921 @vindex org-attach-directory
5922 It is often useful to associate reference material with an outline node/task.
5923 Small chunks of plain text can simply be stored in the subtree of a project.
5924 Hyperlinks (@pxref{Hyperlinks}) can be used to establish associations with
5925 files that live elsewhere on your computer or in the cloud, like emails or
5926 source code files belonging to a project. Another method is @i{attachments},
5927 which are files located in a directory belonging to an outline node. Org
5928 uses directories named by the unique ID of each entry. These directories are
5929 located in the @file{data} directory which lives in the same directory where
5930 your Org file lives@footnote{If you move entries or Org files from one
5931 directory to another, you may want to configure @code{org-attach-directory}
5932 to contain an absolute path.}. If you initialize this directory with
5933 @code{git init}, Org will automatically commit changes when it sees them.
5934 The attachment system has been contributed to Org by John Wiegley.
5936 In cases where it seems better to do so, you can also attach a directory of your
5937 choice to an entry. You can also make children inherit the attachment
5938 directory from a parent, so that an entire subtree uses the same attached
5941 @noindent The following commands deal with attachments.
5947 The dispatcher for commands related to the attachment system. After these
5948 keys, a list of commands is displayed and you need to press an additional key
5949 to select a command:
5954 @vindex org-attach-method
5955 Select a file and move it into the task's attachment directory. The file
5956 will be copied, moved, or linked, depending on @code{org-attach-method}.
5957 Note that hard links are not supported on all systems.
5963 Attach a file using the copy/move/link method.
5964 Note that hard links are not supported on all systems.
5968 Create a new attachment as an Emacs buffer.
5972 Synchronize the current task with its attachment directory, in case you added
5973 attachments yourself.
5977 @vindex org-file-apps
5978 Open current task's attachment. If there are more than one, prompt for a
5979 file name first. Opening will follow the rules set by @code{org-file-apps}.
5980 For more details, see the information on following hyperlinks
5981 (@pxref{Handling links}).
5985 Also open the attachment, but force opening the file in Emacs.
5989 Open the current task's attachment directory.
5993 Also open the directory, but force using @command{dired} in Emacs.
5997 Select and delete a single attachment.
6001 Delete all of a task's attachments. A safer way is to open the directory in
6002 @command{dired} and delete from there.
6006 @cindex property, ATTACH_DIR
6007 Set a specific directory as the entry's attachment directory. This works by
6008 putting the directory path into the @code{ATTACH_DIR} property.
6012 @cindex property, ATTACH_DIR_INHERIT
6013 Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
6014 same directory for attachments as the parent does.
6018 @node RSS Feeds, Protocols, Attachments, Capture
6022 Org has the capability to add and change entries based on information found in
6023 RSS feeds. You could use this to make a task out of each new podcast in a
6024 podcast feed. Or you could use a phone-based note-creating service on the
6025 web to import tasks into Org. To access feeds, you need to configure the
6026 variable @code{org-feed-alist}. The docstring of this variable has detailed
6027 information. Here is just an example:
6030 (setq org-feed-alist
6031 '(("ReQall" "http://www.reqall.com/user/feeds/rss/a1b2c3....."
6032 "~/org/feeds.org" "ReQall Entries")
6035 will configure that new items from the feed provided by @file{reqall.com}
6036 will result in new entries in the file @file{~/org/feeds.org} under the
6037 heading @samp{ReQall Entries}, whenever the following command is used:
6042 Collect items from the feeds configured in @code{org-feed-alist} and act upon
6046 Prompt for a feed name and go to the inbox configured for this feed.
6049 Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which
6050 it will store information about the status of items in the feed, to avoid
6051 adding the same item several times. You should add @samp{FEEDSTATUS} to the
6052 list of drawers in that file:
6055 #+DRAWERS: LOGBOOK PROPERTIES FEEDSTATUS
6058 For more information, see @file{org-feed.el} and the docstring of
6059 @code{org-feed-alist}.
6061 @node Protocols, , RSS Feeds, Capture
6062 @section Protocols for external access
6063 @cindex protocols, for external access
6066 You can set up Org for handling protocol calls from outside applications that
6067 are passed to Emacs through the @file{emacsserver}. For example, you can
6068 configure bookmarks in your web browser to send a link to the current page to
6069 Org and create a note from it using Remember (@pxref{Remember}). Or you
6070 could create a bookmark that will tell Emacs to open the local source file of
6071 a remote website you are looking at with the browser. See
6072 @uref{http://orgmode.org/worg/org-contrib/org-protocol.php} for detailed
6073 documentation and setup instructions.
6076 @node Agenda Views, Embedded LaTeX, Capture, Top
6077 @chapter Agenda Views
6078 @cindex agenda views
6080 Due to the way Org works, TODO items, time-stamped items, and
6081 tagged headlines can be scattered throughout a file or even a number of
6082 files. To get an overview of open action items, or of events that are
6083 important for a particular date, this information must be collected,
6084 sorted and displayed in an organized way.
6086 Org can select items based on various criteria and display them
6087 in a separate buffer. Seven different view types are provided:
6091 an @emph{agenda} that is like a calendar and shows information
6094 a @emph{TODO list} that covers all unfinished
6097 a @emph{match view}, showings headlines based on the tags, properties, and
6098 TODO state associated with them,
6100 a @emph{timeline view} that shows all events in a single Org file,
6101 in time-sorted view,
6103 a @emph{keyword search view} that shows all entries from multiple files
6104 that contain specified keywords,
6106 a @emph{stuck projects view} showing projects that currently don't move
6109 @emph{custom views} that are special tag/keyword searches and
6110 combinations of different views.
6114 The extracted information is displayed in a special @emph{agenda
6115 buffer}. This buffer is read-only, but provides commands to visit the
6116 corresponding locations in the original Org files, and even to
6117 edit these files remotely.
6119 @vindex org-agenda-window-setup
6120 @vindex org-agenda-restore-windows-after-quit
6121 Two variables control how the agenda buffer is displayed and whether the
6122 window configuration is restored when the agenda exits:
6123 @code{org-agenda-window-setup} and
6124 @code{org-agenda-restore-windows-after-quit}.
6127 * Agenda files:: Files being searched for agenda information
6128 * Agenda dispatcher:: Keyboard access to agenda views
6129 * Built-in agenda views:: What is available out of the box?
6130 * Presentation and sorting:: How agenda items are prepared for display
6131 * Agenda commands:: Remote editing of Org trees
6132 * Custom agenda views:: Defining special searches and views
6133 * Exporting Agenda Views::
6134 * Agenda column view:: Using column view for collected entries
6137 @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views
6138 @section Agenda files
6139 @cindex agenda files
6140 @cindex files for agenda
6142 @vindex org-agenda-files
6143 The information to be shown is normally collected from all @emph{agenda
6144 files}, the files listed in the variable
6145 @code{org-agenda-files}@footnote{If the value of that variable is not a
6146 list, but a single file name, then the list of agenda files will be
6147 maintained in that external file.}. If a directory is part of this list,
6148 all files with the extension @file{.org} in this directory will be part
6151 Thus, even if you only work with a single Org file, that file should
6152 be put into the list@footnote{When using the dispatcher, pressing
6153 @kbd{<} before selecting a command will actually limit the command to
6154 the current file, and ignore @code{org-agenda-files} until the next
6155 dispatcher command.}. You can customize @code{org-agenda-files}, but
6156 the easiest way to maintain it is through the following commands
6158 @cindex files, adding to agenda list
6162 Add current file to the list of agenda files. The file is added to
6163 the front of the list. If it was already in the list, it is moved to
6164 the front. With a prefix argument, file is added/moved to the end.
6167 Remove current file from the list of agenda files.
6172 Cycle through agenda file list, visiting one file after the other.
6173 @kindex M-x org-iswitchb
6174 @item M-x org-iswitchb
6175 Command to use an @code{iswitchb}-like interface to switch to and between Org
6180 The Org menu contains the current list of files and can be used
6181 to visit any of them.
6183 If you would like to focus the agenda temporarily on a file not in
6184 this list, or on just one file in the list, or even on only a subtree in a
6185 file, then this can be done in different ways. For a single agenda command,
6186 you may press @kbd{<} once or several times in the dispatcher
6187 (@pxref{Agenda dispatcher}). To restrict the agenda scope for an
6188 extended period, use the following commands:
6193 Permanently restrict the agenda to the current subtree. When with a
6194 prefix argument, or with the cursor before the first headline in a file,
6195 the agenda scope is set to the entire file. This restriction remains in
6196 effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
6197 or @kbd{>} in the agenda dispatcher. If there is a window displaying an
6198 agenda view, the new restriction takes effect immediately.
6201 Remove the permanent restriction created by @kbd{C-c C-x <}.
6205 When working with @file{speedbar.el}, you can use the following commands in
6209 @item < @r{in the speedbar frame}
6210 Permanently restrict the agenda to the item---either an Org file or a subtree
6211 in such a file---at the cursor in the Speedbar frame.
6212 If there is a window displaying an agenda view, the new restriction takes
6215 @item > @r{in the speedbar frame}
6216 Lift the restriction.
6219 @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views
6220 @section The agenda dispatcher
6221 @cindex agenda dispatcher
6222 @cindex dispatching agenda commands
6223 The views are created through a dispatcher, which should be bound to a
6224 global key---for example @kbd{C-c a} (@pxref{Installation}). In the
6225 following we will assume that @kbd{C-c a} is indeed how the dispatcher
6226 is accessed and list keyboard access to commands accordingly. After
6227 pressing @kbd{C-c a}, an additional letter is required to execute a
6228 command. The dispatcher offers the following default commands:
6231 Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
6233 Create a list of all TODO items (@pxref{Global TODO list}).
6235 Create a list of headlines matching a TAGS expression (@pxref{Matching
6236 tags and properties}).
6238 Create the timeline view for the current buffer (@pxref{Timeline}).
6240 Create a list of entries selected by a boolean expression of keywords
6241 and/or regular expressions that must or must not occur in the entry.
6243 @vindex org-agenda-text-search-extra-files
6244 Search for a regular expression in all agenda files and additionally in
6245 the files listed in @code{org-agenda-text-search-extra-files}. This
6246 uses the Emacs command @code{multi-occur}. A prefix argument can be
6247 used to specify the number of context lines for each match, default is
6250 Create a list of stuck projects (@pxref{Stuck projects}).
6252 Restrict an agenda command to the current buffer@footnote{For backward
6253 compatibility, you can also press @kbd{1} to restrict to the current
6254 buffer.}. After pressing @kbd{<}, you still need to press the character
6255 selecting the command.
6257 If there is an active region, restrict the following agenda command to
6258 the region. Otherwise, restrict it to the current subtree@footnote{For
6259 backward compatibility, you can also press @kbd{0} to restrict to the
6260 current region/subtree.}. After pressing @kbd{< <}, you still need to press the
6261 character selecting the command.
6264 You can also define custom commands that will be accessible through the
6265 dispatcher, just like the default commands. This includes the
6266 possibility to create extended agenda buffers that contain several
6267 blocks together, for example the weekly agenda, the global TODO list and
6268 a number of special tags matches. @xref{Custom agenda views}.
6270 @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda Views
6271 @section The built-in agenda views
6273 In this section we describe the built-in views.
6276 * Weekly/daily agenda:: The calendar page with current tasks
6277 * Global TODO list:: All unfinished action items
6278 * Matching tags and properties:: Structured information with fine-tuned search
6279 * Timeline:: Time-sorted view for single file
6280 * Keyword search:: Finding entries by keyword
6281 * Stuck projects:: Find projects you need to review
6284 @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views
6285 @subsection The weekly/daily agenda
6287 @cindex weekly agenda
6288 @cindex daily agenda
6290 The purpose of the weekly/daily @emph{agenda} is to act like a page of a
6291 paper agenda, showing all the tasks for the current week or day.
6294 @cindex org-agenda, command
6297 @vindex org-agenda-ndays
6298 Compile an agenda for the current week from a list of Org files. The agenda
6299 shows the entries for each day. With a numeric prefix@footnote{For backward
6300 compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
6301 listed before the agenda. This feature is deprecated, use the dedicated TODO
6302 list, or a block agenda instead (@pxref{Block agenda}).} (like @kbd{C-u 2 1
6303 C-c a a}) you may set the number of days to be displayed (see also the
6304 variable @code{org-agenda-ndays})
6307 Remote editing from the agenda buffer means, for example, that you can
6308 change the dates of deadlines and appointments from the agenda buffer.
6309 The commands available in the Agenda buffer are listed in @ref{Agenda
6312 @subsubheading Calendar/Diary integration
6313 @cindex calendar integration
6314 @cindex diary integration
6316 Emacs contains the calendar and diary by Edward M. Reingold. The
6317 calendar displays a three-month calendar with holidays from different
6318 countries and cultures. The diary allows you to keep track of
6319 anniversaries, lunar phases, sunrise/set, recurrent appointments
6320 (weekly, monthly) and more. In this way, it is quite complementary to
6321 Org. It can be very useful to combine output from Org with
6324 In order to include entries from the Emacs diary into Org mode's
6325 agenda, you only need to customize the variable
6328 (setq org-agenda-include-diary t)
6331 @noindent After that, everything will happen automatically. All diary
6332 entries including holidays, anniversaries, etc., will be included in the
6333 agenda buffer created by Org mode. @key{SPC}, @key{TAB}, and
6334 @key{RET} can be used from the agenda buffer to jump to the diary
6335 file in order to edit existing diary entries. The @kbd{i} command to
6336 insert new entries for the current date works in the agenda buffer, as
6337 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
6338 Sunrise/Sunset times, show lunar phases and to convert to other
6339 calendars, respectively. @kbd{c} can be used to switch back and forth
6340 between calendar and agenda.
6342 If you are using the diary only for sexp entries and holidays, it is
6343 faster to not use the above setting, but instead to copy or even move
6344 the entries into an Org file. Org mode evaluates diary-style sexp
6345 entries, and does it faster because there is no overhead for first
6346 creating the diary display. Note that the sexp entries must start at
6347 the left margin, no whitespace is allowed before them. For example,
6348 the following segment of an Org file will be processed and entries
6349 will be made in the agenda:
6352 * Birthdays and similar stuff
6354 %%(org-calendar-holiday) ; special function for holiday names
6356 %%(diary-anniversary 14 5 1956) Arthur Dent is %d years old
6357 %%(diary-anniversary 2 10 1869) Mahatma Gandhi would be %d years old
6360 @subsubheading Anniversaries from BBDB
6361 @cindex BBDB, anniversaries
6362 @cindex anniversaries, from BBDB
6364 If you are using the Big Brothers Database to store your contacts, you will
6365 very likely prefer to store anniversaries in BBDB rather than in a
6366 separate Org or diary file. Org supports this and will show BBDB
6367 anniversaries as part of the agenda. All you need to do is to add the
6368 following to one your your agenda files:
6375 %%(org-bbdb-anniversaries)
6378 You can then go ahead and define anniversaries for a BBDB record. Basically,
6379 you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB
6380 record and then add the date in the format @code{YYYY-MM-DD}, followed by a
6381 space and the class of the anniversary (@samp{birthday} or @samp{wedding}, or
6382 a format string). If you omit the class, it will default to @samp{birthday}.
6383 Here are a few examples, the header for the file @file{org-bbdb.el} contains
6384 more detailed information.
6389 2008-04-14 %s released version 6.01 of org-mode, %d years ago
6392 After a change to BBDB, or for the first agenda display during an Emacs
6393 session, the agenda display will suffer a short delay as Org updates its
6394 hash with anniversaries. However, from then on things will be very fast---much
6395 faster in fact than a long list of @samp{%%(diary-anniversary)} entries
6396 in an Org or Diary file.
6398 @subsubheading Appointment reminders
6399 @cindex @file{appt.el}
6400 @cindex appointment reminders
6402 Org can interact with Emacs appointments notification facility. To add all
6403 the appointments of your agenda files, use the command
6404 @code{org-agenda-to-appt}. This command also lets you filter through the
6405 list of your appointments and add only those belonging to a specific category
6406 or matching a regular expression. See the docstring for details.
6408 @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views
6409 @subsection The global TODO list
6410 @cindex global TODO list
6411 @cindex TODO list, global
6413 The global TODO list contains all unfinished TODO items formatted and
6414 collected into a single place.
6419 Show the global TODO list. This collects the TODO items from all
6420 agenda files (@pxref{Agenda Views}) into a single buffer. The buffer is in
6421 @code{agenda-mode}, so there are commands to examine and manipulate
6422 the TODO entries directly from that buffer (@pxref{Agenda commands}).
6425 @cindex TODO keyword matching
6426 @vindex org-todo-keywords
6427 Like the above, but allows selection of a specific TODO keyword. You
6428 can also do this by specifying a prefix argument to @kbd{C-c a t}. With
6429 a @kbd{C-u} prefix you are prompted for a keyword, and you may also
6430 specify several keywords by separating them with @samp{|} as the boolean OR
6431 operator. With a numeric prefix, the nth keyword in
6432 @code{org-todo-keywords} is selected.
6434 The @kbd{r} key in the agenda buffer regenerates it, and you can give
6435 a prefix argument to this command to change the selected TODO keyword,
6436 for example @kbd{3 r}. If you often need a search for a specific
6437 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
6438 Matching specific TODO keywords can also be done as part of a tags
6439 search (@pxref{Tag searches}).
6442 Remote editing of TODO items means that you can change the state of a
6443 TODO entry with a single key press. The commands available in the
6444 TODO list are described in @ref{Agenda commands}.
6446 @cindex sublevels, inclusion into TODO list
6447 Normally the global TODO list simply shows all headlines with TODO
6448 keywords. This list can become very long. There are two ways to keep
6452 @vindex org-agenda-todo-ignore-scheduled
6453 @vindex org-agenda-todo-ignore-deadlines
6454 @vindex org-agenda-todo-ignore-with-date
6455 Some people view a TODO item that has been @emph{scheduled} for execution or
6456 have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}.
6457 Configure the variables @code{org-agenda-todo-ignore-scheduled},
6458 @code{org-agenda-todo-ignore-deadlines}, and/or
6459 @code{org-agenda-todo-ignore-with-date} to exclude such items from the
6462 @vindex org-agenda-todo-list-sublevels
6463 TODO items may have sublevels to break up the task into subtasks. In
6464 such cases it may be enough to list only the highest level TODO headline
6465 and omit the sublevels from the global list. Configure the variable
6466 @code{org-agenda-todo-list-sublevels} to get this behavior.
6469 @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views
6470 @subsection Matching tags and properties
6471 @cindex matching, of tags
6472 @cindex matching, of properties
6476 If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}),
6477 or have properties (@pxref{Properties and Columns}), you can select headlines
6478 based on this metadata and collect them into an agenda buffer. The match
6479 syntax described here also applies when creating sparse trees with @kbd{C-c /
6485 Produce a list of all headlines that match a given set of tags. The
6486 command prompts for a selection criterion, which is a boolean logic
6487 expression with tags, like @samp{+work+urgent-withboss} or
6488 @samp{work|home} (@pxref{Tags}). If you often need a specific search,
6489 define a custom command for it (@pxref{Agenda dispatcher}).
6492 @vindex org-tags-match-list-sublevels
6493 @vindex org-agenda-tags-todo-honor-ignore-options
6494 Like @kbd{C-c a m}, but only select headlines that are also TODO items and
6495 force checking subitems (see variable @code{org-tags-match-list-sublevels}).
6496 To exclude scheduled/deadline items, see the variable
6497 @code{org-agenda-tags-todo-honor-ignore-options}. Matching specific TODO
6498 keywords together with a tags match is also possible, see @ref{Tag searches}.
6501 The commands available in the tags list are described in @ref{Agenda
6504 @subsubheading Match syntax
6506 @cindex Boolean logic, for tag/property searches
6507 A search string can use Boolean operators @samp{&} for AND and @samp{|} for
6508 OR. @samp{&} binds more strongly than @samp{|}. Parentheses are currently
6509 not implemented. Each element in the search is either a tag, a regular
6510 expression matching tags, or an expression like @code{PROPERTY OPERATOR
6511 VALUE} with a comparison operator, accessing a property value. Each element
6512 may be preceded by @samp{-}, to select against it, and @samp{+} is syntactic
6513 sugar for positive selection. The AND operator @samp{&} is optional when
6514 @samp{+} or @samp{-} is present. Here are some examples, using only tags.
6518 Select headlines tagged @samp{:work:}, but discard those also tagged
6521 Selects lines tagged @samp{:work:} or @samp{:laptop:}.
6522 @item work|laptop+night
6523 Like before, but require the @samp{:laptop:} lines to be tagged also
6527 @cindex regular expressions, with tags search
6528 Instead of a tag, you may also specify a regular expression enclosed in curly
6529 braces. For example,
6530 @samp{work+@{^boss.*@}} matches headlines that contain the tag
6531 @samp{:work:} and any tag @i{starting} with @samp{boss}.
6533 @cindex TODO keyword matching, with tags search
6534 @cindex level, require for tags/property match
6535 @cindex category, require for tags/property match
6536 @vindex org-odd-levels-only
6537 You may also test for properties (@pxref{Properties and Columns}) at the same
6538 time as matching tags. The properties may be real properties, or special
6539 properties that represent other metadata (@pxref{Special properties}). For
6540 example, the ``property'' @code{TODO} represents the TODO keyword of the
6541 entry. Or, the ``property'' @code{LEVEL} represents the level of an entry.
6542 So a search @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines
6543 that have the tag @samp{boss} and are @emph{not} marked with the TODO keyword
6544 DONE. In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not
6545 count the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc.
6547 Here are more examples:
6549 @item work+TODO="WAITING"
6550 Select @samp{:work:}-tagged TODO lines with the specific TODO
6551 keyword @samp{WAITING}.
6552 @item work+TODO="WAITING"|home+TODO="WAITING"
6553 Waiting tasks both at work and at home.
6556 When matching properties, a number of different operators can be used to test
6557 the value of a property. Here is a complex example:
6560 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 \
6561 +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
6565 The type of comparison will depend on how the comparison value is written:
6568 If the comparison value is a plain number, a numerical comparison is done,
6569 and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
6570 @samp{>=}, and @samp{<>}.
6572 If the comparison value is enclosed in double-quotes,
6573 a string comparison is done, and the same operators are allowed.
6575 If the comparison value is enclosed in double-quotes @emph{and} angular
6576 brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
6577 assumed to be date/time specifications in the standard Org way, and the
6578 comparison will be done accordingly. Special values that will be recognized
6579 are @code{"<now>"} for now (including time), and @code{"<today>"}, and
6580 @code{"<tomorrow>"} for these days at 0:00 hours, @ie without a time
6581 specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
6582 @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
6583 respectively, can be used.
6585 If the comparison value is enclosed
6586 in curly braces, a regexp match is performed, with @samp{=} meaning that the
6587 regexp matches the property value, and @samp{<>} meaning that it does not
6591 So the search string in the example finds entries tagged @samp{:work:} but
6592 not @samp{:boss:}, which also have a priority value @samp{A}, a
6593 @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
6594 property that is numerically smaller than 2, a @samp{:With:} property that is
6595 matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
6596 on or after October 11, 2008.
6598 Accessing TODO, LEVEL, and CATEGORY during a search is fast. Accessing any
6599 other properties will slow down the search. However, once you have paid the
6600 price by accessing one property, testing additional properties is cheap
6603 You can configure Org mode to use property inheritance during a search, but
6604 beware that this can slow down searches considerably. See @ref{Property
6605 inheritance}, for details.
6607 For backward compatibility, and also for typing speed, there is also a
6608 different way to test TODO states in a search. For this, terminate the
6609 tags/property part of the search string (which may include several terms
6610 connected with @samp{|}) with a @samp{/} and then specify a Boolean
6611 expression just for TODO keywords. The syntax is then similar to that for
6612 tags, but should be applied with care: for example, a positive
6613 selection on several TODO keywords cannot meaningfully be combined with
6614 boolean AND. However, @emph{negative selection} combined with AND can be
6615 meaningful. To make sure that only lines are checked that actually have any
6616 TODO keyword (resulting in a speed-up), use @kbd{C-c a M}, or equivalently
6617 start the TODO part after the slash with @samp{!}. Examples:
6621 Same as @samp{work+TODO="WAITING"}
6622 @item work/!-WAITING-NEXT
6623 Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
6625 @item work/!+WAITING|+NEXT
6626 Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
6630 @node Timeline, Keyword search, Matching tags and properties, Built-in agenda views
6631 @subsection Timeline for a single file
6632 @cindex timeline, single file
6633 @cindex time-sorted view
6635 The timeline summarizes all time-stamped items from a single Org mode
6636 file in a @emph{time-sorted view}. The main purpose of this command is
6637 to give an overview over events in a project.
6642 Show a time-sorted view of the Org file, with all time-stamped items.
6643 When called with a @kbd{C-u} prefix, all unfinished TODO entries
6644 (scheduled or not) are also listed under the current date.
6648 The commands available in the timeline buffer are listed in
6649 @ref{Agenda commands}.
6651 @node Keyword search, Stuck projects, Timeline, Built-in agenda views
6652 @subsection Keyword search
6653 @cindex keyword search
6654 @cindex searching, for keywords
6656 This agenda view is a general text search facility for Org mode entries.
6657 It is particularly useful to find notes.
6662 This is a special search that lets you select entries by keywords or
6663 regular expression, using a boolean logic. For example, the search
6667 +computer +wifi -ethernet -@{8\.11[bg]@}
6671 will search for note entries that contain the keywords @code{computer}
6672 and @code{wifi}, but not the keyword @code{ethernet}, and which are also
6673 not matched by the regular expression @code{8\.11[bg]}, meaning to
6674 exclude both 8.11b and 8.11g.
6676 @vindex org-agenda-text-search-extra-files
6677 Note that in addition to the agenda files, this command will also search
6678 the files listed in @code{org-agenda-text-search-extra-files}.
6681 @node Stuck projects, , Keyword search, Built-in agenda views
6682 @subsection Stuck projects
6684 If you are following a system like David Allen's GTD to organize your
6685 work, one of the ``duties'' you have is a regular review to make sure
6686 that all projects move along. A @emph{stuck} project is a project that
6687 has no defined next actions, so it will never show up in the TODO lists
6688 Org mode produces. During the review, you need to identify such
6689 projects and define next actions for them.
6694 List projects that are stuck.
6697 @vindex org-stuck-projects
6698 Customize the variable @code{org-stuck-projects} to define what a stuck
6699 project is and how to find it.
6702 You almost certainly will have to configure this view before it will
6703 work for you. The built-in default assumes that all your projects are
6704 level-2 headlines, and that a project is not stuck if it has at least
6705 one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
6707 Let's assume that you, in your own way of using Org mode, identify
6708 projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
6709 indicate a project that should not be considered yet. Let's further
6710 assume that the TODO keyword DONE marks finished projects, and that NEXT
6711 and TODO indicate next actions. The tag @@SHOP indicates shopping and
6712 is a next action even without the NEXT tag. Finally, if the project
6713 contains the special word IGNORE anywhere, it should not be listed
6714 either. In this case you would start by identifying eligible projects
6715 with a tags/todo match@footnote{@xref{Tag searches}.}
6716 @samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT, @@SHOP, and
6717 IGNORE in the subtree to identify projects that are not stuck. The
6718 correct customization for this is
6721 (setq org-stuck-projects
6722 '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
6726 Note that if a project is identified as non-stuck, the subtree of this entry
6727 will still be searched for stuck projects.
6729 @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views
6730 @section Presentation and sorting
6731 @cindex presentation, of agenda items
6733 @vindex org-agenda-prefix-format
6734 Before displaying items in an agenda view, Org mode visually prepares
6735 the items and sorts them. Each item occupies a single line. The line
6736 starts with a @emph{prefix} that contains the @emph{category}
6737 (@pxref{Categories}) of the item and other important information. You can
6738 customize the prefix using the option @code{org-agenda-prefix-format}.
6739 The prefix is followed by a cleaned-up version of the outline headline
6740 associated with the item.
6743 * Categories:: Not all tasks are equal
6744 * Time-of-day specifications:: How the agenda knows the time
6745 * Sorting of agenda items:: The order of things
6748 @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting
6749 @subsection Categories
6752 The category is a broad label assigned to each agenda item. By default,
6753 the category is simply derived from the file name, but you can also
6754 specify it with a special line in the buffer, like this@footnote{For
6755 backward compatibility, the following also works: if there are several
6756 such lines in a file, each specifies the category for the text below it.
6757 The first category also applies to any text before the first CATEGORY
6758 line. However, using this method is @emph{strongly} deprecated as it is
6759 incompatible with the outline structure of the document. The correct
6760 method for setting multiple categories in a buffer is using a
6768 @cindex property, CATEGORY
6769 If you would like to have a special CATEGORY for a single entry or a
6770 (sub)tree, give the entry a @code{:CATEGORY:} property with the
6771 special category you want to apply as the value.
6774 The display in the agenda buffer looks best if the category is not
6775 longer than 10 characters.
6777 @node Time-of-day specifications, Sorting of agenda items, Categories, Presentation and sorting
6778 @subsection Time-of-day specifications
6779 @cindex time-of-day specification
6781 Org mode checks each agenda item for a time-of-day specification. The
6782 time can be part of the timestamp that triggered inclusion into the
6783 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time
6784 ranges can be specified with two timestamps, like
6786 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
6788 In the headline of the entry itself, a time(range) may also appear as
6789 plain text (like @samp{12:45} or a @samp{8:30-1pm}). If the agenda
6790 integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
6791 specifications in diary entries are recognized as well.
6793 For agenda display, Org mode extracts the time and displays it in a
6794 standard 24 hour format as part of the prefix. The example times in
6795 the previous paragraphs would end up in the agenda like this:
6798 8:30-13:00 Arthur Dent lies in front of the bulldozer
6799 12:45...... Ford Prefect arrives and takes Arthur to the pub
6800 19:00...... The Vogon reads his poem
6801 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
6805 If the agenda is in single-day mode, or for the display of today, the
6806 timed entries are embedded in a time grid, like
6809 8:00...... ------------------
6810 8:30-13:00 Arthur Dent lies in front of the bulldozer
6811 10:00...... ------------------
6812 12:00...... ------------------
6813 12:45...... Ford Prefect arrives and takes Arthur to the pub
6814 14:00...... ------------------
6815 16:00...... ------------------
6816 18:00...... ------------------
6817 19:00...... The Vogon reads his poem
6818 20:00...... ------------------
6819 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
6822 @vindex org-agenda-use-time-grid
6823 @vindex org-agenda-time-grid
6824 The time grid can be turned on and off with the variable
6825 @code{org-agenda-use-time-grid}, and can be configured with
6826 @code{org-agenda-time-grid}.
6828 @node Sorting of agenda items, , Time-of-day specifications, Presentation and sorting
6829 @subsection Sorting of agenda items
6830 @cindex sorting, of agenda items
6831 @cindex priorities, of agenda items
6832 Before being inserted into a view, the items are sorted. How this is
6833 done depends on the type of view.
6836 @vindex org-agenda-files
6837 For the daily/weekly agenda, the items for each day are sorted. The
6838 default order is to first collect all items containing an explicit
6839 time-of-day specification. These entries will be shown at the beginning
6840 of the list, as a @emph{schedule} for the day. After that, items remain
6841 grouped in categories, in the sequence given by @code{org-agenda-files}.
6842 Within each category, items are sorted by priority (@pxref{Priorities}),
6843 which is composed of the base priority (2000 for priority @samp{A}, 1000
6844 for @samp{B}, and 0 for @samp{C}), plus additional increments for
6845 overdue scheduled or deadline items.
6847 For the TODO list, items remain in the order of categories, but within
6848 each category, sorting takes place according to priority
6849 (@pxref{Priorities}). The priority used for sorting derives from the
6850 priority cookie, with additions depending on how close an item is to its due
6853 For tags matches, items are not sorted at all, but just appear in the
6854 sequence in which they are found in the agenda files.
6857 @vindex org-agenda-sorting-strategy
6858 Sorting can be customized using the variable
6859 @code{org-agenda-sorting-strategy}, and may also include criteria based on
6860 the estimated effort of an entry (@pxref{Effort estimates}).
6862 @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda Views
6863 @section Commands in the agenda buffer
6864 @cindex commands, in agenda buffer
6866 Entries in the agenda buffer are linked back to the Org file or diary
6867 file where they originate. You are not allowed to edit the agenda
6868 buffer itself, but commands are provided to show and jump to the
6869 original entry location, and to edit the Org files ``remotely'' from
6870 the agenda buffer. In this way, all information is stored only once,
6871 removing the risk that your agenda and note files may diverge.
6873 Some commands can be executed with mouse clicks on agenda lines. For
6874 the other commands, the cursor needs to be in the desired line.
6877 @tsubheading{Motion}
6878 @cindex motion commands in agenda
6881 Next line (same as @key{up} and @kbd{C-p}).
6884 Previous line (same as @key{down} and @kbd{C-n}).
6885 @tsubheading{View/Go to Org file}
6890 Display the original location of the item in another window.
6891 With prefix arg, make sure that the entire entry is made visible in the
6892 outline, not only the heading.
6896 Display original location and recenter that window.
6904 Go to the original location of the item in another window. Under Emacs
6905 22, @kbd{mouse-1} will also works for this.
6909 Go to the original location of the item and delete other windows.
6913 @vindex org-agenda-start-with-follow-mode
6914 Toggle Follow mode. In Follow mode, as you move the cursor through
6915 the agenda buffer, the other window always shows the corresponding
6916 location in the Org file. The initial setting for this mode in new
6917 agenda buffers can be set with the variable
6918 @code{org-agenda-start-with-follow-mode}.
6922 Display the entire subtree of the current item in an indirect buffer. With a
6923 numeric prefix argument N, go up to level N and then take that tree. If N is
6924 negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the
6925 previously used indirect buffer.
6929 Follow a link in the entry. This will offer a selection of any links in the
6930 text belonging to the referenced Org node. If there is only one link, it
6931 will be followed without a selection prompt.
6933 @tsubheading{Change display}
6934 @cindex display changing, in agenda
6937 Delete other windows.
6945 @item v d @ @r{or short} @ d
6946 @itemx v w @ @r{or short} @ w
6949 Switch to day/week/month/year view. When switching to day or week view,
6950 this setting becomes the default for subsequent agenda commands. Since
6951 month and year views are slow to create, they do not become the default.
6952 A numeric prefix argument may be used to jump directly to a specific day
6953 of the year, ISO week, month, or year, respectively. For example,
6954 @kbd{32 d} jumps to February 1st, @kbd{9 w} to ISO week number 9. When
6955 setting day, week, or month view, a year may be encoded in the prefix
6956 argument as well. For example, @kbd{200712 w} will jump to week 12 in
6957 2007. If such a year specification has only one or two digits, it will
6958 be mapped to the interval 1938-2037.
6962 @vindex org-agenda-ndays
6963 Go forward in time to display the following @code{org-agenda-ndays} days.
6964 For example, if the display covers a week, switch to the following week.
6965 With prefix arg, go forward that many times @code{org-agenda-ndays} days.
6969 Go backward in time to display earlier dates.
6977 Prompt for a date and go there.
6981 Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}.
6985 @item v l @ @r{or short} @ l
6986 @vindex org-log-done
6987 @vindex org-agenda-log-mode-items
6988 Toggle Logbook mode. In Logbook mode, entries that were marked DONE while
6989 logging was on (variable @code{org-log-done}) are shown in the agenda, as are
6990 entries that have been clocked on that day. You can configure the entry
6991 types that should be included in log mode using the variable
6992 @code{org-agenda-log-mode-items}. When called with a @kbd{C-u} prefix, show
6993 all possible logbook entries, including state changes. When called with two
6994 prefix args @kbd{C-u C-u}, show only logging information, nothing else.
6998 @item v [ @ @r{or short} @ [
6999 Include inactive timestamps into the current view. Only for weekly/daily
7000 agenda and timeline views.
7006 Toggle Archives mode. In Archives mode, trees that are marked
7007 @code{ARCHIVED} are also scanned when producing the agenda. When you use the
7008 capital @kbd{A}, even all archive files are included. To exit archives mode,
7009 press @kbd{v a} again.
7013 @item v R @ @r{or short} @ R
7014 @vindex org-agenda-start-with-clockreport-mode
7015 Toggle Clockreport mode. In Clockreport mode, the daily/weekly agenda will
7016 always show a table with the clocked times for the timespan and file scope
7017 covered by the current agenda view. The initial setting for this mode in new
7018 agenda buffers can be set with the variable
7019 @code{org-agenda-start-with-clockreport-mode}.
7023 @item v E @ @r{or short} @ E
7024 @vindex org-agenda-start-with-entry-text-mode
7025 @vindex org-agenda-entry-text-maxlines
7026 Toggle entry text mode. In entry text mode, a number of lines from the Org
7027 outline node referenced by an agenda line will be displayed below the line.
7028 The maximum number of lines is given by the variable
7029 @code{org-agenda-entry-text-maxlines}. Calling this command with a numeric
7030 prefix argument will temporarily modify that number to the prefix value.
7034 @vindex org-agenda-use-time-grid
7035 @vindex org-agenda-time-grid
7036 Toggle the time grid on and off. See also the variables
7037 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
7041 Recreate the agenda buffer, for example to reflect the changes after
7042 modification of the timestamps of items with @kbd{S-@key{left}} and
7043 @kbd{S-@key{right}}. When the buffer is the global TODO list, a prefix
7044 argument is interpreted to create a selective list for a specific TODO
7054 Save all Org buffers in the current Emacs session, and also the locations of
7059 @vindex org-columns-default-format
7060 Invoke column view (@pxref{Column view}) in the agenda buffer. The column
7061 view format is taken from the entry at point, or (if there is no entry at
7062 point), from the first entry in the agenda view. So whatever the format for
7063 that entry would be in the original buffer (taken from a property, from a
7064 @code{#+COLUMNS} line, or from the default variable
7065 @code{org-columns-default-format}), will be used in the agenda.
7069 Remove the restriction lock on the agenda, if it is currently restricted to a
7070 file or subtree (@pxref{Agenda files}).
7072 @tsubheading{Secondary filtering and query editing}
7073 @cindex filtering, by tag and effort, in agenda
7074 @cindex tag filtering, in agenda
7075 @cindex effort filtering, in agenda
7076 @cindex query editing, in agenda
7080 @vindex org-agenda-filter-preset
7081 Filter the current agenda view with respect to a tag and/or effort estimates.
7082 The difference between this and a custom agenda command is that filtering is
7083 very fast, so that you can switch quickly between different filters without
7084 having to recreate the agenda@footnote{Custom commands can preset a filter by
7085 binding the variable @code{org-agenda-filter-preset} as an option. This
7086 filter will then be applied to the view and persist as a basic filter through
7087 refreshes and more secondary filtering.}
7089 You will be prompted for a tag selection letter. Pressing @key{TAB} at that
7090 prompt will offer use completion to select a tag (including any tags that do
7091 not have a selection character). The command then hides all entries that do
7092 not contain or inherit this tag. When called with prefix arg, remove the
7093 entries that @emph{do} have the tag. A second @kbd{/} at the prompt will
7094 turn off the filter and unhide any hidden entries. If the first key you
7095 press is either @kbd{+} or @kbd{-}, the previous filter will be narrowed by
7096 requiring or forbidding the selected additional tag. Instead of pressing
7097 @kbd{+} or @kbd{-} after @kbd{/}, you can also immediately use the @kbd{\}
7100 @vindex org-sort-agenda-noeffort-is-high
7101 In order to filter for effort estimates, you should set-up allowed
7102 efforts globally, for example
7104 (setq org-global-properties
7105 '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
7107 You can then filter for an effort by first typing an operator, one of
7108 @kbd{<}, @kbd{>}, and @kbd{=}, and then the one-digit index of an effort
7109 estimate in your array of allowed values, where @kbd{0} means the 10th value.
7110 The filter will then restrict to entries with effort smaller-or-equal, equal,
7111 or larger-or-equal than the selected value. If the digits 0-9 are not used
7112 as fast access keys to tags, you can also simply press the index digit
7113 directly without an operator. In this case, @kbd{<} will be assumed. For
7114 application of the operator, entries without a defined effort will be treated
7115 according to the value of @code{org-sort-agenda-noeffort-is-high}. To filter
7116 for tasks without effort definition, press @kbd{?} as the operator.
7120 Narrow the current agenda filter by an additional condition. When called with
7121 prefix arg, remove the entries that @emph{do} have the tag, or that do match
7122 the effort criterion. You can achieve the same effect by pressing @kbd{+} or
7123 @kbd{-} as the first key after the @kbd{/} command.
7131 @item @r{in} search view
7132 add new search words (@kbd{[} and @kbd{]}) or new regular expressions
7133 (@kbd{@{} and @kbd{@}}) to the query string. The opening bracket/brace will
7134 add a positive search term prefixed by @samp{+}, indicating that this search
7135 term @i{must} occur/match in the entry. The closing bracket/brace will add a
7136 negative search term which @i{must not} occur/match in the entry for it to be
7140 @tsubheading{Remote editing}
7141 @cindex remote editing, from agenda
7146 @cindex undoing remote-editing events
7147 @cindex remote editing, undo
7150 Undo a change due to a remote editing command. The change is undone
7151 both in the agenda buffer and in the remote buffer.
7155 Change the TODO state of the item, both in the agenda and in the
7160 @vindex org-agenda-confirm-kill
7161 Delete the current agenda item along with the entire subtree belonging
7162 to it in the original Org file. If the text to be deleted remotely
7163 is longer than one line, the kill needs to be confirmed by the user. See
7164 variable @code{org-agenda-confirm-kill}.
7168 Refile the entry at point.
7172 Toggle the ARCHIVE tag for the current headline.
7176 Move the subtree corresponding to the current entry to its @emph{archive
7181 Archive the subtree corresponding to the current headline. This means the
7182 entry will be moved to the configured archive location, most likely a
7187 @vindex org-agenda-show-inherited-tags
7188 Show all tags associated with the current item. This is useful if you have
7189 turned off @code{org-agenda-show-inherited-tags}, but still want to see all
7190 tags of a headline occasionally.
7194 Set tags for the current headline. If there is an active region in the
7195 agenda, change a tag for all headings in the region.
7199 Set the priority for the current item. Org mode prompts for the
7200 priority character. If you reply with @key{SPC}, the priority cookie
7201 is removed from the entry.
7205 Display weighted priority of current item.
7211 Increase the priority of the current item. The priority is changed in
7212 the original buffer, but the agenda is not resorted. Use the @kbd{r}
7216 @kindex S-@key{down}
7219 Decrease the priority of the current item.
7223 @vindex org-log-into-drawer
7224 Add a note to the entry. This note will be recorded, and then files to the
7225 same location where state change notes are put. Depending on
7226 @code{org-log-into-drawer}, this maybe inside a drawer.
7230 Dispatcher for all command related to attachments.
7238 Set a deadline for this item.
7242 Agenda actions, to set dates for selected items to the cursor date.
7243 This command also works in the calendar! The command prompts for an
7246 m @r{Mark the entry at point for action. You can also make entries}
7247 @r{in Org files with @kbd{C-c C-x C-k}.}
7248 d @r{Set the deadline of the marked entry to the date at point.}
7249 s @r{Schedule the marked entry at the date at point.}
7250 r @r{Call @code{org-remember} with the cursor date as default date.}
7253 Press @kbd{r} afterward to refresh the agenda and see the effect of the
7256 @kindex S-@key{right}
7258 Change the timestamp associated with the current line by one day into the
7259 future. With a numeric prefix argument, change it by that many days. For
7260 example, @kbd{3 6 5 S-@key{right}} will change it by a year. With a
7261 @kbd{C-u} prefix, change the time by one hour. If you immediately repeat the
7262 command, it will continue to change hours even without the prefix arg. With
7263 a double @kbd{C-u C-u} prefix, do the same for changing minutes. The stamp
7264 is changed in the original Org file, but the change is not directly reflected
7265 in the agenda buffer. Use @kbd{r} or @kbd{g} to update the buffer.
7267 @kindex S-@key{left}
7269 Change the timestamp associated with the current line by one day
7274 Change the timestamp associated with the current line to today.
7275 The key @kbd{>} has been chosen, because it is the same as @kbd{S-.}
7280 Start the clock on the current item. If a clock is running already, it
7285 Stop the previously started clock.
7289 Cancel the currently running clock.
7293 Jump to the running clock in another window.
7295 @tsubheading{Bulk remote editing selected entries}
7296 @cindex remote editing, bulk, from agenda
7300 Mark the entry at point for bulk action.
7304 Unmark entry for bulk action.
7308 Unmark all marked entries for bulk action.
7312 Bulk action: act on all marked entries in the agenda. This will prompt for
7313 another key to select the action to be applied:
7315 r @r{Prompt for a single refile target and move all entries. The entries}
7316 @r{will no longer be in the agenda, refresh (@kbd{g}) to bring them back.}
7317 $ @r{Archive all selected entries.}
7318 A @r{Archive entries by moving them to their respective archive siblings.}
7319 t @r{Change TODO state. This prompts for a single TODO keyword and}
7320 @r{changes the state of all selected entries, bypassing blocking and}
7321 @r{suppressing logging notes (but not time stamps).}
7322 + @r{Add a tag to all selected entries.}
7323 - @r{Remove a tag from all selected entries.}
7324 s @r{Schedule all items to a new date. To shift existing schedule dates}
7325 @r{by a fixed number of days, use something starting with double plus}
7326 @r{at the prompt, for example @samp{++8d} or @samp{++2w}.}
7327 d @r{Set deadline to a specific date.}
7331 @tsubheading{Calendar commands}
7332 @cindex calendar commands, from agenda
7335 Open the Emacs calendar and move to the date at the agenda cursor.
7338 When in the calendar, compute and show the Org mode agenda for the
7341 @cindex diary entries, creating from agenda
7344 Insert a new entry into the diary. Prompts for the type of entry
7345 (day, weekly, monthly, yearly, anniversary, cyclic) and creates a new
7346 entry in the diary, just as @kbd{i d}, etc., would do in the calendar.
7347 The date is taken from the cursor position.
7351 Show the phases of the moon for the three months around current date.
7355 Show sunrise and sunset times. The geographical location must be set
7356 with calendar variables, see the documentation for the Emacs calendar.
7360 Convert the date at cursor into many other cultural and historic
7365 Show holidays for three months around the cursor date.
7367 @item M-x org-export-icalendar-combine-agenda-files
7368 Export a single iCalendar file containing entries from all agenda files.
7369 This is a globally available command, and also available in the agenda menu.
7371 @tsubheading{Exporting to a file}
7374 @cindex exporting agenda views
7375 @cindex agenda views, exporting
7376 @vindex org-agenda-exporter-settings
7377 Write the agenda view to a file. Depending on the extension of the selected
7378 file name, the view will be exported as HTML (extension @file{.html} or
7379 @file{.htm}), Postscript (extension @file{.ps}), PDF (extension @file{.pdf}),
7380 or plain text (any other extension). When called with a @kbd{C-u} prefix
7381 argument, immediately open the newly created file. Use the variable
7382 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
7383 for @file{htmlize} to be used during export.
7385 @tsubheading{Quit and Exit}
7388 Quit agenda, remove the agenda buffer.
7391 @cindex agenda files, removing buffers
7393 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
7394 for the compilation of the agenda. Buffers created by the user to
7395 visit Org files will not be removed.
7399 @node Custom agenda views, Exporting Agenda Views, Agenda commands, Agenda Views
7400 @section Custom agenda views
7401 @cindex custom agenda views
7402 @cindex agenda views, custom
7404 Custom agenda commands serve two purposes: to store and quickly access
7405 frequently used TODO and tags searches, and to create special composite
7406 agenda buffers. Custom agenda commands will be accessible through the
7407 dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
7410 * Storing searches:: Type once, use often
7411 * Block agenda:: All the stuff you need in a single buffer
7412 * Setting Options:: Changing the rules
7415 @node Storing searches, Block agenda, Custom agenda views, Custom agenda views
7416 @subsection Storing searches
7418 The first application of custom searches is the definition of keyboard
7419 shortcuts for frequently used searches, either creating an agenda
7420 buffer, or a sparse tree (the latter covering of course only the current
7423 @vindex org-agenda-custom-commands
7424 Custom commands are configured in the variable
7425 @code{org-agenda-custom-commands}. You can customize this variable, for
7426 example by pressing @kbd{C-c a C}. You can also directly set it with
7427 Emacs Lisp in @file{.emacs}. The following example contains all valid
7432 (setq org-agenda-custom-commands
7433 '(("w" todo "WAITING")
7434 ("W" todo-tree "WAITING")
7435 ("u" tags "+boss-urgent")
7436 ("v" tags-todo "+boss-urgent")
7437 ("U" tags-tree "+boss-urgent")
7438 ("f" occur-tree "\\<FIXME\\>")
7439 ("h" . "HOME+Name tags searches") ; description for "h" prefix
7440 ("hl" tags "+home+Lisa")
7441 ("hp" tags "+home+Peter")
7442 ("hk" tags "+home+Kim")))
7447 The initial string in each entry defines the keys you have to press
7448 after the dispatcher command @kbd{C-c a} in order to access the command.
7449 Usually this will be just a single character, but if you have many
7450 similar commands, you can also define two-letter combinations where the
7451 first character is the same in several combinations and serves as a
7452 prefix key@footnote{You can provide a description for a prefix key by
7453 inserting a cons cell with the prefix and the description.}. The second
7454 parameter is the search type, followed by the string or regular
7455 expression to be used for the matching. The example above will
7460 as a global search for TODO entries with @samp{WAITING} as the TODO
7463 as the same search, but only in the current buffer and displaying the
7464 results as a sparse tree
7466 as a global tags search for headlines marked @samp{:boss:} but not
7469 as the same search as @kbd{C-c a u}, but limiting the search to
7470 headlines that are also TODO items
7472 as the same search as @kbd{C-c a u}, but only in the current buffer and
7473 displaying the result as a sparse tree
7475 to create a sparse tree (again: current buffer only) with all entries
7476 containing the word @samp{FIXME}
7478 as a prefix command for a HOME tags search where you have to press an
7479 additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
7480 Peter, or Kim) as additional tag to match.
7483 @node Block agenda, Setting Options, Storing searches, Custom agenda views
7484 @subsection Block agenda
7485 @cindex block agenda
7486 @cindex agenda, with block views
7488 Another possibility is the construction of agenda views that comprise
7489 the results of @emph{several} commands, each of which creates a block in
7490 the agenda buffer. The available commands include @code{agenda} for the
7491 daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
7492 for the global TODO list (as constructed with @kbd{C-c a t}), and the
7493 matching commands discussed above: @code{todo}, @code{tags}, and
7494 @code{tags-todo}. Here are two examples:
7498 (setq org-agenda-custom-commands
7499 '(("h" "Agenda and Home-related tasks"
7503 ("o" "Agenda and Office-related tasks"
7511 This will define @kbd{C-c a h} to create a multi-block view for stuff
7512 you need to attend to at home. The resulting agenda buffer will contain
7513 your agenda for the current week, all TODO items that carry the tag
7514 @samp{home}, and also all lines tagged with @samp{garden}. Finally the
7515 command @kbd{C-c a o} provides a similar view for office tasks.
7517 @node Setting Options, , Block agenda, Custom agenda views
7518 @subsection Setting options for custom commands
7519 @cindex options, for custom agenda views
7521 @vindex org-agenda-custom-commands
7522 Org mode contains a number of variables regulating agenda construction
7523 and display. The global variables define the behavior for all agenda
7524 commands, including the custom commands. However, if you want to change
7525 some settings just for a single custom view, you can do so. Setting
7526 options requires inserting a list of variable names and values at the
7527 right spot in @code{org-agenda-custom-commands}. For example:
7531 (setq org-agenda-custom-commands
7532 '(("w" todo "WAITING"
7533 ((org-agenda-sorting-strategy '(priority-down))
7534 (org-agenda-prefix-format " Mixed: ")))
7535 ("U" tags-tree "+boss-urgent"
7536 ((org-show-following-heading nil)
7537 (org-show-hierarchy-above nil)))
7539 ((org-agenda-files '("~org/notes.org"))
7540 (org-agenda-text-search-extra-files nil)))))
7545 Now the @kbd{C-c a w} command will sort the collected entries only by
7546 priority, and the prefix format is modified to just say @samp{ Mixed: }
7547 instead of giving the category of the entry. The sparse tags tree of
7548 @kbd{C-c a U} will now turn out ultra-compact, because neither the
7549 headline hierarchy above the match, nor the headline following the match
7550 will be shown. The command @kbd{C-c a N} will do a text search limited
7551 to only a single file.
7553 @vindex org-agenda-custom-commands
7554 For command sets creating a block agenda,
7555 @code{org-agenda-custom-commands} has two separate spots for setting
7556 options. You can add options that should be valid for just a single
7557 command in the set, and options that should be valid for all commands in
7558 the set. The former are just added to the command entry, the latter
7559 must come after the list of command entries. Going back to the block
7560 agenda example (@pxref{Block agenda}), let's change the sorting strategy
7561 for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
7562 the results for GARDEN tags query in the opposite order,
7563 @code{priority-up}. This would look like this:
7567 (setq org-agenda-custom-commands
7568 '(("h" "Agenda and Home-related tasks"
7572 ((org-agenda-sorting-strategy '(priority-up)))))
7573 ((org-agenda-sorting-strategy '(priority-down))))
7574 ("o" "Agenda and Office-related tasks"
7581 As you see, the values and parentheses setting is a little complex.
7582 When in doubt, use the customize interface to set this variable---it
7583 fully supports its structure. Just one caveat: when setting options in
7584 this interface, the @emph{values} are just Lisp expressions. So if the
7585 value is a string, you need to add the double-quotes around the value
7589 @node Exporting Agenda Views, Agenda column view, Custom agenda views, Agenda Views
7590 @section Exporting Agenda Views
7591 @cindex agenda views, exporting
7593 If you are away from your computer, it can be very useful to have a printed
7594 version of some agenda views to carry around. Org mode can export custom
7595 agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's
7596 @file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the
7597 ghostscript @file{ps2pdf} utility must be installed on the system. Selecting
7598 a PDF file with also create the postscript file.}, and iCalendar files. If
7599 you want to do this only occasionally, use the command
7604 @cindex exporting agenda views
7605 @cindex agenda views, exporting
7606 @vindex org-agenda-exporter-settings
7607 Write the agenda view to a file. Depending on the extension of the
7608 selected file name, the view will be exported as HTML (extension
7609 @file{.html} or @file{.htm}), Postscript (extension @file{.ps}),
7610 iCalendar (extension @file{.ics}), or plain text (any other extension).
7611 Use the variable @code{org-agenda-exporter-settings} to
7612 set options for @file{ps-print} and for @file{htmlize} to be used during
7615 @vindex org-agenda-add-entry-text-maxlines
7616 @vindex htmlize-output-type
7617 @vindex ps-number-of-columns
7618 @vindex ps-landscape-mode
7620 (setq org-agenda-exporter-settings
7621 '((ps-number-of-columns 2)
7622 (ps-landscape-mode t)
7623 (org-agenda-add-entry-text-maxlines 5)
7624 (htmlize-output-type 'css)))
7628 If you need to export certain agenda views frequently, you can associate
7629 any custom agenda command with a list of output file names
7630 @footnote{If you want to store standard views like the weekly agenda
7631 or the global TODO list as well, you need to define custom commands for
7632 them in order to be able to specify file names.}. Here is an example
7633 that first defines custom commands for the agenda and the global
7634 TODO list, together with a number of files to which to export them.
7635 Then we define two block agenda commands and specify file names for them
7636 as well. File names can be relative to the current working directory,
7641 (setq org-agenda-custom-commands
7642 '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
7643 ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
7644 ("h" "Agenda and Home-related tasks"
7649 ("~/views/home.html"))
7650 ("o" "Agenda and Office-related tasks"
7655 ("~/views/office.ps" "~/calendars/office.ics"))))
7659 The extension of the file name determines the type of export. If it is
7660 @file{.html}, Org mode will use the @file{htmlize.el} package to convert
7661 the buffer to HTML and save it to this file name. If the extension is
7662 @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
7663 Postscript output. If the extension is @file{.ics}, iCalendar export is
7664 run export over all files that were used to construct the agenda, and
7665 limit the export to entries listed in the agenda. Any other
7666 extension produces a plain ASCII file.
7668 The export files are @emph{not} created when you use one of those
7669 commands interactively because this might use too much overhead.
7670 Instead, there is a special command to produce @emph{all} specified
7676 Export all agenda views that have export file names associated with
7680 You can use the options section of the custom agenda commands to also
7681 set options for the export commands. For example:
7684 (setq org-agenda-custom-commands
7686 ((ps-number-of-columns 2)
7687 (ps-landscape-mode t)
7688 (org-agenda-prefix-format " [ ] ")
7689 (org-agenda-with-colors nil)
7690 (org-agenda-remove-tags t))
7695 This command sets two options for the Postscript exporter, to make it
7696 print in two columns in landscape format---the resulting page can be cut
7697 in two and then used in a paper agenda. The remaining settings modify
7698 the agenda prefix to omit category and scheduling information, and
7699 instead include a checkbox to check off items. We also remove the tags
7700 to make the lines compact, and we don't want to use colors for the
7701 black-and-white printer. Settings specified in
7702 @code{org-agenda-exporter-settings} will also apply, but the settings
7703 in @code{org-agenda-custom-commands} take precedence.
7706 From the command line you may also use
7708 emacs -f org-batch-store-agenda-views -kill
7711 or, if you need to modify some parameters@footnote{Quoting depends on the
7712 system you use, please check the FAQ for examples.}
7714 emacs -eval '(org-batch-store-agenda-views \
7715 org-agenda-ndays 30 \
7716 org-agenda-start-day "2007-11-01" \
7717 org-agenda-include-diary nil \
7718 org-agenda-files (quote ("~/org/project.org")))' \
7722 which will create the agenda views restricted to the file
7723 @file{~/org/project.org}, without diary entries and with a 30-day
7726 You can also extract agenda information in a way that allows further
7727 processing by other programs. See @ref{Extracting agenda information}, for
7731 @node Agenda column view, , Exporting Agenda Views, Agenda Views
7732 @section Using column view in the agenda
7733 @cindex column view, in agenda
7734 @cindex agenda, column view
7736 Column view (@pxref{Column view}) is normally used to view and edit
7737 properties embedded in the hierarchical structure of an Org file. It can be
7738 quite useful to use column view also from the agenda, where entries are
7739 collected by certain criteria.
7744 Turn on column view in the agenda.
7747 To understand how to use this properly, it is important to realize that the
7748 entries in the agenda are no longer in their proper outline environment.
7749 This causes the following issues:
7753 @vindex org-columns-default-format
7754 @vindex org-overriding-columns-format
7755 Org needs to make a decision which @code{COLUMNS} format to use. Since the
7756 entries in the agenda are collected from different files, and different files
7757 may have different @code{COLUMNS} formats, this is a non-trivial problem.
7758 Org first checks if the variable @code{org-overriding-columns-format} is
7759 currently set, and if so, takes the format from there. Otherwise it takes
7760 the format associated with the first item in the agenda, or, if that item
7761 does not have a specific format (defined in a property, or in its file), it
7762 uses @code{org-columns-default-format}.
7764 @cindex property, special, CLOCKSUM
7765 If any of the columns has a summary type defined (@pxref{Column attributes}),
7766 turning on column view in the agenda will visit all relevant agenda files and
7767 make sure that the computations of this property are up to date. This is
7768 also true for the special @code{CLOCKSUM} property. Org will then sum the
7769 values displayed in the agenda. In the daily/weekly agenda, the sums will
7770 cover a single day, in all other views they cover the entire block. It is
7771 vital to realize that the agenda may show the same entry @emph{twice} (for
7772 example as scheduled and as a deadline), and it may show two entries from the
7773 same hierarchy (for example a @emph{parent} and its @emph{child}). In these
7774 cases, the summation in the agenda will lead to incorrect results because
7775 some values will count double.
7777 When the column view in the agenda shows the @code{CLOCKSUM}, that is always
7778 the entire clocked time for this item. So even in the daily/weekly agenda,
7779 the clocksum listed in column view may originate from times outside the
7780 current view. This has the advantage that you can compare these values with
7781 a column listing the planned total effort for a task---one of the major
7782 applications for column view in the agenda. If you want information about
7783 clocked time in the displayed period use clock table mode (press @kbd{R} in
7788 @node Embedded LaTeX, Exporting, Agenda Views, Top
7789 @chapter Embedded La@TeX{}
7790 @cindex @TeX{} interpretation
7791 @cindex La@TeX{} interpretation
7793 Plain ASCII is normally sufficient for almost all note taking. One
7794 exception, however, are scientific notes which need to be able to contain
7795 mathematical symbols and the occasional formula. La@TeX{}@footnote{La@TeX{}
7796 is a macro system based on Donald E. Knuth's @TeX{} system. Many of the
7797 features described here as ``La@TeX{}'' are really from @TeX{}, but for
7798 simplicity I am blurring this distinction.} is widely used to typeset
7799 scientific documents. Org mode supports embedding La@TeX{} code into its
7800 files, because many academics are used to reading La@TeX{} source code, and
7801 because it can be readily processed into images for HTML production.
7803 It is not necessary to mark La@TeX{} macros and code in any special way.
7804 If you observe a few conventions, Org mode knows how to find it and what
7808 * Math symbols:: @TeX{} macros for symbols and Greek letters
7809 * Subscripts and superscripts:: Simple syntax for raising/lowering text
7810 * LaTeX fragments:: Complex formulas made easy
7811 * Processing LaTeX fragments:: Previewing La@TeX{} processing
7812 * CDLaTeX mode:: Speed up entering of formulas
7815 @node Math symbols, Subscripts and superscripts, Embedded LaTeX, Embedded LaTeX
7816 @section Math symbols
7817 @cindex math symbols
7818 @cindex @TeX{} macros
7820 You can use La@TeX{} macros to insert special symbols like @samp{\alpha} to
7821 indicate the Greek letter, or @samp{\to} to indicate an arrow. Completion
7822 for these macros is available, just type @samp{\} and maybe a few letters,
7823 and press @kbd{M-@key{TAB}} to see possible completions. Unlike La@TeX{}
7824 code, Org mode allows these macros to be present without surrounding math
7825 delimiters, for example:
7828 Angles are written as Greek letters \alpha, \beta and \gamma.
7831 During HTML export (@pxref{HTML export}), these symbols are translated
7832 into the proper syntax for HTML, for the above examples this is
7833 @samp{α} and @samp{→}, respectively. If you need such a symbol
7834 inside a word, terminate it like this: @samp{\Aacute@{@}stor}.
7836 @node Subscripts and superscripts, LaTeX fragments, Math symbols, Embedded LaTeX
7837 @section Subscripts and superscripts
7841 Just like in La@TeX{}, @samp{^} and @samp{_} are used to indicate super-
7842 and subscripts. Again, these can be used without embedding them in
7843 math-mode delimiters. To increase the readability of ASCII text, it is
7844 not necessary (but OK) to surround multi-character sub- and superscripts
7845 with curly braces. For example
7848 The mass if the sun is M_sun = 1.989 x 10^30 kg. The radius of
7849 the sun is R_@{sun@} = 6.96 x 10^8 m.
7852 To avoid interpretation as raised or lowered text, you can quote
7853 @samp{^} and @samp{_} with a backslash: @samp{\^} and @samp{\_}.
7855 During HTML export (@pxref{HTML export}), subscript and superscripts
7856 are surrounded with @code{<sub>} and @code{<sup>} tags, respectively.
7858 @node LaTeX fragments, Processing LaTeX fragments, Subscripts and superscripts, Embedded LaTeX
7859 @section La@TeX{} fragments
7860 @cindex La@TeX{} fragments
7862 @vindex org-format-latex-header
7863 With symbols, sub- and superscripts, HTML is pretty much at its end when
7864 it comes to representing mathematical formulas@footnote{Yes, there is
7865 MathML, but that is not yet fully supported by many browsers, and there
7866 is no decent converter for turning La@TeX{} or ASCII representations of
7867 formulas into MathML. So for the time being, converting formulas into
7868 images seems the way to go.}. More complex expressions need a dedicated
7869 formula processor. To this end, Org mode can contain arbitrary La@TeX{}
7870 fragments. It provides commands to preview the typeset result of these
7871 fragments, and upon export to HTML, all fragments will be converted to
7872 images and inlined into the HTML document@footnote{The La@TeX{} export
7873 will not use images for displaying La@TeX{} fragments but include these
7874 fragments directly into the La@TeX{} code.}. For this to work you
7875 need to be on a system with a working La@TeX{} installation. You also
7876 need the @file{dvipng} program, available at
7877 @url{http://sourceforge.net/projects/dvipng/}. The La@TeX{} header that
7878 will be used when processing a fragment can be configured with the
7879 variable @code{org-format-latex-header}.
7881 La@TeX{} fragments don't need any special marking at all. The following
7882 snippets will be identified as La@TeX{} source code:
7885 Environments of any kind. The only requirement is that the
7886 @code{\begin} statement appears on a new line, preceded by only
7889 Text within the usual La@TeX{} math delimiters. To avoid conflicts with
7890 currency specifications, single @samp{$} characters are only recognized as
7891 math delimiters if the enclosed text contains at most two line breaks, is
7892 directly attached to the @samp{$} characters with no whitespace in between,
7893 and if the closing @samp{$} is followed by whitespace, punctuation or a dash.
7894 For the other delimiters, there is no such restriction, so when in doubt, use
7895 @samp{\(...\)} as inline math delimiters.
7898 @noindent For example:
7901 \begin@{equation@} % arbitrary environments,
7902 x=\sqrt@{b@} % even tables, figures
7903 \end@{equation@} % etc
7905 If $a^2=b$ and \( b=2 \), then the solution must be
7906 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
7910 @vindex org-format-latex-options
7911 If you need any of the delimiter ASCII sequences for other purposes, you
7912 can configure the option @code{org-format-latex-options} to deselect the
7913 ones you do not wish to have interpreted by the La@TeX{} converter.
7915 @node Processing LaTeX fragments, CDLaTeX mode, LaTeX fragments, Embedded LaTeX
7916 @section Processing LaTeX fragments
7917 @cindex LaTeX fragments, preview
7919 La@TeX{} fragments can be processed to produce preview images of the
7920 typeset expressions:
7925 Produce a preview image of the La@TeX{} fragment at point and overlay it
7926 over the source code. If there is no fragment at point, process all
7927 fragments in the current entry (between two headlines). When called
7928 with a prefix argument, process the entire subtree. When called with
7929 two prefix arguments, or when the cursor is before the first headline,
7930 process the entire buffer.
7933 Remove the overlay preview images.
7936 During HTML export (@pxref{HTML export}), all La@TeX{} fragments are
7937 converted into images and inlined into the document if the following
7941 (setq org-export-with-LaTeX-fragments t)
7944 @node CDLaTeX mode, , Processing LaTeX fragments, Embedded LaTeX
7945 @section Using CDLa@TeX{} to enter math
7948 CDLa@TeX{} mode is a minor mode that is normally used in combination with a
7949 major La@TeX{} mode like AUC@TeX{} in order to speed-up insertion of
7950 environments and math templates. Inside Org mode, you can make use of
7951 some of the features of CDLa@TeX{} mode. You need to install
7952 @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
7953 AUC@TeX{}) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
7954 Don't use CDLa@TeX{} mode itself under Org mode, but use the light
7955 version @code{org-cdlatex-mode} that comes as part of Org mode. Turn it
7956 on for the current buffer with @code{M-x org-cdlatex-mode}, or for all
7960 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
7963 When this mode is enabled, the following features are present (for more
7964 details see the documentation of CDLa@TeX{} mode):
7968 Environment templates can be inserted with @kbd{C-c @{}.
7971 The @key{TAB} key will do template expansion if the cursor is inside a
7972 La@TeX{} fragment@footnote{Org mode has a method to test if the cursor is
7973 inside such a fragment, see the documentation of the function
7974 @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will
7975 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
7976 correctly inside the first brace. Another @key{TAB} will get you into
7977 the second brace. Even outside fragments, @key{TAB} will expand
7978 environment abbreviations at the beginning of a line. For example, if
7979 you write @samp{equ} at the beginning of a line and press @key{TAB},
7980 this abbreviation will be expanded to an @code{equation} environment.
7981 To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}.
7985 @vindex cdlatex-simplify-sub-super-scripts
7986 Pressing @kbd{_} and @kbd{^} inside a La@TeX{} fragment will insert these
7987 characters together with a pair of braces. If you use @key{TAB} to move
7988 out of the braces, and if the braces surround only a single character or
7989 macro, they are removed again (depending on the variable
7990 @code{cdlatex-simplify-sub-super-scripts}).
7993 Pressing the backquote @kbd{`} followed by a character inserts math
7994 macros, also outside La@TeX{} fragments. If you wait more than 1.5 seconds
7995 after the backquote, a help window will pop up.
7998 Pressing the single-quote @kbd{'} followed by another character modifies
7999 the symbol before point with an accent or a font. If you wait more than
8000 1.5 seconds after the backquote, a help window will pop up. Character
8001 modification will work only inside La@TeX{} fragments, outside the quote
8005 @node Exporting, Publishing, Embedded LaTeX, Top
8009 Org-mode documents can be exported into a variety of other formats. For
8010 printing and sharing of notes, ASCII export produces a readable and simple
8011 version of an Org file. HTML export allows you to publish a notes file on
8012 the web, while the XOXO format provides a solid base for exchange with a
8013 broad range of other applications. La@TeX{} export lets you use Org mode and
8014 its structured editing functions to easily create La@TeX{} files. DocBook
8015 export makes it possible to convert Org files to many other formats using
8016 DocBook tools. To incorporate entries with associated times like deadlines
8017 or appointments into a desktop calendar program like iCal, Org mode can also
8018 produce extracts in the iCalendar format. Currently Org mode only supports
8019 export, not import of these different formats.
8021 Org supports export of selected regions when @code{transient-mark-mode} is
8022 enabled (default in Emacs 23).
8025 * Markup rules:: Which structures are recognized?
8026 * Selective export:: Using tags to select and exclude trees
8027 * Export options:: Per-file export settings
8028 * The export dispatcher:: How to access exporter commands
8029 * ASCII export:: Exporting to plain ASCII
8030 * HTML export:: Exporting to HTML
8031 * LaTeX and PDF export:: Exporting to La@TeX{}, and processing to PDF
8032 * DocBook export:: Exporting to DocBook
8033 * XOXO export:: Exporting to XOXO
8034 * iCalendar export:: Exporting in iCalendar format
8037 @node Markup rules, Selective export, Exporting, Exporting
8038 @section Markup rules
8040 When exporting Org-mode documents, the exporter tries to reflect the
8041 structure of the document as accurately as possible in the backend. Since
8042 export targets like HTML, La@TeX{}, or DocBook allow much richer formatting,
8043 Org mode has rules on how to prepare text for rich export. This section
8044 summarizes the markup rules used in an Org-mode buffer.
8047 * Document title:: How the document title is determined
8048 * Headings and sections:: The main structure of the exported document
8049 * Table of contents:: If, where, how to create a table of contents
8050 * Initial text:: Text before the first headline
8051 * Lists:: Plain lists are exported
8052 * Paragraphs:: What determines beginning and ending
8053 * Literal examples:: Source code and other examples
8054 * Include files:: Include the contents of a file during export
8055 * Tables exported:: Tables are exported richly
8056 * Inlined images:: How to inline images during export
8057 * Footnote markup:: ASCII representation of footnotes
8058 * Emphasis and monospace:: To bold or not to bold
8059 * TeX macros and LaTeX fragments:: Create special, rich export.
8060 * Horizontal rules:: A line across the page
8061 * Comment lines:: Some lines will not be exported
8062 * Macro replacement:: Global replacement of place holders
8065 @node Document title, Headings and sections, Markup rules, Markup rules
8066 @subheading Document title
8067 @cindex document title, markup rules
8070 The title of the exported document is taken from the special line
8074 #+TITLE: This is the title of the document
8078 If this line does not exist, the title is derived from the first non-empty,
8079 non-comment line in the buffer. If no such line exists, or if you have
8080 turned off exporting of the text before the first headline (see below), the
8081 title will be the file name without extension.
8083 @cindex property, EXPORT_TITLE
8084 If you are exporting only a subtree by marking is as the region, the heading
8085 of the subtree will become the title of the document. If the subtree has a
8086 property @code{EXPORT_TITLE}, that will take precedence.
8088 @node Headings and sections, Table of contents, Document title, Markup rules
8089 @subheading Headings and sections
8090 @cindex headings and sections, markup rules
8092 @vindex org-headline-levels
8093 The outline structure of the document as described in @ref{Document
8094 Structure}, forms the basis for defining sections of the exported document.
8095 However, since the outline structure is also used for (for example) lists of
8096 tasks, only the first three outline levels will be used as headings. Deeper
8097 levels will become itemized lists. You can change the location of this
8098 switch globally by setting the variable @code{org-headline-levels}, or on a
8099 per-file basis with a line
8106 @node Table of contents, Initial text, Headings and sections, Markup rules
8107 @subheading Table of contents
8108 @cindex table of contents, markup rules
8110 @vindex org-export-with-toc
8111 The table of contents is normally inserted directly before the first headline
8112 of the file. If you would like to get it to a different location, insert the
8113 string @code{[TABLE-OF-CONTENTS]} on a line by itself at the desired
8114 location. The depth of the table of contents is by default the same as the
8115 number of headline levels, but you can choose a smaller number, or turn off
8116 the table of contents entirely, by configuring the variable
8117 @code{org-export-with-toc}, or on a per-file basis with a line like
8120 #+OPTIONS: toc:2 (only to two levels in TOC)
8121 #+OPTIONS: toc:nil (no TOC at all)
8124 @node Initial text, Lists, Table of contents, Markup rules
8125 @subheading Text before the first headline
8126 @cindex text before first headline, markup rules
8129 Org mode normally exports the text before the first headline, and even uses
8130 the first line as the document title. The text will be fully marked up. If
8131 you need to include literal HTML, La@TeX{}, or DocBook code, use the special
8132 constructs described below in the sections for the individual exporters.
8134 @vindex org-export-skip-text-before-1st-heading
8135 Some people like to use the space before the first headline for setup and
8136 internal links and therefore would like to control the exported text before
8137 the first headline in a different way. You can do so by setting the variable
8138 @code{org-export-skip-text-before-1st-heading} to @code{t}. On a per-file
8139 basis, you can get the same effect with @samp{#+OPTIONS: skip:t}.
8142 If you still want to have some text before the first headline, use the
8143 @code{#+TEXT} construct:
8147 #+TEXT: This text will go before the *first* headline.
8148 #+TEXT: [TABLE-OF-CONTENTS]
8149 #+TEXT: This goes between the table of contents and the first headline
8152 @node Lists, Paragraphs, Initial text, Markup rules
8154 @cindex lists, markup rules
8156 Plain lists as described in @ref{Plain lists}, are translated to the backend's
8157 syntax for such lists. Most backends support unordered, ordered, and
8160 @node Paragraphs, Literal examples, Lists, Markup rules
8161 @subheading Paragraphs, line breaks, and quoting
8162 @cindex paragraphs, markup rules
8164 Paragraphs are separated by at least one empty line. If you need to enforce
8165 a line break within a paragraph, use @samp{\\} at the end of a line.
8167 To keep the line breaks in a region, but otherwise use normal formatting, you
8168 can use this construct, which can also be used to format poetry.
8170 @cindex #+BEGIN_VERSE
8173 Great clouds overhead
8174 Tiny black birds rise and fall
8181 When quoting a passage from another document, it is customary to format this
8182 as a paragraph that is indented on both the left and the right margin. You
8183 can include quotations in Org-mode documents like this:
8185 @cindex #+BEGIN_QUOTE
8188 Everything should be made as simple as possible,
8189 but not any simpler -- Albert Einstein
8193 If you would like to center some text, do it like this:
8194 @cindex #+BEGIN_CENTER
8197 Everything should be made as simple as possible, \\
8202 @node Literal examples, Include files, Paragraphs, Markup rules
8203 @subheading Literal examples
8204 @cindex literal examples, markup rules
8205 @cindex code line references, markup rules
8207 You can include literal examples that should not be subjected to
8208 markup. Such examples will be typeset in monospace, so this is well suited
8209 for source code and similar examples.
8210 @cindex #+BEGIN_EXAMPLE
8214 Some example from a text file.
8218 Note that such blocks may be @i{indented} in order to align nicely with
8219 indented text and in particular with plain list structure (@pxref{Plain
8220 lists}). For simplicity when using small examples, you can also start the
8221 example lines with a colon followed by a space. There may also be additional
8222 whitespace before the colon:
8226 : Some example from a text file.
8229 @cindex formatting source code, markup rules
8230 If the example is source code from a programming language, or any other text
8231 that can be marked up by font-lock in Emacs, you can ask for the example to
8232 look like the fontified Emacs buffer@footnote{Currently this works for the
8233 HTML backend, and requires the @file{htmlize.el} package version 1.34 or
8234 later. It also works for LaTeX with the listings package, if you turn on the
8235 option @code{org-export-latex-listings} and make sure that the listings
8236 package is included by the LaTeX header.}. This is done with the @samp{src}
8237 block, where you also need to specify the name of the major mode that should
8238 be used to fontify the example:
8242 #+BEGIN_SRC emacs-lisp
8243 (defun org-xor (a b)
8249 Both in @code{example} and in @code{src} snippets, you can add a @code{-n}
8250 switch to the end of the @code{BEGIN} line, to get the lines of the example
8251 numbered. If you use a @code{+n} switch, the numbering from the previous
8252 numbered snippet will be continued in the current one. In literal examples,
8253 Org will interpret strings like @samp{(ref:name)} as labels, and use them as
8254 targets for special hyperlinks like @code{[[(name)]]} (@ie the reference name
8255 enclosed in single parenthesis). In HTML, hovering the mouse over such a
8256 link will remote-highlight the corresponding code line, which is kind of
8259 You can also add a @code{-r} switch which @i{removes} the labels from the
8260 source code@footnote{Adding @code{-k} to @code{-n -r} will @i{keep} the
8261 labels in the source code while using line numbers for the links, which might
8262 be useful to explain those in an org-mode example code.}. With the @code{-n}
8263 switch, links to these references will be labeled by the line numbers from
8264 the code listing, otherwise links will use the labels with no parentheses.
8268 #+BEGIN_SRC emacs-lisp -n -r
8269 (save-excursion (ref:sc)
8270 (goto-char (point-min)) (ref:jump)
8272 In line [[(sc)]] we remember the current position. [[(jump)][Line (jump)]]
8276 @vindex org-coderef-label-format
8277 If the syntax for the label format conflicts with the language syntax, use a
8278 @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
8279 -n -r -l "((%s))"}. See also the variable @code{org-coderef-label-format}.
8281 HTML export also allows examples to be published as text areas, @xref{Text
8282 areas in HTML export}.
8287 Edit the source code example at point in its native mode. This works by
8288 switching to a temporary buffer with the source code. You need to exit by
8289 pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*}
8290 or @samp{#} will get a comma prepended, to keep them from being interpreted
8291 by Org as outline nodes or special comments. These commas will be striped
8292 for editing with @kbd{C-c '}, and also for export.}, the edited version will
8293 then replace the old version in the Org buffer. Fixed-width regions
8294 (where each line starts with a colon followed by a space) will be edited
8295 using @code{artist-mode}@footnote{You may select a different-mode with the
8296 variable @code{org-edit-fixed-width-region-mode}.} to allow creating ASCII
8297 drawings easily. Using this command in an empty line will create a new
8301 Calling @code{org-store-link} while editing a source code example in a
8302 temporary buffer created with @kbd{C-c '} will prompt for a label, make sure
8303 that it is unique in the current buffer, and insert it with the proper
8304 formatting like @samp{(ref:label)} at the end of the current line. Then the
8305 label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
8309 @node Include files, Tables exported, Literal examples, Markup rules
8310 @subheading Include files
8311 @cindex include files, markup rules
8313 During export, you can include the content of another file. For example, to
8314 include your @file{.emacs} file, you could use:
8318 #+INCLUDE: "~/.emacs" src emacs-lisp
8321 The optional second and third parameter are the markup (e.g. @samp{quote},
8322 @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the
8323 language for formatting the contents. The markup is optional, if it is not
8324 given, the text will be assumed to be in Org mode format and will be
8325 processed normally. The include line will also allow additional keyword
8326 parameters @code{:prefix1} and @code{:prefix} to specify prefixes for the
8327 first line and for each following line, as well as any options accepted by
8328 the selected markup. For example, to include a file as an item, use
8331 #+INCLUDE: "~/snippets/xx" :prefix1 " + " :prefix " "
8337 Visit the include file at point.
8340 @node Tables exported, Inlined images, Include files, Markup rules
8342 @cindex tables, markup rules
8344 Both the native Org mode tables (@pxref{Tables}) and tables formatted with
8345 the @file{table.el} package will be exported properly. For Org mode tables,
8346 the lines before the first horizontal separator line will become table header
8347 lines. You can use the following lines somewhere before the table to assign
8348 a caption and a label for cross references:
8351 #+CAPTION: This is the caption for the next table (or link)
8352 #+LABEL: tbl:basic-data
8355 @node Inlined images, Footnote markup, Tables exported, Markup rules
8356 @subheading Inlined Images
8357 @cindex inlined images, markup rules
8359 Some backends (HTML, La@TeX{}, and DocBook) allow you to directly include images
8360 into the exported document. Org does this, if a link to an image files does
8361 not have a description part, for example @code{[[./img/a.jpg]]}. If you wish
8362 to define a caption for the image and maybe a label for internal cross
8363 references, you can use (before, but close to the link)
8366 #+CAPTION: This is the caption for the next figure link (or table)
8367 #+LABEL: fig:SED-HR4049
8370 You may also define additional attributes for the figure. As this is
8371 backend-specific, see the sections about the individual backends for more
8374 @node Footnote markup, Emphasis and monospace, Inlined images, Markup rules
8375 @subheading Footnote markup
8376 @cindex footnotes, markup rules
8377 @cindex @file{footnote.el}
8379 Footnotes defined in the way described in @ref{Footnotes}, will be exported by
8380 all backends. Org allows multiple references to the same note, and
8381 different backends support this to varying degrees.
8383 @node Emphasis and monospace, TeX macros and LaTeX fragments, Footnote markup, Markup rules
8384 @subheading Emphasis and monospace
8386 @cindex underlined text, markup rules
8387 @cindex bold text, markup rules
8388 @cindex italic text, markup rules
8389 @cindex verbatim text, markup rules
8390 @cindex code text, markup rules
8391 @cindex strike-through text, markup rules
8392 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=}
8393 and @code{~verbatim~}, and, if you must, @samp{+strike-through+}. Text
8394 in the code and verbatim string is not processed for Org-mode specific
8395 syntax, it is exported verbatim.
8397 @node TeX macros and LaTeX fragments, Horizontal rules, Emphasis and monospace, Markup rules
8398 @subheading @TeX{} macros and La@TeX{} fragments
8399 @cindex La@TeX{} fragments, markup rules
8400 @cindex @TeX{} macros, markup rules
8401 @cindex HTML entities
8402 @cindex La@TeX{} entities
8404 @vindex org-html-entities
8405 A @TeX{}-like syntax is used to specify special characters. Where possible,
8406 these will be transformed into the native format of the exporter backend.
8407 Strings like @code{\alpha} will be exported as @code{α} in the HTML
8408 output, and as @code{$\alpha$} in the La@TeX{} output. Similarly,
8409 @code{\nbsp} will become @code{ } in HTML and @code{~} in La@TeX{}.
8410 This applies for a large number of entities, with names taken from both HTML
8411 and La@TeX{}, see the variable @code{org-html-entities} for the complete
8412 list. If you are unsure about a name, use @kbd{M-@key{TAB}} for completion
8413 after having typed the backslash and optionally a few characters
8414 (@pxref{Completion}).
8416 La@TeX{} fragments are converted into images for HTML export, and they are
8417 written literally into the La@TeX{} export. See also @ref{Embedded LaTeX}.
8419 Finally, @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
8420 @samp{...} are all converted into special commands creating hyphens of
8421 different lengths or a compact set of dots.
8423 @node Horizontal rules, Comment lines, TeX macros and LaTeX fragments, Markup rules
8424 @subheading Horizontal rules
8425 @cindex horizontal rules, markup rules
8426 A line consisting of only dashes, and at least 5 of them, will be
8427 exported as a horizontal line (@samp{<hr/>} in HTML).
8429 @node Comment lines, Macro replacement, Horizontal rules, Markup rules
8430 @subheading Comment lines
8431 @cindex comment lines
8432 @cindex exporting, not
8433 @cindex #+BEGIN_COMMENT
8435 Lines starting with @samp{#} in column zero are treated as comments and will
8436 never be exported. Also entire subtrees starting with the word
8437 @samp{COMMENT} will never be exported. Finally, regions surrounded by
8438 @samp{#+BEGIN_COMMENT} ... @samp{#+END_COMMENT} will not be exported.
8443 Toggle the COMMENT keyword at the beginning of an entry.
8446 @node Macro replacement, , Comment lines, Markup rules
8447 @subheading Macro replacement
8448 @cindex macro replacement, during export
8451 You can define text snippets with
8454 #+MACRO: name replacement text $1, $2 are arguments
8457 @noindent which can be referenced anywhere in the document (even in
8458 code examples) with @code{@{@{@{name(arg1,arg2)@}@}@}}. In addition to
8459 defined macros, @code{@{@{@{title@}@}@}}, @code{@{@{@{author@}@}@}}, etc.,
8460 will reference information set by the @code{#+TITLE:}, @code{#+AUTHOR:}, and
8461 similar lines. Also, @code{@{@{@{date(@var{FORMAT})@}@}@}} and
8462 @code{@{@{@{modification-time(@var{FORMAT})@}@}@}} refer to current date time
8463 and to the modification time of the file being exported, respectively.
8464 @var{FORMAT} should be a format string understood by
8465 @code{format-time-string}.
8467 @node Selective export, Export options, Markup rules, Exporting
8468 @section Selective export
8469 @cindex export, selective by tags
8471 @vindex org-export-select-tags
8472 @vindex org-export-exclude-tags
8473 You may use tags to select the parts of a document that should be exported,
8474 or to exclude parts from export. This behavior is governed by two variables:
8475 @code{org-export-select-tags} and @code{org-export-exclude-tags}.
8477 Org first checks if any of the @emph{select} tags is present in the buffer.
8478 If yes, all trees that do not carry one of these tags will be excluded. If a
8479 selected tree is a subtree, the heading hierarchy above it will also be
8480 selected for export, but not the text below those headings.
8483 If none of the select tags is found, the whole buffer will be selected for
8487 Finally, all subtrees that are marked by any of the @emph{exclude} tags will
8488 be removed from the export buffer.
8490 @node Export options, The export dispatcher, Selective export, Exporting
8491 @section Export options
8492 @cindex options, for export
8494 @cindex completion, of option keywords
8495 The exporter recognizes special lines in the buffer which provide
8496 additional information. These lines may be put anywhere in the file.
8497 The whole set of lines can be inserted into the buffer with @kbd{C-c
8498 C-e t}. For individual lines, a good way to make sure the keyword is
8499 correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion
8500 (@pxref{Completion}). For a summary of other in-buffer settings not
8501 specifically related to export, see @ref{In-buffer settings}.
8502 In particular, note that you can place commonly-used (export) options in
8503 a separate file which can be included using @code{#+SETUPFILE}.
8508 Insert template with export options, see example below.
8515 @cindex #+DESCRIPTION
8523 @cindex #+EXPORT_SELECT_TAGS
8524 @cindex #+EXPORT_EXCLUDE_TAGS
8525 @cindex #+LATEX_HEADER
8526 @vindex user-full-name
8527 @vindex user-mail-address
8528 @vindex org-export-default-language
8530 #+TITLE: the title to be shown (default is the buffer name)
8531 #+AUTHOR: the author (default taken from @code{user-full-name})
8532 #+DATE: a date, fixed, of a format string for @code{format-time-string}
8533 #+EMAIL: his/her email address (default from @code{user-mail-address})
8534 #+DESCRIPTION: the page description, @eg for the XHTML meta tag
8535 #+KEYWORDS: the page keywords, @eg for the XHTML meta tag
8536 #+LANGUAGE: language for HTML, @eg @samp{en} (@code{org-export-default-language})
8537 #+TEXT: Some descriptive text to be inserted at the beginning.
8538 #+TEXT: Several lines may be given.
8539 #+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ...
8540 #+BIND: lisp-var lisp-val, e.g.: org-export-latex-low-levels itemize
8541 @r{You need to confirm using these, or configure @code{org-export-allow-BIND}}
8542 #+LINK_UP: the ``up'' link of an exported page
8543 #+LINK_HOME: the ``home'' link of an exported page
8544 #+LATEX_HEADER: extra line(s) for the LaTeX header, like \usepackage@{xyz@}
8545 #+EXPORT_SELECT_TAGS: Tags that select a tree for export
8546 #+EXPORT_EXCLUDE_TAGS: Tags that exclude a tree from export
8550 The OPTIONS line is a compact@footnote{If you want to configure many options
8551 this way, you can use several OPTIONS lines.} form to specify export settings. Here
8553 @cindex headline levels
8554 @cindex section-numbers
8555 @cindex table of contents
8556 @cindex line-break preservation
8557 @cindex quoted HTML tags
8558 @cindex fixed-width sections
8560 @cindex @TeX{}-like syntax for sub- and superscripts
8562 @cindex special strings
8563 @cindex emphasized text
8564 @cindex @TeX{} macros
8565 @cindex La@TeX{} fragments
8566 @cindex author info, in export
8567 @cindex time info, in export
8569 H: @r{set the number of headline levels for export}
8570 num: @r{turn on/off section-numbers}
8571 toc: @r{turn on/off table of contents, or set level limit (integer)}
8572 \n: @r{turn on/off line-break-preservation}
8573 @@: @r{turn on/off quoted HTML tags}
8574 :: @r{turn on/off fixed-width sections}
8575 |: @r{turn on/off tables}
8576 ^: @r{turn on/off @TeX{}-like syntax for sub- and superscripts. If}
8577 @r{you write "^:@{@}", @code{a_@{b@}} will be interpreted, but}
8578 @r{the simple @code{a_b} will be left as it is.}
8579 -: @r{turn on/off conversion of special strings.}
8580 f: @r{turn on/off footnotes like this[1].}
8581 todo: @r{turn on/off inclusion of TODO keywords into exported text}
8582 pri: @r{turn on/off priority cookies}
8583 tags: @r{turn on/off inclusion of tags, may also be @code{not-in-toc}}
8584 <: @r{turn on/off inclusion of any time/date stamps like DEADLINES}
8585 *: @r{turn on/off emphasized text (bold, italic, underlined)}
8586 TeX: @r{turn on/off simple @TeX{} macros in plain text}
8587 LaTeX: @r{turn on/off La@TeX{} fragments}
8588 skip: @r{turn on/off skipping the text before the first heading}
8589 author: @r{turn on/off inclusion of author name/email into exported file}
8590 creator: @r{turn on/off inclusion of creator info into exported file}
8591 timestamp: @r{turn on/off inclusion creation time into exported file}
8592 d: @r{turn on/off inclusion of drawers}
8595 These options take effect in both the HTML and La@TeX{} export, except
8596 for @code{TeX} and @code{LaTeX}, which are respectively @code{t} and
8597 @code{nil} for the La@TeX{} export.
8599 When exporting only a single subtree by selecting it with @kbd{C-c @@} before
8600 calling an export command, the subtree can overrule some of the file's export
8601 settings with properties @code{EXPORT_FILE_NAME}, @code{EXPORT_TITLE},
8602 @code{EXPORT_TEXT}, @code{EXPORT_AUTHOR}, @code{EXPORT_DATE}, and
8603 @code{EXPORT_OPTIONS}.
8605 @node The export dispatcher, ASCII export, Export options, Exporting
8606 @section The export dispatcher
8607 @cindex dispatcher, for export commands
8609 All export commands can be reached using the export dispatcher, which is a
8610 prefix key that prompts for an additional key specifying the command.
8611 Normally the entire file is exported, but if there is an active region that
8612 contains one outline tree, the first heading is used as document title and
8613 the subtrees are exported.
8618 @vindex org-export-run-in-background
8619 Dispatcher for export and publishing commands. Displays a help-window
8620 listing the additional key(s) needed to launch an export or publishing
8621 command. The prefix arg is passed through to the exporter. A double prefix
8622 @kbd{C-u C-u} causes most commands to be executed in the background, in a
8623 separate Emacs process@footnote{To make this behavior the default, customize
8624 the variable @code{org-export-run-in-background}.}.
8627 Like @kbd{C-c C-e}, but only export the text that is currently visible
8628 (@ie not hidden by outline visibility).
8629 @kindex C-u C-u C-c C-e
8630 @item C-u C-u C-c C-e
8631 @vindex org-export-run-in-background
8632 Call an the exporter, but reverse the setting of
8633 @code{org-export-run-in-background}, @ie request background processing if
8634 not set, or force processing in the current Emacs process if set.
8637 @node ASCII export, HTML export, The export dispatcher, Exporting
8638 @section ASCII export
8639 @cindex ASCII export
8641 ASCII export produces a simple and very readable version of an Org-mode
8644 @cindex region, active
8645 @cindex active region
8646 @cindex transient-mark-mode
8650 @cindex property, EXPORT_FILE_NAME
8651 Export as ASCII file. For an Org file, @file{myfile.org}, the ASCII file
8652 will be @file{myfile.txt}. The file will be overwritten without
8653 warning. If there is an active region@footnote{This requires
8654 @code{transient-mark-mode} be turned on.}, only the region will be
8655 exported. If the selected region is a single tree@footnote{To select the
8656 current subtree, use @kbd{C-c @@}.}, the tree head will
8657 become the document title. If the tree head entry has or inherits an
8658 @code{EXPORT_FILE_NAME} property, that name will be used for the
8662 Export to a temporary buffer, do not create a file.
8665 Export only the visible part of the document.
8668 @cindex headline levels, for exporting
8669 In the exported version, the first 3 outline levels will become
8670 headlines, defining a general document structure. Additional levels
8671 will be exported as itemized lists. If you want that transition to occur
8672 at a different level, specify it with a prefix argument. For example,
8679 creates only top level headlines and does the rest as items. When
8680 headlines are converted to items, the indentation of the text following
8681 the headline is changed to fit nicely under the item. This is done with
8682 the assumption that the first body line indicates the base indentation of
8683 the body text. Any indentation larger than this is adjusted to preserve
8684 the layout relative to the first line. Should there be lines with less
8685 indentation than the first, these are left alone.
8687 @vindex org-export-ascii-links-to-notes
8688 Links will be exported in a footnote-like style, with the descriptive part in
8689 the text and the link in a note before the next heading. See the variable
8690 @code{org-export-ascii-links-to-notes} for details and other options.
8692 @node HTML export, LaTeX and PDF export, ASCII export, Exporting
8693 @section HTML export
8696 Org mode contains an HTML (XHTML 1.0 strict) exporter with extensive
8697 HTML formatting, in ways similar to John Gruber's @emph{markdown}
8698 language, but with additional support for tables.
8701 * HTML Export commands:: How to invoke HTML export
8702 * Quoting HTML tags:: Using direct HTML in Org mode
8703 * Links:: Transformation of links for HTML
8704 * Tables in HTML export:: How to modify the formatting of tables
8705 * Images in HTML export:: How to insert figures into HTML output
8706 * Text areas in HTML export:: An alternative way to show an example
8707 * CSS support:: Changing the appearance of the output
8708 * Javascript support:: Info and Folding in a web browser
8711 @node HTML Export commands, Quoting HTML tags, HTML export, HTML export
8712 @subsection HTML export commands
8714 @cindex region, active
8715 @cindex active region
8716 @cindex transient-mark-mode
8720 @cindex property, EXPORT_FILE_NAME
8721 Export as HTML file @file{myfile.html}. For an Org file @file{myfile.org},
8722 the ASCII file will be @file{myfile.html}. The file will be overwritten
8723 without warning. If there is an active region@footnote{This requires
8724 @code{transient-mark-mode} be turned on.}, only the region will be
8725 exported. If the selected region is a single tree@footnote{To select the
8726 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
8727 title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
8728 property, that name will be used for the export.
8731 Export as HTML file and immediately open it with a browser.
8734 Export to a temporary buffer, do not create a file.
8737 Export the active region to a temporary buffer. With a prefix argument, do
8738 not produce the file header and footer, but just the plain HTML section for
8739 the region. This is good for cut-and-paste operations.
8748 Export only the visible part of the document.
8749 @item M-x org-export-region-as-html
8750 Convert the region to HTML under the assumption that it was Org-mode
8751 syntax before. This is a global command that can be invoked in any
8753 @item M-x org-replace-region-by-HTML
8754 Replace the active region (assumed to be in Org-mode syntax) by HTML
8758 @cindex headline levels, for exporting
8759 In the exported version, the first 3 outline levels will become headlines,
8760 defining a general document structure. Additional levels will be exported as
8761 itemized lists. If you want that transition to occur at a different level,
8762 specify it with a numeric prefix argument. For example,
8769 creates two levels of headings and does the rest as items.
8771 @node Quoting HTML tags, Links, HTML Export commands, HTML export
8772 @subsection Quoting HTML tags
8774 Plain @samp{<} and @samp{>} are always transformed to @samp{<} and
8775 @samp{>} in HTML export. If you want to include simple HTML tags
8776 which should be interpreted as such, mark them with @samp{@@} as in
8777 @samp{@@<b>bold text@@</b>}. Note that this really works only for
8778 simple tags. For more extensive HTML that should be copied verbatim to
8779 the exported file use either
8782 @cindex #+BEGIN_HTML
8784 #+HTML: Literal HTML code for export
8788 @cindex #+BEGIN_HTML
8792 All lines between these markers are exported literally
8797 @node Links, Tables in HTML export, Quoting HTML tags, HTML export
8800 @cindex links, in HTML export
8801 @cindex internal links, in HTML export
8802 @cindex external links, in HTML export
8803 Internal links (@pxref{Internal links}) will continue to work in HTML. This
8804 includes automatic links created by radio targets (@pxref{Radio
8805 targets}). Links to external files will still work if the target file is on
8806 the same @i{relative} path as the published Org file. Links to other
8807 @file{.org} files will be translated into HTML links under the assumption
8808 that an HTML version also exists of the linked file, at the same relative
8809 path. @samp{id:} links can then be used to jump to specific entries across
8810 files. For information related to linking files while publishing them to a
8811 publishing directory see @ref{Publishing links}.
8813 If you want to specify attributes for links, you can do so using a special
8814 @code{#+ATTR_HTML} line to define attributes that will be added to the
8815 @code{<a>} or @code{<img>} tags. Here is an example that sets @code{title}
8816 and @code{style} attributes for a link:
8820 #+ATTR_HTML: title="The Org-mode homepage" style="color:red;"
8821 [[http://orgmode.org]]
8824 @node Tables in HTML export, Images in HTML export, Links, HTML export
8826 @cindex tables, in HTML
8827 @vindex org-export-html-table-tag
8829 Org-mode tables are exported to HTML using the table tag defined in
8830 @code{org-export-html-table-tag}. The default setting makes tables without
8831 cell borders and frame. If you would like to change this for individual
8832 tables, place somthing like the following before the table:
8836 #+CAPTION: This is a table with lines around and between cells
8837 #+ATTR_HTML: border="2" rules="all" frame="all"
8840 @node Images in HTML export, Text areas in HTML export, Tables in HTML export, HTML export
8843 @cindex images, inline in HTML
8844 @cindex inlining images in HTML
8845 @vindex org-export-html-inline-images
8846 HTML export can inline images given as links in the Org file, and
8847 it can make an image the clickable part of a link. By
8848 default@footnote{But see the variable
8849 @code{org-export-html-inline-images}.}, images are inlined if a link does
8850 not have a description. So @samp{[[file:myimg.jpg]]} will be inlined,
8851 while @samp{[[file:myimg.jpg][the image]]} will just produce a link
8852 @samp{the image} that points to the image. If the description part
8853 itself is a @code{file:} link or a @code{http:} URL pointing to an
8854 image, this image will be inlined and activated so that clicking on the
8855 image will activate the link. For example, to include a thumbnail that
8856 will link to a high resolution version of the image, you could use:
8859 [[file:highres.jpg][file:thumb.jpg]]
8862 If you need to add attributes to an inlines image, use a @code{#+ATTR_HTML},
8867 #+CAPTION: A black cat stalking a spider
8868 #+ATTR_HTML: alt="cat/spider image" title="one second before action"
8873 and you could use @code{http} addresses just as well.
8875 @node Text areas in HTML export, CSS support, Images in HTML export, HTML export
8876 @subsection Text areas
8878 @cindex text areas, in HTML
8879 An alternative way to publish literal code examples in HTML is to use text
8880 areas, where the example can even be edited before pasting it into an
8881 application. It is triggered by a @code{-t} switch at an @code{example} or
8882 @code{src} block. Using this switch disables any options for syntax and
8883 label highlighting, and line numbering, which may be present. You may also
8884 use @code{-h} and @code{-w} switches to specify the height and width of the
8885 text area, which default to the number of lines in the example, and 80,
8886 respectively. For example
8889 #+BEGIN_EXAMPLE -t -w 40
8890 (defun org-xor (a b)
8897 @node CSS support, Javascript support, Text areas in HTML export, HTML export
8898 @subsection CSS support
8899 @cindex CSS, for HTML export
8900 @cindex HTML export, CSS
8902 @vindex org-export-html-todo-kwd-class-prefix
8903 @vindex org-export-html-tag-class-prefix
8904 You can also give style information for the exported file. The HTML exporter
8905 assigns the following special CSS classes@footnote{If the classes on TODO
8906 keywords and tags lead to conflicts, use the variables
8907 @code{org-export-html-todo-kwd-class-prefix} and
8908 @code{org-export-html-tag-class-prefix} to make them unique.} to appropriate
8909 parts of the document---your style specifications may change these, in
8910 addition to any of the standard classes like for headlines, tables, etc.
8912 p.author @r{author information, including email}
8913 p.date @r{publishing date}
8914 p.creator @r{creator info, about org-mode version}
8915 .title @r{document title}
8916 .todo @r{TODO keywords, all not-done states}
8917 .done @r{the DONE keywords, all stated the count as done}
8918 .WAITING @r{each TODO keyword also uses a class named after itself}
8919 .timestamp @r{timestamp}
8920 .timestamp-kwd @r{keyword associated with a timestamp, like SCHEDULED}
8921 .timestamp-wrapper @r{span around keyword plus timestamp}
8922 .tag @r{tag in a headline}
8923 ._HOME @r{each tag uses itself as a class, "@@" replaced by "_"}
8924 .target @r{target for links}
8925 .linenr @r{the line number in a code example}
8926 .code-highlighted @r{for highlighting referenced code lines}
8927 div.outline-N @r{div for outline level N (headline plus text))}
8928 div.outline-text-N @r{extra div for text at outline level N}
8929 .section-number-N @r{section number in headlines, different for each level}
8930 div.figure @r{how to format an inlined image}
8931 pre.src @r{formatted source code}
8932 pre.example @r{normal example}
8933 p.verse @r{verse paragraph}
8934 div.footnotes @r{footnote section headline}
8935 p.footnote @r{footnote definition paragraph, containing a footnote}
8936 .footref @r{a footnote reference number (always a <sup>)}
8937 .footnum @r{footnote number in footnote definition (always <sup>)}
8940 @vindex org-export-html-style-default
8941 @vindex org-export-html-style-include-default
8942 @vindex org-export-html-style
8943 @vindex org-export-html-extra
8944 @vindex org-export-html-style-default
8945 Each exported file contains a compact default style that defines these
8946 classes in a basic way@footnote{This style is defined in the constant
8947 @code{org-export-html-style-default}, which you should not modify. To turn
8948 inclusion of these defaults off, customize
8949 @code{org-export-html-style-include-default}}. You may overwrite these
8950 settings, or add to them by using the variables @code{org-export-html-style}
8951 (for Org-wide settings) and @code{org-export-html-style-extra} (for more
8952 granular settings, like file-local settings). To set the latter variable
8953 individually for each file, you can use
8957 #+STYLE: <link rel="stylesheet" type="text/css" href="stylesheet.css" />
8961 For longer style definitions, you can use several such lines. You could also
8962 directly write a @code{<style>} @code{</style>} section in this way, without
8963 referring to an external file.
8965 @c FIXME: More about header and footer styles
8966 @c FIXME: Talk about links and targets.
8968 @node Javascript support, , CSS support, HTML export
8969 @subsection Javascript supported display of web pages
8971 @cindex Rose, Sebastian
8972 Sebastian Rose has written a JavaScript program especially designed to
8973 enhance the web viewing experience of HTML files created with Org. This
8974 program allows you to view large files in two different ways. The first one
8975 is an @emph{Info}-like mode where each section is displayed separately and
8976 navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
8977 as well, press @kbd{?} for an overview of the available keys). The second
8978 view type is a @emph{folding} view much like Org provides inside Emacs. The
8979 script is available at @url{http://orgmode.org/org-info.js} and you can find
8980 the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
8981 We host the script at our site, but if you use it a lot, you might
8982 not want to be dependent on @url{orgmode.org} and prefer to install a local
8983 copy on your own web server.
8985 To use the script, you need to make sure that the @file{org-jsinfo.el} module
8986 gets loaded. It should be loaded by default, but you can try @kbd{M-x
8987 customize-variable @key{RET} org-modules @key{RET}} to convince yourself that
8988 this is indeed the case. All it then takes to make use of the program is
8989 adding a single line to the Org file:
8991 @cindex #+INFOJS_OPT
8993 #+INFOJS_OPT: view:info toc:nil
8997 If this line is found, the HTML header will automatically contain the code
8998 needed to invoke the script. Using the line above, you can set the following
9002 path: @r{The path to the script. The default is to grab the script from}
9003 @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
9004 @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
9005 view: @r{Initial view when website is first shown. Possible values are:}
9006 info @r{Info-like interface with one section per page.}
9007 overview @r{Folding interface, initially showing only top-level.}
9008 content @r{Folding interface, starting with all headlines visible.}
9009 showall @r{Folding interface, all headlines and text visible.}
9010 sdepth: @r{Maximum headline level that will still become an independent}
9011 @r{section for info and folding modes. The default is taken from}
9012 @r{@code{org-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
9013 @r{If this is smaller than in @code{org-headline-levels}, each}
9014 @r{info/folding section can still contain child headlines.}
9015 toc: @r{Should the table of content @emph{initially} be visible?}
9016 @r{Even when @code{nil}, you can always get to the "toc" with @kbd{i}.}
9017 tdepth: @r{The depth of the table of contents. The defaults are taken from}
9018 @r{the variables @code{org-headline-levels} and @code{org-export-with-toc}.}
9019 ftoc: @r{Does the css of the page specify a fixed position for the "toc"?}
9020 @r{If yes, the toc will never be displayed as a section.}
9021 ltoc: @r{Should there be short contents (children) in each section?}
9022 @r{Make this @code{above} if the section should be above initial text.}
9023 mouse: @r{Headings are highlighted when the mouse is over them. Should be}
9024 @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
9025 buttons: @r{Should view-toggle buttons be everywhere? When @code{nil} (the}
9026 @r{default), only one such button will be present.}
9029 @vindex org-infojs-options
9030 @vindex org-export-html-use-infojs
9031 You can choose default values for these options by customizing the variable
9032 @code{org-infojs-options}. If you always want to apply the script to your
9033 pages, configure the variable @code{org-export-html-use-infojs}.
9035 @node LaTeX and PDF export, DocBook export, HTML export, Exporting
9036 @section La@TeX{} and PDF export
9037 @cindex La@TeX{} export
9039 @cindex Guerry, Bastian
9041 Org mode contains a La@TeX{} exporter written by Bastien Guerry. With
9042 further processing, this backend is also used to produce PDF output. Since
9043 the La@TeX{} output uses @file{hyperref} to implement links and cross
9044 references, the PDF output file will be fully linked.
9047 * LaTeX/PDF export commands:: Which key invokes which commands
9048 * Quoting LaTeX code:: Incorporating literal La@TeX{} code
9049 * Sectioning structure:: Changing sectioning in La@TeX{} output
9050 * Tables in LaTeX export:: Options for exporting tables to La@TeX{}
9051 * Images in LaTeX export:: How to insert figures into La@TeX{} output
9054 @node LaTeX/PDF export commands, Quoting LaTeX code, LaTeX and PDF export, LaTeX and PDF export
9055 @subsection La@TeX{} export commands
9057 @cindex region, active
9058 @cindex active region
9059 @cindex transient-mark-mode
9063 @cindex property EXPORT_FILE_NAME
9064 Export as La@TeX{} file @file{myfile.tex}. For an Org file
9065 @file{myfile.org}, the ASCII file will be @file{myfile.tex}. The file will
9066 be overwritten without warning. If there is an active region@footnote{This
9067 requires @code{transient-mark-mode} be turned on.}, only the region will be
9068 exported. If the selected region is a single tree@footnote{To select the
9069 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
9070 title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME}
9071 property, that name will be used for the export.
9074 Export to a temporary buffer, do not create a file.
9079 Export only the visible part of the document.
9080 @item M-x org-export-region-as-latex
9081 Convert the region to La@TeX{} under the assumption that it was Org mode
9082 syntax before. This is a global command that can be invoked in any
9084 @item M-x org-replace-region-by-latex
9085 Replace the active region (assumed to be in Org mode syntax) by La@TeX{}
9089 Export as La@TeX{} and then process to PDF.
9092 Export as La@TeX{} and then process to PDF, then open the resulting PDF file.
9095 @cindex headline levels, for exporting
9096 @vindex org-latex-low-levels
9097 In the exported version, the first 3 outline levels will become
9098 headlines, defining a general document structure. Additional levels
9099 will be exported as description lists. The exporter can ignore them or
9100 convert them to a custom string depending on
9101 @code{org-latex-low-levels}.
9103 If you want that transition to occur at a different level, specify it
9104 with a numeric prefix argument. For example,
9111 creates two levels of headings and does the rest as items.
9113 @node Quoting LaTeX code, Sectioning structure, LaTeX/PDF export commands, LaTeX and PDF export
9114 @subsection Quoting La@TeX{} code
9116 Embedded La@TeX{} as described in @ref{Embedded LaTeX}, will be correctly
9117 inserted into the La@TeX{} file. This includes simple macros like
9118 @samp{\ref@{LABEL@}} to create a cross reference to a figure. Furthermore,
9119 you can add special code that should only be present in La@TeX{} export with
9120 the following constructs:
9123 @cindex #+BEGIN_LaTeX
9125 #+LaTeX: Literal LaTeX code for export
9129 @cindex #+BEGIN_LaTeX
9133 All lines between these markers are exported literally
9137 @node Sectioning structure, Tables in LaTeX export, Quoting LaTeX code, LaTeX and PDF export
9138 @subsection Sectioning structure
9139 @cindex La@TeX{} class
9140 @cindex La@TeX{} sectioning structure
9142 By default, the La@TeX{} output uses the class @code{article}.
9144 @vindex org-export-latex-default-class
9145 @vindex org-export-latex-classes
9146 @cindex #+LATEX_HEADER
9147 @cindex #+LATEX_CLASS
9148 @cindex property, LATEX_CLASS
9149 You can change this globally by setting a different value for
9150 @code{org-export-latex-default-class} or locally by adding an option like
9151 @code{#+LaTeX_CLASS: myclass} in your file, or with a @code{:LaTeX_CLASS:}
9152 property that applies when exporting a region containing only this (sub)tree.
9153 The class should be listed in @code{org-export-latex-classes}, where you can
9154 also define the sectioning structure for each class, as well as defining
9155 additional classes. You can also use @code{#+LATEX_HEADER:
9156 \usepackage@{xyz@}} to add lines to the header.
9158 @node Tables in LaTeX export, Images in LaTeX export, Sectioning structure, LaTeX and PDF export
9159 @subsection Tables in La@TeX{} export
9160 @cindex tables, in La@TeX{} export
9162 For La@TeX{} export of a table, you can specify a label and a caption
9163 (@pxref{Markup rules}). You can also use the @code{ATTR_LaTeX} line to
9164 request a longtable environment for the table, so that it may span several
9165 pages. Finally, you can set the alignment string:
9169 @cindex #+ATTR_LaTeX
9171 #+CAPTION: A long table
9173 #+ATTR_LaTeX: longtable align=l|lp@{3cm@}r|l
9179 @node Images in LaTeX export, , Tables in LaTeX export, LaTeX and PDF export
9180 @subsection Images in La@TeX{} export
9181 @cindex images, inline in La@TeX{}
9182 @cindex inlining images in La@TeX{}
9184 Images that are linked to without a description part in the link, like
9185 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
9186 output files resulting from La@TeX{} output. Org will use an
9187 @code{\includegraphics} macro to insert the image. If you have specified a
9188 caption and/or a label as described in @ref{Markup rules}, the figure will
9189 be wrapped into a @code{figure} environment and thus become a floating
9190 element. Finally, you can use an @code{#+ATTR_LaTeX:} line to specify the
9191 options that can be used in the optional argument of the
9192 @code{\includegraphics} macro.
9196 @cindex #+ATTR_LaTeX
9198 #+CAPTION: The black-body emission of the disk around HR 4049
9199 #+LABEL: fig:SED-HR4049
9200 #+ATTR_LaTeX: width=5cm,angle=90
9201 [[./img/sed-hr4049.pdf]]
9204 @vindex org-export-latex-inline-image-extensions
9205 If you need references to a label created in this way, write
9206 @samp{\ref@{fig:SED-HR4049@}} just like in La@TeX{}. The default settings will
9207 recognize files types that can be included as images during processing by
9208 @command{pdflatex} (@file{png}, @file{jpg}, and @file{pdf} files). If you process your
9209 files in a different way, you may need to customize the variable
9210 @code{org-export-latex-inline-image-extensions}.
9212 @node DocBook export, XOXO export, LaTeX and PDF export, Exporting
9213 @section DocBook export
9214 @cindex DocBook export
9218 Org contains a DocBook exporter written by Baoqiu Cui. Once an Org file is
9219 exported to DocBook format, it can be further processed to produce other
9220 formats, including PDF, HTML, man pages, etc., using many available DocBook
9221 tools and stylesheets.
9223 Currently DocBook exporter only supports DocBook V5.0.
9226 * DocBook export commands:: How to invoke DocBook export
9227 * Quoting DocBook code:: Incorporating DocBook code in Org files
9228 * Recursive sections:: Recursive sections in DocBook
9229 * Tables in DocBook export:: Tables are exported as HTML tables
9230 * Images in DocBook export:: How to insert figures into DocBook output
9231 * Special characters:: How to handle special characters
9234 @node DocBook export commands, Quoting DocBook code, DocBook export, DocBook export
9235 @subsection DocBook export commands
9237 @cindex region, active
9238 @cindex active region
9239 @cindex transient-mark-mode
9243 @cindex property EXPORT_FILE_NAME
9244 Export as DocBook file. For an Org file, @file{myfile.org}, the DocBook XML
9245 file will be @file{myfile.xml}. The file will be overwritten without
9246 warning. If there is an active region@footnote{This requires
9247 @code{transient-mark-mode} to be turned on}, only the region will be
9248 exported. If the selected region is a single tree@footnote{To select the
9249 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
9250 title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
9251 property, that name will be used for the export.
9254 Export as DocBook file, process to PDF, then open the resulting PDF file.
9256 @vindex org-export-docbook-xslt-proc-command
9257 @vindex org-export-docbook-xsl-fo-proc-command
9258 Note that, in order to produce PDF output based on exported DocBook file, you
9259 need to have XSLT processor and XSL-FO processor software installed on your
9260 system. Check variables @code{org-export-docbook-xslt-proc-command} and
9261 @code{org-export-docbook-xsl-fo-proc-command}.
9265 Export only the visible part of the document.
9268 @node Quoting DocBook code, Recursive sections, DocBook export commands, DocBook export
9269 @subsection Quoting DocBook code
9271 You can quote DocBook code in Org files and copy it verbatim into exported
9272 DocBook file with the following constructs:
9275 @cindex #+BEGIN_DOCBOOK
9277 #+DOCBOOK: Literal DocBook code for export
9281 @cindex #+BEGIN_DOCBOOK
9285 All lines between these markers are exported by DocBook exporter
9290 For example, you can use the following lines to include a DocBook warning
9291 admonition. As to what this warning says, you should pay attention to the
9292 document context when quoting DocBook code in Org files. You may make
9293 exported DocBook XML files invalid by not quoting DocBook code correctly.
9298 <para>You should know what you are doing when quoting DocBook XML code
9299 in your Org file. Invalid DocBook XML file may be generated by
9300 DocBook exporter if you are not careful!</para>
9305 @node Recursive sections, Tables in DocBook export, Quoting DocBook code, DocBook export
9306 @subsection Recursive sections
9307 @cindex DocBook recursive sections
9309 DocBook exporter exports Org files as articles using the @code{article}
9310 element in DocBook. Recursive sections, @ie @code{section} elements, are
9311 used in exported articles. Top level headlines in Org files are exported as
9312 top level sections, and lower level headlines are exported as nested
9313 sections. The entire structure of Org files will be exported completely, no
9314 matter how many nested levels of headlines there are.
9316 Using recursive sections makes it easy to port and reuse exported DocBook
9317 code in other DocBook document types like @code{book} or @code{set}.
9319 @node Tables in DocBook export, Images in DocBook export, Recursive sections, DocBook export
9320 @subsection Tables in DocBook export
9321 @cindex tables, in DocBook export
9323 Tables in Org files are exported as HTML tables, which have been supported since
9326 If a table does not have a caption, an informal table is generated using the
9327 @code{informaltable} element; otherwise, a formal table will be generated
9328 using the @code{table} element.
9330 @node Images in DocBook export, Special characters, Tables in DocBook export, DocBook export
9331 @subsection Images in DocBook export
9332 @cindex images, inline in DocBook
9333 @cindex inlining images in DocBook
9335 Images that are linked to without a description part in the link, like
9336 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]}, will be exported to DocBook
9337 using @code{mediaobject} elements. Each @code{mediaobject} element contains
9338 an @code{imageobject} that wraps an @code{imagedata} element. If you have
9339 specified a caption for an image as described in @ref{Markup rules}, a
9340 @code{caption} element will be added in @code{mediaobject}. If a label is
9341 also specified, it will be exported as an @code{xml:id} attribute of the
9342 @code{mediaobject} element.
9344 @vindex org-export-docbook-default-image-attributes
9345 Image attributes supported by the @code{imagedata} element, like @code{align}
9346 or @code{width}, can be specified in two ways: you can either customize
9347 variable @code{org-export-docbook-default-image-attributes} or use the
9348 @code{#+ATTR_DOCBOOK:} line. Attributes specified in variable
9349 @code{org-export-docbook-default-image-attributes} are applied to all inline
9350 images in the Org file to be exported (unless they are overwritten by image
9351 attributes specified in @code{#+ATTR_DOCBOOK:} lines).
9353 The @code{#+ATTR_DOCBOOK:} line can be used to specify additional image
9354 attributes or overwrite default image attributes for individual images. If
9355 the same attribute appears in both the @code{#+ATTR_DOCBOOK:} line and
9356 variable @code{org-export-docbook-default-image-attributes}, the former
9357 overwrites the latter. Here is an example about how image attributes can be
9362 @cindex #+ATTR_DOCBOOK
9364 #+CAPTION: The logo of Org mode
9365 #+LABEL: unicorn-svg
9366 #+ATTR_DOCBOOK: scalefit="1" width="100%" depth="100%"
9367 [[./img/org-mode-unicorn.svg]]
9370 @vindex org-export-docbook-inline-image-extensions
9371 By default, DocBook exporter recognizes the following image file types:
9372 @file{jpeg}, @file{jpg}, @file{png}, @file{gif}, and @file{svg}. You can
9373 customize variable @code{org-export-docbook-inline-image-extensions} to add
9374 more types to this list as long as DocBook supports them.
9376 @node Special characters, , Images in DocBook export, DocBook export
9377 @subsection Special characters in DocBook export
9378 @cindex Special characters in DocBook export
9380 @vindex org-export-docbook-doctype
9381 @vindex org-html-entities
9382 Special characters that are written in @TeX{}-like syntax, such as @code{\alpha},
9383 @code{\Gamma}, and @code{\Zeta}, are supported by DocBook exporter. These
9384 characters are rewritten to XML entities, like @code{α},
9385 @code{Γ}, and @code{Ζ}, based on the list saved in variable
9386 @code{org-html-entities}. As long as the generated DocBook file includes the
9387 corresponding entities, these special characters are recognized.
9389 You can customize variable @code{org-export-docbook-doctype} to include the
9390 entities you need. For example, you can set variable
9391 @code{org-export-docbook-doctype} to the following value to recognize all
9392 special characters included in XHTML entities:
9395 "<!DOCTYPE article [
9396 <!ENTITY % xhtml1-symbol PUBLIC
9397 \"-//W3C//ENTITIES Symbol for HTML//EN//XML\"
9398 \"http://www.w3.org/2003/entities/2007/xhtml1-symbol.ent\"
9405 @node XOXO export, iCalendar export, DocBook export, Exporting
9406 @section XOXO export
9409 Org mode contains an exporter that produces XOXO-style output.
9410 Currently, this exporter only handles the general outline structure and
9411 does not interpret any additional Org-mode features.
9416 Export as XOXO file @file{myfile.html}.
9419 Export only the visible part of the document.
9422 @node iCalendar export, , XOXO export, Exporting
9423 @section iCalendar export
9424 @cindex iCalendar export
9426 @vindex org-icalendar-include-todo
9427 @vindex org-icalendar-use-deadline
9428 @vindex org-icalendar-use-scheduled
9429 @vindex org-icalendar-categories
9430 Some people use Org mode for keeping track of projects, but still prefer a
9431 standard calendar application for anniversaries and appointments. In this
9432 case it can be useful to show deadlines and other time-stamped items in Org
9433 files in the calendar application. Org mode can export calendar information
9434 in the standard iCalendar format. If you also want to have TODO entries
9435 included in the export, configure the variable
9436 @code{org-icalendar-include-todo}. Plain timestamps are exported as VEVENT,
9437 and TODO items as VTODO. It will also create events from deadlines that are
9438 in non-TODO items. Deadlines and scheduling dates in TODO items will be used
9439 to set the start and due dates for the TODO entry@footnote{See the variables
9440 @code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}.
9441 As categories, it will use the tags locally defined in the heading, and the
9442 file/tree category@footnote{To add inherited tags or the TODO state,
9443 configure the variable @code{org-icalendar-categories}.}.
9445 @vindex org-icalendar-store-UID
9446 @cindex property, ID
9447 The iCalendar standard requires each entry to have a globally unique
9448 identifier (UID). Org creates these identifiers during export. If you set
9449 the variable @code{org-icalendar-store-UID}, the UID will be stored in the
9450 @code{:ID:} property of the entry and re-used next time you report this
9451 entry. Since a single entry can give rise to multiple iCalendar entries (as
9452 a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
9453 prefixes to the UID, depending on what triggered the inclusion of the entry.
9454 In this way the UID remains unique, but a synchronization program can still
9455 figure out from which entry all the different instances originate.
9460 Create iCalendar entries for the current file and store them in the same
9461 directory, using a file extension @file{.ics}.
9464 @vindex org-agenda-files
9465 Like @kbd{C-c C-e i}, but do this for all files in
9466 @code{org-agenda-files}. For each of these files, a separate iCalendar
9467 file will be written.
9470 @vindex org-combined-agenda-icalendar-file
9471 Create a single large iCalendar file from all files in
9472 @code{org-agenda-files} and write it to the file given by
9473 @code{org-combined-agenda-icalendar-file}.
9476 @vindex org-use-property-inheritance
9477 @vindex org-icalendar-include-body
9478 @cindex property, SUMMARY
9479 @cindex property, DESCRIPTION
9480 @cindex property, LOCATION
9481 The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION
9482 property can be inherited from higher in the hierarchy if you configure
9483 @code{org-use-property-inheritance} accordingly.} properties if the selected
9484 entries have them. If not, the summary will be derived from the headline,
9485 and the description from the body (limited to
9486 @code{org-icalendar-include-body} characters).
9488 How this calendar is best read and updated, depends on the application
9489 you are using. The FAQ covers this issue.
9491 @node Publishing, Miscellaneous, Exporting, Top
9494 @cindex O'Toole, David
9496 Org includes a publishing management system that allows you to configure
9497 automatic HTML conversion of @emph{projects} composed of interlinked org
9498 files. You can also configure Org to automatically upload your exported HTML
9499 pages and related attachments, such as images and source code files, to a web
9502 You can also use Org to convert files into PDF, or even combine HTML and PDF
9503 conversion so that files are available in both formats on the server.
9505 Publishing has been contributed to Org by David O'Toole.
9508 * Configuration:: Defining projects
9509 * Uploading files:: How to get files up on the server
9510 * Sample configuration:: Example projects
9511 * Triggering publication:: Publication commands
9514 @node Configuration, Uploading files, Publishing, Publishing
9515 @section Configuration
9517 Publishing needs significant configuration to specify files, destination
9518 and many other properties of a project.
9521 * Project alist:: The central configuration variable
9522 * Sources and destinations:: From here to there
9523 * Selecting files:: What files are part of the project?
9524 * Publishing action:: Setting the function doing the publishing
9525 * Publishing options:: Tweaking HTML export
9526 * Publishing links:: Which links keep working after publishing?
9527 * Project page index:: Publishing a list of project files
9530 @node Project alist, Sources and destinations, Configuration, Configuration
9531 @subsection The variable @code{org-publish-project-alist}
9532 @cindex org-publish-project-alist
9533 @cindex projects, for publishing
9535 @vindex org-publish-project-alist
9536 Publishing is configured almost entirely through setting the value of one
9537 variable, called @code{org-publish-project-alist}. Each element of the list
9538 configures one project, and may be in one of the two following forms:
9541 ("project-name" :property value :property value ...)
9543 ("project-name" :components ("project-name" "project-name" ...))
9547 In both cases, projects are configured by specifying property values. A
9548 project defines the set of files that will be published, as well as the
9549 publishing configuration to use when publishing those files. When a project
9550 takes the second form listed above, the individual members of the
9551 @code{:components} property are taken to be sub-projects, which group
9552 together files requiring different publishing options. When you publish such
9553 a ``meta-project'', all the components will also be published, in the
9556 @node Sources and destinations, Selecting files, Project alist, Configuration
9557 @subsection Sources and destinations for files
9558 @cindex directories, for publishing
9560 Most properties are optional, but some should always be set. In
9561 particular, Org needs to know where to look for source files,
9562 and where to put published files.
9564 @multitable @columnfractions 0.3 0.7
9565 @item @code{:base-directory}
9566 @tab Directory containing publishing source files
9567 @item @code{:publishing-directory}
9568 @tab Directory where output files will be published. You can directly
9569 publish to a webserver using a file name syntax appropriate for
9570 the Emacs @file{tramp} package. Or you can publish to a local directory and
9571 use external tools to upload your website (@pxref{Uploading files}).
9572 @item @code{:preparation-function}
9573 @tab Function called before starting the publishing process, for example, to
9574 run @code{make} for updating files to be published.
9575 @item @code{:completion-function}
9576 @tab Function called after finishing the publishing process, for example, to
9577 change permissions of the resulting files.
9581 @node Selecting files, Publishing action, Sources and destinations, Configuration
9582 @subsection Selecting files
9583 @cindex files, selecting for publishing
9585 By default, all files with extension @file{.org} in the base directory
9586 are considered part of the project. This can be modified by setting the
9588 @multitable @columnfractions 0.25 0.75
9589 @item @code{:base-extension}
9590 @tab Extension (without the dot!) of source files. This actually is a
9591 regular expression. Set this to the symbol @code{any} if you want to get all
9592 files in @code{:base-directory}, even without extension.
9594 @item @code{:exclude}
9595 @tab Regular expression to match file names that should not be
9596 published, even though they have been selected on the basis of their
9599 @item @code{:include}
9600 @tab List of files to be included regardless of @code{:base-extension}
9601 and @code{:exclude}.
9604 @node Publishing action, Publishing options, Selecting files, Configuration
9605 @subsection Publishing action
9606 @cindex action, for publishing
9608 Publishing means that a file is copied to the destination directory and
9609 possibly transformed in the process. The default transformation is to export
9610 Org files as HTML files, and this is done by the function
9611 @code{org-publish-org-to-html} which calls the HTML exporter (@pxref{HTML
9612 export}). But you also can publish your content as PDF files using
9613 @code{org-publish-org-to-pdf}. If you want to publish the Org file itself,
9614 but with @i{archived}, @i{commented}, and @i{tag-excluded} trees removed, use
9615 @code{org-publish-org-to-org} and set the parameters @code{:plain-source}
9616 and/or @code{:htmlized-source}. This will produce @file{file.org} and
9617 @file{file.org.html} in the publishing
9618 directory@footnote{@file{file-source.org} and @file{file-source.org.html} if
9619 source and publishing directories are equal. Note that with this kind of
9620 setup, you need to add @code{:exclude "-source\\.org"} to the project
9621 definition in @code{org-publish-project-alist} to avoid that the published
9622 source files will be considered as new org files the next time the project is
9623 published.}. Other files like images only
9624 need to be copied to the publishing destination, for this you may use
9625 @code{org-publish-attachment}. For non-Org files, you always need to
9626 specify the publishing function:
9628 @multitable @columnfractions 0.3 0.7
9629 @item @code{:publishing-function}
9630 @tab Function executing the publication of a file. This may also be a
9631 list of functions, which will all be called in turn.
9632 @item @code{:plain-source}
9633 @tab Non-nil means, publish plain source.
9634 @item @code{:htmlized-source}
9635 @tab Non-nil means, publish htmlized source.
9638 The function must accept two arguments: a property list containing at least a
9639 @code{:publishing-directory} property, and the name of the file to be
9640 published. It should take the specified file, make the necessary
9641 transformation (if any) and place the result into the destination folder.
9643 @node Publishing options, Publishing links, Publishing action, Configuration
9644 @subsection Options for the HTML/La@TeX{} exporters
9645 @cindex options, for publishing
9647 The property list can be used to set many export options for the HTML
9648 and La@TeX{} exporters. In most cases, these properties correspond to user
9649 variables in Org. The table below lists these properties along
9650 with the variable they belong to. See the documentation string for the
9651 respective variable for details.
9653 @vindex org-export-html-link-up
9654 @vindex org-export-html-link-home
9655 @vindex org-export-default-language
9656 @vindex org-display-custom-times
9657 @vindex org-export-headline-levels
9658 @vindex org-export-with-section-numbers
9659 @vindex org-export-section-number-format
9660 @vindex org-export-with-toc
9661 @vindex org-export-preserve-breaks
9662 @vindex org-export-with-archived-trees
9663 @vindex org-export-with-emphasize
9664 @vindex org-export-with-sub-superscripts
9665 @vindex org-export-with-special-strings
9666 @vindex org-export-with-footnotes
9667 @vindex org-export-with-drawers
9668 @vindex org-export-with-tags
9669 @vindex org-export-with-todo-keywords
9670 @vindex org-export-with-priority
9671 @vindex org-export-with-TeX-macros
9672 @vindex org-export-with-LaTeX-fragments
9673 @vindex org-export-skip-text-before-1st-heading
9674 @vindex org-export-with-fixed-width
9675 @vindex org-export-with-timestamps
9676 @vindex org-export-author-info
9677 @vindex org-export-creator-info
9678 @vindex org-export-with-tables
9679 @vindex org-export-highlight-first-table-line
9680 @vindex org-export-html-style-include-default
9681 @vindex org-export-html-style
9682 @vindex org-export-html-style-extra
9683 @vindex org-export-html-link-org-files-as-html
9684 @vindex org-export-html-inline-images
9685 @vindex org-export-html-extension
9686 @vindex org-export-html-table-tag
9687 @vindex org-export-html-expand
9688 @vindex org-export-html-with-timestamp
9689 @vindex org-export-publishing-directory
9690 @vindex org-export-html-preamble
9691 @vindex org-export-html-postamble
9692 @vindex org-export-html-auto-preamble
9693 @vindex org-export-html-auto-postamble
9694 @vindex user-full-name
9695 @vindex user-mail-address
9696 @vindex org-export-select-tags
9697 @vindex org-export-exclude-tags
9699 @multitable @columnfractions 0.32 0.68
9700 @item @code{:link-up} @tab @code{org-export-html-link-up}
9701 @item @code{:link-home} @tab @code{org-export-html-link-home}
9702 @item @code{:language} @tab @code{org-export-default-language}
9703 @item @code{:customtime} @tab @code{org-display-custom-times}
9704 @item @code{:headline-levels} @tab @code{org-export-headline-levels}
9705 @item @code{:section-numbers} @tab @code{org-export-with-section-numbers}
9706 @item @code{:section-number-format} @tab @code{org-export-section-number-format}
9707 @item @code{:table-of-contents} @tab @code{org-export-with-toc}
9708 @item @code{:preserve-breaks} @tab @code{org-export-preserve-breaks}
9709 @item @code{:archived-trees} @tab @code{org-export-with-archived-trees}
9710 @item @code{:emphasize} @tab @code{org-export-with-emphasize}
9711 @item @code{:sub-superscript} @tab @code{org-export-with-sub-superscripts}
9712 @item @code{:special-strings} @tab @code{org-export-with-special-strings}
9713 @item @code{:footnotes} @tab @code{org-export-with-footnotes}
9714 @item @code{:drawers} @tab @code{org-export-with-drawers}
9715 @item @code{:tags} @tab @code{org-export-with-tags}
9716 @item @code{:todo-keywords} @tab @code{org-export-with-todo-keywords}
9717 @item @code{:priority} @tab @code{org-export-with-priority}
9718 @item @code{:TeX-macros} @tab @code{org-export-with-TeX-macros}
9719 @item @code{:LaTeX-fragments} @tab @code{org-export-with-LaTeX-fragments}
9720 @item @code{:latex-listings} @tab @code{org-export-latex-listings}
9721 @item @code{:skip-before-1st-heading} @tab @code{org-export-skip-text-before-1st-heading}
9722 @item @code{:fixed-width} @tab @code{org-export-with-fixed-width}
9723 @item @code{:timestamps} @tab @code{org-export-with-timestamps}
9724 @item @code{:author-info} @tab @code{org-export-author-info}
9725 @item @code{:creator-info} @tab @code{org-export-creator-info}
9726 @item @code{:tables} @tab @code{org-export-with-tables}
9727 @item @code{:table-auto-headline} @tab @code{org-export-highlight-first-table-line}
9728 @item @code{:style-include-default} @tab @code{org-export-html-style-include-default}
9729 @item @code{:style} @tab @code{org-export-html-style}
9730 @item @code{:style-extra} @tab @code{org-export-html-style-extra}
9731 @item @code{:convert-org-links} @tab @code{org-export-html-link-org-files-as-html}
9732 @item @code{:inline-images} @tab @code{org-export-html-inline-images}
9733 @item @code{:html-extension} @tab @code{org-export-html-extension}
9734 @item @code{:xml-declaration} @tab @code{org-export-html-xml-declaration}
9735 @item @code{:html-table-tag} @tab @code{org-export-html-table-tag}
9736 @item @code{:expand-quoted-html} @tab @code{org-export-html-expand}
9737 @item @code{:timestamp} @tab @code{org-export-html-with-timestamp}
9738 @item @code{:publishing-directory} @tab @code{org-export-publishing-directory}
9739 @item @code{:preamble} @tab @code{org-export-html-preamble}
9740 @item @code{:postamble} @tab @code{org-export-html-postamble}
9741 @item @code{:auto-preamble} @tab @code{org-export-html-auto-preamble}
9742 @item @code{:auto-postamble} @tab @code{org-export-html-auto-postamble}
9743 @item @code{:author} @tab @code{user-full-name}
9744 @item @code{:email} @tab @code{user-mail-address} : @code{addr;addr;..}
9745 @item @code{:select-tags} @tab @code{org-export-select-tags}
9746 @item @code{:exclude-tags} @tab @code{org-export-exclude-tags}
9747 @item @code{:latex-image-options} @tab @code{org-export-latex-image-default-option}
9750 Most of the @code{org-export-with-*} variables have the same effect in
9751 both HTML and La@TeX{} exporters, except for @code{:TeX-macros} and
9752 @code{:LaTeX-fragments}, respectively @code{nil} and @code{t} in the
9755 @vindex org-publish-project-alist
9756 When a property is given a value in @code{org-publish-project-alist},
9757 its setting overrides the value of the corresponding user variable (if
9758 any) during publishing. Options set within a file (@pxref{Export
9759 options}), however, override everything.
9761 @node Publishing links, Project page index, Publishing options, Configuration
9762 @subsection Links between published files
9763 @cindex links, publishing
9765 To create a link from one Org file to another, you would use
9766 something like @samp{[[file:foo.org][The foo]]} or simply
9767 @samp{file:foo.org.} (@pxref{Hyperlinks}). When published, this link
9768 becomes a link to @file{foo.html}. In this way, you can interlink the
9769 pages of your "org web" project and the links will work as expected when
9770 you publish them to HTML. If you also publish the Org source file and want
9771 to link to that, use an @code{http:} link instead of a @code{file:} link,
9772 because @code{file:} links are converted to link to the corresponding
9775 You may also link to related files, such as images. Provided you are careful
9776 with relative file names, and provided you have also configured Org to upload
9777 the related files, these links will work too. See @ref{Complex example}, for
9778 an example of this usage.
9780 Sometimes an Org file to be published may contain links that are
9781 only valid in your production environment, but not in the publishing
9782 location. In this case, use the property
9784 @multitable @columnfractions 0.4 0.6
9785 @item @code{:link-validation-function}
9786 @tab Function to validate links
9790 to define a function for checking link validity. This function must
9791 accept two arguments, the file name and a directory relative to which
9792 the file name is interpreted in the production environment. If this
9793 function returns @code{nil}, then the HTML generator will only insert a
9794 description into the HTML file, but no link. One option for this
9795 function is @code{org-publish-validate-link} which checks if the given
9796 file is part of any project in @code{org-publish-project-alist}.
9798 @node Project page index, , Publishing links, Configuration
9799 @subsection Project page index
9800 @cindex index, of published pages
9802 The following properties may be used to control publishing of an
9803 index of files or a summary page for a given project.
9805 @multitable @columnfractions 0.25 0.75
9806 @item @code{:auto-index}
9807 @tab When non-nil, publish an index during @code{org-publish-current-project}
9808 or @code{org-publish-all}.
9810 @item @code{:index-filename}
9811 @tab Filename for output of index. Defaults to @file{sitemap.org} (which
9812 becomes @file{sitemap.html}).
9814 @item @code{:index-title}
9815 @tab Title of index page. Defaults to name of file.
9817 @item @code{:index-function}
9818 @tab Plug-in function to use for generation of index.
9819 Defaults to @code{org-publish-org-index}, which generates a plain list
9820 of links to all files in the project.
9823 @node Uploading files, Sample configuration, Configuration, Publishing
9824 @section Uploading files
9828 For those people already utilizing third party sync tools such as
9829 @command{rsync} or @command{unison}, it might be preferable not to use the built in
9830 @i{remote} publishing facilities of Org mode which rely heavily on
9831 Tramp. Tramp, while very useful and powerful, tends not to be
9832 so efficient for multiple file transfer and has been known to cause problems
9835 Specialized synchronization utilities offer several advantages. In addition
9836 to timestamp comparison, they also do content and permissions/attribute
9837 checks. For this reason you might prefer to publish your web to a local
9838 directory (possibly even @i{in place} with your Org files) and then use
9839 @file{unison} or @file{rsync} to do the synchronization with the remote host.
9841 Since Unison (for example) can be configured as to which files to transfer to
9842 a certain remote destination, it can greatly simplify the project publishing
9843 definition. Simply keep all files in the correct location, process your Org
9844 files with @code{org-publish} and let the synchronization tool do the rest.
9845 You do not need, in this scenario, to include attachments such as @file{jpg},
9846 @file{css} or @file{gif} files in the project definition since the 3rd party
9849 Publishing to a local directory is also much faster than to a remote one, so
9850 that you can afford more easily to republish entire projects. If you set
9851 @code{org-publish-use-timestamps-flag} to @code{nil}, you gain the main
9852 benefit of re-including any changed external files such as source example
9853 files you might include with @code{#+INCLUDE}. The timestamp mechanism in
9854 Org is not smart enough to detect if included files have been modified.
9856 @node Sample configuration, Triggering publication, Uploading files, Publishing
9857 @section Sample configuration
9859 Below we provide two example configurations. The first one is a simple
9860 project publishing only a set of Org files. The second example is
9861 more complex, with a multi-component project.
9864 * Simple example:: One-component publishing
9865 * Complex example:: A multi-component publishing example
9868 @node Simple example, Complex example, Sample configuration, Sample configuration
9869 @subsection Example: simple publishing configuration
9871 This example publishes a set of Org files to the @file{public_html}
9872 directory on the local machine.
9875 (setq org-publish-project-alist
9877 :base-directory "~/org/"
9878 :publishing-directory "~/public_html"
9879 :section-numbers nil
9880 :table-of-contents nil
9881 :style "<link rel=\"stylesheet\"
9882 href=\"../other/mystyle.css\"
9883 type=\"text/css\"/>")))
9886 @node Complex example, , Simple example, Sample configuration
9887 @subsection Example: complex publishing configuration
9889 This more complicated example publishes an entire website, including
9890 Org files converted to HTML, image files, Emacs Lisp source code, and
9891 style sheets. The publishing directory is remote and private files are
9894 To ensure that links are preserved, care should be taken to replicate
9895 your directory structure on the web server, and to use relative file
9896 paths. For example, if your Org files are kept in @file{~/org} and your
9897 publishable images in @file{~/images}, you'd link to an image with
9900 file:../images/myimage.png
9903 On the web server, the relative path to the image should be the
9904 same. You can accomplish this by setting up an "images" folder in the
9905 right place on the web server, and publishing images to it.
9908 (setq org-publish-project-alist
9910 :base-directory "~/org/"
9911 :base-extension "org"
9912 :publishing-directory "/ssh:user@@host:~/html/notebook/"
9913 :publishing-function org-publish-org-to-html
9914 :exclude "PrivatePage.org" ;; regexp
9916 :section-numbers nil
9917 :table-of-contents nil
9918 :style "<link rel=\"stylesheet\"
9919 href=\"../other/mystyle.css\" type=\"text/css\"/>"
9921 :auto-postamble nil)
9924 :base-directory "~/images/"
9925 :base-extension "jpg\\|gif\\|png"
9926 :publishing-directory "/ssh:user@@host:~/html/images/"
9927 :publishing-function org-publish-attachment)
9930 :base-directory "~/other/"
9931 :base-extension "css\\|el"
9932 :publishing-directory "/ssh:user@@host:~/html/other/"
9933 :publishing-function org-publish-attachment)
9934 ("website" :components ("orgfiles" "images" "other"))))
9937 @node Triggering publication, , Sample configuration, Publishing
9938 @section Triggering publication
9940 Once properly configured, Org can publish with the following commands:
9945 Prompt for a specific project and publish all files that belong to it.
9948 Publish the project containing the current file.
9951 Publish only the current file.
9954 Publish every project.
9957 @vindex org-publish-use-timestamps-flag
9958 Org uses timestamps to track when a file has changed. The above functions
9959 normally only publish changed files. You can override this and force
9960 publishing of all files by giving a prefix argument to any of the commands
9961 above, or by customizing the variable @code{org-publish-use-timestamps-flag}.
9962 This may be necessary in particular if files include other files via
9963 @code{#+SETUPFILE:} or @code{#+INCLUDE:}.
9965 @node Miscellaneous, Hacking, Publishing, Top
9966 @chapter Miscellaneous
9969 * Completion:: M-TAB knows what you need
9970 * Customization:: Adapting Org to your taste
9971 * In-buffer settings:: Overview of the #+KEYWORDS
9972 * The very busy C-c C-c key:: When in doubt, press C-c C-c
9973 * Clean view:: Getting rid of leading stars in the outline
9974 * TTY keys:: Using Org on a tty
9975 * Interaction:: Other Emacs packages
9979 @node Completion, Customization, Miscellaneous, Miscellaneous
9981 @cindex completion, of @TeX{} symbols
9982 @cindex completion, of TODO keywords
9983 @cindex completion, of dictionary words
9984 @cindex completion, of option keywords
9985 @cindex completion, of tags
9986 @cindex completion, of property keys
9987 @cindex completion, of link abbreviations
9988 @cindex @TeX{} symbol completion
9989 @cindex TODO keywords completion
9990 @cindex dictionary word completion
9991 @cindex option keyword completion
9992 @cindex tag completion
9993 @cindex link abbreviations, completion of
9995 Emacs would not be Emacs without completion, and Org-mode uses it whenever it
9996 makes sense. If you prefer an @i{iswitchb}- or @i{ido}-like interface for
9997 some of the completion prompts, you can specify your preferece by setting at
9998 most one of the variables @code{org-completion-use-iswitchb}
9999 @code{org-completion-use-ido}.
10001 Org supports in-buffer completion. This type of completion does
10002 not make use of the minibuffer. You simply type a few letters into
10003 the buffer and use the key to complete text right there.
10006 @kindex M-@key{TAB}
10008 Complete word at point
10011 At the beginning of a headline, complete TODO keywords.
10013 After @samp{\}, complete @TeX{} symbols supported by the exporter.
10015 After @samp{*}, complete headlines in the current buffer so that they
10016 can be used in search links like @samp{[[*find this headline]]}.
10018 After @samp{:} in a headline, complete tags. The list of tags is taken
10019 from the variable @code{org-tag-alist} (possibly set through the
10020 @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
10021 dynamically from all tags used in the current buffer.
10023 After @samp{:} and not in a headline, complete property keys. The list
10024 of keys is constructed dynamically from all keys used in the current
10027 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
10029 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
10030 @samp{OPTIONS} which set file-specific options for Org mode. When the
10031 option keyword is already complete, pressing @kbd{M-@key{TAB}} again
10032 will insert example settings for this keyword.
10034 In the line after @samp{#+STARTUP: }, complete startup keywords,
10035 @ie valid keys for this line.
10037 Elsewhere, complete dictionary words using Ispell.
10041 @node Customization, In-buffer settings, Completion, Miscellaneous
10042 @section Customization
10043 @cindex customization
10044 @cindex options, for customization
10045 @cindex variables, for customization
10047 There are more than 180 variables that can be used to customize
10048 Org. For the sake of compactness of the manual, I am not
10049 describing the variables here. A structured overview of customization
10050 variables is available with @kbd{M-x org-customize}. Or select
10051 @code{Browse Org Group} from the @code{Org->Customization} menu. Many
10052 settings can also be activated on a per-file basis, by putting special
10053 lines into the buffer (@pxref{In-buffer settings}).
10055 @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous
10056 @section Summary of in-buffer settings
10057 @cindex in-buffer settings
10058 @cindex special keywords
10060 Org mode uses special lines in the buffer to define settings on a
10061 per-file basis. These lines start with a @samp{#+} followed by a
10062 keyword, a colon, and then individual words defining a setting. Several
10063 setting words can be in the same line, but you can also have multiple
10064 lines for the keyword. While these settings are described throughout
10065 the manual, here is a summary. After changing any of those lines in the
10066 buffer, press @kbd{C-c C-c} with the cursor still in the line to
10067 activate the changes immediately. Otherwise they become effective only
10068 when the file is visited again in a new Emacs session.
10070 @vindex org-archive-location
10072 @item #+ARCHIVE: %s_done::
10073 This line sets the archive location for the agenda file. It applies for
10074 all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
10075 of the file. The first such line also applies to any entries before it.
10076 The corresponding variable is @code{org-archive-location}.
10078 This line sets the category for the agenda file. The category applies
10079 for all subsequent lines until the next @samp{#+CATEGORY} line, or the
10080 end of the file. The first such line also applies to any entries before it.
10081 @item #+COLUMNS: %25ITEM .....
10082 @cindex property, COLUMNS
10083 Set the default format for columns view. This format applies when
10084 columns view is invoked in locations where no @code{COLUMNS} property
10086 @item #+CONSTANTS: name1=value1 ...
10087 @vindex org-table-formula-constants
10088 @vindex org-table-formula
10089 Set file-local values for constants to be used in table formulas. This
10090 line set the local variable @code{org-table-formula-constants-local}.
10091 The global version of this variable is
10092 @code{org-table-formula-constants}.
10093 @item #+FILETAGS: :tag1:tag2:tag3:
10094 Set tags that can be inherited by any entry in the file, including the
10096 @item #+DRAWERS: NAME1 .....
10097 @vindex org-drawers
10098 Set the file-local set of drawers. The corresponding global variable is
10099 @code{org-drawers}.
10100 @item #+LINK: linkword replace
10101 @vindex org-link-abbrev-alist
10102 These lines (several are allowed) specify link abbreviations.
10103 @xref{Link abbreviations}. The corresponding variable is
10104 @code{org-link-abbrev-alist}.
10105 @item #+PRIORITIES: highest lowest default
10106 @vindex org-highest-priority
10107 @vindex org-lowest-priority
10108 @vindex org-default-priority
10109 This line sets the limits and the default for the priorities. All three
10110 must be either letters A-Z or numbers 0-9. The highest priority must
10111 have a lower ASCII number that the lowest priority.
10112 @item #+PROPERTY: Property_Name Value
10113 This line sets a default inheritance value for entries in the current
10114 buffer, most useful for specifying the allowed values of a property.
10115 @cindex #+SETUPFILE
10116 @item #+SETUPFILE: file
10117 This line defines a file that holds more in-buffer setup. Normally this is
10118 entirely ignored. Only when the buffer is parsed for option-setting lines
10119 (@ie when starting Org mode for a file, when pressing @kbd{C-c C-c} in a
10120 settings line, or when exporting), then the contents of this file are parsed
10121 as if they had been included in the buffer. In particular, the file can be
10122 any other Org mode file with internal setup. You can visit the file the
10123 cursor is in the line with @kbd{C-c '}.
10126 This line sets options to be used at startup of Org mode, when an
10127 Org file is being visited.
10129 The first set of options deals with the initial visibility of the outline
10130 tree. The corresponding variable for global default settings is
10131 @code{org-startup-folded}, with a default value @code{t}, which means
10133 @vindex org-startup-folded
10134 @cindex @code{overview}, STARTUP keyword
10135 @cindex @code{content}, STARTUP keyword
10136 @cindex @code{showall}, STARTUP keyword
10138 overview @r{top-level headlines only}
10139 content @r{all headlines}
10140 showall @r{no folding at all, show everything}
10143 @vindex org-startup-indented
10144 @cindex @code{indent}, STARTUP keyword
10145 @cindex @code{noindent}, STARTUP keyword
10146 Dynamic virtual indentation is controlled by the variable
10147 @code{org-startup-indented}@footnote{Emacs 23 and Org-mode 6.29 are required}
10149 indent @r{start with @code{org-indent-mode} turned on}
10150 noindent @r{start with @code{org-indent-mode} turned off}
10153 @vindex org-startup-align-all-tables
10154 Then there are options for aligning tables upon visiting a file. This
10155 is useful in files containing narrowed table columns. The corresponding
10156 variable is @code{org-startup-align-all-tables}, with a default value
10158 @cindex @code{align}, STARTUP keyword
10159 @cindex @code{noalign}, STARTUP keyword
10161 align @r{align all tables}
10162 noalign @r{don't align tables on startup}
10164 @vindex org-log-done
10165 @vindex org-log-note-clock-out
10166 @vindex org-log-repeat
10167 Logging the closing and reopening of TODO items and clock intervals can be
10168 configured using these options (see variables @code{org-log-done},
10169 @code{org-log-note-clock-out} and @code{org-log-repeat})
10170 @cindex @code{logdone}, STARTUP keyword
10171 @cindex @code{lognotedone}, STARTUP keyword
10172 @cindex @code{nologdone}, STARTUP keyword
10173 @cindex @code{lognoteclock-out}, STARTUP keyword
10174 @cindex @code{nolognoteclock-out}, STARTUP keyword
10175 @cindex @code{logrepeat}, STARTUP keyword
10176 @cindex @code{lognoterepeat}, STARTUP keyword
10177 @cindex @code{nologrepeat}, STARTUP keyword
10179 logdone @r{record a timestamp when an item is marked DONE}
10180 lognotedone @r{record timestamp and a note when DONE}
10181 nologdone @r{don't record when items are marked DONE}
10182 logrepeat @r{record a time when reinstating a repeating item}
10183 lognoterepeat @r{record a note when reinstating a repeating item}
10184 nologrepeat @r{do not record when reinstating repeating item}
10185 lognoteclock-out @r{record a note when clocking out}
10186 nolognoteclock-out @r{don't record a note when clocking out}
10188 @vindex org-hide-leading-stars
10189 @vindex org-odd-levels-only
10190 Here are the options for hiding leading stars in outline headings, and for
10191 indenting outlines. The corresponding variables are
10192 @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
10193 default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
10194 @cindex @code{hidestars}, STARTUP keyword
10195 @cindex @code{showstars}, STARTUP keyword
10196 @cindex @code{odd}, STARTUP keyword
10197 @cindex @code{even}, STARTUP keyword
10199 hidestars @r{make all but one of the stars starting a headline invisible.}
10200 showstars @r{show all stars starting a headline}
10201 indent @r{virtual indentation according to outline level}
10202 noindent @r{no virtual indentation according to outline level}
10203 odd @r{allow only odd outline levels (1,3,...)}
10204 oddeven @r{allow all outline levels}
10206 @vindex org-put-time-stamp-overlays
10207 @vindex org-time-stamp-overlay-formats
10208 To turn on custom format overlays over timestamps (variables
10209 @code{org-put-time-stamp-overlays} and
10210 @code{org-time-stamp-overlay-formats}), use
10211 @cindex @code{customtime}, STARTUP keyword
10213 customtime @r{overlay custom time format}
10215 @vindex constants-unit-system
10216 The following options influence the table spreadsheet (variable
10217 @code{constants-unit-system}).
10218 @cindex @code{constcgs}, STARTUP keyword
10219 @cindex @code{constSI}, STARTUP keyword
10221 constcgs @r{@file{constants.el} should use the c-g-s unit system}
10222 constSI @r{@file{constants.el} should use the SI unit system}
10224 @vindex org-footnote-define-inline
10225 @vindex org-footnote-auto-label
10226 @vindex org-footnote-auto-adjust
10227 To influence footnote settings, use the following keywords. The
10228 corresponding variables are @code{org-footnote-define-inline},
10229 @code{org-footnote-auto-label}, and @code{org-footnote-auto-adjust}.
10230 @cindex @code{fninline}, STARTUP keyword
10231 @cindex @code{nofninline}, STARTUP keyword
10232 @cindex @code{fnlocal}, STARTUP keyword
10233 @cindex @code{fnprompt}, STARTUP keyword
10234 @cindex @code{fnauto}, STARTUP keyword
10235 @cindex @code{fnconfirm}, STARTUP keyword
10236 @cindex @code{fnplain}, STARTUP keyword
10237 @cindex @code{fnadjust}, STARTUP keyword
10238 @cindex @code{nofnadjust}, STARTUP keyword
10240 fninline @r{define footnotes inline}
10241 fnnoinline @r{define footnotes in separate section}
10242 fnlocal @r{define footnotes near first reference, but not inline}
10243 fnprompt @r{prompt for footnote labels}
10244 fnauto @r{create [fn:1]-like labels automatically (default)}
10245 fnconfirm @r{offer automatic label for editing or confirmation}
10246 fnplain @r{create [1]-like labels automatically}
10247 fnadjust @r{automatically renumber and sort footnotes}
10248 nofnadjust @r{do not renumber and sort automatically}
10250 @cindex org-hide-block-startup
10251 To hide blocks on startup, use these keywords. The corresponding variable is
10252 @code{org-hide-block-startup}.
10253 @cindex @code{hideblocks}, STARTUP keyword
10254 @cindex @code{nohideblocks}, STARTUP keyword
10256 hideblocks @r{Hide all begin/end blocks on startup}
10257 nohideblocks @r{Do not hide blocks on startup}
10259 @item #+TAGS: TAG1(c1) TAG2(c2)
10260 @vindex org-tag-alist
10261 These lines (several such lines are allowed) specify the valid tags in
10262 this file, and (potentially) the corresponding @emph{fast tag selection}
10263 keys. The corresponding variable is @code{org-tag-alist}.
10265 This line contains the formulas for the table directly above the line.
10266 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+DATE:,
10267 @itemx #+OPTIONS:, #+BIND:
10268 @itemx #+DESCRIPTION:, #+KEYWORDS:
10269 @itemx #+LATEX_HEADER:, #+STYLE:, #+LINK_UP:, #+LINK_HOME:,
10270 @itemx #+EXPORT_SELECT_TAGS:, #+EXPORT_EXCLUDE_TAGS:
10271 These lines provide settings for exporting files. For more details see
10272 @ref{Export options}.
10273 @item #+TODO: #+SEQ_TODO: #+TYP_TODO:
10274 @vindex org-todo-keywords
10275 These lines set the TODO keywords and their interpretation in the
10276 current file. The corresponding variable is @code{org-todo-keywords}.
10279 @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous
10280 @section The very busy C-c C-c key
10282 @cindex C-c C-c, overview
10284 The key @kbd{C-c C-c} has many purposes in Org, which are all
10285 mentioned scattered throughout this manual. One specific function of
10286 this key is to add @emph{tags} to a headline (@pxref{Tags}). In many
10287 other circumstances it means something like @emph{``Hey Org, look
10288 here and update according to what you see here''}. Here is a summary of
10289 what this means in different contexts.
10293 If there are highlights in the buffer from the creation of a sparse
10294 tree, or from clock display, remove these highlights.
10296 If the cursor is in one of the special @code{#+KEYWORD} lines, this
10297 triggers scanning the buffer for these lines and updating the
10300 If the cursor is inside a table, realign the table. This command
10301 works even if the automatic table editor has been turned off.
10303 If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
10306 If the cursor is inside a table created by the @file{table.el} package,
10307 activate that table.
10309 If the current buffer is a Remember buffer, close the note and file it.
10310 With a prefix argument, file it, without further interaction, to the
10313 If the cursor is on a @code{<<<target>>>}, update radio targets and
10314 corresponding links in this buffer.
10316 If the cursor is in a property line or at the start or end of a property
10317 drawer, offer property commands.
10319 If the cursor is at a footnote reference, go to the corresponding
10320 definition, and vice versa.
10322 If the cursor is in a plain list item with a checkbox, toggle the status
10325 If the cursor is on a numbered item in a plain list, renumber the
10328 If the cursor is on the @code{#+BEGIN} line of a dynamic block, the
10332 @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous
10333 @section A cleaner outline view
10334 @cindex hiding leading stars
10335 @cindex dynamic indentation
10336 @cindex odd-levels-only outlines
10337 @cindex clean outline view
10339 Some people find it noisy and distracting that the Org headlines start with a
10340 potentially large number of stars, and that text below the headlines is not
10341 indented. While this is no problem when writing a @emph{book-like} document
10342 where the outline headings are really section headings, in a more
10343 @emph{list-oriented} outline, indented structure is a lot cleaner:
10347 * Top level headline | * Top level headline
10348 ** Second level | * Second level
10349 *** 3rd level | * 3rd level
10350 some text | some text
10351 *** 3rd level | * 3rd level
10352 more text | more text
10353 * Another top level headline | * Another top level headline
10358 If you are using at least Emacs 23.1.50.3 and version 6.29 of Org, this kind
10359 of view can be achieved dynamically at display time using
10360 @code{org-indent-mode}. In this minor mode, all lines are prefixed for
10361 display with the necessary amount of space. Also headlines are prefixed with
10362 additional stars, so that the amount of indentation shifts by
10363 two@footnote{See the variable @code{org-indent-indentation-per-level}.}
10364 spaces per level. All headline stars but the last one are made invisible
10365 using the @code{org-hide} face@footnote{Turning on @code{org-indent-mode}
10366 sets @code{org-hide-leading-stars} to @code{t} and
10367 @code{org-adapt-indentation} to @code{nil}.} - see below under @samp{2.} for
10368 more information on how this works. You can turn on @code{org-indent-mode}
10369 for all files by customizing the variable @code{org-startup-indented}, or you
10370 can turn it on for individual files using
10376 If you want a similar effect in earlier version of Emacs and/or Org, or if
10377 you want the indentation to be hard space characters so that the plain text
10378 file looks as similar as possible to the Emacs display, Org supports you in
10383 @emph{Indentation of text below headlines}@*
10384 You may indent text below each headline to make the left boundary line up
10385 with the headline, like
10389 more text, now indented
10392 @vindex org-adapt-indentation
10393 Org supports this with paragraph filling, line wrapping, and structure
10394 editing@footnote{See also the variable @code{org-adapt-indentation}.},
10395 preserving or adapting the indentation as appropriate.
10398 @vindex org-hide-leading-stars
10399 @emph{Hiding leading stars}@* You can modify the display in such a way that
10400 all leading stars become invisible. To do this in a global way, configure
10401 the variable @code{org-hide-leading-stars} or change this on a per-file basis
10405 #+STARTUP: hidestars
10406 #+STARTUP: showstars
10409 With hidden stars, the tree becomes:
10413 * Top level headline
10421 @vindex org-hide @r{(face)}
10422 The leading stars are not truly replaced by whitespace, they are only
10423 fontified with the face @code{org-hide} that uses the background color as
10424 font color. If you are not using either white or black background, you may
10425 have to customize this face to get the wanted effect. Another possibility is
10426 to set this font such that the extra stars are @i{almost} invisible, for
10427 example using the color @code{grey90} on a white background.
10430 @vindex org-odd-levels-only
10431 Things become cleaner still if you skip all the even levels and use only odd
10432 levels 1, 3, 5..., effectively adding two stars to go from one outline level
10433 to the next@footnote{When you need to specify a level for a property search
10434 or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc@.}. In this
10435 way we get the outline view shown at the beginning of this section. In order
10436 to make the structure editing and export commands handle this convention
10437 correctly, configure the variable @code{org-odd-levels-only}, or set this on
10438 a per-file basis with one of the following lines:
10445 You can convert an Org file from single-star-per-level to the
10446 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
10447 RET} in that file. The reverse operation is @kbd{M-x
10448 org-convert-to-oddeven-levels}.
10451 @node TTY keys, Interaction, Clean view, Miscellaneous
10452 @section Using Org on a tty
10453 @cindex tty key bindings
10455 Because Org contains a large number of commands, by default many of
10456 Org's core commands are bound to keys that are generally not
10457 accessible on a tty, such as the cursor keys (@key{left}, @key{right},
10458 @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
10459 together with modifiers like @key{Meta} and/or @key{Shift}. To access
10460 these commands on a tty when special keys are unavailable, the following
10461 alternative bindings can be used. The tty bindings below will likely be
10462 more cumbersome; you may find for some of the bindings below that a
10463 customized workaround suits you better. For example, changing a timestamp
10464 is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
10465 tty you would rather use @kbd{C-c .} to re-insert the timestamp.
10467 @multitable @columnfractions 0.15 0.2 0.2
10468 @item @b{Default} @tab @b{Alternative 1} @tab @b{Alternative 2}
10469 @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab
10470 @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{@key{Esc} @key{left}}
10471 @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab
10472 @item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{@key{Esc} @key{right}}
10473 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab
10474 @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{@key{Esc} @key{up}}
10475 @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab
10476 @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{@key{Esc} @key{down}}
10477 @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab
10478 @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab
10479 @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{@key{Esc} @key{RET}}
10480 @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab
10481 @item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab
10482 @item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab
10483 @item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab
10484 @item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab
10485 @item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab
10486 @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab
10490 @node Interaction, , TTY keys, Miscellaneous
10491 @section Interaction with other packages
10492 @cindex packages, interaction with other
10493 Org lives in the world of GNU Emacs and interacts in various ways
10494 with other code out there.
10497 * Cooperation:: Packages Org cooperates with
10498 * Conflicts:: Packages that lead to conflicts
10501 @node Cooperation, Conflicts, Interaction, Interaction
10502 @subsection Packages that Org cooperates with
10505 @cindex @file{calc.el}
10506 @cindex Gillespie, Dave
10507 @item @file{calc.el} by Dave Gillespie
10508 Org uses the Calc package for implementing spreadsheet
10509 functionality in its tables (@pxref{The spreadsheet}). Org
10510 checks for the availability of Calc by looking for the function
10511 @code{calc-eval} which will have been autoloaded during setup if Calc has
10512 been installed properly. As of Emacs 22, Calc is part of the Emacs
10513 distribution. Another possibility for interaction between the two
10514 packages is using Calc for embedded calculations. @xref{Embedded Mode,
10515 , Embedded Mode, Calc, GNU Emacs Calc Manual}.
10516 @item @file{constants.el} by Carsten Dominik
10517 @cindex @file{constants.el}
10518 @cindex Dominik, Carsten
10519 @vindex org-table-formula-constants
10520 In a table formula (@pxref{The spreadsheet}), it is possible to use
10521 names for natural constants or units. Instead of defining your own
10522 constants in the variable @code{org-table-formula-constants}, install
10523 the @file{constants} package which defines a large number of constants
10524 and units, and lets you use unit prefixes like @samp{M} for
10525 @samp{Mega}, etc@. You will need version 2.0 of this package, available
10526 at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for
10527 the function @code{constants-get}, which has to be autoloaded in your
10528 setup. See the installation instructions in the file
10529 @file{constants.el}.
10530 @item @file{cdlatex.el} by Carsten Dominik
10531 @cindex @file{cdlatex.el}
10532 @cindex Dominik, Carsten
10533 Org mode can make use of the CDLa@TeX{} package to efficiently enter
10534 La@TeX{} fragments into Org files. See @ref{CDLaTeX mode}.
10535 @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
10536 @cindex @file{imenu.el}
10537 Imenu allows menu access to an index of items in a file. Org mode
10538 supports Imenu---all you need to do to get the index is the following:
10540 (add-hook 'org-mode-hook
10541 (lambda () (imenu-add-to-menubar "Imenu")))
10543 @vindex org-imenu-depth
10544 By default the index is two levels deep---you can modify the depth using
10545 the option @code{org-imenu-depth}.
10546 @item @file{remember.el} by John Wiegley
10547 @cindex @file{remember.el}
10548 @cindex Wiegley, John
10549 Org cooperates with remember, see @ref{Remember}.
10550 @file{Remember.el} is not part of Emacs, find it on the web.
10551 @item @file{speedbar.el} by Eric M. Ludlam
10552 @cindex @file{speedbar.el}
10553 @cindex Ludlam, Eric M.
10554 Speedbar is a package that creates a special frame displaying files and
10555 index items in files. Org mode supports Speedbar and allows you to
10556 drill into Org files directly from the Speedbar. It also allows you to
10557 restrict the scope of agenda commands to a file or a subtree by using
10558 the command @kbd{<} in the Speedbar frame.
10559 @cindex @file{table.el}
10560 @item @file{table.el} by Takaaki Ota
10562 @cindex table editor, @file{table.el}
10563 @cindex @file{table.el}
10564 @cindex Ota, Takaaki
10566 Complex ASCII tables with automatic line wrapping, column- and
10567 row-spanning, and alignment can be created using the Emacs table
10568 package by Takaaki Ota (@uref{http://sourceforge.net/projects/table},
10569 and also part of Emacs 22).
10570 When @key{TAB} or @kbd{C-c C-c} is pressed in such a table, Org mode
10571 will call @command{table-recognize-table} and move the cursor into the
10572 table. Inside a table, the keymap of Org mode is inactive. In order
10573 to execute Org mode-related commands, leave the table.
10578 Recognize @file{table.el} table. Works when the cursor is in a
10583 Insert a @file{table.el} table. If there is already a table at point, this
10584 command converts it between the @file{table.el} format and the Org-mode
10585 format. See the documentation string of the command
10586 @code{org-convert-table} for the restrictions under which this is
10589 @file{table.el} is part of Emacs 22.
10590 @item @file{footnote.el} by Steven L. Baur
10591 @cindex @file{footnote.el}
10592 @cindex Baur, Steven L.
10593 Org mode recognizes numerical footnotes as provided by this package.
10594 However, Org mode also has its own footnote support (@pxref{Footnotes}),
10595 which makes using @file{footnote.el} unnecessary.
10598 @node Conflicts, , Cooperation, Interaction
10599 @subsection Packages that lead to conflicts with Org mode
10603 @cindex @code{shift-selection-mode}
10604 @vindex org-support-shift-select
10605 In Emacs 23, @code{shift-selection-mode} is on by default, meaning that
10606 cursor motions combined with the shift key should start or enlarge regions.
10607 This conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change
10608 timestamps, TODO keywords, priorities, and item bullet types if the cursor is
10609 at such a location. By default, @kbd{S-@key{cursor}} commands outside
10610 special contexts don't do anything, but you can customize the variable
10611 @code{org-support-shift-select}. Org mode then tries to accommodate shift
10612 selection by (i) using it outside of the special contexts where special
10613 commands apply, and by (ii) extending an existing active region even if the
10614 cursor moves across a special context.
10616 @item @file{CUA.el} by Kim. F. Storm
10617 @cindex @file{CUA.el}
10618 @cindex Storm, Kim. F.
10619 @vindex org-replace-disputed-keys
10620 Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by CUA mode
10621 (as well as @code{pc-select-mode} and @code{s-region-mode}) to select and extend the
10622 region. In fact, Emacs 23 has this built-in in the form of
10623 @code{shift-selection-mode}, see previous paragraph. If you are using Emacs
10624 23, you probably don't want to use another package for this purpose. However,
10625 if you prefer to leave these keys to a different package while working in
10626 Org mode, configure the variable @code{org-replace-disputed-keys}. When set,
10627 Org will move the following key bindings in Org files, and in the agenda
10628 buffer (but not during date selection).
10631 S-UP -> M-p S-DOWN -> M-n
10632 S-LEFT -> M-- S-RIGHT -> M-+
10633 C-S-LEFT -> M-S-- C-S-RIGHT -> M-S-+
10636 @vindex org-disputed-keys
10637 Yes, these are unfortunately more difficult to remember. If you want
10638 to have other replacement keys, look at the variable
10639 @code{org-disputed-keys}.
10641 @item @file{yasnippet.el}
10642 @cindex @file{yasnippet.el}
10643 The way Org-mode binds the TAB key (binding to @code{[tab]} instead of
10644 @code{"\t"}) overrules yasnippets' access to this key. The following code
10645 fixed this problem:
10648 (add-hook 'org-mode-hook
10650 (org-set-local 'yas/trigger-key [tab])
10651 (define-key yas/keymap [tab] 'yas/next-field-group)))
10654 @item @file{windmove.el} by Hovav Shacham
10655 @cindex @file{windmove.el}
10656 This package also uses the @kbd{S-<cursor>} keys, so everything written
10657 in the paragraph above about CUA mode also applies here.
10661 @node Hacking, History and Acknowledgments, Miscellaneous, Top
10665 This appendix covers some aspects where users can extend the functionality of
10669 * Hooks:: Who to reach into Org's internals
10670 * Add-on packages:: Available extensions
10671 * Adding hyperlink types:: New custom link types
10672 * Context-sensitive commands:: How to add functionality to such commands
10673 * Tables in arbitrary syntax:: Orgtbl for La@TeX{} and other programs
10674 * Dynamic blocks:: Automatically filled blocks
10675 * Special agenda views:: Customized views
10676 * Extracting agenda information:: Postprocessing of agenda information
10677 * Using the property API:: Writing programs that use entry properties
10678 * Using the mapping API:: Mapping over all or selected entries
10681 @node Hooks, Add-on packages, Hacking, Hacking
10685 Org has a large number of hook variables that can be used to add
10686 functionality. This appendix about hacking is going to illustrate the
10687 use of some of them. A complete list of all hooks with documentation is
10688 maintained by the Worg project and can be found at
10689 @uref{http://orgmode.org/worg/org-configs/org-hooks.php}.
10691 @node Add-on packages, Adding hyperlink types, Hooks, Hacking
10692 @section Add-on packages
10693 @cindex add-on packages
10695 A large number of add-on packages have been written by various authors.
10696 These packages are not part of Emacs, but they are distributed as contributed
10697 packages with the separate release available at the Org mode home page at
10698 @uref{http://orgmode.org}. The list of contributed packages, along with
10699 documentation about each package, is maintained by the Worg project at
10700 @uref{http://orgmode.org/worg/org-contrib/}.
10704 @node Adding hyperlink types, Context-sensitive commands, Add-on packages, Hacking
10705 @section Adding hyperlink types
10706 @cindex hyperlinks, adding new types
10708 Org has a large number of hyperlink types built-in
10709 (@pxref{Hyperlinks}). If you would like to add new link types, Org
10710 provides an interface for doing so. Let's look at an example file,
10711 @file{org-man.el}, that will add support for creating links like
10712 @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
10716 ;;; org-man.el - Support for links to manpages in Org
10720 (org-add-link-type "man" 'org-man-open)
10721 (add-hook 'org-store-link-functions 'org-man-store-link)
10723 (defcustom org-man-command 'man
10724 "The Emacs command to be used to display a man page."
10726 :type '(choice (const man) (const woman)))
10728 (defun org-man-open (path)
10729 "Visit the manpage on PATH.
10730 PATH should be a topic that can be thrown at the man command."
10731 (funcall org-man-command path))
10733 (defun org-man-store-link ()
10734 "Store a link to a manpage."
10735 (when (memq major-mode '(Man-mode woman-mode))
10736 ;; This is a man page, we do make this link
10737 (let* ((page (org-man-get-page-name))
10738 (link (concat "man:" page))
10739 (description (format "Manpage for %s" page)))
10740 (org-store-link-props
10743 :description description))))
10745 (defun org-man-get-page-name ()
10746 "Extract the page name from the buffer name."
10747 ;; This works for both `Man-mode' and `woman-mode'.
10748 (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
10749 (match-string 1 (buffer-name))
10750 (error "Cannot create link to this man page")))
10754 ;;; org-man.el ends here
10758 You would activate this new link type in @file{.emacs} with
10765 Let's go through the file and see what it does.
10768 It does @code{(require 'org)} to make sure that @file{org.el} has been
10771 The next line calls @code{org-add-link-type} to define a new link type
10772 with prefix @samp{man}. The call also contains the name of a function
10773 that will be called to follow such a link.
10775 @vindex org-store-link-functions
10776 The next line adds a function to @code{org-store-link-functions}, in
10777 order to allow the command @kbd{C-c l} to record a useful link in a
10778 buffer displaying a man page.
10781 The rest of the file defines the necessary variables and functions.
10782 First there is a customization variable that determines which Emacs
10783 command should be used to display man pages. There are two options,
10784 @code{man} and @code{woman}. Then the function to follow a link is
10785 defined. It gets the link path as an argument---in this case the link
10786 path is just a topic for the manual command. The function calls the
10787 value of @code{org-man-command} to display the man page.
10789 Finally the function @code{org-man-store-link} is defined. When you try
10790 to store a link with @kbd{C-c l}, this function will be called to
10791 try to make a link. The function must first decide if it is supposed to
10792 create the link for this buffer type; we do this by checking the value
10793 of the variable @code{major-mode}. If not, the function must exit and
10794 return the value @code{nil}. If yes, the link is created by getting the
10795 manual topic from the buffer name and prefixing it with the string
10796 @samp{man:}. Then it must call the command @code{org-store-link-props}
10797 and set the @code{:type} and @code{:link} properties. Optionally you
10798 can also set the @code{:description} property to provide a default for
10799 the link description when the link is later inserted into an Org
10800 buffer with @kbd{C-c C-l}.
10802 When is makes sense for your new link type, you may also define a function
10803 @code{org-PREFIX-complete-link} that implements special (@eg completion)
10804 support for inserting such a link with @kbd{C-c C-l}. Such a function should
10805 not accept any arguments, and return the full link with prefix.
10807 @node Context-sensitive commands, Tables in arbitrary syntax, Adding hyperlink types, Hacking
10808 @section Context-sensitive commands
10809 @cindex context-sensitive commands, hooks
10810 @cindex add-ons, context-sensitive commands
10811 @vindex org-ctrl-c-ctrl-c-hook
10813 Org has several commands that act differently depending on context. The most
10814 important example it the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}).
10815 Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys have this property.
10817 Add-ons can tap into this functionality by providing a function that detects
10818 special context for that add-on and executes functionality appropriate for
10819 the context. Here is an example from Dan Davison's @file{org-R.el} which
10820 allows you to evaluate commands based on the @file{R} programming language. For
10821 this package, special contexts are lines that start with @code{#+R:} or
10825 (defun org-R-apply-maybe ()
10826 "Detect if this is context for org-R and execute R commands."
10827 (if (save-excursion
10828 (beginning-of-line 1)
10829 (looking-at "#\\+RR?:"))
10830 (progn (call-interactively 'org-R-apply)
10831 t) ;; to signal that we took action
10832 nil)) ;; to signal that we did not
10834 (add-hook 'org-ctrl-c-ctrl-c-hook 'org-R-apply-maybe)
10837 The function first checks if the cursor is in such a line. If that is the
10838 case, @code{org-R-apply} is called and the function returns @code{t} to
10839 signal that action was taken, and @kbd{C-c C-c} will stop looking for other
10840 contexts. If the function finds it should do nothing locally, it returns @code{nil} so that other, similar functions can have a try.
10843 @node Tables in arbitrary syntax, Dynamic blocks, Context-sensitive commands, Hacking
10844 @section Tables and lists in arbitrary syntax
10845 @cindex tables, in other modes
10846 @cindex lists, in other modes
10847 @cindex Orgtbl mode
10849 Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
10850 frequent feature request has been to make it work with native tables in
10851 specific languages, for example La@TeX{}. However, this is extremely
10852 hard to do in a general way, would lead to a customization nightmare,
10853 and would take away much of the simplicity of the Orgtbl-mode table
10857 This appendix describes a different approach. We keep the Orgtbl mode
10858 table in its native format (the @i{source table}), and use a custom
10859 function to @i{translate} the table to the correct syntax, and to
10860 @i{install} it in the right location (the @i{target table}). This puts
10861 the burden of writing conversion functions on the user, but it allows
10862 for a very flexible system.
10864 Bastien added the ability to do the same with lists. You can use Org's
10865 facilities to edit and structure lists by turning @code{orgstruct-mode}
10866 on, then locally exporting such lists in another format (HTML, La@TeX{}
10871 * Radio tables:: Sending and receiving radio tables
10872 * A LaTeX example:: Step by step, almost a tutorial
10873 * Translator functions:: Copy and modify
10874 * Radio lists:: Doing the same for lists
10877 @node Radio tables, A LaTeX example, Tables in arbitrary syntax, Tables in arbitrary syntax
10878 @subsection Radio tables
10879 @cindex radio tables
10881 To define the location of the target table, you first need to create two
10882 lines that are comments in the current mode, but contain magic words for
10883 Orgtbl mode to find. Orgtbl mode will insert the translated table
10884 between these lines, replacing whatever was there before. For example:
10887 /* BEGIN RECEIVE ORGTBL table_name */
10888 /* END RECEIVE ORGTBL table_name */
10892 Just above the source table, we put a special line that tells
10893 Orgtbl mode how to translate this table and where to install it. For
10897 #+ORGTBL: SEND table_name translation_function arguments....
10901 @code{table_name} is the reference name for the table that is also used
10902 in the receiver lines. @code{translation_function} is the Lisp function
10903 that does the translation. Furthermore, the line can contain a list of
10904 arguments (alternating key and value) at the end. The arguments will be
10905 passed as a property list to the translation function for
10906 interpretation. A few standard parameters are already recognized and
10907 acted upon before the translation function is called:
10911 Skip the first N lines of the table. Hlines do count as separate lines for
10914 @item :skipcols (n1 n2 ...)
10915 List of columns that should be skipped. If the table has a column with
10916 calculation marks, that column is automatically discarded as well.
10917 Please note that the translator function sees the table @emph{after} the
10918 removal of these columns, the function never knows that there have been
10919 additional columns.
10923 The one problem remaining is how to keep the source table in the buffer
10924 without disturbing the normal workings of the file, for example during
10925 compilation of a C file or processing of a La@TeX{} file. There are a
10926 number of different solutions:
10930 The table could be placed in a block comment if that is supported by the
10931 language. For example, in C mode you could wrap the table between
10932 @samp{/*} and @samp{*/} lines.
10934 Sometimes it is possible to put the table after some kind of @i{END}
10935 statement, for example @samp{\bye} in @TeX{} and @samp{\end@{document@}}
10938 You can just comment the table line-by-line whenever you want to process
10939 the file, and uncomment it whenever you need to edit the table. This
10940 only sounds tedious---the command @kbd{M-x orgtbl-toggle-comment}
10941 makes this comment-toggling very easy, in particular if you bind it to a
10945 @node A LaTeX example, Translator functions, Radio tables, Tables in arbitrary syntax
10946 @subsection A La@TeX{} example of radio tables
10947 @cindex La@TeX{}, and Orgtbl mode
10949 The best way to wrap the source table in La@TeX{} is to use the
10950 @code{comment} environment provided by @file{comment.sty}. It has to be
10951 activated by placing @code{\usepackage@{comment@}} into the document
10952 header. Orgtbl mode can insert a radio table skeleton@footnote{By
10953 default this works only for La@TeX{}, HTML, and Texinfo. Configure the
10954 variable @code{orgtbl-radio-tables} to install templates for other
10955 modes.} with the command @kbd{M-x orgtbl-insert-radio-table}. You will
10956 be prompted for a table name, let's say we use @samp{salesfigures}. You
10957 will then get the following template:
10959 @cindex #+ORGTBL, SEND
10961 % BEGIN RECEIVE ORGTBL salesfigures
10962 % END RECEIVE ORGTBL salesfigures
10964 #+ORGTBL: SEND salesfigures orgtbl-to-latex
10970 @vindex La@TeX{}-verbatim-environments
10971 The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
10972 @code{orgtbl-to-latex} to convert the table into La@TeX{} and to put it
10973 into the receiver location with name @code{salesfigures}. You may now
10974 fill in the table, feel free to use the spreadsheet features@footnote{If
10975 the @samp{#+TBLFM} line contains an odd number of dollar characters,
10976 this may cause problems with font-lock in La@TeX{} mode. As shown in the
10977 example you can fix this by adding an extra line inside the
10978 @code{comment} environment that is used to balance the dollar
10979 expressions. If you are using AUC@TeX{} with the font-latex library, a
10980 much better solution is to add the @code{comment} environment to the
10981 variable @code{LaTeX-verbatim-environments}.}:
10984 % BEGIN RECEIVE ORGTBL salesfigures
10985 % END RECEIVE ORGTBL salesfigures
10987 #+ORGTBL: SEND salesfigures orgtbl-to-latex
10988 | Month | Days | Nr sold | per day |
10989 |-------+------+---------+---------|
10990 | Jan | 23 | 55 | 2.4 |
10991 | Feb | 21 | 16 | 0.8 |
10992 | March | 22 | 278 | 12.6 |
10993 #+TBLFM: $4=$3/$2;%.1f
10994 % $ (optional extra dollar to keep font-lock happy, see footnote)
10999 When you are done, press @kbd{C-c C-c} in the table to get the converted
11000 table inserted between the two marker lines.
11002 Now let's assume you want to make the table header by hand, because you
11003 want to control how columns are aligned, etc@. In this case we make sure
11004 that the table translator skips the first 2 lines of the source
11005 table, and tell the command to work as a @i{splice}, @ie to not produce
11006 header and footer commands of the target table:
11009 \begin@{tabular@}@{lrrr@}
11010 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
11011 % BEGIN RECEIVE ORGTBL salesfigures
11012 % END RECEIVE ORGTBL salesfigures
11016 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
11017 | Month | Days | Nr sold | per day |
11018 |-------+------+---------+---------|
11019 | Jan | 23 | 55 | 2.4 |
11020 | Feb | 21 | 16 | 0.8 |
11021 | March | 22 | 278 | 12.6 |
11022 #+TBLFM: $4=$3/$2;%.1f
11026 The La@TeX{} translator function @code{orgtbl-to-latex} is already part of
11027 Orgtbl mode. It uses a @code{tabular} environment to typeset the table
11028 and marks horizontal lines with @code{\hline}. Furthermore, it
11029 interprets the following parameters (see also @pxref{Translator functions}):
11032 @item :splice nil/t
11033 When set to t, return only table body lines, don't wrap them into a
11034 tabular environment. Default is nil.
11037 A format to be used to wrap each field, it should contain @code{%s} for the
11038 original field value. For example, to wrap each field value in dollars,
11039 you could use @code{:fmt "$%s$"}. This may also be a property list with
11040 column numbers and formats. for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
11041 A function of one argument can be used in place of the strings; the
11042 function must return a formatted string.
11045 Use this format to print numbers with exponentials. The format should
11046 have @code{%s} twice for inserting mantissa and exponent, for example
11047 @code{"%s\\times10^@{%s@}"}. The default is @code{"%s\\,(%s)"}. This
11048 may also be a property list with column numbers and formats, for example
11049 @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After
11050 @code{efmt} has been applied to a value, @code{fmt} will also be
11051 applied. Similar to @code{fmt}, functions of two arguments can be
11052 supplied instead of strings.
11055 @node Translator functions, Radio lists, A LaTeX example, Tables in arbitrary syntax
11056 @subsection Translator functions
11057 @cindex HTML, and Orgtbl mode
11058 @cindex translator function
11060 Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
11061 (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
11062 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and @code{orgtbl-to-texinfo}.
11063 Except for @code{orgtbl-to-html}@footnote{The HTML translator uses the same
11064 code that produces tables during HTML export.}, these all use a generic
11065 translator, @code{orgtbl-to-generic}. For example, @code{orgtbl-to-latex}
11066 itself is a very short function that computes the column definitions for the
11067 @code{tabular} environment, defines a few field and line separators and then
11068 hands processing over to the generic translator. Here is the entire code:
11072 (defun orgtbl-to-latex (table params)
11073 "Convert the Orgtbl mode TABLE to LaTeX."
11074 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
11075 org-table-last-alignment ""))
11078 :tstart (concat "\\begin@{tabular@}@{" alignment "@}")
11079 :tend "\\end@{tabular@}"
11080 :lstart "" :lend " \\\\" :sep " & "
11081 :efmt "%s\\,(%s)" :hline "\\hline")))
11082 (orgtbl-to-generic table (org-combine-plists params2 params))))
11086 As you can see, the properties passed into the function (variable
11087 @var{PARAMS}) are combined with the ones newly defined in the function
11088 (variable @var{PARAMS2}). The ones passed into the function (@ie the
11089 ones set by the @samp{ORGTBL SEND} line) take precedence. So if you
11090 would like to use the La@TeX{} translator, but wanted the line endings to
11091 be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
11092 overrule the default with
11095 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
11098 For a new language, you can either write your own converter function in
11099 analogy with the La@TeX{} translator, or you can use the generic function
11100 directly. For example, if you have a language where a table is started
11101 with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are
11102 started with @samp{!BL!}, ended with @samp{!EL!}, and where the field
11103 separator is a TAB, you could call the generic translator like this (on
11107 #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
11108 :lstart "!BL! " :lend " !EL!" :sep "\t"
11112 Please check the documentation string of the function
11113 @code{orgtbl-to-generic} for a full list of parameters understood by
11114 that function, and remember that you can pass each of them into
11115 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
11116 using the generic function.
11118 Of course you can also write a completely new function doing complicated
11119 things the generic translator cannot do. A translator function takes
11120 two arguments. The first argument is the table, a list of lines, each
11121 line either the symbol @code{hline} or a list of fields. The second
11122 argument is the property list containing all parameters specified in the
11123 @samp{#+ORGTBL: SEND} line. The function must return a single string
11124 containing the formatted table. If you write a generally useful
11125 translator, please post it on @email{emacs-orgmode@@gnu.org} so that
11126 others can benefit from your work.
11128 @node Radio lists, , Translator functions, Tables in arbitrary syntax
11129 @subsection Radio lists
11130 @cindex radio lists
11131 @cindex org-list-insert-radio-list
11133 Sending and receiving radio lists works exactly the same way than sending and
11134 receiving radio tables (@pxref{Radio tables}). As for radio tables, you can
11135 insert radio lists templates in HTML, La@TeX{} and Texinfo modes by calling
11136 @code{org-list-insert-radio-list}.
11138 Here are the differences with radio tables:
11142 Use @code{ORGLST} instead of @code{ORGTBL}.
11144 The available translation functions for radio lists don't take
11147 @kbd{C-c C-c} will work when pressed on the first item of the list.
11150 Here is a La@TeX{} example. Let's say that you have this in your
11155 % BEGIN RECEIVE ORGLST to-buy
11156 % END RECEIVE ORGLST to-buy
11158 #+ORGLIST: SEND to-buy orgtbl-to-latex
11167 Pressing `C-c C-c' on @code{a new house} and will insert the converted
11168 La@TeX{} list between the two marker lines.
11170 @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Hacking
11171 @section Dynamic blocks
11172 @cindex dynamic blocks
11174 Org documents can contain @emph{dynamic blocks}. These are
11175 specially marked regions that are updated by some user-written function.
11176 A good example for such a block is the clock table inserted by the
11177 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
11179 Dynamic block are enclosed by a BEGIN-END structure that assigns a name
11180 to the block and can also specify parameters for the function producing
11181 the content of the block.
11183 #+BEGIN:dynamic block
11185 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
11190 Dynamic blocks are updated with the following commands
11193 @kindex C-c C-x C-u
11195 Update dynamic block at point.
11196 @kindex C-u C-c C-x C-u
11197 @item C-u C-c C-x C-u
11198 Update all dynamic blocks in the current file.
11201 Updating a dynamic block means to remove all the text between BEGIN and
11202 END, parse the BEGIN line for parameters and then call the specific
11203 writer function for this block to insert the new content. If you want
11204 to use the original content in the writer function, you can use the
11205 extra parameter @code{:content}.
11207 For a block with name @code{myblock}, the writer function is
11208 @code{org-dblock-write:myblock} with as only parameter a property list
11209 with the parameters given in the begin line. Here is a trivial example
11210 of a block that keeps track of when the block update function was last
11214 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
11220 The corresponding block writer function could look like this:
11223 (defun org-dblock-write:block-update-time (params)
11224 (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
11225 (insert "Last block update at: "
11226 (format-time-string fmt (current-time)))))
11229 If you want to make sure that all dynamic blocks are always up-to-date,
11230 you could add the function @code{org-update-all-dblocks} to a hook, for
11231 example @code{before-save-hook}. @code{org-update-all-dblocks} is
11232 written in a way such that it does nothing in buffers that are not in
11235 @node Special agenda views, Extracting agenda information, Dynamic blocks, Hacking
11236 @section Special agenda views
11237 @cindex agenda views, user-defined
11239 Org provides a special hook that can be used to narrow down the
11240 selection made by any of the agenda views. You may specify a function
11241 that is used at each match to verify if the match should indeed be part
11242 of the agenda view, and if not, how much should be skipped.
11244 Let's say you want to produce a list of projects that contain a WAITING
11245 tag anywhere in the project tree. Let's further assume that you have
11246 marked all tree headings that define a project with the TODO keyword
11247 PROJECT. In this case you would run a TODO search for the keyword
11248 PROJECT, but skip the match unless there is a WAITING tag anywhere in
11249 the subtree belonging to the project line.
11251 To achieve this, you must write a function that searches the subtree for
11252 the tag. If the tag is found, the function must return @code{nil} to
11253 indicate that this match should not be skipped. If there is no such
11254 tag, return the location of the end of the subtree, to indicate that
11255 search should continue from there.
11258 (defun my-skip-unless-waiting ()
11259 "Skip trees that are not waiting"
11260 (let ((subtree-end (save-excursion (org-end-of-subtree t))))
11261 (if (re-search-forward ":waiting:" subtree-end t)
11262 nil ; tag found, do not skip
11263 subtree-end))) ; tag not found, continue after end of subtree
11266 Now you may use this function in an agenda custom command, for example
11270 (org-add-agenda-custom-command
11271 '("b" todo "PROJECT"
11272 ((org-agenda-skip-function 'my-skip-unless-waiting)
11273 (org-agenda-overriding-header "Projects waiting for something: "))))
11276 @vindex org-agenda-overriding-header
11277 Note that this also binds @code{org-agenda-overriding-header} to get a
11278 meaningful header in the agenda view.
11280 @vindex org-odd-levels-only
11281 @vindex org-agenda-skip-function
11282 A general way to create custom searches is to base them on a search for
11283 entries with a certain level limit. If you want to study all entries with
11284 your custom search function, simply do a search for
11285 @samp{LEVEL>0}@footnote{Note that, when using @code{org-odd-levels-only}, a
11286 level number corresponds to order in the hierarchy, not to the number of
11287 stars.}, and then use @code{org-agenda-skip-function} to select the entries
11288 you really want to have.
11290 You may also put a Lisp form into @code{org-agenda-skip-function}. In
11291 particular, you may use the functions @code{org-agenda-skip-entry-if}
11292 and @code{org-agenda-skip-subtree-if} in this form, for example:
11295 @item '(org-agenda-skip-entry-if 'scheduled)
11296 Skip current entry if it has been scheduled.
11297 @item '(org-agenda-skip-entry-if 'notscheduled)
11298 Skip current entry if it has not been scheduled.
11299 @item '(org-agenda-skip-entry-if 'deadline)
11300 Skip current entry if it has a deadline.
11301 @item '(org-agenda-skip-entry-if 'scheduled 'deadline)
11302 Skip current entry if it has a deadline, or if it is scheduled.
11303 @item '(org-agenda-skip-entry-if 'timestamp)
11304 Skip current entry if it has any timestamp, may also be deadline or scheduled.
11305 @item '(org-agenda-skip-entry 'regexp "regular expression")
11306 Skip current entry if the regular expression matches in the entry.
11307 @item '(org-agenda-skip-entry 'notregexp "regular expression")
11308 Skip current entry unless the regular expression matches.
11309 @item '(org-agenda-skip-subtree-if 'regexp "regular expression")
11310 Same as above, but check and skip the entire subtree.
11313 Therefore we could also have written the search for WAITING projects
11314 like this, even without defining a special function:
11317 (org-add-agenda-custom-command
11318 '("b" todo "PROJECT"
11319 ((org-agenda-skip-function '(org-agenda-skip-subtree-if
11320 'regexp ":waiting:"))
11321 (org-agenda-overriding-header "Projects waiting for something: "))))
11324 @node Extracting agenda information, Using the property API, Special agenda views, Hacking
11325 @section Extracting agenda information
11326 @cindex agenda, pipe
11327 @cindex Scripts, for agenda processing
11329 @vindex org-agenda-custom-commands
11330 Org provides commands to access agenda information for the command
11331 line in Emacs batch mode. This extracted information can be sent
11332 directly to a printer, or it can be read by a program that does further
11333 processing of the data. The first of these commands is the function
11334 @code{org-batch-agenda}, that produces an agenda view and sends it as
11335 ASCII text to STDOUT. The command takes a single string as parameter.
11336 If the string has length 1, it is used as a key to one of the commands
11337 you have configured in @code{org-agenda-custom-commands}, basically any
11338 key you can use after @kbd{C-c a}. For example, to directly print the
11339 current TODO list, you could use
11342 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
11345 If the parameter is a string with 2 or more characters, it is used as a
11346 tags/TODO match string. For example, to print your local shopping list
11347 (all items with the tag @samp{shop}, but excluding the tag
11348 @samp{NewYork}), you could use
11351 emacs -batch -l ~/.emacs \
11352 -eval '(org-batch-agenda "+shop-NewYork")' | lpr
11356 You may also modify parameters on the fly like this:
11359 emacs -batch -l ~/.emacs \
11360 -eval '(org-batch-agenda "a" \
11361 org-agenda-ndays 30 \
11362 org-agenda-include-diary nil \
11363 org-agenda-files (quote ("~/org/project.org")))' \
11368 which will produce a 30-day agenda, fully restricted to the Org file
11369 @file{~/org/projects.org}, not even including the diary.
11371 If you want to process the agenda data in more sophisticated ways, you
11372 can use the command @code{org-batch-agenda-csv} to get a comma-separated
11373 list of values for each agenda item. Each line in the output will
11374 contain a number of fields separated by commas. The fields in a line
11378 category @r{The category of the item}
11379 head @r{The headline, without TODO keyword, TAGS and PRIORITY}
11380 type @r{The type of the agenda entry, can be}
11381 todo @r{selected in TODO match}
11382 tagsmatch @r{selected in tags match}
11383 diary @r{imported from diary}
11384 deadline @r{a deadline}
11385 scheduled @r{scheduled}
11386 timestamp @r{appointment, selected by timestamp}
11387 closed @r{entry was closed on date}
11388 upcoming-deadline @r{warning about nearing deadline}
11389 past-scheduled @r{forwarded scheduled item}
11390 block @r{entry has date block including date}
11391 todo @r{The TODO keyword, if any}
11392 tags @r{All tags including inherited ones, separated by colons}
11393 date @r{The relevant date, like 2007-2-14}
11394 time @r{The time, like 15:00-16:50}
11395 extra @r{String with extra planning info}
11396 priority-l @r{The priority letter if any was given}
11397 priority-n @r{The computed numerical priority}
11401 Time and date will only be given if a timestamp (or deadline/scheduled)
11402 led to the selection of the item.
11404 A CSV list like this is very easy to use in a post-processing script.
11405 For example, here is a Perl program that gets the TODO list from
11406 Emacs/Org and prints all the items, preceded by a checkbox:
11411 # define the Emacs command to run
11412 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
11414 # run it and capture the output
11415 $agenda = qx@{$cmd 2>/dev/null@};
11417 # loop over all lines
11418 foreach $line (split(/\n/,$agenda)) @{
11419 # get the individual values
11420 ($category,$head,$type,$todo,$tags,$date,$time,$extra,
11421 $priority_l,$priority_n) = split(/,/,$line);
11422 # process and print
11423 print "[ ] $head\n";
11440 @node Using the property API, Using the mapping API, Extracting agenda information, Hacking
11441 @section Using the property API
11442 @cindex API, for properties
11443 @cindex properties, API
11445 Here is a description of the functions that can be used to work with
11448 @defun org-entry-properties &optional pom which
11449 Get all properties of the entry at point-or-marker POM.@*
11450 This includes the TODO keyword, the tags, time strings for deadline,
11451 scheduled, and clocking, and any additional properties defined in the
11452 entry. The return value is an alist, keys may occur multiple times
11453 if the property key was used several times.@*
11454 POM may also be nil, in which case the current entry is used.
11455 If WHICH is nil or `all', get all properties. If WHICH is
11456 `special' or `standard', only get that subclass.
11458 @vindex org-use-property-inheritance
11459 @defun org-entry-get pom property &optional inherit
11460 Get value of PROPERTY for entry at point-or-marker POM. By default,
11461 this only looks at properties defined locally in the entry. If INHERIT
11462 is non-nil and the entry does not have the property, then also check
11463 higher levels of the hierarchy. If INHERIT is the symbol
11464 @code{selective}, use inheritance if and only if the setting of
11465 @code{org-use-property-inheritance} selects PROPERTY for inheritance.
11468 @defun org-entry-delete pom property
11469 Delete the property PROPERTY from entry at point-or-marker POM.
11472 @defun org-entry-put pom property value
11473 Set PROPERTY to VALUE for entry at point-or-marker POM.
11476 @defun org-buffer-property-keys &optional include-specials
11477 Get all property keys in the current buffer.
11480 @defun org-insert-property-drawer
11481 Insert a property drawer at point.
11484 @defun org-entry-put-multivalued-property pom property &rest values
11485 Set PROPERTY at point-or-marker POM to VALUES. VALUES should be a list of
11486 strings. They will be concatenated, with spaces as separators.
11489 @defun org-entry-get-multivalued-property pom property
11490 Treat the value of the property PROPERTY as a whitespace-separated list of
11491 values and return the values as a list of strings.
11494 @defun org-entry-add-to-multivalued-property pom property value
11495 Treat the value of the property PROPERTY as a whitespace-separated list of
11496 values and make sure that VALUE is in this list.
11499 @defun org-entry-remove-from-multivalued-property pom property value
11500 Treat the value of the property PROPERTY as a whitespace-separated list of
11501 values and make sure that VALUE is @emph{not} in this list.
11504 @defun org-entry-member-in-multivalued-property pom property value
11505 Treat the value of the property PROPERTY as a whitespace-separated list of
11506 values and check if VALUE is in this list.
11509 @node Using the mapping API, , Using the property API, Hacking
11510 @section Using the mapping API
11511 @cindex API, for mapping
11512 @cindex mapping entries, API
11514 Org has sophisticated mapping capabilities to find all entries satisfying
11515 certain criteria. Internally, this functionality is used to produce agenda
11516 views, but there is also an API that can be used to execute arbitrary
11517 functions for each or selected entries. The main entry point for this API
11520 @defun org-map-entries func &optional match scope &rest skip
11521 Call FUNC at each headline selected by MATCH in SCOPE.
11523 FUNC is a function or a Lisp form. The function will be called without
11524 arguments, with the cursor positioned at the beginning of the headline.
11525 The return values of all calls to the function will be collected and
11526 returned as a list.
11528 The call to FUNC will be wrapped into a save-excursion form, so FUNC
11529 does not need to preserve point. After evaluation, the cursor will be
11530 moved to the end of the line (presumably of the headline of the
11531 processed entry) and search continues from there. Under some
11532 circumstances, this may not produce the wanted results. For example,
11533 if you have removed (@eg archived) the current (sub)tree it could
11534 mean that the next entry will be skipped entirely. In such cases, you
11535 can specify the position from where search should continue by making
11536 FUNC set the variable `org-map-continue-from' to the desired buffer
11539 MATCH is a tags/property/todo match as it is used in the agenda match view.
11540 Only headlines that are matched by this query will be considered during
11541 the iteration. When MATCH is nil or t, all headlines will be
11542 visited by the iteration.
11544 SCOPE determines the scope of this command. It can be any of:
11547 nil @r{the current buffer, respecting the restriction if any}
11548 tree @r{the subtree started with the entry at point}
11549 file @r{the current buffer, without restriction}
11551 @r{the current buffer, and any archives associated with it}
11552 agenda @r{all agenda files}
11553 agenda-with-archives
11554 @r{all agenda files with any archive files associated with them}
11556 @r{if this is a list, all files in the list will be scanned}
11559 The remaining args are treated as settings for the skipping facilities of
11560 the scanner. The following items can be given here:
11562 @vindex org-agenda-skip-function
11564 archive @r{skip trees with the archive tag}
11565 comment @r{skip trees with the COMMENT keyword}
11566 function or Lisp form
11567 @r{will be used as value for @code{org-agenda-skip-function},}
11568 @r{so whenever the function returns t, FUNC}
11569 @r{will not be called for that entry and search will}
11570 @r{continue from the point where the function leaves it}
11574 The function given to that mapping routine can really do anything you like.
11575 It can use the property API (@pxref{Using the property API}) to gather more
11576 information about the entry, or in order to change metadata in the entry.
11577 Here are a couple of functions that might be handy:
11579 @defun org-todo &optional arg
11580 Change the TODO state of the entry, see the docstring of the functions for
11581 the many possible values for the argument ARG.
11584 @defun org-priority &optional action
11585 Change the priority of the entry, see the docstring of this function for the
11586 possible values for ACTION.
11589 @defun org-toggle-tag tag &optional onoff
11590 Toggle the tag TAG in the current entry. Setting ONOFF to either @code{on}
11591 or @code{off} will not toggle tag, but ensure that it is either on or off.
11595 Promote the current entry.
11599 Demote the current entry.
11602 Here is a simple example that will turn all entries in the current file with
11603 a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
11604 Entries in comment trees and in archive trees will be ignored.
11608 '(org-todo "UPCOMING")
11609 "+TOMORROW" 'file 'archive 'comment)
11612 The following example counts the number of entries with TODO keyword
11613 @code{WAITING}, in all agenda files.
11616 (length (org-map-entries t "/+WAITING" 'agenda))
11619 @node History and Acknowledgments, Main Index, Hacking, Top
11620 @appendix History and Acknowledgments
11621 @cindex acknowledgments
11625 Org was born in 2003, out of frustration over the user interface
11626 of the Emacs Outline mode. I was trying to organize my notes and
11627 projects, and using Emacs seemed to be the natural way to go. However,
11628 having to remember eleven different commands with two or three keys per
11629 command, only to hide and show parts of the outline tree, that seemed
11630 entirely unacceptable to me. Also, when using outlines to take notes, I
11631 constantly wanted to restructure the tree, organizing it parallel to my
11632 thoughts and plans. @emph{Visibility cycling} and @emph{structure
11633 editing} were originally implemented in the package
11634 @file{outline-magic.el}, but quickly moved to the more general
11635 @file{org.el}. As this environment became comfortable for project
11636 planning, the next step was adding @emph{TODO entries}, basic
11637 @emph{timestamps}, and @emph{table support}. These areas highlighted the two main
11638 goals that Org still has today: to be a new, outline-based,
11639 plain text mode with innovative and intuitive editing features, and to
11640 incorporate project planning functionality directly into a notes file.
11642 A special thanks goes to @i{Bastien Guerry} who has not only written a large
11643 number of extensions to Org (most of them integrated into the core by now),
11644 but who has also helped in the development and maintenance of Org so much that he
11645 should be considered the main co-contributor to this package.
11647 Since the first release, literally thousands of emails to me or to
11648 @email{emacs-orgmode@@gnu.org} have provided a constant stream of bug
11649 reports, feedback, new ideas, and sometimes patches and add-on code.
11650 Many thanks to everyone who has helped to improve this package. I am
11651 trying to keep here a list of the people who had significant influence
11652 in shaping one or more aspects of Org. The list may not be
11653 complete, if I have forgotten someone, please accept my apologies and
11659 @i{Russel Adams} came up with the idea for drawers.
11661 @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
11663 @i{Christophe Bataillon} created the great unicorn logo that we use on the
11666 @i{Alex Bochannek} provided a patch for rounding timestamps.
11668 @i{Brad Bozarth} showed how to pull RSS feed data into Org-mode files.
11670 @i{Tom Breton} wrote @file{org-choose.el}.
11672 @i{Charles Cave}'s suggestion sparked the implementation of templates
11675 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
11678 @i{Gregory Chernov} patched support for Lisp forms into table
11679 calculations and improved XEmacs compatibility, in particular by porting
11680 @file{nouline.el} to XEmacs.
11682 @i{Sacha Chua} suggested copying some linking code from Planner.
11684 @i{Baoqiu Cui} contributed the DocBook exporter.
11686 @i{Eddward DeVilla} proposed and tested checkbox statistics. He also
11687 came up with the idea of properties, and that there should be an API for
11690 @i{Nick Dokos} tracked down several nasty bugs.
11692 @i{Kees Dullemond} used to edit projects lists directly in HTML and so
11693 inspired some of the early development, including HTML export. He also
11694 asked for a way to narrow wide table columns.
11696 @i{Christian Egli} converted the documentation into Texinfo format,
11697 patched CSS formatting into the HTML exporter, and inspired the agenda.
11699 @i{David Emery} provided a patch for custom CSS support in exported
11702 @i{Nic Ferrier} contributed mailcap and XOXO support.
11704 @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
11706 @i{John Foerch} figured out how to make incremental search show context
11707 around a match in a hidden outline tree.
11709 @i{Niels Giesen} had the idea to automatically archive DONE trees.
11711 @i{Bastien Guerry} wrote the La@TeX{} exporter and @file{org-bibtex.el}, and
11712 has been prolific with patches, ideas, and bug reports.
11714 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
11716 @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
11717 task state change logging, and the clocktable. His clear explanations have
11718 been critical when we started to adopt the Git version control system.
11720 @i{Manuel Hermenegildo} has contributed various ideas, small fixes and
11723 @i{Phil Jackson} wrote @file{org-irc.el}.
11725 @i{Scott Jaderholm} proposed footnotes, control over whitespace between
11726 folded entries, and column view for properties.
11728 @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
11730 @i{Shidai Liu} ("Leo") asked for embedded La@TeX{} and tested it. He also
11731 provided frequent feedback and some patches.
11733 @i{Matt Lundin} has proposed last-row references for table formulas and named
11734 invisible anchors. He has also worked a lot on the FAQ.
11736 @i{Jason F. McBrayer} suggested agenda export to CSV format.
11738 @i{Max Mikhanosha} came up with the idea of refiling.
11740 @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
11743 @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
11746 @i{Rick Moynihan} proposed allowing multiple TODO sequences in a file
11747 and being able to quickly restrict the agenda to a subtree.
11749 @i{Todd Neal} provided patches for links to Info files and Elisp forms.
11751 @i{Greg Newman} refreshed the unicorn logo into its current form.
11753 @i{Tim O'Callaghan} suggested in-file links, search options for general
11754 file links, and TAGS.
11756 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
11759 @i{Oliver Oppitz} suggested multi-state TODO items.
11761 @i{Scott Otterson} sparked the introduction of descriptive text for
11762 links, among other things.
11764 @i{Pete Phillips} helped during the development of the TAGS feature, and
11765 provided frequent feedback.
11767 @i{Martin Pohlack} provided the code snippet to bundle character insertion
11768 into bundles of 20 for undo.
11770 @i{T.V. Raman} reported bugs and suggested improvements.
11772 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
11775 @i{Paul Rivier} provided the basic implementation of named footnotes.
11777 @i{Kevin Rogers} contributed code to access VM files on remote hosts.
11779 @i{Sebastian Rose} wrote @file{org-info.js}, a Java script for displaying
11780 webpages derived from Org using an Info-like or a folding interface with
11781 single-key navigation.
11783 @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
11784 conflict with @file{allout.el}.
11786 @i{Jason Riedy} generalized the send-receive mechanism for Orgtbl tables with
11789 @i{Philip Rooke} created the Org reference card, provided lots
11790 of feedback, developed and applied standards to the Org documentation.
11792 @i{Christian Schlauer} proposed angular brackets around links, among
11795 @i{Eric Schulte} wrote @file{org-plot.el} and contributed various patches,
11796 small features and modules.
11798 Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
11799 @file{organizer-mode.el}.
11801 @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal
11802 examples, and remote highlighting for referenced code lines.
11804 @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
11805 now packaged into Org's @file{contrib} directory.
11807 @i{Daniel Sinder} came up with the idea of internal archiving by locking
11810 @i{Dale Smith} proposed link abbreviations.
11812 @i{James TD Smith} has contributed a large number of patches for useful
11813 tweaks and features.
11815 @i{Adam Spiers} asked for global linking commands, inspired the link
11816 extension system, added support for mairix, and proposed the mapping API.
11818 @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content
11819 with links transformation to Org syntax.
11821 @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
11822 chapter about publishing.
11824 @i{J@"urgen Vollmer} contributed code generating the table of contents
11827 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
11830 @i{David Wainberg} suggested archiving, and improvements to the linking
11833 @i{John Wiegley} wrote @file{emacs-wiki.el}, @file{planner.el}, and
11834 @file{muse.el}, which have some overlap with Org. Initially the development
11835 of Org was fully independent because I was not aware of the existence of
11836 these packages. But with time I have occasionally looked at John's code and
11837 learned a lot from it. John has also contributed a number of great ideas and
11838 patches directly to Org, including the attachment system
11839 (@file{org-attach.el}), integration with Apple Mail
11840 (@file{org-mac-message.el}), and hierarchical dependencies of TODO items.
11842 @i{Carsten Wimmer} suggested some changes and helped fix a bug in
11845 @i{Roland Winkler} requested additional key bindings to make Org
11848 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
11849 and contributed various ideas and code snippets.
11853 @node Main Index, Key Index, History and Acknowledgments, Top
11854 @unnumbered Concept Index
11858 @node Key Index, Variable Index, Main Index, Top
11859 @unnumbered Key Index
11863 @node Variable Index, , Key Index, Top
11864 @unnumbered Variable Index
11866 This is not a complete index of variables and faces, only the ones that are
11867 mentioned in the manual. For a more complete list, use @kbd{M-x
11868 org-customize @key{RET}} and then klick yourself through the tree.
11875 arch-tag: 7893d1Fe-cc57-4d13-b5e5-f494a1CBC7ac
11878 @c Local variables:
11879 @c ispell-local-dictionary: "en_US-w_accents"
11880 @c ispell-local-pdict: "./.aspell.org.pws"