\input texinfo
@c %**start of header
+@c @setfilename org
@setfilename ../info/org
@settitle Org Mode Manual
-@set VERSION 3.04
-@set DATE December 2004
+@set VERSION 3.15
+@set DATE September 2005
@dircategory Emacs
@direntry
-* Org Mode: (org). Outline-based notes management and organizer
+* Org Mode: (org). Outline-based notes management and organizer
@end direntry
@c Version and Contact Info
@copying
This manual is for Org-mode (version @value{VERSION}).
-Copyright @copyright{} 2004 Free Software Foundation
+Copyright @copyright{} 2004, 2005 Free Software Foundation
@quotation
Permission is granted to copy, distribute and/or modify this document
-under the terms of the GNU Free Documentation License, Version 1.1 or
+under the terms of the GNU Free Documentation License, Version 1.2 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
and with the Back-Cover Texts as in (a) below. A copy of the
@menu
* Introduction:: Getting started
* Document Structure:: A tree works like your brain
-* TODO items:: Every tree branch can be a TODO item
* Tables:: Pure magic for quick formatting
* Hyperlinks:: Notes in context
+* TODO items:: Every tree branch can be a TODO item
* Timestamps:: Assign date and time to items
* Timeline and Agenda:: Use time-stamped items to produce an agenda
* Exporting:: Sharing and publishing of notes
Introduction
* Summary:: Brief summary of what Org-mode does
-* Installation:: How to install Org-mode
+* Installation and Activation:: How to install Org-mode
+* Feedback:: Bug reports, ideas, patches etc.
Document Structure
* Visibility cycling:: Show ad hide, much simplified
* Motion:: Jumping to other headlines
* Structure editing:: Changing sequence and level of headlines
+* Archiving:: Move done task trees to a different place
* Sparse trees:: Matches embedded in context
+Tables
+
+* Built-in table editor:: Simple tables
+* Table calculations:: Compute a field from other fields
+* orgtbl-mode:: The table editor as minor mode
+* table.el:: Complex tables
+
+Calculations in tables
+
+* Formula syntax:: How to write a formula
+* Column formulas:: Formulas valid for all fields in a column
+* Advanced features:: Field names, parameters and automatic recalc
+* Named-field formulas:: Formulas valid in single fields
+* Editing/debugging formulas:: Changing a stored formula
+* Appetizer::
+
+Hyperlinks
+
+* Links:: URL-like links to the world
+* Remember:: Org-trees store quick notes
+
TODO items
* TODO basics:: Marking and displaying TODO entries
-* Priorities:: Some things are more important than others
* TODO extensions:: Workflow and assignments
+* Priorities:: Some things are more important than others
Extended use of TODO keywords
* TODO types:: I do this, Fred the rest
* Per file keywords:: Different files, different requirements
-Tables
-
-* Built-in table editor:: Simple tables
-* table.el:: Complex tables
-* orgtbl-mode:: The table editor as minor mode
-
-Hyperlinks
-
-* Links:: URL-like links to the world
-* Remember:: Org-trees store quick notes
-
Timestamps
* Time stamps:: Assigning a time to a tree entry
Timeline and Agenda
-* Timeline (single file):: Time-sorted view for single file
-* Agenda (multiple files):: Your weekly planner
+* Timeline:: Time-sorted view for single file
+* Agenda:: Your weekly planner
* Agenda commands:: Remote editing of org trees
* Calendar/Diary integration:: Integrating Anniversaries and more
* Completion:: M-TAB knows what you need
* Customization:: Adapting Org-mode to your taste
-* Tips and Tricks:: An author-imposed FAQ, sort of
+* FAQ:: Frequently asked questions
* Interaction:: Other Emacs packages
-* Acknowledgments:: These people provided feedback and more
* Bugs:: Things which do not work perfectly
+* Acknowledgments:: These people provided feedback and more
@end detailmenu
@end menu
@menu
* Summary:: Brief summary of what Org-mode does
-* Installation:: How to install Org-mode
+* Installation and Activation:: How to install Org-mode
+* Feedback:: Bug reports, ideas, patches etc.
@end menu
-@node Summary, Installation, Introduction, Introduction
+@node Summary, Installation and Activation, Introduction, Introduction
@section Summary
@cindex summary
large files well structured. Visibility cycling and structure editing
help to work with the tree. Tables are easily created with a built-in
table editor. Org-mode supports ToDo items, deadlines, time stamps,
-and scheduling. It dynamically compiles entries into an agenda.
-Plain text URL-like links connect to websites, emails, usenet
+and scheduling. It dynamically compiles entries into an agenda that
+utilizes and smoothly integrates much of the Emacs calendar and diary.
+Plain text URL-like links connect to websites, emails, Usenet
messages, BBDB entries, and any files related to the projects. For
printing and sharing of notes, an Org-mode file can be exported as a
structured ASCII file, or as HTML.
@example
@r{@bullet{} as an outline extension with visibility cycling and structure editing}
@r{@bullet{} as an ASCII system and table editor to take structured notes}
+@r{@bullet{} as an ASCII table editor with some spreadsheet-like capabilities}
@r{@bullet{} as a simple hypertext system, with HTML export}
@r{@bullet{} as a TODO list editor}
@r{@bullet{} as a full agenda and planner with deadlines and work scheduling}
@end example
-The Org-mode table editor can be used integrated into any major mode
-by activating the minor Ortbl-mode.
+The Org-mode table editor can be integrated into any major mode by
+activating the minor Orgtbl-mode.
There is a website for Org-mode which provides links to the newest
version of Org-mode, as well as additional information, screen shots
and example files. This page is located at
@uref{http://www.astro.uva.nl/~dominik/Tools/org/}.
-
@page
-@node Installation, , Summary, Introduction
-@section Installation
+@node Installation and Activation, Feedback, Summary, Introduction
+@section Installation and Activation
@cindex installation
@cindex autoload
@cindex global keybindings
@cindex keybindings, global
-The instructions below assume that you have downloaded Org-mode from
-the web. If Org-mode is part of the Emacs distribution or an XEmacs
-package, you only need to add to @file{.emacs} the last three Lisp
-lines below - all the rest will be taken care of automatically.
+If Org-mode is part of the Emacs distribution or an XEmacs package,
+you only need to copy the following lines to your @file{.emacs} file.
+The last two lines define @emph{global} keys for the commands
+@command{org-store-link} and @command{org-agenda} - please choose
+suitable keys yourself.
-Byte-compile @file{org.el} and put it on your load path. If you'd
-like to use the Info documentation, copy the file @file{org} into the
-directory containing info files and run the command @code{install-info
-org}.
+@lisp
+;; The following lines are always needed. Choose your own keys.
+(add-to-list 'auto-mode-alist '("\\.org$" . org-mode))
+(define-key global-map "\C-cl" 'org-store-link)
+(define-key global-map "\C-ca" 'org-agenda)
+@end lisp
-Then copy the following lines into @file{.emacs}. The last two lines
-define @emph{global} keys for the commands @command{org-store-link}
-and @command{org-agenda} - please choose suitable keys yourself.
+If you have downloaded Org-mode from the Web, you must byte-compile
+@file{org.el} and put it on your load path. In addition to the Emacs
+Lisp lines above, you also need to add the following lines to
+@file{.emacs}:
@lisp
+;; These lines only if org-mode is not part of the X/Emacs distribution.
(autoload 'org-mode "org" "Org mode" t)
(autoload 'org-diary "org" "Diary entries from Org mode")
(autoload 'org-agenda "org" "Multi-file agenda from Org mode" t)
(autoload 'org-store-link "org" "Store a link to the current location" t)
(autoload 'orgtbl-mode "org" "Org tables as a minor mode" t)
(autoload 'turn-on-orgtbl "org" "Org tables as a minor mode")
-(add-to-list 'auto-mode-alist '("\\.org$" . org-mode))
-(define-key global-map "\C-cl" 'org-store-link)
-(define-key global-map "\C-ca" 'org-agenda)
@end lisp
@cindex org-mode, turning on
-@noindent
-This will put all files with extension @samp{.org} into Org-mode. As
-an alternative, make the first line of a file look like this:
+With this setup, all files with extension @samp{.org} will be put into
+Org-mode. As an alternative, make the first line of a file look like
+this:
@example
MY PROJECTS -*- mode: org; -*-
@end example
@noindent which will select Org-mode for this buffer no matter what
-the file's name is.
-
-@node Document Structure, TODO items, Introduction, Top
+the file's name is. See also the variable
+@code{org-insert-mode-line-in-empty-file'}.
+
+@node Feedback, , Installation and Activation, Introduction
+@section Feedback
+@cindex feedback
+@cindex bug reports
+@cindex maintainer
+@cindex author
+
+If you find problems with Org-mode, or if you have questions, remarks,
+or ideas about it, please contact the maintainer Carsten Dominik at
+@value{MAINTAINEREMAIL}.
+
+For bug reports, please provide as much information as possible,
+including the version information of Emacs (@kbd{C-h v emacs-version
+@key{RET}}) and Org-mode (@kbd{M-x org-version}), as well as the
+Org-mode related setup in @file{.emacs}. If an error occurs, a
+traceback can be very useful. Often a small example file helps, along
+with clear information about:
+@enumerate
+@item What exactly did you do?
+@item What did you expect to happen?
+@item What happened instead?
+@end enumerate
+@noindent Thanks for helping to improve this mode.
+
+@node Document Structure, Tables, Introduction, Top
@chapter Document Structure
@cindex document structure
@cindex structure of document
* Visibility cycling:: Show ad hide, much simplified
* Motion:: Jumping to other headlines
* Structure editing:: Changing sequence and level of headlines
+* Archiving:: Move done task trees to a different place
* Sparse trees:: Matches embedded in context
@end menu
Show all.
@end table
+When Emacs first visits an Org-mode file, the global state is set to
+OVERVIEW, i.e. only the top level headlines are visible. This can be
+configured through the variable @code{org-startup-folded}, or on a
+per-file basis by adding one of the following lines anywhere in the
+buffer:
+
+@example
+#+STARTUP: fold
+#+STARTUP: nofold
+#+STARTUP: content
+@end example
+
@node Motion, Structure editing, Visibility cycling, Document Structure
@section Motion
@cindex motion, between headlines
visible.
@end table
-@node Structure editing, Sparse trees, Motion, Document Structure
+@node Structure editing, Archiving, Motion, Document Structure
@section Structure editing
@cindex structure editing
@cindex headline, promotion and demotion
@cindex promotion, of subtrees
@cindex demotion, of subtrees
@cindex subtree, cut and paste
-@cindex pasting, subtrees
-@cindex cutting, subtrees
-@cindex copying, subtrees
+@cindex pasting, of subtrees
+@cindex cutting, of subtrees
+@cindex copying, of subtrees
@table @kbd
@kindex M-@key{RET}
@item M-@key{RET}
Insert new heading with same level as current
+@kindex M-S-@key{RET}
+@item M-S-@key{RET}
+Insert new TODO entry with same level as current heading.
@kindex M-@key{left}
@item M-@key{left}
Promote current heading by one level
Copy subtree to kill ring.
@kindex C-c C-h C-y
@item C-c C-h C-y
-Yank subtree from kill ring. This does modify the level of subtree to
+Yank subtree from kill ring. This does modify the level of the subtree to
make sure the tree fits in nicely at the yank position. The yank
level can also be specified with a prefix arg, or by yanking after a
headline marker like @samp{****}.
inside a table (@pxref{Tables}), the Meta-Cursor keys have different
functionality.
-@node Sparse trees, , Structure editing, Document Structure
+@node Archiving, Sparse trees, Structure editing, Document Structure
+@section Archiving
+@cindex archiving
+
+When a project represented by a (sub)tree is finished, you may want
+to move the tree to an archive place, either in the same file under a
+special top-level heading, or even to a different file.
+@table @kbd
+@kindex C-c $
+@item @kbd{C-c $}
+Archive the subtree starting at the cursor position to the location
+given by @code{org-archive-location}.
+@end table
+
+@cindex archive locations
+The default archive is a file in the same directory as the current
+file, with the name derived by appending @file{_archive} to the
+current file name. For information and examples on how to change
+this, see the documentation string of the variable
+@code{org-archive-location}. If you are also using the Org-mode
+agenda, archiving to a different file is a good way to keep archived
+trees from contributing agenda items.
+
+@node Sparse trees, , Archiving, Document Structure
@section Sparse trees
@cindex sparse trees
@cindex trees, sparse
@emph{sparse trees} for selected information in an outline tree. A
sparse tree means that the entire document is folded as much as
possible, but the selected information is made visible along with the
-headline structure above it. Just try it out and you will see
+headline structure above it@footnote{See also the variable
+@code{org-show-following-heading}.}. Just try it out and you will see
immediately how it works.
Org-mode contains several commands creating such trees. The most
Other commands are using this feature as well. For example @kbd{C-c
C-v} creates a sparse TODO tree (@pxref{TODO basics}).
-@node TODO items, Tables, Document Structure, Top
-@chapter TODO items
-@cindex TODO items
-
-Org-mode does not maintain TODO lists as a separate document. TODO
-items are an integral part of the notes file, because TODO items
-usually come up while taking notes! With Org-mode, you simply mark
-any entry in a tree as being a TODO item. In this way, the
-information is not duplicated, and the entire context from which the
-item emerged is always present when you check.
-
-Of course, this technique causes TODO items to be scattered throughout
-your file. Org-mode provides methods to give you an overview over all
-things you have to do.
-
-@menu
-* TODO basics:: Marking and displaying TODO entries
-* Priorities:: Some things are more important than others
-* TODO extensions:: Workflow and assignments
-@end menu
-
-@node TODO basics, Priorities, TODO items, TODO items
-@section Basic TODO functionality
-
-Any headline can become a TODO item by starting it with the word TODO,
-for example
-
-@example
-*** TODO Write letter to Sam Fortune
-@end example
-
-@noindent
-The most important commands to work with TODO entries are:
-
-@table @kbd
-@kindex C-c C-t
-@item C-c C-t
-Rotate the TODO state of the current item between
-@example
-,-> (unmarked) -> TODO -> DONE --.
-'--------------------------------'
-@end example
-@kindex C-c C-v
-@cindex sparse tree, for TODO
-@item C-c C-v
-View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds
-the entire buffer, but shows all TODO items and the headings hierarchy
-above them. With prefix arg, show also the DONE entries.
-@end table
-
-@node Priorities, TODO extensions, TODO basics, TODO items
-@section Priorities
-@cindex priorities
-
-If you use Org-mode extensively to organize your work, you may end up
-with a number of TODO entries so large that you'd like to prioritize
-them. You can do this by placing a @emph{priority cookie} into the
-headline, like this
-
-@example
-*** TODO [#A] Write letter to Sam Fortune
-@end example
-
-@noindent
-With its standard setup, Org-mode supports priorities @samp{A},
-@samp{B}, and @samp{C}. @samp{A} is the highest priority. An entry
-without a cookie is treated as priority @samp{B}. Priorities make a
-difference only in the multi-file agenda (@pxref{Agenda (multiple files)}).
-
-@table @kbd
-@kindex @kbd{C-c ,}
-@item @kbd{C-c ,}
-Set the priority of the current item. The command prompts for a
-priority character @samp{A}, @samp{B} or @samp{C}. When you press
-@key{SPC} instead, the priority cookie is removed from the headline.
-@kindex S-@key{up}
-@kindex S-@key{down}
-@item S-@key{up}
-@itemx S-@key{down}
-Increase/decrease priority of current item. Note that these keys are
-also used to modify time stamps (@pxref{Creating timestamps}).
-@end table
-
-
-@node TODO extensions, , Priorities, TODO items
-@section Extended use of TODO keywords
-@cindex extended TODO keywords
-
-The default implementation of TODO entries is just two states: TODO
-and DONE. You can, however, use the TODO feature for more
-complicated things by configuring the variables
-@code{org-todo-keywords} and @code{org-todo-interpretation}. Using
-special setup, you can even use TODO keywords in different ways in
-different org files.
-
-@menu
-* Workflow states:: From TODO to DONE in steps
-* TODO types:: I do this, Fred the rest
-* Per file keywords:: Different files, different requirements
-@end menu
-
-@node Workflow states, TODO types, TODO extensions, TODO extensions
-@subsection TODO keywords as workflow states
-@cindex TODO workflow
-@cindex workflow states as TODO keywords
-
-You can use TODO keywords to indicate different states in the process
-of working on an item, for example
-
-@lisp
-(setq org-todo-keywords '("TODO" "FEEDBACK" "VERIFY" "DONE")
- org-todo-interpretation 'sequence)
-@end lisp
-
-With this setup, the command @kbd{C-c C-t} will cycle an entry from
-TODO to FEEDBACK, then to VERIFY, and finally too DONE. You may also
-use a prefix argument to quickly select a specific state. For example
-@kbd{C-3 C-c C-t} will change the state immediately to VERIFY.
-If you define many keywords, you can use in-buffer completion (see
-@ref{Completion}) to insert these words into the buffer.
-
-@node TODO types, Per file keywords, Workflow states, TODO extensions
-@subsection TODO keywords as types
-@cindex TODO types
-@cindex names as TODO keywords
-@cindex types as TODO keywords
-
-The second possibility is to use TODO keywords to indicate different
-types of action items. For example, when you work with several people
-on a single project, you might want to assign action items to
-persons.
-
-@lisp
-(setq org-todo-keywords '("Fred" "Sara" "Lucy" "Mike" "DONE")
- org-todo-interpretation 'type)
-@end lisp
-
-In this case, different keywords do not indicate a sequence, but
-rather different levels. This changes the behavior of the command
-@kbd{C-c C-t} slightly. When used several times in succession, it
-will still cycle through all names. But when when you return to the
-item after some time and execute @kbd{C-c C-t} again, it will switch
-from each name directly to DONE. Use prefix arguments or completion
-to quickly select a specific name.
-
-@node Per file keywords, , TODO types, TODO extensions
-@subsection Setting up TODO keywords for individual files
-@cindex keyword options
-@cindex per file keywords
-
-It can be very useful to use different aspects of the TODO mechanism
-in different files. For this you need to add special lines to the
-file which set the keywords and interpretation for that file only.
-For example, to set one of the two examples discussed above, you
-need one of the following lines, starting in column zero anywhere in
-the file:
-
-@example
-#+SEQ_TODO: TODO FEEDBACK VERIFY DONE
-#+TYP_TODO: Fred Sara Lucy Mike DONE
-@end example
-
-@cindex Completing option keywords
-@kindex M-@key{TAB}
-@noindent To make sure you are using the correct keyword, type
-@samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
-
-@cindex DONE, final TODO keyword
-Remember that the last keyword must always mean that the
-item is DONE (you may use a different word, though). After changing
-these lines, use @kbd{M-x normal-mode} to make the changes known to
-Org-mode. Also note that in each file, only one of the two aspects
-of TODO keywords can be used.
-
-If you want to use very many keywords, for example when working with a
-large group of people, you may split the names over several lines:
-
-@example
-#+TYP_TODO: Fred Sara Lucy Mike
-#+TYP_TODO: Luis George Jules Jessica
-#+TYP_TODO: Kim Arnold Peter
-#+TYP_TODO: DONE
-@end example
-
-@node Tables, Hyperlinks, TODO items, Top
+@kindex C-c C-x v
+@cindex printing sparse trees
+@cindex visible text, printing
+To print a sparse tree, you can use the Emacs command
+@code{ps-print-buffer-with-faces} which does not print invisible parts
+of the document @footnote{This does not work under XEmacs, because
+XEmacs uses selective display for outlining, not text properties}.
+Or you can use the command @kbd{C-c C-x v} to copy the visible part of
+the document to another file (extension @file{.txt}) which then can be
+printed in any desired way.
+
+@node Tables, Hyperlinks, Document Structure, Top
@chapter Tables
@cindex tables
-For taking notes, tables are an essential tool because they allow
-immediate and clear structuring of data. Org-mode has a very fast and
-intuitive table editor built-in. More complex tables can be created
-with the Emacs table.el package.
+Org-mode has a very fast and intuitive table editor built-in.
+Spreadsheet-like calculations are supported in connection with the
+Emacs @file{calc} package.
@menu
* Built-in table editor:: Simple tables
-* table.el:: Complex tables
+* Table calculations:: Compute a field from other fields
* orgtbl-mode:: The table editor as minor mode
+* table.el:: Complex tables
@end menu
-@node Built-in table editor, table.el, Tables, Tables
+@node Built-in table editor, Table calculations, Tables, Tables
@section The built-in table editor
@cindex table editor, builtin
@end example
A table is re-aligned automatically each time you press @key{TAB} or
-@key{RET} inside the table. @key{TAB} also moves to the next field
-(@key{RET} to the next row) and creates new table rows at the end of the
-table or before horizontal lines. The indentation of the table is set
-by the first line. Any line starting with @samp{|-} is considered as a
-horizontal separator line and will be expanded on the next re-align to
-span the whole table width. So, to create the above table, you would
-only type
+@key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to
+the next field (@key{RET} to the next row) and creates new table rows
+at the end of the table or before horizontal lines. The indentation
+of the table is set by the first line. Any line starting with
+@samp{|-} is considered as a horizontal separator line and will be
+expanded on the next re-align to span the whole table width. So, to
+create the above table, you would only type
@example
|Name|Phone|Age
@table @kbd
@tsubheading{Creation and conversion}
-@kindex C-c C-c
-@item C-c C-c
-Recognize @file{table.el} table. Works when the cursor is in a
-table.el table
+@item M-x org-table-create
+Creates an empty Org-mode table. However, it is much easier to just
+start typing, like @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}
@kindex C-c C-c
@item C-c C-c
can use a prefix argument to indicate how many consecutive spaces are
at least required to indicate a field separator (default: just one).
-@item M-x org-table-create
-Creates an empty Org-mode table. However, it is much easier to just
-start typing, like @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}
-
@tsubheading{Re-aligning and field motion}
@kindex C-c C-c
@item C-c C-c
@kindex S-@key{TAB}
@item S-@key{TAB}
-Move to previous field.
+Re-align, move to previous field.
@kindex @key{RET}
@item @key{RET}
necessary. At the beginning or end of a line, @key{RET} still does
NEWLINE, so it can be used to split a table.
-@kindex S-@key{RET}
-@item S-@key{RET}
-Copy from first non-empty
- field above current field.
-
@tsubheading{Column and row editing}
@kindex M-@key{left}
@kindex M-@key{right}
@kindex C-c -
@item C-c -
-Insert a horizontal line below current row. With prefix arg, line is
-created above the current line.
+Insert a horizontal line below current row. With prefix arg, the line
+is created above the current line.
@tsubheading{Regions}
@kindex C-c C-h M-w
@item C-c C-h M-w
-Copy an rectangular region from a table to a special clipboard. Point
+Copy a rectangular region from a table to a special clipboard. Point
and mark determine edge fields of the rectangle. The process ignores
horizontal separator lines.
@kindex C-c C-h C-w
@item C-c C-h C-w
-Copy an rectangular region from a table to a special clipboard, and
-blank all fields in the rectangle.
+Copy a rectangular region from a table to a special clipboard, and
+blank all fields in the rectangle. So this is the ``cut'' operation.
@kindex C-c C-h C-y
@item C-c C-h C-y
-Paste a rectangluar region into a table.
+Paste a rectangular region into a table.
The upper right corner ends up in the current field. All involved fields
will be overwritten. If the rectangle does not fit into the present table,
the table is enlarged as needed. The process ignores horizontal separator
above.
@tsubheading{Calculations}
+@cindex formula, in tables
+@cindex calculations, in tables
+@kindex C-c =
+@item C-c =
+Install a new formula for the current column and replace current field
+with the result of the formula.
+
+@kindex C-u C-c =
+@item C-u C-c =
+Install a new formula for the current field, which must be a named
+field. Evaluate the formula and replace the field content with the
+result.
+
+@kindex C-c '
+@item C-c '
+Edit all formulas associated with the current table in a separate
+buffer.
+
+@kindex C-c *
+@item C-c *
+Recalculate the current row by applying the stored formulas from left
+to right. When called with a @kbd{C-u} prefix, recalculate the
+entire table, starting with the first non-header line (i.e. below the
+first horizontal separator line). For details, see @ref{Table calculations}.
+
+@kindex C-#
+@item C-#
+Rotate the calculation mark in first column through the states
+@samp{}, @samp{#}, @samp{*}, @samp{!}, @samp{$}. For the meaning of
+these marks see @ref{Advanced features}. When there is an active
+region, change all marks in the region.
+
@kindex C-c ?
@item C-c ?
Which table column is the cursor in? Displays number >0 in echo
-area.
+area.
@cindex region, active
@cindex active region
@kindex C-c +
@item C-c +
Sum the numbers in the current column, or in the rectangle defined by
-the active region. The result is displayed in the echo area and can
+the active region. The result is shown in the echo area and can
be inserted with @kbd{C-y}.
-@cindex formula, in tables
-@cindex calculations, in tables
-@kindex C-c =
-@item C-c =
-Replace current field with the result of a formula. Requires the
-Emacs calc package. The formula can access the current field with
-@samp{$}, and the other fields in the current row
-with @samp{$1}, @samp{$2},... For details see the documentation of the
-command @command{org-table-eval-formula}.
+@kindex S-@key{RET}
+@item S-@key{RET}
+When current field is empty, copy from first non-empty field above.
+When not empty, copy current field down to next row and move cursor
+along with it. Depending on the variable
+@code{org-table-copy-increment}, integer field values will be
+incremented during copy. This key is also used by CUA-mode
+(@pxref{Interaction}).
@tsubheading{Miscellaneous}
@kindex C-c |
Toggle the visibility of vertical lines in tables. The lines are
still there, only made invisible with a text property. Any @samp{|}
added by hand will become invisible on the next align.
-Typographically it is good style to have no vertical lines in tables.
@item M-x org-table-import
Import a file as a table. The table should be TAB- or whitespace
@noindent The only table command which then still works is
@kbd{C-c C-c} to do a manual re-align.
-@node table.el, orgtbl-mode, Built-in table editor, Tables
+@node Table calculations, orgtbl-mode, Built-in table editor, Tables
+@section Calculations in tables
+@cindex calculations, in tables
+
+The table editor has some spreadsheet-like capabilities. The Emacs
+@file{calc} package is required for this feature to work. There are
+basically two levels of complexity for table calculations in Org-mode.
+On the basic level, tables do only horizontal computations, so a field
+can be computed from other fields @emph{in the same row}, and Org-mode
+assumes that there is only one formula for each column. This is very
+efficient to work with and enough for many tasks. On the complex
+level, columns and individual fields can be named for easier
+referencing in formulas, individual named fields can have their own
+formula associated with them, and recalculation can be automated.
+
+@menu
+* Formula syntax:: How to write a formula
+* Column formulas:: Formulas valid for all fields in a column
+* Advanced features:: Field names, parameters and automatic recalc
+* Named-field formulas:: Formulas valid in single fields
+* Editing/debugging formulas:: Changing a stored formula
+* Appetizer:: Taste the power of calc
+@end menu
+
+@node Formula syntax, Column formulas, Table calculations, Table calculations
+@subsection Formula syntax
+
+A formula can be any algebraic expression understood by the Emacs
+@file{calc} package. Before evaluation by @code{calc-eval}
+(@pxref{Calling Calc from Your Lisp Programs,calc-eval,Calling calc
+from Your Lisp Programs,calc,GNU Emacs Calc Manual}), variable
+substitution takes place:
+
+@example
+ $ @r{refers to the current field}
+ $3 @r{refers to the field in column 3 of the current row}
+ $3..$7 @r{a vector of the fields in columns 3-7 of current row}
+ $P1..$P3 @r{vector of column range, using column names}
+ &2 @r{second data field above the current, in same column}
+ &5-2 @r{vector from fifth to second field above current}
+ &III-II @r{vector of fields between 2nd and 3rd hline above}
+ &III @r{vector of fields between third hline above and current field}
+ $name @r{a named field, parameter or constant}
+@end example
+
+The range vectors can be directly fed into the calc vector functions
+like functions @samp{vmean} and @samp{vsum}.
+
+@samp{$name} is interpreted as the name of a column, parameter or
+constant. Constants are defined globally through the variable
+@code{org-table-formula-constants}. If you have the
+@file{constants.el} package, it will also be used to resolve
+constants, including natural constants like @samp{$k} for Planck's
+constant, units like @samp{$km} for kilometers. Column names and
+parameters can be specified in special table lines. These are
+described below, see @ref{Advanced features}.
+
+A formula can contain an optional mode string after a semicolon. This
+string consists of flags to influence calc's modes@footnote{By
+default, Org-mode uses the standard calc modes (precision 12, angular
+units degrees, fraction and symbolic modes off). However, the display
+format which has been changed to @code{(float 5)} to keep tables
+compact. The default settings can be configured using the variable
+@code{org-calc-default-modes}.} during execution, e.g. @samp{p20} to
+switch the internal precision to 20 digits, @samp{n3}, @samp{s3},
+@samp{e2} or @samp{f4} to switch to normal, scientific, engineering,
+or fix display format, respectively, and @samp{D}, @samp{R}, @samp{F},
+and @samp{S} to turn on degrees, radians, fraction and symbolic modes,
+respectively. In addition, you may provide a @code{printf} format
+specifier to reformat the final result. A few examples:
+@example
+ $1+$2 @r{Sum of first and second field}
+ $1+$2;%.2f @r{Same, format result to two decimals}
+ exp($2)+exp($1) @r{Math functions can be used}
+ $;%.1f @r{Reformat current cell to 1 decimal}
+ ($3-32)*5/9 @r{Degrees F -> C conversion}
+ $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}}
+ tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1}
+ sin($1);Dp3%.1e @r{Same, but use printf specifier for display}
+ vmean($2..$7) @r{Compute column range mean, using vector function}
+ vsum(&III) @r{Sum numbers from 3rd hline above to here}
+ taylor($3,x=7,2) @r{taylor series of $3, at x=7, second degree}
+@end example
+
+@node Column formulas, Advanced features, Formula syntax, Table calculations
+@subsection Column formulas
+
+To apply a formula to a field, type it directly into the field,
+preceded by an equal sign, like @samp{=$1+$2}. When you press
+@key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the
+field, the formula will be stored as the formula for the current
+column, evaluated and the current field replaced with the result. If
+the field contains only @samp{=}, the previously stored formula for
+this column is used.
+
+For each column, Org-mode will remember the most recently used
+formula. The information is stored in a special line starting with
+@samp{#+TBLFM} directly below the table. When adding/deleting/moving
+columns with the appropriate commands, the stored equations will be
+modified accordingly. When a column used in a calculation is removed,
+references to this column become invalid and will cause an error upon
+applying the equation.
+
+Instead of typing an equation into the field, you may also use the
+command @kbd{C-c =}. It prompts for a formula (with default taken
+from the @samp{#+TBLFM:} line) and applies it to the current field. A
+numerical prefix (e.g. @kbd{C-5 C-c =}) will apply it to that many
+subsequent fields in the current column.
+
+To recompute all the fields in a line, use the command @kbd{C-c *}.
+It re-applies all stored equations to the current row, from left to
+right. With a @kbd{C-u} prefix, this will be done to every line in
+the table, so use this command it you want to make sure the entire
+table is up-to-date. @kbd{C-u C-c C-c} is another way to update the
+entire table. Global updating does not touch the line(s) above the
+first horizontal separator line, assuming that this is the table
+header.
+
+@node Advanced features, Named-field formulas, Column formulas, Table calculations
+@subsection Advanced features
+
+If you want want the recalculation of fields to happen automatically,
+or if you want to be able to assign a formula to an individual field
+(instead of an entire column) you need to reserve the first column of
+the table for special marking characters. Here is an example of a
+table that collects exam results of students and makes use of these
+features:
+@example
+@group
+|---+---------+--------+--------+--------+-------+------|
+| | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
+|---+---------+--------+--------+--------+-------+------|
+| ! | | P1 | P2 | P3 | Tot | |
+| # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
+| ^ | | m1 | m2 | m3 | mt | |
+|---+---------+--------+--------+--------+-------+------|
+| # | Peter | 10 | 8 | 23 | 41 | 8.2 |
+| # | Sara | 6 | 14 | 19 | 39 | 7.8 |
+| # | Sam | 2 | 4 | 3 | 9 | 1.8 |
+|---+---------+--------+--------+--------+-------+------|
+| | Average | | | | 29.7 | |
+| ^ | | | | | at | |
+| $ | max=50 | | | | | |
+|---+---------+--------+--------+--------+-------+------|
+#+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(&II);%.1f
+@end group
+@end example
+
+@noindent @b{Important}: Please note that for these special tables,
+recalculating the table with @kbd{C-u C-c *} does only affect rows
+which are marked @samp{#} or @samp{*}, and named fields. The column
+formulas are not applied in rows with empty first field.
+
+The marking characters have the following meaning:
+@table @samp
+@item !
+The fields in this line define names for the columns, so that you may
+refer to a column as @samp{$Tot} instead of @samp{$6}.
+@item ^
+This row define names for the fields @emph{above} the row. With such
+a definition, any formula in the table may use @samp{$m1} to refer to
+the value @samp{10}. Also, named fields can have their own formula
+associated with them.
+@item _
+Similar to @samp{^}, but defines names for the fields in the row
+@emph{below}.
+@item $
+Fields in this row can define @emph{parameters} for formulas. For
+example, if a field in a @samp{$} row contains @samp{max=50}, then
+formulas in this table can refer to the value 50 using @samp{$max}.
+Parameters work exactly like constants, only that they can be defined on
+a per-table basis. Changing a parameter and then recalculating the
+table can be useful.
+@item #
+Fields in this row are automatically recalculated when pressing
+@key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row
+is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked
+lines will be left alone by this command.
+@item *
+Selects this line for global recalculation with @kbd{C-u C-c *}, but
+not for automatic recalculation. Use this when automatic
+recalculation slows down editing too much.
+@item
+Unmarked lines are exempted from recalculation with @kbd{C-u C-c *}.
+All lines that should be recalculated should be marked with @samp{#}
+or @samp{*}.
+@end table
+
+@node Named-field formulas, Editing/debugging formulas, Advanced features, Table calculations
+@subsection Named-field formulas
+
+A named field can have its own formula associated with it. In the
+example above, this is used for the @samp{at} field that contains
+the average result of the students. To enter a formula for a named
+field, just type it onto the buffer, preceded by @samp{:=}. Or use
+@kbd{C-u C-c =}. This equation will be stored below the table like
+@samp{$name=...}. Any recalculation in the table (even if only
+requested for the current line) will also update all named field
+formulas.
+
+@node Editing/debugging formulas, Appetizer, Named-field formulas, Table calculations
+@subsection Editing and debugging formulas
+
+To edit a column or field formula, you can use the commands @kbd{C-c
+=} and @kbd{C-u C-c =}, respectively. The currently active expression
+is then presented as default in the minibuffer, were it may be edited.
+
+Note that making a table field blank does not remove the formula
+associated with the field - during the next recalculation the field
+will be filled again. To remove a formula from a field, you have to
+give an empty reply when prompted for the formula, or to edit the
+@samp{#+TBLFM} line.
+
+@kindex C-c C-c
+You may edit the @samp{#+TBLFM} directly and re-apply
+the changed equations with @kbd{C-c C-c} in that line, or with the
+normal recalculation commands in the table.
+
+@kindex C-c '
+@kindex C-c C-c
+@kindex C-c C-q
+@kindex C-c ?
+In particular for large tables with many formulas, it is convenient to
+use the command @kbd{C-c '} to edit the formulas of the current table
+in a separate buffer. That buffer will show the formulas one per
+line, and you are free to edit, add and remove formulas. Press
+@kbd{C-c ?} on a @samp{$...} expression to get information about its
+interpretation. Exiting the buffer with @kbd{C-c C-c} only stores the
+modified formulas below the table. Exiting with @kbd{C-u C-c C-c}
+also applies them to the entire table. @kbd{C-c C-q} exits without
+installing the changes.
+
+When the evaluation of a formula leads to an error, the field content
+becomes the string @samp{#ERROR}. If you would like see what is going
+on during variable substitution and calculation in order to find a
+bug, turn on formula debugging in the menu and repeat the calculation
+by pressing, for example by pressing @kbd{C-c = @key{RET}} in a field.
+Detailed information will be displayed.
+
+@node Appetizer, , Editing/debugging formulas, Table calculations
+@subsection Appetizer
+
+Finally, just to wet your appetite on what can be done with the fantastic
+@file{calc} package, here is a table that computes the Taylor series
+for a couple of functions (homework: try that with Excel :-)
+
+@example
+@group
+|---+-------------+---+-----+--------------------------------------|
+| | Func | n | x | Result |
+|---+-------------+---+-----+--------------------------------------|
+| # | exp(x) | 1 | x | 1 + x |
+| # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
+| # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
+| # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
+| # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
+| * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
+|---+-------------+---+-----+--------------------------------------|
+#+TBLFM: $5=taylor($2,$4,$3);n3
+@end group
+@end example
+
+@node orgtbl-mode, table.el, Table calculations, Tables
+@section The Orgtbl minor mode
+@cindex orgtbl-mode
+@cindex minor mode for tables
+
+If you like the intuitive way the Org-mode table editor works, you
+might want to use it also in other modes like text-mode or mail-mode.
+The minor mode Orgtbl-mode makes this possible. You can always toggle
+the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for
+example in mail mode, use
+@lisp
+(add-hook 'mail-mode-hook 'turn-on-orgtbl)
+@end lisp
+
+@node table.el, , orgtbl-mode, Tables
@section The @file{table.el} package
@kindex C-c C-c
-@cindex table editor, table.el
+@cindex table editor, @file{table.el}
@cindex @file{table.el}
-More complex ASCII tables (with automatic line wrapping, column- and
-row-spanning, and alignment) can be created using the Emacs table
+Complex ASCII tables with automatic line wrapping, column- and
+row-spanning, and alignment can be created using the Emacs table
package by Takaaki Ota (@uref{http://sourceforge.net/projects/table}).
When @key{TAB} or @kbd{C-c C-c} is pressed in such a table, Org-mode
will call @command{table-recognize-table} and move the cursor into the
table. Inside a table, the keymap of Org-mode is inactive. In order
-to execute org-related commands, leave the table.
+to execute Org-mode-related commands, leave the table.
@table @kbd
-@kindex C-c #
-@item C-c #
+@kindex C-c C-c
+@item C-c C-c
+Recognize @file{table.el} table. Works when the cursor is in a
+table.el table.
+
+@kindex C-c ~
+@item C-c ~
Insert a table.el table. If there is already a table at point, this
command converts it between the table.el format and the Org-mode
format. See the documentation string of the command
possible.
@end table
-@node orgtbl-mode, , table.el, Tables
-@section The Orgtbl minor mode
-@cindex orgtbl-mode
-@cindex Minor mode for tables
-
-If you like the intuitive way the Org-mode table editor works, you
-might want to use it also in other modes like text-mode or mail-mode.
-The minor mode Orgtbl-mode make this possible. You can always toggle
-the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for
-example in mail mode, use
-@lisp
-(add-hook 'mail-mode-hook 'turn-on-orgtbl)
-@end lisp
-
-@node Hyperlinks, Timestamps, Tables, Top
+@node Hyperlinks, TODO items, Tables, Top
@chapter Hyperlinks
@cindex hyperlinks
-Just like HMTL, Org-mode provides links to other files, usenet
+Just like HMTL, Org-mode provides links to other files, Usenet
articles, emails and much more.
@menu
@cindex links
@cindex GNUS links
@cindex BBDB links
+@cindex URL links
+@cindex file links
@cindex VM links
@cindex RMAIL links
@cindex WANDERLUST links
@cindex USENET links
@cindex SHELL links
-Org-mode supports links to files, websites, usenet and email messages;
-and BBDB database entries. Links are just plain-text URL-like locators.
-The following list shows examples for each link type.
+Org-mode supports links to files, websites, Usenet and email messages;
+and BBDB database entries. Links are just plain-text URL-like
+locators, optionally enclosed by angular brackets. The following list
+shows examples for each link type.
@example
-http://www.astro.uva.nl/~dominik @r{on the web}
-file:/home/dominik/images/jupiter.jpg @r{file, absolute path}
-file:papers/last.pdf @r{file, relative path}
-file:~/code/main.c:255 @r{file, with line number}
-news:comp.emacs @r{Usenet link}
-mailto:adent@@galaxy.net @r{Mail link}
-vm:folder @r{VM folder link}
-vm:folder#id @r{VM message link}
-vm://myself@@some.where.org/folder#id @r{VM on remote machine}
-wl:folder @r{WANDERLUST folder link}
-wl:folder#id @r{WANDERLUST message link}
-rmail:folder @r{RMAIL folder link}
-rmail:folder#id @r{RMAIL message link}
-gnus:group @r{GNUS group link}
-gnus:group#id @r{GNUS article link}
-bbdb:Richard Stallman @r{BBDB link}
-shell:ls *.org @r{A shell command}
+<http://www.astro.uva.nl/~dominik> @r{on the web}
+<file:/home/dominik/images/jupiter.jpg> @r{file, absolute path}
+<file:papers/last.pdf> @r{file, relative path}
+<file:~/code/main.c:255> @r{file, with line number}
+<news:comp.emacs> @r{Usenet link}
+<mailto:adent@@galaxy.net> @r{Mail link}
+<vm:folder> @r{VM folder link}
+<vm:folder#id> @r{VM message link}
+<vm://myself@@some.where.org/folder#id> @r{VM on remote machine}
+<wl:folder> @r{WANDERLUST folder link}
+<wl:folder#id> @r{WANDERLUST message link}
+<rmail:folder> @r{RMAIL folder link}
+<rmail:folder#id> @r{RMAIL message link}
+<gnus:group> @r{GNUS group link}
+<gnus:group#id> @r{GNUS article link}
+<bbdb:Richard Stallman> @r{BBDB link}
+<shell:ls *.org>@footnote{Note that @samp{<} and @samp{>} cannot be part of a link, and therefore of a shell command. If you need redirection, use @@@{ and @@@} instead.} @r{A shell command}
@end example
-A link may contain space characters and is terminated by the end of
-the line. Therefore, there can be only one link per line (but see the
-variable @code{org-allow-space-in-links}).
+A link may contain space characters and is terminated by @samp{>} or by
+the end of a line. In tables, the end of a table field also terminates
+a link. Angle brackets around a link are not required, but are
+recommended to avoid problems with punctuation and other text following
+the link. See also the variable @code{org-allow-space-in-links}.
+
+@cindex storing links
+@table @kbd
+@kindex C-c l
+@item C-c l
+Store a link to the current location. This is a @emph{global} command
+which can be used in any buffer to create a link. The link will be
+stored for later insertion into an Org-mode buffer (see below). For VM,
+RMAIL, WANDERLUST, GNUS and BBDB buffers, the link will point to the
+current article/entry. For W3 and W3M buffer, the link goes to the
+current URL. For any other files, the link will just point to the file.
+The key binding @kbd{C-c l} is only a suggestion - see
+@ref{Installation and Activation}.
+
+@kindex C-c C-l
+@cindex completion, of links
+@cindex completion, of file names
+@item C-c C-l
+Insert a link. This prompts for a link to be inserted into the
+buffer. You can just type a link, using one of the link type prefixes
+mentioned in the examples above. Through completion, all links stored
+during the current session can be accessed. When called with prefix
+arg, you can use file name completion to enter a file link. The link
+will be formatted as given in the variable @code{org-link-format} and
+inserted into the buffer. Note that you don't have to use this
+command to insert a link. Links in Org-mode are plain text, and you
+can type or paste them straight into the buffer.
+
+@cindex inserting links
+@kindex C-c C-o
+@item C-c C-o
+Open link at point. This will launch a web browser for URLs (using
+@command{browse-url-at-point}), run vm/gnus/bbdb for the corresponding
+links, execute the command in a shell link, visit text files with
+Emacs and select a suitable application for non-text files.
+Classification of files is based on file extension only. See option
+@code{org-file-apps}. If there is no link at point, the current
+subtree will be searched for one. If you want to override the default
+application and visit the file with Emacs, use a @kbd{C-u} prefix.
+If the cursor is on a time stamp, compiles the agenda for that date.
+
+@strong{IMPORTANT}: Be careful not to use any dangerous commands in a
+shell link.
+
+@kindex mouse-2
+@item mouse-2
+On links, @kbd{mouse-2} will open the link just like @kbd{C-c C-o} would.
+
+@kindex mouse-3
+@item mouse-3
+Like @kbd{mouse-2}, but force file links to be opened with Emacs.
+@end table
+
+@node Remember, , Links, Hyperlinks
+@section Remember
+@cindex @file{remember.el}
+
+Another way to create org entries with links to other files is through
+the @emph{Remember} package by John Wiegley. @emph{Remember} lets you
+store quick notes with little interruption of your work flow. See
+@uref{http://www.emacswiki.org/cgi-bin/wiki/RememberMode} for more
+information. The notes produced by @emph{Remember} can be stored in
+different ways, and Org-mode files are a good target. Org-mode allows
+to file away notes either to a default file, or directly to the
+correct location in your Org-mode outline tree. The following
+customization@footnote{The two autoload forms are only necessary if
+@file{org.el} is not part of the Emacs distribution or and XEmacs
+package.} will tell @emph{Remember} to use org files as target, and to
+create annotations compatible with Org-mode links.
+
+@example
+(autoload 'org-remember-annotation "org")
+(autoload 'org-remember-handler "org")
+(setq org-directory "~/path/to/my/orgfiles/")
+(setq org-default-notes-file "~/.notes")
+(setq remember-annotation-functions '(org-remember-annotation))
+(setq remember-handler-functions '(org-remember-handler))
+@end example
+
+When you compose a note with remember, you have to press @kbd{C-c C-c}
+to exit remember-mode and to file away the note. The handler first
+prompts for a target file - if you press @key{RET}, the value of
+@code{org-default-notes-file} is used. Then the command offers the
+headings tree of the selected file. You can either immediately press
+@key{RET} to get the note appended to the file. Or you can use
+vertical cursor motion (@key{up} and @key{down}) and visibility
+cycling (@key{TAB}) to find a better place. Pressing @key{RET} or
+@key{left} or @key{right} leads to the following result.
+
+@multitable @columnfractions 0.2 0.1 0.7
+@item @b{Cursor position} @tab @b{Key} @tab @b{Note gets inserted}
+@item buffer-start @tab @key{RET} @tab as level 2 heading at end of file
+@item on headline @tab @key{RET} @tab as sublevel of the heading at cursor
+@item @tab @key{left} @tab as same level, before current heading
+@item @tab @key{right} @tab as same level, after current heading
+@item not on headline @tab @key{RET}
+ @tab at cursor position, level taken from context.
+ Or use prefix arg to specify level manually.
+@end multitable
+
+So a fast way to store the note is to press @kbd{C-c C-c @key{RET}
+@key{RET}} to append it to the default file. Even shorter would be
+@kbd{C-u C-c C-c}, which does the same without even showing the tree.
+But with little extra effort, you can push it directly to the correct
+location.
+
+Before inserting the text into a tree, the function ensures that the
+text has a headline, i.e. a first line that starts with a @samp{*}.
+If not, a headline is constructed from the current date and some
+additional data. If the variable @code{org-adapt-indentation} is
+non-nil, the entire text is also indented so that it starts in the
+same column as the headline (after the asterisks).
+
+@node TODO items, Timestamps, Hyperlinks, Top
+@chapter TODO items
+@cindex TODO items
+
+Org-mode does not maintain TODO lists as a separate document. TODO
+items are an integral part of the notes file, because TODO items
+usually come up while taking notes! With Org-mode, you simply mark
+any entry in a tree as being a TODO item. In this way, the
+information is not duplicated, and the entire context from which the
+item emerged is always present when you check.
+
+Of course, this technique causes TODO items to be scattered throughout
+your file. Org-mode provides methods to give you an overview over all
+things you have to do.
+
+@menu
+* TODO basics:: Marking and displaying TODO entries
+* TODO extensions:: Workflow and assignments
+* Priorities:: Some things are more important than others
+@end menu
+
+@node TODO basics, TODO extensions, TODO items, TODO items
+@section Basic TODO functionality
+
+Any headline can become a TODO item by starting it with the word TODO,
+for example
+
+@example
+*** TODO Write letter to Sam Fortune
+@end example
+
+@noindent
+The most important commands to work with TODO entries are:
+
+@table @kbd
+@kindex C-c C-t
+@item C-c C-t
+Rotate the TODO state of the current item between
+@example
+,-> (unmarked) -> TODO -> DONE --.
+'--------------------------------'
+@end example
+The same rotation can also be done ``remotely'' from the timeline and
+agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}).
+@kindex C-c C-v
+@cindex sparse tree, for TODO
+@item C-c C-v
+View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds
+the entire buffer, but shows all TODO items and the headings hierarchy
+above them. With prefix arg, show also the DONE entries.
+@item C-u C-c a
+A @kbd{C-u} argument to the @code{org-agenda command} (@pxref{Agenda})
+collects all unfinished TODO items into a single place.
+@end table
+
+@node TODO extensions, Priorities, TODO basics, TODO items
+@section Extended use of TODO keywords
+@cindex extended TODO keywords
+
+The default implementation of TODO entries is just two states: TODO
+and DONE. You can, however, use the TODO feature for more
+complicated things by configuring the variables
+@code{org-todo-keywords} and @code{org-todo-interpretation}. Using
+special setup, you can even use TODO keywords in different ways in
+different org files.
+
+@menu
+* Workflow states:: From TODO to DONE in steps
+* TODO types:: I do this, Fred the rest
+* Per file keywords:: Different files, different requirements
+@end menu
+
+@node Workflow states, TODO types, TODO extensions, TODO extensions
+@subsection TODO keywords as workflow states
+@cindex TODO workflow
+@cindex workflow states as TODO keywords
+
+You can use TODO keywords to indicate different states in the process
+of working on an item, for example
+
+@lisp
+(setq org-todo-keywords '("TODO" "FEEDBACK" "VERIFY" "DONE")
+ org-todo-interpretation 'sequence)
+@end lisp
+
+@cindex completion, of TODO keywords
+With this setup, the command @kbd{C-c C-t} will cycle an entry from
+TODO to FEEDBACK, then to VERIFY, and finally too DONE. You may also
+use a prefix argument to quickly select a specific state. For example
+@kbd{C-3 C-c C-t} will change the state immediately to VERIFY.
+If you define many keywords, you can use in-buffer completion (see
+@ref{Completion}) to insert these words into the buffer.
+
+@node TODO types, Per file keywords, Workflow states, TODO extensions
+@subsection TODO keywords as types
+@cindex TODO types
+@cindex names as TODO keywords
+@cindex types as TODO keywords
+
+The second possibility is to use TODO keywords to indicate different
+types of action items. For example, you might want to indicate that
+items are for ``work'' or ``home''. Or, when you work with several
+people on a single project, you might want to assign action items
+directly to persons, by using their names as TODO keywords. This
+would be set up like this:
+
+@lisp
+(setq org-todo-keywords '("Fred" "Sara" "Lucy" "Mike" "DONE")
+ org-todo-interpretation 'type)
+@end lisp
+
+In this case, different keywords do not indicate a sequence, but
+rather different types. So it is normally not useful to change from
+one type to another. Therefore, in this case the behavior of the
+command @kbd{C-c C-t} is changed slightly@footnote{This is also true
+for the @kbd{t} command in the timeline and agenda buffers.}. When
+used several times in succession, it will still cycle through all
+names. But when when you return to the item after some time and
+execute @kbd{C-c C-t} again, it will switch from each name directly to
+DONE. Use prefix arguments or completion to quickly select a specific
+name.
-@cindex storing links
-@table @kbd
-@kindex C-c l
-@item C-c l
-Store a link to the current location. This is a @emph{global} command
-which can be used in any buffer to create a link. The link will be
-stored for later insertion into an Org-mode buffer (see below). For VM,
-RMAIL, WANDERLUST, GNUS and BBDB buffers, the link will point to the
-current article/entry. For W3 and W3M buffer, the link goes to the
-current URL. For any other files, the link will just point to the file.
-The key binding @kbd{C-c l} is only a suggestion - see
-@ref{Installation}.
+@node Per file keywords, , TODO types, TODO extensions
+@subsection Setting up TODO keywords for individual files
+@cindex keyword options
+@cindex per file keywords
-@kindex C-c C-l
-@item C-c C-l
-Insert a link. This prompts for a link to be inserted into the
-buffer. You can just type a link, using one of the link type prefixes
-mentioned in the examples above. Through completion, all links stored
-during the current session can be accessed. When called with prefix
-arg, you can use file name completion to enter a file link. Note that
-you don't have to use this command to insert a link. Links in
-Org-mode are plain text, and you can type or paste them straight into
-the buffer.
+It can be very useful to use different aspects of the TODO mechanism
+in different files, which is not possible with the global settings
+described above. For file-local settings, you need to add special
+lines to the file which set the keywords and interpretation for that
+file only. For example, to set one of the two examples discussed
+above, you need one of the following lines, starting in column zero
+anywhere in the file:
-@cindex inserting links
-@kindex C-c C-o
-@item C-c C-o
-Open link at point. This will launch a web browser for URLs (using
-@command{browse-url-at-point}), run vm/gnus/bbdb for the corresponding
-links, execute the command in a shell link, visit text files with
-Emacs and select a suitable application for non-text files.
-Classification of files is based on file extension only. See option
-@code{org-file-apps}. If there is no link at point, the current
-subtree will be searched for one. If you want to override the default
-application and visit the file with Emacs, use a @kbd{C-u} prefix.
-If the cursor is on a time stamp, compiles the agenda for that date.
+@example
+#+SEQ_TODO: TODO FEEDBACK VERIFY DONE
+#+TYP_TODO: Fred Sara Lucy Mike DONE
+@end example
-@strong{IMPORTANT}: Be careful not to use any dangerous commands in a
-shell link.
+@cindex Completion, of option keywords
+@kindex M-@key{TAB}
+@noindent To make sure you are using the correct keyword, type
+@samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
-@kindex mouse-2
-@item mouse-2
-On links, @kbd{mouse-2} will open the link just like @kbd{C-c C-o} would.
+@cindex DONE, final TODO keyword
+Remember that the last keyword must always mean that the item is DONE
+(you may use a different word, though). Also note that in each file,
+only one of the two aspects of TODO keywords can be used. After
+changing one of these lines, use @kbd{C-c C-c} with the cursor still
+in the line to make the changes known to Org-mode@footnote{Org-mode
+parses these lines only when Org-mode is activated after visiting a
+file. @kbd{C-c C-c} with the cursor in a line starting with @samp{#-}
+is simply restarting Org-mode, making sure that these changes will be
+respected.}.
-@kindex mouse-3
-@item mouse-3
-Like @kbd{mouse-2}, but force file links to be opened with Emacs.
-@end table
+If you want to use very many keywords, for example when working with a
+large group of people, you may split the names over several lines:
-@node Remember, , Links, Hyperlinks
-@section Remember
-@cindex @file{remember.el}
+@example
+#+TYP_TODO: Fred Sara Lucy Mike
+#+TYP_TODO: Luis George Jules Jessica
+#+TYP_TODO: Kim Arnold Peter
+#+TYP_TODO: DONE
+@end example
-Another way to create org entries with links to other files is through
-the @emph{Remember} package by John Wiegley. @emph{Remember} lets you
-store quick notes with little interruption of your work flow. See
-@uref{http://www.emacswiki.org/cgi-bin/wiki/RememberMode} for more
-information. The notes produced by @emph{Remember} can be stored in
-different ways, and Org-mode files are a good target.
-Org-mode allows to file away notes either to a default file, or
-directly to the correct location in your Org-mode outline tree. The
-following customization will tell @emph{Remember} to use org files as
-target, and to create annotations compatible with Org-mode links.
+@node Priorities, , TODO extensions, TODO items
+@section Priorities
+@cindex priorities
+If you use Org-mode extensively to organize your work, you may end up
+with a number of TODO entries so large that you'd like to prioritize
+them. This can be done by placing a @emph{priority cookie} into the
+headline, like this
-@c FIXME: The autoload will not be necessary when Org-mode is part of Emacs
@example
-(autoload 'org-remember-annotation "org")
-(autoload 'org-remember-handler "org")
-(setq org-directory "~/path/to/my/orgfiles/")
-(setq org-default-notes-file "~/.notes")
-(setq remember-annotation-functions '(org-remember-annotation))
-(setq remember-handler-functions '(org-remember-handler))
+*** TODO [#A] Write letter to Sam Fortune
@end example
-When you compose a note with remember, you have to press @kbd{C-c C-c}
-to exit remember-mode and to file away the note. The handler first
-prompts for a target file - if you press @key{RET}, the value of
-@code{org-default-notes-file} is used. Then the command offers the
-headings tree of the selected file. You can either immediately press
-@key{RET} to get the note appended to the file. Or you can use
-vertical cursor motion (@key{up} and @key{down}) and visibility
-cycling (@key{TAB}) to find a better place. Pressing @key{RET} or
-@key{left} or @key{right} leads to the following result.
+@noindent
+With its standard setup, Org-mode supports priorities @samp{A},
+@samp{B}, and @samp{C}. @samp{A} is the highest priority. An entry
+without a cookie is treated as priority @samp{B}. Priorities make a
+difference only in the agenda (@pxref{Agenda}).
-@multitable @columnfractions 0.2 0.1 0.7
-@item @b{Cursor position} @tab @b{Key} @tab @b{Note gets inserted}
-@item buffer-start @tab @key{RET} @tab as level 2 heading at end of file
-@item on headline @tab @key{RET} @tab as sublevel of the heading at cursor
-@item @tab @key{left} @tab as same level, before current heading
-@item @tab @key{right} @tab as same level, after current heading
-@item not on headline @tab @key{RET}
- @tab at cursor position, level taken from context.
- Or use prefix arg to specify level manually.
-@end multitable
+@table @kbd
+@kindex @kbd{C-c ,}
+@item @kbd{C-c ,}
+Set the priority of the current item. The command prompts for a
+priority character @samp{A}, @samp{B} or @samp{C}. When you press
+@key{SPC} instead, the priority cookie is removed from the headline.
+The priorities can also be changed ``remotely'' from the timeline and
+agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
+
+@kindex S-@key{up}
+@kindex S-@key{down}
+@item S-@key{up}
+@itemx S-@key{down}
+Increase/decrease priority of current item. Note that these keys are
+also used to modify time stamps (@pxref{Creating timestamps}).
+Furthermore, these keys are also used by CUA-mode
+(@pxref{Interaction}).
+@end table
-So the fastest way to store the note is to press @kbd{C-c C-c @key{RET}
-@key{RET}} to append it to the default file. But with little extra
-effort, you can push it directly to the correct location.
-Before inserting the text into a tree, the function ensures that the
-text has a headline, i.e. a first line that starts with a @samp{*}.
-If not, a headline is constructed from the current date and some
-additional data. If the variable @code{org-adapt-indentation} is
-non-nil, the entire text is also indented so that it starts in the
-same column as the headline (after the asterixes).
-@node Timestamps, Timeline and Agenda, Hyperlinks, Top
+@node Timestamps, Timeline and Agenda, TODO items, Top
@chapter Timestamps
Items can be labeled with timestamps to make them useful for project
special format, either @samp{<2003-09-16 Tue>} or @samp{<2003-09-16
Tue 09:39>}. A time stamp can appear anywhere in the headline or body
of an org-tree entry. Its presence allows to show entries on specific
-dates in the agenda (@pxref{Agenda (multiple files)}). We distinguish:
+dates in the agenda (@pxref{Agenda}). We distinguish:
@table @var
@cindex timestamp
@end example
@item DEADLINE
-@cindex deadline
+@cindex DEADLINE keyword
If a time stamp is preceded by the word @samp{DEADLINE:}, the task
(most likely a TODO item) is supposed to be finished on that date, and
-it will be listed then. In addition, the compilation for the
-@emph{current day} will carry a warning about the approaching or
-missed deadline, starting @code{org-deadline-warning-days} before the
-due date, and continuing until the entry is marked DONE. An example:
+it will be listed then. In addition, the compilation for @emph{today}
+will carry a warning about the approaching or missed deadline,
+starting @code{org-deadline-warning-days} before the due date, and
+continuing until the entry is marked DONE. An example:
@example
*** TODO write article about the Earth for the Guide
- The editor in charge is bbdb:Ford Prefect
+ The editor in charge is <bbdb:Ford Prefect>
DEADLINE: <2004-02-29 Sun>
@end example
@item SCHEDULED
-@cindex scheduled
+@cindex SCHEDULED keyword
If a time stamp is preceded by the word @samp{SCHEDULED:}, it means
you are planning to start working on that task on the given date. The
headline will be listed under the given date. In addition, a reminder
that the scheduled date has passed will be present in the compilation
-for the @emph{current day}, until the entry is marked DONE. I.e., the
+for @emph{today}, until the entry is marked DONE. I.e., the
task will automatically be forwarded.
@end table
@kindex C-c C-o
@item C-c C-o
Access the agenda for the date given by the time stamp at point
-(@pxref{Agenda (multiple files)}).
+(@pxref{Agenda}).
@kindex C-c C-d
@item C-c C-d
@kindex S-@key{right}
@item S-@key{left}
@itemx S-@key{right}
-Change date at cursor by one day.
+Change date at cursor by one day. These key bindings conflict with
+CUA-mode (@pxref{Interaction}).
@kindex S-@key{up}
@kindex S-@key{down}
@itemx S-@key{down}
Change the item under the cursor in a timestamp. The cursor can be on
a year, month, day, hour or minute. Note that if the cursor is not at
-a time stamp, these same keys modify the priority of an item
-(@pxref{Priorities}).
+a time stamp, these same keys modify the priority of an item.
+(@pxref{Priorities}). The key bindings also conflict with CUA-mode
+(@pxref{Interaction}).
+
@kindex C-c C-y
@cindex evaluate time range
@cindex date, reading in minibuffer
@cindex time, reading in minibuffer
@cindex calendar, for selecting date
-When org prompts for a date/time, the function reading your input will
-replace anything you choose not to specify with the current date and
-time. For details, see the documentation string of
+When Org-mode prompts for a date/time, the function reading your input
+will replace anything you choose not to specify with the current date
+and time. For details, see the documentation string of
@command{org-read-date}. Also, a calender will pop up to allow
selecting a date. The calendar can be fully controlled from the
minibuffer, and a date can be selected with the following commands:
appointments.
@menu
-* Timeline (single file):: Time-sorted view for single file
-* Agenda (multiple files):: Your weekly planner
+* Timeline:: Time-sorted view for single file
+* Agenda:: Your weekly planner
* Agenda commands:: Remote editing of org trees
* Calendar/Diary integration:: Integrating Anniversaries and more
@end menu
-@node Timeline (single file), Agenda (multiple files), Timeline and Agenda, Timeline and Agenda
+@node Timeline, Agenda, Timeline and Agenda, Timeline and Agenda
@section Timeline for a single file
@cindex single file summary
@cindex agenda, for single file
commands available in the Agenda buffer are listed in @ref{Agenda
commands}.
-@node Agenda (multiple files), Agenda commands, Timeline (single file), Timeline and Agenda
-@section Agenda from multiple files
-@cindex agenda, from multiple files
+@node Agenda, Agenda commands, Timeline, Timeline and Agenda
+@section Agenda
+@cindex agenda
An agenda can be compiled from one or more org files. The main
-purpose of this command is to act like a planner, in order to show you
-what tasks are up for the current week, similar to a paper agenda.
+purpose of this command is to act like a paper agenda, showing you all
+the tasks for the current day or week.
The Org-mode files to be processed in order to generate the agenda are
listed in the variable @code{org-agenda-files}. You can customize
unfinished TODO items (also those without a date) are also listed at
the beginning of the buffer, before the first date.@*
The key binding @kbd{C-c a} is only a suggestion - see
-@ref{Installation}.
+@ref{Installation and Activation}.
@end table
The commands available in the Agenda buffer are listed in
@cindex category
In the agenda buffer, each entry is preceded by a @emph{category},
-which is derived from the file name. You can also set the category of
-a file through file variables, for example by making the first line of
-the file look like this:
-
-@cindex file variables
+which is derived from the file name. The category can also be set
+with a special line anywhere in the buffer, looking like this:
@example
-Planet Finder -*- mode: org; org-category: Cheops -*-
+#+CATEGORY: Thesis
@end example
@noindent
-Or, like with TODO keywords (@pxref{Per file keywords}), you can
-insert a special line anywhere in the file:
+After changing this line, press @kbd{C-c C-c} with the cursor still in
+the line, to make the changes known to org-mode. Otherwise, the
+change will only be active the next time you visit this file with
+Emacs.
+
+The display in the agenda buffer looks best if the category is not
+longer than 10 characters.
+
+@subsection Time-of-Day Specifications
+
+Org-mode checks each agenda item for a time-of-day specification. The
+time can be part of the time stamp that triggered inclusion into the
+agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time
+ranges can be specified with two time stamps, like
+@c
+@w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
+
+In the headline of the entry itself, a time(range) may also appear as
+plain text (like @samp{12:45} or a @samp{8:30-1pm}. If the agenda
+integrates the Emacs diary (@pxref{Calendar/Diary integration}), time
+specifications in diary entries are recognized as well.
+
+For agenda display, Org-mode extracts the time and displays it in a
+standard 24 hour format as part of the prefix. The example times in
+the previous paragraphs would end up in the agenda like this:
@example
-#+CATEGORY: Cheops
+ 8:30-13:00 Arthur Dent lies in front of the bulldozer
+ 12:45...... Ford Prefect arrives and takes Arthur to the pub
+ 19:00...... The Vogon reads his poem
+ 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
+@end example
+
+If the agenda is in single-day mode, or for the display of today, the
+timed entries are embedded in a time grid, like
+
+@example
+ 8:00...... ------------------
+ 8:30-13:00 Arthur Dent lies in front of the bulldozer
+ 10:00...... ------------------
+ 12:00...... ------------------
+ 12:45...... Ford Prefect arrives and takes Arthur to the pub
+ 14:00...... ------------------
+ 16:00...... ------------------
+ 18:00...... ------------------
+ 19:00...... The Vogon reads his poem
+ 20:00...... ------------------
+ 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
@end example
-@noindent
-The display looks best if the category is no longer than 10 characters.
+
+The time grid can be turned on and off with the variable
+@code{org-agenda-use-time-grid}, and can be configured with
+@code{org-agenda-time-grid}.
@subsection Sorting of agenda items
categories, in the sequence given by @code{org-agenda-files}. Within
each category, items are sorted by priority (@pxref{Priorities}).
-A time-of-day specification looks like @samp{12:45} or @samp{3pm} and
-must appear in the headline. For example, a timestamp in a headline
-that contains not only a date but also a time will trigger this
-mechanism. Specifications of a time in diary entries are recognized
-as well, so the schedule will be mixed from diary entries and Org-mode
-files.
-
The priority is a numerical quantity composed of the base priority
(2000 for priority @samp{A}, 1000 for @samp{B}, and 0 for @samp{C}),
plus additional increments for overdue scheduled or deadline items.
Sorting can be customized using the variable
@code{org-agenda-sorting-strategy}.
-@node Agenda commands, Calendar/Diary integration, Agenda (multiple files), Timeline and Agenda
+@node Agenda commands, Calendar/Diary integration, Agenda, Timeline and Agenda
@section Commands in the agenda buffer
-Entries in the agenda buffer are linked back to the org file. You are
-not allowed to edit the agenda buffer itself, but commands are provided
-to edit the org-files ``remotely'' from the agenda buffer. In this
-way, all information is stored only once, and you don't risk that your
-agenda and note files diverge.
+Entries in the agenda buffer are linked back to the org file or diary
+file where they originate. You are not allowed to edit the agenda
+buffer itself, but commands are provided to show and jump to the
+original entry location, and to edit the org-files ``remotely'' from
+the agenda buffer. In this way, all information is stored only once,
+and you don't risk that your agenda and note files diverge.
Some commands can be executed with mouse clicks on agenda lines. For
the other commands, the cursor needs to be in the desired line. Most
exceptions are marked.
@table @kbd
+@tsubheading{Motion}
+@kindex n
+@item n
+Next line (same as @key{up}).
+@kindex p
+@item p
+Previous line (same as @key{down}).
@tsubheading{View/GoTo org file}
@kindex mouse-3
@kindex @key{SPC}
@item mouse-3
-@itemx @key{SPC}
+@itemx @key{SPC}
Display the original location of the item in another window.
@kindex l
the agenda buffer, the other window always shows the corresponding
location in the org file.
-
@tsubheading{Change display}
@kindex o
@item o
@kindex w
@item w
-Toggle between weekly and daily view.
+Switch to weekly view (7 days displayed together)
@kindex d
@item d
+Switch to daily view (just one day displayed)
+
+@kindex D
+@item D
Toggle the inclusion of diary entries. See @ref{Calendar/Diary integration}.
+@kindex g
+@item g
+Toggle the time grid on and off. See also the variables
+@code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
+
@kindex r
@item r
Recreate the agenda buffer, for example to reflect the changes
Display the following @code{org-agenda-ndays} days. For example, if
the display covers a week, switch to the following week. With prefix
arg, go forward that many times @code{org-agenda-ndays} days. Not
-available in timlines.
+available in timelines.
@kindex @key{left}
@item @key{left}
Change the TODO state of the item, both in the agenda and in the
original org file.
-@kindex p
-@item p
+@kindex ,
+@item ,
Set the priority for the current item. Org-mode prompts for the
priority character. If you reply with @key{SPC}, the priority cookie
is removed from the entry.
Display weighted priority of current item.
@kindex +
+@kindex S-@key{up}
@item +
+@itemx S-@key{up}
Increase the priority of the current item. The priority is changed in
the original buffer, but the agenda is not resorted. Use the @kbd{r}
key for this.
@kindex -
+@kindex S-@key{down}
@item -
+@itemx S-@key{down}
Decrease the priority of the current item.
@kindex S-@key{right}
the future. With prefix argument, change it by that many days. For
example, @kbd{3 6 5 S-@key{right}} will change it by a year. The
stamp is changed in the original org file, but the change is not
-directly reflected in the agenda buffer. Use the
+directly reflected in the agenda buffer. Use the
@kbd{r} key to update the buffer.
@kindex S-@key{left}
entry in the diary, just like @kbd{i d} etc. would do in the calendar.
The date is taken from the cursor position.
+@tsubheading{Calendar commands}
+@kindex c
+@item c
+Open the Emacs calendar and move to the date at the agenda cursor.
+
+@item c
+When in the calendar, compute and show the Org-mode agenda for the
+date at the cursor.
+
+@kindex M
+@item M
+Show the phases of the moon for three month around current date.
+
+@kindex S
+@item S
+Show sunrise and sunset times. The geographical location must be set
+with calendar variables, see documentation of the Emacs calendar.
+
+@kindex C
+@item C
+Convert the date at cursor into many other cultural and historic
+calendars.
+
+@kindex H
+@item H
+Show holidays for three month around the cursor date.
+
@tsubheading{Quit and Exit}
@kindex q
@item q
the diary.
The interaction between Org-mode and diary works both ways: You can
-list entries from the diary in the Org-mode agenda, or you can display
-entries from the org agenda in the Emacs diary.
+list entries from the diary in the Org-mode agenda, from which many
+calendar and diary commands are directly accessible. Or you can
+display entries from the org agenda in the Emacs diary.
@menu
* Diary to agenda:: Agenda incorporates the diary
@end lisp
@noindent
-@noindent After that, everything will happen automatically.
+@noindent After that, everything will happen automatically. All diary
+entries including holidays, anniversaries etc will be included in the
+agenda buffer created by Org-mode. @key{SPC}, @key{TAB}, and
+@key{RET} can be used from the agenda buffer to jump to the diary
+file, in order to edit existing diary entries. The @kbd{i} command to
+insert new entries for the current date works in the agenda buffer, as
+well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
+Sunrise/Sunset times, show lunar phases and to convert to other
+calendars, respectively. @kbd{c} can be used to switch back and forth
+between calendar and agenda.
@node Agenda to diary, , Diary to agenda, Calendar/Diary integration
@subsection Including the agenda into the diary
If you prefer to use the Emacs diary as your main instrument and if
you wish to include the Org-mode agenda into it, the following steps
are necessary: Autoload the function @command{org-diary} as shown
-above under @ref{Installation}. You also need to use @emph{fancy
-diary display} by setting in @file{.emacs}:
+above under @ref{Installation and Activation}. You also need to use
+@emph{fancy diary display} by setting in @file{.emacs}:
@lisp
(add-hook 'diary-display-hook 'fancy-diary-display)
@node Exporting, Miscellaneous, Timeline and Agenda, Top
@chapter Exporting
@cindex exporting
-@cindex ASCII file
-@cindex HTML
-
+@cindex ASCII export
+@cindex HTML export
@cindex headline levels, for exporting
For printing and sharing of notes, an Org-mode document can be
@cindex active region
@cindex transient-mark-mode
@table @kbd
-@kindex C-c C-x a
+@kindex C-c C-x a
@item C-c C-x a
Export as ASCII file. If there is an active region, only the region
will be exported. For an org file @file{myfile.org}, the ASCII file
will be @file{myfile.txt}. The file will be overwritten without
warning.
-@kindex C-c C-x h
+@kindex C-c C-x h
@item C-c C-x h
Export as HTML file @file{myfile.html}.
-@kindex C-c C-x C-h
+@kindex C-c C-x C-h
@item C-c C-x C-h
Export as HTML file and open it with a browser.
@kindex C-c C-x t
@item
Simple @TeX{}-like math constructs are interpreted:
+@cindex completion, of @TeX{} symbols
@itemize @minus
@item
@samp{10^22} and @samp{J_n} are super- and subscripts. You can quote
@cindex tables, export to HTML
@item
-Tables are transformed into HTML tables.
+Tables are transformed into HTML tables. Data fields before the first
+horizontal separator line will be formatted as table header fields.
@cindex fixed width
@item
-Lines starting with @samp{:} are typeset in a fixed-width font, to
-allow quoting of computer code etc.
+If a headline starts with the word @samp{QUOTE}, the text below the
+headline will be typeset as fixed-width, to allow quoting of computer
+codes etc. Lines starting with @samp{:} are also typeset in
+fixed-width font.
@cindex HTML tags
@item
@section Export options
@cindex options, for export
+@cindex completion, of option keywords
The exporter recognizes special lines in the buffer which provide
additional information. These lines may be put anywhere in the file.
The whole set of lines can be inserted into the buffer with @kbd{C-c
C-x t}. For individual lines, a good way to make sure the keyword is
correct it to type @samp{#+} and then use @kbd{M-@key{TAB}} completion
-(@pxref{Completion}).
+(@pxref{Completion}).
@example
#+TITLE: the title to be shown (default is the buffer name)
@cindex headline levels
@cindex section-numbers
@cindex table of contents
-@cindex linebreak-preservation
+@cindex linebreak preservation
@cindex quoted html tags
@cindex fixed-width sections
@cindex tables
@menu
* Completion:: M-TAB knows what you need
* Customization:: Adapting Org-mode to your taste
-* Tips and Tricks:: An author-imposed FAQ, sort of
+* FAQ:: Frequently asked questions
* Interaction:: Other Emacs packages
-* Acknowledgments:: These people provided feedback and more
* Bugs:: Things which do not work perfectly
+* Acknowledgments:: These people provided feedback and more
@end menu
@node Completion, Customization, Miscellaneous, Miscellaneous
@section Completion
-@cindex complete @TeX{} symbols
-@cindex complete TODO keywords
-@cindex complete dictionary words
-@cindex complete option keywords
+@cindex completion, of @TeX{} symbols
+@cindex completion, of TODO keywords
+@cindex completion, of dictionary words
+@cindex completion, of option keywords
Org-mode supports in-buffer completion. This type of completion does
not make use of the minibuffer. You simply type a few letters into
@end itemize
@end table
-@node Customization, Tips and Tricks, Completion, Miscellaneous
+@node Customization, FAQ, Completion, Miscellaneous
@section Customization
@cindex customization
@cindex options, for customization
variables, use @kbd{M-x org-customize}. Or select @code{Browse Org
Group} from the @code{Org->Customization} menu.
-@node Tips and Tricks, Interaction, Customization, Miscellaneous
-@section Tips and Tricks
-
-@itemize @bullet
-@cindex README files
-@item
-I find Org-mode very useful for the many @file{README} files I have
-scattered through my directories. So I turn on @file{org-mode} for
-all @file{README} files with
+@node FAQ, Interaction, Customization, Miscellaneous
+@section Frequently asked questions
+@enumerate
+@item @b{Org-mode seems to be a useful default mode for the various
+@file{README} files I have scattered through my directories. How do I
+turn it on for all @file{README} files?}
@example
(add-to-list 'auto-mode-alist '("README$" . org-mode))
@end example
-@ignore
-@cindex files, adding automatically
-@item
-If you would like to add all org files you ever create to the list of
-agenda files@footnote{Think twice. Do you @emph{really} want this?},
-you could do so with
-
-@lisp
-(add-hook 'org-mode-hook 'org-add-file)
-@end lisp
-
-If you would like to add only a selection, for example everything
-except the @file{README} files, this could be achieved in the
-following way:
-
-@lisp
-(add-hook 'org-mode-hook
- (lambda ()
- (or (string-match "README\\'" (buffer-file-name))
- (org-add-file))))
-@end lisp
-@end ignore
-
+@item @b{I would like to have two windows on the same Org-mode
+file, but with different outline visibility. Is that possible?}@*
@cindex @code{make-indirect-buffer}
@cindex indirect buffers
-@item
-It can be useful to have two different windows showing the same
-Org-mode file. However, a problem here is that changes to the
-visibility in one window immediately affect the other window. On
-Emacs (not on XEmacs because it uses the old outline-mode) a way out
-is the use of @emph{indirect buffers}, which visit the same file, but
-have separate settings, also for outline visibility. See the
-documentation on the command @code{make-indirect-buffer}.
+In GNU Emacs, you may use @emph{indirect buffers} which do exactly
+this. See the documentation on the command
+@code{make-indirect-buffer}. In XEmacs, this is currently not
+possible because of the different outline implementation.
+@item @b{Is there an easy way to insert links to web locations?}@*
@cindex URL, paste into buffer
-@item
-Paste URLs into Org-mode whenever this seems useful. For example, if
-you are writing notes about a paper which is available on the web, put
-the corresponding URL there and a direct look at the paper is only a
-mouse click away. If you have a local copy of the paper, use a
-file:path link.
+Sure, just type or paste them into the buffer. A plain-text URL-like
+string is directly interpreted as a link.
-@cindex headline levels, for export
-@item
+@item @b{When I export my TODO list, every TODO item becomes a
+separate section. How do I enforce these items to be exported as an
+itemized list?}@*
If you plan to use ASCII or HTML export, make sure things you want to
be exported as item lists are level 4 at least, even if that does mean
there is a level jump. For example
+OPTIONS: H:2; ...
@end example
+@item @b{I would like to export only a subtree of my file to HTML. How?}@*
@cindex exporting a subtree
-@item
If you want to export a subtree, mark the subtree as region and then
export. Marking can be done with @kbd{C-c @@ C-x C-x}, for example.
+@item @b{Org-mode takes over the S-cursor keys. I also want to use
+CUA-mode, is there a way to fix this conflict?}@*
+Yes, see @ref{Interaction}
+
+@item @b{Is there an easy way to insert an empty table template with a
+default number of rows and columns?}@*
@cindex table, empty template
-@item
To insert an empty table template, just type @samp{|-} and use
-@key{TAB}.
-
-@item
-In a table, to add a new column at the end, just type some text
-anywhere after the final @samp{|}. Upon the next re-align, a new
-column will be created.
-
-@item
-In tables, @key{TAB} creates new rows before horizontal separator lines. If
-the cursor is at @samp{Age} in the following table,
-
-@example
-| Name | Phone | Age |
-|-------+-------+-----|
-| | | |
-@end example
-
-the next @key{TAB} would create a second header line. If you want
-instead to go to the first empty field below the horizontal line,
-press @key{down} (to get on the separator line) and then @key{TAB}.
-
+@key{TAB}. The default size can be changed with the variable
+@code{org-table-default-size}. However, just starting to type the
+first line is usually much easier.
+
+@item @b{One of my table columns has started to fill up with
+@samp{#ERROR}. What is going on?}@*
+Org-mode tried to compute the column from other fields using a
+formula stored in the @samp{#+TBLFMT:} line just below the table, and
+the evaluation of the formula fails. Fix the fields used in the
+formula, or fix the formula, or remove it!
+
+@item @b{When I am in the last column of a table and just above a
+horizontal line in the table, pressing TAB creates a new table line
+@i{before} the horizontal line. How can I quickly move to the line
+@i{below} the horizontal line instead?}@*
+Press @key{down} (to get on the separator line) and then @key{TAB}.
+
+@item @b{How can I change the indentation of an entire table without
+fixing every line by hand?}@*
@cindex indentation, of tables
-@item
-To change the indentation of a table, just change the first line and
-realign with @key{TAB}.
+The indentation of a table is set by the first line. So just fix the
+indentation of the first line and realign with @key{TAB}.
-@end itemize
+@end enumerate
-@node Interaction, Acknowledgments, Tips and Tricks, Miscellaneous
+@node Interaction, Bugs, FAQ, Miscellaneous
@section Interaction with other packages
@cindex packages, interaction with other
-@cindex @file{planner.el}
-@cindex @file{remember.el}
-@cindex @file{table.el}
-@file{Org.el} can cooperate with the following packages:
+Org-mode can cooperate with the following packages:
@table @asis
+@cindex @file{table.el}
+@item @file{table.el} by Takaaki Ota
+Org mode cooperates with table.el, see @ref{table.el}.
+@cindex @file{calc.el}
+@item @file{calc.el} by Dave Gillespie
+Org-mode uses the calc package for implementing spreadsheet
+functionality in its tables (@pxref{Table calculations}). Org-modes
+checks for the availability of calc by looking for the function
+@code{calc-eval} which should be autoloaded in your setup if calc has
+been installed properly. As of Emacs 22, calc is part of the Emacs
+distribution. Another possibility for interaction between the two
+packages is using calc for embedded calculations. @xref{Embedded Mode,
+, Embedded Mode, calc, GNU Emacs Calc Manual}.
+@cindex @file{constants.el}
+@item @file{constants.el} by Carsten Dominik
+In a table formula (@pxref{Table calculations}), it is possible to use
+names for natural constants or units. Instead of defining you own
+constants in the variable @code{org-table-formula-constants}, install
+the @file{constants} package which defines a large number of constants
+and units, and lets you use unit prefixes like @samp{M} for
+@samp{Mega} etc. You will need version 2.0 of this package, available
+at @url{http://www.astro.uva.nl/~dominik/Tools}. Org-mode checks for
+the function @code{constants-get}, which has to be autoloaded in your
+setup. See the installation instructions in the file
+@file{constants.el}.
@cindex @file{remember.el}
+@cindex @file{CUA.el}
+@item @file{CUA.el} by Kim. F. Storm
+Keybindings in Org-mode conflict with the @kbd{S-<cursor>} keys
+used by CUA-mode (as well as pc-select-mode and s-region-mode) to
+select and extend the region. If you want to use one of these
+packages along with Org-mode, configure the variable
+@code{org-CUA-compatible}. When set, Org-mode will move the following
+keybindings in org-mode files, and in the agenda buffer (but not
+during date selection).
+@example
+S-UP -> M-p S-DOWN -> M-n
+S-LEFT -> M-- S-RIGHT -> M-+
+S-RET -> C-S-RET
+@end example
+Yes, these are unfortunately more difficult to remember. If you want
+to have other replacement keys, look at the variable
+@code{org-disputed-keys}.
@item @file{remember.el} by John Wiegley
Org mode cooperates with remember, see @ref{Remember}.
-@cindex @file{plannner.el}
+@cindex @file{planner.el}
@item @file{planner.el} by John Wiegley
Planner is another tool to plan work and keep track of tasks. Planner
uses a multi-file approach with project pages and day pages. Is based
-on Emacs-Wiki. It can be useful to display the agenda entries
-resulting from org files in day-pages of the planner. This can be
-done through the diary of the calendar: Integrate org files into the
-diary as described above, and then turn on the diary support of
-planner.
-@cindex @file{table.el}
-@item @file{table.el} by Takaaki Ota
-Org mode cooperates with table.el, see @ref{table.el}.
+on Emacs-Wiki. If Planner is your primary tool, it can be useful to
+display the agenda entries resulting from org files in day-pages of
+the planner. This can be done through the diary of the calendar:
+Integrate org files into the diary as described above, and then turn
+on the diary support of planner.
@end table
-@c EmacsWiki
-@c organizer-mode
-@c todo-mode
-@c records mode
+@node Bugs, Acknowledgments, Interaction, Miscellaneous
+@section Bugs
+@cindex bugs
+
+Here is a list of things which should work differently, but which I
+have found too hard to fix.
+
+@itemize @bullet
+@item
+If you call @code{fill-paragraph} (bound to @kbd{M-q}) in a table, the
+filling is correctly disabled. However, if some text directly
+(without an empty line in between) precedes or follows a table, calling
+@code{fill-paragraph} in that text will also fill the table like
+normal text. Also, @code{fill-region} does bypass the
+@code{fill-paragraph} code and will fill tables like normal text.
+@item
+When the application called by @kbd{C-c C-o} to open a file link fails
+(for example because the application does not exits or refuses to open
+the file), it does so silently. No error message is displayed.
+@item
+Recalculating a table line applies the formulas from left to right.
+If a formula calculated fields further down the row, multiple
+recalculation may be needed to get all fields consistent.
+@item
+Under XEmacs, if Org-mode entries are included into the diary, it is
+not possible to jump back from the diary to the org file. Apparently,
+the text properties are lost when the fancy-diary-display is used.
+However, from Org-mode's timeline and agenda buffers (created with
+@kbd{C-c C-r} and @kbd{C-c a}), things do work correctly.
+@item
+Linux should also have a default viewer application, using mailcap.
+Maybe we can use GNUS or VM mime code? Or dired's guessing commands?
+Any hints (or even patches) are appreciated.
+@item
+When you write @samp{x = a /b/ c}, b will be exported in italics.
+@item
+The exporters work well, but could be made more efficient.
+@end itemize
-@page @c FIXME
+@page
-@node Acknowledgments, Bugs, Interaction, Miscellaneous
+@node Acknowledgments, , Bugs, Miscellaneous
@section Acknowledgments
@cindex acknowledgments
Org-mode was written by Carsten Dominik, who still maintains it at the
-Org-mode homepage
-@uref{http://www.astro.uva.nl/~dominik/Tools/org/}. The following
-people have helped the development along with ideas, suggestions and
-patches.
+Org-mode homepage @uref{http://www.astro.uva.nl/~dominik/Tools/org/}.
+The following people have helped the development along with ideas,
+suggestions and patches.
@itemize @bullet
@item
-Matthias Rempe (Oelde) provided ideas and suggestions, a patch
-introducing Windows NT/2000 support, and quality control.
+Matthias Rempe (Oelde) provided ideas, a patch introducing Windows
+NT/2000 support, and quality control.
@item
Kevin Rogers contributed code to access VM files on remote hosts.
@item
Christian Egli converted the documentation into TeXInfo format. He
also showed me his plans for a multifile summary for Org-mode. Some of
his ideas have found their way into the agenda.
-@item
-Philip Rooke created the Org-mode reference card and did some
-beta-testing.
+@item
+Philip Rooke created the Org-mode reference card. He also helped with
+beta testing and contributed a number of very useful ideas.
+@item
+Christian Schlauer proposed angular brackets around links, among other
+things.
+@item
+David Wainberg suggested to implement an archiving mechanism and helped
+testing.
@item
Linking to VM/BBDB/GNUS was inspired by Tom Shannon's
@file{organizer-mode.el}.
@item
Scheduling TODO items was inspired by John Wiegley's @file{planner.el}.
@item
-Sacha Chua, the current maintainer of Planner suggested to take some
-linking code from Planner, which I did (for RMAIL and Wanderlust).
+Sacha Chua, the current maintainer of Planner, offered linking code
+from Planner. I made use of the offer for links to RMAIL and Wanderlust.
@item
Oliver Oppitz sent several useful suggestions.
@item
Carsten Wimmer suggested some changes and helped fix a bug in linking
to GNUS.
-@end itemize
-
-@node Bugs, , Acknowledgments, Miscellaneous
-@section Bugs
-@cindex bugs
-
-Here is a list of things which should work differently, but which I
-have found too hard to fix.
-
-@itemize @bullet
-@item
-When the application called by @kbd{C-c C-o} to open a file link fails
-(for example because the application does not exits or refuses to open
-the file), it does so silently. No error message is displayed.
-@item
-Under XEmacs, if Org-mode entries are included into the diary, it is
-not possible to jump back from the diary to the org file. Apparently,
-the text properties are lost when the fancy-diary-display is used.
-However, from Org-mode's agenda (created with @kbd{C-c C-r} or
-@kbd{M-x org-agenda}), things do work correctly.
-@item
-Linux should also have a default viewer application, using mailcap.
-Maybe we can use GNUS or VM mime code? Or dired's guessing commands?
-Any hints (or even patches) are appreciated.
-@item
-When you write @samp{x = a /b/ c}, b will be exported in italics.
-@item
-The exporters work well, but could be made more efficient.
+@item
+Pavel Chalmoviansky reported bugs and suggested improvements related
+to the agenda treatment of items with specified time.
+@item
+Stefan Monnier provided a patch with lots of little fixes to keep the
+Emacs-Lisp compiler happy.
+@item
+Kai Grossjohann pointed out that a number of key bindings in Org-mode
+conflict with other packages.
@end itemize
@node Index, Key Index, Miscellaneous, Top
@bye
-
@ignore
arch-tag: 7893d1fe-cc57-4d13-b5e5-f494a1bcc7ac
@end ignore