+
\input texinfo
@c %**start of header
@setfilename ../../info/org
@settitle The Org Manual
-@set VERSION 6.33x
-@set DATE November 2009
+@set VERSION 7.7
+@set DATE July 2011
+
+@c Use proper quote and backtick for code sections in PDF output
+@c Cf. Texinfo manual 14.2
+@set txicodequoteundirected
+@set txicodequotebacktick
@c Version and Contact Info
@set MAINTAINERSITE @uref{http://orgmode.org,maintainers webpage}
@c %**end of header
@finalout
-@c Macro definitions
+
+@c -----------------------------------------------------------------------------
+
+@c Macro definitions for commands and keys
+@c =======================================
+
+@c The behavior of the key/command macros will depend on the flag cmdnames
+@c When set, commands names are shown. When clear, they are not shown.
+
+@set cmdnames
+
+@c Below we define the following macros for Org key tables:
+
+@c orgkey{key} A key item
+@c orgcmd{key,cmd} Key with command name
+@c xorgcmd{key,command} Key with command name as @itemx
+@c orgcmdnki{key,cmd} Like orgcmd, but do not index the key
+@c orgcmdtkc{text,key,cmd} Like orgcmd,special text instead of key
+@c orgcmdkkc{key1,key2,cmd} Two keys with one command name, use "or"
+@c orgcmdkxkc{key1,key2,cmd} Two keys with one command name, but
+@c different functions, so format as @itemx
+@c orgcmdkskc{key1,key2,cmd} Same as orgcmdkkc, but use "or short"
+@c xorgcmdkskc{key1,key2,cmd} Same as previous, but use @itemx
+@c orgcmdkkcc{key1,key2,cmd1,cmd2} Two keys and two commands
+
+@c a key but no command
+@c Inserts: @item key
+@macro orgkey{key}
+@kindex \key\
+@item @kbd{\key\}
+@end macro
+
+@macro xorgkey{key}
+@kindex \key\
+@itemx @kbd{\key\}
+@end macro
+
+@c one key with a command
+@c Inserts: @item KEY COMMAND
+@macro orgcmd{key,command}
+@ifset cmdnames
+@kindex \key\
+@findex \command\
@iftex
-@c @hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed}
+@item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
+@end iftex
+@ifnottex
+@item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
+@end ifnottex
+@end ifset
+@ifclear cmdnames
+@kindex \key\
+@item @kbd{\key\}
+@end ifclear
+@end macro
+
+@c One key with one command, formatted using @itemx
+@c Inserts: @itemx KEY COMMAND
+@macro xorgcmd{key,command}
+@ifset cmdnames
+@kindex \key\
+@findex \command\
+@iftex
+@itemx @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
+@end iftex
+@ifnottex
+@itemx @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
+@end ifnottex
+@end ifset
+@ifclear cmdnames
+@kindex \key\
+@itemx @kbd{\key\}
+@end ifclear
+@end macro
+
+@c one key with a command, bit do not index the key
+@c Inserts: @item KEY COMMAND
+@macro orgcmdnki{key,command}
+@ifset cmdnames
+@findex \command\
+@iftex
+@item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
+@end iftex
+@ifnottex
+@item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
+@end ifnottex
+@end ifset
+@ifclear cmdnames
+@item @kbd{\key\}
+@end ifclear
+@end macro
+
+@c one key with a command, and special text to replace key in item
+@c Inserts: @item TEXT COMMAND
+@macro orgcmdtkc{text,key,command}
+@ifset cmdnames
+@kindex \key\
+@findex \command\
+@iftex
+@item @kbd{\text\} @hskip 0pt plus 1filll @code{\command\}
@end iftex
-@macro Ie {}
-I.e.,
+@ifnottex
+@item @kbd{\text\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
+@end ifnottex
+@end ifset
+@ifclear cmdnames
+@kindex \key\
+@item @kbd{\text\}
+@end ifclear
+@end macro
+
+@c two keys with one command
+@c Inserts: @item KEY1 or KEY2 COMMAND
+@macro orgcmdkkc{key1,key2,command}
+@ifset cmdnames
+@kindex \key1\
+@kindex \key2\
+@findex \command\
+@iftex
+@item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
+@end iftex
+@ifnottex
+@item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
+@end ifnottex
+@end ifset
+@ifclear cmdnames
+@kindex \key1\
+@kindex \key2\
+@item @kbd{\key1\} @ @r{or} @ @kbd{\key2\}
+@end ifclear
@end macro
-@macro ie {}
-i.e.,
+
+@c Two keys with one command name, but different functions, so format as
+@c @itemx
+@c Inserts: @item KEY1
+@c @itemx KEY2 COMMAND
+@macro orgcmdkxkc{key1,key2,command}
+@ifset cmdnames
+@kindex \key1\
+@kindex \key2\
+@findex \command\
+@iftex
+@item @kbd{\key1\}
+@itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
+@end iftex
+@ifnottex
+@item @kbd{\key1\}
+@itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
+@end ifnottex
+@end ifset
+@ifclear cmdnames
+@kindex \key1\
+@kindex \key2\
+@item @kbd{\key1\}
+@itemx @kbd{\key2\}
+@end ifclear
+@end macro
+
+@c Same as previous, but use "or short"
+@c Inserts: @item KEY1 or short KEY2 COMMAND
+@macro orgcmdkskc{key1,key2,command}
+@ifset cmdnames
+@kindex \key1\
+@kindex \key2\
+@findex \command\
+@iftex
+@item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
+@end iftex
+@ifnottex
+@item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
+@end ifnottex
+@end ifset
+@ifclear cmdnames
+@kindex \key1\
+@kindex \key2\
+@item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
+@end ifclear
@end macro
-@macro Eg {}
-E.g.,
+
+@c Same as previous, but use @itemx
+@c Inserts: @itemx KEY1 or short KEY2 COMMAND
+@macro xorgcmdkskc{key1,key2,command}
+@ifset cmdnames
+@kindex \key1\
+@kindex \key2\
+@findex \command\
+@iftex
+@itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
+@end iftex
+@ifnottex
+@itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
+@end ifnottex
+@end ifset
+@ifclear cmdnames
+@kindex \key1\
+@kindex \key2\
+@itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
+@end ifclear
@end macro
-@macro eg {}
-e.g.,
+
+@c two keys with two commands
+@c Inserts: @item KEY1 COMMAND1
+@c @itemx KEY2 COMMAND2
+@macro orgcmdkkcc{key1,key2,command1,command2}
+@ifset cmdnames
+@kindex \key1\
+@kindex \key2\
+@findex \command1\
+@findex \command2\
+@iftex
+@item @kbd{\key1\} @hskip 0pt plus 1filll @code{\command1\}
+@itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command2\}
+@end iftex
+@ifnottex
+@item @kbd{\key1\} @tie{}@tie{}@tie{}@tie{}(@code{\command1\})
+@itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command2\})
+@end ifnottex
+@end ifset
+@ifclear cmdnames
+@kindex \key1\
+@kindex \key2\
+@item @kbd{\key1\}
+@itemx @kbd{\key2\}
+@end ifclear
@end macro
+@c -----------------------------------------------------------------------------
+
+@iftex
+@c @hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed}
+@end iftex
@c Subheadings inside a table.
@macro tsubheading{text}
@copying
This manual is for Org version @value{VERSION}.
-Copyright @copyright{} 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation
+Copyright @copyright{} 2004-2011 Free Software Foundation, Inc.
@quotation
Permission is granted to copy, distribute and/or modify this document
@dircategory Emacs
@direntry
-* Org Mode: (org). Outline-based notes management and organizer.
+* Org Mode: (org). Outline-based notes management and organizer
@end direntry
@titlepage
@subtitle Release @value{VERSION}
@author by Carsten Dominik
+with contributions by David O'Toole, Bastien Guerry, Philip Rooke, Dan Davison, Eric Schulte, and Thomas Dye
@c The following two commands start the copyright page.
@page
* Markup:: Prepare text for rich export
* Exporting:: Sharing and publishing of notes
* Publishing:: Create a web site of linked Org files
+* Working With Source Code:: Export, evaluate, and tangle code blocks
* Miscellaneous:: All the rest which did not fit elsewhere
* Hacking:: How to hack your way around
* MobileOrg:: Viewing and capture on a mobile device
* History and Acknowledgments:: How Org came into being
* Main Index:: An index of Org's concepts and features
* Key Index:: Key bindings and where they are described
+* Command and Function Index:: Command names and some internal functions
* Variable Index:: Variables mentioned in the manual
@detailmenu
* Feedback:: Bug reports, ideas, patches etc.
* Conventions:: Type-setting conventions in the manual
-Document Structure
+Document structure
* Outlines:: Org is based on Outline mode
* Headlines:: How to typeset Org tree headlines
* References:: How to refer to another field or range
* Formula syntax for Calc:: Using Calc to compute stuff
* Formula syntax for Lisp:: Writing formulas in Emacs Lisp
-* Field formulas:: Formulas valid for a single field
+* Durations and time values:: How to compute durations and time values
+* Field and range formulas:: Formula for specific (ranges of) fields
* Column formulas:: Formulas valid for an entire column
* Editing and debugging formulas:: Fixing formulas
* Updating the table:: Recomputing all dependent fields
* Radio targets:: Make targets trigger links in plain text
-TODO Items
+TODO items
* TODO basics:: Marking and displaying TODO entries
* TODO extensions:: Workflow and assignments
* Setting tags:: How to assign tags to a headline
* Tag searches:: Searching for combinations of tags
-Properties and Columns
+Properties and columns
* Property syntax:: How properties are spelled out
-* Special properties:: Access to other Org mode features
+* 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
* Scope of column definitions:: Where defined, where valid?
* Column attributes:: Appearance and content of a column
-Dates and Times
+Dates and times
* Timestamps:: Assigning a time to a tree entry
* Creating timestamps:: Commands which insert timestamps
* Deadlines and scheduling:: Planning your work
* Clocking work time:: Tracking how long you spend on a task
-* Resolving idle time:: Resolving time if you've been idle
* Effort estimates:: Planning work effort in advance
* Relative timer:: Notes with a running timer
+* Countdown timer:: Starting a countdown timer for a task
Creating timestamps
-* The date/time prompt:: How Org mode helps you entering date and time
+* The date/time prompt:: How Org-mode helps you entering date and time
* Custom time format:: Making dates look different
Deadlines and scheduling
* Inserting deadline/schedule:: Planning items
* Repeated tasks:: Items that show up again and again
+Clocking work time
+
+* Clocking commands:: Starting and stopping a clock
+* The clock table:: Detailed reports
+* Resolving idle time:: Resolving time when you've been idle
+
Capture - Refile - Archive
-* Remember:: Capture new tasks/ideas with little interruption
-* Attachments:: Add files to tasks.
+* Capture:: Capturing new stuff
+* Attachments:: Add files to tasks
* RSS Feeds:: Getting input from RSS feeds
-* Protocols:: External (e.g. Browser) access to Emacs and Org
+* Protocols:: External (e.g.@: Browser) access to Emacs and Org
* Refiling notes:: Moving a tree from one place to another
* Archiving:: What to do with finished projects
-Remember
+Capture
+
+* Setting up capture:: Where notes will be stored
+* Using capture:: Commands to invoke and terminate capture
+* Capture templates:: Define the outline of different note types
-* Setting up Remember for Org:: 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
+Capture templates
+
+* Template elements:: What is needed for a complete template entry
+* Template expansion:: Filling in information about time and context
Archiving
* Moving subtrees:: Moving a tree to an archive file
-* Internal archiving:: Switch off a tree but keep i in the file
+* Internal archiving:: Switch off a tree but keep it in the file
-Agenda Views
+Agenda views
* Agenda files:: Files being searched for agenda information
* Agenda dispatcher:: Keyboard access to agenda views
* Images and tables:: Tables and Images will be included
* Literal examples:: Source code examples with special formatting
* Include files:: Include additional files into a document
+* Index entries:: Making an index
* Macro replacement:: Use macros to create complex output
* Embedded LaTeX:: LaTeX can be freely used inside Org documents
* Horizontal rules:: Make a line
* Comment lines:: What will *not* be exported
-Embedded La@TeX{}
+Embedded @LaTeX{}
* Special symbols:: Greek letters and other symbols
* Subscripts and superscripts:: Simple syntax for raising/lowering text
* Selective export:: Using tags to select and exclude trees
* Export options:: Per-file export settings
* The export dispatcher:: How to access exporter commands
-* ASCII export:: Exporting to plain ASCII
+* ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
* HTML export:: Exporting to HTML
-* LaTeX and PDF export:: Exporting to La@TeX{}, and processing to PDF
+* LaTeX and PDF export:: Exporting to @LaTeX{}, and processing to PDF
* DocBook export:: Exporting to DocBook
+* OpenDocumentText export:: Exporting to OpenDocumentText
+* TaskJuggler export:: Exporting to TaskJuggler
* Freemind export:: Exporting to Freemind mind maps
* XOXO export:: Exporting to XOXO
* iCalendar export:: Exporting in iCalendar format
HTML export
* HTML Export commands:: How to invoke HTML export
-* Quoting HTML tags:: Using direct HTML in Org mode
+* HTML preamble and postamble:: How to insert a preamble and a postamble
+* Quoting HTML tags:: Using direct HTML in Org-mode
* Links in HTML export:: How links will be interpreted and formatted
* Tables in HTML export:: How to modify the formatting of tables
* Images in HTML export:: How to insert figures into HTML output
+* Math formatting in HTML export:: Beautiful math also on the web
* Text areas in HTML export:: An alternative way to show an example
* CSS support:: Changing the appearance of the output
-* Javascript support:: Info and Folding in a web browser
+* JavaScript support:: Info and Folding in a web browser
-La@TeX{} and PDF export
+@LaTeX{} and PDF export
* LaTeX/PDF export commands:: Which key invokes which commands
-* Quoting LaTeX code:: Incorporating literal La@TeX{} code
-* Sectioning structure:: Changing sectioning in La@TeX{} output
-* Tables in LaTeX export:: Options for exporting tables to La@TeX{}
-* Images in LaTeX export:: How to insert figures into La@TeX{} output
+* Header and sectioning:: Setting up the export file structure
+* Quoting LaTeX code:: Incorporating literal @LaTeX{} code
+* Tables in LaTeX export:: Options for exporting tables to @LaTeX{}
+* Images in LaTeX export:: How to insert figures into @LaTeX{} output
+* Beamer class export:: Turning the file into a presentation
DocBook export
* Images in DocBook export:: How to insert figures into DocBook output
* Special characters:: How to handle special characters
+OpenDocument export
+
+* OpenDocumentText export commands:: How to invoke OpenDocumentText export
+* Applying Custom Styles:: How to apply custom styles to the output
+* Converting to Other formats:: How to convert to formats like doc, docx etc
+* Links in OpenDocumentText export:: How links will be interpreted and formatted
+* Tables in OpenDocumentText export:: How Tables are handled
+* Images in OpenDocumentText export:: How to insert figures
+* Additional Documentation:: How to handle special characters
+
Publishing
* Configuration:: Defining projects
* Sources and destinations:: From here to there
* Selecting files:: What files are part of the project?
* Publishing action:: Setting the function doing the publishing
-* Publishing options:: Tweaking HTML export
+* Publishing options:: Tweaking HTML/@LaTeX{} export
* Publishing links:: Which links keep working after publishing?
-* Project page index:: Publishing a list of project files
+* Sitemap:: Generating a list of all pages
+* Generating an index:: An index that reaches across pages
Sample configuration
* Simple example:: One-component publishing
* Complex example:: A multi-component publishing example
+Working with source code
+
+* Structure of code blocks:: Code block syntax described
+* Editing source code:: Language major-mode editing
+* Exporting code blocks:: Export contents and/or results
+* Extracting source code:: Create pure source code files
+* Evaluating code blocks:: Place results of evaluation in the Org-mode buffer
+* Library of Babel:: Use and contribute to a library of useful code blocks
+* Languages:: List of supported code block languages
+* Header arguments:: Configure code block functionality
+* Results of evaluation:: How evaluation results are handled
+* Noweb reference syntax:: Literate programming in Org-mode
+* Key bindings and useful functions:: Work quickly with code blocks
+* Batch execution:: Call functions from the command line
+
+Header arguments
+
+* Using header arguments:: Different ways to set header arguments
+* Specific header arguments:: List of header arguments
+
+Using header arguments
+
+* System-wide header arguments:: Set global default values
+* Language-specific header arguments:: Set default values by language
+* Buffer-wide header arguments:: Set default values for a specific buffer
+* Header arguments in Org-mode properties:: Set default values for a buffer or heading
+* Code block specific header arguments:: The most common way to set values
+* Header arguments in function calls:: The most specific level
+
+Specific header arguments
+
+* var:: Pass arguments to code blocks
+* results:: Specify the type of results and how they will
+ be collected and handled
+* file:: Specify a path for file output
+* dir:: Specify the default (possibly remote)
+ directory for code block execution
+* exports:: Export code and/or results
+* tangle:: Toggle tangling and specify file name
+* mkdirp:: Toggle creation of parent directories of target
+ files during tangling
+* comments:: Toggle insertion of comments in tangled
+ code files
+* padline:: Control insertion of padding lines in tangled
+ code files
+* no-expand:: Turn off variable assignment and noweb
+ expansion during tangling
+* session:: Preserve the state of code evaluation
+* noweb:: Toggle expansion of noweb references
+* noweb-ref:: Specify block's noweb reference resolution target
+* cache:: Avoid re-evaluating unchanged code blocks
+* sep:: Delimiter for writing tabular results outside Org
+* hlines:: Handle horizontal lines in tables
+* colnames:: Handle column names in tables
+* rownames:: Handle row names in tables
+* shebang:: Make tangled files executable
+* eval:: Limit evaluation of specific code blocks
+
Miscellaneous
* Completion:: M-TAB knows what you need
-* Speed keys:: Electic commands at the beginning of a headline
+* Easy Templates:: Quick insertion of structural elements
+* Speed keys:: Electric commands at the beginning of a headline
+* Code evaluation security:: Org mode files evaluate inline code
* Customization:: Adapting Org to your taste
* In-buffer settings:: Overview of the #+KEYWORDS
* The very busy C-c C-c key:: When in doubt, press C-c C-c
* Clean view:: Getting rid of leading stars in the outline
* TTY keys:: Using Org on a tty
* Interaction:: Other Emacs packages
+* org-crypt.el:: Encrypting Org files
Interaction with other packages
* Add-on packages:: Available extensions
* Adding hyperlink types:: New custom link types
* Context-sensitive commands:: How to add functionality to such commands
-* Tables in arbitrary syntax:: Orgtbl for La@TeX{} and other programs
+* Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
* Dynamic blocks:: Automatically filled blocks
* Special agenda views:: Customized views
* Extracting agenda information:: Postprocessing of agenda information
iCalendar file. It can also serve as a publishing tool for a set of
linked web pages.
-An important design aspect that distinguishes Org from, for example,
-Planner/Muse is that it encourages you to store every piece of information
-only once. In Planner, you have project pages, day pages and possibly
-other files, duplicating some information such as tasks. In Org,
-you only have notes files. In your notes you mark entries as tasks, and
-label them with tags and timestamps. All necessary lists, like a
-schedule for the day, the agenda for a meeting, tasks lists selected by
-tags, etc., are created dynamically when you need them.
+As a project planning environment, Org works by adding metadata to outline
+nodes. Based on this data, specific entries can be extracted in queries and
+create dynamic @i{agenda views}.
+
+Org mode contains the Org Babel environment which allows you to work with
+embedded source code blocks in a file, to facilitate code evaluation,
+documentation, and literate programming techniques.
+
+Org'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 arbitrary file types, for example in @LaTeX{}. The structure
+editing and list creation capabilities can be used outside Org with
+the minor Orgstruct mode.
Org 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 is a toolbox and can be used in different ways, for
-example as:
+it. Org is a toolbox and can be used in different ways and for different
+ends, for example:
@example
@r{@bullet{} an outline extension with visibility cycling and structure editing}
@r{@bullet{} an ASCII system and table editor for taking structured notes}
-@r{@bullet{} an ASCII table editor with spreadsheet-like capabilities}
@r{@bullet{} a TODO list editor}
@r{@bullet{} a full agenda and planner with deadlines and work scheduling}
@pindex GTD, Getting Things Done
-@r{@bullet{} an environment to implement David Allen's GTD system}
-@r{@bullet{} a basic database application}
-@r{@bullet{} a simple hypertext system, with HTML and La@TeX{} export}
+@r{@bullet{} an environment in which to implement David Allen's GTD system}
+@r{@bullet{} a simple hypertext system, with HTML and @LaTeX{} export}
@r{@bullet{} a publishing tool to create a set of interlinked webpages}
+@r{@bullet{} an environment for literate programming}
@end example
-Org'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 arbitrary file types, for example in La@TeX{}. The structure
-editing and list creation capabilities can be used outside Org with
-the minor Orgstruct mode.
@cindex FAQ
There is a website for Org which provides links to the newest
questions (FAQ), links to tutorials, etc@. This page is located at
@uref{http://orgmode.org}.
+@cindex print edition
+The version 7.3 of this manual is available as a
+@uref{http://www.network-theory.co.uk/org/manual/, paperback book from Network
+Theory Ltd.}
+
@page
@b{Important:} @i{If you are using a version of Org that is part of the Emacs
distribution or an XEmacs package, please skip this section and go directly
-to @ref{Activation}.}
+to @ref{Activation}. To see what version of Org (if any) is part of your
+Emacs distribution, type @kbd{M-x load-library RET org} and then @kbd{M-x
+org-version}.}
If you have downloaded Org from the Web, either as a distribution @file{.zip}
or @file{.tar} file, or as a Git archive, you must take the following steps
(setq load-path (cons "~/path/to/orgdir/contrib/lisp" load-path))
@end example
-@sp 2
-@cartouche
-XEmacs users now need to install the file @file{noutline.el} from
-the @file{xemacs} sub-directory of the Org distribution. Use the
-command:
-
-@example
- make install-noutline
-@end example
-@end cartouche
-@sp 2
-
@noindent Now byte-compile the Lisp files with the shell command:
@example
@end example
Installing Info files is system dependent, because of differences in the
-@file{install-info} program. In Debian it copies the info files into the
-correct directory and modifies the info directory file. In many other
-systems, the files need to be copied to the correct directory separately, and
-@file{install-info} then only modifies the directory file. Check your system
-documentation to find out which of the following commands you need:
+@file{install-info} program. The following should correctly install the Info
+files on most systems, please send a bug report if not@footnote{The output
+from install-info (if any) is also system dependent. In particular Debian
+and its derivatives use two different versions of install-info and you may
+see the message:
+
+@example
+This is not dpkg install-info anymore, but GNU install-info
+See the man page for ginstall-info for command line arguments
+@end example
+
+@noindent which can be safely ignored.}.
@example
make install-info
-make install-info-debian
@end example
Then add the following line to @file{.emacs}. It is needed so that
@cindex global key bindings
@cindex key bindings, global
-@iftex
-@b{Important:} @i{If you use copy-and-paste to copy Lisp code from the
-PDF documentation as viewed by some PDF viewers to your @file{.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 three lines
-define @emph{global} keys for the commands @command{org-store-link},
-@command{org-agenda}, and @command{org-iswitchb}---please choose suitable
-keys yourself.
-
+To make sure files with extension @file{.org} use Org mode, add the following
+line to your @file{.emacs} file.
@lisp
-;; The following lines are always needed. Choose your own keys.
(add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
+@end lisp
+@noindent Org mode buffers need font-lock to be turned on - this is the
+default in Emacs@footnote{If you don't use font-lock globally, turn it on in
+Org buffer with @code{(add-hook 'org-mode-hook 'turn-on-font-lock)}}.
+
+The four Org commands @command{org-store-link}, @command{org-capture},
+@command{org-agenda}, and @command{org-iswitchb} should be accessible through
+global keys (i.e.@: anywhere in Emacs, not just in Org buffers). Here are
+suggested bindings for these keys, please modify the keys to your own
+liking.
+@lisp
(global-set-key "\C-cl" 'org-store-link)
+(global-set-key "\C-cc" 'org-capture)
(global-set-key "\C-ca" 'org-agenda)
(global-set-key "\C-cb" 'org-iswitchb)
@end lisp
-Furthermore, you must activate @code{font-lock-mode} in Org
-buffers, because significant functionality depends on font-locking being
-active. You can do this with either one of the following two lines
-(XEmacs users must use the second option):
-@lisp
-(global-font-lock-mode 1) ; for all buffers
-(add-hook 'org-mode-hook 'turn-on-font-lock) ; Org buffers only
-@end lisp
-
-@cindex Org mode, turning on
+@cindex Org-mode, turning on
With this setup, all files with extension @samp{.org} will be put
-into Org mode. As an alternative, make the first line of a file look
+into Org-mode. As an alternative, make the first line of a file look
like this:
@example
@end example
@vindex org-insert-mode-line-in-empty-file
-@noindent which will select Org mode for this buffer no matter what
+@noindent which will select Org-mode for this buffer no matter what
the file's name is. See also the variable
@code{org-insert-mode-line-in-empty-file}.
If you find problems with Org, or if you have questions, remarks, or ideas
about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}.
If you are not a member of the mailing list, your mail will be passed to the
-list after a moderator has approved it.
-
-For bug reports, please provide as much information as possible, including
-the version information of Emacs (@kbd{M-x emacs-version @key{RET}}) and Org
+list after a moderator has approved it@footnote{Please consider subscribing
+to the mailing list, in order to minimize the work the mailing list
+moderators have to do.}.
+
+For bug reports, please first try to reproduce the bug with the latest
+version of Org available---if you are running an outdated version, it is
+quite possible that the bug has been fixed already. If the bug persists,
+prepare a report and provide as much information as possible, including the
+version information of Emacs (@kbd{M-x emacs-version @key{RET}}) and Org
(@kbd{M-x org-version @key{RET}}), as well as the Org related setup in
@file{.emacs}. The easiest way to do this is to use the command
@example
@item What did you expect to happen?
@item What happened instead?
@end enumerate
-@noindent Thank you for helping to improve this mode.
+@noindent Thank you for helping to improve this program.
@subsubheading How to create a useful backtrace
special meaning are written with all capitals.
@end table
+The manual lists both the keys and the corresponding commands for accessing
+functionality. Org mode often uses the same key for different functions,
+depending on context. The command that is bound to such keys has a generic
+name, like @code{org-metaright}. In the manual we will, wherever possible,
+give the function that is internally called by the generic command. For
+example, in the chapter on document structure, @kbd{M-@key{right}} will be
+listed to call @code{org-do-demote}, while in the chapter on tables, it will
+be listed to call org-table-move-column-right.
+
+If you prefer, you can compile the manual without the command names by
+unsetting the flag @code{cmdnames} in @file{org.texi}.
+
@node Document Structure, Tables, Introduction, Top
-@chapter Document Structure
+@chapter Document structure
@cindex document structure
@cindex structure of document
@cindex headlines
@cindex outline tree
@vindex org-special-ctrl-a/e
+@vindex org-special-ctrl-k
+@vindex org-ctrl-k-protect-subtree
-Headlines define the structure of an outline tree. The headlines in
-Org start with one or more stars, on the left margin@footnote{See
-the variable @code{org-special-ctrl-a/e} to configure special behavior
-of @kbd{C-a} and @kbd{C-e} in headlines.}. For example:
+Headlines define the structure of an outline tree. The headlines in Org
+start with one or more stars, on the left margin@footnote{See the variables
+@code{org-special-ctrl-a/e}, @code{org-special-ctrl-k}, and
+@code{org-ctrl-k-protect-subtree} to configure special behavior of @kbd{C-a},
+@kbd{C-e}, and @kbd{C-k} in headlines.}. For example:
@example
* Top level headline
@cindex folded, subtree visibility state
@cindex children, subtree visibility state
@cindex subtree, subtree visibility state
-@table @kbd
-@kindex @key{TAB}
-@item @key{TAB}
+@table @asis
+@orgcmd{@key{TAB},org-cycle}
@emph{Subtree cycling}: Rotate current subtree among the states
@example
@cindex overview, global visibility state
@cindex contents, global visibility state
@cindex show all, global visibility state
-@kindex S-@key{TAB}
-@item S-@key{TAB}
+@orgcmd{S-@key{TAB},org-global-cycle}
@itemx C-u @key{TAB}
@emph{Global cycling}: Rotate the entire buffer among the states
tables, @kbd{S-@key{TAB}} jumps to the previous field.
@cindex show all, command
-@kindex C-u C-u C-u @key{TAB}
-@item C-u C-u C-u @key{TAB}
+@orgcmd{C-u C-u C-u @key{TAB},show-all}
Show all, including drawers.
-@kindex C-c C-r
-@item C-c C-r
+@orgcmd{C-c C-r,org-reveal}
Reveal context around point, showing the current entry, the following heading
and the hierarchy above. Useful for working near a location that has been
exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
(@pxref{Agenda commands}). With a prefix argument show, on each
-level, all sibling headings.
-@kindex C-c C-x b
-@item C-c C-x b
+level, all sibling headings. With double prefix arg, also show the entire
+subtree of the parent.
+@orgcmd{C-c C-k,show-branches}
+Expose all the headings of the subtree, CONTENT view for just one subtree.
+@orgcmd{C-c C-x b,org-tree-to-indirect-buffer}
Show the current subtree in an indirect buffer@footnote{The indirect
buffer
@ifinfo
prefix argument N, go up to level N and then take that tree. If N is
negative then go up that many levels. With a @kbd{C-u} prefix, do not remove
the previously used indirect buffer.
+@orgcmd{C-c C-x v,org-copy-visible}
+Copy the @i{visible} text in the region into the kill ring.
@end table
@vindex org-startup-folded
@cindex @code{showeverything}, STARTUP keyword
When Emacs first visits an Org file, the global state is set to
-OVERVIEW, i.e. only the top level headlines are visible. This can be
+OVERVIEW, i.e.@: only the top level headlines are visible. This can be
configured through the variable @code{org-startup-folded}, or on a
per-file basis by adding one of the following lines anywhere in the
buffer:
and Columns}) will get their visibility adapted accordingly. Allowed values
for this property are @code{folded}, @code{children}, @code{content}, and
@code{all}.
-@table @kbd
-@kindex C-u C-u @key{TAB}
-@item C-u C-u @key{TAB}
-Switch back to the startup visibility of the buffer, i.e. whatever is
+@table @asis
+@orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
+Switch back to the startup visibility of the buffer, i.e.@: whatever is
requested by startup options and @samp{VISIBILITY} properties in individual
entries.
@end table
@cindex headline navigation
The following commands jump to other headlines in the buffer.
-@table @kbd
-@kindex C-c C-n
-@item C-c C-n
+@table @asis
+@orgcmd{C-c C-n,outline-next-visible-heading}
Next heading.
-@kindex C-c C-p
-@item C-c C-p
+@orgcmd{C-c C-p,outline-previous-visible-heading}
Previous heading.
-@kindex C-c C-f
-@item C-c C-f
+@orgcmd{C-c C-f,org-forward-same-level}
Next heading same level.
-@kindex C-c C-b
-@item C-c C-b
+@orgcmd{C-c C-b,org-backward-same-level}
Previous heading same level.
-@kindex C-c C-u
-@item C-c C-u
+@orgcmd{C-c C-u,outline-up-heading}
Backward to higher level heading.
-@kindex C-c C-j
-@item C-c C-j
+@orgcmd{C-c C-j,org-goto}
Jump to a different place without changing the current outline
visibility. Shows the document structure in a temporary buffer, where
you can use the following keys to find your destination:
@cindex sorting, of subtrees
@cindex subtrees, cut and paste
-@table @kbd
-@kindex M-@key{RET}
-@item M-@key{RET}
+@table @asis
+@orgcmd{M-@key{RET},org-insert-heading}
@vindex org-M-RET-may-split-line
-Insert new heading with same level as current. If the cursor is in a
-plain list item, a new item is created (@pxref{Plain lists}). To force
-creation of a new headline, use a prefix argument, 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@footnote{If 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.
-@kindex C-@key{RET}
-@item C-@key{RET}
+Insert new heading with same level as current. If the cursor is in a plain
+list item, a new item is created (@pxref{Plain lists}). To force creation of
+a new headline, use a prefix argument. 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@footnote{If 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.
+@orgcmd{C-@key{RET},org-insert-heading-respect-content}
Just like @kbd{M-@key{RET}}, except when adding a new heading below the
current heading, the new heading is placed after the body instead of before
it. This command works from anywhere in the entry.
-@kindex M-S-@key{RET}
-@item M-S-@key{RET}
+@orgcmd{M-S-@key{RET},org-insert-todo-heading}
@vindex org-treat-insert-todo-heading-as-state-change
Insert new TODO entry with same level as current heading. See also the
variable @code{org-treat-insert-todo-heading-as-state-change}.
-@kindex C-S-@key{RET}
-@item C-S-@key{RET}
+@orgcmd{C-S-@key{RET},org-insert-todo-heading-respect-content}
Insert new TODO entry with same level as current heading. Like
@kbd{C-@key{RET}}, the new headline will be inserted after the current
subtree.
-@kindex @key{TAB}
-@item @key{TAB} @r{in new, empty entry}
+@orgcmd{@key{TAB},org-cycle}
In a new entry with no text yet, the first @key{TAB} demotes the entry to
become a child of the previous one. The next @key{TAB} makes it a parent,
and so on, all the way to top level. Yet another @key{TAB}, and you are back
to the initial level.
-@kindex M-@key{left}
-@item M-@key{left}
+@orgcmd{M-@key{left},org-do-promote}
Promote current heading by one level.
-@kindex M-@key{right}
-@item M-@key{right}
+@orgcmd{M-@key{right},org-do-demote}
Demote current heading by one level.
-@kindex M-S-@key{left}
-@item M-S-@key{left}
+@orgcmd{M-S-@key{left},org-promote-subtree}
Promote the current subtree by one level.
-@kindex M-S-@key{right}
-@item M-S-@key{right}
+@orgcmd{M-S-@key{right},org-demote-subtree}
Demote the current subtree by one level.
-@kindex M-S-@key{up}
-@item M-S-@key{up}
+@orgcmd{M-S-@key{up},org-move-subtree-up}
Move subtree up (swap with previous subtree of same
level).
-@kindex M-S-@key{down}
-@item M-S-@key{down}
+@orgcmd{M-S-@key{down},org-move-subtree-down}
Move subtree down (swap with next subtree of same level).
-@kindex C-c C-x C-w
-@item C-c C-x C-w
-Kill subtree, i.e. remove it from buffer but save in kill ring.
+@orgcmd{C-c C-x C-w,org-cut-subtree}
+Kill subtree, i.e.@: remove it from buffer but save in kill ring.
With a numeric prefix argument N, kill N sequential subtrees.
-@kindex C-c C-x M-w
-@item C-c C-x M-w
+@orgcmd{C-c C-x M-w,org-copy-subtree}
Copy subtree to kill ring. With a numeric prefix argument N, copy the N
sequential subtrees.
-@kindex C-c C-x C-y
-@item C-c C-x C-y
+@orgcmd{C-c C-x C-y,org-paste-subtree}
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 numeric prefix argument, or by yanking after a
headline marker like @samp{****}.
-@kindex C-y
-@item C-y
+@orgcmd{C-y,org-yank}
@vindex org-yank-adjusted-subtrees
@vindex org-yank-folded-subtrees
Depending on the variables @code{org-yank-adjusted-subtrees} and
force a normal yank is @kbd{C-u C-y}. If you use @code{yank-pop} after a
yank, it will yank previous kill items plainly, without adjustment and
folding.
-@kindex C-c C-x c
-@item C-c C-x c
+@orgcmd{C-c C-x c,org-clone-subtree-with-time-shift}
Clone a subtree by making a number of sibling copies of it. You will be
prompted for the number of copies to make, and you can also specify if any
timestamps in the entry should be shifted. This can be useful, for example,
to create a number of tasks related to a series of lectures to prepare. For
more details, see the docstring of the command
@code{org-clone-subtree-with-time-shift}.
-@kindex C-c C-w
-@item C-c C-w
+@orgcmd{C-c C-w,org-refile}
Refile entry or region to a different location. @xref{Refiling notes}.
-@kindex C-c ^
-@item C-c ^
+@orgcmd{C-c ^,org-sort-entries-or-items}
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
your own function to extract the sorting key. 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.
-@kindex C-x n s
-@item C-x n s
+@orgcmd{C-x n s,org-narrow-to-subtree}
Narrow buffer to current subtree.
-@kindex C-x n w
-@item C-x n w
+@orgcmd{C-x n b,org-narrow-to-block}
+Narrow buffer to current block.
+@orgcmd{C-x n w,widen}
Widen buffer to remove narrowing.
-@kindex C-c *
-@item C-c *
+@orgcmd{C-c *,org-toggle-heading}
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
@vindex org-show-following-heading
@vindex org-show-siblings
@vindex org-show-entry-below
-An important feature of Org mode is the ability to construct @emph{sparse
+An important feature of Org-mode is the ability to construct @emph{sparse
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 it@footnote{See also the
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, all these
+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 /
+@table @asis
+@orgcmd{C-c /,org-sparse-tree}
This prompts for an extra key to select a sparse-tree creating command.
-@kindex C-c / r
-@item C-c / r
+@orgcmd{C-c / r,org-occur}
@vindex org-remove-highlights-with-change
-Occur. Prompts for a regexp and shows a sparse tree with all matches. If
+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
@code{org-remove-highlights-with-change}}, 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.
+@orgcmdkkc{M-g n,M-g M-n,next-error}
+Jump to the next sparse tree match in this buffer.
+@orgcmdkkc{M-g p,M-g M-p,previous-error}
+Jump to the previous sparse tree match in this buffer.
@end table
+
@noindent
@vindex org-agenda-custom-commands
For frequently used sparse trees of specific search strings, you can
@cindex ordered lists
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 supports editing such lists,
-and the HTML exporter (@pxref{Exporting}) parses and formats them.
+additional structure. They also provide a way to create lists of checkboxes
+(@pxref{Checkboxes}). Org supports editing such lists, and every exporter
+(@pxref{Exporting}) can parse and format them.
Org knows ordered lists, unordered lists, and description lists.
@itemize @bullet
@emph{Unordered} list items start with @samp{-}, @samp{+}, or
@samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
they will be seen as top-level headlines. Also, when you are hiding leading
-stars to get a clean outline view, plain list items starting with a star are
-visually indistinguishable from true headlines. In short: even though
-@samp{*} is supported, it may be better to not use it for plain list items.}
-as bullets.
+stars to get a clean outline view, plain list items starting with a star may
+be hard to distinguish from true headlines. In short: even though @samp{*}
+is supported, it may be better to not use it for plain list items.} as
+bullets.
@item
+@vindex org-plain-list-ordered-item-terminator
+@vindex org-alphabetical-lists
@emph{Ordered} list items start with a numeral followed by either a period or
-a right parenthesis, such as @samp{1.} or @samp{1)}.
+a right parenthesis@footnote{You can filter out any of them by configuring
+@code{org-plain-list-ordered-item-terminator}.}, such as @samp{1.} or
+@samp{1)}@footnote{You can also get @samp{a.}, @samp{A.}, @samp{a)} and
+@samp{A)} by configuring @code{org-alphabetical-lists}. To minimize
+confusion with normal text, those are limited to one character only. Beyond
+that limit, bullets will automatically fallback to numbers.}. If you want a
+list to start with a different value (e.g.@: 20), start the text of the item
+with @code{[@@20]}@footnote{If there's a checkbox in the item, the cookie
+must be put @emph{before} the checkbox. If you have activated alphabetical
+lists, you can also use counters like @code{[@@b]}.}. Those constructs can
+be used in any item of the list in order to enforce a particular numbering.
@item
@emph{Description} list items are unordered list items, and contain the
-separator @samp{ :: } to separate the description @emph{term} from the
+separator @samp{ :: } to distinguish the description @emph{term} from the
description.
@end itemize
-@vindex org-empty-line-terminates-plain-lists
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. 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 @code{org-empty-line-terminates-plain-lists}.
-Here is an example:
+list. An item ends before the next line that is less or equally indented
+than its bullet/number.
+
+@vindex org-list-ending-method
+@vindex org-list-end-regexp
+@vindex org-empty-line-terminates-plain-lists
+Two methods@footnote{To disable either of them, configure
+@code{org-list-ending-method}.} are provided to terminate lists. A list ends
+whenever every item has ended, which means before any line less or equally
+indented than items at top level. It also ends before two blank
+lines@footnote{See also @code{org-empty-line-terminates-plain-lists}.}. In
+that case, all items are closed. For finer control, you can end lists with
+any pattern set in @code{org-list-end-regexp}. Here is an example:
@example
@group
+ this was already my favorite scene in the book
+ I really like Miranda Otto.
3. Peter Jackson being shot by Legolas
- - on DVD only
+ - on DVD only
He makes a really funny face when it happens.
But in the end, no individual scenes matter but the film as a whole.
Important actors in this film are:
put into @file{.emacs}: @code{(require 'filladapt)}}, and by exporting them
properly (@pxref{Exporting}). Since indentation is what governs the
structure of these lists, many structural constructs like @code{#+BEGIN_...}
-blocks can be indented to signal that they should be part of a list item.
+blocks can be indented to signal that they belong to a particular item.
+
+@vindex org-list-demote-modify-bullet
+@vindex org-list-indent-offset
+If you find that using a different bullet for a sub-list (than that used for
+the current list-level) improves readability, customize the variable
+@code{org-list-demote-modify-bullet}. To get a greater difference of
+indentation between items and theirs sub-items, customize
+@code{org-list-indent-offset}.
+
+@vindex org-list-automatic-rules
+The following commands act on items when the cursor is in the first line of
+an item (the line with the bullet or number). Some of them imply the
+application of automatic rules to keep list structure intact. If some of
+these actions get in your way, configure @code{org-list-automatic-rules}
+to disable them individually.
-The following commands act on items when the cursor is in the first line
-of an item (the line with the bullet or number).
-
-@table @kbd
-@kindex @key{TAB}
-@item @key{TAB}
+@table @asis
+@orgcmd{@key{TAB},org-cycle}
@vindex org-cycle-include-plain-lists
Items can be folded just like headline levels. Normally this works only if
the cursor is on a plain list item. For more details, see the variable
-@code{org-cycle-include-plain-lists}. to @code{integrate}, plain list items
-will be treated like low-level. The level of an item is then given by the
+@code{org-cycle-include-plain-lists}. If this variable is set to
+@code{integrate}, plain list items will be treated like low-level
+headlines. The level of an item is then 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 current line in a heuristic way.
-@kindex M-@key{RET}
-@item M-@key{RET}
+@orgcmd{M-@key{RET},org-insert-heading}
@vindex org-M-RET-may-split-line
+@vindex org-list-automatic-rules
Insert new item at current level. With a prefix argument, 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@footnote{If 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.
+of an item, that item is @emph{split} in two, and the second part becomes the
+new item@footnote{If you do not want the item to be split, customize the
+variable @code{org-M-RET-may-split-line}.}. If this command is executed
+@emph{before item's body}, the new item is created @emph{before} the current
+one.
@kindex M-S-@key{RET}
@item M-S-@key{RET}
Insert a new item with a checkbox (@pxref{Checkboxes}).
-@kindex @key{TAB}
-@item @key{TAB} @r{in new, empty item}
+@orgcmd{@key{TAB},org-cycle}
In a new item with no text yet, the first @key{TAB} demotes the item to
-become a child of the previous one. The next @key{TAB} makes it a parent,
-and so on, all the way to the left margin. Yet another @key{TAB}, and you
-are back to the initial level.
-@kindex S-@key{up}
+become a child of the previous one. Subsequent @key{TAB}s move the item to
+meaningful levels in the list and eventually get it back to its initial
+position.
@kindex S-@key{down}
@item S-@key{up}
@itemx S-@key{down}
@cindex shift-selection-mode
@vindex org-support-shift-select
-Jump to the previous/next item in the current list, but only if
+@vindex org-list-use-circular-motion
+Jump to the previous/next item in the current list@footnote{If you want to
+cycle around items that way, you may customize
+@code{org-list-use-circular-motion}.}, but only if
@code{org-support-shift-select} is off. If not, you can still use paragraph
jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite
similar effect.
-@kindex M-S-@key{up}
-@kindex M-S-@key{down}
-@item M-S-@key{up}
-@itemx M-S-@key{down}
-Move the item including subitems up/down (swap with previous/next item
-of same indentation). If the list is ordered, renumbering is
-automatic.
+@kindex M-@key{up}
+@kindex M-@key{down}
+@item M-@key{up}
+@itemx M-@key{down}
+Move the item including subitems up/down@footnote{See
+@code{org-liste-use-circular-motion} for a cyclic behavior.} (swap with
+previous/next item of same indentation). If the list is ordered, renumbering
+is automatic.
+@kindex M-@key{left}
+@kindex M-@key{right}
+@item M-@key{left}
+@itemx M-@key{right}
+Decrease/increase the indentation of an item, leaving children alone.
@kindex M-S-@key{left}
@kindex M-S-@key{right}
@item M-S-@key{left}
@itemx M-S-@key{right}
Decrease/increase the indentation of the item, including subitems.
-Initially, the item tree is selected based on current indentation.
-When these commands are executed several times in direct succession,
-the initially selected region is used, even if the new indentation
-would imply a different hierarchy. To use the new hierarchy, break
-the command chain with a cursor motion or so.
+Initially, the item tree is selected based on current indentation. When
+these commands are executed several times in direct succession, the initially
+selected region is used, even if the new indentation would imply a different
+hierarchy. To use the new hierarchy, break the command chain with a cursor
+motion or so.
+
+As a special case, using this command on the very first item of a list will
+move the whole list. This behavior can be disabled by configuring
+@code{org-list-automatic-rules}. The global indentation of a list has no
+influence on the text @emph{after} the list.
@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. 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.
+state of the checkbox. In any case, verify bullets and indentation
+consistency in the whole list.
@kindex C-c -
+@vindex org-plain-list-ordered-item-terminator
+@vindex org-list-automatic-rules
@item C-c -
Cycle the entire list level through the different itemize/enumerate bullets
-(@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}). With a numeric prefix
-argument N, 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
+(@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}) or a subset of them,
+depending on @code{org-plain-list-ordered-item-terminator}, the type of list,
+and its position@footnote{See @code{bullet} rule in
+@code{org-list-automatic-rules} for more information.}. With a numeric
+prefix argument N, select the Nth bullet from this list. If there is an
+active region when calling this, selected text will be changed into an item.
+With a prefix argument, all lines will be converted to list items. If the
+first line already was a list item, any item marker will be removed from the
list. Finally, even without an active region, a normal line will be
converted into a list item.
@kindex C-c *
@item C-c *
Turn a plain list item into a headline (so that it becomes a subheading at
-its location). @xref{Structure editing}, for a detailed explanation.
+its location). @xref{Structure editing}, for a detailed explanation.
+@kindex C-c C-*
+@item C-c C-*
+Turn the whole plain list into a subtree of the current heading. Checkboxes
+(@pxref{Checkboxes}) will become TODO (resp. DONE) keywords when unchecked
+(resp. checked).
@kindex S-@key{left}
@kindex S-@key{right}
@item S-@key{left}/@key{right}
@vindex org-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}.
+normally don't want to see it. For this, Org-mode has @emph{drawers}.
Drawers need to be configured with the variable
@code{org-drawers}@footnote{You can define drawers on a per-file basis
with a line like @code{#+DRAWERS: HIDDEN PROPERTIES STATE}}. Drawers
** This is a headline
Still outside the drawer
:DRAWERNAME:
- This is inside the drawer.
+ This is inside the drawer.
:END:
After the drawer.
@end 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 the @code{PROPERTIES} drawer for
+press @key{TAB} there. Org-mode uses the @code{PROPERTIES} drawer for
storing properties (@pxref{Properties and Columns}), and you can also arrange
for state change notes (@pxref{Tracking TODO state changes}) and clock times
-(@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}.
+(@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}. If you
+want to store a quick note in the LOGBOOK drawer, in a similar way to state changes, use
+
+@table @kbd
+@kindex C-c C-z
+@item C-c C-z
+Add a time-stamped note to the LOGBOOK drawer.
+@end table
@node Blocks, Footnotes, Drawers, Document Structure
@section Blocks
@section Footnotes
@cindex footnotes
-Org mode supports the creation of footnotes. In contrast to the
-@file{footnote.el} package, Org mode's footnotes are designed for work on a
+Org-mode supports the creation of footnotes. In contrast to the
+@file{footnote.el} package, Org-mode's footnotes are designed for work on a
larger document, not only for one-off documents like emails. The basic
-syntax is similar to the one used by @file{footnote.el}, i.e. a footnote is
+syntax is similar to the one used by @file{footnote.el}, i.e.@: a footnote is
defined in a paragraph that is started by a footnote marker in square
brackets in column 0, no indentation allowed. If you need a paragraph break
-inside a footnote, use the La@TeX{} idiom @samp{\par}. The footnote reference
+inside a footnote, use the @LaTeX{} idiom @samp{\par}. The footnote reference
is simply the marker in square brackets, inside text. For example:
@example
[fn:1] The link is: http://orgmode.org
@end example
-Org mode extends the number-based syntax to @emph{named} footnotes and
+Org-mode extends the number-based syntax to @emph{named} footnotes and
optional inline definition. Using plain numbers as markers (as
@file{footnote.el} does) is supported for backward compatibility, but not
-encouraged because of possible conflicts with La@TeX{} snippets (@pxref{Embedded
+encouraged because of possible conflicts with @LaTeX{} snippets (@pxref{Embedded
LaTeX}). Here are the valid references:
@table @code
A named footnote reference, where @code{name} is a unique label word, or, for
simplicity of automatic creation, a number.
@item [fn:: This is the inline definition of this footnote]
-A La@TeX{}-like anonymous footnote where the definition is given directly at the
+A @LaTeX{}-like anonymous footnote where the definition is given directly at the
reference point.
@item [fn:name: a definition]
An inline definition of a footnote, which also specifies a name for the note.
@vindex org-footnote-auto-label
Footnote labels can be created automatically, or you can create names yourself.
This is handled by the variable @code{org-footnote-auto-label} and its
-corresponding @code{#+STARTUP} keywords, see the docstring of that variable
+corresponding @code{#+STARTUP} keywords. See the docstring of that variable
for details.
@noindent The following command handles footnotes:
n @r{Normalize the footnotes by collecting all definitions (including}
@r{inline definitions) into a special section, and then numbering them}
@r{in sequence. The references will then also be numbers. This is}
- @r{meant to be the final step before finishing a document (e.g. sending}
+ @r{meant to be the final step before finishing a document (e.g.@: sending}
@r{off an email). The exporters do this automatically, and so could}
@r{something like @code{message-send-hook}.}
d @r{Delete the footnote at point, and all definitions of and references}
@cindex Orgstruct mode
@cindex minor mode for structure editing
-If you like the intuitive way the Org mode structure editing and list
+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 @code{orgstruct-mode} makes
this possible. Toggle the mode with @kbd{M-x orgstruct-mode}, or
-turn it on by default, for example in Mail mode, with one of:
+turn it on by default, for example in Message mode, with one of:
@lisp
-(add-hook 'mail-mode-hook 'turn-on-orgstruct)
-(add-hook 'mail-mode-hook 'turn-on-orgstruct++)
+(add-hook 'message-mode-hook 'turn-on-orgstruct)
+(add-hook 'message-mode-hook 'turn-on-orgstruct++)
@end lisp
When this mode is active and the cursor is on a line that looks to Org like a
headline or 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. When you use
+lines, Orgstruct mode lurks silently in the shadows. When you use
@code{orgstruct++-mode}, Org will also export indentation and autofill
settings into that mode, and detect item context after the first line of an
item.
@cindex editing tables
Org comes with a fast and intuitive table editor. Spreadsheet-like
-calculations are supported in connection with the Emacs @file{calc}
-package
+calculations are supported using the Emacs @file{calc} package
@ifinfo
(@pxref{Top,Calc,,Calc,Gnu Emacs Calculator Manual}).
@end ifinfo
@section The built-in table editor
@cindex table editor, built-in
-Org makes it easy to format tables in plain ASCII. Any line with
-@samp{|} as the first non-whitespace character is considered part of a
-table. @samp{|} is also the column separator. A table might look like
-this:
+Org makes it easy to format tables in plain ASCII. Any line with @samp{|} as
+the first non-whitespace character is considered part of a table. @samp{|}
+is also the column separator@footnote{To insert a vertical bar into a table
+field, use @code{\vert} or, inside a word @code{abc\vert@{@}def}.}. A table
+might look like this:
@example
| Name | Phone | Age |
@table @kbd
@tsubheading{Creation and conversion}
-@kindex C-c |
-@item C-c |
-Convert the active region to table. If every line contains at least one
+@orgcmd{C-c |,org-table-create-or-convert-from-region}
+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
consecutive spaces, or alternatively a TAB will be the separator.
@*
If there is no active region, this command creates an empty Org
-table. But it's easier just to start typing, like
+table. But it is easier just to start typing, like
@kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
@tsubheading{Re-aligning and field motion}
-@kindex C-c C-c
-@item C-c C-c
+@orgcmd{C-c C-c,org-table-align}
Re-align the table without moving the cursor.
@c
-@kindex @key{TAB}
-@item @key{TAB}
+@orgcmd{<TAB>,org-table-next-field}
Re-align the table, move to the next field. Creates a new row if
necessary.
@c
-@kindex S-@key{TAB}
-@item S-@key{TAB}
+@orgcmd{S-@key{TAB},org-table-previous-field}
Re-align, move to previous field.
@c
-@kindex @key{RET}
-@item @key{RET}
+@orgcmd{@key{RET},org-table-next-row}
Re-align the table and move down to next row. Creates a new row if
necessary. At the beginning or end of a line, @key{RET} still does
NEWLINE, so it can be used to split a table.
@c
-@kindex M-a
-@item M-a
+@orgcmd{M-a,org-table-beginning-of-field}
Move to beginning of the current table field, or on to the previous field.
-@kindex M-e
-@item M-e
+@orgcmd{M-e,org-table-end-of-field}
Move to end of the current table field, or on to the next field.
@tsubheading{Column and row editing}
-@kindex M-@key{left}
-@kindex M-@key{right}
-@item M-@key{left}
-@itemx M-@key{right}
+@orgcmdkkcc{M-@key{left},M-@key{right},org-table-move-column-left,org-table-move-column-right}
Move the current column left/right.
@c
-@kindex M-S-@key{left}
-@item M-S-@key{left}
+@orgcmd{M-S-@key{left},org-table-delete-column}
Kill the current column.
@c
-@kindex M-S-@key{right}
-@item M-S-@key{right}
+@orgcmd{M-S-@key{right},org-table-insert-column}
Insert a new column to the left of the cursor position.
@c
-@kindex M-@key{up}
-@kindex M-@key{down}
-@item M-@key{up}
-@itemx M-@key{down}
+@orgcmdkkcc{M-@key{up},M-@key{down},org-table-move-row-up,org-table-move-row-down}
Move the current row up/down.
@c
-@kindex M-S-@key{up}
-@item M-S-@key{up}
+@orgcmd{M-S-@key{up},org-table-kill-row}
Kill the current row or horizontal line.
@c
-@kindex M-S-@key{down}
-@item M-S-@key{down}
+@orgcmd{M-S-@key{down},org-table-insert-row}
Insert a new row above the current row. With a prefix argument, the line is
created below the current one.
@c
-@kindex C-c -
-@item C-c -
+@orgcmd{C-c -,org-table-insert-hline}
Insert a horizontal line below current row. With a prefix argument, the line
is created above the current line.
@c
-@kindex C-c @key{RET}
-@item C-c @key{RET}
+@orgcmd{C-c @key{RET},org-table-hline-and-move}
Insert a horizontal line below current row, and move the cursor into the row
below that line.
@c
-@kindex C-c ^
-@item C-c ^
+@orgcmd{C-c ^,org-table-sort-lines}
Sort the table lines in the region. The position of point indicates the
column to be used for sorting, and the range of lines is the range
between the nearest horizontal separator lines, or the entire table. If
argument, alphabetic sorting will be case-sensitive.
@tsubheading{Regions}
-@kindex C-c C-x M-w
-@item C-c C-x M-w
+@orgcmd{C-c C-x M-w,org-table-copy-region}
Copy a rectangular region from a table to a special clipboard. Point and
mark determine edge fields of the rectangle. If there is no active region,
copy just the current field. The process ignores horizontal separator lines.
@c
-@kindex C-c C-x C-w
-@item C-c C-x C-w
+@orgcmd{C-c C-x C-w,org-table-cut-region}
Copy a rectangular region from a table to a special clipboard, and
blank all fields in the rectangle. So this is the ``cut'' operation.
@c
-@kindex C-c C-x C-y
-@item C-c C-x C-y
+@orgcmd{C-c C-x C-y,org-table-paste-rectangle}
Paste a rectangular region into a table.
The upper left corner ends up in the current field. All involved fields
will be overwritten. If the rectangle does not fit into the present table,
the table is enlarged as needed. The process ignores horizontal separator
lines.
@c
-@kindex M-@key{RET}
-@itemx M-@kbd{RET}
-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 numeric
-prefix argument may be used to change the number of desired lines. If there
-is no region, the current field is split at the cursor position and the text
-fragment to the right of the cursor is prepended to the field one line
-down. If there is no region, but you specify a prefix argument, the current
-field is made blank, and the content is appended to the field above.
+@orgcmd{M-@key{RET},org-table-wrap-region}
+Split the current field at the cursor position and move the rest to the line
+below. 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 numeric prefix argument may be used to change the number
+of desired lines. If there is no region, but you specify a prefix argument,
+the current field is made blank, and the content is appended to the field
+above.
@tsubheading{Calculations}
@cindex formula, in tables
@cindex region, active
@cindex active region
@cindex transient mark mode
-@kindex C-c +
-@item C-c +
+@orgcmd{C-c +,org-table-sum}
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}.
@c
-@kindex S-@key{RET}
-@item S-@key{RET}
+@orgcmd{S-@key{RET},org-table-copy-down}
@vindex org-table-copy-increment
When current field is empty, copy from first non-empty field above. When not
empty, copy current field down to next row and move cursor along with it.
(@pxref{Conflicts}).
@tsubheading{Miscellaneous}
-@kindex C-c `
-@item C-c `
+@orgcmd{C-c `,org-table-edit-field}
Edit the current field in a separate window. This is useful for fields that
are not fully visible (@pxref{Column width and alignment}). When called with
a @kbd{C-u} prefix, just make the full field visible, so that it can be
-edited in place.
+edited in place. When called with two @kbd{C-u} prefixes, make the editor
+window follow the cursor through the table and always show the current
+field. The follow mode exits automatically when the cursor leaves the table,
+or when you repeat this command with @kbd{C-u C-u C-c `}.
@c
@item M-x org-table-import
Import a file as a table. The table should be TAB or whitespace
the buffer and then converting the region to a table. Any prefix
argument is passed on to the converter, which uses it to determine the
separator.
-@item C-c |
+@orgcmd{C-c |,org-table-create-or-convert-from-region}
Tables can also be imported by pasting tabular text into the Org
buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
@kbd{C-c |} command (see above under @i{Creation and conversion}).
@c
@item M-x org-table-export
+@findex org-table-export
@vindex org-table-export-default-format
Export the table, by default as a TAB-separated file. Use for data
exchange with, for example, spreadsheet or database programs. The format
also the alignment of a column is determined automatically from the fraction
of number-like versus non-number fields in the column.
-Sometimes a single field or a few fields need to carry more text,
-leading to inconveniently wide columns. To limit@footnote{This feature
-does not work on XEmacs.} the width of a column, one field anywhere in
-the column may contain just the string @samp{<N>} where @samp{N} is an
-integer specifying the width of the column in characters. The next
-re-align will then set the width of this column to no more than this
-value.
+Sometimes a single field or a few fields need to carry more text, leading to
+inconveniently wide columns. Or maybe you want to make a table with several
+columns having a fixed width, regardless of content. To set@footnote{This
+feature does not work on XEmacs.} the width of a column, one field anywhere
+in the column may contain just the string @samp{<N>} where @samp{N} is an
+integer specifying the width of the column in characters. The next re-align
+will then set the width of this column to this value.
@example
@group
@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.
+Note that the full text is still in the buffer but is hidden.
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
@end example
If you would like to overrule the automatic alignment of number-rich columns
-to the right and of string-rich column to the left, you and use @samp{<r>} or
-@samp{<l>} in a similar fashion. You may also combine alignment and field
-width like this: @samp{<l10>}.
+to the right and of string-rich column to the left, you can use @samp{<r>},
+@samp{c}@footnote{Centering does not work inside Emacs, but it does have an
+effect when exporting to HTML.} or @samp{<l>} in a similar fashion. You may
+also combine alignment and field width like this: @samp{<l10>}.
+
+Lines which only contain these formatting cookies will be removed
+automatically when exporting the document.
@node Column groups, Orgtbl mode, Column width and alignment, Tables
@section Column groups
marked with vertical lines. Here is an example:
@example
-| | 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)))
+| 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: $2=$1^2::$3=$1^3::$4=$1^4::$5=sqrt($1)::$6=sqrt(sqrt(($1)))
@end example
It is also sufficient to just insert the column group starters after
-every vertical line you'd like to have:
+every vertical line you would like to have:
@example
| N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
might also want to use it in other modes like Text mode or Mail mode.
The minor mode Orgtbl mode makes this possible. You can always toggle
the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for
-example in mail mode, use
+example in Message mode, use
@lisp
-(add-hook 'mail-mode-hook 'turn-on-orgtbl)
+(add-hook 'message-mode-hook 'turn-on-orgtbl)
@end lisp
Furthermore, with some special setup, it is possible to maintain tables
in arbitrary syntax with Orgtbl mode. For example, it is possible to
-construct La@TeX{} tables with the underlying ease and power of
+construct @LaTeX{} tables with the underlying ease and power of
Orgtbl mode, including spreadsheet capabilities. For details, see
@ref{Tables in arbitrary syntax}.
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. While fully featured, Org's
-implementation is not identical to other spreadsheets. For example,
-Org 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.
+derive fields from other fields. While fully featured, Org's implementation
+is not identical to other spreadsheets. For example, Org 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. There is
+also a formula debugger, and a formula editor with features for highlighting
+fields in the table corresponding to the references at the point in the
+formula, moving these references by arrow keys
@menu
* References:: How to refer to another field or range
* Formula syntax for Calc:: Using Calc to compute stuff
* Formula syntax for Lisp:: Writing formulas in Emacs Lisp
-* Field formulas:: Formulas valid for a single field
+* Durations and time values:: How to compute durations and time values
+* Field and range formulas:: Formula for specific (ranges of) fields
* Column formulas:: Formulas valid for an entire column
* Editing and debugging formulas:: Fixing formulas
* Updating the table:: Recomputing all dependent fields
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.
-@c Such references are always fixed to that field, they don't change
-@c when you copy and paste a formula to a different field. So
-@c Org's @code{B3} behaves like @code{$B$3} in other spreadsheets.
-
-@noindent
-Org also uses another, more general operator that looks like this:
+@vindex org-table-use-standard-references
+However, Org prefers@footnote{Org will understand references typed by the
+user as @samp{B4}, but it will not use this syntax when offering a formula
+for editing. You can customize this behavior using the variable
+@code{org-table-use-standard-references}.} to use another, more general
+representation that looks like this:
@example
@@@var{row}$@var{column}
@end example
-@noindent
-Column references can be absolute like @samp{1}, @samp{2},...@samp{@var{N}},
-or relative to the current column like @samp{+1} or @samp{-2}.
-
-The row specification only counts data lines and ignores horizontal
-separator lines (hlines). You can use absolute row numbers
-@samp{1}...@samp{@var{N}}, 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@footnote{Note 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.
-
-@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.
+Column specifications can be absolute like @code{$1},
+@code{$2},...@code{$@var{N}}, or relative to the current column (i.e.@: the
+column of the field which is being computed) like @code{$+1} or @code{$-2}.
+@code{$<} and @code{$>} are immutable references to the first and last
+column, respectively, and you can use @code{$>>>} to indicate the third
+column from the right.
+
+The row specification only counts data lines and ignores horizontal separator
+lines (hlines). Like with columns, you can use absolute row numbers
+@code{@@1}, @code{@@2},...@code{@@@var{N}}, and row numbers relative to the
+current row like @code{@@+3} or @code{@@-1}. @code{@@<} and @code{@@>} are
+immutable references the first and last@footnote{For backward compatibility
+you can also use special names like @code{$LR5} and @code{$LR12} to refer in
+a stable way to the 5th and 12th field in the last row of the table.
+However, this syntax is deprecated, it should not be used for new documents.
+Use @code{@@>$} instead.} row in the table, respectively. You may also
+specify the row relative to one of the hlines: @code{@@I} refers to the first
+hline, @code{@@II} to the second, etc@. @code{@@-I} refers to the first such
+line above the current line, @code{@@+I} to the first such line below the
+current line. You can also write @code{@@III+2} which is the second data line
+after the third hline in the table.
+
+@code{@@0} and @code{$0} refer to the current row and column, respectively,
+i.e. to the row/column for the field being computed. Also, if you omit
+either the column or the row part of the reference, the current row/column is
+implied.
Org's references with @emph{unsigned} numbers are fixed references
in the sense that if you use the same reference in the formula for two
references because the same reference operator can reference different
fields depending on the field being calculated by the formula.
-As a special case, references like @samp{$LR5} and @samp{$LR12} can be used
-to refer in a stable way to the 5th and 12th field in the last row of the
-table.
-
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$3 @r{2nd row, 3rd column (same as @code{C2})}
+$5 @r{column 5 in the current row (same as @code{E&})}
@@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}
+@@>$5 @r{field in the last row, in column 5}
@end example
@subsubheading Range references
@samp{@@} in order to be interpreted correctly). Examples:
@example
-$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..$3 @r{first three fields in the current row}
+$P..$Q @r{range, using column names (see under Advanced)}
+$<<<..$>> @r{start in third column, continue to the one but last}
+@@2$1..@@4$3 @r{6 fields between these two fields (same as @code{A2..C4})}
@@-1$-2..@@-1 @r{3 numbers from the column to the left, 2 up to current row}
+@@I..II @r{between first and second hline, short for @code{@@I..@@II}}
@end example
@noindent Range references return a vector of values that can be fed
see the @samp{E} mode switch below). If there are no non-empty fields,
@samp{[0]} is returned to avoid syntax errors in formulas.
+@subsubheading Field coordinates in formulas
+@cindex field coordinates
+@cindex coordinates, of field
+@cindex row, of field coordinates
+@cindex column, of field coordinates
+
+For Calc formulas and Lisp formulas @code{@@#} and @code{$#} can be used to
+get the row or column number of the field where the formula result goes.
+The traditional Lisp formula equivalents are @code{org-table-current-dline}
+and @code{org-table-current-column}. Examples:
+
+@example
+if(@@# % 2, $#, string("")) @r{column number on odd lines only}
+$3 = remote(FOO, @@@@#$2) @r{copy column 2 from table FOO into}
+ @r{column 3 of the current table}
+@end example
+
+@noindent For the second example, table FOO must have at least as many rows
+as the current table. Note that this is inefficient@footnote{The computation time scales as
+O(N^2) because table FOO is parsed for each field to be copied.} for large
+number of rows.
+
@subsubheading Named references
@cindex named references
@cindex references, named
@code{org-calc-default-modes}.
@example
-p20 @r{switch the internal precision to 20 digits}
-n3 s3 e2 f4 @r{normal, scientific, engineering, or fixed display format}
+p20 @r{set the internal Calc calculation precision to 20 digits}
+n3 s3 e2 f4 @r{Normal, scientific, engineering, or fixed}
+ @r{format of the result of Calc passed back to Org.}
+ @r{Calc formatting is unlimited in precision as}
+ @r{long as the Calc calculation precision is greater.}
D R @r{angle modes: degrees, radians}
F S @r{fraction and symbolic modes}
N @r{interpret all fields as numbers, use 0 for non-numbers}
-T @r{force text interpretation}
E @r{keep empty fields in ranges}
L @r{literal}
@end example
@noindent
-In addition, you may provide a @code{printf} format specifier to
-reformat the final result. A few examples:
+Unless you use large integer numbers or high-precision-calculation
+and -display for floating point numbers you may alternatively provide a
+@code{printf} format specifier to reformat the Calc result after it has been
+passed back to Org instead of letting Calc already do the
+formatting@footnote{The @code{printf} reformatting is limited in precision
+because the value passed to it is converted into an @code{integer} or
+@code{double}. The @code{integer} is limited in size by truncating the
+signed value to 32 bits. The @code{double} is limited in precision to 64
+bits overall which leaves approximately 16 significant decimal digits.}.
+A few examples:
@example
$1+$2 @r{Sum of first and second field}
sin($1);Dp3%.1e @r{Same, but use printf specifier for display}
vmean($2..$7) @r{Compute column range mean, using vector function}
vmean($2..$7);EN @r{Same, but treat empty fields as 0}
-taylor($3,x=7,2) @r{taylor series of $3, at x=7, second degree}
+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
@example
-if($1<20,teen,string("")) @r{``teen'' if age $1 less than 20, else empty}
+if($1<20,teen,string("")) @r{"teen" if age $1 less than 20, else empty}
@end example
-@node Formula syntax for Lisp, Field formulas, Formula syntax for Calc, The spreadsheet
+Note that you can also use two org-specific flags @code{T} and @code{t} for
+durations computations @ref{Durations and time values}.
+
+@node Formula syntax for Lisp, Durations and time values, 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 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
-@file{calc} formulas, you can specify modes and a printf format after a
-semicolon. With Emacs Lisp forms, you need to be conscious 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
-@samp{L} 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, enclose the reference operator itself in double-quotes, like
-@code{"$3"}. 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.
+It is also possible to write a formula in Emacs Lisp; this can be useful for
+string manipulation and control structures, if 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 @file{calc} formulas, you
+can specify modes and a printf format after a semicolon. With Emacs Lisp
+forms, you need to be conscious 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 @samp{L} 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, enclose the reference operator itself in double-quotes,
+like @code{"$3"}. Ranges are inserted as space-separated fields, so you can
+embed them in list or vector syntax. Here are a few examples---note how the
+@samp{N} mode is used when we do computations in Lisp:
@example
@r{Swap the first two characters of the content of column 1}
'(apply '+ '($1..$4));N
@end example
-@node Field formulas, Column formulas, Formula syntax for Lisp, The spreadsheet
-@subsection Field formulas
+@node Durations and time values, Field and range formulas, Formula syntax for Lisp, The spreadsheet
+@subsection Durations and time values
+@cindex Duration, computing
+@cindex Time, computing
+@vindex org-table-duration-custom-format
+
+If you want to compute time values use the @code{T} flag, either in Calc
+formulas or Elisp formulas:
+
+@example
+@group
+ | Task 1 | Task 2 | Total |
+ |---------+----------+----------|
+ | 2:12 | 1:47 | 03:59:00 |
+ | 3:02:20 | -2:07:00 | 0.92 |
+ #+TBLFM: @@2$3=$1+$2;T::@@3$3=$1+$2;t
+@end group
+@end example
+
+Input duration values must be of the form @code{[HH:MM[:SS]}, where seconds
+are optional. With the @code{T} flag, computed durations will be displayed
+as @code{[HH:MM:SS} (see the first formula above). With the @code{t} flag,
+computed durations will be displayed according to the value of the variable
+@code{org-table-duration-custom-format}, which defaults to @code{'hours} and
+will display the result as a fraction of hours (see the second formula in the
+example above).
+
+Negative duration values can be manipulated as well, and integers will be
+considered as seconds in addition and subtraction.
+
+@node Field and range formulas, Column formulas, Durations and time values, The spreadsheet
+@subsection Field and range formulas
@cindex field formula
+@cindex range formula
@cindex formula, for individual table field
+@cindex formula, for range of fields
-To assign a formula to a particular field, type it directly into the
-field, preceded by @samp{:=}, for example @samp{:=$1+$2}. When you
-press @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in
-the field, the formula will be stored as the formula for this field,
-evaluated, and the current field replaced with the result.
+To assign a formula to a particular field, type it directly into the field,
+preceded by @samp{:=}, for example @samp{:=vsum(@@II..III)}. When you press
+@key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
+the formula will be stored as the formula for this field, evaluated, and the
+current field will be replaced with the result.
@cindex #+TBLFM
-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
-@samp{@@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 course this is not true if you edit the table structure
-with normal editing commands---then you must fix the equations yourself.
-The left-hand side of a formula may also be a named field (@pxref{Advanced
-features}), or a last-row reference like @samp{$LR3}.
-
-Instead of typing an equation into the field, you may also use the
-following command
+Formulas are stored in a special line starting with @samp{#+TBLFM:} directly
+below the table. If you type the equation in the 4th field of the 3rd data
+line in the table, the formula will look like @samp{@@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. To avoid this from
+happening, in particular in range references, anchor ranges at the table
+borders (using @code{@@<}, @code{@@>}, @code{$<}, @code{$>}), or at hlines
+using the @code{@@I} notation. Automatic adaptation of field references does
+of cause not happen 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
@table @kbd
-@kindex C-u C-c =
-@item C-u C-c =
+@orgcmd{C-u C-c =,org-table-eval-formula}
Install a new formula for the current field. The command prompts for a
formula with default taken from the @samp{#+TBLFM:} line, applies
it to the current field, and stores it.
@end table
-@node Column formulas, Editing and debugging formulas, Field formulas, The spreadsheet
+The left-hand side of a formula can also be a special expression in order to
+assign the formula to a number of different fields. There is no keyboard
+shortcut to enter such range formulas. To add them, use the formula editor
+(@pxref{Editing and debugging formulas}) or edit the @code{#+TBLFM:} line
+directly.
+
+@table @code
+@item $2=
+Column formula, valid for the entire column. This is so common that Org
+treats these formulas in a special way, see @ref{Column formulas}.
+@item @@3=
+Row formula, applies to all fields in the specified row. @code{@@>=} means
+the last row.
+@item @@1$2..@@4$3=
+Range formula, applies to all fields in the given rectangular range. This
+can also be used to assign a formula to some but not all fields in a row.
+@item $name=
+Named field, see @ref{Advanced features}.
+@end table
+
+@node Column formulas, Editing and debugging formulas, Field and range formulas, The spreadsheet
@subsection Column formulas
@cindex column formula
@cindex formula, for table column
-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 allows you to assign a single formula to an entire
-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.
+When you assign a formula to a simple column reference like @code{$3=}, the
+same formula will be used in all fields of that column, with the following
+very convenient exceptions: (i) 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. (ii) Fields that
+already get a value from a field/range formula will be left alone by column
+formulas. These conditions make column formulas very easy to use.
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
and the current field replaced with the result. If the field contains only
@samp{=}, the previously stored formula for this column is used. For each
column, Org will only remember the most recently used formula. In the
-@samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}. The left-hand
-side of a column formula cannot currently be the name of column, it
-must be the numeric column reference.
+@samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}. The
+left-hand side of a column formula can not be the name of column, it must be
+the numeric column reference or @code{$>}.
Instead of typing an equation into the field, you may also use the
following command:
@table @kbd
-@kindex C-c =
-@item C-c =
+@orgcmd{C-c =,org-table-eval-formula}
Install a new formula for the current column and replace current field with
the result of the formula. The command prompts for a formula, with default
taken from the @samp{#+TBLFM} line, applies it to the current field and
-stores it. With a numeric prefix argument(e.g. @kbd{C-5 C-c =}) the command
+stores it. With a numeric prefix argument(e.g.@: @kbd{C-5 C-c =}) the command
will apply it to that many consecutive fields in the current column.
@end table
@code{org-table-use-standard-references}.
@table @kbd
-@kindex C-c =
-@kindex C-u C-c =
-@item C-c =
-@itemx C-u C-c =
+@orgcmdkkc{C-c =,C-u C-c =,org-table-eval-formula}
Edit the formula associated with the current column/field in the
-minibuffer. See @ref{Column formulas}, and @ref{Field formulas}.
-@kindex C-u C-u C-c =
-@item C-u C-u C-c =
+minibuffer. See @ref{Column formulas}, and @ref{Field and range formulas}.
+@orgcmd{C-u C-u C-c =,org-table-eval-formula}
Re-insert the active formula (either a
field formula, or a column formula) into the current field, so that you
can edit it directly in the field. The advantage over editing in the
minibuffer is that you can use the command @kbd{C-c ?}.
-@kindex C-c ?
-@item C-c ?
+@orgcmd{C-c ?,org-table-field-info}
While editing a formula in a table field, highlight the field(s)
referenced by the reference at the cursor position in the formula.
@kindex C-c @}
+@findex org-table-toggle-coordinate-overlays
@item 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}.
+Toggle the display of row and column numbers for a table, using overlays
+(@command{org-table-toggle-coordinate-overlays}). These are updated each
+time the table is aligned; you can force it with @kbd{C-c C-c}.
@kindex C-c @{
+@findex org-table-toggle-formula-debugger
@item C-c @{
-Toggle the formula debugger on and off. See below.
-@kindex C-c '
-@item C-c '
+Toggle the formula debugger on and off
+(@command{org-table-toggle-formula-debugger}). See below.
+@orgcmd{C-c ',org-table-edit-formulas}
Edit all formulas for the current table in a special buffer, where the
formulas will be displayed one per line. If the current field has an
active formula, the cursor in the formula editor will mark it.
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
-@kindex C-x C-s
-@item C-c C-c
-@itemx C-x C-s
+@orgcmdkkc{C-c C-c,C-x C-s,org-table-fedit-finish}
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
+@orgcmd{C-c C-q,org-table-fedit-abort}
Exit the formula editor without installing changes.
-@kindex C-c C-r
-@item C-c C-r
+@orgcmd{C-c C-r,org-table-fedit-toggle-ref-type}
Toggle all references in the formula editor between standard (like
@code{B3}) and internal (like @code{@@3$2}).
-@kindex @key{TAB}
-@item @key{TAB}
+@orgcmd{@key{TAB},org-table-fedit-lisp-indent}
Pretty-print or indent Lisp formula at point. When in a line containing
a Lisp formula, format the formula according to Emacs Lisp rules.
Another @key{TAB} collapses the formula back again. In the open
formula, @key{TAB} re-indents just like in Emacs Lisp mode.
-@kindex M-@key{TAB}
-@item M-@key{TAB}
+@orgcmd{M-@key{TAB},lisp-complete-symbol}
Complete Lisp symbols, just like in Emacs Lisp mode.
@kindex S-@key{up}
@kindex S-@key{down}
@kindex S-@key{left}
@kindex S-@key{right}
+@findex org-table-fedit-ref-up
+@findex org-table-fedit-ref-down
+@findex org-table-fedit-ref-left
+@findex org-table-fedit-ref-right
@item S-@key{up}/@key{down}/@key{left}/@key{right}
Shift the reference at point. For example, if the reference is
@code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
This also works for relative references and for hline references.
-@kindex M-S-@key{up}
-@kindex M-S-@key{down}
-@item M-S-@key{up}/@key{down}
+@orgcmdkkcc{M-S-@key{up},M-S-@key{down},org-table-fedit-line-up,org-table-fedit-line-down}
Move the test line for column formulas in the Org buffer up and
down.
-@kindex M-@key{up}
-@kindex M-@key{down}
-@item M-@key{up}/@key{down}
+@orgcmdkkcc{M-@key{up},M-@key{down},org-table-fedit-scroll-down,org-table-fedit-scroll-up}
Scroll the window displaying the table.
@kindex C-c @}
+@findex org-table-toggle-coordinate-overlays
@item C-c @}
Turn the coordinate grid in the table on and off.
@end table
following commands:
@table @kbd
-@kindex C-c *
-@item C-c *
+@orgcmd{C-c *,org-table-recalculate}
Recalculate the current row by first applying the stored column formulas
-from left to right, and all field formulas in the current row.
+from left to right, and all field/range formulas in the current row.
@c
@kindex C-u C-c *
@item C-u 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.
@c
-@kindex C-u C-u C-c *
-@kindex C-u C-u C-c C-c
-@item C-u C-u C-c *
-@itemx C-u C-u C-c C-c
+@orgcmdkkc{C-u C-u C-c *,C-u C-u C-c C-c,org-table-iterate}
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.
+@item M-x org-table-recalculate-buffer-tables
+@findex org-table-recalculate-buffer-tables
+Recompute all tables in the current buffer.
+@item M-x org-table-iterate-buffer-tables
+@findex org-table-iterate-buffer-tables
+Iterate all tables in the current buffer, in order to converge table-to-table
+dependencies.
@end table
@node Advanced features, , Updating the table, The spreadsheet
If you want the recalculation of fields to happen automatically, or if
you want to be able to assign @i{names} to fields and columns, you need
to reserve the first column of the table for special marking characters.
+
@table @kbd
-@kindex C-#
-@item C-#
+@orgcmd{C-#,org-table-rotate-recalc-marks}
Rotate the calculation mark in first column through the states @samp{ },
@samp{#}, @samp{*}, @samp{!}, @samp{$}. When there is an active region,
change all marks in the region.
@node Org-Plot, , The spreadsheet, Tables
@section Org-Plot
@cindex graph, in tables
-@cindex plot tables using gnuplot
+@cindex plot tables using Gnuplot
@cindex #+PLOT
Org-Plot can produce 2D and 3D graphs of information stored in org tables
be exercised through the @code{#+PLOT:} lines preceding a table. See below
for a complete list of Org-plot options. For more information and examples
see the Org-plot tutorial at
-@uref{http://orgmode.org/worg/org-tutorials/org-plot.php}.
+@uref{http://orgmode.org/worg/org-tutorials/org-plot.html}.
@subsubheading Plot Options
@item with
Specify a @code{with} option to be inserted for every col being plotted
-(e.g. @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
+(e.g.@: @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
Defaults to @code{lines}.
@item file
If you want to plot to a file, specify @code{"@var{path/to/desired/output-file}"}.
@item labels
-List of labels to be used for the deps (defaults to the column headers if
-they exist).
+List of labels to be used for the @code{deps} (defaults to the column headers
+if they exist).
@item line
Specify an entire line to be inserted in the Gnuplot script.
point to the corresponding headline. The preferred match for a text link is
a @i{dedicated target}: the same string in double angular brackets. Targets
may be located anywhere; sometimes it is convenient to put them into a
-comment line. For example
+comment line. For example
@example
# <<My Target>>
target should be after the first headline, or in the line directly before the
first headline.}.
-If no dedicated target exists, Org will search for the words in the link. In
-the above example the search would be for @samp{my target}. Links starting
-with a star like @samp{*My Target} restrict the search to
-headlines@footnote{To insert a link targeting a headline, in-buffer
-completion can be used. Just type a star followed by a few optional letters
-into the buffer and press @kbd{M-@key{TAB}}. All headlines in the current
-buffer will be offered as completions. @xref{Handling links}, for more
-commands creating links.}. When searching, Org mode will first try an
-exact match, but then move on to more and more lenient searches. For
-example, the link @samp{[[*My Targets]]} will find any of the following:
-
-@example
-** My targets
-** TODO my targets are bright
-** my 20 targets are
-@end example
-
+If no dedicated target exists, Org will search for a headline that is exactly
+the link text but may also include a TODO keyword and tags@footnote{To insert
+a link targeting a headline, in-buffer completion can be used. Just type a
+star followed by a few optional letters into the buffer and press
+@kbd{M-@key{TAB}}. All headlines in the current buffer will be offered as
+completions.}. In non-Org files, the search will look for the words in the
+link text. In the above example the search would be for @samp{my target}.
Following a link pushes a mark onto Org's own mark ring. You can
return to the previous position with @kbd{C-c &}. Using this command
@example
http://www.astro.uva.nl/~dominik @r{on the web}
+doi:10.1000/182 @r{DOI for an electronic resource}
file:/home/dominik/images/jupiter.jpg @r{file, absolute path}
/home/dominik/images/jupiter.jpg @r{same as above}
file:papers/last.pdf @r{file, relative path}
./papers/last.pdf @r{same as above}
+file:/myself@@some.where:papers/last.pdf @r{file, path on remote machine}
+/myself@@some.where:papers/last.pdf @r{same as above}
file:sometextfile::NNN @r{file with line number to jump to}
file:projects.org @r{another Org file}
file:projects.org::some words @r{text search in Org file}
file:projects.org::*task title @r{heading search in Org file}
+docview:papers/last.pdf::NNN @r{open file in doc-view mode at page NNN}
id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID}
news:comp.emacs @r{Usenet link}
mailto:adent@@galaxy.net @r{Mail link}
gnus:group#id @r{Gnus article link}
bbdb:R.*Stallman @r{BBDB link (with regexp)}
irc:/irc.com/#emacs/bob @r{IRC link}
+info:org#External%20links @r{Info node link (with encoded space)}
shell:ls *.org @r{A shell command}
elisp:org-agenda @r{Interactive Elisp command}
elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
@end example
+For customizing Org to add new link types @ref{Adding hyperlink types}.
+
A link should be enclosed in double brackets and may contain a
descriptive text to be displayed instead of the URL (@pxref{Link
format}), for example:
insert it into an Org file, and to follow the link.
@table @kbd
-@kindex C-c l
+@orgcmd{C-c l,org-store-link}
@cindex storing links
-@item C-c l
Store a link to the current location. This is a @emph{global} command (you
must create the key binding yourself) which can be used in any buffer to
create a link. The link will be stored for later insertion into an Org
@b{Org-mode buffers}@*
For Org files, if there is a @samp{<<target>>} at the cursor, the link points
to the target. Otherwise it points to the current headline, which will also
-be the description.
+be the description@footnote{If the headline contains a timestamp, it will be
+removed from the link and result in a wrong link -- you should avoid putting
+timestamp in the headline.}.
@vindex org-link-to-org-use-id
@cindex property, CUSTOM_ID
entry referenced by the current line.
@c
-@kindex C-c C-l
+@orgcmd{C-c C-l,org-insert-link}
@cindex link completion
@cindex completion, of links
@cindex inserting links
-@item C-c C-l
@vindex org-keep-stored-link-after-insertion
Insert a link@footnote{ Note that you don't have to use this command to
insert a link. Links in Org are plain text, and you can type or paste them
example, if you type @kbd{file @key{RET}}, file name completion (alternative
access: @kbd{C-u C-c C-l}, see below) will be offered, and after @kbd{bbdb
@key{RET}} you can complete contact names.
-@kindex C-u C-c C-l
+@orgkey C-u C-c C-l
@cindex file name completion
@cindex completion, of file names
-@item C-u C-c C-l
When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
a file will be inserted and you may use file name completion to select
the name of the file. The path to the file is inserted relative to the
is used, if possible with @samp{~/} for your home directory. You can
force an absolute path with two @kbd{C-u} prefixes.
@c
-@item C-c C-l @r{(with cursor on existing link)}
+@item C-c C-l @ @r{(with cursor on existing link)}
When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
link and description parts of the link.
@c
@cindex following links
-@kindex C-c C-o
-@kindex RET
-@item C-c C-o @r{or} @key{RET}
+@orgcmd{C-c C-o,org-open-at-point}
@vindex org-file-apps
Open link at point. This will launch a web browser for URLs (using
@command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
opening in Emacs, use a @kbd{C-u C-u} prefix.@*
If the cursor is on a headline, but not on a link, offer all links in the
headline and entry text.
+@orgkey @key{RET}
+@vindex org-return-follows-link
+When @code{org-return-follows-link} is set, @kbd{@key{RET}} will also follow
+the link at point.
@c
@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, @kbd{mouse-1} will also follow a link.
+would. Under Emacs 22 and later, @kbd{mouse-1} will also follow a link.
@c
@kindex mouse-3
@item mouse-3
internal links to be displayed in another window@footnote{See the
variable @code{org-display-internal-link-with-indirect-buffer}}.
@c
+@orgcmd{C-c C-x C-v,org-toggle-inline-images}
+@cindex inlining images
+@cindex images, inlining
+@vindex org-startup-with-inline-images
+@cindex @code{inlineimages}, STARTUP keyword
+@cindex @code{noinlineimages}, STARTUP keyword
+Toggle the inline display of linked images. Normally this will only inline
+images that have no description part in the link, i.e.@: images that will also
+be inlined during export. When called with a prefix argument, also display
+images that do have a link description. You can ask for inline images to be
+displayed at startup by configuring the variable
+@code{org-startup-with-inline-images}@footnote{with corresponding
+@code{#+STARTUP} keywords @code{inlineimages} and @code{inlineimages}}.
+@orgcmd{C-c %,org-mark-ring-push}
@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.
+easily. Commands following an internal link do this automatically.
@c
+@orgcmd{C-c &,org-mark-ring-goto}
@cindex links, returning to
-@kindex C-c &
-@item C-c &
Jump back to a recorded position. A position is recorded by the
commands following internal links, and by @kbd{C-c %}. Using this
command several times in direct succession moves through a ring of
previously recorded positions.
@c
-@kindex C-c C-x C-n
-@kindex C-c C-x C-p
+@orgcmdkkcc{C-c C-x C-n,C-c C-x C-p,org-next-link,org-previous-link}
@cindex links, finding next/previous
-@item C-c C-x C-n
-@itemx C-c C-x C-p
Move forward/backward to the next link in the buffer. At the limit of
the buffer, the search fails once, and then wraps around. The key
-bindings for this are really too long, you might want to bind this also
+bindings for this are really too long; you might want to bind this also
to @kbd{C-n} and @kbd{C-p}
@lisp
(add-hook 'org-load-hook
(lambda ()
- (define-key 'org-mode-map "\C-n" 'org-next-link)
- (define-key 'org-mode-map "\C-p" 'org-previous-link)))
+ (define-key org-mode-map "\C-n" 'org-next-link)
+ (define-key org-mode-map "\C-p" 'org-previous-link)))
@end lisp
@end table
@noindent
@vindex org-link-abbrev-alist
-where the tag is optional. The @i{linkword} must be a word; letter, numbers,
-@samp{-}, and @samp{_} are allowed here. Abbreviations are resolved
+where the tag is optional.
+The @i{linkword} must be a word, starting with a letter, followed by
+letters, numbers, @samp{-}, and @samp{_}. Abbreviations are resolved
according to the information in the variable @code{org-link-abbrev-alist}
that relates the linkwords to replacement text. Here is an example:
-@lisp
+@smalllisp
@group
(setq org-link-abbrev-alist
'(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
("google" . "http://www.google.com/search?q=")
- ("ads" . "http://adsabs.harvard.edu/cgi-bin/
- nph-abs_connect?author=%s&db_key=AST")))
+ ("gmap" . "http://maps.google.com/maps?q=%s")
+ ("omap" . "http://nominatim.openstreetmap.org/search?q=%s&polygon=1")
+ ("ads" . "http://adsabs.harvard.edu/cgi-bin/nph-abs_connect?author=%s&db_key=AST")))
@end group
-@end lisp
+@end smalllisp
If the replacement text contains the string @samp{%s}, it will be
replaced with the tag. Otherwise the tag will be appended to the string
With the above setting, you could link to a specific bug with
@code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
-@code{[[google:OrgMode]]} and find out what the Org author is
-doing besides Emacs hacking with @code{[[ads:Dominik,C]]}.
+@code{[[google:OrgMode]]}, show the map location of the Free Software
+Foundation @code{[[gmap:51 Franklin Street, Boston]]} or of Carsten office
+@code{[[omap:Science Park 904, Amsterdam, The Netherlands]]} and find out
+what the Org author is doing besides Emacs hacking with
+@code{[[ads:Dominik,C]]}.
If you need special abbreviations just for a single Org buffer, you
can define them in the file with
@noindent
In-buffer completion (@pxref{Completion}) can be used after @samp{[} to
complete link abbreviations. You may also define a function
-@code{org-PREFIX-complete-link} that implements special (e.g. completion)
+@code{org-PREFIX-complete-link} that implements special (e.g.@: completion)
support for inserting such a link with @kbd{C-c C-l}. Such a function should
not accept any arguments, and return the full link with prefix.
File links can contain additional information to make Emacs jump to a
particular location in the file when following a link. This can be a
line number or a search option after a double@footnote{For backward
-compatibility, line numbers can also follow a single colon.} colon. For
+compatibility, line numbers can also follow a single colon.} colon. For
example, when the command @kbd{C-c l} creates a link (@pxref{Handling
links}) to a file, it encodes the words in the current line as a search
string that can be used to find this line back later when following the
[[file:~/code/main.c::255]]
[[file:~/xx.org::My Target]]
[[file:~/xx.org::*My Target]]
+[[file:~/xx.org::#my-custom-id]]
[[file:~/xx.org::/regexp/]]
@end example
the linked file.
@item *My Target
In an Org file, restrict search to headlines.
+@item #my-custom-id
+Link to a heading with a @code{CUSTOM_ID} property
@item /regexp/
Do a regular expression search for @code{regexp}. This uses the Emacs
command @code{occur} to list all matches in a separate window. If the
-target file is in Org mode, @code{org-occur} is used to create a
+target file is in Org-mode, @code{org-occur} is used to create a
sparse tree with the matches.
@c If the target file is a directory,
@c @code{grep} will be used to search all files in the directory.
an implementation example. See the file @file{org-bibtex.el}.
@node TODO Items, Tags, Hyperlinks, Top
-@chapter TODO Items
+@chapter TODO items
@cindex TODO items
-Org mode does not maintain TODO lists as separate documents@footnote{Of
+Org-mode does not maintain TODO lists as separate documents@footnote{Of
course, you can make a document that contains only long lists of TODO items,
but this is not required.}. Instead, TODO items are an integral part of the
notes file, because TODO items usually come up while taking notes! With Org
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
+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
The most important commands to work with TODO entries are:
@table @kbd
-@kindex C-c C-t
+@orgcmd{C-c C-t,org-todo}
@cindex cycling, of TODO states
-@item C-c C-t
Rotate the TODO state of the current item among
@example
The same rotation can also be done ``remotely'' from the timeline and
agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}).
-@kindex C-u C-c C-t
-@item C-u C-c C-t
+@orgkey{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
@kindex S-@key{right}
@kindex S-@key{left}
+@item S-@key{right} @ @r{/} @ S-@key{left}
@vindex org-treat-S-cursor-todo-selection-as-state-change
-@item S-@key{right}
-@itemx S-@key{left}
Select the following/preceding TODO state, similar to cycling. Useful
mostly if more than two TODO states are possible (@pxref{TODO
extensions}). See also @ref{Conflicts}, for a discussion of the interaction
with @code{shift-selection-mode}. See also the variable
@code{org-treat-S-cursor-todo-selection-as-state-change}.
-@kindex C-c C-v
-@kindex C-c / t
+@orgcmd{C-c / t,org-show-todo-key}
@cindex sparse tree, for TODO
-@item C-c C-v
-@itemx C-c / t
@vindex org-todo-keywords
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 a prefix argument, search for a specific TODO. You will be
-prompted for the keyword, and you can also give a list of keywords like
-@code{KWD1|KWD2|...} to list entries that match any one of these keywords.
-With numeric prefix argument N, show the tree for the Nth keyword in the
-variable @code{org-todo-keywords}. With two prefix arguments, find all TODO
-and DONE entries.
-@kindex C-c a t
-@item 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.
-@kindex S-M-@key{RET}
-@item S-M-@key{RET}
+entire buffer, but shows all TODO items (with not-DONE state) and the
+headings hierarchy above them. With a prefix argument (or by using @kbd{C-c
+/ T}), search for a specific TODO. You will be prompted for the keyword, and
+you can also give a list of keywords like @code{KWD1|KWD2|...} to list
+entries that match any one of these keywords. With a numeric prefix argument
+N, show the tree for the Nth keyword in the variable
+@code{org-todo-keywords}. With two prefix arguments, find all TODO states,
+both un-done and done.
+@orgcmd{C-c a t,org-todo-list}
+Show the global TODO list. Collects the TODO items (with not-DONE states)
+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.
+@orgcmd{S-M-@key{RET},org-insert-todo-heading}
Insert a new TODO entry below the current one.
@end table
@vindex org-todo-keywords
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
+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.
You can use TODO keywords to indicate different @emph{sequential} states
in the process of working on an item, for example@footnote{Changing
-this variable only becomes effective after restarting Org mode in a
+this variable only becomes effective after restarting Org-mode in a
buffer.}:
@lisp
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
+person, and later to mark it DONE. Org-mode supports this style by adapting
the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
@kbd{t} command in the timeline and agenda buffers.}. When used several
times in succession, it will still cycle through all names, in order to first
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
+by using a numeric prefix to @kbd{C-c / t}. For example, to see all things
+Lucy has to do, you would use @kbd{C-3 C-c / t}. To collect Lucy's items
from all agenda files into a single buffer, you would use the numeric prefix
-argument as well when creating the global TODO list: @kbd{C-3 C-c t}.
+argument as well when creating the global TODO list: @kbd{C-3 C-c a t}.
@node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions
@subsection Multiple keyword sets in one file
(sequence "|" "CANCELED")))
@end lisp
-The keywords should all be different, this helps Org mode to keep track
+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,
@kbd{C-c C-t} only operates within a subsequence, so it switches from
@code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
@end lisp
@vindex org-fast-tag-selection-include-todo
-If you then press @code{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
+If you then press @kbd{C-c C-t} followed by the selection key, the entry
+will be switched to this state. @kbd{SPC} can be used to remove any TODO
keyword from an entry.@footnote{Check also the variable
@code{org-fast-tag-selection-include-todo}, it allows you to change the TODO
state through the tags interface (@pxref{Setting tags}), in case you like to
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
@kbd{C-c C-c} with the cursor still in the line to make the changes
-known to Org mode@footnote{Org mode parses these lines only when
-Org mode is activated after visiting a file. @kbd{C-c C-c} with the
-cursor in a line starting with @samp{#+} is simply restarting Org mode
+known to Org-mode@footnote{Org-mode parses these lines only when
+Org-mode is activated after visiting a file. @kbd{C-c C-c} with the
+cursor in a line starting with @samp{#+} is simply restarting Org-mode
for the current buffer.}.
@node Faces for TODO keywords, TODO dependencies, Per-file keywords, TODO extensions
@vindex org-todo @r{(face)}
@vindex org-done @r{(face)}
@vindex org-todo-keyword-faces
-Org mode highlights TODO keywords with special faces: @code{org-todo}
+Org-mode highlights TODO keywords with special faces: @code{org-todo}
for keywords indicating that an item still has to be acted upon, and
@code{org-done} for keywords indicating that an item is finished. If
you are using more than 2 different states, you might want to use
@lisp
@group
(setq org-todo-keyword-faces
- '(("TODO" . org-warning)
- ("DEFERRED" . shadow)
- ("CANCELED" . (:foreground "blue" :weight bold))))
+ '(("TODO" . org-warning) ("STARTED" . "yellow")
+ ("CANCELED" . (:foreground "blue" :weight bold))))
@end group
@end lisp
-While using a list with face properties as shown for CANCELED
-@emph{should} work, this does not aways seem to be the case. If
-necessary, define a special face and use that.
+While using a list with face properties as shown for CANCELED @emph{should}
+work, this does not always seem to be the case. If necessary, define a
+special face and use that. A string is interpreted as a color. The variable
+@code{org-faces-easy-properties} determines if that color is interpreted as a
+foreground or a background color.
@node TODO dependencies, , Faces for TODO keywords, TODO extensions
@subsection TODO dependencies
* Parent
:PROPERTIES:
- :ORDERED: t
+ :ORDERED: t
:END:
** TODO a
** TODO b, needs to wait for (a)
@end example
@table @kbd
-@kindex C-c C-x o
-@item C-c C-x o
+@orgcmd{C-c C-x o,org-toggle-ordered-property}
@vindex org-track-ordered-property-with-tag
@cindex property, ORDERED
Toggle the @code{ORDERED} property of the current entry. A property is used
inherited like a tag. However, if you would like to @i{track} the value of
this property with a tag for better visibility, customize the variable
@code{org-track-ordered-property-with-tag}.
-@kindex C-u C-u C-u C-c C-t
-@item C-u C-u C-u C-c C-t
+@orgkey{C-u C-u C-u C-c C-t}
Change TODO state, circumventing any state blocking.
@end table
@cindex progress logging
@cindex logging, of progress
-Org mode can automatically record a timestamp and possibly a note when
+Org-mode can automatically record a timestamp 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
The most basic logging is to keep track of @emph{when} a certain TODO
item was finished. This is achieved with@footnote{The corresponding
-in-buffer setting is: @code{#+STARTUP: logdone}}.
+in-buffer setting is: @code{#+STARTUP: logdone}}
@lisp
(setq org-log-done 'time)
also overrule the setting of this variable for a subtree by setting a
@code{LOG_INTO_DRAWER} property.
-Since it is normally too much to record a note for every state, Org mode
+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 @samp{!} (for a timestamp) and @samp{@@} (for a note)
in parentheses after each keyword. For example, with the setting
@vindex org-log-done
you not only define global TODO keywords and fast access keys, but also
request that a time is recorded when the entry is set to
-DONE@footnote{It is possible that Org mode will record two timestamps
+DONE@footnote{It is possible that Org-mode will record two timestamps
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
You have enabled the @code{habits} module by customizing the variable
@code{org-modules}.
@item
-The habit is a TODO, with a TODO keyword representing an open state.
+The habit is a TODO item, with a TODO keyword representing an open state.
@item
The property @code{STYLE} is set to the value @code{habit}.
@item
-The TODO has a scheduled date, with a @code{.+} style repeat interval.
+The TODO has a scheduled date, usually with a @code{.+} style repeat
+interval. A @code{++} style may be appropriate for habits with time
+constraints, e.g., must be done on weekends, or a @code{+} style for an
+unusual habit that can have a backlog, e.g., weekly reports.
@item
The TODO may also have minimum and maximum ranges specified by using the
syntax @samp{.+2d/3d}, which says that you want to do the task at least every
three days, but at most every two days.
@item
You must also have state logging for the @code{DONE} state enabled, in order
-for historical data to be represented in the consistency graph. If it's not
-enabled it's not an error, but the consistency graphs will be largely
+for historical data to be represented in the consistency graph. If it is not
+enabled it is not an error, but the consistency graphs will be largely
meaningless.
@end enumerate
If the task was overdue on that day.
@end table
-In addition to coloring each day, the day is also marked with an asterix if
+In addition to coloring each day, the day is also marked with an asterisk if
the task was actually done that day, and an exclamation mark to show where
the current day falls in the graph.
@table @code
@item org-habit-graph-column
The buffer column at which the consistency graph should be drawn. This will
-overwrite any text in that column, so it's a good idea to keep your habits'
+overwrite any text in that column, so it is a good idea to keep your habits'
titles brief and to the point.
@item org-habit-preceding-days
The amount of history, in days before today, to appear in consistency graphs.
@section Priorities
@cindex priorities
-If you use Org mode extensively, you may end up enough TODO items that
+If you use Org-mode extensively, you may end up with 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
+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
-By default, Org mode supports three priorities: @samp{A}, @samp{B}, and
-@samp{C}. @samp{A} is the highest priority. An entry without a cookie
-is treated as priority @samp{B}. Priorities make a difference only in
-the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they have
-no inherent meaning to Org mode.
+@vindex org-priority-faces
+By default, Org-mode supports three priorities: @samp{A}, @samp{B}, and
+@samp{C}. @samp{A} is the highest priority. An entry without a cookie is
+treated just like priority @samp{B}. Priorities make a difference only for
+sorting in the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they
+have no inherent meaning to Org-mode. The cookies can be highlighted with
+special faces by customizing the variable @code{org-priority-faces}.
-Priorities can be attached to any outline tree entries; they do not need
-to be TODO items.
+Priorities can be attached to any outline node; they do not need to be TODO
+items.
@table @kbd
-@kindex @kbd{C-c ,}
@item @kbd{C-c ,}
-Set the priority of the current headline. The command prompts for a
-priority character @samp{A}, @samp{B} or @samp{C}. When you press
-@key{SPC} instead, the priority cookie is removed from the headline.
-The priorities can also be changed ``remotely'' from the timeline and
-agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
+@kindex @kbd{C-c ,}
+@findex org-priority
+Set the priority of the current headline (@command{org-priority}). The
+command prompts for a priority character @samp{A}, @samp{B} or @samp{C}.
+When you press @key{SPC} instead, the priority cookie is removed from the
+headline. The priorities can also be changed ``remotely'' from the timeline
+and agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
@c
-@kindex S-@key{up}
-@kindex S-@key{down}
-@item S-@key{up}
-@itemx S-@key{down}
+@orgcmdkkcc{S-@key{up},S-@key{down},org-priority-up,org-priority-down}
@vindex org-priority-start-cycle-with-default
Increase/decrease priority of current headline@footnote{See also the option
@code{org-priority-start-cycle-with-default}.}. Note that these keys are
global TODO list, see the @code{org-agenda-todo-list-sublevels}.}. To keep
the overview over the fraction of subtasks that are already completed, insert
either @samp{[/]} or @samp{[%]} anywhere in the headline. These cookies will
-be updates each time the todo status of a child changes, or when pressing
+be updated each time the TODO status of a child changes, or when pressing
@kbd{C-c C-c} on the cookie. For example:
@example
@section Checkboxes
@cindex checkboxes
-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}).
+@vindex org-list-automatic-rules
+Every item in a plain list@footnote{With the exception of description
+lists. But you can allow it by modifying @code{org-list-automatic-rules}
+accordingly.} (@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.
Each cookie covers checkboxes of direct children structurally below the
headline/item on which the cookie appears@footnote{Set the variable
@code{org-hierarchical-checkbox-statistics} if you want such cookies to
-represent the all checkboxes below the cookie, not just the direct
+count all checkboxes below the cookie, not just those belonging to direct
children.}. You have to insert the cookie yourself by typing either
@samp{[/]} or @samp{[%]}. With @samp{[/]} you get an @samp{n out of m}
result, as in the examples above. With @samp{[%]} you get information about
@noindent The following commands work with checkboxes:
@table @kbd
-@kindex C-c C-c
-@item C-c C-c
+@orgcmd{C-c C-c,org-toggle-checkbox}
Toggle checkbox status or (with prefix arg) checkbox presence at point. With
double 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
+@orgcmd{C-c C-x C-b,org-toggle-checkbox}
Toggle checkbox status or (with prefix arg) checkbox presence at point. With
double prefix argument, set it to @samp{[-]}, which is considered to be an
intermediate state.
@item
If there is no active region, just toggle the checkbox at point.
@end itemize
-@kindex M-S-@key{RET}
-@item M-S-@key{RET}
-Insert a new item with a checkbox.
-This works only if the cursor is already in a plain list item
-(@pxref{Plain lists}).
-@kindex C-c C-x o
-@item C-c C-x o
+@orgcmd{M-S-@key{RET},org-insert-todo-heading}
+Insert a new item with a checkbox. This works only if the cursor is already
+in a plain list item (@pxref{Plain lists}).
+@orgcmd{C-c C-x o,org-toggle-ordered-property}
@vindex org-track-ordered-property-with-tag
@cindex property, ORDERED
Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
However, if you would like to @i{track} the value of this property with a tag
for better visibility, customize the variable
@code{org-track-ordered-property-with-tag}.
-@kindex C-c #
-@item C-c #
+@orgcmd{C-c #,org-update-statistics-cookies}
Update the statistics cookie in the current outline entry. When called with
a @kbd{C-u} prefix, update the entire file. Checkbox statistic cookies are
updated automatically if you toggle checkboxes with @kbd{C-c C-c} and make
new ones with @kbd{M-S-@key{RET}}. TODO statistics cookies update when
changing TODO states. If you delete boxes/entries or add/change them by
-hand, use this command to get things back into sync. Or simply toggle any
-entry twice (checkboxes with @kbd{C-c C-c}).
+hand, use this command to get things back into sync.
@end table
@node Tags, Properties and Columns, TODO Items, Top
@cindex 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
+information is to assign @i{tags} to headlines. Org-mode has extensive
support for tags.
@vindex org-tag-faces
also a special command for inserting tags:
@table @kbd
-@kindex C-c C-q
-@item C-c C-q
+@orgcmd{C-c C-q,org-set-tags-command}
@cindex completion, of tags
@vindex org-tags-column
-Enter new tags for the current headline. Org mode will either offer
+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}).
-@kindex C-c C-c
-@item C-c C-c
+@orgcmd{C-c C-c,org-set-tags-command}
When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
@end table
@vindex org-tag-alist
-Org will support tag insertion based on a @emph{list of tags}. By
+Org supports 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
#+STARTUP: noptag
@end example
-By default Org mode uses the standard minibuffer completion facilities for
+By default Org-mode uses the standard minibuffer completion facilities for
entering tags. However, it also implements another, quicker, tag selection
method called @emph{fast tag selection}. This allows you to select and
deselect tags with just a single key press. For this to work well you should
@item @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.
+You can also add several tags: just separate them with a comma.
+
@kindex @key{SPC}
@item @key{SPC}
Clear all tags for this line.
information into special lists.
@table @kbd
-@kindex C-c \
-@kindex C-c / m
-@item C-c \
-@itemx C-c / m
+@orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
Create a sparse tree with all headlines matching a tags search. With a
@kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
-@kindex C-c a m
-@item C-c a m
+@orgcmd{C-c a m,org-tags-view}
Create a global list of tag matches from all agenda files.
@xref{Matching tags and properties}.
-@kindex C-c a M
-@item C-c a M
+@orgcmd{C-c a M,org-tags-view}
@vindex org-tags-match-list-sublevels
Create a global list of tag matches from all agenda files, but check
only TODO items and force checking subitems (see variable
@node Properties and Columns, Dates and Times, Tags, Top
-@chapter Properties and Columns
+@chapter Properties and columns
@cindex 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 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 buffer. For
an example of the first application, imagine maintaining a file where
@menu
* Property syntax:: How properties are spelled out
-* Special properties:: Access to other Org mode features
+* 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
The following commands help to work with properties:
@table @kbd
-@kindex M-@key{TAB}
-@item M-@key{TAB}
+@orgcmd{M-@key{TAB},pcomplete}
After an initial colon in a line, complete property keys. All keys used
in the current file will be offered as possible completions.
-@kindex C-c C-x p
-@item C-c C-x p
+@orgcmd{C-c C-x p,org-set-property}
Set a property. This prompts for a property name and a value. If
necessary, the property drawer is created as well.
@item M-x org-insert-property-drawer
+@findex 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.
-@kindex C-c C-c
-@item C-c C-c
+@orgcmd{C-c C-c,org-property-action}
With the cursor in a property drawer, this executes property commands.
-@item C-c C-c s
+@orgcmd{C-c C-c s,org-set-property}
Set a property in the current entry. Both the property and the value
can be inserted using completion.
-@kindex S-@key{right}
-@kindex S-@key{left}
-@item S-@key{left}/@key{right}
+@orgcmdkkcc{S-@key{right},S-@key{left},org-property-next-allowed-value,org-property-previous-allowed-value}
Switch property at point to the next/previous allowed value.
-@item C-c C-c d
+@orgcmd{C-c C-c d,org-delete-property}
Remove a property from the current entry.
-@item C-c C-c D
+@orgcmd{C-c C-c D,org-delete-property-globally}
Globally remove a property, from all entries in the current file.
-@item C-c C-c c
+@orgcmd{C-c C-c c,org-compute-property-at-point}
Compute the property at point, using the operator and scope from the
nearest column format definition.
@end table
@section Special properties
@cindex properties, special
-Special properties provide an alternative access method to Org mode
-features, like the TODO state or the priority of an entry, discussed in the
-previous chapters. This interface exists so that you can include
-these states in a column view (@pxref{Column view}), or to use them in
-queries. The following property names are special and should not be
+Special properties provide an alternative access method to Org-mode features,
+like the TODO state or the priority of an entry, discussed in the previous
+chapters. This interface exists so that you can include these states in a
+column view (@pxref{Column view}), or to use them in queries. The following
+property names are special and (except for @code{:CATEGORY:}) should not be
used as keys in the properties drawer:
@cindex property, special, TODO
@cindex property, special, TIMESTAMP
@cindex property, special, TIMESTAMP_IA
@cindex property, special, CLOCKSUM
+@cindex property, special, BLOCKED
@c guessing that ITEM is needed in this area; also, should this list be sorted?
@cindex property, special, ITEM
+@cindex property, special, FILE
@example
TODO @r{The TODO keyword of the entry.}
TAGS @r{The tags defined directly in the headline.}
TIMESTAMP @r{The first keyword-less timestamp in the entry.}
TIMESTAMP_IA @r{The first inactive timestamp 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.}
+ @r{must be run first to compute the values in the current buffer.}
+BLOCKED @r{"t" if task is currently blocked by children or siblings}
ITEM @r{The content of the entry.}
+FILE @r{The filename the entry is located in.}
@end example
@node Property searches, Property inheritance, Special properties, Properties and Columns
To create sparse trees and special lists with selection based on properties,
the same commands are used as for tag searches (@pxref{Tag searches}).
@table @kbd
-@kindex C-c \
-@kindex C-c / m
-@item C-c \
-@itemx C-c / m
+@orgcmdkkc{C-c / m,C-c \,org-match-sparse-tree}
Create a sparse tree with all matching entries. With a
@kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
-@kindex C-c a m
-@item C-c a m
+@orgcmd{C-c a m,org-tags-view}
Create a global list of tag/property matches from all agenda files.
@xref{Matching tags and properties}.
-@kindex C-c a M
-@item C-c a M
+@orgcmd{C-c a M,org-tags-view}
@vindex org-tags-match-list-sublevels
Create a global list of tag matches from all agenda files, but check
only TODO items and force checking of subitems (see variable
single property:
@table @kbd
-@kindex C-c / p
-@item C-c / p
+@orgkey{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
+value. If you enclose the value in curly braces, it is interpreted as
a regular expression and matched against the property values.
@end table
@cindex inheritance, of properties
@vindex org-use-property-inheritance
-The outline structure of Org-mode documents lends itself for an
+The outline structure of Org-mode documents lends itself to 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
+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
@code{org-use-property-inheritance}. It may be set to @code{t} to make
all properties inherited from the parent, to a list of properties
that should be inherited, or to a regular expression that matches
-inherited properties.
+inherited properties. If a property has the value @samp{nil}, this is
+interpreted as an explicit undefine of the property, so that inheritance
+search will stop at this value and return @code{nil}.
-Org mode has a few properties for which inheritance is hard-coded, at
+Org-mode has a few properties for which inheritance is hard-coded, at
least for the special applications for which they are used:
@cindex property, COLUMNS
A great way to view and edit properties in an outline tree is
@emph{column view}. In column view, each outline node 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
+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
@var{property} @r{The property that should be edited in this column.}
@r{Special properties representing meta data are allowed here}
@r{as well (@pxref{Special properties})}
-(title) @r{The header text for the column. If omitted, the}
- @r{property name is used.}
+@var{title} @r{The header text for the column. If omitted, the property}
+ @r{name is used.}
@{@var{summary-type}@} @r{The summary type. If specified, the column values for}
@r{parent nodes are computed from the children.}
@r{Supported summary types are:}
@{+@} @r{Sum numbers in this column.}
@{+;%.1f@} @r{Like @samp{+}, but format result with @samp{%.1f}.}
@{$@} @r{Currency, short for @samp{+;%.2f}.}
- @{:@} @r{Sum times, HH:MM:SS, plain numbers are hours.}
+ @{:@} @r{Sum times, HH:MM, plain numbers are hours.}
@{X@} @r{Checkbox status, @samp{[X]} if all children are @samp{[X]}.}
@{X/@} @r{Checkbox status, @samp{[n/m]}.}
@{X%@} @r{Checkbox status, @samp{[n%]}.}
@{:min@} @r{Smallest time value in column.}
@{:max@} @r{Largest time value.}
@{:mean@} @r{Arithmetic mean of time values.}
- @{@@min@} @r{Minimum age (in days/hours/mins/seconds).}
- @{@@max@} @r{Maximum age (in days/hours/mins/seconds).}
- @{@@mean@} @r{Arithmetic mean of ages (in days/hours/mins/seconds).}
+ @{@@min@} @r{Minimum age (in days/hours/mins/seconds).}
+ @{@@max@} @r{Maximum age (in days/hours/mins/seconds).}
+ @{@@mean@} @r{Arithmetic mean of ages (in days/hours/mins/seconds).}
+ @{est+@} @r{Add low-high estimates.}
@end example
@noindent
Be aware that you can only have one summary type for any property you
-include. Subsequent columns referencing the same property will all display the
+include. Subsequent columns referencing the same property will all display the
same summary information.
+The @code{est+} summary type requires further explanation. It is used for
+combining estimates, expressed as low-high ranges. For example, instead
+of estimating a particular task will take 5 days, you might estimate it as
+5-6 days if you're fairly confident you know how much work is required, or
+1-10 days if you don't really know what needs to be done. Both ranges
+average at 5.5 days, but the first represents a more predictable delivery.
+
+When combining a set of such estimates, simply adding the lows and highs
+produces an unrealistically wide result. Instead, @code{est+} adds the
+statistical mean and variance of the sub-tasks, generating a final estimate
+from the sum. For example, suppose you had ten tasks, each of which was
+estimated at 0.5 to 2 days of work. Straight addition produces an estimate
+of 5 to 20 days, representing what to expect if everything goes either
+extremely well or extremely poorly. In contrast, @code{est+} estimates the
+full job more realistically, at 10-15 days.
+
Here is an example for a complete columns definition, along with allowed
values.
@noindent
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
+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
@samp{Status} with four different possible values, and for a checkbox
@table @kbd
@tsubheading{Turning column view on and off}
-@kindex C-c C-x C-c
-@item C-c C-x C-c
+@orgcmd{C-c C-x C-c,org-columns}
@vindex org-columns-default-format
Turn on column view. If the cursor is before the first headline in the file,
column view is turned on for the entire file, using the @code{#+COLUMNS}
property. If no such property 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.
-@kindex r
-@item r
+@orgcmd{r,org-columns-redo}
Recreate the column view, to include recent changes made in the buffer.
-@kindex g
-@item g
+@orgcmd{g,org-columns-redo}
Same as @kbd{r}.
-@kindex q
-@item q
+@orgcmd{q,org-columns-quit}
Exit column view.
@tsubheading{Editing values}
@item @key{left} @key{right} @key{up} @key{down}
Switch to the next/previous allowed value of the field. For this, you
have to have specified allowed values for a property.
@item 1..9,0
-Directly select the nth allowed value, @kbd{0} selects the 10th value.
-@kindex n
-@kindex p
-@itemx n / p
+Directly select the Nth allowed value, @kbd{0} selects the 10th value.
+@orgcmdkkcc{n,p,org-columns-next-allowed-value,org-columns-previous-allowed-value}
Same as @kbd{S-@key{left}/@key{right}}
-@kindex e
-@item e
+@orgcmd{e,org-columns-edit-value}
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.
-@kindex C-c C-c
-@item C-c C-c
+@orgcmd{C-c C-c,org-columns-set-tags-or-toggle}
When there is a checkbox at point, toggle it.
-@kindex v
-@item v
+@orgcmd{v,org-columns-show-value}
View the full value of this property. This is useful if the width of
the column is smaller than that of the value.
-@kindex a
-@item a
+@orgcmd{a,org-columns-edit-allowed}
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.
@tsubheading{Modifying the table structure}
-@kindex <
-@kindex >
-@item < / >
+@orgcmdkkcc{<,>,org-columns-narrow,org-columns-widen}
Make the column narrower/wider by one character.
-@kindex S-M-@key{right}
-@item S-M-@key{right}
+@orgcmd{S-M-@key{right},org-columns-new}
Insert a new column, to the left of the current column.
-@kindex S-M-@key{left}
-@item S-M-@key{left}
+@orgcmd{S-M-@key{left},org-columns-delete}
Delete the current column.
@end table
The following commands insert or update the dynamic block:
@table @kbd
-@kindex C-c C-x i
-@item C-c C-x i
+@orgcmd{C-c C-x i,org-insert-columns-dblock}
Insert a dynamic block capturing a column view. You will be prompted
for the scope or ID of the view.
-@kindex C-c C-c
-@item C-c C-c
-@kindex C-c C-x C-u
-@itemx C-c C-x C-u
+@orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
Update dynamic block at point. The cursor needs to be in the
@code{#+BEGIN} line of the dynamic block.
-@kindex C-u C-c C-x C-u
-@item C-u C-c C-x C-u
+@orgcmd{C-u C-c C-x C-u,org-update-all-dblocks}
Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
-you have several clock table blocks in a buffer.
+you have several clock table blocks, column-capturing blocks or other dynamic
+blocks in a buffer.
@end table
You can add formulas to the column view table and you may add plotting
property API}.
@node Dates and Times, Capture - Refile - Archive, Properties and Columns, Top
-@chapter Dates and Times
+@chapter Dates and times
@cindex dates
@cindex times
@cindex timestamp
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
+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
+something was created or last changed. However, in Org-mode this term
is used in a much wider sense.
@menu
* Creating timestamps:: Commands which insert timestamps
* Deadlines and scheduling:: Planning your work
* Clocking work time:: Tracking how long you spend on a task
-* Resolving idle time:: Resolving time if you've been idle
* Effort estimates:: Planning work effort in advance
* Relative timer:: Notes with a running timer
+* Countdown timer:: Starting a countdown timer for a task
@end menu
A timestamp is a specification of a date (possibly with a time or a range of
times) in a special format, either @samp{<2003-09-16 Tue>} or
@samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16 Tue
-12:00-12:30>}@footnote{This is inspired by the standard ISO 6801 date/time
+12:00-12:30>}@footnote{This is inspired by the standard ISO 8601 date/time
format. To use an alternative format, see @ref{Custom time format}.}. A
timestamp can appear anywhere in the headline or body of an Org tree entry.
Its presence causes entries to be shown on specific dates in the agenda
@end example
@item 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
+For more complex date specifications, Org-mode supports using the special
+sexp diary entries implemented in the Emacs calendar/diary
+package@footnote{When working with the standard diary sexp functions, you
+need to be very careful with the order of the arguments. That order depend
+evilly on the variable @code{calendar-date-style} (or, for older Emacs
+versions, @code{european-calendar-style}). For example, to specify a date
+December 12, 2005, the call might look like @code{(diary-date 12 1 2005)} or
+@code{(diary-date 1 12 2005)} or @code{(diary-date 2005 12 1)}, depending on
+the settings. This has been the source of much confusion. Org-mode users
+can resort to special versions of these functions like @code{org-date} or
+@code{org-anniversary}. These work just like the corresponding @code{diary-}
+functions, but with stable ISO order of arguments (year, month, day) wherever
+applicable, independent of the value of @code{calendar-date-style}.}. For example
@example
* The nerd meeting on every 2nd Thursday of the month
- <%%(diary-float t 4 2)>
+ <%%(org-float t 4 2)>
@end example
@item Time/Date range
@cindex creating timestamps
@cindex timestamps, creating
-For Org mode to recognize timestamps, they need to be in the specific
+For Org-mode to recognize timestamps, they need to be in the specific
format. All commands listed below produce timestamps in the correct
format.
@table @kbd
-@kindex C-c .
-@item C-c .
+@orgcmd{C-c .,org-time-stamp}
Prompt for a date and insert a corresponding timestamp. When the cursor is
at an existing timestamp in the buffer, the command is used to modify this
timestamp instead of inserting a new one. When this command is used twice in
succession, a time range is inserted.
@c
-@kindex C-c !
-@item C-c !
+@orgcmd{C-c !,org-time-stamp-inactive}
Like @kbd{C-c .}, but insert an inactive timestamp that will not cause
an agenda entry.
@c
contains date and time. The default time can be rounded to multiples of 5
minutes, see the option @code{org-time-stamp-rounding-minutes}.
@c
-@kindex C-c <
-@item C-c <
+@orgcmd{C-c <,org-date-from-calendar}
Insert a timestamp corresponding to the cursor date in the Calendar.
@c
-@kindex C-c >
-@item C-c >
+@orgcmd{C-c >,org-goto-calendar}
Access the Emacs calendar for the current date. If there is a
timestamp in the current line, go to the corresponding date
instead.
@c
-@kindex C-c C-o
-@item C-c C-o
+@orgcmd{C-c C-o,org-open-at-point}
Access the agenda for the date given by the timestamp or -range at
point (@pxref{Weekly/daily agenda}).
@c
-@kindex S-@key{left}
-@kindex S-@key{right}
-@item S-@key{left}
-@itemx S-@key{right}
+@orgcmdkkcc{S-@key{left},S-@key{right},org-timestamp-down-day,org-timestamp-up-day}
Change date at cursor by one day. These key bindings conflict with
shift-selection and related modes (@pxref{Conflicts}).
@c
-@kindex S-@key{up}
-@kindex S-@key{down}
-@item S-@key{up}
-@itemx S-@key{down}
+@orgcmdkkcc{S-@key{up},S-@key{down},org-timestamp-up,org-timestamp-down-down}
Change the item under the cursor in a timestamp. The cursor can be on a
year, month, day, hour or minute. When the timestamp contains a time range
like @samp{15:30-16:30}, modifying the first time will also shift the second,
shifting the time block with constant length. To change the length, modify
the second time. Note that if the cursor is in a headline and not at a
timestamp, these same keys modify the priority of an item.
-(@pxref{Priorities}). The key bindings also conflict with shift-selection and
+(@pxref{Priorities}). The key bindings also conflict with shift-selection and
related modes (@pxref{Conflicts}).
@c
-@kindex C-c C-y
+@orgcmd{C-c C-y,org-evaluate-time-range}
@cindex evaluate time range
-@item C-c C-y
Evaluate a time range by computing the difference between start and end.
With a prefix argument, insert result after the time range (in a table: into
the following column).
@menu
-* The date/time prompt:: How Org mode helps you entering date and time
+* The date/time prompt:: How Org-mode helps you entering date and time
* Custom time format:: Making dates look different
@end menu
@cindex time, reading in minibuffer
@vindex org-read-date-prefer-future
-When Org mode prompts for a date/time, the default is shown in default
+When Org-mode prompts for a date/time, the default is shown in default
date/time format, and the prompt therefore seems to ask for a specific
format. 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
+copied from an email message. Org-mode will find whatever information is in
there and derive anything you have not specified from the @emph{default date
and time}. The default is usually the current date and time, but when
modifying an existing timestamp, 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
+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 date@footnote{See the
variable @code{org-read-date-prefer-future}. You may set that variable to
time prompt will show this with @samp{(=>F).}
For example, let's assume that today is @b{June 13, 2006}. Here is how
-various inputs will be interpreted, the items filled in by Org mode are
+various inputs will be interpreted, the items filled in by Org-mode are
in @b{bold}.
@example
-3-2-5 --> 2003-02-05
-14 --> @b{2006}-@b{06}-14
-12 --> @b{2006}-@b{07}-12
-Fri --> nearest Friday (defaultdate or later)
-sep 15 --> @b{2006}-09-15
-feb 15 --> @b{2007}-02-15
-sep 12 9 --> 2009-09-12
-12:45 --> @b{2006}-@b{06}-@b{13} 12:45
-22 sept 0:34 --> @b{2006}-09-22 0:34
-w4 --> ISO week for of the current year @b{2006}
-2012 w4 fri --> Friday of ISO week 4 in 2012
-2012-w04-5 --> Same as above
+3-2-5 @result{} 2003-02-05
+2/5/3 @result{} 2003-02-05
+14 @result{} @b{2006}-@b{06}-14
+12 @result{} @b{2006}-@b{07}-12
+2/5 @result{} @b{2007}-02-05
+Fri @result{} nearest Friday (default date or later)
+sep 15 @result{} @b{2006}-09-15
+feb 15 @result{} @b{2007}-02-15
+sep 12 9 @result{} 2009-09-12
+12:45 @result{} @b{2006}-@b{06}-@b{13} 12:45
+22 sept 0:34 @result{} @b{2006}-09-22 0:34
+w4 @result{} ISO week for of the current year @b{2006}
+2012 w4 fri @result{} Friday of ISO week 4 in 2012
+2012-w04-5 @result{} Same as above
@end example
Furthermore you can specify a relative date by giving, as the
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.
+the Nth such day, e.g.@:
@example
-+0 --> today
-. --> today
-+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.
++0 @result{} today
+. @result{} today
++4d @result{} four days from today
++4 @result{} same as above
++2w @result{} two weeks from today
+++5 @result{} five days from default date
++2tue @result{} second Tuesday from now.
@end example
@vindex parse-time-months
you want to use unabbreviated names and/or other languages, configure
the variables @code{parse-time-months} and @code{parse-time-weekdays}.
+@vindex org-read-date-force-compatible-dates
+Not all dates can be represented in a given Emacs implementation. By default
+Org mode forces dates into the compatibility range 1970--2037 which works on
+all Emacs implementations. If you want to use dates outside of this range,
+read the docstring of the variable
+@code{org-read-date-force-compatible-dates}.
+
+You can specify a time range by giving start and end times or by giving a
+start time and a duration (in HH:MM format). Use one or two dash(es) as the
+separator in the former case and use '+' as the separator in the latter
+case, e.g.@:
+
+@example
+11am-1:15pm @result{} 11:00-13:15
+11am--1:15pm @result{} same as above
+11am+2:15 @result{} same as above
+@end example
+
@cindex calendar, for selecting date
@vindex org-popup-calendar-for-date-prompt
Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
@kindex <
@kindex >
+@kindex M-v
+@kindex C-v
@kindex mouse-1
@kindex S-@key{right}
@kindex S-@key{left}
@kindex M-S-@key{left}
@kindex @key{RET}
@example
-> / < @r{Scroll calendar forward/backward by one month.}
+@key{RET} @r{Choose date at cursor in calendar.}
mouse-1 @r{Select date by clicking on it.}
S-@key{right}/@key{left} @r{One day forward/backward.}
S-@key{down}/@key{up} @r{One week forward/backward.}
M-S-@key{right}/@key{left} @r{One month forward/backward.}
-@key{RET} @r{Choose date in calendar.}
+> / < @r{Scroll calendar forward/backward by one month.}
+M-v / C-v @r{Scroll calendar forward/backward by 3 months.}
@end example
@vindex org-read-date-display-live
@vindex org-display-custom-times
@vindex org-time-stamp-custom-formats
-Org mode uses the standard ISO notation for dates and times as it is
+Org-mode uses the standard ISO notation for dates and times as it is
defined in ISO 8601. If you cannot get used to this and require another
representation of date and time to keep you happy, you can get it by
customizing the variables @code{org-display-custom-times} and
@code{org-time-stamp-custom-formats}.
@table @kbd
-@kindex C-c C-x C-t
-@item C-c C-x C-t
+@orgcmd{C-c C-x C-t,org-toggle-time-stamp-overlays}
Toggle the display of custom formats for dates and times.
@end table
@noindent
-Org mode needs the default format for scanning, so the custom date/time
+Org-mode needs the default format for scanning, so the custom date/time
format does not @emph{replace} the default format---instead it is put
@emph{over} the default format using text properties. This has the
following consequences:
time will be changed by one minute.
@item
If the timestamp contains a range of clock times or a repeater, these
-will not be overlayed, but remain in the buffer as they were.
+will not be overlaid, but remain in the buffer as they were.
@item
When you delete a timestamp character-by-character, it will only
disappear from the buffer after @emph{all} (invisible) characters
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.
+in the compilation for @emph{today}, until the entry is marked DONE, i.e.@:
+the task will automatically be forwarded until completed.
@example
*** TODO Call Trillian for a date on New Years Eve.
@end example
@noindent
-@b{Important:} Scheduling an item in Org mode should @i{not} be
+@b{Important:} 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 timestamp, to get this item shown
on the date where it applies. This is a frequent misunderstanding by
-Org users. In Org mode, @i{scheduling} means setting a date when you
+Org users. In Org-mode, @i{scheduling} means setting a date when you
want to start working on an action item.
@end table
You may use timestamps with repeaters in scheduling and deadline
-entries. Org mode will issue early and late warnings based on the
+entries. Org-mode will issue early and late warnings based on the
assumption that the timestamp represents the @i{nearest instance} of
the repeater. However, the use of diary sexp entries like
@c
-@code{<%%(diary-float t 42)>}
+@code{<%%(org-float t 42)>}
@c
-in scheduling and deadline timestamps is limited. Org mode does not
+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.
@node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling
@subsection Inserting deadlines or schedules
-The following commands allow you to quickly insert a deadline or to schedule
+The following commands allow you to quickly insert@footnote{The @samp{SCHEDULED} and
+@samp{DEADLINE} dates are inserted on the line right below the headline. Don't put
+any text between this line and the headline.} a deadline or to schedule
an item:
@table @kbd
@c
-@kindex C-c C-d
-@item C-c C-d
+@orgcmd{C-c C-d,org-deadline}
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. Depending on the
-variable @code{org-log-redeadline}@footnote{with corresponding
+in the line directly following the headline. Any CLOSED timestamp will be
+removed. When called with a prefix arg, an existing deadline will be removed
+from the entry. Depending on the variable @code{org-log-redeadline}@footnote{with corresponding
@code{#+STARTUP} keywords @code{logredeadline}, @code{lognoteredeadline},
and @code{nologredeadline}}, a note will be taken when changing an existing
deadline.
-@c FIXME Any CLOSED timestamp will be removed.????????
-@c
-@kindex C-c C-s
-@item C-c C-s
+
+@orgcmd{C-c C-s,org-schedule}
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. Depending on the variable
@code{org-log-reschedule}@footnote{with corresponding @code{#+STARTUP}
-keywords @code{logredeadline}, @code{lognoteredeadline}, and
-@code{nologredeadline}}, a note will be taken when changing an existing
+keywords @code{logreschedule}, @code{lognotereschedule}, and
+@code{nologreschedule}}, a note will be taken when changing an existing
scheduling time.
@c
-@kindex C-c C-x C-k
+@orgcmd{C-c C-x C-k,org-mark-entry-for-agenda-action}
@kindex k a
@kindex k s
-@item C-c C-x C-k
Mark the current entry for agenda action. After you have marked the entry
like this, you can open the agenda or the calendar to find an appropriate
date. With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to
schedule the marked item.
@c
-@kindex C-c / d
+@orgcmd{C-c / d,org-check-deadlines}
@cindex sparse tree, for deadlines
-@item C-c / d
@vindex org-deadline-warning-days
Create a sparse tree with all deadlines that are either past-due, or
which will become due within @code{org-deadline-warning-days}.
prefix, check that many days. For example, @kbd{C-1 C-c / d} shows
all deadlines due tomorrow.
@c
-@kindex C-c / b
-@item C-c / b
+@orgcmd{C-c / b,org-check-before-date}
Sparse tree for deadlines and scheduled items before a given date.
@c
-@kindex C-c / a
-@item C-c / a
+@orgcmd{C-c / a,org-check-after-date}
Sparse tree for deadlines and scheduled items after a given date.
@end table
+Note that @code{org-schedule} and @code{org-deadline} supports
+setting the date by indicating a relative time: e.g. +1d will set
+the date to the next day after today, and --1w will set the date
+to the previous week before any current timestamp.
+
@node Repeated tasks, , Inserting deadline/schedule, Deadlines and scheduling
@subsection Repeated tasks
@cindex tasks, repeated
@cindex repeated tasks
-Some tasks need to be repeated again and again. Org mode helps to
+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 timestamp. In the following example
@example
a deadline entry, the repeater should come 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
-@emph{next} 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
-timestamp 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:
+@vindex org-todo-repeat-to-state
+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 @emph{next} 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 timestamp by the repeater interval, and
+immediately set the entry state back to TODO@footnote{In fact, the target
+state is taken from, in this sequence, the @code{REPEAT_TO_STATE} property or
+the variable @code{org-todo-repeat-to-state}. If neither of these is
+specified, the target state defaults to the first state of the TODO state
+sequence.}. In the example above, setting the state to DONE would actually
+switch the date like this:
@example
** TODO Pay the rent
month. So if you have not paid 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
+forgot to call your father for 3 weeks, it does not make sense to call
him 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
-@i{after} the last time you did it. For these tasks, Org mode has
-special repeaters markers with @samp{++} and @samp{.+}. For example:
+@i{after} the last time you did it. For these tasks, Org-mode has
+special repeaters @samp{++} and @samp{.+}. For example:
@example
** TODO Call Father
created for this purpose, it is described in @ref{Structure editing}.
-@node Clocking work time, Resolving idle time, Deadlines and scheduling, Dates and Times
+@node Clocking work time, Effort estimates, Deadlines and scheduling, Dates and Times
@section Clocking work time
+@cindex clocking time
+@cindex time clocking
-Org mode allows you to clock the time you spend on specific tasks in a
+Org-mode allows you to clock the time you spend on specific tasks in a
project. When you start working on an item, you can start the clock.
When you stop working on that task, or when you mark the task done, the
clock is stopped and the corresponding time interval is recorded. It
will be found (@pxref{Resolving idle time}) and you will be prompted about
what to do with it.
+@menu
+* Clocking commands:: Starting and stopping a clock
+* The clock table:: Detailed reports
+* Resolving idle time:: Resolving time when you've been idle
+@end menu
+
+@node Clocking commands, The clock table, Clocking work time, Clocking work time
+@subsection Clocking commands
+
@table @kbd
-@kindex C-c C-x C-i
-@item C-c C-x C-i
+@orgcmd{C-c C-x C-i,org-clock-in}
@vindex org-clock-into-drawer
+@cindex property, LOG_INTO_DRAWER
Start the clock on the current item (clock-in). This inserts the CLOCK
keyword together with a timestamp. If this is not the first clocking of
this item, the multiple CLOCK lines will be wrapped into a
@code{:LOGBOOK:} drawer (see also the variable
-@code{org-clock-into-drawer}). When called with a @kbd{C-u} prefix argument,
+@code{org-clock-into-drawer}). You can also overrule
+the setting of this variable for a subtree by setting a
+@code{CLOCK_INTO_DRAWER} or @code{LOG_INTO_DRAWER} property.
+When called with a @kbd{C-u} prefix argument,
select the task from a list of recently clocked tasks. With two @kbd{C-u
C-u} prefixes, clock into the task at point and mark it as the default task.
The default task will always be available when selecting a clocking task,
@code{auto} which is the default@footnote{See also the variable
@code{org-clock-modeline-total}.}.@* Clicking with @kbd{mouse-1} onto the
mode line entry will pop up a menu with clocking options.
-@kindex C-c C-x C-o
-@item C-c C-x C-o
+@c
+@orgcmd{C-c C-x C-o,org-clock-out}
@vindex org-log-note-clock-out
Stop the clock (clock-out). This inserts another timestamp at the same
location where the clock was last started. It also directly computes
possibility to record an additional note together with the clock-out
timestamp@footnote{The corresponding in-buffer setting is:
@code{#+STARTUP: lognoteclock-out}}.
-@kindex C-c C-x C-e
-@item C-c C-x C-e
+@orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
Update the effort estimate for the current clock task.
@kindex C-c C-y
@kindex C-c C-c
-@item C-c C-y @ @ @r{or}@ @ C-c C-c
+@orgcmdkkc{C-c C-c,C-c C-y,org-evaluate-time-range}
Recompute the time interval after changing one of the timestamps. This
is only necessary if you edit the timestamps directly. If you change
them with @kbd{S-@key{cursor}} keys, the update is automatic.
-@kindex C-c C-t
-@item C-c C-t
+@orgcmd{C-S-@key{up/down},org-clock-timestamps-up/down}
+On @code{CLOCK} log lines, increase/decrease both timestamps at the same
+time so that duration keeps the same.
+@orgcmd{C-c C-t,org-todo}
Changing the TODO state of an item to DONE automatically stops the clock
if it is running in this same item.
-@kindex C-c C-x C-x
-@item C-c C-x C-x
+@orgcmd{C-c C-x C-x,org-clock-cancel}
Cancel the current clock. This is useful if a clock was started by
mistake, or if you ended up working on something else.
-@kindex C-c C-x C-j
-@item C-c C-x C-j
-Jump to the entry that contains the currently running clock. With a
-@kbd{C-u} prefix arg, select the target task from a list of recently clocked
-tasks.
-@kindex C-c C-x C-d
-@item C-c C-x C-d
+@orgcmd{C-c C-x C-j,org-clock-goto}
+Jump to the headline of the currently clocked in task. With a @kbd{C-u}
+prefix arg, select the target task from a list of recently clocked tasks.
+@orgcmd{C-c C-x C-d,org-clock-display}
@vindex org-remove-highlights-with-change
-Display time summaries for each subtree in the current buffer. This
-puts overlays at the end of each headline, showing the total time
-recorded under that heading, including the time of any subheadings. You
-can use visibility cycling to study the tree, but the overlays disappear
-when you change the buffer (see variable
-@code{org-remove-highlights-with-change}) or press @kbd{C-c C-c}.
-@kindex C-c C-x C-r
-@item C-c C-x C-r
+Display time summaries for each subtree in the current buffer. This puts
+overlays at the end of each headline, showing the total time recorded under
+that heading, including the time of any subheadings. You can use visibility
+cycling to study the tree, but the overlays disappear when you change the
+buffer (see variable @code{org-remove-highlights-with-change}) or press
+@kbd{C-c C-c}.
+@end table
+
+The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
+the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
+worked on or closed during a day.
+
+@node The clock table, Resolving idle time, Clocking commands, Clocking work time
+@subsection The clock table
+@cindex clocktable, dynamic block
+@cindex report, of clocked time
+
+Org mode can produce quite complex reports based on the time clocking
+information. Such a report is called a @emph{clock table}, because it is
+formatted as one or several Org tables.
+
+@table @kbd
+@orgcmd{C-c C-x C-r,org-clock-report}
Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
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.
+@orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
+Update dynamic block at point. The cursor needs to be in the
+@code{#+BEGIN} line of the dynamic block.
+@orgkey{C-u C-c C-x C-u}
+Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
+you have several clock table blocks in a buffer.
+@orgcmdkxkc{S-@key{left},S-@key{right},org-clocktable-try-shift}
+Shift the current @code{:block} interval and update the table. The cursor
+needs to be in the @code{#+BEGIN: clocktable} line for this command. If
+@code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
+@end table
+
+
+Here is an example of the frame for a clock table as it is inserted into the
+buffer with the @kbd{C-c C-x C-r} command:
+
@cindex #+BEGIN, clocktable
@example
#+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
#+END: clocktable
@end example
@noindent
-If such a block already exists at point, its content is replaced by the
-new table. The @samp{BEGIN} line can specify options:
+@vindex org-clocktable-defaults
+The @samp{BEGIN} line and specify a number of options to define the scope,
+structure, and formatting of the report. Defaults for all these options can
+be configured in the variable @code{org-clocktable-defaults}.
+
+@noindent First there are options that determine which clock entries are to
+be selected:
@example
: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.}
+ @r{Clocks at deeper levels will be summed into the upper level.}
: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}
2007-12-31 @r{New year eve 2007}
2007-12 @r{December 2007}
2007-W50 @r{ISO-week 50 in 2007}
+ 2007-Q2 @r{2nd quarter in 2007}
2007 @r{the year 2007}
today, yesterday, today-@var{N} @r{a relative day}
thisweek, lastweek, thisweek-@var{N} @r{a relative week}
:tend @r{A time string specifying when to stop considering times.}
:step @r{@code{week} or @code{day}, to split the table into chunks.}
@r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
+:stepskip0 @r{Do not show steps that have zero time.}
+:fileskip0 @r{Do not show table sections from files which did not contribute.}
+:tags @r{A tags match to select entries that should contribute. See}
+ @r{@ref{Matching tags and properties} for the match syntax.}
+@end example
+
+Then there are options which determine the formatting of the table. There
+options are interpreted by the function @code{org-clocktable-write-default},
+but you can specify your own function using the @code{:formatter} parameter.
+@example
+:emphasize @r{When @code{t}, emphasize level one and level two items.}
+:lang @r{Language@footnote{Language terms can be set through the variable @code{org-clock-clocktable-language-setup}.} to use for descriptive cells like "Task".}
:link @r{Link the item headlines in the table to their origins.}
+:narrow @r{An integer to limit the width of the headline column in}
+ @r{the org table. If you write it like @samp{50!}, then the}
+ @r{headline will also be shortened in export.}
+:indent @r{Indent each headline field according to its level.}
+:tcolumns @r{Number of columns to be used for times. If this is smaller}
+ @r{than @code{:maxlevel}, lower levels will be lumped into one column.}
+:level @r{Should a level number column be included?}
+:compact @r{Abbreviation for @code{:level nil :indent t :narrow 40! :tcolumns 1}}
+ @r{All are overwritten except if there is an explicit @code{:narrow}}
+:timestamp @r{A timestamp for the entry, when available. Look for SCHEDULED,}
+ @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.}
+:properties @r{List of properties that should be shown in the table. Each}
+ @r{property will get its own column.}
+:inherit-props @r{When this flag is @code{t}, the values for @code{:properties} will be inherited.}
:formula @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
@r{As a special case, @samp{:formula %} adds a column with % time.}
- @r{If you do not specify a formula here, any existing formula.}
+ @r{If you do not specify a formula here, any existing formula}
@r{below the clock table will survive updates and be evaluated.}
-:timestamp @r{A timestamp for the entry, when available. Look for SCHEDULED,}
- @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.}
+:formatter @r{A function to format clock data and insert it into the buffer.}
@end example
To get a clock summary of the current level 1 tree, for the current
day, you could write
#+BEGIN: clocktable :scope subtree :link t :formula %
#+END: clocktable
@end example
-@kindex C-c C-c
-@item C-c C-c
-@kindex C-c C-x C-u
-@itemx C-c C-x C-u
-Update dynamic block at point. The cursor needs to be in the
-@code{#+BEGIN} 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
-you have several clock table blocks in a buffer.
-@kindex S-@key{left}
-@kindex S-@key{right}
-@item S-@key{left}
-@itemx S-@key{right}
-Shift the current @code{:block} interval and update the table. The cursor
-needs to be in the @code{#+BEGIN: clocktable} line for this command. If
-@code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
-@end table
-
-The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
-the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
-worked on or closed during a day.
+A horizontally compact representation of everything clocked during last week
+would be
+@example
+#+BEGIN: clocktable :scope agenda :block lastweek :compact t
+#+END: clocktable
+@end example
-@node Resolving idle time, Effort estimates, Clocking work time, Dates and Times
-@section Resolving idle time
+@node Resolving idle time, , The clock table, Clocking work time
+@subsection Resolving idle time
@cindex resolve idle time
@cindex idle, resolve, dangling
leave you clocked out, no matter which option you choose.
@item C
To cancel the clock altogether, use @kbd{C}. Note that if instead of
-cancelling you subtract the away time, and the resulting clock amount is less
-than a minute, the clock will still be cancelled rather than clutter up the
+canceling you subtract the away time, and the resulting clock amount is less
+than a minute, the clock will still be canceled rather than clutter up the
log with an empty entry.
@end table
dangling clock which was never clocked out from your last session. Using
that clock's starting time as the beginning of the unaccounted-for period,
Org will ask how you want to resolve that time. The logic and behavior is
-identical to dealing with away time due to idleness, it's just happening due
+identical to dealing with away time due to idleness; it is just happening due
to a recovery event rather than a set amount of idle time.
You can also check all the files visited by your Org agenda for dangling
clocks at any time using @kbd{M-x org-resolve-clocks}.
-@node Effort estimates, Relative timer, Resolving idle time, Dates and Times
+@node Effort estimates, Relative timer, Clocking work time, Dates and Times
@section Effort estimates
@cindex effort estimates
for an entry with the following commands:
@table @kbd
-@kindex C-c C-x e
-@item C-c C-x e
+@orgcmd{C-c C-x e,org-set-effort}
Set the effort estimate for the current entry. With a numeric prefix
-argument, set it to the NTH allowed value (see below). This command is also
+argument, set it to the Nth allowed value (see below). This command is also
accessible from the agenda with the @kbd{e} key.
-@kindex C-c C-x C-e
-@item C-c C-x C-e
+@orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
Modify the effort estimate of the item currently being clocked.
@end table
buffer you can use
@example
-#+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00
+#+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00
#+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
@end example
these estimates defined consistently, two or three key presses will narrow
down the list to stuff that fits into an available time slot.
-@node Relative timer, , Effort estimates, Dates and Times
+@node Relative timer, Countdown timer, Effort estimates, Dates and Times
@section Taking notes with a relative timer
@cindex relative timer
such a relative timer and make it easy to create timed notes.
@table @kbd
-@kindex C-c C-x .
-@item C-c C-x .
+@orgcmd{C-c C-x .,org-timer}
Insert a relative time into the buffer. The first time you use this, the
timer will be started. When called with a prefix argument, the timer is
restarted.
-@kindex C-c C-x -
-@item C-c C-x -
+@orgcmd{C-c C-x -,org-timer-item}
Insert a description list item with the current relative time. With a prefix
argument, first reset the timer to 0.
-@kindex M-@key{RET}
-@item M-@key{RET}
+@orgcmd{M-@key{RET},org-insert-heading}
Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
new timer items.
+@c for key sequences with a comma, command name macros fail :(
@kindex C-c C-x ,
@item C-c C-x ,
-Pause the timer, or continue it if it is already paused.
+Pause the timer, or continue it if it is already paused
+(@command{org-timer-pause-or-continue}).
@c removed the sentence because it is redundant to the following item
@kindex C-u C-c C-x ,
@item C-u C-c C-x ,
Stop the timer. After this, you can only start a new timer, not continue the
old one. This command also removes the timer from the mode line.
-@kindex C-c C-x 0
-@item C-c C-x 0
+@orgcmd{C-c C-x 0,org-timer-start}
Reset the timer without inserting anything into the buffer. By default, the
timer is reset to 0. When called with a @kbd{C-u} prefix, reset the timer to
specific starting offset. The user is prompted for the offset, with a
default taken from a timer string at point, if any, So this can be used to
restart taking notes after a break in the process. When called with a double
-prefix argument @kbd{C-c C-u}, change all timer strings in the active region
+prefix argument @kbd{C-u C-u}, change all timer strings in the active region
by a certain amount. This can be used to fix timer strings if the timer was
not started at exactly the right moment.
@end table
+@node Countdown timer, , Relative timer, Dates and Times
+@section Countdown timer
+@cindex Countdown timer
+@kindex C-c C-x ;
+@kindex ;
+
+Calling @code{org-timer-set-timer} from an Org-mode buffer runs a countdown
+timer. Use @kbd{;} from agenda buffers, @key{C-c C-x ;} everywhere else.
+
+@code{org-timer-set-timer} prompts the user for a duration and displays a
+countdown timer in the modeline. @code{org-timer-default-timer} sets the
+default countdown value. Giving a prefix numeric argument overrides this
+default value.
+
@node Capture - Refile - Archive, Agenda Views, Dates and Times, Top
@chapter Capture - Refile - Archive
@cindex capture
An important part of any organization system is the ability to quickly
capture new ideas and tasks, and to associate reference material with them.
-Org uses the @file{remember.el} package to create tasks, and stores files
+Org does this using a process called @i{capture}. It also can store files
related to a task (@i{attachments}) in a special directory. Once in the
system, tasks and projects need to be moved around. Moving completed project
trees to an archive file keeps the system compact and fast.
@menu
-* Remember:: Capture new tasks/ideas with little interruption
-* Attachments:: Add files to tasks.
+* Capture:: Capturing new stuff
+* Attachments:: Add files to tasks
* RSS Feeds:: Getting input from RSS feeds
-* Protocols:: External (e.g. Browser) access to Emacs and Org
+* Protocols:: External (e.g.@: Browser) access to Emacs and Org
* Refiling notes:: Moving a tree from one place to another
* Archiving:: What to do with finished projects
@end menu
-@node Remember, Attachments, Capture - Refile - Archive, Capture - Refile - Archive
-@section Remember
-@cindex @file{remember.el}
+@node Capture, Attachments, Capture - Refile - Archive, Capture - Refile - Archive
+@section Capture
+@cindex capture
-The Remember package by John Wiegley lets you store quick notes with little
-interruption of your work flow. It is an excellent way to add new notes and
-tasks to Org files. The @code{remember.el} package is part of Emacs 23, not
-Emacs 22. See @uref{http://www.emacswiki.org/cgi-bin/wiki/RememberMode} for
-more information.
+Org's method for capturing new items is heavily inspired by John Wiegley
+excellent remember package. Up to version 6.36 Org used a special setup
+for @file{remember.el}. @file{org-remember.el} is still part of Org-mode for
+backward compatibility with existing setups. You can find the documentation
+for org-remember at @url{http://orgmode.org/org-remember.pdf}.
+
+The new capturing setup described here is preferred and should be used by new
+users. To convert your @code{org-remember-templates}, run the command
+@example
+@kbd{M-x org-capture-import-remember-templates @key{RET}}
+@end example
+@noindent and then customize the new variable with @kbd{M-x
+customize-variable org-capture-templates}, check the result, and save the
+customization. You can then use both remember and capture until
+you are familiar with the new mechanism.
-Org significantly expands the possibilities of Remember: 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.
+Capture lets you quickly store notes with little interruption of your work
+flow. The basic process of capturing is very similar to remember, but Org
+does enhance it with templates and more.
@menu
-* Setting up Remember for Org:: 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
+* Setting up capture:: Where notes will be stored
+* Using capture:: Commands to invoke and terminate capture
+* Capture templates:: Define the outline of different note types
@end menu
-@node Setting up Remember for Org, Remember templates, Remember, Remember
-@subsection Setting up Remember for Org
+@node Setting up capture, Using capture, Capture, Capture
+@subsection Setting up capture
-The following customization will tell Remember to use Org files as
-target, and to create annotations compatible with Org links.
+The following customization sets a default target file for notes, and defines
+a global key@footnote{Please select your own key, @kbd{C-c c} is only a
+suggestion.} for capturing new material.
+@vindex org-default-notes-file
@example
-(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)
+(define-key global-map "\C-cc" 'org-capture)
@end example
-@noindent
-The last line binds the command @code{org-remember} to a global
-key@footnote{Please select your own key, @kbd{C-c r} is only a
-suggestion.}. @code{org-remember} basically just calls 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 jumps to the location where the last
-remember note was stored.
-
-The Remember buffer will actually use @code{org-mode} as its major mode, so
-that all editing features of Org mode are available. In addition to this, a
-minor mode @code{org-remember-mode} is turned on, for the single purpose that
-you can use its keymap @code{org-remember-mode-map} to overwrite some of
-Org mode's key bindings.
-
-You can also call @code{org-remember} in a special way from the agenda,
-using the @kbd{k r} key combination. With this access, any timestamps
-inserted by the selected Remember template (see below) will default to
-the cursor date in the agenda, rather than to the current date.
-
-@node Remember templates, Storing notes, Setting up Remember for Org, Remember
-@subsection Remember templates
-@cindex templates, for Remember
-
-In combination with Org, you can use templates to generate
-different types of Remember notes. For example, if you would like
-to use one template to create general TODO entries, another one for
-journal entries, and a third one for collecting random ideas, you could
-use:
-
-@example
-(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 "* %^@{Title@}\n %i\n %a" "~/org/JOURNAL.org" "New Ideas")))
-@end example
-
-@vindex org-remember-default-headline
-@vindex org-directory
-@noindent 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 @code{org-default-notes-file}, the heading
-to @code{org-remember-default-headline}. If the file name is not an absolute
-path, it will be interpreted relative to @code{org-directory}.
-
-The heading can also be the symbols @code{top} or @code{bottom} to send notes
-as level 1 entries to the beginning or end of the file, respectively. It may
-also be the symbol @code{date-tree}. Then, a tree with year on level 1,
-month on level 2 and day on level three will be build in the file, and the
-entry will be filed into the tree under the current date@footnote{If the file
-contains an entry with a @code{DATE_TREE} property, the entire date tree will
-be build under that entry.}
-
-An optional sixth element specifies the contexts in which the user can select
-the template. This element can be 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 modes, and exclude templates for which
-this condition is not fulfilled. Templates that do not specify this element
-at all, or that use @code{nil} or @code{t} as a value will always be
-selectable.
-
-So for example:
-
-@example
-(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" "X" my-check)
- ("Idea" ?i "* %^@{Title@}\n %i\n %a" "~/org/JOURNAL.org" "New Ideas")))
-@end example
+@node Using capture, Capture templates, Setting up capture, Capture
+@subsection Using capture
-@noindent
-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.
+@table @kbd
+@orgcmd{C-c c,org-capture}
+Call the command @code{org-capture}. Note that this keybinding is global and
+not active by default - you need to install it. If you have templates
+@cindex date tree
+defined @pxref{Capture templates}, it will offer these templates for
+selection or use a new Org outline node as the default template. It will
+insert the template into the target file and switch to an indirect buffer
+narrowed to this new node. You may then insert the information you want.
+
+@orgcmd{C-c C-c,org-capture-finalize}
+Once you have finished entering information into the capture buffer, @kbd{C-c
+C-c} will return you to the window configuration before the capture process,
+so that you can resume your work without further distraction. When called
+with a prefix arg, finalize and then jump to the captured item.
+
+@orgcmd{C-c C-w,org-capture-refile}
+Finalize the capture process by refiling (@pxref{Refiling notes}) the note to
+a different place. Please realize that this is a normal refiling command
+that will be executed---so the cursor position at the moment you run this
+command is important. If you have inserted a tree with a parent and
+children, first move the cursor back to the parent. Any prefix argument
+given to this command will be passed on to the @code{org-refile} command.
+
+@orgcmd{C-c C-k,org-capture-kill}
+Abort the capture process and return to the previous state.
+
+@end table
-When you call @kbd{M-x org-remember} (or @kbd{M-x 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
+You can also call @code{org-capture} in a special way from the agenda, using
+the @kbd{k c} key combination. With this access, any timestamps inserted by
+the selected capture template will default to the cursor date in the agenda,
+rather than to the current date.
+
+To find the locations of the last stored capture, use @code{org-capture} with
+prefix commands:
+
+@table @kbd
+@orgkey{C-u C-c c}
+Visit the target location of a capture template. You get to select the
+template in the usual way.
+@orgkey{C-u C-u C-c c}
+Visit the last stored capture item in its buffer.
+@end table
+
+@node Capture templates, , Using capture, Capture
+@subsection Capture templates
+@cindex templates, for Capture
+
+You can use templates for different types of capture items, and
+for different target locations. The easiest way to create such templates is
+through the customize interface.
+
+@table @kbd
+@orgkey{C-c c C}
+Customize the variable @code{org-capture-templates}.
+@end table
+
+Before we give the formal description of template definitions, let's look at
+an example. Say you would like to use one template to create general TODO
+entries, and you want to put these entries under the heading @samp{Tasks} in
+your file @file{~/org/gtd.org}. Also, a date tree in the file
+@file{journal.org} should capture journal entries. A possible configuration
+would look like:
+
+@example
+(setq org-capture-templates
+ '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks")
+ "* TODO %?\n %i\n %a")
+ ("j" "Journal" entry (file+datetree "~/org/journal.org")
+ "* %?\nEntered on %U\n %i\n %a")))
+@end example
+
+@noindent If you then press @kbd{C-c c t}, Org will prepare the template
+for you like this:
@example
* TODO
- [[file:@var{link to where you called remember}]]
+ [[file:@var{link to where you initiated capture}]]
@end example
@noindent
-During expansion of the template, special @kbd{%}-escapes@footnote{If you
-need one of these sequences literally, escape the @kbd{%} with a backslash.}
-allow dynamic insertion of content:
+During expansion of the template, @code{%a} has been replaced by a link to
+the location from where you called the capture command. This can be
+extremely useful for deriving tasks from emails, for example. You fill in
+the task definition, press @code{C-c C-c} and Org returns you to the same
+place where you started the capture process.
+
+To define special keys to capture to a particular template without going
+through the interactive template selection, you can create your key binding
+like this:
+
+@lisp
+(define-key global-map "\C-cx"
+ (lambda () (interactive) (org-capture nil "x")))
+@end lisp
+
+@menu
+* Template elements:: What is needed for a complete template entry
+* Template expansion:: Filling in information about time and context
+@end menu
+
+@node Template elements, Template expansion, Capture templates, Capture templates
+@subsubsection Template elements
+
+Now let's look at the elements of a template definition. Each entry in
+@code{org-capture-templates} is a list with the following items:
+
+@table @var
+@item keys
+The keys that will select the template, as a string, characters
+only, for example @code{"a"} for a template to be selected with a
+single key, or @code{"bt"} for selection with two keys. When using
+several keys, keys using the same prefix key must be sequential
+in the list and preceded by a 2-element entry explaining the
+prefix key, for example
@example
-%^@{@var{prompt}@} @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}
- @r{%^@{prompt|default|completion2|completion3...@}}
- @r{The arrow keys access a prompt-specific history.}
-%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.}
+ ("b" "Templates for marking stuff to buy")
+@end example
+@noindent If you do not define a template for the @kbd{C} key, this key will
+be used to open the customize buffer for this complex variable.
+
+@item description
+A short string describing the template, which will be shown during
+selection.
+
+@item type
+The type of entry, a symbol. Valid values are:
+@table @code
+@item entry
+An Org-mode node, with a headline. Will be filed as the child of the target
+entry or as a top-level entry. The target file should be an Org-mode file.
+@item item
+A plain list item, placed in the first plain list at the target
+location. Again the target file should be an Org file.
+@item checkitem
+A checkbox item. This only differs from the plain list item by the
+default template.
+@item table-line
+a new line in the first table at the target location. Where exactly the
+line will be inserted depends on the properties @code{:prepend} and
+@code{:table-line-pos} (see below).
+@item plain
+Text to be inserted as it is.
+@end table
+
+@item target
+@vindex org-default-notes-file
+Specification of where the captured item should be placed. In Org-mode
+files, targets usually define a node. Entries will become children of this
+node. Other types will be added to the table or list in the body of this
+node. Most target specifications contain a file name. If that file name is
+the empty string, it defaults to @code{org-default-notes-file}. A file can
+also be given as a variable, function, or Emacs Lisp form.
+
+Valid values are:
+@table @code
+@item (file "path/to/file")
+Text will be placed at the beginning or end of that file.
+
+@item (id "id of existing org entry")
+Filing as child of this entry, or in the body of the entry.
+
+@item (file+headline "path/to/file" "node headline")
+Fast configuration if the target heading is unique in the file.
+
+@item (file+olp "path/to/file" "Level 1 heading" "Level 2" ...)
+For non-unique headings, the full path is safer.
+
+@item (file+regexp "path/to/file" "regexp to find location")
+Use a regular expression to position the cursor.
+
+@item (file+datetree "path/to/file")
+Will create a heading in a date tree for today's date.
+
+@item (file+datetree+prompt "path/to/file")
+Will create a heading in a date tree, but will prompt for the date.
+
+@item (file+function "path/to/file" function-finding-location)
+A function to find the right location in the file.
+
+@item (clock)
+File to the entry that is currently being clocked.
+
+@item (function function-finding-location)
+Most general way, write your own function to find both
+file and location.
+@end table
+
+@item template
+The template for creating the capture item. If you leave this empty, an
+appropriate default template will be used. Otherwise this is a string with
+escape codes, which will be replaced depending on time and context of the
+capture call. The string with escapes may be loaded from a template file,
+using the special syntax @code{(file "path/to/template")}. See below for
+more details.
+
+@item properties
+The rest of the entry is a property list of additional options.
+Recognized properties are:
+@table @code
+@item :prepend
+Normally new captured information will be appended at
+the target location (last child, last table line, last list item...).
+Setting this property will change that.
+
+@item :immediate-finish
+When set, do not offer to edit the information, just
+file it away immediately. This makes sense if the template only needs
+information that can be added automatically.
+
+@item :empty-lines
+Set this to the number of lines to insert
+before and after the new item. Default 0, only common other value is 1.
+
+@item :clock-in
+Start the clock in this item.
+
+@item :clock-keep
+Keep the clock running when filing the captured entry.
+
+@item :clock-resume
+If starting the capture interrupted a clock, restart that clock when finished
+with the capture. Note that @code{:clock-keep} has precedence over
+@code{:clock-resume}. When setting both to @code{t}, the current clock will
+run and the previous one will not be resumed.
+
+@item :unnarrowed
+Do not narrow the target buffer, simply show the full buffer. Default is to
+narrow it so that you only see the new material.
+
+@item :table-line-pos
+Specification of the location in the table where the new line should be
+inserted. It should be a string like @code{"II-3"} meaning that the new
+line should become the third line before the second horizontal separator
+line.
+
+@item :kill-buffer
+If the target file was not yet visited when capture was invoked, kill the
+buffer again after capture is completed.
+@end table
+@end table
+
+@node Template expansion, , Template elements, Capture templates
+@subsubsection Template expansion
+
+In the template itself, special @kbd{%}-escapes@footnote{If you need one of
+these sequences literally, escape the @kbd{%} with a backslash.} allow
+dynamic insertion of content. The templates are expanded in the order given here:
+
+@smallexample
+%[@var{file}] @r{insert the contents of the file given by @var{file}.}
+%(@var{sexp}) @r{evaluate Elisp @var{sexp} and replace with the result.}
+%<...> @r{the result of format-time-string on the ... format specification.}
+%t @r{timestamp, date only.}
+%T @r{timestamp with date and time.}
+%u, %U @r{like the above, but inactive timestamps.}
+%a @r{annotation, normally the link created with @code{org-store-link}.}
+%i @r{initial content, the region when capture is called while the}
+ @r{region is active.}
@r{The entire text will be indented like @code{%i} itself.}
-%t @r{timestamp, date only}
-%T @r{timestamp with date and time}
-%u, %U @r{like the above, but inactive timestamps}
-%^t @r{like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}}
- @r{You may define a prompt like @code{%^@{Birthday@}t}}
-%n @r{user name (taken from @code{user-full-name})}
+%A @r{like @code{%a}, but prompt for the description part.}
%c @r{Current kill ring head.}
%x @r{Content of the X clipboard.}
-%^C @r{Interactive selection of which kill or clip to use.}
-%^L @r{Like @code{%^C}, but insert as link.}
+%k @r{title of the currently clocked task.}
+%K @r{link to the currently clocked task.}
+%n @r{user name (taken from @code{user-full-name}).}
+%f @r{file visited by current buffer when org-capture was called.}
+%F @r{full path of the file or directory visited by current buffer.}
+%:keyword @r{specific information for certain link types, see below.}
%^g @r{prompt for tags, with completion on tags in target file.}
-%k @r{title of currently clocked task}
-%K @r{link to currently clocked task}
%^G @r{prompt for tags, with completion all tags in all agenda files.}
-%^@{@var{prop}@}p @r{Prompt the user for a value for property @var{prop}}
-%:keyword @r{specific information for certain link types, see below}
-%[@var{file}] @r{insert the contents of the file given by @var{file}}
-%(@var{sexp}) @r{evaluate Elisp @var{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)}
-%& @r{jump to target location immediately after storing note}
-@end example
+%^t @r{like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}.}
+ @r{You may define a prompt like @code{%^@{Birthday@}t}.}
+%^C @r{Interactive selection of which kill or clip to use.}
+%^L @r{Like @code{%^C}, but insert as link.}
+%^@{@var{prop}@}p @r{Prompt the user for a value for property @var{prop}.}
+%^@{@var{prompt}@} @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}
+ @r{%^@{prompt|default|completion2|completion3...@}.}
+ @r{The arrow keys access a prompt-specific history.}
+@end smallexample
@noindent
For specific link types, the following keywords will be
defined@footnote{If you define your own link types (@pxref{Adding
hyperlink types}), any property you store with
-@code{org-store-link-props} can be accessed in remember templates in a
+@code{org-store-link-props} can be accessed in capture templates in a
similar way.}:
@vindex org-from-is-user-regexp
-@example
-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
+@smallexample
+Link type | Available keywords
+------------------------+----------------------------------------------
+bbdb | %:name %:company
+irc | %:server %:port %:nick
+vm, wl, mh, mew, rmail | %:type %:subject %:message-id
+ | %:from %:fromname %:fromaddress
+ | %:to %:toname %:toaddress
+ | %:date @r{(message date header field)}
+ | %:date-timestamp @r{(date as active timestamp)}
+ | %:date-timestamp-inactive @r{(date as inactive timestamp)}
+ | %: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 smallexample
@noindent
To place the cursor after template expansion use:
-@example
+@smallexample
%? @r{After completing the template, position cursor here.}
-@end example
-
-@noindent
-If you change your mind about which template to use, call
-@code{org-remember} in the remember buffer. You may then select a new
-template that will be filled with the previous context information.
-
-@node Storing notes, , Remember templates, Remember
-@subsection Storing notes
-
-@vindex org-remember-clock-out-on-exit
-When you are finished preparing a note with Remember, you have to press
-@kbd{C-c C-c} to file the note away. If you have started the clock in the
-Remember buffer, you will first be asked if you want to clock out
-now@footnote{To avoid this query, configure the variable
-@code{org-remember-clock-out-on-exit}.}. If you answer @kbd{n}, the clock
-will continue to run after the note was filed away.
-
-The handler will then store the note in the file and under the headline
-specified in the template, or it will use the default file and headline.
-The window configuration will be restored, sending you back to the working
-context before the call to Remember. To re-use the location found
-during the last call to Remember, exit the Remember buffer with
-@kbd{C-0 C-c C-c}, i.e. specify a zero prefix argument to @kbd{C-c C-c}.
-Another special case is @kbd{C-2 C-c C-c} which files the note as a child of
-the currently clocked item.
-
-@vindex org-remember-store-without-prompt
-If you want to store the note directly to a different place, use
-@kbd{C-1 C-c C-c} instead to exit Remember@footnote{Configure 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 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:
-@example
-@key{TAB} @r{Cycle visibility.}
-@key{down} / @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.}
-@c 0-9 @r{Digit argument.}
-@end example
-@noindent
-Pressing @key{RET} or @key{left} or @key{right}
-then leads to the following result.
-
-@vindex org-reverse-note-order
-@multitable @columnfractions 0.2 0.15 0.65
-@item @b{Cursor position} @tab @b{Key} @tab @b{Note gets inserted}
-@item on headline @tab @key{RET} @tab as sublevel of the heading at cursor, first or last
-@item @tab @tab depending on @code{org-reverse-note-order}.
-@item @tab @key{left}/@key{right} @tab as same level, before/after current heading
-@item buffer-start @tab @key{RET} @tab as level 2 heading at end of file or level 1 at beginning
-@item @tab @tab depending on @code{org-reverse-note-order}.
-@item not on headline @tab @key{RET}
- @tab at cursor position, level taken from context.
-@end multitable
-
-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. 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.
+@end smallexample
-@node Attachments, RSS Feeds, Remember, Capture - Refile - Archive
+@node Attachments, RSS Feeds, Capture, Capture - Refile - Archive
@section Attachments
@cindex attachments
@vindex org-attach-directory
It is often useful to associate reference material with an outline node/task.
Small chunks of plain text can simply be stored in the subtree of a project.
-Hyperlinks (@pxref{Hyperlinks}) can be used to establish associations with
+Hyperlinks (@pxref{Hyperlinks}) can establish associations with
files that live elsewhere on your computer or in the cloud, like emails or
source code files belonging to a project. Another method is @i{attachments},
which are files located in a directory belonging to an outline node. Org
directory from a parent, so that an entire subtree uses the same attached
directory.
-@noindent The following commands deal with attachments.
+@noindent The following commands deal with attachments:
@table @kbd
-@kindex C-c C-a
-@item C-c C-a
+@orgcmd{C-c C-a,org-attach}
The dispatcher for commands related to the attachment system. After these
-keys, a list of commands is displayed and you need to press an additional key
+keys, a list of commands is displayed and you must press an additional key
to select a command:
@table @kbd
-@kindex C-c C-a a
-@item a
+@orgcmdtkc{a,C-c C-a a,org-attach-attach}
@vindex org-attach-method
Select a file and move it into the task's attachment directory. The file
will be copied, moved, or linked, depending on @code{org-attach-method}.
Attach a file using the copy/move/link method.
Note that hard links are not supported on all systems.
-@kindex C-c C-a n
-@item n
+@orgcmdtkc{n,C-c C-a n,org-attach-new}
Create a new attachment as an Emacs buffer.
-@kindex C-c C-a z
-@item z
+@orgcmdtkc{z,C-c C-a z,org-attach-sync}
Synchronize the current task with its attachment directory, in case you added
attachments yourself.
-@kindex C-c C-a o
-@item o
+@orgcmdtkc{o,C-c C-a o,org-attach-open}
@vindex org-file-apps
-Open current task's attachment. If there are more than one, prompt for a
+Open current task's attachment. If there is more than one, prompt for a
file name first. Opening will follow the rules set by @code{org-file-apps}.
For more details, see the information on following hyperlinks
(@pxref{Handling links}).
-@kindex C-c C-a O
-@item O
+@orgcmdtkc{O,C-c C-a O,org-attach-open-in-emacs}
Also open the attachment, but force opening the file in Emacs.
-@kindex C-c C-a f
-@item f
+@orgcmdtkc{f,C-c C-a f,org-attach-reveal}
Open the current task's attachment directory.
-@kindex C-c C-a F
-@item F
+@orgcmdtkc{F,C-c C-a F,org-attach-reveal-in-emacs}
Also open the directory, but force using @command{dired} in Emacs.
-@kindex C-c C-a d
-@item d
+@orgcmdtkc{d,C-c C-a d,org-attach-delete-one}
Select and delete a single attachment.
-@kindex C-c C-a D
-@item D
+@orgcmdtkc{D,C-c C-a D,org-attach-delete-all}
Delete all of a task's attachments. A safer way is to open the directory in
@command{dired} and delete from there.
-@kindex C-c C-a s
-@item C-c C-a s
+@orgcmdtkc{s,C-c C-a s,org-attach-set-directory}
@cindex property, ATTACH_DIR
Set a specific directory as the entry's attachment directory. This works by
putting the directory path into the @code{ATTACH_DIR} property.
-@kindex C-c C-a i
-@item C-c C-a i
+@orgcmdtkc{i,C-c C-a i,org-attach-set-inherit}
@cindex property, ATTACH_DIR_INHERIT
Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
same directory for attachments as the parent does.
@node RSS Feeds, Protocols, Attachments, Capture - Refile - Archive
@section RSS feeds
@cindex RSS feeds
+@cindex Atom feeds
-Org has the capability to add and change entries based on information found in
-RSS feeds. You could use this to make a task out of each new podcast in a
+Org can add and change entries based on information found in RSS feeds and
+Atom feeds. You could use this to make a task out of each new podcast in a
podcast feed. Or you could use a phone-based note-creating service on the
-web to import tasks into Org. To access feeds, you need to configure the
-variable @code{org-feed-alist}. The docstring of this variable has detailed
+web to import tasks into Org. To access feeds, configure the variable
+@code{org-feed-alist}. The docstring of this variable has detailed
information. Here is just an example:
@example
(setq org-feed-alist
- '(("ReQall" "http://www.reqall.com/user/feeds/rss/a1b2c3....."
- "~/org/feeds.org" "ReQall Entries")
+ '(("Slashdot"
+ "http://rss.slashdot.org/Slashdot/slashdot"
+ "~/txt/org/feeds.org" "Slashdot Entries")))
@end example
+
@noindent
-will configure that new items from the feed provided by @file{reqall.com}
-will result in new entries in the file @file{~/org/feeds.org} under the
-heading @samp{ReQall Entries}, whenever the following command is used:
+will configure that new items from the feed provided by
+@code{rss.slashdot.org} will result in new entries in the file
+@file{~/org/feeds.org} under the heading @samp{Slashdot Entries}, whenever
+the following command is used:
@table @kbd
-@kindex C-c C-x g
+@orgcmd{C-c C-x g,org-feed-update-all}
@item C-c C-x g
Collect items from the feeds configured in @code{org-feed-alist} and act upon
them.
-@kindex C-c C-x G
-@item C-c C-x G
+@orgcmd{C-c C-x G,org-feed-goto-inbox}
Prompt for a feed name and go to the inbox configured for this feed.
@end table
#+DRAWERS: LOGBOOK PROPERTIES FEEDSTATUS
@end example
-For more information, see @file{org-feed.el} and the docstring of
-@code{org-feed-alist}.
+For more information, including how to read atom feeds, see
+@file{org-feed.el} and the docstring of @code{org-feed-alist}.
@node Protocols, Refiling notes, RSS Feeds, Capture - Refile - Archive
@section Protocols for external access
You can set up Org for handling protocol calls from outside applications that
are passed to Emacs through the @file{emacsserver}. For example, you can
configure bookmarks in your web browser to send a link to the current page to
-Org and create a note from it using Remember (@pxref{Remember}). Or you
+Org and create a note from it using capture (@pxref{Capture}). Or you
could create a bookmark that will tell Emacs to open the local source file of
a remote website you are looking at with the browser. See
@uref{http://orgmode.org/worg/org-contrib/org-protocol.php} for detailed
process, you can use the following special command:
@table @kbd
-@kindex C-c C-w
-@item C-c C-w
+@orgcmd{C-c C-w,org-refile}
@vindex org-reverse-note-order
@vindex org-refile-targets
@vindex org-refile-use-outline-path
@vindex org-outline-path-complete-in-steps
@vindex org-refile-allow-creating-parent-nodes
+@vindex org-log-refile
+@vindex org-refile-use-cache
Refile the entry or region at point. This command offers possible locations
for refiling the entry and lets you select one with completion. The item (or
all items in the region) is filed below the target heading as a subitem.
@code{org-outline-path-complete-in-steps}. If you would like to be able to
create new nodes as new parents for refiling on the fly, check the
variable @code{org-refile-allow-creating-parent-nodes}.
-@kindex C-u C-c C-w
-@item C-u C-c C-w
+When the variable @code{org-log-refile}@footnote{with corresponding
+@code{#+STARTUP} keywords @code{logrefile}, @code{lognoterefile},
+and @code{nologrefile}} is set, a timestamp or a note will be
+recorded when an entry has been refiled.
+@orgkey{C-u C-c C-w}
Use the refile interface to jump to a heading.
-@kindex C-u C-u C-c C-w
-@item C-u C-u C-c C-w
+@orgcmd{C-u C-u C-c C-w,org-refile-goto-last-stored}
Jump to the location where @code{org-refile} last moved a tree to.
@item C-2 C-c C-w
Refile as the child of the item currently being clocked.
+@item C-0 C-c C-w @ @r{or} @ C-u C-u C-u C-c C-w
+
+@orgcmdtkc{C-0 C-c C-w @ @r{or} @ C-u C-u C-u C-c C-w,C-0 C-c C-w,org-refile-cache-clear}
+
+Clear the target cache. Caching of refile targets can be turned on by
+setting @code{org-refile-use-cache}. To make the command see new possible
+targets, you have to clear the cache with this command.
@end table
@node Archiving, , Refiling notes, Capture - Refile - Archive
searches like the construction of agenda views fast.
@table @kbd
-@kindex C-c C-x C-a
-@item C-c C-x C-a
+@orgcmd{C-c C-x C-a,org-archive-subtree-default}
@vindex org-archive-default-command
Archive the current entry using the command specified in the variable
@code{org-archive-default-command}.
@menu
* Moving subtrees:: Moving a tree to an archive file
-* Internal archiving:: Switch off a tree but keep i in the file
+* Internal archiving:: Switch off a tree but keep it in the file
@end menu
@node Moving subtrees, Internal archiving, Archiving, Archiving
the archive file.
@table @kbd
-@kindex C-c $
-@kindex C-c C-x C-s
-@item C-c C-x C-s@ @r{or short} @ C-c $
+@orgcmdkskc{C-c C-x C-s,C-c $,org-archive-subtree}
@vindex org-archive-location
Archive the subtree starting at the cursor position to the location
given by @code{org-archive-location}.
-@kindex C-u C-c C-x C-s
-@item C-u C-c C-x C-s
+@orgkey{C-u C-c C-x C-s}
Check if any direct children of the current headline could be moved to
the archive. To do this, each subtree is checked for open TODO entries.
If none are found, the command offers to move it to the archive
is. Configure the details using the variable
@code{org-export-with-archived-trees}.
@item
-@vindex org-columns-skip-arrchived-trees
+@vindex org-columns-skip-archived-trees
Archived trees are excluded from column view unless the variable
-@code{org-columns-skip-arrchived-trees} is configured to @code{nil}.
+@code{org-columns-skip-archived-trees} is configured to @code{nil}.
@end itemize
-The following commands help managing the ARCHIVE tag:
+The following commands help manage the ARCHIVE tag:
@table @kbd
-@kindex C-c C-x a
-@item C-c C-x a
+@orgcmd{C-c C-x a,org-toggle-archive-tag}
Toggle the ARCHIVE tag for the current headline. When the tag is set,
the headline changes to a shadowed face, and the subtree below it is
hidden.
-@kindex C-u C-c C-x a
-@item C-u C-c C-x a
+@orgkey{C-u C-c C-x a}
Check if any direct children of the current headline should be archived.
To do this, each subtree is checked for open TODO entries. If none are
found, the command offers to set the ARCHIVE tag for the child. If the
cursor is @emph{not} on a headline when this command is invoked, the
level 1 trees will be checked.
-@kindex C-@kbd{TAB}
-@item C-@kbd{TAB}
+@orgcmd{C-@kbd{TAB},org-force-cycle-archived}
Cycle a tree even if it is tagged with ARCHIVE.
-@kindex C-c C-x A
-@item C-c C-x A
+@orgcmd{C-c C-x A,org-archive-to-archive-sibling}
Move the current entry to the @emph{Archive Sibling}. This is a sibling of
the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}. The
entry becomes a child of that sibling and in this way retains a lot of its
@node Agenda Views, Markup, Capture - Refile - Archive, Top
-@chapter Agenda Views
+@chapter Agenda views
@cindex agenda views
Due to the way Org works, TODO items, time-stamped items, and
files}, the files listed in the variable
@code{org-agenda-files}@footnote{If the value of that variable is not a
list, but a single file name, then the list of agenda files will be
-maintained in that external file.}. If a directory is part of this list,
+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.
@cindex files, adding to agenda list
@table @kbd
-@kindex C-c [
-@item C-c [
+@orgcmd{C-c [,org-agenda-file-to-front}
Add current file to the list of agenda files. The file is added to
the front of the list. If it was already in the list, it is moved to
the front. With a prefix argument, file is added/moved to the end.
-@kindex C-c ]
-@item C-c ]
+@orgcmd{C-c ],org-remove-file}
Remove current file from the list of agenda files.
@kindex C-,
-@kindex C-'
-@item C-,
-@itemx C-'
+@orgcmd{C-',org-cycle-agenda-files}
+@itemx C-,
Cycle through agenda file list, visiting one file after the other.
@kindex M-x org-iswitchb
@item M-x org-iswitchb
extended period, use the following commands:
@table @kbd
-@kindex C-c C-x <
-@item C-c C-x <
+@orgcmd{C-c C-x <,org-agenda-set-restriction-lock}
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.
-@kindex C-c C-x >
-@item C-c C-x >
+@orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
Remove the permanent restriction created by @kbd{C-c C-x <}.
@end table
When working with @file{speedbar.el}, you can use the following commands in
the Speedbar frame:
@table @kbd
-@kindex <
-@item < @r{in the speedbar frame}
+@orgcmdtkc{< @r{in the speedbar frame},<,org-speedbar-set-agenda-restriction}
Permanently restrict the agenda to the item---either an Org file or a subtree
in such a file---at the cursor in the Speedbar frame.
If there is a window displaying an agenda view, the new restriction takes
effect immediately.
-@kindex >
-@item > @r{in the speedbar frame}
+@orgcmdtkc{> @r{in the speedbar frame},>,org-agenda-remove-restriction-lock}
Lift the restriction.
@end table
@cindex agenda dispatcher
@cindex dispatching agenda commands
The views are created through a dispatcher, which should be bound to a
-global key---for example @kbd{C-c a} (@pxref{Installation}). In the
+global key---for example @kbd{C-c a} (@pxref{Activation}). In the
following we will assume that @kbd{C-c a} is indeed how the dispatcher
is accessed and list keyboard access to commands accordingly. After
pressing @kbd{C-c a}, an additional letter is required to execute a
@table @kbd
@cindex org-agenda, command
-@kindex C-c a a
-@item C-c a a
-@vindex org-agenda-ndays
+@orgcmd{C-c a a,org-agenda-list}
Compile an agenda for the current week from a list of Org files. The agenda
shows the entries for each day. With a numeric prefix@footnote{For backward
compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
listed before the agenda. This feature is deprecated, use the dedicated TODO
list, or a block agenda instead (@pxref{Block agenda}).} (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})
+C-c a a}) you may set the number of days to be displayed.
@end table
+@vindex org-agenda-span
+@vindex org-agenda-ndays
+The default number of days displayed in the agenda is set by the variable
+@code{org-agenda-span} (or the obsolete @code{org-agenda-ndays}). This
+variable can be set to any number of days you want to see by default in the
+agenda, or to a span name, such a @code{day}, @code{week}, @code{month} or
+@code{year}.
+
Remote editing from the agenda buffer means, for example, that you can
change the dates of deadlines and appointments from the agenda buffer.
The commands available in the Agenda buffer are listed in @ref{Agenda
Org. It can be very useful to combine output from Org with
the diary.
-In order to include entries from the Emacs diary into Org mode's
+In order to include entries from the Emacs diary into Org-mode's
agenda, you only need to customize the variable
@lisp
@noindent After that, everything will happen automatically. All diary
entries including holidays, anniversaries, etc., will be included in the
-agenda buffer created by Org mode. @key{SPC}, @key{TAB}, and
+agenda buffer created by Org-mode. @key{SPC}, @key{TAB}, and
@key{RET} can be used from the agenda buffer to jump to the diary
file in order to edit existing diary entries. The @kbd{i} command to
insert new entries for the current date works in the agenda buffer, as
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 file. Org mode evaluates diary-style sexp
+the entries into an Org 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 whitespace is allowed before them. For example,
#+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
+%%(org-anniversary 1956 5 14)@footnote{@code{org-anniversary} is just like @code{diary-anniversary}, but the argument order is always according to ISO and therefore independent of the value of @code{calendar-date-style}.} Arthur Dent is %d years old
+%%(org-anniversary 1869 10 2) Mahatma Gandhi would be %d years old
@end example
@subsubheading Anniversaries from BBDB
* Anniversaries
:PROPERTIES:
:CATEGORY: Anniv
- :END
+ :END:
%%(org-bbdb-anniversaries)
@end example
You can then go ahead and define anniversaries for a BBDB record. Basically,
you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB
-record and then add the date in the format @code{YYYY-MM-DD}, followed by a
-space and the class of the anniversary (@samp{birthday} or @samp{wedding}, or
-a format string). If you omit the class, it will default to @samp{birthday}.
-Here are a few examples, the header for the file @file{org-bbdb.el} contains
-more detailed information.
+record and then add the date in the format @code{YYYY-MM-DD} or @code{MM-DD},
+followed by a space and the class of the anniversary (@samp{birthday} or
+@samp{wedding}, or a format string). If you omit the class, it will default to
+@samp{birthday}. Here are a few examples, the header for the file
+@file{org-bbdb.el} contains more detailed information.
@example
1973-06-22
+06-22
1955-08-02 wedding
2008-04-14 %s released version 6.01 of org-mode, %d years ago
@end example
the appointments of your agenda files, use the command
@code{org-agenda-to-appt}. This command 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.
+or matching a regular expression. See the docstring for details.
@node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views
@subsection The global TODO list
collected into a single place.
@table @kbd
-@kindex C-c a t
-@item C-c a t
-Show the global TODO list. This collects the TODO items from all
-agenda files (@pxref{Agenda Views}) into a single buffer. The buffer is in
-@code{agenda-mode}, so there are commands to examine and manipulate
-the TODO entries directly from that buffer (@pxref{Agenda commands}).
-@kindex C-c a T
-@item C-c a T
+@orgcmd{C-c a t,org-todo-list}
+Show the global TODO list. This collects the TODO items from all agenda
+files (@pxref{Agenda Views}) into a single buffer. By default, this lists
+items with a state the is not a DONE state. The buffer is in
+@code{agenda-mode}, so there are commands to examine and manipulate the TODO
+entries directly from that buffer (@pxref{Agenda commands}).
+@orgcmd{C-c a T,org-todo-list}
@cindex TODO keyword matching
@vindex org-todo-keywords
-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 the boolean OR
-operator. 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}. You are
+prompted for a keyword, and you may also specify several keywords by
+separating them with @samp{|} as the boolean OR operator. With a numeric
+prefix, the Nth keyword in @code{org-todo-keywords} is selected.
@kindex r
The @kbd{r} key in the agenda buffer regenerates it, and you can give
a prefix argument to this command to change the selected TODO keyword,
@item
@vindex org-agenda-todo-ignore-scheduled
@vindex org-agenda-todo-ignore-deadlines
+@vindex org-agenda-todo-ignore-timestamp
@vindex org-agenda-todo-ignore-with-date
Some people view a TODO item that has been @emph{scheduled} for execution or
have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}.
Configure the variables @code{org-agenda-todo-ignore-scheduled},
-@code{org-agenda-todo-ignore-deadlines}, and/or
-@code{org-agenda-todo-ignore-with-date} to exclude such items from the
-global TODO list.
+@code{org-agenda-todo-ignore-deadlines},
+@code{org-agenda-todo-ignore-timestamp} and/or
+@code{org-agenda-todo-ignore-with-date} to exclude such items from the global
+TODO list.
@item
@vindex org-agenda-todo-list-sublevels
TODO items may have sublevels to break up the task into subtasks. In
m}.
@table @kbd
-@kindex C-c a m
-@item C-c a m
+@orgcmd{C-c a m,org-tags-view}
Produce a list of all headlines that match a given set of tags. The
command prompts for a selection criterion, which is a boolean logic
expression with tags, like @samp{+work+urgent-withboss} or
@samp{work|home} (@pxref{Tags}). If you often need a specific search,
define a custom command for it (@pxref{Agenda dispatcher}).
-@kindex C-c a M
-@item C-c a M
+@orgcmd{C-c a M,org-tags-view}
@vindex org-tags-match-list-sublevels
@vindex org-agenda-tags-todo-honor-ignore-options
-Like @kbd{C-c a m}, but only select headlines that are also TODO items and
-force checking subitems (see variable @code{org-tags-match-list-sublevels}).
-To exclude scheduled/deadline items, see the variable
-@code{org-agenda-tags-todo-honor-ignore-options}. Matching specific TODO
-keywords together with a tags match is also possible, see @ref{Tag searches}.
+Like @kbd{C-c a m}, but only select headlines that are also TODO items in a
+not-DONE state and force checking subitems (see variable
+@code{org-tags-match-list-sublevels}). To exclude scheduled/deadline items,
+see the variable @code{org-agenda-tags-todo-honor-ignore-options}. Matching
+specific TODO keywords together with a tags match is also possible, see
+@ref{Tag searches}.
@end table
The commands available in the tags list are described in @ref{Agenda
assumed to be date/time specifications in the standard Org way, and the
comparison will be done accordingly. Special values that will be recognized
are @code{"<now>"} for now (including time), and @code{"<today>"}, and
-@code{"<tomorrow>"} for these days at 0:00 hours, i.e. without a time
+@code{"<tomorrow>"} for these days at 0:00 hours, i.e.@: without a time
specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
@code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
respectively, can be used.
price by accessing one property, testing additional properties is cheap
again.
-You can configure Org mode to use property inheritance during a search, but
+You can configure Org-mode to use property inheritance during a search, but
beware that this can slow down searches considerably. See @ref{Property
inheritance}, for details.
tags/property part of the search string (which may include several terms
connected with @samp{|}) with a @samp{/} and then specify a Boolean
expression just for TODO keywords. The syntax is then similar to that for
-tags, but should be applied with care: for example, a positive
-selection on several TODO keywords cannot 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 (resulting in a speed-up), use @kbd{C-c a M}, or equivalently
-start the TODO part after the slash with @samp{!}. Examples:
+tags, but should be applied with care: for example, a positive selection on
+several TODO keywords cannot 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
+(resulting in a speed-up), use @kbd{C-c a M}, or equivalently start the TODO
+part after the slash with @samp{!}. Using @kbd{C-c a M} or @samp{/!} will
+not match TODO keywords in a DONE state. Examples:
@table @samp
@item work/WAITING
@cindex timeline, single file
@cindex time-sorted view
-The timeline summarizes all time-stamped items from a single Org mode
+The timeline summarizes all time-stamped items from a single Org-mode
file in a @emph{time-sorted view}. The main purpose of this command is
to give an overview over events in a project.
@table @kbd
-@kindex C-c a L
-@item C-c a L
+@orgcmd{C-c a L,org-timeline}
Show a time-sorted view of the Org file, with all time-stamped items.
When called with a @kbd{C-u} prefix, all unfinished TODO entries
(scheduled or not) are also listed under the current date.
@cindex text search
@cindex searching, for text
-This agenda view is a general text search facility for Org mode entries.
+This agenda view is a general text search facility for Org-mode entries.
It is particularly useful to find notes.
@table @kbd
-@kindex C-c a s
-@item C-c a s
+@orgcmd{C-c a s,org-search-view}
This is a special search that lets you select entries by matching a substring
or specific words using a boolean logic.
@end table
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.
+exclude both 8.11b and 8.11g. The first @samp{+} is necessary to turn on
+word search, other @samp{+} characters are optional. For more details, see
+the docstring of the command @code{org-search-view}.
@vindex org-agenda-text-search-extra-files
Note that in addition to the agenda files, this command will also search
@node Stuck projects, , Search view, Built-in agenda views
@subsection Stuck projects
+@pindex GTD, Getting Things Done
If you are following a system like David Allen's GTD to organize your
work, one of the ``duties'' you have is a regular review to make sure
that all projects move along. A @emph{stuck} project is a project that
has no defined next actions, so it will never show up in the TODO lists
-Org mode produces. During the review, you need to identify such
+Org-mode produces. During the review, you need to identify such
projects and define next actions for them.
@table @kbd
-@kindex C-c a #
-@item C-c a #
+@orgcmd{C-c a #,org-agenda-list-stuck-projects}
List projects that are stuck.
@kindex C-c a !
@item C-c a !
level-2 headlines, and that a project is not stuck if it has at least
one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
-Let's assume that you, in your own way of using Org mode, identify
+Let's assume that you, in your own way of using Org-mode, identify
projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
indicate a project that should not be considered yet. Let's further
assume that the TODO keyword DONE marks finished projects, and that NEXT
@cindex presentation, of agenda items
@vindex org-agenda-prefix-format
-Before displaying items in an agenda view, Org mode visually prepares
-the items and sorts them. Each item occupies a single line. The line
-starts with a @emph{prefix} that contains the @emph{category}
-(@pxref{Categories}) of the item and other important information. You can
-customize the prefix using the option @code{org-agenda-prefix-format}.
-The prefix is followed by a cleaned-up version of the outline headline
+@vindex org-agenda-tags-column
+Before displaying items in an agenda view, Org-mode visually prepares the
+items and sorts them. Each item occupies a single line. The line starts
+with a @emph{prefix} that contains the @emph{category} (@pxref{Categories})
+of the item and other important information. You can customize in which
+column tags will be displayed through @code{org-agenda-tags-column}. You can
+also customize the prefix using the option @code{org-agenda-prefix-format}.
+This prefix is followed by a cleaned-up version of the outline headline
associated with the item.
@menu
@subsection Categories
@cindex category
+@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@footnote{For
The display in the agenda buffer looks best if the category is not
longer than 10 characters.
+@noindent
+You can set up icons for category by customizing the
+@code{org-agenda-category-icon-alist} variable.
+
@node Time-of-day specifications, Sorting of agenda items, Categories, Presentation and sorting
@subsection Time-of-day specifications
@cindex time-of-day specification
-Org mode checks each agenda item for a time-of-day specification. The
+Org-mode checks each agenda item for a time-of-day specification. The
time can be part of the timestamp that triggered inclusion into the
agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time
ranges can be specified with two timestamps, like
integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
specifications in diary entries are recognized as well.
-For agenda display, Org mode extracts the time and displays it in a
+For agenda display, Org-mode extracts the time and displays it in a
standard 24 hour format as part of the prefix. The example times in
the previous paragraphs would end up in the agenda like this:
@table @kbd
@tsubheading{Motion}
@cindex motion commands in agenda
-@kindex n
-@item n
+@orgcmd{n,org-agenda-next-line}
Next line (same as @key{up} and @kbd{C-p}).
-@kindex p
-@item p
+@orgcmd{p,org-agenda-previous-line}
Previous line (same as @key{down} and @kbd{C-n}).
@tsubheading{View/Go to Org file}
-@kindex mouse-3
-@kindex @key{SPC}
-@item mouse-3
-@itemx @key{SPC}
+@orgcmdkkc{@key{SPC},mouse-3,org-agenda-show-and-scroll-up}
Display the original location of the item in another window.
With prefix arg, make sure that the entire entry is made visible in the
outline, not only the heading.
@c
-@kindex L
-@item L
+@orgcmd{L,org-agenda-recenter}
Display original location and recenter that window.
@c
-@kindex mouse-2
-@kindex mouse-1
-@kindex @key{TAB}
-@item mouse-2
-@itemx mouse-1
-@itemx @key{TAB}
-Go to the original location of the item in another window. Under Emacs
-22, @kbd{mouse-1} will also works for this.
+@orgcmdkkc{@key{TAB},mouse-2,org-agenda-goto}
+Go to the original location of the item in another window.
@c
-@kindex @key{RET}
-@itemx @key{RET}
+@orgcmd{@key{RET},org-agenda-switch-to}
Go to the original location of the item and delete other windows.
@c
-@kindex F
-@item F
+@orgcmd{F,org-agenda-follow-mode}
@vindex org-agenda-start-with-follow-mode
Toggle Follow mode. In Follow mode, as you move the cursor through
the agenda buffer, the other window always shows the corresponding
agenda buffers can be set with the variable
@code{org-agenda-start-with-follow-mode}.
@c
-@kindex C-c C-x b
-@item C-c C-x b
+@orgcmd{C-c C-x b,org-agenda-tree-to-indirect-buffer}
Display the entire subtree of the current item in an indirect buffer. With a
numeric prefix argument N, go up to level N and then take that tree. If N is
negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the
previously used indirect buffer.
-@kindex C-c C-o
-@item C-c C-o
+@orgcmd{C-c C-o,org-agenda-open-link}
Follow a link in the entry. This will offer a selection of any links in the
text belonging to the referenced Org node. If there is only one link, it
will be followed without a selection prompt.
@tsubheading{Change display}
@cindex display changing, in agenda
+@kindex A
+@item A
+Interactively select another agenda view and append it to the current view.
+@c
@kindex o
@item o
Delete other windows.
@c
-@kindex v d
-@kindex d
-@kindex v w
-@kindex w
-@kindex v m
-@kindex v y
-@item v d @ @r{or short} @ d
-@itemx v w @ @r{or short} @ w
-@itemx v m
-@itemx v y
-Switch to day/week/month/year view. When switching to day or week view,
-this setting becomes the default for subsequent agenda commands. Since
-month and year views are slow to create, they do not become the default.
-A numeric prefix argument may be used to jump directly to a specific day
-of the year, ISO week, month, or year, respectively. For example,
-@kbd{32 d} jumps to February 1st, @kbd{9 w} to ISO week number 9. When
-setting day, week, or month view, a year may be encoded in the prefix
-argument as well. For example, @kbd{200712 w} will jump to week 12 in
-2007. If such a year specification has only one or two digits, it will
-be mapped to the interval 1938-2037.
+@orgcmdkskc{v d,d,org-agenda-day-view}
+@xorgcmdkskc{v w,w,org-agenda-day-view}
+@xorgcmd{v m,org-agenda-month-view}
+@xorgcmd{v y,org-agenda-month-year}
+@xorgcmd{v SPC,org-agenda-reset-view}
+@vindex org-agenda-span
+Switch to day/week/month/year view. When switching to day or week view, this
+setting becomes the default for subsequent agenda refreshes. Since month and
+year views are slow to create, they do not become the default. A numeric
+prefix argument may be used to jump directly to a specific day of the year,
+ISO week, month, or year, respectively. For example, @kbd{32 d} jumps to
+February 1st, @kbd{9 w} to ISO week number 9. When setting day, week, or
+month view, a year may be encoded in the prefix argument as well. For
+example, @kbd{200712 w} will jump to week 12 in 2007. If such a year
+specification has only one or two digits, it will be mapped to the interval
+1938-2037. @kbd{v @key{SPC}} will reset to what is set in
+@code{org-agenda-span}.
@c
-@kindex f
-@item f
-@vindex org-agenda-ndays
-Go forward in time to display the following @code{org-agenda-ndays} days.
+@orgcmd{f,org-agenda-later}
+Go forward in time to display the following @code{org-agenda-current-span} 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.
+With prefix arg, go forward that many times @code{org-agenda-current-span} days.
@c
-@kindex b
-@item b
+@orgcmd{b,org-agenda-earlier}
Go backward in time to display earlier dates.
@c
-@kindex .
-@item .
+@orgcmd{.,org-agenda-goto-today}
Go to today.
@c
-@kindex j
-@item j
+@orgcmd{j,org-agenda-goto-date}
Prompt for a date and go there.
@c
-@kindex D
-@item D
+@orgcmd{J,org-agenda-clock-goto}
+Go to the currently clocked-in task @i{in the agenda buffer}.
+@c
+@orgcmd{D,org-agenda-toggle-diary}
Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}.
@c
-@kindex v l
-@kindex l
-@item v l @ @r{or short} @ l
+@orgcmdkskc{v l,l,org-agenda-log-mode}
+@kindex v L
@vindex org-log-done
@vindex org-agenda-log-mode-items
Toggle Logbook mode. In Logbook mode, entries that were marked DONE while
@code{org-agenda-log-mode-items}. When called with a @kbd{C-u} prefix, show
all possible logbook entries, including state changes. When called with two
prefix args @kbd{C-u C-u}, show only logging information, nothing else.
+@kbd{v L} is equivalent to @kbd{C-u v l}.
@c
-@kindex v [
-@kindex [
-@item v [ @ @r{or short} @ [
+@orgcmdkskc{v [,[,org-agenda-manipulate-query-add}
Include inactive timestamps into the current view. Only for weekly/daily
agenda and timeline views.
@c
-@kindex v a
-@kindex v A
-@item v a
-@itemx v A
+@orgcmd{v a,org-agenda-archives-mode}
+@xorgcmd{v A,org-agenda-archives-mode 'files}
Toggle Archives mode. In Archives mode, trees that are marked
@code{ARCHIVED} are also scanned when producing the agenda. When you use the
capital @kbd{A}, even all archive files are included. To exit archives mode,
press @kbd{v a} again.
@c
-@kindex v R
-@kindex R
-@item v R @ @r{or short} @ R
+@orgcmdkskc{v R,R,org-agenda-clockreport-mode}
@vindex org-agenda-start-with-clockreport-mode
Toggle Clockreport mode. In Clockreport mode, the daily/weekly agenda will
always show a table with the clocked times for the timespan and file scope
covered by the current agenda view. The initial setting for this mode in new
agenda buffers can be set with the variable
-@code{org-agenda-start-with-clockreport-mode}.
+@code{org-agenda-start-with-clockreport-mode}. By using a prefix argument
+when toggling this mode (i.e.@: @kbd{C-u R}), the clock table will not show
+contributions from entries that are hidden by agenda filtering@footnote{Only
+tags filtering will be respected here, effort filtering is ignored.}.
+@c
+@orgkey{v c}
+@vindex org-agenda-clock-consistency-checks
+Show overlapping clock entries, clocking gaps, and other clocking problems in
+the current agenda range. You can then visit clocking lines and fix them
+manually. See the variable @code{org-agenda-clock-consistency-checks} for
+information on how to customize the definition of what constituted a clocking
+problem. To return to normal agenda display, press @kbd{l} to exit Logbook
+mode.
@c
-@kindex v E
-@kindex E
-@item v E @ @r{or short} @ E
+@orgcmdkskc{v E,E,org-agenda-entry-text-mode}
@vindex org-agenda-start-with-entry-text-mode
@vindex org-agenda-entry-text-maxlines
Toggle entry text mode. In entry text mode, a number of lines from the Org
@code{org-agenda-entry-text-maxlines}. Calling this command with a numeric
prefix argument will temporarily modify that number to the prefix value.
@c
-@kindex G
-@item G
+@orgcmd{G,org-agenda-toggle-time-grid}
@vindex org-agenda-use-time-grid
@vindex org-agenda-time-grid
Toggle the time grid on and off. See also the variables
@code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
@c
-@kindex r
-@item r
+@orgcmd{r,org-agenda-redo}
Recreate the agenda buffer, for example to reflect the changes after
modification of the timestamps of items with @kbd{S-@key{left}} and
@kbd{S-@key{right}}. When the buffer is the global TODO list, a prefix
argument is interpreted to create a selective list for a specific TODO
keyword.
-@kindex g
-@item g
+@orgcmd{g,org-agenda-redo}
Same as @kbd{r}.
@c
-@kindex s
-@kindex C-x C-s
-@item s
-@itemx C-x C-s
+@orgcmdkskc{C-x C-s,s,org-save-all-org-buffers}
Save all Org buffers in the current Emacs session, and also the locations of
IDs.
@c
-@kindex C-c C-x C-c
-@item C-c C-x C-c
+@orgcmd{C-c C-x C-c,org-agenda-columns}
@vindex org-columns-default-format
Invoke column view (@pxref{Column view}) in the agenda buffer. The column
view format is taken from the entry at point, or (if there is no entry at
@code{#+COLUMNS} line, or from the default variable
@code{org-columns-default-format}), will be used in the agenda.
-@kindex C-c C-x >
-@item C-c C-x >
+@orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
Remove the restriction lock on the agenda, if it is currently restricted to a
file or subtree (@pxref{Agenda files}).
@cindex effort filtering, in agenda
@cindex query editing, in agenda
-@kindex /
-@item /
+@orgcmd{/,org-agenda-filter-by-tag}
@vindex org-agenda-filter-preset
Filter the current agenda view with respect to a tag and/or effort estimates.
The difference between this and a custom agenda command is that filtering is
very fast, so that you can switch quickly between different filters without
-having to recreate the agenda@footnote{Custom commands can preset a filter by
+having to recreate the agenda.@footnote{Custom commands can preset a filter by
binding the variable @code{org-agenda-filter-preset} as an option. This
filter will then be applied to the view and persist as a basic filter through
-refreshes and more secondary filtering.}
+refreshes and more secondary filtering. The filter is a global property of
+the entire agenda view---in a block agenda, you should only set this in the
+global options section, not in the section of an individual block.}
-You will be prompted for a tag selection letter, SPC will mean any tag at
+You will be prompted for a tag selection letter; @key{SPC} will mean any tag at
all. Pressing @key{TAB} at that prompt will offer use completion to select a
tag (including any tags that do not have a selection character). The command
then hides all entries that do not contain or inherit this tag. When called
immediately use the @kbd{\} command.
@vindex org-sort-agenda-noeffort-is-high
-In order to filter for effort estimates, you should set-up allowed
+In order to filter for effort estimates, you should set up allowed
efforts globally, for example
@lisp
(setq org-global-properties
@end group
@end lisp
-@kindex \
-@item \
+@orgcmd{\\,org-agenda-filter-by-tag-refine}
Narrow the current agenda filter by an additional condition. When called with
prefix arg, remove the entries that @emph{do} have the tag, or that do match
the effort criterion. You can achieve the same effect by pressing @kbd{+} or
@kbd{-} as the first key after the @kbd{/} command.
+@c
@kindex [
@kindex ]
@kindex @{
selected.
@end table
-@page
@tsubheading{Remote editing}
@cindex remote editing, from agenda
@c
@cindex undoing remote-editing events
@cindex remote editing, undo
-@kindex C-_
-@item C-_
+@orgcmd{C-_,org-agenda-undo}
Undo a change due to a remote editing command. The change is undone
both in the agenda buffer and in the remote buffer.
@c
-@kindex t
-@item t
+@orgcmd{t,org-agenda-todo}
Change the TODO state of the item, both in the agenda and in the
original org file.
@c
-@kindex C-S-@key{right}
-@kindex C-S-@key{left}
-@item C-S-@key{right}@r{/}@key{left}
+@orgcmd{C-S-@key{right},org-agenda-todo-nextset}
+@orgcmd{C-S-@key{left},org-agenda-todo-previousset}
Switch to the next/previous set of TODO keywords.
@c
-@kindex C-k
-@item C-k
+@orgcmd{C-k,org-agenda-kill}
@vindex org-agenda-confirm-kill
Delete the current agenda item along with the entire subtree belonging
to it in the original Org 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}.
@c
-@kindex C-c C-w
-@item C-c C-w
+@orgcmd{C-c C-w,org-agenda-refile}
Refile the entry at point.
@c
-@kindex C-c C-x C-a
-@kindex a
-@item C-c C-x C-a @ @r{or short} @ a
+@orgcmdkskc{C-c C-x C-a,a,org-agenda-archive-default-with-confirmation}
@vindex org-archive-default-command
Archive the subtree corresponding to the entry at point using the default
archiving command set in @code{org-archive-default-command}. When using the
@code{a} key, confirmation will be required.
@c
-@kindex C-c C-x a
-@item C-c C-x a
+@orgcmd{C-c C-x a,org-agenda-toggle-archive-tag}
Toggle the ARCHIVE tag for the current headline.
@c
-@kindex C-c C-x A
-@item C-c C-x A
+@orgcmd{C-c C-x A,org-agenda-archive-to-archive-sibling}
Move the subtree corresponding to the current entry to its @emph{archive
sibling}.
@c
-@kindex $
-@kindex C-c C-x C-s
-@item C-c C-x C-s @ @r{or short} @ $
+@orgcmdkskc{C-c C-x C-s,$,org-agenda-archive}
Archive the subtree corresponding to the current headline. This means the
entry will be moved to the configured archive location, most likely a
different file.
@c
-@kindex T
-@item T
+@orgcmd{T,org-agenda-show-tags}
@vindex org-agenda-show-inherited-tags
Show all tags associated with the current item. This is useful if you have
turned off @code{org-agenda-show-inherited-tags}, but still want to see all
tags of a headline occasionally.
@c
-@kindex :
-@item :
+@orgcmd{:,org-agenda-set-tags}
Set tags for the current headline. If there is an active region in the
agenda, change a tag for all headings in the region.
@c
@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.
+Set the priority for the current item (@command{org-agenda-priority}).
+Org-mode prompts for the priority character. If you reply with @key{SPC},
+the priority cookie is removed from the entry.
@c
-@kindex P
-@item P
+@orgcmd{P,org-agenda-show-priority}
Display weighted priority of current item.
@c
-@kindex +
-@kindex S-@key{up}
-@item +
-@itemx S-@key{up}
+@orgcmdkkc{+,S-@key{up},org-agenda-priority-up}
Increase the priority of the current item. The priority is changed in
the original buffer, but the agenda is not resorted. Use the @kbd{r}
key for this.
@c
-@kindex -
-@kindex S-@key{down}
-@item -
-@itemx S-@key{down}
+@orgcmdkkc{-,S-@key{down},org-agenda-priority-down}
Decrease the priority of the current item.
@c
-@kindex z
-@item z
+@orgcmdkkc{z,C-c C-z,org-agenda-add-note}
@vindex org-log-into-drawer
-Add a note to the entry. This note will be recorded, and then files to the
+Add a note to the entry. This note will be recorded, and then filed to the
same location where state change notes are put. Depending on
-@code{org-log-into-drawer}, this maybe inside a drawer.
+@code{org-log-into-drawer}, this may be inside a drawer.
@c
-@kindex C-c C-a
-@item C-c C-a
+@orgcmd{C-c C-a,org-attach}
Dispatcher for all command related to attachments.
@c
-@kindex C-c C-s
-@item C-c C-s
-Schedule this item
+@orgcmd{C-c C-s,org-agenda-schedule}
+Schedule this item. With prefix arg remove the scheduling timestamp
@c
-@kindex C-c C-d
-@item C-c C-d
-Set a deadline for this item.
+@orgcmd{C-c C-d,org-agenda-deadline}
+Set a deadline for this item. With prefix arg remove the deadline.
@c
-@kindex k
-@item k
+@orgcmd{k,org-agenda-action}
Agenda actions, to set dates for selected items to the cursor date.
This command also works in the calendar! The command prompts for an
additional key:
@r{in Org files with @kbd{C-c C-x C-k}.}
d @r{Set the deadline of the marked entry to the date at point.}
s @r{Schedule the marked entry at the date at point.}
-r @r{Call @code{org-remember} with the cursor date as default date.}
+r @r{Call @code{org-capture} with the cursor date as default date.}
@end example
@noindent
Press @kbd{r} afterward to refresh the agenda and see the effect of the
command.
@c
-@kindex S-@key{right}
-@item S-@key{right}
+@orgcmd{S-@key{right},org-agenda-do-date-later}
Change the timestamp associated with the current line by one day into the
future. With a numeric prefix argument, change it by that many days. For
example, @kbd{3 6 5 S-@key{right}} will change it by a year. With a
is changed in the original Org file, but the change is not directly reflected
in the agenda buffer. Use @kbd{r} or @kbd{g} to update the buffer.
@c
-@kindex S-@key{left}
-@item S-@key{left}
+@orgcmd{S-@key{left},org-agenda-do-date-earlier}
Change the timestamp associated with the current line by one day
into the past.
@c
-@kindex >
-@item >
-Change the timestamp associated with the current line to today.
-The key @kbd{>} has been chosen, because it is the same as @kbd{S-.}
-on my keyboard.
+@orgcmd{>,org-agenda-date-prompt}
+Change the timestamp associated with the current line. The key @kbd{>} has
+been chosen, because it is the same as @kbd{S-.} on my keyboard.
@c
-@kindex I
-@item I
+@orgcmd{I,org-agenda-clock-in}
Start the clock on the current item. If a clock is running already, it
is stopped first.
@c
-@kindex O
-@item O
+@orgcmd{O,org-agenda-clock-out}
Stop the previously started clock.
@c
-@kindex X
-@item X
+@orgcmd{X,org-agenda-clock-cancel}
Cancel the currently running clock.
-
-@kindex J
-@item J
+@c
+@orgcmd{J,org-agenda-clock-goto}
Jump to the running clock in another window.
@tsubheading{Bulk remote editing selected entries}
@cindex remote editing, bulk, from agenda
-@kindex m
-@item s
-Mark the entry at point for bulk action.
-
-@kindex u
-@item u
+@orgcmd{m,org-agenda-bulk-mark}
+Mark the entry at point for bulk action. With prefix arg, mark that many
+successive entries.
+@c
+@orgcmd{%,org-agenda-bulk-mark-regexp}
+Mark entries matching a regular expression for bulk action.
+@c
+@orgcmd{u,org-agenda-bulk-unmark}
Unmark entry for bulk action.
-
-@kindex U
-@item U
+@c
+@orgcmd{U,org-agenda-bulk-remove-all-marks}
Unmark all marked entries for bulk action.
-
-@kindex B
-@item B
+@c
+@orgcmd{B,org-agenda-bulk-action}
Bulk action: act on all marked entries in the agenda. This will prompt for
-another key to select the action to be applied:
+another key to select the action to be applied. The prefix arg to @kbd{B}
+will be passed through to the @kbd{s} and @kbd{d} commands, to bulk-remove
+these special timestamps.
@example
r @r{Prompt for a single refile target and move all entries. The entries}
- @r{will no longer be in the agenda, refresh (@kbd{g}) to bring them back.}
+ @r{will no longer be in the agenda; refresh (@kbd{g}) to bring them back.}
$ @r{Archive all selected entries.}
A @r{Archive entries by moving them to their respective archive siblings.}
t @r{Change TODO state. This prompts for a single TODO keyword and}
@r{changes the state of all selected entries, bypassing blocking and}
- @r{suppressing logging notes (but not time stamps).}
+ @r{suppressing logging notes (but not timestamps).}
+ @r{Add a tag to all selected entries.}
- @r{Remove a tag from all selected entries.}
s @r{Schedule all items to a new date. To shift existing schedule dates}
@r{by a fixed number of days, use something starting with double plus}
@r{at the prompt, for example @samp{++8d} or @samp{++2w}.}
+S @r{Reschedule randomly into the coming N days. N will be prompted for.}
+ @r{With prefix arg (@kbd{C-u B S}), scatter only across weekdays.}
d @r{Set deadline to a specific date.}
+f @r{Apply a function to marked entries.}
+ @r{For example, the function below sets the CATEGORY property of the}
+ @r{entries to web.}
+ @r{(defun set-category ()}
+ @r{ (interactive "P")}
+ @r{ (let* ((marker (or (org-get-at-bol 'org-hd-marker)}
+ @r{ (org-agenda-error)))}
+ @r{ (buffer (marker-buffer marker)))}
+ @r{ (with-current-buffer buffer}
+ @r{ (save-excursion}
+ @r{ (save-restriction}
+ @r{ (widen)}
+ @r{ (goto-char marker)}
+ @r{ (org-back-to-heading t)}
+ @r{ (org-set-property "CATEGORY" "web"))))))}
@end example
@tsubheading{Calendar commands}
@cindex calendar commands, from agenda
-@kindex c
-@item c
+
+@orgcmd{c,org-agenda-goto-calendar}
Open the Emacs calendar and move to the date at the agenda cursor.
@c
-@item c
-When in the calendar, compute and show the Org mode agenda for the
+@orgcmd{c,org-calendar-goto-agenda}
+When in the calendar, compute and show the Org-mode agenda for the
date at the cursor.
@c
@cindex diary entries, creating from agenda
-@kindex i
-@item i
+@orgcmd{i,org-agenda-diary-entry}
@vindex org-agenda-diary-file
Insert a new entry into the diary, using the date at the cursor and (for
block entries) the date at the mark. This will add to the Emacs diary
Org will create entries (in org-mode syntax) in that file instead. Most
entries will be stored in a date-based outline tree that will later make it
easy to archive appointments from previous months/years. The tree will be
-build under an entry with a @code{DATE_TREE} property, or else with years as
-top-level entries. Emacs will prompt you for the entry text - if you specify
+built under an entry with a @code{DATE_TREE} property, or else with years as
+top-level entries. Emacs will prompt you for the entry text---if you specify
it, the entry will be created in @code{org-agenda-diary-file} without further
interaction. If you directly press @key{RET} at the prompt without typing
text, the target file will be shown in another window for you to finish the
entry there. See also the @kbd{k r} command.
@c
-@kindex M
-@item M
+@orgcmd{M,org-agenda-phases-of-moon}
Show the phases of the moon for the three months around current date.
@c
-@kindex S
-@item S
+@orgcmd{S,org-agenda-sunrise-sunset}
Show sunrise and sunset times. The geographical location must be set
with calendar variables, see the documentation for the Emacs calendar.
@c
-@kindex C
-@item C
+@orgcmd{C,org-agenda-convert-date}
Convert the date at cursor into many other cultural and historic
calendars.
@c
-@kindex H
-@item H
+@orgcmd{H,org-agenda-holidays}
Show holidays for three months around the cursor date.
@item M-x org-export-icalendar-combine-agenda-files
This is a globally available command, and also available in the agenda menu.
@tsubheading{Exporting to a file}
-@kindex C-x C-w
-@item C-x C-w
+@orgcmd{C-x C-w,org-write-agenda}
@cindex exporting agenda views
@cindex agenda views, exporting
@vindex org-agenda-exporter-settings
Write the agenda view to a file. Depending on the extension of the selected
file name, the view will be exported as HTML (extension @file{.html} or
-@file{.htm}), Postscript (extension @file{.ps}), PDF (extension @file{.pdf}),
+@file{.htm}), PostScript (extension @file{.ps}), PDF (extension @file{.pdf}),
and plain text (any other extension). When called with a @kbd{C-u} prefix
argument, immediately open the newly created file. Use the variable
@code{org-agenda-exporter-settings} to set options for @file{ps-print} and
for @file{htmlize} to be used during export.
@tsubheading{Quit and Exit}
-@kindex q
-@item q
+@orgcmd{q,org-agenda-quit}
Quit agenda, remove the agenda buffer.
@c
-@kindex x
@cindex agenda files, removing buffers
-@item x
+@orgcmd{x,org-agenda-exit}
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.
@cindex options, for custom agenda views
@vindex org-agenda-custom-commands
-Org mode contains a number of variables regulating agenda construction
+Org-mode contains a number of variables regulating agenda construction
and display. The global variables define the behavior for all agenda
commands, including the custom commands. However, if you want to change
some settings just for a single custom view, you can do so. Setting
@code{org-agenda-custom-commands} has two separate spots for setting
options. You can add options that should be valid for just a single
command in the set, and options that should be valid for all commands in
-the set. The former are just added to the command entry, the latter
+the set. The former are just added to the command entry; the latter
must come after the list of command entries. Going back to the block
agenda example (@pxref{Block agenda}), let's change the sorting strategy
for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
@cindex 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
+version of some agenda views to carry around. Org-mode can export custom
agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's
-@file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the
+@file{htmlize.el}.}, PostScript, PDF@footnote{To create PDF output, the
ghostscript @file{ps2pdf} utility must be installed on the system. Selecting
-a PDF file with also create the postscript file.}, and iCalendar files. If
+a PDF file will also create the PostScript file.}, and iCalendar files. If
you want to do this only occasionally, use the command
@table @kbd
-@kindex C-x C-w
-@item C-x C-w
+@orgcmd{C-x C-w,org-write-agenda}
@cindex exporting agenda views
@cindex agenda views, exporting
@vindex org-agenda-exporter-settings
Write the agenda view to a file. Depending on the extension of the selected
file name, the view will be exported as HTML (extension @file{.html} or
-@file{.htm}), Postscript (extension @file{.ps}), iCalendar (extension
+@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
@end lisp
The extension of the file name determines the type of export. If it is
-@file{.html}, Org mode will use the @file{htmlize.el} package to convert
+@file{.html}, 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
@file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
-Postscript output. If the extension is @file{.ics}, iCalendar export is
+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. Any other
extension produces a plain ASCII file.
files in one step:
@table @kbd
-@kindex C-c a e
-@item C-c a e
+@orgcmd{C-c a e,org-store-agenda-views}
Export all agenda views that have export file names associated with
them.
@end table
@end lisp
@noindent
-This command sets two options for the Postscript exporter, to make it
+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
system you use, please check the FAQ for examples.}
@example
emacs -eval '(org-batch-store-agenda-views \
- org-agenda-ndays 30 \
+ org-agenda-span month \
org-agenda-start-day "2007-11-01" \
org-agenda-include-diary nil \
org-agenda-files (quote ("~/org/project.org")))' \
collected by certain criteria.
@table @kbd
-@kindex C-c C-x C-c
-@item C-c C-x C-c
+@orgcmd{C-c C-x C-c,org-agenda-columns}
Turn on column view in the agenda.
@end table
Org needs to make a decision which @code{COLUMNS} format to use. Since the
entries in the agenda are collected from different files, and different files
may have different @code{COLUMNS} formats, this is a non-trivial problem.
-Org first checks if the variable @code{org-overriding-columns-format} is
+Org first checks if the variable @code{org-agenda-overriding-columns-format} is
currently set, and if so, takes the format from there. Otherwise it takes
the format associated with the first item in the agenda, or, if that item
does not have a specific format (defined in a property, or in its file), it
make sure that the computations of this property are up to date. This is
also true for the special @code{CLOCKSUM} property. Org will then sum the
values displayed in the agenda. In the daily/weekly agenda, the sums will
-cover a single day, in all other views they cover the entire block. It is
+cover a single day; in all other views they cover the entire block. It is
vital to realize that the agenda may show the same entry @emph{twice} (for
example as scheduled and as a deadline), and it may show two entries from the
same hierarchy (for example a @emph{parent} and its @emph{child}). In these
When exporting Org-mode documents, the exporter tries to reflect the
structure of the document as accurately as possible in the backend. Since
-export targets like HTML, La@TeX{}, or DocBook allow much richer formatting,
-Org mode has rules on how to prepare text for rich export. This section
+export targets like HTML, @LaTeX{}, or DocBook allow much richer formatting,
+Org-mode has rules on how to prepare text for rich export. This section
summarizes the markup rules used in an Org-mode buffer.
@menu
* Images and tables:: Tables and Images will be included
* Literal examples:: Source code examples with special formatting
* Include files:: Include additional files into a document
+* Index entries:: Making an index
* Macro replacement:: Use macros to create complex output
* Embedded LaTeX:: LaTeX can be freely used inside Org documents
@end menu
@cindex text before first headline, markup rules
@cindex #+TEXT
-Org mode normally exports the text before the first headline, and even uses
+Org-mode normally exports the text before the first headline, and even uses
the first line as the document title. The text will be fully marked up. If
-you need to include literal HTML, La@TeX{}, or DocBook code, use the special
+you need to include literal HTML, @LaTeX{}, or DocBook code, use the special
constructs described below in the sections for the individual exporters.
@vindex org-export-skip-text-before-1st-heading
#+OPTIONS: skip:t
#+TEXT: This text will go before the *first* headline.
#+TEXT: [TABLE-OF-CONTENTS]
-#+TEXT: This goes between the table of contents and the first headline
+#+TEXT: This goes between the table of contents and the *first* headline
@end example
@node Lists, Paragraphs, Initial text, Structural markup elements
@cindex footnotes, markup rules
@cindex @file{footnote.el}
-Footnotes defined in the way described in @ref{Footnotes}, will be exported by
-all backends. Org allows multiple references to the same note, and
-different backends support this to varying degrees.
+Footnotes defined in the way described in @ref{Footnotes}, will be exported
+by all backends. Org allows multiple references to the same note, and
+multiple footnotes side by side.
@node Emphasis and monospace, Horizontal rules, Footnote markup, Structural markup elements
@subheading Emphasis and monospace
You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=}
and @code{~verbatim~}, and, if you must, @samp{+strike-through+}. Text
in the code and verbatim string is not processed for Org-mode specific
-syntax, it is exported verbatim.
+syntax; it is exported verbatim.
@node Horizontal rules, Comment lines, Emphasis and monospace, Structural markup elements
@subheading Horizontal rules
@cindex horizontal rules, markup rules
-A line consisting of only dashes, and at least 5 of them, will be
-exported as a horizontal line (@samp{<hr/>} in HTML).
+A line consisting of only dashes, and at least 5 of them, will be exported as
+a horizontal line (@samp{<hr/>} in HTML and @code{\hrule} in @LaTeX{}).
@node Comment lines, , Horizontal rules, Structural markup elements
@subheading Comment lines
@cindex #+BEGIN_COMMENT
Lines starting with @samp{#} in column zero are treated as comments and will
-never be exported. If you want an indented line to be treated as a comment,
+never be exported. If you want an indented line to be treated as a comment,
start it with @samp{#+ }. Also entire subtrees starting with the word
@samp{COMMENT} will never be exported. Finally, regions surrounded by
@samp{#+BEGIN_COMMENT} ... @samp{#+END_COMMENT} will not be exported.
@cindex tables, markup rules
@cindex #+CAPTION
@cindex #+LABEL
-Both the native Org mode tables (@pxref{Tables}) and tables formatted with
-the @file{table.el} package will be exported properly. For Org mode tables,
+Both the native Org-mode tables (@pxref{Tables}) and tables formatted with
+the @file{table.el} package will be exported properly. For Org-mode tables,
the lines before the first horizontal separator line will become table header
lines. You can use the following lines somewhere before the table to assign
-a caption and a label for cross references:
+a caption and a label for cross references, and in the text you can refer to
+the object with @code{\ref@{tab:basic-data@}}:
@example
#+CAPTION: This is the caption for the next table (or link)
|-----|----|
@end example
+Optionally, the caption can take the form:
+@example
+#+CAPTION: [Caption for list of figures]@{Caption for table (or link).@}
+@end example
+
@cindex inlined images, markup rules
-Some backends (HTML, La@TeX{}, and DocBook) allow you to directly include
+Some backends (HTML, @LaTeX{}, and DocBook) allow you to directly include
images into the exported document. Org does this, if a link to an image
files does not have a description part, for example @code{[[./img/a.jpg]]}.
If you wish to define a caption for the image and maybe a label for internal
-cross references, you sure that the link is on a line by itself precede it
-with:
+cross references, make sure that the link is on a line by itself and precede
+it with @code{#+CAPTION} and @code{#+LABEL} as follows:
@example
#+CAPTION: This is the caption for the next figure link (or table)
backend-specific, see the sections about the individual backends for more
information.
+@xref{Handling links,the discussion of image links}.
@node Literal examples, Include files, Images and tables, Markup
@section Literal examples
@cindex formatting source code, markup rules
If the example is source code from a programming language, or any other text
that can be marked up by font-lock in Emacs, you can ask for the example to
-look like the fontified Emacs buffer@footnote{Currently this works for the
-HTML backend, and requires the @file{htmlize.el} package version 1.34 or
-later. It also works for LaTeX with the listings package, if you turn on the
-option @code{org-export-latex-listings} and make sure that the listings
-package is included by the LaTeX header.}. This is done with the @samp{src}
-block, where you also need to specify the name of the major mode that should
-be used to fontify the example:
+look like the fontified Emacs buffer@footnote{This works automatically for
+the HTML backend (it requires version 1.34 of the @file{htmlize.el} package,
+which is distributed with Org). Fontified code chunks in LaTeX can be
+achieved using either the listings or the
+@url{http://code.google.com/p/minted, minted,} package. To use listings, turn
+on the variable @code{org-export-latex-listings} and ensure that the listings
+package is included by the LaTeX header (e.g.@: by configuring
+@code{org-export-latex-packages-alist}). See the listings documentation for
+configuration options, including obtaining colored output. For minted it is
+necessary to install the program @url{http://pygments.org, pygments}, in
+addition to setting @code{org-export-latex-minted}, ensuring that the minted
+package is included by the LaTeX header, and ensuring that the
+@code{-shell-escape} option is passed to @file{pdflatex} (see
+@code{org-latex-to-pdf-process}). See the documentation of the variables
+@code{org-export-latex-listings} and @code{org-export-latex-minted} for
+further details.}. This is done with the @samp{src} block, where you also
+need to specify the name of the major mode that should be used to fontify the
+example@footnote{Code in @samp{src} blocks may also be evaluated either
+interactively or on export. See @pxref{Working With Source Code} for more
+information on evaluating code blocks.}:
@cindex #+BEGIN_SRC
@example
#+BEGIN_SRC emacs-lisp
-(defun org-xor (a b)
- "Exclusive or."
- (if a (not b) b))
+ (defun org-xor (a b)
+ "Exclusive or."
+ (if a (not b) b))
#+END_SRC
@end example
numbered. If you use a @code{+n} switch, the numbering from the previous
numbered snippet will be continued in the current one. In literal examples,
Org will interpret strings like @samp{(ref:name)} as labels, and use them as
-targets for special hyperlinks like @code{[[(name)]]} (i.e. the reference name
+targets for special hyperlinks like @code{[[(name)]]} (i.e.@: the reference name
enclosed in single parenthesis). In HTML, hovering the mouse over such a
link will remote-highlight the corresponding code line, which is kind of
cool.
@code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
-n -r -l "((%s))"}. See also the variable @code{org-coderef-label-format}.
-HTML export also allows examples to be published as text areas, @xref{Text
-areas in HTML export}.
+HTML export also allows examples to be published as text areas (@pxref{Text
+areas in HTML export}).
+
+Because the @code{#+BEGIN_...} and @code{#+END_...} patterns need to be added
+so often, shortcuts are provided using the Easy Templates facility
+(@pxref{Easy Templates}).
@table @kbd
@kindex C-c '
switching to a temporary buffer with the source code. You need to exit by
pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*}
or @samp{#} will get a comma prepended, to keep them from being interpreted
-by Org as outline nodes or special comments. These commas will be striped
-for editing with @kbd{C-c '}, and also for export.}, the edited version will
+by Org as outline nodes or special comments. These commas will be stripped
+for editing with @kbd{C-c '}, and also for export.}. The edited version will
then replace the old version in the Org buffer. Fixed-width regions
(where each line starts with a colon followed by a space) will be edited
using @code{artist-mode}@footnote{You may select a different-mode with the
@kindex C-c l
@item C-c l
Calling @code{org-store-link} while editing a source code example in a
-temporary buffer created with @kbd{C-c '} will prompt for a label, make sure
+temporary buffer created with @kbd{C-c '} will prompt for a label. Make sure
that it is unique in the current buffer, and insert it with the proper
formatting like @samp{(ref:label)} at the end of the current line. Then the
label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
@end table
-@node Include files, Macro replacement, Literal examples, Markup
+@node Include files, Index entries, Literal examples, Markup
@section Include files
@cindex include files, markup rules
#+INCLUDE: "~/.emacs" src emacs-lisp
@end example
@noindent
-The optional second and third parameter are the markup (e.g. @samp{quote},
+The optional second and third parameter are the markup (e.g.@: @samp{quote},
@samp{example}, or @samp{src}), and, if the markup is @samp{src}, the
-language for formatting the contents. The markup is optional, if it is not
-given, the text will be assumed to be in Org mode format and will be
+language for formatting the contents. The markup is optional; if it is not
+given, the text will be assumed to be in Org-mode format and will be
processed normally. The include line will also allow additional keyword
parameters @code{:prefix1} and @code{:prefix} to specify prefixes for the
-first line and for each following line, as well as any options accepted by
-the selected markup. For example, to include a file as an item, use
+first line and for each following line, @code{:minlevel} in order to get
+org-mode content demoted to a specified level, as well as any options
+accepted by the selected markup. For example, to include a file as an item,
+use
@example
#+INCLUDE: "~/snippets/xx" :prefix1 " + " :prefix " "
@end example
+You can also include a portion of a file by specifying a lines range using
+the @code{:lines} parameter. The line at the upper end of the range will not
+be included. The start and/or the end of the range may be omitted to use the
+obvious defaults.
+
+@example
+#+INCLUDE: "~/.emacs" :lines "5-10" @r{Include lines 5 to 10, 10 excluded}
+#+INCLUDE: "~/.emacs" :lines "-10" @r{Include lines 1 to 10, 10 excluded}
+#+INCLUDE: "~/.emacs" :lines "10-" @r{Include lines from 10 to EOF}
+@end example
+
@table @kbd
@kindex C-c '
@item C-c '
Visit the include file at point.
@end table
+@node Index entries, Macro replacement, Include files, Markup
+@section Index entries
+@cindex index entries, for publishing
+
+You can specify entries that will be used for generating an index during
+publishing. This is done by lines starting with @code{#+INDEX}. An entry
+the contains an exclamation mark will create a sub item. See @ref{Generating
+an index} for more information.
+
+@example
+* Curriculum Vitae
+#+INDEX: CV
+#+INDEX: Application!CV
+@end example
+
+
+
-@node Macro replacement, Embedded LaTeX, Include files, Markup
+@node Macro replacement, Embedded LaTeX, Index entries, Markup
@section Macro replacement
@cindex macro replacement, during export
@cindex #+MACRO
@node Embedded LaTeX, , Macro replacement, Markup
-@section Embedded La@TeX{}
+@section Embedded @LaTeX{}
@cindex @TeX{} interpretation
-@cindex La@TeX{} interpretation
-
-Plain ASCII is normally sufficient for almost all note taking. One
-exception, however, are scientific notes which need to be able to contain
-mathematical symbols and the occasional formula. La@TeX{}@footnote{La@TeX{}
-is a macro system based on Donald E. Knuth's @TeX{} system. Many of the
-features described here as ``La@TeX{}'' are really from @TeX{}, but for
-simplicity I am blurring this distinction.} is widely used to typeset
-scientific documents. Org mode supports embedding La@TeX{} code into its
-files, because many academics are used to reading La@TeX{} source code, and
-because it can be readily processed into images for HTML production.
-
-It is not necessary to mark La@TeX{} macros and code in any special way.
-If you observe a few conventions, Org mode knows how to find it and what
-to do with it.
+@cindex @LaTeX{} interpretation
+
+Plain ASCII is normally sufficient for almost all note taking. Exceptions
+include scientific notes, which often require mathematical symbols and the
+occasional formula. @LaTeX{}@footnote{@LaTeX{} is a macro system based on
+Donald E. Knuth's @TeX{} system. Many of the features described here as
+``@LaTeX{}'' are really from @TeX{}, but for simplicity I am blurring this
+distinction.} is widely used to typeset scientific documents. Org-mode
+supports embedding @LaTeX{} code into its files, because many academics are
+used to writing and reading @LaTeX{} source code, and because it can be
+readily processed to produce pretty output for a number of export backends.
@menu
* Special symbols:: Greek letters and other symbols
@cindex math symbols
@cindex special symbols
@cindex @TeX{} macros
-@cindex La@TeX{} fragments, markup rules
+@cindex @LaTeX{} fragments, markup rules
@cindex HTML entities
-@cindex La@TeX{} entities
+@cindex @LaTeX{} entities
-You can use La@TeX{} macros to insert special symbols like @samp{\alpha} to
+You can use @LaTeX{} macros to insert special symbols like @samp{\alpha} to
indicate the Greek letter, or @samp{\to} to indicate an arrow. Completion
for these macros is available, just type @samp{\} and maybe a few letters,
-and press @kbd{M-@key{TAB}} to see possible completions. Unlike La@TeX{}
-code, Org mode allows these macros to be present without surrounding math
+and press @kbd{M-@key{TAB}} to see possible completions. Unlike @LaTeX{}
+code, Org-mode allows these macros to be present without surrounding math
delimiters, for example:
@example
Angles are written as Greek letters \alpha, \beta and \gamma.
@end example
-@vindex org-html-entities
+@vindex org-entities
During export, these symbols will be transformed into the native format of
the exporter backend. Strings like @code{\alpha} will be exported as
-@code{α} in the HTML output, and as @code{$\alpha$} in the La@TeX{}
+@code{α} in the HTML output, and as @code{$\alpha$} in the @LaTeX{}
output. Similarly, @code{\nbsp} will become @code{ } in HTML and
-@code{~} in La@TeX{}. If you need such a symbol inside a word, terminate it
+@code{~} in @LaTeX{}. If you need such a symbol inside a word, terminate it
like this: @samp{\Aacute@{@}stor}.
A large number of entities is provided, with names taken from both HTML and
-La@TeX{}, see the variable @code{org-html-entities} for the complete list.
+@LaTeX{}; see the variable @code{org-entities} for the complete list.
@samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
@samp{...} are all converted into special commands creating hyphens of
different lengths or a compact set of dots.
+If you would like to see entities displayed as UTF8 characters, use the
+following command@footnote{You can turn this on by default by setting the
+variable @code{org-pretty-entities}, or on a per-file base with the
+@code{#+STARTUP} option @code{entitiespretty}.}:
+
+@table @kbd
+@kindex C-c C-x \
+@item C-c C-x \
+Toggle display of entities as UTF-8 characters. This does not change the
+buffer content which remains plain ASCII, but it overlays the UTF-8 character
+for display purposes only.
+@end table
+
@node Subscripts and superscripts, LaTeX fragments, Special symbols, Embedded LaTeX
@subsection Subscripts and superscripts
@cindex subscript
@cindex superscript
-Just like in La@TeX{}, @samp{^} and @samp{_} are used to indicate super-
+Just like in @LaTeX{}, @samp{^} and @samp{_} are used to indicate super-
and subscripts. Again, these can be used without embedding them in
math-mode delimiters. To increase the readability of ASCII text, it is
not necessary (but OK) to surround multi-character sub- and superscripts
with curly braces. For example
@example
-The mass if the sun is M_sun = 1.989 x 10^30 kg. The radius of
+The mass of the sun is M_sun = 1.989 x 10^30 kg. The radius of
the sun is R_@{sun@} = 6.96 x 10^8 m.
@end example
#+OPTIONS: ^:@{@}
@end example
+@noindent With this setting, @samp{a_b} will not be interpreted as a
+subscript, but @samp{a_@{b@}} will.
+
+@table @kbd
+@kindex C-c C-x \
+@item C-c C-x \
+In addition to showing entities as UTF-8 characters, this command will also
+format sub- and superscripts in a WYSIWYM way.
+@end table
@node LaTeX fragments, Previewing LaTeX fragments, Subscripts and superscripts, Embedded LaTeX
-@subsection La@TeX{} fragments
-@cindex La@TeX{} fragments
+@subsection @LaTeX{} fragments
+@cindex @LaTeX{} fragments
@vindex org-format-latex-header
-With symbols, sub- and superscripts, HTML is pretty much at its end when
-it comes to representing mathematical formulas@footnote{Yes, there is
-MathML, but that is not yet fully supported by many browsers, and there
-is no decent converter for turning La@TeX{} 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 La@TeX{}
-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@footnote{The La@TeX{} export
-will not use images for displaying La@TeX{} fragments but include these
-fragments directly into the La@TeX{} code.}. For this to work you
-need to be on a system with a working La@TeX{} installation. You also
+Going beyond symbols and sub- and superscripts, a full formula language is
+needed. Org-mode can contain @LaTeX{} math fragments, and it supports ways
+to process these for several export backends. When exporting to @LaTeX{},
+the code is obviously left as it is. When exporting to HTML, Org invokes the
+@uref{http://www.mathjax.org, MathJax library} (@pxref{Math formatting in
+HTML export}) to process and display the math@footnote{If you plan to use
+this regularly or on pages with significant page views, you should install
+@file{MathJax} on your own
+server in order to limit the load of our server.}. Finally, it can also
+process the mathematical expressions into images@footnote{For this to work
+you need to be on a system with a working @LaTeX{} installation. You also
need the @file{dvipng} program, available at
-@url{http://sourceforge.net/projects/dvipng/}. The La@TeX{} header that
-will be used when processing a fragment can be configured with the
-variable @code{org-format-latex-header}.
+@url{http://sourceforge.net/projects/dvipng/}. The @LaTeX{} header that will
+be used when processing a fragment can be configured with the variable
+@code{org-format-latex-header}.} that can be displayed in a browser or in
+DocBook documents.
-La@TeX{} fragments don't need any special marking at all. The following
-snippets will be identified as La@TeX{} source code:
+@LaTeX{} fragments don't need any special marking at all. The following
+snippets will be identified as @LaTeX{} source code:
@itemize @bullet
@item
-Environments of any kind. The only requirement is that the
-@code{\begin} statement appears on a new line, preceded by only
-whitespace.
+Environments of any kind@footnote{When @file{MathJax} is used, only the
+environment recognized by @file{MathJax} will be processed. When
+@file{dvipng} is used to create images, any @LaTeX{} environments will be
+handled.}. The only requirement is that the @code{\begin} statement appears
+on a new line, preceded by only whitespace.
@item
-Text within the usual La@TeX{} math delimiters. To avoid conflicts with
+Text within the usual @LaTeX{} math delimiters. To avoid conflicts with
currency specifications, single @samp{$} characters are only recognized as
math delimiters if the enclosed text contains at most two line breaks, is
directly attached to the @samp{$} characters with no whitespace in between,
@vindex org-format-latex-options
If you need any of the delimiter ASCII sequences for other purposes, you
can configure the option @code{org-format-latex-options} to deselect the
-ones you do not wish to have interpreted by the La@TeX{} converter.
+ones you do not wish to have interpreted by the @LaTeX{} converter.
+
+@vindex org-export-with-LaTeX-fragments
+LaTeX processing can be configured with the variable
+@code{org-export-with-LaTeX-fragments}. The default setting is @code{t}
+which means @file{MathJax} for HTML, and no processing for DocBook, ASCII and
+LaTeX backends. You can also set this variable on a per-file basis using one
+of these lines:
+
+@example
+#+OPTIONS: LaTeX:t @r{Do the right thing automatically (MathJax)}
+#+OPTIONS: LaTeX:dvipng @r{Force using dvipng images}
+#+OPTIONS: LaTeX:nil @r{Do not process @LaTeX{} fragments at all}
+#+OPTIONS: LaTeX:verbatim @r{Verbatim export, for jsMath or so}
+@end example
@node Previewing LaTeX fragments, CDLaTeX mode, LaTeX fragments, Embedded LaTeX
@subsection Previewing LaTeX fragments
@cindex LaTeX fragments, preview
-La@TeX{} fragments can be processed to produce preview images of the
-typeset expressions:
+If you have @file{dvipng} installed, @LaTeX{} fragments can be processed to
+produce preview images of the typeset expressions:
@table @kbd
@kindex C-c C-x C-l
@item C-c C-x C-l
-Produce a preview image of the La@TeX{} fragment at point and overlay it
+Produce a preview image of the @LaTeX{} fragment at point and overlay it
over the source code. If there is no fragment at point, process all
fragments in the current entry (between two headlines). When called
with a prefix argument, process the entire subtree. When called with
@vindex org-format-latex-options
You can customize the variable @code{org-format-latex-options} to influence
-some aspects of the preview. In particular, the @code{:scale} (and for HTML
+some aspects of the preview. In particular, the @code{:scale} (and for HTML
export, @code{:html-scale}) property can be used to adjust the size of the
preview images.
-During HTML export (@pxref{HTML export}), all La@TeX{} fragments are
-converted into images and inlined into the document if the following
-setting is active:
-
-@lisp
-(setq org-export-with-LaTeX-fragments t)
-@end lisp
-
@node CDLaTeX mode, , Previewing LaTeX fragments, Embedded LaTeX
@subsection Using CDLa@TeX{} to enter math
@cindex CDLa@TeX{}
CDLa@TeX{} mode is a minor mode that is normally used in combination with a
-major La@TeX{} mode like AUC@TeX{} in order to speed-up insertion of
-environments and math templates. Inside Org mode, you can make use of
+major @LaTeX{} mode like AUC@TeX{} in order to speed-up insertion of
+environments and math templates. Inside Org-mode, you can make use of
some of the features of CDLa@TeX{} mode. You need to install
@file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
AUC@TeX{}) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
-Don't use CDLa@TeX{} mode itself under Org mode, but use the light
-version @code{org-cdlatex-mode} that comes as part of Org mode. Turn it
+Don't use CDLa@TeX{} mode itself under Org-mode, but use the light
+version @code{org-cdlatex-mode} that comes as part of Org-mode. Turn it
on for the current buffer with @code{M-x org-cdlatex-mode}, or for all
Org files with
@item
@kindex @key{TAB}
The @key{TAB} key will do template expansion if the cursor is inside a
-La@TeX{} fragment@footnote{Org mode has a method to test if the cursor is
+@LaTeX{} fragment@footnote{Org-mode 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 @code{\frac@{@}@{@}} and position the cursor
@kindex _
@kindex ^
@vindex cdlatex-simplify-sub-super-scripts
-Pressing @kbd{_} and @kbd{^} inside a La@TeX{} fragment will insert these
+Pressing @kbd{_} and @kbd{^} inside a @LaTeX{} 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
@item
@kindex `
Pressing the backquote @kbd{`} followed by a character inserts math
-macros, also outside La@TeX{} fragments. If you wait more than 1.5 seconds
+macros, also outside @LaTeX{} fragments. If you wait more than 1.5 seconds
after the backquote, a help window will pop up.
@item
@kindex '
Pressing the single-quote @kbd{'} followed by another character modifies
the symbol before point with an accent or a font. If you wait more than
-1.5 seconds after the backquote, a help window will pop up. Character
-modification will work only inside La@TeX{} fragments, outside the quote
+1.5 seconds after the single-quote, a help window will pop up. Character
+modification will work only inside @LaTeX{} fragments; outside the quote
is normal.
@end itemize
printing and sharing of notes, ASCII export produces a readable and simple
version of an Org 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. La@TeX{} export lets you use Org mode and
-its structured editing functions to easily create La@TeX{} files. DocBook
+broad range of other applications. @LaTeX{} export lets you use Org-mode and
+its structured editing functions to easily create @LaTeX{} files. DocBook
export makes it possible to convert Org files to many other formats using
-DocBook tools. 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.
+DocBook tools. OpenDocumentText export allows seamless collaboration across
+organizational boundaries. For project management you can create gantt and
+resource charts by using TaskJuggler export. 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.
Org supports export of selected regions when @code{transient-mark-mode} is
enabled (default in Emacs 23).
* Selective export:: Using tags to select and exclude trees
* Export options:: Per-file export settings
* The export dispatcher:: How to access exporter commands
-* ASCII export:: Exporting to plain ASCII
+* ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
* HTML export:: Exporting to HTML
-* LaTeX and PDF export:: Exporting to La@TeX{}, and processing to PDF
+* LaTeX and PDF export:: Exporting to @LaTeX{}, and processing to PDF
* DocBook export:: Exporting to DocBook
+* OpenDocumentText export:: Exporting to OpenDocumentText
+* TaskJuggler export:: Exporting to TaskJuggler
* Freemind export:: Exporting to Freemind mind maps
* XOXO export:: Exporting to XOXO
* iCalendar export:: Exporting in iCalendar format
@node Selective export, Export options, Exporting, Exporting
@section Selective export
-@cindex export, selective by tags
+@cindex export, selective by tags or TODO keyword
@vindex org-export-select-tags
@vindex org-export-exclude-tags
+@cindex org-export-with-tasks
You may use tags to select the parts of a document that should be exported,
or to exclude parts from export. This behavior is governed by two variables:
@code{org-export-select-tags} and @code{org-export-exclude-tags}.
-Org first checks if any of the @emph{select} tags is present in the buffer.
-If yes, all trees that do not carry one of these tags will be excluded. If a
-selected tree is a subtree, the heading hierarchy above it will also be
-selected for export, but not the text below those headings.
+@enumerate
+@item
+Org first checks if any of the @emph{select} tags is present in the
+buffer. If yes, all trees that do not carry one of these tags will be
+excluded. If a selected tree is a subtree, the heading hierarchy above it
+will also be selected for export, but not the text below those headings.
-@noindent
+@item
If none of the select tags is found, the whole buffer will be selected for
export.
-@noindent
+@item
Finally, all subtrees that are marked by any of the @emph{exclude} tags will
be removed from the export buffer.
+@end enumerate
+
+The variable @code{org-export-with-tasks} can be configured to select which
+kind of tasks should be included for export. See the docstring of the
+variable for more information.
@node Export options, The export dispatcher, Selective export, Exporting
@section Export options
a separate file which can be included using @code{#+SETUPFILE}.
@table @kbd
-@kindex C-c C-e t
-@item C-c C-e t
+@orgcmd{C-c C-e t,org-insert-export-options-template}
Insert template with export options, see example below.
@end table
@cindex #+LINK_HOME
@cindex #+EXPORT_SELECT_TAGS
@cindex #+EXPORT_EXCLUDE_TAGS
+@cindex #+XSLT
@cindex #+LATEX_HEADER
@vindex user-full-name
@vindex user-mail-address
@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}
+#+DATE: a date, fixed, or a format string for @code{format-time-string}
#+EMAIL: his/her email address (default from @code{user-mail-address})
-#+DESCRIPTION: the page description, e.g. for the XHTML meta tag
-#+KEYWORDS: the page keywords, e.g. for the XHTML meta tag
-#+LANGUAGE: language for HTML, e.g. @samp{en} (@code{org-export-default-language})
+#+DESCRIPTION: the page description, e.g.@: for the XHTML meta tag
+#+KEYWORDS: the page keywords, e.g.@: for the XHTML meta tag
+#+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 f:t TeX:t ...
-#+BIND: lisp-var lisp-val, e.g.: org-export-latex-low-levels itemize
+#+BIND: lisp-var lisp-val, e.g.@:: org-export-latex-low-levels itemize
@r{You need to confirm using these, or configure @code{org-export-allow-BIND}}
#+LINK_UP: the ``up'' link of an exported page
#+LINK_HOME: the ``home'' link of an exported page
#+LATEX_HEADER: extra line(s) for the LaTeX header, like \usepackage@{xyz@}
#+EXPORT_SELECT_TAGS: Tags that select a tree for export
#+EXPORT_EXCLUDE_TAGS: Tags that exclude a tree from export
+#+XSLT: the XSLT stylesheet used by DocBook exporter to generate FO file
@end example
@noindent
The OPTIONS line is a compact@footnote{If you want to configure many options
-this way, you can use several OPTIONS lines.} form to specify export settings. Here
-you can:
+this way, you can use several OPTIONS lines.} form to specify export
+settings. Here you can:
@cindex headline levels
@cindex section-numbers
@cindex table of contents
@cindex special strings
@cindex emphasized text
@cindex @TeX{} macros
-@cindex La@TeX{} fragments
+@cindex @LaTeX{} fragments
@cindex author info, in export
@cindex time info, in export
+@vindex org-export-plist-vars
+@vindex org-export-author-info
+@vindex org-export-creator-info
+@vindex org-export-email-info
+@vindex org-export-time-stamp-file
@example
H: @r{set the number of headline levels for export}
num: @r{turn on/off section-numbers}
toc: @r{turn on/off table of contents, or set level limit (integer)}
-\n: @r{turn on/off line-break-preservation}
+\n: @r{turn on/off line-break-preservation (DOES NOT WORK)}
@@: @r{turn on/off quoted HTML tags}
:: @r{turn on/off fixed-width sections}
|: @r{turn on/off tables}
-: @r{turn on/off conversion of special strings.}
f: @r{turn on/off footnotes like this[1].}
todo: @r{turn on/off inclusion of TODO keywords into exported text}
+tasks: @r{turn on/off inclusion of tasks (TODO items), can be nil to remove}
+ @r{all tasks, @code{todo} to remove DONE tasks, or list of kwds to keep}
pri: @r{turn on/off priority cookies}
tags: @r{turn on/off inclusion of tags, may also be @code{not-in-toc}}
<: @r{turn on/off inclusion of any time/date stamps like DEADLINES}
*: @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 La@TeX{} fragments}
+LaTeX: @r{configure export of @LaTeX{} fragments. Default @code{auto}}
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}
+email: @r{turn on/off inclusion of author email into exported file}
creator: @r{turn on/off inclusion of creator info into exported file}
timestamp: @r{turn on/off inclusion creation time into exported file}
d: @r{turn on/off inclusion of drawers}
@end example
@noindent
-These options take effect in both the HTML and La@TeX{} export, except
-for @code{TeX} and @code{LaTeX}, which are respectively @code{t} and
-@code{nil} for the La@TeX{} export.
+These options take effect in both the HTML and @LaTeX{} export, except for
+@code{TeX} and @code{LaTeX} options, which are respectively @code{t} and
+@code{nil} for the @LaTeX{} export.
+
+The default values for these and many other options are given by a set of
+variables. For a list of such variables, the corresponding OPTIONS keys and
+also the publishing keys (@pxref{Project alist}), see the constant
+@code{org-export-plist-vars}.
When exporting only a single subtree by selecting it with @kbd{C-c @@} before
calling an export command, the subtree can overrule some of the file's export
@code{EXPORT_TEXT}, @code{EXPORT_AUTHOR}, @code{EXPORT_DATE}, and
@code{EXPORT_OPTIONS}.
-@node The export dispatcher, ASCII export, Export options, Exporting
+@node The export dispatcher, ASCII/Latin-1/UTF-8 export, Export options, Exporting
@section The export dispatcher
@cindex dispatcher, for export commands
the subtrees are exported.
@table @kbd
-@kindex C-c C-e
-@item C-c C-e
+@orgcmd{C-c C-e,org-export}
@vindex org-export-run-in-background
Dispatcher for export and publishing commands. Displays a help-window
listing the additional key(s) needed to launch an export or publishing
@kbd{C-u C-u} causes most commands to be executed in the background, in a
separate Emacs process@footnote{To make this behavior the default, customize
the variable @code{org-export-run-in-background}.}.
-@kindex C-c C-e v
-@item C-c C-e v
+@orgcmd{C-c C-e v,org-export-visible}
Like @kbd{C-c C-e}, but only export the text that is currently visible
-(i.e. not hidden by outline visibility).
-@kindex C-u C-u C-c C-e
-@item C-u C-u C-c C-e
+(i.e.@: not hidden by outline visibility).
+@orgcmd{C-u C-u C-c C-e,org-export}
@vindex org-export-run-in-background
-Call an the exporter, but reverse the setting of
-@code{org-export-run-in-background}, i.e. request background processing if
+Call the exporter, but reverse the setting of
+@code{org-export-run-in-background}, i.e.@: request background processing if
not set, or force processing in the current Emacs process if set.
@end table
-@node ASCII export, HTML export, The export dispatcher, Exporting
-@section ASCII export
+@node ASCII/Latin-1/UTF-8 export, HTML export, The export dispatcher, Exporting
+@section ASCII/Latin-1/UTF-8 export
@cindex ASCII export
+@cindex Latin-1 export
+@cindex UTF-8 export
ASCII export produces a simple and very readable version of an Org-mode
-file.
+file, containing only plain ASCII. Latin-1 and UTF-8 export augment the file
+with special characters and symbols available in these encodings.
@cindex region, active
@cindex active region
@cindex transient-mark-mode
@table @kbd
-@kindex C-c C-e a
-@item C-c C-e a
+@orgcmd{C-c C-e a,org-export-as-ascii}
@cindex property, EXPORT_FILE_NAME
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. If there is an active region@footnote{This requires
@code{transient-mark-mode} be turned on.}, only the region will be
-exported. If the selected region is a single tree@footnote{To select the
+exported. If the selected region is a single tree@footnote{To select the
current subtree, use @kbd{C-c @@}.}, 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 A
-@item C-c C-e A
-Export to a temporary buffer, do not create a file.
-@kindex C-c C-e v a
-@item C-c C-e v a
+@orgcmd{C-c C-e A,org-export-as-ascii-to-buffer}
+Export to a temporary buffer. Do not create a file.
+@orgcmd{C-c C-e n,org-export-as-latin1}
+@xorgcmd{C-c C-e N,org-export-as-latin1-to-buffer}
+Like the above commands, but use Latin-1 encoding.
+@orgcmd{C-c C-e u,org-export-as-utf8}
+@xorgcmd{C-c C-e U,org-export-as-utf8-to-buffer}
+Like the above commands, but use UTF-8 encoding.
+@item C-c C-e v a/n/u
Export only the visible part of the document.
@end table
the text and the link in a note before the next heading. See the variable
@code{org-export-ascii-links-to-notes} for details and other options.
-@node HTML export, LaTeX and PDF export, ASCII export, Exporting
+@node HTML export, LaTeX and PDF export, ASCII/Latin-1/UTF-8 export, Exporting
@section HTML export
@cindex HTML export
-Org mode contains an HTML (XHTML 1.0 strict) exporter with extensive
+Org-mode contains an HTML (XHTML 1.0 strict) exporter with extensive
HTML formatting, in ways similar to John Gruber's @emph{markdown}
language, but with additional support for tables.
@menu
* HTML Export commands:: How to invoke HTML export
-* Quoting HTML tags:: Using direct HTML in Org mode
+* HTML preamble and postamble:: How to insert a preamble and a postamble
+* Quoting HTML tags:: Using direct HTML in Org-mode
* Links in HTML export:: How links will be interpreted and formatted
* Tables in HTML export:: How to modify the formatting of tables
* Images in HTML export:: How to insert figures into HTML output
+* Math formatting in HTML export:: Beautiful math also on the web
* Text areas in HTML export:: An alternative way to show an example
* CSS support:: Changing the appearance of the output
-* Javascript support:: Info and Folding in a web browser
+* JavaScript support:: Info and Folding in a web browser
@end menu
-@node HTML Export commands, Quoting HTML tags, HTML export, HTML export
+@node HTML Export commands, HTML preamble and postamble, HTML export, HTML export
@subsection HTML export commands
@cindex region, active
@cindex active region
@cindex transient-mark-mode
@table @kbd
-@kindex C-c C-e h
-@item C-c C-e h
+@orgcmd{C-c C-e h,org-export-as-html}
@cindex property, EXPORT_FILE_NAME
-Export as HTML file @file{myfile.html}. For an Org file @file{myfile.org},
-the ASCII file will be @file{myfile.html}. The file will be overwritten
+Export as HTML file. For an Org file @file{myfile.org},
+the HTML file will be @file{myfile.html}. The file will be overwritten
without warning. If there is an active region@footnote{This requires
@code{transient-mark-mode} be turned on.}, only the region will be
-exported. If the selected region is a single tree@footnote{To select the
+exported. If the selected region is a single tree@footnote{To select the
current subtree, use @kbd{C-c @@}.}, 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
+@orgcmd{C-c C-e b,org-export-as-html-and-open}
Export as HTML file and immediately open it with a browser.
-@kindex C-c C-e H
-@item C-c C-e H
-Export to a temporary buffer, do not create a file.
-@kindex C-c C-e R
-@item C-c C-e R
+@orgcmd{C-c C-e H,org-export-as-html-to-buffer}
+Export to a temporary buffer. Do not create a file.
+@orgcmd{C-c C-e R,org-export-region-as-html}
Export the active region to a temporary buffer. With a prefix argument, do
not produce the file header and footer, 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
-@kindex C-c C-e v H
-@kindex C-c C-e v R
-@item C-c C-e v h
-@item C-c C-e v b
-@item C-c C-e v H
-@item C-c C-e v R
+@item C-c C-e v h/b/H/R
Export only the visible part of the document.
@item M-x org-export-region-as-html
Convert the region to HTML under the assumption that it was Org-mode
@noindent
creates two levels of headings and does the rest as items.
-@node Quoting HTML tags, Links in HTML export, HTML Export commands, HTML export
+
+@node HTML preamble and postamble, Quoting HTML tags, HTML Export commands, HTML export
+@subsection HTML preamble and postamble
+@vindex org-export-html-preamble
+@vindex org-export-html-postamble
+@vindex org-export-html-preamble-format
+@vindex org-export-html-postamble-format
+@vindex org-export-html-validation-link
+@vindex org-export-author-info
+@vindex org-export-email-info
+@vindex org-export-creator-info
+@vindex org-export-time-stamp-file
+
+The HTML exporter lets you define a preamble and a postamble.
+
+The default value for @code{org-export-html-preamble} is @code{t}, which
+means that the preamble is inserted depending on the relevant formatting
+string in @code{org-export-html-preamble-format}.
+
+Setting @code{org-export-html-preamble} to a string will override the default
+formatting string. Setting it to a function, will insert the output of the
+function, which must be a string; such a function takes no argument but you
+can check against the value of @code{opt-plist}, which contains the list of
+publishing properties for the current file. Setting to @code{nil} will not
+insert any preamble.
+
+The default value for @code{org-export-html-postamble} is @code{'auto}, which
+means that the HTML exporter will look for the value of
+@code{org-export-author-info}, @code{org-export-email-info},
+@code{org-export-creator-info} and @code{org-export-time-stamp-file},
+@code{org-export-html-validation-link} and build the postamble from these
+values. Setting @code{org-export-html-postamble} to @code{t} will insert the
+postamble from the relevant formatting string found in
+@code{org-export-html-postamble-format}. Setting it to @code{nil} will not
+insert any postamble.
+
+@node Quoting HTML tags, Links in HTML export, HTML preamble and postamble, HTML export
@subsection Quoting HTML tags
Plain @samp{<} and @samp{>} are always transformed to @samp{<} and
#+ATTR_HTML: border="2" rules="all" frame="all"
@end example
-@node Images in HTML export, Text areas in HTML export, Tables in HTML export, HTML export
+@node Images in HTML export, Math formatting in HTML export, Tables in HTML export, HTML export
@subsection Images in HTML export
@cindex images, inline in HTML
[[file:highres.jpg][file:thumb.jpg]]
@end example
-If you need to add attributes to an inlines image, use a @code{#+ATTR_HTML}.
+If you need to add attributes to an inlined image, use a @code{#+ATTR_HTML}.
In the example below we specify the @code{alt} and @code{title} attributes to
support text viewers and accessibility, and align it to the right.
@end example
@noindent
-and you could use @code{http} addresses just as well.
+You could use @code{http} addresses just as well.
+
+@node Math formatting in HTML export, Text areas in HTML export, Images in HTML export, HTML export
+@subsection Math formatting in HTML export
+@cindex MathJax
+@cindex dvipng
+
+@LaTeX{} math snippets (@pxref{LaTeX fragments}) can be displayed in two
+different ways on HTML pages. The default is to use the
+@uref{http://www.mathjax.org, MathJax system} which should work out of the
+box with Org mode installation because @code{http://orgmode.org} serves
+@file{MathJax} for Org-mode users for small applications and for testing
+purposes. @b{If you plan to use this regularly or on pages with significant
+page views, you should install@footnote{Installation instructions can be
+found on the MathJax website, see
+@uref{http://www.mathjax.org/resources/docs/?installation.html}.} MathJax on
+your own server in order to limit the load of our server.} To configure
+@file{MathJax}, use the variable @code{org-export-html-mathjax-options} or
+insert something like the following into the buffer:
+
+@example
+#+MATHJAX: align:"left" mathml:t path:"/MathJax/MathJax.js"
+@end example
-@node Text areas in HTML export, CSS support, Images in HTML export, HTML export
+@noindent See the docstring of the variable
+@code{org-export-html-mathjax-options} for the meaning of the parameters in
+this line.
+
+If you prefer, you can also request that @LaTeX{} fragments are processed
+into small images that will be inserted into the browser page. Before the
+availability of MathJax, this was the default method for Org files. This
+method requires that the @file{dvipng} program is available on your system.
+You can still get this processing with
+
+@example
+#+OPTIONS: LaTeX:dvipng
+@end example
+
+@node Text areas in HTML export, CSS support, Math formatting in HTML export, HTML export
@subsection Text areas in HTML export
@cindex text areas, in HTML
@example
#+BEGIN_EXAMPLE -t -w 40
-(defun org-xor (a b)
- "Exclusive or."
- (if a (not b) b))
+ (defun org-xor (a b)
+ "Exclusive or."
+ (if a (not b) b))
#+END_EXAMPLE
@end example
-@node CSS support, Javascript support, Text areas in HTML export, HTML export
+@node CSS support, JavaScript support, Text areas in HTML export, HTML export
@subsection CSS support
@cindex CSS, for HTML export
@cindex HTML export, CSS
p.creator @r{creator info, about org-mode version}
.title @r{document title}
.todo @r{TODO keywords, all not-done states}
-.done @r{the DONE keywords, all stated the count as done}
+.done @r{the DONE keywords, all states that count as done}
.WAITING @r{each TODO keyword also uses a class named after itself}
.timestamp @r{timestamp}
.timestamp-kwd @r{keyword associated with a timestamp, like SCHEDULED}
@code{org-export-html-style-include-default}}. You may overwrite these
settings, or add to them by using the variables @code{org-export-html-style}
(for Org-wide settings) and @code{org-export-html-style-extra} (for more
-granular settings, like file-local settings). To set the latter variable
+fine-grained settings, like file-local settings). To set the latter variable
individually for each file, you can use
@cindex #+STYLE
directly write a @code{<style>} @code{</style>} section in this way, without
referring to an external file.
+In order to add styles to a subtree, use the @code{:HTML_CONTAINER_CLASS:}
+property to assign a class to the tree. In order to specify CSS styles for a
+particular headline, you can use the id specified in a @code{:CUSTOM_ID:}
+property.
+
@c FIXME: More about header and footer styles
@c FIXME: Talk about links and targets.
-@node Javascript support, , CSS support, HTML export
-@subsection Javascript supported display of web pages
+@node JavaScript support, , CSS support, HTML export
+@subsection JavaScript supported display of web pages
@cindex Rose, Sebastian
Sebastian Rose has written a JavaScript program especially designed to
@r{@code{org-export-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
@r{If this is smaller than in @code{org-export-headline-levels}, each}
@r{info/folding section can still contain child headlines.}
-toc: @r{Should the table of content @emph{initially} be visible?}
+toc: @r{Should the table of contents @emph{initially} be visible?}
@r{Even when @code{nil}, you can always get to the "toc" with @kbd{i}.}
tdepth: @r{The depth of the table of contents. The defaults are taken from}
@r{the variables @code{org-export-headline-levels} and @code{org-export-with-toc}.}
-ftoc: @r{Does the css of the page specify a fixed position for the "toc"?}
+ftoc: @r{Does the CSS of the page specify a fixed position for the "toc"?}
@r{If yes, the toc will never be displayed as a section.}
ltoc: @r{Should there be short contents (children) in each section?}
@r{Make this @code{above} if the section should be above initial text.}
pages, configure the variable @code{org-export-html-use-infojs}.
@node LaTeX and PDF export, DocBook export, HTML export, Exporting
-@section La@TeX{} and PDF export
-@cindex La@TeX{} export
+@section @LaTeX{} and PDF export
+@cindex @LaTeX{} export
@cindex PDF export
@cindex Guerry, Bastien
-Org mode contains a La@TeX{} exporter written by Bastien Guerry. With
-further processing, this backend is also used to produce PDF output. Since
-the La@TeX{} output uses @file{hyperref} to implement links and cross
-references, the PDF output file will be fully linked.
+Org-mode contains a @LaTeX{} exporter written by Bastien Guerry. With
+further processing@footnote{The default LaTeX output is designed for
+processing with pdftex or latex. It includes packages that are not
+compatible with xetex and possibly luatex. See the variables
+@code{org-export-latex-default-packages-alist} and
+@code{org-export-latex-packages-alist}.}, this backend is also used to
+produce PDF output. Since the @LaTeX{} output uses @file{hyperref} to
+implement links and cross references, the PDF output file will be fully
+linked. Beware of the fact that your @code{org} file has to be properly
+structured in order to be correctly exported: respect the hierarchy of
+sections.
@menu
* LaTeX/PDF export commands:: Which key invokes which commands
-* Quoting LaTeX code:: Incorporating literal La@TeX{} code
-* Sectioning structure:: Changing sectioning in La@TeX{} output
-* Tables in LaTeX export:: Options for exporting tables to La@TeX{}
-* Images in LaTeX export:: How to insert figures into La@TeX{} output
+* Header and sectioning:: Setting up the export file structure
+* Quoting LaTeX code:: Incorporating literal @LaTeX{} code
+* Tables in LaTeX export:: Options for exporting tables to @LaTeX{}
+* Images in LaTeX export:: How to insert figures into @LaTeX{} output
+* Beamer class export:: Turning the file into a presentation
@end menu
-@node LaTeX/PDF export commands, Quoting LaTeX code, LaTeX and PDF export, LaTeX and PDF export
-@subsection La@TeX{} export commands
+@node LaTeX/PDF export commands, Header and sectioning, LaTeX and PDF export, LaTeX and PDF export
+@subsection @LaTeX{} export commands
@cindex region, active
@cindex active region
@cindex transient-mark-mode
@table @kbd
-@kindex C-c C-e l
-@item C-c C-e l
+@orgcmd{C-c C-e l,org-export-as-latex}
@cindex property EXPORT_FILE_NAME
-Export as La@TeX{} file @file{myfile.tex}. For an Org file
-@file{myfile.org}, the ASCII file will be @file{myfile.tex}. The file will
+Export as @LaTeX{} file. For an Org file
+@file{myfile.org}, the @LaTeX{} file will be @file{myfile.tex}. The file will
be overwritten without warning. If there is an active region@footnote{This
requires @code{transient-mark-mode} be turned on.}, only the region will be
-exported. If the selected region is a single tree@footnote{To select the
+exported. If the selected region is a single tree@footnote{To select the
current subtree, use @kbd{C-c @@}.}, 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 L
-@item C-c C-e L
-Export to a temporary buffer, do not create a file.
-@kindex C-c C-e v l
-@kindex C-c C-e v L
-@item C-c C-e v l
-@item C-c C-e v L
+@orgcmd{C-c C-e L,org-export-as-latex-to-buffer}
+Export to a temporary buffer. Do not create a file.
+@item C-c C-e v l/L
Export only the visible part of the document.
@item M-x org-export-region-as-latex
-Convert the region to La@TeX{} under the assumption that it was Org mode
+Convert the region to @LaTeX{} under the assumption that it was Org-mode
syntax before. This is a global command that can be invoked in any
buffer.
@item M-x org-replace-region-by-latex
-Replace the active region (assumed to be in Org mode syntax) by La@TeX{}
+Replace the active region (assumed to be in Org-mode syntax) by @LaTeX{}
code.
-@kindex C-c C-e p
-@item C-c C-e p
-Export as La@TeX{} and then process to PDF.
-@kindex C-c C-e d
-@item C-c C-e d
-Export as La@TeX{} and then process to PDF, then open the resulting PDF file.
+@orgcmd{C-c C-e p,org-export-as-pdf}
+Export as @LaTeX{} and then process to PDF.
+@orgcmd{C-c C-e d,org-export-as-pdf-and-open}
+Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
@end table
@cindex headline levels, for exporting
@code{org-latex-low-levels}.
If you want that transition to occur at a different level, specify it
-with a numeric prefix argument. For example,
+with a numeric prefix argument. For example,
@example
@kbd{C-2 C-c C-e l}
@noindent
creates two levels of headings and does the rest as items.
-@node Quoting LaTeX code, Sectioning structure, LaTeX/PDF export commands, LaTeX and PDF export
-@subsection Quoting La@TeX{} code
+@node Header and sectioning, Quoting LaTeX code, LaTeX/PDF export commands, LaTeX and PDF export
+@subsection Header and sectioning structure
+@cindex @LaTeX{} class
+@cindex @LaTeX{} sectioning structure
+@cindex @LaTeX{} header
+@cindex header, for LaTeX files
+@cindex sectioning structure, for LaTeX export
-Embedded La@TeX{} as described in @ref{Embedded LaTeX}, will be correctly
-inserted into the La@TeX{} file. This includes simple macros like
+By default, the @LaTeX{} output uses the class @code{article}.
+
+@vindex org-export-latex-default-class
+@vindex org-export-latex-classes
+@vindex org-export-latex-default-packages-alist
+@vindex org-export-latex-packages-alist
+@cindex #+LATEX_HEADER
+@cindex #+LATEX_CLASS
+@cindex #+LATEX_CLASS_OPTIONS
+@cindex property, LATEX_CLASS
+@cindex property, LATEX_CLASS_OPTIONS
+You can change this globally by setting a different value for
+@code{org-export-latex-default-class} or locally by adding an option like
+@code{#+LaTeX_CLASS: myclass} in your file, or with a @code{:LaTeX_CLASS:}
+property that applies when exporting a region containing only this (sub)tree.
+The class must be listed in @code{org-export-latex-classes}. This variable
+defines a header template for each class@footnote{Into which the values of
+@code{org-export-latex-default-packages-alist} and
+@code{org-export-latex-packages-alist} are spliced.}, and allows you to
+define the sectioning structure for each class. You can also define your own
+classes there. @code{#+LaTeX_CLASS_OPTIONS} or a @code{LaTeX_CLASS_OPTIONS}
+property can specify the options for the @code{\documentclass} macro. You
+can also use @code{#+LATEX_HEADER: \usepackage@{xyz@}} to add lines to the
+header. See the docstring of @code{org-export-latex-classes} for more
+information.
+
+@node Quoting LaTeX code, Tables in LaTeX export, Header and sectioning, LaTeX and PDF export
+@subsection Quoting @LaTeX{} code
+
+Embedded @LaTeX{} as described in @ref{Embedded LaTeX}, will be correctly
+inserted into the @LaTeX{} file. This includes simple macros like
@samp{\ref@{LABEL@}} to create a cross reference to a figure. Furthermore,
-you can add special code that should only be present in La@TeX{} export with
+you can add special code that should only be present in @LaTeX{} export with
the following constructs:
@cindex #+LaTeX
#+END_LaTeX
@end example
-@node Sectioning structure, Tables in LaTeX export, Quoting LaTeX code, LaTeX and PDF export
-@subsection Sectioning structure
-@cindex La@TeX{} class
-@cindex La@TeX{} sectioning structure
-
-By default, the La@TeX{} output uses the class @code{article}.
-
-@vindex org-export-latex-default-class
-@vindex org-export-latex-classes
-@cindex #+LATEX_HEADER
-@cindex #+LATEX_CLASS
-@cindex property, LATEX_CLASS
-You can change this globally by setting a different value for
-@code{org-export-latex-default-class} or locally by adding an option like
-@code{#+LaTeX_CLASS: myclass} in your file, or with a @code{:LaTeX_CLASS:}
-property that applies when exporting a region containing only this (sub)tree.
-The class should be listed in @code{org-export-latex-classes}, where you can
-also define the sectioning structure for each class, as well as defining
-additional classes. You can also use @code{#+LATEX_HEADER:
-\usepackage@{xyz@}} to add lines to the header.
-@node Tables in LaTeX export, Images in LaTeX export, Sectioning structure, LaTeX and PDF export
-@subsection Tables in La@TeX{} export
-@cindex tables, in La@TeX{} export
+@node Tables in LaTeX export, Images in LaTeX export, Quoting LaTeX code, LaTeX and PDF export
+@subsection Tables in @LaTeX{} export
+@cindex tables, in @LaTeX{} export
-For La@TeX{} export of a table, you can specify a label and a caption
-(@pxref{Images and tables}). You can also use the @code{ATTR_LaTeX} line to
-request a longtable environment for the table, so that it may span several
-pages. Finally, you can set the alignment string:
+For @LaTeX{} export of a table, you can specify a label, a caption and
+placement options (@pxref{Images and tables}). You can also use the
+@code{ATTR_LaTeX} line to request a @code{longtable} environment for the
+table, so that it may span several pages, or to change the default table
+environment from @code{table} to @code{table*} or to change the default inner
+tabular environment to @code{tabularx} or @code{tabulary}. Finally, you can
+set the alignment string, and (with @code{tabularx} or @code{tabulary}) the
+width:
@cindex #+CAPTION
@cindex #+LABEL
| ..... | ..... |
@end example
+or to specify a multicolumn table with @code{tabulary}
+
+@cindex #+CAPTION
+@cindex #+LABEL
+@cindex #+ATTR_LaTeX
+@example
+#+CAPTION: A wide table with tabulary
+#+LABEL: tbl:wide
+#+ATTR_LaTeX: table* tabulary width=\textwidth
+| ..... | ..... |
+| ..... | ..... |
+@end example
-@node Images in LaTeX export, , Tables in LaTeX export, LaTeX and PDF export
-@subsection Images in La@TeX{} export
-@cindex images, inline in La@TeX{}
-@cindex inlining images in La@TeX{}
+@node Images in LaTeX export, Beamer class export, Tables in LaTeX export, LaTeX and PDF export
+@subsection Images in @LaTeX{} export
+@cindex images, inline in @LaTeX{}
+@cindex inlining images in @LaTeX{}
Images that are linked to without a description part in the link, like
@samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
-output file resulting from La@TeX{} processing. Org will use an
+output file resulting from @LaTeX{} processing. Org will use an
@code{\includegraphics} macro to insert the image. If you have specified a
caption and/or a label as described in @ref{Images and tables}, the figure
will be wrapped into a @code{figure} environment and thus become a floating
-element. You can use an @code{#+ATTR_LaTeX:} line to specify the various
-options that can be used in the optional argument of the
-@code{\includegraphics} macro. To modify the placement option of the
-@code{figure} environment, add something like @samp{placement=[h!]} to the
-Attributes.
-
-If you'd like to let text flow around the image, add the word @samp{wrap} to
-the @code{#+ATTR_LaTeX:} line, which will make the figure occupy the left
-half of the page. To fine-tune, the @code{placement} field will be the
-set of additional arguments needed by the @code{wrapfigure} environment.
-Note that if you change the size of the image, you need to use compatible
-settings for @code{\includegraphics} and @code{wrapfigure}.
+element. You can use an @code{#+ATTR_LaTeX:} line to specify various other
+options. You can ask org to export an image as a float without specifying
+a label or a caption by using the keyword @code{float} in this line. Various
+optional arguments to the @code{\includegraphics} macro can also be specified
+in this fashion. To modify the placement option of the floating environment,
+add something like @samp{placement=[h!]} to the attributes. It is to be noted
+this option can be used with tables as well@footnote{One can also take
+advantage of this option to pass other, unrelated options into the figure or
+table environment. For an example see the section ``Exporting org files'' in
+@url{http://orgmode.org/worg/org-hacks.html}}. For example the
+@code{#+ATTR_LaTeX:} line below is exported as the @code{figure} environment
+below it.
+
+If you would like to let text flow around the image, add the word @samp{wrap}
+to the @code{#+ATTR_LaTeX:} line, which will make the figure occupy the left
+half of the page. To fine-tune, the @code{placement} field will be the set
+of additional arguments needed by the @code{wrapfigure} environment. Note
+that if you change the size of the image, you need to use compatible settings
+for @code{\includegraphics} and @code{wrapfigure}.
@cindex #+CAPTION
@cindex #+LABEL
[[./img/hst.png]]
@end example
+If you wish to include an image which spans multiple columns in a page, you
+can use the keyword @code{multicolumn} in the @code{#+ATTR_LaTeX} line. This
+will export the image wrapped in a @code{figure*} environment.
+
If you need references to a label created in this way, write
-@samp{\ref@{fig:SED-HR4049@}} just like in La@TeX{}.
+@samp{\ref@{fig:SED-HR4049@}} just like in @LaTeX{}.
+
+@node Beamer class export, , Images in LaTeX export, LaTeX and PDF export
+@subsection Beamer class export
+
+The LaTeX class @file{beamer} allows production of high quality presentations
+using LaTeX and pdf processing. Org-mode has special support for turning an
+Org-mode file or tree into a @file{beamer} presentation.
+
+When the LaTeX class for the current buffer (as set with @code{#+LaTeX_CLASS:
+beamer}) or subtree (set with a @code{LaTeX_CLASS} property) is
+@code{beamer}, a special export mode will turn the file or tree into a beamer
+presentation. Any tree with not-too-deep level nesting should in principle be
+exportable as a beamer presentation. By default, the top-level entries (or
+the first level below the selected subtree heading) will be turned into
+frames, and the outline structure below this level will become itemize lists.
+You can also configure the variable @code{org-beamer-frame-level} to a
+different level---then the hierarchy above frames will produce the sectioning
+structure of the presentation.
+
+A template for useful in-buffer settings or properties can be inserted into
+the buffer with @kbd{M-x org-insert-beamer-options-template}. Among other
+things, this will install a column view format which is very handy for
+editing special properties used by beamer.
+
+You can influence the structure of the presentation using the following
+properties:
+
+@table @code
+@item BEAMER_env
+The environment that should be used to format this entry. Valid environments
+are defined in the constant @code{org-beamer-environments-default}, and you
+can define more in @code{org-beamer-environments-extra}. If this property is
+set, the entry will also get a @code{:B_environment:} tag to make this
+visible. This tag has no semantic meaning, it is only a visual aid.
+@item BEAMER_envargs
+The beamer-special arguments that should be used for the environment, like
+@code{[t]} or @code{[<+->]} of @code{<2-3>}. If the @code{BEAMER_col}
+property is also set, something like @code{C[t]} can be added here as well to
+set an options argument for the implied @code{columns} environment.
+@code{c[t]} or @code{c<2->} will set an options for the implied @code{column}
+environment.
+@item BEAMER_col
+The width of a column that should start with this entry. If this property is
+set, the entry will also get a @code{:BMCOL:} property to make this visible.
+Also this tag is only a visual aid. When this is a plain number, it will be
+interpreted as a fraction of @code{\textwidth}. Otherwise it will be assumed
+that you have specified the units, like @samp{3cm}. The first such property
+in a frame will start a @code{columns} environment to surround the columns.
+This environment is closed when an entry has a @code{BEAMER_col} property
+with value 0 or 1, or automatically at the end of the frame.
+@item BEAMER_extra
+Additional commands that should be inserted after the environment has been
+opened. For example, when creating a frame, this can be used to specify
+transitions.
+@end table
+
+Frames will automatically receive a @code{fragile} option if they contain
+source code that uses the verbatim environment. Special @file{beamer}
+specific code can be inserted using @code{#+BEAMER:} and
+@code{#+BEGIN_beamer...#+end_beamer} constructs, similar to other export
+backends, but with the difference that @code{#+LaTeX:} stuff will be included
+in the presentation as well.
+
+Outline nodes with @code{BEAMER_env} property value @samp{note} or
+@samp{noteNH} will be formatted as beamer notes, i,e, they will be wrapped
+into @code{\note@{...@}}. The former will include the heading as part of the
+note text, the latter will ignore the heading of that node. To simplify note
+generation, it is actually enough to mark the note with a @emph{tag} (either
+@code{:B_note:} or @code{:B_noteNH:}) instead of creating the
+@code{BEAMER_env} property.
+
+You can turn on a special minor mode @code{org-beamer-mode} for editing
+support with
+
+@example
+#+STARTUP: beamer
+@end example
+
+@table @kbd
+@orgcmd{C-c C-b,org-beamer-select-environment}
+In @code{org-beamer-mode}, this key offers fast selection of a beamer
+environment or the @code{BEAMER_col} property.
+@end table
+
+Column view provides a great way to set the environment of a node and other
+important parameters. Make sure you are using a COLUMN format that is geared
+toward this special purpose. The command @kbd{M-x
+org-insert-beamer-options-template} defines such a format.
+
+Here is a simple example Org document that is intended for beamer export.
+
+@smallexample
+#+LaTeX_CLASS: beamer
+#+TITLE: Example Presentation
+#+AUTHOR: Carsten Dominik
+#+LaTeX_CLASS_OPTIONS: [presentation]
+#+BEAMER_FRAME_LEVEL: 2
+#+BEAMER_HEADER_EXTRA: \usetheme@{Madrid@}\usecolortheme@{default@}
+#+COLUMNS: %35ITEM %10BEAMER_env(Env) %10BEAMER_envargs(Args) %4BEAMER_col(Col) %8BEAMER_extra(Ex)
+
+* This is the first structural section
+
+** Frame 1 \\ with a subtitle
+*** Thanks to Eric Fraga :BMCOL:B_block:
+ :PROPERTIES:
+ :BEAMER_env: block
+ :BEAMER_envargs: C[t]
+ :BEAMER_col: 0.5
+ :END:
+ for the first viable beamer setup in Org
+*** Thanks to everyone else :BMCOL:B_block:
+ :PROPERTIES:
+ :BEAMER_col: 0.5
+ :BEAMER_env: block
+ :BEAMER_envargs: <2->
+ :END:
+ for contributing to the discussion
+**** This will be formatted as a beamer note :B_note:
+** Frame 2 \\ where we will not use columns
+*** Request :B_block:
+ Please test this stuff!
+ :PROPERTIES:
+ :BEAMER_env: block
+ :END:
+@end smallexample
-@node DocBook export, Freemind export, LaTeX and PDF export, Exporting
+For more information, see the documentation on Worg.
+
+@node DocBook export, OpenDocumentText export, LaTeX and PDF export, Exporting
@section DocBook export
@cindex DocBook export
@cindex PDF export
-@cindex Cui, Baoqui
+@cindex Cui, Baoqiu
Org contains a DocBook exporter written by Baoqiu Cui. Once an Org file is
exported to DocBook format, it can be further processed to produce other
@cindex active region
@cindex transient-mark-mode
@table @kbd
-@kindex C-c C-e D
-@item C-c C-e D
+@orgcmd{C-c C-e D,org-export-as-docbook}
@cindex property EXPORT_FILE_NAME
Export as DocBook file. For an Org file, @file{myfile.org}, the DocBook XML
file will be @file{myfile.xml}. The file will be overwritten without
current subtree, use @kbd{C-c @@}.}, 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 V
-@item C-c C-e V
+@orgcmd{C-c C-e V,org-export-as-docbook-pdf-and-open}
Export as DocBook file, process to PDF, then open the resulting PDF file.
@vindex org-export-docbook-xslt-proc-command
system. Check variables @code{org-export-docbook-xslt-proc-command} and
@code{org-export-docbook-xsl-fo-proc-command}.
-@kindex C-c C-e v D
-@item C-c C-e v D
+@vindex org-export-docbook-xslt-stylesheet
+The stylesheet argument @code{%s} in variable
+@code{org-export-docbook-xslt-proc-command} is replaced by the value of
+variable @code{org-export-docbook-xslt-stylesheet}, which needs to be set by
+the user. You can also overrule this global setting on a per-file basis by
+adding an in-buffer setting @code{#+XSLT:} to the Org file.
+
+@orgkey{C-c C-e v D}
Export only the visible part of the document.
@end table
#+BEGIN_DOCBOOK
<warning>
<para>You should know what you are doing when quoting DocBook XML code
- in your Org file. Invalid DocBook XML file may be generated by
+ in your Org file. Invalid DocBook XML may be generated by
DocBook exporter if you are not careful!</para>
</warning>
#+END_DOCBOOK
@cindex DocBook recursive sections
DocBook exporter exports Org files as articles using the @code{article}
-element in DocBook. Recursive sections, i.e. @code{section} elements, are
+element in DocBook. Recursive sections, i.e.@: @code{section} elements, are
used in exported articles. Top level headlines in Org files are exported as
top level sections, and lower level headlines are exported as nested
sections. The entire structure of Org files will be exported completely, no
variable @code{org-export-docbook-default-image-attributes} or use the
@code{#+ATTR_DOCBOOK:} line. Attributes specified in variable
@code{org-export-docbook-default-image-attributes} are applied to all inline
-images in the Org file to be exported (unless they are overwritten by image
+images in the Org file to be exported (unless they are overridden by image
attributes specified in @code{#+ATTR_DOCBOOK:} lines).
The @code{#+ATTR_DOCBOOK:} line can be used to specify additional image
-attributes or overwrite default image attributes for individual images. If
+attributes or override default image attributes for individual images. If
the same attribute appears in both the @code{#+ATTR_DOCBOOK:} line and
variable @code{org-export-docbook-default-image-attributes}, the former
-overwrites the latter. Here is an example about how image attributes can be
+takes precedence. Here is an example about how image attributes can be
set:
@cindex #+CAPTION
@cindex #+LABEL
@cindex #+ATTR_DOCBOOK
@example
-#+CAPTION: The logo of Org mode
+#+CAPTION: The logo of Org-mode
#+LABEL: unicorn-svg
#+ATTR_DOCBOOK: scalefit="1" width="100%" depth="100%"
[[./img/org-mode-unicorn.svg]]
@cindex Special characters in DocBook export
@vindex org-export-docbook-doctype
-@vindex org-html-entities
+@vindex org-entities
Special characters that are written in @TeX{}-like syntax, such as @code{\alpha},
@code{\Gamma}, and @code{\Zeta}, are supported by DocBook exporter. These
characters are rewritten to XML entities, like @code{α},
@code{Γ}, and @code{Ζ}, based on the list saved in variable
-@code{org-html-entities}. As long as the generated DocBook file includes the
+@code{org-entities}. As long as the generated DocBook file includes the
corresponding entities, these special characters are recognized.
You can customize variable @code{org-export-docbook-doctype} to include the
"
@end example
-@node Freemind export, XOXO export, DocBook export, Exporting
+@c begin opendocument
+
+@node OpenDocumentText export, TaskJuggler export, DocBook export, Exporting
+@section OpenDocumentText export
+@cindex OpenDocumentText export
+@cindex K, Jambunathan
+
+Org-mode 7.6 supports export to OpenDocumentText format using
+@file{org-odt.el} module contributed by Jambunathan K. This module can be
+enabled in one of the following ways based on your mode of installation.
+
+@enumerate
+@item
+If you have downloaded the Org from the Web, either as a distribution
+@file{.zip} or @file{.tar} file, or as a Git archive, enable the @code{odt}
+option in variable @code{org-modules}.
+@item
+If you are using Org that comes bundled with Emacs, then you can install the
+OpenDocumentText exporter using the package manager. To do this, customize
+the variable @code{package-archives} to include
+@uref{http://orgmode.org/pkg/releases/} as one of the package archives.
+@end enumerate
+
+@menu
+* OpenDocumentText export commands::How to invoke OpenDocumentText export
+* Applying Custom Styles:: How to apply custom styles to the output
+* Converting to Other formats:: How to convert to formats like doc, docx etc
+* Links in OpenDocumentText export:: How links will be interpreted and formatted
+* Tables in OpenDocumentText export:: Tables are exported as HTML tables
+* Images in OpenDocumentText export:: How to insert figures into DocBook output
+* Additional Documentation:: Where to find more information
+@end menu
+
+@node OpenDocumentText export commands, Applying Custom Styles, OpenDocumentText export, OpenDocumentText export
+@subsection OpenDocumentText export commands
+
+@cindex region, active
+@cindex active region
+@cindex transient-mark-mode
+@table @kbd
+@orgcmd{C-c C-e o,org-export-as-odt}
+@cindex property EXPORT_FILE_NAME
+Export as OpenDocumentText file. For an Org file, @file{myfile.org}, the
+OpenDocumentText file will be @file{myfile.odt}. The file will be
+overwritten without warning. If there is an active region@footnote{This
+requires @code{transient-mark-mode} to be turned on}, only the region will be
+exported. If the selected region is a single tree@footnote{To select the
+current subtree, use @kbd{C-c @@}.}, 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.
+@orgcmd{C-c C-e O,org-export-as-odt-and-open}
+Export as OpenDocumentText file and open the resulting file.
+@end table
+
+@node Applying Custom Styles, Converting to Other formats, OpenDocumentText export commands, OpenDocumentText export
+@subsection Applying Custom Styles
+@cindex styles, custom
+@cindex template, custom
+
+@vindex org-export-odt-styles-file
+
+OpenDocumentExporter ships with a custom @file{styles.xml} for formatting of
+the exported file. To customize the output to suit your needs you can use
+one of the following methods:
+
+@enumerate
+@item
+Customize the variable @code{org-export-odt-styles-file} to point to either a
+@file{styles.xml} file, a OpenDocument Text Template file @code{.ott} or a
+combination of Text or Template Document together with a set of member files.
+Use the first two options if the styles.xml has no references to additional
+set of files and use the last option if the @file{styles.xml} references
+additional files like header and footer images.
+@item
+Use an external tool like unoconv to apply custom templates.
+@end enumerate
+
+For best results, it is necessary that the style names used by
+OpenDocumentText exporter match that used in the @file{styles.xml}.
+
+@node Converting to Other formats, Links in OpenDocumentText export, Applying Custom Styles, OpenDocumentText export
+@subsection Converting to Other formats
+
+@cindex convert
+@cindex doc, docx
+
+@vindex org-export-odt-styles-file
+
+Often times there is a need to convert OpenDocumentText files to other
+formats like doc, docx or pdf. You can accomplish this by one of the
+following methods:
+
+@table @kbd
+@item M-x org-lparse
+Export the outline first to one of the native formats (like OpenDocumentText)
+and immediately post-process it to other formats using an external converter.
+
+@item M-x org-lparse-convert
+Export an existing document to other formats using an external converter.
+@end table
+
+You can choose the converter used for conversion by customizing the variable
+@code{org-lparse-convert-process}.
+
+@node Links in OpenDocumentText export, Tables in OpenDocumentText export, Converting to Other formats, OpenDocumentText export
+@subsection Links in OpenDocumentText export
+@cindex tables, in DocBook export
+
+OpenDocumentExporter creates cross-references (aka bookmarks) for links that
+are destined locally. It creates internet style links for all other links.
+
+@node Tables in OpenDocumentText export, Images in OpenDocumentText export, Links in OpenDocumentText export, OpenDocumentText export
+@subsection Tables in OpenDocumentText export
+@cindex tables, in DocBook export
+
+Export of @file{table.el} tables with row or column spanning is not
+supported. Such tables are stripped from the exported document.
+
+@node Images in OpenDocumentText export, Additional Documentation, Tables in OpenDocumentText export, OpenDocumentText export
+@subsection Images in OpenDocumentText export
+@cindex images, embedding in OpenDocumentText
+@cindex embedding images in OpenDocumentText
+
+OpenDocumentText exporter can embed images within the exported document. To
+embed images, provide a link to the desired image file with no link
+description. For example, the following links @samp{[[file:img.jpg]]} or
+@samp{[[./img.jpg]]}, will result in embedding of @samp{img.jpg} in the
+exported file.
+
+The exporter can also embed scaled and explicitly sized images within the
+exported document. The markup of the scale and size specifications has not
+been standardized yet and is hence conveniently skipped in this document.
+
+The exporter can also make an image the clickable part of a link. To create
+clickable images, provide a link whose description is a link to an image
+file. For example, the following link
+@samp{[[http://orgmode.org][./img.jpg]]}, will result in a clickable image
+that links to @uref{http://Orgmode.org} website.
+
+@node Additional Documentation, , Images in OpenDocumentText export, OpenDocumentText export
+@subsection Additional documentation
+
+The OpenDocumentText exporter is still in development. For up to date
+information, please follow Org mailing list @email{emacs-orgmode@@gnu.org}
+closely.
+
+@c end opendocument
+
+@node TaskJuggler export, Freemind export, OpenDocumentText export, Exporting
+@section TaskJuggler export
+@cindex TaskJuggler export
+@cindex Project management
+
+@uref{http://www.taskjuggler.org/, TaskJuggler} is a project management tool.
+It provides an optimizing scheduler that computes your project time lines and
+resource assignments based on the project outline and the constraints that
+you have provided.
+
+The TaskJuggler exporter is a bit different from other exporters, such as the
+HTML and LaTeX exporters for example, in that it does not export all the
+nodes of a document or strictly follow the order of the nodes in the
+document.
+
+Instead the TaskJuggler exporter looks for a tree that defines the tasks and
+a optionally tree that defines the resources for this project. It then
+creates a TaskJuggler file based on these trees and the attributes defined in
+all the nodes.
+
+@subsection TaskJuggler export commands
+
+@table @kbd
+@orgcmd{C-c C-e j,org-export-as-taskjuggler}
+Export as TaskJuggler file.
+
+@orgcmd{C-c C-e J,org-export-as-taskjuggler-and-open}
+Export as TaskJuggler file and then open the file with TaskJugglerUI.
+@end table
+
+@subsection Tasks
+
+@vindex org-export-taskjuggler-project-tag
+Create your tasks as you usually do with Org-mode. Assign efforts to each
+task using properties (it is easiest to do this in the column view). You
+should end up with something similar to the example by Peter Jones in
+@url{http://www.contextualdevelopment.com/static/artifacts/articles/2008/project-planning/project-planning.org}.
+Now mark the top node of your tasks with a tag named
+@code{:taskjuggler_project:} (or whatever you customized
+@code{org-export-taskjuggler-project-tag} to). You are now ready to export
+the project plan with @kbd{C-c C-e J} which will export the project plan and
+open a gantt chart in TaskJugglerUI.
+
+@subsection Resources
+
+@vindex org-export-taskjuggler-resource-tag
+Next you can define resources and assign those to work on specific tasks. You
+can group your resources hierarchically. Tag the top node of the resources
+with @code{:taskjuggler_resource:} (or whatever you customized
+@code{org-export-taskjuggler-resource-tag} to). You can optionally assign an
+identifier (named @samp{resource_id}) to the resources (using the standard
+Org properties commands, @pxref{Property syntax}) or you can let the exporter
+generate identifiers automatically (the exporter picks the first word of the
+headline as the identifier as long as it is unique---see the documentation of
+@code{org-taskjuggler-get-unique-id}). Using that identifier you can then
+allocate resources to tasks. This is again done with the @samp{allocate}
+property on the tasks. Do this in column view or when on the task type
+@kbd{C-c C-x p allocate @key{RET} <resource_id> @key{RET}}.
+
+Once the allocations are done you can again export to TaskJuggler and check
+in the Resource Allocation Graph which person is working on what task at what
+time.
+
+@subsection Export of properties
+
+The exporter also takes TODO state information into consideration, i.e.@: if a
+task is marked as done it will have the corresponding attribute in
+TaskJuggler (@samp{complete 100}). Also it will export any property on a task
+resource or resource node which is known to TaskJuggler, such as
+@samp{limits}, @samp{vacation}, @samp{shift}, @samp{booking},
+@samp{efficiency}, @samp{journalentry}, @samp{rate} for resources or
+@samp{account}, @samp{start}, @samp{note}, @samp{duration}, @samp{end},
+@samp{journalentry}, @samp{milestone}, @samp{reference}, @samp{responsible},
+@samp{scheduling}, etc for tasks.
+
+@subsection Dependencies
+
+The exporter will handle dependencies that are defined in the tasks either
+with the @samp{ORDERED} attribute (@pxref{TODO dependencies}), with the
+@samp{BLOCKER} attribute (see @file{org-depend.el}) or alternatively with a
+@samp{depends} attribute. Both the @samp{BLOCKER} and the @samp{depends}
+attribute can be either @samp{previous-sibling} or a reference to an
+identifier (named @samp{task_id}) which is defined for another task in the
+project. @samp{BLOCKER} and the @samp{depends} attribute can define multiple
+dependencies separated by either space or comma. You can also specify
+optional attributes on the dependency by simply appending it. The following
+examples should illustrate this:
+
+@example
+* Preparation
+ :PROPERTIES:
+ :task_id: preparation
+ :ORDERED: t
+ :END:
+* Training material
+ :PROPERTIES:
+ :task_id: training_material
+ :ORDERED: t
+ :END:
+** Markup Guidelines
+ :PROPERTIES:
+ :Effort: 2d
+ :END:
+** Workflow Guidelines
+ :PROPERTIES:
+ :Effort: 2d
+ :END:
+* Presentation
+ :PROPERTIES:
+ :Effort: 2d
+ :BLOCKER: training_material @{ gapduration 1d @} preparation
+ :END:
+@end example
+
+@subsection Reports
+
+@vindex org-export-taskjuggler-default-reports
+TaskJuggler can produce many kinds of reports (e.g.@: gantt chart, resource
+allocation, etc). The user defines what kind of reports should be generated
+for a project in the TaskJuggler file. The exporter will automatically insert
+some default reports in the file. These defaults are defined in
+@code{org-export-taskjuggler-default-reports}. They can be modified using
+customize along with a number of other options. For a more complete list, see
+@kbd{M-x customize-group @key{RET} org-export-taskjuggler @key{RET}}.
+
+For more information and examples see the Org-taskjuggler tutorial at
+@uref{http://orgmode.org/worg/org-tutorials/org-taskjuggler.html}.
+
+@node Freemind export, XOXO export, TaskJuggler export, Exporting
@section Freemind export
@cindex Freemind export
@cindex mind map
-The freemind exporter was written by Lennart Borgman.
+The Freemind exporter was written by Lennart Borgman.
@table @kbd
-@kindex C-c C-e m
-@item C-c C-e m
-Export as Freemind mind map @file{myfile.mm}.
+@orgcmd{C-c C-e m,org-export-as-freemind}
+Export as Freemind mind map. For an Org file @file{myfile.org}, the Freemind
+file will be @file{myfile.mm}.
@end table
@node XOXO export, iCalendar export, Freemind export, Exporting
@section XOXO export
@cindex XOXO export
-Org mode contains an exporter that produces XOXO-style output.
+Org-mode contains an exporter that produces XOXO-style output.
Currently, this exporter only handles the general outline structure and
does not interpret any additional Org-mode features.
@table @kbd
-@kindex C-c C-e x
-@item C-c C-e x
-Export as XOXO file @file{myfile.html}.
-@kindex C-c C-e v
-@item C-c C-e v x
+@orgcmd{C-c C-e x,org-export-as-xoxo}
+Export as XOXO file. For an Org file @file{myfile.org}, the XOXO file will be
+@file{myfile.html}.
+@orgkey{C-c C-e v x}
Export only the visible part of the document.
@end table
@vindex org-icalendar-use-deadline
@vindex org-icalendar-use-scheduled
@vindex org-icalendar-categories
-Some people use Org mode for keeping track of projects, but still prefer a
+@vindex org-icalendar-alarm-time
+Some people use Org-mode for keeping track of projects, but still prefer a
standard calendar application for anniversaries and appointments. In this
case it can be useful to show deadlines and other time-stamped items in Org
-files in the calendar application. Org mode can export calendar information
+files in the calendar application. Org-mode can export calendar information
in the standard iCalendar format. If you also want to have TODO entries
included in the export, configure the variable
@code{org-icalendar-include-todo}. Plain timestamps are exported as VEVENT,
@code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}.
As categories, it will use the tags locally defined in the heading, and the
file/tree category@footnote{To add inherited tags or the TODO state,
-configure the variable @code{org-icalendar-categories}.}.
+configure the variable @code{org-icalendar-categories}.}. See the variable
+@code{org-icalendar-alarm-time} for a way to assign alarms to entries with a
+time.
@vindex org-icalendar-store-UID
@cindex property, ID
figure out from which entry all the different instances originate.
@table @kbd
-@kindex C-c C-e i
-@item C-c C-e i
+@orgcmd{C-c C-e i,org-export-icalendar-this-file}
Create iCalendar entries for the current file and store them in the same
directory, using a file extension @file{.ics}.
-@kindex C-c C-e I
-@item C-c C-e I
+@orgcmd{C-c C-e I, org-export-icalendar-all-agenda-files}
@vindex org-agenda-files
Like @kbd{C-c C-e i}, but do this for all files in
@code{org-agenda-files}. For each of these files, a separate iCalendar
file will be written.
-@kindex C-c C-e c
-@item C-c C-e c
+@orgcmd{C-c C-e c,org-export-icalendar-combine-agenda-files}
@vindex org-combined-agenda-icalendar-file
Create a single large iCalendar file from all files in
@code{org-agenda-files} and write it to the file given by
How this calendar is best read and updated, depends on the application
you are using. The FAQ covers this issue.
-@node Publishing, Miscellaneous, Exporting, Top
+@node Publishing, Working With Source Code, Exporting, Top
@chapter Publishing
@cindex publishing
-@cindex O'Toole, David
Org includes a publishing management system that allows you to configure
automatic HTML conversion of @emph{projects} composed of interlinked org
* Sources and destinations:: From here to there
* Selecting files:: What files are part of the project?
* Publishing action:: Setting the function doing the publishing
-* Publishing options:: Tweaking HTML export
+* Publishing options:: Tweaking HTML/@LaTeX{} export
* Publishing links:: Which links keep working after publishing?
-* Project page index:: Publishing a list of project files
+* Sitemap:: Generating a list of all pages
+* Generating an index:: An index that reaches across pages
@end menu
@node Project alist, Sources and destinations, Configuration, Configuration
@lisp
("project-name" :property value :property value ...)
+ @r{i.e.@: a well-formed property list with alternating keys and values}
@r{or}
("project-name" :components ("project-name" "project-name" ...))
the Emacs @file{tramp} package. Or you can publish to a local directory and
use external tools to upload your website (@pxref{Uploading files}).
@item @code{:preparation-function}
-@tab Function called before starting the publishing process, for example, to
-run @code{make} for updating files to be published.
+@tab Function or list of functions to be called before starting the
+publishing process, for example, to run @code{make} for updating files to be
+published. The project property list is scoped into this call as the
+variable @code{project-plist}.
@item @code{:completion-function}
-@tab Function called after finishing the publishing process, for example, to
-change permissions of the resulting files.
+@tab Function or list of functions called after finishing the publishing
+process, for example, to change permissions of the resulting files. The
+project property list is scoped into this call as the variable
+@code{project-plist}.
@end multitable
@noindent
@item @code{:include}
@tab List of files to be included regardless of @code{:base-extension}
and @code{:exclude}.
+
+@item @code{:recursive}
+@tab Non-nil means, check base-directory recursively for files to publish.
@end multitable
@node Publishing action, Publishing options, Selecting files, Configuration
Org 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}). But you also can publish your content as PDF files using
-@code{org-publish-org-to-pdf}. If you want to publish the Org file itself,
-but with @i{archived}, @i{commented}, and @i{tag-excluded} trees removed, use
-@code{org-publish-org-to-org} and set the parameters @code{:plain-source}
-and/or @code{:htmlized-source}. This will produce @file{file.org} and
-@file{file.org.html} in the publishing
+@code{org-publish-org-to-pdf}, or as @code{ascii}, @code{latin1} or
+@code{utf8} encoded files using the corresponding functions. If you want to
+publish the Org file itself, but with @i{archived}, @i{commented}, and
+@i{tag-excluded} trees removed, use @code{org-publish-org-to-org} and set the
+parameters @code{:plain-source} and/or @code{:htmlized-source}. This will
+produce @file{file.org} and @file{file.org.html} in the publishing
directory@footnote{@file{file-source.org} and @file{file-source.org.html} if
source and publishing directories are equal. Note that with this kind of
setup, you need to add @code{:exclude "-source\\.org"} to the project
-definition in @code{org-publish-project-alist} to avoid that the published
-source files will be considered as new org files the next time the project is
-published.}. Other files like images only
-need to be copied to the publishing destination, for this you may use
-@code{org-publish-attachment}. For non-Org files, you always need to
-specify the publishing function:
+definition in @code{org-publish-project-alist} to prevent the published
+source files from being considered as new org files the next time the project
+is published.}. Other files like images only need to be copied to the
+publishing destination; for this you may use @code{org-publish-attachment}.
+For non-Org files, you always need to specify the publishing function:
@multitable @columnfractions 0.3 0.7
@item @code{:publishing-function}
@tab Non-nil means, publish htmlized source.
@end multitable
-The function must accept two arguments: a property list containing at least a
-@code{:publishing-directory} property, and the name of the file to be
-published. It should take the specified file, make the necessary
-transformation (if any) and place the result into the destination folder.
+The function must accept three arguments: a property list containing at least
+a @code{:publishing-directory} property, the name of the file to be
+published, and the path to the publishing directory of the output file. It
+should take the specified file, make the necessary transformation (if any)
+and place the result into the destination folder.
@node Publishing options, Publishing links, Publishing action, Configuration
-@subsection Options for the HTML/La@TeX{} exporters
+@subsection Options for the HTML/@LaTeX{} exporters
@cindex options, for publishing
The property list can be used to set many export options for the HTML
-and La@TeX{} exporters. In most cases, these properties correspond to user
+and @LaTeX{} exporters. In most cases, these properties correspond to user
variables in Org. The table below lists these properties along
with the variable they belong to. See the documentation string for the
respective variable for details.
@vindex org-export-with-drawers
@vindex org-export-with-tags
@vindex org-export-with-todo-keywords
+@vindex org-export-with-tasks
+@vindex org-export-with-done-tasks
@vindex org-export-with-priority
@vindex org-export-with-TeX-macros
@vindex org-export-with-LaTeX-fragments
@vindex org-export-with-fixed-width
@vindex org-export-with-timestamps
@vindex org-export-author-info
+@vindex org-export-email-info
@vindex org-export-creator-info
+@vindex org-export-time-stamp-file
@vindex org-export-with-tables
@vindex org-export-highlight-first-table-line
@vindex org-export-html-style-include-default
+@vindex org-export-html-style-include-scripts
@vindex org-export-html-style
@vindex org-export-html-style-extra
@vindex org-export-html-link-org-files-as-html
@vindex org-export-publishing-directory
@vindex org-export-html-preamble
@vindex org-export-html-postamble
-@vindex org-export-html-auto-preamble
-@vindex org-export-html-auto-postamble
@vindex user-full-name
@vindex user-mail-address
@vindex org-export-select-tags
@item @code{:drawers} @tab @code{org-export-with-drawers}
@item @code{:tags} @tab @code{org-export-with-tags}
@item @code{:todo-keywords} @tab @code{org-export-with-todo-keywords}
+@item @code{:tasks} @tab @code{org-export-with-tasks}
@item @code{:priority} @tab @code{org-export-with-priority}
@item @code{:TeX-macros} @tab @code{org-export-with-TeX-macros}
@item @code{:LaTeX-fragments} @tab @code{org-export-with-LaTeX-fragments}
@item @code{:skip-before-1st-heading} @tab @code{org-export-skip-text-before-1st-heading}
@item @code{:fixed-width} @tab @code{org-export-with-fixed-width}
@item @code{:timestamps} @tab @code{org-export-with-timestamps}
+@item @code{:author} @tab @code{user-full-name}
+@item @code{:email} @tab @code{user-mail-address} : @code{addr;addr;..}
@item @code{:author-info} @tab @code{org-export-author-info}
+@item @code{:email-info} @tab @code{org-export-email-info}
@item @code{:creator-info} @tab @code{org-export-creator-info}
@item @code{:tables} @tab @code{org-export-with-tables}
@item @code{:table-auto-headline} @tab @code{org-export-highlight-first-table-line}
@item @code{:style-include-default} @tab @code{org-export-html-style-include-default}
+@item @code{:style-include-scripts} @tab @code{org-export-html-style-include-scripts}
@item @code{:style} @tab @code{org-export-html-style}
@item @code{:style-extra} @tab @code{org-export-html-style-extra}
@item @code{:convert-org-links} @tab @code{org-export-html-link-org-files-as-html}
@item @code{:inline-images} @tab @code{org-export-html-inline-images}
@item @code{:html-extension} @tab @code{org-export-html-extension}
+@item @code{:html-preamble} @tab @code{org-export-html-preamble}
+@item @code{:html-postamble} @tab @code{org-export-html-postamble}
@item @code{:xml-declaration} @tab @code{org-export-html-xml-declaration}
@item @code{:html-table-tag} @tab @code{org-export-html-table-tag}
@item @code{:expand-quoted-html} @tab @code{org-export-html-expand}
@item @code{:timestamp} @tab @code{org-export-html-with-timestamp}
@item @code{:publishing-directory} @tab @code{org-export-publishing-directory}
-@item @code{:preamble} @tab @code{org-export-html-preamble}
-@item @code{:postamble} @tab @code{org-export-html-postamble}
-@item @code{:auto-preamble} @tab @code{org-export-html-auto-preamble}
-@item @code{:auto-postamble} @tab @code{org-export-html-auto-postamble}
-@item @code{:author} @tab @code{user-full-name}
-@item @code{:email} @tab @code{user-mail-address} : @code{addr;addr;..}
@item @code{:select-tags} @tab @code{org-export-select-tags}
@item @code{:exclude-tags} @tab @code{org-export-exclude-tags}
@item @code{:latex-image-options} @tab @code{org-export-latex-image-default-option}
@end multitable
-Most of the @code{org-export-with-*} variables have the same effect in
-both HTML and La@TeX{} exporters, except for @code{:TeX-macros} and
-@code{:LaTeX-fragments}, respectively @code{nil} and @code{t} in the
-La@TeX{} export.
+Most of the @code{org-export-with-*} variables have the same effect in
+both HTML and @LaTeX{} exporters, except for @code{:TeX-macros} and
+@code{:LaTeX-fragments} options, respectively @code{nil} and @code{t} in the
+@LaTeX{} export. See @code{org-export-plist-vars} to check this list of
+options.
+
+
+
+@vindex org-publish-project-alist
+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, Sitemap, Publishing options, Configuration
+@subsection Links between published files
+@cindex links, publishing
+
+To create a link from one Org file to another, you would use
+something like @samp{[[file:foo.org][The foo]]} or simply
+@samp{file:foo.org.} (@pxref{Hyperlinks}). When published, this link
+becomes a link to @file{foo.html}. In this way, you can interlink the
+pages of your "org web" project and the links will work as expected when
+you publish them to HTML. If you also publish the Org source file and want
+to link to that, use an @code{http:} link instead of a @code{file:} link,
+because @code{file:} links are converted to link to the corresponding
+@file{html} file.
+
+You may also link to related files, such as images. Provided you are careful
+with relative file names, and provided you have also configured Org to upload
+the related files, these links will work too. See @ref{Complex example}, for
+an example of this usage.
+
+Sometimes an Org file to be published may contain links that are
+only valid in your production environment, but not in the publishing
+location. In this case, use the property
+
+@multitable @columnfractions 0.4 0.6
+@item @code{:link-validation-function}
+@tab Function to validate links
+@end multitable
+
+@noindent
+to define a function for checking link validity. This function must
+accept two arguments, the file name and a directory relative to which
+the file name is interpreted in the production environment. If this
+function returns @code{nil}, then the HTML generator will only insert a
+description into the HTML file, but no link. One option for this
+function is @code{org-publish-validate-link} which checks if the given
+file is part of any project in @code{org-publish-project-alist}.
+
+@node Sitemap, Generating an index, Publishing links, Configuration
+@subsection Generating a sitemap
+@cindex sitemap, of published pages
+
+The following properties may be used to control publishing of
+a map of files for a given project.
+
+@multitable @columnfractions 0.35 0.65
+@item @code{:auto-sitemap}
+@tab When non-nil, publish a sitemap during @code{org-publish-current-project}
+or @code{org-publish-all}.
+
+@item @code{:sitemap-filename}
+@tab Filename for output of sitemap. Defaults to @file{sitemap.org} (which
+becomes @file{sitemap.html}).
+
+@item @code{:sitemap-title}
+@tab Title of sitemap page. Defaults to name of file.
+
+@item @code{:sitemap-function}
+@tab Plug-in function to use for generation of the sitemap.
+Defaults to @code{org-publish-org-sitemap}, which generates a plain list
+of links to all files in the project.
+
+@item @code{:sitemap-sort-folders}
+@tab Where folders should appear in the sitemap. Set this to @code{first}
+(default) or @code{last} to display folders first or last,
+respectively. Any other value will mix files and folders.
+
+@item @code{:sitemap-sort-files}
+@tab How the files are sorted in the site map. Set this to
+@code{alphabetically} (default), @code{chronologically} or
+@code{anti-chronologically}. @code{chronologically} sorts the files with
+older date first while @code{anti-chronologically} sorts the files with newer
+date first. @code{alphabetically} sorts the files alphabetically. The date of
+a file is retrieved with @code{org-publish-find-date}.
+
+@item @code{:sitemap-ignore-case}
+@tab Should sorting be case-sensitive? Default @code{nil}.
+
+@item @code{:sitemap-file-entry-format}
+@tab With this option one can tell how a sitemap's entry is formatted in the
+sitemap. This is a format string with some escape sequences: @code{%t} stands
+for the title of the file, @code{%a} stands for the author of the file and
+@code{%d} stands for the date of the file. The date is retrieved with the
+@code{org-publish-find-date} function and formatted with
+@code{org-publish-sitemap-date-format}. Default @code{%t}.
+
+@item @code{:sitemap-date-format}
+@tab Format string for the @code{format-time-string} function that tells how
+a sitemap entry's date is to be formatted. This property bypasses
+@code{org-publish-sitemap-date-format} which defaults to @code{%Y-%m-%d}.
+
+@item @code{:sitemap-sans-extension}
+@tab When non-nil, remove filenames' extensions from the generated sitemap.
+Useful to have cool URIs (see @uref{http://www.w3.org/Provider/Style/URI}).
+Defaults to @code{nil}.
+
+@end multitable
+
+@node Generating an index, , Sitemap, Configuration
+@subsection Generating an index
+@cindex index, in a publishing project
+
+Org-mode can generate an index across the files of a publishing project.
+
+@multitable @columnfractions 0.25 0.75
+@item @code{:makeindex}
+@tab When non-nil, generate in index in the file @file{theindex.org} and
+publish it as @file{theindex.html}.
+@end multitable
+
+The file will be created when first publishing a project with the
+@code{:makeindex} set. The file only contains a statement @code{#+include:
+"theindex.inc"}. You can then build around this include statement by adding
+a title, style information, etc.
+
+@node Uploading files, Sample configuration, Configuration, Publishing
+@section Uploading files
+@cindex rsync
+@cindex unison
+
+For those people already utilizing third party sync tools such as
+@command{rsync} or @command{unison}, it might be preferable not to use the built in
+@i{remote} publishing facilities of Org-mode which rely heavily on
+Tramp. Tramp, while very useful and powerful, tends not to be
+so efficient for multiple file transfer and has been known to cause problems
+under heavy usage.
+
+Specialized synchronization utilities offer several advantages. In addition
+to timestamp comparison, they also do content and permissions/attribute
+checks. For this reason you might prefer to publish your web to a local
+directory (possibly even @i{in place} with your Org files) and then use
+@file{unison} or @file{rsync} to do the synchronization with the remote host.
+
+Since Unison (for example) can be configured as to which files to transfer to
+a certain remote destination, it can greatly simplify the project publishing
+definition. Simply keep all files in the correct location, process your Org
+files with @code{org-publish} and let the synchronization tool do the rest.
+You do not need, in this scenario, to include attachments such as @file{jpg},
+@file{css} or @file{gif} files in the project definition since the 3rd party
+tool syncs them.
+
+Publishing to a local directory is also much faster than to a remote one, so
+that you can afford more easily to republish entire projects. If you set
+@code{org-publish-use-timestamps-flag} to @code{nil}, you gain the main
+benefit of re-including any changed external files such as source example
+files you might include with @code{#+INCLUDE}. The timestamp mechanism in
+Org is not smart enough to detect if included files have been modified.
+
+@node Sample configuration, Triggering publication, Uploading files, Publishing
+@section Sample configuration
+
+Below we provide two example configurations. The first one is a simple
+project publishing only a set of Org files. The second example is
+more complex, with a multi-component project.
+
+@menu
+* Simple example:: One-component publishing
+* Complex example:: A multi-component publishing example
+@end menu
+
+@node Simple example, Complex example, Sample configuration, Sample configuration
+@subsection Example: simple publishing configuration
+
+This example publishes a set of Org files to the @file{public_html}
+directory on the local machine.
+
+@lisp
+(setq org-publish-project-alist
+ '(("org"
+ :base-directory "~/org/"
+ :publishing-directory "~/public_html"
+ :section-numbers nil
+ :table-of-contents nil
+ :style "<link rel=\"stylesheet\"
+ href=\"../other/mystyle.css\"
+ type=\"text/css\"/>")))
+@end lisp
+
+@node Complex example, , Simple example, Sample configuration
+@subsection Example: complex publishing configuration
+
+This more complicated example publishes an entire website, including
+Org files converted to HTML, image files, Emacs Lisp source code, and
+style sheets. The publishing directory is remote and private files are
+excluded.
+
+To ensure that links are preserved, care should be taken to replicate
+your directory structure on the web server, and to use relative file
+paths. For example, if your Org files are kept in @file{~/org} and your
+publishable images in @file{~/images}, you would link to an image with
+@c
+@example
+file:../images/myimage.png
+@end example
+@c
+On the web server, the relative path to the image should be the
+same. You can accomplish this by setting up an "images" folder in the
+right place on the web server, and publishing images to it.
+
+@lisp
+(setq org-publish-project-alist
+ '(("orgfiles"
+ :base-directory "~/org/"
+ :base-extension "org"
+ :publishing-directory "/ssh:user@@host:~/html/notebook/"
+ :publishing-function org-publish-org-to-html
+ :exclude "PrivatePage.org" ;; regexp
+ :headline-levels 3
+ :section-numbers nil
+ :table-of-contents nil
+ :style "<link rel=\"stylesheet\"
+ href=\"../other/mystyle.css\" type=\"text/css\"/>"
+ :html-preamble t)
+
+ ("images"
+ :base-directory "~/images/"
+ :base-extension "jpg\\|gif\\|png"
+ :publishing-directory "/ssh:user@@host:~/html/images/"
+ :publishing-function org-publish-attachment)
+
+ ("other"
+ :base-directory "~/other/"
+ :base-extension "css\\|el"
+ :publishing-directory "/ssh:user@@host:~/html/other/"
+ :publishing-function org-publish-attachment)
+ ("website" :components ("orgfiles" "images" "other"))))
+@end lisp
+
+@node Triggering publication, , Sample configuration, Publishing
+@section Triggering publication
+
+Once properly configured, Org can publish with the following commands:
+
+@table @kbd
+@orgcmd{C-c C-e X,org-publish}
+Prompt for a specific project and publish all files that belong to it.
+@orgcmd{C-c C-e P,org-publish-current-project}
+Publish the project containing the current file.
+@orgcmd{C-c C-e F,org-publish-current-file}
+Publish only the current file.
+@orgcmd{C-c C-e E,org-publish-all}
+Publish every project.
+@end table
+
+@vindex org-publish-use-timestamps-flag
+Org uses timestamps to track when a file has changed. The above functions
+normally only publish changed files. You can override this and force
+publishing of all files by giving a prefix argument to any of the commands
+above, or by customizing the variable @code{org-publish-use-timestamps-flag}.
+This may be necessary in particular if files include other files via
+@code{#+SETUPFILE:} or @code{#+INCLUDE:}.
+
+@comment node-name, next, previous, up
+@comment Working With Source Code, Miscellaneous, Publishing, Top
+
+@node Working With Source Code, Miscellaneous, Publishing, Top
+@chapter Working with source code
+@cindex Schulte, Eric
+@cindex Davison, Dan
+@cindex source code, working with
+
+Source code can be included in Org-mode documents using a @samp{src} block,
+e.g.@:
+
+@example
+#+BEGIN_SRC emacs-lisp
+ (defun org-xor (a b)
+ "Exclusive or."
+ (if a (not b) b))
+#+END_SRC
+@end example
+
+Org-mode provides a number of features for working with live source code,
+including editing of code blocks in their native major-mode, evaluation of
+code blocks, converting code blocks into source files (known as @dfn{tangling}
+in literate programming), and exporting code blocks and their
+results in several formats. This functionality was contributed by Eric
+Schulte and Dan Davison, and was originally named Org-babel.
+
+The following sections describe Org-mode's code block handling facilities.
+
+@menu
+* Structure of code blocks:: Code block syntax described
+* Editing source code:: Language major-mode editing
+* Exporting code blocks:: Export contents and/or results
+* Extracting source code:: Create pure source code files
+* Evaluating code blocks:: Place results of evaluation in the Org-mode buffer
+* Library of Babel:: Use and contribute to a library of useful code blocks
+* Languages:: List of supported code block languages
+* Header arguments:: Configure code block functionality
+* Results of evaluation:: How evaluation results are handled
+* Noweb reference syntax:: Literate programming in Org-mode
+* Key bindings and useful functions:: Work quickly with code blocks
+* Batch execution:: Call functions from the command line
+@end menu
+
+@comment node-name, next, previous, up
+@comment Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
+
+@node Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
+@section Structure of code blocks
+@cindex code block, structure
+@cindex source code, block structure
+
+The structure of code blocks is as follows:
+
+@example
+#+srcname: <name>
+#+begin_src <language> <switches> <header arguments>
+ <body>
+#+end_src
+@end example
+
+Switches and header arguments are optional. Code can also be embedded in text
+inline using
+
+@example
+src_<language>@{<body>@}
+@end example
+
+or
+
+@example
+src_<language>[<header arguments>]@{<body>@}
+@end example
+
+@table @code
+@item <name>
+This name is associated with the code block. This is similar to the
+@samp{#+tblname} lines that can be used to name tables in Org-mode files.
+Referencing the name of a code block makes it possible to evaluate the
+block from other places in the file, other files, or from Org-mode table
+formulas (see @ref{The spreadsheet}). Names are assumed to be unique by
+evaluation functions and the behavior of multiple blocks of the same name is
+undefined.
+@item <language>
+The language of the code in the block.
+@item <switches>
+Optional switches controlling exportation of the code block (see switches discussion in
+@ref{Literal examples})
+@item <header arguments>
+Optional header arguments control many aspects of evaluation, export and
+tangling of code blocks. See the @ref{Header arguments}.
+Header arguments can also be set on a per-buffer or per-subtree
+basis using properties.
+@item <body>
+The source code.
+@end table
+
+@comment node-name, next, previous, up
+@comment Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
+
+@node Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
+@section Editing source code
+@cindex code block, editing
+@cindex source code, editing
+
+@kindex C-c '
+Use @kbd{C-c '} to edit the current code block. This brings up
+a language major-mode edit buffer containing the body of the code
+block. Saving this buffer will write the new contents back to the Org
+buffer. Use @kbd{C-c '} again to exit.
+
+The @code{org-src-mode} minor mode will be active in the edit buffer. The
+following variables can be used to configure the behavior of the edit
+buffer. See also the customization group @code{org-edit-structure} for
+further configuration options.
+
+@table @code
+@item org-src-lang-modes
+If an Emacs major-mode named @code{<lang>-mode} exists, where
+@code{<lang>} is the language named in the header line of the code block,
+then the edit buffer will be placed in that major-mode. This variable
+can be used to map arbitrary language names to existing major modes.
+@item org-src-window-setup
+Controls the way Emacs windows are rearranged when the edit buffer is created.
+@item org-src-preserve-indentation
+This variable is especially useful for tangling languages such as
+Python, in which whitespace indentation in the output is critical.
+@item org-src-ask-before-returning-to-edit-buffer
+By default, Org will ask before returning to an open edit buffer. Set this
+variable to nil to switch without asking.
+@end table
+
+To turn on native code fontification in the @emph{Org} buffer, configure the
+variable @code{org-src-fontify-natively}.
+
+@comment node-name, next, previous, up
+@comment Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
+
+@node Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
+@section Exporting code blocks
+@cindex code block, exporting
+@cindex source code, exporting
+
+It is possible to export the @emph{contents} of code blocks, the
+@emph{results} of code block evaluation, @emph{neither}, or @emph{both}. For
+most languages, the default exports the contents of code blocks. However, for
+some languages (e.g.@: @code{ditaa}) the default exports the results of code
+block evaluation. For information on exporting code block bodies, see
+@ref{Literal examples}.
+
+The @code{:exports} header argument can be used to specify export
+behavior:
+
+@subsubheading Header arguments:
+@table @code
+@item :exports code
+The default in most languages. The body of the code block is exported, as
+described in @ref{Literal examples}.
+@item :exports results
+The code block will be evaluated and the results will be placed in the
+Org-mode buffer for export, either updating previous results of the code
+block located anywhere in the buffer or, if no previous results exist,
+placing the results immediately after the code block. The body of the code
+block will not be exported.
+@item :exports both
+Both the code block and its results will be exported.
+@item :exports none
+Neither the code block nor its results will be exported.
+@end table
+
+It is possible to inhibit the evaluation of code blocks during export.
+Setting the @code{org-export-babel-evaluate} variable to @code{nil} will
+ensure that no code blocks are evaluated as part of the export process. This
+can be useful in situations where potentially untrusted Org-mode files are
+exported in an automated fashion, for example when Org-mode is used as the
+markup language for a wiki.
+
+@comment node-name, next, previous, up
+@comment Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
+@node Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
+@section Extracting source code
+@cindex tangling
+@cindex source code, extracting
+@cindex code block, extracting source code
+
+Creating pure source code files by extracting code from source blocks is
+referred to as ``tangling''---a term adopted from the literate programming
+community. During ``tangling'' of code blocks their bodies are expanded
+using @code{org-babel-expand-src-block} which can expand both variable and
+``noweb'' style references (see @ref{Noweb reference syntax}).
+
+@subsubheading Header arguments
+@table @code
+@item :tangle no
+The default. The code block is not included in the tangled output.
+@item :tangle yes
+Include the code block in the tangled output. The output file name is the
+name of the org file with the extension @samp{.org} replaced by the extension
+for the block language.
+@item :tangle filename
+Include the code block in the tangled output to file @samp{filename}.
+@end table
+
+@kindex C-c C-v t
+@subsubheading Functions
+@table @code
+@item org-babel-tangle
+Tangle the current file. Bound to @kbd{C-c C-v t}.
+@item org-babel-tangle-file
+Choose a file to tangle. Bound to @kbd{C-c C-v f}.
+@end table
+
+@subsubheading Hooks
+@table @code
+@item org-babel-post-tangle-hook
+This hook is run from within code files tangled by @code{org-babel-tangle}.
+Example applications could include post-processing, compilation or evaluation
+of tangled code files.
+@end table
+
+@node Evaluating code blocks, Library of Babel, Extracting source code, Working With Source Code
+@section Evaluating code blocks
+@cindex code block, evaluating
+@cindex source code, evaluating
+
+Code blocks can be evaluated@footnote{Whenever code is evaluated there is a
+potential for that code to do harm. Org-mode provides a number of safeguards
+to ensure that it only evaluates code with explicit confirmation from the
+user. For information on these safeguards (and on how to disable them) see
+@ref{Code evaluation security}.} and the results placed in the Org-mode
+buffer. By default, evaluation is only turned on for @code{emacs-lisp} code
+blocks, however support exists for evaluating blocks in many languages. See
+@ref{Languages} for a list of supported languages. See @ref{Structure of
+code blocks} for information on the syntax used to define a code block.
+
+@kindex C-c C-c
+There are a number of ways to evaluate code blocks. The simplest is to press
+@kbd{C-c C-c} or @kbd{C-c C-v e} with the point on a code block@footnote{The
+@code{org-babel-no-eval-on-ctrl-c-ctrl-c} variable can be used to remove code
+evaluation from the @kbd{C-c C-c} key binding.}. This will call the
+@code{org-babel-execute-src-block} function to evaluate the block and insert
+its results into the Org-mode buffer.
+
+It is also possible to evaluate named code blocks from anywhere in an
+Org-mode buffer or an Org-mode table. @code{#+call} (or synonymously
+@code{#+function} or @code{#+lob}) lines can be used to remotely execute code
+blocks located in the current Org-mode buffer or in the ``Library of Babel''
+(see @ref{Library of Babel}). These lines use the following syntax to place
+a call on a line by itself.
+
+@example
+#+call: <name>(<arguments>)
+#+call: <name>[<header args>](<arguments>) <header args>
+@end example
+
+The following syntax can be used to place these calls within a block of
+prose.
+
+@example
+...prose... call_<name>(<arguments>) ...prose...
+...prose... call_<name>[<header args>](<arguments>)[<header args>] ...prose...
+@end example
+
+@table @code
+@item <name>
+The name of the code block to be evaluated.
+@item <arguments>
+Arguments specified in this section will be passed to the code block. These
+arguments should relate to @code{:var} header arguments in the called code
+block expressed using standard function call syntax. For example if the
+original code block named @code{double} has the header argument @code{:var
+n=2}, then the call line passing the number four to that block would be
+written as @code{#+call: double(n=2)}.
+@item <header args>
+Header arguments can be placed either inside the call to the code block or at
+the end of the line as shown below.
+
+@example
+#+call: code_bloc_name[XXXX](arguments) YYYY
+@end example
+
+Header arguments located in these two locations are treated differently.
+
+@table @code
+@item XXXX
+Those placed in the @code{XXXX} location are passed through and applied to
+the code block being called. These header arguments affect how the code
+block is evaluated, for example @code{[:results output]} will collect the
+results from @code{STDOUT} of the called code block.
+@item YYYY
+Those placed in the @code{YYYY} location are applied to the call line and do
+not affect the code block being called. These header arguments affect how
+the results are incorporated into the Org-mode buffer when the call line is
+evaluated, and how the call line is exported. For example @code{:results
+org} at the end of the call line will insert the results of the call line
+inside of an Org-mode block.
+@end table
+
+For more examples of passing header arguments to @code{#+call:} lines see
+@ref{Header arguments in function calls}.
+@end table
+
+@node Library of Babel, Languages, Evaluating code blocks, Working With Source Code
+@section Library of Babel
+@cindex babel, library of
+@cindex source code, library
+@cindex code block, library
+
+The ``Library of Babel'' is a library of code blocks
+that can be called from any Org-mode file. The library is housed in an
+Org-mode file located in the @samp{contrib} directory of Org-mode.
+Org-mode users can deposit functions they believe to be generally
+useful in the library.
+
+Code blocks defined in the ``Library of Babel'' can be called remotely as if
+they were in the current Org-mode buffer (see @ref{Evaluating code blocks}
+for information on the syntax of remote code block evaluation).
+
+@kindex C-c C-v i
+Code blocks located in any Org-mode file can be loaded into the ``Library of
+Babel'' with the @code{org-babel-lob-ingest} function, bound to @kbd{C-c C-v
+i}.
+
+@node Languages, Header arguments, Library of Babel, Working With Source Code
+@section Languages
+@cindex babel, languages
+@cindex source code, languages
+@cindex code block, languages
+
+Code blocks in the following languages are supported.
+
+@multitable @columnfractions 0.28 0.3 0.22 0.2
+@item @b{Language} @tab @b{Identifier} @tab @b{Language} @tab @b{Identifier}
+@item Asymptote @tab asymptote @tab Awk @tab awk
+@item Emacs Calc @tab calc @tab C @tab C
+@item C++ @tab C++ @tab Clojure @tab clojure
+@item CSS @tab css @tab ditaa @tab ditaa
+@item Graphviz @tab dot @tab Emacs Lisp @tab emacs-lisp
+@item gnuplot @tab gnuplot @tab Haskell @tab haskell
+@item Java @tab java @tab @tab
+@item Javascript @tab js @tab LaTeX @tab latex
+@item Ledger @tab ledger @tab Lisp @tab lisp
+@item Lilypond @tab lilypond @tab MATLAB @tab matlab
+@item Mscgen @tab mscgen @tab Objective Caml @tab ocaml
+@item Octave @tab octave @tab Org-mode @tab org
+@item Oz @tab oz @tab Perl @tab perl
+@item Plantuml @tab plantuml @tab Python @tab python
+@item R @tab R @tab Ruby @tab ruby
+@item Sass @tab sass @tab Scheme @tab scheme
+@item GNU Screen @tab screen @tab shell @tab sh
+@item SQL @tab sql @tab SQLite @tab sqlite
+@end multitable
+
+Language-specific documentation is available for some languages. If
+available, it can be found at
+@uref{http://orgmode.org/worg/org-contrib/babel/languages}.
+
+The @code{org-babel-load-languages} controls which languages are enabled for
+evaluation (by default only @code{emacs-lisp} is enabled). This variable can
+be set using the customization interface or by adding code like the following
+to your emacs configuration.
+
+@quotation
+The following disables @code{emacs-lisp} evaluation and enables evaluation of
+@code{R} code blocks.
+@end quotation
+
+@lisp
+(org-babel-do-load-languages
+ 'org-babel-load-languages
+ '((emacs-lisp . nil)
+ (R . t)))
+@end lisp
+
+It is also possible to enable support for a language by loading the related
+elisp file with @code{require}.
+
+@quotation
+The following adds support for evaluating @code{clojure} code blocks.
+@end quotation
+
+@lisp
+(require 'ob-clojure)
+@end lisp
+
+@node Header arguments, Results of evaluation, Languages, Working With Source Code
+@section Header arguments
+@cindex code block, header arguments
+@cindex source code, block header arguments
+
+Code block functionality can be configured with header arguments. This
+section provides an overview of the use of header arguments, and then
+describes each header argument in detail.
+
+@menu
+* Using header arguments:: Different ways to set header arguments
+* Specific header arguments:: List of header arguments
+@end menu
+
+@node Using header arguments, Specific header arguments, Header arguments, Header arguments
+@subsection Using header arguments
+
+The values of header arguments can be set in six different ways, each more
+specific (and having higher priority) than the last.
+@menu
+* System-wide header arguments:: Set global default values
+* Language-specific header arguments:: Set default values by language
+* Buffer-wide header arguments:: Set default values for a specific buffer
+* Header arguments in Org-mode properties:: Set default values for a buffer or heading
+* Code block specific header arguments:: The most common way to set values
+* Header arguments in function calls:: The most specific level
+@end menu
+
+
+@node System-wide header arguments, Language-specific header arguments, Using header arguments, Using header arguments
+@subsubheading System-wide header arguments
+@vindex org-babel-default-header-args
+System-wide values of header arguments can be specified by customizing the
+@code{org-babel-default-header-args} variable:
+
+@example
+:session => "none"
+:results => "replace"
+:exports => "code"
+:cache => "no"
+:noweb => "no"
+@end example
+
+@c @example
+@c org-babel-default-header-args is a variable defined in `org-babel.el'.
+@c Its value is
+@c ((:session . "none")
+@c (:results . "replace")
+@c (:exports . "code")
+@c (:cache . "no")
+@c (:noweb . "no"))
+
+
+@c Documentation:
+@c Default arguments to use when evaluating a code block.
+@c @end example
+
+For example, the following example could be used to set the default value of
+@code{:noweb} header arguments to @code{yes}. This would have the effect of
+expanding @code{:noweb} references by default when evaluating source code
+blocks.
+
+@lisp
+(setq org-babel-default-header-args
+(cons '(:noweb . "yes")
+(assq-delete-all :noweb org-babel-default-header-args)))
+@end lisp
+
+@node Language-specific header arguments, Buffer-wide header arguments, System-wide header arguments, Using header arguments
+@subsubheading Language-specific header arguments
+Each language can define its own set of default header arguments. See the
+language-specific documentation available online at
+@uref{http://orgmode.org/worg/org-contrib/babel}.
+
+@node Buffer-wide header arguments, Header arguments in Org-mode properties, Language-specific header arguments, Using header arguments
+@subsubheading Buffer-wide header arguments
+Buffer-wide header arguments may be specified through the use of a special
+line placed anywhere in an Org-mode file. The line consists of the
+@code{#+BABEL:} keyword followed by a series of header arguments which may be
+specified using the standard header argument syntax.
+
+For example the following would set @code{session} to @code{*R*}, and
+@code{results} to @code{silent} for every code block in the buffer, ensuring
+that all execution took place in the same session, and no results would be
+inserted into the buffer.
+
+@example
+#+BABEL: :session *R* :results silent
+@end example
+
+@node Header arguments in Org-mode properties, Code block specific header arguments, Buffer-wide header arguments, Using header arguments
+@subsubheading Header arguments in Org-mode properties
+
+Header arguments are also read from Org-mode properties (see @ref{Property
+syntax}), which can be set on a buffer-wide or per-heading basis. An example
+of setting a header argument for all code blocks in a buffer is
+
+@example
+#+property: tangle yes
+@end example
+
+When properties are used to set default header arguments, they are looked up
+with inheritance, so the value of the @code{:cache} header argument will default
+to @code{yes} in all code blocks in the subtree rooted at the following
+heading:
+
+@example
+* outline header
+:PROPERTIES:
+:cache: yes
+:END:
+@end example
+
+@kindex C-c C-x p
+@vindex org-babel-default-header-args
+Properties defined in this way override the properties set in
+@code{org-babel-default-header-args}. It is convenient to use the
+@code{org-set-property} function bound to @kbd{C-c C-x p} to set properties
+in Org-mode documents.
+
+@node Code block specific header arguments, Header arguments in function calls, Header arguments in Org-mode properties, Using header arguments
+@subsubheading Code block specific header arguments
+
+The most common way to assign values to header arguments is at the
+code block level. This can be done by listing a sequence of header
+arguments and their values as part of the @code{#+begin_src} line.
+Properties set in this way override both the values of
+@code{org-babel-default-header-args} and header arguments specified as
+properties. In the following example, the @code{:results} header argument
+is set to @code{silent}, meaning the results of execution will not be
+inserted in the buffer, and the @code{:exports} header argument is set to
+@code{code}, meaning only the body of the code block will be
+preserved on export to HTML or LaTeX.
+
+@example
+#+source: factorial
+#+begin_src haskell :results silent :exports code :var n=0
+fac 0 = 1
+fac n = n * fac (n-1)
+#+end_src
+@end example
+Similarly, it is possible to set header arguments for inline code blocks:
+
+@example
+src_haskell[:exports both]@{fac 5@}
+@end example
+
+Code block header arguments can span multiple lines using =#+header:= or
+=#+headers:= lines preceding a code block or nested in between the name and
+body of a named code block.
+
+Multi-line header arguments on an un-named code block:
+@example
+ #+headers: :var data1=1
+ #+begin_src emacs-lisp :var data2=2
+ (message "data1:%S, data2:%S" data1 data2)
+ #+end_src
+
+ #+results:
+ : data1:1, data2:2
+@end example
+
+Multi-line header arguments on a named code block:
+@example
+ #+source: named-block
+ #+header: :var data=2
+ #+begin_src emacs-lisp
+ (message "data:%S" data)
+ #+end_src
+
+ #+results: named-block
+ : data:2
+@end example
+
+@node Header arguments in function calls, , Code block specific header arguments, Using header arguments
+@comment node-name, next, previous, up
+@subsubheading Header arguments in function calls
+
+At the most specific level, header arguments for ``Library of Babel'' or
+function call lines can be set as shown in the two examples below. For more
+information on the structure of @code{#+call:} lines see @ref{Evaluating code
+blocks}.
+
+The following will apply the @code{:exports results} header argument to the
+evaluation of the @code{#+call:} line.
+@example
+#+call: factorial(n=5) :exports results
+@end example
+
+The following will apply the @code{:session special} header argument to the
+evaluation of the @code{factorial} code block.
+@example
+#+call: factorial[:session special](n=5)
+@end example
+
+@node Specific header arguments, , Using header arguments, Header arguments
+@subsection Specific header arguments
+The following header arguments are defined:
+
+@menu
+* var:: Pass arguments to code blocks
+* results:: Specify the type of results and how they will
+ be collected and handled
+* file:: Specify a path for file output
+* dir:: Specify the default (possibly remote)
+ directory for code block execution
+* exports:: Export code and/or results
+* tangle:: Toggle tangling and specify file name
+* mkdirp:: Toggle creation of parent directories of target
+ files during tangling
+* comments:: Toggle insertion of comments in tangled
+ code files
+* padline:: Control insertion of padding lines in tangled
+ code files
+* no-expand:: Turn off variable assignment and noweb
+ expansion during tangling
+* session:: Preserve the state of code evaluation
+* noweb:: Toggle expansion of noweb references
+* noweb-ref:: Specify block's noweb reference resolution target
+* cache:: Avoid re-evaluating unchanged code blocks
+* sep:: Delimiter for writing tabular results outside Org
+* hlines:: Handle horizontal lines in tables
+* colnames:: Handle column names in tables
+* rownames:: Handle row names in tables
+* shebang:: Make tangled files executable
+* eval:: Limit evaluation of specific code blocks
+@end menu
+
+Additional header arguments are defined on a language-specific basis, see
+@ref{Languages}.
+
+@node var, results, Specific header arguments, Specific header arguments
+@subsubsection @code{:var}
+The @code{:var} header argument is used to pass arguments to code blocks.
+The specifics of how arguments are included in a code block vary by language;
+these are addressed in the language-specific documentation. However, the
+syntax used to specify arguments is the same across all languages. The
+values passed to arguments can be literal values, values from org-mode tables
+and literal example blocks, the results of other code blocks, or Emacs Lisp
+code---see the ``Emacs Lisp evaluation of variables'' heading below.
+
+These values can be indexed in a manner similar to arrays---see the
+``indexable variable values'' heading below.
+
+The following syntax is used to pass arguments to code blocks using the
+@code{:var} header argument.
+
+@example
+:var name=assign
+@end example
+
+where @code{assign} can take one of the following forms
+
+@itemize @bullet
+@item literal value
+either a string @code{"string"} or a number @code{9}.
+@item reference
+a table name:
+
+@example
+#+tblname: example-table
+| 1 |
+| 2 |
+| 3 |
+| 4 |
+
+#+source: table-length
+#+begin_src emacs-lisp :var table=example-table
+(length table)
+#+end_src
+
+#+results: table-length
+: 4
+@end example
+
+a code block name, as assigned by @code{#+srcname:}, followed by
+parentheses:
+
+@example
+#+begin_src emacs-lisp :var length=table-length()
+(* 2 length)
+#+end_src
+
+#+results:
+: 8
+@end example
+
+In addition, an argument can be passed to the code block referenced
+by @code{:var}. The argument is passed within the parentheses following the
+code block name:
+
+@example
+#+source: double
+#+begin_src emacs-lisp :var input=8
+(* 2 input)
+#+end_src
+
+#+results: double
+: 16
+
+#+source: squared
+#+begin_src emacs-lisp :var input=double(input=1)
+(* input input)
+#+end_src
+
+#+results: squared
+: 4
+@end example
+@end itemize
+
+@subsubheading Alternate argument syntax
+It is also possible to specify arguments in a potentially more natural way
+using the @code{#+source:} line of a code block. As in the following
+example arguments can be packed inside of parenthesis, separated by commas,
+following the source name.
+
+@example
+#+source: double(input=0, x=2)
+#+begin_src emacs-lisp
+(* 2 (+ input x))
+#+end_src
+@end example
+
+@subsubheading Indexable variable values
+It is possible to reference portions of variable values by ``indexing'' into
+the variables. Indexes are 0 based with negative values counting back from
+the end. If an index is separated by @code{,}s then each subsequent section
+will index into the next deepest nesting or dimension of the value. Note
+that this indexing occurs @emph{before} other table related header arguments
+like @code{:hlines}, @code{:colnames} and @code{:rownames} are applied. The
+following example assigns the last cell of the first row the table
+@code{example-table} to the variable @code{data}:
+
+@example
+#+results: example-table
+| 1 | a |
+| 2 | b |
+| 3 | c |
+| 4 | d |
+
+#+begin_src emacs-lisp :var data=example-table[0,-1]
+ data
+#+end_src
+
+#+results:
+: a
+@end example
+
+Ranges of variable values can be referenced using two integers separated by a
+@code{:}, in which case the entire inclusive range is referenced. For
+example the following assigns the middle three rows of @code{example-table}
+to @code{data}.
+
+@example
+#+results: example-table
+| 1 | a |
+| 2 | b |
+| 3 | c |
+| 4 | d |
+| 5 | 3 |
+
+#+begin_src emacs-lisp :var data=example-table[1:3]
+ data
+#+end_src
+
+#+results:
+| 2 | b |
+| 3 | c |
+| 4 | d |
+@end example
+
+Additionally, an empty index, or the single character @code{*}, are both
+interpreted to mean the entire range and as such are equivalent to
+@code{0:-1}, as shown in the following example in which the entire first
+column is referenced.
+
+@example
+#+results: example-table
+| 1 | a |
+| 2 | b |
+| 3 | c |
+| 4 | d |
+
+#+begin_src emacs-lisp :var data=example-table[,0]
+ data
+#+end_src
+
+#+results:
+| 1 | 2 | 3 | 4 |
+@end example
+
+It is possible to index into the results of code blocks as well as tables.
+Any number of dimensions can be indexed. Dimensions are separated from one
+another by commas, as shown in the following example.
+
+@example
+#+source: 3D
+#+begin_src emacs-lisp
+ '(((1 2 3) (4 5 6) (7 8 9))
+ ((10 11 12) (13 14 15) (16 17 18))
+ ((19 20 21) (22 23 24) (25 26 27)))
+#+end_src
+
+#+begin_src emacs-lisp :var data=3D[1,,1]
+ data
+#+end_src
+
+#+results:
+| 11 | 14 | 17 |
+@end example
+
+@subsubheading Emacs Lisp evaluation of variables
+
+Emacs lisp code can be used to initialize variable values. When a variable
+value starts with @code{(}, @code{[}, @code{'} or @code{`} it will be evaluated as
+Emacs Lisp and the result of the evaluation will be assigned as the variable
+value. The following example demonstrates use of this evaluation to reliably
+pass the file-name of the org-mode buffer to a code block---note that
+evaluation of header arguments is guaranteed to take place in the original
+org-mode file, while there is no such guarantee for evaluation of the code
+block body.
+
+@example
+#+begin_src sh :var filename=(buffer-file-name) :exports both
+ wc -w $filename
+#+end_src
+@end example
+
+Note that values read from tables and lists will not be evaluated as
+Emacs Lisp, as shown in the following example.
+
+@example
+#+results: table
+| (a b c) |
+
+#+headers: :var data=table[0,0]
+#+begin_src perl
+ $data
+#+end_src
+
+#+results:
+: (a b c)
+@end example
+
+@node results, file, var, Specific header arguments
+@subsubsection @code{:results}
+
+There are three classes of @code{:results} header argument. Only one option
+per class may be supplied per code block.
+
+@itemize @bullet
+@item
+@b{collection} header arguments specify how the results should be collected
+from the code block
+@item
+@b{type} header arguments specify what type of result the code block will
+return---which has implications for how they will be inserted into the
+Org-mode buffer
+@item
+@b{handling} header arguments specify how the results of evaluating the code
+block should be handled.
+@end itemize
+
+@subsubheading Collection
+The following options are mutually exclusive, and specify how the results
+should be collected from the code block.
+
+@itemize @bullet
+@item @code{value}
+This is the default. The result is the value of the last statement in the
+code block. This header argument places the evaluation in functional
+mode. Note that in some languages, e.g., Python, use of this result type
+requires that a @code{return} statement be included in the body of the source
+code block. E.g., @code{:results value}.
+@item @code{output}
+The result is the collection of everything printed to STDOUT during the
+execution of the code block. This header argument places the
+evaluation in scripting mode. E.g., @code{:results output}.
+@end itemize
+
+@subsubheading Type
+
+The following options are mutually exclusive and specify what type of results
+the code block will return. By default, results are inserted as either a
+table or scalar depending on their value.
+
+@itemize @bullet
+@item @code{table}, @code{vector}
+The results should be interpreted as an Org-mode table. If a single value is
+returned, it will be converted into a table with one row and one column.
+E.g., @code{:results value table}.
+@item @code{list}
+The results should be interpreted as an Org-mode list. If a single scalar
+value is returned it will be converted into a list with only one element.
+@item @code{scalar}, @code{verbatim}
+The results should be interpreted literally---they will not be
+converted into a table. The results will be inserted into the Org-mode
+buffer as quoted text. E.g., @code{:results value verbatim}.
+@item @code{file}
+The results will be interpreted as the path to a file, and will be inserted
+into the Org-mode buffer as a file link. E.g., @code{:results value file}.
+@item @code{raw}, @code{org}
+The results are interpreted as raw Org-mode code and are inserted directly
+into the buffer. If the results look like a table they will be aligned as
+such by Org-mode. E.g., @code{:results value raw}.
+@item @code{html}
+Results are assumed to be HTML and will be enclosed in a @code{begin_html}
+block. E.g., @code{:results value html}.
+@item @code{latex}
+Results assumed to be LaTeX and are enclosed in a @code{begin_latex} block.
+E.g., @code{:results value latex}.
+@item @code{code}
+Result are assumed to be parseable code and are enclosed in a code block.
+E.g., @code{:results value code}.
+@item @code{pp}
+The result is converted to pretty-printed code and is enclosed in a code
+block. This option currently supports Emacs Lisp, Python, and Ruby. E.g.,
+@code{:results value pp}.
+@item @code{wrap}
+The result is wrapped in a @code{begin_result} block. This can be useful for
+inserting @code{raw} or @code{org} syntax results in such a way that their
+extend is known and they can be automatically removed or replaced.
+@end itemize
+
+@subsubheading Handling
+The following results options indicate what happens with the
+results once they are collected.
+
+@itemize @bullet
+@item @code{silent}
+The results will be echoed in the minibuffer but will not be inserted into
+the Org-mode buffer. E.g., @code{:results output silent}.
+@item @code{replace}
+The default value. Any existing results will be removed, and the new results
+will be inserted into the Org-mode buffer in their place. E.g.,
+@code{:results output replace}.
+@item @code{append}
+If there are pre-existing results of the code block then the new results will
+be appended to the existing results. Otherwise the new results will be
+inserted as with @code{replace}.
+@item @code{prepend}
+If there are pre-existing results of the code block then the new results will
+be prepended to the existing results. Otherwise the new results will be
+inserted as with @code{replace}.
+@end itemize
+
+@node file, dir, results, Specific header arguments
+@subsubsection @code{:file}
+
+The header argument @code{:file} is used to specify an external file in which
+to save code block results. After code block evaluation an Org-mode style
+@code{[[file:]]} link (see @ref{Link format}) to the file will be inserted
+into the Org-mode buffer. Some languages including R, gnuplot, dot, and
+ditaa provide special handling of the @code{:file} header argument
+automatically wrapping the code block body in the boilerplate code required
+to save output to the specified file. This is often useful for saving
+graphical output of a code block to the specified file.
+
+The argument to @code{:file} should be either a string specifying the path to
+a file, or a list of two strings in which case the first element of the list
+should be the path to a file and the second a description for the link.
+
+@node dir, exports, file, Specific header arguments
+@subsubsection @code{:dir} and remote execution
+
+While the @code{:file} header argument can be used to specify the path to the
+output file, @code{:dir} specifies the default directory during code block
+execution. If it is absent, then the directory associated with the current
+buffer is used. In other words, supplying @code{:dir path} temporarily has
+the same effect as changing the current directory with @kbd{M-x cd path}, and
+then not supplying @code{:dir}. Under the surface, @code{:dir} simply sets
+the value of the Emacs variable @code{default-directory}.
+
+When using @code{:dir}, you should supply a relative path for file output
+(e.g.@: @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which
+case that path will be interpreted relative to the default directory.
+
+In other words, if you want your plot to go into a folder called @file{Work}
+in your home directory, you could use
+
+@example
+#+begin_src R :file myplot.png :dir ~/Work
+matplot(matrix(rnorm(100), 10), type="l")
+#+end_src
+@end example
+
+@subsubheading Remote execution
+A directory on a remote machine can be specified using tramp file syntax, in
+which case the code will be evaluated on the remote machine. An example is
+
+@example
+#+begin_src R :file plot.png :dir /dand@@yakuba.princeton.edu:
+plot(1:10, main=system("hostname", intern=TRUE))
+#+end_src
+@end example
+
+Text results will be returned to the local Org-mode buffer as usual, and file
+output will be created on the remote machine with relative paths interpreted
+relative to the remote directory. An Org-mode link to the remote file will be
+created.
+
+So, in the above example a plot will be created on the remote machine,
+and a link of the following form will be inserted in the org buffer:
+
+@example
+[[file:/scp:dand@@yakuba.princeton.edu:/home/dand/plot.png][plot.png]]
+@end example
+
+Most of this functionality follows immediately from the fact that @code{:dir}
+sets the value of the Emacs variable @code{default-directory}, thanks to
+tramp. Those using XEmacs, or GNU Emacs prior to version 23 may need to
+install tramp separately in order for these features to work correctly.
+
+@subsubheading Further points
+
+@itemize @bullet
+@item
+If @code{:dir} is used in conjunction with @code{:session}, although it will
+determine the starting directory for a new session as expected, no attempt is
+currently made to alter the directory associated with an existing session.
+@item
+@code{:dir} should typically not be used to create files during export with
+@code{:exports results} or @code{:exports both}. The reason is that, in order
+to retain portability of exported material between machines, during export
+links inserted into the buffer will *not* be expanded against @code{default
+directory}. Therefore, if @code{default-directory} is altered using
+@code{:dir}, it is probable that the file will be created in a location to
+which the link does not point.
+@end itemize
+
+@node exports, tangle, dir, Specific header arguments
+@subsubsection @code{:exports}
+
+The @code{:exports} header argument specifies what should be included in HTML
+or LaTeX exports of the Org-mode file.
+
+@itemize @bullet
+@item @code{code}
+The default. The body of code is included into the exported file. E.g.,
+@code{:exports code}.
+@item @code{results}
+The result of evaluating the code is included in the exported file. E.g.,
+@code{:exports results}.
+@item @code{both}
+Both the code and results are included in the exported file. E.g.,
+@code{:exports both}.
+@item @code{none}
+Nothing is included in the exported file. E.g., @code{:exports none}.
+@end itemize
+
+@node tangle, mkdirp, exports, Specific header arguments
+@subsubsection @code{:tangle}
+
+The @code{:tangle} header argument specifies whether or not the code
+block should be included in tangled extraction of source code files.
+
+@itemize @bullet
+@item @code{tangle}
+The code block is exported to a source code file named after the full path
+(including the directory) and file name (w/o extension) of the Org-mode file.
+E.g., @code{:tangle yes}.
+@item @code{no}
+The default. The code block is not exported to a source code file.
+E.g., @code{:tangle no}.
+@item other
+Any other string passed to the @code{:tangle} header argument is interpreted
+as a path (directory and file name relative to the directory of the Org-mode
+file) to which the block will be exported. E.g., @code{:tangle path}.
+@end itemize
+
+@node mkdirp, comments, tangle, Specific header arguments
+@subsubsection @code{:mkdirp}
+
+The @code{:mkdirp} header argument can be used to create parent directories
+of tangled files when missing. This can be set to @code{yes} to enable
+directory creation or to @code{no} to inhibit directory creation.
+
+@node comments, padline, mkdirp, Specific header arguments
+@subsubsection @code{:comments}
+By default code blocks are tangled to source-code files without any insertion
+of comments beyond those which may already exist in the body of the code
+block. The @code{:comments} header argument can be set as follows to control
+the insertion of extra comments into the tangled code file.
+
+@itemize @bullet
+@item @code{no}
+The default. No extra comments are inserted during tangling.
+@item @code{link}
+The code block is wrapped in comments which contain pointers back to the
+original Org file from which the code was tangled.
+@item @code{yes}
+A synonym for ``link'' to maintain backwards compatibility.
+@item @code{org}
+Include text from the org-mode file as a comment.
+
+The text is picked from the leading context of the tangled code and is
+limited by the nearest headline or source block as the case may be.
+@item @code{both}
+Turns on both the ``link'' and ``org'' comment options.
+@item @code{noweb}
+Turns on the ``link'' comment option, and additionally wraps expanded noweb
+references in the code block body in link comments.
+@end itemize
+
+@node padline, no-expand, comments, Specific header arguments
+@subsubsection @code{:padline}
+Control in insertion of padding lines around code block bodies in tangled
+code files. The default value is @code{yes} which results in insertion of
+newlines before and after each tangled code block. The following arguments
+are accepted.
+
+@itemize @bullet
+@item @code{yes}
+Insert newlines before and after each code block body in tangled code files.
+@item @code{no}
+Do not insert any newline padding in tangled output.
+@end itemize
+
+@node no-expand, session, padline, Specific header arguments
+@subsubsection @code{:no-expand}
+
+By default, code blocks are expanded with @code{org-babel-expand-src-block}
+during tangling. This has the effect of assigning values to variables
+specified with @code{:var} (see @ref{var}), and of replacing ``noweb''
+references (see @ref{Noweb reference syntax}) with their targets. The
+@code{:no-expand} header argument can be used to turn off this behavior.
+
+@node session, noweb, no-expand, Specific header arguments
+@subsubsection @code{:session}
+
+The @code{:session} header argument starts a session for an interpreted
+language where state is preserved.
+
+By default, a session is not started.
+
+A string passed to the @code{:session} header argument will give the session
+a name. This makes it possible to run concurrent sessions for each
+interpreted language.
+
+@node noweb, noweb-ref, session, Specific header arguments
+@subsubsection @code{:noweb}
+
+The @code{:noweb} header argument controls expansion of ``noweb'' style (see
+@ref{Noweb reference syntax}) references in a code block. This header
+argument can have one of three values: @code{yes}, @code{no}, or @code{tangle}.
+
+@itemize @bullet
+@item @code{yes}
+All ``noweb'' syntax references in the body of the code block will be
+expanded before the block is evaluated, tangled or exported.
+@item @code{no}
+The default. No ``noweb'' syntax specific action is taken on evaluating
+code blocks, However, noweb references will still be expanded during
+tangling.
+@item @code{tangle}
+All ``noweb'' syntax references in the body of the code block will be
+expanded before the block is tangled, however ``noweb'' references will not
+be expanded when the block is evaluated or exported.
+@end itemize
+
+@subsubheading Noweb prefix lines
+Noweb insertions are now placed behind the line prefix of the
+@code{<<reference>>}.
+This behavior is illustrated in the following example. Because the
+@code{<<example>>} noweb reference appears behind the SQL comment syntax,
+each line of the expanded noweb reference will be commented.
+
+This code block:
+
+@example
+-- <<example>>
+@end example
+
+
+expands to:
+
+@example
+-- this is the
+-- multi-line body of example
+@end example
+
+Note that noweb replacement text that does not contain any newlines will not
+be affected by this change, so it is still possible to use inline noweb
+references.
+
+@node noweb-ref, cache, noweb, Specific header arguments
+@subsubsection @code{:noweb-ref}
+When expanding ``noweb'' style references the bodies of all code block with
+@emph{either} a block name matching the reference name @emph{or} a
+@code{:noweb-ref} header argument matching the reference name will be
+concatenated together to form the replacement text.
+
+By setting this header argument at the sub-tree or file level, simple code
+block concatenation may be achieved. For example, when tangling the
+following Org-mode file, the bodies of code blocks will be concatenated into
+the resulting pure code file.
+
+@example
+ #+begin_src sh :tangle yes :noweb yes :shebang #!/bin/sh
+ <<fullest-disk>>
+ #+end_src
+ * the mount point of the fullest disk
+ :PROPERTIES:
+ :noweb-ref: fullest-disk
+ :END:
+
+ ** query all mounted disks
+ #+begin_src sh
+ df \
+ #+end_src
-@vindex org-publish-project-alist
-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.
+ ** strip the header row
+ #+begin_src sh
+ |sed '1d' \
+ #+end_src
-@node Publishing links, Project page index, Publishing options, Configuration
-@subsection Links between published files
-@cindex links, publishing
+ ** sort by the percent full
+ #+begin_src sh
+ |awk '@{print $5 " " $6@}'|sort -n |tail -1 \
+ #+end_src
-To create a link from one Org file to another, you would use
-something like @samp{[[file:foo.org][The foo]]} or simply
-@samp{file:foo.org.} (@pxref{Hyperlinks}). When published, this link
-becomes a link to @file{foo.html}. In this way, you can interlink the
-pages of your "org web" project and the links will work as expected when
-you publish them to HTML. If you also publish the Org source file and want
-to link to that, use an @code{http:} link instead of a @code{file:} link,
-because @code{file:} links are converted to link to the corresponding
-@file{html} file.
+ ** extract the mount point
+ #+begin_src sh
+ |awk '@{print $2@}'
+ #+end_src
+@end example
-You may also link to related files, such as images. Provided you are careful
-with relative file names, and provided you have also configured Org to upload
-the related files, these links will work too. See @ref{Complex example}, for
-an example of this usage.
+@node cache, sep, noweb-ref, Specific header arguments
+@subsubsection @code{:cache}
-Sometimes an Org file to be published may contain links that are
-only valid in your production environment, but not in the publishing
-location. In this case, use the property
+The @code{:cache} header argument controls the use of in-buffer caching of
+the results of evaluating code blocks. It can be used to avoid re-evaluating
+unchanged code blocks. This header argument can have one of two
+values: @code{yes} or @code{no}.
-@multitable @columnfractions 0.4 0.6
-@item @code{:link-validation-function}
-@tab Function to validate links
-@end multitable
+@itemize @bullet
+@item @code{no}
+The default. No caching takes place, and the code block will be evaluated
+every time it is called.
+@item @code{yes}
+Every time the code block is run a SHA1 hash of the code and arguments
+passed to the block will be generated. This hash is packed into the
+@code{#+results:} line and will be checked on subsequent
+executions of the code block. If the code block has not
+changed since the last time it was evaluated, it will not be re-evaluated.
+@end itemize
-@noindent
-to define a function for checking link validity. This function must
-accept two arguments, the file name and a directory relative to which
-the file name is interpreted in the production environment. If this
-function returns @code{nil}, then the HTML generator will only insert a
-description into the HTML file, but no link. One option for this
-function is @code{org-publish-validate-link} which checks if the given
-file is part of any project in @code{org-publish-project-alist}.
+Code block caches notice if the value of a variable argument
+to the code block has changed. If this is the case, the cache is
+invalidated and the code block is re-run. In the following example,
+@code{caller} will not be re-run unless the results of @code{random} have
+changed since it was last run.
-@node Project page index, , Publishing links, Configuration
-@subsection Project page index
-@cindex index, of published pages
+@example
+ #+srcname: random
+ #+begin_src R :cache yes
+ runif(1)
+ #+end_src
-The following properties may be used to control publishing of an
-index of files or a summary page for a given project.
+ #+results[a2a72cd647ad44515fab62e144796432793d68e1]: random
+ 0.4659510825295
-@multitable @columnfractions 0.25 0.75
-@item @code{:auto-index}
-@tab When non-nil, publish an index during @code{org-publish-current-project}
-or @code{org-publish-all}.
+ #+srcname: caller
+ #+begin_src emacs-lisp :var x=random :cache yes
+ x
+ #+end_src
-@item @code{:index-filename}
-@tab Filename for output of index. Defaults to @file{sitemap.org} (which
-becomes @file{sitemap.html}).
+ #+results[bec9c8724e397d5df3b696502df3ed7892fc4f5f]: caller
+ 0.254227238707244
+@end example
-@item @code{:index-title}
-@tab Title of index page. Defaults to name of file.
+@node sep, hlines, cache, Specific header arguments
+@subsubsection @code{:sep}
-@item @code{:index-function}
-@tab Plug-in function to use for generation of index.
-Defaults to @code{org-publish-org-index}, which generates a plain list
-of links to all files in the project.
-@end multitable
+The @code{:sep} header argument can be used to control the delimiter used
+when writing tabular results out to files external to Org-mode. This is used
+either when opening tabular results of a code block by calling the
+@code{org-open-at-point} function bound to @kbd{C-c C-o} on the code block,
+or when writing code block results to an external file (see @ref{file})
+header argument.
-@node Uploading files, Sample configuration, Configuration, Publishing
-@section Uploading files
-@cindex rsync
-@cindex unison
+By default, when @code{:sep} is not specified output tables are tab
+delimited.
-For those people already utilizing third party sync tools such as
-@command{rsync} or @command{unison}, it might be preferable not to use the built in
-@i{remote} publishing facilities of Org mode which rely heavily on
-Tramp. Tramp, while very useful and powerful, tends not to be
-so efficient for multiple file transfer and has been known to cause problems
-under heavy usage.
+@node hlines, colnames, sep, Specific header arguments
+@subsubsection @code{:hlines}
-Specialized synchronization utilities offer several advantages. In addition
-to timestamp comparison, they also do content and permissions/attribute
-checks. For this reason you might prefer to publish your web to a local
-directory (possibly even @i{in place} with your Org files) and then use
-@file{unison} or @file{rsync} to do the synchronization with the remote host.
+Tables are frequently represented with one or more horizontal lines, or
+hlines. The @code{:hlines} argument to a code block accepts the
+values @code{yes} or @code{no}, with a default value of @code{no}.
-Since Unison (for example) can be configured as to which files to transfer to
-a certain remote destination, it can greatly simplify the project publishing
-definition. Simply keep all files in the correct location, process your Org
-files with @code{org-publish} and let the synchronization tool do the rest.
-You do not need, in this scenario, to include attachments such as @file{jpg},
-@file{css} or @file{gif} files in the project definition since the 3rd party
-tool syncs them.
+@itemize @bullet
+@item @code{no}
+Strips horizontal lines from the input table. In most languages this is the
+desired effect because an @code{hline} symbol is interpreted as an unbound
+variable and raises an error. Setting @code{:hlines no} or relying on the
+default value yields the following results.
+
+@example
+#+tblname: many-cols
+| a | b | c |
+|---+---+---|
+| d | e | f |
+|---+---+---|
+| g | h | i |
+
+#+source: echo-table
+#+begin_src python :var tab=many-cols
+ return tab
+#+end_src
+
+#+results: echo-table
+| a | b | c |
+| d | e | f |
+| g | h | i |
+@end example
+
+@item @code{yes}
+Leaves hlines in the table. Setting @code{:hlines yes} has this effect.
+
+@example
+#+tblname: many-cols
+| a | b | c |
+|---+---+---|
+| d | e | f |
+|---+---+---|
+| g | h | i |
+
+#+source: echo-table
+#+begin_src python :var tab=many-cols :hlines yes
+ return tab
+#+end_src
+
+#+results: echo-table
+| a | b | c |
+|---+---+---|
+| d | e | f |
+|---+---+---|
+| g | h | i |
+@end example
+@end itemize
-Publishing to a local directory is also much faster than to a remote one, so
-that you can afford more easily to republish entire projects. If you set
-@code{org-publish-use-timestamps-flag} to @code{nil}, you gain the main
-benefit of re-including any changed external files such as source example
-files you might include with @code{#+INCLUDE}. The timestamp mechanism in
-Org is not smart enough to detect if included files have been modified.
+@node colnames, rownames, hlines, Specific header arguments
+@subsubsection @code{:colnames}
-@node Sample configuration, Triggering publication, Uploading files, Publishing
-@section Sample configuration
+The @code{:colnames} header argument accepts the values @code{yes},
+@code{no}, or @code{nil} for unassigned. The default value is @code{nil}.
-Below we provide two example configurations. The first one is a simple
-project publishing only a set of Org files. The second example is
-more complex, with a multi-component project.
+@itemize @bullet
+@item @code{nil}
+If an input table looks like it has column names
+(because its second row is an hline), then the column
+names will be removed from the table before
+processing, then reapplied to the results.
-@menu
-* Simple example:: One-component publishing
-* Complex example:: A multi-component publishing example
-@end menu
+@example
+#+tblname: less-cols
+| a |
+|---|
+| b |
+| c |
-@node Simple example, Complex example, Sample configuration, Sample configuration
-@subsection Example: simple publishing configuration
+#+srcname: echo-table-again
+#+begin_src python :var tab=less-cols
+ return [[val + '*' for val in row] for row in tab]
+#+end_src
-This example publishes a set of Org files to the @file{public_html}
-directory on the local machine.
+#+results: echo-table-again
+| a |
+|----|
+| b* |
+| c* |
+@end example
-@lisp
-(setq org-publish-project-alist
- '(("org"
- :base-directory "~/org/"
- :publishing-directory "~/public_html"
- :section-numbers nil
- :table-of-contents nil
- :style "<link rel=\"stylesheet\"
- href=\"../other/mystyle.css\"
- type=\"text/css\"/>")))
-@end lisp
+Please note that column names are not removed before the table is indexed
+using variable indexing @xref{var, Indexable variable values}.
-@node Complex example, , Simple example, Sample configuration
-@subsection Example: complex publishing configuration
+@item @code{no}
+No column name pre-processing takes place
-This more complicated example publishes an entire website, including
-Org files converted to HTML, image files, Emacs Lisp source code, and
-style sheets. The publishing directory is remote and private files are
-excluded.
+@item @code{yes}
+Column names are removed and reapplied as with @code{nil} even if the table
+does not ``look like'' it has column names (i.e.@: the second row is not an
+hline)
+@end itemize
+
+@node rownames, shebang, colnames, Specific header arguments
+@subsubsection @code{:rownames}
+
+The @code{:rownames} header argument can take on the values @code{yes}
+or @code{no}, with a default value of @code{no}.
+
+@itemize @bullet
+@item @code{no}
+No row name pre-processing will take place.
+
+@item @code{yes}
+The first column of the table is removed from the table before processing,
+and is then reapplied to the results.
-To ensure that links are preserved, care should be taken to replicate
-your directory structure on the web server, and to use relative file
-paths. For example, if your Org files are kept in @file{~/org} and your
-publishable images in @file{~/images}, you'd link to an image with
-@c
@example
-file:../images/myimage.png
-@end example
-@c
-On the web server, the relative path to the image should be the
-same. You can accomplish this by setting up an "images" folder in the
-right place on the web server, and publishing images to it.
+#+tblname: with-rownames
+| one | 1 | 2 | 3 | 4 | 5 |
+| two | 6 | 7 | 8 | 9 | 10 |
-@lisp
-(setq org-publish-project-alist
- '(("orgfiles"
- :base-directory "~/org/"
- :base-extension "org"
- :publishing-directory "/ssh:user@@host:~/html/notebook/"
- :publishing-function org-publish-org-to-html
- :exclude "PrivatePage.org" ;; regexp
- :headline-levels 3
- :section-numbers nil
- :table-of-contents nil
- :style "<link rel=\"stylesheet\"
- href=\"../other/mystyle.css\" type=\"text/css\"/>"
- :auto-preamble t
- :auto-postamble nil)
+#+srcname: echo-table-once-again
+#+begin_src python :var tab=with-rownames :rownames yes
+ return [[val + 10 for val in row] for row in tab]
+#+end_src
- ("images"
- :base-directory "~/images/"
- :base-extension "jpg\\|gif\\|png"
- :publishing-directory "/ssh:user@@host:~/html/images/"
- :publishing-function org-publish-attachment)
+#+results: echo-table-once-again
+| one | 11 | 12 | 13 | 14 | 15 |
+| two | 16 | 17 | 18 | 19 | 20 |
+@end example
- ("other"
- :base-directory "~/other/"
- :base-extension "css\\|el"
- :publishing-directory "/ssh:user@@host:~/html/other/"
- :publishing-function org-publish-attachment)
- ("website" :components ("orgfiles" "images" "other"))))
-@end lisp
+Please note that row names are not removed before the table is indexed using
+variable indexing @xref{var, Indexable variable values}.
-@node Triggering publication, , Sample configuration, Publishing
-@section Triggering publication
+@end itemize
-Once properly configured, Org can publish with the following commands:
+@node shebang, eval, rownames, Specific header arguments
+@subsubsection @code{:shebang}
+
+Setting the @code{:shebang} header argument to a string value
+(e.g.@: @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the
+first line of any tangled file holding the code block, and the file
+permissions of the tangled file are set to make it executable.
+
+@node eval, , shebang, Specific header arguments
+@subsubsection @code{:eval}
+The @code{:eval} header argument can be used to limit the evaluation of
+specific code blocks. @code{:eval} accepts two arguments ``never'' and
+``query''. @code{:eval never} will ensure that a code block is never
+evaluated, this can be useful for protecting against the evaluation of
+dangerous code blocks. @code{:eval query} will require a query for every
+execution of a code block regardless of the value of the
+@code{org-confirm-babel-evaluate} variable.
+
+If this header argument is not set then evaluation is determined by the value
+of the @code{org-confirm-babel-evaluate} variable see @ref{Code evaluation
+security}.
+
+@node Results of evaluation, Noweb reference syntax, Header arguments, Working With Source Code
+@section Results of evaluation
+@cindex code block, results of evaluation
+@cindex source code, results of evaluation
+
+The way in which results are handled depends on whether a session is invoked,
+as well as on whether @code{:results value} or @code{:results output} is
+used. The following table shows the table possibilities. For a full listing
+of the possible results header arguments see @ref{results}.
+
+@multitable @columnfractions 0.26 0.33 0.41
+@item @tab @b{Non-session} @tab @b{Session}
+@item @code{:results value} @tab value of last expression @tab value of last expression
+@item @code{:results output} @tab contents of STDOUT @tab concatenation of interpreter output
+@end multitable
-@table @kbd
-@kindex C-c C-e C
-@item C-c C-e C
-Prompt for a specific project and publish all files that belong to it.
-@kindex C-c C-e P
-@item C-c C-e P
-Publish the project containing the current file.
-@kindex C-c C-e F
-@item C-c C-e F
-Publish only the current file.
-@kindex C-c C-e E
-@item C-c C-e E
-Publish every project.
-@end table
+Note: With @code{:results value}, the result in both @code{:session} and
+non-session is returned to Org-mode as a table (a one- or two-dimensional
+vector of strings or numbers) when appropriate.
+
+@subsection Non-session
+@subsubsection @code{:results value}
+This is the default. Internally, the value is obtained by wrapping the code
+in a function definition in the external language, and evaluating that
+function. Therefore, code should be written as if it were the body of such a
+function. In particular, note that Python does not automatically return a
+value from a function unless a @code{return} statement is present, and so a
+@samp{return} statement will usually be required in Python.
+
+This is the only one of the four evaluation contexts in which the code is
+automatically wrapped in a function definition.
+
+@subsubsection @code{:results output}
+The code is passed to the interpreter as an external process, and the
+contents of the standard output stream are returned as text. (In certain
+languages this also contains the error output stream; this is an area for
+future work.)
+
+@subsection Session
+@subsubsection @code{:results value}
+The code is passed to an interpreter running as an interactive Emacs inferior
+process. Only languages which provide tools for interactive evaluation of
+code have session support, so some language (e.g., C and ditaa) do not
+support the @code{:session} header argument, and in other languages (e.g.,
+Python and Haskell) which have limitations on the code which may be entered
+into interactive sessions, those limitations apply to the code in code blocks
+using the @code{:session} header argument as well.
+
+Unless the @code{:results output} option is supplied (see below) the result
+returned is the result of the last evaluation performed by the
+interpreter. (This is obtained in a language-specific manner: the value of
+the variable @code{_} in Python and Ruby, and the value of @code{.Last.value}
+in R).
+
+@subsubsection @code{:results output}
+The code is passed to the interpreter running as an interactive Emacs
+inferior process. The result returned is the concatenation of the sequence of
+(text) output from the interactive interpreter. Notice that this is not
+necessarily the same as what would be sent to @code{STDOUT} if the same code
+were passed to a non-interactive interpreter running as an external
+process. For example, compare the following two blocks:
+
+@example
+#+begin_src python :results output
+ print "hello"
+ 2
+ print "bye"
+#+end_src
+
+#+resname:
+: hello
+: bye
+@end example
+
+In non-session mode, the `2' is not printed and does not appear.
+@example
+#+begin_src python :results output :session
+ print "hello"
+ 2
+ print "bye"
+#+end_src
+
+#+resname:
+: hello
+: 2
+: bye
+@end example
+
+But in @code{:session} mode, the interactive interpreter receives input `2'
+and prints out its value, `2'. (Indeed, the other print statements are
+unnecessary here).
+
+@node Noweb reference syntax, Key bindings and useful functions, Results of evaluation, Working With Source Code
+@section Noweb reference syntax
+@cindex code block, noweb reference
+@cindex syntax, noweb
+@cindex source code, noweb reference
+
+The ``noweb'' (see @uref{http://www.cs.tufts.edu/~nr/noweb/}) Literate
+Programming system allows named blocks of code to be referenced by using the
+familiar Noweb syntax:
+
+@example
+<<code-block-name>>
+@end example
+
+When a code block is tangled or evaluated, whether or not ``noweb''
+references are expanded depends upon the value of the @code{:noweb} header
+argument. If @code{:noweb yes}, then a Noweb reference is expanded before
+evaluation. If @code{:noweb no}, the default, then the reference is not
+expanded before evaluation.
+
+Note: the default value, @code{:noweb no}, was chosen to ensure that
+correct code is not broken in a language, such as Ruby, where
+@code{<<arg>>} is a syntactically valid construct. If @code{<<arg>>} is not
+syntactically valid in languages that you use, then please consider setting
+the default value.
+
+@node Key bindings and useful functions, Batch execution, Noweb reference syntax, Working With Source Code
+@section Key bindings and useful functions
+@cindex code block, key bindings
+
+Many common Org-mode key sequences are re-bound depending on
+the context.
+
+Within a code block, the following key bindings
+are active:
-@vindex org-publish-use-timestamps-flag
-Org uses timestamps to track when a file has changed. The above functions
-normally only publish changed files. You can override this and force
-publishing of all files by giving a prefix argument to any of the commands
-above, or by customizing the variable @code{org-publish-use-timestamps-flag}.
-This may be necessary in particular if files include other files via
-@code{#+SETUPFILE:} or @code{#+INCLUDE:}.
+@multitable @columnfractions 0.25 0.75
+@kindex C-c C-c
+@item @kbd{C-c C-c} @tab @code{org-babel-execute-src-block}
+@kindex C-c C-o
+@item @kbd{C-c C-o} @tab @code{org-babel-open-src-block-result}
+@kindex C-up
+@item @kbd{C-@key{up}} @tab @code{org-babel-load-in-session}
+@kindex M-down
+@item @kbd{M-@key{down}} @tab @code{org-babel-pop-to-session}
+@end multitable
+
+In an Org-mode buffer, the following key bindings are active:
+
+@multitable @columnfractions 0.45 0.55
+@kindex C-c C-v a
+@kindex C-c C-v C-a
+@item @kbd{C-c C-v a} @ @ @r{or} @ @ @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
+@kindex C-c C-v b
+@kindex C-c C-v C-b
+@item @kbd{C-c C-v b} @ @ @r{or} @ @ @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
+@kindex C-c C-v f
+@kindex C-c C-v C-f
+@item @kbd{C-c C-v f} @ @ @r{or} @ @ @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
+@kindex C-c C-v g
+@item @kbd{C-c C-v g} @tab @code{org-babel-goto-named-source-block}
+@kindex C-c C-v h
+@item @kbd{C-c C-v h} @tab @code{org-babel-describe-bindings}
+@kindex C-c C-v l
+@kindex C-c C-v C-l
+@item @kbd{C-c C-v l} @ @ @r{or} @ @ @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest}
+@kindex C-c C-v p
+@kindex C-c C-v C-p
+@item @kbd{C-c C-v p} @ @ @r{or} @ @ @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block}
+@kindex C-c C-v s
+@kindex C-c C-v C-s
+@item @kbd{C-c C-v s} @ @ @r{or} @ @ @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
+@kindex C-c C-v t
+@kindex C-c C-v C-t
+@item @kbd{C-c C-v t} @ @ @r{or} @ @ @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
+@kindex C-c C-v z
+@kindex C-c C-v C-z
+@item @kbd{C-c C-v z} @ @ @r{or} @ @ @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session}
+@end multitable
-@node Miscellaneous, Hacking, Publishing, Top
+@c When possible these keybindings were extended to work when the control key is
+@c kept pressed, resulting in the following additional keybindings.
+
+@c @multitable @columnfractions 0.25 0.75
+@c @item @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
+@c @item @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
+@c @item @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
+@c @item @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest}
+@c @item @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block}
+@c @item @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
+@c @item @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
+@c @item @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session}
+@c @end multitable
+
+@node Batch execution, , Key bindings and useful functions, Working With Source Code
+@section Batch execution
+@cindex code block, batch execution
+@cindex source code, batch execution
+
+It is possible to call functions from the command line. This shell
+script calls @code{org-babel-tangle} on every one of its arguments.
+
+Be sure to adjust the paths to fit your system.
+
+@example
+#!/bin/sh
+# -*- mode: shell-script -*-
+#
+# tangle files with org-mode
+#
+DIR=`pwd`
+FILES=""
+ORGINSTALL="~/src/org/lisp/org-install.el"
+
+# wrap each argument in the code required to call tangle on it
+for i in $@@; do
+ FILES="$FILES \"$i\""
+done
+
+emacs -Q --batch -l $ORGINSTALL \
+--eval "(progn
+(add-to-list 'load-path (expand-file-name \"~/src/org/lisp/\"))
+(add-to-list 'load-path (expand-file-name \"~/src/org/contrib/lisp/\"))
+(require 'org)(require 'org-exp)(require 'ob)(require 'ob-tangle)
+(mapc (lambda (file)
+ (find-file (expand-file-name file \"$DIR\"))
+ (org-babel-tangle)
+ (kill-buffer)) '($FILES)))" 2>&1 |grep tangled
+@end example
+
+@node Miscellaneous, Hacking, Working With Source Code, Top
@chapter Miscellaneous
@menu
* Completion:: M-TAB knows what you need
-* Speed keys:: Electic commands at the beginning of a headline
+* Easy Templates:: Quick insertion of structural elements
+* Speed keys:: Electric commands at the beginning of a headline
+* Code evaluation security:: Org mode files evaluate inline code
* Customization:: Adapting Org to your taste
* In-buffer settings:: Overview of the #+KEYWORDS
* The very busy C-c C-c key:: When in doubt, press C-c C-c
* Clean view:: Getting rid of leading stars in the outline
* TTY keys:: Using Org on a tty
* Interaction:: Other Emacs packages
+* org-crypt.el:: Encrypting Org files
@end menu
-@node Completion, Speed keys, Miscellaneous, Miscellaneous
+@node Completion, Easy Templates, Miscellaneous, Miscellaneous
@section Completion
@cindex completion, of @TeX{} symbols
@cindex completion, of TODO keywords
After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
@item
After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
-@samp{OPTIONS} which set file-specific options for Org mode. When the
+@samp{OPTIONS} which set file-specific options for Org-mode. When the
option keyword is already complete, pressing @kbd{M-@key{TAB}} again
will insert example settings for this keyword.
@item
In the line after @samp{#+STARTUP: }, complete startup keywords,
-i.e. valid keys for this line.
+i.e.@: valid keys for this line.
@item
Elsewhere, complete dictionary words using Ispell.
@end itemize
@end table
-@node Speed keys, Customization, Completion, Miscellaneous
+@node Easy Templates, Speed keys, Completion, Miscellaneous
+@section Easy Templates
+@cindex template insertion
+@cindex insertion, of templates
+
+Org-mode supports insertion of empty structural elements (like
+@code{#+BEGIN_SRC} and @code{#+END_SRC} pairs) with just a few key
+strokes. This is achieved through a native template expansion mechanism.
+Note that Emacs has several other template mechanisms which could be used in
+a similar way, for example @file{yasnippet}.
+
+To insert a structural element, type a @samp{<}, followed by a template
+selector and @kbd{@key{TAB}}. Completion takes effect only when the above
+keystrokes are typed on a line by itself.
+
+The following template selectors are currently supported.
+
+@multitable @columnfractions 0.1 0.9
+@item @kbd{s} @tab @code{#+begin_src ... #+end_src}
+@item @kbd{e} @tab @code{#+begin_example ... #+end_example}
+@item @kbd{q} @tab @code{#+begin_quote ... #+end_quote}
+@item @kbd{v} @tab @code{#+begin_verse ... #+end_verse}
+@item @kbd{c} @tab @code{#+begin_center ... #+end_center}
+@item @kbd{l} @tab @code{#+begin_latex ... #+end_latex}
+@item @kbd{L} @tab @code{#+latex:}
+@item @kbd{h} @tab @code{#+begin_html ... #+end_html}
+@item @kbd{H} @tab @code{#+html:}
+@item @kbd{a} @tab @code{#+begin_ascii ... #+end_ascii}
+@item @kbd{A} @tab @code{#+ascii:}
+@item @kbd{i} @tab @code{#+index:} line
+@item @kbd{I} @tab @code{#+include:} line
+@end multitable
+
+For example, on an empty line, typing "<e" and then pressing TAB, will expand
+into a complete EXAMPLE template.
+
+You can install additional templates by customizing the variable
+@code{org-structure-template-alist}. See the docstring of the variable for
+additional details.
+
+@node Speed keys, Code evaluation security, Easy Templates, Miscellaneous
@section Speed keys
@cindex speed keys
@vindex org-use-speed-commands
@vindex org-speed-commands-user
Single keys can be made to execute commands when the cursor is at the
-beginning of a headline, i.e. before the first star. Configure the variable
+beginning of a headline, i.e.@: before the first star. Configure the variable
@code{org-use-speed-commands} to activate this feature. There is a
pre-defined list of commands, and you can add more such commands using the
variable @code{org-speed-commands-user}. Speed keys do not only speed up
navigation and other commands, but they also provide an alternative way to
-execute commands bound to keys that are not or not easily available on a tty,
+execute commands bound to keys that are not or not easily available on a TTY,
or on a small mobile device with a limited keyboard.
To see which commands are available, activate the feature and press @kbd{?}
with the cursor at the beginning of a headline.
-@node Customization, In-buffer settings, Speed keys, Miscellaneous
+@node Code evaluation security, Customization, Speed keys, Miscellaneous
+@section Code evaluation and security issues
+
+Org provides tools to work with the code snippets, including evaluating them.
+
+Running code on your machine always comes with a security risk. Badly
+written or malicious code can be executed on purpose or by accident. Org has
+default settings which will only evaluate such code if you give explicit
+permission to do so, and as a casual user of these features you should leave
+these precautions intact.
+
+For people who regularly work with such code, the confirmation prompts can
+become annoying, and you might want to turn them off. This can be done, but
+you must be aware of the risks that are involved.
+
+Code evaluation can happen under the following circumstances:
+
+@table @i
+@item Source code blocks
+Source code blocks can be evaluated during export, or when pressing @kbd{C-c
+C-c} in the block. The most important thing to realize here is that Org mode
+files which contain code snippets are, in a certain sense, like executable
+files. So you should accept them and load them into Emacs only from trusted
+sources---just like you would do with a program you install on your computer.
+
+Make sure you know what you are doing before customizing the variables
+which take off the default security brakes.
+
+@defopt org-confirm-babel-evaluate
+When t (the default), the user is asked before every code block evaluation.
+When nil, the user is not asked. When set to a function, it is called with
+two arguments (language and body of the code block) and should return t to
+ask and nil not to ask.
+@end defopt
+
+For example, here is how to execute "ditaa" code (which is considered safe)
+without asking:
+@example
+(defun my-org-confirm-babel-evaluate (lang body)
+ (not (string= lang "ditaa"))) ; don't ask for ditaa
+(setq org-confirm-babel-evaluate 'my-org-confirm-babel-evaluate)
+@end example
+
+@item Following @code{shell} and @code{elisp} links
+Org has two link types that can directly evaluate code (@pxref{External
+links}). These links can be problematic because the code to be evaluated is
+not visible.
+
+@defopt org-confirm-shell-link-function
+Function to queries user about shell link execution.
+@end defopt
+@defopt org-confirm-elisp-link-function
+Functions to query user for Emacs Lisp link execution.
+@end defopt
+
+@item Formulas in tables
+Formulas in tables (@pxref{The spreadsheet}) are code that is evaluated
+either by the @i{calc} interpreter, or by the @i{Emacs Lisp} interpreter.
+@end table
+
+@node Customization, In-buffer settings, Code evaluation security, Miscellaneous
@section Customization
@cindex customization
@cindex options, for customization
@cindex in-buffer settings
@cindex special keywords
-Org mode uses special lines in the buffer to define settings on a
+Org-mode uses special lines in the buffer to define settings on a
per-file basis. These lines start with a @samp{#+} followed by a
keyword, a colon, and then individual words defining a setting. Several
setting words can be in the same line, but you can also have multiple
@vindex org-table-formula-constants
@vindex org-table-formula
Set file-local values for constants to be used in table formulas. This
-line set the local variable @code{org-table-formula-constants-local}.
+line sets the local variable @code{org-table-formula-constants-local}.
The global version of this variable is
@code{org-table-formula-constants}.
@item #+FILETAGS: :tag1:tag2:tag3:
@vindex org-default-priority
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.
+have a lower ASCII number than the lowest priority.
@item #+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 #+SETUPFILE: file
This line defines a file that holds more in-buffer setup. Normally this is
entirely ignored. Only when the buffer is parsed for option-setting lines
-(i.e. when starting Org mode for a file, when pressing @kbd{C-c C-c} in a
+(i.e.@: when starting Org-mode for a file, when pressing @kbd{C-c C-c} in a
settings line, or when exporting), then the contents of this file are parsed
as if they had been included in the buffer. In particular, the file can be
-any other Org mode file with internal setup. You can visit the file the
+any other Org-mode file with internal setup. You can visit the file the
cursor is in the line with @kbd{C-c '}.
@item #+STARTUP:
@cindex #+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 file is being visited.
The first set of options deals with the initial visibility of the outline
align @r{align all tables}
noalign @r{don't align tables on startup}
@end example
+
+@vindex org-startup-with-inline-images
+When visiting a file, inline images can be automatically displayed. The
+corresponding variable is @code{org-startup-with-inline-images}, with a
+default value @code{nil} to avoid delays when visiting a file.
+@cindex @code{inlineimages}, STARTUP keyword
+@cindex @code{noinlineimages}, STARTUP keyword
+@example
+inlineimages @r{show inline images}
+noinlineimages @r{don't show inline images on startup}
+@end example
+
@vindex org-log-done
@vindex org-log-note-clock-out
@vindex org-log-repeat
@cindex @code{logredeadline}, STARTUP keyword
@cindex @code{lognoteredeadline}, STARTUP keyword
@cindex @code{nologredeadline}, STARTUP keyword
+@cindex @code{logrefile}, STARTUP keyword
+@cindex @code{lognoterefile}, STARTUP keyword
+@cindex @code{nologrefile}, STARTUP keyword
@example
logdone @r{record a timestamp when an item is marked DONE}
lognotedone @r{record timestamp and a note when DONE}
logredeadline @r{record a timestamp when deadline changes}
lognoteredeadline @r{record a note when deadline changes}
nologredeadline @r{do not record when a deadline date changes}
+logrefile @r{record a timestamp when refiling}
+lognoterefile @r{record a note when refiling}
+nologrefile @r{do not record when refiling}
@end example
@vindex org-hide-leading-stars
@vindex org-odd-levels-only
fnnoinline @r{define footnotes in separate section}
fnlocal @r{define footnotes near first reference, but not inline}
fnprompt @r{prompt for footnote labels}
-fnauto @r{create [fn:1]-like labels automatically (default)}
+fnauto @r{create @code{[fn:1]}-like labels automatically (default)}
fnconfirm @r{offer automatic label for editing or confirmation}
-fnplain @r{create [1]-like labels automatically}
+fnplain @r{create @code{[1]}-like labels automatically}
fnadjust @r{automatically renumber and sort footnotes}
nofnadjust @r{do not renumber and sort automatically}
@end example
@cindex org-hide-block-startup
-To hide blocks on startup, use these keywords. The corresponding variable is
+To hide blocks on startup, use these keywords. The corresponding variable is
@code{org-hide-block-startup}.
@cindex @code{hideblocks}, STARTUP keyword
@cindex @code{nohideblocks}, STARTUP keyword
hideblocks @r{Hide all begin/end blocks on startup}
nohideblocks @r{Do not hide blocks on startup}
@end example
+@cindex org-pretty-entities
+The display of entities as UTF-8 characters is governed by the variable
+@code{org-pretty-entities} and the keywords
+@cindex @code{entitiespretty}, STARTUP keyword
+@cindex @code{entitiesplain}, STARTUP keyword
+@example
+entitiespretty @r{Show entities as UTF-8 characters where possible}
+entitiesplain @r{Leave entities plain}
+@end example
@item #+TAGS: TAG1(c1) TAG2(c2)
@vindex org-tag-alist
These lines (several such lines are allowed) specify the valid tags in
@item #+TBLFM:
This line contains the formulas for the table directly above the line.
@item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+DATE:,
-@itemx #+OPTIONS:, #+BIND:
-@itemx #+DESCRIPTION:, #+KEYWORDS:
+@itemx #+OPTIONS:, #+BIND:, #+XSLT:,
+@itemx #+DESCRIPTION:, #+KEYWORDS:,
@itemx #+LATEX_HEADER:, #+STYLE:, #+LINK_UP:, #+LINK_HOME:,
@itemx #+EXPORT_SELECT_TAGS:, #+EXPORT_EXCLUDE_TAGS:
These lines provide settings for exporting files. For more details see
If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
the entire table.
@item
-If the cursor is inside a table created by the @file{table.el} package,
-activate that table.
-@item
-If the current buffer is a Remember buffer, close the note and file it.
+If the current buffer is a capture buffer, close the note and file it.
With a prefix argument, file it, without further interaction, to the
default location.
@item
@end example
@noindent
-If you are using at least Emacs 23.1.50.3 and version 6.29 of Org, this kind
-of view can be achieved dynamically at display time using
-@code{org-indent-mode}. In this minor mode, all lines are prefixed for
-display with the necessary amount of space. Also headlines are prefixed with
-additional stars, so that the amount of indentation shifts by
-two@footnote{See the variable @code{org-indent-indentation-per-level}.}
-spaces per level. All headline stars but the last one are made invisible
-using the @code{org-hide} face@footnote{Turning on @code{org-indent-mode}
-sets @code{org-hide-leading-stars} to @code{t} and
-@code{org-adapt-indentation} to @code{nil}.} - see below under @samp{2.} for
-more information on how this works. You can turn on @code{org-indent-mode}
-for all files by customizing the variable @code{org-startup-indented}, or you
-can turn it on for individual files using
+
+If you are using at least Emacs 23.2@footnote{Emacs 23.1 can actually crash
+with @code{org-indent-mode}} and version 6.29 of Org, this kind of view can
+be achieved dynamically at display time using @code{org-indent-mode}. In
+this minor mode, all lines are prefixed for display with the necessary amount
+of space@footnote{@code{org-indent-mode} also sets the @code{wrap-prefix}
+property, such that @code{visual-line-mode} (or purely setting
+@code{word-wrap}) wraps long lines (including headlines) correctly indented.
+}. Also headlines are prefixed with additional stars, so that the amount of
+indentation shifts by two@footnote{See the variable
+@code{org-indent-indentation-per-level}.} spaces per level. All headline
+stars but the last one are made invisible using the @code{org-hide}
+face@footnote{Turning on @code{org-indent-mode} sets
+@code{org-hide-leading-stars} to @code{t} and @code{org-adapt-indentation} to
+@code{nil}.} - see below under @samp{2.} for more information on how this
+works. You can turn on @code{org-indent-mode} for all files by customizing
+the variable @code{org-startup-indented}, or you can turn it on for
+individual files using
@example
#+STARTUP: indent
@end example
-If you want a similar effect in earlier version of Emacs and/or Org, or if
+If you want a similar effect in an earlier version of Emacs and/or Org, or if
you want the indentation to be hard space characters so that the plain text
file looks as similar as possible to the Emacs display, Org supports you in
the following way:
tty you would rather use @kbd{C-c .} to re-insert the timestamp.
@multitable @columnfractions 0.15 0.2 0.1 0.2
-@item @b{Default} @tab @b{Alternative 1} @tab @b{Speed key} @tab @b{Alternative 2}
-@item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab @kbd{C} @tab
-@item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{l} @tab @kbd{@key{Esc} @key{left}}
-@item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab @kbd{L} @tab
+@item @b{Default} @tab @b{Alternative 1} @tab @b{Speed key} @tab @b{Alternative 2}
+@item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab @kbd{C} @tab
+@item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{l} @tab @kbd{@key{Esc} @key{left}}
+@item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab @kbd{L} @tab
@item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{r} @tab @kbd{@key{Esc} @key{right}}
-@item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab @kbd{R} @tab
-@item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{ } @tab @kbd{@key{Esc} @key{up}}
-@item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab @kbd{U} @tab
+@item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab @kbd{R} @tab
+@item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{ } @tab @kbd{@key{Esc} @key{up}}
+@item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab @kbd{U} @tab
@item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{ } @tab @kbd{@key{Esc} @key{down}}
-@item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab @kbd{D} @tab
+@item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab @kbd{D} @tab
@item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab @kbd{ } @tab
@item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{ } @tab @kbd{@key{Esc} @key{RET}}
@item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab @kbd{ } @tab
@end multitable
-@node Interaction, , TTY keys, Miscellaneous
+@node Interaction, org-crypt.el, TTY keys, Miscellaneous
@section Interaction with other packages
@cindex packages, interaction with other
Org lives in the world of GNU Emacs and interacts in various ways
@code{calc-eval} which will have been autoloaded during setup if Calc has
been installed properly. As of Emacs 22, Calc is part of the Emacs
distribution. Another possibility for interaction between the two
-packages is using Calc for embedded calculations. @xref{Embedded Mode,
+packages is using Calc for embedded calculations. @xref{Embedded Mode,
, Embedded Mode, Calc, GNU Emacs Calc Manual}.
@item @file{constants.el} by Carsten Dominik
@cindex @file{constants.el}
the @file{constants} package which defines a large number of constants
and units, and lets you use unit prefixes like @samp{M} for
@samp{Mega}, etc@. You will need version 2.0 of this package, available
-at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for
+at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for
the function @code{constants-get}, which has to be autoloaded in your
setup. See the installation instructions in the file
@file{constants.el}.
@item @file{cdlatex.el} by Carsten Dominik
@cindex @file{cdlatex.el}
@cindex Dominik, Carsten
-Org mode can make use of the CDLa@TeX{} package to efficiently enter
-La@TeX{} fragments into Org files. See @ref{CDLaTeX mode}.
+Org-mode can make use of the CDLa@TeX{} package to efficiently enter
+@LaTeX{} fragments into Org files. See @ref{CDLaTeX mode}.
@item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
@cindex @file{imenu.el}
-Imenu allows menu access to an index of items in a file. Org mode
+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:
@lisp
(add-hook 'org-mode-hook
@item @file{remember.el} by John Wiegley
@cindex @file{remember.el}
@cindex Wiegley, John
-Org cooperates with remember, see @ref{Remember}.
-@file{Remember.el} is not part of Emacs, find it on the web.
+Org used to use this package for capture, but no longer does.
@item @file{speedbar.el} by Eric M. Ludlam
@cindex @file{speedbar.el}
@cindex Ludlam, Eric M.
Speedbar is a package that creates a special frame displaying files and
-index items in files. Org mode supports Speedbar and allows you to
+index items in files. Org-mode supports Speedbar and allows you to
drill into Org files directly from the Speedbar. It also allows you 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}
@cindex Ota, Takaaki
-Complex ASCII tables with automatic line wrapping, column- and
-row-spanning, and alignment can be created using the Emacs table
-package by Takaaki Ota (@uref{http://sourceforge.net/projects/table},
-and also part of Emacs 22).
-When @key{TAB} or @kbd{C-c C-c} is pressed in such a table, Org mode
-will call @command{table-recognize-table} and move the cursor into the
-table. Inside a table, the keymap of Org mode is inactive. In order
-to execute Org mode-related commands, leave the table.
+Complex ASCII tables with automatic line wrapping, column- and row-spanning,
+and alignment can be created using the Emacs table package by Takaaki Ota
+(@uref{http://sourceforge.net/projects/table}, and also part of Emacs 22).
+Org-mode will recognize these tables and export them properly. Because of
+interference with other Org-mode functionality, you unfortunately cannot edit
+these tables directly in the buffer. Instead, you need to use the command
+@kbd{C-c '} to edit them, similar to source code snippets.
@table @kbd
-@kindex C-c C-c
-@item C-c C-c
-Recognize @file{table.el} table. Works when the cursor is in a
-table.el table.
+@orgcmd{C-c ',org-edit-special}
+Edit a @file{table.el} table. Works when the cursor is in a table.el table.
@c
-@kindex C-c ~
-@item C-c ~
+@orgcmd{C-c ~,org-table-create-with-table.el}
Insert a @file{table.el} table. If there is already a table at point, this
command converts it between the @file{table.el} format and the Org-mode
format. See the documentation string of the command
@code{org-convert-table} for the restrictions under which this is
possible.
@end table
-@file{table.el} is part of Emacs 22.
+@file{table.el} is part of Emacs since Emacs 22.
@item @file{footnote.el} by Steven L. Baur
@cindex @file{footnote.el}
@cindex Baur, Steven L.
-Org mode recognizes numerical footnotes as provided by this package.
-However, Org mode also has its own footnote support (@pxref{Footnotes}),
+Org-mode recognizes numerical footnotes as provided by this package.
+However, Org-mode also has its own footnote support (@pxref{Footnotes}),
which makes using @file{footnote.el} unnecessary.
@end table
@node Conflicts, , Cooperation, Interaction
-@subsection Packages that lead to conflicts with Org mode
+@subsection Packages that lead to conflicts with Org-mode
@table @asis
timestamps, TODO keywords, priorities, and item bullet types if the cursor is
at such a location. By default, @kbd{S-@key{cursor}} commands outside
special contexts don't do anything, but you can customize the variable
-@code{org-support-shift-select}. Org mode then tries to accommodate shift
+@code{org-support-shift-select}. Org-mode then tries to accommodate shift
selection by (i) using it outside of the special contexts where special
commands apply, and by (ii) extending an existing active region even if the
cursor moves across a special context.
@code{shift-selection-mode}, see previous paragraph. If you are using Emacs
23, you probably don't want to use another package for this purpose. However,
if you prefer to leave these keys to a different package while working in
-Org mode, configure the variable @code{org-replace-disputed-keys}. When set,
+Org-mode, configure the variable @code{org-replace-disputed-keys}. When set,
Org will move the following key bindings in Org 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-+
-C-S-LEFT -> M-S-- C-S-RIGHT -> M-S-+
+S-UP @result{} M-p S-DOWN @result{} M-n
+S-LEFT @result{} M-- S-RIGHT @result{} M-+
+C-S-LEFT @result{} M-S-- C-S-RIGHT @result{} M-S-+
@end example
@vindex org-disputed-keys
@item @file{yasnippet.el}
@cindex @file{yasnippet.el}
-The way Org-mode binds the TAB key (binding to @code{[tab]} instead of
-@code{"\t"}) overrules yasnippets' access to this key. The following code
+The way Org mode binds the TAB key (binding to @code{[tab]} instead of
+@code{"\t"}) overrules YASnippet's access to this key. The following code
fixed this problem:
@lisp
(define-key yas/keymap [tab] 'yas/next-field-group)))
@end lisp
+The latest version of yasnippet doesn't play well with Org mode. If the
+above code does not fix the conflict, start by defining the following
+function:
+
+@lisp
+(defun yas/org-very-safe-expand ()
+ (let ((yas/fallback-behavior 'return-nil)) (yas/expand)))
+@end lisp
+
+Then, tell Org mode what to do with the new function:
+
+@lisp
+(add-hook 'org-mode-hook
+ (lambda ()
+ (make-variable-buffer-local 'yas/trigger-key)
+ (setq yas/trigger-key [tab])
+ (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand)
+ (define-key yas/keymap [tab] 'yas/next-field)))
+@end lisp
+
@item @file{windmove.el} by Hovav Shacham
@cindex @file{windmove.el}
This package also uses the @kbd{S-<cursor>} keys, so everything written
-in the paragraph above about CUA mode also applies here.
+in the paragraph above about CUA mode also applies here. If you want make
+the windmove function active in locations where Org-mode does not have
+special functionality on @kbd{S-@key{cursor}}, add this to your
+configuration:
+
+@lisp
+;; Make windmove work in org-mode:
+(add-hook 'org-shiftup-final-hook 'windmove-up)
+(add-hook 'org-shiftleft-final-hook 'windmove-left)
+(add-hook 'org-shiftdown-final-hook 'windmove-down)
+(add-hook 'org-shiftright-final-hook 'windmove-right)
+@end lisp
@item @file{viper.el} by Michael Kifer
@cindex @file{viper.el}
@end table
+@node org-crypt.el, , Interaction, Miscellaneous
+@section org-crypt.el
+@cindex @file{org-crypt.el}
+@cindex @code{org-decrypt-entry}
+
+Org-crypt will encrypt the text of an entry, but not the headline, or
+properties. Org-crypt uses the Emacs EasyPG library to encrypt and decrypt
+files.
+
+Any text below a headline that has a @samp{:crypt:} tag will be automatically
+be encrypted when the file is saved. If you want to use a different tag just
+customize the @code{org-crypt-tag-matcher} setting.
+
+To use org-crypt it is suggested that you have the following in your
+@file{.emacs}:
+
+@example
+(require 'org-crypt)
+(org-crypt-use-before-save-magic)
+(setq org-tags-exclude-from-inheritance (quote ("crypt")))
+
+(setq org-crypt-key nil)
+ ;; GPG key to use for encryption
+ ;; Either the Key ID or set to nil to use symmetric encryption.
+
+(setq auto-save-default nil)
+ ;; Auto-saving does not cooperate with org-crypt.el: so you need
+ ;; to turn it off if you plan to use org-crypt.el quite often.
+ ;; Otherwise, you'll get an (annoying) message each time you
+ ;; start Org.
+
+ ;; To turn it off only locally, you can insert this:
+ ;;
+ ;; # -*- buffer-auto-save-file-name: nil; -*-
+@end example
+
+Excluding the crypt tag from inheritance prevents already encrypted text
+being encrypted again.
@node Hacking, MobileOrg, Miscellaneous, Top
@appendix Hacking
* Add-on packages:: Available extensions
* Adding hyperlink types:: New custom link types
* Context-sensitive commands:: How to add functionality to such commands
-* Tables in arbitrary syntax:: Orgtbl for La@TeX{} and other programs
+* Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
* Dynamic blocks:: Automatically filled blocks
* Special agenda views:: Customized views
* Extracting agenda information:: Postprocessing of agenda information
A large number of add-on packages have been written by various authors.
These packages are not part of Emacs, but they are distributed as contributed
-packages with the separate release available at the Org mode home page at
+packages with the separate release available at the Org-mode home page at
@uref{http://orgmode.org}. The list of contributed packages, along with
documentation about each package, is maintained by the Worg project at
@uref{http://orgmode.org/worg/org-contrib/}.
the link description when the link is later inserted into an Org
buffer with @kbd{C-c C-l}.
-When is makes sense for your new link type, you may also define a function
-@code{org-PREFIX-complete-link} that implements special (e.g. completion)
+When it makes sense for your new link type, you may also define a function
+@code{org-PREFIX-complete-link} that implements special (e.g.@: completion)
support for inserting such a link with @kbd{C-c C-l}. Such a function should
not accept any arguments, and return the full link with prefix.
Add-ons can tap into this functionality by providing a function that detects
special context for that add-on and executes functionality appropriate for
the context. Here is an example from Dan Davison's @file{org-R.el} which
-allows you to evaluate commands based on the @file{R} programming language. For
-this package, special contexts are lines that start with @code{#+R:} or
+allows you to evaluate commands based on the @file{R} programming language
+@footnote{@file{org-R.el} has been replaced by the org-mode functionality
+described in @ref{Working With Source Code} and is now obsolete.}. For this
+package, special contexts are lines that start with @code{#+R:} or
@code{#+RR:}.
@lisp
The function first checks if the cursor is in such a line. If that is the
case, @code{org-R-apply} is called and the function returns @code{t} to
signal that action was taken, and @kbd{C-c C-c} will stop looking for other
-contexts. If the function finds it should do nothing locally, it returns @code{nil} so that other, similar functions can have a try.
+contexts. If the function finds it should do nothing locally, it returns
+@code{nil} so that other, similar functions can have a try.
@node Tables in arbitrary syntax, Dynamic blocks, Context-sensitive commands, Hacking
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 La@TeX{}. However, this is extremely
+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
+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
function to @i{translate} the table to the correct syntax, and to
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, La@TeX{}
-or Texinfo.)
+Bastien added the ability to do the same with lists, in Orgstruct mode. 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, @LaTeX{} or Texinfo.)
@menu
@noindent
@code{table_name} is the reference name for the table that is also used
-in the receiver lines. @code{translation_function} is the Lisp function
+in the receiver lines. @code{translation_function} is the Lisp function
that does the translation. Furthermore, the line can contain a list of
arguments (alternating key and value) at the end. The arguments will be
passed as a property list to the translation function for
@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 La@TeX{} file. There are a
+compilation of a C file or processing of a @LaTeX{} file. There are a
number of different solutions:
@itemize @bullet
@item
Sometimes it is possible to put the table after some kind of @i{END}
statement, for example @samp{\bye} in @TeX{} and @samp{\end@{document@}}
-in La@TeX{}.
+in @LaTeX{}.
@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
@end itemize
@node A LaTeX example, Translator functions, Radio tables, Tables in arbitrary syntax
-@subsection A La@TeX{} example of radio tables
-@cindex La@TeX{}, and Orgtbl mode
+@subsection A @LaTeX{} example of radio tables
+@cindex @LaTeX{}, and Orgtbl mode
-The best way to wrap the source table in La@TeX{} is to use the
+The best way to wrap the source table in @LaTeX{} is to use the
@code{comment} environment provided by @file{comment.sty}. It has to be
activated by placing @code{\usepackage@{comment@}} into the document
header. Orgtbl mode can insert a radio table skeleton@footnote{By
-default this works only for La@TeX{}, HTML, and Texinfo. Configure the
+default this works only for @LaTeX{}, 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, let's say we use @samp{salesfigures}. You
@end example
@noindent
-@vindex La@TeX{}-verbatim-environments
+@vindex @LaTeX{}-verbatim-environments
The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
-@code{orgtbl-to-latex} to convert the table into La@TeX{} and to put it
+@code{orgtbl-to-latex} to convert the table into @LaTeX{} 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 features@footnote{If
+fill in the table---feel free to use the spreadsheet features@footnote{If
the @samp{#+TBLFM} line contains an odd number of dollar characters,
-this may cause problems with font-lock in La@TeX{} mode. As shown in the
+this may cause problems with font-lock in @LaTeX{} mode. As shown in the
example you can fix this by adding an extra line inside the
@code{comment} environment that is used to balance the dollar
expressions. If you are using AUC@TeX{} with the font-latex library, a
Now let's assume you want to make the table header by hand, because you
want to control how columns are aligned, etc@. In this case we make sure
that the table translator skips the first 2 lines of the source
-table, and tell the command to work as a @i{splice}, i.e. to not produce
+table, and tell the command to work as a @i{splice}, i.e.@: to not produce
header and footer commands of the target table:
@example
\end@{comment@}
@end example
-The La@TeX{} translator function @code{orgtbl-to-latex} is already part of
+The @LaTeX{} 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 (see also @pxref{Translator functions}):
A format to be used to wrap each field, it should contain @code{%s} for the
original field value. For example, to wrap each field value in dollars,
you could use @code{:fmt "$%s$"}. This may also be a property list with
-column numbers and formats. for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
+column numbers and formats, for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
A function of one argument can be used in place of the strings; the
function must return a formatted string.
As you can see, the properties passed into the function (variable
@var{PARAMS}) are combined with the ones newly defined in the function
-(variable @var{PARAMS2}). The ones passed into the function (i.e. the
+(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 La@TeX{} translator, but wanted the line endings to
+would like to use the @LaTeX{} translator, but wanted the line endings to
be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
overrule the default with
@end example
For a new language, you can either write your own converter function in
-analogy with the La@TeX{} translator, or you can use the generic function
+analogy with the @LaTeX{} 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
translator, please post it on @email{emacs-orgmode@@gnu.org} so that
others can benefit from your work.
-@node Radio lists, , Translator functions, Tables in arbitrary syntax
+@node Radio lists, , Translator functions, Tables in arbitrary syntax
@subsection Radio lists
@cindex radio lists
@cindex org-list-insert-radio-list
-Sending and receiving radio lists works exactly the same way than sending and
+Sending and receiving radio lists works exactly the same way as sending and
receiving radio tables (@pxref{Radio tables}). As for radio tables, you can
-insert radio lists templates in HTML, La@TeX{} and Texinfo modes by calling
+insert radio list templates in HTML, @LaTeX{} and Texinfo modes by calling
@code{org-list-insert-radio-list}.
Here are the differences with radio tables:
@itemize @minus
@item
-Use @code{ORGLST} instead of @code{ORGTBL}.
+Orgstruct mode must be active.
+@item
+Use the @code{ORGLST} keyword instead of @code{ORGTBL}.
@item
The available translation functions for radio lists don't take
parameters.
@kbd{C-c C-c} will work when pressed on the first item of the list.
@end itemize
-Here is a La@TeX{} example. Let's say that you have this in your
-La@TeX{} file:
+Here is a @LaTeX{} example. Let's say that you have this in your
+@LaTeX{} file:
-@cindex #+ORGLIST
+@cindex #+ORGLST
@example
% BEGIN RECEIVE ORGLST to-buy
% END RECEIVE ORGLST to-buy
\begin@{comment@}
-#+ORGLIST: SEND to-buy orgtbl-to-latex
+#+ORGLST: SEND to-buy org-list-to-latex
- a new house
- a new computer
+ a new keyboard
@end example
Pressing `C-c C-c' on @code{a new house} and will insert the converted
-La@TeX{} list between the two marker lines.
+@LaTeX{} list between the two marker lines.
@node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Hacking
@section Dynamic blocks
A good example for such a block is the clock table inserted by the
command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
-Dynamic block are enclosed by a BEGIN-END structure that assigns a name
+Dynamic blocks are enclosed by a BEGIN-END structure that assigns a name
to the block and can also specify parameters for the function producing
the content of the block.
-#+BEGIN:dynamic block
+@cindex #+BEGIN:dynamic block
@example
#+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
Dynamic blocks are updated with the following commands
@table @kbd
-@kindex C-c C-x C-u
-@item C-c C-x C-u
+@orgcmd{C-c C-x C-u,org-dblock-update}
Update dynamic block at point.
-@kindex C-u C-c C-x C-u
-@item C-u C-c C-x C-u
+@orgkey{C-u C-c C-x C-u}
Update all dynamic blocks in the current file.
@end table
written in a way such that it does nothing in buffers that are not in
@code{org-mode}.
+You can narrow the current buffer to the current dynamic block (like any
+other block) with @code{org-narrow-to-block}.
+
@node Special agenda views, Extracting agenda information, Dynamic blocks, Hacking
@section Special agenda views
@cindex agenda views, user-defined
-Org provides a special hook that can be used to narrow down the
-selection made by any of the agenda views. You may specify a function
-that is used at each match to verify if the match should indeed be part
-of the agenda view, and if not, how much should be skipped.
+@vindex org-agenda-skip-function
+@vindex org-agenda-skip-function-global
+Org provides a special hook that can be used to narrow down the selection
+made by these agenda views: @code{agenda}, @code{todo}, @code{alltodo},
+@code{tags}, @code{tags-todo}, @code{tags-tree}. You may specify a function
+that is used at each match to verify if the match should indeed be part of
+the agenda view, and if not, how much should be skipped. You can specify a
+global condition that will be applied to all agenda views, this condition
+would be stored in the variable @code{org-agenda-skip-function-global}. More
+commonly, such a definition is applied only to specific custom searches,
+using @code{org-agenda-skip-function}.
Let's say you want to produce a list of projects that contain a WAITING
tag anywhere in the project tree. Let's further assume that you have
and @code{org-agenda-skip-subtree-if} in this form, for example:
@table @code
-@item '(org-agenda-skip-entry-if 'scheduled)
+@item (org-agenda-skip-entry-if 'scheduled)
Skip current entry if it has been scheduled.
-@item '(org-agenda-skip-entry-if 'notscheduled)
+@item (org-agenda-skip-entry-if 'notscheduled)
Skip current entry if it has not been scheduled.
-@item '(org-agenda-skip-entry-if 'deadline)
+@item (org-agenda-skip-entry-if 'deadline)
Skip current entry if it has a deadline.
-@item '(org-agenda-skip-entry-if 'scheduled 'deadline)
+@item (org-agenda-skip-entry-if 'scheduled 'deadline)
Skip current entry if it has a deadline, or if it is scheduled.
-@item '(org-agenda-skip-entry-if 'timestamp)
+@item (org-agenda-skip-entry-if 'todo '("TODO" "WAITING"))
+Skip current entry if the TODO keyword is TODO or WAITING.
+@item (org-agenda-skip-entry-if 'todo 'done)
+Skip current entry if the TODO keyword marks a DONE state.
+@item (org-agenda-skip-entry-if 'timestamp)
Skip current entry if it has any timestamp, may also be deadline or scheduled.
-@item '(org-agenda-skip-entry 'regexp "regular expression")
+@item (org-agenda-skip-entry 'regexp "regular expression")
Skip current entry if the regular expression matches in the entry.
-@item '(org-agenda-skip-entry 'notregexp "regular expression")
+@item (org-agenda-skip-entry 'notregexp "regular expression")
Skip current entry unless the regular expression matches.
-@item '(org-agenda-skip-subtree-if 'regexp "regular expression")
+@item (org-agenda-skip-subtree-if 'regexp "regular expression")
Same as above, but check and skip the entire subtree.
@end table
@example
emacs -batch -l ~/.emacs \
-eval '(org-batch-agenda "a" \
- org-agenda-ndays 30 \
+ org-agenda-span month \
org-agenda-include-diary nil \
org-agenda-files (quote ("~/org/project.org")))' \
| lpr
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
+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
values and check if VALUE is in this list.
@end defun
+@defopt org-property-allowed-value-functions
+Hook for functions supplying allowed values for a specific property.
+The functions must take a single argument, the name of the property, and
+return a flat list of allowed values. If @samp{:ETC} is one of
+the values, use the values as completion help, but allow also other values
+to be entered. The functions must return @code{nil} if they are not
+responsible for this property.
+@end defopt
+
@node Using the mapping API, , Using the property API, Hacking
@section Using the mapping API
@cindex API, for mapping
moved to the end of the line (presumably of the headline of the
processed entry) and search continues from there. Under some
circumstances, this may not produce the wanted results. For example,
-if you have removed (e.g. archived) the current (sub)tree it could
+if you have removed (e.g.@: archived) the current (sub)tree it could
mean that the next entry will be skipped entirely. In such cases, you
can specify the position from where search should continue by making
FUNC set the variable `org-map-continue-from' to the desired buffer
@example
nil @r{the current buffer, respecting the restriction if any}
tree @r{the subtree started with the entry at point}
+region @r{The entries within the active region, if any}
file @r{the current buffer, without restriction}
file-with-archives
@r{the current buffer, and any archives associated with it}
Here are a couple of functions that might be handy:
@defun org-todo &optional arg
-Change the TODO state of the entry, see the docstring of the functions for
+Change the TODO state of the entry. See the docstring of the functions for
the many possible values for the argument ARG.
@end defun
@defun org-priority &optional action
-Change the priority of the entry, see the docstring of this function for the
+Change the priority of the entry. See the docstring of this function for the
possible values for ACTION.
@end defun
@cindex iPhone
@cindex MobileOrg
-@i{MobileOrg} is an application for the @i{iPhone/iPod Touch} series of
-devices, developed by Richard Moreland. @i{MobileOrg} offers offline viewing
-and capture support for an Org-mode system rooted on a ``real'' computer. It
-does also allow you to record changes to existing entries. For information
-about @i{MobileOrg}, see @uref{http://mobileorg.ncogni.to/}).
+@uref{http://mobileorg.ncogni.to/, MobileOrg} is an application for the
+@i{iPhone/iPod Touch} series of devices, developed by Richard Moreland.
+@i{MobileOrg} offers offline viewing and capture support for an Org-mode
+system rooted on a ``real'' computer. It does also allow you to record
+changes to existing entries. Android users should check out
+@uref{http://wiki.github.com/matburt/mobileorg-android/, MobileOrg Android}
+by Matt Jones.
This appendix describes the support Org has for creating agenda views in a
format that can be displayed by @i{MobileOrg}, and for integrating notes
For changing tags and TODO states in MobileOrg, you should have set up the
customization variables @code{org-todo-keywords} and @code{org-tags-alist} to
-cover all important tags and todo keywords, even if individual files use only
+cover all important tags and TODO keywords, even if individual files use only
part of these. MobileOrg will also offer you states and tags set up with
-in-buffer settings, but it will understand the logistics of todo state
+in-buffer settings, but it will understand the logistics of TODO state
@i{sets} (@pxref{Per-file keywords}) and @i{mutually exclusive} tags
(@pxref{Setting tags}) only for those set in these variables.
@node Setting up the staging area, Pushing to MobileOrg, MobileOrg, MobileOrg
@section Setting up the staging area
-Org-mode has commands to prepare a directory with files for @i{MobileOrg},
-and to read captured notes from there. If Emacs can directly write to the
-WebDAV directory accessed by @i{MobileOrg}, just point to this directory
-using the variable @code{org-mobile-directory}. Using the @file{tramp}
-method, @code{org-mobile-directory} may point to a remote directory
-accessible through, for example,
-@file{ssh/scp}:
+MobileOrg needs to interact with Emacs through a directory on a server. If you
+are using a public server, you should consider to encrypt the files that are
+uploaded to the server. This can be done with Org-mode 7.02 and with
+@i{MobileOrg 1.5} (iPhone version), and you need an @file{openssl}
+installation on your system. To turn on encryption, set a password in
+@i{MobileOrg} and, on the Emacs side, configure the variable
+@code{org-mobile-use-encryption}@footnote{If you can safely store the
+password in your Emacs setup, you might also want to configure
+@code{org-mobile-encryption-password}. Please read the docstring of that
+variable. Note that encryption will apply only to the contents of the
+@file{.org} files. The file names themselves will remain visible.}.
+
+The easiest way to create that directory is to use a free
+@uref{http://dropbox.com,Dropbox.com} account@footnote{If you cannot use
+Dropbox, or if your version of MobileOrg does not support it, you can use a
+webdav server. For more information, check out the documentation of MobileOrg and also this
+@uref{http://orgmode.org/worg/org-faq.html#mobileorg_webdav, FAQ entry}.}.
+When MobileOrg first connects to your Dropbox, it will create a directory
+@i{MobileOrg} inside the Dropbox. After the directory has been created, tell
+Emacs about it:
-@smallexample
-(setq org-mobile-directory "/scpc:user@@remote.host:org/webdav/")
-@end smallexample
-
-If Emacs cannot access the WebDAV directory directly using a @file{tramp}
-method, or you prefer to maintain a local copy, you can use a local directory
-for staging. Other means must then be used to keep this directory in sync
-with the WebDAV directory. In the following example, files are staged in
-@file{~/stage}, and Org-mode hooks take care of moving files to and from the
-WebDAV directory using @file{scp}.
+@lisp
+(setq org-mobile-directory "~/Dropbox/MobileOrg")
+@end lisp
-@smallexample
-(setq org-mobile-directory "~/stage/")
-(add-hook 'org-mobile-post-push-hook
- (lambda () (shell-command "scp -r ~/stage/* user@@wdhost:mobile/")))
-(add-hook 'org-mobile-pre-pull-hook
- (lambda () (shell-command "scp user@@wdhost:mobile/mobileorg.org ~/stage/ ")))
-(add-hook 'org-mobile-post-pull-hook
- (lambda () (shell-command "scp ~/stage/mobileorg.org user@@wdhost:mobile/")))
-@end smallexample
+Org-mode has commands to put files for @i{MobileOrg} into that directory,
+and to read captured notes from there.
@node Pushing to MobileOrg, Pulling from MobileOrg, Setting up the staging area, MobileOrg
@section Pushing to MobileOrg
This operation copies all files currently listed in @code{org-mobile-files}
to the directory @code{org-mobile-directory}. By default this list contains
all agenda files (as listed in @code{org-agenda-files}), but additional files
-can be included by customizing @code{org-mobiles-files}. File names will be
-staged with path relative to @code{org-directory}, so all files should be
-inside this directory. The push operation also creates (in the same
-directory) a special Org file @file{agendas.org}. This file is an Org-mode
-style outline, containing every custom agenda view defined by the user.
-While creating the agendas, Org-mode will force@footnote{See the variable
-@code{org-mobile-force-id-on-agenda-items}.} an ID property on all entries
-referenced by the agendas, so that these entries can be uniquely identified
-if @i{MobileOrg} flags them for further action. Finally, Org writes the file
-@file{index.org}, containing links to all other files. If @i{MobileOrg} is
-configured to request this file from the WebDAV server, all agendas and Org
-files will be downloaded to the device. To speed up the download, MobileOrg
-will only read files whose checksums@footnote{stored automatically in the
-file @file{checksums.dat}} have changed.
+can be included by customizing @code{org-mobile-files}. File names will be
+staged with paths relative to @code{org-directory}, so all files should be
+inside this directory. The push operation also creates a special Org file
+@file{agendas.org} with all custom agenda view defined by the
+user@footnote{While creating the agendas, Org-mode will force ID properties
+on all referenced entries, so that these entries can be uniquely identified
+if @i{MobileOrg} flags them for further action. If you do not want to get
+these properties in so many entries, you can set the variable
+@code{org-mobile-force-id-on-agenda-items} to @code{nil}. Org mode will then
+rely on outline paths, in the hope that these will be unique enough.}.
+Finally, Org writes the file @file{index.org}, containing links to all other
+files. @i{MobileOrg} first reads this file from the server, and then
+downloads all agendas and Org files listed in it. To speed up the download,
+MobileOrg will only read files whose checksums@footnote{stored automatically
+in the file @file{checksums.dat}} have changed.
@node Pulling from MobileOrg, , Pushing to MobileOrg, MobileOrg
@section Pulling from MobileOrg
-When @i{MobileOrg} synchronizes with the WebDAV server, it not only pulls the
-Org files for viewing. It also appends captured entries and pointers to
-flagged and changed entries to the file @file{mobileorg.org} on the server.
-Org has a @emph{pull} operation that integrates this information into an
-inbox file and operates on the pointers to flagged entries. Here is how it
-works:
+When @i{MobileOrg} synchronizes with the server, it not only pulls the Org
+files for viewing. It also appends captured entries and pointers to flagged
+and changed entries to the file @file{mobileorg.org} on the server. Org has
+a @emph{pull} operation that integrates this information into an inbox file
+and operates on the pointers to flagged entries. Here is how it works:
@enumerate
@item
z C-y C-c C-c} to store that flagging note as a normal note in the entry.
Pressing @kbd{?} twice in succession will offer to remove the
@code{:FLAGGED:} tag along with the recorded flagging note (which is stored
-in a property). In this way you indicate, that the intended processing for
+in a property). In this way you indicate that the intended processing for
this flagged entry is finished.
@end table
@end enumerate
@kindex C-c a ?
If you are not able to process all flagged entries directly, you can always
-return to this agenda view using @kbd{C-c a ?}. Note, however, that there is
-a subtle difference. The view created automatically by @kbd{M-x
-org-mobile-pull RET} is guaranteed to search all files that have been
-addressed by the last pull. This might include a file that is not currently
-in your list of agenda files. If you later use @kbd{C-c a ?} to regenerate
-the view, only the current agenda files will be searched.
+return to this agenda view@footnote{Note, however, that there is a subtle
+difference. The view created automatically by @kbd{M-x org-mobile-pull
+@key{RET}} is guaranteed to search all files that have been addressed by the
+last pull. This might include a file that is not currently in your list of
+agenda files. If you later use @kbd{C-c a ?} to regenerate the view, only
+the current agenda files will be searched.} using @kbd{C-c a ?}.
@node History and Acknowledgments, Main Index, MobileOrg, Top
-@appendix History and Acknowledgments
-@cindex acknowledgements
+@appendix History and acknowledgments
+@cindex acknowledgments
@cindex history
@cindex thanks
-Org was born in 2003, out of frustration over the user interface
-of the Emacs Outline mode. I was trying to organize my notes and
-projects, and using Emacs seemed to be the natural way to go. However,
-having to remember eleven different commands with two or three keys per
-command, only to hide and show parts of the outline tree, that seemed
-entirely unacceptable to me. Also, when using outlines to take notes, I
-constantly wanted to restructure the tree, organizing it parallel to my
-thoughts and plans. @emph{Visibility cycling} and @emph{structure
-editing} were originally implemented in the package
-@file{outline-magic.el}, but quickly moved to the more general
-@file{org.el}. As this environment became comfortable for project
-planning, the next step was adding @emph{TODO entries}, basic
-@emph{timestamps}, and @emph{table support}. These areas highlighted the two main
-goals that Org still has today: to be a new, outline-based,
-plain text mode with innovative and intuitive editing features, and to
-incorporate project planning functionality directly into a notes file.
-
-A special thanks goes to @i{Bastien Guerry} who has not only written a large
-number of extensions to Org (most of them integrated into the core by now),
-but who has also helped in the development and maintenance of Org so much that he
-should be considered the main co-contributor to this package.
+Org was born in 2003, out of frustration over the user interface of the Emacs
+Outline mode. I was trying to organize my notes and projects, and using
+Emacs seemed to be the natural way to go. However, having to remember eleven
+different commands with two or three keys per command, only to hide and show
+parts of the outline tree, that seemed entirely unacceptable to me. Also,
+when using outlines to take notes, I constantly wanted to restructure the
+tree, organizing it parallel to my thoughts and plans. @emph{Visibility
+cycling} and @emph{structure editing} were originally implemented in the
+package @file{outline-magic.el}, but quickly moved to the more general
+@file{org.el}. As this environment became comfortable for project planning,
+the next step was adding @emph{TODO entries}, basic @emph{timestamps}, and
+@emph{table support}. These areas highlighted the two main goals that Org
+still has today: to be a new, outline-based, plain text mode with innovative
+and intuitive editing features, and to incorporate project planning
+functionality directly into a notes file.
Since the first release, literally thousands of emails to me or to
@email{emacs-orgmode@@gnu.org} have provided a constant stream of bug
complete, if I have forgotten someone, please accept my apologies and
let me know.
+Before I get to this list, a few special mentions are in order:
+
+@table @i
+@item Bastien Guerry
+Bastien has written a large number of extensions to Org (most of them
+integrated into the core by now), including the LaTeX exporter and the plain
+list parser. His support during the early days, when he basically acted as
+co-maintainer, was central to the success of this project. Bastien also
+invented Worg, helped establishing the Web presence of Org, and sponsors
+hosting costs for the orgmode.org website.
+@item Eric Schulte and Dan Davison
+Eric and Dan are jointly responsible for the Org-babel system, which turns
+Org into a multi-language environment for evaluating code and doing literate
+programming and reproducible research.
+@item John Wiegley
+John has contributed a number of great ideas and patches directly to Org,
+including the attachment system (@file{org-attach.el}), integration with
+Apple Mail (@file{org-mac-message.el}), hierarchical dependencies of TODO
+items, habit tracking (@file{org-habits.el}), and encryption
+(@file{org-crypt.el}). Also, the capture system is really an extended copy
+of his great @file{remember.el}.
+@item Sebastian Rose
+Without Sebastian, the HTML/XHTML publishing of Org would be the pitiful work
+of an ignorant amateur. Sebastian has pushed this part of Org onto a much
+higher level. He also wrote @file{org-info.js}, a Java script for displaying
+webpages derived from Org using an Info-like or a folding interface with
+single-key navigation.
+@end table
+
+@noindent OK, now to the full list of contributions! Again, please let me
+know what I am missing here!
+
@itemize @bullet
@item
@item
@i{Alex Bochannek} provided a patch for rounding timestamps.
@item
+@i{Jan Böcker} wrote @file{org-docview.el}.
+@item
@i{Brad Bozarth} showed how to pull RSS feed data into Org-mode files.
@item
@i{Tom Breton} wrote @file{org-choose.el}.
@item
@i{Charles Cave}'s suggestion sparked the implementation of templates
-for Remember.
+for Remember, which are now templates for capture.
@item
@i{Pavel Chalmoviansky} influenced the agenda treatment of items with
specified time.
@item
@i{Baoqiu Cui} contributed the DocBook exporter.
@item
-@i{Dan Davison} wrote (together with @i{Eric Schulte}) Org Babel.
-@item
@i{Eddward DeVilla} proposed and tested checkbox statistics. He also
came up with the idea of properties, and that there should be an API for
them.
inspired some of the early development, including HTML export. He also
asked for a way to narrow wide table columns.
@item
-@i{Christian Egli} converted the documentation into Texinfo format,
-patched CSS formatting into the HTML exporter, and inspired the agenda.
+@i{Thomas S. Dye} contributed documentation on Worg and helped integrating
+the Org-Babel documentation into the manual.
+@item
+@i{Christian Egli} converted the documentation into Texinfo format, inspired
+the agenda, patched CSS formatting into the HTML exporter, and wrote
+@file{org-taskjuggler.el}.
@item
@i{David Emery} provided a patch for custom CSS support in exported
HTML agendas.
@item
@i{Austin Frank} works as a mailing list moderator.
@item
+@i{Eric Fraga} drove the development of BEAMER export with ideas and
+testing.
+@item
+@i{Barry Gidden} did proofreading the manual in preparation for the book
+publication through Network Theory Ltd.
+@item
@i{Niels Giesen} had the idea to automatically archive DONE trees.
@item
-@i{Bastien Guerry} wrote the La@TeX{} exporter and @file{org-bibtex.el}, and
-has been prolific with patches, ideas, and bug reports.
+@i{Nicolas Goaziou} rewrote much of the plain list code.
@item
@i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
@item
+@i{Brian Gough} of Network Theory Ltd publishes the Org mode manual as a
+book.
+@item
@i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
task state change logging, and the clocktable. His clear explanations have
been critical when we started to adopt the Git version control system.
@i{Scott Jaderholm} proposed footnotes, control over whitespace between
folded entries, and column view for properties.
@item
+@i{Matt Jones} wrote @i{MobileOrg Android}.
+@item
@i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
@item
-@i{Shidai Liu} ("Leo") asked for embedded La@TeX{} and tested it. He also
+@i{Shidai Liu} ("Leo") asked for embedded @LaTeX{} and tested it. He also
provided frequent feedback and some patches.
@item
@i{Matt Lundin} has proposed last-row references for table formulas and named
invisible anchors. He has also worked a lot on the FAQ.
@item
+@i{David Maus} wrote @file{org-atom.el}, maintains the issues file for Org,
+and is a prolific contributor on the mailing list with competent replies,
+small fixes and patches.
+@item
@i{Jason F. McBrayer} suggested agenda export to CSV format.
@item
@i{Max Mikhanosha} came up with the idea of refiling.
@i{Tim O'Callaghan} suggested in-file links, search options for general
file links, and TAGS.
@item
+@i{Osamu Okano} wrote @file{orgcard2ref.pl}, a Perl program to create a text
+version of the reference card.
+@item
@i{Takeshi Okano} translated the manual and David O'Toole's tutorial
into Japanese.
@item
@item
@i{Kevin Rogers} contributed code to access VM files on remote hosts.
@item
-@i{Sebastian Rose} wrote @file{org-info.js}, a Java script for displaying
-webpages derived from Org using an Info-like or a folding interface with
-single-key navigation.
-@item
@i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
conflict with @file{allout.el}.
@item
@i{Christian Schlauer} proposed angular brackets around links, among
other things.
@item
-@i{Eric Schulte} wrote @file{org-plot.el} and (together with @i{Dan Davison})
-Org Babel, and contributed various patches, small features and modules.
+@i{Paul Sexton} wrote @file{org-ctags.el}.
@item
Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
@file{organizer-mode.el}.
@i{Adam Spiers} asked for global linking commands, inspired the link
extension system, added support for mairix, and proposed the mapping API.
@item
+@i{Ulf Stegemann} created the table to translate special symbols to HTML,
+LaTeX, UTF-8, Latin-1 and ASCII.
+@item
@i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content
with links transformation to Org syntax.
@item
@i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
chapter about publishing.
@item
+@i{Jambunathan K} contributed the OpenDocumentText exporter.
+@item
+@i{Sebastien Vauban} reported many issues with LaTeX and BEAMER export and
+enabled source code highlighting in Gnus.
+@item
+@i{Stefan Vollmar} organized a video-recorded talk at the
+Max-Planck-Institute for Neurology. He also inspired the creation of a
+concept index for HTML export.
+@item
@i{J@"urgen Vollmer} contributed code generating the table of contents
in HTML output.
@item
+@i{Samuel Wales} has provided important feedback and bug reports.
+@item
@i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
keyword.
@item
@i{David Wainberg} suggested archiving, and improvements to the linking
system.
@item
-@i{John Wiegley} wrote @file{emacs-wiki.el}, @file{planner.el}, and
-@file{muse.el}, which have some overlap with Org. Initially the development
-of Org was fully independent because I was not aware of the existence of
-these packages. But with time I have occasionally looked at John's code and
-learned a lot from it. John has also contributed a number of great ideas and
-patches directly to Org, including the attachment system
-(@file{org-attach.el}), integration with Apple Mail
-(@file{org-mac-message.el}), hierarchical dependencies of TODO items, habit
-tracking (@file{org-habits.el}) and support for pcomplete.
-@item
@i{Carsten Wimmer} suggested some changes and helped fix a bug in
linking to Gnus.
@item
@item
@i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
and contributed various ideas and code snippets.
+@item
@end itemize
@node Main Index, Key Index, History and Acknowledgments, Top
-@unnumbered Concept Index
+@unnumbered Concept index
@printindex cp
-@node Key Index, Variable Index, Main Index, Top
-@unnumbered Key Index
+@node Key Index, Command and Function Index, Main Index, Top
+@unnumbered Key index
@printindex ky
-@node Variable Index, , Key Index, Top
-@unnumbered Variable Index
+@node Command and Function Index, Variable Index, Key Index, Top
+@unnumbered Command and function index
+
+@printindex fn
+
+@node Variable Index, , Command and Function Index, Top
+@unnumbered Variable index
This is not a complete index of variables and faces, only the ones that are
mentioned in the manual. For a more complete list, use @kbd{M-x
@bye
-@ignore
- arch-tag: 7893d1Fe-cc57-4d13-b5e5-f494a1CBC7ac
-@end ignore
-
@c Local variables:
-@c ispell-local-dictionary: "en_US-w_accents"
-@c ispell-local-pdict: "./.aspell.org.pws"
@c fill-column: 77
+@c indent-tabs-mode: nil
+@c paragraph-start: "\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|\f\\|[ ]*$"
+@c paragraph-separate: "\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|[ \f]*$"
@c End:
HCoop / bpt / emacs.git / blobdiff