Push version number to 6.11pre01.
[org-mode.git] / doc / org.texi
blob15bea5836f3088824899410b2e1d95327f116069
1 \input texinfo
2 @c %**start of header
3 @setfilename ../../info/org
4 @settitle The Org Manual
6 @set VERSION 6.11pre01
7 @set DATE November 2008
9 @dircategory Emacs
10 @direntry
11 * Org Mode: (org).      Outline-based notes management and organizer
12 @end direntry
14 @c Version and Contact Info
15 @set MAINTAINERSITE @uref{http://orgmode.org,maintainers webpage}
16 @set AUTHOR Carsten Dominik
17 @set MAINTAINER Carsten Dominik
18 @set MAINTAINEREMAIL @email{carsten at orgmode dot org}
19 @set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer}
20 @c %**end of header
21 @finalout
23 @c Macro definitions
25 @c Subheadings inside a table.
26 @macro tsubheading{text}
27 @ifinfo
28 @subsubheading \text\
29 @end ifinfo
30 @ifnotinfo
31 @item @b{\text\}
32 @end ifnotinfo
33 @end macro
35 @copying
36 This manual is for Org (version @value{VERSION}).
38 Copyright @copyright{} 2004, 2005, 2006, 2007, 2008 Free Software Foundation
40 @quotation
41 Permission is granted to copy, distribute and/or modify this document
42 under the terms of the GNU Free Documentation License, Version 1.2 or
43 any later version published by the Free Software Foundation; with no
44 Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
45 and with the Back-Cover Texts as in (a) below.  A copy of the license
46 is included in the section entitled ``GNU Free Documentation License.''
48 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
49 modify this GNU manual.  Buying copies from the FSF supports it in
50 developing GNU and promoting software freedom.''
52 This document is part of a collection distributed under the GNU Free
53 Documentation License.  If you want to distribute this document
54 separately from the collection, you can do so by adding a copy of the
55 license to the document, as described in section 6 of the license.
56 @end quotation
57 @end copying
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 * Extensions::                  Add-ons for Org mode
97 * Hacking::                     How hack your way around
98 * History and Acknowledgments::  How Org came into being
99 * Main Index::                  An index of Org's concepts and features
100 * Key Index::                   Key bindings and where they are described
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 * Orgstruct mode::              Structure editing outside Org
126 Archiving
128 * ARCHIVE tag::                 Marking a tree as inactive
129 * Moving subtrees::             Moving a tree to an archive file
131 Tables
133 * Built-in table editor::       Simple tables
134 * Narrow columns::              Stop wasting space in tables
135 * Column groups::               Grouping to trigger vertical lines
136 * Orgtbl mode::                 The table editor as minor mode
137 * The spreadsheet::             The table editor has spreadsheet capabilities
138 * Org Plot::                    Plotting from org tables
140 The spreadsheet
142 * References::                  How to refer to another field or range
143 * Formula syntax for Calc::     Using Calc to compute stuff
144 * Formula syntax for Lisp::     Writing formulas in Emacs Lisp
145 * Field formulas::              Formulas valid for a single field
146 * Column formulas::             Formulas valid for an entire column
147 * Editing and debugging formulas::  Fixing formulas
148 * Updating the table::          Recomputing all dependent fields
149 * Advanced features::           Field names, parameters and automatic recalc
151 Hyperlinks
153 * Link format::                 How links in Org are formatted
154 * Internal links::              Links to other places in the current file
155 * External links::              URL-like links to the world
156 * Handling links::              Creating, inserting and following
157 * Using links outside Org::     Linking from my C source code?
158 * Link abbreviations::          Shortcuts for writing complex links
159 * Search options::              Linking to a specific location
160 * Custom searches::             When the default search is not enough
162 Internal links
164 * Radio targets::               Make targets trigger links in plain text
166 TODO Items
168 * TODO basics::                 Marking and displaying TODO entries
169 * TODO extensions::             Workflow and assignments
170 * Progress logging::            Dates and notes for progress
171 * Priorities::                  Some things are more important than others
172 * Breaking down tasks::         Splitting a task into manageable pieces
173 * Checkboxes::                  Tick-off lists
175 Extended use of TODO keywords
177 * Workflow states::             From TODO to DONE in steps
178 * TODO types::                  I do this, Fred does the rest
179 * Multiple sets in one file::   Mixing it all, and still finding your way
180 * Fast access to TODO states::  Single letter selection of a state
181 * Per-file keywords::           Different files, different requirements
182 * Faces for TODO keywords::     Highlighting states
184 Progress logging
186 * Closing items::               When was this entry marked DONE?
187 * Tracking TODO state changes::  When did the status change?
189 Tags
191 * Tag inheritance::             Tags use the tree structure of the outline
192 * Setting tags::                How to assign tags to a headline
193 * Tag searches::                Searching for combinations of tags
195 Properties and Columns
197 * Property syntax::             How properties are spelled out
198 * Special properties::          Access to other Org mode features
199 * Property searches::           Matching property values
200 * Property inheritance::        Passing values down the tree
201 * Column view::                 Tabular viewing and editing
202 * Property API::                Properties for Lisp programmers
204 Column view
206 * Defining columns::            The COLUMNS format property
207 * Using column view::           How to create and use column view
208 * Capturing column view::       A dynamic block for column view
210 Defining columns
212 * Scope of column definitions::  Where defined, where valid?
213 * Column attributes::           Appearance and content of a column
215 Dates and Times
217 * Timestamps::                  Assigning a time to a tree entry
218 * Creating timestamps::         Commands which insert timestamps
219 * Deadlines and scheduling::    Planning your work
220 * Clocking work time::          Tracking how long you spend on a task
221 * Effort estimates::            Planning work effort in advance
223 Creating timestamps
225 * The date/time prompt::        How Org mode helps you entering date and time
226 * Custom time format::          Making dates look different
228 Deadlines and scheduling
230 * Inserting deadline/schedule::  Planning items
231 * Repeated tasks::              Items that show up again and again
233 Capture
235 * Remember::                    Capture new tasks/ideas with little interruption
236 * Attachments::                 Add files to tasks.
238 Remember
240 * Setting up Remember::         Some code for .emacs to get things going
241 * Remember templates::          Define the outline of different note types
242 * Storing notes::               Directly get the note to where it belongs
243 * Refiling notes::              Moving a note or task to a project
245 Agenda Views
247 * Agenda files::                Files being searched for agenda information
248 * Agenda dispatcher::           Keyboard access to agenda views
249 * Built-in agenda views::       What is available out of the box?
250 * Presentation and sorting::    How agenda items are prepared for display
251 * Agenda commands::             Remote editing of Org trees
252 * Custom agenda views::         Defining special searches and views
253 * Agenda column view::          Using column view for collected entries
255 The built-in agenda views
257 * Weekly/daily agenda::         The calendar page with current tasks
258 * Global TODO list::            All unfinished action items
259 * Matching tags and properties::  Structured information with fine-tuned search
260 * Timeline::                    Time-sorted view for single file
261 * Keyword search::              Finding entries by keyword
262 * Stuck projects::              Find projects you need to review
264 Presentation and sorting
266 * Categories::                  Not all tasks are equal
267 * Time-of-day specifications::  How the agenda knows the time
268 * Sorting of agenda items::     The order of things
270 Custom agenda views
272 * Storing searches::            Type once, use often
273 * Block agenda::                All the stuff you need in a single buffer
274 * Setting Options::             Changing the rules
275 * Exporting Agenda Views::      Writing agendas to files
276 * Using the agenda elsewhere::  Using agenda information in other programs
278 Embedded LaTeX
280 * Math symbols::                TeX macros for symbols and Greek letters
281 * Subscripts and superscripts::  Simple syntax for raising/lowering text
282 * LaTeX fragments::             Complex formulas made easy
283 * Processing LaTeX fragments::  Previewing LaTeX processing
284 * CDLaTeX mode::                Speed up entering of formulas
286 Exporting
288 * Markup rules::                Which structures are recognized?
289 * Selective export::            Using tags to select and exclude trees
290 * Export options::              Per-file export settings
291 * The export dispatcher::       How to access exporter commands
292 * ASCII export::                Exporting to plain ASCII
293 * HTML export::                 Exporting to HTML
294 * LaTeX and PDF export::        Exporting to LaTeX, and processing to PDF
295 * XOXO export::                 Exporting to XOXO
296 * iCalendar export::            Exporting in iCalendar format
298 Markup rules
300 * Document title::              How the document title is determined
301 * Headings and sections::       The main structure of the exported document
302 * Table of contents::           If, where, how to create a table of contents
303 * Initial text::                Text before the first headline
304 * Lists::                       Plain lists are exported
305 * Paragraphs::                  What determines beginning and ending
306 * Literal examples::            Source code and other examples
307 * Include files::               Include the contents of a file during export
308 * Tables exported::             Tables are exported richly
309 * Footnotes::                   Numbers like [1]
310 * Emphasis and monospace::      To bold or not to bold
311 * TeX macros and LaTeX fragments::  Create special, rich export.
312 * Horizontal rules::            A line across the page
313 * Comment lines::               Some lines will not be exported
315 HTML export
317 * HTML Export commands::        How to invoke HTML export
318 * Quoting HTML tags::           Using direct HTML in Org mode
319 * Links::                       Transformation of links for HTML
320 * Images::                      How to include images
321 * CSS support::                 Changing the appearance of the output
322 * Javascript support::          Info and Folding in a web browser
324 LaTeX and PDF export
326 * LaTeX/PDF export commands::   
327 * Quoting LaTeX code::          Incorporating literal LaTeX code
328 * Sectioning structure::        Changing sectioning in LaTeX output
330 Publishing
332 * Configuration::               Defining projects
333 * Sample configuration::        Example projects
334 * Triggering publication::      Publication commands
336 Configuration
338 * Project alist::               The central configuration variable
339 * Sources and destinations::    From here to there
340 * Selecting files::             What files are part of the project?
341 * Publishing action::           Setting the function doing the publishing
342 * Publishing options::          Tweaking HTML export
343 * Publishing links::            Which links keep working after publishing?
344 * Project page index::          Publishing a list of project files
346 Sample configuration
348 * Simple example::              One-component publishing
349 * Complex example::             A multi-component publishing example
351 Miscellaneous
353 * Completion::                  M-TAB knows what you need
354 * Customization::               Adapting Org to your taste
355 * In-buffer settings::          Overview of the #+KEYWORDS
356 * The very busy C-c C-c key::   When in doubt, press C-c C-c
357 * Clean view::                  Getting rid of leading stars in the outline
358 * TTY keys::                    Using Org on a tty
359 * Interaction::                 Other Emacs packages
360 * Bugs::                        Things which do not work perfectly
362 Interaction with other packages
364 * Cooperation::                 Packages Org cooperates with
365 * Conflicts::                   Packages that lead to conflicts
367 Extensions
369 * Extensions in the contrib directory::  These come with the Org distro
370 * Other extensions::            These you have to find on the web.
372 Hacking
374 * Adding hyperlink types::      New custom link types
375 * Tables in arbitrary syntax::  Orgtbl for LaTeX and other programs
376 * Dynamic blocks::              Automatically filled blocks
377 * Special agenda views::        Customized views
378 * Using the property API::      Writing programs that use entry properties
379 * Using the mapping API::       Mapping over all or selected entries
381 Tables and lists in arbitrary syntax
383 * Radio tables::                Sending and receiving
384 * A LaTeX example::             Step by step, almost a tutorial
385 * Translator functions::        Copy and modify
386 * Radio lists::                 Doing the same for lists
388 @end detailmenu
389 @end menu
391 @node Introduction, Document Structure, Top, Top
392 @chapter Introduction
393 @cindex introduction
395 @menu
396 * Summary::                     Brief summary of what Org does
397 * Installation::                How to install a downloaded version of Org
398 * Activation::                  How to activate Org for certain buffers
399 * Feedback::                    Bug reports, ideas, patches etc.
400 * Conventions::                 Type-setting conventions in the manual
401 @end menu
403 @node Summary, Installation, Introduction, Introduction
404 @section Summary
405 @cindex summary
407 Org is a mode for keeping notes, maintaining TODO lists, and doing
408 project planning with a fast and effective plain-text system.
410 Org develops organizational tasks around NOTES files that contain
411 lists or information about projects as plain text.  Org is
412 implemented on top of Outline mode, which makes it possible to keep the
413 content of large files well structured.  Visibility cycling and
414 structure editing help to work with the tree.  Tables are easily created
415 with a built-in table editor.  Org supports TODO items, deadlines,
416 time stamps, and scheduling.  It dynamically compiles entries into an
417 agenda that utilizes and smoothly integrates much of the Emacs calendar
418 and diary.  Plain text URL-like links connect to websites, emails,
419 Usenet messages, BBDB entries, and any files related to the projects.
420 For printing and sharing of notes, an Org file can be exported as a
421 structured ASCII file, as HTML, or (TODO and agenda items only) as an
422 iCalendar file.  It can also serve as a publishing tool for a set of
423 linked web pages.
425 An important design aspect that distinguishes Org from for example
426 Planner/Muse is that it encourages to store every piece of information
427 only once.  In Planner, you have project pages, day pages and possibly
428 other files, duplicating some information such as tasks.  In Org,
429 you only have notes files.  In your notes you mark entries as tasks,
430 label them with tags and timestamps.  All necessary lists like a
431 schedule for the day, the agenda for a meeting, tasks lists selected by
432 tags etc are created dynamically when you need them.
434 Org keeps simple things simple.  When first fired up, it should
435 feel like a straightforward, easy to use outliner.  Complexity is not
436 imposed, but a large amount of functionality is available when you need
437 it.  Org is a toolbox and can be used in different ways, for
438 example as:
440 @example
441 @r{@bullet{} outline extension with visibility cycling and structure editing}
442 @r{@bullet{} ASCII system and table editor for taking structured notes}
443 @r{@bullet{} ASCII table editor with spreadsheet-like capabilities}
444 @r{@bullet{} TODO list editor}
445 @r{@bullet{} full agenda and planner with deadlines and work scheduling}
446 @r{@bullet{} environment to implement David Allen's GTD system}
447 @r{@bullet{} a basic database application}
448 @r{@bullet{} simple hypertext system, with HTML and LaTeX export}
449 @r{@bullet{} publishing tool to create a set of interlinked webpages}
450 @end example
452 Org's automatic, context sensitive table editor with spreadsheet
453 capabilities can be integrated into any major mode by activating the
454 minor Orgtbl mode.  Using a translation step, it can be used to maintain
455 tables in arbitrary file types, for example in La@TeX{}.  The structure
456 editing and list creation capabilities can be used outside Org with
457 the minor Orgstruct mode.
459 @cindex FAQ
460 There is a website for Org which provides links to the newest
461 version of Org, as well as additional information, frequently asked
462 questions (FAQ), links to tutorials etc.  This page is located at
463 @uref{http://orgmode.org}.
465 @page
468 @node Installation, Activation, Summary, Introduction
469 @section Installation
470 @cindex installation
471 @cindex XEmacs
473 @b{Important:} @i{If Org is part of the Emacs distribution or an
474 XEmacs package, please skip this section and go directly to
475 @ref{Activation}.}
477 If you have downloaded Org from the Web, either as a distribution @file{.zip}
478 or @file{.tar} file, or as a GIT archive, you must take the following steps
479 to install it: Go into the unpacked Org distribution directory and edit the
480 top section of the file @file{Makefile}.  You must set the name of the Emacs
481 binary (likely either @file{emacs} or @file{xemacs}), and the paths to the
482 directories where local Lisp and Info files are kept.  If you don't have
483 access to the system-wide directories, you can simply run Org directly from
484 the distribution directory by adding the @file{lisp} subdirectory to the
485 Emacs load path.  To do this, add the following line to @file{.emacs}:
487 @example
488 (setq load-path (cons "~/path/to/orgdir/lisp" load-path))
489 @end example
491 @noindent
492 If you plan to use code from the @file{contrib} subdirectory, do a similar
493 step for this directory:
495 @example
496 (setq load-path (cons "~/path/to/orgdir/contrib/lisp" load-path))
497 @end example
499 @b{XEmacs users now need to install the file @file{noutline.el} from
500 the @file{xemacs} sub-directory of the Org distribution.  Use the
501 command:}
503 @example
504 @b{make install-noutline}
505 @end example
507 @noindent Now byte-compile the Lisp files with the shell command:
509 @example
510 make
511 @end example
513 @noindent If you are running Org from the distribution directory, this is
514 all.  If you want to install into the system directories, use
516 @example
517 make install
518 make install-info
519 @end example
521 @noindent Then add to @file{.emacs}:
523 @lisp
524 ;; This line only if Org is not part of the X/Emacs distribution.
525 (require 'org-install)
526 @end lisp
529 @node Activation, Feedback, Installation, Introduction
530 @section Activation
531 @cindex activation
532 @cindex autoload
533 @cindex global key bindings
534 @cindex key bindings, global
536 @iftex
537 @b{Important:} @i{If you use copy-and-paste to copy lisp code from the
538 PDF documentation as viewed by some PDF viewers to your .emacs file, the
539 single quote character comes out incorrectly and the code will not work.
540 You need to fix the single quotes by hand, or copy from Info
541 documentation.}
542 @end iftex
544 Add the following lines to your @file{.emacs} file.  The last three lines
545 define @emph{global} keys for the commands @command{org-store-link},
546 @command{org-agenda}, and @command{org-iswitchb} - please choose suitable
547 keys yourself.
549 @lisp
550 ;; The following lines are always needed.  Choose your own keys.
551 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
552 (global-set-key "\C-cl" 'org-store-link)
553 (global-set-key "\C-ca" 'org-agenda)
554 (global-set-key "\C-cb" 'org-iswitchb)
555 @end lisp
557 Furthermore, you must activate @code{font-lock-mode} in Org
558 buffers, because significant functionality depends on font-locking being
559 active.  You can do this with either one of the following two lines
560 (XEmacs user must use the second option):
561 @lisp
562 (global-font-lock-mode 1)                     ; for all buffers
563 (add-hook 'org-mode-hook 'turn-on-font-lock)  ; Org buffers only
564 @end lisp
566 @cindex Org mode, turning on
567 With this setup, all files with extension @samp{.org} will be put
568 into Org mode.  As an alternative, make the first line of a file look
569 like this:
571 @example
572 MY PROJECTS    -*- mode: org; -*-
573 @end example
575 @noindent which will select Org mode for this buffer no matter what
576 the file's name is.  See also the variable
577 @code{org-insert-mode-line-in-empty-file}.
579 @node Feedback, Conventions, Activation, Introduction
580 @section Feedback
581 @cindex feedback
582 @cindex bug reports
583 @cindex maintainer
584 @cindex author
586 If you find problems with Org, or if you have questions, remarks, or ideas
587 about it, please mail to the Org mailing list @code{emacs-orgmode@@gnu.org}.
588 If you are not a member of the mailing list, your mail will be reviewed by a
589 moderator and then passed through to the list.
591 For bug reports, please provide as much information as possible,
592 including the version information of Emacs (@kbd{C-h v emacs-version
593 @key{RET}}) and Org (@kbd{C-h v org-version @key{RET}}), as well as
594 the Org related setup in @file{.emacs}.  If an error occurs, a
595 backtrace can be very useful (see below on how to create one).  Often a
596 small example file helps, along with clear information about:
598 @enumerate
599 @item What exactly did you do?
600 @item What did you expect to happen?
601 @item What happened instead?
602 @end enumerate
603 @noindent Thank you for helping to improve this mode.
605 @subsubheading How to create a useful backtrace
607 @cindex backtrace of an error
608 If working with Org produces an error with a message you don't
609 understand, you may have hit a bug.  The best way to report this is by
610 providing, in addition to what was mentioned above, a @emph{Backtrace}.
611 This is information from the built-in debugger about where and how the
612 error occurred.  Here is how to produce a useful backtrace:
614 @enumerate
615 @item
616 Start a fresh Emacs or XEmacs, and make sure that it will load the
617 original Lisp code in @file{org.el} instead of the compiled version in
618 @file{org.elc}.  The backtrace contains much more information if it is
619 produced with uncompiled code.  To do this, either rename @file{org.elc}
620 to something else before starting Emacs, or ask Emacs explicitly to load
621 @file{org.el} by using the command line
622 @example
623 emacs -l /path/to/org.el
624 @end example
625 @item
626 Go to the @code{Options} menu and select @code{Enter Debugger on Error}
627 (XEmacs has this option in the @code{Troubleshooting} sub-menu).
628 @item
629 Do whatever you have to do to hit the error.  Don't forget to
630 document the steps you take.
631 @item
632 When you hit the error, a @file{*Backtrace*} buffer will appear on the
633 screen.  Save this buffer to a file (for example using @kbd{C-x C-w}) and
634 attach it to your bug report.
635 @end enumerate
637 @node Conventions,  , Feedback, Introduction
638 @section Typesetting conventions used in this manual
640 Org uses three types of keywords: TODO keywords, tags, and property
641 names.  In this manual we use the following conventions:
643 @table @code
644 @item TODO
645 @itemx WAITING
646 TODO keywords are written with all capitals, even if they are
647 user-defined.
648 @item boss
649 @itemx ARCHIVE
650 User-defined tags are written in lowercase; built-in tags with special
651 meaning are written with all capitals.
652 @item Release
653 @itemx PRIORITY
654 User-defined properties are capitalized; built-in properties with
655 special meaning are written with all capitals.
656 @end table
658 @node Document Structure, Tables, Introduction, Top
659 @chapter Document Structure
660 @cindex document structure
661 @cindex structure of document
663 Org is based on outline mode and provides flexible commands to
664 edit the structure of the document.
666 @menu
667 * Outlines::                    Org is based on Outline mode
668 * Headlines::                   How to typeset Org tree headlines
669 * Visibility cycling::          Show and hide, much simplified
670 * Motion::                      Jumping to other headlines
671 * Structure editing::           Changing sequence and level of headlines
672 * Archiving::                   Move done task trees to a different place
673 * Sparse trees::                Matches embedded in context
674 * Plain lists::                 Additional structure within an entry
675 * Drawers::                     Tucking stuff away
676 * Orgstruct mode::              Structure editing outside Org
677 @end menu
679 @node Outlines, Headlines, Document Structure, Document Structure
680 @section Outlines
681 @cindex outlines
682 @cindex Outline mode
684 Org is implemented on top of Outline mode.  Outlines allow a
685 document to be organized in a hierarchical structure, which (at least
686 for me) is the best representation of notes and thoughts.  An overview
687 of this structure is achieved by folding (hiding) large parts of the
688 document to show only the general document structure and the parts
689 currently being worked on.  Org greatly simplifies the use of
690 outlines by compressing the entire show/hide functionality into a single
691 command @command{org-cycle}, which is bound to the @key{TAB} key.
693 @node Headlines, Visibility cycling, Outlines, Document Structure
694 @section Headlines
695 @cindex headlines
696 @cindex outline tree
698 Headlines define the structure of an outline tree.  The headlines in
699 Org start with one or more stars, on the left margin@footnote{See
700 the variable @code{org-special-ctrl-a/e} to configure special behavior
701 of @kbd{C-a} and @kbd{C-e} in headlines.}.  For example:
703 @example
704 * Top level headline
705 ** Second level
706 *** 3rd level
707     some text
708 *** 3rd level
709     more text
711 * Another top level headline
712 @end example
714 @noindent Some people find the many stars too noisy and would prefer an
715 outline that has whitespace followed by a single star as headline
716 starters.  @ref{Clean view} describes a setup to realize this.
718 An empty line after the end of a subtree is considered part of it and
719 will be hidden when the subtree is folded.  However, if you leave at
720 least two empty lines, one empty line will remain visible after folding
721 the subtree, in order to structure the collapsed view.  See the
722 variable @code{org-cycle-separator-lines} to modify this behavior.
724 @node Visibility cycling, Motion, Headlines, Document Structure
725 @section Visibility cycling
726 @cindex cycling, visibility
727 @cindex visibility cycling
728 @cindex trees, visibility
729 @cindex show hidden text
730 @cindex hide text
732 Outlines make it possible to hide parts of the text in the buffer.
733 Org uses just two commands, bound to @key{TAB} and
734 @kbd{S-@key{TAB}} to change the visibility in the buffer.
736 @cindex subtree visibility states
737 @cindex subtree cycling
738 @cindex folded, subtree visibility state
739 @cindex children, subtree visibility state
740 @cindex subtree, subtree visibility state
741 @table @kbd
742 @kindex @key{TAB}
743 @item @key{TAB}
744 @emph{Subtree cycling}: Rotate current subtree among the states
746 @example
747 ,-> FOLDED -> CHILDREN -> SUBTREE --.
748 '-----------------------------------'
749 @end example
751 The cursor must be on a headline for this to work@footnote{see, however,
752 the option @code{org-cycle-emulate-tab}.}.  When the cursor is at the
753 beginning of the buffer and the first line is not a headline, then
754 @key{TAB} actually runs global cycling (see below)@footnote{see the
755 option @code{org-cycle-global-at-bob}.}.  Also when called with a prefix
756 argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
758 @cindex global visibility states
759 @cindex global cycling
760 @cindex overview, global visibility state
761 @cindex contents, global visibility state
762 @cindex show all, global visibility state
763 @kindex S-@key{TAB}
764 @item S-@key{TAB}
765 @itemx C-u @key{TAB}
766 @emph{Global cycling}: Rotate the entire buffer among the states
768 @example
769 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
770 '--------------------------------------'
771 @end example
773 When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
774 CONTENTS view up to headlines of level N will be shown.  Note that inside
775 tables, @kbd{S-@key{TAB}} jumps to the previous field.
777 @cindex show all, command
778 @kindex C-u C-u C-u @key{TAB}
779 @item C-u C-u C-u @key{TAB}
780 Show all, including drawers.
781 @kindex C-c C-r
782 @item C-c C-r
783 Reveal context around point, showing the current entry, the following heading
784 and the hierarchy above.  Useful for working near a location that has been
785 exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
786 (@pxref{Agenda commands}).  With a prefix argument show, on each
787 level, all sibling headings.
788 @kindex C-c C-x b
789 @item C-c C-x b
790 Show the current subtree in an indirect buffer@footnote{The indirect
791 buffer
792 @ifinfo
793 (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
794 @end ifinfo
795 @ifnotinfo
796 (see the Emacs manual for more information about indirect buffers)
797 @end ifnotinfo
798 will contain the entire buffer, but will be narrowed to the current
799 tree.  Editing the indirect buffer will also change the original buffer,
800 but without affecting visibility in that buffer.}.  With a numeric
801 prefix argument N, go up to level N and then take that tree.  If N is
802 negative then go up that many levels.  With a @kbd{C-u} prefix, do not remove
803 the previously used indirect buffer.
804 @end table
806 When Emacs first visits an Org file, the global state is set to
807 OVERVIEW, i.e. only the top level headlines are visible.  This can be
808 configured through the variable @code{org-startup-folded}, or on a
809 per-file basis by adding one of the following lines anywhere in the
810 buffer:
812 @example
813 #+STARTUP: overview
814 #+STARTUP: content
815 #+STARTUP: showall
816 @end example
818 @noindent
819 Forthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
820 and Columns}) will get their visibility adapted accordingly.  Allowed values
821 for this property are @code{folded}, @code{children}, @code{content}, and
822 @code{all}.
823 @table @kbd
824 @kindex C-u C-u @key{TAB}
825 @item C-u C-u @key{TAB}
826 Switch back to the startup visibility of the buffer, i.e. whatever is
827 requested by startup options and @samp{VISIBILITY} properties in individual
828 entries.
829 @end table
831 @node Motion, Structure editing, Visibility cycling, Document Structure
832 @section Motion
833 @cindex motion, between headlines
834 @cindex jumping, to headlines
835 @cindex headline navigation
836 The following commands jump to other headlines in the buffer.
838 @table @kbd
839 @kindex C-c C-n
840 @item C-c C-n
841 Next heading.
842 @kindex C-c C-p
843 @item C-c C-p
844 Previous heading.
845 @kindex C-c C-f
846 @item C-c C-f
847 Next heading same level.
848 @kindex C-c C-b
849 @item C-c C-b
850 Previous heading same level.
851 @kindex C-c C-u
852 @item C-c C-u
853 Backward to higher level heading.
854 @kindex C-c C-j
855 @item C-c C-j
856 Jump to a different place without changing the current outline
857 visibility.  Shows the document structure in a temporary buffer, where
858 you can use the following keys to find your destination:
859 @example
860 @key{TAB}         @r{Cycle visibility.}
861 @key{down} / @key{up}   @r{Next/previous visible headline.}
862 @key{RET}         @r{Select this location.}
863 @kbd{/}           @r{Do a Sparse-tree search}
864 @r{The following keys work if you turn off @code{org-goto-auto-isearch}}
865 n / p        @r{Next/previous visible headline.}
866 f / b        @r{Next/previous headline same level.}
867 u            @r{One level up.}
868 0-9          @r{Digit argument.}
869 q            @r{Quit}
870 @end example
871 @end table
873 @node Structure editing, Archiving, Motion, Document Structure
874 @section Structure editing
875 @cindex structure editing
876 @cindex headline, promotion and demotion
877 @cindex promotion, of subtrees
878 @cindex demotion, of subtrees
879 @cindex subtree, cut and paste
880 @cindex pasting, of subtrees
881 @cindex cutting, of subtrees
882 @cindex copying, of subtrees
883 @cindex subtrees, cut and paste
885 @table @kbd
886 @kindex M-@key{RET}
887 @item M-@key{RET}
888 Insert new heading with same level as current.  If the cursor is in a
889 plain list item, a new item is created (@pxref{Plain lists}).  To force
890 creation of a new headline, use a prefix argument, or first press @key{RET}
891 to get to the beginning of the next line.  When this command is used in
892 the middle of a line, the line is split and the rest of the line becomes
893 the new headline@footnote{If you do not want the line to be split,
894 customize the variable @code{org-M-RET-may-split-line}.}.  If the
895 command is used at the beginning of a headline, the new headline is
896 created before the current line.  If at the beginning of any other line,
897 the content of that line is made the new heading.  If the command is
898 used at the end of a folded subtree (i.e. behind the ellipses at the end
899 of a headline), then a headline like the current one will be inserted
900 after the end of the subtree.
901 @kindex C-@key{RET}
902 @item C-@key{RET}
903 Just like @kbd{M-@key{RET}}, except when adding a new heading below the
904 current heading, the new heading is placed after the body instead of before
905 it.  This command works from anywhere in the entry.
906 @kindex M-S-@key{RET}
907 @item M-S-@key{RET}
908 Insert new TODO entry with same level as current heading.
909 @kindex C-S-@key{RET}
910 @item C-S-@key{RET}
911 Insert new TODO entry with same level as current heading.  Like
912 @kbd{C-@key{RET}}, the new headline will be inserted after the current
913 subtree.
914 @kindex M-@key{left}
915 @item M-@key{left}
916 Promote current heading by one level.
917 @kindex M-@key{right}
918 @item M-@key{right}
919 Demote current heading by one level.
920 @kindex M-S-@key{left}
921 @item M-S-@key{left}
922 Promote the current subtree by one level.
923 @kindex M-S-@key{right}
924 @item M-S-@key{right}
925 Demote the current subtree by one level.
926 @kindex M-S-@key{up}
927 @item M-S-@key{up}
928 Move subtree up (swap with previous subtree of same
929 level).
930 @kindex M-S-@key{down}
931 @item M-S-@key{down}
932 Move subtree down (swap with next subtree of same level).
933 @kindex C-c C-x C-w
934 @item C-c C-x C-w
935 Kill subtree, i.e. remove it from buffer but save in kill ring.
936 With a numeric prefix argument N, kill N sequential subtrees.
937 @kindex C-c C-x M-w
938 @item C-c C-x M-w
939 Copy subtree to kill ring.  With a numeric prefix argument N, copy the N
940 sequential subtrees.
941 @kindex C-c C-x C-y
942 @item C-c C-x C-y
943 Yank subtree from kill ring.  This does modify the level of the subtree to
944 make sure the tree fits in nicely at the yank position.  The yank level can
945 also be specified with a numeric prefix argument, or by yanking after a
946 headline marker like @samp{****}.
947 @kindex C-y 
948 @item C-y
949 Depending on the variables @code{org-yank-adjusted-subtrees} and
950 @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
951 paste subtrees folded and in a clever way, using the same command as @kbd{C-c
952 C-x C-y}.
953 @kindex C-c C-w
954 @item C-c C-w
955 Refile entry to a different location.  @xref{Refiling notes}.
956 @kindex C-c ^
957 @item C-c ^
958 Sort same-level entries.  When there is an active region, all entries in the
959 region will be sorted.  Otherwise the children of the current headline are
960 sorted.  The command prompts for the sorting method, which can be
961 alphabetically, numerically, by time (using the first time stamp in each
962 entry), by priority, or by TODO keyword (in the sequence the keywords have
963 been defined in the setup).  Reverse sorting is possible as well.  You can
964 also supply your own function to extract the sorting key.  With a @kbd{C-u}
965 prefix, sorting will be case-sensitive.  With two @kbd{C-u C-u} prefixes,
966 duplicate entries will also be removed.
967 @kindex C-x n s
968 @item C-x n s
969 Narrow buffer to current subtree.
970 @kindex C-x n w
971 @item C-x n w
972 Widen buffer to remove a narrowing.
973 @kindex C-c *
974 @item C-c *
975 Turn a normal line or plain list item into a headline (so that it
976 becomes a subheading at its location).  Also turn a headline into a
977 normal line by removing the stars.  If there is an active region, turn
978 all lines in the region into headlines.  Or, if the first line is a
979 headline, remove the stars from all headlines in the region.
980 @end table
982 @cindex region, active
983 @cindex active region
984 @cindex Transient mark mode
985 When there is an active region (Transient mark mode), promotion and
986 demotion work on all headlines in the region.  To select a region of
987 headlines, it is best to place both point and mark at the beginning of a
988 line, mark at the beginning of the first headline, and point at the line
989 just after the last headline to change.  Note that when the cursor is
990 inside a table (@pxref{Tables}), the Meta-Cursor keys have different
991 functionality.
993 @node Archiving, Sparse trees, Structure editing, Document Structure
994 @section Archiving
995 @cindex archiving
997 When a project represented by a (sub)tree is finished, you may want
998 to move the tree out of the way and to stop it from contributing to the
999 agenda.  Org mode knows two ways of archiving.  You can mark a tree with
1000 the ARCHIVE tag, or you can move an entire (sub)tree to a different
1001 location.
1003 @menu
1004 * ARCHIVE tag::                 Marking a tree as inactive
1005 * Moving subtrees::             Moving a tree to an archive file
1006 @end menu
1008 @node ARCHIVE tag, Moving subtrees, Archiving, Archiving
1009 @subsection The ARCHIVE tag
1010 @cindex internal archiving
1012 A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
1013 its location in the outline tree, but behaves in the following way:
1014 @itemize @minus
1015 @item
1016 It does not open when you attempt to do so with a visibility cycling
1017 command (@pxref{Visibility cycling}).  You can force cycling archived
1018 subtrees with @kbd{C-@key{TAB}}, or by setting the option
1019 @code{org-cycle-open-archived-trees}.  Also normal outline commands like
1020 @code{show-all} will open archived subtrees.
1021 @item
1022 During sparse tree construction (@pxref{Sparse trees}), matches in
1023 archived subtrees are not exposed, unless you configure the option
1024 @code{org-sparse-tree-open-archived-trees}.
1025 @item
1026 During agenda view construction (@pxref{Agenda Views}), the content of
1027 archived trees is ignored unless you configure the option
1028 @code{org-agenda-skip-archived-trees}, in which case these trees will always
1029 be included.  In the agenda you can press the @kbd{v} key to get archives
1030 temporarily included.
1031 @item
1032 Archived trees are not exported (@pxref{Exporting}), only the headline
1033 is.  Configure the details using the variable
1034 @code{org-export-with-archived-trees}.
1035 @end itemize
1037 The following commands help managing the ARCHIVE tag:
1039 @table @kbd
1040 @kindex C-c C-x a
1041 @item C-c C-x a
1042 Toggle the ARCHIVE tag for the current headline.  When the tag is set,
1043 the headline changes to a shadowed face, and the subtree below it is
1044 hidden.
1045 @kindex C-u C-c C-x a
1046 @item C-u C-c C-x a
1047 Check if any direct children of the current headline should be archived.
1048 To do this, each subtree is checked for open TODO entries.  If none are
1049 found, the command offers to set the ARCHIVE tag for the child.  If the
1050 cursor is @emph{not} on a headline when this command is invoked, the
1051 level 1 trees will be checked.
1052 @kindex C-@kbd{TAB}
1053 @item C-@kbd{TAB}
1054 Cycle a tree even if it is tagged with ARCHIVE.
1055 @end table
1057 @node Moving subtrees,  , ARCHIVE tag, Archiving
1058 @subsection Moving subtrees
1059 @cindex external archiving
1061 Once an entire project is finished, you may want to move it to a different
1062 location.  Org can move it to an @emph{Archive Sibling} in the same tree, to a
1063 different tree in the current file, or to a different file, the archive file.
1065 @table @kbd
1066 @kindex C-c C-x A
1067 @item C-c C-x A
1068 Move the current entry to the @emph{Archive Sibling}.  This is a sibling of
1069 the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}
1070 (@pxref{ARCHIVE tag}).  The entry becomes a child of that sibling and in this
1071 way retains a lot of its original context, including inherited tags and
1072 approximate position in the outline.
1073 @kindex C-c C-x C-s
1074 @item C-c C-x C-s
1075 Archive the subtree starting at the cursor position to the location
1076 given by @code{org-archive-location}.  Context information that could be
1077 lost like the file name, the category, inherited tags, and the TODO
1078 state will be store as properties in the entry.
1079 @kindex C-u C-c C-x C-s
1080 @item C-u C-c C-x C-s
1081 Check if any direct children of the current headline could be moved to
1082 the archive.  To do this, each subtree is checked for open TODO entries.
1083 If none are found, the command offers to move it to the archive
1084 location.  If the cursor is @emph{not} on a headline when this command
1085 is invoked, the level 1 trees will be checked.
1086 @end table
1088 @cindex archive locations
1089 The default archive location is a file in the same directory as the
1090 current file, with the name derived by appending @file{_archive} to the
1091 current file name.  For information and examples on how to change this,
1092 see the documentation string of the variable
1093 @code{org-archive-location}.  There is also an in-buffer option for
1094 setting this variable, for example@footnote{For backward compatibility,
1095 the following also works: If there are several such lines in a file,
1096 each specifies the archive location for the text below it.  The first
1097 such line also applies to any text before its definition.  However,
1098 using this method is @emph{strongly} deprecated as it is incompatible
1099 with the outline structure of the document.  The correct method for
1100 setting multiple archive locations in a buffer is using a property.}:
1102 @example
1103 #+ARCHIVE: %s_done::
1104 @end example
1106 @noindent
1107 If you would like to have a special ARCHIVE location for a single entry
1108 or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
1109 location as the value (@pxref{Properties and Columns}).
1111 When a subtree is moved, it receives a number of special properties that
1112 record context information like the file from where the entry came, it's
1113 outline path the archiving time etc.  Configure the variable
1114 @code{org-archive-save-context-info} to adjust the amount of information
1115 added.
1117 @node Sparse trees, Plain lists, Archiving, Document Structure
1118 @section Sparse trees
1119 @cindex sparse trees
1120 @cindex trees, sparse
1121 @cindex folding, sparse trees
1122 @cindex occur, command
1124 An important feature of Org mode is the ability to construct @emph{sparse
1125 trees} for selected information in an outline tree, so that the entire
1126 document is folded as much as possible, but the selected information is made
1127 visible along with the headline structure above it@footnote{See also the
1128 variables @code{org-show-hierarchy-above}, @code{org-show-following-heading},
1129 @code{org-show-siblings}, and @code{org-show-entry-below} for detailed
1130 control on how much context is shown around each match.}.  Just try it out
1131 and you will see immediately how it works.
1133 Org mode contains several commands creating such trees, all these
1134 commands can be accessed through a dispatcher:
1136 @table @kbd
1137 @kindex C-c /
1138 @item C-c /
1139 This prompts for an extra key to select a sparse-tree creating command.
1140 @kindex C-c / r
1141 @item C-c / r
1142 Occur.  Prompts for a regexp and shows a sparse tree with all matches.  If
1143 the match is in a headline, the headline is made visible.  If the match is in
1144 the body of an entry, headline and body are made visible.  In order to
1145 provide minimal context, also the full hierarchy of headlines above the match
1146 is shown, as well as the headline following the match.  Each match is also
1147 highlighted; the highlights disappear when the buffer is changed by an
1148 editing command@footnote{depending on the option
1149 @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
1150 When called with a @kbd{C-u} prefix argument, previous highlights are kept,
1151 so several calls to this command can be stacked.
1152 @end table
1154 @noindent
1155 For frequently used sparse trees of specific search strings, you can
1156 use the variable @code{org-agenda-custom-commands} to define fast
1157 keyboard access to specific sparse trees.  These commands will then be
1158 accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
1159 For example:
1161 @lisp
1162 (setq org-agenda-custom-commands
1163       '(("f" occur-tree "FIXME")))
1164 @end lisp
1166 @noindent will define the key @kbd{C-c a f} as a shortcut for creating
1167 a sparse tree matching the string @samp{FIXME}.
1169 The other sparse tree commands select headings based on TODO keywords,
1170 tags, or properties and will be discussed later in this manual.
1172 @kindex C-c C-e v
1173 @cindex printing sparse trees
1174 @cindex visible text, printing
1175 To print a sparse tree, you can use the Emacs command
1176 @code{ps-print-buffer-with-faces} which does not print invisible parts
1177 of the document @footnote{This does not work under XEmacs, because
1178 XEmacs uses selective display for outlining, not text properties.}.
1179 Or you can use the command @kbd{C-c C-e v} to export only the visible
1180 part of the document and print the resulting file.
1182 @node Plain lists, Drawers, Sparse trees, Document Structure
1183 @section Plain lists
1184 @cindex plain lists
1185 @cindex lists, plain
1186 @cindex lists, ordered
1187 @cindex ordered lists
1189 Within an entry of the outline tree, hand-formatted lists can provide
1190 additional structure.  They also provide a way to create lists of
1191 checkboxes (@pxref{Checkboxes}).  Org supports editing such lists,
1192 and the HTML exporter (@pxref{Exporting}) parses and formats them.
1194 Org knows ordered lists, unordered lists, and description lists.
1195 @itemize @bullet
1196 @item
1197 @emph{Unordered} list items start with @samp{-}, @samp{+}, or
1198 @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
1199 they will be seen as top-level headlines.  Also, when you are hiding leading
1200 stars to get a clean outline view, plain list items starting with a star are
1201 visually indistinguishable from true headlines.  In short: even though
1202 @samp{*} is supported, it may be better to not use it for plain list items.}
1203 as bullets.
1204 @item
1205 @emph{Ordered} list items start with a numeral followed by either a period or
1206 a right parenthesis, such as @samp{1.} or @samp{1)}.
1207 @item
1208 @emph{Description} list items are like unordered list items, but contain the
1209 separator @samp{ :: } to separate the description @emph{term} from the
1210 desciption.
1211 @end itemize
1213 Items belonging to the same list must have the same indentation on the first
1214 line.  In particular, if an ordered list reaches number @samp{10.}, then the
1215 2--digit numbers must be written left-aligned with the other numbers in the
1216 list.  Indentation also determines the end of a list item.  It ends before
1217 the next line that is indented like the bullet/number, or less.  Empty lines
1218 are part of the previous item, so you can have several paragraphs in one
1219 item.  If you would like an empty line to terminate all currently open plain
1220 lists, configure the variable @code{org-empty-line-terminates-plain-lists}.
1221 Here is an example:
1223 @example
1224 @group
1225 ** Lord of the Rings
1226    My favorite scenes are (in this order)
1227    1. The attack of the Rohirrim
1228    2. Eowyns fight with the witch king
1229       + this was already my favorite scene in the book
1230       + I really like Miranda Otto.
1231    3. Peter Jackson being shot by Legolas
1232        - on DVD only
1233       He makes a really funny face when it happens.
1234    But in the end, not individual scenes matter but the film as a whole.
1235    Important actors in this film are:
1236    - @b{Elijah Wood} :: He plays the Frodo
1237    - @b{Sean Austin} :: He plays the Sam, Frodos friend.  I still remember
1238      him very well from his role as Mikey Walsh a in the Goonies.
1239 @end group
1240 @end example
1242 Org supports these lists by tuning filling and wrapping commands to
1243 deal with them correctly@footnote{Org only changes the filling
1244 settings for Emacs.  For XEmacs, you should use Kyle E. Jones'
1245 @file{filladapt.el}.  To turn this on,  put into @file{.emacs}:
1246 @code{(require 'filladapt)}}, and by exporting them properly
1247 (@pxref{Exporting}).
1249 The following commands act on items when the cursor is in the first line
1250 of an item (the line with the bullet or number).
1252 @table @kbd
1253 @kindex @key{TAB}
1254 @item @key{TAB}
1255 Items can be folded just like headline levels if you set the variable
1256 @code{org-cycle-include-plain-lists}.  The level of an item is then
1257 given by the indentation of the bullet/number.  Items are always
1258 subordinate to real headlines, however; the hierarchies remain
1259 completely separated.
1261 If @code{org-cycle-include-plain-lists} has not been set, @key{TAB}
1262 fixes the indentation of the current line in a heuristic way.
1263 @kindex M-@key{RET}
1264 @item M-@key{RET}
1265 Insert new item at current level.  With a prefix argument, force a new
1266 heading (@pxref{Structure editing}).  If this command is used in the middle
1267 of a line, the line is @emph{split} and the rest of the line becomes the new
1268 item@footnote{If you do not want the line to be split, customize the variable
1269 @code{org-M-RET-may-split-line}.}.  If this command is executed in the
1270 @emph{whitespace before a bullet or number}, the new item is created
1271 @emph{before} the current item.  If the command is executed in the white
1272 space before the text that is part of an item but does not contain the
1273 bullet, a bullet is added to the current line.
1274 @kindex M-S-@key{RET}
1275 @item M-S-@key{RET}
1276 Insert a new item with a checkbox (@pxref{Checkboxes}).
1277 @kindex S-@key{up}
1278 @kindex S-@key{down}
1279 @item S-@key{up}
1280 @itemx S-@key{down}
1281 Jump to the previous/next item in the current list.
1282 @kindex M-S-@key{up}
1283 @kindex M-S-@key{down}
1284 @item M-S-@key{up}
1285 @itemx M-S-@key{down}
1286 Move the item including subitems up/down (swap with previous/next item
1287 of same indentation).  If the list is ordered, renumbering is
1288 automatic.
1289 @kindex M-S-@key{left}
1290 @kindex M-S-@key{right}
1291 @item M-S-@key{left}
1292 @itemx M-S-@key{right}
1293 Decrease/increase the indentation of the item, including subitems.
1294 Initially, the item tree is selected based on current indentation.
1295 When these commands are executed several times in direct succession,
1296 the initially selected region is used, even if the new indentation
1297 would imply a different hierarchy.  To use the new hierarchy, break
1298 the command chain with a cursor motion or so.
1299 @kindex C-c C-c
1300 @item C-c C-c
1301 If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
1302 state of the checkbox.  If not, this command makes sure that all the
1303 items on this list level use the same bullet.  Furthermore, if this is
1304 an ordered list, make sure the numbering is OK.
1305 @kindex C-c -
1306 @item C-c -
1307 Cycle the entire list level through the different itemize/enumerate bullets
1308 (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}).  With a numeric prefix
1309 argument N, select the Nth bullet from this list.  If there is an active
1310 region when calling this, all lines will be converted to list items.  If the
1311 first line already was a list item, any item markers will be removed from the
1312 list.  Finally, even without an active region, a normal line will be
1313 converted into a list item.
1314 @end table
1316 @node Drawers, Orgstruct mode, Plain lists, Document Structure
1317 @section Drawers
1318 @cindex drawers
1319 @cindex visibility cycling, drawers
1321 Sometimes you want to keep information associated with an entry, but you
1322 normally don't want to see it.  For this, Org mode has @emph{drawers}.
1323 Drawers need to be configured with the variable
1324 @code{org-drawers}@footnote{You can define drawers on a per-file basis
1325 with a line like @code{#+DRAWERS: HIDDEN PROPERTIES STATE}}.  Drawers
1326 look like this:
1328 @example
1329 ** This is a headline
1330    Still outside the drawer
1331    :DRAWERNAME:
1332       This is inside the drawer.
1333    :END:
1334    After the drawer.
1335 @end example
1337 Visibility cycling (@pxref{Visibility cycling}) on the headline will
1338 hide and show the entry, but keep the drawer collapsed to a single line.
1339 In order to look inside the drawer, you need to move the cursor to the
1340 drawer line and press @key{TAB} there.  Org mode uses a drawer for
1341 storing properties (@pxref{Properties and Columns}), and another one for
1342 storing clock times (@pxref{Clocking work time}).
1344 @node Orgstruct mode,  , Drawers, Document Structure
1345 @section The Orgstruct minor mode
1346 @cindex Orgstruct mode
1347 @cindex minor mode for structure editing
1349 If you like the intuitive way the Org mode structure editing and list
1350 formatting works, you might want to use these commands in other modes
1351 like Text mode or Mail mode as well.  The minor mode Orgstruct mode
1352 makes this possible.  You can always toggle the mode with @kbd{M-x
1353 orgstruct-mode}.  To turn it on by default, for example in Mail mode,
1356 @lisp
1357 (add-hook 'mail-mode-hook 'turn-on-orgstruct)
1358 @end lisp
1360 When this mode is active and the cursor is on a line that looks to
1361 Org like a headline of the first line of a list item, most
1362 structure editing commands will work, even if the same keys normally
1363 have different functionality in the major mode you are using.  If the
1364 cursor is not in one of those special lines, Orgstruct mode lurks
1365 silently in the shadow.
1367 @node Tables, Hyperlinks, Document Structure, Top
1368 @chapter Tables
1369 @cindex tables
1370 @cindex editing tables
1372 Org comes with a fast and intuitive table editor.  Spreadsheet-like
1373 calculations are supported in connection with the Emacs @file{calc}
1374 package
1375 @ifinfo
1376 (@pxref{Top,Calc,,Calc,Gnu Emacs Calculator Manual}).
1377 @end ifinfo
1378 @ifnotinfo
1379 (see the Emacs Calculator manual for more information about the Emacs
1380 calculator).
1381 @end ifnotinfo
1383 @menu
1384 * Built-in table editor::       Simple tables
1385 * Narrow columns::              Stop wasting space in tables
1386 * Column groups::               Grouping to trigger vertical lines
1387 * Orgtbl mode::                 The table editor as minor mode
1388 * The spreadsheet::             The table editor has spreadsheet capabilities
1389 * Org Plot::                    Plotting from org tables
1390 @end menu
1392 @node Built-in table editor, Narrow columns, Tables, Tables
1393 @section The built-in table editor
1394 @cindex table editor, built-in
1396 Org makes it easy to format tables in plain ASCII.  Any line with
1397 @samp{|} as the first non-whitespace character is considered part of a
1398 table.  @samp{|} is also the column separator.  A table might look like
1399 this:
1401 @example
1402 | Name  | Phone | Age |
1403 |-------+-------+-----|
1404 | Peter |  1234 |  17 |
1405 | Anna  |  4321 |  25 |
1406 @end example
1408 A table is re-aligned automatically each time you press @key{TAB} or
1409 @key{RET} or @kbd{C-c C-c} inside the table.  @key{TAB} also moves to
1410 the next field (@key{RET} to the next row) and creates new table rows
1411 at the end of the table or before horizontal lines.  The indentation
1412 of the table is set by the first line.  Any line starting with
1413 @samp{|-} is considered as a horizontal separator line and will be
1414 expanded on the next re-align to span the whole table width.  So, to
1415 create the above table, you would only type
1417 @example
1418 |Name|Phone|Age|
1420 @end example
1422 @noindent and then press @key{TAB} to align the table and start filling in
1423 fields.
1425 When typing text into a field, Org treats @key{DEL},
1426 @key{Backspace}, and all character keys in a special way, so that
1427 inserting and deleting avoids shifting other fields.  Also, when
1428 typing @emph{immediately after the cursor was moved into a new field
1429 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
1430 field is automatically made blank.  If this behavior is too
1431 unpredictable for you, configure the variables
1432 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
1434 @table @kbd
1435 @tsubheading{Creation and conversion}
1436 @kindex C-c |
1437 @item C-c |
1438 Convert the active region to table. If every line contains at least one
1439 TAB character, the function assumes that the material is tab separated.
1440 If every line contains a comma, comma-separated values (CSV) are assumed.
1441 If not, lines are split at whitespace into fields.  You can use a prefix
1442 argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
1443 C-u} forces TAB, and a numeric argument N indicates that at least N
1444 consecutive spaces, or alternatively a TAB will be the separator.
1446 If there is no active region, this command creates an empty Org
1447 table.  But it's easier just to start typing, like
1448 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
1450 @tsubheading{Re-aligning and field motion}
1451 @kindex C-c C-c
1452 @item C-c C-c
1453 Re-align the table without moving the cursor.
1455 @kindex @key{TAB}
1456 @item @key{TAB}
1457 Re-align the table, move to the next field.  Creates a new row if
1458 necessary.
1460 @kindex S-@key{TAB}
1461 @item S-@key{TAB}
1462 Re-align, move to previous field.
1464 @kindex @key{RET}
1465 @item @key{RET}
1466 Re-align the table and move down to next row.  Creates a new row if
1467 necessary.  At the beginning or end of a line, @key{RET} still does
1468 NEWLINE, so it can be used to split a table.
1470 @tsubheading{Column and row editing}
1471 @kindex M-@key{left}
1472 @kindex M-@key{right}
1473 @item M-@key{left}
1474 @itemx M-@key{right}
1475 Move the current column left/right.
1477 @kindex M-S-@key{left}
1478 @item M-S-@key{left}
1479 Kill the current column.
1481 @kindex M-S-@key{right}
1482 @item M-S-@key{right}
1483 Insert a new column to the left of the cursor position.
1485 @kindex M-@key{up}
1486 @kindex M-@key{down}
1487 @item M-@key{up}
1488 @itemx M-@key{down}
1489 Move the current row up/down.
1491 @kindex M-S-@key{up}
1492 @item M-S-@key{up}
1493 Kill the current row or horizontal line.
1495 @kindex M-S-@key{down}
1496 @item M-S-@key{down}
1497 Insert a new row above the current row.  With a prefix argument, the line is
1498 created below the current one.
1500 @kindex C-c -
1501 @item C-c -
1502 Insert a horizontal line below current row. With a prefix argument, the line
1503 is created above the current line.
1505 @kindex C-c ^
1506 @item C-c ^
1507 Sort the table lines in the region.  The position of point indicates the
1508 column to be used for sorting, and the range of lines is the range
1509 between the nearest horizontal separator lines, or the entire table.  If
1510 point is before the first column, you will be prompted for the sorting
1511 column.  If there is an active region, the mark specifies the first line
1512 and the sorting column, while point should be in the last line to be
1513 included into the sorting.  The command prompts for the sorting type
1514 (alphabetically, numerically, or by time).  When called with a prefix
1515 argument, alphabetic sorting will be case-sensitive.
1517 @tsubheading{Regions}
1518 @kindex C-c C-x M-w
1519 @item C-c C-x M-w
1520 Copy a rectangular region from a table to a special clipboard.  Point
1521 and mark determine edge fields of the rectangle.  The process ignores
1522 horizontal separator lines.
1524 @kindex C-c C-x C-w
1525 @item C-c C-x C-w
1526 Copy a rectangular region from a table to a special clipboard, and
1527 blank all fields in the rectangle.  So this is the ``cut'' operation.
1529 @kindex C-c C-x C-y
1530 @item C-c C-x C-y
1531 Paste a rectangular region into a table.
1532 The upper left corner ends up in the current field.  All involved fields
1533 will be overwritten.  If the rectangle does not fit into the present table,
1534 the table is enlarged as needed.  The process ignores horizontal separator
1535 lines.
1537 @kindex C-c C-q
1538 @kindex M-@key{RET}
1539 @item C-c C-q
1540 @itemx M-@kbd{RET}
1541 Wrap several fields in a column like a paragraph.  If there is an active
1542 region, and both point and mark are in the same column, the text in the
1543 column is wrapped to minimum width for the given number of lines.  A numeric
1544 prefix argument may be used to change the number of desired lines.  If there
1545 is no region, the current field is split at the cursor position and the text
1546 fragment to the right of the cursor is prepended to the field one line
1547 down. If there is no region, but you specify a prefix argument, the current
1548 field is made blank, and the content is appended to the field above.
1550 @tsubheading{Calculations}
1551 @cindex formula, in tables
1552 @cindex calculations, in tables
1553 @cindex region, active
1554 @cindex active region
1555 @cindex Transient mark mode
1556 @kindex C-c +
1557 @item C-c +
1558 Sum the numbers in the current column, or in the rectangle defined by
1559 the active region.  The result is shown in the echo area and can
1560 be inserted with @kbd{C-y}.
1562 @kindex S-@key{RET}
1563 @item S-@key{RET}
1564 When current field is empty, copy from first non-empty field above.  When not
1565 empty, copy current field down to next row and move cursor along with it.
1566 Depending on the variable @code{org-table-copy-increment}, integer field
1567 values will be incremented during copy.  Integers that are too large will not
1568 be incremented.  Also, a @code{0} prefix argument temporarily dispables the
1569 increment.  This key is also used by CUA mode (@pxref{Cooperation}).
1571 @tsubheading{Miscellaneous}
1572 @kindex C-c `
1573 @item C-c `
1574 Edit the current field in a separate window.  This is useful for fields
1575 that are not fully visible (@pxref{Narrow columns}).  When called with a
1576 @kbd{C-u} prefix, just make the full field visible, so that it can be
1577 edited in place.
1579 @item M-x org-table-import
1580 Import a file as a table.  The table should be TAB- or whitespace
1581 separated.  Useful, for example, to import a spreadsheet table or data
1582 from a database, because these programs generally can write
1583 TAB-separated text files.  This command works by inserting the file into
1584 the buffer and then converting the region to a table.  Any prefix
1585 argument is passed on to the converter, which uses it to determine the
1586 separator.
1587 @item C-c |
1588 Tables can also be imported by pasting tabular text into the Org
1589 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
1590 @kbd{C-c |} command (see above under @i{Creation and conversion}).
1592 @item M-x org-table-export
1593 Export the table, by default as a TAB-separated file.  Useful for data
1594 exchange with, for example, spreadsheet or database programs.  The format
1595 used to export the file can be configured in the variable
1596 @code{org-table-export-default-format}.  You may also use properties
1597 @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
1598 name and the format for table export in a subtree.  Org supports quite
1599 general formats for exported tables.  The exporter format is the same as the
1600 format used by Orgtbl radio tables, see @ref{Translator functions} for a
1601 detailed description.
1602 @end table
1604 If you don't like the automatic table editor because it gets in your
1605 way on lines which you would like to start with @samp{|}, you can turn
1606 it off with
1608 @lisp
1609 (setq org-enable-table-editor nil)
1610 @end lisp
1612 @noindent Then the only table command that still works is
1613 @kbd{C-c C-c} to do a manual re-align.
1615 @node Narrow columns, Column groups, Built-in table editor, Tables
1616 @section Narrow columns
1617 @cindex narrow columns in tables
1619 The width of columns is automatically determined by the table editor.
1620 Sometimes a single field or a few fields need to carry more text,
1621 leading to inconveniently wide columns.  To limit@footnote{This feature
1622 does not work on XEmacs.} the width of a column, one field anywhere in
1623 the column may contain just the string @samp{<N>} where @samp{N} is an
1624 integer specifying the width of the column in characters.  The next
1625 re-align will then set the width of this column to no more than this
1626 value.
1628 @example
1629 @group
1630 |---+------------------------------|               |---+--------|
1631 |   |                              |               |   | <6>    |
1632 | 1 | one                          |               | 1 | one    |
1633 | 2 | two                          |     ----\     | 2 | two    |
1634 | 3 | This is a long chunk of text |     ----/     | 3 | This=> |
1635 | 4 | four                         |               | 4 | four   |
1636 |---+------------------------------|               |---+--------|
1637 @end group
1638 @end example
1640 @noindent
1641 Fields that are wider become clipped and end in the string @samp{=>}.
1642 Note that the full text is still in the buffer, it is only invisible.
1643 To see the full text, hold the mouse over the field - a tool-tip window
1644 will show the full content.  To edit such a field, use the command
1645 @kbd{C-c `} (that is @kbd{C-c} followed by the backquote).  This will
1646 open a new window with the full field.  Edit it and finish with @kbd{C-c
1647 C-c}.
1649 When visiting a file containing a table with narrowed columns, the
1650 necessary character hiding has not yet happened, and the table needs to
1651 be aligned before it looks nice.  Setting the option
1652 @code{org-startup-align-all-tables} will realign all tables in a file
1653 upon visiting, but also slow down startup.  You can also set this option
1654 on a per-file basis with:
1656 @example
1657 #+STARTUP: align
1658 #+STARTUP: noalign
1659 @end example
1661 @node Column groups, Orgtbl mode, Narrow columns, Tables
1662 @section Column groups
1663 @cindex grouping columns in tables
1665 When Org exports tables, it does so by default without vertical
1666 lines because that is visually more satisfying in general.  Occasionally
1667 however, vertical lines can be useful to structure a table into groups
1668 of columns, much like horizontal lines can do for groups of rows.  In
1669 order to specify column groups, you can use a special row where the
1670 first field contains only @samp{/}.  The further fields can either
1671 contain @samp{<} to indicate that this column should start a group,
1672 @samp{>} to indicate the end of a column, or @samp{<>} to make a column
1673 a group of its own.  Boundaries between column groups will upon export be
1674 marked with vertical lines.  Here is an example:
1676 @example
1677 |   |  N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
1678 |---+----+-----+-----+-----+---------+------------|
1679 | / | <> |   < |     |   > |       < |          > |
1680 | # |  1 |   1 |   1 |   1 |       1 |          1 |
1681 | # |  2 |   4 |   8 |  16 |  1.4142 |     1.1892 |
1682 | # |  3 |   9 |  27 |  81 |  1.7321 |     1.3161 |
1683 |---+----+-----+-----+-----+---------+------------|
1684 #+TBLFM: $3=$2^2::$4=$2^3::$5=$2^4::$6=sqrt($2)::$7=sqrt(sqrt(($2)))
1685 @end example
1687 It is also sufficient to just insert the column group starters after
1688 every vertical line you'd like to have:
1690 @example
1691 |  N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
1692 |----+-----+-----+-----+---------+------------|
1693 | /  | <   |     |     | <       |            |
1694 @end example
1696 @node Orgtbl mode, The spreadsheet, Column groups, Tables
1697 @section The Orgtbl minor mode
1698 @cindex Orgtbl mode
1699 @cindex minor mode for tables
1701 If you like the intuitive way the Org table editor works, you
1702 might also want to use it in other modes like Text mode or Mail mode.
1703 The minor mode Orgtbl mode makes this possible.  You can always toggle
1704 the mode with @kbd{M-x orgtbl-mode}.  To turn it on by default, for
1705 example in mail mode, use
1707 @lisp
1708 (add-hook 'mail-mode-hook 'turn-on-orgtbl)
1709 @end lisp
1711 Furthermore, with some special setup, it is possible to maintain tables
1712 in arbitrary syntax with Orgtbl mode.  For example, it is possible to
1713 construct La@TeX{} tables with the underlying ease and power of
1714 Orgtbl mode, including spreadsheet capabilities.  For details, see
1715 @ref{Tables in arbitrary syntax}.
1717 @node The spreadsheet, Org Plot, Orgtbl mode, Tables
1718 @section The spreadsheet
1719 @cindex calculations, in tables
1720 @cindex spreadsheet capabilities
1721 @cindex @file{calc} package
1723 The table editor makes use of the Emacs @file{calc} package to implement
1724 spreadsheet-like capabilities.  It can also evaluate Emacs Lisp forms to
1725 derive fields from other fields.  While fully featured, Org's
1726 implementation is not identical to other spreadsheets.  For example,
1727 Org knows the concept of a @emph{column formula} that will be
1728 applied to all non-header fields in a column without having to copy the
1729 formula to each relevant field.
1731 @menu
1732 * References::                  How to refer to another field or range
1733 * Formula syntax for Calc::     Using Calc to compute stuff
1734 * Formula syntax for Lisp::     Writing formulas in Emacs Lisp
1735 * Field formulas::              Formulas valid for a single field
1736 * Column formulas::             Formulas valid for an entire column
1737 * Editing and debugging formulas::  Fixing formulas
1738 * Updating the table::          Recomputing all dependent fields
1739 * Advanced features::           Field names, parameters and automatic recalc
1740 @end menu
1742 @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet
1743 @subsection References
1744 @cindex references
1746 To compute fields in the table from other fields, formulas must
1747 reference other fields or ranges.  In Org, fields can be referenced
1748 by name, by absolute coordinates, and by relative coordinates.  To find
1749 out what the coordinates of a field are, press @kbd{C-c ?} in that
1750 field, or press @kbd{C-c @}} to toggle the display of a grid.
1752 @subsubheading Field references
1753 @cindex field references
1754 @cindex references, to fields
1756 Formulas can reference the value of another field in two ways.  Like in
1757 any other spreadsheet, you may reference fields with a letter/number
1758 combination like @code{B3}, meaning the 2nd field in the 3rd row.
1759 @c Such references are always fixed to that field, they don't change
1760 @c when you copy and paste a formula to a different field.  So
1761 @c Org's @code{B3} behaves like @code{$B$3} in other spreadsheets.
1763 @noindent
1764 Org also uses another, more general operator that looks like this:
1765 @example
1766 @@row$column
1767 @end example
1769 @noindent
1770 Column references can be absolute like @samp{1}, @samp{2},...@samp{N},
1771 or relative to the current column like @samp{+1} or @samp{-2}.
1773 The row specification only counts data lines and ignores horizontal
1774 separator lines (hlines).  You can use absolute row numbers
1775 @samp{1}...@samp{N}, and row numbers relative to the current row like
1776 @samp{+3} or @samp{-1}.  Or specify the row relative to one of the
1777 hlines: @samp{I} refers to the first hline@footnote{Note that only
1778 hlines are counted that @emph{separate} table lines.  If the table
1779 starts with a hline above the header, it does not count.}, @samp{II} to
1780 the second etc.  @samp{-I} refers to the first such line above the
1781 current line, @samp{+I} to the first such line below the current line.
1782 You can also write @samp{III+2} which is the second data line after the
1783 third hline in the table.  Relative row numbers like @samp{-3} will not
1784 cross hlines if the current line is too close to the hline.  Instead,
1785 the value directly at the hline is used.
1787 @samp{0} refers to the current row and column.  Also, if you omit
1788 either the column or the row part of the reference, the current
1789 row/column is implied.
1791 Org's references with @emph{unsigned} numbers are fixed references
1792 in the sense that if you use the same reference in the formula for two
1793 different fields, the same field will be referenced each time.
1794 Org's references with @emph{signed} numbers are floating
1795 references because the same reference operator can reference different
1796 fields depending on the field being calculated by the formula.
1798 Here are a few examples:
1800 @example
1801 @@2$3      @r{2nd row, 3rd column}
1802 C2        @r{same as previous}
1803 $5        @r{column 5 in the current row}
1804 E&        @r{same as previous}
1805 @@2        @r{current column, row 2}
1806 @@-1$-3    @r{the field one row up, three columns to the left}
1807 @@-I$2     @r{field just under hline above current row, column 2}
1808 @end example
1810 @subsubheading Range references
1811 @cindex range references
1812 @cindex references, to ranges
1814 You may reference a rectangular range of fields by specifying two field
1815 references connected by two dots @samp{..}.  If both fields are in the
1816 current row, you may simply use @samp{$2..$7}, but if at least one field
1817 is in a different row, you need to use the general @code{@@row$column}
1818 format at least for the first field (i.e the reference must start with
1819 @samp{@@} in order to be interpreted correctly).  Examples:
1821 @example
1822 $1..$3        @r{First three fields in the current row.}
1823 $P..$Q        @r{Range, using column names (see under Advanced)}
1824 @@2$1..@@4$3    @r{6 fields between these two fields.}
1825 A2..C4        @r{Same as above.}
1826 @@-1$-2..@@-1   @r{3 numbers from the column to the left, 2 up to current row}
1827 @end example
1829 @noindent Range references return a vector of values that can be fed
1830 into Calc vector functions.  Empty fields in ranges are normally
1831 suppressed, so that the vector contains only the non-empty fields (but
1832 see the @samp{E} mode switch below).  If there are no non-empty fields,
1833 @samp{[0]} is returned to avoid syntax errors in formulas.
1835 @subsubheading Named references
1836 @cindex named references
1837 @cindex references, named
1838 @cindex name, of column or field
1839 @cindex constants, in calculations
1841 @samp{$name} is interpreted as the name of a column, parameter or
1842 constant.  Constants are defined globally through the variable
1843 @code{org-table-formula-constants}, and locally (for the file) through a
1844 line like
1846 @example
1847 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
1848 @end example
1850 @noindent
1851 Also properties (@pxref{Properties and Columns}) can be used as
1852 constants in table formulas: For a property @samp{:Xyz:} use the name
1853 @samp{$PROP_Xyz}, and the property will be searched in the current
1854 outline entry and in the hierarchy above it.  If you have the
1855 @file{constants.el} package, it will also be used to resolve constants,
1856 including natural constants like @samp{$h} for Planck's constant, and
1857 units like @samp{$km} for kilometers@footnote{@file{Constant.el} can
1858 supply the values of constants in two different unit systems, @code{SI}
1859 and @code{cgs}.  Which one is used depends on the value of the variable
1860 @code{constants-unit-system}.  You can use the @code{#+STARTUP} options
1861 @code{constSI} and @code{constcgs} to set this value for the current
1862 buffer.}.  Column names and parameters can be specified in special table
1863 lines.  These are described below, see @ref{Advanced features}.  All
1864 names must start with a letter, and further consist of letters and
1865 numbers.
1867 @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet
1868 @subsection Formula syntax for Calc
1869 @cindex formula syntax, Calc
1870 @cindex syntax, of formulas
1872 A formula can be any algebraic expression understood by the Emacs
1873 @file{Calc} package.  @b{Note that @file{calc} has the
1874 non-standard convention that @samp{/} has lower precedence than
1875 @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.}  Before
1876 evaluation by @code{calc-eval} (@pxref{Calling Calc from
1877 Your Programs,calc-eval,Calling Calc from Your Lisp Programs,Calc,GNU
1878 Emacs Calc Manual}),
1879 @c FIXME:  The link to the Calc manual in HTML does not work.
1880 variable substitution takes place according to the rules described above.
1881 @cindex vectors, in table calculations
1882 The range vectors can be directly fed into the Calc vector functions
1883 like @samp{vmean} and @samp{vsum}.
1885 @cindex format specifier
1886 @cindex mode, for @file{calc}
1887 A formula can contain an optional mode string after a semicolon.  This
1888 string consists of flags to influence Calc and other modes during
1889 execution.  By default, Org uses the standard Calc modes (precision
1890 12, angular units degrees, fraction and symbolic modes off).  The display
1891 format, however, has been changed to @code{(float 5)} to keep tables
1892 compact.  The default settings can be configured using the variable
1893 @code{org-calc-default-modes}.
1895 @example
1896 p20           @r{switch the internal precision to 20 digits}
1897 n3 s3 e2 f4   @r{normal, scientific, engineering, or fixed display format}
1898 D R           @r{angle modes: degrees, radians}
1899 F S           @r{fraction and symbolic modes}
1900 N             @r{interpret all fields as numbers, use 0 for non-numbers}
1901 T             @r{force text interpretation}
1902 E             @r{keep empty fields in ranges}
1903 @end example
1905 @noindent
1906 In addition, you may provide a @code{printf} format specifier to
1907 reformat the final result.  A few examples:
1909 @example
1910 $1+$2                @r{Sum of first and second field}
1911 $1+$2;%.2f           @r{Same, format result to two decimals}
1912 exp($2)+exp($1)      @r{Math functions can be used}
1913 $0;%.1f              @r{Reformat current cell to 1 decimal}
1914 ($3-32)*5/9          @r{Degrees F -> C conversion}
1915 $c/$1/$cm            @r{Hz -> cm conversion, using @file{constants.el}}
1916 tan($1);Dp3s1        @r{Compute in degrees, precision 3, display SCI 1}
1917 sin($1);Dp3%.1e      @r{Same, but use printf specifier for display}
1918 vmean($2..$7)        @r{Compute column range mean, using vector function}
1919 vmean($2..$7);EN     @r{Same, but treat empty fields as 0}
1920 taylor($3,x=7,2)     @r{taylor series of $3, at x=7, second degree}
1921 @end example
1923 Calc also contains a complete set of logical operations.  For example
1925 @example
1926 if($1<20,teen,string(""))  @r{``teen'' if age $1 less than 20, else empty}
1927 @end example
1929 @node Formula syntax for Lisp, Field formulas, Formula syntax for Calc, The spreadsheet
1930 @subsection Emacs Lisp forms as formulas
1931 @cindex Lisp forms, as table formulas
1933 It is also possible to write a formula in Emacs Lisp; this can be useful
1934 for string manipulation and control structures, if the Calc's
1935 functionality is not enough.  If a formula starts with a single quote
1936 followed by an opening parenthesis, then it is evaluated as a lisp form.
1937 The evaluation should return either a string or a number.  Just as with
1938 @file{calc} formulas, you can specify modes and a printf format after a
1939 semicolon.  With Emacs Lisp forms, you need to be conscious about the way
1940 field references are interpolated into the form.  By default, a
1941 reference will be interpolated as a Lisp string (in double quotes)
1942 containing the field.  If you provide the @samp{N} mode switch, all
1943 referenced elements will be numbers (non-number fields will be zero) and
1944 interpolated as Lisp numbers, without quotes.  If you provide the
1945 @samp{L} flag, all fields will be interpolated literally, without quotes.
1946 I.e., if you want a reference to be interpreted as a string by the Lisp
1947 form, enclose the reference operator itself in double quotes, like
1948 @code{"$3"}.  Ranges are inserted as space-separated fields, so you can
1949 embed them in list or vector syntax.  A few examples, note how the
1950 @samp{N} mode is used when we do computations in lisp.
1952 @example
1953 @r{Swap the first two characters of the content of column 1}
1954   '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
1955 @r{Add columns 1 and 2, equivalent to the Calc's @code{$1+$2}}
1956   '(+ $1 $2);N
1957 @r{Compute the sum of columns 1-4, like Calc's @code{vsum($1..$4)}}
1958   '(apply '+ '($1..$4));N
1959 @end example
1961 @node Field formulas, Column formulas, Formula syntax for Lisp, The spreadsheet
1962 @subsection Field formulas
1963 @cindex field formula
1964 @cindex formula, for individual table field
1966 To assign a formula to a particular field, type it directly into the
1967 field, preceded by @samp{:=}, for example @samp{:=$1+$2}.  When you
1968 press @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in
1969 the field, the formula will be stored as the formula for this field,
1970 evaluated, and the current field replaced with the result.
1972 Formulas are stored in a special line starting with @samp{#+TBLFM:}
1973 directly below the table.  If you typed the equation in the 4th field of
1974 the 3rd data line in the table, the formula will look like
1975 @samp{@@3$4=$1+$2}.  When inserting/deleting/swapping column and rows
1976 with the appropriate commands, @i{absolute references} (but not relative
1977 ones) in stored formulas are modified in order to still reference the
1978 same field.  Of cause this is not true if you edit the table structure
1979 with normal editing commands - then you must fix the equations yourself.
1981 Instead of typing an equation into the field, you may also use the
1982 following command
1984 @table @kbd
1985 @kindex C-u C-c =
1986 @item C-u C-c =
1987 Install a new formula for the current field.  The command prompts for a
1988 formula, with default taken from the @samp{#+TBLFM:} line, applies
1989 it to the current field and stores it.
1990 @end table
1992 @node Column formulas, Editing and debugging formulas, Field formulas, The spreadsheet
1993 @subsection Column formulas
1994 @cindex column formula
1995 @cindex formula, for table column
1997 Often in a table, the same formula should be used for all fields in a
1998 particular column.  Instead of having to copy the formula to all fields
1999 in that column, Org allows to assign a single formula to an entire
2000 column.  If the table contains horizontal separator hlines, everything
2001 before the first such line is considered part of the table @emph{header}
2002 and will not be modified by column formulas.
2004 To assign a formula to a column, type it directly into any field in the
2005 column, preceded by an equal sign, like @samp{=$1+$2}.  When you press
2006 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the
2007 field, the formula will be stored as the formula for the current column,
2008 evaluated and the current field replaced with the result.  If the field
2009 contains only @samp{=}, the previously stored formula for this column is
2010 used.  For each column, Org will only remember the most recently
2011 used formula.  In the @samp{TBLFM:} line, column formulas will look like
2012 @samp{$4=$1+$2}.
2014 Instead of typing an equation into the field, you may also use the
2015 following command:
2017 @table @kbd
2018 @kindex C-c =
2019 @item C-c =
2020 Install a new formula for the current column and replace current field with
2021 the result of the formula.  The command prompts for a formula, with default
2022 taken from the @samp{#+TBLFM} line, applies it to the current field and
2023 stores it.  With a numeric prefix argument(e.g. @kbd{C-5 C-c =}) the command
2024 will apply it to that many consecutive fields in the current column.
2025 @end table
2027 @node Editing and debugging formulas, Updating the table, Column formulas, The spreadsheet
2028 @subsection Editing and debugging formulas
2029 @cindex formula editing
2030 @cindex editing, of table formulas
2032 You can edit individual formulas in the minibuffer or directly in the
2033 field.  Org can also prepare a special buffer with all active
2034 formulas of a table.  When offering a formula for editing, Org
2035 converts references to the standard format (like @code{B3} or @code{D&})
2036 if possible.  If you prefer to only work with the internal format (like
2037 @code{@@3$2} or @code{$4}), configure the variable
2038 @code{org-table-use-standard-references}.
2040 @table @kbd
2041 @kindex C-c =
2042 @kindex C-u C-c =
2043 @item C-c =
2044 @itemx C-u C-c =
2045 Edit the formula associated with the current column/field in the
2046 minibuffer.  See @ref{Column formulas} and @ref{Field formulas}.
2047 @kindex C-u C-u C-c =
2048 @item C-u C-u C-c =
2049 Re-insert the active formula (either a
2050 field formula, or a column formula) into the current field, so that you
2051 can edit it directly in the field.  The advantage over editing in the
2052 minibuffer is that you can use the command @kbd{C-c ?}.
2053 @kindex C-c ?
2054 @item C-c ?
2055 While editing a formula in a table field, highlight the field(s)
2056 referenced by the reference at the cursor position in the formula.
2057 @kindex C-c @}
2058 @item C-c @}
2059 Toggle the display of row and column numbers for a table, using
2060 overlays.  These are updated each time the table is aligned, you can
2061 force it with @kbd{C-c C-c}.
2062 @kindex C-c @{
2063 @item C-c @{
2064 Toggle the formula debugger on and off.  See below.
2065 @kindex C-c '
2066 @item C-c '
2067 Edit all formulas for the current table in a special buffer, where the
2068 formulas will be displayed one per line.  If the current field has an
2069 active formula, the cursor in the formula editor will mark it.
2070 While inside the special buffer, Org will automatically highlight
2071 any field or range reference at the cursor position.  You may edit,
2072 remove and add formulas, and use the following commands:
2073 @table @kbd
2074 @kindex C-c C-c
2075 @kindex C-x C-s
2076 @item C-c C-c
2077 @itemx C-x C-s
2078 Exit the formula editor and store the modified formulas.  With @kbd{C-u}
2079 prefix, also apply the new formulas to the entire table.
2080 @kindex C-c C-q
2081 @item C-c C-q
2082 Exit the formula editor without installing changes.
2083 @kindex C-c C-r
2084 @item C-c C-r
2085 Toggle all references in the formula editor between standard (like
2086 @code{B3}) and internal (like @code{@@3$2}).
2087 @kindex @key{TAB}
2088 @item @key{TAB}
2089 Pretty-print or indent lisp formula at point.  When in a line containing
2090 a lisp formula, format the formula according to Emacs Lisp rules.
2091 Another @key{TAB} collapses the formula back again.  In the open
2092 formula, @key{TAB} re-indents just like in Emacs lisp mode.
2093 @kindex M-@key{TAB}
2094 @item M-@key{TAB}
2095 Complete Lisp symbols, just like in Emacs lisp mode.
2096 @kindex S-@key{up}
2097 @kindex S-@key{down}
2098 @kindex S-@key{left}
2099 @kindex S-@key{right}
2100 @item S-@key{up}/@key{down}/@key{left}/@key{right}
2101 Shift the reference at point.  For example, if the reference is
2102 @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
2103 This also works for relative references, and for hline references.
2104 @kindex M-S-@key{up}
2105 @kindex M-S-@key{down}
2106 @item M-S-@key{up}/@key{down}
2107 Move the test line for column formulas in the Org buffer up and
2108 down.
2109 @kindex M-@key{up}
2110 @kindex M-@key{down}
2111 @item M-@key{up}/@key{down}
2112 Scroll the window displaying the table.
2113 @kindex C-c @}
2114 @item C-c @}
2115 Turn the coordinate grid in the table on and off.
2116 @end table
2117 @end table
2119 Making a table field blank does not remove the formula associated with
2120 the field, because that is stored in a different line (the @samp{TBLFM}
2121 line) - during the next recalculation the field will be filled again.
2122 To remove a formula from a field, you have to give an empty reply when
2123 prompted for the formula, or to edit the @samp{#+TBLFM} line.
2125 @kindex C-c C-c
2126 You may edit the @samp{#+TBLFM} directly and re-apply the changed
2127 equations with @kbd{C-c C-c} in that line, or with the normal
2128 recalculation commands in the table.
2130 @subsubheading Debugging formulas
2131 @cindex formula debugging
2132 @cindex debugging, of table formulas
2133 When the evaluation of a formula leads to an error, the field content
2134 becomes the string @samp{#ERROR}.  If you would like see what is going
2135 on during variable substitution and calculation in order to find a bug,
2136 turn on formula debugging in the @code{Tbl} menu and repeat the
2137 calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
2138 field.  Detailed information will be displayed.
2140 @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet
2141 @subsection Updating the table
2142 @cindex recomputing table fields
2143 @cindex updating, table
2145 Recalculation of a table is normally not automatic, but needs to be
2146 triggered by a command.  See @ref{Advanced features} for a way to make
2147 recalculation at least semi-automatically.
2149 In order to recalculate a line of a table or the entire table, use the
2150 following commands:
2152 @table @kbd
2153 @kindex C-c *
2154 @item C-c *
2155 Recalculate the current row by first applying the stored column formulas
2156 from left to right, and all field formulas in the current row.
2158 @kindex C-u C-c *
2159 @item C-u C-c *
2160 @kindex C-u C-c C-c
2161 @itemx C-u C-c C-c
2162 Recompute the entire table, line by line.  Any lines before the first
2163 hline are left alone, assuming that these are part of the table header.
2165 @kindex C-u C-u C-c *
2166 @kindex C-u C-u C-c C-c
2167 @item C-u C-u C-c *
2168 @itemx C-u C-u C-c C-c
2169 Iterate the table by recomputing it until no further changes occur.
2170 This may be necessary if some computed fields use the value of other
2171 fields that are computed @i{later} in the calculation sequence.
2172 @end table
2174 @node Advanced features,  , Updating the table, The spreadsheet
2175 @subsection Advanced features
2177 If you want the recalculation of fields to happen automatically, or if
2178 you want to be able to assign @i{names} to fields and columns, you need
2179 to reserve the first column of the table for special marking characters.
2180 @table @kbd
2181 @kindex C-#
2182 @item C-#
2183 Rotate the calculation mark in first column through the states @samp{},
2184 @samp{#}, @samp{*}, @samp{!}, @samp{$}.  When there is an active region,
2185 change all marks in the region.
2186 @end table
2188 Here is an example of a table that collects exam results of students and
2189 makes use of these features:
2191 @example
2192 @group
2193 |---+---------+--------+--------+--------+-------+------|
2194 |   | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
2195 |---+---------+--------+--------+--------+-------+------|
2196 | ! |         |     P1 |     P2 |     P3 |   Tot |      |
2197 | # | Maximum |     10 |     15 |     25 |    50 | 10.0 |
2198 | ^ |         |     m1 |     m2 |     m3 |    mt |      |
2199 |---+---------+--------+--------+--------+-------+------|
2200 | # | Peter   |     10 |      8 |     23 |    41 |  8.2 |
2201 | # | Sam     |      2 |      4 |      3 |     9 |  1.8 |
2202 |---+---------+--------+--------+--------+-------+------|
2203 |   | Average |        |        |        |  29.7 |      |
2204 | ^ |         |        |        |        |    at |      |
2205 | $ | max=50  |        |        |        |       |      |
2206 |---+---------+--------+--------+--------+-------+------|
2207 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
2208 @end group
2209 @end example
2211 @noindent @b{Important}: Please note that for these special tables,
2212 recalculating the table with @kbd{C-u C-c *} will only affect rows that
2213 are marked @samp{#} or @samp{*}, and fields that have a formula assigned
2214 to the field itself.  The column formulas are not applied in rows with
2215 empty first field.
2217 @cindex marking characters, tables
2218 The marking characters have the following meaning:
2219 @table @samp
2220 @item !
2221 The fields in this line define names for the columns, so that you may
2222 refer to a column as @samp{$Tot} instead of @samp{$6}.
2223 @item ^
2224 This row defines names for the fields @emph{above} the row.  With such
2225 a definition, any formula in the table may use @samp{$m1} to refer to
2226 the value @samp{10}.  Also, if you assign a formula to a names field, it
2227 will be stored as @samp{$name=...}.
2228 @item _
2229 Similar to @samp{^}, but defines names for the fields in the row
2230 @emph{below}.
2231 @item $
2232 Fields in this row can define @emph{parameters} for formulas.  For
2233 example, if a field in a @samp{$} row contains @samp{max=50}, then
2234 formulas in this table can refer to the value 50 using @samp{$max}.
2235 Parameters work exactly like constants, only that they can be defined on
2236 a per-table basis.
2237 @item #
2238 Fields in this row are automatically recalculated when pressing
2239 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row.  Also, this row
2240 is selected for a global recalculation with @kbd{C-u C-c *}.  Unmarked
2241 lines will be left alone by this command.
2242 @item *
2243 Selects this line for global recalculation with @kbd{C-u C-c *}, but
2244 not for automatic recalculation.  Use this when automatic
2245 recalculation slows down editing too much.
2246 @item
2247 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
2248 All lines that should be recalculated should be marked with @samp{#}
2249 or @samp{*}.
2250 @item /
2251 Do not export this line.  Useful for lines that contain the narrowing
2252 @samp{<N>} markers.
2253 @end table
2255 Finally, just to whet your appetite on what can be done with the
2256 fantastic @file{calc} package, here is a table that computes the Taylor
2257 series of degree @code{n} at location @code{x} for a couple of
2258 functions.
2260 @example
2261 @group
2262 |---+-------------+---+-----+--------------------------------------|
2263 |   | Func        | n | x   | Result                               |
2264 |---+-------------+---+-----+--------------------------------------|
2265 | # | exp(x)      | 1 | x   | 1 + x                                |
2266 | # | exp(x)      | 2 | x   | 1 + x + x^2 / 2                      |
2267 | # | exp(x)      | 3 | x   | 1 + x + x^2 / 2 + x^3 / 6            |
2268 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
2269 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2    |
2270 | * | tan(x)      | 3 | x   | 0.0175 x + 1.77e-6 x^3               |
2271 |---+-------------+---+-----+--------------------------------------|
2272 #+TBLFM: $5=taylor($2,$4,$3);n3
2273 @end group
2274 @end example
2276 @page
2277 @node Org Plot,  , The spreadsheet, Tables
2278 @section Org Plot
2279 @cindex graph, in tables
2280 @cindex plot tables using gnuplot
2282 Org Plot can produce 2D and 3D graphs of information stored in org tables
2283 using @file{Gnuplot} @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
2284 @uref{http://cars9.uchicago.edu/~ravel/software/gnuplot-mode.html}.  To see
2285 this in action ensure that you have both Gnuplot and Gnuplot-mode installed
2286 on your system, then call @code{org-plot/gnuplot} on the following table.
2288 @example
2289 @group
2290 #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
2291 | Sede      | Max cites | H-index |
2292 |-----------+-----------+---------|
2293 | Chile     |    257.72 |   21.39 |
2294 | Leeds     |    165.77 |   19.68 |
2295 | Sao Paolo |     71.00 |   11.50 |
2296 | Stockholm |    134.19 |   14.33 |
2297 | Morelia   |    257.56 |   17.67 |
2298 @end group
2299 @end example
2301 Notice that Org Plot is smart enough to apply the tables headers as labels.
2302 Further control over the labels, type, content, and appearance of plots can
2303 be exercised through the @code{#+Plot:} lines preceding a table.  See below
2304 for a complete list of Org plot options.  For more information and examples
2305 see the org-plot tutorial at
2306 @uref{http://legito.org/worg/org-tutorials/org-plot.php}.
2308 @subsubheading Plot Options
2310 @table @code
2311 @item set
2312 Specify any @file{gnuplot} option to be set when graphing.
2314 @item title
2315 Specify the title of the plot.
2317 @item ind
2318 Specify which column of the table to use as the @code{x} axis.
2320 @item deps
2321 Specify the columns to graph as a lisp style list, surrounded by parenthesis
2322 and separated by spaces for example @code{dep:(3 4)} to graph the third and
2323 fourth columns (defaults to graphing all other columns aside from the ind
2324 column).
2326 @item type
2327 Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
2329 @item with
2330 Specify a @code{with} option to be inserted for every col being plotted
2331 (e.g. @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
2332 Defaults to 'lines'.
2334 @item file
2335 If you want to plot to a file specify the @code{"path/to/desired/output-file"}.
2337 @item labels
2338 List of labels to be used for the deps (defaults to column headers if they
2339 exist).
2341 @item line
2342 Specify an entire line to be inserted in the gnuplot script.
2344 @item map
2345 When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
2346 flat mapping rather than a @code{3d} slope.
2348 @item timefmt
2349 Specify format of org-mode timestamps as they will be parsed by gnuplot.
2350 Defaults to '%Y-%m-%d-%H:%M:%S'.
2352 @item script
2353 If you want total control you can specify a script file (place the file name
2354 between double quotes) which will be used to plot.  Before plotting, every
2355 instance of @code{$datafile} in the specified script will be replaced with
2356 the path to the generated data file.  Note even if you set this option you
2357 may still want to specify the plot type, as that can impact the content of
2358 the data file.
2359 @end table
2361 @node Hyperlinks, TODO Items, Tables, Top
2362 @chapter Hyperlinks
2363 @cindex hyperlinks
2365 Like HTML, Org provides links inside a file, external links to
2366 other files, Usenet articles, emails, and much more.
2368 @menu
2369 * Link format::                 How links in Org are formatted
2370 * Internal links::              Links to other places in the current file
2371 * External links::              URL-like links to the world
2372 * Handling links::              Creating, inserting and following
2373 * Using links outside Org::     Linking from my C source code?
2374 * Link abbreviations::          Shortcuts for writing complex links
2375 * Search options::              Linking to a specific location
2376 * Custom searches::             When the default search is not enough
2377 @end menu
2379 @node Link format, Internal links, Hyperlinks, Hyperlinks
2380 @section Link format
2381 @cindex link format
2382 @cindex format, of links
2384 Org will recognize plain URL-like links and activate them as
2385 clickable links.  The general link format, however, looks like this:
2387 @example
2388 [[link][description]]       @r{or alternatively}           [[link]]
2389 @end example
2391 Once a link in the buffer is complete (all brackets present), Org
2392 will change the display so that @samp{description} is displayed instead
2393 of @samp{[[link][description]]} and @samp{link} is displayed instead of
2394 @samp{[[link]]}.  Links will be highlighted in the face @code{org-link},
2395 which by default is an underlined face.  You can directly edit the
2396 visible part of a link.  Note that this can be either the @samp{link}
2397 part (if there is no description) or the @samp{description} part.  To
2398 edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
2399 cursor on the link.
2401 If you place the cursor at the beginning or just behind the end of the
2402 displayed text and press @key{BACKSPACE}, you will remove the
2403 (invisible) bracket at that location.  This makes the link incomplete
2404 and the internals are again displayed as plain text.  Inserting the
2405 missing bracket hides the link internals again.  To show the
2406 internal structure of all links, use the menu entry
2407 @code{Org->Hyperlinks->Literal links}.
2409 @node Internal links, External links, Link format, Hyperlinks
2410 @section Internal links
2411 @cindex internal links
2412 @cindex links, internal
2413 @cindex targets, for links
2415 If the link does not look like a URL, it is considered to be internal in
2416 the current file.  Links such as @samp{[[My Target]]} or @samp{[[My
2417 Target][Find my target]]} lead to a text search in the current file.
2418 The link can be followed with @kbd{C-c C-o} when the cursor is on the
2419 link, or with a mouse click (@pxref{Handling links}).  The preferred
2420 match for such a link is a dedicated target: the same string in double
2421 angular brackets.  Targets may be located anywhere; sometimes it is
2422 convenient to put them into a comment line. For example
2424 @example
2425 # <<My Target>>
2426 @end example
2428 @noindent In HTML export (@pxref{HTML export}), such targets will become
2429 named anchors for direct access through @samp{http} links@footnote{Note
2430 that text before the first headline is usually not exported, so the
2431 first such target should be after the first headline.}.
2433 If no dedicated target exists, Org will search for the words in the
2434 link.  In the above example the search would be for @samp{my target}.
2435 Links starting with a star like @samp{*My Target} restrict the search to
2436 headlines.  When searching, Org mode will first try an exact match, but
2437 then move on to more and more lenient searches.  For example, the link
2438 @samp{[[*My Targets]]} will find any of the following:
2440 @example
2441 ** My targets
2442 ** TODO my targets are bright
2443 ** my 20 targets are
2444 @end example
2446 To insert a link targeting a headline, in-buffer completion can be used.
2447 Just type a star followed by a few optional letters into the buffer and
2448 press @kbd{M-@key{TAB}}.  All headlines in the current buffer will be
2449 offered as completions.  @xref{Handling links}, for more commands
2450 creating links.
2452 Following a link pushes a mark onto Org's own mark ring.  You can
2453 return to the previous position with @kbd{C-c &}.  Using this command
2454 several times in direct succession goes back to positions recorded
2455 earlier.
2457 @menu
2458 * Radio targets::               Make targets trigger links in plain text
2459 @end menu
2461 @node Radio targets,  , Internal links, Internal links
2462 @subsection Radio targets
2463 @cindex radio targets
2464 @cindex targets, radio
2465 @cindex links, radio targets
2467 Org can automatically turn any occurrences of certain target names
2468 in normal text into a link.  So without explicitly creating a link, the
2469 text connects to the target radioing its position.  Radio targets are
2470 enclosed by triple angular brackets.  For example, a target @samp{<<<My
2471 Target>>>} causes each occurrence of @samp{my target} in normal text to
2472 become activated as a link.  The Org file is scanned automatically
2473 for radio targets only when the file is first loaded into Emacs.  To
2474 update the target list during editing, press @kbd{C-c C-c} with the
2475 cursor on or at a target.
2477 @node External links, Handling links, Internal links, Hyperlinks
2478 @section External links
2479 @cindex links, external
2480 @cindex external links
2481 @cindex links, external
2482 @cindex Gnus links
2483 @cindex BBDB links
2484 @cindex IRC links
2485 @cindex URL links
2486 @cindex file links
2487 @cindex VM links
2488 @cindex RMAIL links
2489 @cindex WANDERLUST links
2490 @cindex MH-E links
2491 @cindex USENET links
2492 @cindex SHELL links
2493 @cindex Info links
2494 @cindex elisp links
2496 Org supports links to files, websites, Usenet and email messages,
2497 BBDB database entries and links to both IRC conversations and their
2498 logs.  External links are URL-like locators.  They start with a short
2499 identifying string followed by a colon.  There can be no space after
2500 the colon.  The following list shows examples for each link type.
2502 @example
2503 http://www.astro.uva.nl/~dominik          @r{on the web}
2504 file:/home/dominik/images/jupiter.jpg     @r{file, absolute path}
2505 /home/dominik/images/jupiter.jpg          @r{same as above}
2506 file:papers/last.pdf                      @r{file, relative path}
2507 ./papers/last.pdf                         @r{same as above}
2508 news:comp.emacs                           @r{Usenet link}
2509 mailto:adent@@galaxy.net                 @r{Mail link}
2510 vm:folder                                 @r{VM folder link}
2511 vm:folder#id                              @r{VM message link}
2512 vm://myself@@some.where.org/folder#id    @r{VM on remote machine}
2513 wl:folder                                 @r{WANDERLUST folder link}
2514 wl:folder#id                              @r{WANDERLUST message link}
2515 mhe:folder                                @r{MH-E folder link}
2516 mhe:folder#id                             @r{MH-E message link}
2517 rmail:folder                              @r{RMAIL folder link}
2518 rmail:folder#id                           @r{RMAIL message link}
2519 gnus:group                                @r{Gnus group link}
2520 gnus:group#id                             @r{Gnus article link}
2521 bbdb:Richard Stallman                     @r{BBDB link}
2522 irc:/irc.com/#emacs/bob                   @r{IRC link}
2523 shell:ls *.org                            @r{A shell command}
2524 elisp:(find-file-other-frame "Elisp.org") @r{An elisp form to evaluate}
2525 @end example
2527 A link should be enclosed in double brackets and may contain a
2528 descriptive text to be displayed instead of the URL (@pxref{Link
2529 format}), for example:
2531 @example
2532 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
2533 @end example
2535 @noindent
2536 If the description is a file name or URL that points to an image, HTML
2537 export (@pxref{HTML export}) will inline the image as a clickable
2538 button.  If there is no description at all and the link points to an
2539 image,
2540 that image will be inlined into the exported HTML file.
2542 @cindex angular brackets, around links
2543 @cindex plain text external links
2544 Org also finds external links in the normal text and activates them
2545 as links.  If spaces must be part of the link (for example in
2546 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
2547 about the end of the link, enclose them in angular brackets.
2549 @node Handling links, Using links outside Org, External links, Hyperlinks
2550 @section Handling links
2551 @cindex links, handling
2553 Org provides methods to create a link in the correct syntax, to
2554 insert it into an Org file, and to follow the link.
2556 @table @kbd
2557 @kindex C-c l
2558 @cindex storing links
2559 @item C-c l
2560 Store a link to the current location.  This is a @emph{global} command
2561 which can be used in any buffer to create a link.  The link will be
2562 stored for later insertion into an Org buffer (see below).  For
2563 Org files, if there is a @samp{<<target>>} at the cursor, the
2564 link points to the target.  Otherwise it points to the current
2565 headline.  For VM, Rmail, Wanderlust, MH-E, Gnus and BBDB buffers, the
2566 link will indicate the current article/entry.  For W3 and W3M buffers,
2567 the link goes to the current URL.  For IRC links, if you set the
2568 variable @code{org-irc-link-to-logs} to non-nil then @kbd{C-c l} will
2569 store a @samp{file:/} style link to the relevant point in the logs for
2570 the current conversation. Otherwise an @samp{irc:/} style link to the
2571 user/channel/server under the point will be stored.  For any other
2572 files, the link will point to the file, with a search string
2573 (@pxref{Search options}) pointing to the contents of the current line.
2574 If there is an active region, the selected words will form the basis
2575 of the search string.  If the automatically created link is not
2576 working correctly or accurately enough, you can write custom functions
2577 to select the search string and to do the search for particular file
2578 types - see @ref{Custom searches}.  The key binding @kbd{C-c l} is
2579 only a suggestion - see @ref{Installation}.
2581 @kindex C-c C-l
2582 @cindex link completion
2583 @cindex completion, of links
2584 @cindex inserting links
2585 @item C-c C-l
2586 Insert a link.  This prompts for a link to be inserted into the buffer.  You
2587 can just type a link, using text for an internal link, or one of the link
2588 type prefixes mentioned in the examples above.  All links stored during the
2589 current session are part of the history for this prompt, so you can access
2590 them with @key{up} and @key{down} (or @kbd{M-p/n}).  Completion, on the other
2591 hand, will help you to insert valid link prefixes like @samp{http:} or
2592 @samp{ftp:}, including the prefixes defined through link abbreviations
2593 (@pxref{Link abbreviations}).  The link will be inserted into the
2594 buffer@footnote{After insertion of a stored link, the link will be removed
2595 from the list of stored links.  To keep it in the list later use, use a
2596 triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
2597 @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
2598 If some text was selected when this command is called, the selected text
2599 becomes the default description.@* Note that you don't have to use this
2600 command to insert a link.  Links in Org are plain text, and you can type
2601 or paste them straight into the buffer.  By using this command, the links are
2602 automatically enclosed in double brackets, and you will be asked for the
2603 optional descriptive text.
2605 @c  If the link is a @samp{file:} link and
2606 @c the linked file is located in the same directory as the current file or
2607 @c a subdirectory of it, the path of the file will be inserted relative to
2608 @c the current directory.
2610 @kindex C-u C-c C-l
2611 @cindex file name completion
2612 @cindex completion, of file names
2613 @item C-u C-c C-l
2614 When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
2615 a file will be inserted and you may use file name completion to select
2616 the name of the file.  The path to the file is inserted relative to the
2617 directory of the current org file, if the linked file is in the current
2618 directory or in a sub-directory of it, or if the path is written relative
2619 to the current directory using @samp{../}.  Otherwise an absolute path
2620 is used, if possible with @samp{~/} for your home directory.  You can
2621 force an absolute path with two @kbd{C-u} prefixes.
2623 @item C-c C-l @r{(with cursor on existing link)}
2624 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
2625 link and description parts of the link.
2627 @cindex following links
2628 @kindex C-c C-o
2629 @item C-c C-o
2630 Open link at point.  This will launch a web browser for URLs (using
2631 @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
2632 the corresponding links, and execute the command in a shell link.  When the
2633 cursor is on an internal link, this commands runs the corresponding search.
2634 When the cursor is on a TAG list in a headline, it creates the corresponding
2635 TAGS view.  If the cursor is on a time stamp, it compiles the agenda for that
2636 date.  Furthermore, it will visit text and remote files in @samp{file:} links
2637 with Emacs and select a suitable application for local non-text files.
2638 Classification of files is based on file extension only.  See option
2639 @code{org-file-apps}.  If you want to override the default application and
2640 visit the file with Emacs, use a @kbd{C-u} prefix.  If you want to avoid
2641 opening in Emacs, use a @kbd{C-u C-u} prefix.
2643 @kindex mouse-2
2644 @kindex mouse-1
2645 @item mouse-2
2646 @itemx mouse-1
2647 On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
2648 would.  Under Emacs 22, also @kbd{mouse-1} will follow a link.
2650 @kindex mouse-3
2651 @item mouse-3
2652 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
2653 internal links to be displayed in another window@footnote{See the
2654 variable @code{org-display-internal-link-with-indirect-buffer}}.
2656 @cindex mark ring
2657 @kindex C-c %
2658 @item C-c %
2659 Push the current position onto the mark ring, to be able to return
2660 easily. Commands following an internal link do this automatically.
2662 @cindex links, returning to
2663 @kindex C-c &
2664 @item C-c &
2665 Jump back to a recorded position.  A position is recorded by the
2666 commands following internal links, and by @kbd{C-c %}.  Using this
2667 command several times in direct succession moves through a ring of
2668 previously recorded positions.
2670 @kindex C-c C-x C-n
2671 @kindex C-c C-x C-p
2672 @cindex links, finding next/previous
2673 @item C-c C-x C-n
2674 @itemx C-c C-x C-p
2675 Move forward/backward to the next link in the buffer.  At the limit of
2676 the buffer, the search fails once, and then wraps around.  The key
2677 bindings for this are really too long, you might want to bind this also
2678 to @kbd{C-n} and @kbd{C-p}
2679 @lisp
2680 (add-hook 'org-load-hook
2681   (lambda ()
2682     (define-key 'org-mode-map "\C-n" 'org-next-link)
2683     (define-key 'org-mode-map "\C-p" 'org-previous-link)))
2684 @end lisp
2685 @end table
2687 @node Using links outside Org, Link abbreviations, Handling links, Hyperlinks
2688 @section Using links outside Org
2690 You can insert and follow links that have Org syntax not only in
2691 Org, but in any Emacs buffer.  For this, you should create two
2692 global commands, like this (please select suitable global keys
2693 yourself):
2695 @lisp
2696 (global-set-key "\C-c L" 'org-insert-link-global)
2697 (global-set-key "\C-c o" 'org-open-at-point-global)
2698 @end lisp
2700 @node Link abbreviations, Search options, Using links outside Org, Hyperlinks
2701 @section Link abbreviations
2702 @cindex link abbreviations
2703 @cindex abbreviation, links
2705 Long URLs can be cumbersome to type, and often many similar links are
2706 needed in a document.  For this you can use link abbreviations.  An
2707 abbreviated link looks like this
2709 @example
2710 [[linkword:tag][description]]
2711 @end example
2713 @noindent
2714 where the tag is optional.  Such abbreviations are resolved according to
2715 the information in the variable @code{org-link-abbrev-alist} that
2716 relates the linkwords to replacement text.  Here is an example:
2718 @lisp
2719 @group
2720 (setq org-link-abbrev-alist
2721   '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
2722     ("google"   . "http://www.google.com/search?q=")
2723     ("ads"      . "http://adsabs.harvard.edu/cgi-bin/
2724                    nph-abs_connect?author=%s&db_key=AST")))
2725 @end group
2726 @end lisp
2728 If the replacement text contains the string @samp{%s}, it will be
2729 replaced with the tag.  Otherwise the tag will be appended to the string
2730 in order to create the link.  You may also specify a function that will
2731 be called with the tag as the only argument to create the link.
2733 With the above setting, you could link to a specific bug with
2734 @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
2735 @code{[[google:OrgMode]]} and find out what the Org author is
2736 doing besides Emacs hacking with @code{[[ads:Dominik,C]]}.
2738 If you need special abbreviations just for a single Org buffer, you
2739 can define them in the file with
2741 @example
2742 #+LINK: bugzilla  http://10.1.2.9/bugzilla/show_bug.cgi?id=
2743 #+LINK: google    http://www.google.com/search?q=%s
2744 @end example
2746 @noindent
2747 In-buffer completion @pxref{Completion} can be used after @samp{[} to
2748 complete link abbreviations.
2750 @node Search options, Custom searches, Link abbreviations, Hyperlinks
2751 @section Search options in file links
2752 @cindex search option in file links
2753 @cindex file links, searching
2755 File links can contain additional information to make Emacs jump to a
2756 particular location in the file when following a link.  This can be a
2757 line number or a search option after a double@footnote{For backward
2758 compatibility, line numbers can also follow a single colon.} colon. For
2759 example, when the command @kbd{C-c l} creates a link (@pxref{Handling
2760 links}) to a file, it encodes the words in the current line as a search
2761 string that can be used to find this line back later when following the
2762 link with @kbd{C-c C-o}.
2764 Here is the syntax of the different ways to attach a search to a file
2765 link, together with an explanation:
2767 @example
2768 [[file:~/code/main.c::255]]
2769 [[file:~/xx.org::My Target]]
2770 [[file:~/xx.org::*My Target]]
2771 [[file:~/xx.org::/regexp/]]
2772 @end example
2774 @table @code
2775 @item 255
2776 Jump to line 255.
2777 @item My Target
2778 Search for a link target @samp{<<My Target>>}, or do a text search for
2779 @samp{my target}, similar to the search in internal links, see
2780 @ref{Internal links}.  In HTML export (@pxref{HTML export}), such a file
2781 link will become an HTML reference to the corresponding named anchor in
2782 the linked file.
2783 @item *My Target
2784 In an Org file, restrict search to headlines.
2785 @item /regexp/
2786 Do a regular expression search for @code{regexp}.  This uses the Emacs
2787 command @code{occur} to list all matches in a separate window.  If the
2788 target file is in Org mode, @code{org-occur} is used to create a
2789 sparse tree with the matches.
2790 @c If the target file is a directory,
2791 @c @code{grep} will be used to search all files in the directory.
2792 @end table
2794 As a degenerate case, a file link with an empty file name can be used
2795 to search the current file.  For example, @code{[[file:::find me]]} does
2796 a search for @samp{find me} in the current file, just as
2797 @samp{[[find me]]} would.
2799 @node Custom searches,  , Search options, Hyperlinks
2800 @section Custom Searches
2801 @cindex custom search strings
2802 @cindex search strings, custom
2804 The default mechanism for creating search strings and for doing the
2805 actual search related to a file link may not work correctly in all
2806 cases.  For example, BibTeX database files have many entries like
2807 @samp{year="1993"} which would not result in good search strings,
2808 because the only unique identification for a BibTeX entry is the
2809 citation key.
2811 If you come across such a problem, you can write custom functions to set
2812 the right search string for a particular file type, and to do the search
2813 for the string in the file.  Using @code{add-hook}, these functions need
2814 to be added to the hook variables
2815 @code{org-create-file-search-functions} and
2816 @code{org-execute-file-search-functions}.  See the docstring for these
2817 variables for more information.  Org actually uses this mechanism
2818 for Bib@TeX{} database files, and you can use the corresponding code as
2819 an implementation example.  See the file @file{org-bibtex.el}.
2821 @node TODO Items, Tags, Hyperlinks, Top
2822 @chapter TODO Items
2823 @cindex TODO items
2825 Org mode does not maintain TODO lists as separate documents@footnote{Of
2826 course, you can make a document that contains inly long lists of TODO items,
2827 but this is not required.}.  Instead, TODO items are an integral part of the
2828 notes file, because TODO items usually come up while taking notes!  With Org
2829 mode, simply mark any entry in a tree as being a TODO item.  In this way,
2830 information is not duplicated, and the entire context from which the TODO
2831 item emerged is always present.
2833 Of course, this technique for managing TODO items scatters them
2834 throughout your notes file.  Org mode compensates for this by providing
2835 methods to give you an overview of all the things that you have to do.
2837 @menu
2838 * TODO basics::                 Marking and displaying TODO entries
2839 * TODO extensions::             Workflow and assignments
2840 * Progress logging::            Dates and notes for progress
2841 * Priorities::                  Some things are more important than others
2842 * Breaking down tasks::         Splitting a task into manageable pieces
2843 * Checkboxes::                  Tick-off lists
2844 @end menu
2846 @node TODO basics, TODO extensions, TODO Items, TODO Items
2847 @section Basic TODO functionality
2849 Any headline becomes a TODO item when it starts with the word
2850 @samp{TODO}, for example:
2852 @example
2853 *** TODO Write letter to Sam Fortune
2854 @end example
2856 @noindent
2857 The most important commands to work with TODO entries are:
2859 @table @kbd
2860 @kindex C-c C-t
2861 @cindex cycling, of TODO states
2862 @item C-c C-t
2863 Rotate the TODO state of the current item among
2865 @example
2866 ,-> (unmarked) -> TODO -> DONE --.
2867 '--------------------------------'
2868 @end example
2870 The same rotation can also be done ``remotely'' from the timeline and
2871 agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}).
2873 @kindex C-u C-c C-t
2874 @item C-u C-c C-t
2875 Select a specific keyword using completion or (if it has been set up)
2876 the fast selection interface.  For the latter, you need to assign keys
2877 to TODO states, see @ref{Per-file keywords} and @ref{Setting tags} for
2878 more information.
2880 @kindex S-@key{right}
2881 @kindex S-@key{left}
2882 @item S-@key{right}
2883 @itemx S-@key{left}
2884 Select the following/preceding TODO state, similar to cycling.  Useful
2885 mostly if more than two TODO states are possible (@pxref{TODO
2886 extensions}).
2887 @kindex C-c C-v
2888 @kindex C-c / t
2889 @cindex sparse tree, for TODO
2890 @item C-c C-v
2891 @itemx C-c / t
2892 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}).  Folds
2893 the entire buffer, but shows all TODO items and the headings hierarchy
2894 above them.  With a prefix argument, search for a specific TODO.  You will be
2895 prompted for the keyword, and you can also give a list of keywords like
2896 @code{KWD1|KWD2|...}.  With numeric prefix argument N, show the tree for the
2897 Nth keyword in the variable @code{org-todo-keywords}.  With two prefix
2898 arguments, find all TODO and DONE entries.
2899 @kindex C-c a t
2900 @item C-c a t
2901 Show the global TODO list.  Collects the TODO items from all agenda
2902 files (@pxref{Agenda Views}) into a single buffer.  The new buffer will
2903 be in @code{agenda-mode}, which provides commands to examine and
2904 manipulate the TODO entries from the new buffer (@pxref{Agenda
2905 commands}).  @xref{Global TODO list}, for more information.
2906 @kindex S-M-@key{RET}
2907 @item S-M-@key{RET}
2908 Insert a new TODO entry below the current one.
2909 @end table
2911 @noindent
2912 Changing a TODO state can also trigger tag changes.  See the docstring of the
2913 option @code{org-todo-state-tags-triggers} for details.
2915 @node TODO extensions, Progress logging, TODO basics, TODO Items
2916 @section Extended use of TODO keywords
2917 @cindex extended TODO keywords
2919 By default, marked TODO entries have one of only two states: TODO and
2920 DONE.  Org mode allows you to classify TODO items in more complex ways
2921 with @emph{TODO keywords} (stored in @code{org-todo-keywords}).  With
2922 special setup, the TODO keyword system can work differently in different
2923 files.
2925 Note that @i{tags} are another way to classify headlines in general and
2926 TODO items in particular (@pxref{Tags}).
2928 @menu
2929 * Workflow states::             From TODO to DONE in steps
2930 * TODO types::                  I do this, Fred does the rest
2931 * Multiple sets in one file::   Mixing it all, and still finding your way
2932 * Fast access to TODO states::  Single letter selection of a state
2933 * Per-file keywords::           Different files, different requirements
2934 * Faces for TODO keywords::     Highlighting states
2935 @end menu
2937 @node Workflow states, TODO types, TODO extensions, TODO extensions
2938 @subsection TODO keywords as workflow states
2939 @cindex TODO workflow
2940 @cindex workflow states as TODO keywords
2942 You can use TODO keywords to indicate different @emph{sequential} states
2943 in the process of working on an item, for example@footnote{Changing
2944 this variable only becomes effective after restarting Org mode in a
2945 buffer.}:
2947 @lisp
2948 (setq org-todo-keywords
2949   '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
2950 @end lisp
2952 The vertical bar separates the TODO keywords (states that @emph{need
2953 action}) from the DONE states (which need @emph{no further action}).  If
2954 you don't provide the separator bar, the last state is used as the DONE
2955 state.
2956 @cindex completion, of TODO keywords
2957 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
2958 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED.  You may
2959 also use a numeric prefix argument to quickly select a specific state.  For
2960 example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY.
2961 Or you can use @kbd{S-left} to go backward through the sequence.  If you
2962 define many keywords, you can use in-buffer completion
2963 (@pxref{Completion}) or even a special one-key selection scheme
2964 (@pxref{Fast access to TODO states}) to insert these words into the
2965 buffer.  Changing a TODO state can be logged with a timestamp, see
2966 @ref{Tracking TODO state changes} for more information.
2968 @node TODO types, Multiple sets in one file, Workflow states, TODO extensions
2969 @subsection TODO keywords as types
2970 @cindex TODO types
2971 @cindex names as TODO keywords
2972 @cindex types as TODO keywords
2974 The second possibility is to use TODO keywords to indicate different
2975 @emph{types} of action items.  For example, you might want to indicate
2976 that items are for ``work'' or ``home''.  Or, when you work with several
2977 people on a single project, you might want to assign action items
2978 directly to persons, by using their names as TODO keywords.  This would
2979 be set up like this:
2981 @lisp
2982 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
2983 @end lisp
2985 In this case, different keywords do not indicate a sequence, but rather
2986 different types.  So the normal work flow would be to assign a task to a
2987 person, and later to mark it DONE.  Org mode supports this style by adapting
2988 the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
2989 @kbd{t} command in the timeline and agenda buffers.}.  When used several
2990 times in succession, it will still cycle through all names, in order to first
2991 select the right type for a task.  But when you return to the item after some
2992 time and execute @kbd{C-c C-t} again, it will switch from any name directly
2993 to DONE.  Use prefix arguments or completion to quickly select a specific
2994 name.  You can also review the items of a specific TODO type in a sparse tree
2995 by using a numeric prefix to @kbd{C-c C-v}.  For example, to see all things
2996 Lucy has to do, you would use @kbd{C-3 C-c C-v}.  To collect Lucy's items
2997 from all agenda files into a single buffer, you would use the numeric prefix
2998 argument as well when creating the global TODO list: @kbd{C-3 C-c t}.
3000 @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions
3001 @subsection Multiple keyword sets in one file
3002 @cindex TODO keyword sets
3004 Sometimes you may want to use different sets of TODO keywords in
3005 parallel.  For example, you may want to have the basic
3006 @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
3007 separate state indicating that an item has been canceled (so it is not
3008 DONE, but also does not require action).  Your setup would then look
3009 like this:
3011 @lisp
3012 (setq org-todo-keywords
3013       '((sequence "TODO" "|" "DONE")
3014         (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
3015         (sequence "|" "CANCELED")))
3016 @end lisp
3018 The keywords should all be different, this helps Org mode to keep track
3019 of which subsequence should be used for a given entry.  In this setup,
3020 @kbd{C-c C-t} only operates within a subsequence, so it switches from
3021 @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
3022 (nothing) to @code{REPORT}.  Therefore you need a mechanism to initially
3023 select the correct sequence.  Besides the obvious ways like typing a
3024 keyword or using completion, you may also apply the following commands:
3026 @table @kbd
3027 @kindex C-S-@key{right}
3028 @kindex C-S-@key{left}
3029 @item C-S-@key{right}
3030 @itemx C-S-@key{left}
3031 These keys jump from one TODO subset to the next.  In the above example,
3032 @kbd{C-S-@key{right}} would jump from @code{TODO} or @code{DONE} to
3033 @code{REPORT}, and any of the words in the second row to @code{CANCELED}.
3034 @kindex S-@key{right}
3035 @kindex S-@key{left}
3036 @item S-@key{right}
3037 @itemx S-@key{left}
3038 @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through
3039 @emph{all} keywords from all sets, so for example @kbd{S-@key{<right>}}
3040 would switch from @code{DONE} to @code{REPORT} in the example above.
3041 @end table
3043 @node Fast access to TODO states, Per-file keywords, Multiple sets in one file, TODO extensions
3044 @subsection Fast access to TODO states
3046 If you would like to quickly change an entry to an arbitrary TODO state
3047 instead of cycling through the states, you can set up keys for
3048 single-letter access to the states.  This is done by adding the section
3049 key after each keyword, in parenthesis.  For example:
3051 @lisp
3052 (setq org-todo-keywords
3053       '((sequence "TODO(t)" "|" "DONE(d)")
3054         (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
3055         (sequence "|" "CANCELED(c)")))
3056 @end lisp
3058 If you then press @code{C-u C-c C-t} followed by the selection key, the
3059 entry will be switched to this state.  @key{SPC} can be used to remove
3060 any TODO keyword from an entry.  Should you like this way of selecting
3061 TODO states a lot, you might want to set the variable
3062 @code{org-use-fast-todo-selection} to @code{t} and make this behavior
3063 the default.  Check also the variable
3064 @code{org-fast-tag-selection-include-todo}, it allows to change the TODO
3065 state through the tags interface (@pxref{Setting tags}), in case you
3066 like to mingle the two concepts.
3068 @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions
3069 @subsection Setting up keywords for individual files
3070 @cindex keyword options
3071 @cindex per-file keywords
3073 It can be very useful to use different aspects of the TODO mechanism in
3074 different files.  For file-local settings, you need to add special lines
3075 to the file which set the keywords and interpretation for that file
3076 only.  For example, to set one of the two examples discussed above, you
3077 need one of the following lines, starting in column zero anywhere in the
3078 file:
3080 @example
3081 #+SEQ_TODO: TODO FEEDBACK VERIFY | DONE CANCELED
3082 @end example
3084 @example
3085 #+TYP_TODO: Fred Sara Lucy Mike | DONE
3086 @end example
3088 A setup for using several sets in parallel would be:
3090 @example
3091 #+SEQ_TODO: TODO | DONE
3092 #+SEQ_TODO: REPORT BUG KNOWNCAUSE | FIXED
3093 #+SEQ_TODO: | CANCELED
3094 @end example
3096 @cindex completion, of option keywords
3097 @kindex M-@key{TAB}
3098 @noindent To make sure you are using the correct keyword, type
3099 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
3101 @cindex DONE, final TODO keyword
3102 Remember that the keywords after the vertical bar (or the last keyword
3103 if no bar is there) must always mean that the item is DONE (although you
3104 may use a different word).  After changing one of these lines, use
3105 @kbd{C-c C-c} with the cursor still in the line to make the changes
3106 known to Org mode@footnote{Org mode parses these lines only when
3107 Org mode is activated after visiting a file.  @kbd{C-c C-c} with the
3108 cursor in a line starting with @samp{#+} is simply restarting Org mode
3109 for the current buffer.}.
3111 @node Faces for TODO keywords,  , Per-file keywords, TODO extensions
3112 @subsection Faces for TODO keywords
3113 @cindex faces, for TODO keywords
3115 Org mode highlights TODO keywords with special faces: @code{org-todo}
3116 for keywords indicating that an item still has to be acted upon, and
3117 @code{org-done} for keywords indicating that an item is finished.  If
3118 you are using more than 2 different states, you might want to use
3119 special faces for some of them.  This can be done using the variable
3120 @code{org-todo-keyword-faces}.  For example:
3122 @lisp
3123 (setq org-todo-keyword-faces
3124       '(("TODO"      . org-warning)
3125         ("DEFERRED"  . shadow)
3126         ("CANCELED"  . (:foreground "blue" :weight bold))))
3127 @end lisp
3129 While using a list with face properties as shown for CANCELED
3130 @emph{should} work, this does not aways seem to be the case.  If
3131 necessary, define a special face and use that.
3133 @page
3134 @node Progress logging, Priorities, TODO extensions, TODO Items
3135 @section Progress logging
3136 @cindex progress logging
3137 @cindex logging, of progress
3139 Org mode can automatically record a time stamp and possibly a note when
3140 you mark a TODO item as DONE, or even each time you change the state of
3141 a TODO item.  This system is highly configurable, settings can be on a
3142 per-keyword basis and can be localized to a file or even a subtree.  For
3143 information on how to clock working time for a task, see @ref{Clocking
3144 work time}.
3146 @menu
3147 * Closing items::               When was this entry marked DONE?
3148 * Tracking TODO state changes::  When did the status change?
3149 @end menu
3151 @node Closing items, Tracking TODO state changes, Progress logging, Progress logging
3152 @subsection Closing items
3154 The most basic logging is to keep track of @emph{when} a certain TODO
3155 item was finished.  This is achieved with@footnote{The corresponding
3156 in-buffer setting is: @code{#+STARTUP: logdone}}.
3158 @lisp
3159 (setq org-log-done 'time)
3160 @end lisp
3162 @noindent
3163 Then each time you turn an entry from a TODO (not-done) state into any
3164 of the DONE states, a line @samp{CLOSED: [timestamp]} will be inserted
3165 just after the headline.  If you turn the entry back into a TODO item
3166 through further state cycling, that line will be removed again.  If you
3167 want to record a note along with the timestamp, use@footnote{The
3168 corresponding in-buffer setting is: @code{#+STARTUP: lognotedone}}
3170 @lisp
3171 (setq org-log-done 'note)
3172 @end lisp
3174 @noindent
3175 You will then be prompted for a note, and that note will be stored below
3176 the entry with a @samp{Closing Note} heading.
3178 In the timeline (@pxref{Timeline}) and in the agenda
3179 (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
3180 display the TODO items with a @samp{CLOSED} timestamp on each day,
3181 giving you an overview of what has been done.
3183 @node Tracking TODO state changes,  , Closing items, Progress logging
3184 @subsection Tracking TODO state changes
3186 When TODO keywords are used as workflow states (@pxref{Workflow
3187 states}), you might want to keep track of when a state change occurred
3188 and maybe take a note about this change.  Since it is normally too much
3189 to record a note for every state, Org mode expects configuration on a
3190 per-keyword basis for this.  This is achieved by adding special markers
3191 @samp{!} (for a time stamp) and @samp{@@} (for a note) in parenthesis
3192 after each keyword.  For example, with the setting
3194 @lisp
3195 (setq org-todo-keywords
3196   '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
3197 @end lisp
3199 @noindent
3200 you not only define global TODO keywords and fast access keys, but also
3201 request that a time is recorded when the entry is turned into
3202 DONE@footnote{It is possible that Org mode will record two time stamps
3203 when you are using both @code{org-log-done} and state change logging.
3204 However, it will never prompt for two notes - if you have configured
3205 both, the state change recording note will take precedence and cancel
3206 the @samp{Closing Note}.}, and that a note is recorded when switching to
3207 WAIT or CANCELED.  The setting for WAIT is even more special: The
3208 @samp{!} after the slash means that in addition to the note taken when
3209 entering the state, a time stamp should be recorded when @i{leaving} the
3210 WAIT state, if and only if the @i{target} state does not configure
3211 logging for entering it.  So it has no effect when switching from WAIT
3212 to DONE, because DONE is configured to record a timestamp only.  But
3213 when switching from WAIT back to TODO, the @samp{/!} in the WAIT
3214 setting now triggers a timestamp even though TODO has no logging
3215 configured.
3217 You can use the exact same syntax for setting logging preferences local
3218 to a buffer:
3219 @example
3220 #+SEQ_TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
3221 @end example
3223 In order to define logging settings that are local to a subtree or a
3224 single item, define a LOGGING property in this entry.  Any non-empty
3225 LOGGING property resets all logging settings to nil.  You may then turn
3226 on logging for this specific tree using STARTUP keywords like
3227 @code{lognotedone} or @code{logrepeat}, as well as adding state specific
3228 settings like @code{TODO(!)}.  For example
3230 @example
3231 * TODO Log each state with only a time
3232   :PROPERTIES:
3233   :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
3234   :END:
3235 * TODO Only log when switching to WAIT, and when repeating
3236   :PROPERTIES:
3237   :LOGGING: WAIT(@@) logrepeat
3238   :END:
3239 * TODO No logging at all
3240   :PROPERTIES:
3241   :LOGGING: nil
3242   :END:
3243 @end example
3245 @node Priorities, Breaking down tasks, Progress logging, TODO Items
3246 @section Priorities
3247 @cindex priorities
3249 If you use Org mode extensively, you may end up enough TODO items that
3250 it starts to make sense to prioritize them.  Prioritizing can be done by
3251 placing a @emph{priority cookie} into the headline of a TODO item, like
3252 this
3254 @example
3255 *** TODO [#A] Write letter to Sam Fortune
3256 @end example
3258 @noindent
3259 By default, Org mode supports three priorities: @samp{A}, @samp{B}, and
3260 @samp{C}.  @samp{A} is the highest priority.  An entry without a cookie
3261 is treated as priority @samp{B}.  Priorities make a difference only in
3262 the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they have
3263 no inherent meaning to Org mode.
3265 Priorities can be attached to any outline tree entries; they do not need
3266 to be TODO items.
3268 @table @kbd
3269 @kindex @kbd{C-c ,}
3270 @item @kbd{C-c ,}
3271 Set the priority of the current headline.  The command prompts for a
3272 priority character @samp{A}, @samp{B} or @samp{C}.  When you press
3273 @key{SPC} instead, the priority cookie is removed from the headline.
3274 The priorities can also be changed ``remotely'' from the timeline and
3275 agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
3277 @kindex S-@key{up}
3278 @kindex S-@key{down}
3279 @item S-@key{up}
3280 @itemx S-@key{down}
3281 Increase/decrease priority of current headline@footnote{See also the
3282 option @code{org-priority-start-cycle-with-default'}.}.  Note that these
3283 keys are also used to modify time stamps (@pxref{Creating timestamps}).
3284 Furthermore, these keys are also used by CUA mode (@pxref{Conflicts}).
3285 @end table
3287 You can change the range of allowed priorities by setting the variables
3288 @code{org-highest-priority}, @code{org-lowest-priority}, and
3289 @code{org-default-priority}.  For an individual buffer, you may set
3290 these values (highest, lowest, default) like this (please make sure that
3291 the highest priority is earlier in the alphabet than the lowest
3292 priority):
3294 @example
3295 #+PRIORITIES: A C B
3296 @end example
3298 @node Breaking down tasks, Checkboxes, Priorities, TODO Items
3299 @section Breaking tasks down into subtasks
3300 @cindex tasks, breaking down
3302 It is often advisable to break down large tasks into smaller, manageable
3303 subtasks.  You can do this by creating an outline tree below a TODO item,
3304 with detailed subtasks on the tree@footnote{To keep subtasks out of the
3305 global TODO list, see the @code{org-agenda-todo-list-sublevels}.}.  To keep
3306 the overview over the fraction of subtasks that are already completed, insert
3307 either @samp{[/]} or @samp{[%]} anywhere in the headline.  These cookies will
3308 be updates each time the todo status of a child changes.  For example:
3310 @example
3311 * Organize Party [33%]
3312 ** TODO Call people [1/2]
3313 *** TODO Peter
3314 *** DONE Sarah
3315 ** TODO Buy food
3316 ** DONE Talk to neighbor
3317 @end example
3319 If you would like a TODO entry to automatically change to DONE when all
3320 chilrden are done, you can use the following setup:
3322 @example
3323 (defun org-summary-todo (n-done n-not-done)
3324   "Switch entry to DONE when all subentries are done, to TODO otherwise."
3325   (let (org-log-done org-log-states)   ; turn off logging
3326     (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
3328 (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
3329 @end example
3332 Another possibility is the use of checkboxes to identify (a hierarchy of) a
3333 large number of subtasks (@pxref{Checkboxes}).
3336 @node Checkboxes,  , Breaking down tasks, TODO Items
3337 @section Checkboxes
3338 @cindex checkboxes
3340 Every item in a plain list (@pxref{Plain lists}) can be made into a
3341 checkbox by starting it with the string @samp{[ ]}.  This feature is
3342 similar to TODO items (@pxref{TODO Items}), but is more lightweight.
3343 Checkboxes are not included into the global TODO list, so they are often
3344 great to split a task into a number of simple steps.  Or you can use
3345 them in a shopping list.  To toggle a checkbox, use @kbd{C-c C-c}, or
3346 use the mouse (thanks to Piotr Zielinski's @file{org-mouse.el}).
3348 Here is an example of a checkbox list.
3350 @example
3351 * TODO Organize party [2/4]
3352   - [-] call people [1/3]
3353     - [ ] Peter
3354     - [X] Sarah
3355     - [ ] Sam
3356   - [X] order food
3357   - [ ] think about what music to play
3358   - [X] talk to the neighbors
3359 @end example
3361 Checkboxes work hierarchically, so if a checkbox item has children that
3362 are checkboxes, toggling one of the children checkboxes will make the
3363 parent checkbox reflect if none, some, or all of the children are
3364 checked.
3366 @cindex statistics, for checkboxes
3367 @cindex checkbox statistics
3368 The @samp{[2/4]} and @samp{[1/3]} in the first and second line are
3369 cookies indicating how many checkboxes present in this entry have been
3370 checked off, and the total number of checkboxes are present.  This can
3371 give you an idea on how many checkboxes remain, even without opening a
3372 folded entry.  The cookies can be placed into a headline or into (the
3373 first line of) a plain list item. Each cookie covers all checkboxes
3374 structurally below the headline/item on which the cookie appear.  You
3375 have to insert the cookie yourself by typing either @samp{[/]} or
3376 @samp{[%]}.  With @samp{[/]} you get an @samp{n out of m} result, as in
3377 the examples above.  With @samp{[%]} you get information about the
3378 percentage of checkboxes checked (in the above example, this would be
3379 @samp{[50%]} and @samp{[33%]}, respectively).
3381 @noindent The following commands work with checkboxes:
3383 @table @kbd
3384 @kindex C-c C-c
3385 @item C-c C-c
3386 Toggle checkbox at point.  With a prefix argument, set it to @samp{[-]},
3387 which is considered to be an intermediate state.
3388 @kindex C-c C-x C-b
3389 @item C-c C-x C-b
3390 Toggle checkbox at point.
3391 @itemize @minus
3392 @item
3393 If there is an active region, toggle the first checkbox in the region
3394 and set all remaining boxes to the same status as the first.  If you
3395 want to toggle all boxes in the region independently, use a prefix
3396 argument.
3397 @item
3398 If the cursor is in a headline, toggle checkboxes in the region between
3399 this headline and the next (so @emph{not} the entire subtree).
3400 @item
3401 If there is no active region, just toggle the checkbox at point.
3402 @end itemize
3403 @kindex M-S-@key{RET}
3404 @item M-S-@key{RET}
3405 Insert a new item with a checkbox.
3406 This works only if the cursor is already in a plain list item
3407 (@pxref{Plain lists}).
3408 @kindex C-c #
3409 @item C-c #
3410 Update the checkbox statistics in the current outline entry.  When
3411 called with a @kbd{C-u} prefix, update the entire file.  Checkbox
3412 statistic cookies are updated automatically if you toggle checkboxes
3413 with @kbd{C-c C-c} and make new ones with @kbd{M-S-@key{RET}}.  If you
3414 delete boxes or add/change them by hand, use this command to get things
3415 back into synch.  Or simply toggle any checkbox twice with @kbd{C-c C-c}.
3416 @end table
3418 @node Tags, Properties and Columns, TODO Items, Top
3419 @chapter Tags
3420 @cindex tags
3421 @cindex headline tagging
3422 @cindex matching, tags
3423 @cindex sparse tree, tag based
3425 An excellent way to implement labels and contexts for cross-correlating
3426 information is to assign @i{tags} to headlines.  Org mode has extensive
3427 support for tags.
3429 Every headline can contain a list of tags; they occur at the end of the
3430 headline.  Tags are normal words containing letters, numbers, @samp{_},
3431 and @samp{@@}.  Tags must be preceded and followed by a single colon,
3432 e.g., @samp{:work:}.  Several tags can be specified, as in
3433 @samp{:work:urgent:}.
3435 @menu
3436 * Tag inheritance::             Tags use the tree structure of the outline
3437 * Setting tags::                How to assign tags to a headline
3438 * Tag searches::                Searching for combinations of tags
3439 @end menu
3441 @node Tag inheritance, Setting tags, Tags, Tags
3442 @section Tag inheritance
3443 @cindex tag inheritance
3444 @cindex inheritance, of tags
3445 @cindex sublevels, inclusion into tags match
3447 @i{Tags} make use of the hierarchical structure of outline trees.  If a
3448 heading has a certain tag, all subheadings will inherit the tag as
3449 well.  For example, in the list
3451 @example
3452 * Meeting with the French group      :work:
3453 ** Summary by Frank                  :boss:notes:
3454 *** TODO Prepare slides for him      :action:
3455 @end example
3457 @noindent
3458 the final heading will have the tags @samp{:work:}, @samp{:boss:},
3459 @samp{:notes:}, and @samp{:action:} even though the final heading is not
3460 explicitly marked with those tags.  You can also set tags that all entries in
3461 a file should inherit as if these tags would be defined in a hypothetical
3462 level zero that surounds the entire file.
3464 @example
3465 #+FILETAGS: :Peter:Boss:Secret:
3466 @end example
3468 @noindent
3469 To limit tag inheritance to specific tags, or to turn it off entirely, use
3470 the variable @code{org-use-tag-inheritance}.
3472 When a headline matches during a tags search while tag inheritance is turned
3473 on, all the sublevels in the same tree will match as well@footnote{This is
3474 only true if the the search does not involve more complex tests including
3475 properties (@pxref{Property searches}).}.  The list of matches may then
3476 become very long.  If you only want to see the first tags match in a subtree,
3477 configure the variable @code{org-tags-match-list-sublevels}.
3479 @node Setting tags, Tag searches, Tag inheritance, Tags
3480 @section Setting tags
3481 @cindex setting tags
3482 @cindex tags, setting
3484 @kindex M-@key{TAB}
3485 Tags can simply be typed into the buffer at the end of a headline.
3486 After a colon, @kbd{M-@key{TAB}} offers completion on tags.  There is
3487 also a special command for inserting tags:
3489 @table @kbd
3490 @kindex C-c C-q
3491 @item C-c C-q
3492 @cindex completion, of tags
3493 Enter new tags for the current headline.  Org mode will either offer
3494 completion or a special single-key interface for setting tags, see
3495 below.  After pressing @key{RET}, the tags will be inserted and aligned
3496 to @code{org-tags-column}.  When called with a @kbd{C-u} prefix, all
3497 tags in the current buffer will be aligned to that column, just to make
3498 things look nice.  TAGS are automatically realigned after promotion,
3499 demotion, and TODO state changes (@pxref{TODO basics}).
3500 @kindex C-c C-c
3501 @item C-c C-c
3502 When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
3503 @end table
3505 Org will support tag insertion based on a @emph{list of tags}.  By
3506 default this list is constructed dynamically, containing all tags
3507 currently used in the buffer.  You may also globally specify a hard list
3508 of tags with the variable @code{org-tag-alist}.  Finally you can set
3509 the default tags for a given file with lines like
3511 @example
3512 #+TAGS: @@work @@home @@tennisclub
3513 #+TAGS: laptop car pc sailboat
3514 @end example
3516 If you have globally defined your preferred set of tags using the
3517 variable @code{org-tag-alist}, but would like to use a dynamic tag list
3518 in a specific file, add an empty TAGS option line to that file:
3520 @example
3521 #+TAGS:
3522 @end example
3524 By default Org mode uses the standard minibuffer completion facilities for
3525 entering tags.  However, it also implements another, quicker, tag selection
3526 method called @emph{fast tag selection}.  This allows you to select and
3527 deselect tags with just a single key press.  For this to work well you should
3528 assign unique letters to most of your commonly used tags.  You can do this
3529 globally by configuring the variable @code{org-tag-alist} in your
3530 @file{.emacs} file.  For example, you may find the need to tag many items in
3531 different files with @samp{:@@home:}.  In this case you can set something
3532 like:
3534 @lisp
3535 (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
3536 @end lisp
3538 @noindent If the tag is only relevant to the file you are working on then you
3539 can, instead, set the TAGS option line as:
3541 @example
3542 #+TAGS: @@work(w)  @@home(h)  @@tennisclub(t)  laptop(l)  pc(p)
3543 @end example
3545 @noindent
3546 You can also group together tags that are mutually exclusive.  By using
3547 braces, as in:
3549 @example
3550 #+TAGS: @{ @@work(w)  @@home(h)  @@tennisclub(t) @}  laptop(l)  pc(p)
3551 @end example
3553 @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
3554 and @samp{@@tennisclub} should be selected.  Multiple such groups are allowed.
3556 @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
3557 these lines to activate any changes.
3559 @noindent
3560 To set these mutually exclusive groups in the variable @code{org-mode-alist}
3561 you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
3562 of the braces.  The previous example would be set globally by the following
3563 configuration:
3565 @lisp
3566 (setq org-tag-alist '((:startgroup . nil)
3567                       ("@@work" . ?w) ("@@home" . ?h)
3568                       ("@@tennisclub" . ?t)
3569                       (:endgroup . nil)
3570                       ("laptop" . ?l) ("pc" . ?p)))
3571 @end lisp
3573 If at least one tag has a selection key then pressing @kbd{C-c C-c} will
3574 automatically present you with a special interface, listing inherited tags,
3575 the tags of the current headline, and a list of all valid tags with
3576 corresponding keys@footnote{Keys will automatically be assigned to tags which
3577 have no configured keys.}.  In this interface, you can use the following
3578 keys:
3580 @table @kbd
3581 @item a-z...
3582 Pressing keys assigned to tags will add or remove them from the list of
3583 tags in the current line.  Selecting a tag in a group of mutually
3584 exclusive tags will turn off any other tags from that group.
3585 @kindex @key{TAB}
3586 @item @key{TAB}
3587 Enter a tag in the minibuffer, even if the tag is not in the predefined
3588 list.  You will be able to complete on all tags present in the buffer.
3589 @kindex @key{SPC}
3590 @item @key{SPC}
3591 Clear all tags for this line.
3592 @kindex @key{RET}
3593 @item @key{RET}
3594 Accept the modified set.
3595 @item C-g
3596 Abort without installing changes.
3597 @item q
3598 If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
3599 @item !
3600 Turn off groups of mutually exclusive tags.  Use this to (as an
3601 exception) assign several tags from such a group.
3602 @item C-c
3603 Toggle auto-exit after the next change (see below).
3604 If you are using expert mode, the first @kbd{C-c} will display the
3605 selection window.
3606 @end table
3608 @noindent
3609 This method lets you assign tags to a headline with very few keys.  With
3610 the above setup, you could clear the current tags and set @samp{@@home},
3611 @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
3612 C-c @key{SPC} h l p @key{RET}}.  Switching from @samp{@@home} to
3613 @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
3614 alternatively with @kbd{C-c C-c C-c w}.  Adding the non-predefined tag
3615 @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
3616 @key{RET} @key{RET}}.
3618 If you find that most of the time, you need only a single key press to
3619 modify your list of tags, set the variable
3620 @code{org-fast-tag-selection-single-key}.  Then you no longer have to
3621 press @key{RET} to exit fast tag selection - it will immediately exit
3622 after the first change.  If you then occasionally need more keys, press
3623 @kbd{C-c} to turn off auto-exit for the current tag selection process
3624 (in effect: start selection with @kbd{C-c C-c C-c} instead of @kbd{C-c
3625 C-c}).  If you set the variable to the value @code{expert}, the special
3626 window is not even shown for single-key tag selection, it comes up only
3627 when you press an extra @kbd{C-c}.
3629 @node Tag searches,  , Setting tags, Tags
3630 @section Tag searches
3631 @cindex tag searches
3632 @cindex searching for tags
3634 Once a system of tags has been set up, it can be used to collect related
3635 information into special lists.
3637 @table @kbd
3638 @kindex C-c \
3639 @kindex C-c / T
3640 @item C-c \
3641 @itemx C-c / T
3642 Create a sparse tree with all headlines matching a tags search.  With a
3643 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
3644 @kindex C-c a m
3645 @item C-c a m
3646 Create a global list of tag matches from all agenda files.
3647 @xref{Matching tags and properties}.
3648 @kindex C-c a M
3649 @item C-c a M
3650 Create a global list of tag matches from all agenda files, but check
3651 only TODO items and force checking subitems (see variable
3652 @code{org-tags-match-list-sublevels}).
3653 @end table
3655 @cindex Boolean logic, for tag searches
3656 A @i{tags} search string can use Boolean operators @samp{&} for AND and
3657 @samp{|} for OR.  @samp{&} binds more strongly than @samp{|}.
3658 Parenthesis are currently not implemented.  A tag may also be preceded
3659 by @samp{-}, to select against it, and @samp{+} is syntactic sugar for
3660 positive selection.  The AND operator @samp{&} is optional when @samp{+}
3661 or @samp{-} is present.  Examples:
3663 @table @samp
3664 @item +work-boss
3665 Select headlines tagged @samp{:work:}, but discard those also tagged
3666 @samp{:boss:}.
3667 @item work|laptop
3668 Selects lines tagged @samp{:work:} or @samp{:laptop:}.
3669 @item work|laptop&night
3670 Like before, but require the @samp{:laptop:} lines to be tagged also
3671 @samp{:night:}.
3672 @end table
3674 @cindex TODO keyword matching, with tags search
3675 You may also test for TODO keywords (@pxref{TODO extensions}) and properties
3676 (@pxref{Properties and Columns}) at the same time as matching tags.  For a
3677 guide on how to match properties, see @ref{Property searches}.  To match a
3678 specific TODO keyword, include an expression like @samp{+TODO="NEXT"} as one
3679 of the terms in a tags search.
3681 There is also the possibility to end the tags part of the match (which may
3682 include several terms connected with @samp{|}) with a @samp{/} and then
3683 specify a Boolean expression just for TODO keywords.  The syntax is then
3684 similar to the tag matches, but should be applied with consideration: For
3685 example, a positive selection on several TODO keywords can not meaningfully
3686 be combined with boolean AND.  However, @emph{negative selection} combined
3687 with AND can be meaningful.  To make sure that only lines are checked that
3688 actually have any TODO keyword (resulting in a speed-up), use @kbd{C-c a M},
3689 or equivalently start the TODO part after the slash with @samp{!}.  Examples:
3691 @table @samp
3692 @item work+TODO="WAITING"
3693 Select @samp{:work:}-tagged TODO lines with the specific TODO
3694 keyword @samp{WAITING}.
3695 @item work+TODO="WAITING"|home+TODO="WAITING"
3696 Waiting tasks both at work and at home.
3697 @item work/WAITING
3698 Same as the first example.
3699 @item work/!-WAITING-NEXT
3700 Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
3701 nor @samp{NEXT}
3702 @item work/!+WAITING|+NEXT
3703 Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
3704 @samp{NEXT}.
3705 @end table
3707 @cindex regular expressions, with tags search
3708 Any element of the tag/todo match can be a regular expression - in this
3709 case it must be enclosed in curly braces.  For example,
3710 @samp{work+@{^boss.*@}} matches headlines that contain the tag
3711 @samp{:work:} and any tag @i{starting} with @samp{boss}.  You may also use a
3712 regular expression in @samp{TODO=@{^W@}} which would match TODO keywords
3713 starting with the letter @samp{W}.
3715 @cindex level, require for tags/property match
3716 @cindex category, require for tags/property match
3717 You can also require a headline to be of a certain level or category, by
3718 writing instead of any TAG an expression like @samp{LEVEL=3} or
3719 @samp{CATEGORY="work"}, respectively.  For example, a search
3720 @samp{+LEVEL=3+boss/-DONE} lists all level three headlines that have the
3721 tag @samp{boss} and are @emph{not} marked with the TODO keyword DONE.
3723 Accessing TODO, LEVEL, and CATEGORY during a search is fast.  Accessing any
3724 other properties will slow down the search.
3726 @node Properties and Columns, Dates and Times, Tags, Top
3727 @chapter Properties and Columns
3728 @cindex properties
3730 Properties are a set of key-value pairs associated with an entry.  There
3731 are two main applications for properties in Org mode.  First, properties
3732 are like tags, but with a value.  Second, you can use properties to
3733 implement (very basic) database capabilities in an Org buffer.  For
3734 an example of the first application, imagine maintaining a file where
3735 you document bugs and plan releases of a piece of software.  Instead of
3736 using tags like @code{:release_1:}, @code{:release_2:}, one can use a
3737 property, say @code{:Release:}, that in different subtrees has different
3738 values, such as @code{1.0} or @code{2.0}.  For an example of the second
3739 application of properties, imagine keeping track of your music CD's,
3740 where properties could be things such as the album artist, date of
3741 release, number of tracks, and so on.
3743 Properties can be conveniently edited and viewed in column view
3744 (@pxref{Column view}).
3746 @menu
3747 * Property syntax::             How properties are spelled out
3748 * Special properties::          Access to other Org mode features
3749 * Property searches::           Matching property values
3750 * Property inheritance::        Passing values down the tree
3751 * Column view::                 Tabular viewing and editing
3752 * Property API::                Properties for Lisp programmers
3753 @end menu
3755 @node Property syntax, Special properties, Properties and Columns, Properties and Columns
3756 @section Property syntax
3757 @cindex property syntax
3758 @cindex drawer, for properties
3760 Properties are key-value pairs.  They need to be inserted into a special
3761 drawer (@pxref{Drawers}) with the name @code{PROPERTIES}.  Each property
3762 is specified on a single line, with the key (surrounded by colons)
3763 first, and the value after it.  Here is an example:
3765 @example
3766 * CD collection
3767 ** Classic
3768 *** Goldberg Variations
3769     :PROPERTIES:
3770     :Title:     Goldberg Variations
3771     :Composer:  J.S. Bach
3772     :Artist:    Glen Gould
3773     :Publisher: Deutsche Grammphon
3774     :NDisks:    1
3775     :END:
3776 @end example
3778 You may define the allowed values for a particular property @samp{:Xyz:}
3779 by setting a property @samp{:Xyz_ALL:}.  This special property is
3780 @emph{inherited}, so if you set it in a level 1 entry, it will apply to
3781 the entire tree.  When allowed values are defined, setting the
3782 corresponding property becomes easier and is less prone to typing
3783 errors.  For the example with the CD collection, we can predefine
3784 publishers and the number of disks in a box like this:
3786 @example
3787 * CD collection
3788   :PROPERTIES:
3789   :NDisks_ALL:  1 2 3 4
3790   :Publisher_ALL: "Deutsche Grammophon" Phillips EMI
3791   :END:
3792 @end example
3794 If you want to set properties that can be inherited by any entry in a
3795 file, use a line like
3797 @example
3798 #+PROPERTY: NDisks_ALL 1 2 3 4
3799 @end example
3801 Property values set with the global variable
3802 @code{org-global-properties} can be inherited by all entries in all
3803 Org files.
3805 @noindent
3806 The following commands help to work with properties:
3808 @table @kbd
3809 @kindex M-@key{TAB}
3810 @item M-@key{TAB}
3811 After an initial colon in a line, complete property keys.  All keys used
3812 in the current file will be offered as possible completions.
3813 @kindex C-c C-x p
3814 @item C-c C-x p
3815 Set a property.  This prompts for a property name and a value.  If
3816 necessary, the property drawer is created as well.
3817 @item M-x org-insert-property-drawer
3818 Insert a property drawer into the current entry.  The drawer will be
3819 inserted early in the entry, but after the lines with planning
3820 information like deadlines.
3821 @kindex C-c C-c
3822 @item C-c C-c
3823 With the cursor in a property drawer, this executes property commands.
3824 @item C-c C-c s
3825 Set a property in the current entry.  Both the property and the value
3826 can be inserted using completion.
3827 @kindex S-@key{right}
3828 @kindex S-@key{left}
3829 @item S-@key{left}/@key{right}
3830 Switch property at point to the next/previous allowed value.
3831 @item C-c C-c d
3832 Remove a property from the current entry.
3833 @item C-c C-c D
3834 Globally remove a property, from all entries in the current file.
3835 @item C-c C-c c
3836 Compute the property at point, using the operator and scope from the
3837 nearest column format definition.
3838 @end table
3840 @node Special properties, Property searches, Property syntax, Properties and Columns
3841 @section Special properties
3842 @cindex properties, special
3844 Special properties provide alternative access method to Org mode
3845 features discussed in the previous chapters, like the TODO state or the
3846 priority of an entry.  This interface exists so that you can include
3847 these states into columns view (@pxref{Column view}), or to use them in
3848 queries.  The following property names are special and should not be
3849 used as keys in the properties drawer:
3851 @example
3852 TODO         @r{The TODO keyword of the entry.}
3853 TAGS         @r{The tags defined directly in the headline.}
3854 ALLTAGS      @r{All tags, including inherited ones.}
3855 PRIORITY     @r{The priority of the entry, a string with a single letter.}
3856 DEADLINE     @r{The deadline time string, without the angular brackets.}
3857 SCHEDULED    @r{The scheduling time stamp, without the angular brackets.}
3858 TIMESTAMP    @r{The first keyword-less time stamp in the entry.}
3859 TIMESTAMP_IA @r{The first inactive time stamp in the entry.}
3860 CLOCKSUM     @r{The sum of CLOCK intervals in the subtree.  @code{org-clock-sum}}
3861              @r{must be run first to compute the values.}
3862 @end example
3864 @node Property searches, Property inheritance, Special properties, Properties and Columns
3865 @section Property searches
3866 @cindex properties, searching
3867 @cindex searching, of properties
3869 To create sparse trees and special lists with selection based on properties,
3870 the same commands are used as for tag searches (@pxref{Tag searches}), and
3871 the same logic applies.  For example, here is a search string:
3873 @example
3874 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2         \
3875          +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
3876 @end example
3878 @noindent
3879 The type of comparison will depend on how the comparison value is written:
3880 @itemize @minus
3881 @item
3882 If the comparison value is a plain number, a numerical comparison is done,
3883 and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
3884 @samp{>=}, and @samp{<>}.
3885 @item
3886 If the comparison value is enclosed in double
3887 quotes, a string comparison is done, and the same operators are allowed.  
3888 @item
3889 If the comparison value is enclosed in double quotes @emph{and} angular
3890 brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
3891 assumed to be date/time specifications in the standard Org way@footnote{The
3892 only special values that will be recognized are @samp{"<now>"} for now, and
3893 @samp{"<today>"} today at 0:00 hours, i.e. without a time specification.}, and
3894 the comparison will be done accordingly.
3895 @item
3896 If the comparison value is enclosed
3897 in curly braces, a regexp match is performed, with @samp{=} meaning that the
3898 regexp matches the property value, and @samp{<>} meaning that it does not
3899 match.  
3900 @end itemize
3902 So the search string in the example finds entries tagged @samp{:work:} but
3903 not @samp{:boss:}, which also have a priority value @samp{A}, a
3904 @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
3905 property that is numerically smaller than 2, a @samp{:With:} property that is
3906 matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
3907 on or after October 11, 2008.
3909 You can configure Org mode to use property inheritance during a search, but
3910 beware that this can slow down searches considerably.  See @ref{Property
3911 inheritance} for details.
3913 There is also a special command for creating sparse trees based on a
3914 single property:
3916 @table @kbd
3917 @kindex C-c / p
3918 @item C-c / p
3919 Create a sparse tree based on the value of a property.  This first
3920 prompts for the name of a property, and then for a value.  A sparse tree
3921 is created with all entries that define this property with the given
3922 value.  If you enclose the value into curly braces, it is interpreted as
3923 a regular expression and matched against the property values.
3924 @end table
3926 @node Property inheritance, Column view, Property searches, Properties and Columns
3927 @section Property Inheritance
3928 @cindex properties, inheritance
3929 @cindex inheritance, of properties
3931 The outline structure of Org mode documents lends itself for an
3932 inheritance model of properties: If the parent in a tree has a certain
3933 property, the children can inherit this property.  Org mode does not
3934 turn this on by default, because it can slow down property searches
3935 significantly and is often not needed.  However, if you find inheritance
3936 useful, you can turn it on by setting the variable
3937 @code{org-use-property-inheritance}.  It may be set to @code{t}, to make
3938 all properties inherited from the parent, to a list of properties
3939 that should be inherited, or to a regular expression that matches
3940 inherited properties.
3942 Org mode has a few properties for which inheritance is hard-coded, at
3943 least for the special applications for which they are used:
3945 @table @code
3946 @item COLUMNS
3947 The @code{:COLUMNS:} property defines the format of column view
3948 (@pxref{Column view}).  It is inherited in the sense that the level
3949 where a @code{:COLUMNS:} property is defined is used as the starting
3950 point for a column view table, independently of the location in the
3951 subtree from where columns view is turned on.
3952 @item CATEGORY
3953 For agenda view, a category set through a @code{:CATEGORY:} property
3954 applies to the entire subtree.
3955 @item ARCHIVE
3956 For archiving, the @code{:ARCHIVE:} property may define the archive
3957 location for the entire subtree (@pxref{Moving subtrees}).
3958 @item LOGGING
3959 The LOGGING property may define logging settings for an entry or a
3960 subtree (@pxref{Tracking TODO state changes}).
3961 @end table
3963 @node Column view, Property API, Property inheritance, Properties and Columns
3964 @section Column view
3966 A great way to view and edit properties in an outline tree is
3967 @emph{column view}.  In column view, each outline item is turned into a
3968 table row.  Columns in this table provide access to properties of the
3969 entries.  Org mode implements columns by overlaying a tabular structure
3970 over the headline of each item.  While the headlines have been turned
3971 into a table row, you can still change the visibility of the outline
3972 tree.  For example, you get a compact table by switching to CONTENTS
3973 view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
3974 is active), but you can still open, read, and edit the entry below each
3975 headline.  Or, you can switch to column view after executing a sparse
3976 tree command and in this way get a table only for the selected items.
3977 Column view also works in agenda buffers (@pxref{Agenda Views}) where
3978 queries have collected selected items, possibly from a number of files.
3980 @menu
3981 * Defining columns::            The COLUMNS format property
3982 * Using column view::           How to create and use column view
3983 * Capturing column view::       A dynamic block for column view
3984 @end menu
3986 @node Defining columns, Using column view, Column view, Column view
3987 @subsection Defining columns
3988 @cindex column view, for properties
3989 @cindex properties, column view
3991 Setting up a column view first requires defining the columns.  This is
3992 done by defining a column format line.
3994 @menu
3995 * Scope of column definitions::  Where defined, where valid?
3996 * Column attributes::           Appearance and content of a column
3997 @end menu
3999 @node Scope of column definitions, Column attributes, Defining columns, Defining columns
4000 @subsubsection Scope of column definitions
4002 To define a column format for an entire file, use a line like
4004 @example
4005 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
4006 @end example
4008 To specify a format that only applies to a specific tree, add a
4009 @code{:COLUMNS:} property to the top node of that tree, for example:
4011 @example
4012 ** Top node for columns view
4013    :PROPERTIES:
4014    :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
4015    :END:
4016 @end example
4018 If a @code{:COLUMNS:} property is present in an entry, it defines columns
4019 for the entry itself, and for the entire subtree below it.  Since the
4020 column definition is part of the hierarchical structure of the document,
4021 you can define columns on level 1 that are general enough for all
4022 sublevels, and more specific columns further down, when you edit a
4023 deeper part of the tree.
4025 @node Column attributes,  , Scope of column definitions, Defining columns
4026 @subsubsection Column attributes
4027 A column definition sets the attributes of a column.  The general
4028 definition looks like this:
4030 @example
4031  %[width]property[(title)][@{summary-type@}]
4032 @end example
4034 @noindent
4035 Except for the percent sign and the property name, all items are
4036 optional.  The individual parts have the following meaning:
4038 @example
4039 width           @r{An integer specifying the width of the column in characters.}
4040                 @r{If omitted, the width will be determined automatically.}
4041 property        @r{The property that should be edited in this column.}
4042 (title)         @r{The header text for the column. If omitted, the}
4043                 @r{property name is used.}
4044 @{summary-type@}  @r{The summary type.  If specified, the column values for}
4045                 @r{parent nodes are computed from the children.}
4046                 @r{Supported summary types are:}
4047                 @{+@}       @r{Sum numbers in this column.}
4048                 @{+;%.1f@}  @r{Like @samp{+}, but format result with @samp{%.1f}.}
4049                 @{$@}       @r{Currency, short for @samp{+;%.2f}.}
4050                 @{:@}       @r{Sum times, HH:MM:SS, plain numbers are hours.}
4051                 @{X@}       @r{Checkbox status, [X] if all children are [X].}
4052                 @{X/@}      @r{Checkbox status, [n/m].}
4053                 @{X%@}      @r{Checkbox status, [n%].}
4054 @end example
4056 @noindent
4057 Here is an example for a complete columns definition, along with allowed
4058 values.
4060 @example
4061 :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.}
4062                    %10Time_Estimate@{:@} %CLOCKSUM
4063 :Owner_ALL:    Tammy Mark Karl Lisa Don
4064 :Status_ALL:   "In progress" "Not started yet" "Finished" ""
4065 :Approved_ALL: "[ ]" "[X]"
4066 @end example
4068 The first column, @samp{%25ITEM}, means the first 25 characters of the
4069 item itself, i.e. of the headline.  You probably always should start the
4070 column definition with the @samp{ITEM} specifier.  The other specifiers
4071 create columns @samp{Owner} with a list of names as allowed values, for
4072 @samp{Status} with four different possible values, and for a checkbox
4073 field @samp{Approved}.  When no width is given after the @samp{%}
4074 character, the column will be exactly as wide as it needs to be in order
4075 to fully display all values.  The @samp{Approved} column does have a
4076 modified title (@samp{Approved?}, with a question mark).  Summaries will
4077 be created for the @samp{Time_Estimate} column by adding time duration
4078 expressions like HH:MM, and for the @samp{Approved} column, by providing
4079 an @samp{[X]} status if all children have been checked.  The
4080 @samp{CLOCKSUM} column is special, it lists the sum of CLOCK intervals
4081 in the subtree.
4083 @node Using column view, Capturing column view, Defining columns, Column view
4084 @subsection Using column view
4086 @table @kbd
4087 @tsubheading{Turning column view on and off}
4088 @kindex C-c C-x C-c
4089 @item C-c C-x C-c
4090 Create the column view for the local environment.  This command searches
4091 the hierarchy, up from point, for a @code{:COLUMNS:} property that defines
4092 a format.  When one is found, the column view table is established for
4093 the entire tree, starting from the entry that contains the @code{:COLUMNS:}
4094 property.  If none is found, the format is taken from the @code{#+COLUMNS}
4095 line or from the variable @code{org-columns-default-format}, and column
4096 view is established for the current entry and its subtree.
4097 @kindex r
4098 @item r
4099 Recreate the column view, to include recent changes made in the buffer.
4100 @kindex g
4101 @item g
4102 Same as @kbd{r}.
4103 @kindex q
4104 @item q
4105 Exit column view.
4106 @tsubheading{Editing values}
4107 @item @key{left} @key{right} @key{up} @key{down}
4108 Move through the column view from field to field.
4109 @kindex S-@key{left}
4110 @kindex S-@key{right}
4111 @item  S-@key{left}/@key{right}
4112 Switch to the next/previous allowed value of the field.  For this, you
4113 have to have specified allowed values for a property.
4114 @item 1..9,0
4115 Directly select the nth allowed value, @kbd{0} selects the 10th value.
4116 @kindex n
4117 @kindex p
4118 @itemx  n / p
4119 Same as @kbd{S-@key{left}/@key{right}}
4120 @kindex e
4121 @item e
4122 Edit the property at point.  For the special properties, this will
4123 invoke the same interface that you normally use to change that
4124 property.  For example, when editing a TAGS property, the tag completion
4125 or fast selection interface will pop up.
4126 @kindex C-c C-c
4127 @item C-c C-c
4128 When there is a checkbox at point, toggle it.
4129 @kindex v
4130 @item v
4131 View the full value of this property.  This is useful if the width of
4132 the column is smaller than that of the value.
4133 @kindex a
4134 @item a
4135 Edit the list of allowed values for this property.  If the list is found
4136 in the hierarchy, the modified values is stored there.  If no list is
4137 found, the new value is stored in the first entry that is part of the
4138 current column view.
4139 @tsubheading{Modifying the table structure}
4140 @kindex <
4141 @kindex >
4142 @item < / >
4143 Make the column narrower/wider by one character.
4144 @kindex S-M-@key{right}
4145 @item S-M-@key{right}
4146 Insert a new column, to the left of the current column.
4147 @kindex S-M-@key{left}
4148 @item S-M-@key{left}
4149 Delete the current column.
4150 @end table
4152 @node Capturing column view,  , Using column view, Column view
4153 @subsection Capturing column view
4155 Since column view is just an overlay over a buffer, it cannot be
4156 exported or printed directly.  If you want to capture a column view, use
4157 this @code{columnview} dynamic block (@pxref{Dynamic blocks}).  The frame
4158 of this block looks like this:
4160 @cindex #+BEGIN: columnview
4161 @example
4162 * The column view
4163 #+BEGIN: columnview :hlines 1 :id "label"
4165 #+END:
4166 @end example
4168 @noindent This dynamic block has the following parameters:
4170 @table @code
4171 @item :id
4172 This is most important parameter.  Column view is a feature that is
4173 often localized to a certain (sub)tree, and the capture block might be
4174 in a different location in the file.  To identify the tree whose view to
4175 capture, you can use 3 values:
4176 @example
4177 local     @r{use the tree in which the capture block is located}
4178 global    @r{make a global view, including all headings in the file}
4179 "label"   @r{call column view in the tree that has an @code{:ID:}}
4180           @r{property with the value @i{label}.  You can use}
4181           @r{@kbd{M-x org-id-copy} to create a globally unique ID for}
4182           @r{the current entry and copy it to the kill-ring.}
4183 @end example
4184 @item :hlines
4185 When @code{t}, insert a hline after every line.  When a number N, insert
4186 a hline before each headline with level @code{<= N}.
4187 @item :vlines
4188 When set to @code{t}, enforce column groups to get vertical lines.
4189 @item :maxlevel
4190 When set to a number, don't capture entries below this level.
4191 @item :skip-empty-rows
4192 When set to @code{t}, skip row where the only non-empty specifier of the
4193 column view is @code{ITEM}.
4195 @end table
4197 @noindent
4198 The following commands insert or update the dynamic block:
4200 @table @kbd
4201 @kindex C-c C-x i
4202 @item C-c C-x i
4203 Insert a dynamic block capturing a column view.  You will be prompted
4204 for the scope or id of the view.
4205 @kindex C-c C-c
4206 @item C-c C-c
4207 @kindex C-c C-x C-u
4208 @itemx C-c C-x C-u
4209 Update dynamical block at point.  The cursor needs to be in the
4210 @code{#+BEGIN} line of the dynamic block.
4211 @kindex C-u C-c C-x C-u
4212 @item C-u C-c C-x C-u
4213 Update all dynamic blocks (@pxref{Dynamic blocks}).  This is useful if
4214 you have several clock table blocks in a buffer.
4215 @end table
4217 You can add formulas to the column view table and you may add plotting
4218 instructions in front of the table - these will survive an update of the
4219 block.  If there is a @code{#+TBLFM:} after the table, the table will
4220 actually be recalculated automatically after an update.
4222 @node Property API,  , Column view, Properties and Columns
4223 @section The Property API
4224 @cindex properties, API
4225 @cindex API, for properties
4227 There is a full API for accessing and changing properties.  This API can
4228 be used by Emacs Lisp programs to work with properties and to implement
4229 features based on them.  For more information see @ref{Using the
4230 property API}.
4232 @node Dates and Times, Capture, Properties and Columns, Top
4233 @chapter Dates and Times
4234 @cindex dates
4235 @cindex times
4236 @cindex time stamps
4237 @cindex date stamps
4239 To assist project planning, TODO items can be labeled with a date and/or
4240 a time.  The specially formatted string carrying the date and time
4241 information is called a @emph{timestamp} in Org mode.  This may be a
4242 little confusing because timestamp is often used as indicating when
4243 something was created or last changed.  However, in Org mode this term
4244 is used in a much wider sense.
4246 @menu
4247 * Timestamps::                  Assigning a time to a tree entry
4248 * Creating timestamps::         Commands which insert timestamps
4249 * Deadlines and scheduling::    Planning your work
4250 * Clocking work time::          Tracking how long you spend on a task
4251 * Effort estimates::            Planning work effort in advance
4252 @end menu
4255 @node Timestamps, Creating timestamps, Dates and Times, Dates and Times
4256 @section Timestamps, deadlines and scheduling
4257 @cindex time stamps
4258 @cindex ranges, time
4259 @cindex date stamps
4260 @cindex deadlines
4261 @cindex scheduling
4263 A time stamp is a specification of a date (possibly with time or a range
4264 of times) in a special format, either @samp{<2003-09-16 Tue>} or
4265 @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16 Tue
4266 12:00-12:30>}@footnote{This is the standard ISO date/time format.  To
4267 use an alternative format, see @ref{Custom time format}.}.  A time stamp
4268 can appear anywhere in the headline or body of an Org tree entry.  Its
4269 presence causes entries to be shown on specific dates in the agenda
4270 (@pxref{Weekly/daily agenda}).  We distinguish:
4272 @table @var
4273 @item Plain time stamp; Event; Appointment
4274 @cindex timestamp
4275 A simple time stamp just assigns a date/time to an item.  This is just
4276 like writing down an appointment or event in a paper agenda.  In the
4277 timeline and agenda displays, the headline of an entry associated with a
4278 plain time stamp will be shown exactly on that date.
4280 @example
4281 * Meet Peter at the movies <2006-11-01 Wed 19:15>
4282 * Discussion on climate change <2006-11-02 Thu 20:00-22:00>
4283 @end example
4285 @item Time stamp with repeater interval
4286 @cindex timestamp, with repeater interval
4287 A time stamp may contain a @emph{repeater interval}, indicating that it
4288 applies not only on the given date, but again and again after a certain
4289 interval of N days (d), weeks (w), months(m), or years(y).  The
4290 following will show up in the agenda every Wednesday:
4292 @example
4293 * Pick up Sam at school <2007-05-16 Wed 12:30 +1w>
4294 @end example
4296 @item Diary-style sexp entries
4297 For more complex date specifications, Org mode supports using the
4298 special sexp diary entries implemented in the Emacs calendar/diary
4299 package.  For example
4301 @example
4302 * The nerd meeting on every 2nd Thursday of the month
4303   <%%(diary-float t 4 2)>
4304 @end example
4306 @item Time/Date range
4307 @cindex timerange
4308 @cindex date range
4309 Two time stamps connected by @samp{--} denote a range.  The headline
4310 will be shown on the first and last day of the range, and on any dates
4311 that are displayed and fall in the range.  Here is an example:
4313 @example
4314 ** Meeting in Amsterdam
4315    <2004-08-23 Mon>--<2004-08-26 Thu>
4316 @end example
4318 @item Inactive time stamp
4319 @cindex timestamp, inactive
4320 @cindex inactive timestamp
4321 Just like a plain time stamp, but with square brackets instead of
4322 angular ones.  These time stamps are inactive in the sense that they do
4323 @emph{not} trigger an entry to show up in the agenda.
4325 @example
4326 * Gillian comes late for the fifth time [2006-11-01 Wed]
4327 @end example
4329 @end table
4331 @node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times
4332 @section Creating timestamps
4333 @cindex creating timestamps
4334 @cindex timestamps, creating
4336 For Org mode to recognize time stamps, they need to be in the specific
4337 format.  All commands listed below produce time stamps in the correct
4338 format.
4340 @table @kbd
4341 @kindex C-c .
4342 @item C-c .
4343 Prompt for a date and insert a corresponding time stamp.  When the cursor is
4344 at an existing time stamp in the buffer, the command is used to modify this
4345 timestamp instead of inserting a new one.  When this command is used twice in
4346 succession, a time range is inserted.
4348 @kindex C-u C-c .
4349 @item C-u C-c .
4350 Like @kbd{C-c .}, but use the alternative format which contains date
4351 and time.  The default time can be rounded to multiples of 5 minutes,
4352 see the option @code{org-time-stamp-rounding-minutes}.
4354 @kindex C-c !
4355 @item C-c !
4356 Like @kbd{C-c .}, but insert an inactive time stamp that will not cause
4357 an agenda entry.
4359 @kindex C-c <
4360 @item C-c <
4361 Insert a time stamp corresponding to the cursor date in the Calendar.
4363 @kindex C-c >
4364 @item C-c >
4365 Access the Emacs calendar for the current date.  If there is a
4366 timestamp in the current line, go to the corresponding date
4367 instead.
4369 @kindex C-c C-o
4370 @item C-c C-o
4371 Access the agenda for the date given by the time stamp or -range at
4372 point (@pxref{Weekly/daily agenda}).
4374 @kindex S-@key{left}
4375 @kindex S-@key{right}
4376 @item S-@key{left}
4377 @itemx S-@key{right}
4378 Change date at cursor by one day.  These key bindings conflict with
4379 CUA mode (@pxref{Conflicts}).
4381 @kindex S-@key{up}
4382 @kindex S-@key{down}
4383 @item S-@key{up}
4384 @itemx S-@key{down}
4385 Change the item under the cursor in a timestamp.  The cursor can be on a
4386 year, month, day, hour or minute.  Note that if the cursor is in a
4387 headline and not at a time stamp, these same keys modify the priority of
4388 an item.  (@pxref{Priorities}). The key bindings also conflict with
4389 CUA mode (@pxref{Conflicts}).
4391 @kindex C-c C-y
4392 @cindex evaluate time range
4393 @item C-c C-y
4394 Evaluate a time range by computing the difference between start and end.
4395 With a prefix argument, insert result after the time range (in a table: into
4396 the following column).
4397 @end table
4400 @menu
4401 * The date/time prompt::        How Org mode helps you entering date and time
4402 * Custom time format::          Making dates look different
4403 @end menu
4405 @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps
4406 @subsection The date/time prompt
4407 @cindex date, reading in minibuffer
4408 @cindex time, reading in minibuffer
4410 When Org mode prompts for a date/time, the default is shown as an ISO
4411 date, and the prompt therefore seems to ask for an ISO date.  But it
4412 will in fact accept any string containing some date and/or time
4413 information, and it is really smart about interpreting your input.  You
4414 can, for example, use @kbd{C-y} to paste a (possibly multi-line) string
4415 copied from an email message.  Org mode will find whatever information
4416 is in there and derive anything you have not specified from the
4417 @emph{default date and time}.  The default is usually the current date
4418 and time, but when modifying an existing time stamp, or when entering
4419 the second stamp of a range, it is taken from the stamp in the buffer.
4420 When filling in information, Org mode assumes that most of the time you
4421 will want to enter a date in the future: If you omit the month/year and
4422 the given day/month is @i{before} today, it will assume that you mean a
4423 future date@footnote{See the variable
4424 @code{org-read-date-prefer-future}.}.
4426 For example, lets assume that today is @b{June 13, 2006}.  Here is how
4427 various inputs will be interpreted, the items filled in by Org mode are
4428 in @b{bold}.
4430 @example
4431 3-2-5         --> 2003-02-05
4432 14            --> @b{2006}-@b{06}-14
4433 12            --> @b{2006}-@b{07}-12
4434 Fri           --> nearest Friday (defaultdate or later)
4435 sep 15        --> @b{2006}-11-15
4436 feb 15        --> @b{2007}-02-15
4437 sep 12 9      --> 2009-09-12
4438 12:45         --> @b{2006}-@b{06}-@b{13} 12:45
4439 22 sept 0:34  --> @b{2006}-09-22 0:34
4440 w4            --> ISO week for of the current year @b{2006}
4441 2012 w4 fri   --> Friday of ISO week 4 in 2012
4442 2012-w04-5    --> Same as above
4443 @end example
4445 Furthermore you can specify a relative date by giving, as the
4446 @emph{first} thing in the input: a plus/minus sign, a number and a
4447 letter [dwmy] to indicate change in days weeks, months, years.  With a
4448 single plus or minus, the date is always relative to today.  With a
4449 double plus or minus, it is relative to the default date.  If instead of
4450 a single letter, you use the abbreviation of day name, the date will be
4451 the nth such day.  E.g.
4453 @example
4454 +0            --> today
4455 .             --> today
4456 +4d           --> four days from today
4457 +4            --> same as above
4458 +2w           --> two weeks from today
4459 ++5           --> five days from default date
4460 +2tue         --> second tuesday from now.
4461 @end example
4463 The function understands English month and weekday abbreviations.  If
4464 you want to use unabbreviated names and/or other languages, configure
4465 the variables @code{parse-time-months} and @code{parse-time-weekdays}.
4467 @cindex calendar, for selecting date
4468 Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
4469 you don't need/want the calendar, configure the variable
4470 @code{org-popup-calendar-for-date-prompt}.}.  When you exit the date
4471 prompt, either by clicking on a date in the calendar, or by pressing
4472 @key{RET}, the date selected in the calendar will be combined with the
4473 information entered at the prompt.  You can control the calendar fully
4474 from the minibuffer:
4476 @kindex <
4477 @kindex >
4478 @kindex mouse-1
4479 @kindex S-@key{right}
4480 @kindex S-@key{left}
4481 @kindex S-@key{down}
4482 @kindex S-@key{up}
4483 @kindex M-S-@key{right}
4484 @kindex M-S-@key{left}
4485 @kindex @key{RET}
4486 @example
4487 > / <          @r{Scroll calendar forward/backward by one month.}
4488 mouse-1        @r{Select date by clicking on it.}
4489 S-@key{right}/@key{left}     @r{One day forward/backward.}
4490 S-@key{down}/@key{up}     @r{One week forward/backward.}
4491 M-S-@key{right}/@key{left}   @r{One month forward/backward.}
4492 @key{RET}           @r{Choose date in calendar.}
4493 @end example
4495 The actions of the date/time prompt may seem complex, but I assure you they
4496 will grow on you, and you will start getting annoyed by pretty much any other
4497 way of entering a date/time out there.  To help you understand what is going
4498 on, the current interpretation of your input will be displayed live in the
4499 minibuffer@footnote{If you find this distracting, turn the display of with
4500 @code{org-read-date-display-live}.}.
4502 @node Custom time format,  , The date/time prompt, Creating timestamps
4503 @subsection Custom time format
4504 @cindex custom date/time format
4505 @cindex time format, custom
4506 @cindex date format, custom
4508 Org mode uses the standard ISO notation for dates and times as it is
4509 defined in ISO 8601.  If you cannot get used to this and require another
4510 representation of date and time to keep you happy, you can get it by
4511 customizing the variables @code{org-display-custom-times} and
4512 @code{org-time-stamp-custom-formats}.
4514 @table @kbd
4515 @kindex C-c C-x C-t
4516 @item C-c C-x C-t
4517 Toggle the display of custom formats for dates and times.
4518 @end table
4520 @noindent
4521 Org mode needs the default format for scanning, so the custom date/time
4522 format does not @emph{replace} the default format - instead it is put
4523 @emph{over} the default format using text properties.  This has the
4524 following consequences:
4525 @itemize @bullet
4526 @item
4527 You cannot place the cursor onto a time stamp anymore, only before or
4528 after.
4529 @item
4530 The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
4531 each component of a time stamp.  If the cursor is at the beginning of
4532 the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
4533 just like @kbd{S-@key{left}/@key{right}}.  At the end of the stamp, the
4534 time will be changed by one minute.
4535 @item
4536 If the time stamp contains a range of clock times or a repeater, these
4537 will not be overlayed, but remain in the buffer as they were.
4538 @item
4539 When you delete a time stamp character-by-character, it will only
4540 disappear from the buffer after @emph{all} (invisible) characters
4541 belonging to the ISO timestamp have been removed.
4542 @item
4543 If the custom time stamp format is longer than the default and you are
4544 using dates in tables, table alignment will be messed up.  If the custom
4545 format is shorter, things do work as expected.
4546 @end itemize
4549 @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times
4550 @section Deadlines and scheduling
4552 A time stamp may be preceded by special keywords to facilitate planning:
4554 @table @var
4555 @item DEADLINE
4556 @cindex DEADLINE keyword
4558 Meaning: the task (most likely a TODO item, though not necessarily) is supposed
4559 to be finished on that date.
4561 On the deadline date, the task will be listed in the agenda.  In
4562 addition, the agenda for @emph{today} will carry a warning about the
4563 approaching or missed deadline, starting
4564 @code{org-deadline-warning-days} before the due date, and continuing
4565 until the entry is marked DONE.  An example:
4567 @example
4568 *** TODO write article about the Earth for the Guide
4569     The editor in charge is [[bbdb:Ford Prefect]]
4570     DEADLINE: <2004-02-29 Sun>
4571 @end example
4573 You can specify a different lead time for warnings for a specific
4574 deadlines using the following syntax.  Here is an example with a warning
4575 period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}.
4577 @item SCHEDULED
4578 @cindex SCHEDULED keyword
4580 Meaning: you are planning to start working on that task on the given
4581 date.
4583 The headline will be listed under the given date@footnote{It will still
4584 be listed on that date after it has been marked DONE.  If you don't like
4585 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}.  In
4586 addition, a reminder that the scheduled date has passed will be present
4587 in the compilation for @emph{today}, until the entry is marked DONE.
4588 I.e., the task will automatically be forwarded until completed.
4590 @example
4591 *** TODO Call Trillian for a date on New Years Eve.
4592     SCHEDULED: <2004-12-25 Sat>
4593 @end example
4595 @noindent
4596 @b{Important:} Scheduling an item in Org mode should @i{not} be
4597 understood in the same way that we understand @i{scheduling a meeting}.
4598 Setting a date for a meeting is just a simple appointment, you should
4599 mark this entry with a simple plain time stamp, to get this item shown
4600 on the date where it applies.  This is a frequent mis-understanding from
4601 Org-users.  In Org mode, @i{scheduling} means setting a date when you
4602 want to start working on an action item.
4603 @end table
4605 You may use time stamps with repeaters in scheduling and deadline
4606 entries.  Org mode will issue early and late warnings based on the
4607 assumption that the time stamp represents the @i{nearest instance} of
4608 the repeater.  However, the use of diary sexp entries like
4610 @code{<%%(diary-float t 42)>}
4612 in scheduling and deadline timestamps is limited.  Org mode does not
4613 know enough about the internals of each sexp function to issue early and
4614 late warnings.  However, it will show the item on each day where the
4615 sexp entry matches.
4617 @menu
4618 * Inserting deadline/schedule::  Planning items
4619 * Repeated tasks::              Items that show up again and again
4620 @end menu
4622 @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling
4623 @subsection Inserting deadlines or schedules
4625 The following commands allow to quickly insert a deadline or to schedule
4626 an item:
4628 @table @kbd
4630 @kindex C-c C-d
4631 @item C-c C-d
4632 Insert @samp{DEADLINE} keyword along with a stamp.  The insertion will
4633 happen in the line directly following the headline.  When called with a
4634 prefix arg, an existing deadline will be removed from the entry.
4635 @c FIXME Any CLOSED timestamp will be removed.????????
4637 @kindex C-c / d
4638 @cindex sparse tree, for deadlines
4639 @item C-c / d
4640 Create a sparse tree with all deadlines that are either past-due, or
4641 which will become due within @code{org-deadline-warning-days}.
4642 With @kbd{C-u} prefix, show all deadlines in the file.  With a numeric
4643 prefix, check that many days.  For example, @kbd{C-1 C-c / d} shows
4644 all deadlines due tomorrow.
4646 @kindex C-c C-s
4647 @item C-c C-s
4648 Insert @samp{SCHEDULED} keyword along with a stamp.  The insertion will
4649 happen in the line directly following the headline.  Any CLOSED
4650 timestamp will be removed.  When called with a prefix argument, remove
4651 the scheduling date from the entry.
4653 @kindex C-c C-x C-k
4654 @kindex k a
4655 @kindex k s
4656 @item C-c C-x C-k
4657 Mark the current entry for agenda action.  After you have marked the entry
4658 like this, you can open the agenda or the calendar to find an appropriate
4659 date.  With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to
4660 schedule the marked item.
4661 @end table
4663 @node Repeated tasks,  , Inserting deadline/schedule, Deadlines and scheduling
4664 @subsection Repeated tasks
4666 Some tasks need to be repeated again and again.  Org mode helps to
4667 organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
4668 or plain time stamp.  In the following example
4669 @example
4670 ** TODO Pay the rent
4671    DEADLINE: <2005-10-01 Sat +1m>
4672 @end example
4673 the @code{+1m} is a repeater; the intended interpretation is that the
4674 task has a deadline on <2005-10-01> and repeats itself every (one) month
4675 starting from that time.  If you need both a repeater and a special
4676 warning period in a deadline entry, the repeater comes first and the
4677 warning period last: @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
4679 Deadlines and scheduled items produce entries in the agenda when they
4680 are over-due, so it is important to be able to mark such an entry as
4681 completed once you have done so.  When you mark a DEADLINE or a SCHEDULE
4682 with the TODO keyword DONE, it will no longer produce entries in the
4683 agenda.  The problem with this is, however, that then also the
4684 @emph{next} instance of the repeated entry will not be active.  Org mode
4685 deals with this in the following way: When you try to mark such an entry
4686 DONE (using @kbd{C-c C-t}), it will shift the base date of the repeating
4687 time stamp by the repeater interval, and immediately set the entry state
4688 back to TODO.  In the example above, setting the state to DONE would
4689 actually switch the date like this:
4691 @example
4692 ** TODO Pay the rent
4693    DEADLINE: <2005-11-01 Tue +1m>
4694 @end example
4696 A timestamp@footnote{You can change this using the option
4697 @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
4698 @code{lognoterepeat}, and @code{nologrepeat}.  With @code{lognoterepeat}, you
4699 will aslo be prompted for a note.} will be added under the deadline, to keep
4700 a record that you actually acted on the previous instance of this deadline.
4702 As a consequence of shifting the base date, this entry will no longer be
4703 visible in the agenda when checking past dates, but all future instances
4704 will be visible.
4706 With the @samp{+1m} cookie, the date shift will always be exactly one
4707 month.  So if you have not payed the rent for three months, marking this
4708 entry DONE will still keep it as an overdue deadline.  Depending on the
4709 task, this may not be the best way to handle it.  For example, if you
4710 forgot to call you father for 3 weeks, it does not make sense to call
4711 him 3 times in a single day to make up for it.  Finally, there are tasks
4712 like changing batteries which should always repeat a certain time
4713 @i{after} the last time you did it.  For these tasks, Org mode has
4714 special repeaters markers with @samp{++} and @samp{.+}.  For example:
4716 @example
4717 ** TODO Call Father
4718    DEADLINE: <2008-02-10 Sun ++1w>
4719    Marking this DONE will shift the date by at least one week,
4720    but also by as many weeks as it takes to get this date into
4721    the future.  However, it stays on a Sunday, even if you called
4722    and marked it done on Saturday.
4723 ** TODO Check the batteries in the smoke detectors
4724    DEADLINE: <2005-11-01 Tue .+1m>
4725    Marking this DONE will shift the date to one month after
4726    today.
4727 @end example
4729 You may have both scheduling and deadline information for a specific
4730 task - just make sure that the repeater intervals on both are the same.
4732 @node Clocking work time, Effort estimates, Deadlines and scheduling, Dates and Times
4733 @section Clocking work time
4735 Org mode allows you to clock the time you spent on specific tasks in a
4736 project.  When you start working on an item, you can start the clock.
4737 When you stop working on that task, or when you mark the task done, the
4738 clock is stopped and the corresponding time interval is recorded.  It
4739 also computes the total time spent on each subtree of a project.
4741 @table @kbd
4742 @kindex C-c C-x C-i
4743 @item C-c C-x C-i
4744 Start the clock on the current item (clock-in).  This inserts the CLOCK
4745 keyword together with a timestamp.  If this is not the first clocking of
4746 this item, the multiple CLOCK lines will be wrapped into a
4747 @code{:CLOCK:} drawer (see also the variable
4748 @code{org-clock-into-drawer}).  When called with a @kbd{C-u} prefix argument,
4749 select the task from a list of recently clocked tasks.  With two @kbd{C-u
4750 C-u} prefixes, clock into the task at point and mark it as the default task.
4751 The default task will always be available when selecting a clocking task,
4752 with letter @kbd{d}.
4753 @kindex C-c C-x C-o
4754 @item C-c C-x C-o
4755 Stop the clock (clock-out).  The inserts another timestamp at the same
4756 location where the clock was last started.  It also directly computes
4757 the resulting time in inserts it after the time range as @samp{=>
4758 HH:MM}.  See the variable @code{org-log-note-clock-out} for the
4759 possibility to record an additional note together with the clock-out
4760 time stamp@footnote{The corresponding in-buffer setting is:
4761 @code{#+STARTUP: lognoteclock-out}}.
4762 @kindex C-c C-y
4763 @item C-c C-y
4764 Recompute the time interval after changing one of the time stamps.  This
4765 is only necessary if you edit the time stamps directly.  If you change
4766 them with @kbd{S-@key{cursor}} keys, the update is automatic.
4767 @kindex C-c C-t
4768 @item C-c C-t
4769 Changing the TODO state of an item to DONE automatically stops the clock
4770 if it is running in this same item.
4771 @kindex C-c C-x C-x
4772 @item C-c C-x C-x
4773 Cancel the current clock.  This is useful if a clock was started by
4774 mistake, or if you ended up working on something else.
4775 @kindex C-c C-x C-j
4776 @item C-c C-x C-j
4777 Jump to the entry that contains the currently running clock.  With a
4778 @kbd{C-u} prefix arg, select the target task from a list of recently clocked
4779 tasks.
4780 @kindex C-c C-x C-d
4781 @item C-c C-x C-d
4782 Display time summaries for each subtree in the current buffer.  This
4783 puts overlays at the end of each headline, showing the total time
4784 recorded under that heading, including the time of any subheadings. You
4785 can use visibility cycling to study the tree, but the overlays disappear
4786 when you change the buffer (see variable
4787 @code{org-remove-highlights-with-change}) or press @kbd{C-c C-c}.
4788 @kindex C-c C-x C-r
4789 @item C-c C-x C-r
4790 Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
4791 report as an Org mode table into the current file.  When the cursor is
4792 at an existing clock table, just update it.  When called with a prefix
4793 argument, jump to the first clock report in the current document and
4794 update it.
4795 @cindex #+BEGIN: clocktable
4796 @example
4797 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
4798 #+END: clocktable
4799 @end example
4800 @noindent
4801 If such a block already exists at point, its content is replaced by the
4802 new table.  The @samp{BEGIN} line can specify options:
4803 @example
4804 :maxlevel    @r{Maximum level depth to which times are listed in the table.}
4805 :emphasize   @r{When @code{t}, emphasize level one and level two items}
4806 :scope       @r{The scope to consider.  This can be any of the following:}
4807              nil        @r{the current buffer or narrowed region}
4808              file       @r{the full current buffer}
4809              subtree    @r{the subtree where the clocktable is located}
4810              treeN      @r{the surrounding level N tree, for example @code{tree3}}
4811              tree       @r{the surrounding level 1 tree}
4812              agenda     @r{all agenda files}
4813              ("file"..) @r{scan these files}
4814              file-with-archives    @r{current file and its archives}
4815              agenda-with-archives  @r{all agenda files, including archives}
4816 :block       @r{The time block to consider.  This block is specified either}
4817              @r{absolute, or relative to the current time and may be any of}
4818              @r{these formats:}
4819              2007-12-31    @r{New year eve 2007}
4820              2007-12       @r{December 2007}
4821              2007-W50      @r{ISO-week 50 in 2007}
4822              2007          @r{the year 2007}
4823              today, yesterday, today-N          @r{a relative day}
4824              thisweek, lastweek, thisweek-N     @r{a relative week}
4825              thismonth, lastmonth, thismonth-N  @r{a relative month}
4826              thisyear, lastyear, thisyear-N     @r{a relative year}
4827              @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
4828 :tstart      @r{A time string specifying when to start considering times}
4829 :tend        @r{A time string specifying when to stop considering times}
4830 :step        @r{@code{week} or @code{day}, to split the table into chunks.}
4831              @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
4832 :link        @r{Link the item headlines in the table to their origins}
4833 @end example
4834 So to get a clock summary of the current level 1 tree, for the current
4835 day, you could write
4836 @example
4837 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
4838 #+END: clocktable
4839 @end example
4840 and to use a specific time range you could write@footnote{Note that all
4841 parameters must be specified in a single line - the line is broken here
4842 only to fit it onto the manual.}
4843 @example
4844 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
4845                     :tend "<2006-08-10 Thu 12:00>"
4846 #+END: clocktable
4847 @end example
4848 @kindex C-c C-c
4849 @item C-c C-c
4850 @kindex C-c C-x C-u
4851 @itemx C-c C-x C-u
4852 Update dynamical block at point.  The cursor needs to be in the
4853 @code{#+BEGIN} line of the dynamic block.
4854 @kindex C-u C-c C-x C-u
4855 @item C-u C-c C-x C-u
4856 Update all dynamic blocks (@pxref{Dynamic blocks}).  This is useful if
4857 you have several clock table blocks in a buffer.
4858 @kindex S-@key{left}
4859 @kindex S-@key{right}
4860 @item S-@key{left}
4861 @itemx S-@key{right}
4862 Shift the current @code{:block} interval and update the table.  The cursor
4863 needs to be in the @code{#+BEGIN: clocktable} line for this command.  If
4864 @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
4865 @end table
4867 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
4868 the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
4869 worked on or closed during a day.
4871 @node Effort estimates,  , Clocking work time, Dates and Times
4872 @section Effort estimates
4873 @cindex Effort estimates
4875 If you want to plan your work in a very detailed way, or if you need to
4876 produce offers with quotations of the estimated work effort, you may want to
4877 assign effort estimates to entries.  If you are also clocking your work, you
4878 may later want to compare the planned effort with the actual working time, a
4879 great way to improve planning estimates.  Effort estimates are stored in a
4880 special property @samp{Effort}@footnote{You may change the property being
4881 used with the variable @code{org-effort-property}.}.  Clearly the best way to
4882 work with effort estimates is through column view (@pxref{Column view}).  You
4883 should start by setting up discrete values for effort estimates, and a
4884 @code{COLUMNS} format that displays these values together with clock sums (if
4885 you want to clock your time).  For a specific buffer you can use
4887 @example
4888 #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00
4889 #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
4890 @end example
4892 @noindent
4893 or, even better, you can set up these values globally by customizing the
4894 variables @code{org-global-properties} and @code{org-columns-default-format}.
4895 In particular if you want to use this setup also in the agenda, a global
4896 setup may be advised.
4898 The way to assign estimates to individual items is then to switch to column
4899 mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
4900 value.  The values you enter will immediately be summed up in the hierarchy.
4901 In the column next to it, any clocked time will be displayed.
4903 If you switch to column view in the daily/weekly agenda, the effort column
4904 will summarize the estimated work effort for each day@footnote{Please note
4905 the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
4906 column view}).}, and you can use this to find space in your schedule.  To get
4907 an overview of the entire part of the day that is committed, you can set the
4908 option @code{org-agenda-columns-add-appointments-to-effort-sum}.  The
4909 appointments on a day that take place over a specified time interval will
4910 then also be added to the load estimate of the day.
4912 Effort estimates can be used in secondary agenda filtering that is triggered
4913 with the @kbd{/} key in the agenda (@pxref{Agenda commands}).  If you have
4914 these estimates defined consistently, two or three key presses will narrow
4915 down the list to stuff that fits into an available time slot.
4917 @node Capture, Agenda Views, Dates and Times, Top
4918 @chapter Capture
4919 @cindex capture
4921 An important part of any organization system is the ability to quickly
4922 capture new ideas and tasks, and to associate reference material with them.
4923 Org uses the @file{remember} package to create tasks, and stores files
4924 related to a task (@i{attachments}) in a special directory.
4926 @menu
4927 * Remember::                    Capture new tasks/ideas with little interruption
4928 * Attachments::                 Add files to tasks.
4929 @end menu
4931 @node Remember, Attachments, Capture, Capture
4932 @section Remember
4933 @cindex @file{remember.el}
4935 The @i{Remember} package by John Wiegley lets you store quick notes with
4936 little interruption of your work flow.  See
4937 @uref{http://www.emacswiki.org/cgi-bin/wiki/RememberMode} for more
4938 information.  It is an excellent way to add new notes and tasks to
4939 Org files.  Org significantly expands the possibilities of
4940 @i{remember}: You may define templates for different note types, and
4941 associate target files and headlines with specific templates.  It also
4942 allows you to select the location where a note should be stored
4943 interactively, on the fly.
4945 @menu
4946 * Setting up Remember::         Some code for .emacs to get things going
4947 * Remember templates::          Define the outline of different note types
4948 * Storing notes::               Directly get the note to where it belongs
4949 * Refiling notes::              Moving a note or task to a project
4950 @end menu
4952 @node Setting up Remember, Remember templates, Remember, Remember
4953 @subsection Setting up Remember
4955 The following customization will tell @i{remember} to use org files as
4956 target, and to create annotations compatible with Org links.
4958 @example
4959 (org-remember-insinuate)
4960 (setq org-directory "~/path/to/my/orgfiles/")
4961 (setq org-default-notes-file (concat org-directory "/notes.org"))
4962 (define-key global-map "\C-cr" 'org-remember)
4963 @end example
4965 The last line binds the command @code{org-remember} to a global
4966 key@footnote{Please select your own key, @kbd{C-c r} is only a
4967 suggestion.}.  @code{org-remember} basically just calls @code{remember},
4968 but it makes a few things easier: If there is an active region, it will
4969 automatically copy the region into the remember buffer.  It also allows
4970 to jump to the buffer and location where remember notes are being
4971 stored: Just call @code{org-remember} with a prefix argument.  If you
4972 use two prefix arguments, Org jumps to the location where the last
4973 remember note was stored.
4975 You can also call @code{org-remember} in a special way from the agenda,
4976 using the @kbd{k r} key combination.  With this access, any time stamps
4977 inserted by the selected remember template (see below) will default to
4978 the cursor date in the agenda, rather than to the current date.
4980 @node Remember templates, Storing notes, Setting up Remember, Remember
4981 @subsection Remember templates
4982 @cindex templates, for remember
4984 In combination with Org, you can use templates to generate
4985 different types of @i{remember} notes.  For example, if you would like
4986 to use one template to create general TODO entries, another one for
4987 journal entries, and a third one for collecting random ideas, you could
4988 use:
4990 @example
4991 (setq org-remember-templates
4992  '(("Todo" ?t "* TODO %?\n  %i\n  %a" "~/org/TODO.org" "Tasks")
4993    ("Journal" ?j "* %U %?\n\n  %i\n  %a" "~/org/JOURNAL.org")
4994    ("Idea" ?i "* %^@{Title@}\n  %i\n  %a" "~/org/JOURNAL.org" "New Ideas")))
4995 @end example
4997 @noindent In these entries, the first string is just a name, and the
4998 character specifies how to select the template.  It is useful if the
4999 character is also the first letter of the name.  The next string specifies
5000 the template.  Two more (optional) strings give the file in which, and the
5001 headline under which the new note should be stored.  The file (if not present
5002 or @code{nil}) defaults to @code{org-default-notes-file}, the heading to
5003 @code{org-remember-default-headline}.  If the file name is not an absolute
5004 path, it will be interpreted relative to @code{org-directory}.  The heading
5005 can also be the symbols @code{top} or @code{bottom} to send note as level 1
5006 entries to the beginning or end of the file, respectively.
5008 An optional sixth element specifies the contexts in which the user can select
5009 the template.  This element can be a list of major modes or a function.
5010 @code{org-remember} will first check whether the function returns @code{t} or
5011 if we are in any of the listed major mode, and exclude templates fo which
5012 this condition is not fulfilled.  Templates that do not specify this element
5013 at all, or that use @code{nil} or @code{t} as a value will always be
5014 selectable.
5016 So for example:
5018 @example
5019 (setq org-remember-templates
5020  '(("Bug" ?b "* BUG %?\n  %i\n  %a" "~/org/BUGS.org" "Bugs" (emacs-lisp-mode))
5021    ("Journal" ?j "* %U %?\n\n  %i\n  %a" "~/org/JOURNAL.org" "X" my-check)
5022    ("Idea" ?i "* %^@{Title@}\n  %i\n  %a" "~/org/JOURNAL.org" "New Ideas")))
5023 @end example
5025 The first template will only be available when invoking @code{org-remember}
5026 from an buffer in @code{emacs-lisp-mode}.  The second template will only be
5027 available when the function @code{my-check} returns @code{t}.  The third
5028 template will be proposed in any context.
5030 When you call @kbd{M-x org-remember} (or @kbd{M-x remember}) to remember
5031 something, Org will prompt for a key to select the template (if you have
5032 more than one template) and then prepare the buffer like
5033 @example
5034 * TODO
5035   [[file:link to where you called remember]]
5036 @end example
5038 @noindent
5039 During expansion of the template, special @kbd{%}-escapes allow dynamic
5040 insertion of content:
5041 @example
5042 %^@{prompt@}  @r{prompt the user for a string and replace this sequence with it.}
5043             @r{You may specify a default value and a completion table with}
5044             @r{%^@{prompt|default|completion2|completion3...@}}
5045             @r{The arrow keys access a prompt-specific history.}
5046 %a          @r{annotation, normally the link created with @code{org-store-link}}
5047 %A          @r{like @code{%a}, but prompt for the description part}
5048 %i          @r{initial content, the region when remember is called with C-u.}
5049             @r{The entire text will be indented like @code{%i} itself.}
5050 %t          @r{time stamp, date only}
5051 %T          @r{time stamp with date and time}
5052 %u, %U      @r{like the above, but inactive time stamps}
5053 %^t         @r{like @code{%t}, but prompt for date.  Similarly @code{%^T}, @code{%^u}, @code{%^U}}
5054             @r{You may define a prompt like @code{%^@{Birthday@}t}}
5055 %n          @r{user name (taken from @code{user-full-name})}
5056 %c          @r{Current kill ring head.}
5057 %x          @r{Content of the X clipboard.}
5058 %^C         @r{Interactive selection of which kill or clip to use.}
5059 %^L         @r{Like @code{%^C}, but insert as link.}
5060 %^g         @r{prompt for tags, with completion on tags in target file.}
5061 %k          @r{title of currently clocked task}
5062 %K          @r{link to currently clocked task}
5063 %^G         @r{prompt for tags, with completion all tags in all agenda files.}
5064 %^@{prop@}p   @r{Prompt the user for a value for property @code{prop}}
5065 %:keyword   @r{specific information for certain link types, see below}
5066 %[pathname] @r{insert the contents of the file given by @code{pathname}}
5067 %(sexp)     @r{evaluate elisp @code{(sexp)} and replace with the result}
5068 %!          @r{immediately store note after completing the template}
5069             @r{(skipping the @kbd{C-c C-c} that normally triggers storing)}
5070 %&          @r{jump to target location immediately after storing note}
5071 @end example
5073 @noindent
5074 For specific link types, the following keywords will be
5075 defined@footnote{If you define your own link types (@pxref{Adding
5076 hyperlink types}), any property you store with
5077 @code{org-store-link-props} can be accessed in remember templates in a
5078 similar way.}:
5080 @example
5081 Link type          |  Available keywords
5082 -------------------+----------------------------------------------
5083 bbdb               |  %:name %:company
5084 bbdb               |  %::server %:port %:nick
5085 vm, wl, mh, rmail  |  %:type %:subject %:message-id
5086                    |  %:from %:fromname %:fromaddress
5087                    |  %:to   %:toname   %:toaddress
5088                    |  %: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}.}}
5089 gnus               |  %:group, @r{for messages also all email fields}
5090 w3, w3m            |  %:url
5091 info               |  %:file %:node
5092 calendar           |  %:date"
5093 @end example
5095 @noindent
5096 To place the cursor after template expansion use:
5098 @example
5099 %?          @r{After completing the template, position cursor here.}
5100 @end example
5102 @noindent
5103 If you change your mind about which template to use, call
5104 @code{org-remember} in the remember buffer.  You may then select a new
5105 template that will be filled with the previous context information.
5107 @node Storing notes, Refiling notes, Remember templates, Remember
5108 @subsection Storing notes
5110 When you are finished preparing a note with @i{remember}, you have to press
5111 @kbd{C-c C-c} to file the note away.  If you have started the clock in the
5112 remember buffer, you will first be asked if you want to clock out
5113 now@footnote{To avoid this query, configure the variable
5114 @code{org-remember-clock-out-on-exit}.}.  If you answer @kbd{n}, the clock
5115 will continue to run after the note was filed away.
5117 The handler will then store the note in the file and under the headline
5118 specified in the template, or it will use the default file and headlines.
5119 The window configuration will be restored, sending you back to the working
5120 context before the call to @code{remember}.  To re-use the location found
5121 during the last call to @code{remember}, exit the remember buffer with
5122 @kbd{C-0 C-c C-c}, i.e. specify a zero prefix argument to @kbd{C-c C-c}.
5123 Another special case is @kbd{C-2 C-c C-c} which files the note as a child of
5124 the currently clocked item.
5126 If you want to store the note directly to a different place, use
5127 @kbd{C-1 C-c C-c} instead to exit remember@footnote{Configure the
5128 variable @code{org-remember-store-without-prompt} to make this behavior
5129 the default.}.  The handler will then first prompt for a target file -
5130 if you press @key{RET}, the value specified for the template is used.
5131 Then the command offers the headings tree of the selected file, with the
5132 cursor position at the default headline (if you had specified one in the
5133 template).  You can either immediately press @key{RET} to get the note
5134 placed there.  Or you can use the following keys to find a different
5135 location:
5136 @example
5137 @key{TAB}         @r{Cycle visibility.}
5138 @key{down} / @key{up}   @r{Next/previous visible headline.}
5139 n / p        @r{Next/previous visible headline.}
5140 f / b        @r{Next/previous headline same level.}
5141 u            @r{One level up.}
5142 @c 0-9          @r{Digit argument.}
5143 @end example
5144 @noindent
5145 Pressing @key{RET} or @key{left} or @key{right}
5146 then leads to the following result.
5148 @multitable @columnfractions 0.2 0.15 0.65
5149 @item @b{Cursor position} @tab @b{Key} @tab @b{Note gets inserted}
5150 @item on headline     @tab @key{RET}              @tab as sublevel of the heading at cursor, first or last
5151 @item                 @tab                        @tab depending on @code{org-reverse-note-order}.
5152 @item                 @tab @key{left}/@key{right} @tab as same level, before/after current heading
5153 @item buffer-start    @tab @key{RET} @tab as level 2 heading at end of file or level 1 at beginning
5154 @item                 @tab @tab depending on @code{org-reverse-note-order}.
5155 @item not on headline @tab @key{RET}
5156       @tab at cursor position, level taken from context.
5157 @end multitable
5159 Before inserting the text into a tree, the function ensures that the text has
5160 a headline, i.e. a first line that starts with a @samp{*}.  If not, a
5161 headline is constructed from the current date.  If you have indented the text
5162 of the note below the headline, the indentation will be adapted if inserting
5163 the note into the tree requires demotion from level 1.
5165 @node Refiling notes,  , Storing notes, Remember
5166 @subsection Refiling notes
5167 @cindex refiling notes
5169 Remember is usually used to quickly capture notes and tasks into one or
5170 a few capture lists.  When reviewing the captured data, you may want to
5171 refile some of the entries into a different list, for example into a
5172 project.  Cutting, finding the right location and then pasting the note
5173 is cumbersome.  To simplify this process, you can use the following
5174 special command:
5176 @table @kbd
5177 @kindex C-c C-w
5178 @item C-c C-w
5179 Refile the entry at point.  This command offers possible locations for
5180 refiling the entry and lets you select one with completion.  The item is
5181 filed below the target heading as a subitem.  Depending on
5182 @code{org-reverse-note-order}, it will be either the first of last
5183 subitem.@* By default, all level 1 headlines in the current buffer are
5184 considered to be targets, but you can have more complex definitions
5185 across a number of files.  See the variable @code{org-refile-targets}
5186 for details.  If you would like to select a location via a file-pathlike
5187 completion along the outline path, see the variable
5188 @code{org-refile-use-outline-path}.
5189 @kindex C-u C-c C-w
5190 @item C-u C-c C-w
5191 Use the refile interface to jump to a heading.
5192 @kindex C-u C-u C-c C-w
5193 @item C-u C-u C-c C-w
5194 Jump to the location where @code{org-refile} last moved a tree to.
5195 @end table
5197 @node Attachments,  , Remember, Capture
5198 @section Attachments
5199 @cindex attachments
5201 It is often useful to associate reference material with an outline node/task.
5202 Small chunks of plain text can simply be stored in the subtree of a project.
5203 Hyperlinks (@pxref{Hyperlinks}) can be used to establish associations with
5204 files that live elsewhere on your computer or in the cloud, like emails or
5205 source code files belonging to a project.  Another method is @i{attachments},
5206 which are files located in a directory belonging to an outline node.  Org
5207 uses directories named by the unique ID of each entry.  These directories are
5208 located in the @file{data} directory which lives in the same directory where
5209 your org-file lives@footnote{If you move entries or Org-files from one
5210 directory to the next, you may want to configure @code{org-attach-directory}
5211 to contain an absolute path.}.  If you initialize this directory with
5212 @code{git-init}, Org will automatically commit changes when it sees them.
5213 The attachment system has been contributed to Org by John Wiegley.
5215 @noindent The following commands deal with attachments.
5217 @table @kbd
5219 @kindex C-c C-a
5220 @item C-c C-a
5221 The dispatcher for commands related to the attachment system.  After these
5222 keys, a list of commands is displayed and you need to press an additional key
5223 to select a command:
5225 @table @kbd
5226 @kindex C-c C-a a 
5227 @item a 
5228 Select a file and move it into the task's attachment directory.  The file
5229 will be copied, moved, or linked, depending on @code{org-attach-method}.
5230 Note that hard links are not supported on all systems.
5232 @kindex C-c C-a c
5233 @kindex C-c C-a m 
5234 @kindex C-c C-a l 
5235 @item c/m/l
5236 Attach a file using the copy/move/link method.
5237 Note that hard links are not supported on all systems.
5239 @kindex C-c C-a n
5240 @item n
5241 Create a new attachment as an Emacs buffer.
5243 @kindex C-c C-a z
5244 @item z
5245 Synchronize the current task with its attachment directory, in case you added
5246 attachments yourself.
5248 @kindex C-c C-a o
5249 @item o
5250 Open current task's attachment.  If there are more than one, prompt for a
5251 file name first.  Opening will follow the rules set by @code{org-file-apps}.
5252 For more details, see the information on following hyperlings
5253 (@pxref{Handling links}).
5255 @kindex C-c C-a O
5256 @item O
5257 Also open the attachment, but force opening the file in Emacs.
5259 @kindex C-c C-a f
5260 @item f
5261 Open the current task's attachment directory.
5263 @kindex C-c C-a F
5264 @item F
5265 Also open the directory, but force using @code{dired} in Emacs.
5267 @kindex C-c C-a d
5268 @item d
5269 Select and delete a single attachment.
5271 @kindex C-c C-a D
5272 @item D
5273 Delete all of a task's attachments.  A safer way is to open the directory in
5274 dired and delete from there.
5275 @end table
5276 @end table
5278 @node Agenda Views, Embedded LaTeX, Capture, Top
5279 @chapter Agenda Views
5280 @cindex agenda views
5282 Due to the way Org works, TODO items, time-stamped items, and
5283 tagged headlines can be scattered throughout a file or even a number of
5284 files.  To get an overview of open action items, or of events that are
5285 important for a particular date, this information must be collected,
5286 sorted and displayed in an organized way.
5288 Org can select items based on various criteria, and display them
5289 in a separate buffer.  Seven different view types are provided:
5291 @itemize @bullet
5292 @item
5293 an @emph{agenda} that is like a calendar and shows information
5294 for specific dates,
5295 @item
5296 a @emph{TODO list} that covers all unfinished
5297 action items,
5298 @item
5299 a @emph{match view}, showings headlines based on the tags, properties and
5300 TODO state associated with them,
5301 @item
5302 a @emph{timeline view} that shows all events in a single Org file,
5303 in time-sorted view,
5304 @item
5305 a @emph{keyword search view} that shows all entries from multiple files
5306 that contain specified keywords.
5307 @item
5308 a @emph{stuck projects view} showing projects that currently don't move
5309 along, and
5310 @item
5311 @emph{custom views} that are special tag/keyword searches and
5312 combinations of different views.
5313 @end itemize
5315 @noindent
5316 The extracted information is displayed in a special @emph{agenda
5317 buffer}.  This buffer is read-only, but provides commands to visit the
5318 corresponding locations in the original Org files, and even to
5319 edit these files remotely.
5321 Two variables control how the agenda buffer is displayed and whether the
5322 window configuration is restored when the agenda exits:
5323 @code{org-agenda-window-setup} and
5324 @code{org-agenda-restore-windows-after-quit}.
5326 @menu
5327 * Agenda files::                Files being searched for agenda information
5328 * Agenda dispatcher::           Keyboard access to agenda views
5329 * Built-in agenda views::       What is available out of the box?
5330 * Presentation and sorting::    How agenda items are prepared for display
5331 * Agenda commands::             Remote editing of Org trees
5332 * Custom agenda views::         Defining special searches and views
5333 * Agenda column view::          Using column view for collected entries
5334 @end menu
5336 @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views
5337 @section Agenda files
5338 @cindex agenda files
5339 @cindex files for agenda
5341 The information to be shown is normally collected from all @emph{agenda
5342 files}, the files listed in the variable
5343 @code{org-agenda-files}@footnote{If the value of that variable is not a
5344 list, but a single file name, then the list of agenda files will be
5345 maintained in that external file.}. If a directory is part of this list,
5346 all files with the extension @file{.org} in this directory will be part
5347 of the list.
5349 Thus even if you only work with a single Org file, this file should
5350 be put into that list@footnote{When using the dispatcher, pressing
5351 @kbd{<} before selecting a command will actually limit the command to
5352 the current file, and ignore @code{org-agenda-files} until the next
5353 dispatcher command.}.  You can customize @code{org-agenda-files}, but
5354 the easiest way to maintain it is through the following commands
5356 @cindex files, adding to agenda list
5357 @table @kbd
5358 @kindex C-c [
5359 @item C-c [
5360 Add current file to the list of agenda files.  The file is added to
5361 the front of the list.  If it was already in the list, it is moved to
5362 the front.  With a prefix argument, file is added/moved to the end.
5363 @kindex C-c ]
5364 @item C-c ]
5365 Remove current file from the list of agenda files.
5366 @kindex C-,
5367 @kindex C-'
5368 @item C-,
5369 @itemx C-'
5370 Cycle through agenda file list, visiting one file after the other.
5371 @kindex M-x org-iswitchb
5372 @item M-x org-iswitchb
5373 Command to use an @code{iswitchb}-like interface to switch to and between Org
5374 buffers.
5375 @end table
5377 @noindent
5378 The Org menu contains the current list of files and can be used
5379 to visit any of them.
5381 If you would like to focus the agenda temporarily onto a file not in
5382 this list, or onto just one file in the list or even only a subtree in a
5383 file, this can be done in different ways.  For a single agenda command,
5384 you may press @kbd{<} once or several times in the dispatcher
5385 (@pxref{Agenda dispatcher}).  To restrict the agenda scope for an
5386 extended period, use the following commands:
5388 @table @kbd
5389 @kindex C-c C-x <
5390 @item C-c C-x <
5391 Permanently restrict the agenda to the current subtree.  When with a
5392 prefix argument, or with the cursor before the first headline in a file,
5393 the agenda scope is set to the entire file.  This restriction remains in
5394 effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
5395 or @kbd{>} in the agenda dispatcher.  If there is a window displaying an
5396 agenda view, the new restriction takes effect immediately.
5397 @kindex C-c C-x <
5398 @item C-c C-x <
5399 Remove the permanent restriction created by @kbd{C-c C-x <}.
5400 @end table
5402 @noindent
5403 When working with @file{Speedbar}, you can use the following commands in
5404 the Speedbar frame:
5405 @table @kbd
5406 @kindex <
5407 @item < @r{in the speedbar frame}
5408 Permanently restrict the agenda to the item at the cursor in the
5409 Speedbar frame, either an Org file or a subtree in such a file.
5410 If there is a window displaying an agenda view, the new restriction takes
5411 effect immediately.
5412 @kindex <
5413 @item > @r{in the speedbar frame}
5414 Lift the restriction again.
5415 @end table
5417 @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views
5418 @section The agenda dispatcher
5419 @cindex agenda dispatcher
5420 @cindex dispatching agenda commands
5421 The views are created through a dispatcher that should be bound to a
5422 global key, for example @kbd{C-c a} (@pxref{Installation}).  In the
5423 following we will assume that @kbd{C-c a} is indeed how the dispatcher
5424 is accessed and list keyboard access to commands accordingly.  After
5425 pressing @kbd{C-c a}, an additional letter is required to execute a
5426 command.  The dispatcher offers the following default commands:
5427 @table @kbd
5428 @item a
5429 Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
5430 @item t @r{/} T
5431 Create a list of all TODO items (@pxref{Global TODO list}).
5432 @item m @r{/} M
5433 Create a list of headlines matching a TAGS expression (@pxref{Matching
5434 tags and properties}).
5435 @item L
5436 Create the timeline view for the current buffer (@pxref{Timeline}).
5437 @item s
5438 Create a list of entries selected by a boolean expression of keywords
5439 and/or regular expressions that must or must not occur in the entry.
5440 @item /
5441 Search for a regular expression in all agenda files and additionally in
5442 the files listed in @code{org-agenda-multi-occur-extra-files}.  This
5443 uses the Emacs command @code{multi-occur}.  A prefix argument can be
5444 used to specify the number of context lines for each match, default is
5446 @item # @r{/} !
5447 Create a list of stuck projects (@pxref{Stuck projects}).
5448 @item <
5449 Restrict an agenda command to the current buffer@footnote{For backward
5450 compatibility, you can also press @kbd{1} to restrict to the current
5451 buffer.}.  After pressing @kbd{<}, you still need to press the character
5452 selecting the command.
5453 @item < <
5454 If there is an active region, restrict the following agenda command to
5455 the region.  Otherwise, restrict it to the current subtree@footnote{For
5456 backward compatibility, you can also press @kbd{0} to restrict to the
5457 current buffer.}.  After pressing @kbd{< <}, you still need to press the
5458 character selecting the command.
5459 @end table
5461 You can also define custom commands that will be accessible through the
5462 dispatcher, just like the default commands.  This includes the
5463 possibility to create extended agenda buffers that contain several
5464 blocks together, for example the weekly agenda, the global TODO list and
5465 a number of special tags matches.  @xref{Custom agenda views}.
5467 @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda Views
5468 @section The built-in agenda views
5470 In this section we describe the built-in views.
5472 @menu
5473 * Weekly/daily agenda::         The calendar page with current tasks
5474 * Global TODO list::            All unfinished action items
5475 * Matching tags and properties::  Structured information with fine-tuned search
5476 * Timeline::                    Time-sorted view for single file
5477 * Keyword search::              Finding entries by keyword
5478 * Stuck projects::              Find projects you need to review
5479 @end menu
5481 @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views
5482 @subsection The weekly/daily agenda
5483 @cindex agenda
5484 @cindex weekly agenda
5485 @cindex daily agenda
5487 The purpose of the weekly/daily @emph{agenda} is to act like a page of a
5488 paper agenda, showing all the tasks for the current week or day.
5490 @table @kbd
5491 @cindex org-agenda, command
5492 @kindex C-c a a
5493 @item C-c a a
5494 Compile an agenda for the current week from a list of org files.  The agenda
5495 shows the entries for each day.  With a numeric prefix@footnote{For backward
5496 compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
5497 listed before the agenda.  This feature is deprecated, use the dedicated TODO
5498 list, or a block agenda instead (@pxref{Block agenda}).}  (like @kbd{C-u 2 1
5499 C-c a a}) you may set the number of days to be displayed (see also the
5500 variable @code{org-agenda-ndays})
5501 @end table
5503 Remote editing from the agenda buffer means, for example, that you can
5504 change the dates of deadlines and appointments from the agenda buffer.
5505 The commands available in the Agenda buffer are listed in @ref{Agenda
5506 commands}.
5508 @subsubheading Calendar/Diary integration
5509 @cindex calendar integration
5510 @cindex diary integration
5512 Emacs contains the calendar and diary by Edward M. Reingold.  The
5513 calendar displays a three-month calendar with holidays from different
5514 countries and cultures.  The diary allows you to keep track of
5515 anniversaries, lunar phases, sunrise/set, recurrent appointments
5516 (weekly, monthly) and more.  In this way, it is quite complementary to
5517 Org.  It can be very useful to combine output from Org with
5518 the diary.
5520 In order to include entries from the Emacs diary into Org mode's
5521 agenda, you only need to customize the variable
5523 @lisp
5524 (setq org-agenda-include-diary t)
5525 @end lisp
5527 @noindent After that, everything will happen automatically.  All diary
5528 entries including holidays, anniversaries etc will be included in the
5529 agenda buffer created by Org mode.  @key{SPC}, @key{TAB}, and
5530 @key{RET} can be used from the agenda buffer to jump to the diary
5531 file in order to edit existing diary entries.  The @kbd{i} command to
5532 insert new entries for the current date works in the agenda buffer, as
5533 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
5534 Sunrise/Sunset times, show lunar phases and to convert to other
5535 calendars, respectively.  @kbd{c} can be used to switch back and forth
5536 between calendar and agenda.
5538 If you are using the diary only for sexp entries and holidays, it is
5539 faster to not use the above setting, but instead to copy or even move
5540 the entries into an Org file. Org mode evaluates diary-style sexp
5541 entries, and does it faster because there is no overhead for first
5542 creating the diary display.  Note that the sexp entries must start at
5543 the left margin, no white space is allowed before them.  For example,
5544 the following segment of an Org file will be processed and entries
5545 will be made in the agenda:
5547 @example
5548 * Birthdays and similar stuff
5549 #+CATEGORY: Holiday
5550 %%(org-calendar-holiday)   ; special function for holiday names
5551 #+CATEGORY: Ann
5552 %%(diary-anniversary 14  5 1956) Arthur Dent is %d years old
5553 %%(diary-anniversary  2 10 1869) Mahatma Gandhi would be %d years old
5554 @end example
5556 @subsubheading Appointment reminders
5557 @cindex @file{appt.el}
5558 @cindex appointment reminders
5560 Org can interact with Emacs appointments notification facility.
5562 To add all the appointments of your agenda files, use the command
5563 @code{org-agenda-to-appt}.  This commands also lets you filter through
5564 the list of your appointments and add only those belonging to a specific
5565 category or matching a regular expression. See the docstring for
5566 details.
5568 @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views
5569 @subsection The global TODO list
5570 @cindex global TODO list
5571 @cindex TODO list, global
5573 The global TODO list contains all unfinished TODO items, formatted and
5574 collected into a single place.
5576 @table @kbd
5577 @kindex C-c a t
5578 @item C-c a t
5579 Show the global TODO list.  This collects the TODO items from all
5580 agenda files (@pxref{Agenda Views}) into a single buffer.  The buffer is in
5581 @code{agenda-mode}, so there are commands to examine and manipulate
5582 the TODO entries directly from that buffer (@pxref{Agenda commands}).
5583 @kindex C-c a T
5584 @item C-c a T
5585 @cindex TODO keyword matching
5586 Like the above, but allows selection of a specific TODO keyword.  You
5587 can also do this by specifying a prefix argument to @kbd{C-c a t}.  With
5588 a @kbd{C-u} prefix you are prompted for a keyword, and you may also
5589 specify several keywords by separating them with @samp{|} as boolean OR
5590 operator.  With a numeric prefix, the Nth keyword in
5591 @code{org-todo-keywords} is selected.
5592 @kindex r
5593 The @kbd{r} key in the agenda buffer regenerates it, and you can give
5594 a prefix argument to this command to change the selected TODO keyword,
5595 for example @kbd{3 r}.  If you often need a search for a specific
5596 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
5597 Matching specific TODO keywords can also be done as part of a tags
5598 search (@pxref{Tag searches}).
5599 @end table
5601 Remote editing of TODO items means that you can change the state of a
5602 TODO entry with a single key press.  The commands available in the
5603 TODO list are described in @ref{Agenda commands}.
5605 @cindex sublevels, inclusion into TODO list
5606 Normally the global TODO list simply shows all headlines with TODO
5607 keywords.  This list can become very long.  There are two ways to keep
5608 it more compact:
5609 @itemize @minus
5610 @item
5611 Some people view a TODO item that has been @emph{scheduled} for
5612 execution (@pxref{Timestamps}) as no longer @emph{open}.  Configure the
5613 variable @code{org-agenda-todo-ignore-scheduled} to exclude scheduled
5614 items from the global TODO list.
5615 @item
5616 TODO items may have sublevels to break up the task into subtasks.  In
5617 such cases it may be enough to list only the highest level TODO headline
5618 and omit the sublevels from the global list.  Configure the variable
5619 @code{org-agenda-todo-list-sublevels} to get this behavior.
5620 @end itemize
5622 @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views
5623 @subsection Matching tags and properties
5624 @cindex matching, of tags
5625 @cindex matching, of properties
5626 @cindex tags view
5627 @cindex match view
5629 If headlines in the agenda files are marked with @emph{tags}
5630 (@pxref{Tags}), you can select headlines based on the tags that apply
5631 to them and collect them into an agenda buffer.
5633 @table @kbd
5634 @kindex C-c a m
5635 @item C-c a m
5636 Produce a list of all headlines that match a given set of tags.  The
5637 command prompts for a selection criterion, which is a boolean logic
5638 expression with tags, like @samp{+work+urgent-withboss} or
5639 @samp{work|home} (@pxref{Tags}).  If you often need a specific search,
5640 define a custom command for it (@pxref{Agenda dispatcher}).
5641 @kindex C-c a M
5642 @item C-c a M
5643 Like @kbd{C-c a m}, but only select headlines that are also TODO items
5644 and force checking subitems (see variable
5645 @code{org-tags-match-list-sublevels}).  Matching specific TODO keywords
5646 together with a tags match is also possible, see @ref{Tag searches}.
5647 @end table
5649 The commands available in the tags list are described in @ref{Agenda
5650 commands}.
5652 @node Timeline, Keyword search, Matching tags and properties, Built-in agenda views
5653 @subsection Timeline for a single file
5654 @cindex timeline, single file
5655 @cindex time-sorted view
5657 The timeline summarizes all time-stamped items from a single Org mode
5658 file in a @emph{time-sorted view}.  The main purpose of this command is
5659 to give an overview over events in a project.
5661 @table @kbd
5662 @kindex C-c a L
5663 @item C-c a L
5664 Show a time-sorted view of the org file, with all time-stamped items.
5665 When called with a @kbd{C-u} prefix, all unfinished TODO entries
5666 (scheduled or not) are also listed under the current date.
5667 @end table
5669 @noindent
5670 The commands available in the timeline buffer are listed in
5671 @ref{Agenda commands}.
5673 @node Keyword search, Stuck projects, Timeline, Built-in agenda views
5674 @subsection Keyword search
5675 @cindex keyword search
5676 @cindex searching, for keywords
5678 This agenda view is a general text search facility for Org mode entries.
5679 It is particularly useful to find notes.
5681 @table @kbd
5682 @kindex C-c a s
5683 @item C-c a s
5684 This is a special search that lets you select entries by keywords or
5685 regular expression, using a boolean logic.  For example, the search
5686 string
5688 @example
5689 +computer +wifi -ethernet -@{8\.11[bg]@}
5690 @end example
5692 @noindent
5693 will search for note entries that contain the keywords @code{computer}
5694 and @code{wifi}, but not the keyword @code{ethernet}, and which are also
5695 not matched by the regular expression @code{8\.11[bg]}, meaning to
5696 exclude both 8.11b and 8.11g.
5698 Note that in addition to the agenda files, this command will also search
5699 the files listed in @code{org-agenda-text-search-extra-files}.
5700 @end table
5702 @node Stuck projects,  , Keyword search, Built-in agenda views
5703 @subsection Stuck projects
5705 If you are following a system like David Allen's GTD to organize your
5706 work, one of the ``duties'' you have is a regular review to make sure
5707 that all projects move along.  A @emph{stuck} project is a project that
5708 has no defined next actions, so it will never show up in the TODO lists
5709 Org mode produces.  During the review, you need to identify such
5710 projects and define next actions for them.
5712 @table @kbd
5713 @kindex C-c a #
5714 @item C-c a #
5715 List projects that are stuck.
5716 @kindex C-c a !
5717 @item C-c a !
5718 Customize the variable @code{org-stuck-projects} to define what a stuck
5719 project is and how to find it.
5720 @end table
5722 You almost certainly will have to configure this view before it will
5723 work for you.  The built-in default assumes that all your projects are
5724 level-2 headlines, and that a project is not stuck if it has at least
5725 one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
5727 Let's assume that you, in your own way of using Org mode, identify
5728 projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
5729 indicate a project that should not be considered yet.  Let's further
5730 assume that the TODO keyword DONE marks finished projects, and that NEXT
5731 and TODO indicate next actions.  The tag @@SHOP indicates shopping and
5732 is a next action even without the NEXT tag.  Finally, if the project
5733 contains the special word IGNORE anywhere, it should not be listed
5734 either.  In this case you would start by identifying eligible projects
5735 with a tags/todo match @samp{+PROJECT/-MAYBE-DONE}, and then check for
5736 TODO, NEXT, @@SHOP, and IGNORE in the subtree to identify projects that
5737 are not stuck.  The correct customization for this is
5739 @lisp
5740 (setq org-stuck-projects
5741       '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
5742                                "\\<IGNORE\\>"))
5743 @end lisp
5746 @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views
5747 @section Presentation and sorting
5748 @cindex presentation, of agenda items
5750 Before displaying items in an agenda view, Org mode visually prepares
5751 the items and sorts them.  Each item occupies a single line.  The line
5752 starts with a @emph{prefix} that contains the @emph{category}
5753 (@pxref{Categories}) of the item and other important information.  You can
5754 customize the prefix using the option @code{org-agenda-prefix-format}.
5755 The prefix is followed by a cleaned-up version of the outline headline
5756 associated with the item.
5758 @menu
5759 * Categories::                  Not all tasks are equal
5760 * Time-of-day specifications::  How the agenda knows the time
5761 * Sorting of agenda items::     The order of things
5762 @end menu
5764 @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting
5765 @subsection Categories
5767 @cindex category
5768 The category is a broad label assigned to each agenda item.  By default,
5769 the category is simply derived from the file name, but you can also
5770 specify it with a special line in the buffer, like this@footnote{For
5771 backward compatibility, the following also works: If there are several
5772 such lines in a file, each specifies the category for the text below it.
5773 The first category also applies to any text before the first CATEGORY
5774 line.  However, using this method is @emph{strongly} deprecated as it is
5775 incompatible with the outline structure of the document.  The correct
5776 method for setting multiple categories in a buffer is using a
5777 property.}:
5779 @example
5780 #+CATEGORY: Thesis
5781 @end example
5783 @noindent
5784 If you would like to have a special CATEGORY for a single entry or a
5785 (sub)tree, give the entry a @code{:CATEGORY:} property with the location
5786 as the value (@pxref{Properties and Columns}).
5788 @noindent
5789 The display in the agenda buffer looks best if the category is not
5790 longer than 10 characters.
5792 @node Time-of-day specifications, Sorting of agenda items, Categories, Presentation and sorting
5793 @subsection Time-of-day specifications
5794 @cindex time-of-day specification
5796 Org mode checks each agenda item for a time-of-day specification.  The
5797 time can be part of the time stamp that triggered inclusion into the
5798 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}.  Time
5799 ranges can be specified with two time stamps, like
5801 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
5803 In the headline of the entry itself, a time(range) may also appear as
5804 plain text (like @samp{12:45} or a @samp{8:30-1pm}).  If the agenda
5805 integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
5806 specifications in diary entries are recognized as well.
5808 For agenda display, Org mode extracts the time and displays it in a
5809 standard 24 hour format as part of the prefix.  The example times in
5810 the previous paragraphs would end up in the agenda like this:
5812 @example
5813     8:30-13:00 Arthur Dent lies in front of the bulldozer
5814    12:45...... Ford Prefect arrives and takes Arthur to the pub
5815    19:00...... The Vogon reads his poem
5816    20:30-22:15 Marwin escorts the Hitchhikers to the bridge
5817 @end example
5819 @cindex time grid
5820 If the agenda is in single-day mode, or for the display of today, the
5821 timed entries are embedded in a time grid, like
5823 @example
5824     8:00...... ------------------
5825     8:30-13:00 Arthur Dent lies in front of the bulldozer
5826    10:00...... ------------------
5827    12:00...... ------------------
5828    12:45...... Ford Prefect arrives and takes Arthur to the pub
5829    14:00...... ------------------
5830    16:00...... ------------------
5831    18:00...... ------------------
5832    19:00...... The Vogon reads his poem
5833    20:00...... ------------------
5834    20:30-22:15 Marwin escorts the Hitchhikers to the bridge
5835 @end example
5837 The time grid can be turned on and off with the variable
5838 @code{org-agenda-use-time-grid}, and can be configured with
5839 @code{org-agenda-time-grid}.
5841 @node Sorting of agenda items,  , Time-of-day specifications, Presentation and sorting
5842 @subsection Sorting of agenda items
5843 @cindex sorting, of agenda items
5844 @cindex priorities, of agenda items
5845 Before being inserted into a view, the items are sorted.  How this is
5846 done depends on the type of view.
5847 @itemize @bullet
5848 @item
5849 For the daily/weekly agenda, the items for each day are sorted.  The
5850 default order is to first collect all items containing an explicit
5851 time-of-day specification.  These entries will be shown at the beginning
5852 of the list, as a @emph{schedule} for the day.  After that, items remain
5853 grouped in categories, in the sequence given by @code{org-agenda-files}.
5854 Within each category, items are sorted by priority (@pxref{Priorities}),
5855 which is composed of the base priority (2000 for priority @samp{A}, 1000
5856 for @samp{B}, and 0 for @samp{C}), plus additional increments for
5857 overdue scheduled or deadline items.
5858 @item
5859 For the TODO list, items remain in the order of categories, but within
5860 each category, sorting takes place according to priority
5861 (@pxref{Priorities}).
5862 @item
5863 For tags matches, items are not sorted at all, but just appear in the
5864 sequence in which they are found in the agenda files.
5865 @end itemize
5867 Sorting can be customized using the variable
5868 @code{org-agenda-sorting-strategy}, and may also include criteria based on
5869 the estimated effort of an entry (@pxref{Effort estimates}).
5871 @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda Views
5872 @section Commands in the agenda buffer
5873 @cindex commands, in agenda buffer
5875 Entries in the agenda buffer are linked back to the org file or diary
5876 file where they originate.  You are not allowed to edit the agenda
5877 buffer itself, but commands are provided to show and jump to the
5878 original entry location, and to edit the org-files ``remotely'' from
5879 the agenda buffer.  In this way, all information is stored only once,
5880 removing the risk that your agenda and note files may diverge.
5882 Some commands can be executed with mouse clicks on agenda lines.  For
5883 the other commands, the cursor needs to be in the desired line.
5885 @table @kbd
5886 @tsubheading{Motion}
5887 @cindex motion commands in agenda
5888 @kindex n
5889 @item n
5890 Next line (same as @key{up} and @kbd{C-p}).
5891 @kindex p
5892 @item p
5893 Previous line (same as @key{down} and @kbd{C-n}).
5894 @tsubheading{View/Go to org file}
5895 @kindex mouse-3
5896 @kindex @key{SPC}
5897 @item mouse-3
5898 @itemx @key{SPC}
5899 Display the original location of the item in another window.
5901 @kindex L
5902 @item L
5903 Display original location and recenter that window.
5905 @kindex mouse-2
5906 @kindex mouse-1
5907 @kindex @key{TAB}
5908 @item mouse-2
5909 @itemx mouse-1
5910 @itemx @key{TAB}
5911 Go to the original location of the item in another window.  Under Emacs
5912 22, @kbd{mouse-1} will also works for this.
5914 @kindex @key{RET}
5915 @itemx @key{RET}
5916 Go to the original location of the item and delete other windows.
5918 @kindex f
5919 @item f
5920 Toggle Follow mode.  In Follow mode, as you move the cursor through
5921 the agenda buffer, the other window always shows the corresponding
5922 location in the org file.  The initial setting for this mode in new
5923 agenda buffers can be set with the variable
5924 @code{org-agenda-start-with-follow-mode}.
5926 @kindex b
5927 @item b
5928 Display the entire subtree of the current item in an indirect buffer.  With a
5929 numeric prefix argument N, go up to level N and then take that tree.  If N is
5930 negative, go up that many levels.  With a @kbd{C-u} prefix, do not remove the
5931 previously used indirect buffer.
5933 @kindex l
5934 @item l
5935 Toggle Logbook mode.  In Logbook mode, entries that where marked DONE while
5936 logging was on (variable @code{org-log-done}) are shown in the agenda, as are
5937 entries that have been clocked on that day.  You can configure the entry
5938 types that should be included in log mode using the variable
5939 @code{org-agenda-log-mode-items}.  When called with a @kbd{C-u} prefix, show
5940 all possible logbook entries, including state changes.
5942 @kindex v
5943 @item v
5944 Toggle Archives mode.  In archives mode, trees that are marked are also
5945 scanned when producing the agenda.  When you call this command with a
5946 @kbd{C-u} prefix argument, even all archive files are included.  To exit
5947 archives mode, press @kbd{v} again.
5949 @kindex R
5950 @item R
5951 Toggle Clockreport mode.  In clockreport mode, the daily/weekly agenda will
5952 always show a table with the clocked times for the timespan and file scope
5953 covered by the current agenda view.  The initial setting for this mode in new
5954 agenda buffers can be set with the variable
5955 @code{org-agenda-start-with-clockreport-mode}.
5957 @tsubheading{Change display}
5958 @cindex display changing, in agenda
5959 @kindex o
5960 @item o
5961 Delete other windows.
5963 @kindex d
5964 @kindex w
5965 @kindex m
5966 @kindex y
5967 @item d w m y
5968 Switch to day/week/month/year view.  When switching to day or week view,
5969 this setting becomes the default for subsequent agenda commands.  Since
5970 month and year views are slow to create, they do not become the default.
5971 A numeric prefix argument may be used to jump directly to a specific day
5972 of the year, ISO week, month, or year, respectively.  For example,
5973 @kbd{32 d} jumps to February 1st, @kbd{9 w} to ISO week number 9.  When
5974 setting day, week, or month view, a year may be encoded in the prefix
5975 argument as well.  For example, @kbd{200712 w} will jump to week 12 in
5976 2007.  If such a year specification has only one or two digits, it will
5977 be mapped to the interval 1938-2037.
5979 @kindex D
5980 @item D
5981 Toggle the inclusion of diary entries.  See @ref{Weekly/daily agenda}.
5983 @kindex G
5984 @item G
5985 Toggle the time grid on and off.  See also the variables
5986 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
5988 @kindex r
5989 @item r
5990 Recreate the agenda buffer, for example to reflect the changes
5991 after modification of the time stamps of items with S-@key{left} and
5992 S-@key{right}.  When the buffer is the global TODO list, a prefix
5993 argument is interpreted to create a selective list for a specific TODO
5994 keyword.
5995 @kindex g
5996 @item g
5997 Same as @kbd{r}.
5999 @kindex s
6000 @kindex C-x C-s
6001 @item s
6002 @itemx C-x C-s
6003 Save all Org buffers in the current Emacs session.
6005 @kindex @key{right}
6006 @item @key{right}
6007 Display the following @code{org-agenda-ndays} days.  For example, if
6008 the display covers a week, switch to the following week.  With prefix
6009 arg, go forward that many times @code{org-agenda-ndays} days.
6011 @kindex @key{left}
6012 @item @key{left}
6013 Display the previous dates.
6015 @kindex .
6016 @item .
6017 Go to today.
6019 @kindex C-c C-x C-c
6020 @item C-c C-x C-c
6021 Invoke column view (@pxref{Column view}) in the agenda buffer.  The column
6022 view format is taken from the entry at point, or (if there is no entry at
6023 point), from the first entry in the agenda view.  So whatever the format for
6024 that entry would be in the original buffer (taken from a property, from a
6025 @code{#+COLUMNS} line, or from the default variable
6026 @code{org-columns-default-format}), will be used in the agenda.
6028 @tsubheading{Secondary filtering and query editing}
6029 @cindex filtering, by tag and effort, in agenda
6030 @cindex tag filtering, in agenda
6031 @cindex effort filtering, in agenda
6032 @cindex query editing, in agenda
6034 @kindex /
6035 @item /
6036 Filter the current agenda view with respect to a tag and/or effort estimates.
6037 The difference between this and a custom agenda commands is that filtering is
6038 very fast, so that you can switch quickly between different filters without
6039 having to recreate the agenda.
6041 You will be prompted for a tag selection letter.  Pressing @key{TAB} at that
6042 prompt will offer use completion to select a tag (including any tags that do
6043 not have a selection character).  The command then hides all entries that do
6044 not contain or inherit this tag.  When called with prefix arg, remove the
6045 entries that @emph{do} have the tag.  A second @kbd{/} at the prompt will
6046 turn off the filter and unhide any hidden entries.  If the first key you
6047 press is either @kbd{+} or @kbd{-}, the previous filter will be narrowed by
6048 requiring or forbidding the selected additional tag.  Instead of pressing
6049 @kbd{+} or @kbd{-}, you can also use the @kbd{\} command.
6051 In order to filter for effort estimates, you should set-up allowed
6052 efforts globally, for example
6053 @lisp
6054 (setq org-global-properties
6055     '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
6056 @end lisp
6057 You can then filter for an effort by first typing an operator, one of @kbd{<},
6058 @kbd{>}, and @kbd{=}, and then the one-digit index of an effort estimate in
6059 your array of allowed values, where @kbd{0} means the 10th value.  The filter
6060 will then restrict to entries with effort smaller-or-equal, equal, or
6061 larger-or-equal than the selected value.  If the digits 0-9 are not used as
6062 fast access keys to tags, you can also simply press the index digit directly
6063 without an operator.  In this case, @kbd{<} will be assumed.
6065 @kindex \
6066 @item \
6067 Narrow the current agenda filter by an additional condition.  When called with
6068 prefix arg, remove the entries that @emph{do} have the tag, or that do match
6069 the effort criterion.  You can achieve the same effect by pressing @kbd{+} or
6070 @kbd{-} as the first key after the @kbd{/} command.
6072 @kindex [
6073 @kindex ]
6074 @kindex @{
6075 @kindex @}
6076 @item [ ] @{ @}
6077 In the @i{search view} (@pxref{Keyword search}), these keys add new search
6078 words (@kbd{[} and @kbd{]}) or new regular expressions (@kbd{@{} and
6079 @kbd{@}}) to the query string.  The opening bracket/brace will add a positive
6080 search term prefixed by @samp{+}, indicating that this search term @i{must}
6081 occur/match in the entry.  The closing bracket/brace will add a negative
6082 search term which @i{must not} occur/match in the entry for it to be
6083 selected.
6086 @tsubheading{Remote editing}
6087 @cindex remote editing, from agenda
6089 @item 0-9
6090 Digit argument.
6092 @cindex undoing remote-editing events
6093 @cindex remote editing, undo
6094 @kindex C-_
6095 @item C-_
6096 Undo a change due to a remote editing command.  The change is undone
6097 both in the agenda buffer and in the remote buffer.
6099 @kindex t
6100 @item t
6101 Change the TODO state of the item, both in the agenda and in the
6102 original org file.
6104 @kindex C-k
6105 @item C-k
6106 Delete the current agenda item along with the entire subtree belonging
6107 to it in the original Org file.  If the text to be deleted remotely
6108 is longer than one line, the kill needs to be confirmed by the user.  See
6109 variable @code{org-agenda-confirm-kill}.
6111 @kindex a
6112 @item a
6113 Toggle the ARCHIVE tag for the current headline.
6115 @kindex A
6116 @item A
6117 Move the subtree corresponding to the current entry to its @emph{Archive
6118 Sibling}.
6120 @kindex $
6121 @item $
6122 Archive the subtree corresponding to the current headline.  This means the
6123 entry will be moved to the configured archive location, most likely a
6124 different file.
6126 @kindex T
6127 @item T
6128 Show all tags associated with the current item.  Because of
6129 inheritance, this may be more than the tags listed in the line itself.
6131 @kindex :
6132 @item :
6133 Set tags for the current headline.  If there is an active region in the
6134 agenda, change a tag for all headings in the region.
6136 @kindex ,
6137 @item ,
6138 Set the priority for the current item.  Org mode prompts for the
6139 priority character. If you reply with @key{SPC}, the priority cookie
6140 is removed from the entry.
6142 @kindex P
6143 @item P
6144 Display weighted priority of current item.
6146 @kindex +
6147 @kindex S-@key{up}
6148 @item +
6149 @itemx S-@key{up}
6150 Increase the priority of the current item.  The priority is changed in
6151 the original buffer, but the agenda is not resorted.  Use the @kbd{r}
6152 key for this.
6154 @kindex -
6155 @kindex S-@key{down}
6156 @item -
6157 @itemx S-@key{down}
6158 Decrease the priority of the current item.
6160 @kindex C-c C-a
6161 @item C-c C-a
6162 Dispatcher for all command related to attachments.
6164 @kindex C-c C-s
6165 @item C-c C-s
6166 Schedule this item
6168 @kindex C-c C-d
6169 @item C-c C-d
6170 Set a deadline for this item.
6172 @kindex k
6173 @item k
6174 Agenda actions, to set dates for selected items to the cursor date.
6175 This command also works in the calendar!  The command prompts for an
6176 additonal key:
6177 @example
6178 m   @r{Mark the entry at point for action.  You can also make entries}
6179     @r{in Org files with @kbd{C-c C-x C-k}.}
6180 d   @r{Set the deadline of the marked entry to the date at point.}
6181 s   @r{Schedule the marked entry at the date at point.}
6182 r   @r{Call @code{org-remember} with the cursor date as default date.}
6183 @end example
6184 Press @kbd{r} afterwards to refresh the agenda and see the effect of the
6185 command.
6187 @kindex S-@key{right}
6188 @item S-@key{right}
6189 Change the time stamp associated with the current line by one day into the
6190 future.  With a numeric prefix argument, change it by that many days.  For
6191 example, @kbd{3 6 5 S-@key{right}} will change it by a year.  The stamp is
6192 changed in the original org file, but the change is not directly reflected in
6193 the agenda buffer.  Use the @kbd{r} key to update the buffer.
6195 @kindex S-@key{left}
6196 @item S-@key{left}
6197 Change the time stamp associated with the current line by one day
6198 into the past.
6200 @kindex >
6201 @item >
6202 Change the time stamp associated with the current line to today.
6203 The key @kbd{>} has been chosen, because it is the same as @kbd{S-.}
6204 on my keyboard.
6206 @kindex I
6207 @item I
6208 Start the clock on the current item.  If a clock is running already, it
6209 is stopped first.
6211 @kindex O
6212 @item O
6213 Stop the previously started clock.
6215 @kindex X
6216 @item X
6217 Cancel the currently running clock.
6219 @kindex J
6220 @item J
6221 Jump to the running clock in another window.
6223 @tsubheading{Calendar commands}
6224 @cindex calendar commands, from agenda
6225 @kindex c
6226 @item c
6227 Open the Emacs calendar and move to the date at the agenda cursor.
6229 @item c
6230 When in the calendar, compute and show the Org mode agenda for the
6231 date at the cursor.
6233 @cindex diary entries, creating from agenda
6234 @kindex i
6235 @item i
6236 Insert a new entry into the diary.  Prompts for the type of entry
6237 (day, weekly, monthly, yearly, anniversary, cyclic) and creates a new
6238 entry in the diary, just as @kbd{i d} etc. would do in the calendar.
6239 The date is taken from the cursor position.
6241 @kindex M
6242 @item M
6243 Show the phases of the moon for the three months around current date.
6245 @kindex S
6246 @item S
6247 Show sunrise and sunset times.  The geographical location must be set
6248 with calendar variables, see documentation of the Emacs calendar.
6250 @kindex C
6251 @item C
6252 Convert the date at cursor into many other cultural and historic
6253 calendars.
6255 @kindex H
6256 @item H
6257 Show holidays for three month around the cursor date.
6259 @item M-x org-export-icalendar-combine-agenda-files
6260 Export a single iCalendar file containing entries from all agenda files.
6261 This is a globally available command, and also available in the agenda menu.
6263 @tsubheading{Exporting to a file}
6264 @kindex C-x C-w
6265 @item C-x C-w
6266 @cindex exporting agenda views
6267 @cindex agenda views, exporting
6268 Write the agenda view to a file.  Depending on the extension of the
6269 selected file name, the view will be exported as HTML (extension
6270 @file{.html} or @file{.htm}), Postscript (extension @file{.ps}), or
6271 plain text (any other extension).  Use the variable
6272 @code{org-agenda-exporter-settings} to set options for @file{ps-print}
6273 and for @file{htmlize} to be used during export.
6275 @tsubheading{Quit and Exit}
6276 @kindex q
6277 @item q
6278 Quit agenda, remove the agenda buffer.
6280 @kindex x
6281 @cindex agenda files, removing buffers
6282 @item x
6283 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
6284 for the compilation of the agenda.  Buffers created by the user to
6285 visit org files will not be removed.
6286 @end table
6289 @node Custom agenda views, Agenda column view, Agenda commands, Agenda Views
6290 @section Custom agenda views
6291 @cindex custom agenda views
6292 @cindex agenda views, custom
6294 Custom agenda commands serve two purposes: to store and quickly access
6295 frequently used TODO and tags searches, and to create special composite
6296 agenda buffers.  Custom agenda commands will be accessible through the
6297 dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
6299 @menu
6300 * Storing searches::            Type once, use often
6301 * Block agenda::                All the stuff you need in a single buffer
6302 * Setting Options::             Changing the rules
6303 * Exporting Agenda Views::      Writing agendas to files
6304 * Using the agenda elsewhere::  Using agenda information in other programs
6305 @end menu
6307 @node Storing searches, Block agenda, Custom agenda views, Custom agenda views
6308 @subsection Storing searches
6310 The first application of custom searches is the definition of keyboard
6311 shortcuts for frequently used searches, either creating an agenda
6312 buffer, or a sparse tree (the latter covering of course only the current
6313 buffer).
6314 @kindex C-c a C
6315 Custom commands are configured in the variable
6316 @code{org-agenda-custom-commands}.  You can customize this variable, for
6317 example by pressing @kbd{C-c a C}.  You can also directly set it with
6318 Emacs Lisp in @file{.emacs}.  The following example contains all valid
6319 search types:
6321 @lisp
6322 @group
6323 (setq org-agenda-custom-commands
6324       '(("w" todo "WAITING")
6325         ("W" todo-tree "WAITING")
6326         ("u" tags "+boss-urgent")
6327         ("v" tags-todo "+boss-urgent")
6328         ("U" tags-tree "+boss-urgent")
6329         ("f" occur-tree "\\<FIXME\\>")
6330         ("h" . "HOME+Name tags searches") ; description for "h" prefix
6331         ("hl" tags "+home+Lisa")
6332         ("hp" tags "+home+Peter")
6333         ("hk" tags "+home+Kim")))
6334 @end group
6335 @end lisp
6337 @noindent
6338 The initial string in each entry defines the keys you have to press
6339 after the dispatcher command @kbd{C-c a} in order to access the command.
6340 Usually this will be just a single character, but if you have many
6341 similar commands, you can also define two-letter combinations where the
6342 first character is the same in several combinations and serves as a
6343 prefix key@footnote{You can provide a description for a prefix key by
6344 inserting a cons cell with the prefix and the description.}.  The second
6345 parameter is the search type, followed by the string or regular
6346 expression to be used for the matching.  The example above will
6347 therefore define:
6349 @table @kbd
6350 @item C-c a w
6351 as a global search for TODO entries with @samp{WAITING} as the TODO
6352 keyword
6353 @item C-c a W
6354 as the same search, but only in the current buffer and displaying the
6355 results as a sparse tree
6356 @item C-c a u
6357 as a global tags search for headlines marked @samp{:boss:} but not
6358 @samp{:urgent:}
6359 @item C-c a v
6360 as the same search as @kbd{C-c a u}, but limiting the search to
6361 headlines that are also TODO items
6362 @item C-c a U
6363 as the same search as @kbd{C-c a u}, but only in the current buffer and
6364 displaying the result as a sparse tree
6365 @item C-c a f
6366 to create a sparse tree (again: current buffer only) with all entries
6367 containing the word @samp{FIXME}
6368 @item C-c a h
6369 as a prefix command for a HOME tags search where you have to press an
6370 additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
6371 Peter, or Kim) as additional tag to match.
6372 @end table
6374 @node Block agenda, Setting Options, Storing searches, Custom agenda views
6375 @subsection Block agenda
6376 @cindex block agenda
6377 @cindex agenda, with block views
6379 Another possibility is the construction of agenda views that comprise
6380 the results of @emph{several} commands, each of which creates a block in
6381 the agenda buffer.  The available commands include @code{agenda} for the
6382 daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
6383 for the global TODO list (as constructed with @kbd{C-c a t}), and the
6384 matching commands discussed above: @code{todo}, @code{tags}, and
6385 @code{tags-todo}.  Here are two examples:
6387 @lisp
6388 @group
6389 (setq org-agenda-custom-commands
6390       '(("h" "Agenda and Home-related tasks"
6391          ((agenda "")
6392           (tags-todo "home")
6393           (tags "garden")))
6394         ("o" "Agenda and Office-related tasks"
6395          ((agenda "")
6396           (tags-todo "work")
6397           (tags "office")))))
6398 @end group
6399 @end lisp
6401 @noindent
6402 This will define @kbd{C-c a h} to create a multi-block view for stuff
6403 you need to attend to at home.  The resulting agenda buffer will contain
6404 your agenda for the current week, all TODO items that carry the tag
6405 @samp{home}, and also all lines tagged with @samp{garden}.  Finally the
6406 command @kbd{C-c a o} provides a similar view for office tasks.
6408 @node Setting Options, Exporting Agenda Views, Block agenda, Custom agenda views
6409 @subsection Setting options for custom commands
6410 @cindex options, for custom agenda views
6412 Org mode contains a number of variables regulating agenda construction
6413 and display.  The global variables define the behavior for all agenda
6414 commands, including the custom commands.  However, if you want to change
6415 some settings just for a single custom view, you can do so.  Setting
6416 options requires inserting a list of variable names and values at the
6417 right spot in @code{org-agenda-custom-commands}.  For example:
6419 @lisp
6420 @group
6421 (setq org-agenda-custom-commands
6422       '(("w" todo "WAITING"
6423          ((org-agenda-sorting-strategy '(priority-down))
6424           (org-agenda-prefix-format "  Mixed: ")))
6425         ("U" tags-tree "+boss-urgent"
6426          ((org-show-following-heading nil)
6427           (org-show-hierarchy-above nil)))
6428         ("N" search ""
6429          ((org-agenda-files '("~org/notes.org"))
6430           (org-agenda-text-search-extra-files nil)))))
6431 @end group
6432 @end lisp
6434 @noindent
6435 Now the @kbd{C-c a w} command will sort the collected entries only by
6436 priority, and the prefix format is modified to just say @samp{  Mixed: }
6437 instead of giving the category of the entry.  The sparse tags tree of
6438 @kbd{C-c a U} will now turn out ultra-compact, because neither the
6439 headline hierarchy above the match, nor the headline following the match
6440 will be shown.  The command @kbd{C-c a N} will do a text search limited
6441 to only a single file.
6443 For command sets creating a block agenda,
6444 @code{org-agenda-custom-commands} has two separate spots for setting
6445 options.  You can add options that should be valid for just a single
6446 command in the set, and options that should be valid for all commands in
6447 the set.  The former are just added to the command entry, the latter
6448 must come after the list of command entries.  Going back to the block
6449 agenda example (@pxref{Block agenda}), let's change the sorting strategy
6450 for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
6451 the results for GARDEN tags query in the opposite order,
6452 @code{priority-up}.  This would look like this:
6454 @lisp
6455 @group
6456 (setq org-agenda-custom-commands
6457       '(("h" "Agenda and Home-related tasks"
6458          ((agenda)
6459           (tags-todo "home")
6460           (tags "garden"
6461                 ((org-agenda-sorting-strategy '(priority-up)))))
6462          ((org-agenda-sorting-strategy '(priority-down))))
6463         ("o" "Agenda and Office-related tasks"
6464          ((agenda)
6465           (tags-todo "work")
6466           (tags "office")))))
6467 @end group
6468 @end lisp
6470 As you see, the values and parenthesis setting is a little complex.
6471 When in doubt, use the customize interface to set this variable - it
6472 fully supports its structure.  Just one caveat: When setting options in
6473 this interface, the @emph{values} are just lisp expressions.  So if the
6474 value is a string, you need to add the double quotes around the value
6475 yourself.
6478 @node Exporting Agenda Views, Using the agenda elsewhere, Setting Options, Custom agenda views
6479 @subsection Exporting Agenda Views
6480 @cindex agenda views, exporting
6482 If you are away from your computer, it can be very useful to have a
6483 printed version of some agenda views to carry around.  Org mode can
6484 export custom agenda views as plain text, HTML@footnote{You need to
6485 install Hrvoje Niksic' @file{htmlize.el}.} postscript, and iCalendar
6486 files.  If you want to do this only occasionally, use the command
6488 @table @kbd
6489 @kindex C-x C-w
6490 @item C-x C-w
6491 @cindex exporting agenda views
6492 @cindex agenda views, exporting
6493 Write the agenda view to a file.  Depending on the extension of the
6494 selected file name, the view will be exported as HTML (extension
6495 @file{.html} or @file{.htm}), Postscript (extension @file{.ps}),
6496 iCalendar (extension @file{.ics}), or plain text (any other extension).
6497 Use the variable @code{org-agenda-exporter-settings} to
6498 set options for @file{ps-print} and for @file{htmlize} to be used during
6499 export, for example
6501 @lisp
6502 (setq org-agenda-exporter-settings
6503       '((ps-number-of-columns 2)
6504         (ps-landscape-mode t)
6505         (htmlize-output-type 'css)))
6506 @end lisp
6507 @end table
6509 If you need to export certain agenda views frequently, you can associate
6510 any custom agenda command with a list of output file names
6511 @footnote{If you want to store standard views like the weekly agenda
6512 or the global TODO list as well, you need to define custom commands for
6513 them in order to be able to specify file names.}.  Here is an example
6514 that first does define custom commands for the agenda and the global
6515 todo list, together with a number of files to which to export them.
6516 Then we define two block agenda commands and specify file names for them
6517 as well.  File names can be relative to the current working directory,
6518 or absolute.
6520 @lisp
6521 @group
6522 (setq org-agenda-custom-commands
6523       '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
6524         ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
6525         ("h" "Agenda and Home-related tasks"
6526          ((agenda "")
6527           (tags-todo "home")
6528           (tags "garden"))
6529          nil
6530          ("~/views/home.html"))
6531         ("o" "Agenda and Office-related tasks"
6532          ((agenda)
6533           (tags-todo "work")
6534           (tags "office"))
6535          nil
6536          ("~/views/office.ps" "~/calendars/office.ics"))))
6537 @end group
6538 @end lisp
6540 The extension of the file name determines the type of export.  If it is
6541 @file{.html}, Org mode will use the @file{htmlize.el} package to convert
6542 the buffer to HTML and save it to this file name.  If the extension is
6543 @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
6544 postscript output.  If the extension is @file{.ics}, iCalendar export is
6545 run export over all files that were used to construct the agenda, and
6546 limit the export to entries listed in the agenda now.  Any other
6547 extension produces a plain ASCII file.
6549 The export files are @emph{not} created when you use one of those
6550 commands interactively because this might use too much overhead.
6551 Instead, there is a special command to produce @emph{all} specified
6552 files in one step:
6554 @table @kbd
6555 @kindex C-c a e
6556 @item C-c a e
6557 Export all agenda views that have export file names associated with
6558 them.
6559 @end table
6561 You can use the options section of the custom agenda commands to also
6562 set options for the export commands.  For example:
6564 @lisp
6565 (setq org-agenda-custom-commands
6566       '(("X" agenda ""
6567          ((ps-number-of-columns 2)
6568           (ps-landscape-mode t)
6569           (org-agenda-prefix-format " [ ] ")
6570           (org-agenda-with-colors nil)
6571           (org-agenda-remove-tags t))
6572          ("theagenda.ps"))))
6573 @end lisp
6575 @noindent
6576 This command sets two options for the postscript exporter, to make it
6577 print in two columns in landscape format - the resulting page can be cut
6578 in two and then used in a paper agenda.  The remaining settings modify
6579 the agenda prefix to omit category and scheduling information, and
6580 instead include a checkbox to check off items.  We also remove the tags
6581 to make the lines compact, and we don't want to use colors for the
6582 black-and-white printer.  Settings specified in
6583 @code{org-agenda-exporter-settings} will also apply, but the settings
6584 in @code{org-agenda-custom-commands} take precedence.
6586 @noindent
6587 From the command line you may also use
6588 @example
6589 emacs -f org-batch-store-agenda-views -kill
6590 @end example
6591 @noindent
6592 or, if you need to modify some parameters@footnote{Quoting may depend on the
6593 system you use, please check th FAQ for examples.}
6594 @example
6595 emacs -eval '(org-batch-store-agenda-views                      \
6596               org-agenda-ndays 30                               \
6597               org-agenda-start-day "2007-11-01"                 \
6598               org-agenda-include-diary nil                      \
6599               org-agenda-files (quote ("~/org/project.org")))'  \
6600       -kill
6601 @end example
6602 @noindent
6603 which will create the agenda views restricted to the file
6604 @file{~/org/project.org}, without diary entries and with 30 days
6605 extent.
6607 @node Using the agenda elsewhere,  , Exporting Agenda Views, Custom agenda views
6608 @subsection Using agenda information outside of Org
6609 @cindex agenda, pipe
6610 @cindex Scripts, for agenda processing
6612 Org provides commands to access agenda information for the command
6613 line in emacs batch mode.  This extracted information can be sent
6614 directly to a printer, or it can be read by a program that does further
6615 processing of the data.  The first of these commands is the function
6616 @code{org-batch-agenda}, that produces an agenda view and sends it as
6617 ASCII text to STDOUT.  The command takes a single string as parameter.
6618 If the string has length 1, it is used as a key to one of the commands
6619 you have configured in @code{org-agenda-custom-commands}, basically any
6620 key you can use after @kbd{C-c a}.  For example, to directly print the
6621 current TODO list, you could use
6623 @example
6624 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
6625 @end example
6627 If the parameter is a string with 2 or more characters, it is used as a
6628 tags/todo match string.  For example, to print your local shopping list
6629 (all items with the tag @samp{shop}, but excluding the tag
6630 @samp{NewYork}), you could use
6632 @example
6633 emacs -batch -l ~/.emacs                                      \
6634       -eval '(org-batch-agenda "+shop-NewYork")' | lpr
6635 @end example
6637 @noindent
6638 You may also modify parameters on the fly like this:
6640 @example
6641 emacs -batch -l ~/.emacs                                      \
6642    -eval '(org-batch-agenda "a"                               \
6643             org-agenda-ndays 30                               \
6644             org-agenda-include-diary nil                      \
6645             org-agenda-files (quote ("~/org/project.org")))'  \
6646    | lpr
6647 @end example
6649 @noindent
6650 which will produce a 30 day agenda, fully restricted to the Org file
6651 @file{~/org/projects.org}, not even including the diary.
6653 If you want to process the agenda data in more sophisticated ways, you
6654 can use the command @code{org-batch-agenda-csv} to get a comma-separated
6655 list of values for each agenda item.  Each line in the output will
6656 contain a number of fields separated by commas.  The fields in a line
6657 are:
6659 @example
6660 category     @r{The category of the item}
6661 head         @r{The headline, without TODO kwd, TAGS and PRIORITY}
6662 type         @r{The type of the agenda entry, can be}
6663                 todo               @r{selected in TODO match}
6664                 tagsmatch          @r{selected in tags match}
6665                 diary              @r{imported from diary}
6666                 deadline           @r{a deadline}
6667                 scheduled          @r{scheduled}
6668                 timestamp          @r{appointment, selected by timestamp}
6669                 closed             @r{entry was closed on date}
6670                 upcoming-deadline  @r{warning about nearing deadline}
6671                 past-scheduled     @r{forwarded scheduled item}
6672                 block              @r{entry has date block including date}
6673 todo         @r{The TODO keyword, if any}
6674 tags         @r{All tags including inherited ones, separated by colons}
6675 date         @r{The relevant date, like 2007-2-14}
6676 time         @r{The time, like 15:00-16:50}
6677 extra        @r{String with extra planning info}
6678 priority-l   @r{The priority letter if any was given}
6679 priority-n   @r{The computed numerical priority}
6680 @end example
6682 @noindent
6683 Time and date will only be given if a timestamp (or deadline/scheduled)
6684 lead to the selection of the item.
6686 A CSV list like this is very easy to use in a post processing script.
6687 For example, here is a Perl program that gets the TODO list from
6688 Emacs/Org and prints all the items, preceded by a checkbox:
6690 @example
6691 @group
6692 #!/usr/bin/perl
6694 # define the Emacs command to run
6695 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
6697 # run it and capture the output
6698 $agenda = qx@{$cmd 2>/dev/null@};
6700 # loop over all lines
6701 foreach $line (split(/\n/,$agenda)) @{
6703   # get the individual values
6704   ($category,$head,$type,$todo,$tags,$date,$time,$extra,
6705    $priority_l,$priority_n) = split(/,/,$line);
6707   # proccess and print
6708   print "[ ] $head\n";
6710 @end group
6711 @end example
6713 @node Agenda column view,  , Custom agenda views, Agenda Views
6714 @section Using column view in the agenda
6715 @cindex column view, in agenda
6716 @cindex agenda, column view
6718 Column view (@pxref{Column view}) is normally used to view and edit
6719 properties embedded in the hierarchical structure of an Org file.  It can be
6720 quite useful to use column view also from the agenda, where entries are
6721 collected by certain criteria.
6723 @table @kbd
6724 @kindex C-c C-x C-c
6725 @item C-c C-x C-c
6726 Turn on column view in the agenda.
6727 @end table
6729 To understand how to use this properly, it is important to realize that the
6730 entries in the agenda are no longer in their proper outline environment.
6731 This causes the following issues:
6733 @enumerate
6734 @item
6735 Org needs to make a decision which @code{COLUMNS} format to use.  Since the
6736 entries in the agenda are collected from different files, and different files
6737 may have different @code{COLUMNS} formats, this is a non-trivial problem.
6738 Org first checks if the variable @code{org-overriding-columns-format} is
6739 currently set, and if yes takes the format from there.  Otherwise it takes
6740 the format associated with the first item in the agenda, or, if that item
6741 does not have a specific format (defined in a property, or in it's file), it
6742 uses @code{org-columns-default-format}.
6743 @item
6744 If any of the columns has a summary type defined (@pxref{Column attributes}),
6745 turning on column view in the agenda will visit all relevant agenda files and
6746 make sure that the computations of this property are up to date.  This is
6747 also true for the special @code{CLOCKSUM} property.  Org will then sum the
6748 values displayed in the agenda.  In the daily/weekly agenda, the sums will
6749 cover a single day, in all other views they cover the entire block.  It is
6750 vital to realize that the agenda may show the same entry @emph{twice} (for
6751 example as scheduled and as a deadline), and it may show two entries from the
6752 same hierarchy (for example a @emph{parent} and it's @emph{child}).  In these
6753 cases, the summation in the agenda will lead to incorrect results because
6754 some values will count double.
6755 @item
6756 When the column view in the agenda shows the @code{CLOCKSUM}, that is always
6757 the entire clocked time for this item.  So even in the daily/weekly agenda,
6758 the clocksum listed in column view may originate from times outside the
6759 current view.  This has the advantage that you can compare these values with
6760 a column listing the planned total effort for a task - one of the major
6761 applications for column view in the agenda.  If you want information about
6762 clocked time in the displayed period use clock table mode (press @kbd{R} in
6763 the agenda).
6764 @end enumerate
6767 @node Embedded LaTeX, Exporting, Agenda Views, Top
6768 @chapter Embedded LaTeX
6769 @cindex @TeX{} interpretation
6770 @cindex La@TeX{} interpretation
6772 Plain ASCII is normally sufficient for almost all note taking.  One
6773 exception, however, are scientific notes which need to be able to contain
6774 mathematical symbols and the occasional formula.  La@TeX{}@footnote{La@TeX{}
6775 is a macro system based on Donald E. Knuth's @TeX{} system.  Many of the
6776 features described here as ``La@TeX{}'' are really from @TeX{}, but for
6777 simplicity I am blurring this distinction.}  is widely used to typeset
6778 scientific documents. Org mode supports embedding La@TeX{} code into its
6779 files, because many academics are used to reading La@TeX{} source code, and
6780 because it can be readily processed into images for HTML production.
6782 It is not necessary to mark La@TeX{} macros and code in any special way.
6783 If you observe a few conventions, Org mode knows how to find it and what
6784 to do with it.
6786 @menu
6787 * Math symbols::                TeX macros for symbols and Greek letters
6788 * Subscripts and superscripts::  Simple syntax for raising/lowering text
6789 * LaTeX fragments::             Complex formulas made easy
6790 * Processing LaTeX fragments::  Previewing LaTeX processing
6791 * CDLaTeX mode::                Speed up entering of formulas
6792 @end menu
6794 @node Math symbols, Subscripts and superscripts, Embedded LaTeX, Embedded LaTeX
6795 @section Math symbols
6796 @cindex math symbols
6797 @cindex TeX macros
6799 You can use La@TeX{} macros to insert special symbols like @samp{\alpha}
6800 to indicate the Greek letter, or @samp{\to} to indicate an arrow.
6801 Completion for these macros is available, just type @samp{\} and maybe a
6802 few letters, and press @kbd{M-@key{TAB}} to see possible completions.
6803 Unlike La@TeX{} code, Org mode allows these macros to be present
6804 without surrounding math delimiters, for example:
6806 @example
6807 Angles are written as Greek letters \alpha, \beta and \gamma.
6808 @end example
6810 During HTML export (@pxref{HTML export}), these symbols are translated
6811 into the proper syntax for HTML, for the above examples this is
6812 @samp{&alpha;} and @samp{&rarr;}, respectively.  If you need such a symbol
6813 inside a word, terminate it like this: @samp{\Aacute@{@}stor}.
6815 @node Subscripts and superscripts, LaTeX fragments, Math symbols, Embedded LaTeX
6816 @section Subscripts and superscripts
6817 @cindex subscript
6818 @cindex superscript
6820 Just like in La@TeX{}, @samp{^} and @samp{_} are used to indicate super-
6821 and subscripts.  Again, these can be used without embedding them in
6822 math-mode delimiters.  To increase the readability of ASCII text, it is
6823 not necessary (but OK) to surround multi-character sub- and superscripts
6824 with curly braces.  For example
6826 @example
6827 The mass if the sun is M_sun = 1.989 x 10^30 kg.  The radius of
6828 the sun is R_@{sun@} = 6.96 x 10^8 m.
6829 @end example
6831 To avoid interpretation as raised or lowered text, you can quote
6832 @samp{^} and @samp{_} with a backslash: @samp{\_} and @samp{\^}.
6834 During HTML export (@pxref{HTML export}), subscript and superscripts
6835 are surrounded with @code{<sub>} and @code{<sup>} tags, respectively.
6837 @node LaTeX fragments, Processing LaTeX fragments, Subscripts and superscripts, Embedded LaTeX
6838 @section LaTeX fragments
6839 @cindex LaTeX fragments
6841 With symbols, sub- and superscripts, HTML is pretty much at its end when
6842 it comes to representing mathematical formulas@footnote{Yes, there is
6843 MathML, but that is not yet fully supported by many browsers, and there
6844 is no decent converter for turning La@TeX{} or ASCII representations of
6845 formulas into MathML. So for the time being, converting formulas into
6846 images seems the way to go.}. More complex expressions need a dedicated
6847 formula processor. To this end, Org mode can contain arbitrary La@TeX{}
6848 fragments. It provides commands to preview the typeset result of these
6849 fragments, and upon export to HTML, all fragments will be converted to
6850 images and inlined into the HTML document@footnote{The La@TeX{} export
6851 will not use images for displaying La@TeX{} fragments but include these
6852 fragments directly into the La@TeX{} code.}. For this to work you
6853 need to be on a system with a working La@TeX{} installation. You also
6854 need the @file{dvipng} program, available at
6855 @url{http://sourceforge.net/projects/dvipng/}. The La@TeX{} header that
6856 will be used when processing a fragment can be configured with the
6857 variable @code{org-format-latex-header}.
6859 La@TeX{} fragments don't need any special marking at all.  The following
6860 snippets will be identified as La@TeX{} source code:
6861 @itemize @bullet
6862 @item
6863 Environments of any kind.  The only requirement is that the
6864 @code{\begin} statement appears on a new line, preceded by only
6865 whitespace.
6866 @item
6867 Text within the usual La@TeX{} math delimiters.  To avoid conflicts with
6868 currency specifications, single @samp{$} characters are only recognized
6869 as math delimiters if the enclosed text contains at most two line breaks,
6870 is directly attached to the @samp{$} characters with no whitespace in
6871 between, and if the closing @samp{$} is followed by whitespace or
6872 punctuation.  For the other delimiters, there is no such restriction, so
6873 when in doubt, use @samp{\(...\)} as inline math delimiters.
6874 @end itemize
6876 @noindent For example:
6878 @example
6879 \begin@{equation@}                          % arbitrary environments,
6880 x=\sqrt@{b@}                                % even tables, figures
6881 \end@{equation@}                            % etc
6883 If $a^2=b$ and \( b=2 \), then the solution must be
6884 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
6885 @end example
6887 @noindent
6888 If you need any of the delimiter ASCII sequences for other purposes, you
6889 can configure the option @code{org-format-latex-options} to deselect the
6890 ones you do not wish to have interpreted by the La@TeX{} converter.
6892 @node Processing LaTeX fragments, CDLaTeX mode, LaTeX fragments, Embedded LaTeX
6893 @section Processing LaTeX fragments
6894 @cindex LaTeX fragments, preview
6896 La@TeX{} fragments can be processed to produce a preview images of the
6897 typeset expressions:
6899 @table @kbd
6900 @kindex C-c C-x C-l
6901 @item C-c C-x C-l
6902 Produce a preview image of the La@TeX{} fragment at point and overlay it
6903 over the source code.  If there is no fragment at point, process all
6904 fragments in the current entry (between two headlines).  When called
6905 with a prefix argument, process the entire subtree.  When called with
6906 two prefix arguments, or when the cursor is before the first headline,
6907 process the entire buffer.
6908 @kindex C-c C-c
6909 @item C-c C-c
6910 Remove the overlay preview images.
6911 @end table
6913 During HTML export (@pxref{HTML export}), all La@TeX{} fragments are
6914 converted into images and inlined into the document if the following
6915 setting is active:
6917 @lisp
6918 (setq org-export-with-LaTeX-fragments t)
6919 @end lisp
6921 @node CDLaTeX mode,  , Processing LaTeX fragments, Embedded LaTeX
6922 @section Using CDLaTeX to enter math
6923 @cindex CDLaTeX
6925 CDLaTeX mode is a minor mode that is normally used in combination with a
6926 major La@TeX{} mode like AUCTeX in order to speed-up insertion of
6927 environments and math templates.  Inside Org mode, you can make use of
6928 some of the features of CDLaTeX mode.  You need to install
6929 @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
6930 AUCTeX) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
6931 Don't use CDLaTeX mode itself under Org mode, but use the light
6932 version @code{org-cdlatex-mode} that comes as part of Org mode.  Turn it
6933 on for the current buffer with @code{M-x org-cdlatex-mode}, or for all
6934 Org files with
6936 @lisp
6937 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
6938 @end lisp
6940 When this mode is enabled, the following features are present (for more
6941 details see the documentation of CDLaTeX mode):
6942 @itemize @bullet
6943 @kindex C-c @{
6944 @item
6945 Environment templates can be inserted with @kbd{C-c @{}.
6946 @item
6947 @kindex @key{TAB}
6948 The @key{TAB} key will do template expansion if the cursor is inside a
6949 La@TeX{} fragment@footnote{Org mode has a method to test if the cursor is
6950 inside such a fragment, see the documentation of the function
6951 @code{org-inside-LaTeX-fragment-p}.}.  For example, @key{TAB} will
6952 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
6953 correctly inside the first brace.  Another @key{TAB} will get you into
6954 the second brace.  Even outside fragments, @key{TAB} will expand
6955 environment abbreviations at the beginning of a line.  For example, if
6956 you write @samp{equ} at the beginning of a line and press @key{TAB},
6957 this abbreviation will be expanded to an @code{equation} environment.
6958 To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}.
6959 @item
6960 @kindex _
6961 @kindex ^
6962 Pressing @kbd{_} and @kbd{^} inside a La@TeX{} fragment will insert these
6963 characters together with a pair of braces.  If you use @key{TAB} to move
6964 out of the braces, and if the braces surround only a single character or
6965 macro, they are removed again (depending on the variable
6966 @code{cdlatex-simplify-sub-super-scripts}).
6967 @item
6968 @kindex `
6969 Pressing the backquote @kbd{`} followed by a character inserts math
6970 macros, also outside La@TeX{} fragments.  If you wait more than 1.5 seconds
6971 after the backquote, a help window will pop up.
6972 @item
6973 @kindex '
6974 Pressing the normal quote @kbd{'} followed by another character modifies
6975 the symbol before point with an accent or a font.  If you wait more than
6976 1.5 seconds after the backquote, a help window will pop up.  Character
6977 modification will work only inside La@TeX{} fragments, outside the quote
6978 is normal.
6979 @end itemize
6981 @node Exporting, Publishing, Embedded LaTeX, Top
6982 @chapter Exporting
6983 @cindex exporting
6985 Org mode documents can be exported into a variety of other formats.  For
6986 printing and sharing of notes, ASCII export produces a readable and
6987 simple version of an Org file.  HTML export allows you to publish a
6988 notes file on the web, while the XOXO format provides a solid base for
6989 exchange with a broad range of other applications. La@TeX{} export lets
6990 you use Org mode and its structured editing functions to easily create
6991 La@TeX{} files.  To incorporate entries with associated times like
6992 deadlines or appointments into a desktop calendar program like iCal,
6993 Org mode can also produce extracts in the iCalendar format.  Currently
6994 Org mode only supports export, not import of these different formats.
6996 @menu
6997 * Markup rules::                Which structures are recognized?
6998 * Selective export::            Using tags to select and exclude trees
6999 * Export options::              Per-file export settings
7000 * The export dispatcher::       How to access exporter commands
7001 * ASCII export::                Exporting to plain ASCII
7002 * HTML export::                 Exporting to HTML
7003 * LaTeX and PDF export::        Exporting to LaTeX, and processing to PDF
7004 * XOXO export::                 Exporting to XOXO
7005 * iCalendar export::            Exporting in iCalendar format
7006 @end menu
7008 @node Markup rules, Selective export, Exporting, Exporting
7009 @section Markup rules
7011 When exporting Org mode documents,  the exporter tries to reflect the
7012 structure of the document as accurately as possible in the back-end.  Since
7013 export targets like HTML or La@TeX{} allow much richer formatting, Org mode
7014 has rules how to prepare text for rich export.  This section summarizes the
7015 markup rule used in an Org mode buffer.
7017 @menu
7018 * Document title::              How the document title is determined
7019 * Headings and sections::       The main structure of the exported document
7020 * Table of contents::           If, where, how to create a table of contents
7021 * Initial text::                Text before the first headline
7022 * Lists::                       Plain lists are exported
7023 * Paragraphs::                  What determines beginning and ending
7024 * Literal examples::            Source code and other examples
7025 * Include files::               Include the contents of a file during export
7026 * Tables exported::             Tables are exported richly
7027 * Footnotes::                   Numbers like [1]
7028 * Emphasis and monospace::      To bold or not to bold
7029 * TeX macros and LaTeX fragments::  Create special, rich export.
7030 * Horizontal rules::            A line across the page
7031 * Comment lines::               Some lines will not be exported
7032 @end menu
7034 @node Document title, Headings and sections, Markup rules, Markup rules
7035 @subheading Document title
7036 @cindex document title, markup rules
7038 @noindent
7039 The title of the exported document is taken from the special line
7041 @example
7042 #+TITLE: This is the title of the document
7043 @end example
7045 @noindent
7046 If this line does not exist, the title is derived from the first non-empty,
7047 non-comment line in the buffer.  If no such line exists, or if you have
7048 turned off exporting of the text before the first headline (see below), the
7049 title will be the file name without extension.
7051 If you are exporting only a subtree by marking is as the region, the heading
7052 of the subtree will become the title of the document.  If the subtree has a
7053 property @code{EXPORT_TITLE}, that will take precedence.
7055 @node Headings and sections, Table of contents, Document title, Markup rules
7056 @subheading Headings and sections
7057 @cindex headings and sections, markup rules
7059 The outline structure of the document as described in @ref{Document
7060 Structure} forms the basis for defining sections of the exported document.
7061 However, since the outline structure is also used for (for example) lists of
7062 tasks, only the first three outline levels will be used as headings.  Deeper
7063 levels will become itemized lists.  You can change the location of this
7064 switch, globally by setting the variable @code{org-headline-levels}, or on a
7065 per file basis with a line
7067 @example
7068 #+OPTIONS: H:4
7069 @end example
7071 @node Table of contents, Initial text, Headings and sections, Markup rules
7072 @subheading Table of contents
7073 @cindex table of contents, markup rules
7075 The table of contents is normally inserted directly before the first headline
7076 of the file.  If you would like to get it to a different location, insert the
7077 string @code{[TABLE-OF-CONTENTS]} on a line by itself at the desired
7078 location.  The depth of the table of contents is by default the same as the
7079 number of headline levels, but you can choose a smaller number or turn off
7080 the table of contents entirely by configuring the variable
7081 @code{org-export-with-toc}, or on a per-file basis with a line like
7083 @example
7084 #+OPTIONS: toc:2          (only to two levels in TOC)
7085 #+OPTIONS: toc:nil        (no TOC at all)
7086 @end example
7088 @node Initial text, Lists, Table of contents, Markup rules
7089 @subheading Text before the first headline
7090 @cindex text before first headline, markup rules
7091 @cindex #+TEXT
7093 Org mode normally exports the text before the first headline, and even uses
7094 the first line as the document title.  The text will be fully marked up.  If
7095 you need to include literal HTML or La@TeX{} code, use the special constructs
7096 described below in the sections for the individual exporters.
7098 Some people like to use the space before the first headline for setup and
7099 internal links and therefore would like to control the exported text before
7100 the first headline in a different way.  You can do so by setting the variable
7101 @code{org-export-skip-text-before-1st-heading} to @code{t}.  On a per-file
7102 basis, you can get the same effect with @samp{#+OPTIONS: skip:t}.
7104 @noindent
7105 If you still want to have some text before the first headline, use the
7106 @code{#+TEXT} construct:
7108 @example
7109 #+OPTIONS: skip:t
7110 #+TEXT: This text will go before the *first* headline.
7111 #+TEXT: [TABLE-OF-CONTENTS]
7112 #+TEXT: This goes between the table of contents and the first headline
7113 @end example
7115 @node Lists, Paragraphs, Initial text, Markup rules
7116 @subheading Lists
7117 @cindex lists, markup rules
7119 Plain lists as described in @ref{Plain lists} are translated to the back-ends
7120 syntax for such lists.  Most back-ends support unordered, ordered, and
7121 description lists.
7123 @node Paragraphs, Literal examples, Lists, Markup rules
7124 @subheading Paragraphs, line breaks, and quoting
7125 @cindex paragraphs, markup rules
7127 Paragraphs are separated by at least one empty line.  If you need to enforce
7128 a line break within a paragraph, use @samp{\\} at the end of a line.
7130 To keep the line breaks in a region, but otherwise use normal formatting, you
7131 can use this construct, which can also be used to format poetry.
7133 @example
7134 #+BEGIN_VERSE
7135  Great clouds overhead
7136  Tiny black birds rise and fall
7137  Snow covers Emacs
7139      -- AlexSchroeder
7140 #+END_VERSE
7141 @end example
7143 When quoting a passage from another document, it is customary to format this
7144 as a paragraph that is indented on both the left and the right margin.  You
7145 can include quotations in Org mode documents like this:
7147 @example
7148 #+BEGIN_QUOTE
7149 Everything should be made as simple as possible,
7150 but not any simpler -- Albert Einstein
7151 #+END_QUOTE
7152 @end example
7155 @node Literal examples, Include files, Paragraphs, Markup rules
7156 @subheading Literal examples
7157 @cindex literal examples, markup rules
7159 You can include literal examples that should not be subjected to
7160 markup.  Such examples will be typeset in monospace, so this is well suited
7161 for source code and similar examples.
7162 @cindex #+BEGIN_EXAMPLE
7164 @example
7165 #+BEGIN_EXAMPLE
7166 Some example from a text file.
7167 #+END_EXAMPLE
7168 @end example
7170 For simplicity when using small examples, you can also start the example
7171 lines with a colon:
7173 @example
7174 : Some example from a text file.
7175 @end example
7177 @cindex formatting source code, markup rules
7178 If the example is source code from a programming language, or any other text
7179 that can be marked up by font-lock in Emacs, you can ask for the example to
7180 look like the fontified Emacs buffer@footnote{Currently this works only for
7181 the HTML back-end, and requires the @file{htmlize.el} package version 1.34 or
7182 later.}.  This is done with the @samp{src} block, where you also need to
7183 specify the name of the major mode that should be used to fontify the
7184 example:
7185 @cindex #+BEGIN_SRC
7187 @example
7188 #+BEGIN_SRC emacs-lisp
7189 (defun org-xor (a b)
7190    "Exclusive or."
7191    (if a (not b) b))
7192 #+END_SRC
7193 @end example
7195 @table @kbd
7196 @kindex C-c '
7197 @item C-c '
7198 Edit the source code example at point in its native mode.  This works by
7199 switching to an indirect buffer, narrowing the buffer and switching to the
7200 other mode.  You need to exit by pressing @kbd{C-c '} again@footnote{Upon
7201 exit, lines starting with @samp{*} or @samp{#} will get a comma prepended, to
7202 keep them from being interpreted by Org as outline nodes or special
7203 comments.  These commas will be striped for editing with @kbd{C-c '}, and
7204 also for export.}.  Fixed-width
7205 regions (where each line starts with a colon followed by a space) will be
7206 edited using @code{artist-mode}@footnote{You may select a different-mode with
7207 the variable @code{org-edit-fixed-width-region-mode}.} to allow creating
7208 ASCII drawings easily.  Using this command in an empty line will create a new
7209 fixed-width region.
7210 @end table
7213 @node Include files, Tables exported, Literal examples, Markup rules
7214 @subheading Include files
7215 @cindex include files, markup rules
7217 During export, you can include the content of another file.  For example, to
7218 include your .emacs file, you could use:
7219 @cindex #+INCLUDE
7221 @example
7222 #+INCLUDE: "~/.emacs" src emacs-lisp
7223 @end example
7225 The optional second and third parameter are the markup (@samp{quote},
7226 @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the
7227 language for formatting the contents.  The markup is optional, if it is not
7228 given, the text will be assumed to be in Org mode format and will be
7229 processed normally.  The include line will also allow additional keyword
7230 parameters @code{:prefix1} and @code{:prefix} to specify prefixes for the
7231 first line and for each following line.  For example, to include a file as an
7232 item, use
7234 @example
7235 #+INCLUDE: "~/snippets/xx" :prefix1 "   + " :prefix "     "
7236 @end example
7238 @table @kbd
7239 @kindex C-c '
7240 @item C-c '
7241 Visit the include file at point.
7242 @end table
7244 @node Tables exported, Footnotes, Include files, Markup rules
7245 @subheading Tables
7246 @cindex tables, markup rules
7248 Both the native Org mode tables (@pxref{Tables}) and tables formatted with
7249 the @file{table.el} package will be exported properly.  For Org mode tables,
7250 the lines before the first horizontal separator line will become table header
7251 lines.
7253 @node Footnotes, Emphasis and monospace, Tables exported, Markup rules
7254 @subheading Footnotes
7255 @cindex footnotes, markup rules
7256 @cindex @file{footnote.el}
7258 @kindex C-c !
7259 Numbers in square brackets are treated as footnote markers, and lines
7260 starting with such a marker are interpreted as the footnote itself.  You can
7261 use the Emacs package @file{footnote.el} to create footnotes@footnote{The
7262 @file{footnote} package uses @kbd{C-c !} to invoke its commands.  This
7263 binding conflicts with the Org mode command for inserting inactive time
7264 stamps.  You could use the variable @code{footnote-prefix} to switch
7265 footnotes commands to another key.  Or, if you are too used to this binding,
7266 you could use @code{org-replace-disputed-keys} and @code{org-disputed-keys}
7267 to change the settings in Org.}.  For example:
7269 @example
7270 The Org homepage[1] now looks a lot better than it used to.
7272 [1] The link is: http://orgmode.org
7273 @end example
7275 @node Emphasis and monospace, TeX macros and LaTeX fragments, Footnotes, Markup rules
7276 @subheading Emphasis and monospace
7278 @cindex underlined text, markup rules
7279 @cindex bold text, markup rules
7280 @cindex italic text, markup rules
7281 @cindex verbatim text, markup rules
7282 @cindex code text, markup rules
7283 @cindex strike-through text, markup rules
7284 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=}
7285 and @code{~verbatim~}, and, if you must, @samp{+strike-through+}.  Text
7286 in the code and verbatim string is not processed for Org mode specific
7287 syntax, it is exported verbatim.
7289 @node TeX macros and LaTeX fragments, Horizontal rules, Emphasis and monospace, Markup rules
7290 @subheading @TeX{} macros and La@TeX{} fragments
7291 @cindex LaTeX fragments, markup rules
7292 @cindex TeX macros, markup rules
7293 @cindex HTML entities
7294 @cindex LaTeX entities
7296 A @TeX{}-like syntax is used to specify special characters.  Where possible,
7297 these will be transformed into the native format of the exporter back-end.
7298 Strings like @code{\alpha} will be exported as @code{&alpha;} in the HTML
7299 output, and as @code{$\alpha$} in the La@TeX{} output.  Similarly,
7300 @code{\nbsp} will become @code{&nbsp;} in HTML and @code{~} in La@TeX{}.
7301 This applies for a large number of entities, with names taken from both HTML
7302 and La@TeX{}, see the variable @code{org-html-entities} for the complete
7303 list.  If you are unsure about a name, use @kbd{M-@key{TAB}} for completion
7304 after having types the backslash and maybe a few characters
7305 (@pxref{Completion}).
7307 La@TeX{} fragments are converted into images for HTML export, and they are
7308 written literally into the La@TeX{} export.  See also @ref{Embedded LaTeX}.
7310 Finally, @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
7311 @samp{...} are all converted into special commands creating hyphens of
7312 different lengths or a compact set of dots.
7314 @node Horizontal rules, Comment lines, TeX macros and LaTeX fragments, Markup rules
7315 @subheading  Horizontal rules
7316 @cindex horizontal rules, markup rules
7317 A line consisting of only dashes, and at least 5 of them, will be
7318 exported as a horizontal line (@samp{<hr/>} in HTML).
7320 @node Comment lines,  , Horizontal rules, Markup rules
7321 @subheading Comment lines
7322 @cindex comment lines
7323 @cindex exporting, not
7325 Lines starting with @samp{#} in column zero are treated as comments and will
7326 never be exported.  Also entire subtrees starting with the word
7327 @samp{COMMENT} will never be exported.  Finally, regions surrounded by
7328 @samp{#+BEGIN_COMMENT} ... @samp{#+END_COMMENT} will not be exported.
7330 @table @kbd
7331 @kindex C-c ;
7332 @item C-c ;
7333 Toggle the COMMENT keyword at the beginning of an entry.
7334 @end table
7336 @node Selective export, Export options, Markup rules, Exporting
7337 @section Selective export
7338 @cindex export, selective by tags
7340 You may use tags to select the parts of a document that should be exported,
7341 or to exclude parts from export.  This behavior is governed by two variables:
7342 @code{org-export-select-tags} and @code{org-export-exclude-tags}.
7344 Org first checks if any of the @emph{select} tags is present in the buffer.
7345 If yes, all trees that do not carry one of these tags will be excluded.  If a
7346 selected tree is a subtree, the heading hierarchy above it will also be
7347 selected for export, but not the text below those headings.
7349 @noindent
7350 If none of the select tags is found, the whole buffer will be selected for
7351 export.
7353 @noindent
7354 Finally, all subtrees that are marked by any of the @emph{exclude} tags will
7355 be removed from the export buffer.
7357 @node Export options, The export dispatcher, Selective export, Exporting
7358 @section Export options
7359 @cindex options, for export
7361 @cindex completion, of option keywords
7362 The exporter recognizes special lines in the buffer which provide
7363 additional information.  These lines may be put anywhere in the file.
7364 The whole set of lines can be inserted into the buffer with @kbd{C-c
7365 C-e t}.  For individual lines, a good way to make sure the keyword is
7366 correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion
7367 (@pxref{Completion}).
7369 @table @kbd
7370 @kindex C-c C-e t
7371 @item C-c C-e t
7372 Insert template with export options, see example below.
7373 @end table
7375 @cindex #+TITLE:
7376 @cindex #+AUTHOR:
7377 @cindex #+DATE:
7378 @cindex #+EMAIL:
7379 @cindex #+LANGUAGE:
7380 @cindex #+TEXT:
7381 @cindex #+OPTIONS:
7382 @cindex #+LINK_UP:
7383 @cindex #+LINK_HOME:
7384 @cindex #+EXPORT_SELECT_TAGS:
7385 @cindex #+EXPORT_EXCLUDE_TAGS:
7386 @example
7387 #+TITLE:     the title to be shown (default is the buffer name)
7388 #+AUTHOR:    the author (default taken from @code{user-full-name})
7389 #+DATE:      A date, fixed, of a format string for @code{format-time-string}
7390 #+EMAIL:     his/her email address (default from @code{user-mail-address})
7391 #+LANGUAGE:  language for HTML, e.g. @samp{en} (@code{org-export-default-language})
7392 #+TEXT:      Some descriptive text to be inserted at the beginning.
7393 #+TEXT:      Several lines may be given.
7394 #+OPTIONS:   H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ...
7395 #+LINK_UP:   the ``up'' link of an exported page
7396 #+LINK_HOME: the ``home'' link of an exported page
7397 #+EXPORT_SELECT_TAGS:   Tags that select a tree for export
7398 #+EXPORT_EXCLUDE_TAGS:  Tags that exclude a tree from export
7399 @end example
7401 @noindent
7402 The OPTIONS line is a compact@footnote{If you want to configure many options
7403 this way, you can use several OPTIONS lines.} form to specify export settings.  Here
7404 you can:
7405 @cindex headline levels
7406 @cindex section-numbers
7407 @cindex table of contents
7408 @cindex line-break preservation
7409 @cindex quoted HTML tags
7410 @cindex fixed-width sections
7411 @cindex tables
7412 @cindex @TeX{}-like syntax for sub- and superscripts
7413 @cindex footnotes
7414 @cindex special strings
7415 @cindex emphasized text
7416 @cindex @TeX{} macros
7417 @cindex La@TeX{} fragments
7418 @cindex author info, in export
7419 @cindex time info, in export
7420 @example
7421 H:         @r{set the number of headline levels for export}
7422 num:       @r{turn on/off section-numbers}
7423 toc:       @r{turn on/off table of contents, or set level limit (integer)}
7424 \n:        @r{turn on/off line-break-preservation}
7425 @@:         @r{turn on/off quoted HTML tags}
7426 ::         @r{turn on/off fixed-width sections}
7427 |:         @r{turn on/off tables}
7428 ^:         @r{turn on/off @TeX{}-like syntax for sub- and superscripts.  If}
7429            @r{you write "^:@{@}", @code{a_@{b@}} will be interpreted, but}
7430            @r{the simple @code{a_b} will be left as it is.}
7431 -:         @r{turn on/off conversion of special strings.}
7432 f:         @r{turn on/off footnotes like this[1].}
7433 *:         @r{turn on/off emphasized text (bold, italic, underlined)}
7434 TeX:       @r{turn on/off simple @TeX{} macros in plain text}
7435 LaTeX:     @r{turn on/off La@TeX{} fragments}
7436 skip:      @r{turn on/off skipping the text before the first heading}
7437 author:    @r{turn on/off inclusion of author name/email into exported file}
7438 creator:   @r{turn on/off inclusion of creator info into exported file}
7439 timestamp: @r{turn on/off inclusion creation time into exported file}
7440 d:         @r{turn on/off inclusion of drawers}
7441 @end example
7443 These options take effect in both the HTML and La@TeX{} export, except
7444 for @code{TeX} and @code{LaTeX}, which are respectively @code{t} and
7445 @code{nil} for the La@TeX{} export.
7447 When exporting only a single subtree by selecting it with @kbd{C-c @@} before
7448 calling an export command, the subtree can overrule some of the file's export
7449 settings with properties @code{EXPORT_FILE_NAME}, @code{EXPORT_TITLE},
7450 @code{EXPORT_TEXT}, and @code{EXPORT_OPTIONS}.
7452 @node The export dispatcher, ASCII export, Export options, Exporting
7453 @section The export dispatcher
7454 @cindex dispatcher, for export commands
7456 All export commands can be reached using the export dispatcher, which is a
7457 prefix key that prompts for an additional key specifying the command.
7458 Normally the entire file is exported, but if there is an active region that
7459 contains one outline tree, the first heading is used as document title and
7460 the subtrees are exported.
7462 @table @kbd
7463 @kindex C-c C-e
7464 @item C-c C-e
7465 Dispatcher for export and publishing commands.  Displays a help-window
7466 listing the additional key(s) needed to launch an export or publishing
7467 command.  The prefix arg is passed through to the exporter.  If the option
7468 @code{org-export-run-in-background} is set, Org will run the command in the
7469 background if that seems useful for the specific command (i.e. commands that
7470 write to a file).
7471 @kindex C-c C-e v
7472 @item C-c C-e v
7473 Like @kbd{C-c C-e}, but only export the text that is currently visible
7474 (i.e. not hidden by outline visibility).
7475 @kindex C-u C-u C-c C-e
7476 @item C-u C-u C-c C-e
7477 Call an the exporter, but reverse the setting of
7478 @code{org-export-run-in-background}, i.e. request background processing if
7479 not set, or force processing in the current Emacs process if st.
7480 @end table
7482 @node ASCII export, HTML export, The export dispatcher, Exporting
7483 @section ASCII export
7484 @cindex ASCII export
7486 ASCII export produces a simple and very readable version of an Org mode
7487 file.
7489 @cindex region, active
7490 @cindex active region
7491 @cindex Transient mark mode
7492 @table @kbd
7493 @kindex C-c C-e a
7494 @item C-c C-e a
7495 Export as ASCII file.  For an org file @file{myfile.org}, the ASCII file
7496 will be @file{myfile.txt}.  The file will be overwritten without
7497 warning.  If there is an active region, only the region will be
7498 exported. If the selected region is a single tree@footnote{To select the
7499 current subtree, use @kbd{C-c @@}.}, the tree head will
7500 become the document title.  If the tree head entry has or inherits an
7501 @code{EXPORT_FILE_NAME} property, that name will be used for the
7502 export.
7503 @kindex C-c C-e v a
7504 @item C-c C-e v a
7505 Export only the visible part of the document.
7506 @end table
7508 @cindex headline levels, for exporting
7509 In the exported version, the first 3 outline levels will become
7510 headlines, defining a general document structure.  Additional levels
7511 will be exported as itemized lists.  If you want that transition to occur
7512 at a different level, specify it with a prefix argument.  For example,
7514 @example
7515 @kbd{C-1 C-c C-e a}
7516 @end example
7518 @noindent
7519 creates only top level headlines and does the rest as items.  When
7520 headlines are converted to items, the indentation of the text following
7521 the headline is changed to fit nicely under the item.  This is done with
7522 the assumption that the first body line indicates the base indentation of
7523 the body text.  Any indentation larger than this is adjusted to preserve
7524 the layout relative to the first line.  Should there be lines with less
7525 indentation than the first, these are left alone.
7527 @node HTML export, LaTeX and PDF export, ASCII export, Exporting
7528 @section HTML export
7529 @cindex HTML export
7531 Org mode contains an HTML (XHTML 1.0 strict) exporter with extensive
7532 HTML formatting, in ways similar to John Grubers @emph{markdown}
7533 language, but with additional support for tables.
7535 @menu
7536 * HTML Export commands::        How to invoke HTML export
7537 * Quoting HTML tags::           Using direct HTML in Org mode
7538 * Links::                       Transformation of links for HTML
7539 * Images::                      How to include images
7540 * CSS support::                 Changing the appearance of the output
7541 * Javascript support::          Info and Folding in a web browser
7542 @end menu
7544 @node HTML Export commands, Quoting HTML tags, HTML export, HTML export
7545 @subsection HTML export commands
7547 @cindex region, active
7548 @cindex active region
7549 @cindex Transient mark mode
7550 @table @kbd
7551 @kindex C-c C-e h
7552 @item C-c C-e h
7553 Export as HTML file @file{myfile.html}.  For an org file @file{myfile.org},
7554 the ASCII file will be @file{myfile.html}.  The file will be overwritten
7555 without warning.  If there is an active region, only the region will be
7556 exported. If the selected region is a single tree@footnote{To select the
7557 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
7558 title.  If the tree head entry has or inherits an @code{EXPORT_FILE_NAME}
7559 property, that name will be used for the export.
7560 @kindex C-c C-e b
7561 @item C-c C-e b
7562 Export as HTML file and immediately open it with a browser.
7563 @kindex C-c C-e H
7564 @item C-c C-e H
7565 Export to a temporary buffer, do not create a file.
7566 @kindex C-c C-e R
7567 @item C-c C-e R
7568 Export the active region to a temporary buffer.  With a prefix argument, do
7569 not produce the file header and footer, but just the plain HTML section for
7570 the region.  This is good for cut-and-paste operations.
7571 @kindex C-c C-e v h
7572 @kindex C-c C-e v b
7573 @kindex C-c C-e v H
7574 @kindex C-c C-e v R
7575 @item C-c C-e v h
7576 @item C-c C-e v b
7577 @item C-c C-e v H
7578 @item C-c C-e v R
7579 Export only the visible part of the document.
7580 @item M-x org-export-region-as-html
7581 Convert the region to HTML under the assumption that it was Org mode
7582 syntax before.  This is a global command that can be invoked in any
7583 buffer.
7584 @item M-x org-replace-region-by-HTML
7585 Replace the active region (assumed to be in Org mode syntax) by HTML
7586 code.
7587 @end table
7589 @cindex headline levels, for exporting
7590 In the exported version, the first 3 outline levels will become headlines,
7591 defining a general document structure.  Additional levels will be exported as
7592 itemized lists.  If you want that transition to occur at a different level,
7593 specify it with a numeric prefix argument.  For example,
7595 @example
7596 @kbd{C-2 C-c C-e b}
7597 @end example
7599 @noindent
7600 creates two levels of headings and does the rest as items.
7602 @node Quoting HTML tags, Links, HTML Export commands, HTML export
7603 @subsection Quoting HTML tags
7605 Plain @samp{<} and @samp{>} are always transformed to @samp{&lt;} and
7606 @samp{&gt;} in HTML export.  If you want to include simple HTML tags
7607 which should be interpreted as such, mark them with @samp{@@} as in
7608 @samp{@@<b>bold text@@</b>}.  Note that this really works only for
7609 simple tags.  For more extensive HTML that should be copied verbatim to
7610 the exported file use either
7612 @example
7613 #+HTML: Literal HTML code for export
7614 @end example
7616 @noindent or
7617 @cindex #+BEGIN_HTML
7619 @example
7620 #+BEGIN_HTML
7621 All lines between these markers are exported literally
7622 #+END_HTML
7623 @end example
7626 @node Links, Images, Quoting HTML tags, HTML export
7627 @subsection Links
7629 @cindex links, in HTML export
7630 @cindex internal links, in HTML export
7631 @cindex external links, in HTML export
7632 Internal links (@pxref{Internal links}) will continue to work in HTML
7633 files only if they match a dedicated @samp{<<target>>}.  Automatic links
7634 created by radio targets (@pxref{Radio targets}) will also work in the
7635 HTML file.  Links to external files will still work if the HTML file is
7636 in the same directory as the Org file.  Links to other @file{.org}
7637 files will be translated into HTML links under the assumption that an
7638 HTML version also exists of the linked file.  For information related to
7639 linking files while publishing them to a publishing directory see
7640 @ref{Publishing links}.
7642 If you want to specify attributes for links, you can do so using a special
7643 syntax.  Here is an example that sets @code{alt} and @code{title} attributes
7644 for an inlined image:
7646 @example
7647 [[./img/a.jpg@{@{alt="This is image A" title="Image with no action"@}@}]]
7648 @end example
7650 @node Images, CSS support, Links, HTML export
7651 @subsection Images
7653 @cindex images, inline in HTML
7654 @cindex inlining images in HTML
7655 HTML export can inline images given as links in the Org file, and
7656 it can make an image the clickable part of a link.  By
7657 default@footnote{but see the variable
7658 @code{org-export-html-inline-images}}, images are inlined if a link does
7659 not have a description.  So @samp{[[file:myimg.jpg]]} will be inlined,
7660 while @samp{[[file:myimg.jpg][the image]]} will just produce a link
7661 @samp{the image} that points to the image.  If the description part
7662 itself is a @code{file:} link or a @code{http:} URL pointing to an
7663 image, this image will be inlined and activated so that clicking on the
7664 image will activate the link.  For example, to include a thumbnail that
7665 will link to a high resolution version of the image, you could use:
7667 @example
7668 [[file:highres.jpg][file:thumb.jpg]]
7669 @end example
7671 @noindent
7672 and you could use @code{http} addresses just as well.
7674 @node CSS support, Javascript support, Images, HTML export
7675 @subsection CSS support
7676 @cindex CSS, for HTML export
7677 @cindex HTML export, CSS
7679 You can also give style information for the exported file.  The HTML
7680 exporter assigns the following CSS classes to appropriate parts of the
7681 document - your style specifications may change these:
7682 @example
7683 .todo           @r{TODO keywords}
7684 .done           @r{the DONE keyword}
7685 .timestamp      @r{time stamp}
7686 .timestamp-kwd  @r{keyword associated with a time stamp, like SCHEDULED}
7687 .tag            @r{tag in a headline}
7688 .target         @r{target for links}
7689 @end example
7691 Each exported files contains a compact default style that defines these
7692 classes in a basic way@footnote{This style is defined in the constant
7693 @code{org-export-html-style-default}, which you should not modify.  To turn
7694 inclusion of these defaults off, customize
7695 @code{org-export-html-style-include-default}}.  You may overwrite these
7696 settings, or add to them by using the variables @code{org-export-html-style}
7697 (for Org-wide settings) and @code{org-export-html-style-extra} (for more
7698 granular settings, like file-local settings).  To set the latter variable
7699 individually for each file, you can use
7701 @example
7702 #+STYLE: <link rel="stylesheet" type="text/css" href="stylesheet.css" />
7703 @end example
7705 @noindent
7706 For longer style definitions, you can use several such lines.  You could also
7707 directly write a @code{<style>} @code{</style>} section in this way, without
7708 referring to an external file.
7710 @c FIXME: More about header and footer styles
7711 @c FIXME: Talk about links and targets.
7713 @node Javascript support,  , CSS support, HTML export
7714 @subsection Javascript supported display of web pages
7716 @emph{Sebastian Rose} has written a JavaScript program especially designed to
7717 enhance the web viewing experience of HTML files created with Org.  This
7718 program allows to view large files in two different ways.  The first one is
7719 an @emph{Info}-like mode where each section is displayed separately and
7720 navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
7721 as well, press @kbd{?} for an overview of the available keys).  The second
7722 view type is a @emph{folding} view much like Org provides it inside Emacs.
7723 The script is available at @url{http://orgmode.org/org-info.js} and you can
7724 find the documentation for it at
7725 @url{http://orgmode.org/worg/code/org-info-js/org-info.js.html}.  We are
7726 serving the script from our site, but if you use it a lot, you might not want
7727 to be dependent on @url{orgmode.org} and prefer to install a local copy on
7728 your own web server.
7730 To use the script, you need to make sure that the @file{org-jsinfo.el} module
7731 gets loaded.  It should be loaded by default, try @kbd{M-x customize-variable
7732 @key{RET} org-modules @key{RET}} to convince yourself that this is indeed the
7733 case.  All it then takes to make use of the program is adding a single line
7734 to the Org file:
7736 @example
7737 #+INFOJS_OPT: view:info toc:nil
7738 @end example
7740 @noindent
7741 If this line is found, the HTML header will automatically contain the code
7742 needed to invoke the script.  Using the line above, you can set the following
7743 viewing options:
7745 @example
7746 path:    @r{The path to the script.  The default is to grab the script from}
7747          @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
7748          @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
7749 view:    @r{Initial view when website is first shown.  Possible values are:}
7750          info      @r{Info-like interface with one section per page.}
7751          overview  @r{Folding interface, initially showing only top-level.}
7752          content   @r{Folding interface, starting with all headlines visible.}
7753          showall   @r{Folding interface, all headlines and text visible.}
7754 sdepth:  @r{Maximum headline level that will still become an independent}
7755          @r{section for info and folding modes.  The default is taken from}
7756          @r{@code{org-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
7757          @r{If this is smaller than in @code{org-headline-levels}, each}
7758          @r{info/folding section can still contain children headlines.}
7759 toc:     @r{Should the table of content @emph{initially} be visible?}
7760          @r{Even when @code{nil}, you can always get to the toc with @kbd{i}.}
7761 tdepth:  @r{The depth of the table of contents.  The defaults are taken from}
7762          @r{the variables @code{org-headline-levels} and @code{org-export-with-toc}.}
7763 ftoc:    @r{Does the css of the page specify a fixed position for the toc?}
7764          @r{If yes, the toc will never be displayed as a section.}
7765 ltoc:    @r{Should there be short contents (children) in each section?}
7766 mouse:   @r{Headings are highlighted when the mouse is over them.  Should be}
7767          @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
7768 buttons: @r{Should view-toggle buttons be everywhere?  When @code{nil} (the}
7769          @r{default), only one such button will be present.}
7770 @end example
7772 You can choose default values for these options by customizing the variable
7773 @code{org-infojs-options}.  If you always want to apply the script to your
7774 pages, configure the variable @code{org-export-html-use-infojs}.
7776 @node LaTeX and PDF export, XOXO export, HTML export, Exporting
7777 @section LaTeX and PDF export
7778 @cindex LaTeX export
7779 @cindex PDF export
7781 Org mode contains a La@TeX{} exporter written by Bastien Guerry.  With
7782 further processing, this backend is also used to produce PDF output.  Since
7783 the LaTeX output uses @file{hyperref} to implement links and cross
7784 references, the PDF output file will be fully linked.
7786 @menu
7787 * LaTeX/PDF export commands::   
7788 * Quoting LaTeX code::          Incorporating literal LaTeX code
7789 * Sectioning structure::        Changing sectioning in LaTeX output
7790 @end menu
7792 @node LaTeX/PDF export commands, Quoting LaTeX code, LaTeX and PDF export, LaTeX and PDF export
7793 @subsection LaTeX export commands
7795 @table @kbd
7796 @kindex C-c C-e l
7797 @item C-c C-e l
7798 Export as La@TeX{} file @file{myfile.tex}.  For an org file
7799 @file{myfile.org}, the ASCII file will be @file{myfile.tex}.  The file will
7800 be overwritten without warning.  If there is an active region, only the
7801 region will be exported. If the selected region is a single tree@footnote{To
7802 select the current subtree, use @kbd{C-c @@}.}, the tree head will become the
7803 document title.  If the tree head entry has or inherits an
7804 @code{EXPORT_FILE_NAME} property, that name will be used for the export.
7805 @kindex C-c C-e L
7806 @item C-c C-e L
7807 Export to a temporary buffer, do not create a file.
7808 @kindex C-c C-e v l
7809 @kindex C-c C-e v L
7810 @item C-c C-e v l
7811 @item C-c C-e v L
7812 Export only the visible part of the document.
7813 @item M-x org-export-region-as-latex
7814 Convert the region to La@TeX{} under the assumption that it was Org mode
7815 syntax before.  This is a global command that can be invoked in any
7816 buffer.
7817 @item M-x org-replace-region-by-latex
7818 Replace the active region (assumed to be in Org mode syntax) by La@TeX{}
7819 code.
7820 @kindex C-c C-e p
7821 @item C-c C-e p
7822 Export as LaTeX and then process to PDF.
7823 @kindex C-c C-e d
7824 @item C-c C-e d
7825 Export as LaTeX and then process to PDF, then open the resulting PDF file.
7826 @end table
7828 @cindex headline levels, for exporting
7829 In the exported version, the first 3 outline levels will become
7830 headlines, defining a general document structure.  Additional levels
7831 will be exported as description lists.  The exporter can ignore them or
7832 convert them to a custom string depending on
7833 @code{org-latex-low-levels}.
7835 If you want that transition to occur at a different level, specify it
7836 with a numeric prefix argument. For example,
7838 @example
7839 @kbd{C-2 C-c C-e l}
7840 @end example
7842 @noindent
7843 creates two levels of headings and does the rest as items.
7845 @node Quoting LaTeX code, Sectioning structure, LaTeX/PDF export commands, LaTeX and PDF export
7846 @subsection Quoting LaTeX code
7848 Embedded La@TeX{} as described in @ref{Embedded LaTeX} will be correctly
7849 inserted into the La@TeX{} file.  Furthermore, you can add special code
7850 that should only be present in La@TeX{} export with the following
7851 constructs:
7853 @example
7854 #+LaTeX: Literal LaTeX code for export
7855 @end example
7857 @noindent or
7858 @cindex #+BEGIN_LaTeX
7860 @example
7861 #+BEGIN_LaTeX
7862 All lines between these markers are exported literally
7863 #+END_LaTeX
7864 @end example
7866 @node   Sectioning structure,  , Quoting LaTeX code, LaTeX and PDF export
7867 @subsection Sectioning structure
7868 @cindex LaTeX class
7869 @cindex LaTeX sectioning structure
7871 By default, the La@TeX{} output uses the class @code{article}.
7873 You can change this globally by setting a different value for
7874 @code{org-export-latex-default-class} or locally by adding an option like
7875 @code{#+LaTeX_CLASS: myclass} in your file.  The class should be listed in
7876 @code{org-export-latex-classes}, where you can also define the sectioning
7877 structure for each class, as well as defining additonal classes.
7880 @node XOXO export, iCalendar export, LaTeX and PDF export, Exporting
7881 @section XOXO export
7882 @cindex XOXO export
7884 Org mode contains an exporter that produces XOXO-style output.
7885 Currently, this exporter only handles the general outline structure and
7886 does not interpret any additional Org mode features.
7888 @table @kbd
7889 @kindex C-c C-e x
7890 @item C-c C-e x
7891 Export as XOXO file @file{myfile.html}.
7892 @kindex C-c C-e v
7893 @item C-c C-e v x
7894 Export only the visible part of the document.
7895 @end table
7897 @node iCalendar export,  , XOXO export, Exporting
7898 @section iCalendar export
7899 @cindex iCalendar export
7901 Some people like to use Org mode for keeping track of projects, but still
7902 prefer a standard calendar application for anniversaries and appointments.
7903 In this case it can be useful to have deadlines and other time-stamped items
7904 in Org files show up in the calendar application.  Org mode can export
7905 calendar information in the standard iCalendar format.  If you also want to
7906 have TODO entries included in the export, configure the variable
7907 @code{org-icalendar-include-todo}.  iCalendar export will export plain time
7908 stamps as VEVENT, and TODO items as VTODO.  It will also create events from
7909 deadlines that are in non-TODO items.  Deadlines and scheduling dates in TODO
7910 items will be used to set the start and due dates for the todo
7911 entry@footnote{See the variables @code{org-icalendar-use-deadline} and
7912 @code{org-icalendar-use-scheduled}.}.  As categories, it will use the tags
7913 locally defined in the heading, and the file/tree category@footnote{To add
7914 inherited tags or the TODO state, configure the variable
7915 @code{org-icalendar-categories}.}. 
7917 The iCalendar standard requires each entry to have a globally unique
7918 identifier (UID).  Org creates these identifiers during export.  If you set
7919 the variable @code{org-icalendar-store-UID}, the UID will be stored in the
7920 @code{:ID:} property of the entry and re-used next time you report this
7921 entry.  Since a single entry can give rise to multiple iCalendar entries (as
7922 a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
7923 prefixes to the UID, depending on what triggered the inclusion of the entry.
7924 In this way the UID remains unique, but a synchronization program can still
7925 figure out from which entry all the different instances originate.
7927 @table @kbd
7928 @kindex C-c C-e i
7929 @item C-c C-e i
7930 Create iCalendar entries for the current file and store them in the same
7931 directory, using a file extension @file{.ics}.
7932 @kindex C-c C-e I
7933 @item C-c C-e I
7934 Like @kbd{C-c C-e i}, but do this for all files in
7935 @code{org-agenda-files}.  For each of these files, a separate iCalendar
7936 file will be written.
7937 @kindex C-c C-e c
7938 @item C-c C-e c
7939 Create a single large iCalendar file from all files in
7940 @code{org-agenda-files} and write it to the file given by
7941 @code{org-combined-agenda-icalendar-file}.
7942 @end table
7944 The export will honor SUMMARY, DESCRIPTION and LOCATION properties if
7945 the selected entries have them.  If not, the summary will be derived
7946 from the headline, and the description from the body (limited to
7947 @code{org-icalendar-include-body} characters).
7949 How this calendar is best read and updated, that depends on the application
7950 you are using.  The FAQ covers this issue.
7952 @node Publishing, Miscellaneous, Exporting, Top
7953 @chapter Publishing
7954 @cindex publishing
7956 Org includes@footnote{@file{org-publish.el} is not distributed with
7957 Emacs 21, if you are still using Emacs 21, you need you need to download
7958 this file separately.} a publishing management system that allows you to
7959 configure automatic HTML conversion of @emph{projects} composed of
7960 interlinked org files.  This system is called @emph{org-publish}.  You can
7961 also configure org-publish to automatically upload your exported HTML
7962 pages and related attachments, such as images and source code files, to
7963 a web server. Org-publish turns Org into a web-site authoring tool.
7965 You can also use Org-publish to convert files into La@TeX{}, or even
7966 combine HTML and La@TeX{} conversion so that files are available in both
7967 formats on the server@footnote{Since La@TeX{} files on a server are not
7968 that helpful, you surely want to perform further conversion on them --
7969 e.g. convert them to @code{PDF} format.}.
7971 Org-publish has been contributed to Org by David O'Toole.
7973 @menu
7974 * Configuration::               Defining projects
7975 * Sample configuration::        Example projects
7976 * Triggering publication::      Publication commands
7977 @end menu
7979 @node Configuration, Sample configuration, Publishing, Publishing
7980 @section Configuration
7982 Publishing needs significant configuration to specify files, destination
7983 and many other properties of a project.
7985 @menu
7986 * Project alist::               The central configuration variable
7987 * Sources and destinations::    From here to there
7988 * Selecting files::             What files are part of the project?
7989 * Publishing action::           Setting the function doing the publishing
7990 * Publishing options::          Tweaking HTML export
7991 * Publishing links::            Which links keep working after publishing?
7992 * Project page index::          Publishing a list of project files
7993 @end menu
7995 @node Project alist, Sources and destinations, Configuration, Configuration
7996 @subsection The variable @code{org-publish-project-alist}
7997 @cindex org-publish-project-alist
7998 @cindex projects, for publishing
8000 Org-publish is configured almost entirely through setting the value of
8001 one variable, called @code{org-publish-project-alist}.
8002 Each element of the list configures one project, and may be in one of
8003 the two following forms:
8005 @lisp
8006 ("project-name" :property value :property value ...)
8008 @r{or}
8010 ("project-name" :components ("project-name" "project-name" ...))
8012 @end lisp
8014 In both cases, projects are configured by specifying property values.
8015 A project defines the set of files that will be published, as well as
8016 the publishing configuration to use when publishing those files.  When
8017 a project takes the second form listed above, the individual members
8018 of the ``components'' property are taken to be components of the
8019 project, which group together files requiring different publishing
8020 options. When you publish such a ``meta-project'' all the components
8021 will also publish.
8023 @node Sources and destinations, Selecting files, Project alist, Configuration
8024 @subsection Sources and destinations for files
8025 @cindex directories, for publishing
8027 Most properties are optional, but some should always be set. In
8028 particular, org-publish needs to know where to look for source files,
8029 and where to put published files.
8031 @multitable @columnfractions 0.3 0.7
8032 @item @code{:base-directory}
8033 @tab Directory containing publishing source files
8034 @item @code{:publishing-directory}
8035 @tab Directory (possibly remote) where output files will be published.
8036 @item @code{:preparation-function}
8037 @tab Function called before starting the publishing process, for example to
8038 run @code{make} for updating files to be published.
8039 @item @code{:completion-function}
8040 @tab Function called after finishing the publishing process, for example to
8041 change permissions of the resulting files.
8042 @end multitable
8043 @noindent
8045 @node Selecting files, Publishing action, Sources and destinations, Configuration
8046 @subsection Selecting files
8047 @cindex files, selecting for publishing
8049 By default, all files with extension @file{.org} in the base directory
8050 are considered part of the project.  This can be modified by setting the
8051 properties
8052 @multitable @columnfractions 0.25 0.75
8053 @item @code{:base-extension}
8054 @tab Extension (without the dot!) of source files.  This actually is a
8055 regular expression.
8057 @item @code{:exclude}
8058 @tab Regular expression to match file names that should not be
8059 published, even though they have been selected on the basis of their
8060 extension.
8062 @item @code{:include}
8063 @tab List of files to be included regardless of @code{:base-extension}
8064 and @code{:exclude}.
8065 @end multitable
8067 @node Publishing action, Publishing options, Selecting files, Configuration
8068 @subsection Publishing action
8069 @cindex action, for publishing
8071 Publishing means that a file is copied to the destination directory and
8072 possibly transformed in the process.  The default transformation is to export
8073 Org files as HTML files, and this is done by the function
8074 @code{org-publish-org-to-html} which calls the HTML exporter (@pxref{HTML
8075 export}). But you also can publish your files in La@TeX{} by using the
8076 function @code{org-publish-org-to-latex} instead, or as PDF files using
8077 @code{org-publish-org-to-pdf}.  Other files like images only need to be
8078 copied to the publishing destination. For non-Org files, you need to provide
8079 your own publishing function:
8081 @multitable @columnfractions 0.3 0.7
8082 @item @code{:publishing-function}
8083 @tab Function executing the publication of a file.  This may also be a
8084 list of functions, which will all be called in turn.
8085 @end multitable
8087 The function must accept two arguments: a property list containing at
8088 least a @code{:publishing-directory} property, and the name of the file
8089 to be published.  It should take the specified file, make the necessary
8090 transformation (if any) and place the result into the destination folder.
8091 You can write your own publishing function, but @code{org-publish}
8092 provides one for attachments (files that only need to be copied):
8093 @code{org-publish-attachment}.
8095 @node Publishing options, Publishing links, Publishing action, Configuration
8096 @subsection Options for the HTML/LaTeX exporters
8097 @cindex options, for publishing
8099 The property list can be used to set many export options for the HTML
8100 and La@TeX{} exporters.  In most cases, these properties correspond to user
8101 variables in Org.  The table below lists these properties along
8102 with the variable they belong to.  See the documentation string for the
8103 respective variable for details.
8105 @multitable @columnfractions 0.3 0.7
8106 @item @code{:language}              @tab @code{org-export-default-language}
8107 @item @code{:headline-levels}       @tab @code{org-export-headline-levels}
8108 @item @code{:section-numbers}       @tab @code{org-export-with-section-numbers}
8109 @item @code{:table-of-contents}     @tab @code{org-export-with-toc}
8110 @item @code{:archived-trees}        @tab @code{org-export-with-archived-trees}
8111 @item @code{:emphasize}             @tab @code{org-export-with-emphasize}
8112 @item @code{:sub-superscript}       @tab @code{org-export-with-sub-superscripts}
8113 @item @code{:special-strings}       @tab @code{org-export-with-special-strings}
8114 @item @code{:TeX-macros}            @tab @code{org-export-with-TeX-macros}
8115 @item @code{:LaTeX-fragments}       @tab @code{org-export-with-LaTeX-fragments}
8116 @item @code{:fixed-width}           @tab @code{org-export-with-fixed-width}
8117 @item @code{:timestamps}            @tab @code{org-export-with-timestamps}
8118 @item @code{:author-info}           @tab @code{org-export-author-info}
8119 @item @code{:creator-info}          @tab @code{org-export-creator-info}
8120 @item @code{:tags}                  @tab @code{org-export-with-tags}
8121 @item @code{:tables}                @tab @code{org-export-with-tables}
8122 @item @code{:table-auto-headline}   @tab @code{org-export-highlight-first-table-line}
8123 @item @code{:style-include-default} @tab @code{org-export-html-style-include-default}
8124 @item @code{:style}                 @tab @code{org-export-html-style}
8125 @item @code{:style-extra}           @tab @code{org-export-html-style-extra}
8126 @item @code{:convert-org-links}     @tab @code{org-export-html-link-org-files-as-html}
8127 @item @code{:inline-images}         @tab @code{org-export-html-inline-images}
8128 @item @code{:expand-quoted-html}    @tab @code{org-export-html-expand}
8129 @item @code{:timestamp}             @tab @code{org-export-html-with-timestamp}
8130 @item @code{:publishing-directory}  @tab @code{org-export-publishing-directory}
8131 @item @code{:preamble}              @tab @code{org-export-html-preamble}
8132 @item @code{:postamble}             @tab @code{org-export-html-postamble}
8133 @item @code{:auto-preamble}         @tab @code{org-export-html-auto-preamble}
8134 @item @code{:auto-postamble}        @tab @code{org-export-html-auto-postamble}
8135 @item @code{:author}                @tab @code{user-full-name}
8136 @item @code{:email}                 @tab @code{user-mail-address}
8137 @item @code{:select-tags}           @tab @code{org-export-select-tags}
8138 @item @code{:exclude-tags}          @tab @code{org-export-exclude-tags}
8139 @end multitable
8141 If you use several email addresses, separate them by a semi-column.
8143 Most of the @code{org-export-with-*} variables have the same effect in
8144 both HTML and La@TeX{} exporters, except for @code{:TeX-macros} and
8145 @code{:LaTeX-fragments}, respectively @code{nil} and @code{t} in the
8146 La@TeX{} export.
8148 When a property is given a value in @code{org-publish-project-alist},
8149 its setting overrides the value of the corresponding user variable (if
8150 any) during publishing.  Options set within a file (@pxref{Export
8151 options}), however, override everything.
8153 @node Publishing links, Project page index, Publishing options, Configuration
8154 @subsection Links between published files
8155 @cindex links, publishing
8157 To create a link from one Org file to another, you would use
8158 something like @samp{[[file:foo.org][The foo]]} or simply
8159 @samp{file:foo.org.} (@pxref{Hyperlinks}).  Upon publishing this link
8160 becomes a link to @file{foo.html}.  In this way, you can interlink the
8161 pages of your "org web" project and the links will work as expected when
8162 you publish them to HTML.
8164 You may also link to related files, such as images. Provided you are
8165 careful with relative pathnames, and provided you have also configured
8166 @code{org-publish} to upload the related files, these links will work
8167 too. @ref{Complex example} for an example of this usage.
8169 Sometime an Org file to be published may contain links that are
8170 only valid in your production environment, but not in the publishing
8171 location.  In this case, use the property
8173 @multitable @columnfractions 0.4 0.6
8174 @item @code{:link-validation-function}
8175 @tab Function to validate links
8176 @end multitable
8178 @noindent
8179 to define a function for checking link validity.  This function must
8180 accept two arguments, the file name and a directory relative to which
8181 the file name is interpreted in the production environment.  If this
8182 function returns @code{nil}, then the HTML generator will only insert a
8183 description into the HTML file, but no link.  One option for this
8184 function is @code{org-publish-validate-link} which checks if the given
8185 file is part of any project in @code{org-publish-project-alist}.
8187 @node Project page index,  , Publishing links, Configuration
8188 @subsection Project page index
8189 @cindex index, of published pages
8191 The following properties may be used to control publishing of an
8192 index of files or summary page for a given project.
8194 @multitable @columnfractions 0.25 0.75
8195 @item @code{:auto-index}
8196 @tab When non-nil, publish an index during org-publish-current-project or
8197 org-publish-all.
8199 @item @code{:index-filename}
8200 @tab Filename for output of index. Defaults to @file{index.org} (which
8201 becomes @file{index.html}).
8203 @item @code{:index-title}
8204 @tab Title of index page. Defaults to name of file.
8206 @item @code{:index-function}
8207 @tab Plug-in function to use for generation of index.
8208 Defaults to @code{org-publish-org-index}, which generates a plain list
8209 of links to all files in the project.
8210 @end multitable
8212 @node Sample configuration, Triggering publication, Configuration, Publishing
8213 @section Sample configuration
8215 Below we provide two example configurations.  The first one is a simple
8216 project publishing only a set of Org files.  The second example is
8217 more complex, with a multi-component project.
8219 @menu
8220 * Simple example::              One-component publishing
8221 * Complex example::             A multi-component publishing example
8222 @end menu
8224 @node Simple example, Complex example, Sample configuration, Sample configuration
8225 @subsection Example: simple publishing configuration
8227 This example publishes a set of Org files to the @file{public_html}
8228 directory on the local machine.
8230 @lisp
8231 (setq org-publish-project-alist
8232       '(("org"
8233          :base-directory "~/org/"
8234          :publishing-directory "~/public_html"
8235          :section-numbers nil
8236          :table-of-contents nil
8237          :style "<link rel=\"stylesheet\"
8238                 href=\"../other/mystyle.css\"
8239                 type=\"text/css\">")))
8240 @end lisp
8242 @node Complex example,  , Simple example, Sample configuration
8243 @subsection Example: complex publishing configuration
8245 This more complicated example publishes an entire website, including
8246 org files converted to HTML, image files, emacs lisp source code, and
8247 style sheets. The publishing-directory is remote and private files are
8248 excluded.
8250 To ensure that links are preserved, care should be taken to replicate
8251 your directory structure on the web server, and to use relative file
8252 paths. For example, if your org files are kept in @file{~/org} and your
8253 publishable images in @file{~/images}, you'd link to an image with
8255 @example
8256 file:../images/myimage.png
8257 @end example
8259 On the web server, the relative path to the image should be the
8260 same. You can accomplish this by setting up an "images" folder in the
8261 right place on the web server, and publishing images to it.
8263 @lisp
8264 (setq org-publish-project-alist
8265       '(("orgfiles"
8266           :base-directory "~/org/"
8267           :base-extension "org"
8268           :publishing-directory "/ssh:user@@host:~/html/notebook/"
8269           :publishing-function org-publish-org-to-html
8270           :exclude "PrivatePage.org"   ;; regexp
8271           :headline-levels 3
8272           :section-numbers nil
8273           :table-of-contents nil
8274           :style "<link rel=\"stylesheet\"
8275                   href=\"../other/mystyle.css\" type=\"text/css\">"
8276           :auto-preamble t
8277           :auto-postamble nil)
8279          ("images"
8280           :base-directory "~/images/"
8281           :base-extension "jpg\\|gif\\|png"
8282           :publishing-directory "/ssh:user@@host:~/html/images/"
8283           :publishing-function org-publish-attachment)
8285          ("other"
8286           :base-directory "~/other/"
8287           :base-extension "css\\|el"
8288           :publishing-directory "/ssh:user@@host:~/html/other/"
8289           :publishing-function org-publish-attachment)
8290          ("website" :components ("orgfiles" "images" "other"))))
8291 @end lisp
8293 @node Triggering publication,  , Sample configuration, Publishing
8294 @section Triggering publication
8296 Once org-publish is properly configured, you can publish with the
8297 following functions:
8299 @table @kbd
8300 @item C-c C-e C
8301 Prompt for a specific project and publish all files that belong to it.
8302 @item C-c C-e P
8303 Publish the project containing the current file.
8304 @item C-c C-e F
8305 Publish only the current file.
8306 @item C-c C-e A
8307 Publish all projects.
8308 @end table
8310 Org uses timestamps to track when a file has changed. The above
8311 functions normally only publish changed files. You can override this and
8312 force publishing of all files by giving a prefix argument.
8314 @node Miscellaneous, Extensions, Publishing, Top
8315 @chapter Miscellaneous
8317 @menu
8318 * Completion::                  M-TAB knows what you need
8319 * Customization::               Adapting Org to your taste
8320 * In-buffer settings::          Overview of the #+KEYWORDS
8321 * The very busy C-c C-c key::   When in doubt, press C-c C-c
8322 * Clean view::                  Getting rid of leading stars in the outline
8323 * TTY keys::                    Using Org on a tty
8324 * Interaction::                 Other Emacs packages
8325 * Bugs::                        Things which do not work perfectly
8326 @end menu
8328 @node Completion, Customization, Miscellaneous, Miscellaneous
8329 @section Completion
8330 @cindex completion, of @TeX{} symbols
8331 @cindex completion, of TODO keywords
8332 @cindex completion, of dictionary words
8333 @cindex completion, of option keywords
8334 @cindex completion, of tags
8335 @cindex completion, of property keys
8336 @cindex completion, of link abbreviations
8337 @cindex @TeX{} symbol completion
8338 @cindex TODO keywords completion
8339 @cindex dictionary word completion
8340 @cindex option keyword completion
8341 @cindex tag completion
8342 @cindex link abbreviations, completion of
8344 Org supports in-buffer completion.  This type of completion does
8345 not make use of the minibuffer.  You simply type a few letters into
8346 the buffer and use the key to complete text right there.
8348 @table @kbd
8349 @kindex M-@key{TAB}
8350 @item M-@key{TAB}
8351 Complete word at point
8352 @itemize @bullet
8353 @item
8354 At the beginning of a headline, complete TODO keywords.
8355 @item
8356 After @samp{\}, complete @TeX{} symbols supported by the exporter.
8357 @item
8358 After @samp{*}, complete headlines in the current buffer so that they
8359 can be used in search links like @samp{[[*find this headline]]}.
8360 @item
8361 After @samp{:} in a headline, complete tags.  The list of tags is taken
8362 from the variable @code{org-tag-alist} (possibly set through the
8363 @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
8364 dynamically from all tags used in the current buffer.
8365 @item
8366 After @samp{:} and not in a headline, complete property keys.  The list
8367 of keys is constructed dynamically from all keys used in the current
8368 buffer.
8369 @item
8370 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
8371 @item
8372 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
8373 @samp{OPTIONS} which set file-specific options for Org mode.  When the
8374 option keyword is already complete, pressing @kbd{M-@key{TAB}} again
8375 will insert example settings for this keyword.
8376 @item
8377 In the line after @samp{#+STARTUP: }, complete startup keywords,
8378 i.e. valid keys for this line.
8379 @item
8380 Elsewhere, complete dictionary words using Ispell.
8381 @end itemize
8382 @end table
8384 @node Customization, In-buffer settings, Completion, Miscellaneous
8385 @section Customization
8386 @cindex customization
8387 @cindex options, for customization
8388 @cindex variables, for customization
8390 There are more than 180 variables that can be used to customize
8391 Org.  For the sake of compactness of the manual, I am not
8392 describing the variables here.  A structured overview of customization
8393 variables is available with @kbd{M-x org-customize}.  Or select
8394 @code{Browse Org Group} from the @code{Org->Customization} menu.  Many
8395 settings can also be activated on a per-file basis, by putting special
8396 lines into the buffer (@pxref{In-buffer settings}).
8398 @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous
8399 @section Summary of in-buffer settings
8400 @cindex in-buffer settings
8401 @cindex special keywords
8403 Org mode uses special lines in the buffer to define settings on a
8404 per-file basis.  These lines start with a @samp{#+} followed by a
8405 keyword, a colon, and then individual words defining a setting.  Several
8406 setting words can be in the same line, but you can also have multiple
8407 lines for the keyword.  While these settings are described throughout
8408 the manual, here is a summary.  After changing any of those lines in the
8409 buffer, press @kbd{C-c C-c} with the cursor still in the line to
8410 activate the changes immediately.  Otherwise they become effective only
8411 when the file is visited again in a new Emacs session.
8413 @table @kbd
8414 @item #+ARCHIVE: %s_done::
8415 This line sets the archive location for the agenda file.  It applies for
8416 all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
8417 of the file.  The first such line also applies to any entries before it.
8418 The corresponding variable is @code{org-archive-location}.
8419 @item #+CATEGORY:
8420 This line sets the category for the agenda file.  The category applies
8421 for all subsequent lines until the next @samp{#+CATEGORY} line, or the
8422 end of the file.  The first such line also applies to any entries before it.
8423 @item #+COLUMNS: %25ITEM .....
8424 Set the default format for columns view.  This format applies when
8425 columns view is invoked in location where no @code{COLUMNS} property
8426 applies.
8427 @item #+CONSTANTS: name1=value1 ...
8428 Set file-local values for constants to be used in table formulas.  This
8429 line set the local variable @code{org-table-formula-constants-local}.
8430 The global version of this variable is
8431 @code{org-table-formula-constants}.
8432 @item #+FILETAGS: :tag1:tag2:tag3:
8433 Set tags that can be inherited by any entry in the file, including the
8434 top-level entries.
8435 @item #+DRAWERS: NAME1 .....
8436 Set the file-local set of drawers.  The corresponding global variable is
8437 @code{org-drawers}.
8438 @item #+LINK:  linkword replace
8439 These lines (several are allowed) specify link abbreviations.
8440 @xref{Link abbreviations}.  The corresponding variable is
8441 @code{org-link-abbrev-alist}.
8442 @item #+PRIORITIES: highest lowest default
8443 This line sets the limits and the default for the priorities.  All three
8444 must be either letters A-Z or numbers 0-9.  The highest priority must
8445 have a lower ASCII number that the lowest priority.
8446 @item #+PROPERTY: Property_Name Value
8447 This line sets a default inheritance value for entries in the current
8448 buffer, most useful for specifying the allowed values of a property.
8449 @item #+SETUPFILE: file
8450 This line defines a file that holds more in-buffer setup.  Normally this is
8451 entirely ignored.  Only when the buffer is parsed for option-setting lines
8452 (i.e. when starting Org mode for a file, when pressing @kbd{C-c C-c} in a
8453 settings line, or when exporting), then the contents of this file are parsed
8454 as if they had been included in the buffer.  In particlar, the file can be
8455 any other Org mode file with internal setup.  You can visit the file the
8456 cursor is in the line with @kbd{C-c '}.
8457 @item #+STARTUP:
8458 This line sets options to be used at startup of Org mode, when an
8459 Org file is being visited.  The first set of options deals with the
8460 initial visibility of the outline tree.  The corresponding variable for
8461 global default settings is @code{org-startup-folded}, with a default
8462 value @code{t}, which means @code{overview}.
8463 @cindex @code{overview}, STARTUP keyword
8464 @cindex @code{content}, STARTUP keyword
8465 @cindex @code{showall}, STARTUP keyword
8466 @example
8467 overview   @r{top-level headlines only}
8468 content    @r{all headlines}
8469 showall    @r{no folding at all, show everything}
8470 @end example
8471 Then there are options for aligning tables upon visiting a file.  This
8472 is useful in files containing narrowed table columns.  The corresponding
8473 variable is @code{org-startup-align-all-tables}, with a default value
8474 @code{nil}.
8475 @cindex @code{align}, STARTUP keyword
8476 @cindex @code{noalign}, STARTUP keyword
8477 @example
8478 align      @r{align all tables}
8479 noalign    @r{don't align tables on startup}
8480 @end example
8481 Logging closing and reinstating TODO items, and clock intervals
8482 (variables @code{org-log-done}, @code{org-log-note-clock-out}, and
8483 @code{org-log-repeat}) can be configured using these options.
8484 @cindex @code{logdone}, STARTUP keyword
8485 @cindex @code{lognotedone}, STARTUP keyword
8486 @cindex @code{nologdone}, STARTUP keyword
8487 @cindex @code{lognoteclock-out}, STARTUP keyword
8488 @cindex @code{nolognoteclock-out}, STARTUP keyword
8489 @cindex @code{logrepeat}, STARTUP keyword
8490 @cindex @code{lognoterepeat}, STARTUP keyword
8491 @cindex @code{nologrepeat}, STARTUP keyword
8492 @example
8493 logdone            @r{record a timestamp when an item is marked DONE}
8494 lognotedone        @r{record timestamp and a note when DONE}
8495 nologdone          @r{don't record when items are marked DONE}
8496 logrepeat          @r{record a time when reinstating a repeating item}
8497 lognoterepeat      @r{record a note when reinstating a repeating item}
8498 nologrepeat        @r{do not record when reinstating repeating item}
8499 lognoteclock-out   @r{record a note when clocking out}
8500 nolognoteclock-out @r{don't record a note when clocking out}
8501 @end example
8502 Here are the options for hiding leading stars in outline headings, and for
8503 indenting outlines.  The corresponding variables are
8504 @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
8505 default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
8506 @cindex @code{hidestars}, STARTUP keyword
8507 @cindex @code{showstars}, STARTUP keyword
8508 @cindex @code{odd}, STARTUP keyword
8509 @cindex @code{even}, STARTUP keyword
8510 @example
8511 hidestars  @r{make all but one of the stars starting a headline invisible.}
8512 showstars  @r{show all stars starting a headline}
8513 indent     @r{virtual indentation according to outline level}
8514 noindent   @r{no virtual indentation according to outline level}
8515 odd        @r{allow only odd outline levels (1,3,...)}
8516 oddeven    @r{allow all outline levels}
8517 @end example
8518 To turn on custom format overlays over time stamps (variables
8519 @code{org-put-time-stamp-overlays} and
8520 @code{org-time-stamp-overlay-formats}), use
8521 @cindex @code{customtime}, STARTUP keyword
8522 @example
8523 customtime @r{overlay custom time format}
8524 @end example
8525 The following options influence the table spreadsheet (variable
8526 @code{constants-unit-system}).
8527 @cindex @code{constcgs}, STARTUP keyword
8528 @cindex @code{constSI}, STARTUP keyword
8529 @example
8530 constcgs   @r{@file{constants.el} should use the c-g-s unit system}
8531 constSI    @r{@file{constants.el} should use the SI unit system}
8532 @end example
8533 @item #+TAGS:  TAG1(c1) TAG2(c2)
8534 These lines (several such lines are allowed) specify the valid tags in
8535 this file, and (potentially) the corresponding @emph{fast tag selection}
8536 keys.  The corresponding variable is @code{org-tag-alist}.
8537 @item #+TBLFM:
8538 This line contains the formulas for the table directly above the line.
8539 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS, #+DATE:
8540 These lines provide settings for exporting files.  For more details see
8541 @ref{Export options}.
8542 @item #+SEQ_TODO:   #+TYP_TODO:
8543 These lines set the TODO keywords and their interpretation in the
8544 current file.  The corresponding variables are @code{org-todo-keywords}
8545 and @code{org-todo-interpretation}.
8546 @end table
8548 @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous
8549 @section The very busy C-c C-c key
8550 @kindex C-c C-c
8551 @cindex C-c C-c, overview
8553 The key @kbd{C-c C-c} has many purposes in Org, which are all
8554 mentioned scattered throughout this manual.  One specific function of
8555 this key is to add @emph{tags} to a headline (@pxref{Tags}).  In many
8556 other circumstances it means something like @emph{Hey Org, look
8557 here and update according to what you see here}.  Here is a summary of
8558 what this means in different contexts.
8560 @itemize @minus
8561 @item
8562 If there are highlights in the buffer from the creation of a sparse
8563 tree, or from clock display, remove these highlights.
8564 @item
8565 If the cursor is in one of the special @code{#+KEYWORD} lines, this
8566 triggers scanning the buffer for these lines and updating the
8567 information.
8568 @item
8569 If the cursor is inside a table, realign the table.  This command
8570 works even if the automatic table editor has been turned off.
8571 @item
8572 If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
8573 the entire table.
8574 @item
8575 If the cursor is inside a table created by the @file{table.el} package,
8576 activate that table.
8577 @item
8578 If the current buffer is a remember buffer, close the note and file it.
8579 With a prefix argument, file it, without further interaction, to the
8580 default location.
8581 @item
8582 If the cursor is on a @code{<<<target>>>}, update radio targets and
8583 corresponding links in this buffer.
8584 @item
8585 If the cursor is in a property line or at the start or end of a property
8586 drawer, offer property commands.
8587 @item
8588 If the cursor is in a plain list item with a checkbox, toggle the status
8589 of the checkbox.
8590 @item
8591 If the cursor is on a numbered item in a plain list, renumber the
8592 ordered list.
8593 @item
8594 If the cursor is on the @code{#+BEGIN} line of a dynamical block, the
8595 block is updated.
8596 @end itemize
8598 @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous
8599 @section A cleaner outline view
8600 @cindex hiding leading stars
8601 @cindex dynamic indentation
8602 @cindex odd-levels-only outlines
8603 @cindex clean outline view
8605 Some people find it noisy and distracting that the Org headlines are starting
8606 with a potentially large number of stars, and that text below the headlines
8607 is not indented.  This is not really a problem when you are writing a book
8608 where the outline headings are really section headlines.  However, in a more
8609 list-oriented outline, it is clear that an indented structure is a lot
8610 cleaner, as can be seen by comparing the two columns in the following
8611 example: 
8613 @example
8614 @group
8615 * Top level headline             |    * Top level headline
8616 ** Second level                  |      * Second level
8617 *** 3rd level                    |        * 3rd level
8618 some text                        |          some text
8619 *** 3rd level                    |        * 3rd level
8620 more text                        |          more text
8621 * Another top level headline     |    * Another top level headline
8622 @end group
8623 @end example
8625 @noindent
8626 It is non-trivial to make such a look work in Emacs, but Org contains three
8627 separate features that, combined, achieve just that.
8629 @enumerate
8630 @item 
8631 @emph{Indentation of text below headlines}@*
8632 You may indent text below each headline to make the left boundary line up
8633 with the headline, like
8635 @example
8636 *** 3rd level
8637     more text, now indented
8638 @end example
8640 A good way to get this indentation is by hand, and Org supports this with
8641 paragraph filling, line wrapping, and structure editing@footnote{See also the
8642 variable @code{org-adapt-indentation}.} preserving or adapting the
8643 indentation appropriate.  A different approach would be to have a way to
8644 automatically indent lines according to outline structure by adding overlays
8645 or text properties.  But I have not yet found a robust and efficient way to
8646 do this in large files.
8648 @item
8649 @emph{Hiding leading stars}@* You can modify the display in such a way that
8650 all leading stars become invisible.  To do this in a global way, configure
8651 the variable @code{org-hide-leading-stars} or change this on a per-file basis
8652 with
8654 @example
8655 #+STARTUP: hidestars
8656 @end example
8658 @noindent
8659 Note that the opposite behavior is selected with @code{showstars}.
8661 With hidden stars, the tree becomes:
8663 @example
8664 @group
8665 * Top level headline
8666  * Second level
8667   * 3rd level
8668   ...
8669 @end group
8670 @end example
8672 @noindent
8673 Note that the leading stars are not truly replaced by whitespace, they
8674 are only fontified with the face @code{org-hide} that uses the
8675 background color as font color.  If you are not using either white or
8676 black background, you may have to customize this face to get the wanted
8677 effect.  Another possibility is to set this font such that the extra
8678 stars are @i{almost} invisible, for example using the color
8679 @code{grey90} on a white background.
8681 @item
8682 Things become cleaner still if you skip all the even levels and use only odd
8683 levels 1, 3, 5..., effectively adding two stars to go from one outline level
8684 to the next.  In this way we get the outline view shown at the beginning of
8685 this section.  In order to make the structure editing and export commands
8686 handle this convention correctly, configure the variable
8687 @code{org-odd-levels-only}, or set this on a per-file basis with one of the
8688 following lines:
8690 @example
8691 #+STARTUP: odd
8692 #+STARTUP: oddeven
8693 @end example
8695 You can convert an Org file from single-star-per-level to the
8696 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
8697 RET} in that file.  The reverse operation is @kbd{M-x
8698 org-convert-to-oddeven-levels}.
8699 @end enumerate
8701 @node TTY keys, Interaction, Clean view, Miscellaneous
8702 @section Using Org on a tty
8703 @cindex tty key bindings
8705 Because Org contains a large number of commands, by default much of
8706 Org's core commands are bound to keys that are generally not
8707 accessible on a tty, such as the cursor keys (@key{left}, @key{right},
8708 @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
8709 together with modifiers like @key{Meta} and/or @key{Shift}.  To access
8710 these commands on a tty when special keys are unavailable, the following
8711 alternative bindings can be used.  The tty bindings below will likely be
8712 more cumbersome; you may find for some of the bindings below that a
8713 customized work-around suits you better.  For example, changing a time
8714 stamp is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
8715 tty you would rather use @kbd{C-c .} to re-insert the timestamp.
8717 @multitable @columnfractions 0.15 0.2 0.2
8718 @item @b{Default} @tab @b{Alternative 1} @tab @b{Alternative 2}
8719 @item @kbd{S-@key{TAB}}     @tab @kbd{C-u @key{TAB}}       @tab
8720 @item @kbd{M-@key{left}}    @tab @kbd{C-c C-x l}           @tab @kbd{@key{Esc} @key{left}}
8721 @item @kbd{M-S-@key{left}}  @tab @kbd{C-c C-x L}           @tab
8722 @item @kbd{M-@key{right}}   @tab @kbd{C-c C-x i}           @tab @kbd{@key{Esc} @key{right}}
8723 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R}           @tab
8724 @item @kbd{M-@key{up}}      @tab @kbd{C-c C-x u}           @tab @kbd{@key{Esc} @key{up}}
8725 @item @kbd{M-S-@key{up}}    @tab @kbd{C-c C-x U}           @tab
8726 @item @kbd{M-@key{down}}    @tab @kbd{C-c C-x d}           @tab @kbd{@key{Esc} @key{down}}
8727 @item @kbd{M-S-@key{down}}  @tab @kbd{C-c C-x D}           @tab
8728 @item @kbd{S-@key{RET}}     @tab @kbd{C-c C-x c}           @tab
8729 @item @kbd{M-@key{RET}}     @tab @kbd{C-c C-x m}           @tab @kbd{@key{Esc} @key{RET}}
8730 @item @kbd{M-S-@key{RET}}   @tab @kbd{C-c C-x M}           @tab
8731 @item @kbd{S-@key{left}}    @tab @kbd{C-c @key{left}}      @tab
8732 @item @kbd{S-@key{right}}   @tab @kbd{C-c @key{right}}     @tab
8733 @item @kbd{S-@key{up}}      @tab @kbd{C-c @key{up}}        @tab
8734 @item @kbd{S-@key{down}}    @tab @kbd{C-c @key{down}}      @tab
8735 @item @kbd{C-S-@key{left}}  @tab @kbd{C-c C-x @key{left}}  @tab
8736 @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab
8737 @end multitable
8739 @node Interaction, Bugs, TTY keys, Miscellaneous
8740 @section Interaction with other packages
8741 @cindex packages, interaction with other
8742 Org lives in the world of GNU Emacs and interacts in various ways
8743 with other code out there.
8745 @menu
8746 * Cooperation::                 Packages Org cooperates with
8747 * Conflicts::                   Packages that lead to conflicts
8748 @end menu
8750 @node Cooperation, Conflicts, Interaction, Interaction
8751 @subsection Packages that Org cooperates with
8753 @table @asis
8754 @cindex @file{calc.el}
8755 @item @file{calc.el} by Dave Gillespie
8756 Org uses the Calc package for implementing spreadsheet
8757 functionality in its tables (@pxref{The spreadsheet}).  Org
8758 checks for the availability of Calc by looking for the function
8759 @code{calc-eval} which should be autoloaded in your setup if Calc has
8760 been installed properly.  As of Emacs 22, Calc is part of the Emacs
8761 distribution.  Another possibility for interaction between the two
8762 packages is using Calc for embedded calculations. @xref{Embedded Mode,
8763 , Embedded Mode, Calc, GNU Emacs Calc Manual}.
8764 @cindex @file{constants.el}
8765 @item @file{constants.el} by Carsten Dominik
8766 In a table formula (@pxref{The spreadsheet}), it is possible to use
8767 names for natural constants or units.  Instead of defining your own
8768 constants in the variable @code{org-table-formula-constants}, install
8769 the @file{constants} package which defines a large number of constants
8770 and units, and lets you use unit prefixes like @samp{M} for
8771 @samp{Mega} etc.  You will need version 2.0 of this package, available
8772 at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for
8773 the function @code{constants-get}, which has to be autoloaded in your
8774 setup.  See the installation instructions in the file
8775 @file{constants.el}.
8776 @item @file{cdlatex.el} by Carsten Dominik
8777 @cindex @file{cdlatex.el}
8778 Org mode can make use of the CDLaTeX package to efficiently enter
8779 La@TeX{} fragments into Org files. See @ref{CDLaTeX mode}.
8780 @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
8781 @cindex @file{imenu.el}
8782 Imenu allows menu access to an index of items in a file.  Org mode
8783 supports Imenu - all you need to do to get the index is the following:
8784 @lisp
8785 (add-hook 'org-mode-hook
8786           (lambda () (imenu-add-to-menubar "Imenu")))
8787 @end lisp
8788 By default the index is two levels deep - you can modify the depth using
8789 the option @code{org-imenu-depth}.
8790 @item @file{remember.el} by John Wiegley
8791 @cindex @file{remember.el}
8792 Org cooperates with remember, see @ref{Remember}.
8793 @file{Remember.el} is not part of Emacs, find it on the web.
8794 @item @file{speedbar.el} by Eric M. Ludlam
8795 @cindex @file{speedbar.el}
8796 Speedbar is a package that creates a special frame displaying files and
8797 index items in files.  Org mode supports Speedbar and allows you to
8798 drill into Org files directly from the Speedbar.  It also allows to
8799 restrict the scope of agenda commands to a file or a subtree by using
8800 the command @kbd{<} in the Speedbar frame.
8801 @cindex @file{table.el}
8802 @item @file{table.el} by Takaaki Ota
8803 @kindex C-c C-c
8804 @cindex table editor, @file{table.el}
8805 @cindex @file{table.el}
8807 Complex ASCII tables with automatic line wrapping, column- and
8808 row-spanning, and alignment can be created using the Emacs table
8809 package by Takaaki Ota (@uref{http://sourceforge.net/projects/table},
8810 and also part of Emacs 22).
8811 When @key{TAB} or @kbd{C-c C-c} is pressed in such a table, Org mode
8812 will call @command{table-recognize-table} and move the cursor into the
8813 table.  Inside a table, the keymap of Org mode is inactive.  In order
8814 to execute Org mode-related commands, leave the table.
8816 @table @kbd
8817 @kindex C-c C-c
8818 @item C-c C-c
8819 Recognize @file{table.el} table.  Works when the cursor is in a
8820 table.el table.
8822 @kindex C-c ~
8823 @item C-c ~
8824 Insert a table.el table.  If there is already a table at point, this
8825 command converts it between the table.el format and the Org mode
8826 format.  See the documentation string of the command
8827 @code{org-convert-table} for the restrictions under which this is
8828 possible.
8829 @end table
8830 @file{table.el} is part of Emacs 22.
8831 @cindex @file{footnote.el}
8832 @item @file{footnote.el} by Steven L. Baur
8833 Org mode recognizes numerical footnotes as provided by this package
8834 (@pxref{Footnotes}).
8835 @end table
8837 @node Conflicts,  , Cooperation, Interaction
8838 @subsection Packages that lead to conflicts with Org mode
8840 @table @asis
8842 @cindex @file{allout.el}
8843 @item @file{allout.el} by Ken Manheimer
8844 Startup of Org may fail with the error message
8845 @code{(wrong-type-argument keymapp nil)} when there is an outdated
8846 version @file{allout.el} on the load path, for example the version
8847 distributed with Emacs 21.x.  Upgrade to Emacs 22 and this problem will
8848 disappear.  If for some reason you cannot do this, make sure that org.el
8849 is loaded @emph{before} @file{allout.el}, for example by putting
8850 @code{(require 'org)} early enough into your @file{.emacs} file.
8852 @cindex @file{CUA.el}
8853 @item @file{CUA.el} by Kim. F. Storm
8854 Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by
8855 CUA mode (as well as pc-select-mode and s-region-mode) to select and
8856 extend the region.  If you want to use one of these packages along with
8857 Org, configure the variable @code{org-replace-disputed-keys}.  When
8858 set, Org will move the following key bindings in Org files, and
8859 in the agenda buffer (but not during date selection).
8861 @example
8862 S-UP    -> M-p             S-DOWN  -> M-n
8863 S-LEFT  -> M--             S-RIGHT -> M-+
8864 @end example
8866 Yes, these are unfortunately more difficult to remember.  If you want
8867 to have other replacement keys, look at the variable
8868 @code{org-disputed-keys}.
8869 @item @file{windmove.el} by Hovav Shacham
8870 @cindex @file{windmove.el}
8871 Also this package uses the @kbd{S-<cursor>} keys, so everything written
8872 in the paragraph above about CUA mode also applies here.
8874 @cindex @file{footnote.el}
8875 @item @file{footnote.el} by Steven L. Baur
8876 Org supports the syntax of the footnote package, but only the
8877 numerical footnote markers.  Also, the default key for footnote
8878 commands, @kbd{C-c !} is already used by Org.  You could use the
8879 variable @code{footnote-prefix} to switch footnotes commands to another
8880 key.  Or, you could use @code{org-replace-disputed-keys} and
8881 @code{org-disputed-keys} to change the settings in Org.
8883 @end table
8886 @node Bugs,  , Interaction, Miscellaneous
8887 @section Bugs
8888 @cindex bugs
8890 Here is a list of things that should work differently, but which I
8891 have found too hard to fix.
8893 @itemize @bullet
8894 @item
8895 If a table field starts with a link, and if the corresponding table
8896 column is narrowed (@pxref{Narrow columns}) to a width too small to
8897 display the link, the field would look entirely empty even though it is
8898 not.  To prevent this, Org throws an error.  The work-around is to
8899 make the column wide enough to fit the link, or to add some text (at
8900 least 2 characters) before the link in the same field.
8901 @item
8902 Narrowing table columns does not work on XEmacs, because the
8903 @code{format} function does not transport text properties.
8904 @item
8905 Text in an entry protected with the @samp{QUOTE} keyword should not
8906 autowrap.
8907 @item
8908 When the application called by @kbd{C-c C-o} to open a file link fails
8909 (for example because the application does not exist or refuses to open
8910 the file), it does so silently.  No error message is displayed.
8911 @item
8912 Recalculating a table line applies the formulas from left to right.
8913 If a formula uses @emph{calculated} fields further down the row,
8914 multiple recalculation may be needed to get all fields consistent.  You
8915 may use the command @code{org-table-iterate} (@kbd{C-u C-c *}) to
8916 recalculate until convergence.
8917 @item
8918 The exporters work well, but could be made more efficient.
8919 @end itemize
8922 @node Extensions, Hacking, Miscellaneous, Top
8923 @appendix Extensions
8925 This appendix lists the extension modules that have been written for Org.
8926 Many of these extensions live in the @file{contrib} directory of the Org
8927 distribution, others are available somewhere on the web.
8929 @menu
8930 * Extensions in the contrib directory::  These come with the Org distro
8931 * Other extensions::            These you have to find on the web.
8932 @end menu
8934 @node Extensions in the contrib directory, Other extensions, Extensions, Extensions
8935 @section Extensions in the @file{contrib} directory
8937 @table @asis
8938 @item @file{org-annotate-file.el} by @i{Philip Jackson}
8939       Annotate a file with org syntax, in a separate file, with links back to
8940       the annotated file.
8941 @item @file{org-annotation-helper.el} by @i{Bastien Guerry and Daniel E. German} 
8942       Call @i{remember} directly from Firefox/Opera, or from Adobe Reader.
8943       When activating a special link or bookmark, Emacs receives a trigger to
8944       create a note with a link back to the website.  Requires some setup, a
8945       detailes description is in
8946       @file{contrib/packages/org-annotation-helper}.
8947 @item @file{org-bookmark.el} by @i{Tokuya Kameshima}
8948       Support for links to Emacs bookmarks.
8949 @item @file{org-depend.el} by @i{Carsten Dominik}
8950       TODO dependencies for Org-mode.  Make TODO state changes in one entry
8951       trigger changes in another, or be blocked by the state of another
8952       entry.  Also, easily create chains of TODO items with exactly one
8953       active item at any time.
8954 @item @file{org-elisp-symbol.el} by @i{Bastien Guerry}
8955       Org links to emacs-lisp symbols.  This can create annotated links that
8956       exactly point to the definition location of a variable of function.
8957 @item @file{org-eval.el} by @i{Carsten Dominik}
8958       The @code{<lisp>} tag, adapted from Emacs Wiki and Emacs Muse, allows
8959       to include text in a document that is the result of evaluating some
8960       code.  Other scripting languages like @code{perl} can be supported with
8961       this package as well.
8962 @item @file{org-expiry.el} by @i{Bastien Guerry}
8963       Expiry mechanism for Org entries.
8964 @item @file{org-indent.el} by @i{Carsten Dominik}
8965       Dynamic indentation of Org outlines.  The plan is to indent an outline
8966       according to level, but so far this is too hard for a proper and stable
8967       implementation.  Still, it works somewhat.
8968 @item @file{org-interactive-query.el} by @i{Christopher League}
8969       Interactive modification of tags queries.  After running a general
8970       query in Org, this package allows to narrow down the results by adding
8971       more tags or keywords.
8972 @item @file{org-mairix.el} by @i{Georg C. F. Greve}
8973       Hook mairix search into Org for different MUAs.
8974 @item @file{org-man.el} by @i{Carsten Dominik}
8975       Support for links to manpages in Org-mode.
8976 @item @file{org-mtags.el} by @i{Carsten Dominik}
8977       Support for some Muse-like tags in Org-mode.  This package allows you
8978       to write @code{<example>} and @code{<src>} and other syntax copied from
8979       Emacs Muse, right inside an Org file.  The goal here is to make it easy
8980       to publish the same file using either org-publish or Muse.
8981 @item @file{org-panel.el} by @i{Lennard Borgman}
8982       Simplified and display-aided access to some Org commands.
8983 @c @item @file{org-plot.el} by @i{Eric Schulte}
8984 @c      Plotting Org tables with Gnuplot.
8985 @item @file{org-registry.el} by @i{Bastien Guerry}
8986       A registry for Org links, to find out from where links point to a given
8987       file or location.
8988 @item @file{org2rem.el} by @i{Bastien Guerry}
8989       Convert org appointments into reminders for the @file{remind} program.
8990 @item @file{org-screen.el} by @i{Andrew Hyatt}
8991       Visit screen sessions through Org-mode links.
8992 @item @file{org-toc.el} by @i{Bastien Guerry}
8993       Table of contents in a separate buffer, with fast access to sections
8994       and easy visibility cycling.
8995 @item @file{orgtbl-sqlinsert.el} by @i{Jason Riedy}
8996       Convert Org-mode tables to SQL insertions.  Documentation for this can
8997       be found on the Worg pages.
8998 @end table
9001 @node Other extensions,  , Extensions in the contrib directory, Extensions
9002 @section Other extensions
9004 @i{TO BE DONE}
9006 @node Hacking, History and Acknowledgments, Extensions, Top
9007 @appendix Hacking
9009 This appendix covers some aspects where users can extend the functionality of
9010 Org.
9012 @menu
9013 * Adding hyperlink types::      New custom link types
9014 * Tables in arbitrary syntax::  Orgtbl for LaTeX and other programs
9015 * Dynamic blocks::              Automatically filled blocks
9016 * Special agenda views::        Customized views
9017 * Using the property API::      Writing programs that use entry properties
9018 * Using the mapping API::       Mapping over all or selected entries
9019 @end menu
9021 @node Adding hyperlink types, Tables in arbitrary syntax, Hacking, Hacking
9022 @section Adding hyperlink types
9023 @cindex hyperlinks, adding new types
9025 Org has a large number of hyperlink types built-in
9026 (@pxref{Hyperlinks}).  If you would like to add new link types, it
9027 provides an interface for doing so.  Let's look at an example file
9028 @file{org-man.el} that will add support for creating links like
9029 @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
9030 emacs:
9032 @lisp
9033 ;;; org-man.el - Support for links to manpages in Org
9035 (require 'org)
9037 (org-add-link-type "man" 'org-man-open)
9038 (add-hook 'org-store-link-functions 'org-man-store-link)
9040 (defcustom org-man-command 'man
9041   "The Emacs command to be used to display a man page."
9042   :group 'org-link
9043   :type '(choice (const man) (const woman)))
9045 (defun org-man-open (path)
9046   "Visit the manpage on PATH.
9047 PATH should be a topic that can be thrown at the man command."
9048   (funcall org-man-command path))
9050 (defun org-man-store-link ()
9051   "Store a link to a manpage."
9052   (when (memq major-mode '(Man-mode woman-mode))
9053     ;; This is a man page, we do make this link
9054     (let* ((page (org-man-get-page-name))
9055            (link (concat "man:" page))
9056            (description (format "Manpage for %s" page)))
9057       (org-store-link-props
9058        :type "man"
9059        :link link
9060        :description description))))
9062 (defun org-man-get-page-name ()
9063   "Extract the page name from the buffer name."
9064   ;; This works for both `Man-mode' and `woman-mode'.
9065   (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
9066       (match-string 1 (buffer-name))
9067     (error "Cannot create link to this man page")))
9069 (provide 'org-man)
9071 ;;; org-man.el ends here
9072 @end lisp
9074 @noindent
9075 You would activate this new link type in @file{.emacs} with
9077 @lisp
9078 (require 'org-man)
9079 @end lisp
9081 @noindent
9082 Let's go through the file and see what it does.
9083 @enumerate
9084 @item
9085 It does @code{(require 'org)} to make sure that @file{org.el} has been
9086 loaded.
9087 @item
9088 The next line calls @code{org-add-link-type} to define a new link type
9089 with prefix @samp{man}.  The call also contains the name of a function
9090 that will be called to follow such a link.
9091 @item
9092 The next line adds a function to @code{org-store-link-functions}, in
9093 order to allow the command @kbd{C-c l} to record a useful link in a
9094 buffer displaying a man page.
9095 @end enumerate
9097 The rest of the file defines the necessary variables and functions.
9098 First there is a customization variable that determines which emacs
9099 command should be used to display man pages.  There are two options,
9100 @code{man} and @code{woman}.  Then the function to follow a link is
9101 defined.  It gets the link path as an argument - in this case the link
9102 path is just a topic for the manual command.  The function calls the
9103 value of @code{org-man-command} to display the man page.
9105 Finally the function @code{org-man-store-link} is defined.  When you try
9106 to store a link with @kbd{C-c l}, also this function will be called to
9107 try to make a link.  The function must first decide if it is supposed to
9108 create the link for this buffer type, we do this by checking the value
9109 of the variable @code{major-mode}.  If not, the function must exit and
9110 return the value @code{nil}.  If yes, the link is created by getting the
9111 manual topic from the buffer name and prefixing it with the string
9112 @samp{man:}.  Then it must call the command @code{org-store-link-props}
9113 and set the @code{:type} and @code{:link} properties.  Optionally you
9114 can also set the @code{:description} property to provide a default for
9115 the link description when the link is later inserted into an Org
9116 buffer with @kbd{C-c C-l}.
9118 @node Tables in arbitrary syntax, Dynamic blocks, Adding hyperlink types, Hacking
9119 @section Tables and lists in arbitrary syntax
9120 @cindex tables, in other modes
9121 @cindex lists, in other modes
9122 @cindex Orgtbl mode
9124 Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
9125 frequent feature request has been to make it work with native tables in
9126 specific languages, for example La@TeX{}.  However, this is extremely
9127 hard to do in a general way, would lead to a customization nightmare,
9128 and would take away much of the simplicity of the Orgtbl mode table
9129 editor.
9132 This appendix describes a different approach.  We keep the Orgtbl mode
9133 table in its native format (the @i{source table}), and use a custom
9134 function to @i{translate} the table to the correct syntax, and to
9135 @i{install} it in the right location (the @i{target table}).  This puts
9136 the burden of writing conversion functions on the user, but it allows
9137 for a very flexible system.
9139 Bastien added the ability to do the same with lists.  You can use Org's
9140 facilities to edit and structure lists by turning @code{orgstruct-mode}
9141 on, then locally exporting such lists in another format (HTML, La@TeX{}
9142 or Texinfo.)
9145 @menu
9146 * Radio tables::                Sending and receiving
9147 * A LaTeX example::             Step by step, almost a tutorial
9148 * Translator functions::        Copy and modify
9149 * Radio lists::                 Doing the same for lists
9150 @end menu
9152 @node Radio tables, A LaTeX example, Tables in arbitrary syntax, Tables in arbitrary syntax
9153 @subsection Radio tables
9154 @cindex radio tables
9156 To define the location of the target table, you first need to create two
9157 lines that are comments in the current mode, but contain magic words for
9158 Orgtbl mode to find.  Orgtbl mode will insert the translated table
9159 between these lines, replacing whatever was there before.  For example:
9161 @example
9162 /* BEGIN RECEIVE ORGTBL table_name */
9163 /* END RECEIVE ORGTBL table_name */
9164 @end example
9166 @noindent
9167 Just above the source table, we put a special line that tells
9168 Orgtbl mode how to translate this table and where to install it.  For
9169 example:
9170 @example
9171 #+ORGTBL: SEND table_name translation_function arguments....
9172 @end example
9174 @noindent
9175 @code{table_name} is the reference name for the table that is also used
9176 in the receiver lines. @code{translation_function} is the Lisp function
9177 that does the translation.  Furthermore, the line can contain a list of
9178 arguments (alternating key and value) at the end.  The arguments will be
9179 passed as a property list to the translation function for
9180 interpretation.  A few standard parameters are already recognized and
9181 acted upon before the translation function is called:
9183 @table @code
9184 @item :skip N
9185 Skip the first N lines of the table.  Hlines do count as separate lines for
9186 this parameter!
9188 @item :skipcols (n1 n2 ...)
9189 List of columns that should be skipped.  If the table has a column with
9190 calculation marks, that column is automatically discarded as well.
9191 Please note that the translator function sees the table @emph{after} the
9192 removal of these columns, the function never knows that there have been
9193 additional columns.
9194 @end table
9196 @noindent
9197 The one problem remaining is how to keep the source table in the buffer
9198 without disturbing the normal workings of the file, for example during
9199 compilation of a C file or processing of a La@TeX{} file.  There are a
9200 number of different solutions:
9202 @itemize @bullet
9203 @item
9204 The table could be placed in a block comment if that is supported by the
9205 language.  For example, in C mode you could wrap the table between
9206 @samp{/*} and @samp{*/} lines.
9207 @item
9208 Sometimes it is possible to put the table after some kind of @i{END}
9209 statement, for example @samp{\bye} in TeX and @samp{\end@{document@}}
9210 in La@TeX{}.
9211 @item
9212 You can just comment the table line by line whenever you want to process
9213 the file, and uncomment it whenever you need to edit the table.  This
9214 only sounds tedious - the command @kbd{M-x orgtbl-toggle-comment} does
9215 make this comment-toggling very easy, in particular if you bind it to a
9216 key.
9217 @end itemize
9219 @node A LaTeX example, Translator functions, Radio tables, Tables in arbitrary syntax
9220 @subsection A LaTeX example of radio tables
9221 @cindex LaTeX, and Orgtbl mode
9223 The best way to wrap the source table in La@TeX{} is to use the
9224 @code{comment} environment provided by @file{comment.sty}.  It has to be
9225 activated by placing @code{\usepackage@{comment@}} into the document
9226 header.  Orgtbl mode can insert a radio table skeleton@footnote{By
9227 default this works only for La@TeX{}, HTML, and Texinfo.  Configure the
9228 variable @code{orgtbl-radio-tables} to install templates for other
9229 modes.}  with the command @kbd{M-x orgtbl-insert-radio-table}.  You will
9230 be prompted for a table name, lets say we use @samp{salesfigures}.  You
9231 will then get the following template:
9233 @cindex #+ORGTBL: SEND
9234 @example
9235 % BEGIN RECEIVE ORGTBL salesfigures
9236 % END RECEIVE ORGTBL salesfigures
9237 \begin@{comment@}
9238 #+ORGTBL: SEND salesfigures orgtbl-to-latex
9239 | | |
9240 \end@{comment@}
9241 @end example
9243 @noindent
9244 The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
9245 @code{orgtbl-to-latex} to convert the table into La@TeX{} and to put it
9246 into the receiver location with name @code{salesfigures}.  You may now
9247 fill in the table, feel free to use the spreadsheet features@footnote{If
9248 the @samp{#+TBLFM} line contains an odd number of dollar characters,
9249 this may cause problems with font-lock in LaTeX mode.  As shown in the
9250 example you can fix this by adding an extra line inside the
9251 @code{comment} environment that is used to balance the dollar
9252 expressions.  If you are using AUCTeX with the font-latex library, a
9253 much better solution is to add the @code{comment} environment to the
9254 variable @code{LaTeX-verbatim-environments}.}:
9256 @example
9257 % BEGIN RECEIVE ORGTBL salesfigures
9258 % END RECEIVE ORGTBL salesfigures
9259 \begin@{comment@}
9260 #+ORGTBL: SEND salesfigures orgtbl-to-latex
9261 | Month | Days | Nr sold | per day |
9262 |-------+------+---------+---------|
9263 | Jan   |   23 |      55 |     2.4 |
9264 | Feb   |   21 |      16 |     0.8 |
9265 | March |   22 |     278 |    12.6 |
9266 #+TBLFM: $4=$3/$2;%.1f
9267 % $ (optional extra dollar to keep font-lock happy, see footnote)
9268 \end@{comment@}
9269 @end example
9271 @noindent
9272 When you are done, press @kbd{C-c C-c} in the table to get the converted
9273 table inserted between the two marker lines.
9275 Now lets assume you want to make the table header by hand, because you
9276 want to control how columns are aligned etc.  In this case we make sure
9277 that the table translator does skip the first 2 lines of the source
9278 table, and tell the command to work as a @i{splice}, i.e. to not produce
9279 header and footer commands of the target table:
9281 @example
9282 \begin@{tabular@}@{lrrr@}
9283 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
9284 % BEGIN RECEIVE ORGTBL salesfigures
9285 % END RECEIVE ORGTBL salesfigures
9286 \end@{tabular@}
9288 \begin@{comment@}
9289 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
9290 | Month | Days | Nr sold | per day |
9291 |-------+------+---------+---------|
9292 | Jan   |   23 |      55 |     2.4 |
9293 | Feb   |   21 |      16 |     0.8 |
9294 | March |   22 |     278 |    12.6 |
9295 #+TBLFM: $4=$3/$2;%.1f
9296 \end@{comment@}
9297 @end example
9299 The La@TeX{} translator function @code{orgtbl-to-latex} is already part of
9300 Orgtbl mode.  It uses a @code{tabular} environment to typeset the table
9301 and marks horizontal lines with @code{\hline}.  Furthermore, it
9302 interprets the following parameters (see also @ref{Translator functions}):
9304 @table @code
9305 @item :splice nil/t
9306 When set to t, return only table body lines, don't wrap them into a
9307 tabular environment.  Default is nil.
9309 @item :fmt fmt
9310 A format to be used to wrap each field, should contain @code{%s} for the
9311 original field value.  For example, to wrap each field value in dollars,
9312 you could use @code{:fmt "$%s$"}.  This may also be a property list with
9313 column numbers and formats. for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
9314 A function of one argument can be used in place of the strings; the
9315 function must return a formatted string.
9317 @item :efmt efmt
9318 Use this format to print numbers with exponentials.  The format should
9319 have @code{%s} twice for inserting mantissa and exponent, for example
9320 @code{"%s\\times10^@{%s@}"}.  The default is @code{"%s\\,(%s)"}.  This
9321 may also be a property list with column numbers and formats, for example
9322 @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}.  After
9323 @code{efmt} has been applied to a value, @code{fmt} will also be
9324 applied.  Similar to @code{fmt}, functions of two arguments can be
9325 supplied instead of strings.
9326 @end table
9328 @node Translator functions, Radio lists, A LaTeX example, Tables in arbitrary syntax
9329 @subsection Translator functions
9330 @cindex HTML, and Orgtbl mode
9331 @cindex translator function
9333 Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
9334 (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
9335 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and @code{orgtbl-to-texinfo}.
9336 Except for @code{orgtbl-to-html}@footnote{The HTML translator uses the same
9337 code that produces tables during HTML export.}, these all use a generic
9338 translator, @code{orgtbl-to-generic}.  For example, @code{orgtbl-to-latex}
9339 itself is a very short function that computes the column definitions for the
9340 @code{tabular} environment, defines a few field and line separators and then
9341 hands over to the generic translator.  Here is the entire code:
9343 @lisp
9344 @group
9345 (defun orgtbl-to-latex (table params)
9346   "Convert the Orgtbl mode TABLE to LaTeX."
9347   (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
9348                                org-table-last-alignment ""))
9349          (params2
9350           (list
9351            :tstart (concat "\\begin@{tabular@}@{" alignment "@}")
9352            :tend "\\end@{tabular@}"
9353            :lstart "" :lend " \\\\" :sep " & "
9354            :efmt "%s\\,(%s)" :hline "\\hline")))
9355     (orgtbl-to-generic table (org-combine-plists params2 params))))
9356 @end group
9357 @end lisp
9359 As you can see, the properties passed into the function (variable
9360 @var{PARAMS}) are combined with the ones newly defined in the function
9361 (variable @var{PARAMS2}).  The ones passed into the function (i.e. the
9362 ones set by the @samp{ORGTBL SEND} line) take precedence.  So if you
9363 would like to use the La@TeX{} translator, but wanted the line endings to
9364 be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
9365 overrule the default with
9367 @example
9368 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
9369 @end example
9371 For a new language, you can either write your own converter function in
9372 analogy with the La@TeX{} translator, or you can use the generic function
9373 directly.  For example, if you have a language where a table is started
9374 with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are
9375 started with @samp{!BL!}, ended with @samp{!EL!} and where the field
9376 separator is a TAB, you could call the generic translator like this (on
9377 a single line!):
9379 @example
9380 #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
9381                               :lstart "!BL! " :lend " !EL!" :sep "\t"
9382 @end example
9384 @noindent
9385 Please check the documentation string of the function
9386 @code{orgtbl-to-generic} for a full list of parameters understood by
9387 that function and remember that you can pass each of them into
9388 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
9389 using the generic function.
9391 Of course you can also write a completely new function doing complicated
9392 things the generic translator cannot do.  A translator function takes
9393 two arguments.  The first argument is the table, a list of lines, each
9394 line either the symbol @code{hline} or a list of fields.  The second
9395 argument is the property list containing all parameters specified in the
9396 @samp{#+ORGTBL: SEND} line.  The function must return a single string
9397 containing the formatted table.  If you write a generally useful
9398 translator, please post it on @code{emacs-orgmode@@gnu.org} so that
9399 others can benefit from your work.
9401 @node  Radio lists,  , Translator functions, Tables in arbitrary syntax
9402 @subsection Radio lists
9403 @cindex radio lists
9404 @cindex org-list-insert-radio-list
9406 Sending and receiving radio lists works exactly the same way than
9407 sending and receiving radio tables (@pxref{Radio tables}) @footnote{You
9408 need to load the @code{org-export-latex.el} package to use radio lists
9409 since the relevant code is there for now.}.  As for radio tables, you
9410 can insert radio lists templates in HTML, La@TeX{} and Texinfo modes by
9411 calling @code{org-list-insert-radio-list}.
9413 Here are the differences with radio tables:
9415 @itemize @minus
9416 @item
9417 Use @code{ORGLST} instead of @code{ORGTBL}.
9418 @item
9419 The available translation functions for radio lists don't take
9420 parameters.
9421 @item
9422 `C-c C-c' will work when pressed on the first item of the list.
9423 @end itemize
9425 Here is a La@TeX{} example.  Let's say that you have this in your
9426 La@TeX{} file:
9428 @example
9429 % BEGIN RECEIVE ORGLST to-buy
9430 % END RECEIVE ORGLST to-buy
9431 \begin@{comment@}
9432 #+ORGLIST: SEND to-buy orgtbl-to-latex
9433 - a new house
9434 - a new computer
9435   + a new keyboard
9436   + a new mouse
9437 - a new life
9438 \end@{comment@}
9439 @end example
9441 Pressing `C-c C-c' on @code{a new house} and will insert the converted
9442 La@TeX{} list between the two marker lines.
9444 @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Hacking
9445 @section Dynamic blocks
9446 @cindex dynamic blocks
9448 Org documents can contain @emph{dynamic blocks}.  These are
9449 specially marked regions that are updated by some user-written function.
9450 A good example for such a block is the clock table inserted by the
9451 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
9453 Dynamic block are enclosed by a BEGIN-END structure that assigns a name
9454 to the block and can also specify parameters for the function producing
9455 the content of the block.
9457 #+BEGIN:dynamic block
9458 @example
9459 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
9461 #+END:
9462 @end example
9464 Dynamic blocks are updated with the following commands
9466 @table @kbd
9467 @kindex C-c C-x C-u
9468 @item C-c C-x C-u
9469 Update dynamic block at point.
9470 @kindex C-u C-c C-x C-u
9471 @item C-u C-c C-x C-u
9472 Update all dynamic blocks in the current file.
9473 @end table
9475 Updating a dynamic block means to remove all the text between BEGIN and
9476 END, parse the BEGIN line for parameters and then call the specific
9477 writer function for this block to insert the new content.  If you want
9478 to use the original content in the writer function, you can use the
9479 extra parameter @code{:content}.
9481 For a block with name @code{myblock}, the writer function is
9482 @code{org-dblock-write:myblock} with as only parameter a property list
9483 with the parameters given in the begin line.  Here is a trivial example
9484 of a block that keeps track of when the block update function was last
9485 run:
9487 @example
9488 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
9490 #+END:
9491 @end example
9493 @noindent
9494 The corresponding block writer function could look like this:
9496 @lisp
9497 (defun org-dblock-write:block-update-time (params)
9498    (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
9499      (insert "Last block update at: "
9500              (format-time-string fmt (current-time)))))
9501 @end lisp
9503 If you want to make sure that all dynamic blocks are always up-to-date,
9504 you could add the function @code{org-update-all-dblocks} to a hook, for
9505 example @code{before-save-hook}.  @code{org-update-all-dblocks} is
9506 written in a way that is does nothing in buffers that are not in
9507 @code{org-mode}.
9509 @node Special agenda views, Using the property API, Dynamic blocks, Hacking
9510 @section Special agenda views
9511 @cindex agenda views, user-defined
9513 Org provides a special hook that can be used to narrow down the
9514 selection made by any of the agenda views.  You may specify a function
9515 that is used at each match to verify if the match should indeed be part
9516 of the agenda view, and if not, how much should be skipped.
9518 Let's say you want to produce a list of projects that contain a WAITING
9519 tag anywhere in the project tree.  Let's further assume that you have
9520 marked all tree headings that define a project with the TODO keyword
9521 PROJECT.  In this case you would run a TODO search for the keyword
9522 PROJECT, but skip the match unless there is a WAITING tag anywhere in
9523 the subtree belonging to the project line.
9525 To achieve this, you must write a function that searches the subtree for
9526 the tag.  If the tag is found, the function must return @code{nil} to
9527 indicate that this match should not be skipped.  If there is no such
9528 tag, return the location of the end of the subtree, to indicate that
9529 search should continue from there.
9531 @lisp
9532 (defun my-skip-unless-waiting ()
9533   "Skip trees that are not waiting"
9534   (let ((subtree-end (save-excursion (org-end-of-subtree t))))
9535     (if (re-search-forward ":waiting:" subtree-end t)
9536         nil          ; tag found, do not skip
9537       subtree-end))) ; tag not found, continue after end of subtree
9538 @end lisp
9540 Now you may use this function in an agenda custom command, for example
9541 like this:
9543 @lisp
9544 (org-add-agenda-custom-command
9545  '("b" todo "PROJECT"
9546    ((org-agenda-skip-function 'my-skip-unless-waiting)
9547     (org-agenda-overriding-header "Projects waiting for something: "))))
9548 @end lisp
9550 Note that this also binds @code{org-agenda-overriding-header} to get a
9551 meaningful header in the agenda view.
9553 A general way to create custom searches is to base them on a search for
9554 entries with a certain level limit.  If you want to study all entries with
9555 your custom search function, simply do a search for @samp{LEVEL>0}, and then
9556 use @code{org-agenda-skip-function} to select the entries you really want to
9557 have.
9559 You may also put a Lisp form into @code{org-agenda-skip-function}.  In
9560 particular, you may use the functions @code{org-agenda-skip-entry-if}
9561 and @code{org-agenda-skip-subtree-if} in this form, for example:
9563 @table @code
9564 @item '(org-agenda-skip-entry-if 'scheduled)
9565 Skip current entry if it has been scheduled.
9566 @item '(org-agenda-skip-entry-if 'notscheduled)
9567 Skip current entry if it has not been scheduled.
9568 @item '(org-agenda-skip-entry-if 'deadline)
9569 Skip current entry if it has a deadline.
9570 @item '(org-agenda-skip-entry-if 'scheduled 'deadline)
9571 Skip current entry if it has a deadline, or if it is scheduled.
9572 @item '(org-agenda-skip-entry 'regexp "regular expression")
9573 Skip current entry if the regular expression matches in the entry.
9574 @item '(org-agenda-skip-entry 'notregexp "regular expression")
9575 Skip current entry unless the regular expression matches.
9576 @item '(org-agenda-skip-subtree-if 'regexp "regular expression")
9577 Same as above, but check and skip the entire subtree.
9578 @end table
9580 Therefore we could also have written the search for WAITING projects
9581 like this, even without defining a special function:
9583 @lisp
9584 (org-add-agenda-custom-command
9585  '("b" todo "PROJECT"
9586    ((org-agenda-skip-function '(org-agenda-skip-subtree-if
9587                                 'regexp ":waiting:"))
9588     (org-agenda-overriding-header "Projects waiting for something: "))))
9589 @end lisp
9591 @node Using the property API, Using the mapping API, Special agenda views, Hacking
9592 @section Using the property API
9593 @cindex API, for properties
9594 @cindex properties, API
9596 Here is a description of the functions that can be used to work with
9597 properties.
9599 @defun org-entry-properties &optional pom which
9600 Get all properties of the entry at point-or-marker POM.
9601 This includes the TODO keyword, the tags, time strings for deadline,
9602 scheduled, and clocking, and any additional properties defined in the
9603 entry.  The return value is an alist, keys may occur multiple times
9604 if the property key was used several times.
9605 POM may also be nil, in which case the current entry is used.
9606 If WHICH is nil or `all', get all properties.  If WHICH is
9607 `special' or `standard', only get that subclass.
9608 @end defun
9609 @defun org-entry-get pom property &optional inherit
9610 Get value of PROPERTY for entry at point-or-marker POM.  By default,
9611 this only looks at properties defined locally in the entry.  If INHERIT
9612 is non-nil and the entry does not have the property, then also check
9613 higher levels of the hierarchy.  If INHERIT is the symbol
9614 @code{selective}, use inheritance if and only if the setting of
9615 @code{org-use-property-inheritance} selects PROPERTY for inheritance.
9616 @end defun
9618 @defun org-entry-delete pom property
9619 Delete the property PROPERTY from entry at point-or-marker POM.
9620 @end defun
9622 @defun org-entry-put pom property value
9623 Set PROPERTY to VALUE for entry at point-or-marker POM.
9624 @end defun
9626 @defun org-buffer-property-keys &optional include-specials
9627 Get all property keys in the current buffer.
9628 @end defun
9630 @defun org-insert-property-drawer
9631 Insert a property drawer at point.
9632 @end defun
9634 @defun org-entry-put-multivalued-property pom property &rest values
9635 Set PROPERTY at point-or-marker POM to VALUES.  VALUES should be a list of
9636 strings.  They will be concatenated, with spaces as separators.
9637 @end defun
9639 @defun org-entry-get-multivalued-property pom property
9640 Treat the value of the property PROPERTY as a whitespace-separated list of
9641 values and return the values as a list of strings.
9642 @end defun
9644 @defun org-entry-add-to-multivalued-property pom property value
9645 Treat the value of the property PROPERTY as a whitespace-separated list of
9646 values and make sure that VALUE is in this list.
9647 @end defun
9649 @defun org-entry-remove-from-multivalued-property pom property value
9650 Treat the value of the property PROPERTY as a whitespace-separated list of
9651 values and make sure that VALUE is @emph{not} in this list.
9652 @end defun
9654 @defun org-entry-member-in-multivalued-property pom property value
9655 Treat the value of the property PROPERTY as a whitespace-separated list of
9656 values and check if VALUE is in this list.
9657 @end defun
9659 @node Using the mapping API,  , Using the property API, Hacking
9660 @section Using the mapping API
9661 @cindex API, for mapping
9662 @cindex mapping entries, API
9664 Org has sophisticated mapping capabilities to find all entries satisfying
9665 certain criteria.  Internally, this functionality is used to produce agenda
9666 views, but there is also an API that can be used to execute arbitrary
9667 functions for each or selected entries.  The main entry point for this API
9668 is: 
9670 @defun org-map-entries func &optional match scope &rest skip
9671 Call FUNC at each headline selected by MATCH in SCOPE.
9673 FUNC is a function or a lisp form.  The function will be called without
9674 arguments, with the cursor positioned at the beginning of the headline.
9675 The return values of all calls to the function will be collected and
9676 returned as a list.
9678 MATCH is a tags/property/todo match as it is used in the agenda match view.
9679 Only headlines that are matched by this query will be considered during
9680 the iteration.  When MATCH is nil or t, all headlines will be
9681 visited by the iteration.
9683 SCOPE determines the scope of this command.  It can be any of:
9685 @example
9686 nil     @r{the current buffer, respecting the restriction if any}
9687 tree    @r{the subtree started with the entry at point}
9688 file    @r{the current buffer, without restriction}
9689 file-with-archives
9690         @r{the current buffer, and any archives associated with it}
9691 agenda  @r{all agenda files}
9692 agenda-with-archives
9693         @r{all agenda files with any archive files associated with them}
9694 (file1 file2 ...)
9695         @r{if this is a list, all files in the list will be scanned}
9696 @end example
9698 The remaining args are treated as settings for the skipping facilities of
9699 the scanner.  The following items can be given here:
9701 @example
9702 archive   @r{skip trees with the archive tag}
9703 comment   @r{skip trees with the COMMENT keyword}
9704 function or Lisp form
9705           @r{will be used as value for @code{org-agenda-skip-function},}
9706           @r{so whenever the the function returns t, FUNC}
9707           @r{will not be called for that entry and search will}
9708           @r{continue from the point where the function leaves it}
9709 @end example
9710 @end defun
9712 The function given to that mapping routine can really do anything you like.
9713 It can uce the property API (@pxref{Using the property API}) to gather more
9714 information about the entry, or in order to change metadate in the entry.
9715 Here are a couple of functions that might be handy:
9717 @defun org-todo &optional arg
9718 Change the TODO state of the entry, see the docstring of the functions for
9719 the many possible values for the argument ARG.
9720 @end defun
9722 @defun org-priority &optional action
9723 Change the priority of the entry, see the docstring of this function for the
9724 possible values for ACTION.
9725 @end defun
9727 @defun org-toggle-tag tag &optional onoff
9728 Toggle the tag TAG in the current entry.  Setting ONOFF to either @code{on}
9729 or @code{off} will not toggle tag, but ensure that it is either on or off.
9730 @end defun
9732 @defun org-promote
9733 Promote the current entry.
9734 @end defun
9736 @defun org-demote
9737 Demote the current entry.
9738 @end defun
9740 Here is a simple example that will turn all entries in the current file with
9741 a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
9742 Entries in comment trees and in archive trees will be ignored.
9744 @lisp
9745 (org-map-entries
9746    '(org-todo "UPCOMING")
9747    "+TOMORROW" 'file 'archive 'comment)
9748 @end lisp
9750 The following example counts the number of entries with TODO keyword
9751 @code{WAITING}, in all agenda files.
9753 @lisp
9754 (length (org-map-entries t "/+WAITING" nil 'agenda))
9755 @end lisp
9757 @node History and Acknowledgments, Main Index, Hacking, Top
9758 @appendix History and Acknowledgments
9759 @cindex acknowledgments
9760 @cindex history
9761 @cindex thanks
9763 Org was borne in 2003, out of frustration over the user interface
9764 of the Emacs Outline mode.  I was trying to organize my notes and
9765 projects, and using Emacs seemed to be the natural way to go.  However,
9766 having to remember eleven different commands with two or three keys per
9767 command, only to hide and show parts of the outline tree, that seemed
9768 entirely unacceptable to me.  Also, when using outlines to take notes, I
9769 constantly want to restructure the tree, organizing it parallel to my
9770 thoughts and plans.  @emph{Visibility cycling} and @emph{structure
9771 editing} were originally implemented in the package
9772 @file{outline-magic.el}, but quickly moved to the more general
9773 @file{org.el}.  As this environment became comfortable for project
9774 planning, the next step was adding @emph{TODO entries}, basic @emph{time
9775 stamps}, and @emph{table support}.  These areas highlight the two main
9776 goals that Org still has today: To create a new, outline-based,
9777 plain text mode with innovative and intuitive editing features, and to
9778 incorporate project planning functionality directly into a notes file.
9780 A special thanks goes to @i{Bastien Guerry} who has not only writen a large
9781 number of extensions to Org (most of them integrated into the core by now),
9782 but has also helped the development and maintenance of Org so much that he
9783 should be considered co-author of this package.
9785 Since the first release, literally thousands of emails to me or on
9786 @code{emacs-orgmode@@gnu.org} have provided a constant stream of bug
9787 reports, feedback, new ideas, and sometimes patches and add-on code.
9788 Many thanks to everyone who has helped to improve this package.  I am
9789 trying to keep here a list of the people who had significant influence
9790 in shaping one or more aspects of Org.  The list may not be
9791 complete, if I have forgotten someone, please accept my apologies and
9792 let me know.
9794 @itemize @bullet
9796 @item
9797 @i{Russel Adams} came up with the idea for drawers.
9798 @item
9799 @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
9800 @item
9801 @i{Christophe Bataillon} created the great unicorn logo that we use on the
9802 Org-mode website.
9803 @item
9804 @i{Alex Bochannek} provided a patch for rounding time stamps.
9805 @item
9806 @i{Charles Cave}'s suggestion sparked the implementation of templates
9807 for Remember.
9808 @item
9809 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
9810 specified time.
9811 @item
9812 @i{Gregory Chernov} patched support for lisp forms into table
9813 calculations and improved XEmacs compatibility, in particular by porting
9814 @file{nouline.el} to XEmacs.
9815 @item
9816 @i{Sacha Chua} suggested to copy some linking code from Planner.
9817 @item
9818 @i{Eddward DeVilla} proposed and tested checkbox statistics.  He also
9819 came up with the idea of properties, and that there should be an API for
9820 them.
9821 @item
9822 @i{Kees Dullemond} used to edit projects lists directly in HTML and so
9823 inspired some of the early development, including HTML export.  He also
9824 asked for a way to narrow wide table columns.
9825 @item
9826 @i{Christian Egli} converted the documentation into Texinfo format,
9827 patched CSS formatting into the HTML exporter, and inspired the agenda.
9828 @item
9829 @i{David Emery} provided a patch for custom CSS support in exported
9830 HTML agendas.
9831 @item
9832 @i{Nic Ferrier} contributed mailcap and XOXO support.
9833 @item
9834 @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
9835 @item
9836 @i{John Foerch} figured out how to make incremental search show context
9837 around a match in a hidden outline tree.
9838 @item
9839 @i{Niels Giesen} had the idea to automatically archive DONE trees.
9840 @item
9841 @i{Bastien Guerry} wrote the La@TeX{} exporter and @file{org-bibtex.el}, and
9842 has been prolific with patches, ideas, and bug reports.
9843 @item
9844 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
9845 @item
9846 @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
9847 task state change logging, and the clocktable.  His clear explanations have
9848 been critical when we started to adopt the GIT version control system.
9849 @item
9850 @i{Manuel Hermenegildo} has contributed various ideas, small fixed and
9851 patches.
9852 @item
9853 @i{Phil Jackson} wrote @file{org-irc.el}.
9854 @item
9855 @i{Scott Jaderholm} proposed footnotes, control over whitespace between
9856 folded entries, and column view for properties.
9857 @item
9858 @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
9859 @item
9860 @i{Shidai Liu} ("Leo") asked for embedded La@TeX{} and tested it.  He also
9861 provided frequent feedback and some patches.
9862 @item
9863 @i{Jason F. McBrayer} suggested agenda export to CSV format.
9864 @item
9865 @i{Max Mikhanosha} came up with the idea of refiling.
9866 @item
9867 @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
9868 basis.
9869 @item
9870 @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
9871 happy.
9872 @item
9873 @i{Rick Moynihan} proposed to allow multiple TODO sequences in a file
9874 and to be able to quickly restrict the agenda to a subtree.
9875 @item
9876 @i{Todd Neal} provided patches for links to Info files and elisp forms.
9877 @item
9878 @i{Tim O'Callaghan} suggested in-file links, search options for general
9879 file links, and TAGS.
9880 @item
9881 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
9882 into Japanese.
9883 @item
9884 @i{Oliver Oppitz} suggested multi-state TODO items.
9885 @item
9886 @i{Scott Otterson} sparked the introduction of descriptive text for
9887 links, among other things.
9888 @item
9889 @i{Pete Phillips} helped during the development of the TAGS feature, and
9890 provided frequent feedback.
9891 @item
9892 @i{T.V. Raman} reported bugs and suggested improvements.
9893 @item
9894 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
9895 control.
9896 @item
9897 @i{Kevin Rogers} contributed code to access VM files on remote hosts.
9898 @item
9899 @i{Sebastian Rose} wrote @file{org-info.js}, a Java script for displaying
9900 webpages derived from Org using an Info-like, or a folding interface with
9901 single key navigation.
9902 @item
9903 @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
9904 conflict with @file{allout.el}.
9905 @item
9906 @i{Jason Riedy} generalized the send-receive mechanism for orgtbl tables with
9907 extensive patches.
9908 @item
9909 @i{Philip Rooke} created the Org reference card, provided lots
9910 of feedback, developed and applied standards to the Org documentation.
9911 @item
9912 @i{Christian Schlauer} proposed angular brackets around links, among
9913 other things.
9914 @item
9915 @i{Eric Schulte} wrote @file{org-plot.el}.
9916 @item
9917 Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
9918 @file{organizer-mode.el}.
9919 @item
9920 @i{Ilya Shlyakhter} proposed the Archive Sibling.
9921 @item
9922 @i{Daniel Sinder} came up with the idea of internal archiving by locking
9923 subtrees.
9924 @item
9925 @i{Dale Smith} proposed link abbreviations.
9926 @item
9927 @i{James TD Smith} has contributed a large number of patches for useful
9928 tweaks and features.
9929 @item
9930 @i{Adam Spiers} asked for global linking commands, inspired the link
9931 extension system, added support for mairix, and proposed the mapping API.
9932 @item
9933 @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
9934 chapter about publishing.
9935 @item
9936 @i{J@"urgen Vollmer} contributed code generating the table of contents
9937 in HTML output.
9938 @item
9939 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
9940 keyword.
9941 @item
9942 @i{David Wainberg} suggested archiving, and improvements to the linking
9943 system.
9944 @item
9945 @i{John Wiegley} wrote @file{emacs-wiki.el}, @file{planner.el}, and
9946 @file{muse.el}, which have similar goals as Org.  Initially the
9947 development of Org was fully independent because I was not aware of the
9948 existence of these packages.  But with time I have accasionally looked
9949 at John's code and learned a lot from it.  John has also contributed a
9950 number of great ideas and patches directly to Org, including the attachment
9951 system (@file{org-attach.el}) and integration with Apple Mail
9952 (@file{org-mac-message.el}).
9953 @item
9954 @i{Carsten Wimmer} suggested some changes and helped fix a bug in
9955 linking to Gnus.
9956 @item
9957 @i{Roland Winkler} requested additional key bindings to make Org
9958 work on a tty.
9959 @item
9960 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
9961 and contributed various ideas and code snippets.
9962 @end itemize
9965 @node Main Index, Key Index, History and Acknowledgments, Top
9966 @unnumbered The Main Index
9968 @printindex cp
9970 @node Key Index,  , Main Index, Top
9971 @unnumbered Key Index
9973 @printindex ky
9975 @bye
9977 @ignore
9978         arch-tag: 7893d1Fe-cc57-4d13-b5e5-f494a1CBC7ac
9979 @end ignore
9981 @c Local variables:
9982 @c ispell-local-dictionary: "en_US-w_accents"
9983 @c ispell-local-pdict: "./.aspell.org.pws"
9984 @c fill-column: 77
9985 @c End: