tec/org-mode
tec
/
org-mode
forked from mirrors/org-mode
1
0
Fork 0
Code Pull Requests Releases Activity
org-mode/org.texi

3751 lines
138 KiB
Plaintext
Raw Blame History

\input texinfo
@c %**start of header
@setfilename org
@c @setfilename ../info/org
@settitle Org Mode Manual
@set VERSION 4.19b
@set DATE March 2006
@dircategory Emacs
@direntry
* Org Mode: (org). outline-based notes management and organizer
@end direntry
@c Version and Contact Info
@set MAINTAINERSITE @uref{http://www.astro.uva.nl/~dominik/Tools/org/,maintainers webpage}
@set MAINTAINER Carsten Dominik
@set MAINTAINEREMAIL @email{dominik@@science.uva.nl}
@set MAINTAINERCONTACT @uref{mailto:dominik@@science.uva.nl,contact the maintainer}
@c %**end of header
@finalout
@c Macro definitions
@c FIXME: does not look good in html
@c Subheadings inside a table. Need a difference between info and the rest.
@macro tsubheading{text}
@ifinfo
@subsubheading \text\
@end ifinfo
@ifnotinfo
@item @b{\text\}
@end ifnotinfo
@end macro
@copying
This manual is for Org-mode (version @value{VERSION}).
Copyright @copyright{} 2004, 2005, 2006 Free Software Foundation
@quotation
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
and with the Back-Cover Texts as in (a) below. A copy of the
license is included in the section entitled ``GNU Free Documentation
License.''
(a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
this GNU Manual, like GNU software. Copies published by the Free
Software Foundation raise funds for GNU development.''
@end quotation
@end copying
@titlepage
@title Org Mode Manual
@subtitle Release @value{VERSION}
@author by Carsten Dominik
@c The following two commands start the copyright page.
@page
@vskip 0pt plus 1filll
@insertcopying
@end titlepage
@c Output the table of contents at the beginning.
@contents
@ifnottex
@node Top, Introduction, (dir), (dir)
@top Org Mode Manual
@insertcopying
@end ifnottex
@menu
* Introduction:: Getting started
* Document Structure:: A tree works like your brain
* Tables:: Pure magic for quick formatting
* Hyperlinks:: Notes in context
* TODO items:: Every tree branch can be a TODO item
* Timestamps:: Assign date and time to items
* Tags:: Tagging headlines and matching sets of tags
* 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
* Key Index:: Key bindings and where they are described
@detailmenu
--- The Detailed Node Listing ---
Introduction
* Summary:: Brief summary of what Org-mode does
* Installation and activation:: How to install Org-mode
* 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 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
* Plain Lists:: Editing hand-formatted lists
Tables
* Built-in table editor:: Simple tables
* Narrow columns:: Stop wasting space in 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
* Link format:: How links in Org-mode are formatted
* Internal links:: Links to other places in the current file
* 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
Internal links
* Radio targets:: Make targets trigger links in plain text.
* CamelCase links:: Activating CamelCase words as links
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
Extended use of TODO keywords
* Workflow states:: From TODO to DONE in steps
* TODO types:: I do this, Fred the rest
* Per file keywords:: Different files, different requirements
Timestamps
* Time stamps:: Assigning a time to a tree entry
* Creating timestamps:: Commands which insert timestamps
Tags
* Tag inheritance:: Tags use the tree structure of the outline
* Setting tags:: How to assign tags to a headline
* Tag searches:: Searching for combinations of tags
Agenda Views
* Agenda files:: Files being searched for agenda information
* Agenda dispatcher:: Keyboard access to agenda views
* Weekly/Daily Agenda:: The calendar page with current tasks
* Global TODO list:: All unfinished action items
* Matching headline tags:: Structured information with fine-tuned search
* Timeline:: Time-sorted view for single file
* Agenda commands:: Remote editing of org trees
The weekly/daily agenda
* Categories:: Not all tasks are equal
* Time-of-day specifications:: How the agenda knows the time
* Calendar/Diary integration:: Integrating Anniversaries and more
* Sorting of agenda items:: The order of things
Exporting
* 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
Miscellaneous
* Completion:: M-TAB knows what you need
* Customization:: Adapting Org-mode to your taste
* Clean view:: Getting rid of leading stars in the outline
* TTY keys:: Using Org-mode on a tty
* FAQ:: Frequently asked questions
* Interaction:: Other Emacs packages
* Bugs:: Things which do not work perfectly
* Acknowledgments:: These people provided feedback and more
@end detailmenu
@end menu
@node Introduction, Document Structure, Top, Top
@chapter Introduction
@cindex introduction
@menu
* Summary:: Brief summary of what Org-mode does
* Installation and activation:: How to install Org-mode
* Feedback:: Bug reports, ideas, patches etc.
@end menu
@node Summary, Installation and activation, Introduction, Introduction
@section Summary
@cindex summary
Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
project planning with a fast and effective plain-text system.
Org-mode develops organizational tasks around NOTES files that contain
information about projects as plain text. Org-mode is implemented on
top of outline-mode, which makes it possible to keep the content of
large files well structured. Visibility cycling and structure editing
help to work with the tree. Tables are easily created with a built-in
table editor. Org-mode supports ToDo items, deadlines, time stamps,
and scheduling. It dynamically compiles entries into an agenda that
utilizes and smoothly integrates much of the Emacs calendar and diary.
Plain text URL-like links connect to websites, emails, Usenet
messages, BBDB entries, and any files related to the projects. For
printing and sharing of notes, an Org-mode file can be exported as a
structured ASCII file, as HTML, or (todo and agenda items only) as an
iCalendar file.
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 for taking 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}
@end example
The Org-mode table editor can be integrated into any major mode by
activating the minor Orgtbl-mode.
There is a website for Org-mode which provides links to the newest
version of Org-mode, as well as additional information, screen shots
and example files. This page is located at
@uref{http://www.astro.uva.nl/~dominik/Tools/org/}.
@page
@node Installation and activation, Feedback, Summary, Introduction
@section Installation and Activation
@cindex installation
@cindex autoload
@cindex global keybindings
@cindex keybindings, global
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.
@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
If you have downloaded Org-mode from the Web, you must byte-compile
@file{org.el} and put it on your load path. In addition to the Emacs
Lisp lines above, you also need to add the following lines to
@file{.emacs}:
@lisp
;; These lines only if org-mode is not part of the X/Emacs distribution.
(autoload 'org-mode "org" "Org mode" t)
(autoload 'org-diary "org" "Diary entries from Org mode")
(autoload 'org-agenda "org" "Multi-file agenda from Org mode" t)
(autoload 'org-store-link "org" "Store a link to the current location" t)
(autoload 'orgtbl-mode "org" "Org tables as a minor mode" t)
(autoload 'turn-on-orgtbl "org" "Org tables as a minor mode")
@end lisp
@cindex org-mode, turning on
With this setup, all files with extension @samp{.org} will be put into
Org-mode. As an alternative, make the first line of a file look like
this:
@example
MY PROJECTS -*- mode: org; -*-
@end example
@noindent which will select Org-mode for this buffer no matter what
the file's name is. See also the variable
@code{org-insert-mode-line-in-empty-file}.
If you are upgrading to version 4.20 or later from a version 4.14 or
earlier, some links may stop working. These are links containing space
characters. To make such links work again, and also to transform all
links from the old @samp{<link>} format to the new @samp{[[link]]}
format, execute once in each file: @kbd{M-x org-upgrade-old-links}.
@node Feedback, , Installation and activation, Introduction
@section Feedback
@cindex feedback
@cindex bug reports
@cindex maintainer
@cindex author
If you find problems with Org-mode, or if you have questions, remarks,
or ideas about it, please contact the maintainer Carsten Dominik at
@value{MAINTAINEREMAIL}.
For bug reports, please provide as much information as possible,
including the version information of Emacs (@kbd{C-h v emacs-version
@key{RET}}) and Org-mode (@kbd{C-h v org-version @key{RET}}), as well as
the Org-mode related setup in @file{.emacs}. If an error occurs, a
traceback can be very useful. Often a small example file helps, along
with clear information about:
@enumerate
@item What exactly did you do?
@item What did you expect to happen?
@item What happened instead?
@end enumerate
@noindent Thank you for helping to improve this mode.
@node Document Structure, Tables, Introduction, Top
@chapter Document Structure
@cindex document structure
@cindex structure of document
Org-mode is based on outline mode and provides flexible commands to
edit the structure of the document.
@menu
* Outlines:: Org-mode is based on outline-mode
* Headlines:: How to typeset org-tree headlines
* 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
* Plain Lists:: Editing hand-formatted lists
@end menu
@node Outlines, Headlines, Document Structure, Document Structure
@section Outlines
@cindex outlines
@cindex outline-mode
Org-mode is implemented on top of outline-mode. Outlines allow to
organize a document in a hierarchical structure, which (at least for
me) is the best representation of notes and thoughts. Overview over
this structure is achieved by folding (hiding) large parts of the
document to show only the general document structure and the parts
currently being worked on. Org-mode greatly simplifies the use of
outlines by compressing the entire show/hide functionality into a
single command @command{org-cycle}, which is bound to the @key{TAB}
key.
@node Headlines, Visibility cycling, Outlines, Document Structure
@section Headlines
@cindex headlines
@cindex outline tree
Headlines define the structure of an outline tree. The headlines in
Org-mode start with one or more stars, on the left margin. For
example:
@example
* Top level headline
** Second level
*** 3rd level
some text
*** 3rd level
more text
* Another top level headline
@end example
@noindent Some people find the many stars too noisy and would prefer an
outline that has whitespace followed by a single star as headline
starters. @ref{Clean view} describes a setup to realize this.
@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
the visibility in the buffer.
@cindex subtree visibility states
@cindex folded, subtree visibility state
@cindex children, subtree visibility state
@cindex subtree, subtree visibility state
@table @kbd
@kindex @key{TAB}
@item @key{TAB}
Rotate current subtree between the states
@example
,-> FOLDED -> CHILDREN -> SUBTREE --.
'-----------------------------------'
@end example
At the beginning of the buffer (or when called with @kbd{C-u}), this does
the same as the command @kbd{S-@key{TAB}} below.
@cindex global visibility states
@cindex overview, global visibility state
@cindex contents, global visibility state
@cindex show all, global visibility state
@kindex S-@key{TAB}
@item S-@key{TAB}
Rotate the entire buffer between the states
@example
,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
'--------------------------------------'
@end example
Note that inside tables, @kbd{S-@key{TAB}} jumps to the previous field.
@cindex show all, command
@kindex C-c C-a
@item C-c C-a
Show all.
@end table
When Emacs first visits an Org-mode file, the global state is set to
OVERVIEW, i.e. only the top level headlines are visible. This can be
configured through the variable @code{org-startup-folded}, or on a
per-file basis by adding one of the following lines anywhere in the
buffer:
@example
#+STARTUP: fold
#+STARTUP: nofold
#+STARTUP: content
@end example
@node Motion, Structure editing, Visibility cycling, Document Structure
@section Motion
@cindex motion, between headlines
@cindex jumping, to headlines
@cindex headline navigation
The following commands jump to other headlines in the buffer.
@table @kbd
@kindex C-c C-n
@item C-c C-n
Next heading.
@kindex C-c C-p
@item C-c C-p
Previous heading.
@kindex C-c C-f
@item C-c C-f
Next heading same level.
@kindex C-c C-b
@item C-c C-b
Previous heading same level.
@kindex C-c C-u
@item C-c C-u
Backward to higher level heading.
@kindex C-c C-j
@item C-c C-j
Jump to a different place without changing the current outline
visibility. Shows the document structure in a temporary buffer, where
you can use visibility cycling (@key{TAB}) to find your destination.
After pressing @key{RET}, the cursor moves to the selected location in
the original buffer, and the headings hierarchy above it is made
visible.
@end table
@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, 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. 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.
@kindex M-@key{left}
@item M-@key{left}
Promote current heading by one level.
@kindex M-@key{right}
@item M-@key{right}
Demote current heading by one level.
@kindex M-S-@key{left}
@item M-S-@key{left}
Promote the current subtree by one level.
@kindex M-S-@key{right}
@item M-S-@key{right}
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).
@kindex M-S-@key{down}
@item M-S-@key{down}
Move subtree down (swap with next subtree of same level).
@kindex C-c C-x C-w
@kindex C-c C-x C-k
@item C-c C-x C-w
@itemx C-c C-x C-k
Kill subtree, i.e. remove it from buffer but save in kill ring.
@kindex C-c C-x M-w
@item C-c C-x M-w
Copy subtree to kill ring.
@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
headline marker like @samp{****}.
@end table
@cindex region, active
@cindex active region
@cindex transient-mark-mode
When there is an active region (transient-mark-mode), promotion and
demotion work on all headlines in the region. To select a region of
headlines, it is best to place both point and mark at the beginning of a
line, mark at the beginning of the first headline, and point at the line
just after the last headline to change. Note that when the cursor is
inside a table (@pxref{Tables}), the Meta-Cursor keys have different
functionality.
@node Archiving, Sparse trees, Structure editing, Document Structure
@section Archiving
@cindex archiving
@cindex filing subtrees
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, Plain Lists, Archiving, Document Structure
@section Sparse trees
@cindex sparse trees
@cindex trees, sparse
@cindex folding, sparse trees
@cindex occur, command
An important feature of Org-mode is the ability to construct
@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@footnote{See also the variables
@code{org-show-hierarchy-above} and
@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
basic one is @command{org-occur}:
@table @kbd
@kindex C-c /
@item C-c /
Occur. Prompts for a regexp and shows a sparse tree with all matches.
If the match is in a headline, the headline is made visible. If the
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. Each match is also highlighted, the highlights disappear
when the buffer is changed with an editing command.
@end table
@noindent
For frequently used sparse trees of specific search strings, you can
use the variable @code{org-agenda-custom-commands} to define fast
keyboard access to specific sparse trees. These commands will then be
accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
For example:
@lisp
(setq org-agenda-custom-commands
'(("f" occur-tree "FIXME")))
@end lisp
@noindent will define the key @kbd{C-c a f} as a shortcut for creating
a sparse tree matching the string @samp{FIXME}.
Other commands are using sparse trees as well. For example @kbd{C-c
C-v} creates a sparse TODO tree (@pxref{TODO basics}).
@kindex C-c C-x v
@cindex printing sparse trees
@cindex visible text, printing
To print a sparse tree, you can use the Emacs command
@code{ps-print-buffer-with-faces} which does not print invisible parts
of the document @footnote{This does not work under XEmacs, because
XEmacs uses selective display for outlining, not text properties}.
Or you can use the command @kbd{C-c C-x v} to copy the visible part of
the document to another file (extension @file{.txt}) which can then be
printed in any desired way.
@node Plain Lists, , Sparse trees, Document Structure
@section Plain Lists
@cindex plain lists
@cindex lists, plain
@cindex lists, ordered
@cindex ordered lists
Headlines define both 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. Also, when you are hiding leading stars to get a clean
outline view, plain list items starting with a star are visually
indistinguishable from true headlines. In short: even though @samp{*}
is supported, it may be better to not use it for plain list items} 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.}, then
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. Furthermore, 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
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
* Narrow columns:: Stop wasting space in 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, Narrow columns, Tables, Tables
@section The built-in table editor
@cindex table editor, builtin
Org-mode makes it easy to format tables in plain ASCII. Any line with
@samp{|} as the first non-white character is considered part of a
table. @samp{|} is also the column separator. A table might look
like this:
@example
| Name | Phone | Age |
|-------+-------+-----|
| Peter | 1234 | 17 |
| Anna | 4321 | 25 |
@end example
A table is re-aligned automatically each time you press @key{TAB} or
@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}
@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
Convert region to table. Works when the cursor is not in an existing
table, and when there is a region defined. If every line contains at
least one TAB character, the function assumes that the material is tab
separated. If not, lines are split at whitespace into fields. You
can use a prefix argument to indicate the minimum number of consequtive
spaces required to indentify a field separator (default: just one).
@tsubheading{Re-aligning and field motion}
@kindex C-c C-c
@item C-c C-c
Re-align the table without moving the cursor.
@kindex @key{TAB}
@item @key{TAB}
Re-align the table, move to the next field. Creates a new row if
necessary.
@kindex S-@key{TAB}
@item S-@key{TAB}
Re-align, move to previous field.
@kindex @key{RET}
@item @key{RET}
Re-align the table and move down to next row. Creates a new row if
necessary. At the beginning or end of a line, @key{RET} still does
NEWLINE, so it can be used to split a table.
@tsubheading{Column and row editing}
@kindex M-@key{left}
@kindex M-@key{right}
@item M-@key{left}
@itemx M-@key{right}
Move the current column left/right.
@kindex M-S-@key{left}
@item M-S-@key{left}
Kill the current column.
@kindex M-S-@key{right}
@item M-S-@key{right}
Insert a new column to the left of the cursor position.
@kindex M-@key{up}
@kindex M-@key{down}
@item M-@key{up}
@itemx M-@key{down}
Move the current row up/down.
@kindex M-S-@key{up}
@item M-S-@key{up}
Kill the current row or horizontal line.
@kindex M-S-@key{down}
@item M-S-@key{down}
Insert a new row above (with arg: below) the current row.
@kindex C-c -
@item C-c -
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-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-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,
the table is enlarged as needed. The process ignores horizontal separator
lines.
@kindex C-c C-q
@item C-c C-q
Wrap several fields in a column like a paragraph. If there is an active
region, and both point and mark are in the same column, the text in the
column is wrapped to minimum width for the given number of lines. A
prefix ARG may be used to change the number of desired lines. If there
is no region, the current field is split at the cursor position and the
text fragment to the right of the cursor is prepended to the field one
line down. If there is no region, but you specify a prefix ARG, the
current field is made blank, and the content is appended to the field
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.
@cindex region, active
@cindex active region
@cindex transient-mark-mode
@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 shown in the echo area and can
be inserted with @kbd{C-y}.
@kindex S-@key{RET}
@item S-@key{RET}
When current field is empty, copy from first non-empty field above.
When not empty, copy current field down to next row and move cursor
along with it. Depending on the variable
@code{org-table-copy-increment}, integer field values will be
incremented during copy. This key is also used by CUA-mode
(@pxref{Interaction}).
@tsubheading{Miscellaneous}
@kindex C-c `
@item C-c `
Edit the current field in a separate window. This is useful for fields
that are not fully visible (@pxref{Narrow columns}). When called with a
@kbd{C-u} prefix, just make the full field visible, so that it can be
edited in place.
@kindex C-c @key{TAB}
@item C-c @key{TAB}
This is an alias for @kbd{C-u C-c `} to make the current field fully
visible.
@kindex C-c |
@item 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.
@item M-x org-table-import
Import a file as a table. The table should be TAB- or whitespace
separated. Useful, for example, to import an Excel table or data from a
database, because these programs generally can write TAB-separated text
files. This command works by inserting the file into the buffer and
then converting the region to a table. Any prefix argument is passed on
to the converter, which uses it to determine the separator.
@item M-x org-table-export
Export the table as a TAB-separated file. Useful for data exchange with,
for example, Excel or database programs.
@end table
If you don't like the automatic table editor because it gets in your
way on lines which you would like to start with @samp{|}, you can turn
it off with
@lisp
(setq org-enable-table-editor nil)
@end lisp
@noindent The only table command which then still works is
@kbd{C-c C-c} to do a manual re-align.
@node Narrow columns, Table calculations, Built-in table editor, Tables
@section Narrow columns
@cindex narrow columns in tables
The width of columns is automatically determined by the table editor.
Sometimes a single field or a few fields need to carry more text,
leading to unconveniently wide columns. To limit@footnote{This feature
does not work on XEmacs.} the width of a column, one field anywhere in
the column must carry the string @samp{<N>} where @samp{N} is an integer
specifying the width of the column in characters. The next re-align
will then set the width of this column to no more than this value.
@example
|---+------------------------------| |---+--------|
| | | | | <6> |
| 1 | one | | 1 | one |
| 2 | two | ----\ | 2 | two |
| 3 | This is a long chunk of text | ----/ | 3 | This=> |
| 4 | four | | 4 | four |
|---+------------------------------| |---+--------|
@end example
@noindent
Fields that are wider become clipped and end in the string @samp{=>}.
Note that the full text is still in the buffer, it is only invisible.
To see the full text, hold the mouse over the field - a tooltip window
will show the full content. To edit such a field, use the command
@kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will
open a new window with the full field. Edit it and finish with @kbd{C-c
C-c}.
When visiting a file containing a table with narrowed columns, the
necessary character hiding has not yet happened, and the table needs to
be aligned before it looks nice. Setting the option
@code{org-startup-align-all-tables} will realign all tables in a file
upon visiting, but also slow down startup. You can also set this option
on a per-file basis with:
@example
#+STARTUP: align
#+STARTUP: noalign
@end example
@node Table calculations, orgtbl-mode, Narrow columns, 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. Note that @file{calc} has the slightly
non-standard convention that @samp{/} has lower precedence than
@samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}. 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, and 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 fixed 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, up 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 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 *} will 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 exempt 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 into 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, 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, where 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,
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, @file{table.el}
@cindex @file{table.el}
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},
and also part of Emacs 22).
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-mode-related commands, leave the table.
@table @kbd
@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
@code{org-convert-table} for the restrictions under which this is
possible.
@end table
@node Hyperlinks, TODO items, Tables, Top
@chapter Hyperlinks
@cindex hyperlinks
Just like HMTL, Org-mode provides links inside a file, and external
links to other files, Usenet articles, emails and much more.
@menu
* Link format:: How links in Org-mode are formatted
* Internal links:: Links to other places in the current file
* 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 Link format, Internal links, Hyperlinks, Hyperlinks
@section Link format
@cindex link format
@cindex format, of links
Org-mode will recognize plain URL-like links in the buffer and activate
them as clickable links. However, the general linkformat looks like
this:
@example
[[link][description]] @r{or alternatively} [[link]]
@end example
The description part is optional. Once a link in the buffer is
complete, Org-mode will change the display so that
@u{@samp{description}} is displayed instead of
@samp{[[link][description]]} and @samp{link} is displayed instead of
@samp{[[link]]}. Links will be highlighted in the face @code{org-link},
which by default is an underlined face. You can directly edit the
visible part of a link. To edit the invisible part, use @kbd{C-c C-l}
with the cursor on the link. If you place the cursor at the beginning
of end of the displayed text and press @key{BACKSPACE}, you will remove
the (invisible) bracket at that location. This makes the link incomplete
and the internals are again displayed as plain text. Inserting the
missing bracket does hide the link internal again. Finally, you may also
use the menu entry @code{Org->Hperlinks->Literal links} to unhide all
links.
@node Internal links, External links, Link format, Hyperlinks
@section Internal links
@cindex internal links
@cindex links, internal
@cindex CamelCase links
If the link text does not look like a URL, links are considered to be
internal in the current file. Links such as @samp{[[My Target]]} or
@samp{[[My Target][Find my target]]} lead to a text search in the
current file. The link can be followed with @kbd{C-c C-o} when the
cursor is on the link, or with a mouse click (@pxref{Managing links}).
The preferred match for such a link is a dedicated target: The same
string in double angular brackets. Targets may be located anywhere,
often it is convenient to put them into a comment line, for example
@example
# <<My Target>>
@end example
If no dedicated target exists, Org-mode will search for the words in the
link, often removing the need for a dedicated target. In the above
example the search would be for @samp{my target}. Links starting with a
star like @samp{*My Target} restrict the search to headlines. When
searching, Org-mode will first try an exact match, but then move on to
more and more lenient searches. For example, the link @samp{[[*My
Targets]]} will find any of the following:
@example
** My targets
** TODO my targets are bright
** my 20 targets are
@end example
To insert a link 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}}. All headlines in the current buffer will be
offered as completions. @xref{Managing links}, for more commands
creating links.
Following a link pushes a mark onto Org-mode's own mark ring. You can
return to the previous position with @kbd{C-c &}. Using this command
several times in direct succession goes back to positions recorded
earlier.
@menu
* Radio targets:: Make targets trigger links in plain text.
* CamelCase links:: Activating CamelCase words as links
@end menu
@node Radio targets, CamelCase links, Internal links, Internal links
@subsection Radio targets
You can configure Org-mode to link any occurrences of certain target
names in normal text. So without explicitly creating a link, the text
connects to the target radioing its position. Radio targets are
enclosed by triple angular brackets. For example, a target
@samp{<<<My Target>>>} causes each occurrence of @samp{my target} in
normal text to become activated as a link. The Org-mode file is
scanned automatically for radio targets only when the file is first
loaded into Emacs. To update the target list during editing, press
@kbd{C-c C-c} with the cursor on or at a target.
@node CamelCase links, , Radio targets, Internal links
@subsection CamelCase words as links
@cindex completion, of CamelCase links
@cindex CamelCase links, completion of
Org-mode also supports CamelCase words as links. This feature is not
turned on by default because of the inconsistencies this system suffers
from. It is mainly kept for backward compatibility, but the use is
deprecated. To activate CamelCase words as links, and to make headline
completion offer CamelCase version of headlines, the following
customization is needed:
@lisp
(setq org-activate-camels t
org-file-link-context-use-camel-case t)
@end lisp
@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 MH-E links
@cindex USENET links
@cindex SHELL links
Org-mode supports links to files, websites, Usenet and email messages;
and BBDB database entries. External links are URL-like locators. 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}
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}
mhe:folder @r{MH-E folder link}
mhe:folder#id @r{MH-E 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 should be enclosed in double brackets and may contain a
descriptive text to be displayed instead of the url (@pxref{Link
format}), for example:
@example
[[http://www.gnu.org/software/emacs/][GNU Emacs]]
@end example
@cindex angular brackets, around links
@cindex plain text external links
Org-mode also finds external links in the normal text and activates them
as links. Plain text links cannot contain spaces. To remove
ambiguities about the end of the link, enclose them in angular brackets.
@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.
@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 buffers, 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 search string (@pxref{Search Options}) 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 completion, of links
@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 text for an internal link, or one of the
link type prefixes mentioned in the examples above. Through completion,
all links stored during the current session can be accessed. The link
will be formatted as given in the variable @code{org-link-format} and
inserted into the buffer, along with a descriptive text. 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.
By using this command, the links are automatically enclosed in double
brackets, and you will be asked for the optional descriptive text.
@kindex C-u C-c C-l
@cindex file name completion
@cindex completion, of file names
@item C-u C-c C-l
When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
a file will be inserted and you may use file name completion to select
the name of the file. The path to the file is inserted relative to the
directory of the current org file, if the linked file is in the current
directory or in a subdirectory of it. Otherwise an absolute path, if
possible with @samp{~/} for your home directory is used. You can force
an absolute path with two @kbd{C-u} prefixes.
@item C-c C-l @r{with cursor on existing link}
When the cursor is on an existing link, @kbd{C-c C-l} allows to edit the
link and description parts of the link.
@cindex following links
@kindex C-c C-o
@item C-c C-o
Open link at point. This will launch a web browser for URLs (using
@command{browse-url-at-point}), run vm/mh-e/wanderlust/rmail/gnus/bbdb
for the corresponding links, and execute the command in a shell link.
When the cursor is on an internal link, this commands runs the
corresponding search. When the cursor is on a TAGS list in a headline,
it creates the corresponding TAGS view. If the cursor is on a time
stamp, it compiles the agenda for that date. 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 you want to
override the default application and visit the file with Emacs, use a
@kbd{C-u} prefix.
@kindex mouse-2
@kindex mouse-1
@item mouse-2
@itemx mouse-1
On links, @kbd{mouse-2} will open the link just like @kbd{C-c C-o}
would. Under Emacs 22, also @kbd{mouse-1} will follow a link.
@kindex mouse-3
@item mouse-3
Like @kbd{mouse-2}, but force file links to be opened with Emacs.
@cindex mark ring
@kindex C-c %
@item C-c %
Push the current position onto the mark ring, to be able to return
easily. Commands following an internal link do this automatically.
@cindex links, returning to
@kindex C-c &
@item C-c &
Jump back to a recorded position. A position is recorded by the
commands following internal links, and by @kbd{C-c %}. Using this
command several times in direct succession moves through a ring of
previously recorded positions.
@end table
@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::My Target]]
[[file:~/xx.org::*My Target]]
[[file:~/xx.org::/regexp/]]
@end example
@noindent Here is what these options do.
@table @code
@item 255
Jump to line 255.
@item My Target
Search for a link target @samp{<<My Target>>}, or do a text search for
@samp{my target}, similar to the search in internal links, see
@ref{Internal links}.
@item *My Target
In an Org-mode file, restrict search to headlines.
@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
As a degenerate case, a file link with an empty file name can be used
to search the current file. For example, @code{<file:::find me>} does
a search for @samp{find me} in the current file, just like
@samp{[[find me]]} would.
@node Remember, , Search Options, Hyperlinks
@section Remember
@cindex @file{remember.el}
Another way to create org entries with links to other files is through
the @emph{Remember} package by John Wiegley. @emph{Remember} lets you
store quick notes with little interruption of your work flow. See
@uref{http://www.emacswiki.org/cgi-bin/wiki/RememberMode} for more
information. The notes produced by @emph{Remember} can be stored in
different ways, and Org-mode files are a good target. Org-mode allows
to file away notes either to a default file, or directly to the
correct location in your Org-mode outline tree. The following
customization@footnote{The three 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.
@example
(autoload 'org-remember-annotation "org")
(autoload 'org-remember-apply-template "org")
(autoload 'org-remember-handler "org")
(setq org-directory "~/path/to/my/orgfiles/")
(setq org-default-notes-file "~/.notes")
(setq remember-annotation-functions '(org-remember-annotation))
(setq remember-handler-functions '(org-remember-handler))
(add-hook 'remember-mode-hook 'org-remember-apply-template)
@end example
@cindex templates, for remember
In combination with Org-mode, you can use templates to generate
different types of remember notes. For example, if you would like to
use one template to create general TODO entries, and another one for
journal entries, you could use:
@example
(setq org-remember-templates
'((?t "* TODO %?\n %i\n %a" "~/org/TODO.org")
(?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org")))
@end example
@noindent In these entries, the character specifies how to select the
template, the first string specifies the template, and the second string
specifies a default file (overruling @code{org-default-notes-file}) as a
target for this note.
When you call @kbd{M-x remember} to remember something, org will prompt
for a key to select the template and then prepare the buffer like
@example
* TODO
<file:link to where you called remember>
@end example
@noindent or
@example
* [2006-03-21 Tue 15:37]
<file:link to where you called remember>
@end example
@noindent See the variable @code{org-remember-templates} for more details.
When you are finished composing a note with remember, you have to press
@kbd{C-c C-c} to exit remember-mode and to file the note away. The
handler first prompts for a target file - if you press @key{RET}, the
value of @code{org-default-notes-file} is used. Then the command offers
the headings tree of the selected file. You can either immediately
press @key{RET} to get the note appended to the file. Or you can use
vertical cursor motion (@key{up} and @key{down}) and visibility cycling
(@key{TAB}) to find a better place. Pressing @key{RET} or @key{left} or
@key{right} leads to the following result.
@multitable @columnfractions 0.2 0.1 0.7
@item @b{Cursor position} @tab @b{Key} @tab @b{Note gets inserted}
@item buffer-start @tab @key{RET} @tab as level 2 heading at end of file
@item on headline @tab @key{RET} @tab as sublevel of the heading at cursor
@item @tab @key{left} @tab as same level, before current heading
@item @tab @key{right} @tab as same level, after current heading
@item not on headline @tab @key{RET}
@tab at cursor position, level taken from context.
Or use prefix arg to specify level manually.
@end multitable
So a fast way to store the note is to press @kbd{C-c C-c @key{RET}
@key{RET}} to append it to the default file. Even shorter would be
@kbd{C-u C-c C-c}, which does the same without even showing the tree.
But with little extra effort, you can push it directly to the correct
location.
Before inserting the text into a tree, the function ensures that the
text has a headline, i.e. a first line that starts with a @samp{*}.
If not, a headline is constructed from the current date and some
additional data. If the variable @code{org-adapt-indentation} is
non-nil, the entire text is also indented so that it starts in the
same column as the headline (after the asterisks).
@node TODO items, Timestamps, Hyperlinks, Top
@chapter TODO items
@cindex TODO items
Org-mode does not maintain TODO lists as a separate document. TODO
items are an integral part of the notes file, because TODO items
usually come up while taking notes! With Org-mode, you simply mark
any entry in a tree as being a TODO item. In this way, the
information is not duplicated, and the entire context from which the
item emerged is always present when you check.
Of course, this technique causes TODO items to be scattered throughout
your file. Org-mode provides methods to give you an overview over all
things you have to do.
@menu
* TODO basics:: Marking and displaying TODO entries
* Progress logging:: Document your productivity
* TODO extensions:: Workflow and assignments
* Priorities:: Some things are more important than others
@end menu
@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,
for example:
@example
*** TODO Write letter to Sam Fortune
@end example
@noindent
The most important commands to work with TODO entries are:
@table @kbd
@kindex C-c C-t
@cindex cycling, of TODO states
@item C-c C-t
Rotate the TODO state of the current item between
@example
,-> (unmarked) -> TODO -> DONE --.
'--------------------------------'
@end example
The same rotation can also be done ``remotely'' from the timeline and
agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}).
@kindex C-c C-v
@cindex sparse tree, for TODO
@item C-c C-v
View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds
the entire buffer, but shows all TODO items and the headings hierarchy
above them. With prefix arg, show also the DONE entries. 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 Views}) 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 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{Weekly/Daily 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
The default implementation of TODO entries is just two states: TODO and
DONE. You can, however, use the TODO feature for more complicated
things by configuring the variables @code{org-todo-keywords} and
@code{org-todo-interpretation}. Using special setup, you can even use
TODO keywords in different ways in different org files.
Note that @i{tags} are another way to classify headlines in general and
TODO items in particular (@pxref{Tags}).
@menu
* Workflow states:: From TODO to DONE in steps
* TODO types:: I do this, Fred the rest
* Per file keywords:: Different files, different requirements
@end menu
@node Workflow states, TODO types, TODO extensions, TODO extensions
@subsection TODO keywords as workflow states
@cindex TODO workflow
@cindex workflow states as TODO keywords
You can use TODO keywords to indicate different states in the process
of working on an item, for example:
@lisp
(setq org-todo-keywords '("TODO" "FEEDBACK" "VERIFY" "DONE")
org-todo-interpretation 'sequence)
@end lisp
@cindex completion, of TODO keywords
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 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
@ref{Completion}) to insert these words into the buffer.
@node TODO types, Per file keywords, Workflow states, TODO extensions
@subsection TODO keywords as types
@cindex TODO types
@cindex names as TODO keywords
@cindex types as TODO keywords
The second possibility is to use TODO keywords to indicate different
types of action items. For example, you might want to indicate that
items are for ``work'' or ``home''. 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")
org-todo-interpretation 'type)
@end lisp
In this case, different keywords do not indicate a sequence, but
rather different types. So it is normally not useful to change from
one type to another. Therefore, in this case the behavior of the
command @kbd{C-c C-t} is changed slightly@footnote{This is also true
for the @kbd{t} command in the timeline and agenda buffers.}. When
used several times in succession, it will still cycle through all
names. But when 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
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
@cindex keyword options
@cindex per file keywords
It can be very useful to use different aspects of the TODO mechanism
in different files, which is not possible with the global settings
described above. For file-local settings, you need to add special
lines to the file which set the keywords and interpretation for that
file only. For example, to set one of the two examples discussed
above, you need one of the following lines, starting in column zero
anywhere in the file:
@example
#+SEQ_TODO: TODO FEEDBACK VERIFY DONE
#+TYP_TODO: Fred Sara Lucy Mike DONE
@end example
@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.
@cindex DONE, final TODO keyword
Remember that the last keyword must always mean that the item is DONE
(you may use a different word, though). Also note that in each file,
only one of the two aspects of TODO keywords can be used. After
changing one of these lines, use @kbd{C-c C-c} with the cursor still
in the line to make the changes known to Org-mode@footnote{Org-mode
parses these lines only when Org-mode is activated after visiting a
file. @kbd{C-c C-c} with the cursor in a line starting with @samp{#+}
is simply restarting Org-mode, making sure that these changes will be
respected.}.
If you want to use very many keywords, for example when working with a
large group of people, you may split the names over several lines:
@example
#+TYP_TODO: Fred Sara Lucy Mike
#+TYP_TODO: Luis George Jules Jessica
#+TYP_TODO: Kim Arnold Peter
#+TYP_TODO: DONE
@end example
@node Priorities, , TODO extensions, TODO items
@section Priorities
@cindex priorities
If you use Org-mode extensively to organize your work, you may end up
with a number of TODO entries so large that you'd like to prioritize
them. This can be done by placing a @emph{priority cookie} into the
headline, like this
@example
*** TODO [#A] Write letter to Sam Fortune
@end example
@noindent
With its standard setup, Org-mode supports priorities @samp{A},
@samp{B}, and @samp{C}. @samp{A} is the highest priority. An entry
without a cookie is treated as priority @samp{B}. Priorities make a
difference only in the agenda (@pxref{Weekly/Daily Agenda}).
@table @kbd
@kindex @kbd{C-c ,}
@item @kbd{C-c ,}
Set the priority of the current item. The command prompts for a
priority character @samp{A}, @samp{B} or @samp{C}. When you press
@key{SPC} instead, the priority cookie is removed from the headline.
The priorities can also be changed ``remotely'' from the timeline and
agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
@kindex S-@key{up}
@kindex S-@key{down}
@item S-@key{up}
@itemx S-@key{down}
Increase/decrease priority of current item. Note that these keys are
also used to modify time stamps (@pxref{Creating timestamps}).
Furthermore, these keys are also used by CUA-mode
(@pxref{Interaction}).
@end table
@node Timestamps, Tags, TODO items, Top
@chapter Timestamps
Items can be labeled with timestamps to make them useful for project
planning.
@menu
* Time stamps:: Assigning a time to a tree entry
* Creating timestamps:: Commands which insert timestamps
@end menu
@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
A time stamp is a specification of a date (possibly with time) in a
special format, either @samp{<2003-09-16 Tue>} or @samp{<2003-09-16
Tue 09:39>}. A time stamp can appear anywhere in the headline or body
of an org-tree entry. Its presence allows entries to be shown on specific
dates in the agenda (@pxref{Weekly/Daily Agenda}). We distinguish:
@table @var
@cindex timestamp
@item TIMESTAMP
A simple time stamp just assigns a date/time to an item. In the
timeline and agenda displays, the headline of the entry will be shown
exactly on that date.
@item TIMERANGE
@cindex timerange
Two time stamps connected by @samp{--} denote a time range. The
headline will be shown on the first and last day of the range, and on
any dates that are displayed and fall in the range. Here is an
example:
@example
** Meeting in Amsterdam
<2004-08-23 Mon>--<2004-08-26 Thu>
@end example
@item 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 @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>
DEADLINE: <2004-02-29 Sun>
@end example
@item 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 @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
format.
@table @kbd
@kindex C-c .
@item C-c .
Prompt for a date and insert a corresponding time stamp. When the
cursor is at a previously used time stamp, it is updated to NOW. When
this command is used twice in succession, a time range is inserted.
@kindex C-u C-c .
@item C-u C-c .
Like @kbd{C-c .}, but use the alternative format which contains date
and time. The default time can be rounded to multiples of 5 minutes,
see the option @code{org-time-stamp-rounding-minutes}.
@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 C-c >
@item C-c >
Access the Emacs calendar for the current date. If there is a
timestamp in the current line, goto the corresponding date
instead.
@kindex C-c C-o
@item C-c C-o
Access the agenda for the date given by the time stamp at point
(@pxref{Weekly/Daily Agenda}).
@kindex C-c C-d
@item C-c C-d
Insert @samp{DEADLINE} keyword along with a stamp.
@kindex C-c C-w
@cindex sparse tree, for deadlines
@item C-c C-w
Create a sparse tree with all deadlines that are either past-due, or
which will become due within @code{org-deadline-warning-days}.
With @kbd{C-u} prefix, show all deadlines in the file. With a numeric
prefix, check that many days. For example, @kbd{C-1 C-c C-w} shows
all deadlines due tomorrow.
@kindex C-c C-s
@item C-c C-s
Insert @samp{SCHEDULED} keyword along with a stamp.
@kindex S-@key{left}
@kindex S-@key{right}
@item S-@key{left}
@itemx S-@key{right}
Change date at cursor by one day. These key bindings conflict with
CUA-mode (@pxref{Interaction}).
@kindex S-@key{up}
@kindex S-@key{down}
@item S-@key{up}
@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}). The key bindings also conflict with CUA-mode
(@pxref{Interaction}).
@kindex C-c C-y
@cindex evaluate time range
@item C-c C-y
Evaluate a time range by computing the difference between start and
end. With prefix arg, insert result after the time range (in a table:
into the following column).
@end table
@cindex date, reading in minibuffer
@cindex time, reading in minibuffer
@cindex calendar, for selecting date
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:
@table @kbd
@kindex <
@item <
Scroll calendar backwards by one month.
@kindex >
@item >
Scroll calendar forwards by one month.
@kindex mouse-1
@item mouse-1
Select date by clicking on it.
@kindex S-@key{right}
@item S-@key{right}
One day forward.
@kindex S-@key{left}
@item S-@key{left}
One day back.
@kindex S-@key{down}
@item S-@key{down}
One week forward.
@kindex S-@key{up}
@item S-@key{up}
One week back.
@kindex M-S-@key{right}
@item M-S-@key{right}
One month forward.
@kindex M-S-@key{left}
@item M-S-@key{left}
One month back.
@kindex @key{RET}
@item @key{RET}
Choose date in calendar (only if nothing typed into minibuffer).
@end table
@node Tags, Agenda Views, Timestamps, Top
@chapter Tags
@cindex tags
@cindex headline tagging
@cindex matching, tags
@cindex sparse tree, tag based
If you wish to implement a system to cross-correlate information, an
excellent way is to assign @i{tags} to headline. Org-mode has
extensive support for using tags.
Every headline can contain a list of tags, at the end of the headline.
Tags are normal words containing letters, numbers, @samp{_}, and
@samp{@@}. Tags must be preceded and followed by a single colon; like
@samp{:WORK:}. Several tags can be specified like @samp{:WORK:URGENT:}.
@menu
* Tag inheritance:: Tags use the tree structure of the outline
* Setting tags:: How to assign tags to a headline
* Tag searches:: Searching for combinations of tags
@end menu
@node Tag inheritance, Setting tags, Tags, Tags
@section Tag inheritance
@cindex inheritance, of tags
@i{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:NOTES:
*** TODO Prepare slides for him :ACTION:
@end example
@noindent
the final heading will have the tags @samp{:WORK:}, @samp{:BOSS:},
@samp{:NOTES:}, and @samp{:ACTION:}. When executing tag searches and
Org-mode finds that a certain headline matches the search criterion, it
will not check any sublevel headline, assuming that these likely also
match, and that the list of matches can become very long. However, this
may not be what you want, and you can influence inheritance and
searching using the variables @code{org-use-tag-inheritance} and
@code{org-tags-match-list-sublevels}.
@node Setting tags, Tag searches, Tag inheritance, Tags
@section Setting tags
@cindex setting tags
@kindex M-@key{TAB}
As Org-mode deals with plain text files, tags can simply be typed into
the buffer. After a colon, @kbd{M-@key{TAB}} offers completion on all
tags being used in the current buffer. There is also a special command
for inserting tags:
@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. Several tags, separated by colons, may be
specified at the prompt. After pressing @key{RET}, the tags will be
inserted and aligned to @code{org-tags-column}. When called with a
@kbd{C-u} prefix, all tags in the current buffer will be aligned to that
column, just to make things look nice. TAGS are automatically realigned
after promotion, demotion, and TODO state changes (@pxref{TODO basics}).
@end table
@node Tag searches, , Setting tags, Tags
@section Tag searches
@cindex tag searches
Once a tags system has been set up, it can be used to collect related
information into special lists.
@table @kbd
@kindex C-c \
@item C-c \
Create a sparse tree with all headlines matching a tags search.
@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}.
@kindex C-c a M
@item C-c a M
Create a global list of tag matches from all agenda files, but check
only TODO items and force checking subitems (see variable
@code{org-tags-match-list-sublevels}).
@end table
A @i{tags} search string can use Boolean operators @samp{&} for AND and
@samp{|} for OR. @samp{&} binds more strongly than @samp{|}.
Parenthesis are currently not implemented. A tag may also be preceded
by @samp{-}, to select against it, and @samp{+} is syntactic sugar for
positive selection. The AND operator @samp{&} is optional when @samp{+}
or @samp{-} is present. For example, @samp{+WORK-BOSS} would select all
headlines that are tagged @samp{:WORK:}, but discard those also tagged
@samp{:BOSS:}. The search string @samp{WORK|LAPTOP} selects all lines
tagged @samp{:WORK:} or @samp{:LAPTOP:}. The string
@samp{WORK|LAPTOP&NIGHT} requires that the @samp{:LAPTOP:} lines are
also tagged @samp{NIGHT}.
@node Agenda Views, Exporting, Tags, Top
@chapter Agenda Views
@cindex agenda views
Due to the way Org-mode works, TODO items, time-stamped items, and
tagged headlines can be scattered throughout a file or even a number of
files. To get an overview over open action items, or over events that
are important for a particular date, this information must be collected,
sorted and displayed in an organized way.
Org-mode can select items based on various criteria, and display them
in a separate buffer. Three different views are provided:
@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 shows 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.
@menu
* Agenda files:: Files being searched for agenda information
* Agenda dispatcher:: Keyboard access to agenda views
* Weekly/Daily Agenda:: The calendar page with current tasks
* Global TODO list:: All unfinished action items
* Matching headline tags:: Structured information with fine-tuned search
* Timeline:: Time-sorted view for single file
* Agenda commands:: Remote editing of org trees
@end menu
@node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views
@section Agenda files
The information to be shown is collected from all @emph{agenda files},
the files listed in the variable @code{org-agenda-files}@footnote{If the
value of that variable is not a list, but a single file name, then the
list of agenda files will be maintained in that external file.}. Thus even
if you only work with a single Org-mode file, this file should 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 @code{org-agenda-files}, 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. 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, visiting one file after the other.
@end table
@noindent
The Org menu contains the current list of files and can be used
to visit any of them.
@node Agenda dispatcher, Weekly/Daily Agenda, Agenda files, Agenda Views
@section The agenda dispatcher
@cindex agenda dispatcher
@cindex dispatching agenda commands
@cindex custom agenda commands
@cindex agenda commands, custom
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. After pressing @kbd{C-c a}, an additional
letter is required to execute a command. The dispatcher offers the
following default commands:
@table @kbd
@item a
Create the calendar-like agenda (@pxref{Weekly/Daily Agenda}).
@item t / T
Create a list of all TODO items (@pxref{Global TODO list}).
@item m / M
Create a list of headlines matching a TAGS expression (@pxref{Matching
headline tags}).
@end table
You can also define custom commands that will be accessible through
the dispatcher, just like the default commands. Custom commands are
global searches for tags and specific TODO keywords, or a variety of
sparse tree creating commands (@pxref{Sparse trees}). As sparse trees
are only defined for a single org-mode file, these latter commands act
on the current buffer instead of the list of agenda files.
@kindex C-c a C
Custom commands are configured in the variable
@code{org-agenda-custom-commands}. You can customize this variable,
for example by pressing @kbd{C-c a C}. You can also directly set it
with Emacs Lisp in @file{.emacs}. For example:
@lisp
(setq org-agenda-custom-commands
'(("w" todo "WAITING")
("u" tags "+BOSS-URGENT")
("U" tags-tree "+BOSS-URGENT")
("f" occur-tree "\\<FIXME\\>")))
@end lisp
@noindent will define @kbd{C-c a w} as a global search for
TODO entries with @samp{WAITING} as the TODO keyword, @kbd{C-c a u} as a
global tags search for headlines marked @samp{:BOSS:} but not
@samp{:URGENT:}, @kbd{C-c a U} to do the same search but only in the
current buffer and display the result as a sparse tree, and @kbd{C-c a
f} to create a sparse tree with all entries containing the word
@samp{FIXME}. For more information, look at the documentation string
of the variable @code{org-agenda-custom-commands}.
@node Weekly/Daily Agenda, Global TODO list, Agenda dispatcher, Agenda Views
@section The weekly/daily agenda
@cindex agenda
The purpose of the weekly/daily @emph{agenda} is to act like a page of
a paper agenda, showing all the tasks for the current week or day.
@table @kbd
@cindex org-agenda, command
@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 (including those without a date) are also listed at
the beginning of the buffer, before the first date.@*
@end table
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}.
@menu
* Categories:: Not all tasks are equal
* Time-of-day specifications:: How the agenda knows the time
* Calendar/Diary integration:: Integrating Anniversaries and more
* Sorting of agenda items:: The order of things
@end menu
@node Categories, Time-of-day specifications, Weekly/Daily Agenda, Weekly/Daily Agenda
@subsection Categories
@cindex category
In the agenda buffer, each entry is preceded by a @emph{category},
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: Thesis
@end example
If there are several such lines in a file, each specifies the category
for the text below it (but the first category also applies to any text
before the first CATEGORY line). The display in the agenda buffer looks
best if the category is not longer than 10 characters.
@node Time-of-day specifications, Calendar/Diary integration, Categories, Weekly/Daily Agenda
@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}.
@node Calendar/Diary integration, Sorting of agenda items, Time-of-day specifications, Weekly/Daily Agenda
@subsection Calendar/Diary integration
@cindex calendar integration
@cindex diary integration
Emacs contains the calendar and diary by Edward M. Reingold. The
calendar displays a three-month calendar with holidays from different
countries and cultures. The diary allows you to keep track of
anniversaries, lunar phases, sunrise/set, recurrent appointments
(weekly, monthly) and more. In this way, it is quite complementary to
Org-mode. It can be very useful to combine output from Org-mode with
the diary.
In order to include entries from the Emacs diary into Org-mode's
agenda, you only need to customize the variable
@lisp
(setq org-agenda-include-diary t)
@end lisp
@noindent After that, everything will happen automatically. All diary
entries including holidays, anniversaries etc will be included in the
agenda buffer created by Org-mode. @key{SPC}, @key{TAB}, and
@key{RET} can be used from the agenda buffer to jump to the diary
file in order to edit existing diary entries. The @kbd{i} command to
insert new entries for the current date works in the agenda buffer, as
well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
Sunrise/Sunset times, show lunar phases and to convert to other
calendars, respectively. @kbd{c} can be used to switch back and forth
between calendar and agenda.
@node Sorting of agenda items, , Calendar/Diary integration, Weekly/Daily Agenda
@subsection Sorting of agenda items
@cindex sorting, of agenda items
@cindex priorities, of agenda items
The entries for each day are sorted. The default order is to first
collect all items containing an explicit time-of-day specification.
These entries will be shown at the beginning of the list, as a
@emph{schedule} for the day. After that, items remain grouped in
categories, in the sequence given by @code{org-agenda-files}. Within
each category, items are sorted by priority (@pxref{Priorities}).
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 Global TODO list, Matching headline tags, Weekly/Daily 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 Views}) 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 allows selection of a specific TODO keyword. You can
also do this by specifying a prefix argument to @kbd{C-c a t}. 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}. If you often need a search for a specific
keyword, define a custom command for it (@pxref{Agenda dispatcher}).
@end table
Remote editing of TODO 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 agenda 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 boolean logic
expression with tags, like @samp{+WORK+URGENT-WITHBOSS} or
@samp{WORK|HOME} (@pxref{Tags}). If you often need a specific search,
define a custom command for it (@pxref{Agenda dispatcher}).
@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
and force checking subitems (see variable
@code{org-tags-match-list-sublevels}.
@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 a @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, , 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
buffer itself, but commands are provided to show and jump to the
original entry location, and to edit the org-files ``remotely'' from
the agenda buffer. In this way, all information is stored only once,
removing the risk that your agenda and note files may diverge.
Some commands can be executed with mouse clicks on agenda lines. For
the other commands, the cursor needs to be in the desired line.
@table @kbd
@tsubheading{Motion}
@kindex n
@item n
Next line (same as @key{up}).
@kindex p
@item p
Previous line (same as @key{down}).
@tsubheading{View/GoTo org file}
@kindex mouse-3
@kindex @key{SPC}
@item mouse-3
@itemx @key{SPC}
Display the original location of the item in another window.
@kindex L
@item L
Display original location and recenter that window.
@kindex mouse-2
@kindex mouse-1
@kindex @key{TAB}
@item mouse-2
@itemx mouse-1
@itemx @key{TAB}
Go to the original location of the item in another window. Under Emacs
22, @kbd{mouse-1} will also works for this.
@kindex @key{RET}
@itemx @key{RET}
Go to the original location of the item and delete other windows.
@kindex f
@item f
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
Delete other windows.
@kindex w
@item w
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}. 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}
Display the following @code{org-agenda-ndays} days. For example, if
the display covers a week, switch to the following week. With prefix
arg, go forward that many times @code{org-agenda-ndays} days.
@kindex @key{left}
@item @key{left}
Display the previous dates.
@kindex .
@item .
Goto today.
@tsubheading{Remote editing}
@item 0-9
Digit argument.
@kindex t
@item t
Change the TODO state of the item, both in the agenda and in the
original org file.
@kindex T
@item T
Show all tags assiciated with the current item. Because of
inheritance, this may be more than the tags listed in the line itself.
@kindex :
@item :
Set tags for the current headline.
@kindex ,
@item ,
Set the priority for the current item. Org-mode prompts for the
priority character. If you reply with @key{SPC}, the priority cookie
is removed from the entry.
@kindex P
@item p
Display weighted priority of current item.
@kindex +
@kindex S-@key{up}
@item +
@itemx S-@key{up}
Increase the priority of the current item. The priority is changed in
the original buffer, but the agenda is not resorted. Use the @kbd{r}
key for this.
@kindex -
@kindex S-@key{down}
@item -
@itemx S-@key{down}
Decrease the priority of the current item.
@kindex S-@key{right}
@item S-@key{right}
Change the time stamp associated with the current line by one day into
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
@kbd{r} key to update the buffer.
@kindex S-@key{left}
@item S-@key{left}
Change the time stamp associated with the current line by one day
into the past.
@kindex >
@item >
Change the time stamp associated with the current line to today.
The key @kbd{>} has been chosen, because it is the same as @kbd{S-.}
on my keyboard.
@cindex diary entries, creating from agenda
@kindex i
@item i
Insert a new entry into the diary. Prompts for the type of entry
(day, weekly, monthly, yearly, anniversary, cyclic) and creates a new
entry in the diary, just like @kbd{i d} etc. would do in the calendar.
The date is taken from the cursor position.
@tsubheading{Calendar commands}
@kindex c
@item c
Open the Emacs calendar and move to the date at the agenda cursor.
@item c
When in the calendar, compute and show the Org-mode agenda for the
date at the cursor.
@kindex M
@item M
Show the phases of the moon for the three month around current date.
@kindex S
@item S
Show sunrise and sunset times. The geographical location must be set
with calendar variables, see documentation of the Emacs calendar.
@kindex C
@item C
Convert the date at cursor into many other cultural and historic
calendars.
@kindex H
@item H
Show holidays for three month around the cursor date.
@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.
@tsubheading{Quit and Exit}
@kindex q
@item q
Quit agenda, remove the agenda buffer.
@kindex x
@cindex agenda files, removing buffers
@item x
Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
for the compilation of the agenda. Buffers created by the user to
visit org files will not be removed.
@end table
@node Exporting, Miscellaneous, Agenda Views, Top
@chapter Exporting
@cindex exporting
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
* ASCII export:: Export as a structured ASCII file
* HTML export:: Export as an HTML file
* iCalendar export:: Create calendar entries.
@end menu
@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
@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.
@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 itemized 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 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 entry (QUOTE) or region, see below.
@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 itemized 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
You can make words @b{*bold*}, @i{/italic/}, and _underlined_
@cindex @TeX{} interpretation
@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
@samp{^} and @samp{_} with a backslash: @samp{\_} and @samp{\^}
@item
@samp{\alpha} indicates a Greek letter, @samp{\to} an arrow. You can
use completion for these macros, just type @samp{\} and maybe a few
letters, and press @kbd{M-@key{TAB}} to see possible completions.
@end itemize
@cindex tables, export to HTML
@item
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
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 you want to include HTML tags which should be interpreted as such,
mark them with a @samp{@@} like in @samp{@@<b>bold text@@</b>}.
Plain @samp{<} and @samp{>} are always transformed to @samp{&lt;} and
@samp{&gt;} in HTML export.
@end itemize
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, 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 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)
#+AUTHOR: the author (default taken from @code{user-full-name})
#+EMAIL: his/her email address (default from @code{user-mail-address})
#+LANGUAGE: language for HTML, e.g. @samp{en} (@code{org-export-default-language})
#+TEXT: Some descriptive text to be inserted at the beginning.
#+TEXT: Several lines may be given.
#+OPTIONS: H:2 num:t toc:t \n:nil @:t ::t |:t ^:t *:nil TeX:t
@end example
@noindent
The OPTIONS line is a compact form to specify export settings. Here
you can:
@cindex headline levels
@cindex section-numbers
@cindex table of contents
@cindex linebreak preservation
@cindex quoted html tags
@cindex fixed-width sections
@cindex tables
@cindex @TeX{}-like syntax for sub- and superscripts
@cindex emphasized text
@cindex @TeX{} macros
@example
H: @r{set the number of headline levels for export}
num: @r{turn on/off section-numbers}
toc: @r{turn on/off table of contents}
\n: @r{turn on/off linebreak-preservation}
@@: @r{turn on/off quoted html tags}
:: @r{turn on/off fixed-width sections}
|: @r{turn on/off tables}
^: @r{turn on/off @TeX{}-like syntax for sub- and superscripts.}
*: @r{turn on/off emphasized text (bold, italic, underlined)}
TeX: @r{turn on/off @TeX{} macros}
@end example
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. This applies also for
ASCII export.
@table @kbd
@kindex C-c ;
@item 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
* Clean view:: Getting rid of leading stars in the outline
* TTY keys:: Using Org-mode on a tty
* FAQ:: Frequently asked questions
* Interaction:: Other Emacs packages
* Bugs:: Things which do not work perfectly
* Acknowledgments:: These people provided feedback and more
@end menu
@node Completion, Customization, Miscellaneous, Miscellaneous
@section Completion
@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
the buffer and use the key to complete text right there.
@table @kbd
@kindex M-@key{TAB}
@item M-@key{TAB}
Complete word at point
@itemize @bullet
@item
At the beginning of a headline, complete TODO keywords.
@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 elsewhere 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
will insert example settings for this keyword.
@item
Elsewhere, complete dictionary words using ispell.
@end itemize
@end table
@node Customization, Clean view, Completion, Miscellaneous
@section Customization
@cindex customization
@cindex options, for customization
@cindex variables, for customization
There are more than 100 variables that can be used to customize
Org-mode. For the sake of compactness of the manual, we are not
describing the variables here. A structured overview of customization
variables is available with @kbd{M-x org-customize}. Or select
@code{Browse Org Group} from the @code{Org->Customization} menu.
@node Clean view, TTY keys, Customization, Miscellaneous
@section A cleaner outline view
@cindex hiding leading stars
@cindex clean outline view
Some people find it noisy and distracting that the Org-mode headlines
are starting with a potentially large number of stars. For example
the tree from @ref{Headlines}:
@example
* Top level headline
** Second level
*** 3rd level
some text
*** 3rd level
more text
* Another top level headline
@end example
@noindent
Unfortunately this is deeply ingrained into the code of Org-mode and
cannot be easily changed. You can, however, modify the display in such
a way that all leading stars become invisible and the outline more easy
to read. To do this, customize the variable
@code{org-hide-leading-stars} like this:
@lisp
(setq org-hide-leading-stars t)
@end lisp
@noindent
or change this on a per-file basis with one of the lines (anywhere in
the buffer)
@example
#+STARTUP: showstars
#+STARTUP: hidestars
@end example
@noindent
Press @kbd{C-c C-c} with the cursor in a @samp{STARTUP} line to activate
the modifications.
With stars hidden, the tree becomes:
@example
* Top level headline
* Second level
* 3rd level
some text
* 3rd level
more text
* Another top level headline
@end example
@noindent
Note that the leading stars are not truly replaced by whitespace, they
are only fontified with the face @code{org-hide} that uses the
background color as font color. If are are not using either white or
black background, you may have to customize this face to get the wanted
effect. Another possibility is to set this font such that the extra
stars are @i{almost} invisible, for example using the color
@code{grey90} on a white background.
Things become cleaner still if you skip all the even levels and use only
odd levels 1, 3, 5..., effectively adding two stars to go from one
outline level to the next:
@example
* Top level headline
* Second level
* 3rd level
some text
* 3rd level
more text
* Another top level headline
@end example
@noindent
In order to make the structure editing and export commands handle this
convention correctly, use
@lisp
(setq org-odd-levels-only t)
@end lisp
@noindent
or set this on a per-file basis with one of the following lines (don't
forget to press @kbd{C-c C-c} with the cursor in the startup line to
activate changes immediately).
@example
#+STARTUP: odd
#+STARTUP: oddeven
@end example
You can convert an Org-mode file from single-star-per-level to
the double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
RET} in that file. There is no command for the back conversion because
such a command might merge levels and in this way destroy the
structure of the tree.
@c FIXME: Maybe we should have such a command...
@node TTY keys, FAQ, Clean view, 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.
@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 FAQ, Interaction, TTY keys, 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
@item @b{Some of my links stopped working after I upgraded to a version
4.20 or later. Why is this, and how can I fix it?}@* The newer versions of
Org-mode have a better link system and no longer allow unescaped space
characters as part of a link. To fix these links, and also to move all
@samp{<link>} style links to the new @samp{[[link]]} system, execute
once in each Org-mode file: @kbd{M-x org-upgrade-old-links}.
@item @b{I really like the old style links with angular brackets
better. Please give them back to me, don't tell me it is not
possible!}@* Would I let you down like that? If you must (even if I
don't understand why), you can do this
@lisp
(setq org-allow-space-in-plain-links t
org-link-style 'plain
org-link-format "<%s>")
@end lisp
@item @b{All these stars are driving me mad, I just find the Emacs
outlines unreadable. Can't you just put white space and a single star as a
starter for headlines?}@*
See @ref{Clean view}.
@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
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{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:
@example
* Todays top priorities
**** TODO write a letter to xyz
**** TODO Finish the paper
**** Pick up kids at the school
@end example
Alternatively, if you need a specific value for the heading/item
transition in a particular file, use the @samp{+OPTIONS} line to
configure the @samp{H} switch.
@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
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
To insert an empty table template, just type @samp{|-} and use
@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
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}.
@item @b{Is it possible to include entries from org-mode files into my
emacs diary?}@*
Since the org-mode agenda is much more powerful and can contain the
diary (@pxref{Calendar/Diary integration}), you should think twice
before deciding to do this. Integrating Org-mode information into the
diary is, however, possible. The following steps are necessary:
Autoload the function @command{org-diary} as shown above under
@ref{Installation and activation}. You also need to use @emph{fancy
diary display} by setting in @file{.emacs}:
@lisp
(add-hook 'diary-display-hook 'fancy-diary-display)
@end lisp
Then include the following line into your @file{~/diary} file, in
order to get the entries from all files listed in the variable
@code{org-agenda-files}:
@example
&%%(org-diary)
@end example
@noindent
You may also select specific files with
@example
&%%(org-diary) ~/path/to/some/org-file.org
&%%(org-diary) ~/path/to/another/org-file.org
@end example
If you now launch the calendar and press @kbd{d} to display a diary,
the headlines of entries containing a timestamp, date range, schedule,
or deadline referring to the selected date will be listed. Just like
in Org-mode's agenda view, the diary for @emph{today} contains
additional entries for overdue deadlines and scheduled items. See
also the documentation of the @command{org-diary} function.
@end enumerate
@node Interaction, Bugs, FAQ, Miscellaneous
@section Interaction with other packages
@cindex packages, interaction with other
Org-mode can cooperate with the following packages:
@table @asis
@cindex @file{org-mouse.el}
@item @file{org-mouse.el} by Piotr Zielinski
This package implements extended mouse functionality for Org-mode. It
allows you to cycle visibility and to edit the document structure with
the mouse. It also provides a context-sensitive menu that changes
depending on the context of a mouse-click. Use a search engine to find
this package on the web.
@cindex @file{table.el}
@item @file{table.el} by Takaaki Ota
Org mode cooperates with table.el, see @ref{table.el}. @file{table.el}
is part of Emacs 22.
@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 your 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}.
@file{Remember.el} is not part of Emacs, find it on the web.
@end table
@node Bugs, Acknowledgments, Interaction, Miscellaneous
@section Bugs
@cindex bugs
Here is a list of things that should work differently, but which I
have found too hard to fix.
@itemize @bullet
@item
If a table field starts with a link, and if the corresponding table
column is narrowed (@pxref{Narrow columns}) to a width too small to
display the link, the field would look entirely empty even though it is
not. To prevent this, Org-mode throws an error. The work-around is to
make the column wide enough to fit the link, or to add some text (at
least 2 characters) before the link in the same field.
@item
Narrowing table columns does not work on XEmacs, because the
@code{format} function does not transport text properties.
@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
Plain list items should be able to hold a TODO item. Unfortunately this
has so many technical problems that I will only consider this change for
the next major release (5.0).
@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
You can only make a single word boldface or italic. To emphasize
several words in a row, each must have the emphasize markers, like in
@samp{*three* *bold* *words*}.
@item
The exporters work well, but could be made more efficient.
@end itemize
@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/}.
The following people (in alphabetic order) have helped the development
along with ideas, suggestions and patches. Many thanks to all of you,
Org-mode would not be what it is without your input.
@itemize @bullet
@item
Thomas Baumann contributed the code for links to the MH-E email system.
@item
Alex Bochannek provided a patch for rounding time stamps.
@item
Charles Caves' suggestion sparked the implementation of templates for
Remember.
@item
Pavel Chalmoviansky influenced the agenda treatment of items with
specified time.
@item
Sacha Chua suggested to copy some linking code from Planner.
@item
Christian Egli converted the documentation into TeXInfo format, patched
CSS formatting into the HTML exporter, and inspired the agenda.
@item
Nic Ferrier contributed mailcap and XML support.
@item
Kai Grossjohann pointed out key-binding conflicts caused by Org-mode.
@item
Stefan Monnier provided a patch to keep the Emacs-Lisp compiler happy.
@item
Tim O'Callaghan suggested in-file links, search options for
general file links, and TAGS.
@item
Oliver Oppitz suggested multi-state TODO items.
@item
Scott Otterson sparked the introduction of descriptive text for links,
among other things.
@item
Pete Phillips helped the development of the TAGS feature.
@item
Matthias Rempe (Oelde) provided ideas, Windows support, and quality
control.
@item
Kevin Rogers contributed code to access VM files on remote hosts.
@item
Philip Rooke created the Org-mode reference card and provided lots of feedback.
@item
Christian Schlauer proposed angular brackets around links, among other
things.
@item
Linking to VM/BBDB/GNUS was inspired by Tom Shannon's
@file{organizer-mode.el}.
@item
J@"urgen Vollmer contributed code generating the table of contents
in HTML output.
@item
Chris Wallace provided a patch implementing the @samp{QUOTE} keyword.
@item
David Wainberg suggested archiving, and improvements to the linking
system.
@item
John Wiegley wrote @file{emacs-wiki.el} and @file{planner.el}. The
development of Org-mode was fully independent, and both systems are
really different beasts in their basic ideas and implementation details.
However, I have later looked at John's code and learned from his
implementation of (i) links where the link itself is hidden and only a
description is shown, and (ii) popping up a calendar to select a date.
@item
Carsten Wimmer suggested some changes and helped fix a bug in linking
to GNUS.
@item
Roland Winkler requested additional keybindings to make Org-mode
work on a tty.
@item
Piotr Zielinski wrote @file{org-mouse.el} and showed how to follow links
with mouse-1.
@end itemize
@node Index, Key Index, Miscellaneous, Top
@chapter Index
@printindex cp
@node Key Index, , Index, Top
@chapter Key Index
@printindex ky
@bye
@ignore
arch-tag: 7893d1fe-cc57-4d13-b5e5-f494a1bcc7ac
@end ignore
View Git Blame Copy Permalink