@setfilename ../info/org
@settitle Org Mode Manual
-@set VERSION 3.08
-@set DATE April 2005
+@set VERSION 4.00
+@set DATE December 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
* 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
+* Agenda Views:: Collecting information into views
* Exporting:: Sharing and publishing of notes
* Miscellaneous:: All the rest which did not fit elsewhere
* Index:: The fast road to specific information
* Summary:: Brief summary of what Org-mode does
* Installation and Activation:: How to install Org-mode
-* Feedback:: Bug reportes, ideas, patches etc.
+* Feedback:: Bug reports, ideas, patches etc.
Document Structure
* Outlines:: Org-mode is based on outline-mode
* Headlines:: How to typeset org-tree headlines
-* Visibility cycling:: Show ad hide, much simplified
+* Visibility cycling:: Show and 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
+* Tags::
+* Plain Lists:: Editing hand-formatted lists
Tables
* 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
+
+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:: Taste the power of calc
Hyperlinks
-* Links:: URL-like links to the world
+* Internal Links:: CamelCaseWords as internal links
+* External Links:: URL-like links to the world
+* Managing links:: Creating, inserting and following
+* Search Options:: Linking to a specific location
* Remember:: Org-trees store quick notes
TODO items
* TODO basics:: Marking and displaying TODO entries
+* Progress Logging:: Document your productivity
* TODO extensions:: Workflow and assignments
* Priorities:: Some things are more important than others
* Time stamps:: Assigning a time to a tree entry
* Creating timestamps:: Commands which insert timestamps
-Timeline and Agenda
+Agenda Views
-* Timeline:: Time-sorted view for single file
* Agenda:: Your weekly planner
+* Global TODO list:: Overview over all things to do
+* Matching headline tags:: Select information based on tags
+* Timeline:: Time-sorted view for single file
* Agenda commands:: Remote editing of org trees
* Calendar/Diary integration:: Integrating Anniversaries and more
Exporting
-* Export commands:: Commands which export and display
+* ASCII export:: Export as a structured ASCII file
+* HTML export:: Export as an HTML file
+* iCalendar export:: Create calendar entries.
+
+HTML export
+
* HTML formatting:: Interpretation of the buffer content
* Export options:: How to influence exports
* Comment lines:: Lines which will not be exported
* 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
+* TTY keys:: Using Org-mode on a tty
* 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 and Activation:: How to install Org-mode
-* Feedback:: Bug reportes, ideas, patches etc.
+* Feedback:: Bug reports, ideas, patches etc.
@end menu
@node Summary, Installation and Activation, Introduction, Introduction
table editor. Org-mode supports ToDo items, deadlines, time stamps,
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
+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.
+structured ASCII file, as HTML, or (todo and agenda items only) as an
+iCalendar file.
-Org-mode keeps simple things simple. Not every outline branch needs
-to be an action item, not every action item needs to have priority or
-scheduling information associated with it. Org-mode can be used on
-different levels and in different ways, for example
+Org-mode keeps simple things simple. When first fired up, it should
+feel like a simple but easy to use outliner. Complexity is not
+imposed, but a large amount of functionality is available when you
+need it. Org-mode can be used on different levels and in different
+ways, for example
@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 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}
@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-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")
-
-;; 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
@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; -*-
@noindent which will select Org-mode for this buffer no matter what
the file's name is. See also the variable
-@code{org-insert-mode-line-in-empty-file'}.
+@code{org-insert-mode-line-in-empty-file'}.
@node Feedback, , Installation and Activation, Introduction
@section Feedback
@end enumerate
@noindent Thanks for helping to improve this mode.
-
@node Document Structure, Tables, Introduction, Top
@chapter Document Structure
@cindex document structure
@menu
* Outlines:: Org-mode is based on outline-mode
* Headlines:: How to typeset org-tree headlines
-* Visibility cycling:: Show ad hide, much simplified
+* Visibility cycling:: Show and 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
+* Tags::
+* Plain Lists:: Editing hand-formatted lists
@end menu
@node Outlines, Headlines, Document Structure, Document Structure
@cindex outline tree
Headlines define the structure of an outline tree. The Headlines in
-Org-mode start with one or more stars, for example
+Org-mode start with one or more stars, on the left margin. For
+example
@example
* Top level headline
@node Visibility cycling, Motion, Headlines, Document Structure
@section Visibility cycling
+@cindex cycling, visibility
@cindex visibility cycling
@cindex trees, visibility
+@cindex show hidden text
+@cindex hide text
Outlines make it possible to hide parts of the text in the buffer.
Org-mode uses a single command bound to the @key{TAB} key to change
Show all.
@end table
-When Emacs firsts visits a Org-mode file, the global state is set to
+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
@section Motion
@cindex motion, between headlines
@cindex jumping, to headlines
+@cindex headline navigation
The following commands jump to other headlines in the buffer.
@table @kbd
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
+@cindex subtrees, cut and paste
@table @kbd
@kindex M-@key{RET}
@item M-@key{RET}
-Insert new heading with same level as current
+Insert new heading with same level as current. If the cursor is in a
+plain list item, a new item is created. To force creation of a new
+headline, use a prefix arg, or first press @key{RET} to get to the
+beginning of the next line.
@kindex M-S-@key{RET}
@item M-S-@key{RET}
Insert new TODO entry with same level as current heading.
Demote the current subtree by one level
@kindex M-S-@key{up}
@item M-S-@key{up}
-Move subtree up (swap with previous subtree of same level)
+Move subtree up (swap with previous subtree of same
+level)
@kindex M-S-@key{down}
@item M-S-@key{down}
Move subtree down (swap with next subtree of same level)
-@kindex C-c C-h C-w
-@item C-c C-h C-w
+@kindex C-c C-x C-w
+@item C-c C-x C-w
Kill subtree, i.e. remove it from buffer but save in kill ring.
-@kindex C-c C-h M-w
-@item C-c C-h M-w
+@kindex C-c C-x M-w
+@item C-c C-x M-w
Copy subtree to kill ring.
-@kindex C-c C-h C-y
-@item C-c C-h C-y
+@kindex C-c C-x C-y
+@item C-c C-x C-y
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
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
+@cindex filing subtries
+
+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, Tags, 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
match is in the body of an entry, headline and body are made visible.
In order to provide minimal context, also the full hierarchy of
headlines above the match is shown, as well as the headline following
-the match.
+the match. Each match is also highlighted, the highlights disappear
+when the buffer is changed with an editing command.
@end table
Other commands are using this feature as well. For example @kbd{C-c
@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
+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 Tags, Plain Lists, Sparse trees, Document Structure
+@section Tags
+@cindex tags
+@cindex headline tagging
+@cindex matching, tags
+@cindex sparse tree, tag based
+
+If you wish to implement a tag system to cross-correlate information,
+this can be done as well in Org-mode. Every headline can contain a
+list of tags, at the end of the headline. Tags are normal words
+containing letters and @samp{_}, but no numbers. Tags must be
+preceded and followed by a single colon; like @samp{:WORK:}. Several
+tags can be specified like @samp{:WORK:URGENT:}.
+
+@cindex inheritance, of tags
+Tags make use of the hierarchical structure of outline trees. If a
+heading has a certain tag, all subheadings will inherit the tag as
+well. For example, in the list
+
+@example
+* Meeting with the French group :WORK:
+** Summary by Frank :BOSS:
+*** TODO Prepare slides for him :ACTION:
+@end example
+@noindent
+the final heading will have the tags @samp{:WORK:}, @samp{:BOSS:}, and
+@samp{:ACTION:}.
+
+@table @kbd
+@kindex C-c C-c
+@item C-c C-c
+@cindex completion, of tags
+Enter new tags for the current headline. The minibuffer will prompt
+for a list of tags and offer completion with respect to all other tags
+used in the current buffer. After pressing @key{RET}, the tags will
+be inserted and aligned to @code{org-tags-column}. When called with a
+@kbd{C-u} prefix, align all tags in the current buffer to that column,
+just to make things look nice. Tags can also be just typed into the
+buffer, with @kbd{M-@key{TAB}} support.
+@cindex M-@key{TAB}
+@item M-@key{TAB}
+Tags can also be typed directly into the buffer, using
+@kbd{M-@key{TAB}} completion.
+@kindex C-c \
+@item C-c \
+Create a sparse tree with all headlines matching a given set of tags.
+The command prompts for the tags to match. The criterion is just a
+list of tags separated by @samp{+} or @samp{-} for positive and
+negative selection. For example, @samp{+WORK-BOSS} would select all
+headlines that are tagged @samp{:WORK:}, but discard those also tagged
+@samp{:BOSS:}.
+@kindex C-c a m
+@item C-c a m
+Create a global list of tag matches from all agenda files.
+@xref{Matching headline tags}.
+@end table
+
+@node Plain Lists, , Tags, Document Structure
+@section Plain Lists
+@cindex plain lists
+@cindex lists, plain
+@cindex lists, ordered
+@cindex ordered lists
+
+Headlines define the structure of the Org-mode file, and also lists
+(for example TODO items (@pxref{TODO items}) should be created using
+headline levels. However, when taking notes, the plain text is
+sometimes easier to read with hand-formatted lists. Org-mode supports
+editing such lists, and the HTML exporter (@pxref{Exporting}) does
+parse and format them.
+
+Org-mode knows ordered and unordered lists. Unordered list items
+start with @samp{-}, @samp{+}, or @samp{*}@footnote{When using
+@samp{*} as a bullet, lines must be indented or they will be seen as
+top-level headlines.} as bullets. Ordered list items start with
+@samp{1.} or @samp{1)}. Items belonging to the same list must have
+the same indentation on the first line. In particular, if an ordered
+list reaches number @samp{10.}, also the 2--digit numbers must be
+written left-aligned with the other numbers in the list. Indentation
+also determines the end of a list item. It ends before the next line
+that is indented like the bullet/number, or less. For example:
+
+@example
+** Lord of the Rings
+My favorite scenes are (in this order)
+1. Eowyns fight with the witch king
+ + this was already my favorite scene in the book
+ + I really like Miranda Otto.
+2. The attack of the Rohirrim
+3. Peter Jackson being shot by Legolas
+ - on DVD only
+ He makes a really funny face when it happens.
+@end example
+
+Org-mode supports these lists by tuning filling and wrapping commands
+to correctly deal with them. Futhermore, the following commands act
+on items when the cursor is in the first line of an item (the line
+with the bullet or number).
+
+@table @kbd
+@kindex @key{TAB}
+@item @key{TAB}
+Items can be folded just like headline levels if you set the variable
+@code{org-cycle-include-plain-lists}. The level of an item is then
+given by the indentation of the bullet/number. However, items are
+always subordinate to real headlines, the hierarchies remain
+completely separated.
+@kindex M-@key{RET}
+@item M-@key{RET}
+Insert new item at current level. With prefix arg, for a new heading.
+@kindex M-S-@key{up}
+@kindex M-S-@key{down}
+@item M-S-@key{up}
+@itemx M-S-@key{down}
+Move the item including subitems up/down (swap with previous/next item
+of same indentation). If the list is ordered, renumbering is
+automatic.
+@kindex M-S-@key{left}
+@kindex M-S-@key{right}
+@item M-S-@key{left}
+@itemx M-S-@key{right}
+Decrease/increase the indentation of the item, including subitems.
+Initially, the item tree is selected based on current indentation.
+When these commands are executed several times in direct succession,
+the initially selected region is used, even if the new indentation
+would imply a different hierarchy. To use the new hierarchy, break
+the command chain with a cursor motion or so.
+@kindex C-c C-c
+@item C-c C-c
+Renumber the ordered list at the cursor.
+@end table
+
@node Tables, Hyperlinks, Document Structure, Top
@chapter Tables
@cindex tables
+@cindex editing 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
|-
@end example
-
@noindent and then press @key{TAB} to align the table and start filling in
fields.
+When typing text into a field, Org-mode treats @key{DEL},
+@key{Backspace}, and all character keys in a special way, so that
+inserting and deleting avoids shifting other fields. Also, when
+typing @emph{immediately after the cursor was moved into a new field
+with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
+field is automatically made blank. If this behavior is too
+unpredictable for you, configure the variables
+@code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
+
@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}
@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.
+
+@kindex C-c ^
+@item C-c ^
+Sort the table lines in the region. Point and mark must be in the first
+and last line to be included, and must be in the column that should be
+used for sorting. The command prompts for numerical versus
+alphanumerical sorting.
@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
+@kindex C-c C-x M-w
+@item C-c C-x M-w
+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.
-@kindex C-c C-h C-y
-@item C-c C-h C-y
+@kindex C-c C-x C-w
+@item C-c C-x C-w
+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-x C-y
+@item C-c C-x C-y
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,
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}.
-@kindex S-@key{RET}
-@item S-@key{RET}
+@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.
-
-@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}.
+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
+@cindex spreadsheet capabilities
+@cindex @file{calc} package
+
+The table editor makes use of the Emacs @file{calc} package to
+implement spreadsheet-like capabilities. Org-mode has two levels of
+complexity for table calculations. 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
+@cindex formula syntax
+@cindex syntax, of formulas
+
+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
+
+@cindex vectors, in table calculations
+The range vectors can be directly fed into the calc vector functions
+like @samp{vmean} and @samp{vsum}.
+
+@cindex name, of column or field
+@cindex constants, in calculations
+@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{$h} 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}.
+
+@cindex format specifier
+@cindex mode, for @file{calc}
+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 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
+@cindex column formula
+@cindex formula, for table column
+
+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.
+
+@cindex recomputing table fields
+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.
+
+@cindex marking characters, tables
+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 defines 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
+@cindex named field formula
+@cindex formula, for named table field
+
+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
+@cindex formula editing
+@cindex editing, of table 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 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 Hyperlinks, TODO items, Tables, Top
@chapter Hyperlinks
@cindex hyperlinks
-Just like HMTL, Org-mode provides links to other files, usenet
-articles, emails and much more.
+Just like HMTL, Org-mode provides links inside a file, and external
+links to other files, Usenet articles, emails and much more.
@menu
-* Links:: URL-like links to the world
+* Internal Links:: CamelCaseWords as internal links
+* External Links:: URL-like links to the world
+* Managing links:: Creating, inserting and following
+* Search Options:: Linking to a specific location
* Remember:: Org-trees store quick notes
@end menu
-@node Links, Remember, Hyperlinks, Hyperlinks
-@section Links
-@cindex links
+@node Internal Links, External Links, Hyperlinks, Hyperlinks
+@section Internal Links
+@cindex internal links
+@cindex links, internal
+@cindex CamelCase links
+
+Similar to Wiki implementations, Org-mode interprets words spelled in
+CamelCase (i.e. mixed case with at least one capital letter following
+on a small letter inside the word) as links. While in Wiki
+implementations these links usually point to another file, in Org-mode
+they point to a target in the current file. Targets are CamelCased
+words in double angular brackets, and may be located anywhere, also in
+a comment line. For example
+@example
+# <<MyTarget>>
+@end example
+
+Each occurrence of @samp{MyTarget} in the file is an active link that
+can be followed with @kbd{C-c C-o} or with a mouse click
+(@pxref{Managing links}). If no dedicated target exists, org-mode will
+search for the words in the link separated by white space, in the
+above example for @samp{my target}. If the link starts with a star
+like @samp{*MyTarget}, the search is restricted to headlines.
+Org-mode will first try an exact match of a full headline, but then
+move on to more and more lenient searches. The link @samp{*MyTargets}
+will find any of the following
+@example
+** My targets
+** TODO my targets are bright
+** my 20 targets are
+@end example
+@cindex completion, of CamelCase links
+@cindex CamelCase links, completion of
+It is therefore often not even necessary to set a dedicated target.
+The link will automatically find a target. If you want to see what
+lines in the current buffer are matched by a given CamelCase link,
+open the link with @kbd{C-u C-c C-o}. Even if there are several
+matches, org-mode will usually find the right one since it tries
+targets and exact matches first. To insert links targeting a
+headline, in-buffer completion can be used. Just type a star followed
+by a few optional letters into the buffer and press @kbd{M-@key{TAB}}.
+CamelCased versions of all headlines in the current buffer will be
+offered as completions. @xref{Managing links}, for more commands
+creating links.
+
+@node External Links, Managing links, Internal Links, Hyperlinks
+@section External Links
+@cindex links, external
+@cindex external links
+@cindex links, external
@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}
+<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 or, in tables, by the end of the table field. Therefore,
-outside of tables 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}.
+
+
+@node Managing links, Search Options, External Links, Hyperlinks
+@section Managing links
+
+Org-mode provides methods to create a link in the correct syntax, to
+insert it into an org-mode file, and to follow the link.
-@cindex storing links
@table @kbd
@kindex C-c l
+@cindex storing links
@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}.
+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 Org-mode files, the current headline is
+targeted. For any other files, the link will point to the file, with
+a CamelCase (@pxref{Search Options}) search string pointing to the
+contents of the current line. If there is an active region, the
+selected words will form the basis of the search string. The key
+binding @kbd{C-c l} is only a suggestion - see @ref{Installation and
+Activation}.
@kindex C-c C-l
+@cindex link completion
+@cindex file name completion
+@cindex completion, of links
+@cindex completion, of file names
+@cindex inserting links
@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.
+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
+@cindex following links
@kindex C-c C-o
+@kindex mouse-2
@item C-c C-o
+@itemx mouse-2
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.
+links, and execute the command in a shell link. When the cursor is on
+a CamelCase link, this commands runs the corresponding search. When
+the cursor is on a TAGS list in a headline, it creates the
+corresponding TAGS view. Furthermore, it will visit text files in
+@samp{file:} links 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.
Like @kbd{mouse-2}, but force file links to be opened with Emacs.
@end table
-@node Remember, , Links, Hyperlinks
+
+@node Search Options, Remember, Managing links, Hyperlinks
+@section Search options in file links
+@cindex search option in file links
+@cindex file links, searching
+
+File links can contain additional information to make Emacs jump to a
+particular location in the file when following a link. This can be a
+line number or a search option after a double@footnote{For backward
+compatibility, line numbers can also follow a single colon.} colon.
+For example:
+@example
+<file:~/code/main.c::255>
+<file:~/xx.org::MyTarget>
+<file:~/xx.org::find me>
+<file:~/xx.org::/regexp/>
+@end example
+@noindent Here is what these options do.
+
+@table @code
+@item 255
+Jump to line 255.
+@item MyGoal
+Search for a link target with name MyGoal, or do a text search for
+@samp{my target}, similar to the CamelCase search in internal links,
+see @ref{Internal Links}.
+@item find me
+Do a normal text search for the text @samp{find me}.
+@item /regexp/
+Do a regular expression search for @code{regexp}. This uses the Emacs
+command @code{occur} to list all matches in a separate window. If the
+target file is in Org-mode, @code{org-occur} is used to create a
+sparse tree with the matches.
+@c If the target file is a directory,
+@c @code{grep} will be used to search all files in the directory.
+@end table
+
+To use the search options also for a search in the current file, a
+file link with an empty file name can be used. For example,
+@code{<file:::find me>} does a search for @samp{find me} in the
+current file.
+
+@node Remember, , Search Options, Hyperlinks
@section Remember
@cindex @file{remember.el}
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.
+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 an XEmacs
+package.} will tell @emph{Remember} to use org files as target, and to
+create annotations compatible with Org-mode links.
-@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")
@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}
+@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 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.
+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{*}.
@menu
* TODO basics:: Marking and displaying TODO entries
+* Progress Logging:: Document your productivity
* TODO extensions:: Workflow and assignments
* Priorities:: Some things are more important than others
@end menu
-@node TODO basics, TODO extensions, TODO items, TODO items
+@node TODO basics, Progress Logging, TODO items, TODO items
@section Basic TODO functionality
Any headline can become a TODO item by starting it with the word TODO,
@table @kbd
@kindex C-c C-t
+@cindex cycling, of TODO states
@item C-c C-t
Rotate the TODO state of the current item between
@example
@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.
+above them. With prefix arg, show also the DONE entries. With
+numerical prefix N, show the tree for the Nth keyword in the variable
+@code{org-todo-keywords}.
+@kindex C-c a t
+@item C-c a t
+Show the global TODO list. This collects the TODO items from all
+agenda files (@pxref{Agenda}) into a single buffer. The buffer is in
+@code{agenda-mode}, so there are commands to examine and manipulate
+the TODO entries directly from that buffer (@pxref{Agenda commands}).
+@xref{Global TODO list}, for more information.
+@item @code{org-agenda-include-all-todo}
+If you would like to have all your TODO items listed as part of your
+agenda, customize the variable @code{org-agenda-include-all-todo}.
@end table
-@node TODO extensions, Priorities, TODO basics, TODO items
+@node Progress Logging, TODO extensions, TODO basics, TODO items
+@section Progress Logging
+@cindex progress logging
+@cindex logging, of progress
+If you want to keep track of @emph{when} a certain TODO item was
+finished, turn on logging with
+@lisp
+(setq org-log-done t)
+@end lisp
+@noindent
+Then each time you turn a TODO entry into DONE using either @kbd{C-c
+C-t} in the Org-mode buffer or @kbd{t} in the agenda buffer, a line
+@samp{CLOSED: [timestamp]} will be inserted just after the headline.
+If you turn the entry back into a TODO item again through further
+state cycling, that line will be removed again. In the timeline
+(@pxref{Timeline}) and in the agenda (@pxref{Agenda}), you can then
+use the @kbd{L} key to display the TODO items closed on each day,
+giving you an overview of what has been done on a day.
+
+@node TODO extensions, Priorities, Progress Logging, TODO items
@section Extended use of TODO keywords
@cindex extended TODO keywords
org-todo-interpretation 'sequence)
@end lisp
+@cindex completion, of TODO keywords
+Changing these variables becomes only effective in a new Emacs session.
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
+TODO to FEEDBACK, then to VERIFY, and finally to 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
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:
+items are for ``work'' or ``home''. If you are into David Allen's
+@emph{Getting Things DONE}, you might want to use todo types
+@samp{NEXTACTION}, @samp{WAITING}, @samp{MAYBE}. 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")
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 the behavior of the
+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
+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.
+names. But 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.
+You can also review the items of a specific TODO type in a sparse tree
+by using a numeric prefix to @kbd{C-c C-v}. For example, to see all
+things Lucy has to do, you would use @kbd{C-3 C-c C-v}. To collect
+collect Lucy's items from all agenda files into a single buffer, you
+would use the prefix arg as well when creating the global todo list:
+@kbd{C-3 C-c t}.
@node Per file keywords, , TODO types, TODO extensions
@subsection Setting up TODO keywords for individual files
#+TYP_TODO: Fred Sara Lucy Mike DONE
@end example
-@cindex Completing option keywords
+@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.
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{#-}
+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.}.
+respected.}.
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:
@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
-
-
-@node Timestamps, Timeline and Agenda, TODO items, Top
+@node Timestamps, Agenda Views, TODO items, Top
@chapter Timestamps
Items can be labeled with timestamps to make them useful for project
@node Time stamps, Creating timestamps, Timestamps, Timestamps
@section Time stamps, deadlines and scheduling
@cindex time stamps
+@cindex ranges, time
+@cindex date stamps
@cindex deadlines
@cindex scheduling
@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
@node Creating timestamps, , Time stamps, Timestamps
@section Creating timestamps
@cindex creating timestamps
+@cindex timestamps, creating
For Org-mode to recognize time stamps, they need to be in the specific
format. All commands listed below produce time stamps in the correct
Like @kbd{C-c .}, but use the alternative format which contains date
and time.
+@kindex C-c !
+@item C-c !
+Like @kbd{C-c .}, but insert an inactive time stamp not triggering the
+agenda.
+
@kindex C-c <
@item C-c <
Insert a time stamp corresponding to the cursor date in the Calendar.
@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:
Choose date in calendar (only if nothing typed into minibuffer).
@end table
-@node Timeline and Agenda, Exporting, Timestamps, Top
-@chapter Timeline and Agenda
-@cindex agenda
+@node Agenda Views, Exporting, Timestamps, Top
+@chapter Agenda Views
+@cindex agenda views
+@ignore
We have already described three commands to filter important
information in an org file into a sparse tree (@pxref{Sparse trees}):
timestamps}.
@end itemize
@noindent
+@end ignore
-Instead of using the sparse trees, Org-mode can also collect and
-time-sort the important items into a separate buffer, which we call
-the @emph{timeline} of the org file. It can also collect information
-from a @emph{list of files} and in this way provide an @emph{agenda}
-which covers all of your current projects, action items and
-appointments.
-
-@menu
-* 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, Agenda, Timeline and Agenda, Timeline and Agenda
-@section Timeline for a single file
-@cindex single file summary
-@cindex agenda, for single file
-@cindex timeline, single file
-@cindex time-sorted view
-
-The timeline shows all time-stamped items in a single Org-mode file,
-in @emph{time-sorted view}. The main purpose of this command is to
-give an overview over events in a project.
-
-@table @kbd
-@kindex C-c C-r
-@item C-c C-r
-Show a time-sorted view of the org file, with all time-stamped items
-of today or later. When called with a @kbd{C-u} prefix, past dates
-will be included as well. When called with two @kbd{C-u C-u}
-prefixes, all unfinished TODO entries (scheduled or not) are also
-listed under the current date.
-@end table
-@noindent
-
-The timeline is shown in a temporary buffer @file{*Org Agenda*}. The
-commands available in the Agenda buffer are listed in @ref{Agenda
-commands}.
-
-@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.
-
-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
-this variable, but the easiest way to maintain it is through the
-following commands
+Org-mode can collect and sort selected items into a separate buffer.
+The information to be listed is collected from all @emph{agenda
+files}, the files listed in the variable @code{org-agenda-files}.
+Thus even if you only work with a single Org-mode file, this file must
+be put into that list@footnote{When using the dispatcher pressing
+@kbd{1} before selecting a command will actually limit the command to
+the current file, and ignore @code{org-agenda-files} until the next
+dispatcher command.}. You can customize this variable, but the easiest
+way to maintain it is through the following commands
@cindex files, adding to agenda list
@table @kbd
@kindex C-c [
@item C-c [
-Add current file to the list of agenda files
+Add current file to the list of agenda files. The file is added to
+the front of the list. If it was already in the list, it is moved to
+the front. With prefix arg, file is added/moved to the end.
@kindex C-c ]
@item C-c ]
Remove current file from the list of agenda files.
+@kindex C-,
+@item C-,
+Cycle through agenda file list.
@end table
@noindent
-The Org menu contains the list of all files and can be used to quickly
-visit any of them.
+The Org menu always contains the current list of files and can be used
+to quickly visit any of them.
+
+Org-mode provides three different views on the information in these
+files:
+@itemize @bullet
+@item
+an @emph{agenda} that is like a calendar and shows information
+for specific dates
+@item
+a @emph{TODO list} that covers all unfinished
+action items, and
+@item
+a @emph{tags view} that show information based on
+the tags associated with headlines in the outline tree.
+@end itemize
+@noindent
+The extracted information is displayed in a special @emph{agenda
+buffer}. This buffer is read-only, but provides commands to visit the
+corresponding locations in the original Org-mode files, and even to
+edit these files remotely.
-The global command @command{org-agenda} compiles the agenda from all
-listed files.
+The views are created through a dispatcher that should be bound to a
+global key, for example @kbd{C-c a} (@pxref{Installation and
+Activation}). In the following we will assume that @kbd{C-c a} is
+indeed how the dispatcher is accessed and list keyboard access to
+commands accordingly.
+
+@menu
+* Agenda:: Your weekly planner
+* Global TODO list:: Overview over all things to do
+* Matching headline tags:: Select information based on tags
+* Timeline:: Time-sorted view for single file
+* Agenda commands:: Remote editing of org trees
+* Calendar/Diary integration:: Integrating Anniversaries and more
+@end menu
+
+@node Agenda, Global TODO list, Agenda Views, Agenda Views
+@section Agenda
+@cindex agenda
+
+The purpose of the @emph{agenda} is to act like a week/day page of a
+paper agenda, showing you all the tasks for the current week or day.
@table @kbd
@cindex org-agenda, command
-@kindex C-c a
-@item C-c a
+@kindex C-c a a
+@item C-c a a
Compile an agenda for the current week from a list of org files. The
agenda shows the entries for each day. With a @kbd{C-u} prefix (or
when the variable @code{org-agenda-include-all-todo} is @code{t}), all
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
+The key binding @kbd{C-c a a} is only a suggestion - see
@ref{Installation and Activation}.
@end table
-The commands available in the Agenda buffer are listed in
-@ref{Agenda commands}.
+Remote editing from the agenda buffer means for example that you can
+change the dates of deadlines and appointments from the agenda buffer.
+The commands available in the Agenda buffer are listed in @ref{Agenda
+commands}.
+
@subsection Categories
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
-#+CATEGORY: Cheops
+#+CATEGORY: Thesis
@end example
-@noindent
-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.
+If there are several such lines in a file, each specifies the category
+for the text below it. 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
+ 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
+
+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}.
-The display in the agenda buffer looks best if the category is not
-longer than 10 characters.
@subsection Sorting of agenda items
@cindex 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, Timeline and Agenda
+@node Global TODO list, Matching headline tags, Agenda, Agenda Views
+@section The global TODO list
+@cindex global TODO list
+@cindex TODO list, global
+
+The global TODO list contains all unfinished TODO items, formatted and
+collected into a single place.
+
+@table @kbd
+@kindex C-c a t
+@item C-c a t
+Show the global TODO list. This collects the TODO items from all
+agenda files (@pxref{Agenda}) into a single buffer. The buffer is in
+@code{agenda-mode}, so there are commands to examine and manipulate
+the TODO entries directly from that buffer (@pxref{Agenda commands}).
+@xref{Global TODO list}, for more information.
+@kindex C-c a T
+@item C-c a T
+Like the above, but allow to select a specific TODO keyword. You can
+also do this by specifying a prefix argument. With a @kbd{C-u} prefix
+you are prompted for a keyword. With a numeric prefix, the Nth
+keyword in @code{org-todo-keywords} is selected.
+@kindex r
+The @kbd{r} key in the agenda buffer regenerates it, and you can give
+a prefix argument to this command to change the selected TODO keyword,
+for example @kbd{3 r}.
+@end table
+
+Remote editing of TDOD items means that you can change the state of a
+TODO entry with a single key press. The commands available in the
+TODO list are described in @ref{Agenda commands}.
+
+@node Matching headline tags, Timeline, Global TODO list, Agenda Views
+@section Matching headline tags
+@cindex matching, of tags
+@cindex tags view
+
+If headlines in the agenda files are marked with @emph{tags}
+(@pxref{Tags}), you can select headlines based on the tags that apply
+to them and collect them into an ageenda buffer.
+
+@table @kbd
+@kindex C-c a m
+@item C-c a m
+Produce a list of all headlines that match a given set of tags. The
+command prompts for a selection criterion, which is a simple list of
+TAGS with positive and negative selection, like
+@samp{+WORK+URGENT-WITHBOSS}.
+@kindex C-c a M
+@item C-c a M
+Like @kbd{C-c a m}, but only select headlines that are also TODO
+items.
+@end table
+
+The commands available in the tags list are described in @ref{Agenda
+commands}.
+
+@node Timeline, Agenda commands, Matching headline tags, Agenda Views
+@section Timeline for a single file
+@cindex single file summary
+@cindex agenda, for single file
+@cindex timeline, single file
+@cindex time-sorted view
+
+The timeline is not really an agenda view, because it only summarizes
+items from a single Org-mode file. But it also uses the agenda buffer
+and provides similar commands, so we discuss it here. The timeline
+shows all time-stamped items in a single Org-mode file (or the
+selected part of it), in @emph{time-sorted view}. The main purpose of
+this command is to give an overview over events in a project.
+
+@table @kbd
+@kindex C-c C-r
+@item C-c C-r
+Show a time-sorted view of the org file, with all time-stamped items.
+When called with a @kbd{C-u} prefix, all unfinished TODO entries
+(scheduled or not) are also listed under the current date.
+@end table
+@noindent
+
+The commands available in the timeline buffer are listed in
+@ref{Agenda commands}.
+
+@node Agenda commands, Calendar/Diary integration, Timeline, Agenda Views
@section Commands in the agenda buffer
+@cindex commands, in agenda buffer
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
@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
-@item l
+@kindex L
+@item L
Display original location and recenter that window.
@kindex mouse-2
@kindex f
@item f
-Toggle follow mode. In follow mode, as you move the cursor through
+Toggle Follow mode. In Follow mode, as you move the cursor through
the agenda buffer, the other window always shows the corresponding
location in the org file.
+@kindex l
+@item l
+Toggle Logbook mode. In Logbook mode, entries that where marked DONE while
+logging was on (variable @code{org-log-done}) are shown in the agenda.
+
@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
after modification of the time stamps of items with S-@key{left} and
-S-@key{right}.
+S-@key{right}. When the buffer is the global todo list, a prefix
+argument is interpreted to create a selective list for a specific TODO
+keyword.
@kindex @key{right}
@item @key{right}
@kindex +
@kindex S-@key{up}
@item +
-@item S-@key{up}
+@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 -
-@item S-@key{down}
+@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}
@item H
Show holidays for three month around the cursor date.
+@kindex C-c C-x C-c
+@item C-c C-x C-c
+Export a single iCalendar file containing entries from all agenda files.
+Not available in timelines.
+
@tsubheading{Quit and Exit}
@kindex q
@item q
@end table
-@node Calendar/Diary integration, , Agenda commands, Timeline and Agenda
+@node Calendar/Diary integration, , Agenda commands, Agenda Views
@section Calendar/Diary integration
@cindex calendar integration
@cindex diary integration
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. Also 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.
+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
+@cindex agenda to 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
additional entries for overdue deadlines and scheduled items. See
also the documentation of the @command{org-diary} function.
-@node Exporting, Miscellaneous, Timeline and Agenda, Top
+@node Exporting, Miscellaneous, Agenda Views, Top
@chapter Exporting
@cindex exporting
-@cindex ASCII file
-@cindex HTML
-
-
-@cindex headline levels, for exporting
-For printing and sharing of notes, an Org-mode document can be
-exported as an ASCII file, or as HTML. In the exported version, the
-first 3 outline levels will become headlines, defining a general
-document structure. Additional levels will be exported as itemize
-lists. If you want that transition to occur at a different level,
-specify it with a prefix argument. For example,
-@example
-@kbd{M-1 M-x org-export-as-html}
-@end example
-@noindent
-creates only top level headlines and does the rest as items.
+For printing and sharing of notes, Org-mode documents can be exported
+as ASCII or HTML files. To incorporate entries with associated times
+like deadlines or appointments into a desktop calendar program like
+iCal, Org-mode can also produce extracts in the iCalendar format.
@menu
-* Export commands:: Commands which export and display
-* HTML formatting:: Interpretation of the buffer content
-* Export options:: How to influence exports
-* Comment lines:: Lines which will not be exported
+* ASCII export:: Export as a structured ASCII file
+* HTML export:: Export as an HTML file
+* iCalendar export:: Create calendar entries.
@end menu
-@node Export commands, HTML formatting, Exporting, Exporting
-@section Export commands
+@node ASCII export, HTML export, Exporting, Exporting
+@section ASCII export
+@cindex ASCII export
@cindex region, active
@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
+@end table
+
+@cindex headline levels, for exporting
+In the exported version, the first 3 outline levels will become
+headlines, defining a general document structure. Additional levels
+will be exported as itemize lists. If you want that transition to occur
+at a different level, specify it with a prefix argument. For example,
+@example
+@kbd{C-1 C-c C-x a org-export-as-ascii}
+@end example
+@noindent
+creates only top level headlines and does the rest as items. Lines
+starting with @samp{#} and subtrees starting with the word @samp{COMMENT}
+will not be exported.
+
+@node HTML export, iCalendar export, ASCII export, Exporting
+@section HTML export
+@cindex HTML export
+
+Org-mode contains an HTML exporter with extensive HTML formatting, in
+ways similar to John Grubers @emph{markdown} language, but with
+additional support for tables.
+
+@cindex region, active
+@cindex active region
+@cindex transient-mark-mode
+@table @kbd
+@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
-@item C-c C-x C-h
+@kindex C-c C-x b
+@item C-c C-x b
Export as HTML file and open it with a browser.
@kindex C-c C-x t
@item C-c C-x t
Insert template with export options, see below.
@kindex C-c :
@item C-c :
-Toggle fixed-width for line or region, see below.
+Toggle fixed-width for entry (QUOTE) or region, see below.
@end table
-@node HTML formatting, Export options, Export commands, Exporting
-@section HTML formatting
+@cindex headline levels, for exporting
+In the exported version, the first 3 outline levels will become
+headlines, defining a general document structure. Additional levels
+will be exported as itemize lists. If you want that transition to occur
+at a different level, specify it with a prefix argument. For example,
+@example
+@kbd{C-2 C-c C-x b}
+@end example
+@noindent
+creates two levels of headings and does the rest as items.
+
+@menu
+* HTML formatting:: Interpretation of the buffer content
+* Export options:: How to influence exports
+* Comment lines:: Lines which will not be exported
+@end menu
+
+@node HTML formatting, Export options, HTML export, HTML export
+@subsection HTML formatting
Not all text is transferred literally to the exported HTML file. The
exporter implements the following interpretation:
@itemize @bullet
+
+@cindex hand-formatted lists
+@cindex lists, hand-formatted
+@item
+Hand-formatted lists with @samp{-}, @samp{*} or @samp{+} as
+bullet, or with @samp{1.} or @samp{2)} as enumerator will be recognized and
+transformed into HTML lists. See @xref{Plain Lists}.
+
@cindex underlined text
@cindex bold text
@cindex italic text
@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
If these conversions conflict with your habits of typing ASCII text,
they can all be turned off with corresponding variables.
-@node Export options, Comment lines, HTML formatting, Exporting
-@section Export options
+@node Export options, Comment lines, HTML formatting, HTML export
+@subsection 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}).
+correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} 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
TeX: @r{turn on/off @TeX{} macros}
@end example
-@node Comment lines, , Export options, Exporting
-@section Comment lines
+You can also give style information for the exported file. The
+default specification can be configured through the option
+@code{org-export-html-style}. If you want to use a file-local style,
+you may use file variables, best wrapped into a COMMENT section at the
+end of the outline tree. For example:
+
+@example
+* COMMENT HTML style specifications
+
+# Local Variables:
+# org-export-html-style: " <style type=\"text/css\">
+ p @{font-weight: normal; color: gray; @}
+ h1 @{color: black; @}
+ </style>"
+# End: ***
+@end example
+
+Remember to execute @kbd{M-x normal-mode} after changing this to make
+the new style visible to Emacs.
+
+@node Comment lines, , Export options, HTML export
+@subsection Comment lines
@cindex comment lines
@cindex exporting, not
Lines starting with @samp{#} in column zero are treated as comments
and will never be exported. Also entire subtrees starting with the
word @samp{COMMENT} will never be exported. Finally, any text before
-the first headline will not be exported either.
+the first headline will not be exported either. This applies also for
+ASCII export.
@table @kbd
@kindex C-c ;
Toggle the COMMENT keyword at the beginning of an entry.
@end table
+@node iCalendar export, , HTML export, Exporting
+@section iCalendar export
+@cindex iCalendar export
+
+Some people like to use Org-mode for keeping track of projects, but
+still prefer a standard calendar application for anniversaries and
+appointments. In this case it can be useful to have deadlines and
+other time-stamped items in Org-mode files show up in the calendar
+application. Org-mode can export calendar information in the standard
+iCalendar format.
+
+@table @kbd
+@kindex C-c C-x i
+@item C-c C-x i
+Create iCalendar entries for the current file and store them in the same
+directory, using a file extension @file{.ics}.
+@kindex C-c C-x C-i
+@item C-c C-x C-i
+Like @kbd{C-c C-x i}, but do this for all files in
+@code{org-agenda-files}. For each of these files, a separate iCalendar
+file will be written.
+@kindex C-c C-x c
+@item C-c C-x c
+Create a single large iCalendar file from all files in
+@code{org-agenda-files} and write it to the file given by
+@code{org-combined-agenda-icalendar-file}.
+@end table
+
+How this calendar is best read and updated, depends on the application
+you are using. For example, when using iCal under Apple MacOS X, you
+could create a new calendar @samp{OrgMode} (the default name for the
+calendar created by @kbd{C-c C-x c}, see the variables
+@code{org-icalendar-combined-name} and
+@code{org-combined-agenda-icalendar-file}). Then set Org-mode to
+overwrite the corresponding file
+@file{~/Library/Calendars/OrgMode.ics}. You may even use AppleScript
+to make iCal re-read the calendar files each time a new version of
+@file{OrgMode.ics} is produced. Here is the setup needed for this:
+
+@cindex applescript, for calendar update
+@lisp
+(setq org-combined-agenda-icalendar-file
+ "~/Library/Calendars/OrgMode.ics")
+(add-hook 'org-after-save-iCalendar-file-hook
+ (lambda ()
+ (shell-command
+ "osascript -e 'tell application \"iCal\" to reload calendars'")))
+@end lisp
+
@node Miscellaneous, Index, Exporting, Top
@chapter Miscellaneous
@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
+* TTY keys:: Using Org-mode on a tty
* 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
+@cindex completion, of CamelCase links
+@cindex completion, of tags
+@cindex @TeX{} symbol completion
+@cindex TODO keywords completion
+@cindex dictionary word completion
+@cindex option keyword completion
+@cindex CamelCase link completion
+@cindex tag completion
Org-mode supports in-buffer completion. This type of completion does
not make use of the minibuffer. You simply type a few letters into
@item
After @samp{\}, complete @TeX{} symbols supported by the exporter.
@item
+After @samp{*}, complete CamelCase versions of all headlines in the
+buffer.
+@item
+After @samp{:}, complete tags used elswhere in the buffer.
+@item
After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
@samp{OPTIONS} which set file-specific options for Org-mode. When the
option keyword is already complete, pressing @kbd{M-@key{TAB}} again
@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
+@cindex FAQ
+@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}.
+Or configure the variable @code{org-table-tab-jumps-over-hlines}.
+
+@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, TTY keys, 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
-@page @c FIXME
+@node TTY keys, Bugs, Interaction, Miscellaneous
+@section Using org-mode on a tty
+@cindex tty keybindings
+
+Org-mode uses a number of keys that are not accessible on a tty. This
+applies to most special keys like cursor keys, @key{TAB} and
+@key{RET}, when these are combined with modifier keys like @key{Meta}
+and/or @key{Shift}. Org-mode uses these bindings because it needs to
+provide keys for a large number of commands, and because these keys
+appeared particularly easy to remember. In order to still be able to
+access the core functionality of Org-mode on a tty, alternative
+bindings are provided. Here is a complete list of these bindings,
+which are obviously more cumbersome to use. Note that sometimes a
+work-around can be better. For example changing a time stamp is
+really only fun with @kbd{S-@key{cursor}} keys. On a tty you would
+rather use @kbd{C-c .} to re-insert the timestamp.
+
+@page
+@multitable @columnfractions 0.15 0.2 0.2
+@item @b{Default} @tab @b{Alternative 1} @tab @b{Alternative 2}
+@item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab
+@item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{@key{Esc} @key{left}}
+@item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab
+@item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{@key{Esc} @key{right}}
+@item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab
+@item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{@key{Esc} @key{up}}
+@item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab
+@item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{@key{Esc} @key{down}}
+@item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab
+@item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab
+@item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{@key{Esc} @key{RET}}
+@item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab
+@item @kbd{S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab
+@item @kbd{S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab
+@item @kbd{S-@key{up}} @tab @kbd{C-c C-x @key{up}} @tab
+@item @kbd{S-@key{down}} @tab @kbd{C-c C-x @key{down}} @tab
+@end multitable
+
+@node Bugs, Acknowledgments, TTY keys, 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
+@c @item
+@c If you call @code{fill-paragraph} (bound to @kbd{M-q}) in a table, the
+@c filling is correctly disabled. However, if some text directly
+@c (without an empty line in between) precedes or follows a table, calling
+@c @code{fill-paragraph} in that text will also fill the table like
+@c normal text. Also, @code{fill-region} does bypass the
+@c @code{fill-paragraph} code and will fill tables like normal text.
+@item
+Text in an entry protected with the @samp{QUOTE} keyword should not
+autowrap.
+@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
+The remote-editing commands in the agenda buffer cannot be undone with
+@code{undo} called from within the agenda buffer. But you can go to
+the corresponding buffer (using @key{TAB} or @key{RET} and execute
+@code{undo} there.
+@item
+Recalculating a table line applies the formulas from left to right.
+If a formula uses @emph{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
-@node Acknowledgments, Bugs, Interaction, Miscellaneous
+@node Acknowledgments, , Bugs, Miscellaneous
@section Acknowledgments
@cindex acknowledgments
+@cindex thanks
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/}.
@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
Juergen Vollmer contributed code generating the table of contents
in HTML output, and other export improvements.
@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.
+Christian Egli converted the documentation into TeXInfo format and
+patched basic CSS formatting support into the HTML exporter. He also
+inspired the agenda by showing me his plans for a multifile summary.
@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, suggested to copy
+linking code from Planner (I took code for RMAIL and Wanderlust).
@item
-Oliver Oppitz sent several useful suggestions.
+Oliver Oppitz made useful suggestions.
@item
Carsten Wimmer suggested some changes and helped fix a bug in linking
to GNUS.
@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.
-@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 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
+Kai Grossjohann pointed out that a number of key bindings in Org-mode
+conflict with other packages.
@item
-The exporters work well, but could be made more efficient.
+Roland Winkler pointed out that additional keybindings are needed to
+use Org-mode on a tty.
+@item
+Tim O'Callaghan suggested in-file links, search options for
+general file links, and TAGS.
+@c @item
+@c Nic Ferrier and Christian Egli implemented XML export.
@end itemize
@node Index, Key Index, Miscellaneous, Top
@bye
-
@ignore
arch-tag: 7893d1fe-cc57-4d13-b5e5-f494a1bcc7ac
@end ignore