(Fmodify_frame_parameters): Doc fix.
[emacs.git] / man / org.texi
blob7c32c2e0e3ba4429743dcdccf7ecef6766dbb38e
1 \input texinfo
2 @c %**start of header
3 @setfilename ../info/org
4 @settitle Org Mode Manual
6 @set VERSION 5.23
7 @set DATE March 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-mode (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.1 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
46 license is included in the section entitled ``GNU Free Documentation
47 License.''
49 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
50 this GNU Manual, like GNU software.  Copies published by the Free
51 Software Foundation raise funds for GNU development.''
52 @end quotation
53 @end copying
55 @titlepage
56 @title Org Mode Manual
58 @subtitle Release @value{VERSION}
59 @author by Carsten Dominik
61 @c The following two commands start the copyright page.
62 @page
63 @vskip 0pt plus 1filll
64 @insertcopying
65 @end titlepage
67 @c Output the table of contents at the beginning.
68 @contents
70 @ifnottex
71 @node Top, Introduction, (dir), (dir)
72 @top Org Mode Manual
74 @insertcopying
75 @end ifnottex
77 @menu
78 * Introduction::                Getting started
79 * Document structure::          A tree works like your brain
80 * Tables::                      Pure magic for quick formatting
81 * Hyperlinks::                  Notes in context
82 * TODO items::                  Every tree branch can be a TODO item
83 * Tags::                        Tagging headlines and matching sets of tags
84 * Properties and columns::      Storing information about an entry
85 * Dates and times::             Making items useful for planning
86 * Remember::                    Quickly adding nodes to the outline tree
87 * Agenda views::                Collecting information into views
88 * Embedded LaTeX::              LaTeX fragments and formulas
89 * Exporting::                   Sharing and publishing of notes
90 * Publishing::                  Create a web site of linked Org-mode files
91 * Miscellaneous::               All the rest which did not fit elsewhere
92 * Extensions and Hacking::      It is possible to write add-on code
93 * History and Acknowledgments::  How Org-mode came into being
94 * Main Index::
95 * Key Index::                   Key bindings and where they are described
97 @detailmenu
98  --- The Detailed Node Listing ---
100 Introduction
102 * Summary::                     Brief summary of what Org-mode does
103 * Installation::                How to install a downloaded version of Org-mode
104 * Activation::                  How to activate Org-mode for certain buffers.
105 * Feedback::                    Bug reports, ideas, patches etc.
106 * Conventions::                 Type-setting conventions in the manual
108 Document Structure
110 * Outlines::                    Org-mode is based on outline-mode
111 * Headlines::                   How to typeset org-tree headlines
112 * Visibility cycling::          Show and hide, much simplified
113 * Motion::                      Jumping to other headlines
114 * Structure editing::           Changing sequence and level of headlines
115 * Archiving::                   Move done task trees to a different place
116 * Sparse trees::                Matches embedded in context
117 * Plain lists::                 Additional structure within an entry
118 * Drawers::                     Tucking stuff away
119 * orgstruct-mode::              Structure editing outside Org-mode
121 Archiving
123 * ARCHIVE tag::                 Marking a tree as inactive
124 * Moving subtrees::             Moving a tree to an archive file
126 Tables
128 * Built-in table editor::       Simple tables
129 * Narrow columns::              Stop wasting space in tables
130 * Column groups::               Grouping to trigger vertical lines
131 * orgtbl-mode::                 The table editor as minor mode
132 * The spreadsheet::             The table editor has spreadsheet capabilities.
134 The spreadsheet
136 * References::                  How to refer to another field or range
137 * Formula syntax for Calc::     Using Calc to compute stuff
138 * Formula syntax for Lisp::     Writing formulas in Emacs Lisp
139 * Field formulas::              Formulas valid for a single field
140 * Column formulas::             Formulas valid for an entire column
141 * Editing and debugging formulas::  Fixing formulas
142 * Updating the table::          Recomputing all dependent fields
143 * Advanced features::           Field names, parameters and automatic recalc
145 Hyperlinks
147 * Link format::                 How links in Org-mode are formatted
148 * Internal links::              Links to other places in the current file
149 * External links::              URL-like links to the world
150 * Handling links::              Creating, inserting and following
151 * Using links outside Org-mode::  Linking from my C source code?
152 * Link abbreviations::          Shortcuts for writing complex links
153 * Search options::              Linking to a specific location
154 * Custom searches::             When the default search is not enough
156 Internal links
158 * Radio targets::               Make targets trigger links in plain text.
160 TODO items
162 * TODO basics::                 Marking and displaying TODO entries
163 * TODO extensions::             Workflow and assignments
164 * Progress logging::            Dates and notes for progress
165 * Priorities::                  Some things are more important than others
166 * Breaking down tasks::         Splitting a task into manageable pieces
167 * Checkboxes::                  Tick-off lists
169 Extended use of TODO keywords
171 * Workflow states::             From TODO to DONE in steps
172 * TODO types::                  I do this, Fred does the rest
173 * Multiple sets in one file::   Mixing it all, and still finding your way
174 * Fast access to TODO states::  Single letter selection of a state
175 * Per-file keywords::           Different files, different requirements
176 * Faces for TODO keywords::     Highlighting states
178 Progress Logging
180 * Closing items::               When was this entry marked DONE?
181 * Tracking TODO state changes::  When did the status change?
183 Tags
185 * Tag inheritance::             Tags use the tree structure of the outline
186 * Setting tags::                How to assign tags to a headline
187 * Tag searches::                Searching for combinations of tags
189 Properties and Columns
191 * Property syntax::             How properties are spelled out
192 * Special properties::          Access to other Org-mode features
193 * Property searches::           Matching property values
194 * Property inheritance::        Passing values down the tree
195 * Column view::                 Tabular viewing and editing
196 * Property API::                Properties for Lisp programmers
198 Column View
200 * Defining columns::            The COLUMNS format property
201 * Using column view::           How to create and use column view
202 * Capturing Column View::       A dynamic block for column view
204 Defining Columns
206 * Scope of column definitions::  Where defined, where valid?
207 * Column attributes::           Appearance and content of a column
209 Dates and Times
211 * Time stamps::                 Assigning a time to a tree entry
212 * Creating timestamps::         Commands which insert timestamps
213 * Deadlines and scheduling::    Planning your work
214 * Clocking work time::
216 Creating timestamps
218 * The date/time prompt::        How org-mode helps you entering date and time
219 * Custom time format::          Making dates look differently
221 Deadlines and Scheduling
223 * Inserting deadline/schedule::  Planning items
224 * Repeated tasks::              Items that show up again and again
226 Remember
228 * Setting up remember::         Some code for .emacs to get things going
229 * Remember templates::          Define the outline of different note types
230 * Storing notes::               Directly get the note to where it belongs
231 * Refiling notes::              Moving a note or task to a project
233 Agenda Views
235 * Agenda files::                Files being searched for agenda information
236 * Agenda dispatcher::           Keyboard access to agenda views
237 * Built-in agenda views::       What is available out of the box?
238 * Presentation and sorting::    How agenda items are prepared for display
239 * Agenda commands::             Remote editing of org trees
240 * Custom agenda views::         Defining special searches and views
242 The built-in agenda views
244 * Weekly/Daily agenda::         The calendar page with current tasks
245 * Global TODO list::            All unfinished action items
246 * Matching tags and properties::  Structured information with fine-tuned search
247 * Timeline::                    Time-sorted view for single file
248 * Keyword search::              Finding entries by keyword
249 * Stuck projects::              Find projects you need to review
251 Presentation and sorting
253 * Categories::                  Not all tasks are equal
254 * Time-of-day specifications::  How the agenda knows the time
255 * Sorting of agenda items::     The order of things
257 Custom agenda views
259 * Storing searches::            Type once, use often
260 * Block agenda::                All the stuff you need in a single buffer
261 * Setting Options::             Changing the rules
262 * Exporting Agenda Views::      Writing agendas to files.
263 * Extracting Agenda Information for other programs::
265 Embedded LaTeX
267 * Math symbols::                TeX macros for symbols and Greek letters
268 * Subscripts and Superscripts::  Simple syntax for raising/lowering text
269 * LaTeX fragments::             Complex formulas made easy
270 * Processing LaTeX fragments::  Previewing LaTeX processing
271 * CDLaTeX mode::                Speed up entering of formulas
273 Exporting
275 * ASCII export::                Exporting to plain ASCII
276 * HTML export::                 Exporting to HTML
277 * LaTeX export::                Exporting to LaTeX
278 * XOXO export::                 Exporting to XOXO
279 * iCalendar export::            Exporting in iCalendar format
280 * Text interpretation::         How the exporter looks at the file
282 HTML export
284 * HTML Export commands::        How to invoke LaTeX export
285 * Quoting HTML tags::           Using direct HTML in Org-mode
286 * Links::                       Transformation of links for HTML
287 * Images::                      How to include images
288 * CSS support::                 Changing the appearence of the output
290 LaTeX export
292 * LaTeX export commands::       How to invoke LaTeX export
293 * Quoting LaTeX code::          Incorporating literal LaTeX code
294 * Sectioning structure::
296 Text interpretation by the exporter
298 * Comment lines::               Some lines will not be exported
299 * Initial text::                Text before the first headline
300 * Footnotes::                   Numbers like [1]
301 * Quoted examples::             Inserting quoted chnuks of text
302 * Enhancing text::              Subscripts, symbols and more
303 * Export options::              How to influence the export settings
305 Publishing
307 * Configuration::               Defining projects
308 * Sample configuration::        Example projects
309 * Triggering publication::      Publication commands
311 Configuration
313 * Project alist::               The central configuration variable
314 * Sources and destinations::    From here to there
315 * Selecting files::             What files are part of the project?
316 * Publishing action::           Setting the function doing the publishing
317 * Publishing options::          Tweaking HTML export
318 * Publishing links::            Which links keep working after publishing?
319 * Project page index::          Publishing a list of project files
321 Sample configuration
323 * Simple example::              One-component publishing
324 * Complex example::             A multi-component publishing example
326 Miscellaneous
328 * Completion::                  M-TAB knows what you need
329 * Customization::               Adapting Org-mode to your taste
330 * In-buffer settings::          Overview of the #+KEYWORDS
331 * The very busy C-c C-c key::   When in doubt, press C-c C-c
332 * Clean view::                  Getting rid of leading stars in the outline
333 * TTY keys::                    Using Org-mode on a tty
334 * Interaction::                 Other Emacs packages
335 * Bugs::                        Things which do not work perfectly
337 Interaction with other packages
339 * Cooperation::                 Packages Org-mode cooperates with
340 * Conflicts::                   Packages that lead to conflicts
342 Extensions, Hooks and Hacking
344 * Extensions::                  Existing 3rd-part extensions
345 * Adding hyperlink types::      New custom link types
346 * Tables in arbitrary syntax::  Orgtbl for LaTeX and other programs
347 * Dynamic blocks::              Automatically filled blocks
348 * Special agenda views::        Customized views
349 * Using the property API::      Writing programs that use entry properties
351 Tables and Lists in arbitrary syntax
353 * Radio tables::                Sending and receiving
354 * A LaTeX example::             Step by step, almost a tutorial
355 * Translator functions::        Copy and modify
356 * Radio lists::                 Doing the same for lists.
358 @end detailmenu
359 @end menu
361 @node Introduction, Document structure, Top, Top
362 @chapter Introduction
363 @cindex introduction
365 @menu
366 * Summary::                     Brief summary of what Org-mode does
367 * Installation::                How to install a downloaded version of Org-mode
368 * Activation::                  How to activate Org-mode for certain buffers.
369 * Feedback::                    Bug reports, ideas, patches etc.
370 * Conventions::                 Type-setting conventions in the manual
371 @end menu
373 @node Summary, Installation, Introduction, Introduction
374 @section Summary
375 @cindex summary
377 Org-mode is a mode for keeping notes, maintaining TODO lists, and doing
378 project planning with a fast and effective plain-text system.
380 Org-mode develops organizational tasks around NOTES files that contain
381 lists or information about projects as plain text.  Org-mode is
382 implemented on top of outline-mode, which makes it possible to keep the
383 content of large files well structured.  Visibility cycling and
384 structure editing help to work with the tree.  Tables are easily created
385 with a built-in table editor.  Org-mode supports TODO items, deadlines,
386 time stamps, and scheduling.  It dynamically compiles entries into an
387 agenda that utilizes and smoothly integrates much of the Emacs calendar
388 and diary.  Plain text URL-like links connect to websites, emails,
389 Usenet messages, BBDB entries, and any files related to the projects.
390 For printing and sharing of notes, an Org-mode file can be exported as a
391 structured ASCII file, as HTML, or (TODO and agenda items only) as an
392 iCalendar file.  It can also serve as a publishing tool for a set of
393 linked webpages.
395 An important design aspect that distinguishes Org-mode from for example
396 Planner/Muse is that it encourages to store every piece of information
397 only once.  In Planner, you have project pages, day pages and possibly
398 other files, duplicating some information such as tasks.  In Org-mode,
399 you only have notes files.  In your notes you mark entries as tasks,
400 label them with tags and timestamps.  All necessary lists like a
401 schedule for the day, the agenda for a meeting, tasks lists selected by
402 tags etc are created dynamically when you need them.
404 Org-mode keeps simple things simple.  When first fired up, it should
405 feel like a straightforward, easy to use outliner.  Complexity is not
406 imposed, but a large amount of functionality is available when you need
407 it.  Org-mode is a toolbox and can be used in different ways, for
408 example as:
410 @example
411 @r{@bullet{} outline extension with visibility cycling and structure editing}
412 @r{@bullet{} ASCII system and table editor for taking structured notes}
413 @r{@bullet{} ASCII table editor with spreadsheet-like capabilities}
414 @r{@bullet{} TODO list editor}
415 @r{@bullet{} full agenda and planner with deadlines and work scheduling}
416 @r{@bullet{} environment to implement David Allen's GTD system}
417 @r{@bullet{} a basic database application}
418 @r{@bullet{} simple hypertext system, with HTML and LaTeX export}
419 @r{@bullet{} publishing tool to create a set of interlinked webpages}
420 @end example
422 Org-mode's automatic, context sensitive table editor with spreadsheet
423 capabilities can be integrated into any major mode by activating the
424 minor Orgtbl-mode.  Using a translation step, it can be used to maintain
425 tables in arbitrary file types, for example in La@TeX{}.  The structure
426 editing and list creation capabilities can be used outside Org-mode with
427 the minor Orgstruct-mode.
429 @cindex FAQ
430 There is a website for Org-mode which provides links to the newest
431 version of Org-mode, as well as additional information, frequently asked
432 questions (FAQ), links to tutorials etc.  This page is located at
433 @uref{http://orgmode.org}.
435 @page
438 @node Installation, Activation, Summary, Introduction
439 @section Installation
440 @cindex installation
441 @cindex XEmacs
443 @b{Important:} @i{If Org-mode is part of the Emacs distribution or an
444 XEmacs package, please skip this section and go directly to
445 @ref{Activation}.}
447 If you have downloaded Org-mode from the Web, you must take the
448 following steps to install it: Go into the Org-mode distribution
449 directory and edit the top section of the file @file{Makefile}.  You
450 must set the name of the Emacs binary (likely either @file{emacs} or
451 @file{xemacs}), and the paths to the directories where local Lisp and
452 Info files are kept.  If you don't have access to the system-wide
453 directories, create your own two directories for these files, enter them
454 into the Makefile, and make sure Emacs finds the Lisp files by adding
455 the following line to @file{.emacs}:
457 @example
458 (setq load-path (cons "~/path/to/lispdir" load-path))
459 @end example
461 @b{XEmacs users now need to install the file @file{noutline.el} from
462 the @file{xemacs} subdirectory of the Org-mode distribution.  Use the
463 command:}
465 @example
466 @b{make install-noutline}
467 @end example
469 @noindent Now byte-compile and install the Lisp files with the shell
470 commands:
472 @example
473 make
474 make install
475 @end example
477 @noindent If you want to install the info documentation, use this command:
479 @example
480 make install-info
481 @end example
483 @noindent Then add to @file{.emacs}:
485 @lisp
486 ;; This line only if org-mode is not part of the X/Emacs distribution.
487 (require 'org-install)
488 @end lisp
490 @node Activation, Feedback, Installation, Introduction
491 @section Activation
492 @cindex activation
493 @cindex autoload
494 @cindex global keybindings
495 @cindex keybindings, global
497 @iftex
498 @b{Important:} @i{If you use copy-and-paste to copy lisp code from the
499 PDF documentation as viewed by Acrobat reader to your .emacs file, the
500 single quote character comes out incorrectly and the code will not work.
501 You need to fix the single quotes by hand, or copy from Info
502 documentation.}
503 @end iftex
505 Add the following lines to your @file{.emacs} file.  The last two lines
506 define @emph{global} keys for the commands @command{org-store-link} and
507 @command{org-agenda} - please choose suitable keys yourself.
509 @lisp
510 ;; The following lines are always needed.  Choose your own keys.
511 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
512 (global-set-key "\C-cl" 'org-store-link)
513 (global-set-key "\C-ca" 'org-agenda)
514 @end lisp
516 Furthermore, you must activate @code{font-lock-mode} in org-mode
517 buffers, because significant functionality depends on font-locking being
518 active.  You can do this with either one of the following two lines
519 (XEmacs user must use the second option):
520 @lisp
521 (global-font-lock-mode 1)                     ; for all buffers
522 (add-hook 'org-mode-hook 'turn-on-font-lock)  ; org-mode buffers only
523 @end lisp
525 @cindex org-mode, turning on
526 With this setup, all files with extension @samp{.org} will be put
527 into Org-mode.  As an alternative, make the first line of a file look
528 like this:
530 @example
531 MY PROJECTS    -*- mode: org; -*-
532 @end example
534 @noindent which will select Org-mode for this buffer no matter what
535 the file's name is.  See also the variable
536 @code{org-insert-mode-line-in-empty-file}.
538 @node Feedback, Conventions, Activation, Introduction
539 @section Feedback
540 @cindex feedback
541 @cindex bug reports
542 @cindex maintainer
543 @cindex author
545 If you find problems with Org-mode, or if you have questions, remarks,
546 or ideas about it, please contact the maintainer @value{MAINTAINER} at
547 @value{MAINTAINEREMAIL}.
549 For bug reports, please provide as much information as possible,
550 including the version information of Emacs (@kbd{C-h v emacs-version
551 @key{RET}}) and Org-mode (@kbd{C-h v org-version @key{RET}}), as well as
552 the Org-mode related setup in @file{.emacs}.  If an error occurs, a
553 backtrace can be very useful (see below on how to create one).  Often a
554 small example file helps, along with clear information about:
556 @enumerate
557 @item What exactly did you do?
558 @item What did you expect to happen?
559 @item What happened instead?
560 @end enumerate
561 @noindent Thank you for helping to improve this mode.
563 @subsubheading How to create a useful backtrace
565 @cindex backtrace of an error
566 If working with Org-mode produces an error with a message you don't
567 understand, you may have hit a bug.  The best way to report this is by
568 providing, in addition to what was mentioned above, a @emph{Backtrace}.
569 This is information from the built-in debugger about where and how the
570 error occurred.  Here is how to produce a useful backtrace:
572 @enumerate
573 @item
574 Start a fresh Emacs or XEmacs, and make sure that it will load the
575 original Lisp code in @file{org.el} instead of the compiled version in
576 @file{org.elc}.  The backtrace contains much more information if it is
577 produced with uncompiled code.  To do this, either rename @file{org.elc}
578 to something else before starting Emacs, or ask Emacs explicitly to load
579 @file{org.el} by using the command line
580 @example
581 emacs -l /path/to/org.el
582 @end example
583 @item
584 Go to the @code{Options} menu and select @code{Enter Debugger on Error}
585 (XEmacs has this option in the @code{Troubleshooting} sub-menu).
586 @item
587 Do whatever you have to do to hit the error.  Don't forget to
588 document the steps you take.
589 @item
590 When you hit the error, a @file{*Backtrace*} buffer will appear on the
591 screen.  Save this buffer to a file (for example using @kbd{C-x C-w}) and
592 attach it to your bug report.
593 @end enumerate
595 @node Conventions,  , Feedback, Introduction
596 @section Typesetting conventions used in this manual
598 Org-mode uses three types of keywords: TODO keywords, tags, and property
599 names.  In this manual we use the following conventions:
601 @table @code
602 @item TODO
603 @itemx WAITING
604 TODO keywords are written with all capitals, even if they are
605 user-defined.
606 @item boss
607 @itemx ARCHIVE
608 User-defined tags are written in lowercase; built-in tags with special
609 meaning are written with all capitals.
610 @item Release
611 @itemx PRIORITY
612 User-defined properties are capitalized; built-in properties with
613 special meaning are written with all capitals.
614 @end table
616 @node Document structure, Tables, Introduction, Top
617 @chapter Document Structure
618 @cindex document structure
619 @cindex structure of document
621 Org-mode is based on outline mode and provides flexible commands to
622 edit the structure of the document.
624 @menu
625 * Outlines::                    Org-mode is based on outline-mode
626 * Headlines::                   How to typeset org-tree headlines
627 * Visibility cycling::          Show and hide, much simplified
628 * Motion::                      Jumping to other headlines
629 * Structure editing::           Changing sequence and level of headlines
630 * Archiving::                   Move done task trees to a different place
631 * Sparse trees::                Matches embedded in context
632 * Plain lists::                 Additional structure within an entry
633 * Drawers::                     Tucking stuff away
634 * orgstruct-mode::              Structure editing outside Org-mode
635 @end menu
637 @node Outlines, Headlines, Document structure, Document structure
638 @section Outlines
639 @cindex outlines
640 @cindex outline-mode
642 Org-mode is implemented on top of outline-mode.  Outlines allow a
643 document to be organized in a hierarchical structure, which (at least
644 for me) is the best representation of notes and thoughts.  An overview
645 of this structure is achieved by folding (hiding) large parts of the
646 document to show only the general document structure and the parts
647 currently being worked on.  Org-mode greatly simplifies the use of
648 outlines by compressing the entire show/hide functionality into a single
649 command @command{org-cycle}, which is bound to the @key{TAB} key.
651 @node Headlines, Visibility cycling, Outlines, Document structure
652 @section Headlines
653 @cindex headlines
654 @cindex outline tree
656 Headlines define the structure of an outline tree.  The headlines in
657 Org-mode start with one or more stars, on the left margin@footnote{See
658 the variable @code{org-special-ctrl-a/e} to configure special behavior
659 of @kbd{C-a} and @kbd{C-e} in headlines.}.  For example:
661 @example
662 * Top level headline
663 ** Second level
664 *** 3rd level
665     some text
666 *** 3rd level
667     more text
669 * Another top level headline
670 @end example
672 @noindent Some people find the many stars too noisy and would prefer an
673 outline that has whitespace followed by a single star as headline
674 starters.  @ref{Clean view} describes a setup to realize this.
676 An empty line after the end of a subtree is considered part of it and
677 will be hidden when the subtree is folded.  However, if you leave at
678 least two empty lines, one empty line will remain visible after folding
679 the subtree, in order to structure the collapsed view.  See the
680 variable @code{org-cycle-separator-lines} to modify this behavior.
682 @node Visibility cycling, Motion, Headlines, Document structure
683 @section Visibility cycling
684 @cindex cycling, visibility
685 @cindex visibility cycling
686 @cindex trees, visibility
687 @cindex show hidden text
688 @cindex hide text
690 Outlines make it possible to hide parts of the text in the buffer.
691 Org-mode uses just two commands, bound to @key{TAB} and
692 @kbd{S-@key{TAB}} to change the visibility in the buffer.
694 @cindex subtree visibility states
695 @cindex subtree cycling
696 @cindex folded, subtree visibility state
697 @cindex children, subtree visibility state
698 @cindex subtree, subtree visibility state
699 @table @kbd
700 @kindex @key{TAB}
701 @item @key{TAB}
702 @emph{Subtree cycling}: Rotate current subtree among the states
704 @example
705 ,-> FOLDED -> CHILDREN -> SUBTREE --.
706 '-----------------------------------'
707 @end example
709 The cursor must be on a headline for this to work@footnote{see, however,
710 the option @code{org-cycle-emulate-tab}.}.  When the cursor is at the
711 beginning of the buffer and the first line is not a headline, then
712 @key{TAB} actually runs global cycling (see below)@footnote{see the
713 option @code{org-cycle-global-at-bob}.}.  Also when called with a prefix
714 argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
716 @cindex global visibility states
717 @cindex global cycling
718 @cindex overview, global visibility state
719 @cindex contents, global visibility state
720 @cindex show all, global visibility state
721 @kindex S-@key{TAB}
722 @item S-@key{TAB}
723 @itemx C-u @key{TAB}
724 @emph{Global cycling}: Rotate the entire buffer among the states
726 @example
727 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
728 '--------------------------------------'
729 @end example
731 When @kbd{S-@key{TAB}} is called with a numerical prefix N, the CONTENTS
732 view up to headlines of level N will be shown.
733 Note that inside tables, @kbd{S-@key{TAB}} jumps to the previous field.
735 @cindex show all, command
736 @kindex C-c C-a
737 @item C-c C-a
738 Show all.
739 @kindex C-c C-r
740 @item C-c C-r
741 Reveal context around point, showing the current entry, the following
742 heading and the hierarchy above.  Useful for working near a location
743 that has been exposed by a sparse tree command (@pxref{Sparse trees}) or
744 an agenda command (@pxref{Agenda commands}).  With prefix arg show, on
745 each
747 level, all sibling headings.
748 @kindex C-c C-x b
749 @item C-c C-x b
750 Show the current subtree in an indirect buffer@footnote{The indirect
751 buffer
752 @ifinfo
753 (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
754 @end ifinfo
755 @ifnotinfo
756 (see the Emacs manual for more information about indirect buffers)
757 @end ifnotinfo
758 will contain the entire buffer, but will be narrowed to the current
759 tree.  Editing the indirect buffer will also change the original buffer,
760 but without affecting visibility in that buffer.}.  With numerical
761 prefix ARG, go up to this level and then take that tree.  If ARG is
762 negative, go up that many levels.  With @kbd{C-u} prefix, do not remove
763 the previously used indirect buffer.
764 @end table
766 When Emacs first visits an Org-mode file, the global state is set to
767 OVERVIEW, i.e. only the top level headlines are visible.  This can be
768 configured through the variable @code{org-startup-folded}, or on a
769 per-file basis by adding one of the following lines anywhere in the
770 buffer:
772 @example
773 #+STARTUP: overview
774 #+STARTUP: content
775 #+STARTUP: showall
776 @end example
778 @node Motion, Structure editing, Visibility cycling, Document structure
779 @section Motion
780 @cindex motion, between headlines
781 @cindex jumping, to headlines
782 @cindex headline navigation
783 The following commands jump to other headlines in the buffer.
785 @table @kbd
786 @kindex C-c C-n
787 @item C-c C-n
788 Next heading.
789 @kindex C-c C-p
790 @item C-c C-p
791 Previous heading.
792 @kindex C-c C-f
793 @item C-c C-f
794 Next heading same level.
795 @kindex C-c C-b
796 @item C-c C-b
797 Previous heading same level.
798 @kindex C-c C-u
799 @item C-c C-u
800 Backward to higher level heading.
801 @kindex C-c C-j
802 @item C-c C-j
803 Jump to a different place without changing the current outline
804 visibility.  Shows the document structure in a temporary buffer, where
805 you can use the following keys to find your destination:
806 @example
807 @key{TAB}         @r{Cycle visibility.}
808 @key{down} / @key{up}   @r{Next/previous visible headline.}
809 n / p        @r{Next/previous visible headline.}
810 f / b        @r{Next/previous headline same level.}
811 u            @r{One level up.}
812 0-9          @r{Digit argument.}
813 @key{RET}         @r{Select this location.}
814 @end example
815 @end table
817 @node Structure editing, Archiving, Motion, Document structure
818 @section Structure editing
819 @cindex structure editing
820 @cindex headline, promotion and demotion
821 @cindex promotion, of subtrees
822 @cindex demotion, of subtrees
823 @cindex subtree, cut and paste
824 @cindex pasting, of subtrees
825 @cindex cutting, of subtrees
826 @cindex copying, of subtrees
827 @cindex subtrees, cut and paste
829 @table @kbd
830 @kindex M-@key{RET}
831 @item M-@key{RET}
832 Insert new heading with same level as current.  If the cursor is in a
833 plain list item, a new item is created (@pxref{Plain lists}).  To force
834 creation of a new headline, use a prefix arg, or first press @key{RET}
835 to get to the beginning of the next line.  When this command is used in
836 the middle of a line, the line is split and the rest of the line becomes
837 the new headline@footnote{If you do not want the line to be split,
838 customize the variable @code{org-M-RET-may-split-line}.}.  If the
839 command is used at the beginning of a headline, the new headline is
840 created before the current line.  If at the beginning of any other line,
841 the content of that line is made the new heading.  If the command is
842 used at the end of a folded subtree (i.e. behind the ellipses at the end
843 of a headline), then a headline like the current one will be inserted
844 after the end of the subtree.
845 @kindex C-@key{RET}
846 @item C-@key{RET}
847 Insert a new heading after the current subtree, same level as the
848 current headline.  This command works from anywhere in the entry.
849 @kindex M-S-@key{RET}
850 @item M-S-@key{RET}
851 Insert new TODO entry with same level as current heading.
852 @kindex M-@key{left}
853 @item M-@key{left}
854 Promote current heading by one level.
855 @kindex M-@key{right}
856 @item M-@key{right}
857 Demote current heading by one level.
858 @kindex M-S-@key{left}
859 @item M-S-@key{left}
860 Promote the current subtree by one level.
861 @kindex M-S-@key{right}
862 @item M-S-@key{right}
863 Demote the current subtree by one level.
864 @kindex M-S-@key{up}
865 @item M-S-@key{up}
866 Move subtree up (swap with previous subtree of same
867 level).
868 @kindex M-S-@key{down}
869 @item M-S-@key{down}
870 Move subtree down (swap with next subtree of same level).
871 @kindex C-c C-x C-w
872 @kindex C-c C-x C-k
873 @item C-c C-x C-w
874 @itemx C-c C-x C-k
875 Kill subtree, i.e. remove it from buffer but save in kill ring.
876 With prefix arg, kill N sequential subtrees.
877 @kindex C-c C-x M-w
878 @item C-c C-x M-w
879 Copy subtree to kill ring.  With prefix arg, copy N sequential subtrees.
880 @kindex C-c C-x C-y
881 @item C-c C-x C-y
882 Yank subtree from kill ring.  This does modify the level of the subtree to
883 make sure the tree fits in nicely at the yank position.  The yank
884 level can also be specified with a prefix arg, or by yanking after a
885 headline marker like @samp{****}.
886 @kindex C-c C-w
887 @item C-c C-w
888 Refile entry to a different location.  @xref{Refiling notes}.
889 @kindex C-c ^
890 @item C-c ^
891 Sort same-level entries.  When there is an active region, all entries in
892 the region will be sorted.  Otherwise the children of the current
893 headline are sorted.  The command prompts for the sorting method, which
894 can be alphabetically, numerically, by time (using the first time stamp
895 in each entry), by priority, and each of these in reverse order.  You
896 can also supply your own function to extract the sorting key.  With a
897 @kbd{C-u} prefix, sorting will be case-sensitive.  With two @kbd{C-u
898 C-u} prefixes, duplicate entries will also be removed.
899 @kindex C-c *
900 @item C-c *
901 Turn a normal line or plain list item into a headline (so that it
902 becomes a subheading at its location).  Also turn a headline into a
903 normal line by removing the stars.  If there is an active region, turn
904 all lines in the region into headlines.  Or, if the first line is a
905 headline, remove the stars from all headlines in the region.
906 @end table
908 @cindex region, active
909 @cindex active region
910 @cindex transient-mark-mode
911 When there is an active region (transient-mark-mode), promotion and
912 demotion work on all headlines in the region.  To select a region of
913 headlines, it is best to place both point and mark at the beginning of a
914 line, mark at the beginning of the first headline, and point at the line
915 just after the last headline to change.  Note that when the cursor is
916 inside a table (@pxref{Tables}), the Meta-Cursor keys have different
917 functionality.
919 @node Archiving, Sparse trees, Structure editing, Document structure
920 @section Archiving
921 @cindex archiving
923 When a project represented by a (sub)tree is finished, you may want
924 to move the tree out of the way and to stop it from contributing to the
925 agenda.  Org-mode knows two ways of archiving.  You can mark a tree with
926 the ARCHIVE tag, or you can move an entire (sub)tree to a different
927 location.
929 @menu
930 * ARCHIVE tag::                 Marking a tree as inactive
931 * Moving subtrees::             Moving a tree to an archive file
932 @end menu
934 @node ARCHIVE tag, Moving subtrees, Archiving, Archiving
935 @subsection The ARCHIVE tag
936 @cindex internal archiving
938 A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
939 its location in the outline tree, but behaves in the following way:
940 @itemize @minus
941 @item
942 It does not open when you attempt to do so with a visibility cycling
943 command (@pxref{Visibility cycling}).  You can force cycling archived
944 subtrees with @kbd{C-@key{TAB}}, or by setting the option
945 @code{org-cycle-open-archived-trees}.  Also normal outline commands like
946 @code{show-all} will open archived subtrees.
947 @item
948 During sparse tree construction (@pxref{Sparse trees}), matches in
949 archived subtrees are not exposed, unless you configure the option
950 @code{org-sparse-tree-open-archived-trees}.
951 @item
952 During agenda view construction (@pxref{Agenda views}), the content of
953 archived trees is ignored unless you configure the option
954 @code{org-agenda-skip-archived-trees}.
955 @item
956 Archived trees are not exported (@pxref{Exporting}), only the headline
957 is.  Configure the details using the variable
958 @code{org-export-with-archived-trees}.
959 @end itemize
961 The following commands help managing the ARCHIVE tag:
963 @table @kbd
964 @kindex C-c C-x C-a
965 @item C-c C-x C-a
966 Toggle the ARCHIVE tag for the current headline.  When the tag is set,
967 the headline changes to a shadowish face, and the subtree below it is
968 hidden.
969 @kindex C-u C-c C-x C-a
970 @item C-u C-c C-x C-a
971 Check if any direct children of the current headline should be archived.
972 To do this, each subtree is checked for open TODO entries.  If none are
973 found, the command offers to set the ARCHIVE tag for the child.  If the
974 cursor is @emph{not} on a headline when this command is invoked, the
975 level 1 trees will be checked.
976 @kindex C-@kbd{TAB}
977 @item C-@kbd{TAB}
978 Cycle a tree even if it is tagged with ARCHIVE.
979 @end table
981 @node Moving subtrees,  , ARCHIVE tag, Archiving
982 @subsection Moving subtrees
983 @cindex external archiving
985 Once an entire project is finished, you may want to move it to a
986 different location, either in the current file, or even in a different
987 file, the archive file.
989 @table @kbd
990 @kindex C-c C-x C-s
991 @item C-c C-x C-s
992 Archive the subtree starting at the cursor position to the location
993 given by @code{org-archive-location}.  Context information that could be
994 lost like the file name, the category, inherited tags, and the todo
995 state will be store as properties in the entry.
996 @kindex C-u C-c C-x C-s
997 @item C-u C-c C-x C-s
998 Check if any direct children of the current headline could be moved to
999 the archive.  To do this, each subtree is checked for open TODO entries.
1000 If none are found, the command offers to move it to the archive
1001 location.  If the cursor is @emph{not} on a headline when this command
1002 is invoked, the level 1 trees will be checked.
1003 @end table
1005 @cindex archive locations
1006 The default archive location is a file in the same directory as the
1007 current file, with the name derived by appending @file{_archive} to the
1008 current file name.  For information and examples on how to change this,
1009 see the documentation string of the variable
1010 @code{org-archive-location}.  There is also an in-buffer option for
1011 setting this variable, for example@footnote{For backward compatibility,
1012 the following also works: If there are several such lines in a file,
1013 each specifies the archive location for the text below it.  The first
1014 such line also applies to any text before its definition.  However,
1015 using this method is @emph{strongly} deprecated as it is incompatible
1016 with the outline structure of the document.  The correct method for
1017 setting multiple archive locations in a buffer is using a property.}:
1019 @example
1020 #+ARCHIVE: %s_done::
1021 @end example
1023 @noindent
1024 If you would like to have a special ARCHIVE location for a single entry
1025 or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
1026 location as the value (@pxref{Properties and columns}).
1028 When a subtree is moved, it receives a number of special properties that
1029 record context information like the file from where the entry came, it's
1030 outline path the archiving time etc.  Configure the variable
1031 @code{org-archive-save-context-info} to adjust the amount of information
1032 added.
1034 @node Sparse trees, Plain lists, Archiving, Document structure
1035 @section Sparse trees
1036 @cindex sparse trees
1037 @cindex trees, sparse
1038 @cindex folding, sparse trees
1039 @cindex occur, command
1041 An important feature of Org-mode is the ability to construct
1042 @emph{sparse trees} for selected information in an outline tree, so that
1043 the entire document is folded as much as possible, but the selected
1044 information is made visible along with the headline structure above
1045 it@footnote{See also the variables @code{org-show-hierarchy-above},
1046 @code{org-show-following-heading}, and @code{org-show-siblings} for
1047 detailed control on how much context is shown around each match.}.  Just
1048 try it out and you will see immediately how it works.
1050 Org-mode contains several commands creating such trees, all these
1051 commands can be accessed through a dispatcher:
1053 @table @kbd
1054 @kindex C-c /
1055 @item C-c /
1056 This prompts for an extra key to select a sparse-tree creating command.
1057 @kindex C-c / r
1058 @item C-c / r
1059 Occur.  Prompts for a regexp and shows a sparse tree with all matches.
1060 If the match is in a headline, the headline is made visible.  If the
1061 match is in the body of an entry, headline and body are made visible.
1062 In order to provide minimal context, also the full hierarchy of
1063 headlines above the match is shown, as well as the headline following
1064 the match.  Each match is also highlighted; the highlights disappear
1065 when the buffer is changed by an editing command, or by pressing
1066 @kbd{C-c C-c}.  When called with a @kbd{C-u} prefix argument, previous
1067 highlights are kept, so several calls to this command can be stacked.
1068 @end table
1070 @noindent
1071 For frequently used sparse trees of specific search strings, you can
1072 use the variable @code{org-agenda-custom-commands} to define fast
1073 keyboard access to specific sparse trees.  These commands will then be
1074 accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
1075 For example:
1077 @lisp
1078 (setq org-agenda-custom-commands
1079       '(("f" occur-tree "FIXME")))
1080 @end lisp
1082 @noindent will define the key @kbd{C-c a f} as a shortcut for creating
1083 a sparse tree matching the string @samp{FIXME}.
1085 The other sparse tree commands select headings based on TODO keywords,
1086 tags, or properties and will be discussed later in this manual.
1088 @kindex C-c C-e v
1089 @cindex printing sparse trees
1090 @cindex visible text, printing
1091 To print a sparse tree, you can use the Emacs command
1092 @code{ps-print-buffer-with-faces} which does not print invisible parts
1093 of the document @footnote{This does not work under XEmacs, because
1094 XEmacs uses selective display for outlining, not text properties.}.
1095 Or you can use the command @kbd{C-c C-e v} to export only the visible
1096 part of the document and print the resulting file.
1098 @node Plain lists, Drawers, Sparse trees, Document structure
1099 @section Plain lists
1100 @cindex plain lists
1101 @cindex lists, plain
1102 @cindex lists, ordered
1103 @cindex ordered lists
1105 Within an entry of the outline tree, hand-formatted lists can provide
1106 additional structure.  They also provide a way to create lists of
1107 checkboxes (@pxref{Checkboxes}).  Org-mode supports editing such lists,
1108 and the HTML exporter (@pxref{Exporting}) parses and formats them.
1110 Org-mode knows ordered and unordered lists.  Unordered list items start
1111 with @samp{-}, @samp{+}, or @samp{*}@footnote{When using @samp{*} as a
1112 bullet, lines must be indented or they will be seen as top-level
1113 headlines.  Also, when you are hiding leading stars to get a clean
1114 outline view, plain list items starting with a star are visually
1115 indistinguishable from true headlines.  In short: even though @samp{*}
1116 is supported, it may be better to not use it for plain list items.} as
1117 bullets.  Ordered list items start with a numeral followed by either a
1118 period or a right parenthesis, such as @samp{1.} or @samp{1)}.  Items
1119 belonging to the same list must have the same indentation on the first
1120 line.  In particular, if an ordered list reaches number @samp{10.}, then
1121 the 2--digit numbers must be written left-aligned with the other numbers
1122 in the list.  Indentation also determines the end of a list item.  It
1123 ends before the next line that is indented like the bullet/number, or
1124 less.  Empty lines are part of the previous item, so you can have
1125 several paragraphs in one item.  If you would like an empty line to
1126 terminate all currently open plain lists, configure the variable
1127 @code{org-empty-line-terminates-plain-lists}.  Here is an example:
1129 @example
1130 @group
1131 ** Lord of the Rings
1132    My favorite scenes are (in this order)
1133    1. The attack of the Rohirrim
1134    2. Eowyns fight with the witch king
1135       + this was already my favorite scene in the book
1136       + I really like Miranda Otto.
1137    3. Peter Jackson being shot by Legolas
1138        - on DVD only
1139       He makes a really funny face when it happens.
1140    But in the end, not individual scenes matter but the film as a whole.
1141 @end group
1142 @end example
1144 Org-mode supports these lists by tuning filling and wrapping commands to
1145 deal with them correctly@footnote{Org-mode only changes the filling
1146 settings for Emacs.  For XEmacs, you should use Kyle E. Jones'
1147 @file{filladapt.el}.  To turn this on,  put into @file{.emacs}:
1148 @code{(require 'filladapt)}}.
1150 The following commands act on items when the cursor is in the first line
1151 of an item (the line with the bullet or number).
1153 @table @kbd
1154 @kindex @key{TAB}
1155 @item @key{TAB}
1156 Items can be folded just like headline levels if you set the variable
1157 @code{org-cycle-include-plain-lists}.  The level of an item is then
1158 given by the indentation of the bullet/number.  Items are always
1159 subordinate to real headlines, however; the hierarchies remain
1160 completely separated.
1162 If @code{org-cycle-include-plain-lists} has not been set, @key{TAB}
1163 fixes the indentation of the curent line in a heuristic way.
1164 @kindex M-@key{RET}
1165 @item M-@key{RET}
1166 Insert new item at current level.  With prefix arg, force a new heading
1167 (@pxref{Structure editing}).  If this command is used in the middle of a
1168 line, the line is @emph{split} and the rest of the line becomes the new
1169 item@footnote{If you do not want the line to be split, customize the
1170 variable @code{org-M-RET-may-split-line}.}.  If this command is executed
1171 in the @emph{whitespace before a bullet or number}, the new item is
1172 created @emph{before} the current item.  If the command is executed in
1173 the white space before the text that is part of an item but does not
1174 contain the bullet, a bullet is added to the current line.
1175 @kindex M-S-@key{RET}
1176 @item M-S-@key{RET}
1177 Insert a new item with a checkbox (@pxref{Checkboxes}).
1178 @kindex S-@key{up}
1179 @kindex S-@key{down}
1180 @item S-@key{up}
1181 @itemx S-@key{down}
1182 Jump to the previous/next item in the current list.
1183 @kindex M-S-@key{up}
1184 @kindex M-S-@key{down}
1185 @item M-S-@key{up}
1186 @itemx M-S-@key{down}
1187 Move the item including subitems up/down (swap with previous/next item
1188 of same indentation).  If the list is ordered, renumbering is
1189 automatic.
1190 @kindex M-S-@key{left}
1191 @kindex M-S-@key{right}
1192 @item M-S-@key{left}
1193 @itemx M-S-@key{right}
1194 Decrease/increase the indentation of the item, including subitems.
1195 Initially, the item tree is selected based on current indentation.
1196 When these commands are executed several times in direct succession,
1197 the initially selected region is used, even if the new indentation
1198 would imply a different hierarchy.  To use the new hierarchy, break
1199 the command chain with a cursor motion or so.
1200 @kindex C-c C-c
1201 @item C-c C-c
1202 If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
1203 state of the checkbox.  If not, this command makes sure that all the
1204 items on this list level use the same bullet.  Furthermore, if this is
1205 an ordered list, make sure the numbering is ok.
1206 @kindex C-c -
1207 @item C-c -
1208 Cycle the entire list level through the different itemize/enumerate
1209 bullets (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}).
1210 With prefix arg, select the nth bullet from this list.
1211 If there is an active region when calling this, all lines will be
1212 converted to list items.  If the first line already was a list item, any
1213 item markers will be removed from the list.  Finally, even without an
1214 active region, a normal line will be converted into a list item.
1215 @end table
1217 @node Drawers, orgstruct-mode, Plain lists, Document structure
1218 @section Drawers
1219 @cindex drawers
1220 @cindex visibility cycling, drawers
1222 Sometimes you want to keep information associated with an entry, but you
1223 normally don't want to see it.  For this, Org-mode has @emph{drawers}.
1224 Drawers need to be configured with the variable
1225 @code{org-drawers}@footnote{You can define drawers on a per-file basis
1226 with a line like @code{#+DRAWERS: HIDDEN PROPERTIES STATE}}.  Drawers
1227 look like this:
1229 @example
1230 ** This is a headline
1231    Still outside the drawer
1232    :DRAWERNAME:
1233       This is inside the drawer.
1234    :END:
1235    After the drawer.
1236 @end example
1238 Visibility cycling (@pxref{Visibility cycling}) on the headline will
1239 hide and show the entry, but keep the drawer collapsed to a single line.
1240 In order to look inside the drawer, you need to move the cursor to the
1241 drawer line and press @key{TAB} there.  Org-mode uses a drawer for
1242 storing properties (@pxref{Properties and columns}).
1244 @node orgstruct-mode,  , Drawers, Document structure
1245 @section The Orgstruct minor mode
1246 @cindex orgstruct-mode
1247 @cindex minor mode for structure editing
1249 If you like the intuitive way the Org-mode structure editing and list
1250 formatting works, you might want to use these commands in other modes
1251 like text-mode or mail-mode as well.  The minor mode Orgstruct-mode
1252 makes this possible.  You can always toggle the mode with @kbd{M-x
1253 orgstruct-mode}.  To turn it on by default, for example in mail mode,
1256 @lisp
1257 (add-hook 'mail-mode-hook 'turn-on-orgstruct)
1258 @end lisp
1260 When this mode is active and the cursor is on a line that looks to
1261 Org-mode like a headline of the first line of a list item, most
1262 structure editing commands will work, even if the same keys normally
1263 have different functionality in the major mode you are using.  If the
1264 cursor is not in one of those special lines, Orgstruct-mode lurks
1265 silently in the shadow.
1267 @node Tables, Hyperlinks, Document structure, Top
1268 @chapter Tables
1269 @cindex tables
1270 @cindex editing tables
1272 Org-mode comes with a fast and intuitive table editor.  Spreadsheet-like
1273 calculations are supported in connection with the Emacs @file{calc}
1274 package
1275 @ifinfo
1276 (@pxref{Top,Calc,,calc,Gnu Emacs Calculator Manual}).
1277 @end ifinfo
1278 @ifnotinfo
1279 (see the Emacs Calculator manual for more information about the Emacs
1280 calculator).
1281 @end ifnotinfo
1283 @menu
1284 * Built-in table editor::       Simple tables
1285 * Narrow columns::              Stop wasting space in tables
1286 * Column groups::               Grouping to trigger vertical lines
1287 * orgtbl-mode::                 The table editor as minor mode
1288 * The spreadsheet::             The table editor has spreadsheet capabilities.
1289 @end menu
1291 @node Built-in table editor, Narrow columns, Tables, Tables
1292 @section The built-in table editor
1293 @cindex table editor, built-in
1295 Org-mode makes it easy to format tables in plain ASCII.  Any line with
1296 @samp{|} as the first non-whitespace character is considered part of a
1297 table.  @samp{|} is also the column separator.  A table might look like
1298 this:
1300 @example
1301 | Name  | Phone | Age |
1302 |-------+-------+-----|
1303 | Peter |  1234 |  17 |
1304 | Anna  |  4321 |  25 |
1305 @end example
1307 A table is re-aligned automatically each time you press @key{TAB} or
1308 @key{RET} or @kbd{C-c C-c} inside the table.  @key{TAB} also moves to
1309 the next field (@key{RET} to the next row) and creates new table rows
1310 at the end of the table or before horizontal lines.  The indentation
1311 of the table is set by the first line.  Any line starting with
1312 @samp{|-} is considered as a horizontal separator line and will be
1313 expanded on the next re-align to span the whole table width.  So, to
1314 create the above table, you would only type
1316 @example
1317 |Name|Phone|Age|
1319 @end example
1321 @noindent and then press @key{TAB} to align the table and start filling in
1322 fields.
1324 When typing text into a field, Org-mode treats @key{DEL},
1325 @key{Backspace}, and all character keys in a special way, so that
1326 inserting and deleting avoids shifting other fields.  Also, when
1327 typing @emph{immediately after the cursor was moved into a new field
1328 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
1329 field is automatically made blank.  If this behavior is too
1330 unpredictable for you, configure the variables
1331 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
1333 @table @kbd
1334 @tsubheading{Creation and conversion}
1335 @kindex C-c |
1336 @item C-c |
1337 Convert the active region to table. If every line contains at least one
1338 TAB character, the function assumes that the material is tab separated.
1339 If every line contains a comma, comma-separated values (CSV) are assumed.
1340 If not, lines are split at whitespace into fields.  You can use a prefix
1341 argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
1342 C-u} forces TAB, and a numeric argument N indicates that at least N
1343 consequtive spaces, or alternatively a TAB will be the separator.
1345 If there is no active region, this command creates an empty Org-mode
1346 table.  But it's easier just to start typing, like
1347 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
1349 @tsubheading{Re-aligning and field motion}
1350 @kindex C-c C-c
1351 @item C-c C-c
1352 Re-align the table without moving the cursor.
1354 @kindex @key{TAB}
1355 @item @key{TAB}
1356 Re-align the table, move to the next field.  Creates a new row if
1357 necessary.
1359 @kindex S-@key{TAB}
1360 @item S-@key{TAB}
1361 Re-align, move to previous field.
1363 @kindex @key{RET}
1364 @item @key{RET}
1365 Re-align the table and move down to next row.  Creates a new row if
1366 necessary.  At the beginning or end of a line, @key{RET} still does
1367 NEWLINE, so it can be used to split a table.
1369 @tsubheading{Column and row editing}
1370 @kindex M-@key{left}
1371 @kindex M-@key{right}
1372 @item M-@key{left}
1373 @itemx M-@key{right}
1374 Move the current column left/right.
1376 @kindex M-S-@key{left}
1377 @item M-S-@key{left}
1378 Kill the current column.
1380 @kindex M-S-@key{right}
1381 @item M-S-@key{right}
1382 Insert a new column to the left of the cursor position.
1384 @kindex M-@key{up}
1385 @kindex M-@key{down}
1386 @item M-@key{up}
1387 @itemx M-@key{down}
1388 Move the current row up/down.
1390 @kindex M-S-@key{up}
1391 @item M-S-@key{up}
1392 Kill the current row or horizontal line.
1394 @kindex M-S-@key{down}
1395 @item M-S-@key{down}
1396 Insert a new row above (with arg: below) the current row.
1398 @kindex C-c -
1399 @item C-c -
1400 Insert a horizontal line below current row. With prefix arg, the line
1401 is created above the current line.
1403 @kindex C-c ^
1404 @item C-c ^
1405 Sort the table lines in the region.  The position of point indicates the
1406 column to be used for sorting, and the range of lines is the range
1407 between the nearest horizontal separator lines, or the entire table.  If
1408 point is before the first column, you will be prompted for the sorting
1409 column.  If there is an active region, the mark specifies the first line
1410 and the sorting column, while point should be in the last line to be
1411 included into the sorting.  The command prompts for the sorting type
1412 (alphabetically, numerically, or by time).  When called with a prefix
1413 argument, alphabetic sorting will be case-sensitive.
1415 @tsubheading{Regions}
1416 @kindex C-c C-x M-w
1417 @item C-c C-x M-w
1418 Copy a rectangular region from a table to a special clipboard.  Point
1419 and mark determine edge fields of the rectangle.  The process ignores
1420 horizontal separator lines.
1422 @kindex C-c C-x C-w
1423 @item C-c C-x C-w
1424 Copy a rectangular region from a table to a special clipboard, and
1425 blank all fields in the rectangle.  So this is the ``cut'' operation.
1427 @kindex C-c C-x C-y
1428 @item C-c C-x C-y
1429 Paste a rectangular region into a table.
1430 The upper right corner ends up in the current field.  All involved fields
1431 will be overwritten.  If the rectangle does not fit into the present table,
1432 the table is enlarged as needed.  The process ignores horizontal separator
1433 lines.
1435 @kindex C-c C-q
1436 @kindex M-@key{RET}
1437 @item C-c C-q
1438 @itemx M-@kbd{RET}
1439 Wrap several fields in a column like a paragraph.  If there is an active
1440 region, and both point and mark are in the same column, the text in the
1441 column is wrapped to minimum width for the given number of lines.  A
1442 prefix ARG may be used to change the number of desired lines.  If there
1443 is no region, the current field is split at the cursor position and the
1444 text fragment to the right of the cursor is prepended to the field one
1445 line down. If there is no region, but you specify a prefix ARG, the
1446 current field is made blank, and the content is appended to the field
1447 above.
1449 @tsubheading{Calculations}
1450 @cindex formula, in tables
1451 @cindex calculations, in tables
1452 @cindex region, active
1453 @cindex active region
1454 @cindex transient-mark-mode
1455 @kindex C-c +
1456 @item C-c +
1457 Sum the numbers in the current column, or in the rectangle defined by
1458 the active region.  The result is shown in the echo area and can
1459 be inserted with @kbd{C-y}.
1461 @kindex S-@key{RET}
1462 @item S-@key{RET}
1463 When current field is empty, copy from first non-empty field above.
1464 When not empty, copy current field down to next row and move cursor
1465 along with it.  Depending on the variable
1466 @code{org-table-copy-increment}, integer field values will be
1467 incremented during copy.  This key is also used by CUA-mode
1468 (@pxref{Cooperation}).
1470 @tsubheading{Miscellaneous}
1471 @kindex C-c `
1472 @item C-c `
1473 Edit the current field in a separate window.  This is useful for fields
1474 that are not fully visible (@pxref{Narrow columns}).  When called with a
1475 @kbd{C-u} prefix, just make the full field visible, so that it can be
1476 edited in place.
1478 @item M-x org-table-import
1479 Import a file as a table.  The table should be TAB- or whitespace
1480 separated.  Useful, for example, to import a spreadsheet table or data
1481 from a database, because these programs generally can write
1482 TAB-separated text files.  This command works by inserting the file into
1483 the buffer and then converting the region to a table.  Any prefix
1484 argument is passed on to the converter, which uses it to determine the
1485 separator.
1486 @item C-c |
1487 Tables can also be imported by pasting tabular text into the org-mode
1488 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
1489 @kbd{C-c |} command (see above under @i{Creation and conversion}.
1491 @item M-x org-table-export
1492 Export the table as a TAB-separated file.  Useful for data exchange with,
1493 for example, spreadsheet or database programs.
1494 @end table
1496 If you don't like the automatic table editor because it gets in your
1497 way on lines which you would like to start with @samp{|}, you can turn
1498 it off with
1500 @lisp
1501 (setq org-enable-table-editor nil)
1502 @end lisp
1504 @noindent Then the only table command that still works is
1505 @kbd{C-c C-c} to do a manual re-align.
1507 @node Narrow columns, Column groups, Built-in table editor, Tables
1508 @section Narrow columns
1509 @cindex narrow columns in tables
1511 The width of columns is automatically determined by the table editor.
1512 Sometimes a single field or a few fields need to carry more text,
1513 leading to inconveniently wide columns.  To limit@footnote{This feature
1514 does not work on XEmacs.} the width of a column, one field anywhere in
1515 the column may contain just the string @samp{<N>} where @samp{N} is an
1516 integer specifying the width of the column in characters.  The next
1517 re-align will then set the width of this column to no more than this
1518 value.
1520 @example
1521 @group
1522 |---+------------------------------|               |---+--------|
1523 |   |                              |               |   | <6>    |
1524 | 1 | one                          |               | 1 | one    |
1525 | 2 | two                          |     ----\     | 2 | two    |
1526 | 3 | This is a long chunk of text |     ----/     | 3 | This=> |
1527 | 4 | four                         |               | 4 | four   |
1528 |---+------------------------------|               |---+--------|
1529 @end group
1530 @end example
1532 @noindent
1533 Fields that are wider become clipped and end in the string @samp{=>}.
1534 Note that the full text is still in the buffer, it is only invisible.
1535 To see the full text, hold the mouse over the field - a tool-tip window
1536 will show the full content.  To edit such a field, use the command
1537 @kbd{C-c `} (that is @kbd{C-c} followed by the backquote).  This will
1538 open a new window with the full field.  Edit it and finish with @kbd{C-c
1539 C-c}.
1541 When visiting a file containing a table with narrowed columns, the
1542 necessary character hiding has not yet happened, and the table needs to
1543 be aligned before it looks nice.  Setting the option
1544 @code{org-startup-align-all-tables} will realign all tables in a file
1545 upon visiting, but also slow down startup.  You can also set this option
1546 on a per-file basis with:
1548 @example
1549 #+STARTUP: align
1550 #+STARTUP: noalign
1551 @end example
1553 @node Column groups, orgtbl-mode, Narrow columns, Tables
1554 @section Column groups
1555 @cindex grouping columns in tables
1557 When Org-mode exports tables, it does so by default without vertical
1558 lines because that is visually more satisfying in general.  Occasionally
1559 however, vertical lines can be useful to structure a table into groups
1560 of columns, much like horizontal lines can do for groups of rows.  In
1561 order to specify column groups, you can use a special row where the
1562 first field contains only @samp{/}.  The further fields can either
1563 contain @samp{<} to indicate that this column should start a group,
1564 @samp{>} to indicate the end of a column, or @samp{<>} to make a column
1565 a group of its own.  Boundaries between colum groups will upon export be
1566 marked with vertical lines.  Here is an example:
1568 @example
1569 |   |  N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
1570 |---+----+-----+-----+-----+---------+------------|
1571 | / | <> |   < |     |   > |       < |          > |
1572 | # |  1 |   1 |   1 |   1 |       1 |          1 |
1573 | # |  2 |   4 |   8 |  16 |  1.4142 |     1.1892 |
1574 | # |  3 |   9 |  27 |  81 |  1.7321 |     1.3161 |
1575 |---+----+-----+-----+-----+---------+------------|
1576 #+TBLFM: $3=$2^2::$4=$2^3::$5=$2^4::$6=sqrt($2)::$7=sqrt(sqrt(($2))
1577 @end example
1579 It is also sufficient to just insert the colum group starters after
1580 every vertical line you'd like to have:
1582 @example
1583 |  N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
1584 |----+-----+-----+-----+---------+------------|
1585 | /  | <   |     |     | <       |            |
1586 @end example
1588 @node orgtbl-mode, The spreadsheet, Column groups, Tables
1589 @section The Orgtbl minor mode
1590 @cindex orgtbl-mode
1591 @cindex minor mode for tables
1593 If you like the intuitive way the Org-mode table editor works, you
1594 might also want to use it in other modes like text-mode or mail-mode.
1595 The minor mode Orgtbl-mode makes this possible.  You can always toggle
1596 the mode with @kbd{M-x orgtbl-mode}.  To turn it on by default, for
1597 example in mail mode, use
1599 @lisp
1600 (add-hook 'mail-mode-hook 'turn-on-orgtbl)
1601 @end lisp
1603 Furthermore, with some special setup, it is possible to maintain tables
1604 in arbitrary syntax with Orgtbl-mode.  For example, it is possible to
1605 construct La@TeX{} tables with the underlying ease and power of
1606 Orgtbl-mode, including spreadsheet capabilities.  For details, see
1607 @ref{Tables in arbitrary syntax}.
1609 @node The spreadsheet,  , orgtbl-mode, Tables
1610 @section The spreadsheet
1611 @cindex calculations, in tables
1612 @cindex spreadsheet capabilities
1613 @cindex @file{calc} package
1615 The table editor makes use of the Emacs @file{calc} package to implement
1616 spreadsheet-like capabilities.  It can also evaluate Emacs Lisp forms to
1617 derive fields from other fields.  While fully featured, Org-mode's
1618 implementation is not identical to other spreadsheets.  For example,
1619 Org-mode knows the concept of a @emph{column formula} that will be
1620 applied to all non-header fields in a column without having to copy the
1621 formula to each relevant field.
1623 @menu
1624 * References::                  How to refer to another field or range
1625 * Formula syntax for Calc::     Using Calc to compute stuff
1626 * Formula syntax for Lisp::     Writing formulas in Emacs Lisp
1627 * Field formulas::              Formulas valid for a single field
1628 * Column formulas::             Formulas valid for an entire column
1629 * Editing and debugging formulas::  Fixing formulas
1630 * Updating the table::          Recomputing all dependent fields
1631 * Advanced features::           Field names, parameters and automatic recalc
1632 @end menu
1634 @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet
1635 @subsection References
1636 @cindex references
1638 To compute fields in the table from other fields, formulas must
1639 reference other fields or ranges.  In Org-mode, fields can be referenced
1640 by name, by absolute coordinates, and by relative coordinates.  To find
1641 out what the coordinates of a field are, press @kbd{C-c ?} in that
1642 field, or press @kbd{C-c @}} to toggle the display of a grid.
1644 @subsubheading Field references
1645 @cindex field references
1646 @cindex references, to fields
1648 Formulas can reference the value of another field in two ways.  Like in
1649 any other spreadsheet, you may reference fields with a letter/number
1650 combination like @code{B3}, meaning the 2nd field in the 3rd row.
1651 @c Such references are always fixed to that field, they don't change
1652 @c when you copy and paste a formula to a different field.  So
1653 @c Org-mode's @code{B3} behaves like @code{$B$3} in other spreadsheets.
1655 @noindent
1656 Org-mode also uses another, more general operator that looks like this:
1657 @example
1658 @@row$column
1659 @end example
1661 @noindent
1662 Column references can be absolute like @samp{1}, @samp{2},...@samp{N},
1663 or relative to the current column like @samp{+1} or @samp{-2}.
1665 The row specification only counts data lines and ignores horizontal
1666 separator lines (hlines).  You can use absolute row numbers
1667 @samp{1}...@samp{N}, and row numbers relative to the current row like
1668 @samp{+3} or @samp{-1}.  Or specify the row relative to one of the
1669 hlines: @samp{I} refers to the first hline@footnote{Note that only
1670 hlines are counted that @emph{separate} table lines.  If the table
1671 starts with a hline above the header, it does not count.}, @samp{II} to
1672 the second etc.  @samp{-I} refers to the first such line above the
1673 current line, @samp{+I} to the first such line below the current line.
1674 You can also write @samp{III+2} which is the second data line after the
1675 third hline in the table.  Relative row numbers like @samp{-3} will not
1676 cross hlines if the current line is too close to the hline.  Instead,
1677 the value directly at the hline is used.
1679 @samp{0} refers to the current row and column.  Also, if you omit
1680 either the column or the row part of the reference, the current
1681 row/column is implied.
1683 Org-mode's references with @emph{unsigned} numbers are fixed references
1684 in the sense that if you use the same reference in the formula for two
1685 different fields, the same field will be referenced each time.
1686 Org-mode's references with @emph{signed} numbers are floating
1687 references because the same reference operator can reference different
1688 fields depending on the field being calculated by the formula.
1690 Here are a few examples:
1692 @example
1693 @@2$3      @r{2nd row, 3rd column}
1694 C2        @r{same as previous}
1695 $5        @r{column 5 in the current row}
1696 E&        @r{same as previous}
1697 @@2        @r{current column, row 2}
1698 @@-1$-3    @r{the field one row up, three columns to the left}
1699 @@-I$2     @r{field just under hline above current row, column 2}
1700 @end example
1702 @subsubheading Range references
1703 @cindex range references
1704 @cindex references, to ranges
1706 You may reference a rectangular range of fields by specifying two field
1707 references connected by two dots @samp{..}.  If both fields are in the
1708 current row, you may simply use @samp{$2..$7}, but if at least one field
1709 is in a different row, you need to use the general @code{@@row$column}
1710 format at least for the first field (i.e the reference must start with
1711 @samp{@@} in order to be interpreted correctly).  Examples:
1713 @example
1714 $1..$3        @r{First three fields in the current row.}
1715 $P..$Q        @r{Range, using column names (see under Advanced)}
1716 @@2$1..@@4$3    @r{6 fields between these two fields.}
1717 A2..C4        @r{Same as above.}
1718 @@-1$-2..@@-1   @r{3 numbers from the column to the left, 2 up to current row}
1719 @end example
1721 @noindent Range references return a vector of values that can be fed
1722 into Calc vector functions.  Empty fields in ranges are normally
1723 suppressed, so that the vector contains only the non-empty fields (but
1724 see the @samp{E} mode switch below).  If there are no non-empty fields,
1725 @samp{[0]} is returned to avoid syntax errors in formulas.
1727 @subsubheading Named references
1728 @cindex named references
1729 @cindex references, named
1730 @cindex name, of column or field
1731 @cindex constants, in calculations
1733 @samp{$name} is interpreted as the name of a column, parameter or
1734 constant.  Constants are defined globally through the variable
1735 @code{org-table-formula-constants}, and locally (for the file) through a
1736 line like
1738 @example
1739 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
1740 @end example
1742 @noindent
1743 Also properties (@pxref{Properties and columns}) can be used as
1744 constants in table formulas: For a property @samp{:Xyz:} use the name
1745 @samp{$PROP_Xyz}, and the property will be searched in the current
1746 outline entry and in the hierarchy above it.  If you have the
1747 @file{constants.el} package, it will also be used to resolve constants,
1748 including natural constants like @samp{$h} for Planck's constant, and
1749 units like @samp{$km} for kilometers@footnote{@file{Constant.el} can
1750 supply the values of constants in two different unit systems, @code{SI}
1751 and @code{cgs}.  Which one is used depends on the value of the variable
1752 @code{constants-unit-system}.  You can use the @code{#+STARTUP} options
1753 @code{constSI} and @code{constcgs} to set this value for the current
1754 buffer.}.  Column names and parameters can be specified in special table
1755 lines.  These are described below, see @ref{Advanced features}.  All
1756 names must start with a letter, and further consist of letters and
1757 numbers.
1759 @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet
1760 @subsection Formula syntax for Calc
1761 @cindex formula syntax, Calc
1762 @cindex syntax, of formulas
1764 A formula can be any algebraic expression understood by the Emacs
1765 @file{Calc} package.  @b{Note that @file{calc} has the
1766 non-standard convention that @samp{/} has lower precedence than
1767 @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.}  Before
1768 evaluation by @code{calc-eval} (@pxref{Calling Calc from
1769 Your Programs,calc-eval,Calling calc from Your Lisp Programs,calc,GNU
1770 Emacs Calc Manual}),
1771 @c FIXME:  The link to the calc manual in HTML does not work.
1772 variable substitution takes place according to the rules described above.
1773 @cindex vectors, in table calculations
1774 The range vectors can be directly fed into the calc vector functions
1775 like @samp{vmean} and @samp{vsum}.
1777 @cindex format specifier
1778 @cindex mode, for @file{calc}
1779 A formula can contain an optional mode string after a semicolon.  This
1780 string consists of flags to influence Calc and other modes during
1781 execution.  By default, Org-mode uses the standard calc modes (precision
1782 12, angular units degrees, fraction and symbolic modes off.  The display
1783 format, however, has been changed to @code{(float 5)} to keep tables
1784 compact.  The default settings can be configured using the variable
1785 @code{org-calc-default-modes}.
1787 @example
1788 p20           @r{switch the internal precision to 20 digits}
1789 n3 s3 e2 f4   @r{normal, scientific, engineering, or fixed display format}
1790 D R           @r{angle modes: degrees, radians}
1791 F S           @r{fraction and symbolic modes}
1792 N             @r{interpret all fields as numbers, use 0 for non-numbers}
1793 T             @r{force text interpretation}
1794 E             @r{keep empty fields in ranges}
1795 @end example
1797 @noindent
1798 In addition, you may provide a @code{printf} format specifier to
1799 reformat the final result.  A few examples:
1801 @example
1802 $1+$2                @r{Sum of first and second field}
1803 $1+$2;%.2f           @r{Same, format result to two decimals}
1804 exp($2)+exp($1)      @r{Math functions can be used}
1805 $0;%.1f              @r{Reformat current cell to 1 decimal}
1806 ($3-32)*5/9          @r{Degrees F -> C conversion}
1807 $c/$1/$cm            @r{Hz -> cm conversion, using @file{constants.el}}
1808 tan($1);Dp3s1        @r{Compute in degrees, precision 3, display SCI 1}
1809 sin($1);Dp3%.1e      @r{Same, but use printf specifier for display}
1810 vmean($2..$7)        @r{Compute column range mean, using vector function}
1811 vmean($2..$7);EN     @r{Same, but treat empty fields as 0}
1812 taylor($3,x=7,2)     @r{taylor series of $3, at x=7, second degree}
1813 @end example
1815 Calc also contains a complete set of logical operations.  For example
1817 @example
1818 if($1<20,teen,string(""))  @r{``teen'' if age $1 less than 20, else empty}
1819 @end example
1821 @node Formula syntax for Lisp, Field formulas, Formula syntax for Calc, The spreadsheet
1822 @subsection Emacs Lisp forms as formulas
1823 @cindex Lisp forms, as table formulas
1825 It is also possible to write a formula in Emacs Lisp; this can be useful
1826 for string manipulation and control structures, if the Calc's
1827 functionality is not enough.  If a formula starts with a single quote
1828 followed by an opening parenthesis, then it is evaluated as a lisp form.
1829 The evaluation should return either a string or a number.  Just as with
1830 @file{calc} formulas, you can specify modes and a printf format after a
1831 semicolon.  With Emacs Lisp forms, you need to be concious about the way
1832 field references are interpolated into the form.  By default, a
1833 reference will be interpolated as a Lisp string (in double quotes)
1834 containing the field.  If you provide the @samp{N} mode switch, all
1835 referenced elements will be numbers (non-number fields will be zero) and
1836 interpolated as Lisp numbers, without quotes.  If you provide the
1837 @samp{L} flag, all fields will be interpolated literally, without quotes.
1838 I.e., if you want a reference to be interpreted as a string by the Lisp
1839 form, enclode the reference operator itself in double quotes, like
1840 @code{"$3"}.  Ranges are inserted as space-separated fields, so you can
1841 embed them in list or vector syntax.  A few examples, note how the
1842 @samp{N} mode is used when we do computations in lisp.
1844 @example
1845 @r{Swap the first two characters of the content of column 1}
1846   '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
1847 @r{Add columns 1 and 2, equivalent to the Calc's @code{$1+$2}}
1848   '(+ $1 $2);N
1849 @r{Compute the sum of columns 1-4, like Calc's @code{vsum($1..$4)}}
1850   '(apply '+ '($1..$4));N
1851 @end example
1853 @node Field formulas, Column formulas, Formula syntax for Lisp, The spreadsheet
1854 @subsection Field formulas
1855 @cindex field formula
1856 @cindex formula, for individual table field
1858 To assign a formula to a particular field, type it directly into the
1859 field, preceded by @samp{:=}, for example @samp{:=$1+$2}.  When you
1860 press @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in
1861 the field, the formula will be stored as the formula for this field,
1862 evaluated, and the current field replaced with the result.
1864 Formulas are stored in a special line starting with @samp{#+TBLFM:}
1865 directly below the table.  If you typed the equation in the 4th field of
1866 the 3rd data line in the table, the formula will look like
1867 @samp{@@3$4=$1+$2}.  When inserting/deleting/swapping column and rows
1868 with the appropriate commands, @i{absolute references} (but not relative
1869 ones) in stored formulas are modified in order to still reference the
1870 same field.  Of cause this is not true if you edit the table structure
1871 with normal editing commands - then you must fix the equations yourself.
1873 Instead of typing an equation into the field, you may also use the
1874 following command
1876 @table @kbd
1877 @kindex C-u C-c =
1878 @item C-u C-c =
1879 Install a new formula for the current field.  The command prompts for a
1880 formula, with default taken from the @samp{#+TBLFM:} line, applies
1881 it to the current field and stores it.
1882 @end table
1884 @node Column formulas, Editing and debugging formulas, Field formulas, The spreadsheet
1885 @subsection Column formulas
1886 @cindex column formula
1887 @cindex formula, for table column
1889 Often in a table, the same formula should be used for all fields in a
1890 particular column.  Instead of having to copy the formula to all fields
1891 in that column, org-mode allows to assign a single formula to an entire
1892 column.  If the table contains horizontal separator hlines, everything
1893 before the first such line is considered part of the table @emph{header}
1894 and will not be modified by column formulas.
1896 To assign a formula to a column, type it directly into any field in the
1897 column, preceded by an equal sign, like @samp{=$1+$2}.  When you press
1898 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the
1899 field, the formula will be stored as the formula for the current column,
1900 evaluated and the current field replaced with the result.  If the field
1901 contains only @samp{=}, the previously stored formula for this column is
1902 used.  For each column, Org-mode will only remember the most recently
1903 used formula.  In the @samp{TBLFM:} line, column formulas will look like
1904 @samp{$4=$1+$2}.
1906 Instead of typing an equation into the field, you may also use the
1907 following command:
1909 @table @kbd
1910 @kindex C-c =
1911 @item C-c =
1912 Install a new formula for the current column and replace current field
1913 with the result of the formula.  The command prompts for a formula, with
1914 default taken from the @samp{#+TBLFM} line, applies it to the current
1915 field and stores it.  With a numerical prefix (e.g. @kbd{C-5 C-c =})
1916 will apply it to that many consecutive fields in the current column.
1917 @end table
1920 @node Editing and debugging formulas, Updating the table, Column formulas, The spreadsheet
1921 @subsection Editing and Debugging formulas
1922 @cindex formula editing
1923 @cindex editing, of table formulas
1925 You can edit individual formulas in the minibuffer or directly in the
1926 field.  Org-mode can also prepare a special buffer with all active
1927 formulas of a table.  When offering a formula for editing, Org-mode
1928 converts references to the standard format (like @code{B3} or @code{D&})
1929 if possible.  If you prefer to only work with the internal format (like
1930 @code{@@3$2} or @code{$4}), configure the variable
1931 @code{org-table-use-standard-references}.
1933 @table @kbd
1934 @kindex C-c =
1935 @kindex C-u C-c =
1936 @item C-c =
1937 @itemx C-u C-c =
1938 Edit the formula associated with the current column/field in the
1939 minibuffer.  See @ref{Column formulas} and @ref{Field formulas}.
1940 @kindex C-u C-u C-c =
1941 @item C-u C-u C-c =
1942 Re-insert the active formula (either a
1943 field formula, or a column formula) into the current field, so that you
1944 can edit it directly in the field.  The advantage over editing in the
1945 minibuffer is that you can use the command @kbd{C-c ?}.
1946 @kindex C-c ?
1947 @item C-c ?
1948 While editing a formula in a table field, highlight the field(s)
1949 referenced by the reference at the cursor position in the formula.
1950 @kindex C-c @}
1951 @item C-c @}
1952 Toggle the display of row and column numbers for a table, using
1953 overlays.  These are updated each time the table is aligned, you can
1954 force it with @kbd{C-c C-c}.
1955 @kindex C-c @{
1956 @item C-c @{
1957 Toggle the formula debugger on and off.  See below.
1958 @kindex C-c '
1959 @item C-c '
1960 Edit all formulas for the current table in a special buffer, where the
1961 formulas will be displayed one per line.  If the current field has an
1962 active formula, the cursor in the formula editor will mark it.
1963 While inside the special buffer, Org-mode will automatically highlight
1964 any field or range reference at the cursor position.  You may edit,
1965 remove and add formulas, and use the following commands:
1966 @table @kbd
1967 @kindex C-c C-c
1968 @kindex C-x C-s
1969 @item C-c C-c
1970 @itemx C-x C-s
1971 Exit the formula editor and store the modified formulas.  With @kbd{C-u}
1972 prefix, also apply the new formulas to the entire table.
1973 @kindex C-c C-q
1974 @item C-c C-q
1975 Exit the formula editor without installing changes.
1976 @kindex C-c C-r
1977 @item C-c C-r
1978 Toggle all references in the formula editor between standard (like
1979 @code{B3}) and internal (like @code{@@3$2}).
1980 @kindex @key{TAB}
1981 @item @key{TAB}
1982 Pretty-print or indent lisp formula at point.  When in a line containing
1983 a lisp formula, format the formula according to Emacs Lisp rules.
1984 Another @key{TAB} collapses the formula back again.  In the open
1985 formula, @key{TAB} re-indents just like in Emacs-lisp-mode.
1986 @kindex M-@key{TAB}
1987 @item M-@key{TAB}
1988 Complete Lisp symbols, just like in Emacs-lisp-mode.
1989 @kindex S-@key{up}
1990 @kindex S-@key{down}
1991 @kindex S-@key{left}
1992 @kindex S-@key{right}
1993 @item S-@key{up}/@key{down}/@key{left}/@key{right}
1994 Shift the reference at point.  For example, if the reference is
1995 @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
1996 This also works for relative references, and for hline references.
1997 @kindex M-S-@key{up}
1998 @kindex M-S-@key{down}
1999 @item M-S-@key{up}/@key{down}
2000 Move the test line for column formulas in the Org-mode buffer up and
2001 down.
2002 @kindex M-@key{up}
2003 @kindex M-@key{down}
2004 @item M-@key{up}/@key{down}
2005 Scroll the window displaying the table.
2006 @kindex C-c @}
2007 @item C-c @}
2008 Turn the coordinate grid in the table on and off.
2009 @end table
2010 @end table
2012 Making a table field blank does not remove the formula associated with
2013 the field, because that is stored in a different line (the @samp{TBLFM}
2014 line) - during the next recalculation the field will be filled again.
2015 To remove a formula from a field, you have to give an empty reply when
2016 prompted for the formula, or to edit the @samp{#+TBLFM} line.
2018 @kindex C-c C-c
2019 You may edit the @samp{#+TBLFM} directly and re-apply the changed
2020 equations with @kbd{C-c C-c} in that line, or with the normal
2021 recalculation commands in the table.
2023 @subsubheading Debugging formulas
2024 @cindex formula debugging
2025 @cindex debugging, of table formulas
2026 When the evaluation of a formula leads to an error, the field content
2027 becomes the string @samp{#ERROR}.  If you would like see what is going
2028 on during variable substitution and calculation in order to find a bug,
2029 turn on formula debugging in the @code{Tbl} menu and repeat the
2030 calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
2031 field.  Detailed information will be displayed.
2033 @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet
2034 @subsection Updating the Table
2035 @cindex recomputing table fields
2036 @cindex updating, table
2038 Recalculation of a table is normally not automatic, but needs to be
2039 triggered by a command.  See @ref{Advanced features} for a way to make
2040 recalculation at least semi-automatically.
2042 In order to recalculate a line of a table or the entire table, use the
2043 following commands:
2045 @table @kbd
2046 @kindex C-c *
2047 @item C-c *
2048 Recalculate the current row by first applying the stored column formulas
2049 from left to right, and all field formulas in the current row.
2051 @kindex C-u C-c *
2052 @item C-u C-c *
2053 @kindex C-u C-c C-c
2054 @itemx C-u C-c C-c
2055 Recompute the entire table, line by line.  Any lines before the first
2056 hline are left alone, assuming that these are part of the table header.
2058 @kindex C-u C-u C-c *
2059 @kindex C-u C-u C-c C-c
2060 @item C-u C-u C-c *
2061 @itemx C-u C-u C-c C-c
2062 Iterate the table by recomputing it until no further changes occur.
2063 This may be necessary if some computed fields use the value of other
2064 fields that are computed @i{later} in the calculation sequence.
2065 @end table
2067 @node Advanced features,  , Updating the table, The spreadsheet
2068 @subsection Advanced features
2070 If you want the recalculation of fields to happen automatically, or if
2071 you want to be able to assign @i{names} to fields and columns, you need
2072 to reserve the first column of the table for special marking characters.
2073 @table @kbd
2074 @kindex C-#
2075 @item C-#
2076 Rotate the calculation mark in first column through the states @samp{},
2077 @samp{#}, @samp{*}, @samp{!}, @samp{$}.  The meaning of these characters
2078 is discussed below.  When there is an active region, change all marks in
2079 the region.
2080 @end table
2082 Here is an example of a table that collects exam results of students and
2083 makes use of these features:
2085 @example
2086 @group
2087 |---+---------+--------+--------+--------+-------+------|
2088 |   | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
2089 |---+---------+--------+--------+--------+-------+------|
2090 | ! |         |     P1 |     P2 |     P3 |   Tot |      |
2091 | # | Maximum |     10 |     15 |     25 |    50 | 10.0 |
2092 | ^ |         |     m1 |     m2 |     m3 |    mt |      |
2093 |---+---------+--------+--------+--------+-------+------|
2094 | # | Peter   |     10 |      8 |     23 |    41 |  8.2 |
2095 | # | Sara    |      6 |     14 |     19 |    39 |  7.8 |
2096 | # | Sam     |      2 |      4 |      3 |     9 |  1.8 |
2097 |---+---------+--------+--------+--------+-------+------|
2098 |   | Average |        |        |        |  29.7 |      |
2099 | ^ |         |        |        |        |    at |      |
2100 | $ | max=50  |        |        |        |       |      |
2101 |---+---------+--------+--------+--------+-------+------|
2102 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
2103 @end group
2104 @end example
2106 @noindent @b{Important}: Please note that for these special tables,
2107 recalculating the table with @kbd{C-u C-c *} will only affect rows that
2108 are marked @samp{#} or @samp{*}, and fields that have a formula assigned
2109 to the field itself.  The column formulas are not applied in rows with
2110 empty first field.
2112 @cindex marking characters, tables
2113 The marking characters have the following meaning:
2114 @table @samp
2115 @item !
2116 The fields in this line define names for the columns, so that you may
2117 refer to a column as @samp{$Tot} instead of @samp{$6}.
2118 @item ^
2119 This row defines names for the fields @emph{above} the row.  With such
2120 a definition, any formula in the table may use @samp{$m1} to refer to
2121 the value @samp{10}.  Also, if you assign a formula to a names field, it
2122 will be stored as @samp{$name=...}.
2123 @item _
2124 Similar to @samp{^}, but defines names for the fields in the row
2125 @emph{below}.
2126 @item $
2127 Fields in this row can define @emph{parameters} for formulas.  For
2128 example, if a field in a @samp{$} row contains @samp{max=50}, then
2129 formulas in this table can refer to the value 50 using @samp{$max}.
2130 Parameters work exactly like constants, only that they can be defined on
2131 a per-table basis.
2132 @item #
2133 Fields in this row are automatically recalculated when pressing
2134 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row.  Also, this row
2135 is selected for a global recalculation with @kbd{C-u C-c *}.  Unmarked
2136 lines will be left alone by this command.
2137 @item *
2138 Selects this line for global recalculation with @kbd{C-u C-c *}, but
2139 not for automatic recalculation.  Use this when automatic
2140 recalculation slows down editing too much.
2141 @item
2142 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
2143 All lines that should be recalculated should be marked with @samp{#}
2144 or @samp{*}.
2145 @item /
2146 Do not export this line.  Useful for lines that contain the narrowing
2147 @samp{<N>} markers.
2148 @end table
2150 Finally, just to whet your appetite on what can be done with the
2151 fantastic @file{calc} package, here is a table that computes the Taylor
2152 series of degree @code{n} at location @code{x} for a couple of
2153 functions.
2155 @example
2156 @group
2157 |---+-------------+---+-----+--------------------------------------|
2158 |   | Func        | n | x   | Result                               |
2159 |---+-------------+---+-----+--------------------------------------|
2160 | # | exp(x)      | 1 | x   | 1 + x                                |
2161 | # | exp(x)      | 2 | x   | 1 + x + x^2 / 2                      |
2162 | # | exp(x)      | 3 | x   | 1 + x + x^2 / 2 + x^3 / 6            |
2163 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
2164 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2    |
2165 | * | tan(x)      | 3 | x   | 0.0175 x + 1.77e-6 x^3               |
2166 |---+-------------+---+-----+--------------------------------------|
2167 #+TBLFM: $5=taylor($2,$4,$3);n3
2168 @end group
2169 @end example
2171 @node Hyperlinks, TODO items, Tables, Top
2172 @chapter Hyperlinks
2173 @cindex hyperlinks
2175 Like HTML, Org-mode provides links inside a file, external links to
2176 other files, Usenet articles, emails, and much more.
2178 @menu
2179 * Link format::                 How links in Org-mode are formatted
2180 * Internal links::              Links to other places in the current file
2181 * External links::              URL-like links to the world
2182 * Handling links::              Creating, inserting and following
2183 * Using links outside Org-mode::  Linking from my C source code?
2184 * Link abbreviations::          Shortcuts for writing complex links
2185 * Search options::              Linking to a specific location
2186 * Custom searches::             When the default search is not enough
2187 @end menu
2189 @node Link format, Internal links, Hyperlinks, Hyperlinks
2190 @section Link format
2191 @cindex link format
2192 @cindex format, of links
2194 Org-mode will recognize plain URL-like links and activate them as
2195 clickable links.  The general link format, however, looks like this:
2197 @example
2198 [[link][description]]       @r{or alternatively}           [[link]]
2199 @end example
2201 Once a link in the buffer is complete (all brackets present), Org-mode
2202 will change the display so that @samp{description} is displayed instead
2203 of @samp{[[link][description]]} and @samp{link} is displayed instead of
2204 @samp{[[link]]}.  Links will be highlighted in the face @code{org-link},
2205 which by default is an underlined face.  You can directly edit the
2206 visible part of a link.  Note that this can be either the @samp{link}
2207 part (if there is no description) or the @samp{description} part.  To
2208 edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
2209 cursor on the link.
2211 If you place the cursor at the beginning or just behind the end of the
2212 displayed text and press @key{BACKSPACE}, you will remove the
2213 (invisible) bracket at that location.  This makes the link incomplete
2214 and the internals are again displayed as plain text.  Inserting the
2215 missing bracket hides the link internals again.  To show the
2216 internal structure of all links, use the menu entry
2217 @code{Org->Hyperlinks->Literal links}.
2219 @node Internal links, External links, Link format, Hyperlinks
2220 @section Internal links
2221 @cindex internal links
2222 @cindex links, internal
2223 @cindex targets, for links
2225 If the link does not look like a URL, it is considered to be internal in
2226 the current file.  Links such as @samp{[[My Target]]} or @samp{[[My
2227 Target][Find my target]]} lead to a text search in the current file.
2228 The link can be followed with @kbd{C-c C-o} when the cursor is on the
2229 link, or with a mouse click (@pxref{Handling links}).  The preferred
2230 match for such a link is a dedicated target: the same string in double
2231 angular brackets.  Targets may be located anywhere; sometimes it is
2232 convenient to put them into a comment line. For example
2234 @example
2235 # <<My Target>>
2236 @end example
2238 @noindent In HTML export (@pxref{HTML export}), such targets will become
2239 named anchors for direct access through @samp{http} links@footnote{Note
2240 that text before the first headline is usually not exported, so the
2241 first such target should be after the first headline.}.
2243 If no dedicated target exists, Org-mode will search for the words in the
2244 link.  In the above example the search would be for @samp{my target}.
2245 Links starting with a star like @samp{*My Target} restrict the search to
2246 headlines.  When searching, Org-mode will first try an exact match, but
2247 then move on to more and more lenient searches.  For example, the link
2248 @samp{[[*My Targets]]} will find any of the following:
2250 @example
2251 ** My targets
2252 ** TODO my targets are bright
2253 ** my 20 targets are
2254 @end example
2256 To insert a link targeting a headline, in-buffer completion can be used.
2257 Just type a star followed by a few optional letters into the buffer and
2258 press @kbd{M-@key{TAB}}.  All headlines in the current buffer will be
2259 offered as completions.  @xref{Handling links}, for more commands
2260 creating links.
2262 Following a link pushes a mark onto Org-mode's own mark ring.  You can
2263 return to the previous position with @kbd{C-c &}.  Using this command
2264 several times in direct succession goes back to positions recorded
2265 earlier.
2267 @menu
2268 * Radio targets::               Make targets trigger links in plain text.
2269 @end menu
2271 @node Radio targets,  , Internal links, Internal links
2272 @subsection Radio targets
2273 @cindex radio targets
2274 @cindex targets, radio
2275 @cindex links, radio targets
2277 Org-mode can automatically turn any occurrences of certain target names
2278 in normal text into a link.  So without explicitly creating a link, the
2279 text connects to the target radioing its position.  Radio targets are
2280 enclosed by triple angular brackets.  For example, a target @samp{<<<My
2281 Target>>>} causes each occurrence of @samp{my target} in normal text to
2282 become activated as a link.  The Org-mode file is scanned automatically
2283 for radio targets only when the file is first loaded into Emacs.  To
2284 update the target list during editing, press @kbd{C-c C-c} with the
2285 cursor on or at a target.
2287 @node External links, Handling links, Internal links, Hyperlinks
2288 @section External links
2289 @cindex links, external
2290 @cindex external links
2291 @cindex links, external
2292 @cindex GNUS links
2293 @cindex BBDB links
2294 @cindex IRC links
2295 @cindex URL links
2296 @cindex file links
2297 @cindex VM links
2298 @cindex RMAIL links
2299 @cindex WANDERLUST links
2300 @cindex MH-E links
2301 @cindex USENET links
2302 @cindex SHELL links
2303 @cindex Info links
2304 @cindex elisp links
2306 Org-mode supports links to files, websites, Usenet and email messages,
2307 BBDB database entries and links to both IRC conversations and their
2308 logs.  External links are URL-like locators.  They start with a short
2309 identifying string followed by a colon.  There can be no space after
2310 the colon.  The following list shows examples for each link type.
2312 @example
2313 http://orgmode.org/                       @r{on the web}
2314 file:/home/dominik/images/jupiter.jpg     @r{file, absolute path}
2315 file:papers/last.pdf                      @r{file, relative path}
2316 news:comp.emacs                           @r{Usenet link}
2317 mailto:adent@@galaxy.net                  @r{Mail link}
2318 vm:folder                                 @r{VM folder link}
2319 vm:folder#id                              @r{VM message link}
2320 vm://myself@@some.where.org/folder#id     @r{VM on remote machine}
2321 wl:folder                                 @r{WANDERLUST folder link}
2322 wl:folder#id                              @r{WANDERLUST message link}
2323 mhe:folder                                @r{MH-E folder link}
2324 mhe:folder#id                             @r{MH-E message link}
2325 rmail:folder                              @r{RMAIL folder link}
2326 rmail:folder#id                           @r{RMAIL message link}
2327 gnus:group                                @r{GNUS group link}
2328 gnus:group#id                             @r{GNUS article link}
2329 bbdb:Richard Stallman                     @r{BBDB link}
2330 irc:/irc.com/#emacs/bob                   @r{IRC link}
2331 shell:ls *.org                            @r{A shell command}
2332 elisp:(find-file-other-frame "Elisp.org") @r{An elisp form to evaluate}
2333 @end example
2335 A link should be enclosed in double brackets and may contain a
2336 descriptive text to be displayed instead of the url (@pxref{Link
2337 format}), for example:
2339 @example
2340 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
2341 @end example
2343 @noindent
2344 If the description is a file name or URL that points to an image, HTML
2345 export (@pxref{HTML export}) will inline the image as a clickable
2346 button.  If there is no description at all and the link points to an
2347 image,
2348 that image will be inlined into the exported HTML file.
2350 @cindex angular brackets, around links
2351 @cindex plain text external links
2352 Org-mode also finds external links in the normal text and activates them
2353 as links.  If spaces must be part of the link (for example in
2354 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
2355 about the end of the link, enclose them in angular brackets.
2357 @node Handling links, Using links outside Org-mode, External links, Hyperlinks
2358 @section Handling links
2359 @cindex links, handling
2361 Org-mode provides methods to create a link in the correct syntax, to
2362 insert it into an org-mode file, and to follow the link.
2364 @table @kbd
2365 @kindex C-c l
2366 @cindex storing links
2367 @item C-c l
2368 Store a link to the current location.  This is a @emph{global} command
2369 which can be used in any buffer to create a link.  The link will be
2370 stored for later insertion into an Org-mode buffer (see below).  For
2371 Org-mode files, if there is a @samp{<<target>>} at the cursor, the
2372 link points to the target.  Otherwise it points to the current
2373 headline.  For VM, RMAIL, WANDERLUST, MH-E, GNUS and BBDB buffers, the
2374 link will indicate the current article/entry.  For W3 and W3M buffers,
2375 the link goes to the current URL.  For IRC links, if you set the
2376 variable @code{org-irc-link-to-logs} to non-nil then @kbd{C-c l} will
2377 store a @samp{file:/} style link to the relevant point in the logs for
2378 the current conversation. Otherwise an @samp{irc:/} style link to the
2379 user/channel/server under the point will be stored.  For any other
2380 files, the link will point to the file, with a search string
2381 (@pxref{Search options}) pointing to the contents of the current line.
2382 If there is an active region, the selected words will form the basis
2383 of the search string.  If the automatically created link is not
2384 working correctly or accurately enough, you can write custom functions
2385 to select the search string and to do the search for particular file
2386 types - see @ref{Custom searches}.  The key binding @kbd{C-c l} is
2387 only a suggestion - see @ref{Installation}.
2389 @kindex C-c C-l
2390 @cindex link completion
2391 @cindex completion, of links
2392 @cindex inserting links
2393 @item C-c C-l
2394 Insert a link.  This prompts for a link to be inserted into the buffer.
2395 You can just type a link, using text for an internal link, or one of the
2396 link type prefixes mentioned in the examples above.  All links stored
2397 during the current session are part of the history for this prompt, so
2398 you can access them with @key{up} and @key{down} (or @kbd{M-p/n}).
2399 Completion, on the other hand, will help you to insert valid link
2400 prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
2401 defined through link abbreviations (@pxref{Link abbreviations}).  The
2402 link will be inserted into the buffer@footnote{After insertion of a
2403 stored link, the link will be removed from the list of stored links.  To
2404 keep it in the list later use, use a triple @kbd{C-u} prefix to @kbd{C-c
2405 C-l}, or configure the option
2406 @code{org-keep-stored-link-after-insertion}.}, along with a descriptive
2407 text.  If some text was selected when this command is called, the
2408 selected text becomes the default description.@* Note that you don't
2409 have to use this command to insert a link.  Links in Org-mode are plain
2410 text, and you can type or paste them straight into the buffer.  By using
2411 this command, the links are automatically enclosed in double brackets,
2412 and you will be asked for the optional descriptive text.
2414 @c  If the link is a @samp{file:} link and
2415 @c the linked file is located in the same directory as the current file or
2416 @c a subdirectory of it, the path of the file will be inserted relative to
2417 @c the current directory.
2419 @kindex C-u C-c C-l
2420 @cindex file name completion
2421 @cindex completion, of file names
2422 @item C-u C-c C-l
2423 When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
2424 a file will be inserted and you may use file name completion to select
2425 the name of the file.  The path to the file is inserted relative to the
2426 directory of the current org file, if the linked file is in the current
2427 directory or in a subdirectory of it, or if the path is written relative
2428 to the current directory using @samp{../}.  Otherwise an absolute path
2429 is used, if possible with @samp{~/} for your home directory.  You can
2430 force an absolute path with two @kbd{C-u} prefixes.
2432 @item C-c C-l @r{(with cursor on existing link)}
2433 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
2434 link and description parts of the link.
2436 @cindex following links
2437 @kindex C-c C-o
2438 @item C-c C-o
2439 Open link at point.  This will launch a web browser for URLs (using
2440 @command{browse-url-at-point}), run vm/mh-e/wanderlust/rmail/gnus/bbdb
2441 for the corresponding links, and execute the command in a shell link.
2442 When the cursor is on an internal link, this commands runs the
2443 corresponding search.  When the cursor is on a TAG list in a headline,
2444 it creates the corresponding TAGS view.  If the cursor is on a time
2445 stamp, it compiles the agenda for that date.  Furthermore, it will visit
2446 text and remote files in @samp{file:} links with Emacs and select a
2447 suitable application for local non-text files.  Classification of files
2448 is based on file extension only.  See option @code{org-file-apps}.  If
2449 you want to override the default application and visit the file with
2450 Emacs, use a @kbd{C-u} prefix.
2452 @kindex mouse-2
2453 @kindex mouse-1
2454 @item mouse-2
2455 @itemx mouse-1
2456 On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
2457 would.  Under Emacs 22, also @kbd{mouse-1} will follow a link.
2459 @kindex mouse-3
2460 @item mouse-3
2461 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
2462 internal links to be displayed in another window@footnote{See the
2463 variable @code{org-display-internal-link-with-indirect-buffer}}.
2465 @cindex mark ring
2466 @kindex C-c %
2467 @item C-c %
2468 Push the current position onto the mark ring, to be able to return
2469 easily. Commands following an internal link do this automatically.
2471 @cindex links, returning to
2472 @kindex C-c &
2473 @item C-c &
2474 Jump back to a recorded position.  A position is recorded by the
2475 commands following internal links, and by @kbd{C-c %}.  Using this
2476 command several times in direct succession moves through a ring of
2477 previously recorded positions.
2479 @kindex C-c C-x C-n
2480 @kindex C-c C-x C-p
2481 @cindex links, finding next/previous
2482 @item C-c C-x C-n
2483 @itemx C-c C-x C-p
2484 Move forward/backward to the next link in the buffer.  At the limit of
2485 the buffer, the search fails once, and then wraps around.  The key
2486 bindings for this are really too long, you might want to bind this also
2487 to @kbd{C-n} and @kbd{C-p}
2488 @lisp
2489 (add-hook 'org-load-hook
2490   (lambda ()
2491     (define-key 'org-mode-map "\C-n" 'org-next-link)
2492     (define-key 'org-mode-map "\C-p" 'org-previous-link)))
2493 @end lisp
2494 @end table
2496 @node Using links outside Org-mode, Link abbreviations, Handling links, Hyperlinks
2497 @section Using links outside Org-mode
2499 You can insert and follow links that have Org-mode syntax not only in
2500 Org-mode, but in any Emacs buffer.  For this, you should create two
2501 global commands, like this (please select suitable global keys
2502 yourself):
2504 @lisp
2505 (global-set-key "\C-c L" 'org-insert-link-global)
2506 (global-set-key "\C-c o" 'org-open-at-point-global)
2507 @end lisp
2509 @node Link abbreviations, Search options, Using links outside Org-mode, Hyperlinks
2510 @section Link abbreviations
2511 @cindex link abbreviations
2512 @cindex abbreviation, links
2514 Long URLs can be cumbersome to type, and often many similar links are
2515 needed in a document.  For this you can use link abbreviations.  An
2516 abbreviated link looks like this
2518 @example
2519 [[linkword:tag][description]]
2520 @end example
2522 @noindent
2523 where the tag is optional.  Such abbreviations are resolved according to
2524 the information in the variable @code{org-link-abbrev-alist} that
2525 relates the linkwords to replacement text.  Here is an example:
2527 @lisp
2528 @group
2529 (setq org-link-abbrev-alist
2530   '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
2531     ("google"   . "http://www.google.com/search?q=")
2532     ("ads"      . "http://adsabs.harvard.edu/cgi-bin/
2533                    nph-abs_connect?author=%s&db_key=AST")))
2534 @end group
2535 @end lisp
2537 If the replacement text contains the string @samp{%s}, it will be
2538 replaced with the tag.  Otherwise the tag will be appended to the string
2539 in order to create the link.  You may also specify a function that will
2540 be called with the tag as the only argument to create the link.
2542 With the above setting, you could link to a specific bug with
2543 @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
2544 @code{[[google:OrgMode]]} and find out what the Org-mode author is
2545 doing besides Emacs hacking with @code{[[ads:Dominik,C]]}.
2547 If you need special abbreviations just for a single Org-mode buffer, you
2548 can define them in the file with
2550 @example
2551 #+LINK: bugzilla  http://10.1.2.9/bugzilla/show_bug.cgi?id=
2552 #+LINK: google    http://www.google.com/search?q=%s
2553 @end example
2555 @noindent
2556 In-buffer completion @pxref{Completion} can be used after @samp{[} to
2557 complete link abbreviations.
2559 @node Search options, Custom searches, Link abbreviations, Hyperlinks
2560 @section Search options in file links
2561 @cindex search option in file links
2562 @cindex file links, searching
2564 File links can contain additional information to make Emacs jump to a
2565 particular location in the file when following a link.  This can be a
2566 line number or a search option after a double@footnote{For backward
2567 compatibility, line numbers can also follow a single colon.} colon. For
2568 example, when the command @kbd{C-c l} creates a link (@pxref{Handling
2569 links}) to a file, it encodes the words in the current line as a search
2570 string that can be used to find this line back later when following the
2571 link with @kbd{C-c C-o}.
2573 Here is the syntax of the different ways to attach a search to a file
2574 link, together with an explanation:
2576 @example
2577 [[file:~/code/main.c::255]]
2578 [[file:~/xx.org::My Target]]
2579 [[file:~/xx.org::*My Target]]
2580 [[file:~/xx.org::/regexp/]]
2581 @end example
2583 @table @code
2584 @item 255
2585 Jump to line 255.
2586 @item My Target
2587 Search for a link target @samp{<<My Target>>}, or do a text search for
2588 @samp{my target}, similar to the search in internal links, see
2589 @ref{Internal links}.  In HTML export (@pxref{HTML export}), such a file
2590 link will become an HTML reference to the corresponding named anchor in
2591 the linked file.
2592 @item *My Target
2593 In an Org-mode file, restrict search to headlines.
2594 @item /regexp/
2595 Do a regular expression search for @code{regexp}.  This uses the Emacs
2596 command @code{occur} to list all matches in a separate window.  If the
2597 target file is in Org-mode, @code{org-occur} is used to create a
2598 sparse tree with the matches.
2599 @c If the target file is a directory,
2600 @c @code{grep} will be used to search all files in the directory.
2601 @end table
2603 As a degenerate case, a file link with an empty file name can be used
2604 to search the current file.  For example, @code{[[file:::find me]]} does
2605 a search for @samp{find me} in the current file, just as
2606 @samp{[[find me]]} would.
2608 @node Custom searches,  , Search options, Hyperlinks
2609 @section Custom Searches
2610 @cindex custom search strings
2611 @cindex search strings, custom
2613 The default mechanism for creating search strings and for doing the
2614 actual search related to a file link may not work correctly in all
2615 cases.  For example, BibTeX database files have many entries like
2616 @samp{year="1993"} which would not result in good search strings,
2617 because the only unique identification for a BibTeX entry is the
2618 citation key.
2620 If you come across such a problem, you can write custom functions to set
2621 the right search string for a particular file type, and to do the search
2622 for the string in the file.  Using @code{add-hook}, these functions need
2623 to be added to the hook variables
2624 @code{org-create-file-search-functions} and
2625 @code{org-execute-file-search-functions}.  See the docstring for these
2626 variables for more information.  Org-mode actually uses this mechanism
2627 for Bib@TeX{} database files, and you can use the corresponding code as
2628 an implementation example.  Search for @samp{BibTeX links} in the source
2629 file.
2633 @node TODO items, Tags, Hyperlinks, Top
2634 @chapter TODO items
2635 @cindex TODO items
2637 Org-mode does not maintain TODO lists as separate documents.  Instead,
2638 TODO items are an integral part of the notes file, because TODO items
2639 usually come up while taking notes!  With Org-mode, simply mark any
2640 entry in a tree as being a TODO item.  In this way, information is not
2641 duplicated, and the entire context from which the TODO item emerged is
2642 always present.
2644 Of course, this technique for managing TODO items scatters them
2645 throughout your notes file.  Org-mode compensates for this by providing
2646 methods to give you an overview of all the things that you have to do.
2648 @menu
2649 * TODO basics::                 Marking and displaying TODO entries
2650 * TODO extensions::             Workflow and assignments
2651 * Progress logging::            Dates and notes for progress
2652 * Priorities::                  Some things are more important than others
2653 * Breaking down tasks::         Splitting a task into manageable pieces
2654 * Checkboxes::                  Tick-off lists
2655 @end menu
2657 @node TODO basics, TODO extensions, TODO items, TODO items
2658 @section Basic TODO functionality
2660 Any headline becomes a TODO item when it starts with the word
2661 @samp{TODO}, for example:
2663 @example
2664 *** TODO Write letter to Sam Fortune
2665 @end example
2667 @noindent
2668 The most important commands to work with TODO entries are:
2670 @table @kbd
2671 @kindex C-c C-t
2672 @cindex cycling, of TODO states
2673 @item C-c C-t
2674 Rotate the TODO state of the current item among
2676 @example
2677 ,-> (unmarked) -> TODO -> DONE --.
2678 '--------------------------------'
2679 @end example
2681 The same rotation can also be done ``remotely'' from the timeline and
2682 agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}).
2684 @kindex C-u C-c C-t
2685 @item C-u C-c C-t
2686 Select a specific keyword using completion or (if it has been set up)
2687 the fast selection interface.  For the latter, you need to assign keys
2688 to TODO states, see @ref{Per-file keywords} and @ref{Setting tags} for
2689 more information.
2691 @kindex S-@key{right}
2692 @kindex S-@key{left}
2693 @item S-@key{right}
2694 @itemx S-@key{left}
2695 Select the following/preceding TODO state, similar to cycling.  Useful
2696 mostly if more than two TODO states are possible (@pxref{TODO
2697 extensions}).
2698 @kindex C-c C-v
2699 @kindex C-c / t
2700 @cindex sparse tree, for TODO
2701 @item C-c C-v
2702 @itemx C-c / t
2703 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}).  Folds
2704 the entire buffer, but shows all TODO items and the headings hierarchy
2705 above them.  With prefix arg, search for a specific TODO.  You will be
2706 prompted for the keyword, and you can also give a list of keywords like
2707 @code{KWD1|KWD2|...}.  With numerical prefix N, show the tree for the
2708 Nth keyword in the variable @code{org-todo-keywords}.  With two prefix
2709 args, find all TODO and DONE entries.
2710 @kindex C-c a t
2711 @item C-c a t
2712 Show the global TODO list.  Collects the TODO items from all agenda
2713 files (@pxref{Agenda views}) into a single buffer.  The new buffer will
2714 be in @code{agenda-mode}, which provides commands to examine and
2715 manipulate the TODO entries from the new buffer (@pxref{Agenda
2716 commands}).  @xref{Global TODO list}, for more information.
2717 @kindex S-M-@key{RET}
2718 @item S-M-@key{RET}
2719 Insert a new TODO entry below the current one.
2720 @end table
2722 @node TODO extensions, Progress logging, TODO basics, TODO items
2723 @section Extended use of TODO keywords
2724 @cindex extended TODO keywords
2726 By default, marked TODO entries have one of only two states: TODO and
2727 DONE.  Org-mode allows you to classify TODO items in more complex ways
2728 with @emph{TODO keywords} (stored in @code{org-todo-keywords}).  With
2729 special setup, the TODO keyword system can work differently in different
2730 files.
2732 Note that @i{tags} are another way to classify headlines in general and
2733 TODO items in particular (@pxref{Tags}).
2735 @menu
2736 * Workflow states::             From TODO to DONE in steps
2737 * TODO types::                  I do this, Fred does the rest
2738 * Multiple sets in one file::   Mixing it all, and still finding your way
2739 * Fast access to TODO states::  Single letter selection of a state
2740 * Per-file keywords::           Different files, different requirements
2741 * Faces for TODO keywords::     Highlighting states
2742 @end menu
2744 @node Workflow states, TODO types, TODO extensions, TODO extensions
2745 @subsection TODO keywords as workflow states
2746 @cindex TODO workflow
2747 @cindex workflow states as TODO keywords
2749 You can use TODO keywords to indicate different @emph{sequential} states
2750 in the process of working on an item, for example@footnote{Changing
2751 this variable only becomes effective after restarting Org-mode in a
2752 buffer.}:
2754 @lisp
2755 (setq org-todo-keywords
2756   '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
2757 @end lisp
2759 The vertical bar separates the TODO keywords (states that @emph{need
2760 action}) from the DONE states (which need @emph{no further action}.  If
2761 you don't provide the separator bar, the last state is used as the DONE
2762 state.
2763 @cindex completion, of TODO keywords
2764 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
2765 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED.  You may
2766 also use a prefix argument to quickly select a specific state.  For
2767 example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY.
2768 Or you can use @kbd{S-left} to go backward through the sequence.  If you
2769 define many keywords, you can use in-buffer completion
2770 (@pxref{Completion}) or even a special one-key selection scheme
2771 (@pxref{Fast access to TODO states}) to insert these words into the
2772 buffer.  Changing a todo state can be logged with a timestamp, see
2773 @ref{Tracking TODO state changes} for more information.
2775 @node TODO types, Multiple sets in one file, Workflow states, TODO extensions
2776 @subsection TODO keywords as types
2777 @cindex TODO types
2778 @cindex names as TODO keywords
2779 @cindex types as TODO keywords
2781 The second possibility is to use TODO keywords to indicate different
2782 @emph{types} of action items.  For example, you might want to indicate
2783 that items are for ``work'' or ``home''.  Or, when you work with several
2784 people on a single project, you might want to assign action items
2785 directly to persons, by using their names as TODO keywords.  This would
2786 be set up like this:
2788 @lisp
2789 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
2790 @end lisp
2792 In this case, different keywords do not indicate a sequence, but rather
2793 different types.  So the normal work flow would be to assign a task to a
2794 person, and later to mark it DONE.  Org-mode supports this style by
2795 adapting the workings of the command @kbd{C-c C-t}@footnote{This is also
2796 true for the @kbd{t} command in the timeline and agenda buffers.}.  When
2797 used several times in succession, it will still cycle through all names,
2798 in order to first select the right type for a task.  But when you return
2799 to the item after some time and execute @kbd{C-c C-t} again, it will
2800 switch from any name directly to DONE.  Use prefix arguments or
2801 completion to quickly select a specific name.  You can also review the
2802 items of a specific TODO type in a sparse tree by using a numeric prefix
2803 to @kbd{C-c C-v}.  For example, to see all things Lucy has to do, you
2804 would use @kbd{C-3 C-c C-v}.  To collect Lucy's items from all agenda
2805 files into a single buffer, you would use the prefix arg as well when
2806 creating the global todo list: @kbd{C-3 C-c t}.
2808 @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions
2809 @subsection Multiple keyword sets in one file
2810 @cindex todo keyword sets
2812 Sometimes you may want to use different sets of TODO keywords in
2813 parallel.  For example, you may want to have the basic
2814 @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
2815 separate state indicating that an item has been canceled (so it is not
2816 DONE, but also does not require action).  Your setup would then look
2817 like this:
2819 @lisp
2820 (setq org-todo-keywords
2821       '((sequence "TODO" "|" "DONE")
2822         (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
2823         (sequence "|" "CANCELED")))
2824 @end lisp
2826 The keywords should all be different, this helps Org-mode to keep track
2827 of which subsequence should be used for a given entry.  In this setup,
2828 @kbd{C-c C-t} only operates within a subsequence, so it switches from
2829 @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
2830 (nothing) to @code{REPORT}.  Therefore you need a mechanism to initially
2831 select the correct sequence.  Besides the obvious ways like typing a
2832 keyword or using completion, you may also apply the following commands:
2834 @table @kbd
2835 @kindex C-S-@key{right}
2836 @kindex C-S-@key{left}
2837 @item C-S-@key{right}
2838 @itemx C-S-@key{left}
2839 These keys jump from one TODO subset to the next.  In the above example,
2840 @kbd{C-S-@key{right}} would jump from @code{TODO} or @code{DONE} to
2841 @code{REPORT}, and any of the words in the second row to @code{CANCELED}.
2842 @kindex S-@key{right}
2843 @kindex S-@key{left}
2844 @item S-@key{right}
2845 @itemx S-@key{left}
2846 @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through
2847 @emph{all} keywords from all sets, so for example @kbd{S-@key{<right>}}
2848 would switch from @code{DONE} to @code{REPORT} in the example above.
2849 @end table
2851 @node Fast access to TODO states, Per-file keywords, Multiple sets in one file, TODO extensions
2852 @subsection Fast access to TODO states
2854 If you would like to quickly change an entry to an arbitrary TODO state
2855 instead of cycling through the states, you can set up keys for
2856 single-letter access to the states.  This is done by adding the section
2857 key after each keyword, in parenthesis.  For example:
2859 @lisp
2860 (setq org-todo-keywords
2861       '((sequence "TODO(t)" "|" "DONE(d)")
2862         (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
2863         (sequence "|" "CANCELED(c)")))
2864 @end lisp
2866 If you then press @code{C-u C-c C-t} followed by the selection key, the
2867 entry will be switched to this state.  @key{SPC} can be used to remove
2868 any TODO keyword from an entry.  Should you like this way of selecting
2869 TODO states a lot, you might want to set the variable
2870 @code{org-use-fast-todo-selection} to @code{t} and make this behavior
2871 the default.  Check also the variable
2872 @code{org-fast-tag-selection-include-todo}, it allows to change the TODO
2873 state through the tags interface (@pxref{Setting tags}), in case you
2874 like to mingle the two concepts.
2876 @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions
2877 @subsection Setting up keywords for individual files
2878 @cindex keyword options
2879 @cindex per-file keywords
2881 It can be very useful to use different aspects of the TODO mechanism in
2882 different files.  For file-local settings, you need to add special lines
2883 to the file which set the keywords and interpretation for that file
2884 only.  For example, to set one of the two examples discussed above, you
2885 need one of the following lines, starting in column zero anywhere in the
2886 file:
2888 @example
2889 #+SEQ_TODO: TODO FEEDBACK VERIFY | DONE CANCELED
2890 @end example
2892 @example
2893 #+TYP_TODO: Fred Sara Lucy Mike | DONE
2894 @end example
2896 A setup for using several sets in parallel would be:
2898 @example
2899 #+SEQ_TODO: TODO | DONE
2900 #+SEQ_TODO: REPORT BUG KNOWNCAUSE | FIXED
2901 #+SEQ_TODO: | CANCELED
2902 @end example
2904 @cindex completion, of option keywords
2905 @kindex M-@key{TAB}
2906 @noindent To make sure you are using the correct keyword, type
2907 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
2909 @cindex DONE, final TODO keyword
2910 Remember that the keywords after the vertical bar (or the last keyword
2911 if no bar is there) must always mean that the item is DONE (although you
2912 may use a different word).  After changing one of these lines, use
2913 @kbd{C-c C-c} with the cursor still in the line to make the changes
2914 known to Org-mode@footnote{Org-mode parses these lines only when
2915 Org-mode is activated after visiting a file.  @kbd{C-c C-c} with the
2916 cursor in a line starting with @samp{#+} is simply restarting Org-mode
2917 for the current buffer.}.
2919 @node Faces for TODO keywords,  , Per-file keywords, TODO extensions
2920 @subsection Faces for TODO keywords
2921 @cindex faces, for TODO keywords
2923 Org-mode highlights TODO keywords with special faces: @code{org-todo}
2924 for keywords indicating that an item still has to be acted upon, and
2925 @code{org-done} for keywords indicating that an item is finished.  If
2926 you are using more than 2 different states, you might want to use
2927 special faces for some of them.  This can be done using the variable
2928 @code{org-todo-keyword-faces}.  For example:
2930 @lisp
2931 (setq org-todo-keyword-faces
2932       '(("TODO"      . org-warning)
2933         ("DEFERRED"  . shadow)
2934         ("CANCELED"  . (:foreground "blue" :weight bold))))
2935 @end lisp
2937 While using a list with face properties as shown for CANCELED
2938 @emph{should} work, this does not aways seem to be the case.  If
2939 necessary, define a special face and use that.
2941 @page
2942 @node Progress logging, Priorities, TODO extensions, TODO items
2943 @section Progress Logging
2944 @cindex progress logging
2945 @cindex logging, of progress
2947 Org-mode can automatically record a time stamp and possibly a note when
2948 you mark a TODO item as DONE, or even each time you change the state of
2949 a TODO item.  This system is highly configurable, settings can be on a
2950 per-keyword basis and can be localized to a file or even a subtree.  For
2951 information on how to clock working time for a task, see @ref{Clocking
2952 work time}.
2954 @menu
2955 * Closing items::               When was this entry marked DONE?
2956 * Tracking TODO state changes::  When did the status change?
2957 @end menu
2959 @node Closing items, Tracking TODO state changes, Progress logging, Progress logging
2960 @subsection Closing items
2962 The most basic logging is to keep track of @emph{when} a certain TODO
2963 item was finished.  This is achieved with@footnote{The corresponding
2964 in-buffer setting is: @code{#+STARTUP: logdone}}.
2966 @lisp
2967 (setq org-log-done 'time)
2968 @end lisp
2970 @noindent
2971 Then each time you turn an entry from a TODO (not-done) state into any
2972 of the DONE states, a line @samp{CLOSED: [timestamp]} will be inserted
2973 just after the headline.  If you turn the entry back into a TODO item
2974 through further state cycling, that line will be removed again.  If you
2975 want to record a note along with the timestamp, use@footnote{The
2976 corresponding in-buffer setting is: @code{#+STARTUP: lognotedone}}
2978 @lisp
2979 (setq org-log-done 'note)
2980 @end lisp
2982 @noindent
2983 You will then be prompted for a note, and that note will be stored below
2984 the entry with a @samp{Closing Note} heading.
2986 In the timeline (@pxref{Timeline}) and in the agenda
2987 (@pxref{Weekly/Daily agenda}), you can then use the @kbd{l} key to
2988 display the TODO items with a @samp{CLOSED} timestamp on each day,
2989 giving you an overview of what has been done.
2991 @node Tracking TODO state changes,  , Closing items, Progress logging
2992 @subsection Tracking TODO state changes
2994 When TODO keywords are used as workflow states (@pxref{Workflow
2995 states}), you might want to keep track of when a state change occurred
2996 and maybe take a note about this change.  Since it is normally too much
2997 to record a note for every state, Org-mode expects configuration on a
2998 per-keyword basis for this.  This is achieved by adding special markers
2999 @samp{!} (for a time stamp) and @samp{@@} (for a note) in parenthesis
3000 after each keyword.  For example, with the setting
3002 @lisp
3003 (setq org-todo-keywords
3004   '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
3005 @end lisp
3007 @noindent
3008 you not only define global TODO keywords and fast access keys, but also
3009 request that a time is recorded when the entry is turned into
3010 DONE@footnote{It is possible that Org-mode will record two time stamps
3011 when you are using both @code{org-log-done} and state change logging.
3012 However, it will never prompt for two notes - if you have configured
3013 both, the state change recording note will take precedence and cancel
3014 the @samp{Closing Note}.}, and that a note is recorded when switching to
3015 WAIT or CANCELED.  The setting for WAIT is even more special: The
3016 @samp{!} after the slash means that in addition to the note taken when
3017 entering the state, a time stamp should be recorded when @i{leaving} the
3018 WAIT state, if and only if the @i{target} state does not configure
3019 logging for entering it.  So it has no effect when switching from WAIT
3020 to DONE, because DONE is configured to record a timestamp only.  But
3021 when switching from WAIT back to TODO, the @samp{/!} in the WAIT
3022 setting now triggers a timestamp even though TODO has no logging
3023 configured.
3025 You can use the exact same syntax for setting logging preferences local
3026 to a buffer:
3027 @example
3028 #+SEQ_TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
3029 @end example
3031 In order to define logging settings that are local to a subtree or a
3032 single item, define a LOGGING property in this entry.  Any non-empty
3033 LOGGING property resets all logging settings to nil.  You may then turn
3034 on logging for this specific tree using STARTUP keywords like
3035 @code{lognotedone} or @code{logrepeat}, as well as adding state specific
3036 settings like @code{TODO(!)}.  For example
3038 @example
3039 * TODO Log each state with only a time
3040   :PROPERTIES:
3041   :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
3042   :END:
3043 * TODO Only log when switching to WAIT, and when repeating
3044   :PROPERTIES:
3045   :LOGGING: WAIT(@@) logrepeat
3046   :END:
3047 * TODO No logging at all
3048   :PROPERTIES:
3049   :LOGGING: nil
3050   :END:
3051 @end example
3054 @node Priorities, Breaking down tasks, Progress logging, TODO items
3055 @section Priorities
3056 @cindex priorities
3058 If you use Org-mode extensively, you may end up enough TODO items that
3059 it starts to make sense to prioritize them.  Prioritizing can be done by
3060 placing a @emph{priority cookie} into the headline of a TODO item, like
3061 this
3063 @example
3064 *** TODO [#A] Write letter to Sam Fortune
3065 @end example
3067 @noindent
3068 By default, Org-mode supports three priorities: @samp{A}, @samp{B}, and
3069 @samp{C}.  @samp{A} is the highest priority.  An entry without a cookie
3070 is treated as priority @samp{B}.  Priorities make a difference only in
3071 the agenda (@pxref{Weekly/Daily agenda}); outside the agenda, they have
3072 no inherent meaning to Org-mode.
3074 Priorities can be attached to any outline tree entries; they do not need
3075 to be TODO items.
3077 @table @kbd
3078 @kindex @kbd{C-c ,}
3079 @item @kbd{C-c ,}
3080 Set the priority of the current headline.  The command prompts for a
3081 priority character @samp{A}, @samp{B} or @samp{C}.  When you press
3082 @key{SPC} instead, the priority cookie is removed from the headline.
3083 The priorities can also be changed ``remotely'' from the timeline and
3084 agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
3086 @kindex S-@key{up}
3087 @kindex S-@key{down}
3088 @item S-@key{up}
3089 @itemx S-@key{down}
3090 Increase/decrease priority of current headline@footnote{See also the
3091 option @code{org-priority-start-cycle-with-default'}.}.  Note that these
3092 keys are also used to modify time stamps (@pxref{Creating timestamps}).
3093 Furthermore, these keys are also used by CUA-mode (@pxref{Conflicts}).
3094 @end table
3096 You can change the range of allowed priorities by setting the variables
3097 @code{org-highest-priority}, @code{org-lowest-priority}, and
3098 @code{org-default-priority}.  For an individual buffer, you may set
3099 these values (highest, lowest, default) like this (please make sure that
3100 the highest priority is earlier in the alphabet than the lowest
3101 priority):
3103 @example
3104 #+PRIORITIES: A C B
3105 @end example
3107 @node Breaking down tasks, Checkboxes, Priorities, TODO items
3108 @section Breaking tasks down into subtasks
3109 @cindex tasks, breaking down
3111 It is often advisable to break down large tasks into smaller, manageable
3112 subtasks.  You can do this by creating an outline tree below a TODO
3113 item, with detailed subtasks on the tree@footnote{To keep subtasks out
3114 of the global TODO list, see the
3115 @code{org-agenda-todo-list-sublevels}.}.  Another possibility is the use
3116 of checkboxes to identify (a hierarchy of) a large number of subtasks
3117 (@pxref{Checkboxes}).
3120 @node Checkboxes,  , Breaking down tasks, TODO items
3121 @section Checkboxes
3122 @cindex checkboxes
3124 Every item in a plain list (@pxref{Plain lists}) can be made into a
3125 checkbox by starting it with the string @samp{[ ]}.  This feature is
3126 similar to TODO items (@pxref{TODO items}), but is more lightweight.
3127 Checkboxes are not included into the global TODO list, so they are often
3128 great to split a task into a number of simple steps.  Or you can use
3129 them in a shopping list.  To toggle a checkbox, use @kbd{C-c C-c}, or
3130 use the mouse (thanks to Piotr Zielinski's @file{org-mouse.el}).
3132 Here is an example of a checkbox list.
3134 @example
3135 * TODO Organize party [2/4]
3136   - [-] call people [1/3]
3137     - [ ] Peter
3138     - [X] Sarah
3139     - [ ] Sam
3140   - [X] order food
3141   - [ ] think about what music to play
3142   - [X] talk to the neighbors
3143 @end example
3145 Checkboxes work hierarchically, so if a checkbox item has children that
3146 are checkboxes, toggling one of the children checkboxes will make the
3147 parent checkbox reflect if none, some, or all of the children are
3148 checked.
3150 @cindex statistics, for checkboxes
3151 @cindex checkbox statistics
3152 The @samp{[2/4]} and @samp{[1/3]} in the first and second line are
3153 cookies indicating how many checkboxes present in this entry have been
3154 checked off, and the total number of checkboxes are present.  This can
3155 give you an idea on how many checkboxes remain, even without opening a
3156 folded entry.  The cookies can be placed into a headline or into (the
3157 first line of) a plain list item. Each cookie covers all checkboxes
3158 structurally below the headline/item on which the cookie appear.  You
3159 have to insert the cookie yourself by typing either @samp{[/]} or
3160 @samp{[%]}.  With @samp{[/]} you get an @samp{n out of m} result, as in
3161 the examples above.  With @samp{[%]} you get information about the
3162 percentage of checkboxes checked (in the above example, this would be
3163 @samp{[50%]} and @samp{[33%]}, respectively).
3165 @noindent The following commands work with checkboxes:
3167 @table @kbd
3168 @kindex C-c C-c
3169 @item C-c C-c
3170 Toggle checkbox at point.  With prefix argument, set it to @samp{[-]},
3171 which is considered to be an intermediate state.
3172 @kindex C-c C-x C-b
3173 @item C-c C-x C-b
3174 Toggle checkbox at point.
3175 @itemize @minus
3176 @item
3177 If there is an active region, toggle the first checkbox in the region
3178 and set all remaining boxes to the same status as the first.  If you
3179 want to toggle all boxes in the region independently, use a prefix
3180 argument.
3181 @item
3182 If the cursor is in a headline, toggle checkboxes in the region between
3183 this headline and the next (so @emph{not} the entire subtree).
3184 @item
3185 If there is no active region, just toggle the checkbox at point.
3186 @end itemize
3187 @kindex M-S-@key{RET}
3188 @item M-S-@key{RET}
3189 Insert a new item with a checkbox.
3190 This works only if the cursor is already in a plain list item
3191 (@pxref{Plain lists}).
3192 @kindex C-c #
3193 @item C-c #
3194 Update the checkbox statistics in the current outline entry.  When
3195 called with a @kbd{C-u} prefix, update the entire file.  Checkbox
3196 statistic cookies are updated automatically if you toggle checkboxes
3197 with @kbd{C-c C-c} and make new ones with @kbd{M-S-@key{RET}}.  If you
3198 delete boxes or add/change them by hand, use this command to get things
3199 back into synch.  Or simply toggle any checkbox twice with @kbd{C-c C-c}.
3200 @end table
3202 @node Tags, Properties and columns, TODO items, Top
3203 @chapter Tags
3204 @cindex tags
3205 @cindex headline tagging
3206 @cindex matching, tags
3207 @cindex sparse tree, tag based
3209 An excellent way to implement labels and contexts for cross-correlating
3210 information is to assign @i{tags} to headlines.  Org-mode has extensive
3211 support for tags.
3213 Every headline can contain a list of tags; they occur at the end of the
3214 headline.  Tags are normal words containing letters, numbers, @samp{_},
3215 and @samp{@@}.  Tags must be preceded and followed by a single colon,
3216 e.g., @samp{:WORK:}.  Several tags can be specified, as in
3217 @samp{:work:URGENT:}.
3219 @menu
3220 * Tag inheritance::             Tags use the tree structure of the outline
3221 * Setting tags::                How to assign tags to a headline
3222 * Tag searches::                Searching for combinations of tags
3223 @end menu
3225 @node Tag inheritance, Setting tags, Tags, Tags
3226 @section Tag inheritance
3227 @cindex tag inheritance
3228 @cindex inheritance, of tags
3229 @cindex sublevels, inclusion into tags match
3231 @i{Tags} make use of the hierarchical structure of outline trees.  If a
3232 heading has a certain tag, all subheadings will inherit the tag as
3233 well.  For example, in the list
3235 @example
3236 * Meeting with the French group      :work:
3237 ** Summary by Frank                  :boss:notes:
3238 *** TODO Prepare slides for him      :action:
3239 @end example
3241 @noindent
3242 the final heading will have the tags @samp{:work:}, @samp{:boss:},
3243 @samp{:notes:}, and @samp{:action:} even though the final heading is not
3244 explicitly marked with those tags.  When executing tag searches and
3245 Org-mode finds that a certain headline matches the search criterion, it
3246 will not check any sublevel headline, assuming that these also match and
3247 that the list of matches could become very long because of that.  If you
3248 do want the subevels be tested and listed as well, you may set the
3249 variable @code{org-tags-match-list-sublevels}.  To turn off tag
3250 inheritance entirely, use the variable @code{org-use-tag-inheritance}.
3252 @node Setting tags, Tag searches, Tag inheritance, Tags
3253 @section Setting tags
3254 @cindex setting tags
3255 @cindex tags, setting
3257 @kindex M-@key{TAB}
3258 Tags can simply be typed into the buffer at the end of a headline.
3259 After a colon, @kbd{M-@key{TAB}} offers completion on tags.  There is
3260 also a special command for inserting tags:
3262 @table @kbd
3263 @kindex C-c C-c
3264 @item C-c C-c
3265 @cindex completion, of tags
3266 Enter new tags for the current headline.  Org-mode will either offer
3267 completion or a special single-key interface for setting tags, see
3268 below.  After pressing @key{RET}, the tags will be inserted and aligned
3269 to @code{org-tags-column}.  When called with a @kbd{C-u} prefix, all
3270 tags in the current buffer will be aligned to that column, just to make
3271 things look nice.  TAGS are automatically realigned after promotion,
3272 demotion, and TODO state changes (@pxref{TODO basics}).
3273 @end table
3275 Org will support tag insertion based on a @emph{list of tags}.  By
3276 default this list is constructed dynamically, containing all tags
3277 currently used in the buffer.  You may also globally specify a hard list
3278 of tags with the variable @code{org-tag-alist}.  Finally you can set
3279 the default tags for a given file with lines like
3281 @example
3282 #+TAGS: @@work @@home @@tennisclub
3283 #+TAGS: laptop car pc sailboat
3284 @end example
3286 If you have globally defined your preferred set of tags using the
3287 variable @code{org-tag-alist}, but would like to use a dynamic tag list
3288 in a specific file, add an empty TAGS option line to that file:
3290 @example
3291 #+TAGS:
3292 @end example
3294 The default support method for entering tags is minibuffer completion.
3295 However, Org-mode also implements a much better method: @emph{fast tag
3296 selection}.  This method allows to select and deselect tags with a
3297 single key per tag.  To function efficiently, you should assign unique
3298 keys to most tags.  This can be done globally with
3300 @lisp
3301 (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
3302 @end lisp
3304 @noindent or on a per-file basis with
3306 @example
3307 #+TAGS: @@work(w)  @@home(h)  @@tennisclub(t)  laptop(l)  pc(p)
3308 @end example
3310 @noindent
3311 You can also group together tags that are mutually exclusive.  With
3312 curly braces@footnote{In @code{org-mode-alist} use
3313 @code{'(:startgroup)} and @code{'(:endgroup)}, respectively.  Several
3314 groups are allowed.}
3316 @example
3317 #+TAGS: @{ @@work(w)  @@home(h)  @@tennisclub(t) @}  laptop(l)  pc(p)
3318 @end example
3320 @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
3321 and @samp{@@tennisclub} should be selected.
3323 @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
3324 these lines to activate any changes.
3326 If at least one tag has a selection key, pressing @kbd{C-c C-c} will
3327 automatically present you with a special interface, listing inherited
3328 tags, the tags of the current headline, and a list of all valid tags
3329 with corresponding keys@footnote{Keys will automatically be assigned to
3330 tags which have no configured keys.}.  In this interface, you can use
3331 the following keys:
3333 @table @kbd
3334 @item a-z...
3335 Pressing keys assigned to tags will add or remove them from the list of
3336 tags in the current line.  Selecting a tag in a group of mutually
3337 exclusive tags will turn off any other tags from that group.
3338 @kindex @key{TAB}
3339 @item @key{TAB}
3340 Enter a tag in the minibuffer, even if the tag is not in the predefined
3341 list.  You will be able to complete on all tags present in the buffer.
3342 @kindex @key{SPC}
3343 @item @key{SPC}
3344 Clear all tags for this line.
3345 @kindex @key{RET}
3346 @item @key{RET}
3347 Accept the modified set.
3348 @item C-g
3349 Abort without installing changes.
3350 @item q
3351 If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
3352 @item !
3353 Turn off groups of mutually exclusive tags.  Use this to (as an
3354 exception) assign several tags from such a group.
3355 @item C-c
3356 Toggle auto-exit after the next change (see below).
3357 If you are using expert mode, the first @kbd{C-c} will display the
3358 selection window.
3359 @end table
3361 @noindent
3362 This method lets you assign tags to a headline with very few keys.  With
3363 the above setup, you could clear the current tags and set @samp{@@home},
3364 @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
3365 C-c @key{SPC} h l p @key{RET}}.  Switching from @samp{@@home} to
3366 @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
3367 alternatively with @kbd{C-c C-c C-c w}.  Adding the non-predefined tag
3368 @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
3369 @key{RET} @key{RET}}.
3371 If you find that most of the time, you need only a single keypress to
3372 modify your list of tags, set the variable
3373 @code{org-fast-tag-selection-single-key}.  Then you no longer have to
3374 press @key{RET} to exit fast tag selection - it will immediately exit
3375 after the first change.  If you then occasionally need more keys, press
3376 @kbd{C-c} to turn off auto-exit for the current tag selection process
3377 (in effect: start selection with @kbd{C-c C-c C-c} instead of @kbd{C-c
3378 C-c}).  If you set the variable to the value @code{expert}, the special
3379 window is not even shown for single-key tag selection, it comes up only
3380 when you press an extra @kbd{C-c}.
3382 @node Tag searches,  , Setting tags, Tags
3383 @section Tag searches
3384 @cindex tag searches
3385 @cindex searching for tags
3387 Once a system of tags has been set up, it can be used to collect related
3388 information into special lists.
3390 @table @kbd
3391 @kindex C-c \
3392 @kindex C-c / T
3393 @item C-c \
3394 @itemx C-c / T
3395 Create a sparse tree with all headlines matching a tags search.  With a
3396 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
3397 @kindex C-c a m
3398 @item C-c a m
3399 Create a global list of tag matches from all agenda files.
3400 @xref{Matching tags and properties}.
3401 @kindex C-c a M
3402 @item C-c a M
3403 Create a global list of tag matches from all agenda files, but check
3404 only TODO items and force checking subitems (see variable
3405 @code{org-tags-match-list-sublevels}).
3406 @end table
3408 @cindex Boolean logic, for tag searches
3409 A @i{tags} search string can use Boolean operators @samp{&} for AND and
3410 @samp{|} for OR.  @samp{&} binds more strongly than @samp{|}.
3411 Parenthesis are currently not implemented.  A tag may also be preceded
3412 by @samp{-}, to select against it, and @samp{+} is syntactic sugar for
3413 positive selection.  The AND operator @samp{&} is optional when @samp{+}
3414 or @samp{-} is present.  Examples:
3416 @table @samp
3417 @item +work-boss
3418 Select headlines tagged @samp{:work:}, but discard those also tagged
3419 @samp{:boss:}.
3420 @item work|laptop
3421 Selects lines tagged @samp{:work:} or @samp{:laptop:}.
3422 @item work|laptop&night
3423 Like before, but require the @samp{:laptop:} lines to be tagged also
3424 @samp{:night:}.
3425 @end table
3427 @cindex TODO keyword matching, with tags search
3428 If you are using multi-state TODO keywords (@pxref{TODO extensions}), it
3429 can be useful to also match on the TODO keyword.  This can be done by
3430 adding a condition after a slash to a tags match.  The syntax is similar
3431 to the tag matches, but should be applied with consideration: For
3432 example, a positive selection on several TODO keywords can not
3433 meaningfully be combined with boolean AND.  However, @emph{negative
3434 selection} combined with AND can be meaningful.  To make sure that only
3435 lines are checked that actually have any TODO keyword, use @kbd{C-c a
3436 M}, or equivalently start the todo part after the slash with @samp{!}.
3437 Examples:
3439 @table @samp
3440 @item work/WAITING
3441 Select @samp{:work:}-tagged TODO lines with the specific TODO
3442 keyword @samp{WAITING}.
3443 @item work/!-WAITING-NEXT
3444 Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
3445 nor @samp{NEXT}
3446 @item work/+WAITING|+NEXT
3447 Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
3448 @samp{NEXT}.
3449 @end table
3451 @cindex regular expressions, with tags search
3452 Any element of the tag/todo match can be a regular expression - in this
3453 case it must be enclosed in curly braces.  For example,
3454 @samp{work+@{^boss.*@}} matches headlines that contain the tag
3455 @samp{:work:} and any tag @i{starting} with @samp{boss}.
3457 @cindex level, require for tags/property match
3458 @cindex category, require for tags/property match
3459 You can also require a headline to be of a certain level or category, by
3460 writing instead of any TAG an expression like @samp{LEVEL=3} or
3461 @samp{CATEGORY="work"}, respectively.  For example, a search
3462 @samp{+LEVEL=3+boss/-DONE} lists all level three headlines that have the
3463 tag @samp{boss} and are @emph{not} marked with the todo keyword DONE.
3465 @node Properties and columns, Dates and times, Tags, Top
3466 @chapter Properties and Columns
3467 @cindex properties
3469 Properties are a set of key-value pairs associated with an entry.  There
3470 are two main applications for properties in Org-mode.  First, properties
3471 are like tags, but with a value.  Second, you can use properties to
3472 implement (very basic) database capabilities in an Org-mode buffer.  For
3473 an example of the first application, imagine maintaining a file where
3474 you document bugs and plan releases of a piece of software.  Instead of
3475 using tags like @code{:release_1:}, @code{:release_2:}, one can use a
3476 property, say @code{:Release:}, that in different subtrees has different
3477 values, such as @code{1.0} or @code{2.0}.  For an example of the second
3478 application of properties, imagine keeping track of one's music CD's,
3479 where properties could be things such as the album artist, date of
3480 release, number of tracks, and so on.
3482 Properties can be conveniently edited and viewed in column view
3483 (@pxref{Column view}).
3485 Properties are like tags, but with a value.  For example, in a file
3486 where you document bugs and plan releases of a piece of software,
3487 instead of using tags like @code{:release_1:}, @code{:release_2:}, it
3488 can be more efficient to use a property @code{:Release:} with a value
3489 @code{1.0} or @code{2.0}.  Second, you can use properties to implement
3490 (very basic) database capabilities in an Org-mode buffer, for example to
3491 create a list of Music CD's you own.  You can edit and view properties
3492 conveniently in column view (@pxref{Column view}).
3494 @menu
3495 * Property syntax::             How properties are spelled out
3496 * Special properties::          Access to other Org-mode features
3497 * Property searches::           Matching property values
3498 * Property inheritance::        Passing values down the tree
3499 * Column view::                 Tabular viewing and editing
3500 * Property API::                Properties for Lisp programmers
3501 @end menu
3503 @node Property syntax, Special properties, Properties and columns, Properties and columns
3504 @section Property Syntax
3505 @cindex property syntax
3506 @cindex drawer, for properties
3508 Properties are key-value pairs.  They need to be inserted into a special
3509 drawer (@pxref{Drawers}) with the name @code{PROPERTIES}.  Each property
3510 is specified on a single line, with the key (surrounded by colons)
3511 first, and the value after it.  Here is an example:
3513 @example
3514 * CD collection
3515 ** Classic
3516 *** Goldberg Variations
3517     :PROPERTIES:
3518     :Title:     Goldberg Variations
3519     :Composer:  J.S. Bach
3520     :Artist:    Glen Gould
3521     :Publisher: Deutsche Grammphon
3522     :NDisks:    1
3523     :END:
3524 @end example
3526 You may define the allowed values for a particular property @samp{:Xyz:}
3527 by setting a property @samp{:Xyz_ALL:}.  This special property is
3528 @emph{inherited}, so if you set it in a level 1 entry, it will apply to
3529 the entire tree.  When allowed values are defined, setting the
3530 corresponding property becomes easier and is less prone to typing
3531 errors.  For the example with the CD collection, we can predefine
3532 publishers and the number of disks in a box like this:
3534 @example
3535 * CD collection
3536   :PROPERTIES:
3537   :NDisks_ALL:  1 2 3 4
3538   :Publisher_ALL: "Deutsche Grammophon" Phillips EMI
3539   :END:
3540 @end example
3542 If you want to set properties that can be inherited by any entry in a
3543 file, use a line like
3545 @example
3546 #+PROPERTY: NDisks_ALL 1 2 3 4
3547 @end example
3549 Property values set with the global variable
3550 @code{org-global-properties} can be inherited by all entries in all
3551 Org-mode files.
3553 @noindent
3554 The following commands help to work with properties:
3556 @table @kbd
3557 @kindex M-@key{TAB}
3558 @item M-@key{TAB}
3559 After an initial colon in a line, complete property keys.  All keys used
3560 in the current file will be offered as possible completions.
3561 @kindex C-c C-x p
3562 @item C-c C-x p
3563 Set a property.  This prompts for a property name and a value.  If
3564 necessary, the property drawer is created as well.
3565 @item M-x org-insert-property-drawer
3566 Insert a property drawer into the current entry.  The drawer will be
3567 inserted early in the entry, but after the lines with planning
3568 information like deadlines.
3569 @kindex C-c C-c
3570 @item C-c C-c
3571 With the cursor in a property drawer, this executes property commands.
3572 @item C-c C-c s
3573 Set a property in the current entry.  Both the property and the value
3574 can be inserted using completion.
3575 @kindex S-@key{right}
3576 @kindex S-@key{left}
3577 @item S-@key{left}/@key{right}
3578 Switch property at point to the next/previous allowed value.
3579 @item C-c C-c d
3580 Remove a property from the current entry.
3581 @item C-c C-c D
3582 Globally remove a property, from all entries in the current file.
3583 @item C-c C-c c
3584 Compute the property at point, using the operator and scope from the
3585 nearest column format definition.
3586 @end table
3588 @node Special properties, Property searches, Property syntax, Properties and columns
3589 @section Special Properties
3590 @cindex properties, special
3592 Special properties provide alternative access method to Org-mode
3593 features discussed in the previous chapters, like the TODO state or the
3594 priority of an entry.  This interface exists so that you can include
3595 these states into columns view (@pxref{Column view}), or to use them in
3596 queries.  The following property names are special and should not be
3597 used as keys in the properties drawer:
3599 @example
3600 TODO         @r{The TODO keyword of the entry.}
3601 TAGS         @r{The tags defined directly in the headline.}
3602 ALLTAGS      @r{All tags, including inherited ones.}
3603 PRIORITY     @r{The priority of the entry, a string with a single letter.}
3604 DEADLINE     @r{The deadline time string, without the angular brackets.}
3605 SCHEDULED    @r{The scheduling time stamp, without the angular brackets.}
3606 TIMESTAMP    @r{The first keyword-less time stamp in the entry.}
3607 TIMESTAMP_IA @r{The first inactive time stamp in the entry.}
3608 CLOCKSUM     @r{The sum of CLOCK intervals in the subtree.  @code{org-clock-sum}}
3609              @r{must be run first to compute the values.}
3610 @end example
3612 @node Property searches, Property inheritance, Special properties, Properties and columns
3613 @section Property searches
3614 @cindex properties, searching
3615 @cindex properties, inheritance
3616 @cindex searching, of properties
3617 @cindex inheritance, of properties
3619 To create sparse trees and special lists with selection based on
3620 properties, the same commands are used as for tag searches (@pxref{Tag
3621 searches}), and the same logic applies.  For example, a search string
3623 @example
3624 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort=""+With=@{Sarah\|Denny@}
3625 @end example
3627 @noindent
3628 finds entries tagged @samp{:work:} but not @samp{:boss:}, which
3629 also have a priority value @samp{A}, a @samp{:Coffee:} property with the
3630 value @samp{unlimited}, an @samp{Effort} property that is undefined or
3631 empty, and a @samp{:With:} property that is matched by
3632 the regular expression @samp{Sarah\|Denny}.
3634 You can configure Org-mode to use property inheritance during a search,
3635 see @ref{Property inheritance} for details.
3637 There is also a special command for creating sparse trees based on a
3638 single property:
3640 @table @kbd
3641 @kindex C-c / p
3642 @item C-c / p
3643 Create a sparse tree based on the value of a property.  This first
3644 prompts for the name of a property, and then for a value.  A sparse tree
3645 is created with all entries that define this property with the given
3646 value.  If you enclose the value into curly braces, it is interpreted as
3647 a regular expression and matched against the property values.
3648 @end table
3650 @node Property inheritance, Column view, Property searches, Properties and columns
3651 @section Property Inheritance
3653 The outline structure of Org-mode documents lends itself for an
3654 inheritance model of properties: If the parent in a tree has a certain
3655 property, the children can inherit this property.  Org-mode does not
3656 turn this on by default, because it can slow down property searches
3657 significantly and is often not needed.  However, if you find inheritance
3658 useful, you can turn it on by setting the variable
3659 @code{org-use-property-inheritance}.  It may be set to @code{t}, to make
3660 all properties inherited from the parent, or to a list of properties
3661 that should be inherited.
3663 Org-mode has a few properties for which inheritance is hard-coded, at
3664 least for the special applications for which they are used:
3666 @table @code
3667 @item COLUMNS
3668 The @code{:COLUMNS:} property defines the format of column view
3669 (@pxref{Column view}).  It is inherited in the sense that the level
3670 where a @code{:COLUMNS:} property is defined is used as the starting
3671 point for a column view table, independently of the location in the
3672 subtree from where columns view is turned on.
3673 @item CATEGORY
3674 For agenda view, a category set through a @code{:CATEGORY:} property
3675 applies to the entire subtree.
3676 @item ARCHIVE
3677 For archiving, the @code{:ARCHIVE:} property may define the archive
3678 location for the entire subtree (@pxref{Moving subtrees}).
3679 @item LOGGING
3680 The LOGGING property may define logging settings for an entry or a
3681 subtree (@pxref{Tracking TODO state changes}).
3682 @end table
3684 @node Column view, Property API, Property inheritance, Properties and columns
3685 @section Column View
3687 A great way to view and edit properties in an outline tree is
3688 @emph{column view}.  In column view, each outline item is turned into a
3689 table row.  Columns in this table provide access to properties of the
3690 entries.  Org-mode implements columns by overlaying a tabular structure
3691 over the headline of each item.  While the headlines have been turned
3692 into a table row, you can still change the visibility of the outline
3693 tree.  For example, you get a compact table by switching to CONTENTS
3694 view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
3695 is active), but you can still open, read, and edit the entry below each
3696 headline.  Or, you can switch to column view after executing a sparse
3697 tree command and in this way get a table only for the selected items.
3698 Column view also works in agenda buffers (@pxref{Agenda views}) where
3699 queries have collected selected items, possibly from a number of files.
3701 @menu
3702 * Defining columns::            The COLUMNS format property
3703 * Using column view::           How to create and use column view
3704 * Capturing Column View::       A dynamic block for column view
3705 @end menu
3707 @node Defining columns, Using column view, Column view, Column view
3708 @subsection Defining Columns
3709 @cindex column view, for properties
3710 @cindex properties, column view
3712 Setting up a column view first requires defining the columns.  This is
3713 done by defining a column format line.
3715 @menu
3716 * Scope of column definitions::  Where defined, where valid?
3717 * Column attributes::           Appearance and content of a column
3718 @end menu
3720 @node Scope of column definitions, Column attributes, Defining columns, Defining columns
3721 @subsubsection Scope of column definitions
3723 To define a column format for an entire file, use a line like
3725 @example
3726 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
3727 @end example
3729 To specify a format that only applies to a specific tree, add a
3730 @code{:COLUMNS:} property to the top node of that tree, for example:
3732 @example
3733 ** Top node for columns view
3734    :PROPERTIES:
3735    :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
3736    :END:
3737 @end example
3739 If a @code{:COLUMNS:} property is present in an entry, it defines columns
3740 for the entry itself, and for the entire subtree below it.  Since the
3741 column definition is part of the hierarchical structure of the document,
3742 you can define columns on level 1 that are general enough for all
3743 sublevels, and more specific columns further down, when you edit a
3744 deeper part of the tree.
3746 @node Column attributes,  , Scope of column definitions, Defining columns
3747 @subsubsection Column attributes
3748 A column definition sets the attributes of a column.  The general
3749 definition looks like this:
3751 @example
3752  %[width]property[(title)][@{summary-type@}]
3753 @end example
3755 @noindent
3756 Except for the percent sign and the property name, all items are
3757 optional.  The individual parts have the following meaning:
3759 @example
3760 width           @r{An integer specifying the width of the column in characters.}
3761                 @r{If omitted, the width will be determined automatically.}
3762 property        @r{The property that should be edited in this column.}
3763 (title)         @r{The header text for the column. If omitted, the}
3764                 @r{property name is used.}
3765 @{summary-type@}  @r{The summary type.  If specified, the column values for}
3766                 @r{parent nodes are computed from the children.}
3767                 @r{Supported summary types are:}
3768                 @{+@}       @r{Sum numbers in this column.}
3769                 @{+;%.1f@}  @r{Like @samp{+}, but format result with @samp{%.1f}.}
3770                 @{$@}       @r{Currency, short for @samp{+;%.2f}.}
3771                 @{:@}       @r{Sum times, HH:MM:SS, plain numbers are hours.}
3772                 @{X@}       @r{Checkbox status, [X] if all children are [X].}
3773                 @{X/@}      @r{Checkbox status, [n/m].}
3774                 @{X%@}      @r{Checkbox status, [n%].}
3775 @end example
3777 @noindent
3778 Here is an example for a complete columns definition, along with allowed
3779 values.
3781 @example
3782 :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.}
3783                    %10Time_Estimate@{:@} %CLOCKSUM
3784 :Owner_ALL:    Tammy Mark Karl Lisa Don
3785 :Status_ALL:   "In progress" "Not started yet" "Finished" ""
3786 :Approved_ALL: "[ ]" "[X]"
3787 @end example
3789 The first column, @samp{%25ITEM}, means the first 25 characters of the
3790 item itself, i.e. of the headline.  You probably always should start the
3791 column definition with the @samp{ITEM} specifier.  The other specifiers
3792 create columns @samp{Owner} with a list of names as allowed values, for
3793 @samp{Status} with four different possible values, and for a checkbox
3794 field @samp{Approved}.  When no width is given after the @samp{%}
3795 character, the column will be exactly as wide as it needs to be in order
3796 to fully display all values.  The @samp{Approved} column does have a
3797 modified title (@samp{Approved?}, with a question mark).  Summaries will
3798 be created for the @samp{Time_Estimate} column by adding time duration
3799 expressions like HH:MM, and for the @samp{Approved} column, by providing
3800 an @samp{[X]} status if all children have been checked.  The
3801 @samp{CLOCKSUM} column is special, it lists the sum of CLOCK intervals
3802 in the subtree.
3804 @node Using column view, Capturing Column View, Defining columns, Column view
3805 @subsection Using Column View
3807 @table @kbd
3808 @tsubheading{Turning column view on and off}
3809 @kindex C-c C-x C-c
3810 @item C-c C-x C-c
3811 Create the column view for the local environment.  This command searches
3812 the hierarchy, up from point, for a @code{:COLUMNS:} property that defines
3813 a format.  When one is found, the column view table is established for
3814 the entire tree, starting from the entry that contains the @code{:COLUMNS:}
3815 property.  If none is found, the format is taken from the @code{#+COLUMNS}
3816 line or from the variable @code{org-columns-default-format}, and column
3817 view is established for the current entry and its subtree.
3818 @kindex r
3819 @item r
3820 Recreate the column view, to included hanges happening in the buffer.
3821 @kindex g
3822 @item g
3823 Same as @kbd{r}.
3824 @kindex q
3825 @item q
3826 Exit column view.
3827 @tsubheading{Editing values}
3828 @item @key{left} @key{right} @key{up} @key{down}
3829 Move through the column view from field to field.
3830 @kindex S-@key{left}
3831 @kindex S-@key{right}
3832 @item  S-@key{left}/@key{right}
3833 Switch to the next/previous allowed value of the field.  For this, you
3834 have to have specified allowed values for a property.
3835 @kindex n
3836 @kindex p
3837 @itemx  n / p
3838 Same as @kbd{S-@key{left}/@key{right}}
3839 @kindex e
3840 @item e
3841 Edit the property at point.  For the special properties, this will
3842 invoke the same interface that you normally use to change that
3843 property.  For example, when editing a TAGS property, the tag completion
3844 or fast selection interface will pop up.
3845 @kindex C-c C-c
3846 @item C-c C-c
3847 When there is a checkbox at point, toggle it.
3848 @kindex v
3849 @item v
3850 View the full value of this property.  This is useful if the width of
3851 the column is smaller than that of the value.
3852 @kindex a
3853 @item a
3854 Edit the list of allowed values for this property.  If the list is found
3855 in the hierarchy, the modified values is stored there.  If no list is
3856 found, the new value is stored in the first entry that is part of the
3857 current column view.
3858 @tsubheading{Modifying the table structure}
3859 @kindex <
3860 @kindex >
3861 @item < / >
3862 Make the column narrower/wider by one character.
3863 @kindex S-M-@key{right}
3864 @item S-M-@key{right}
3865 Insert a new column, to the right of the current column.
3866 @kindex S-M-@key{left}
3867 @item S-M-@key{left}
3868 Delete the current column.
3869 @end table
3871 @node Capturing Column View,  , Using column view, Column view
3872 @subsection Capturing Column View
3874 Since column view is just an overlay over a buffer, it cannot be
3875 exported or printed directly.  If you want to capture a column view, use
3876 ths @code{columnview} dynamic block (@pxref{Dynamic blocks}).  The frame
3877 of this block looks like this:
3879 @example
3880 * The column view
3881 #+BEGIN: columnview :hlines 1 :id "label"
3883 #+END:
3884 @end example
3886 @noindent This dynamic block has the following parameters:
3888 @table @code
3889 @item :id
3890 This is most important parameter.  Column view is a feature that is
3891 often localized to a certain (sub)tree, and the capture block might be
3892 in a different location in the file.  To identify the tree whose view to
3893 capture, you can use 3 values:
3894 @example
3895 local     @r{use the tree in which the capture block is located}
3896 global    @r{make a global view, including all headings in the file}
3897 "label"   @r{call column view in the tree that has and @code{:ID:}}
3898           @r{property with the value @i{label}}
3899 @end example
3900 @item :hlines
3901 When @code{t}, insert a hline after every line.  When a number N, insert
3902 a hline before each headline with level @code{<= N}.
3903 @item :vlines
3904 When set to @code{t}, enforce column groups to get vertical lines.
3905 @item :maxlevel
3906 When set to a number, don't capture entries below this level.
3907 @item :skip-empty-rows
3908 When set to @code{t}, skip row where the only non-empty specifier of the
3909 column view is @code{ITEM}.
3911 @end table
3913 @noindent
3914 The following commands insert or update the dynamic block:
3916 @table @kbd
3917 @kindex C-c C-x r
3918 @item C-c C-x r
3919 Insert a dynamic block capturing a column view.  You will be prompted
3920 for the scope or id of the view.
3921 @kindex C-c C-c
3922 @item C-c C-c
3923 @kindex C-c C-x C-u
3924 @itemx C-c C-x C-u
3925 Update dynamical block at point.  The cursor needs to be in the
3926 @code{#+BEGIN} line of the dynamic block.
3927 @kindex C-u C-c C-x C-u
3928 @item C-u C-c C-x C-u
3929 Update all dynamic blocks (@pxref{Dynamic blocks}).  This is useful if
3930 you have several clocktable blocks in a buffer.
3931 @end table
3933 @node Property API,  , Column view, Properties and columns
3934 @section The Property API
3935 @cindex properties, API
3936 @cindex API, for properties
3938 There is a full API for accessing and changing properties.  This API can
3939 be used by Emacs Lisp programs to work with properties and to implement
3940 features based on them.  For more information see @ref{Using the
3941 property API}.
3943 @node Dates and times, Remember, Properties and columns, Top
3944 @chapter Dates and Times
3945 @cindex dates
3946 @cindex times
3947 @cindex time stamps
3948 @cindex date stamps
3950 To assist project planning, TODO items can be labeled with a date and/or
3951 a time.  The specially formatted string carrying the date and time
3952 information is called a @emph{timestamp} in Org-mode.  This may be a
3953 little confusing because timestamp is often used as indicating when
3954 something was created or last changed.  However, in Org-mode this term
3955 is used in a much wider sense.
3957 @menu
3958 * Time stamps::                 Assigning a time to a tree entry
3959 * Creating timestamps::         Commands which insert timestamps
3960 * Deadlines and scheduling::    Planning your work
3961 * Clocking work time::
3962 @end menu
3965 @node Time stamps, Creating timestamps, Dates and times, Dates and times
3966 @section Time stamps, deadlines and scheduling
3967 @cindex time stamps
3968 @cindex ranges, time
3969 @cindex date stamps
3970 @cindex deadlines
3971 @cindex scheduling
3973 A time stamp is a specification of a date (possibly with time or a range
3974 of times) in a special format, either @samp{<2003-09-16 Tue>} or
3975 @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16 Tue
3976 12:00-12:30>}@footnote{This is the standard ISO date/time format.  To
3977 use an alternative format, see @ref{Custom time format}.}.  A time stamp
3978 can appear anywhere in the headline or body of an org-tree entry.  Its
3979 presence causes entries to be shown on specific dates in the agenda
3980 (@pxref{Weekly/Daily agenda}).  We distinguish:
3982 @table @var
3983 @item Plain time stamp; Event; Appointment
3984 @cindex timestamp
3985 A simple time stamp just assigns a date/time to an item.  This is just
3986 like writing down an appointment or event in a paper agenda.  In the
3987 timeline and agenda displays, the headline of an entry associated with a
3988 plain time stamp will be shown exactly on that date.
3990 @example
3991 * Meet Peter at the movies <2006-11-01 Wed 19:15>
3992 * Discussion on climate change <2006-11-02 Thu 20:00-22:00>
3993 @end example
3995 @item Time stamp with repeater interval
3996 @cindex timestamp, with repeater interval
3997 A time stamp may contain a @emph{repeater interval}, indicating that it
3998 applies not only on the given date, but again and again after a certain
3999 interval of N days (d), weeks (w), months(m), or years(y).  The
4000 following will show up in the agenda every Wednesday:
4002 @example
4003 * Pick up Sam at school <2007-05-16 Wed 12:30 +1w>
4004 @end example
4006 @item Diary-style sexp entries
4007 For more complex date specifications, Org-mode supports using the
4008 special sexp diary entries implemented in the Emacs calendar/diary
4009 package.  For example
4011 @example
4012 * The nerd meeting on every 2nd Thursday of the month
4013   <%%(diary-float t 4 2)>
4014 @end example
4016 @item Time/Date range
4017 @cindex timerange
4018 @cindex date range
4019 Two time stamps connected by @samp{--} denote a range.  The headline
4020 will be shown on the first and last day of the range, and on any dates
4021 that are displayed and fall in the range.  Here is an example:
4023 @example
4024 ** Meeting in Amsterdam
4025    <2004-08-23 Mon>--<2004-08-26 Thu>
4026 @end example
4028 @item Inactive time stamp
4029 @cindex timestamp, inactive
4030 @cindex inactive timestamp
4031 Just like a plain time stamp, but with square brackets instead of
4032 angular ones.  These time stamps are inactive in the sense that they do
4033 @emph{not} trigger an entry to show up in the agenda.
4035 @example
4036 * Gillian comes late for the fifth time [2006-11-01 Wed]
4037 @end example
4039 @end table
4041 @node Creating timestamps, Deadlines and scheduling, Time stamps, Dates and times
4042 @section Creating timestamps
4043 @cindex creating timestamps
4044 @cindex timestamps, creating
4046 For Org-mode to recognize time stamps, they need to be in the specific
4047 format.  All commands listed below produce time stamps in the correct
4048 format.
4050 @table @kbd
4051 @kindex C-c .
4052 @item C-c .
4053 Prompt for a date and insert a corresponding time stamp.  When the
4054 cursor is at a previously used time stamp, it is updated to NOW.  When
4055 this command is used twice in succession, a time range is inserted.
4057 @kindex C-u C-c .
4058 @item C-u C-c .
4059 Like @kbd{C-c .}, but use the alternative format which contains date
4060 and time.  The default time can be rounded to multiples of 5 minutes,
4061 see the option @code{org-time-stamp-rounding-minutes}.
4063 @kindex C-c !
4064 @item C-c !
4065 Like @kbd{C-c .}, but insert an inactive time stamp that will not cause
4066 an agenda entry.
4068 @kindex C-c <
4069 @item C-c <
4070 Insert a time stamp corresponding to the cursor date in the Calendar.
4072 @kindex C-c >
4073 @item C-c >
4074 Access the Emacs calendar for the current date.  If there is a
4075 timestamp in the current line, goto the corresponding date
4076 instead.
4078 @kindex C-c C-o
4079 @item C-c C-o
4080 Access the agenda for the date given by the time stamp or -range at
4081 point (@pxref{Weekly/Daily agenda}).
4083 @kindex S-@key{left}
4084 @kindex S-@key{right}
4085 @item S-@key{left}
4086 @itemx S-@key{right}
4087 Change date at cursor by one day.  These key bindings conflict with
4088 CUA-mode (@pxref{Conflicts}).
4090 @kindex S-@key{up}
4091 @kindex S-@key{down}
4092 @item S-@key{up}
4093 @itemx S-@key{down}
4094 Change the item under the cursor in a timestamp.  The cursor can be on a
4095 year, month, day, hour or minute.  Note that if the cursor is in a
4096 headline and not at a time stamp, these same keys modify the priority of
4097 an item.  (@pxref{Priorities}). The key bindings also conflict with
4098 CUA-mode (@pxref{Conflicts}).
4100 @kindex C-c C-y
4101 @cindex evaluate time range
4102 @item C-c C-y
4103 Evaluate a time range by computing the difference between start and
4104 end.  With prefix arg, insert result after the time range (in a table:
4105 into the following column).
4106 @end table
4109 @menu
4110 * The date/time prompt::        How org-mode helps you entering date and time
4111 * Custom time format::          Making dates look differently
4112 @end menu
4114 @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps
4115 @subsection The date/time prompt
4116 @cindex date, reading in minibuffer
4117 @cindex time, reading in minibuffer
4119 When Org-mode prompts for a date/time, the default is shown as an ISO
4120 date, and the prompt therefore seems to ask for an ISO date.  But it
4121 will in fact accept any string containing some date and/or time
4122 information, and it is really smart about interpreting your input.  You
4123 can, for example, use @kbd{C-y} to paste a (possibly multi-line) string
4124 copied from an email message.  Org-mode will find whatever information
4125 is in there and derive anything you have not specified from the
4126 @emph{default date and time}.  The default is usually the current date
4127 and time, but when modifying an existing time stamp, or when entering
4128 the second stamp of a range, it is taken from the stamp in the buffer.
4129 When filling in information, Org-mode assumes that most of the time you
4130 will want to enter a date in the future: If you omit the month/year and
4131 the given day/month is @i{before} today, it will assume that you mean a
4132 future date@footnote{See the variable
4133 @code{org-read-date-prefer-future}.}.
4135 For example, lets assume that today is @b{June 13, 2006}.  Here is how
4136 various inputs will be interpreted, the items filled in by Org-mode are
4137 in @b{bold}.
4139 @example
4140 3-2-5         --> 2003-02-05
4141 14            --> @b{2006}-@b{06}-14
4142 12            --> @b{2006}-@b{07}-12
4143 Fri           --> nearest Friday (defaultdate or later)
4144 sep 15        --> @b{2006}-11-15
4145 feb 15        --> @b{2007}-02-15
4146 sep 12 9      --> 2009-09-12
4147 12:45         --> @b{2006}-@b{06}-@b{13} 12:45
4148 22 sept 0:34  --> @b{2006}-09-22 0:34
4149 @end example
4151 Furthermore you can specify a relative date by giving, as the
4152 @emph{first} thing in the input: a plus/minus sign, a number and a
4153 letter [dwmy] to indicate change in days weeks, months, years.  With a
4154 single plus or minus, the date is always relative to today.  With a
4155 double plus or minus, it is relative to the default date.  If instead of
4156 a single letter, you use the abbreviation of day name, the date will be
4157 the nth such day.  E.g.
4159 @example
4160 +4d           --> four days from today
4161 +4            --> same as above
4162 +2w           --> two weeks from today
4163 ++5           --> five days from default date
4164 +2tue         --> second tuesday from now.
4165 @end example
4167 The function understands English month and weekday abbreviations.  If
4168 you want to use unabbreviated names and/or other languages, configure
4169 the variables @code{parse-time-months} and @code{parse-time-weekdays}.
4171 @cindex calendar, for selecting date
4172 Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
4173 you don't need/want the calendar, configure the variable
4174 @code{org-popup-calendar-for-date-prompt}.}.  When you exit the date
4175 prompt, either by clicking on a date in the calendar, or by pressing
4176 @key{RET}, the date selected in the calendar will be combined with the
4177 information entered at the prompt.  You can control the calendar fully
4178 from the minibuffer:
4180 @kindex <
4181 @kindex >
4182 @kindex mouse-1
4183 @kindex S-@key{right}
4184 @kindex S-@key{left}
4185 @kindex S-@key{down}
4186 @kindex S-@key{up}
4187 @kindex M-S-@key{right}
4188 @kindex M-S-@key{left}
4189 @kindex @key{RET}
4190 @example
4191 > / <          @r{Scroll calendar forward/backward by one month.}
4192 mouse-1        @r{Select date by clicking on it.}
4193 S-@key{right}/@key{left}     @r{One day forward/backward.}
4194 S-@key{down}/@key{up}     @r{One week forward/backward.}
4195 M-S-@key{right}/@key{left}   @r{One month forward/backward.}
4196 @key{RET}           @r{Choose date in calendar.}
4197 @end example
4199 The actions of the date/time prompt may seem complex, but I asure you
4200 they will grow on you.  To help you understand what is going on, the
4201 current interpretation of your input will be displayed live in the
4202 minibuffer@footnote{If you find this distracting, turn the display of
4203 with @code{org-read-date-display-live}.}.
4205 @node Custom time format,  , The date/time prompt, Creating timestamps
4206 @subsection Custom time format
4207 @cindex custom date/time format
4208 @cindex time format, custom
4209 @cindex date format, custom
4211 Org-mode uses the standard ISO notation for dates and times as it is
4212 defined in ISO 8601.  If you cannot get used to this and require another
4213 representation of date and time to keep you happy, you can get it by
4214 customizing the variables @code{org-display-custom-times} and
4215 @code{org-time-stamp-custom-formats}.
4217 @table @kbd
4218 @kindex C-c C-x C-t
4219 @item C-c C-x C-t
4220 Toggle the display of custom formats for dates and times.
4221 @end table
4223 @noindent
4224 Org-mode needs the default format for scanning, so the custom date/time
4225 format does not @emph{replace} the default format - instead it is put
4226 @emph{over} the default format using text properties.  This has the
4227 following consequences:
4228 @itemize @bullet
4229 @item
4230 You cannot place the cursor onto a time stamp anymore, only before or
4231 after.
4232 @item
4233 The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
4234 each component of a time stamp.  If the cursor is at the beginning of
4235 the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
4236 just like @kbd{S-@key{left}/@key{right}}.  At the end of the stamp, the
4237 time will be changed by one minute.
4238 @item
4239 If the time stamp contains a range of clock times or a repeater, these
4240 will not be overlayed, but remain in the buffer as they were.
4241 @item
4242 When you delete a time stamp character-by-character, it will only
4243 disappear from the buffer after @emph{all} (invisible) characters
4244 belonging to the ISO timestamp have been removed.
4245 @item
4246 If the custom time stamp format is longer than the default and you are
4247 using dates in tables, table alignment will be messed up.  If the custom
4248 format is shorter, things do work as expected.
4249 @end itemize
4252 @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and times
4253 @section Deadlines and Scheduling
4255 A time stamp may be preceded by special keywords to facilitate planning:
4257 @table @var
4258 @item DEADLINE
4259 @cindex DEADLINE keyword
4261 Meaning: the task (most likely a TODO item, though not necessarily) is supposed
4262 to be finished on that date.
4264 On the deadline date, the task will be listed in the agenda.  In
4265 addition, the agenda for @emph{today} will carry a warning about the
4266 approaching or missed deadline, starting
4267 @code{org-deadline-warning-days} before the due date, and continuing
4268 until the entry is marked DONE.  An example:
4270 @example
4271 *** TODO write article about the Earth for the Guide
4272     The editor in charge is [[bbdb:Ford Prefect]]
4273     DEADLINE: <2004-02-29 Sun>
4274 @end example
4276 You can specify a different lead time for warnings for a specific
4277 deadlines using the following syntax.  Here is an example with a warning
4278 period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}.
4280 @item SCHEDULED
4281 @cindex SCHEDULED keyword
4283 Meaning: you are planning to start working on that task on the given
4284 date.
4286 The headline will be listed under the given date@footnote{It will still
4287 be listed on that date after it has been marked DONE.  If you don't like
4288 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}.  In
4289 addition, a reminder that the scheduled date has passed will be present
4290 in the compilation for @emph{today}, until the entry is marked DONE.
4291 I.e., the task will automatically be forwarded until completed.
4293 @example
4294 *** TODO Call Trillian for a date on New Years Eve.
4295     SCHEDULED: <2004-12-25 Sat>
4296 @end example
4298 @noindent
4299 @b{Important:} Scheduling an item in Org-mode should @i{not} be
4300 understood in the same way that we understand @i{scheduling a meeting}.
4301 Setting a date for a meeting is just a simple appointment, you should
4302 mark this entry with a simple plain time stamp, to get this item shown
4303 on the date where it applies.  This is a frequent mis-understanding from
4304 Org-users.  In Org-mode, @i{scheduling} means setting a date when you
4305 want to start working on an action item.
4306 @end table
4308 You may use time stamps with repeaters in scheduling and deadline
4309 entries.  Org-mode will issue early and late warnings based on the
4310 assumption that the time stamp represents the @i{nearest instance} of
4311 the repeater.  However, the use of diary sexp entries like
4313 @code{<%%(diary-float t 42)>}
4315 in scheduling and deadline timestamps is limited.  Org-mode does not
4316 know enough about the internals of each sexp function to issue early and
4317 late warnings.  However, it will show the item on each day where the
4318 sexp entry matches.
4320 @menu
4321 * Inserting deadline/schedule::  Planning items
4322 * Repeated tasks::              Items that show up again and again
4323 @end menu
4325 @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling
4326 @subsection Inserting deadline/schedule
4328 The following commands allow to quickly insert a deadline or to schedule
4329 an item:
4331 @table @kbd
4333 @kindex C-c C-d
4334 @item C-c C-d
4335 Insert @samp{DEADLINE} keyword along with a stamp.  The insertion will
4336 happen in the line directly following the headline.  When called with a
4337 prefix arg, an existing deadline will be removed from the entry.
4338 @c FIXME Any CLOSED timestamp will be removed.????????
4340 @kindex C-c / d
4341 @cindex sparse tree, for deadlines
4342 @item C-c / d
4343 Create a sparse tree with all deadlines that are either past-due, or
4344 which will become due within @code{org-deadline-warning-days}.
4345 With @kbd{C-u} prefix, show all deadlines in the file.  With a numeric
4346 prefix, check that many days.  For example, @kbd{C-1 C-c / d} shows
4347 all deadlines due tomorrow.
4349 @kindex C-c C-s
4350 @item C-c C-s
4351 Insert @samp{SCHEDULED} keyword along with a stamp.  The insertion will
4352 happen in the line directly following the headline.  Any CLOSED
4353 timestamp will be removed.  When called with a prefix argument, remove
4354 the scheduling date from the entry.
4355 @end table
4357 @node Repeated tasks,  , Inserting deadline/schedule, Deadlines and scheduling
4358 @subsection Repeated Tasks
4360 Some tasks need to be repeated again and again.  Org-mode helps to
4361 organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
4362 or plain time stamp.  In the following example
4363 @example
4364 ** TODO Pay the rent
4365    DEADLINE: <2005-10-01 Sat +1m>
4366 @end example
4367 the @code{+1m} is a repeater; the intended interpretation is that the
4368 task has a deadline on <2005-10-01> and repeats itself every (one) month
4369 starting from that time.  If you need both a repeater and a special
4370 warning period in a deadline entry, the repeater comes first and the
4371 warning period last: @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
4373 Deadlines and scheduled items produce entries in the agenda when they
4374 are over-due, so it is important to be able to mark such an entry as
4375 completed once you have done so.  When you mark a DEADLINE or a SCHEDULE
4376 with the todo keyword DONE, it will no longer produce entries in the
4377 agenda.  The problem with this is, however, that then also the
4378 @emph{next} instance of the repeated entry will not be active.  Org-mode
4379 deals with this in the following way: When you try to mark such an entry
4380 DONE (using @kbd{C-c C-t}), it will shift the base date of the repeating
4381 time stamp by the repeater interval, and immediately set the entry state
4382 back to TODO.  In the example above, setting the state to DONE would
4383 actually switch the date like this:
4385 @example
4386 ** TODO Pay the rent
4387    DEADLINE: <2005-11-01 Tue +1m>
4388 @end example
4390 You will also be prompted for a note@footnote{You can change this using
4391 the option @code{org-log-repeat}, or the @code{#+STARTUP} options
4392 @code{logrepeat}, @code{lognoterepeat}, and @code{nologrepeat}.} that
4393 will be put under the DEADLINE line to keep a record that you actually
4394 acted on the previous instance of this deadline.
4396 As a consequence of shifting the base date, this entry will no longer be
4397 visible in the agenda when checking past dates, but all future instances
4398 will be visible.
4400 With the @samp{+1m} cookie, the date shift will always be exactly one
4401 month.  So if you have not payed the rent for three months, marking this
4402 entry DONE will still keep it as an overdue deadline.  Depending on the
4403 task, this may not be the best way to handle it.  For example, if you
4404 forgot to call you father for 3 weeks, it does not make sense to call
4405 her 3 times in a single day to make up for it.  Finally, there are tasks
4406 like changing batteries which should always repeat a certain time
4407 @i{after} the last time you did it.  For these tasks, Org-mode has
4408 special repeaters markes with @samp{++} and @samp{.+}.  For example:
4410 @example
4411 ** TODO Call Father
4412    DEADLINE: <2008-02-10 Sun ++1w>
4413    Marking this DONE will shift the date by at least one week,
4414    but also by as many weeks as it takes to get this date into
4415    the future.  However, it stays on a Sunday, even if you called
4416    and marked it done on Saturday.
4417 ** TODO Check the batteries in the smoke detectors
4418    DEADLINE: <2005-11-01 Tue .+1m>
4419    Marking this DONE will shift the date to one month after
4420    today.
4421 @end example
4423 You may have both scheduling and deadline information for a specific
4424 task - just make sure that the repeater intervals on both are the same.
4426 @node Clocking work time,  , Deadlines and scheduling, Dates and times
4427 @section Clocking work time
4429 Org-mode allows you to clock the time you spent on specific tasks in a
4430 project.  When you start working on an item, you can start the clock.
4431 When you stop working on that task, or when you mark the task done, the
4432 clock is stopped and the corresponding time interval is recorded.  It
4433 also computes the total time spent on each subtree of a project.
4435 @table @kbd
4436 @kindex C-c C-x C-i
4437 @item C-c C-x C-i
4438 Start the clock on the current item (clock-in).  This inserts the CLOCK
4439 keyword together with a timestamp.  If this is not the first clocking of
4440 this item, the multiple CLOCK lines will be wrapped into a
4441 @code{:CLOCK:} drawer (see also the variable
4442 @code{org-clock-into-drawer}).
4443 @kindex C-c C-x C-o
4444 @item C-c C-x C-o
4445 Stop the clock (clock-out).  The inserts another timestamp at the same
4446 location where the clock was last started.  It also directly computes
4447 the resulting time in inserts it after the time range as @samp{=>
4448 HH:MM}.  See the variable @code{org-log-note-clock-out} for the
4449 possibility to record an additional note together with the clock-out
4450 time stamp@footnote{The corresponding in-buffer setting is:
4451 @code{#+STARTUP: lognoteclock-out}}.
4452 @kindex C-c C-y
4453 @item C-c C-y
4454 Recompute the time interval after changing one of the time stamps.  This
4455 is only necessary if you edit the time stamps directly.  If you change
4456 them with @kbd{S-@key{cursor}} keys, the update is automatic.
4457 @kindex C-c C-t
4458 @item C-c C-t
4459 Changing the TODO state of an item to DONE automatically stops the clock
4460 if it is running in this same item.
4461 @kindex C-c C-x C-x
4462 @item C-c C-x C-x
4463 Cancel the current clock.  This is useful if a clock was started by
4464 mistake, or if you ended up working on something else.
4465 @kindex C-c C-x C-j
4466 @item C-c C-x C-j
4467 Jump to the entry that contains the currently running clock, an another
4468 window.
4469 @kindex C-c C-x C-d
4470 @item C-c C-x C-d
4471 Display time summaries for each subtree in the current buffer.  This
4472 puts overlays at the end of each headline, showing the total time
4473 recorded under that heading, including the time of any subheadings. You
4474 can use visibility cycling to study the tree, but the overlays disappear
4475 when you change the buffer (see variable
4476 @code{org-remove-highlights-with-change}) or press @kbd{C-c C-c}.
4477 @kindex C-c C-x C-r
4478 @item C-c C-x C-r
4479 Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
4480 report as an org-mode table into the current file.  When the cursor is
4481 at an existing clock table, just update it.  When called with a prefix
4482 argument, jump to the first clock report in the current document and
4483 update it.
4484 @example
4485 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
4487 #+END: clocktable
4488 @end example
4489 @noindent
4490 If such a block already exists at point, its content is replaced by the
4491 new table.  The @samp{BEGIN} line can specify options:
4492 @example
4493 :maxlevel    @r{Maximum level depth to which times are listed in the table.}
4494 :emphasize   @r{When @code{t}, emphasize level one and level two items}
4495 :scope       @r{The scope to consider.  This can be any of the following:}
4496              nil        @r{the current buffer or narrowed region}
4497              file       @r{the full current buffer}
4498              subtree    @r{the subtree where the clocktable is located}
4499              treeN      @r{the surrounding level N tree, for example @code{tree3}}
4500              tree       @r{the surrounding level 1 tree}
4501              agenda     @r{all agenda files}
4502              ("file"..) @r{scan these files}
4503 :block       @r{The time block to consider.  This block is specified relative}
4504              @r{to the current time and may be any of these keywords:}
4505              @r{@code{today}, @code{yesterday}, @code{thisweek}, @code{lastweek},}
4506              @r{@code{thismonth}, @code{lastmonth}, @code{thisyear}, or @code{lastyear}}.
4507 :tstart      @r{A time string specifying when to start considering times}
4508 :tend        @r{A time string specifying when to stop considering times}
4509 :step        @r{@code{week} or @code{day}, to split the table into chunks}
4510 :link        @r{Link the item headlines in the table to their origins}
4511 @end example
4512 So to get a clock summary of the current level 1 tree, for the current
4513 day, you could write
4514 @example
4515 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1
4517 #+END: clocktable
4518 @end example
4519 and to use a specific time range you could write@footnote{Note that all
4520 parameters must be specified in a single line - the line is broken here
4521 only to fit it onto the manual.}
4522 @example
4523 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
4524                     :tend "<2006-08-10 Thu 12:00>"
4526 #+END: clocktable
4527 @end example
4528 @kindex C-c C-c
4529 @item C-c C-c
4530 @kindex C-c C-x C-u
4531 @itemx C-c C-x C-u
4532 Update dynamical block at point.  The cursor needs to be in the
4533 @code{#+BEGIN} line of the dynamic block.
4534 @kindex C-u C-c C-x C-u
4535 @item C-u C-c C-x C-u
4536 Update all dynamic blocks (@pxref{Dynamic blocks}).  This is useful if
4537 you have several clocktable blocks in a buffer.
4538 @end table
4540 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
4541 the agenda (@pxref{Weekly/Daily agenda}) to show which tasks have been
4542 worked on or closed during a day.
4544 @node Remember, Agenda views, Dates and times, Top
4545 @chapter Remember
4546 @cindex @file{remember.el}
4548 The @i{Remember} package by John Wiegley lets you store quick notes with
4549 little interruption of your work flow.  See
4550 @uref{http://www.emacswiki.org/cgi-bin/wiki/RememberMode} for more
4551 information.  It is an excellent way to add new notes and tasks to
4552 Org-mode files.  Org-mode significantly expands the possibilities of
4553 @i{remember}: You may define templates for different note types, and
4554 associate target files and headlines with specific templates.  It also
4555 allows you to select the location where a note should be stored
4556 interactively, on the fly.
4558 @menu
4559 * Setting up remember::         Some code for .emacs to get things going
4560 * Remember templates::          Define the outline of different note types
4561 * Storing notes::               Directly get the note to where it belongs
4562 * Refiling notes::              Moving a note or task to a project
4563 @end menu
4565 @node Setting up remember, Remember templates, Remember, Remember
4566 @section Setting up remember
4568 The following customization will tell @i{remember} to use org files as
4569 target, and to create annotations compatible with Org-mode links.
4571 @example
4572 (org-remember-insinuate)
4573 (setq org-directory "~/path/to/my/orgfiles/")
4574 (setq org-default-notes-file (concat org-directory "/notes.org"))
4575 (define-key global-map "\C-cr" 'org-remember)
4576 @end example
4578 The last line binds the command @code{org-remember} to a global
4579 key@footnote{Please select your own key, @kbd{C-c r} is only a
4580 suggestion.}.  @code{org-remember} basically just calls @code{remember},
4581 but it makes a few things easier: If there is an active region, it will
4582 automatically copy the region into the remember buffer.  It also allows
4583 to jump to the buffer and location where remember notes are being
4584 stored: Just call @code{org-remember} with a prefix argument.  If you
4585 use two prefix arguments, Org-mode jumps to the location where the last
4586 remember note was stored.
4588 @node Remember templates, Storing notes, Setting up remember, Remember
4589 @section Remember templates
4590 @cindex templates, for remember
4592 In combination with Org-mode, you can use templates to generate
4593 different types of @i{remember} notes.  For example, if you would like
4594 to use one template to create general TODO entries, another one for
4595 journal entries, and a third one for collecting random ideas, you could
4596 use:
4598 @example
4599 (setq org-remember-templates
4600  '(("Todo" ?t "* TODO %?\n  %i\n  %a" "~/org/TODO.org" "Tasks")
4601    ("Journal" ?j "* %U %?\n\n  %i\n  %a" "~/org/JOURNAL.org")
4602    ("Idea" ?i "* %^@{Title@}\n  %i\n  %a" "~/org/JOURNAL.org" "New Ideas")))
4603 @end example
4605 @noindent In these entries, the first string is just a name, and the
4606 character specifies how to select the template.  It is useful if the
4607 character is also the first letter of the name.  The next string
4608 specifies the template.  Two more (optional) strings give the file in
4609 which, and the headline under which the new note should be stored.  The
4610 file (if not present or @code{nil}) defaults to
4611 @code{org-default-notes-file}, the heading to
4612 @code{org-remember-default-headline}.
4614 An optional sixth element specifies the contexts in which the user can
4615 select the template.  This element can be either a list of major modes
4616 or a function.  @code{org-remember} will first check whether the function
4617 returns @code{t} or if we are in any of the listed major mode, and select 
4618 the template accordingly.
4620 So for example:
4622 @example
4623 (setq org-remember-templates
4624  '(("Bug" ?b "* BUG %?\n  %i\n  %a" "~/org/BUGS.org" "Bugs" (emacs-lisp-mode))
4625    ("Journal" ?j "* %U %?\n\n  %i\n  %a" "~/org/JOURNAL.org" my-check)
4626    ("Idea" ?i "* %^@{Title@}\n  %i\n  %a" "~/org/JOURNAL.org" "New Ideas")))
4627 @end example
4629 The first template will only be available when invoking @code{org-remember}
4630 from an buffer in @code{emacs-lisp-mode}.  The second template will only be
4631 available when the function @code{my-check} returns @code{t}.  The third
4632 template will be proposed in any context.
4634 When you call @kbd{M-x remember} (or @kbd{M-x org-remember}) to remember
4635 something, org will prompt for a key to select the template (if you have
4636 more than one template) and then prepare the buffer like
4637 @example
4638 * TODO
4639   [[file:link to where you called remember]]
4640 @end example
4642 @noindent
4643 During expansion of the template, special @kbd{%}-escapes allow dynamic
4644 insertion of content:
4645 @example
4646 %^@{prompt@}  @r{prompt the user for a string and replace this sequence with it.}
4647             @r{You may specify a default value and a completion table with}
4648             @r{%^@{prompt|default|completion2|completion3...@}}
4649             @r{The arrow keys access a prompt-specific history.}
4650 %t          @r{time stamp, date only}
4651 %T          @r{time stamp with date and time}
4652 %u, %U      @r{like the above, but inactive time stamps}
4653 %^t         @r{like @code{%t}, but prompt for date.  Similarly @code{%^T}, @code{%^u}, @code{%^U}}
4654             @r{You may define a prompt like @code{%^@{Birthday@}t}}
4655 %n          @r{user name (taken from @code{user-full-name})}
4656 %a          @r{annotation, normally the link created with @code{org-store-link}}
4657 %A          @r{like @code{%a}, but prompt for the description part}
4658 %i          @r{initial content, the region when remember is called with C-u.}
4659             @r{The entire text will be indented like @code{%i} itself.}
4660 %c          @r{Content of the clipboard, or current kill ring head.}
4661 %^g         @r{prompt for tags, with completion on tags in target file.}
4662 %^G         @r{prompt for tags, with completion all tags in all agenda files.}
4663 %:keyword   @r{specific information for certain link types, see below}
4664 %[pathname] @r{insert the contents of the file given by @code{pathname}}
4665 %(sexp)     @r{evaluate elisp @code{(sexp)} and replace with the result}
4666 %!          @r{immediately store note after completing the template}
4667             @r{(skipping the @kbd{C-c C-c} that normally triggers storing)}
4668 @end example
4670 @noindent
4671 For specific link types, the following keywords will be
4672 defined@footnote{If you define your own link types (@pxref{Adding
4673 hyperlink types}), any property you store with
4674 @code{org-store-link-props} can be accessed in remember templates in a
4675 similar way.}:
4677 @example
4678 Link type          |  Available keywords
4679 -------------------+----------------------------------------------
4680 bbdb               |  %:name %:company
4681 bbdb               |  %::server %:port %:nick
4682 vm, wl, mh, rmail  |  %:type %:subject %:message-id
4683                    |  %:from %:fromname %:fromaddress
4684                    |  %:to   %:toname   %:toaddress
4685                    |  %: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}.}}
4686 gnus               |  %:group, @r{for messages also all email fields}
4687 w3, w3m            |  %:url
4688 info               |  %:file %:node
4689 calendar           |  %:date"
4690 @end example
4692 @noindent
4693 To place the cursor after template expansion use:
4695 @example
4696 %?          @r{After completing the template, position cursor here.}
4697 @end example
4699 @noindent
4700 If you change your mind about which template to use, call
4701 @code{org-remember} in the remember buffer.  You may then select a new
4702 template that will be filled with the previous context information.
4704 @node Storing notes, Refiling notes, Remember templates, Remember
4705 @section Storing notes
4707 When you are finished preparing a note with @i{remember}, you have to
4708 press @kbd{C-c C-c} to file the note away.  The handler will store the
4709 note in the file and under the headline specified in the template, or it
4710 will use the default file and headlines.  The window configuration will
4711 be restored, sending you back to the working context before the call to
4712 @code{remember}.  To re-use the location found during the last call to
4713 @code{remember}, exit the remember buffer with @kbd{C-u C-u C-c C-c},
4714 i.e. specify a double prefix argument to @kbd{C-c C-c}.
4716 If you want to store the note directly to a different place, use
4717 @kbd{C-u C-c C-c} instead to exit remember@footnote{Configure the
4718 variable @code{org-remember-store-without-prompt} to make this behavior
4719 the default.}.  The handler will then first prompt for a target file -
4720 if you press @key{RET}, the value specified for the template is used.
4721 Then the command offers the headings tree of the selected file, with the
4722 cursor position at the default headline (if you had specified one in the
4723 template).  You can either immediately press @key{RET} to get the note
4724 placed there.  Or you can use the following keys to find a different
4725 location:
4726 @example
4727 @key{TAB}         @r{Cycle visibility.}
4728 @key{down} / @key{up}   @r{Next/previous visible headline.}
4729 n / p        @r{Next/previous visible headline.}
4730 f / b        @r{Next/previous headline same level.}
4731 u            @r{One level up.}
4732 @c 0-9          @r{Digit argument.}
4733 @end example
4734 @noindent
4735 Pressing @key{RET} or @key{left} or @key{right}
4736 then leads to the following result.
4738 @multitable @columnfractions 0.2 0.15 0.65
4739 @item @b{Cursor position} @tab @b{Key} @tab @b{Note gets inserted}
4740 @item on headline     @tab @key{RET}              @tab as sublevel of the heading at cursor, first or last
4741 @item                 @tab                        @tab depending on @code{org-reverse-note-order}.
4742 @item                 @tab @key{left}/@key{right} @tab as same level, before/after current heading
4743 @item buffer-start    @tab @key{RET} @tab as level 2 heading at end of file or level 1 at beginning
4744 @item                 @tab @tab depending on @code{org-reverse-note-order}.
4745 @item not on headline @tab @key{RET}
4746       @tab at cursor position, level taken from context.
4747 @end multitable
4749 Before inserting the text into a tree, the function ensures that the
4750 text has a headline, i.e. a first line that starts with a @samp{*}.  If
4751 not, a headline is constructed from the current date and some additional
4752 data.  If you have indented the text of the note below the headline, the
4753 indentation will be adapted if inserting the note into the tree requires
4754 demotion from level 1.
4756 @node Refiling notes,  , Storing notes, Remember
4757 @section Refiling notes
4758 @cindex refiling notes
4760 Remember is usually used to quickly capture notes and tasks into one or
4761 a few capture lists.  When reviewing the captured data, you may want to
4762 refile some of the entries into a different list, for example into a
4763 project.  Cutting, finding the right location and then pasting the note
4764 is cumbersome.  To simplify this process, you can use the following
4765 special command:
4767 @table @kbd
4768 @kindex C-c C-w
4769 @item C-c C-w
4770 Refile the entry at point.  This command offers possible locations for
4771 refiling the entry and lets you select one with completion.  The item is
4772 filed below the target heading as a subitem.  Depending on
4773 @code{org-reverse-note-order}, it will be either the first of last
4774 subitem.@* By default, all level 1 headlines in the current buffer are
4775 considered to be targets, but you can have more complex definitions
4776 across a number of files.  See the variable @code{org-refile-targets}
4777 for details.
4778 @kindex C-u C-c C-w
4779 @item C-u C-c C-w
4780 Use the refile interface to jump to a heading.
4781 @kindex C-u C-u C-c C-w
4782 @item C- C-u C-c C-w
4783 Jump to the location where @code{org-refile} last moved a tree to.
4784 @end table
4786 @node Agenda views, Embedded LaTeX, Remember, Top
4787 @chapter Agenda Views
4788 @cindex agenda views
4790 Due to the way Org-mode works, TODO items, time-stamped items, and
4791 tagged headlines can be scattered throughout a file or even a number of
4792 files.  To get an overview of open action items, or of events that are
4793 important for a particular date, this information must be collected,
4794 sorted and displayed in an organized way.
4796 Org-mode can select items based on various criteria, and display them
4797 in a separate buffer.  Seven different view types are provided:
4799 @itemize @bullet
4800 @item
4801 an @emph{agenda} that is like a calendar and shows information
4802 for specific dates,
4803 @item
4804 a @emph{TODO list} that covers all unfinished
4805 action items,
4806 @item
4807 a @emph{tags view}, showings headlines based on
4808 the tags associated with them,
4809 @item
4810 a @emph{timeline view} that shows all events in a single Org-mode file,
4811 in time-sorted view,
4812 @item
4813 a @emph{keyword search view} that shows all entries from multiple files
4814 that contain specified keywords.
4815 @item
4816 a @emph{stuck projects view} showing projects that currently don't move
4817 along, and
4818 @item
4819 @emph{custom views} that are special tag/keyword searches and
4820 combinations of different views.
4821 @end itemize
4823 @noindent
4824 The extracted information is displayed in a special @emph{agenda
4825 buffer}.  This buffer is read-only, but provides commands to visit the
4826 corresponding locations in the original Org-mode files, and even to
4827 edit these files remotely.
4829 Two variables control how the agenda buffer is displayed and whether the
4830 window configuration is restored when the agenda exits:
4831 @code{org-agenda-window-setup} and
4832 @code{org-agenda-restore-windows-after-quit}.
4834 @menu
4835 * Agenda files::                Files being searched for agenda information
4836 * Agenda dispatcher::           Keyboard access to agenda views
4837 * Built-in agenda views::       What is available out of the box?
4838 * Presentation and sorting::    How agenda items are prepared for display
4839 * Agenda commands::             Remote editing of org trees
4840 * Custom agenda views::         Defining special searches and views
4841 @end menu
4843 @node Agenda files, Agenda dispatcher, Agenda views, Agenda views
4844 @section Agenda files
4845 @cindex agenda files
4846 @cindex files for agenda
4848 The information to be shown is normally collected from all @emph{agenda
4849 files}, the files listed in the variable
4850 @code{org-agenda-files}@footnote{If the value of that variable is not a
4851 list, but a single file name, then the list of agenda files will be
4852 maintained in that external file.}. If a directory is part of this list,
4853 all files with the extension @file{.org} in this directory will be part
4854 of the list.
4856 Thus even if you only work with a single Org-mode file, this file should
4857 be put into that list@footnote{When using the dispatcher, pressing
4858 @kbd{<} before selecting a command will actually limit the command to
4859 the current file, and ignore @code{org-agenda-files} until the next
4860 dispatcher command.}.  You can customize @code{org-agenda-files}, but
4861 the easiest way to maintain it is through the following commands
4863 @cindex files, adding to agenda list
4864 @table @kbd
4865 @kindex C-c [
4866 @item C-c [
4867 Add current file to the list of agenda files.  The file is added to
4868 the front of the list.  If it was already in the list, it is moved to
4869 the front.  With prefix arg, file is added/moved to the end.
4870 @kindex C-c ]
4871 @item C-c ]
4872 Remove current file from the list of agenda files.
4873 @kindex C-,
4874 @kindex C-'
4875 @item C-,
4876 @itemx C-'
4877 Cycle through agenda file list, visiting one file after the other.
4878 @end table
4880 @noindent
4881 The Org menu contains the current list of files and can be used
4882 to visit any of them.
4884 If you would like to focus the agenda temporarily onto a file not in
4885 this list, or onto just one file in the list or even only a subtree in a
4886 file, this can be done in different ways.  For a single agenda command,
4887 you may press @kbd{<} once or several times in the dispatcher
4888 (@pxref{Agenda dispatcher}).  To restrict the agenda scope for an
4889 extended period, use the following commands:
4891 @table @kbd
4892 @kindex C-c C-x <
4893 @item C-c C-x <
4894 Permanently restrict the agenda to the current subtree.  When with a
4895 prefix argument, or with the cursor before the first headline in a file,
4896 the agenda scope is set to the entire file.  This restriction remains in
4897 effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
4898 or @kbd{>} in the agenda dispatcher.  If there is a window displaying an
4899 agenda view, the new restriction takes effect immediately.
4900 @kindex C-c C-x <
4901 @item C-c C-x <
4902 Remove the permanent restriction created by @kbd{C-c C-x <}.
4903 @end table
4905 @noindent
4906 When working with @file{Speedbar}, you can use the following commands in
4907 the speedbar frame:
4908 @table @kbd
4909 @kindex <
4910 @item < @r{in the speedbar frame}
4911 Permanently restrict the agenda to the item at the cursor in the
4912 speedbar frame, either an Org-mode file or a subtree in such a file.
4913 If there is a window displaying an agenda view, the new restriction takes
4914 effect immediately.
4915 @kindex <
4916 @item > @r{in the speedbar frame}
4917 Lift the restriction again.
4918 @end table
4920 @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda views
4921 @section The agenda dispatcher
4922 @cindex agenda dispatcher
4923 @cindex dispatching agenda commands
4924 The views are created through a dispatcher that should be bound to a
4925 global key, for example @kbd{C-c a} (@pxref{Installation}).  In the
4926 following we will assume that @kbd{C-c a} is indeed how the dispatcher
4927 is accessed and list keyboard access to commands accordingly.  After
4928 pressing @kbd{C-c a}, an additional letter is required to execute a
4929 command.  The dispatcher offers the following default commands:
4930 @table @kbd
4931 @item a
4932 Create the calendar-like agenda (@pxref{Weekly/Daily agenda}).
4933 @item t @r{/} T
4934 Create a list of all TODO items (@pxref{Global TODO list}).
4935 @item m @r{/} M
4936 Create a list of headlines matching a TAGS expression (@pxref{Matching
4937 tags and properties}).
4938 @item L
4939 Create the timeline view for the current buffer (@pxref{Timeline}).
4940 @item s
4941 Create a list of entries selected by a boolean expression of keywords
4942 and/or regular expressions that must or must not occur in the entry.
4943 @item /
4944 Search for a regular expression in all agenda files and additionally in
4945 the files listed in @code{org-agenda-multi-occur-extra-files}.  This
4946 uses the Emacs command @code{multi-occur}.  A prefix argument can be
4947 used to specify the number of context lines for each match, default is
4949 @item # @r{/} !
4950 Create a list of stuck projects (@pxref{Stuck projects}).
4951 @item <
4952 Restrict an agenda command to the current buffer@footnote{For backward
4953 compatibility, you can also press @kbd{1} to restrict to the current
4954 buffer.}.  After pressing @kbd{<}, you still need to press the character
4955 selecting the command.
4956 @item < <
4957 If there is an active region, restrict the following agenda command to
4958 the region.  Otherwise, restrict it to the current subtree@footnote{For
4959 backward compatibility, you can also press @kbd{0} to restrict to the
4960 current buffer.}.  After pressing @kbd{< <}, you still need to press the
4961 character selecting the command.
4962 @end table
4964 You can also define custom commands that will be accessible through the
4965 dispatcher, just like the default commands.  This includes the
4966 possibility to create extended agenda buffers that contain several
4967 blocks together, for example the weekly agenda, the global TODO list and
4968 a number of special tags matches.  @xref{Custom agenda views}.
4970 @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda views
4971 @section The built-in agenda views
4973 In this section we describe the built-in views.
4975 @menu
4976 * Weekly/Daily agenda::         The calendar page with current tasks
4977 * Global TODO list::            All unfinished action items
4978 * Matching tags and properties::  Structured information with fine-tuned search
4979 * Timeline::                    Time-sorted view for single file
4980 * Keyword search::              Finding entries by keyword
4981 * Stuck projects::              Find projects you need to review
4982 @end menu
4984 @node Weekly/Daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views
4985 @subsection The weekly/daily agenda
4986 @cindex agenda
4987 @cindex weekly agenda
4988 @cindex daily agenda
4990 The purpose of the weekly/daily @emph{agenda} is to act like a page of a
4991 paper agenda, showing all the tasks for the current week or day.
4993 @table @kbd
4994 @cindex org-agenda, command
4995 @kindex C-c a a
4996 @item C-c a a
4997 Compile an agenda for the current week from a list of org files.  The
4998 agenda shows the entries for each day.  With a numeric
4999 prefix@footnote{For backward compatibility, the universal prefix
5000 @kbd{C-u} causes all TODO entries to be listed before the agenda.  This
5001 feature is deprecated, use the dedicated TODO list, or a block agenda
5002 instead.}  (like @kbd{C-u 2 1 C-c a a}) you may set the number of days
5003 to be displayed (see also the variable @code{org-agenda-ndays})
5004 @end table
5006 Remote editing from the agenda buffer means, for example, that you can
5007 change the dates of deadlines and appointments from the agenda buffer.
5008 The commands available in the Agenda buffer are listed in @ref{Agenda
5009 commands}.
5011 @subsubheading Calendar/Diary integration
5012 @cindex calendar integration
5013 @cindex diary integration
5015 Emacs contains the calendar and diary by Edward M. Reingold.  The
5016 calendar displays a three-month calendar with holidays from different
5017 countries and cultures.  The diary allows you to keep track of
5018 anniversaries, lunar phases, sunrise/set, recurrent appointments
5019 (weekly, monthly) and more.  In this way, it is quite complementary to
5020 Org-mode.  It can be very useful to combine output from Org-mode with
5021 the diary.
5023 In order to include entries from the Emacs diary into Org-mode's
5024 agenda, you only need to customize the variable
5026 @lisp
5027 (setq org-agenda-include-diary t)
5028 @end lisp
5030 @noindent After that, everything will happen automatically.  All diary
5031 entries including holidays, anniversaries etc will be included in the
5032 agenda buffer created by Org-mode.  @key{SPC}, @key{TAB}, and
5033 @key{RET} can be used from the agenda buffer to jump to the diary
5034 file in order to edit existing diary entries.  The @kbd{i} command to
5035 insert new entries for the current date works in the agenda buffer, as
5036 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
5037 Sunrise/Sunset times, show lunar phases and to convert to other
5038 calendars, respectively.  @kbd{c} can be used to switch back and forth
5039 between calendar and agenda.
5041 If you are using the diary only for sexp entries and holidays, it is
5042 faster to not use the above setting, but instead to copy or even move
5043 the entries into an Org-mode file. Org-mode evaluates diary-style sexp
5044 entries, and does it faster because there is no overhead for first
5045 creating the diary display.  Note that the sexp entries must start at
5046 the left margin, no white space is allowed before them.  For example,
5047 the following segment of an Org-mode file will be processed and entries
5048 will be made in the agenda:
5050 @example
5051 * Birthdays and similar stuff
5052 #+CATEGORY: Holiday
5053 %%(org-calendar-holiday)   ; special function for holiday names
5054 #+CATEGORY: Ann
5055 %%(diary-anniversary 14  5 1956) Arthur Dent is %d years old
5056 %%(diary-anniversary  2 10 1869) Mahatma Gandhi would be %d years old
5057 @end example
5059 @subsubheading Appointment reminders
5060 @cindex @file{appt.el}
5061 @cindex appointment reminders
5063 Org can interact with Emacs appointments notification facility.
5065 To add all the appointments of your agenda files, use the command
5066 @code{org-agenda-to-appt}.  This commands also lets you filter through
5067 the list of your appointments and add only those belonging to a specific
5068 category or matching a regular expression. See the docstring for
5069 details.
5071 @node Global TODO list, Matching tags and properties, Weekly/Daily agenda, Built-in agenda views
5072 @subsection The global TODO list
5073 @cindex global TODO list
5074 @cindex TODO list, global
5076 The global TODO list contains all unfinished TODO items, formatted and
5077 collected into a single place.
5079 @table @kbd
5080 @kindex C-c a t
5081 @item C-c a t
5082 Show the global TODO list.  This collects the TODO items from all
5083 agenda files (@pxref{Agenda views}) into a single buffer.  The buffer is in
5084 @code{agenda-mode}, so there are commands to examine and manipulate
5085 the TODO entries directly from that buffer (@pxref{Agenda commands}).
5086 @kindex C-c a T
5087 @item C-c a T
5088 @cindex TODO keyword matching
5089 Like the above, but allows selection of a specific TODO keyword.  You
5090 can also do this by specifying a prefix argument to @kbd{C-c a t}.  With
5091 a @kbd{C-u} prefix you are prompted for a keyword, and you may also
5092 specify several keywords by separating them with @samp{|} as boolean OR
5093 operator.  With a numeric prefix, the Nth keyword in
5094 @code{org-todo-keywords} is selected.
5095 @kindex r
5096 The @kbd{r} key in the agenda buffer regenerates it, and you can give
5097 a prefix argument to this command to change the selected TODO keyword,
5098 for example @kbd{3 r}.  If you often need a search for a specific
5099 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
5100 Matching specific TODO keywords can also be done as part of a tags
5101 search (@pxref{Tag searches}).
5102 @end table
5104 Remote editing of TODO items means that you can change the state of a
5105 TODO entry with a single key press.  The commands available in the
5106 TODO list are described in @ref{Agenda commands}.
5108 @cindex sublevels, inclusion into todo list
5109 Normally the global todo list simply shows all headlines with TODO
5110 keywords.  This list can become very long.  There are two ways to keep
5111 it more compact:
5112 @itemize @minus
5113 @item
5114 Some people view a TODO item that has been @emph{scheduled} for
5115 execution (@pxref{Time stamps}) as no longer @emph{open}.  Configure the
5116 variable @code{org-agenda-todo-ignore-scheduled} to exclude scheduled
5117 items from the global TODO list.
5118 @item
5119 TODO items may have sublevels to break up the task into subtasks.  In
5120 such cases it may be enough to list only the highest level TODO headline
5121 and omit the sublevels from the global list.  Configure the variable
5122 @code{org-agenda-todo-list-sublevels} to get this behavior.
5123 @end itemize
5125 @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views
5126 @subsection Matching Tags and Properties
5127 @cindex matching, of tags
5128 @cindex matching, of properties
5129 @cindex tags view
5131 If headlines in the agenda files are marked with @emph{tags}
5132 (@pxref{Tags}), you can select headlines based on the tags that apply
5133 to them and collect them into an agenda buffer.
5135 @table @kbd
5136 @kindex C-c a m
5137 @item C-c a m
5138 Produce a list of all headlines that match a given set of tags.  The
5139 command prompts for a selection criterion, which is a boolean logic
5140 expression with tags, like @samp{+work+urgent-withboss} or
5141 @samp{work|home} (@pxref{Tags}).  If you often need a specific search,
5142 define a custom command for it (@pxref{Agenda dispatcher}).
5143 @kindex C-c a M
5144 @item C-c a M
5145 Like @kbd{C-c a m}, but only select headlines that are also TODO items
5146 and force checking subitems (see variable
5147 @code{org-tags-match-list-sublevels}).  Matching specific todo keywords
5148 together with a tags match is also possible, see @ref{Tag searches}.
5149 @end table
5151 The commands available in the tags list are described in @ref{Agenda
5152 commands}.
5154 @node Timeline, Keyword search, Matching tags and properties, Built-in agenda views
5155 @subsection Timeline for a single file
5156 @cindex timeline, single file
5157 @cindex time-sorted view
5159 The timeline summarizes all time-stamped items from a single Org-mode
5160 file in a @emph{time-sorted view}.  The main purpose of this command is
5161 to give an overview over events in a project.
5163 @table @kbd
5164 @kindex C-c a L
5165 @item C-c a L
5166 Show a time-sorted view of the org file, with all time-stamped items.
5167 When called with a @kbd{C-u} prefix, all unfinished TODO entries
5168 (scheduled or not) are also listed under the current date.
5169 @end table
5171 @noindent
5172 The commands available in the timeline buffer are listed in
5173 @ref{Agenda commands}.
5175 @node Keyword search, Stuck projects, Timeline, Built-in agenda views
5176 @subsection Keyword search
5177 @cindex keyword search
5178 @cindex searching, for keywords
5180 This agenda view is a general text search facility for Org-mode entries.
5181 It is particularly useful to find notes.
5183 @table @kbd
5184 @kindex C-c a s
5185 @item C-c a s
5186 This is a special search that lets you select entries by keywords or
5187 regular expression, using a boolean logic.  For example, the search
5188 string
5190 @example
5191 +computer +wifi -ethernet -@{8\.11[bg]@}
5192 @end example
5194 @noindent
5195 will search for note entries that contain the keywords @code{computer}
5196 and @code{wifi}, but not the keyword @code{ethernet}, and which are also
5197 not matched by the regular expression @code{8\.11[bg]}, meaning to
5198 exclude both 8.11b and 8.11g.
5200 Note that in addition to the agenda files, this command will also search
5201 the files listed in @code{org-agenda-text-search-extra-files}.
5202 @end table
5204 @node Stuck projects,  , Keyword search, Built-in agenda views
5205 @subsection Stuck projects
5207 If you are following a system like David Allen's GTD to organize your
5208 work, one of the ``duties'' you have is a regular review to make sure
5209 that all projects move along.  A @emph{stuck} project is a project that
5210 has no defined next actions, so it will never show up in the TODO lists
5211 Org-mode produces.  During the review, you need to identify such
5212 projects and define next actions for them.
5214 @table @kbd
5215 @kindex C-c a #
5216 @item C-c a #
5217 List projects that are stuck.
5218 @kindex C-c a !
5219 @item C-c a !
5220 Customize the variable @code{org-stuck-projects} to define what a stuck
5221 project is and how to find it.
5222 @end table
5224 You almost certainly will have to configure this view before it will
5225 work for you.  The built-in default assumes that all your projects are
5226 level-2 headlines, and that a project is not stuck if it has at least
5227 one entry marked with a todo keyword TODO or NEXT or NEXTACTION.
5229 Lets assume that you, in your own way of using Org-mode, identify
5230 projects with a tag PROJECT, and that you use a todo keyword MAYBE to
5231 indicate a project that should not be considered yet.  Lets further
5232 assume that the todo keyword DONE marks finished projects, and that NEXT
5233 and TODO indicate next actions.  The tag @@SHOP indicates shopping and
5234 is a next action even without the NEXT tag.  Finally, if the project
5235 contains the special word IGNORE anywhere, it should not be listed
5236 either.  In this case you would start by identifying eligible projects
5237 with a tags/todo match @samp{+PROJECT/-MAYBE-DONE}, and then check for
5238 TODO, NEXT, @@SHOP, and IGNORE in the subtree to identify projects that
5239 are not stuck.  The correct customization for this is
5241 @lisp
5242 (setq org-stuck-projects
5243       '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
5244                                "\\<IGNORE\\>"))
5245 @end lisp
5248 @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda views
5249 @section Presentation and sorting
5250 @cindex presentation, of agenda items
5252 Before displaying items in an agenda view, Org-mode visually prepares
5253 the items and sorts them.  Each item occupies a single line.  The line
5254 starts with a @emph{prefix} that contains the @emph{category}
5255 (@pxref{Categories}) of the item and other important information.  You can
5256 customize the prefix using the option @code{org-agenda-prefix-format}.
5257 The prefix is followed by a cleaned-up version of the outline headline
5258 associated with the item.
5260 @menu
5261 * Categories::                  Not all tasks are equal
5262 * Time-of-day specifications::  How the agenda knows the time
5263 * Sorting of agenda items::     The order of things
5264 @end menu
5266 @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting
5267 @subsection Categories
5269 @cindex category
5270 The category is a broad label assigned to each agenda item.  By default,
5271 the category is simply derived from the file name, but you can also
5272 specify it with a special line in the buffer, like this@footnote{For
5273 backward compatibility, the following also works: If there are several
5274 such lines in a file, each specifies the category for the text below it.
5275 The first category also applies to any text before the first CATEGORY
5276 line.  However, using this method is @emph{strongly} deprecated as it is
5277 incompatible with the outline structure of the document.  The correct
5278 method for setting multiple categories in a buffer is using a
5279 property.}:
5281 @example
5282 #+CATEGORY: Thesis
5283 @end example
5285 @noindent
5286 If you would like to have a special CATEGORY for a single entry or a
5287 (sub)tree, give the entry a @code{:CATEGORY:} property with the location
5288 as the value (@pxref{Properties and columns}).
5290 @noindent
5291 The display in the agenda buffer looks best if the category is not
5292 longer than 10 characters.
5294 @node Time-of-day specifications, Sorting of agenda items, Categories, Presentation and sorting
5295 @subsection Time-of-Day Specifications
5296 @cindex time-of-day specification
5298 Org-mode checks each agenda item for a time-of-day specification.  The
5299 time can be part of the time stamp that triggered inclusion into the
5300 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}.  Time
5301 ranges can be specified with two time stamps, like
5303 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
5305 In the headline of the entry itself, a time(range) may also appear as
5306 plain text (like @samp{12:45} or a @samp{8:30-1pm}.  If the agenda
5307 integrates the Emacs diary (@pxref{Weekly/Daily agenda}), time
5308 specifications in diary entries are recognized as well.
5310 For agenda display, Org-mode extracts the time and displays it in a
5311 standard 24 hour format as part of the prefix.  The example times in
5312 the previous paragraphs would end up in the agenda like this:
5314 @example
5315     8:30-13:00 Arthur Dent lies in front of the bulldozer
5316    12:45...... Ford Prefect arrives and takes Arthur to the pub
5317    19:00...... The Vogon reads his poem
5318    20:30-22:15 Marwin escorts the Hitchhikers to the bridge
5319 @end example
5321 @cindex time grid
5322 If the agenda is in single-day mode, or for the display of today, the
5323 timed entries are embedded in a time grid, like
5325 @example
5326     8:00...... ------------------
5327     8:30-13:00 Arthur Dent lies in front of the bulldozer
5328    10:00...... ------------------
5329    12:00...... ------------------
5330    12:45...... Ford Prefect arrives and takes Arthur to the pub
5331    14:00...... ------------------
5332    16:00...... ------------------
5333    18:00...... ------------------
5334    19:00...... The Vogon reads his poem
5335    20:00...... ------------------
5336    20:30-22:15 Marwin escorts the Hitchhikers to the bridge
5337 @end example
5339 The time grid can be turned on and off with the variable
5340 @code{org-agenda-use-time-grid}, and can be configured with
5341 @code{org-agenda-time-grid}.
5343 @node Sorting of agenda items,  , Time-of-day specifications, Presentation and sorting
5344 @subsection Sorting of agenda items
5345 @cindex sorting, of agenda items
5346 @cindex priorities, of agenda items
5347 Before being inserted into a view, the items are sorted.  How this is
5348 done depends on the type of view.
5349 @itemize @bullet
5350 @item
5351 For the daily/weekly agenda, the items for each day are sorted.  The
5352 default order is to first collect all items containing an explicit
5353 time-of-day specification.  These entries will be shown at the beginning
5354 of the list, as a @emph{schedule} for the day.  After that, items remain
5355 grouped in categories, in the sequence given by @code{org-agenda-files}.
5356 Within each category, items are sorted by priority (@pxref{Priorities}),
5357 which is composed of the base priority (2000 for priority @samp{A}, 1000
5358 for @samp{B}, and 0 for @samp{C}), plus additional increments for
5359 overdue scheduled or deadline items.
5360 @item
5361 For the TODO list, items remain in the order of categories, but within
5362 each category, sorting takes place according to priority
5363 (@pxref{Priorities}).
5364 @item
5365 For tags matches, items are not sorted at all, but just appear in the
5366 sequence in which they are found in the agenda files.
5367 @end itemize
5369 Sorting can be customized using the variable
5370 @code{org-agenda-sorting-strategy}.
5373 @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda views
5374 @section Commands in the agenda buffer
5375 @cindex commands, in agenda buffer
5377 Entries in the agenda buffer are linked back to the org file or diary
5378 file where they originate.  You are not allowed to edit the agenda
5379 buffer itself, but commands are provided to show and jump to the
5380 original entry location, and to edit the org-files ``remotely'' from
5381 the agenda buffer.  In this way, all information is stored only once,
5382 removing the risk that your agenda and note files may diverge.
5384 Some commands can be executed with mouse clicks on agenda lines.  For
5385 the other commands, the cursor needs to be in the desired line.
5387 @table @kbd
5388 @tsubheading{Motion}
5389 @cindex motion commands in agenda
5390 @kindex n
5391 @item n
5392 Next line (same as @key{up} and @kbd{C-p}).
5393 @kindex p
5394 @item p
5395 Previous line (same as @key{down} and @kbd{C-n}).
5396 @tsubheading{View/GoTo org file}
5397 @kindex mouse-3
5398 @kindex @key{SPC}
5399 @item mouse-3
5400 @itemx @key{SPC}
5401 Display the original location of the item in another window.
5403 @kindex L
5404 @item L
5405 Display original location and recenter that window.
5407 @kindex mouse-2
5408 @kindex mouse-1
5409 @kindex @key{TAB}
5410 @item mouse-2
5411 @itemx mouse-1
5412 @itemx @key{TAB}
5413 Go to the original location of the item in another window.  Under Emacs
5414 22, @kbd{mouse-1} will also works for this.
5416 @kindex @key{RET}
5417 @itemx @key{RET}
5418 Go to the original location of the item and delete other windows.
5420 @kindex f
5421 @item f
5422 Toggle Follow mode.  In Follow mode, as you move the cursor through
5423 the agenda buffer, the other window always shows the corresponding
5424 location in the org file.  The initial setting for this mode in new
5425 agenda buffers can be set with the variable
5426 @code{org-agenda-start-with-follow-mode}.
5428 @kindex b
5429 @item b
5430 Display the entire subtree of the current item in an indirect buffer.
5431 With numerical prefix ARG, go up to this level and then take that tree.
5432 If ARG is negative, go up that many levels.  With @kbd{C-u} prefix, do
5433 not remove the previously used indirect buffer.
5435 @kindex l
5436 @item l
5437 Toggle Logbook mode.  In Logbook mode, entries that where marked DONE while
5438 logging was on (variable @code{org-log-done}) are shown in the agenda,
5439 as are entries that have been clocked on that day.
5441 @tsubheading{Change display}
5442 @cindex display changing, in agenda
5443 @kindex o
5444 @item o
5445 Delete other windows.
5447 @kindex d
5448 @kindex w
5449 @kindex m
5450 @kindex y
5451 @item d w m y
5452 Switch to day/week/month/year view.  When switching to day or week view,
5453 this setting becomes the default for subseqent agenda commands.  Since
5454 month and year views are slow to create, the do not become the default.
5456 @kindex D
5457 @item D
5458 Toggle the inclusion of diary entries.  See @ref{Weekly/Daily agenda}.
5460 @kindex G
5461 @item G
5462 Toggle the time grid on and off.  See also the variables
5463 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
5465 @kindex r
5466 @item r
5467 Recreate the agenda buffer, for example to reflect the changes
5468 after modification of the time stamps of items with S-@key{left} and
5469 S-@key{right}.  When the buffer is the global todo list, a prefix
5470 argument is interpreted to create a selective list for a specific TODO
5471 keyword.
5472 @kindex g
5473 @item g
5474 Same as @kbd{r}.
5476 @kindex s
5477 @kindex C-x C-s
5478 @item s
5479 @itemx C-x C-s
5480 Save all Org-mode buffers in the current Emacs session.
5482 @kindex @key{right}
5483 @item @key{right}
5484 Display the following @code{org-agenda-ndays} days.  For example, if
5485 the display covers a week, switch to the following week.  With prefix
5486 arg, go forward that many times @code{org-agenda-ndays} days.
5488 @kindex @key{left}
5489 @item @key{left}
5490 Display the previous dates.
5492 @kindex .
5493 @item .
5494 Goto today.
5496 @tsubheading{Query editing}
5497 @cindex query editing, in agenda
5499 @kindex [
5500 @kindex ]
5501 @kindex @{
5502 @kindex @}
5503 @item [ ] @{ @}
5504 In the @i{search view} (@pxref{Keyword search}), these keys add new
5505 search words (@kbd{[} and @kbd{]}) or new regular expressions (@kbd{@{}
5506 and @kbd{@}}) to the query string.  The opening bracket/brace will add a
5507 positive search term prefixed by @samp{+}, indicating that this search
5508 term @i{must} occur/match in the entry.  Closing bracket/brace add a
5509 negative search term which @i{must not} occur/match in the entry for it
5510 to be selected.
5513 @tsubheading{Remote editing}
5514 @cindex remote editing, from agenda
5516 @item 0-9
5517 Digit argument.
5519 @cindex undoing remote-editing events
5520 @cindex remote editing, undo
5521 @kindex C-_
5522 @item C-_
5523 Undo a change due to a remote editing command.  The change is undone
5524 both in the agenda buffer and in the remote buffer.
5526 @kindex t
5527 @item t
5528 Change the TODO state of the item, both in the agenda and in the
5529 original org file.
5531 @kindex C-k
5532 @item C-k
5533 Delete the current agenda item along with the entire subtree belonging
5534 to it in the original Org-mode file.  If the text to be deleted remotely
5535 is longer than one line, the kill needs to be confirmed by the user.  See
5536 variable @code{org-agenda-confirm-kill}.
5538 @kindex $
5539 @item $
5540 Archive the subtree corresponding to the current headline.
5542 @kindex T
5543 @item T
5544 Show all tags associated with the current item.  Because of
5545 inheritance, this may be more than the tags listed in the line itself.
5547 @kindex :
5548 @item :
5549 Set tags for the current headline.  If there is an active region in the
5550 agenda, change a tag for all headings in the region.
5552 @kindex a
5553 @item a
5554 Toggle the ARCHIVE tag for the current headline.
5556 @kindex ,
5557 @item ,
5558 Set the priority for the current item.  Org-mode prompts for the
5559 priority character. If you reply with @key{SPC}, the priority cookie
5560 is removed from the entry.
5562 @kindex P
5563 @item P
5564 Display weighted priority of current item.
5566 @kindex +
5567 @kindex S-@key{up}
5568 @item +
5569 @itemx S-@key{up}
5570 Increase the priority of the current item.  The priority is changed in
5571 the original buffer, but the agenda is not resorted.  Use the @kbd{r}
5572 key for this.
5574 @kindex -
5575 @kindex S-@key{down}
5576 @item -
5577 @itemx S-@key{down}
5578 Decrease the priority of the current item.
5580 @kindex C-c C-s
5581 @item C-c C-s
5582 Schedule this item
5584 @kindex C-c C-d
5585 @item C-c C-d
5586 Set a deadline for this item.
5588 @kindex S-@key{right}
5589 @item S-@key{right}
5590 Change the time stamp associated with the current line by one day into
5591 the future.  With prefix argument, change it by that many days.  For
5592 example, @kbd{3 6 5 S-@key{right}} will change it by a year.  The
5593 stamp is changed in the original org file, but the change is not
5594 directly reflected in the agenda buffer.  Use the
5595 @kbd{r} key to update the buffer.
5597 @kindex S-@key{left}
5598 @item S-@key{left}
5599 Change the time stamp associated with the current line by one day
5600 into the past.
5602 @kindex >
5603 @item >
5604 Change the time stamp associated with the current line to today.
5605 The key @kbd{>} has been chosen, because it is the same as @kbd{S-.}
5606 on my keyboard.
5608 @kindex I
5609 @item I
5610 Start the clock on the current item.  If a clock is running already, it
5611 is stopped first.
5613 @kindex O
5614 @item O
5615 Stop the previously started clock.
5617 @kindex X
5618 @item X
5619 Cancel the currently running clock.
5621 @kindex J
5622 @item J
5623 Jump to the running clock in another window.
5625 @tsubheading{Calendar commands}
5626 @cindex calendar commands, from agenda
5627 @kindex c
5628 @item c
5629 Open the Emacs calendar and move to the date at the agenda cursor.
5631 @item c
5632 When in the calendar, compute and show the Org-mode agenda for the
5633 date at the cursor.
5635 @cindex diary entries, creating from agenda
5636 @kindex i
5637 @item i
5638 Insert a new entry into the diary.  Prompts for the type of entry
5639 (day, weekly, monthly, yearly, anniversary, cyclic) and creates a new
5640 entry in the diary, just as @kbd{i d} etc. would do in the calendar.
5641 The date is taken from the cursor position.
5643 @kindex M
5644 @item M
5645 Show the phases of the moon for the three months around current date.
5647 @kindex S
5648 @item S
5649 Show sunrise and sunset times.  The geographical location must be set
5650 with calendar variables, see documentation of the Emacs calendar.
5652 @kindex C
5653 @item C
5654 Convert the date at cursor into many other cultural and historic
5655 calendars.
5657 @kindex H
5658 @item H
5659 Show holidays for three month around the cursor date.
5661 @c FIXME:  This should be a different key.
5662 @kindex C-c C-x C-c
5663 @item C-c C-x C-c
5664 Export a single iCalendar file containing entries from all agenda files.
5666 @tsubheading{Exporting to a file}
5667 @kindex C-x C-w
5668 @item C-x C-w
5669 @cindex exporting agenda views
5670 @cindex agenda views, exporting
5671 Write the agenda view to a file.  Depending on the extension of the
5672 selected file name, the view will be exported as HTML (extension
5673 @file{.html} or @file{.htm}), Postscript (extension @file{.ps}), or
5674 plain text (any other extension).  Use the variable
5675 @code{org-agenda-exporter-settings} to set options for @file{ps-print}
5676 and for @file{htmlize} to be used during export.
5678 @tsubheading{Quit and Exit}
5679 @kindex q
5680 @item q
5681 Quit agenda, remove the agenda buffer.
5683 @kindex x
5684 @cindex agenda files, removing buffers
5685 @item x
5686 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
5687 for the compilation of the agenda.  Buffers created by the user to
5688 visit org files will not be removed.
5689 @end table
5692 @node Custom agenda views,  , Agenda commands, Agenda views
5693 @section Custom agenda views
5694 @cindex custom agenda views
5695 @cindex agenda views, custom
5697 Custom agenda commands serve two purposes: to store and quickly access
5698 frequently used TODO and tags searches, and to create special composite
5699 agenda buffers.  Custom agenda commands will be accessible through the
5700 dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
5702 @menu
5703 * Storing searches::            Type once, use often
5704 * Block agenda::                All the stuff you need in a single buffer
5705 * Setting Options::             Changing the rules
5706 * Exporting Agenda Views::      Writing agendas to files.
5707 * Extracting Agenda Information for other programs::
5708 @end menu
5710 @node Storing searches, Block agenda, Custom agenda views, Custom agenda views
5711 @subsection Storing searches
5713 The first application of custom searches is the definition of keyboard
5714 shortcuts for frequently used searches, either creating an agenda
5715 buffer, or a sparse tree (the latter covering of course only the current
5716 buffer).
5717 @kindex C-c a C
5718 Custom commands are configured in the variable
5719 @code{org-agenda-custom-commands}.  You can customize this variable, for
5720 example by pressing @kbd{C-c a C}.  You can also directly set it with
5721 Emacs Lisp in @file{.emacs}.  The following example contains all valid
5722 search types:
5724 @lisp
5725 @group
5726 (setq org-agenda-custom-commands
5727       '(("w" todo "WAITING")
5728         ("W" todo-tree "WAITING")
5729         ("u" tags "+boss-urgent")
5730         ("v" tags-todo "+boss-urgent")
5731         ("U" tags-tree "+boss-urgent")
5732         ("f" occur-tree "\\<FIXME\\>")
5733         ("h" . "HOME+Name tags searches") ; description for "h" prefix
5734         ("hl" tags "+home+Lisa")
5735         ("hp" tags "+home+Peter")
5736         ("hk" tags "+home+Kim")))
5737 @end group
5738 @end lisp
5740 @noindent
5741 The initial string in each entry defines the keys you have to press
5742 after the dispatcher command @kbd{C-c a} in order to access the command.
5743 Usually this will be just a single character, but if you have many
5744 similar commands, you can also define two-letter combinations where the
5745 first character is the same in several combinations and serves as a
5746 prefix key@footnote{You can provide a description for a prefix key by
5747 inserting a cons cell with the prefix and the description.}.  The second
5748 parameter is the search type, followed by the string or regular
5749 expression to be used for the matching.  The example above will
5750 therefore define:
5752 @table @kbd
5753 @item C-c a w
5754 as a global search for TODO entries with @samp{WAITING} as the TODO
5755 keyword
5756 @item C-c a W
5757 as the same search, but only in the current buffer and displaying the
5758 results as a sparse tree
5759 @item C-c a u
5760 as a global tags search for headlines marked @samp{:boss:} but not
5761 @samp{:urgent:}
5762 @item C-c a v
5763 as the same search as @kbd{C-c a u}, but limiting the search to
5764 headlines that are also TODO items
5765 @item C-c a U
5766 as the same search as @kbd{C-c a u}, but only in the current buffer and
5767 displaying the result as a sparse tree
5768 @item C-c a f
5769 to create a sparse tree (again: current buffer only) with all entries
5770 containing the word @samp{FIXME}
5771 @item C-c a h
5772 as a prefix command for a HOME tags search where you have to press an
5773 additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
5774 Peter, or Kim) as additional tag to match.
5775 @end table
5777 @node Block agenda, Setting Options, Storing searches, Custom agenda views
5778 @subsection Block agenda
5779 @cindex block agenda
5780 @cindex agenda, with block views
5782 Another possibility is the construction of agenda views that comprise
5783 the results of @emph{several} commands, each of which creates a block in
5784 the agenda buffer.  The available commands include @code{agenda} for the
5785 daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
5786 for the global todo list (as constructed with @kbd{C-c a t}), and the
5787 matching commands discussed above: @code{todo}, @code{tags}, and
5788 @code{tags-todo}.  Here are two examples:
5790 @lisp
5791 @group
5792 (setq org-agenda-custom-commands
5793       '(("h" "Agenda and Home-related tasks"
5794          ((agenda "")
5795           (tags-todo "home")
5796           (tags "garden")))
5797         ("o" "Agenda and Office-related tasks"
5798          ((agenda "")
5799           (tags-todo "work")
5800           (tags "office")))))
5801 @end group
5802 @end lisp
5804 @noindent
5805 This will define @kbd{C-c a h} to create a multi-block view for stuff
5806 you need to attend to at home.  The resulting agenda buffer will contain
5807 your agenda for the current week, all TODO items that carry the tag
5808 @samp{home}, and also all lines tagged with @samp{garden}.  Finally the
5809 command @kbd{C-c a o} provides a similar view for office tasks.
5811 @node Setting Options, Exporting Agenda Views, Block agenda, Custom agenda views
5812 @subsection Setting Options for custom commands
5813 @cindex options, for custom agenda views
5815 Org-mode contains a number of variables regulating agenda construction
5816 and display.  The global variables define the behavior for all agenda
5817 commands, including the custom commands.  However, if you want to change
5818 some settings just for a single custom view, you can do so.  Setting
5819 options requires inserting a list of variable names and values at the
5820 right spot in @code{org-agenda-custom-commands}.  For example:
5822 @lisp
5823 @group
5824 (setq org-agenda-custom-commands
5825       '(("w" todo "WAITING"
5826          ((org-agenda-sorting-strategy '(priority-down))
5827           (org-agenda-prefix-format "  Mixed: ")))
5828         ("U" tags-tree "+boss-urgent"
5829          ((org-show-following-heading nil)
5830           (org-show-hierarchy-above nil)))
5831         ("N" search ""
5832          ((org-agenda-files '("~org/notes.org"))
5833           (org-agenda-text-search-extra-files nil)))))
5834 @end group
5835 @end lisp
5837 @noindent
5838 Now the @kbd{C-c a w} command will sort the collected entries only by
5839 priority, and the prefix format is modified to just say @samp{  Mixed: }
5840 instead of giving the category of the entry.  The sparse tags tree of
5841 @kbd{C-c a U} will now turn out ultra-compact, because neither the
5842 headline hierarchy above the match, nor the headline following the match
5843 will be shown.  The command @kbd{C-c a N} will do a text search limited
5844 to only a single file.
5846 For command sets creating a block agenda,
5847 @code{org-agenda-custom-commands} has two separate spots for setting
5848 options.  You can add options that should be valid for just a single
5849 command in the set, and options that should be valid for all commands in
5850 the set.  The former are just added to the command entry, the latter
5851 must come after the list of command entries.  Going back to the block
5852 agenda example (@pxref{Block agenda}), let's change the sorting strategy
5853 for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
5854 the results for GARDEN tags query in the opposite order,
5855 @code{priority-up}.  This would look like this:
5857 @lisp
5858 @group
5859 (setq org-agenda-custom-commands
5860       '(("h" "Agenda and Home-related tasks"
5861          ((agenda)
5862           (tags-todo "home")
5863           (tags "garden"
5864                 ((org-agenda-sorting-strategy '(priority-up)))))
5865          ((org-agenda-sorting-strategy '(priority-down))))
5866         ("o" "Agenda and Office-related tasks"
5867          ((agenda)
5868           (tags-todo "work")
5869           (tags "office")))))
5870 @end group
5871 @end lisp
5873 As you see, the values and parenthesis setting is a little complex.
5874 When in doubt, use the customize interface to set this variable - it
5875 fully supports its structure.  Just one caveat: When setting options in
5876 this interface, the @emph{values} are just lisp expressions.  So if the
5877 value is a string, you need to add the double quotes around the value
5878 yourself.
5881 @node Exporting Agenda Views, Extracting Agenda Information for other programs, Setting Options, Custom agenda views
5882 @subsection Exporting Agenda Views
5883 @cindex agenda views, exporting
5885 If you are away from your computer, it can be very useful to have a
5886 printed version of some agenda views to carry around.  Org-mode can
5887 export custom agenda views as plain text, HTML@footnote{You need to
5888 install Hrvoje Niksic' @file{htmlize.el}.} postscript, and iCalendar
5889 files.  If you want to do this only occasionally, use the command
5891 @table @kbd
5892 @kindex C-x C-w
5893 @item C-x C-w
5894 @cindex exporting agenda views
5895 @cindex agenda views, exporting
5896 Write the agenda view to a file.  Depending on the extension of the
5897 selected file name, the view will be exported as HTML (extension
5898 @file{.html} or @file{.htm}), Postscript (extension @file{.ps}),
5899 iCalendar (extension @file{.ics}), or plain text (any other extension).
5900 Use the variable @code{org-agenda-exporter-settings} to
5901 set options for @file{ps-print} and for @file{htmlize} to be used during
5902 export, for example
5904 @lisp
5905 (setq org-agenda-exporter-settings
5906       '((ps-number-of-columns 2)
5907         (ps-landscape-mode t)
5908         (htmlize-output-type 'css)))
5909 @end lisp
5910 @end table
5912 If you need to export certain agenda views frequently, you can associate
5913 any custom agenda command with a list of output file names
5914 @footnote{If you want to store standard views like the weekly agenda
5915 or the global TODO list as well, you need to define custom commands for
5916 them in order to be able to specify file names.}.  Here is an example
5917 that first does define custom commands for the agenda and the global
5918 todo list, together with a number of files to which to export them.
5919 Then we define two block agenda commands and specify file names for them
5920 as well.  File names can be relative to the current working directory,
5921 or absolute.
5923 @lisp
5924 @group
5925 (setq org-agenda-custom-commands
5926       '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
5927         ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
5928         ("h" "Agenda and Home-related tasks"
5929          ((agenda "")
5930           (tags-todo "home")
5931           (tags "garden"))
5932          nil
5933          ("~/views/home.html"))
5934         ("o" "Agenda and Office-related tasks"
5935          ((agenda)
5936           (tags-todo "work")
5937           (tags "office"))
5938          nil
5939          ("~/views/office.ps" "~/calendars/office.ics"))))
5940 @end group
5941 @end lisp
5943 The extension of the file name determines the type of export.  If it is
5944 @file{.html}, Org-mode will use the @file{htmlize.el} package to convert
5945 the buffer to HTML and save it to this file name.  If the extension is
5946 @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
5947 postscript output.  If the extension is @file{.ics}, iCalendar export is
5948 run export over all files that were used to construct the agenda, and
5949 limit the export to entries listed in the agenda now.  Any other
5950 extension produces a plain ASCII file.
5952 The export files are @emph{not} created when you use one of those
5953 commands interactively because this might use too much overhead.
5954 Instead, there is a special command to produce @emph{all} specified
5955 files in one step:
5957 @table @kbd
5958 @kindex C-c a e
5959 @item C-c a e
5960 Export all agenda views that have export file names associated with
5961 them.
5962 @end table
5964 You can use the options section of the custom agenda commands to also
5965 set options for the export commands.  For example:
5967 @lisp
5968 (setq org-agenda-custom-commands
5969       '(("X" agenda ""
5970          ((ps-number-of-columns 2)
5971           (ps-landscape-mode t)
5972           (org-agenda-prefix-format " [ ] ")
5973           (org-agenda-with-colors nil)
5974           (org-agenda-remove-tags t))
5975          ("theagenda.ps"))))
5976 @end lisp
5978 @noindent
5979 This command sets two options for the postscript exporter, to make it
5980 print in two columns in landscape format - the resulting page can be cut
5981 in two and then used in a paper agenda.  The remaining settings modify
5982 the agenda prefix to omit category and scheduling information, and
5983 instead include a checkbox to check off items.  We also remove the tags
5984 to make the lines compact, and we don't want to use colors for the
5985 black-and-white printer.  Settings specified in
5986 @code{org-agenda-exporter-settings} will also apply, but the settings
5987 in @code{org-agenda-custom-commands} take precedence.
5989 @noindent
5990 From the command line you may also use
5991 @example
5992 emacs -f org-batch-store-agenda-views -kill
5993 @end example
5994 @noindent
5995 or, if you need to modify some parameters
5996 @example
5997 emacs -eval '(org-batch-store-agenda-views                      \
5998               org-agenda-ndays 30                               \
5999               org-agenda-start-day "2007-11-01"                 \
6000               org-agenda-include-diary nil                      \
6001               org-agenda-files (quote ("~/org/project.org")))'  \
6002       -kill
6003 @end example
6004 @noindent
6005 which will create the agenda views restricted to the file
6006 @file{~/org/project.org}, without diary entries and with 30 days
6007 extent.
6009 @node Extracting Agenda Information for other programs,  , Exporting Agenda Views, Custom agenda views
6010 @subsection Extracting Agenda Information for other programs
6011 @cindex agenda, pipe
6012 @cindex Scripts, for agenda processing
6014 Org-mode provides commands to access agenda information for the command
6015 line in emacs batch mode.  This extracted information can be sent
6016 directly to a printer, or it can be read by a program that does further
6017 processing of the data.  The first of these commands is the function
6018 @code{org-batch-agenda}, that produces an agenda view and sends it as
6019 ASCII text to STDOUT.  The command takes a single string as parameter.
6020 If the string has length 1, it is used as a key to one of the commands
6021 you have configured in @code{org-agenda-custom-commands}, basically any
6022 key you can use after @kbd{C-c a}.  For example, to directly print the
6023 current TODO list, you could use
6025 @example
6026 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
6027 @end example
6029 If the parameter is a string with 2 or more characters, it is used as a
6030 tags/todo match string.  For example, to print your local shopping list
6031 (all items with the tag @samp{shop}, but excluding the tag
6032 @samp{NewYork}), you could use
6034 @example
6035 emacs -batch -l ~/.emacs                                      \
6036       -eval '(org-batch-agenda "+shop-NewYork")' | lpr
6037 @end example
6039 @noindent
6040 You may also modify parameters on the fly like this:
6042 @example
6043 emacs -batch -l ~/.emacs                                      \
6044    -eval '(org-batch-agenda "a"                               \
6045             org-agenda-ndays 30                               \
6046             org-agenda-include-diary nil                      \
6047             org-agenda-files (quote ("~/org/project.org")))'  \
6048    | lpr
6049 @end example
6051 @noindent
6052 which will produce a 30 day agenda, fully restricted to the Org file
6053 @file{~/org/projects.org}, not even including the diary.
6055 If you want to process the agenda data in more sophisticated ways, you
6056 can use the command @code{org-batch-agenda-csv} to get a comma-separated
6057 list of values for each agenda item.  Each line in the output will
6058 contain a number of fields separated by commas.  The fields in a line
6059 are:
6061 @example
6062 category     @r{The category of the item}
6063 head         @r{The headline, without TODO kwd, TAGS and PRIORITY}
6064 type         @r{The type of the agenda entry, can be}
6065                 todo               @r{selected in TODO match}
6066                 tagsmatch          @r{selected in tags match}
6067                 diary              @r{imported from diary}
6068                 deadline           @r{a deadline}
6069                 scheduled          @r{scheduled}
6070                 timestamp          @r{appointment, selected by timestamp}
6071                 closed             @r{entry was closed on date}
6072                 upcoming-deadline  @r{warning about nearing deadline}
6073                 past-scheduled     @r{forwarded scheduled item}
6074                 block              @r{entry has date block including date}
6075 todo         @r{The todo keyword, if any}
6076 tags         @r{All tags including inherited ones, separated by colons}
6077 date         @r{The relevant date, like 2007-2-14}
6078 time         @r{The time, like 15:00-16:50}
6079 extra        @r{String with extra planning info}
6080 priority-l   @r{The priority letter if any was given}
6081 priority-n   @r{The computed numerical priority}
6082 @end example
6084 @noindent
6085 Time and date will only be given if a timestamp (or deadline/scheduled)
6086 lead to the selection of the item.
6088 A CSV list like this is very easy to use in a post processing script.
6089 For example, here is a Perl program that gets the TODO list from
6090 Emacs/org-mode and prints all the items, preceded by a checkbox:
6092 @example
6093 @group
6094 #!/usr/bin/perl
6096 # define the Emacs command to run
6097 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
6099 # run it and capture the output
6100 $agenda = qx@{$cmd 2>/dev/null@};
6102 # loop over all lines
6103 foreach $line (split(/\n/,$agenda)) @{
6105   # get the individual values
6106   ($category,$head,$type,$todo,$tags,$date,$time,$extra,
6107    $priority_l,$priority_n) = split(/,/,$line);
6109   # proccess and print
6110   print "[ ] $head\n";
6112 @end group
6113 @end example
6115 @node Embedded LaTeX, Exporting, Agenda views, Top
6116 @chapter Embedded LaTeX
6117 @cindex @TeX{} interpretation
6118 @cindex La@TeX{} interpretation
6120 Plain ASCII is normally sufficient for almost all note taking.  One
6121 exception, however, are scientific notes which need to be able to
6122 contain mathematical symbols and the occasional formula.
6123 La@TeX{}@footnote{La@TeX{} is a macro system based on Donald E. Knuth's
6124 @TeX{} system.  Many of the features described here as ``La@TeX{}'' are
6125 really from @TeX{}, but for simplicity I am blurring this distinction.}
6126 is widely used to typeset scientific documents. Org-mode supports
6127 embedding La@TeX{} code into its files, because many academics are used
6128 to read La@TeX{} source code, and because it can be readily processed
6129 into images for HTML production.
6131 It is not necessary to mark La@TeX{} macros and code in any special way.
6132 If you observe a few conventions, Org-mode knows how to find it and what
6133 to do with it.
6135 @menu
6136 * Math symbols::                TeX macros for symbols and Greek letters
6137 * Subscripts and Superscripts::  Simple syntax for raising/lowering text
6138 * LaTeX fragments::             Complex formulas made easy
6139 * Processing LaTeX fragments::  Previewing LaTeX processing
6140 * CDLaTeX mode::                Speed up entering of formulas
6141 @end menu
6143 @node Math symbols, Subscripts and Superscripts, Embedded LaTeX, Embedded LaTeX
6144 @section Math symbols
6145 @cindex math symbols
6146 @cindex TeX macros
6148 You can use La@TeX{} macros to insert special symbols like @samp{\alpha}
6149 to indicate the Greek letter, or @samp{\to} to indicate an arrow.
6150 Completion for these macros is available, just type @samp{\} and maybe a
6151 few letters, and press @kbd{M-@key{TAB}} to see possible completions.
6152 Unlike La@TeX{} code, Org-mode allows these macros to be present
6153 without surrounding math delimiters, for example:
6155 @example
6156 Angles are written as Greek letters \alpha, \beta and \gamma.
6157 @end example
6159 During HTML export (@pxref{HTML export}), these symbols are translated
6160 into the proper syntax for HTML, for the above examples this is
6161 @samp{&alpha;} and @samp{&rarr;}, respectively.
6163 @node Subscripts and Superscripts, LaTeX fragments, Math symbols, Embedded LaTeX
6164 @section Subscripts and Superscripts
6165 @cindex subscript
6166 @cindex superscript
6168 Just like in La@TeX{}, @samp{^} and @samp{_} are used to indicate super-
6169 and subscripts.  Again, these can be used without embedding them in
6170 math-mode delimiters.  To increase the readability of ASCII text, it is
6171 not necessary (but OK) to surround multi-character sub- and superscripts
6172 with curly braces.  For example
6174 @example
6175 The mass if the sun is M_sun = 1.989 x 10^30 kg.  The radius of
6176 the sun is R_@{sun@} = 6.96 x 10^8 m.
6177 @end example
6179 To avoid interpretation as raised or lowered text, you can quote
6180 @samp{^} and @samp{_} with a backslash: @samp{\_} and @samp{\^}.
6182 During HTML export (@pxref{HTML export}), subscript and superscripts
6183 are surrounded with @code{<sub>} and @code{<sup>} tags, respectively.
6185 @node LaTeX fragments, Processing LaTeX fragments, Subscripts and Superscripts, Embedded LaTeX
6186 @section LaTeX fragments
6187 @cindex LaTeX fragments
6189 With symbols, sub- and superscripts, HTML is pretty much at its end when
6190 it comes to representing mathematical formulas@footnote{Yes, there is
6191 MathML, but that is not yet fully supported by many browsers, and there
6192 is no decent converter for turning La@TeX{} or ASCII representations of
6193 formulas into MathML. So for the time being, converting formulas into
6194 images seems the way to go.}. More complex expressions need a dedicated
6195 formula processor. To this end, Org-mode can contain arbitrary La@TeX{}
6196 fragments. It provides commands to preview the typeset result of these
6197 fragments, and upon export to HTML, all fragments will be converted to
6198 images and inlined into the HTML document@footnote{The La@TeX{} export
6199 will not use images for displaying La@TeX{} fragments but include these
6200 fragments directly into the La@TeX{} code.}. For this to work you
6201 need to be on a system with a working La@TeX{} installation. You also
6202 need the @file{dvipng} program, available at
6203 @url{http://sourceforge.net/projects/dvipng/}. The La@TeX{} header that
6204 will be used when processing a fragment can be configured with the
6205 variable @code{org-format-latex-header}.
6207 La@TeX{} fragments don't need any special marking at all.  The following
6208 snippets will be identified as La@TeX{} source code:
6209 @itemize @bullet
6210 @item
6211 Environments of any kind.  The only requirement is that the
6212 @code{\begin} statement appears on a new line, preceded by only
6213 whitespace.
6214 @item
6215 Text within the usual La@TeX{} math delimiters.  To avoid conflicts with
6216 currency specifications, single @samp{$} characters are only recognized
6217 as math delimiters if the enclosed text contains at most two line breaks,
6218 is directly attached to the @samp{$} characters with no whitespace in
6219 between, and if the closing @samp{$} is followed by whitespace or
6220 punctuation.  For the other delimiters, there is no such restriction, so
6221 when in doubt, use @samp{\(...\)} as inline math delimiters.
6222 @end itemize
6224 @noindent For example:
6226 @example
6227 \begin@{equation@}                          % arbitrary environments,
6228 x=\sqrt@{b@}                                % even tables, figures
6229 \end@{equation@}                            % etc
6231 If $a^2=b$ and \( b=2 \), then the solution must be
6232 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
6233 @end example
6235 @noindent
6236 If you need any of the delimiter ASCII sequences for other purposes, you
6237 can configure the option @code{org-format-latex-options} to deselect the
6238 ones you do not wish to have interpreted by the La@TeX{} converter.
6240 @node Processing LaTeX fragments, CDLaTeX mode, LaTeX fragments, Embedded LaTeX
6241 @section Processing LaTeX fragments
6242 @cindex LaTeX fragments, preview
6244 La@TeX{} fragments can be processed to produce a preview images of the
6245 typeset expressions:
6247 @table @kbd
6248 @kindex C-c C-x C-l
6249 @item C-c C-x C-l
6250 Produce a preview image of the La@TeX{} fragment at point and overlay it
6251 over the source code.  If there is no fragment at point, process all
6252 fragments in the current entry (between two headlines).  When called
6253 with a prefix argument, process the entire subtree.  When called with
6254 two prefix arguments, or when the cursor is before the first headline,
6255 process the entire buffer.
6256 @kindex C-c C-c
6257 @item C-c C-c
6258 Remove the overlay preview images.
6259 @end table
6261 During HTML export (@pxref{HTML export}), all La@TeX{} fragments are
6262 converted into images and inlined into the document if the following
6263 setting is active:
6265 @lisp
6266 (setq org-export-with-LaTeX-fragments t)
6267 @end lisp
6269 @node CDLaTeX mode,  , Processing LaTeX fragments, Embedded LaTeX
6270 @section Using CDLaTeX to enter math
6271 @cindex CDLaTeX
6273 CDLaTeX-mode is a minor mode that is normally used in combination with a
6274 major La@TeX{} mode like AUCTeX in order to speed-up insertion of
6275 environments and math templates.  Inside Org-mode, you can make use of
6276 some of the features of cdlatex-mode.  You need to install
6277 @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
6278 AUCTeX) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
6279 Don't turn cdlatex-mode itself under Org-mode, but use the light
6280 version @code{org-cdlatex-mode} that comes as part of Org-mode.  Turn it
6281 on for the current buffer with @code{M-x org-cdlatex-mode}, or for all
6282 Org-mode files with
6284 @lisp
6285 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
6286 @end lisp
6288 When this mode is enabled, the following features are present (for more
6289 details see the documentation of cdlatex-mode):
6290 @itemize @bullet
6291 @kindex C-c @{
6292 @item
6293 Environment templates can be inserted with @kbd{C-c @{}.
6294 @item
6295 @kindex @key{TAB}
6296 The @key{TAB} key will do template expansion if the cursor is inside a
6297 La@TeX{} fragment@footnote{Org-mode has a method to test if the cursor is
6298 inside such a fragment, see the documentation of the function
6299 @code{org-inside-LaTeX-fragment-p}.}.  For example, @key{TAB} will
6300 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
6301 correctly inside the first brace.  Another @key{TAB} will get you into
6302 the second brace.  Even outside fragments, @key{TAB} will expand
6303 environment abbreviations at the beginning of a line.  For example, if
6304 you write @samp{equ} at the beginning of a line and press @key{TAB},
6305 this abbreviation will be expanded to an @code{equation} environment.
6306 To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}.
6307 @item
6308 @kindex _
6309 @kindex ^
6310 Pressing @kbd{_} and @kbd{^} inside a La@TeX{} fragment will insert these
6311 characters together with a pair of braces.  If you use @key{TAB} to move
6312 out of the braces, and if the braces surround only a single character or
6313 macro, they are removed again (depending on the variable
6314 @code{cdlatex-simplify-sub-super-scripts}).
6315 @item
6316 @kindex `
6317 Pressing the backquote @kbd{`} followed by a character inserts math
6318 macros, also outside La@TeX{} fragments.  If you wait more than 1.5 seconds
6319 after the backquote, a help window will pop up.
6320 @item
6321 @kindex '
6322 Pressing the normal quote @kbd{'} followed by another character modifies
6323 the symbol before point with an accent or a font.  If you wait more than
6324 1.5 seconds after the backquote, a help window will pop up.  Character
6325 modification will work only inside La@TeX{} fragments, outside the quote
6326 is normal.
6327 @end itemize
6329 @node Exporting, Publishing, Embedded LaTeX, Top
6330 @chapter Exporting
6331 @cindex exporting
6333 Org-mode documents can be exported into a variety of other formats.  For
6334 printing and sharing of notes, ASCII export produces a readable and
6335 simple version of an Org-mode file.  HTML export allows you to publish a
6336 notes file on the web, while the XOXO format provides a solid base for
6337 exchange with a broad range of other applications. La@TeX{} export lets
6338 you use Org-mode and its structured editing functions to easily create
6339 La@TeX{} files.  To incorporate entries with associated times like
6340 deadlines or appointments into a desktop calendar program like iCal,
6341 Org-mode can also produce extracts in the iCalendar format.  Currently
6342 Org-mode only supports export, not import of these different formats.
6344 When exporting, Org-mode uses special conventions to enrich the output
6345 produced.  @xref{Text interpretation}, for more details.
6347 @table @kbd
6348 @kindex C-c C-e
6349 @item C-c C-e
6350 Dispatcher for export and publishing commands.  Displays a help-window
6351 listing the additional key(s) needed to launch an export or publishing
6352 command.
6353 @end table
6355 @menu
6356 * ASCII export::                Exporting to plain ASCII
6357 * HTML export::                 Exporting to HTML
6358 * LaTeX export::                Exporting to LaTeX
6359 * XOXO export::                 Exporting to XOXO
6360 * iCalendar export::            Exporting in iCalendar format
6361 * Text interpretation::         How the exporter looks at the file
6362 @end menu
6364 @node ASCII export, HTML export, Exporting, Exporting
6365 @section ASCII export
6366 @cindex ASCII export
6368 ASCII export produces a simple and very readable version of an Org-mode
6369 file.
6371 @cindex region, active
6372 @cindex active region
6373 @cindex transient-mark-mode
6374 @table @kbd
6375 @kindex C-c C-e a
6376 @item C-c C-e a
6377 Export as ASCII file.  For an org file @file{myfile.org}, the ASCII file
6378 will be @file{myfile.txt}.  The file will be overwritten without
6379 warning.  If there is an active region, only the region will be
6380 exported. If the selected region is a single tree, the tree head will
6381 become the document title.  If the tree head entry has or inherits an
6382 @code{:EXPORT_FILE_NAME:} property, that name will be used for the
6383 export.
6384 @kindex C-c C-e v a
6385 @item C-c C-e v a
6386 Export only the visible part of the document.
6387 @end table
6389 @cindex headline levels, for exporting
6390 In the exported version, the first 3 outline levels will become
6391 headlines, defining a general document structure.  Additional levels
6392 will be exported as itemized lists.  If you want that transition to occur
6393 at a different level, specify it with a prefix argument.  For example,
6395 @example
6396 @kbd{C-1 C-c C-e a}
6397 @end example
6399 @noindent
6400 creates only top level headlines and does the rest as items.  When
6401 headlines are converted to items, the indentation of the text following
6402 the headline is changed to fit nicely under the item.  This is done with
6403 the assumption that the first bodyline indicates the base indentation of
6404 the body text.  Any indentation larger than this is adjusted to preserve
6405 the layout relative to the first line.  Should there be lines with less
6406 indentation than the first, these are left alone.
6408 @node HTML export, LaTeX export, ASCII export, Exporting
6409 @section HTML export
6410 @cindex HTML export
6412 Org-mode contains an HTML (XHTML 1.0 strict) exporter with extensive
6413 HTML formatting, in ways similar to John Grubers @emph{markdown}
6414 language, but with additional support for tables.
6416 @menu
6417 * HTML Export commands::        How to invoke LaTeX export
6418 * Quoting HTML tags::           Using direct HTML in Org-mode
6419 * Links::                       Transformation of links for HTML
6420 * Images::                      How to include images
6421 * CSS support::                 Changing the appearence of the output
6422 @end menu
6424 @node HTML Export commands, Quoting HTML tags, HTML export, HTML export
6425 @subsection HTML export commands
6427 @cindex region, active
6428 @cindex active region
6429 @cindex transient-mark-mode
6430 @table @kbd
6431 @kindex C-c C-e h
6432 @item C-c C-e h
6433 Export as HTML file @file{myfile.html}.  For an org file
6434 @file{myfile.org}, the ASCII file will be @file{myfile.html}.  The file
6435 will be overwritten without warning.  If there is an active region, only
6436 the region will be exported. If the selected region is a single tree,
6437 the tree head will become the document title.  If the tree head entry
6438 has or inherits an @code{:EXPORT_FILE_NAME:} property, that name will be
6439 used for the export.
6440 @kindex C-c C-e b
6441 @item C-c C-e b
6442 Export as HTML file and immediately open it with a browser.
6443 @kindex C-c C-e H
6444 @item C-c C-e H
6445 Export to a temporary buffer, do not create a file.
6446 @kindex C-c C-e R
6447 @item C-c C-e R
6448 Export the active region to a temporary buffer.  With prefix arg, do not
6449 produce file header and foot, but just the plain HTML section for the
6450 region.  This is good for cut-and-paste operations.
6451 @kindex C-c C-e v h
6452 @kindex C-c C-e v b
6453 @kindex C-c C-e v H
6454 @kindex C-c C-e v R
6455 @item C-c C-e v h
6456 @item C-c C-e v b
6457 @item C-c C-e v H
6458 @item C-c C-e v R
6459 Export only the visible part of the document.
6460 @item M-x org-export-region-as-html
6461 Convert the region to HTML under the assumption that it was org-mode
6462 syntax before.  This is a global command that can be invoked in any
6463 buffer.
6464 @item M-x org-replace-region-by-HTML
6465 Replace the active region (assumed to be in Org-mode syntax) by HTML
6466 code.
6467 @end table
6469 @cindex headline levels, for exporting
6470 In the exported version, the first 3 outline levels will become
6471 headlines, defining a general document structure.  Additional levels
6472 will be exported as itemized lists.  If you want that transition to occur
6473 at a different level, specify it with a prefix argument.  For example,
6475 @example
6476 @kbd{C-2 C-c C-e b}
6477 @end example
6479 @noindent
6480 creates two levels of headings and does the rest as items.
6482 @node Quoting HTML tags, Links, HTML Export commands, HTML export
6483 @subsection Quoting HTML tags
6485 Plain @samp{<} and @samp{>} are always transformed to @samp{&lt;} and
6486 @samp{&gt;} in HTML export.  If you want to include simple HTML tags
6487 which should be interpreted as such, mark them with @samp{@@} as in
6488 @samp{@@<b>bold text@@</b>}.  Note that this really works only for
6489 simple tags.  For more extensive HTML that should be copied verbatim to
6490 the exported file use either
6492 @example
6493 #+HTML: Literal HTML code for export
6494 @end example
6496 @noindent or
6498 @example
6499 #+BEGIN_HTML
6500 All lines between these markers are exported literally
6501 #+END_HTML
6502 @end example
6505 @node Links, Images, Quoting HTML tags, HTML export
6506 @subsection Links
6508 @cindex links, in HTML export
6509 @cindex internal links, in HTML export
6510 @cindex external links, in HTML export
6511 Internal links (@pxref{Internal links}) will continue to work in HTML
6512 files only if they match a dedicated @samp{<<target>>}.  Automatic links
6513 created by radio targets (@pxref{Radio targets}) will also work in the
6514 HTML file.  Links to external files will still work if the HTML file is
6515 in the same directory as the Org-mode file.  Links to other @file{.org}
6516 files will be translated into HTML links under the assumption that an
6517 HTML version also exists of the linked file.  For information related to
6518 linking files while publishing them to a publishing directory see
6519 @ref{Publishing links}.
6521 @node Images, CSS support, Links, HTML export
6522 @subsection Images
6524 @cindex images, inline in HTML
6525 @cindex inlining images in HTML
6526 HTML export can inline images given as links in the Org-mode file, and
6527 it can make an image the clickable part of a link.  By
6528 default@footnote{but see the variable
6529 @code{org-export-html-inline-images}}, images are inlined if a link does
6530 not have a description.  So @samp{[[file:myimg.jpg]]} will be inlined,
6531 while @samp{[[file:myimg.jpg][the image]]} will just produce a link
6532 @samp{the image} that points to the image.  If the description part
6533 itself is a @code{file:} link or a @code{http:} URL pointing to an
6534 image, this image will be inlined and activated so that clicking on the
6535 image will activate the link.  For example, to include a thumbnail that
6536 will link to a high resolution version of the image, you could use:
6538 @example
6539 [[file:highres.jpg][file:thumb.jpg]]
6540 @end example
6542 @noindent
6543 and you could use @code{http} addresses just as well.
6545 @node CSS support,  , Images, HTML export
6546 @subsection CSS support
6548 You can also give style information for the exported file.  The HTML
6549 exporter assigns the following CSS classes to appropriate parts of the
6550 document - your style specifications may change these:
6551 @example
6552 .todo           @r{TODO keywords}
6553 .done           @r{the DONE keyword}
6554 .timestamp      @r{time stamp}
6555 .timestamp-kwd  @r{keyword associated with a time stamp, like SCHEDULED}
6556 .tag            @r{tag in a headline}
6557 .target         @r{target for links}
6558 @end example
6560 The default style specification can be configured through the option
6561 @code{org-export-html-style}.  If you want to use a file-local style,
6562 you may use file variables, best wrapped into a COMMENT section at the
6563 end of the outline tree.  For example@footnote{Under Emacs 21, the
6564 continuation lines for a variable value should have no @samp{#} at the
6565 start of the line.}:
6567 @example
6568 * COMMENT html style specifications
6570 # Local Variables:
6571 # org-export-html-style: "   <style type=\"text/css\">
6572 #       p @{font-weight: normal; color: gray; @}
6573 #       h1 @{color: black; @}
6574 #   </style>"
6575 # End:
6576 @end example
6578 Remember to execute @kbd{M-x normal-mode} after changing this to make
6579 the new style visible to Emacs.  This command restarts org-mode for the
6580 current buffer and forces Emacs to re-evaluate the local variables
6581 section in the buffer.
6583 @c FIXME: More about header and footer styles
6584 @c FIXME: Talk about links and targets.
6586 @node LaTeX export, XOXO export, HTML export, Exporting
6587 @section LaTeX export
6588 @cindex LaTeX export
6590 Org-mode contains a La@TeX{} exporter written by Bastien Guerry.
6592 @menu
6593 * LaTeX export commands::       How to invoke LaTeX export
6594 * Quoting LaTeX code::          Incorporating literal LaTeX code
6595 * Sectioning structure::
6596 @end menu
6598 @node LaTeX export commands, Quoting LaTeX code, LaTeX export, LaTeX export
6599 @subsection LaTeX export commands
6601 @table @kbd
6602 @kindex C-c C-e l
6603 @item C-c C-e l
6604 Export as La@TeX{} file @file{myfile.tex}.
6605 @kindex C-c C-e L
6606 @item C-c C-e L
6607 Export to a temporary buffer, do not create a file.
6608 @kindex C-c C-e v l
6609 @kindex C-c C-e v L
6610 @item C-c C-e v l
6611 @item C-c C-e v L
6612 Export only the visible part of the document.
6613 @item M-x org-export-region-as-latex
6614 Convert the region to La@TeX{} under the assumption that it was org-mode
6615 syntax before.  This is a global command that can be invoked in any
6616 buffer.
6617 @item M-x org-replace-region-by-latex
6618 Replace the active region (assumed to be in Org-mode syntax) by La@TeX{}
6619 code.
6620 @end table
6622 @cindex headline levels, for exporting
6623 In the exported version, the first 3 outline levels will become
6624 headlines, defining a general document structure.  Additional levels
6625 will be exported as description lists.  The exporter can ignore them or
6626 convert them to a custom string depending on
6627 @code{org-latex-low-levels}.
6629 If you want that transition to occur at a different level, specify it
6630 with a prefix argument. For example,
6632 @example
6633 @kbd{C-2 C-c C-e l}
6634 @end example
6636 @noindent
6637 creates two levels of headings and does the rest as items.
6639 @node Quoting LaTeX code, Sectioning structure, LaTeX export commands, LaTeX export
6640 @subsection Quoting LaTeX code
6642 Embedded La@TeX{} as described in @ref{Embedded LaTeX} will be correctly
6643 inserted into the La@TeX{} file.  Forthermore, you can add special code
6644 that should only be present in La@TeX{} export with the following
6645 constructs:
6647 @example
6648 #+LaTeX: Literal LaTeX code for export
6649 @end example
6651 @noindent or
6653 @example
6654 #+BEGIN_LaTeX
6655 All lines between these markers are exported literally
6656 #+END_LaTeX
6657 @end example
6661 @node   Sectioning structure,  , Quoting LaTeX code, LaTeX export
6662 @subsection Sectioning structure
6663 @cindex LaTeX class
6664 @cindex LaTeX sectioning structure
6666 By default, the La@TeX{} output uses the class @code{article}.
6668 You can change this globally by setting a different value for
6669 @code{org-export-latex-default-class} or locally by adding an option
6670 like @code{#+LaTeX_CLASS: myclass} in your file.  The class should be
6671 listed in @code{org-export-latex-classes}, where you can also define the
6672 sectioning structure for each class.
6675 @node XOXO export, iCalendar export, LaTeX export, Exporting
6676 @section XOXO export
6677 @cindex XOXO export
6679 Org-mode contains an exporter that produces XOXO-style output.
6680 Currently, this exporter only handles the general outline structure and
6681 does not interpret any additional Org-mode features.
6683 @table @kbd
6684 @kindex C-c C-e x
6685 @item C-c C-e x
6686 Export as XOXO file @file{myfile.html}.
6687 @kindex C-c C-e v
6688 @item C-c C-e v x
6689 Export only the visible part of the document.
6690 @end table
6692 @node iCalendar export, Text interpretation, XOXO export, Exporting
6693 @section iCalendar export
6694 @cindex iCalendar export
6696 Some people like to use Org-mode for keeping track of projects, but
6697 still prefer a standard calendar application for anniversaries and
6698 appointments.  In this case it can be useful to have deadlines and
6699 other time-stamped items in Org-mode files show up in the calendar
6700 application.  Org-mode can export calendar information in the standard
6701 iCalendar format.  If you also want to have TODO entries included in the
6702 export, configure the variable @code{org-icalendar-include-todo}.
6704 @table @kbd
6705 @kindex C-c C-e i
6706 @item C-c C-e i
6707 Create iCalendar entries for the current file and store them in the same
6708 directory, using a file extension @file{.ics}.
6709 @kindex C-c C-e I
6710 @item C-c C-e I
6711 Like @kbd{C-c C-e i}, but do this for all files in
6712 @code{org-agenda-files}.  For each of these files, a separate iCalendar
6713 file will be written.
6714 @kindex C-c C-e c
6715 @item C-c C-e c
6716 Create a single large iCalendar file from all files in
6717 @code{org-agenda-files} and write it to the file given by
6718 @code{org-combined-agenda-icalendar-file}.
6719 @end table
6721 The export will honor SUMMARY, DESCRIPTION and LOCATION properties if
6722 the selected entries have them.  If not, the summary will be derived
6723 from the headline, and the description from the body (limited to
6724 @code{org-icalendar-include-body} characters).
6726 How this calendar is best read and updated, depends on the application
6727 you are using.  The FAQ covers this issue.
6730 @node Text interpretation,  , iCalendar export, Exporting
6731 @section Text interpretation by the exporter
6733 The exporter backends interpret additional structure in the Org-mode file
6734 in order to produce better output.
6736 @menu
6737 * Comment lines::               Some lines will not be exported
6738 * Initial text::                Text before the first headline
6739 * Footnotes::                   Numbers like [1]
6740 * Quoted examples::             Inserting quoted chnuks of text
6741 * Enhancing text::              Subscripts, symbols and more
6742 * Export options::              How to influence the export settings
6743 @end menu
6745 @node Comment lines, Initial text, Text interpretation, Text interpretation
6746 @subsection Comment lines
6747 @cindex comment lines
6748 @cindex exporting, not
6750 Lines starting with @samp{#} in column zero are treated as comments
6751 and will never be exported.  Also entire subtrees starting with the
6752 word @samp{COMMENT} will never be exported.
6754 @table @kbd
6755 @kindex C-c ;
6756 @item C-c ;
6757 Toggle the COMMENT keyword at the beginning of an entry.
6758 @end table
6760 @node Initial text, Footnotes, Comment lines, Text interpretation
6761 @subsection Text before the first headline
6763 Org-mode normally ignores any text before the first headline when
6764 exporting, leaving this region for internal links to speed up navigation
6765 etc.  However, in publishing-oriented files, you might want to have some
6766 text before the first headline, like a small introduction, special HTML
6767 code with a navigation bar, etc.  You can ask to have this part of the
6768 file exported as well by setting the variable
6769 @code{org-export-skip-text-before-1st-heading} to @code{nil}.  On a
6770 per-file basis, you can get the same effect with
6772 @example
6773 #+OPTIONS: skip:nil
6774 @end example
6776 The text before the first headline will be fully processed
6777 (@pxref{Enhancing text}), and the first non-comment line becomes the
6778 title of the exported document.  If you need to include literal HTML,
6779 use the special constructs described in @ref{Quoting HTML tags}.  The
6780 table of contents is normally inserted directly before the first
6781 headline of the file.  If you would like to get it to a different
6782 location, insert the string @code{[TABLE-OF-CONTENTS]} on a line by
6783 itself at the desired location.
6785 Finally, if you want to use the space before the first headline for
6786 internal purposes, but @emph{still} want to place something before the
6787 first headline when exporting the file, you can use the @code{#+TEXT}
6788 construct:
6790 @example
6791 #+OPTIONS: skip:t
6792 #+TEXT: This text will go before the *first* headline.
6793 #+TEXT: We place the table of contents here:
6794 #+TEXT: [TABLE-OF-CONTENTS]
6795 #+TEXT: This goes between the table of contents and the first headline
6796 @end example
6798 @node Footnotes, Quoted examples, Initial text, Text interpretation
6799 @subsection Footnotes
6800 @cindex footnotes
6801 @cindex @file{footnote.el}
6803 Numbers in square brackets are treated as footnotes, so that you can use
6804 the Emacs package @file{footnote.el} to create footnotes.  For example:
6806 @example
6807 The org-mode homepage[1] clearly needs help from
6808 a good web designer.
6810 [1] The link is: http://orgmode.org
6811 @end example
6813 @noindent
6814 @kindex C-c !
6815 Note that the @file{footnote} package uses @kbd{C-c !} to invoke its
6816 commands.  This binding conflicts with the org-mode command for
6817 inserting inactive time stamps.  You could use the variable
6818 @code{footnote-prefix} to switch footnotes commands to another key.  Or,
6819 if you are too used to this binding, you could use
6820 @code{org-replace-disputed-keys} and @code{org-disputed-keys} to change
6821 the settings in Org-mode.
6823 @node Quoted examples, Enhancing text, Footnotes, Text interpretation
6824 @subsection Quoted examples
6825 @cindex quoted examples
6826 @cindex examples, quoted
6827 @cindex text, fixed width
6828 @cindex fixed width text
6830 When writing technical documents, you often need to insert examples that
6831 are not further interpreted by Org-mode.  For historical reasons, there
6832 are several ways to do this:
6834 @itemize @bullet
6835 @item
6836 If a headline starts with the word @samp{QUOTE}, the text below the
6837 headline will be typeset as fixed-width, to allow quoting of computer
6838 codes etc.
6839 @item
6840 Lines starting with @samp{:} are also typeset in fixed-width font.
6841 @table @kbd
6842 @kindex C-c :
6843 @item C-c :
6844 Toggle fixed-width for entry (QUOTE) or region, see below.
6845 @end table
6846 @item
6847 Finally, text between
6848 @example
6849 #+BEGIN_EXAMPLE
6850 quoted text
6851 #+END_EXAMPLE
6852 @end example
6853 will also be exported in this way.
6854 @end itemize
6857 @node Enhancing text, Export options, Quoted examples, Text interpretation
6858 @subsection Enhancing text for export
6859 @cindex enhancing text
6860 @cindex richer text
6862 Some of the export backends of Org-mode allow for sophisticated text
6863 formatting, this is true in particular for the HTML and La@TeX{}
6864 backends.  Org-mode has a number of typing conventions that allow to
6865 produce a richly formatted output.
6867 @itemize @bullet
6869 @cindex hand-formatted lists
6870 @cindex lists, hand-formatted
6871 @item
6872 Plain lists @samp{-}, @samp{*} or @samp{+} as bullet, or with @samp{1.}
6873 or @samp{2)} as enumerator will be recognized and transformed if the
6874 backend supports lists.  See @xref{Plain lists}.
6876 @cindex underlined text
6877 @cindex bold text
6878 @cindex italic text
6879 @cindex verbatim text
6880 @item
6881 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=}
6882 and @code{~verbatim~}, and, if you must, @samp{+strikethrough+}.  Text
6883 in the code and verbatim string is not processed for org-mode specific
6884 syntax, it is exported verbatim.
6886 @cindex horizontal rules, in exported files
6887 @item
6888 A line consisting of only dashes, and at least 5 of them, will be
6889 exported as a horizontal line (@samp{<hr/>} in HTML).
6891 @cindex LaTeX fragments, export
6892 @cindex TeX macros, export
6893 @item
6894 Many @TeX{} macros and entire La@TeX{} fragments are converted into HTML
6895 entities or images (@pxref{Embedded LaTeX}).
6897 @cindex tables, export
6898 @item
6899 Tables are transformed into native tables under the exporter, if the
6900 export backend supports this. Data fields before the first horizontal
6901 separator line will be formatted as table header fields.
6903 @cindex fixed width
6904 @item
6905 If a headline starts with the word @samp{QUOTE}, the text below the
6906 headline will be typeset as fixed-width, to allow quoting of computer
6907 codes etc.  Lines starting with @samp{:} are also typeset in fixed-width
6908 font.
6909 @table @kbd
6910 @kindex C-c :
6911 @item C-c :
6912 Toggle fixed-width for entry (QUOTE) or region, see below.
6913 @end table
6914 Finally, text between
6915 @example
6916 #+BEGIN_EXAMPLE
6917 quoted text
6918 #+END_EXAMPLE
6919 @end example
6920 will also be exported in this way.
6922 @cindex linebreak, forced
6923 @item
6924 A double backslash @emph{at the end of a line} enforces a line break at
6925 this position.
6927 @cindex HTML entities, LaTeX entities
6928 @item
6929 Strings like @code{\alpha} will be exported as @code{&alpha;}, in the
6930 HTML output.  These strings are exported as @code{$\alpha$} in the
6931 La@TeX{} output.  Similarly, @code{\nbsp} will become @code{&nbsp;} in
6932 HTML and in La@TeX{}.  This applies for a long list of entities, see
6933 the variable @code{org-html-entities} for the complete list.
6934 @c FIXME
6935 @end itemize
6937 If these conversions conflict with your habits of typing ASCII text,
6938 they can all be turned off with corresponding variables.  See the
6939 customization group @code{org-export-general}, and the following section
6940 which explains how to set export options with special lines in a
6941 buffer.
6944 @node Export options,  , Enhancing text, Text interpretation
6945 @subsection Export options
6946 @cindex options, for export
6948 @cindex completion, of option keywords
6949 The exporter recognizes special lines in the buffer which provide
6950 additional information.  These lines may be put anywhere in the file.
6951 The whole set of lines can be inserted into the buffer with @kbd{C-c
6952 C-e t}.  For individual lines, a good way to make sure the keyword is
6953 correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion
6954 (@pxref{Completion}).
6956 @table @kbd
6957 @kindex C-c C-e t
6958 @item C-c C-e t
6959 Insert template with export options, see example below.
6960 @end table
6962 @example
6963 #+TITLE:     the title to be shown (default is the buffer name)
6964 #+AUTHOR:    the author (default taken from @code{user-full-name})
6965 #+DATE:      A date, fixed, of a format string for @code{format-time-string}
6966 #+EMAIL:     his/her email address (default from @code{user-mail-address})
6967 #+LANGUAGE:  language for HTML, e.g. @samp{en} (@code{org-export-default-language})
6968 #+TEXT:      Some descriptive text to be inserted at the beginning.
6969 #+TEXT:      Several lines may be given.
6970 #+OPTIONS:   H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ...
6971 @end example
6973 @noindent
6974 The OPTIONS line is a compact form to specify export settings.  Here
6975 you can:
6976 @cindex headline levels
6977 @cindex section-numbers
6978 @cindex table of contents
6979 @cindex linebreak preservation
6980 @cindex quoted HTML tags
6981 @cindex fixed-width sections
6982 @cindex tables
6983 @cindex @TeX{}-like syntax for sub- and superscripts
6984 @cindex footnotes
6985 @cindex special strings
6986 @cindex emphasized text
6987 @cindex @TeX{} macros
6988 @cindex La@TeX{} fragments
6989 @cindex author info, in export
6990 @cindex time info, in export
6991 @example
6992 H:         @r{set the number of headline levels for export}
6993 num:       @r{turn on/off section-numbers}
6994 toc:       @r{turn on/off table of contents, or set level limit (integer)}
6995 \n:        @r{turn on/off linebreak-preservation}
6996 @@:         @r{turn on/off quoted HTML tags}
6997 ::         @r{turn on/off fixed-width sections}
6998 |:         @r{turn on/off tables}
6999 ^:         @r{turn on/off @TeX{}-like syntax for sub- and superscripts.  If}
7000            @r{you write "^:@{@}", @code{a_@{b@}} will be interpreted, but}
7001            @r{the simple @code{a_b} will be left as it is.}
7002 -:         @r{turn on/off conversion of special strings.}
7003 f:         @r{turn on/off foototes like this[1].}
7004 *:         @r{turn on/off emphasized text (bold, italic, underlined)}
7005 TeX:       @r{turn on/off simple @TeX{} macros in plain text}
7006 LaTeX:     @r{turn on/off La@TeX{} fragments}
7007 skip:      @r{turn on/off skipping the text before the first heading}
7008 author:    @r{turn on/off inclusion of author name/email into exported file}
7009 timestamp: @r{turn on/off inclusion creation time into exported file}
7010 d:         @r{turn on/off inclusion of drawers}
7011 @end example
7013 These options take effect in both the HTML and La@TeX{} export, except
7014 for @code{TeX} and @code{LaTeX}, which are respectively @code{t} and
7015 @code{nil} for the La@TeX{} export.
7017 @node Publishing, Miscellaneous, Exporting, Top
7018 @chapter Publishing
7019 @cindex publishing
7021 Org-mode includes@footnote{@file{org-publish.el} is not distributed with
7022 Emacs 21, if you are still using Emacs 21, you need you need to download
7023 this file separately.} a publishing management system that allows you to
7024 configure automatic HTML conversion of @emph{projects} composed of
7025 interlinked org files.  This system is called @emph{org-publish}.  You can
7026 also configure org-publish to automatically upload your exported HTML
7027 pages and related attachments, such as images and source code files, to
7028 a web server. Org-publish turns org-mode into a web-site authoring tool.
7030 You can also use Org-publish to convert files into La@TeX{}, or even
7031 combine HTML and La@TeX{} conversion so that files are available in both
7032 formats on the server@footnote{Since La@TeX{} files on a server are not
7033 that helpful, you surely want to perform further conversion on them --
7034 e.g. convert them to @code{PDF} format.}.
7036 Org-publish has been contributed to Org-mode by David O'Toole.
7038 @menu
7039 * Configuration::               Defining projects
7040 * Sample configuration::        Example projects
7041 * Triggering publication::      Publication commands
7042 @end menu
7044 @node Configuration, Sample configuration, Publishing, Publishing
7045 @section Configuration
7047 Publishing needs significant configuration to specify files, destination
7048 and many other properties of a project.
7050 @menu
7051 * Project alist::               The central configuration variable
7052 * Sources and destinations::    From here to there
7053 * Selecting files::             What files are part of the project?
7054 * Publishing action::           Setting the function doing the publishing
7055 * Publishing options::          Tweaking HTML export
7056 * Publishing links::            Which links keep working after publishing?
7057 * Project page index::          Publishing a list of project files
7058 @end menu
7060 @node Project alist, Sources and destinations, Configuration, Configuration
7061 @subsection The variable @code{org-publish-project-alist}
7062 @cindex org-publish-project-alist
7063 @cindex projects, for publishing
7065 Org-publish is configured almost entirely through setting the value of
7066 one variable, called @code{org-publish-project-alist}.
7067 Each element of the list configures one project, and may be in one of
7068 the two following forms:
7070 @lisp
7071 ("project-name" :property value :property value ...)
7073 @r{or}
7075 ("project-name" :components ("project-name" "project-name" ...))
7077 @end lisp
7079 In both cases, projects are configured by specifying property values.
7080 A project defines the set of files that will be published, as well as
7081 the publishing configuration to use when publishing those files.  When
7082 a project takes the second form listed above, the individual members
7083 of the ``components'' property are taken to be components of the
7084 project, which group together files requiring different publishing
7085 options. When you publish such a ``meta-project'' all the components
7086 will also publish.
7088 @node Sources and destinations, Selecting files, Project alist, Configuration
7089 @subsection Sources and destinations for files
7090 @cindex directories, for publishing
7092 Most properties are optional, but some should always be set. In
7093 particular, org-publish needs to know where to look for source files,
7094 and where to put published files.
7096 @multitable @columnfractions 0.3 0.7
7097 @item @code{:base-directory}
7098 @tab Directory containing publishing source files
7099 @item @code{:publishing-directory}
7100 @tab Directory (possibly remote) where output files will be published.
7101 @item @code{:preparation-function}
7102 @tab Function called before starting publishing process, for example to
7103 run @code{make} for updating files to be published.
7104 @end multitable
7105 @noindent
7107 @node Selecting files, Publishing action, Sources and destinations, Configuration
7108 @subsection Selecting files
7109 @cindex files, selecting for publishing
7111 By default, all files with extension @file{.org} in the base directory
7112 are considered part of the project.  This can be modified by setting the
7113 properties
7114 @multitable @columnfractions 0.25 0.75
7115 @item @code{:base-extension}
7116 @tab Extension (without the dot!) of source files.  This actually is a
7117 regular expression.
7119 @item @code{:exclude}
7120 @tab Regular expression to match file names that should not be
7121 published, even though they have been selected on the basis of their
7122 extension.
7124 @item @code{:include}
7125 @tab List of files to be included regardless of @code{:base-extension}
7126 and @code{:exclude}.
7127 @end multitable
7129 @node Publishing action, Publishing options, Selecting files, Configuration
7130 @subsection Publishing Action
7131 @cindex action, for publishing
7133 Publishing means that a file is copied to the destination directory and
7134 possibly transformed in the process.  The default transformation is to
7135 export Org-mode files as HTML files, and this is done by the function
7136 @code{org-publish-org-to-html} which calls the HTML exporter
7137 (@pxref{HTML export}). But you also can publish your files in La@TeX{} by
7138 using the function @code{org-publish-org-to-latex} instead. Other files
7139 like images only need to be copied to the publishing destination. For
7140 non-Org-mode files, you need to specify the publishing function.
7143 @multitable @columnfractions 0.3 0.7
7144 @item @code{:publishing-function}
7145 @tab Function executing the publication of a file.  This may also be a
7146 list of functions, which will all be called in turn.
7147 @end multitable
7149 The function must accept two arguments: a property list containing at
7150 least a @code{:publishing-directory} property, and the name of the file
7151 to be published.  It should take the specified file, make the necessary
7152 transformation (if any) and place the result into the destination folder.
7153 You can write your own publishing function, but @code{org-publish}
7154 provides one for attachments (files that only need to be copied):
7155 @code{org-publish-attachment}.
7157 @node Publishing options, Publishing links, Publishing action, Configuration
7158 @subsection Options for the HTML/LaTeX exporters
7159 @cindex options, for publishing
7161 The property list can be used to set many export options for the HTML
7162 and La@TeX{} exporters.  In most cases, these properties correspond to user
7163 variables in Org-mode.  The table below lists these properties along
7164 with the variable they belong to.  See the documentation string for the
7165 respective variable for details.
7167 @multitable @columnfractions 0.3 0.7
7168 @item @code{:language}              @tab @code{org-export-default-language}
7169 @item @code{:headline-levels}       @tab @code{org-export-headline-levels}
7170 @item @code{:section-numbers}       @tab @code{org-export-with-section-numbers}
7171 @item @code{:table-of-contents}     @tab @code{org-export-with-toc}
7172 @item @code{:archived-trees}        @tab @code{org-export-with-archived-trees}
7173 @item @code{:emphasize}             @tab @code{org-export-with-emphasize}
7174 @item @code{:sub-superscript}       @tab @code{org-export-with-sub-superscripts}
7175 @item @code{:special-strings}       @tab @code{org-export-with-special-strings}
7176 @item @code{:TeX-macros}            @tab @code{org-export-with-TeX-macros}
7177 @item @code{:LaTeX-fragments}       @tab @code{org-export-with-LaTeX-fragments}
7178 @item @code{:fixed-width}           @tab @code{org-export-with-fixed-width}
7179 @item @code{:timestamps}           .@tab @code{org-export-with-timestamps}
7180 @item @code{:tags}                 .@tab @code{org-export-with-tags}
7181 @item @code{:tables}                @tab @code{org-export-with-tables}
7182 @item @code{:table-auto-headline}   @tab @code{org-export-highlight-first-table-line}
7183 @item @code{:style}                 @tab @code{org-export-html-style}
7184 @item @code{:convert-org-links}     @tab @code{org-export-html-link-org-files-as-html}
7185 @item @code{:inline-images}         @tab @code{org-export-html-inline-images}
7186 @item @code{:expand-quoted-html}    @tab @code{org-export-html-expand}
7187 @item @code{:timestamp}             @tab @code{org-export-html-with-timestamp}
7188 @item @code{:publishing-directory}  @tab @code{org-export-publishing-directory}
7189 @item @code{:preamble}              @tab @code{org-export-html-preamble}
7190 @item @code{:postamble}             @tab @code{org-export-html-postamble}
7191 @item @code{:auto-preamble}         @tab @code{org-export-html-auto-preamble}
7192 @item @code{:auto-postamble}        @tab @code{org-export-html-auto-postamble}
7193 @item @code{:author}                @tab @code{user-full-name}
7194 @item @code{:email}                 @tab @code{user-mail-address}
7195 @end multitable
7197 If you use several email addresses, separate them by a semi-column.
7199 Most of the @code{org-export-with-*} variables have the same effect in
7200 both HTML and La@TeX{} exporters, except for @code{:TeX-macros} and
7201 @code{:LaTeX-fragments}, respectively @code{nil} and @code{t} in the
7202 La@TeX{} export.
7204 When a property is given a value in @code{org-publish-project-alist},
7205 its setting overrides the value of the corresponding user variable (if
7206 any) during publishing.  Options set within a file (@pxref{Export
7207 options}), however, override everything.
7209 @node Publishing links, Project page index, Publishing options, Configuration
7210 @subsection Links between published files
7211 @cindex links, publishing
7213 To create a link from one Org-mode file to another, you would use
7214 something like @samp{[[file:foo.org][The foo]]} or simply
7215 @samp{file:foo.org.} (@pxref{Hyperlinks}).  Upon publishing this link
7216 becomes a link to @file{foo.html}.  In this way, you can interlink the
7217 pages of your "org web" project and the links will work as expected when
7218 you publish them to HTML.
7220 You may also link to related files, such as images. Provided you are
7221 careful with relative pathnames, and provided you have also configured
7222 @code{org-publish} to upload the related files, these links will work
7223 too. @ref{Complex example} for an example of this usage.
7225 Sometime an Org-mode file to be published may contain links that are
7226 only valid in your production environment, but not in the publishing
7227 location.  In this case, use the property
7229 @multitable @columnfractions 0.4 0.6
7230 @item @code{:link-validation-function}
7231 @tab Function to validate links
7232 @end multitable
7234 @noindent
7235 to define a function for checking link validity.  This function must
7236 accept two arguments, the file name and a directory relative to which
7237 the file name is interpreted in the production environment.  If this
7238 function returns @code{nil}, then the HTML generator will only insert a
7239 description into the HTML file, but no link.  One option for this
7240 function is @code{org-publish-validate-link} which checks if the given
7241 file is part of any project in @code{org-publish-project-alist}.
7243 @node Project page index,  , Publishing links, Configuration
7244 @subsection Project page index
7245 @cindex index, of published pages
7247 The following properties may be used to control publishing of an
7248 index of files or summary page for a given project.
7250 @multitable @columnfractions 0.25 0.75
7251 @item @code{:auto-index}
7252 @tab When non-nil, publish an index during org-publish-current-project or
7253 org-publish-all.
7255 @item @code{:index-filename}
7256 @tab Filename for output of index. Defaults to @file{index.org} (which
7257 becomes @file{index.html}).
7259 @item @code{:index-title}
7260 @tab Title of index page. Defaults to name of file.
7262 @item @code{:index-function}
7263 @tab Plugin function to use for generation of index.
7264 Defaults to @code{org-publish-org-index}, which generates a plain list
7265 of links to all files in the project.
7266 @end multitable
7268 @node Sample configuration, Triggering publication, Configuration, Publishing
7269 @section Sample configuration
7271 Below we provide two example configurations.  The first one is a simple
7272 project publishing only a set of Org-mode files.  The second example is
7273 more complex, with a multi-component project.
7275 @menu
7276 * Simple example::              One-component publishing
7277 * Complex example::             A multi-component publishing example
7278 @end menu
7280 @node Simple example, Complex example, Sample configuration, Sample configuration
7281 @subsection Example: simple publishing configuration
7283 This example publishes a set of Org-mode files to the @file{public_html}
7284 directory on the local machine.
7286 @lisp
7287 (setq org-publish-project-alist
7288       '(("org"
7289          :base-directory "~/org/"
7290          :publishing-directory "~/public_html"
7291          :section-numbers nil
7292          :table-of-contents nil
7293          :style "<link rel=stylesheet
7294                 href=\"../other/mystyle.css\"
7295                 type=\"text/css\">")))
7296 @end lisp
7298 @node Complex example,  , Simple example, Sample configuration
7299 @subsection Example: complex publishing configuration
7301 This more complicated example publishes an entire website, including
7302 org files converted to HTML, image files, emacs lisp source code, and
7303 stylesheets. The publishing-directory is remote and private files are
7304 excluded.
7306 To ensure that links are preserved, care should be taken to replicate
7307 your directory structure on the web server, and to use relative file
7308 paths. For example, if your org files are kept in @file{~/org} and your
7309 publishable images in @file{~/images}, you'd link to an image with
7311 @example
7312 file:../images/myimage.png
7313 @end example
7315 On the web server, the relative path to the image should be the
7316 same. You can accomplish this by setting up an "images" folder in the
7317 right place on the webserver, and publishing images to it.
7319 @lisp
7320 (setq org-publish-project-alist
7321       '(("orgfiles"
7322           :base-directory "~/org/"
7323           :base-extension "org"
7324           :publishing-directory "/ssh:user@@host:~/html/notebook/"
7325           :publishing-function org-publish-org-to-html
7326           :exclude "PrivatePage.org"   ;; regexp
7327           :headline-levels 3
7328           :section-numbers nil
7329           :table-of-contents nil
7330           :style "<link rel=stylesheet
7331                   href=\"../other/mystyle.css\" type=\"text/css\">"
7332           :auto-preamble t
7333           :auto-postamble nil)
7335          ("images"
7336           :base-directory "~/images/"
7337           :base-extension "jpg\\|gif\\|png"
7338           :publishing-directory "/ssh:user@@host:~/html/images/"
7339           :publishing-function org-publish-attachment)
7341          ("other"
7342           :base-directory "~/other/"
7343           :base-extension "css\\|el"
7344           :publishing-directory "/ssh:user@@host:~/html/other/"
7345           :publishing-function org-publish-attachment)
7346          ("website" :components ("orgfiles" "images" "other"))))
7347 @end lisp
7349 @node Triggering publication,  , Sample configuration, Publishing
7350 @section Triggering publication
7352 Once org-publish is properly configured, you can publish with the
7353 following functions:
7355 @table @kbd
7356 @item C-c C-e C
7357 Prompt for a specific project and publish all files that belong to it.
7358 @item C-c C-e P
7359 Publish the project containing the current file.
7360 @item C-c C-e F
7361 Publish only the current file.
7362 @item C-c C-e A
7363 Publish all projects.
7364 @end table
7366 Org uses timestamps to track when a file has changed. The above
7367 functions normally only publish changed files. You can override this and
7368 force publishing of all files by giving a prefix argument.
7370 @node Miscellaneous, Extensions and Hacking, Publishing, Top
7371 @chapter Miscellaneous
7373 @menu
7374 * Completion::                  M-TAB knows what you need
7375 * Customization::               Adapting Org-mode to your taste
7376 * In-buffer settings::          Overview of the #+KEYWORDS
7377 * The very busy C-c C-c key::   When in doubt, press C-c C-c
7378 * Clean view::                  Getting rid of leading stars in the outline
7379 * TTY keys::                    Using Org-mode on a tty
7380 * Interaction::                 Other Emacs packages
7381 * Bugs::                        Things which do not work perfectly
7382 @end menu
7384 @node Completion, Customization, Miscellaneous, Miscellaneous
7385 @section Completion
7386 @cindex completion, of @TeX{} symbols
7387 @cindex completion, of TODO keywords
7388 @cindex completion, of dictionary words
7389 @cindex completion, of option keywords
7390 @cindex completion, of tags
7391 @cindex completion, of property keys
7392 @cindex completion, of link abbreviations
7393 @cindex @TeX{} symbol completion
7394 @cindex TODO keywords completion
7395 @cindex dictionary word completion
7396 @cindex option keyword completion
7397 @cindex tag completion
7398 @cindex link abbreviations, completion of
7400 Org-mode supports in-buffer completion.  This type of completion does
7401 not make use of the minibuffer.  You simply type a few letters into
7402 the buffer and use the key to complete text right there.
7404 @table @kbd
7405 @kindex M-@key{TAB}
7406 @item M-@key{TAB}
7407 Complete word at point
7408 @itemize @bullet
7409 @item
7410 At the beginning of a headline, complete TODO keywords.
7411 @item
7412 After @samp{\}, complete @TeX{} symbols supported by the exporter.
7413 @item
7414 After @samp{*}, complete headlines in the current buffer so that they
7415 can be used in search links like @samp{[[*find this headline]]}.
7416 @item
7417 After @samp{:} in a headline, complete tags.  The list of tags is taken
7418 from the variable @code{org-tag-alist} (possibly set through the
7419 @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
7420 dynamically from all tags used in the current buffer.
7421 @item
7422 After @samp{:} and not in a headline, complete property keys.  The list
7423 of keys is constructed dynamically from all keys used in the current
7424 buffer.
7425 @item
7426 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
7427 @item
7428 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
7429 @samp{OPTIONS} which set file-specific options for Org-mode.  When the
7430 option keyword is already complete, pressing @kbd{M-@key{TAB}} again
7431 will insert example settings for this keyword.
7432 @item
7433 In the line after @samp{#+STARTUP: }, complete startup keywords,
7434 i.e. valid keys for this line.
7435 @item
7436 Elsewhere, complete dictionary words using ispell.
7437 @end itemize
7438 @end table
7440 @node Customization, In-buffer settings, Completion, Miscellaneous
7441 @section Customization
7442 @cindex customization
7443 @cindex options, for customization
7444 @cindex variables, for customization
7446 There are more than 180 variables that can be used to customize
7447 Org-mode.  For the sake of compactness of the manual, I am not
7448 describing the variables here.  A structured overview of customization
7449 variables is available with @kbd{M-x org-customize}.  Or select
7450 @code{Browse Org Group} from the @code{Org->Customization} menu.  Many
7451 settings can also be activated on a per-file basis, by putting special
7452 lines into the buffer (@pxref{In-buffer settings}).
7454 @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous
7455 @section Summary of in-buffer settings
7456 @cindex in-buffer settings
7457 @cindex special keywords
7459 Org-mode uses special lines in the buffer to define settings on a
7460 per-file basis.  These lines start with a @samp{#+} followed by a
7461 keyword, a colon, and then individual words defining a setting.  Several
7462 setting words can be in the same line, but you can also have multiple
7463 lines for the keyword.  While these settings are described throughout
7464 the manual, here is a summary.  After changing any of those lines in the
7465 buffer, press @kbd{C-c C-c} with the cursor still in the line to
7466 activate the changes immediately.  Otherwise they become effective only
7467 when the file is visited again in a new Emacs session.
7469 @table @kbd
7470 @item #+ARCHIVE: %s_done::
7471 This line sets the archive location for the agenda file.  It applies for
7472 all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
7473 of the file.  The first such line also applies to any entries before it.
7474 The corresponding variable is @code{org-archive-location}.
7475 @item #+CATEGORY:
7476 This line sets the category for the agenda file.  The category applies
7477 for all subsequent lines until the next @samp{#+CATEGORY} line, or the
7478 end of the file.  The first such line also applies to any entries before it.
7479 @item #+COLUMNS: %25ITEM .....
7480 Set the default format for columns view.  This format applies when
7481 columns view is invoked in location where no @code{COLUMNS} property
7482 applies.
7483 @item #+CONSTANTS: name1=value1 ...
7484 Set file-local values for constants to be used in table formulas.  This
7485 line set the local variable @code{org-table-formula-constants-local}.
7486 The global version of this variable is
7487 @code{org-table-formula-constants}.
7488 @item #+DRAWERS: NAME1 .....
7489 Set the file-local set of drawers.  The corresponding global variable is
7490 @code{org-drawers}.
7491 @item #+LINK:  linkword replace
7492 These lines (several are allowed) specify link abbreviations.
7493 @xref{Link abbreviations}.  The corresponding variable is
7494 @code{org-link-abbrev-alist}.
7495 @item #+PRIORITIES: highest lowest default
7496 This line sets the limits and the default for the priorities.  All three
7497 must be either letters A-Z or numbers 0-9.  The highest priority must
7498 have a lower ASCII number that the lowest priority.
7499 @item #+PROPERTY: Property_Name Value
7500 This line sets a default inheritance value for entries in the current
7501 buffer, most useful for specifying the allowed values of a property.
7502 @item #+STARTUP:
7503 This line sets options to be used at startup of Org-mode, when an
7504 Org-mode file is being visited.  The first set of options deals with the
7505 initial visibility of the outline tree.  The corresponding variable for
7506 global default settings is @code{org-startup-folded}, with a default
7507 value @code{t}, which means @code{overview}.
7508 @cindex @code{overview}, STARTUP keyword
7509 @cindex @code{content}, STARTUP keyword
7510 @cindex @code{showall}, STARTUP keyword
7511 @example
7512 overview   @r{top-level headlines only}
7513 content    @r{all headlines}
7514 showall    @r{no folding at all, show everything}
7515 @end example
7516 Then there are options for aligning tables upon visiting a file.  This
7517 is useful in files containing narrowed table columns.  The corresponding
7518 variable is @code{org-startup-align-all-tables}, with a default value
7519 @code{nil}.
7520 @cindex @code{align}, STARTUP keyword
7521 @cindex @code{noalign}, STARTUP keyword
7522 @example
7523 align      @r{align all tables}
7524 noalign    @r{don't align tables on startup}
7525 @end example
7526 Logging closing and reinstating TODO items, and clock intervals
7527 (variables @code{org-log-done}, @code{org-log-note-clock-out}, and
7528 @code{org-log-repeat}) can be configured using these options.
7529 @cindex @code{logdone}, STARTUP keyword
7530 @cindex @code{lognotedone}, STARTUP keyword
7531 @cindex @code{nologdone}, STARTUP keyword
7532 @cindex @code{lognoteclock-out}, STARTUP keyword
7533 @cindex @code{nolognoteclock-out}, STARTUP keyword
7534 @cindex @code{logrepeat}, STARTUP keyword
7535 @cindex @code{lognoterepeat}, STARTUP keyword
7536 @cindex @code{nologrepeat}, STARTUP keyword
7537 @example
7538 logdone            @r{record a timestamp when an item is marked DONE}
7539 lognotedone        @r{record timestamp and a note when DONE}
7540 nologdone          @r{don't record when items are marked DONE}
7541 logrepeat          @r{record a time when reinstating a repeating item}
7542 lognoterepeat      @r{record a note when reinstating a repeating item}
7543 nologrepeat        @r{do not record when reinstating repeating item}
7544 lognoteclock-out   @r{record a note when clocking out}
7545 nolognoteclock-out @r{don't record a note when clocking out}
7546 @end example
7547 Here are the options for hiding leading stars in outline headings.  The
7548 corresponding variables are @code{org-hide-leading-stars} and
7549 @code{org-odd-levels-only}, both with a default setting @code{nil}
7550 (meaning @code{showstars} and @code{oddeven}).
7551 @cindex @code{hidestars}, STARTUP keyword
7552 @cindex @code{showstars}, STARTUP keyword
7553 @cindex @code{odd}, STARTUP keyword
7554 @cindex @code{even}, STARTUP keyword
7555 @example
7556 hidestars  @r{make all but one of the stars starting a headline invisible.}
7557 showstars  @r{show all stars starting a headline}
7558 odd        @r{allow only odd outline levels (1,3,...)}
7559 oddeven    @r{allow all outline levels}
7560 @end example
7561 To turn on custom format overlays over time stamps (variables
7562 @code{org-put-time-stamp-overlays} and
7563 @code{org-time-stamp-overlay-formats}), use
7564 @cindex @code{customtime}, STARTUP keyword
7565 @example
7566 customtime @r{overlay custom time format}
7567 @end example
7568 The following options influence the table spreadsheet (variable
7569 @code{constants-unit-system}).
7570 @cindex @code{constcgs}, STARTUP keyword
7571 @cindex @code{constSI}, STARTUP keyword
7572 @example
7573 constcgs   @r{@file{constants.el} should use the c-g-s unit system}
7574 constSI    @r{@file{constants.el} should use the SI unit system}
7575 @end example
7576 @item #+TAGS:  TAG1(c1) TAG2(c2)
7577 These lines (several such lines are allowed) specify the valid tags in
7578 this file, and (potentially) the corresponding @emph{fast tag selection}
7579 keys.  The corresponding variable is @code{org-tag-alist}.
7580 @item #+TBLFM:
7581 This line contains the formulas for the table directly above the line.
7582 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS, #+DATE:
7583 These lines provide settings for exporting files.  For more details see
7584 @ref{Export options}.
7585 @item #+SEQ_TODO:   #+TYP_TODO:
7586 These lines set the TODO keywords and their interpretation in the
7587 current file.  The corresponding variables are @code{org-todo-keywords}
7588 and @code{org-todo-interpretation}.
7589 @end table
7591 @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous
7592 @section The very busy C-c C-c key
7593 @kindex C-c C-c
7594 @cindex C-c C-c, overview
7596 The key @kbd{C-c C-c} has many purposes in org-mode, which are all
7597 mentioned scattered throughout this manual.  One specific function of
7598 this key is to add @emph{tags} to a headline (@pxref{Tags}).  In many
7599 other circumstances it means something like @emph{Hey Org-mode, look
7600 here and update according to what you see here}.  Here is a summary of
7601 what this means in different contexts.
7603 @itemize @minus
7604 @item
7605 If there are highlights in the buffer from the creation of a sparse
7606 tree, or from clock display, remove these highlights.
7607 @item
7608 If the cursor is in one of the special @code{#+KEYWORD} lines, this
7609 triggers scanning the buffer for these lines and updating the
7610 information.
7611 @item
7612 If the cursor is inside a table, realign the table.  This command
7613 works even if the automatic table editor has been turned off.
7614 @item
7615 If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
7616 the entire table.
7617 @item
7618 If the cursor is inside a table created by the @file{table.el} package,
7619 activate that table.
7620 @item
7621 If the current buffer is a remember buffer, close the note and file it.
7622 With a prefix argument, file it, without further interaction, to the
7623 default location.
7624 @item
7625 If the cursor is on a @code{<<<target>>>}, update radio targets and
7626 corresponding links in this buffer.
7627 @item
7628 If the cursor is in a property line or at the start or end of a property
7629 drawer, offer property commands.
7630 @item
7631 If the cursor is in a plain list item with a checkbox, toggle the status
7632 of the checkbox.
7633 @item
7634 If the cursor is on a numbered item in a plain list, renumber the
7635 ordered list.
7636 @item
7637 If the cursor is on the @code{#+BEGIN} line of a dynamical block, the
7638 block is updated.
7639 @end itemize
7641 @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous
7642 @section A cleaner outline view
7643 @cindex hiding leading stars
7644 @cindex clean outline view
7646 Some people find it noisy and distracting that the Org-mode headlines
7647 are starting with a potentially large number of stars.  For example
7648 the tree from @ref{Headlines}:
7650 @example
7651 * Top level headline
7652 ** Second level
7653 *** 3rd level
7654     some text
7655 *** 3rd level
7656     more text
7657 * Another top level headline
7658 @end example
7660 @noindent
7661 Unfortunately this is deeply ingrained into the code of Org-mode and
7662 cannot be easily changed.  You can, however, modify the display in such
7663 a way that all leading stars become invisible and the outline more easy
7664 to read.  To do this, customize the variable
7665 @code{org-hide-leading-stars} like this:
7667 @lisp
7668 (setq org-hide-leading-stars t)
7669 @end lisp
7671 @noindent
7672 or change this on a per-file basis with one of the lines (anywhere in
7673 the buffer)
7675 @example
7676 #+STARTUP: showstars
7677 #+STARTUP: hidestars
7678 @end example
7680 @noindent
7681 Press @kbd{C-c C-c} with the cursor in a @samp{STARTUP} line to activate
7682 the modifications.
7684 With stars hidden, the tree becomes:
7686 @example
7687 * Top level headline
7688  * Second level
7689   * 3rd level
7690     some text
7691   * 3rd level
7692     more text
7693 * Another top level headline
7694 @end example
7696 @noindent
7697 Note that the leading stars are not truly replaced by whitespace, they
7698 are only fontified with the face @code{org-hide} that uses the
7699 background color as font color.  If you are not using either white or
7700 black background, you may have to customize this face to get the wanted
7701 effect.  Another possibility is to set this font such that the extra
7702 stars are @i{almost} invisible, for example using the color
7703 @code{grey90} on a white background.
7705 Things become cleaner still if you skip all the even levels and use only
7706 odd levels 1, 3, 5..., effectively adding two stars to go from one
7707 outline level to the next:
7709 @example
7710 * Top level headline
7711   * Second level
7712     * 3rd level
7713       some text
7714     * 3rd level
7715       more text
7716 * Another top level headline
7717 @end example
7719 @noindent
7720 In order to make the structure editing and export commands handle this
7721 convention correctly, use
7723 @lisp
7724 (setq org-odd-levels-only t)
7725 @end lisp
7727 @noindent
7728 or set this on a per-file basis with one of the following lines (don't
7729 forget to press @kbd{C-c C-c} with the cursor in the startup line to
7730 activate changes immediately).
7732 @example
7733 #+STARTUP: odd
7734 #+STARTUP: oddeven
7735 @end example
7737 You can convert an Org-mode file from single-star-per-level to the
7738 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
7739 RET} in that file.  The reverse operation is @kbd{M-x
7740 org-convert-to-oddeven-levels}.
7742 @node TTY keys, Interaction, Clean view, Miscellaneous
7743 @section Using org-mode on a tty
7744 @cindex tty keybindings
7746 Because Org-mode contains a large number of commands, by default much of
7747 Org-mode's core commands are bound to keys that are generally not
7748 accessible on a tty, such as the cursor keys (@key{left}, @key{right},
7749 @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
7750 together with modifiers like @key{Meta} and/or @key{Shift}.  To access
7751 these commands on a tty when special keys are unavailable, the following
7752 alternative bindings can be used.  The tty bindings below will likely be
7753 more cumbersome; you may find for some of the bindings below that a
7754 customized work-around suits you better.  For example, changing a time
7755 stamp is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
7756 tty you would rather use @kbd{C-c .} to re-insert the timestamp.
7758 @multitable @columnfractions 0.15 0.2 0.2
7759 @item @b{Default} @tab @b{Alternative 1} @tab @b{Alternative 2}
7760 @item @kbd{S-@key{TAB}}     @tab @kbd{C-u @key{TAB}}       @tab
7761 @item @kbd{M-@key{left}}    @tab @kbd{C-c C-x l}           @tab @kbd{@key{Esc} @key{left}}
7762 @item @kbd{M-S-@key{left}}  @tab @kbd{C-c C-x L}           @tab
7763 @item @kbd{M-@key{right}}   @tab @kbd{C-c C-x r}           @tab @kbd{@key{Esc} @key{right}}
7764 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R}           @tab
7765 @item @kbd{M-@key{up}}      @tab @kbd{C-c C-x u}           @tab @kbd{@key{Esc} @key{up}}
7766 @item @kbd{M-S-@key{up}}    @tab @kbd{C-c C-x U}           @tab
7767 @item @kbd{M-@key{down}}    @tab @kbd{C-c C-x d}           @tab @kbd{@key{Esc} @key{down}}
7768 @item @kbd{M-S-@key{down}}  @tab @kbd{C-c C-x D}           @tab
7769 @item @kbd{S-@key{RET}}     @tab @kbd{C-c C-x c}           @tab
7770 @item @kbd{M-@key{RET}}     @tab @kbd{C-c C-x m}           @tab @kbd{@key{Esc} @key{RET}}
7771 @item @kbd{M-S-@key{RET}}   @tab @kbd{C-c C-x M}           @tab
7772 @item @kbd{S-@key{left}}    @tab @kbd{C-c @key{left}}      @tab
7773 @item @kbd{S-@key{right}}   @tab @kbd{C-c @key{right}}     @tab
7774 @item @kbd{S-@key{up}}      @tab @kbd{C-c @key{up}}        @tab
7775 @item @kbd{S-@key{down}}    @tab @kbd{C-c @key{down}}      @tab
7776 @item @kbd{C-S-@key{left}}  @tab @kbd{C-c C-x @key{left}}  @tab
7777 @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab
7778 @end multitable
7780 @node Interaction, Bugs, TTY keys, Miscellaneous
7781 @section Interaction with other packages
7782 @cindex packages, interaction with other
7783 Org-mode lives in the world of GNU Emacs and interacts in various ways
7784 with other code out there.
7786 @menu
7787 * Cooperation::                 Packages Org-mode cooperates with
7788 * Conflicts::                   Packages that lead to conflicts
7789 @end menu
7791 @node Cooperation, Conflicts, Interaction, Interaction
7792 @subsection Packages that Org-mode cooperates with
7794 @table @asis
7795 @cindex @file{calc.el}
7796 @item @file{calc.el} by Dave Gillespie
7797 Org-mode uses the calc package for implementing spreadsheet
7798 functionality in its tables (@pxref{The spreadsheet}).  Org-mode
7799 checks for the availability of calc by looking for the function
7800 @code{calc-eval} which should be autoloaded in your setup if calc has
7801 been installed properly.  As of Emacs 22, calc is part of the Emacs
7802 distribution.  Another possibility for interaction between the two
7803 packages is using calc for embedded calculations. @xref{Embedded Mode,
7804 , Embedded Mode, calc, GNU Emacs Calc Manual}.
7805 @cindex @file{constants.el}
7806 @item @file{constants.el} by Carsten Dominik
7807 In a table formula (@pxref{The spreadsheet}), it is possible to use
7808 names for natural constants or units.  Instead of defining your own
7809 constants in the variable @code{org-table-formula-constants}, install
7810 the @file{constants} package which defines a large number of constants
7811 and units, and lets you use unit prefixes like @samp{M} for
7812 @samp{Mega} etc.  You will need version 2.0 of this package, available
7813 at @url{http://www.astro.uva.nl/~dominik/Tools}. Org-mode checks for
7814 the function @code{constants-get}, which has to be autoloaded in your
7815 setup.  See the installation instructions in the file
7816 @file{constants.el}.
7817 @item @file{cdlatex.el} by Carsten Dominik
7818 @cindex @file{cdlatex.el}
7819 Org-mode can make use of the cdlatex package to efficiently enter
7820 La@TeX{} fragments into Org-mode files. See @ref{CDLaTeX mode}.
7821 @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
7822 @cindex @file{imenu.el}
7823 Imenu allows menu access to an index of items in a file.  Org-mode
7824 supports imenu - all you need to do to get the index is the following:
7825 @lisp
7826 (add-hook 'org-mode-hook
7827           (lambda () 'imenu-add-to-menubar "Imenu"))
7828 @end lisp
7829 By default the index is two levels deep - you can modify the depth using
7830 the option @code{org-imenu-depth}.
7831 @item @file{remember.el} by John Wiegley
7832 @cindex @file{remember.el}
7833 Org mode cooperates with remember, see @ref{Remember}.
7834 @file{Remember.el} is not part of Emacs, find it on the web.
7835 @item @file{speedbar.el} by Eric M. Ludlam
7836 @cindex @file{speedbar.el}
7837 Speedbar is a package that creates a special frame displaying files and
7838 index items in files.  Org-mode supports speedbar and allows you to
7839 drill into Org-mode files directly from the speedbar.  It also allows to
7840 restrict the scope of agenda commands to a file or a subtree by using
7841 the command @kbd{<} in the speedbar frame.
7842 @cindex @file{table.el}
7843 @item @file{table.el} by Takaaki Ota
7844 @kindex C-c C-c
7845 @cindex table editor, @file{table.el}
7846 @cindex @file{table.el}
7848 Complex ASCII tables with automatic line wrapping, column- and
7849 row-spanning, and alignment can be created using the Emacs table
7850 package by Takaaki Ota (@uref{http://sourceforge.net/projects/table},
7851 and also part of Emacs 22).
7852 When @key{TAB} or @kbd{C-c C-c} is pressed in such a table, Org-mode
7853 will call @command{table-recognize-table} and move the cursor into the
7854 table.  Inside a table, the keymap of Org-mode is inactive.  In order
7855 to execute Org-mode-related commands, leave the table.
7857 @table @kbd
7858 @kindex C-c C-c
7859 @item C-c C-c
7860 Recognize @file{table.el} table.  Works when the cursor is in a
7861 table.el table.
7863 @kindex C-c ~
7864 @item C-c ~
7865 Insert a table.el table.  If there is already a table at point, this
7866 command converts it between the table.el format and the Org-mode
7867 format.  See the documentation string of the command
7868 @code{org-convert-table} for the restrictions under which this is
7869 possible.
7870 @end table
7871 @file{table.el} is part of Emacs 22.
7872 @cindex @file{footnote.el}
7873 @item @file{footnote.el} by Steven L. Baur
7874 Org-mode recognizes numerical footnotes as provided by this package
7875 (@pxref{Footnotes}).
7876 @end table
7878 @node Conflicts,  , Cooperation, Interaction
7879 @subsection Packages that lead to conflicts with Org-mode
7881 @table @asis
7883 @cindex @file{allout.el}
7884 @item @file{allout.el} by Ken Manheimer
7885 Startup of Org-mode may fail with the error message
7886 @code{(wrong-type-argument keymapp nil)} when there is an outdated
7887 version @file{allout.el} on the load path, for example the version
7888 distributed with Emacs 21.x.  Upgrade to Emacs 22 and this problem will
7889 disappear.  If for some reason you cannot do this, make sure that org.el
7890 is loaded @emph{before} @file{allout.el}, for example by putting
7891 @code{(require 'org)} early enough into your @file{.emacs} file.
7893 @cindex @file{CUA.el}
7894 @item @file{CUA.el} by Kim. F. Storm
7895 Keybindings in Org-mode conflict with the @kbd{S-<cursor>} keys used by
7896 CUA-mode (as well as pc-select-mode and s-region-mode) to select and
7897 extend the region.  If you want to use one of these packages along with
7898 Org-mode, configure the variable @code{org-replace-disputed-keys}.  When
7899 set, Org-mode will move the following keybindings in Org-mode files, and
7900 in the agenda buffer (but not during date selection).
7902 @example
7903 S-UP    -> M-p             S-DOWN  -> M-n
7904 S-LEFT  -> M--             S-RIGHT -> M-+
7905 @end example
7907 Yes, these are unfortunately more difficult to remember.  If you want
7908 to have other replacement keys, look at the variable
7909 @code{org-disputed-keys}.
7910 @item @file{windmove.el} by Hovav Shacham
7911 @cindex @file{windmove.el}
7912 Also this package uses the @kbd{S-<cursor>} keys, so everything written
7913 in the paragraph above about CUA mode also applies here.
7915 @cindex @file{footnote.el}
7916 @item @file{footnote.el} by Steven L. Baur
7917 Org-mode supports the syntax of the footnote package, but only the
7918 numerical footnote markers.  Also, the default key for footnote
7919 commands, @kbd{C-c !} is already used by Org-mode.  You could use the
7920 variable @code{footnote-prefix} to switch footnotes commands to another
7921 key.  Or, you could use @code{org-replace-disputed-keys} and
7922 @code{org-disputed-keys} to change the settings in Org-mode.
7924 @end table
7927 @node Bugs,  , Interaction, Miscellaneous
7928 @section Bugs
7929 @cindex bugs
7931 Here is a list of things that should work differently, but which I
7932 have found too hard to fix.
7934 @itemize @bullet
7935 @item
7936 If a table field starts with a link, and if the corresponding table
7937 column is narrowed (@pxref{Narrow columns}) to a width too small to
7938 display the link, the field would look entirely empty even though it is
7939 not.  To prevent this, Org-mode throws an error.  The work-around is to
7940 make the column wide enough to fit the link, or to add some text (at
7941 least 2 characters) before the link in the same field.
7942 @item
7943 Narrowing table columns does not work on XEmacs, because the
7944 @code{format} function does not transport text properties.
7945 @item
7946 Text in an entry protected with the @samp{QUOTE} keyword should not
7947 autowrap.
7948 @item
7949 When the application called by @kbd{C-c C-o} to open a file link fails
7950 (for example because the application does not exist or refuses to open
7951 the file), it does so silently.  No error message is displayed.
7952 @item
7953 Recalculating a table line applies the formulas from left to right.
7954 If a formula uses @emph{calculated} fields further down the row,
7955 multiple recalculation may be needed to get all fields consistent.  You
7956 may use the command @code{org-table-iterate} (@kbd{C-u C-c *}) to
7957 recalculate until convergence.
7958 @item
7959 A single letter cannot be made bold, for example @samp{*a*}.
7960 @item
7961 The exporters work well, but could be made more efficient.
7962 @end itemize
7965 @node Extensions and Hacking, History and Acknowledgments, Miscellaneous, Top
7966 @appendix Extensions, Hooks and Hacking
7968 This appendix lists extensions for Org-mode written by other authors.
7969 It also covers some aspects where users can extend the functionality of
7970 Org-mode.
7972 @menu
7973 * Extensions::                  Existing 3rd-part extensions
7974 * Adding hyperlink types::      New custom link types
7975 * Tables in arbitrary syntax::  Orgtbl for LaTeX and other programs
7976 * Dynamic blocks::              Automatically filled blocks
7977 * Special agenda views::        Customized views
7978 * Using the property API::      Writing programs that use entry properties
7979 @end menu
7981 @node Extensions, Adding hyperlink types, Extensions and Hacking, Extensions and Hacking
7982 @section Third-party extensions for Org-mode
7983 @cindex extension, third-party
7985 The following extensions for Org-mode have been written by other people:
7987 @table @asis
7988 @cindex @file{org-publish.el}
7989 @item @file{org-publish.el} by David O'Toole
7990 This package provides facilities for publishing related sets of Org-mode
7991 files together with linked files like images as webpages.  It is
7992 highly configurable and can be used for other publishing purposes as
7993 well.  As of Org-mode version 4.30, @file{org-publish.el} is part of the
7994 Org-mode distribution.  It is not yet part of Emacs, however, a delay
7995 caused by the preparations for the 22.1 release.  In the mean time,
7996 @file{org-publish.el} can be downloaded from David's site:
7997 @url{http://dto.freeshell.org/e/org-publish.el}.
7998 @cindex @file{org-mouse.el}
7999 @item @file{org-mouse.el} by Piotr Zielinski
8000 This package implements extended mouse functionality for Org-mode.  It
8001 allows you to cycle visibility and to edit the document structure with
8002 the mouse.  Best of all, it provides a context-sensitive menu on
8003 @key{mouse-3} that changes depending on the context of a mouse-click.
8004 As of Org-mode version 4.53, @file{org-mouse.el} is part of the
8005 Org-mode distribution.  It is not yet part of Emacs, however, a delay
8006 caused by the preparations for the 22.1 release.  In the mean time,
8007 @file{org-mouse.el} can be downloaded from Piotr's site:
8008 @url{http://www.cl.cam.ac.uk/~pz215/files/org-mouse.el}.
8009 @cindex @file{org-blog.el}
8010 @item @file{org-blog.el} by David O'Toole
8011 A blogging plug-in for @file{org-publish.el}.@*
8012 @url{http://dto.freeshell.org/notebook/OrgMode.html}.
8013 @cindex @file{blorg.el}
8014 @item @file{blorg.el} by Bastien Guerry
8015 Publish Org-mode files as
8016 blogs. @url{http://www.cognition.ens.fr/~guerry/blorg.html}.
8017 @cindex @file{org2rem.el}
8018 @item @file{org2rem.el} by Bastien Guerry
8019 Translates Org-mode files into something readable by
8020 Remind. @url{http://www.cognition.ens.fr/~guerry/u/org2rem.el}.
8021 @item @file{org-toc.el} by Bastien Guerry
8022 Produces a simple table of contents of an Org-mode file, for easy
8023 navigation. @url{http://www.cognition.ens.fr/~guerry/u/org-registry.el}.
8024 @item @file{org-registry.el} by Bastien Guerry
8025 Find which Org-file link to a certain document.
8026 @url{http://www.cognition.ens.fr/~guerry/u/org2rem.el}.
8027 @end table
8029 @page
8031 @node Adding hyperlink types, Tables in arbitrary syntax, Extensions, Extensions and Hacking
8032 @section Adding hyperlink types
8033 @cindex hyperlinks, adding new types
8035 Org-mode has a large number of hyperlink types built-in
8036 (@pxref{Hyperlinks}).  If you would like to add new link types, it
8037 provides an interface for doing so.  Lets look at an example file
8038 @file{org-man.el} that will add support for creating links like
8039 @samp{[[man:printf][The printf manpage]]} to show unix manual pages inside
8040 emacs:
8042 @lisp
8043 ;;; org-man.el - Support for links to manpages in Org-mode
8045 (require 'org)
8047 (org-add-link-type "man" 'org-man-open)
8048 (add-hook 'org-store-link-functions 'org-man-store-link)
8050 (defcustom org-man-command 'man
8051   "The Emacs command to be used to display a man page."
8052   :group 'org-link
8053   :type '(choice (const man) (const woman)))
8055 (defun org-man-open (path)
8056   "Visit the manpage on PATH.
8057 PATH should be a topic that can be thrown at the man command."
8058   (funcall org-man-command path))
8060 (defun org-man-store-link ()
8061   "Store a link to a manpage."
8062   (when (memq major-mode '(Man-mode woman-mode))
8063     ;; This is a man page, we do make this link
8064     (let* ((page (org-man-get-page-name))
8065            (link (concat "man:" page))
8066            (description (format "Manpage for %s" page)))
8067       (org-store-link-props
8068        :type "man"
8069        :link link
8070        :description description))))
8072 (defun org-man-get-page-name ()
8073   "Extract the page name from the buffer name."
8074   ;; This works for both `Man-mode' and `woman-mode'.
8075   (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
8076       (match-string 1 (buffer-name))
8077     (error "Cannot create link to this man page")))
8079 (provide 'org-man)
8081 ;;; org-man.el ends here
8082 @end lisp
8084 @noindent
8085 You would activate this new link type in @file{.emacs} with
8087 @lisp
8088 (require 'org-man)
8089 @end lisp
8091 @noindent
8092 Lets go through the file and see what it does.
8093 @enumerate
8094 @item
8095 It does @code{(require 'org)} to make sure that @file{org.el} has been
8096 loaded.
8097 @item
8098 The next line calls @code{org-add-link-type} to define a new link type
8099 with prefix @samp{man}.  The call also contains the name of a function
8100 that will be called to follow such a link.
8101 @item
8102 The next line adds a function to @code{org-store-link-functions}, in
8103 order to allow the command @kbd{C-c l} to record a useful link in a
8104 buffer displaying a man page.
8105 @end enumerate
8107 The rest of the file defines the necessary variables and functions.
8108 First there is a customization variable that determines which emacs
8109 command should be used to display manpages.  There are two options,
8110 @code{man} and @code{woman}.  Then the function to follow a link is
8111 defined.  It gets the link path as an argument - in this case the link
8112 path is just a topic for the manual command.  The function calls the
8113 value of @code{org-man-command} to display the man page.
8115 Finally the function @code{org-man-store-link} is defined.  When you try
8116 to store a link with @kbd{C-c l}, also this function will be called to
8117 try to make a link.  The function must first decide if it is supposed to
8118 create the link for this buffer type, we do this by checking the value
8119 of the variable @code{major-mode}.  If not, the function must exit and
8120 retunr the value @code{nil}.  If yes, the link is created by getting the
8121 manual tpoic from the buffer name and prefixing it with the string
8122 @samp{man:}.  Then it must call the command @code{org-store-link-props}
8123 and set the @code{:type} and @code{:link} properties.  Optionally you
8124 can also set the @code{:description} property to provide a default for
8125 the link description when the link is later inserted into tan Org-mode
8126 buffer with @kbd{C-c C-l}.
8128 @node Tables in arbitrary syntax, Dynamic blocks, Adding hyperlink types, Extensions and Hacking
8129 @section Tables and Lists in arbitrary syntax
8130 @cindex tables, in other modes
8131 @cindex lists, in other modes
8132 @cindex orgtbl-mode
8134 Since Orgtbl-mode can be used as a minor mode in arbitrary buffers, a
8135 frequent feature request has been to make it work with native tables in
8136 specific languages, for example La@TeX{}.  However, this is extremely
8137 hard to do in a general way, would lead to a customization nightmare,
8138 and would take away much of the simplicity of the Orgtbl-mode table
8139 editor.
8142 This appendix describes a different approach.  We keep the Orgtbl-mode
8143 table in its native format (the @i{source table}), and use a custom
8144 function to @i{translate} the table to the correct syntax, and to
8145 @i{install} it in the right location (the @i{target table}).  This puts
8146 the burden of writing conversion functions on the user, but it allows
8147 for a very flexible system.
8149 Bastien added the ability to do the same with lists.  You can use Org's
8150 facilities to edit and structure lists by turning @code{orgstruct-mode}
8151 on, then locally exporting such lists in another format (HTML, La@TeX{}
8152 or TeXInfo.)
8155 @menu
8156 * Radio tables::                Sending and receiving
8157 * A LaTeX example::             Step by step, almost a tutorial
8158 * Translator functions::        Copy and modify
8159 * Radio lists::                 Doing the same for lists.
8160 @end menu
8162 @node Radio tables, A LaTeX example, Tables in arbitrary syntax, Tables in arbitrary syntax
8163 @subsection Radio tables
8164 @cindex radio tables
8166 To define the location of the target table, you first need to create two
8167 lines that are comments in the current mode, but contain magic words for
8168 Orgtbl-mode to find.  Orgtbl-mode will insert the translated table
8169 between these lines, replacing whatever was there before.  For example:
8171 @example
8172 /* BEGIN RECEIVE ORGTBL table_name */
8173 /* END RECEIVE ORGTBL table_name */
8174 @end example
8176 @noindent
8177 Just above the source table, we put a special line that tells
8178 Orgtbl-mode how to translate this table and where to install it.  For
8179 example:
8180 @example
8181 #+ORGTBL: SEND table_name translation_function arguments....
8182 @end example
8184 @noindent
8185 @code{table_name} is the reference name for the table that is also used
8186 in the receiver lines. @code{translation_function} is the Lisp function
8187 that does the translation.  Furthermore, the line can contain a list of
8188 arguments (alternating key and value) at the end.  The arguments will be
8189 passed as a property list to the translation function for
8190 interpretation.  A few standard parameters are already recognized and
8191 acted upon before the translation function is called:
8193 @table @code
8194 @item :skip N
8195 Skip the first N lines of the table. Hlines do count!
8196 @item :skipcols (n1 n2 ...)
8197 List of columns that should be skipped.  If the table has a column with
8198 calculation marks, that column is automatically discarded as well.
8199 Please note that the translator function sees the table @emph{after} the
8200 removal of these columns, the function never knows that there have been
8201 additional columns.
8202 @end table
8204 @noindent
8205 The one problem remaining is how to keep the source table in the buffer
8206 without disturbing the normal workings of the file, for example during
8207 compilation of a C file or processing of a La@TeX{} file.  There are a
8208 number of different solutions:
8210 @itemize @bullet
8211 @item
8212 The table could be placed in a block comment if that is supported by the
8213 language.  For example, in C-mode you could wrap the table between
8214 @samp{/*} and @samp{*/} lines.
8215 @item
8216 Sometimes it is possible to put the table after some kind of @i{END}
8217 statement, for example @samp{\bye} in TeX and @samp{\end@{document@}}
8218 in La@TeX{}.
8219 @item
8220 You can just comment the table line by line whenever you want to process
8221 the file, and uncomment it whenever you need to edit the table.  This
8222 only sounds tedious - the command @kbd{M-x orgtbl-toggle-comment} does
8223 make this comment-toggling very easy, in particular if you bind it to a
8224 key.
8225 @end itemize
8227 @node A LaTeX example, Translator functions, Radio tables, Tables in arbitrary syntax
8228 @subsection A LaTeX example of radio tables
8229 @cindex LaTeX, and orgtbl-mode
8231 The best way to wrap the source table in La@TeX{} is to use the
8232 @code{comment} environment provided by @file{comment.sty}.  It has to be
8233 activated by placing @code{\usepackage@{comment@}} into the document
8234 header.  Orgtbl-mode can insert a radio table skeleton@footnote{By
8235 default this works only for La@TeX{}, HTML, and TeXInfo.  Configure the
8236 variable @code{orgtbl-radio-tables} to install templates for other
8237 modes.}  with the command @kbd{M-x orgtbl-insert-radio-table}.  You will
8238 be prompted for a table name, lets say we use @samp{salesfigures}.  You
8239 will then get the following template:
8241 @example
8242 % BEGIN RECEIVE ORGTBL salesfigures
8243 % END RECEIVE ORGTBL salesfigures
8244 \begin@{comment@}
8245 #+ORGTBL: SEND salesfigures orgtbl-to-latex
8246 | | |
8247 \end@{comment@}
8248 @end example
8250 @noindent
8251 The @code{#+ORGTBL: SEND} line tells orgtbl-mode to use the function
8252 @code{orgtbl-to-latex} to convert the table into La@TeX{} and to put it
8253 into the receiver location with name @code{salesfigures}.  You may now
8254 fill in the table, feel free to use the spreadsheet features@footnote{If
8255 the @samp{#+TBLFM} line contains an odd number of dollar characters,
8256 this may cause problems with font-lock in latex-mode.  As shown in the
8257 example you can fix this by adding an extra line inside the
8258 @code{comment} environment that is used to balance the dollar
8259 expressions.  If you are using AUCTeX with the font-latex library, a
8260 much better solution is to add the @code{comment} environment to the
8261 variable @code{LaTeX-verbatim-environments}.}:
8263 @example
8264 % BEGIN RECEIVE ORGTBL salesfigures
8265 % END RECEIVE ORGTBL salesfigures
8266 \begin@{comment@}
8267 #+ORGTBL: SEND salesfigures orgtbl-to-latex
8268 | Month | Days | Nr sold | per day |
8269 |-------+------+---------+---------|
8270 | Jan   |   23 |      55 |     2.4 |
8271 | Feb   |   21 |      16 |     0.8 |
8272 | March |   22 |     278 |    12.6 |
8273 #+TBLFM: $4=$3/$2;%.1f
8274 % $ (optional extra dollar to keep font-lock happy, see footnote)
8275 \end@{comment@}
8276 @end example
8278 @noindent
8279 When you are done, press @kbd{C-c C-c} in the table to get the converted
8280 table inserted between the two marker lines.
8282 Now lets assume you want to make the table header by hand, because you
8283 want to control how columns are aligned etc.  In this case we make sure
8284 that the table translator does skip the first 2 lines of the source
8285 table, and tell the command to work as a @i{splice}, i.e. to not produce
8286 header and footer commands of the target table:
8288 @example
8289 \begin@{tabular@}@{lrrr@}
8290 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
8291 % BEGIN RECEIVE ORGTBL salesfigures
8292 % END RECEIVE ORGTBL salesfigures
8293 \end@{tabular@}
8295 \begin@{comment@}
8296 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
8297 | Month | Days | Nr sold | per day |
8298 |-------+------+---------+---------|
8299 | Jan   |   23 |      55 |     2.4 |
8300 | Feb   |   21 |      16 |     0.8 |
8301 | March |   22 |     278 |    12.6 |
8302 #+TBLFM: $4=$3/$2;%.1f
8303 \end@{comment@}
8304 @end example
8306 The La@TeX{} translator function @code{orgtbl-to-latex} is already part of
8307 Orgtbl-mode.  It uses a @code{tabular} environment to typeset the table
8308 and marks horizontal lines with @code{\hline}.  Furthermore, it
8309 interprets the following parameters:
8311 @table @code
8312 @item :splice nil/t
8313 When set to t, return only table body lines, don't wrap them into a
8314 tabular environment.  Default is nil.
8316 @item :fmt fmt
8317 A format to be used to wrap each field, should contain @code{%s} for the
8318 original field value.  For example, to wrap each field value in dollars,
8319 you could use @code{:fmt "$%s$"}.  This may also be a property list with
8320 column numbers and formats. for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
8322 @item :efmt efmt
8323 Use this format to print numbers with exponentials.  The format should
8324 have @code{%s} twice for inserting mantissa and exponent, for example
8325 @code{"%s\\times10^@{%s@}"}.  The default is @code{"%s\\,(%s)"}.  This
8326 may also be a property list with column numbers and formats, for example
8327 @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}.  After
8328 @code{efmt} has been applied to a value, @code{fmt} will also be
8329 applied.
8330 @end table
8332 @node Translator functions, Radio lists, A LaTeX example, Tables in arbitrary syntax
8333 @subsection Translator functions
8334 @cindex HTML, and orgtbl-mode
8335 @cindex translator function
8337 Orgtbl-mode has several translator functions built-in:
8338 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and
8339 @code{orgtbl-to-texinfo}.  Except for @code{orgtbl-to-html}@footnote{The
8340 HTML translator uses the same code that produces tables during HTML
8341 export.}, these all use a generic translator, @code{orgtbl-to-generic}.
8342 For example, @code{orgtbl-to-latex} itself is a very short function that
8343 computes the column definitions for the @code{tabular} environment,
8344 defines a few field and line separators and then hands over to the
8345 generic translator.  Here is the entire code:
8347 @lisp
8348 @group
8349 (defun orgtbl-to-latex (table params)
8350   "Convert the orgtbl-mode TABLE to LaTeX."
8351   (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
8352                                org-table-last-alignment ""))
8353          (params2
8354           (list
8355            :tstart (concat "\\begin@{tabular@}@{" alignment "@}")
8356            :tend "\\end@{tabular@}"
8357            :lstart "" :lend " \\\\" :sep " & "
8358            :efmt "%s\\,(%s)" :hline "\\hline")))
8359     (orgtbl-to-generic table (org-combine-plists params2 params))))
8360 @end group
8361 @end lisp
8363 As you can see, the properties passed into the function (variable
8364 @var{PARAMS}) are combined with the ones newly defined in the function
8365 (variable @var{PARAMS2}).  The ones passed into the function (i.e. the
8366 ones set by the @samp{ORGTBL SEND} line) take precedence.  So if you
8367 would like to use the La@TeX{} translator, but wanted the line endings to
8368 be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
8369 overrule the default with
8371 @example
8372 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
8373 @end example
8375 For a new language, you can either write your own converter function in
8376 analogy with the La@TeX{} translator, or you can use the generic function
8377 directly.  For example, if you have a language where a table is started
8378 with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are
8379 started with @samp{!BL!}, ended with @samp{!EL!} and where the field
8380 separator is a TAB, you could call the generic translator like this (on
8381 a single line!):
8383 @example
8384 #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
8385                               :lstart "!BL! " :lend " !EL!" :sep "\t"
8386 @end example
8388 @noindent
8389 Please check the documentation string of the function
8390 @code{orgtbl-to-generic} for a full list of parameters understood by
8391 that function and remember that you can pass each of them into
8392 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
8393 using the generic function.
8395 Of course you can also write a completely new function doing complicated
8396 things the generic translator cannot do.  A translator function takes
8397 two arguments.  The first argument is the table, a list of lines, each
8398 line either the symbol @code{hline} or a list of fields.  The second
8399 argument is the property list containing all parameters specified in the
8400 @samp{#+ORGTBL: SEND} line.  The function must return a single string
8401 containing the formatted table.  If you write a generally useful
8402 translator, please post it on @code{emacs-orgmode@@gnu.org} so that
8403 others can benefit from your work.
8405 @node  Radio lists,  , Translator functions, Tables in arbitrary syntax
8406 @subsection Radio lists
8407 @cindex radio lists
8408 @cindex org-list-insert-radio-list
8410 Sending and receiving radio lists works exactly the same way than
8411 sending and receiving radio tables (@pxref{Radio tables}) @footnote{You
8412 need to load the @code{org-export-latex.el} package to use radio lists
8413 since the relevant code is there for now.}.  As for radio tables, you
8414 can insert radio lists templates in HTML, La@TeX{} and TeXInfo modes by
8415 calling @code{org-list-insert-radio-list}.
8417 Here are the differences with radio tables:
8419 @itemize @minus
8420 @item
8421 Use @code{ORGLST} instead of @code{ORGTBL}.
8422 @item
8423 The available translation functions for radio lists don't take
8424 parameters.
8425 @item
8426 `C-c C-c' will work when pressed on the first item of the list.
8427 @end itemize
8429 Here is a La@TeX{} example.  Let's say that you have this in your
8430 La@TeX{} file:
8432 @example
8433 % BEGIN RECEIVE ORGLST to-buy
8434 % END RECEIVE ORGLST to-buy
8435 \begin@{comment@}
8436 #+ORGLIST: SEND to-buy orgtbl-to-latex
8437 - a new house
8438 - a new computer
8439   + a new keyboard
8440   + a new mouse
8441 - a new life
8442 \end@{comment@}
8443 @end example
8445 Pressing `C-c C-c' on @code{a new house} and will insert the converted
8446 La@TeX{} list between the two marker lines.
8448 @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Extensions and Hacking
8449 @section Dynamic blocks
8450 @cindex dynamic blocks
8452 Org-mode documents can contain @emph{dynamic blocks}.  These are
8453 specially marked regions that are updated by some user-written function.
8454 A good example for such a block is the clock table inserted by the
8455 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
8457 Dynamic block are enclosed by a BEGIN-END structure that assigns a name
8458 to the block and can also specify parameters for the function producing
8459 the content of the block.
8461 @example
8462 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
8464 #+END:
8465 @end example
8467 Dynamic blocks are updated with the following commands
8469 @table @kbd
8470 @kindex C-c C-x C-u
8471 @item C-c C-x C-u
8472 Update dynamic block at point.
8473 @kindex C-u C-c C-x C-u
8474 @item C-u C-c C-x C-u
8475 Update all dynamic blocks in the current file.
8476 @end table
8478 Updating a dynamic block means to remove all the text between BEGIN and
8479 END, parse the BEGIN line for parameters and then call the specific
8480 writer function for this block to insert the new content.  If you want
8481 to use the original content in the writer function, you can use the
8482 extra parameter @code{:content}.
8484 For a block with name @code{myblock}, the writer function is
8485 @code{org-dblock-write:myblock} with as only parameter a property list
8486 with the parameters given in the begin line.  Here is a trivial example
8487 of a block that keeps track of when the block update function was last
8488 run:
8490 @example
8491 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
8493 #+END:
8494 @end example
8496 @noindent
8497 The corresponding block writer function could look like this:
8499 @lisp
8500 (defun org-dblock-write:block-update-time (params)
8501    (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
8502      (insert "Last block update at: "
8503              (format-time-string fmt (current-time)))))
8504 @end lisp
8506 If you want to make sure that all dynamic blocks are always up-to-date,
8507 you could add the function @code{org-update-all-dblocks} to a hook, for
8508 example @code{before-save-hook}.  @code{org-update-all-dblocks} is
8509 written in a way that is does nothing in buffers that are not in Org-mode.
8511 @node Special agenda views, Using the property API, Dynamic blocks, Extensions and Hacking
8512 @section Special Agenda Views
8513 @cindex agenda views, user-defined
8515 Org-mode provides a special hook that can be used to narrow down the
8516 selection made by any of the agenda views.  You may specify a function
8517 that is used at each match to verify if the match should indeed be part
8518 of the agenda view, and if not, how much should be skipped.
8520 Let's say you want to produce a list of projects that contain a WAITING
8521 tag anywhere in the project tree.  Let's further assume that you have
8522 marked all tree headings that define a project with the todo keyword
8523 PROJECT.  In this case you would run a todo search for the keyword
8524 PROJECT, but skip the match unless there is a WAITING tag anywhere in
8525 the subtree belonging to the project line.
8527 To achieve this, you must write a function that searches the subtree for
8528 the tag.  If the tag is found, the function must return @code{nil} to
8529 indicate that this match should not be skipped.  If there is no such
8530 tag, return the location of the end of the subtree, to indicate that
8531 search should continue from there.
8533 @lisp
8534 (defun my-skip-unless-waiting ()
8535   "Skip trees that are not waiting"
8536   (let ((subtree-end (save-excursion (org-end-of-subtree t))))
8537     (if (re-search-forward ":waiting:" subtree-end t)
8538         nil          ; tag found, do not skip
8539       subtree-end))) ; tag not found, continue after end of subtree
8540 @end lisp
8542 Now you may use this function in an agenda custom command, for example
8543 like this:
8545 @lisp
8546 (org-add-agenda-custom-command
8547  '("b" todo "PROJECT"
8548    ((org-agenda-skip-function 'my-org-waiting-projects)
8549     (org-agenda-overriding-header "Projects waiting for something: "))))
8550 @end lisp
8552 Note that this also binds @code{org-agenda-overriding-header} to get a
8553 meaningful header in the agenda view.
8555 You may also put a Lisp form into @code{org-agenda-skip-function}.  In
8556 particular, you may use the functions @code{org-agenda-skip-entry-if}
8557 and @code{org-agenda-skip-subtree-if} in this form, for example:
8559 @table @code
8560 @item '(org-agenda-skip-entry-if 'scheduled)
8561 Skip current entry if it has been scheduled.
8562 @item '(org-agenda-skip-entry-if 'notscheduled)
8563 Skip current entry if it has not been scheduled.
8564 @item '(org-agenda-skip-entry-if 'deadline)
8565 Skip current entry if it has a deadline.
8566 @item '(org-agenda-skip-entry-if 'scheduled 'deadline)
8567 Skip current entry if it has a deadline, or if it is scheduled.
8568 @item '(org-agenda-skip-entry 'regexp "regular expression")
8569 Skip current entry if the regular expression matches in the entry.
8570 @item '(org-agenda-skip-entry 'notregexp "regular expression")
8571 Skip current entry unless the regular expression matches.
8572 @item '(org-agenda-skip-subtree-if 'regexp "regular expression")
8573 Same as above, but check and skip the entire subtree.
8574 @end table
8576 Therefore we could also have written the search for WAITING projects
8577 like this, even without defining a special function:
8579 @lisp
8580 (org-add-agenda-custom-command
8581  '("b" todo "PROJECT"
8582    ((org-agenda-skip-function '(org-agenda-skip-subtree-if
8583                                 'regexp ":waiting:"))
8584     (org-agenda-overriding-header "Projects waiting for something: "))))
8585 @end lisp
8588 @node Using the property API,  , Special agenda views, Extensions and Hacking
8589 @section Using the property API
8590 @cindex API, for properties
8591 @cindex properties, API
8593 Here is a description of the functions that can be used to work with
8594 properties.
8596 @defun org-entry-properties &optional pom which
8597 Get all properties of the entry at point-or-marker POM.
8598 This includes the TODO keyword, the tags, time strings for deadline,
8599 scheduled, and clocking, and any additional properties defined in the
8600 entry.  The return value is an alist, keys may occur multiple times
8601 if the property key was used several times.
8602 POM may also be nil, in which case the current entry is used.
8603 If WHICH is nil or `all', get all properties.  If WHICH is
8604 `special' or `standard', only get that subclass.
8605 @end defun
8606 @defun org-entry-get pom property &optional inherit
8607 Get value of PROPERTY for entry at point-or-marker POM.
8608 If INHERIT is non-nil and the entry does not have the property,
8609 then also check higher levels of the hierarchy.  This function ignores
8610 the value of @code{org-use-property-inheritance} and requires the
8611 explicit INHERIT flag.
8612 @end defun
8614 @defun org-entry-delete pom property
8615 Delete the property PROPERTY from entry at point-or-marker POM.
8616 @end defun
8618 @defun org-entry-put pom property value
8619 Set PROPERTY to VALUE for entry at point-or-marker POM.
8620 @end defun
8622 @defun org-buffer-property-keys &optional include-specials
8623 Get all property keys in the current buffer.
8624 @end defun
8626 @defun org-insert-property-drawer
8627 Insert a property drawer at point.
8628 @end defun
8630 @node History and Acknowledgments, Main Index, Extensions and Hacking, Top
8631 @appendix History and Acknowledgments
8632 @cindex acknowledgments
8633 @cindex history
8634 @cindex thanks
8636 Org-mode was borne in 2003, out of frustration over the user interface
8637 of the Emacs outline-mode.  I was trying to organize my notes and
8638 projects, and using Emacs seemed to be the natural way to go.  However,
8639 having to remember eleven different commands with two or three keys per
8640 command, only to hide and unhide parts of the outline tree, that seemed
8641 entirely unacceptable to me.  Also, when using outlines to take notes, I
8642 constantly want to restructure the tree, organizing it parallel to my
8643 thoughts and plans.  @emph{Visibility cycling} and @emph{structure
8644 editing} were originally implemented in the package
8645 @file{outline-magic.el}, but quickly moved to the more general
8646 @file{org.el}.  As this environment became comfortable for project
8647 planning, the next step was adding @emph{TODO entries}, basic @emph{time
8648 stamps}, and @emph{table support}.  These areas highlight the two main
8649 goals that Org-mode still has today: To create a new, outline-based,
8650 plain text mode with innovative and intuitive editing features, and to
8651 incorporate project planning functionality directly into a notes file.
8653 Since the first release, literally thousands of emails to me or on
8654 @code{emacs-orgmode@@gnu.org} have provided a constant stream of bug
8655 reports, feedback, new ideas, and sometimes patches and add-on code.
8656 Many thanks to everyone who has helped to improve this package.  I am
8657 trying to keep here a list of the people who had significant influence
8658 in shaping one or more aspects of Org-mode.  The list may not be
8659 complete, if I have forgotten someone, please accept my apologies and
8660 let me know.
8662 @itemize @bullet
8664 @item
8665 @i{Russel Adams} came up with the idea for drawers.
8666 @item
8667 @i{Thomas Baumann} contributed the code for links to the MH-E email
8668 system.
8669 @item
8670 @i{Alex Bochannek} provided a patch for rounding time stamps.
8671 @item
8672 @i{Charles Cave}'s suggestion sparked the implementation of templates
8673 for Remember.
8674 @item
8675 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
8676 specified time.
8677 @item
8678 @i{Gregory Chernov} patched support for lisp forms into table
8679 calculations and improved XEmacs compatibility, in particular by porting
8680 @file{nouline.el} to XEmacs.
8681 @item
8682 @i{Sacha Chua} suggested to copy some linking code from Planner.
8683 @item
8684 @i{Eddward DeVilla} proposed and tested checkbox statistics.  He also
8685 came up with the idea of properties, and that there should be an API for
8686 them.
8687 @item
8688 @i{Kees Dullemond} used to edit projects lists directly in HTML and so
8689 inspired some of the early development, including HTML export.  He also
8690 asked for a way to narrow wide table columns.
8691 @item
8692 @i{Christian Egli} converted the documentation into TeXInfo format,
8693 patched CSS formatting into the HTML exporter, and inspired the agenda.
8694 @item
8695 @i{David Emery} provided a patch for custom CSS support in exported
8696 HTML agendas.
8697 @item
8698 @i{Nic Ferrier} contributed mailcap and XOXO support.
8699 @item
8700 @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
8701 @item
8702 @i{John Foerch} figured out how to make incremental search show context
8703 around a match in a hidden outline tree.
8704 @item
8705 @i{Niels Giesen} had the idea to automatically archive DONE trees.
8706 @item
8707 @i{Bastien Guerry} wrote the La@TeX{} exporter and has been prolific
8708 with patches, ideas, and bug reports.
8709 @item
8710 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
8711 @item
8712 @i{Scott Jaderholm} proposed footnotes, control over whitespace between
8713 folded entries, and column view for properties.
8714 @item
8715 @i{Shidai Liu} ("Leo") asked for embedded La@TeX{} and tested it.  He also
8716 provided frequent feedback and some patches.
8717 @item
8718 @i{Jason F. McBrayer} suggested agenda export to CSV format.
8719 @item
8720 @i{Max Mikhanosha} came up with the idea of refiling.
8721 @item
8722 @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
8723 basis.
8724 @item
8725 @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
8726 happy.
8727 @item
8728 @i{Rick Moynihan} proposed to allow multiple TODO sequences in a file
8729 and to be able to quickly restrict the agenda to a subtree.
8730 @item
8731 @i{Todd Neal} provided patches for links to Info files and elisp forms.
8732 @item
8733 @i{Tim O'Callaghan} suggested in-file links, search options for general
8734 file links, and TAGS.
8735 @item
8736 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
8737 into Japanese.
8738 @item
8739 @i{Oliver Oppitz} suggested multi-state TODO items.
8740 @item
8741 @i{Scott Otterson} sparked the introduction of descriptive text for
8742 links, among other things.
8743 @item
8744 @i{Pete Phillips} helped during the development of the TAGS feature, and
8745 provided frequent feedback.
8746 @item
8747 @i{T.V. Raman} reported bugs and suggested improvements.
8748 @item
8749 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
8750 control.
8751 @item
8752 @i{Kevin Rogers} contributed code to access VM files on remote hosts.
8753 @item
8754 @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
8755 conflict with @file{allout.el}.
8756 @item
8757 @i{Jason Riedy} sent a patch to fix a bug with export of TODO keywords.
8758 @item
8759 @i{Philip Rooke} created the Org-mode reference card and provided lots
8760 of feedback.
8761 @item
8762 @i{Christian Schlauer} proposed angular brackets around links, among
8763 other things.
8764 @item
8765 Linking to VM/BBDB/GNUS was inspired by @i{Tom Shannon}'s
8766 @file{organizer-mode.el}.
8767 @item
8768 @i{Daniel Sinder} came up with the idea of internal archiving by locking
8769 subtrees.
8770 @item
8771 @i{Dale Smith} proposed link abbreviations.
8772 @item
8773 @i{Adam Spiers} asked for global linking commands and inspired the link
8774 extension system.  support mairix.
8775 @item
8776 @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
8777 chapter about publishing.
8778 @item
8779 @i{J@"urgen Vollmer} contributed code generating the table of contents
8780 in HTML output.
8781 @item
8782 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
8783 keyword.
8784 @item
8785 @i{David Wainberg} suggested archiving, and improvements to the linking
8786 system.
8787 @item
8788 @i{John Wiegley} wrote @file{emacs-wiki.el} and @file{planner.el}.  The
8789 development of Org-mode was fully independent, and both systems are
8790 really different beasts in their basic ideas and implementation details.
8791 I later looked at John's code, however, and learned from his
8792 implementation of (i) links where the link itself is hidden and only a
8793 description is shown, and (ii) popping up a calendar to select a date.
8794 John has also contributed a number of great ideas directly to Org-mode.
8795 @item
8796 @i{Carsten Wimmer} suggested some changes and helped fix a bug in
8797 linking to GNUS.
8798 @item
8799 @i{Roland Winkler} requested additional keybindings to make Org-mode
8800 work on a tty.
8801 @item
8802 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
8803 and contributed various ideas and code snippets.
8804 @end itemize
8807 @node Main Index, Key Index, History and Acknowledgments, Top
8808 @unnumbered The Main Index
8810 @printindex cp
8812 @node Key Index,  , Main Index, Top
8813 @unnumbered Key Index
8815 @printindex ky
8817 @bye
8819 @ignore
8820    arch-tag: 7893d1fe-cc57-4d13-b5e5-f494a1bcc7ac
8821 @end ignore