[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Emacs-diffs] Changes to emacs/man/Attic/org.texi, v [EMACS_22_BASE]
|
From: |
Carsten Dominik |
|
Subject: |
[Emacs-diffs] Changes to emacs/man/Attic/org.texi, v [EMACS_22_BASE] |
|
Date: |
Tue, 08 Apr 2008 07:47:50 +0000 |
CVSROOT: /sources/emacs
Module name: emacs
Branch: EMACS_22_BASE
Changes by: Carsten Dominik <cdominik> 08/04/08 07:47:50
Index: org.texi
===================================================================
RCS file: /sources/emacs/emacs/man/Attic/org.texi,v
retrieving revision 1.78.2.3
retrieving revision 1.78.2.4
diff -u -b -r1.78.2.3 -r1.78.2.4
--- org.texi 12 Mar 2008 14:37:46 -0000 1.78.2.3
+++ org.texi 8 Apr 2008 07:47:49 -0000 1.78.2.4
@@ -3,8 +3,8 @@
@setfilename ../info/org
@settitle Org Mode Manual
address@hidden VERSION 4.67
address@hidden DATE February 2007
address@hidden VERSION 5.23
address@hidden DATE March 2008
@dircategory Emacs
@direntry
@@ -12,11 +12,11 @@
@end direntry
@c Version and Contact Info
address@hidden MAINTAINERSITE @uref{http://orgmode.org/,maintainers webpage}
address@hidden MAINTAINERSITE @uref{http://orgmode.org,maintainers webpage}
@set AUTHOR Carsten Dominik
@set MAINTAINER Carsten Dominik
address@hidden MAINTAINEREMAIL @email{dominik at science dot uva dot nl}
address@hidden MAINTAINERCONTACT @uref{mailto:dominik at science dot uva dot
nl,contact the maintainer}
address@hidden MAINTAINEREMAIL @email{carsten at orgmode dot org}
address@hidden MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot
org,contact the maintainer}
@c %**end of header
@finalout
@@ -80,8 +80,10 @@
* 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
+* Properties and columns:: Storing information about an entry
+* Dates and times:: Making items useful for planning
+* Remember:: Quickly adding nodes to the outline tree
* Agenda views:: Collecting information into views
* Embedded LaTeX:: LaTeX fragments and formulas
* Exporting:: Sharing and publishing of notes
@@ -89,8 +91,7 @@
* Miscellaneous:: All the rest which did not fit elsewhere
* Extensions and Hacking:: It is possible to write add-on code
* History and Acknowledgments:: How Org-mode came into being
-* GNU Free Documentation License:: The license for this documentation.
-* Index:: The fast road to specific information
+* Main Index::
* Key Index:: Key bindings and where they are described
@detailmenu
@@ -102,6 +103,7 @@
* Installation:: How to install a downloaded version of Org-mode
* Activation:: How to activate Org-mode for certain buffers.
* Feedback:: Bug reports, ideas, patches etc.
+* Conventions:: Type-setting conventions in the manual
Document Structure
@@ -113,6 +115,8 @@
* Archiving:: Move done task trees to a different place
* Sparse trees:: Matches embedded in context
* Plain lists:: Additional structure within an entry
+* Drawers:: Tucking stuff away
+* orgstruct-mode:: Structure editing outside Org-mode
Archiving
@@ -123,6 +127,7 @@
* Built-in table editor:: Simple tables
* Narrow columns:: Stop wasting space in tables
+* Column groups:: Grouping to trigger vertical lines
* orgtbl-mode:: The table editor as minor mode
* The spreadsheet:: The table editor has spreadsheet capabilities.
@@ -143,58 +148,87 @@
* Internal links:: Links to other places in the current file
* External links:: URL-like links to the world
* Handling links:: Creating, inserting and following
+* Using links outside Org-mode:: Linking from my C source code?
* Link abbreviations:: Shortcuts for writing complex links
* Search options:: Linking to a specific location
* Custom searches:: When the default search is not enough
-* Remember:: Org-trees store quick notes
Internal links
* Radio targets:: Make targets trigger links in plain text.
-Remember
-
-* Setting up remember:: Some code for .emacs to get things going
-* Remember templates:: Define the outline of different note types
-* Storing notes:: Directly get the note to where it belongs
-
TODO items
* TODO basics:: Marking and displaying TODO entries
* TODO extensions:: Workflow and assignments
+* Progress logging:: Dates and notes for progress
* Priorities:: Some things are more important than others
-* Breaking down tasks:: Splitting a task into managable pieces
+* Breaking down tasks:: Splitting a task into manageable pieces
* Checkboxes:: Tick-off lists
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
+* TODO types:: I do this, Fred does the rest
+* Multiple sets in one file:: Mixing it all, and still finding your way
+* Fast access to TODO states:: Single letter selection of a state
+* Per-file keywords:: Different files, different requirements
+* Faces for TODO keywords:: Highlighting states
+
+Progress Logging
+
+* Closing items:: When was this entry marked DONE?
+* Tracking TODO state changes:: When did the status change?
+
+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
+
+Properties and Columns
+
+* Property syntax:: How properties are spelled out
+* Special properties:: Access to other Org-mode features
+* Property searches:: Matching property values
+* Property inheritance:: Passing values down the tree
+* Column view:: Tabular viewing and editing
+* Property API:: Properties for Lisp programmers
+
+Column View
-Timestamps
+* Defining columns:: The COLUMNS format property
+* Using column view:: How to create and use column view
+* Capturing Column View:: A dynamic block for column view
+
+Defining Columns
+
+* Scope of column definitions:: Where defined, where valid?
+* Column attributes:: Appearance and content of a column
+
+Dates and Times
* Time stamps:: Assigning a time to a tree entry
* Creating timestamps:: Commands which insert timestamps
-* Custom time format:: If you cannot work with the ISO format
-* Repeating items:: Deadlines that come back again and again
-* Progress logging:: Documenting when what work was done.
+* Deadlines and scheduling:: Planning your work
+* Clocking work time::
Creating timestamps
* The date/time prompt:: How org-mode helps you entering date and time
+* Custom time format:: Making dates look differently
-Progress Logging
+Deadlines and Scheduling
-* Closing items:: When was this entry marked DONE?
-* Tracking TODO state changes:: When did the status change?
-* Clocking work time:: When exactly did you work on this item?
+* Inserting deadline/schedule:: Planning items
+* Repeated tasks:: Items that show up again and again
-Tags
+Remember
-* 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
+* Setting up remember:: Some code for .emacs to get things going
+* Remember templates:: Define the outline of different note types
+* Storing notes:: Directly get the note to where it belongs
+* Refiling notes:: Moving a note or task to a project
Agenda Views
@@ -209,8 +243,9 @@
* 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
+* Matching tags and properties:: Structured information with fine-tuned search
* Timeline:: Time-sorted view for single file
+* Keyword search:: Finding entries by keyword
* Stuck projects:: Find projects you need to review
Presentation and sorting
@@ -224,7 +259,8 @@
* Storing searches:: Type once, use often
* Block agenda:: All the stuff you need in a single buffer
* Setting Options:: Changing the rules
-* Batch processing:: Agenda views from the command line
+* Exporting Agenda Views:: Writing agendas to files.
+* Extracting Agenda Information for other programs::
Embedded LaTeX
@@ -238,21 +274,31 @@
* ASCII export:: Exporting to plain ASCII
* HTML export:: Exporting to HTML
+* LaTeX export:: Exporting to LaTeX
* XOXO export:: Exporting to XOXO
* iCalendar export:: Exporting in iCalendar format
* Text interpretation:: How the exporter looks at the file
HTML export
-* Export commands:: How to invode HTML export
+* HTML Export commands:: How to invoke LaTeX export
* Quoting HTML tags:: Using direct HTML in Org-mode
-* Links:: How hyperlinks get transferred to HTML
-* Images:: To inline or not to inline?
-* CSS support:: Style specifications
+* Links:: Transformation of links for HTML
+* Images:: How to include images
+* CSS support:: Changing the appearence of the output
+
+LaTeX export
+
+* LaTeX export commands:: How to invoke LaTeX export
+* Quoting LaTeX code:: Incorporating literal LaTeX code
+* Sectioning structure::
Text interpretation by the exporter
* Comment lines:: Some lines will not be exported
+* Initial text:: Text before the first headline
+* Footnotes:: Numbers like [1]
+* Quoted examples:: Inserting quoted chnuks of text
* Enhancing text:: Subscripts, symbols and more
* Export options:: How to influence the export settings
@@ -296,15 +342,18 @@
Extensions, Hooks and Hacking
* Extensions:: Existing 3rd-part extensions
+* Adding hyperlink types:: New custom link types
* Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs
* Dynamic blocks:: Automatically filled blocks
* Special agenda views:: Customized views
+* Using the property API:: Writing programs that use entry properties
-Tables in arbitrary syntax
+Tables and Lists in arbitrary syntax
* Radio tables:: Sending and receiving
* A LaTeX example:: Step by step, almost a tutorial
* Translator functions:: Copy and modify
+* Radio lists:: Doing the same for lists.
@end detailmenu
@end menu
@@ -318,13 +367,14 @@
* Installation:: How to install a downloaded version of Org-mode
* Activation:: How to activate Org-mode for certain buffers.
* Feedback:: Bug reports, ideas, patches etc.
+* Conventions:: Type-setting conventions in the manual
@end menu
@node Summary, Installation, Introduction, Introduction
@section Summary
@cindex summary
-Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
+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
@@ -332,13 +382,13 @@
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,
+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
+structured ASCII file, as HTML, or (TODO and agenda items only) as an
iCalendar file. It can also serve as a publishing tool for a set of
linked webpages.
@@ -354,7 +404,7 @@
Org-mode keeps simple things simple. When first fired up, it should
feel like a straightforward, 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
+it. Org-mode is a toolbox and can be used in different ways, for
example as:
@example
@@ -364,20 +414,23 @@
@address@hidden TODO list editor}
@address@hidden full agenda and planner with deadlines and work scheduling}
@address@hidden environment to implement David Allen's GTD system}
address@hidden@bullet{} simple hypertext system, with HTML export}
address@hidden@bullet{} a basic database application}
address@hidden@bullet{} simple hypertext system, with HTML and LaTeX export}
@address@hidden publishing tool to create a set of interlinked webpages}
@end example
Org-mode's automatic, context sensitive table editor with spreadsheet
capabilities can be integrated into any major mode by activating the
minor Orgtbl-mode. Using a translation step, it can be used to maintain
-tables in arbitray file types, for example in LaTeX.
+tables in arbitrary file types, for example in address@hidden The structure
+editing and list creation capabilities can be used outside Org-mode with
+the minor Orgstruct-mode.
@cindex FAQ
There is a website for Org-mode which provides links to the newest
version of Org-mode, as well as additional information, frequently asked
questions (FAQ), links to tutorials etc. This page is located at
address@hidden://orgmode.org/}.
address@hidden://orgmode.org}.
@page
@@ -443,9 +496,10 @@
@iftex
@b{Important:} @i{If you use copy-and-paste to copy lisp code from the
-PDF documentation to your .emacs file, the single quote character comes
-out incorrectly and the code will not work. You need to fix the single
-quotes by hand, or copy from Info documentation.}
+PDF documentation as viewed by Acrobat reader to your .emacs file, the
+single quote character comes out incorrectly and the code will not work.
+You need to fix the single quotes by hand, or copy from Info
+documentation.}
@end iftex
Add the following lines to your @file{.emacs} file. The last two lines
@@ -454,9 +508,9 @@
@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)
+(add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
+(global-set-key "\C-cl" 'org-store-link)
+(global-set-key "\C-ca" 'org-agenda)
@end lisp
Furthermore, you must activate @code{font-lock-mode} in org-mode
@@ -481,7 +535,7 @@
the file's name is. See also the variable
@code{org-insert-mode-line-in-empty-file}.
address@hidden Feedback, , Activation, Introduction
address@hidden Feedback, Conventions, Activation, Introduction
@section Feedback
@cindex feedback
@cindex bug reports
@@ -538,6 +592,27 @@
attach it to your bug report.
@end enumerate
address@hidden Conventions, , Feedback, Introduction
address@hidden Typesetting conventions used in this manual
+
+Org-mode uses three types of keywords: TODO keywords, tags, and property
+names. In this manual we use the following conventions:
+
address@hidden @code
address@hidden TODO
address@hidden WAITING
+TODO keywords are written with all capitals, even if they are
+user-defined.
address@hidden boss
address@hidden ARCHIVE
+User-defined tags are written in lowercase; built-in tags with special
+meaning are written with all capitals.
address@hidden Release
address@hidden PRIORITY
+User-defined properties are capitalized; built-in properties with
+special meaning are written with all capitals.
address@hidden table
+
@node Document structure, Tables, Introduction, Top
@chapter Document Structure
@cindex document structure
@@ -555,6 +630,8 @@
* Archiving:: Move done task trees to a different place
* Sparse trees:: Matches embedded in context
* Plain lists:: Additional structure within an entry
+* Drawers:: Tucking stuff away
+* orgstruct-mode:: Structure editing outside Org-mode
@end menu
@node Outlines, Headlines, Document structure, Document structure
@@ -562,15 +639,14 @@
@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
+Org-mode is implemented on top of outline-mode. Outlines allow a
+document to be organized in a hierarchical structure, which (at least
+for me) is the best representation of notes and thoughts. An overview
+of 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.
+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
@@ -578,8 +654,9 @@
@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:
+Org-mode start with one or more stars, on the left address@hidden
+the variable @code{org-special-ctrl-a/e} to configure special behavior
+of @kbd{C-a} and @kbd{C-e} in headlines.}. For example:
@example
* Top level headline
@@ -588,6 +665,7 @@
some text
*** 3rd level
more text
+
* Another top level headline
@end example
@@ -595,6 +673,12 @@
outline that has whitespace followed by a single star as headline
starters. @ref{Clean view} describes a setup to realize this.
+An empty line after the end of a subtree is considered part of it and
+will be hidden when the subtree is folded. However, if you leave at
+least two empty lines, one empty line will remain visible after folding
+the subtree, in order to structure the collapsed view. See the
+variable @code{org-cycle-separator-lines} to modify this behavior.
+
@node Visibility cycling, Motion, Headlines, Document structure
@section Visibility cycling
@cindex cycling, visibility
@@ -615,7 +699,7 @@
@table @kbd
@kindex @key{TAB}
@item @key{TAB}
address@hidden cycling}: Rotate current subtree between the states
address@hidden cycling}: Rotate current subtree among the states
@example
,-> FOLDED -> CHILDREN -> SUBTREE --.
@@ -637,7 +721,7 @@
@kindex address@hidden
@item address@hidden
@itemx C-u @key{TAB}
address@hidden cycling}: Rotate the entire buffer between the states
address@hidden cycling}: Rotate the entire buffer among the states
@example
,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
@@ -656,19 +740,27 @@
@item C-c C-r
Reveal context around point, showing the current entry, the following
heading and the hierarchy above. Useful for working near a location
-exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda
-command (@pxref{Agenda commands}). With prefix arg show, on each
+that has been exposed by a sparse tree command (@pxref{Sparse trees}) or
+an agenda command (@pxref{Agenda commands}). With prefix arg show, on
+each
+
level, all sibling headings.
@kindex C-c C-x b
@item C-c C-x b
Show the current subtree in an indirect address@hidden indirect
-buffer (@pxref{Indirect Buffers,Indirect Buffers,Indirect
-Buffers,emacs,GNU Emacs Manual}) will contain the entire buffer, but
-will be narrowed to the current tree. Editing the indirect buffer will
-also change the original buffer, but without affecting visibility in
-that buffer.}. With numerical prefix ARG, go up to this level and then
-take that tree. If ARG is negative, go up that many levels. With
address@hidden prefix, do not remove the previously used indirect buffer.
+buffer
address@hidden
+(@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
address@hidden ifinfo
address@hidden
+(see the Emacs manual for more information about indirect buffers)
address@hidden ifnotinfo
+will contain the entire buffer, but will be narrowed to the current
+tree. Editing the indirect buffer will also change the original buffer,
+but without affecting visibility in that buffer.}. With numerical
+prefix ARG, go up to this level and then take that tree. If ARG is
+negative, go up that many levels. With @kbd{C-u} prefix, do not remove
+the previously used indirect buffer.
@end table
When Emacs first visits an Org-mode file, the global state is set to
@@ -710,10 +802,16 @@
@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.
+you can use the following keys to find your destination:
address@hidden
address@hidden @r{Cycle visibility.}
address@hidden / @key{up} @r{Next/previous visible headline.}
+n / p @r{Next/previous visible headline.}
+f / b @r{Next/previous headline same level.}
+u @r{One level up.}
+0-9 @r{Digit argument.}
address@hidden @r{Select this location.}
address@hidden example
@end table
@node Structure editing, Archiving, Motion, Document structure
@@ -736,12 +834,18 @@
creation of a new headline, use a prefix arg, or first press @key{RET}
to get to the beginning of the next line. When this command is used in
the middle of a line, the line is split and the rest of the line becomes
-the new headline. If the command is used at the beginning of a
-headline, the new headline is created before the current line. If at
-the beginning of any other line, the content of that line is made the
-new heading. If the command is used at the end of a folded subtree
-(i.e. behind the ellipses at the end of a headline), then a headline
-like the current one will be inserted after the end of the subtree.
+the new address@hidden you do not want the line to be split,
+customize the variable @code{org-M-RET-may-split-line}.}. If the
+command is used at the beginning of a headline, the new headline is
+created before the current line. If at the beginning of any other line,
+the content of that line is made the new heading. If the command is
+used at the end of a folded subtree (i.e. behind the ellipses at the end
+of a headline), then a headline like the current one will be inserted
+after the end of the subtree.
address@hidden address@hidden
address@hidden address@hidden
+Insert a new heading after the current subtree, same level as the
+current headline. This command works from anywhere in the entry.
@kindex address@hidden
@item address@hidden
Insert new TODO entry with same level as current heading.
@@ -769,24 +873,36 @@
@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.
+With prefix arg, kill N sequential subtrees.
@kindex C-c C-x M-w
@item C-c C-x M-w
-Copy subtree to kill ring.
+Copy subtree to kill ring. With prefix arg, copy N sequential subtrees.
@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{****}.
address@hidden C-c C-w
address@hidden C-c C-w
+Refile entry to a different location. @xref{Refiling notes}.
@kindex C-c ^
@item C-c ^
Sort same-level entries. When there is an active region, all entries in
the region will be sorted. Otherwise the children of the current
headline are sorted. The command prompts for the sorting method, which
can be alphabetically, numerically, by time (using the first time stamp
-in each entry), and each of these in reverse order. With a @kbd{C-u}
-prefix, sorting will be case-sensitive. With two @kbd{C-u C-u}
-prefixes, duplicate entries will also be removed.
+in each entry), by priority, and each of these in reverse order. You
+can also supply your own function to extract the sorting key. With a
address@hidden prefix, sorting will be case-sensitive. With two @kbd{C-u
+C-u} prefixes, duplicate entries will also be removed.
address@hidden C-c *
address@hidden C-c *
+Turn a normal line or plain list item into a headline (so that it
+becomes a subheading at its location). Also turn a headline into a
+normal line by removing the stars. If there is an active region, turn
+all lines in the region into headlines. Or, if the first line is a
+headline, remove the stars from all headlines in the region.
@end table
@cindex region, active
@@ -874,7 +990,9 @@
@kindex C-c C-x C-s
@item C-c C-x C-s
Archive the subtree starting at the cursor position to the location
-given by @code{org-archive-location}.
+given by @code{org-archive-location}. Context information that could be
+lost like the file name, the category, inherited tags, and the todo
+state will be store as properties in the entry.
@kindex C-u C-c C-x C-s
@item C-u C-c C-x C-s
Check if any direct children of the current headline could be moved to
@@ -890,16 +1008,28 @@
current file name. For information and examples on how to change this,
see the documentation string of the variable
@code{org-archive-location}. There is also an in-buffer option for
-setting this variable, for example
+setting this variable, for address@hidden backward compatibility,
+the following also works: If there are several such lines in a file,
+each specifies the archive location for the text below it. The first
+such line also applies to any text before its definition. However,
+using this method is @emph{strongly} deprecated as it is incompatible
+with the outline structure of the document. The correct method for
+setting multiple archive locations in a buffer is using a property.}:
@example
#+ARCHIVE: %s_done::
@end example
@noindent
-You may have several such lines in the buffer, they will then be valid
-for the entries following the line (the first will also apply to any
-text before it).
+If you would like to have a special ARCHIVE location for a single entry
+or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
+location as the value (@pxref{Properties and columns}).
+
+When a subtree is moved, it receives a number of special properties that
+record context information like the file from where the entry came, it's
+outline path the archiving time etc. Configure the variable
address@hidden to adjust the amount of information
+added.
@node Sparse trees, Plain lists, Archiving, Document structure
@section Sparse trees
@@ -909,31 +1039,34 @@
@cindex occur, command
An important feature of Org-mode is the ability to construct
address@hidden 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 address@hidden also the variables
address@hidden, @code{org-show-following-heading}, and
address@hidden for detailed control on how much context is
-shown around each match.}. Just try it out and you will see immediately
-how it works.
address@hidden trees} for selected information in an outline tree, so that
+the entire document is folded as much as possible, but the selected
+information is made visible along with the headline structure above
address@hidden also the variables @code{org-show-hierarchy-above},
address@hidden, and @code{org-show-siblings} for
+detailed control on how much context is shown around each match.}. 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}:
+Org-mode contains several commands creating such trees, all these
+commands can be accessed through a dispatcher:
@table @kbd
@kindex C-c /
@item C-c /
+This prompts for an extra key to select a sparse-tree creating command.
address@hidden C-c / r
address@hidden C-c / r
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 changes an editing command, or by pressing @kbd{C-c
-C-c}. When called with a @kbd{C-u} prefix argument, previous highlights
-are kept, so several calls to this command can be stacked.
+when the buffer is changed by an editing command, or by pressing
address@hidden C-c}. When called with a @kbd{C-u} prefix argument, previous
+highlights are kept, so several calls to this command can be stacked.
@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
@@ -949,8 +1082,8 @@
@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 use sparse trees as well. For example @kbd{C-c
-C-v} creates a sparse TODO tree (@pxref{TODO basics}).
+The other sparse tree commands select headings based on TODO keywords,
+tags, or properties and will be discussed later in this manual.
@kindex C-c C-e v
@cindex printing sparse trees
@@ -962,7 +1095,7 @@
Or you can use the command @kbd{C-c C-e v} to export only the visible
part of the document and print the resulting file.
address@hidden Plain lists, , Sparse trees, Document structure
address@hidden Plain lists, Drawers, Sparse trees, Document structure
@section Plain lists
@cindex plain lists
@cindex lists, plain
@@ -972,7 +1105,7 @@
Within an entry of the outline tree, hand-formatted lists can provide
additional structure. They also provide a way to create lists of
checkboxes (@pxref{Checkboxes}). Org-mode supports editing such lists,
-and the HTML exporter (@pxref{Exporting}) does parse and format them.
+and the HTML exporter (@pxref{Exporting}) parses and formats them.
Org-mode knows ordered and unordered lists. Unordered list items start
with @samp{-}, @samp{+}, or @address@hidden using @samp{*} as a
@@ -980,14 +1113,18 @@
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 not to use it for plain list items} as
-bullets. Ordered list items start with @samp{1.} or @samp{1)}. Items
+is supported, it may be better to not use it for plain list items.} as
+bullets. Ordered list items start with a numeral followed by either a
+period or a right parenthesis, such as @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:
+less. Empty lines are part of the previous item, so you can have
+several paragraphs in one item. If you would like an empty line to
+terminate all currently open plain lists, configure the variable
address@hidden Here is an example:
@example
@group
@@ -1008,10 +1145,7 @@
deal with them address@hidden only changes the filling
settings for Emacs. For XEmacs, you should use Kyle E. Jones'
@file{filladapt.el}. To turn this on, put into @file{.emacs}:
address@hidden
-(require 'filladapt)
address@hidden example
-}.
address@hidden(require 'filladapt)}}.
The following commands act on items when the cursor is in the first line
of an item (the line with the bullet or number).
@@ -1024,16 +1158,20 @@
given by the indentation of the bullet/number. Items are always
subordinate to real headlines, however; the hierarchies remain
completely separated.
+
+If @code{org-cycle-include-plain-lists} has not been set, @key{TAB}
+fixes the indentation of the curent line in a heuristic way.
@kindex address@hidden
@item address@hidden
Insert new item at current level. With prefix arg, force a new heading
(@pxref{Structure editing}). If this command is used in the middle of a
line, the line is @emph{split} and the rest of the line becomes the new
-item. If this command is executed in the @emph{whitespace before a bullet or
-number}, the new item is created @emph{before} the current item. If the
-command is executed in the white space before the text that is part of
-an item but does not contain the bullet, a bullet is added to the
-current line.
address@hidden you do not want the line to be split, customize the
+variable @code{org-M-RET-may-split-line}.}. If this command is executed
+in the @emph{whitespace before a bullet or number}, the new item is
+created @emph{before} the current item. If the command is executed in
+the white space before the text that is part of an item but does not
+contain the bullet, a bullet is added to the current line.
@kindex address@hidden
@item address@hidden
Insert a new item with a checkbox (@pxref{Checkboxes}).
@@ -1062,22 +1200,90 @@
@kindex C-c C-c
@item C-c C-c
If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
-state of the checkbox. Otherwise, if this is an ordered list, renumber
-the ordered list at the cursor.
address@hidden table
+state of the checkbox. If not, this command makes sure that all the
+items on this list level use the same bullet. Furthermore, if this is
+an ordered list, make sure the numbering is ok.
address@hidden C-c -
address@hidden C-c -
+Cycle the entire list level through the different itemize/enumerate
+bullets (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}).
+With prefix arg, select the nth bullet from this list.
+If there is an active region when calling this, all lines will be
+converted to list items. If the first line already was a list item, any
+item markers will be removed from the list. Finally, even without an
+active region, a normal line will be converted into a list item.
address@hidden table
+
address@hidden Drawers, orgstruct-mode, Plain lists, Document structure
address@hidden Drawers
address@hidden drawers
address@hidden visibility cycling, drawers
+
+Sometimes you want to keep information associated with an entry, but you
+normally don't want to see it. For this, Org-mode has @emph{drawers}.
+Drawers need to be configured with the variable
address@hidden@footnote{You can define drawers on a per-file basis
+with a line like @code{#+DRAWERS: HIDDEN PROPERTIES STATE}}. Drawers
+look like this:
+
address@hidden
+** This is a headline
+ Still outside the drawer
+ :DRAWERNAME:
+ This is inside the drawer.
+ :END:
+ After the drawer.
address@hidden example
+
+Visibility cycling (@pxref{Visibility cycling}) on the headline will
+hide and show the entry, but keep the drawer collapsed to a single line.
+In order to look inside the drawer, you need to move the cursor to the
+drawer line and press @key{TAB} there. Org-mode uses a drawer for
+storing properties (@pxref{Properties and columns}).
+
address@hidden orgstruct-mode, , Drawers, Document structure
address@hidden The Orgstruct minor mode
address@hidden orgstruct-mode
address@hidden minor mode for structure editing
+
+If you like the intuitive way the Org-mode structure editing and list
+formatting works, you might want to use these commands in other modes
+like text-mode or mail-mode as well. The minor mode Orgstruct-mode
+makes this possible. You can always toggle the mode with @kbd{M-x
+orgstruct-mode}. To turn it on by default, for example in mail mode,
+use
+
address@hidden
+(add-hook 'mail-mode-hook 'turn-on-orgstruct)
address@hidden lisp
+
+When this mode is active and the cursor is on a line that looks to
+Org-mode like a headline of the first line of a list item, most
+structure editing commands will work, even if the same keys normally
+have different functionality in the major mode you are using. If the
+cursor is not in one of those special lines, Orgstruct-mode lurks
+silently in the shadow.
@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.
+Org-mode comes with a fast and intuitive table editor. Spreadsheet-like
+calculations are supported in connection with the Emacs @file{calc}
+package
address@hidden
+(@pxref{Top,Calc,,calc,Gnu Emacs Calculator Manual}).
address@hidden ifinfo
address@hidden
+(see the Emacs Calculator manual for more information about the Emacs
+calculator).
address@hidden ifnotinfo
@menu
* Built-in table editor:: Simple tables
* Narrow columns:: Stop wasting space in tables
+* Column groups:: Grouping to trigger vertical lines
* orgtbl-mode:: The table editor as minor mode
* The spreadsheet:: The table editor has spreadsheet capabilities.
@end menu
@@ -1087,9 +1293,9 @@
@cindex table editor, built-in
Org-mode makes it easy to format tables in plain ASCII. Any line with
address@hidden|} as the first non-white character is considered part of a
-table. @samp{|} is also the column separator. A table might look
-like this:
address@hidden|} as the first non-whitespace character is considered part of a
+table. @samp{|} is also the column separator. A table might look like
+this:
@example
| Name | Phone | Age |
@@ -1130,9 +1336,12 @@
@item C-c |
Convert the active region to table. If every line contains at least one
TAB character, the function assumes that the material is tab separated.
+If every line contains a comma, comma-separated values (CSV) are assumed.
If not, lines are split at whitespace into fields. You can use a prefix
-argument to indicate the minimum number of consecutive spaces required
-to identify a field separator (default: just one)address@hidden
+argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
+C-u} forces TAB, and a numeric argument N indicates that at least N
+consequtive spaces, or alternatively a TAB will be the separator.
address@hidden
If there is no active region, this command creates an empty Org-mode
table. But it's easier just to start typing, like
@kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
@@ -1141,16 +1350,16 @@
@kindex C-c C-c
@item C-c C-c
Re-align the table without moving the cursor.
-
address@hidden
@kindex @key{TAB}
@item @key{TAB}
Re-align the table, move to the next field. Creates a new row if
necessary.
-
address@hidden
@kindex address@hidden
@item address@hidden
Re-align, move to previous field.
-
address@hidden
@kindex @key{RET}
@item @key{RET}
Re-align the table and move down to next row. Creates a new row if
@@ -1163,34 +1372,34 @@
@item address@hidden
@itemx address@hidden
Move the current column left/right.
-
address@hidden
@kindex address@hidden
@item address@hidden
Kill the current column.
-
address@hidden
@kindex address@hidden
@item address@hidden
Insert a new column to the left of the cursor position.
-
address@hidden
@kindex address@hidden
@kindex address@hidden
@item address@hidden
@itemx address@hidden
Move the current row up/down.
-
address@hidden
@kindex address@hidden
@item address@hidden
Kill the current row or horizontal line.
-
address@hidden
@kindex address@hidden
@item address@hidden
Insert a new row above (with arg: below) the current row.
-
address@hidden
@kindex C-c -
@item C-c -
Insert a horizontal line below current row. With prefix arg, the line
is created above the current line.
-
address@hidden
@kindex C-c ^
@item C-c ^
Sort the table lines in the region. The position of point indicates the
@@ -1209,10 +1418,12 @@
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.
address@hidden
@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.
address@hidden
@kindex C-c C-x C-y
@item C-c C-x C-y
Paste a rectangular region into a table.
@@ -1220,8 +1431,11 @@
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.
address@hidden
@kindex C-c C-q
address@hidden address@hidden
@item C-c C-q
address@hidden address@hidden
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
@@ -1235,7 +1449,6 @@
@tsubheading{Calculations}
@cindex formula, in tables
@cindex calculations, in tables
-
@cindex region, active
@cindex active region
@cindex transient-mark-mode
@@ -1244,7 +1457,7 @@
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}.
-
address@hidden
@kindex address@hidden
@item address@hidden
When current field is empty, copy from first non-empty field above.
@@ -1261,24 +1474,23 @@
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.
-
address@hidden C-c @key{TAB}
address@hidden C-c @key{TAB}
-This is an alias for @kbd{C-u C-c `} to make the current field fully
-visible.
-
address@hidden
@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.
-
+separated. Useful, for example, to import a spreadsheet 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.
address@hidden C-c |
+Tables can also be imported by pasting tabular text into the org-mode
+buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
address@hidden |} command (see above under @i{Creation and conversion}.
address@hidden
@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.
-
+for example, spreadsheet or database programs.
@end table
If you don't like the automatic table editor because it gets in your
@@ -1292,7 +1504,7 @@
@noindent Then the only table command that still works is
@kbd{C-c C-c} to do a manual re-align.
address@hidden Narrow columns, orgtbl-mode, Built-in table editor, Tables
address@hidden Narrow columns, Column groups, Built-in table editor, Tables
@section Narrow columns
@cindex narrow columns in tables
@@ -1320,7 +1532,7 @@
@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
+To see the full text, hold the mouse over the field - a tool-tip 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
@@ -1338,7 +1550,42 @@
#+STARTUP: noalign
@end example
address@hidden orgtbl-mode, The spreadsheet, Narrow columns, Tables
address@hidden Column groups, orgtbl-mode, Narrow columns, Tables
address@hidden Column groups
address@hidden grouping columns in tables
+
+When Org-mode exports tables, it does so by default without vertical
+lines because that is visually more satisfying in general. Occasionally
+however, vertical lines can be useful to structure a table into groups
+of columns, much like horizontal lines can do for groups of rows. In
+order to specify column groups, you can use a special row where the
+first field contains only @samp{/}. The further fields can either
+contain @samp{<} to indicate that this column should start a group,
address@hidden>} to indicate the end of a column, or @samp{<>} to make a column
+a group of its own. Boundaries between colum groups will upon export be
+marked with vertical lines. Here is an example:
+
address@hidden
+| | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
+|---+----+-----+-----+-----+---------+------------|
+| / | <> | < | | > | < | > |
+| # | 1 | 1 | 1 | 1 | 1 | 1 |
+| # | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
+| # | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
+|---+----+-----+-----+-----+---------+------------|
+#+TBLFM: $3=$2^2::$4=$2^3::$5=$2^4::$6=sqrt($2)::$7=sqrt(sqrt(($2))
address@hidden example
+
+It is also sufficient to just insert the colum group starters after
+every vertical line you'd like to have:
+
address@hidden
+| N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
+|----+-----+-----+-----+---------+------------|
+| / | < | | | < | |
address@hidden example
+
address@hidden orgtbl-mode, The spreadsheet, Column groups, Tables
@section The Orgtbl minor mode
@cindex orgtbl-mode
@cindex minor mode for tables
@@ -1355,8 +1602,8 @@
Furthermore, with some special setup, it is possible to maintain tables
in arbitrary syntax with Orgtbl-mode. For example, it is possible to
-construct LaTeX tables with the underlying ease and power of
-Orgtbl-mode, including spreadsheet capabulities. For details, see
+construct address@hidden tables with the underlying ease and power of
+Orgtbl-mode, including spreadsheet capabilities. For details, see
@ref{Tables in arbitrary syntax}.
@node The spreadsheet, , orgtbl-mode, Tables
@@ -1367,7 +1614,12 @@
The table editor makes use of the Emacs @file{calc} package to implement
spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
-derive fields from other fields.
+derive fields from other fields. While fully featured, Org-mode's
+implementation is not identical to other spreadsheets. For example,
+Org-mode knows the concept of a @emph{column formula} that will be
+applied to all non-header fields in a column without having to copy the
+formula to each relevant field.
+
@menu
* References:: How to refer to another field or range
* Formula syntax for Calc:: Using Calc to compute stuff
@@ -1387,17 +1639,26 @@
reference other fields or ranges. In Org-mode, fields can be referenced
by name, by absolute coordinates, and by relative coordinates. To find
out what the coordinates of a field are, press @kbd{C-c ?} in that
-field.
+field, or press @kbd{C-c @}} to toggle the display of a grid.
@subsubheading Field references
@cindex field references
@cindex references, to fields
-Formulas can reference the value of another field with the operator
+Formulas can reference the value of another field in two ways. Like in
+any other spreadsheet, you may reference fields with a letter/number
+combination like @code{B3}, meaning the 2nd field in the 3rd row.
address@hidden Such references are always fixed to that field, they don't change
address@hidden when you copy and paste a formula to a different field. So
address@hidden Org-mode's @code{B3} behaves like @code{$B$3} in other
spreadsheets.
+
address@hidden
+Org-mode also uses another, more general operator that looks like this:
@example
@@row$column
@end example
address@hidden
Column references can be absolute like @samp{1}, @samp{2},address@hidden,
or relative to the current column like @samp{+1} or @samp{-2}.
@@ -1405,30 +1666,34 @@
separator lines (hlines). You can use absolute row numbers
@address@hidden, and row numbers relative to the current row like
@samp{+3} or @samp{-1}. Or specify the row relative to one of the
-hlines: @samp{I} refers to the first hline, @samp{II} to the second etc.
address@hidden refers to the first such line above the current line,
address@hidden to the first such line below the current line. You can also
-write @samp{III+2} which is the second data line after the third hline
-in the table. Relative row numbers like @samp{-3} will not cross hlines
-if the current line is too close to the hline. Instead, the value
-directly at the hline is used.
+hlines: @samp{I} refers to the first address@hidden that only
+hlines are counted that @emph{separate} table lines. If the table
+starts with a hline above the header, it does not count.}, @samp{II} to
+the second etc. @samp{-I} refers to the first such line above the
+current line, @samp{+I} to the first such line below the current line.
+You can also write @samp{III+2} which is the second data line after the
+third hline in the table. Relative row numbers like @samp{-3} will not
+cross hlines if the current line is too close to the hline. Instead,
+the value directly at the hline is used.
@samp{0} refers to the current row and column. Also, if you omit
either the column or the row part of the reference, the current
row/column is implied.
-Org-mode's references with @emph{positive} numbers correspond to fixed
-references in other spreadsheet programs. For example, @code{@@3$28}
-corresponds to @code{$AB$3}. Org-mode's references with @emph{negative}
-numbers behave similar to non-fixed references in other spreadsheet
-programs, because when the same formula is used in several fields,
-different fields are referenced each time.
+Org-mode's references with @emph{unsigned} numbers are fixed references
+in the sense that if you use the same reference in the formula for two
+different fields, the same field will be referenced each time.
+Org-mode's references with @emph{signed} numbers are floating
+references because the same reference operator can reference different
+fields depending on the field being calculated by the formula.
Here are a few examples:
@example
@@2$3 @r{2nd row, 3rd column}
+C2 @r{same as previous}
$5 @r{column 5 in the current row}
+E& @r{same as previous}
@@2 @r{current column, row 2}
@@-1$-3 @r{the field one row up, three columns to the left}
@@-I$2 @r{field just under hline above current row, column 2}
@@ -1449,6 +1714,7 @@
$1..$3 @r{First three fields in the current row.}
$P..$Q @r{Range, using column names (see under Advanced)}
@@2$1..@@4$3 @r{6 fields between these two fields.}
+A2..C4 @r{Same as above.}
@@-1$-2..@@-1 @r{3 numbers from the column to the left, 2 up to current row}
@end example
@@ -1466,12 +1732,29 @@
@samp{$name} is interpreted as the name of a column, parameter or
constant. Constants are defined globally through the variable
address@hidden If you have the
address@hidden 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}.
address@hidden, and locally (for the file) through a
+line like
+
address@hidden
+#+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
address@hidden example
+
address@hidden
+Also properties (@pxref{Properties and columns}) can be used as
+constants in table formulas: For a property @samp{:Xyz:} use the name
address@hidden, and the property will be searched in the current
+outline entry and in the hierarchy above it. If you have the
address@hidden 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 address@hidden@file{Constant.el} can
+supply the values of constants in two different unit systems, @code{SI}
+and @code{cgs}. Which one is used depends on the value of the variable
address@hidden You can use the @code{#+STARTUP} options
address@hidden and @code{constcgs} to set this value for the current
+buffer.}. Column names and parameters can be specified in special table
+lines. These are described below, see @ref{Advanced features}. All
+names must start with a letter, and further consist of letters and
+numbers.
@node Formula syntax for Calc, Formula syntax for Lisp, References, The
spreadsheet
@subsection Formula syntax for Calc
@@ -1485,6 +1768,7 @@
evaluation by @code{calc-eval} (@pxref{Calling Calc from
Your Programs,calc-eval,Calling calc from Your Lisp Programs,calc,GNU
Emacs Calc Manual}),
address@hidden FIXME: The link to the calc manual in HTML does not work.
variable substitution takes place according to the rules described above.
@cindex vectors, in table calculations
The range vectors can be directly fed into the calc vector functions
@@ -1518,7 +1802,7 @@
$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}
+$0;%.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}
@@ -1528,21 +1812,34 @@
taylor($3,x=7,2) @r{taylor series of $3, at x=7, second degree}
@end example
+Calc also contains a complete set of logical operations. For example
+
address@hidden
+if($1<20,teen,string("")) @r{``teen'' if age $1 less than 20, else empty}
address@hidden example
+
@node Formula syntax for Lisp, Field formulas, Formula syntax for Calc, The
spreadsheet
@subsection Emacs Lisp forms as formulas
@cindex Lisp forms, as table formulas
It is also possible to write a formula in Emacs Lisp; this can be useful
-for string manipulation and control structures. If a formula starts
-with a single quote followed by an opening parenthesis, then it is
-evaluated as a lisp form. The evaluation should return either a string
-or a number. Just as with @file{calc} formulas, you can specify modes
-and a printf format after a semicolon. A reference will be replaced
-with a string (in double quotes) containing the field. If you provide
-the @samp{N} mode switch, all referenced elements will be numbers.
-Ranges are inserted as space-separated fields, so you can embed them in
-list or vector syntax. A few examples, note how the @samp{N} mode is
-used when we do computations in lisp.
+for string manipulation and control structures, if the Calc's
+functionality is not enough. If a formula starts with a single quote
+followed by an opening parenthesis, then it is evaluated as a lisp form.
+The evaluation should return either a string or a number. Just as with
address@hidden formulas, you can specify modes and a printf format after a
+semicolon. With Emacs Lisp forms, you need to be concious about the way
+field references are interpolated into the form. By default, a
+reference will be interpolated as a Lisp string (in double quotes)
+containing the field. If you provide the @samp{N} mode switch, all
+referenced elements will be numbers (non-number fields will be zero) and
+interpolated as Lisp numbers, without quotes. If you provide the
address@hidden flag, all fields will be interpolated literally, without quotes.
+I.e., if you want a reference to be interpreted as a string by the Lisp
+form, enclode the reference operator itself in double quotes, like
address@hidden"$3"}. Ranges are inserted as space-separated fields, so you can
+embed them in list or vector syntax. A few examples, note how the
address@hidden mode is used when we do computations in lisp.
@example
@r{Swap the first two characters of the content of column 1}
@@ -1567,12 +1864,11 @@
Formulas are stored in a special line starting with @samp{#+TBLFM:}
directly below the table. If you typed the equation in the 4th field of
the 3rd data line in the table, the formula will look like
address@hidden@@3$2=$1+$2}. When inserting/deleting/swapping column and rows
address@hidden@@3$4=$1+$2}. When inserting/deleting/swapping column and rows
with the appropriate commands, @i{absolute references} (but not relative
-ones) in stored formulas are modified in order to
-still reference the same field. Of cause this is not true if you edit
-the table structure with normal editing commands - then you must go and
-fix equations yourself.
+ones) in stored formulas are modified in order to still reference the
+same field. Of cause this is not true if you edit the table structure
+with normal editing commands - then you must fix the equations yourself.
Instead of typing an equation into the field, you may also use the
following command
@@ -1593,7 +1889,9 @@
Often in a table, the same formula should be used for all fields in a
particular column. Instead of having to copy the formula to all fields
in that column, org-mode allows to assign a single formula to an entire
-column.
+column. If the table contains horizontal separator hlines, everything
+before the first such line is considered part of the table @emph{header}
+and will not be modified by column formulas.
To assign a formula to a column, type it directly into any field in the
column, preceded by an equal sign, like @samp{=$1+$2}. When you press
@@ -1626,7 +1924,11 @@
You can edit individual formulas in the minibuffer or directly in the
field. Org-mode can also prepare a special buffer with all active
-formulas of a table.
+formulas of a table. When offering a formula for editing, Org-mode
+converts references to the standard format (like @code{B3} or @code{D&})
+if possible. If you prefer to only work with the internal format (like
address@hidden@@3$2} or @code{$4}), configure the variable
address@hidden
@table @kbd
@kindex C-c =
@@ -1645,21 +1947,36 @@
@item C-c ?
While editing a formula in a table field, highlight the field(s)
referenced by the reference at the cursor position in the formula.
address@hidden C-c @}
address@hidden C-c @}
+Toggle the display of row and column numbers for a table, using
+overlays. These are updated each time the table is aligned, you can
+force it with @kbd{C-c C-c}.
address@hidden C-c @{
address@hidden C-c @{
+Toggle the formula debugger on and off. See below.
@kindex C-c '
@item C-c '
Edit all formulas for the current table in a special buffer, where the
-formulas will be displayed one per line.
+formulas will be displayed one per line. If the current field has an
+active formula, the cursor in the formula editor will mark it.
While inside the special buffer, Org-mode will automatically highlight
any field or range reference at the cursor position. You may edit,
remove and add formulas, and use the following commands:
@table @kbd
@kindex C-c C-c
address@hidden C-x C-s
@item C-c C-c
-Exit the buffer and store the modified formulas. With @kbd{C-u} prefix,
-also apply the new formulas to the entire table.
address@hidden C-x C-s
+Exit the formula editor and store the modified formulas. With @kbd{C-u}
+prefix, also apply the new formulas to the entire table.
@kindex C-c C-q
@item C-c C-q
-Exit the buffer without installing changes.
+Exit the formula editor without installing changes.
address@hidden C-c C-r
address@hidden C-c C-r
+Toggle all references in the formula editor between standard (like
address@hidden) and internal (like @code{@@3$2}).
@kindex @key{TAB}
@item @key{TAB}
Pretty-print or indent lisp formula at point. When in a line containing
@@ -1671,23 +1988,25 @@
Complete Lisp symbols, just like in Emacs-lisp-mode.
@kindex address@hidden
@kindex address@hidden
address@hidden address@hidden/@key{down}
-Move the reference line in the Org-mode buffer up and down. This is
-important for highlighting the references of column formulas for
-different rows.
address@hidden address@hidden
address@hidden address@hidden
address@hidden address@hidden/@key{down}/@key{left}/@key{right}
+Shift the reference at point. For example, if the reference is
address@hidden and you press @address@hidden, it will become @code{C3}.
+This also works for relative references, and for hline references.
address@hidden address@hidden
address@hidden address@hidden
address@hidden address@hidden/@key{down}
+Move the test line for column formulas in the Org-mode buffer up and
+down.
@kindex address@hidden
@kindex address@hidden
@item address@hidden/@key{down}
Scroll the window displaying the table.
address@hidden table
@kindex C-c @}
@item C-c @}
-Toggle the display of row and column numbers for a table, using
-overlays. These are uptated each time the table is aligned, you can
-force it with @kbd{C-c C-c}.
address@hidden C-c @{
address@hidden C-c @{
-Toggle the formula debugger on and off. See below.
+Turn the coordinate grid in the table on and off.
address@hidden table
@end table
Making a table field blank does not remove the formula associated with
@@ -1708,8 +2027,8 @@
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 @code{Tbl} menu and repeat the
-calculation, for example by pressing @kbd{C-c = @key{RET}} in a field.
-Detailed information will be displayed.
+calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
+field. Detailed information will be displayed.
@node Updating the table, Advanced features, Editing and debugging formulas,
The spreadsheet
@subsection Updating the Table
@@ -1728,22 +2047,23 @@
@item C-c *
Recalculate the current row by first applying the stored column formulas
from left to right, and all field formulas in the current row.
-
address@hidden
@kindex C-u C-c *
@item C-u C-c *
@kindex C-u C-c C-c
@itemx C-u C-c C-c
Recompute the entire table, line by line. Any lines before the first
hline are left alone, assuming that these are part of the table header.
-
address@hidden
@kindex C-u C-u C-c *
address@hidden C-u C-u C-c C-c
@item C-u C-u C-c *
address@hidden C-u C-u C-c C-c
Iterate the table by recomputing it until no further changes occur.
This may be necessary if some computed fields use the value of other
fields that are computed @i{later} in the calculation sequence.
@end table
-
@node Advanced features, , Updating the table, The spreadsheet
@subsection Advanced features
@@ -1829,8 +2149,8 @@
Finally, just to whet your appetite on what can be done with the
fantastic @file{calc} package, here is a table that computes the Taylor
-series of degree @code{n} at location @code{x} for a couple of functions
-(homework: try that with Excel :-)
+series of degree @code{n} at location @code{x} for a couple of
+functions.
@example
@group
@@ -1852,18 +2172,18 @@
@chapter Hyperlinks
@cindex hyperlinks
-Just like HTML, Org-mode provides links inside a file, and external
-links to other files, Usenet articles, emails, and much more.
+Like HTML, Org-mode provides links inside a file, 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
* Handling links:: Creating, inserting and following
+* Using links outside Org-mode:: Linking from my C source code?
* Link abbreviations:: Shortcuts for writing complex links
* Search options:: Linking to a specific location
* Custom searches:: When the default search is not enough
-* Remember:: Org-trees store quick notes
@end menu
@node Link format, Internal links, Hyperlinks, Hyperlinks
@@ -1917,8 +2237,8 @@
@noindent In HTML export (@pxref{HTML export}), such targets will become
named anchors for direct access through @samp{http} address@hidden
-that text before the first headline will never be exported, so the first
-such target must be after the first headline.}.
+that text before the first headline is usually not exported, so the
+first such target should be after the first headline.}.
If no dedicated target exists, Org-mode will search for the words in the
link. In the above example the search would be for @samp{my target}.
@@ -1954,15 +2274,15 @@
@cindex targets, radio
@cindex links, 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
address@hidden<<<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
address@hidden C-c} with the cursor on or at a target.
+Org-mode can automatically turn any occurrences of certain target names
+in normal text into a link. 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 External links, Handling links, Internal links, Hyperlinks
@section External links
@@ -1971,6 +2291,7 @@
@cindex links, external
@cindex GNUS links
@cindex BBDB links
address@hidden IRC links
@cindex URL links
@cindex file links
@cindex VM links
@@ -1983,10 +2304,10 @@
@cindex elisp links
Org-mode supports links to files, websites, Usenet and email messages,
-and BBDB database entries. External links are URL-like locators. They
-start with a short identifying string followed by a colon. There can be
-no space after the colon. The following list shows examples for each
-link type.
+BBDB database entries and links to both IRC conversations and their
+logs. External links are URL-like locators. They start with a short
+identifying string followed by a colon. There can be no space after
+the colon. The following list shows examples for each link type.
@example
http://orgmode.org/ @r{on the web}
@@ -2006,6 +2327,7 @@
gnus:group @r{GNUS group link}
gnus:group#id @r{GNUS article link}
bbdb:Richard Stallman @r{BBDB link}
+irc:/irc.com/#emacs/bob @r{IRC link}
shell:ls *.org @r{A shell command}
elisp:(find-file-other-frame "Elisp.org") @r{An elisp form to evaluate}
@end example
@@ -2032,7 +2354,7 @@
@samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
about the end of the link, enclose them in angular brackets.
address@hidden Handling links, Link abbreviations, External links, Hyperlinks
address@hidden Handling links, Using links outside Org-mode, External links,
Hyperlinks
@section Handling links
@cindex links, handling
@@ -2046,19 +2368,24 @@
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
-Org-mode files, if there is a @samp{<<target>>} at the cursor, the link
-points to the target. Otherwise it points to the current headline. For
-VM, RMAIL, WANDERLUST, MH-E, GNUS and BBDB buffers, the link will
-indicate the current article/entry. For W3 and W3M buffers, the link
-goes to the current URL. 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. If the
-automatically created link is not working correctly or accurately
-enough, you can write custom functions to select the search string and
-to do the search for particular file types - see @ref{Custom searches}.
-The key binding @kbd{C-c l} is only a suggestion - see @ref{Installation}.
-
+Org-mode files, if there is a @samp{<<target>>} at the cursor, the
+link points to the target. Otherwise it points to the current
+headline. For VM, RMAIL, WANDERLUST, MH-E, GNUS and BBDB buffers, the
+link will indicate the current article/entry. For W3 and W3M buffers,
+the link goes to the current URL. For IRC links, if you set the
+variable @code{org-irc-link-to-logs} to non-nil then @kbd{C-c l} will
+store a @samp{file:/} style link to the relevant point in the logs for
+the current conversation. Otherwise an @samp{irc:/} style link to the
+user/channel/server under the point will be stored. 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. If the automatically created link is not
+working correctly or accurately enough, you can write custom functions
+to select the search string and to do the search for particular file
+types - see @ref{Custom searches}. The key binding @kbd{C-c l} is
+only a suggestion - see @ref{Installation}.
address@hidden
@kindex C-c C-l
@cindex link completion
@cindex completion, of links
@@ -2068,24 +2395,27 @@
You can just type a link, using text for an internal link, or one of the
link type prefixes mentioned in the examples above. All links stored
during the current session are part of the history for this prompt, so
-you can access them with @key{up} and @key{down}, or with
address@hidden insertion of a stored link, the link will be
-removed from the list of stored links. To keep it in the list later
-use, use a triple @kbd{C-u} prefix to @kbd{C-c C-l}, or configure the
-option @code{org-keep-stored-link-after-insertion}.}. The link will be
-inserted into the buffer, along with a descriptive text. If some text
-was selected when this command is called, the selected text becomes the
-default address@hidden 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.
-
+you can access them with @key{up} and @key{down} (or @kbd{M-p/n}).
+Completion, on the other hand, will help you to insert valid link
+prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
+defined through link abbreviations (@pxref{Link abbreviations}). The
+link will be inserted into the address@hidden insertion of a
+stored link, the link will be removed from the list of stored links. To
+keep it in the list later use, use a triple @kbd{C-u} prefix to @kbd{C-c
+C-l}, or configure the option
address@hidden, along with a descriptive
+text. If some text was selected when this command is called, the
+selected text becomes the default address@hidden 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.
address@hidden
@c If the link is a @samp{file:} link and
@c the linked file is located in the same directory as the current file or
@c a subdirectory of it, the path of the file will be inserted relative to
@c the current directory.
-
address@hidden
@kindex C-u C-c C-l
@cindex file name completion
@cindex completion, of file names
@@ -2098,11 +2428,11 @@
to the current directory using @samp{../}. Otherwise an absolute path
is used, if possible with @samp{~/} for your home directory. You can
force an absolute path with two @kbd{C-u} prefixes.
-
address@hidden C-c C-l @r{with cursor on existing link}
address@hidden
address@hidden C-c C-l @r{(with cursor on existing link)}
When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
link and description parts of the link.
-
address@hidden
@cindex following links
@kindex C-c C-o
@item C-c C-o
@@ -2118,26 +2448,26 @@
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.
-
address@hidden
@kindex mouse-2
@kindex mouse-1
@item mouse-2
@itemx mouse-1
On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
would. Under Emacs 22, also @kbd{mouse-1} will follow a link.
-
address@hidden
@kindex mouse-3
@item mouse-3
Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
internal links to be displayed in another address@hidden the
variable @code{org-display-internal-link-with-indirect-buffer}}.
-
address@hidden
@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.
-
address@hidden
@cindex links, returning to
@kindex C-c &
@item C-c &
@@ -2145,7 +2475,7 @@
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.
-
address@hidden
@kindex C-c C-x C-n
@kindex C-c C-x C-p
@cindex links, finding next/previous
@@ -2163,7 +2493,20 @@
@end lisp
@end table
address@hidden Link abbreviations, Search options, Handling links, Hyperlinks
address@hidden Using links outside Org-mode, Link abbreviations, Handling
links, Hyperlinks
address@hidden Using links outside Org-mode
+
+You can insert and follow links that have Org-mode syntax not only in
+Org-mode, but in any Emacs buffer. For this, you should create two
+global commands, like this (please select suitable global keys
+yourself):
+
address@hidden
+(global-set-key "\C-c L" 'org-insert-link-global)
+(global-set-key "\C-c o" 'org-open-at-point-global)
address@hidden lisp
+
address@hidden Link abbreviations, Search options, Using links outside
Org-mode, Hyperlinks
@section Link abbreviations
@cindex link abbreviations
@cindex abbreviation, links
@@ -2262,7 +2605,7 @@
a search for @samp{find me} in the current file, just as
@samp{[[find me]]} would.
address@hidden Custom searches, Remember, Search options, Hyperlinks
address@hidden Custom searches, , Search options, Hyperlinks
@section Custom Searches
@cindex custom search strings
@cindex search strings, custom
@@ -2286,384 +2629,450 @@
file.
address@hidden Remember, , Custom searches, Hyperlinks
address@hidden Remember
address@hidden @file{remember.el}
-Another way to create org entries with links to other files is through
-the @i{remember} package by John Wiegley. @i{Remember} lets you store
-quick notes with little interruption of your work flow. See
address@hidden://www.emacswiki.org/cgi-bin/wiki/RememberMode} for more
-information. The notes produced by @i{Remember} can be stored in
-different ways, and Org-mode files are a good target. Org-mode
-significantly expands the possibilities of @i{remember}: You may define
-templates for different note types, and to associate target files and
-headlines with specific templates. It also allows you to select the
-location where a note should be stored interactively, on the fly.
address@hidden TODO items, Tags, Hyperlinks, Top
address@hidden TODO items
address@hidden TODO items
+
+Org-mode does not maintain TODO lists as separate documents. Instead,
+TODO items are an integral part of the notes file, because TODO items
+usually come up while taking notes! With Org-mode, simply mark any
+entry in a tree as being a TODO item. In this way, information is not
+duplicated, and the entire context from which the TODO item emerged is
+always present.
+
+Of course, this technique for managing TODO items scatters them
+throughout your notes file. Org-mode compensates for this by providing
+methods to give you an overview of all the things that you have to do.
@menu
-* Setting up remember:: Some code for .emacs to get things going
-* Remember templates:: Define the outline of different note types
-* Storing notes:: Directly get the note to where it belongs
+* TODO basics:: Marking and displaying TODO entries
+* TODO extensions:: Workflow and assignments
+* Progress logging:: Dates and notes for progress
+* Priorities:: Some things are more important than others
+* Breaking down tasks:: Splitting a task into manageable pieces
+* Checkboxes:: Tick-off lists
@end menu
address@hidden Setting up remember, Remember templates, Remember, Remember
address@hidden Setting up remember
address@hidden TODO basics, TODO extensions, TODO items, TODO items
address@hidden Basic TODO functionality
-The following customization will tell @i{remember} to use org files as
-target, and to create annotations compatible with Org-mode links.
+Any headline becomes a TODO item when it starts with the word
address@hidden, for example:
@example
-(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)
+*** TODO Write letter to Sam Fortune
@end example
address@hidden Remember templates, Storing notes, Setting up remember, Remember
address@hidden Remember templates
address@hidden templates, for remember
address@hidden
+The most important commands to work with TODO entries are:
-In combination with Org-mode, you can use templates to generate
-different types of @i{remember} notes. For example, if you would like
-to use one template to create general TODO entries, another one for
-journal entries, and a third one for collecting random ideas, you could
-use:
address@hidden @kbd
address@hidden C-c C-t
address@hidden cycling, of TODO states
address@hidden C-c C-t
+Rotate the TODO state of the current item among
@example
-(setq org-remember-templates
- '((?t "* TODO %?\n %i\n %a" "~/org/TODO.org")
- (?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org")
- (?i "* address@hidden@}\n %i\n %a" "~/org/JOURNAL.org" "New Ideas")))
+,-> (unmarked) -> TODO -> DONE --.
+'--------------------------------'
@end example
address@hidden In these entries, the character specifies how to select the
-template. The first string specifies the template. Two more (optional)
-strings give the file in which, and the headline under which the new
-note should be stored. The file defaults to
address@hidden, the heading to
address@hidden Both defaults help to get to the
-storing location quickly, but you can change the location interactively
-while storing the note.
+The same rotation can also be done ``remotely'' from the timeline and
+agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}).
-When you call @kbd{M-x remember} (or @kbd{M-x org-remember}) to remember
-something, org will prompt for a key to select the template (if you have
-more than one template) and then prepare the buffer like
address@hidden
-* TODO
- [[file:link to where you called remember]]
address@hidden example
address@hidden C-u C-c C-t
address@hidden C-u C-c C-t
+Select a specific keyword using completion or (if it has been set up)
+the fast selection interface. For the latter, you need to assign keys
+to TODO states, see @ref{Per-file keywords} and @ref{Setting tags} for
+more information.
address@hidden or
address@hidden address@hidden
address@hidden address@hidden
address@hidden address@hidden
address@hidden address@hidden
+Select the following/preceding TODO state, similar to cycling. Useful
+mostly if more than two TODO states are possible (@pxref{TODO
+extensions}).
address@hidden C-c C-v
address@hidden C-c / t
address@hidden sparse tree, for TODO
address@hidden C-c C-v
address@hidden C-c / t
+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, search for a specific TODO. You will be
+prompted for the keyword, and you can also give a list of keywords like
address@hidden|KWD2|...}. With numerical prefix N, show the tree for the
+Nth keyword in the variable @code{org-todo-keywords}. With two prefix
+args, find all TODO and DONE entries.
address@hidden C-c a t
address@hidden C-c a t
+Show the global TODO list. Collects the TODO items from all agenda
+files (@pxref{Agenda views}) into a single buffer. The new buffer will
+be in @code{agenda-mode}, which provides commands to examine and
+manipulate the TODO entries from the new buffer (@pxref{Agenda
+commands}). @xref{Global TODO list}, for more information.
address@hidden address@hidden
address@hidden address@hidden
+Insert a new TODO entry below the current one.
address@hidden table
address@hidden
-* [2006-03-21 Tue 15:37]
address@hidden TODO extensions, Progress logging, TODO basics, TODO items
address@hidden Extended use of TODO keywords
address@hidden extended TODO keywords
- [[file:link to where you called remember]]
address@hidden example
+By default, marked TODO entries have one of only two states: TODO and
+DONE. Org-mode allows you to classify TODO items in more complex ways
+with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With
+special setup, the TODO keyword system can work differently in different
+files.
address@hidden
-During expansion of the template, special @kbd{%}-escapes allow dynamic
-insertion of content:
address@hidden
address@hidden@} @r{prompt the user for a string and replace this sequence
with it.}
-%t @r{time stamp, date only}
-%T @r{time stamp with date and time}
-%u, %U @r{like the above, but inactive time stamps}
-%^t @r{like @code{%t}, but prompt for date. Similarly @code{%^T},
@code{%^u}, @code{%^U}}
- @r{You may define a prompt like @address@hidden@}t}}
-%n @r{user name (taken from @code{user-full-name})}
-%a @r{annotation, normally the link created with
@code{org-store-link}}
-%i @r{initial content, the region when remember is called with C-u.}
- @r{The entire text will be indented like @code{%i} itself.}
-%:keyword @r{specific information for certain link types, see below}
address@hidden example
+Note that @i{tags} are another way to classify headlines in general and
+TODO items in particular (@pxref{Tags}).
address@hidden
-For specific link types, the following keywords will be defined:
address@hidden
+* Workflow states:: From TODO to DONE in steps
+* TODO types:: I do this, Fred does the rest
+* Multiple sets in one file:: Mixing it all, and still finding your way
+* Fast access to TODO states:: Single letter selection of a state
+* Per-file keywords:: Different files, different requirements
+* Faces for TODO keywords:: Highlighting states
address@hidden menu
address@hidden
-Link type | Available keywords
--------------------+----------------------------------------------
-bbdb | %:name %:company
-vm, wl, mh, rmail | %:type %:subject %:message-id
- | %:from %:fromname %:fromaddress
- | %:to %:toname %:toaddress
- | %:fromto @r{(either "to NAME" or "from
NAME")@footnote{This will always be the other, not the user. See the variable
@code{org-from-is-user-regexp}.}}
-gnus | %:group, @r{for messages also all email fields}
-w3, w3m | %:url
-info | %:file %:node
-calendar | %:date"
address@hidden example
address@hidden Workflow states, TODO types, TODO extensions, TODO extensions
address@hidden TODO keywords as workflow states
address@hidden TODO workflow
address@hidden workflow states as TODO keywords
address@hidden
-If you would like to have the cursor in a specific position after the
-template has been expanded:
+You can use TODO keywords to indicate different @emph{sequential} states
+in the process of working on an item, for address@hidden
+this variable only becomes effective after restarting Org-mode in a
+buffer.}:
address@hidden
-%? @r{After completing the template, position cursor here.}
address@hidden example
address@hidden
+(setq org-todo-keywords
+ '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
address@hidden lisp
address@hidden
-If you change you mind about which template to use, call
address@hidden in the remember buffer. You may then select a new
-template that will be filled with the previoous context information.
+The vertical bar separates the TODO keywords (states that @emph{need
+action}) from the DONE states (which need @emph{no further action}. If
+you don't provide the separator bar, the last state is used as the DONE
+state.
address@hidden completion, of TODO keywords
+With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
+to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED. 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.
+Or you can use @kbd{S-left} to go backward through the sequence. If you
+define many keywords, you can use in-buffer completion
+(@pxref{Completion}) or even a special one-key selection scheme
+(@pxref{Fast access to TODO states}) to insert these words into the
+buffer. Changing a todo state can be logged with a timestamp, see
address@hidden TODO state changes} for more information.
address@hidden Storing notes, , Remember templates, Remember
address@hidden Storing notes
address@hidden TODO types, Multiple sets in one file, Workflow states, TODO
extensions
address@hidden TODO keywords as types
address@hidden TODO types
address@hidden names as TODO keywords
address@hidden types as TODO keywords
-When you are finished preparing a note with @i{remember}, you have to press
address@hidden C-c} to file the note away. The handler first prompts for a
-target file - if you press @key{RET}, the value specified for the
-template is used. Then the command offers the headings tree of the
-selected file, with the cursor position at the default headline (if you
-had specified one in the template). You can either immediately press
address@hidden to get the note placed there. 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}
-then leads to the following result.
+The second possibility is to use TODO keywords to indicate different
address@hidden of action items. For example, you might want to indicate
+that items are for ``work'' or ``home''. Or, when you work with several
+people on a single project, you might want to assign action items
+directly to persons, by using their names as TODO keywords. This would
+be set up like this:
address@hidden @columnfractions 0.2 0.1 0.7
address@hidden @b{Cursor position} @tab @b{Key} @tab @b{Note gets inserted}
address@hidden buffer-start @tab @key{RET} @tab as level 2 heading at end of
file
address@hidden on headline @tab @key{RET} @tab as sublevel of the heading at
cursor
address@hidden @tab @key{left} @tab as same level, before current
heading
address@hidden @tab @key{right} @tab as same level, after current
heading
address@hidden not on headline @tab @key{RET}
- @tab at cursor position, level taken from context.
- Or use prefix arg to specify level manually.
address@hidden multitable
address@hidden
+(setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
address@hidden lisp
-So a fast way to store the note to its default location is to press
address@hidden C-c @key{RET} @key{RET}}. Even shorter would be @kbd{C-u C-c
-C-c}, which does the same without even asking for a file or showing the
-tree.
+In this case, different keywords do not indicate a sequence, but rather
+different types. So the normal work flow would be to assign a task to a
+person, and later to mark it DONE. Org-mode supports this style by
+adapting the workings of the command @kbd{C-c address@hidden 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,
+in order to first select the right type for a task. But when you return
+to the item after some time and execute @kbd{C-c C-t} again, it will
+switch from any 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}.
+
address@hidden Multiple sets in one file, Fast access to TODO states, TODO
types, TODO extensions
address@hidden Multiple keyword sets in one file
address@hidden todo keyword sets
+
+Sometimes you may want to use different sets of TODO keywords in
+parallel. For example, you may want to have the basic
address@hidden/@code{DONE}, but also a workflow for bug fixing, and a
+separate state indicating that an item has been canceled (so it is not
+DONE, but also does not require action). Your setup would then look
+like this:
-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).
address@hidden
+(setq org-todo-keywords
+ '((sequence "TODO" "|" "DONE")
+ (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
+ (sequence "|" "CANCELED")))
address@hidden lisp
+The keywords should all be different, this helps Org-mode to keep track
+of which subsequence should be used for a given entry. In this setup,
address@hidden C-t} only operates within a subsequence, so it switches from
address@hidden to (nothing) to @code{TODO}, and from @code{FIXED} to
+(nothing) to @code{REPORT}. Therefore you need a mechanism to initially
+select the correct sequence. Besides the obvious ways like typing a
+keyword or using completion, you may also apply the following commands:
+
address@hidden @kbd
address@hidden address@hidden
address@hidden address@hidden
address@hidden address@hidden
address@hidden address@hidden
+These keys jump from one TODO subset to the next. In the above example,
address@hidden@key{right}} would jump from @code{TODO} or @code{DONE} to
address@hidden, and any of the words in the second row to @code{CANCELED}.
address@hidden address@hidden
address@hidden address@hidden
address@hidden address@hidden
address@hidden address@hidden
address@hidden@key{<left>}} and @address@hidden<right>}} and walk through
address@hidden keywords from all sets, so for example @address@hidden<right>}}
+would switch from @code{DONE} to @code{REPORT} in the example above.
address@hidden table
address@hidden TODO items, Timestamps, Hyperlinks, Top
address@hidden TODO items
address@hidden TODO items
address@hidden Fast access to TODO states, Per-file keywords, Multiple sets in
one file, TODO extensions
address@hidden Fast access to TODO states
+
+If you would like to quickly change an entry to an arbitrary TODO state
+instead of cycling through the states, you can set up keys for
+single-letter access to the states. This is done by adding the section
+key after each keyword, in parenthesis. For example:
-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.
address@hidden
+(setq org-todo-keywords
+ '((sequence "TODO(t)" "|" "DONE(d)")
+ (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
+ (sequence "|" "CANCELED(c)")))
address@hidden lisp
address@hidden
-* TODO basics:: Marking and displaying TODO entries
-* TODO extensions:: Workflow and assignments
-* Priorities:: Some things are more important than others
-* Breaking down tasks:: Splitting a task into managable pieces
-* Checkboxes:: Tick-off lists
address@hidden menu
+If you then press @code{C-u C-c C-t} followed by the selection key, the
+entry will be switched to this state. @key{SPC} can be used to remove
+any TODO keyword from an entry. Should you like this way of selecting
+TODO states a lot, you might want to set the variable
address@hidden to @code{t} and make this behavior
+the default. Check also the variable
address@hidden, it allows to change the TODO
+state through the tags interface (@pxref{Setting tags}), in case you
+like to mingle the two concepts.
address@hidden TODO basics, TODO extensions, TODO items, TODO items
address@hidden Basic TODO functionality
address@hidden Per-file keywords, Faces for TODO keywords, Fast access to TODO
states, TODO extensions
address@hidden Setting up keywords for individual files
address@hidden keyword options
address@hidden per-file keywords
-Any headline can become a TODO item by starting it with the word TODO,
-for example:
+It can be very useful to use different aspects of the TODO mechanism in
+different files. 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
-*** TODO Write letter to Sam Fortune
+#+SEQ_TODO: TODO FEEDBACK VERIFY | DONE CANCELED
address@hidden example
+or
address@hidden
+#+TYP_TODO: Fred Sara Lucy Mike | DONE
@end example
address@hidden
-The most important commands to work with TODO entries are:
-
address@hidden @kbd
address@hidden C-c C-t
address@hidden cycling, of TODO states
address@hidden C-c C-t
-Rotate the TODO state of the current item between
+A setup for using several sets in parallel would be:
@example
-,-> (unmarked) -> TODO -> DONE --.
-'--------------------------------'
+#+SEQ_TODO: TODO | DONE
+#+SEQ_TODO: REPORT BUG KNOWNCAUSE | FIXED
+#+SEQ_TODO: | CANCELED
@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}).
address@hidden address@hidden
address@hidden address@hidden
address@hidden address@hidden
address@hidden address@hidden
-Select the following/preceding TODO state, similar to cycling. Mostly
-useful if more than two TODO states are possible (@pxref{TODO extensions}).
address@hidden C-c C-v
address@hidden sparse tree, for TODO
address@hidden 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
address@hidden
address@hidden C-c a t
address@hidden 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
address@hidden, so there are commands to examine and manipulate
-the TODO entries directly from that buffer (@pxref{Agenda commands}).
address@hidden TODO list}, for more information.
address@hidden @item @code{org-agenda-include-all-todo}
address@hidden If you would like to have all your TODO items listed as part of
your
address@hidden agenda, customize the variable
@code{org-agenda-include-all-todo}.
address@hidden table
address@hidden completion, of option keywords
address@hidden address@hidden
address@hidden To make sure you are using the correct keyword, type
address@hidden into the buffer and then use @address@hidden completion.
address@hidden DONE, final TODO keyword
+Remember that the keywords after the vertical bar (or the last keyword
+if no bar is there) must always mean that the item is DONE (although you
+may use a different word). After changing one of these lines, use
address@hidden C-c} with the cursor still in the line to make the changes
+known to address@hidden 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
+for the current buffer.}.
+
address@hidden Faces for TODO keywords, , Per-file keywords, TODO extensions
address@hidden Faces for TODO keywords
address@hidden faces, for TODO keywords
+
+Org-mode highlights TODO keywords with special faces: @code{org-todo}
+for keywords indicating that an item still has to be acted upon, and
address@hidden for keywords indicating that an item is finished. If
+you are using more than 2 different states, you might want to use
+special faces for some of them. This can be done using the variable
address@hidden For example:
address@hidden TODO extensions, Priorities, TODO basics, TODO items
address@hidden Extended use of TODO keywords
address@hidden extended TODO keywords
address@hidden
+(setq org-todo-keyword-faces
+ '(("TODO" . org-warning)
+ ("DEFERRED" . shadow)
+ ("CANCELED" . (:foreground "blue" :weight bold))))
address@hidden lisp
-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
address@hidden Using special setup, you can even use
-TODO keywords in different ways in different org files.
+While using a list with face properties as shown for CANCELED
address@hidden work, this does not aways seem to be the case. If
+necessary, define a special face and use that.
-Note that @i{tags} are another way to classify headlines in general and
-TODO items in particular (@pxref{Tags}).
address@hidden
address@hidden Progress logging, Priorities, TODO extensions, TODO items
address@hidden Progress Logging
address@hidden progress logging
address@hidden logging, of progress
+
+Org-mode can automatically record a time stamp and possibly a note when
+you mark a TODO item as DONE, or even each time you change the state of
+a TODO item. This system is highly configurable, settings can be on a
+per-keyword basis and can be localized to a file or even a subtree. For
+information on how to clock working time for a task, see @ref{Clocking
+work time}.
@menu
-* Workflow states:: From TODO to DONE in steps
-* TODO types:: I do this, Fred the rest
-* Per file keywords:: Different files, different requirements
+* Closing items:: When was this entry marked DONE?
+* Tracking TODO state changes:: When did the status change?
@end menu
address@hidden Workflow states, TODO types, TODO extensions, TODO extensions
address@hidden TODO keywords as workflow states
address@hidden TODO workflow
address@hidden workflow states as TODO keywords
address@hidden Closing items, Tracking TODO state changes, Progress logging,
Progress logging
address@hidden Closing items
-You can use TODO keywords to indicate different states in the process
-of working on an item, for example:
+The most basic logging is to keep track of @emph{when} a certain TODO
+item was finished. This is achieved address@hidden corresponding
+in-buffer setting is: @code{#+STARTUP: logdone}}.
@lisp
-(setq org-todo-keywords '("TODO" "FEEDBACK" "VERIFY" "DONE")
- org-todo-interpretation 'sequence)
+(setq org-log-done 'time)
@end lisp
address@hidden completion, of TODO keywords
-Changing these variables only becomes 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
address@hidden C-c C-t} will change the state immediately to VERIFY.
-If you define many keywords, you can use in-buffer completion (see
address@hidden) to insert these words into the buffer. Changing a todo
-state can be logged with a timestamp, see @ref{Tracking TODO state
-changes} for more information.
address@hidden
+Then each time you turn an entry from a TODO (not-done) state into any
+of the DONE states, a line @samp{CLOSED: [timestamp]} will be inserted
+just after the headline. If you turn the entry back into a TODO item
+through further state cycling, that line will be removed again. If you
+want to record a note along with the timestamp, address@hidden
+corresponding in-buffer setting is: @code{#+STARTUP: lognotedone}}
address@hidden TODO types, Per file keywords, Workflow states, TODO extensions
address@hidden TODO keywords as types
address@hidden TODO types
address@hidden names as TODO keywords
address@hidden types as TODO keywords
address@hidden
+(setq org-log-done 'note)
address@hidden lisp
-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
address@hidden Things DONE}, you might want to use todo types
address@hidden, @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:
-
address@hidden
-(setq org-todo-keywords '("Fred" "Sara" "Lucy" "Mike" "DONE")
- org-todo-interpretation 'type)
address@hidden 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 address@hidden 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
address@hidden 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:
address@hidden C-c t}.
address@hidden
+You will then be prompted for a note, and that note will be stored below
+the entry with a @samp{Closing Note} heading.
address@hidden Per file keywords, , TODO types, TODO extensions
address@hidden Setting up TODO keywords for individual files
address@hidden keyword options
address@hidden per file keywords
+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 with a @samp{CLOSED} timestamp on each day,
+giving you an overview of what has been done.
-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:
address@hidden Tracking TODO state changes, , Closing items, Progress logging
address@hidden Tracking TODO state changes
address@hidden
-#+SEQ_TODO: TODO FEEDBACK VERIFY DONE
-#+TYP_TODO: Fred Sara Lucy Mike DONE
address@hidden example
+When TODO keywords are used as workflow states (@pxref{Workflow
+states}), you might want to keep track of when a state change occurred
+and maybe take a note about this change. Since it is normally too much
+to record a note for every state, Org-mode expects configuration on a
+per-keyword basis for this. This is achieved by adding special markers
address@hidden (for a time stamp) and @samp{@@} (for a note) in parenthesis
+after each keyword. For example, with the setting
address@hidden completion, of option keywords
address@hidden address@hidden
address@hidden To make sure you are using the correct keyword, type
address@hidden into the buffer and then use @address@hidden completion.
address@hidden
+(setq org-todo-keywords
+ '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
address@hidden lisp
address@hidden DONE, final TODO keyword
-Remember that the last keyword must always mean that the item is DONE
-(although you may use a different word). 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 address@hidden
-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 for the current buffer.}.
-
-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:
-
address@hidden
-#+TYP_TODO: Fred Sara Lucy Mike
-#+TYP_TODO: Luis George Jules Jessica
-#+TYP_TODO: Kim Arnold Peter
-#+TYP_TODO: DONE
address@hidden
+you not only define global TODO keywords and fast access keys, but also
+request that a time is recorded when the entry is turned into
address@hidden is possible that Org-mode will record two time stamps
+when you are using both @code{org-log-done} and state change logging.
+However, it will never prompt for two notes - if you have configured
+both, the state change recording note will take precedence and cancel
+the @samp{Closing Note}.}, and that a note is recorded when switching to
+WAIT or CANCELED. The setting for WAIT is even more special: The
address@hidden after the slash means that in addition to the note taken when
+entering the state, a time stamp should be recorded when @i{leaving} the
+WAIT state, if and only if the @i{target} state does not configure
+logging for entering it. So it has no effect when switching from WAIT
+to DONE, because DONE is configured to record a timestamp only. But
+when switching from WAIT back to TODO, the @samp{/!} in the WAIT
+setting now triggers a timestamp even though TODO has no logging
+configured.
+
+You can use the exact same syntax for setting logging preferences local
+to a buffer:
address@hidden
+#+SEQ_TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
address@hidden example
+
+In order to define logging settings that are local to a subtree or a
+single item, define a LOGGING property in this entry. Any non-empty
+LOGGING property resets all logging settings to nil. You may then turn
+on logging for this specific tree using STARTUP keywords like
address@hidden or @code{logrepeat}, as well as adding state specific
+settings like @code{TODO(!)}. For example
+
address@hidden
+* TODO Log each state with only a time
+ :PROPERTIES:
+ :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
+ :END:
+* TODO Only log when switching to WAIT, and when repeating
+ :PROPERTIES:
+ :LOGGING: WAIT(@@) logrepeat
+ :END:
+* TODO No logging at all
+ :PROPERTIES:
+ :LOGGING: nil
+ :END:
@end example
address@hidden Priorities, Breaking down tasks, TODO extensions, TODO items
+
address@hidden Priorities, Breaking down tasks, Progress logging, 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
+If you use Org-mode extensively, you may end up enough TODO items that
+it starts to make sense to prioritize them. Prioritizing can be done by
+placing a @emph{priority cookie} into the headline of a TODO item, like
+this
@example
*** TODO [#A] Write letter to Sam Fortune
@end example
@noindent
-With its standard setup, Org-mode supports priorities @samp{A},
address@hidden, 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}).
+By default, Org-mode supports three priorities: @samp{A}, @samp{B}, and
address@hidden @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}); outside the agenda, they have
+no inherent meaning to Org-mode.
+
+Priorities can be attached to any outline tree entries; they do not need
+to be TODO items.
@table @kbd
@kindex @kbd{C-c ,}
@@ -2673,21 +3082,33 @@
@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}).
-
address@hidden
@kindex address@hidden
@kindex address@hidden
@item address@hidden
@itemx address@hidden
-Increase/decrease priority of current headline. Note that these keys
-are also used to modify time stamps (@pxref{Creating timestamps}).
+Increase/decrease priority of current address@hidden also the
+option @code{org-priority-start-cycle-with-default'}.}. Note that these
+keys are also used to modify time stamps (@pxref{Creating timestamps}).
Furthermore, these keys are also used by CUA-mode (@pxref{Conflicts}).
@end table
+You can change the range of allowed priorities by setting the variables
address@hidden, @code{org-lowest-priority}, and
address@hidden For an individual buffer, you may set
+these values (highest, lowest, default) like this (please make sure that
+the highest priority is earlier in the alphabet than the lowest
+priority):
+
address@hidden
+#+PRIORITIES: A C B
address@hidden example
+
@node Breaking down tasks, Checkboxes, Priorities, TODO items
@section Breaking tasks down into subtasks
@cindex tasks, breaking down
-It is often advisable to break down large tasks into smaller, managable
+It is often advisable to break down large tasks into smaller, manageable
subtasks. You can do this by creating an outline tree below a TODO
item, with detailed subtasks on the address@hidden keep subtasks out
of the global TODO list, see the
@@ -2700,17 +3121,19 @@
@section Checkboxes
@cindex checkboxes
-Every item in a plain list (@pxref{Plain lists}) can be made a checkbox
-by starting it with the string @samp{[ ]}. This feature is similar to
-TODO items (@pxref{TODO items}), but more lightweight. Checkboxes are
-not included into the global TODO list, so they are often great to split
-a task into a number of simple steps. Or you can use them in a shopping
-list. To toggle a checkbox, use @kbd{C-c C-c}, or try Piotr Zielinski's
address@hidden Here is an example of a checkbox list.
+Every item in a plain list (@pxref{Plain lists}) can be made into a
+checkbox by starting it with the string @samp{[ ]}. This feature is
+similar to TODO items (@pxref{TODO items}), but is more lightweight.
+Checkboxes are not included into the global TODO list, so they are often
+great to split a task into a number of simple steps. Or you can use
+them in a shopping list. To toggle a checkbox, use @kbd{C-c C-c}, or
+use the mouse (thanks to Piotr Zielinski's @file{org-mouse.el}).
+
+Here is an example of a checkbox list.
@example
-* TODO Organize party [3/6]
- - call people [1/3]
+* TODO Organize party [2/4]
+ - [-] call people [1/3]
- [ ] Peter
- [X] Sarah
- [ ] Sam
@@ -2719,26 +3142,33 @@
- [X] talk to the neighbors
@end example
+Checkboxes work hierarchically, so if a checkbox item has children that
+are checkboxes, toggling one of the children checkboxes will make the
+parent checkbox reflect if none, some, or all of the children are
+checked.
+
@cindex statistics, for checkboxes
@cindex checkbox statistics
-The @samp{[3/6]} and @samp{[1/3]} in the first and second line are
-cookies indicating how many checkboxes are present in this entry, and
-how many of them have been checked off. This can give you an idea on
-how many checkboxes remain, even without opening a folded entry. The
-cookies can be placed into a headline or into (the first line of) a
-plain list item. Each cookie covers all checkboxes structurally below
-that headline/item. You have to insert the cookie yourself by typing
-either @samp{[/]} or @samp{[%]}. In the first case you get an @samp{n
-out of m} result, in the second case you get information about the
+The @samp{[2/4]} and @samp{[1/3]} in the first and second line are
+cookies indicating how many checkboxes present in this entry have been
+checked off, and the total number of checkboxes are present. This can
+give you an idea on how many checkboxes remain, even without opening a
+folded entry. The cookies can be placed into a headline or into (the
+first line of) a plain list item. Each cookie covers all checkboxes
+structurally below the headline/item on which the cookie appear. You
+have to insert the cookie yourself by typing either @samp{[/]} or
address@hidden With @samp{[/]} you get an @samp{n out of m} result, as in
+the examples above. With @samp{[%]} you get information about the
percentage of checkboxes checked (in the above example, this would be
address@hidden and @samp{[33%], respectively}).
address@hidden and @samp{[33%]}, respectively).
@noindent The following commands work with checkboxes:
@table @kbd
@kindex C-c C-c
@item C-c C-c
-Toggle checkbox at point.
+Toggle checkbox at point. With prefix argument, set it to @samp{[-]},
+which is considered to be an intermediate state.
@kindex C-c C-x C-b
@item C-c C-x C-b
Toggle checkbox at point.
@@ -2769,24 +3199,770 @@
back into synch. Or simply toggle any checkbox twice with @kbd{C-c C-c}.
@end table
address@hidden Timestamps, Tags, TODO items, Top
address@hidden Timestamps
address@hidden Tags, Properties and columns, TODO items, Top
address@hidden Tags
address@hidden tags
address@hidden headline tagging
address@hidden matching, tags
address@hidden sparse tree, tag based
+
+An excellent way to implement labels and contexts for cross-correlating
+information is to assign @i{tags} to headlines. Org-mode has extensive
+support for tags.
+
+Every headline can contain a list of tags; they occur 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,
+e.g., @samp{:WORK:}. Several tags can be specified, as in
address@hidden:work:URGENT:}.
+
address@hidden
+* 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
address@hidden menu
+
address@hidden Tag inheritance, Setting tags, Tags, Tags
address@hidden Tag inheritance
address@hidden tag inheritance
address@hidden inheritance, of tags
address@hidden sublevels, inclusion into tags match
+
address@hidden 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
+
address@hidden
+* Meeting with the French group :work:
+** Summary by Frank :boss:notes:
+*** TODO Prepare slides for him :action:
address@hidden example
+
address@hidden
+the final heading will have the tags @samp{:work:}, @samp{:boss:},
address@hidden:notes:}, and @samp{:action:} even though the final heading is not
+explicitly marked with those tags. 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 also match and
+that the list of matches could become very long because of that. If you
+do want the subevels be tested and listed as well, you may set the
+variable @code{org-tags-match-list-sublevels}. To turn off tag
+inheritance entirely, use the variable @code{org-use-tag-inheritance}.
+
address@hidden Setting tags, Tag searches, Tag inheritance, Tags
address@hidden Setting tags
address@hidden setting tags
address@hidden tags, setting
+
address@hidden address@hidden
+Tags can simply be typed into the buffer at the end of a headline.
+After a colon, @address@hidden offers completion on tags. There is
+also a special command for inserting tags:
+
address@hidden @kbd
address@hidden C-c C-c
address@hidden C-c C-c
address@hidden completion, of tags
+Enter new tags for the current headline. Org-mode will either offer
+completion or a special single-key interface for setting tags, see
+below. 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}).
address@hidden table
+
+Org will support tag insertion based on a @emph{list of tags}. By
+default this list is constructed dynamically, containing all tags
+currently used in the buffer. You may also globally specify a hard list
+of tags with the variable @code{org-tag-alist}. Finally you can set
+the default tags for a given file with lines like
+
address@hidden
+#+TAGS: @@work @@home @@tennisclub
+#+TAGS: laptop car pc sailboat
address@hidden example
+
+If you have globally defined your preferred set of tags using the
+variable @code{org-tag-alist}, but would like to use a dynamic tag list
+in a specific file, add an empty TAGS option line to that file:
+
address@hidden
+#+TAGS:
address@hidden example
+
+The default support method for entering tags is minibuffer completion.
+However, Org-mode also implements a much better method: @emph{fast tag
+selection}. This method allows to select and deselect tags with a
+single key per tag. To function efficiently, you should assign unique
+keys to most tags. This can be done globally with
+
address@hidden
+(setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
address@hidden lisp
+
address@hidden or on a per-file basis with
+
address@hidden
+#+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p)
address@hidden example
+
address@hidden
+You can also group together tags that are mutually exclusive. With
+curly address@hidden @code{org-mode-alist} use
address@hidden'(:startgroup)} and @code{'(:endgroup)}, respectively. Several
+groups are allowed.}
+
address@hidden
+#+TAGS: @{ @@work(w) @@home(h) @@tennisclub(t) @} laptop(l) pc(p)
address@hidden example
+
address@hidden you indicate that at most one of @samp{@@work}, @samp{@@home},
+and @samp{@@tennisclub} should be selected.
+
address@hidden Don't forget to press @kbd{C-c C-c} with the cursor in one of
+these lines to activate any changes.
+
+If at least one tag has a selection key, pressing @kbd{C-c C-c} will
+automatically present you with a special interface, listing inherited
+tags, the tags of the current headline, and a list of all valid tags
+with corresponding address@hidden will automatically be assigned to
+tags which have no configured keys.}. In this interface, you can use
+the following keys:
+
address@hidden @kbd
address@hidden a-z...
+Pressing keys assigned to tags will add or remove them from the list of
+tags in the current line. Selecting a tag in a group of mutually
+exclusive tags will turn off any other tags from that group.
address@hidden @key{TAB}
address@hidden @key{TAB}
+Enter a tag in the minibuffer, even if the tag is not in the predefined
+list. You will be able to complete on all tags present in the buffer.
address@hidden @key{SPC}
address@hidden @key{SPC}
+Clear all tags for this line.
address@hidden @key{RET}
address@hidden @key{RET}
+Accept the modified set.
address@hidden C-g
+Abort without installing changes.
address@hidden q
+If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
address@hidden !
+Turn off groups of mutually exclusive tags. Use this to (as an
+exception) assign several tags from such a group.
address@hidden C-c
+Toggle auto-exit after the next change (see below).
+If you are using expert mode, the first @kbd{C-c} will display the
+selection window.
address@hidden table
+
address@hidden
+This method lets you assign tags to a headline with very few keys. With
+the above setup, you could clear the current tags and set @samp{@@home},
address@hidden and @samp{pc} tags with just the following keys: @kbd{C-c
+C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@home} to
address@hidden@@work} would be done with @kbd{C-c C-c w @key{RET}} or
+alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag
address@hidden could be done with @kbd{C-c C-c @key{TAB} S a r a h
address@hidden @key{RET}}.
+
+If you find that most of the time, you need only a single keypress to
+modify your list of tags, set the variable
address@hidden Then you no longer have to
+press @key{RET} to exit fast tag selection - it will immediately exit
+after the first change. If you then occasionally need more keys, press
address@hidden to turn off auto-exit for the current tag selection process
+(in effect: start selection with @kbd{C-c C-c C-c} instead of @kbd{C-c
+C-c}). If you set the variable to the value @code{expert}, the special
+window is not even shown for single-key tag selection, it comes up only
+when you press an extra @kbd{C-c}.
+
address@hidden Tag searches, , Setting tags, Tags
address@hidden Tag searches
address@hidden tag searches
address@hidden searching for tags
+
+Once a system of tags has been set up, it can be used to collect related
+information into special lists.
+
address@hidden @kbd
address@hidden C-c \
address@hidden C-c / T
address@hidden C-c \
address@hidden C-c / T
+Create a sparse tree with all headlines matching a tags search. With a
address@hidden prefix argument, ignore headlines that are not a TODO line.
address@hidden C-c a m
address@hidden C-c a m
+Create a global list of tag matches from all agenda files.
address@hidden tags and properties}.
address@hidden C-c a M
address@hidden 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
address@hidden).
address@hidden table
+
address@hidden Boolean logic, for tag searches
+A @i{tags} search string can use Boolean operators @samp{&} for AND and
address@hidden|} 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. Examples:
+
address@hidden @samp
address@hidden +work-boss
+Select headlines tagged @samp{:work:}, but discard those also tagged
address@hidden:boss:}.
address@hidden work|laptop
+Selects lines tagged @samp{:work:} or @samp{:laptop:}.
address@hidden work|laptop&night
+Like before, but require the @samp{:laptop:} lines to be tagged also
address@hidden:night:}.
address@hidden table
+
address@hidden TODO keyword matching, with tags search
+If you are using multi-state TODO keywords (@pxref{TODO extensions}), it
+can be useful to also match on the TODO keyword. This can be done by
+adding a condition after a slash to a tags match. The syntax is similar
+to the tag matches, but should be applied with consideration: For
+example, a positive selection on several TODO keywords can not
+meaningfully be combined with boolean AND. However, @emph{negative
+selection} combined with AND can be meaningful. To make sure that only
+lines are checked that actually have any TODO keyword, use @kbd{C-c a
+M}, or equivalently start the todo part after the slash with @samp{!}.
+Examples:
+
address@hidden @samp
address@hidden work/WAITING
+Select @samp{:work:}-tagged TODO lines with the specific TODO
+keyword @samp{WAITING}.
address@hidden work/!-WAITING-NEXT
+Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
+nor @samp{NEXT}
address@hidden work/+WAITING|+NEXT
+Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
address@hidden
address@hidden table
+
address@hidden regular expressions, with tags search
+Any element of the tag/todo match can be a regular expression - in this
+case it must be enclosed in curly braces. For example,
address@hidden@address@hidden matches headlines that contain the tag
address@hidden:work:} and any tag @i{starting} with @samp{boss}.
+
address@hidden level, require for tags/property match
address@hidden category, require for tags/property match
+You can also require a headline to be of a certain level or category, by
+writing instead of any TAG an expression like @samp{LEVEL=3} or
address@hidden"work"}, respectively. For example, a search
address@hidden/-DONE} lists all level three headlines that have the
+tag @samp{boss} and are @emph{not} marked with the todo keyword DONE.
+
address@hidden Properties and columns, Dates and times, Tags, Top
address@hidden Properties and Columns
address@hidden properties
+
+Properties are a set of key-value pairs associated with an entry. There
+are two main applications for properties in Org-mode. First, properties
+are like tags, but with a value. Second, you can use properties to
+implement (very basic) database capabilities in an Org-mode buffer. For
+an example of the first application, imagine maintaining a file where
+you document bugs and plan releases of a piece of software. Instead of
+using tags like @code{:release_1:}, @code{:release_2:}, one can use a
+property, say @code{:Release:}, that in different subtrees has different
+values, such as @code{1.0} or @code{2.0}. For an example of the second
+application of properties, imagine keeping track of one's music CD's,
+where properties could be things such as the album artist, date of
+release, number of tracks, and so on.
+
+Properties can be conveniently edited and viewed in column view
+(@pxref{Column view}).
+
+Properties are like tags, but with a value. For example, in a file
+where you document bugs and plan releases of a piece of software,
+instead of using tags like @code{:release_1:}, @code{:release_2:}, it
+can be more efficient to use a property @code{:Release:} with a value
address@hidden or @code{2.0}. Second, you can use properties to implement
+(very basic) database capabilities in an Org-mode buffer, for example to
+create a list of Music CD's you own. You can edit and view properties
+conveniently in column view (@pxref{Column view}).
+
address@hidden
+* Property syntax:: How properties are spelled out
+* Special properties:: Access to other Org-mode features
+* Property searches:: Matching property values
+* Property inheritance:: Passing values down the tree
+* Column view:: Tabular viewing and editing
+* Property API:: Properties for Lisp programmers
address@hidden menu
+
address@hidden Property syntax, Special properties, Properties and columns,
Properties and columns
address@hidden Property Syntax
address@hidden property syntax
address@hidden drawer, for properties
+
+Properties are key-value pairs. They need to be inserted into a special
+drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property
+is specified on a single line, with the key (surrounded by colons)
+first, and the value after it. Here is an example:
+
address@hidden
+* CD collection
+** Classic
+*** Goldberg Variations
+ :PROPERTIES:
+ :Title: Goldberg Variations
+ :Composer: J.S. Bach
+ :Artist: Glen Gould
+ :Publisher: Deutsche Grammphon
+ :NDisks: 1
+ :END:
address@hidden example
+
+You may define the allowed values for a particular property @samp{:Xyz:}
+by setting a property @samp{:Xyz_ALL:}. This special property is
address@hidden, so if you set it in a level 1 entry, it will apply to
+the entire tree. When allowed values are defined, setting the
+corresponding property becomes easier and is less prone to typing
+errors. For the example with the CD collection, we can predefine
+publishers and the number of disks in a box like this:
+
address@hidden
+* CD collection
+ :PROPERTIES:
+ :NDisks_ALL: 1 2 3 4
+ :Publisher_ALL: "Deutsche Grammophon" Phillips EMI
+ :END:
address@hidden example
+
+If you want to set properties that can be inherited by any entry in a
+file, use a line like
+
address@hidden
+#+PROPERTY: NDisks_ALL 1 2 3 4
address@hidden example
+
+Property values set with the global variable
address@hidden can be inherited by all entries in all
+Org-mode files.
+
address@hidden
+The following commands help to work with properties:
+
address@hidden @kbd
address@hidden address@hidden
address@hidden address@hidden
+After an initial colon in a line, complete property keys. All keys used
+in the current file will be offered as possible completions.
address@hidden C-c C-x p
address@hidden C-c C-x p
+Set a property. This prompts for a property name and a value. If
+necessary, the property drawer is created as well.
address@hidden M-x org-insert-property-drawer
+Insert a property drawer into the current entry. The drawer will be
+inserted early in the entry, but after the lines with planning
+information like deadlines.
address@hidden C-c C-c
address@hidden C-c C-c
+With the cursor in a property drawer, this executes property commands.
address@hidden C-c C-c s
+Set a property in the current entry. Both the property and the value
+can be inserted using completion.
address@hidden address@hidden
address@hidden address@hidden
address@hidden address@hidden/@key{right}
+Switch property at point to the next/previous allowed value.
address@hidden C-c C-c d
+Remove a property from the current entry.
address@hidden C-c C-c D
+Globally remove a property, from all entries in the current file.
address@hidden C-c C-c c
+Compute the property at point, using the operator and scope from the
+nearest column format definition.
address@hidden table
+
address@hidden Special properties, Property searches, Property syntax,
Properties and columns
address@hidden Special Properties
address@hidden properties, special
+
+Special properties provide alternative access method to Org-mode
+features discussed in the previous chapters, like the TODO state or the
+priority of an entry. This interface exists so that you can include
+these states into columns view (@pxref{Column view}), or to use them in
+queries. The following property names are special and should not be
+used as keys in the properties drawer:
+
address@hidden
+TODO @r{The TODO keyword of the entry.}
+TAGS @r{The tags defined directly in the headline.}
+ALLTAGS @r{All tags, including inherited ones.}
+PRIORITY @r{The priority of the entry, a string with a single letter.}
+DEADLINE @r{The deadline time string, without the angular brackets.}
+SCHEDULED @r{The scheduling time stamp, without the angular brackets.}
+TIMESTAMP @r{The first keyword-less time stamp in the entry.}
+TIMESTAMP_IA @r{The first inactive time stamp in the entry.}
+CLOCKSUM @r{The sum of CLOCK intervals in the subtree.
@code{org-clock-sum}}
+ @r{must be run first to compute the values.}
address@hidden example
+
address@hidden Property searches, Property inheritance, Special properties,
Properties and columns
address@hidden Property searches
address@hidden properties, searching
address@hidden properties, inheritance
address@hidden searching, of properties
address@hidden inheritance, of properties
+
+To create sparse trees and special lists with selection based on
+properties, the same commands are used as for tag searches (@pxref{Tag
+searches}), and the same logic applies. For example, a search string
+
address@hidden
++work-boss+PRIORITY="A"+Coffee="unlimited"+Effort=""address@hidden|address@hidden
address@hidden example
+
address@hidden
+finds entries tagged @samp{:work:} but not @samp{:boss:}, which
+also have a priority value @samp{A}, a @samp{:Coffee:} property with the
+value @samp{unlimited}, an @samp{Effort} property that is undefined or
+empty, and a @samp{:With:} property that is matched by
+the regular expression @samp{Sarah\|Denny}.
+
+You can configure Org-mode to use property inheritance during a search,
+see @ref{Property inheritance} for details.
+
+There is also a special command for creating sparse trees based on a
+single property:
+
address@hidden @kbd
address@hidden C-c / p
address@hidden C-c / p
+Create a sparse tree based on the value of a property. This first
+prompts for the name of a property, and then for a value. A sparse tree
+is created with all entries that define this property with the given
+value. If you enclose the value into curly braces, it is interpreted as
+a regular expression and matched against the property values.
address@hidden table
+
address@hidden Property inheritance, Column view, Property searches, Properties
and columns
address@hidden Property Inheritance
+
+The outline structure of Org-mode documents lends itself for an
+inheritance model of properties: If the parent in a tree has a certain
+property, the children can inherit this property. Org-mode does not
+turn this on by default, because it can slow down property searches
+significantly and is often not needed. However, if you find inheritance
+useful, you can turn it on by setting the variable
address@hidden It may be set to @code{t}, to make
+all properties inherited from the parent, or to a list of properties
+that should be inherited.
+
+Org-mode has a few properties for which inheritance is hard-coded, at
+least for the special applications for which they are used:
+
address@hidden @code
address@hidden COLUMNS
+The @code{:COLUMNS:} property defines the format of column view
+(@pxref{Column view}). It is inherited in the sense that the level
+where a @code{:COLUMNS:} property is defined is used as the starting
+point for a column view table, independently of the location in the
+subtree from where columns view is turned on.
address@hidden CATEGORY
+For agenda view, a category set through a @code{:CATEGORY:} property
+applies to the entire subtree.
address@hidden ARCHIVE
+For archiving, the @code{:ARCHIVE:} property may define the archive
+location for the entire subtree (@pxref{Moving subtrees}).
address@hidden LOGGING
+The LOGGING property may define logging settings for an entry or a
+subtree (@pxref{Tracking TODO state changes}).
address@hidden table
+
address@hidden Column view, Property API, Property inheritance, Properties and
columns
address@hidden Column View
+
+A great way to view and edit properties in an outline tree is
address@hidden view}. In column view, each outline item is turned into a
+table row. Columns in this table provide access to properties of the
+entries. Org-mode implements columns by overlaying a tabular structure
+over the headline of each item. While the headlines have been turned
+into a table row, you can still change the visibility of the outline
+tree. For example, you get a compact table by switching to CONTENTS
+view (@address@hidden address@hidden, or simply @kbd{c} while column view
+is active), but you can still open, read, and edit the entry below each
+headline. Or, you can switch to column view after executing a sparse
+tree command and in this way get a table only for the selected items.
+Column view also works in agenda buffers (@pxref{Agenda views}) where
+queries have collected selected items, possibly from a number of files.
+
address@hidden
+* Defining columns:: The COLUMNS format property
+* Using column view:: How to create and use column view
+* Capturing Column View:: A dynamic block for column view
address@hidden menu
+
address@hidden Defining columns, Using column view, Column view, Column view
address@hidden Defining Columns
address@hidden column view, for properties
address@hidden properties, column view
+
+Setting up a column view first requires defining the columns. This is
+done by defining a column format line.
+
address@hidden
+* Scope of column definitions:: Where defined, where valid?
+* Column attributes:: Appearance and content of a column
address@hidden menu
+
address@hidden Scope of column definitions, Column attributes, Defining
columns, Defining columns
address@hidden Scope of column definitions
+
+To define a column format for an entire file, use a line like
+
address@hidden
+#+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
address@hidden example
+
+To specify a format that only applies to a specific tree, add a
address@hidden:COLUMNS:} property to the top node of that tree, for example:
+
address@hidden
+** Top node for columns view
+ :PROPERTIES:
+ :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
+ :END:
address@hidden example
+
+If a @code{:COLUMNS:} property is present in an entry, it defines columns
+for the entry itself, and for the entire subtree below it. Since the
+column definition is part of the hierarchical structure of the document,
+you can define columns on level 1 that are general enough for all
+sublevels, and more specific columns further down, when you edit a
+deeper part of the tree.
+
address@hidden Column attributes, , Scope of column definitions, Defining
columns
address@hidden Column attributes
+A column definition sets the attributes of a column. The general
+definition looks like this:
+
address@hidden
+ %[width]property[(title)address@hidden@}]
address@hidden example
+
address@hidden
+Except for the percent sign and the property name, all items are
+optional. The individual parts have the following meaning:
+
address@hidden
+width @r{An integer specifying the width of the column in
characters.}
+ @r{If omitted, the width will be determined automatically.}
+property @r{The property that should be edited in this column.}
+(title) @r{The header text for the column. If omitted, the}
+ @r{property name is used.}
address@hidden@} @r{The summary type. If specified, the column values for}
+ @r{parent nodes are computed from the children.}
+ @r{Supported summary types are:}
+ @address@hidden @r{Sum numbers in this column.}
+ @{+;address@hidden @r{Like @samp{+}, but format result with
@samp{%.1f}.}
+ @address@hidden @r{Currency, short for @samp{+;%.2f}.}
+ @{:@} @r{Sum times, HH:MM:SS, plain numbers are hours.}
+ @address@hidden @r{Checkbox status, [X] if all children
are [X].}
+ @{X/@} @r{Checkbox status, [n/m].}
+ @address@hidden @r{Checkbox status, [n%].}
address@hidden example
+
address@hidden
+Here is an example for a complete columns definition, along with allowed
+values.
+
address@hidden
+:COLUMNS: %20ITEM %9Approved(Approved?)@address@hidden %Owner %11Status
address@hidden note that the COLUMNS definition must be on a single line - it
is wrapped here only because of formatting constraints.}
+ address@hidden:@} %CLOCKSUM
+:Owner_ALL: Tammy Mark Karl Lisa Don
+:Status_ALL: "In progress" "Not started yet" "Finished" ""
+:Approved_ALL: "[ ]" "[X]"
address@hidden example
+
+The first column, @samp{%25ITEM}, means the first 25 characters of the
+item itself, i.e. of the headline. You probably always should start the
+column definition with the @samp{ITEM} specifier. The other specifiers
+create columns @samp{Owner} with a list of names as allowed values, for
address@hidden with four different possible values, and for a checkbox
+field @samp{Approved}. When no width is given after the @samp{%}
+character, the column will be exactly as wide as it needs to be in order
+to fully display all values. The @samp{Approved} column does have a
+modified title (@samp{Approved?}, with a question mark). Summaries will
+be created for the @samp{Time_Estimate} column by adding time duration
+expressions like HH:MM, and for the @samp{Approved} column, by providing
+an @samp{[X]} status if all children have been checked. The
address@hidden column is special, it lists the sum of CLOCK intervals
+in the subtree.
+
address@hidden Using column view, Capturing Column View, Defining columns,
Column view
address@hidden Using Column View
+
address@hidden @kbd
address@hidden column view on and off}
address@hidden C-c C-x C-c
address@hidden C-c C-x C-c
+Create the column view for the local environment. This command searches
+the hierarchy, up from point, for a @code{:COLUMNS:} property that defines
+a format. When one is found, the column view table is established for
+the entire tree, starting from the entry that contains the @code{:COLUMNS:}
+property. If none is found, the format is taken from the @code{#+COLUMNS}
+line or from the variable @code{org-columns-default-format}, and column
+view is established for the current entry and its subtree.
address@hidden r
address@hidden r
+Recreate the column view, to included hanges happening in the buffer.
address@hidden g
address@hidden g
+Same as @kbd{r}.
address@hidden q
address@hidden q
+Exit column view.
address@hidden values}
address@hidden @key{left} @key{right} @key{up} @key{down}
+Move through the column view from field to field.
address@hidden address@hidden
address@hidden address@hidden
address@hidden address@hidden/@key{right}
+Switch to the next/previous allowed value of the field. For this, you
+have to have specified allowed values for a property.
address@hidden n
address@hidden p
address@hidden n / p
+Same as @address@hidden/@key{right}}
address@hidden e
address@hidden e
+Edit the property at point. For the special properties, this will
+invoke the same interface that you normally use to change that
+property. For example, when editing a TAGS property, the tag completion
+or fast selection interface will pop up.
address@hidden C-c C-c
address@hidden C-c C-c
+When there is a checkbox at point, toggle it.
address@hidden v
address@hidden v
+View the full value of this property. This is useful if the width of
+the column is smaller than that of the value.
address@hidden a
address@hidden a
+Edit the list of allowed values for this property. If the list is found
+in the hierarchy, the modified values is stored there. If no list is
+found, the new value is stored in the first entry that is part of the
+current column view.
address@hidden the table structure}
address@hidden <
address@hidden >
address@hidden < / >
+Make the column narrower/wider by one character.
address@hidden address@hidden
address@hidden address@hidden
+Insert a new column, to the right of the current column.
address@hidden address@hidden
address@hidden address@hidden
+Delete the current column.
address@hidden table
+
address@hidden Capturing Column View, , Using column view, Column view
address@hidden Capturing Column View
+
+Since column view is just an overlay over a buffer, it cannot be
+exported or printed directly. If you want to capture a column view, use
+ths @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame
+of this block looks like this:
+
address@hidden
+* The column view
+#+BEGIN: columnview :hlines 1 :id "label"
+
+#+END:
address@hidden example
+
address@hidden This dynamic block has the following parameters:
+
address@hidden @code
address@hidden :id
+This is most important parameter. Column view is a feature that is
+often localized to a certain (sub)tree, and the capture block might be
+in a different location in the file. To identify the tree whose view to
+capture, you can use 3 values:
address@hidden
+local @r{use the tree in which the capture block is located}
+global @r{make a global view, including all headings in the file}
+"label" @r{call column view in the tree that has and @code{:ID:}}
+ @r{property with the value @i{label}}
address@hidden example
address@hidden :hlines
+When @code{t}, insert a hline after every line. When a number N, insert
+a hline before each headline with level @code{<= N}.
address@hidden :vlines
+When set to @code{t}, enforce column groups to get vertical lines.
address@hidden :maxlevel
+When set to a number, don't capture entries below this level.
address@hidden :skip-empty-rows
+When set to @code{t}, skip row where the only non-empty specifier of the
+column view is @code{ITEM}.
+
address@hidden table
+
address@hidden
+The following commands insert or update the dynamic block:
+
address@hidden @kbd
address@hidden C-c C-x r
address@hidden C-c C-x r
+Insert a dynamic block capturing a column view. You will be prompted
+for the scope or id of the view.
address@hidden C-c C-c
address@hidden C-c C-c
address@hidden C-c C-x C-u
address@hidden C-c C-x C-u
+Update dynamical block at point. The cursor needs to be in the
address@hidden line of the dynamic block.
address@hidden C-u C-c C-x C-u
address@hidden C-u C-c C-x C-u
+Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
+you have several clocktable blocks in a buffer.
address@hidden table
+
address@hidden Property API, , Column view, Properties and columns
address@hidden The Property API
address@hidden properties, API
address@hidden API, for properties
+
+There is a full API for accessing and changing properties. This API can
+be used by Emacs Lisp programs to work with properties and to implement
+features based on them. For more information see @ref{Using the
+property API}.
+
address@hidden Dates and times, Remember, Properties and columns, Top
address@hidden Dates and Times
address@hidden dates
address@hidden times
@cindex time stamps
@cindex date stamps
-Items can be labeled with timestamps to make them useful for project
-planning.
+To assist project planning, TODO items can be labeled with a date and/or
+a time. The specially formatted string carrying the date and time
+information is called a @emph{timestamp} in Org-mode. This may be a
+little confusing because timestamp is often used as indicating when
+something was created or last changed. However, in Org-mode this term
+is used in a much wider sense.
@menu
* Time stamps:: Assigning a time to a tree entry
* Creating timestamps:: Commands which insert timestamps
-* Custom time format:: If you cannot work with the ISO format
-* Repeating items:: Deadlines that come back again and again
-* Progress logging:: Documenting when what work was done.
+* Deadlines and scheduling:: Planning your work
+* Clocking work time::
@end menu
address@hidden Time stamps, Creating timestamps, Timestamps, Timestamps
address@hidden Time stamps, Creating timestamps, Dates and times, Dates and
times
@section Time stamps, deadlines and scheduling
@cindex time stamps
@cindex ranges, time
@@ -2794,97 +3970,75 @@
@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>address@hidden is the standard ISO date/time format. If you
-cannot get used to these, see @ref{Custom time format}}. A time stamp
+A time stamp is a specification of a date (possibly with time or a range
+of times) in a special format, either @samp{<2003-09-16 Tue>} or
address@hidden<2003-09-16 Tue 09:39>} or @samp{<2003-09-16 Tue
+12:00-12:30>address@hidden is the standard ISO date/time format. To
+use an alternative format, see @ref{Custom time format}.}. 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
+presence causes entries to be shown on specific dates in the agenda
(@pxref{Weekly/Daily agenda}). We distinguish:
@table @var
address@hidden Plain time stamp
address@hidden Plain time stamp; Event; Appointment
@cindex timestamp
A simple time stamp just assigns a date/time to an item. This is just
-like writing down an appointment in a paper agenda, or like writing down
-an event in a diary, when you want to take note of when something
-happened. In the timeline and agenda displays, the headline of an entry
-associated with a plain time stamp will be shown exactly on that date.
+like writing down an appointment or event in a paper agenda. In the
+timeline and agenda displays, the headline of an entry associated with a
+plain time stamp will be shown exactly on that date.
@example
* Meet Peter at the movies <2006-11-01 Wed 19:15>
+* Discussion on climate change <2006-11-02 Thu 20:00-22:00>
@end example
address@hidden Inactive time stamp
address@hidden timestamp, inactive
address@hidden inactive timestamp
-Just like a plain time stamp, but with square brackets instead of
-angular ones. These time stamps are inactive in the sense that they do
address@hidden trigger an entry to show up in the agenda.
address@hidden Time stamp with repeater interval
address@hidden timestamp, with repeater interval
+A time stamp may contain a @emph{repeater interval}, indicating that it
+applies not only on the given date, but again and again after a certain
+interval of N days (d), weeks (w), months(m), or years(y). The
+following will show up in the agenda every Wednesday:
@example
-* Gillian comes late for the fifth time [2006-11-01 Wed]
+* Pick up Sam at school <2007-05-16 Wed 12:30 +1w>
@end example
address@hidden Time stamp range
address@hidden 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:
address@hidden Diary-style sexp entries
+For more complex date specifications, Org-mode supports using the
+special sexp diary entries implemented in the Emacs calendar/diary
+package. For example
@example
-** Meeting in Amsterdam
- <2004-08-23 Mon>--<2004-08-26 Thu>
+* The nerd meeting on every 2nd Thursday of the month
+ <%%(diary-float t 4 2)>
@end example
address@hidden Time stamp with SCHEDULED keyword
address@hidden 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. So this is
-not about recording an event, but about planning your work. The
-headline will be listed under the given address@hidden will still be
-listed on that date after it has been marked DONE. If you don't like
-this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. 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 until completed.
address@hidden Time/Date range
address@hidden timerange
address@hidden date range
+Two time stamps connected by @samp{--} denote a 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
-*** TODO Call Trillian for a date on New Years Eve.
- SCHEDULED: <2004-12-25 Sat>
+** Meeting in Amsterdam
+ <2004-08-23 Mon>--<2004-08-26 Thu>
@end example
address@hidden Time stamp with DEADLINE keyword
address@hidden 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:
address@hidden Inactive time stamp
address@hidden timestamp, inactive
address@hidden inactive timestamp
+Just like a plain time stamp, but with square brackets instead of
+angular ones. These time stamps are inactive in the sense that they do
address@hidden trigger an entry to show up in the agenda.
@example
-*** TODO write article about the Earth for the Guide
- The editor in charge is [[bbdb:Ford Prefect]]
- DEADLINE: <2004-02-29 Sun>
+* Gillian comes late for the fifth time [2006-11-01 Wed]
@end example
address@hidden Time stamp with CLOSED keyword
address@hidden CLOSED keyword
-When @code{org-log-done} is non-nil, Org-mode will automatically insert
-a special time stamp each time a TODO entry is marked done
-(@pxref{Progress logging}). This time stamp is enclosed in square
-brackets instead of angular brackets.
-
address@hidden Time range with CLOCK keyword
address@hidden CLOCK keyword
-When using the clock to time the work that is being done on specific
-items, time ranges preceded by the CLOCK keyword are inserted
-automatically into the file. The time stamps are enclosed in square
-brackets instead of angular brackets. @xref{Clocking work time}.
+
@end table
address@hidden Creating timestamps, Custom time format, Time stamps, Timestamps
address@hidden Creating timestamps, Deadlines and scheduling, Time stamps,
Dates and times
@section Creating timestamps
@cindex creating timestamps
@cindex timestamps, creating
@@ -2899,61 +4053,40 @@
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.
-
address@hidden
@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}.
-
address@hidden
@kindex C-c !
@item C-c !
-Like @kbd{C-c .}, but insert an inactive time stamp not triggering the
-agenda.
-
+Like @kbd{C-c .}, but insert an inactive time stamp that will not cause
+an agenda entry.
address@hidden
@kindex C-c <
@item C-c <
Insert a time stamp corresponding to the cursor date in the Calendar.
-
address@hidden
@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.
-
address@hidden
@kindex C-c C-o
@item C-c C-o
Access the agenda for the date given by the time stamp or -range at
point (@pxref{Weekly/Daily agenda}).
-
address@hidden C-c C-d
address@hidden C-c C-d
-Insert @samp{DEADLINE} keyword along with a stamp. The insertion will
-happen in the line directly following the headline.
address@hidden FIXME Any CLOSED timestamp will be removed.????????
-
address@hidden C-c C-w
address@hidden sparse tree, for deadlines
address@hidden 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.
-
address@hidden C-c C-s
address@hidden C-c C-s
-Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will
-happen in the line directly following the headline. Any CLOSED
-timestamp will be removed.
-
address@hidden
@kindex address@hidden
@kindex address@hidden
@item address@hidden
@itemx address@hidden
Change date at cursor by one day. These key bindings conflict with
CUA-mode (@pxref{Conflicts}).
-
address@hidden
@kindex address@hidden
@kindex address@hidden
@item address@hidden
@@ -2963,8 +4096,7 @@
headline and 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{Conflicts}).
-
-
address@hidden
@kindex C-c C-y
@cindex evaluate time range
@item C-c C-y
@@ -2976,29 +4108,60 @@
@menu
* The date/time prompt:: How org-mode helps you entering date and time
+* Custom time format:: Making dates look differently
@end menu
address@hidden The date/time prompt, , Creating timestamps, Creating timestamps
address@hidden The date/time prompt, Custom time format, Creating timestamps,
Creating timestamps
@subsection The date/time prompt
@cindex date, reading in minibuffer
@cindex time, reading in minibuffer
-When Org-mode prompts for a date/time, the prompt suggests to enter an
-ISO date. But it will in fact accept any string containing some date
-and/or time information. You can, for example, use @kbd{C-y} to paste a
-(possibly multi-line) string copied from an email message. Org-mode
-will find whatever information is in there and will replace anything not
-specified with the current date and time. For example:
-
address@hidden
- 3-2-5 --> 2003-02-05
- feb 15 --> currentyear-02-15
- sep 12 9 --> 2009-09-12
- 12:45 --> today 12:45
- 22 sept 0:34 --> currentyear-09-22 0:34
- 12 --> currentyear-currentmonth-12
- Fri --> nearest Friday (today or later)
- +4 --> 4 days from now (if +N is the only thing given)
+When Org-mode prompts for a date/time, the default is shown as an ISO
+date, and the prompt therefore seems to ask for an ISO date. But it
+will in fact accept any string containing some date and/or time
+information, and it is really smart about interpreting your input. You
+can, for example, use @kbd{C-y} to paste a (possibly multi-line) string
+copied from an email message. Org-mode will find whatever information
+is in there and derive anything you have not specified from the
address@hidden date and time}. The default is usually the current date
+and time, but when modifying an existing time stamp, or when entering
+the second stamp of a range, it is taken from the stamp in the buffer.
+When filling in information, Org-mode assumes that most of the time you
+will want to enter a date in the future: If you omit the month/year and
+the given day/month is @i{before} today, it will assume that you mean a
+future address@hidden the variable
address@hidden
+
+For example, lets assume that today is @b{June 13, 2006}. Here is how
+various inputs will be interpreted, the items filled in by Org-mode are
+in @b{bold}.
+
address@hidden
+3-2-5 --> 2003-02-05
+14 --> @address@hidden
+12 --> @address@hidden
+Fri --> nearest Friday (defaultdate or later)
+sep 15 --> @b{2006}-11-15
+feb 15 --> @b{2007}-02-15
+sep 12 9 --> 2009-09-12
+12:45 --> @address@hidden@b{13} 12:45
+22 sept 0:34 --> @b{2006}-09-22 0:34
address@hidden example
+
+Furthermore you can specify a relative date by giving, as the
address@hidden thing in the input: a plus/minus sign, a number and a
+letter [dwmy] to indicate change in days weeks, months, years. With a
+single plus or minus, the date is always relative to today. With a
+double plus or minus, it is relative to the default date. If instead of
+a single letter, you use the abbreviation of day name, the date will be
+the nth such day. E.g.
+
address@hidden
++4d --> four days from today
++4 --> same as above
++2w --> two weeks from today
+++5 --> five days from default date
++2tue --> second tuesday from now.
@end example
The function understands English month and weekday abbreviations. If
@@ -3014,41 +4177,33 @@
information entered at the prompt. You can control the calendar fully
from the minibuffer:
address@hidden @kbd
@kindex <
address@hidden <
-Scroll calendar backwards by one month.
@kindex >
address@hidden >
-Scroll calendar forwards by one month.
@kindex mouse-1
address@hidden mouse-1
-Select date by clicking on it.
@kindex address@hidden
address@hidden address@hidden
-One day forward.
@kindex address@hidden
address@hidden address@hidden
-One day back.
@kindex address@hidden
address@hidden address@hidden
-One week forward.
@kindex address@hidden
address@hidden address@hidden
-One week back.
@kindex address@hidden
address@hidden address@hidden
-One month forward.
@kindex address@hidden
address@hidden address@hidden
-One month back.
@kindex @key{RET}
address@hidden @key{RET}
-Choose date in calendar (only if nothing was typed into minibuffer).
address@hidden table
address@hidden
+> / < @r{Scroll calendar forward/backward by one month.}
+mouse-1 @r{Select date by clicking on it.}
address@hidden/@key{left} @r{One day forward/backward.}
address@hidden/@key{up} @r{One week forward/backward.}
address@hidden/@key{left} @r{One month forward/backward.}
address@hidden @r{Choose date in calendar.}
address@hidden example
+
+The actions of the date/time prompt may seem complex, but I asure you
+they will grow on you. To help you understand what is going on, the
+current interpretation of your input will be displayed live in the
address@hidden you find this distracting, turn the display of
+with @code{org-read-date-display-live}.}.
address@hidden Custom time format, Repeating items, Creating timestamps,
Timestamps
address@hidden Custom time format
address@hidden Custom time format, , The date/time prompt, Creating timestamps
address@hidden Custom time format
@cindex custom date/time format
@cindex time format, custom
@cindex date format, custom
@@ -3081,6 +4236,9 @@
just like @address@hidden/@key{right}}. At the end of the stamp, the
time will be changed by one minute.
@item
+If the time stamp contains a range of clock times or a repeater, these
+will not be overlayed, but remain in the buffer as they were.
address@hidden
When you delete a time stamp character-by-character, it will only
disappear from the buffer after @emph{all} (invisible) characters
belonging to the ISO timestamp have been removed.
@@ -3090,117 +4248,183 @@
format is shorter, things do work as expected.
@end itemize
address@hidden Repeating items, Progress logging, Custom time format, Timestamps
address@hidden Repeating items
address@hidden TODO items, repeating
address@hidden deadlines, repeating
address@hidden scheduling, repeating
-
-Org-mode integrates with the Emacs calendar and diary to display cyclic
-appointments, anniversaries and other special entries in the agenda
-(@pxref{Weekly/Daily agenda}). However, it can be useful to have
-certain deadlines and scheduling items to auto-repeat. The advantage of
-a deadline or scheduled item is that the they produce warnings ahead of
-time and automatically forward themselves in the agenda until they are
-done. The abstract difference is therefore between cyclic
address@hidden and cyclic @i{action items}. For appointments you
-should use the diary, for actions you can uses an org-mode deadline or
-scheduling time stamp together with a REPEAT cookie. For example:
-
address@hidden
-* TODO Replace batteries in smoke detector REPEAT(+18m)
- SCHEDULED: <2007-01-01 Mon>
-
-* TODO Get dentist appointment REPEAT(+6m)
- SCHEDULED: <2006-12-19 Tue>
-
-* TODO Tax report to IRS REPEAT(+1y)
- DEADLINE: <2007-04-01 Sun>
address@hidden example
-
-Each time you try to mark one of these entries DONE using @kbd{C-c C-t},
-they will automatically switch back to the state TODO, and the
-deadline/scheduling will be shifted accordingly. The time units
-recognized by org-mode are year (y), month (m), week (w), and day (d).
-Org-mode will also prompt you for a note and record the fact that you
-have closed this item in a note under the headline.
-
-One unusual property of these repeating items is that only one instance
-of each exist at any given time. So if you look back or ahead in the
-agenda, you will not find past and future instances, only the current
-one will show up. Use a cyclic diary entry if you need all past and
-future instances to be visible in the agenda.
address@hidden Progress logging, , Repeating items, Timestamps
address@hidden Progress Logging
address@hidden progress logging
address@hidden logging, of progress
address@hidden Deadlines and scheduling, Clocking work time, Creating
timestamps, Dates and times
address@hidden Deadlines and Scheduling
-Org-mode can automatically record a time stamp when you mark a TODO item
-as DONE, or even each time when you change the state of a TODO item.
-You can also measure precisely the time you spent on specific items in a
-project by starting and stopping a clock when you start and stop working
-on an aspect of a project.
+A time stamp may be preceded by special keywords to facilitate planning:
address@hidden
-* Closing items:: When was this entry marked DONE?
-* Tracking TODO state changes:: When did the status change?
-* Clocking work time:: When exactly did you work on this item?
address@hidden menu
address@hidden @var
address@hidden DEADLINE
address@hidden DEADLINE keyword
address@hidden Closing items, Tracking TODO state changes, Progress logging,
Progress logging
address@hidden Closing items
+Meaning: the task (most likely a TODO item, though not necessarily) is supposed
+to be finished on that date.
-If you want to keep track of @emph{when} a certain TODO item was
-finished, turn on logging address@hidden corresponding in-buffer
-setting is: @code{#+STARTUP: logdone}}
+On the deadline date, the task will be listed in the agenda. In
+addition, the agenda for @emph{today} will carry a warning about the
+approaching or missed deadline, starting
address@hidden before the due date, and continuing
+until the entry is marked DONE. An example:
address@hidden
-(setq org-log-done t)
address@hidden lisp
address@hidden
+*** TODO write article about the Earth for the Guide
+ The editor in charge is [[bbdb:Ford Prefect]]
+ DEADLINE: <2004-02-29 Sun>
address@hidden example
address@hidden
-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
address@hidden: [timestamp]} will be inserted just after the headline. If
-you turn the entry back into a TODO item 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
address@hidden key to display the TODO items closed on each day, giving you an
-overview of what has been done on a day. If you want to record a note
-along with the timestamp, address@hidden corresponding in-buffer
-setting is: @code{#+STARTUP: lognotedone}}
+You can specify a different lead time for warnings for a specific
+deadlines using the following syntax. Here is an example with a warning
+period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}.
address@hidden
-(setq org-log-done '(done))
address@hidden lisp
address@hidden SCHEDULED
address@hidden SCHEDULED keyword
address@hidden Tracking TODO state changes, Clocking work time, Closing items,
Progress logging
address@hidden Tracking TODO state changes
+Meaning: you are planning to start working on that task on the given
+date.
-When TODO keywords are used as workflow states (@pxref{Workflow
-states}), you might want to keep track of when a state change occurred,
-and you may even want to attach notes to that state change. With the
-setting
+The headline will be listed under the given address@hidden will still
+be listed on that date after it has been marked DONE. If you don't like
+this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. 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 until completed.
address@hidden
-(setq org-log-done '(state))
address@hidden lisp
address@hidden
+*** TODO Call Trillian for a date on New Years Eve.
+ SCHEDULED: <2004-12-25 Sat>
address@hidden example
@noindent
-each state change will prompt you for a note that will be attached to
-the current headline. Very likely you do not want this verbose tracking
-all the time, so it is probably better to configure this behavior with
-in-buffer options. For example, if you are tracking purchases, put
-these into a separate file that starts with:
address@hidden:} Scheduling an item in Org-mode should @i{not} be
+understood in the same way that we understand @i{scheduling a meeting}.
+Setting a date for a meeting is just a simple appointment, you should
+mark this entry with a simple plain time stamp, to get this item shown
+on the date where it applies. This is a frequent mis-understanding from
+Org-users. In Org-mode, @i{scheduling} means setting a date when you
+want to start working on an action item.
address@hidden table
address@hidden
-#+SEQ_TODO: TODO ORDERED INVOICE PAYED RECEIVED SENT
-#+STARTUP: lognotestate
+You may use time stamps with repeaters in scheduling and deadline
+entries. Org-mode will issue early and late warnings based on the
+assumption that the time stamp represents the @i{nearest instance} of
+the repeater. However, the use of diary sexp entries like
address@hidden
address@hidden<%%(diary-float t 42)>}
address@hidden
+in scheduling and deadline timestamps is limited. Org-mode does not
+know enough about the internals of each sexp function to issue early and
+late warnings. However, it will show the item on each day where the
+sexp entry matches.
+
address@hidden
+* Inserting deadline/schedule:: Planning items
+* Repeated tasks:: Items that show up again and again
address@hidden menu
+
address@hidden Inserting deadline/schedule, Repeated tasks, Deadlines and
scheduling, Deadlines and scheduling
address@hidden Inserting deadline/schedule
+
+The following commands allow to quickly insert a deadline or to schedule
+an item:
+
address@hidden @kbd
address@hidden
address@hidden C-c C-d
address@hidden C-c C-d
+Insert @samp{DEADLINE} keyword along with a stamp. The insertion will
+happen in the line directly following the headline. When called with a
+prefix arg, an existing deadline will be removed from the entry.
address@hidden FIXME Any CLOSED timestamp will be removed.????????
address@hidden
address@hidden C-c / d
address@hidden sparse tree, for deadlines
address@hidden C-c / d
+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 / d} shows
+all deadlines due tomorrow.
address@hidden
address@hidden C-c C-s
address@hidden C-c C-s
+Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will
+happen in the line directly following the headline. Any CLOSED
+timestamp will be removed. When called with a prefix argument, remove
+the scheduling date from the entry.
address@hidden table
+
address@hidden Repeated tasks, , Inserting deadline/schedule, Deadlines and
scheduling
address@hidden Repeated Tasks
+
+Some tasks need to be repeated again and again. Org-mode helps to
+organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
+or plain time stamp. In the following example
address@hidden
+** TODO Pay the rent
+ DEADLINE: <2005-10-01 Sat +1m>
address@hidden example
+the @code{+1m} is a repeater; the intended interpretation is that the
+task has a deadline on <2005-10-01> and repeats itself every (one) month
+starting from that time. If you need both a repeater and a special
+warning period in a deadline entry, the repeater comes first and the
+warning period last: @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
+
+Deadlines and scheduled items produce entries in the agenda when they
+are over-due, so it is important to be able to mark such an entry as
+completed once you have done so. When you mark a DEADLINE or a SCHEDULE
+with the todo keyword DONE, it will no longer produce entries in the
+agenda. The problem with this is, however, that then also the
address@hidden instance of the repeated entry will not be active. Org-mode
+deals with this in the following way: When you try to mark such an entry
+DONE (using @kbd{C-c C-t}), it will shift the base date of the repeating
+time stamp by the repeater interval, and immediately set the entry state
+back to TODO. In the example above, setting the state to DONE would
+actually switch the date like this:
+
address@hidden
+** TODO Pay the rent
+ DEADLINE: <2005-11-01 Tue +1m>
address@hidden example
+
+You will also be prompted for a address@hidden can change this using
+the option @code{org-log-repeat}, or the @code{#+STARTUP} options
address@hidden, @code{lognoterepeat}, and @code{nologrepeat}.} that
+will be put under the DEADLINE line to keep a record that you actually
+acted on the previous instance of this deadline.
+
+As a consequence of shifting the base date, this entry will no longer be
+visible in the agenda when checking past dates, but all future instances
+will be visible.
+
+With the @samp{+1m} cookie, the date shift will always be exactly one
+month. So if you have not payed the rent for three months, marking this
+entry DONE will still keep it as an overdue deadline. Depending on the
+task, this may not be the best way to handle it. For example, if you
+forgot to call you father for 3 weeks, it does not make sense to call
+her 3 times in a single day to make up for it. Finally, there are tasks
+like changing batteries which should always repeat a certain time
address@hidden the last time you did it. For these tasks, Org-mode has
+special repeaters markes with @samp{++} and @samp{.+}. For example:
+
address@hidden
+** TODO Call Father
+ DEADLINE: <2008-02-10 Sun ++1w>
+ Marking this DONE will shift the date by at least one week,
+ but also by as many weeks as it takes to get this date into
+ the future. However, it stays on a Sunday, even if you called
+ and marked it done on Saturday.
+** TODO Check the batteries in the smoke detectors
+ DEADLINE: <2005-11-01 Tue .+1m>
+ Marking this DONE will shift the date to one month after
+ today.
@end example
address@hidden Clocking work time, , Tracking TODO state changes, Progress
logging
address@hidden Clocking work time
+You may have both scheduling and deadline information for a specific
+task - just make sure that the repeater intervals on both are the same.
+
address@hidden Clocking work time, , Deadlines and scheduling, Dates and times
address@hidden Clocking work time
Org-mode allows you to clock the time you spent on specific tasks in a
project. When you start working on an item, you can start the clock.
@@ -3212,16 +4436,19 @@
@kindex C-c C-x C-i
@item C-c C-x C-i
Start the clock on the current item (clock-in). This inserts the CLOCK
-keyword together with a timestamp.
+keyword together with a timestamp. If this is not the first clocking of
+this item, the multiple CLOCK lines will be wrapped into a
address@hidden:CLOCK:} drawer (see also the variable
address@hidden).
@kindex C-c C-x C-o
@item C-c C-x C-o
Stop the clock (clock-out). The inserts another timestamp at the same
location where the clock was last started. It also directly computes
the resulting time in inserts it after the time range as @samp{=>
-HH:MM}. See the variable @code{org-log-done} for the possibility to
-record an additional note together with the clock-out time
address@hidden corresponding in-buffer setting is: @code{#+STARTUP:
-lognoteclock-out}}.
+HH:MM}. See the variable @code{org-log-note-clock-out} for the
+possibility to record an additional note together with the clock-out
+time address@hidden corresponding in-buffer setting is:
address@hidden: lognoteclock-out}}.
@kindex C-c C-y
@item C-c C-y
Recompute the time interval after changing one of the time stamps. This
@@ -3235,6 +4462,10 @@
@item C-c C-x C-x
Cancel the current clock. This is useful if a clock was started by
mistake, or if you ended up working on something else.
address@hidden C-c C-x C-j
address@hidden C-c C-x C-j
+Jump to the entry that contains the currently running clock, an another
+window.
@kindex C-c C-x C-d
@item C-c C-x C-d
Display time summaries for each subtree in the current buffer. This
@@ -3246,28 +4477,42 @@
@kindex C-c C-x C-r
@item C-c C-x C-r
Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
-report as an org-mode table into the current file.
+report as an org-mode table into the current file. When the cursor is
+at an existing clock table, just update it. When called with a prefix
+argument, jump to the first clock report in the current document and
+update it.
@example
-#+BEGIN: clocktable :maxlevel 2 :emphasize nil
+#+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
#+END: clocktable
@end example
@noindent
-If such a block already exists, its content is replaced by the new
-table. The @samp{BEGIN} line can specify options:
+If such a block already exists at point, its content is replaced by the
+new table. The @samp{BEGIN} line can specify options:
@example
-:maxlevels @r{Maximum level depth to which times are listed in the table.}
+:maxlevel @r{Maximum level depth to which times are listed in the table.}
:emphasize @r{When @code{t}, emphasize level one and level two items}
+:scope @r{The scope to consider. This can be any of the following:}
+ nil @r{the current buffer or narrowed region}
+ file @r{the full current buffer}
+ subtree @r{the subtree where the clocktable is located}
+ treeN @r{the surrounding level N tree, for example
@code{tree3}}
+ tree @r{the surrounding level 1 tree}
+ agenda @r{all agenda files}
+ ("file"..) @r{scan these files}
:block @r{The time block to consider. This block is specified relative}
@r{to the current time and may be any of these keywords:}
@address@hidden, @code{yesterday}, @code{thisweek},
@code{lastweek},}
@address@hidden, @code{lastmonth}, @code{thisyear}, or
@code{lastyear}}.
:tstart @r{A time string specifying when to start considering times}
:tend @r{A time string specifying when to stop considering times}
+:step @address@hidden or @code{day}, to split the table into chunks}
+:link @r{Link the item headlines in the table to their origins}
@end example
-So to get a clock summary for the current day, you could write
+So to get a clock summary of the current level 1 tree, for the current
+day, you could write
@example
-#+BEGIN: clocktable :maxlevel 2 :block today
+#+BEGIN: clocktable :maxlevel 2 :block today :scope tree1
#+END: clocktable
@end example
@@ -3280,6 +4525,12 @@
#+END: clocktable
@end example
address@hidden C-c C-c
address@hidden C-c C-c
address@hidden C-c C-x C-u
address@hidden C-c C-x C-u
+Update dynamical block at point. The cursor needs to be in the
address@hidden line of the dynamic block.
@kindex C-u C-c C-x C-u
@item C-u C-c C-x C-u
Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
@@ -3290,274 +4541,260 @@
the agenda (@pxref{Weekly/Daily agenda}) to show which tasks have been
worked on or closed during a day.
address@hidden Tags, Agenda views, Timestamps, Top
address@hidden Tags
address@hidden tags
address@hidden headline tagging
address@hidden matching, tags
address@hidden sparse tree, tag based
address@hidden Remember, Agenda views, Dates and times, Top
address@hidden Remember
address@hidden @file{remember.el}
-If you wish to implement a system of labels and contexts for
-cross-correlating information, an excellent way is to assign @i{tags} to
-headlines. 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
address@hidden@@}. Tags must be preceded and followed by a single colon; like
address@hidden:WORK:}. Several tags can be specified like @samp{:WORK:URGENT:}.
+The @i{Remember} package by John Wiegley lets you store quick notes with
+little interruption of your work flow. See
address@hidden://www.emacswiki.org/cgi-bin/wiki/RememberMode} for more
+information. It is an excellent way to add new notes and tasks to
+Org-mode files. Org-mode significantly expands the possibilities of
address@hidden: You may define templates for different note types, and
+associate target files and headlines with specific templates. It also
+allows you to select the location where a note should be stored
+interactively, on the fly.
@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
+* Setting up remember:: Some code for .emacs to get things going
+* Remember templates:: Define the outline of different note types
+* Storing notes:: Directly get the note to where it belongs
+* Refiling notes:: Moving a note or task to a project
@end menu
address@hidden Tag inheritance, Setting tags, Tags, Tags
address@hidden Tag inheritance
address@hidden inheritance, of tags
address@hidden sublevels, inclusion into tags match
address@hidden Setting up remember, Remember templates, Remember, Remember
address@hidden Setting up remember
address@hidden 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
+The following customization will tell @i{remember} to use org files as
+target, and to create annotations compatible with Org-mode links.
@example
-* Meeting with the French group :WORK:
-** Summary by Frank :BOSS:NOTES:
-*** TODO Prepare slides for him :ACTION:
+(org-remember-insinuate)
+(setq org-directory "~/path/to/my/orgfiles/")
+(setq org-default-notes-file (concat org-directory "/notes.org"))
+(define-key global-map "\C-cr" 'org-remember)
@end example
address@hidden
-the final heading will have the tags @samp{:WORK:}, @samp{:BOSS:},
address@hidden: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. This may
-not be what you want, however, and you can influence inheritance and
-searching using the variables @code{org-use-tag-inheritance} and
address@hidden
-
address@hidden Setting tags, Tag searches, Tag inheritance, Tags
address@hidden Setting tags
address@hidden setting tags
address@hidden tags, setting
-
address@hidden address@hidden
-Tags can simply be typed into the buffer at the end of a headline.
-After a colon, @address@hidden offers completion on tags. There is
-also a special command for inserting tags:
+The last line binds the command @code{org-remember} to a global
address@hidden select your own key, @kbd{C-c r} is only a
+suggestion.}. @code{org-remember} basically just calls @code{remember},
+but it makes a few things easier: If there is an active region, it will
+automatically copy the region into the remember buffer. It also allows
+to jump to the buffer and location where remember notes are being
+stored: Just call @code{org-remember} with a prefix argument. If you
+use two prefix arguments, Org-mode jumps to the location where the last
+remember note was stored.
address@hidden @kbd
address@hidden C-c C-c
address@hidden C-c C-c
address@hidden completion, of tags
-Enter new tags for the current headline. Org-mode will either offer
-completion or a special single-key interface for setting tags, see
-below. 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}).
address@hidden table
address@hidden Remember templates, Storing notes, Setting up remember, Remember
address@hidden Remember templates
address@hidden templates, for remember
-Org will support tag insertion based on a @emph{list of tags}. By
-default this list is constructed dynamically, containing all tags
-currently used in the buffer. You may also globally specify a hard list
-of tags with the variable @code{org-tag-alist}. Finally you can set
-the default tags for a given file with lines like
+In combination with Org-mode, you can use templates to generate
+different types of @i{remember} notes. For example, if you would like
+to use one template to create general TODO entries, another one for
+journal entries, and a third one for collecting random ideas, you could
+use:
@example
-#+TAGS: @@WORK @@HOME @@TENNISCLUB
-#+TAGS: Laptop Car PC Sailboat
+(setq org-remember-templates
+ '(("Todo" ?t "* TODO %?\n %i\n %a" "~/org/TODO.org" "Tasks")
+ ("Journal" ?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org")
+ ("Idea" ?i "* address@hidden@}\n %i\n %a" "~/org/JOURNAL.org" "New
Ideas")))
@end example
-If you have globally defined your preferred set of tags using the
-variable @code{org-tag-alist}, but would like to use a dynamic tag list
-in a specific file: Just add an empty TAGS option line to that file:
address@hidden In these entries, the first string is just a name, and the
+character specifies how to select the template. It is useful if the
+character is also the first letter of the name. The next string
+specifies the template. Two more (optional) strings give the file in
+which, and the headline under which the new note should be stored. The
+file (if not present or @code{nil}) defaults to
address@hidden, the heading to
address@hidden
+
+An optional sixth element specifies the contexts in which the user can
+select the template. This element can be either a list of major modes
+or a function. @code{org-remember} will first check whether the function
+returns @code{t} or if we are in any of the listed major mode, and select
+the template accordingly.
+
+So for example:
@example
-#+TAGS:
+(setq org-remember-templates
+ '(("Bug" ?b "* BUG %?\n %i\n %a" "~/org/BUGS.org" "Bugs" (emacs-lisp-mode))
+ ("Journal" ?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org" my-check)
+ ("Idea" ?i "* address@hidden@}\n %i\n %a" "~/org/JOURNAL.org" "New
Ideas")))
@end example
-The default support method for entering tags is minibuffer completion.
-However, Org-mode also implements a much better method: @emph{fast tag
-selection}. This method allows to select and deselect tags with a
-single key per tag. To function efficiently, you should assign unique
-keys to most tags. This can be done globally with
-
address@hidden
-(setq org-tag-alist '(("@@WORK" . ?w) ("@@HOME" . ?h) ("Laptop" . ?l)))
address@hidden lisp
+The first template will only be available when invoking @code{org-remember}
+from an buffer in @code{emacs-lisp-mode}. The second template will only be
+available when the function @code{my-check} returns @code{t}. The third
+template will be proposed in any context.
address@hidden or on a per-file basis with
+When you call @kbd{M-x remember} (or @kbd{M-x org-remember}) to remember
+something, org will prompt for a key to select the template (if you have
+more than one template) and then prepare the buffer like
address@hidden
+* TODO
+ [[file:link to where you called remember]]
address@hidden example
address@hidden
+During expansion of the template, special @kbd{%}-escapes allow dynamic
+insertion of content:
@example
-#+TAGS: @@WORK(w) @@HOME(h) @@TENNISCLUB(t) Laptop(l) PC(p)
address@hidden@} @r{prompt the user for a string and replace this sequence
with it.}
+ @r{You may specify a default value and a completion table with}
+ @address@hidden|default|completion2|address@hidden
+ @r{The arrow keys access a prompt-specific history.}
+%t @r{time stamp, date only}
+%T @r{time stamp with date and time}
+%u, %U @r{like the above, but inactive time stamps}
+%^t @r{like @code{%t}, but prompt for date. Similarly @code{%^T},
@code{%^u}, @code{%^U}}
+ @r{You may define a prompt like @address@hidden@}t}}
+%n @r{user name (taken from @code{user-full-name})}
+%a @r{annotation, normally the link created with
@code{org-store-link}}
+%A @r{like @code{%a}, but prompt for the description part}
+%i @r{initial content, the region when remember is called with C-u.}
+ @r{The entire text will be indented like @code{%i} itself.}
+%c @r{Content of the clipboard, or current kill ring head.}
+%^g @r{prompt for tags, with completion on tags in target file.}
+%^G @r{prompt for tags, with completion all tags in all agenda files.}
+%:keyword @r{specific information for certain link types, see below}
+%[pathname] @r{insert the contents of the file given by @code{pathname}}
+%(sexp) @r{evaluate elisp @code{(sexp)} and replace with the result}
+%! @r{immediately store note after completing the template}
+ @r{(skipping the @kbd{C-c C-c} that normally triggers storing)}
@end example
@noindent
-You can also group together tags that are mutually exclusive. With
-curly address@hidden @code{org-mode-alist} use
address@hidden'(:startgroup)} and @code{'(:endgroup)}, respectively. Several
-groups are allowed.}
+For specific link types, the following keywords will be
address@hidden you define your own link types (@pxref{Adding
+hyperlink types}), any property you store with
address@hidden can be accessed in remember templates in a
+similar way.}:
@example
-#+TAGS: @{ @@WORK(w) @@HOME(h) @@TENNISCLUB(t) @} Laptop(l) PC(p)
+Link type | Available keywords
+-------------------+----------------------------------------------
+bbdb | %:name %:company
+bbdb | %::server %:port %:nick
+vm, wl, mh, rmail | %:type %:subject %:message-id
+ | %:from %:fromname %:fromaddress
+ | %:to %:toname %:toaddress
+ | %:fromto @r{(either "to NAME" or "from
NAME")@footnote{This will always be the other, not the user. See the variable
@code{org-from-is-user-regexp}.}}
+gnus | %:group, @r{for messages also all email fields}
+w3, w3m | %:url
+info | %:file %:node
+calendar | %:date"
@end example
address@hidden you indicate that at most one of @samp{@@WORK}, @samp{@@HOME},
-and @samp{@@TENNISCLUB} should be selected.
address@hidden
+To place the cursor after template expansion use:
address@hidden Don't forget to press @kbd{C-c C-c} with the cursor in one of
-these lines to activate any changes.
address@hidden
+%? @r{After completing the template, position cursor here.}
address@hidden example
-If at least one tag has a selection key, pressing @kbd{C-c C-c} will
-automatically present you with a special interface, listing inherited
-tags, the tags of the current headline, and a list of all valid tags
-with corresponding address@hidden will automatically be assigned to
-tags which have no configured keys.}. In this interface, you can use
-the following keys:
address@hidden
+If you change your mind about which template to use, call
address@hidden in the remember buffer. You may then select a new
+template that will be filled with the previous context information.
address@hidden @kbd
address@hidden a-z...
-Pressing keys assigned to tags will add or remove them from the list of
-tags in the current line. Selecting a tag in a group of mutually
-exclusive tags will turn off any other tags from that group.
address@hidden @key{TAB}
address@hidden @key{TAB}
-Enter a tag in the minibuffer, even if the tag is not in the predefined
-list. You will be able to complete on all tags present in the buffer.
address@hidden @key{SPC}
address@hidden @key{SPC}
-Clear all tags for this line.
address@hidden @key{RET}
address@hidden @key{RET}
-Accept the modified set.
address@hidden C-g
-Abort without installing changes.
address@hidden q
-If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
address@hidden !
-Turn off groups of mutually exclusive tags. Use this to (as an
-exception) assign several tags from such a group.
address@hidden C-c
-Toggle auto-exit after the next change (see below).
-If you are using expert mode, the first @kbd{C-c} will display the
-selection window.
address@hidden table
address@hidden Storing notes, Refiling notes, Remember templates, Remember
address@hidden Storing notes
+When you are finished preparing a note with @i{remember}, you have to
+press @kbd{C-c C-c} to file the note away. The handler will store the
+note in the file and under the headline specified in the template, or it
+will use the default file and headlines. The window configuration will
+be restored, sending you back to the working context before the call to
address@hidden To re-use the location found during the last call to
address@hidden, exit the remember buffer with @kbd{C-u C-u C-c C-c},
+i.e. specify a double prefix argument to @kbd{C-c C-c}.
+
+If you want to store the note directly to a different place, use
address@hidden C-c C-c} instead to exit address@hidden the
+variable @code{org-remember-store-without-prompt} to make this behavior
+the default.}. The handler will then first prompt for a target file -
+if you press @key{RET}, the value specified for the template is used.
+Then the command offers the headings tree of the selected file, with the
+cursor position at the default headline (if you had specified one in the
+template). You can either immediately press @key{RET} to get the note
+placed there. Or you can use the following keys to find a different
+location:
address@hidden
address@hidden @r{Cycle visibility.}
address@hidden / @key{up} @r{Next/previous visible headline.}
+n / p @r{Next/previous visible headline.}
+f / b @r{Next/previous headline same level.}
+u @r{One level up.}
address@hidden 0-9 @r{Digit argument.}
address@hidden example
@noindent
-This method lets you assign tags to a headline with very few keys. With
-the above setup, you could clear the current tags and set @samp{@@HOME},
address@hidden and @samp{PC} tags with just the following keys: @kbd{C-c
-C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@HOME} to
address@hidden@@WORK} would be done with @kbd{C-c C-c w @key{RET}} or
-alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag
address@hidden could be done with @kbd{C-c C-c @key{TAB} S a r a h
address@hidden @key{RET}}.
-
-If you find that most of the time, you need only a single keypress to
-modify your list of tags, set the variable
address@hidden Then you no longer have to
-press @key{RET} to exit fast tag selection - it will immediately exit
-after the first change. If you then occasionally need more keys, press
address@hidden to turn off auto-exit for the current tag selection process
-(in effect: start selection with @kbd{C-c C-c C-c} instead of @kbd{C-c
-C-c}). If you set the variable to the value @code{expert}, the special
-window is not even shown for single-key tag selection, it comes up only
-when you press an extra @kbd{C-c}.
+Pressing @key{RET} or @key{left} or @key{right}
+then leads to the following result.
address@hidden Tag searches, , Setting tags, Tags
address@hidden Tag searches
address@hidden tag searches
address@hidden searching for tags
address@hidden @columnfractions 0.2 0.15 0.65
address@hidden @b{Cursor position} @tab @b{Key} @tab @b{Note gets inserted}
address@hidden on headline @tab @key{RET} @tab as sublevel of
the heading at cursor, first or last
address@hidden @tab @tab depending on
@code{org-reverse-note-order}.
address@hidden @tab @key{left}/@key{right} @tab as same level,
before/after current heading
address@hidden buffer-start @tab @key{RET} @tab as level 2 heading at end of
file or level 1 at beginning
address@hidden @tab @tab depending on
@code{org-reverse-note-order}.
address@hidden not on headline @tab @key{RET}
+ @tab at cursor position, level taken from context.
address@hidden multitable
-Once a tags system has been set up, it can be used to collect related
-information into special lists.
+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 you have indented the text of the note below the headline, the
+indentation will be adapted if inserting the note into the tree requires
+demotion from level 1.
+
address@hidden Refiling notes, , Storing notes, Remember
address@hidden Refiling notes
address@hidden refiling notes
+
+Remember is usually used to quickly capture notes and tasks into one or
+a few capture lists. When reviewing the captured data, you may want to
+refile some of the entries into a different list, for example into a
+project. Cutting, finding the right location and then pasting the note
+is cumbersome. To simplify this process, you can use the following
+special command:
@table @kbd
address@hidden C-c \
address@hidden C-c \
-Create a sparse tree with all headlines matching a tags search. With a
address@hidden prefix argument, ignore headlines that are not a TODO line.
address@hidden C-c a m
address@hidden C-c a m
-Create a global list of tag matches from all agenda files.
address@hidden headline tags}.
address@hidden C-c a M
address@hidden 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
address@hidden).
address@hidden table
-
address@hidden Boolean logic, for tag searches
-A @i{tags} search string can use Boolean operators @samp{&} for AND and
address@hidden|} 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. Examples:
-
address@hidden @samp
address@hidden +WORK-BOSS
-Select headlines tagged @samp{:WORK:}, but discard those also tagged
address@hidden:BOSS:}.
address@hidden WORK|LAPTOP
-Selects lines tagged @samp{:WORK:} or @samp{:LAPTOP:}.
address@hidden WORK|LAPTOP&NIGHT
-Like before, but require the @samp{:LAPTOP:} lines to be tagged also
address@hidden
address@hidden table
-
address@hidden TODO keyword matching, with tags search
-If you are using multi-state TODO keywords (@pxref{TODO extensions}), it
-can be useful to also match on the TODO keyword. This can be done by
-adding a condition after a slash to a tags match. The syntax is similar
-to the tag matches, but should be applied with consideration: For
-example, a positive selection on several TODO keywords can not
-meaningfully be combined with boolean AND. However, @emph{negative
-selection} combined with AND can be meaningful. To make sure that only
-lines are checked that actually have any TODO keyword, use @kbd{C-c a
-M}, or equivalently start the todo part after the slash with @samp{!}.
-Examples:
-
address@hidden @samp
address@hidden WORK/WAITING
-Select @samp{:WORK:}-tagged TODO lines with the specific TODO
-keyword @samp{WAITING}.
address@hidden WORK/!-WAITING-NEXT
-Select @samp{:WORK:}-tagged TODO lines that are neither @samp{WAITING}
-nor @samp{NEXT}
address@hidden WORK/+WAITING|+NEXT
-Select @samp{:WORK:}-tagged TODO lines that are either @samp{WAITING} or
address@hidden
address@hidden C-c C-w
address@hidden C-c C-w
+Refile the entry at point. This command offers possible locations for
+refiling the entry and lets you select one with completion. The item is
+filed below the target heading as a subitem. Depending on
address@hidden, it will be either the first of last
address@hidden By default, all level 1 headlines in the current buffer are
+considered to be targets, but you can have more complex definitions
+across a number of files. See the variable @code{org-refile-targets}
+for details.
address@hidden C-u C-c C-w
address@hidden C-u C-c C-w
+Use the refile interface to jump to a heading.
address@hidden C-u C-u C-c C-w
address@hidden C- C-u C-c C-w
+Jump to the location where @code{org-refile} last moved a tree to.
@end table
address@hidden regular expressions, with tags search
-Any element of the tag/todo match can be a regular expression - in this
-case it must be enclosed in curly braces. For example,
address@hidden@address@hidden matches headlines that contain the tag
address@hidden and any tag @i{starting} with @samp{BOSS}.
-
address@hidden level, require for tags match
-You can also require a headline to be of a certain level, by writing
-instead of any TAG an expression like @samp{LEVEL=3}. For example, a
-search @samp{+LEVEL=3+BOSS/-DONE} lists all level three headlines that
-have the tag BOSS and are @emph{not} marked with the todo keyword DONE.
-
address@hidden Agenda views, Embedded LaTeX, Tags, Top
address@hidden Agenda views, Embedded LaTeX, Remember, 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,
+files. To get an overview of open action items, or of 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. Six different view types are provided:
+in a separate buffer. Seven different view types are provided:
@itemize @bullet
@item
@@ -3573,6 +4810,9 @@
a @emph{timeline view} that shows all events in a single Org-mode file,
in time-sorted view,
@item
+a @emph{keyword search view} that shows all entries from multiple files
+that contain specified keywords.
address@hidden
a @emph{stuck projects view} showing projects that currently don't move
along, and
@item
@@ -3605,14 +4845,18 @@
@cindex agenda files
@cindex files for agenda
-The information to be shown is collected from all @emph{agenda files},
-the files listed in the variable @address@hidden 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 address@hidden 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
+The information to be shown is normally collected from all @emph{agenda
+files}, the files listed in the variable
address@hidden@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.}. If a directory is part of this list,
+all files with the extension @file{.org} in this directory will be part
+of the list.
+
+Thus even if you only work with a single Org-mode file, this file should
+be put into that address@hidden using the dispatcher, pressing
address@hidden<} 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
@@ -3637,6 +4881,42 @@
The Org menu contains the current list of files and can be used
to visit any of them.
+If you would like to focus the agenda temporarily onto a file not in
+this list, or onto just one file in the list or even only a subtree in a
+file, this can be done in different ways. For a single agenda command,
+you may press @kbd{<} once or several times in the dispatcher
+(@pxref{Agenda dispatcher}). To restrict the agenda scope for an
+extended period, use the following commands:
+
address@hidden @kbd
address@hidden C-c C-x <
address@hidden C-c C-x <
+Permanently restrict the agenda to the current subtree. When with a
+prefix argument, or with the cursor before the first headline in a file,
+the agenda scope is set to the entire file. This restriction remains in
+effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
+or @kbd{>} in the agenda dispatcher. If there is a window displaying an
+agenda view, the new restriction takes effect immediately.
address@hidden C-c C-x <
address@hidden C-c C-x <
+Remove the permanent restriction created by @kbd{C-c C-x <}.
address@hidden table
+
address@hidden
+When working with @file{Speedbar}, you can use the following commands in
+the speedbar frame:
address@hidden @kbd
address@hidden <
address@hidden < @r{in the speedbar frame}
+Permanently restrict the agenda to the item at the cursor in the
+speedbar frame, either an Org-mode file or a subtree in such a file.
+If there is a window displaying an agenda view, the new restriction takes
+effect immediately.
address@hidden <
address@hidden > @r{in the speedbar frame}
+Lift the restriction again.
address@hidden table
+
@node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda views
@section The agenda dispatcher
@cindex agenda dispatcher
@@ -3654,19 +4934,31 @@
Create a list of all TODO items (@pxref{Global TODO list}).
@item m @r{/} M
Create a list of headlines matching a TAGS expression (@pxref{Matching
-headline tags}).
+tags and properties}).
@item L
Create the timeline view for the current buffer (@pxref{Timeline}).
address@hidden s
+Create a list of entries selected by a boolean expression of keywords
+and/or regular expressions that must or must not occur in the entry.
address@hidden /
+Search for a regular expression in all agenda files and additionally in
+the files listed in @code{org-agenda-multi-occur-extra-files}. This
+uses the Emacs command @code{multi-occur}. A prefix argument can be
+used to specify the number of context lines for each match, default is
+1.
@item # @r{/} !
Create a list of stuck projects (@pxref{Stuck projects}).
address@hidden 1
-Restrict an agenda command to the current buffer. After pressing
address@hidden, you still need to press the character selecting the command.
address@hidden 0
address@hidden <
+Restrict an agenda command to the current address@hidden backward
+compatibility, you can also press @kbd{1} to restrict to the current
+buffer.}. After pressing @kbd{<}, you still need to press the character
+selecting the command.
address@hidden < <
If there is an active region, restrict the following agenda command to
-the region. Otherwise, restrict it to the current subtree. After
-pressing @kbd{0}, you still need to press the character selecting the
-command.
+the region. Otherwise, restrict it to the current address@hidden
+backward compatibility, you can also press @kbd{0} to restrict to the
+current buffer.}. After pressing @kbd{< <}, you still need to press the
+character selecting the command.
@end table
You can also define custom commands that will be accessible through the
@@ -3683,8 +4975,9 @@
@menu
* 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
+* Matching tags and properties:: Structured information with fine-tuned search
* Timeline:: Time-sorted view for single file
+* Keyword search:: Finding entries by keyword
* Stuck projects:: Find projects you need to review
@end menu
@@ -3702,10 +4995,12 @@
@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 address@hidden
+agenda shows the entries for each day. With a numeric
address@hidden backward compatibility, the universal prefix
address@hidden causes all TODO entries to be listed before the agenda. This
+feature is deprecated, use the dedicated TODO list, or a block agenda
+instead.} (like @kbd{C-u 2 1 C-c a a}) you may set the number of days
+to be displayed (see also the variable @code{org-agenda-ndays})
@end table
Remote editing from the agenda buffer means, for example, that you can
@@ -3743,8 +5038,37 @@
calendars, respectively. @kbd{c} can be used to switch back and forth
between calendar and agenda.
+If you are using the diary only for sexp entries and holidays, it is
+faster to not use the above setting, but instead to copy or even move
+the entries into an Org-mode file. Org-mode evaluates diary-style sexp
+entries, and does it faster because there is no overhead for first
+creating the diary display. Note that the sexp entries must start at
+the left margin, no white space is allowed before them. For example,
+the following segment of an Org-mode file will be processed and entries
+will be made in the agenda:
+
address@hidden
+* Birthdays and similar stuff
+#+CATEGORY: Holiday
+%%(org-calendar-holiday) ; special function for holiday names
+#+CATEGORY: Ann
+%%(diary-anniversary 14 5 1956) Arthur Dent is %d years old
+%%(diary-anniversary 2 10 1869) Mahatma Gandhi would be %d years old
address@hidden example
+
address@hidden Appointment reminders
address@hidden @file{appt.el}
address@hidden appointment reminders
+
+Org can interact with Emacs appointments notification facility.
+
+To add all the appointments of your agenda files, use the command
address@hidden This commands also lets you filter through
+the list of your appointments and add only those belonging to a specific
+category or matching a regular expression. See the docstring for
+details.
address@hidden Global TODO list, Matching headline tags, Weekly/Daily agenda,
Built-in agenda views
address@hidden Global TODO list, Matching tags and properties, Weekly/Daily
agenda, Built-in agenda views
@subsection The global TODO list
@cindex global TODO list
@cindex TODO list, global
@@ -3762,10 +5086,12 @@
@kindex C-c a T
@item C-c a T
@cindex TODO keyword matching
-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
address@hidden prefix you are prompted for a keyword. With a numeric
-prefix, the Nth keyword in @code{org-todo-keywords} is selected.
+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, and you may also
+specify several keywords by separating them with @samp{|} as boolean OR
+operator. With a numeric prefix, the Nth keyword in
address@hidden 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,
@@ -3796,9 +5122,10 @@
@code{org-agenda-todo-list-sublevels} to get this behavior.
@end itemize
address@hidden Matching headline tags, Timeline, Global TODO list, Built-in
agenda views
address@hidden Matching headline tags
address@hidden Matching tags and properties, Timeline, Global TODO list,
Built-in agenda views
address@hidden Matching Tags and Properties
@cindex matching, of tags
address@hidden matching, of properties
@cindex tags view
If headlines in the agenda files are marked with @emph{tags}
@@ -3810,8 +5137,8 @@
@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
address@hidden|HOME} (@pxref{Tags}). If you often need a specific search,
+expression with tags, like @samp{+work+urgent-withboss} or
address@hidden|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
@@ -3824,7 +5151,7 @@
The commands available in the tags list are described in @ref{Agenda
commands}.
address@hidden Timeline, Stuck projects, Matching headline tags, Built-in
agenda views
address@hidden Timeline, Keyword search, Matching tags and properties, Built-in
agenda views
@subsection Timeline for a single file
@cindex timeline, single file
@cindex time-sorted view
@@ -3834,7 +5161,7 @@
to give an overview over events in a project.
@table @kbd
address@hidden C-a a L
address@hidden C-c a L
@item C-c a L
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
@@ -3845,8 +5172,36 @@
The commands available in the timeline buffer are listed in
@ref{Agenda commands}.
address@hidden Keyword search, Stuck projects, Timeline, Built-in agenda views
address@hidden Keyword search
address@hidden keyword search
address@hidden searching, for keywords
address@hidden Stuck projects, , Timeline, Built-in agenda views
+This agenda view is a general text search facility for Org-mode entries.
+It is particularly useful to find notes.
+
address@hidden @kbd
address@hidden C-c a s
address@hidden C-c a s
+This is a special search that lets you select entries by keywords or
+regular expression, using a boolean logic. For example, the search
+string
+
address@hidden
++computer +wifi -ethernet address@hidden@}
address@hidden example
+
address@hidden
+will search for note entries that contain the keywords @code{computer}
+and @code{wifi}, but not the keyword @code{ethernet}, and which are also
+not matched by the regular expression @code{8\.11[bg]}, meaning to
+exclude both 8.11b and 8.11g.
+
+Note that in addition to the agenda files, this command will also search
+the files listed in @code{org-agenda-text-search-extra-files}.
address@hidden table
+
address@hidden Stuck projects, , Keyword search, Built-in agenda views
@subsection Stuck projects
If you are following a system like David Allen's GTD to organize your
@@ -3875,16 +5230,18 @@
projects with a tag PROJECT, and that you use a todo keyword MAYBE to
indicate a project that should not be considered yet. Lets further
assume that the todo keyword DONE marks finished projects, and that NEXT
-and TODO indicate next actions. Finally, the tag @@SHOP indicates
-shopping and is a next action even without the NEXT tag. In this case
-you would start by identifying eligible projects with a tags/todo match
address@hidden/-MAYBE-DONE}, and then check for TODO, NEXT and @@SHOP in
-the subtree to identify projects that are not stuck. The correct
-customization for this is
+and TODO indicate next actions. The tag @@SHOP indicates shopping and
+is a next action even without the NEXT tag. Finally, if the project
+contains the special word IGNORE anywhere, it should not be listed
+either. In this case you would start by identifying eligible projects
+with a tags/todo match @samp{+PROJECT/-MAYBE-DONE}, and then check for
+TODO, NEXT, @@SHOP, and IGNORE in the subtree to identify projects that
+are not stuck. The correct customization for this is
@lisp
(setq org-stuck-projects
- ("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")))
+ '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
+ "\\<IGNORE\\>"))
@end lisp
@@ -3912,16 +5269,27 @@
@cindex category
The category is a broad label assigned to each agenda item. By default,
the category is simply derived from the file name, but you can also
-specify it with a special line in the buffer, like this:
+specify it with a special line in the buffer, like address@hidden
+backward compatibility, the following also works: If there are several
+such lines in a file, each specifies the category for the text below it.
+The first category also applies to any text before the first CATEGORY
+line. However, using this method is @emph{strongly} deprecated as it is
+incompatible with the outline structure of the document. The correct
+method for setting multiple categories in a buffer is using a
+property.}:
@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.
address@hidden
+If you would like to have a special CATEGORY for a single entry or a
+(sub)tree, give the entry a @code{:CATEGORY:} property with the location
+as the value (@pxref{Properties and columns}).
+
address@hidden
+The display in the agenda buffer looks best if the category is not
+longer than 10 characters.
@node Time-of-day specifications, Sorting of agenda items, Categories,
Presentation and sorting
@subsection Time-of-Day Specifications
@@ -4021,21 +5389,21 @@
@cindex motion commands in agenda
@kindex n
@item n
-Next line (same as @key{up}).
+Next line (same as @key{up} and @kbd{C-p}).
@kindex p
@item p
-Previous line (same as @key{down}).
+Previous line (same as @key{down} and @kbd{C-n}).
@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.
-
address@hidden
@kindex L
@item L
Display original location and recenter that window.
-
address@hidden
@kindex mouse-2
@kindex mouse-1
@kindex @key{TAB}
@@ -4044,11 +5412,11 @@
@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.
-
address@hidden
@kindex @key{RET}
@itemx @key{RET}
Go to the original location of the item and delete other windows.
-
address@hidden
@kindex f
@item f
Toggle Follow mode. In Follow mode, as you move the cursor through
@@ -4056,14 +5424,14 @@
location in the org file. The initial setting for this mode in new
agenda buffers can be set with the variable
@code{org-agenda-start-with-follow-mode}.
-
address@hidden
@kindex b
@item b
Display the entire subtree of the current item in an indirect buffer.
With numerical prefix ARG, go up to this level and then take that tree.
If ARG is negative, go up that many levels. With @kbd{C-u} prefix, do
not remove the previously used indirect buffer.
-
address@hidden
@kindex l
@item l
Toggle Logbook mode. In Logbook mode, entries that where marked DONE while
@@ -4075,24 +5443,25 @@
@kindex o
@item o
Delete other windows.
-
address@hidden w
address@hidden w
-Switch to weekly view (7 days displayed together).
-
address@hidden
@kindex d
address@hidden d
-Switch to daily view (just one day displayed).
-
address@hidden w
address@hidden m
address@hidden y
address@hidden d w m y
+Switch to day/week/month/year view. When switching to day or week view,
+this setting becomes the default for subseqent agenda commands. Since
+month and year views are slow to create, the do not become the default.
address@hidden
@kindex D
@item D
Toggle the inclusion of diary entries. See @ref{Weekly/Daily agenda}.
-
address@hidden g
address@hidden g
address@hidden
address@hidden G
address@hidden G
Toggle the time grid on and off. See also the variables
@code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
-
address@hidden
@kindex r
@item r
Recreate the agenda buffer, for example to reflect the changes
@@ -4100,77 +5469,100 @@
address@hidden When the buffer is the global todo list, a prefix
argument is interpreted to create a selective list for a specific TODO
keyword.
-
address@hidden g
address@hidden g
+Same as @kbd{r}.
address@hidden
@kindex s
address@hidden C-x C-s
@item s
address@hidden C-x C-s
Save all Org-mode buffers in the current Emacs session.
-
address@hidden
@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.
-
address@hidden
@kindex @key{left}
@item @key{left}
Display the previous dates.
-
address@hidden
@kindex .
@item .
Goto today.
address@hidden editing}
address@hidden query editing, in agenda
+
address@hidden [
address@hidden ]
address@hidden @{
address@hidden @}
address@hidden [ ] @{ @}
+In the @i{search view} (@pxref{Keyword search}), these keys add new
+search words (@kbd{[} and @kbd{]}) or new regular expressions (@address@hidden
+and @address@hidden) to the query string. The opening bracket/brace will add a
+positive search term prefixed by @samp{+}, indicating that this search
+term @i{must} occur/match in the entry. Closing bracket/brace add a
+negative search term which @i{must not} occur/match in the entry for it
+to be selected.
+
+
@tsubheading{Remote editing}
@cindex remote editing, from agenda
@item 0-9
Digit argument.
-
address@hidden
@cindex undoing remote-editing events
@cindex remote editing, undo
@kindex C-_
@item C-_
Undo a change due to a remote editing command. The change is undone
both in the agenda buffer and in the remote buffer.
-
address@hidden
@kindex t
@item t
Change the TODO state of the item, both in the agenda and in the
original org file.
-
address@hidden
@kindex C-k
@item C-k
Delete the current agenda item along with the entire subtree belonging
to it in the original Org-mode file. If the text to be deleted remotely
is longer than one line, the kill needs to be confirmed by the user. See
variable @code{org-agenda-confirm-kill}.
-
address@hidden
@kindex $
@item $
Archive the subtree corresponding to the current headline.
-
address@hidden
@kindex T
@item T
Show all tags associated with the current item. Because of
inheritance, this may be more than the tags listed in the line itself.
-
address@hidden
@kindex :
@item :
-Set tags for the current headline.
-
+Set tags for the current headline. If there is an active region in the
+agenda, change a tag for all headings in the region.
address@hidden
@kindex a
@item a
Toggle the ARCHIVE tag for the current headline.
-
address@hidden
@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.
-
address@hidden
@kindex P
@item P
Display weighted priority of current item.
-
address@hidden
@kindex +
@kindex address@hidden
@item +
@@ -4178,21 +5570,21 @@
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.
-
address@hidden
@kindex -
@kindex address@hidden
@item -
@itemx address@hidden
Decrease the priority of the current item.
-
address@hidden
@kindex C-c C-s
@item C-c C-s
Schedule this item
-
address@hidden
@kindex C-c C-d
@item C-c C-d
Set a deadline for this item.
-
address@hidden
@kindex address@hidden
@item address@hidden
Change the time stamp associated with the current line by one day into
@@ -4201,39 +5593,45 @@
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.
-
address@hidden
@kindex address@hidden
@item address@hidden
Change the time stamp associated with the current line by one day
into the past.
-
address@hidden
@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.
-
address@hidden
@kindex I
@item I
Start the clock on the current item. If a clock is running already, it
is stopped first.
address@hidden
@kindex O
@item O
Stop the previously started clock.
address@hidden
@kindex X
@item X
Cancel the currently running clock.
address@hidden J
address@hidden J
+Jump to the running clock in another window.
+
@tsubheading{Calendar commands}
@cindex calendar commands, from agenda
@kindex c
@item c
Open the Emacs calendar and move to the date at the agenda cursor.
-
address@hidden
@item c
When in the calendar, compute and show the Org-mode agenda for the
date at the cursor.
-
address@hidden
@cindex diary entries, creating from agenda
@kindex i
@item i
@@ -4241,42 +5639,53 @@
(day, weekly, monthly, yearly, anniversary, cyclic) and creates a new
entry in the diary, just as @kbd{i d} etc. would do in the calendar.
The date is taken from the cursor position.
-
address@hidden
@kindex M
@item M
Show the phases of the moon for the three months around current date.
-
address@hidden
@kindex S
@item S
Show sunrise and sunset times. The geographical location must be set
with calendar variables, see documentation of the Emacs calendar.
-
address@hidden
@kindex C
@item C
Convert the date at cursor into many other cultural and historic
calendars.
-
address@hidden
@kindex H
@item H
Show holidays for three month around the cursor date.
-
address@hidden
@c FIXME: This should be a different key.
@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.
address@hidden to a file}
address@hidden C-x C-w
address@hidden C-x C-w
address@hidden exporting agenda views
address@hidden agenda views, exporting
+Write the agenda view to a file. Depending on the extension of the
+selected file name, the view will be exported as HTML (extension
address@hidden or @file{.htm}), Postscript (extension @file{.ps}), or
+plain text (any other extension). Use the variable
address@hidden to set options for @file{ps-print}
+and for @file{htmlize} to be used during export.
+
@tsubheading{Quit and Exit}
@kindex q
@item q
Quit agenda, remove the agenda buffer.
-
address@hidden
@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
@@ -4294,7 +5703,8 @@
* Storing searches:: Type once, use often
* Block agenda:: All the stuff you need in a single buffer
* Setting Options:: Changing the rules
-* Batch processing:: Agenda views from the command line
+* Exporting Agenda Views:: Writing agendas to files.
+* Extracting Agenda Information for other programs::
@end menu
@node Storing searches, Block agenda, Custom agenda views, Custom agenda views
@@ -4316,19 +5726,28 @@
(setq org-agenda-custom-commands
'(("w" todo "WAITING")
("W" todo-tree "WAITING")
- ("u" tags "+BOSS-URGENT")
- ("v" tags-todo "+BOSS-URGENT")
- ("U" tags-tree "+BOSS-URGENT")
- ("f" occur-tree "\\<FIXME\\>")))
+ ("u" tags "+boss-urgent")
+ ("v" tags-todo "+boss-urgent")
+ ("U" tags-tree "+boss-urgent")
+ ("f" occur-tree "\\<FIXME\\>")
+ ("h" . "HOME+Name tags searches") ; description for "h" prefix
+ ("hl" tags "+home+Lisa")
+ ("hp" tags "+home+Peter")
+ ("hk" tags "+home+Kim")))
@end group
@end lisp
@noindent
-The initial single-character string in each entry defines the character
-you have to press after the dispatcher command @kbd{C-c a} in order to
-access the command. The second parameter is the search type, followed
-by the string or regular expression to be used for the matching. The
-example above will therefore define:
+The initial string in each entry defines the keys you have to press
+after the dispatcher command @kbd{C-c a} in order to access the command.
+Usually this will be just a single character, but if you have many
+similar commands, you can also define two-letter combinations where the
+first character is the same in several combinations and serves as a
+prefix address@hidden can provide a description for a prefix key by
+inserting a cons cell with the prefix and the description.}. The second
+parameter is the search type, followed by the string or regular
+expression to be used for the matching. The example above will
+therefore define:
@table @kbd
@item C-c a w
@@ -4338,8 +5757,8 @@
as the same search, but only in the current buffer and displaying the
results as a sparse tree
@item C-c a u
-as a global tags search for headlines marked @samp{:BOSS:} but not
address@hidden:URGENT:}
+as a global tags search for headlines marked @samp{:boss:} but not
address@hidden:urgent:}
@item C-c a v
as the same search as @kbd{C-c a u}, but limiting the search to
headlines that are also TODO items
@@ -4348,7 +5767,11 @@
displaying the result as a sparse tree
@item C-c a f
to create a sparse tree (again: current buffer only) with all entries
-containing the word @samp{FIXME}.
+containing the word @samp{FIXME}
address@hidden C-c a h
+as a prefix command for a HOME tags search where you have to press an
+additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
+Peter, or Kim) as additional tag to match.
@end table
@node Block agenda, Setting Options, Storing searches, Custom agenda views
@@ -4368,13 +5791,13 @@
@group
(setq org-agenda-custom-commands
'(("h" "Agenda and Home-related tasks"
- ((agenda)
- (tags-todo "HOME")
- (tags "GARDEN")))
+ ((agenda "")
+ (tags-todo "home")
+ (tags "garden")))
("o" "Agenda and Office-related tasks"
- ((agenda)
- (tags-todo "WORK")
- (tags "OFFICE")))))
+ ((agenda "")
+ (tags-todo "work")
+ (tags "office")))))
@end group
@end lisp
@@ -4382,11 +5805,10 @@
This will define @kbd{C-c a h} to create a multi-block view for stuff
you need to attend to at home. The resulting agenda buffer will contain
your agenda for the current week, all TODO items that carry the tag
address@hidden, and also all lines tagged with @samp{GARDEN}. Finally the
address@hidden, and also all lines tagged with @samp{garden}. Finally the
command @kbd{C-c a o} provides a similar view for office tasks.
-
address@hidden Setting Options, Batch processing, Block agenda, Custom agenda
views
address@hidden Setting Options, Exporting Agenda Views, Block agenda, Custom
agenda views
@subsection Setting Options for custom commands
@cindex options, for custom agenda views
@@ -4403,19 +5825,23 @@
'(("w" todo "WAITING"
((org-agenda-sorting-strategy '(priority-down))
(org-agenda-prefix-format " Mixed: ")))
- ("U" tags-tree "+BOSS-URGENT"
+ ("U" tags-tree "+boss-urgent"
((org-show-following-heading nil)
- (org-show-hierarchy-above nil)))))
+ (org-show-hierarchy-above nil)))
+ ("N" search ""
+ ((org-agenda-files '("~org/notes.org"))
+ (org-agenda-text-search-extra-files nil)))))
@end group
@end lisp
@noindent
Now the @kbd{C-c a w} command will sort the collected entries only by
-priority, and the prefix format is modified to just say @samp{ Mixed:}
+priority, and the prefix format is modified to just say @samp{ Mixed: }
instead of giving the category of the entry. The sparse tags tree of
@kbd{C-c a U} will now turn out ultra-compact, because neither the
headline hierarchy above the match, nor the headline following the match
-will be shown.
+will be shown. The command @kbd{C-c a N} will do a text search limited
+to only a single file.
For command sets creating a block agenda,
@code{org-agenda-custom-commands} has two separate spots for setting
@@ -4433,13 +5859,14 @@
(setq org-agenda-custom-commands
'(("h" "Agenda and Home-related tasks"
((agenda)
- (tags-todo "HOME")
- (tags "GARDEN" ((org-agenda-sorting-strategy '(priority-up)))))
+ (tags-todo "home")
+ (tags "garden"
+ ((org-agenda-sorting-strategy '(priority-up)))))
((org-agenda-sorting-strategy '(priority-down))))
("o" "Agenda and Office-related tasks"
((agenda)
- (tags-todo "WORK")
- (tags "OFFICE")))))
+ (tags-todo "work")
+ (tags "office")))))
@end group
@end lisp
@@ -4450,36 +5877,241 @@
value is a string, you need to add the double quotes around the value
yourself.
address@hidden Batch processing, , Setting Options, Custom agenda views
address@hidden Creating agenda views in batch processing
address@hidden agenda, batch production
-
-If you want to print or otherwise reprocess agenda views, it can be
-useful to create an agenda from the command line. This is the purpose
-of the function @code{org-batch-agenda}. It takes as a parameter one of
-the strings that are the keys in @code{org-agenda-custom-commands}. For
-example, to directly print the current TODO list, you could use
+
address@hidden Exporting Agenda Views, Extracting Agenda Information for other
programs, Setting Options, Custom agenda views
address@hidden Exporting Agenda Views
address@hidden agenda views, exporting
+
+If you are away from your computer, it can be very useful to have a
+printed version of some agenda views to carry around. Org-mode can
+export custom agenda views as plain text, address@hidden need to
+install Hrvoje Niksic' @file{htmlize.el}.} postscript, and iCalendar
+files. If you want to do this only occasionally, use the command
+
address@hidden @kbd
address@hidden C-x C-w
address@hidden C-x C-w
address@hidden exporting agenda views
address@hidden agenda views, exporting
+Write the agenda view to a file. Depending on the extension of the
+selected file name, the view will be exported as HTML (extension
address@hidden or @file{.htm}), Postscript (extension @file{.ps}),
+iCalendar (extension @file{.ics}), or plain text (any other extension).
+Use the variable @code{org-agenda-exporter-settings} to
+set options for @file{ps-print} and for @file{htmlize} to be used during
+export, for example
+
address@hidden
+(setq org-agenda-exporter-settings
+ '((ps-number-of-columns 2)
+ (ps-landscape-mode t)
+ (htmlize-output-type 'css)))
address@hidden lisp
address@hidden table
+
+If you need to export certain agenda views frequently, you can associate
+any custom agenda command with a list of output file names
address@hidden you want to store standard views like the weekly agenda
+or the global TODO list as well, you need to define custom commands for
+them in order to be able to specify file names.}. Here is an example
+that first does define custom commands for the agenda and the global
+todo list, together with a number of files to which to export them.
+Then we define two block agenda commands and specify file names for them
+as well. File names can be relative to the current working directory,
+or absolute.
+
address@hidden
address@hidden
+(setq org-agenda-custom-commands
+ '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
+ ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
+ ("h" "Agenda and Home-related tasks"
+ ((agenda "")
+ (tags-todo "home")
+ (tags "garden"))
+ nil
+ ("~/views/home.html"))
+ ("o" "Agenda and Office-related tasks"
+ ((agenda)
+ (tags-todo "work")
+ (tags "office"))
+ nil
+ ("~/views/office.ps" "~/calendars/office.ics"))))
address@hidden group
address@hidden lisp
+
+The extension of the file name determines the type of export. If it is
address@hidden, Org-mode will use the @file{htmlize.el} package to convert
+the buffer to HTML and save it to this file name. If the extension is
address@hidden, @code{ps-print-buffer-with-faces} is used to produce
+postscript output. If the extension is @file{.ics}, iCalendar export is
+run export over all files that were used to construct the agenda, and
+limit the export to entries listed in the agenda now. Any other
+extension produces a plain ASCII file.
+
+The export files are @emph{not} created when you use one of those
+commands interactively because this might use too much overhead.
+Instead, there is a special command to produce @emph{all} specified
+files in one step:
+
address@hidden @kbd
address@hidden C-c a e
address@hidden C-c a e
+Export all agenda views that have export file names associated with
+them.
address@hidden table
+
+You can use the options section of the custom agenda commands to also
+set options for the export commands. For example:
+
address@hidden
+(setq org-agenda-custom-commands
+ '(("X" agenda ""
+ ((ps-number-of-columns 2)
+ (ps-landscape-mode t)
+ (org-agenda-prefix-format " [ ] ")
+ (org-agenda-with-colors nil)
+ (org-agenda-remove-tags t))
+ ("theagenda.ps"))))
address@hidden lisp
+
address@hidden
+This command sets two options for the postscript exporter, to make it
+print in two columns in landscape format - the resulting page can be cut
+in two and then used in a paper agenda. The remaining settings modify
+the agenda prefix to omit category and scheduling information, and
+instead include a checkbox to check off items. We also remove the tags
+to make the lines compact, and we don't want to use colors for the
+black-and-white printer. Settings specified in
address@hidden will also apply, but the settings
+in @code{org-agenda-custom-commands} take precedence.
+
address@hidden
+From the command line you may also use
address@hidden
+emacs -f org-batch-store-agenda-views -kill
address@hidden example
address@hidden
+or, if you need to modify some parameters
address@hidden
+emacs -eval '(org-batch-store-agenda-views \
+ org-agenda-ndays 30 \
+ org-agenda-start-day "2007-11-01" \
+ org-agenda-include-diary nil \
+ org-agenda-files (quote ("~/org/project.org")))' \
+ -kill
address@hidden example
address@hidden
+which will create the agenda views restricted to the file
address@hidden/org/project.org}, without diary entries and with 30 days
+extent.
+
address@hidden Extracting Agenda Information for other programs, , Exporting
Agenda Views, Custom agenda views
address@hidden Extracting Agenda Information for other programs
address@hidden agenda, pipe
address@hidden Scripts, for agenda processing
+
+Org-mode provides commands to access agenda information for the command
+line in emacs batch mode. This extracted information can be sent
+directly to a printer, or it can be read by a program that does further
+processing of the data. The first of these commands is the function
address@hidden, that produces an agenda view and sends it as
+ASCII text to STDOUT. The command takes a single string as parameter.
+If the string has length 1, it is used as a key to one of the commands
+you have configured in @code{org-agenda-custom-commands}, basically any
+key you can use after @kbd{C-c a}. For example, to directly print the
+current TODO list, you could use
@example
emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
@end example
+If the parameter is a string with 2 or more characters, it is used as a
+tags/todo match string. For example, to print your local shopping list
+(all items with the tag @samp{shop}, but excluding the tag
address@hidden), you could use
+
address@hidden
+emacs -batch -l ~/.emacs \
+ -eval '(org-batch-agenda "+shop-NewYork")' | lpr
address@hidden example
+
@noindent
You may also modify parameters on the fly like this:
@example
emacs -batch -l ~/.emacs \
-eval '(org-batch-agenda "a" \
- org-agenda-ndays 300 \
+ org-agenda-ndays 30 \
org-agenda-include-diary nil \
org-agenda-files (quote ("~/org/project.org")))' \
| lpr
@end example
@noindent
-which will produce a 300 day agenda, fully restricted to the Org file
+which will produce a 30 day agenda, fully restricted to the Org file
@file{~/org/projects.org}, not even including the diary.
+If you want to process the agenda data in more sophisticated ways, you
+can use the command @code{org-batch-agenda-csv} to get a comma-separated
+list of values for each agenda item. Each line in the output will
+contain a number of fields separated by commas. The fields in a line
+are:
+
address@hidden
+category @r{The category of the item}
+head @r{The headline, without TODO kwd, TAGS and PRIORITY}
+type @r{The type of the agenda entry, can be}
+ todo @r{selected in TODO match}
+ tagsmatch @r{selected in tags match}
+ diary @r{imported from diary}
+ deadline @r{a deadline}
+ scheduled @r{scheduled}
+ timestamp @r{appointment, selected by timestamp}
+ closed @r{entry was closed on date}
+ upcoming-deadline @r{warning about nearing deadline}
+ past-scheduled @r{forwarded scheduled item}
+ block @r{entry has date block including date}
+todo @r{The todo keyword, if any}
+tags @r{All tags including inherited ones, separated by colons}
+date @r{The relevant date, like 2007-2-14}
+time @r{The time, like 15:00-16:50}
+extra @r{String with extra planning info}
+priority-l @r{The priority letter if any was given}
+priority-n @r{The computed numerical priority}
address@hidden example
+
address@hidden
+Time and date will only be given if a timestamp (or deadline/scheduled)
+lead to the selection of the item.
+
+A CSV list like this is very easy to use in a post processing script.
+For example, here is a Perl program that gets the TODO list from
+Emacs/org-mode and prints all the items, preceded by a checkbox:
+
address@hidden
address@hidden
+#!/usr/bin/perl
+
+# define the Emacs command to run
+$cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
+
+# run it and capture the output
+$agenda = address@hidden 2>/dev/address@hidden;
+
+# loop over all lines
+foreach $line (split(/\n/,$agenda)) @{
+
+ # get the individual values
+ ($category,$head,$type,$todo,$tags,$date,$time,$extra,
+ $priority_l,$priority_n) = split(/,/,$line);
+
+ # proccess and print
+ print "[ ] $head\n";
address@hidden
address@hidden group
address@hidden example
+
@node Embedded LaTeX, Exporting, Agenda views, Top
@chapter Embedded LaTeX
@cindex @TeX{} interpretation
@@ -4557,19 +6189,23 @@
With symbols, sub- and superscripts, HTML is pretty much at its end when
it comes to representing mathematical address@hidden, there is
MathML, but that is not yet fully supported by many browsers, and there
-is no decent converter for turning LaTeX of ASCII representations of
+is no decent converter for turning address@hidden or ASCII representations of
formulas into MathML. So for the time being, converting formulas into
-images seems the way to go.}. More complex
-expressions need a dedicated formula processor. To this end, Org-mode
-can contain arbitrary address@hidden fragments. It provides commands to
-preview the typeset result of these fragments, and upon export to HTML,
-all fragments will be converted to images and inlined into the HTML
-document. For this to work you need to be on a system with a working
address@hidden installation. You also need the @file{dvipng} program,
-available at @url{http://sourceforge.net/projects/dvipng/}.
+images seems the way to go.}. More complex expressions need a dedicated
+formula processor. To this end, Org-mode can contain arbitrary address@hidden
+fragments. It provides commands to preview the typeset result of these
+fragments, and upon export to HTML, all fragments will be converted to
+images and inlined into the HTML address@hidden address@hidden export
+will not use images for displaying address@hidden fragments but include these
+fragments directly into the address@hidden code.}. For this to work you
+need to be on a system with a working address@hidden installation. You also
+need the @file{dvipng} program, available at
address@hidden://sourceforge.net/projects/dvipng/}. The address@hidden header
that
+will be used when processing a fragment can be configured with the
+variable @code{org-format-latex-header}.
address@hidden fragments don't need any special marking at all. The following
-snippets will be identified as LaTeX source code:
+snippets will be identified as address@hidden source code:
@itemize @bullet
@item
Environments of any kind. The only requirement is that the
@@ -4635,7 +6271,7 @@
@cindex CDLaTeX
CDLaTeX-mode is a minor mode that is normally used in combination with a
-major LaTeX mode like AUCTeX in order to speed-up insertion of
+major address@hidden mode like AUCTeX in order to speed-up insertion of
environments and math templates. Inside Org-mode, you can make use of
some of the features of cdlatex-mode. You need to install
@file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
@@ -4658,7 +6294,7 @@
@item
@kindex @key{TAB}
The @key{TAB} key will do template expansion if the cursor is inside a
-LaTeX address@hidden has a method to test if the cursor is
address@hidden address@hidden has a method to test if the cursor is
inside such a fragment, see the documentation of the function
@code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will
expand @code{fr} to @address@hidden@address@hidden@}} and position the cursor
@@ -4671,7 +6307,7 @@
@item
@kindex _
@kindex ^
-Pressing @kbd{_} and @kbd{^} inside a LaTeX fragment will insert these
+Pressing @kbd{_} and @kbd{^} inside a address@hidden fragment will insert these
characters together with a pair of braces. If you use @key{TAB} to move
out of the braces, and if the braces surround only a single character or
macro, they are removed again (depending on the variable
@@ -4679,7 +6315,7 @@
@item
@kindex `
Pressing the backquote @kbd{`} followed by a character inserts math
-macros, also outside LaTeX fragments. If you wait more than 1.5 seconds
+macros, also outside address@hidden fragments. If you wait more than 1.5
seconds
after the backquote, a help window will pop up.
@item
@kindex '
@@ -4698,11 +6334,12 @@
printing and sharing of notes, ASCII export produces a readable and
simple version of an Org-mode file. HTML export allows you to publish a
notes file on the web, while the XOXO format provides a solid base for
-exchange with a broad range of other applications. 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. Currently Org-mode only supports export, not
-import of these different formats.
+exchange with a broad range of other applications. address@hidden export lets
+you use Org-mode and its structured editing functions to easily create
address@hidden 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. Currently
+Org-mode only supports export, not import of these different formats.
When exporting, Org-mode uses special conventions to enrich the output
produced. @xref{Text interpretation}, for more details.
@@ -4718,6 +6355,7 @@
@menu
* ASCII export:: Exporting to plain ASCII
* HTML export:: Exporting to HTML
+* LaTeX export:: Exporting to LaTeX
* XOXO export:: Exporting to XOXO
* iCalendar export:: Exporting in iCalendar format
* Text interpretation:: How the exporter looks at the file
@@ -4736,10 +6374,13 @@
@table @kbd
@kindex C-c C-e a
@item C-c C-e 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
+Export as ASCII file. For an org file @file{myfile.org}, the ASCII file
will be @file{myfile.txt}. The file will be overwritten without
-warning.
+warning. If there is an active region, only the region will be
+exported. If the selected region is a single tree, the tree head will
+become the document title. If the tree head entry has or inherits an
address@hidden:EXPORT_FILE_NAME:} property, that name will be used for the
+export.
@kindex C-c C-e v a
@item C-c C-e v a
Export only the visible part of the document.
@@ -4764,7 +6405,7 @@
the layout relative to the first line. Should there be lines with less
indentation than the first, these are left alone.
address@hidden HTML export, XOXO export, ASCII export, Exporting
address@hidden HTML export, LaTeX export, ASCII export, Exporting
@section HTML export
@cindex HTML export
@@ -4773,14 +6414,14 @@
language, but with additional support for tables.
@menu
-* Export commands:: How to invode HTML export
+* HTML Export commands:: How to invoke LaTeX export
* Quoting HTML tags:: Using direct HTML in Org-mode
-* Links:: How hyperlinks get transferred to HTML
-* Images:: To inline or not to inline?
-* CSS support:: Style specifications
+* Links:: Transformation of links for HTML
+* Images:: How to include images
+* CSS support:: Changing the appearence of the output
@end menu
address@hidden Export commands, Quoting HTML tags, HTML export, HTML export
address@hidden HTML Export commands, Quoting HTML tags, HTML export, HTML export
@subsection HTML export commands
@cindex region, active
@@ -4789,15 +6430,40 @@
@table @kbd
@kindex C-c C-e h
@item C-c C-e h
-Export as HTML file @file{myfile.html}.
+Export as HTML file @file{myfile.html}. For an org file
address@hidden, the ASCII file will be @file{myfile.html}. The file
+will be overwritten without warning. If there is an active region, only
+the region will be exported. If the selected region is a single tree,
+the tree head will become the document title. If the tree head entry
+has or inherits an @code{:EXPORT_FILE_NAME:} property, that name will be
+used for the export.
@kindex C-c C-e b
@item C-c C-e b
-Export as HTML file and open it with a browser.
+Export as HTML file and immediately open it with a browser.
address@hidden C-c C-e H
address@hidden C-c C-e H
+Export to a temporary buffer, do not create a file.
address@hidden C-c C-e R
address@hidden C-c C-e R
+Export the active region to a temporary buffer. With prefix arg, do not
+produce file header and foot, but just the plain HTML section for the
+region. This is good for cut-and-paste operations.
@kindex C-c C-e v h
@kindex C-c C-e v b
address@hidden C-c C-e v H
address@hidden C-c C-e v R
@item C-c C-e v h
@item C-c C-e v b
address@hidden C-c C-e v H
address@hidden C-c C-e v R
Export only the visible part of the document.
address@hidden M-x org-export-region-as-html
+Convert the region to HTML under the assumption that it was org-mode
+syntax before. This is a global command that can be invoked in any
+buffer.
address@hidden M-x org-replace-region-by-HTML
+Replace the active region (assumed to be in Org-mode syntax) by HTML
+code.
@end table
@cindex headline levels, for exporting
@@ -4813,7 +6479,7 @@
@noindent
creates two levels of headings and does the rest as items.
address@hidden Quoting HTML tags, Links, Export commands, HTML export
address@hidden Quoting HTML tags, Links, HTML Export commands, HTML export
@subsection Quoting HTML tags
Plain @samp{<} and @samp{>} are always transformed to @samp{<} and
@@ -4917,7 +6583,96 @@
@c FIXME: More about header and footer styles
@c FIXME: Talk about links and targets.
address@hidden XOXO export, iCalendar export, HTML export, Exporting
address@hidden LaTeX export, XOXO export, HTML export, Exporting
address@hidden LaTeX export
address@hidden LaTeX export
+
+Org-mode contains a address@hidden exporter written by Bastien Guerry.
+
address@hidden
+* LaTeX export commands:: How to invoke LaTeX export
+* Quoting LaTeX code:: Incorporating literal LaTeX code
+* Sectioning structure::
address@hidden menu
+
address@hidden LaTeX export commands, Quoting LaTeX code, LaTeX export, LaTeX
export
address@hidden LaTeX export commands
+
address@hidden @kbd
address@hidden C-c C-e l
address@hidden C-c C-e l
+Export as address@hidden file @file{myfile.tex}.
address@hidden C-c C-e L
address@hidden C-c C-e L
+Export to a temporary buffer, do not create a file.
address@hidden C-c C-e v l
address@hidden C-c C-e v L
address@hidden C-c C-e v l
address@hidden C-c C-e v L
+Export only the visible part of the document.
address@hidden M-x org-export-region-as-latex
+Convert the region to address@hidden under the assumption that it was org-mode
+syntax before. This is a global command that can be invoked in any
+buffer.
address@hidden M-x org-replace-region-by-latex
+Replace the active region (assumed to be in Org-mode syntax) by address@hidden
+code.
address@hidden table
+
address@hidden 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 description lists. The exporter can ignore them or
+convert them to a custom string depending on
address@hidden
+
+If you want that transition to occur at a different level, specify it
+with a prefix argument. For example,
+
address@hidden
address@hidden C-c C-e l}
address@hidden example
+
address@hidden
+creates two levels of headings and does the rest as items.
+
address@hidden Quoting LaTeX code, Sectioning structure, LaTeX export commands,
LaTeX export
address@hidden Quoting LaTeX code
+
+Embedded address@hidden as described in @ref{Embedded LaTeX} will be correctly
+inserted into the address@hidden file. Forthermore, you can add special code
+that should only be present in address@hidden export with the following
+constructs:
+
address@hidden
+#+LaTeX: Literal LaTeX code for export
address@hidden example
+
address@hidden or
+
address@hidden
+#+BEGIN_LaTeX
+All lines between these markers are exported literally
+#+END_LaTeX
address@hidden example
+
+
+
address@hidden Sectioning structure, , Quoting LaTeX code, LaTeX export
address@hidden Sectioning structure
address@hidden LaTeX class
address@hidden LaTeX sectioning structure
+
+By default, the address@hidden output uses the class @code{article}.
+
+You can change this globally by setting a different value for
address@hidden or locally by adding an option
+like @code{#+LaTeX_CLASS: myclass} in your file. The class should be
+listed in @code{org-export-latex-classes}, where you can also define the
+sectioning structure for each class.
+
+
address@hidden XOXO export, iCalendar export, LaTeX export, Exporting
@section XOXO export
@cindex XOXO export
@@ -4963,6 +6718,11 @@
@code{org-combined-agenda-icalendar-file}.
@end table
+The export will honor SUMMARY, DESCRIPTION and LOCATION properties if
+the selected entries have them. If not, the summary will be derived
+from the headline, and the description from the body (limited to
address@hidden characters).
+
How this calendar is best read and updated, depends on the application
you are using. The FAQ covers this issue.
@@ -4975,19 +6735,21 @@
@menu
* Comment lines:: Some lines will not be exported
+* Initial text:: Text before the first headline
+* Footnotes:: Numbers like [1]
+* Quoted examples:: Inserting quoted chnuks of text
* Enhancing text:: Subscripts, symbols and more
* Export options:: How to influence the export settings
@end menu
address@hidden Comment lines, Enhancing text, Text interpretation, Text
interpretation
address@hidden Comment lines, Initial text, Text interpretation, Text
interpretation
@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.
+word @samp{COMMENT} will never be exported.
@table @kbd
@kindex C-c ;
@@ -4995,15 +6757,112 @@
Toggle the COMMENT keyword at the beginning of an entry.
@end table
address@hidden Enhancing text, Export options, Comment lines, Text
interpretation
address@hidden Initial text, Footnotes, Comment lines, Text interpretation
address@hidden Text before the first headline
+
+Org-mode normally ignores any text before the first headline when
+exporting, leaving this region for internal links to speed up navigation
+etc. However, in publishing-oriented files, you might want to have some
+text before the first headline, like a small introduction, special HTML
+code with a navigation bar, etc. You can ask to have this part of the
+file exported as well by setting the variable
address@hidden to @code{nil}. On a
+per-file basis, you can get the same effect with
+
address@hidden
+#+OPTIONS: skip:nil
address@hidden example
+
+The text before the first headline will be fully processed
+(@pxref{Enhancing text}), and the first non-comment line becomes the
+title of the exported document. If you need to include literal HTML,
+use the special constructs described in @ref{Quoting HTML tags}. The
+table of contents is normally inserted directly before the first
+headline of the file. If you would like to get it to a different
+location, insert the string @code{[TABLE-OF-CONTENTS]} on a line by
+itself at the desired location.
+
+Finally, if you want to use the space before the first headline for
+internal purposes, but @emph{still} want to place something before the
+first headline when exporting the file, you can use the @code{#+TEXT}
+construct:
+
address@hidden
+#+OPTIONS: skip:t
+#+TEXT: This text will go before the *first* headline.
+#+TEXT: We place the table of contents here:
+#+TEXT: [TABLE-OF-CONTENTS]
+#+TEXT: This goes between the table of contents and the first headline
address@hidden example
+
address@hidden Footnotes, Quoted examples, Initial text, Text interpretation
address@hidden Footnotes
address@hidden footnotes
address@hidden @file{footnote.el}
+
+Numbers in square brackets are treated as footnotes, so that you can use
+the Emacs package @file{footnote.el} to create footnotes. For example:
+
address@hidden
+The org-mode homepage[1] clearly needs help from
+a good web designer.
+
+[1] The link is: http://orgmode.org
address@hidden example
+
address@hidden
address@hidden C-c !
+Note that the @file{footnote} package uses @kbd{C-c !} to invoke its
+commands. This binding conflicts with the org-mode command for
+inserting inactive time stamps. You could use the variable
address@hidden to switch footnotes commands to another key. Or,
+if you are too used to this binding, you could use
address@hidden and @code{org-disputed-keys} to change
+the settings in Org-mode.
+
address@hidden Quoted examples, Enhancing text, Footnotes, Text interpretation
address@hidden Quoted examples
address@hidden quoted examples
address@hidden examples, quoted
address@hidden text, fixed width
address@hidden fixed width text
+
+When writing technical documents, you often need to insert examples that
+are not further interpreted by Org-mode. For historical reasons, there
+are several ways to do this:
+
address@hidden @bullet
address@hidden
+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.
address@hidden
+Lines starting with @samp{:} are also typeset in fixed-width font.
address@hidden @kbd
address@hidden C-c :
address@hidden C-c :
+Toggle fixed-width for entry (QUOTE) or region, see below.
address@hidden table
address@hidden
+Finally, text between
address@hidden
+#+BEGIN_EXAMPLE
+quoted text
+#+END_EXAMPLE
address@hidden example
+will also be exported in this way.
address@hidden itemize
+
+
address@hidden Enhancing text, Export options, Quoted examples, Text
interpretation
@subsection Enhancing text for export
@cindex enhancing text
@cindex richer text
Some of the export backends of Org-mode allow for sophisticated text
-formatting, this is true in particular for the HTML backend. Org-mode
-has a number of typing conventions that allow to produce a richly
-formatted output.
+formatting, this is true in particular for the HTML and address@hidden
+backends. Org-mode has a number of typing conventions that allow to
+produce a richly formatted output.
@itemize @bullet
@@ -5017,9 +6876,12 @@
@cindex underlined text
@cindex bold text
@cindex italic text
address@hidden verbatim text
@item
-You can make words @b{*bold*}, @i{/italic/}, _underlined_,
address@hidden, and @samp{+strikethrough+}.
+You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=}
+and @code{~verbatim~}, and, if you must, @samp{+strikethrough+}. Text
+in the code and verbatim string is not processed for org-mode specific
+syntax, it is exported verbatim.
@cindex horizontal rules, in exported files
@item
@@ -5042,22 +6904,38 @@
@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.
+codes etc. Lines starting with @samp{:} are also typeset in fixed-width
+font.
@table @kbd
@kindex C-c :
@item C-c :
Toggle fixed-width for entry (QUOTE) or region, see below.
@end table
+Finally, text between
address@hidden
+#+BEGIN_EXAMPLE
+quoted text
+#+END_EXAMPLE
address@hidden example
+will also be exported in this way.
@cindex linebreak, forced
@item
A double backslash @emph{at the end of a line} enforces a line break at
this position.
+
address@hidden HTML entities, LaTeX entities
address@hidden
+Strings like @code{\alpha} will be exported as @code{α}, in the
+HTML output. These strings are exported as @code{$\alpha$} in the
address@hidden output. Similarly, @code{\nbsp} will become @code{ } in
+HTML and in address@hidden This applies for a long list of entities, see
+the variable @code{org-html-entities} for the complete list.
address@hidden FIXME
@end itemize
If these conversions conflict with your habits of typing ASCII text,
-they can all be turned off with corresponding variables (see the
+they can all be turned off with corresponding variables. See the
customization group @code{org-export-general}, and the following section
which explains how to set export options with special lines in a
buffer.
@@ -5084,11 +6962,12 @@
@example
#+TITLE: the title to be shown (default is the buffer name)
#+AUTHOR: the author (default taken from @code{user-full-name})
+#+DATE: A date, fixed, of a format string for @code{format-time-string}
#+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 LaTeX:t
+#+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ...
@end example
@noindent
@@ -5102,9 +6981,13 @@
@cindex fixed-width sections
@cindex tables
@cindex @TeX{}-like syntax for sub- and superscripts
address@hidden footnotes
address@hidden special strings
@cindex emphasized text
@cindex @TeX{} macros
@cindex address@hidden fragments
address@hidden author info, in export
address@hidden time info, in export
@example
H: @r{set the number of headline levels for export}
num: @r{turn on/off section-numbers}
@@ -5113,26 +6996,42 @@
@@: @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 @TeX{}-like syntax for sub- and superscripts. If}
+ @r{you write "^:@address@hidden", @address@hidden@}} will be
interpreted, but}
+ @r{the simple @code{a_b} will be left as it is.}
+-: @r{turn on/off conversion of special strings.}
+f: @r{turn on/off foototes like this[1].}
*: @r{turn on/off emphasized text (bold, italic, underlined)}
TeX: @r{turn on/off simple @TeX{} macros in plain text}
LaTeX: @r{turn on/off address@hidden fragments}
+skip: @r{turn on/off skipping the text before the first heading}
+author: @r{turn on/off inclusion of author name/email into exported file}
+timestamp: @r{turn on/off inclusion creation time into exported file}
+d: @r{turn on/off inclusion of drawers}
@end example
+These options take effect in both the HTML and address@hidden export, except
+for @code{TeX} and @code{LaTeX}, which are respectively @code{t} and
address@hidden for the address@hidden export.
+
@node Publishing, Miscellaneous, Exporting, Top
@chapter Publishing
@cindex publishing
-Org-mode address@hidden@file{org-publish.el} is not yet part of
-Emacs, so if you are using @file{org.el} as it comes with Emacs, you
-need to download this file separately. Also make sure org.el is at
-least version 4.27.} a publishing management system
-that allows you to configure automatic HTML conversion of
address@hidden composed of interlinked org files. This system is
-called @emph{org-publish}. You can also configure org-publish to
-automatically upload your exported HTML pages and related attachments,
-such as images and source code files, to a web server. Org-publish turns
-org-mode into a web-site authoring tool.
+Org-mode address@hidden@file{org-publish.el} is not distributed with
+Emacs 21, if you are still using Emacs 21, you need you need to download
+this file separately.} a publishing management system that allows you to
+configure automatic HTML conversion of @emph{projects} composed of
+interlinked org files. This system is called @emph{org-publish}. You can
+also configure org-publish to automatically upload your exported HTML
+pages and related attachments, such as images and source code files, to
+a web server. Org-publish turns org-mode into a web-site authoring tool.
+
+You can also use Org-publish to convert files into address@hidden, or even
+combine HTML and address@hidden conversion so that files are available in both
+formats on the address@hidden address@hidden files on a server are not
+that helpful, you surely want to perform further conversion on them --
+e.g. convert them to @code{PDF} format.}.
Org-publish has been contributed to Org-mode by David O'Toole.
@@ -5235,9 +7134,11 @@
possibly transformed in the process. The default transformation is to
export Org-mode files as HTML files, and this is done by the function
@code{org-publish-org-to-html} which calls the HTML exporter
-(@pxref{HTML export}). Other files like images only need to be copied
-to the publishing destination. For non-Org-mode files, you need to
-specify the publishing function.
+(@pxref{HTML export}). But you also can publish your files in address@hidden by
+using the function @code{org-publish-org-to-latex} instead. Other files
+like images only need to be copied to the publishing destination. For
+non-Org-mode files, you need to specify the publishing function.
+
@multitable @columnfractions 0.3 0.7
@item @code{:publishing-function}
@@ -5254,13 +7155,13 @@
@code{org-publish-attachment}.
@node Publishing options, Publishing links, Publishing action, Configuration
address@hidden Options for the HTML exporter
address@hidden Options for the HTML/LaTeX exporters
@cindex options, for publishing
The property list can be used to set many export options for the HTML
-exporter. In most cases, these properties correspond to user variables
-in Org-mode. The table below lists these properties along with the
-variable they belong to. See the documentation string for the
+and address@hidden exporters. In most cases, these properties correspond to
user
+variables in Org-mode. The table below lists these properties along
+with the variable they belong to. See the documentation string for the
respective variable for details.
@multitable @columnfractions 0.3 0.7
@@ -5271,6 +7172,7 @@
@item @code{:archived-trees} @tab @code{org-export-with-archived-trees}
@item @code{:emphasize} @tab @code{org-export-with-emphasize}
@item @code{:sub-superscript} @tab
@code{org-export-with-sub-superscripts}
address@hidden @code{:special-strings} @tab
@code{org-export-with-special-strings}
@item @code{:TeX-macros} @tab @code{org-export-with-TeX-macros}
@item @code{:LaTeX-fragments} @tab @code{org-export-with-LaTeX-fragments}
@item @code{:fixed-width} @tab @code{org-export-with-fixed-width}
@@ -5292,9 +7194,16 @@
@item @code{:email} @tab @code{user-mail-address}
@end multitable
-When a property is given a value in org-publish-project-alist, its
-setting overrides the value of the corresponding user variable (if any)
-during publishing. options set within a file (@pxref{Export
+If you use several email addresses, separate them by a semi-column.
+
+Most of the @code{org-export-with-*} variables have the same effect in
+both HTML and address@hidden exporters, except for @code{:TeX-macros} and
address@hidden:LaTeX-fragments}, respectively @code{nil} and @code{t} in the
address@hidden export.
+
+When a property is given a value in @code{org-publish-project-alist},
+its setting overrides the value of the corresponding user variable (if
+any) during publishing. Options set within a file (@pxref{Export
options}), however, override everything.
@node Publishing links, Project page index, Publishing options, Configuration
@@ -5310,7 +7219,7 @@
You may also link to related files, such as images. Provided you are
careful with relative pathnames, and provided you have also configured
-org-publish to upload the related files, these links will work
address@hidden to upload the related files, these links will work
too. @ref{Complex example} for an example of this usage.
Sometime an Org-mode file to be published may contain links that are
@@ -5444,13 +7353,13 @@
following functions:
@table @kbd
address@hidden C-c C-e c
address@hidden C-c C-e C
Prompt for a specific project and publish all files that belong to it.
address@hidden C-c C-e p
address@hidden C-c C-e P
Publish the project containing the current file.
address@hidden C-c C-e f
address@hidden C-c C-e F
Publish only the current file.
address@hidden C-c C-e a
address@hidden C-c C-e A
Publish all projects.
@end table
@@ -5479,6 +7388,7 @@
@cindex completion, of dictionary words
@cindex completion, of option keywords
@cindex completion, of tags
address@hidden completion, of property keys
@cindex completion, of link abbreviations
@cindex @TeX{} symbol completion
@cindex TODO keywords completion
@@ -5504,10 +7414,14 @@
After @samp{*}, complete headlines in the current buffer so that they
can be used in search links like @samp{[[*find this headline]]}.
@item
-After @samp{:}, complete tags. The list of tags is taken from the
-variable @code{org-tag-alist} (possibly set through the @samp{#+TAGS}
-in-buffer option, @pxref{Setting tags}), or it is created dynamically
-from all tags used in the current buffer.
+After @samp{:} in a headline, complete tags. The list of tags is taken
+from the variable @code{org-tag-alist} (possibly set through the
address@hidden in-buffer option, @pxref{Setting tags}), or it is created
+dynamically from all tags used in the current buffer.
address@hidden
+After @samp{:} and not in a headline, complete property keys. The list
+of keys is constructed dynamically from all keys used in the current
+buffer.
@item
After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
@item
@@ -5553,8 +7467,40 @@
when the file is visited again in a new Emacs session.
@table @kbd
address@hidden #+ARCHIVE: %s_done::
+This line sets the archive location for the agenda file. It applies for
+all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
+of the file. The first such line also applies to any entries before it.
+The corresponding variable is @code{org-archive-location}.
address@hidden #+CATEGORY:
+This line sets the category for the agenda file. The category applies
+for all subsequent lines until the next @samp{#+CATEGORY} line, or the
+end of the file. The first such line also applies to any entries before it.
address@hidden #+COLUMNS: %25ITEM .....
+Set the default format for columns view. This format applies when
+columns view is invoked in location where no @code{COLUMNS} property
+applies.
address@hidden #+CONSTANTS: name1=value1 ...
+Set file-local values for constants to be used in table formulas. This
+line set the local variable @code{org-table-formula-constants-local}.
+The global version of this variable is
address@hidden
address@hidden #+DRAWERS: NAME1 .....
+Set the file-local set of drawers. The corresponding global variable is
address@hidden
address@hidden #+LINK: linkword replace
+These lines (several are allowed) specify link abbreviations.
address@hidden abbreviations}. The corresponding variable is
address@hidden
address@hidden #+PRIORITIES: highest lowest default
+This line sets the limits and the default for the priorities. All three
+must be either letters A-Z or numbers 0-9. The highest priority must
+have a lower ASCII number that the lowest priority.
address@hidden #+PROPERTY: Property_Name Value
+This line sets a default inheritance value for entries in the current
+buffer, most useful for specifying the allowed values of a property.
@item #+STARTUP:
-This line sets options to be used at startup of org-mode, when an
+This line sets options to be used at startup of Org-mode, when an
Org-mode file is being visited. The first set of options deals with the
initial visibility of the outline tree. The corresponding variable for
global default settings is @code{org-startup-folded}, with a default
@@ -5577,19 +7523,26 @@
align @r{align all tables}
noalign @r{don't align tables on startup}
@end example
-Logging TODO state changes and clock intervals (variable
address@hidden) can be configured using these options.
+Logging closing and reinstating TODO items, and clock intervals
+(variables @code{org-log-done}, @code{org-log-note-clock-out}, and
address@hidden) can be configured using these options.
@cindex @code{logdone}, STARTUP keyword
address@hidden @code{nologging}, STARTUP keyword
@cindex @code{lognotedone}, STARTUP keyword
address@hidden @code{nologdone}, STARTUP keyword
@cindex @code{lognoteclock-out}, STARTUP keyword
address@hidden @code{lognotestate}, STARTUP keyword
address@hidden @code{nolognoteclock-out}, STARTUP keyword
address@hidden @code{logrepeat}, STARTUP keyword
address@hidden @code{lognoterepeat}, STARTUP keyword
address@hidden @code{nologrepeat}, STARTUP keyword
@example
-logging @r{record a timestamp when an item is marked DONE}
-nologging @r{don't record when items are marked DONE}
+logdone @r{record a timestamp when an item is marked DONE}
lognotedone @r{record timestamp and a note when DONE}
-lognotestate @r{record timestamp, note when TODO state changes}
-lognoteclock-out @r{record timestamp and a note when clocking out}
+nologdone @r{don't record when items are marked DONE}
+logrepeat @r{record a time when reinstating a repeating item}
+lognoterepeat @r{record a note when reinstating a repeating item}
+nologrepeat @r{do not record when reinstating repeating item}
+lognoteclock-out @r{record a note when clocking out}
+nolognoteclock-out @r{don't record a note when clocking out}
@end example
Here are the options for hiding leading stars in outline headings. The
corresponding variables are @code{org-hide-leading-stars} and
@@ -5612,32 +7565,27 @@
@example
customtime @r{overlay custom time format}
@end example
address@hidden #+SEQ_TODO: #+TYP_TODO:
-These lines set the TODO keywords and their interpretation in the
-current file. The corresponding variables are @code{org-todo-keywords}
-and @code{org-todo-interpretation}.
+The following options influence the table spreadsheet (variable
address@hidden).
address@hidden @code{constcgs}, STARTUP keyword
address@hidden @code{constSI}, STARTUP keyword
address@hidden
+constcgs @address@hidden should use the c-g-s unit system}
+constSI @address@hidden should use the SI unit system}
address@hidden example
@item #+TAGS: TAG1(c1) TAG2(c2)
These lines (several such lines are allowed) specify the valid tags in
this file, and (potentially) the corresponding @emph{fast tag selection}
keys. The corresponding variable is @code{org-tag-alist}.
address@hidden #+LINK: linkword replace
-These lines (several are allowed) specify link abbreviations.
address@hidden abbreviations}. The corresponding variable is
address@hidden
address@hidden #+CATEGORY:
-This line sets the category for the agenda file. The category applies
-for all subsequent lines until the next @samp{#+CATEGORY} line, or the
-end of the file. The first such line also applies to any entries before it.
address@hidden #+ARCHIVE: %s_done::
-This line sets the archive location for the agenda file. It applies for
-all subsequent lines until the next @samp{#+CATEGORY} line, or the end
-of the file. The first such line also applies to any entries before it.
-The corresponding variable is @code{org-archive-location}.
@item #+TBLFM:
This line contains the formulas for the table directly above the line.
address@hidden #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS:
address@hidden #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS,
#+DATE:
These lines provide settings for exporting files. For more details see
@ref{Export options}.
address@hidden #+SEQ_TODO: #+TYP_TODO:
+These lines set the TODO keywords and their interpretation in the
+current file. The corresponding variables are @code{org-todo-keywords}
+and @code{org-todo-interpretation}.
@end table
@node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous
@@ -5677,11 +7625,17 @@
If the cursor is on a @code{<<<target>>>}, update radio targets and
corresponding links in this buffer.
@item
+If the cursor is in a property line or at the start or end of a property
+drawer, offer property commands.
address@hidden
If the cursor is in a plain list item with a checkbox, toggle the status
of the checkbox.
@item
If the cursor is on a numbered item in a plain list, renumber the
ordered list.
address@hidden
+If the cursor is on the @code{#+BEGIN} line of a dynamical block, the
+block is updated.
@end itemize
@node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous
@@ -5789,18 +7743,17 @@
@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
address@hidden, 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 @address@hidden keys. On a tty you would
-rather use @kbd{C-c .} to re-insert the timestamp.
+Because Org-mode contains a large number of commands, by default much of
+Org-mode's core commands are bound to keys that are generally not
+accessible on a tty, such as the cursor keys (@key{left}, @key{right},
address@hidden, @key{down}), @key{TAB} and @key{RET}, in particular when used
+together with modifiers like @key{Meta} and/or @key{Shift}. To access
+these commands on a tty when special keys are unavailable, the following
+alternative bindings can be used. The tty bindings below will likely be
+more cumbersome; you may find for some of the bindings below that a
+customized work-around suits you better. For example, changing a time
+stamp is really only fun with @address@hidden keys, whereas 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}
@@ -5816,10 +7769,12 @@
@item @address@hidden @tab @kbd{C-c C-x c} @tab
@item @address@hidden @tab @kbd{C-c C-x m} @tab @address@hidden
@key{RET}}
@item @address@hidden @tab @kbd{C-c C-x M} @tab
address@hidden @address@hidden @tab @kbd{C-c C-x @key{left}} @tab
address@hidden @address@hidden @tab @kbd{C-c C-x @key{right}} @tab
address@hidden @address@hidden @tab @kbd{C-c C-x @key{up}} @tab
address@hidden @address@hidden @tab @kbd{C-c C-x @key{down}} @tab
address@hidden @address@hidden @tab @kbd{C-c @key{left}} @tab
address@hidden @address@hidden @tab @kbd{C-c @key{right}} @tab
address@hidden @address@hidden @tab @kbd{C-c @key{up}} @tab
address@hidden @address@hidden @tab @kbd{C-c @key{down}} @tab
address@hidden @address@hidden @tab @kbd{C-c C-x @key{left}} @tab
address@hidden @address@hidden @tab @kbd{C-c C-x @key{right}} @tab
@end multitable
@node Interaction, Bugs, TTY keys, Miscellaneous
@@ -5863,10 +7818,27 @@
@cindex @file{cdlatex.el}
Org-mode can make use of the cdlatex package to efficiently enter
address@hidden fragments into Org-mode files. See @ref{CDLaTeX mode}.
address@hidden @file{imenu.el} by Ake Stenhoff and Lars Lindberg
address@hidden @file{imenu.el}
+Imenu allows menu access to an index of items in a file. Org-mode
+supports imenu - all you need to do to get the index is the following:
address@hidden
+(add-hook 'org-mode-hook
+ (lambda () 'imenu-add-to-menubar "Imenu"))
address@hidden lisp
+By default the index is two levels deep - you can modify the depth using
+the option @code{org-imenu-depth}.
@item @file{remember.el} by John Wiegley
@cindex @file{remember.el}
Org mode cooperates with remember, see @ref{Remember}.
@file{Remember.el} is not part of Emacs, find it on the web.
address@hidden @file{speedbar.el} by Eric M. Ludlam
address@hidden @file{speedbar.el}
+Speedbar is a package that creates a special frame displaying files and
+index items in files. Org-mode supports speedbar and allows you to
+drill into Org-mode files directly from the speedbar. It also allows to
+restrict the scope of agenda commands to a file or a subtree by using
+the command @kbd{<} in the speedbar frame.
@cindex @file{table.el}
@item @file{table.el} by Takaaki Ota
@kindex C-c C-c
@@ -5887,7 +7859,7 @@
@item C-c C-c
Recognize @file{table.el} table. Works when the cursor is in a
table.el table.
-
address@hidden
@kindex C-c ~
@item C-c ~
Insert a table.el table. If there is already a table at point, this
@@ -5897,6 +7869,10 @@
possible.
@end table
@file{table.el} is part of Emacs 22.
address@hidden @file{footnote.el}
address@hidden @file{footnote.el} by Steven L. Baur
+Org-mode recognizes numerical footnotes as provided by this package
+(@pxref{Footnotes}).
@end table
@node Conflicts, , Cooperation, Interaction
@@ -5916,18 +7892,16 @@
@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
address@hidden When set, Org-mode will move the following
-keybindings in org-mode files, and in the agenda buffer (but not
-during date selection).
+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-replace-disputed-keys}. 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
@@ -5937,6 +7911,16 @@
@cindex @file{windmove.el}
Also this package uses the @kbd{S-<cursor>} keys, so everything written
in the paragraph above about CUA mode also applies here.
+
address@hidden @file{footnote.el}
address@hidden @file{footnote.el} by Steven L. Baur
+Org-mode supports the syntax of the footnote package, but only the
+numerical footnote markers. Also, the default key for footnote
+commands, @kbd{C-c !} is already used by Org-mode. You could use the
+variable @code{footnote-prefix} to switch footnotes commands to another
+key. Or, you could use @code{org-replace-disputed-keys} and
address@hidden to change the settings in Org-mode.
+
@end table
@@ -5987,12 +7971,14 @@
@menu
* Extensions:: Existing 3rd-part extensions
+* Adding hyperlink types:: New custom link types
* Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs
* Dynamic blocks:: Automatically filled blocks
* Special agenda views:: Customized views
+* Using the property API:: Writing programs that use entry properties
@end menu
address@hidden Extensions, Tables in arbitrary syntax, Extensions and Hacking,
Extensions and Hacking
address@hidden Extensions, Adding hyperlink types, Extensions and Hacking,
Extensions and Hacking
@section Third-party extensions for Org-mode
@cindex extension, third-party
@@ -6032,20 +8018,126 @@
@item @file{org2rem.el} by Bastien Guerry
Translates Org-mode files into something readable by
Remind. @url{http://www.cognition.ens.fr/~guerry/u/org2rem.el}.
address@hidden @file{org-toc.el} by Bastien Guerry
+Produces a simple table of contents of an Org-mode file, for easy
+navigation. @url{http://www.cognition.ens.fr/~guerry/u/org-registry.el}.
address@hidden @file{org-registry.el} by Bastien Guerry
+Find which Org-file link to a certain document.
address@hidden://www.cognition.ens.fr/~guerry/u/org2rem.el}.
@end table
@page
address@hidden Tables in arbitrary syntax, Dynamic blocks, Extensions,
Extensions and Hacking
address@hidden Tables in arbitrary syntax
address@hidden Adding hyperlink types, Tables in arbitrary syntax, Extensions,
Extensions and Hacking
address@hidden Adding hyperlink types
address@hidden hyperlinks, adding new types
+
+Org-mode has a large number of hyperlink types built-in
+(@pxref{Hyperlinks}). If you would like to add new link types, it
+provides an interface for doing so. Lets look at an example file
address@hidden that will add support for creating links like
address@hidden:printf][The printf manpage]]} to show unix manual pages inside
+emacs:
+
address@hidden
+;;; org-man.el - Support for links to manpages in Org-mode
+
+(require 'org)
+
+(org-add-link-type "man" 'org-man-open)
+(add-hook 'org-store-link-functions 'org-man-store-link)
+
+(defcustom org-man-command 'man
+ "The Emacs command to be used to display a man page."
+ :group 'org-link
+ :type '(choice (const man) (const woman)))
+
+(defun org-man-open (path)
+ "Visit the manpage on PATH.
+PATH should be a topic that can be thrown at the man command."
+ (funcall org-man-command path))
+
+(defun org-man-store-link ()
+ "Store a link to a manpage."
+ (when (memq major-mode '(Man-mode woman-mode))
+ ;; This is a man page, we do make this link
+ (let* ((page (org-man-get-page-name))
+ (link (concat "man:" page))
+ (description (format "Manpage for %s" page)))
+ (org-store-link-props
+ :type "man"
+ :link link
+ :description description))))
+
+(defun org-man-get-page-name ()
+ "Extract the page name from the buffer name."
+ ;; This works for both `Man-mode' and `woman-mode'.
+ (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
+ (match-string 1 (buffer-name))
+ (error "Cannot create link to this man page")))
+
+(provide 'org-man)
+
+;;; org-man.el ends here
address@hidden lisp
+
address@hidden
+You would activate this new link type in @file{.emacs} with
+
address@hidden
+(require 'org-man)
address@hidden lisp
+
address@hidden
+Lets go through the file and see what it does.
address@hidden
address@hidden
+It does @code{(require 'org)} to make sure that @file{org.el} has been
+loaded.
address@hidden
+The next line calls @code{org-add-link-type} to define a new link type
+with prefix @samp{man}. The call also contains the name of a function
+that will be called to follow such a link.
address@hidden
+The next line adds a function to @code{org-store-link-functions}, in
+order to allow the command @kbd{C-c l} to record a useful link in a
+buffer displaying a man page.
address@hidden enumerate
+
+The rest of the file defines the necessary variables and functions.
+First there is a customization variable that determines which emacs
+command should be used to display manpages. There are two options,
address@hidden and @code{woman}. Then the function to follow a link is
+defined. It gets the link path as an argument - in this case the link
+path is just a topic for the manual command. The function calls the
+value of @code{org-man-command} to display the man page.
+
+Finally the function @code{org-man-store-link} is defined. When you try
+to store a link with @kbd{C-c l}, also this function will be called to
+try to make a link. The function must first decide if it is supposed to
+create the link for this buffer type, we do this by checking the value
+of the variable @code{major-mode}. If not, the function must exit and
+retunr the value @code{nil}. If yes, the link is created by getting the
+manual tpoic from the buffer name and prefixing it with the string
address@hidden:}. Then it must call the command @code{org-store-link-props}
+and set the @code{:type} and @code{:link} properties. Optionally you
+can also set the @code{:description} property to provide a default for
+the link description when the link is later inserted into tan Org-mode
+buffer with @kbd{C-c C-l}.
+
address@hidden Tables in arbitrary syntax, Dynamic blocks, Adding hyperlink
types, Extensions and Hacking
address@hidden Tables and Lists in arbitrary syntax
@cindex tables, in other modes
address@hidden lists, in other modes
@cindex orgtbl-mode
Since Orgtbl-mode can be used as a minor mode in arbitrary buffers, a
frequent feature request has been to make it work with native tables in
-specific languages, for example LaTeX. However, this is extremely hard
-to do in a general way, would lead to a customization nightmare, and
-would take away much of the simplicity of the Orgtbl-mode table editor.
+specific languages, for example address@hidden However, this is extremely
+hard to do in a general way, would lead to a customization nightmare,
+and would take away much of the simplicity of the Orgtbl-mode table
+editor.
+
This appendix describes a different approach. We keep the Orgtbl-mode
table in its native format (the @i{source table}), and use a custom
@@ -6054,10 +8146,17 @@
the burden of writing conversion functions on the user, but it allows
for a very flexible system.
+Bastien added the ability to do the same with lists. You can use Org's
+facilities to edit and structure lists by turning @code{orgstruct-mode}
+on, then locally exporting such lists in another format (HTML, address@hidden
+or TeXInfo.)
+
+
@menu
* Radio tables:: Sending and receiving
* A LaTeX example:: Step by step, almost a tutorial
* Translator functions:: Copy and modify
+* Radio lists:: Doing the same for lists.
@end menu
@node Radio tables, A LaTeX example, Tables in arbitrary syntax, Tables in
arbitrary syntax
@@ -6105,7 +8204,7 @@
@noindent
The one problem remaining is how to keep the source table in the buffer
without disturbing the normal workings of the file, for example during
-compilation of a C file or processing of a LaTeX file. There are a
+compilation of a C file or processing of a address@hidden file. There are a
number of different solutions:
@itemize @bullet
@@ -6116,7 +8215,7 @@
@item
Sometimes it is possible to put the table after some kind of @i{END}
statement, for example @samp{\bye} in TeX and @address@hidden@}}
-in LaTeX.
+in address@hidden
@item
You can just comment the table line by line whenever you want to process
the file, and uncomment it whenever you need to edit the table. This
@@ -6126,14 +8225,14 @@
@end itemize
@node A LaTeX example, Translator functions, Radio tables, Tables in arbitrary
syntax
address@hidden A LaTeX example
address@hidden A LaTeX example of radio tables
@cindex LaTeX, and orgtbl-mode
-The best way to wrap the source table in LaTeX is to use the
+The best way to wrap the source table in address@hidden is to use the
@code{comment} environment provided by @file{comment.sty}. It has to be
activated by placing @address@hidden@}} into the document
header. Orgtbl-mode can insert a radio table address@hidden
-default this works only for LaTeX, HTML, and TeXInfo. Configure the
+default this works only for address@hidden, HTML, and TeXInfo. Configure the
variable @code{orgtbl-radio-tables} to install templates for other
modes.} with the command @kbd{M-x orgtbl-insert-radio-table}. You will
be prompted for a table name, lets say we use @samp{salesfigures}. You
@@ -6150,7 +8249,7 @@
@noindent
The @code{#+ORGTBL: SEND} line tells orgtbl-mode to use the function
address@hidden to convert the table into LaTeX and to put it
address@hidden to convert the table into address@hidden and to put it
into the receiver location with name @code{salesfigures}. You may now
fill in the table, feel free to use the spreadsheet address@hidden
the @samp{#+TBLFM} line contains an odd number of dollar characters,
@@ -6204,7 +8303,7 @@
address@hidden@}
@end example
-The LaTeX translator function @code{orgtbl-to-latex} is already part of
+The address@hidden translator function @code{orgtbl-to-latex} is already part
of
Orgtbl-mode. It uses a @code{tabular} environment to typeset the table
and marks horizontal lines with @code{\hline}. Furthermore, it
interprets the following parameters:
@@ -6230,7 +8329,7 @@
applied.
@end table
address@hidden Translator functions, , A LaTeX example, Tables in arbitrary
syntax
address@hidden Translator functions, Radio lists, A LaTeX example, Tables in
arbitrary syntax
@subsection Translator functions
@cindex HTML, and orgtbl-mode
@cindex translator function
@@ -6265,7 +8364,7 @@
@var{PARAMS}) are combined with the ones newly defined in the function
(variable @var{PARAMS2}). The ones passed into the function (i.e. the
ones set by the @samp{ORGTBL SEND} line) take precedence. So if you
-would like to use the LaTeX translator, but wanted the line endings to
+would like to use the address@hidden translator, but wanted the line endings to
be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
overrule the default with
@@ -6274,7 +8373,7 @@
@end example
For a new language, you can either write your own converter function in
-analogy with the LaTeX translator, or you can use the generic function
+analogy with the address@hidden translator, or you can use the generic function
directly. For example, if you have a language where a table is started
with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are
started with @samp{!BL!}, ended with @samp{!EL!} and where the field
@@ -6303,6 +8402,49 @@
translator, please post it on @code{emacs-orgmode@@gnu.org} so that
others can benefit from your work.
address@hidden Radio lists, , Translator functions, Tables in arbitrary syntax
address@hidden Radio lists
address@hidden radio lists
address@hidden org-list-insert-radio-list
+
+Sending and receiving radio lists works exactly the same way than
+sending and receiving radio tables (@pxref{Radio tables}) @footnote{You
+need to load the @code{org-export-latex.el} package to use radio lists
+since the relevant code is there for now.}. As for radio tables, you
+can insert radio lists templates in HTML, address@hidden and TeXInfo modes by
+calling @code{org-list-insert-radio-list}.
+
+Here are the differences with radio tables:
+
address@hidden @minus
address@hidden
+Use @code{ORGLST} instead of @code{ORGTBL}.
address@hidden
+The available translation functions for radio lists don't take
+parameters.
address@hidden
+`C-c C-c' will work when pressed on the first item of the list.
address@hidden itemize
+
+Here is a address@hidden example. Let's say that you have this in your
address@hidden file:
+
address@hidden
+% BEGIN RECEIVE ORGLST to-buy
+% END RECEIVE ORGLST to-buy
address@hidden@}
+#+ORGLIST: SEND to-buy orgtbl-to-latex
+- a new house
+- a new computer
+ + a new keyboard
+ + a new mouse
+- a new life
address@hidden@}
address@hidden example
+
+Pressing `C-c C-c' on @code{a new house} and will insert the converted
address@hidden list between the two marker lines.
+
@node Dynamic blocks, Special agenda views, Tables in arbitrary syntax,
Extensions and Hacking
@section Dynamic blocks
@cindex dynamic blocks
@@ -6335,8 +8477,11 @@
Updating a dynamic block means to remove all the text between BEGIN and
END, parse the BEGIN line for parameters and then call the specific
-writer function for this block to insert the new content. For a block
-with name @code{myblock}, the writer function is
+writer function for this block to insert the new content. If you want
+to use the original content in the writer function, you can use the
+extra parameter @code{:content}.
+
+For a block with name @code{myblock}, the writer function is
@code{org-dblock-write:myblock} with as only parameter a property list
with the parameters given in the begin line. Here is a trivial example
of a block that keeps track of when the block update function was last
@@ -6363,7 +8508,7 @@
example @code{before-save-hook}. @code{org-update-all-dblocks} is
written in a way that is does nothing in buffers that are not in Org-mode.
address@hidden Special agenda views, , Dynamic blocks, Extensions and Hacking
address@hidden Special agenda views, Using the property API, Dynamic blocks,
Extensions and Hacking
@section Special Agenda Views
@cindex agenda views, user-defined
@@ -6389,35 +8534,100 @@
(defun my-skip-unless-waiting ()
"Skip trees that are not waiting"
(let ((subtree-end (save-excursion (org-end-of-subtree t))))
- (if (re-search-forward ":WAITING:" subtree-end t)
+ (if (re-search-forward ":waiting:" subtree-end t)
nil ; tag found, do not skip
subtree-end))) ; tag not found, continue after end of subtree
@end lisp
-Furthermore you must write a command that uses @code{let} to temporarily
-put this function into the variable @code{org-agenda-skip-function},
-sets the header string for the agenda buffer, and calls the todo-list
-generator while asking for the specific TODO keyword PROJECT. The
-function must also accept one argument MATCH, but it can choose to
-ignore address@hidden must be present in case you want to define a
-custom command for producing this special list. Custom commands always
-supply the MATCH argument, but it can be empty if you do not specify it
-while defining the command(@pxref{Custom agenda
-views}).} (as we do in the example below). Here is the example:
-
address@hidden
-(defun my-org-waiting-projects (&optional match)
- "Produce a list of projects that contain a WAITING tag.
-MATCH is being ignored."
- (interactive)
- (let ((org-agenda-skip-function 'my-skip-unless-waiting)
- (org-agenda-overriding-header "Projects waiting for something: "))
- ;; make the list
- (org-todo-list "PROJECT")))
+Now you may use this function in an agenda custom command, for example
+like this:
+
address@hidden
+(org-add-agenda-custom-command
+ '("b" todo "PROJECT"
+ ((org-agenda-skip-function 'my-org-waiting-projects)
+ (org-agenda-overriding-header "Projects waiting for something: "))))
address@hidden lisp
+
+Note that this also binds @code{org-agenda-overriding-header} to get a
+meaningful header in the agenda view.
+
+You may also put a Lisp form into @code{org-agenda-skip-function}. In
+particular, you may use the functions @code{org-agenda-skip-entry-if}
+and @code{org-agenda-skip-subtree-if} in this form, for example:
+
address@hidden @code
address@hidden '(org-agenda-skip-entry-if 'scheduled)
+Skip current entry if it has been scheduled.
address@hidden '(org-agenda-skip-entry-if 'notscheduled)
+Skip current entry if it has not been scheduled.
address@hidden '(org-agenda-skip-entry-if 'deadline)
+Skip current entry if it has a deadline.
address@hidden '(org-agenda-skip-entry-if 'scheduled 'deadline)
+Skip current entry if it has a deadline, or if it is scheduled.
address@hidden '(org-agenda-skip-entry 'regexp "regular expression")
+Skip current entry if the regular expression matches in the entry.
address@hidden '(org-agenda-skip-entry 'notregexp "regular expression")
+Skip current entry unless the regular expression matches.
address@hidden '(org-agenda-skip-subtree-if 'regexp "regular expression")
+Same as above, but check and skip the entire subtree.
address@hidden table
+
+Therefore we could also have written the search for WAITING projects
+like this, even without defining a special function:
+
address@hidden
+(org-add-agenda-custom-command
+ '("b" todo "PROJECT"
+ ((org-agenda-skip-function '(org-agenda-skip-subtree-if
+ 'regexp ":waiting:"))
+ (org-agenda-overriding-header "Projects waiting for something: "))))
@end lisp
address@hidden History and Acknowledgments, GNU Free Documentation License,
Extensions and Hacking, Top
address@hidden Using the property API, , Special agenda views, Extensions and
Hacking
address@hidden Using the property API
address@hidden API, for properties
address@hidden properties, API
+
+Here is a description of the functions that can be used to work with
+properties.
+
address@hidden org-entry-properties &optional pom which
+Get all properties of the entry at point-or-marker POM.
+This includes the TODO keyword, the tags, time strings for deadline,
+scheduled, and clocking, and any additional properties defined in the
+entry. The return value is an alist, keys may occur multiple times
+if the property key was used several times.
+POM may also be nil, in which case the current entry is used.
+If WHICH is nil or `all', get all properties. If WHICH is
+`special' or `standard', only get that subclass.
address@hidden defun
address@hidden org-entry-get pom property &optional inherit
+Get value of PROPERTY for entry at point-or-marker POM.
+If INHERIT is non-nil and the entry does not have the property,
+then also check higher levels of the hierarchy. This function ignores
+the value of @code{org-use-property-inheritance} and requires the
+explicit INHERIT flag.
address@hidden defun
+
address@hidden org-entry-delete pom property
+Delete the property PROPERTY from entry at point-or-marker POM.
address@hidden defun
+
address@hidden org-entry-put pom property value
+Set PROPERTY to VALUE for entry at point-or-marker POM.
address@hidden defun
+
address@hidden org-buffer-property-keys &optional include-specials
+Get all property keys in the current buffer.
address@hidden defun
+
address@hidden org-insert-property-drawer
+Insert a property drawer at point.
address@hidden defun
+
address@hidden History and Acknowledgments, Main Index, Extensions and Hacking,
Top
@appendix History and Acknowledgments
@cindex acknowledgments
@cindex history
@@ -6440,7 +8650,7 @@
plain text mode with innovative and intuitive editing features, and to
incorporate project planning functionality directly into a notes file.
-Since the first release, hundreds of emails to me or on
+Since the first release, literally thousands of emails to me or on
@code{emacs-orgmode@@gnu.org} have provided a constant stream of bug
reports, feedback, new ideas, and sometimes patches and add-on code.
Many thanks to everyone who has helped to improve this package. I am
@@ -6452,6 +8662,8 @@
@itemize @bullet
@item
address@hidden Adams} came up with the idea for drawers.
address@hidden
@i{Thomas Baumann} contributed the code for links to the MH-E email
system.
@item
@@ -6469,7 +8681,9 @@
@item
@i{Sacha Chua} suggested to copy some linking code from Planner.
@item
address@hidden DeVilla} proposed and tested checkbox statistics.
address@hidden DeVilla} proposed and tested checkbox statistics. He also
+came up with the idea of properties, and that there should be an API for
+them.
@item
@i{Kees Dullemond} used to edit projects lists directly in HTML and so
inspired some of the early development, including HTML export. He also
@@ -6478,25 +8692,42 @@
@i{Christian Egli} converted the documentation into TeXInfo format,
patched CSS formatting into the HTML exporter, and inspired the agenda.
@item
address@hidden Emery} provided a patch for custom CSS support in exported
+HTML agendas.
address@hidden
@i{Nic Ferrier} contributed mailcap and XOXO support.
@item
address@hidden A. Figueroa-Villanueva} implemented hierarchical checkboxes.
address@hidden
@i{John Foerch} figured out how to make incremental search show context
around a match in a hidden outline tree.
@item
address@hidden Giessen} had the idea to automatically archive DONE trees.
address@hidden Giesen} had the idea to automatically archive DONE trees.
@item
address@hidden Guerry} provided extensive feedback and some patches, and
-translated David O'Toole's tutorial into French.
address@hidden Guerry} wrote the address@hidden exporter and has been prolific
+with patches, ideas, and bug reports.
@item
@i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
@item
address@hidden Liu} (``Leo'') provided extensive feedback and some patches.
address@hidden Jaderholm} proposed footnotes, control over whitespace between
+folded entries, and column view for properties.
address@hidden
address@hidden Liu} ("Leo") asked for embedded address@hidden and tested it.
He also
+provided frequent feedback and some patches.
address@hidden
address@hidden F. McBrayer} suggested agenda export to CSV format.
@item
address@hidden Liu} asked for embedded LaTeX and tested it.
address@hidden Mikhanosha} came up with the idea of refiling.
address@hidden
address@hidden Minaev} sent a patch to set priority limits on a per-file
+basis.
@item
@i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
happy.
@item
address@hidden Moynihan} proposed to allow multiple TODO sequences in a file
+and to be able to quickly restrict the agenda to a subtree.
address@hidden
@i{Todd Neal} provided patches for links to Info files and elisp forms.
@item
@i{Tim O'Callaghan} suggested in-file links, search options for general
@@ -6539,6 +8770,9 @@
@item
@i{Dale Smith} proposed link abbreviations.
@item
address@hidden Spiers} asked for global linking commands and inspired the link
+extension system. support mairix.
address@hidden
@i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
chapter about publishing.
@item
@@ -6557,6 +8791,7 @@
I later looked at John's code, however, 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.
+John has also contributed a number of great ideas directly to Org-mode.
@item
@i{Carsten Wimmer} suggested some changes and helped fix a bug in
linking to GNUS.
@@ -6568,17 +8803,13 @@
and contributed various ideas and code snippets.
@end itemize
address@hidden GNU Free Documentation License, Index, History and
Acknowledgments, Top
address@hidden GNU Free Documentation License
address@hidden doclicense.texi
-
address@hidden Index, Key Index, GNU Free Documentation License, Top
address@hidden Index
address@hidden Main Index, Key Index, History and Acknowledgments, Top
address@hidden The Main Index
@printindex cp
address@hidden Key Index, , Index, Top
address@hidden Key Index, , Main Index, Top
@unnumbered Key Index
@printindex ky
@@ -6588,3 +8819,4 @@
@ignore
arch-tag: 7893d1fe-cc57-4d13-b5e5-f494a1bcc7ac
@end ignore
+)
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Emacs-diffs] Changes to emacs/man/Attic/org.texi, v [EMACS_22_BASE],
Carsten Dominik <=