Docs: Fix info structure problem
[org-mode.git] / doc / org.texi
bloba1edce26f3c5134bdac8733e9ca5731b911628fa
1 \input texinfo
2 @c %**start of header
3 @setfilename ../../info/org
4 @settitle The Org Manual
6 @set VERSION 6.25trans
7 @set DATE April 2009
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}
15 @c %**end of header
16 @finalout
18 @c Macro definitions
20 @c Subheadings inside a table.
21 @macro tsubheading{text}
22 @ifinfo
23 @subsubheading \text\
24 @end ifinfo
25 @ifnotinfo
26 @item @b{\text\}
27 @end ifnotinfo
28 @end macro
30 @copying
31 This manual is for Org version @value{VERSION}.
33 Copyright @copyright{} 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation
35 @quotation
36 Permission is granted to copy, distribute and/or modify this document
37 under the terms of the GNU Free Documentation License, Version 1.3 or
38 any later version published by the Free Software Foundation; with no
39 Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
40 and with the Back-Cover Texts as in (a) below.  A copy of the license
41 is included in the section entitled ``GNU Free Documentation License.''
43 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
44 modify this GNU manual.  Buying copies from the FSF supports it in
45 developing GNU and promoting software freedom.''
47 This document is part of a collection distributed under the GNU Free
48 Documentation License.  If you want to distribute this document
49 separately from the collection, you can do so by adding a copy of the
50 license to the document, as described in section 6 of the license.
51 @end quotation
52 @end copying
54 @dircategory Emacs
55 @direntry
56 * Org Mode: (org).      Outline-based notes management and organizer
57 @end direntry
59 @titlepage
60 @title The Org Manual
62 @subtitle Release @value{VERSION}
63 @author by Carsten Dominik
65 @c The following two commands start the copyright page.
66 @page
67 @vskip 0pt plus 1filll
68 @insertcopying
69 @end titlepage
71 @c Output the table of contents at the beginning.
72 @contents
74 @ifnottex
75 @node Top, Introduction, (dir), (dir)
76 @top Org Mode Manual
78 @insertcopying
79 @end ifnottex
81 @menu
82 * Introduction::                Getting started
83 * Document Structure::          A tree works like your brain
84 * Tables::                      Pure magic for quick formatting
85 * Hyperlinks::                  Notes in context
86 * TODO Items::                  Every tree branch can be a TODO item
87 * Tags::                        Tagging headlines and matching sets of tags
88 * Properties and Columns::      Storing information about an entry
89 * Dates and Times::             Making items useful for planning
90 * Capture::                     Creating tasks and attaching files
91 * Agenda Views::                Collecting information into views
92 * Embedded LaTeX::              LaTeX fragments and formulas
93 * Exporting::                   Sharing and publishing of notes
94 * Publishing::                  Create a web site of linked Org files
95 * Miscellaneous::               All the rest which did not fit elsewhere
96 * Hacking::                     How to hack your way around
97 * History and Acknowledgments::  How Org came into being
98 * Main Index::                  An index of Org's concepts and features
99 * Key Index::                   Key bindings and where they are described
100 * Variable and Faces Index::    Index for variables and faces discussed
102 @detailmenu
103  --- The Detailed Node Listing ---
105 Introduction
107 * Summary::                     Brief summary of what Org does
108 * Installation::                How to install a downloaded version of Org
109 * Activation::                  How to activate Org for certain buffers
110 * Feedback::                    Bug reports, ideas, patches etc.
111 * Conventions::                 Type-setting conventions in the manual
113 Document Structure
115 * Outlines::                    Org is based on Outline mode
116 * Headlines::                   How to typeset Org tree headlines
117 * Visibility cycling::          Show and hide, much simplified
118 * Motion::                      Jumping to other headlines
119 * Structure editing::           Changing sequence and level of headlines
120 * Archiving::                   Move done task trees to a different place
121 * Sparse trees::                Matches embedded in context
122 * Plain lists::                 Additional structure within an entry
123 * Drawers::                     Tucking stuff away
124 * Footnotes::                   How footnotes are defined in Org's syntax
125 * Orgstruct mode::              Structure editing outside Org
127 Archiving
129 * ARCHIVE tag::                 Marking a tree as inactive
130 * Moving subtrees::             Moving a tree to an archive file
132 Tables
134 * Built-in table editor::       Simple tables
135 * Narrow columns::              Stop wasting space in tables
136 * Column groups::               Grouping to trigger vertical lines
137 * Orgtbl mode::                 The table editor as minor mode
138 * The spreadsheet::             The table editor has spreadsheet capabilities
139 * Org Plot::                    Plotting from org tables
141 The spreadsheet
143 * References::                  How to refer to another field or range
144 * Formula syntax for Calc::     Using Calc to compute stuff
145 * Formula syntax for Lisp::     Writing formulas in Emacs Lisp
146 * Field formulas::              Formulas valid for a single field
147 * Column formulas::             Formulas valid for an entire column
148 * Editing and debugging formulas::  Fixing formulas
149 * Updating the table::          Recomputing all dependent fields
150 * Advanced features::           Field names, parameters and automatic recalc
152 Hyperlinks
154 * Link format::                 How links in Org are formatted
155 * Internal links::              Links to other places in the current file
156 * External links::              URL-like links to the world
157 * Handling links::              Creating, inserting and following
158 * Using links outside Org::     Linking from my C source code?
159 * Link abbreviations::          Shortcuts for writing complex links
160 * Search options::              Linking to a specific location
161 * Custom searches::             When the default search is not enough
163 Internal links
165 * Radio targets::               Make targets trigger links in plain text
167 TODO Items
169 * TODO basics::                 Marking and displaying TODO entries
170 * TODO extensions::             Workflow and assignments
171 * Progress logging::            Dates and notes for progress
172 * Priorities::                  Some things are more important than others
173 * Breaking down tasks::         Splitting a task into manageable pieces
174 * Checkboxes::                  Tick-off lists
176 Extended use of TODO keywords
178 * Workflow states::             From TODO to DONE in steps
179 * TODO types::                  I do this, Fred does the rest
180 * Multiple sets in one file::   Mixing it all, and still finding your way
181 * Fast access to TODO states::  Single letter selection of a state
182 * Per-file keywords::           Different files, different requirements
183 * Faces for TODO keywords::     Highlighting states
184 * TODO dependencies::           When one task needs to wait for others
186 Progress logging
188 * Closing items::               When was this entry marked DONE?
189 * Tracking TODO state changes::  When did the status change?
191 Tags
193 * Tag inheritance::             Tags use the tree structure of the outline
194 * Setting tags::                How to assign tags to a headline
195 * Tag searches::                Searching for combinations of tags
197 Properties and Columns
199 * Property syntax::             How properties are spelled out
200 * Special properties::          Access to other Org mode features
201 * Property searches::           Matching property values
202 * Property inheritance::        Passing values down the tree
203 * Column view::                 Tabular viewing and editing
204 * Property API::                Properties for Lisp programmers
206 Column view
208 * Defining columns::            The COLUMNS format property
209 * Using column view::           How to create and use column view
210 * Capturing column view::       A dynamic block for column view
212 Defining columns
214 * Scope of column definitions::  Where defined, where valid?
215 * Column attributes::           Appearance and content of a column
217 Dates and Times
219 * Timestamps::                  Assigning a time to a tree entry
220 * Creating timestamps::         Commands which insert timestamps
221 * Deadlines and scheduling::    Planning your work
222 * Clocking work time::          Tracking how long you spend on a task
223 * Effort estimates::            Planning work effort in advance
224 * Relative timer::              Notes with a running timer
226 Creating timestamps
228 * The date/time prompt::        How Org mode helps you entering date and time
229 * Custom time format::          Making dates look different
231 Deadlines and scheduling
233 * Inserting deadline/schedule::  Planning items
234 * Repeated tasks::              Items that show up again and again
236 Capture
238 * Remember::                    Capture new tasks/ideas with little interruption
239 * Attachments::                 Add files to tasks.
240 * RSS Feeds::                   Getting input from RSS feeds
241 * Protocols::                   External (e.g. Browser) access to Emacs and Org
243 Remember
245 * Setting up Remember::         Some code for .emacs to get things going
246 * Remember templates::          Define the outline of different note types
247 * Storing notes::               Directly get the note to where it belongs
248 * Refiling notes::              Moving a note or task to a project
250 Agenda Views
252 * Agenda files::                Files being searched for agenda information
253 * Agenda dispatcher::           Keyboard access to agenda views
254 * Built-in agenda views::       What is available out of the box?
255 * Presentation and sorting::    How agenda items are prepared for display
256 * Agenda commands::             Remote editing of Org trees
257 * Custom agenda views::         Defining special searches and views
258 * Exporting Agenda Views::      
259 * Agenda column view::          Using column view for collected entries
261 The built-in agenda views
263 * Weekly/daily agenda::         The calendar page with current tasks
264 * Global TODO list::            All unfinished action items
265 * Matching tags and properties::  Structured information with fine-tuned search
266 * Timeline::                    Time-sorted view for single file
267 * Keyword search::              Finding entries by keyword
268 * Stuck projects::              Find projects you need to review
270 Presentation and sorting
272 * Categories::                  Not all tasks are equal
273 * Time-of-day specifications::  How the agenda knows the time
274 * Sorting of agenda items::     The order of things
276 Custom agenda views
278 * Storing searches::            Type once, use often
279 * Block agenda::                All the stuff you need in a single buffer
280 * Setting Options::             Changing the rules
282 Embedded LaTeX
284 * Math symbols::                TeX macros for symbols and Greek letters
285 * Subscripts and superscripts::  Simple syntax for raising/lowering text
286 * LaTeX fragments::             Complex formulas made easy
287 * Processing LaTeX fragments::  Previewing LaTeX processing
288 * CDLaTeX mode::                Speed up entering of formulas
290 Exporting
292 * Markup rules::                Which structures are recognized?
293 * Selective export::            Using tags to select and exclude trees
294 * Export options::              Per-file export settings
295 * The export dispatcher::       How to access exporter commands
296 * ASCII export::                Exporting to plain ASCII
297 * HTML export::                 Exporting to HTML
298 * LaTeX and PDF export::        Exporting to LaTeX, and processing to PDF
299 * DocBook export::              Exporting to DocBook
300 * XOXO export::                 Exporting to XOXO
301 * iCalendar export::            Exporting in iCalendar format
303 Markup rules
305 * Document title::              How the document title is determined
306 * Headings and sections::       The main structure of the exported document
307 * Table of contents::           If, where, how to create a table of contents
308 * Initial text::                Text before the first headline
309 * Lists::                       Plain lists are exported
310 * Paragraphs::                  What determines beginning and ending
311 * Literal examples::            Source code and other examples
312 * Include files::               Include the contents of a file during export
313 * Tables exported::             Tables are exported richly
314 * Inlined images::              How to inline images during export
315 * Footnote markup::             ASCII representation of footnotes
316 * Emphasis and monospace::      To bold or not to bold
317 * TeX macros and LaTeX fragments::  Create special, rich export.
318 * Horizontal rules::            A line across the page
319 * Comment lines::               Some lines will not be exported
320 * Macro replacement::           Global replacement of place holdes
322 HTML export
324 * HTML Export commands::        How to invoke HTML export
325 * Quoting HTML tags::           Using direct HTML in Org mode
326 * Links::                       Transformation of links for HTML
327 * Tables in HTML export::       How to modify the formatting of tables
328 * Images in HTML export::       How to insert figures into HTML output
329 * Text areas in HTML export::   An alternative way to show an example
330 * CSS support::                 Changing the appearance of the output
331 * Javascript support::          Info and Folding in a web browser
333 LaTeX and PDF export
335 * LaTeX/PDF export commands::   Which key invokes which commands
336 * Quoting LaTeX code::          Incorporating literal LaTeX code
337 * Sectioning structure::        Changing sectioning in LaTeX output
338 * Tables in LaTeX export::      Options for exporting tables to LaTeX
339 * Images in LaTeX export::      How to insert figures into LaTeX output
341 DocBook export
343 * DocBook export commands::     How to invoke DocBook export
344 * Quoting DocBook code::        Incorporating DocBook code in Org files
345 * Recursive sections::          Recursive sections in DocBook
346 * Tables in DocBook export::    Tables are exported as HTML tables
347 * Images in DocBook export::    How to insert figures into DocBook output
348 * Special characters::          How to handle special characters
350 Publishing
352 * Configuration::               Defining projects
353 * Uploading files::             How to get files up on the server
354 * Sample configuration::        Example projects
355 * Triggering publication::      Publication commands
357 Configuration
359 * Project alist::               The central configuration variable
360 * Sources and destinations::    From here to there
361 * Selecting files::             What files are part of the project?
362 * Publishing action::           Setting the function doing the publishing
363 * Publishing options::          Tweaking HTML export
364 * Publishing links::            Which links keep working after publishing?
365 * Project page index::          Publishing a list of project files
367 Sample configuration
369 * Simple example::              One-component publishing
370 * Complex example::             A multi-component publishing example
372 Miscellaneous
374 * Completion::                  M-TAB knows what you need
375 * Customization::               Adapting Org to your taste
376 * In-buffer settings::          Overview of the #+KEYWORDS
377 * The very busy C-c C-c key::   When in doubt, press C-c C-c
378 * Clean view::                  Getting rid of leading stars in the outline
379 * TTY keys::                    Using Org on a tty
380 * Interaction::                 Other Emacs packages
382 Interaction with other packages
384 * Cooperation::                 Packages Org cooperates with
385 * Conflicts::                   Packages that lead to conflicts
387 Hacking
389 * Hooks::                       Who to reach into Org's internals
390 * Add-on packages::             Available extensions
391 * Adding hyperlink types::      New custom link types
392 * Context-sensitive commands::  How to add functioality to such commands
393 * Tables in arbitrary syntax::  Orgtbl for LaTeX and other programs
394 * Dynamic blocks::              Automatically filled blocks
395 * Special agenda views::        Customized views
396 * Extracting agenda information::  Postprocessing of agenda information
397 * Using the property API::      Writing programs that use entry properties
398 * Using the mapping API::       Mapping over all or selected entries
400 Tables and lists in arbitrary syntax
402 * Radio tables::                Sending and receiving
403 * A LaTeX example::             Step by step, almost a tutorial
404 * Translator functions::        Copy and modify
405 * Radio lists::                 Doing the same for lists
407 @end detailmenu
408 @end menu
410 @node Introduction, Document Structure, Top, Top
411 @chapter Introduction
412 @cindex introduction
414 @menu
415 * Summary::                     Brief summary of what Org does
416 * Installation::                How to install a downloaded version of Org
417 * Activation::                  How to activate Org for certain buffers
418 * Feedback::                    Bug reports, ideas, patches etc.
419 * Conventions::                 Type-setting conventions in the manual
420 @end menu
422 @node Summary, Installation, Introduction, Introduction
423 @section Summary
424 @cindex summary
426 Org is a mode for keeping notes, maintaining TODO lists, and doing
427 project planning with a fast and effective plain-text system.
429 Org develops organizational tasks around NOTES files that contain
430 lists or information about projects as plain text.  Org is
431 implemented on top of Outline mode, which makes it possible to keep the
432 content of large files well structured.  Visibility cycling and
433 structure editing help to work with the tree.  Tables are easily created
434 with a built-in table editor.  Org supports TODO items, deadlines,
435 time stamps, and scheduling.  It dynamically compiles entries into an
436 agenda that utilizes and smoothly integrates much of the Emacs calendar
437 and diary.  Plain text URL-like links connect to websites, emails,
438 Usenet messages, BBDB entries, and any files related to the projects.
439 For printing and sharing of notes, an Org file can be exported as a
440 structured ASCII file, as HTML, or (TODO and agenda items only) as an
441 iCalendar file.  It can also serve as a publishing tool for a set of
442 linked web pages.
444 An important design aspect that distinguishes Org from for example
445 Planner/Muse is that it encourages to store every piece of information
446 only once.  In Planner, you have project pages, day pages and possibly
447 other files, duplicating some information such as tasks.  In Org,
448 you only have notes files.  In your notes you mark entries as tasks,
449 label them with tags and timestamps.  All necessary lists like a
450 schedule for the day, the agenda for a meeting, tasks lists selected by
451 tags etc are created dynamically when you need them.
453 Org keeps simple things simple.  When first fired up, it should
454 feel like a straightforward, easy to use outliner.  Complexity is not
455 imposed, but a large amount of functionality is available when you need
456 it.  Org is a toolbox and can be used in different ways, for
457 example as:
459 @example
460 @r{@bullet{} outline extension with visibility cycling and structure editing}
461 @r{@bullet{} ASCII system and table editor for taking structured notes}
462 @r{@bullet{} ASCII table editor with spreadsheet-like capabilities}
463 @r{@bullet{} TODO list editor}
464 @r{@bullet{} full agenda and planner with deadlines and work scheduling}
465 @r{@bullet{} environment to implement David Allen's GTD system}
466 @r{@bullet{} a basic database application}
467 @r{@bullet{} simple hypertext system, with HTML and LaTeX export}
468 @r{@bullet{} publishing tool to create a set of interlinked webpages}
469 @end example
471 Org's automatic, context sensitive table editor with spreadsheet
472 capabilities can be integrated into any major mode by activating the
473 minor Orgtbl mode.  Using a translation step, it can be used to maintain
474 tables in arbitrary file types, for example in La@TeX{}.  The structure
475 editing and list creation capabilities can be used outside Org with
476 the minor Orgstruct mode.
478 @cindex FAQ
479 There is a website for Org which provides links to the newest
480 version of Org, as well as additional information, frequently asked
481 questions (FAQ), links to tutorials etc.  This page is located at
482 @uref{http://orgmode.org}.
484 @page
487 @node Installation, Activation, Summary, Introduction
488 @section Installation
489 @cindex installation
490 @cindex XEmacs
492 @b{Important:} @i{If Org is part of the Emacs distribution or an
493 XEmacs package, please skip this section and go directly to
494 @ref{Activation}.}
496 If you have downloaded Org from the Web, either as a distribution @file{.zip}
497 or @file{.tar} file, or as a GIT archive, you must take the following steps
498 to install it: Go into the unpacked Org distribution directory and edit the
499 top section of the file @file{Makefile}.  You must set the name of the Emacs
500 binary (likely either @file{emacs} or @file{xemacs}), and the paths to the
501 directories where local Lisp and Info files are kept.  If you don't have
502 access to the system-wide directories, you can simply run Org directly from
503 the distribution directory by adding the @file{lisp} subdirectory to the
504 Emacs load path.  To do this, add the following line to @file{.emacs}:
506 @example
507 (setq load-path (cons "~/path/to/orgdir/lisp" load-path))
508 @end example
510 @noindent
511 If you plan to use code from the @file{contrib} subdirectory, do a similar
512 step for this directory:
514 @example
515 (setq load-path (cons "~/path/to/orgdir/contrib/lisp" load-path))
516 @end example
518 @b{XEmacs users now need to install the file @file{noutline.el} from
519 the @file{xemacs} sub-directory of the Org distribution.  Use the
520 command:}
522 @example
523 @b{make install-noutline}
524 @end example
526 @noindent Now byte-compile the Lisp files with the shell command:
528 @example
529 make
530 @end example
532 @noindent If you are running Org from the distribution directory, this is
533 all.  If you want to install into the system directories, use (as
534 administrator)
535 @example
536 make install
537 @end example
539 Installing Info files is system dependent, because of differences in the
540 @file{install-info} program.  In Debian it does copy the info files into the
541 correct directory and modifies the info directory file.  In many other
542 systems, the files need to be copied to the correct directory separately, and
543 @file{install-info} then only modifies the directory file.  Check your system
544 documentation to find out which of the following commands you need:
546 @example
547 make install-info
548 make install-info-debian
549 @end example
551 @noindent Then add to @file{.emacs}:
553 @lisp
554 ;; This line only if Org is not part of the X/Emacs distribution.
555 (require 'org-install)
556 @end lisp
558 Do not forget to activate Org as described in the following section.
560 @node Activation, Feedback, Installation, Introduction
561 @section Activation
562 @cindex activation
563 @cindex autoload
564 @cindex global key bindings
565 @cindex key bindings, global
567 @iftex
568 @b{Important:} @i{If you use copy-and-paste to copy lisp code from the
569 PDF documentation as viewed by some PDF viewers to your .emacs file, the
570 single quote character comes out incorrectly and the code will not work.
571 You need to fix the single quotes by hand, or copy from Info
572 documentation.}
573 @end iftex
575 Add the following lines to your @file{.emacs} file.  The last three lines
576 define @emph{global} keys for the commands @command{org-store-link},
577 @command{org-agenda}, and @command{org-iswitchb} - please choose suitable
578 keys yourself.
580 @lisp
581 ;; The following lines are always needed.  Choose your own keys.
582 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
583 (global-set-key "\C-cl" 'org-store-link)
584 (global-set-key "\C-ca" 'org-agenda)
585 (global-set-key "\C-cb" 'org-iswitchb)
586 @end lisp
588 Furthermore, you must activate @code{font-lock-mode} in Org
589 buffers, because significant functionality depends on font-locking being
590 active.  You can do this with either one of the following two lines
591 (XEmacs user must use the second option):
592 @lisp
593 (global-font-lock-mode 1)                     ; for all buffers
594 (add-hook 'org-mode-hook 'turn-on-font-lock)  ; Org buffers only
595 @end lisp
597 @cindex Org mode, turning on
598 With this setup, all files with extension @samp{.org} will be put
599 into Org mode.  As an alternative, make the first line of a file look
600 like this:
602 @example
603 MY PROJECTS    -*- mode: org; -*-
604 @end example
606 @vindex org-insert-mode-line-in-empty-file
607 @noindent which will select Org mode for this buffer no matter what
608 the file's name is.  See also the variable
609 @code{org-insert-mode-line-in-empty-file}.
611 Many commands in Org work on the region if the region is @i{active}.  To make
612 use of this, you need to have @code{transient-mark-mode}
613 (@code{zmacs-regions} in XEmacs) turned on.  In Emacs 23 this is the default,
614 in Emacs 22 you need to do this yourself with
615 @lisp
616 (transient-mark-mode 1)
617 @end lisp
618 @noindent If you do not like @code{transient-make-mode}, you can create an
619 active region by using the mouse to select a region, or pressing
620 @kbd{C-@key{SPC}} twice before moving the cursor.
622 @node Feedback, Conventions, Activation, Introduction
623 @section Feedback
624 @cindex feedback
625 @cindex bug reports
626 @cindex maintainer
627 @cindex author
629 If you find problems with Org, or if you have questions, remarks, or ideas
630 about it, please mail to the Org mailing list @code{emacs-orgmode@@gnu.org}.
631 If you are not a member of the mailing list, your mail will be reviewed by a
632 moderator and then passed through to the list.
634 For bug reports, please provide as much information as possible,
635 including the version information of Emacs (@kbd{C-h v emacs-version
636 @key{RET}}) and Org (@kbd{C-h v org-version @key{RET}}), as well as
637 the Org related setup in @file{.emacs}.  If an error occurs, a
638 backtrace can be very useful (see below on how to create one).  Often a
639 small example file helps, along with clear information about:
641 @enumerate
642 @item What exactly did you do?
643 @item What did you expect to happen?
644 @item What happened instead?
645 @end enumerate
646 @noindent Thank you for helping to improve this mode.
648 @subsubheading How to create a useful backtrace
650 @cindex backtrace of an error
651 If working with Org produces an error with a message you don't
652 understand, you may have hit a bug.  The best way to report this is by
653 providing, in addition to what was mentioned above, a @emph{Backtrace}.
654 This is information from the built-in debugger about where and how the
655 error occurred.  Here is how to produce a useful backtrace:
657 @enumerate
658 @item
659 Reload uncompiled versions of all Org-mode lisp files.  The backtrace
660 contains much more information if it is produced with uncompiled code.
661 To do this, use
662 @example
663 C-u M-x org-reload RET
664 @end example
665 or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the
666 menu.
667 @item
668 Go to the @code{Options} menu and select @code{Enter Debugger on Error}
669 (XEmacs has this option in the @code{Troubleshooting} sub-menu).
670 @item
671 Do whatever you have to do to hit the error.  Don't forget to
672 document the steps you take.
673 @item
674 When you hit the error, a @file{*Backtrace*} buffer will appear on the
675 screen.  Save this buffer to a file (for example using @kbd{C-x C-w}) and
676 attach it to your bug report.
677 @end enumerate
679 @node Conventions,  , Feedback, Introduction
680 @section Typesetting conventions used in this manual
682 Org uses three types of keywords: TODO keywords, tags, and property
683 names.  In this manual we use the following conventions:
685 @table @code
686 @item TODO
687 @itemx WAITING
688 TODO keywords are written with all capitals, even if they are
689 user-defined.
690 @item boss
691 @itemx ARCHIVE
692 User-defined tags are written in lowercase; built-in tags with special
693 meaning are written with all capitals.
694 @item Release
695 @itemx PRIORITY
696 User-defined properties are capitalized; built-in properties with
697 special meaning are written with all capitals.
698 @end table
700 @node Document Structure, Tables, Introduction, Top
701 @chapter Document Structure
702 @cindex document structure
703 @cindex structure of document
705 Org is based on outline mode and provides flexible commands to
706 edit the structure of the document.
708 @menu
709 * Outlines::                    Org is based on Outline mode
710 * Headlines::                   How to typeset Org tree headlines
711 * Visibility cycling::          Show and hide, much simplified
712 * Motion::                      Jumping to other headlines
713 * Structure editing::           Changing sequence and level of headlines
714 * Archiving::                   Move done task trees to a different place
715 * Sparse trees::                Matches embedded in context
716 * Plain lists::                 Additional structure within an entry
717 * Drawers::                     Tucking stuff away
718 * Footnotes::                   How footnotes are defined in Org's syntax
719 * Orgstruct mode::              Structure editing outside Org
720 @end menu
722 @node Outlines, Headlines, Document Structure, Document Structure
723 @section Outlines
724 @cindex outlines
725 @cindex Outline mode
727 Org is implemented on top of Outline mode.  Outlines allow a
728 document to be organized in a hierarchical structure, which (at least
729 for me) is the best representation of notes and thoughts.  An overview
730 of this structure is achieved by folding (hiding) large parts of the
731 document to show only the general document structure and the parts
732 currently being worked on.  Org greatly simplifies the use of
733 outlines by compressing the entire show/hide functionality into a single
734 command @command{org-cycle}, which is bound to the @key{TAB} key.
736 @node Headlines, Visibility cycling, Outlines, Document Structure
737 @section Headlines
738 @cindex headlines
739 @cindex outline tree
740 @vindex org-special-ctrl-a/e
742 Headlines define the structure of an outline tree.  The headlines in
743 Org start with one or more stars, on the left margin@footnote{See
744 the variable @code{org-special-ctrl-a/e} to configure special behavior
745 of @kbd{C-a} and @kbd{C-e} in headlines.}.  For example:
747 @example
748 * Top level headline
749 ** Second level
750 *** 3rd level
751     some text
752 *** 3rd level
753     more text
755 * Another top level headline
756 @end example
758 @noindent Some people find the many stars too noisy and would prefer an
759 outline that has whitespace followed by a single star as headline
760 starters.  @ref{Clean view} describes a setup to realize this.
762 @vindex org-cycle-separator-lines
763 An empty line after the end of a subtree is considered part of it and
764 will be hidden when the subtree is folded.  However, if you leave at
765 least two empty lines, one empty line will remain visible after folding
766 the subtree, in order to structure the collapsed view.  See the
767 variable @code{org-cycle-separator-lines} to modify this behavior.
769 @node Visibility cycling, Motion, Headlines, Document Structure
770 @section Visibility cycling
771 @cindex cycling, visibility
772 @cindex visibility cycling
773 @cindex trees, visibility
774 @cindex show hidden text
775 @cindex hide text
777 Outlines make it possible to hide parts of the text in the buffer.
778 Org uses just two commands, bound to @key{TAB} and
779 @kbd{S-@key{TAB}} to change the visibility in the buffer.
781 @cindex subtree visibility states
782 @cindex subtree cycling
783 @cindex folded, subtree visibility state
784 @cindex children, subtree visibility state
785 @cindex subtree, subtree visibility state
786 @table @kbd
787 @kindex @key{TAB}
788 @item @key{TAB}
789 @emph{Subtree cycling}: Rotate current subtree among the states
791 @example
792 ,-> FOLDED -> CHILDREN -> SUBTREE --.
793 '-----------------------------------'
794 @end example
796 @vindex org-cycle-emulate-tab
797 @vindex org-cycle-global-at-bob
798 The cursor must be on a headline for this to work@footnote{see, however,
799 the option @code{org-cycle-emulate-tab}.}.  When the cursor is at the
800 beginning of the buffer and the first line is not a headline, then
801 @key{TAB} actually runs global cycling (see below)@footnote{see the
802 option @code{org-cycle-global-at-bob}.}.  Also when called with a prefix
803 argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
805 @cindex global visibility states
806 @cindex global cycling
807 @cindex overview, global visibility state
808 @cindex contents, global visibility state
809 @cindex show all, global visibility state
810 @kindex S-@key{TAB}
811 @item S-@key{TAB}
812 @itemx C-u @key{TAB}
813 @emph{Global cycling}: Rotate the entire buffer among the states
815 @example
816 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
817 '--------------------------------------'
818 @end example
820 When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
821 CONTENTS view up to headlines of level N will be shown.  Note that inside
822 tables, @kbd{S-@key{TAB}} jumps to the previous field.
824 @cindex show all, command
825 @kindex C-u C-u C-u @key{TAB}
826 @item C-u C-u C-u @key{TAB}
827 Show all, including drawers.
828 @kindex C-c C-r
829 @item C-c C-r
830 Reveal context around point, showing the current entry, the following heading
831 and the hierarchy above.  Useful for working near a location that has been
832 exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
833 (@pxref{Agenda commands}).  With a prefix argument show, on each
834 level, all sibling headings.
835 @kindex C-c C-x b
836 @item C-c C-x b
837 Show the current subtree in an indirect buffer@footnote{The indirect
838 buffer
839 @ifinfo
840 (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
841 @end ifinfo
842 @ifnotinfo
843 (see the Emacs manual for more information about indirect buffers)
844 @end ifnotinfo
845 will contain the entire buffer, but will be narrowed to the current
846 tree.  Editing the indirect buffer will also change the original buffer,
847 but without affecting visibility in that buffer.}.  With a numeric
848 prefix argument N, go up to level N and then take that tree.  If N is
849 negative then go up that many levels.  With a @kbd{C-u} prefix, do not remove
850 the previously used indirect buffer.
851 @end table
853 @vindex org-startup-folded
854 When Emacs first visits an Org file, the global state is set to
855 OVERVIEW, i.e. only the top level headlines are visible.  This can be
856 configured through the variable @code{org-startup-folded}, or on a
857 per-file basis by adding one of the following lines anywhere in the
858 buffer:
860 @example
861 #+STARTUP: overview
862 #+STARTUP: content
863 #+STARTUP: showall
864 @end example
866 @noindent
867 Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
868 and Columns}) will get their visibility adapted accordingly.  Allowed values
869 for this property are @code{folded}, @code{children}, @code{content}, and
870 @code{all}.
871 @table @kbd
872 @kindex C-u C-u @key{TAB}
873 @item C-u C-u @key{TAB}
874 Switch back to the startup visibility of the buffer, i.e. whatever is
875 requested by startup options and @samp{VISIBILITY} properties in individual
876 entries.
877 @end table
879 @node Motion, Structure editing, Visibility cycling, Document Structure
880 @section Motion
881 @cindex motion, between headlines
882 @cindex jumping, to headlines
883 @cindex headline navigation
884 The following commands jump to other headlines in the buffer.
886 @table @kbd
887 @kindex C-c C-n
888 @item C-c C-n
889 Next heading.
890 @kindex C-c C-p
891 @item C-c C-p
892 Previous heading.
893 @kindex C-c C-f
894 @item C-c C-f
895 Next heading same level.
896 @kindex C-c C-b
897 @item C-c C-b
898 Previous heading same level.
899 @kindex C-c C-u
900 @item C-c C-u
901 Backward to higher level heading.
902 @kindex C-c C-j
903 @item C-c C-j
904 Jump to a different place without changing the current outline
905 visibility.  Shows the document structure in a temporary buffer, where
906 you can use the following keys to find your destination:
907 @vindex org-goto-auto-isearch
908 @example
909 @key{TAB}         @r{Cycle visibility.}
910 @key{down} / @key{up}   @r{Next/previous visible headline.}
911 @key{RET}         @r{Select this location.}
912 @kbd{/}           @r{Do a Sparse-tree search}
913 @r{The following keys work if you turn off @code{org-goto-auto-isearch}}
914 n / p        @r{Next/previous visible headline.}
915 f / b        @r{Next/previous headline same level.}
916 u            @r{One level up.}
917 0-9          @r{Digit argument.}
918 q            @r{Quit}
919 @end example
920 @vindex org-goto-interface
921 See also the variable @code{org-goto-interface}.
922 @end table
924 @node Structure editing, Archiving, Motion, Document Structure
925 @section Structure editing
926 @cindex structure editing
927 @cindex headline, promotion and demotion
928 @cindex promotion, of subtrees
929 @cindex demotion, of subtrees
930 @cindex subtree, cut and paste
931 @cindex pasting, of subtrees
932 @cindex cutting, of subtrees
933 @cindex copying, of subtrees
934 @cindex subtrees, cut and paste
936 @table @kbd
937 @kindex M-@key{RET}
938 @item M-@key{RET}
939 @vindex org-M-RET-may-split-line
940 Insert new heading with same level as current.  If the cursor is in a
941 plain list item, a new item is created (@pxref{Plain lists}).  To force
942 creation of a new headline, use a prefix argument, or first press @key{RET}
943 to get to the beginning of the next line.  When this command is used in
944 the middle of a line, the line is split and the rest of the line becomes
945 the new headline@footnote{If you do not want the line to be split,
946 customize the variable @code{org-M-RET-may-split-line}.}.  If the
947 command is used at the beginning of a headline, the new headline is
948 created before the current line.  If at the beginning of any other line,
949 the content of that line is made the new heading.  If the command is
950 used at the end of a folded subtree (i.e. behind the ellipses at the end
951 of a headline), then a headline like the current one will be inserted
952 after the end of the subtree.
953 @kindex C-@key{RET}
954 @item C-@key{RET}
955 Just like @kbd{M-@key{RET}}, except when adding a new heading below the
956 current heading, the new heading is placed after the body instead of before
957 it.  This command works from anywhere in the entry.
958 @kindex M-S-@key{RET}
959 @item M-S-@key{RET}
960 Insert new TODO entry with same level as current heading.
961 @kindex C-S-@key{RET}
962 @item C-S-@key{RET}
963 Insert new TODO entry with same level as current heading.  Like
964 @kbd{C-@key{RET}}, the new headline will be inserted after the current
965 subtree.
966 @kindex M-@key{left}
967 @item M-@key{left}
968 Promote current heading by one level.
969 @kindex M-@key{right}
970 @item M-@key{right}
971 Demote current heading by one level.
972 @kindex M-S-@key{left}
973 @item M-S-@key{left}
974 Promote the current subtree by one level.
975 @kindex M-S-@key{right}
976 @item M-S-@key{right}
977 Demote the current subtree by one level.
978 @kindex M-S-@key{up}
979 @item M-S-@key{up}
980 Move subtree up (swap with previous subtree of same
981 level).
982 @kindex M-S-@key{down}
983 @item M-S-@key{down}
984 Move subtree down (swap with next subtree of same level).
985 @kindex C-c C-x C-w
986 @item C-c C-x C-w
987 Kill subtree, i.e. remove it from buffer but save in kill ring.
988 With a numeric prefix argument N, kill N sequential subtrees.
989 @kindex C-c C-x M-w
990 @item C-c C-x M-w
991 Copy subtree to kill ring.  With a numeric prefix argument N, copy the N
992 sequential subtrees.
993 @kindex C-c C-x C-y
994 @item C-c C-x C-y
995 Yank subtree from kill ring.  This does modify the level of the subtree to
996 make sure the tree fits in nicely at the yank position.  The yank level can
997 also be specified with a numeric prefix argument, or by yanking after a
998 headline marker like @samp{****}.
999 @kindex C-y
1000 @item C-y
1001 @vindex org-yank-adjusted-subtrees
1002 @vindex org-yank-folded-subtrees
1003 Depending on the variables @code{org-yank-adjusted-subtrees} and
1004 @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
1005 paste subtrees folded and in a clever way, using the same command as @kbd{C-c
1006 C-x C-y}.  With the default settings, no level adjustment will take place,
1007 but the yanked tree will be folded unless doing so would swallow text
1008 previously visible.  Any prefix argument to this command will force a normal
1009 @code{yank} to be executed, with the prefix passed along.  A good way to
1010 force a normal yank is @kbd{C-u C-y}.  If you use @code{yank-pop} after a
1011 yank, it will yank previous kill items plainly, without adjustment and
1012 folding.
1013 @kindex C-c C-x c
1014 @item C-c C-x c
1015 Clone a subtree by making a number of sibling copies of it.  You will be
1016 prompted for the number of copies to make, and you can also specify if any
1017 time stamps in the entry should be shifted.  This can be useful, for example,
1018 to create a number of tasks related to a series of lectures to prepare.  For
1019 more details, see the docstring of the command
1020 @code{org-clone-subtree-with-time-shift}.
1021 @kindex C-c C-w
1022 @item C-c C-w
1023 Refile entry or region to a different location.  @xref{Refiling notes}.
1024 @kindex C-c ^
1025 @item C-c ^
1026 Sort same-level entries.  When there is an active region, all entries in the
1027 region will be sorted.  Otherwise the children of the current headline are
1028 sorted.  The command prompts for the sorting method, which can be
1029 alphabetically, numerically, by time (using the first time stamp in each
1030 entry), by priority, or by TODO keyword (in the sequence the keywords have
1031 been defined in the setup).  Reverse sorting is possible as well.  You can
1032 also supply your own function to extract the sorting key.  With a @kbd{C-u}
1033 prefix, sorting will be case-sensitive.  With two @kbd{C-u C-u} prefixes,
1034 duplicate entries will also be removed.
1035 @kindex C-x n s
1036 @item C-x n s
1037 Narrow buffer to current subtree.
1038 @kindex C-x n w
1039 @item C-x n w
1040 Widen buffer to remove a narrowing.
1041 @kindex C-c *
1042 @item C-c *
1043 Turn a normal line or plain list item into a headline (so that it becomes a
1044 subheading at its location).  Also turn a headline into a normal line by
1045 removing the stars.  If there is an active region, turn all lines in the
1046 region into headlines.  If the first line in the region was an item, turn
1047 only the item lines into headlines.  Finally, if the first line is a
1048 headline, remove the stars from all headlines in the region.
1049 @end table
1051 @cindex region, active
1052 @cindex active region
1053 @cindex Transient mark mode
1054 When there is an active region (Transient mark mode), promotion and
1055 demotion work on all headlines in the region.  To select a region of
1056 headlines, it is best to place both point and mark at the beginning of a
1057 line, mark at the beginning of the first headline, and point at the line
1058 just after the last headline to change.  Note that when the cursor is
1059 inside a table (@pxref{Tables}), the Meta-Cursor keys have different
1060 functionality.
1062 @node Archiving, Sparse trees, Structure editing, Document Structure
1063 @section Archiving
1064 @cindex archiving
1066 When a project represented by a (sub)tree is finished, you may want
1067 to move the tree out of the way and to stop it from contributing to the
1068 agenda.  Org mode knows two ways of archiving.  You can mark a tree with
1069 the ARCHIVE tag, or you can move an entire (sub)tree to a different
1070 location.
1072 @menu
1073 * ARCHIVE tag::                 Marking a tree as inactive
1074 * Moving subtrees::             Moving a tree to an archive file
1075 @end menu
1077 @node ARCHIVE tag, Moving subtrees, Archiving, Archiving
1078 @subsection The ARCHIVE tag
1079 @cindex internal archiving
1081 A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
1082 its location in the outline tree, but behaves in the following way:
1083 @itemize @minus
1084 @item
1085 @vindex org-cycle-open-archived-trees
1086 It does not open when you attempt to do so with a visibility cycling
1087 command (@pxref{Visibility cycling}).  You can force cycling archived
1088 subtrees with @kbd{C-@key{TAB}}, or by setting the option
1089 @code{org-cycle-open-archived-trees}.  Also normal outline commands like
1090 @code{show-all} will open archived subtrees.
1091 @item
1092 @vindex org-sparse-tree-open-archived-trees
1093 During sparse tree construction (@pxref{Sparse trees}), matches in
1094 archived subtrees are not exposed, unless you configure the option
1095 @code{org-sparse-tree-open-archived-trees}.
1096 @item
1097 @vindex org-agenda-skip-archived-trees
1098 During agenda view construction (@pxref{Agenda Views}), the content of
1099 archived trees is ignored unless you configure the option
1100 @code{org-agenda-skip-archived-trees}, in which case these trees will always
1101 be included.  In the agenda you can press the @kbd{v} key to get archives
1102 temporarily included.
1103 @item
1104 @vindex org-export-with-archived-trees
1105 Archived trees are not exported (@pxref{Exporting}), only the headline
1106 is.  Configure the details using the variable
1107 @code{org-export-with-archived-trees}.
1108 @item
1109 @vindex org-columns-skip-arrchived-trees
1110 Archived trees are excluded from column view unless the variable
1111 @code{org-columns-skip-arrchived-trees} is configured to @code{nil}.
1112 @end itemize
1114 The following commands help managing the ARCHIVE tag:
1116 @table @kbd
1117 @kindex C-c C-x a
1118 @item C-c C-x a
1119 Toggle the ARCHIVE tag for the current headline.  When the tag is set,
1120 the headline changes to a shadowed face, and the subtree below it is
1121 hidden.
1122 @kindex C-u C-c C-x a
1123 @item C-u C-c C-x a
1124 Check if any direct children of the current headline should be archived.
1125 To do this, each subtree is checked for open TODO entries.  If none are
1126 found, the command offers to set the ARCHIVE tag for the child.  If the
1127 cursor is @emph{not} on a headline when this command is invoked, the
1128 level 1 trees will be checked.
1129 @kindex C-@kbd{TAB}
1130 @item C-@kbd{TAB}
1131 Cycle a tree even if it is tagged with ARCHIVE.
1132 @end table
1134 @node Moving subtrees,  , ARCHIVE tag, Archiving
1135 @subsection Moving subtrees
1136 @cindex external archiving
1138 Once an entire project is finished, you may want to move it to a different
1139 location.  Org can move it to an @emph{Archive Sibling} in the same tree, to a
1140 different tree in the current file, or to a different file, the archive file.
1142 @table @kbd
1143 @kindex C-c C-x A
1144 @item C-c C-x A
1145 Move the current entry to the @emph{Archive Sibling}.  This is a sibling of
1146 the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}
1147 (@pxref{ARCHIVE tag}).  The entry becomes a child of that sibling and in this
1148 way retains a lot of its original context, including inherited tags and
1149 approximate position in the outline.
1150 @kindex C-c $
1151 @kindex C-c C-x C-s
1152 @itemx C-c $
1153 @item C-c C-x C-s
1154 @vindex org-archive-location
1155 Archive the subtree starting at the cursor position to the location
1156 given by @code{org-archive-location}.  Context information that could be
1157 lost like the file name, the category, inherited tags, and the TODO
1158 state will be store as properties in the entry.
1159 @kindex C-u C-c C-x C-s
1160 @item C-u C-c C-x C-s
1161 Check if any direct children of the current headline could be moved to
1162 the archive.  To do this, each subtree is checked for open TODO entries.
1163 If none are found, the command offers to move it to the archive
1164 location.  If the cursor is @emph{not} on a headline when this command
1165 is invoked, the level 1 trees will be checked.
1166 @end table
1168 @cindex archive locations
1169 The default archive location is a file in the same directory as the
1170 current file, with the name derived by appending @file{_archive} to the
1171 current file name.  For information and examples on how to change this,
1172 see the documentation string of the variable
1173 @code{org-archive-location}.  There is also an in-buffer option for
1174 setting this variable, for example@footnote{For backward compatibility,
1175 the following also works: If there are several such lines in a file,
1176 each specifies the archive location for the text below it.  The first
1177 such line also applies to any text before its definition.  However,
1178 using this method is @emph{strongly} deprecated as it is incompatible
1179 with the outline structure of the document.  The correct method for
1180 setting multiple archive locations in a buffer is using properties.}:
1182 @example
1183 #+ARCHIVE: %s_done::
1184 @end example
1186 @noindent
1187 If you would like to have a special ARCHIVE location for a single entry
1188 or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
1189 location as the value (@pxref{Properties and Columns}).
1191 @vindex org-archive-save-context-info
1192 When a subtree is moved, it receives a number of special properties that
1193 record context information like the file from where the entry came, it's
1194 outline path the archiving time etc.  Configure the variable
1195 @code{org-archive-save-context-info} to adjust the amount of information
1196 added.
1198 @node Sparse trees, Plain lists, Archiving, Document Structure
1199 @section Sparse trees
1200 @cindex sparse trees
1201 @cindex trees, sparse
1202 @cindex folding, sparse trees
1203 @cindex occur, command
1205 @vindex org-show-hierarchy-above
1206 @vindex org-show-following-heading
1207 @vindex org-show-siblings
1208 @vindex org-show-entry-below
1209 An important feature of Org mode is the ability to construct @emph{sparse
1210 trees} for selected information in an outline tree, so that the entire
1211 document is folded as much as possible, but the selected information is made
1212 visible along with the headline structure above it@footnote{See also the
1213 variables @code{org-show-hierarchy-above}, @code{org-show-following-heading},
1214 @code{org-show-siblings}, and @code{org-show-entry-below} for detailed
1215 control on how much context is shown around each match.}.  Just try it out
1216 and you will see immediately how it works.
1218 Org mode contains several commands creating such trees, all these
1219 commands can be accessed through a dispatcher:
1221 @table @kbd
1222 @kindex C-c /
1223 @item C-c /
1224 This prompts for an extra key to select a sparse-tree creating command.
1225 @kindex C-c / r
1226 @item C-c / r
1227 @vindex org-remove-highlights-with-change
1228 Occur.  Prompts for a regexp and shows a sparse tree with all matches.  If
1229 the match is in a headline, the headline is made visible.  If the match is in
1230 the body of an entry, headline and body are made visible.  In order to
1231 provide minimal context, also the full hierarchy of headlines above the match
1232 is shown, as well as the headline following the match.  Each match is also
1233 highlighted; the highlights disappear when the buffer is changed by an
1234 editing command@footnote{depending on the option
1235 @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
1236 When called with a @kbd{C-u} prefix argument, previous highlights are kept,
1237 so several calls to this command can be stacked.
1238 @end table
1240 @noindent
1241 @vindex org-agenda-custom-commands
1242 For frequently used sparse trees of specific search strings, you can
1243 use the variable @code{org-agenda-custom-commands} to define fast
1244 keyboard access to specific sparse trees.  These commands will then be
1245 accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
1246 For example:
1248 @lisp
1249 (setq org-agenda-custom-commands
1250       '(("f" occur-tree "FIXME")))
1251 @end lisp
1253 @noindent will define the key @kbd{C-c a f} as a shortcut for creating
1254 a sparse tree matching the string @samp{FIXME}.
1256 The other sparse tree commands select headings based on TODO keywords,
1257 tags, or properties and will be discussed later in this manual.
1259 @kindex C-c C-e v
1260 @cindex printing sparse trees
1261 @cindex visible text, printing
1262 To print a sparse tree, you can use the Emacs command
1263 @code{ps-print-buffer-with-faces} which does not print invisible parts
1264 of the document @footnote{This does not work under XEmacs, because
1265 XEmacs uses selective display for outlining, not text properties.}.
1266 Or you can use the command @kbd{C-c C-e v} to export only the visible
1267 part of the document and print the resulting file.
1269 @node Plain lists, Drawers, Sparse trees, Document Structure
1270 @section Plain lists
1271 @cindex plain lists
1272 @cindex lists, plain
1273 @cindex lists, ordered
1274 @cindex ordered lists
1276 Within an entry of the outline tree, hand-formatted lists can provide
1277 additional structure.  They also provide a way to create lists of
1278 checkboxes (@pxref{Checkboxes}).  Org supports editing such lists,
1279 and the HTML exporter (@pxref{Exporting}) parses and formats them.
1281 Org knows ordered lists, unordered lists, and description lists.
1282 @itemize @bullet
1283 @item
1284 @emph{Unordered} list items start with @samp{-}, @samp{+}, or
1285 @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
1286 they will be seen as top-level headlines.  Also, when you are hiding leading
1287 stars to get a clean outline view, plain list items starting with a star are
1288 visually indistinguishable from true headlines.  In short: even though
1289 @samp{*} is supported, it may be better to not use it for plain list items.}
1290 as bullets.
1291 @item
1292 @emph{Ordered} list items start with a numeral followed by either a period or
1293 a right parenthesis, such as @samp{1.} or @samp{1)}.
1294 @item
1295 @emph{Description} list items are like unordered list items, but contain the
1296 separator @samp{ :: } to separate the description @emph{term} from the
1297 description.
1298 @end itemize
1300 @vindex org-empty-line-terminates-plain-lists
1301 Items belonging to the same list must have the same indentation on the first
1302 line.  In particular, if an ordered list reaches number @samp{10.}, then the
1303 2--digit numbers must be written left-aligned with the other numbers in the
1304 list.  Indentation also determines the end of a list item.  It ends before
1305 the next line that is indented like the bullet/number, or less.  Empty lines
1306 are part of the previous item, so you can have several paragraphs in one
1307 item.  If you would like an empty line to terminate all currently open plain
1308 lists, configure the variable @code{org-empty-line-terminates-plain-lists}.
1309 Here is an example:
1311 @example
1312 @group
1313 ** Lord of the Rings
1314    My favorite scenes are (in this order)
1315    1. The attack of the Rohirrim
1316    2. Eowyn's fight with the witch king
1317       + this was already my favorite scene in the book
1318       + I really like Miranda Otto.
1319    3. Peter Jackson being shot by Legolas
1320        - on DVD only
1321       He makes a really funny face when it happens.
1322    But in the end, no individual scenes matter but the film as a whole.
1323    Important actors in this film are:
1324    - @b{Elijah Wood} :: He plays Frodo
1325    - @b{Sean Austin} :: He plays Sam, Frodo's friend.  I still remember
1326      him very well from his role as Mikey Walsh in the Goonies.
1327 @end group
1328 @end example
1330 Org supports these lists by tuning filling and wrapping commands to
1331 deal with them correctly@footnote{Org only changes the filling
1332 settings for Emacs.  For XEmacs, you should use Kyle E. Jones'
1333 @file{filladapt.el}.  To turn this on,  put into @file{.emacs}:
1334 @code{(require 'filladapt)}}, and by exporting them properly
1335 (@pxref{Exporting}).
1337 The following commands act on items when the cursor is in the first line
1338 of an item (the line with the bullet or number).
1340 @table @kbd
1341 @kindex @key{TAB}
1342 @item @key{TAB}
1343 @vindex org-cycle-include-plain-lists
1344 Items can be folded just like headline levels if you set the variable
1345 @code{org-cycle-include-plain-lists}.  The level of an item is then
1346 given by the indentation of the bullet/number.  Items are always
1347 subordinate to real headlines, however; the hierarchies remain
1348 completely separated.
1350 If @code{org-cycle-include-plain-lists} has not been set, @key{TAB}
1351 fixes the indentation of the current line in a heuristic way.
1352 @kindex M-@key{RET}
1353 @item M-@key{RET}
1354 @vindex org-M-RET-may-split-line
1355 Insert new item at current level.  With a prefix argument, force a new
1356 heading (@pxref{Structure editing}).  If this command is used in the middle
1357 of a line, the line is @emph{split} and the rest of the line becomes the new
1358 item@footnote{If you do not want the line to be split, customize the variable
1359 @code{org-M-RET-may-split-line}.}.  If this command is executed in the
1360 @emph{whitespace before a bullet or number}, the new item is created
1361 @emph{before} the current item.  If the command is executed in the white
1362 space before the text that is part of an item but does not contain the
1363 bullet, a bullet is added to the current line.
1364 @kindex M-S-@key{RET}
1365 @item M-S-@key{RET}
1366 Insert a new item with a checkbox (@pxref{Checkboxes}).
1367 @kindex S-@key{up}
1368 @kindex S-@key{down}
1369 @item S-@key{up}
1370 @itemx S-@key{down}
1371 @cindex shift-selection-mode
1372 @vindex org-support-shift-select
1373 Jump to the previous/next item in the current list, but only if
1374 @code{org-support-shift-select} is off.  If not, you can still use paragraph
1375 jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite
1376 similar effect.
1377 @kindex M-S-@key{up}
1378 @kindex M-S-@key{down}
1379 @item M-S-@key{up}
1380 @itemx M-S-@key{down}
1381 Move the item including subitems up/down (swap with previous/next item
1382 of same indentation).  If the list is ordered, renumbering is
1383 automatic.
1384 @kindex M-S-@key{left}
1385 @kindex M-S-@key{right}
1386 @item M-S-@key{left}
1387 @itemx M-S-@key{right}
1388 Decrease/increase the indentation of the item, including subitems.
1389 Initially, the item tree is selected based on current indentation.
1390 When these commands are executed several times in direct succession,
1391 the initially selected region is used, even if the new indentation
1392 would imply a different hierarchy.  To use the new hierarchy, break
1393 the command chain with a cursor motion or so.
1394 @kindex C-c C-c
1395 @item C-c C-c
1396 If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
1397 state of the checkbox.  If not, this command makes sure that all the
1398 items on this list level use the same bullet.  Furthermore, if this is
1399 an ordered list, make sure the numbering is OK.
1400 @kindex C-c -
1401 @item C-c -
1402 Cycle the entire list level through the different itemize/enumerate bullets
1403 (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}).  With a numeric prefix
1404 argument N, select the Nth bullet from this list.  If there is an active
1405 region when calling this, all lines will be converted to list items.  If the
1406 first line already was a list item, any item markers will be removed from the
1407 list.  Finally, even without an active region, a normal line will be
1408 converted into a list item.
1409 @kindex S-@key{left}
1410 @kindex S-@key{right}
1411 @item S-@key{left}/@key{right}
1412 @vindex org-support-shift-select
1413 This command also cycles bullet styles when the cursor in on the bullet or
1414 anywhere in an item line, details depending on
1415 @code{org-support-shift-select}.
1416 @end table
1418 @node Drawers, Footnotes, Plain lists, Document Structure
1419 @section Drawers
1420 @cindex drawers
1421 @cindex visibility cycling, drawers
1423 @vindex org-drawers
1424 Sometimes you want to keep information associated with an entry, but you
1425 normally don't want to see it.  For this, Org mode has @emph{drawers}.
1426 Drawers need to be configured with the variable
1427 @code{org-drawers}@footnote{You can define drawers on a per-file basis
1428 with a line like @code{#+DRAWERS: HIDDEN PROPERTIES STATE}}.  Drawers
1429 look like this:
1431 @example
1432 ** This is a headline
1433    Still outside the drawer
1434    :DRAWERNAME:
1435       This is inside the drawer.
1436    :END:
1437    After the drawer.
1438 @end example
1440 Visibility cycling (@pxref{Visibility cycling}) on the headline will hide and
1441 show the entry, but keep the drawer collapsed to a single line.  In order to
1442 look inside the drawer, you need to move the cursor to the drawer line and
1443 press @key{TAB} there.  Org mode uses the @code{PROPERTIES} drawer for
1444 storing properties (@pxref{Properties and Columns}), and you can also arrange
1445 for state change notes @pxref{Tracking TODO state changes} and clock times
1446 (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}.
1448 @node Footnotes, Orgstruct mode, Drawers, Document Structure
1449 @section Footnotes
1450 @cindex footnotes
1452 Org-mode supports the creation of footnotes.  In contrast to the
1453 @file{footnote.el} package, Org-mode's footnotes are designed for work on a
1454 larger document, not only for one-off documents like emails.  The basic
1455 syntax is similar to the one used by @file{footnote.el}, i.e. a footnote is
1456 defined in a paragraph that is started by a footnote marker in square
1457 brackets in column 0, no indentation allowed.  If you need a paragraph break
1458 inside a footnote, use the LaTeX idiom @samp{\par}.  The footnote reference
1459 is simply the marker in square brackets, inside text.  For example:
1461 @example
1462 The Org homepage[fn:1] now looks a lot better than it used to.
1464 [fn:1] The link is: http://orgmode.org
1465 @end example
1467 Org-mode extends the number-based syntax to @emph{named} footnotes and
1468 optional inline definition.  Using plain numbers as markers (as
1469 @file{footnote.el} does) is supported for backward compatibility, but not
1470 encouraged because of possible conflicts with LaTeX snippets @pxref{Embedded
1471 LaTeX}.  Here are the valid references:
1473 @table @code
1474 @item [1]
1475 A plain numeric footnote marker.
1476 @item [fn:name]
1477 A named footnote reference, where @code{name} is a unique label word, or, for
1478 simplicity of automatic creation, a number.
1479 @item [fn:: This is the inline definition of this footnote]
1480 A LaTeX-like anonymous footnote where the definition is given directly at the
1481 reference point.
1482 @item [fn:name: a definition]
1483 An inline definition of a footnote, which also specifies a name for the note.
1484 Since Org allows multiple references to the same note, you can then use
1485 @code{[fn:name]} to create additional references.
1486 @end table
1488 @vindex org-footnote-auto-label
1489 Footnote labels can be created automatically, or you create names yourself.
1490 This is handled by the variable @code{org-footnote-auto-label} and its
1491 corresponding @code{#+STARTUP} keywords, see the docstring of that variable
1492 for details.
1494 @noindent The following command handles footnotes:
1496 @table @kbd
1497 @kindex C-c C-x f
1498 @item C-c C-x f
1499 The footnote action command.
1501 When the cursor is on a footnote reference, jump to the definition.  When it
1502 is at a definition, jump to the (first) reference.
1504 @vindex org-footnote-define-inline
1505 @vindex org-footnote-section
1506 Otherwise, create a new footnote.  Depending on the variable
1507 @code{org-footnote-define-inline}@footnote{The corresponding in-buffer
1508 setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
1509 definition will be placed right into the text as part of the reference, or
1510 separately into the location determined by the variable
1511 @code{org-footnote-section}.
1513 When this command is called with a prefix argument, a menu of additional
1514 options is offered:
1515 @example
1516 s   @r{Sort the footnote definitions by reference sequence.  During editing,}
1517     @r{Org makes no effort to sort footnote definitions into a particular}
1518     @r{sequence.  If you want them sorted, use this command, which will}
1519     @r{also move entries according to @code{org-footnote-section}.}
1520 n   @r{Normalize the footnotes by collecting all definitions (including}
1521     @r{inline definitions) into a special section, and then numbering them}
1522     @r{in sequence.  The references will then also be numbers.  This is}
1523     @r{meant to be the final step before finishing a document (e.g. sending}
1524     @r{off an email).  The exporters do this automatically, and so could}
1525     @r{something like @code{message-send-hook}.}
1526 d   @r{Delete the footnote at point, and all definitions of and references}
1527     @r{to it.}
1528 @end example
1529 @kindex C-c C-c
1530 @item C-c C-c
1531 If the cursor is on a footnote reference, jump to the definition.  If it is a
1532 the definition, jump back to the reference.  When called at a footnote
1533 location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
1534 @kindex C-c C-o
1535 @kindex mouse-1
1536 @kindex mouse-2
1537 @item C-c C-c  @r{or} mouse-1/2
1538 Footnote labels are also links to the corresponding definition/reference, and
1539 you can use the usual commands to follow these links.
1540 @end table
1542 @node Orgstruct mode,  , Footnotes, Document Structure
1543 @section The Orgstruct minor mode
1544 @cindex Orgstruct mode
1545 @cindex minor mode for structure editing
1547 If you like the intuitive way the Org mode structure editing and list
1548 formatting works, you might want to use these commands in other modes like
1549 Text mode or Mail mode as well.  The minor mode @code{orgstruct-mode} makes
1550 this possible.   Toggle the mode with @kbd{M-x orgstruct-mode}, or
1551 turn it on by default, for example in Mail mode, with one of:
1553 @lisp
1554 (add-hook 'mail-mode-hook 'turn-on-orgstruct)
1555 (add-hook 'mail-mode-hook 'turn-on-orgstruct++)
1556 @end lisp
1558 When this mode is active and the cursor is on a line that looks to Org like a
1559 headline or the first line of a list item, most structure editing commands
1560 will work, even if the same keys normally have different functionality in the
1561 major mode you are using.  If the cursor is not in one of those special
1562 lines, Orgstruct mode lurks silently in the shadow.  When you use
1563 @code{orgstruct++-mode}, Org will also export indentation and autofill
1564 settings into that mode, and detect item context after the first line of an
1565 item.
1567 @node Tables, Hyperlinks, Document Structure, Top
1568 @chapter Tables
1569 @cindex tables
1570 @cindex editing tables
1572 Org comes with a fast and intuitive table editor.  Spreadsheet-like
1573 calculations are supported in connection with the Emacs @file{calc}
1574 package
1575 @ifinfo
1576 (@pxref{Top,Calc,,Calc,Gnu Emacs Calculator Manual}).
1577 @end ifinfo
1578 @ifnotinfo
1579 (see the Emacs Calculator manual for more information about the Emacs
1580 calculator).
1581 @end ifnotinfo
1583 @menu
1584 * Built-in table editor::       Simple tables
1585 * Narrow columns::              Stop wasting space in tables
1586 * Column groups::               Grouping to trigger vertical lines
1587 * Orgtbl mode::                 The table editor as minor mode
1588 * The spreadsheet::             The table editor has spreadsheet capabilities
1589 * Org Plot::                    Plotting from org tables
1590 @end menu
1592 @node Built-in table editor, Narrow columns, Tables, Tables
1593 @section The built-in table editor
1594 @cindex table editor, built-in
1596 Org makes it easy to format tables in plain ASCII.  Any line with
1597 @samp{|} as the first non-whitespace character is considered part of a
1598 table.  @samp{|} is also the column separator.  A table might look like
1599 this:
1601 @example
1602 | Name  | Phone | Age |
1603 |-------+-------+-----|
1604 | Peter |  1234 |  17 |
1605 | Anna  |  4321 |  25 |
1606 @end example
1608 A table is re-aligned automatically each time you press @key{TAB} or
1609 @key{RET} or @kbd{C-c C-c} inside the table.  @key{TAB} also moves to
1610 the next field (@key{RET} to the next row) and creates new table rows
1611 at the end of the table or before horizontal lines.  The indentation
1612 of the table is set by the first line.  Any line starting with
1613 @samp{|-} is considered as a horizontal separator line and will be
1614 expanded on the next re-align to span the whole table width.  So, to
1615 create the above table, you would only type
1617 @example
1618 |Name|Phone|Age|
1620 @end example
1622 @noindent and then press @key{TAB} to align the table and start filling in
1623 fields.  Even faster would be to type @code{|Name|Phone|Age} followed by
1624 @kbd{C-c @key{RET}}.
1626 @vindex org-enable-table-editor
1627 @vindex org-table-auto-blank-field
1628 When typing text into a field, Org treats @key{DEL},
1629 @key{Backspace}, and all character keys in a special way, so that
1630 inserting and deleting avoids shifting other fields.  Also, when
1631 typing @emph{immediately after the cursor was moved into a new field
1632 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
1633 field is automatically made blank.  If this behavior is too
1634 unpredictable for you, configure the variables
1635 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
1637 @table @kbd
1638 @tsubheading{Creation and conversion}
1639 @kindex C-c |
1640 @item C-c |
1641 Convert the active region to table. If every line contains at least one
1642 TAB character, the function assumes that the material is tab separated.
1643 If every line contains a comma, comma-separated values (CSV) are assumed.
1644 If not, lines are split at whitespace into fields.  You can use a prefix
1645 argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
1646 C-u} forces TAB, and a numeric argument N indicates that at least N
1647 consecutive spaces, or alternatively a TAB will be the separator.
1649 If there is no active region, this command creates an empty Org
1650 table.  But it's easier just to start typing, like
1651 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
1653 @tsubheading{Re-aligning and field motion}
1654 @kindex C-c C-c
1655 @item C-c C-c
1656 Re-align the table without moving the cursor.
1658 @kindex @key{TAB}
1659 @item @key{TAB}
1660 Re-align the table, move to the next field.  Creates a new row if
1661 necessary.
1663 @kindex S-@key{TAB}
1664 @item S-@key{TAB}
1665 Re-align, move to previous field.
1667 @kindex @key{RET}
1668 @item @key{RET}
1669 Re-align the table and move down to next row.  Creates a new row if
1670 necessary.  At the beginning or end of a line, @key{RET} still does
1671 NEWLINE, so it can be used to split a table.
1673 @kindex M-a
1674 @item M-a
1675 Move to beginning of the current table field, or on to the previous field.
1676 @kindex M-e
1677 @item M-e
1678 Move to end of the current table field, or on to the next field.
1680 @tsubheading{Column and row editing}
1681 @kindex M-@key{left}
1682 @kindex M-@key{right}
1683 @item M-@key{left}
1684 @itemx M-@key{right}
1685 Move the current column left/right.
1687 @kindex M-S-@key{left}
1688 @item M-S-@key{left}
1689 Kill the current column.
1691 @kindex M-S-@key{right}
1692 @item M-S-@key{right}
1693 Insert a new column to the left of the cursor position.
1695 @kindex M-@key{up}
1696 @kindex M-@key{down}
1697 @item M-@key{up}
1698 @itemx M-@key{down}
1699 Move the current row up/down.
1701 @kindex M-S-@key{up}
1702 @item M-S-@key{up}
1703 Kill the current row or horizontal line.
1705 @kindex M-S-@key{down}
1706 @item M-S-@key{down}
1707 Insert a new row above the current row.  With a prefix argument, the line is
1708 created below the current one.
1710 @kindex C-c -
1711 @item C-c -
1712 Insert a horizontal line below current row.  With a prefix argument, the line
1713 is created above the current line.
1715 @kindex C-c @key{RET}
1716 @item C-c @key{RET}
1717 Insert a horizontal line below current row, and move the cursor into the row
1718 below that line.
1720 @kindex C-c ^
1721 @item C-c ^
1722 Sort the table lines in the region.  The position of point indicates the
1723 column to be used for sorting, and the range of lines is the range
1724 between the nearest horizontal separator lines, or the entire table.  If
1725 point is before the first column, you will be prompted for the sorting
1726 column.  If there is an active region, the mark specifies the first line
1727 and the sorting column, while point should be in the last line to be
1728 included into the sorting.  The command prompts for the sorting type
1729 (alphabetically, numerically, or by time).  When called with a prefix
1730 argument, alphabetic sorting will be case-sensitive.
1732 @tsubheading{Regions}
1733 @kindex C-c C-x M-w
1734 @item C-c C-x M-w
1735 Copy a rectangular region from a table to a special clipboard.  Point
1736 and mark determine edge fields of the rectangle.  The process ignores
1737 horizontal separator lines.
1739 @kindex C-c C-x C-w
1740 @item C-c C-x C-w
1741 Copy a rectangular region from a table to a special clipboard, and
1742 blank all fields in the rectangle.  So this is the ``cut'' operation.
1744 @kindex C-c C-x C-y
1745 @item C-c C-x C-y
1746 Paste a rectangular region into a table.
1747 The upper left corner ends up in the current field.  All involved fields
1748 will be overwritten.  If the rectangle does not fit into the present table,
1749 the table is enlarged as needed.  The process ignores horizontal separator
1750 lines.
1752 @kindex M-@key{RET}
1753 @itemx M-@kbd{RET}
1754 Wrap several fields in a column like a paragraph.  If there is an active
1755 region, and both point and mark are in the same column, the text in the
1756 column is wrapped to minimum width for the given number of lines.  A numeric
1757 prefix argument may be used to change the number of desired lines.  If there
1758 is no region, the current field is split at the cursor position and the text
1759 fragment to the right of the cursor is prepended to the field one line
1760 down. If there is no region, but you specify a prefix argument, the current
1761 field is made blank, and the content is appended to the field above.
1763 @tsubheading{Calculations}
1764 @cindex formula, in tables
1765 @cindex calculations, in tables
1766 @cindex region, active
1767 @cindex active region
1768 @cindex Transient mark mode
1769 @kindex C-c +
1770 @item C-c +
1771 Sum the numbers in the current column, or in the rectangle defined by
1772 the active region.  The result is shown in the echo area and can
1773 be inserted with @kbd{C-y}.
1775 @kindex S-@key{RET}
1776 @item S-@key{RET}
1777 @vindex org-table-copy-increment
1778 When current field is empty, copy from first non-empty field above.  When not
1779 empty, copy current field down to next row and move cursor along with it.
1780 Depending on the variable @code{org-table-copy-increment}, integer field
1781 values will be incremented during copy.  Integers that are too large will not
1782 be incremented.  Also, a @code{0} prefix argument temporarily disables the
1783 increment.  This key is also used by shift-selection and related modes
1784 (@pxref{Conflicts}).
1786 @tsubheading{Miscellaneous}
1787 @kindex C-c `
1788 @item C-c `
1789 Edit the current field in a separate window.  This is useful for fields
1790 that are not fully visible (@pxref{Narrow columns}).  When called with a
1791 @kbd{C-u} prefix, just make the full field visible, so that it can be
1792 edited in place.
1794 @item M-x org-table-import
1795 Import a file as a table.  The table should be TAB- or whitespace
1796 separated.  Useful, for example, to import a spreadsheet table or data
1797 from a database, because these programs generally can write
1798 TAB-separated text files.  This command works by inserting the file into
1799 the buffer and then converting the region to a table.  Any prefix
1800 argument is passed on to the converter, which uses it to determine the
1801 separator.
1802 @item C-c |
1803 Tables can also be imported by pasting tabular text into the Org
1804 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
1805 @kbd{C-c |} command (see above under @i{Creation and conversion}).
1807 @item M-x org-table-export
1808 @vindex org-table-export-default-format
1809 Export the table, by default as a TAB-separated file.  Useful for data
1810 exchange with, for example, spreadsheet or database programs.  The format
1811 used to export the file can be configured in the variable
1812 @code{org-table-export-default-format}.  You may also use properties
1813 @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
1814 name and the format for table export in a subtree.  Org supports quite
1815 general formats for exported tables.  The exporter format is the same as the
1816 format used by Orgtbl radio tables, see @ref{Translator functions} for a
1817 detailed description.
1818 @end table
1820 If you don't like the automatic table editor because it gets in your
1821 way on lines which you would like to start with @samp{|}, you can turn
1822 it off with
1824 @lisp
1825 (setq org-enable-table-editor nil)
1826 @end lisp
1828 @noindent Then the only table command that still works is
1829 @kbd{C-c C-c} to do a manual re-align.
1831 @node Narrow columns, Column groups, Built-in table editor, Tables
1832 @section Narrow columns
1833 @cindex narrow columns in tables
1835 The width of columns is automatically determined by the table editor.
1836 Sometimes a single field or a few fields need to carry more text,
1837 leading to inconveniently wide columns.  To limit@footnote{This feature
1838 does not work on XEmacs.} the width of a column, one field anywhere in
1839 the column may contain just the string @samp{<N>} where @samp{N} is an
1840 integer specifying the width of the column in characters.  The next
1841 re-align will then set the width of this column to no more than this
1842 value.
1844 @example
1845 @group
1846 |---+------------------------------|               |---+--------|
1847 |   |                              |               |   | <6>    |
1848 | 1 | one                          |               | 1 | one    |
1849 | 2 | two                          |     ----\     | 2 | two    |
1850 | 3 | This is a long chunk of text |     ----/     | 3 | This=> |
1851 | 4 | four                         |               | 4 | four   |
1852 |---+------------------------------|               |---+--------|
1853 @end group
1854 @end example
1856 @noindent
1857 Fields that are wider become clipped and end in the string @samp{=>}.
1858 Note that the full text is still in the buffer, it is only invisible.
1859 To see the full text, hold the mouse over the field - a tool-tip window
1860 will show the full content.  To edit such a field, use the command
1861 @kbd{C-c `} (that is @kbd{C-c} followed by the backquote).  This will
1862 open a new window with the full field.  Edit it and finish with @kbd{C-c
1863 C-c}.
1865 @vindex org-startup-align-all-tables
1866 When visiting a file containing a table with narrowed columns, the
1867 necessary character hiding has not yet happened, and the table needs to
1868 be aligned before it looks nice.  Setting the option
1869 @code{org-startup-align-all-tables} will realign all tables in a file
1870 upon visiting, but also slow down startup.  You can also set this option
1871 on a per-file basis with:
1873 @example
1874 #+STARTUP: align
1875 #+STARTUP: noalign
1876 @end example
1878 @node Column groups, Orgtbl mode, Narrow columns, Tables
1879 @section Column groups
1880 @cindex grouping columns in tables
1882 When Org exports tables, it does so by default without vertical
1883 lines because that is visually more satisfying in general.  Occasionally
1884 however, vertical lines can be useful to structure a table into groups
1885 of columns, much like horizontal lines can do for groups of rows.  In
1886 order to specify column groups, you can use a special row where the
1887 first field contains only @samp{/}.  The further fields can either
1888 contain @samp{<} to indicate that this column should start a group,
1889 @samp{>} to indicate the end of a column, or @samp{<>} to make a column
1890 a group of its own.  Boundaries between column groups will upon export be
1891 marked with vertical lines.  Here is an example:
1893 @example
1894 |   |  N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
1895 |---+----+-----+-----+-----+---------+------------|
1896 | / | <> |   < |     |   > |       < |          > |
1897 | # |  1 |   1 |   1 |   1 |       1 |          1 |
1898 | # |  2 |   4 |   8 |  16 |  1.4142 |     1.1892 |
1899 | # |  3 |   9 |  27 |  81 |  1.7321 |     1.3161 |
1900 |---+----+-----+-----+-----+---------+------------|
1901 #+TBLFM: $3=$2^2::$4=$2^3::$5=$2^4::$6=sqrt($2)::$7=sqrt(sqrt(($2)))
1902 @end example
1904 It is also sufficient to just insert the column group starters after
1905 every vertical line you'd like to have:
1907 @example
1908 |  N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
1909 |----+-----+-----+-----+---------+------------|
1910 | /  | <   |     |     | <       |            |
1911 @end example
1913 @node Orgtbl mode, The spreadsheet, Column groups, Tables
1914 @section The Orgtbl minor mode
1915 @cindex Orgtbl mode
1916 @cindex minor mode for tables
1918 If you like the intuitive way the Org table editor works, you
1919 might also want to use it in other modes like Text mode or Mail mode.
1920 The minor mode Orgtbl mode makes this possible.  You can always toggle
1921 the mode with @kbd{M-x orgtbl-mode}.  To turn it on by default, for
1922 example in mail mode, use
1924 @lisp
1925 (add-hook 'mail-mode-hook 'turn-on-orgtbl)
1926 @end lisp
1928 Furthermore, with some special setup, it is possible to maintain tables
1929 in arbitrary syntax with Orgtbl mode.  For example, it is possible to
1930 construct La@TeX{} tables with the underlying ease and power of
1931 Orgtbl mode, including spreadsheet capabilities.  For details, see
1932 @ref{Tables in arbitrary syntax}.
1934 @node The spreadsheet, Org Plot, Orgtbl mode, Tables
1935 @section The spreadsheet
1936 @cindex calculations, in tables
1937 @cindex spreadsheet capabilities
1938 @cindex @file{calc} package
1940 The table editor makes use of the Emacs @file{calc} package to implement
1941 spreadsheet-like capabilities.  It can also evaluate Emacs Lisp forms to
1942 derive fields from other fields.  While fully featured, Org's
1943 implementation is not identical to other spreadsheets.  For example,
1944 Org knows the concept of a @emph{column formula} that will be
1945 applied to all non-header fields in a column without having to copy the
1946 formula to each relevant field.
1948 @menu
1949 * References::                  How to refer to another field or range
1950 * Formula syntax for Calc::     Using Calc to compute stuff
1951 * Formula syntax for Lisp::     Writing formulas in Emacs Lisp
1952 * Field formulas::              Formulas valid for a single field
1953 * Column formulas::             Formulas valid for an entire column
1954 * Editing and debugging formulas::  Fixing formulas
1955 * Updating the table::          Recomputing all dependent fields
1956 * Advanced features::           Field names, parameters and automatic recalc
1957 @end menu
1959 @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet
1960 @subsection References
1961 @cindex references
1963 To compute fields in the table from other fields, formulas must
1964 reference other fields or ranges.  In Org, fields can be referenced
1965 by name, by absolute coordinates, and by relative coordinates.  To find
1966 out what the coordinates of a field are, press @kbd{C-c ?} in that
1967 field, or press @kbd{C-c @}} to toggle the display of a grid.
1969 @subsubheading Field references
1970 @cindex field references
1971 @cindex references, to fields
1973 Formulas can reference the value of another field in two ways.  Like in
1974 any other spreadsheet, you may reference fields with a letter/number
1975 combination like @code{B3}, meaning the 2nd field in the 3rd row.
1976 @c Such references are always fixed to that field, they don't change
1977 @c when you copy and paste a formula to a different field.  So
1978 @c Org's @code{B3} behaves like @code{$B$3} in other spreadsheets.
1980 @noindent
1981 Org also uses another, more general operator that looks like this:
1982 @example
1983 @@row$column
1984 @end example
1986 @noindent
1987 Column references can be absolute like @samp{1}, @samp{2},...@samp{N},
1988 or relative to the current column like @samp{+1} or @samp{-2}.
1990 The row specification only counts data lines and ignores horizontal
1991 separator lines (hlines).  You can use absolute row numbers
1992 @samp{1}...@samp{N}, and row numbers relative to the current row like
1993 @samp{+3} or @samp{-1}.  Or specify the row relative to one of the
1994 hlines: @samp{I} refers to the first hline@footnote{Note that only
1995 hlines are counted that @emph{separate} table lines.  If the table
1996 starts with a hline above the header, it does not count.}, @samp{II} to
1997 the second etc.  @samp{-I} refers to the first such line above the
1998 current line, @samp{+I} to the first such line below the current line.
1999 You can also write @samp{III+2} which is the second data line after the
2000 third hline in the table.  Relative row numbers like @samp{-3} will not
2001 cross hlines if the current line is too close to the hline.  Instead,
2002 the value directly at the hline is used.
2004 @samp{0} refers to the current row and column.  Also, if you omit
2005 either the column or the row part of the reference, the current
2006 row/column is implied.
2008 Org's references with @emph{unsigned} numbers are fixed references
2009 in the sense that if you use the same reference in the formula for two
2010 different fields, the same field will be referenced each time.
2011 Org's references with @emph{signed} numbers are floating
2012 references because the same reference operator can reference different
2013 fields depending on the field being calculated by the formula.
2015 As a special case references like @samp{$LR5} and @samp{$LR12} can be used to
2016 refer in a stable way to the 5th and 12th field in the last row of the
2017 table.
2019 Here are a few examples:
2021 @example
2022 @@2$3      @r{2nd row, 3rd column}
2023 C2        @r{same as previous}
2024 $5        @r{column 5 in the current row}
2025 E&        @r{same as previous}
2026 @@2        @r{current column, row 2}
2027 @@-1$-3    @r{the field one row up, three columns to the left}
2028 @@-I$2     @r{field just under hline above current row, column 2}
2029 @end example
2031 @subsubheading Range references
2032 @cindex range references
2033 @cindex references, to ranges
2035 You may reference a rectangular range of fields by specifying two field
2036 references connected by two dots @samp{..}.  If both fields are in the
2037 current row, you may simply use @samp{$2..$7}, but if at least one field
2038 is in a different row, you need to use the general @code{@@row$column}
2039 format at least for the first field (i.e the reference must start with
2040 @samp{@@} in order to be interpreted correctly).  Examples:
2042 @example
2043 $1..$3        @r{First three fields in the current row.}
2044 $P..$Q        @r{Range, using column names (see under Advanced)}
2045 @@2$1..@@4$3    @r{6 fields between these two fields.}
2046 A2..C4        @r{Same as above.}
2047 @@-1$-2..@@-1   @r{3 numbers from the column to the left, 2 up to current row}
2048 @end example
2050 @noindent Range references return a vector of values that can be fed
2051 into Calc vector functions.  Empty fields in ranges are normally
2052 suppressed, so that the vector contains only the non-empty fields (but
2053 see the @samp{E} mode switch below).  If there are no non-empty fields,
2054 @samp{[0]} is returned to avoid syntax errors in formulas.
2056 @subsubheading Named references
2057 @cindex named references
2058 @cindex references, named
2059 @cindex name, of column or field
2060 @cindex constants, in calculations
2062 @vindex org-table-formula-constants
2063 @samp{$name} is interpreted as the name of a column, parameter or
2064 constant.  Constants are defined globally through the variable
2065 @code{org-table-formula-constants}, and locally (for the file) through a
2066 line like
2068 @example
2069 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
2070 @end example
2072 @noindent
2073 @vindex constants-unit-system
2074 Also properties (@pxref{Properties and Columns}) can be used as
2075 constants in table formulas: For a property @samp{:Xyz:} use the name
2076 @samp{$PROP_Xyz}, and the property will be searched in the current
2077 outline entry and in the hierarchy above it.  If you have the
2078 @file{constants.el} package, it will also be used to resolve constants,
2079 including natural constants like @samp{$h} for Planck's constant, and
2080 units like @samp{$km} for kilometers@footnote{@file{Constant.el} can
2081 supply the values of constants in two different unit systems, @code{SI}
2082 and @code{cgs}.  Which one is used depends on the value of the variable
2083 @code{constants-unit-system}.  You can use the @code{#+STARTUP} options
2084 @code{constSI} and @code{constcgs} to set this value for the current
2085 buffer.}.  Column names and parameters can be specified in special table
2086 lines.  These are described below, see @ref{Advanced features}.  All
2087 names must start with a letter, and further consist of letters and
2088 numbers.
2090 @subsubheading Remote references
2091 @cindex remote references
2092 @cindex references, remote
2093 @cindex references, to a different table
2094 @cindex name, of column or field
2095 @cindex constants, in calculations
2097 You may also reference constants, fields and ranges from a different table,
2098 either in the current file or even in a different file.  The syntax is
2100 @example
2101 remote(NAME-OR-ID,REF)
2102 @end example
2104 @noindent
2105 where NAME can be the name of a table in the current file as set by a
2106 @code{#+TBLNAME: NAME} line before the table.  It can also be the ID of an
2107 entry, even in a different file, and the reference then refers to the first
2108 table in that entry.  REF is an absolute field or range reference as
2109 described above, valid in the referenced table.
2111 @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet
2112 @subsection Formula syntax for Calc
2113 @cindex formula syntax, Calc
2114 @cindex syntax, of formulas
2116 A formula can be any algebraic expression understood by the Emacs
2117 @file{Calc} package.  @b{Note that @file{calc} has the
2118 non-standard convention that @samp{/} has lower precedence than
2119 @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.}  Before
2120 evaluation by @code{calc-eval} (@pxref{Calling Calc from
2121 Your Programs,calc-eval,Calling Calc from Your Lisp Programs,Calc,GNU
2122 Emacs Calc Manual}),
2123 @c FIXME:  The link to the Calc manual in HTML does not work.
2124 variable substitution takes place according to the rules described above.
2125 @cindex vectors, in table calculations
2126 The range vectors can be directly fed into the Calc vector functions
2127 like @samp{vmean} and @samp{vsum}.
2129 @cindex format specifier
2130 @cindex mode, for @file{calc}
2131 @vindex org-calc-default-modes
2132 A formula can contain an optional mode string after a semicolon.  This
2133 string consists of flags to influence Calc and other modes during
2134 execution.  By default, Org uses the standard Calc modes (precision
2135 12, angular units degrees, fraction and symbolic modes off).  The display
2136 format, however, has been changed to @code{(float 5)} to keep tables
2137 compact.  The default settings can be configured using the variable
2138 @code{org-calc-default-modes}.
2140 @example
2141 p20           @r{switch the internal precision to 20 digits}
2142 n3 s3 e2 f4   @r{normal, scientific, engineering, or fixed display format}
2143 D R           @r{angle modes: degrees, radians}
2144 F S           @r{fraction and symbolic modes}
2145 N             @r{interpret all fields as numbers, use 0 for non-numbers}
2146 T             @r{force text interpretation}
2147 E             @r{keep empty fields in ranges}
2148 @end example
2150 @noindent
2151 In addition, you may provide a @code{printf} format specifier to
2152 reformat the final result.  A few examples:
2154 @example
2155 $1+$2                @r{Sum of first and second field}
2156 $1+$2;%.2f           @r{Same, format result to two decimals}
2157 exp($2)+exp($1)      @r{Math functions can be used}
2158 $0;%.1f              @r{Reformat current cell to 1 decimal}
2159 ($3-32)*5/9          @r{Degrees F -> C conversion}
2160 $c/$1/$cm            @r{Hz -> cm conversion, using @file{constants.el}}
2161 tan($1);Dp3s1        @r{Compute in degrees, precision 3, display SCI 1}
2162 sin($1);Dp3%.1e      @r{Same, but use printf specifier for display}
2163 vmean($2..$7)        @r{Compute column range mean, using vector function}
2164 vmean($2..$7);EN     @r{Same, but treat empty fields as 0}
2165 taylor($3,x=7,2)     @r{taylor series of $3, at x=7, second degree}
2166 @end example
2168 Calc also contains a complete set of logical operations.  For example
2170 @example
2171 if($1<20,teen,string(""))  @r{``teen'' if age $1 less than 20, else empty}
2172 @end example
2174 @node Formula syntax for Lisp, Field formulas, Formula syntax for Calc, The spreadsheet
2175 @subsection Emacs Lisp forms as formulas
2176 @cindex Lisp forms, as table formulas
2178 It is also possible to write a formula in Emacs Lisp; this can be useful
2179 for string manipulation and control structures, if Calc's
2180 functionality is not enough.  If a formula starts with a single quote
2181 followed by an opening parenthesis, then it is evaluated as a lisp form.
2182 The evaluation should return either a string or a number.  Just as with
2183 @file{calc} formulas, you can specify modes and a printf format after a
2184 semicolon.  With Emacs Lisp forms, you need to be conscious about the way
2185 field references are interpolated into the form.  By default, a
2186 reference will be interpolated as a Lisp string (in double quotes)
2187 containing the field.  If you provide the @samp{N} mode switch, all
2188 referenced elements will be numbers (non-number fields will be zero) and
2189 interpolated as Lisp numbers, without quotes.  If you provide the
2190 @samp{L} flag, all fields will be interpolated literally, without quotes.
2191 I.e., if you want a reference to be interpreted as a string by the Lisp
2192 form, enclose the reference operator itself in double quotes, like
2193 @code{"$3"}.  Ranges are inserted as space-separated fields, so you can
2194 embed them in list or vector syntax.  A few examples, note how the
2195 @samp{N} mode is used when we do computations in lisp.
2197 @example
2198 @r{Swap the first two characters of the content of column 1}
2199   '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
2200 @r{Add columns 1 and 2, equivalent to Calc's @code{$1+$2}}
2201   '(+ $1 $2);N
2202 @r{Compute the sum of columns 1-4, like Calc's @code{vsum($1..$4)}}
2203   '(apply '+ '($1..$4));N
2204 @end example
2206 @node Field formulas, Column formulas, Formula syntax for Lisp, The spreadsheet
2207 @subsection Field formulas
2208 @cindex field formula
2209 @cindex formula, for individual table field
2211 To assign a formula to a particular field, type it directly into the
2212 field, preceded by @samp{:=}, for example @samp{:=$1+$2}.  When you
2213 press @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in
2214 the field, the formula will be stored as the formula for this field,
2215 evaluated, and the current field replaced with the result.
2217 Formulas are stored in a special line starting with @samp{#+TBLFM:}
2218 directly below the table.  If you typed the equation in the 4th field of
2219 the 3rd data line in the table, the formula will look like
2220 @samp{@@3$4=$1+$2}.  When inserting/deleting/swapping column and rows
2221 with the appropriate commands, @i{absolute references} (but not relative
2222 ones) in stored formulas are modified in order to still reference the
2223 same field.  Of cause this is not true if you edit the table structure
2224 with normal editing commands - then you must fix the equations yourself.
2225 The left hand side of a formula may also be a named field (@pxref{Advanced
2226 features}), or a last-row reference like @samp{$LR3}.
2228 Instead of typing an equation into the field, you may also use the
2229 following command
2231 @table @kbd
2232 @kindex C-u C-c =
2233 @item C-u C-c =
2234 Install a new formula for the current field.  The command prompts for a
2235 formula, with default taken from the @samp{#+TBLFM:} line, applies
2236 it to the current field and stores it.
2237 @end table
2239 @node Column formulas, Editing and debugging formulas, Field formulas, The spreadsheet
2240 @subsection Column formulas
2241 @cindex column formula
2242 @cindex formula, for table column
2244 Often in a table, the same formula should be used for all fields in a
2245 particular column.  Instead of having to copy the formula to all fields
2246 in that column, Org allows to assign a single formula to an entire
2247 column.  If the table contains horizontal separator hlines, everything
2248 before the first such line is considered part of the table @emph{header}
2249 and will not be modified by column formulas.
2251 To assign a formula to a column, type it directly into any field in the
2252 column, preceded by an equal sign, like @samp{=$1+$2}.  When you press
2253 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2254 the formula will be stored as the formula for the current column, evaluated
2255 and the current field replaced with the result.  If the field contains only
2256 @samp{=}, the previously stored formula for this column is used.  For each
2257 column, Org will only remember the most recently used formula.  In the
2258 @samp{TBLFM:} line, column formulas will look like @samp{$4=$1+$2}.  The left
2259 hand side of a column formula can currently not be the name of column, it
2260 must be the numeric column reference.
2262 Instead of typing an equation into the field, you may also use the
2263 following command:
2265 @table @kbd
2266 @kindex C-c =
2267 @item C-c =
2268 Install a new formula for the current column and replace current field with
2269 the result of the formula.  The command prompts for a formula, with default
2270 taken from the @samp{#+TBLFM} line, applies it to the current field and
2271 stores it.  With a numeric prefix argument(e.g. @kbd{C-5 C-c =}) the command
2272 will apply it to that many consecutive fields in the current column.
2273 @end table
2275 @node Editing and debugging formulas, Updating the table, Column formulas, The spreadsheet
2276 @subsection Editing and debugging formulas
2277 @cindex formula editing
2278 @cindex editing, of table formulas
2280 @vindex org-table-use-standard-references
2281 You can edit individual formulas in the minibuffer or directly in the
2282 field.  Org can also prepare a special buffer with all active
2283 formulas of a table.  When offering a formula for editing, Org
2284 converts references to the standard format (like @code{B3} or @code{D&})
2285 if possible.  If you prefer to only work with the internal format (like
2286 @code{@@3$2} or @code{$4}), configure the variable
2287 @code{org-table-use-standard-references}.
2289 @table @kbd
2290 @kindex C-c =
2291 @kindex C-u C-c =
2292 @item C-c =
2293 @itemx C-u C-c =
2294 Edit the formula associated with the current column/field in the
2295 minibuffer.  See @ref{Column formulas} and @ref{Field formulas}.
2296 @kindex C-u C-u C-c =
2297 @item C-u C-u C-c =
2298 Re-insert the active formula (either a
2299 field formula, or a column formula) into the current field, so that you
2300 can edit it directly in the field.  The advantage over editing in the
2301 minibuffer is that you can use the command @kbd{C-c ?}.
2302 @kindex C-c ?
2303 @item C-c ?
2304 While editing a formula in a table field, highlight the field(s)
2305 referenced by the reference at the cursor position in the formula.
2306 @kindex C-c @}
2307 @item C-c @}
2308 Toggle the display of row and column numbers for a table, using
2309 overlays.  These are updated each time the table is aligned, you can
2310 force it with @kbd{C-c C-c}.
2311 @kindex C-c @{
2312 @item C-c @{
2313 Toggle the formula debugger on and off.  See below.
2314 @kindex C-c '
2315 @item C-c '
2316 Edit all formulas for the current table in a special buffer, where the
2317 formulas will be displayed one per line.  If the current field has an
2318 active formula, the cursor in the formula editor will mark it.
2319 While inside the special buffer, Org will automatically highlight
2320 any field or range reference at the cursor position.  You may edit,
2321 remove and add formulas, and use the following commands:
2322 @table @kbd
2323 @kindex C-c C-c
2324 @kindex C-x C-s
2325 @item C-c C-c
2326 @itemx C-x C-s
2327 Exit the formula editor and store the modified formulas.  With @kbd{C-u}
2328 prefix, also apply the new formulas to the entire table.
2329 @kindex C-c C-q
2330 @item C-c C-q
2331 Exit the formula editor without installing changes.
2332 @kindex C-c C-r
2333 @item C-c C-r
2334 Toggle all references in the formula editor between standard (like
2335 @code{B3}) and internal (like @code{@@3$2}).
2336 @kindex @key{TAB}
2337 @item @key{TAB}
2338 Pretty-print or indent lisp formula at point.  When in a line containing
2339 a lisp formula, format the formula according to Emacs Lisp rules.
2340 Another @key{TAB} collapses the formula back again.  In the open
2341 formula, @key{TAB} re-indents just like in Emacs lisp mode.
2342 @kindex M-@key{TAB}
2343 @item M-@key{TAB}
2344 Complete Lisp symbols, just like in Emacs lisp mode.
2345 @kindex S-@key{up}
2346 @kindex S-@key{down}
2347 @kindex S-@key{left}
2348 @kindex S-@key{right}
2349 @item S-@key{up}/@key{down}/@key{left}/@key{right}
2350 Shift the reference at point.  For example, if the reference is
2351 @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
2352 This also works for relative references, and for hline references.
2353 @kindex M-S-@key{up}
2354 @kindex M-S-@key{down}
2355 @item M-S-@key{up}/@key{down}
2356 Move the test line for column formulas in the Org buffer up and
2357 down.
2358 @kindex M-@key{up}
2359 @kindex M-@key{down}
2360 @item M-@key{up}/@key{down}
2361 Scroll the window displaying the table.
2362 @kindex C-c @}
2363 @item C-c @}
2364 Turn the coordinate grid in the table on and off.
2365 @end table
2366 @end table
2368 Making a table field blank does not remove the formula associated with
2369 the field, because that is stored in a different line (the @samp{TBLFM}
2370 line) - during the next recalculation the field will be filled again.
2371 To remove a formula from a field, you have to give an empty reply when
2372 prompted for the formula, or to edit the @samp{#+TBLFM} line.
2374 @kindex C-c C-c
2375 You may edit the @samp{#+TBLFM} directly and re-apply the changed
2376 equations with @kbd{C-c C-c} in that line, or with the normal
2377 recalculation commands in the table.
2379 @subsubheading Debugging formulas
2380 @cindex formula debugging
2381 @cindex debugging, of table formulas
2382 When the evaluation of a formula leads to an error, the field content
2383 becomes the string @samp{#ERROR}.  If you would like see what is going
2384 on during variable substitution and calculation in order to find a bug,
2385 turn on formula debugging in the @code{Tbl} menu and repeat the
2386 calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
2387 field.  Detailed information will be displayed.
2389 @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet
2390 @subsection Updating the table
2391 @cindex recomputing table fields
2392 @cindex updating, table
2394 Recalculation of a table is normally not automatic, but needs to be
2395 triggered by a command.  See @ref{Advanced features} for a way to make
2396 recalculation at least semi-automatically.
2398 In order to recalculate a line of a table or the entire table, use the
2399 following commands:
2401 @table @kbd
2402 @kindex C-c *
2403 @item C-c *
2404 Recalculate the current row by first applying the stored column formulas
2405 from left to right, and all field formulas in the current row.
2407 @kindex C-u C-c *
2408 @item C-u C-c *
2409 @kindex C-u C-c C-c
2410 @itemx C-u C-c C-c
2411 Recompute the entire table, line by line.  Any lines before the first
2412 hline are left alone, assuming that these are part of the table header.
2414 @kindex C-u C-u C-c *
2415 @kindex C-u C-u C-c C-c
2416 @item C-u C-u C-c *
2417 @itemx C-u C-u C-c C-c
2418 Iterate the table by recomputing it until no further changes occur.
2419 This may be necessary if some computed fields use the value of other
2420 fields that are computed @i{later} in the calculation sequence.
2421 @end table
2423 @node Advanced features,  , Updating the table, The spreadsheet
2424 @subsection Advanced features
2426 If you want the recalculation of fields to happen automatically, or if
2427 you want to be able to assign @i{names} to fields and columns, you need
2428 to reserve the first column of the table for special marking characters.
2429 @table @kbd
2430 @kindex C-#
2431 @item C-#
2432 Rotate the calculation mark in first column through the states @samp{},
2433 @samp{#}, @samp{*}, @samp{!}, @samp{$}.  When there is an active region,
2434 change all marks in the region.
2435 @end table
2437 Here is an example of a table that collects exam results of students and
2438 makes use of these features:
2440 @example
2441 @group
2442 |---+---------+--------+--------+--------+-------+------|
2443 |   | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
2444 |---+---------+--------+--------+--------+-------+------|
2445 | ! |         |     P1 |     P2 |     P3 |   Tot |      |
2446 | # | Maximum |     10 |     15 |     25 |    50 | 10.0 |
2447 | ^ |         |     m1 |     m2 |     m3 |    mt |      |
2448 |---+---------+--------+--------+--------+-------+------|
2449 | # | Peter   |     10 |      8 |     23 |    41 |  8.2 |
2450 | # | Sam     |      2 |      4 |      3 |     9 |  1.8 |
2451 |---+---------+--------+--------+--------+-------+------|
2452 |   | Average |        |        |        |  29.7 |      |
2453 | ^ |         |        |        |        |    at |      |
2454 | $ | max=50  |        |        |        |       |      |
2455 |---+---------+--------+--------+--------+-------+------|
2456 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
2457 @end group
2458 @end example
2460 @noindent @b{Important}: Please note that for these special tables,
2461 recalculating the table with @kbd{C-u C-c *} will only affect rows that
2462 are marked @samp{#} or @samp{*}, and fields that have a formula assigned
2463 to the field itself.  The column formulas are not applied in rows with
2464 empty first field.
2466 @cindex marking characters, tables
2467 The marking characters have the following meaning:
2468 @table @samp
2469 @item !
2470 The fields in this line define names for the columns, so that you may
2471 refer to a column as @samp{$Tot} instead of @samp{$6}.
2472 @item ^
2473 This row defines names for the fields @emph{above} the row.  With such
2474 a definition, any formula in the table may use @samp{$m1} to refer to
2475 the value @samp{10}.  Also, if you assign a formula to a names field, it
2476 will be stored as @samp{$name=...}.
2477 @item _
2478 Similar to @samp{^}, but defines names for the fields in the row
2479 @emph{below}.
2480 @item $
2481 Fields in this row can define @emph{parameters} for formulas.  For
2482 example, if a field in a @samp{$} row contains @samp{max=50}, then
2483 formulas in this table can refer to the value 50 using @samp{$max}.
2484 Parameters work exactly like constants, only that they can be defined on
2485 a per-table basis.
2486 @item #
2487 Fields in this row are automatically recalculated when pressing
2488 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row.  Also, this row
2489 is selected for a global recalculation with @kbd{C-u C-c *}.  Unmarked
2490 lines will be left alone by this command.
2491 @item *
2492 Selects this line for global recalculation with @kbd{C-u C-c *}, but
2493 not for automatic recalculation.  Use this when automatic
2494 recalculation slows down editing too much.
2495 @item
2496 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
2497 All lines that should be recalculated should be marked with @samp{#}
2498 or @samp{*}.
2499 @item /
2500 Do not export this line.  Useful for lines that contain the narrowing
2501 @samp{<N>} markers.
2502 @end table
2504 Finally, just to whet your appetite on what can be done with the
2505 fantastic @file{calc} package, here is a table that computes the Taylor
2506 series of degree @code{n} at location @code{x} for a couple of
2507 functions.
2509 @example
2510 @group
2511 |---+-------------+---+-----+--------------------------------------|
2512 |   | Func        | n | x   | Result                               |
2513 |---+-------------+---+-----+--------------------------------------|
2514 | # | exp(x)      | 1 | x   | 1 + x                                |
2515 | # | exp(x)      | 2 | x   | 1 + x + x^2 / 2                      |
2516 | # | exp(x)      | 3 | x   | 1 + x + x^2 / 2 + x^3 / 6            |
2517 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
2518 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2    |
2519 | * | tan(x)      | 3 | x   | 0.0175 x + 1.77e-6 x^3               |
2520 |---+-------------+---+-----+--------------------------------------|
2521 #+TBLFM: $5=taylor($2,$4,$3);n3
2522 @end group
2523 @end example
2525 @node Org Plot,  , The spreadsheet, Tables
2526 @section Org Plot
2527 @cindex graph, in tables
2528 @cindex plot tables using gnuplot
2530 Org Plot can produce 2D and 3D graphs of information stored in org tables
2531 using @file{Gnuplot} @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
2532 @uref{http://cars9.uchicago.edu/~ravel/software/gnuplot-mode.html}.  To see
2533 this in action ensure that you have both Gnuplot and Gnuplot-mode installed
2534 on your system, then call @code{org-plot/gnuplot} on the following table.
2536 @example
2537 @group
2538 #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
2539 | Sede      | Max cites | H-index |
2540 |-----------+-----------+---------|
2541 | Chile     |    257.72 |   21.39 |
2542 | Leeds     |    165.77 |   19.68 |
2543 | Sao Paolo |     71.00 |   11.50 |
2544 | Stockholm |    134.19 |   14.33 |
2545 | Morelia   |    257.56 |   17.67 |
2546 @end group
2547 @end example
2549 Notice that Org Plot is smart enough to apply the tables headers as labels.
2550 Further control over the labels, type, content, and appearance of plots can
2551 be exercised through the @code{#+Plot:} lines preceding a table.  See below
2552 for a complete list of Org plot options.  For more information and examples
2553 see the org-plot tutorial at
2554 @uref{http://orgmode.org/worg/org-tutorials/org-plot.php}.
2556 @subsubheading Plot Options
2558 @table @code
2559 @item set
2560 Specify any @file{gnuplot} option to be set when graphing.
2562 @item title
2563 Specify the title of the plot.
2565 @item ind
2566 Specify which column of the table to use as the @code{x} axis.
2568 @item deps
2569 Specify the columns to graph as a lisp style list, surrounded by parenthesis
2570 and separated by spaces for example @code{dep:(3 4)} to graph the third and
2571 fourth columns (defaults to graphing all other columns aside from the ind
2572 column).
2574 @item type
2575 Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
2577 @item with
2578 Specify a @code{with} option to be inserted for every col being plotted
2579 (e.g. @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
2580 Defaults to 'lines'.
2582 @item file
2583 If you want to plot to a file specify the @code{"path/to/desired/output-file"}.
2585 @item labels
2586 List of labels to be used for the deps (defaults to column headers if they
2587 exist).
2589 @item line
2590 Specify an entire line to be inserted in the gnuplot script.
2592 @item map
2593 When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
2594 flat mapping rather than a @code{3d} slope.
2596 @item timefmt
2597 Specify format of org-mode timestamps as they will be parsed by gnuplot.
2598 Defaults to '%Y-%m-%d-%H:%M:%S'.
2600 @item script
2601 If you want total control you can specify a script file (place the file name
2602 between double quotes) which will be used to plot.  Before plotting, every
2603 instance of @code{$datafile} in the specified script will be replaced with
2604 the path to the generated data file.  Note even if you set this option you
2605 may still want to specify the plot type, as that can impact the content of
2606 the data file.
2607 @end table
2609 @node Hyperlinks, TODO Items, Tables, Top
2610 @chapter Hyperlinks
2611 @cindex hyperlinks
2613 Like HTML, Org provides links inside a file, external links to
2614 other files, Usenet articles, emails, and much more.
2616 @menu
2617 * Link format::                 How links in Org are formatted
2618 * Internal links::              Links to other places in the current file
2619 * External links::              URL-like links to the world
2620 * Handling links::              Creating, inserting and following
2621 * Using links outside Org::     Linking from my C source code?
2622 * Link abbreviations::          Shortcuts for writing complex links
2623 * Search options::              Linking to a specific location
2624 * Custom searches::             When the default search is not enough
2625 @end menu
2627 @node Link format, Internal links, Hyperlinks, Hyperlinks
2628 @section Link format
2629 @cindex link format
2630 @cindex format, of links
2632 Org will recognize plain URL-like links and activate them as
2633 clickable links.  The general link format, however, looks like this:
2635 @example
2636 [[link][description]]       @r{or alternatively}           [[link]]
2637 @end example
2639 Once a link in the buffer is complete (all brackets present), Org
2640 will change the display so that @samp{description} is displayed instead
2641 of @samp{[[link][description]]} and @samp{link} is displayed instead of
2642 @samp{[[link]]}.  Links will be highlighted in the face @code{org-link},
2643 which by default is an underlined face.  You can directly edit the
2644 visible part of a link.  Note that this can be either the @samp{link}
2645 part (if there is no description) or the @samp{description} part.  To
2646 edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
2647 cursor on the link.
2649 If you place the cursor at the beginning or just behind the end of the
2650 displayed text and press @key{BACKSPACE}, you will remove the
2651 (invisible) bracket at that location.  This makes the link incomplete
2652 and the internals are again displayed as plain text.  Inserting the
2653 missing bracket hides the link internals again.  To show the
2654 internal structure of all links, use the menu entry
2655 @code{Org->Hyperlinks->Literal links}.
2657 @node Internal links, External links, Link format, Hyperlinks
2658 @section Internal links
2659 @cindex internal links
2660 @cindex links, internal
2661 @cindex targets, for links
2663 If the link does not look like a URL, it is considered to be internal in
2664 the current file.  Links such as @samp{[[My Target]]} or @samp{[[My
2665 Target][Find my target]]} lead to a text search in the current file.
2666 The link can be followed with @kbd{C-c C-o} when the cursor is on the
2667 link, or with a mouse click (@pxref{Handling links}).  The preferred
2668 match for such a link is a dedicated target: the same string in double
2669 angular brackets.  Targets may be located anywhere; sometimes it is
2670 convenient to put them into a comment line. For example
2672 @example
2673 # <<My Target>>
2674 @end example
2676 @noindent In HTML export (@pxref{HTML export}), such targets will become
2677 named anchors for direct access through @samp{http} links@footnote{Note that
2678 text before the first headline is usually not exported, so the first such
2679 target should be after the first headline, or in the line directly before the
2680 first headline.}.
2682 If no dedicated target exists, Org will search for the words in the
2683 link.  In the above example the search would be for @samp{my target}.
2684 Links starting with a star like @samp{*My Target} restrict the search to
2685 headlines.  When searching, Org mode will first try an exact match, but
2686 then move on to more and more lenient searches.  For example, the link
2687 @samp{[[*My Targets]]} will find any of the following:
2689 @example
2690 ** My targets
2691 ** TODO my targets are bright
2692 ** my 20 targets are
2693 @end example
2695 To insert a link targeting a headline, in-buffer completion can be used.
2696 Just type a star followed by a few optional letters into the buffer and
2697 press @kbd{M-@key{TAB}}.  All headlines in the current buffer will be
2698 offered as completions.  @xref{Handling links}, for more commands
2699 creating links.
2701 Following a link pushes a mark onto Org's own mark ring.  You can
2702 return to the previous position with @kbd{C-c &}.  Using this command
2703 several times in direct succession goes back to positions recorded
2704 earlier.
2706 @menu
2707 * Radio targets::               Make targets trigger links in plain text
2708 @end menu
2710 @node Radio targets,  , Internal links, Internal links
2711 @subsection Radio targets
2712 @cindex radio targets
2713 @cindex targets, radio
2714 @cindex links, radio targets
2716 Org can automatically turn any occurrences of certain target names
2717 in normal text into a link.  So without explicitly creating a link, the
2718 text connects to the target radioing its position.  Radio targets are
2719 enclosed by triple angular brackets.  For example, a target @samp{<<<My
2720 Target>>>} causes each occurrence of @samp{my target} in normal text to
2721 become activated as a link.  The Org file is scanned automatically
2722 for radio targets only when the file is first loaded into Emacs.  To
2723 update the target list during editing, press @kbd{C-c C-c} with the
2724 cursor on or at a target.
2726 @node External links, Handling links, Internal links, Hyperlinks
2727 @section External links
2728 @cindex links, external
2729 @cindex external links
2730 @cindex links, external
2731 @cindex Gnus links
2732 @cindex BBDB links
2733 @cindex IRC links
2734 @cindex URL links
2735 @cindex file links
2736 @cindex VM links
2737 @cindex RMAIL links
2738 @cindex WANDERLUST links
2739 @cindex MH-E links
2740 @cindex USENET links
2741 @cindex SHELL links
2742 @cindex Info links
2743 @cindex elisp links
2745 Org supports links to files, websites, Usenet and email messages,
2746 BBDB database entries and links to both IRC conversations and their
2747 logs.  External links are URL-like locators.  They start with a short
2748 identifying string followed by a colon.  There can be no space after
2749 the colon.  The following list shows examples for each link type.
2751 @example
2752 http://www.astro.uva.nl/~dominik          @r{on the web}
2753 file:/home/dominik/images/jupiter.jpg     @r{file, absolute path}
2754 /home/dominik/images/jupiter.jpg          @r{same as above}
2755 file:papers/last.pdf                      @r{file, relative path}
2756 ./papers/last.pdf                         @r{same as above}
2757 file:projects.org                         @r{another org file}
2758 file:projects.org::some words             @r{text search in org file}
2759 file:projects.org::*task title            @r{heading search in org file}
2760 id:B7423F4D-2E8A-471B-8810-C40F074717E9   @r{Link to heading by ID}
2761 news:comp.emacs                           @r{Usenet link}
2762 mailto:adent@@galaxy.net                   @r{Mail link}
2763 vm:folder                                 @r{VM folder link}
2764 vm:folder#id                              @r{VM message link}
2765 vm://myself@@some.where.org/folder#id      @r{VM on remote machine}
2766 wl:folder                                 @r{WANDERLUST folder link}
2767 wl:folder#id                              @r{WANDERLUST message link}
2768 mhe:folder                                @r{MH-E folder link}
2769 mhe:folder#id                             @r{MH-E message link}
2770 rmail:folder                              @r{RMAIL folder link}
2771 rmail:folder#id                           @r{RMAIL message link}
2772 gnus:group                                @r{Gnus group link}
2773 gnus:group#id                             @r{Gnus article link}
2774 bbdb:R.*Stallman                          @r{BBDB link (with regexp)}
2775 irc:/irc.com/#emacs/bob                   @r{IRC link}
2776 shell:ls *.org                            @r{A shell command}
2777 elisp:org-agenda                          @r{Interactive elisp command}
2778 elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
2779 @end example
2781 A link should be enclosed in double brackets and may contain a
2782 descriptive text to be displayed instead of the URL (@pxref{Link
2783 format}), for example:
2785 @example
2786 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
2787 @end example
2789 @noindent
2790 If the description is a file name or URL that points to an image, HTML
2791 export (@pxref{HTML export}) will inline the image as a clickable
2792 button.  If there is no description at all and the link points to an
2793 image,
2794 that image will be inlined into the exported HTML file.
2796 @cindex angular brackets, around links
2797 @cindex plain text external links
2798 Org also finds external links in the normal text and activates them
2799 as links.  If spaces must be part of the link (for example in
2800 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
2801 about the end of the link, enclose them in angular brackets.
2803 @node Handling links, Using links outside Org, External links, Hyperlinks
2804 @section Handling links
2805 @cindex links, handling
2807 Org provides methods to create a link in the correct syntax, to
2808 insert it into an Org file, and to follow the link.
2810 @table @kbd
2811 @kindex C-c l
2812 @cindex storing links
2813 @item C-c l
2814 Store a link to the current location.  This is a @emph{global} command (you
2815 must create the key binding yourself) which can be used in any buffer to
2816 create a link.  The link will be stored for later insertion into an Org
2817 buffer (see below).
2819 @vindex org-link-to-org-use-id
2820 For Org files, if there is a @samp{<<target>>} at the cursor, the link points
2821 to the target.  Otherwise it points to the current headline, either by text
2822 (unsafe), or, if @file{org-id.el} is loaded and @code{org-link-to-org-use-id}
2823 is set, by ID property.
2825 @vindex org-irc-link-to-logs
2826 For VM, Rmail, Wanderlust, MH-E, Gnus and BBDB buffers, the link will
2827 indicate the current article/entry.  For W3 and W3M buffers, the link goes to
2828 the current URL.  For IRC links, if you set the variable
2829 @code{org-irc-link-to-logs} to non-nil then @kbd{C-c l} will store a
2830 @samp{file:/} style link to the relevant point in the logs for the current
2831 conversation.  Otherwise an @samp{irc:/} style link to the user/channel/server
2832 under the point will be stored.
2834 For any other files, the link will point to the file, with a search string
2835 (@pxref{Search options}) pointing to the contents of the current line.  If
2836 there is an active region, the selected words will form the basis of the
2837 search string.  If the automatically created link is not working correctly or
2838 accurately enough, you can write custom functions to select the search string
2839 and to do the search for particular file types - see @ref{Custom searches}.
2840 The key binding @kbd{C-c l} is only a suggestion - see @ref{Installation}.
2842 @kindex C-c C-l
2843 @cindex link completion
2844 @cindex completion, of links
2845 @cindex inserting links
2846 @item C-c C-l
2847 @vindex org-keep-stored-link-after-insertion
2848 Insert a link.  This prompts for a link to be inserted into the buffer.  You
2849 can just type a link, using text for an internal link, or one of the link
2850 type prefixes mentioned in the examples above.  All links stored during the
2851 current session are part of the history for this prompt, so you can access
2852 them with @key{up} and @key{down} (or @kbd{M-p/n}).  Completion, on the other
2853 hand, will help you to insert valid link prefixes like @samp{http:} or
2854 @samp{ftp:}, including the prefixes defined through link abbreviations
2855 (@pxref{Link abbreviations}).  The link will be inserted into the
2856 buffer@footnote{After insertion of a stored link, the link will be removed
2857 from the list of stored links.  To keep it in the list later use, use a
2858 triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
2859 @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
2860 If some text was selected when this command is called, the selected text
2861 becomes the default description.@* Note that you don't have to use this
2862 command to insert a link.  Links in Org are plain text, and you can type
2863 or paste them straight into the buffer.  By using this command, the links are
2864 automatically enclosed in double brackets, and you will be asked for the
2865 optional descriptive text.
2867 @c  If the link is a @samp{file:} link and
2868 @c the linked file is located in the same directory as the current file or
2869 @c a subdirectory of it, the path of the file will be inserted relative to
2870 @c the current directory.
2872 @kindex C-u C-c C-l
2873 @cindex file name completion
2874 @cindex completion, of file names
2875 @item C-u C-c C-l
2876 When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
2877 a file will be inserted and you may use file name completion to select
2878 the name of the file.  The path to the file is inserted relative to the
2879 directory of the current org file, if the linked file is in the current
2880 directory or in a sub-directory of it, or if the path is written relative
2881 to the current directory using @samp{../}.  Otherwise an absolute path
2882 is used, if possible with @samp{~/} for your home directory.  You can
2883 force an absolute path with two @kbd{C-u} prefixes.
2885 @item C-c C-l @r{(with cursor on existing link)}
2886 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
2887 link and description parts of the link.
2889 @cindex following links
2890 @kindex C-c C-o
2891 @kindex RET
2892 @item C-c C-o @r{or} @key{RET}
2893 @vindex org-file-apps
2894 Open link at point.  This will launch a web browser for URLs (using
2895 @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
2896 the corresponding links, and execute the command in a shell link.  When the
2897 cursor is on an internal link, this commands runs the corresponding search.
2898 When the cursor is on a TAG list in a headline, it creates the corresponding
2899 TAGS view.  If the cursor is on a time stamp, it compiles the agenda for that
2900 date.  Furthermore, it will visit text and remote files in @samp{file:} links
2901 with Emacs and select a suitable application for local non-text files.
2902 Classification of files is based on file extension only.  See option
2903 @code{org-file-apps}.  If you want to override the default application and
2904 visit the file with Emacs, use a @kbd{C-u} prefix.  If you want to avoid
2905 opening in Emacs, use a @kbd{C-u C-u} prefix.
2907 @kindex mouse-2
2908 @kindex mouse-1
2909 @item mouse-2
2910 @itemx mouse-1
2911 On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
2912 would.  Under Emacs 22, also @kbd{mouse-1} will follow a link.
2914 @kindex mouse-3
2915 @item mouse-3
2916 @vindex org-display-internal-link-with-indirect-buffer
2917 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
2918 internal links to be displayed in another window@footnote{See the
2919 variable @code{org-display-internal-link-with-indirect-buffer}}.
2921 @cindex mark ring
2922 @kindex C-c %
2923 @item C-c %
2924 Push the current position onto the mark ring, to be able to return
2925 easily. Commands following an internal link do this automatically.
2927 @cindex links, returning to
2928 @kindex C-c &
2929 @item C-c &
2930 Jump back to a recorded position.  A position is recorded by the
2931 commands following internal links, and by @kbd{C-c %}.  Using this
2932 command several times in direct succession moves through a ring of
2933 previously recorded positions.
2935 @kindex C-c C-x C-n
2936 @kindex C-c C-x C-p
2937 @cindex links, finding next/previous
2938 @item C-c C-x C-n
2939 @itemx C-c C-x C-p
2940 Move forward/backward to the next link in the buffer.  At the limit of
2941 the buffer, the search fails once, and then wraps around.  The key
2942 bindings for this are really too long, you might want to bind this also
2943 to @kbd{C-n} and @kbd{C-p}
2944 @lisp
2945 (add-hook 'org-load-hook
2946   (lambda ()
2947     (define-key 'org-mode-map "\C-n" 'org-next-link)
2948     (define-key 'org-mode-map "\C-p" 'org-previous-link)))
2949 @end lisp
2950 @end table
2952 @node Using links outside Org, Link abbreviations, Handling links, Hyperlinks
2953 @section Using links outside Org
2955 You can insert and follow links that have Org syntax not only in
2956 Org, but in any Emacs buffer.  For this, you should create two
2957 global commands, like this (please select suitable global keys
2958 yourself):
2960 @lisp
2961 (global-set-key "\C-c L" 'org-insert-link-global)
2962 (global-set-key "\C-c o" 'org-open-at-point-global)
2963 @end lisp
2965 @node Link abbreviations, Search options, Using links outside Org, Hyperlinks
2966 @section Link abbreviations
2967 @cindex link abbreviations
2968 @cindex abbreviation, links
2970 Long URLs can be cumbersome to type, and often many similar links are
2971 needed in a document.  For this you can use link abbreviations.  An
2972 abbreviated link looks like this
2974 @example
2975 [[linkword:tag][description]]
2976 @end example
2978 @noindent
2979 @vindex org-link-abbrev-alist
2980 where the tag is optional.  The @i{linkword} must be a word; letter, numbers,
2981 @samp{-}, and @samp{_} are allowed here.  Abbreviations are resolved
2982 according to the information in the variable @code{org-link-abbrev-alist}
2983 that relates the linkwords to replacement text.  Here is an example:
2985 @lisp
2986 @group
2987 (setq org-link-abbrev-alist
2988   '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
2989     ("google"   . "http://www.google.com/search?q=")
2990     ("ads"      . "http://adsabs.harvard.edu/cgi-bin/
2991                    nph-abs_connect?author=%s&db_key=AST")))
2992 @end group
2993 @end lisp
2995 If the replacement text contains the string @samp{%s}, it will be
2996 replaced with the tag.  Otherwise the tag will be appended to the string
2997 in order to create the link.  You may also specify a function that will
2998 be called with the tag as the only argument to create the link.
3000 With the above setting, you could link to a specific bug with
3001 @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
3002 @code{[[google:OrgMode]]} and find out what the Org author is
3003 doing besides Emacs hacking with @code{[[ads:Dominik,C]]}.
3005 If you need special abbreviations just for a single Org buffer, you
3006 can define them in the file with
3008 @example
3009 #+LINK: bugzilla  http://10.1.2.9/bugzilla/show_bug.cgi?id=
3010 #+LINK: google    http://www.google.com/search?q=%s
3011 @end example
3013 @noindent
3014 In-buffer completion @pxref{Completion} can be used after @samp{[} to
3015 complete link abbreviations.
3017 @node Search options, Custom searches, Link abbreviations, Hyperlinks
3018 @section Search options in file links
3019 @cindex search option in file links
3020 @cindex file links, searching
3022 File links can contain additional information to make Emacs jump to a
3023 particular location in the file when following a link.  This can be a
3024 line number or a search option after a double@footnote{For backward
3025 compatibility, line numbers can also follow a single colon.} colon. For
3026 example, when the command @kbd{C-c l} creates a link (@pxref{Handling
3027 links}) to a file, it encodes the words in the current line as a search
3028 string that can be used to find this line back later when following the
3029 link with @kbd{C-c C-o}.
3031 Here is the syntax of the different ways to attach a search to a file
3032 link, together with an explanation:
3034 @example
3035 [[file:~/code/main.c::255]]
3036 [[file:~/xx.org::My Target]]
3037 [[file:~/xx.org::*My Target]]
3038 [[file:~/xx.org::/regexp/]]
3039 @end example
3041 @table @code
3042 @item 255
3043 Jump to line 255.
3044 @item My Target
3045 Search for a link target @samp{<<My Target>>}, or do a text search for
3046 @samp{my target}, similar to the search in internal links, see
3047 @ref{Internal links}.  In HTML export (@pxref{HTML export}), such a file
3048 link will become an HTML reference to the corresponding named anchor in
3049 the linked file.
3050 @item *My Target
3051 In an Org file, restrict search to headlines.
3052 @item /regexp/
3053 Do a regular expression search for @code{regexp}.  This uses the Emacs
3054 command @code{occur} to list all matches in a separate window.  If the
3055 target file is in Org mode, @code{org-occur} is used to create a
3056 sparse tree with the matches.
3057 @c If the target file is a directory,
3058 @c @code{grep} will be used to search all files in the directory.
3059 @end table
3061 As a degenerate case, a file link with an empty file name can be used
3062 to search the current file.  For example, @code{[[file:::find me]]} does
3063 a search for @samp{find me} in the current file, just as
3064 @samp{[[find me]]} would.
3066 @node Custom searches,  , Search options, Hyperlinks
3067 @section Custom Searches
3068 @cindex custom search strings
3069 @cindex search strings, custom
3071 The default mechanism for creating search strings and for doing the
3072 actual search related to a file link may not work correctly in all
3073 cases.  For example, BibTeX database files have many entries like
3074 @samp{year="1993"} which would not result in good search strings,
3075 because the only unique identification for a BibTeX entry is the
3076 citation key.
3078 @vindex org-create-file-search-functions
3079 @vindex org-execute-file-search-functions
3080 If you come across such a problem, you can write custom functions to set
3081 the right search string for a particular file type, and to do the search
3082 for the string in the file.  Using @code{add-hook}, these functions need
3083 to be added to the hook variables
3084 @code{org-create-file-search-functions} and
3085 @code{org-execute-file-search-functions}.  See the docstring for these
3086 variables for more information.  Org actually uses this mechanism
3087 for Bib@TeX{} database files, and you can use the corresponding code as
3088 an implementation example.  See the file @file{org-bibtex.el}.
3090 @node TODO Items, Tags, Hyperlinks, Top
3091 @chapter TODO Items
3092 @cindex TODO items
3094 Org mode does not maintain TODO lists as separate documents@footnote{Of
3095 course, you can make a document that contains only long lists of TODO items,
3096 but this is not required.}.  Instead, TODO items are an integral part of the
3097 notes file, because TODO items usually come up while taking notes!  With Org
3098 mode, simply mark any entry in a tree as being a TODO item.  In this way,
3099 information is not duplicated, and the entire context from which the TODO
3100 item emerged is always present.
3102 Of course, this technique for managing TODO items scatters them
3103 throughout your notes file.  Org mode compensates for this by providing
3104 methods to give you an overview of all the things that you have to do.
3106 @menu
3107 * TODO basics::                 Marking and displaying TODO entries
3108 * TODO extensions::             Workflow and assignments
3109 * Progress logging::            Dates and notes for progress
3110 * Priorities::                  Some things are more important than others
3111 * Breaking down tasks::         Splitting a task into manageable pieces
3112 * Checkboxes::                  Tick-off lists
3113 @end menu
3115 @node TODO basics, TODO extensions, TODO Items, TODO Items
3116 @section Basic TODO functionality
3118 Any headline becomes a TODO item when it starts with the word
3119 @samp{TODO}, for example:
3121 @example
3122 *** TODO Write letter to Sam Fortune
3123 @end example
3125 @noindent
3126 The most important commands to work with TODO entries are:
3128 @table @kbd
3129 @kindex C-c C-t
3130 @cindex cycling, of TODO states
3131 @item C-c C-t
3132 Rotate the TODO state of the current item among
3134 @example
3135 ,-> (unmarked) -> TODO -> DONE --.
3136 '--------------------------------'
3137 @end example
3139 The same rotation can also be done ``remotely'' from the timeline and
3140 agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}).
3142 @kindex C-u C-c C-t
3143 @item C-u C-c C-t
3144 Select a specific keyword using completion or (if it has been set up)
3145 the fast selection interface.  For the latter, you need to assign keys
3146 to TODO states, see @ref{Per-file keywords} and @ref{Setting tags} for
3147 more information.
3149 @kindex S-@key{right}
3150 @kindex S-@key{left}
3151 @item S-@key{right}
3152 @itemx S-@key{left}
3153 Select the following/preceding TODO state, similar to cycling.  Useful
3154 mostly if more than two TODO states are possible (@pxref{TODO
3155 extensions}).  See also @ref{Conflicts} for a discussion of the interaction
3156 with @code{shift-selection-mode}.
3157 @kindex C-c C-v
3158 @kindex C-c / t
3159 @cindex sparse tree, for TODO
3160 @item C-c C-v
3161 @itemx C-c / t
3162 @vindex org-todo-keywords
3163 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}).  Folds the
3164 entire buffer, but shows all TODO items and the headings hierarchy above
3165 them.  With a prefix argument, search for a specific TODO.  You will be
3166 prompted for the keyword, and you can also give a list of keywords like
3167 @code{KWD1|KWD2|...} to list entries that match any one of these keywords.
3168 With numeric prefix argument N, show the tree for the Nth keyword in the
3169 variable @code{org-todo-keywords}.  With two prefix arguments, find all TODO
3170 and DONE entries.
3171 @kindex C-c a t
3172 @item C-c a t
3173 Show the global TODO list.  Collects the TODO items from all agenda
3174 files (@pxref{Agenda Views}) into a single buffer.  The new buffer will
3175 be in @code{agenda-mode}, which provides commands to examine and
3176 manipulate the TODO entries from the new buffer (@pxref{Agenda
3177 commands}).  @xref{Global TODO list}, for more information.
3178 @kindex S-M-@key{RET}
3179 @item S-M-@key{RET}
3180 Insert a new TODO entry below the current one.
3181 @end table
3183 @noindent
3184 @vindex org-todo-state-tags-triggers
3185 Changing a TODO state can also trigger tag changes.  See the docstring of the
3186 option @code{org-todo-state-tags-triggers} for details.
3188 @node TODO extensions, Progress logging, TODO basics, TODO Items
3189 @section Extended use of TODO keywords
3190 @cindex extended TODO keywords
3192 @vindex org-todo-keywords
3193 By default, marked TODO entries have one of only two states: TODO and
3194 DONE.  Org mode allows you to classify TODO items in more complex ways
3195 with @emph{TODO keywords} (stored in @code{org-todo-keywords}).  With
3196 special setup, the TODO keyword system can work differently in different
3197 files.
3199 Note that @i{tags} are another way to classify headlines in general and
3200 TODO items in particular (@pxref{Tags}).
3202 @menu
3203 * Workflow states::             From TODO to DONE in steps
3204 * TODO types::                  I do this, Fred does the rest
3205 * Multiple sets in one file::   Mixing it all, and still finding your way
3206 * Fast access to TODO states::  Single letter selection of a state
3207 * Per-file keywords::           Different files, different requirements
3208 * Faces for TODO keywords::     Highlighting states
3209 * TODO dependencies::           When one task needs to wait for others
3210 @end menu
3212 @node Workflow states, TODO types, TODO extensions, TODO extensions
3213 @subsection TODO keywords as workflow states
3214 @cindex TODO workflow
3215 @cindex workflow states as TODO keywords
3217 You can use TODO keywords to indicate different @emph{sequential} states
3218 in the process of working on an item, for example@footnote{Changing
3219 this variable only becomes effective after restarting Org mode in a
3220 buffer.}:
3222 @lisp
3223 (setq org-todo-keywords
3224   '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
3225 @end lisp
3227 The vertical bar separates the TODO keywords (states that @emph{need
3228 action}) from the DONE states (which need @emph{no further action}).  If
3229 you don't provide the separator bar, the last state is used as the DONE
3230 state.
3231 @cindex completion, of TODO keywords
3232 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
3233 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED.  You may
3234 also use a numeric prefix argument to quickly select a specific state.  For
3235 example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY.
3236 Or you can use @kbd{S-left} to go backward through the sequence.  If you
3237 define many keywords, you can use in-buffer completion
3238 (@pxref{Completion}) or even a special one-key selection scheme
3239 (@pxref{Fast access to TODO states}) to insert these words into the
3240 buffer.  Changing a TODO state can be logged with a timestamp, see
3241 @ref{Tracking TODO state changes} for more information.
3243 @node TODO types, Multiple sets in one file, Workflow states, TODO extensions
3244 @subsection TODO keywords as types
3245 @cindex TODO types
3246 @cindex names as TODO keywords
3247 @cindex types as TODO keywords
3249 The second possibility is to use TODO keywords to indicate different
3250 @emph{types} of action items.  For example, you might want to indicate
3251 that items are for ``work'' or ``home''.  Or, when you work with several
3252 people on a single project, you might want to assign action items
3253 directly to persons, by using their names as TODO keywords.  This would
3254 be set up like this:
3256 @lisp
3257 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
3258 @end lisp
3260 In this case, different keywords do not indicate a sequence, but rather
3261 different types.  So the normal work flow would be to assign a task to a
3262 person, and later to mark it DONE.  Org mode supports this style by adapting
3263 the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
3264 @kbd{t} command in the timeline and agenda buffers.}.  When used several
3265 times in succession, it will still cycle through all names, in order to first
3266 select the right type for a task.  But when you return to the item after some
3267 time and execute @kbd{C-c C-t} again, it will switch from any name directly
3268 to DONE.  Use prefix arguments or completion to quickly select a specific
3269 name.  You can also review the items of a specific TODO type in a sparse tree
3270 by using a numeric prefix to @kbd{C-c C-v}.  For example, to see all things
3271 Lucy has to do, you would use @kbd{C-3 C-c C-v}.  To collect Lucy's items
3272 from all agenda files into a single buffer, you would use the numeric prefix
3273 argument as well when creating the global TODO list: @kbd{C-3 C-c t}.
3275 @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions
3276 @subsection Multiple keyword sets in one file
3277 @cindex TODO keyword sets
3279 Sometimes you may want to use different sets of TODO keywords in
3280 parallel.  For example, you may want to have the basic
3281 @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
3282 separate state indicating that an item has been canceled (so it is not
3283 DONE, but also does not require action).  Your setup would then look
3284 like this:
3286 @lisp
3287 (setq org-todo-keywords
3288       '((sequence "TODO" "|" "DONE")
3289         (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
3290         (sequence "|" "CANCELED")))
3291 @end lisp
3293 The keywords should all be different, this helps Org mode to keep track
3294 of which subsequence should be used for a given entry.  In this setup,
3295 @kbd{C-c C-t} only operates within a subsequence, so it switches from
3296 @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
3297 (nothing) to @code{REPORT}.  Therefore you need a mechanism to initially
3298 select the correct sequence.  Besides the obvious ways like typing a
3299 keyword or using completion, you may also apply the following commands:
3301 @table @kbd
3302 @kindex C-S-@key{right}
3303 @kindex C-S-@key{left}
3304 @kindex C-u C-u C-c C-t
3305 @item C-u C-u C-c C-t
3306 @itemx C-S-@key{right}
3307 @itemx C-S-@key{left}
3308 These keys jump from one TODO subset to the next.  In the above example,
3309 @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{right}} would jump from @code{TODO} or
3310 @code{DONE} to @code{REPORT}, and any of the words in the second row to
3311 @code{CANCELED}.  Note that the @kbd{C-S-} key binding conflict with
3312 @code{shift-selection-mode} (@pxref{Conflicts}).
3313 @kindex S-@key{right}
3314 @kindex S-@key{left}
3315 @item S-@key{right}
3316 @itemx S-@key{left}
3317 @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through @emph{all}
3318 keywords from all sets, so for example @kbd{S-@key{<right>}} would switch
3319 from @code{DONE} to @code{REPORT} in the example above.  See also
3320 @ref{Conflicts} for a discussion of the interaction with
3321 @code{shift-selection-mode}.
3322 @end table
3324 @node Fast access to TODO states, Per-file keywords, Multiple sets in one file, TODO extensions
3325 @subsection Fast access to TODO states
3327 If you would like to quickly change an entry to an arbitrary TODO state
3328 instead of cycling through the states, you can set up keys for
3329 single-letter access to the states.  This is done by adding the section
3330 key after each keyword, in parenthesis.  For example:
3332 @lisp
3333 (setq org-todo-keywords
3334       '((sequence "TODO(t)" "|" "DONE(d)")
3335         (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
3336         (sequence "|" "CANCELED(c)")))
3337 @end lisp
3339 @vindex org-fast-tag-selection-include-todo
3340 If you then press @code{C-c C-t} followed by the selection key, the entry
3341 will be switched to this state.  @key{SPC} can be used to remove any TODO
3342 keyword from an entry.@footnote{Check also the variable
3343 @code{org-fast-tag-selection-include-todo}, it allows to change the TODO
3344 state through the tags interface (@pxref{Setting tags}), in case you like to
3345 mingle the two concepts.  Note that this means you need to come up with
3346 unique keys across both sets of keywords.}
3348 @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions
3349 @subsection Setting up keywords for individual files
3350 @cindex keyword options
3351 @cindex per-file keywords
3353 It can be very useful to use different aspects of the TODO mechanism in
3354 different files.  For file-local settings, you need to add special lines
3355 to the file which set the keywords and interpretation for that file
3356 only.  For example, to set one of the two examples discussed above, you
3357 need one of the following lines, starting in column zero anywhere in the
3358 file:
3360 @example
3361 #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
3362 @end example
3363 @noindent (you may also write @code{#+SEQ_TODO} to be explicit about the
3364 interpretation, but it means the same as @code{#+TODO}), or
3365 @example
3366 #+TYP_TODO: Fred Sara Lucy Mike | DONE
3367 @end example
3369 A setup for using several sets in parallel would be:
3371 @example
3372 #+TODO: TODO | DONE
3373 #+TODO: REPORT BUG KNOWNCAUSE | FIXED
3374 #+TODO: | CANCELED
3375 @end example
3377 @cindex completion, of option keywords
3378 @kindex M-@key{TAB}
3379 @noindent To make sure you are using the correct keyword, type
3380 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
3382 @cindex DONE, final TODO keyword
3383 Remember that the keywords after the vertical bar (or the last keyword
3384 if no bar is there) must always mean that the item is DONE (although you
3385 may use a different word).  After changing one of these lines, use
3386 @kbd{C-c C-c} with the cursor still in the line to make the changes
3387 known to Org mode@footnote{Org mode parses these lines only when
3388 Org mode is activated after visiting a file.  @kbd{C-c C-c} with the
3389 cursor in a line starting with @samp{#+} is simply restarting Org mode
3390 for the current buffer.}.
3392 @node Faces for TODO keywords, TODO dependencies, Per-file keywords, TODO extensions
3393 @subsection Faces for TODO keywords
3394 @cindex faces, for TODO keywords
3396 @vindex org-todo @r{(face)}
3397 @vindex org-done @r{(face)}
3398 @vindex org-todo-keyword-faces
3399 Org mode highlights TODO keywords with special faces: @code{org-todo}
3400 for keywords indicating that an item still has to be acted upon, and
3401 @code{org-done} for keywords indicating that an item is finished.  If
3402 you are using more than 2 different states, you might want to use
3403 special faces for some of them.  This can be done using the variable
3404 @code{org-todo-keyword-faces}.  For example:
3406 @lisp
3407 @group
3408 (setq org-todo-keyword-faces
3409       '(("TODO"      . org-warning)
3410         ("DEFERRED"  . shadow)
3411         ("CANCELED"  . (:foreground "blue" :weight bold))))
3412 @end group
3413 @end lisp
3415 While using a list with face properties as shown for CANCELED
3416 @emph{should} work, this does not aways seem to be the case.  If
3417 necessary, define a special face and use that.
3419 @node TODO dependencies,  , Faces for TODO keywords, TODO extensions
3420 @subsection TODO dependencies
3421 @cindex TODO dependencies
3422 @cindex dependencies, of TODO states
3424 @vindex org-enforce-todo-dependencies
3425 The structure of Org files (hierarchy and lists) makes it easy to define TODO
3426 dependencies.  Usually, a parent TODO task should not be marked DONE until
3427 all subtasks (defined as children tasks) are marked as DONE.  And sometimes
3428 there is a logical sequence to a number of (sub)tasks, so that one task
3429 cannot be acted upon before all siblings above it are done.  If you customize
3430 the variable @code{org-enforce-todo-dependencies}, Org will block entries
3431 from changing state to DONE while they have children that are not DONE.
3432 Furthermore, if an entry has a property @code{ORDERED}, each of its children
3433 will be blocked until all earlier siblings are marked DONE.  Here is an
3434 example:
3436 @example
3437 * TODO Blocked until (two) is done
3438 ** DONE one
3439 ** TODO two
3441 * Parent
3442   :PROPERTIES:
3443     :ORDERED: t
3444   :END:
3445 ** TODO a
3446 ** TODO b, needs to wait for (a)
3447 ** TODO c, needs to wait for (a) and (b)
3448 @end example
3450 @table @kbd
3451 @kindex C-c C-x o
3452 @item C-c C-x o
3453 @vindex org-track-ordered-property-with-tag
3454 Toggle the @code{ORDERED} property of the current entry.  A property is used
3455 for this behavior because this should be local to the current entry, not
3456 inherited like a tag.  However, if you would like to @i{track} the value of
3457 this property with a tag for better visibility, customize the variable
3458 @code{org-track-ordered-property-with-tag}.
3459 @kindex C-u C-u C-u C-c C-t
3460 @item C-u C-u C-u C-c C-t
3461 Change TODO state, circumventin any state blocking.
3462 @end table
3464 @vindex org-agenda-dim-blocked-tasks
3465 If you set the variable @code{org-agenda-dim-blocked-tasks}, TODO entries
3466 that cannot be closed because of such dependencies will be shown in a dimmed
3467 font or even made invisible in agenda views (@pxref{Agenda Views}).
3469 @cindex checkboxes and TODO dependencies
3470 @vindex org-enforce-todo-dependencies
3471 You can also block changes of TODO states by looking at checkboxes
3472 (@pxref{Checkboxes}).  If you set the variable
3473 @code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked
3474 checkboxes will be blocked from switching to DONE.
3476 If you need more complex dependency structures, for example dependencies
3477 between entries in different trees or files, check out the contributed
3478 module @file{org-depend.el}.
3480 @page
3481 @node Progress logging, Priorities, TODO extensions, TODO Items
3482 @section Progress logging
3483 @cindex progress logging
3484 @cindex logging, of progress
3486 Org mode can automatically record a time stamp and possibly a note when
3487 you mark a TODO item as DONE, or even each time you change the state of
3488 a TODO item.  This system is highly configurable, settings can be on a
3489 per-keyword basis and can be localized to a file or even a subtree.  For
3490 information on how to clock working time for a task, see @ref{Clocking
3491 work time}.
3493 @menu
3494 * Closing items::               When was this entry marked DONE?
3495 * Tracking TODO state changes::  When did the status change?
3496 @end menu
3498 @node Closing items, Tracking TODO state changes, Progress logging, Progress logging
3499 @subsection Closing items
3501 The most basic logging is to keep track of @emph{when} a certain TODO
3502 item was finished.  This is achieved with@footnote{The corresponding
3503 in-buffer setting is: @code{#+STARTUP: logdone}}.
3505 @lisp
3506 (setq org-log-done 'time)
3507 @end lisp
3509 @noindent
3510 Then each time you turn an entry from a TODO (not-done) state into any
3511 of the DONE states, a line @samp{CLOSED: [timestamp]} will be inserted
3512 just after the headline.  If you turn the entry back into a TODO item
3513 through further state cycling, that line will be removed again.  If you
3514 want to record a note along with the timestamp, use@footnote{The
3515 corresponding in-buffer setting is: @code{#+STARTUP: lognotedone}}
3517 @lisp
3518 (setq org-log-done 'note)
3519 @end lisp
3521 @noindent
3522 You will then be prompted for a note, and that note will be stored below
3523 the entry with a @samp{Closing Note} heading.
3525 In the timeline (@pxref{Timeline}) and in the agenda
3526 (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
3527 display the TODO items with a @samp{CLOSED} timestamp on each day,
3528 giving you an overview of what has been done.
3530 @node Tracking TODO state changes,  , Closing items, Progress logging
3531 @subsection Tracking TODO state changes
3532 @cindex drawer, for state change recording
3534 @vindex org-log-states-order-reversed
3535 @vindex org-log-state-notes-into-drawer
3536 When TODO keywords are used as workflow states (@pxref{Workflow states}), you
3537 might want to keep track of when a state change occurred and maybe take a
3538 note about this change.  You can either record just a timestamp, or a
3539 timestamped note for a change.  These records will be inserted after the
3540 headline as an itemized list, newest first@footnote{See the variable
3541 @code{org-log-states-order-reversed}}.  When taking a lot of notes, you might
3542 want to get the notes out of a way into a drawer (@pxref{Drawers}).
3543 Customize the variable @code{org-log-state-notes-into-drawer} to get this
3544 behavior - the recommended drawer for this is called @code{LOGBOOK}.
3546 Since it is normally too much to record a note for every state, Org mode
3547 expects configuration on a per-keyword basis for this.  This is achieved by
3548 adding special markers @samp{!} (for a time stamp) and @samp{@@} (for a note)
3549 in parenthesis after each keyword.  For example, with the setting
3551 @lisp
3552 (setq org-todo-keywords
3553   '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
3554 @end lisp
3556 @noindent
3557 @vindex org-log-done
3558 you not only define global TODO keywords and fast access keys, but also
3559 request that a time is recorded when the entry is turned into
3560 DONE@footnote{It is possible that Org mode will record two time stamps
3561 when you are using both @code{org-log-done} and state change logging.
3562 However, it will never prompt for two notes - if you have configured
3563 both, the state change recording note will take precedence and cancel
3564 the @samp{Closing Note}.}, and that a note is recorded when switching to
3565 WAIT or CANCELED.  The setting for WAIT is even more special: The
3566 @samp{!} after the slash means that in addition to the note taken when
3567 entering the state, a time stamp should be recorded when @i{leaving} the
3568 WAIT state, if and only if the @i{target} state does not configure
3569 logging for entering it.  So it has no effect when switching from WAIT
3570 to DONE, because DONE is configured to record a timestamp only.  But
3571 when switching from WAIT back to TODO, the @samp{/!} in the WAIT
3572 setting now triggers a timestamp even though TODO has no logging
3573 configured.
3575 You can use the exact same syntax for setting logging preferences local
3576 to a buffer:
3577 @example
3578 #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
3579 @end example
3581 In order to define logging settings that are local to a subtree or a
3582 single item, define a LOGGING property in this entry.  Any non-empty
3583 LOGGING property resets all logging settings to nil.  You may then turn
3584 on logging for this specific tree using STARTUP keywords like
3585 @code{lognotedone} or @code{logrepeat}, as well as adding state specific
3586 settings like @code{TODO(!)}.  For example
3588 @example
3589 * TODO Log each state with only a time
3590   :PROPERTIES:
3591   :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
3592   :END:
3593 * TODO Only log when switching to WAIT, and when repeating
3594   :PROPERTIES:
3595   :LOGGING: WAIT(@@) logrepeat
3596   :END:
3597 * TODO No logging at all
3598   :PROPERTIES:
3599   :LOGGING: nil
3600   :END:
3601 @end example
3603 @node Priorities, Breaking down tasks, Progress logging, TODO Items
3604 @section Priorities
3605 @cindex priorities
3607 If you use Org mode extensively, you may end up enough TODO items that
3608 it starts to make sense to prioritize them.  Prioritizing can be done by
3609 placing a @emph{priority cookie} into the headline of a TODO item, like
3610 this
3612 @example
3613 *** TODO [#A] Write letter to Sam Fortune
3614 @end example
3616 @noindent
3617 By default, Org mode supports three priorities: @samp{A}, @samp{B}, and
3618 @samp{C}.  @samp{A} is the highest priority.  An entry without a cookie
3619 is treated as priority @samp{B}.  Priorities make a difference only in
3620 the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they have
3621 no inherent meaning to Org mode.
3623 Priorities can be attached to any outline tree entries; they do not need
3624 to be TODO items.
3626 @table @kbd
3627 @kindex @kbd{C-c ,}
3628 @item @kbd{C-c ,}
3629 Set the priority of the current headline.  The command prompts for a
3630 priority character @samp{A}, @samp{B} or @samp{C}.  When you press
3631 @key{SPC} instead, the priority cookie is removed from the headline.
3632 The priorities can also be changed ``remotely'' from the timeline and
3633 agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
3635 @kindex S-@key{up}
3636 @kindex S-@key{down}
3637 @item S-@key{up}
3638 @itemx S-@key{down}
3639 @vindex org-priority-start-cycle-with-default
3640 Increase/decrease priority of current headline@footnote{See also the option
3641 @code{org-priority-start-cycle-with-default}.}.  Note that these keys are
3642 also used to modify time stamps (@pxref{Creating timestamps}).  See also
3643 @ref{Conflicts} for a discussion of the interaction with
3644 @code{shift-selection-mode}.
3645 @end table
3647 @vindex org-highest-priority
3648 @vindex org-lowest-priority
3649 @vindex org-default-priority
3650 You can change the range of allowed priorities by setting the variables
3651 @code{org-highest-priority}, @code{org-lowest-priority}, and
3652 @code{org-default-priority}.  For an individual buffer, you may set
3653 these values (highest, lowest, default) like this (please make sure that
3654 the highest priority is earlier in the alphabet than the lowest
3655 priority):
3657 @example
3658 #+PRIORITIES: A C B
3659 @end example
3661 @node Breaking down tasks, Checkboxes, Priorities, TODO Items
3662 @section Breaking tasks down into subtasks
3663 @cindex tasks, breaking down
3665 @vindex org-agenda-todo-list-sublevels
3666 It is often advisable to break down large tasks into smaller, manageable
3667 subtasks.  You can do this by creating an outline tree below a TODO item,
3668 with detailed subtasks on the tree@footnote{To keep subtasks out of the
3669 global TODO list, see the @code{org-agenda-todo-list-sublevels}.}.  To keep
3670 the overview over the fraction of subtasks that are already completed, insert
3671 either @samp{[/]} or @samp{[%]} anywhere in the headline.  These cookies will
3672 be updates each time the todo status of a child changes.  For example:
3674 @example
3675 * Organize Party [33%]
3676 ** TODO Call people [1/2]
3677 *** TODO Peter
3678 *** DONE Sarah
3679 ** TODO Buy food
3680 ** DONE Talk to neighbor
3681 @end example
3683 If you would like a TODO entry to automatically change to DONE when all
3684 children are done, you can use the following setup:
3686 @example
3687 (defun org-summary-todo (n-done n-not-done)
3688   "Switch entry to DONE when all subentries are done, to TODO otherwise."
3689   (let (org-log-done org-log-states)   ; turn off logging
3690     (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
3692 (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
3693 @end example
3696 Another possibility is the use of checkboxes to identify (a hierarchy of) a
3697 large number of subtasks (@pxref{Checkboxes}).
3700 @node Checkboxes,  , Breaking down tasks, TODO Items
3701 @section Checkboxes
3702 @cindex checkboxes
3704 Every item in a plain list (@pxref{Plain lists}) can be made into a
3705 checkbox by starting it with the string @samp{[ ]}.  This feature is
3706 similar to TODO items (@pxref{TODO Items}), but is more lightweight.
3707 Checkboxes are not included into the global TODO list, so they are often
3708 great to split a task into a number of simple steps.  Or you can use
3709 them in a shopping list.  To toggle a checkbox, use @kbd{C-c C-c}, or
3710 use the mouse (thanks to Piotr Zielinski's @file{org-mouse.el}).
3712 Here is an example of a checkbox list.
3714 @example
3715 * TODO Organize party [2/4]
3716   - [-] call people [1/3]
3717     - [ ] Peter
3718     - [X] Sarah
3719     - [ ] Sam
3720   - [X] order food
3721   - [ ] think about what music to play
3722   - [X] talk to the neighbors
3723 @end example
3725 Checkboxes work hierarchically, so if a checkbox item has children that
3726 are checkboxes, toggling one of the children checkboxes will make the
3727 parent checkbox reflect if none, some, or all of the children are
3728 checked.
3730 @cindex statistics, for checkboxes
3731 @cindex checkbox statistics
3732 The @samp{[2/4]} and @samp{[1/3]} in the first and second line are
3733 cookies indicating how many checkboxes present in this entry have been
3734 checked off, and the total number of checkboxes are present.  This can
3735 give you an idea on how many checkboxes remain, even without opening a
3736 folded entry.  The cookies can be placed into a headline or into (the
3737 first line of) a plain list item. Each cookie covers all checkboxes
3738 structurally below the headline/item on which the cookie appear.  You
3739 have to insert the cookie yourself by typing either @samp{[/]} or
3740 @samp{[%]}.  With @samp{[/]} you get an @samp{n out of m} result, as in
3741 the examples above.  With @samp{[%]} you get information about the
3742 percentage of checkboxes checked (in the above example, this would be
3743 @samp{[50%]} and @samp{[33%]}, respectively).
3745 @cindex blocking, of checkboxes
3746 @cindex checkbox blocking
3747 If the current outline node has an @code{ORDERED} property, checkboxes must
3748 be checked off in sequence, and an error will be thrown if you try to check
3749 off a box while there are unchecked boxes bove it.
3751 @noindent The following commands work with checkboxes:
3753 @table @kbd
3754 @kindex C-c C-c
3755 @item C-c C-c
3756 Toggle checkbox status or (with prefix arg) checkbox presence at point.  With
3757 double prefix argument, set it to @samp{[-]}, which is considered to be an
3758 intermediate state.
3759 @kindex C-c C-x C-b
3760 @item C-c C-x C-b
3761 Toggle checkbox status or (with prefix arg) checkbox presence at point.  With
3762 double prefix argument, set it to @samp{[-]}, which is considered to be an
3763 intermediate state.
3764 @itemize @minus
3765 @item
3766 If there is an active region, toggle the first checkbox in the region
3767 and set all remaining boxes to the same status as the first.  With a prefix
3768 arg, add or remove the checkbox for all items in the region.
3769 @item
3770 If the cursor is in a headline, toggle checkboxes in the region between
3771 this headline and the next (so @emph{not} the entire subtree).
3772 @item
3773 If there is no active region, just toggle the checkbox at point.
3774 @end itemize
3775 @kindex M-S-@key{RET}
3776 @item M-S-@key{RET}
3777 Insert a new item with a checkbox.
3778 This works only if the cursor is already in a plain list item
3779 (@pxref{Plain lists}).
3780 @kindex C-c C-x o
3781 @item C-c C-x o
3782 @vindex org-track-ordered-property-with-tag
3783 Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
3784 be checked off in sequence.  A property is used for this behavior because
3785 this should be local to the current entry, not inherited like a tag.
3786 However, if you would like to @i{track} the value of this property with a tag
3787 for better visibility, customize the variable
3788 @code{org-track-ordered-property-with-tag}.
3789 @kindex C-c #
3790 @item C-c #
3791 Update the checkbox statistics in the current outline entry.  When
3792 called with a @kbd{C-u} prefix, update the entire file.  Checkbox
3793 statistic cookies are updated automatically if you toggle checkboxes
3794 with @kbd{C-c C-c} and make new ones with @kbd{M-S-@key{RET}}.  If you
3795 delete boxes or add/change them by hand, use this command to get things
3796 back into sync.  Or simply toggle any checkbox twice with @kbd{C-c C-c}.
3797 @end table
3799 @node Tags, Properties and Columns, TODO Items, Top
3800 @chapter Tags
3801 @cindex tags
3802 @cindex headline tagging
3803 @cindex matching, tags
3804 @cindex sparse tree, tag based
3806 An excellent way to implement labels and contexts for cross-correlating
3807 information is to assign @i{tags} to headlines.  Org mode has extensive
3808 support for tags.
3810 @vindex org-tag-faces
3811 Every headline can contain a list of tags; they occur at the end of the
3812 headline.  Tags are normal words containing letters, numbers, @samp{_}, and
3813 @samp{@@}.  Tags must be preceded and followed by a single colon, e.g.,
3814 @samp{:work:}.  Several tags can be specified, as in @samp{:work:urgent:}.
3815 Tags will by default get a bold face with the same color as the headline.
3816 You may specify special faces for specific tags using the variable
3817 @code{org-tag-faces}, much in the same way as you can do for TODO keywords
3818 (@pxref{Faces for TODO keywords}).
3820 @menu
3821 * Tag inheritance::             Tags use the tree structure of the outline
3822 * Setting tags::                How to assign tags to a headline
3823 * Tag searches::                Searching for combinations of tags
3824 @end menu
3826 @node Tag inheritance, Setting tags, Tags, Tags
3827 @section Tag inheritance
3828 @cindex tag inheritance
3829 @cindex inheritance, of tags
3830 @cindex sublevels, inclusion into tags match
3832 @i{Tags} make use of the hierarchical structure of outline trees.  If a
3833 heading has a certain tag, all subheadings will inherit the tag as
3834 well.  For example, in the list
3836 @example
3837 * Meeting with the French group      :work:
3838 ** Summary by Frank                  :boss:notes:
3839 *** TODO Prepare slides for him      :action:
3840 @end example
3842 @noindent
3843 the final heading will have the tags @samp{:work:}, @samp{:boss:},
3844 @samp{:notes:}, and @samp{:action:} even though the final heading is not
3845 explicitly marked with those tags.  You can also set tags that all entries in
3846 a file should inherit as if these tags would be defined in a hypothetical
3847 level zero that surrounds the entire file.
3849 @example
3850 #+FILETAGS: :Peter:Boss:Secret:
3851 @end example
3853 @noindent
3854 @vindex org-use-tag-inheritance
3855 @vindex org-tags-exclude-from-inheritance
3856 To limit tag inheritance to specific tags, or to turn it off entirely, use
3857 the variables @code{org-use-tag-inheritance} and
3858 @code{org-tags-exclude-from-inheritance}.
3860 @vindex org-tags-match-list-sublevels
3861 When a headline matches during a tags search while tag inheritance is turned
3862 on, all the sublevels in the same tree will (for a simple match form) match
3863 as well@footnote{This is only true if the search does not involve more
3864 complex tests including properties (@pxref{Property searches}).}.  The list
3865 of matches may then become very long.  If you only want to see the first tags
3866 match in a subtree, configure the variable
3867 @code{org-tags-match-list-sublevels} (not recommended).
3869 @node Setting tags, Tag searches, Tag inheritance, Tags
3870 @section Setting tags
3871 @cindex setting tags
3872 @cindex tags, setting
3874 @kindex M-@key{TAB}
3875 Tags can simply be typed into the buffer at the end of a headline.
3876 After a colon, @kbd{M-@key{TAB}} offers completion on tags.  There is
3877 also a special command for inserting tags:
3879 @table @kbd
3880 @kindex C-c C-q
3881 @item C-c C-q
3882 @cindex completion, of tags
3883 @vindex org-tags-column
3884 Enter new tags for the current headline.  Org mode will either offer
3885 completion or a special single-key interface for setting tags, see
3886 below.  After pressing @key{RET}, the tags will be inserted and aligned
3887 to @code{org-tags-column}.  When called with a @kbd{C-u} prefix, all
3888 tags in the current buffer will be aligned to that column, just to make
3889 things look nice.  TAGS are automatically realigned after promotion,
3890 demotion, and TODO state changes (@pxref{TODO basics}).
3891 @kindex C-c C-c
3892 @item C-c C-c
3893 When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
3894 @end table
3896 @vindex org-tag-alist
3897 Org will support tag insertion based on a @emph{list of tags}.  By
3898 default this list is constructed dynamically, containing all tags
3899 currently used in the buffer.  You may also globally specify a hard list
3900 of tags with the variable @code{org-tag-alist}.  Finally you can set
3901 the default tags for a given file with lines like
3903 @example
3904 #+TAGS: @@work @@home @@tennisclub
3905 #+TAGS: laptop car pc sailboat
3906 @end example
3908 If you have globally defined your preferred set of tags using the
3909 variable @code{org-tag-alist}, but would like to use a dynamic tag list
3910 in a specific file, add an empty TAGS option line to that file:
3912 @example
3913 #+TAGS:
3914 @end example
3916 @vindex org-tag-persistent-alist
3917 If you have a preferred set of tags that you would like to use in every file,
3918 in addition to those defined on a per file basis by TAGS option lines, then
3919 you may specify a list of tags with the variable
3920 @code{org-tag-persistent-alist}.  You may turn this off on a per file basis
3921 by adding a STARTUP option line to that file:
3923 @example
3924 #+STARTUP: noptag
3925 @end example
3927 By default Org mode uses the standard minibuffer completion facilities for
3928 entering tags.  However, it also implements another, quicker, tag selection
3929 method called @emph{fast tag selection}.  This allows you to select and
3930 deselect tags with just a single key press.  For this to work well you should
3931 assign unique letters to most of your commonly used tags.  You can do this
3932 globally by configuring the variable @code{org-tag-alist} in your
3933 @file{.emacs} file.  For example, you may find the need to tag many items in
3934 different files with @samp{:@@home:}.  In this case you can set something
3935 like:
3937 @lisp
3938 (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
3939 @end lisp
3941 @noindent If the tag is only relevant to the file you are working on then you
3942 can, instead, set the TAGS option line as:
3944 @example
3945 #+TAGS: @@work(w)  @@home(h)  @@tennisclub(t)  laptop(l)  pc(p)
3946 @end example
3948 @noindent The tags interface will show the available tags in a splash
3949 window.  If you would to start a new line after a specific tag, insert
3950 @samp{\n} into the tag list
3952 @example
3953 #+TAGS: @@work(w)  @@home(h)  @@tennisclub(t) \n laptop(l)  pc(p)
3954 @end example
3956 @noindent or write them in two lines:
3958 @example
3959 #+TAGS: @@work(w)  @@home(h)  @@tennisclub(t)
3960 #+TAGS: laptop(l)  pc(p)
3961 @end example
3963 @noindent
3964 You can also group together tags that are mutually exclusive.  By using
3965 braces, as in:
3967 @example
3968 #+TAGS: @{ @@work(w)  @@home(h)  @@tennisclub(t) @}  laptop(l)  pc(p)
3969 @end example
3971 @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
3972 and @samp{@@tennisclub} should be selected.  Multiple such groups are allowed.
3974 @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
3975 these lines to activate any changes.
3977 @noindent
3978 To set these mutually exclusive groups in the variable @code{org-tags-alist}
3979 you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
3980 of the braces.  Similarly, you can use @code{:newline} to indicate a line
3981 break.  The previous example would be set globally by the following
3982 configuration:
3984 @lisp
3985 (setq org-tag-alist '((:startgroup . nil)
3986                       ("@@work" . ?w) ("@@home" . ?h)
3987                       ("@@tennisclub" . ?t)
3988                       (:endgroup . nil)
3989                       ("laptop" . ?l) ("pc" . ?p)))
3990 @end lisp
3992 If at least one tag has a selection key then pressing @kbd{C-c C-c} will
3993 automatically present you with a special interface, listing inherited tags,
3994 the tags of the current headline, and a list of all valid tags with
3995 corresponding keys@footnote{Keys will automatically be assigned to tags which
3996 have no configured keys.}.  In this interface, you can use the following
3997 keys:
3999 @table @kbd
4000 @item a-z...
4001 Pressing keys assigned to tags will add or remove them from the list of
4002 tags in the current line.  Selecting a tag in a group of mutually
4003 exclusive tags will turn off any other tags from that group.
4004 @kindex @key{TAB}
4005 @item @key{TAB}
4006 Enter a tag in the minibuffer, even if the tag is not in the predefined
4007 list.  You will be able to complete on all tags present in the buffer.
4008 @kindex @key{SPC}
4009 @item @key{SPC}
4010 Clear all tags for this line.
4011 @kindex @key{RET}
4012 @item @key{RET}
4013 Accept the modified set.
4014 @item C-g
4015 Abort without installing changes.
4016 @item q
4017 If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
4018 @item !
4019 Turn off groups of mutually exclusive tags.  Use this to (as an
4020 exception) assign several tags from such a group.
4021 @item C-c
4022 Toggle auto-exit after the next change (see below).
4023 If you are using expert mode, the first @kbd{C-c} will display the
4024 selection window.
4025 @end table
4027 @noindent
4028 This method lets you assign tags to a headline with very few keys.  With
4029 the above setup, you could clear the current tags and set @samp{@@home},
4030 @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
4031 C-c @key{SPC} h l p @key{RET}}.  Switching from @samp{@@home} to
4032 @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
4033 alternatively with @kbd{C-c C-c C-c w}.  Adding the non-predefined tag
4034 @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
4035 @key{RET} @key{RET}}.
4037 @vindex org-fast-tag-selection-single-key
4038 If you find that most of the time, you need only a single key press to
4039 modify your list of tags, set the variable
4040 @code{org-fast-tag-selection-single-key}.  Then you no longer have to
4041 press @key{RET} to exit fast tag selection - it will immediately exit
4042 after the first change.  If you then occasionally need more keys, press
4043 @kbd{C-c} to turn off auto-exit for the current tag selection process
4044 (in effect: start selection with @kbd{C-c C-c C-c} instead of @kbd{C-c
4045 C-c}).  If you set the variable to the value @code{expert}, the special
4046 window is not even shown for single-key tag selection, it comes up only
4047 when you press an extra @kbd{C-c}.
4049 @node Tag searches,  , Setting tags, Tags
4050 @section Tag searches
4051 @cindex tag searches
4052 @cindex searching for tags
4054 Once a system of tags has been set up, it can be used to collect related
4055 information into special lists.
4057 @table @kbd
4058 @kindex C-c \
4059 @kindex C-c / m
4060 @item C-c \
4061 @itemx C-c / m
4062 Create a sparse tree with all headlines matching a tags search.  With a
4063 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
4064 @kindex C-c a m
4065 @item C-c a m
4066 Create a global list of tag matches from all agenda files.
4067 @xref{Matching tags and properties}.
4068 @kindex C-c a M
4069 @item C-c a M
4070 @vindex org-tags-match-list-sublevels
4071 Create a global list of tag matches from all agenda files, but check
4072 only TODO items and force checking subitems (see variable
4073 @code{org-tags-match-list-sublevels}).
4074 @end table
4076 These commands all prompt for a match string which allows basic Boolean logic
4077 like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and
4078 @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries
4079 which are tagged @samp{Kathy} or @samp{Sally}.  The full syntax of the search
4080 string is rich and allows also matching against TODO keywords, entry levels
4081 and properties.  For a complete description with many examples, see
4082 @ref{Matching tags and properties}.
4085 @node Properties and Columns, Dates and Times, Tags, Top
4086 @chapter Properties and Columns
4087 @cindex properties
4089 Properties are a set of key-value pairs associated with an entry.  There
4090 are two main applications for properties in Org mode.  First, properties
4091 are like tags, but with a value.  Second, you can use properties to
4092 implement (very basic) database capabilities in an Org buffer.  For
4093 an example of the first application, imagine maintaining a file where
4094 you document bugs and plan releases of a piece of software.  Instead of
4095 using tags like @code{:release_1:}, @code{:release_2:}, one can use a
4096 property, say @code{:Release:}, that in different subtrees has different
4097 values, such as @code{1.0} or @code{2.0}.  For an example of the second
4098 application of properties, imagine keeping track of your music CDs,
4099 where properties could be things such as the album artist, date of
4100 release, number of tracks, and so on.
4102 Properties can be conveniently edited and viewed in column view
4103 (@pxref{Column view}).
4105 @menu
4106 * Property syntax::             How properties are spelled out
4107 * Special properties::          Access to other Org mode features
4108 * Property searches::           Matching property values
4109 * Property inheritance::        Passing values down the tree
4110 * Column view::                 Tabular viewing and editing
4111 * Property API::                Properties for Lisp programmers
4112 @end menu
4114 @node Property syntax, Special properties, Properties and Columns, Properties and Columns
4115 @section Property syntax
4116 @cindex property syntax
4117 @cindex drawer, for properties
4119 Properties are key-value pairs.  They need to be inserted into a special
4120 drawer (@pxref{Drawers}) with the name @code{PROPERTIES}.  Each property
4121 is specified on a single line, with the key (surrounded by colons)
4122 first, and the value after it.  Here is an example:
4124 @example
4125 * CD collection
4126 ** Classic
4127 *** Goldberg Variations
4128     :PROPERTIES:
4129     :Title:     Goldberg Variations
4130     :Composer:  J.S. Bach
4131     :Artist:    Glen Gould
4132     :Publisher: Deutsche Grammophon
4133     :NDisks:    1
4134     :END:
4135 @end example
4137 You may define the allowed values for a particular property @samp{:Xyz:}
4138 by setting a property @samp{:Xyz_ALL:}.  This special property is
4139 @emph{inherited}, so if you set it in a level 1 entry, it will apply to
4140 the entire tree.  When allowed values are defined, setting the
4141 corresponding property becomes easier and is less prone to typing
4142 errors.  For the example with the CD collection, we can predefine
4143 publishers and the number of disks in a box like this:
4145 @example
4146 * CD collection
4147   :PROPERTIES:
4148   :NDisks_ALL:  1 2 3 4
4149   :Publisher_ALL: "Deutsche Grammophon" Philips EMI
4150   :END:
4151 @end example
4153 If you want to set properties that can be inherited by any entry in a
4154 file, use a line like
4156 @example
4157 #+PROPERTY: NDisks_ALL 1 2 3 4
4158 @end example
4160 @vindex org-global-properties
4161 Property values set with the global variable
4162 @code{org-global-properties} can be inherited by all entries in all
4163 Org files.
4165 @noindent
4166 The following commands help to work with properties:
4168 @table @kbd
4169 @kindex M-@key{TAB}
4170 @item M-@key{TAB}
4171 After an initial colon in a line, complete property keys.  All keys used
4172 in the current file will be offered as possible completions.
4173 @kindex C-c C-x p
4174 @item C-c C-x p
4175 Set a property.  This prompts for a property name and a value.  If
4176 necessary, the property drawer is created as well.
4177 @item M-x org-insert-property-drawer
4178 Insert a property drawer into the current entry.  The drawer will be
4179 inserted early in the entry, but after the lines with planning
4180 information like deadlines.
4181 @kindex C-c C-c
4182 @item C-c C-c
4183 With the cursor in a property drawer, this executes property commands.
4184 @item C-c C-c s
4185 Set a property in the current entry.  Both the property and the value
4186 can be inserted using completion.
4187 @kindex S-@key{right}
4188 @kindex S-@key{left}
4189 @item S-@key{left}/@key{right}
4190 Switch property at point to the next/previous allowed value.
4191 @item C-c C-c d
4192 Remove a property from the current entry.
4193 @item C-c C-c D
4194 Globally remove a property, from all entries in the current file.
4195 @item C-c C-c c
4196 Compute the property at point, using the operator and scope from the
4197 nearest column format definition.
4198 @end table
4200 @node Special properties, Property searches, Property syntax, Properties and Columns
4201 @section Special properties
4202 @cindex properties, special
4204 Special properties provide alternative access method to Org mode
4205 features discussed in the previous chapters, like the TODO state or the
4206 priority of an entry.  This interface exists so that you can include
4207 these states into columns view (@pxref{Column view}), or to use them in
4208 queries.  The following property names are special and should not be
4209 used as keys in the properties drawer:
4211 @example
4212 TODO         @r{The TODO keyword of the entry.}
4213 TAGS         @r{The tags defined directly in the headline.}
4214 ALLTAGS      @r{All tags, including inherited ones.}
4215 CATEGORY     @r{The category of an entry.}
4216 PRIORITY     @r{The priority of the entry, a string with a single letter.}
4217 DEADLINE     @r{The deadline time string, without the angular brackets.}
4218 SCHEDULED    @r{The scheduling time stamp, without the angular brackets.}
4219 CLOSED       @r{When was this entry closed?}
4220 TIMESTAMP    @r{The first keyword-less time stamp in the entry.}
4221 TIMESTAMP_IA @r{The first inactive time stamp in the entry.}
4222 CLOCKSUM     @r{The sum of CLOCK intervals in the subtree.  @code{org-clock-sum}}
4223              @r{must be run first to compute the values.}
4224 @end example
4226 @node Property searches, Property inheritance, Special properties, Properties and Columns
4227 @section Property searches
4228 @cindex properties, searching
4229 @cindex searching, of properties
4231 To create sparse trees and special lists with selection based on properties,
4232 the same commands are used as for tag searches (@pxref{Tag searches}).
4233 @table @kbd
4234 @kindex C-c \
4235 @kindex C-c / m
4236 @item C-c \
4237 @itemx C-c / m
4238 Create a sparse tree with all matching entries.  With a
4239 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
4240 @kindex C-c a m
4241 @item C-c a m
4242 Create a global list of tag/property  matches from all agenda files.
4243 @xref{Matching tags and properties}.
4244 @kindex C-c a M
4245 @item C-c a M
4246 @vindex org-tags-match-list-sublevels
4247 Create a global list of tag matches from all agenda files, but check
4248 only TODO items and force checking subitems (see variable
4249 @code{org-tags-match-list-sublevels}).
4250 @end table
4252 The syntax for the search string is described in @ref{Matching tags and
4253 properties}.
4255 There is also a special command for creating sparse trees based on a
4256 single property:
4258 @table @kbd
4259 @kindex C-c / p
4260 @item C-c / p
4261 Create a sparse tree based on the value of a property.  This first
4262 prompts for the name of a property, and then for a value.  A sparse tree
4263 is created with all entries that define this property with the given
4264 value.  If you enclose the value into curly braces, it is interpreted as
4265 a regular expression and matched against the property values.
4266 @end table
4268 @node Property inheritance, Column view, Property searches, Properties and Columns
4269 @section Property Inheritance
4270 @cindex properties, inheritance
4271 @cindex inheritance, of properties
4273 @vindex org-use-property-inheritance
4274 The outline structure of Org mode documents lends itself for an
4275 inheritance model of properties: If the parent in a tree has a certain
4276 property, the children can inherit this property.  Org mode does not
4277 turn this on by default, because it can slow down property searches
4278 significantly and is often not needed.  However, if you find inheritance
4279 useful, you can turn it on by setting the variable
4280 @code{org-use-property-inheritance}.  It may be set to @code{t}, to make
4281 all properties inherited from the parent, to a list of properties
4282 that should be inherited, or to a regular expression that matches
4283 inherited properties.
4285 Org mode has a few properties for which inheritance is hard-coded, at
4286 least for the special applications for which they are used:
4288 @table @code
4289 @item COLUMNS
4290 The @code{:COLUMNS:} property defines the format of column view
4291 (@pxref{Column view}).  It is inherited in the sense that the level
4292 where a @code{:COLUMNS:} property is defined is used as the starting
4293 point for a column view table, independently of the location in the
4294 subtree from where columns view is turned on.
4295 @item CATEGORY
4296 For agenda view, a category set through a @code{:CATEGORY:} property
4297 applies to the entire subtree.
4298 @item ARCHIVE
4299 For archiving, the @code{:ARCHIVE:} property may define the archive
4300 location for the entire subtree (@pxref{Moving subtrees}).
4301 @item LOGGING
4302 The LOGGING property may define logging settings for an entry or a
4303 subtree (@pxref{Tracking TODO state changes}).
4304 @end table
4306 @node Column view, Property API, Property inheritance, Properties and Columns
4307 @section Column view
4309 A great way to view and edit properties in an outline tree is
4310 @emph{column view}.  In column view, each outline item is turned into a
4311 table row.  Columns in this table provide access to properties of the
4312 entries.  Org mode implements columns by overlaying a tabular structure
4313 over the headline of each item.  While the headlines have been turned
4314 into a table row, you can still change the visibility of the outline
4315 tree.  For example, you get a compact table by switching to CONTENTS
4316 view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
4317 is active), but you can still open, read, and edit the entry below each
4318 headline.  Or, you can switch to column view after executing a sparse
4319 tree command and in this way get a table only for the selected items.
4320 Column view also works in agenda buffers (@pxref{Agenda Views}) where
4321 queries have collected selected items, possibly from a number of files.
4323 @menu
4324 * Defining columns::            The COLUMNS format property
4325 * Using column view::           How to create and use column view
4326 * Capturing column view::       A dynamic block for column view
4327 @end menu
4329 @node Defining columns, Using column view, Column view, Column view
4330 @subsection Defining columns
4331 @cindex column view, for properties
4332 @cindex properties, column view
4334 Setting up a column view first requires defining the columns.  This is
4335 done by defining a column format line.
4337 @menu
4338 * Scope of column definitions::  Where defined, where valid?
4339 * Column attributes::           Appearance and content of a column
4340 @end menu
4342 @node Scope of column definitions, Column attributes, Defining columns, Defining columns
4343 @subsubsection Scope of column definitions
4345 To define a column format for an entire file, use a line like
4347 @example
4348 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
4349 @end example
4351 To specify a format that only applies to a specific tree, add a
4352 @code{:COLUMNS:} property to the top node of that tree, for example:
4354 @example
4355 ** Top node for columns view
4356    :PROPERTIES:
4357    :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
4358    :END:
4359 @end example
4361 If a @code{:COLUMNS:} property is present in an entry, it defines columns
4362 for the entry itself, and for the entire subtree below it.  Since the
4363 column definition is part of the hierarchical structure of the document,
4364 you can define columns on level 1 that are general enough for all
4365 sublevels, and more specific columns further down, when you edit a
4366 deeper part of the tree.
4368 @node Column attributes,  , Scope of column definitions, Defining columns
4369 @subsubsection Column attributes
4370 A column definition sets the attributes of a column.  The general
4371 definition looks like this:
4373 @example
4374  %[width]property[(title)][@{summary-type@}]
4375 @end example
4377 @noindent
4378 Except for the percent sign and the property name, all items are
4379 optional.  The individual parts have the following meaning:
4381 @example
4382 width           @r{An integer specifying the width of the column in characters.}
4383                 @r{If omitted, the width will be determined automatically.}
4384 property        @r{The property that should be edited in this column.}
4385 (title)         @r{The header text for the column. If omitted, the}
4386                 @r{property name is used.}
4387 @{summary-type@}  @r{The summary type.  If specified, the column values for}
4388                 @r{parent nodes are computed from the children.}
4389                 @r{Supported summary types are:}
4390                 @{+@}       @r{Sum numbers in this column.}
4391                 @{+;%.1f@}  @r{Like @samp{+}, but format result with @samp{%.1f}.}
4392                 @{$@}       @r{Currency, short for @samp{+;%.2f}.}
4393                 @{:@}       @r{Sum times, HH:MM:SS, plain numbers are hours.}
4394                 @{X@}       @r{Checkbox status, [X] if all children are [X].}
4395                 @{X/@}      @r{Checkbox status, [n/m].}
4396                 @{X%@}      @r{Checkbox status, [n%].}
4397 @end example
4399 @noindent
4400 Here is an example for a complete columns definition, along with allowed
4401 values.
4403 @example
4404 :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.}
4405                    %10Time_Estimate@{:@} %CLOCKSUM
4406 :Owner_ALL:    Tammy Mark Karl Lisa Don
4407 :Status_ALL:   "In progress" "Not started yet" "Finished" ""
4408 :Approved_ALL: "[ ]" "[X]"
4409 @end example
4411 The first column, @samp{%25ITEM}, means the first 25 characters of the
4412 item itself, i.e. of the headline.  You probably always should start the
4413 column definition with the @samp{ITEM} specifier.  The other specifiers
4414 create columns @samp{Owner} with a list of names as allowed values, for
4415 @samp{Status} with four different possible values, and for a checkbox
4416 field @samp{Approved}.  When no width is given after the @samp{%}
4417 character, the column will be exactly as wide as it needs to be in order
4418 to fully display all values.  The @samp{Approved} column does have a
4419 modified title (@samp{Approved?}, with a question mark).  Summaries will
4420 be created for the @samp{Time_Estimate} column by adding time duration
4421 expressions like HH:MM, and for the @samp{Approved} column, by providing
4422 an @samp{[X]} status if all children have been checked.  The
4423 @samp{CLOCKSUM} column is special, it lists the sum of CLOCK intervals
4424 in the subtree.
4426 @node Using column view, Capturing column view, Defining columns, Column view
4427 @subsection Using column view
4429 @table @kbd
4430 @tsubheading{Turning column view on and off}
4431 @kindex C-c C-x C-c
4432 @item C-c C-x C-c
4433 @vindex org-columns-default-format
4434 Create the column view for the local environment.  This command searches
4435 the hierarchy, up from point, for a @code{:COLUMNS:} property that defines
4436 a format.  When one is found, the column view table is established for
4437 the entire tree, starting from the entry that contains the @code{:COLUMNS:}
4438 property.  If none is found, the format is taken from the @code{#+COLUMNS}
4439 line or from the variable @code{org-columns-default-format}, and column
4440 view is established for the current entry and its subtree.
4441 @kindex r
4442 @item r
4443 Recreate the column view, to include recent changes made in the buffer.
4444 @kindex g
4445 @item g
4446 Same as @kbd{r}.
4447 @kindex q
4448 @item q
4449 Exit column view.
4450 @tsubheading{Editing values}
4451 @item @key{left} @key{right} @key{up} @key{down}
4452 Move through the column view from field to field.
4453 @kindex S-@key{left}
4454 @kindex S-@key{right}
4455 @item  S-@key{left}/@key{right}
4456 Switch to the next/previous allowed value of the field.  For this, you
4457 have to have specified allowed values for a property.
4458 @item 1..9,0
4459 Directly select the nth allowed value, @kbd{0} selects the 10th value.
4460 @kindex n
4461 @kindex p
4462 @itemx  n / p
4463 Same as @kbd{S-@key{left}/@key{right}}
4464 @kindex e
4465 @item e
4466 Edit the property at point.  For the special properties, this will
4467 invoke the same interface that you normally use to change that
4468 property.  For example, when editing a TAGS property, the tag completion
4469 or fast selection interface will pop up.
4470 @kindex C-c C-c
4471 @item C-c C-c
4472 When there is a checkbox at point, toggle it.
4473 @kindex v
4474 @item v
4475 View the full value of this property.  This is useful if the width of
4476 the column is smaller than that of the value.
4477 @kindex a
4478 @item a
4479 Edit the list of allowed values for this property.  If the list is found
4480 in the hierarchy, the modified values is stored there.  If no list is
4481 found, the new value is stored in the first entry that is part of the
4482 current column view.
4483 @tsubheading{Modifying the table structure}
4484 @kindex <
4485 @kindex >
4486 @item < / >
4487 Make the column narrower/wider by one character.
4488 @kindex S-M-@key{right}
4489 @item S-M-@key{right}
4490 Insert a new column, to the left of the current column.
4491 @kindex S-M-@key{left}
4492 @item S-M-@key{left}
4493 Delete the current column.
4494 @end table
4496 @node Capturing column view,  , Using column view, Column view
4497 @subsection Capturing column view
4499 Since column view is just an overlay over a buffer, it cannot be
4500 exported or printed directly.  If you want to capture a column view, use
4501 this @code{columnview} dynamic block (@pxref{Dynamic blocks}).  The frame
4502 of this block looks like this:
4504 @cindex #+BEGIN: columnview
4505 @example
4506 * The column view
4507 #+BEGIN: columnview :hlines 1 :id "label"
4509 #+END:
4510 @end example
4512 @noindent This dynamic block has the following parameters:
4514 @table @code
4515 @item :id
4516 This is most important parameter.  Column view is a feature that is
4517 often localized to a certain (sub)tree, and the capture block might be
4518 in a different location in the file.  To identify the tree whose view to
4519 capture, you can use 3 values:
4520 @example
4521 local     @r{use the tree in which the capture block is located}
4522 global    @r{make a global view, including all headings in the file}
4523 "file:path-to-file"
4524           @r{run column view at the top of this file}
4525 "ID"      @r{call column view in the tree that has an @code{:ID:}}
4526           @r{property with the value @i{label}.  You can use}
4527           @r{@kbd{M-x org-id-copy} to create a globally unique ID for}
4528           @r{the current entry and copy it to the kill-ring.}
4529 @end example
4530 @item :hlines
4531 When @code{t}, insert a hline after every line.  When a number N, insert
4532 a hline before each headline with level @code{<= N}.
4533 @item :vlines
4534 When set to @code{t}, enforce column groups to get vertical lines.
4535 @item :maxlevel
4536 When set to a number, don't capture entries below this level.
4537 @item :skip-empty-rows
4538 When set to @code{t}, skip row where the only non-empty specifier of the
4539 column view is @code{ITEM}.
4541 @end table
4543 @noindent
4544 The following commands insert or update the dynamic block:
4546 @table @kbd
4547 @kindex C-c C-x i
4548 @item C-c C-x i
4549 Insert a dynamic block capturing a column view.  You will be prompted
4550 for the scope or id of the view.
4551 @kindex C-c C-c
4552 @item C-c C-c
4553 @kindex C-c C-x C-u
4554 @itemx C-c C-x C-u
4555 Update dynamical block at point.  The cursor needs to be in the
4556 @code{#+BEGIN} line of the dynamic block.
4557 @kindex C-u C-c C-x C-u
4558 @item C-u C-c C-x C-u
4559 Update all dynamic blocks (@pxref{Dynamic blocks}).  This is useful if
4560 you have several clock table blocks in a buffer.
4561 @end table
4563 You can add formulas to the column view table and you may add plotting
4564 instructions in front of the table - these will survive an update of the
4565 block.  If there is a @code{#+TBLFM:} after the table, the table will
4566 actually be recalculated automatically after an update.
4568 An alternative way to capture and process property values into a table is
4569 provided by Eric Schulte's @file{org-collector.el} which is a contributed
4570 package@footnote{Contributed packages are not part of Emacs, but are
4571 distributed with the main distribution of Org (see
4572 @uref{http://orgmode.org}).}.  It provides a general API to collect
4573 properties from entries in a certain scope, and arbitrary Lisp expressions to
4574 process these values before inserting them into a table or a dynamic block.
4576 @node Property API,  , Column view, Properties and Columns
4577 @section The Property API
4578 @cindex properties, API
4579 @cindex API, for properties
4581 There is a full API for accessing and changing properties.  This API can
4582 be used by Emacs Lisp programs to work with properties and to implement
4583 features based on them.  For more information see @ref{Using the
4584 property API}.
4586 @node Dates and Times, Capture, Properties and Columns, Top
4587 @chapter Dates and Times
4588 @cindex dates
4589 @cindex times
4590 @cindex time stamps
4591 @cindex date stamps
4593 To assist project planning, TODO items can be labeled with a date and/or
4594 a time.  The specially formatted string carrying the date and time
4595 information is called a @emph{timestamp} in Org mode.  This may be a
4596 little confusing because timestamp is often used as indicating when
4597 something was created or last changed.  However, in Org mode this term
4598 is used in a much wider sense.
4600 @menu
4601 * Timestamps::                  Assigning a time to a tree entry
4602 * Creating timestamps::         Commands which insert timestamps
4603 * Deadlines and scheduling::    Planning your work
4604 * Clocking work time::          Tracking how long you spend on a task
4605 * Effort estimates::            Planning work effort in advance
4606 * Relative timer::              Notes with a running timer
4607 @end menu
4610 @node Timestamps, Creating timestamps, Dates and Times, Dates and Times
4611 @section Timestamps, deadlines and scheduling
4612 @cindex time stamps
4613 @cindex ranges, time
4614 @cindex date stamps
4615 @cindex deadlines
4616 @cindex scheduling
4618 A time stamp is a specification of a date (possibly with time or a range
4619 of times) in a special format, either @samp{<2003-09-16 Tue>} or
4620 @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16 Tue
4621 12:00-12:30>}@footnote{This is the standard ISO date/time format.  To
4622 use an alternative format, see @ref{Custom time format}.}.  A time stamp
4623 can appear anywhere in the headline or body of an Org tree entry.  Its
4624 presence causes entries to be shown on specific dates in the agenda
4625 (@pxref{Weekly/daily agenda}).  We distinguish:
4627 @table @var
4628 @item Plain time stamp; Event; Appointment
4629 @cindex timestamp
4630 A simple time stamp just assigns a date/time to an item.  This is just
4631 like writing down an appointment or event in a paper agenda.  In the
4632 timeline and agenda displays, the headline of an entry associated with a
4633 plain time stamp will be shown exactly on that date.
4635 @example
4636 * Meet Peter at the movies <2006-11-01 Wed 19:15>
4637 * Discussion on climate change <2006-11-02 Thu 20:00-22:00>
4638 @end example
4640 @item Time stamp with repeater interval
4641 @cindex timestamp, with repeater interval
4642 A time stamp may contain a @emph{repeater interval}, indicating that it
4643 applies not only on the given date, but again and again after a certain
4644 interval of N days (d), weeks (w), months(m), or years(y).  The
4645 following will show up in the agenda every Wednesday:
4647 @example
4648 * Pick up Sam at school <2007-05-16 Wed 12:30 +1w>
4649 @end example
4651 @item Diary-style sexp entries
4652 For more complex date specifications, Org mode supports using the
4653 special sexp diary entries implemented in the Emacs calendar/diary
4654 package.  For example
4656 @example
4657 * The nerd meeting on every 2nd Thursday of the month
4658   <%%(diary-float t 4 2)>
4659 @end example
4661 @item Time/Date range
4662 @cindex timerange
4663 @cindex date range
4664 Two time stamps connected by @samp{--} denote a range.  The headline
4665 will be shown on the first and last day of the range, and on any dates
4666 that are displayed and fall in the range.  Here is an example:
4668 @example
4669 ** Meeting in Amsterdam
4670    <2004-08-23 Mon>--<2004-08-26 Thu>
4671 @end example
4673 @item Inactive time stamp
4674 @cindex timestamp, inactive
4675 @cindex inactive timestamp
4676 Just like a plain time stamp, but with square brackets instead of
4677 angular ones.  These time stamps are inactive in the sense that they do
4678 @emph{not} trigger an entry to show up in the agenda.
4680 @example
4681 * Gillian comes late for the fifth time [2006-11-01 Wed]
4682 @end example
4684 @end table
4686 @node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times
4687 @section Creating timestamps
4688 @cindex creating timestamps
4689 @cindex timestamps, creating
4691 For Org mode to recognize time stamps, they need to be in the specific
4692 format.  All commands listed below produce time stamps in the correct
4693 format.
4695 @table @kbd
4696 @kindex C-c .
4697 @item C-c .
4698 Prompt for a date and insert a corresponding time stamp.  When the cursor is
4699 at an existing time stamp in the buffer, the command is used to modify this
4700 timestamp instead of inserting a new one.  When this command is used twice in
4701 succession, a time range is inserted.
4703 @kindex C-c !
4704 @item C-c !
4705 Like @kbd{C-c .}, but insert an inactive time stamp that will not cause
4706 an agenda entry.
4708 @kindex C-u C-c .
4709 @kindex C-u C-c !
4710 @item C-u C-c .
4711 @itemx C-u C-c !
4712 @vindex org-time-stamp-rounding-minutes
4713 Like @kbd{C-c .} and @kbd{C-c !}, but use the alternative format which
4714 contains date and time.  The default time can be rounded to multiples of 5
4715 minutes, see the option @code{org-time-stamp-rounding-minutes}.
4717 @kindex C-c <
4718 @item C-c <
4719 Insert a time stamp corresponding to the cursor date in the Calendar.
4721 @kindex C-c >
4722 @item C-c >
4723 Access the Emacs calendar for the current date.  If there is a
4724 timestamp in the current line, go to the corresponding date
4725 instead.
4727 @kindex C-c C-o
4728 @item C-c C-o
4729 Access the agenda for the date given by the time stamp or -range at
4730 point (@pxref{Weekly/daily agenda}).
4732 @kindex S-@key{left}
4733 @kindex S-@key{right}
4734 @item S-@key{left}
4735 @itemx S-@key{right}
4736 Change date at cursor by one day.  These key bindings conflict with
4737 shift-selection and related modes (@pxref{Conflicts}).
4739 @kindex S-@key{up}
4740 @kindex S-@key{down}
4741 @item S-@key{up}
4742 @itemx S-@key{down}
4743 Change the item under the cursor in a timestamp.  The cursor can be on a
4744 year, month, day, hour or minute.  When the time stamp contains a time range
4745 like @samp{15:30-16:30}, modifying the first time will also shift the second,
4746 shifting the time block with constant length.  To change the length, modify
4747 the second time.  Note that if the cursor is in a headline and not at a time
4748 stamp, these same keys modify the priority of an item.
4749 (@pxref{Priorities}). The key bindings also conflict with shift-selection and
4750 related modes (@pxref{Conflicts}).
4752 @kindex C-c C-y
4753 @cindex evaluate time range
4754 @item C-c C-y
4755 Evaluate a time range by computing the difference between start and end.
4756 With a prefix argument, insert result after the time range (in a table: into
4757 the following column).
4758 @end table
4761 @menu
4762 * The date/time prompt::        How Org mode helps you entering date and time
4763 * Custom time format::          Making dates look different
4764 @end menu
4766 @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps
4767 @subsection The date/time prompt
4768 @cindex date, reading in minibuffer
4769 @cindex time, reading in minibuffer
4771 @vindex org-read-date-prefer-future
4772 When Org mode prompts for a date/time, the default is shown as an ISO
4773 date, and the prompt therefore seems to ask for an ISO date.  But it
4774 will in fact accept any string containing some date and/or time
4775 information, and it is really smart about interpreting your input.  You
4776 can, for example, use @kbd{C-y} to paste a (possibly multi-line) string
4777 copied from an email message.  Org mode will find whatever information
4778 is in there and derive anything you have not specified from the
4779 @emph{default date and time}.  The default is usually the current date
4780 and time, but when modifying an existing time stamp, or when entering
4781 the second stamp of a range, it is taken from the stamp in the buffer.
4782 When filling in information, Org mode assumes that most of the time you
4783 will want to enter a date in the future: If you omit the month/year and
4784 the given day/month is @i{before} today, it will assume that you mean a
4785 future date@footnote{See the variable
4786 @code{org-read-date-prefer-future}.}.
4788 For example, let's assume that today is @b{June 13, 2006}.  Here is how
4789 various inputs will be interpreted, the items filled in by Org mode are
4790 in @b{bold}.
4792 @example
4793 3-2-5         --> 2003-02-05
4794 14            --> @b{2006}-@b{06}-14
4795 12            --> @b{2006}-@b{07}-12
4796 Fri           --> nearest Friday (defaultdate or later)
4797 sep 15        --> @b{2006}-09-15
4798 feb 15        --> @b{2007}-02-15
4799 sep 12 9      --> 2009-09-12
4800 12:45         --> @b{2006}-@b{06}-@b{13} 12:45
4801 22 sept 0:34  --> @b{2006}-09-22 0:34
4802 w4            --> ISO week for of the current year @b{2006}
4803 2012 w4 fri   --> Friday of ISO week 4 in 2012
4804 2012-w04-5    --> Same as above
4805 @end example
4807 Furthermore you can specify a relative date by giving, as the
4808 @emph{first} thing in the input: a plus/minus sign, a number and a
4809 letter [dwmy] to indicate change in days weeks, months, years.  With a
4810 single plus or minus, the date is always relative to today.  With a
4811 double plus or minus, it is relative to the default date.  If instead of
4812 a single letter, you use the abbreviation of day name, the date will be
4813 the nth such day.  E.g.
4815 @example
4816 +0            --> today
4817 .             --> today
4818 +4d           --> four days from today
4819 +4            --> same as above
4820 +2w           --> two weeks from today
4821 ++5           --> five days from default date
4822 +2tue         --> second tuesday from now.
4823 @end example
4825 @vindex parse-time-months
4826 @vindex parse-time-weekdays
4827 The function understands English month and weekday abbreviations.  If
4828 you want to use unabbreviated names and/or other languages, configure
4829 the variables @code{parse-time-months} and @code{parse-time-weekdays}.
4831 @cindex calendar, for selecting date
4832 @vindex org-popup-calendar-for-date-prompt
4833 Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
4834 you don't need/want the calendar, configure the variable
4835 @code{org-popup-calendar-for-date-prompt}.}.  When you exit the date
4836 prompt, either by clicking on a date in the calendar, or by pressing
4837 @key{RET}, the date selected in the calendar will be combined with the
4838 information entered at the prompt.  You can control the calendar fully
4839 from the minibuffer:
4841 @kindex <
4842 @kindex >
4843 @kindex mouse-1
4844 @kindex S-@key{right}
4845 @kindex S-@key{left}
4846 @kindex S-@key{down}
4847 @kindex S-@key{up}
4848 @kindex M-S-@key{right}
4849 @kindex M-S-@key{left}
4850 @kindex @key{RET}
4851 @example
4852 > / <          @r{Scroll calendar forward/backward by one month.}
4853 mouse-1        @r{Select date by clicking on it.}
4854 S-@key{right}/@key{left}     @r{One day forward/backward.}
4855 S-@key{down}/@key{up}     @r{One week forward/backward.}
4856 M-S-@key{right}/@key{left}   @r{One month forward/backward.}
4857 @key{RET}           @r{Choose date in calendar.}
4858 @end example
4860 @vindex org-read-date-display-live
4861 The actions of the date/time prompt may seem complex, but I assure you they
4862 will grow on you, and you will start getting annoyed by pretty much any other
4863 way of entering a date/time out there.  To help you understand what is going
4864 on, the current interpretation of your input will be displayed live in the
4865 minibuffer@footnote{If you find this distracting, turn the display of with
4866 @code{org-read-date-display-live}.}.
4868 @node Custom time format,  , The date/time prompt, Creating timestamps
4869 @subsection Custom time format
4870 @cindex custom date/time format
4871 @cindex time format, custom
4872 @cindex date format, custom
4874 @vindex org-display-custom-times
4875 @vindex org-time-stamp-custom-formats
4876 Org mode uses the standard ISO notation for dates and times as it is
4877 defined in ISO 8601.  If you cannot get used to this and require another
4878 representation of date and time to keep you happy, you can get it by
4879 customizing the variables @code{org-display-custom-times} and
4880 @code{org-time-stamp-custom-formats}.
4882 @table @kbd
4883 @kindex C-c C-x C-t
4884 @item C-c C-x C-t
4885 Toggle the display of custom formats for dates and times.
4886 @end table
4888 @noindent
4889 Org mode needs the default format for scanning, so the custom date/time
4890 format does not @emph{replace} the default format - instead it is put
4891 @emph{over} the default format using text properties.  This has the
4892 following consequences:
4893 @itemize @bullet
4894 @item
4895 You cannot place the cursor onto a time stamp anymore, only before or
4896 after.
4897 @item
4898 The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
4899 each component of a time stamp.  If the cursor is at the beginning of
4900 the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
4901 just like @kbd{S-@key{left}/@key{right}}.  At the end of the stamp, the
4902 time will be changed by one minute.
4903 @item
4904 If the time stamp contains a range of clock times or a repeater, these
4905 will not be overlayed, but remain in the buffer as they were.
4906 @item
4907 When you delete a time stamp character-by-character, it will only
4908 disappear from the buffer after @emph{all} (invisible) characters
4909 belonging to the ISO timestamp have been removed.
4910 @item
4911 If the custom time stamp format is longer than the default and you are
4912 using dates in tables, table alignment will be messed up.  If the custom
4913 format is shorter, things do work as expected.
4914 @end itemize
4917 @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times
4918 @section Deadlines and scheduling
4920 A time stamp may be preceded by special keywords to facilitate planning:
4922 @table @var
4923 @item DEADLINE
4924 @cindex DEADLINE keyword
4926 Meaning: the task (most likely a TODO item, though not necessarily) is supposed
4927 to be finished on that date.
4929 @vindex org-deadline-warning-days
4930 On the deadline date, the task will be listed in the agenda.  In
4931 addition, the agenda for @emph{today} will carry a warning about the
4932 approaching or missed deadline, starting
4933 @code{org-deadline-warning-days} before the due date, and continuing
4934 until the entry is marked DONE.  An example:
4936 @example
4937 *** TODO write article about the Earth for the Guide
4938     The editor in charge is [[bbdb:Ford Prefect]]
4939     DEADLINE: <2004-02-29 Sun>
4940 @end example
4942 You can specify a different lead time for warnings for a specific
4943 deadlines using the following syntax.  Here is an example with a warning
4944 period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}.
4946 @item SCHEDULED
4947 @cindex SCHEDULED keyword
4949 Meaning: you are planning to start working on that task on the given
4950 date.
4952 @vindex org-agenda-skip-scheduled-if-done
4953 The headline will be listed under the given date@footnote{It will still
4954 be listed on that date after it has been marked DONE.  If you don't like
4955 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}.  In
4956 addition, a reminder that the scheduled date has passed will be present
4957 in the compilation for @emph{today}, until the entry is marked DONE.
4958 I.e., the task will automatically be forwarded until completed.
4960 @example
4961 *** TODO Call Trillian for a date on New Years Eve.
4962     SCHEDULED: <2004-12-25 Sat>
4963 @end example
4965 @noindent
4966 @b{Important:} Scheduling an item in Org mode should @i{not} be
4967 understood in the same way that we understand @i{scheduling a meeting}.
4968 Setting a date for a meeting is just a simple appointment, you should
4969 mark this entry with a simple plain time stamp, to get this item shown
4970 on the date where it applies.  This is a frequent mis-understanding from
4971 Org-users.  In Org mode, @i{scheduling} means setting a date when you
4972 want to start working on an action item.
4973 @end table
4975 You may use time stamps with repeaters in scheduling and deadline
4976 entries.  Org mode will issue early and late warnings based on the
4977 assumption that the time stamp represents the @i{nearest instance} of
4978 the repeater.  However, the use of diary sexp entries like
4980 @code{<%%(diary-float t 42)>}
4982 in scheduling and deadline timestamps is limited.  Org mode does not
4983 know enough about the internals of each sexp function to issue early and
4984 late warnings.  However, it will show the item on each day where the
4985 sexp entry matches.
4987 @menu
4988 * Inserting deadline/schedule::  Planning items
4989 * Repeated tasks::              Items that show up again and again
4990 @end menu
4992 @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling
4993 @subsection Inserting deadlines or schedules
4995 The following commands allow to quickly insert a deadline or to schedule
4996 an item:
4998 @table @kbd
5000 @kindex C-c C-d
5001 @item C-c C-d
5002 Insert @samp{DEADLINE} keyword along with a stamp.  The insertion will
5003 happen in the line directly following the headline.  When called with a
5004 prefix arg, an existing deadline will be removed from the entry.
5005 @c FIXME Any CLOSED timestamp will be removed.????????
5007 @kindex C-c C-s
5008 @item C-c C-s
5009 Insert @samp{SCHEDULED} keyword along with a stamp.  The insertion will
5010 happen in the line directly following the headline.  Any CLOSED
5011 timestamp will be removed.  When called with a prefix argument, remove
5012 the scheduling date from the entry.
5014 @kindex C-c C-x C-k
5015 @kindex k a
5016 @kindex k s
5017 @item C-c C-x C-k
5018 Mark the current entry for agenda action.  After you have marked the entry
5019 like this, you can open the agenda or the calendar to find an appropriate
5020 date.  With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to
5021 schedule the marked item.
5023 @kindex C-c / d
5024 @cindex sparse tree, for deadlines
5025 @item C-c / d
5026 @vindex org-deadline-warning-days
5027 Create a sparse tree with all deadlines that are either past-due, or
5028 which will become due within @code{org-deadline-warning-days}.
5029 With @kbd{C-u} prefix, show all deadlines in the file.  With a numeric
5030 prefix, check that many days.  For example, @kbd{C-1 C-c / d} shows
5031 all deadlines due tomorrow.
5033 @kindex C-c / b
5034 @item C-c / b
5035 Sparse tree for deadlines and scheduled items before a given date.
5037 @kindex C-c / a
5038 @item C-c / a
5039 Sparse tree for deadlines and scheduled items after a given date.
5040 @end table
5042 @node Repeated tasks,  , Inserting deadline/schedule, Deadlines and scheduling
5043 @subsection Repeated tasks
5044 @cindex tasks, repeated
5045 @cindex repeated tasks
5047 Some tasks need to be repeated again and again.  Org mode helps to
5048 organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
5049 or plain time stamp.  In the following example
5050 @example
5051 ** TODO Pay the rent
5052    DEADLINE: <2005-10-01 Sat +1m>
5053 @end example
5054 the @code{+1m} is a repeater; the intended interpretation is that the task
5055 has a deadline on <2005-10-01> and repeats itself every (one) month starting
5056 from that time.  If you need both a repeater and a special warning period in
5057 a deadline entry, the repeater should come first and the warning period last:
5058 @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
5060 Deadlines and scheduled items produce entries in the agenda when they
5061 are over-due, so it is important to be able to mark such an entry as
5062 completed once you have done so.  When you mark a DEADLINE or a SCHEDULE
5063 with the TODO keyword DONE, it will no longer produce entries in the
5064 agenda.  The problem with this is, however, that then also the
5065 @emph{next} instance of the repeated entry will not be active.  Org mode
5066 deals with this in the following way: When you try to mark such an entry
5067 DONE (using @kbd{C-c C-t}), it will shift the base date of the repeating
5068 time stamp by the repeater interval, and immediately set the entry state
5069 back to TODO.  In the example above, setting the state to DONE would
5070 actually switch the date like this:
5072 @example
5073 ** TODO Pay the rent
5074    DEADLINE: <2005-11-01 Tue +1m>
5075 @end example
5077 @vindex org-log-repeat
5078 A timestamp@footnote{You can change this using the option
5079 @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
5080 @code{lognoterepeat}, and @code{nologrepeat}.  With @code{lognoterepeat}, you
5081 will also be prompted for a note.} will be added under the deadline, to keep
5082 a record that you actually acted on the previous instance of this deadline.
5084 As a consequence of shifting the base date, this entry will no longer be
5085 visible in the agenda when checking past dates, but all future instances
5086 will be visible.
5088 With the @samp{+1m} cookie, the date shift will always be exactly one
5089 month.  So if you have not payed the rent for three months, marking this
5090 entry DONE will still keep it as an overdue deadline.  Depending on the
5091 task, this may not be the best way to handle it.  For example, if you
5092 forgot to call you father for 3 weeks, it does not make sense to call
5093 him 3 times in a single day to make up for it.  Finally, there are tasks
5094 like changing batteries which should always repeat a certain time
5095 @i{after} the last time you did it.  For these tasks, Org mode has
5096 special repeaters markers with @samp{++} and @samp{.+}.  For example:
5098 @example
5099 ** TODO Call Father
5100    DEADLINE: <2008-02-10 Sun ++1w>
5101    Marking this DONE will shift the date by at least one week,
5102    but also by as many weeks as it takes to get this date into
5103    the future.  However, it stays on a Sunday, even if you called
5104    and marked it done on Saturday.
5105 ** TODO Check the batteries in the smoke detectors
5106    DEADLINE: <2005-11-01 Tue .+1m>
5107    Marking this DONE will shift the date to one month after
5108    today.
5109 @end example
5111 You may have both scheduling and deadline information for a specific
5112 task - just make sure that the repeater intervals on both are the same.
5114 An alternative to using a repeater is to create a number of copies of a task
5115 subtree, with dates shifted in each copy.  The command @kbd{C-c C-x c} was
5116 created for this purpose, it is described in @ref{Structure editing}.
5119 @node Clocking work time, Effort estimates, Deadlines and scheduling, Dates and Times
5120 @section Clocking work time
5122 Org mode allows you to clock the time you spent on specific tasks in a
5123 project.  When you start working on an item, you can start the clock.
5124 When you stop working on that task, or when you mark the task done, the
5125 clock is stopped and the corresponding time interval is recorded.  It
5126 also computes the total time spent on each subtree of a project.
5128 Normally, the clock does not survive xiting and re-entereing Emacs, but you
5129 can arrange for the clock information to persisst accress Emacs sessions with
5131 @lisp
5132 (setq org-clock-persist t)
5133 (org-clock-persistence-insinuate)
5134 @end lisp
5136 @table @kbd
5137 @kindex C-c C-x C-i
5138 @item C-c C-x C-i
5139 @vindex org-clock-into-drawer
5140 Start the clock on the current item (clock-in).  This inserts the CLOCK
5141 keyword together with a timestamp.  If this is not the first clocking of
5142 this item, the multiple CLOCK lines will be wrapped into a
5143 @code{:CLOCK:} drawer (see also the variable
5144 @code{org-clock-into-drawer}).  When called with a @kbd{C-u} prefix argument,
5145 select the task from a list of recently clocked tasks.  With two @kbd{C-u
5146 C-u} prefixes, clock into the task at point and mark it as the default task.
5147 The default task will always be available when selecting a clocking task,
5148 with letter @kbd{d}.
5149 @kindex C-c C-x C-o
5150 @item C-c C-x C-o
5151 @vindex org-log-note-clock-out
5152 Stop the clock (clock-out).  This inserts another timestamp at the same
5153 location where the clock was last started.  It also directly computes
5154 the resulting time in inserts it after the time range as @samp{=>
5155 HH:MM}.  See the variable @code{org-log-note-clock-out} for the
5156 possibility to record an additional note together with the clock-out
5157 time stamp@footnote{The corresponding in-buffer setting is:
5158 @code{#+STARTUP: lognoteclock-out}}.
5159 @kindex C-c C-y
5160 @item C-c C-y
5161 Recompute the time interval after changing one of the time stamps.  This
5162 is only necessary if you edit the time stamps directly.  If you change
5163 them with @kbd{S-@key{cursor}} keys, the update is automatic.
5164 @kindex C-c C-t
5165 @item C-c C-t
5166 Changing the TODO state of an item to DONE automatically stops the clock
5167 if it is running in this same item.
5168 @kindex C-c C-x C-x
5169 @item C-c C-x C-x
5170 Cancel the current clock.  This is useful if a clock was started by
5171 mistake, or if you ended up working on something else.
5172 @kindex C-c C-x C-j
5173 @item C-c C-x C-j
5174 Jump to the entry that contains the currently running clock.  With a
5175 @kbd{C-u} prefix arg, select the target task from a list of recently clocked
5176 tasks.
5177 @kindex C-c C-x C-d
5178 @item C-c C-x C-d
5179 @vindex org-remove-highlights-with-change
5180 Display time summaries for each subtree in the current buffer.  This
5181 puts overlays at the end of each headline, showing the total time
5182 recorded under that heading, including the time of any subheadings. You
5183 can use visibility cycling to study the tree, but the overlays disappear
5184 when you change the buffer (see variable
5185 @code{org-remove-highlights-with-change}) or press @kbd{C-c C-c}.
5186 @kindex C-c C-x C-r
5187 @item C-c C-x C-r
5188 Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
5189 report as an Org mode table into the current file.  When the cursor is
5190 at an existing clock table, just update it.  When called with a prefix
5191 argument, jump to the first clock report in the current document and
5192 update it.
5193 @cindex #+BEGIN: clocktable
5194 @example
5195 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
5196 #+END: clocktable
5197 @end example
5198 @noindent
5199 If such a block already exists at point, its content is replaced by the
5200 new table.  The @samp{BEGIN} line can specify options:
5201 @example
5202 :maxlevel    @r{Maximum level depth to which times are listed in the table.}
5203 :emphasize   @r{When @code{t}, emphasize level one and level two items}
5204 :scope       @r{The scope to consider.  This can be any of the following:}
5205              nil        @r{the current buffer or narrowed region}
5206              file       @r{the full current buffer}
5207              subtree    @r{the subtree where the clocktable is located}
5208              treeN      @r{the surrounding level N tree, for example @code{tree3}}
5209              tree       @r{the surrounding level 1 tree}
5210              agenda     @r{all agenda files}
5211              ("file"..) @r{scan these files}
5212              file-with-archives    @r{current file and its archives}
5213              agenda-with-archives  @r{all agenda files, including archives}
5214 :block       @r{The time block to consider.  This block is specified either}
5215              @r{absolute, or relative to the current time and may be any of}
5216              @r{these formats:}
5217              2007-12-31    @r{New year eve 2007}
5218              2007-12       @r{December 2007}
5219              2007-W50      @r{ISO-week 50 in 2007}
5220              2007          @r{the year 2007}
5221              today, yesterday, today-N          @r{a relative day}
5222              thisweek, lastweek, thisweek-N     @r{a relative week}
5223              thismonth, lastmonth, thismonth-N  @r{a relative month}
5224              thisyear, lastyear, thisyear-N     @r{a relative year}
5225              @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
5226 :tstart      @r{A time string specifying when to start considering times}
5227 :tend        @r{A time string specifying when to stop considering times}
5228 :step        @r{@code{week} or @code{day}, to split the table into chunks.}
5229              @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
5230 :link        @r{Link the item headlines in the table to their origins}
5231 :formula     @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
5232              @r{As a special case, @samp{:formula %} adds column with % time.}
5233              @r{If you do not specify a formula here, any existing formula}
5234              @r{below the clock table will survive updates and be evaluated.}
5235 @end example
5236 So to get a clock summary of the current level 1 tree, for the current
5237 day, you could write
5238 @example
5239 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
5240 #+END: clocktable
5241 @end example
5242 and to use a specific time range you could write@footnote{Note that all
5243 parameters must be specified in a single line - the line is broken here
5244 only to fit it onto the manual.}
5245 @example
5246 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
5247                     :tend "<2006-08-10 Thu 12:00>"
5248 #+END: clocktable
5249 @end example
5250 A summary of the current subtree with % times would be
5251 @example
5252 #+BEGIN: clocktable :scope subtree :link t :formula %
5253 #+END: clocktable
5254 @end example
5255 @kindex C-c C-c
5256 @item C-c C-c
5257 @kindex C-c C-x C-u
5258 @itemx C-c C-x C-u
5259 Update dynamical block at point.  The cursor needs to be in the
5260 @code{#+BEGIN} line of the dynamic block.
5261 @kindex C-u C-c C-x C-u
5262 @item C-u C-c C-x C-u
5263 Update all dynamic blocks (@pxref{Dynamic blocks}).  This is useful if
5264 you have several clock table blocks in a buffer.
5265 @kindex S-@key{left}
5266 @kindex S-@key{right}
5267 @item S-@key{left}
5268 @itemx S-@key{right}
5269 Shift the current @code{:block} interval and update the table.  The cursor
5270 needs to be in the @code{#+BEGIN: clocktable} line for this command.  If
5271 @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
5272 @end table
5274 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
5275 the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
5276 worked on or closed during a day.
5278 @node Effort estimates, Relative timer, Clocking work time, Dates and Times
5279 @section Effort estimates
5280 @cindex effort estimates
5282 @vindex org-effort-property
5283 If you want to plan your work in a very detailed way, or if you need to
5284 produce offers with quotations of the estimated work effort, you may want to
5285 assign effort estimates to entries.  If you are also clocking your work, you
5286 may later want to compare the planned effort with the actual working time, a
5287 great way to improve planning estimates.  Effort estimates are stored in a
5288 special property @samp{Effort}@footnote{You may change the property being
5289 used with the variable @code{org-effort-property}.}.  Clearly the best way to
5290 work with effort estimates is through column view (@pxref{Column view}).  You
5291 should start by setting up discrete values for effort estimates, and a
5292 @code{COLUMNS} format that displays these values together with clock sums (if
5293 you want to clock your time).  For a specific buffer you can use
5295 @example
5296 #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00
5297 #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
5298 @end example
5300 @noindent
5301 @vindex org-global-properties
5302 @vindex org-columns-default-format
5303 or, even better, you can set up these values globally by customizing the
5304 variables @code{org-global-properties} and @code{org-columns-default-format}.
5305 In particular if you want to use this setup also in the agenda, a global
5306 setup may be advised.
5308 The way to assign estimates to individual items is then to switch to column
5309 mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
5310 value.  The values you enter will immediately be summed up in the hierarchy.
5311 In the column next to it, any clocked time will be displayed.
5313 @vindex org-agenda-columns-add-appointments-to-effort-sum
5314 If you switch to column view in the daily/weekly agenda, the effort column
5315 will summarize the estimated work effort for each day@footnote{Please note
5316 the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
5317 column view}).}, and you can use this to find space in your schedule.  To get
5318 an overview of the entire part of the day that is committed, you can set the
5319 option @code{org-agenda-columns-add-appointments-to-effort-sum}.  The
5320 appointments on a day that take place over a specified time interval will
5321 then also be added to the load estimate of the day.
5323 Effort estimates can be used in secondary agenda filtering that is triggered
5324 with the @kbd{/} key in the agenda (@pxref{Agenda commands}).  If you have
5325 these estimates defined consistently, two or three key presses will narrow
5326 down the list to stuff that fits into an available time slot.
5328 @node Relative timer,  , Effort estimates, Dates and Times
5329 @section Taking notes with a relative timer
5330 @cindex relative timer
5332 When taking notes during, for example, a meeting or a video viewing, it can
5333 be useful to have access to times relative to a starting time.  Org provides
5334 such a relative timer and make it easy to create timed notes.
5336 @table @kbd
5337 @kindex C-c C-x .
5338 @item C-c C-x .
5339 Insert a relative time into the buffer.  The first time you use this, the
5340 timer will be started.  When called with a prefix argument, the timer is
5341 restarted.
5342 @kindex C-c C-x -
5343 @item C-c C-x -
5344 Insert a description list item with the current relative time.  With a prefix
5345 argument, first reset the timer to 0.
5346 @kindex M-@key{RET}
5347 @item M-@key{RET}
5348 Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
5349 new timer items.
5350 @kindex C-c C-x ,
5351 @item C-c C-x ,
5352 Pause the timer, or continue it if it is already paused.  With prefix
5353 argument, stop it entirely.
5354 @kindex C-u C-c C-x ,
5355 @item C-u C-c C-x ,
5356 Stop the timer.  After this, you can only start a new timer, not continue the
5357 old one.  This command also removes the timer from the mode line.
5358 @kindex C-c C-x 0
5359 @item C-c C-x 0
5360 Reset the timer without inserting anything into the buffer.  By default, the
5361 timer is reset to 0.  When called with a @kbd{C-u} prefix, reset the timer to
5362 specific starting offset.  The user is prompted for the offset, with a
5363 default taken from a timer string at point, if any, So this can be used to
5364 restart taking notes after a break in the process.  When called with a double
5365 prefix argument @kbd{C-c C-u}, change all timer strings in the active region
5366 by a certain amount.  This can be used to fix timer strings if the timer was
5367 not started at exactly the right moment.
5368 @end table
5370 @node Capture, Agenda Views, Dates and Times, Top
5371 @chapter Capture
5372 @cindex capture
5374 An important part of any organization system is the ability to quickly
5375 capture new ideas and tasks, and to associate reference material with them.
5376 Org uses the @file{remember} package to create tasks, and stores files
5377 related to a task (@i{attachments}) in a special directory.
5379 @menu
5380 * Remember::                    Capture new tasks/ideas with little interruption
5381 * Attachments::                 Add files to tasks.
5382 * RSS Feeds::                   Getting input from RSS feeds
5383 * Protocols::                   External (e.g. Browser) access to Emacs and Org
5384 @end menu
5386 @node Remember, Attachments, Capture, Capture
5387 @section Remember
5388 @cindex @file{remember.el}
5390 The @i{Remember} package by John Wiegley lets you store quick notes with
5391 little interruption of your work flow.  See
5392 @uref{http://www.emacswiki.org/cgi-bin/wiki/RememberMode} for more
5393 information.  It is an excellent way to add new notes and tasks to
5394 Org files.  Org significantly expands the possibilities of
5395 @i{remember}: You may define templates for different note types, and
5396 associate target files and headlines with specific templates.  It also
5397 allows you to select the location where a note should be stored
5398 interactively, on the fly.
5400 @menu
5401 * Setting up Remember::         Some code for .emacs to get things going
5402 * Remember templates::          Define the outline of different note types
5403 * Storing notes::               Directly get the note to where it belongs
5404 * Refiling notes::              Moving a note or task to a project
5405 @end menu
5407 @node Setting up Remember, Remember templates, Remember, Remember
5408 @subsection Setting up Remember
5410 The following customization will tell @i{remember} to use org files as
5411 target, and to create annotations compatible with Org links.
5413 @example
5414 (org-remember-insinuate)
5415 (setq org-directory "~/path/to/my/orgfiles/")
5416 (setq org-default-notes-file (concat org-directory "/notes.org"))
5417 (define-key global-map "\C-cr" 'org-remember)
5418 @end example
5420 The last line binds the command @code{org-remember} to a global
5421 key@footnote{Please select your own key, @kbd{C-c r} is only a
5422 suggestion.}.  @code{org-remember} basically just calls @code{remember},
5423 but it makes a few things easier: If there is an active region, it will
5424 automatically copy the region into the remember buffer.  It also allows
5425 to jump to the buffer and location where remember notes are being
5426 stored: Just call @code{org-remember} with a prefix argument.  If you
5427 use two prefix arguments, Org jumps to the location where the last
5428 remember note was stored.
5430 The remember buffer will actually use @code{org-mode} as its major mode, so
5431 that all editing features of Org-mode are available.  In addition to this, a
5432 minor mode @code{org-remember-mode} is turned on, for the single purpose that
5433 you can use its keymap @code{org-remember-mode-map} to overwrite some of
5434 Org-mode's key bindings.
5436 You can also call @code{org-remember} in a special way from the agenda,
5437 using the @kbd{k r} key combination.  With this access, any time stamps
5438 inserted by the selected remember template (see below) will default to
5439 the cursor date in the agenda, rather than to the current date.
5441 @node Remember templates, Storing notes, Setting up Remember, Remember
5442 @subsection Remember templates
5443 @cindex templates, for remember
5445 In combination with Org, you can use templates to generate
5446 different types of @i{remember} notes.  For example, if you would like
5447 to use one template to create general TODO entries, another one for
5448 journal entries, and a third one for collecting random ideas, you could
5449 use:
5451 @example
5452 (setq org-remember-templates
5453  '(("Todo" ?t "* TODO %?\n  %i\n  %a" "~/org/TODO.org" "Tasks")
5454    ("Journal" ?j "* %U %?\n\n  %i\n  %a" "~/org/JOURNAL.org")
5455    ("Idea" ?i "* %^@{Title@}\n  %i\n  %a" "~/org/JOURNAL.org" "New Ideas")))
5456 @end example
5458 @vindex org-remember-default-headline
5459 @vindex org-directory
5460 @noindent In these entries, the first string is just a name, and the
5461 character specifies how to select the template.  It is useful if the
5462 character is also the first letter of the name.  The next string specifies
5463 the template.  Two more (optional) strings give the file in which, and the
5464 headline under which the new note should be stored.  The file (if not present
5465 or @code{nil}) defaults to @code{org-default-notes-file}, the heading to
5466 @code{org-remember-default-headline}.  If the file name is not an absolute
5467 path, it will be interpreted relative to @code{org-directory}.  The heading
5468 can also be the symbols @code{top} or @code{bottom} to send note as level 1
5469 entries to the beginning or end of the file, respectively.
5471 An optional sixth element specifies the contexts in which the user can select
5472 the template.  This element can be a list of major modes or a function.
5473 @code{org-remember} will first check whether the function returns @code{t} or
5474 if we are in any of the listed major mode, and exclude templates for which
5475 this condition is not fulfilled.  Templates that do not specify this element
5476 at all, or that use @code{nil} or @code{t} as a value will always be
5477 selectable.
5479 So for example:
5481 @example
5482 (setq org-remember-templates
5483  '(("Bug" ?b "* BUG %?\n  %i\n  %a" "~/org/BUGS.org" "Bugs" (emacs-lisp-mode))
5484    ("Journal" ?j "* %U %?\n\n  %i\n  %a" "~/org/JOURNAL.org" "X" my-check)
5485    ("Idea" ?i "* %^@{Title@}\n  %i\n  %a" "~/org/JOURNAL.org" "New Ideas")))
5486 @end example
5488 The first template will only be available when invoking @code{org-remember}
5489 from an buffer in @code{emacs-lisp-mode}.  The second template will only be
5490 available when the function @code{my-check} returns @code{t}.  The third
5491 template will be proposed in any context.
5493 When you call @kbd{M-x org-remember} (or @kbd{M-x remember}) to remember
5494 something, Org will prompt for a key to select the template (if you have
5495 more than one template) and then prepare the buffer like
5496 @example
5497 * TODO
5498   [[file:link to where you called remember]]
5499 @end example
5501 @noindent
5502 During expansion of the template, special @kbd{%}-escapes allow dynamic
5503 insertion of content:
5504 @example
5505 %^@{prompt@}  @r{prompt the user for a string and replace this sequence with it.}
5506             @r{You may specify a default value and a completion table with}
5507             @r{%^@{prompt|default|completion2|completion3...@}}
5508             @r{The arrow keys access a prompt-specific history.}
5509 %a          @r{annotation, normally the link created with @code{org-store-link}}
5510 %A          @r{like @code{%a}, but prompt for the description part}
5511 %i          @r{initial content, the region when remember is called with C-u.}
5512             @r{The entire text will be indented like @code{%i} itself.}
5513 %t          @r{time stamp, date only}
5514 %T          @r{time stamp with date and time}
5515 %u, %U      @r{like the above, but inactive time stamps}
5516 %^t         @r{like @code{%t}, but prompt for date.  Similarly @code{%^T}, @code{%^u}, @code{%^U}}
5517             @r{You may define a prompt like @code{%^@{Birthday@}t}}
5518 %n          @r{user name (taken from @code{user-full-name})}
5519 %c          @r{Current kill ring head.}
5520 %x          @r{Content of the X clipboard.}
5521 %^C         @r{Interactive selection of which kill or clip to use.}
5522 %^L         @r{Like @code{%^C}, but insert as link.}
5523 %^g         @r{prompt for tags, with completion on tags in target file.}
5524 %k          @r{title of currently clocked task}
5525 %K          @r{link to currently clocked task}
5526 %^G         @r{prompt for tags, with completion all tags in all agenda files.}
5527 %^@{prop@}p   @r{Prompt the user for a value for property @code{prop}}
5528 %:keyword   @r{specific information for certain link types, see below}
5529 %[pathname] @r{insert the contents of the file given by @code{pathname}}
5530 %(sexp)     @r{evaluate elisp @code{(sexp)} and replace with the result}
5531 %!          @r{immediately store note after completing the template}
5532             @r{(skipping the @kbd{C-c C-c} that normally triggers storing)}
5533 %&          @r{jump to target location immediately after storing note}
5534 @end example
5536 @noindent
5537 For specific link types, the following keywords will be
5538 defined@footnote{If you define your own link types (@pxref{Adding
5539 hyperlink types}), any property you store with
5540 @code{org-store-link-props} can be accessed in remember templates in a
5541 similar way.}:
5543 @vindex org-from-is-user-regexp
5544 @example
5545 Link type          |  Available keywords
5546 -------------------+----------------------------------------------
5547 bbdb               |  %:name %:company
5548 bbdb               |  %::server %:port %:nick
5549 vm, wl, mh, rmail  |  %:type %:subject %:message-id
5550                    |  %:from %:fromname %:fromaddress
5551                    |  %:to   %:toname   %:toaddress
5552                    |  %: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}.}}
5553 gnus               |  %:group, @r{for messages also all email fields}
5554 w3, w3m            |  %:url
5555 info               |  %:file %:node
5556 calendar           |  %:date"
5557 @end example
5559 @noindent
5560 To place the cursor after template expansion use:
5562 @example
5563 %?          @r{After completing the template, position cursor here.}
5564 @end example
5566 @noindent
5567 If you change your mind about which template to use, call
5568 @code{org-remember} in the remember buffer.  You may then select a new
5569 template that will be filled with the previous context information.
5571 @node Storing notes, Refiling notes, Remember templates, Remember
5572 @subsection Storing notes
5574 @vindex org-remember-clock-out-on-exit
5575 When you are finished preparing a note with @i{remember}, you have to press
5576 @kbd{C-c C-c} to file the note away.  If you have started the clock in the
5577 remember buffer, you will first be asked if you want to clock out
5578 now@footnote{To avoid this query, configure the variable
5579 @code{org-remember-clock-out-on-exit}.}.  If you answer @kbd{n}, the clock
5580 will continue to run after the note was filed away.
5582 The handler will then store the note in the file and under the headline
5583 specified in the template, or it will use the default file and headlines.
5584 The window configuration will be restored, sending you back to the working
5585 context before the call to @code{remember}.  To re-use the location found
5586 during the last call to @code{remember}, exit the remember buffer with
5587 @kbd{C-0 C-c C-c}, i.e. specify a zero prefix argument to @kbd{C-c C-c}.
5588 Another special case is @kbd{C-2 C-c C-c} which files the note as a child of
5589 the currently clocked item.
5591 @vindex org-remember-store-without-prompt
5592 If you want to store the note directly to a different place, use
5593 @kbd{C-1 C-c C-c} instead to exit remember@footnote{Configure the
5594 variable @code{org-remember-store-without-prompt} to make this behavior
5595 the default.}.  The handler will then first prompt for a target file -
5596 if you press @key{RET}, the value specified for the template is used.
5597 Then the command offers the headings tree of the selected file, with the
5598 cursor position at the default headline (if you had specified one in the
5599 template).  You can either immediately press @key{RET} to get the note
5600 placed there.  Or you can use the following keys to find a different
5601 location:
5602 @example
5603 @key{TAB}         @r{Cycle visibility.}
5604 @key{down} / @key{up}   @r{Next/previous visible headline.}
5605 n / p        @r{Next/previous visible headline.}
5606 f / b        @r{Next/previous headline same level.}
5607 u            @r{One level up.}
5608 @c 0-9          @r{Digit argument.}
5609 @end example
5610 @noindent
5611 Pressing @key{RET} or @key{left} or @key{right}
5612 then leads to the following result.
5614 @vindex org-reverse-note-order
5615 @multitable @columnfractions 0.2 0.15 0.65
5616 @item @b{Cursor position} @tab @b{Key} @tab @b{Note gets inserted}
5617 @item on headline     @tab @key{RET}              @tab as sublevel of the heading at cursor, first or last
5618 @item                 @tab                        @tab depending on @code{org-reverse-note-order}.
5619 @item                 @tab @key{left}/@key{right} @tab as same level, before/after current heading
5620 @item buffer-start    @tab @key{RET} @tab as level 2 heading at end of file or level 1 at beginning
5621 @item                 @tab @tab depending on @code{org-reverse-note-order}.
5622 @item not on headline @tab @key{RET}
5623       @tab at cursor position, level taken from context.
5624 @end multitable
5626 Before inserting the text into a tree, the function ensures that the text has
5627 a headline, i.e. a first line that starts with a @samp{*}.  If not, a
5628 headline is constructed from the current date.  If you have indented the text
5629 of the note below the headline, the indentation will be adapted if inserting
5630 the note into the tree requires demotion from level 1.
5632 @node Refiling notes,  , Storing notes, Remember
5633 @subsection Refiling notes
5634 @cindex refiling notes
5636 Remember is usually used to quickly capture notes and tasks into one or
5637 a few capture lists.  When reviewing the captured data, you may want to
5638 refile some of the entries into a different list, for example into a
5639 project.  Cutting, finding the right location and then pasting the note
5640 is cumbersome.  To simplify this process, you can use the following
5641 special command:
5643 @table @kbd
5644 @kindex C-c C-w
5645 @item C-c C-w
5646 @vindex org-reverse-note-order
5647 @vindex org-refile-targets
5648 @vindex org-refile-use-outline-path
5649 @vindex org-outline-path-complete-in-steps
5650 @vindex org-refile-allow-creating-parent-nodes
5651 Refile the entry or region at point.  This command offers possible locations
5652 for refiling the entry and lets you select one with completion.  The item (or
5653 all items in the region) is filed below the target heading as a subitem.
5654 Depending on @code{org-reverse-note-order}, it will be either the first or
5655 last subitem.@*
5656 By default, all level 1 headlines in the current buffer are considered to be
5657 targets, but you can have more complex definitions across a number of files.
5658 See the variable @code{org-refile-targets} for details.  If you would like to
5659 select a location via a file-path-like completion along the outline path, see
5660 the variables @code{org-refile-use-outline-path} and
5661 @code{org-outline-path-complete-in-steps}.  If you would like to be able to
5662 create new nodes as new parents for for refiling on the fly, check the
5663 variable @code{org-refile-allow-creating-parent-nodes}.
5664 @kindex C-u C-c C-w
5665 @item C-u C-c C-w
5666 Use the refile interface to jump to a heading.
5667 @kindex C-u C-u C-c C-w
5668 @item C-u C-u C-c C-w
5669 Jump to the location where @code{org-refile} last moved a tree to.
5670 @end table
5673 @node Attachments, RSS Feeds, Remember, Capture
5674 @section Attachments
5675 @cindex attachments
5677 @vindex org-attach-directory
5678 It is often useful to associate reference material with an outline node/task.
5679 Small chunks of plain text can simply be stored in the subtree of a project.
5680 Hyperlinks (@pxref{Hyperlinks}) can be used to establish associations with
5681 files that live elsewhere on your computer or in the cloud, like emails or
5682 source code files belonging to a project.  Another method is @i{attachments},
5683 which are files located in a directory belonging to an outline node.  Org
5684 uses directories named by the unique ID of each entry.  These directories are
5685 located in the @file{data} directory which lives in the same directory where
5686 your org-file lives@footnote{If you move entries or Org-files from one
5687 directory to the next, you may want to configure @code{org-attach-directory}
5688 to contain an absolute path.}.  If you initialize this directory with
5689 @code{git init}, Org will automatically commit changes when it sees them.
5690 The attachment system has been contributed to Org by John Wiegley.
5692 In cases where this seems better, you can also attach a directory of your
5693 choice to an entry.  You can also make children inherit the attachment
5694 directory from a parent, so that an entire subtree uses the same attached
5695 directory.
5697 @noindent The following commands deal with attachments.
5699 @table @kbd
5701 @kindex C-c C-a
5702 @item C-c C-a
5703 The dispatcher for commands related to the attachment system.  After these
5704 keys, a list of commands is displayed and you need to press an additional key
5705 to select a command:
5707 @table @kbd
5708 @kindex C-c C-a a
5709 @item a
5710 @vindex org-attach-method
5711 Select a file and move it into the task's attachment directory.  The file
5712 will be copied, moved, or linked, depending on @code{org-attach-method}.
5713 Note that hard links are not supported on all systems.
5715 @kindex C-c C-a c
5716 @kindex C-c C-a m
5717 @kindex C-c C-a l
5718 @item c/m/l
5719 Attach a file using the copy/move/link method.
5720 Note that hard links are not supported on all systems.
5722 @kindex C-c C-a n
5723 @item n
5724 Create a new attachment as an Emacs buffer.
5726 @kindex C-c C-a z
5727 @item z
5728 Synchronize the current task with its attachment directory, in case you added
5729 attachments yourself.
5731 @kindex C-c C-a o
5732 @item o
5733 @vindex org-file-apps
5734 Open current task's attachment.  If there are more than one, prompt for a
5735 file name first.  Opening will follow the rules set by @code{org-file-apps}.
5736 For more details, see the information on following hyperlinks
5737 (@pxref{Handling links}).
5739 @kindex C-c C-a O
5740 @item O
5741 Also open the attachment, but force opening the file in Emacs.
5743 @kindex C-c C-a f
5744 @item f
5745 Open the current task's attachment directory.
5747 @kindex C-c C-a F
5748 @item F
5749 Also open the directory, but force using @code{dired} in Emacs.
5751 @kindex C-c C-a d
5752 @item d
5753 Select and delete a single attachment.
5755 @kindex C-c C-a D
5756 @item D
5757 Delete all of a task's attachments.  A safer way is to open the directory in
5758 dired and delete from there.
5760 @kindex C-c C-a s
5761 @item C-c C-a s
5762 Set a specific directory as the entry's attachment directory.  This works by
5763 putting the directory path into the @code{ATTACH_DIR} property.
5765 @kindex C-c C-a i
5766 @item C-c C-a i
5767 Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
5768 same directory for attachments as the parent.
5769 @end table
5770 @end table
5772 @node RSS Feeds, Protocols, Attachments, Capture
5773 @section RSS feeds
5774 @cindex RSS feeds
5776 Org has the capablity to add and change entries based on information found in
5777 RSS feeds.  You could use this to make a task out of each new podcast in a
5778 podcast feed.  Or you could use a phone-based note-creating service on the
5779 web to import tasks into Org.  To access feeds, you need to configure the
5780 variable @code{org-feed-alist}.  The docstring of this variable has detailed
5781 information.  Here is just an example:
5783 @example
5784 (setq org-feed-alist
5785       '(("ReQall" "http://www.reqall.com/user/feeds/rss/a1b2c3....."
5786          "~/org/feeds.org" "ReQall Entries")
5787 @end example
5789 will configure that new items from the feed provided by @file{reqall.com}
5790 will result in new entries in the file @file{~/org/feeds.org} under the
5791 heading @samp{ReQall Entries}, whenever the following command is used:
5793 @table @kbd
5794 @kindex C-c C-x g
5795 @item C-c C-x g
5796 Collect items from the feeds configured in @code{org-feed-alist} and act upon
5797 them.
5798 @kindex C-c C-x G
5799 @item C-c C-x G
5800 Prompt for a feed name and go to the inbox configured for this feed.
5801 @end table
5803 Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which
5804 it will store information about the status of items in the feed, to avoid
5805 adding the same item several times.  You should add @samp{FEEDSTATUS} to the
5806 list of drawers in that file:
5808 @example
5809 #+DRAWERS: LOGBOOK PROPERTIES FEEDSTATUS
5810 @end example
5812 For more information, see @file{org-feed.el} and the docstring of
5813 @code{org-feed-alist}.
5815 @node Protocols,  , RSS Feeds, Capture
5816 @section Protocols for external access
5817 @cindex protocols, for external access
5818 @cindex emacsserver
5820 You can set up Org for handling protocol calls from outside applications that
5821 are passed to Emacs through the @file{emacsserver}.  For example, you can
5822 configure bookmarks in your webbrowser to send a link to the current page to
5823 Org and create a note from it using remember (@pxref{Remember}).  Or you
5824 could create a bookmark that will tell Emacs to open the local source file of
5825 a remote website you are looking at with the browser.  See
5826 @uref{http://orgmode.org/worg/org-contrib/org-protocol.php} for detailed
5827 documentation and setup instructions.
5830 @node Agenda Views, Embedded LaTeX, Capture, Top
5831 @chapter Agenda Views
5832 @cindex agenda views
5834 Due to the way Org works, TODO items, time-stamped items, and
5835 tagged headlines can be scattered throughout a file or even a number of
5836 files.  To get an overview of open action items, or of events that are
5837 important for a particular date, this information must be collected,
5838 sorted and displayed in an organized way.
5840 Org can select items based on various criteria, and display them
5841 in a separate buffer.  Seven different view types are provided:
5843 @itemize @bullet
5844 @item
5845 an @emph{agenda} that is like a calendar and shows information
5846 for specific dates,
5847 @item
5848 a @emph{TODO list} that covers all unfinished
5849 action items,
5850 @item
5851 a @emph{match view}, showings headlines based on the tags, properties and
5852 TODO state associated with them,
5853 @item
5854 a @emph{timeline view} that shows all events in a single Org file,
5855 in time-sorted view,
5856 @item
5857 a @emph{keyword search view} that shows all entries from multiple files
5858 that contain specified keywords.
5859 @item
5860 a @emph{stuck projects view} showing projects that currently don't move
5861 along, and
5862 @item
5863 @emph{custom views} that are special tag/keyword searches and
5864 combinations of different views.
5865 @end itemize
5867 @noindent
5868 The extracted information is displayed in a special @emph{agenda
5869 buffer}.  This buffer is read-only, but provides commands to visit the
5870 corresponding locations in the original Org files, and even to
5871 edit these files remotely.
5873 @vindex org-agenda-window-setup
5874 @vindex org-agenda-restore-windows-after-quit
5875 Two variables control how the agenda buffer is displayed and whether the
5876 window configuration is restored when the agenda exits:
5877 @code{org-agenda-window-setup} and
5878 @code{org-agenda-restore-windows-after-quit}.
5880 @menu
5881 * Agenda files::                Files being searched for agenda information
5882 * Agenda dispatcher::           Keyboard access to agenda views
5883 * Built-in agenda views::       What is available out of the box?
5884 * Presentation and sorting::    How agenda items are prepared for display
5885 * Agenda commands::             Remote editing of Org trees
5886 * Custom agenda views::         Defining special searches and views
5887 * Exporting Agenda Views::      
5888 * Agenda column view::          Using column view for collected entries
5889 @end menu
5891 @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views
5892 @section Agenda files
5893 @cindex agenda files
5894 @cindex files for agenda
5896 @vindex org-agenda-files
5897 The information to be shown is normally collected from all @emph{agenda
5898 files}, the files listed in the variable
5899 @code{org-agenda-files}@footnote{If the value of that variable is not a
5900 list, but a single file name, then the list of agenda files will be
5901 maintained in that external file.}. If a directory is part of this list,
5902 all files with the extension @file{.org} in this directory will be part
5903 of the list.
5905 Thus even if you only work with a single Org file, this file should
5906 be put into that list@footnote{When using the dispatcher, pressing
5907 @kbd{<} before selecting a command will actually limit the command to
5908 the current file, and ignore @code{org-agenda-files} until the next
5909 dispatcher command.}.  You can customize @code{org-agenda-files}, but
5910 the easiest way to maintain it is through the following commands
5912 @cindex files, adding to agenda list
5913 @table @kbd
5914 @kindex C-c [
5915 @item C-c [
5916 Add current file to the list of agenda files.  The file is added to
5917 the front of the list.  If it was already in the list, it is moved to
5918 the front.  With a prefix argument, file is added/moved to the end.
5919 @kindex C-c ]
5920 @item C-c ]
5921 Remove current file from the list of agenda files.
5922 @kindex C-,
5923 @kindex C-'
5924 @item C-,
5925 @itemx C-'
5926 Cycle through agenda file list, visiting one file after the other.
5927 @kindex M-x org-iswitchb
5928 @item M-x org-iswitchb
5929 Command to use an @code{iswitchb}-like interface to switch to and between Org
5930 buffers.
5931 @end table
5933 @noindent
5934 The Org menu contains the current list of files and can be used
5935 to visit any of them.
5937 If you would like to focus the agenda temporarily onto a file not in
5938 this list, or onto just one file in the list or even only a subtree in a
5939 file, this can be done in different ways.  For a single agenda command,
5940 you may press @kbd{<} once or several times in the dispatcher
5941 (@pxref{Agenda dispatcher}).  To restrict the agenda scope for an
5942 extended period, use the following commands:
5944 @table @kbd
5945 @kindex C-c C-x <
5946 @item C-c C-x <
5947 Permanently restrict the agenda to the current subtree.  When with a
5948 prefix argument, or with the cursor before the first headline in a file,
5949 the agenda scope is set to the entire file.  This restriction remains in
5950 effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
5951 or @kbd{>} in the agenda dispatcher.  If there is a window displaying an
5952 agenda view, the new restriction takes effect immediately.
5953 @kindex C-c C-x >
5954 @item C-c C-x >
5955 Remove the permanent restriction created by @kbd{C-c C-x <}.
5956 @end table
5958 @noindent
5959 When working with @file{Speedbar}, you can use the following commands in
5960 the Speedbar frame:
5961 @table @kbd
5962 @kindex <
5963 @item < @r{in the speedbar frame}
5964 Permanently restrict the agenda to the item at the cursor in the
5965 Speedbar frame, either an Org file or a subtree in such a file.
5966 If there is a window displaying an agenda view, the new restriction takes
5967 effect immediately.
5968 @kindex >
5969 @item > @r{in the speedbar frame}
5970 Lift the restriction again.
5971 @end table
5973 @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views
5974 @section The agenda dispatcher
5975 @cindex agenda dispatcher
5976 @cindex dispatching agenda commands
5977 The views are created through a dispatcher that should be bound to a
5978 global key, for example @kbd{C-c a} (@pxref{Installation}).  In the
5979 following we will assume that @kbd{C-c a} is indeed how the dispatcher
5980 is accessed and list keyboard access to commands accordingly.  After
5981 pressing @kbd{C-c a}, an additional letter is required to execute a
5982 command.  The dispatcher offers the following default commands:
5983 @table @kbd
5984 @item a
5985 Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
5986 @item t @r{/} T
5987 Create a list of all TODO items (@pxref{Global TODO list}).
5988 @item m @r{/} M
5989 Create a list of headlines matching a TAGS expression (@pxref{Matching
5990 tags and properties}).
5991 @item L
5992 Create the timeline view for the current buffer (@pxref{Timeline}).
5993 @item s
5994 Create a list of entries selected by a boolean expression of keywords
5995 and/or regular expressions that must or must not occur in the entry.
5996 @item /
5997 @vindex org-agenda-text-search-extra-files
5998 Search for a regular expression in all agenda files and additionally in
5999 the files listed in @code{org-agenda-text-search-extra-files}.  This
6000 uses the Emacs command @code{multi-occur}.  A prefix argument can be
6001 used to specify the number of context lines for each match, default is
6003 @item # @r{/} !
6004 Create a list of stuck projects (@pxref{Stuck projects}).
6005 @item <
6006 Restrict an agenda command to the current buffer@footnote{For backward
6007 compatibility, you can also press @kbd{1} to restrict to the current
6008 buffer.}.  After pressing @kbd{<}, you still need to press the character
6009 selecting the command.
6010 @item < <
6011 If there is an active region, restrict the following agenda command to
6012 the region.  Otherwise, restrict it to the current subtree@footnote{For
6013 backward compatibility, you can also press @kbd{0} to restrict to the
6014 current buffer.}.  After pressing @kbd{< <}, you still need to press the
6015 character selecting the command.
6016 @end table
6018 You can also define custom commands that will be accessible through the
6019 dispatcher, just like the default commands.  This includes the
6020 possibility to create extended agenda buffers that contain several
6021 blocks together, for example the weekly agenda, the global TODO list and
6022 a number of special tags matches.  @xref{Custom agenda views}.
6024 @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda Views
6025 @section The built-in agenda views
6027 In this section we describe the built-in views.
6029 @menu
6030 * Weekly/daily agenda::         The calendar page with current tasks
6031 * Global TODO list::            All unfinished action items
6032 * Matching tags and properties::  Structured information with fine-tuned search
6033 * Timeline::                    Time-sorted view for single file
6034 * Keyword search::              Finding entries by keyword
6035 * Stuck projects::              Find projects you need to review
6036 @end menu
6038 @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views
6039 @subsection The weekly/daily agenda
6040 @cindex agenda
6041 @cindex weekly agenda
6042 @cindex daily agenda
6044 The purpose of the weekly/daily @emph{agenda} is to act like a page of a
6045 paper agenda, showing all the tasks for the current week or day.
6047 @table @kbd
6048 @cindex org-agenda, command
6049 @kindex C-c a a
6050 @item C-c a a
6051 @vindex org-agenda-ndays
6052 Compile an agenda for the current week from a list of org files.  The agenda
6053 shows the entries for each day.  With a numeric prefix@footnote{For backward
6054 compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
6055 listed before the agenda.  This feature is deprecated, use the dedicated TODO
6056 list, or a block agenda instead (@pxref{Block agenda}).}  (like @kbd{C-u 2 1
6057 C-c a a}) you may set the number of days to be displayed (see also the
6058 variable @code{org-agenda-ndays})
6059 @end table
6061 Remote editing from the agenda buffer means, for example, that you can
6062 change the dates of deadlines and appointments from the agenda buffer.
6063 The commands available in the Agenda buffer are listed in @ref{Agenda
6064 commands}.
6066 @subsubheading Calendar/Diary integration
6067 @cindex calendar integration
6068 @cindex diary integration
6070 Emacs contains the calendar and diary by Edward M. Reingold.  The
6071 calendar displays a three-month calendar with holidays from different
6072 countries and cultures.  The diary allows you to keep track of
6073 anniversaries, lunar phases, sunrise/set, recurrent appointments
6074 (weekly, monthly) and more.  In this way, it is quite complementary to
6075 Org.  It can be very useful to combine output from Org with
6076 the diary.
6078 In order to include entries from the Emacs diary into Org mode's
6079 agenda, you only need to customize the variable
6081 @lisp
6082 (setq org-agenda-include-diary t)
6083 @end lisp
6085 @noindent After that, everything will happen automatically.  All diary
6086 entries including holidays, anniversaries etc will be included in the
6087 agenda buffer created by Org mode.  @key{SPC}, @key{TAB}, and
6088 @key{RET} can be used from the agenda buffer to jump to the diary
6089 file in order to edit existing diary entries.  The @kbd{i} command to
6090 insert new entries for the current date works in the agenda buffer, as
6091 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
6092 Sunrise/Sunset times, show lunar phases and to convert to other
6093 calendars, respectively.  @kbd{c} can be used to switch back and forth
6094 between calendar and agenda.
6096 If you are using the diary only for sexp entries and holidays, it is
6097 faster to not use the above setting, but instead to copy or even move
6098 the entries into an Org file. Org mode evaluates diary-style sexp
6099 entries, and does it faster because there is no overhead for first
6100 creating the diary display.  Note that the sexp entries must start at
6101 the left margin, no white space is allowed before them.  For example,
6102 the following segment of an Org file will be processed and entries
6103 will be made in the agenda:
6105 @example
6106 * Birthdays and similar stuff
6107 #+CATEGORY: Holiday
6108 %%(org-calendar-holiday)   ; special function for holiday names
6109 #+CATEGORY: Ann
6110 %%(diary-anniversary 14  5 1956) Arthur Dent is %d years old
6111 %%(diary-anniversary  2 10 1869) Mahatma Gandhi would be %d years old
6112 @end example
6114 @subsubheading Anniversaries from BBDB
6115 @cindex BBDB, anniversaries
6116 @cindex anniversaries, from BBDB
6118 If you are using the Big Brothers Database to store your contacts, you will
6119 very likely prefer to store anniversaries in BBDB rather than in a
6120 separate Org or diary file.  Org supports this and will show BBDB
6121 anniversaries as part of the agenda.  All you need to do is to add the
6122 following to one your your agenda files:
6124 @example
6125 * Anniversaries
6126   :PROPERTIES:
6127   :CATEGORY: Anniv
6128   :END
6129 %%(org-bbdb-anniversaries)
6130 @end example
6132 You can then go ahead and define anniversaries for a BBDB record.  Basically,
6133 you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB
6134 record and then add the date in the format @code{YYYY-MM-DD}, followed by a
6135 space and the class of the anniversary (@samp{birthday} or @samp{wedding}, or
6136 a format string).  If you omit the class, it will default to @samp{birthday}.
6137 Here are a few examples, the header for the file @file{org-bbdb.el} contains
6138 more detailed information.
6140 @example
6141 1973-06-22
6142 1955-08-02 wedding
6143 2008-04-14 %s released version 6.01 of Org-mode, %d years ago
6144 @end example
6146 After a change to BBDB, or for the first agenda display during an Emacs
6147 session, the agenda display will suffer a short delay as Org updates it's
6148 hash with anniversaries.  However, from then on things will be very fast -
6149 much faster in fact than a long list of @samp{%%(diary-anniversary)} entries
6150 in an Org or Diary file.
6152 @subsubheading Appointment reminders
6153 @cindex @file{appt.el}
6154 @cindex appointment reminders
6156 Org can interact with Emacs appointments notification facility.  To add all
6157 the appointments of your agenda files, use the command
6158 @code{org-agenda-to-appt}.  This commands also lets you filter through the
6159 list of your appointments and add only those belonging to a specific category
6160 or matching a regular expression. See the docstring for details.
6162 @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views
6163 @subsection The global TODO list
6164 @cindex global TODO list
6165 @cindex TODO list, global
6167 The global TODO list contains all unfinished TODO items, formatted and
6168 collected into a single place.
6170 @table @kbd
6171 @kindex C-c a t
6172 @item C-c a t
6173 Show the global TODO list.  This collects the TODO items from all
6174 agenda files (@pxref{Agenda Views}) into a single buffer.  The buffer is in
6175 @code{agenda-mode}, so there are commands to examine and manipulate
6176 the TODO entries directly from that buffer (@pxref{Agenda commands}).
6177 @kindex C-c a T
6178 @item C-c a T
6179 @cindex TODO keyword matching
6180 @vindex org-todo-keywords
6181 Like the above, but allows selection of a specific TODO keyword.  You
6182 can also do this by specifying a prefix argument to @kbd{C-c a t}.  With
6183 a @kbd{C-u} prefix you are prompted for a keyword, and you may also
6184 specify several keywords by separating them with @samp{|} as boolean OR
6185 operator.  With a numeric prefix, the Nth keyword in
6186 @code{org-todo-keywords} is selected.
6187 @kindex r
6188 The @kbd{r} key in the agenda buffer regenerates it, and you can give
6189 a prefix argument to this command to change the selected TODO keyword,
6190 for example @kbd{3 r}.  If you often need a search for a specific
6191 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
6192 Matching specific TODO keywords can also be done as part of a tags
6193 search (@pxref{Tag searches}).
6194 @end table
6196 Remote editing of TODO items means that you can change the state of a
6197 TODO entry with a single key press.  The commands available in the
6198 TODO list are described in @ref{Agenda commands}.
6200 @cindex sublevels, inclusion into TODO list
6201 Normally the global TODO list simply shows all headlines with TODO
6202 keywords.  This list can become very long.  There are two ways to keep
6203 it more compact:
6204 @itemize @minus
6205 @item
6206 @vindex org-agenda-todo-ignore-scheduled
6207 @vindex org-agenda-todo-ignore-deadlines
6208 @vindex org-agenda-todo-ignore-with-date
6209 Some people view a TODO item that has been @emph{scheduled} for execution or
6210 have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}
6211 Configure the variables @code{org-agenda-todo-ignore-scheduled},
6212 @code{org-agenda-todo-ignore-deadlines}, and/or
6213 @code{org-agenda-todo-ignore-with-date} to exclude such items from the
6214 global TODO list.
6215 @item
6216 @vindex org-agenda-todo-list-sublevels
6217 TODO items may have sublevels to break up the task into subtasks.  In
6218 such cases it may be enough to list only the highest level TODO headline
6219 and omit the sublevels from the global list.  Configure the variable
6220 @code{org-agenda-todo-list-sublevels} to get this behavior.
6221 @end itemize
6223 @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views
6224 @subsection Matching tags and properties
6225 @cindex matching, of tags
6226 @cindex matching, of properties
6227 @cindex tags view
6228 @cindex match view
6230 If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}),
6231 or have properties @pxref{Properties and Columns}, you can select headlines
6232 based on this meta data and collect them into an agenda buffer.  The match
6233 syntax described here also applies when creating sparse trees with @kbd{C-c /
6236 @table @kbd
6237 @kindex C-c a m
6238 @item C-c a m
6239 Produce a list of all headlines that match a given set of tags.  The
6240 command prompts for a selection criterion, which is a boolean logic
6241 expression with tags, like @samp{+work+urgent-withboss} or
6242 @samp{work|home} (@pxref{Tags}).  If you often need a specific search,
6243 define a custom command for it (@pxref{Agenda dispatcher}).
6244 @kindex C-c a M
6245 @item C-c a M
6246 @vindex org-tags-match-list-sublevels
6247 @vindex org-agenda-tags-todo-honor-ignore-options
6248 Like @kbd{C-c a m}, but only select headlines that are also TODO items and
6249 force checking subitems (see variable @code{org-tags-match-list-sublevels}).
6250 To exclude scheduled/deadline items, see the variable
6251 @code{org-agenda-tags-todo-honor-ignore-options}.  Matching specific TODO
6252 keywords together with a tags match is also possible, see @ref{Tag searches}.
6253 @end table
6255 The commands available in the tags list are described in @ref{Agenda
6256 commands}.
6258 @subsubheading Match syntax
6260 @cindex Boolean logic, for tag/property searches
6261 A search string can use Boolean operators @samp{&} for AND and @samp{|} for
6262 OR.  @samp{&} binds more strongly than @samp{|}.  Parenthesis are currently
6263 not implemented.  Each element in the search is either a tag, a regular
6264 expression matching tags, or an expression like @code{PROPERTY OPERATOR
6265 VALUE} with a comparison operator, accessing a property value.  Each element
6266 may be preceded by @samp{-}, to select against it, and @samp{+} is syntactic
6267 sugar for positive selection.  The AND operator @samp{&} is optional when
6268 @samp{+} or @samp{-} is present.  Here are some examples, using only tags.
6270 @table @samp
6271 @item +work-boss
6272 Select headlines tagged @samp{:work:}, but discard those also tagged
6273 @samp{:boss:}.
6274 @item work|laptop
6275 Selects lines tagged @samp{:work:} or @samp{:laptop:}.
6276 @item work|laptop+night
6277 Like before, but require the @samp{:laptop:} lines to be tagged also
6278 @samp{:night:}.
6279 @end table
6281 @cindex regular expressions, with tags search
6282 Instead of a tag, you may also specify a regular expression enclosed in curly
6283 braces.  For example,
6284 @samp{work+@{^boss.*@}} matches headlines that contain the tag
6285 @samp{:work:} and any tag @i{starting} with @samp{boss}.
6287 @cindex TODO keyword matching, with tags search
6288 @cindex level, require for tags/property match
6289 @cindex category, require for tags/property match
6290 @vindex org-odd-levels-only
6291 You may also test for properties (@pxref{Properties and Columns}) at the same
6292 time as matching tags.  The properties may be real properties, or special
6293 properties that represent other meta data (@pxref{Special properties}).  For
6294 example, the ``property'' @code{TODO} represents the TODO keyword of the
6295 entry.  Or, the ``property'' @code{LEVEL} represents the level of an entry.
6296 So a search @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines
6297 that have the tag @samp{boss} and are @emph{not} marked with the TODO keyword
6298 DONE.  In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not
6299 count the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc.
6301 Here are more examples:
6302 @table @samp
6303 @item work+TODO="WAITING"
6304 Select @samp{:work:}-tagged TODO lines with the specific TODO
6305 keyword @samp{WAITING}.
6306 @item work+TODO="WAITING"|home+TODO="WAITING"
6307 Waiting tasks both at work and at home.
6308 @end table
6310 When matching properties, a number of different operators can be used to test
6311 the value of a property.  Here is a complex example:
6313 @example
6314 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2         \
6315          +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
6316 @end example
6318 @noindent
6319 The type of comparison will depend on how the comparison value is written:
6320 @itemize @minus
6321 @item
6322 If the comparison value is a plain number, a numerical comparison is done,
6323 and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
6324 @samp{>=}, and @samp{<>}.
6325 @item
6326 If the comparison value is enclosed in double
6327 quotes, a string comparison is done, and the same operators are allowed.
6328 @item
6329 If the comparison value is enclosed in double quotes @emph{and} angular
6330 brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
6331 assumed to be date/time specifications in the standard Org way, and the
6332 comparison will be done accordingly.  Special values that will be recognized
6333 are @code{"<now>"} for now (including time), and @code{"<today>"}, and
6334 @code{"<tomorrow>"} for these days at 0:00 hours, i.e. without a time
6335 specification.  Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
6336 @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
6337 respectively, can be used.
6338 @item
6339 If the comparison value is enclosed
6340 in curly braces, a regexp match is performed, with @samp{=} meaning that the
6341 regexp matches the property value, and @samp{<>} meaning that it does not
6342 match.
6343 @end itemize
6345 So the search string in the example finds entries tagged @samp{:work:} but
6346 not @samp{:boss:}, which also have a priority value @samp{A}, a
6347 @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
6348 property that is numerically smaller than 2, a @samp{:With:} property that is
6349 matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
6350 on or after October 11, 2008.
6352 Accessing TODO, LEVEL, and CATEGORY during a search is fast.  Accessing any
6353 other properties will slow down the search.  However, once you have payed the
6354 price by accessing one property, testing additional properties is cheap
6355 again.
6357 You can configure Org mode to use property inheritance during a search, but
6358 beware that this can slow down searches considerably.  See @ref{Property
6359 inheritance} for details.
6361 For backward compatibility, and also for typing speed, there is also a
6362 different way to test TODO states in a search.  For this, terminalte the
6363 tags/property part of the search string (which may include several terms
6364 connected with @samp{|}) with a @samp{/} and then specify a Boolean
6365 expression just for TODO keywords.  The syntax is then similar to that for
6366 tags, but should be applied with consideration: For example, a positive
6367 selection on several TODO keywords can not meaningfully be combined with
6368 boolean AND.  However, @emph{negative selection} combined with AND can be
6369 meaningful.  To make sure that only lines are checked that actually have any
6370 TODO keyword (resulting in a speed-up), use @kbd{C-c a M}, or equivalently
6371 start the TODO part after the slash with @samp{!}.  Examples:
6373 @table @samp
6374 @item work/WAITING
6375 Same as @samp{work+TODO="WAITING"}
6376 @item work/!-WAITING-NEXT
6377 Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
6378 nor @samp{NEXT}
6379 @item work/!+WAITING|+NEXT
6380 Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
6381 @samp{NEXT}.
6382 @end table
6384 @node Timeline, Keyword search, Matching tags and properties, Built-in agenda views
6385 @subsection Timeline for a single file
6386 @cindex timeline, single file
6387 @cindex time-sorted view
6389 The timeline summarizes all time-stamped items from a single Org mode
6390 file in a @emph{time-sorted view}.  The main purpose of this command is
6391 to give an overview over events in a project.
6393 @table @kbd
6394 @kindex C-c a L
6395 @item C-c a L
6396 Show a time-sorted view of the org file, with all time-stamped items.
6397 When called with a @kbd{C-u} prefix, all unfinished TODO entries
6398 (scheduled or not) are also listed under the current date.
6399 @end table
6401 @noindent
6402 The commands available in the timeline buffer are listed in
6403 @ref{Agenda commands}.
6405 @node Keyword search, Stuck projects, Timeline, Built-in agenda views
6406 @subsection Keyword search
6407 @cindex keyword search
6408 @cindex searching, for keywords
6410 This agenda view is a general text search facility for Org mode entries.
6411 It is particularly useful to find notes.
6413 @table @kbd
6414 @kindex C-c a s
6415 @item C-c a s
6416 This is a special search that lets you select entries by keywords or
6417 regular expression, using a boolean logic.  For example, the search
6418 string
6420 @example
6421 +computer +wifi -ethernet -@{8\.11[bg]@}
6422 @end example
6424 @noindent
6425 will search for note entries that contain the keywords @code{computer}
6426 and @code{wifi}, but not the keyword @code{ethernet}, and which are also
6427 not matched by the regular expression @code{8\.11[bg]}, meaning to
6428 exclude both 8.11b and 8.11g.
6430 @vindex org-agenda-text-search-extra-files
6431 Note that in addition to the agenda files, this command will also search
6432 the files listed in @code{org-agenda-text-search-extra-files}.
6433 @end table
6435 @node Stuck projects,  , Keyword search, Built-in agenda views
6436 @subsection Stuck projects
6438 If you are following a system like David Allen's GTD to organize your
6439 work, one of the ``duties'' you have is a regular review to make sure
6440 that all projects move along.  A @emph{stuck} project is a project that
6441 has no defined next actions, so it will never show up in the TODO lists
6442 Org mode produces.  During the review, you need to identify such
6443 projects and define next actions for them.
6445 @table @kbd
6446 @kindex C-c a #
6447 @item C-c a #
6448 List projects that are stuck.
6449 @kindex C-c a !
6450 @item C-c a !
6451 @vindex org-stuck-projects
6452 Customize the variable @code{org-stuck-projects} to define what a stuck
6453 project is and how to find it.
6454 @end table
6456 You almost certainly will have to configure this view before it will
6457 work for you.  The built-in default assumes that all your projects are
6458 level-2 headlines, and that a project is not stuck if it has at least
6459 one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
6461 Let's assume that you, in your own way of using Org mode, identify
6462 projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
6463 indicate a project that should not be considered yet.  Let's further
6464 assume that the TODO keyword DONE marks finished projects, and that NEXT
6465 and TODO indicate next actions.  The tag @@SHOP indicates shopping and
6466 is a next action even without the NEXT tag.  Finally, if the project
6467 contains the special word IGNORE anywhere, it should not be listed
6468 either.  In this case you would start by identifying eligible projects
6469 with a tags/todo match@footnote{@ref{Tag searches}}
6470 @samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT, @@SHOP, and
6471 IGNORE in the subtree to identify projects that are not stuck.  The
6472 correct customization for this is
6474 @lisp
6475 (setq org-stuck-projects
6476       '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
6477                                "\\<IGNORE\\>"))
6478 @end lisp
6480 Note that if a project is identified as non-stuck, the subtree of this entry
6481 will still be searched for stuck projets.
6483 @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views
6484 @section Presentation and sorting
6485 @cindex presentation, of agenda items
6487 @vindex org-agenda-prefix-format
6488 Before displaying items in an agenda view, Org mode visually prepares
6489 the items and sorts them.  Each item occupies a single line.  The line
6490 starts with a @emph{prefix} that contains the @emph{category}
6491 (@pxref{Categories}) of the item and other important information.  You can
6492 customize the prefix using the option @code{org-agenda-prefix-format}.
6493 The prefix is followed by a cleaned-up version of the outline headline
6494 associated with the item.
6496 @menu
6497 * Categories::                  Not all tasks are equal
6498 * Time-of-day specifications::  How the agenda knows the time
6499 * Sorting of agenda items::     The order of things
6500 @end menu
6502 @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting
6503 @subsection Categories
6505 @cindex category
6506 The category is a broad label assigned to each agenda item.  By default,
6507 the category is simply derived from the file name, but you can also
6508 specify it with a special line in the buffer, like this@footnote{For
6509 backward compatibility, the following also works: If there are several
6510 such lines in a file, each specifies the category for the text below it.
6511 The first category also applies to any text before the first CATEGORY
6512 line.  However, using this method is @emph{strongly} deprecated as it is
6513 incompatible with the outline structure of the document.  The correct
6514 method for setting multiple categories in a buffer is using a
6515 property.}:
6517 @example
6518 #+CATEGORY: Thesis
6519 @end example
6521 @noindent
6522 If you would like to have a special CATEGORY for a single entry or a
6523 (sub)tree, give the entry a @code{:CATEGORY:} property with the
6524 special category you want to apply as the value.
6526 @noindent
6527 The display in the agenda buffer looks best if the category is not
6528 longer than 10 characters.
6530 @node Time-of-day specifications, Sorting of agenda items, Categories, Presentation and sorting
6531 @subsection Time-of-day specifications
6532 @cindex time-of-day specification
6534 Org mode checks each agenda item for a time-of-day specification.  The
6535 time can be part of the time stamp that triggered inclusion into the
6536 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}.  Time
6537 ranges can be specified with two time stamps, like
6539 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
6541 In the headline of the entry itself, a time(range) may also appear as
6542 plain text (like @samp{12:45} or a @samp{8:30-1pm}).  If the agenda
6543 integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
6544 specifications in diary entries are recognized as well.
6546 For agenda display, Org mode extracts the time and displays it in a
6547 standard 24 hour format as part of the prefix.  The example times in
6548 the previous paragraphs would end up in the agenda like this:
6550 @example
6551     8:30-13:00 Arthur Dent lies in front of the bulldozer
6552    12:45...... Ford Prefect arrives and takes Arthur to the pub
6553    19:00...... The Vogon reads his poem
6554    20:30-22:15 Marvin escorts the Hitchhikers to the bridge
6555 @end example
6557 @cindex time grid
6558 If the agenda is in single-day mode, or for the display of today, the
6559 timed entries are embedded in a time grid, like
6561 @example
6562     8:00...... ------------------
6563     8:30-13:00 Arthur Dent lies in front of the bulldozer
6564    10:00...... ------------------
6565    12:00...... ------------------
6566    12:45...... Ford Prefect arrives and takes Arthur to the pub
6567    14:00...... ------------------
6568    16:00...... ------------------
6569    18:00...... ------------------
6570    19:00...... The Vogon reads his poem
6571    20:00...... ------------------
6572    20:30-22:15 Marvin escorts the Hitchhikers to the bridge
6573 @end example
6575 @vindex org-agenda-use-time-grid
6576 @vindex org-agenda-time-grid
6577 The time grid can be turned on and off with the variable
6578 @code{org-agenda-use-time-grid}, and can be configured with
6579 @code{org-agenda-time-grid}.
6581 @node Sorting of agenda items,  , Time-of-day specifications, Presentation and sorting
6582 @subsection Sorting of agenda items
6583 @cindex sorting, of agenda items
6584 @cindex priorities, of agenda items
6585 Before being inserted into a view, the items are sorted.  How this is
6586 done depends on the type of view.
6587 @itemize @bullet
6588 @item
6589 @vindex org-agenda-files
6590 For the daily/weekly agenda, the items for each day are sorted.  The
6591 default order is to first collect all items containing an explicit
6592 time-of-day specification.  These entries will be shown at the beginning
6593 of the list, as a @emph{schedule} for the day.  After that, items remain
6594 grouped in categories, in the sequence given by @code{org-agenda-files}.
6595 Within each category, items are sorted by priority (@pxref{Priorities}),
6596 which is composed of the base priority (2000 for priority @samp{A}, 1000
6597 for @samp{B}, and 0 for @samp{C}), plus additional increments for
6598 overdue scheduled or deadline items.
6599 @item
6600 For the TODO list, items remain in the order of categories, but within
6601 each category, sorting takes place according to priority
6602 (@pxref{Priorities}).  The priority used for sorting derives from the
6603 priority cookie, with additions depending on how close an item is to its due
6604 or scheduled date.
6605 @item
6606 For tags matches, items are not sorted at all, but just appear in the
6607 sequence in which they are found in the agenda files.
6608 @end itemize
6610 @vindex org-agenda-sorting-strategy
6611 Sorting can be customized using the variable
6612 @code{org-agenda-sorting-strategy}, and may also include criteria based on
6613 the estimated effort of an entry (@pxref{Effort estimates}).
6615 @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda Views
6616 @section Commands in the agenda buffer
6617 @cindex commands, in agenda buffer
6619 Entries in the agenda buffer are linked back to the org file or diary
6620 file where they originate.  You are not allowed to edit the agenda
6621 buffer itself, but commands are provided to show and jump to the
6622 original entry location, and to edit the org-files ``remotely'' from
6623 the agenda buffer.  In this way, all information is stored only once,
6624 removing the risk that your agenda and note files may diverge.
6626 Some commands can be executed with mouse clicks on agenda lines.  For
6627 the other commands, the cursor needs to be in the desired line.
6629 @table @kbd
6630 @tsubheading{Motion}
6631 @cindex motion commands in agenda
6632 @kindex n
6633 @item n
6634 Next line (same as @key{up} and @kbd{C-p}).
6635 @kindex p
6636 @item p
6637 Previous line (same as @key{down} and @kbd{C-n}).
6638 @tsubheading{View/Go to org file}
6639 @kindex mouse-3
6640 @kindex @key{SPC}
6641 @item mouse-3
6642 @itemx @key{SPC}
6643 Display the original location of the item in another window.
6644 With prefix arg, make sure that the entire entry is made visible in the
6645 outline, not only the heading.
6647 @kindex L
6648 @item L
6649 Display original location and recenter that window.
6651 @kindex mouse-2
6652 @kindex mouse-1
6653 @kindex @key{TAB}
6654 @item mouse-2
6655 @itemx mouse-1
6656 @itemx @key{TAB}
6657 Go to the original location of the item in another window.  Under Emacs
6658 22, @kbd{mouse-1} will also works for this.
6660 @kindex @key{RET}
6661 @itemx @key{RET}
6662 Go to the original location of the item and delete other windows.
6664 @kindex f
6665 @item f
6666 @vindex org-agenda-start-with-follow-mode
6667 Toggle Follow mode.  In Follow mode, as you move the cursor through
6668 the agenda buffer, the other window always shows the corresponding
6669 location in the org file.  The initial setting for this mode in new
6670 agenda buffers can be set with the variable
6671 @code{org-agenda-start-with-follow-mode}.
6673 @kindex b
6674 @item b
6675 Display the entire subtree of the current item in an indirect buffer.  With a
6676 numeric prefix argument N, go up to level N and then take that tree.  If N is
6677 negative, go up that many levels.  With a @kbd{C-u} prefix, do not remove the
6678 previously used indirect buffer.
6680 @kindex l
6681 @item l
6682 @vindex org-log-done
6683 @vindex org-agenda-log-mode-items
6684 Toggle Logbook mode.  In Logbook mode, entries that were marked DONE while
6685 logging was on (variable @code{org-log-done}) are shown in the agenda, as are
6686 entries that have been clocked on that day.  You can configure the entry
6687 types that should be included in log mode using the variable
6688 @code{org-agenda-log-mode-items}.  When called with a @kbd{C-u} prefix, show
6689 all possible logbook entries, including state changes.  When called with two
6690 prefix args @kbd{C-u C-u}, show only logging information, nothing else.
6692 @kindex v
6693 @item v
6694 Toggle Archives mode.  In archives mode, trees that are marked
6695 @code{ARCHIVED} are also scanned when producing the agenda.  When you call
6696 this command with a @kbd{C-u} prefix argument, even all archive files are
6697 included.  To exit archives mode, press @kbd{v} again.
6699 @kindex R
6700 @item R
6701 @vindex org-agenda-start-with-clockreport-mode
6702 Toggle Clockreport mode.  In clockreport mode, the daily/weekly agenda will
6703 always show a table with the clocked times for the timespan and file scope
6704 covered by the current agenda view.  The initial setting for this mode in new
6705 agenda buffers can be set with the variable
6706 @code{org-agenda-start-with-clockreport-mode}.
6708 @tsubheading{Change display}
6709 @cindex display changing, in agenda
6710 @kindex o
6711 @item o
6712 Delete other windows.
6714 @kindex d
6715 @kindex w
6716 @kindex m
6717 @kindex y
6718 @item d w m y
6719 Switch to day/week/month/year view.  When switching to day or week view,
6720 this setting becomes the default for subsequent agenda commands.  Since
6721 month and year views are slow to create, they do not become the default.
6722 A numeric prefix argument may be used to jump directly to a specific day
6723 of the year, ISO week, month, or year, respectively.  For example,
6724 @kbd{32 d} jumps to February 1st, @kbd{9 w} to ISO week number 9.  When
6725 setting day, week, or month view, a year may be encoded in the prefix
6726 argument as well.  For example, @kbd{200712 w} will jump to week 12 in
6727 2007.  If such a year specification has only one or two digits, it will
6728 be mapped to the interval 1938-2037.
6730 @kindex D
6731 @item D
6732 Toggle the inclusion of diary entries.  See @ref{Weekly/daily agenda}.
6734 @kindex G
6735 @item G
6736 @vindex org-agenda-use-time-grid
6737 @vindex org-agenda-time-grid
6738 Toggle the time grid on and off.  See also the variables
6739 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
6741 @kindex r
6742 @item r
6743 Recreate the agenda buffer, for example to reflect the changes
6744 after modification of the time stamps of items with S-@key{left} and
6745 S-@key{right}.  When the buffer is the global TODO list, a prefix
6746 argument is interpreted to create a selective list for a specific TODO
6747 keyword.
6748 @kindex g
6749 @item g
6750 Same as @kbd{r}.
6752 @kindex s
6753 @kindex C-x C-s
6754 @item s
6755 @itemx C-x C-s
6756 Save all Org buffers in the current Emacs session, and also the locations of
6757 IDs.
6759 @kindex @key{right}
6760 @item @key{right}
6761 @vindex org-agenda-ndays
6762 Display the following @code{org-agenda-ndays} days.  For example, if
6763 the display covers a week, switch to the following week.  With prefix
6764 arg, go forward that many times @code{org-agenda-ndays} days.
6766 @kindex @key{left}
6767 @item @key{left}
6768 Display the previous dates.
6770 @kindex .
6771 @item .
6772 Go to today.
6774 @kindex j
6775 @item j
6776 Prompt for a date and go there.
6778 @kindex C-c C-x C-c
6779 @item C-c C-x C-c
6780 @vindex org-columns-default-format
6781 Invoke column view (@pxref{Column view}) in the agenda buffer.  The column
6782 view format is taken from the entry at point, or (if there is no entry at
6783 point), from the first entry in the agenda view.  So whatever the format for
6784 that entry would be in the original buffer (taken from a property, from a
6785 @code{#+COLUMNS} line, or from the default variable
6786 @code{org-columns-default-format}), will be used in the agenda.
6788 @tsubheading{Secondary filtering and query editing}
6789 @cindex filtering, by tag and effort, in agenda
6790 @cindex tag filtering, in agenda
6791 @cindex effort filtering, in agenda
6792 @cindex query editing, in agenda
6794 @kindex /
6795 @item /
6796 @vindex org-agenda-filter-preset
6797 Filter the current agenda view with respect to a tag and/or effort estimates.
6798 The difference between this and a custom agenda command is that filtering is
6799 very fast, so that you can switch quickly between different filters without
6800 having to recreate the agenda@footnote{Custom commands can preset a filter by
6801 binding the variable @code{org-agenda-filter-preset} as an option.  This
6802 filter will then be applied to the view and presist as a basic filter through
6803 refreshes and more secondary filtering.}
6805 You will be prompted for a tag selection letter.  Pressing @key{TAB} at that
6806 prompt will offer use completion to select a tag (including any tags that do
6807 not have a selection character).  The command then hides all entries that do
6808 not contain or inherit this tag.  When called with prefix arg, remove the
6809 entries that @emph{do} have the tag.  A second @kbd{/} at the prompt will
6810 turn off the filter and unhide any hidden entries.  If the first key you
6811 press is either @kbd{+} or @kbd{-}, the previous filter will be narrowed by
6812 requiring or forbidding the selected additional tag.  Instead of pressing
6813 @kbd{+} or @kbd{-} after @kbd{/}, you can also immediately use the @kbd{\}
6814 command.
6816 @vindex org-sort-agenda-noeffort-is-high
6817 In order to filter for effort estimates, you should set-up allowed
6818 efforts globally, for example
6819 @lisp
6820 (setq org-global-properties
6821     '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
6822 @end lisp
6823 You can then filter for an effort by first typing an operator, one of
6824 @kbd{<}, @kbd{>}, and @kbd{=}, and then the one-digit index of an effort
6825 estimate in your array of allowed values, where @kbd{0} means the 10th value.
6826 The filter will then restrict to entries with effort smaller-or-equal, equal,
6827 or larger-or-equal than the selected value.  If the digits 0-9 are not used
6828 as fast access keys to tags, you can also simply press the index digit
6829 directly without an operator.  In this case, @kbd{<} will be assumed.  For
6830 application of the operator, entries without a defined effort will be treated
6831 according to the value of @code{org-sort-agenda-noeffort-is-high}.  To filter
6832 for tasks without effort definition, press @kbd{?} as the operator.
6834 @kindex \
6835 @item \
6836 Narrow the current agenda filter by an additional condition.  When called with
6837 prefix arg, remove the entries that @emph{do} have the tag, or that do match
6838 the effort criterion.  You can achieve the same effect by pressing @kbd{+} or
6839 @kbd{-} as the first key after the @kbd{/} command.
6841 @kindex [
6842 @kindex ]
6843 @kindex @{
6844 @kindex @}
6845 @item [ ] @{ @}
6846 In the @i{search view} (@pxref{Keyword search}), these keys add new search
6847 words (@kbd{[} and @kbd{]}) or new regular expressions (@kbd{@{} and
6848 @kbd{@}}) to the query string.  The opening bracket/brace will add a positive
6849 search term prefixed by @samp{+}, indicating that this search term @i{must}
6850 occur/match in the entry.  The closing bracket/brace will add a negative
6851 search term which @i{must not} occur/match in the entry for it to be
6852 selected.
6855 @tsubheading{Remote editing}
6856 @cindex remote editing, from agenda
6858 @item 0-9
6859 Digit argument.
6861 @cindex undoing remote-editing events
6862 @cindex remote editing, undo
6863 @kindex C-_
6864 @item C-_
6865 Undo a change due to a remote editing command.  The change is undone
6866 both in the agenda buffer and in the remote buffer.
6868 @kindex t
6869 @item t
6870 Change the TODO state of the item, both in the agenda and in the
6871 original org file.
6873 @kindex C-k
6874 @item C-k
6875 @vindex org-agenda-confirm-kill
6876 Delete the current agenda item along with the entire subtree belonging
6877 to it in the original Org file.  If the text to be deleted remotely
6878 is longer than one line, the kill needs to be confirmed by the user.  See
6879 variable @code{org-agenda-confirm-kill}.
6881 @kindex a
6882 @item a
6883 Toggle the ARCHIVE tag for the current headline.
6885 @kindex A
6886 @item A
6887 Move the subtree corresponding to the current entry to its @emph{Archive
6888 Sibling}.
6890 @kindex $
6891 @item $
6892 Archive the subtree corresponding to the current headline.  This means the
6893 entry will be moved to the configured archive location, most likely a
6894 different file.
6896 @kindex T
6897 @item T
6898 @vindex org-agenda-show-inherited-tags
6899 Show all tags associated with the current item.  This is useful if you have
6900 turned off @code{org-agenda-show-inherited-tags}, but still want to see all
6901 tags of a headline occasionally.
6903 @kindex :
6904 @item :
6905 Set tags for the current headline.  If there is an active region in the
6906 agenda, change a tag for all headings in the region.
6908 @kindex ,
6909 @item ,
6910 Set the priority for the current item.  Org mode prompts for the
6911 priority character. If you reply with @key{SPC}, the priority cookie
6912 is removed from the entry.
6914 @kindex P
6915 @item P
6916 Display weighted priority of current item.
6918 @kindex +
6919 @kindex S-@key{up}
6920 @item +
6921 @itemx S-@key{up}
6922 Increase the priority of the current item.  The priority is changed in
6923 the original buffer, but the agenda is not resorted.  Use the @kbd{r}
6924 key for this.
6926 @kindex -
6927 @kindex S-@key{down}
6928 @item -
6929 @itemx S-@key{down}
6930 Decrease the priority of the current item.
6932 @kindex z
6933 @item z
6934 @vindex org-log-state-notes-into-drawer
6935 Add a note to the entry.  This note will be recorded, and then files to the
6936 same location where state change notes a put.  Depending on
6937 @code{org-log-state-notes-into-drawer}, this maybe inside a drawer.
6939 @kindex C-c C-a
6940 @item C-c C-a
6941 Dispatcher for all command related to attachments.
6943 @kindex C-c C-s
6944 @item C-c C-s
6945 Schedule this item
6947 @kindex C-c C-d
6948 @item C-c C-d
6949 Set a deadline for this item.
6951 @kindex k
6952 @item k
6953 Agenda actions, to set dates for selected items to the cursor date.
6954 This command also works in the calendar!  The command prompts for an
6955 additional key:
6956 @example
6957 m   @r{Mark the entry at point for action.  You can also make entries}
6958     @r{in Org files with @kbd{C-c C-x C-k}.}
6959 d   @r{Set the deadline of the marked entry to the date at point.}
6960 s   @r{Schedule the marked entry at the date at point.}
6961 r   @r{Call @code{org-remember} with the cursor date as default date.}
6962 @end example
6963 Press @kbd{r} afterward to refresh the agenda and see the effect of the
6964 command.
6966 @kindex S-@key{right}
6967 @item S-@key{right}
6968 Change the time stamp associated with the current line by one day into the
6969 future.  With a numeric prefix argument, change it by that many days.  For
6970 example, @kbd{3 6 5 S-@key{right}} will change it by a year.  With a
6971 @kbd{C-u} prefix, change the time by one hour.  If you immediately repeat the
6972 command, it will continue to change hours even without the prefix arg.  With
6973 a double @kbd{C-u C-u} prefix, do the same for changing minutes.  The stamp
6974 is changed in the original org file, but the change is not directly reflected
6975 in the agenda buffer.  Use @kbd{r} or @kbd{g} to update the buffer.
6977 @kindex S-@key{left}
6978 @item S-@key{left}
6979 Change the time stamp associated with the current line by one day
6980 into the past.
6982 @kindex >
6983 @item >
6984 Change the time stamp associated with the current line to today.
6985 The key @kbd{>} has been chosen, because it is the same as @kbd{S-.}
6986 on my keyboard.
6988 @kindex I
6989 @item I
6990 Start the clock on the current item.  If a clock is running already, it
6991 is stopped first.
6993 @kindex O
6994 @item O
6995 Stop the previously started clock.
6997 @kindex X
6998 @item X
6999 Cancel the currently running clock.
7001 @kindex J
7002 @item J
7003 Jump to the running clock in another window.
7005 @tsubheading{Calendar commands}
7006 @cindex calendar commands, from agenda
7007 @kindex c
7008 @item c
7009 Open the Emacs calendar and move to the date at the agenda cursor.
7011 @item c
7012 When in the calendar, compute and show the Org mode agenda for the
7013 date at the cursor.
7015 @cindex diary entries, creating from agenda
7016 @kindex i
7017 @item i
7018 Insert a new entry into the diary.  Prompts for the type of entry
7019 (day, weekly, monthly, yearly, anniversary, cyclic) and creates a new
7020 entry in the diary, just as @kbd{i d} etc. would do in the calendar.
7021 The date is taken from the cursor position.
7023 @kindex M
7024 @item M
7025 Show the phases of the moon for the three months around current date.
7027 @kindex S
7028 @item S
7029 Show sunrise and sunset times.  The geographical location must be set
7030 with calendar variables, see documentation of the Emacs calendar.
7032 @kindex C
7033 @item C
7034 Convert the date at cursor into many other cultural and historic
7035 calendars.
7037 @kindex H
7038 @item H
7039 Show holidays for three month around the cursor date.
7041 @item M-x org-export-icalendar-combine-agenda-files
7042 Export a single iCalendar file containing entries from all agenda files.
7043 This is a globally available command, and also available in the agenda menu.
7045 @tsubheading{Exporting to a file}
7046 @kindex C-x C-w
7047 @item C-x C-w
7048 @cindex exporting agenda views
7049 @cindex agenda views, exporting
7050 @vindex org-agenda-exporter-settings
7051 Write the agenda view to a file.  Depending on the extension of the selected
7052 file name, the view will be exported as HTML (extension @file{.html} or
7053 @file{.htm}), Postscript (extension @file{.ps}), PDF (extension @file{.pdf}),
7054 or plain text (any other extension).  When called with a @kbd{C-u} prefix
7055 argument, immediately open the newly created file.  Use the variable
7056 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
7057 for @file{htmlize} to be used during export.
7059 @tsubheading{Quit and Exit}
7060 @kindex q
7061 @item q
7062 Quit agenda, remove the agenda buffer.
7064 @kindex x
7065 @cindex agenda files, removing buffers
7066 @item x
7067 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
7068 for the compilation of the agenda.  Buffers created by the user to
7069 visit org files will not be removed.
7070 @end table
7073 @node Custom agenda views, Exporting Agenda Views, Agenda commands, Agenda Views
7074 @section Custom agenda views
7075 @cindex custom agenda views
7076 @cindex agenda views, custom
7078 Custom agenda commands serve two purposes: to store and quickly access
7079 frequently used TODO and tags searches, and to create special composite
7080 agenda buffers.  Custom agenda commands will be accessible through the
7081 dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
7083 @menu
7084 * Storing searches::            Type once, use often
7085 * Block agenda::                All the stuff you need in a single buffer
7086 * Setting Options::             Changing the rules
7087 @end menu
7089 @node Storing searches, Block agenda, Custom agenda views, Custom agenda views
7090 @subsection Storing searches
7092 The first application of custom searches is the definition of keyboard
7093 shortcuts for frequently used searches, either creating an agenda
7094 buffer, or a sparse tree (the latter covering of course only the current
7095 buffer).
7096 @kindex C-c a C
7097 @vindex org-agenda-custom-commands
7098 Custom commands are configured in the variable
7099 @code{org-agenda-custom-commands}.  You can customize this variable, for
7100 example by pressing @kbd{C-c a C}.  You can also directly set it with
7101 Emacs Lisp in @file{.emacs}.  The following example contains all valid
7102 search types:
7104 @lisp
7105 @group
7106 (setq org-agenda-custom-commands
7107       '(("w" todo "WAITING")
7108         ("W" todo-tree "WAITING")
7109         ("u" tags "+boss-urgent")
7110         ("v" tags-todo "+boss-urgent")
7111         ("U" tags-tree "+boss-urgent")
7112         ("f" occur-tree "\\<FIXME\\>")
7113         ("h" . "HOME+Name tags searches") ; description for "h" prefix
7114         ("hl" tags "+home+Lisa")
7115         ("hp" tags "+home+Peter")
7116         ("hk" tags "+home+Kim")))
7117 @end group
7118 @end lisp
7120 @noindent
7121 The initial string in each entry defines the keys you have to press
7122 after the dispatcher command @kbd{C-c a} in order to access the command.
7123 Usually this will be just a single character, but if you have many
7124 similar commands, you can also define two-letter combinations where the
7125 first character is the same in several combinations and serves as a
7126 prefix key@footnote{You can provide a description for a prefix key by
7127 inserting a cons cell with the prefix and the description.}.  The second
7128 parameter is the search type, followed by the string or regular
7129 expression to be used for the matching.  The example above will
7130 therefore define:
7132 @table @kbd
7133 @item C-c a w
7134 as a global search for TODO entries with @samp{WAITING} as the TODO
7135 keyword
7136 @item C-c a W
7137 as the same search, but only in the current buffer and displaying the
7138 results as a sparse tree
7139 @item C-c a u
7140 as a global tags search for headlines marked @samp{:boss:} but not
7141 @samp{:urgent:}
7142 @item C-c a v
7143 as the same search as @kbd{C-c a u}, but limiting the search to
7144 headlines that are also TODO items
7145 @item C-c a U
7146 as the same search as @kbd{C-c a u}, but only in the current buffer and
7147 displaying the result as a sparse tree
7148 @item C-c a f
7149 to create a sparse tree (again: current buffer only) with all entries
7150 containing the word @samp{FIXME}
7151 @item C-c a h
7152 as a prefix command for a HOME tags search where you have to press an
7153 additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
7154 Peter, or Kim) as additional tag to match.
7155 @end table
7157 @node Block agenda, Setting Options, Storing searches, Custom agenda views
7158 @subsection Block agenda
7159 @cindex block agenda
7160 @cindex agenda, with block views
7162 Another possibility is the construction of agenda views that comprise
7163 the results of @emph{several} commands, each of which creates a block in
7164 the agenda buffer.  The available commands include @code{agenda} for the
7165 daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
7166 for the global TODO list (as constructed with @kbd{C-c a t}), and the
7167 matching commands discussed above: @code{todo}, @code{tags}, and
7168 @code{tags-todo}.  Here are two examples:
7170 @lisp
7171 @group
7172 (setq org-agenda-custom-commands
7173       '(("h" "Agenda and Home-related tasks"
7174          ((agenda "")
7175           (tags-todo "home")
7176           (tags "garden")))
7177         ("o" "Agenda and Office-related tasks"
7178          ((agenda "")
7179           (tags-todo "work")
7180           (tags "office")))))
7181 @end group
7182 @end lisp
7184 @noindent
7185 This will define @kbd{C-c a h} to create a multi-block view for stuff
7186 you need to attend to at home.  The resulting agenda buffer will contain
7187 your agenda for the current week, all TODO items that carry the tag
7188 @samp{home}, and also all lines tagged with @samp{garden}.  Finally the
7189 command @kbd{C-c a o} provides a similar view for office tasks.
7191 @node Setting Options,  , Block agenda, Custom agenda views
7192 @subsection Setting options for custom commands
7193 @cindex options, for custom agenda views
7195 @vindex org-agenda-custom-commands
7196 Org mode contains a number of variables regulating agenda construction
7197 and display.  The global variables define the behavior for all agenda
7198 commands, including the custom commands.  However, if you want to change
7199 some settings just for a single custom view, you can do so.  Setting
7200 options requires inserting a list of variable names and values at the
7201 right spot in @code{org-agenda-custom-commands}.  For example:
7203 @lisp
7204 @group
7205 (setq org-agenda-custom-commands
7206       '(("w" todo "WAITING"
7207          ((org-agenda-sorting-strategy '(priority-down))
7208           (org-agenda-prefix-format "  Mixed: ")))
7209         ("U" tags-tree "+boss-urgent"
7210          ((org-show-following-heading nil)
7211           (org-show-hierarchy-above nil)))
7212         ("N" search ""
7213          ((org-agenda-files '("~org/notes.org"))
7214           (org-agenda-text-search-extra-files nil)))))
7215 @end group
7216 @end lisp
7218 @noindent
7219 Now the @kbd{C-c a w} command will sort the collected entries only by
7220 priority, and the prefix format is modified to just say @samp{  Mixed: }
7221 instead of giving the category of the entry.  The sparse tags tree of
7222 @kbd{C-c a U} will now turn out ultra-compact, because neither the
7223 headline hierarchy above the match, nor the headline following the match
7224 will be shown.  The command @kbd{C-c a N} will do a text search limited
7225 to only a single file.
7227 @vindex org-agenda-custom-commands
7228 For command sets creating a block agenda,
7229 @code{org-agenda-custom-commands} has two separate spots for setting
7230 options.  You can add options that should be valid for just a single
7231 command in the set, and options that should be valid for all commands in
7232 the set.  The former are just added to the command entry, the latter
7233 must come after the list of command entries.  Going back to the block
7234 agenda example (@pxref{Block agenda}), let's change the sorting strategy
7235 for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
7236 the results for GARDEN tags query in the opposite order,
7237 @code{priority-up}.  This would look like this:
7239 @lisp
7240 @group
7241 (setq org-agenda-custom-commands
7242       '(("h" "Agenda and Home-related tasks"
7243          ((agenda)
7244           (tags-todo "home")
7245           (tags "garden"
7246                 ((org-agenda-sorting-strategy '(priority-up)))))
7247          ((org-agenda-sorting-strategy '(priority-down))))
7248         ("o" "Agenda and Office-related tasks"
7249          ((agenda)
7250           (tags-todo "work")
7251           (tags "office")))))
7252 @end group
7253 @end lisp
7255 As you see, the values and parenthesis setting is a little complex.
7256 When in doubt, use the customize interface to set this variable - it
7257 fully supports its structure.  Just one caveat: When setting options in
7258 this interface, the @emph{values} are just lisp expressions.  So if the
7259 value is a string, you need to add the double quotes around the value
7260 yourself.
7263 @node Exporting Agenda Views, Agenda column view, Custom agenda views, Agenda Views
7264 @section Exporting Agenda Views
7265 @cindex agenda views, exporting
7267 If you are away from your computer, it can be very useful to have a printed
7268 version of some agenda views to carry around.  Org mode can export custom
7269 agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's
7270 @file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the
7271 ghostscript @file{ps2pdf} utility must be installed on the system.  Selecting
7272 a pdf file with also create the postscript file.}, and iCalendar files.  If
7273 you want to do this only occasionally, use the command
7275 @table @kbd
7276 @kindex C-x C-w
7277 @item C-x C-w
7278 @cindex exporting agenda views
7279 @cindex agenda views, exporting
7280 @vindex org-agenda-exporter-settings
7281 Write the agenda view to a file.  Depending on the extension of the
7282 selected file name, the view will be exported as HTML (extension
7283 @file{.html} or @file{.htm}), Postscript (extension @file{.ps}),
7284 iCalendar (extension @file{.ics}), or plain text (any other extension).
7285 Use the variable @code{org-agenda-exporter-settings} to
7286 set options for @file{ps-print} and for @file{htmlize} to be used during
7287 export, for example
7289 @vindex org-agenda-add-entry-text-maxlines
7290 @vindex htmlize-output-type
7291 @vindex ps-number-of-columns
7292 @vindex ps-landscape-mode
7293 @lisp
7294 (setq org-agenda-exporter-settings
7295       '((ps-number-of-columns 2)
7296         (ps-landscape-mode t)
7297         (org-agenda-add-entry-text-maxlines 5)
7298         (htmlize-output-type 'css)))
7299 @end lisp
7300 @end table
7302 If you need to export certain agenda views frequently, you can associate
7303 any custom agenda command with a list of output file names
7304 @footnote{If you want to store standard views like the weekly agenda
7305 or the global TODO list as well, you need to define custom commands for
7306 them in order to be able to specify file names.}.  Here is an example
7307 that first does define custom commands for the agenda and the global
7308 todo list, together with a number of files to which to export them.
7309 Then we define two block agenda commands and specify file names for them
7310 as well.  File names can be relative to the current working directory,
7311 or absolute.
7313 @lisp
7314 @group
7315 (setq org-agenda-custom-commands
7316       '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
7317         ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
7318         ("h" "Agenda and Home-related tasks"
7319          ((agenda "")
7320           (tags-todo "home")
7321           (tags "garden"))
7322          nil
7323          ("~/views/home.html"))
7324         ("o" "Agenda and Office-related tasks"
7325          ((agenda)
7326           (tags-todo "work")
7327           (tags "office"))
7328          nil
7329          ("~/views/office.ps" "~/calendars/office.ics"))))
7330 @end group
7331 @end lisp
7333 The extension of the file name determines the type of export.  If it is
7334 @file{.html}, Org mode will use the @file{htmlize.el} package to convert
7335 the buffer to HTML and save it to this file name.  If the extension is
7336 @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
7337 postscript output.  If the extension is @file{.ics}, iCalendar export is
7338 run export over all files that were used to construct the agenda, and
7339 limit the export to entries listed in the agenda now.  Any other
7340 extension produces a plain ASCII file.
7342 The export files are @emph{not} created when you use one of those
7343 commands interactively because this might use too much overhead.
7344 Instead, there is a special command to produce @emph{all} specified
7345 files in one step:
7347 @table @kbd
7348 @kindex C-c a e
7349 @item C-c a e
7350 Export all agenda views that have export file names associated with
7351 them.
7352 @end table
7354 You can use the options section of the custom agenda commands to also
7355 set options for the export commands.  For example:
7357 @lisp
7358 (setq org-agenda-custom-commands
7359       '(("X" agenda ""
7360          ((ps-number-of-columns 2)
7361           (ps-landscape-mode t)
7362           (org-agenda-prefix-format " [ ] ")
7363           (org-agenda-with-colors nil)
7364           (org-agenda-remove-tags t))
7365          ("theagenda.ps"))))
7366 @end lisp
7368 @noindent
7369 This command sets two options for the postscript exporter, to make it
7370 print in two columns in landscape format - the resulting page can be cut
7371 in two and then used in a paper agenda.  The remaining settings modify
7372 the agenda prefix to omit category and scheduling information, and
7373 instead include a checkbox to check off items.  We also remove the tags
7374 to make the lines compact, and we don't want to use colors for the
7375 black-and-white printer.  Settings specified in
7376 @code{org-agenda-exporter-settings} will also apply, but the settings
7377 in @code{org-agenda-custom-commands} take precedence.
7379 @noindent
7380 From the command line you may also use
7381 @example
7382 emacs -f org-batch-store-agenda-views -kill
7383 @end example
7384 @noindent
7385 or, if you need to modify some parameters@footnote{Quoting may depend on the
7386 system you use, please check th FAQ for examples.}
7387 @example
7388 emacs -eval '(org-batch-store-agenda-views                      \
7389               org-agenda-ndays 30                               \
7390               org-agenda-start-day "2007-11-01"                 \
7391               org-agenda-include-diary nil                      \
7392               org-agenda-files (quote ("~/org/project.org")))'  \
7393       -kill
7394 @end example
7395 @noindent
7396 which will create the agenda views restricted to the file
7397 @file{~/org/project.org}, without diary entries and with 30 days
7398 extent.
7400 You can also extract agenda information in a way that allows further
7401 processing by other programs.  See @ref{Extracting agenda information} for
7402 more information.
7405 @node Agenda column view,  , Exporting Agenda Views, Agenda Views
7406 @section Using column view in the agenda
7407 @cindex column view, in agenda
7408 @cindex agenda, column view
7410 Column view (@pxref{Column view}) is normally used to view and edit
7411 properties embedded in the hierarchical structure of an Org file.  It can be
7412 quite useful to use column view also from the agenda, where entries are
7413 collected by certain criteria.
7415 @table @kbd
7416 @kindex C-c C-x C-c
7417 @item C-c C-x C-c
7418 Turn on column view in the agenda.
7419 @end table
7421 To understand how to use this properly, it is important to realize that the
7422 entries in the agenda are no longer in their proper outline environment.
7423 This causes the following issues:
7425 @enumerate
7426 @item
7427 @vindex org-columns-default-format
7428 @vindex org-overriding-columns-format
7429 Org needs to make a decision which @code{COLUMNS} format to use.  Since the
7430 entries in the agenda are collected from different files, and different files
7431 may have different @code{COLUMNS} formats, this is a non-trivial problem.
7432 Org first checks if the variable @code{org-overriding-columns-format} is
7433 currently set, and if yes takes the format from there.  Otherwise it takes
7434 the format associated with the first item in the agenda, or, if that item
7435 does not have a specific format (defined in a property, or in it's file), it
7436 uses @code{org-columns-default-format}.
7437 @item
7438 If any of the columns has a summary type defined (@pxref{Column attributes}),
7439 turning on column view in the agenda will visit all relevant agenda files and
7440 make sure that the computations of this property are up to date.  This is
7441 also true for the special @code{CLOCKSUM} property.  Org will then sum the
7442 values displayed in the agenda.  In the daily/weekly agenda, the sums will
7443 cover a single day, in all other views they cover the entire block.  It is
7444 vital to realize that the agenda may show the same entry @emph{twice} (for
7445 example as scheduled and as a deadline), and it may show two entries from the
7446 same hierarchy (for example a @emph{parent} and it's @emph{child}).  In these
7447 cases, the summation in the agenda will lead to incorrect results because
7448 some values will count double.
7449 @item
7450 When the column view in the agenda shows the @code{CLOCKSUM}, that is always
7451 the entire clocked time for this item.  So even in the daily/weekly agenda,
7452 the clocksum listed in column view may originate from times outside the
7453 current view.  This has the advantage that you can compare these values with
7454 a column listing the planned total effort for a task - one of the major
7455 applications for column view in the agenda.  If you want information about
7456 clocked time in the displayed period use clock table mode (press @kbd{R} in
7457 the agenda).
7458 @end enumerate
7461 @node Embedded LaTeX, Exporting, Agenda Views, Top
7462 @chapter Embedded LaTeX
7463 @cindex @TeX{} interpretation
7464 @cindex La@TeX{} interpretation
7466 Plain ASCII is normally sufficient for almost all note taking.  One
7467 exception, however, are scientific notes which need to be able to contain
7468 mathematical symbols and the occasional formula.  La@TeX{}@footnote{La@TeX{}
7469 is a macro system based on Donald E. Knuth's @TeX{} system.  Many of the
7470 features described here as ``La@TeX{}'' are really from @TeX{}, but for
7471 simplicity I am blurring this distinction.}  is widely used to typeset
7472 scientific documents. Org mode supports embedding La@TeX{} code into its
7473 files, because many academics are used to reading La@TeX{} source code, and
7474 because it can be readily processed into images for HTML production.
7476 It is not necessary to mark La@TeX{} macros and code in any special way.
7477 If you observe a few conventions, Org mode knows how to find it and what
7478 to do with it.
7480 @menu
7481 * Math symbols::                TeX macros for symbols and Greek letters
7482 * Subscripts and superscripts::  Simple syntax for raising/lowering text
7483 * LaTeX fragments::             Complex formulas made easy
7484 * Processing LaTeX fragments::  Previewing LaTeX processing
7485 * CDLaTeX mode::                Speed up entering of formulas
7486 @end menu
7488 @node Math symbols, Subscripts and superscripts, Embedded LaTeX, Embedded LaTeX
7489 @section Math symbols
7490 @cindex math symbols
7491 @cindex TeX macros
7493 You can use La@TeX{} macros to insert special symbols like @samp{\alpha} to
7494 indicate the Greek letter, or @samp{\to} to indicate an arrow.  Completion
7495 for these macros is available, just type @samp{\} and maybe a few letters,
7496 and press @kbd{M-@key{TAB}} to see possible completions.  Unlike La@TeX{}
7497 code, Org mode allows these macros to be present without surrounding math
7498 delimiters, for example:
7500 @example
7501 Angles are written as Greek letters \alpha, \beta and \gamma.
7502 @end example
7504 During HTML export (@pxref{HTML export}), these symbols are translated
7505 into the proper syntax for HTML, for the above examples this is
7506 @samp{&alpha;} and @samp{&rarr;}, respectively.  If you need such a symbol
7507 inside a word, terminate it like this: @samp{\Aacute@{@}stor}.
7509 @node Subscripts and superscripts, LaTeX fragments, Math symbols, Embedded LaTeX
7510 @section Subscripts and superscripts
7511 @cindex subscript
7512 @cindex superscript
7514 Just like in La@TeX{}, @samp{^} and @samp{_} are used to indicate super-
7515 and subscripts.  Again, these can be used without embedding them in
7516 math-mode delimiters.  To increase the readability of ASCII text, it is
7517 not necessary (but OK) to surround multi-character sub- and superscripts
7518 with curly braces.  For example
7520 @example
7521 The mass if the sun is M_sun = 1.989 x 10^30 kg.  The radius of
7522 the sun is R_@{sun@} = 6.96 x 10^8 m.
7523 @end example
7525 To avoid interpretation as raised or lowered text, you can quote
7526 @samp{^} and @samp{_} with a backslash: @samp{\_} and @samp{\^}.
7528 During HTML export (@pxref{HTML export}), subscript and superscripts
7529 are surrounded with @code{<sub>} and @code{<sup>} tags, respectively.
7531 @node LaTeX fragments, Processing LaTeX fragments, Subscripts and superscripts, Embedded LaTeX
7532 @section LaTeX fragments
7533 @cindex LaTeX fragments
7535 @vindex org-format-latex-header
7536 With symbols, sub- and superscripts, HTML is pretty much at its end when
7537 it comes to representing mathematical formulas@footnote{Yes, there is
7538 MathML, but that is not yet fully supported by many browsers, and there
7539 is no decent converter for turning La@TeX{} or ASCII representations of
7540 formulas into MathML. So for the time being, converting formulas into
7541 images seems the way to go.}. More complex expressions need a dedicated
7542 formula processor. To this end, Org mode can contain arbitrary La@TeX{}
7543 fragments. It provides commands to preview the typeset result of these
7544 fragments, and upon export to HTML, all fragments will be converted to
7545 images and inlined into the HTML document@footnote{The La@TeX{} export
7546 will not use images for displaying La@TeX{} fragments but include these
7547 fragments directly into the La@TeX{} code.}. For this to work you
7548 need to be on a system with a working La@TeX{} installation. You also
7549 need the @file{dvipng} program, available at
7550 @url{http://sourceforge.net/projects/dvipng/}. The La@TeX{} header that
7551 will be used when processing a fragment can be configured with the
7552 variable @code{org-format-latex-header}.
7554 La@TeX{} fragments don't need any special marking at all.  The following
7555 snippets will be identified as La@TeX{} source code:
7556 @itemize @bullet
7557 @item
7558 Environments of any kind.  The only requirement is that the
7559 @code{\begin} statement appears on a new line, preceded by only
7560 whitespace.
7561 @item
7562 Text within the usual La@TeX{} math delimiters.  To avoid conflicts with
7563 currency specifications, single @samp{$} characters are only recognized as
7564 math delimiters if the enclosed text contains at most two line breaks, is
7565 directly attached to the @samp{$} characters with no whitespace in between,
7566 and if the closing @samp{$} is followed by whitespace, punctuation or a dash.
7567 For the other delimiters, there is no such restriction, so when in doubt, use
7568 @samp{\(...\)} as inline math delimiters.
7569 @end itemize
7571 @noindent For example:
7573 @example
7574 \begin@{equation@}                          % arbitrary environments,
7575 x=\sqrt@{b@}                                % even tables, figures
7576 \end@{equation@}                            % etc
7578 If $a^2=b$ and \( b=2 \), then the solution must be
7579 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
7580 @end example
7582 @noindent
7583 @vindex org-format-latex-options
7584 If you need any of the delimiter ASCII sequences for other purposes, you
7585 can configure the option @code{org-format-latex-options} to deselect the
7586 ones you do not wish to have interpreted by the La@TeX{} converter.
7588 @node Processing LaTeX fragments, CDLaTeX mode, LaTeX fragments, Embedded LaTeX
7589 @section Processing LaTeX fragments
7590 @cindex LaTeX fragments, preview
7592 La@TeX{} fragments can be processed to produce a preview images of the
7593 typeset expressions:
7595 @table @kbd
7596 @kindex C-c C-x C-l
7597 @item C-c C-x C-l
7598 Produce a preview image of the La@TeX{} fragment at point and overlay it
7599 over the source code.  If there is no fragment at point, process all
7600 fragments in the current entry (between two headlines).  When called
7601 with a prefix argument, process the entire subtree.  When called with
7602 two prefix arguments, or when the cursor is before the first headline,
7603 process the entire buffer.
7604 @kindex C-c C-c
7605 @item C-c C-c
7606 Remove the overlay preview images.
7607 @end table
7609 During HTML export (@pxref{HTML export}), all La@TeX{} fragments are
7610 converted into images and inlined into the document if the following
7611 setting is active:
7613 @lisp
7614 (setq org-export-with-LaTeX-fragments t)
7615 @end lisp
7617 @node CDLaTeX mode,  , Processing LaTeX fragments, Embedded LaTeX
7618 @section Using CDLaTeX to enter math
7619 @cindex CDLaTeX
7621 CDLaTeX mode is a minor mode that is normally used in combination with a
7622 major La@TeX{} mode like AUCTeX in order to speed-up insertion of
7623 environments and math templates.  Inside Org mode, you can make use of
7624 some of the features of CDLaTeX mode.  You need to install
7625 @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
7626 AUCTeX) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
7627 Don't use CDLaTeX mode itself under Org mode, but use the light
7628 version @code{org-cdlatex-mode} that comes as part of Org mode.  Turn it
7629 on for the current buffer with @code{M-x org-cdlatex-mode}, or for all
7630 Org files with
7632 @lisp
7633 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
7634 @end lisp
7636 When this mode is enabled, the following features are present (for more
7637 details see the documentation of CDLaTeX mode):
7638 @itemize @bullet
7639 @kindex C-c @{
7640 @item
7641 Environment templates can be inserted with @kbd{C-c @{}.
7642 @item
7643 @kindex @key{TAB}
7644 The @key{TAB} key will do template expansion if the cursor is inside a
7645 La@TeX{} fragment@footnote{Org mode has a method to test if the cursor is
7646 inside such a fragment, see the documentation of the function
7647 @code{org-inside-LaTeX-fragment-p}.}.  For example, @key{TAB} will
7648 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
7649 correctly inside the first brace.  Another @key{TAB} will get you into
7650 the second brace.  Even outside fragments, @key{TAB} will expand
7651 environment abbreviations at the beginning of a line.  For example, if
7652 you write @samp{equ} at the beginning of a line and press @key{TAB},
7653 this abbreviation will be expanded to an @code{equation} environment.
7654 To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}.
7655 @item
7656 @kindex _
7657 @kindex ^
7658 @vindex cdlatex-simplify-sub-super-scripts
7659 Pressing @kbd{_} and @kbd{^} inside a La@TeX{} fragment will insert these
7660 characters together with a pair of braces.  If you use @key{TAB} to move
7661 out of the braces, and if the braces surround only a single character or
7662 macro, they are removed again (depending on the variable
7663 @code{cdlatex-simplify-sub-super-scripts}).
7664 @item
7665 @kindex `
7666 Pressing the backquote @kbd{`} followed by a character inserts math
7667 macros, also outside La@TeX{} fragments.  If you wait more than 1.5 seconds
7668 after the backquote, a help window will pop up.
7669 @item
7670 @kindex '
7671 Pressing the normal quote @kbd{'} followed by another character modifies
7672 the symbol before point with an accent or a font.  If you wait more than
7673 1.5 seconds after the backquote, a help window will pop up.  Character
7674 modification will work only inside La@TeX{} fragments, outside the quote
7675 is normal.
7676 @end itemize
7678 @node Exporting, Publishing, Embedded LaTeX, Top
7679 @chapter Exporting
7680 @cindex exporting
7682 Org mode documents can be exported into a variety of other formats.  For
7683 printing and sharing of notes, ASCII export produces a readable and simple
7684 version of an Org file.  HTML export allows you to publish a notes file on
7685 the web, while the XOXO format provides a solid base for exchange with a
7686 broad range of other applications. La@TeX{} export lets you use Org mode and
7687 its structured editing functions to easily create La@TeX{} files.  DocBook
7688 export makes it possible to convert Org files to many other formats using
7689 DocBook tools.  To incorporate entries with associated times like deadlines
7690 or appointments into a desktop calendar program like iCal, Org mode can also
7691 produce extracts in the iCalendar format.  Currently Org mode only supports
7692 export, not import of these different formats.
7694 Org supports export of selected regions when @code{transient-mark-mode} is
7695 enabled (default in Emacs 23).
7697 @menu
7698 * Markup rules::                Which structures are recognized?
7699 * Selective export::            Using tags to select and exclude trees
7700 * Export options::              Per-file export settings
7701 * The export dispatcher::       How to access exporter commands
7702 * ASCII export::                Exporting to plain ASCII
7703 * HTML export::                 Exporting to HTML
7704 * LaTeX and PDF export::        Exporting to LaTeX, and processing to PDF
7705 * DocBook export::              Exporting to DocBook
7706 * XOXO export::                 Exporting to XOXO
7707 * iCalendar export::            Exporting in iCalendar format
7708 @end menu
7710 @node Markup rules, Selective export, Exporting, Exporting
7711 @section Markup rules
7713 When exporting Org mode documents, the exporter tries to reflect the
7714 structure of the document as accurately as possible in the back-end.  Since
7715 export targets like HTML, La@TeX{}, or DocBook allow much richer formatting,
7716 Org mode has rules how to prepare text for rich export.  This section
7717 summarizes the markup rule used in an Org mode buffer.
7719 @menu
7720 * Document title::              How the document title is determined
7721 * Headings and sections::       The main structure of the exported document
7722 * Table of contents::           If, where, how to create a table of contents
7723 * Initial text::                Text before the first headline
7724 * Lists::                       Plain lists are exported
7725 * Paragraphs::                  What determines beginning and ending
7726 * Literal examples::            Source code and other examples
7727 * Include files::               Include the contents of a file during export
7728 * Tables exported::             Tables are exported richly
7729 * Inlined images::              How to inline images during export
7730 * Footnote markup::             ASCII representation of footnotes
7731 * Emphasis and monospace::      To bold or not to bold
7732 * TeX macros and LaTeX fragments::  Create special, rich export.
7733 * Horizontal rules::            A line across the page
7734 * Comment lines::               Some lines will not be exported
7735 * Macro replacement::           Global replacement of place holdes
7736 @end menu
7738 @node Document title, Headings and sections, Markup rules, Markup rules
7739 @subheading Document title
7740 @cindex document title, markup rules
7742 @noindent
7743 The title of the exported document is taken from the special line
7745 @example
7746 #+TITLE: This is the title of the document
7747 @end example
7749 @noindent
7750 If this line does not exist, the title is derived from the first non-empty,
7751 non-comment line in the buffer.  If no such line exists, or if you have
7752 turned off exporting of the text before the first headline (see below), the
7753 title will be the file name without extension.
7755 If you are exporting only a subtree by marking is as the region, the heading
7756 of the subtree will become the title of the document.  If the subtree has a
7757 property @code{EXPORT_TITLE}, that will take precedence.
7759 @node Headings and sections, Table of contents, Document title, Markup rules
7760 @subheading Headings and sections
7761 @cindex headings and sections, markup rules
7763 @vindex org-headline-levels
7764 The outline structure of the document as described in @ref{Document
7765 Structure} forms the basis for defining sections of the exported document.
7766 However, since the outline structure is also used for (for example) lists of
7767 tasks, only the first three outline levels will be used as headings.  Deeper
7768 levels will become itemized lists.  You can change the location of this
7769 switch, globally by setting the variable @code{org-headline-levels}, or on a
7770 per file basis with a line
7772 @example
7773 #+OPTIONS: H:4
7774 @end example
7776 @node Table of contents, Initial text, Headings and sections, Markup rules
7777 @subheading Table of contents
7778 @cindex table of contents, markup rules
7780 @vindex org-export-with-toc
7781 The table of contents is normally inserted directly before the first headline
7782 of the file.  If you would like to get it to a different location, insert the
7783 string @code{[TABLE-OF-CONTENTS]} on a line by itself at the desired
7784 location.  The depth of the table of contents is by default the same as the
7785 number of headline levels, but you can choose a smaller number or turn off
7786 the table of contents entirely by configuring the variable
7787 @code{org-export-with-toc}, or on a per-file basis with a line like
7789 @example
7790 #+OPTIONS: toc:2          (only to two levels in TOC)
7791 #+OPTIONS: toc:nil        (no TOC at all)
7792 @end example
7794 @node Initial text, Lists, Table of contents, Markup rules
7795 @subheading Text before the first headline
7796 @cindex text before first headline, markup rules
7797 @cindex #+TEXT
7799 Org mode normally exports the text before the first headline, and even uses
7800 the first line as the document title.  The text will be fully marked up.  If
7801 you need to include literal HTML, La@TeX{}, or DocBook code, use the special
7802 constructs described below in the sections for the individual exporters.
7804 @vindex org-export-skip-text-before-1st-heading
7805 Some people like to use the space before the first headline for setup and
7806 internal links and therefore would like to control the exported text before
7807 the first headline in a different way.  You can do so by setting the variable
7808 @code{org-export-skip-text-before-1st-heading} to @code{t}.  On a per-file
7809 basis, you can get the same effect with @samp{#+OPTIONS: skip:t}.
7811 @noindent
7812 If you still want to have some text before the first headline, use the
7813 @code{#+TEXT} construct:
7815 @example
7816 #+OPTIONS: skip:t
7817 #+TEXT: This text will go before the *first* headline.
7818 #+TEXT: [TABLE-OF-CONTENTS]
7819 #+TEXT: This goes between the table of contents and the first headline
7820 @end example
7822 @node Lists, Paragraphs, Initial text, Markup rules
7823 @subheading Lists
7824 @cindex lists, markup rules
7826 Plain lists as described in @ref{Plain lists} are translated to the back-ends
7827 syntax for such lists.  Most back-ends support unordered, ordered, and
7828 description lists.
7830 @node Paragraphs, Literal examples, Lists, Markup rules
7831 @subheading Paragraphs, line breaks, and quoting
7832 @cindex paragraphs, markup rules
7834 Paragraphs are separated by at least one empty line.  If you need to enforce
7835 a line break within a paragraph, use @samp{\\} at the end of a line.
7837 To keep the line breaks in a region, but otherwise use normal formatting, you
7838 can use this construct, which can also be used to format poetry.
7840 @example
7841 #+BEGIN_VERSE
7842  Great clouds overhead
7843  Tiny black birds rise and fall
7844  Snow covers Emacs
7846      -- AlexSchroeder
7847 #+END_VERSE
7848 @end example
7850 When quoting a passage from another document, it is customary to format this
7851 as a paragraph that is indented on both the left and the right margin.  You
7852 can include quotations in Org mode documents like this:
7854 @example
7855 #+BEGIN_QUOTE
7856 Everything should be made as simple as possible,
7857 but not any simpler -- Albert Einstein
7858 #+END_QUOTE
7859 @end example
7861 If you would like to center some text, do it like this:
7862 @example
7863 #+BEGIN_CENTER
7864 Everything should be made as simple as possible, \\
7865 but not any simpler
7866 #+END_CENTER
7867 @end example
7869 @node Literal examples, Include files, Paragraphs, Markup rules
7870 @subheading Literal examples
7871 @cindex literal examples, markup rules
7872 @cindex code line refenences, markup rules
7874 You can include literal examples that should not be subjected to
7875 markup.  Such examples will be typeset in monospace, so this is well suited
7876 for source code and similar examples.
7877 @cindex #+BEGIN_EXAMPLE
7879 @example
7880 #+BEGIN_EXAMPLE
7881 Some example from a text file.
7882 #+END_EXAMPLE
7883 @end example
7885 For simplicity when using small examples, you can also start the example
7886 lines with a colon followed by a space.  There may also be additional
7887 whitespace before the colon:
7889 @example
7890 Here is an example
7891    : Some example from a text file.
7892 @end example
7894 @cindex formatting source code, markup rules
7895 If the example is source code from a programming language, or any other text
7896 that can be marked up by font-lock in Emacs, you can ask for the example to
7897 look like the fontified Emacs buffer@footnote{Currently this works only for
7898 the HTML back-end, and requires the @file{htmlize.el} package version 1.34 or
7899 later.}.  This is done with the @samp{src} block, where you also need to
7900 specify the name of the major mode that should be used to fontify the
7901 example:
7902 @cindex #+BEGIN_SRC
7904 @example
7905 #+BEGIN_SRC emacs-lisp
7906 (defun org-xor (a b)
7907    "Exclusive or."
7908    (if a (not b) b))
7909 #+END_SRC
7910 @end example
7912 Both in @code{example} and in @code{src} snippets, you can add a @code{-n}
7913 switch to the end of the @code{BEGIN} line, to get the lines of the example
7914 numbered.  If you use a @code{+n} switch, the numbering from the previous
7915 numbered snippet will be continued in the current one.  In literal examples,
7916 Org will interpret strings like @samp{(ref:name)} as labels, and use them as
7917 targets for special hyperlinks like @code{[[(name)]]} (i.e. the reference
7918 name enclosed in single parenthesis).  In HTML, hovering the mouse over such
7919 a link will remote-highlight the corresponding code line, which is kind of
7920 cool.  If the example/src snippet is numbered, you can also add a @code{-r}
7921 switch.  Then labels will be @i{removed} from the source code and the links
7922 will be @i{replaced}@footnote{If you want to explain the use of such labels
7923 themelves in org-mode example code, you can use the @code{-k} switch to make
7924 sure they are not touched.} with line numbers from the code listing.  Here is
7925 an example:
7927 @example
7928 #+BEGIN_SRC emacs-lisp -n -r
7929 (save-excursion                  (ref:sc)
7930    (goto-char (point-min))       (ref:jump)
7931 #+END SRC
7932 In line [[(sc)]] we remember the current positon.  [[(jump)][Line (jump)]]
7933 jumps to point-min.
7934 @end example
7936 @vindex org-coderef-label-format
7937 If the syntax for the label format conflicts with the language syntax, use a
7938 @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
7939 -n -r -l "((%s))"}.  See also the variable @code{org-coderef-label-format}.
7941 HTML export also allows examples to be published as text areas, @pxref{Text
7942 areas in HTML export}.
7944 @table @kbd
7945 @kindex C-c '
7946 @item C-c '
7947 Edit the source code example at point in its native mode.  This works by
7948 switching to an indirect buffer, narrowing the buffer and switching to the
7949 other mode.  You need to exit by pressing @kbd{C-c '} again@footnote{Upon
7950 exit, lines starting with @samp{*} or @samp{#} will get a comma prepended, to
7951 keep them from being interpreted by Org as outline nodes or special
7952 comments.  These commas will be striped for editing with @kbd{C-c '}, and
7953 also for export.}.  Fixed-width
7954 regions (where each line starts with a colon followed by a space) will be
7955 edited using @code{artist-mode}@footnote{You may select a different-mode with
7956 the variable @code{org-edit-fixed-width-region-mode}.} to allow creating
7957 ASCII drawings easily.  Using this command in an empty line will create a new
7958 fixed-width region.
7959 @kindex C-c l
7960 @item C-c l
7961 Calling @code{org-store-link} while editing a source code example in a
7962 temporary buffer created with @kbd{C-c '} will prompt for a label, make sure
7963 that it is unique in the current buffer, and insert it with the proper
7964 formatting like @samp{(ref:label)} at the end of the current line.  Then the
7965 label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
7966 @end table
7969 @node Include files, Tables exported, Literal examples, Markup rules
7970 @subheading Include files
7971 @cindex include files, markup rules
7973 During export, you can include the content of another file.  For example, to
7974 include your .emacs file, you could use:
7975 @cindex #+INCLUDE
7977 @example
7978 #+INCLUDE: "~/.emacs" src emacs-lisp
7979 @end example
7981 The optional second and third parameter are the markup (@samp{quote},
7982 @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the
7983 language for formatting the contents.  The markup is optional, if it is not
7984 given, the text will be assumed to be in Org mode format and will be
7985 processed normally.  The include line will also allow additional keyword
7986 parameters @code{:prefix1} and @code{:prefix} to specify prefixes for the
7987 first line and for each following line, as well as any options accepted by
7988 the selected markup.  For example, to include a file as an item, use
7990 @example
7991 #+INCLUDE: "~/snippets/xx" :prefix1 "   + " :prefix "     "
7992 @end example
7994 @table @kbd
7995 @kindex C-c '
7996 @item C-c '
7997 Visit the include file at point.
7998 @end table
8000 @node Tables exported, Inlined images, Include files, Markup rules
8001 @subheading Tables
8002 @cindex tables, markup rules
8004 Both the native Org mode tables (@pxref{Tables}) and tables formatted with
8005 the @file{table.el} package will be exported properly.  For Org mode tables,
8006 the lines before the first horizontal separator line will become table header
8007 lines.  You can use the following lines somewhere before the table to assign
8008 a caption and a label for cross references:
8010 @example
8011 #+CAPTION: This is the caption for the next table (or link)
8012 #+LABEL:   tbl:basic-data
8013 @end example
8015 @node Inlined images, Footnote markup, Tables exported, Markup rules
8016 @subheading Inlined Images
8017 @cindex inlined images, markup rules
8019 Some backends (HTML, LaTeX, and DocBook) allow to directly include images
8020 into the exported document.  Org does this, if a link to an image files does
8021 not have a description part, for example @code{[[./img/a.jpg]]}.  If you wish
8022 to define a caption for the image and maybe a label for internal cross
8023 references, you can use (before, but close to the link)
8025 @example
8026 #+CAPTION: This is the caption for the next figure link (or table)
8027 #+LABEL:   fig:SED-HR4049
8028 @end example
8030 You may also define additional attributes for the figure.  As this is
8031 backend-specific, see the sections about the individual backends for more
8032 information.
8034 @node Footnote markup, Emphasis and monospace, Inlined images, Markup rules
8035 @subheading Footnote markup
8036 @cindex footnotes, markup rules
8037 @cindex @file{footnote.el}
8039 Footnotes defined in the way descriped in @ref{Footnotes} will be exported by
8040 all backends.  Org does allow multiple references to the same note, and
8041 different backends support this to varying degree.
8043 @node Emphasis and monospace, TeX macros and LaTeX fragments, Footnote markup, Markup rules
8044 @subheading Emphasis and monospace
8046 @cindex underlined text, markup rules
8047 @cindex bold text, markup rules
8048 @cindex italic text, markup rules
8049 @cindex verbatim text, markup rules
8050 @cindex code text, markup rules
8051 @cindex strike-through text, markup rules
8052 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=}
8053 and @code{~verbatim~}, and, if you must, @samp{+strike-through+}.  Text
8054 in the code and verbatim string is not processed for Org mode specific
8055 syntax, it is exported verbatim.
8057 @node TeX macros and LaTeX fragments, Horizontal rules, Emphasis and monospace, Markup rules
8058 @subheading @TeX{} macros and La@TeX{} fragments
8059 @cindex LaTeX fragments, markup rules
8060 @cindex TeX macros, markup rules
8061 @cindex HTML entities
8062 @cindex LaTeX entities
8064 @vindex org-html-entities
8065 A @TeX{}-like syntax is used to specify special characters.  Where possible,
8066 these will be transformed into the native format of the exporter back-end.
8067 Strings like @code{\alpha} will be exported as @code{&alpha;} in the HTML
8068 output, and as @code{$\alpha$} in the La@TeX{} output.  Similarly,
8069 @code{\nbsp} will become @code{&nbsp;} in HTML and @code{~} in La@TeX{}.
8070 This applies for a large number of entities, with names taken from both HTML
8071 and La@TeX{}, see the variable @code{org-html-entities} for the complete
8072 list.  If you are unsure about a name, use @kbd{M-@key{TAB}} for completion
8073 after having typed the backslash and maybe a few characters
8074 (@pxref{Completion}).
8076 La@TeX{} fragments are converted into images for HTML export, and they are
8077 written literally into the La@TeX{} export.  See also @ref{Embedded LaTeX}.
8079 Finally, @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
8080 @samp{...} are all converted into special commands creating hyphens of
8081 different lengths or a compact set of dots.
8083 @node Horizontal rules, Comment lines, TeX macros and LaTeX fragments, Markup rules
8084 @subheading  Horizontal rules
8085 @cindex horizontal rules, markup rules
8086 A line consisting of only dashes, and at least 5 of them, will be
8087 exported as a horizontal line (@samp{<hr/>} in HTML).
8089 @node Comment lines, Macro replacement, Horizontal rules, Markup rules
8090 @subheading Comment lines
8091 @cindex comment lines
8092 @cindex exporting, not
8094 Lines starting with @samp{#} in column zero are treated as comments and will
8095 never be exported.  Also entire subtrees starting with the word
8096 @samp{COMMENT} will never be exported.  Finally, regions surrounded by
8097 @samp{#+BEGIN_COMMENT} ... @samp{#+END_COMMENT} will not be exported.
8099 @table @kbd
8100 @kindex C-c ;
8101 @item C-c ;
8102 Toggle the COMMENT keyword at the beginning of an entry.
8103 @end table
8105 @node Macro replacement,  , Comment lines, Markup rules
8106 @subheading Macro replacement
8108 You can define text snippets with
8110 @example
8111 #+MACRO: name   replacement text
8112 @end example
8114 @noindent which can be referenced anywhere in the document (even in
8115 code examples) with @code{@{@{@{name@}@}@}}.  In addition to defined macros,
8116 @code{@{@{@{title@}@}@}}, @code{@{@{@{author@}@}@}}, etc will reference
8117 information set by the @code{#+TITLE:}, @code{#+AUTHOR:}, and similar lines.
8119 @node Selective export, Export options, Markup rules, Exporting
8120 @section Selective export
8121 @cindex export, selective by tags
8123 @vindex org-export-select-tags
8124 @vindex org-export-exclude-tags
8125 You may use tags to select the parts of a document that should be exported,
8126 or to exclude parts from export.  This behavior is governed by two variables:
8127 @code{org-export-select-tags} and @code{org-export-exclude-tags}.
8129 Org first checks if any of the @emph{select} tags is present in the buffer.
8130 If yes, all trees that do not carry one of these tags will be excluded.  If a
8131 selected tree is a subtree, the heading hierarchy above it will also be
8132 selected for export, but not the text below those headings.
8134 @noindent
8135 If none of the select tags is found, the whole buffer will be selected for
8136 export.
8138 @noindent
8139 Finally, all subtrees that are marked by any of the @emph{exclude} tags will
8140 be removed from the export buffer.
8142 @node Export options, The export dispatcher, Selective export, Exporting
8143 @section Export options
8144 @cindex options, for export
8146 @cindex completion, of option keywords
8147 The exporter recognizes special lines in the buffer which provide
8148 additional information.  These lines may be put anywhere in the file.
8149 The whole set of lines can be inserted into the buffer with @kbd{C-c
8150 C-e t}.  For individual lines, a good way to make sure the keyword is
8151 correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion
8152 (@pxref{Completion}).   For a summary of other in-buffer settings not 
8153 specifically related to export, see @ref{In-buffer settings}. 
8154 In particular, note that you can place commonly-used (export) options in 
8155 a separate file which can be included using @code{#+SETUPFILE}.
8157 @table @kbd
8158 @kindex C-c C-e t
8159 @item C-c C-e t
8160 Insert template with export options, see example below.
8161 @end table
8163 @cindex #+TITLE:
8164 @cindex #+AUTHOR:
8165 @cindex #+DATE:
8166 @cindex #+EMAIL:
8167 @cindex #+DESCRIPTION:
8168 @cindex #+KEYWORDS:
8169 @cindex #+LANGUAGE:
8170 @cindex #+TEXT:
8171 @cindex #+OPTIONS:
8172 @cindex #+LINK_UP:
8173 @cindex #+LINK_HOME:
8174 @cindex #+EXPORT_SELECT_TAGS:
8175 @cindex #+EXPORT_EXCLUDE_TAGS:
8176 @cindex #+LATEX_HEADER:
8177 @vindex user-full-name
8178 @vindex user-mail-address
8179 @vindex org-export-default-language
8180 @example
8181 #+TITLE:       the title to be shown (default is the buffer name)
8182 #+AUTHOR:      the author (default taken from @code{user-full-name})
8183 #+DATE:        a date, fixed, of a format string for @code{format-time-string}
8184 #+EMAIL:       his/her email address (default from @code{user-mail-address})
8185 #+DESCRIPTION: the page description, e.g. for the XHTML meta tag
8186 #+KEYWORDS:    the page keywords, e.g. for the XHTML meta tag
8187 #+LANGUAGE:    language for HTML, e.g. @samp{en} (@code{org-export-default-language})
8188 #+TEXT:        Some descriptive text to be inserted at the beginning.
8189 #+TEXT:        Several lines may be given.
8190 #+OPTIONS:     H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ...
8191 #+LINK_UP:     the ``up'' link of an exported page
8192 #+LINK_HOME:   the ``home'' link of an exported page
8193 #+LATEX_HEADER: extra line(s) for the LaTeX header, like \usepackage@{xyz@}
8194 #+EXPORT_SELECT_TAGS:   Tags that select a tree for export
8195 #+EXPORT_EXCLUDE_TAGS:  Tags that exclude a tree from export
8196 @end example
8198 @noindent
8199 The OPTIONS line is a compact@footnote{If you want to configure many options
8200 this way, you can use several OPTIONS lines.} form to specify export settings.  Here
8201 you can:
8202 @cindex headline levels
8203 @cindex section-numbers
8204 @cindex table of contents
8205 @cindex line-break preservation
8206 @cindex quoted HTML tags
8207 @cindex fixed-width sections
8208 @cindex tables
8209 @cindex @TeX{}-like syntax for sub- and superscripts
8210 @cindex footnotes
8211 @cindex special strings
8212 @cindex emphasized text
8213 @cindex @TeX{} macros
8214 @cindex La@TeX{} fragments
8215 @cindex author info, in export
8216 @cindex time info, in export
8217 @example
8218 H:         @r{set the number of headline levels for export}
8219 num:       @r{turn on/off section-numbers}
8220 toc:       @r{turn on/off table of contents, or set level limit (integer)}
8221 \n:        @r{turn on/off line-break-preservation}
8222 @@:         @r{turn on/off quoted HTML tags}
8223 ::         @r{turn on/off fixed-width sections}
8224 |:         @r{turn on/off tables}
8225 ^:         @r{turn on/off @TeX{}-like syntax for sub- and superscripts.  If}
8226            @r{you write "^:@{@}", @code{a_@{b@}} will be interpreted, but}
8227            @r{the simple @code{a_b} will be left as it is.}
8228 -:         @r{turn on/off conversion of special strings.}
8229 f:         @r{turn on/off footnotes like this[1].}
8230 todo:      @r{turn on/off inclusion of TODO keywords into exported text}
8231 pri:       @r{turn on/off priority cookies}
8232 tags:      @r{turn on/off inclusion of tags, may also be @code{not-in-toc}}
8233 <:         @r{turn on/off inclusion of any time/date stamps like DEADLINES}
8234 *:         @r{turn on/off emphasized text (bold, italic, underlined)}
8235 TeX:       @r{turn on/off simple @TeX{} macros in plain text}
8236 LaTeX:     @r{turn on/off La@TeX{} fragments}
8237 skip:      @r{turn on/off skipping the text before the first heading}
8238 author:    @r{turn on/off inclusion of author name/email into exported file}
8239 creator:   @r{turn on/off inclusion of creator info into exported file}
8240 timestamp: @r{turn on/off inclusion creation time into exported file}
8241 d:         @r{turn on/off inclusion of drawers}
8242 @end example
8244 These options take effect in both the HTML and La@TeX{} export, except
8245 for @code{TeX} and @code{LaTeX}, which are respectively @code{t} and
8246 @code{nil} for the La@TeX{} export.
8248 When exporting only a single subtree by selecting it with @kbd{C-c @@} before
8249 calling an export command, the subtree can overrule some of the file's export
8250 settings with properties @code{EXPORT_FILE_NAME}, @code{EXPORT_TITLE},
8251 @code{EXPORT_TEXT}, and @code{EXPORT_OPTIONS}.
8253 @node The export dispatcher, ASCII export, Export options, Exporting
8254 @section The export dispatcher
8255 @cindex dispatcher, for export commands
8257 All export commands can be reached using the export dispatcher, which is a
8258 prefix key that prompts for an additional key specifying the command.
8259 Normally the entire file is exported, but if there is an active region that
8260 contains one outline tree, the first heading is used as document title and
8261 the subtrees are exported.
8263 @table @kbd
8264 @kindex C-c C-e
8265 @item C-c C-e
8266 @vindex org-export-run-in-background
8267 Dispatcher for export and publishing commands.  Displays a help-window
8268 listing the additional key(s) needed to launch an export or publishing
8269 command.  The prefix arg is passed through to the exporter.  A double prefix
8270 @kbd{C-u C-u} causes most commands to be executed in the background, in a
8271 separate emacs process@footnote{To make this behavior the default, customize
8272 the variable @code{org-export-run-in-background}.}.
8273 @kindex C-c C-e v
8274 @item C-c C-e v
8275 Like @kbd{C-c C-e}, but only export the text that is currently visible
8276 (i.e. not hidden by outline visibility).
8277 @kindex C-u C-u C-c C-e
8278 @item C-u C-u C-c C-e
8279 @vindex org-export-run-in-background
8280 Call an the exporter, but reverse the setting of
8281 @code{org-export-run-in-background}, i.e. request background processing if
8282 not set, or force processing in the current Emacs process if st.
8283 @end table
8285 @node ASCII export, HTML export, The export dispatcher, Exporting
8286 @section ASCII export
8287 @cindex ASCII export
8289 ASCII export produces a simple and very readable version of an Org mode
8290 file.
8292 @cindex region, active
8293 @cindex active region
8294 @cindex transient-mark-mode
8295 @table @kbd
8296 @kindex C-c C-e a
8297 @item C-c C-e a
8298 Export as ASCII file.  For an org file @file{myfile.org}, the ASCII file
8299 will be @file{myfile.txt}.  The file will be overwritten without
8300 warning.  If there is an active region@footnote{this requires
8301 @code{transient-mark-mode} to be turned on}, only the region will be
8302 exported. If the selected region is a single tree@footnote{To select the
8303 current subtree, use @kbd{C-c @@}.}, the tree head will
8304 become the document title.  If the tree head entry has or inherits an
8305 @code{EXPORT_FILE_NAME} property, that name will be used for the
8306 export.
8307 @kindex C-c C-e v a
8308 @item C-c C-e v a
8309 Export only the visible part of the document.
8310 @end table
8312 @cindex headline levels, for exporting
8313 In the exported version, the first 3 outline levels will become
8314 headlines, defining a general document structure.  Additional levels
8315 will be exported as itemized lists.  If you want that transition to occur
8316 at a different level, specify it with a prefix argument.  For example,
8318 @example
8319 @kbd{C-1 C-c C-e a}
8320 @end example
8322 @noindent
8323 creates only top level headlines and does the rest as items.  When
8324 headlines are converted to items, the indentation of the text following
8325 the headline is changed to fit nicely under the item.  This is done with
8326 the assumption that the first body line indicates the base indentation of
8327 the body text.  Any indentation larger than this is adjusted to preserve
8328 the layout relative to the first line.  Should there be lines with less
8329 indentation than the first, these are left alone.
8331 @vindex org-export-ascii-links-to-notes
8332 Links will be exported in a footnote-like style, with the descriptive part in
8333 the text and the link in a note before the next heading.  See the variable
8334 @code{org-export-ascii-links-to-notes} for details and other options.
8336 @node HTML export, LaTeX and PDF export, ASCII export, Exporting
8337 @section HTML export
8338 @cindex HTML export
8340 Org mode contains an HTML (XHTML 1.0 strict) exporter with extensive
8341 HTML formatting, in ways similar to John Gruber's @emph{markdown}
8342 language, but with additional support for tables.
8344 @menu
8345 * HTML Export commands::        How to invoke HTML export
8346 * Quoting HTML tags::           Using direct HTML in Org mode
8347 * Links::                       Transformation of links for HTML
8348 * Tables in HTML export::       How to modify the formatting of tables
8349 * Images in HTML export::       How to insert figures into HTML output
8350 * Text areas in HTML export::   An alternative way to show an example
8351 * CSS support::                 Changing the appearance of the output
8352 * Javascript support::          Info and Folding in a web browser
8353 @end menu
8355 @node HTML Export commands, Quoting HTML tags, HTML export, HTML export
8356 @subsection HTML export commands
8358 @cindex region, active
8359 @cindex active region
8360 @cindex transient-mark-mode
8361 @table @kbd
8362 @kindex C-c C-e h
8363 @item C-c C-e h
8364 Export as HTML file @file{myfile.html}.  For an org file @file{myfile.org},
8365 the ASCII file will be @file{myfile.html}.  The file will be overwritten
8366 without warning.  If there is an active region@footnote{this requires
8367 @code{transient-mark-mode} to be turned on}, only the region will be
8368 exported. If the selected region is a single tree@footnote{To select the
8369 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
8370 title.  If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
8371 property, that name will be used for the export.
8372 @kindex C-c C-e b
8373 @item C-c C-e b
8374 Export as HTML file and immediately open it with a browser.
8375 @kindex C-c C-e H
8376 @item C-c C-e H
8377 Export to a temporary buffer, do not create a file.
8378 @kindex C-c C-e R
8379 @item C-c C-e R
8380 Export the active region to a temporary buffer.  With a prefix argument, do
8381 not produce the file header and footer, but just the plain HTML section for
8382 the region.  This is good for cut-and-paste operations.
8383 @kindex C-c C-e v h
8384 @kindex C-c C-e v b
8385 @kindex C-c C-e v H
8386 @kindex C-c C-e v R
8387 @item C-c C-e v h
8388 @item C-c C-e v b
8389 @item C-c C-e v H
8390 @item C-c C-e v R
8391 Export only the visible part of the document.
8392 @item M-x org-export-region-as-html
8393 Convert the region to HTML under the assumption that it was Org mode
8394 syntax before.  This is a global command that can be invoked in any
8395 buffer.
8396 @item M-x org-replace-region-by-HTML
8397 Replace the active region (assumed to be in Org mode syntax) by HTML
8398 code.
8399 @end table
8401 @cindex headline levels, for exporting
8402 In the exported version, the first 3 outline levels will become headlines,
8403 defining a general document structure.  Additional levels will be exported as
8404 itemized lists.  If you want that transition to occur at a different level,
8405 specify it with a numeric prefix argument.  For example,
8407 @example
8408 @kbd{C-2 C-c C-e b}
8409 @end example
8411 @noindent
8412 creates two levels of headings and does the rest as items.
8414 @node Quoting HTML tags, Links, HTML Export commands, HTML export
8415 @subsection Quoting HTML tags
8417 Plain @samp{<} and @samp{>} are always transformed to @samp{&lt;} and
8418 @samp{&gt;} in HTML export.  If you want to include simple HTML tags
8419 which should be interpreted as such, mark them with @samp{@@} as in
8420 @samp{@@<b>bold text@@</b>}.  Note that this really works only for
8421 simple tags.  For more extensive HTML that should be copied verbatim to
8422 the exported file use either
8424 @example
8425 #+HTML: Literal HTML code for export
8426 @end example
8428 @noindent or
8429 @cindex #+BEGIN_HTML
8431 @example
8432 #+BEGIN_HTML
8433 All lines between these markers are exported literally
8434 #+END_HTML
8435 @end example
8438 @node Links, Tables in HTML export, Quoting HTML tags, HTML export
8439 @subsection Links
8441 @cindex links, in HTML export
8442 @cindex internal links, in HTML export
8443 @cindex external links, in HTML export
8444 Internal links (@pxref{Internal links}) will continue to work in HTML.  This
8445 does include automatic links created by radio targets (@pxref{Radio
8446 targets}).  Links to external files will still work if the target file is on
8447 the same @i{relative} path as the published Org file.  Links to other
8448 @file{.org} files will be translated into HTML links under the assumption
8449 that an HTML version also exists of the linked file, at the same relative
8450 path.  @samp{id:} links can then be used to jump to specific entries across
8451 files.  For information related to linking files while publishing them to a
8452 publishing directory see @ref{Publishing links}.
8454 If you want to specify attributes for links, you can do so using a special
8455 @code{#+ATTR_HTML} line to define attributes that will be added to the
8456 @code{<a>} or @code{<img>} tags.  Here is an example that sets @code{title}
8457 and @code{style} attributes for a link:
8459 @example
8460 #+ATTR_HTML: title="The Org-mode homepage" style="color:red;"
8461 [[http://orgmode.org]]
8462 @end example
8464 @node Tables in HTML export, Images in HTML export, Links, HTML export
8465 @subsection Tables
8466 @cindex tables, in HTML
8467 @vindex org-export-html-table-tag
8469 Org-mode tables are exported to HTML using the table tag defined in
8470 @code{org-export-html-table-tag}.  The default setting makes tables without
8471 cell borders and frame.  If you would like to change this for individual
8472 tables, place somthing like the following before the table:
8474 @example
8475 #+CAPTION: This is a table with lines around and between cells
8476 #+ATTR_HTML: border="2" rules="all" frame="all"
8477 @end example
8479 @node Images in HTML export, Text areas in HTML export, Tables in HTML export, HTML export
8480 @subsection Images
8482 @cindex images, inline in HTML
8483 @cindex inlining images in HTML
8484 @vindex org-export-html-inline-images
8485 HTML export can inline images given as links in the Org file, and
8486 it can make an image the clickable part of a link.  By
8487 default@footnote{but see the variable
8488 @code{org-export-html-inline-images}}, images are inlined if a link does
8489 not have a description.  So @samp{[[file:myimg.jpg]]} will be inlined,
8490 while @samp{[[file:myimg.jpg][the image]]} will just produce a link
8491 @samp{the image} that points to the image.  If the description part
8492 itself is a @code{file:} link or a @code{http:} URL pointing to an
8493 image, this image will be inlined and activated so that clicking on the
8494 image will activate the link.  For example, to include a thumbnail that
8495 will link to a high resolution version of the image, you could use:
8497 @example
8498 [[file:highres.jpg][file:thumb.jpg]]
8499 @end example
8501 If you need to add attributes to an inlines image, use a @code{#+ATTR_HTML},
8502 for example:
8504 @example
8505 #+CAPTION: A black cat stalking a spider
8506 #+ATTR_HTML: alt="cat/spider image" title="one second before action"
8507 [[./img/a.jpg]]
8508 @end example
8510 @noindent
8511 and you could use @code{http} addresses just as well.
8513 @node Text areas in HTML export, CSS support, Images in HTML export, HTML export
8514 @subsection Text areas
8516 @cindex text areas, in HTML
8517 An alternative way to publish literal code examples in HTML is to use text
8518 areas, where the example can even be edited before pasting it into an
8519 application.  It is triggered by a @code{-t} switch at an @code{example} or
8520 @code{src} block.  Using this switch disables any options for syntax and
8521 label highlighting, and line numbering, which may be present.  You may also
8522 use @code{-h} and @code{-w} switches to specify the height and width of the
8523 text area, which default to the number of lines in the example, and 80,
8524 respectively.  For example
8526 @example
8527 #+BEGIN_EXAMPLE -t -w 40
8528 (defun org-xor (a b)
8529    "Exclusive or."
8530    (if a (not b) b))
8531 #+END_EXAMPLE
8532 @end example
8535 @node CSS support, Javascript support, Text areas in HTML export, HTML export
8536 @subsection CSS support
8537 @cindex CSS, for HTML export
8538 @cindex HTML export, CSS
8540 @vindex org-export-html-todo-kwd-class-prefix
8541 @vindex org-export-html-tag-class-prefix
8542 You can also give style information for the exported file.  The HTML exporter
8543 assigns the following special CSS classes@footnote{If the classes on TODO
8544 keywords and tags lead to conflicts, use the variables
8545 @code{org-export-html-todo-kwd-class-prefix} and
8546 @code{org-export-html-tag-class-prefix} to make them unique.} to appropriate
8547 parts of the document - your style specifications may change these, in
8548 addition to any of the standard classes like for headlines, tables etc.
8549 @example
8550 p.author            @r{author information, including email}
8551 p.date              @r{publishing date}
8552 p.creator           @r{creator info, about Org-mode version}
8553 .title              @r{document title}
8554 .todo               @r{TODO keywords, all not-done states}
8555 .done               @r{the DONE keywords, all stated the count as done}
8556 .WAITING            @r{each TODO keyword also uses a class named after itself}
8557 .timestamp          @r{time stamp}
8558 .timestamp-kwd      @r{keyword associated with a time stamp, like SCHEDULED}
8559 .timestamp-wrapper  @r{span around keyword plus time stamp}
8560 .tag                @r{tag in a headline}
8561 ._HOME              @r{each tag uses itself as a class, "@@" replaced by "_"}
8562 .target             @r{target for links}
8563 .linenr             @r{the line number in a code example}
8564 .code-highlighted   @r{for highlighting referenced code lines}
8565 div.outline-N       @r{div for outline level N (headline plus text))}
8566 div.outline-text-N  @r{extra div for text at outline level N}
8567 .section-number-N   @r{section number in headlines, different for each level}
8568 div.figure          @r{how to format an inlined image}
8569 pre.src             @r{formatted source code}
8570 pre.example         @r{normal example}
8571 p.verse             @r{verse paragraph}
8572 div.footnotes       @r{footnote section headline}
8573 p.footnote          @r{footnote definition paragraph, containing a footnote}
8574 .footref            @r{a footnote reference number (always a <sup>)}
8575 .footnum            @r{footnote number in footnote definition (always <sup>)}
8576 @end example
8578 @vindex org-export-html-style-default
8579 @vindex org-export-html-style-include-default
8580 @vindex org-export-html-style
8581 @vindex org-export-html-extra
8582 @vindex org-export-html-style-default
8583 Each exported files contains a compact default style that defines these
8584 classes in a basic way@footnote{This style is defined in the constant
8585 @code{org-export-html-style-default}, which you should not modify.  To turn
8586 inclusion of these defaults off, customize
8587 @code{org-export-html-style-include-default}}.  You may overwrite these
8588 settings, or add to them by using the variables @code{org-export-html-style}
8589 (for Org-wide settings) and @code{org-export-html-style-extra} (for more
8590 granular settings, like file-local settings).  To set the latter variable
8591 individually for each file, you can use
8593 @example
8594 #+STYLE: <link rel="stylesheet" type="text/css" href="stylesheet.css" />
8595 @end example
8597 @noindent
8598 For longer style definitions, you can use several such lines.  You could also
8599 directly write a @code{<style>} @code{</style>} section in this way, without
8600 referring to an external file.
8602 @c FIXME: More about header and footer styles
8603 @c FIXME: Talk about links and targets.
8605 @node Javascript support,  , CSS support, HTML export
8606 @subsection Javascript supported display of web pages
8608 @emph{Sebastian Rose} has written a JavaScript program especially designed to
8609 enhance the web viewing experience of HTML files created with Org.  This
8610 program allows you to view large files in two different ways.  The first one
8611 is an @emph{Info}-like mode where each section is displayed separately and
8612 navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
8613 as well, press @kbd{?} for an overview of the available keys).  The second
8614 view type is a @emph{folding} view much like Org provides inside Emacs.  The
8615 script is available at @url{http://orgmode.org/org-info.js} and you can find
8616 the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
8617 We are serving the script from our site, but if you use it a lot, you might
8618 not want to be dependent on @url{orgmode.org} and prefer to install a local
8619 copy on your own web server.
8621 To use the script, you need to make sure that the @file{org-jsinfo.el} module
8622 gets loaded.  It should be loaded by default, but you can try @kbd{M-x
8623 customize-variable @key{RET} org-modules @key{RET}} to convince yourself that
8624 this is indeed the case.  All it then takes to make use of the program is
8625 adding a single line to the Org file:
8627 @example
8628 #+INFOJS_OPT: view:info toc:nil
8629 @end example
8631 @noindent
8632 If this line is found, the HTML header will automatically contain the code
8633 needed to invoke the script.  Using the line above, you can set the following
8634 viewing options:
8636 @example
8637 path:    @r{The path to the script.  The default is to grab the script from}
8638          @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
8639          @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
8640 view:    @r{Initial view when website is first shown.  Possible values are:}
8641          info      @r{Info-like interface with one section per page.}
8642          overview  @r{Folding interface, initially showing only top-level.}
8643          content   @r{Folding interface, starting with all headlines visible.}
8644          showall   @r{Folding interface, all headlines and text visible.}
8645 sdepth:  @r{Maximum headline level that will still become an independent}
8646          @r{section for info and folding modes.  The default is taken from}
8647          @r{@code{org-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
8648          @r{If this is smaller than in @code{org-headline-levels}, each}
8649          @r{info/folding section can still contain children headlines.}
8650 toc:     @r{Should the table of content @emph{initially} be visible?}
8651          @r{Even when @code{nil}, you can always get to the toc with @kbd{i}.}
8652 tdepth:  @r{The depth of the table of contents.  The defaults are taken from}
8653          @r{the variables @code{org-headline-levels} and @code{org-export-with-toc}.}
8654 ftoc:    @r{Does the css of the page specify a fixed position for the toc?}
8655          @r{If yes, the toc will never be displayed as a section.}
8656 ltoc:    @r{Should there be short contents (children) in each section?}
8657          @r{Make this @code{above} it the section should be above initial text.}
8658 mouse:   @r{Headings are highlighted when the mouse is over them.  Should be}
8659          @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
8660 buttons: @r{Should view-toggle buttons be everywhere?  When @code{nil} (the}
8661          @r{default), only one such button will be present.}
8662 @end example
8664 @vindex org-infojs-options
8665 @vindex org-export-html-use-infojs
8666 You can choose default values for these options by customizing the variable
8667 @code{org-infojs-options}.  If you always want to apply the script to your
8668 pages, configure the variable @code{org-export-html-use-infojs}.
8670 @node LaTeX and PDF export, DocBook export, HTML export, Exporting
8671 @section LaTeX and PDF export
8672 @cindex LaTeX export
8673 @cindex PDF export
8675 Org mode contains a La@TeX{} exporter written by Bastien Guerry.  With
8676 further processing, this backend is also used to produce PDF output.  Since
8677 the LaTeX output uses @file{hyperref} to implement links and cross
8678 references, the PDF output file will be fully linked.
8680 @menu
8681 * LaTeX/PDF export commands::   Which key invokes which commands
8682 * Quoting LaTeX code::          Incorporating literal LaTeX code
8683 * Sectioning structure::        Changing sectioning in LaTeX output
8684 * Tables in LaTeX export::      Options for exporting tables to LaTeX
8685 * Images in LaTeX export::      How to insert figures into LaTeX output
8686 @end menu
8688 @node LaTeX/PDF export commands, Quoting LaTeX code, LaTeX and PDF export, LaTeX and PDF export
8689 @subsection LaTeX export commands
8691 @cindex region, active
8692 @cindex active region
8693 @cindex transient-mark-mode
8694 @table @kbd
8695 @kindex C-c C-e l
8696 @item C-c C-e l
8697 Export as La@TeX{} file @file{myfile.tex}.  For an org file
8698 @file{myfile.org}, the ASCII file will be @file{myfile.tex}.  The file will
8699 be overwritten without warning.  If there is an active region@footnote{this
8700 requires @code{transient-mark-mode} to be turned on}, only the region will be
8701 exported. If the selected region is a single tree@footnote{To select the
8702 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
8703 title.  If the tree head entry has or inherits an @code{EXPORT_FILE_NAME}
8704 property, that name will be used for the export.
8705 @kindex C-c C-e L
8706 @item C-c C-e L
8707 Export to a temporary buffer, do not create a file.
8708 @kindex C-c C-e v l
8709 @kindex C-c C-e v L
8710 @item C-c C-e v l
8711 @item C-c C-e v L
8712 Export only the visible part of the document.
8713 @item M-x org-export-region-as-latex
8714 Convert the region to La@TeX{} under the assumption that it was Org mode
8715 syntax before.  This is a global command that can be invoked in any
8716 buffer.
8717 @item M-x org-replace-region-by-latex
8718 Replace the active region (assumed to be in Org mode syntax) by La@TeX{}
8719 code.
8720 @kindex C-c C-e p
8721 @item C-c C-e p
8722 Export as LaTeX and then process to PDF.
8723 @kindex C-c C-e d
8724 @item C-c C-e d
8725 Export as LaTeX and then process to PDF, then open the resulting PDF file.
8726 @end table
8728 @cindex headline levels, for exporting
8729 @vindex org-latex-low-levels
8730 In the exported version, the first 3 outline levels will become
8731 headlines, defining a general document structure.  Additional levels
8732 will be exported as description lists.  The exporter can ignore them or
8733 convert them to a custom string depending on
8734 @code{org-latex-low-levels}.
8736 If you want that transition to occur at a different level, specify it
8737 with a numeric prefix argument. For example,
8739 @example
8740 @kbd{C-2 C-c C-e l}
8741 @end example
8743 @noindent
8744 creates two levels of headings and does the rest as items.
8746 @node Quoting LaTeX code, Sectioning structure, LaTeX/PDF export commands, LaTeX and PDF export
8747 @subsection Quoting LaTeX code
8749 Embedded La@TeX{} as described in @ref{Embedded LaTeX} will be correctly
8750 inserted into the La@TeX{} file.  This includes simple macros like
8751 @samp{\ref@{LABEL@}} to create a cross reference to a figure.  Furthermore,
8752 you can add special code that should only be present in La@TeX{} export with
8753 the following constructs:
8755 @example
8756 #+LaTeX: Literal LaTeX code for export
8757 @end example
8759 @noindent or
8760 @cindex #+BEGIN_LaTeX
8762 @example
8763 #+BEGIN_LaTeX
8764 All lines between these markers are exported literally
8765 #+END_LaTeX
8766 @end example
8768 @node  Sectioning structure, Tables in LaTeX export, Quoting LaTeX code, LaTeX and PDF export
8769 @subsection Sectioning structure
8770 @cindex LaTeX class
8771 @cindex LaTeX sectioning structure
8773 By default, the La@TeX{} output uses the class @code{article}.
8775 @vindex org-export-latex-default-class
8776 @vindex org-export-latex-classes
8777 @cindex #+LATEX_HEADER:
8778 You can change this globally by setting a different value for
8779 @code{org-export-latex-default-class} or locally by adding an option like
8780 @code{#+LaTeX_CLASS: myclass} in your file, or with a @code{:LaTeX_CLASS:}
8781 property that applies when exporting a region containing only this (sub)tree.
8782 The class should be listed in @code{org-export-latex-classes}, where you can
8783 also define the sectioning structure for each class, as well as defining
8784 additional classes.  You can also use @code{#+LATEX_HEADER:
8785 \usepackage@{xyz@}} to add lines to the header.
8787 @node Tables in LaTeX export, Images in LaTeX export, Sectioning structure, LaTeX and PDF export
8788 @subsection Tables in LaTeX export
8789 @cindex tables, in LaTeX export
8791 For LaTeX export of a table, you can specify a label and a caption
8792 (@pxref{Markup rules}).  You can also use the @code{ATTR_LaTeX} line to
8793 request a longtable environment for the table, so that it may span several
8794 pages.  Finally, you can set the alignment string:
8796 @example
8797 #+CAPTION: A long table
8798 #+LABEL: tbl:long
8799 #+ATTR_LaTeX: longtable align=l|lp@{3cm@}r|l
8800 | ..... | ..... |
8801 | ..... | ..... |
8802 @end example
8805 @node Images in LaTeX export,  , Tables in LaTeX export, LaTeX and PDF export
8806 @subsection Images in LaTeX export
8807 @cindex images, inline in LaTeX
8808 @cindex inlining images in LaTeX
8810 Images that are linked to without a description part in the link, like
8811 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
8812 output files resulting from LaTeX output.  Org will use an
8813 @code{\includegraphics} macro to insert the image.  If you have specified a
8814 caption and/or a label as described in @ref{Markup rules}, the figure will
8815 be wrapped into a @code{figure} environment and thus become a floating
8816 element.  Finally, you can use an @code{#+ATTR_LaTeX:} line to specify the
8817 options that can be used in the optional argument of the
8818 @code{\includegraphics} macro.
8820 @example
8821 #+CAPTION:    The black-body emission of the disk around HR 4049
8822 #+LABEL:      fig:SED-HR4049
8823 #+ATTR_LaTeX: width=5cm,angle=90
8824 [[./img/sed-hr4049.pdf]]
8825 @end example
8827 @vindex org-export-latex-inline-image-extensions
8828 If you need references to a label created in this way, write
8829 @samp{\ref@{fig:SED-HR4049@}} just like in LaTeX.  The default settings will
8830 recognize files types that can be included as images during processing by
8831 pdflatex (@file{png}, @file{jpg}, and @file{pdf} files).  If you process your
8832 files in a different way, you may need to customize the variable
8833 @code{org-export-latex-inline-image-extensions}.
8835 @node DocBook export, XOXO export, LaTeX and PDF export, Exporting
8836 @section DocBook export
8837 @cindex DocBook export
8838 @cindex PDF export
8840 Org contains a DocBook exporter written by Baoqiu Cui.  Once an Org file is
8841 exported to DocBook format, it can be further processed to produce other
8842 formats, including PDF, HTML, man pages, etc, using many available DocBook
8843 tools and stylesheets.
8845 Currently DocBook exporter only supports DocBook V5.0.
8847 @menu
8848 * DocBook export commands::     How to invoke DocBook export
8849 * Quoting DocBook code::        Incorporating DocBook code in Org files
8850 * Recursive sections::          Recursive sections in DocBook
8851 * Tables in DocBook export::    Tables are exported as HTML tables
8852 * Images in DocBook export::    How to insert figures into DocBook output
8853 * Special characters::          How to handle special characters
8854 @end menu
8856 @node DocBook export commands, Quoting DocBook code, DocBook export, DocBook export
8857 @subsection DocBook export commands
8859 @cindex region, active
8860 @cindex active region
8861 @cindex transient-mark-mode
8862 @table @kbd
8863 @kindex C-c C-e D
8864 @item C-c C-e D
8865 Export as DocBook file.  For an Org file @file{myfile.org}, the DocBook XML
8866 file will be @file{myfile.xml}.  The file will be overwritten without
8867 warning.  If there is an active region@footnote{This requires
8868 @code{transient-mark-mode} to be turned on}, only the region will be
8869 exported.  If the selected region is a single tree@footnote{To select the
8870 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
8871 title.  If the tree head entry as, or inherits, an @code{EXPORT_FILE_NAME}
8872 property, that name will be used for the export.
8873 @kindex C-c C-e V
8874 @item C-c C-e V
8875 Export as DocBook file, process to PDF, then open the resulting PDF file.
8877 @vindex org-export-docbook-xslt-proc-command
8878 @vindex org-export-docbook-xsl-fo-proc-command
8879 Note that, in order to produce PDF output based on exported DocBook file, you
8880 need to have XSLT processor and XSL-FO processor software installed on your
8881 system.  Check variables @code{org-export-docbook-xslt-proc-command} and
8882 @code{org-export-docbook-xsl-fo-proc-command}.
8884 @kindex C-c C-e v D
8885 @item C-c C-e v D
8886 Export only the visible part of the document.
8887 @end table
8889 @node Quoting DocBook code, Recursive sections, DocBook export commands, DocBook export
8890 @subsection Quoting DocBook code
8892 You can quote DocBook code in Org files and copy it verbatim into exported
8893 DocBook file with the following constructs:
8895 @example
8896 #+DOCBOOK: Literal DocBook code for export
8897 @end example
8899 @noindent or
8900 @cindex #+BEGIN_DOCBOOK
8902 @example
8903 #+BEGIN_DOCBOOK
8904 All lines between these markers are exported by DocBook exporter
8905 literally.
8906 #+END_DOCBOOK
8907 @end example
8909 For example, you can use the following lines to include a DocBook warning
8910 admonition.  As what this warning says, you should pay attention to the
8911 document context when quoting DocBook code in Org files.  You may make
8912 exported DocBook XML file invalid if not quoting DocBook code correctly.
8914 @example
8915 #+BEGIN_DOCBOOK
8916 <warning>
8917   <para>You should know what you are doing when quoting DocBook XML code
8918   in your Org file.  Invalid DocBook XML file may be generated by
8919   DocBook exporter if you are not careful!</para>
8920 </warning>
8921 #+END_DOCBOOK
8922 @end example
8924 @node Recursive sections, Tables in DocBook export, Quoting DocBook code, DocBook export
8925 @subsection Recursive sections
8926 @cindex DocBook recursive sections
8928 DocBook exporter exports Org files as articles using the @code{article}
8929 element in DocBook.  Recursive sections, i.e. @code{section} elements, are
8930 used in exported articles.  Top level headlines in Org files are exported as
8931 top level sections, and lower level headlines are exported as nested
8932 sections.  The entire structure of Org files will be exported completely, no
8933 matter how many nested levels of headlines there are.
8935 Using recursive sections makes it easy to port and reuse exported DocBook
8936 code in other DocBook document types like @code{book} or @code{set}.
8938 @node Tables in DocBook export, Images in DocBook export, Recursive sections, DocBook export
8939 @subsection Tables in DocBook export
8940 @cindex tables, in DocBook export
8942 Tables in Org files are exported as HTML tables, which are supported since
8943 DocBook V4.3.
8945 If a table does not have a caption, an informal table is generated using the
8946 @code{informaltable} element; otherwise, a formal table will be generated
8947 using the @code{table} element.
8949 @node Images in DocBook export, Special characters, Tables in DocBook export, DocBook export
8950 @subsection Images in DocBook export
8951 @cindex images, inline in DocBook
8952 @cindex inlining images in DocBook
8954 Images that are linked to without a description part in the link, like
8955 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]}, will be exported to DocBook
8956 using @code{mediaobject} elements.  Each @code{mediaobject} element contains
8957 an @code{imageobject} that wraps an @code{imagedata} element.  If you have
8958 specified a caption for an image as described in @ref{Markup rules}, a
8959 @code{caption} element will be added in @code{mediaobject}.  If a label is
8960 also specified, it will be exported as an @code{xml:id} attribute of the
8961 @code{mediaobject} element.
8963 @vindex org-export-docbook-default-image-attributes
8964 Image attributes supported by the @code{imagedata} element, like @code{align}
8965 or @code{width}, can be specified in two ways: you can either customize
8966 variable @code{org-export-docbook-default-image-attributes} or use the
8967 @code{#+ATTR_DOCBOOK:} line.  Attributes sepcified in variable
8968 @code{org-export-docbook-default-image-attributes} are applied to all inline
8969 images in the Org file to be exported (unless they are overwritten by image
8970 attributes specified in @code{#+ATTR_DOCBOOK:} lines).
8972 The @code{#+ATTR_DOCBOOK:} line can be used to specify additional image
8973 attributes or overwrite default image attributes for individual images.  If
8974 the same attribute appears in both the @code{#+ATTR_DOCBOOK:} line and
8975 variable @code{org-export-docbook-default-image-attributes}, the former
8976 overwrites the latter.  Here is an example about how image attributes can be
8977 set:
8979 @example
8980 #+CAPTION:    The logo of Org-mode
8981 #+LABEL:      unicorn-svg
8982 #+ATTR_DOCBOOK: scalefit="1" width="100%" depth="100%"
8983 [[./img/org-mode-unicorn.svg]]
8984 @end example
8986 @vindex org-export-docbook-inline-image-extensions
8987 By default, DocBook exporter recognizes the following image file types:
8988 @file{jpeg}, @file{jpg}, @file{png}, @file{gif}, and @file{svg}.  You can
8989 customize variable @code{org-export-docbook-inline-image-extensions} to add
8990 more types to this list as long as DocBook supports them.
8992 @node Special characters,  , Images in DocBook export, DocBook export
8993 @subsection Special characters in DocBook export
8994 @cindex Special characters in DocBook export
8996 @vindex org-export-docbook-doctype
8997 @vindex org-html-entities
8998 Special characters that are written in TeX-like syntax, such as @code{\alpha}
8999 @code{\Gamma}, and @code{\Zeta}, are supported by DocBook exporter.  These
9000 characters are rewritten to XML entities, like @code{&alpha;},
9001 @code{&Gamma;}, and @code{&Zeta;}, based on the list saved in variable
9002 @code{org-html-entities}.  As long as the generated DocBook file includes the
9003 corresponding entities, these special characters are recognized.
9005 You can customize variable @code{org-export-docbook-doctype} to include the
9006 entities you need.  For example, you can set variable
9007 @code{org-export-docbook-doctype} to the following value to recognize all
9008 special characters included in XHTML entities:
9010 @example
9011 "<!DOCTYPE article [
9012 <!ENTITY % xhtml1-symbol PUBLIC
9013 \"-//W3C//ENTITIES Symbol for HTML//EN//XML\"
9014 \"http://www.w3.org/2003/entities/2007/xhtml1-symbol.ent\"
9016 %xhtml1-symbol;
9019 @end example
9021 @node XOXO export, iCalendar export, DocBook export, Exporting
9022 @section XOXO export
9023 @cindex XOXO export
9025 Org mode contains an exporter that produces XOXO-style output.
9026 Currently, this exporter only handles the general outline structure and
9027 does not interpret any additional Org mode features.
9029 @table @kbd
9030 @kindex C-c C-e x
9031 @item C-c C-e x
9032 Export as XOXO file @file{myfile.html}.
9033 @kindex C-c C-e v
9034 @item C-c C-e v x
9035 Export only the visible part of the document.
9036 @end table
9038 @node iCalendar export,  , XOXO export, Exporting
9039 @section iCalendar export
9040 @cindex iCalendar export
9042 @vindex org-icalendar-include-todo
9043 @vindex org-icalendar-use-deadline
9044 @vindex org-icalendar-use-scheduled
9045 @vindex org-icalendar-categories
9046 Some people use Org mode for keeping track of projects, but still prefer a
9047 standard calendar application for anniversaries and appointments.  In this
9048 case it can be useful to show deadlines and other time-stamped items in Org
9049 files in the calendar application.  Org mode can export calendar information
9050 in the standard iCalendar format.  If you also want to have TODO entries
9051 included in the export, configure the variable
9052 @code{org-icalendar-include-todo}.  Plain time stamps are exported as VEVENT,
9053 and TODO items as VTODO.  It will also create events from deadlines that are
9054 in non-TODO items.  Deadlines and scheduling dates in TODO items will be used
9055 to set the start and due dates for the todo entry@footnote{See the variables
9056 @code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}.
9057 As categories, it will use the tags locally defined in the heading, and the
9058 file/tree category@footnote{To add inherited tags or the TODO state,
9059 configure the variable @code{org-icalendar-categories}.}.
9061 @vindex org-icalendar-store-UID
9062 The iCalendar standard requires each entry to have a globally unique
9063 identifier (UID).  Org creates these identifiers during export.  If you set
9064 the variable @code{org-icalendar-store-UID}, the UID will be stored in the
9065 @code{:ID:} property of the entry and re-used next time you report this
9066 entry.  Since a single entry can give rise to multiple iCalendar entries (as
9067 a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
9068 prefixes to the UID, depending on what triggered the inclusion of the entry.
9069 In this way the UID remains unique, but a synchronization program can still
9070 figure out from which entry all the different instances originate.
9072 @table @kbd
9073 @kindex C-c C-e i
9074 @item C-c C-e i
9075 Create iCalendar entries for the current file and store them in the same
9076 directory, using a file extension @file{.ics}.
9077 @kindex C-c C-e I
9078 @item C-c C-e I
9079 @vindex org-agenda-files
9080 Like @kbd{C-c C-e i}, but do this for all files in
9081 @code{org-agenda-files}.  For each of these files, a separate iCalendar
9082 file will be written.
9083 @kindex C-c C-e c
9084 @item C-c C-e c
9085 @vindex org-combined-agenda-icalendar-file
9086 Create a single large iCalendar file from all files in
9087 @code{org-agenda-files} and write it to the file given by
9088 @code{org-combined-agenda-icalendar-file}.
9089 @end table
9091 @vindex org-use-property-inheritance
9092 @vindex org-icalendar-include-body
9093 The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION
9094 property can be inherited from higher in the hierarchy if you configure
9095 @code{org-use-property-inheritance} accordingly.} properties if the selected
9096 entries have them.  If not, the summary will be derived from the headline,
9097 and the description from the body (limited to
9098 @code{org-icalendar-include-body} characters).
9100 How this calendar is best read and updated, that depends on the application
9101 you are using.  The FAQ covers this issue.
9103 @node Publishing, Miscellaneous, Exporting, Top
9104 @chapter Publishing
9105 @cindex publishing
9107 Org includes a publishing management system that allows you to configure
9108 automatic HTML conversion of @emph{projects} composed of interlinked org
9109 files.  You can also configure Org to automatically upload your exported HTML
9110 pages and related attachments, such as images and source code files, to a web
9111 server.
9113 You can also use Org to convert files into PDF, or even combine HTML and PDF
9114 conversion so that files are available in both formats on the server.
9116 Publishing has been contributed to Org by David O'Toole.
9118 @menu
9119 * Configuration::               Defining projects
9120 * Uploading files::             How to get files up on the server
9121 * Sample configuration::        Example projects
9122 * Triggering publication::      Publication commands
9123 @end menu
9125 @node Configuration, Uploading files, Publishing, Publishing
9126 @section Configuration
9128 Publishing needs significant configuration to specify files, destination
9129 and many other properties of a project.
9131 @menu
9132 * Project alist::               The central configuration variable
9133 * Sources and destinations::    From here to there
9134 * Selecting files::             What files are part of the project?
9135 * Publishing action::           Setting the function doing the publishing
9136 * Publishing options::          Tweaking HTML export
9137 * Publishing links::            Which links keep working after publishing?
9138 * Project page index::          Publishing a list of project files
9139 @end menu
9141 @node Project alist, Sources and destinations, Configuration, Configuration
9142 @subsection The variable @code{org-publish-project-alist}
9143 @cindex org-publish-project-alist
9144 @cindex projects, for publishing
9146 @vindex org-publish-project-alist
9147 Publishing is configured almost entirely through setting the value of one
9148 variable, called @code{org-publish-project-alist}.  Each element of the list
9149 configures one project, and may be in one of the two following forms:
9151 @lisp
9152    ("project-name" :property value :property value ...)
9153 @r{or}
9154    ("project-name" :components ("project-name" "project-name" ...))
9156 @end lisp
9158 In both cases, projects are configured by specifying property values.  A
9159 project defines the set of files that will be published, as well as the
9160 publishing configuration to use when publishing those files.  When a project
9161 takes the second form listed above, the individual members of the
9162 @code{:components} property are taken to be sub-projects, which group
9163 together files requiring different publishing options.  When you publish such
9164 a ``meta-project'', all the components will also be published, in the
9165 sequence given.
9167 @node Sources and destinations, Selecting files, Project alist, Configuration
9168 @subsection Sources and destinations for files
9169 @cindex directories, for publishing
9171 Most properties are optional, but some should always be set.  In
9172 particular, Org needs to know where to look for source files,
9173 and where to put published files.
9175 @multitable @columnfractions 0.3 0.7
9176 @item @code{:base-directory}
9177 @tab Directory containing publishing source files
9178 @item @code{:publishing-directory}
9179 @tab Directory where output files will be published.  You can directly
9180 publish to a webserver using a file name syntax appropriate for
9181 the Emacs @file{tramp} package.  Or you can publish to a local directory and
9182 use external tools to upload your website (@pxref{Uploading files}).
9183 @item @code{:preparation-function}
9184 @tab Function called before starting the publishing process, for example to
9185 run @code{make} for updating files to be published.
9186 @item @code{:completion-function}
9187 @tab Function called after finishing the publishing process, for example to
9188 change permissions of the resulting files.
9189 @end multitable
9190 @noindent
9192 @node Selecting files, Publishing action, Sources and destinations, Configuration
9193 @subsection Selecting files
9194 @cindex files, selecting for publishing
9196 By default, all files with extension @file{.org} in the base directory
9197 are considered part of the project.  This can be modified by setting the
9198 properties
9199 @multitable @columnfractions 0.25 0.75
9200 @item @code{:base-extension}
9201 @tab Extension (without the dot!) of source files.  This actually is a
9202 regular expression.  Set this to the symbol @code{any} if you want to get all
9203 files in @code{:base-directory}, even without extension.
9205 @item @code{:exclude}
9206 @tab Regular expression to match file names that should not be
9207 published, even though they have been selected on the basis of their
9208 extension.
9210 @item @code{:include}
9211 @tab List of files to be included regardless of @code{:base-extension}
9212 and @code{:exclude}.
9213 @end multitable
9215 @node Publishing action, Publishing options, Selecting files, Configuration
9216 @subsection Publishing action
9217 @cindex action, for publishing
9219 Publishing means that a file is copied to the destination directory and
9220 possibly transformed in the process.  The default transformation is to export
9221 Org files as HTML files, and this is done by the function
9222 @code{org-publish-org-to-html} which calls the HTML exporter (@pxref{HTML
9223 export}).  But you also can publish your as PDF files using
9224 @code{org-publish-org-to-pdf}.  Other files like images only need to be
9225 copied to the publishing destination, for this you may use
9226 @code{org-publish-attachment}.  For non-Org files, you always need to provide
9227 specify the publishing function:
9229 @multitable @columnfractions 0.3 0.7
9230 @item @code{:publishing-function}
9231 @tab Function executing the publication of a file.  This may also be a
9232 list of functions, which will all be called in turn.
9233 @end multitable
9235 The function must accept two arguments: a property list containing at least a
9236 @code{:publishing-directory} property, and the name of the file to be
9237 published.  It should take the specified file, make the necessary
9238 transformation (if any) and place the result into the destination folder.
9240 @node Publishing options, Publishing links, Publishing action, Configuration
9241 @subsection Options for the HTML/LaTeX exporters
9242 @cindex options, for publishing
9244 The property list can be used to set many export options for the HTML
9245 and La@TeX{} exporters.  In most cases, these properties correspond to user
9246 variables in Org.  The table below lists these properties along
9247 with the variable they belong to.  See the documentation string for the
9248 respective variable for details.
9250 @vindex org-export-html-link-up
9251 @vindex org-export-html-link-home
9252 @vindex org-export-default-language
9253 @vindex org-display-custom-times
9254 @vindex org-export-headline-levels
9255 @vindex org-export-with-section-numbers
9256 @vindex org-export-section-number-format
9257 @vindex org-export-with-toc
9258 @vindex org-export-preserve-breaks
9259 @vindex org-export-with-archived-trees
9260 @vindex org-export-with-emphasize
9261 @vindex org-export-with-sub-superscripts
9262 @vindex org-export-with-special-strings
9263 @vindex org-export-with-footnotes
9264 @vindex org-export-with-drawers
9265 @vindex org-export-with-tags
9266 @vindex org-export-with-todo-keywords
9267 @vindex org-export-with-priority
9268 @vindex org-export-with-TeX-macros
9269 @vindex org-export-with-LaTeX-fragments
9270 @vindex org-export-skip-text-before-1st-heading
9271 @vindex org-export-with-fixed-width
9272 @vindex org-export-with-timestamps
9273 @vindex org-export-author-info
9274 @vindex org-export-creator-info
9275 @vindex org-export-with-tables
9276 @vindex org-export-highlight-first-table-line
9277 @vindex org-export-html-style-include-default
9278 @vindex org-export-html-style
9279 @vindex org-export-html-style-extra
9280 @vindex org-export-html-link-org-files-as-html
9281 @vindex org-export-html-inline-images
9282 @vindex org-export-html-extension
9283 @vindex org-export-html-table-tag
9284 @vindex org-export-html-expand
9285 @vindex org-export-html-with-timestamp
9286 @vindex org-export-publishing-directory
9287 @vindex org-export-html-preamble
9288 @vindex org-export-html-postamble
9289 @vindex org-export-html-auto-preamble
9290 @vindex org-export-html-auto-postamble
9291 @vindex user-full-name
9292 @vindex user-mail-address
9293 @vindex org-export-select-tags
9294 @vindex org-export-exclude-tags
9296 @multitable @columnfractions 0.32 0.68
9297 @item @code{:link-up}               @tab @code{org-export-html-link-up}
9298 @item @code{:link-home}             @tab @code{org-export-html-link-home}
9299 @item @code{:language}              @tab @code{org-export-default-language}
9300 @item @code{:customtime}            @tab @code{org-display-custom-times}
9301 @item @code{:headline-levels}       @tab @code{org-export-headline-levels}
9302 @item @code{:section-numbers}       @tab @code{org-export-with-section-numbers}
9303 @item @code{:section-number-format} @tab @code{org-export-section-number-format}
9304 @item @code{:table-of-contents}     @tab @code{org-export-with-toc}
9305 @item @code{:preserve-breaks}       @tab @code{org-export-preserve-breaks}
9306 @item @code{:archived-trees}        @tab @code{org-export-with-archived-trees}
9307 @item @code{:emphasize}             @tab @code{org-export-with-emphasize}
9308 @item @code{:sub-superscript}       @tab @code{org-export-with-sub-superscripts}
9309 @item @code{:special-strings}       @tab @code{org-export-with-special-strings}
9310 @item @code{:footnotes}             @tab @code{org-export-with-footnotes}
9311 @item @code{:drawers}               @tab @code{org-export-with-drawers}
9312 @item @code{:tags}                  @tab @code{org-export-with-tags}
9313 @item @code{:todo-keywords}         @tab @code{org-export-with-todo-keywords}
9314 @item @code{:priority}              @tab @code{org-export-with-priority}
9315 @item @code{:TeX-macros}            @tab @code{org-export-with-TeX-macros}
9316 @item @code{:LaTeX-fragments}       @tab @code{org-export-with-LaTeX-fragments}
9317 @item @code{:skip-before-1st-heading} @tab @code{org-export-skip-text-before-1st-heading}
9318 @item @code{:fixed-width}           @tab @code{org-export-with-fixed-width}
9319 @item @code{:timestamps}            @tab @code{org-export-with-timestamps}
9320 @item @code{:author-info}           @tab @code{org-export-author-info}
9321 @item @code{:creator-info}          @tab @code{org-export-creator-info}
9322 @item @code{:tables}                @tab @code{org-export-with-tables}
9323 @item @code{:table-auto-headline}   @tab @code{org-export-highlight-first-table-line}
9324 @item @code{:style-include-default} @tab @code{org-export-html-style-include-default}
9325 @item @code{:style}                 @tab @code{org-export-html-style}
9326 @item @code{:style-extra}           @tab @code{org-export-html-style-extra}
9327 @item @code{:convert-org-links}     @tab @code{org-export-html-link-org-files-as-html}
9328 @item @code{:inline-images}         @tab @code{org-export-html-inline-images}
9329 @item @code{:html-extension}        @tab @code{org-export-html-extension}
9330 @item @code{:html-table-tag}        @tab @code{org-export-html-table-tag}
9331 @item @code{:expand-quoted-html}    @tab @code{org-export-html-expand}
9332 @item @code{:timestamp}             @tab @code{org-export-html-with-timestamp}
9333 @item @code{:publishing-directory}  @tab @code{org-export-publishing-directory}
9334 @item @code{:preamble}              @tab @code{org-export-html-preamble}
9335 @item @code{:postamble}             @tab @code{org-export-html-postamble}
9336 @item @code{:auto-preamble}         @tab @code{org-export-html-auto-preamble}
9337 @item @code{:auto-postamble}        @tab @code{org-export-html-auto-postamble}
9338 @item @code{:author}                @tab @code{user-full-name}
9339 @item @code{:email}                 @tab @code{user-mail-address} : @code{addr;addr;..}
9340 @item @code{:select-tags}           @tab @code{org-export-select-tags}
9341 @item @code{:exclude-tags}          @tab @code{org-export-exclude-tags}
9342 @end multitable
9344 Most of the @code{org-export-with-*} variables have the same effect in
9345 both HTML and La@TeX{} exporters, except for @code{:TeX-macros} and
9346 @code{:LaTeX-fragments}, respectively @code{nil} and @code{t} in the
9347 La@TeX{} export.
9349 @vindex org-publish-project-alist
9350 When a property is given a value in @code{org-publish-project-alist},
9351 its setting overrides the value of the corresponding user variable (if
9352 any) during publishing.  Options set within a file (@pxref{Export
9353 options}), however, override everything.
9355 @node Publishing links, Project page index, Publishing options, Configuration
9356 @subsection Links between published files
9357 @cindex links, publishing
9359 To create a link from one Org file to another, you would use
9360 something like @samp{[[file:foo.org][The foo]]} or simply
9361 @samp{file:foo.org.} (@pxref{Hyperlinks}).  Upon publishing this link
9362 becomes a link to @file{foo.html}.  In this way, you can interlink the
9363 pages of your "org web" project and the links will work as expected when
9364 you publish them to HTML.
9366 You may also link to related files, such as images. Provided you are careful
9367 with relative pathnames, and provided you have also configured Org to upload
9368 the related files, these links will work too. See @ref{Complex example} for
9369 an example of this usage.
9371 Sometimes an Org file to be published may contain links that are
9372 only valid in your production environment, but not in the publishing
9373 location.  In this case, use the property
9375 @multitable @columnfractions 0.4 0.6
9376 @item @code{:link-validation-function}
9377 @tab Function to validate links
9378 @end multitable
9380 @noindent
9381 to define a function for checking link validity.  This function must
9382 accept two arguments, the file name and a directory relative to which
9383 the file name is interpreted in the production environment.  If this
9384 function returns @code{nil}, then the HTML generator will only insert a
9385 description into the HTML file, but no link.  One option for this
9386 function is @code{org-publish-validate-link} which checks if the given
9387 file is part of any project in @code{org-publish-project-alist}.
9389 @node Project page index,  , Publishing links, Configuration
9390 @subsection Project page index
9391 @cindex index, of published pages
9393 The following properties may be used to control publishing of an
9394 index of files or a summary page for a given project.
9396 @multitable @columnfractions 0.25 0.75
9397 @item @code{:auto-index}
9398 @tab When non-nil, publish an index during @code{org-publish-current-project}
9399 or @code{org-publish-all}.
9401 @item @code{:index-filename}
9402 @tab Filename for output of index. Defaults to @file{sitemap.org} (which
9403 becomes @file{sitemap.html}).
9405 @item @code{:index-title}
9406 @tab Title of index page. Defaults to name of file.
9408 @item @code{:index-function}
9409 @tab Plug-in function to use for generation of index.
9410 Defaults to @code{org-publish-org-index}, which generates a plain list
9411 of links to all files in the project.
9412 @end multitable
9414 @node Uploading files, Sample configuration, Configuration, Publishing
9415 @section Uploading files
9416 @cindex rsync
9417 @cindex unison
9419 For those people already utilising third party sync tools such as
9420 @file{rsync} or @file{unison}, it might be preferable not to use the built in
9421 @i{remote} publishing facilities of Org-mode which rely heavily on
9422 @file{Tramp}.  @file{Tramp}, while very useful and powerful, tends not to be
9423 so efficient for multiple file transfer and has been known to cause problems
9424 under heavy usage.
9426 Specialised synchronization utilities offer several advantages.  In addition
9427 to timestamp comparison, they also do content and permissions/attribute
9428 checks.  For this reason you might prefer to publish your web to a local
9429 directory (possibly even @i{in place} with your Org files) and then use
9430 @file{unison} or @file{rsync} to do the synchronisation with the remote host.
9432 Since Unison (for example) can be configured as to which files to transfer to
9433 a certain remote destination, it can greatly simplify the project publishing
9434 definition.  Simply keep all files in the correct location, process your Org
9435 files with @code{org-publish} and let the synchronization tool do the rest.
9436 You do not need, in this scenario, to include attachments such as @file{jpg},
9437 @file{css} or @file{gif} files in the project definition since the 3rd party
9438 tool syncs them.
9440 Publishing to a local directory is also much faster than to a remote one, so
9441 that you can afford more easily to republish entire projects.  If you set
9442 @code{org-publish-use-timestamps-flag} to @code{nil}, you gain the main
9443 benefit of re-including any changed external files such as source example
9444 files you might include with @code{#+INCLUDE}.  The timestamp mechanism in
9445 Org is not smart enough to detect if included files have been modified.
9447 @node Sample configuration, Triggering publication, Uploading files, Publishing
9448 @section Sample configuration
9450 Below we provide two example configurations.  The first one is a simple
9451 project publishing only a set of Org files.  The second example is
9452 more complex, with a multi-component project.
9454 @menu
9455 * Simple example::              One-component publishing
9456 * Complex example::             A multi-component publishing example
9457 @end menu
9459 @node Simple example, Complex example, Sample configuration, Sample configuration
9460 @subsection Example: simple publishing configuration
9462 This example publishes a set of Org files to the @file{public_html}
9463 directory on the local machine.
9465 @lisp
9466 (setq org-publish-project-alist
9467       '(("org"
9468          :base-directory "~/org/"
9469          :publishing-directory "~/public_html"
9470          :section-numbers nil
9471          :table-of-contents nil
9472          :style "<link rel=\"stylesheet\"
9473                 href=\"../other/mystyle.css\"
9474                 type=\"text/css\">")))
9475 @end lisp
9477 @node Complex example,  , Simple example, Sample configuration
9478 @subsection Example: complex publishing configuration
9480 This more complicated example publishes an entire website, including
9481 org files converted to HTML, image files, emacs lisp source code, and
9482 style sheets. The publishing-directory is remote and private files are
9483 excluded.
9485 To ensure that links are preserved, care should be taken to replicate
9486 your directory structure on the web server, and to use relative file
9487 paths. For example, if your org files are kept in @file{~/org} and your
9488 publishable images in @file{~/images}, you'd link to an image with
9490 @example
9491 file:../images/myimage.png
9492 @end example
9494 On the web server, the relative path to the image should be the
9495 same. You can accomplish this by setting up an "images" folder in the
9496 right place on the web server, and publishing images to it.
9498 @lisp
9499 (setq org-publish-project-alist
9500       '(("orgfiles"
9501           :base-directory "~/org/"
9502           :base-extension "org"
9503           :publishing-directory "/ssh:user@@host:~/html/notebook/"
9504           :publishing-function org-publish-org-to-html
9505           :exclude "PrivatePage.org"   ;; regexp
9506           :headline-levels 3
9507           :section-numbers nil
9508           :table-of-contents nil
9509           :style "<link rel=\"stylesheet\"
9510                   href=\"../other/mystyle.css\" type=\"text/css\">"
9511           :auto-preamble t
9512           :auto-postamble nil)
9514          ("images"
9515           :base-directory "~/images/"
9516           :base-extension "jpg\\|gif\\|png"
9517           :publishing-directory "/ssh:user@@host:~/html/images/"
9518           :publishing-function org-publish-attachment)
9520          ("other"
9521           :base-directory "~/other/"
9522           :base-extension "css\\|el"
9523           :publishing-directory "/ssh:user@@host:~/html/other/"
9524           :publishing-function org-publish-attachment)
9525          ("website" :components ("orgfiles" "images" "other"))))
9526 @end lisp
9528 @node Triggering publication,  , Sample configuration, Publishing
9529 @section Triggering publication
9531 Once properly configured, Org can publish with the following commands:
9533 @table @kbd
9534 @item C-c C-e C
9535 Prompt for a specific project and publish all files that belong to it.
9536 @item C-c C-e P
9537 Publish the project containing the current file.
9538 @item C-c C-e F
9539 Publish only the current file.
9540 @item C-c C-e A
9541 Publish all projects.
9542 @end table
9544 @vindex org-publish-use-timestamps-flag
9545 Org uses timestamps to track when a file has changed. The above functions
9546 normally only publish changed files. You can override this and force
9547 publishing of all files by giving a prefix argument, or by customizing the
9548 variable @code{org-publish-use-timestamps-flag}.  This may be necessary in
9549 particular if files include other files via @code{#+SETUPFILE:} or
9550 @code{#+INCLUDE:}
9552 @node Miscellaneous, Hacking, Publishing, Top
9553 @chapter Miscellaneous
9555 @menu
9556 * Completion::                  M-TAB knows what you need
9557 * Customization::               Adapting Org to your taste
9558 * In-buffer settings::          Overview of the #+KEYWORDS
9559 * The very busy C-c C-c key::   When in doubt, press C-c C-c
9560 * Clean view::                  Getting rid of leading stars in the outline
9561 * TTY keys::                    Using Org on a tty
9562 * Interaction::                 Other Emacs packages
9563 @end menu
9566 @node Completion, Customization, Miscellaneous, Miscellaneous
9567 @section Completion
9568 @cindex completion, of @TeX{} symbols
9569 @cindex completion, of TODO keywords
9570 @cindex completion, of dictionary words
9571 @cindex completion, of option keywords
9572 @cindex completion, of tags
9573 @cindex completion, of property keys
9574 @cindex completion, of link abbreviations
9575 @cindex @TeX{} symbol completion
9576 @cindex TODO keywords completion
9577 @cindex dictionary word completion
9578 @cindex option keyword completion
9579 @cindex tag completion
9580 @cindex link abbreviations, completion of
9582 Org supports in-buffer completion.  This type of completion does
9583 not make use of the minibuffer.  You simply type a few letters into
9584 the buffer and use the key to complete text right there.
9586 @table @kbd
9587 @kindex M-@key{TAB}
9588 @item M-@key{TAB}
9589 Complete word at point
9590 @itemize @bullet
9591 @item
9592 At the beginning of a headline, complete TODO keywords.
9593 @item
9594 After @samp{\}, complete @TeX{} symbols supported by the exporter.
9595 @item
9596 After @samp{*}, complete headlines in the current buffer so that they
9597 can be used in search links like @samp{[[*find this headline]]}.
9598 @item
9599 After @samp{:} in a headline, complete tags.  The list of tags is taken
9600 from the variable @code{org-tag-alist} (possibly set through the
9601 @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
9602 dynamically from all tags used in the current buffer.
9603 @item
9604 After @samp{:} and not in a headline, complete property keys.  The list
9605 of keys is constructed dynamically from all keys used in the current
9606 buffer.
9607 @item
9608 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
9609 @item
9610 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
9611 @samp{OPTIONS} which set file-specific options for Org mode.  When the
9612 option keyword is already complete, pressing @kbd{M-@key{TAB}} again
9613 will insert example settings for this keyword.
9614 @item
9615 In the line after @samp{#+STARTUP: }, complete startup keywords,
9616 i.e. valid keys for this line.
9617 @item
9618 Elsewhere, complete dictionary words using Ispell.
9619 @end itemize
9620 @end table
9622 @node Customization, In-buffer settings, Completion, Miscellaneous
9623 @section Customization
9624 @cindex customization
9625 @cindex options, for customization
9626 @cindex variables, for customization
9628 There are more than 180 variables that can be used to customize
9629 Org.  For the sake of compactness of the manual, I am not
9630 describing the variables here.  A structured overview of customization
9631 variables is available with @kbd{M-x org-customize}.  Or select
9632 @code{Browse Org Group} from the @code{Org->Customization} menu.  Many
9633 settings can also be activated on a per-file basis, by putting special
9634 lines into the buffer (@pxref{In-buffer settings}).
9636 @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous
9637 @section Summary of in-buffer settings
9638 @cindex in-buffer settings
9639 @cindex special keywords
9641 Org mode uses special lines in the buffer to define settings on a
9642 per-file basis.  These lines start with a @samp{#+} followed by a
9643 keyword, a colon, and then individual words defining a setting.  Several
9644 setting words can be in the same line, but you can also have multiple
9645 lines for the keyword.  While these settings are described throughout
9646 the manual, here is a summary.  After changing any of those lines in the
9647 buffer, press @kbd{C-c C-c} with the cursor still in the line to
9648 activate the changes immediately.  Otherwise they become effective only
9649 when the file is visited again in a new Emacs session.
9651 @vindex org-archive-location
9652 @table @kbd
9653 @item #+ARCHIVE: %s_done::
9654 This line sets the archive location for the agenda file.  It applies for
9655 all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
9656 of the file.  The first such line also applies to any entries before it.
9657 The corresponding variable is @code{org-archive-location}.
9658 @item #+CATEGORY:
9659 This line sets the category for the agenda file.  The category applies
9660 for all subsequent lines until the next @samp{#+CATEGORY} line, or the
9661 end of the file.  The first such line also applies to any entries before it.
9662 @item #+COLUMNS: %25ITEM .....
9663 Set the default format for columns view.  This format applies when
9664 columns view is invoked in location where no @code{COLUMNS} property
9665 applies.
9666 @item #+CONSTANTS: name1=value1 ...
9667 @vindex org-table-formula-constants
9668 @vindex org-table-formula
9669 Set file-local values for constants to be used in table formulas.  This
9670 line set the local variable @code{org-table-formula-constants-local}.
9671 The global version of this variable is
9672 @code{org-table-formula-constants}.
9673 @item #+FILETAGS: :tag1:tag2:tag3:
9674 Set tags that can be inherited by any entry in the file, including the
9675 top-level entries.
9676 @item #+DRAWERS: NAME1 .....
9677 @vindex org-drawers
9678 Set the file-local set of drawers.  The corresponding global variable is
9679 @code{org-drawers}.
9680 @item #+LINK:  linkword replace
9681 @vindex org-link-abbrev-alist
9682 These lines (several are allowed) specify link abbreviations.
9683 @xref{Link abbreviations}.  The corresponding variable is
9684 @code{org-link-abbrev-alist}.
9685 @item #+PRIORITIES: highest lowest default
9686 @vindex org-highest-priority
9687 @vindex org-lowest-priority
9688 @vindex org-default-priority
9689 This line sets the limits and the default for the priorities.  All three
9690 must be either letters A-Z or numbers 0-9.  The highest priority must
9691 have a lower ASCII number that the lowest priority.
9692 @item #+PROPERTY: Property_Name Value
9693 This line sets a default inheritance value for entries in the current
9694 buffer, most useful for specifying the allowed values of a property.
9695 @cindex #+SETUPFILE
9696 @item #+SETUPFILE: file
9697 This line defines a file that holds more in-buffer setup.  Normally this is
9698 entirely ignored.  Only when the buffer is parsed for option-setting lines
9699 (i.e. when starting Org mode for a file, when pressing @kbd{C-c C-c} in a
9700 settings line, or when exporting), then the contents of this file are parsed
9701 as if they had been included in the buffer.  In particular, the file can be
9702 any other Org mode file with internal setup.  You can visit the file the
9703 cursor is in the line with @kbd{C-c '}.
9704 @item #+STARTUP:
9705 @vindex org-startup-folded
9706 This line sets options to be used at startup of Org mode, when an
9707 Org file is being visited.  The first set of options deals with the
9708 initial visibility of the outline tree.  The corresponding variable for
9709 global default settings is @code{org-startup-folded}, with a default
9710 value @code{t}, which means @code{overview}.
9711 @cindex @code{overview}, STARTUP keyword
9712 @cindex @code{content}, STARTUP keyword
9713 @cindex @code{showall}, STARTUP keyword
9714 @example
9715 overview   @r{top-level headlines only}
9716 content    @r{all headlines}
9717 showall    @r{no folding at all, show everything}
9718 @end example
9719 @vindex org-startup-align-all-tables
9720 Then there are options for aligning tables upon visiting a file.  This
9721 is useful in files containing narrowed table columns.  The corresponding
9722 variable is @code{org-startup-align-all-tables}, with a default value
9723 @code{nil}.
9724 @cindex @code{align}, STARTUP keyword
9725 @cindex @code{noalign}, STARTUP keyword
9726 @example
9727 align      @r{align all tables}
9728 noalign    @r{don't align tables on startup}
9729 @end example
9730 @vindex org-log-done
9731 @vindex org-log-note-clock-out
9732 @vindex org-log-repeat
9733 Logging closing and reinstating TODO items, and clock intervals
9734 (variables @code{org-log-done}, @code{org-log-note-clock-out}, and
9735 @code{org-log-repeat}) can be configured using these options.
9736 @cindex @code{logdone}, STARTUP keyword
9737 @cindex @code{lognotedone}, STARTUP keyword
9738 @cindex @code{nologdone}, STARTUP keyword
9739 @cindex @code{lognoteclock-out}, STARTUP keyword
9740 @cindex @code{nolognoteclock-out}, STARTUP keyword
9741 @cindex @code{logrepeat}, STARTUP keyword
9742 @cindex @code{lognoterepeat}, STARTUP keyword
9743 @cindex @code{nologrepeat}, STARTUP keyword
9744 @example
9745 logdone            @r{record a timestamp when an item is marked DONE}
9746 lognotedone        @r{record timestamp and a note when DONE}
9747 nologdone          @r{don't record when items are marked DONE}
9748 logrepeat          @r{record a time when reinstating a repeating item}
9749 lognoterepeat      @r{record a note when reinstating a repeating item}
9750 nologrepeat        @r{do not record when reinstating repeating item}
9751 lognoteclock-out   @r{record a note when clocking out}
9752 nolognoteclock-out @r{don't record a note when clocking out}
9753 @end example
9754 @vindex org-hide-leading-stars
9755 @vindex org-odd-levels-only
9756 Here are the options for hiding leading stars in outline headings, and for
9757 indenting outlines.  The corresponding variables are
9758 @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
9759 default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
9760 @cindex @code{hidestars}, STARTUP keyword
9761 @cindex @code{showstars}, STARTUP keyword
9762 @cindex @code{odd}, STARTUP keyword
9763 @cindex @code{even}, STARTUP keyword
9764 @example
9765 hidestars  @r{make all but one of the stars starting a headline invisible.}
9766 showstars  @r{show all stars starting a headline}
9767 indent     @r{virtual indentation according to outline level}
9768 noindent   @r{no virtual indentation according to outline level}
9769 odd        @r{allow only odd outline levels (1,3,...)}
9770 oddeven    @r{allow all outline levels}
9771 @end example
9772 @vindex org-put-time-stamp-overlays
9773 @vindex org-time-stamp-overlay-formats
9774 To turn on custom format overlays over time stamps (variables
9775 @code{org-put-time-stamp-overlays} and
9776 @code{org-time-stamp-overlay-formats}), use
9777 @cindex @code{customtime}, STARTUP keyword
9778 @example
9779 customtime @r{overlay custom time format}
9780 @end example
9781 @vindex constants-unit-system
9782 The following options influence the table spreadsheet (variable
9783 @code{constants-unit-system}).
9784 @cindex @code{constcgs}, STARTUP keyword
9785 @cindex @code{constSI}, STARTUP keyword
9786 @example
9787 constcgs   @r{@file{constants.el} should use the c-g-s unit system}
9788 constSI    @r{@file{constants.el} should use the SI unit system}
9789 @end example
9790 @vindex org-footnote-define-inline
9791 @vindex org-footnote-auto-label
9792 To influence footnote settings, use the following keywords.  The
9793 corresponding variables are @code{org-footnote-define-inline} and
9794 @code{org-footnote-auto-label}.
9795 @cindex @code{fninline}, STARTUP keyword
9796 @cindex @code{fnnoinline}, STARTUP keyword
9797 @cindex @code{fnlocal}, STARTUP keyword
9798 @cindex @code{fnprompt}, STARTUP keyword
9799 @cindex @code{fnauto}, STARTUP keyword
9800 @cindex @code{fnconfirm}, STARTUP keyword
9801 @cindex @code{fnplain}, STARTUP keyword
9802 @example
9803 fninline    @r{define footnotes inline}
9804 fnnoinline  @r{define footnotes in separate section}
9805 fnlocal     @r{define footnotes near first reference, but not inline}
9806 fnprompt    @r{prompt for footnote labels}
9807 fnauto      @r{create [fn:1]-like labels automatically (default)}
9808 fnconfirm   @r{offer automatic label for editing or confirmation}
9809 fnplain     @r{create [1]-like labels automatically}
9810 @end example
9811 @item #+TAGS:  TAG1(c1) TAG2(c2)
9812 @vindex org-tag-alist
9813 These lines (several such lines are allowed) specify the valid tags in
9814 this file, and (potentially) the corresponding @emph{fast tag selection}
9815 keys.  The corresponding variable is @code{org-tag-alist}.
9816 @item #+TBLFM:
9817 This line contains the formulas for the table directly above the line.
9818 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS, #+DATE:,
9819 @itemx #+DESCRIPTION:, #+KEYWORDS:
9820 @itemx #+LATEX_HEADER:, #+STYLE:, #+LINK_UP:, #+LINK_HOME:, 
9821 @itemx #+EXPORT_SELECT_TAGS:, #+EXPORT_EXCLUDE_TAGS:
9822 These lines provide settings for exporting files.  For more details see
9823 @ref{Export options}.
9824 @item #+TODO:    #+SEQ_TODO:   #+TYP_TODO:
9825 @vindex org-todo-keywords
9826 These lines set the TODO keywords and their interpretation in the
9827 current file.  The corresponding variable is @code{org-todo-keywords}.
9828 @end table
9830 @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous
9831 @section The very busy C-c C-c key
9832 @kindex C-c C-c
9833 @cindex C-c C-c, overview
9835 The key @kbd{C-c C-c} has many purposes in Org, which are all
9836 mentioned scattered throughout this manual.  One specific function of
9837 this key is to add @emph{tags} to a headline (@pxref{Tags}).  In many
9838 other circumstances it means something like @emph{Hey Org, look
9839 here and update according to what you see here}.  Here is a summary of
9840 what this means in different contexts.
9842 @itemize @minus
9843 @item
9844 If there are highlights in the buffer from the creation of a sparse
9845 tree, or from clock display, remove these highlights.
9846 @item
9847 If the cursor is in one of the special @code{#+KEYWORD} lines, this
9848 triggers scanning the buffer for these lines and updating the
9849 information.
9850 @item
9851 If the cursor is inside a table, realign the table.  This command
9852 works even if the automatic table editor has been turned off.
9853 @item
9854 If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
9855 the entire table.
9856 @item
9857 If the cursor is inside a table created by the @file{table.el} package,
9858 activate that table.
9859 @item
9860 If the current buffer is a remember buffer, close the note and file it.
9861 With a prefix argument, file it, without further interaction, to the
9862 default location.
9863 @item
9864 If the cursor is on a @code{<<<target>>>}, update radio targets and
9865 corresponding links in this buffer.
9866 @item
9867 If the cursor is in a property line or at the start or end of a property
9868 drawer, offer property commands.
9869 @item
9870 If the cursor is at a footnote reference, go to the corresponding
9871 definition, and vice versa.
9872 @item
9873 If the cursor is in a plain list item with a checkbox, toggle the status
9874 of the checkbox.
9875 @item
9876 If the cursor is on a numbered item in a plain list, renumber the
9877 ordered list.
9878 @item
9879 If the cursor is on the @code{#+BEGIN} line of a dynamical block, the
9880 block is updated.
9881 @end itemize
9883 @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous
9884 @section A cleaner outline view
9885 @cindex hiding leading stars
9886 @cindex dynamic indentation
9887 @cindex odd-levels-only outlines
9888 @cindex clean outline view
9890 Some people find it noisy and distracting that the Org headlines are starting
9891 with a potentially large number of stars, and that text below the headlines
9892 is not indented.  This is not really a problem when you are writing a book
9893 where the outline headings are really section headlines.  However, in a more
9894 list-oriented outline, it is clear that an indented structure is a lot
9895 cleaner, as can be seen by comparing the two columns in the following
9896 example:
9898 @example
9899 @group
9900 * Top level headline             |    * Top level headline
9901 ** Second level                  |      * Second level
9902 *** 3rd level                    |        * 3rd level
9903 some text                        |          some text
9904 *** 3rd level                    |        * 3rd level
9905 more text                        |          more text
9906 * Another top level headline     |    * Another top level headline
9907 @end group
9908 @end example
9910 @noindent
9911 It is non-trivial to make such a look work in Emacs, but Org contains three
9912 separate features that, combined, achieve just that.
9914 @enumerate
9915 @item
9916 @emph{Indentation of text below headlines}@*
9917 You may indent text below each headline to make the left boundary line up
9918 with the headline, like
9920 @example
9921 *** 3rd level
9922     more text, now indented
9923 @end example
9925 @vindex org-adapt-indentation
9926 A good way to get this indentation is by hand, and Org supports this with
9927 paragraph filling, line wrapping, and structure editing@footnote{See also the
9928 variable @code{org-adapt-indentation}.} preserving or adapting the
9929 indentation appropriate.  A different approach would be to have a way to
9930 automatically indent lines according to outline structure by adding overlays
9931 or text properties.  But I have not yet found a robust and efficient way to
9932 do this in large files.
9934 @item
9935 @vindex org-hide-leading-stars
9936 @emph{Hiding leading stars}@* You can modify the display in such a way that
9937 all leading stars become invisible.  To do this in a global way, configure
9938 the variable @code{org-hide-leading-stars} or change this on a per-file basis
9939 with
9941 @example
9942 #+STARTUP: hidestars
9943 @end example
9945 @noindent
9946 Note that the opposite behavior is selected with @code{showstars}.
9948 With hidden stars, the tree becomes:
9950 @example
9951 @group
9952 * Top level headline
9953  * Second level
9954   * 3rd level
9955   ...
9956 @end group
9957 @end example
9959 @noindent
9960 @vindex org-hide @r{(face)}
9961 Note that the leading stars are not truly replaced by whitespace, they
9962 are only fontified with the face @code{org-hide} that uses the
9963 background color as font color.  If you are not using either white or
9964 black background, you may have to customize this face to get the wanted
9965 effect.  Another possibility is to set this font such that the extra
9966 stars are @i{almost} invisible, for example using the color
9967 @code{grey90} on a white background.
9969 @item
9970 @cindex org-odd-levels-only
9971 Things become cleaner still if you skip all the even levels and use only odd
9972 levels 1, 3, 5..., effectively adding two stars to go from one outline level
9973 to the next@footnote{When you need to specify a level for a property search
9974 or refile targets, @samp{LEVEL=2} will correspond to 3 stars etc.}.  In this
9975 way we get the outline view shown at the beginning of this section.  In order
9976 to make the structure editing and export commands handle this convention
9977 correctly, configure the variable @code{org-odd-levels-only}, or set this on
9978 a per-file basis with one of the following lines:
9980 @example
9981 #+STARTUP: odd
9982 #+STARTUP: oddeven
9983 @end example
9985 You can convert an Org file from single-star-per-level to the
9986 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
9987 RET} in that file.  The reverse operation is @kbd{M-x
9988 org-convert-to-oddeven-levels}.
9989 @end enumerate
9991 @node TTY keys, Interaction, Clean view, Miscellaneous
9992 @section Using Org on a tty
9993 @cindex tty key bindings
9995 Because Org contains a large number of commands, by default much of
9996 Org's core commands are bound to keys that are generally not
9997 accessible on a tty, such as the cursor keys (@key{left}, @key{right},
9998 @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
9999 together with modifiers like @key{Meta} and/or @key{Shift}.  To access
10000 these commands on a tty when special keys are unavailable, the following
10001 alternative bindings can be used.  The tty bindings below will likely be
10002 more cumbersome; you may find for some of the bindings below that a
10003 customized work-around suits you better.  For example, changing a time
10004 stamp is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
10005 tty you would rather use @kbd{C-c .} to re-insert the timestamp.
10007 @multitable @columnfractions 0.15 0.2 0.2
10008 @item @b{Default} @tab @b{Alternative 1} @tab @b{Alternative 2}
10009 @item @kbd{S-@key{TAB}}     @tab @kbd{C-u @key{TAB}}       @tab
10010 @item @kbd{M-@key{left}}    @tab @kbd{C-c C-x l}           @tab @kbd{@key{Esc} @key{left}}
10011 @item @kbd{M-S-@key{left}}  @tab @kbd{C-c C-x L}           @tab
10012 @item @kbd{M-@key{right}}   @tab @kbd{C-c C-x r}           @tab @kbd{@key{Esc} @key{right}}
10013 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R}           @tab
10014 @item @kbd{M-@key{up}}      @tab @kbd{C-c C-x u}           @tab @kbd{@key{Esc} @key{up}}
10015 @item @kbd{M-S-@key{up}}    @tab @kbd{C-c C-x U}           @tab
10016 @item @kbd{M-@key{down}}    @tab @kbd{C-c C-x d}           @tab @kbd{@key{Esc} @key{down}}
10017 @item @kbd{M-S-@key{down}}  @tab @kbd{C-c C-x D}           @tab
10018 @item @kbd{S-@key{RET}}     @tab @kbd{C-c C-x c}           @tab
10019 @item @kbd{M-@key{RET}}     @tab @kbd{C-c C-x m}           @tab @kbd{@key{Esc} @key{RET}}
10020 @item @kbd{M-S-@key{RET}}   @tab @kbd{C-c C-x M}           @tab
10021 @item @kbd{S-@key{left}}    @tab @kbd{C-c @key{left}}      @tab
10022 @item @kbd{S-@key{right}}   @tab @kbd{C-c @key{right}}     @tab
10023 @item @kbd{S-@key{up}}      @tab @kbd{C-c @key{up}}        @tab
10024 @item @kbd{S-@key{down}}    @tab @kbd{C-c @key{down}}      @tab
10025 @item @kbd{C-S-@key{left}}  @tab @kbd{C-c C-x @key{left}}  @tab
10026 @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab
10027 @end multitable
10030 @node Interaction,  , TTY keys, Miscellaneous
10031 @section Interaction with other packages
10032 @cindex packages, interaction with other
10033 Org lives in the world of GNU Emacs and interacts in various ways
10034 with other code out there.
10036 @menu
10037 * Cooperation::                 Packages Org cooperates with
10038 * Conflicts::                   Packages that lead to conflicts
10039 @end menu
10041 @node Cooperation, Conflicts, Interaction, Interaction
10042 @subsection Packages that Org cooperates with
10044 @table @asis
10045 @cindex @file{calc.el}
10046 @item @file{calc.el} by Dave Gillespie
10047 Org uses the Calc package for implementing spreadsheet
10048 functionality in its tables (@pxref{The spreadsheet}).  Org
10049 checks for the availability of Calc by looking for the function
10050 @code{calc-eval} which should be autoloaded in your setup if Calc has
10051 been installed properly.  As of Emacs 22, Calc is part of the Emacs
10052 distribution.  Another possibility for interaction between the two
10053 packages is using Calc for embedded calculations. @xref{Embedded Mode,
10054 , Embedded Mode, Calc, GNU Emacs Calc Manual}.
10055 @cindex @file{constants.el}
10056 @item @file{constants.el} by Carsten Dominik
10057 @vindex org-table-formula-constants
10058 In a table formula (@pxref{The spreadsheet}), it is possible to use
10059 names for natural constants or units.  Instead of defining your own
10060 constants in the variable @code{org-table-formula-constants}, install
10061 the @file{constants} package which defines a large number of constants
10062 and units, and lets you use unit prefixes like @samp{M} for
10063 @samp{Mega} etc.  You will need version 2.0 of this package, available
10064 at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for
10065 the function @code{constants-get}, which has to be autoloaded in your
10066 setup.  See the installation instructions in the file
10067 @file{constants.el}.
10068 @item @file{cdlatex.el} by Carsten Dominik
10069 @cindex @file{cdlatex.el}
10070 Org mode can make use of the CDLaTeX package to efficiently enter
10071 La@TeX{} fragments into Org files. See @ref{CDLaTeX mode}.
10072 @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
10073 @cindex @file{imenu.el}
10074 Imenu allows menu access to an index of items in a file.  Org mode
10075 supports Imenu - all you need to do to get the index is the following:
10076 @lisp
10077 (add-hook 'org-mode-hook
10078           (lambda () (imenu-add-to-menubar "Imenu")))
10079 @end lisp
10080 @vindex org-imenu-depth
10081 By default the index is two levels deep - you can modify the depth using
10082 the option @code{org-imenu-depth}.
10083 @item @file{remember.el} by John Wiegley
10084 @cindex @file{remember.el}
10085 Org cooperates with remember, see @ref{Remember}.
10086 @file{Remember.el} is not part of Emacs, find it on the web.
10087 @item @file{speedbar.el} by Eric M. Ludlam
10088 @cindex @file{speedbar.el}
10089 Speedbar is a package that creates a special frame displaying files and
10090 index items in files.  Org mode supports Speedbar and allows you to
10091 drill into Org files directly from the Speedbar.  It also allows to
10092 restrict the scope of agenda commands to a file or a subtree by using
10093 the command @kbd{<} in the Speedbar frame.
10094 @cindex @file{table.el}
10095 @item @file{table.el} by Takaaki Ota
10096 @kindex C-c C-c
10097 @cindex table editor, @file{table.el}
10098 @cindex @file{table.el}
10100 Complex ASCII tables with automatic line wrapping, column- and
10101 row-spanning, and alignment can be created using the Emacs table
10102 package by Takaaki Ota (@uref{http://sourceforge.net/projects/table},
10103 and also part of Emacs 22).
10104 When @key{TAB} or @kbd{C-c C-c} is pressed in such a table, Org mode
10105 will call @command{table-recognize-table} and move the cursor into the
10106 table.  Inside a table, the keymap of Org mode is inactive.  In order
10107 to execute Org mode-related commands, leave the table.
10109 @table @kbd
10110 @kindex C-c C-c
10111 @item C-c C-c
10112 Recognize @file{table.el} table.  Works when the cursor is in a
10113 table.el table.
10115 @kindex C-c ~
10116 @item C-c ~
10117 Insert a table.el table.  If there is already a table at point, this
10118 command converts it between the table.el format and the Org mode
10119 format.  See the documentation string of the command
10120 @code{org-convert-table} for the restrictions under which this is
10121 possible.
10122 @end table
10123 @file{table.el} is part of Emacs 22.
10124 @cindex @file{footnote.el}
10125 @item @file{footnote.el} by Steven L. Baur
10126 Org mode recognizes numerical footnotes as provided by this package.
10127 However, Org-mode also has its own footnote support (@pxref{Footnotes}),
10128 which makes using @file{footnote.el} unnecessary.
10129 @end table
10131 @node Conflicts,  , Cooperation, Interaction
10132 @subsection Packages that lead to conflicts with Org mode
10134 @table @asis
10136 @cindex @code{shift-selection-mode}
10137 @vindex org-support-shift-select
10138 In Emacs 23, @code{shift-selection-mode} is on by default, meaning that
10139 cursor motions combined with the shift key should start or enlarge regions.
10140 This conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change
10141 timestamps, TODO keywords, priorities, and item bullet types if the cursor is
10142 at such a location.  By default, @kbd{S-@key{cursor}} commands outside
10143 special contexts don't do anything, but you can customize the variable
10144 @code{org-support-shift-select}.  Org-mode then tries to accommodate shift
10145 selection by (i) using it outside of the special contexts where special
10146 commands apply, and by (ii) extending an existing active region even if the
10147 cursor moves across a special context.
10149 @cindex @file{CUA.el}
10150 @item @file{CUA.el} by Kim. F. Storm
10151 @vindex org-replace-disputed-keys
10152 Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by CUA mode
10153 (as well as pc-select-mode and s-region-mode) to select and extend the
10154 region.  In fact, Emacs 23 has this built-in in the form of
10155 @code{shift-selection-mode}, see previous paragraph.  If you are using Emacs
10156 23, you probably don't want to use another package for this purpose.  However,
10157 if you prefer to leave these keys to a different package while working in
10158 Org-mode, configure the variable @code{org-replace-disputed-keys}.  When set,
10159 Org will move the following key bindings in Org files, and in the agenda
10160 buffer (but not during date selection).
10162 @example
10163 S-UP      ->  M-p             S-DOWN     ->  M-n
10164 S-LEFT    ->  M--             S-RIGHT    ->  M-+
10165 C-S-LEFT  ->  M-S--           C-S-RIGHT  ->  M-S-+
10166 @end example
10168 @vindex org-disputed-keys
10169 Yes, these are unfortunately more difficult to remember.  If you want
10170 to have other replacement keys, look at the variable
10171 @code{org-disputed-keys}.
10173 @item @file{windmove.el} by Hovav Shacham
10174 @cindex @file{windmove.el}
10175 Also this package uses the @kbd{S-<cursor>} keys, so everything written
10176 in the paragraph above about CUA mode also applies here.
10178 @end table
10180 @node Hacking, History and Acknowledgments, Miscellaneous, Top
10181 @appendix Hacking
10182 @cindex hacking
10184 This appendix covers some aspects where users can extend the functionality of
10185 Org.
10187 @menu
10188 * Hooks::                       Who to reach into Org's internals
10189 * Add-on packages::             Available extensions
10190 * Adding hyperlink types::      New custom link types
10191 * Context-sensitive commands::  How to add functioality to such commands
10192 * Tables in arbitrary syntax::  Orgtbl for LaTeX and other programs
10193 * Dynamic blocks::              Automatically filled blocks
10194 * Special agenda views::        Customized views
10195 * Extracting agenda information::  Postprocessing of agenda information
10196 * Using the property API::      Writing programs that use entry properties
10197 * Using the mapping API::       Mapping over all or selected entries
10198 @end menu
10200 @node Hooks, Add-on packages, Hacking, Hacking
10201 @section Hooks
10202 @cindex hooks
10204 Org has a large number of hook variables that can be used to add
10205 functionality to it.  This appendix about hacking is going to illustrate the
10206 use of some of them.  A complete list of all hooks with documentation is
10207 maintained by the worg project and can be found at
10208 @uref{http://orgmode.org/worg/org-configs/org-hooks.php}.
10210 @node Add-on packages, Adding hyperlink types, Hooks, Hacking
10211 @section Add-on packages
10212 @cindex add-on packages
10214 A large number of add-on packages have been written by various authors.
10215 These packages are not part of Emacs, but they are distributed as contributed
10216 packages with the separate release available at the Org-mode home page at
10217 @uref{http://orgmode.org}.  The list of contributed packages, along with
10218 documentation about each package, is maintained by the Worg project at
10219 @uref{http://orgmode.org/worg/org-contrib/}.
10223 @node Adding hyperlink types, Context-sensitive commands, Add-on packages, Hacking
10224 @section Adding hyperlink types
10225 @cindex hyperlinks, adding new types
10227 Org has a large number of hyperlink types built-in
10228 (@pxref{Hyperlinks}).  If you would like to add new link types, it
10229 provides an interface for doing so.  Let's look at an example file
10230 @file{org-man.el} that will add support for creating links like
10231 @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
10232 emacs:
10234 @lisp
10235 ;;; org-man.el - Support for links to manpages in Org
10237 (require 'org)
10239 (org-add-link-type "man" 'org-man-open)
10240 (add-hook 'org-store-link-functions 'org-man-store-link)
10242 (defcustom org-man-command 'man
10243   "The Emacs command to be used to display a man page."
10244   :group 'org-link
10245   :type '(choice (const man) (const woman)))
10247 (defun org-man-open (path)
10248   "Visit the manpage on PATH.
10249 PATH should be a topic that can be thrown at the man command."
10250   (funcall org-man-command path))
10252 (defun org-man-store-link ()
10253   "Store a link to a manpage."
10254   (when (memq major-mode '(Man-mode woman-mode))
10255     ;; This is a man page, we do make this link
10256     (let* ((page (org-man-get-page-name))
10257            (link (concat "man:" page))
10258            (description (format "Manpage for %s" page)))
10259       (org-store-link-props
10260        :type "man"
10261        :link link
10262        :description description))))
10264 (defun org-man-get-page-name ()
10265   "Extract the page name from the buffer name."
10266   ;; This works for both `Man-mode' and `woman-mode'.
10267   (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
10268       (match-string 1 (buffer-name))
10269     (error "Cannot create link to this man page")))
10271 (provide 'org-man)
10273 ;;; org-man.el ends here
10274 @end lisp
10276 @noindent
10277 You would activate this new link type in @file{.emacs} with
10279 @lisp
10280 (require 'org-man)
10281 @end lisp
10283 @noindent
10284 Let's go through the file and see what it does.
10285 @enumerate
10286 @item
10287 It does @code{(require 'org)} to make sure that @file{org.el} has been
10288 loaded.
10289 @item
10290 The next line calls @code{org-add-link-type} to define a new link type
10291 with prefix @samp{man}.  The call also contains the name of a function
10292 that will be called to follow such a link.
10293 @item
10294 @vindex org-store-link-functions
10295 The next line adds a function to @code{org-store-link-functions}, in
10296 order to allow the command @kbd{C-c l} to record a useful link in a
10297 buffer displaying a man page.
10298 @end enumerate
10300 The rest of the file defines the necessary variables and functions.
10301 First there is a customization variable that determines which emacs
10302 command should be used to display man pages.  There are two options,
10303 @code{man} and @code{woman}.  Then the function to follow a link is
10304 defined.  It gets the link path as an argument - in this case the link
10305 path is just a topic for the manual command.  The function calls the
10306 value of @code{org-man-command} to display the man page.
10308 Finally the function @code{org-man-store-link} is defined.  When you try
10309 to store a link with @kbd{C-c l}, also this function will be called to
10310 try to make a link.  The function must first decide if it is supposed to
10311 create the link for this buffer type, we do this by checking the value
10312 of the variable @code{major-mode}.  If not, the function must exit and
10313 return the value @code{nil}.  If yes, the link is created by getting the
10314 manual topic from the buffer name and prefixing it with the string
10315 @samp{man:}.  Then it must call the command @code{org-store-link-props}
10316 and set the @code{:type} and @code{:link} properties.  Optionally you
10317 can also set the @code{:description} property to provide a default for
10318 the link description when the link is later inserted into an Org
10319 buffer with @kbd{C-c C-l}.
10321 @node Context-sensitive commands, Tables in arbitrary syntax, Adding hyperlink types, Hacking
10322 @section Context-sensitive commands
10323 @cindex context-sensitive commands, hooks
10324 @cindex add-ons, context-sensitive commands
10325 @vindex org-ctrl-c-ctrl-c-hook
10327 Org has several commands that act differently depending on context.  The most
10328 important example it the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}).
10329 Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys do have this property.
10331 Add-ons can tap into this functionality by providing a function that detects
10332 special context for that add-on and executes functionality appropriate for
10333 the context.  Here is an example from Dan Davison's @file{org-R.el} which
10334 allows to evaluate commands based on the @file{R} programming language.  For
10335 this package, special contexts are lines that start with @code{#+R:} or
10336 @code{#+RR:}.
10338 @lisp
10339 (defun org-R-apply-maybe ()
10340   "Detect if this is context for org-R and execute R commands."
10341   (if (save-excursion
10342         (beginning-of-line 1)
10343         (looking-at "#\\+RR?:"))
10344       (progn (call-interactively 'org-R-apply)
10345              t) ;; to signal that we took action
10346     nil)) ;; to signal that we did not
10348 (add-hook 'org-ctrl-c-ctrl-c-hook 'org-R-apply-maybe)
10349 @end lisp
10351 The function first checks if the cursor is in such a line.  If that is the
10352 case, @code{org-R-apply} is called and the function returns @code{t} to
10353 signal that action was taken, and @kbd{C-c C-c} will stop looking for other
10354 contexts.  If the function finds it should do nothing locally, it returns @code{nil} so that other, similar functions can have a try.
10357 @node Tables in arbitrary syntax, Dynamic blocks, Context-sensitive commands, Hacking
10358 @section Tables and lists in arbitrary syntax
10359 @cindex tables, in other modes
10360 @cindex lists, in other modes
10361 @cindex Orgtbl mode
10363 Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
10364 frequent feature request has been to make it work with native tables in
10365 specific languages, for example La@TeX{}.  However, this is extremely
10366 hard to do in a general way, would lead to a customization nightmare,
10367 and would take away much of the simplicity of the Orgtbl mode table
10368 editor.
10371 This appendix describes a different approach.  We keep the Orgtbl mode
10372 table in its native format (the @i{source table}), and use a custom
10373 function to @i{translate} the table to the correct syntax, and to
10374 @i{install} it in the right location (the @i{target table}).  This puts
10375 the burden of writing conversion functions on the user, but it allows
10376 for a very flexible system.
10378 Bastien added the ability to do the same with lists.  You can use Org's
10379 facilities to edit and structure lists by turning @code{orgstruct-mode}
10380 on, then locally exporting such lists in another format (HTML, La@TeX{}
10381 or Texinfo.)
10384 @menu
10385 * Radio tables::                Sending and receiving
10386 * A LaTeX example::             Step by step, almost a tutorial
10387 * Translator functions::        Copy and modify
10388 * Radio lists::                 Doing the same for lists
10389 @end menu
10391 @node Radio tables, A LaTeX example, Tables in arbitrary syntax, Tables in arbitrary syntax
10392 @subsection Radio tables
10393 @cindex radio tables
10395 To define the location of the target table, you first need to create two
10396 lines that are comments in the current mode, but contain magic words for
10397 Orgtbl mode to find.  Orgtbl mode will insert the translated table
10398 between these lines, replacing whatever was there before.  For example:
10400 @example
10401 /* BEGIN RECEIVE ORGTBL table_name */
10402 /* END RECEIVE ORGTBL table_name */
10403 @end example
10405 @noindent
10406 Just above the source table, we put a special line that tells
10407 Orgtbl mode how to translate this table and where to install it.  For
10408 example:
10409 @example
10410 #+ORGTBL: SEND table_name translation_function arguments....
10411 @end example
10413 @noindent
10414 @code{table_name} is the reference name for the table that is also used
10415 in the receiver lines. @code{translation_function} is the Lisp function
10416 that does the translation.  Furthermore, the line can contain a list of
10417 arguments (alternating key and value) at the end.  The arguments will be
10418 passed as a property list to the translation function for
10419 interpretation.  A few standard parameters are already recognized and
10420 acted upon before the translation function is called:
10422 @table @code
10423 @item :skip N
10424 Skip the first N lines of the table.  Hlines do count as separate lines for
10425 this parameter!
10427 @item :skipcols (n1 n2 ...)
10428 List of columns that should be skipped.  If the table has a column with
10429 calculation marks, that column is automatically discarded as well.
10430 Please note that the translator function sees the table @emph{after} the
10431 removal of these columns, the function never knows that there have been
10432 additional columns.
10433 @end table
10435 @noindent
10436 The one problem remaining is how to keep the source table in the buffer
10437 without disturbing the normal workings of the file, for example during
10438 compilation of a C file or processing of a La@TeX{} file.  There are a
10439 number of different solutions:
10441 @itemize @bullet
10442 @item
10443 The table could be placed in a block comment if that is supported by the
10444 language.  For example, in C mode you could wrap the table between
10445 @samp{/*} and @samp{*/} lines.
10446 @item
10447 Sometimes it is possible to put the table after some kind of @i{END}
10448 statement, for example @samp{\bye} in TeX and @samp{\end@{document@}}
10449 in La@TeX{}.
10450 @item
10451 You can just comment the table line by line whenever you want to process
10452 the file, and uncomment it whenever you need to edit the table.  This
10453 only sounds tedious - the command @kbd{M-x orgtbl-toggle-comment} does
10454 make this comment-toggling very easy, in particular if you bind it to a
10455 key.
10456 @end itemize
10458 @node A LaTeX example, Translator functions, Radio tables, Tables in arbitrary syntax
10459 @subsection A LaTeX example of radio tables
10460 @cindex LaTeX, and Orgtbl mode
10462 The best way to wrap the source table in La@TeX{} is to use the
10463 @code{comment} environment provided by @file{comment.sty}.  It has to be
10464 activated by placing @code{\usepackage@{comment@}} into the document
10465 header.  Orgtbl mode can insert a radio table skeleton@footnote{By
10466 default this works only for La@TeX{}, HTML, and Texinfo.  Configure the
10467 variable @code{orgtbl-radio-tables} to install templates for other
10468 modes.}  with the command @kbd{M-x orgtbl-insert-radio-table}.  You will
10469 be prompted for a table name, let's say we use @samp{salesfigures}.  You
10470 will then get the following template:
10472 @cindex #+ORGTBL: SEND
10473 @example
10474 % BEGIN RECEIVE ORGTBL salesfigures
10475 % END RECEIVE ORGTBL salesfigures
10476 \begin@{comment@}
10477 #+ORGTBL: SEND salesfigures orgtbl-to-latex
10478 | | |
10479 \end@{comment@}
10480 @end example
10482 @noindent
10483 @vindex LaTeX-verbatim-environments
10484 The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
10485 @code{orgtbl-to-latex} to convert the table into La@TeX{} and to put it
10486 into the receiver location with name @code{salesfigures}.  You may now
10487 fill in the table, feel free to use the spreadsheet features@footnote{If
10488 the @samp{#+TBLFM} line contains an odd number of dollar characters,
10489 this may cause problems with font-lock in LaTeX mode.  As shown in the
10490 example you can fix this by adding an extra line inside the
10491 @code{comment} environment that is used to balance the dollar
10492 expressions.  If you are using AUCTeX with the font-latex library, a
10493 much better solution is to add the @code{comment} environment to the
10494 variable @code{LaTeX-verbatim-environments}.}:
10496 @example
10497 % BEGIN RECEIVE ORGTBL salesfigures
10498 % END RECEIVE ORGTBL salesfigures
10499 \begin@{comment@}
10500 #+ORGTBL: SEND salesfigures orgtbl-to-latex
10501 | Month | Days | Nr sold | per day |
10502 |-------+------+---------+---------|
10503 | Jan   |   23 |      55 |     2.4 |
10504 | Feb   |   21 |      16 |     0.8 |
10505 | March |   22 |     278 |    12.6 |
10506 #+TBLFM: $4=$3/$2;%.1f
10507 % $ (optional extra dollar to keep font-lock happy, see footnote)
10508 \end@{comment@}
10509 @end example
10511 @noindent
10512 When you are done, press @kbd{C-c C-c} in the table to get the converted
10513 table inserted between the two marker lines.
10515 Now let's assume you want to make the table header by hand, because you
10516 want to control how columns are aligned etc.  In this case we make sure
10517 that the table translator does skip the first 2 lines of the source
10518 table, and tell the command to work as a @i{splice}, i.e. to not produce
10519 header and footer commands of the target table:
10521 @example
10522 \begin@{tabular@}@{lrrr@}
10523 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
10524 % BEGIN RECEIVE ORGTBL salesfigures
10525 % END RECEIVE ORGTBL salesfigures
10526 \end@{tabular@}
10528 \begin@{comment@}
10529 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
10530 | Month | Days | Nr sold | per day |
10531 |-------+------+---------+---------|
10532 | Jan   |   23 |      55 |     2.4 |
10533 | Feb   |   21 |      16 |     0.8 |
10534 | March |   22 |     278 |    12.6 |
10535 #+TBLFM: $4=$3/$2;%.1f
10536 \end@{comment@}
10537 @end example
10539 The La@TeX{} translator function @code{orgtbl-to-latex} is already part of
10540 Orgtbl mode.  It uses a @code{tabular} environment to typeset the table
10541 and marks horizontal lines with @code{\hline}.  Furthermore, it
10542 interprets the following parameters (see also @ref{Translator functions}):
10544 @table @code
10545 @item :splice nil/t
10546 When set to t, return only table body lines, don't wrap them into a
10547 tabular environment.  Default is nil.
10549 @item :fmt fmt
10550 A format to be used to wrap each field, should contain @code{%s} for the
10551 original field value.  For example, to wrap each field value in dollars,
10552 you could use @code{:fmt "$%s$"}.  This may also be a property list with
10553 column numbers and formats. for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
10554 A function of one argument can be used in place of the strings; the
10555 function must return a formatted string.
10557 @item :efmt efmt
10558 Use this format to print numbers with exponentials.  The format should
10559 have @code{%s} twice for inserting mantissa and exponent, for example
10560 @code{"%s\\times10^@{%s@}"}.  The default is @code{"%s\\,(%s)"}.  This
10561 may also be a property list with column numbers and formats, for example
10562 @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}.  After
10563 @code{efmt} has been applied to a value, @code{fmt} will also be
10564 applied.  Similar to @code{fmt}, functions of two arguments can be
10565 supplied instead of strings.
10566 @end table
10568 @node Translator functions, Radio lists, A LaTeX example, Tables in arbitrary syntax
10569 @subsection Translator functions
10570 @cindex HTML, and Orgtbl mode
10571 @cindex translator function
10573 Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
10574 (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
10575 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and @code{orgtbl-to-texinfo}.
10576 Except for @code{orgtbl-to-html}@footnote{The HTML translator uses the same
10577 code that produces tables during HTML export.}, these all use a generic
10578 translator, @code{orgtbl-to-generic}.  For example, @code{orgtbl-to-latex}
10579 itself is a very short function that computes the column definitions for the
10580 @code{tabular} environment, defines a few field and line separators and then
10581 hands over to the generic translator.  Here is the entire code:
10583 @lisp
10584 @group
10585 (defun orgtbl-to-latex (table params)
10586   "Convert the Orgtbl mode TABLE to LaTeX."
10587   (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
10588                                org-table-last-alignment ""))
10589          (params2
10590           (list
10591            :tstart (concat "\\begin@{tabular@}@{" alignment "@}")
10592            :tend "\\end@{tabular@}"
10593            :lstart "" :lend " \\\\" :sep " & "
10594            :efmt "%s\\,(%s)" :hline "\\hline")))
10595     (orgtbl-to-generic table (org-combine-plists params2 params))))
10596 @end group
10597 @end lisp
10599 As you can see, the properties passed into the function (variable
10600 @var{PARAMS}) are combined with the ones newly defined in the function
10601 (variable @var{PARAMS2}).  The ones passed into the function (i.e. the
10602 ones set by the @samp{ORGTBL SEND} line) take precedence.  So if you
10603 would like to use the La@TeX{} translator, but wanted the line endings to
10604 be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
10605 overrule the default with
10607 @example
10608 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
10609 @end example
10611 For a new language, you can either write your own converter function in
10612 analogy with the La@TeX{} translator, or you can use the generic function
10613 directly.  For example, if you have a language where a table is started
10614 with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are
10615 started with @samp{!BL!}, ended with @samp{!EL!} and where the field
10616 separator is a TAB, you could call the generic translator like this (on
10617 a single line!):
10619 @example
10620 #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
10621                               :lstart "!BL! " :lend " !EL!" :sep "\t"
10622 @end example
10624 @noindent
10625 Please check the documentation string of the function
10626 @code{orgtbl-to-generic} for a full list of parameters understood by
10627 that function and remember that you can pass each of them into
10628 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
10629 using the generic function.
10631 Of course you can also write a completely new function doing complicated
10632 things the generic translator cannot do.  A translator function takes
10633 two arguments.  The first argument is the table, a list of lines, each
10634 line either the symbol @code{hline} or a list of fields.  The second
10635 argument is the property list containing all parameters specified in the
10636 @samp{#+ORGTBL: SEND} line.  The function must return a single string
10637 containing the formatted table.  If you write a generally useful
10638 translator, please post it on @code{emacs-orgmode@@gnu.org} so that
10639 others can benefit from your work.
10641 @node  Radio lists,  , Translator functions, Tables in arbitrary syntax
10642 @subsection Radio lists
10643 @cindex radio lists
10644 @cindex org-list-insert-radio-list
10646 Sending and receiving radio lists works exactly the same way than
10647 sending and receiving radio tables (@pxref{Radio tables}) @footnote{You
10648 need to load the @code{org-export-latex.el} package to use radio lists
10649 since the relevant code is there for now.}.  As for radio tables, you
10650 can insert radio lists templates in HTML, La@TeX{} and Texinfo modes by
10651 calling @code{org-list-insert-radio-list}.
10653 Here are the differences with radio tables:
10655 @itemize @minus
10656 @item
10657 Use @code{ORGLST} instead of @code{ORGTBL}.
10658 @item
10659 The available translation functions for radio lists don't take
10660 parameters.
10661 @item
10662 `C-c C-c' will work when pressed on the first item of the list.
10663 @end itemize
10665 Here is a La@TeX{} example.  Let's say that you have this in your
10666 La@TeX{} file:
10668 @example
10669 % BEGIN RECEIVE ORGLST to-buy
10670 % END RECEIVE ORGLST to-buy
10671 \begin@{comment@}
10672 #+ORGLIST: SEND to-buy orgtbl-to-latex
10673 - a new house
10674 - a new computer
10675   + a new keyboard
10676   + a new mouse
10677 - a new life
10678 \end@{comment@}
10679 @end example
10681 Pressing `C-c C-c' on @code{a new house} and will insert the converted
10682 La@TeX{} list between the two marker lines.
10684 @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Hacking
10685 @section Dynamic blocks
10686 @cindex dynamic blocks
10688 Org documents can contain @emph{dynamic blocks}.  These are
10689 specially marked regions that are updated by some user-written function.
10690 A good example for such a block is the clock table inserted by the
10691 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
10693 Dynamic block are enclosed by a BEGIN-END structure that assigns a name
10694 to the block and can also specify parameters for the function producing
10695 the content of the block.
10697 #+BEGIN:dynamic block
10698 @example
10699 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
10701 #+END:
10702 @end example
10704 Dynamic blocks are updated with the following commands
10706 @table @kbd
10707 @kindex C-c C-x C-u
10708 @item C-c C-x C-u
10709 Update dynamic block at point.
10710 @kindex C-u C-c C-x C-u
10711 @item C-u C-c C-x C-u
10712 Update all dynamic blocks in the current file.
10713 @end table
10715 Updating a dynamic block means to remove all the text between BEGIN and
10716 END, parse the BEGIN line for parameters and then call the specific
10717 writer function for this block to insert the new content.  If you want
10718 to use the original content in the writer function, you can use the
10719 extra parameter @code{:content}.
10721 For a block with name @code{myblock}, the writer function is
10722 @code{org-dblock-write:myblock} with as only parameter a property list
10723 with the parameters given in the begin line.  Here is a trivial example
10724 of a block that keeps track of when the block update function was last
10725 run:
10727 @example
10728 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
10730 #+END:
10731 @end example
10733 @noindent
10734 The corresponding block writer function could look like this:
10736 @lisp
10737 (defun org-dblock-write:block-update-time (params)
10738    (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
10739      (insert "Last block update at: "
10740              (format-time-string fmt (current-time)))))
10741 @end lisp
10743 If you want to make sure that all dynamic blocks are always up-to-date,
10744 you could add the function @code{org-update-all-dblocks} to a hook, for
10745 example @code{before-save-hook}.  @code{org-update-all-dblocks} is
10746 written in a way that is does nothing in buffers that are not in
10747 @code{org-mode}.
10749 @node Special agenda views, Extracting agenda information, Dynamic blocks, Hacking
10750 @section Special agenda views
10751 @cindex agenda views, user-defined
10753 Org provides a special hook that can be used to narrow down the
10754 selection made by any of the agenda views.  You may specify a function
10755 that is used at each match to verify if the match should indeed be part
10756 of the agenda view, and if not, how much should be skipped.
10758 Let's say you want to produce a list of projects that contain a WAITING
10759 tag anywhere in the project tree.  Let's further assume that you have
10760 marked all tree headings that define a project with the TODO keyword
10761 PROJECT.  In this case you would run a TODO search for the keyword
10762 PROJECT, but skip the match unless there is a WAITING tag anywhere in
10763 the subtree belonging to the project line.
10765 To achieve this, you must write a function that searches the subtree for
10766 the tag.  If the tag is found, the function must return @code{nil} to
10767 indicate that this match should not be skipped.  If there is no such
10768 tag, return the location of the end of the subtree, to indicate that
10769 search should continue from there.
10771 @lisp
10772 (defun my-skip-unless-waiting ()
10773   "Skip trees that are not waiting"
10774   (let ((subtree-end (save-excursion (org-end-of-subtree t))))
10775     (if (re-search-forward ":waiting:" subtree-end t)
10776         nil          ; tag found, do not skip
10777       subtree-end))) ; tag not found, continue after end of subtree
10778 @end lisp
10780 Now you may use this function in an agenda custom command, for example
10781 like this:
10783 @lisp
10784 (org-add-agenda-custom-command
10785  '("b" todo "PROJECT"
10786    ((org-agenda-skip-function 'my-skip-unless-waiting)
10787     (org-agenda-overriding-header "Projects waiting for something: "))))
10788 @end lisp
10790 @vindex org-agenda-overriding-header
10791 Note that this also binds @code{org-agenda-overriding-header} to get a
10792 meaningful header in the agenda view.
10794 @vindex org-odd-levels-only
10795 @vindex org-agenda-skip-function
10796 A general way to create custom searches is to base them on a search for
10797 entries with a certain level limit.  If you want to study all entries with
10798 your custom search function, simply do a search for
10799 @samp{LEVEL>0}@footnote{Note that, when using @code{org-odd-levels-only}, a
10800 level number corresponds to order in the hierarchy, not to the number of
10801 stars.}, and then use @code{org-agenda-skip-function} to select the entries
10802 you really want to have.
10804 You may also put a Lisp form into @code{org-agenda-skip-function}.  In
10805 particular, you may use the functions @code{org-agenda-skip-entry-if}
10806 and @code{org-agenda-skip-subtree-if} in this form, for example:
10808 @table @code
10809 @item '(org-agenda-skip-entry-if 'scheduled)
10810 Skip current entry if it has been scheduled.
10811 @item '(org-agenda-skip-entry-if 'notscheduled)
10812 Skip current entry if it has not been scheduled.
10813 @item '(org-agenda-skip-entry-if 'deadline)
10814 Skip current entry if it has a deadline.
10815 @item '(org-agenda-skip-entry-if 'scheduled 'deadline)
10816 Skip current entry if it has a deadline, or if it is scheduled.
10817 @item '(org-agenda-skip-entry-if 'timestamp)
10818 Skip current entry if it has any timestamp, may also be deadline or scheduled.
10819 @item '(org-agenda-skip-entry 'regexp "regular expression")
10820 Skip current entry if the regular expression matches in the entry.
10821 @item '(org-agenda-skip-entry 'notregexp "regular expression")
10822 Skip current entry unless the regular expression matches.
10823 @item '(org-agenda-skip-subtree-if 'regexp "regular expression")
10824 Same as above, but check and skip the entire subtree.
10825 @end table
10827 Therefore we could also have written the search for WAITING projects
10828 like this, even without defining a special function:
10830 @lisp
10831 (org-add-agenda-custom-command
10832  '("b" todo "PROJECT"
10833    ((org-agenda-skip-function '(org-agenda-skip-subtree-if
10834                                 'regexp ":waiting:"))
10835     (org-agenda-overriding-header "Projects waiting for something: "))))
10836 @end lisp
10838 @node Extracting agenda information, Using the property API, Special agenda views, Hacking
10839 @section Extracting agenda information
10840 @cindex agenda, pipe
10841 @cindex Scripts, for agenda processing
10843 @vindex org-agenda-custom-commands
10844 Org provides commands to access agenda information for the command
10845 line in emacs batch mode.  This extracted information can be sent
10846 directly to a printer, or it can be read by a program that does further
10847 processing of the data.  The first of these commands is the function
10848 @code{org-batch-agenda}, that produces an agenda view and sends it as
10849 ASCII text to STDOUT.  The command takes a single string as parameter.
10850 If the string has length 1, it is used as a key to one of the commands
10851 you have configured in @code{org-agenda-custom-commands}, basically any
10852 key you can use after @kbd{C-c a}.  For example, to directly print the
10853 current TODO list, you could use
10855 @example
10856 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
10857 @end example
10859 If the parameter is a string with 2 or more characters, it is used as a
10860 tags/todo match string.  For example, to print your local shopping list
10861 (all items with the tag @samp{shop}, but excluding the tag
10862 @samp{NewYork}), you could use
10864 @example
10865 emacs -batch -l ~/.emacs                                      \
10866       -eval '(org-batch-agenda "+shop-NewYork")' | lpr
10867 @end example
10869 @noindent
10870 You may also modify parameters on the fly like this:
10872 @example
10873 emacs -batch -l ~/.emacs                                      \
10874    -eval '(org-batch-agenda "a"                               \
10875             org-agenda-ndays 30                               \
10876             org-agenda-include-diary nil                      \
10877             org-agenda-files (quote ("~/org/project.org")))'  \
10878    | lpr
10879 @end example
10881 @noindent
10882 which will produce a 30 day agenda, fully restricted to the Org file
10883 @file{~/org/projects.org}, not even including the diary.
10885 If you want to process the agenda data in more sophisticated ways, you
10886 can use the command @code{org-batch-agenda-csv} to get a comma-separated
10887 list of values for each agenda item.  Each line in the output will
10888 contain a number of fields separated by commas.  The fields in a line
10889 are:
10891 @example
10892 category     @r{The category of the item}
10893 head         @r{The headline, without TODO kwd, TAGS and PRIORITY}
10894 type         @r{The type of the agenda entry, can be}
10895                 todo               @r{selected in TODO match}
10896                 tagsmatch          @r{selected in tags match}
10897                 diary              @r{imported from diary}
10898                 deadline           @r{a deadline}
10899                 scheduled          @r{scheduled}
10900                 timestamp          @r{appointment, selected by timestamp}
10901                 closed             @r{entry was closed on date}
10902                 upcoming-deadline  @r{warning about nearing deadline}
10903                 past-scheduled     @r{forwarded scheduled item}
10904                 block              @r{entry has date block including date}
10905 todo         @r{The TODO keyword, if any}
10906 tags         @r{All tags including inherited ones, separated by colons}
10907 date         @r{The relevant date, like 2007-2-14}
10908 time         @r{The time, like 15:00-16:50}
10909 extra        @r{String with extra planning info}
10910 priority-l   @r{The priority letter if any was given}
10911 priority-n   @r{The computed numerical priority}
10912 @end example
10914 @noindent
10915 Time and date will only be given if a timestamp (or deadline/scheduled)
10916 lead to the selection of the item.
10918 A CSV list like this is very easy to use in a post processing script.
10919 For example, here is a Perl program that gets the TODO list from
10920 Emacs/Org and prints all the items, preceded by a checkbox:
10922 @example
10923 #!/usr/bin/perl
10925 # define the Emacs command to run
10926 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
10928 # run it and capture the output
10929 $agenda = qx@{$cmd 2>/dev/null@};
10931 # loop over all lines
10932 foreach $line (split(/\n/,$agenda)) @{
10933   # get the individual values
10934   ($category,$head,$type,$todo,$tags,$date,$time,$extra,
10935    $priority_l,$priority_n) = split(/,/,$line);
10936   # process and print
10937   print "[ ] $head\n";
10939 @end example
10954 @node Using the property API, Using the mapping API, Extracting agenda information, Hacking
10955 @section Using the property API
10956 @cindex API, for properties
10957 @cindex properties, API
10959 Here is a description of the functions that can be used to work with
10960 properties.
10962 @defun org-entry-properties &optional pom which
10963 Get all properties of the entry at point-or-marker POM.
10964 This includes the TODO keyword, the tags, time strings for deadline,
10965 scheduled, and clocking, and any additional properties defined in the
10966 entry.  The return value is an alist, keys may occur multiple times
10967 if the property key was used several times.
10968 POM may also be nil, in which case the current entry is used.
10969 If WHICH is nil or `all', get all properties.  If WHICH is
10970 `special' or `standard', only get that subclass.
10971 @end defun
10972 @vindex org-use-property-inheritance
10973 @defun org-entry-get pom property &optional inherit
10974 Get value of PROPERTY for entry at point-or-marker POM.  By default,
10975 this only looks at properties defined locally in the entry.  If INHERIT
10976 is non-nil and the entry does not have the property, then also check
10977 higher levels of the hierarchy.  If INHERIT is the symbol
10978 @code{selective}, use inheritance if and only if the setting of
10979 @code{org-use-property-inheritance} selects PROPERTY for inheritance.
10980 @end defun
10982 @defun org-entry-delete pom property
10983 Delete the property PROPERTY from entry at point-or-marker POM.
10984 @end defun
10986 @defun org-entry-put pom property value
10987 Set PROPERTY to VALUE for entry at point-or-marker POM.
10988 @end defun
10990 @defun org-buffer-property-keys &optional include-specials
10991 Get all property keys in the current buffer.
10992 @end defun
10994 @defun org-insert-property-drawer
10995 Insert a property drawer at point.
10996 @end defun
10998 @defun org-entry-put-multivalued-property pom property &rest values
10999 Set PROPERTY at point-or-marker POM to VALUES.  VALUES should be a list of
11000 strings.  They will be concatenated, with spaces as separators.
11001 @end defun
11003 @defun org-entry-get-multivalued-property pom property
11004 Treat the value of the property PROPERTY as a whitespace-separated list of
11005 values and return the values as a list of strings.
11006 @end defun
11008 @defun org-entry-add-to-multivalued-property pom property value
11009 Treat the value of the property PROPERTY as a whitespace-separated list of
11010 values and make sure that VALUE is in this list.
11011 @end defun
11013 @defun org-entry-remove-from-multivalued-property pom property value
11014 Treat the value of the property PROPERTY as a whitespace-separated list of
11015 values and make sure that VALUE is @emph{not} in this list.
11016 @end defun
11018 @defun org-entry-member-in-multivalued-property pom property value
11019 Treat the value of the property PROPERTY as a whitespace-separated list of
11020 values and check if VALUE is in this list.
11021 @end defun
11023 @node Using the mapping API,  , Using the property API, Hacking
11024 @section Using the mapping API
11025 @cindex API, for mapping
11026 @cindex mapping entries, API
11028 Org has sophisticated mapping capabilities to find all entries satisfying
11029 certain criteria.  Internally, this functionality is used to produce agenda
11030 views, but there is also an API that can be used to execute arbitrary
11031 functions for each or selected entries.  The main entry point for this API
11034 @defun org-map-entries func &optional match scope &rest skip
11035 Call FUNC at each headline selected by MATCH in SCOPE.
11037 FUNC is a function or a lisp form.  The function will be called without
11038 arguments, with the cursor positioned at the beginning of the headline.
11039 The return values of all calls to the function will be collected and
11040 returned as a list.
11042 The call to FUNC will be wrapped into a save-excursion form, so FUNC
11043 does not need to preserve point.  After evaluaton, the cursor will be
11044 moved to the end of the line (presumably of the headline of the
11045 processed entry) and search continues from there.  Under some
11046 circumstances, this may not produce the wanted results.  For example,
11047 if you have removed (e.g. archived) the current (sub)tree it could
11048 mean that the next entry will be skipped entirely.  In such cases, you
11049 can specify the position from where search should continue by making
11050 FUNC set the variable `org-map-continue-from' to the desired buffer
11051 position.
11053 MATCH is a tags/property/todo match as it is used in the agenda match view.
11054 Only headlines that are matched by this query will be considered during
11055 the iteration.  When MATCH is nil or t, all headlines will be
11056 visited by the iteration.
11058 SCOPE determines the scope of this command.  It can be any of:
11060 @example
11061 nil     @r{the current buffer, respecting the restriction if any}
11062 tree    @r{the subtree started with the entry at point}
11063 file    @r{the current buffer, without restriction}
11064 file-with-archives
11065         @r{the current buffer, and any archives associated with it}
11066 agenda  @r{all agenda files}
11067 agenda-with-archives
11068         @r{all agenda files with any archive files associated with them}
11069 (file1 file2 ...)
11070         @r{if this is a list, all files in the list will be scanned}
11071 @end example
11073 The remaining args are treated as settings for the skipping facilities of
11074 the scanner.  The following items can be given here:
11076 @vindex org-agenda-skip-function
11077 @example
11078 archive   @r{skip trees with the archive tag}
11079 comment   @r{skip trees with the COMMENT keyword}
11080 function or Lisp form
11081           @r{will be used as value for @code{org-agenda-skip-function},}
11082           @r{so whenever the function returns t, FUNC}
11083           @r{will not be called for that entry and search will}
11084           @r{continue from the point where the function leaves it}
11085 @end example
11086 @end defun
11088 The function given to that mapping routine can really do anything you like.
11089 It can use the property API (@pxref{Using the property API}) to gather more
11090 information about the entry, or in order to change metadata in the entry.
11091 Here are a couple of functions that might be handy:
11093 @defun org-todo &optional arg
11094 Change the TODO state of the entry, see the docstring of the functions for
11095 the many possible values for the argument ARG.
11096 @end defun
11098 @defun org-priority &optional action
11099 Change the priority of the entry, see the docstring of this function for the
11100 possible values for ACTION.
11101 @end defun
11103 @defun org-toggle-tag tag &optional onoff
11104 Toggle the tag TAG in the current entry.  Setting ONOFF to either @code{on}
11105 or @code{off} will not toggle tag, but ensure that it is either on or off.
11106 @end defun
11108 @defun org-promote
11109 Promote the current entry.
11110 @end defun
11112 @defun org-demote
11113 Demote the current entry.
11114 @end defun
11116 Here is a simple example that will turn all entries in the current file with
11117 a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
11118 Entries in comment trees and in archive trees will be ignored.
11120 @lisp
11121 (org-map-entries
11122    '(org-todo "UPCOMING")
11123    "+TOMORROW" 'file 'archive 'comment)
11124 @end lisp
11126 The following example counts the number of entries with TODO keyword
11127 @code{WAITING}, in all agenda files.
11129 @lisp
11130 (length (org-map-entries t "/+WAITING" 'agenda))
11131 @end lisp
11133 @node History and Acknowledgments, Main Index, Hacking, Top
11134 @appendix History and Acknowledgments
11135 @cindex acknowledgments
11136 @cindex history
11137 @cindex thanks
11139 Org was borne in 2003, out of frustration over the user interface
11140 of the Emacs Outline mode.  I was trying to organize my notes and
11141 projects, and using Emacs seemed to be the natural way to go.  However,
11142 having to remember eleven different commands with two or three keys per
11143 command, only to hide and show parts of the outline tree, that seemed
11144 entirely unacceptable to me.  Also, when using outlines to take notes, I
11145 constantly want to restructure the tree, organizing it parallel to my
11146 thoughts and plans.  @emph{Visibility cycling} and @emph{structure
11147 editing} were originally implemented in the package
11148 @file{outline-magic.el}, but quickly moved to the more general
11149 @file{org.el}.  As this environment became comfortable for project
11150 planning, the next step was adding @emph{TODO entries}, basic @emph{time
11151 stamps}, and @emph{table support}.  These areas highlight the two main
11152 goals that Org still has today: To create a new, outline-based,
11153 plain text mode with innovative and intuitive editing features, and to
11154 incorporate project planning functionality directly into a notes file.
11156 A special thanks goes to @i{Bastien Guerry} who has not only written a large
11157 number of extensions to Org (most of them integrated into the core by now),
11158 but has also helped the development and maintenance of Org so much that he
11159 should be considered the main co-contributor to this package.
11161 Since the first release, literally thousands of emails to me or on
11162 @code{emacs-orgmode@@gnu.org} have provided a constant stream of bug
11163 reports, feedback, new ideas, and sometimes patches and add-on code.
11164 Many thanks to everyone who has helped to improve this package.  I am
11165 trying to keep here a list of the people who had significant influence
11166 in shaping one or more aspects of Org.  The list may not be
11167 complete, if I have forgotten someone, please accept my apologies and
11168 let me know.
11170 @itemize @bullet
11172 @item
11173 @i{Russel Adams} came up with the idea for drawers.
11174 @item
11175 @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
11176 @item
11177 @i{Christophe Bataillon} created the great unicorn logo that we use on the
11178 Org-mode website.
11179 @item
11180 @i{Alex Bochannek} provided a patch for rounding time stamps.
11181 @item
11182 @i{Brad Bozarth} showed how to pull RSS feed data into Org-mode files.
11183 @item
11184 @i{Tom Breton} wrote @file{org-choose.el}.
11185 @item
11186 @i{Charles Cave}'s suggestion sparked the implementation of templates
11187 for Remember.
11188 @item
11189 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
11190 specified time.
11191 @item
11192 @i{Gregory Chernov} patched support for lisp forms into table
11193 calculations and improved XEmacs compatibility, in particular by porting
11194 @file{nouline.el} to XEmacs.
11195 @item
11196 @i{Sacha Chua} suggested to copy some linking code from Planner.
11197 @item
11198 @i{Baoqiu Cui} contributed the DocBook exporter.
11199 @item
11200 @i{Eddward DeVilla} proposed and tested checkbox statistics.  He also
11201 came up with the idea of properties, and that there should be an API for
11202 them.
11203 @item
11204 @i{Nick Dokos} tracked down several nasty bugs.
11205 @item
11206 @i{Kees Dullemond} used to edit projects lists directly in HTML and so
11207 inspired some of the early development, including HTML export.  He also
11208 asked for a way to narrow wide table columns.
11209 @item
11210 @i{Christian Egli} converted the documentation into Texinfo format,
11211 patched CSS formatting into the HTML exporter, and inspired the agenda.
11212 @item
11213 @i{David Emery} provided a patch for custom CSS support in exported
11214 HTML agendas.
11215 @item
11216 @i{Nic Ferrier} contributed mailcap and XOXO support.
11217 @item
11218 @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
11219 @item
11220 @i{John Foerch} figured out how to make incremental search show context
11221 around a match in a hidden outline tree.
11222 @item
11223 @i{Niels Giesen} had the idea to automatically archive DONE trees.
11224 @item
11225 @i{Bastien Guerry} wrote the La@TeX{} exporter and @file{org-bibtex.el}, and
11226 has been prolific with patches, ideas, and bug reports.
11227 @item
11228 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
11229 @item
11230 @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
11231 task state change logging, and the clocktable.  His clear explanations have
11232 been critical when we started to adopt the GIT version control system.
11233 @item
11234 @i{Manuel Hermenegildo} has contributed various ideas, small fixed and
11235 patches.
11236 @item
11237 @i{Phil Jackson} wrote @file{org-irc.el}.
11238 @item
11239 @i{Scott Jaderholm} proposed footnotes, control over whitespace between
11240 folded entries, and column view for properties.
11241 @item
11242 @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
11243 @item
11244 @i{Shidai Liu} ("Leo") asked for embedded La@TeX{} and tested it.  He also
11245 provided frequent feedback and some patches.
11246 @item
11247 @i{Matt Lundin} has proposed last-row references for table formulas and named
11248 invisible anchors.  He has also worked a lot on the FAQ.
11249 @item
11250 @i{Jason F. McBrayer} suggested agenda export to CSV format.
11251 @item
11252 @i{Max Mikhanosha} came up with the idea of refiling.
11253 @item
11254 @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
11255 basis.
11256 @item
11257 @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
11258 happy.
11259 @item
11260 @i{Rick Moynihan} proposed to allow multiple TODO sequences in a file
11261 and to be able to quickly restrict the agenda to a subtree.
11262 @item
11263 @i{Todd Neal} provided patches for links to Info files and elisp forms.
11264 @item
11265 @i{Tim O'Callaghan} suggested in-file links, search options for general
11266 file links, and TAGS.
11267 @item
11268 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
11269 into Japanese.
11270 @item
11271 @i{Oliver Oppitz} suggested multi-state TODO items.
11272 @item
11273 @i{Scott Otterson} sparked the introduction of descriptive text for
11274 links, among other things.
11275 @item
11276 @i{Pete Phillips} helped during the development of the TAGS feature, and
11277 provided frequent feedback.
11278 @item
11279 @i{Martin Pohlack} provided the code snippet to bundle character insertion
11280 into bundles of 20 for undo.
11281 @item
11282 @i{T.V. Raman} reported bugs and suggested improvements.
11283 @item
11284 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
11285 control.
11286 @item
11287 @i{Paul Rivier} provided the basic implementation of named footnotes.
11288 @item
11289 @i{Kevin Rogers} contributed code to access VM files on remote hosts.
11290 @item
11291 @i{Sebastian Rose} wrote @file{org-info.js}, a Java script for displaying
11292 webpages derived from Org using an Info-like, or a folding interface with
11293 single key navigation.
11294 @item
11295 @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
11296 conflict with @file{allout.el}.
11297 @item
11298 @i{Jason Riedy} generalized the send-receive mechanism for orgtbl tables with
11299 extensive patches.
11300 @item
11301 @i{Philip Rooke} created the Org reference card, provided lots
11302 of feedback, developed and applied standards to the Org documentation.
11303 @item
11304 @i{Christian Schlauer} proposed angular brackets around links, among
11305 other things.
11306 @item
11307 @i{Eric Schulte} wrote @file{org-plot.el}.
11308 @item
11309 Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
11310 @file{organizer-mode.el}.
11311 @item
11312 @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal
11313 examples, and remote highlighting for referenced code lines.
11314 @item
11315 @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
11316 now packaged into Org's @file{contrib} directory.
11317 @item
11318 @i{Daniel Sinder} came up with the idea of internal archiving by locking
11319 subtrees.
11320 @item
11321 @i{Dale Smith} proposed link abbreviations.
11322 @item
11323 @i{James TD Smith} has contributed a large number of patches for useful
11324 tweaks and features.
11325 @item
11326 @i{Adam Spiers} asked for global linking commands, inspired the link
11327 extension system, added support for mairix, and proposed the mapping API.
11328 @item
11329 @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content
11330 with links transformation to Org syntax.
11331 @item
11332 @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
11333 chapter about publishing.
11334 @item
11335 @i{J@"urgen Vollmer} contributed code generating the table of contents
11336 in HTML output.
11337 @item
11338 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
11339 keyword.
11340 @item
11341 @i{David Wainberg} suggested archiving, and improvements to the linking
11342 system.
11343 @item
11344 @i{John Wiegley} wrote @file{emacs-wiki.el}, @file{planner.el}, and
11345 @file{muse.el}, which have some overlap with Org.  Initially the development
11346 of Org was fully independent because I was not aware of the existence of
11347 these packages.  But with time I have occasionally looked at John's code and
11348 learned a lot from it.  John has also contributed a number of great ideas and
11349 patches directly to Org, including the attachment system
11350 (@file{org-attach.el}), integration with Apple Mail
11351 (@file{org-mac-message.el}), and hierarchical dependencies of TODO items.
11352 @item
11353 @i{Carsten Wimmer} suggested some changes and helped fix a bug in
11354 linking to Gnus.
11355 @item
11356 @i{Roland Winkler} requested additional key bindings to make Org
11357 work on a tty.
11358 @item
11359 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
11360 and contributed various ideas and code snippets.
11361 @end itemize
11364 @node Main Index, Key Index, History and Acknowledgments, Top
11365 @unnumbered Concept Index
11367 @printindex cp
11369 @node Key Index, Variable and Faces Index, Main Index, Top
11370 @unnumbered Key Index
11372 @printindex ky
11374 @node Variable and Faces Index,  , Key Index, Top
11375 @unnumbered Variable Index
11377 This is not a complete index of variables and faces, only the ones that are
11378 mentioned in the manual.  For a more complete list, use @kbd{M-x
11379 org-customize @key{RET}} and then klick yourself through the tree.
11381 @printindex vr
11383 @bye
11385 @ignore
11386         arch-tag: 7893d1Fe-cc57-4d13-b5e5-f494a1CBC7ac
11387 @end ignore
11389 @c Local variables:
11390 @c ispell-local-dictionary: "en_US-w_accents"
11391 @c ispell-local-pdict: "./.aspell.org.pws"
11392 @c fill-column: 77
11393 @c End: